From 21502a3be2038b2eb2edecfc00118d693fb93010 Mon Sep 17 00:00:00 2001 From: "Api (Codebuild)" Date: Sun, 24 Dec 2023 17:59:03 +0000 Subject: [PATCH] Look for details in API documentation's changelog --- .openapi-generator/FILES | 162 +- .openapi-generator/VERSION | 2 +- README.md | 70 +- docs/ActivesessionGetCurrentV1Response.md | 1 + ...tivesessionGetCurrentV1ResponseMPayload.md | 4 + docs/ActivesessionGetListV1Response.md | 1 + .../ActivesessionGetListV1ResponseMPayload.md | 1 + docs/ActivesessionListElement.md | 1 + docs/ActivesessionResponse.md | 1 + docs/ActivesessionResponseCompound.md | 4 + docs/ActivesessionResponseCompoundApikey.md | 1 + docs/ActivesessionResponseCompoundUser.md | 1 + docs/AddressRequest.md | 1 + docs/AddressRequestCompound.md | 1 + docs/ApikeyCreateObjectV2Request.md | 1 + docs/ApikeyCreateObjectV2Response.md | 1 + docs/ApikeyCreateObjectV2ResponseMPayload.md | 1 + docs/ApikeyEditObjectV1Request.md | 1 + docs/ApikeyEditObjectV1Response.md | 1 + docs/ApikeyEditPermissionsV1Request.md | 1 + docs/ApikeyEditPermissionsV1Response.md | 1 + ...ApikeyEditPermissionsV1ResponseMPayload.md | 1 + docs/ApikeyGetCorsV1Response.md | 1 + docs/ApikeyGetCorsV1ResponseMPayload.md | 1 + docs/ApikeyGetListV1Response.md | 1 + docs/ApikeyGetListV1ResponseMPayload.md | 1 + docs/ApikeyGetObjectV2Response.md | 1 + docs/ApikeyGetObjectV2ResponseMPayload.md | 1 + docs/ApikeyGetPermissionsV1Response.md | 1 + .../ApikeyGetPermissionsV1ResponseMPayload.md | 1 + docs/ApikeyGetSubnetsV1Response.md | 1 + docs/ApikeyGetSubnetsV1ResponseMPayload.md | 1 + docs/ApikeyListElement.md | 1 + docs/ApikeyRegenerateV1Request.md | 1 + docs/ApikeyRegenerateV1Response.md | 1 + docs/ApikeyRegenerateV1ResponseMPayload.md | 1 + docs/ApikeyRequest.md | 1 + docs/ApikeyRequestCompound.md | 1 + docs/ApikeyResponse.md | 1 + docs/ApikeyResponseCompound.md | 1 + docs/AttachmentDownloadV1Response.md | 30 - docs/AttachmentGetAttachmentlogsV1Response.md | 32 + ...mentGetAttachmentlogsV1ResponseMPayload.md | 30 + docs/AttachmentGetDownloadUrlV1Response.md | 32 + ...achmentGetDownloadUrlV1ResponseMPayload.md | 30 + docs/AttachmentResponse.md | 90 + docs/AttachmentResponseCompound.md | 90 + docs/AttachmentlogResponse.md | 34 + docs/AttachmentlogResponseCompound.md | 34 + docs/AttemptResponse.md | 1 + docs/AttemptResponseCompound.md | 1 + ...tityexternalAutocompleteElementResponse.md | 1 + ...entityexternalGetAutocompleteV2Response.md | 1 + ...ternalGetAutocompleteV2ResponseMPayload.md | 1 + ...tityinternalAutocompleteElementResponse.md | 1 + ...lingentityinternalCreateObjectV1Request.md | 1 + ...ingentityinternalCreateObjectV1Response.md | 1 + ...yinternalCreateObjectV1ResponseMPayload.md | 1 + ...illingentityinternalEditObjectV1Request.md | 1 + ...llingentityinternalEditObjectV1Response.md | 1 + ...entityinternalGetAutocompleteV2Response.md | 1 + ...ternalGetAutocompleteV2ResponseMPayload.md | 1 + .../BillingentityinternalGetListV1Response.md | 1 + ...entityinternalGetListV1ResponseMPayload.md | 1 + ...illingentityinternalGetObjectV2Response.md | 1 + ...tityinternalGetObjectV2ResponseMPayload.md | 1 + docs/BillingentityinternalListElement.md | 1 + docs/BillingentityinternalRequest.md | 1 + docs/BillingentityinternalRequestCompound.md | 1 + docs/BillingentityinternalResponse.md | 1 + docs/BillingentityinternalResponseCompound.md | 1 + docs/BillingentityinternalproductRequest.md | 1 + ...ingentityinternalproductRequestCompound.md | 1 + docs/BillingentityinternalproductResponse.md | 1 + ...ngentityinternalproductResponseCompound.md | 1 + docs/BrandingAutocompleteElementResponse.md | 1 + docs/BrandingCreateObjectV1Request.md | 1 + docs/BrandingCreateObjectV1Response.md | 1 + .../BrandingCreateObjectV1ResponseMPayload.md | 1 + docs/BrandingEditObjectV1Request.md | 1 + docs/BrandingEditObjectV1Response.md | 1 + docs/BrandingGetAutocompleteV2Response.md | 1 + ...andingGetAutocompleteV2ResponseMPayload.md | 1 + docs/BrandingGetListV1Response.md | 1 + docs/BrandingGetListV1ResponseMPayload.md | 1 + docs/BrandingGetObjectV2Response.md | 1 + docs/BrandingGetObjectV2ResponseMPayload.md | 1 + docs/BrandingListElement.md | 1 + docs/BrandingRequest.md | 1 + docs/BrandingRequestCompound.md | 1 + docs/BrandingResponse.md | 1 + docs/BrandingResponseCompound.md | 1 + ...rcontractGetCommunicationListV1Response.md | 1 + ...tGetCommunicationListV1ResponseMPayload.md | 1 + docs/ClonehistoryGetListV1Response.md | 1 + docs/ClonehistoryGetListV1ResponseMPayload.md | 1 + docs/ClonehistoryListElement.md | 1 + docs/CommonAudit.md | 1 + docs/CommonAuditdetail.md | 1 + docs/CommonFile.md | 1 + docs/CommonGetAutocompleteV1Response.md | 1 + docs/CommonGetListV1ResponseMPayload.md | 1 + docs/CommonGetReportV1Response.md | 1 + docs/CommonGetReportV1ResponseMPayload.md | 1 + docs/CommonReport.md | 1 + docs/CommonReportcell.md | 1 + docs/CommonReportcellstyle.md | 1 + docs/CommonReportcolumn.md | 1 + docs/CommonReportgroup.md | 1 + docs/CommonReportrow.md | 1 + docs/CommonReportsection.md | 1 + docs/CommonReportsubsection.md | 1 + docs/CommonReportsubsectionpart.md | 1 + docs/CommonResponse.md | 1 + docs/CommonResponseError.md | 1 + ...CommonResponseErrorEzsignformValidation.md | 1 + docs/CommonResponseErrorSTemporaryFileUrl.md | 1 + docs/CommonResponseErrorTooManyRequests.md | 1 + docs/CommonResponseFilter.md | 1 + docs/CommonResponseGetList.md | 1 + docs/CommonResponseObjDebug.md | 1 + docs/CommonResponseObjDebugPayload.md | 1 + docs/CommonResponseObjDebugPayloadGetList.md | 1 + docs/CommonResponseObjSQLQuery.md | 1 + ...monResponseRedirectSSecretquestionTextX.md | 1 + docs/CommonResponseWarning.md | 1 + docs/CommonWebhook.md | 1 + ...unicationCreateObjectV1ResponseMPayload.md | 1 + docs/CommunicationRequest.md | 1 + docs/CommunicationRequestCompound.md | 1 + docs/CommunicationSendV1Request.md | 1 + docs/CommunicationSendV1Response.md | 1 + docs/CommunicationattachmentRequest.md | 1 + .../CommunicationattachmentRequestCompound.md | 1 + docs/CommunicationexternalrecipientRequest.md | 3 +- ...icationexternalrecipientRequestCompound.md | 3 +- docs/CommunicationrecipientRequest.md | 5 +- docs/CommunicationrecipientRequestCompound.md | 5 +- docs/CommunicationreferenceRequest.md | 1 + docs/CommunicationreferenceRequestCompound.md | 1 + docs/CompanyAutocompleteElementResponse.md | 1 + docs/CompanyGetAutocompleteV2Response.md | 1 + ...ompanyGetAutocompleteV2ResponseMPayload.md | 1 + docs/ComputedECommunicationDirection.md | 1 + docs/ComputedEEzsigndocumentSteptype.md | 1 + docs/ContactRequest.md | 1 + docs/ContactRequestCompound.md | 1 + docs/ContactinformationsRequest.md | 1 + docs/ContactinformationsRequestCompound.md | 1 + docs/CorsCreateObjectV1Request.md | 1 + docs/CorsCreateObjectV1Response.md | 1 + docs/CorsCreateObjectV1ResponseMPayload.md | 1 + docs/CorsDeleteObjectV1Response.md | 1 + docs/CorsEditObjectV1Request.md | 1 + docs/CorsEditObjectV1Response.md | 1 + docs/CorsGetObjectV2Response.md | 1 + docs/CorsGetObjectV2ResponseMPayload.md | 1 + docs/CorsRequest.md | 1 + docs/CorsRequestCompound.md | 1 + docs/CorsResponse.md | 1 + docs/CorsResponseCompound.md | 1 + docs/CustomAttachmentResponse.md | 94 + docs/CustomAttachmentdocumenttypeResponse.md | 31 + docs/CustomAutocompleteElementResponse.md | 1 + .../CustomCommunicationListElementResponse.md | 1 + docs/CustomCommunicationattachmentRequest.md | 1 + ...tomCommunicationrecipientsgroupResponse.md | 1 + ...ommunicationrecipientsrecipientResponse.md | 1 + docs/CustomCommunicationsenderRequest.md | 2 + docs/CustomCommunicationsenderResponse.md | 7 +- docs/CustomContactNameResponse.md | 1 + docs/CustomCreditcardtransactionResponse.md | 1 + docs/CustomDropdownElementRequest.md | 1 + docs/CustomDropdownElementRequestCompound.md | 1 + docs/CustomDropdownElementResponse.md | 1 + docs/CustomDropdownElementResponseCompound.md | 1 + ...tomEzmaxinvoicingEzsigndocumentResponse.md | 1 + ...ustomEzmaxinvoicingEzsignfolderResponse.md | 1 + docs/CustomEzmaxpricingResponse.md | 1 + ...cumentEzsignsignaturesAutomaticResponse.md | 1 + ...folderEzsignsignaturesAutomaticResponse.md | 1 + ...nerassociationActionableElementResponse.md | 1 + ...gnfoldersignerassociationmessageRequest.md | 1 + ...gnfoldersignerassociationstatusResponse.md | 1 + .../CustomEzsignfoldertransmissionResponse.md | 1 + ...mEzsignfoldertransmissionSignerResponse.md | 1 + docs/CustomEzsignfoldertypeResponse.md | 6 +- docs/CustomEzsignformfieldRequest.md | 1 + docs/CustomEzsignformfielderrorResponse.md | 1 + .../CustomEzsignformfielderrortestResponse.md | 1 + docs/CustomEzsignformfieldgroupRequest.md | 1 + ...natureEzsignsignaturesAutomaticResponse.md | 1 + docs/CustomEzsignsignaturestatusResponse.md | 1 + docs/CustomFormDataDocumentResponse.md | 1 + docs/CustomFormDataEzsignformfieldResponse.md | 1 + ...tomFormDataEzsignformfieldgroupResponse.md | 1 + docs/CustomFormDataSignerResponse.md | 1 + docs/CustomFormsDataFolderResponse.md | 1 + ...ortEzsigntemplatepackageRelationRequest.md | 1 + ...nsubsectiongetnotificationtestsResponse.md | 1 + ...icationtestgetnotificationtestsResponse.md | 1 + docs/CustomUserResponse.md | 1 + docs/CustomWebhookResponse.md | 4 + docs/CustomWebhooklogResponse.md | 1 + docs/CustomWordPositionOccurenceResponse.md | 1 + docs/CustomWordPositionWordResponse.md | 1 + docs/DepartmentAutocompleteElementResponse.md | 1 + docs/DepartmentGetAutocompleteV2Response.md | 1 + ...rtmentGetAutocompleteV2ResponseMPayload.md | 1 + ...stransferGetCommunicationListV1Response.md | 1 + ...rGetCommunicationListV1ResponseMPayload.md | 1 + docs/EmailRequest.md | 1 + docs/EmailRequestCompound.md | 1 + docs/EmailResponse.md | 1 + docs/EmailResponseCompound.md | 1 + docs/EmailtypeAutocompleteElementResponse.md | 1 + docs/EmailtypeGetAutocompleteV2Response.md | 1 + ...iltypeGetAutocompleteV2ResponseMPayload.md | 1 + docs/EnumFontunderline.md | 1 + docs/EnumFontweight.md | 1 + docs/EnumHorizontalalignment.md | 1 + docs/EnumTextvalidation.md | 1 + docs/EnumVerticalalignment.md | 1 + ...maxinvoicingAutocompleteElementResponse.md | 1 + ...EzmaxinvoicingGetAutocompleteV2Response.md | 1 + ...oicingGetAutocompleteV2ResponseMPayload.md | 1 + docs/EzmaxinvoicingGetObjectV2Response.md | 1 + ...maxinvoicingGetObjectV2ResponseMPayload.md | 1 + .../EzmaxinvoicingGetProvisionalV1Response.md | 1 + ...voicingGetProvisionalV1ResponseMPayload.md | 1 + docs/EzmaxinvoicingResponse.md | 1 + docs/EzmaxinvoicingResponseCompound.md | 1 + docs/EzmaxinvoicingagentResponse.md | 1 + docs/EzmaxinvoicingagentResponseCompound.md | 1 + docs/EzmaxinvoicingcommissionResponse.md | 1 + ...zmaxinvoicingcommissionResponseCompound.md | 1 + docs/EzmaxinvoicingcontractResponse.md | 1 + .../EzmaxinvoicingcontractResponseCompound.md | 1 + docs/EzmaxinvoicingsummaryexternalResponse.md | 1 + ...nvoicingsummaryexternalResponseCompound.md | 1 + ...xinvoicingsummaryexternaldetailResponse.md | 1 + ...ngsummaryexternaldetailResponseCompound.md | 1 + docs/EzmaxinvoicingsummaryglobalResponse.md | 1 + ...xinvoicingsummaryglobalResponseCompound.md | 1 + docs/EzmaxinvoicingsummaryinternalResponse.md | 1 + ...nvoicingsummaryinternalResponseCompound.md | 1 + ...xinvoicingsummaryinternaldetailResponse.md | 1 + ...ngsummaryinternaldetailResponseCompound.md | 1 + docs/EzmaxinvoicinguserResponse.md | 1 + docs/EzmaxinvoicinguserResponseCompound.md | 1 + ...EzmaxproductAutocompleteElementResponse.md | 1 + docs/EzmaxproductGetAutocompleteV2Response.md | 1 + ...roductGetAutocompleteV2ResponseMPayload.md | 1 + docs/EzsignSuggestSignersV1Response.md | 1 + .../EzsignSuggestSignersV1ResponseMPayload.md | 1 + docs/EzsignSuggestTemplatesV1Response.md | 1 + ...zsignSuggestTemplatesV1ResponseMPayload.md | 1 + docs/EzsignannotationResponse.md | 1 + docs/EzsignannotationResponseCompound.md | 1 + ...eateEzsignbulksendtransmissionV1Request.md | 1 + ...ateEzsignbulksendtransmissionV1Response.md | 1 + ...nbulksendtransmissionV1ResponseMPayload.md | 1 + docs/EzsignbulksendCreateObjectV1Request.md | 1 + docs/EzsignbulksendCreateObjectV1Response.md | 1 + ...nbulksendCreateObjectV1ResponseMPayload.md | 1 + docs/EzsignbulksendDeleteObjectV1Response.md | 1 + docs/EzsignbulksendEditObjectV1Request.md | 1 + docs/EzsignbulksendEditObjectV1Response.md | 1 + ...etEzsignbulksendtransmissionsV1Response.md | 1 + ...bulksendtransmissionsV1ResponseMPayload.md | 1 + ...dGetEzsignsignaturesAutomaticV1Response.md | 1 + ...gnsignaturesAutomaticV1ResponseMPayload.md | 1 + docs/EzsignbulksendGetFormsDataV1Response.md | 1 + ...nbulksendGetFormsDataV1ResponseMPayload.md | 1 + docs/EzsignbulksendGetListV1Response.md | 1 + ...EzsignbulksendGetListV1ResponseMPayload.md | 1 + docs/EzsignbulksendGetObjectV2Response.md | 1 + ...signbulksendGetObjectV2ResponseMPayload.md | 1 + docs/EzsignbulksendListElement.md | 1 + docs/EzsignbulksendReorderV1Request.md | 1 + docs/EzsignbulksendReorderV1Response.md | 1 + docs/EzsignbulksendRequest.md | 1 + docs/EzsignbulksendRequestCompound.md | 1 + docs/EzsignbulksendResponse.md | 1 + docs/EzsignbulksendResponseCompound.md | 1 + ...enddocumentmappingCreateObjectV1Request.md | 1 + ...nddocumentmappingCreateObjectV1Response.md | 1 + ...ntmappingCreateObjectV1ResponseMPayload.md | 1 + ...nddocumentmappingDeleteObjectV1Response.md | 1 + ...ksenddocumentmappingGetObjectV2Response.md | 1 + ...umentmappingGetObjectV2ResponseMPayload.md | 1 + docs/EzsignbulksenddocumentmappingRequest.md | 1 + ...nbulksenddocumentmappingRequestCompound.md | 1 + docs/EzsignbulksenddocumentmappingResponse.md | 1 + ...bulksenddocumentmappingResponseCompound.md | 1 + ...ksendsignermappingCreateObjectV1Request.md | 1 + ...sendsignermappingCreateObjectV1Response.md | 1 + ...ermappingCreateObjectV1ResponseMPayload.md | 1 + ...sendsignermappingDeleteObjectV1Response.md | 1 + ...ulksendsignermappingGetObjectV2Response.md | 1 + ...ignermappingGetObjectV2ResponseMPayload.md | 1 + docs/EzsignbulksendsignermappingRequest.md | 1 + ...ignbulksendsignermappingRequestCompound.md | 1 + docs/EzsignbulksendsignermappingResponse.md | 1 + ...gnbulksendsignermappingResponseCompound.md | 1 + ...nGetEzsignsignaturesAutomaticV1Response.md | 1 + ...gnsignaturesAutomaticV1ResponseMPayload.md | 1 + ...ksendtransmissionGetFormsDataV1Response.md | 1 + ...nsmissionGetFormsDataV1ResponseMPayload.md | 1 + ...bulksendtransmissionGetObjectV2Response.md | 1 + ...transmissionGetObjectV2ResponseMPayload.md | 1 + docs/EzsignbulksendtransmissionResponse.md | 1 + ...ignbulksendtransmissionResponseCompound.md | 1 + ...igndocumentApplyEzsigntemplateV1Request.md | 1 + ...gndocumentApplyEzsigntemplateV1Response.md | 1 + ...igndocumentApplyEzsigntemplateV2Request.md | 1 + ...gndocumentApplyEzsigntemplateV2Response.md | 1 + docs/EzsigndocumentCreateObjectV1Request.md | 1 + docs/EzsigndocumentCreateObjectV1Response.md | 1 + ...ndocumentCreateObjectV1ResponseMPayload.md | 1 + docs/EzsigndocumentCreateObjectV2Request.md | 1 + docs/EzsigndocumentCreateObjectV2Response.md | 1 + ...ndocumentCreateObjectV2ResponseMPayload.md | 1 + docs/EzsigndocumentDeclineToSignV1Request.md | 1 + docs/EzsigndocumentDeclineToSignV1Response.md | 1 + docs/EzsigndocumentDeleteObjectV1Response.md | 1 + ...umentEditEzsignformfieldgroupsV1Request.md | 1 + ...mentEditEzsignformfieldgroupsV1Response.md | 1 + ...EzsignformfieldgroupsV1ResponseMPayload.md | 1 + ...gndocumentEditEzsignsignaturesV1Request.md | 1 + ...ndocumentEditEzsignsignaturesV1Response.md | 1 + ...tEditEzsignsignaturesV1ResponseMPayload.md | 1 + .../EzsigndocumentEndPrematurelyV1Response.md | 1 + docs/EzsigndocumentFlattenV1Response.md | 1 + ...documentGetActionableElementsV1Response.md | 1 + ...GetActionableElementsV1ResponseMPayload.md | 1 + .../EzsigndocumentGetAttachmentsV1Response.md | 32 + ...ocumentGetAttachmentsV1ResponseMPayload.md | 30 + ...ndocumentGetCompletedElementsV1Response.md | 1 + ...tGetCompletedElementsV1ResponseMPayload.md | 1 + .../EzsigndocumentGetDownloadUrlV1Response.md | 1 + ...ocumentGetDownloadUrlV1ResponseMPayload.md | 1 + ...ndocumentGetEzsignannotationsV1Response.md | 1 + ...tGetEzsignannotationsV1ResponseMPayload.md | 1 + ...umentGetEzsignformfieldgroupsV1Response.md | 1 + ...EzsignformfieldgroupsV1ResponseMPayload.md | 1 + .../EzsigndocumentGetEzsignpagesV1Response.md | 1 + ...ocumentGetEzsignpagesV1ResponseMPayload.md | 1 + ...tGetEzsignsignaturesAutomaticV1Response.md | 1 + ...gnsignaturesAutomaticV1ResponseMPayload.md | 1 + ...gndocumentGetEzsignsignaturesV1Response.md | 1 + ...ntGetEzsignsignaturesV1ResponseMPayload.md | 1 + docs/EzsigndocumentGetFormDataV1Response.md | 1 + ...gndocumentGetFormDataV1ResponseMPayload.md | 1 + docs/EzsigndocumentGetObjectV1Response.md | 1 + ...signdocumentGetObjectV1ResponseMPayload.md | 2 + docs/EzsigndocumentGetObjectV2Response.md | 1 + ...signdocumentGetObjectV2ResponseMPayload.md | 1 + ...signdocumentGetTemporaryProofV1Response.md | 1 + ...mentGetTemporaryProofV1ResponseMPayload.md | 1 + ...zsigndocumentGetWordsPositionsV1Request.md | 1 + ...signdocumentGetWordsPositionsV1Response.md | 1 + docs/EzsigndocumentPatchObjectV1Request.md | 1 + docs/EzsigndocumentPatchObjectV1Response.md | 1 + docs/EzsigndocumentRequest.md | 1 + docs/EzsigndocumentRequestCompound.md | 1 + docs/EzsigndocumentRequestPatch.md | 1 + docs/EzsigndocumentResponse.md | 2 + docs/EzsigndocumentResponseCompound.md | 2 + ...EzsigndocumentSubmitEzsignformV1Request.md | 1 + ...zsigndocumentSubmitEzsignformV1Response.md | 1 + docs/EzsigndocumentUnsendV1Response.md | 1 + docs/EzsigndocumentlogResponse.md | 1 + docs/EzsigndocumentlogResponseCompound.md | 1 + docs/EzsignelementdependencyRequest.md | 1 + .../EzsignelementdependencyRequestCompound.md | 1 + docs/EzsignelementdependencyResponse.md | 1 + ...EzsignelementdependencyResponseCompound.md | 1 + docs/EzsignfolderArchiveV1Response.md | 1 + docs/EzsignfolderBatchDownloadV1Request.md | 1 + docs/EzsignfolderCreateObjectV1Request.md | 1 + docs/EzsignfolderCreateObjectV1Response.md | 1 + ...ignfolderCreateObjectV1ResponseMPayload.md | 1 + docs/EzsignfolderCreateObjectV2Request.md | 1 + docs/EzsignfolderCreateObjectV2Response.md | 1 + ...ignfolderCreateObjectV2ResponseMPayload.md | 1 + docs/EzsignfolderDeleteObjectV1Response.md | 1 + ...signfolderDisposeEzsignfoldersV1Request.md | 1 + ...ignfolderDisposeEzsignfoldersV1Response.md | 1 + docs/EzsignfolderDisposeV1Response.md | 1 + docs/EzsignfolderEditObjectV1Request.md | 1 + docs/EzsignfolderEditObjectV1Response.md | 1 + ...gnfolderGetActionableElementsV1Response.md | 1 + ...GetActionableElementsV1ResponseMPayload.md | 1 + ...zsignfolderGetAttachmentCountV1Response.md | 32 + ...derGetAttachmentCountV1ResponseMPayload.md | 30 + docs/EzsignfolderGetAttachmentsV1Response.md | 32 + ...nfolderGetAttachmentsV1ResponseMPayload.md | 30 + ...gnfolderGetCommunicationCountV1Response.md | 1 + ...GetCommunicationCountV1ResponseMPayload.md | 1 + ...ignfolderGetCommunicationListV1Response.md | 1 + ...rGetCommunicationListV1ResponseMPayload.md | 1 + ...derGetCommunicationrecipientsV1Response.md | 1 + ...mmunicationrecipientsV1ResponseMPayload.md | 1 + ...folderGetCommunicationsendersV1Response.md | 1 + ...tCommunicationsendersV1ResponseMPayload.md | 1 + ...zsignfolderGetEzsigndocumentsV1Response.md | 1 + ...derGetEzsigndocumentsV1ResponseMPayload.md | 1 + ...zsignfoldersignerassociationsV1Response.md | 1 + ...dersignerassociationsV1ResponseMPayload.md | 1 + ...rGetEzsignsignaturesAutomaticV1Response.md | 1 + ...gnsignaturesAutomaticV1ResponseMPayload.md | 1 + docs/EzsignfolderGetFormsDataV1Response.md | 1 + ...ignfolderGetFormsDataV1ResponseMPayload.md | 1 + docs/EzsignfolderGetListV1Response.md | 1 + docs/EzsignfolderGetListV1ResponseMPayload.md | 1 + docs/EzsignfolderGetObjectV1Response.md | 1 + ...EzsignfolderGetObjectV1ResponseMPayload.md | 1 + docs/EzsignfolderGetObjectV2Response.md | 1 + ...EzsignfolderGetObjectV2ResponseMPayload.md | 1 + ...EzsignfoldersignerassociationsV1Request.md | 1 + ...zsignfoldersignerassociationsV1Response.md | 1 + ...dersignerassociationsV1ResponseMPayload.md | 1 + ...derImportEzsigntemplatepackageV1Request.md | 1 + ...erImportEzsigntemplatepackageV1Response.md | 1 + ...EzsigntemplatepackageV1ResponseMPayload.md | 1 + docs/EzsignfolderListElement.md | 1 + docs/EzsignfolderReorderV1Request.md | 1 + docs/EzsignfolderReorderV1Response.md | 1 + docs/EzsignfolderRequest.md | 1 + docs/EzsignfolderRequestCompound.md | 1 + docs/EzsignfolderResponse.md | 1 + docs/EzsignfolderResponseCompound.md | 1 + docs/EzsignfolderSendV1Request.md | 1 + docs/EzsignfolderSendV1Response.md | 1 + docs/EzsignfolderSendV2Request.md | 1 + docs/EzsignfolderSendV2Response.md | 1 + docs/EzsignfolderSendV3Request.md | 1 + docs/EzsignfolderSendV3Response.md | 1 + docs/EzsignfolderUnsendV1Response.md | 1 + ...rsignerassociationCreateObjectV1Request.md | 1 + ...signerassociationCreateObjectV1Response.md | 1 + ...sociationCreateObjectV1ResponseMPayload.md | 1 + ...rsignerassociationCreateObjectV2Request.md | 1 + ...signerassociationCreateObjectV2Response.md | 1 + ...sociationCreateObjectV2ResponseMPayload.md | 1 + ...signerassociationDeleteObjectV1Response.md | 1 + ...dersignerassociationEditObjectV1Request.md | 1 + ...ersignerassociationEditObjectV1Response.md | 1 + ...nerassociationForceDisconnectV1Response.md | 1 + ...ssociationGetInPersonLoginUrlV1Response.md | 1 + ...onGetInPersonLoginUrlV1ResponseMPayload.md | 1 + ...dersignerassociationGetObjectV1Response.md | 1 + ...rassociationGetObjectV1ResponseMPayload.md | 1 + ...dersignerassociationGetObjectV2Response.md | 1 + ...rassociationGetObjectV2ResponseMPayload.md | 1 + ...ersignerassociationPatchObjectV1Request.md | 1 + ...rsignerassociationPatchObjectV1Response.md | 1 + docs/EzsignfoldersignerassociationRequest.md | 1 + ...nfoldersignerassociationRequestCompound.md | 1 + ...signfoldersignerassociationRequestPatch.md | 1 + docs/EzsignfoldersignerassociationResponse.md | 1 + ...foldersignerassociationResponseCompound.md | 1 + ...ersignerassociationResponseCompoundUser.md | 1 + ...gnfoldertypeAutocompleteElementResponse.md | 1 + docs/EzsignfoldertypeCreateObjectV1Request.md | 1 + .../EzsignfoldertypeCreateObjectV1Response.md | 1 + ...oldertypeCreateObjectV1ResponseMPayload.md | 1 + docs/EzsignfoldertypeEditObjectV1Request.md | 1 + docs/EzsignfoldertypeEditObjectV1Response.md | 1 + ...signfoldertypeGetAutocompleteV2Response.md | 1 + ...ertypeGetAutocompleteV2ResponseMPayload.md | 1 + docs/EzsignfoldertypeGetListV1Response.md | 1 + ...signfoldertypeGetListV1ResponseMPayload.md | 1 + docs/EzsignfoldertypeGetObjectV2Response.md | 1 + ...gnfoldertypeGetObjectV2ResponseMPayload.md | 1 + docs/EzsignfoldertypeListElement.md | 1 + docs/EzsignfoldertypeRequest.md | 17 +- docs/EzsignfoldertypeRequestCompound.md | 17 +- docs/EzsignfoldertypeResponse.md | 17 +- docs/EzsignfoldertypeResponseCompound.md | 17 +- docs/EzsignformfieldRequest.md | 1 + docs/EzsignformfieldRequestCompound.md | 1 + docs/EzsignformfieldResponse.md | 1 + docs/EzsignformfieldResponseCompound.md | 1 + ...signformfieldgroupCreateObjectV1Request.md | 1 + ...ignformfieldgroupCreateObjectV1Response.md | 1 + ...ieldgroupCreateObjectV1ResponseMPayload.md | 1 + ...ignformfieldgroupDeleteObjectV1Response.md | 1 + ...EzsignformfieldgroupEditObjectV1Request.md | 1 + ...zsignformfieldgroupEditObjectV1Response.md | 1 + ...EzsignformfieldgroupGetObjectV2Response.md | 1 + ...rmfieldgroupGetObjectV2ResponseMPayload.md | 1 + docs/EzsignformfieldgroupRequest.md | 1 + docs/EzsignformfieldgroupRequestCompound.md | 1 + docs/EzsignformfieldgroupResponse.md | 1 + docs/EzsignformfieldgroupResponseCompound.md | 1 + docs/EzsignformfieldgroupsignerRequest.md | 1 + ...signformfieldgroupsignerRequestCompound.md | 1 + docs/EzsignformfieldgroupsignerResponse.md | 1 + ...ignformfieldgroupsignerResponseCompound.md | 1 + docs/EzsignpageConsultV1Response.md | 1 + docs/EzsignpageResponse.md | 1 + docs/EzsignpageResponseCompound.md | 1 + docs/EzsignsignatureCreateObjectV1Request.md | 1 + docs/EzsignsignatureCreateObjectV1Response.md | 1 + ...signatureCreateObjectV1ResponseMPayload.md | 1 + docs/EzsignsignatureCreateObjectV2Request.md | 1 + docs/EzsignsignatureCreateObjectV2Response.md | 1 + ...signatureCreateObjectV2ResponseMPayload.md | 1 + docs/EzsignsignatureDeleteObjectV1Response.md | 1 + docs/EzsignsignatureEditObjectV1Request.md | 1 + docs/EzsignsignatureEditObjectV1Response.md | 1 + ...eGetEzsignsignatureattachmentV1Response.md | 1 + ...gnsignatureattachmentV1ResponseMPayload.md | 1 + ...eGetEzsignsignaturesAutomaticV1Response.md | 1 + ...gnsignaturesAutomaticV1ResponseMPayload.md | 1 + docs/EzsignsignatureGetObjectV2Response.md | 1 + ...ignsignatureGetObjectV2ResponseMPayload.md | 1 + docs/EzsignsignatureRequest.md | 1 + docs/EzsignsignatureRequestCompound.md | 1 + docs/EzsignsignatureResponse.md | 3 + docs/EzsignsignatureResponseCompound.md | 3 + docs/EzsignsignatureSignV1Request.md | 2 + docs/EzsignsignatureSignV1Response.md | 1 + docs/EzsignsignatureattachmentResponse.md | 1 + docs/EzsignsignaturecustomdateRequest.md | 1 + ...zsignsignaturecustomdateRequestCompound.md | 1 + docs/EzsignsignaturecustomdateResponse.md | 1 + ...signsignaturecustomdateResponseCompound.md | 1 + docs/EzsignsignerRequest.md | 1 + docs/EzsignsignerRequestCompound.md | 1 + docs/EzsignsignerRequestCompoundContact.md | 1 + docs/EzsignsignerResponse.md | 1 + docs/EzsignsignerResponseCompound.md | 1 + docs/EzsignsignerResponseCompoundContact.md | 1 + .../EzsignsignergroupCreateObjectV1Request.md | 1 + ...EzsignsignergroupCreateObjectV1Response.md | 1 + ...gnergroupCreateObjectV1ResponseMPayload.md | 1 + ...EzsignsignergroupDeleteObjectV1Response.md | 1 + ...itEzsignsignergroupmembershipsV1Request.md | 1 + ...tEzsignsignergroupmembershipsV1Response.md | 1 + ...ignergroupmembershipsV1ResponseMPayload.md | 1 + docs/EzsignsignergroupEditObjectV1Request.md | 1 + docs/EzsignsignergroupEditObjectV1Response.md | 1 + ...tEzsignsignergroupmembershipsV1Response.md | 1 + ...ignergroupmembershipsV1ResponseMPayload.md | 1 + docs/EzsignsignergroupGetObjectV2Response.md | 1 + ...nsignergroupGetObjectV2ResponseMPayload.md | 1 + docs/EzsignsignergroupRequest.md | 1 + docs/EzsignsignergroupRequestCompound.md | 1 + docs/EzsignsignergroupResponse.md | 1 + docs/EzsignsignergroupResponseCompound.md | 1 + ...nergroupmembershipCreateObjectV1Request.md | 1 + ...ergroupmembershipCreateObjectV1Response.md | 1 + ...embershipCreateObjectV1ResponseMPayload.md | 1 + ...ergroupmembershipDeleteObjectV1Response.md | 1 + ...ignergroupmembershipGetObjectV2Response.md | 1 + ...upmembershipGetObjectV2ResponseMPayload.md | 1 + docs/EzsignsignergroupmembershipRequest.md | 1 + ...ignsignergroupmembershipRequestCompound.md | 1 + docs/EzsignsignergroupmembershipResponse.md | 1 + ...gnsignergroupmembershipResponseCompound.md | 1 + ...igningreasonAutocompleteElementResponse.md | 32 + ...zsignsigningreasonCreateObjectV1Request.md | 30 + ...signsigningreasonCreateObjectV1Response.md | 32 + ...ingreasonCreateObjectV1ResponseMPayload.md | 30 + .../EzsignsigningreasonEditObjectV1Request.md | 30 + ...EzsignsigningreasonEditObjectV1Response.md | 31 + ...nsigningreasonGetAutocompleteV2Response.md | 32 + ...reasonGetAutocompleteV2ResponseMPayload.md | 30 + docs/EzsignsigningreasonGetListV1Response.md | 32 + ...nsigningreasonGetListV1ResponseMPayload.md | 32 + .../EzsignsigningreasonGetObjectV2Response.md | 32 + ...igningreasonGetObjectV2ResponseMPayload.md | 30 + docs/EzsignsigningreasonListElement.md | 32 + docs/EzsignsigningreasonRequest.md | 32 + docs/EzsignsigningreasonRequestCompound.md | 32 + docs/EzsignsigningreasonResponse.md | 32 + docs/EzsignsigningreasonResponseCompound.md | 32 + ...signtemplateAutocompleteElementResponse.md | 1 + docs/EzsigntemplateCopyV1Request.md | 1 + docs/EzsigntemplateCopyV1Response.md | 1 + docs/EzsigntemplateCopyV1ResponseMPayload.md | 1 + docs/EzsigntemplateCreateObjectV1Request.md | 1 + docs/EzsigntemplateCreateObjectV1Response.md | 1 + ...ntemplateCreateObjectV1ResponseMPayload.md | 1 + docs/EzsigntemplateDeleteObjectV1Response.md | 1 + docs/EzsigntemplateEditObjectV1Request.md | 1 + docs/EzsigntemplateEditObjectV1Response.md | 1 + ...EzsigntemplateGetAutocompleteV2Response.md | 1 + ...mplateGetAutocompleteV2ResponseMPayload.md | 1 + docs/EzsigntemplateGetListV1Response.md | 1 + ...EzsigntemplateGetListV1ResponseMPayload.md | 1 + docs/EzsigntemplateGetObjectV1Response.md | 1 + ...signtemplateGetObjectV1ResponseMPayload.md | 1 + docs/EzsigntemplateGetObjectV2Response.md | 1 + ...signtemplateGetObjectV2ResponseMPayload.md | 1 + docs/EzsigntemplateListElement.md | 1 + docs/EzsigntemplateRequest.md | 1 + docs/EzsigntemplateRequestCompound.md | 1 + docs/EzsigntemplateResponse.md | 1 + docs/EzsigntemplateResponseCompound.md | 1 + ...gntemplatedocumentCreateObjectV1Request.md | 1 + ...ntemplatedocumentCreateObjectV1Response.md | 1 + ...edocumentCreateObjectV1ResponseMPayload.md | 1 + ...tEzsigntemplateformfieldgroupsV1Request.md | 1 + ...EzsigntemplateformfieldgroupsV1Response.md | 1 + ...mplateformfieldgroupsV1ResponseMPayload.md | 1 + ...ntEditEzsigntemplatesignaturesV1Request.md | 1 + ...tEditEzsigntemplatesignaturesV1Response.md | 1 + ...igntemplatesignaturesV1ResponseMPayload.md | 1 + ...signtemplatedocumentEditObjectV1Request.md | 1 + ...igntemplatedocumentEditObjectV1Response.md | 1 + ...EzsigntemplatedocumentFlattenV1Response.md | 1 + ...etEzsigntemplatedocumentpagesV1Response.md | 1 + ...templatedocumentpagesV1ResponseMPayload.md | 1 + ...EzsigntemplateformfieldgroupsV1Response.md | 1 + ...mplateformfieldgroupsV1ResponseMPayload.md | 1 + ...ntGetEzsigntemplatesignaturesV1Response.md | 1 + ...igntemplatesignaturesV1ResponseMPayload.md | 1 + ...signtemplatedocumentGetObjectV2Response.md | 1 + ...latedocumentGetObjectV2ResponseMPayload.md | 1 + ...platedocumentGetWordsPositionsV1Request.md | 1 + ...latedocumentGetWordsPositionsV1Response.md | 1 + ...igntemplatedocumentPatchObjectV1Request.md | 1 + ...gntemplatedocumentPatchObjectV1Response.md | 1 + docs/EzsigntemplatedocumentRequest.md | 1 + docs/EzsigntemplatedocumentRequestCompound.md | 1 + docs/EzsigntemplatedocumentRequestPatch.md | 1 + docs/EzsigntemplatedocumentResponse.md | 1 + .../EzsigntemplatedocumentResponseCompound.md | 1 + docs/EzsigntemplatedocumentpageResponse.md | 1 + ...igntemplatedocumentpageResponseCompound.md | 1 + .../EzsigntemplateelementdependencyRequest.md | 1 + ...emplateelementdependencyRequestCompound.md | 1 + ...EzsigntemplateelementdependencyResponse.md | 1 + ...mplateelementdependencyResponseCompound.md | 1 + docs/EzsigntemplateformfieldRequest.md | 1 + .../EzsigntemplateformfieldRequestCompound.md | 1 + docs/EzsigntemplateformfieldResponse.md | 1 + ...EzsigntemplateformfieldResponseCompound.md | 1 + ...lateformfieldgroupCreateObjectV1Request.md | 1 + ...ateformfieldgroupCreateObjectV1Response.md | 1 + ...ieldgroupCreateObjectV1ResponseMPayload.md | 1 + ...ateformfieldgroupDeleteObjectV1Response.md | 1 + ...mplateformfieldgroupEditObjectV1Request.md | 1 + ...plateformfieldgroupEditObjectV1Response.md | 1 + ...mplateformfieldgroupGetObjectV2Response.md | 1 + ...rmfieldgroupGetObjectV2ResponseMPayload.md | 1 + docs/EzsigntemplateformfieldgroupRequest.md | 1 + ...gntemplateformfieldgroupRequestCompound.md | 1 + docs/EzsigntemplateformfieldgroupResponse.md | 1 + ...ntemplateformfieldgroupResponseCompound.md | 1 + ...signtemplateformfieldgroupsignerRequest.md | 1 + ...lateformfieldgroupsignerRequestCompound.md | 1 + ...igntemplateformfieldgroupsignerResponse.md | 1 + ...ateformfieldgroupsignerResponseCompound.md | 1 + ...platepackageAutocompleteElementResponse.md | 1 + ...igntemplatepackageCreateObjectV1Request.md | 1 + ...gntemplatepackageCreateObjectV1Response.md | 1 + ...tepackageCreateObjectV1ResponseMPayload.md | 1 + ...gntemplatepackageDeleteObjectV1Response.md | 1 + ...itEzsigntemplatepackagesignersV1Request.md | 1 + ...tEzsigntemplatepackagesignersV1Response.md | 1 + ...emplatepackagesignersV1ResponseMPayload.md | 1 + ...zsigntemplatepackageEditObjectV1Request.md | 1 + ...signtemplatepackageEditObjectV1Response.md | 1 + ...emplatepackageGetAutocompleteV2Response.md | 1 + ...ackageGetAutocompleteV2ResponseMPayload.md | 1 + .../EzsigntemplatepackageGetListV1Response.md | 1 + ...emplatepackageGetListV1ResponseMPayload.md | 1 + ...zsigntemplatepackageGetObjectV2Response.md | 1 + ...platepackageGetObjectV2ResponseMPayload.md | 1 + docs/EzsigntemplatepackageListElement.md | 1 + docs/EzsigntemplatepackageRequest.md | 1 + docs/EzsigntemplatepackageRequestCompound.md | 1 + docs/EzsigntemplatepackageResponse.md | 1 + docs/EzsigntemplatepackageResponseCompound.md | 1 + ...epackagemembershipCreateObjectV1Request.md | 1 + ...packagemembershipCreateObjectV1Response.md | 1 + ...embershipCreateObjectV1ResponseMPayload.md | 1 + ...packagemembershipDeleteObjectV1Response.md | 1 + ...atepackagemembershipGetObjectV2Response.md | 1 + ...gemembershipGetObjectV2ResponseMPayload.md | 1 + .../EzsigntemplatepackagemembershipRequest.md | 1 + ...emplatepackagemembershipRequestCompound.md | 1 + ...EzsigntemplatepackagemembershipResponse.md | 1 + ...mplatepackagemembershipResponseCompound.md | 1 + ...platepackagesignerCreateObjectV1Request.md | 1 + ...latepackagesignerCreateObjectV1Response.md | 1 + ...agesignerCreateObjectV1ResponseMPayload.md | 1 + ...latepackagesignerDeleteObjectV1Response.md | 1 + ...agesignerDeleteObjectV1ResponseMPayload.md | 1 + ...emplatepackagesignerEditObjectV1Request.md | 1 + ...mplatepackagesignerEditObjectV1Response.md | 1 + ...emplatepackagesignerGetObjectV2Response.md | 1 + ...ackagesignerGetObjectV2ResponseMPayload.md | 1 + docs/EzsigntemplatepackagesignerRequest.md | 1 + ...igntemplatepackagesignerRequestCompound.md | 1 + docs/EzsigntemplatepackagesignerResponse.md | 1 + ...gntemplatepackagesignerResponseCompound.md | 1 + ...gesignermembershipCreateObjectV1Request.md | 1 + ...esignermembershipCreateObjectV1Response.md | 1 + ...embershipCreateObjectV1ResponseMPayload.md | 1 + ...esignermembershipDeleteObjectV1Response.md | 1 + ...embershipDeleteObjectV1ResponseMPayload.md | 1 + ...kagesignermembershipGetObjectV2Response.md | 1 + ...ermembershipGetObjectV2ResponseMPayload.md | 1 + ...ntemplatepackagesignermembershipRequest.md | 1 + ...epackagesignermembershipRequestCompound.md | 1 + ...templatepackagesignermembershipResponse.md | 1 + ...packagesignermembershipResponseCompound.md | 1 + ...ntemplatesignatureCreateObjectV1Request.md | 1 + ...templatesignatureCreateObjectV1Response.md | 1 + ...signatureCreateObjectV1ResponseMPayload.md | 1 + ...templatesignatureDeleteObjectV1Response.md | 1 + ...igntemplatesignatureEditObjectV1Request.md | 1 + ...gntemplatesignatureEditObjectV1Response.md | 1 + ...igntemplatesignatureGetObjectV2Response.md | 1 + ...atesignatureGetObjectV2ResponseMPayload.md | 1 + docs/EzsigntemplatesignatureRequest.md | 1 + .../EzsigntemplatesignatureRequestCompound.md | 1 + docs/EzsigntemplatesignatureResponse.md | 1 + ...EzsigntemplatesignatureResponseCompound.md | 1 + ...zsigntemplatesignaturecustomdateRequest.md | 1 + ...platesignaturecustomdateRequestCompound.md | 1 + ...signtemplatesignaturecustomdateResponse.md | 1 + ...latesignaturecustomdateResponseCompound.md | 1 + ...signtemplatesignerCreateObjectV1Request.md | 1 + ...igntemplatesignerCreateObjectV1Response.md | 1 + ...atesignerCreateObjectV1ResponseMPayload.md | 1 + ...igntemplatesignerDeleteObjectV1Response.md | 1 + ...EzsigntemplatesignerEditObjectV1Request.md | 1 + ...zsigntemplatesignerEditObjectV1Response.md | 1 + ...EzsigntemplatesignerGetObjectV2Response.md | 1 + ...mplatesignerGetObjectV2ResponseMPayload.md | 1 + docs/EzsigntemplatesignerRequest.md | 1 + docs/EzsigntemplatesignerRequestCompound.md | 1 + docs/EzsigntemplatesignerResponse.md | 1 + docs/EzsigntemplatesignerResponseCompound.md | 1 + ...arequirementAutocompleteElementResponse.md | 1 + ...tsarequirementGetAutocompleteV2Response.md | 1 + ...rementGetAutocompleteV2ResponseMPayload.md | 1 + docs/FieldEActivesessionOrigin.md | 1 + docs/FieldEActivesessionUsertype.md | 1 + docs/FieldEActivesessionWeekdaystart.md | 1 + docs/FieldEAttachmentDocumenttype.md | 12 + docs/FieldEAttachmentPrivacy.md | 12 + docs/FieldEAttachmentType.md | 12 + docs/FieldEAttachmentVerified.md | 12 + docs/FieldEAttachmentlogType.md | 12 + docs/FieldEBrandingLogo.md | 1 + docs/FieldECommunicationImportance.md | 1 + docs/FieldECommunicationType.md | 1 + ...ieldECommunicationexternalrecipientType.md | 1 + docs/FieldECommunicationrecipientType.md | 1 + docs/FieldECreditcardtypeCodename.md | 1 + docs/FieldEErrorCode.md | 1 + docs/FieldEEzmaxinvoicingPaymenttype.md | 1 + ...FieldEEzmaxinvoicingagentVariationezmax.md | 1 + ...ieldEEzmaxinvoicingagentVariationezsign.md | 1 + ...FieldEEzmaxinvoicingcontractPaymenttype.md | 1 + ...FieldEEzmaxinvoicinguserVariationezsign.md | 1 + docs/FieldEEzsignannotationType.md | 1 + docs/FieldEEzsigndocumentStep.md | 1 + docs/FieldEEzsigndocumentlogType.md | 1 + docs/FieldEEzsignelementdependencyOperator.md | 1 + ...FieldEEzsignelementdependencyValidation.md | 1 + ...FieldEEzsignfolderSendreminderfrequency.md | 1 + docs/FieldEEzsignfolderStep.md | 1 + docs/FieldEEzsignfoldertypeDisposal.md | 1 + docs/FieldEEzsignfoldertypePrivacylevel.md | 1 + ...dEEzsignfoldertypeSendreminderfrequency.md | 1 + ...ldEEzsignformfieldDependencyrequirement.md | 1 + ...dEEzsignformfieldgroupSignerrequirement.md | 1 + ...eldEEzsignformfieldgroupTooltipposition.md | 1 + docs/FieldEEzsignformfieldgroupType.md | 1 + ...eldEEzsignsignatureAttachmentnamesource.md | 1 + ...ldEEzsignsignatureDependencyrequirement.md | 1 + docs/FieldEEzsignsignatureFont.md | 1 + docs/FieldEEzsignsignatureTooltipposition.md | 1 + docs/FieldEEzsignsignatureType.md | 3 +- ...EzsigntemplateelementdependencyOperator.md | 1 + ...signtemplateelementdependencyValidation.md | 1 + ...ntemplateformfieldDependencyrequirement.md | 1 + ...templateformfieldgroupSignerrequirement.md | 1 + ...gntemplateformfieldgroupTooltipposition.md | 1 + .../FieldEEzsigntemplateformfieldgroupType.md | 1 + ...gntemplatesignatureAttachmentnamesource.md | 1 + ...ntemplatesignatureDependencyrequirement.md | 1 + docs/FieldEEzsigntemplatesignatureFont.md | 1 + ...EEzsigntemplatesignatureTooltipposition.md | 1 + docs/FieldEEzsigntemplatesignatureType.md | 3 +- docs/FieldENotificationpreferenceStatus.md | 1 + docs/FieldEPaymenttermType.md | 1 + docs/FieldEPhoneType.md | 1 + docs/FieldESessionhistoryEndby.md | 1 + docs/FieldESystemconfigurationEzsign.md | 1 + docs/FieldESystemconfigurationLanguage1.md | 1 + docs/FieldESystemconfigurationLanguage2.md | 1 + ...ystemconfigurationNewexternaluseraction.md | 1 + docs/FieldEUserEzsignaccess.md | 3 +- docs/FieldEUserEzsignprepaid.md | 12 + docs/FieldEUserEzsignsendreminderfrequency.md | 1 + docs/FieldEUserLogintype.md | 1 + docs/FieldEUserOrigin.md | 1 + docs/FieldEUserType.md | 1 + docs/FieldEVariableexpenseTaxable.md | 1 + docs/FieldEVersionhistoryType.md | 1 + docs/FieldEVersionhistoryUsertype.md | 1 + docs/FieldEWebhookEzsignevent.md | 1 + docs/FieldEWebhookManagementevent.md | 1 + docs/FieldEWebhookModule.md | 1 + docs/FieldPksEzmaxclientOs.md | 1 + docs/FontAutocompleteElementResponse.md | 1 + docs/FontGetAutocompleteV2Response.md | 1 + docs/FontGetAutocompleteV2ResponseMPayload.md | 1 + ...nchisebrokerAutocompleteElementResponse.md | 1 + ...ranchisebrokerGetAutocompleteV2Response.md | 1 + ...brokerGetAutocompleteV2ResponseMPayload.md | 1 + ...nchiseofficeAutocompleteElementResponse.md | 1 + ...ranchiseofficeGetAutocompleteV2Response.md | 1 + ...officeGetAutocompleteV2ResponseMPayload.md | 1 + ...chisereferalincomeCreateObjectV1Request.md | 1 + ...hisereferalincomeCreateObjectV1Response.md | 1 + ...ralincomeCreateObjectV1ResponseMPayload.md | 1 + ...chisereferalincomeCreateObjectV2Request.md | 1 + ...hisereferalincomeCreateObjectV2Response.md | 1 + ...ralincomeCreateObjectV2ResponseMPayload.md | 1 + docs/FranchisereferalincomeRequest.md | 1 + docs/FranchisereferalincomeRequestCompound.md | 1 + docs/GlobalCustomerApi.md | 3 + docs/GlobalCustomerGetEndpointV1Response.md | 1 + docs/GlobalEzmaxclientApi.md | 3 + docs/GlobalEzmaxclientVersionV1Response.md | 2 + docs/GlobalEzmaxcustomerApi.md | 3 + ...EzmaxcustomerGetConfigurationV1Response.md | 1 + docs/HeaderAcceptLanguage.md | 1 + docs/InscriptionGetAttachmentsV1Response.md | 32 + ...riptionGetAttachmentsV1ResponseMPayload.md | 30 + ...scriptionGetCommunicationListV1Response.md | 1 + ...nGetCommunicationListV1ResponseMPayload.md | 1 + ...iptionGetCommunicationsendersV1Response.md | 32 + ...tCommunicationsendersV1ResponseMPayload.md | 30 + ...enticatedGetCommunicationListV1Response.md | 1 + ...dGetCommunicationListV1ResponseMPayload.md | 1 + ...ptiontempGetCommunicationListV1Response.md | 1 + ...pGetCommunicationListV1ResponseMPayload.md | 1 + docs/InvoiceGetAttachmentsV1Response.md | 32 + ...InvoiceGetAttachmentsV1ResponseMPayload.md | 30 + docs/InvoiceGetCommunicationListV1Response.md | 1 + ...eGetCommunicationListV1ResponseMPayload.md | 1 + docs/LanguageAutocompleteElementResponse.md | 1 + docs/LanguageGetAutocompleteV2Response.md | 1 + ...nguageGetAutocompleteV2ResponseMPayload.md | 1 + docs/ModuleEzsignApi.md | 6 + docs/ModuleReportApi.md | 3 + docs/ModuleResponse.md | 1 + docs/ModuleResponseCompound.md | 1 + docs/ModuleUserApi.md | 3 + docs/ModulegroupGetAllV1Response.md | 1 + docs/ModulegroupGetAllV1ResponseMPayload.md | 1 + docs/ModulegroupResponse.md | 1 + docs/ModulegroupResponseCompound.md | 1 + docs/ModulesectionResponse.md | 1 + docs/ModulesectionResponseCompound.md | 1 + docs/MultilingualApikeyDescription.md | 1 + ...lingualBillingentityinternalDescription.md | 1 + docs/MultilingualBrandingDescription.md | 1 + ...zmaxinvoicingsummaryinternalDescription.md | 1 + docs/MultilingualEzsignfoldertypeName.md | 1 + ...ultilingualEzsignsignergroupDescription.md | 1 + ...tilingualEzsignsigningreasonDescription.md | 31 + .../MultilingualNotificationsubsectionName.md | 1 + docs/MultilingualNotificationtestName.md | 1 + docs/MultilingualPaymenttermDescription.md | 1 + docs/MultilingualSubnetDescription.md | 1 + docs/MultilingualUsergroupName.md | 1 + .../MultilingualVariableexpenseDescription.md | 1 + docs/MultilingualVersionhistoryDetail.md | 1 + ...onsectionGetNotificationtestsV1Response.md | 1 + ...nGetNotificationtestsV1ResponseMPayload.md | 1 + docs/NotificationsubsectionResponse.md | 1 + docs/NotificationtestGetElementsV1Response.md | 1 + ...cationtestGetElementsV1ResponseMPayload.md | 1 + docs/NotificationtestResponse.md | 1 + docs/ObjectActivesessionApi.md | 6 + docs/ObjectApikeyApi.md | 27 + docs/ObjectAttachmentApi.md | 185 +- docs/ObjectBillingentityexternalApi.md | 3 + docs/ObjectBillingentityinternalApi.md | 15 + docs/ObjectBrandingApi.md | 15 + docs/ObjectBuyercontractApi.md | 3 + docs/ObjectClonehistoryApi.md | 3 + docs/ObjectCommunicationApi.md | 3 + docs/ObjectCompanyApi.md | 3 + docs/ObjectCorsApi.md | 12 + docs/ObjectDepartmentApi.md | 3 + docs/ObjectElectronicfundstransferApi.md | 15 +- docs/ObjectEmailtypeApi.md | 3 + docs/ObjectEzmaxinvoicingApi.md | 12 + docs/ObjectEzmaxproductApi.md | 3 + docs/ObjectEzsignbulksendApi.md | 33 + .../ObjectEzsignbulksenddocumentmappingApi.md | 9 + docs/ObjectEzsignbulksendsignermappingApi.md | 9 + docs/ObjectEzsignbulksendtransmissionApi.md | 12 + docs/ObjectEzsigndocumentApi.md | 161 + docs/ObjectEzsignfolderApi.md | 247 + .../ObjectEzsignfoldersignerassociationApi.md | 27 + docs/ObjectEzsignfoldertypeApi.md | 18 + docs/ObjectEzsignformfieldgroupApi.md | 12 + docs/ObjectEzsignpageApi.md | 3 + docs/ObjectEzsignsignatureApi.md | 24 + docs/ObjectEzsignsignergroupApi.md | 18 + docs/ObjectEzsignsignergroupmembershipApi.md | 9 + docs/ObjectEzsignsigningreasonApi.md | 442 + docs/ObjectEzsigntemplateApi.md | 24 + docs/ObjectEzsigntemplatedocumentApi.md | 33 + docs/ObjectEzsigntemplateformfieldgroupApi.md | 12 + docs/ObjectEzsigntemplatepackageApi.md | 21 + ...bjectEzsigntemplatepackagemembershipApi.md | 9 + docs/ObjectEzsigntemplatepackagesignerApi.md | 12 + ...zsigntemplatepackagesignermembershipApi.md | 9 + docs/ObjectEzsigntemplatesignatureApi.md | 12 + docs/ObjectEzsigntemplatesignerApi.md | 12 + docs/ObjectEzsigntsarequirementApi.md | 3 + docs/ObjectFontApi.md | 3 + docs/ObjectFranchisebrokerApi.md | 6 + docs/ObjectFranchiseofficeApi.md | 3 + docs/ObjectFranchisereferalincomeApi.md | 6 + docs/ObjectInscriptionApi.md | 169 + docs/ObjectInscriptionnotauthenticatedApi.md | 3 + docs/ObjectInscriptiontempApi.md | 3 + docs/ObjectInvoiceApi.md | 86 + docs/ObjectLanguageApi.md | 3 + docs/ObjectModulegroupApi.md | 3 + docs/ObjectNotificationsectionApi.md | 3 + docs/ObjectNotificationtestApi.md | 3 + docs/ObjectOtherincomeApi.md | 3 + docs/ObjectPaymenttermApi.md | 15 + docs/ObjectPeriodApi.md | 6 + docs/ObjectPermissionApi.md | 12 + docs/ObjectPhonetypeApi.md | 3 + docs/ObjectRejectedoffertopurchaseApi.md | 3 + docs/ObjectSecretquestionApi.md | 3 + docs/ObjectSessionhistoryApi.md | 3 + docs/ObjectSignatureApi.md | 12 + docs/ObjectSubnetApi.md | 12 + docs/ObjectSystemconfigurationApi.md | 6 + docs/ObjectTaxassignmentApi.md | 3 + docs/ObjectTimezoneApi.md | 3 + docs/ObjectUserApi.md | 33 + docs/ObjectUsergroupApi.md | 33 + docs/ObjectUsergroupdelegationApi.md | 12 + docs/ObjectUsergroupmembershipApi.md | 12 + docs/ObjectUserlogintypeApi.md | 3 + docs/ObjectUserstagedApi.md | 15 + docs/ObjectVariableexpenseApi.md | 15 + docs/ObjectVersionhistoryApi.md | 3 + docs/ObjectWebhookApi.md | 190 + ...herincomeGetCommunicationListV1Response.md | 1 + ...eGetCommunicationListV1ResponseMPayload.md | 1 + .../PaymenttermAutocompleteElementResponse.md | 1 + docs/PaymenttermCreateObjectV1Request.md | 1 + docs/PaymenttermCreateObjectV1Response.md | 1 + ...ymenttermCreateObjectV1ResponseMPayload.md | 1 + docs/PaymenttermEditObjectV1Request.md | 1 + docs/PaymenttermEditObjectV1Response.md | 1 + docs/PaymenttermGetAutocompleteV2Response.md | 1 + ...nttermGetAutocompleteV2ResponseMPayload.md | 1 + docs/PaymenttermGetListV1Response.md | 1 + docs/PaymenttermGetListV1ResponseMPayload.md | 1 + docs/PaymenttermGetObjectV2Response.md | 1 + .../PaymenttermGetObjectV2ResponseMPayload.md | 1 + docs/PaymenttermListElement.md | 1 + docs/PaymenttermRequest.md | 1 + docs/PaymenttermRequestCompound.md | 1 + docs/PaymenttermResponse.md | 1 + docs/PaymenttermResponseCompound.md | 1 + docs/PeriodAutocompleteElementResponse.md | 1 + docs/PeriodGetAutocompleteV2Response.md | 1 + ...PeriodGetAutocompleteV2ResponseMPayload.md | 1 + docs/PermissionCreateObjectV1Request.md | 1 + docs/PermissionCreateObjectV1Response.md | 1 + ...ermissionCreateObjectV1ResponseMPayload.md | 1 + docs/PermissionDeleteObjectV1Response.md | 1 + docs/PermissionEditObjectV1Request.md | 1 + docs/PermissionEditObjectV1Response.md | 1 + docs/PermissionGetObjectV2Response.md | 1 + docs/PermissionGetObjectV2ResponseMPayload.md | 1 + docs/PermissionRequest.md | 1 + docs/PermissionRequestCompound.md | 1 + docs/PermissionResponse.md | 1 + docs/PermissionResponseCompound.md | 1 + docs/PhoneRequest.md | 1 + docs/PhoneRequestCompound.md | 1 + docs/PhoneResponse.md | 1 + docs/PhoneResponseCompound.md | 2 + docs/PhonetypeAutocompleteElementResponse.md | 1 + docs/PhonetypeGetAutocompleteV2Response.md | 1 + ...netypeGetAutocompleteV2ResponseMPayload.md | 1 + ...opurchaseGetCommunicationListV1Response.md | 1 + ...eGetCommunicationListV1ResponseMPayload.md | 1 + docs/ScimAuthenticationScheme.md | 1 + docs/ScimEmail.md | 1 + docs/ScimGroup.md | 1 + docs/ScimGroupMember.md | 1 + docs/ScimGroupsApi.md | 15 + docs/ScimServiceProviderConfig.md | 1 + docs/ScimServiceProviderConfigApi.md | 3 + docs/ScimServiceProviderConfigBulk.md | 1 + ...ScimServiceProviderConfigChangePassword.md | 1 + docs/ScimServiceProviderConfigEtag.md | 1 + docs/ScimServiceProviderConfigFilter.md | 1 + docs/ScimServiceProviderConfigPatch.md | 1 + docs/ScimServiceProviderConfigSort.md | 1 + docs/ScimUser.md | 1 + docs/ScimUserList.md | 1 + docs/ScimUsersApi.md | 15 + ...cretquestionAutocompleteElementResponse.md | 1 + ...SecretquestionGetAutocompleteV2Response.md | 1 + ...estionGetAutocompleteV2ResponseMPayload.md | 1 + docs/SessionhistoryGetListV1Response.md | 1 + ...SessionhistoryGetListV1ResponseMPayload.md | 1 + docs/SessionhistoryListElement.md | 1 + docs/SignatureCreateObjectV1Request.md | 1 + docs/SignatureCreateObjectV1Response.md | 1 + ...SignatureCreateObjectV1ResponseMPayload.md | 1 + docs/SignatureDeleteObjectV1Response.md | 1 + docs/SignatureEditObjectV1Request.md | 1 + docs/SignatureEditObjectV1Response.md | 1 + docs/SignatureGetObjectV2Response.md | 1 + docs/SignatureGetObjectV2ResponseMPayload.md | 1 + docs/SignatureRequest.md | 1 + docs/SignatureRequestCompound.md | 1 + docs/SignatureResponse.md | 1 + docs/SignatureResponseCompound.md | 1 + docs/SubnetCreateObjectV1Request.md | 1 + docs/SubnetCreateObjectV1Response.md | 1 + docs/SubnetCreateObjectV1ResponseMPayload.md | 1 + docs/SubnetDeleteObjectV1Response.md | 1 + docs/SubnetEditObjectV1Request.md | 1 + docs/SubnetEditObjectV1Response.md | 1 + docs/SubnetGetObjectV2Response.md | 1 + docs/SubnetGetObjectV2ResponseMPayload.md | 1 + docs/SubnetRequest.md | 1 + docs/SubnetRequestCompound.md | 1 + docs/SubnetResponse.md | 1 + docs/SubnetResponseCompound.md | 1 + .../SystemconfigurationEditObjectV1Request.md | 1 + ...SystemconfigurationEditObjectV1Response.md | 1 + .../SystemconfigurationGetObjectV2Response.md | 1 + ...onfigurationGetObjectV2ResponseMPayload.md | 1 + docs/SystemconfigurationRequest.md | 1 + docs/SystemconfigurationRequestCompound.md | 1 + docs/SystemconfigurationResponse.md | 1 + docs/SystemconfigurationResponseCompound.md | 1 + ...axassignmentAutocompleteElementResponse.md | 1 + .../TaxassignmentGetAutocompleteV2Response.md | 1 + ...gnmentGetAutocompleteV2ResponseMPayload.md | 1 + docs/TextstylestaticResponse.md | 1 + docs/TextstylestaticResponseCompound.md | 1 + docs/TimezoneAutocompleteElementResponse.md | 1 + docs/TimezoneGetAutocompleteV2Response.md | 1 + ...mezoneGetAutocompleteV2ResponseMPayload.md | 1 + docs/UserAutocompleteElementResponse.md | 1 + docs/UserCreateEzsignuserV1Request.md | 1 + docs/UserCreateEzsignuserV1Response.md | 1 + .../UserCreateEzsignuserV1ResponseMPayload.md | 1 + docs/UserCreateObjectV1Request.md | 1 + docs/UserCreateObjectV1Response.md | 1 + docs/UserCreateObjectV1ResponseMPayload.md | 1 + docs/UserEditObjectV1Request.md | 1 + docs/UserEditObjectV1Response.md | 1 + docs/UserEditPermissionsV1Request.md | 1 + docs/UserEditPermissionsV1Response.md | 1 + docs/UserEditPermissionsV1ResponseMPayload.md | 1 + docs/UserGetApikeysV1Response.md | 1 + docs/UserGetApikeysV1ResponseMPayload.md | 1 + docs/UserGetAutocompleteV2Response.md | 1 + docs/UserGetAutocompleteV2ResponseMPayload.md | 1 + docs/UserGetEffectivePermissionsV1Response.md | 1 + ...tEffectivePermissionsV1ResponseMPayload.md | 1 + docs/UserGetListV1Response.md | 1 + docs/UserGetListV1ResponseMPayload.md | 1 + docs/UserGetObjectV2Response.md | 1 + docs/UserGetObjectV2ResponseMPayload.md | 1 + docs/UserGetPermissionsV1Response.md | 1 + docs/UserGetPermissionsV1ResponseMPayload.md | 1 + docs/UserGetSubnetsV1Response.md | 1 + docs/UserGetSubnetsV1ResponseMPayload.md | 1 + docs/UserListElement.md | 1 + docs/UserRequest.md | 1 + docs/UserRequestCompound.md | 1 + docs/UserResponse.md | 1 + docs/UserResponseCompound.md | 1 + docs/UserSendPasswordResetV1Response.md | 1 + docs/UsergroupAutocompleteElementResponse.md | 1 + docs/UsergroupCreateObjectV1Request.md | 1 + docs/UsergroupCreateObjectV1Response.md | 1 + ...UsergroupCreateObjectV1ResponseMPayload.md | 1 + docs/UsergroupEditObjectV1Request.md | 1 + docs/UsergroupEditObjectV1Response.md | 1 + docs/UsergroupEditPermissionsV1Request.md | 1 + docs/UsergroupEditPermissionsV1Response.md | 1 + ...rgroupEditPermissionsV1ResponseMPayload.md | 1 + ...rgroupEditUsergroupdelegationsV1Request.md | 1 + ...groupEditUsergroupdelegationsV1Response.md | 1 + ...tUsergroupdelegationsV1ResponseMPayload.md | 1 + ...rgroupEditUsergroupmembershipsV1Request.md | 1 + ...groupEditUsergroupmembershipsV1Response.md | 1 + ...tUsergroupmembershipsV1ResponseMPayload.md | 1 + docs/UsergroupGetAutocompleteV2Response.md | 1 + ...rgroupGetAutocompleteV2ResponseMPayload.md | 1 + docs/UsergroupGetListV1Response.md | 1 + docs/UsergroupGetListV1ResponseMPayload.md | 1 + docs/UsergroupGetObjectV2Response.md | 1 + docs/UsergroupGetObjectV2ResponseMPayload.md | 1 + docs/UsergroupGetPermissionsV1Response.md | 1 + ...ergroupGetPermissionsV1ResponseMPayload.md | 1 + ...rgroupGetUsergroupdelegationsV1Response.md | 1 + ...tUsergroupdelegationsV1ResponseMPayload.md | 1 + ...rgroupGetUsergroupmembershipsV1Response.md | 1 + ...tUsergroupmembershipsV1ResponseMPayload.md | 1 + docs/UsergroupListElement.md | 1 + docs/UsergroupRequest.md | 1 + docs/UsergroupRequestCompound.md | 1 + docs/UsergroupResponse.md | 1 + docs/UsergroupResponseCompound.md | 1 + ...sergroupdelegationCreateObjectV1Request.md | 1 + ...ergroupdelegationCreateObjectV1Response.md | 1 + ...elegationCreateObjectV1ResponseMPayload.md | 1 + ...ergroupdelegationDeleteObjectV1Response.md | 1 + .../UsergroupdelegationEditObjectV1Request.md | 1 + ...UsergroupdelegationEditObjectV1Response.md | 1 + .../UsergroupdelegationGetObjectV2Response.md | 1 + ...updelegationGetObjectV2ResponseMPayload.md | 1 + docs/UsergroupdelegationRequest.md | 1 + docs/UsergroupdelegationRequestCompound.md | 1 + docs/UsergroupdelegationResponse.md | 1 + docs/UsergroupdelegationResponseCompound.md | 1 + ...sergroupmembershipCreateObjectV1Request.md | 1 + ...ergroupmembershipCreateObjectV1Response.md | 1 + ...embershipCreateObjectV1ResponseMPayload.md | 1 + ...ergroupmembershipDeleteObjectV1Response.md | 1 + .../UsergroupmembershipEditObjectV1Request.md | 1 + ...UsergroupmembershipEditObjectV1Response.md | 1 + .../UsergroupmembershipGetObjectV2Response.md | 1 + ...upmembershipGetObjectV2ResponseMPayload.md | 1 + docs/UsergroupmembershipRequest.md | 1 + docs/UsergroupmembershipRequestCompound.md | 1 + docs/UsergroupmembershipResponse.md | 1 + docs/UsergroupmembershipResponseCompound.md | 1 + ...serlogintypeAutocompleteElementResponse.md | 1 + .../UserlogintypeGetAutocompleteV2Response.md | 1 + ...intypeGetAutocompleteV2ResponseMPayload.md | 1 + docs/UserstagedCreateUserV1Response.md | 1 + .../UserstagedCreateUserV1ResponseMPayload.md | 1 + docs/UserstagedDeleteObjectV1Response.md | 1 + docs/UserstagedGetListV1Response.md | 1 + docs/UserstagedGetListV1ResponseMPayload.md | 1 + docs/UserstagedGetObjectV2Response.md | 1 + docs/UserstagedGetObjectV2ResponseMPayload.md | 1 + docs/UserstagedListElement.md | 1 + docs/UserstagedMapV1Request.md | 1 + docs/UserstagedMapV1Response.md | 1 + docs/UserstagedResponse.md | 1 + docs/UserstagedResponseCompound.md | 1 + ...iableexpenseAutocompleteElementResponse.md | 1 + docs/VariableexpenseCreateObjectV1Request.md | 1 + docs/VariableexpenseCreateObjectV1Response.md | 1 + ...leexpenseCreateObjectV1ResponseMPayload.md | 1 + docs/VariableexpenseEditObjectV1Request.md | 1 + docs/VariableexpenseEditObjectV1Response.md | 1 + ...ariableexpenseGetAutocompleteV2Response.md | 1 + ...xpenseGetAutocompleteV2ResponseMPayload.md | 1 + docs/VariableexpenseGetListV1Response.md | 1 + ...ariableexpenseGetListV1ResponseMPayload.md | 1 + docs/VariableexpenseGetObjectV2Response.md | 1 + ...iableexpenseGetObjectV2ResponseMPayload.md | 1 + docs/VariableexpenseListElement.md | 1 + docs/VariableexpenseRequest.md | 1 + docs/VariableexpenseRequestCompound.md | 1 + docs/VariableexpenseResponse.md | 1 + docs/VariableexpenseResponseCompound.md | 1 + docs/VersionhistoryGetObjectV2Response.md | 1 + ...rsionhistoryGetObjectV2ResponseMPayload.md | 1 + docs/VersionhistoryResponse.md | 1 + docs/VersionhistoryResponseCompound.md | 1 + docs/WebhookCreateObjectV1Request.md | 1 + docs/WebhookCreateObjectV1Response.md | 1 + docs/WebhookCreateObjectV1ResponseMPayload.md | 1 + docs/WebhookCreateObjectV2Request.md | 30 + docs/WebhookCreateObjectV2Response.md | 32 + docs/WebhookCreateObjectV2ResponseMPayload.md | 30 + docs/WebhookDeleteObjectV1Response.md | 1 + docs/WebhookEditObjectV1Request.md | 1 + docs/WebhookEditObjectV1Response.md | 1 + docs/WebhookEzsignDocumentCompleted.md | 1 + docs/WebhookEzsignEzsignsignerAcceptclause.md | 1 + docs/WebhookEzsignEzsignsignerConnect.md | 1 + docs/WebhookEzsignFolderCompleted.md | 1 + docs/WebhookGetHistoryV1Response.md | 1 + docs/WebhookGetHistoryV1ResponseMPayload.md | 1 + docs/WebhookGetListV1Response.md | 1 + docs/WebhookGetListV1ResponseMPayload.md | 1 + docs/WebhookGetObjectV2Response.md | 1 + docs/WebhookGetObjectV2ResponseMPayload.md | 1 + docs/WebhookListElement.md | 2 + docs/WebhookRegenerateApikeyV1Request.md | 30 + docs/WebhookRegenerateApikeyV1Response.md | 32 + ...bhookRegenerateApikeyV1ResponseMPayload.md | 30 + docs/WebhookRequest.md | 2 + docs/WebhookRequestCompound.md | 2 + docs/WebhookResponse.md | 4 + docs/WebhookResponseCompound.md | 4 + docs/WebhookTestV1Response.md | 1 + docs/WebhookUserUserCreated.md | 1 + docs/WebhookUserstagedUserstagedCreated.md | 1 + docs/WebsiteRequest.md | 1 + docs/WebsiteRequestCompound.md | 1 + .../WebsocketRequestServerGetWebsocketIDV1.md | 1 + docs/WebsocketResponseErrorV1.md | 2 + docs/WebsocketResponseErrorV1MPayload.md | 1 + docs/WebsocketResponseGetWebsocketIDV1.md | 1 + ...bsocketResponseGetWebsocketIDV1MPayload.md | 1 + docs/WebsocketResponseInformationV1.md | 2 + .../WebsocketResponseInformationV1MPayload.md | 1 + eZmaxApi/__init__.py | 54 +- eZmaxApi/api/__init__.py | 1 + eZmaxApi/api/global_customer_api.py | 358 +- eZmaxApi/api/global_ezmaxclient_api.py | 335 +- eZmaxApi/api/global_ezmaxcustomer_api.py | 339 +- eZmaxApi/api/module_ezsign_api.py | 645 +- eZmaxApi/api/module_report_api.py | 345 +- eZmaxApi/api/module_user_api.py | 351 +- eZmaxApi/api/object_activesession_api.py | 736 +- eZmaxApi/api/object_apikey_api.py | 3078 +++-- eZmaxApi/api/object_attachment_api.py | 858 +- .../api/object_billingentityexternal_api.py | 386 +- .../api/object_billingentityinternal_api.py | 1790 ++- eZmaxApi/api/object_branding_api.py | 1786 ++- eZmaxApi/api/object_buyercontract_api.py | 338 +- eZmaxApi/api/object_clonehistory_api.py | 410 +- eZmaxApi/api/object_communication_api.py | 348 +- eZmaxApi/api/object_company_api.py | 386 +- eZmaxApi/api/object_cors_api.py | 1350 +- eZmaxApi/api/object_department_api.py | 386 +- .../api/object_electronicfundstransfer_api.py | 338 +- eZmaxApi/api/object_emailtype_api.py | 386 +- eZmaxApi/api/object_ezmaxinvoicing_api.py | 1387 ++- eZmaxApi/api/object_ezmaxproduct_api.py | 386 +- eZmaxApi/api/object_ezsignbulksend_api.py | 3952 ++++-- ...bject_ezsignbulksenddocumentmapping_api.py | 998 +- .../object_ezsignbulksendsignermapping_api.py | 994 +- .../object_ezsignbulksendtransmission_api.py | 1322 +- eZmaxApi/api/object_ezsigndocument_api.py | 9622 ++++++++++----- eZmaxApi/api/object_ezsignfolder_api.py | 10296 +++++++++++----- ...bject_ezsignfoldersignerassociation_api.py | 3111 +++-- eZmaxApi/api/object_ezsignfoldertype_api.py | 2158 +++- .../api/object_ezsignformfieldgroup_api.py | 1353 +- eZmaxApi/api/object_ezsignpage_api.py | 366 +- eZmaxApi/api/object_ezsignsignature_api.py | 2676 ++-- eZmaxApi/api/object_ezsignsignergroup_api.py | 2018 ++- .../object_ezsignsignergroupmembership_api.py | 995 +- .../api/object_ezsignsigningreason_api.py | 1518 +++ eZmaxApi/api/object_ezsigntemplate_api.py | 2796 +++-- .../api/object_ezsigntemplatedocument_api.py | 3916 ++++-- ...object_ezsigntemplateformfieldgroup_api.py | 1349 +- .../api/object_ezsigntemplatepackage_api.py | 2467 ++-- ...ect_ezsigntemplatepackagemembership_api.py | 998 +- .../object_ezsigntemplatepackagesigner_api.py | 1349 +- ...signtemplatepackagesignermembership_api.py | 998 +- .../api/object_ezsigntemplatesignature_api.py | 1349 +- .../api/object_ezsigntemplatesigner_api.py | 1349 +- .../api/object_ezsigntsarequirement_api.py | 403 +- eZmaxApi/api/object_font_api.py | 386 +- eZmaxApi/api/object_franchisebroker_api.py | 754 +- eZmaxApi/api/object_franchiseoffice_api.py | 386 +- .../api/object_franchisereferalincome_api.py | 688 +- eZmaxApi/api/object_inscription_api.py | 852 +- .../object_inscriptionnotauthenticated_api.py | 338 +- eZmaxApi/api/object_inscriptiontemp_api.py | 338 +- eZmaxApi/api/object_invoice_api.py | 592 +- eZmaxApi/api/object_language_api.py | 386 +- eZmaxApi/api/object_modulegroup_api.py | 330 +- .../api/object_notificationsection_api.py | 356 +- eZmaxApi/api/object_notificationtest_api.py | 338 +- eZmaxApi/api/object_otherincome_api.py | 338 +- eZmaxApi/api/object_paymentterm_api.py | 1789 ++- eZmaxApi/api/object_period_api.py | 754 +- eZmaxApi/api/object_permission_api.py | 1354 +- eZmaxApi/api/object_phonetype_api.py | 386 +- .../api/object_rejectedoffertopurchase_api.py | 338 +- eZmaxApi/api/object_secretquestion_api.py | 386 +- eZmaxApi/api/object_sessionhistory_api.py | 405 +- eZmaxApi/api/object_signature_api.py | 1350 +- eZmaxApi/api/object_subnet_api.py | 1358 +- .../api/object_systemconfiguration_api.py | 694 +- eZmaxApi/api/object_taxassignment_api.py | 386 +- eZmaxApi/api/object_timezone_api.py | 386 +- eZmaxApi/api/object_user_api.py | 3773 ++++-- eZmaxApi/api/object_usergroup_api.py | 3806 ++++-- .../api/object_usergroupdelegation_api.py | 1350 +- .../api/object_usergroupmembership_api.py | 1349 +- eZmaxApi/api/object_userlogintype_api.py | 386 +- eZmaxApi/api/object_userstaged_api.py | 1760 ++- eZmaxApi/api/object_variableexpense_api.py | 1790 ++- eZmaxApi/api/object_versionhistory_api.py | 338 +- eZmaxApi/api/object_webhook_api.py | 3028 +++-- eZmaxApi/api/scim_groups_api.py | 1625 ++- .../api/scim_service_provider_config_api.py | 315 +- eZmaxApi/api/scim_users_api.py | 1625 ++- eZmaxApi/api_client.py | 487 +- eZmaxApi/api_response.py | 26 +- eZmaxApi/configuration.py | 4 +- eZmaxApi/exceptions.py | 84 +- eZmaxApi/models/__init__.py | 53 +- .../activesession_get_current_v1_response.py | 70 +- ...ssion_get_current_v1_response_m_payload.py | 145 +- .../activesession_get_list_v1_response.py | 70 +- ...esession_get_list_v1_response_m_payload.py | 70 +- eZmaxApi/models/activesession_list_element.py | 119 +- eZmaxApi/models/activesession_response.py | 107 +- .../models/activesession_response_compound.py | 145 +- .../activesession_response_compound_apikey.py | 67 +- .../activesession_response_compound_user.py | 103 +- eZmaxApi/models/address_request.py | 95 +- eZmaxApi/models/address_request_compound.py | 95 +- .../models/apikey_create_object_v2_request.py | 63 +- .../apikey_create_object_v2_response.py | 70 +- ...key_create_object_v2_response_m_payload.py | 63 +- .../models/apikey_edit_object_v1_request.py | 62 +- .../models/apikey_edit_object_v1_response.py | 66 +- .../apikey_edit_permissions_v1_request.py | 62 +- .../apikey_edit_permissions_v1_response.py | 70 +- ..._edit_permissions_v1_response_m_payload.py | 63 +- .../models/apikey_get_cors_v1_response.py | 70 +- .../apikey_get_cors_v1_response_m_payload.py | 62 +- .../models/apikey_get_list_v1_response.py | 70 +- .../apikey_get_list_v1_response_m_payload.py | 70 +- .../models/apikey_get_object_v2_response.py | 70 +- ...apikey_get_object_v2_response_m_payload.py | 62 +- .../apikey_get_permissions_v1_response.py | 70 +- ...y_get_permissions_v1_response_m_payload.py | 62 +- .../models/apikey_get_subnets_v1_response.py | 70 +- ...pikey_get_subnets_v1_response_m_payload.py | 62 +- eZmaxApi/models/apikey_list_element.py | 87 +- .../models/apikey_regenerate_v1_request.py | 62 +- .../models/apikey_regenerate_v1_response.py | 70 +- ...apikey_regenerate_v1_response_m_payload.py | 62 +- eZmaxApi/models/apikey_request.py | 83 +- eZmaxApi/models/apikey_request_compound.py | 83 +- eZmaxApi/models/apikey_response.py | 99 +- eZmaxApi/models/apikey_response_compound.py | 99 +- .../models/attachment_download_v1_response.py | 82 - ...tachment_get_attachmentlogs_v1_response.py | 106 + ...et_attachmentlogs_v1_response_m_payload.py | 98 + ...attachment_get_download_url_v1_response.py | 106 + ..._get_download_url_v1_response_m_payload.py | 90 + eZmaxApi/models/attachment_response.py | 243 + .../models/attachment_response_compound.py | 243 + eZmaxApi/models/attachmentlog_response.py | 117 + .../models/attachmentlog_response_compound.py | 117 + eZmaxApi/models/attempt_response.py | 70 +- eZmaxApi/models/attempt_response_compound.py | 70 +- ...yexternal_autocomplete_element_response.py | 71 +- ...tyexternal_get_autocomplete_v2_response.py | 70 +- ..._get_autocomplete_v2_response_m_payload.py | 62 +- ...yinternal_autocomplete_element_response.py | 71 +- ...entityinternal_create_object_v1_request.py | 63 +- ...ntityinternal_create_object_v1_response.py | 70 +- ...nal_create_object_v1_response_m_payload.py | 63 +- ...ngentityinternal_edit_object_v1_request.py | 62 +- ...gentityinternal_edit_object_v1_response.py | 66 +- ...tyinternal_get_autocomplete_v2_response.py | 70 +- ..._get_autocomplete_v2_response_m_payload.py | 62 +- ...lingentityinternal_get_list_v1_response.py | 70 +- ...internal_get_list_v1_response_m_payload.py | 70 +- ...ngentityinternal_get_object_v2_response.py | 70 +- ...ternal_get_object_v2_response_m_payload.py | 62 +- .../billingentityinternal_list_element.py | 67 +- .../models/billingentityinternal_request.py | 67 +- .../billingentityinternal_request_compound.py | 71 +- .../models/billingentityinternal_response.py | 67 +- ...billingentityinternal_response_compound.py | 71 +- .../billingentityinternalproduct_request.py | 71 +- ...gentityinternalproduct_request_compound.py | 71 +- .../billingentityinternalproduct_response.py | 91 +- ...entityinternalproduct_response_compound.py | 91 +- .../branding_autocomplete_element_response.py | 71 +- .../branding_create_object_v1_request.py | 63 +- .../branding_create_object_v1_response.py | 70 +- ...ing_create_object_v1_response_m_payload.py | 63 +- .../models/branding_edit_object_v1_request.py | 62 +- .../branding_edit_object_v1_response.py | 66 +- .../branding_get_autocomplete_v2_response.py | 70 +- ..._get_autocomplete_v2_response_m_payload.py | 62 +- .../models/branding_get_list_v1_response.py | 70 +- ...branding_get_list_v1_response_m_payload.py | 70 +- .../models/branding_get_object_v2_response.py | 70 +- ...anding_get_object_v2_response_m_payload.py | 62 +- eZmaxApi/models/branding_list_element.py | 99 +- eZmaxApi/models/branding_request.py | 117 +- eZmaxApi/models/branding_request_compound.py | 117 +- eZmaxApi/models/branding_response.py | 121 +- eZmaxApi/models/branding_response_compound.py | 125 +- ...ract_get_communication_list_v1_response.py | 70 +- ...ommunication_list_v1_response_m_payload.py | 62 +- .../clonehistory_get_list_v1_response.py | 70 +- ...ehistory_get_list_v1_response_m_payload.py | 70 +- eZmaxApi/models/clonehistory_list_element.py | 115 +- eZmaxApi/models/common_audit.py | 66 +- eZmaxApi/models/common_auditdetail.py | 93 +- eZmaxApi/models/common_file.py | 78 +- .../common_get_autocomplete_v1_response.py | 70 +- .../common_get_list_v1_response_m_payload.py | 66 +- .../models/common_get_report_v1_response.py | 70 +- ...common_get_report_v1_response_m_payload.py | 62 +- eZmaxApi/models/common_report.py | 62 +- eZmaxApi/models/common_reportcell.py | 66 +- eZmaxApi/models/common_reportcellstyle.py | 94 +- eZmaxApi/models/common_reportcolumn.py | 66 +- eZmaxApi/models/common_reportgroup.py | 66 +- eZmaxApi/models/common_reportrow.py | 66 +- eZmaxApi/models/common_reportsection.py | 82 +- eZmaxApi/models/common_reportsubsection.py | 70 +- .../models/common_reportsubsectionpart.py | 68 +- eZmaxApi/models/common_response.py | 66 +- eZmaxApi/models/common_response_error.py | 69 +- ...on_response_error_ezsignform_validation.py | 75 +- ...mon_response_error_s_temporary_file_url.py | 75 +- ...common_response_error_too_many_requests.py | 69 +- eZmaxApi/models/common_response_filter.py | 70 +- eZmaxApi/models/common_response_get_list.py | 66 +- eZmaxApi/models/common_response_obj_debug.py | 82 +- .../common_response_obj_debug_payload.py | 74 +- ...mon_response_obj_debug_payload_get_list.py | 95 +- .../models/common_response_obj_sql_query.py | 66 +- ...sponse_redirect_s_secretquestion_text_x.py | 62 +- eZmaxApi/models/common_response_warning.py | 66 +- eZmaxApi/models/common_webhook.py | 66 +- ...ion_create_object_v1_response_m_payload.py | 63 +- eZmaxApi/models/communication_request.py | 111 +- .../models/communication_request_compound.py | 127 +- .../models/communication_send_v1_request.py | 63 +- .../models/communication_send_v1_response.py | 70 +- .../models/communicationattachment_request.py | 75 +- ...ommunicationattachment_request_compound.py | 75 +- .../communicationexternalrecipient_request.py | 90 +- ...ationexternalrecipient_request_compound.py | 90 +- .../models/communicationrecipient_request.py | 119 +- ...communicationrecipient_request_compound.py | 119 +- .../models/communicationreference_request.py | 99 +- ...communicationreference_request_compound.py | 99 +- .../company_autocomplete_element_response.py | 71 +- .../company_get_autocomplete_v2_response.py | 70 +- ..._get_autocomplete_v2_response_m_payload.py | 62 +- .../computed_e_communication_direction.py | 11 +- .../computed_e_ezsigndocument_steptype.py | 11 +- eZmaxApi/models/contact_request.py | 87 +- eZmaxApi/models/contact_request_compound.py | 91 +- .../models/contactinformations_request.py | 74 +- .../contactinformations_request_compound.py | 94 +- .../models/cors_create_object_v1_request.py | 63 +- .../models/cors_create_object_v1_response.py | 70 +- ...ors_create_object_v1_response_m_payload.py | 63 +- .../models/cors_delete_object_v1_response.py | 66 +- .../models/cors_edit_object_v1_request.py | 62 +- .../models/cors_edit_object_v1_response.py | 66 +- .../models/cors_get_object_v2_response.py | 70 +- .../cors_get_object_v2_response_m_payload.py | 62 +- eZmaxApi/models/cors_request.py | 75 +- eZmaxApi/models/cors_request_compound.py | 75 +- eZmaxApi/models/cors_response.py | 75 +- eZmaxApi/models/cors_response_compound.py | 75 +- eZmaxApi/models/custom_attachment_response.py | 272 + .../custom_attachmentdocumenttype_response.py | 101 + .../custom_autocomplete_element_response.py | 82 +- ...tom_communication_list_element_response.py | 105 +- .../custom_communicationattachment_request.py | 66 +- ...m_communicationrecipientsgroup_response.py | 66 +- ...mmunicationrecipientsrecipient_response.py | 145 +- .../custom_communicationsender_request.py | 79 +- .../custom_communicationsender_response.py | 124 +- .../models/custom_contact_name_response.py | 70 +- .../custom_creditcardtransaction_response.py | 83 +- .../models/custom_dropdown_element_request.py | 66 +- ...ustom_dropdown_element_request_compound.py | 66 +- .../custom_dropdown_element_response.py | 66 +- ...stom_dropdown_element_response_compound.py | 66 +- ..._ezmaxinvoicing_ezsigndocument_response.py | 83 +- ...om_ezmaxinvoicing_ezsignfolder_response.py | 87 +- .../models/custom_ezmaxpricing_response.py | 79 +- ...ent_ezsignsignatures_automatic_response.py | 71 +- ...der_ezsignsignatures_automatic_response.py | 71 +- ...association_actionable_element_response.py | 103 +- ...nfoldersignerassociationmessage_request.py | 67 +- ...nfoldersignerassociationstatus_response.py | 83 +- ...ustom_ezsignfoldertransmission_response.py | 87 +- ...zsignfoldertransmission_signer_response.py | 71 +- .../custom_ezsignfoldertype_response.py | 93 +- .../models/custom_ezsignformfield_request.py | 75 +- .../custom_ezsignformfielderror_response.py | 66 +- ...ustom_ezsignformfielderrortest_response.py | 71 +- .../custom_ezsignformfieldgroup_request.py | 71 +- ...ure_ezsignsignatures_automatic_response.py | 71 +- .../custom_ezsignsignaturestatus_response.py | 78 +- .../custom_form_data_document_response.py | 83 +- ...stom_form_data_ezsignformfield_response.py | 66 +- ...form_data_ezsignformfieldgroup_response.py | 67 +- .../custom_form_data_signer_response.py | 83 +- .../custom_forms_data_folder_response.py | 71 +- ..._ezsigntemplatepackage_relation_request.py | 71 +- ...subsectiongetnotificationtests_response.py | 87 +- ...cationtestgetnotificationtests_response.py | 91 +- eZmaxApi/models/custom_user_response.py | 75 +- eZmaxApi/models/custom_webhook_response.py | 121 +- eZmaxApi/models/custom_webhooklog_response.py | 66 +- ...custom_word_position_occurence_response.py | 71 +- .../custom_word_position_word_response.py | 66 +- ...epartment_autocomplete_element_response.py | 75 +- ...department_get_autocomplete_v2_response.py | 70 +- ..._get_autocomplete_v2_response_m_payload.py | 62 +- ...sfer_get_communication_list_v1_response.py | 70 +- ...ommunication_list_v1_response_m_payload.py | 62 +- eZmaxApi/models/email_request.py | 71 +- eZmaxApi/models/email_request_compound.py | 71 +- eZmaxApi/models/email_response.py | 71 +- eZmaxApi/models/email_response_compound.py | 71 +- ...emailtype_autocomplete_element_response.py | 75 +- .../emailtype_get_autocomplete_v2_response.py | 70 +- ..._get_autocomplete_v2_response_m_payload.py | 62 +- eZmaxApi/models/enum_fontunderline.py | 11 +- eZmaxApi/models/enum_fontweight.py | 11 +- eZmaxApi/models/enum_horizontalalignment.py | 11 +- eZmaxApi/models/enum_textvalidation.py | 11 +- eZmaxApi/models/enum_verticalalignment.py | 11 +- ...invoicing_autocomplete_element_response.py | 71 +- ...xinvoicing_get_autocomplete_v2_response.py | 70 +- ..._get_autocomplete_v2_response_m_payload.py | 62 +- .../ezmaxinvoicing_get_object_v2_response.py | 70 +- ...oicing_get_object_v2_response_m_payload.py | 62 +- ...axinvoicing_get_provisional_v1_response.py | 70 +- ...g_get_provisional_v1_response_m_payload.py | 155 +- eZmaxApi/models/ezmaxinvoicing_response.py | 119 +- .../ezmaxinvoicing_response_compound.py | 155 +- .../models/ezmaxinvoicingagent_response.py | 143 +- .../ezmaxinvoicingagent_response_compound.py | 147 +- .../ezmaxinvoicingcommission_response.py | 97 +- ...axinvoicingcommission_response_compound.py | 101 +- .../models/ezmaxinvoicingcontract_response.py | 103 +- ...zmaxinvoicingcontract_response_compound.py | 103 +- .../ezmaxinvoicingsummaryexternal_response.py | 83 +- ...oicingsummaryexternal_response_compound.py | 87 +- ...invoicingsummaryexternaldetail_response.py | 111 +- ...summaryexternaldetail_response_compound.py | 111 +- .../ezmaxinvoicingsummaryglobal_response.py | 159 +- ...nvoicingsummaryglobal_response_compound.py | 163 +- .../ezmaxinvoicingsummaryinternal_response.py | 87 +- ...oicingsummaryinternal_response_compound.py | 91 +- ...invoicingsummaryinternaldetail_response.py | 119 +- ...summaryinternaldetail_response_compound.py | 119 +- .../models/ezmaxinvoicinguser_response.py | 99 +- .../ezmaxinvoicinguser_response_compound.py | 103 +- ...axproduct_autocomplete_element_response.py | 71 +- ...maxproduct_get_autocomplete_v2_response.py | 70 +- ..._get_autocomplete_v2_response_m_payload.py | 62 +- .../ezsign_suggest_signers_v1_response.py | 70 +- ...n_suggest_signers_v1_response_m_payload.py | 70 +- .../ezsign_suggest_templates_v1_response.py | 70 +- ...suggest_templates_v1_response_m_payload.py | 66 +- eZmaxApi/models/ezsignannotation_response.py | 107 +- .../ezsignannotation_response_compound.py | 111 +- ...e_ezsignbulksendtransmission_v1_request.py | 91 +- ..._ezsignbulksendtransmission_v1_response.py | 70 +- ...ksendtransmission_v1_response_m_payload.py | 62 +- ...ezsignbulksend_create_object_v1_request.py | 63 +- ...zsignbulksend_create_object_v1_response.py | 70 +- ...end_create_object_v1_response_m_payload.py | 63 +- ...zsignbulksend_delete_object_v1_response.py | 66 +- .../ezsignbulksend_edit_object_v1_request.py | 62 +- .../ezsignbulksend_edit_object_v1_response.py | 66 +- ...ezsignbulksendtransmissions_v1_response.py | 70 +- ...sendtransmissions_v1_response_m_payload.py | 62 +- ..._ezsignsignatures_automatic_v1_response.py | 70 +- ...natures_automatic_v1_response_m_payload.py | 66 +- ...signbulksend_get_forms_data_v1_response.py | 70 +- ...nd_get_forms_data_v1_response_m_payload.py | 62 +- .../ezsignbulksend_get_list_v1_response.py | 70 +- ...bulksend_get_list_v1_response_m_payload.py | 70 +- .../ezsignbulksend_get_object_v2_response.py | 70 +- ...lksend_get_object_v2_response_m_payload.py | 62 +- .../models/ezsignbulksend_list_element.py | 107 +- .../ezsignbulksend_reorder_v1_request.py | 63 +- .../ezsignbulksend_reorder_v1_response.py | 66 +- eZmaxApi/models/ezsignbulksend_request.py | 91 +- .../models/ezsignbulksend_request_compound.py | 91 +- eZmaxApi/models/ezsignbulksend_response.py | 107 +- .../ezsignbulksend_response_compound.py | 115 +- ...ocumentmapping_create_object_v1_request.py | 63 +- ...cumentmapping_create_object_v1_response.py | 70 +- ...ing_create_object_v1_response_m_payload.py | 63 +- ...cumentmapping_delete_object_v1_response.py | 66 +- ...ddocumentmapping_get_object_v2_response.py | 70 +- ...apping_get_object_v2_response_m_payload.py | 62 +- .../ezsignbulksenddocumentmapping_request.py | 75 +- ...ulksenddocumentmapping_request_compound.py | 75 +- .../ezsignbulksenddocumentmapping_response.py | 83 +- ...lksenddocumentmapping_response_compound.py | 91 +- ...dsignermapping_create_object_v1_request.py | 63 +- ...signermapping_create_object_v1_response.py | 70 +- ...ing_create_object_v1_response_m_payload.py | 63 +- ...signermapping_delete_object_v1_response.py | 66 +- ...endsignermapping_get_object_v2_response.py | 70 +- ...apping_get_object_v2_response_m_payload.py | 62 +- .../ezsignbulksendsignermapping_request.py | 75 +- ...nbulksendsignermapping_request_compound.py | 75 +- .../ezsignbulksendsignermapping_response.py | 75 +- ...bulksendsignermapping_response_compound.py | 75 +- ..._ezsignsignatures_automatic_v1_response.py | 70 +- ...natures_automatic_v1_response_m_payload.py | 66 +- ...transmission_get_forms_data_v1_response.py | 70 +- ...on_get_forms_data_v1_response_m_payload.py | 62 +- ...sendtransmission_get_object_v2_response.py | 70 +- ...ission_get_object_v2_response_m_payload.py | 62 +- .../ezsignbulksendtransmission_response.py | 83 +- ...nbulksendtransmission_response_compound.py | 87 +- ...ocument_apply_ezsigntemplate_v1_request.py | 71 +- ...cument_apply_ezsigntemplate_v1_response.py | 66 +- ...ocument_apply_ezsigntemplate_v2_request.py | 71 +- ...cument_apply_ezsigntemplate_v2_response.py | 66 +- ...ezsigndocument_create_object_v1_request.py | 66 +- ...zsigndocument_create_object_v1_response.py | 70 +- ...ent_create_object_v1_response_m_payload.py | 63 +- ...ezsigndocument_create_object_v2_request.py | 63 +- ...zsigndocument_create_object_v2_response.py | 70 +- ...ent_create_object_v2_response_m_payload.py | 63 +- ...signdocument_decline_to_sign_v1_request.py | 65 +- ...igndocument_decline_to_sign_v1_response.py | 66 +- ...zsigndocument_delete_object_v1_response.py | 66 +- ...t_edit_ezsignformfieldgroups_v1_request.py | 62 +- ..._edit_ezsignformfieldgroups_v1_response.py | 70 +- ...gnformfieldgroups_v1_response_m_payload.py | 63 +- ...cument_edit_ezsignsignatures_v1_request.py | 62 +- ...ument_edit_ezsignsignatures_v1_response.py | 70 +- ..._ezsignsignatures_v1_response_m_payload.py | 63 +- ...igndocument_end_prematurely_v1_response.py | 66 +- .../ezsigndocument_flatten_v1_response.py | 66 +- ...ent_get_actionable_elements_v1_response.py | 70 +- ...tionable_elements_v1_response_m_payload.py | 66 +- ...igndocument_get_attachments_v1_response.py | 106 + ...t_get_attachments_v1_response_m_payload.py | 98 + ...ment_get_completed_elements_v1_response.py | 70 +- ...ompleted_elements_v1_response_m_payload.py | 66 +- ...gndocument_get_download_url_v1_response.py | 70 +- ..._get_download_url_v1_response_m_payload.py | 62 +- ...ument_get_ezsignannotations_v1_response.py | 70 +- ...ezsignannotations_v1_response_m_payload.py | 62 +- ...t_get_ezsignformfieldgroups_v1_response.py | 70 +- ...gnformfieldgroups_v1_response_m_payload.py | 62 +- ...igndocument_get_ezsignpages_v1_response.py | 70 +- ...t_get_ezsignpages_v1_response_m_payload.py | 62 +- ..._ezsignsignatures_automatic_v1_response.py | 70 +- ...natures_automatic_v1_response_m_payload.py | 66 +- ...cument_get_ezsignsignatures_v1_response.py | 70 +- ..._ezsignsignatures_v1_response_m_payload.py | 62 +- ...zsigndocument_get_form_data_v1_response.py | 70 +- ...ent_get_form_data_v1_response_m_payload.py | 62 +- .../ezsigndocument_get_object_v1_response.py | 70 +- ...cument_get_object_v1_response_m_payload.py | 175 +- .../ezsigndocument_get_object_v2_response.py | 70 +- ...cument_get_object_v2_response_m_payload.py | 62 +- ...ocument_get_temporary_proof_v1_response.py | 70 +- ...t_temporary_proof_v1_response_m_payload.py | 62 +- ...document_get_words_positions_v1_request.py | 74 +- ...ocument_get_words_positions_v1_response.py | 70 +- .../ezsigndocument_patch_object_v1_request.py | 62 +- ...ezsigndocument_patch_object_v1_response.py | 66 +- eZmaxApi/models/ezsigndocument_request.py | 131 +- .../models/ezsigndocument_request_compound.py | 131 +- .../models/ezsigndocument_request_patch.py | 66 +- eZmaxApi/models/ezsigndocument_response.py | 151 +- .../ezsigndocument_response_compound.py | 175 +- ...gndocument_submit_ezsignform_v1_request.py | 67 +- ...ndocument_submit_ezsignform_v1_response.py | 66 +- .../ezsigndocument_unsend_v1_response.py | 66 +- eZmaxApi/models/ezsigndocumentlog_response.py | 95 +- .../ezsigndocumentlog_response_compound.py | 95 +- .../models/ezsignelementdependency_request.py | 101 +- ...zsignelementdependency_request_compound.py | 101 +- .../ezsignelementdependency_response.py | 101 +- ...signelementdependency_response_compound.py | 101 +- .../ezsignfolder_archive_v1_response.py | 66 +- .../ezsignfolder_batch_download_v1_request.py | 69 +- .../ezsignfolder_create_object_v1_request.py | 66 +- .../ezsignfolder_create_object_v1_response.py | 70 +- ...der_create_object_v1_response_m_payload.py | 63 +- .../ezsignfolder_create_object_v2_request.py | 63 +- .../ezsignfolder_create_object_v2_response.py | 70 +- ...der_create_object_v2_response_m_payload.py | 63 +- .../ezsignfolder_delete_object_v1_response.py | 66 +- ...folder_dispose_ezsignfolders_v1_request.py | 63 +- ...older_dispose_ezsignfolders_v1_response.py | 66 +- .../ezsignfolder_dispose_v1_response.py | 66 +- .../ezsignfolder_edit_object_v1_request.py | 62 +- .../ezsignfolder_edit_object_v1_response.py | 66 +- ...der_get_actionable_elements_v1_response.py | 70 +- ...tionable_elements_v1_response_m_payload.py | 66 +- ...folder_get_attachment_count_v1_response.py | 106 + ..._attachment_count_v1_response_m_payload.py | 90 + ...zsignfolder_get_attachments_v1_response.py | 106 + ...r_get_attachments_v1_response_m_payload.py | 98 + ...der_get_communication_count_v1_response.py | 70 +- ...mmunication_count_v1_response_m_payload.py | 62 +- ...lder_get_communication_list_v1_response.py | 70 +- ...ommunication_list_v1_response_m_payload.py | 62 +- ...get_communicationrecipients_v1_response.py | 70 +- ...icationrecipients_v1_response_m_payload.py | 62 +- ...er_get_communicationsenders_v1_response.py | 70 +- ...municationsenders_v1_response_m_payload.py | 62 +- ...nfolder_get_ezsigndocuments_v1_response.py | 70 +- ...t_ezsigndocuments_v1_response_m_payload.py | 62 +- ...ignfoldersignerassociations_v1_response.py | 70 +- ...ignerassociations_v1_response_m_payload.py | 62 +- ..._ezsignsignatures_automatic_v1_response.py | 70 +- ...natures_automatic_v1_response_m_payload.py | 66 +- ...ezsignfolder_get_forms_data_v1_response.py | 70 +- ...er_get_forms_data_v1_response_m_payload.py | 62 +- .../ezsignfolder_get_list_v1_response.py | 70 +- ...gnfolder_get_list_v1_response_m_payload.py | 70 +- .../ezsignfolder_get_object_v1_response.py | 70 +- ...folder_get_object_v1_response_m_payload.py | 153 +- .../ezsignfolder_get_object_v2_response.py | 70 +- ...folder_get_object_v2_response_m_payload.py | 62 +- ...signfoldersignerassociations_v1_request.py | 63 +- ...ignfoldersignerassociations_v1_response.py | 70 +- ...ignerassociations_v1_response_m_payload.py | 63 +- ...import_ezsigntemplatepackage_v1_request.py | 71 +- ...mport_ezsigntemplatepackage_v1_response.py | 70 +- ...gntemplatepackage_v1_response_m_payload.py | 62 +- eZmaxApi/models/ezsignfolder_list_element.py | 115 +- .../models/ezsignfolder_reorder_v1_request.py | 63 +- .../ezsignfolder_reorder_v1_response.py | 66 +- eZmaxApi/models/ezsignfolder_request.py | 93 +- .../models/ezsignfolder_request_compound.py | 93 +- eZmaxApi/models/ezsignfolder_response.py | 153 +- .../models/ezsignfolder_response_compound.py | 153 +- .../models/ezsignfolder_send_v1_request.py | 62 +- .../models/ezsignfolder_send_v1_response.py | 66 +- .../models/ezsignfolder_send_v2_request.py | 71 +- .../models/ezsignfolder_send_v2_response.py | 66 +- .../models/ezsignfolder_send_v3_request.py | 71 +- .../models/ezsignfolder_send_v3_response.py | 66 +- .../models/ezsignfolder_unsend_v1_response.py | 66 +- ...nerassociation_create_object_v1_request.py | 66 +- ...erassociation_create_object_v1_response.py | 70 +- ...ion_create_object_v1_response_m_payload.py | 63 +- ...nerassociation_create_object_v2_request.py | 63 +- ...erassociation_create_object_v2_response.py | 70 +- ...ion_create_object_v2_response_m_payload.py | 63 +- ...erassociation_delete_object_v1_response.py | 66 +- ...ignerassociation_edit_object_v1_request.py | 62 +- ...gnerassociation_edit_object_v1_response.py | 66 +- ...ssociation_force_disconnect_v1_response.py | 66 +- ...ion_get_in_person_login_url_v1_response.py | 70 +- ..._person_login_url_v1_response_m_payload.py | 62 +- ...ignerassociation_get_object_v1_response.py | 70 +- ...iation_get_object_v1_response_m_payload.py | 95 +- ...ignerassociation_get_object_v2_response.py | 70 +- ...iation_get_object_v2_response_m_payload.py | 62 +- ...gnerassociation_patch_object_v1_request.py | 62 +- ...nerassociation_patch_object_v1_response.py | 66 +- .../ezsignfoldersignerassociation_request.py | 87 +- ...oldersignerassociation_request_compound.py | 91 +- ...gnfoldersignerassociation_request_patch.py | 62 +- .../ezsignfoldersignerassociation_response.py | 83 +- ...ldersignerassociation_response_compound.py | 95 +- ...ignerassociation_response_compound_user.py | 83 +- ...oldertype_autocomplete_element_response.py | 75 +- ...signfoldertype_create_object_v1_request.py | 63 +- ...ignfoldertype_create_object_v1_response.py | 70 +- ...ype_create_object_v1_response_m_payload.py | 63 +- ...ezsignfoldertype_edit_object_v1_request.py | 62 +- ...zsignfoldertype_edit_object_v1_response.py | 66 +- ...foldertype_get_autocomplete_v2_response.py | 70 +- ..._get_autocomplete_v2_response_m_payload.py | 62 +- .../ezsignfoldertype_get_list_v1_response.py | 70 +- ...ldertype_get_list_v1_response_m_payload.py | 70 +- ...ezsignfoldertype_get_object_v2_response.py | 70 +- ...ertype_get_object_v2_response_m_payload.py | 62 +- .../models/ezsignfoldertype_list_element.py | 75 +- eZmaxApi/models/ezsignfoldertype_request.py | 207 +- .../ezsignfoldertype_request_compound.py | 215 +- eZmaxApi/models/ezsignfoldertype_response.py | 231 +- .../ezsignfoldertype_response_compound.py | 239 +- eZmaxApi/models/ezsignformfield_request.py | 111 +- .../ezsignformfield_request_compound.py | 115 +- eZmaxApi/models/ezsignformfield_response.py | 111 +- .../ezsignformfield_response_compound.py | 115 +- ...formfieldgroup_create_object_v1_request.py | 63 +- ...ormfieldgroup_create_object_v1_response.py | 70 +- ...oup_create_object_v1_response_m_payload.py | 63 +- ...ormfieldgroup_delete_object_v1_response.py | 66 +- ...gnformfieldgroup_edit_object_v1_request.py | 62 +- ...nformfieldgroup_edit_object_v1_response.py | 66 +- ...gnformfieldgroup_get_object_v2_response.py | 70 +- ...dgroup_get_object_v2_response_m_payload.py | 62 +- .../models/ezsignformfieldgroup_request.py | 129 +- .../ezsignformfieldgroup_request_compound.py | 141 +- .../models/ezsignformfieldgroup_response.py | 129 +- .../ezsignformfieldgroup_response_compound.py | 141 +- .../ezsignformfieldgroupsigner_request.py | 67 +- ...gnformfieldgroupsigner_request_compound.py | 67 +- .../ezsignformfieldgroupsigner_response.py | 67 +- ...nformfieldgroupsigner_response_compound.py | 67 +- .../models/ezsignpage_consult_v1_response.py | 66 +- eZmaxApi/models/ezsignpage_response.py | 91 +- .../models/ezsignpage_response_compound.py | 91 +- ...zsignsignature_create_object_v1_request.py | 66 +- ...signsignature_create_object_v1_response.py | 70 +- ...ure_create_object_v1_response_m_payload.py | 63 +- ...zsignsignature_create_object_v2_request.py | 63 +- ...signsignature_create_object_v2_response.py | 70 +- ...ure_create_object_v2_response_m_payload.py | 63 +- ...signsignature_delete_object_v1_response.py | 66 +- .../ezsignsignature_edit_object_v1_request.py | 62 +- ...ezsignsignature_edit_object_v1_response.py | 66 +- ...t_ezsignsignatureattachment_v1_response.py | 70 +- ...gnatureattachment_v1_response_m_payload.py | 62 +- ..._ezsignsignatures_automatic_v1_response.py | 70 +- ...natures_automatic_v1_response_m_payload.py | 66 +- .../ezsignsignature_get_object_v2_response.py | 70 +- ...nature_get_object_v2_response_m_payload.py | 62 +- eZmaxApi/models/ezsignsignature_request.py | 153 +- .../ezsignsignature_request_compound.py | 165 +- eZmaxApi/models/ezsignsignature_response.py | 193 +- .../ezsignsignature_response_compound.py | 209 +- .../models/ezsignsignature_sign_v1_request.py | 97 +- .../ezsignsignature_sign_v1_response.py | 66 +- .../ezsignsignatureattachment_response.py | 85 +- .../ezsignsignaturecustomdate_request.py | 75 +- ...ignsignaturecustomdate_request_compound.py | 75 +- .../ezsignsignaturecustomdate_response.py | 75 +- ...gnsignaturecustomdate_response_compound.py | 75 +- eZmaxApi/models/ezsignsigner_request.py | 85 +- .../models/ezsignsigner_request_compound.py | 89 +- .../ezsignsigner_request_compound_contact.py | 103 +- eZmaxApi/models/ezsignsigner_response.py | 83 +- .../models/ezsignsigner_response_compound.py | 87 +- .../ezsignsigner_response_compound_contact.py | 99 +- ...ignsignergroup_create_object_v1_request.py | 63 +- ...gnsignergroup_create_object_v1_response.py | 70 +- ...oup_create_object_v1_response_m_payload.py | 63 +- ...gnsignergroup_delete_object_v1_response.py | 66 +- ...ezsignsignergroupmemberships_v1_request.py | 62 +- ...zsignsignergroupmemberships_v1_response.py | 70 +- ...rgroupmemberships_v1_response_m_payload.py | 63 +- ...zsignsignergroup_edit_object_v1_request.py | 62 +- ...signsignergroup_edit_object_v1_response.py | 66 +- ...zsignsignergroupmemberships_v1_response.py | 70 +- ...rgroupmemberships_v1_response_m_payload.py | 62 +- ...zsignsignergroup_get_object_v2_response.py | 70 +- ...rgroup_get_object_v2_response_m_payload.py | 62 +- eZmaxApi/models/ezsignsignergroup_request.py | 71 +- .../ezsignsignergroup_request_compound.py | 71 +- eZmaxApi/models/ezsignsignergroup_response.py | 71 +- .../ezsignsignergroup_response_compound.py | 71 +- ...roupmembership_create_object_v1_request.py | 63 +- ...oupmembership_create_object_v1_response.py | 70 +- ...hip_create_object_v1_response_m_payload.py | 63 +- ...oupmembership_delete_object_v1_response.py | 66 +- ...rgroupmembership_get_object_v2_response.py | 70 +- ...ership_get_object_v2_response_m_payload.py | 62 +- .../ezsignsignergroupmembership_request.py | 83 +- ...nsignergroupmembership_request_compound.py | 83 +- .../ezsignsignergroupmembership_response.py | 83 +- ...signergroupmembership_response_compound.py | 83 +- ...ingreason_autocomplete_element_response.py | 102 + ...nsigningreason_create_object_v1_request.py | 99 + ...signingreason_create_object_v1_response.py | 106 + ...son_create_object_v1_response_m_payload.py | 91 + ...ignsigningreason_edit_object_v1_request.py | 94 + ...gnsigningreason_edit_object_v1_response.py | 100 + ...ningreason_get_autocomplete_v2_response.py | 106 + ..._get_autocomplete_v2_response_m_payload.py | 98 + ...zsignsigningreason_get_list_v1_response.py | 106 + ...ngreason_get_list_v1_response_m_payload.py | 102 + ...ignsigningreason_get_object_v2_response.py | 106 + ...reason_get_object_v2_response_m_payload.py | 94 + .../ezsignsigningreason_list_element.py | 102 + .../models/ezsignsigningreason_request.py | 99 + .../ezsignsigningreason_request_compound.py | 99 + .../models/ezsignsigningreason_response.py | 99 + .../ezsignsigningreason_response_compound.py | 99 + ...ntemplate_autocomplete_element_response.py | 75 +- .../models/ezsigntemplate_copy_v1_request.py | 63 +- .../models/ezsigntemplate_copy_v1_response.py | 70 +- ...signtemplate_copy_v1_response_m_payload.py | 63 +- ...ezsigntemplate_create_object_v1_request.py | 63 +- ...zsigntemplate_create_object_v1_response.py | 70 +- ...ate_create_object_v1_response_m_payload.py | 63 +- ...zsigntemplate_delete_object_v1_response.py | 66 +- .../ezsigntemplate_edit_object_v1_request.py | 62 +- .../ezsigntemplate_edit_object_v1_response.py | 66 +- ...gntemplate_get_autocomplete_v2_response.py | 70 +- ..._get_autocomplete_v2_response_m_payload.py | 62 +- .../ezsigntemplate_get_list_v1_response.py | 70 +- ...template_get_list_v1_response_m_payload.py | 70 +- .../ezsigntemplate_get_object_v1_response.py | 70 +- ...mplate_get_object_v1_response_m_payload.py | 107 +- .../ezsigntemplate_get_object_v2_response.py | 70 +- ...mplate_get_object_v2_response_m_payload.py | 62 +- .../models/ezsigntemplate_list_element.py | 99 +- eZmaxApi/models/ezsigntemplate_request.py | 83 +- .../models/ezsigntemplate_request_compound.py | 83 +- eZmaxApi/models/ezsigntemplate_response.py | 99 +- .../ezsigntemplate_response_compound.py | 107 +- ...mplatedocument_create_object_v1_request.py | 63 +- ...platedocument_create_object_v1_response.py | 70 +- ...ent_create_object_v1_response_m_payload.py | 63 +- ...zsigntemplateformfieldgroups_v1_request.py | 62 +- ...signtemplateformfieldgroups_v1_response.py | 70 +- ...teformfieldgroups_v1_response_m_payload.py | 63 +- ...dit_ezsigntemplatesignatures_v1_request.py | 62 +- ...it_ezsigntemplatesignatures_v1_response.py | 70 +- ...emplatesignatures_v1_response_m_payload.py | 63 +- ...templatedocument_edit_object_v1_request.py | 62 +- ...emplatedocument_edit_object_v1_response.py | 70 +- ...igntemplatedocument_flatten_v1_response.py | 66 +- ...ezsigntemplatedocumentpages_v1_response.py | 70 +- ...latedocumentpages_v1_response_m_payload.py | 62 +- ...signtemplateformfieldgroups_v1_response.py | 70 +- ...teformfieldgroups_v1_response_m_payload.py | 62 +- ...et_ezsigntemplatesignatures_v1_response.py | 70 +- ...emplatesignatures_v1_response_m_payload.py | 62 +- ...templatedocument_get_object_v2_response.py | 70 +- ...cument_get_object_v2_response_m_payload.py | 62 +- ...document_get_words_positions_v1_request.py | 74 +- ...ocument_get_words_positions_v1_response.py | 70 +- ...emplatedocument_patch_object_v1_request.py | 62 +- ...mplatedocument_patch_object_v1_response.py | 66 +- .../models/ezsigntemplatedocument_request.py | 117 +- ...ezsigntemplatedocument_request_compound.py | 117 +- .../ezsigntemplatedocument_request_patch.py | 62 +- .../models/ezsigntemplatedocument_response.py | 87 +- ...zsigntemplatedocument_response_compound.py | 87 +- .../ezsigntemplatedocumentpage_response.py | 91 +- ...ntemplatedocumentpage_response_compound.py | 91 +- ...ezsigntemplateelementdependency_request.py | 101 +- ...plateelementdependency_request_compound.py | 101 +- ...zsigntemplateelementdependency_response.py | 101 +- ...lateelementdependency_response_compound.py | 101 +- .../models/ezsigntemplateformfield_request.py | 107 +- ...zsigntemplateformfield_request_compound.py | 111 +- .../ezsigntemplateformfield_response.py | 107 +- ...signtemplateformfield_response_compound.py | 111 +- ...formfieldgroup_create_object_v1_request.py | 63 +- ...ormfieldgroup_create_object_v1_response.py | 70 +- ...oup_create_object_v1_response_m_payload.py | 63 +- ...ormfieldgroup_delete_object_v1_response.py | 66 +- ...teformfieldgroup_edit_object_v1_request.py | 62 +- ...eformfieldgroup_edit_object_v1_response.py | 66 +- ...teformfieldgroup_get_object_v2_response.py | 70 +- ...dgroup_get_object_v2_response_m_payload.py | 62 +- .../ezsigntemplateformfieldgroup_request.py | 129 +- ...templateformfieldgroup_request_compound.py | 141 +- .../ezsigntemplateformfieldgroup_response.py | 129 +- ...emplateformfieldgroup_response_compound.py | 141 +- ...igntemplateformfieldgroupsigner_request.py | 67 +- ...teformfieldgroupsigner_request_compound.py | 67 +- ...gntemplateformfieldgroupsigner_response.py | 67 +- ...eformfieldgroupsigner_response_compound.py | 67 +- ...tepackage_autocomplete_element_response.py | 83 +- ...emplatepackage_create_object_v1_request.py | 63 +- ...mplatepackage_create_object_v1_response.py | 70 +- ...age_create_object_v1_response_m_payload.py | 63 +- ...mplatepackage_delete_object_v1_response.py | 66 +- ...ezsigntemplatepackagesigners_v1_request.py | 62 +- ...zsigntemplatepackagesigners_v1_response.py | 70 +- ...atepackagesigners_v1_response_m_payload.py | 63 +- ...ntemplatepackage_edit_object_v1_request.py | 62 +- ...templatepackage_edit_object_v1_response.py | 66 +- ...atepackage_get_autocomplete_v2_response.py | 70 +- ..._get_autocomplete_v2_response_m_payload.py | 62 +- ...igntemplatepackage_get_list_v1_response.py | 70 +- ...epackage_get_list_v1_response_m_payload.py | 70 +- ...ntemplatepackage_get_object_v2_response.py | 70 +- ...ackage_get_object_v2_response_m_payload.py | 62 +- .../ezsigntemplatepackage_list_element.py | 95 +- .../models/ezsigntemplatepackage_request.py | 87 +- .../ezsigntemplatepackage_request_compound.py | 87 +- .../models/ezsigntemplatepackage_response.py | 99 +- ...ezsigntemplatepackage_response_compound.py | 107 +- ...kagemembership_create_object_v1_request.py | 63 +- ...agemembership_create_object_v1_response.py | 70 +- ...hip_create_object_v1_response_m_payload.py | 71 +- ...agemembership_delete_object_v1_response.py | 66 +- ...ackagemembership_get_object_v2_response.py | 70 +- ...ership_get_object_v2_response_m_payload.py | 62 +- ...ezsigntemplatepackagemembership_request.py | 71 +- ...platepackagemembership_request_compound.py | 71 +- ...zsigntemplatepackagemembership_response.py | 75 +- ...latepackagemembership_response_compound.py | 87 +- ...epackagesigner_create_object_v1_request.py | 63 +- ...packagesigner_create_object_v1_response.py | 70 +- ...ner_create_object_v1_response_m_payload.py | 63 +- ...packagesigner_delete_object_v1_response.py | 70 +- ...ner_delete_object_v1_response_m_payload.py | 66 +- ...atepackagesigner_edit_object_v1_request.py | 62 +- ...tepackagesigner_edit_object_v1_response.py | 66 +- ...atepackagesigner_get_object_v2_response.py | 70 +- ...signer_get_object_v2_response_m_payload.py | 62 +- .../ezsigntemplatepackagesigner_request.py | 71 +- ...ntemplatepackagesigner_request_compound.py | 71 +- .../ezsigntemplatepackagesigner_response.py | 71 +- ...templatepackagesigner_response_compound.py | 71 +- ...gnermembership_create_object_v1_request.py | 63 +- ...nermembership_create_object_v1_response.py | 70 +- ...hip_create_object_v1_response_m_payload.py | 63 +- ...nermembership_delete_object_v1_response.py | 70 +- ...hip_delete_object_v1_response_m_payload.py | 66 +- ...signermembership_get_object_v2_response.py | 70 +- ...ership_get_object_v2_response_m_payload.py | 62 +- ...templatepackagesignermembership_request.py | 83 +- ...ackagesignermembership_request_compound.py | 83 +- ...emplatepackagesignermembership_response.py | 83 +- ...ckagesignermembership_response_compound.py | 83 +- ...platesignature_create_object_v1_request.py | 63 +- ...latesignature_create_object_v1_response.py | 70 +- ...ure_create_object_v1_response_m_payload.py | 63 +- ...latesignature_delete_object_v1_response.py | 66 +- ...emplatesignature_edit_object_v1_request.py | 62 +- ...mplatesignature_edit_object_v1_response.py | 66 +- ...emplatesignature_get_object_v2_response.py | 70 +- ...nature_get_object_v2_response_m_payload.py | 62 +- .../models/ezsigntemplatesignature_request.py | 153 +- ...zsigntemplatesignature_request_compound.py | 165 +- .../ezsigntemplatesignature_response.py | 153 +- ...signtemplatesignature_response_compound.py | 165 +- ...signtemplatesignaturecustomdate_request.py | 75 +- ...atesignaturecustomdate_request_compound.py | 75 +- ...igntemplatesignaturecustomdate_response.py | 75 +- ...tesignaturecustomdate_response_compound.py | 75 +- ...templatesigner_create_object_v1_request.py | 63 +- ...emplatesigner_create_object_v1_response.py | 70 +- ...ner_create_object_v1_response_m_payload.py | 71 +- ...emplatesigner_delete_object_v1_response.py | 66 +- ...gntemplatesigner_edit_object_v1_request.py | 62 +- ...ntemplatesigner_edit_object_v1_response.py | 66 +- ...gntemplatesigner_get_object_v2_response.py | 70 +- ...signer_get_object_v2_response_m_payload.py | 62 +- .../models/ezsigntemplatesigner_request.py | 71 +- .../ezsigntemplatesigner_request_compound.py | 71 +- .../models/ezsigntemplatesigner_response.py | 71 +- .../ezsigntemplatesigner_response_compound.py | 71 +- ...quirement_autocomplete_element_response.py | 75 +- ...equirement_get_autocomplete_v2_response.py | 70 +- ..._get_autocomplete_v2_response_m_payload.py | 62 +- .../models/field_e_activesession_origin.py | 11 +- .../models/field_e_activesession_usertype.py | 11 +- .../field_e_activesession_weekdaystart.py | 11 +- .../models/field_e_attachment_documenttype.py | 93 + eZmaxApi/models/field_e_attachment_privacy.py | 50 + eZmaxApi/models/field_e_attachment_type.py | 49 + .../models/field_e_attachment_verified.py | 47 + eZmaxApi/models/field_e_attachmentlog_type.py | 73 + eZmaxApi/models/field_e_branding_logo.py | 11 +- .../field_e_communication_importance.py | 11 +- eZmaxApi/models/field_e_communication_type.py | 11 +- ...d_e_communicationexternalrecipient_type.py | 11 +- .../field_e_communicationrecipient_type.py | 11 +- .../models/field_e_creditcardtype_codename.py | 11 +- eZmaxApi/models/field_e_error_code.py | 11 +- .../field_e_ezmaxinvoicing_paymenttype.py | 11 +- ...ld_e_ezmaxinvoicingagent_variationezmax.py | 11 +- ...d_e_ezmaxinvoicingagent_variationezsign.py | 11 +- ...ld_e_ezmaxinvoicingcontract_paymenttype.py | 11 +- ...ld_e_ezmaxinvoicinguser_variationezsign.py | 11 +- .../models/field_e_ezsignannotation_type.py | 11 +- .../models/field_e_ezsigndocument_step.py | 11 +- .../models/field_e_ezsigndocumentlog_type.py | 11 +- ...ield_e_ezsignelementdependency_operator.py | 11 +- ...ld_e_ezsignelementdependency_validation.py | 11 +- ...ld_e_ezsignfolder_sendreminderfrequency.py | 11 +- eZmaxApi/models/field_e_ezsignfolder_step.py | 11 +- .../field_e_ezsignfoldertype_disposal.py | 11 +- .../field_e_ezsignfoldertype_privacylevel.py | 11 +- ..._ezsignfoldertype_sendreminderfrequency.py | 11 +- ...e_ezsignformfield_dependencyrequirement.py | 11 +- ..._ezsignformfieldgroup_signerrequirement.py | 11 +- ..._e_ezsignformfieldgroup_tooltipposition.py | 11 +- .../field_e_ezsignformfieldgroup_type.py | 13 +- ..._e_ezsignsignature_attachmentnamesource.py | 11 +- ...e_ezsignsignature_dependencyrequirement.py | 11 +- .../models/field_e_ezsignsignature_font.py | 11 +- ...field_e_ezsignsignature_tooltipposition.py | 11 +- .../models/field_e_ezsignsignature_type.py | 14 +- ...zsigntemplateelementdependency_operator.py | 11 +- ...igntemplateelementdependency_validation.py | 11 +- ...templateformfield_dependencyrequirement.py | 11 +- ...emplateformfieldgroup_signerrequirement.py | 11 +- ...ntemplateformfieldgroup_tooltipposition.py | 11 +- ...eld_e_ezsigntemplateformfieldgroup_type.py | 13 +- ...ntemplatesignature_attachmentnamesource.py | 11 +- ...templatesignature_dependencyrequirement.py | 11 +- .../field_e_ezsigntemplatesignature_font.py | 11 +- ...ezsigntemplatesignature_tooltipposition.py | 11 +- .../field_e_ezsigntemplatesignature_type.py | 14 +- .../field_e_notificationpreference_status.py | 11 +- eZmaxApi/models/field_e_paymentterm_type.py | 11 +- eZmaxApi/models/field_e_phone_type.py | 11 +- .../models/field_e_sessionhistory_endby.py | 11 +- .../field_e_systemconfiguration_ezsign.py | 11 +- .../field_e_systemconfiguration_language1.py | 11 +- .../field_e_systemconfiguration_language2.py | 11 +- ...stemconfiguration_newexternaluseraction.py | 11 +- eZmaxApi/models/field_e_user_ezsignaccess.py | 13 +- eZmaxApi/models/field_e_user_ezsignprepaid.py | 47 + ...ield_e_user_ezsignsendreminderfrequency.py | 11 +- eZmaxApi/models/field_e_user_logintype.py | 11 +- eZmaxApi/models/field_e_user_origin.py | 11 +- eZmaxApi/models/field_e_user_type.py | 11 +- .../models/field_e_variableexpense_taxable.py | 11 +- .../models/field_e_versionhistory_type.py | 11 +- .../models/field_e_versionhistory_usertype.py | 11 +- .../models/field_e_webhook_ezsignevent.py | 11 +- .../models/field_e_webhook_managementevent.py | 11 +- eZmaxApi/models/field_e_webhook_module.py | 11 +- eZmaxApi/models/field_pks_ezmaxclient_os.py | 12 +- .../font_autocomplete_element_response.py | 75 +- .../font_get_autocomplete_v2_response.py | 70 +- ..._get_autocomplete_v2_response_m_payload.py | 62 +- ...isebroker_autocomplete_element_response.py | 71 +- ...hisebroker_get_autocomplete_v2_response.py | 70 +- ..._get_autocomplete_v2_response_m_payload.py | 62 +- ...iseoffice_autocomplete_element_response.py | 71 +- ...hiseoffice_get_autocomplete_v2_response.py | 70 +- ..._get_autocomplete_v2_response_m_payload.py | 62 +- ...ereferalincome_create_object_v1_request.py | 66 +- ...referalincome_create_object_v1_response.py | 70 +- ...ome_create_object_v1_response_m_payload.py | 63 +- ...ereferalincome_create_object_v2_request.py | 63 +- ...referalincome_create_object_v2_response.py | 70 +- ...ome_create_object_v2_response_m_payload.py | 63 +- .../models/franchisereferalincome_request.py | 111 +- ...franchisereferalincome_request_compound.py | 119 +- ...lobal_customer_get_endpoint_v1_response.py | 62 +- .../global_ezmaxclient_version_v1_response.py | 64 +- ...xcustomer_get_configuration_v1_response.py | 82 +- eZmaxApi/models/header_accept_language.py | 11 +- ...inscription_get_attachments_v1_response.py | 106 + ...n_get_attachments_v1_response_m_payload.py | 98 + ...tion_get_communication_list_v1_response.py | 70 +- ...ommunication_list_v1_response_m_payload.py | 62 +- ...on_get_communicationsenders_v1_response.py | 106 + ...municationsenders_v1_response_m_payload.py | 98 + ...ated_get_communication_list_v1_response.py | 70 +- ...ommunication_list_v1_response_m_payload.py | 62 +- ...temp_get_communication_list_v1_response.py | 70 +- ...ommunication_list_v1_response_m_payload.py | 62 +- .../invoice_get_attachments_v1_response.py | 106 + ...e_get_attachments_v1_response_m_payload.py | 98 + ...oice_get_communication_list_v1_response.py | 70 +- ...ommunication_list_v1_response_m_payload.py | 62 +- .../language_autocomplete_element_response.py | 71 +- .../language_get_autocomplete_v2_response.py | 70 +- ..._get_autocomplete_v2_response_m_payload.py | 62 +- eZmaxApi/models/module_response.py | 87 +- eZmaxApi/models/module_response_compound.py | 91 +- .../models/modulegroup_get_all_v1_response.py | 70 +- ...dulegroup_get_all_v1_response_m_payload.py | 62 +- eZmaxApi/models/modulegroup_response.py | 69 +- .../models/modulegroup_response_compound.py | 75 +- eZmaxApi/models/modulesection_response.py | 75 +- .../models/modulesection_response_compound.py | 83 +- .../models/multilingual_apikey_description.py | 66 +- ...ngual_billingentityinternal_description.py | 71 +- .../multilingual_branding_description.py | 66 +- ...maxinvoicingsummaryinternal_description.py | 67 +- .../multilingual_ezsignfoldertype_name.py | 66 +- ...tilingual_ezsignsignergroup_description.py | 66 +- ...lingual_ezsignsigningreason_description.py | 113 + ...ultilingual_notificationsubsection_name.py | 66 +- .../multilingual_notificationtest_name.py | 66 +- .../multilingual_paymentterm_description.py | 71 +- .../models/multilingual_subnet_description.py | 71 +- .../models/multilingual_usergroup_name.py | 71 +- ...ultilingual_variableexpense_description.py | 71 +- .../multilingual_versionhistory_detail.py | 66 +- ...ction_get_notificationtests_v1_response.py | 70 +- ...notificationtests_v1_response_m_payload.py | 62 +- .../models/notificationsubsection_response.py | 83 +- ...tificationtest_get_elements_v1_response.py | 70 +- ...test_get_elements_v1_response_m_payload.py | 75 +- eZmaxApi/models/notificationtest_response.py | 83 +- ...come_get_communication_list_v1_response.py | 70 +- ...ommunication_list_v1_response_m_payload.py | 62 +- ...ymentterm_autocomplete_element_response.py | 75 +- .../paymentterm_create_object_v1_request.py | 63 +- .../paymentterm_create_object_v1_response.py | 70 +- ...erm_create_object_v1_response_m_payload.py | 62 +- .../paymentterm_edit_object_v1_request.py | 62 +- .../paymentterm_edit_object_v1_response.py | 66 +- ...aymentterm_get_autocomplete_v2_response.py | 70 +- ..._get_autocomplete_v2_response_m_payload.py | 62 +- .../paymentterm_get_list_v1_response.py | 70 +- ...mentterm_get_list_v1_response_m_payload.py | 70 +- .../paymentterm_get_object_v2_response.py | 70 +- ...ntterm_get_object_v2_response_m_payload.py | 62 +- eZmaxApi/models/paymentterm_list_element.py | 91 +- eZmaxApi/models/paymentterm_request.py | 89 +- .../models/paymentterm_request_compound.py | 89 +- eZmaxApi/models/paymentterm_response.py | 93 +- .../models/paymentterm_response_compound.py | 93 +- .../period_autocomplete_element_response.py | 71 +- .../period_get_autocomplete_v2_response.py | 70 +- ..._get_autocomplete_v2_response_m_payload.py | 62 +- .../permission_create_object_v1_request.py | 63 +- .../permission_create_object_v1_response.py | 70 +- ...ion_create_object_v1_response_m_payload.py | 63 +- .../permission_delete_object_v1_response.py | 66 +- .../permission_edit_object_v1_request.py | 62 +- .../permission_edit_object_v1_response.py | 66 +- .../permission_get_object_v2_response.py | 70 +- ...ission_get_object_v2_response_m_payload.py | 62 +- eZmaxApi/models/permission_request.py | 87 +- .../models/permission_request_compound.py | 87 +- eZmaxApi/models/permission_response.py | 91 +- .../models/permission_response_compound.py | 91 +- eZmaxApi/models/phone_request.py | 101 +- eZmaxApi/models/phone_request_compound.py | 101 +- eZmaxApi/models/phone_response.py | 85 +- eZmaxApi/models/phone_response_compound.py | 87 +- ...phonetype_autocomplete_element_response.py | 75 +- .../phonetype_get_autocomplete_v2_response.py | 70 +- ..._get_autocomplete_v2_response_m_payload.py | 62 +- ...hase_get_communication_list_v1_response.py | 70 +- ...ommunication_list_v1_response_m_payload.py | 62 +- eZmaxApi/models/scim_authentication_scheme.py | 64 +- eZmaxApi/models/scim_email.py | 58 +- eZmaxApi/models/scim_group.py | 65 +- eZmaxApi/models/scim_group_member.py | 60 +- .../models/scim_service_provider_config.py | 80 +- .../scim_service_provider_config_bulk.py | 68 +- ...service_provider_config_change_password.py | 60 +- .../scim_service_provider_config_etag.py | 60 +- .../scim_service_provider_config_filter.py | 64 +- .../scim_service_provider_config_patch.py | 60 +- .../scim_service_provider_config_sort.py | 60 +- eZmaxApi/models/scim_user.py | 66 +- eZmaxApi/models/scim_user_list.py | 76 +- ...tquestion_autocomplete_element_response.py | 71 +- ...etquestion_get_autocomplete_v2_response.py | 70 +- ..._get_autocomplete_v2_response_m_payload.py | 62 +- .../sessionhistory_get_list_v1_response.py | 70 +- ...nhistory_get_list_v1_response_m_payload.py | 70 +- .../models/sessionhistory_list_element.py | 113 +- .../signature_create_object_v1_request.py | 63 +- .../signature_create_object_v1_response.py | 70 +- ...ure_create_object_v1_response_m_payload.py | 63 +- .../signature_delete_object_v1_response.py | 66 +- .../signature_edit_object_v1_request.py | 62 +- .../signature_edit_object_v1_response.py | 66 +- .../signature_get_object_v2_response.py | 70 +- ...nature_get_object_v2_response_m_payload.py | 62 +- eZmaxApi/models/signature_request.py | 73 +- eZmaxApi/models/signature_request_compound.py | 73 +- eZmaxApi/models/signature_response.py | 69 +- .../models/signature_response_compound.py | 69 +- .../models/subnet_create_object_v1_request.py | 63 +- .../subnet_create_object_v1_response.py | 70 +- ...net_create_object_v1_response_m_payload.py | 63 +- .../subnet_delete_object_v1_response.py | 66 +- .../models/subnet_edit_object_v1_request.py | 62 +- .../models/subnet_edit_object_v1_response.py | 66 +- .../models/subnet_get_object_v2_response.py | 70 +- ...subnet_get_object_v2_response_m_payload.py | 62 +- eZmaxApi/models/subnet_request.py | 87 +- eZmaxApi/models/subnet_request_compound.py | 87 +- eZmaxApi/models/subnet_response.py | 87 +- eZmaxApi/models/subnet_response_compound.py | 87 +- ...temconfiguration_edit_object_v1_request.py | 62 +- ...emconfiguration_edit_object_v1_response.py | 66 +- ...temconfiguration_get_object_v2_response.py | 70 +- ...ration_get_object_v2_response_m_payload.py | 62 +- .../models/systemconfiguration_request.py | 103 +- .../systemconfiguration_request_compound.py | 103 +- .../models/systemconfiguration_response.py | 111 +- .../systemconfiguration_response_compound.py | 111 +- ...ssignment_autocomplete_element_response.py | 71 +- ...assignment_get_autocomplete_v2_response.py | 70 +- ..._get_autocomplete_v2_response_m_payload.py | 62 +- eZmaxApi/models/textstylestatic_response.py | 95 +- .../textstylestatic_response_compound.py | 95 +- .../timezone_autocomplete_element_response.py | 71 +- .../timezone_get_autocomplete_v2_response.py | 70 +- ..._get_autocomplete_v2_response_m_payload.py | 62 +- .../user_autocomplete_element_response.py | 75 +- .../user_create_ezsignuser_v1_request.py | 95 +- .../user_create_ezsignuser_v1_response.py | 70 +- ...create_ezsignuser_v1_response_m_payload.py | 66 +- .../models/user_create_object_v1_request.py | 63 +- .../models/user_create_object_v1_response.py | 70 +- ...ser_create_object_v1_response_m_payload.py | 63 +- .../models/user_edit_object_v1_request.py | 62 +- .../models/user_edit_object_v1_response.py | 66 +- .../user_edit_permissions_v1_request.py | 62 +- .../user_edit_permissions_v1_response.py | 70 +- ..._edit_permissions_v1_response_m_payload.py | 63 +- .../models/user_get_apikeys_v1_response.py | 70 +- .../user_get_apikeys_v1_response_m_payload.py | 63 +- .../user_get_autocomplete_v2_response.py | 70 +- ..._get_autocomplete_v2_response_m_payload.py | 62 +- ...r_get_effective_permissions_v1_response.py | 70 +- ...ctive_permissions_v1_response_m_payload.py | 62 +- eZmaxApi/models/user_get_list_v1_response.py | 70 +- .../user_get_list_v1_response_m_payload.py | 70 +- .../models/user_get_object_v2_response.py | 70 +- .../user_get_object_v2_response_m_payload.py | 62 +- .../user_get_permissions_v1_response.py | 70 +- ...r_get_permissions_v1_response_m_payload.py | 62 +- .../models/user_get_subnets_v1_response.py | 70 +- .../user_get_subnets_v1_response_m_payload.py | 62 +- eZmaxApi/models/user_list_element.py | 107 +- eZmaxApi/models/user_request.py | 173 +- eZmaxApi/models/user_request_compound.py | 173 +- eZmaxApi/models/user_response.py | 219 +- eZmaxApi/models/user_response_compound.py | 219 +- .../user_send_password_reset_v1_response.py | 66 +- ...usergroup_autocomplete_element_response.py | 75 +- .../usergroup_create_object_v1_request.py | 63 +- .../usergroup_create_object_v1_response.py | 70 +- ...oup_create_object_v1_response_m_payload.py | 63 +- .../usergroup_edit_object_v1_request.py | 62 +- .../usergroup_edit_object_v1_response.py | 66 +- .../usergroup_edit_permissions_v1_request.py | 62 +- .../usergroup_edit_permissions_v1_response.py | 70 +- ..._edit_permissions_v1_response_m_payload.py | 63 +- ...up_edit_usergroupdelegations_v1_request.py | 62 +- ...p_edit_usergroupdelegations_v1_response.py | 70 +- ...rgroupdelegations_v1_response_m_payload.py | 63 +- ...up_edit_usergroupmemberships_v1_request.py | 62 +- ...p_edit_usergroupmemberships_v1_response.py | 70 +- ...rgroupmemberships_v1_response_m_payload.py | 63 +- .../usergroup_get_autocomplete_v2_response.py | 70 +- ..._get_autocomplete_v2_response_m_payload.py | 62 +- .../models/usergroup_get_list_v1_response.py | 70 +- ...sergroup_get_list_v1_response_m_payload.py | 70 +- .../usergroup_get_object_v2_response.py | 70 +- ...rgroup_get_object_v2_response_m_payload.py | 62 +- .../usergroup_get_permissions_v1_response.py | 70 +- ...p_get_permissions_v1_response_m_payload.py | 62 +- ...up_get_usergroupdelegations_v1_response.py | 70 +- ...rgroupdelegations_v1_response_m_payload.py | 62 +- ...up_get_usergroupmemberships_v1_response.py | 70 +- ...rgroupmemberships_v1_response_m_payload.py | 62 +- eZmaxApi/models/usergroup_list_element.py | 75 +- eZmaxApi/models/usergroup_request.py | 67 +- eZmaxApi/models/usergroup_request_compound.py | 67 +- eZmaxApi/models/usergroup_response.py | 67 +- .../models/usergroup_response_compound.py | 67 +- ...roupdelegation_create_object_v1_request.py | 63 +- ...oupdelegation_create_object_v1_response.py | 70 +- ...ion_create_object_v1_response_m_payload.py | 63 +- ...oupdelegation_delete_object_v1_response.py | 66 +- ...rgroupdelegation_edit_object_v1_request.py | 62 +- ...groupdelegation_edit_object_v1_response.py | 66 +- ...rgroupdelegation_get_object_v2_response.py | 70 +- ...gation_get_object_v2_response_m_payload.py | 62 +- .../models/usergroupdelegation_request.py | 71 +- .../usergroupdelegation_request_compound.py | 71 +- .../models/usergroupdelegation_response.py | 99 +- .../usergroupdelegation_response_compound.py | 99 +- ...roupmembership_create_object_v1_request.py | 63 +- ...oupmembership_create_object_v1_response.py | 70 +- ...hip_create_object_v1_response_m_payload.py | 63 +- ...oupmembership_delete_object_v1_response.py | 66 +- ...rgroupmembership_edit_object_v1_request.py | 62 +- ...groupmembership_edit_object_v1_response.py | 66 +- ...rgroupmembership_get_object_v2_response.py | 70 +- ...ership_get_object_v2_response_m_payload.py | 62 +- .../models/usergroupmembership_request.py | 71 +- .../usergroupmembership_request_compound.py | 71 +- .../models/usergroupmembership_response.py | 99 +- .../usergroupmembership_response_compound.py | 99 +- ...logintype_autocomplete_element_response.py | 71 +- ...rlogintype_get_autocomplete_v2_response.py | 70 +- ..._get_autocomplete_v2_response_m_payload.py | 62 +- .../userstaged_create_user_v1_response.py | 70 +- ...taged_create_user_v1_response_m_payload.py | 63 +- .../userstaged_delete_object_v1_response.py | 66 +- .../models/userstaged_get_list_v1_response.py | 70 +- ...erstaged_get_list_v1_response_m_payload.py | 70 +- .../userstaged_get_object_v2_response.py | 70 +- ...staged_get_object_v2_response_m_payload.py | 62 +- eZmaxApi/models/userstaged_list_element.py | 89 +- eZmaxApi/models/userstaged_map_v1_request.py | 63 +- eZmaxApi/models/userstaged_map_v1_response.py | 66 +- eZmaxApi/models/userstaged_response.py | 93 +- .../models/userstaged_response_compound.py | 93 +- ...leexpense_autocomplete_element_response.py | 75 +- ...ariableexpense_create_object_v1_request.py | 63 +- ...riableexpense_create_object_v1_response.py | 70 +- ...nse_create_object_v1_response_m_payload.py | 63 +- .../variableexpense_edit_object_v1_request.py | 62 +- ...variableexpense_edit_object_v1_response.py | 66 +- ...bleexpense_get_autocomplete_v2_response.py | 70 +- ..._get_autocomplete_v2_response_m_payload.py | 62 +- .../variableexpense_get_list_v1_response.py | 70 +- ...eexpense_get_list_v1_response_m_payload.py | 70 +- .../variableexpense_get_object_v2_response.py | 70 +- ...xpense_get_object_v2_response_m_payload.py | 62 +- .../models/variableexpense_list_element.py | 87 +- eZmaxApi/models/variableexpense_request.py | 85 +- .../variableexpense_request_compound.py | 85 +- eZmaxApi/models/variableexpense_response.py | 85 +- .../variableexpense_response_compound.py | 85 +- .../versionhistory_get_object_v2_response.py | 70 +- ...istory_get_object_v2_response_m_payload.py | 62 +- eZmaxApi/models/versionhistory_response.py | 107 +- .../versionhistory_response_compound.py | 107 +- .../webhook_create_object_v1_request.py | 63 +- .../webhook_create_object_v1_response.py | 70 +- ...ook_create_object_v1_response_m_payload.py | 63 +- .../webhook_create_object_v2_request.py | 99 + .../webhook_create_object_v2_response.py | 106 + ...ook_create_object_v2_response_m_payload.py | 99 + .../webhook_delete_object_v1_response.py | 66 +- .../models/webhook_edit_object_v1_request.py | 62 +- .../models/webhook_edit_object_v1_response.py | 66 +- .../webhook_ezsign_document_completed.py | 70 +- ...ebhook_ezsign_ezsignsigner_acceptclause.py | 74 +- .../webhook_ezsign_ezsignsigner_connect.py | 74 +- .../models/webhook_ezsign_folder_completed.py | 70 +- .../models/webhook_get_history_v1_response.py | 70 +- ...bhook_get_history_v1_response_m_payload.py | 62 +- .../models/webhook_get_list_v1_response.py | 70 +- .../webhook_get_list_v1_response_m_payload.py | 70 +- .../models/webhook_get_object_v2_response.py | 70 +- ...ebhook_get_object_v2_response_m_payload.py | 62 +- eZmaxApi/models/webhook_list_element.py | 100 +- .../webhook_regenerate_apikey_v1_request.py | 90 + .../webhook_regenerate_apikey_v1_response.py | 106 + ...regenerate_apikey_v1_response_m_payload.py | 94 + eZmaxApi/models/webhook_request.py | 105 +- eZmaxApi/models/webhook_request_compound.py | 105 +- eZmaxApi/models/webhook_response.py | 113 +- eZmaxApi/models/webhook_response_compound.py | 117 +- eZmaxApi/models/webhook_test_v1_response.py | 66 +- eZmaxApi/models/webhook_user_user_created.py | 70 +- .../webhook_userstaged_userstaged_created.py | 70 +- eZmaxApi/models/website_request.py | 67 +- eZmaxApi/models/website_request_compound.py | 67 +- ...ocket_request_server_get_websocket_idv1.py | 64 +- .../models/websocket_response_error_v1.py | 80 +- .../websocket_response_error_v1_m_payload.py | 69 +- .../websocket_response_get_websocket_idv1.py | 68 +- ...t_response_get_websocket_idv1_m_payload.py | 65 +- .../websocket_response_information_v1.py | 80 +- ...ocket_response_information_v1_m_payload.py | 62 +- eZmaxApi/rest.py | 274 +- openapitools.json | 2 +- pyproject.toml | 4 +- requirements.txt | 4 +- setup.py | 4 +- ...t_activesession_get_current_v1_response.py | 4 +- ...ssion_get_current_v1_response_m_payload.py | 8 +- ...test_activesession_get_list_v1_response.py | 4 +- ...esession_get_list_v1_response_m_payload.py | 4 +- test/test_activesession_list_element.py | 4 +- test/test_activesession_response.py | 4 +- test/test_activesession_response_compound.py | 8 +- ..._activesession_response_compound_apikey.py | 4 +- ...st_activesession_response_compound_user.py | 4 +- test/test_address_request.py | 4 +- test/test_address_request_compound.py | 4 +- test/test_apikey_create_object_v2_request.py | 4 +- test/test_apikey_create_object_v2_response.py | 4 +- ...key_create_object_v2_response_m_payload.py | 4 +- test/test_apikey_edit_object_v1_request.py | 4 +- test/test_apikey_edit_object_v1_response.py | 4 +- ...test_apikey_edit_permissions_v1_request.py | 4 +- ...est_apikey_edit_permissions_v1_response.py | 4 +- ..._edit_permissions_v1_response_m_payload.py | 4 +- test/test_apikey_get_cors_v1_response.py | 4 +- ...t_apikey_get_cors_v1_response_m_payload.py | 4 +- test/test_apikey_get_list_v1_response.py | 4 +- ...t_apikey_get_list_v1_response_m_payload.py | 4 +- test/test_apikey_get_object_v2_response.py | 4 +- ...apikey_get_object_v2_response_m_payload.py | 4 +- ...test_apikey_get_permissions_v1_response.py | 4 +- ...y_get_permissions_v1_response_m_payload.py | 4 +- test/test_apikey_get_subnets_v1_response.py | 4 +- ...pikey_get_subnets_v1_response_m_payload.py | 4 +- test/test_apikey_list_element.py | 4 +- test/test_apikey_regenerate_v1_request.py | 4 +- test/test_apikey_regenerate_v1_response.py | 4 +- ...apikey_regenerate_v1_response_m_payload.py | 4 +- test/test_apikey_request.py | 4 +- test/test_apikey_request_compound.py | 4 +- test/test_apikey_response.py | 4 +- test/test_apikey_response_compound.py | 4 +- ...tachment_get_attachmentlogs_v1_response.py | 75 + ...et_attachmentlogs_v1_response_m_payload.py | 58 + ...attachment_get_download_url_v1_response.py | 69 + ..._get_download_url_v1_response_m_payload.py | 54 + test/test_attachment_response.py | 139 + test/test_attachment_response_compound.py | 139 + test/test_attachmentlog_response.py | 61 + test/test_attachmentlog_response_compound.py | 61 + test/test_attempt_response.py | 4 +- test/test_attempt_response_compound.py | 4 +- ...yexternal_autocomplete_element_response.py | 4 +- ...tyexternal_get_autocomplete_v2_response.py | 4 +- ..._get_autocomplete_v2_response_m_payload.py | 4 +- ...yinternal_autocomplete_element_response.py | 4 +- ...entityinternal_create_object_v1_request.py | 4 +- ...ntityinternal_create_object_v1_response.py | 4 +- ...nal_create_object_v1_response_m_payload.py | 4 +- ...ngentityinternal_edit_object_v1_request.py | 4 +- ...gentityinternal_edit_object_v1_response.py | 4 +- ...tyinternal_get_autocomplete_v2_response.py | 4 +- ..._get_autocomplete_v2_response_m_payload.py | 4 +- ...lingentityinternal_get_list_v1_response.py | 4 +- ...internal_get_list_v1_response_m_payload.py | 4 +- ...ngentityinternal_get_object_v2_response.py | 4 +- ...ternal_get_object_v2_response_m_payload.py | 4 +- ...test_billingentityinternal_list_element.py | 4 +- test/test_billingentityinternal_request.py | 4 +- ..._billingentityinternal_request_compound.py | 4 +- test/test_billingentityinternal_response.py | 4 +- ...billingentityinternal_response_compound.py | 4 +- ...st_billingentityinternalproduct_request.py | 4 +- ...gentityinternalproduct_request_compound.py | 4 +- ...t_billingentityinternalproduct_response.py | 4 +- ...entityinternalproduct_response_compound.py | 4 +- ..._branding_autocomplete_element_response.py | 4 +- .../test_branding_create_object_v1_request.py | 4 +- ...test_branding_create_object_v1_response.py | 4 +- ...ing_create_object_v1_response_m_payload.py | 4 +- test/test_branding_edit_object_v1_request.py | 4 +- test/test_branding_edit_object_v1_response.py | 4 +- ...t_branding_get_autocomplete_v2_response.py | 4 +- ..._get_autocomplete_v2_response_m_payload.py | 4 +- test/test_branding_get_list_v1_response.py | 4 +- ...branding_get_list_v1_response_m_payload.py | 4 +- test/test_branding_get_object_v2_response.py | 4 +- ...anding_get_object_v2_response_m_payload.py | 4 +- test/test_branding_list_element.py | 4 +- test/test_branding_request.py | 6 +- test/test_branding_request_compound.py | 6 +- test/test_branding_response.py | 4 +- test/test_branding_response_compound.py | 4 +- ...ract_get_communication_list_v1_response.py | 4 +- ...ommunication_list_v1_response_m_payload.py | 4 +- .../test_clonehistory_get_list_v1_response.py | 4 +- ...ehistory_get_list_v1_response_m_payload.py | 4 +- test/test_clonehistory_list_element.py | 4 +- test/test_common_audit.py | 4 +- test/test_common_auditdetail.py | 4 +- test/test_common_file.py | 6 +- ...est_common_get_autocomplete_v1_response.py | 4 +- ...t_common_get_list_v1_response_m_payload.py | 4 +- test/test_common_get_report_v1_response.py | 4 +- ...common_get_report_v1_response_m_payload.py | 4 +- test/test_common_report.py | 4 +- test/test_common_reportcell.py | 4 +- test/test_common_reportcellstyle.py | 4 +- test/test_common_reportcolumn.py | 4 +- test/test_common_reportgroup.py | 4 +- test/test_common_reportrow.py | 4 +- test/test_common_reportsection.py | 4 +- test/test_common_reportsubsection.py | 4 +- test/test_common_reportsubsectionpart.py | 4 +- test/test_common_response.py | 4 +- test/test_common_response_error.py | 4 +- ...on_response_error_ezsignform_validation.py | 4 +- ...mon_response_error_s_temporary_file_url.py | 4 +- ...common_response_error_too_many_requests.py | 4 +- test/test_common_response_filter.py | 4 +- test/test_common_response_get_list.py | 4 +- test/test_common_response_obj_debug.py | 4 +- .../test_common_response_obj_debug_payload.py | 4 +- ...mon_response_obj_debug_payload_get_list.py | 4 +- test/test_common_response_obj_sql_query.py | 4 +- ...sponse_redirect_s_secretquestion_text_x.py | 4 +- test/test_common_response_warning.py | 4 +- test/test_common_webhook.py | 4 +- ...ion_create_object_v1_response_m_payload.py | 4 +- test/test_communication_request.py | 5 +- test/test_communication_request_compound.py | 9 +- test/test_communication_send_v1_request.py | 4 +- test/test_communication_send_v1_response.py | 4 +- test/test_communicationattachment_request.py | 4 +- ...ommunicationattachment_request_compound.py | 4 +- ..._communicationexternalrecipient_request.py | 5 +- ...ationexternalrecipient_request_compound.py | 5 +- test/test_communicationrecipient_request.py | 8 +- ...communicationrecipient_request_compound.py | 8 +- test/test_communicationreference_request.py | 4 +- ...communicationreference_request_compound.py | 4 +- ...t_company_autocomplete_element_response.py | 4 +- ...st_company_get_autocomplete_v2_response.py | 4 +- ..._get_autocomplete_v2_response_m_payload.py | 4 +- ...test_computed_e_communication_direction.py | 2 +- ...test_computed_e_ezsigndocument_steptype.py | 2 +- test/test_contact_request.py | 4 +- test/test_contact_request_compound.py | 4 +- test/test_contactinformations_request.py | 4 +- ...st_contactinformations_request_compound.py | 4 +- test/test_cors_create_object_v1_request.py | 4 +- test/test_cors_create_object_v1_response.py | 4 +- ...ors_create_object_v1_response_m_payload.py | 4 +- test/test_cors_delete_object_v1_response.py | 4 +- test/test_cors_edit_object_v1_request.py | 4 +- test/test_cors_edit_object_v1_response.py | 4 +- test/test_cors_get_object_v2_response.py | 4 +- ...t_cors_get_object_v2_response_m_payload.py | 4 +- test/test_cors_request.py | 4 +- test/test_cors_request_compound.py | 4 +- test/test_cors_response.py | 4 +- test/test_cors_response_compound.py | 4 +- test/test_custom_attachment_response.py | 147 + ..._custom_attachmentdocumenttype_response.py | 60 + ...st_custom_autocomplete_element_response.py | 4 +- ...tom_communication_list_element_response.py | 4 +- ..._custom_communicationattachment_request.py | 6 +- ...m_communicationrecipientsgroup_response.py | 4 +- ...mmunicationrecipientsrecipient_response.py | 4 +- ...test_custom_communicationsender_request.py | 5 +- ...est_custom_communicationsender_response.py | 10 +- test/test_custom_contact_name_response.py | 4 +- ...t_custom_creditcardtransaction_response.py | 4 +- test/test_custom_dropdown_element_request.py | 4 +- ...ustom_dropdown_element_request_compound.py | 4 +- test/test_custom_dropdown_element_response.py | 4 +- ...stom_dropdown_element_response_compound.py | 4 +- ..._ezmaxinvoicing_ezsigndocument_response.py | 4 +- ...om_ezmaxinvoicing_ezsignfolder_response.py | 4 +- test/test_custom_ezmaxpricing_response.py | 4 +- ...ent_ezsignsignatures_automatic_response.py | 4 +- ...der_ezsignsignatures_automatic_response.py | 4 +- ...association_actionable_element_response.py | 4 +- ...nfoldersignerassociationmessage_request.py | 4 +- ...nfoldersignerassociationstatus_response.py | 4 +- ...ustom_ezsignfoldertransmission_response.py | 4 +- ...zsignfoldertransmission_signer_response.py | 4 +- test/test_custom_ezsignfoldertype_response.py | 7 +- test/test_custom_ezsignformfield_request.py | 4 +- ...st_custom_ezsignformfielderror_response.py | 4 +- ...ustom_ezsignformfielderrortest_response.py | 4 +- ...est_custom_ezsignformfieldgroup_request.py | 4 +- ...ure_ezsignsignatures_automatic_response.py | 4 +- ...t_custom_ezsignsignaturestatus_response.py | 4 +- ...test_custom_form_data_document_response.py | 4 +- ...stom_form_data_ezsignformfield_response.py | 4 +- ...form_data_ezsignformfieldgroup_response.py | 4 +- test/test_custom_form_data_signer_response.py | 4 +- .../test_custom_forms_data_folder_response.py | 4 +- ..._ezsigntemplatepackage_relation_request.py | 4 +- ...subsectiongetnotificationtests_response.py | 4 +- ...cationtestgetnotificationtests_response.py | 4 +- test/test_custom_user_response.py | 4 +- test/test_custom_webhook_response.py | 8 +- test/test_custom_webhooklog_response.py | 4 +- ...custom_word_position_occurence_response.py | 4 +- ...test_custom_word_position_word_response.py | 4 +- ...epartment_autocomplete_element_response.py | 4 +- ...department_get_autocomplete_v2_response.py | 4 +- ..._get_autocomplete_v2_response_m_payload.py | 4 +- ...sfer_get_communication_list_v1_response.py | 4 +- ...ommunication_list_v1_response_m_payload.py | 4 +- test/test_email_request.py | 4 +- test/test_email_request_compound.py | 4 +- test/test_email_response.py | 4 +- test/test_email_response_compound.py | 4 +- ...emailtype_autocomplete_element_response.py | 4 +- ..._emailtype_get_autocomplete_v2_response.py | 4 +- ..._get_autocomplete_v2_response_m_payload.py | 4 +- test/test_enum_fontunderline.py | 2 +- test/test_enum_fontweight.py | 2 +- test/test_enum_horizontalalignment.py | 2 +- test/test_enum_textvalidation.py | 2 +- test/test_enum_verticalalignment.py | 2 +- ...invoicing_autocomplete_element_response.py | 4 +- ...xinvoicing_get_autocomplete_v2_response.py | 4 +- ..._get_autocomplete_v2_response_m_payload.py | 4 +- ...t_ezmaxinvoicing_get_object_v2_response.py | 4 +- ...oicing_get_object_v2_response_m_payload.py | 4 +- ...axinvoicing_get_provisional_v1_response.py | 4 +- ...g_get_provisional_v1_response_m_payload.py | 4 +- test/test_ezmaxinvoicing_response.py | 4 +- test/test_ezmaxinvoicing_response_compound.py | 4 +- test/test_ezmaxinvoicingagent_response.py | 4 +- ...t_ezmaxinvoicingagent_response_compound.py | 4 +- .../test_ezmaxinvoicingcommission_response.py | 4 +- ...axinvoicingcommission_response_compound.py | 4 +- test/test_ezmaxinvoicingcontract_response.py | 4 +- ...zmaxinvoicingcontract_response_compound.py | 4 +- ..._ezmaxinvoicingsummaryexternal_response.py | 4 +- ...oicingsummaryexternal_response_compound.py | 4 +- ...invoicingsummaryexternaldetail_response.py | 4 +- ...summaryexternaldetail_response_compound.py | 4 +- ...st_ezmaxinvoicingsummaryglobal_response.py | 4 +- ...nvoicingsummaryglobal_response_compound.py | 4 +- ..._ezmaxinvoicingsummaryinternal_response.py | 4 +- ...oicingsummaryinternal_response_compound.py | 4 +- ...invoicingsummaryinternaldetail_response.py | 4 +- ...summaryinternaldetail_response_compound.py | 4 +- test/test_ezmaxinvoicinguser_response.py | 4 +- ...st_ezmaxinvoicinguser_response_compound.py | 4 +- ...axproduct_autocomplete_element_response.py | 4 +- ...maxproduct_get_autocomplete_v2_response.py | 4 +- ..._get_autocomplete_v2_response_m_payload.py | 4 +- ...test_ezsign_suggest_signers_v1_response.py | 4 +- ...n_suggest_signers_v1_response_m_payload.py | 4 +- ...st_ezsign_suggest_templates_v1_response.py | 4 +- ...suggest_templates_v1_response_m_payload.py | 4 +- test/test_ezsignannotation_response.py | 4 +- ...test_ezsignannotation_response_compound.py | 4 +- ...e_ezsignbulksendtransmission_v1_request.py | 4 +- ..._ezsignbulksendtransmission_v1_response.py | 4 +- ...ksendtransmission_v1_response_m_payload.py | 4 +- ...ezsignbulksend_create_object_v1_request.py | 4 +- ...zsignbulksend_create_object_v1_response.py | 4 +- ...end_create_object_v1_response_m_payload.py | 4 +- ...zsignbulksend_delete_object_v1_response.py | 4 +- ...t_ezsignbulksend_edit_object_v1_request.py | 4 +- ..._ezsignbulksend_edit_object_v1_response.py | 4 +- ...ezsignbulksendtransmissions_v1_response.py | 4 +- ...sendtransmissions_v1_response_m_payload.py | 4 +- ..._ezsignsignatures_automatic_v1_response.py | 4 +- ...natures_automatic_v1_response_m_payload.py | 4 +- ...signbulksend_get_forms_data_v1_response.py | 4 +- ...nd_get_forms_data_v1_response_m_payload.py | 4 +- ...est_ezsignbulksend_get_list_v1_response.py | 4 +- ...bulksend_get_list_v1_response_m_payload.py | 4 +- ...t_ezsignbulksend_get_object_v2_response.py | 4 +- ...lksend_get_object_v2_response_m_payload.py | 4 +- test/test_ezsignbulksend_list_element.py | 4 +- .../test_ezsignbulksend_reorder_v1_request.py | 4 +- ...test_ezsignbulksend_reorder_v1_response.py | 4 +- test/test_ezsignbulksend_request.py | 4 +- test/test_ezsignbulksend_request_compound.py | 4 +- test/test_ezsignbulksend_response.py | 4 +- test/test_ezsignbulksend_response_compound.py | 4 +- ...ocumentmapping_create_object_v1_request.py | 4 +- ...cumentmapping_create_object_v1_response.py | 4 +- ...ing_create_object_v1_response_m_payload.py | 4 +- ...cumentmapping_delete_object_v1_response.py | 4 +- ...ddocumentmapping_get_object_v2_response.py | 4 +- ...apping_get_object_v2_response_m_payload.py | 4 +- ...t_ezsignbulksenddocumentmapping_request.py | 4 +- ...ulksenddocumentmapping_request_compound.py | 4 +- ..._ezsignbulksenddocumentmapping_response.py | 4 +- ...lksenddocumentmapping_response_compound.py | 4 +- ...dsignermapping_create_object_v1_request.py | 4 +- ...signermapping_create_object_v1_response.py | 4 +- ...ing_create_object_v1_response_m_payload.py | 4 +- ...signermapping_delete_object_v1_response.py | 4 +- ...endsignermapping_get_object_v2_response.py | 4 +- ...apping_get_object_v2_response_m_payload.py | 4 +- ...est_ezsignbulksendsignermapping_request.py | 4 +- ...nbulksendsignermapping_request_compound.py | 4 +- ...st_ezsignbulksendsignermapping_response.py | 4 +- ...bulksendsignermapping_response_compound.py | 4 +- ..._ezsignsignatures_automatic_v1_response.py | 4 +- ...natures_automatic_v1_response_m_payload.py | 4 +- ...transmission_get_forms_data_v1_response.py | 4 +- ...on_get_forms_data_v1_response_m_payload.py | 4 +- ...sendtransmission_get_object_v2_response.py | 4 +- ...ission_get_object_v2_response_m_payload.py | 4 +- ...est_ezsignbulksendtransmission_response.py | 4 +- ...nbulksendtransmission_response_compound.py | 4 +- ...ocument_apply_ezsigntemplate_v1_request.py | 4 +- ...cument_apply_ezsigntemplate_v1_response.py | 4 +- ...ocument_apply_ezsigntemplate_v2_request.py | 4 +- ...cument_apply_ezsigntemplate_v2_response.py | 4 +- ...ezsigndocument_create_object_v1_request.py | 6 +- ...zsigndocument_create_object_v1_response.py | 4 +- ...ent_create_object_v1_response_m_payload.py | 4 +- ...ezsigndocument_create_object_v2_request.py | 4 +- ...zsigndocument_create_object_v2_response.py | 4 +- ...ent_create_object_v2_response_m_payload.py | 4 +- ...signdocument_decline_to_sign_v1_request.py | 4 +- ...igndocument_decline_to_sign_v1_response.py | 4 +- ...zsigndocument_delete_object_v1_response.py | 4 +- ...t_edit_ezsignformfieldgroups_v1_request.py | 4 +- ..._edit_ezsignformfieldgroups_v1_response.py | 4 +- ...gnformfieldgroups_v1_response_m_payload.py | 4 +- ...cument_edit_ezsignsignatures_v1_request.py | 4 +- ...ument_edit_ezsignsignatures_v1_response.py | 4 +- ..._ezsignsignatures_v1_response_m_payload.py | 4 +- ...igndocument_end_prematurely_v1_response.py | 4 +- ...test_ezsigndocument_flatten_v1_response.py | 4 +- ...ent_get_actionable_elements_v1_response.py | 4 +- ...tionable_elements_v1_response_m_payload.py | 4 +- ...igndocument_get_attachments_v1_response.py | 83 + ...t_get_attachments_v1_response_m_payload.py | 66 + ...ment_get_completed_elements_v1_response.py | 4 +- ...ompleted_elements_v1_response_m_payload.py | 4 +- ...gndocument_get_download_url_v1_response.py | 4 +- ..._get_download_url_v1_response_m_payload.py | 4 +- ...ument_get_ezsignannotations_v1_response.py | 4 +- ...ezsignannotations_v1_response_m_payload.py | 4 +- ...t_get_ezsignformfieldgroups_v1_response.py | 4 +- ...gnformfieldgroups_v1_response_m_payload.py | 4 +- ...igndocument_get_ezsignpages_v1_response.py | 4 +- ...t_get_ezsignpages_v1_response_m_payload.py | 4 +- ..._ezsignsignatures_automatic_v1_response.py | 4 +- ...natures_automatic_v1_response_m_payload.py | 4 +- ...cument_get_ezsignsignatures_v1_response.py | 4 +- ..._ezsignsignatures_v1_response_m_payload.py | 4 +- ...zsigndocument_get_form_data_v1_response.py | 4 +- ...ent_get_form_data_v1_response_m_payload.py | 4 +- ...t_ezsigndocument_get_object_v1_response.py | 4 +- ...cument_get_object_v1_response_m_payload.py | 6 +- ...t_ezsigndocument_get_object_v2_response.py | 4 +- ...cument_get_object_v2_response_m_payload.py | 4 +- ...ocument_get_temporary_proof_v1_response.py | 4 +- ...t_temporary_proof_v1_response_m_payload.py | 4 +- ...document_get_words_positions_v1_request.py | 4 +- ...ocument_get_words_positions_v1_response.py | 4 +- ..._ezsigndocument_patch_object_v1_request.py | 4 +- ...ezsigndocument_patch_object_v1_response.py | 4 +- test/test_ezsigndocument_request.py | 6 +- test/test_ezsigndocument_request_compound.py | 6 +- test/test_ezsigndocument_request_patch.py | 4 +- test/test_ezsigndocument_response.py | 8 +- test/test_ezsigndocument_response_compound.py | 6 +- ...gndocument_submit_ezsignform_v1_request.py | 4 +- ...ndocument_submit_ezsignform_v1_response.py | 4 +- .../test_ezsigndocument_unsend_v1_response.py | 4 +- test/test_ezsigndocumentlog_response.py | 4 +- ...est_ezsigndocumentlog_response_compound.py | 4 +- test/test_ezsignelementdependency_request.py | 4 +- ...zsignelementdependency_request_compound.py | 4 +- test/test_ezsignelementdependency_response.py | 4 +- ...signelementdependency_response_compound.py | 4 +- test/test_ezsignfolder_archive_v1_response.py | 4 +- ..._ezsignfolder_batch_download_v1_request.py | 4 +- ...t_ezsignfolder_create_object_v1_request.py | 4 +- ..._ezsignfolder_create_object_v1_response.py | 4 +- ...der_create_object_v1_response_m_payload.py | 4 +- ...t_ezsignfolder_create_object_v2_request.py | 4 +- ..._ezsignfolder_create_object_v2_response.py | 4 +- ...der_create_object_v2_response_m_payload.py | 4 +- ..._ezsignfolder_delete_object_v1_response.py | 4 +- ...folder_dispose_ezsignfolders_v1_request.py | 4 +- ...older_dispose_ezsignfolders_v1_response.py | 4 +- test/test_ezsignfolder_dispose_v1_response.py | 4 +- ...est_ezsignfolder_edit_object_v1_request.py | 4 +- ...st_ezsignfolder_edit_object_v1_response.py | 4 +- ...der_get_actionable_elements_v1_response.py | 4 +- ...tionable_elements_v1_response_m_payload.py | 4 +- ...folder_get_attachment_count_v1_response.py | 71 + ..._attachment_count_v1_response_m_payload.py | 54 + ...zsignfolder_get_attachments_v1_response.py | 83 + ...r_get_attachments_v1_response_m_payload.py | 66 + ...der_get_communication_count_v1_response.py | 4 +- ...mmunication_count_v1_response_m_payload.py | 4 +- ...lder_get_communication_list_v1_response.py | 4 +- ...ommunication_list_v1_response_m_payload.py | 4 +- ...get_communicationrecipients_v1_response.py | 4 +- ...icationrecipients_v1_response_m_payload.py | 4 +- ...er_get_communicationsenders_v1_response.py | 16 +- ...municationsenders_v1_response_m_payload.py | 16 +- ...nfolder_get_ezsigndocuments_v1_response.py | 4 +- ...t_ezsigndocuments_v1_response_m_payload.py | 4 +- ...ignfoldersignerassociations_v1_response.py | 4 +- ...ignerassociations_v1_response_m_payload.py | 4 +- ..._ezsignsignatures_automatic_v1_response.py | 4 +- ...natures_automatic_v1_response_m_payload.py | 4 +- ...ezsignfolder_get_forms_data_v1_response.py | 4 +- ...er_get_forms_data_v1_response_m_payload.py | 4 +- .../test_ezsignfolder_get_list_v1_response.py | 4 +- ...gnfolder_get_list_v1_response_m_payload.py | 4 +- ...est_ezsignfolder_get_object_v1_response.py | 4 +- ...folder_get_object_v1_response_m_payload.py | 4 +- ...est_ezsignfolder_get_object_v2_response.py | 4 +- ...folder_get_object_v2_response_m_payload.py | 4 +- ...signfoldersignerassociations_v1_request.py | 4 +- ...ignfoldersignerassociations_v1_response.py | 4 +- ...ignerassociations_v1_response_m_payload.py | 4 +- ...import_ezsigntemplatepackage_v1_request.py | 4 +- ...mport_ezsigntemplatepackage_v1_response.py | 4 +- ...gntemplatepackage_v1_response_m_payload.py | 4 +- test/test_ezsignfolder_list_element.py | 4 +- test/test_ezsignfolder_reorder_v1_request.py | 4 +- test/test_ezsignfolder_reorder_v1_response.py | 4 +- test/test_ezsignfolder_request.py | 4 +- test/test_ezsignfolder_request_compound.py | 4 +- test/test_ezsignfolder_response.py | 4 +- test/test_ezsignfolder_response_compound.py | 4 +- test/test_ezsignfolder_send_v1_request.py | 4 +- test/test_ezsignfolder_send_v1_response.py | 4 +- test/test_ezsignfolder_send_v2_request.py | 4 +- test/test_ezsignfolder_send_v2_response.py | 4 +- test/test_ezsignfolder_send_v3_request.py | 4 +- test/test_ezsignfolder_send_v3_response.py | 4 +- test/test_ezsignfolder_unsend_v1_response.py | 4 +- ...nerassociation_create_object_v1_request.py | 4 +- ...erassociation_create_object_v1_response.py | 4 +- ...ion_create_object_v1_response_m_payload.py | 4 +- ...nerassociation_create_object_v2_request.py | 4 +- ...erassociation_create_object_v2_response.py | 4 +- ...ion_create_object_v2_response_m_payload.py | 4 +- ...erassociation_delete_object_v1_response.py | 4 +- ...ignerassociation_edit_object_v1_request.py | 4 +- ...gnerassociation_edit_object_v1_response.py | 4 +- ...ssociation_force_disconnect_v1_response.py | 4 +- ...ion_get_in_person_login_url_v1_response.py | 4 +- ..._person_login_url_v1_response_m_payload.py | 4 +- ...ignerassociation_get_object_v1_response.py | 4 +- ...iation_get_object_v1_response_m_payload.py | 4 +- ...ignerassociation_get_object_v2_response.py | 4 +- ...iation_get_object_v2_response_m_payload.py | 4 +- ...gnerassociation_patch_object_v1_request.py | 4 +- ...nerassociation_patch_object_v1_response.py | 4 +- ...t_ezsignfoldersignerassociation_request.py | 4 +- ...oldersignerassociation_request_compound.py | 4 +- ...gnfoldersignerassociation_request_patch.py | 4 +- ..._ezsignfoldersignerassociation_response.py | 4 +- ...ldersignerassociation_response_compound.py | 4 +- ...ignerassociation_response_compound_user.py | 4 +- ...oldertype_autocomplete_element_response.py | 4 +- ...signfoldertype_create_object_v1_request.py | 4 +- ...ignfoldertype_create_object_v1_response.py | 4 +- ...ype_create_object_v1_response_m_payload.py | 4 +- ...ezsignfoldertype_edit_object_v1_request.py | 4 +- ...zsignfoldertype_edit_object_v1_response.py | 4 +- ...foldertype_get_autocomplete_v2_response.py | 4 +- ..._get_autocomplete_v2_response_m_payload.py | 4 +- ...t_ezsignfoldertype_get_list_v1_response.py | 4 +- ...ldertype_get_list_v1_response_m_payload.py | 4 +- ...ezsignfoldertype_get_object_v2_response.py | 4 +- ...ertype_get_object_v2_response_m_payload.py | 4 +- test/test_ezsignfoldertype_list_element.py | 4 +- test/test_ezsignfoldertype_request.py | 16 +- .../test_ezsignfoldertype_request_compound.py | 16 +- test/test_ezsignfoldertype_response.py | 16 +- ...test_ezsignfoldertype_response_compound.py | 16 +- test/test_ezsignformfield_request.py | 4 +- test/test_ezsignformfield_request_compound.py | 4 +- test/test_ezsignformfield_response.py | 4 +- .../test_ezsignformfield_response_compound.py | 4 +- ...formfieldgroup_create_object_v1_request.py | 4 +- ...ormfieldgroup_create_object_v1_response.py | 4 +- ...oup_create_object_v1_response_m_payload.py | 4 +- ...ormfieldgroup_delete_object_v1_response.py | 4 +- ...gnformfieldgroup_edit_object_v1_request.py | 4 +- ...nformfieldgroup_edit_object_v1_response.py | 4 +- ...gnformfieldgroup_get_object_v2_response.py | 4 +- ...dgroup_get_object_v2_response_m_payload.py | 4 +- test/test_ezsignformfieldgroup_request.py | 4 +- ...t_ezsignformfieldgroup_request_compound.py | 4 +- test/test_ezsignformfieldgroup_response.py | 4 +- ..._ezsignformfieldgroup_response_compound.py | 4 +- ...test_ezsignformfieldgroupsigner_request.py | 4 +- ...gnformfieldgroupsigner_request_compound.py | 4 +- ...est_ezsignformfieldgroupsigner_response.py | 4 +- ...nformfieldgroupsigner_response_compound.py | 4 +- test/test_ezsignpage_consult_v1_response.py | 4 +- test/test_ezsignpage_response.py | 4 +- test/test_ezsignpage_response_compound.py | 4 +- ...zsignsignature_create_object_v1_request.py | 4 +- ...signsignature_create_object_v1_response.py | 4 +- ...ure_create_object_v1_response_m_payload.py | 4 +- ...zsignsignature_create_object_v2_request.py | 4 +- ...signsignature_create_object_v2_response.py | 4 +- ...ure_create_object_v2_response_m_payload.py | 4 +- ...signsignature_delete_object_v1_response.py | 4 +- ..._ezsignsignature_edit_object_v1_request.py | 4 +- ...ezsignsignature_edit_object_v1_response.py | 4 +- ...t_ezsignsignatureattachment_v1_response.py | 4 +- ...gnatureattachment_v1_response_m_payload.py | 4 +- ..._ezsignsignatures_automatic_v1_response.py | 4 +- ...natures_automatic_v1_response_m_payload.py | 4 +- ..._ezsignsignature_get_object_v2_response.py | 4 +- ...nature_get_object_v2_response_m_payload.py | 4 +- test/test_ezsignsignature_request.py | 4 +- test/test_ezsignsignature_request_compound.py | 4 +- test/test_ezsignsignature_response.py | 6 +- .../test_ezsignsignature_response_compound.py | 6 +- test/test_ezsignsignature_sign_v1_request.py | 7 +- test/test_ezsignsignature_sign_v1_response.py | 4 +- ...test_ezsignsignatureattachment_response.py | 4 +- .../test_ezsignsignaturecustomdate_request.py | 4 +- ...ignsignaturecustomdate_request_compound.py | 4 +- ...test_ezsignsignaturecustomdate_response.py | 4 +- ...gnsignaturecustomdate_response_compound.py | 4 +- test/test_ezsignsigner_request.py | 4 +- test/test_ezsignsigner_request_compound.py | 4 +- ...t_ezsignsigner_request_compound_contact.py | 4 +- test/test_ezsignsigner_response.py | 4 +- test/test_ezsignsigner_response_compound.py | 4 +- ..._ezsignsigner_response_compound_contact.py | 4 +- ...ignsignergroup_create_object_v1_request.py | 4 +- ...gnsignergroup_create_object_v1_response.py | 4 +- ...oup_create_object_v1_response_m_payload.py | 4 +- ...gnsignergroup_delete_object_v1_response.py | 4 +- ...ezsignsignergroupmemberships_v1_request.py | 4 +- ...zsignsignergroupmemberships_v1_response.py | 4 +- ...rgroupmemberships_v1_response_m_payload.py | 4 +- ...zsignsignergroup_edit_object_v1_request.py | 4 +- ...signsignergroup_edit_object_v1_response.py | 4 +- ...zsignsignergroupmemberships_v1_response.py | 4 +- ...rgroupmemberships_v1_response_m_payload.py | 4 +- ...zsignsignergroup_get_object_v2_response.py | 4 +- ...rgroup_get_object_v2_response_m_payload.py | 4 +- test/test_ezsignsignergroup_request.py | 4 +- ...test_ezsignsignergroup_request_compound.py | 4 +- test/test_ezsignsignergroup_response.py | 4 +- ...est_ezsignsignergroup_response_compound.py | 4 +- ...roupmembership_create_object_v1_request.py | 4 +- ...oupmembership_create_object_v1_response.py | 4 +- ...hip_create_object_v1_response_m_payload.py | 4 +- ...oupmembership_delete_object_v1_response.py | 4 +- ...rgroupmembership_get_object_v2_response.py | 4 +- ...ership_get_object_v2_response_m_payload.py | 4 +- ...est_ezsignsignergroupmembership_request.py | 4 +- ...nsignergroupmembership_request_compound.py | 4 +- ...st_ezsignsignergroupmembership_response.py | 4 +- ...signergroupmembership_response_compound.py | 4 +- ...ingreason_autocomplete_element_response.py | 58 + ...nsigningreason_create_object_v1_request.py | 58 + ...signingreason_create_object_v1_response.py | 75 + ...son_create_object_v1_response_m_payload.py | 58 + ...ignsigningreason_edit_object_v1_request.py | 54 + ...nsigningreason_edit_object_v1_response.py} | 22 +- ...ningreason_get_autocomplete_v2_response.py | 81 + ..._get_autocomplete_v2_response_m_payload.py | 64 + ...zsignsigningreason_get_list_v1_response.py | 57 + ...ngreason_get_list_v1_response_m_payload.py | 68 + ...ignsigningreason_get_object_v2_response.py | 71 + ...reason_get_object_v2_response_m_payload.py | 54 + test/test_ezsignsigningreason_list_element.py | 58 + test/test_ezsignsigningreason_request.py | 61 + ...st_ezsignsigningreason_request_compound.py | 61 + test/test_ezsignsigningreason_response.py | 62 + ...t_ezsignsigningreason_response_compound.py | 62 + ...ntemplate_autocomplete_element_response.py | 4 +- test/test_ezsigntemplate_copy_v1_request.py | 4 +- test/test_ezsigntemplate_copy_v1_response.py | 4 +- ...signtemplate_copy_v1_response_m_payload.py | 4 +- ...ezsigntemplate_create_object_v1_request.py | 4 +- ...zsigntemplate_create_object_v1_response.py | 4 +- ...ate_create_object_v1_response_m_payload.py | 4 +- ...zsigntemplate_delete_object_v1_response.py | 4 +- ...t_ezsigntemplate_edit_object_v1_request.py | 4 +- ..._ezsigntemplate_edit_object_v1_response.py | 4 +- ...gntemplate_get_autocomplete_v2_response.py | 4 +- ..._get_autocomplete_v2_response_m_payload.py | 4 +- ...est_ezsigntemplate_get_list_v1_response.py | 4 +- ...template_get_list_v1_response_m_payload.py | 4 +- ...t_ezsigntemplate_get_object_v1_response.py | 4 +- ...mplate_get_object_v1_response_m_payload.py | 4 +- ...t_ezsigntemplate_get_object_v2_response.py | 4 +- ...mplate_get_object_v2_response_m_payload.py | 4 +- test/test_ezsigntemplate_list_element.py | 4 +- test/test_ezsigntemplate_request.py | 4 +- test/test_ezsigntemplate_request_compound.py | 4 +- test/test_ezsigntemplate_response.py | 4 +- test/test_ezsigntemplate_response_compound.py | 4 +- ...mplatedocument_create_object_v1_request.py | 4 +- ...platedocument_create_object_v1_response.py | 4 +- ...ent_create_object_v1_response_m_payload.py | 4 +- ...zsigntemplateformfieldgroups_v1_request.py | 4 +- ...signtemplateformfieldgroups_v1_response.py | 4 +- ...teformfieldgroups_v1_response_m_payload.py | 4 +- ...dit_ezsigntemplatesignatures_v1_request.py | 4 +- ...it_ezsigntemplatesignatures_v1_response.py | 4 +- ...emplatesignatures_v1_response_m_payload.py | 4 +- ...templatedocument_edit_object_v1_request.py | 4 +- ...emplatedocument_edit_object_v1_response.py | 4 +- ...igntemplatedocument_flatten_v1_response.py | 4 +- ...ezsigntemplatedocumentpages_v1_response.py | 4 +- ...latedocumentpages_v1_response_m_payload.py | 4 +- ...signtemplateformfieldgroups_v1_response.py | 4 +- ...teformfieldgroups_v1_response_m_payload.py | 4 +- ...et_ezsigntemplatesignatures_v1_response.py | 4 +- ...emplatesignatures_v1_response_m_payload.py | 4 +- ...templatedocument_get_object_v2_response.py | 4 +- ...cument_get_object_v2_response_m_payload.py | 4 +- ...document_get_words_positions_v1_request.py | 4 +- ...ocument_get_words_positions_v1_response.py | 4 +- ...emplatedocument_patch_object_v1_request.py | 4 +- ...mplatedocument_patch_object_v1_response.py | 4 +- test/test_ezsigntemplatedocument_request.py | 6 +- ...ezsigntemplatedocument_request_compound.py | 6 +- ...st_ezsigntemplatedocument_request_patch.py | 4 +- test/test_ezsigntemplatedocument_response.py | 4 +- ...zsigntemplatedocument_response_compound.py | 4 +- ...est_ezsigntemplatedocumentpage_response.py | 4 +- ...ntemplatedocumentpage_response_compound.py | 4 +- ...ezsigntemplateelementdependency_request.py | 4 +- ...plateelementdependency_request_compound.py | 4 +- ...zsigntemplateelementdependency_response.py | 4 +- ...lateelementdependency_response_compound.py | 4 +- test/test_ezsigntemplateformfield_request.py | 4 +- ...zsigntemplateformfield_request_compound.py | 4 +- test/test_ezsigntemplateformfield_response.py | 4 +- ...signtemplateformfield_response_compound.py | 4 +- ...formfieldgroup_create_object_v1_request.py | 4 +- ...ormfieldgroup_create_object_v1_response.py | 4 +- ...oup_create_object_v1_response_m_payload.py | 4 +- ...ormfieldgroup_delete_object_v1_response.py | 4 +- ...teformfieldgroup_edit_object_v1_request.py | 4 +- ...eformfieldgroup_edit_object_v1_response.py | 4 +- ...teformfieldgroup_get_object_v2_response.py | 4 +- ...dgroup_get_object_v2_response_m_payload.py | 4 +- ...st_ezsigntemplateformfieldgroup_request.py | 4 +- ...templateformfieldgroup_request_compound.py | 4 +- ...t_ezsigntemplateformfieldgroup_response.py | 4 +- ...emplateformfieldgroup_response_compound.py | 4 +- ...igntemplateformfieldgroupsigner_request.py | 4 +- ...teformfieldgroupsigner_request_compound.py | 4 +- ...gntemplateformfieldgroupsigner_response.py | 4 +- ...eformfieldgroupsigner_response_compound.py | 4 +- ...tepackage_autocomplete_element_response.py | 4 +- ...emplatepackage_create_object_v1_request.py | 4 +- ...mplatepackage_create_object_v1_response.py | 4 +- ...age_create_object_v1_response_m_payload.py | 4 +- ...mplatepackage_delete_object_v1_response.py | 4 +- ...ezsigntemplatepackagesigners_v1_request.py | 4 +- ...zsigntemplatepackagesigners_v1_response.py | 4 +- ...atepackagesigners_v1_response_m_payload.py | 4 +- ...ntemplatepackage_edit_object_v1_request.py | 4 +- ...templatepackage_edit_object_v1_response.py | 4 +- ...atepackage_get_autocomplete_v2_response.py | 4 +- ..._get_autocomplete_v2_response_m_payload.py | 4 +- ...igntemplatepackage_get_list_v1_response.py | 4 +- ...epackage_get_list_v1_response_m_payload.py | 4 +- ...ntemplatepackage_get_object_v2_response.py | 4 +- ...ackage_get_object_v2_response_m_payload.py | 4 +- ...test_ezsigntemplatepackage_list_element.py | 4 +- test/test_ezsigntemplatepackage_request.py | 4 +- ..._ezsigntemplatepackage_request_compound.py | 4 +- test/test_ezsigntemplatepackage_response.py | 4 +- ...ezsigntemplatepackage_response_compound.py | 4 +- ...kagemembership_create_object_v1_request.py | 4 +- ...agemembership_create_object_v1_response.py | 4 +- ...hip_create_object_v1_response_m_payload.py | 4 +- ...agemembership_delete_object_v1_response.py | 4 +- ...ackagemembership_get_object_v2_response.py | 4 +- ...ership_get_object_v2_response_m_payload.py | 4 +- ...ezsigntemplatepackagemembership_request.py | 4 +- ...platepackagemembership_request_compound.py | 4 +- ...zsigntemplatepackagemembership_response.py | 4 +- ...latepackagemembership_response_compound.py | 4 +- ...epackagesigner_create_object_v1_request.py | 4 +- ...packagesigner_create_object_v1_response.py | 4 +- ...ner_create_object_v1_response_m_payload.py | 4 +- ...packagesigner_delete_object_v1_response.py | 4 +- ...ner_delete_object_v1_response_m_payload.py | 4 +- ...atepackagesigner_edit_object_v1_request.py | 4 +- ...tepackagesigner_edit_object_v1_response.py | 4 +- ...atepackagesigner_get_object_v2_response.py | 4 +- ...signer_get_object_v2_response_m_payload.py | 4 +- ...est_ezsigntemplatepackagesigner_request.py | 4 +- ...ntemplatepackagesigner_request_compound.py | 4 +- ...st_ezsigntemplatepackagesigner_response.py | 4 +- ...templatepackagesigner_response_compound.py | 4 +- ...gnermembership_create_object_v1_request.py | 4 +- ...nermembership_create_object_v1_response.py | 4 +- ...hip_create_object_v1_response_m_payload.py | 4 +- ...nermembership_delete_object_v1_response.py | 4 +- ...hip_delete_object_v1_response_m_payload.py | 4 +- ...signermembership_get_object_v2_response.py | 4 +- ...ership_get_object_v2_response_m_payload.py | 4 +- ...templatepackagesignermembership_request.py | 4 +- ...ackagesignermembership_request_compound.py | 4 +- ...emplatepackagesignermembership_response.py | 4 +- ...ckagesignermembership_response_compound.py | 4 +- ...platesignature_create_object_v1_request.py | 4 +- ...latesignature_create_object_v1_response.py | 4 +- ...ure_create_object_v1_response_m_payload.py | 4 +- ...latesignature_delete_object_v1_response.py | 4 +- ...emplatesignature_edit_object_v1_request.py | 4 +- ...mplatesignature_edit_object_v1_response.py | 4 +- ...emplatesignature_get_object_v2_response.py | 4 +- ...nature_get_object_v2_response_m_payload.py | 4 +- test/test_ezsigntemplatesignature_request.py | 4 +- ...zsigntemplatesignature_request_compound.py | 4 +- test/test_ezsigntemplatesignature_response.py | 4 +- ...signtemplatesignature_response_compound.py | 4 +- ...signtemplatesignaturecustomdate_request.py | 4 +- ...atesignaturecustomdate_request_compound.py | 4 +- ...igntemplatesignaturecustomdate_response.py | 4 +- ...tesignaturecustomdate_response_compound.py | 4 +- ...templatesigner_create_object_v1_request.py | 4 +- ...emplatesigner_create_object_v1_response.py | 4 +- ...ner_create_object_v1_response_m_payload.py | 4 +- ...emplatesigner_delete_object_v1_response.py | 4 +- ...gntemplatesigner_edit_object_v1_request.py | 4 +- ...ntemplatesigner_edit_object_v1_response.py | 4 +- ...gntemplatesigner_get_object_v2_response.py | 4 +- ...signer_get_object_v2_response_m_payload.py | 4 +- test/test_ezsigntemplatesigner_request.py | 4 +- ...t_ezsigntemplatesigner_request_compound.py | 4 +- test/test_ezsigntemplatesigner_response.py | 4 +- ..._ezsigntemplatesigner_response_compound.py | 4 +- ...quirement_autocomplete_element_response.py | 4 +- ...equirement_get_autocomplete_v2_response.py | 4 +- ..._get_autocomplete_v2_response_m_payload.py | 4 +- test/test_field_e_activesession_origin.py | 2 +- test/test_field_e_activesession_usertype.py | 2 +- ...test_field_e_activesession_weekdaystart.py | 2 +- test/test_field_e_attachment_documenttype.py | 35 + test/test_field_e_attachment_privacy.py | 35 + test/test_field_e_attachment_type.py | 35 + test/test_field_e_attachment_verified.py | 35 + test/test_field_e_attachmentlog_type.py | 35 + test/test_field_e_branding_logo.py | 2 +- test/test_field_e_communication_importance.py | 2 +- test/test_field_e_communication_type.py | 2 +- ...d_e_communicationexternalrecipient_type.py | 2 +- ...est_field_e_communicationrecipient_type.py | 2 +- test/test_field_e_creditcardtype_codename.py | 2 +- test/test_field_e_error_code.py | 2 +- ...test_field_e_ezmaxinvoicing_paymenttype.py | 2 +- ...ld_e_ezmaxinvoicingagent_variationezmax.py | 2 +- ...d_e_ezmaxinvoicingagent_variationezsign.py | 2 +- ...ld_e_ezmaxinvoicingcontract_paymenttype.py | 2 +- ...ld_e_ezmaxinvoicinguser_variationezsign.py | 2 +- test/test_field_e_ezsignannotation_type.py | 2 +- test/test_field_e_ezsigndocument_step.py | 2 +- test/test_field_e_ezsigndocumentlog_type.py | 2 +- ...ield_e_ezsignelementdependency_operator.py | 2 +- ...ld_e_ezsignelementdependency_validation.py | 2 +- ...ld_e_ezsignfolder_sendreminderfrequency.py | 2 +- test/test_field_e_ezsignfolder_step.py | 2 +- .../test_field_e_ezsignfoldertype_disposal.py | 2 +- ...t_field_e_ezsignfoldertype_privacylevel.py | 2 +- ..._ezsignfoldertype_sendreminderfrequency.py | 2 +- ...e_ezsignformfield_dependencyrequirement.py | 2 +- ..._ezsignformfieldgroup_signerrequirement.py | 2 +- ..._e_ezsignformfieldgroup_tooltipposition.py | 2 +- .../test_field_e_ezsignformfieldgroup_type.py | 2 +- ..._e_ezsignsignature_attachmentnamesource.py | 2 +- ...e_ezsignsignature_dependencyrequirement.py | 2 +- test/test_field_e_ezsignsignature_font.py | 2 +- ...field_e_ezsignsignature_tooltipposition.py | 2 +- test/test_field_e_ezsignsignature_type.py | 2 +- ...zsigntemplateelementdependency_operator.py | 2 +- ...igntemplateelementdependency_validation.py | 2 +- ...templateformfield_dependencyrequirement.py | 2 +- ...emplateformfieldgroup_signerrequirement.py | 2 +- ...ntemplateformfieldgroup_tooltipposition.py | 2 +- ...eld_e_ezsigntemplateformfieldgroup_type.py | 2 +- ...ntemplatesignature_attachmentnamesource.py | 2 +- ...templatesignature_dependencyrequirement.py | 2 +- ...st_field_e_ezsigntemplatesignature_font.py | 2 +- ...ezsigntemplatesignature_tooltipposition.py | 2 +- ...st_field_e_ezsigntemplatesignature_type.py | 2 +- ...t_field_e_notificationpreference_status.py | 2 +- test/test_field_e_paymentterm_type.py | 2 +- test/test_field_e_phone_type.py | 2 +- test/test_field_e_sessionhistory_endby.py | 2 +- ...test_field_e_systemconfiguration_ezsign.py | 2 +- ...t_field_e_systemconfiguration_language1.py | 2 +- ...t_field_e_systemconfiguration_language2.py | 2 +- ...stemconfiguration_newexternaluseraction.py | 2 +- test/test_field_e_user_ezsignaccess.py | 2 +- test/test_field_e_user_ezsignprepaid.py | 35 + ...ield_e_user_ezsignsendreminderfrequency.py | 2 +- test/test_field_e_user_logintype.py | 2 +- test/test_field_e_user_origin.py | 2 +- test/test_field_e_user_type.py | 2 +- test/test_field_e_variableexpense_taxable.py | 2 +- test/test_field_e_versionhistory_type.py | 2 +- test/test_field_e_versionhistory_usertype.py | 2 +- test/test_field_e_webhook_ezsignevent.py | 2 +- test/test_field_e_webhook_managementevent.py | 2 +- test/test_field_e_webhook_module.py | 2 +- test/test_field_pks_ezmaxclient_os.py | 2 +- ...test_font_autocomplete_element_response.py | 4 +- .../test_font_get_autocomplete_v2_response.py | 4 +- ..._get_autocomplete_v2_response_m_payload.py | 4 +- ...isebroker_autocomplete_element_response.py | 4 +- ...hisebroker_get_autocomplete_v2_response.py | 4 +- ..._get_autocomplete_v2_response_m_payload.py | 4 +- ...iseoffice_autocomplete_element_response.py | 4 +- ...hiseoffice_get_autocomplete_v2_response.py | 4 +- ..._get_autocomplete_v2_response_m_payload.py | 4 +- ...ereferalincome_create_object_v1_request.py | 4 +- ...referalincome_create_object_v1_response.py | 4 +- ...ome_create_object_v1_response_m_payload.py | 4 +- ...ereferalincome_create_object_v2_request.py | 4 +- ...referalincome_create_object_v2_response.py | 4 +- ...ome_create_object_v2_response_m_payload.py | 4 +- test/test_franchisereferalincome_request.py | 4 +- ...franchisereferalincome_request_compound.py | 4 +- test/test_global_customer_api.py | 6 +- ...lobal_customer_get_endpoint_v1_response.py | 4 +- test/test_global_ezmaxclient_api.py | 6 +- ..._global_ezmaxclient_version_v1_response.py | 8 +- test/test_global_ezmaxcustomer_api.py | 6 +- ...xcustomer_get_configuration_v1_response.py | 4 +- test/test_header_accept_language.py | 2 +- ...inscription_get_attachments_v1_response.py | 83 + ...n_get_attachments_v1_response_m_payload.py | 66 + ...tion_get_communication_list_v1_response.py | 4 +- ...ommunication_list_v1_response_m_payload.py | 4 +- ...on_get_communicationsenders_v1_response.py | 101 + ...municationsenders_v1_response_m_payload.py | 84 + ...ated_get_communication_list_v1_response.py | 4 +- ...ommunication_list_v1_response_m_payload.py | 4 +- ...temp_get_communication_list_v1_response.py | 4 +- ...ommunication_list_v1_response_m_payload.py | 4 +- ...est_invoice_get_attachments_v1_response.py | 83 + ...e_get_attachments_v1_response_m_payload.py | 66 + ...oice_get_communication_list_v1_response.py | 4 +- ...ommunication_list_v1_response_m_payload.py | 4 +- ..._language_autocomplete_element_response.py | 4 +- ...t_language_get_autocomplete_v2_response.py | 4 +- ..._get_autocomplete_v2_response_m_payload.py | 4 +- test/test_module_ezsign_api.py | 8 +- test/test_module_report_api.py | 6 +- test/test_module_response.py | 4 +- test/test_module_response_compound.py | 4 +- test/test_module_user_api.py | 6 +- test/test_modulegroup_get_all_v1_response.py | 4 +- ...dulegroup_get_all_v1_response_m_payload.py | 4 +- test/test_modulegroup_response.py | 4 +- test/test_modulegroup_response_compound.py | 4 +- test/test_modulesection_response.py | 4 +- test/test_modulesection_response_compound.py | 4 +- test/test_multilingual_apikey_description.py | 4 +- ...ngual_billingentityinternal_description.py | 4 +- .../test_multilingual_branding_description.py | 4 +- ...maxinvoicingsummaryinternal_description.py | 4 +- ...test_multilingual_ezsignfoldertype_name.py | 4 +- ...tilingual_ezsignsignergroup_description.py | 4 +- ...lingual_ezsignsigningreason_description.py | 54 + ...ultilingual_notificationsubsection_name.py | 4 +- ...test_multilingual_notificationtest_name.py | 4 +- ...st_multilingual_paymentterm_description.py | 4 +- test/test_multilingual_subnet_description.py | 4 +- test/test_multilingual_usergroup_name.py | 4 +- ...ultilingual_variableexpense_description.py | 4 +- ...test_multilingual_versionhistory_detail.py | 4 +- ...ction_get_notificationtests_v1_response.py | 4 +- ...notificationtests_v1_response_m_payload.py | 4 +- test/test_notificationsubsection_response.py | 4 +- ...tificationtest_get_elements_v1_response.py | 4 +- ...test_get_elements_v1_response_m_payload.py | 4 +- test/test_notificationtest_response.py | 4 +- test/test_object_activesession_api.py | 8 +- test/test_object_apikey_api.py | 22 +- test/test_object_attachment_api.py | 20 +- test/test_object_billingentityexternal_api.py | 6 +- test/test_object_billingentityinternal_api.py | 14 +- test/test_object_branding_api.py | 14 +- test/test_object_buyercontract_api.py | 6 +- test/test_object_clonehistory_api.py | 6 +- test/test_object_communication_api.py | 6 +- test/test_object_company_api.py | 6 +- test/test_object_cors_api.py | 12 +- test/test_object_department_api.py | 6 +- ...test_object_electronicfundstransfer_api.py | 10 +- test/test_object_emailtype_api.py | 6 +- test/test_object_ezmaxinvoicing_api.py | 12 +- test/test_object_ezmaxproduct_api.py | 6 +- test/test_object_ezsignbulksend_api.py | 26 +- ...bject_ezsignbulksenddocumentmapping_api.py | 10 +- ..._object_ezsignbulksendsignermapping_api.py | 10 +- ...t_object_ezsignbulksendtransmission_api.py | 12 +- test/test_object_ezsigndocument_api.py | 63 +- test/test_object_ezsignfolder_api.py | 72 +- ...bject_ezsignfoldersignerassociation_api.py | 22 +- test/test_object_ezsignfoldertype_api.py | 16 +- test/test_object_ezsignformfieldgroup_api.py | 12 +- test/test_object_ezsignpage_api.py | 6 +- test/test_object_ezsignsignature_api.py | 20 +- test/test_object_ezsignsignergroup_api.py | 16 +- ..._object_ezsignsignergroupmembership_api.py | 10 +- test/test_object_ezsignsigningreason_api.py | 67 + test/test_object_ezsigntemplate_api.py | 20 +- .../test_object_ezsigntemplatedocument_api.py | 26 +- ...object_ezsigntemplateformfieldgroup_api.py | 12 +- test/test_object_ezsigntemplatepackage_api.py | 18 +- ...ect_ezsigntemplatepackagemembership_api.py | 10 +- ..._object_ezsigntemplatepackagesigner_api.py | 12 +- ...signtemplatepackagesignermembership_api.py | 10 +- ...test_object_ezsigntemplatesignature_api.py | 12 +- test/test_object_ezsigntemplatesigner_api.py | 12 +- test/test_object_ezsigntsarequirement_api.py | 6 +- test/test_object_font_api.py | 6 +- test/test_object_franchisebroker_api.py | 8 +- test/test_object_franchiseoffice_api.py | 6 +- .../test_object_franchisereferalincome_api.py | 8 +- test/test_object_inscription_api.py | 20 +- ..._object_inscriptionnotauthenticated_api.py | 6 +- test/test_object_inscriptiontemp_api.py | 6 +- test/test_object_invoice_api.py | 13 +- test/test_object_language_api.py | 6 +- test/test_object_modulegroup_api.py | 6 +- test/test_object_notificationsection_api.py | 6 +- test/test_object_notificationtest_api.py | 6 +- test/test_object_otherincome_api.py | 6 +- test/test_object_paymentterm_api.py | 14 +- test/test_object_period_api.py | 8 +- test/test_object_permission_api.py | 12 +- test/test_object_phonetype_api.py | 6 +- ...test_object_rejectedoffertopurchase_api.py | 6 +- test/test_object_secretquestion_api.py | 6 +- test/test_object_sessionhistory_api.py | 6 +- test/test_object_signature_api.py | 12 +- test/test_object_subnet_api.py | 12 +- test/test_object_systemconfiguration_api.py | 8 +- test/test_object_taxassignment_api.py | 6 +- test/test_object_timezone_api.py | 6 +- test/test_object_user_api.py | 26 +- test/test_object_usergroup_api.py | 26 +- test/test_object_usergroupdelegation_api.py | 12 +- test/test_object_usergroupmembership_api.py | 12 +- test/test_object_userlogintype_api.py | 6 +- test/test_object_userstaged_api.py | 14 +- test/test_object_variableexpense_api.py | 14 +- test/test_object_versionhistory_api.py | 6 +- test/test_object_webhook_api.py | 32 +- ...come_get_communication_list_v1_response.py | 4 +- ...ommunication_list_v1_response_m_payload.py | 4 +- ...ymentterm_autocomplete_element_response.py | 4 +- ...st_paymentterm_create_object_v1_request.py | 4 +- ...t_paymentterm_create_object_v1_response.py | 4 +- ...erm_create_object_v1_response_m_payload.py | 4 +- ...test_paymentterm_edit_object_v1_request.py | 4 +- ...est_paymentterm_edit_object_v1_response.py | 4 +- ...aymentterm_get_autocomplete_v2_response.py | 4 +- ..._get_autocomplete_v2_response_m_payload.py | 4 +- test/test_paymentterm_get_list_v1_response.py | 4 +- ...mentterm_get_list_v1_response_m_payload.py | 4 +- ...test_paymentterm_get_object_v2_response.py | 4 +- ...ntterm_get_object_v2_response_m_payload.py | 4 +- test/test_paymentterm_list_element.py | 4 +- test/test_paymentterm_request.py | 4 +- test/test_paymentterm_request_compound.py | 4 +- test/test_paymentterm_response.py | 4 +- test/test_paymentterm_response_compound.py | 4 +- ...st_period_autocomplete_element_response.py | 4 +- ...est_period_get_autocomplete_v2_response.py | 4 +- ..._get_autocomplete_v2_response_m_payload.py | 4 +- ...est_permission_create_object_v1_request.py | 4 +- ...st_permission_create_object_v1_response.py | 4 +- ...ion_create_object_v1_response_m_payload.py | 4 +- ...st_permission_delete_object_v1_response.py | 4 +- .../test_permission_edit_object_v1_request.py | 4 +- ...test_permission_edit_object_v1_response.py | 4 +- .../test_permission_get_object_v2_response.py | 4 +- ...ission_get_object_v2_response_m_payload.py | 4 +- test/test_permission_request.py | 4 +- test/test_permission_request_compound.py | 4 +- test/test_permission_response.py | 4 +- test/test_permission_response_compound.py | 4 +- test/test_phone_request.py | 4 +- test/test_phone_request_compound.py | 4 +- test/test_phone_response.py | 4 +- test/test_phone_response_compound.py | 7 +- ...phonetype_autocomplete_element_response.py | 4 +- ..._phonetype_get_autocomplete_v2_response.py | 4 +- ..._get_autocomplete_v2_response_m_payload.py | 4 +- ...hase_get_communication_list_v1_response.py | 4 +- ...ommunication_list_v1_response_m_payload.py | 4 +- test/test_scim_authentication_scheme.py | 4 +- test/test_scim_email.py | 4 +- test/test_scim_group.py | 4 +- test/test_scim_group_member.py | 4 +- test/test_scim_groups_api.py | 14 +- test/test_scim_service_provider_config.py | 4 +- test/test_scim_service_provider_config_api.py | 6 +- .../test_scim_service_provider_config_bulk.py | 4 +- ...service_provider_config_change_password.py | 4 +- .../test_scim_service_provider_config_etag.py | 4 +- ...est_scim_service_provider_config_filter.py | 4 +- ...test_scim_service_provider_config_patch.py | 4 +- .../test_scim_service_provider_config_sort.py | 4 +- test/test_scim_user.py | 4 +- test/test_scim_user_list.py | 4 +- test/test_scim_users_api.py | 14 +- ...tquestion_autocomplete_element_response.py | 4 +- ...etquestion_get_autocomplete_v2_response.py | 4 +- ..._get_autocomplete_v2_response_m_payload.py | 4 +- ...est_sessionhistory_get_list_v1_response.py | 4 +- ...nhistory_get_list_v1_response_m_payload.py | 4 +- test/test_sessionhistory_list_element.py | 4 +- ...test_signature_create_object_v1_request.py | 4 +- ...est_signature_create_object_v1_response.py | 4 +- ...ure_create_object_v1_response_m_payload.py | 4 +- ...est_signature_delete_object_v1_response.py | 4 +- test/test_signature_edit_object_v1_request.py | 4 +- .../test_signature_edit_object_v1_response.py | 4 +- test/test_signature_get_object_v2_response.py | 4 +- ...nature_get_object_v2_response_m_payload.py | 4 +- test/test_signature_request.py | 4 +- test/test_signature_request_compound.py | 4 +- test/test_signature_response.py | 4 +- test/test_signature_response_compound.py | 4 +- test/test_subnet_create_object_v1_request.py | 4 +- test/test_subnet_create_object_v1_response.py | 4 +- ...net_create_object_v1_response_m_payload.py | 4 +- test/test_subnet_delete_object_v1_response.py | 4 +- test/test_subnet_edit_object_v1_request.py | 4 +- test/test_subnet_edit_object_v1_response.py | 4 +- test/test_subnet_get_object_v2_response.py | 4 +- ...subnet_get_object_v2_response_m_payload.py | 4 +- test/test_subnet_request.py | 4 +- test/test_subnet_request_compound.py | 4 +- test/test_subnet_response.py | 4 +- test/test_subnet_response_compound.py | 4 +- ...temconfiguration_edit_object_v1_request.py | 4 +- ...emconfiguration_edit_object_v1_response.py | 4 +- ...temconfiguration_get_object_v2_response.py | 4 +- ...ration_get_object_v2_response_m_payload.py | 4 +- test/test_systemconfiguration_request.py | 4 +- ...st_systemconfiguration_request_compound.py | 4 +- test/test_systemconfiguration_response.py | 4 +- ...t_systemconfiguration_response_compound.py | 4 +- ...ssignment_autocomplete_element_response.py | 4 +- ...assignment_get_autocomplete_v2_response.py | 4 +- ..._get_autocomplete_v2_response_m_payload.py | 4 +- test/test_textstylestatic_response.py | 4 +- .../test_textstylestatic_response_compound.py | 4 +- ..._timezone_autocomplete_element_response.py | 4 +- ...t_timezone_get_autocomplete_v2_response.py | 4 +- ..._get_autocomplete_v2_response_m_payload.py | 4 +- ...test_user_autocomplete_element_response.py | 4 +- .../test_user_create_ezsignuser_v1_request.py | 4 +- ...test_user_create_ezsignuser_v1_response.py | 4 +- ...create_ezsignuser_v1_response_m_payload.py | 4 +- test/test_user_create_object_v1_request.py | 4 +- test/test_user_create_object_v1_response.py | 4 +- ...ser_create_object_v1_response_m_payload.py | 4 +- test/test_user_edit_object_v1_request.py | 4 +- test/test_user_edit_object_v1_response.py | 4 +- test/test_user_edit_permissions_v1_request.py | 4 +- .../test_user_edit_permissions_v1_response.py | 4 +- ..._edit_permissions_v1_response_m_payload.py | 4 +- test/test_user_get_apikeys_v1_response.py | 4 +- ..._user_get_apikeys_v1_response_m_payload.py | 4 +- .../test_user_get_autocomplete_v2_response.py | 4 +- ..._get_autocomplete_v2_response_m_payload.py | 4 +- ...r_get_effective_permissions_v1_response.py | 4 +- ...ctive_permissions_v1_response_m_payload.py | 4 +- test/test_user_get_list_v1_response.py | 4 +- ...est_user_get_list_v1_response_m_payload.py | 4 +- test/test_user_get_object_v2_response.py | 4 +- ...t_user_get_object_v2_response_m_payload.py | 4 +- test/test_user_get_permissions_v1_response.py | 4 +- ...r_get_permissions_v1_response_m_payload.py | 4 +- test/test_user_get_subnets_v1_response.py | 4 +- ..._user_get_subnets_v1_response_m_payload.py | 4 +- test/test_user_list_element.py | 4 +- test/test_user_request.py | 4 +- test/test_user_request_compound.py | 4 +- test/test_user_response.py | 4 +- test/test_user_response_compound.py | 4 +- ...st_user_send_password_reset_v1_response.py | 4 +- ...usergroup_autocomplete_element_response.py | 4 +- ...test_usergroup_create_object_v1_request.py | 4 +- ...est_usergroup_create_object_v1_response.py | 4 +- ...oup_create_object_v1_response_m_payload.py | 4 +- test/test_usergroup_edit_object_v1_request.py | 4 +- .../test_usergroup_edit_object_v1_response.py | 4 +- ...t_usergroup_edit_permissions_v1_request.py | 4 +- ..._usergroup_edit_permissions_v1_response.py | 4 +- ..._edit_permissions_v1_response_m_payload.py | 4 +- ...up_edit_usergroupdelegations_v1_request.py | 4 +- ...p_edit_usergroupdelegations_v1_response.py | 4 +- ...rgroupdelegations_v1_response_m_payload.py | 4 +- ...up_edit_usergroupmemberships_v1_request.py | 4 +- ...p_edit_usergroupmemberships_v1_response.py | 4 +- ...rgroupmemberships_v1_response_m_payload.py | 4 +- ..._usergroup_get_autocomplete_v2_response.py | 4 +- ..._get_autocomplete_v2_response_m_payload.py | 4 +- test/test_usergroup_get_list_v1_response.py | 4 +- ...sergroup_get_list_v1_response_m_payload.py | 4 +- test/test_usergroup_get_object_v2_response.py | 4 +- ...rgroup_get_object_v2_response_m_payload.py | 4 +- ...t_usergroup_get_permissions_v1_response.py | 4 +- ...p_get_permissions_v1_response_m_payload.py | 4 +- ...up_get_usergroupdelegations_v1_response.py | 4 +- ...rgroupdelegations_v1_response_m_payload.py | 4 +- ...up_get_usergroupmemberships_v1_response.py | 4 +- ...rgroupmemberships_v1_response_m_payload.py | 4 +- test/test_usergroup_list_element.py | 4 +- test/test_usergroup_request.py | 4 +- test/test_usergroup_request_compound.py | 4 +- test/test_usergroup_response.py | 4 +- test/test_usergroup_response_compound.py | 4 +- ...roupdelegation_create_object_v1_request.py | 4 +- ...oupdelegation_create_object_v1_response.py | 4 +- ...ion_create_object_v1_response_m_payload.py | 4 +- ...oupdelegation_delete_object_v1_response.py | 4 +- ...rgroupdelegation_edit_object_v1_request.py | 4 +- ...groupdelegation_edit_object_v1_response.py | 4 +- ...rgroupdelegation_get_object_v2_response.py | 4 +- ...gation_get_object_v2_response_m_payload.py | 4 +- test/test_usergroupdelegation_request.py | 4 +- ...st_usergroupdelegation_request_compound.py | 4 +- test/test_usergroupdelegation_response.py | 4 +- ...t_usergroupdelegation_response_compound.py | 4 +- ...roupmembership_create_object_v1_request.py | 4 +- ...oupmembership_create_object_v1_response.py | 4 +- ...hip_create_object_v1_response_m_payload.py | 4 +- ...oupmembership_delete_object_v1_response.py | 4 +- ...rgroupmembership_edit_object_v1_request.py | 4 +- ...groupmembership_edit_object_v1_response.py | 4 +- ...rgroupmembership_get_object_v2_response.py | 4 +- ...ership_get_object_v2_response_m_payload.py | 4 +- test/test_usergroupmembership_request.py | 4 +- ...st_usergroupmembership_request_compound.py | 4 +- test/test_usergroupmembership_response.py | 4 +- ...t_usergroupmembership_response_compound.py | 4 +- ...logintype_autocomplete_element_response.py | 4 +- ...rlogintype_get_autocomplete_v2_response.py | 4 +- ..._get_autocomplete_v2_response_m_payload.py | 4 +- ...test_userstaged_create_user_v1_response.py | 4 +- ...taged_create_user_v1_response_m_payload.py | 4 +- ...st_userstaged_delete_object_v1_response.py | 4 +- test/test_userstaged_get_list_v1_response.py | 4 +- ...erstaged_get_list_v1_response_m_payload.py | 4 +- .../test_userstaged_get_object_v2_response.py | 4 +- ...staged_get_object_v2_response_m_payload.py | 4 +- test/test_userstaged_list_element.py | 4 +- test/test_userstaged_map_v1_request.py | 4 +- test/test_userstaged_map_v1_response.py | 4 +- test/test_userstaged_response.py | 4 +- test/test_userstaged_response_compound.py | 4 +- ...leexpense_autocomplete_element_response.py | 4 +- ...ariableexpense_create_object_v1_request.py | 4 +- ...riableexpense_create_object_v1_response.py | 4 +- ...nse_create_object_v1_response_m_payload.py | 4 +- ..._variableexpense_edit_object_v1_request.py | 4 +- ...variableexpense_edit_object_v1_response.py | 4 +- ...bleexpense_get_autocomplete_v2_response.py | 4 +- ..._get_autocomplete_v2_response_m_payload.py | 4 +- ...st_variableexpense_get_list_v1_response.py | 4 +- ...eexpense_get_list_v1_response_m_payload.py | 4 +- ..._variableexpense_get_object_v2_response.py | 4 +- ...xpense_get_object_v2_response_m_payload.py | 4 +- test/test_variableexpense_list_element.py | 4 +- test/test_variableexpense_request.py | 4 +- test/test_variableexpense_request_compound.py | 4 +- test/test_variableexpense_response.py | 4 +- .../test_variableexpense_response_compound.py | 4 +- ...t_versionhistory_get_object_v2_response.py | 4 +- ...istory_get_object_v2_response_m_payload.py | 4 +- test/test_versionhistory_response.py | 4 +- test/test_versionhistory_response_compound.py | 4 +- test/test_webhook_create_object_v1_request.py | 4 +- .../test_webhook_create_object_v1_response.py | 4 +- ...ook_create_object_v1_response_m_payload.py | 4 +- test/test_webhook_create_object_v2_request.py | 58 + .../test_webhook_create_object_v2_response.py | 75 + ...ook_create_object_v2_response_m_payload.py | 58 + .../test_webhook_delete_object_v1_response.py | 4 +- test/test_webhook_edit_object_v1_request.py | 4 +- test/test_webhook_edit_object_v1_response.py | 4 +- .../test_webhook_ezsign_document_completed.py | 10 +- ...ebhook_ezsign_ezsignsigner_acceptclause.py | 4 +- ...est_webhook_ezsign_ezsignsigner_connect.py | 4 +- test/test_webhook_ezsign_folder_completed.py | 4 +- test/test_webhook_get_history_v1_response.py | 4 +- ...bhook_get_history_v1_response_m_payload.py | 4 +- test/test_webhook_get_list_v1_response.py | 4 +- ..._webhook_get_list_v1_response_m_payload.py | 10 +- test/test_webhook_get_object_v2_response.py | 4 +- ...ebhook_get_object_v2_response_m_payload.py | 4 +- test/test_webhook_list_element.py | 8 +- ...st_webhook_regenerate_apikey_v1_request.py | 53 + ...t_webhook_regenerate_apikey_v1_response.py | 71 + ...regenerate_apikey_v1_response_m_payload.py | 54 + test/test_webhook_request.py | 5 +- test/test_webhook_request_compound.py | 5 +- test/test_webhook_response.py | 8 +- test/test_webhook_response_compound.py | 8 +- test/test_webhook_test_v1_response.py | 4 +- test/test_webhook_user_user_created.py | 4 +- ...t_webhook_userstaged_userstaged_created.py | 4 +- test/test_website_request.py | 4 +- test/test_website_request_compound.py | 4 +- ...ocket_request_server_get_websocket_idv1.py | 4 +- test/test_websocket_response_error_v1.py | 6 +- ...t_websocket_response_error_v1_m_payload.py | 4 +- ...t_websocket_response_get_websocket_idv1.py | 4 +- ...t_response_get_websocket_idv1_m_payload.py | 4 +- .../test_websocket_response_information_v1.py | 6 +- ...ocket_response_information_v1_m_payload.py | 4 +- 3692 files changed, 144613 insertions(+), 66831 deletions(-) delete mode 100644 docs/AttachmentDownloadV1Response.md create mode 100644 docs/AttachmentGetAttachmentlogsV1Response.md create mode 100644 docs/AttachmentGetAttachmentlogsV1ResponseMPayload.md create mode 100644 docs/AttachmentGetDownloadUrlV1Response.md create mode 100644 docs/AttachmentGetDownloadUrlV1ResponseMPayload.md create mode 100644 docs/AttachmentResponse.md create mode 100644 docs/AttachmentResponseCompound.md create mode 100644 docs/AttachmentlogResponse.md create mode 100644 docs/AttachmentlogResponseCompound.md create mode 100644 docs/CustomAttachmentResponse.md create mode 100644 docs/CustomAttachmentdocumenttypeResponse.md create mode 100644 docs/EzsigndocumentGetAttachmentsV1Response.md create mode 100644 docs/EzsigndocumentGetAttachmentsV1ResponseMPayload.md create mode 100644 docs/EzsignfolderGetAttachmentCountV1Response.md create mode 100644 docs/EzsignfolderGetAttachmentCountV1ResponseMPayload.md create mode 100644 docs/EzsignfolderGetAttachmentsV1Response.md create mode 100644 docs/EzsignfolderGetAttachmentsV1ResponseMPayload.md create mode 100644 docs/EzsignsigningreasonAutocompleteElementResponse.md create mode 100644 docs/EzsignsigningreasonCreateObjectV1Request.md create mode 100644 docs/EzsignsigningreasonCreateObjectV1Response.md create mode 100644 docs/EzsignsigningreasonCreateObjectV1ResponseMPayload.md create mode 100644 docs/EzsignsigningreasonEditObjectV1Request.md create mode 100644 docs/EzsignsigningreasonEditObjectV1Response.md create mode 100644 docs/EzsignsigningreasonGetAutocompleteV2Response.md create mode 100644 docs/EzsignsigningreasonGetAutocompleteV2ResponseMPayload.md create mode 100644 docs/EzsignsigningreasonGetListV1Response.md create mode 100644 docs/EzsignsigningreasonGetListV1ResponseMPayload.md create mode 100644 docs/EzsignsigningreasonGetObjectV2Response.md create mode 100644 docs/EzsignsigningreasonGetObjectV2ResponseMPayload.md create mode 100644 docs/EzsignsigningreasonListElement.md create mode 100644 docs/EzsignsigningreasonRequest.md create mode 100644 docs/EzsignsigningreasonRequestCompound.md create mode 100644 docs/EzsignsigningreasonResponse.md create mode 100644 docs/EzsignsigningreasonResponseCompound.md create mode 100644 docs/FieldEAttachmentDocumenttype.md create mode 100644 docs/FieldEAttachmentPrivacy.md create mode 100644 docs/FieldEAttachmentType.md create mode 100644 docs/FieldEAttachmentVerified.md create mode 100644 docs/FieldEAttachmentlogType.md create mode 100644 docs/FieldEUserEzsignprepaid.md create mode 100644 docs/InscriptionGetAttachmentsV1Response.md create mode 100644 docs/InscriptionGetAttachmentsV1ResponseMPayload.md create mode 100644 docs/InscriptionGetCommunicationsendersV1Response.md create mode 100644 docs/InscriptionGetCommunicationsendersV1ResponseMPayload.md create mode 100644 docs/InvoiceGetAttachmentsV1Response.md create mode 100644 docs/InvoiceGetAttachmentsV1ResponseMPayload.md create mode 100644 docs/MultilingualEzsignsigningreasonDescription.md create mode 100644 docs/ObjectEzsignsigningreasonApi.md create mode 100644 docs/WebhookCreateObjectV2Request.md create mode 100644 docs/WebhookCreateObjectV2Response.md create mode 100644 docs/WebhookCreateObjectV2ResponseMPayload.md create mode 100644 docs/WebhookRegenerateApikeyV1Request.md create mode 100644 docs/WebhookRegenerateApikeyV1Response.md create mode 100644 docs/WebhookRegenerateApikeyV1ResponseMPayload.md create mode 100644 eZmaxApi/api/object_ezsignsigningreason_api.py delete mode 100644 eZmaxApi/models/attachment_download_v1_response.py create mode 100644 eZmaxApi/models/attachment_get_attachmentlogs_v1_response.py create mode 100644 eZmaxApi/models/attachment_get_attachmentlogs_v1_response_m_payload.py create mode 100644 eZmaxApi/models/attachment_get_download_url_v1_response.py create mode 100644 eZmaxApi/models/attachment_get_download_url_v1_response_m_payload.py create mode 100644 eZmaxApi/models/attachment_response.py create mode 100644 eZmaxApi/models/attachment_response_compound.py create mode 100644 eZmaxApi/models/attachmentlog_response.py create mode 100644 eZmaxApi/models/attachmentlog_response_compound.py create mode 100644 eZmaxApi/models/custom_attachment_response.py create mode 100644 eZmaxApi/models/custom_attachmentdocumenttype_response.py create mode 100644 eZmaxApi/models/ezsigndocument_get_attachments_v1_response.py create mode 100644 eZmaxApi/models/ezsigndocument_get_attachments_v1_response_m_payload.py create mode 100644 eZmaxApi/models/ezsignfolder_get_attachment_count_v1_response.py create mode 100644 eZmaxApi/models/ezsignfolder_get_attachment_count_v1_response_m_payload.py create mode 100644 eZmaxApi/models/ezsignfolder_get_attachments_v1_response.py create mode 100644 eZmaxApi/models/ezsignfolder_get_attachments_v1_response_m_payload.py create mode 100644 eZmaxApi/models/ezsignsigningreason_autocomplete_element_response.py create mode 100644 eZmaxApi/models/ezsignsigningreason_create_object_v1_request.py create mode 100644 eZmaxApi/models/ezsignsigningreason_create_object_v1_response.py create mode 100644 eZmaxApi/models/ezsignsigningreason_create_object_v1_response_m_payload.py create mode 100644 eZmaxApi/models/ezsignsigningreason_edit_object_v1_request.py create mode 100644 eZmaxApi/models/ezsignsigningreason_edit_object_v1_response.py create mode 100644 eZmaxApi/models/ezsignsigningreason_get_autocomplete_v2_response.py create mode 100644 eZmaxApi/models/ezsignsigningreason_get_autocomplete_v2_response_m_payload.py create mode 100644 eZmaxApi/models/ezsignsigningreason_get_list_v1_response.py create mode 100644 eZmaxApi/models/ezsignsigningreason_get_list_v1_response_m_payload.py create mode 100644 eZmaxApi/models/ezsignsigningreason_get_object_v2_response.py create mode 100644 eZmaxApi/models/ezsignsigningreason_get_object_v2_response_m_payload.py create mode 100644 eZmaxApi/models/ezsignsigningreason_list_element.py create mode 100644 eZmaxApi/models/ezsignsigningreason_request.py create mode 100644 eZmaxApi/models/ezsignsigningreason_request_compound.py create mode 100644 eZmaxApi/models/ezsignsigningreason_response.py create mode 100644 eZmaxApi/models/ezsignsigningreason_response_compound.py create mode 100644 eZmaxApi/models/field_e_attachment_documenttype.py create mode 100644 eZmaxApi/models/field_e_attachment_privacy.py create mode 100644 eZmaxApi/models/field_e_attachment_type.py create mode 100644 eZmaxApi/models/field_e_attachment_verified.py create mode 100644 eZmaxApi/models/field_e_attachmentlog_type.py create mode 100644 eZmaxApi/models/field_e_user_ezsignprepaid.py create mode 100644 eZmaxApi/models/inscription_get_attachments_v1_response.py create mode 100644 eZmaxApi/models/inscription_get_attachments_v1_response_m_payload.py create mode 100644 eZmaxApi/models/inscription_get_communicationsenders_v1_response.py create mode 100644 eZmaxApi/models/inscription_get_communicationsenders_v1_response_m_payload.py create mode 100644 eZmaxApi/models/invoice_get_attachments_v1_response.py create mode 100644 eZmaxApi/models/invoice_get_attachments_v1_response_m_payload.py create mode 100644 eZmaxApi/models/multilingual_ezsignsigningreason_description.py create mode 100644 eZmaxApi/models/webhook_create_object_v2_request.py create mode 100644 eZmaxApi/models/webhook_create_object_v2_response.py create mode 100644 eZmaxApi/models/webhook_create_object_v2_response_m_payload.py create mode 100644 eZmaxApi/models/webhook_regenerate_apikey_v1_request.py create mode 100644 eZmaxApi/models/webhook_regenerate_apikey_v1_response.py create mode 100644 eZmaxApi/models/webhook_regenerate_apikey_v1_response_m_payload.py create mode 100644 test/test_attachment_get_attachmentlogs_v1_response.py create mode 100644 test/test_attachment_get_attachmentlogs_v1_response_m_payload.py create mode 100644 test/test_attachment_get_download_url_v1_response.py create mode 100644 test/test_attachment_get_download_url_v1_response_m_payload.py create mode 100644 test/test_attachment_response.py create mode 100644 test/test_attachment_response_compound.py create mode 100644 test/test_attachmentlog_response.py create mode 100644 test/test_attachmentlog_response_compound.py create mode 100644 test/test_custom_attachment_response.py create mode 100644 test/test_custom_attachmentdocumenttype_response.py create mode 100644 test/test_ezsigndocument_get_attachments_v1_response.py create mode 100644 test/test_ezsigndocument_get_attachments_v1_response_m_payload.py create mode 100644 test/test_ezsignfolder_get_attachment_count_v1_response.py create mode 100644 test/test_ezsignfolder_get_attachment_count_v1_response_m_payload.py create mode 100644 test/test_ezsignfolder_get_attachments_v1_response.py create mode 100644 test/test_ezsignfolder_get_attachments_v1_response_m_payload.py create mode 100644 test/test_ezsignsigningreason_autocomplete_element_response.py create mode 100644 test/test_ezsignsigningreason_create_object_v1_request.py create mode 100644 test/test_ezsignsigningreason_create_object_v1_response.py create mode 100644 test/test_ezsignsigningreason_create_object_v1_response_m_payload.py create mode 100644 test/test_ezsignsigningreason_edit_object_v1_request.py rename test/{test_attachment_download_v1_response.py => test_ezsignsigningreason_edit_object_v1_response.py} (70%) create mode 100644 test/test_ezsignsigningreason_get_autocomplete_v2_response.py create mode 100644 test/test_ezsignsigningreason_get_autocomplete_v2_response_m_payload.py create mode 100644 test/test_ezsignsigningreason_get_list_v1_response.py create mode 100644 test/test_ezsignsigningreason_get_list_v1_response_m_payload.py create mode 100644 test/test_ezsignsigningreason_get_object_v2_response.py create mode 100644 test/test_ezsignsigningreason_get_object_v2_response_m_payload.py create mode 100644 test/test_ezsignsigningreason_list_element.py create mode 100644 test/test_ezsignsigningreason_request.py create mode 100644 test/test_ezsignsigningreason_request_compound.py create mode 100644 test/test_ezsignsigningreason_response.py create mode 100644 test/test_ezsignsigningreason_response_compound.py create mode 100644 test/test_field_e_attachment_documenttype.py create mode 100644 test/test_field_e_attachment_privacy.py create mode 100644 test/test_field_e_attachment_type.py create mode 100644 test/test_field_e_attachment_verified.py create mode 100644 test/test_field_e_attachmentlog_type.py create mode 100644 test/test_field_e_user_ezsignprepaid.py create mode 100644 test/test_inscription_get_attachments_v1_response.py create mode 100644 test/test_inscription_get_attachments_v1_response_m_payload.py create mode 100644 test/test_inscription_get_communicationsenders_v1_response.py create mode 100644 test/test_inscription_get_communicationsenders_v1_response_m_payload.py create mode 100644 test/test_invoice_get_attachments_v1_response.py create mode 100644 test/test_invoice_get_attachments_v1_response_m_payload.py create mode 100644 test/test_multilingual_ezsignsigningreason_description.py create mode 100644 test/test_object_ezsignsigningreason_api.py create mode 100644 test/test_webhook_create_object_v2_request.py create mode 100644 test/test_webhook_create_object_v2_response.py create mode 100644 test/test_webhook_create_object_v2_response_m_payload.py create mode 100644 test/test_webhook_regenerate_apikey_v1_request.py create mode 100644 test/test_webhook_regenerate_apikey_v1_response.py create mode 100644 test/test_webhook_regenerate_apikey_v1_response_m_payload.py diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES index 310d8d985..f5de9060d 100644 --- a/.openapi-generator/FILES +++ b/.openapi-generator/FILES @@ -41,7 +41,14 @@ docs/ApikeyRequest.md docs/ApikeyRequestCompound.md docs/ApikeyResponse.md docs/ApikeyResponseCompound.md -docs/AttachmentDownloadV1Response.md +docs/AttachmentGetAttachmentlogsV1Response.md +docs/AttachmentGetAttachmentlogsV1ResponseMPayload.md +docs/AttachmentGetDownloadUrlV1Response.md +docs/AttachmentGetDownloadUrlV1ResponseMPayload.md +docs/AttachmentResponse.md +docs/AttachmentResponseCompound.md +docs/AttachmentlogResponse.md +docs/AttachmentlogResponseCompound.md docs/AttemptResponse.md docs/AttemptResponseCompound.md docs/BillingentityexternalAutocompleteElementResponse.md @@ -154,6 +161,8 @@ docs/CorsRequest.md docs/CorsRequestCompound.md docs/CorsResponse.md docs/CorsResponseCompound.md +docs/CustomAttachmentResponse.md +docs/CustomAttachmentdocumenttypeResponse.md docs/CustomAutocompleteElementResponse.md docs/CustomCommunicationListElementResponse.md docs/CustomCommunicationattachmentRequest.md @@ -327,6 +336,8 @@ docs/EzsigndocumentEndPrematurelyV1Response.md docs/EzsigndocumentFlattenV1Response.md docs/EzsigndocumentGetActionableElementsV1Response.md docs/EzsigndocumentGetActionableElementsV1ResponseMPayload.md +docs/EzsigndocumentGetAttachmentsV1Response.md +docs/EzsigndocumentGetAttachmentsV1ResponseMPayload.md docs/EzsigndocumentGetCompletedElementsV1Response.md docs/EzsigndocumentGetCompletedElementsV1ResponseMPayload.md docs/EzsigndocumentGetDownloadUrlV1Response.md @@ -383,6 +394,10 @@ docs/EzsignfolderEditObjectV1Request.md docs/EzsignfolderEditObjectV1Response.md docs/EzsignfolderGetActionableElementsV1Response.md docs/EzsignfolderGetActionableElementsV1ResponseMPayload.md +docs/EzsignfolderGetAttachmentCountV1Response.md +docs/EzsignfolderGetAttachmentCountV1ResponseMPayload.md +docs/EzsignfolderGetAttachmentsV1Response.md +docs/EzsignfolderGetAttachmentsV1ResponseMPayload.md docs/EzsignfolderGetCommunicationCountV1Response.md docs/EzsignfolderGetCommunicationCountV1ResponseMPayload.md docs/EzsignfolderGetCommunicationListV1Response.md @@ -548,6 +563,23 @@ docs/EzsignsignergroupmembershipRequest.md docs/EzsignsignergroupmembershipRequestCompound.md docs/EzsignsignergroupmembershipResponse.md docs/EzsignsignergroupmembershipResponseCompound.md +docs/EzsignsigningreasonAutocompleteElementResponse.md +docs/EzsignsigningreasonCreateObjectV1Request.md +docs/EzsignsigningreasonCreateObjectV1Response.md +docs/EzsignsigningreasonCreateObjectV1ResponseMPayload.md +docs/EzsignsigningreasonEditObjectV1Request.md +docs/EzsignsigningreasonEditObjectV1Response.md +docs/EzsignsigningreasonGetAutocompleteV2Response.md +docs/EzsignsigningreasonGetAutocompleteV2ResponseMPayload.md +docs/EzsignsigningreasonGetListV1Response.md +docs/EzsignsigningreasonGetListV1ResponseMPayload.md +docs/EzsignsigningreasonGetObjectV2Response.md +docs/EzsignsigningreasonGetObjectV2ResponseMPayload.md +docs/EzsignsigningreasonListElement.md +docs/EzsignsigningreasonRequest.md +docs/EzsignsigningreasonRequestCompound.md +docs/EzsignsigningreasonResponse.md +docs/EzsignsigningreasonResponseCompound.md docs/EzsigntemplateAutocompleteElementResponse.md docs/EzsigntemplateCopyV1Request.md docs/EzsigntemplateCopyV1Response.md @@ -715,6 +747,11 @@ docs/EzsigntsarequirementGetAutocompleteV2ResponseMPayload.md docs/FieldEActivesessionOrigin.md docs/FieldEActivesessionUsertype.md docs/FieldEActivesessionWeekdaystart.md +docs/FieldEAttachmentDocumenttype.md +docs/FieldEAttachmentPrivacy.md +docs/FieldEAttachmentType.md +docs/FieldEAttachmentVerified.md +docs/FieldEAttachmentlogType.md docs/FieldEBrandingLogo.md docs/FieldECommunicationImportance.md docs/FieldECommunicationType.md @@ -766,6 +803,7 @@ docs/FieldESystemconfigurationLanguage1.md docs/FieldESystemconfigurationLanguage2.md docs/FieldESystemconfigurationNewexternaluseraction.md docs/FieldEUserEzsignaccess.md +docs/FieldEUserEzsignprepaid.md docs/FieldEUserEzsignsendreminderfrequency.md docs/FieldEUserLogintype.md docs/FieldEUserOrigin.md @@ -801,12 +839,18 @@ docs/GlobalEzmaxclientVersionV1Response.md docs/GlobalEzmaxcustomerApi.md docs/GlobalEzmaxcustomerGetConfigurationV1Response.md docs/HeaderAcceptLanguage.md +docs/InscriptionGetAttachmentsV1Response.md +docs/InscriptionGetAttachmentsV1ResponseMPayload.md docs/InscriptionGetCommunicationListV1Response.md docs/InscriptionGetCommunicationListV1ResponseMPayload.md +docs/InscriptionGetCommunicationsendersV1Response.md +docs/InscriptionGetCommunicationsendersV1ResponseMPayload.md docs/InscriptionnotauthenticatedGetCommunicationListV1Response.md docs/InscriptionnotauthenticatedGetCommunicationListV1ResponseMPayload.md docs/InscriptiontempGetCommunicationListV1Response.md docs/InscriptiontempGetCommunicationListV1ResponseMPayload.md +docs/InvoiceGetAttachmentsV1Response.md +docs/InvoiceGetAttachmentsV1ResponseMPayload.md docs/InvoiceGetCommunicationListV1Response.md docs/InvoiceGetCommunicationListV1ResponseMPayload.md docs/LanguageAutocompleteElementResponse.md @@ -829,6 +873,7 @@ docs/MultilingualBrandingDescription.md docs/MultilingualEzmaxinvoicingsummaryinternalDescription.md docs/MultilingualEzsignfoldertypeName.md docs/MultilingualEzsignsignergroupDescription.md +docs/MultilingualEzsignsigningreasonDescription.md docs/MultilingualNotificationsubsectionName.md docs/MultilingualNotificationtestName.md docs/MultilingualPaymenttermDescription.md @@ -871,6 +916,7 @@ docs/ObjectEzsignpageApi.md docs/ObjectEzsignsignatureApi.md docs/ObjectEzsignsignergroupApi.md docs/ObjectEzsignsignergroupmembershipApi.md +docs/ObjectEzsignsigningreasonApi.md docs/ObjectEzsigntemplateApi.md docs/ObjectEzsigntemplatedocumentApi.md docs/ObjectEzsigntemplateformfieldgroupApi.md @@ -1147,6 +1193,9 @@ docs/VersionhistoryResponseCompound.md docs/WebhookCreateObjectV1Request.md docs/WebhookCreateObjectV1Response.md docs/WebhookCreateObjectV1ResponseMPayload.md +docs/WebhookCreateObjectV2Request.md +docs/WebhookCreateObjectV2Response.md +docs/WebhookCreateObjectV2ResponseMPayload.md docs/WebhookDeleteObjectV1Response.md docs/WebhookEditObjectV1Request.md docs/WebhookEditObjectV1Response.md @@ -1161,6 +1210,9 @@ docs/WebhookGetListV1ResponseMPayload.md docs/WebhookGetObjectV2Response.md docs/WebhookGetObjectV2ResponseMPayload.md docs/WebhookListElement.md +docs/WebhookRegenerateApikeyV1Request.md +docs/WebhookRegenerateApikeyV1Response.md +docs/WebhookRegenerateApikeyV1ResponseMPayload.md docs/WebhookRequest.md docs/WebhookRequestCompound.md docs/WebhookResponse.md @@ -1214,6 +1266,7 @@ eZmaxApi/api/object_ezsignpage_api.py eZmaxApi/api/object_ezsignsignature_api.py eZmaxApi/api/object_ezsignsignergroup_api.py eZmaxApi/api/object_ezsignsignergroupmembership_api.py +eZmaxApi/api/object_ezsignsigningreason_api.py eZmaxApi/api/object_ezsigntemplate_api.py eZmaxApi/api/object_ezsigntemplatedocument_api.py eZmaxApi/api/object_ezsigntemplateformfieldgroup_api.py @@ -1303,7 +1356,14 @@ eZmaxApi/models/apikey_request.py eZmaxApi/models/apikey_request_compound.py eZmaxApi/models/apikey_response.py eZmaxApi/models/apikey_response_compound.py -eZmaxApi/models/attachment_download_v1_response.py +eZmaxApi/models/attachment_get_attachmentlogs_v1_response.py +eZmaxApi/models/attachment_get_attachmentlogs_v1_response_m_payload.py +eZmaxApi/models/attachment_get_download_url_v1_response.py +eZmaxApi/models/attachment_get_download_url_v1_response_m_payload.py +eZmaxApi/models/attachment_response.py +eZmaxApi/models/attachment_response_compound.py +eZmaxApi/models/attachmentlog_response.py +eZmaxApi/models/attachmentlog_response_compound.py eZmaxApi/models/attempt_response.py eZmaxApi/models/attempt_response_compound.py eZmaxApi/models/billingentityexternal_autocomplete_element_response.py @@ -1416,6 +1476,8 @@ eZmaxApi/models/cors_request.py eZmaxApi/models/cors_request_compound.py eZmaxApi/models/cors_response.py eZmaxApi/models/cors_response_compound.py +eZmaxApi/models/custom_attachment_response.py +eZmaxApi/models/custom_attachmentdocumenttype_response.py eZmaxApi/models/custom_autocomplete_element_response.py eZmaxApi/models/custom_communication_list_element_response.py eZmaxApi/models/custom_communicationattachment_request.py @@ -1589,6 +1651,8 @@ eZmaxApi/models/ezsigndocument_end_prematurely_v1_response.py eZmaxApi/models/ezsigndocument_flatten_v1_response.py eZmaxApi/models/ezsigndocument_get_actionable_elements_v1_response.py eZmaxApi/models/ezsigndocument_get_actionable_elements_v1_response_m_payload.py +eZmaxApi/models/ezsigndocument_get_attachments_v1_response.py +eZmaxApi/models/ezsigndocument_get_attachments_v1_response_m_payload.py eZmaxApi/models/ezsigndocument_get_completed_elements_v1_response.py eZmaxApi/models/ezsigndocument_get_completed_elements_v1_response_m_payload.py eZmaxApi/models/ezsigndocument_get_download_url_v1_response.py @@ -1645,6 +1709,10 @@ eZmaxApi/models/ezsignfolder_edit_object_v1_request.py eZmaxApi/models/ezsignfolder_edit_object_v1_response.py eZmaxApi/models/ezsignfolder_get_actionable_elements_v1_response.py eZmaxApi/models/ezsignfolder_get_actionable_elements_v1_response_m_payload.py +eZmaxApi/models/ezsignfolder_get_attachment_count_v1_response.py +eZmaxApi/models/ezsignfolder_get_attachment_count_v1_response_m_payload.py +eZmaxApi/models/ezsignfolder_get_attachments_v1_response.py +eZmaxApi/models/ezsignfolder_get_attachments_v1_response_m_payload.py eZmaxApi/models/ezsignfolder_get_communication_count_v1_response.py eZmaxApi/models/ezsignfolder_get_communication_count_v1_response_m_payload.py eZmaxApi/models/ezsignfolder_get_communication_list_v1_response.py @@ -1810,6 +1878,23 @@ eZmaxApi/models/ezsignsignergroupmembership_request.py eZmaxApi/models/ezsignsignergroupmembership_request_compound.py eZmaxApi/models/ezsignsignergroupmembership_response.py eZmaxApi/models/ezsignsignergroupmembership_response_compound.py +eZmaxApi/models/ezsignsigningreason_autocomplete_element_response.py +eZmaxApi/models/ezsignsigningreason_create_object_v1_request.py +eZmaxApi/models/ezsignsigningreason_create_object_v1_response.py +eZmaxApi/models/ezsignsigningreason_create_object_v1_response_m_payload.py +eZmaxApi/models/ezsignsigningreason_edit_object_v1_request.py +eZmaxApi/models/ezsignsigningreason_edit_object_v1_response.py +eZmaxApi/models/ezsignsigningreason_get_autocomplete_v2_response.py +eZmaxApi/models/ezsignsigningreason_get_autocomplete_v2_response_m_payload.py +eZmaxApi/models/ezsignsigningreason_get_list_v1_response.py +eZmaxApi/models/ezsignsigningreason_get_list_v1_response_m_payload.py +eZmaxApi/models/ezsignsigningreason_get_object_v2_response.py +eZmaxApi/models/ezsignsigningreason_get_object_v2_response_m_payload.py +eZmaxApi/models/ezsignsigningreason_list_element.py +eZmaxApi/models/ezsignsigningreason_request.py +eZmaxApi/models/ezsignsigningreason_request_compound.py +eZmaxApi/models/ezsignsigningreason_response.py +eZmaxApi/models/ezsignsigningreason_response_compound.py eZmaxApi/models/ezsigntemplate_autocomplete_element_response.py eZmaxApi/models/ezsigntemplate_copy_v1_request.py eZmaxApi/models/ezsigntemplate_copy_v1_response.py @@ -1977,6 +2062,11 @@ eZmaxApi/models/ezsigntsarequirement_get_autocomplete_v2_response_m_payload.py eZmaxApi/models/field_e_activesession_origin.py eZmaxApi/models/field_e_activesession_usertype.py eZmaxApi/models/field_e_activesession_weekdaystart.py +eZmaxApi/models/field_e_attachment_documenttype.py +eZmaxApi/models/field_e_attachment_privacy.py +eZmaxApi/models/field_e_attachment_type.py +eZmaxApi/models/field_e_attachment_verified.py +eZmaxApi/models/field_e_attachmentlog_type.py eZmaxApi/models/field_e_branding_logo.py eZmaxApi/models/field_e_communication_importance.py eZmaxApi/models/field_e_communication_type.py @@ -2028,6 +2118,7 @@ eZmaxApi/models/field_e_systemconfiguration_language1.py eZmaxApi/models/field_e_systemconfiguration_language2.py eZmaxApi/models/field_e_systemconfiguration_newexternaluseraction.py eZmaxApi/models/field_e_user_ezsignaccess.py +eZmaxApi/models/field_e_user_ezsignprepaid.py eZmaxApi/models/field_e_user_ezsignsendreminderfrequency.py eZmaxApi/models/field_e_user_logintype.py eZmaxApi/models/field_e_user_origin.py @@ -2060,12 +2151,18 @@ eZmaxApi/models/global_customer_get_endpoint_v1_response.py eZmaxApi/models/global_ezmaxclient_version_v1_response.py eZmaxApi/models/global_ezmaxcustomer_get_configuration_v1_response.py eZmaxApi/models/header_accept_language.py +eZmaxApi/models/inscription_get_attachments_v1_response.py +eZmaxApi/models/inscription_get_attachments_v1_response_m_payload.py eZmaxApi/models/inscription_get_communication_list_v1_response.py eZmaxApi/models/inscription_get_communication_list_v1_response_m_payload.py +eZmaxApi/models/inscription_get_communicationsenders_v1_response.py +eZmaxApi/models/inscription_get_communicationsenders_v1_response_m_payload.py eZmaxApi/models/inscriptionnotauthenticated_get_communication_list_v1_response.py eZmaxApi/models/inscriptionnotauthenticated_get_communication_list_v1_response_m_payload.py eZmaxApi/models/inscriptiontemp_get_communication_list_v1_response.py eZmaxApi/models/inscriptiontemp_get_communication_list_v1_response_m_payload.py +eZmaxApi/models/invoice_get_attachments_v1_response.py +eZmaxApi/models/invoice_get_attachments_v1_response_m_payload.py eZmaxApi/models/invoice_get_communication_list_v1_response.py eZmaxApi/models/invoice_get_communication_list_v1_response_m_payload.py eZmaxApi/models/language_autocomplete_element_response.py @@ -2085,6 +2182,7 @@ eZmaxApi/models/multilingual_branding_description.py eZmaxApi/models/multilingual_ezmaxinvoicingsummaryinternal_description.py eZmaxApi/models/multilingual_ezsignfoldertype_name.py eZmaxApi/models/multilingual_ezsignsignergroup_description.py +eZmaxApi/models/multilingual_ezsignsigningreason_description.py eZmaxApi/models/multilingual_notificationsubsection_name.py eZmaxApi/models/multilingual_notificationtest_name.py eZmaxApi/models/multilingual_paymentterm_description.py @@ -2327,6 +2425,9 @@ eZmaxApi/models/versionhistory_response_compound.py eZmaxApi/models/webhook_create_object_v1_request.py eZmaxApi/models/webhook_create_object_v1_response.py eZmaxApi/models/webhook_create_object_v1_response_m_payload.py +eZmaxApi/models/webhook_create_object_v2_request.py +eZmaxApi/models/webhook_create_object_v2_response.py +eZmaxApi/models/webhook_create_object_v2_response_m_payload.py eZmaxApi/models/webhook_delete_object_v1_response.py eZmaxApi/models/webhook_edit_object_v1_request.py eZmaxApi/models/webhook_edit_object_v1_response.py @@ -2341,6 +2442,9 @@ eZmaxApi/models/webhook_get_list_v1_response_m_payload.py eZmaxApi/models/webhook_get_object_v2_response.py eZmaxApi/models/webhook_get_object_v2_response_m_payload.py eZmaxApi/models/webhook_list_element.py +eZmaxApi/models/webhook_regenerate_apikey_v1_request.py +eZmaxApi/models/webhook_regenerate_apikey_v1_response.py +eZmaxApi/models/webhook_regenerate_apikey_v1_response_m_payload.py eZmaxApi/models/webhook_request.py eZmaxApi/models/webhook_request_compound.py eZmaxApi/models/webhook_response.py @@ -2403,7 +2507,14 @@ test/test_apikey_request.py test/test_apikey_request_compound.py test/test_apikey_response.py test/test_apikey_response_compound.py -test/test_attachment_download_v1_response.py +test/test_attachment_get_attachmentlogs_v1_response.py +test/test_attachment_get_attachmentlogs_v1_response_m_payload.py +test/test_attachment_get_download_url_v1_response.py +test/test_attachment_get_download_url_v1_response_m_payload.py +test/test_attachment_response.py +test/test_attachment_response_compound.py +test/test_attachmentlog_response.py +test/test_attachmentlog_response_compound.py test/test_attempt_response.py test/test_attempt_response_compound.py test/test_billingentityexternal_autocomplete_element_response.py @@ -2516,6 +2627,8 @@ test/test_cors_request.py test/test_cors_request_compound.py test/test_cors_response.py test/test_cors_response_compound.py +test/test_custom_attachment_response.py +test/test_custom_attachmentdocumenttype_response.py test/test_custom_autocomplete_element_response.py test/test_custom_communication_list_element_response.py test/test_custom_communicationattachment_request.py @@ -2689,6 +2802,8 @@ test/test_ezsigndocument_end_prematurely_v1_response.py test/test_ezsigndocument_flatten_v1_response.py test/test_ezsigndocument_get_actionable_elements_v1_response.py test/test_ezsigndocument_get_actionable_elements_v1_response_m_payload.py +test/test_ezsigndocument_get_attachments_v1_response.py +test/test_ezsigndocument_get_attachments_v1_response_m_payload.py test/test_ezsigndocument_get_completed_elements_v1_response.py test/test_ezsigndocument_get_completed_elements_v1_response_m_payload.py test/test_ezsigndocument_get_download_url_v1_response.py @@ -2745,6 +2860,10 @@ test/test_ezsignfolder_edit_object_v1_request.py test/test_ezsignfolder_edit_object_v1_response.py test/test_ezsignfolder_get_actionable_elements_v1_response.py test/test_ezsignfolder_get_actionable_elements_v1_response_m_payload.py +test/test_ezsignfolder_get_attachment_count_v1_response.py +test/test_ezsignfolder_get_attachment_count_v1_response_m_payload.py +test/test_ezsignfolder_get_attachments_v1_response.py +test/test_ezsignfolder_get_attachments_v1_response_m_payload.py test/test_ezsignfolder_get_communication_count_v1_response.py test/test_ezsignfolder_get_communication_count_v1_response_m_payload.py test/test_ezsignfolder_get_communication_list_v1_response.py @@ -2910,6 +3029,23 @@ test/test_ezsignsignergroupmembership_request.py test/test_ezsignsignergroupmembership_request_compound.py test/test_ezsignsignergroupmembership_response.py test/test_ezsignsignergroupmembership_response_compound.py +test/test_ezsignsigningreason_autocomplete_element_response.py +test/test_ezsignsigningreason_create_object_v1_request.py +test/test_ezsignsigningreason_create_object_v1_response.py +test/test_ezsignsigningreason_create_object_v1_response_m_payload.py +test/test_ezsignsigningreason_edit_object_v1_request.py +test/test_ezsignsigningreason_edit_object_v1_response.py +test/test_ezsignsigningreason_get_autocomplete_v2_response.py +test/test_ezsignsigningreason_get_autocomplete_v2_response_m_payload.py +test/test_ezsignsigningreason_get_list_v1_response.py +test/test_ezsignsigningreason_get_list_v1_response_m_payload.py +test/test_ezsignsigningreason_get_object_v2_response.py +test/test_ezsignsigningreason_get_object_v2_response_m_payload.py +test/test_ezsignsigningreason_list_element.py +test/test_ezsignsigningreason_request.py +test/test_ezsignsigningreason_request_compound.py +test/test_ezsignsigningreason_response.py +test/test_ezsignsigningreason_response_compound.py test/test_ezsigntemplate_autocomplete_element_response.py test/test_ezsigntemplate_copy_v1_request.py test/test_ezsigntemplate_copy_v1_response.py @@ -3077,6 +3213,11 @@ test/test_ezsigntsarequirement_get_autocomplete_v2_response_m_payload.py test/test_field_e_activesession_origin.py test/test_field_e_activesession_usertype.py test/test_field_e_activesession_weekdaystart.py +test/test_field_e_attachment_documenttype.py +test/test_field_e_attachment_privacy.py +test/test_field_e_attachment_type.py +test/test_field_e_attachment_verified.py +test/test_field_e_attachmentlog_type.py test/test_field_e_branding_logo.py test/test_field_e_communication_importance.py test/test_field_e_communication_type.py @@ -3128,6 +3269,7 @@ test/test_field_e_systemconfiguration_language1.py test/test_field_e_systemconfiguration_language2.py test/test_field_e_systemconfiguration_newexternaluseraction.py test/test_field_e_user_ezsignaccess.py +test/test_field_e_user_ezsignprepaid.py test/test_field_e_user_ezsignsendreminderfrequency.py test/test_field_e_user_logintype.py test/test_field_e_user_origin.py @@ -3163,12 +3305,18 @@ test/test_global_ezmaxclient_version_v1_response.py test/test_global_ezmaxcustomer_api.py test/test_global_ezmaxcustomer_get_configuration_v1_response.py test/test_header_accept_language.py +test/test_inscription_get_attachments_v1_response.py +test/test_inscription_get_attachments_v1_response_m_payload.py test/test_inscription_get_communication_list_v1_response.py test/test_inscription_get_communication_list_v1_response_m_payload.py +test/test_inscription_get_communicationsenders_v1_response.py +test/test_inscription_get_communicationsenders_v1_response_m_payload.py test/test_inscriptionnotauthenticated_get_communication_list_v1_response.py test/test_inscriptionnotauthenticated_get_communication_list_v1_response_m_payload.py test/test_inscriptiontemp_get_communication_list_v1_response.py test/test_inscriptiontemp_get_communication_list_v1_response_m_payload.py +test/test_invoice_get_attachments_v1_response.py +test/test_invoice_get_attachments_v1_response_m_payload.py test/test_invoice_get_communication_list_v1_response.py test/test_invoice_get_communication_list_v1_response_m_payload.py test/test_language_autocomplete_element_response.py @@ -3191,6 +3339,7 @@ test/test_multilingual_branding_description.py test/test_multilingual_ezmaxinvoicingsummaryinternal_description.py test/test_multilingual_ezsignfoldertype_name.py test/test_multilingual_ezsignsignergroup_description.py +test/test_multilingual_ezsignsigningreason_description.py test/test_multilingual_notificationsubsection_name.py test/test_multilingual_notificationtest_name.py test/test_multilingual_paymentterm_description.py @@ -3233,6 +3382,7 @@ test/test_object_ezsignpage_api.py test/test_object_ezsignsignature_api.py test/test_object_ezsignsignergroup_api.py test/test_object_ezsignsignergroupmembership_api.py +test/test_object_ezsignsigningreason_api.py test/test_object_ezsigntemplate_api.py test/test_object_ezsigntemplatedocument_api.py test/test_object_ezsigntemplateformfieldgroup_api.py @@ -3509,6 +3659,9 @@ test/test_versionhistory_response_compound.py test/test_webhook_create_object_v1_request.py test/test_webhook_create_object_v1_response.py test/test_webhook_create_object_v1_response_m_payload.py +test/test_webhook_create_object_v2_request.py +test/test_webhook_create_object_v2_response.py +test/test_webhook_create_object_v2_response_m_payload.py test/test_webhook_delete_object_v1_response.py test/test_webhook_edit_object_v1_request.py test/test_webhook_edit_object_v1_response.py @@ -3523,6 +3676,9 @@ test/test_webhook_get_list_v1_response_m_payload.py test/test_webhook_get_object_v2_response.py test/test_webhook_get_object_v2_response_m_payload.py test/test_webhook_list_element.py +test/test_webhook_regenerate_apikey_v1_request.py +test/test_webhook_regenerate_apikey_v1_response.py +test/test_webhook_regenerate_apikey_v1_response_m_payload.py test/test_webhook_request.py test/test_webhook_request_compound.py test/test_webhook_response.py diff --git a/.openapi-generator/VERSION b/.openapi-generator/VERSION index 73a86b197..4b49d9bb6 100644 --- a/.openapi-generator/VERSION +++ b/.openapi-generator/VERSION @@ -1 +1 @@ -7.0.1 \ No newline at end of file +7.2.0 \ No newline at end of file diff --git a/README.md b/README.md index 8d9c0f90c..8a850f353 100644 --- a/README.md +++ b/README.md @@ -106,6 +106,8 @@ Class | Method | HTTP request | Description *ObjectApikeyApi* | [**apikey_get_subnets_v1**](docs/ObjectApikeyApi.md#apikey_get_subnets_v1) | **GET** /1/object/apikey/{pkiApikeyID}/getSubnets | Retrieve an existing Apikey's subnets *ObjectApikeyApi* | [**apikey_regenerate_v1**](docs/ObjectApikeyApi.md#apikey_regenerate_v1) | **POST** /1/object/apikey/{pkiApikeyID}/regenerate | Regenerate the Apikey *ObjectAttachmentApi* | [**attachment_download_v1**](docs/ObjectAttachmentApi.md#attachment_download_v1) | **GET** /1/object/attachment/{pkiAttachmentID}/download | Retrieve the content +*ObjectAttachmentApi* | [**attachment_get_attachmentlogs_v1**](docs/ObjectAttachmentApi.md#attachment_get_attachmentlogs_v1) | **GET** /1/object/attachment/{pkiAttachmentID}/getAttachmentlogs | Retrieve the Attachmentlogs +*ObjectAttachmentApi* | [**attachment_get_download_url_v1**](docs/ObjectAttachmentApi.md#attachment_get_download_url_v1) | **GET** /1/object/attachment/{pkiAttachmentID}/getDownloadUrl | Retrieve a URL to download attachments. *ObjectBillingentityexternalApi* | [**billingentityexternal_get_autocomplete_v2**](docs/ObjectBillingentityexternalApi.md#billingentityexternal_get_autocomplete_v2) | **GET** /2/object/billingentityexternal/getAutocomplete/{sSelector} | Retrieve Billingentityexternals and IDs *ObjectBillingentityinternalApi* | [**billingentityinternal_create_object_v1**](docs/ObjectBillingentityinternalApi.md#billingentityinternal_create_object_v1) | **POST** /1/object/billingentityinternal | Create a new Billingentityinternal *ObjectBillingentityinternalApi* | [**billingentityinternal_edit_object_v1**](docs/ObjectBillingentityinternalApi.md#billingentityinternal_edit_object_v1) | **PUT** /1/object/billingentityinternal/{pkiBillingentityinternalID} | Edit an existing Billingentityinternal @@ -126,7 +128,7 @@ Class | Method | HTTP request | Description *ObjectCorsApi* | [**cors_edit_object_v1**](docs/ObjectCorsApi.md#cors_edit_object_v1) | **PUT** /1/object/cors/{pkiCorsID} | Edit an existing Cors *ObjectCorsApi* | [**cors_get_object_v2**](docs/ObjectCorsApi.md#cors_get_object_v2) | **GET** /2/object/cors/{pkiCorsID} | Retrieve an existing Cors *ObjectDepartmentApi* | [**department_get_autocomplete_v2**](docs/ObjectDepartmentApi.md#department_get_autocomplete_v2) | **GET** /2/object/department/getAutocomplete/{sSelector} | Retrieve Departments and IDs -*ObjectElectronicfundstransferApi* | [**eletronicfundstransfer_get_communication_list_v1**](docs/ObjectElectronicfundstransferApi.md#eletronicfundstransfer_get_communication_list_v1) | **GET** /1/object/electronicfundstransfer/{pkiElectronicfundstransferID}/getCommunicationList | Retrieve Communication list +*ObjectElectronicfundstransferApi* | [**electronicfundstransfer_get_communication_list_v1**](docs/ObjectElectronicfundstransferApi.md#electronicfundstransfer_get_communication_list_v1) | **GET** /1/object/electronicfundstransfer/{pkiElectronicfundstransferID}/getCommunicationList | Retrieve Communication list *ObjectEmailtypeApi* | [**emailtype_get_autocomplete_v2**](docs/ObjectEmailtypeApi.md#emailtype_get_autocomplete_v2) | **GET** /2/object/emailtype/getAutocomplete/{sSelector} | Retrieve Emailtypes and IDs *ObjectEzmaxinvoicingApi* | [**ezmaxinvoicing_get_autocomplete_v1**](docs/ObjectEzmaxinvoicingApi.md#ezmaxinvoicing_get_autocomplete_v1) | **GET** /1/object/ezmaxinvoicing/getAutocomplete/{sSelector} | Retrieve Ezmaxinvoicings and IDs *ObjectEzmaxinvoicingApi* | [**ezmaxinvoicing_get_autocomplete_v2**](docs/ObjectEzmaxinvoicingApi.md#ezmaxinvoicing_get_autocomplete_v2) | **GET** /2/object/ezmaxinvoicing/getAutocomplete/{sSelector} | Retrieve Ezmaxinvoicings and IDs @@ -165,6 +167,7 @@ Class | Method | HTTP request | Description *ObjectEzsigndocumentApi* | [**ezsigndocument_end_prematurely_v1**](docs/ObjectEzsigndocumentApi.md#ezsigndocument_end_prematurely_v1) | **POST** /1/object/ezsigndocument/{pkiEzsigndocumentID}/endPrematurely | End prematurely *ObjectEzsigndocumentApi* | [**ezsigndocument_flatten_v1**](docs/ObjectEzsigndocumentApi.md#ezsigndocument_flatten_v1) | **POST** /1/object/ezsigndocument/{pkiEzsigndocumentID}/flatten | Flatten *ObjectEzsigndocumentApi* | [**ezsigndocument_get_actionable_elements_v1**](docs/ObjectEzsigndocumentApi.md#ezsigndocument_get_actionable_elements_v1) | **GET** /1/object/ezsigndocument/{pkiEzsigndocumentID}/getActionableElements | Retrieve actionable elements for the Ezsigndocument +*ObjectEzsigndocumentApi* | [**ezsigndocument_get_attachments_v1**](docs/ObjectEzsigndocumentApi.md#ezsigndocument_get_attachments_v1) | **GET** /1/object/ezsigndocument/{pkiEzsigndocumentID}/getAttachments | Retrieve Ezsigndocument's Attachments *ObjectEzsigndocumentApi* | [**ezsigndocument_get_completed_elements_v1**](docs/ObjectEzsigndocumentApi.md#ezsigndocument_get_completed_elements_v1) | **GET** /1/object/ezsigndocument/{pkiEzsigndocumentID}/getCompletedElements | Retrieve completed elements for the Ezsigndocument *ObjectEzsigndocumentApi* | [**ezsigndocument_get_download_url_v1**](docs/ObjectEzsigndocumentApi.md#ezsigndocument_get_download_url_v1) | **GET** /1/object/ezsigndocument/{pkiEzsigndocumentID}/getDownloadUrl/{eDocumentType} | Retrieve a URL to download documents. *ObjectEzsigndocumentApi* | [**ezsigndocument_get_ezsignannotations_v1**](docs/ObjectEzsigndocumentApi.md#ezsigndocument_get_ezsignannotations_v1) | **GET** /1/object/ezsigndocument/{pkiEzsigndocumentID}/getEzsignannotations | Retrieve an existing Ezsigndocument's Ezsignannotations @@ -189,6 +192,8 @@ Class | Method | HTTP request | Description *ObjectEzsignfolderApi* | [**ezsignfolder_dispose_v1**](docs/ObjectEzsignfolderApi.md#ezsignfolder_dispose_v1) | **POST** /1/object/ezsignfolder/{pkiEzsignfolderID}/dispose | Dispose the Ezsignfolder *ObjectEzsignfolderApi* | [**ezsignfolder_edit_object_v1**](docs/ObjectEzsignfolderApi.md#ezsignfolder_edit_object_v1) | **PUT** /1/object/ezsignfolder/{pkiEzsignfolderID} | Edit an existing Ezsignfolder *ObjectEzsignfolderApi* | [**ezsignfolder_get_actionable_elements_v1**](docs/ObjectEzsignfolderApi.md#ezsignfolder_get_actionable_elements_v1) | **GET** /1/object/ezsignfolder/{pkiEzsignfolderID}/getActionableElements | Retrieve actionable elements for the Ezsignfolder +*ObjectEzsignfolderApi* | [**ezsignfolder_get_attachment_count_v1**](docs/ObjectEzsignfolderApi.md#ezsignfolder_get_attachment_count_v1) | **GET** /1/object/ezsignfolder/{pkiEzsignfolderID}/getAttachmentCount | Retrieve Attachment count +*ObjectEzsignfolderApi* | [**ezsignfolder_get_attachments_v1**](docs/ObjectEzsignfolderApi.md#ezsignfolder_get_attachments_v1) | **GET** /1/object/ezsignfolder/{pkiEzsignfolderID}/getAttachments | Retrieve Ezsignfolder's Attachments *ObjectEzsignfolderApi* | [**ezsignfolder_get_communication_count_v1**](docs/ObjectEzsignfolderApi.md#ezsignfolder_get_communication_count_v1) | **GET** /1/object/ezsignfolder/{pkiEzsignfolderID}/getCommunicationCount | Retrieve Communication count *ObjectEzsignfolderApi* | [**ezsignfolder_get_communication_list_v1**](docs/ObjectEzsignfolderApi.md#ezsignfolder_get_communication_list_v1) | **GET** /1/object/ezsignfolder/{pkiEzsignfolderID}/getCommunicationList | Retrieve Communication list *ObjectEzsignfolderApi* | [**ezsignfolder_get_communicationrecipients_v1**](docs/ObjectEzsignfolderApi.md#ezsignfolder_get_communicationrecipients_v1) | **GET** /1/object/ezsignfolder/{pkiEzsignfolderID}/getCommunicationrecipients | Retrieve Ezsignfolder's Communicationrecipient @@ -244,6 +249,11 @@ Class | Method | HTTP request | Description *ObjectEzsignsignergroupmembershipApi* | [**ezsignsignergroupmembership_create_object_v1**](docs/ObjectEzsignsignergroupmembershipApi.md#ezsignsignergroupmembership_create_object_v1) | **POST** /1/object/ezsignsignergroupmembership | Create a new Ezsignsignergroupmembership *ObjectEzsignsignergroupmembershipApi* | [**ezsignsignergroupmembership_delete_object_v1**](docs/ObjectEzsignsignergroupmembershipApi.md#ezsignsignergroupmembership_delete_object_v1) | **DELETE** /1/object/ezsignsignergroupmembership/{pkiEzsignsignergroupmembershipID} | Delete an existing Ezsignsignergroupmembership *ObjectEzsignsignergroupmembershipApi* | [**ezsignsignergroupmembership_get_object_v2**](docs/ObjectEzsignsignergroupmembershipApi.md#ezsignsignergroupmembership_get_object_v2) | **GET** /2/object/ezsignsignergroupmembership/{pkiEzsignsignergroupmembershipID} | Retrieve an existing Ezsignsignergroupmembership +*ObjectEzsignsigningreasonApi* | [**ezsignsigningreason_create_object_v1**](docs/ObjectEzsignsigningreasonApi.md#ezsignsigningreason_create_object_v1) | **POST** /1/object/ezsignsigningreason | Create a new Ezsignsigningreason +*ObjectEzsignsigningreasonApi* | [**ezsignsigningreason_edit_object_v1**](docs/ObjectEzsignsigningreasonApi.md#ezsignsigningreason_edit_object_v1) | **PUT** /1/object/ezsignsigningreason/{pkiEzsignsigningreasonID} | Edit an existing Ezsignsigningreason +*ObjectEzsignsigningreasonApi* | [**ezsignsigningreason_get_autocomplete_v2**](docs/ObjectEzsignsigningreasonApi.md#ezsignsigningreason_get_autocomplete_v2) | **GET** /2/object/ezsignsigningreason/getAutocomplete/{sSelector} | Retrieve Ezsignsigningreasons and IDs +*ObjectEzsignsigningreasonApi* | [**ezsignsigningreason_get_list_v1**](docs/ObjectEzsignsigningreasonApi.md#ezsignsigningreason_get_list_v1) | **GET** /1/object/ezsignsigningreason/getList | Retrieve Ezsignsigningreason list +*ObjectEzsignsigningreasonApi* | [**ezsignsigningreason_get_object_v2**](docs/ObjectEzsignsigningreasonApi.md#ezsignsigningreason_get_object_v2) | **GET** /2/object/ezsignsigningreason/{pkiEzsignsigningreasonID} | Retrieve an existing Ezsignsigningreason *ObjectEzsigntemplateApi* | [**ezsigntemplate_copy_v1**](docs/ObjectEzsigntemplateApi.md#ezsigntemplate_copy_v1) | **POST** /1/object/ezsigntemplate/{pkiEzsigntemplateID}/copy | Copy the Ezsigntemplate *ObjectEzsigntemplateApi* | [**ezsigntemplate_create_object_v1**](docs/ObjectEzsigntemplateApi.md#ezsigntemplate_create_object_v1) | **POST** /1/object/ezsigntemplate | Create a new Ezsigntemplate *ObjectEzsigntemplateApi* | [**ezsigntemplate_delete_object_v1**](docs/ObjectEzsigntemplateApi.md#ezsigntemplate_delete_object_v1) | **DELETE** /1/object/ezsigntemplate/{pkiEzsigntemplateID} | Delete an existing Ezsigntemplate @@ -299,9 +309,12 @@ Class | Method | HTTP request | Description *ObjectFranchiseofficeApi* | [**franchiseoffice_get_autocomplete_v2**](docs/ObjectFranchiseofficeApi.md#franchiseoffice_get_autocomplete_v2) | **GET** /2/object/franchiseoffice/getAutocomplete/{sSelector} | Retrieve Franchiseoffices and IDs *ObjectFranchisereferalincomeApi* | [**franchisereferalincome_create_object_v1**](docs/ObjectFranchisereferalincomeApi.md#franchisereferalincome_create_object_v1) | **POST** /1/object/franchisereferalincome | Create a new Franchisereferalincome *ObjectFranchisereferalincomeApi* | [**franchisereferalincome_create_object_v2**](docs/ObjectFranchisereferalincomeApi.md#franchisereferalincome_create_object_v2) | **POST** /2/object/franchisereferalincome | Create a new Franchisereferalincome +*ObjectInscriptionApi* | [**inscription_get_attachments_v1**](docs/ObjectInscriptionApi.md#inscription_get_attachments_v1) | **GET** /1/object/inscription/{pkiInscriptionID}/getAttachments | Retrieve Inscription's Attachments *ObjectInscriptionApi* | [**inscription_get_communication_list_v1**](docs/ObjectInscriptionApi.md#inscription_get_communication_list_v1) | **GET** /1/object/inscription/{pkiInscriptionID}/getCommunicationList | Retrieve Communication list +*ObjectInscriptionApi* | [**inscription_get_communicationsenders_v1**](docs/ObjectInscriptionApi.md#inscription_get_communicationsenders_v1) | **GET** /1/object/inscription/{pkiInscriptionID}/getCommunicationsenders | Retrieve Inscription's Communicationsender *ObjectInscriptionnotauthenticatedApi* | [**inscriptionnotauthenticated_get_communication_list_v1**](docs/ObjectInscriptionnotauthenticatedApi.md#inscriptionnotauthenticated_get_communication_list_v1) | **GET** /1/object/inscriptionnotauthenticated/{pkiInscriptionnotauthenticatedID}/getCommunicationList | Retrieve Communication list *ObjectInscriptiontempApi* | [**inscriptiontemp_get_communication_list_v1**](docs/ObjectInscriptiontempApi.md#inscriptiontemp_get_communication_list_v1) | **GET** /1/object/inscriptiontemp/{pkiInscriptiontempID}/getCommunicationList | Retrieve Communication list +*ObjectInvoiceApi* | [**invoice_get_attachments_v1**](docs/ObjectInvoiceApi.md#invoice_get_attachments_v1) | **GET** /1/object/invoice/{pkiInvoiceID}/getAttachments | Retrieve Invoice's Attachments *ObjectInvoiceApi* | [**invoice_get_communication_list_v1**](docs/ObjectInvoiceApi.md#invoice_get_communication_list_v1) | **GET** /1/object/invoice/{pkiInvoiceID}/getCommunicationList | Retrieve Communication list *ObjectLanguageApi* | [**language_get_autocomplete_v2**](docs/ObjectLanguageApi.md#language_get_autocomplete_v2) | **GET** /2/object/language/getAutocomplete/{sSelector} | Retrieve Languages and IDs *ObjectModulegroupApi* | [**modulegroup_get_all_v1**](docs/ObjectModulegroupApi.md#modulegroup_get_all_v1) | **GET** /1/object/modulegroup/getAll/{eContext} | Retrieve all Modulegroups @@ -378,11 +391,13 @@ Class | Method | HTTP request | Description *ObjectVariableexpenseApi* | [**variableexpense_get_object_v2**](docs/ObjectVariableexpenseApi.md#variableexpense_get_object_v2) | **GET** /2/object/variableexpense/{pkiVariableexpenseID} | Retrieve an existing Variableexpense *ObjectVersionhistoryApi* | [**versionhistory_get_object_v2**](docs/ObjectVersionhistoryApi.md#versionhistory_get_object_v2) | **GET** /2/object/versionhistory/{pkiVersionhistoryID} | Retrieve an existing Versionhistory *ObjectWebhookApi* | [**webhook_create_object_v1**](docs/ObjectWebhookApi.md#webhook_create_object_v1) | **POST** /1/object/webhook | Create a new Webhook +*ObjectWebhookApi* | [**webhook_create_object_v2**](docs/ObjectWebhookApi.md#webhook_create_object_v2) | **POST** /2/object/webhook | Create a new Webhook *ObjectWebhookApi* | [**webhook_delete_object_v1**](docs/ObjectWebhookApi.md#webhook_delete_object_v1) | **DELETE** /1/object/webhook/{pkiWebhookID} | Delete an existing Webhook *ObjectWebhookApi* | [**webhook_edit_object_v1**](docs/ObjectWebhookApi.md#webhook_edit_object_v1) | **PUT** /1/object/webhook/{pkiWebhookID} | Edit an existing Webhook *ObjectWebhookApi* | [**webhook_get_history_v1**](docs/ObjectWebhookApi.md#webhook_get_history_v1) | **GET** /1/object/webhook/{pkiWebhookID}/getHistory | Retrieve the logs for recent Webhook calls *ObjectWebhookApi* | [**webhook_get_list_v1**](docs/ObjectWebhookApi.md#webhook_get_list_v1) | **GET** /1/object/webhook/getList | Retrieve Webhook list *ObjectWebhookApi* | [**webhook_get_object_v2**](docs/ObjectWebhookApi.md#webhook_get_object_v2) | **GET** /2/object/webhook/{pkiWebhookID} | Retrieve an existing Webhook +*ObjectWebhookApi* | [**webhook_regenerate_apikey_v1**](docs/ObjectWebhookApi.md#webhook_regenerate_apikey_v1) | **POST** /1/object/webhook/{pkiWebhookID}/regenerateApikey | Regenerate the Apikey *ObjectWebhookApi* | [**webhook_test_v1**](docs/ObjectWebhookApi.md#webhook_test_v1) | **POST** /1/object/webhook/{pkiWebhookID}/test | Test the Webhook by calling the Url *ScimGroupsApi* | [**groups_create_object_scim_v2**](docs/ScimGroupsApi.md#groups_create_object_scim_v2) | **POST** /2/scim/Groups | Create a new Usergroup *ScimGroupsApi* | [**groups_delete_object_scim_v2**](docs/ScimGroupsApi.md#groups_delete_object_scim_v2) | **DELETE** /2/scim/Groups/{groupId} | Delete an existing Usergroup @@ -436,7 +451,14 @@ Class | Method | HTTP request | Description - [ApikeyRequestCompound](docs/ApikeyRequestCompound.md) - [ApikeyResponse](docs/ApikeyResponse.md) - [ApikeyResponseCompound](docs/ApikeyResponseCompound.md) - - [AttachmentDownloadV1Response](docs/AttachmentDownloadV1Response.md) + - [AttachmentGetAttachmentlogsV1Response](docs/AttachmentGetAttachmentlogsV1Response.md) + - [AttachmentGetAttachmentlogsV1ResponseMPayload](docs/AttachmentGetAttachmentlogsV1ResponseMPayload.md) + - [AttachmentGetDownloadUrlV1Response](docs/AttachmentGetDownloadUrlV1Response.md) + - [AttachmentGetDownloadUrlV1ResponseMPayload](docs/AttachmentGetDownloadUrlV1ResponseMPayload.md) + - [AttachmentResponse](docs/AttachmentResponse.md) + - [AttachmentResponseCompound](docs/AttachmentResponseCompound.md) + - [AttachmentlogResponse](docs/AttachmentlogResponse.md) + - [AttachmentlogResponseCompound](docs/AttachmentlogResponseCompound.md) - [AttemptResponse](docs/AttemptResponse.md) - [AttemptResponseCompound](docs/AttemptResponseCompound.md) - [BillingentityexternalAutocompleteElementResponse](docs/BillingentityexternalAutocompleteElementResponse.md) @@ -549,6 +571,8 @@ Class | Method | HTTP request | Description - [CorsRequestCompound](docs/CorsRequestCompound.md) - [CorsResponse](docs/CorsResponse.md) - [CorsResponseCompound](docs/CorsResponseCompound.md) + - [CustomAttachmentResponse](docs/CustomAttachmentResponse.md) + - [CustomAttachmentdocumenttypeResponse](docs/CustomAttachmentdocumenttypeResponse.md) - [CustomAutocompleteElementResponse](docs/CustomAutocompleteElementResponse.md) - [CustomCommunicationListElementResponse](docs/CustomCommunicationListElementResponse.md) - [CustomCommunicationattachmentRequest](docs/CustomCommunicationattachmentRequest.md) @@ -722,6 +746,8 @@ Class | Method | HTTP request | Description - [EzsigndocumentFlattenV1Response](docs/EzsigndocumentFlattenV1Response.md) - [EzsigndocumentGetActionableElementsV1Response](docs/EzsigndocumentGetActionableElementsV1Response.md) - [EzsigndocumentGetActionableElementsV1ResponseMPayload](docs/EzsigndocumentGetActionableElementsV1ResponseMPayload.md) + - [EzsigndocumentGetAttachmentsV1Response](docs/EzsigndocumentGetAttachmentsV1Response.md) + - [EzsigndocumentGetAttachmentsV1ResponseMPayload](docs/EzsigndocumentGetAttachmentsV1ResponseMPayload.md) - [EzsigndocumentGetCompletedElementsV1Response](docs/EzsigndocumentGetCompletedElementsV1Response.md) - [EzsigndocumentGetCompletedElementsV1ResponseMPayload](docs/EzsigndocumentGetCompletedElementsV1ResponseMPayload.md) - [EzsigndocumentGetDownloadUrlV1Response](docs/EzsigndocumentGetDownloadUrlV1Response.md) @@ -778,6 +804,10 @@ Class | Method | HTTP request | Description - [EzsignfolderEditObjectV1Response](docs/EzsignfolderEditObjectV1Response.md) - [EzsignfolderGetActionableElementsV1Response](docs/EzsignfolderGetActionableElementsV1Response.md) - [EzsignfolderGetActionableElementsV1ResponseMPayload](docs/EzsignfolderGetActionableElementsV1ResponseMPayload.md) + - [EzsignfolderGetAttachmentCountV1Response](docs/EzsignfolderGetAttachmentCountV1Response.md) + - [EzsignfolderGetAttachmentCountV1ResponseMPayload](docs/EzsignfolderGetAttachmentCountV1ResponseMPayload.md) + - [EzsignfolderGetAttachmentsV1Response](docs/EzsignfolderGetAttachmentsV1Response.md) + - [EzsignfolderGetAttachmentsV1ResponseMPayload](docs/EzsignfolderGetAttachmentsV1ResponseMPayload.md) - [EzsignfolderGetCommunicationCountV1Response](docs/EzsignfolderGetCommunicationCountV1Response.md) - [EzsignfolderGetCommunicationCountV1ResponseMPayload](docs/EzsignfolderGetCommunicationCountV1ResponseMPayload.md) - [EzsignfolderGetCommunicationListV1Response](docs/EzsignfolderGetCommunicationListV1Response.md) @@ -943,6 +973,23 @@ Class | Method | HTTP request | Description - [EzsignsignergroupmembershipRequestCompound](docs/EzsignsignergroupmembershipRequestCompound.md) - [EzsignsignergroupmembershipResponse](docs/EzsignsignergroupmembershipResponse.md) - [EzsignsignergroupmembershipResponseCompound](docs/EzsignsignergroupmembershipResponseCompound.md) + - [EzsignsigningreasonAutocompleteElementResponse](docs/EzsignsigningreasonAutocompleteElementResponse.md) + - [EzsignsigningreasonCreateObjectV1Request](docs/EzsignsigningreasonCreateObjectV1Request.md) + - [EzsignsigningreasonCreateObjectV1Response](docs/EzsignsigningreasonCreateObjectV1Response.md) + - [EzsignsigningreasonCreateObjectV1ResponseMPayload](docs/EzsignsigningreasonCreateObjectV1ResponseMPayload.md) + - [EzsignsigningreasonEditObjectV1Request](docs/EzsignsigningreasonEditObjectV1Request.md) + - [EzsignsigningreasonEditObjectV1Response](docs/EzsignsigningreasonEditObjectV1Response.md) + - [EzsignsigningreasonGetAutocompleteV2Response](docs/EzsignsigningreasonGetAutocompleteV2Response.md) + - [EzsignsigningreasonGetAutocompleteV2ResponseMPayload](docs/EzsignsigningreasonGetAutocompleteV2ResponseMPayload.md) + - [EzsignsigningreasonGetListV1Response](docs/EzsignsigningreasonGetListV1Response.md) + - [EzsignsigningreasonGetListV1ResponseMPayload](docs/EzsignsigningreasonGetListV1ResponseMPayload.md) + - [EzsignsigningreasonGetObjectV2Response](docs/EzsignsigningreasonGetObjectV2Response.md) + - [EzsignsigningreasonGetObjectV2ResponseMPayload](docs/EzsignsigningreasonGetObjectV2ResponseMPayload.md) + - [EzsignsigningreasonListElement](docs/EzsignsigningreasonListElement.md) + - [EzsignsigningreasonRequest](docs/EzsignsigningreasonRequest.md) + - [EzsignsigningreasonRequestCompound](docs/EzsignsigningreasonRequestCompound.md) + - [EzsignsigningreasonResponse](docs/EzsignsigningreasonResponse.md) + - [EzsignsigningreasonResponseCompound](docs/EzsignsigningreasonResponseCompound.md) - [EzsigntemplateAutocompleteElementResponse](docs/EzsigntemplateAutocompleteElementResponse.md) - [EzsigntemplateCopyV1Request](docs/EzsigntemplateCopyV1Request.md) - [EzsigntemplateCopyV1Response](docs/EzsigntemplateCopyV1Response.md) @@ -1110,6 +1157,11 @@ Class | Method | HTTP request | Description - [FieldEActivesessionOrigin](docs/FieldEActivesessionOrigin.md) - [FieldEActivesessionUsertype](docs/FieldEActivesessionUsertype.md) - [FieldEActivesessionWeekdaystart](docs/FieldEActivesessionWeekdaystart.md) + - [FieldEAttachmentDocumenttype](docs/FieldEAttachmentDocumenttype.md) + - [FieldEAttachmentPrivacy](docs/FieldEAttachmentPrivacy.md) + - [FieldEAttachmentType](docs/FieldEAttachmentType.md) + - [FieldEAttachmentVerified](docs/FieldEAttachmentVerified.md) + - [FieldEAttachmentlogType](docs/FieldEAttachmentlogType.md) - [FieldEBrandingLogo](docs/FieldEBrandingLogo.md) - [FieldECommunicationImportance](docs/FieldECommunicationImportance.md) - [FieldECommunicationType](docs/FieldECommunicationType.md) @@ -1161,6 +1213,7 @@ Class | Method | HTTP request | Description - [FieldESystemconfigurationLanguage2](docs/FieldESystemconfigurationLanguage2.md) - [FieldESystemconfigurationNewexternaluseraction](docs/FieldESystemconfigurationNewexternaluseraction.md) - [FieldEUserEzsignaccess](docs/FieldEUserEzsignaccess.md) + - [FieldEUserEzsignprepaid](docs/FieldEUserEzsignprepaid.md) - [FieldEUserEzsignsendreminderfrequency](docs/FieldEUserEzsignsendreminderfrequency.md) - [FieldEUserLogintype](docs/FieldEUserLogintype.md) - [FieldEUserOrigin](docs/FieldEUserOrigin.md) @@ -1193,12 +1246,18 @@ Class | Method | HTTP request | Description - [GlobalEzmaxclientVersionV1Response](docs/GlobalEzmaxclientVersionV1Response.md) - [GlobalEzmaxcustomerGetConfigurationV1Response](docs/GlobalEzmaxcustomerGetConfigurationV1Response.md) - [HeaderAcceptLanguage](docs/HeaderAcceptLanguage.md) + - [InscriptionGetAttachmentsV1Response](docs/InscriptionGetAttachmentsV1Response.md) + - [InscriptionGetAttachmentsV1ResponseMPayload](docs/InscriptionGetAttachmentsV1ResponseMPayload.md) - [InscriptionGetCommunicationListV1Response](docs/InscriptionGetCommunicationListV1Response.md) - [InscriptionGetCommunicationListV1ResponseMPayload](docs/InscriptionGetCommunicationListV1ResponseMPayload.md) + - [InscriptionGetCommunicationsendersV1Response](docs/InscriptionGetCommunicationsendersV1Response.md) + - [InscriptionGetCommunicationsendersV1ResponseMPayload](docs/InscriptionGetCommunicationsendersV1ResponseMPayload.md) - [InscriptionnotauthenticatedGetCommunicationListV1Response](docs/InscriptionnotauthenticatedGetCommunicationListV1Response.md) - [InscriptionnotauthenticatedGetCommunicationListV1ResponseMPayload](docs/InscriptionnotauthenticatedGetCommunicationListV1ResponseMPayload.md) - [InscriptiontempGetCommunicationListV1Response](docs/InscriptiontempGetCommunicationListV1Response.md) - [InscriptiontempGetCommunicationListV1ResponseMPayload](docs/InscriptiontempGetCommunicationListV1ResponseMPayload.md) + - [InvoiceGetAttachmentsV1Response](docs/InvoiceGetAttachmentsV1Response.md) + - [InvoiceGetAttachmentsV1ResponseMPayload](docs/InvoiceGetAttachmentsV1ResponseMPayload.md) - [InvoiceGetCommunicationListV1Response](docs/InvoiceGetCommunicationListV1Response.md) - [InvoiceGetCommunicationListV1ResponseMPayload](docs/InvoiceGetCommunicationListV1ResponseMPayload.md) - [LanguageAutocompleteElementResponse](docs/LanguageAutocompleteElementResponse.md) @@ -1218,6 +1277,7 @@ Class | Method | HTTP request | Description - [MultilingualEzmaxinvoicingsummaryinternalDescription](docs/MultilingualEzmaxinvoicingsummaryinternalDescription.md) - [MultilingualEzsignfoldertypeName](docs/MultilingualEzsignfoldertypeName.md) - [MultilingualEzsignsignergroupDescription](docs/MultilingualEzsignsignergroupDescription.md) + - [MultilingualEzsignsigningreasonDescription](docs/MultilingualEzsignsigningreasonDescription.md) - [MultilingualNotificationsubsectionName](docs/MultilingualNotificationsubsectionName.md) - [MultilingualNotificationtestName](docs/MultilingualNotificationtestName.md) - [MultilingualPaymenttermDescription](docs/MultilingualPaymenttermDescription.md) @@ -1460,6 +1520,9 @@ Class | Method | HTTP request | Description - [WebhookCreateObjectV1Request](docs/WebhookCreateObjectV1Request.md) - [WebhookCreateObjectV1Response](docs/WebhookCreateObjectV1Response.md) - [WebhookCreateObjectV1ResponseMPayload](docs/WebhookCreateObjectV1ResponseMPayload.md) + - [WebhookCreateObjectV2Request](docs/WebhookCreateObjectV2Request.md) + - [WebhookCreateObjectV2Response](docs/WebhookCreateObjectV2Response.md) + - [WebhookCreateObjectV2ResponseMPayload](docs/WebhookCreateObjectV2ResponseMPayload.md) - [WebhookDeleteObjectV1Response](docs/WebhookDeleteObjectV1Response.md) - [WebhookEditObjectV1Request](docs/WebhookEditObjectV1Request.md) - [WebhookEditObjectV1Response](docs/WebhookEditObjectV1Response.md) @@ -1474,6 +1537,9 @@ Class | Method | HTTP request | Description - [WebhookGetObjectV2Response](docs/WebhookGetObjectV2Response.md) - [WebhookGetObjectV2ResponseMPayload](docs/WebhookGetObjectV2ResponseMPayload.md) - [WebhookListElement](docs/WebhookListElement.md) + - [WebhookRegenerateApikeyV1Request](docs/WebhookRegenerateApikeyV1Request.md) + - [WebhookRegenerateApikeyV1Response](docs/WebhookRegenerateApikeyV1Response.md) + - [WebhookRegenerateApikeyV1ResponseMPayload](docs/WebhookRegenerateApikeyV1ResponseMPayload.md) - [WebhookRequest](docs/WebhookRequest.md) - [WebhookRequestCompound](docs/WebhookRequestCompound.md) - [WebhookResponse](docs/WebhookResponse.md) diff --git a/docs/ActivesessionGetCurrentV1Response.md b/docs/ActivesessionGetCurrentV1Response.md index db1a6d058..06b1fd9c0 100644 --- a/docs/ActivesessionGetCurrentV1Response.md +++ b/docs/ActivesessionGetCurrentV1Response.md @@ -3,6 +3,7 @@ Response for GET /1/object/activesession/getCurrent ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/ActivesessionGetCurrentV1ResponseMPayload.md b/docs/ActivesessionGetCurrentV1ResponseMPayload.md index ef2feae07..181145dda 100644 --- a/docs/ActivesessionGetCurrentV1ResponseMPayload.md +++ b/docs/ActivesessionGetCurrentV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for GET /1/object/activesession/getCurrent ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **e_activesession_usertype** | [**FieldEActivesessionUsertype**](FieldEActivesessionUsertype.md) | | @@ -16,6 +17,9 @@ Name | Type | Description | Notes **pks_customer_code** | **str** | The customer code assigned to your account | **fki_systemconfigurationtype_id** | **int** | The unique ID of the Systemconfigurationtype | **fki_signature_id** | **int** | The unique ID of the Signature | [optional] +**e_user_ezsignaccess** | [**FieldEUserEzsignaccess**](FieldEUserEzsignaccess.md) | | +**e_user_ezsignprepaid** | [**FieldEUserEzsignprepaid**](FieldEUserEzsignprepaid.md) | | [optional] +**dt_user_ezsignprepaidexpiration** | **str** | The eZsign prepaid expiration date | [optional] **a_pki_permission_id** | **List[int]** | An array of permissions granted to the user or api key | **obj_user_real** | [**ActivesessionResponseCompoundUser**](ActivesessionResponseCompoundUser.md) | | **obj_user_cloned** | [**ActivesessionResponseCompoundUser**](ActivesessionResponseCompoundUser.md) | | [optional] diff --git a/docs/ActivesessionGetListV1Response.md b/docs/ActivesessionGetListV1Response.md index e85d08ad7..660d0ae80 100644 --- a/docs/ActivesessionGetListV1Response.md +++ b/docs/ActivesessionGetListV1Response.md @@ -3,6 +3,7 @@ Response for GET /1/object/activesession/getList ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayloadGetList**](CommonResponseObjDebugPayloadGetList.md) | | diff --git a/docs/ActivesessionGetListV1ResponseMPayload.md b/docs/ActivesessionGetListV1ResponseMPayload.md index 30719eb06..f4fd234a6 100644 --- a/docs/ActivesessionGetListV1ResponseMPayload.md +++ b/docs/ActivesessionGetListV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for GET /1/object/activesession/getList ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **i_row_returned** | **int** | The number of rows returned | diff --git a/docs/ActivesessionListElement.md b/docs/ActivesessionListElement.md index 88f882203..e5b748bb4 100644 --- a/docs/ActivesessionListElement.md +++ b/docs/ActivesessionListElement.md @@ -3,6 +3,7 @@ A Activesession List Element ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_activesession_id** | **int** | The unique ID of the Activesession | diff --git a/docs/ActivesessionResponse.md b/docs/ActivesessionResponse.md index c9c516f15..a9ab2c9f9 100644 --- a/docs/ActivesessionResponse.md +++ b/docs/ActivesessionResponse.md @@ -3,6 +3,7 @@ An Activesession Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **e_activesession_usertype** | [**FieldEActivesessionUsertype**](FieldEActivesessionUsertype.md) | | diff --git a/docs/ActivesessionResponseCompound.md b/docs/ActivesessionResponseCompound.md index 73fb6e1c0..1360e5daf 100644 --- a/docs/ActivesessionResponseCompound.md +++ b/docs/ActivesessionResponseCompound.md @@ -3,6 +3,7 @@ Payload for GET /1/object/activesession/getCurrent ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **e_activesession_usertype** | [**FieldEActivesessionUsertype**](FieldEActivesessionUsertype.md) | | @@ -16,6 +17,9 @@ Name | Type | Description | Notes **pks_customer_code** | **str** | The customer code assigned to your account | **fki_systemconfigurationtype_id** | **int** | The unique ID of the Systemconfigurationtype | **fki_signature_id** | **int** | The unique ID of the Signature | [optional] +**e_user_ezsignaccess** | [**FieldEUserEzsignaccess**](FieldEUserEzsignaccess.md) | | +**e_user_ezsignprepaid** | [**FieldEUserEzsignprepaid**](FieldEUserEzsignprepaid.md) | | [optional] +**dt_user_ezsignprepaidexpiration** | **str** | The eZsign prepaid expiration date | [optional] **a_pki_permission_id** | **List[int]** | An array of permissions granted to the user or api key | **obj_user_real** | [**ActivesessionResponseCompoundUser**](ActivesessionResponseCompoundUser.md) | | **obj_user_cloned** | [**ActivesessionResponseCompoundUser**](ActivesessionResponseCompoundUser.md) | | [optional] diff --git a/docs/ActivesessionResponseCompoundApikey.md b/docs/ActivesessionResponseCompoundApikey.md index 1c4c54ad0..c6e330a5c 100644 --- a/docs/ActivesessionResponseCompoundApikey.md +++ b/docs/ActivesessionResponseCompoundApikey.md @@ -3,6 +3,7 @@ An Activesession->Apikey object and children to create a complete structure ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_apikey_id** | **int** | The unique ID of the Apikey | diff --git a/docs/ActivesessionResponseCompoundUser.md b/docs/ActivesessionResponseCompoundUser.md index 1d9fbe48c..e67af58df 100644 --- a/docs/ActivesessionResponseCompoundUser.md +++ b/docs/ActivesessionResponseCompoundUser.md @@ -3,6 +3,7 @@ An Activesession->User Object and children to create a complete structure ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_user_id** | **int** | The unique ID of the User | diff --git a/docs/AddressRequest.md b/docs/AddressRequest.md index 44ea0b9ec..5b3847c9d 100644 --- a/docs/AddressRequest.md +++ b/docs/AddressRequest.md @@ -3,6 +3,7 @@ An Address Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **fki_addresstype_id** | **int** | The unique ID of the Addresstype. Valid values: |Value|Description| |-|-| |1|Office| |2|Home| |3|Real Estate Invoice| |4|Invoicing| |5|Shipping| | diff --git a/docs/AddressRequestCompound.md b/docs/AddressRequestCompound.md index 7c5376c4d..94415993d 100644 --- a/docs/AddressRequestCompound.md +++ b/docs/AddressRequestCompound.md @@ -3,6 +3,7 @@ An Address Object and children to create a complete structure ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **fki_addresstype_id** | **int** | The unique ID of the Addresstype. Valid values: |Value|Description| |-|-| |1|Office| |2|Home| |3|Real Estate Invoice| |4|Invoicing| |5|Shipping| | diff --git a/docs/ApikeyCreateObjectV2Request.md b/docs/ApikeyCreateObjectV2Request.md index a1df5e0ab..5b8380345 100644 --- a/docs/ApikeyCreateObjectV2Request.md +++ b/docs/ApikeyCreateObjectV2Request.md @@ -3,6 +3,7 @@ Request for POST /2/object/apikey ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_apikey** | [**List[ApikeyRequestCompound]**](ApikeyRequestCompound.md) | | diff --git a/docs/ApikeyCreateObjectV2Response.md b/docs/ApikeyCreateObjectV2Response.md index 036431346..f20785f94 100644 --- a/docs/ApikeyCreateObjectV2Response.md +++ b/docs/ApikeyCreateObjectV2Response.md @@ -3,6 +3,7 @@ Response for POST /2/object/apikey ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/ApikeyCreateObjectV2ResponseMPayload.md b/docs/ApikeyCreateObjectV2ResponseMPayload.md index 74bb1b187..5491db74e 100644 --- a/docs/ApikeyCreateObjectV2ResponseMPayload.md +++ b/docs/ApikeyCreateObjectV2ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for POST /2/object/apikey ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_apikey** | [**List[ApikeyResponseCompound]**](ApikeyResponseCompound.md) | | diff --git a/docs/ApikeyEditObjectV1Request.md b/docs/ApikeyEditObjectV1Request.md index 7f0250308..bcac66741 100644 --- a/docs/ApikeyEditObjectV1Request.md +++ b/docs/ApikeyEditObjectV1Request.md @@ -3,6 +3,7 @@ Request for PUT /1/object/apikey/{pkiApikeyID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_apikey** | [**ApikeyRequestCompound**](ApikeyRequestCompound.md) | | diff --git a/docs/ApikeyEditObjectV1Response.md b/docs/ApikeyEditObjectV1Response.md index 511adbaa7..097969f51 100644 --- a/docs/ApikeyEditObjectV1Response.md +++ b/docs/ApikeyEditObjectV1Response.md @@ -3,6 +3,7 @@ Response for PUT /1/object/apikey/{pkiApikeyID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/ApikeyEditPermissionsV1Request.md b/docs/ApikeyEditPermissionsV1Request.md index d14c6953f..97473814d 100644 --- a/docs/ApikeyEditPermissionsV1Request.md +++ b/docs/ApikeyEditPermissionsV1Request.md @@ -3,6 +3,7 @@ Request for PUT /1/object/apikey/{pkiApikeyID}/editPermissions ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_permission** | [**List[PermissionRequestCompound]**](PermissionRequestCompound.md) | | diff --git a/docs/ApikeyEditPermissionsV1Response.md b/docs/ApikeyEditPermissionsV1Response.md index b8ec888ef..6d8818d37 100644 --- a/docs/ApikeyEditPermissionsV1Response.md +++ b/docs/ApikeyEditPermissionsV1Response.md @@ -3,6 +3,7 @@ Response for PUT /1/object/apikey/{pkiApikeyID}/editPermissions ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/ApikeyEditPermissionsV1ResponseMPayload.md b/docs/ApikeyEditPermissionsV1ResponseMPayload.md index e4a5c8600..ab71f48f3 100644 --- a/docs/ApikeyEditPermissionsV1ResponseMPayload.md +++ b/docs/ApikeyEditPermissionsV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for PUT /1/object/apikey/{pkiApikeyID}/editPermissions ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_pki_permission_id** | **List[int]** | | diff --git a/docs/ApikeyGetCorsV1Response.md b/docs/ApikeyGetCorsV1Response.md index 81c77350a..222b31eca 100644 --- a/docs/ApikeyGetCorsV1Response.md +++ b/docs/ApikeyGetCorsV1Response.md @@ -3,6 +3,7 @@ Response for GET /1/object/apikey/{pkiApikeyID}/getCors ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/ApikeyGetCorsV1ResponseMPayload.md b/docs/ApikeyGetCorsV1ResponseMPayload.md index 02d46e985..6cdc89663 100644 --- a/docs/ApikeyGetCorsV1ResponseMPayload.md +++ b/docs/ApikeyGetCorsV1ResponseMPayload.md @@ -3,6 +3,7 @@ Response for GET /1/object/apikey/{pkiApikeyID}/getCors ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_cors** | [**List[CorsResponseCompound]**](CorsResponseCompound.md) | | diff --git a/docs/ApikeyGetListV1Response.md b/docs/ApikeyGetListV1Response.md index f3355259d..f30dfe243 100644 --- a/docs/ApikeyGetListV1Response.md +++ b/docs/ApikeyGetListV1Response.md @@ -3,6 +3,7 @@ Response for GET /1/object/apikey/getList ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayloadGetList**](CommonResponseObjDebugPayloadGetList.md) | | diff --git a/docs/ApikeyGetListV1ResponseMPayload.md b/docs/ApikeyGetListV1ResponseMPayload.md index cd3c3cdab..6176ce573 100644 --- a/docs/ApikeyGetListV1ResponseMPayload.md +++ b/docs/ApikeyGetListV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for GET /1/object/apikey/getList ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **i_row_returned** | **int** | The number of rows returned | diff --git a/docs/ApikeyGetObjectV2Response.md b/docs/ApikeyGetObjectV2Response.md index 905d52c84..9332777c6 100644 --- a/docs/ApikeyGetObjectV2Response.md +++ b/docs/ApikeyGetObjectV2Response.md @@ -3,6 +3,7 @@ Response for GET /2/object/apikey/{pkiApikeyID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/ApikeyGetObjectV2ResponseMPayload.md b/docs/ApikeyGetObjectV2ResponseMPayload.md index 313cd3f40..898b8b88e 100644 --- a/docs/ApikeyGetObjectV2ResponseMPayload.md +++ b/docs/ApikeyGetObjectV2ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for GET /2/object/apikey/{pkiApikeyID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_apikey** | [**ApikeyResponseCompound**](ApikeyResponseCompound.md) | | diff --git a/docs/ApikeyGetPermissionsV1Response.md b/docs/ApikeyGetPermissionsV1Response.md index 63c7eddb7..0505e0381 100644 --- a/docs/ApikeyGetPermissionsV1Response.md +++ b/docs/ApikeyGetPermissionsV1Response.md @@ -3,6 +3,7 @@ Response for GET /1/object/apikey/{pkiApikeyID}/getPermissions ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/ApikeyGetPermissionsV1ResponseMPayload.md b/docs/ApikeyGetPermissionsV1ResponseMPayload.md index 28e9be8b8..33eb60a8d 100644 --- a/docs/ApikeyGetPermissionsV1ResponseMPayload.md +++ b/docs/ApikeyGetPermissionsV1ResponseMPayload.md @@ -3,6 +3,7 @@ Response for GET /1/object/apikey/{pkiApikeyID}/getPermissions ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_modulegroup** | [**List[ModulegroupResponseCompound]**](ModulegroupResponseCompound.md) | | diff --git a/docs/ApikeyGetSubnetsV1Response.md b/docs/ApikeyGetSubnetsV1Response.md index 86649f7e1..e0256e455 100644 --- a/docs/ApikeyGetSubnetsV1Response.md +++ b/docs/ApikeyGetSubnetsV1Response.md @@ -3,6 +3,7 @@ Response for GET /1/object/apikey/{pkiApikeyID}/getSubnets ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/ApikeyGetSubnetsV1ResponseMPayload.md b/docs/ApikeyGetSubnetsV1ResponseMPayload.md index 0992f5018..a13e42fae 100644 --- a/docs/ApikeyGetSubnetsV1ResponseMPayload.md +++ b/docs/ApikeyGetSubnetsV1ResponseMPayload.md @@ -3,6 +3,7 @@ Response for GET /1/object/apikey/{pkiApikeyID}/getSubnets ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_subnet** | [**List[SubnetResponseCompound]**](SubnetResponseCompound.md) | | diff --git a/docs/ApikeyListElement.md b/docs/ApikeyListElement.md index 2c4089ae7..d39fd287c 100644 --- a/docs/ApikeyListElement.md +++ b/docs/ApikeyListElement.md @@ -3,6 +3,7 @@ A Branding List Element ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_apikey_id** | **int** | The unique ID of the Apikey | diff --git a/docs/ApikeyRegenerateV1Request.md b/docs/ApikeyRegenerateV1Request.md index 5e2d65409..3332c8662 100644 --- a/docs/ApikeyRegenerateV1Request.md +++ b/docs/ApikeyRegenerateV1Request.md @@ -3,6 +3,7 @@ Request for POST /1/object/apikey/{pkiApikeyID}/regenerate ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **b_apikey_issigned** | **bool** | Whether the apikey is signed or not | [optional] diff --git a/docs/ApikeyRegenerateV1Response.md b/docs/ApikeyRegenerateV1Response.md index eb5249955..dc6a40583 100644 --- a/docs/ApikeyRegenerateV1Response.md +++ b/docs/ApikeyRegenerateV1Response.md @@ -3,6 +3,7 @@ Response for GET /1/object/apikey/{pkiApikeyID}/regenerate ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/ApikeyRegenerateV1ResponseMPayload.md b/docs/ApikeyRegenerateV1ResponseMPayload.md index cd718ff3f..e1261c6fb 100644 --- a/docs/ApikeyRegenerateV1ResponseMPayload.md +++ b/docs/ApikeyRegenerateV1ResponseMPayload.md @@ -3,6 +3,7 @@ Response for GET /1/object/apikey/{pkiApikeyID}/regenerate ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_apikey** | [**ApikeyResponseCompound**](ApikeyResponseCompound.md) | | diff --git a/docs/ApikeyRequest.md b/docs/ApikeyRequest.md index 104989dfa..df584a338 100644 --- a/docs/ApikeyRequest.md +++ b/docs/ApikeyRequest.md @@ -3,6 +3,7 @@ An Apikey Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_apikey_id** | **int** | The unique ID of the Apikey | [optional] diff --git a/docs/ApikeyRequestCompound.md b/docs/ApikeyRequestCompound.md index c8f77fae6..c26b384be 100644 --- a/docs/ApikeyRequestCompound.md +++ b/docs/ApikeyRequestCompound.md @@ -3,6 +3,7 @@ An Apikey Object and children to create a complete structure ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_apikey_id** | **int** | The unique ID of the Apikey | [optional] diff --git a/docs/ApikeyResponse.md b/docs/ApikeyResponse.md index bcc3964e8..5a7b44da5 100644 --- a/docs/ApikeyResponse.md +++ b/docs/ApikeyResponse.md @@ -3,6 +3,7 @@ An Apikey Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_apikey_id** | **int** | The unique ID of the Apikey | diff --git a/docs/ApikeyResponseCompound.md b/docs/ApikeyResponseCompound.md index 3f5c115e8..737b1209c 100644 --- a/docs/ApikeyResponseCompound.md +++ b/docs/ApikeyResponseCompound.md @@ -3,6 +3,7 @@ An Apikey Object and children to create a complete structure ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_apikey_id** | **int** | The unique ID of the Apikey | diff --git a/docs/AttachmentDownloadV1Response.md b/docs/AttachmentDownloadV1Response.md deleted file mode 100644 index e6e97a019..000000000 --- a/docs/AttachmentDownloadV1Response.md +++ /dev/null @@ -1,30 +0,0 @@ -# AttachmentDownloadV1Response - -Response for POST /1/object/ezsignfolder/{pkiEzsignfolderID}/send - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | -**obj_debug** | [**CommonResponseObjDebug**](CommonResponseObjDebug.md) | | [optional] - -## Example - -```python -from eZmaxApi.models.attachment_download_v1_response import AttachmentDownloadV1Response - -# TODO update the JSON string below -json = "{}" -# create an instance of AttachmentDownloadV1Response from a JSON string -attachment_download_v1_response_instance = AttachmentDownloadV1Response.from_json(json) -# print the JSON string representation of the object -print AttachmentDownloadV1Response.to_json() - -# convert the object into a dict -attachment_download_v1_response_dict = attachment_download_v1_response_instance.to_dict() -# create an instance of AttachmentDownloadV1Response from a dict -attachment_download_v1_response_form_dict = attachment_download_v1_response.from_dict(attachment_download_v1_response_dict) -``` -[[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/docs/AttachmentGetAttachmentlogsV1Response.md b/docs/AttachmentGetAttachmentlogsV1Response.md new file mode 100644 index 000000000..5e15284d1 --- /dev/null +++ b/docs/AttachmentGetAttachmentlogsV1Response.md @@ -0,0 +1,32 @@ +# AttachmentGetAttachmentlogsV1Response + +Response for GET /1/object/attachment/{pkiAttachmentID}/getAttachmentlogs + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | +**obj_debug** | [**CommonResponseObjDebug**](CommonResponseObjDebug.md) | | [optional] +**m_payload** | [**AttachmentGetAttachmentlogsV1ResponseMPayload**](AttachmentGetAttachmentlogsV1ResponseMPayload.md) | | + +## Example + +```python +from eZmaxApi.models.attachment_get_attachmentlogs_v1_response import AttachmentGetAttachmentlogsV1Response + +# TODO update the JSON string below +json = "{}" +# create an instance of AttachmentGetAttachmentlogsV1Response from a JSON string +attachment_get_attachmentlogs_v1_response_instance = AttachmentGetAttachmentlogsV1Response.from_json(json) +# print the JSON string representation of the object +print AttachmentGetAttachmentlogsV1Response.to_json() + +# convert the object into a dict +attachment_get_attachmentlogs_v1_response_dict = attachment_get_attachmentlogs_v1_response_instance.to_dict() +# create an instance of AttachmentGetAttachmentlogsV1Response from a dict +attachment_get_attachmentlogs_v1_response_form_dict = attachment_get_attachmentlogs_v1_response.from_dict(attachment_get_attachmentlogs_v1_response_dict) +``` +[[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/docs/AttachmentGetAttachmentlogsV1ResponseMPayload.md b/docs/AttachmentGetAttachmentlogsV1ResponseMPayload.md new file mode 100644 index 000000000..16a82885f --- /dev/null +++ b/docs/AttachmentGetAttachmentlogsV1ResponseMPayload.md @@ -0,0 +1,30 @@ +# AttachmentGetAttachmentlogsV1ResponseMPayload + +Response for GET /1/object/attachment/{pkiAttachmentID}/getAttachmentlogs + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**a_obj_attachmentlog** | [**List[AttachmentlogResponseCompound]**](AttachmentlogResponseCompound.md) | | + +## Example + +```python +from eZmaxApi.models.attachment_get_attachmentlogs_v1_response_m_payload import AttachmentGetAttachmentlogsV1ResponseMPayload + +# TODO update the JSON string below +json = "{}" +# create an instance of AttachmentGetAttachmentlogsV1ResponseMPayload from a JSON string +attachment_get_attachmentlogs_v1_response_m_payload_instance = AttachmentGetAttachmentlogsV1ResponseMPayload.from_json(json) +# print the JSON string representation of the object +print AttachmentGetAttachmentlogsV1ResponseMPayload.to_json() + +# convert the object into a dict +attachment_get_attachmentlogs_v1_response_m_payload_dict = attachment_get_attachmentlogs_v1_response_m_payload_instance.to_dict() +# create an instance of AttachmentGetAttachmentlogsV1ResponseMPayload from a dict +attachment_get_attachmentlogs_v1_response_m_payload_form_dict = attachment_get_attachmentlogs_v1_response_m_payload.from_dict(attachment_get_attachmentlogs_v1_response_m_payload_dict) +``` +[[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/docs/AttachmentGetDownloadUrlV1Response.md b/docs/AttachmentGetDownloadUrlV1Response.md new file mode 100644 index 000000000..58ff28037 --- /dev/null +++ b/docs/AttachmentGetDownloadUrlV1Response.md @@ -0,0 +1,32 @@ +# AttachmentGetDownloadUrlV1Response + +Response for GET /1/object/attachment/{pkiAttachmentID}/getDownloadUrl + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | +**obj_debug** | [**CommonResponseObjDebug**](CommonResponseObjDebug.md) | | [optional] +**m_payload** | [**AttachmentGetDownloadUrlV1ResponseMPayload**](AttachmentGetDownloadUrlV1ResponseMPayload.md) | | + +## Example + +```python +from eZmaxApi.models.attachment_get_download_url_v1_response import AttachmentGetDownloadUrlV1Response + +# TODO update the JSON string below +json = "{}" +# create an instance of AttachmentGetDownloadUrlV1Response from a JSON string +attachment_get_download_url_v1_response_instance = AttachmentGetDownloadUrlV1Response.from_json(json) +# print the JSON string representation of the object +print AttachmentGetDownloadUrlV1Response.to_json() + +# convert the object into a dict +attachment_get_download_url_v1_response_dict = attachment_get_download_url_v1_response_instance.to_dict() +# create an instance of AttachmentGetDownloadUrlV1Response from a dict +attachment_get_download_url_v1_response_form_dict = attachment_get_download_url_v1_response.from_dict(attachment_get_download_url_v1_response_dict) +``` +[[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/docs/AttachmentGetDownloadUrlV1ResponseMPayload.md b/docs/AttachmentGetDownloadUrlV1ResponseMPayload.md new file mode 100644 index 000000000..c39860074 --- /dev/null +++ b/docs/AttachmentGetDownloadUrlV1ResponseMPayload.md @@ -0,0 +1,30 @@ +# AttachmentGetDownloadUrlV1ResponseMPayload + +Payload for GET /1/object/attachment/{pkiAttachmentID}/getDownloadUrl + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**s_download_url** | **str** | The Url to the requested attachment. Url will expire after 5 minutes. | + +## Example + +```python +from eZmaxApi.models.attachment_get_download_url_v1_response_m_payload import AttachmentGetDownloadUrlV1ResponseMPayload + +# TODO update the JSON string below +json = "{}" +# create an instance of AttachmentGetDownloadUrlV1ResponseMPayload from a JSON string +attachment_get_download_url_v1_response_m_payload_instance = AttachmentGetDownloadUrlV1ResponseMPayload.from_json(json) +# print the JSON string representation of the object +print AttachmentGetDownloadUrlV1ResponseMPayload.to_json() + +# convert the object into a dict +attachment_get_download_url_v1_response_m_payload_dict = attachment_get_download_url_v1_response_m_payload_instance.to_dict() +# create an instance of AttachmentGetDownloadUrlV1ResponseMPayload from a dict +attachment_get_download_url_v1_response_m_payload_form_dict = attachment_get_download_url_v1_response_m_payload.from_dict(attachment_get_download_url_v1_response_m_payload_dict) +``` +[[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/docs/AttachmentResponse.md b/docs/AttachmentResponse.md new file mode 100644 index 000000000..c3a926352 --- /dev/null +++ b/docs/AttachmentResponse.md @@ -0,0 +1,90 @@ +# AttachmentResponse + +An Attachment Object + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pki_attachment_id** | **int** | The unique ID of the Attachment. | +**fki_computer_id** | **int** | The unique ID of the Computer | [optional] +**fki_adjustment_id** | **int** | The unique ID of the Adjustment | [optional] +**fki_agent_id** | **int** | The unique ID of the Agent. | [optional] +**fki_bankaccount_id** | **int** | The unique ID of the Bankaccount | [optional] +**fki_broker_id** | **int** | The unique ID of the Broker. | [optional] +**fki_commissionadvance_id** | **int** | The unique ID of the Commissionadvance | [optional] +**fki_communication_id** | **int** | The unique ID of the Communication. | [optional] +**fki_customer_id** | **int** | The unique ID of the Customer. | [optional] +**fki_customertemplate_id** | **int** | The unique ID of the Customertemplate | [optional] +**fki_deposit_id** | **int** | The unique ID of the Deposit | [optional] +**fki_deposittransitcheque_id** | **int** | The unique ID of the Deposittransitcheque | [optional] +**fki_electronicfundstransfer_id** | **int** | The unique ID of the Electronicfundstransfer | [optional] +**fki_employee_id** | **int** | The unique ID of the Employee. | [optional] +**fki_externalbroker_id** | **int** | The unique ID of the Externalbroker. | [optional] +**fki_ezcomadvanceserver_id** | **int** | The unique ID of the Ezcomadvanceserver | [optional] +**fki_ezcomcompany_id** | **int** | The unique ID of the Ezcomcompany | [optional] +**fki_ezsigndocument_id** | **int** | The unique ID of the Ezsigndocument | [optional] +**fki_ghacqcontract_id** | **int** | The unique ID of the Ghacqcontract | [optional] +**fki_inscription_id** | **int** | The unique ID of the Inscription. | [optional] +**fki_inscriptiontemp_id** | **int** | The unique ID of the Inscriptiontemp | [optional] +**fki_inscriptionnotauthenticated_id** | **int** | The unique ID of the Inscriptionnotauthenticated. | [optional] +**fki_invoice_id** | **int** | The unique ID of the Invoice. | [optional] +**fki_buyercontract_id** | **int** | The unique ID of the Buyercontract | [optional] +**fki_franchisebroker_id** | **int** | The unique ID of the Franchisebroker | [optional] +**fki_franchiseagence_id** | **int** | The unique ID of the Franchiseagence | [optional] +**fki_franchiseoffice_id** | **int** | The unique ID of the Franchisereoffice | [optional] +**fki_franchisefranchise_id** | **int** | The unique ID of the Franchisefranchise | [optional] +**fki_franchisecomplaint_id** | **int** | The unique ID of the Franchisecomplaint | [optional] +**fki_lead_id** | **int** | The unique ID of the Lead | [optional] +**fki_marketingprogram_id** | **int** | The unique ID of the Marketingprogram | [optional] +**fki_marketingfollow_id** | **int** | The unique ID of the Marketingfollow | [optional] +**fki_notary_id** | **int** | The unique ID of the Notary. | [optional] +**fki_officetaxreport_id** | **int** | The unique ID of the Officetaxreport | [optional] +**fki_otherincome_id** | **int** | The unique ID of the Otherincome | [optional] +**fki_paymentpreparation_id** | **int** | The unique ID of the Paymentpreparation | [optional] +**fki_purchase_id** | **int** | The unique ID of the Purchase | [optional] +**fki_salary_id** | **int** | The unique ID of the Salary | [optional] +**fki_supplier_id** | **int** | The unique ID of the Supplier. | [optional] +**fki_tranqcontract_id** | **int** | The unique ID of the Tranqcontract | [optional] +**fki_template_id** | **int** | The unique ID of the Template | [optional] +**fki_inscriptionchecklist_id** | **int** | The unique ID of the Inscriptionchecklist | [optional] +**fki_folder_id** | **int** | The unique ID of the Folder | [optional] +**fki_rejectedoffertopurchase_id** | **int** | The unique ID of the Rejectedoffertopurchase | [optional] +**fki_disclosure_id** | **int** | The unique ID of the Disclosure | [optional] +**fki_reconciliation_id** | **int** | The unique ID of the Reconciliation | [optional] +**fki_ezsigndocument_id_reference** | **int** | The unique ID of the Ezsigndocument | [optional] +**e_attachment_documenttype** | [**FieldEAttachmentDocumenttype**](FieldEAttachmentDocumenttype.md) | | +**s_attachment_name** | **str** | The name of the Attachment | +**e_attachment_privacy** | [**FieldEAttachmentPrivacy**](FieldEAttachmentPrivacy.md) | | +**fki_user_id_specific** | **int** | The unique ID of the User | [optional] +**e_attachment_type** | [**FieldEAttachmentType**](FieldEAttachmentType.md) | | +**i_attachment_size** | **int** | The size of the Attachment | +**i_attachment_ed_mmoduleflag** | **int** | The edmmoduleflag of the Attachment | [optional] +**s_attachment_md5** | **str** | The md5 of the Attachment | +**b_attachment_deleted** | **bool** | Whether if it's deleted | +**b_attachment_valid** | **bool** | Whether if it's valid | +**e_attachment_verified** | [**FieldEAttachmentVerified**](FieldEAttachmentVerified.md) | | +**t_attachment_rejectioncomment** | **str** | The rejectioncomment of the Attachment | [optional] +**fki_user_id_owner** | **int** | The unique ID of the User | [optional] +**obj_audit** | [**CommonAudit**](CommonAudit.md) | | [optional] + +## Example + +```python +from eZmaxApi.models.attachment_response import AttachmentResponse + +# TODO update the JSON string below +json = "{}" +# create an instance of AttachmentResponse from a JSON string +attachment_response_instance = AttachmentResponse.from_json(json) +# print the JSON string representation of the object +print AttachmentResponse.to_json() + +# convert the object into a dict +attachment_response_dict = attachment_response_instance.to_dict() +# create an instance of AttachmentResponse from a dict +attachment_response_form_dict = attachment_response.from_dict(attachment_response_dict) +``` +[[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/docs/AttachmentResponseCompound.md b/docs/AttachmentResponseCompound.md new file mode 100644 index 000000000..d59ab5816 --- /dev/null +++ b/docs/AttachmentResponseCompound.md @@ -0,0 +1,90 @@ +# AttachmentResponseCompound + +A Attachment Object + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pki_attachment_id** | **int** | The unique ID of the Attachment. | +**fki_computer_id** | **int** | The unique ID of the Computer | [optional] +**fki_adjustment_id** | **int** | The unique ID of the Adjustment | [optional] +**fki_agent_id** | **int** | The unique ID of the Agent. | [optional] +**fki_bankaccount_id** | **int** | The unique ID of the Bankaccount | [optional] +**fki_broker_id** | **int** | The unique ID of the Broker. | [optional] +**fki_commissionadvance_id** | **int** | The unique ID of the Commissionadvance | [optional] +**fki_communication_id** | **int** | The unique ID of the Communication. | [optional] +**fki_customer_id** | **int** | The unique ID of the Customer. | [optional] +**fki_customertemplate_id** | **int** | The unique ID of the Customertemplate | [optional] +**fki_deposit_id** | **int** | The unique ID of the Deposit | [optional] +**fki_deposittransitcheque_id** | **int** | The unique ID of the Deposittransitcheque | [optional] +**fki_electronicfundstransfer_id** | **int** | The unique ID of the Electronicfundstransfer | [optional] +**fki_employee_id** | **int** | The unique ID of the Employee. | [optional] +**fki_externalbroker_id** | **int** | The unique ID of the Externalbroker. | [optional] +**fki_ezcomadvanceserver_id** | **int** | The unique ID of the Ezcomadvanceserver | [optional] +**fki_ezcomcompany_id** | **int** | The unique ID of the Ezcomcompany | [optional] +**fki_ezsigndocument_id** | **int** | The unique ID of the Ezsigndocument | [optional] +**fki_ghacqcontract_id** | **int** | The unique ID of the Ghacqcontract | [optional] +**fki_inscription_id** | **int** | The unique ID of the Inscription. | [optional] +**fki_inscriptiontemp_id** | **int** | The unique ID of the Inscriptiontemp | [optional] +**fki_inscriptionnotauthenticated_id** | **int** | The unique ID of the Inscriptionnotauthenticated. | [optional] +**fki_invoice_id** | **int** | The unique ID of the Invoice. | [optional] +**fki_buyercontract_id** | **int** | The unique ID of the Buyercontract | [optional] +**fki_franchisebroker_id** | **int** | The unique ID of the Franchisebroker | [optional] +**fki_franchiseagence_id** | **int** | The unique ID of the Franchiseagence | [optional] +**fki_franchiseoffice_id** | **int** | The unique ID of the Franchisereoffice | [optional] +**fki_franchisefranchise_id** | **int** | The unique ID of the Franchisefranchise | [optional] +**fki_franchisecomplaint_id** | **int** | The unique ID of the Franchisecomplaint | [optional] +**fki_lead_id** | **int** | The unique ID of the Lead | [optional] +**fki_marketingprogram_id** | **int** | The unique ID of the Marketingprogram | [optional] +**fki_marketingfollow_id** | **int** | The unique ID of the Marketingfollow | [optional] +**fki_notary_id** | **int** | The unique ID of the Notary. | [optional] +**fki_officetaxreport_id** | **int** | The unique ID of the Officetaxreport | [optional] +**fki_otherincome_id** | **int** | The unique ID of the Otherincome | [optional] +**fki_paymentpreparation_id** | **int** | The unique ID of the Paymentpreparation | [optional] +**fki_purchase_id** | **int** | The unique ID of the Purchase | [optional] +**fki_salary_id** | **int** | The unique ID of the Salary | [optional] +**fki_supplier_id** | **int** | The unique ID of the Supplier. | [optional] +**fki_tranqcontract_id** | **int** | The unique ID of the Tranqcontract | [optional] +**fki_template_id** | **int** | The unique ID of the Template | [optional] +**fki_inscriptionchecklist_id** | **int** | The unique ID of the Inscriptionchecklist | [optional] +**fki_folder_id** | **int** | The unique ID of the Folder | [optional] +**fki_rejectedoffertopurchase_id** | **int** | The unique ID of the Rejectedoffertopurchase | [optional] +**fki_disclosure_id** | **int** | The unique ID of the Disclosure | [optional] +**fki_reconciliation_id** | **int** | The unique ID of the Reconciliation | [optional] +**fki_ezsigndocument_id_reference** | **int** | The unique ID of the Ezsigndocument | [optional] +**e_attachment_documenttype** | [**FieldEAttachmentDocumenttype**](FieldEAttachmentDocumenttype.md) | | +**s_attachment_name** | **str** | The name of the Attachment | +**e_attachment_privacy** | [**FieldEAttachmentPrivacy**](FieldEAttachmentPrivacy.md) | | +**fki_user_id_specific** | **int** | The unique ID of the User | [optional] +**e_attachment_type** | [**FieldEAttachmentType**](FieldEAttachmentType.md) | | +**i_attachment_size** | **int** | The size of the Attachment | +**i_attachment_ed_mmoduleflag** | **int** | The edmmoduleflag of the Attachment | [optional] +**s_attachment_md5** | **str** | The md5 of the Attachment | +**b_attachment_deleted** | **bool** | Whether if it's deleted | +**b_attachment_valid** | **bool** | Whether if it's valid | +**e_attachment_verified** | [**FieldEAttachmentVerified**](FieldEAttachmentVerified.md) | | +**t_attachment_rejectioncomment** | **str** | The rejectioncomment of the Attachment | [optional] +**fki_user_id_owner** | **int** | The unique ID of the User | [optional] +**obj_audit** | [**CommonAudit**](CommonAudit.md) | | [optional] + +## Example + +```python +from eZmaxApi.models.attachment_response_compound import AttachmentResponseCompound + +# TODO update the JSON string below +json = "{}" +# create an instance of AttachmentResponseCompound from a JSON string +attachment_response_compound_instance = AttachmentResponseCompound.from_json(json) +# print the JSON string representation of the object +print AttachmentResponseCompound.to_json() + +# convert the object into a dict +attachment_response_compound_dict = attachment_response_compound_instance.to_dict() +# create an instance of AttachmentResponseCompound from a dict +attachment_response_compound_form_dict = attachment_response_compound.from_dict(attachment_response_compound_dict) +``` +[[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/docs/AttachmentlogResponse.md b/docs/AttachmentlogResponse.md new file mode 100644 index 000000000..b12ee1113 --- /dev/null +++ b/docs/AttachmentlogResponse.md @@ -0,0 +1,34 @@ +# AttachmentlogResponse + +An Attachmentlog Object + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**fki_attachment_id** | **int** | The unique ID of the Attachment. | +**fki_user_id** | **int** | The unique ID of the User | +**dt_attachmentlog_datetime** | **str** | The created date | +**e_attachmentlog_type** | [**FieldEAttachmentlogType**](FieldEAttachmentlogType.md) | | +**s_attachmentlog_detail** | **str** | The additionnal detail | [optional] + +## Example + +```python +from eZmaxApi.models.attachmentlog_response import AttachmentlogResponse + +# TODO update the JSON string below +json = "{}" +# create an instance of AttachmentlogResponse from a JSON string +attachmentlog_response_instance = AttachmentlogResponse.from_json(json) +# print the JSON string representation of the object +print AttachmentlogResponse.to_json() + +# convert the object into a dict +attachmentlog_response_dict = attachmentlog_response_instance.to_dict() +# create an instance of AttachmentlogResponse from a dict +attachmentlog_response_form_dict = attachmentlog_response.from_dict(attachmentlog_response_dict) +``` +[[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/docs/AttachmentlogResponseCompound.md b/docs/AttachmentlogResponseCompound.md new file mode 100644 index 000000000..d8dd3842a --- /dev/null +++ b/docs/AttachmentlogResponseCompound.md @@ -0,0 +1,34 @@ +# AttachmentlogResponseCompound + +A Attachmentlog Object + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**fki_attachment_id** | **int** | The unique ID of the Attachment. | +**fki_user_id** | **int** | The unique ID of the User | +**dt_attachmentlog_datetime** | **str** | The created date | +**e_attachmentlog_type** | [**FieldEAttachmentlogType**](FieldEAttachmentlogType.md) | | +**s_attachmentlog_detail** | **str** | The additionnal detail | [optional] + +## Example + +```python +from eZmaxApi.models.attachmentlog_response_compound import AttachmentlogResponseCompound + +# TODO update the JSON string below +json = "{}" +# create an instance of AttachmentlogResponseCompound from a JSON string +attachmentlog_response_compound_instance = AttachmentlogResponseCompound.from_json(json) +# print the JSON string representation of the object +print AttachmentlogResponseCompound.to_json() + +# convert the object into a dict +attachmentlog_response_compound_dict = attachmentlog_response_compound_instance.to_dict() +# create an instance of AttachmentlogResponseCompound from a dict +attachmentlog_response_compound_form_dict = attachmentlog_response_compound.from_dict(attachmentlog_response_compound_dict) +``` +[[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/docs/AttemptResponse.md b/docs/AttemptResponse.md index a30282c13..f82b20be3 100644 --- a/docs/AttemptResponse.md +++ b/docs/AttemptResponse.md @@ -3,6 +3,7 @@ An Attempt object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **dt_attempt_start** | **str** | Represent a Date Time. The timezone is the one configured in the User's profile. | diff --git a/docs/AttemptResponseCompound.md b/docs/AttemptResponseCompound.md index 663b7b89c..de675f418 100644 --- a/docs/AttemptResponseCompound.md +++ b/docs/AttemptResponseCompound.md @@ -3,6 +3,7 @@ An Attempt object and children to create a complete structure ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **dt_attempt_start** | **str** | Represent a Date Time. The timezone is the one configured in the User's profile. | diff --git a/docs/BillingentityexternalAutocompleteElementResponse.md b/docs/BillingentityexternalAutocompleteElementResponse.md index 0e77988ce..81b53e220 100644 --- a/docs/BillingentityexternalAutocompleteElementResponse.md +++ b/docs/BillingentityexternalAutocompleteElementResponse.md @@ -3,6 +3,7 @@ A Billingentityexternal AutocompleteElement Response ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_billingentityexternal_id** | **int** | The unique ID of the Billingentityexternal | diff --git a/docs/BillingentityexternalGetAutocompleteV2Response.md b/docs/BillingentityexternalGetAutocompleteV2Response.md index c21ff74f7..5aa4e5f22 100644 --- a/docs/BillingentityexternalGetAutocompleteV2Response.md +++ b/docs/BillingentityexternalGetAutocompleteV2Response.md @@ -3,6 +3,7 @@ Response for GET /2/object/billingentityexternal/getAutocomplete ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/BillingentityexternalGetAutocompleteV2ResponseMPayload.md b/docs/BillingentityexternalGetAutocompleteV2ResponseMPayload.md index 6c5b64915..ab2bc1149 100644 --- a/docs/BillingentityexternalGetAutocompleteV2ResponseMPayload.md +++ b/docs/BillingentityexternalGetAutocompleteV2ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for POST /2/object/billingentityexternal/getAutocomplete ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_billingentityexternal** | [**List[BillingentityexternalAutocompleteElementResponse]**](BillingentityexternalAutocompleteElementResponse.md) | An array of Billingentityexternal autocomplete element response. | diff --git a/docs/BillingentityinternalAutocompleteElementResponse.md b/docs/BillingentityinternalAutocompleteElementResponse.md index 6d248bc2e..8f6e81717 100644 --- a/docs/BillingentityinternalAutocompleteElementResponse.md +++ b/docs/BillingentityinternalAutocompleteElementResponse.md @@ -3,6 +3,7 @@ A Billingentityinternal AutocompleteElement Response ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_billingentityinternal_id** | **int** | The unique ID of the Billingentityinternal. | diff --git a/docs/BillingentityinternalCreateObjectV1Request.md b/docs/BillingentityinternalCreateObjectV1Request.md index f36144408..eaa2f83f9 100644 --- a/docs/BillingentityinternalCreateObjectV1Request.md +++ b/docs/BillingentityinternalCreateObjectV1Request.md @@ -3,6 +3,7 @@ Request for POST /1/object/billingentityinternal ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_billingentityinternal** | [**List[BillingentityinternalRequestCompound]**](BillingentityinternalRequestCompound.md) | | diff --git a/docs/BillingentityinternalCreateObjectV1Response.md b/docs/BillingentityinternalCreateObjectV1Response.md index a0a225f12..023268931 100644 --- a/docs/BillingentityinternalCreateObjectV1Response.md +++ b/docs/BillingentityinternalCreateObjectV1Response.md @@ -3,6 +3,7 @@ Response for POST /1/object/billingentityinternal ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/BillingentityinternalCreateObjectV1ResponseMPayload.md b/docs/BillingentityinternalCreateObjectV1ResponseMPayload.md index 460aa336f..c72f1b4ef 100644 --- a/docs/BillingentityinternalCreateObjectV1ResponseMPayload.md +++ b/docs/BillingentityinternalCreateObjectV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for POST /1/object/billingentityinternal ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_pki_billingentityinternal_id** | **List[int]** | An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request. | diff --git a/docs/BillingentityinternalEditObjectV1Request.md b/docs/BillingentityinternalEditObjectV1Request.md index 69047ec60..fba4cf1d6 100644 --- a/docs/BillingentityinternalEditObjectV1Request.md +++ b/docs/BillingentityinternalEditObjectV1Request.md @@ -3,6 +3,7 @@ Request for PUT /1/object/billingentityinternal/{pkiBillingentityinternalID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_billingentityinternal** | [**BillingentityinternalRequestCompound**](BillingentityinternalRequestCompound.md) | | diff --git a/docs/BillingentityinternalEditObjectV1Response.md b/docs/BillingentityinternalEditObjectV1Response.md index d3e725c91..70d4df985 100644 --- a/docs/BillingentityinternalEditObjectV1Response.md +++ b/docs/BillingentityinternalEditObjectV1Response.md @@ -3,6 +3,7 @@ Response for PUT /1/object/billingentityinternal/{pkiBillingentityinternalID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/BillingentityinternalGetAutocompleteV2Response.md b/docs/BillingentityinternalGetAutocompleteV2Response.md index e3fe464fc..a45c86eac 100644 --- a/docs/BillingentityinternalGetAutocompleteV2Response.md +++ b/docs/BillingentityinternalGetAutocompleteV2Response.md @@ -3,6 +3,7 @@ Response for GET /2/object/billingentityinternal/getAutocomplete ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/BillingentityinternalGetAutocompleteV2ResponseMPayload.md b/docs/BillingentityinternalGetAutocompleteV2ResponseMPayload.md index b3bd884a6..19852e955 100644 --- a/docs/BillingentityinternalGetAutocompleteV2ResponseMPayload.md +++ b/docs/BillingentityinternalGetAutocompleteV2ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for POST /2/object/billingentityinternal/getAutocomplete ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_billingentityinternal** | [**List[BillingentityinternalAutocompleteElementResponse]**](BillingentityinternalAutocompleteElementResponse.md) | An array of Billingentityinternal object containing the description, ID and active status about the element. | diff --git a/docs/BillingentityinternalGetListV1Response.md b/docs/BillingentityinternalGetListV1Response.md index 033899ae9..e92a84492 100644 --- a/docs/BillingentityinternalGetListV1Response.md +++ b/docs/BillingentityinternalGetListV1Response.md @@ -3,6 +3,7 @@ Response for GET /1/object/billingentityinternal/getList ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayloadGetList**](CommonResponseObjDebugPayloadGetList.md) | | diff --git a/docs/BillingentityinternalGetListV1ResponseMPayload.md b/docs/BillingentityinternalGetListV1ResponseMPayload.md index c7810e0de..e0a3bd996 100644 --- a/docs/BillingentityinternalGetListV1ResponseMPayload.md +++ b/docs/BillingentityinternalGetListV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for GET /1/object/billingentityinternal/getList ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **i_row_returned** | **int** | The number of rows returned | diff --git a/docs/BillingentityinternalGetObjectV2Response.md b/docs/BillingentityinternalGetObjectV2Response.md index 40cc112cb..c36551a1f 100644 --- a/docs/BillingentityinternalGetObjectV2Response.md +++ b/docs/BillingentityinternalGetObjectV2Response.md @@ -3,6 +3,7 @@ Response for GET /2/object/billingentityinternal/{pkiBillingentityinternalID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/BillingentityinternalGetObjectV2ResponseMPayload.md b/docs/BillingentityinternalGetObjectV2ResponseMPayload.md index 3098507f6..4163f96c1 100644 --- a/docs/BillingentityinternalGetObjectV2ResponseMPayload.md +++ b/docs/BillingentityinternalGetObjectV2ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for GET /2/object/billingentityinternal/{pkiBillingentityinternalID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_billingentityinternal** | [**BillingentityinternalResponseCompound**](BillingentityinternalResponseCompound.md) | | diff --git a/docs/BillingentityinternalListElement.md b/docs/BillingentityinternalListElement.md index 4c015a3d9..aad1dbe65 100644 --- a/docs/BillingentityinternalListElement.md +++ b/docs/BillingentityinternalListElement.md @@ -3,6 +3,7 @@ A Billingentityinternal List Element ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_billingentityinternal_id** | **int** | The unique ID of the Billingentityinternal. | diff --git a/docs/BillingentityinternalRequest.md b/docs/BillingentityinternalRequest.md index 28bdcfd77..8211ba6a7 100644 --- a/docs/BillingentityinternalRequest.md +++ b/docs/BillingentityinternalRequest.md @@ -3,6 +3,7 @@ A Billingentityinternal Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_billingentityinternal_id** | **int** | The unique ID of the Billingentityinternal. | [optional] diff --git a/docs/BillingentityinternalRequestCompound.md b/docs/BillingentityinternalRequestCompound.md index d35119832..15ee1966d 100644 --- a/docs/BillingentityinternalRequestCompound.md +++ b/docs/BillingentityinternalRequestCompound.md @@ -3,6 +3,7 @@ A Billingentityinternal Object and children ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_billingentityinternal_id** | **int** | The unique ID of the Billingentityinternal. | [optional] diff --git a/docs/BillingentityinternalResponse.md b/docs/BillingentityinternalResponse.md index 0f157de63..1c1df29a7 100644 --- a/docs/BillingentityinternalResponse.md +++ b/docs/BillingentityinternalResponse.md @@ -3,6 +3,7 @@ A Billingentityinternal Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_billingentityinternal_id** | **int** | The unique ID of the Billingentityinternal. | diff --git a/docs/BillingentityinternalResponseCompound.md b/docs/BillingentityinternalResponseCompound.md index 45454bbbf..9efefe9e3 100644 --- a/docs/BillingentityinternalResponseCompound.md +++ b/docs/BillingentityinternalResponseCompound.md @@ -3,6 +3,7 @@ A Billingentityinternal Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_billingentityinternal_id** | **int** | The unique ID of the Billingentityinternal. | diff --git a/docs/BillingentityinternalproductRequest.md b/docs/BillingentityinternalproductRequest.md index cf3c7cc8c..9bdb1850b 100644 --- a/docs/BillingentityinternalproductRequest.md +++ b/docs/BillingentityinternalproductRequest.md @@ -3,6 +3,7 @@ A Billingentityinternalproduct Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_billingentityinternalproduct_id** | **int** | The unique ID of the Billingentityinternalproduct | [optional] diff --git a/docs/BillingentityinternalproductRequestCompound.md b/docs/BillingentityinternalproductRequestCompound.md index 9cabc001a..263cdfd73 100644 --- a/docs/BillingentityinternalproductRequestCompound.md +++ b/docs/BillingentityinternalproductRequestCompound.md @@ -3,6 +3,7 @@ A Billingentityinternalproduct Object and children ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_billingentityinternalproduct_id** | **int** | The unique ID of the Billingentityinternalproduct | [optional] diff --git a/docs/BillingentityinternalproductResponse.md b/docs/BillingentityinternalproductResponse.md index c8bc4b0bb..d8fe60053 100644 --- a/docs/BillingentityinternalproductResponse.md +++ b/docs/BillingentityinternalproductResponse.md @@ -3,6 +3,7 @@ A Billingentityinternalproduct Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_billingentityinternalproduct_id** | **int** | The unique ID of the Billingentityinternalproduct | diff --git a/docs/BillingentityinternalproductResponseCompound.md b/docs/BillingentityinternalproductResponseCompound.md index 0212f4fb2..e8af1c900 100644 --- a/docs/BillingentityinternalproductResponseCompound.md +++ b/docs/BillingentityinternalproductResponseCompound.md @@ -3,6 +3,7 @@ A Billingentityinternalproduct Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_billingentityinternalproduct_id** | **int** | The unique ID of the Billingentityinternalproduct | diff --git a/docs/BrandingAutocompleteElementResponse.md b/docs/BrandingAutocompleteElementResponse.md index 93830aeba..3922e00dd 100644 --- a/docs/BrandingAutocompleteElementResponse.md +++ b/docs/BrandingAutocompleteElementResponse.md @@ -3,6 +3,7 @@ Branding AutocompleteElement Response ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **s_branding_description_x** | **str** | The Description of the Branding in the language of the requester | diff --git a/docs/BrandingCreateObjectV1Request.md b/docs/BrandingCreateObjectV1Request.md index eac84210d..fc43f0347 100644 --- a/docs/BrandingCreateObjectV1Request.md +++ b/docs/BrandingCreateObjectV1Request.md @@ -3,6 +3,7 @@ Request for POST /1/object/branding ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_branding** | [**List[BrandingRequestCompound]**](BrandingRequestCompound.md) | | diff --git a/docs/BrandingCreateObjectV1Response.md b/docs/BrandingCreateObjectV1Response.md index 29eba4a1f..2afe41016 100644 --- a/docs/BrandingCreateObjectV1Response.md +++ b/docs/BrandingCreateObjectV1Response.md @@ -3,6 +3,7 @@ Response for POST /1/object/branding ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/BrandingCreateObjectV1ResponseMPayload.md b/docs/BrandingCreateObjectV1ResponseMPayload.md index 5cbf01d82..be1a6a20c 100644 --- a/docs/BrandingCreateObjectV1ResponseMPayload.md +++ b/docs/BrandingCreateObjectV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for POST /1/object/branding ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_pki_branding_id** | **List[int]** | An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request. | diff --git a/docs/BrandingEditObjectV1Request.md b/docs/BrandingEditObjectV1Request.md index 156e0ee91..2b158f5ae 100644 --- a/docs/BrandingEditObjectV1Request.md +++ b/docs/BrandingEditObjectV1Request.md @@ -3,6 +3,7 @@ Request for PUT /1/object/branding/{pkiBrandingID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_branding** | [**BrandingRequestCompound**](BrandingRequestCompound.md) | | diff --git a/docs/BrandingEditObjectV1Response.md b/docs/BrandingEditObjectV1Response.md index 9b728a26c..ed1fcc79f 100644 --- a/docs/BrandingEditObjectV1Response.md +++ b/docs/BrandingEditObjectV1Response.md @@ -3,6 +3,7 @@ Response for PUT /1/object/branding/{pkiBrandingID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/BrandingGetAutocompleteV2Response.md b/docs/BrandingGetAutocompleteV2Response.md index 899b47fe6..9abb8c59b 100644 --- a/docs/BrandingGetAutocompleteV2Response.md +++ b/docs/BrandingGetAutocompleteV2Response.md @@ -3,6 +3,7 @@ Response for GET /2/object/branding/getAutocomplete ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/BrandingGetAutocompleteV2ResponseMPayload.md b/docs/BrandingGetAutocompleteV2ResponseMPayload.md index 2379e944f..bac88e015 100644 --- a/docs/BrandingGetAutocompleteV2ResponseMPayload.md +++ b/docs/BrandingGetAutocompleteV2ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for POST /2/object/branding/getAutocomplete ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_branding** | [**List[BrandingAutocompleteElementResponse]**](BrandingAutocompleteElementResponse.md) | An array of Branding object containing the description, ID and active status about the element. | diff --git a/docs/BrandingGetListV1Response.md b/docs/BrandingGetListV1Response.md index 730e0ff78..f1e950b31 100644 --- a/docs/BrandingGetListV1Response.md +++ b/docs/BrandingGetListV1Response.md @@ -3,6 +3,7 @@ Response for GET /1/object/branding/getList ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayloadGetList**](CommonResponseObjDebugPayloadGetList.md) | | diff --git a/docs/BrandingGetListV1ResponseMPayload.md b/docs/BrandingGetListV1ResponseMPayload.md index 862126c89..b73788dc0 100644 --- a/docs/BrandingGetListV1ResponseMPayload.md +++ b/docs/BrandingGetListV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for GET /1/object/branding/getList ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **i_row_returned** | **int** | The number of rows returned | diff --git a/docs/BrandingGetObjectV2Response.md b/docs/BrandingGetObjectV2Response.md index 7ef170a06..e34faea8d 100644 --- a/docs/BrandingGetObjectV2Response.md +++ b/docs/BrandingGetObjectV2Response.md @@ -3,6 +3,7 @@ Response for GET /2/object/branding/{pkiBrandingID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/BrandingGetObjectV2ResponseMPayload.md b/docs/BrandingGetObjectV2ResponseMPayload.md index fccebfefe..b119a2305 100644 --- a/docs/BrandingGetObjectV2ResponseMPayload.md +++ b/docs/BrandingGetObjectV2ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for GET /2/object/branding/{pkiBrandingID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_branding** | [**BrandingResponseCompound**](BrandingResponseCompound.md) | | diff --git a/docs/BrandingListElement.md b/docs/BrandingListElement.md index f2b4395b1..114cdf62d 100644 --- a/docs/BrandingListElement.md +++ b/docs/BrandingListElement.md @@ -3,6 +3,7 @@ A Branding List Element ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_branding_id** | **int** | The unique ID of the Branding | diff --git a/docs/BrandingRequest.md b/docs/BrandingRequest.md index af47108b7..09904cb68 100644 --- a/docs/BrandingRequest.md +++ b/docs/BrandingRequest.md @@ -3,6 +3,7 @@ A Branding Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_branding_id** | **int** | The unique ID of the Branding | [optional] diff --git a/docs/BrandingRequestCompound.md b/docs/BrandingRequestCompound.md index 3d5e5be8b..2a48369f2 100644 --- a/docs/BrandingRequestCompound.md +++ b/docs/BrandingRequestCompound.md @@ -3,6 +3,7 @@ A Branding Object and children ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_branding_id** | **int** | The unique ID of the Branding | [optional] diff --git a/docs/BrandingResponse.md b/docs/BrandingResponse.md index 85c405c11..006cc35c6 100644 --- a/docs/BrandingResponse.md +++ b/docs/BrandingResponse.md @@ -3,6 +3,7 @@ A Branding Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_branding_id** | **int** | The unique ID of the Branding | diff --git a/docs/BrandingResponseCompound.md b/docs/BrandingResponseCompound.md index e5aa09acd..737e173df 100644 --- a/docs/BrandingResponseCompound.md +++ b/docs/BrandingResponseCompound.md @@ -3,6 +3,7 @@ A Branding Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_branding_id** | **int** | The unique ID of the Branding | diff --git a/docs/BuyercontractGetCommunicationListV1Response.md b/docs/BuyercontractGetCommunicationListV1Response.md index 366ce84fb..125eefc3e 100644 --- a/docs/BuyercontractGetCommunicationListV1Response.md +++ b/docs/BuyercontractGetCommunicationListV1Response.md @@ -3,6 +3,7 @@ Response for GET /1/object/buyercontract/{pkiBuyercontractID}/getCommunicationList ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayloadGetList**](CommonResponseObjDebugPayloadGetList.md) | | diff --git a/docs/BuyercontractGetCommunicationListV1ResponseMPayload.md b/docs/BuyercontractGetCommunicationListV1ResponseMPayload.md index b09c56815..5d042e6c8 100644 --- a/docs/BuyercontractGetCommunicationListV1ResponseMPayload.md +++ b/docs/BuyercontractGetCommunicationListV1ResponseMPayload.md @@ -3,6 +3,7 @@ Response for GET /1/object/buyercontract/{pkiBuyercontractID}/getCommunicationList ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_communication** | [**List[CustomCommunicationListElementResponse]**](CustomCommunicationListElementResponse.md) | | diff --git a/docs/ClonehistoryGetListV1Response.md b/docs/ClonehistoryGetListV1Response.md index ed6595a4e..2765344cc 100644 --- a/docs/ClonehistoryGetListV1Response.md +++ b/docs/ClonehistoryGetListV1Response.md @@ -3,6 +3,7 @@ Response for GET /1/object/clonehistory/getList ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayloadGetList**](CommonResponseObjDebugPayloadGetList.md) | | diff --git a/docs/ClonehistoryGetListV1ResponseMPayload.md b/docs/ClonehistoryGetListV1ResponseMPayload.md index fce4c24ae..52f805439 100644 --- a/docs/ClonehistoryGetListV1ResponseMPayload.md +++ b/docs/ClonehistoryGetListV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for GET /1/object/clonehistory/getList ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **i_row_returned** | **int** | The number of rows returned | diff --git a/docs/ClonehistoryListElement.md b/docs/ClonehistoryListElement.md index 6a8018080..c238c02df 100644 --- a/docs/ClonehistoryListElement.md +++ b/docs/ClonehistoryListElement.md @@ -3,6 +3,7 @@ A Clonehistory List Element ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_clonehistory_id** | **int** | The unique ID of the Clonehistory | diff --git a/docs/CommonAudit.md b/docs/CommonAudit.md index f8e3bee99..093439fa5 100644 --- a/docs/CommonAudit.md +++ b/docs/CommonAudit.md @@ -3,6 +3,7 @@ Gives informations about the user that created the object and the last user to have modified it. If the object was never modified after creation, objAuditdetailModified won't be returned. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_auditdetail_created** | [**CommonAuditdetail**](CommonAuditdetail.md) | | diff --git a/docs/CommonAuditdetail.md b/docs/CommonAuditdetail.md index e53380c04..dd2c1db9d 100644 --- a/docs/CommonAuditdetail.md +++ b/docs/CommonAuditdetail.md @@ -3,6 +3,7 @@ Gives informations about the user that created the object or the last user to have modified it. If the object was never modified after creation, both Created and Modified informations will be the same. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **fki_user_id** | **int** | The unique ID of the User | diff --git a/docs/CommonFile.md b/docs/CommonFile.md index d40e9a906..3ccd7035a 100644 --- a/docs/CommonFile.md +++ b/docs/CommonFile.md @@ -3,6 +3,7 @@ Object representing a file used in a request or response context ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **s_file_name** | **str** | The name of the file | diff --git a/docs/CommonGetAutocompleteV1Response.md b/docs/CommonGetAutocompleteV1Response.md index 3b1cd6057..e1c689059 100644 --- a/docs/CommonGetAutocompleteV1Response.md +++ b/docs/CommonGetAutocompleteV1Response.md @@ -3,6 +3,7 @@ Response for GET /1/object/xxx/getAutocomplete ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/CommonGetListV1ResponseMPayload.md b/docs/CommonGetListV1ResponseMPayload.md index 712b616a1..de595f948 100644 --- a/docs/CommonGetListV1ResponseMPayload.md +++ b/docs/CommonGetListV1ResponseMPayload.md @@ -3,6 +3,7 @@ Generic List Response ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **i_row_returned** | **int** | The number of rows returned | diff --git a/docs/CommonGetReportV1Response.md b/docs/CommonGetReportV1Response.md index 6bf5c7518..1182296e8 100644 --- a/docs/CommonGetReportV1Response.md +++ b/docs/CommonGetReportV1Response.md @@ -3,6 +3,7 @@ Response for POST /1/report/xxx/xxx and /1/module/report/getReportFromCache ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/CommonGetReportV1ResponseMPayload.md b/docs/CommonGetReportV1ResponseMPayload.md index 19797724b..17db74c1a 100644 --- a/docs/CommonGetReportV1ResponseMPayload.md +++ b/docs/CommonGetReportV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for POST /1/report/xxx/xxx and and /1/module/report/getReportFromCache ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_reportgroup** | [**CommonReportgroup**](CommonReportgroup.md) | | diff --git a/docs/CommonReport.md b/docs/CommonReport.md index 74dcf3820..e413eee85 100644 --- a/docs/CommonReport.md +++ b/docs/CommonReport.md @@ -3,6 +3,7 @@ A Report containing Reportsections ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_reportsection** | [**List[CommonReportsection]**](CommonReportsection.md) | | diff --git a/docs/CommonReportcell.md b/docs/CommonReportcell.md index 2fedda83e..97dea0486 100644 --- a/docs/CommonReportcell.md +++ b/docs/CommonReportcell.md @@ -3,6 +3,7 @@ A cell in a Reportrow ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **i_reportcell_columnspan** | **int** | The number of Reportcolumns the Reportcell spans | diff --git a/docs/CommonReportcellstyle.md b/docs/CommonReportcellstyle.md index c9bd6eb7c..c51ec1982 100644 --- a/docs/CommonReportcellstyle.md +++ b/docs/CommonReportcellstyle.md @@ -3,6 +3,7 @@ Styles applied to a Reportcell ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **b_reportcellstyle_bordertop** | **bool** | Whether there is a border at the top of the Reportcell | diff --git a/docs/CommonReportcolumn.md b/docs/CommonReportcolumn.md index 2b88d9cb6..51342f38c 100644 --- a/docs/CommonReportcolumn.md +++ b/docs/CommonReportcolumn.md @@ -3,6 +3,7 @@ A column in a Reportsection ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_reportcellstyle_default** | [**CommonReportcellstyle**](CommonReportcellstyle.md) | | diff --git a/docs/CommonReportgroup.md b/docs/CommonReportgroup.md index 00d5de4fb..9278074b7 100644 --- a/docs/CommonReportgroup.md +++ b/docs/CommonReportgroup.md @@ -3,6 +3,7 @@ A group of reports Each Reportgroup is for a specific recipient or for a specific context. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_report** | [**List[CommonReport]**](CommonReport.md) | | diff --git a/docs/CommonReportrow.md b/docs/CommonReportrow.md index 2a52f184f..e1af65ae8 100644 --- a/docs/CommonReportrow.md +++ b/docs/CommonReportrow.md @@ -3,6 +3,7 @@ A row in a Reportsubsectionpart ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_reportcell** | [**List[CommonReportcell]**](CommonReportcell.md) | | diff --git a/docs/CommonReportsection.md b/docs/CommonReportsection.md index 278021ffd..b886fb7a8 100644 --- a/docs/CommonReportsection.md +++ b/docs/CommonReportsection.md @@ -3,6 +3,7 @@ A section in a Report. Each Reportsection shares Reportcolumns disposition with all its Reportsubsection ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_reportsubsection** | [**List[CommonReportsubsection]**](CommonReportsubsection.md) | | diff --git a/docs/CommonReportsubsection.md b/docs/CommonReportsubsection.md index f6b86d28e..9be6566f1 100644 --- a/docs/CommonReportsubsection.md +++ b/docs/CommonReportsubsection.md @@ -3,6 +3,7 @@ A Subsection in a Reportsection. It contains 3 Reportsubsectionparts (Header, Body and Footer) ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_reportsubsectionpart_header** | [**CommonReportsubsectionpart**](CommonReportsubsectionpart.md) | | diff --git a/docs/CommonReportsubsectionpart.md b/docs/CommonReportsubsectionpart.md index f904f164d..bd74c368b 100644 --- a/docs/CommonReportsubsectionpart.md +++ b/docs/CommonReportsubsectionpart.md @@ -3,6 +3,7 @@ A part in the Reportsubsection ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **e_reportsubsectionpart_type** | **str** | The type of the Reportsubsectionpart | diff --git a/docs/CommonResponse.md b/docs/CommonResponse.md index c7c801fec..644e93974 100644 --- a/docs/CommonResponse.md +++ b/docs/CommonResponse.md @@ -3,6 +3,7 @@ All API response will inherit this based Response ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/CommonResponseError.md b/docs/CommonResponseError.md index e61d008a0..db2914bfd 100644 --- a/docs/CommonResponseError.md +++ b/docs/CommonResponseError.md @@ -3,6 +3,7 @@ Generic Error Message ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **s_error_message** | **str** | The message giving details about the error | diff --git a/docs/CommonResponseErrorEzsignformValidation.md b/docs/CommonResponseErrorEzsignformValidation.md index d36fc7bb8..b5775a992 100644 --- a/docs/CommonResponseErrorEzsignformValidation.md +++ b/docs/CommonResponseErrorEzsignformValidation.md @@ -3,6 +3,7 @@ Generic Error Message ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **s_error_message** | **str** | The message giving details about the error | diff --git a/docs/CommonResponseErrorSTemporaryFileUrl.md b/docs/CommonResponseErrorSTemporaryFileUrl.md index d6fcff679..fe9d4e3ab 100644 --- a/docs/CommonResponseErrorSTemporaryFileUrl.md +++ b/docs/CommonResponseErrorSTemporaryFileUrl.md @@ -3,6 +3,7 @@ Generic Error Message ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **s_error_message** | **str** | The message giving details about the error | diff --git a/docs/CommonResponseErrorTooManyRequests.md b/docs/CommonResponseErrorTooManyRequests.md index 9ad789a33..8b0bec15c 100644 --- a/docs/CommonResponseErrorTooManyRequests.md +++ b/docs/CommonResponseErrorTooManyRequests.md @@ -3,6 +3,7 @@ Generic Error Message ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **s_error_message** | **str** | The message giving details about the error | diff --git a/docs/CommonResponseFilter.md b/docs/CommonResponseFilter.md index c13d26a2d..2228d1fa3 100644 --- a/docs/CommonResponseFilter.md +++ b/docs/CommonResponseFilter.md @@ -3,6 +3,7 @@ Definition of Filters for getList ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_auto_type** | **Dict[str, str]** | List of filters that can be used in *sFilter* (Automatic types) | [optional] diff --git a/docs/CommonResponseGetList.md b/docs/CommonResponseGetList.md index 693969141..fd8ec1d75 100644 --- a/docs/CommonResponseGetList.md +++ b/docs/CommonResponseGetList.md @@ -3,6 +3,7 @@ All API response will inherit this based Response ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayloadGetList**](CommonResponseObjDebugPayloadGetList.md) | | diff --git a/docs/CommonResponseObjDebug.md b/docs/CommonResponseObjDebug.md index da075a61e..fdee196c8 100644 --- a/docs/CommonResponseObjDebug.md +++ b/docs/CommonResponseObjDebug.md @@ -3,6 +3,7 @@ This is a generic debug object that is returned by all API requests ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **s_memory_usage** | **str** | The peak memory allocated during the API request execution. Formatted as a human readable string | diff --git a/docs/CommonResponseObjDebugPayload.md b/docs/CommonResponseObjDebugPayload.md index 42a5d45b3..1701fc49e 100644 --- a/docs/CommonResponseObjDebugPayload.md +++ b/docs/CommonResponseObjDebugPayload.md @@ -3,6 +3,7 @@ This is a debug object containing debugging information on the actual function ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **i_version_min** | **int** | The minimum version of the function that can be called | diff --git a/docs/CommonResponseObjDebugPayloadGetList.md b/docs/CommonResponseObjDebugPayloadGetList.md index d99b63ee9..5fedc8e18 100644 --- a/docs/CommonResponseObjDebugPayloadGetList.md +++ b/docs/CommonResponseObjDebugPayloadGetList.md @@ -3,6 +3,7 @@ This is a debug object containing debugging information on the actual function ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **i_version_min** | **int** | The minimum version of the function that can be called | diff --git a/docs/CommonResponseObjSQLQuery.md b/docs/CommonResponseObjSQLQuery.md index 816a2c3de..d8d1ffeb7 100644 --- a/docs/CommonResponseObjSQLQuery.md +++ b/docs/CommonResponseObjSQLQuery.md @@ -3,6 +3,7 @@ Definition of objSQLQuery Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **s_query** | **str** | The SQL Query | diff --git a/docs/CommonResponseRedirectSSecretquestionTextX.md b/docs/CommonResponseRedirectSSecretquestionTextX.md index 508d153b6..fd9a00d53 100644 --- a/docs/CommonResponseRedirectSSecretquestionTextX.md +++ b/docs/CommonResponseRedirectSSecretquestionTextX.md @@ -3,6 +3,7 @@ 352 Redirect Message containing secret question ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **s_secretquestion_text_x** | **str** | The text of the Secretquestion in the language of the requester | diff --git a/docs/CommonResponseWarning.md b/docs/CommonResponseWarning.md index 51a2056c9..8d0b76e23 100644 --- a/docs/CommonResponseWarning.md +++ b/docs/CommonResponseWarning.md @@ -3,6 +3,7 @@ Generic Warning Message ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **s_warning_message** | **str** | More detail about the warning | diff --git a/docs/CommonWebhook.md b/docs/CommonWebhook.md index 27bab1164..2895db415 100644 --- a/docs/CommonWebhook.md +++ b/docs/CommonWebhook.md @@ -3,6 +3,7 @@ This is the base Webhook object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_webhook** | [**CustomWebhookResponse**](CustomWebhookResponse.md) | | diff --git a/docs/CommunicationCreateObjectV1ResponseMPayload.md b/docs/CommunicationCreateObjectV1ResponseMPayload.md index c9f500892..a1b33059a 100644 --- a/docs/CommunicationCreateObjectV1ResponseMPayload.md +++ b/docs/CommunicationCreateObjectV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for POST /1/object/communication ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_pki_communication_id** | **List[int]** | An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request. | diff --git a/docs/CommunicationRequest.md b/docs/CommunicationRequest.md index 68ff1bdb2..942cecd86 100644 --- a/docs/CommunicationRequest.md +++ b/docs/CommunicationRequest.md @@ -3,6 +3,7 @@ Request for POST /1/object/communication ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_communication_id** | **int** | The unique ID of the Communication. | [optional] diff --git a/docs/CommunicationRequestCompound.md b/docs/CommunicationRequestCompound.md index 00163fae4..e4366b568 100644 --- a/docs/CommunicationRequestCompound.md +++ b/docs/CommunicationRequestCompound.md @@ -3,6 +3,7 @@ Request for POST /1/object/communication ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_communication_id** | **int** | The unique ID of the Communication. | [optional] diff --git a/docs/CommunicationSendV1Request.md b/docs/CommunicationSendV1Request.md index 37d23973b..ea206142f 100644 --- a/docs/CommunicationSendV1Request.md +++ b/docs/CommunicationSendV1Request.md @@ -3,6 +3,7 @@ Request for POST /1/object/communication ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_communication** | [**List[CommunicationRequestCompound]**](CommunicationRequestCompound.md) | | diff --git a/docs/CommunicationSendV1Response.md b/docs/CommunicationSendV1Response.md index 4731096c2..c71ea1579 100644 --- a/docs/CommunicationSendV1Response.md +++ b/docs/CommunicationSendV1Response.md @@ -3,6 +3,7 @@ Response for POST /1/object/communication ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/CommunicationattachmentRequest.md b/docs/CommunicationattachmentRequest.md index aa158e192..45c39782f 100644 --- a/docs/CommunicationattachmentRequest.md +++ b/docs/CommunicationattachmentRequest.md @@ -3,6 +3,7 @@ A Communicationattachment Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_communicationattachment_id** | **int** | The unique ID of the Communicationattachment | [optional] diff --git a/docs/CommunicationattachmentRequestCompound.md b/docs/CommunicationattachmentRequestCompound.md index 57ff043d8..cb31aaf72 100644 --- a/docs/CommunicationattachmentRequestCompound.md +++ b/docs/CommunicationattachmentRequestCompound.md @@ -3,6 +3,7 @@ A Communicationattachment Object and children ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_communicationattachment_id** | **int** | The unique ID of the Communicationattachment | [optional] diff --git a/docs/CommunicationexternalrecipientRequest.md b/docs/CommunicationexternalrecipientRequest.md index 09a09efc2..f24716de4 100644 --- a/docs/CommunicationexternalrecipientRequest.md +++ b/docs/CommunicationexternalrecipientRequest.md @@ -3,13 +3,14 @@ A Communicationexternalrecipient Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_communicationexternalrecipient_id** | **int** | The unique ID of the Communicationexternalrecipient | [optional] **s_email_address** | **str** | The email address. | [optional] **s_phone_e164** | **str** | A phone number in E.164 Format | [optional] **e_communicationexternalrecipient_type** | [**FieldECommunicationexternalrecipientType**](FieldECommunicationexternalrecipientType.md) | | [optional] -**s_communicationexternalrecipient_name** | **str** | The name of the Communicationexternalrecipient | +**s_communicationexternalrecipient_name** | **str** | The name of the Communicationexternalrecipient | [optional] ## Example diff --git a/docs/CommunicationexternalrecipientRequestCompound.md b/docs/CommunicationexternalrecipientRequestCompound.md index 4242e2343..f9cecb098 100644 --- a/docs/CommunicationexternalrecipientRequestCompound.md +++ b/docs/CommunicationexternalrecipientRequestCompound.md @@ -3,13 +3,14 @@ A Communicationexternalrecipient Object and children ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_communicationexternalrecipient_id** | **int** | The unique ID of the Communicationexternalrecipient | [optional] **s_email_address** | **str** | The email address. | [optional] **s_phone_e164** | **str** | A phone number in E.164 Format | [optional] **e_communicationexternalrecipient_type** | [**FieldECommunicationexternalrecipientType**](FieldECommunicationexternalrecipientType.md) | | [optional] -**s_communicationexternalrecipient_name** | **str** | The name of the Communicationexternalrecipient | +**s_communicationexternalrecipient_name** | **str** | The name of the Communicationexternalrecipient | [optional] ## Example diff --git a/docs/CommunicationrecipientRequest.md b/docs/CommunicationrecipientRequest.md index ec74ffb65..1b3162595 100644 --- a/docs/CommunicationrecipientRequest.md +++ b/docs/CommunicationrecipientRequest.md @@ -3,12 +3,13 @@ A Communicationrecipient Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_communicationrecipient_id** | **int** | The unique ID of the Communicationrecipient. | [optional] **fki_agent_id** | **int** | The unique ID of the Agent. | [optional] -**fki_agentincorporation_id** | **int** | The unique ID of the Agentincorporation. | [optional] **fki_broker_id** | **int** | The unique ID of the Broker. | [optional] +**fki_contact_id** | **int** | The unique ID of the Contact | [optional] **fki_customer_id** | **int** | The unique ID of the Customer. | [optional] **fki_employee_id** | **int** | The unique ID of the Employee. | [optional] **fki_assistant_id** | **int** | The unique ID of the Assistant. | [optional] @@ -17,6 +18,8 @@ Name | Type | Description | Notes **fki_notary_id** | **int** | The unique ID of the Notary. | [optional] **fki_supplier_id** | **int** | The unique ID of the Supplier. | [optional] **fki_user_id** | **int** | The unique ID of the User | [optional] +**fki_mailboxshared_id** | **int** | The unique ID of the Mailboxshared | [optional] +**fki_phonelineshared_id** | **int** | The unique ID of the Phonelineshared | [optional] **e_communicationrecipient_type** | [**FieldECommunicationrecipientType**](FieldECommunicationrecipientType.md) | | [optional] ## Example diff --git a/docs/CommunicationrecipientRequestCompound.md b/docs/CommunicationrecipientRequestCompound.md index d6367711d..8fc334715 100644 --- a/docs/CommunicationrecipientRequestCompound.md +++ b/docs/CommunicationrecipientRequestCompound.md @@ -3,12 +3,13 @@ A Communicationrecipient Object and children ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_communicationrecipient_id** | **int** | The unique ID of the Communicationrecipient. | [optional] **fki_agent_id** | **int** | The unique ID of the Agent. | [optional] -**fki_agentincorporation_id** | **int** | The unique ID of the Agentincorporation. | [optional] **fki_broker_id** | **int** | The unique ID of the Broker. | [optional] +**fki_contact_id** | **int** | The unique ID of the Contact | [optional] **fki_customer_id** | **int** | The unique ID of the Customer. | [optional] **fki_employee_id** | **int** | The unique ID of the Employee. | [optional] **fki_assistant_id** | **int** | The unique ID of the Assistant. | [optional] @@ -17,6 +18,8 @@ Name | Type | Description | Notes **fki_notary_id** | **int** | The unique ID of the Notary. | [optional] **fki_supplier_id** | **int** | The unique ID of the Supplier. | [optional] **fki_user_id** | **int** | The unique ID of the User | [optional] +**fki_mailboxshared_id** | **int** | The unique ID of the Mailboxshared | [optional] +**fki_phonelineshared_id** | **int** | The unique ID of the Phonelineshared | [optional] **e_communicationrecipient_type** | [**FieldECommunicationrecipientType**](FieldECommunicationrecipientType.md) | | [optional] ## Example diff --git a/docs/CommunicationreferenceRequest.md b/docs/CommunicationreferenceRequest.md index 76cd0ead5..7466944ab 100644 --- a/docs/CommunicationreferenceRequest.md +++ b/docs/CommunicationreferenceRequest.md @@ -3,6 +3,7 @@ A Communicationreference Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_communicationreference_id** | **int** | The unique ID of the Communicationreference | [optional] diff --git a/docs/CommunicationreferenceRequestCompound.md b/docs/CommunicationreferenceRequestCompound.md index 9ad461bb9..cb68a2600 100644 --- a/docs/CommunicationreferenceRequestCompound.md +++ b/docs/CommunicationreferenceRequestCompound.md @@ -3,6 +3,7 @@ A Communicationreference Object and children ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_communicationreference_id** | **int** | The unique ID of the Communicationreference | [optional] diff --git a/docs/CompanyAutocompleteElementResponse.md b/docs/CompanyAutocompleteElementResponse.md index 2764aee12..449bc2408 100644 --- a/docs/CompanyAutocompleteElementResponse.md +++ b/docs/CompanyAutocompleteElementResponse.md @@ -3,6 +3,7 @@ A Company AutocompleteElement Response ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_company_id** | **int** | The unique ID of the Company | diff --git a/docs/CompanyGetAutocompleteV2Response.md b/docs/CompanyGetAutocompleteV2Response.md index fef25e2a3..939719b19 100644 --- a/docs/CompanyGetAutocompleteV2Response.md +++ b/docs/CompanyGetAutocompleteV2Response.md @@ -3,6 +3,7 @@ Response for GET /2/object/company/getAutocomplete ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/CompanyGetAutocompleteV2ResponseMPayload.md b/docs/CompanyGetAutocompleteV2ResponseMPayload.md index c11c64145..c8a4ef229 100644 --- a/docs/CompanyGetAutocompleteV2ResponseMPayload.md +++ b/docs/CompanyGetAutocompleteV2ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for POST /2/object/company/getAutocomplete ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_company** | [**List[CompanyAutocompleteElementResponse]**](CompanyAutocompleteElementResponse.md) | An array of Company autocomplete element response. | diff --git a/docs/ComputedECommunicationDirection.md b/docs/ComputedECommunicationDirection.md index 370db1c43..7dfe1a68c 100644 --- a/docs/ComputedECommunicationDirection.md +++ b/docs/ComputedECommunicationDirection.md @@ -3,6 +3,7 @@ The direction of the Communication ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/ComputedEEzsigndocumentSteptype.md b/docs/ComputedEEzsigndocumentSteptype.md index 9592e4159..06baa9662 100644 --- a/docs/ComputedEEzsigndocumentSteptype.md +++ b/docs/ComputedEEzsigndocumentSteptype.md @@ -3,6 +3,7 @@ Indicates whether the current step is a form or signatures. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/ContactRequest.md b/docs/ContactRequest.md index 9c6917423..06395e839 100644 --- a/docs/ContactRequest.md +++ b/docs/ContactRequest.md @@ -3,6 +3,7 @@ A Contact Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **fki_contacttitle_id** | **int** | The unique ID of the Contacttitle. Valid values: |Value|Description| |-|-| |1|Ms.| |2|Mr.| |4|(Blank)| |5|Me (For Notaries)| | diff --git a/docs/ContactRequestCompound.md b/docs/ContactRequestCompound.md index be4179013..e8b92236f 100644 --- a/docs/ContactRequestCompound.md +++ b/docs/ContactRequestCompound.md @@ -3,6 +3,7 @@ A Contact Object and children to create a complete structure ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **fki_contacttitle_id** | **int** | The unique ID of the Contacttitle. Valid values: |Value|Description| |-|-| |1|Ms.| |2|Mr.| |4|(Blank)| |5|Me (For Notaries)| | diff --git a/docs/ContactinformationsRequest.md b/docs/ContactinformationsRequest.md index a8c565a31..4bfb9b153 100644 --- a/docs/ContactinformationsRequest.md +++ b/docs/ContactinformationsRequest.md @@ -3,6 +3,7 @@ A Contactinformations Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **i_address_default** | **int** | The index in the a_objAddress array (zero based index) representing the Address object that should become the default one. You can leave the value to 0 if the array is empty. | diff --git a/docs/ContactinformationsRequestCompound.md b/docs/ContactinformationsRequestCompound.md index fb47b5994..e6d3942a3 100644 --- a/docs/ContactinformationsRequestCompound.md +++ b/docs/ContactinformationsRequestCompound.md @@ -3,6 +3,7 @@ A Contactinformations Object and children to create a complete structure ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **i_address_default** | **int** | The index in the a_objAddress array (zero based index) representing the Address object that should become the default one. You can leave the value to 0 if the array is empty. | diff --git a/docs/CorsCreateObjectV1Request.md b/docs/CorsCreateObjectV1Request.md index c56bcd319..69b86ca26 100644 --- a/docs/CorsCreateObjectV1Request.md +++ b/docs/CorsCreateObjectV1Request.md @@ -3,6 +3,7 @@ Request for POST /1/object/cors ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_cors** | [**List[CorsRequestCompound]**](CorsRequestCompound.md) | | diff --git a/docs/CorsCreateObjectV1Response.md b/docs/CorsCreateObjectV1Response.md index 0c570d824..910bd9fa1 100644 --- a/docs/CorsCreateObjectV1Response.md +++ b/docs/CorsCreateObjectV1Response.md @@ -3,6 +3,7 @@ Response for POST /1/object/cors ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/CorsCreateObjectV1ResponseMPayload.md b/docs/CorsCreateObjectV1ResponseMPayload.md index f6fc7e585..e4a10ed5b 100644 --- a/docs/CorsCreateObjectV1ResponseMPayload.md +++ b/docs/CorsCreateObjectV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for POST /1/object/cors ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_pki_cors_id** | **List[int]** | An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request. | diff --git a/docs/CorsDeleteObjectV1Response.md b/docs/CorsDeleteObjectV1Response.md index fc2255832..a69449e70 100644 --- a/docs/CorsDeleteObjectV1Response.md +++ b/docs/CorsDeleteObjectV1Response.md @@ -3,6 +3,7 @@ Response for DELETE /1/object/cors/{pkiCorsID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/CorsEditObjectV1Request.md b/docs/CorsEditObjectV1Request.md index 4fb46fbfc..4d55d9760 100644 --- a/docs/CorsEditObjectV1Request.md +++ b/docs/CorsEditObjectV1Request.md @@ -3,6 +3,7 @@ Request for PUT /1/object/cors/{pkiCorsID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_cors** | [**CorsRequestCompound**](CorsRequestCompound.md) | | diff --git a/docs/CorsEditObjectV1Response.md b/docs/CorsEditObjectV1Response.md index b68636c02..9ac018d3b 100644 --- a/docs/CorsEditObjectV1Response.md +++ b/docs/CorsEditObjectV1Response.md @@ -3,6 +3,7 @@ Response for PUT /1/object/cors/{pkiCorsID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/CorsGetObjectV2Response.md b/docs/CorsGetObjectV2Response.md index 9e021f295..51dac911d 100644 --- a/docs/CorsGetObjectV2Response.md +++ b/docs/CorsGetObjectV2Response.md @@ -3,6 +3,7 @@ Response for GET /2/object/cors/{pkiCorsID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/CorsGetObjectV2ResponseMPayload.md b/docs/CorsGetObjectV2ResponseMPayload.md index 798f629d3..3f3ee312b 100644 --- a/docs/CorsGetObjectV2ResponseMPayload.md +++ b/docs/CorsGetObjectV2ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for GET /2/object/cors/{pkiCorsID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_cors** | [**CorsResponseCompound**](CorsResponseCompound.md) | | diff --git a/docs/CorsRequest.md b/docs/CorsRequest.md index 9d8c5df0b..3118b82b8 100644 --- a/docs/CorsRequest.md +++ b/docs/CorsRequest.md @@ -3,6 +3,7 @@ A Cors Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_cors_id** | **int** | The unique ID of the Cors | [optional] diff --git a/docs/CorsRequestCompound.md b/docs/CorsRequestCompound.md index 4412fa347..ee64bff8c 100644 --- a/docs/CorsRequestCompound.md +++ b/docs/CorsRequestCompound.md @@ -3,6 +3,7 @@ A Cors Object and children ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_cors_id** | **int** | The unique ID of the Cors | [optional] diff --git a/docs/CorsResponse.md b/docs/CorsResponse.md index 95f200ceb..b9ce9e75b 100644 --- a/docs/CorsResponse.md +++ b/docs/CorsResponse.md @@ -3,6 +3,7 @@ A Cors Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_cors_id** | **int** | The unique ID of the Cors | diff --git a/docs/CorsResponseCompound.md b/docs/CorsResponseCompound.md index b549b2cbc..6cd79bb4a 100644 --- a/docs/CorsResponseCompound.md +++ b/docs/CorsResponseCompound.md @@ -3,6 +3,7 @@ A Cors Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_cors_id** | **int** | The unique ID of the Cors | diff --git a/docs/CustomAttachmentResponse.md b/docs/CustomAttachmentResponse.md new file mode 100644 index 000000000..d1c2ed4ae --- /dev/null +++ b/docs/CustomAttachmentResponse.md @@ -0,0 +1,94 @@ +# CustomAttachmentResponse + +A Custom Attachment Object + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pki_attachment_id** | **int** | The unique ID of the Attachment. | +**fki_computer_id** | **int** | The unique ID of the Computer | [optional] +**fki_adjustment_id** | **int** | The unique ID of the Adjustment | [optional] +**fki_agent_id** | **int** | The unique ID of the Agent. | [optional] +**fki_bankaccount_id** | **int** | The unique ID of the Bankaccount | [optional] +**fki_broker_id** | **int** | The unique ID of the Broker. | [optional] +**fki_commissionadvance_id** | **int** | The unique ID of the Commissionadvance | [optional] +**fki_communication_id** | **int** | The unique ID of the Communication. | [optional] +**fki_customer_id** | **int** | The unique ID of the Customer. | [optional] +**fki_customertemplate_id** | **int** | The unique ID of the Customertemplate | [optional] +**fki_deposit_id** | **int** | The unique ID of the Deposit | [optional] +**fki_deposittransitcheque_id** | **int** | The unique ID of the Deposittransitcheque | [optional] +**fki_electronicfundstransfer_id** | **int** | The unique ID of the Electronicfundstransfer | [optional] +**fki_employee_id** | **int** | The unique ID of the Employee. | [optional] +**fki_externalbroker_id** | **int** | The unique ID of the Externalbroker. | [optional] +**fki_ezcomadvanceserver_id** | **int** | The unique ID of the Ezcomadvanceserver | [optional] +**fki_ezcomcompany_id** | **int** | The unique ID of the Ezcomcompany | [optional] +**fki_ezsigndocument_id** | **int** | The unique ID of the Ezsigndocument | [optional] +**fki_ghacqcontract_id** | **int** | The unique ID of the Ghacqcontract | [optional] +**fki_inscription_id** | **int** | The unique ID of the Inscription. | [optional] +**fki_inscriptiontemp_id** | **int** | The unique ID of the Inscriptiontemp | [optional] +**fki_inscriptionnotauthenticated_id** | **int** | The unique ID of the Inscriptionnotauthenticated. | [optional] +**fki_invoice_id** | **int** | The unique ID of the Invoice. | [optional] +**fki_buyercontract_id** | **int** | The unique ID of the Buyercontract | [optional] +**fki_franchisebroker_id** | **int** | The unique ID of the Franchisebroker | [optional] +**fki_franchiseagence_id** | **int** | The unique ID of the Franchiseagence | [optional] +**fki_franchiseoffice_id** | **int** | The unique ID of the Franchisereoffice | [optional] +**fki_franchisefranchise_id** | **int** | The unique ID of the Franchisefranchise | [optional] +**fki_franchisecomplaint_id** | **int** | The unique ID of the Franchisecomplaint | [optional] +**fki_lead_id** | **int** | The unique ID of the Lead | [optional] +**fki_marketingprogram_id** | **int** | The unique ID of the Marketingprogram | [optional] +**fki_marketingfollow_id** | **int** | The unique ID of the Marketingfollow | [optional] +**fki_notary_id** | **int** | The unique ID of the Notary. | [optional] +**fki_officetaxreport_id** | **int** | The unique ID of the Officetaxreport | [optional] +**fki_otherincome_id** | **int** | The unique ID of the Otherincome | [optional] +**fki_paymentpreparation_id** | **int** | The unique ID of the Paymentpreparation | [optional] +**fki_purchase_id** | **int** | The unique ID of the Purchase | [optional] +**fki_salary_id** | **int** | The unique ID of the Salary | [optional] +**fki_supplier_id** | **int** | The unique ID of the Supplier. | [optional] +**fki_tranqcontract_id** | **int** | The unique ID of the Tranqcontract | [optional] +**fki_template_id** | **int** | The unique ID of the Template | [optional] +**fki_inscriptionchecklist_id** | **int** | The unique ID of the Inscriptionchecklist | [optional] +**fki_folder_id** | **int** | The unique ID of the Folder | [optional] +**fki_rejectedoffertopurchase_id** | **int** | The unique ID of the Rejectedoffertopurchase | [optional] +**fki_disclosure_id** | **int** | The unique ID of the Disclosure | [optional] +**fki_reconciliation_id** | **int** | The unique ID of the Reconciliation | [optional] +**fki_ezsigndocument_id_reference** | **int** | The unique ID of the Ezsigndocument | [optional] +**e_attachment_documenttype** | [**FieldEAttachmentDocumenttype**](FieldEAttachmentDocumenttype.md) | | +**s_attachment_name** | **str** | The name of the Attachment | +**e_attachment_privacy** | [**FieldEAttachmentPrivacy**](FieldEAttachmentPrivacy.md) | | +**fki_user_id_specific** | **int** | The unique ID of the User | [optional] +**e_attachment_type** | [**FieldEAttachmentType**](FieldEAttachmentType.md) | | +**i_attachment_size** | **int** | The size of the Attachment | +**i_attachment_ed_mmoduleflag** | **int** | The edmmoduleflag of the Attachment | [optional] +**s_attachment_md5** | **str** | The md5 of the Attachment | +**b_attachment_deleted** | **bool** | Whether if it's deleted | +**b_attachment_valid** | **bool** | Whether if it's valid | +**e_attachment_verified** | [**FieldEAttachmentVerified**](FieldEAttachmentVerified.md) | | +**t_attachment_rejectioncomment** | **str** | The rejectioncomment of the Attachment | [optional] +**fki_user_id_owner** | **int** | The unique ID of the User | [optional] +**obj_audit** | [**CommonAudit**](CommonAudit.md) | | [optional] +**obj_attachment_proof** | [**AttachmentResponseCompound**](AttachmentResponseCompound.md) | | [optional] +**obj_attachment_proofdocument** | [**AttachmentResponseCompound**](AttachmentResponseCompound.md) | | [optional] +**a_obj_attachment_attachment** | [**List[AttachmentResponseCompound]**](AttachmentResponseCompound.md) | | [optional] +**a_obj_attachment_version** | [**List[AttachmentResponseCompound]**](AttachmentResponseCompound.md) | | [optional] + +## Example + +```python +from eZmaxApi.models.custom_attachment_response import CustomAttachmentResponse + +# TODO update the JSON string below +json = "{}" +# create an instance of CustomAttachmentResponse from a JSON string +custom_attachment_response_instance = CustomAttachmentResponse.from_json(json) +# print the JSON string representation of the object +print CustomAttachmentResponse.to_json() + +# convert the object into a dict +custom_attachment_response_dict = custom_attachment_response_instance.to_dict() +# create an instance of CustomAttachmentResponse from a dict +custom_attachment_response_form_dict = custom_attachment_response.from_dict(custom_attachment_response_dict) +``` +[[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/docs/CustomAttachmentdocumenttypeResponse.md b/docs/CustomAttachmentdocumenttypeResponse.md new file mode 100644 index 000000000..a5503ec83 --- /dev/null +++ b/docs/CustomAttachmentdocumenttypeResponse.md @@ -0,0 +1,31 @@ +# CustomAttachmentdocumenttypeResponse + +An Attachmentdocumenttype + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**e_attachment_documenttype** | [**FieldEAttachmentDocumenttype**](FieldEAttachmentDocumenttype.md) | | +**a_obj_attachment** | [**List[CustomAttachmentResponse]**](CustomAttachmentResponse.md) | | + +## Example + +```python +from eZmaxApi.models.custom_attachmentdocumenttype_response import CustomAttachmentdocumenttypeResponse + +# TODO update the JSON string below +json = "{}" +# create an instance of CustomAttachmentdocumenttypeResponse from a JSON string +custom_attachmentdocumenttype_response_instance = CustomAttachmentdocumenttypeResponse.from_json(json) +# print the JSON string representation of the object +print CustomAttachmentdocumenttypeResponse.to_json() + +# convert the object into a dict +custom_attachmentdocumenttype_response_dict = custom_attachmentdocumenttype_response_instance.to_dict() +# create an instance of CustomAttachmentdocumenttypeResponse from a dict +custom_attachmentdocumenttype_response_form_dict = custom_attachmentdocumenttype_response.from_dict(custom_attachmentdocumenttype_response_dict) +``` +[[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/docs/CustomAutocompleteElementResponse.md b/docs/CustomAutocompleteElementResponse.md index cbce751e3..752801e60 100644 --- a/docs/CustomAutocompleteElementResponse.md +++ b/docs/CustomAutocompleteElementResponse.md @@ -3,6 +3,7 @@ Generic AutocompleteElement Response ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **s_category** | **str** | The Category for the dropdown or an empty string if not categorized | diff --git a/docs/CustomCommunicationListElementResponse.md b/docs/CustomCommunicationListElementResponse.md index e3516ba75..23afb9c70 100644 --- a/docs/CustomCommunicationListElementResponse.md +++ b/docs/CustomCommunicationListElementResponse.md @@ -3,6 +3,7 @@ A Communication List Element ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_communication_id** | **int** | The unique ID of the Communication. | diff --git a/docs/CustomCommunicationattachmentRequest.md b/docs/CustomCommunicationattachmentRequest.md index 2b1599a91..15032acac 100644 --- a/docs/CustomCommunicationattachmentRequest.md +++ b/docs/CustomCommunicationattachmentRequest.md @@ -3,6 +3,7 @@ A Custom Communicationattachment Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_communicationattachment** | [**CommunicationattachmentRequestCompound**](CommunicationattachmentRequestCompound.md) | | [optional] diff --git a/docs/CustomCommunicationrecipientsgroupResponse.md b/docs/CustomCommunicationrecipientsgroupResponse.md index b1c33bb40..8c01b6b5a 100644 --- a/docs/CustomCommunicationrecipientsgroupResponse.md +++ b/docs/CustomCommunicationrecipientsgroupResponse.md @@ -3,6 +3,7 @@ Generic CommunicationrecipientsGroup Response ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **s_communicationrecipientsgroup_label** | **str** | The label for the Communicationrecipientsgroup | diff --git a/docs/CustomCommunicationrecipientsrecipientResponse.md b/docs/CustomCommunicationrecipientsrecipientResponse.md index 867edc948..0deb2b517 100644 --- a/docs/CustomCommunicationrecipientsrecipientResponse.md +++ b/docs/CustomCommunicationrecipientsrecipientResponse.md @@ -3,6 +3,7 @@ Generic AutocompleteElement Response ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **fki_agent_id** | **int** | The unique ID of the Agent. | [optional] diff --git a/docs/CustomCommunicationsenderRequest.md b/docs/CustomCommunicationsenderRequest.md index 0699e753e..3c1e53759 100644 --- a/docs/CustomCommunicationsenderRequest.md +++ b/docs/CustomCommunicationsenderRequest.md @@ -3,11 +3,13 @@ A Communicationsender Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **fki_agent_id** | **int** | The unique ID of the Agent. | [optional] **fki_broker_id** | **int** | The unique ID of the Broker. | [optional] **fki_mailboxshared_id** | **int** | The unique ID of the Mailboxshared | [optional] +**fki_phonelineshared_id** | **int** | The unique ID of the Phonelineshared | [optional] **fki_user_id** | **int** | The unique ID of the User | [optional] ## Example diff --git a/docs/CustomCommunicationsenderResponse.md b/docs/CustomCommunicationsenderResponse.md index eb68223d9..ad99c5f8a 100644 --- a/docs/CustomCommunicationsenderResponse.md +++ b/docs/CustomCommunicationsenderResponse.md @@ -3,16 +3,19 @@ Generic Communicationsender Response ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **fki_agent_id** | **int** | The unique ID of the Agent. | [optional] **fki_broker_id** | **int** | The unique ID of the Broker. | [optional] **fki_user_id** | **int** | The unique ID of the User | [optional] **fki_mailboxshared_id** | **int** | The unique ID of the Mailboxshared | [optional] +**fki_phonelineshared_id** | **int** | The unique ID of the Phonelineshared | [optional] **e_communicationsender_objecttype** | **str** | | **obj_contact_name** | [**CustomContactNameResponse**](CustomContactNameResponse.md) | | -**s_email_address** | **str** | The email address. | [optional] -**s_phone_e164** | **str** | A phone number in E.164 Format | [optional] +**obj_email** | [**EmailResponseCompound**](EmailResponseCompound.md) | | [optional] +**obj_phone_fax** | [**PhoneResponseCompound**](PhoneResponseCompound.md) | | [optional] +**obj_phone_sms** | [**PhoneResponseCompound**](PhoneResponseCompound.md) | | [optional] ## Example diff --git a/docs/CustomContactNameResponse.md b/docs/CustomContactNameResponse.md index 406f0c03f..951e01b3e 100644 --- a/docs/CustomContactNameResponse.md +++ b/docs/CustomContactNameResponse.md @@ -3,6 +3,7 @@ A Custom ContactName Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **s_contact_firstname** | **str** | The First name of the contact | [optional] diff --git a/docs/CustomCreditcardtransactionResponse.md b/docs/CustomCreditcardtransactionResponse.md index 8d28ffe8f..95f2a7b95 100644 --- a/docs/CustomCreditcardtransactionResponse.md +++ b/docs/CustomCreditcardtransactionResponse.md @@ -3,6 +3,7 @@ A custom Creditcardtransaction Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **e_creditcardtype_codename** | [**FieldECreditcardtypeCodename**](FieldECreditcardtypeCodename.md) | | diff --git a/docs/CustomDropdownElementRequest.md b/docs/CustomDropdownElementRequest.md index 8ba800588..b9d77faf7 100644 --- a/docs/CustomDropdownElementRequest.md +++ b/docs/CustomDropdownElementRequest.md @@ -3,6 +3,7 @@ Generic DropdownElement Request ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **s_label** | **str** | The Description of the element | diff --git a/docs/CustomDropdownElementRequestCompound.md b/docs/CustomDropdownElementRequestCompound.md index 2619af2d2..4efdba080 100644 --- a/docs/CustomDropdownElementRequestCompound.md +++ b/docs/CustomDropdownElementRequestCompound.md @@ -3,6 +3,7 @@ A Generic DropdownElement Object and children to create a complete structure ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **s_label** | **str** | The Description of the element | diff --git a/docs/CustomDropdownElementResponse.md b/docs/CustomDropdownElementResponse.md index cbd8a4b50..2628b5307 100644 --- a/docs/CustomDropdownElementResponse.md +++ b/docs/CustomDropdownElementResponse.md @@ -3,6 +3,7 @@ Generic DropdownElement Response ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **s_label** | **str** | The Description of the element | diff --git a/docs/CustomDropdownElementResponseCompound.md b/docs/CustomDropdownElementResponseCompound.md index 811868934..fe8bf08c6 100644 --- a/docs/CustomDropdownElementResponseCompound.md +++ b/docs/CustomDropdownElementResponseCompound.md @@ -3,6 +3,7 @@ A Generic DropdownElement Object and children to create a complete structure ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **s_label** | **str** | The Description of the element | diff --git a/docs/CustomEzmaxinvoicingEzsigndocumentResponse.md b/docs/CustomEzmaxinvoicingEzsigndocumentResponse.md index 7c2dc0c9c..b90c22b2c 100644 --- a/docs/CustomEzmaxinvoicingEzsigndocumentResponse.md +++ b/docs/CustomEzmaxinvoicingEzsigndocumentResponse.md @@ -3,6 +3,7 @@ An EzmaxinvoicingEzsigndocument object containing information about the Ezmaxinvoicing for an Ezsigndocument ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **fki_ezsignfolder_id** | **int** | The unique ID of the Ezsignfolder | diff --git a/docs/CustomEzmaxinvoicingEzsignfolderResponse.md b/docs/CustomEzmaxinvoicingEzsignfolderResponse.md index 567c6bb80..c24204760 100644 --- a/docs/CustomEzmaxinvoicingEzsignfolderResponse.md +++ b/docs/CustomEzmaxinvoicingEzsignfolderResponse.md @@ -3,6 +3,7 @@ An EzmaxinvoicingEzsignfolder object containing information about the Ezmaxinvoicing for an Ezsignfolder ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **fki_ezsignfolder_id** | **int** | The unique ID of the Ezsignfolder | diff --git a/docs/CustomEzmaxpricingResponse.md b/docs/CustomEzmaxpricingResponse.md index 040fdd6e8..ac157857d 100644 --- a/docs/CustomEzmaxpricingResponse.md +++ b/docs/CustomEzmaxpricingResponse.md @@ -3,6 +3,7 @@ A Custom Ezmaxpricing Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezmaxpricing_id** | **int** | The unique ID of the Ezmaxpricing | diff --git a/docs/CustomEzsigndocumentEzsignsignaturesAutomaticResponse.md b/docs/CustomEzsigndocumentEzsignsignaturesAutomaticResponse.md index a9bc5808b..6e0f2f7cb 100644 --- a/docs/CustomEzsigndocumentEzsignsignaturesAutomaticResponse.md +++ b/docs/CustomEzsigndocumentEzsignsignaturesAutomaticResponse.md @@ -3,6 +3,7 @@ An Ezsigndocument Object in the context of an EzsignsignaturesAutomatic path ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsigndocument_id** | **int** | The unique ID of the Ezsigndocument | diff --git a/docs/CustomEzsignfolderEzsignsignaturesAutomaticResponse.md b/docs/CustomEzsignfolderEzsignsignaturesAutomaticResponse.md index 669b87c7f..6ad517d38 100644 --- a/docs/CustomEzsignfolderEzsignsignaturesAutomaticResponse.md +++ b/docs/CustomEzsignfolderEzsignsignaturesAutomaticResponse.md @@ -3,6 +3,7 @@ An Ezsignfolder Object in the context of an EzsignsignaturesAutomatic path ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsignfolder_id** | **int** | The unique ID of the Ezsignfolder | diff --git a/docs/CustomEzsignfoldersignerassociationActionableElementResponse.md b/docs/CustomEzsignfoldersignerassociationActionableElementResponse.md index 9b2c04f97..7b726ad9b 100644 --- a/docs/CustomEzsignfoldersignerassociationActionableElementResponse.md +++ b/docs/CustomEzsignfoldersignerassociationActionableElementResponse.md @@ -3,6 +3,7 @@ A Ezsignfoldersignerassociation Object with actionable elements ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsignfoldersignerassociation_id** | **int** | The unique ID of the Ezsignfoldersignerassociation | diff --git a/docs/CustomEzsignfoldersignerassociationmessageRequest.md b/docs/CustomEzsignfoldersignerassociationmessageRequest.md index f81b00265..9208eff18 100644 --- a/docs/CustomEzsignfoldersignerassociationmessageRequest.md +++ b/docs/CustomEzsignfoldersignerassociationmessageRequest.md @@ -3,6 +3,7 @@ A custom message Object in the context of an Ezsignfolder's send function ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **fki_ezsignfoldersignerassociation_id** | **int** | The unique ID of the Ezsignfoldersignerassociation | diff --git a/docs/CustomEzsignfoldersignerassociationstatusResponse.md b/docs/CustomEzsignfoldersignerassociationstatusResponse.md index ef68da9c6..8e1bfb4c2 100644 --- a/docs/CustomEzsignfoldersignerassociationstatusResponse.md +++ b/docs/CustomEzsignfoldersignerassociationstatusResponse.md @@ -3,6 +3,7 @@ A Ezsignfoldersignerassociationstatus Object and children to create a complete structure ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **fki_ezsignfoldersignerassociation_id** | **int** | The unique ID of the Ezsignfoldersignerassociation | diff --git a/docs/CustomEzsignfoldertransmissionResponse.md b/docs/CustomEzsignfoldertransmissionResponse.md index a4b224269..6030544cd 100644 --- a/docs/CustomEzsignfoldertransmissionResponse.md +++ b/docs/CustomEzsignfoldertransmissionResponse.md @@ -3,6 +3,7 @@ An Ezsignfolder Object in the context of an Ezsignbulksendtransmission ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsignfolder_id** | **int** | The unique ID of the Ezsignfolder | diff --git a/docs/CustomEzsignfoldertransmissionSignerResponse.md b/docs/CustomEzsignfoldertransmissionSignerResponse.md index d10f02ef1..e50b533a9 100644 --- a/docs/CustomEzsignfoldertransmissionSignerResponse.md +++ b/docs/CustomEzsignfoldertransmissionSignerResponse.md @@ -3,6 +3,7 @@ A form Signer Object in the context of an Ezsignfoldertransmissions ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **fki_user_id** | **int** | The unique ID of the User | [optional] diff --git a/docs/CustomEzsignfoldertypeResponse.md b/docs/CustomEzsignfoldertypeResponse.md index c7bbfe3d2..732b33847 100644 --- a/docs/CustomEzsignfoldertypeResponse.md +++ b/docs/CustomEzsignfoldertypeResponse.md @@ -3,12 +3,16 @@ A Custom Ezsignfoldertype Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsignfoldertype_id** | **int** | The unique ID of the Ezsignfoldertype. | **s_ezsignfoldertype_name_x** | **str** | The name of the Ezsignfoldertype in the language of the requester | [optional] -**b_ezsignfoldertype_includeproofsigner** | **bool** | Whether we include the proof with the signed Ezsigndocument for Ezsignsigners | [optional] +**b_ezsignfoldertype_sendproofezsignsigner** | **bool** | Whether we send the proof in the email to Ezsignsigner | [optional] +**b_ezsignfoldertype_includeproofsigner** | **bool** | THIS FIELD WILL BE DELETED. Whether we include the proof with the signed Ezsigndocument for Ezsignsigners | [optional] **b_ezsignfoldertype_includeproofuser** | **bool** | Whether we include the proof with the signed Ezsigndocument for users | [optional] +**b_ezsignfoldertype_allowdownloadattachmentezsignsigner** | **bool** | Whether we allow the Ezsigndocument to be downloaded by an Ezsignsigner | [optional] +**b_ezsignfoldertype_allowdownloadproofezsignsigner** | **bool** | Whether we allow the proof to be downloaded by an Ezsignsigner | [optional] **b_ezsignfoldertype_delegate** | **bool** | Wheter if delegation of signature is allowed to another user or not | [optional] **b_ezsignfoldertype_reassign** | **bool** | Wheter if Reassignment of signature is allowed to another signatory or not | [optional] diff --git a/docs/CustomEzsignformfieldRequest.md b/docs/CustomEzsignformfieldRequest.md index ab558bec4..a1cbb69c3 100644 --- a/docs/CustomEzsignformfieldRequest.md +++ b/docs/CustomEzsignformfieldRequest.md @@ -3,6 +3,7 @@ A Custom Ezsignformfield Object to fill an Ezsignform using submitForm ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsignformfield_id** | **int** | The unique ID of the Ezsignformfield | [optional] diff --git a/docs/CustomEzsignformfielderrorResponse.md b/docs/CustomEzsignformfielderrorResponse.md index b33580bd5..cf82374cf 100644 --- a/docs/CustomEzsignformfielderrorResponse.md +++ b/docs/CustomEzsignformfielderrorResponse.md @@ -3,6 +3,7 @@ A Custom Ezsignformfield Object to contain an error list ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **s_ezsignformfield_label** | **str** | The Label for the Ezsignformfield | diff --git a/docs/CustomEzsignformfielderrortestResponse.md b/docs/CustomEzsignformfielderrortestResponse.md index 963440654..0be792125 100644 --- a/docs/CustomEzsignformfielderrortestResponse.md +++ b/docs/CustomEzsignformfielderrortestResponse.md @@ -3,6 +3,7 @@ A Custom Ezsignformfielderrortest Object to contain the detail of the test error ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **s_ezsignformfielderrortest_name** | **str** | The name of the test | diff --git a/docs/CustomEzsignformfieldgroupRequest.md b/docs/CustomEzsignformfieldgroupRequest.md index 8575ad3cd..520b22399 100644 --- a/docs/CustomEzsignformfieldgroupRequest.md +++ b/docs/CustomEzsignformfieldgroupRequest.md @@ -3,6 +3,7 @@ A Custom Ezsignformfieldgroup Object to fill an Ezsignform using submitForm ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsignformfieldgroup_id** | **int** | The unique ID of the Ezsignformfieldgroup | [optional] diff --git a/docs/CustomEzsignsignatureEzsignsignaturesAutomaticResponse.md b/docs/CustomEzsignsignatureEzsignsignaturesAutomaticResponse.md index e88e62f92..514023b5d 100644 --- a/docs/CustomEzsignsignatureEzsignsignaturesAutomaticResponse.md +++ b/docs/CustomEzsignsignatureEzsignsignaturesAutomaticResponse.md @@ -3,6 +3,7 @@ An Ezsignsignature Object in the context of an EzsignsignaturesAutomatic path ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsignsignature_id** | **int** | The unique ID of the Ezsignsignature | diff --git a/docs/CustomEzsignsignaturestatusResponse.md b/docs/CustomEzsignsignaturestatusResponse.md index fa4fb912b..4c09141d7 100644 --- a/docs/CustomEzsignsignaturestatusResponse.md +++ b/docs/CustomEzsignsignaturestatusResponse.md @@ -3,6 +3,7 @@ A Ezsignsignaturestatus Object and children to create a complete structure ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **e_ezsignsignaturestatus_steptype** | **str** | Type of step | diff --git a/docs/CustomFormDataDocumentResponse.md b/docs/CustomFormDataDocumentResponse.md index 2a734e22e..1453c2e12 100644 --- a/docs/CustomFormDataDocumentResponse.md +++ b/docs/CustomFormDataDocumentResponse.md @@ -3,6 +3,7 @@ A form Data Document Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsigndocument_id** | **int** | The unique ID of the Ezsigndocument | diff --git a/docs/CustomFormDataEzsignformfieldResponse.md b/docs/CustomFormDataEzsignformfieldResponse.md index 216ccac4c..84ca1553a 100644 --- a/docs/CustomFormDataEzsignformfieldResponse.md +++ b/docs/CustomFormDataEzsignformfieldResponse.md @@ -3,6 +3,7 @@ An Ezsignformfield Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **s_ezsignformfield_label** | **str** | The Label for the Ezsignformfield | diff --git a/docs/CustomFormDataEzsignformfieldgroupResponse.md b/docs/CustomFormDataEzsignformfieldgroupResponse.md index 9a00dab47..93f8da035 100644 --- a/docs/CustomFormDataEzsignformfieldgroupResponse.md +++ b/docs/CustomFormDataEzsignformfieldgroupResponse.md @@ -3,6 +3,7 @@ An FormDataSigner->Ezsignformfieldgroup Object and children to create a complete structure ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **s_ezsignformfieldgroup_label** | **str** | The Label for the Ezsignformfieldgroup | diff --git a/docs/CustomFormDataSignerResponse.md b/docs/CustomFormDataSignerResponse.md index 7c42d131a..bc613a130 100644 --- a/docs/CustomFormDataSignerResponse.md +++ b/docs/CustomFormDataSignerResponse.md @@ -3,6 +3,7 @@ A form Data Signer Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **fki_ezsignfoldersignerassociation_id** | **int** | The unique ID of the Ezsignfoldersignerassociation | diff --git a/docs/CustomFormsDataFolderResponse.md b/docs/CustomFormsDataFolderResponse.md index 0995fa8af..1317faad4 100644 --- a/docs/CustomFormsDataFolderResponse.md +++ b/docs/CustomFormsDataFolderResponse.md @@ -3,6 +3,7 @@ A forms Data Folder Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsignfolder_id** | **int** | The unique ID of the Ezsignfolder | diff --git a/docs/CustomImportEzsigntemplatepackageRelationRequest.md b/docs/CustomImportEzsigntemplatepackageRelationRequest.md index 462ef65e3..9cbc90745 100644 --- a/docs/CustomImportEzsigntemplatepackageRelationRequest.md +++ b/docs/CustomImportEzsigntemplatepackageRelationRequest.md @@ -3,6 +3,7 @@ The object used in /1/object/ezsignfolder/{pkiEzsignfolderID}/importEzsigntemplatepackage Request ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **fki_ezsigntemplatepackagesigner_id** | **int** | The unique ID of the Ezsigntemplatepackagesigner | [optional] diff --git a/docs/CustomNotificationsubsectiongetnotificationtestsResponse.md b/docs/CustomNotificationsubsectiongetnotificationtestsResponse.md index 70e9a8a78..26f6ba1c9 100644 --- a/docs/CustomNotificationsubsectiongetnotificationtestsResponse.md +++ b/docs/CustomNotificationsubsectiongetnotificationtestsResponse.md @@ -3,6 +3,7 @@ A Notificationsubsection Object in the context of getNotificationtests ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_notificationsubsection_id** | **int** | The unique ID of the Notificationsubsection | diff --git a/docs/CustomNotificationtestgetnotificationtestsResponse.md b/docs/CustomNotificationtestgetnotificationtestsResponse.md index 1711bc333..607f617f2 100644 --- a/docs/CustomNotificationtestgetnotificationtestsResponse.md +++ b/docs/CustomNotificationtestgetnotificationtestsResponse.md @@ -3,6 +3,7 @@ A Notificationtest Object in the context of getNotificationtests ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_notificationtest_id** | **int** | The unique ID of the Notificationtest | diff --git a/docs/CustomUserResponse.md b/docs/CustomUserResponse.md index 327664e84..808f7683a 100644 --- a/docs/CustomUserResponse.md +++ b/docs/CustomUserResponse.md @@ -3,6 +3,7 @@ A User Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_user_id** | **int** | The unique ID of the User | diff --git a/docs/CustomWebhookResponse.md b/docs/CustomWebhookResponse.md index 2c279eb48..e6a1e321c 100644 --- a/docs/CustomWebhookResponse.md +++ b/docs/CustomWebhookResponse.md @@ -3,6 +3,7 @@ A custom Webhook object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_webhook_id** | **int** | The unique ID of the Webhook | @@ -14,7 +15,10 @@ Name | Type | Description | Notes **e_webhook_managementevent** | [**FieldEWebhookManagementevent**](FieldEWebhookManagementevent.md) | | [optional] **s_webhook_url** | **str** | The URL of the Webhook callback | **s_webhook_emailfailed** | **str** | The email that will receive the Webhook in case all attempts fail | +**s_webhook_apikey** | **str** | The Apikey for the Webhook. This will be hidden if we are not creating or regenerating the Apikey. | [optional] +**s_webhook_secret** | **str** | The Secret for the Webhook. This will be hidden if we are not creating or regenerating the Apikey. | [optional] **b_webhook_isactive** | **bool** | Whether the Webhook is active or not | +**b_webhook_issigned** | **bool** | Whether the requests will be signed or not | **b_webhook_skipsslvalidation** | **bool** | Wheter the server's SSL certificate should be validated or not. Not recommended to skip for production use | **pks_customer_code** | **str** | The customer code assigned to your account | **b_webhook_test** | **bool** | Wheter the webhook received is a manual test or a real event | diff --git a/docs/CustomWebhooklogResponse.md b/docs/CustomWebhooklogResponse.md index 4f20a24ae..f9e98a057 100644 --- a/docs/CustomWebhooklogResponse.md +++ b/docs/CustomWebhooklogResponse.md @@ -3,6 +3,7 @@ A custom Webhooklog object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **dt_webhooklog_date** | **str** | The date and time at which the Webhooklog happened. | diff --git a/docs/CustomWordPositionOccurenceResponse.md b/docs/CustomWordPositionOccurenceResponse.md index 4c643876b..1c883a99e 100644 --- a/docs/CustomWordPositionOccurenceResponse.md +++ b/docs/CustomWordPositionOccurenceResponse.md @@ -3,6 +3,7 @@ A Word Position Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **i_page** | **int** | The page where the word occurence was found | [optional] diff --git a/docs/CustomWordPositionWordResponse.md b/docs/CustomWordPositionWordResponse.md index a00702688..acde8e425 100644 --- a/docs/CustomWordPositionWordResponse.md +++ b/docs/CustomWordPositionWordResponse.md @@ -3,6 +3,7 @@ A Word Position Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **s_word** | **str** | The searched word | diff --git a/docs/DepartmentAutocompleteElementResponse.md b/docs/DepartmentAutocompleteElementResponse.md index c8d2091a2..27d45ccc9 100644 --- a/docs/DepartmentAutocompleteElementResponse.md +++ b/docs/DepartmentAutocompleteElementResponse.md @@ -3,6 +3,7 @@ A Department AutocompleteElement Response ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **s_company_name_x** | **str** | The Name of the Company in the language of the requester | diff --git a/docs/DepartmentGetAutocompleteV2Response.md b/docs/DepartmentGetAutocompleteV2Response.md index a4c06e19c..ae1eb5d29 100644 --- a/docs/DepartmentGetAutocompleteV2Response.md +++ b/docs/DepartmentGetAutocompleteV2Response.md @@ -3,6 +3,7 @@ Response for GET /2/object/department/getAutocomplete ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/DepartmentGetAutocompleteV2ResponseMPayload.md b/docs/DepartmentGetAutocompleteV2ResponseMPayload.md index 4d42950db..7d04094f3 100644 --- a/docs/DepartmentGetAutocompleteV2ResponseMPayload.md +++ b/docs/DepartmentGetAutocompleteV2ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for POST /2/object/department/getAutocomplete ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_department** | [**List[DepartmentAutocompleteElementResponse]**](DepartmentAutocompleteElementResponse.md) | An array of Department autocomplete element response. | diff --git a/docs/ElectronicfundstransferGetCommunicationListV1Response.md b/docs/ElectronicfundstransferGetCommunicationListV1Response.md index 66d7bc0b4..c7a345016 100644 --- a/docs/ElectronicfundstransferGetCommunicationListV1Response.md +++ b/docs/ElectronicfundstransferGetCommunicationListV1Response.md @@ -3,6 +3,7 @@ Response for GET /1/object/electronicfundstransfer/{pkiElectronicfundstransferID}/getCommunicationList ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayloadGetList**](CommonResponseObjDebugPayloadGetList.md) | | diff --git a/docs/ElectronicfundstransferGetCommunicationListV1ResponseMPayload.md b/docs/ElectronicfundstransferGetCommunicationListV1ResponseMPayload.md index d8216bead..f17e33e0d 100644 --- a/docs/ElectronicfundstransferGetCommunicationListV1ResponseMPayload.md +++ b/docs/ElectronicfundstransferGetCommunicationListV1ResponseMPayload.md @@ -3,6 +3,7 @@ Response for GET /1/object/electronicfundstransfer/{pkiElectronicfundstransferID}/getCommunicationList ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_communication** | [**List[CustomCommunicationListElementResponse]**](CustomCommunicationListElementResponse.md) | | diff --git a/docs/EmailRequest.md b/docs/EmailRequest.md index 9604f9279..1af7ca483 100644 --- a/docs/EmailRequest.md +++ b/docs/EmailRequest.md @@ -3,6 +3,7 @@ An Email Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_email_id** | **int** | The unique ID of the Email | [optional] diff --git a/docs/EmailRequestCompound.md b/docs/EmailRequestCompound.md index 8c38f0d20..51847a4ec 100644 --- a/docs/EmailRequestCompound.md +++ b/docs/EmailRequestCompound.md @@ -3,6 +3,7 @@ An Email Object and children to create a complete structure ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_email_id** | **int** | The unique ID of the Email | [optional] diff --git a/docs/EmailResponse.md b/docs/EmailResponse.md index fde5befd8..2597d44cf 100644 --- a/docs/EmailResponse.md +++ b/docs/EmailResponse.md @@ -3,6 +3,7 @@ An Email Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_email_id** | **int** | The unique ID of the Email | diff --git a/docs/EmailResponseCompound.md b/docs/EmailResponseCompound.md index db530b903..04a347db7 100644 --- a/docs/EmailResponseCompound.md +++ b/docs/EmailResponseCompound.md @@ -3,6 +3,7 @@ An Email Object and children to create a complete structure ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_email_id** | **int** | The unique ID of the Email | diff --git a/docs/EmailtypeAutocompleteElementResponse.md b/docs/EmailtypeAutocompleteElementResponse.md index 982f709d5..29f1d693b 100644 --- a/docs/EmailtypeAutocompleteElementResponse.md +++ b/docs/EmailtypeAutocompleteElementResponse.md @@ -3,6 +3,7 @@ A Emailtype AutocompleteElement Response ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_emailtype_id** | **int** | The unique ID of the Emailtype. Valid values: |Value|Description| |-|-| |1|Office| |2|Home| | diff --git a/docs/EmailtypeGetAutocompleteV2Response.md b/docs/EmailtypeGetAutocompleteV2Response.md index 44e3dbe1a..67463a96c 100644 --- a/docs/EmailtypeGetAutocompleteV2Response.md +++ b/docs/EmailtypeGetAutocompleteV2Response.md @@ -3,6 +3,7 @@ Response for GET /2/object/emailtype/getAutocomplete ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EmailtypeGetAutocompleteV2ResponseMPayload.md b/docs/EmailtypeGetAutocompleteV2ResponseMPayload.md index 38b394ca5..6041cb4ae 100644 --- a/docs/EmailtypeGetAutocompleteV2ResponseMPayload.md +++ b/docs/EmailtypeGetAutocompleteV2ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for POST /2/object/emailtype/getAutocomplete ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_emailtype** | [**List[EmailtypeAutocompleteElementResponse]**](EmailtypeAutocompleteElementResponse.md) | An array of Emailtype autocomplete element response. | diff --git a/docs/EnumFontunderline.md b/docs/EnumFontunderline.md index 827a73735..c3d4c203c 100644 --- a/docs/EnumFontunderline.md +++ b/docs/EnumFontunderline.md @@ -3,6 +3,7 @@ The Font Underline style ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/EnumFontweight.md b/docs/EnumFontweight.md index fb69f1582..57a255391 100644 --- a/docs/EnumFontweight.md +++ b/docs/EnumFontweight.md @@ -3,6 +3,7 @@ The Font Weight ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/EnumHorizontalalignment.md b/docs/EnumHorizontalalignment.md index addc457ca..09f8c3bc5 100644 --- a/docs/EnumHorizontalalignment.md +++ b/docs/EnumHorizontalalignment.md @@ -3,6 +3,7 @@ The Horizontal alignment ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/EnumTextvalidation.md b/docs/EnumTextvalidation.md index 27b3f9d4d..32f5b2a91 100644 --- a/docs/EnumTextvalidation.md +++ b/docs/EnumTextvalidation.md @@ -3,6 +3,7 @@ The text validation ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/EnumVerticalalignment.md b/docs/EnumVerticalalignment.md index 84535417c..ea1ba8681 100644 --- a/docs/EnumVerticalalignment.md +++ b/docs/EnumVerticalalignment.md @@ -3,6 +3,7 @@ The Vertical alignment ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/EzmaxinvoicingAutocompleteElementResponse.md b/docs/EzmaxinvoicingAutocompleteElementResponse.md index 6f2e583ec..c82f22c23 100644 --- a/docs/EzmaxinvoicingAutocompleteElementResponse.md +++ b/docs/EzmaxinvoicingAutocompleteElementResponse.md @@ -3,6 +3,7 @@ A Ezmaxinvoicing AutocompleteElement Response ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **yyyymm_ezmaxinvoicing** | **str** | The YYYYMM period of the Ezmaxinvoicing | diff --git a/docs/EzmaxinvoicingGetAutocompleteV2Response.md b/docs/EzmaxinvoicingGetAutocompleteV2Response.md index 100a13a20..1667eeaea 100644 --- a/docs/EzmaxinvoicingGetAutocompleteV2Response.md +++ b/docs/EzmaxinvoicingGetAutocompleteV2Response.md @@ -3,6 +3,7 @@ Response for GET /2/object/ezmaxinvoicing/getAutocomplete ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzmaxinvoicingGetAutocompleteV2ResponseMPayload.md b/docs/EzmaxinvoicingGetAutocompleteV2ResponseMPayload.md index ecc5a0215..147a84f72 100644 --- a/docs/EzmaxinvoicingGetAutocompleteV2ResponseMPayload.md +++ b/docs/EzmaxinvoicingGetAutocompleteV2ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for POST /2/object/ezmaxinvoicing/getAutocomplete ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_ezmaxinvoicing** | [**List[EzmaxinvoicingAutocompleteElementResponse]**](EzmaxinvoicingAutocompleteElementResponse.md) | An array of Ezmaxinvoicing autocomplete element response. | diff --git a/docs/EzmaxinvoicingGetObjectV2Response.md b/docs/EzmaxinvoicingGetObjectV2Response.md index 9357475a6..a42e49cf7 100644 --- a/docs/EzmaxinvoicingGetObjectV2Response.md +++ b/docs/EzmaxinvoicingGetObjectV2Response.md @@ -3,6 +3,7 @@ Response for GET /2/object/ezmaxinvoicing/{pkiEzmaxinvoicingID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzmaxinvoicingGetObjectV2ResponseMPayload.md b/docs/EzmaxinvoicingGetObjectV2ResponseMPayload.md index 02dae77b9..6066350cf 100644 --- a/docs/EzmaxinvoicingGetObjectV2ResponseMPayload.md +++ b/docs/EzmaxinvoicingGetObjectV2ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for GET /2/object/ezmaxinvoicing/{pkiEzmaxinvoicingID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_ezmaxinvoicing** | [**EzmaxinvoicingResponseCompound**](EzmaxinvoicingResponseCompound.md) | | diff --git a/docs/EzmaxinvoicingGetProvisionalV1Response.md b/docs/EzmaxinvoicingGetProvisionalV1Response.md index 3d7b291e7..b61c973d8 100644 --- a/docs/EzmaxinvoicingGetProvisionalV1Response.md +++ b/docs/EzmaxinvoicingGetProvisionalV1Response.md @@ -3,6 +3,7 @@ Response for GET /1/object/ezmaxinvoicing/getProvisional ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzmaxinvoicingGetProvisionalV1ResponseMPayload.md b/docs/EzmaxinvoicingGetProvisionalV1ResponseMPayload.md index 156d57966..d8918662b 100644 --- a/docs/EzmaxinvoicingGetProvisionalV1ResponseMPayload.md +++ b/docs/EzmaxinvoicingGetProvisionalV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for GET /1/object/ezmaxinvoicing/getProvisional ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezmaxinvoicing_id** | **int** | The unique ID of the Ezmaxinvoicing | [optional] diff --git a/docs/EzmaxinvoicingResponse.md b/docs/EzmaxinvoicingResponse.md index 6181ad484..e395a5225 100644 --- a/docs/EzmaxinvoicingResponse.md +++ b/docs/EzmaxinvoicingResponse.md @@ -3,6 +3,7 @@ A Ezmaxinvoicing Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezmaxinvoicing_id** | **int** | The unique ID of the Ezmaxinvoicing | [optional] diff --git a/docs/EzmaxinvoicingResponseCompound.md b/docs/EzmaxinvoicingResponseCompound.md index 7aa7cee78..12e3602ce 100644 --- a/docs/EzmaxinvoicingResponseCompound.md +++ b/docs/EzmaxinvoicingResponseCompound.md @@ -3,6 +3,7 @@ A Ezmaxinvoicing Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezmaxinvoicing_id** | **int** | The unique ID of the Ezmaxinvoicing | [optional] diff --git a/docs/EzmaxinvoicingagentResponse.md b/docs/EzmaxinvoicingagentResponse.md index f7319a639..05416e763 100644 --- a/docs/EzmaxinvoicingagentResponse.md +++ b/docs/EzmaxinvoicingagentResponse.md @@ -3,6 +3,7 @@ A Ezmaxinvoicingagent Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezmaxinvoicingagent_id** | **int** | The unique ID of the Ezmaxinvoicingagent | [optional] diff --git a/docs/EzmaxinvoicingagentResponseCompound.md b/docs/EzmaxinvoicingagentResponseCompound.md index 847f91def..49207e353 100644 --- a/docs/EzmaxinvoicingagentResponseCompound.md +++ b/docs/EzmaxinvoicingagentResponseCompound.md @@ -3,6 +3,7 @@ A Ezmaxinvoicingagent Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezmaxinvoicingagent_id** | **int** | The unique ID of the Ezmaxinvoicingagent | [optional] diff --git a/docs/EzmaxinvoicingcommissionResponse.md b/docs/EzmaxinvoicingcommissionResponse.md index d8d0780fe..44547de24 100644 --- a/docs/EzmaxinvoicingcommissionResponse.md +++ b/docs/EzmaxinvoicingcommissionResponse.md @@ -3,6 +3,7 @@ A Ezmaxinvoicingcommission Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezmaxinvoicingcommission_id** | **int** | The unique ID of the Ezmaxinvoicingcommission | [optional] diff --git a/docs/EzmaxinvoicingcommissionResponseCompound.md b/docs/EzmaxinvoicingcommissionResponseCompound.md index d12979342..8f0976c9d 100644 --- a/docs/EzmaxinvoicingcommissionResponseCompound.md +++ b/docs/EzmaxinvoicingcommissionResponseCompound.md @@ -3,6 +3,7 @@ A Ezmaxinvoicingcommission Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezmaxinvoicingcommission_id** | **int** | The unique ID of the Ezmaxinvoicingcommission | [optional] diff --git a/docs/EzmaxinvoicingcontractResponse.md b/docs/EzmaxinvoicingcontractResponse.md index d81f871db..4819b217b 100644 --- a/docs/EzmaxinvoicingcontractResponse.md +++ b/docs/EzmaxinvoicingcontractResponse.md @@ -3,6 +3,7 @@ A Ezmaxinvoicingcontract Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezmaxinvoicingcontract_id** | **int** | The unique ID of the Ezmaxinvoicingcontract | diff --git a/docs/EzmaxinvoicingcontractResponseCompound.md b/docs/EzmaxinvoicingcontractResponseCompound.md index 01a448238..eaf4c67d0 100644 --- a/docs/EzmaxinvoicingcontractResponseCompound.md +++ b/docs/EzmaxinvoicingcontractResponseCompound.md @@ -3,6 +3,7 @@ A Ezmaxinvoicingcontract Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezmaxinvoicingcontract_id** | **int** | The unique ID of the Ezmaxinvoicingcontract | diff --git a/docs/EzmaxinvoicingsummaryexternalResponse.md b/docs/EzmaxinvoicingsummaryexternalResponse.md index 9e882b28f..701e74e45 100644 --- a/docs/EzmaxinvoicingsummaryexternalResponse.md +++ b/docs/EzmaxinvoicingsummaryexternalResponse.md @@ -3,6 +3,7 @@ A Ezmaxinvoicingsummaryexternal Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezmaxinvoicingsummaryexternal_id** | **int** | The unique ID of the Ezmaxinvoicingsummaryexternal | [optional] diff --git a/docs/EzmaxinvoicingsummaryexternalResponseCompound.md b/docs/EzmaxinvoicingsummaryexternalResponseCompound.md index 387ce0745..c1828c6d4 100644 --- a/docs/EzmaxinvoicingsummaryexternalResponseCompound.md +++ b/docs/EzmaxinvoicingsummaryexternalResponseCompound.md @@ -3,6 +3,7 @@ A Ezmaxinvoicingsummaryexternal Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezmaxinvoicingsummaryexternal_id** | **int** | The unique ID of the Ezmaxinvoicingsummaryexternal | [optional] diff --git a/docs/EzmaxinvoicingsummaryexternaldetailResponse.md b/docs/EzmaxinvoicingsummaryexternaldetailResponse.md index 06bc4ed42..7f908aa34 100644 --- a/docs/EzmaxinvoicingsummaryexternaldetailResponse.md +++ b/docs/EzmaxinvoicingsummaryexternaldetailResponse.md @@ -3,6 +3,7 @@ A Ezmaxinvoicingsummaryexternaldetail Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezmaxinvoicingsummaryexternaldetail_id** | **int** | The unique ID of the Ezmaxinvoicingsummaryexternaldetail | [optional] diff --git a/docs/EzmaxinvoicingsummaryexternaldetailResponseCompound.md b/docs/EzmaxinvoicingsummaryexternaldetailResponseCompound.md index a2a781ad9..5466eca72 100644 --- a/docs/EzmaxinvoicingsummaryexternaldetailResponseCompound.md +++ b/docs/EzmaxinvoicingsummaryexternaldetailResponseCompound.md @@ -3,6 +3,7 @@ A Ezmaxinvoicingsummaryexternaldetail Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezmaxinvoicingsummaryexternaldetail_id** | **int** | The unique ID of the Ezmaxinvoicingsummaryexternaldetail | [optional] diff --git a/docs/EzmaxinvoicingsummaryglobalResponse.md b/docs/EzmaxinvoicingsummaryglobalResponse.md index 8c9341948..70877f220 100644 --- a/docs/EzmaxinvoicingsummaryglobalResponse.md +++ b/docs/EzmaxinvoicingsummaryglobalResponse.md @@ -3,6 +3,7 @@ A Ezmaxinvoicingsummaryglobal Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezmaxinvoicingsummaryglobal_id** | **int** | The unique ID of the Ezmaxinvoicingsummaryglobal | [optional] diff --git a/docs/EzmaxinvoicingsummaryglobalResponseCompound.md b/docs/EzmaxinvoicingsummaryglobalResponseCompound.md index 5eb420b06..4e9ce341c 100644 --- a/docs/EzmaxinvoicingsummaryglobalResponseCompound.md +++ b/docs/EzmaxinvoicingsummaryglobalResponseCompound.md @@ -3,6 +3,7 @@ A Ezmaxinvoicingsummaryglobal Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezmaxinvoicingsummaryglobal_id** | **int** | The unique ID of the Ezmaxinvoicingsummaryglobal | [optional] diff --git a/docs/EzmaxinvoicingsummaryinternalResponse.md b/docs/EzmaxinvoicingsummaryinternalResponse.md index 7c29b93d5..d725cf583 100644 --- a/docs/EzmaxinvoicingsummaryinternalResponse.md +++ b/docs/EzmaxinvoicingsummaryinternalResponse.md @@ -3,6 +3,7 @@ A Ezmaxinvoicingsummaryinternal Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezmaxinvoicingsummaryinternal_id** | **int** | The unique ID of the Ezmaxinvoicingsummaryinternal | [optional] diff --git a/docs/EzmaxinvoicingsummaryinternalResponseCompound.md b/docs/EzmaxinvoicingsummaryinternalResponseCompound.md index 2e82e05c1..e49569987 100644 --- a/docs/EzmaxinvoicingsummaryinternalResponseCompound.md +++ b/docs/EzmaxinvoicingsummaryinternalResponseCompound.md @@ -3,6 +3,7 @@ A Ezmaxinvoicingsummaryinternal Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezmaxinvoicingsummaryinternal_id** | **int** | The unique ID of the Ezmaxinvoicingsummaryinternal | [optional] diff --git a/docs/EzmaxinvoicingsummaryinternaldetailResponse.md b/docs/EzmaxinvoicingsummaryinternaldetailResponse.md index 9cd861f43..5855d79a5 100644 --- a/docs/EzmaxinvoicingsummaryinternaldetailResponse.md +++ b/docs/EzmaxinvoicingsummaryinternaldetailResponse.md @@ -3,6 +3,7 @@ A Ezmaxinvoicingsummaryinternaldetail Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezmaxinvoicingsummaryinternaldetail_id** | **int** | The unique ID of the Ezmaxinvoicingsummaryinternaldetail | [optional] diff --git a/docs/EzmaxinvoicingsummaryinternaldetailResponseCompound.md b/docs/EzmaxinvoicingsummaryinternaldetailResponseCompound.md index 2834eda01..664d34bbb 100644 --- a/docs/EzmaxinvoicingsummaryinternaldetailResponseCompound.md +++ b/docs/EzmaxinvoicingsummaryinternaldetailResponseCompound.md @@ -3,6 +3,7 @@ A Ezmaxinvoicingsummaryinternaldetail Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezmaxinvoicingsummaryinternaldetail_id** | **int** | The unique ID of the Ezmaxinvoicingsummaryinternaldetail | [optional] diff --git a/docs/EzmaxinvoicinguserResponse.md b/docs/EzmaxinvoicinguserResponse.md index 42505fb1f..b7e66eb2d 100644 --- a/docs/EzmaxinvoicinguserResponse.md +++ b/docs/EzmaxinvoicinguserResponse.md @@ -3,6 +3,7 @@ A Ezmaxinvoicinguser Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezmaxinvoicinguser_id** | **int** | The unique ID of the Ezmaxinvoicinguser | [optional] diff --git a/docs/EzmaxinvoicinguserResponseCompound.md b/docs/EzmaxinvoicinguserResponseCompound.md index d8173d589..4e5b73678 100644 --- a/docs/EzmaxinvoicinguserResponseCompound.md +++ b/docs/EzmaxinvoicinguserResponseCompound.md @@ -3,6 +3,7 @@ A Ezmaxinvoicinguser Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezmaxinvoicinguser_id** | **int** | The unique ID of the Ezmaxinvoicinguser | [optional] diff --git a/docs/EzmaxproductAutocompleteElementResponse.md b/docs/EzmaxproductAutocompleteElementResponse.md index 1165278e8..c82403768 100644 --- a/docs/EzmaxproductAutocompleteElementResponse.md +++ b/docs/EzmaxproductAutocompleteElementResponse.md @@ -3,6 +3,7 @@ A Ezmaxproduct AutocompleteElement Response ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezmaxproduct_id** | **int** | The unique ID of the Ezmaxproduct | diff --git a/docs/EzmaxproductGetAutocompleteV2Response.md b/docs/EzmaxproductGetAutocompleteV2Response.md index 5310b42e1..04807b3c3 100644 --- a/docs/EzmaxproductGetAutocompleteV2Response.md +++ b/docs/EzmaxproductGetAutocompleteV2Response.md @@ -3,6 +3,7 @@ Response for GET /2/object/ezmaxproduct/getAutocomplete ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzmaxproductGetAutocompleteV2ResponseMPayload.md b/docs/EzmaxproductGetAutocompleteV2ResponseMPayload.md index db13d2d02..2d7864446 100644 --- a/docs/EzmaxproductGetAutocompleteV2ResponseMPayload.md +++ b/docs/EzmaxproductGetAutocompleteV2ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for POST /2/object/ezmaxproduct/getAutocomplete ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_ezmaxproduct** | [**List[EzmaxproductAutocompleteElementResponse]**](EzmaxproductAutocompleteElementResponse.md) | An array of Ezmaxproduct autocomplete element response. | diff --git a/docs/EzsignSuggestSignersV1Response.md b/docs/EzsignSuggestSignersV1Response.md index c4e34aec0..b097c92e0 100644 --- a/docs/EzsignSuggestSignersV1Response.md +++ b/docs/EzsignSuggestSignersV1Response.md @@ -3,6 +3,7 @@ Response for GET /1/module/ezsign/suggestSigners ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsignSuggestSignersV1ResponseMPayload.md b/docs/EzsignSuggestSignersV1ResponseMPayload.md index 1ccd977c1..280e3a413 100644 --- a/docs/EzsignSuggestSignersV1ResponseMPayload.md +++ b/docs/EzsignSuggestSignersV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for GET /1/module/ezsign/suggestSigners ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_ezsignfoldersignerassociation** | [**List[EzsignfoldersignerassociationResponseCompound]**](EzsignfoldersignerassociationResponseCompound.md) | | diff --git a/docs/EzsignSuggestTemplatesV1Response.md b/docs/EzsignSuggestTemplatesV1Response.md index 0ba1833a3..6a6b0bed6 100644 --- a/docs/EzsignSuggestTemplatesV1Response.md +++ b/docs/EzsignSuggestTemplatesV1Response.md @@ -3,6 +3,7 @@ Response for GET /1/module/ezsign/suggestTemplates ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsignSuggestTemplatesV1ResponseMPayload.md b/docs/EzsignSuggestTemplatesV1ResponseMPayload.md index 2cd823c4f..ed6f75985 100644 --- a/docs/EzsignSuggestTemplatesV1ResponseMPayload.md +++ b/docs/EzsignSuggestTemplatesV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for GET /1/module/ezsign/suggestTemplates ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_ezsigntemplate** | [**List[EzsigntemplateResponseCompound]**](EzsigntemplateResponseCompound.md) | | diff --git a/docs/EzsignannotationResponse.md b/docs/EzsignannotationResponse.md index c82cccfea..e571662f3 100644 --- a/docs/EzsignannotationResponse.md +++ b/docs/EzsignannotationResponse.md @@ -3,6 +3,7 @@ A Ezsignannotation Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsignannotation_id** | **int** | The unique ID of the Ezsignannotation | diff --git a/docs/EzsignannotationResponseCompound.md b/docs/EzsignannotationResponseCompound.md index dd89aec74..849fd09e9 100644 --- a/docs/EzsignannotationResponseCompound.md +++ b/docs/EzsignannotationResponseCompound.md @@ -3,6 +3,7 @@ A Ezsignannotation Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsignannotation_id** | **int** | The unique ID of the Ezsignannotation | diff --git a/docs/EzsignbulksendCreateEzsignbulksendtransmissionV1Request.md b/docs/EzsignbulksendCreateEzsignbulksendtransmissionV1Request.md index 895ce1db0..326fc882b 100644 --- a/docs/EzsignbulksendCreateEzsignbulksendtransmissionV1Request.md +++ b/docs/EzsignbulksendCreateEzsignbulksendtransmissionV1Request.md @@ -3,6 +3,7 @@ Request for POST /1/object/ezsignbulksend/{pkiEzsignbulksendID}/createEzsignbulksendtransmission ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **fki_userlogintype_id** | **int** | The unique ID of the Userlogintype Valid values: |Value|Description|Detail| |-|-|-| |1|**Email Only**|The Ezsignsigner will receive a secure link by email| |2|**Email and phone or SMS**|The Ezsignsigner will receive a secure link by email and will need to authenticate using SMS or Phone call. **Additional fee applies**| |3|**Email and secret question**|The Ezsignsigner will receive a secure link by email and will need to authenticate using a predefined question and answer| |4|**In person only**|The Ezsignsigner will only be able to sign \"In-Person\" and there won't be any authentication. No email will be sent for invitation to sign. Make sure you evaluate the risk of signature denial and at minimum, we recommend you use a handwritten signature type| |5|**In person with phone or SMS**|The Ezsignsigner will only be able to sign \"In-Person\" and will need to authenticate using SMS or Phone call. No email will be sent for invitation to sign. **Additional fee applies**| | diff --git a/docs/EzsignbulksendCreateEzsignbulksendtransmissionV1Response.md b/docs/EzsignbulksendCreateEzsignbulksendtransmissionV1Response.md index 103f79eb5..30d10c538 100644 --- a/docs/EzsignbulksendCreateEzsignbulksendtransmissionV1Response.md +++ b/docs/EzsignbulksendCreateEzsignbulksendtransmissionV1Response.md @@ -3,6 +3,7 @@ Response for POST /1/object/ezsignbulksend/{pkiEzsignbulksendID}/createEzsignbulksendtransmission ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsignbulksendCreateEzsignbulksendtransmissionV1ResponseMPayload.md b/docs/EzsignbulksendCreateEzsignbulksendtransmissionV1ResponseMPayload.md index 7bea17cd3..3bc6fa415 100644 --- a/docs/EzsignbulksendCreateEzsignbulksendtransmissionV1ResponseMPayload.md +++ b/docs/EzsignbulksendCreateEzsignbulksendtransmissionV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for POST /1/object/ezsignbulksend/{pkiEzsignbulksendID}/createEzsignbulksendtransmission ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_ezsignbulksendtransmission** | [**EzsignbulksendtransmissionResponse**](EzsignbulksendtransmissionResponse.md) | | diff --git a/docs/EzsignbulksendCreateObjectV1Request.md b/docs/EzsignbulksendCreateObjectV1Request.md index 81b1bede4..a7722a0e7 100644 --- a/docs/EzsignbulksendCreateObjectV1Request.md +++ b/docs/EzsignbulksendCreateObjectV1Request.md @@ -3,6 +3,7 @@ Request for POST /1/object/ezsignbulksend ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_ezsignbulksend** | [**List[EzsignbulksendRequestCompound]**](EzsignbulksendRequestCompound.md) | | diff --git a/docs/EzsignbulksendCreateObjectV1Response.md b/docs/EzsignbulksendCreateObjectV1Response.md index 9c6af3943..ca95041e5 100644 --- a/docs/EzsignbulksendCreateObjectV1Response.md +++ b/docs/EzsignbulksendCreateObjectV1Response.md @@ -3,6 +3,7 @@ Response for POST /1/object/ezsignbulksend ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsignbulksendCreateObjectV1ResponseMPayload.md b/docs/EzsignbulksendCreateObjectV1ResponseMPayload.md index 9f4ce1a80..32156185d 100644 --- a/docs/EzsignbulksendCreateObjectV1ResponseMPayload.md +++ b/docs/EzsignbulksendCreateObjectV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for POST /1/object/ezsignbulksend ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_pki_ezsignbulksend_id** | **List[int]** | An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request. | diff --git a/docs/EzsignbulksendDeleteObjectV1Response.md b/docs/EzsignbulksendDeleteObjectV1Response.md index dea26abc1..ae4f26edf 100644 --- a/docs/EzsignbulksendDeleteObjectV1Response.md +++ b/docs/EzsignbulksendDeleteObjectV1Response.md @@ -3,6 +3,7 @@ Response for DELETE /1/object/ezsignbulksend/{pkiEzsignbulksendID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsignbulksendEditObjectV1Request.md b/docs/EzsignbulksendEditObjectV1Request.md index a3edf9a76..3fff6a61d 100644 --- a/docs/EzsignbulksendEditObjectV1Request.md +++ b/docs/EzsignbulksendEditObjectV1Request.md @@ -3,6 +3,7 @@ Request for PUT /1/object/ezsignbulksend/{pkiEzsignbulksendID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_ezsignbulksend** | [**EzsignbulksendRequestCompound**](EzsignbulksendRequestCompound.md) | | diff --git a/docs/EzsignbulksendEditObjectV1Response.md b/docs/EzsignbulksendEditObjectV1Response.md index eae016fe0..14f72808b 100644 --- a/docs/EzsignbulksendEditObjectV1Response.md +++ b/docs/EzsignbulksendEditObjectV1Response.md @@ -3,6 +3,7 @@ Response for PUT /1/object/ezsignbulksend/{pkiEzsignbulksendID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsignbulksendGetEzsignbulksendtransmissionsV1Response.md b/docs/EzsignbulksendGetEzsignbulksendtransmissionsV1Response.md index e58eb01bf..b75909798 100644 --- a/docs/EzsignbulksendGetEzsignbulksendtransmissionsV1Response.md +++ b/docs/EzsignbulksendGetEzsignbulksendtransmissionsV1Response.md @@ -3,6 +3,7 @@ Response for GET /1/object/ezsignbulksend/{pkiEzsignbulksend}/getEzsignbulksendtransmissions ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsignbulksendGetEzsignbulksendtransmissionsV1ResponseMPayload.md b/docs/EzsignbulksendGetEzsignbulksendtransmissionsV1ResponseMPayload.md index 2c9030838..626a251fe 100644 --- a/docs/EzsignbulksendGetEzsignbulksendtransmissionsV1ResponseMPayload.md +++ b/docs/EzsignbulksendGetEzsignbulksendtransmissionsV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for GET /1/object/ezsignbulksend/{pkiEzsignbulksend}/getEzsignbulksendtransmissions ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_ezsignbulksendtransmission** | [**List[EzsignbulksendtransmissionResponseCompound]**](EzsignbulksendtransmissionResponseCompound.md) | | diff --git a/docs/EzsignbulksendGetEzsignsignaturesAutomaticV1Response.md b/docs/EzsignbulksendGetEzsignsignaturesAutomaticV1Response.md index 26e7964e4..bf0b48f73 100644 --- a/docs/EzsignbulksendGetEzsignsignaturesAutomaticV1Response.md +++ b/docs/EzsignbulksendGetEzsignsignaturesAutomaticV1Response.md @@ -3,6 +3,7 @@ Response for GET /1/object/ezsignbulksend/{pkiEzsignbulksendID}/getEzsignsignaturesAutomatic ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsignbulksendGetEzsignsignaturesAutomaticV1ResponseMPayload.md b/docs/EzsignbulksendGetEzsignsignaturesAutomaticV1ResponseMPayload.md index 73c8cf878..7685e3789 100644 --- a/docs/EzsignbulksendGetEzsignsignaturesAutomaticV1ResponseMPayload.md +++ b/docs/EzsignbulksendGetEzsignsignaturesAutomaticV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for GET /1/object/ezsignbulksend/{pkiEzsignbulksendID}/getEzsignsignaturesAutomatic ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_e_ezsignsignature_type** | [**List[FieldEEzsignsignatureType]**](FieldEEzsignsignatureType.md) | All eEzsignsignatureType contained in the response | diff --git a/docs/EzsignbulksendGetFormsDataV1Response.md b/docs/EzsignbulksendGetFormsDataV1Response.md index 27296a47f..17e44c8e7 100644 --- a/docs/EzsignbulksendGetFormsDataV1Response.md +++ b/docs/EzsignbulksendGetFormsDataV1Response.md @@ -3,6 +3,7 @@ Response for GET /1/object/ezsignbulksend/{pkiEzsignbulksendID}/getFormsData ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsignbulksendGetFormsDataV1ResponseMPayload.md b/docs/EzsignbulksendGetFormsDataV1ResponseMPayload.md index ac123f62f..ab08ad628 100644 --- a/docs/EzsignbulksendGetFormsDataV1ResponseMPayload.md +++ b/docs/EzsignbulksendGetFormsDataV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for GET/1/object/ezsignbulksend/{pkiEzsignbulksendID}/getFormsData ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_forms_data_folder** | [**List[CustomFormsDataFolderResponse]**](CustomFormsDataFolderResponse.md) | | diff --git a/docs/EzsignbulksendGetListV1Response.md b/docs/EzsignbulksendGetListV1Response.md index c0f2d00b6..30c3e2118 100644 --- a/docs/EzsignbulksendGetListV1Response.md +++ b/docs/EzsignbulksendGetListV1Response.md @@ -3,6 +3,7 @@ Response for GET /1/object/ezsignbulksend/getList ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayloadGetList**](CommonResponseObjDebugPayloadGetList.md) | | diff --git a/docs/EzsignbulksendGetListV1ResponseMPayload.md b/docs/EzsignbulksendGetListV1ResponseMPayload.md index 531292a6d..ffd06b2f1 100644 --- a/docs/EzsignbulksendGetListV1ResponseMPayload.md +++ b/docs/EzsignbulksendGetListV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for GET /1/object/ezsignbulksend/getList ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **i_row_returned** | **int** | The number of rows returned | diff --git a/docs/EzsignbulksendGetObjectV2Response.md b/docs/EzsignbulksendGetObjectV2Response.md index 4b5d7e026..451456055 100644 --- a/docs/EzsignbulksendGetObjectV2Response.md +++ b/docs/EzsignbulksendGetObjectV2Response.md @@ -3,6 +3,7 @@ Response for GET /2/object/ezsignbulksend/{pkiEzsignbulksendID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsignbulksendGetObjectV2ResponseMPayload.md b/docs/EzsignbulksendGetObjectV2ResponseMPayload.md index 0487b1359..8258d4dc1 100644 --- a/docs/EzsignbulksendGetObjectV2ResponseMPayload.md +++ b/docs/EzsignbulksendGetObjectV2ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for GET /2/object/ezsignbulksend/{pkiEzsignbulksendID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_ezsignbulksend** | [**EzsignbulksendResponseCompound**](EzsignbulksendResponseCompound.md) | | diff --git a/docs/EzsignbulksendListElement.md b/docs/EzsignbulksendListElement.md index 6fe5df9d2..81b08e9be 100644 --- a/docs/EzsignbulksendListElement.md +++ b/docs/EzsignbulksendListElement.md @@ -3,6 +3,7 @@ An Ezsignbulksend List Element ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsignbulksend_id** | **int** | The unique ID of the Ezsignbulksend | diff --git a/docs/EzsignbulksendReorderV1Request.md b/docs/EzsignbulksendReorderV1Request.md index af374b62b..becb98167 100644 --- a/docs/EzsignbulksendReorderV1Request.md +++ b/docs/EzsignbulksendReorderV1Request.md @@ -3,6 +3,7 @@ Request for POST /1/object/ezsignbulksend/{pkiEzsignbulksendID}/reorder ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_pki_ezsignbulksenddocumentmapping_id** | **List[int]** | | diff --git a/docs/EzsignbulksendReorderV1Response.md b/docs/EzsignbulksendReorderV1Response.md index 34f70d205..614f555e1 100644 --- a/docs/EzsignbulksendReorderV1Response.md +++ b/docs/EzsignbulksendReorderV1Response.md @@ -3,6 +3,7 @@ Response for POST /1/object/ezsignbulksend/{pkiEzsignbulksendID}/reorder ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsignbulksendRequest.md b/docs/EzsignbulksendRequest.md index f987dad83..0288c5eaf 100644 --- a/docs/EzsignbulksendRequest.md +++ b/docs/EzsignbulksendRequest.md @@ -3,6 +3,7 @@ A Ezsignbulksend Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsignbulksend_id** | **int** | The unique ID of the Ezsignbulksend | [optional] diff --git a/docs/EzsignbulksendRequestCompound.md b/docs/EzsignbulksendRequestCompound.md index e547bdf1b..5b060a577 100644 --- a/docs/EzsignbulksendRequestCompound.md +++ b/docs/EzsignbulksendRequestCompound.md @@ -3,6 +3,7 @@ A Ezsignbulksend Object and children ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsignbulksend_id** | **int** | The unique ID of the Ezsignbulksend | [optional] diff --git a/docs/EzsignbulksendResponse.md b/docs/EzsignbulksendResponse.md index 2315ba38e..eff626ef0 100644 --- a/docs/EzsignbulksendResponse.md +++ b/docs/EzsignbulksendResponse.md @@ -3,6 +3,7 @@ An Ezsignbulksend Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsignbulksend_id** | **int** | The unique ID of the Ezsignbulksend | diff --git a/docs/EzsignbulksendResponseCompound.md b/docs/EzsignbulksendResponseCompound.md index c24d5eefc..20b1ddffa 100644 --- a/docs/EzsignbulksendResponseCompound.md +++ b/docs/EzsignbulksendResponseCompound.md @@ -3,6 +3,7 @@ An Ezsignbulksend Object and children to create a complete structure ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsignbulksend_id** | **int** | The unique ID of the Ezsignbulksend | diff --git a/docs/EzsignbulksenddocumentmappingCreateObjectV1Request.md b/docs/EzsignbulksenddocumentmappingCreateObjectV1Request.md index 48bdf6218..7c063f1ee 100644 --- a/docs/EzsignbulksenddocumentmappingCreateObjectV1Request.md +++ b/docs/EzsignbulksenddocumentmappingCreateObjectV1Request.md @@ -3,6 +3,7 @@ Request for POST /1/object/ezsignbulksenddocumentmapping ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_ezsignbulksenddocumentmapping** | [**List[EzsignbulksenddocumentmappingRequestCompound]**](EzsignbulksenddocumentmappingRequestCompound.md) | | diff --git a/docs/EzsignbulksenddocumentmappingCreateObjectV1Response.md b/docs/EzsignbulksenddocumentmappingCreateObjectV1Response.md index 29b86fbff..f834d4ff5 100644 --- a/docs/EzsignbulksenddocumentmappingCreateObjectV1Response.md +++ b/docs/EzsignbulksenddocumentmappingCreateObjectV1Response.md @@ -3,6 +3,7 @@ Response for POST /1/object/ezsignbulksenddocumentmapping ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsignbulksenddocumentmappingCreateObjectV1ResponseMPayload.md b/docs/EzsignbulksenddocumentmappingCreateObjectV1ResponseMPayload.md index 8fd465e31..fe8662a15 100644 --- a/docs/EzsignbulksenddocumentmappingCreateObjectV1ResponseMPayload.md +++ b/docs/EzsignbulksenddocumentmappingCreateObjectV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for POST /1/object/ezsignbulksenddocumentmapping ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_pki_ezsignbulksenddocumentmapping_id** | **List[int]** | An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request. | diff --git a/docs/EzsignbulksenddocumentmappingDeleteObjectV1Response.md b/docs/EzsignbulksenddocumentmappingDeleteObjectV1Response.md index 0ef41cf41..321cde235 100644 --- a/docs/EzsignbulksenddocumentmappingDeleteObjectV1Response.md +++ b/docs/EzsignbulksenddocumentmappingDeleteObjectV1Response.md @@ -3,6 +3,7 @@ Response for DELETE /1/object/ezsignbulksenddocumentmapping/{pkiEzsignbulksenddocumentmappingID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsignbulksenddocumentmappingGetObjectV2Response.md b/docs/EzsignbulksenddocumentmappingGetObjectV2Response.md index d2bdf8775..e814744cf 100644 --- a/docs/EzsignbulksenddocumentmappingGetObjectV2Response.md +++ b/docs/EzsignbulksenddocumentmappingGetObjectV2Response.md @@ -3,6 +3,7 @@ Response for GET /2/object/ezsignbulksenddocumentmapping/{pkiEzsignbulksenddocumentmappingID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsignbulksenddocumentmappingGetObjectV2ResponseMPayload.md b/docs/EzsignbulksenddocumentmappingGetObjectV2ResponseMPayload.md index 4969eb7de..520380158 100644 --- a/docs/EzsignbulksenddocumentmappingGetObjectV2ResponseMPayload.md +++ b/docs/EzsignbulksenddocumentmappingGetObjectV2ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for GET /2/object/ezsignbulksenddocumentmapping/{pkiEzsignbulksenddocumentmappingID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_ezsignbulksenddocumentmapping** | [**EzsignbulksenddocumentmappingResponseCompound**](EzsignbulksenddocumentmappingResponseCompound.md) | | diff --git a/docs/EzsignbulksenddocumentmappingRequest.md b/docs/EzsignbulksenddocumentmappingRequest.md index bf12bd16a..206105f74 100644 --- a/docs/EzsignbulksenddocumentmappingRequest.md +++ b/docs/EzsignbulksenddocumentmappingRequest.md @@ -3,6 +3,7 @@ A Ezsignbulksenddocumentmapping Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsignbulksenddocumentmapping_id** | **int** | The unique ID of the Ezsignbulksenddocumentmapping. | [optional] diff --git a/docs/EzsignbulksenddocumentmappingRequestCompound.md b/docs/EzsignbulksenddocumentmappingRequestCompound.md index 92f6b6d9d..872708826 100644 --- a/docs/EzsignbulksenddocumentmappingRequestCompound.md +++ b/docs/EzsignbulksenddocumentmappingRequestCompound.md @@ -3,6 +3,7 @@ A Ezsignbulksenddocumentmapping Object and children ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsignbulksenddocumentmapping_id** | **int** | The unique ID of the Ezsignbulksenddocumentmapping. | [optional] diff --git a/docs/EzsignbulksenddocumentmappingResponse.md b/docs/EzsignbulksenddocumentmappingResponse.md index bf4b94dd6..75a42a6b5 100644 --- a/docs/EzsignbulksenddocumentmappingResponse.md +++ b/docs/EzsignbulksenddocumentmappingResponse.md @@ -3,6 +3,7 @@ A Ezsignbulksenddocumentmapping Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsignbulksenddocumentmapping_id** | **int** | The unique ID of the Ezsignbulksenddocumentmapping. | diff --git a/docs/EzsignbulksenddocumentmappingResponseCompound.md b/docs/EzsignbulksenddocumentmappingResponseCompound.md index a2d9e78ac..e9a441555 100644 --- a/docs/EzsignbulksenddocumentmappingResponseCompound.md +++ b/docs/EzsignbulksenddocumentmappingResponseCompound.md @@ -3,6 +3,7 @@ A Ezsignbulksenddocumentmapping Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsignbulksenddocumentmapping_id** | **int** | The unique ID of the Ezsignbulksenddocumentmapping. | diff --git a/docs/EzsignbulksendsignermappingCreateObjectV1Request.md b/docs/EzsignbulksendsignermappingCreateObjectV1Request.md index 594425c31..9bd4447b2 100644 --- a/docs/EzsignbulksendsignermappingCreateObjectV1Request.md +++ b/docs/EzsignbulksendsignermappingCreateObjectV1Request.md @@ -3,6 +3,7 @@ Request for POST /1/object/ezsignbulksendsignermapping ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_ezsignbulksendsignermapping** | [**List[EzsignbulksendsignermappingRequestCompound]**](EzsignbulksendsignermappingRequestCompound.md) | | diff --git a/docs/EzsignbulksendsignermappingCreateObjectV1Response.md b/docs/EzsignbulksendsignermappingCreateObjectV1Response.md index 1d5aec722..34f9959d2 100644 --- a/docs/EzsignbulksendsignermappingCreateObjectV1Response.md +++ b/docs/EzsignbulksendsignermappingCreateObjectV1Response.md @@ -3,6 +3,7 @@ Response for POST /1/object/ezsignbulksendsignermapping ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsignbulksendsignermappingCreateObjectV1ResponseMPayload.md b/docs/EzsignbulksendsignermappingCreateObjectV1ResponseMPayload.md index 78d6e21a5..f0d0826ad 100644 --- a/docs/EzsignbulksendsignermappingCreateObjectV1ResponseMPayload.md +++ b/docs/EzsignbulksendsignermappingCreateObjectV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for POST /1/object/ezsignbulksendsignermapping ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_pki_ezsignbulksendsignermapping_id** | **List[int]** | An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request. | diff --git a/docs/EzsignbulksendsignermappingDeleteObjectV1Response.md b/docs/EzsignbulksendsignermappingDeleteObjectV1Response.md index 36acf2ada..2ede9fb8c 100644 --- a/docs/EzsignbulksendsignermappingDeleteObjectV1Response.md +++ b/docs/EzsignbulksendsignermappingDeleteObjectV1Response.md @@ -3,6 +3,7 @@ Response for DELETE /1/object/ezsignbulksendsignermapping/{pkiEzsignbulksendsignermappingID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsignbulksendsignermappingGetObjectV2Response.md b/docs/EzsignbulksendsignermappingGetObjectV2Response.md index 38d2f2ebd..fa2dbc8b9 100644 --- a/docs/EzsignbulksendsignermappingGetObjectV2Response.md +++ b/docs/EzsignbulksendsignermappingGetObjectV2Response.md @@ -3,6 +3,7 @@ Response for GET /2/object/ezsignbulksendsignermapping/{pkiEzsignbulksendsignermappingID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsignbulksendsignermappingGetObjectV2ResponseMPayload.md b/docs/EzsignbulksendsignermappingGetObjectV2ResponseMPayload.md index 91e85c006..ab9215351 100644 --- a/docs/EzsignbulksendsignermappingGetObjectV2ResponseMPayload.md +++ b/docs/EzsignbulksendsignermappingGetObjectV2ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for GET /2/object/ezsignbulksendsignermapping/{pkiEzsignbulksendsignermappingID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_ezsignbulksendsignermapping** | [**EzsignbulksendsignermappingResponseCompound**](EzsignbulksendsignermappingResponseCompound.md) | | diff --git a/docs/EzsignbulksendsignermappingRequest.md b/docs/EzsignbulksendsignermappingRequest.md index e6c632861..6b000df3e 100644 --- a/docs/EzsignbulksendsignermappingRequest.md +++ b/docs/EzsignbulksendsignermappingRequest.md @@ -3,6 +3,7 @@ A Ezsignbulksendsignermapping Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsignbulksendsignermapping_id** | **int** | The unique ID of the Ezsignbulksendsignermapping | [optional] diff --git a/docs/EzsignbulksendsignermappingRequestCompound.md b/docs/EzsignbulksendsignermappingRequestCompound.md index 7af1fd1e2..c47fb02cd 100644 --- a/docs/EzsignbulksendsignermappingRequestCompound.md +++ b/docs/EzsignbulksendsignermappingRequestCompound.md @@ -3,6 +3,7 @@ A Ezsignbulksendsignermapping Object and children ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsignbulksendsignermapping_id** | **int** | The unique ID of the Ezsignbulksendsignermapping | [optional] diff --git a/docs/EzsignbulksendsignermappingResponse.md b/docs/EzsignbulksendsignermappingResponse.md index b6bb8c32c..4f2c7fe56 100644 --- a/docs/EzsignbulksendsignermappingResponse.md +++ b/docs/EzsignbulksendsignermappingResponse.md @@ -3,6 +3,7 @@ A Ezsignbulksendsignermapping Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsignbulksendsignermapping_id** | **int** | The unique ID of the Ezsignbulksendsignermapping | diff --git a/docs/EzsignbulksendsignermappingResponseCompound.md b/docs/EzsignbulksendsignermappingResponseCompound.md index b7c55cf4e..446e35946 100644 --- a/docs/EzsignbulksendsignermappingResponseCompound.md +++ b/docs/EzsignbulksendsignermappingResponseCompound.md @@ -3,6 +3,7 @@ A Ezsignbulksendsignermapping Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsignbulksendsignermapping_id** | **int** | The unique ID of the Ezsignbulksendsignermapping | diff --git a/docs/EzsignbulksendtransmissionGetEzsignsignaturesAutomaticV1Response.md b/docs/EzsignbulksendtransmissionGetEzsignsignaturesAutomaticV1Response.md index 7f79ae1ba..a30f145c9 100644 --- a/docs/EzsignbulksendtransmissionGetEzsignsignaturesAutomaticV1Response.md +++ b/docs/EzsignbulksendtransmissionGetEzsignsignaturesAutomaticV1Response.md @@ -3,6 +3,7 @@ Response for GET /1/object/ezsignbulksendtransmission/{pkiEzsignbulksendtransmissionID}/getEzsignsignaturesAutomatic ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsignbulksendtransmissionGetEzsignsignaturesAutomaticV1ResponseMPayload.md b/docs/EzsignbulksendtransmissionGetEzsignsignaturesAutomaticV1ResponseMPayload.md index 6ce8329f0..15131c457 100644 --- a/docs/EzsignbulksendtransmissionGetEzsignsignaturesAutomaticV1ResponseMPayload.md +++ b/docs/EzsignbulksendtransmissionGetEzsignsignaturesAutomaticV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for GET /1/object/ezsignbulksendtransmission/{pkiEzsignbulksendtransmissionID}/getEzsignsignaturesAutomatic ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_e_ezsignsignature_type** | [**List[FieldEEzsignsignatureType]**](FieldEEzsignsignatureType.md) | All eEzsignsignatureType contained in the response | diff --git a/docs/EzsignbulksendtransmissionGetFormsDataV1Response.md b/docs/EzsignbulksendtransmissionGetFormsDataV1Response.md index 2471f20d0..11861588a 100644 --- a/docs/EzsignbulksendtransmissionGetFormsDataV1Response.md +++ b/docs/EzsignbulksendtransmissionGetFormsDataV1Response.md @@ -3,6 +3,7 @@ Response for GET /1/object/ezsignbulksendtransmission/{pkiEzsignbulksendtransmissionID}/getFormsData ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsignbulksendtransmissionGetFormsDataV1ResponseMPayload.md b/docs/EzsignbulksendtransmissionGetFormsDataV1ResponseMPayload.md index 456441cc6..54d1868cb 100644 --- a/docs/EzsignbulksendtransmissionGetFormsDataV1ResponseMPayload.md +++ b/docs/EzsignbulksendtransmissionGetFormsDataV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for GET /1/object/ezsignbulksendtransmission/{pkiEzsignbulksendtransmissionID}/getFormsData ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_forms_data_folder** | [**List[CustomFormsDataFolderResponse]**](CustomFormsDataFolderResponse.md) | | diff --git a/docs/EzsignbulksendtransmissionGetObjectV2Response.md b/docs/EzsignbulksendtransmissionGetObjectV2Response.md index c10b57c18..882263d12 100644 --- a/docs/EzsignbulksendtransmissionGetObjectV2Response.md +++ b/docs/EzsignbulksendtransmissionGetObjectV2Response.md @@ -3,6 +3,7 @@ Response for GET /2/object/ezsignbulksendtransmission/{pkiEzsignbulksendtransmissionID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsignbulksendtransmissionGetObjectV2ResponseMPayload.md b/docs/EzsignbulksendtransmissionGetObjectV2ResponseMPayload.md index f0a2e26d2..a726666ca 100644 --- a/docs/EzsignbulksendtransmissionGetObjectV2ResponseMPayload.md +++ b/docs/EzsignbulksendtransmissionGetObjectV2ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for GET /2/object/ezsignbulksendtransmission/{pkiEzsignbulksendtransmissionID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_ezsignbulksendtransmission** | [**EzsignbulksendtransmissionResponseCompound**](EzsignbulksendtransmissionResponseCompound.md) | | diff --git a/docs/EzsignbulksendtransmissionResponse.md b/docs/EzsignbulksendtransmissionResponse.md index 1a5352263..8b6e4282f 100644 --- a/docs/EzsignbulksendtransmissionResponse.md +++ b/docs/EzsignbulksendtransmissionResponse.md @@ -3,6 +3,7 @@ An Ezsignbulksendtransmission Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsignbulksendtransmission_id** | **int** | The unique ID of the Ezsignbulksendtransmission | diff --git a/docs/EzsignbulksendtransmissionResponseCompound.md b/docs/EzsignbulksendtransmissionResponseCompound.md index bb941ebdb..f88695a79 100644 --- a/docs/EzsignbulksendtransmissionResponseCompound.md +++ b/docs/EzsignbulksendtransmissionResponseCompound.md @@ -3,6 +3,7 @@ An Ezsignbulksendtransmission Object and children to create a complete structure ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsignbulksendtransmission_id** | **int** | The unique ID of the Ezsignbulksendtransmission | diff --git a/docs/EzsigndocumentApplyEzsigntemplateV1Request.md b/docs/EzsigndocumentApplyEzsigntemplateV1Request.md index ed7eaa009..4f4bed631 100644 --- a/docs/EzsigndocumentApplyEzsigntemplateV1Request.md +++ b/docs/EzsigndocumentApplyEzsigntemplateV1Request.md @@ -3,6 +3,7 @@ Request for POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/applyezsigntemplate ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **fki_ezsigntemplate_id** | **int** | The unique ID of the Ezsigntemplate | diff --git a/docs/EzsigndocumentApplyEzsigntemplateV1Response.md b/docs/EzsigndocumentApplyEzsigntemplateV1Response.md index c313fd50a..b48a18a84 100644 --- a/docs/EzsigndocumentApplyEzsigntemplateV1Response.md +++ b/docs/EzsigndocumentApplyEzsigntemplateV1Response.md @@ -3,6 +3,7 @@ Response for POST /1/object/ezsigndocument/{pkiEzsigndocument}/applyEzsigntemplate ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsigndocumentApplyEzsigntemplateV2Request.md b/docs/EzsigndocumentApplyEzsigntemplateV2Request.md index 450c6f453..d777856cd 100644 --- a/docs/EzsigndocumentApplyEzsigntemplateV2Request.md +++ b/docs/EzsigndocumentApplyEzsigntemplateV2Request.md @@ -3,6 +3,7 @@ Request for POST /2/object/ezsigndocument/{pkiEzsigndocumentID}/applyezsigntemplate ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **fki_ezsigntemplate_id** | **int** | The unique ID of the Ezsigntemplate | diff --git a/docs/EzsigndocumentApplyEzsigntemplateV2Response.md b/docs/EzsigndocumentApplyEzsigntemplateV2Response.md index d70d903b5..94085b751 100644 --- a/docs/EzsigndocumentApplyEzsigntemplateV2Response.md +++ b/docs/EzsigndocumentApplyEzsigntemplateV2Response.md @@ -3,6 +3,7 @@ Response for POST /2/object/ezsigndocument/{pkiEzsigndocument}/applyEzsigntemplate ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsigndocumentCreateObjectV1Request.md b/docs/EzsigndocumentCreateObjectV1Request.md index 0c55abe4a..9334c3abb 100644 --- a/docs/EzsigndocumentCreateObjectV1Request.md +++ b/docs/EzsigndocumentCreateObjectV1Request.md @@ -3,6 +3,7 @@ Request for POST /1/object/ezsigndocument ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_ezsigndocument** | [**EzsigndocumentRequest**](EzsigndocumentRequest.md) | | [optional] diff --git a/docs/EzsigndocumentCreateObjectV1Response.md b/docs/EzsigndocumentCreateObjectV1Response.md index efbf10b28..ab97c0638 100644 --- a/docs/EzsigndocumentCreateObjectV1Response.md +++ b/docs/EzsigndocumentCreateObjectV1Response.md @@ -3,6 +3,7 @@ Response for POST /1/object/ezsigndocument ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsigndocumentCreateObjectV1ResponseMPayload.md b/docs/EzsigndocumentCreateObjectV1ResponseMPayload.md index d055550bb..ed0f0cf2d 100644 --- a/docs/EzsigndocumentCreateObjectV1ResponseMPayload.md +++ b/docs/EzsigndocumentCreateObjectV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for POST /1/object/ezsigndocument ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_pki_ezsigndocument_id** | **List[int]** | An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request. | diff --git a/docs/EzsigndocumentCreateObjectV2Request.md b/docs/EzsigndocumentCreateObjectV2Request.md index 0c174ee3d..dd29c5a58 100644 --- a/docs/EzsigndocumentCreateObjectV2Request.md +++ b/docs/EzsigndocumentCreateObjectV2Request.md @@ -3,6 +3,7 @@ Request for POST /2/object/ezsigndocument ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_ezsigndocument** | [**List[EzsigndocumentRequestCompound]**](EzsigndocumentRequestCompound.md) | | diff --git a/docs/EzsigndocumentCreateObjectV2Response.md b/docs/EzsigndocumentCreateObjectV2Response.md index ebda9a419..b800f84d3 100644 --- a/docs/EzsigndocumentCreateObjectV2Response.md +++ b/docs/EzsigndocumentCreateObjectV2Response.md @@ -3,6 +3,7 @@ Response for POST /2/object/ezsigndocument ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsigndocumentCreateObjectV2ResponseMPayload.md b/docs/EzsigndocumentCreateObjectV2ResponseMPayload.md index c5ebd337c..0faa4eb2d 100644 --- a/docs/EzsigndocumentCreateObjectV2ResponseMPayload.md +++ b/docs/EzsigndocumentCreateObjectV2ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for POST /2/object/ezsigndocument ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_pki_ezsigndocument_id** | **List[int]** | An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request. | diff --git a/docs/EzsigndocumentDeclineToSignV1Request.md b/docs/EzsigndocumentDeclineToSignV1Request.md index 1cc5170be..b43004cf6 100644 --- a/docs/EzsigndocumentDeclineToSignV1Request.md +++ b/docs/EzsigndocumentDeclineToSignV1Request.md @@ -3,6 +3,7 @@ Request for POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/declineToSign ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **s_reason** | **str** | Reason for refusal | diff --git a/docs/EzsigndocumentDeclineToSignV1Response.md b/docs/EzsigndocumentDeclineToSignV1Response.md index 930bc6614..8e141f9df 100644 --- a/docs/EzsigndocumentDeclineToSignV1Response.md +++ b/docs/EzsigndocumentDeclineToSignV1Response.md @@ -3,6 +3,7 @@ Response for POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/declineToSign ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsigndocumentDeleteObjectV1Response.md b/docs/EzsigndocumentDeleteObjectV1Response.md index 8d83db1c8..5bb188482 100644 --- a/docs/EzsigndocumentDeleteObjectV1Response.md +++ b/docs/EzsigndocumentDeleteObjectV1Response.md @@ -3,6 +3,7 @@ Response for DELETE /1/object/ezsigndocument/{pkiEzsigndocumentID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsigndocumentEditEzsignformfieldgroupsV1Request.md b/docs/EzsigndocumentEditEzsignformfieldgroupsV1Request.md index ab6d403b9..4c9c92384 100644 --- a/docs/EzsigndocumentEditEzsignformfieldgroupsV1Request.md +++ b/docs/EzsigndocumentEditEzsignformfieldgroupsV1Request.md @@ -3,6 +3,7 @@ Request for PUT /1/object/ezsigndocument/{pkiEzsigndocumentID}/editEzsignformfieldgroups ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_ezsignformfieldgroup** | [**List[EzsignformfieldgroupRequestCompound]**](EzsignformfieldgroupRequestCompound.md) | | diff --git a/docs/EzsigndocumentEditEzsignformfieldgroupsV1Response.md b/docs/EzsigndocumentEditEzsignformfieldgroupsV1Response.md index e8582cfb5..194d1fd79 100644 --- a/docs/EzsigndocumentEditEzsignformfieldgroupsV1Response.md +++ b/docs/EzsigndocumentEditEzsignformfieldgroupsV1Response.md @@ -3,6 +3,7 @@ Response for PUT /1/object/ezsigndocument/{pkiEzsigndocumentID}/editEzsignformfieldgroups ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsigndocumentEditEzsignformfieldgroupsV1ResponseMPayload.md b/docs/EzsigndocumentEditEzsignformfieldgroupsV1ResponseMPayload.md index 8083225c4..d2487d232 100644 --- a/docs/EzsigndocumentEditEzsignformfieldgroupsV1ResponseMPayload.md +++ b/docs/EzsigndocumentEditEzsignformfieldgroupsV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for PUT /1/object/ezsigndocument/{pkiEzsigndocumentID}/editEzsignformfieldgroups ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_pki_ezsignformfieldgroup_id** | **List[int]** | | diff --git a/docs/EzsigndocumentEditEzsignsignaturesV1Request.md b/docs/EzsigndocumentEditEzsignsignaturesV1Request.md index 6da9b28cb..cb129e16a 100644 --- a/docs/EzsigndocumentEditEzsignsignaturesV1Request.md +++ b/docs/EzsigndocumentEditEzsignsignaturesV1Request.md @@ -3,6 +3,7 @@ Request for PUT /1/object/ezsigndocument/{pkiEzsigndocumentID}/editEzsignsignatures ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_ezsignsignature** | [**List[EzsignsignatureRequestCompound]**](EzsignsignatureRequestCompound.md) | | diff --git a/docs/EzsigndocumentEditEzsignsignaturesV1Response.md b/docs/EzsigndocumentEditEzsignsignaturesV1Response.md index aadd8c366..dccaa8134 100644 --- a/docs/EzsigndocumentEditEzsignsignaturesV1Response.md +++ b/docs/EzsigndocumentEditEzsignsignaturesV1Response.md @@ -3,6 +3,7 @@ Response for PUT /1/object/ezsigndocument/{pkiEzsigndocumentID}/editEzsignsignatures ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsigndocumentEditEzsignsignaturesV1ResponseMPayload.md b/docs/EzsigndocumentEditEzsignsignaturesV1ResponseMPayload.md index 25b861d26..8a4368c50 100644 --- a/docs/EzsigndocumentEditEzsignsignaturesV1ResponseMPayload.md +++ b/docs/EzsigndocumentEditEzsignsignaturesV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for PUT /1/object/ezsigndocument/{pkiEzsigndocumentID}/editEzsignsignatures ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_pki_ezsignsignature_id** | **List[int]** | | diff --git a/docs/EzsigndocumentEndPrematurelyV1Response.md b/docs/EzsigndocumentEndPrematurelyV1Response.md index 5a85eb24e..189363d71 100644 --- a/docs/EzsigndocumentEndPrematurelyV1Response.md +++ b/docs/EzsigndocumentEndPrematurelyV1Response.md @@ -3,6 +3,7 @@ Response for POST /1/object/ezsigndocument/{pkiEzsigndocument}/endPrematurely ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsigndocumentFlattenV1Response.md b/docs/EzsigndocumentFlattenV1Response.md index c75cb8722..3fee2196c 100644 --- a/docs/EzsigndocumentFlattenV1Response.md +++ b/docs/EzsigndocumentFlattenV1Response.md @@ -3,6 +3,7 @@ Response for POST /1/object/ezsigndocument/{pkiEzsigndocument}/flatten ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsigndocumentGetActionableElementsV1Response.md b/docs/EzsigndocumentGetActionableElementsV1Response.md index 705227bc6..3e91014a8 100644 --- a/docs/EzsigndocumentGetActionableElementsV1Response.md +++ b/docs/EzsigndocumentGetActionableElementsV1Response.md @@ -3,6 +3,7 @@ Response for GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getActionableElements ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsigndocumentGetActionableElementsV1ResponseMPayload.md b/docs/EzsigndocumentGetActionableElementsV1ResponseMPayload.md index 61e48f453..82cd25016 100644 --- a/docs/EzsigndocumentGetActionableElementsV1ResponseMPayload.md +++ b/docs/EzsigndocumentGetActionableElementsV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getActionableElements ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_ezsignsignature** | [**List[EzsignsignatureResponseCompound]**](EzsignsignatureResponseCompound.md) | | diff --git a/docs/EzsigndocumentGetAttachmentsV1Response.md b/docs/EzsigndocumentGetAttachmentsV1Response.md new file mode 100644 index 000000000..04eb12e08 --- /dev/null +++ b/docs/EzsigndocumentGetAttachmentsV1Response.md @@ -0,0 +1,32 @@ +# EzsigndocumentGetAttachmentsV1Response + +Response for GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getAttachments + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | +**obj_debug** | [**CommonResponseObjDebug**](CommonResponseObjDebug.md) | | [optional] +**m_payload** | [**EzsigndocumentGetAttachmentsV1ResponseMPayload**](EzsigndocumentGetAttachmentsV1ResponseMPayload.md) | | + +## Example + +```python +from eZmaxApi.models.ezsigndocument_get_attachments_v1_response import EzsigndocumentGetAttachmentsV1Response + +# TODO update the JSON string below +json = "{}" +# create an instance of EzsigndocumentGetAttachmentsV1Response from a JSON string +ezsigndocument_get_attachments_v1_response_instance = EzsigndocumentGetAttachmentsV1Response.from_json(json) +# print the JSON string representation of the object +print EzsigndocumentGetAttachmentsV1Response.to_json() + +# convert the object into a dict +ezsigndocument_get_attachments_v1_response_dict = ezsigndocument_get_attachments_v1_response_instance.to_dict() +# create an instance of EzsigndocumentGetAttachmentsV1Response from a dict +ezsigndocument_get_attachments_v1_response_form_dict = ezsigndocument_get_attachments_v1_response.from_dict(ezsigndocument_get_attachments_v1_response_dict) +``` +[[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/docs/EzsigndocumentGetAttachmentsV1ResponseMPayload.md b/docs/EzsigndocumentGetAttachmentsV1ResponseMPayload.md new file mode 100644 index 000000000..c8c613686 --- /dev/null +++ b/docs/EzsigndocumentGetAttachmentsV1ResponseMPayload.md @@ -0,0 +1,30 @@ +# EzsigndocumentGetAttachmentsV1ResponseMPayload + +Response for GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getAttachments + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**a_obj_attachmentdocumenttype** | [**List[CustomAttachmentdocumenttypeResponse]**](CustomAttachmentdocumenttypeResponse.md) | | + +## Example + +```python +from eZmaxApi.models.ezsigndocument_get_attachments_v1_response_m_payload import EzsigndocumentGetAttachmentsV1ResponseMPayload + +# TODO update the JSON string below +json = "{}" +# create an instance of EzsigndocumentGetAttachmentsV1ResponseMPayload from a JSON string +ezsigndocument_get_attachments_v1_response_m_payload_instance = EzsigndocumentGetAttachmentsV1ResponseMPayload.from_json(json) +# print the JSON string representation of the object +print EzsigndocumentGetAttachmentsV1ResponseMPayload.to_json() + +# convert the object into a dict +ezsigndocument_get_attachments_v1_response_m_payload_dict = ezsigndocument_get_attachments_v1_response_m_payload_instance.to_dict() +# create an instance of EzsigndocumentGetAttachmentsV1ResponseMPayload from a dict +ezsigndocument_get_attachments_v1_response_m_payload_form_dict = ezsigndocument_get_attachments_v1_response_m_payload.from_dict(ezsigndocument_get_attachments_v1_response_m_payload_dict) +``` +[[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/docs/EzsigndocumentGetCompletedElementsV1Response.md b/docs/EzsigndocumentGetCompletedElementsV1Response.md index be0b923f1..e5bb921ab 100644 --- a/docs/EzsigndocumentGetCompletedElementsV1Response.md +++ b/docs/EzsigndocumentGetCompletedElementsV1Response.md @@ -3,6 +3,7 @@ Response for GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getCompletedElements ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsigndocumentGetCompletedElementsV1ResponseMPayload.md b/docs/EzsigndocumentGetCompletedElementsV1ResponseMPayload.md index 24505acb8..8a7b13684 100644 --- a/docs/EzsigndocumentGetCompletedElementsV1ResponseMPayload.md +++ b/docs/EzsigndocumentGetCompletedElementsV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getCompletedElements ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_ezsignsignature** | [**List[EzsignsignatureResponseCompound]**](EzsignsignatureResponseCompound.md) | | diff --git a/docs/EzsigndocumentGetDownloadUrlV1Response.md b/docs/EzsigndocumentGetDownloadUrlV1Response.md index 426fcb7b1..b7d327e31 100644 --- a/docs/EzsigndocumentGetDownloadUrlV1Response.md +++ b/docs/EzsigndocumentGetDownloadUrlV1Response.md @@ -3,6 +3,7 @@ Response for GET /1/object/ezsigndocument/{pkiEzsigndocument}/getDownloadUrl ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsigndocumentGetDownloadUrlV1ResponseMPayload.md b/docs/EzsigndocumentGetDownloadUrlV1ResponseMPayload.md index 2b2488df2..3d8dceb44 100644 --- a/docs/EzsigndocumentGetDownloadUrlV1ResponseMPayload.md +++ b/docs/EzsigndocumentGetDownloadUrlV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for GET /1/object/ezsigndocument/{pkiEzsigndocument}/getDownloadUrl ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **s_download_url** | **str** | The Url to the requested document. Url will expire after 5 minutes. | diff --git a/docs/EzsigndocumentGetEzsignannotationsV1Response.md b/docs/EzsigndocumentGetEzsignannotationsV1Response.md index fc67b873e..df0ca94f9 100644 --- a/docs/EzsigndocumentGetEzsignannotationsV1Response.md +++ b/docs/EzsigndocumentGetEzsignannotationsV1Response.md @@ -3,6 +3,7 @@ Response for GET /1/object/ezsigndocument/{pkiEzsigndocument}/getEzsignannotations ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsigndocumentGetEzsignannotationsV1ResponseMPayload.md b/docs/EzsigndocumentGetEzsignannotationsV1ResponseMPayload.md index b6ec47ad9..e869988dd 100644 --- a/docs/EzsigndocumentGetEzsignannotationsV1ResponseMPayload.md +++ b/docs/EzsigndocumentGetEzsignannotationsV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for GET /1/object/ezsigndocument/{pkiEzsigndocument}/getEzsignannotations ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_ezsignannotation** | [**List[EzsignannotationResponseCompound]**](EzsignannotationResponseCompound.md) | | diff --git a/docs/EzsigndocumentGetEzsignformfieldgroupsV1Response.md b/docs/EzsigndocumentGetEzsignformfieldgroupsV1Response.md index 37e8cfa4a..274998f31 100644 --- a/docs/EzsigndocumentGetEzsignformfieldgroupsV1Response.md +++ b/docs/EzsigndocumentGetEzsignformfieldgroupsV1Response.md @@ -3,6 +3,7 @@ Response for GET /1/object/ezsigndocument/{pkiEzsigndocument}/getEzsignformfieldgroups ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsigndocumentGetEzsignformfieldgroupsV1ResponseMPayload.md b/docs/EzsigndocumentGetEzsignformfieldgroupsV1ResponseMPayload.md index 21ec33305..f7bfc86d4 100644 --- a/docs/EzsigndocumentGetEzsignformfieldgroupsV1ResponseMPayload.md +++ b/docs/EzsigndocumentGetEzsignformfieldgroupsV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for GET /1/object/ezsigndocument/{pkiEzsigndocument}/getEzsignformfieldgroups ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_ezsignformfieldgroup** | [**List[EzsignformfieldgroupResponseCompound]**](EzsignformfieldgroupResponseCompound.md) | | diff --git a/docs/EzsigndocumentGetEzsignpagesV1Response.md b/docs/EzsigndocumentGetEzsignpagesV1Response.md index 39027058b..89bebbef5 100644 --- a/docs/EzsigndocumentGetEzsignpagesV1Response.md +++ b/docs/EzsigndocumentGetEzsignpagesV1Response.md @@ -3,6 +3,7 @@ Response for GET /1/object/ezsigndocument/{pkiEzsigndocument}/getEzsignpages ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsigndocumentGetEzsignpagesV1ResponseMPayload.md b/docs/EzsigndocumentGetEzsignpagesV1ResponseMPayload.md index ac69ab38d..114d7afa8 100644 --- a/docs/EzsigndocumentGetEzsignpagesV1ResponseMPayload.md +++ b/docs/EzsigndocumentGetEzsignpagesV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for GET /1/object/ezsigndocument/{pkiEzsigndocument}/getEzsignpages ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_ezsignpage** | [**List[EzsignpageResponseCompound]**](EzsignpageResponseCompound.md) | | diff --git a/docs/EzsigndocumentGetEzsignsignaturesAutomaticV1Response.md b/docs/EzsigndocumentGetEzsignsignaturesAutomaticV1Response.md index 14c14e000..dc980e3e8 100644 --- a/docs/EzsigndocumentGetEzsignsignaturesAutomaticV1Response.md +++ b/docs/EzsigndocumentGetEzsignsignaturesAutomaticV1Response.md @@ -3,6 +3,7 @@ Response for GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getEzsignsignaturesAutomatic ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsigndocumentGetEzsignsignaturesAutomaticV1ResponseMPayload.md b/docs/EzsigndocumentGetEzsignsignaturesAutomaticV1ResponseMPayload.md index 2d03d5450..491bc6abf 100644 --- a/docs/EzsigndocumentGetEzsignsignaturesAutomaticV1ResponseMPayload.md +++ b/docs/EzsigndocumentGetEzsignsignaturesAutomaticV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getEzsignsignaturesAutomatic ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_e_ezsignsignature_type** | [**List[FieldEEzsignsignatureType]**](FieldEEzsignsignatureType.md) | All eEzsignsignatureType contained in the response | diff --git a/docs/EzsigndocumentGetEzsignsignaturesV1Response.md b/docs/EzsigndocumentGetEzsignsignaturesV1Response.md index a82eed5d9..878c6dcdb 100644 --- a/docs/EzsigndocumentGetEzsignsignaturesV1Response.md +++ b/docs/EzsigndocumentGetEzsignsignaturesV1Response.md @@ -3,6 +3,7 @@ Response for GET /1/object/ezsigndocument/{pkiEzsigndocument}/getEzsignsignatures ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsigndocumentGetEzsignsignaturesV1ResponseMPayload.md b/docs/EzsigndocumentGetEzsignsignaturesV1ResponseMPayload.md index 1e26415e0..1cd0d7990 100644 --- a/docs/EzsigndocumentGetEzsignsignaturesV1ResponseMPayload.md +++ b/docs/EzsigndocumentGetEzsignsignaturesV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for GET /1/object/ezsigndocument/{pkiEzsigndocument}/getEzsignsignatures ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_ezsignsignature** | [**List[EzsignsignatureResponseCompound]**](EzsignsignatureResponseCompound.md) | | diff --git a/docs/EzsigndocumentGetFormDataV1Response.md b/docs/EzsigndocumentGetFormDataV1Response.md index ea8bded46..84903d228 100644 --- a/docs/EzsigndocumentGetFormDataV1Response.md +++ b/docs/EzsigndocumentGetFormDataV1Response.md @@ -3,6 +3,7 @@ Response for GET /1/object/ezsigndocument/{pkiEzsigndocument}/getFormData ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsigndocumentGetFormDataV1ResponseMPayload.md b/docs/EzsigndocumentGetFormDataV1ResponseMPayload.md index cf4450e0a..d241991ea 100644 --- a/docs/EzsigndocumentGetFormDataV1ResponseMPayload.md +++ b/docs/EzsigndocumentGetFormDataV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for GET /1/object/ezsigndocument/{pkiEzsigndocument}/getFormData ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_form_data_document** | [**CustomFormDataDocumentResponse**](CustomFormDataDocumentResponse.md) | | diff --git a/docs/EzsigndocumentGetObjectV1Response.md b/docs/EzsigndocumentGetObjectV1Response.md index 7dcbb680f..6e6703ce4 100644 --- a/docs/EzsigndocumentGetObjectV1Response.md +++ b/docs/EzsigndocumentGetObjectV1Response.md @@ -3,6 +3,7 @@ Response for GET /1/object/ezsigndocument/{pkiEzsigndocumentID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsigndocumentGetObjectV1ResponseMPayload.md b/docs/EzsigndocumentGetObjectV1ResponseMPayload.md index 239b21090..4e396948e 100644 --- a/docs/EzsigndocumentGetObjectV1ResponseMPayload.md +++ b/docs/EzsigndocumentGetObjectV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for GET /1/object/ezsigndocument/{pkiEzsigndocumentID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsigndocument_id** | **int** | The unique ID of the Ezsigndocument | @@ -26,6 +27,7 @@ Name | Type | Description | Notes **b_ezsigndocument_hassignedsignatures** | **bool** | If the Ezsigndocument contains signed signatures (From internal or external sources) | [optional] **obj_audit** | [**CommonAudit**](CommonAudit.md) | | [optional] **s_ezsigndocument_externalid** | **str** | This field can be used to store an External ID from the client's system. Anything can be stored in this field, it will never be evaluated by the eZmax system and will be returned AS-IS. To store multiple values, consider using a JSON formatted structure, a URL encoded string, a CSV or any other custom format. | [optional] +**i_ezsigndocument_ezsignsignatureattachmenttotal** | **int** | The number of Ezsigndocumentattachment total | **e_ezsigndocument_steptype** | [**ComputedEEzsigndocumentSteptype**](ComputedEEzsigndocumentSteptype.md) | | **i_ezsigndocument_stepformtotal** | **int** | The total number of steps in the form filling phase | **i_ezsigndocument_stepformcurrent** | **int** | The current step in the form filling phase | diff --git a/docs/EzsigndocumentGetObjectV2Response.md b/docs/EzsigndocumentGetObjectV2Response.md index 1d6f5ae3b..73b847b5b 100644 --- a/docs/EzsigndocumentGetObjectV2Response.md +++ b/docs/EzsigndocumentGetObjectV2Response.md @@ -3,6 +3,7 @@ Response for GET /2/object/ezsigndocument/{pkiEzsigndocumentID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsigndocumentGetObjectV2ResponseMPayload.md b/docs/EzsigndocumentGetObjectV2ResponseMPayload.md index 25be9c508..d24e17c68 100644 --- a/docs/EzsigndocumentGetObjectV2ResponseMPayload.md +++ b/docs/EzsigndocumentGetObjectV2ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for GET /2/object/ezsigndocument/{pkiEzsigndocumentID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_ezsigndocument** | [**EzsigndocumentResponseCompound**](EzsigndocumentResponseCompound.md) | | diff --git a/docs/EzsigndocumentGetTemporaryProofV1Response.md b/docs/EzsigndocumentGetTemporaryProofV1Response.md index 276788060..d12f65e84 100644 --- a/docs/EzsigndocumentGetTemporaryProofV1Response.md +++ b/docs/EzsigndocumentGetTemporaryProofV1Response.md @@ -3,6 +3,7 @@ Response for GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getTemporaryProof ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsigndocumentGetTemporaryProofV1ResponseMPayload.md b/docs/EzsigndocumentGetTemporaryProofV1ResponseMPayload.md index 3a2ff2bee..460830eba 100644 --- a/docs/EzsigndocumentGetTemporaryProofV1ResponseMPayload.md +++ b/docs/EzsigndocumentGetTemporaryProofV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getTemporaryProof ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_ezsigndocumentlog** | [**List[EzsigndocumentlogResponseCompound]**](EzsigndocumentlogResponseCompound.md) | | diff --git a/docs/EzsigndocumentGetWordsPositionsV1Request.md b/docs/EzsigndocumentGetWordsPositionsV1Request.md index d91a7214e..7f4cdabd2 100644 --- a/docs/EzsigndocumentGetWordsPositionsV1Request.md +++ b/docs/EzsigndocumentGetWordsPositionsV1Request.md @@ -3,6 +3,7 @@ Request for POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/getWordsPositions ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **e_get** | **str** | Specify if you want to retrieve *All* words or specific *Words* from the document. If you specify *Words*, you must send the list of words to search for in *a_sWord*. | diff --git a/docs/EzsigndocumentGetWordsPositionsV1Response.md b/docs/EzsigndocumentGetWordsPositionsV1Response.md index fe9feb77e..d379eb149 100644 --- a/docs/EzsigndocumentGetWordsPositionsV1Response.md +++ b/docs/EzsigndocumentGetWordsPositionsV1Response.md @@ -3,6 +3,7 @@ Response for POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/getWordsPositions ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsigndocumentPatchObjectV1Request.md b/docs/EzsigndocumentPatchObjectV1Request.md index 476403bcb..863c13f45 100644 --- a/docs/EzsigndocumentPatchObjectV1Request.md +++ b/docs/EzsigndocumentPatchObjectV1Request.md @@ -3,6 +3,7 @@ Request for PATCH /1/object/ezsigndocument/{pkiEzsigndocumentID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_ezsigndocument** | [**EzsigndocumentRequestPatch**](EzsigndocumentRequestPatch.md) | | diff --git a/docs/EzsigndocumentPatchObjectV1Response.md b/docs/EzsigndocumentPatchObjectV1Response.md index 9473de26b..457ab7219 100644 --- a/docs/EzsigndocumentPatchObjectV1Response.md +++ b/docs/EzsigndocumentPatchObjectV1Response.md @@ -3,6 +3,7 @@ Response for PATCH /1/object/ezsigndocument/{pkiEzsigndocumentID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsigndocumentRequest.md b/docs/EzsigndocumentRequest.md index 10d521411..5e9b7571e 100644 --- a/docs/EzsigndocumentRequest.md +++ b/docs/EzsigndocumentRequest.md @@ -3,6 +3,7 @@ An Ezsigndocument Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsigndocument_id** | **int** | The unique ID of the Ezsigndocument | [optional] diff --git a/docs/EzsigndocumentRequestCompound.md b/docs/EzsigndocumentRequestCompound.md index beb59c4f3..3247f1f0a 100644 --- a/docs/EzsigndocumentRequestCompound.md +++ b/docs/EzsigndocumentRequestCompound.md @@ -3,6 +3,7 @@ An Ezsigndocument Object and children to create a complete structure ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsigndocument_id** | **int** | The unique ID of the Ezsigndocument | [optional] diff --git a/docs/EzsigndocumentRequestPatch.md b/docs/EzsigndocumentRequestPatch.md index bd836d5f6..eafbf7fa8 100644 --- a/docs/EzsigndocumentRequestPatch.md +++ b/docs/EzsigndocumentRequestPatch.md @@ -3,6 +3,7 @@ An Ezsigndocument Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **dt_ezsigndocument_duedate** | **str** | The maximum date and time at which the Ezsigndocument can be signed. | [optional] diff --git a/docs/EzsigndocumentResponse.md b/docs/EzsigndocumentResponse.md index 08715c6a8..4257397c2 100644 --- a/docs/EzsigndocumentResponse.md +++ b/docs/EzsigndocumentResponse.md @@ -3,6 +3,7 @@ An Ezsigndocument Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsigndocument_id** | **int** | The unique ID of the Ezsigndocument | @@ -26,6 +27,7 @@ Name | Type | Description | Notes **b_ezsigndocument_hassignedsignatures** | **bool** | If the Ezsigndocument contains signed signatures (From internal or external sources) | [optional] **obj_audit** | [**CommonAudit**](CommonAudit.md) | | [optional] **s_ezsigndocument_externalid** | **str** | This field can be used to store an External ID from the client's system. Anything can be stored in this field, it will never be evaluated by the eZmax system and will be returned AS-IS. To store multiple values, consider using a JSON formatted structure, a URL encoded string, a CSV or any other custom format. | [optional] +**i_ezsigndocument_ezsignsignatureattachmenttotal** | **int** | The number of Ezsigndocumentattachment total | ## Example diff --git a/docs/EzsigndocumentResponseCompound.md b/docs/EzsigndocumentResponseCompound.md index 06b9fad27..a74f87e94 100644 --- a/docs/EzsigndocumentResponseCompound.md +++ b/docs/EzsigndocumentResponseCompound.md @@ -3,6 +3,7 @@ An Ezsigndocument Object and children to create a complete structure ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsigndocument_id** | **int** | The unique ID of the Ezsigndocument | @@ -26,6 +27,7 @@ Name | Type | Description | Notes **b_ezsigndocument_hassignedsignatures** | **bool** | If the Ezsigndocument contains signed signatures (From internal or external sources) | [optional] **obj_audit** | [**CommonAudit**](CommonAudit.md) | | [optional] **s_ezsigndocument_externalid** | **str** | This field can be used to store an External ID from the client's system. Anything can be stored in this field, it will never be evaluated by the eZmax system and will be returned AS-IS. To store multiple values, consider using a JSON formatted structure, a URL encoded string, a CSV or any other custom format. | [optional] +**i_ezsigndocument_ezsignsignatureattachmenttotal** | **int** | The number of Ezsigndocumentattachment total | **e_ezsigndocument_steptype** | [**ComputedEEzsigndocumentSteptype**](ComputedEEzsigndocumentSteptype.md) | | **i_ezsigndocument_stepformtotal** | **int** | The total number of steps in the form filling phase | **i_ezsigndocument_stepformcurrent** | **int** | The current step in the form filling phase | diff --git a/docs/EzsigndocumentSubmitEzsignformV1Request.md b/docs/EzsigndocumentSubmitEzsignformV1Request.md index 865d64fd1..06d78e90a 100644 --- a/docs/EzsigndocumentSubmitEzsignformV1Request.md +++ b/docs/EzsigndocumentSubmitEzsignformV1Request.md @@ -3,6 +3,7 @@ Request for POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/submitEzsignform ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **b_ezsignform_isdraft** | **bool** | Whether the Ezsignform submitted is a draft or not. | diff --git a/docs/EzsigndocumentSubmitEzsignformV1Response.md b/docs/EzsigndocumentSubmitEzsignformV1Response.md index a5ba94f83..3646a3af1 100644 --- a/docs/EzsigndocumentSubmitEzsignformV1Response.md +++ b/docs/EzsigndocumentSubmitEzsignformV1Response.md @@ -3,6 +3,7 @@ Response for POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/submitEzsignform ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsigndocumentUnsendV1Response.md b/docs/EzsigndocumentUnsendV1Response.md index 23ef6e3ac..d0dc7a5ca 100644 --- a/docs/EzsigndocumentUnsendV1Response.md +++ b/docs/EzsigndocumentUnsendV1Response.md @@ -3,6 +3,7 @@ Response for POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/unsend ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsigndocumentlogResponse.md b/docs/EzsigndocumentlogResponse.md index 71eb5c901..d1ab416db 100644 --- a/docs/EzsigndocumentlogResponse.md +++ b/docs/EzsigndocumentlogResponse.md @@ -3,6 +3,7 @@ An Ezsigndocumentlog Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **fki_user_id** | **int** | The unique ID of the User | [optional] diff --git a/docs/EzsigndocumentlogResponseCompound.md b/docs/EzsigndocumentlogResponseCompound.md index 97c6ba6c8..98826bc6f 100644 --- a/docs/EzsigndocumentlogResponseCompound.md +++ b/docs/EzsigndocumentlogResponseCompound.md @@ -3,6 +3,7 @@ An Ezsigndocumentlog Object and children to create a complete structure ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **fki_user_id** | **int** | The unique ID of the User | [optional] diff --git a/docs/EzsignelementdependencyRequest.md b/docs/EzsignelementdependencyRequest.md index 3a12091e0..d5d422460 100644 --- a/docs/EzsignelementdependencyRequest.md +++ b/docs/EzsignelementdependencyRequest.md @@ -3,6 +3,7 @@ An Ezsignelementdependency Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsignelementdependency_id** | **int** | The unique ID of the Ezsignelementdependency | [optional] diff --git a/docs/EzsignelementdependencyRequestCompound.md b/docs/EzsignelementdependencyRequestCompound.md index 4229a4509..15f8262bd 100644 --- a/docs/EzsignelementdependencyRequestCompound.md +++ b/docs/EzsignelementdependencyRequestCompound.md @@ -3,6 +3,7 @@ An Ezsignelementdependency Object and children to create a complete structure ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsignelementdependency_id** | **int** | The unique ID of the Ezsignelementdependency | [optional] diff --git a/docs/EzsignelementdependencyResponse.md b/docs/EzsignelementdependencyResponse.md index 86217682a..aa2363c3f 100644 --- a/docs/EzsignelementdependencyResponse.md +++ b/docs/EzsignelementdependencyResponse.md @@ -3,6 +3,7 @@ An Ezsignelementdependency Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsignelementdependency_id** | **int** | The unique ID of the Ezsignelementdependency | diff --git a/docs/EzsignelementdependencyResponseCompound.md b/docs/EzsignelementdependencyResponseCompound.md index b1c6f73b6..7520deb4f 100644 --- a/docs/EzsignelementdependencyResponseCompound.md +++ b/docs/EzsignelementdependencyResponseCompound.md @@ -3,6 +3,7 @@ An Ezsignelementdependency Object and children to create a complete structure ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsignelementdependency_id** | **int** | The unique ID of the Ezsignelementdependency | diff --git a/docs/EzsignfolderArchiveV1Response.md b/docs/EzsignfolderArchiveV1Response.md index be03a4887..c70d9cd96 100644 --- a/docs/EzsignfolderArchiveV1Response.md +++ b/docs/EzsignfolderArchiveV1Response.md @@ -3,6 +3,7 @@ Response for POST /1/object/ezsignfolder/{pkiEzsignfolderID}/archive ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsignfolderBatchDownloadV1Request.md b/docs/EzsignfolderBatchDownloadV1Request.md index 1fafbbd22..b6b6946cc 100644 --- a/docs/EzsignfolderBatchDownloadV1Request.md +++ b/docs/EzsignfolderBatchDownloadV1Request.md @@ -3,6 +3,7 @@ Request for POST /1/object/ezsignfolder/{pkiEzsignfolderID}/batchDownload ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_pki_ezsigndocument_id** | **List[int]** | | diff --git a/docs/EzsignfolderCreateObjectV1Request.md b/docs/EzsignfolderCreateObjectV1Request.md index 19af78515..173a83cc5 100644 --- a/docs/EzsignfolderCreateObjectV1Request.md +++ b/docs/EzsignfolderCreateObjectV1Request.md @@ -3,6 +3,7 @@ Request for POST /1/object/ezsignfolder ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_ezsignfolder** | [**EzsignfolderRequest**](EzsignfolderRequest.md) | | [optional] diff --git a/docs/EzsignfolderCreateObjectV1Response.md b/docs/EzsignfolderCreateObjectV1Response.md index 66eb226ed..f52e37159 100644 --- a/docs/EzsignfolderCreateObjectV1Response.md +++ b/docs/EzsignfolderCreateObjectV1Response.md @@ -3,6 +3,7 @@ Response for POST /1/object/ezsignfolder ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsignfolderCreateObjectV1ResponseMPayload.md b/docs/EzsignfolderCreateObjectV1ResponseMPayload.md index d06bf630a..c70ab8c35 100644 --- a/docs/EzsignfolderCreateObjectV1ResponseMPayload.md +++ b/docs/EzsignfolderCreateObjectV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for POST /1/object/ezsignfolder ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_pki_ezsignfolder_id** | **List[int]** | An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request. | diff --git a/docs/EzsignfolderCreateObjectV2Request.md b/docs/EzsignfolderCreateObjectV2Request.md index 0052eaa8c..4f0f9ab44 100644 --- a/docs/EzsignfolderCreateObjectV2Request.md +++ b/docs/EzsignfolderCreateObjectV2Request.md @@ -3,6 +3,7 @@ Request for POST /2/object/ezsignfolder ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_ezsignfolder** | [**List[EzsignfolderRequestCompound]**](EzsignfolderRequestCompound.md) | | diff --git a/docs/EzsignfolderCreateObjectV2Response.md b/docs/EzsignfolderCreateObjectV2Response.md index 239a97ce9..e5843e934 100644 --- a/docs/EzsignfolderCreateObjectV2Response.md +++ b/docs/EzsignfolderCreateObjectV2Response.md @@ -3,6 +3,7 @@ Response for POST /2/object/ezsignfolder ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsignfolderCreateObjectV2ResponseMPayload.md b/docs/EzsignfolderCreateObjectV2ResponseMPayload.md index 7e9b60967..b04ade3b1 100644 --- a/docs/EzsignfolderCreateObjectV2ResponseMPayload.md +++ b/docs/EzsignfolderCreateObjectV2ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for POST /2/object/ezsignfolder ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_pki_ezsignfolder_id** | **List[int]** | An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request. | diff --git a/docs/EzsignfolderDeleteObjectV1Response.md b/docs/EzsignfolderDeleteObjectV1Response.md index ef0cc1751..142e0a0a1 100644 --- a/docs/EzsignfolderDeleteObjectV1Response.md +++ b/docs/EzsignfolderDeleteObjectV1Response.md @@ -3,6 +3,7 @@ Response for DELETE /1/object/ezsignfolder/{pkiEzsignfolderID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsignfolderDisposeEzsignfoldersV1Request.md b/docs/EzsignfolderDisposeEzsignfoldersV1Request.md index 80c4856a6..2c26d4ccf 100644 --- a/docs/EzsignfolderDisposeEzsignfoldersV1Request.md +++ b/docs/EzsignfolderDisposeEzsignfoldersV1Request.md @@ -3,6 +3,7 @@ Request for POST /1/object/ezsignfolder/disposeEzsignfolders ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_pki_ezsignfolder_id** | **List[int]** | | diff --git a/docs/EzsignfolderDisposeEzsignfoldersV1Response.md b/docs/EzsignfolderDisposeEzsignfoldersV1Response.md index a83119c24..55a842e0a 100644 --- a/docs/EzsignfolderDisposeEzsignfoldersV1Response.md +++ b/docs/EzsignfolderDisposeEzsignfoldersV1Response.md @@ -3,6 +3,7 @@ Response for POST /1/object/ezsignfolder/disposeEzsignfolders ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsignfolderDisposeV1Response.md b/docs/EzsignfolderDisposeV1Response.md index 38df0bfa2..cac17a903 100644 --- a/docs/EzsignfolderDisposeV1Response.md +++ b/docs/EzsignfolderDisposeV1Response.md @@ -3,6 +3,7 @@ Response for POST /1/object/ezsignfolder/{pkiEzsignfolderID}/dispose ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsignfolderEditObjectV1Request.md b/docs/EzsignfolderEditObjectV1Request.md index 96962e085..6d49d56e8 100644 --- a/docs/EzsignfolderEditObjectV1Request.md +++ b/docs/EzsignfolderEditObjectV1Request.md @@ -3,6 +3,7 @@ Request for PUT /1/object/ezsignfolder/{pkiEzsignfolderID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_ezsignfolder** | [**EzsignfolderRequestCompound**](EzsignfolderRequestCompound.md) | | diff --git a/docs/EzsignfolderEditObjectV1Response.md b/docs/EzsignfolderEditObjectV1Response.md index b7716f664..69a0762c9 100644 --- a/docs/EzsignfolderEditObjectV1Response.md +++ b/docs/EzsignfolderEditObjectV1Response.md @@ -3,6 +3,7 @@ Response for PUT /1/object/ezsignfolder/{pkiEzsignfolderID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsignfolderGetActionableElementsV1Response.md b/docs/EzsignfolderGetActionableElementsV1Response.md index af20e5306..abdd2507c 100644 --- a/docs/EzsignfolderGetActionableElementsV1Response.md +++ b/docs/EzsignfolderGetActionableElementsV1Response.md @@ -3,6 +3,7 @@ Response for GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getActionableElements ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsignfolderGetActionableElementsV1ResponseMPayload.md b/docs/EzsignfolderGetActionableElementsV1ResponseMPayload.md index b80f222ec..1e7d4f07a 100644 --- a/docs/EzsignfolderGetActionableElementsV1ResponseMPayload.md +++ b/docs/EzsignfolderGetActionableElementsV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getActionableElements ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_ezsignsignature** | [**List[EzsignsignatureResponseCompound]**](EzsignsignatureResponseCompound.md) | | diff --git a/docs/EzsignfolderGetAttachmentCountV1Response.md b/docs/EzsignfolderGetAttachmentCountV1Response.md new file mode 100644 index 000000000..c01fe983f --- /dev/null +++ b/docs/EzsignfolderGetAttachmentCountV1Response.md @@ -0,0 +1,32 @@ +# EzsignfolderGetAttachmentCountV1Response + +Response for GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getAttachmentCount + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | +**obj_debug** | [**CommonResponseObjDebug**](CommonResponseObjDebug.md) | | [optional] +**m_payload** | [**EzsignfolderGetAttachmentCountV1ResponseMPayload**](EzsignfolderGetAttachmentCountV1ResponseMPayload.md) | | + +## Example + +```python +from eZmaxApi.models.ezsignfolder_get_attachment_count_v1_response import EzsignfolderGetAttachmentCountV1Response + +# TODO update the JSON string below +json = "{}" +# create an instance of EzsignfolderGetAttachmentCountV1Response from a JSON string +ezsignfolder_get_attachment_count_v1_response_instance = EzsignfolderGetAttachmentCountV1Response.from_json(json) +# print the JSON string representation of the object +print EzsignfolderGetAttachmentCountV1Response.to_json() + +# convert the object into a dict +ezsignfolder_get_attachment_count_v1_response_dict = ezsignfolder_get_attachment_count_v1_response_instance.to_dict() +# create an instance of EzsignfolderGetAttachmentCountV1Response from a dict +ezsignfolder_get_attachment_count_v1_response_form_dict = ezsignfolder_get_attachment_count_v1_response.from_dict(ezsignfolder_get_attachment_count_v1_response_dict) +``` +[[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/docs/EzsignfolderGetAttachmentCountV1ResponseMPayload.md b/docs/EzsignfolderGetAttachmentCountV1ResponseMPayload.md new file mode 100644 index 000000000..51cc3b2e2 --- /dev/null +++ b/docs/EzsignfolderGetAttachmentCountV1ResponseMPayload.md @@ -0,0 +1,30 @@ +# EzsignfolderGetAttachmentCountV1ResponseMPayload + +Response for GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getAttachmentCount + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**i_attachment_count** | **int** | The count of Attachment. | + +## Example + +```python +from eZmaxApi.models.ezsignfolder_get_attachment_count_v1_response_m_payload import EzsignfolderGetAttachmentCountV1ResponseMPayload + +# TODO update the JSON string below +json = "{}" +# create an instance of EzsignfolderGetAttachmentCountV1ResponseMPayload from a JSON string +ezsignfolder_get_attachment_count_v1_response_m_payload_instance = EzsignfolderGetAttachmentCountV1ResponseMPayload.from_json(json) +# print the JSON string representation of the object +print EzsignfolderGetAttachmentCountV1ResponseMPayload.to_json() + +# convert the object into a dict +ezsignfolder_get_attachment_count_v1_response_m_payload_dict = ezsignfolder_get_attachment_count_v1_response_m_payload_instance.to_dict() +# create an instance of EzsignfolderGetAttachmentCountV1ResponseMPayload from a dict +ezsignfolder_get_attachment_count_v1_response_m_payload_form_dict = ezsignfolder_get_attachment_count_v1_response_m_payload.from_dict(ezsignfolder_get_attachment_count_v1_response_m_payload_dict) +``` +[[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/docs/EzsignfolderGetAttachmentsV1Response.md b/docs/EzsignfolderGetAttachmentsV1Response.md new file mode 100644 index 000000000..3e9f1a921 --- /dev/null +++ b/docs/EzsignfolderGetAttachmentsV1Response.md @@ -0,0 +1,32 @@ +# EzsignfolderGetAttachmentsV1Response + +Response for GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getAttachments + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | +**obj_debug** | [**CommonResponseObjDebug**](CommonResponseObjDebug.md) | | [optional] +**m_payload** | [**EzsignfolderGetAttachmentsV1ResponseMPayload**](EzsignfolderGetAttachmentsV1ResponseMPayload.md) | | + +## Example + +```python +from eZmaxApi.models.ezsignfolder_get_attachments_v1_response import EzsignfolderGetAttachmentsV1Response + +# TODO update the JSON string below +json = "{}" +# create an instance of EzsignfolderGetAttachmentsV1Response from a JSON string +ezsignfolder_get_attachments_v1_response_instance = EzsignfolderGetAttachmentsV1Response.from_json(json) +# print the JSON string representation of the object +print EzsignfolderGetAttachmentsV1Response.to_json() + +# convert the object into a dict +ezsignfolder_get_attachments_v1_response_dict = ezsignfolder_get_attachments_v1_response_instance.to_dict() +# create an instance of EzsignfolderGetAttachmentsV1Response from a dict +ezsignfolder_get_attachments_v1_response_form_dict = ezsignfolder_get_attachments_v1_response.from_dict(ezsignfolder_get_attachments_v1_response_dict) +``` +[[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/docs/EzsignfolderGetAttachmentsV1ResponseMPayload.md b/docs/EzsignfolderGetAttachmentsV1ResponseMPayload.md new file mode 100644 index 000000000..59246ea03 --- /dev/null +++ b/docs/EzsignfolderGetAttachmentsV1ResponseMPayload.md @@ -0,0 +1,30 @@ +# EzsignfolderGetAttachmentsV1ResponseMPayload + +Response for GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getAttachments + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**a_obj_attachmentdocumenttype** | [**List[CustomAttachmentdocumenttypeResponse]**](CustomAttachmentdocumenttypeResponse.md) | | + +## Example + +```python +from eZmaxApi.models.ezsignfolder_get_attachments_v1_response_m_payload import EzsignfolderGetAttachmentsV1ResponseMPayload + +# TODO update the JSON string below +json = "{}" +# create an instance of EzsignfolderGetAttachmentsV1ResponseMPayload from a JSON string +ezsignfolder_get_attachments_v1_response_m_payload_instance = EzsignfolderGetAttachmentsV1ResponseMPayload.from_json(json) +# print the JSON string representation of the object +print EzsignfolderGetAttachmentsV1ResponseMPayload.to_json() + +# convert the object into a dict +ezsignfolder_get_attachments_v1_response_m_payload_dict = ezsignfolder_get_attachments_v1_response_m_payload_instance.to_dict() +# create an instance of EzsignfolderGetAttachmentsV1ResponseMPayload from a dict +ezsignfolder_get_attachments_v1_response_m_payload_form_dict = ezsignfolder_get_attachments_v1_response_m_payload.from_dict(ezsignfolder_get_attachments_v1_response_m_payload_dict) +``` +[[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/docs/EzsignfolderGetCommunicationCountV1Response.md b/docs/EzsignfolderGetCommunicationCountV1Response.md index 078bdcf8b..e693cf151 100644 --- a/docs/EzsignfolderGetCommunicationCountV1Response.md +++ b/docs/EzsignfolderGetCommunicationCountV1Response.md @@ -3,6 +3,7 @@ Response for GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getCommunicationCount ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsignfolderGetCommunicationCountV1ResponseMPayload.md b/docs/EzsignfolderGetCommunicationCountV1ResponseMPayload.md index 0f5429759..3df7a1918 100644 --- a/docs/EzsignfolderGetCommunicationCountV1ResponseMPayload.md +++ b/docs/EzsignfolderGetCommunicationCountV1ResponseMPayload.md @@ -3,6 +3,7 @@ Response for GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getCommunicationCount ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **i_communication_count** | **int** | The count of Communication. | diff --git a/docs/EzsignfolderGetCommunicationListV1Response.md b/docs/EzsignfolderGetCommunicationListV1Response.md index a195038f2..93f18ca71 100644 --- a/docs/EzsignfolderGetCommunicationListV1Response.md +++ b/docs/EzsignfolderGetCommunicationListV1Response.md @@ -3,6 +3,7 @@ Response for GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getCommunicationList ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayloadGetList**](CommonResponseObjDebugPayloadGetList.md) | | diff --git a/docs/EzsignfolderGetCommunicationListV1ResponseMPayload.md b/docs/EzsignfolderGetCommunicationListV1ResponseMPayload.md index ea39bb476..2025fd468 100644 --- a/docs/EzsignfolderGetCommunicationListV1ResponseMPayload.md +++ b/docs/EzsignfolderGetCommunicationListV1ResponseMPayload.md @@ -3,6 +3,7 @@ Response for GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getCommunicationList ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_communication** | [**List[CustomCommunicationListElementResponse]**](CustomCommunicationListElementResponse.md) | | diff --git a/docs/EzsignfolderGetCommunicationrecipientsV1Response.md b/docs/EzsignfolderGetCommunicationrecipientsV1Response.md index 484958ca1..955e6d0cd 100644 --- a/docs/EzsignfolderGetCommunicationrecipientsV1Response.md +++ b/docs/EzsignfolderGetCommunicationrecipientsV1Response.md @@ -3,6 +3,7 @@ Response for GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getCommunicationrecipients ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsignfolderGetCommunicationrecipientsV1ResponseMPayload.md b/docs/EzsignfolderGetCommunicationrecipientsV1ResponseMPayload.md index 06c55440f..734996752 100644 --- a/docs/EzsignfolderGetCommunicationrecipientsV1ResponseMPayload.md +++ b/docs/EzsignfolderGetCommunicationrecipientsV1ResponseMPayload.md @@ -3,6 +3,7 @@ Response for GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getCommunicationrecipients ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_communicationrecipientsgroup** | [**List[CustomCommunicationrecipientsgroupResponse]**](CustomCommunicationrecipientsgroupResponse.md) | | diff --git a/docs/EzsignfolderGetCommunicationsendersV1Response.md b/docs/EzsignfolderGetCommunicationsendersV1Response.md index 50c7f2f50..be747d370 100644 --- a/docs/EzsignfolderGetCommunicationsendersV1Response.md +++ b/docs/EzsignfolderGetCommunicationsendersV1Response.md @@ -3,6 +3,7 @@ Response for GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getCommunicationrecipients ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsignfolderGetCommunicationsendersV1ResponseMPayload.md b/docs/EzsignfolderGetCommunicationsendersV1ResponseMPayload.md index ea9355e7e..4c52d68a5 100644 --- a/docs/EzsignfolderGetCommunicationsendersV1ResponseMPayload.md +++ b/docs/EzsignfolderGetCommunicationsendersV1ResponseMPayload.md @@ -3,6 +3,7 @@ Response for GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getCommunicationsenders ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_communicationsenders** | [**List[CustomCommunicationsenderResponse]**](CustomCommunicationsenderResponse.md) | | diff --git a/docs/EzsignfolderGetEzsigndocumentsV1Response.md b/docs/EzsignfolderGetEzsigndocumentsV1Response.md index eab086589..2ab51ef73 100644 --- a/docs/EzsignfolderGetEzsigndocumentsV1Response.md +++ b/docs/EzsignfolderGetEzsigndocumentsV1Response.md @@ -3,6 +3,7 @@ Response for GET /1/object/ezsignfolder/{pkiEzsignfolder}/getEzsigndocuments ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsignfolderGetEzsigndocumentsV1ResponseMPayload.md b/docs/EzsignfolderGetEzsigndocumentsV1ResponseMPayload.md index 358abe83f..56d440ad9 100644 --- a/docs/EzsignfolderGetEzsigndocumentsV1ResponseMPayload.md +++ b/docs/EzsignfolderGetEzsigndocumentsV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for GET /1/object/ezsignfolder/{pkiEzsignfolder}/getEzsigndocuments ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_ezsigndocument** | [**List[EzsigndocumentResponseCompound]**](EzsigndocumentResponseCompound.md) | | diff --git a/docs/EzsignfolderGetEzsignfoldersignerassociationsV1Response.md b/docs/EzsignfolderGetEzsignfoldersignerassociationsV1Response.md index ae4e313e2..51e49e2d8 100644 --- a/docs/EzsignfolderGetEzsignfoldersignerassociationsV1Response.md +++ b/docs/EzsignfolderGetEzsignfoldersignerassociationsV1Response.md @@ -3,6 +3,7 @@ Response for GET /1/object/ezsignfolder/{pkiEzsignfolder}/getEzsignfoldersignerassociations ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsignfolderGetEzsignfoldersignerassociationsV1ResponseMPayload.md b/docs/EzsignfolderGetEzsignfoldersignerassociationsV1ResponseMPayload.md index fc89de435..5241d3e9b 100644 --- a/docs/EzsignfolderGetEzsignfoldersignerassociationsV1ResponseMPayload.md +++ b/docs/EzsignfolderGetEzsignfoldersignerassociationsV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for GET /1/object/ezsignfolder/{pkiEzsignfolder}/getEzsignfoldersignerassociations ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_ezsignfoldersignerassociation** | [**List[CustomEzsignfoldersignerassociationActionableElementResponse]**](CustomEzsignfoldersignerassociationActionableElementResponse.md) | | diff --git a/docs/EzsignfolderGetEzsignsignaturesAutomaticV1Response.md b/docs/EzsignfolderGetEzsignsignaturesAutomaticV1Response.md index 92097a01f..2da78b1d2 100644 --- a/docs/EzsignfolderGetEzsignsignaturesAutomaticV1Response.md +++ b/docs/EzsignfolderGetEzsignsignaturesAutomaticV1Response.md @@ -3,6 +3,7 @@ Response for GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getEzsignsignaturesAutomatic ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsignfolderGetEzsignsignaturesAutomaticV1ResponseMPayload.md b/docs/EzsignfolderGetEzsignsignaturesAutomaticV1ResponseMPayload.md index bebed754a..4f1210386 100644 --- a/docs/EzsignfolderGetEzsignsignaturesAutomaticV1ResponseMPayload.md +++ b/docs/EzsignfolderGetEzsignsignaturesAutomaticV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getEzsignsignaturesAutomatic ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_e_ezsignsignature_type** | [**List[FieldEEzsignsignatureType]**](FieldEEzsignsignatureType.md) | All eEzsignsignatureType contained in the response | diff --git a/docs/EzsignfolderGetFormsDataV1Response.md b/docs/EzsignfolderGetFormsDataV1Response.md index 20530330a..899eefe84 100644 --- a/docs/EzsignfolderGetFormsDataV1Response.md +++ b/docs/EzsignfolderGetFormsDataV1Response.md @@ -3,6 +3,7 @@ Response for GET /1/object/ezsignfolder/{pkiEzsignfolder}/getFormsData ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsignfolderGetFormsDataV1ResponseMPayload.md b/docs/EzsignfolderGetFormsDataV1ResponseMPayload.md index 7054bbdc8..ff083561e 100644 --- a/docs/EzsignfolderGetFormsDataV1ResponseMPayload.md +++ b/docs/EzsignfolderGetFormsDataV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for GET /1/object/ezsignfolder/{pkiEzsigndocument}/getFormsData ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_forms_data_folder** | [**CustomFormsDataFolderResponse**](CustomFormsDataFolderResponse.md) | | diff --git a/docs/EzsignfolderGetListV1Response.md b/docs/EzsignfolderGetListV1Response.md index 2d6b1d1a4..d46c6e5ea 100644 --- a/docs/EzsignfolderGetListV1Response.md +++ b/docs/EzsignfolderGetListV1Response.md @@ -3,6 +3,7 @@ Response for GET /1/object/ezsignfolder/getList ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayloadGetList**](CommonResponseObjDebugPayloadGetList.md) | | diff --git a/docs/EzsignfolderGetListV1ResponseMPayload.md b/docs/EzsignfolderGetListV1ResponseMPayload.md index 29ee1626f..1c40585f5 100644 --- a/docs/EzsignfolderGetListV1ResponseMPayload.md +++ b/docs/EzsignfolderGetListV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for GET /1/object/ezsignfolder/getList ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **i_row_returned** | **int** | The number of rows returned | diff --git a/docs/EzsignfolderGetObjectV1Response.md b/docs/EzsignfolderGetObjectV1Response.md index dc0e76657..8540fa4d4 100644 --- a/docs/EzsignfolderGetObjectV1Response.md +++ b/docs/EzsignfolderGetObjectV1Response.md @@ -3,6 +3,7 @@ Response for GET /1/object/ezsignfolder/{pkiEzsignfolderID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsignfolderGetObjectV1ResponseMPayload.md b/docs/EzsignfolderGetObjectV1ResponseMPayload.md index b114cf826..3aa943f1e 100644 --- a/docs/EzsignfolderGetObjectV1ResponseMPayload.md +++ b/docs/EzsignfolderGetObjectV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for GET /1/object/ezsignfolder/{pkiEzsignfolderID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsignfolder_id** | **int** | The unique ID of the Ezsignfolder | diff --git a/docs/EzsignfolderGetObjectV2Response.md b/docs/EzsignfolderGetObjectV2Response.md index 89f80a4c5..c67ab08a1 100644 --- a/docs/EzsignfolderGetObjectV2Response.md +++ b/docs/EzsignfolderGetObjectV2Response.md @@ -3,6 +3,7 @@ Response for GET /2/object/ezsignfolder/{pkiEzsignfolderID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsignfolderGetObjectV2ResponseMPayload.md b/docs/EzsignfolderGetObjectV2ResponseMPayload.md index 6dde330f9..50fc33c40 100644 --- a/docs/EzsignfolderGetObjectV2ResponseMPayload.md +++ b/docs/EzsignfolderGetObjectV2ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for GET /2/object/ezsignfolder/{pkiEzsignfolderID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_ezsignfolder** | [**EzsignfolderResponseCompound**](EzsignfolderResponseCompound.md) | | diff --git a/docs/EzsignfolderImportEzsignfoldersignerassociationsV1Request.md b/docs/EzsignfolderImportEzsignfoldersignerassociationsV1Request.md index 5bd097cdc..1760dd6e9 100644 --- a/docs/EzsignfolderImportEzsignfoldersignerassociationsV1Request.md +++ b/docs/EzsignfolderImportEzsignfoldersignerassociationsV1Request.md @@ -3,6 +3,7 @@ Request for POST /1/object/ezsignfolder/{pkiEzsignfolderID}/importEzsignfoldersignerassociations ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_fki_ezsignfoldersignerassociation_id** | **List[int]** | | diff --git a/docs/EzsignfolderImportEzsignfoldersignerassociationsV1Response.md b/docs/EzsignfolderImportEzsignfoldersignerassociationsV1Response.md index e675d35a2..ed00828c8 100644 --- a/docs/EzsignfolderImportEzsignfoldersignerassociationsV1Response.md +++ b/docs/EzsignfolderImportEzsignfoldersignerassociationsV1Response.md @@ -3,6 +3,7 @@ Response for POST /1/object/ezsignfolder/{pkiEzsignfolder}/importEzsignfoldersignerassociations ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsignfolderImportEzsignfoldersignerassociationsV1ResponseMPayload.md b/docs/EzsignfolderImportEzsignfoldersignerassociationsV1ResponseMPayload.md index 869541a49..6e053841d 100644 --- a/docs/EzsignfolderImportEzsignfoldersignerassociationsV1ResponseMPayload.md +++ b/docs/EzsignfolderImportEzsignfoldersignerassociationsV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for POST /1/object/ezsignfolder/{pkiEzsignfolder}/importEzsignfoldersignerassociations ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_pki_ezsignfoldersignerassociation_id** | **List[int]** | | diff --git a/docs/EzsignfolderImportEzsigntemplatepackageV1Request.md b/docs/EzsignfolderImportEzsigntemplatepackageV1Request.md index 228da913b..976c838dc 100644 --- a/docs/EzsignfolderImportEzsigntemplatepackageV1Request.md +++ b/docs/EzsignfolderImportEzsigntemplatepackageV1Request.md @@ -3,6 +3,7 @@ Request for POST /1/object/ezsignfolder/{pkiEzsignfolderID}/importEzsigntemplatepackage ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **fki_ezsigntemplatepackage_id** | **int** | The unique ID of the Ezsigntemplatepackage | diff --git a/docs/EzsignfolderImportEzsigntemplatepackageV1Response.md b/docs/EzsignfolderImportEzsigntemplatepackageV1Response.md index c7e1b6dd8..2f550d24d 100644 --- a/docs/EzsignfolderImportEzsigntemplatepackageV1Response.md +++ b/docs/EzsignfolderImportEzsigntemplatepackageV1Response.md @@ -3,6 +3,7 @@ Response for POST/1/object/ezsignfolder/{pkiEzsignfolderID}/importEzsigntemplatepackage ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsignfolderImportEzsigntemplatepackageV1ResponseMPayload.md b/docs/EzsignfolderImportEzsigntemplatepackageV1ResponseMPayload.md index 9be1bb3bc..24137b65f 100644 --- a/docs/EzsignfolderImportEzsigntemplatepackageV1ResponseMPayload.md +++ b/docs/EzsignfolderImportEzsigntemplatepackageV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for POST /1/object/ezsignfolder/{pkiEzsignfolderID}/importEzsigntemplatepackage ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_ezsigndocument** | [**List[EzsigndocumentResponseCompound]**](EzsigndocumentResponseCompound.md) | | diff --git a/docs/EzsignfolderListElement.md b/docs/EzsignfolderListElement.md index e46fb2dbc..d71bdf404 100644 --- a/docs/EzsignfolderListElement.md +++ b/docs/EzsignfolderListElement.md @@ -3,6 +3,7 @@ An Ezsignfolder List Element ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsignfolder_id** | **int** | The unique ID of the Ezsignfolder | diff --git a/docs/EzsignfolderReorderV1Request.md b/docs/EzsignfolderReorderV1Request.md index 787949dd2..e13eed38c 100644 --- a/docs/EzsignfolderReorderV1Request.md +++ b/docs/EzsignfolderReorderV1Request.md @@ -3,6 +3,7 @@ Request for POST /1/object/ezsignfolder/{pkiEzsignfolderID}/reorder ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_pki_ezsigndocument_id** | **List[int]** | | diff --git a/docs/EzsignfolderReorderV1Response.md b/docs/EzsignfolderReorderV1Response.md index e12c82d94..1bfd802fb 100644 --- a/docs/EzsignfolderReorderV1Response.md +++ b/docs/EzsignfolderReorderV1Response.md @@ -3,6 +3,7 @@ Response for POST /1/object/ezsignfolder/{pkiEzsignfolderID}/reorder ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsignfolderRequest.md b/docs/EzsignfolderRequest.md index 7247432e0..d5bd3df5d 100644 --- a/docs/EzsignfolderRequest.md +++ b/docs/EzsignfolderRequest.md @@ -3,6 +3,7 @@ An Ezsignfolder Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsignfolder_id** | **int** | The unique ID of the Ezsignfolder | [optional] diff --git a/docs/EzsignfolderRequestCompound.md b/docs/EzsignfolderRequestCompound.md index 2320d9957..8c2d65d75 100644 --- a/docs/EzsignfolderRequestCompound.md +++ b/docs/EzsignfolderRequestCompound.md @@ -3,6 +3,7 @@ An Ezsignfolder Object and children to create a complete structure ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsignfolder_id** | **int** | The unique ID of the Ezsignfolder | [optional] diff --git a/docs/EzsignfolderResponse.md b/docs/EzsignfolderResponse.md index 303d0cf5f..14be4a57f 100644 --- a/docs/EzsignfolderResponse.md +++ b/docs/EzsignfolderResponse.md @@ -3,6 +3,7 @@ An Ezsignfolder Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsignfolder_id** | **int** | The unique ID of the Ezsignfolder | diff --git a/docs/EzsignfolderResponseCompound.md b/docs/EzsignfolderResponseCompound.md index 0a05dd6b1..f3a174ee7 100644 --- a/docs/EzsignfolderResponseCompound.md +++ b/docs/EzsignfolderResponseCompound.md @@ -3,6 +3,7 @@ An Ezsignfolder Object and children to create a complete structure ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsignfolder_id** | **int** | The unique ID of the Ezsignfolder | diff --git a/docs/EzsignfolderSendV1Request.md b/docs/EzsignfolderSendV1Request.md index ef2c2f934..b3f911094 100644 --- a/docs/EzsignfolderSendV1Request.md +++ b/docs/EzsignfolderSendV1Request.md @@ -3,6 +3,7 @@ Request for POST /1/object/ezsignfolder/{pkiEzsignfolderID}/send ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **t_extra_message** | **str** | A custom text message that will be added to the email sent. | diff --git a/docs/EzsignfolderSendV1Response.md b/docs/EzsignfolderSendV1Response.md index 1a9e58d2c..4b7488cea 100644 --- a/docs/EzsignfolderSendV1Response.md +++ b/docs/EzsignfolderSendV1Response.md @@ -3,6 +3,7 @@ Response for GET /1/object/attachment/{pkiAttachmentID}/download ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsignfolderSendV2Request.md b/docs/EzsignfolderSendV2Request.md index 10680ae33..cb2a7a385 100644 --- a/docs/EzsignfolderSendV2Request.md +++ b/docs/EzsignfolderSendV2Request.md @@ -3,6 +3,7 @@ Request for POST /2/object/ezsignfolder/{pkiEzsignfolderID}/send ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **t_ezsignfolder_message** | **str** | A custom text message that will be added to the email sent. | diff --git a/docs/EzsignfolderSendV2Response.md b/docs/EzsignfolderSendV2Response.md index 6e987571f..a0b7e62a9 100644 --- a/docs/EzsignfolderSendV2Response.md +++ b/docs/EzsignfolderSendV2Response.md @@ -3,6 +3,7 @@ Response for POST /2/object/ezsignfolder/{pkiEzsignfolderID}/send ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsignfolderSendV3Request.md b/docs/EzsignfolderSendV3Request.md index f072dc81c..2c9f023cb 100644 --- a/docs/EzsignfolderSendV3Request.md +++ b/docs/EzsignfolderSendV3Request.md @@ -3,6 +3,7 @@ Request for POST /3/object/ezsignfolder/{pkiEzsignfolderID}/send ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **t_ezsignfolder_message** | **str** | A custom text message that will be added to the email sent. | [optional] diff --git a/docs/EzsignfolderSendV3Response.md b/docs/EzsignfolderSendV3Response.md index e2706d282..2c81b953a 100644 --- a/docs/EzsignfolderSendV3Response.md +++ b/docs/EzsignfolderSendV3Response.md @@ -3,6 +3,7 @@ Response for POST /3/object/ezsignfolder/{pkiEzsignfolderID}/send ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsignfolderUnsendV1Response.md b/docs/EzsignfolderUnsendV1Response.md index 45412f6d4..d0836c85c 100644 --- a/docs/EzsignfolderUnsendV1Response.md +++ b/docs/EzsignfolderUnsendV1Response.md @@ -3,6 +3,7 @@ Response for POST /1/object/ezsignfolder/{pkiEzsignfolderID}/unsend ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsignfoldersignerassociationCreateObjectV1Request.md b/docs/EzsignfoldersignerassociationCreateObjectV1Request.md index 842505e26..085ad2fc2 100644 --- a/docs/EzsignfoldersignerassociationCreateObjectV1Request.md +++ b/docs/EzsignfoldersignerassociationCreateObjectV1Request.md @@ -3,6 +3,7 @@ Request for POST /1/object/ezsignfoldersignerassociation ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_ezsignfoldersignerassociation** | [**EzsignfoldersignerassociationRequest**](EzsignfoldersignerassociationRequest.md) | | [optional] diff --git a/docs/EzsignfoldersignerassociationCreateObjectV1Response.md b/docs/EzsignfoldersignerassociationCreateObjectV1Response.md index eb92998dd..d00cf6465 100644 --- a/docs/EzsignfoldersignerassociationCreateObjectV1Response.md +++ b/docs/EzsignfoldersignerassociationCreateObjectV1Response.md @@ -3,6 +3,7 @@ Response for POST /1/object/ezsignfoldersignerassociation ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsignfoldersignerassociationCreateObjectV1ResponseMPayload.md b/docs/EzsignfoldersignerassociationCreateObjectV1ResponseMPayload.md index 83ef170ce..0cc966daa 100644 --- a/docs/EzsignfoldersignerassociationCreateObjectV1ResponseMPayload.md +++ b/docs/EzsignfoldersignerassociationCreateObjectV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for POST /1/object/ezsignfoldersignerassociation ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_pki_ezsignfoldersignerassociation_id** | **List[int]** | An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request. | diff --git a/docs/EzsignfoldersignerassociationCreateObjectV2Request.md b/docs/EzsignfoldersignerassociationCreateObjectV2Request.md index f46327b15..b316b02bd 100644 --- a/docs/EzsignfoldersignerassociationCreateObjectV2Request.md +++ b/docs/EzsignfoldersignerassociationCreateObjectV2Request.md @@ -3,6 +3,7 @@ Request for POST /2/object/ezsignfoldersignerassociation ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_ezsignfoldersignerassociation** | [**List[EzsignfoldersignerassociationRequestCompound]**](EzsignfoldersignerassociationRequestCompound.md) | | diff --git a/docs/EzsignfoldersignerassociationCreateObjectV2Response.md b/docs/EzsignfoldersignerassociationCreateObjectV2Response.md index 57533af9e..be1610e3e 100644 --- a/docs/EzsignfoldersignerassociationCreateObjectV2Response.md +++ b/docs/EzsignfoldersignerassociationCreateObjectV2Response.md @@ -3,6 +3,7 @@ Response for POST /2/object/ezsignfoldersignerassociation ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsignfoldersignerassociationCreateObjectV2ResponseMPayload.md b/docs/EzsignfoldersignerassociationCreateObjectV2ResponseMPayload.md index 7d1c6adc1..8344b3878 100644 --- a/docs/EzsignfoldersignerassociationCreateObjectV2ResponseMPayload.md +++ b/docs/EzsignfoldersignerassociationCreateObjectV2ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for POST /2/object/ezsignfoldersignerassociation ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_pki_ezsignfoldersignerassociation_id** | **List[int]** | An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request. | diff --git a/docs/EzsignfoldersignerassociationDeleteObjectV1Response.md b/docs/EzsignfoldersignerassociationDeleteObjectV1Response.md index 136dba2d6..6bbc3e03a 100644 --- a/docs/EzsignfoldersignerassociationDeleteObjectV1Response.md +++ b/docs/EzsignfoldersignerassociationDeleteObjectV1Response.md @@ -3,6 +3,7 @@ Response for DELETE /1/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociationID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsignfoldersignerassociationEditObjectV1Request.md b/docs/EzsignfoldersignerassociationEditObjectV1Request.md index 16641e3d0..fba316a80 100644 --- a/docs/EzsignfoldersignerassociationEditObjectV1Request.md +++ b/docs/EzsignfoldersignerassociationEditObjectV1Request.md @@ -3,6 +3,7 @@ Request for PUT /1/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociationID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_ezsignfoldersignerassociation** | [**EzsignfoldersignerassociationRequestCompound**](EzsignfoldersignerassociationRequestCompound.md) | | diff --git a/docs/EzsignfoldersignerassociationEditObjectV1Response.md b/docs/EzsignfoldersignerassociationEditObjectV1Response.md index 6a7ace9ff..7f46880d8 100644 --- a/docs/EzsignfoldersignerassociationEditObjectV1Response.md +++ b/docs/EzsignfoldersignerassociationEditObjectV1Response.md @@ -3,6 +3,7 @@ Response for PUT /1/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociationID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsignfoldersignerassociationForceDisconnectV1Response.md b/docs/EzsignfoldersignerassociationForceDisconnectV1Response.md index ee5104931..1f1f0fcda 100644 --- a/docs/EzsignfoldersignerassociationForceDisconnectV1Response.md +++ b/docs/EzsignfoldersignerassociationForceDisconnectV1Response.md @@ -3,6 +3,7 @@ Response for POST /1/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociation}/forceDisconnect ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsignfoldersignerassociationGetInPersonLoginUrlV1Response.md b/docs/EzsignfoldersignerassociationGetInPersonLoginUrlV1Response.md index 849aa22d0..5b400fc65 100644 --- a/docs/EzsignfoldersignerassociationGetInPersonLoginUrlV1Response.md +++ b/docs/EzsignfoldersignerassociationGetInPersonLoginUrlV1Response.md @@ -3,6 +3,7 @@ Response for GET /1/object/ezsignfoldersignerassociation/getInPersonLoginUrl ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsignfoldersignerassociationGetInPersonLoginUrlV1ResponseMPayload.md b/docs/EzsignfoldersignerassociationGetInPersonLoginUrlV1ResponseMPayload.md index dd997b0a3..fc2c6b318 100644 --- a/docs/EzsignfoldersignerassociationGetInPersonLoginUrlV1ResponseMPayload.md +++ b/docs/EzsignfoldersignerassociationGetInPersonLoginUrlV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for GET /1/object/ezsignfoldersignerassociation/getInPersonLoginUrl ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **s_login_url** | **str** | The Url to login to the signing application. Url will expire after 30 minutes. | diff --git a/docs/EzsignfoldersignerassociationGetObjectV1Response.md b/docs/EzsignfoldersignerassociationGetObjectV1Response.md index 69b8f095f..c10abd6fd 100644 --- a/docs/EzsignfoldersignerassociationGetObjectV1Response.md +++ b/docs/EzsignfoldersignerassociationGetObjectV1Response.md @@ -3,6 +3,7 @@ Response for GET /1/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociationID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsignfoldersignerassociationGetObjectV1ResponseMPayload.md b/docs/EzsignfoldersignerassociationGetObjectV1ResponseMPayload.md index 5862e057c..391cfeb2a 100644 --- a/docs/EzsignfoldersignerassociationGetObjectV1ResponseMPayload.md +++ b/docs/EzsignfoldersignerassociationGetObjectV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for GET /1/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociationID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsignfoldersignerassociation_id** | **int** | The unique ID of the Ezsignfoldersignerassociation | diff --git a/docs/EzsignfoldersignerassociationGetObjectV2Response.md b/docs/EzsignfoldersignerassociationGetObjectV2Response.md index 2bb92a4a2..ad2ed3266 100644 --- a/docs/EzsignfoldersignerassociationGetObjectV2Response.md +++ b/docs/EzsignfoldersignerassociationGetObjectV2Response.md @@ -3,6 +3,7 @@ Response for GET /2/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociationID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsignfoldersignerassociationGetObjectV2ResponseMPayload.md b/docs/EzsignfoldersignerassociationGetObjectV2ResponseMPayload.md index 8ee3ac2aa..92c4e08b6 100644 --- a/docs/EzsignfoldersignerassociationGetObjectV2ResponseMPayload.md +++ b/docs/EzsignfoldersignerassociationGetObjectV2ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for GET /2/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociationID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_ezsignfoldersignerassociation** | [**EzsignfoldersignerassociationResponseCompound**](EzsignfoldersignerassociationResponseCompound.md) | | diff --git a/docs/EzsignfoldersignerassociationPatchObjectV1Request.md b/docs/EzsignfoldersignerassociationPatchObjectV1Request.md index 4a60a5e44..cec4e768e 100644 --- a/docs/EzsignfoldersignerassociationPatchObjectV1Request.md +++ b/docs/EzsignfoldersignerassociationPatchObjectV1Request.md @@ -3,6 +3,7 @@ Request for PATCH /1/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociationID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_ezsignfoldersignerassociation** | [**EzsignfoldersignerassociationRequestPatch**](EzsignfoldersignerassociationRequestPatch.md) | | diff --git a/docs/EzsignfoldersignerassociationPatchObjectV1Response.md b/docs/EzsignfoldersignerassociationPatchObjectV1Response.md index e2ae73eae..5ff34326f 100644 --- a/docs/EzsignfoldersignerassociationPatchObjectV1Response.md +++ b/docs/EzsignfoldersignerassociationPatchObjectV1Response.md @@ -3,6 +3,7 @@ Response for PATCH /1/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociationID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsignfoldersignerassociationRequest.md b/docs/EzsignfoldersignerassociationRequest.md index f2e27a28a..4bd24662e 100644 --- a/docs/EzsignfoldersignerassociationRequest.md +++ b/docs/EzsignfoldersignerassociationRequest.md @@ -3,6 +3,7 @@ An Ezsignfoldersignerassociation Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsignfoldersignerassociation_id** | **int** | The unique ID of the Ezsignfoldersignerassociation | [optional] diff --git a/docs/EzsignfoldersignerassociationRequestCompound.md b/docs/EzsignfoldersignerassociationRequestCompound.md index acbfe3e65..a169978d4 100644 --- a/docs/EzsignfoldersignerassociationRequestCompound.md +++ b/docs/EzsignfoldersignerassociationRequestCompound.md @@ -3,6 +3,7 @@ An Ezsignfoldersignerassociation Object and children to create a complete structure ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsignfoldersignerassociation_id** | **int** | The unique ID of the Ezsignfoldersignerassociation | [optional] diff --git a/docs/EzsignfoldersignerassociationRequestPatch.md b/docs/EzsignfoldersignerassociationRequestPatch.md index a05d90ed5..d10f051c2 100644 --- a/docs/EzsignfoldersignerassociationRequestPatch.md +++ b/docs/EzsignfoldersignerassociationRequestPatch.md @@ -3,6 +3,7 @@ An Ezsignfoldersignerassociation Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **t_ezsignfoldersignerassociation_message** | **str** | A custom text message that will be added to the email sent. | [optional] diff --git a/docs/EzsignfoldersignerassociationResponse.md b/docs/EzsignfoldersignerassociationResponse.md index c9280e82c..195d38e0d 100644 --- a/docs/EzsignfoldersignerassociationResponse.md +++ b/docs/EzsignfoldersignerassociationResponse.md @@ -3,6 +3,7 @@ An Ezsignfoldersignerassociation Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsignfoldersignerassociation_id** | **int** | The unique ID of the Ezsignfoldersignerassociation | diff --git a/docs/EzsignfoldersignerassociationResponseCompound.md b/docs/EzsignfoldersignerassociationResponseCompound.md index aa8e912da..32456d6cf 100644 --- a/docs/EzsignfoldersignerassociationResponseCompound.md +++ b/docs/EzsignfoldersignerassociationResponseCompound.md @@ -3,6 +3,7 @@ An Ezsignfoldersignerassociation Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsignfoldersignerassociation_id** | **int** | The unique ID of the Ezsignfoldersignerassociation | diff --git a/docs/EzsignfoldersignerassociationResponseCompoundUser.md b/docs/EzsignfoldersignerassociationResponseCompoundUser.md index a892ab530..643897bbb 100644 --- a/docs/EzsignfoldersignerassociationResponseCompoundUser.md +++ b/docs/EzsignfoldersignerassociationResponseCompoundUser.md @@ -3,6 +3,7 @@ A Ezsignfoldersignerassociation->User Object and children to create a complete structure ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_user_id** | **int** | The unique ID of the User | diff --git a/docs/EzsignfoldertypeAutocompleteElementResponse.md b/docs/EzsignfoldertypeAutocompleteElementResponse.md index 1ea19db61..7a5e6b008 100644 --- a/docs/EzsignfoldertypeAutocompleteElementResponse.md +++ b/docs/EzsignfoldertypeAutocompleteElementResponse.md @@ -3,6 +3,7 @@ A Ezsignfoldertype AutocompleteElement Response ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **e_ezsignfoldertype_privacylevel** | [**FieldEEzsignfoldertypePrivacylevel**](FieldEEzsignfoldertypePrivacylevel.md) | | diff --git a/docs/EzsignfoldertypeCreateObjectV1Request.md b/docs/EzsignfoldertypeCreateObjectV1Request.md index 823a0aa1e..e941cdc88 100644 --- a/docs/EzsignfoldertypeCreateObjectV1Request.md +++ b/docs/EzsignfoldertypeCreateObjectV1Request.md @@ -3,6 +3,7 @@ Request for POST /1/object/ezsignfoldertype ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_ezsignfoldertype** | [**List[EzsignfoldertypeRequestCompound]**](EzsignfoldertypeRequestCompound.md) | | diff --git a/docs/EzsignfoldertypeCreateObjectV1Response.md b/docs/EzsignfoldertypeCreateObjectV1Response.md index ec34c1fba..836c666fe 100644 --- a/docs/EzsignfoldertypeCreateObjectV1Response.md +++ b/docs/EzsignfoldertypeCreateObjectV1Response.md @@ -3,6 +3,7 @@ Response for POST /1/object/ezsignfoldertype ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsignfoldertypeCreateObjectV1ResponseMPayload.md b/docs/EzsignfoldertypeCreateObjectV1ResponseMPayload.md index 1241e94bb..504a59f74 100644 --- a/docs/EzsignfoldertypeCreateObjectV1ResponseMPayload.md +++ b/docs/EzsignfoldertypeCreateObjectV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for POST /1/object/ezsignfoldertype ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_pki_ezsignfoldertype_id** | **List[int]** | An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request. | diff --git a/docs/EzsignfoldertypeEditObjectV1Request.md b/docs/EzsignfoldertypeEditObjectV1Request.md index 880de69cd..69f9978b4 100644 --- a/docs/EzsignfoldertypeEditObjectV1Request.md +++ b/docs/EzsignfoldertypeEditObjectV1Request.md @@ -3,6 +3,7 @@ Request for PUT /1/object/ezsignfoldertype/{pkiEzsignfoldertypeID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_ezsignfoldertype** | [**EzsignfoldertypeRequestCompound**](EzsignfoldertypeRequestCompound.md) | | diff --git a/docs/EzsignfoldertypeEditObjectV1Response.md b/docs/EzsignfoldertypeEditObjectV1Response.md index 03ea2fa44..de769cede 100644 --- a/docs/EzsignfoldertypeEditObjectV1Response.md +++ b/docs/EzsignfoldertypeEditObjectV1Response.md @@ -3,6 +3,7 @@ Response for PUT /1/object/ezsignfoldertype/{pkiEzsignfoldertypeID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsignfoldertypeGetAutocompleteV2Response.md b/docs/EzsignfoldertypeGetAutocompleteV2Response.md index 944a222a3..775f86a9c 100644 --- a/docs/EzsignfoldertypeGetAutocompleteV2Response.md +++ b/docs/EzsignfoldertypeGetAutocompleteV2Response.md @@ -3,6 +3,7 @@ Response for GET /2/object/ezsignfoldertype/getAutocomplete ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsignfoldertypeGetAutocompleteV2ResponseMPayload.md b/docs/EzsignfoldertypeGetAutocompleteV2ResponseMPayload.md index 8734aaf32..c4d043111 100644 --- a/docs/EzsignfoldertypeGetAutocompleteV2ResponseMPayload.md +++ b/docs/EzsignfoldertypeGetAutocompleteV2ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for POST /2/object/ezsignfoldertype/getAutocomplete ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_ezsignfoldertype** | [**List[EzsignfoldertypeAutocompleteElementResponse]**](EzsignfoldertypeAutocompleteElementResponse.md) | An array of Ezsignfoldertype autocomplete element response. | diff --git a/docs/EzsignfoldertypeGetListV1Response.md b/docs/EzsignfoldertypeGetListV1Response.md index 411ee5b9b..3a411484e 100644 --- a/docs/EzsignfoldertypeGetListV1Response.md +++ b/docs/EzsignfoldertypeGetListV1Response.md @@ -3,6 +3,7 @@ Response for GET /1/object/ezsignfoldertype/getList ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayloadGetList**](CommonResponseObjDebugPayloadGetList.md) | | diff --git a/docs/EzsignfoldertypeGetListV1ResponseMPayload.md b/docs/EzsignfoldertypeGetListV1ResponseMPayload.md index 20b402050..e5cc95290 100644 --- a/docs/EzsignfoldertypeGetListV1ResponseMPayload.md +++ b/docs/EzsignfoldertypeGetListV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for GET /1/object/ezsignfoldertype/getList ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **i_row_returned** | **int** | The number of rows returned | diff --git a/docs/EzsignfoldertypeGetObjectV2Response.md b/docs/EzsignfoldertypeGetObjectV2Response.md index 5f7e8aac2..9e31c64a4 100644 --- a/docs/EzsignfoldertypeGetObjectV2Response.md +++ b/docs/EzsignfoldertypeGetObjectV2Response.md @@ -3,6 +3,7 @@ Response for GET /2/object/ezsignfoldertype/{pkiEzsignfoldertypeID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsignfoldertypeGetObjectV2ResponseMPayload.md b/docs/EzsignfoldertypeGetObjectV2ResponseMPayload.md index cbce9c72d..bc619059a 100644 --- a/docs/EzsignfoldertypeGetObjectV2ResponseMPayload.md +++ b/docs/EzsignfoldertypeGetObjectV2ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for GET /2/object/ezsignfoldertype/{pkiEzsignfoldertypeID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_ezsignfoldertype** | [**EzsignfoldertypeResponseCompound**](EzsignfoldertypeResponseCompound.md) | | diff --git a/docs/EzsignfoldertypeListElement.md b/docs/EzsignfoldertypeListElement.md index 26eb68a1f..dd26a98ef 100644 --- a/docs/EzsignfoldertypeListElement.md +++ b/docs/EzsignfoldertypeListElement.md @@ -3,6 +3,7 @@ An Ezsignfoldertype List Element ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsignfoldertype_id** | **int** | The unique ID of the Ezsignfoldertype. | diff --git a/docs/EzsignfoldertypeRequest.md b/docs/EzsignfoldertypeRequest.md index fa5373fa9..00735e20a 100644 --- a/docs/EzsignfoldertypeRequest.md +++ b/docs/EzsignfoldertypeRequest.md @@ -3,6 +3,7 @@ A Ezsignfoldertype Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsignfoldertype_id** | **int** | The unique ID of the Ezsignfoldertype. | [optional] @@ -22,18 +23,28 @@ Name | Type | Description | Notes **i_ezsignfoldertype_deadlinedays** | **int** | The number of days to get all Ezsignsignatures | **b_ezsignfoldertype_delegate** | **bool** | Wheter if delegation of signature is allowed to another user or not | [optional] **b_ezsignfoldertype_reassign** | **bool** | Wheter if Reassignment of signature is allowed to another signatory or not | [optional] -**b_ezsignfoldertype_sendattatchmentsigner** | **bool** | Whether we send the Ezsigndocument and the proof as attachment in the email | +**b_ezsignfoldertype_sendattatchmentsigner** | **bool** | THIS FIELD WILL BE DELETED. Whether we send the Ezsigndocument and the proof as attachment in the email | [optional] +**b_ezsignfoldertype_sendsignedtoezsignsigner** | **bool** | Whether we send an email to Ezsignsigner when document is completed | [optional] +**b_ezsignfoldertype_sendsignedtouser** | **bool** | Whether we send an email to User who signed when document is completed | [optional] +**b_ezsignfoldertype_sendattachmentezsignsigner** | **bool** | Whether we send the Ezsigndocument in the email to Ezsignsigner | [optional] +**b_ezsignfoldertype_sendproofezsignsigner** | **bool** | Whether we send the proof in the email to Ezsignsigner | [optional] +**b_ezsignfoldertype_sendattachmentuser** | **bool** | Whether we send the Ezsigndocument in the email to User | [optional] +**b_ezsignfoldertype_sendproofuser** | **bool** | Whether we send the proof in the email to User | [optional] +**b_ezsignfoldertype_sendproofemail** | **bool** | Whether we send the proof in the email to external recipient | [optional] +**b_ezsignfoldertype_allowdownloadattachmentezsignsigner** | **bool** | Whether we allow the Ezsigndocument to be downloaded by an Ezsignsigner | [optional] +**b_ezsignfoldertype_allowdownloadproofezsignsigner** | **bool** | Whether we allow the proof to be downloaded by an Ezsignsigner | [optional] +**b_ezsignfoldertype_sendproofreceivealldocument** | **bool** | Whether we send the proof to user and Ezsignsigner who receive all documents. | [optional] **b_ezsignfoldertype_sendsignedtodocumentowner** | **bool** | Whether we send the signed Ezsigndocument to the Ezsigndocument's owner | **b_ezsignfoldertype_sendsignedtofolderowner** | **bool** | Whether we send the signed Ezsigndocument to the Ezsignfolder's owner | **b_ezsignfoldertype_sendsignedtofullgroup** | **bool** | Whether we send the signed Ezsigndocument to the Usergroup that has acces to all Ezsignfolders | [optional] -**b_ezsignfoldertype_sendsignedtolimitedgroup** | **bool** | Whether we send the signed Ezsigndocument to the Usergroup that has acces to only their own Ezsignfolders | [optional] +**b_ezsignfoldertype_sendsignedtolimitedgroup** | **bool** | THIS FIELD WILL BE DELETED. Whether we send the signed Ezsigndocument to the Usergroup that has acces to only their own Ezsignfolders | [optional] **b_ezsignfoldertype_sendsignedtocolleague** | **bool** | Whether we send the signed Ezsigndocument to the colleagues | **b_ezsignfoldertype_sendsummarytodocumentowner** | **bool** | Whether we send the summary to the Ezsigndocument's owner | **b_ezsignfoldertype_sendsummarytofolderowner** | **bool** | Whether we send the summary to the Ezsignfolder's owner | **b_ezsignfoldertype_sendsummarytofullgroup** | **bool** | Whether we send the summary to the Usergroup that has acces to all Ezsignfolders | [optional] **b_ezsignfoldertype_sendsummarytolimitedgroup** | **bool** | Whether we send the summary to the Usergroup that has acces to only their own Ezsignfolders | [optional] **b_ezsignfoldertype_sendsummarytocolleague** | **bool** | Whether we send the summary to the colleagues | -**b_ezsignfoldertype_includeproofsigner** | **bool** | Whether we include the proof with the signed Ezsigndocument for Ezsignsigners | +**b_ezsignfoldertype_includeproofsigner** | **bool** | THIS FIELD WILL BE DELETED. Whether we include the proof with the signed Ezsigndocument for Ezsignsigners | [optional] **b_ezsignfoldertype_includeproofuser** | **bool** | Whether we include the proof with the signed Ezsigndocument for users | **b_ezsignfoldertype_isactive** | **bool** | Whether the Ezsignfoldertype is active or not | diff --git a/docs/EzsignfoldertypeRequestCompound.md b/docs/EzsignfoldertypeRequestCompound.md index 034451013..d637bdec2 100644 --- a/docs/EzsignfoldertypeRequestCompound.md +++ b/docs/EzsignfoldertypeRequestCompound.md @@ -3,6 +3,7 @@ A Ezsignfoldertype Object and children ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsignfoldertype_id** | **int** | The unique ID of the Ezsignfoldertype. | [optional] @@ -22,18 +23,28 @@ Name | Type | Description | Notes **i_ezsignfoldertype_deadlinedays** | **int** | The number of days to get all Ezsignsignatures | **b_ezsignfoldertype_delegate** | **bool** | Wheter if delegation of signature is allowed to another user or not | [optional] **b_ezsignfoldertype_reassign** | **bool** | Wheter if Reassignment of signature is allowed to another signatory or not | [optional] -**b_ezsignfoldertype_sendattatchmentsigner** | **bool** | Whether we send the Ezsigndocument and the proof as attachment in the email | +**b_ezsignfoldertype_sendattatchmentsigner** | **bool** | THIS FIELD WILL BE DELETED. Whether we send the Ezsigndocument and the proof as attachment in the email | [optional] +**b_ezsignfoldertype_sendsignedtoezsignsigner** | **bool** | Whether we send an email to Ezsignsigner when document is completed | [optional] +**b_ezsignfoldertype_sendsignedtouser** | **bool** | Whether we send an email to User who signed when document is completed | [optional] +**b_ezsignfoldertype_sendattachmentezsignsigner** | **bool** | Whether we send the Ezsigndocument in the email to Ezsignsigner | [optional] +**b_ezsignfoldertype_sendproofezsignsigner** | **bool** | Whether we send the proof in the email to Ezsignsigner | [optional] +**b_ezsignfoldertype_sendattachmentuser** | **bool** | Whether we send the Ezsigndocument in the email to User | [optional] +**b_ezsignfoldertype_sendproofuser** | **bool** | Whether we send the proof in the email to User | [optional] +**b_ezsignfoldertype_sendproofemail** | **bool** | Whether we send the proof in the email to external recipient | [optional] +**b_ezsignfoldertype_allowdownloadattachmentezsignsigner** | **bool** | Whether we allow the Ezsigndocument to be downloaded by an Ezsignsigner | [optional] +**b_ezsignfoldertype_allowdownloadproofezsignsigner** | **bool** | Whether we allow the proof to be downloaded by an Ezsignsigner | [optional] +**b_ezsignfoldertype_sendproofreceivealldocument** | **bool** | Whether we send the proof to user and Ezsignsigner who receive all documents. | [optional] **b_ezsignfoldertype_sendsignedtodocumentowner** | **bool** | Whether we send the signed Ezsigndocument to the Ezsigndocument's owner | **b_ezsignfoldertype_sendsignedtofolderowner** | **bool** | Whether we send the signed Ezsigndocument to the Ezsignfolder's owner | **b_ezsignfoldertype_sendsignedtofullgroup** | **bool** | Whether we send the signed Ezsigndocument to the Usergroup that has acces to all Ezsignfolders | [optional] -**b_ezsignfoldertype_sendsignedtolimitedgroup** | **bool** | Whether we send the signed Ezsigndocument to the Usergroup that has acces to only their own Ezsignfolders | [optional] +**b_ezsignfoldertype_sendsignedtolimitedgroup** | **bool** | THIS FIELD WILL BE DELETED. Whether we send the signed Ezsigndocument to the Usergroup that has acces to only their own Ezsignfolders | [optional] **b_ezsignfoldertype_sendsignedtocolleague** | **bool** | Whether we send the signed Ezsigndocument to the colleagues | **b_ezsignfoldertype_sendsummarytodocumentowner** | **bool** | Whether we send the summary to the Ezsigndocument's owner | **b_ezsignfoldertype_sendsummarytofolderowner** | **bool** | Whether we send the summary to the Ezsignfolder's owner | **b_ezsignfoldertype_sendsummarytofullgroup** | **bool** | Whether we send the summary to the Usergroup that has acces to all Ezsignfolders | [optional] **b_ezsignfoldertype_sendsummarytolimitedgroup** | **bool** | Whether we send the summary to the Usergroup that has acces to only their own Ezsignfolders | [optional] **b_ezsignfoldertype_sendsummarytocolleague** | **bool** | Whether we send the summary to the colleagues | -**b_ezsignfoldertype_includeproofsigner** | **bool** | Whether we include the proof with the signed Ezsigndocument for Ezsignsigners | +**b_ezsignfoldertype_includeproofsigner** | **bool** | THIS FIELD WILL BE DELETED. Whether we include the proof with the signed Ezsigndocument for Ezsignsigners | [optional] **b_ezsignfoldertype_includeproofuser** | **bool** | Whether we include the proof with the signed Ezsigndocument for users | **b_ezsignfoldertype_isactive** | **bool** | Whether the Ezsignfoldertype is active or not | **a_fki_user_id_signed** | **List[int]** | | [optional] diff --git a/docs/EzsignfoldertypeResponse.md b/docs/EzsignfoldertypeResponse.md index c820a176d..a00164e42 100644 --- a/docs/EzsignfoldertypeResponse.md +++ b/docs/EzsignfoldertypeResponse.md @@ -3,6 +3,7 @@ A Ezsignfoldertype Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsignfoldertype_id** | **int** | The unique ID of the Ezsignfoldertype. | @@ -27,18 +28,28 @@ Name | Type | Description | Notes **i_ezsignfoldertype_deadlinedays** | **int** | The number of days to get all Ezsignsignatures | **b_ezsignfoldertype_delegate** | **bool** | Wheter if delegation of signature is allowed to another user or not | [optional] **b_ezsignfoldertype_reassign** | **bool** | Wheter if Reassignment of signature is allowed to another signatory or not | [optional] -**b_ezsignfoldertype_sendattatchmentsigner** | **bool** | Whether we send the Ezsigndocument and the proof as attachment in the email | +**b_ezsignfoldertype_sendattatchmentsigner** | **bool** | THIS FIELD WILL BE DELETED. Whether we send the Ezsigndocument and the proof as attachment in the email | [optional] +**b_ezsignfoldertype_sendsignedtoezsignsigner** | **bool** | Whether we send an email to Ezsignsigner when document is completed | [optional] +**b_ezsignfoldertype_sendsignedtouser** | **bool** | Whether we send an email to User who signed when document is completed | [optional] +**b_ezsignfoldertype_sendattachmentezsignsigner** | **bool** | Whether we send the Ezsigndocument in the email to Ezsignsigner | [optional] +**b_ezsignfoldertype_sendproofezsignsigner** | **bool** | Whether we send the proof in the email to Ezsignsigner | [optional] +**b_ezsignfoldertype_sendattachmentuser** | **bool** | Whether we send the Ezsigndocument in the email to User | [optional] +**b_ezsignfoldertype_sendproofuser** | **bool** | Whether we send the proof in the email to User | [optional] +**b_ezsignfoldertype_sendproofemail** | **bool** | Whether we send the proof in the email to external recipient | [optional] +**b_ezsignfoldertype_allowdownloadattachmentezsignsigner** | **bool** | Whether we allow the Ezsigndocument to be downloaded by an Ezsignsigner | [optional] +**b_ezsignfoldertype_allowdownloadproofezsignsigner** | **bool** | Whether we allow the proof to be downloaded by an Ezsignsigner | [optional] +**b_ezsignfoldertype_sendproofreceivealldocument** | **bool** | Whether we send the proof to user and Ezsignsigner who receive all documents. | [optional] **b_ezsignfoldertype_sendsignedtodocumentowner** | **bool** | Whether we send the signed Ezsigndocument to the Ezsigndocument's owner | **b_ezsignfoldertype_sendsignedtofolderowner** | **bool** | Whether we send the signed Ezsigndocument to the Ezsignfolder's owner | **b_ezsignfoldertype_sendsignedtofullgroup** | **bool** | Whether we send the signed Ezsigndocument to the Usergroup that has acces to all Ezsignfolders | [optional] -**b_ezsignfoldertype_sendsignedtolimitedgroup** | **bool** | Whether we send the signed Ezsigndocument to the Usergroup that has acces to only their own Ezsignfolders | [optional] +**b_ezsignfoldertype_sendsignedtolimitedgroup** | **bool** | THIS FIELD WILL BE DELETED. Whether we send the signed Ezsigndocument to the Usergroup that has acces to only their own Ezsignfolders | [optional] **b_ezsignfoldertype_sendsignedtocolleague** | **bool** | Whether we send the signed Ezsigndocument to the colleagues | **b_ezsignfoldertype_sendsummarytodocumentowner** | **bool** | Whether we send the summary to the Ezsigndocument's owner | **b_ezsignfoldertype_sendsummarytofolderowner** | **bool** | Whether we send the summary to the Ezsignfolder's owner | **b_ezsignfoldertype_sendsummarytofullgroup** | **bool** | Whether we send the summary to the Usergroup that has acces to all Ezsignfolders | [optional] **b_ezsignfoldertype_sendsummarytolimitedgroup** | **bool** | Whether we send the summary to the Usergroup that has acces to only their own Ezsignfolders | [optional] **b_ezsignfoldertype_sendsummarytocolleague** | **bool** | Whether we send the summary to the colleagues | -**b_ezsignfoldertype_includeproofsigner** | **bool** | Whether we include the proof with the signed Ezsigndocument for Ezsignsigners | +**b_ezsignfoldertype_includeproofsigner** | **bool** | THIS FIELD WILL BE DELETED. Whether we include the proof with the signed Ezsigndocument for Ezsignsigners | [optional] **b_ezsignfoldertype_includeproofuser** | **bool** | Whether we include the proof with the signed Ezsigndocument for users | **b_ezsignfoldertype_isactive** | **bool** | Whether the Ezsignfoldertype is active or not | diff --git a/docs/EzsignfoldertypeResponseCompound.md b/docs/EzsignfoldertypeResponseCompound.md index e4ed39638..27f4b029b 100644 --- a/docs/EzsignfoldertypeResponseCompound.md +++ b/docs/EzsignfoldertypeResponseCompound.md @@ -3,6 +3,7 @@ A Ezsignfoldertype Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsignfoldertype_id** | **int** | The unique ID of the Ezsignfoldertype. | @@ -27,18 +28,28 @@ Name | Type | Description | Notes **i_ezsignfoldertype_deadlinedays** | **int** | The number of days to get all Ezsignsignatures | **b_ezsignfoldertype_delegate** | **bool** | Wheter if delegation of signature is allowed to another user or not | [optional] **b_ezsignfoldertype_reassign** | **bool** | Wheter if Reassignment of signature is allowed to another signatory or not | [optional] -**b_ezsignfoldertype_sendattatchmentsigner** | **bool** | Whether we send the Ezsigndocument and the proof as attachment in the email | +**b_ezsignfoldertype_sendattatchmentsigner** | **bool** | THIS FIELD WILL BE DELETED. Whether we send the Ezsigndocument and the proof as attachment in the email | [optional] +**b_ezsignfoldertype_sendsignedtoezsignsigner** | **bool** | Whether we send an email to Ezsignsigner when document is completed | [optional] +**b_ezsignfoldertype_sendsignedtouser** | **bool** | Whether we send an email to User who signed when document is completed | [optional] +**b_ezsignfoldertype_sendattachmentezsignsigner** | **bool** | Whether we send the Ezsigndocument in the email to Ezsignsigner | [optional] +**b_ezsignfoldertype_sendproofezsignsigner** | **bool** | Whether we send the proof in the email to Ezsignsigner | [optional] +**b_ezsignfoldertype_sendattachmentuser** | **bool** | Whether we send the Ezsigndocument in the email to User | [optional] +**b_ezsignfoldertype_sendproofuser** | **bool** | Whether we send the proof in the email to User | [optional] +**b_ezsignfoldertype_sendproofemail** | **bool** | Whether we send the proof in the email to external recipient | [optional] +**b_ezsignfoldertype_allowdownloadattachmentezsignsigner** | **bool** | Whether we allow the Ezsigndocument to be downloaded by an Ezsignsigner | [optional] +**b_ezsignfoldertype_allowdownloadproofezsignsigner** | **bool** | Whether we allow the proof to be downloaded by an Ezsignsigner | [optional] +**b_ezsignfoldertype_sendproofreceivealldocument** | **bool** | Whether we send the proof to user and Ezsignsigner who receive all documents. | [optional] **b_ezsignfoldertype_sendsignedtodocumentowner** | **bool** | Whether we send the signed Ezsigndocument to the Ezsigndocument's owner | **b_ezsignfoldertype_sendsignedtofolderowner** | **bool** | Whether we send the signed Ezsigndocument to the Ezsignfolder's owner | **b_ezsignfoldertype_sendsignedtofullgroup** | **bool** | Whether we send the signed Ezsigndocument to the Usergroup that has acces to all Ezsignfolders | [optional] -**b_ezsignfoldertype_sendsignedtolimitedgroup** | **bool** | Whether we send the signed Ezsigndocument to the Usergroup that has acces to only their own Ezsignfolders | [optional] +**b_ezsignfoldertype_sendsignedtolimitedgroup** | **bool** | THIS FIELD WILL BE DELETED. Whether we send the signed Ezsigndocument to the Usergroup that has acces to only their own Ezsignfolders | [optional] **b_ezsignfoldertype_sendsignedtocolleague** | **bool** | Whether we send the signed Ezsigndocument to the colleagues | **b_ezsignfoldertype_sendsummarytodocumentowner** | **bool** | Whether we send the summary to the Ezsigndocument's owner | **b_ezsignfoldertype_sendsummarytofolderowner** | **bool** | Whether we send the summary to the Ezsignfolder's owner | **b_ezsignfoldertype_sendsummarytofullgroup** | **bool** | Whether we send the summary to the Usergroup that has acces to all Ezsignfolders | [optional] **b_ezsignfoldertype_sendsummarytolimitedgroup** | **bool** | Whether we send the summary to the Usergroup that has acces to only their own Ezsignfolders | [optional] **b_ezsignfoldertype_sendsummarytocolleague** | **bool** | Whether we send the summary to the colleagues | -**b_ezsignfoldertype_includeproofsigner** | **bool** | Whether we include the proof with the signed Ezsigndocument for Ezsignsigners | +**b_ezsignfoldertype_includeproofsigner** | **bool** | THIS FIELD WILL BE DELETED. Whether we include the proof with the signed Ezsigndocument for Ezsignsigners | [optional] **b_ezsignfoldertype_includeproofuser** | **bool** | Whether we include the proof with the signed Ezsigndocument for users | **b_ezsignfoldertype_isactive** | **bool** | Whether the Ezsignfoldertype is active or not | **a_fki_user_id_signed** | **List[int]** | | [optional] diff --git a/docs/EzsignformfieldRequest.md b/docs/EzsignformfieldRequest.md index eba768041..d8e78b9fe 100644 --- a/docs/EzsignformfieldRequest.md +++ b/docs/EzsignformfieldRequest.md @@ -3,6 +3,7 @@ A Ezsignformfield Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsignformfield_id** | **int** | The unique ID of the Ezsignformfield | [optional] diff --git a/docs/EzsignformfieldRequestCompound.md b/docs/EzsignformfieldRequestCompound.md index 78eaa733b..84d75444d 100644 --- a/docs/EzsignformfieldRequestCompound.md +++ b/docs/EzsignformfieldRequestCompound.md @@ -3,6 +3,7 @@ An Ezsignformfield Object and children to create a complete structure ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsignformfield_id** | **int** | The unique ID of the Ezsignformfield | [optional] diff --git a/docs/EzsignformfieldResponse.md b/docs/EzsignformfieldResponse.md index 0f9eb035c..cacf50465 100644 --- a/docs/EzsignformfieldResponse.md +++ b/docs/EzsignformfieldResponse.md @@ -3,6 +3,7 @@ An Ezsignformfield Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsignformfield_id** | **int** | The unique ID of the Ezsignformfield | diff --git a/docs/EzsignformfieldResponseCompound.md b/docs/EzsignformfieldResponseCompound.md index 504454613..3eb987776 100644 --- a/docs/EzsignformfieldResponseCompound.md +++ b/docs/EzsignformfieldResponseCompound.md @@ -3,6 +3,7 @@ An Ezsignformfield Object and children to create a complete structure ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsignformfield_id** | **int** | The unique ID of the Ezsignformfield | diff --git a/docs/EzsignformfieldgroupCreateObjectV1Request.md b/docs/EzsignformfieldgroupCreateObjectV1Request.md index f39e0481b..021e6e853 100644 --- a/docs/EzsignformfieldgroupCreateObjectV1Request.md +++ b/docs/EzsignformfieldgroupCreateObjectV1Request.md @@ -3,6 +3,7 @@ Request for POST /1/object/ezsignformfieldgroup ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_ezsignformfieldgroup** | [**List[EzsignformfieldgroupRequestCompound]**](EzsignformfieldgroupRequestCompound.md) | | diff --git a/docs/EzsignformfieldgroupCreateObjectV1Response.md b/docs/EzsignformfieldgroupCreateObjectV1Response.md index 0c964e993..acfe47e64 100644 --- a/docs/EzsignformfieldgroupCreateObjectV1Response.md +++ b/docs/EzsignformfieldgroupCreateObjectV1Response.md @@ -3,6 +3,7 @@ Response for POST /1/object/ezsignformfieldgroup ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsignformfieldgroupCreateObjectV1ResponseMPayload.md b/docs/EzsignformfieldgroupCreateObjectV1ResponseMPayload.md index b787d473b..74638c5a0 100644 --- a/docs/EzsignformfieldgroupCreateObjectV1ResponseMPayload.md +++ b/docs/EzsignformfieldgroupCreateObjectV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for POST /1/object/ezsignformfieldgroup ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_pki_ezsignformfieldgroup_id** | **List[int]** | An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request. | diff --git a/docs/EzsignformfieldgroupDeleteObjectV1Response.md b/docs/EzsignformfieldgroupDeleteObjectV1Response.md index 41acd8588..ef21f6b9c 100644 --- a/docs/EzsignformfieldgroupDeleteObjectV1Response.md +++ b/docs/EzsignformfieldgroupDeleteObjectV1Response.md @@ -3,6 +3,7 @@ Response for DELETE /1/object/ezsignformfieldgroup/{pkiEzsignformfieldgroupID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsignformfieldgroupEditObjectV1Request.md b/docs/EzsignformfieldgroupEditObjectV1Request.md index f2d091a8a..834d1068c 100644 --- a/docs/EzsignformfieldgroupEditObjectV1Request.md +++ b/docs/EzsignformfieldgroupEditObjectV1Request.md @@ -3,6 +3,7 @@ Request for PUT /1/object/ezsignformfieldgroup/{pkiEzsignfoldersignerassociationID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_ezsignformfieldgroup** | [**EzsignformfieldgroupRequestCompound**](EzsignformfieldgroupRequestCompound.md) | | diff --git a/docs/EzsignformfieldgroupEditObjectV1Response.md b/docs/EzsignformfieldgroupEditObjectV1Response.md index 7f830a5a1..bf389a29c 100644 --- a/docs/EzsignformfieldgroupEditObjectV1Response.md +++ b/docs/EzsignformfieldgroupEditObjectV1Response.md @@ -3,6 +3,7 @@ Response for PUT /1/object/ezsignformfieldgroup/{pkiEzsignfoldersignerassociationID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsignformfieldgroupGetObjectV2Response.md b/docs/EzsignformfieldgroupGetObjectV2Response.md index aaac6ecf6..5f82b68f6 100644 --- a/docs/EzsignformfieldgroupGetObjectV2Response.md +++ b/docs/EzsignformfieldgroupGetObjectV2Response.md @@ -3,6 +3,7 @@ Response for GET /2/object/ezsignformfieldgroup/{pkiEzsignformfieldgroupID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsignformfieldgroupGetObjectV2ResponseMPayload.md b/docs/EzsignformfieldgroupGetObjectV2ResponseMPayload.md index c5454f38f..7430a20ab 100644 --- a/docs/EzsignformfieldgroupGetObjectV2ResponseMPayload.md +++ b/docs/EzsignformfieldgroupGetObjectV2ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for GET /2/object/ezsignformfieldgroup/{pkiEzsignformfieldgroupID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_ezsignformfieldgroup** | [**EzsignformfieldgroupResponseCompound**](EzsignformfieldgroupResponseCompound.md) | | diff --git a/docs/EzsignformfieldgroupRequest.md b/docs/EzsignformfieldgroupRequest.md index 3934e4ced..1fb68f3f4 100644 --- a/docs/EzsignformfieldgroupRequest.md +++ b/docs/EzsignformfieldgroupRequest.md @@ -3,6 +3,7 @@ An Ezsignformfieldgroup Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsignformfieldgroup_id** | **int** | The unique ID of the Ezsignformfieldgroup | [optional] diff --git a/docs/EzsignformfieldgroupRequestCompound.md b/docs/EzsignformfieldgroupRequestCompound.md index 136c3f6e4..f78fb6fa6 100644 --- a/docs/EzsignformfieldgroupRequestCompound.md +++ b/docs/EzsignformfieldgroupRequestCompound.md @@ -3,6 +3,7 @@ An Ezsignformfieldgroup Object and children to create a complete structure ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsignformfieldgroup_id** | **int** | The unique ID of the Ezsignformfieldgroup | [optional] diff --git a/docs/EzsignformfieldgroupResponse.md b/docs/EzsignformfieldgroupResponse.md index d03691412..5f44abc17 100644 --- a/docs/EzsignformfieldgroupResponse.md +++ b/docs/EzsignformfieldgroupResponse.md @@ -3,6 +3,7 @@ An Ezsignformfieldgroup Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsignformfieldgroup_id** | **int** | The unique ID of the Ezsignformfieldgroup | diff --git a/docs/EzsignformfieldgroupResponseCompound.md b/docs/EzsignformfieldgroupResponseCompound.md index 2530d7b9f..c0346f57b 100644 --- a/docs/EzsignformfieldgroupResponseCompound.md +++ b/docs/EzsignformfieldgroupResponseCompound.md @@ -3,6 +3,7 @@ An Ezsignformfieldgroup Object and children to create a complete structure ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsignformfieldgroup_id** | **int** | The unique ID of the Ezsignformfieldgroup | diff --git a/docs/EzsignformfieldgroupsignerRequest.md b/docs/EzsignformfieldgroupsignerRequest.md index 546b26b68..5fa047afd 100644 --- a/docs/EzsignformfieldgroupsignerRequest.md +++ b/docs/EzsignformfieldgroupsignerRequest.md @@ -3,6 +3,7 @@ A Ezsignformfieldgroupsigner Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsignformfieldgroupsigner_id** | **int** | The unique ID of the Ezsignformfieldgroupsigner | [optional] diff --git a/docs/EzsignformfieldgroupsignerRequestCompound.md b/docs/EzsignformfieldgroupsignerRequestCompound.md index 63780a62a..5e5883997 100644 --- a/docs/EzsignformfieldgroupsignerRequestCompound.md +++ b/docs/EzsignformfieldgroupsignerRequestCompound.md @@ -3,6 +3,7 @@ An Ezsignformfieldgroupsigner Object and children to create a complete structure ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsignformfieldgroupsigner_id** | **int** | The unique ID of the Ezsignformfieldgroupsigner | [optional] diff --git a/docs/EzsignformfieldgroupsignerResponse.md b/docs/EzsignformfieldgroupsignerResponse.md index 861392354..33a9e1f37 100644 --- a/docs/EzsignformfieldgroupsignerResponse.md +++ b/docs/EzsignformfieldgroupsignerResponse.md @@ -3,6 +3,7 @@ A Ezsignformfieldgroupsigner Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsignformfieldgroupsigner_id** | **int** | The unique ID of the Ezsignformfieldgroupsigner | diff --git a/docs/EzsignformfieldgroupsignerResponseCompound.md b/docs/EzsignformfieldgroupsignerResponseCompound.md index 5d75d5db7..cdf334cdd 100644 --- a/docs/EzsignformfieldgroupsignerResponseCompound.md +++ b/docs/EzsignformfieldgroupsignerResponseCompound.md @@ -3,6 +3,7 @@ An Ezsignformfieldgroupsigner Object and children to create a complete structure ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsignformfieldgroupsigner_id** | **int** | The unique ID of the Ezsignformfieldgroupsigner | diff --git a/docs/EzsignpageConsultV1Response.md b/docs/EzsignpageConsultV1Response.md index dcef645b3..6c382322a 100644 --- a/docs/EzsignpageConsultV1Response.md +++ b/docs/EzsignpageConsultV1Response.md @@ -3,6 +3,7 @@ Response for POST /1/object/ezsignpage/{pkiEzsignpageID}/consult ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsignpageResponse.md b/docs/EzsignpageResponse.md index 33e217e04..83b79c1e1 100644 --- a/docs/EzsignpageResponse.md +++ b/docs/EzsignpageResponse.md @@ -3,6 +3,7 @@ An Ezsignpage Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsignpage_id** | **int** | The unique ID of the Ezsignpage | diff --git a/docs/EzsignpageResponseCompound.md b/docs/EzsignpageResponseCompound.md index 80b3d54b4..5dd0571a6 100644 --- a/docs/EzsignpageResponseCompound.md +++ b/docs/EzsignpageResponseCompound.md @@ -3,6 +3,7 @@ An Ezsignpage Object and children to create a complete structure ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsignpage_id** | **int** | The unique ID of the Ezsignpage | diff --git a/docs/EzsignsignatureCreateObjectV1Request.md b/docs/EzsignsignatureCreateObjectV1Request.md index e2d7dd77c..6080d220d 100644 --- a/docs/EzsignsignatureCreateObjectV1Request.md +++ b/docs/EzsignsignatureCreateObjectV1Request.md @@ -3,6 +3,7 @@ Request for POST /1/object/ezsignsignature ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_ezsignsignature** | [**EzsignsignatureRequest**](EzsignsignatureRequest.md) | | [optional] diff --git a/docs/EzsignsignatureCreateObjectV1Response.md b/docs/EzsignsignatureCreateObjectV1Response.md index ec06836d2..f81553b68 100644 --- a/docs/EzsignsignatureCreateObjectV1Response.md +++ b/docs/EzsignsignatureCreateObjectV1Response.md @@ -3,6 +3,7 @@ Response for POST /1/object/ezsignsignature ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsignsignatureCreateObjectV1ResponseMPayload.md b/docs/EzsignsignatureCreateObjectV1ResponseMPayload.md index d0080c2d2..b601de13b 100644 --- a/docs/EzsignsignatureCreateObjectV1ResponseMPayload.md +++ b/docs/EzsignsignatureCreateObjectV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for POST /1/object/ezsignsignature ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_pki_ezsignsignature_id** | **List[int]** | An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request. | diff --git a/docs/EzsignsignatureCreateObjectV2Request.md b/docs/EzsignsignatureCreateObjectV2Request.md index 9ad130e73..af4844c78 100644 --- a/docs/EzsignsignatureCreateObjectV2Request.md +++ b/docs/EzsignsignatureCreateObjectV2Request.md @@ -3,6 +3,7 @@ Request for POST /2/object/ezsignsignature ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_ezsignsignature** | [**List[EzsignsignatureRequestCompound]**](EzsignsignatureRequestCompound.md) | | diff --git a/docs/EzsignsignatureCreateObjectV2Response.md b/docs/EzsignsignatureCreateObjectV2Response.md index f46d1d91d..3305e80a5 100644 --- a/docs/EzsignsignatureCreateObjectV2Response.md +++ b/docs/EzsignsignatureCreateObjectV2Response.md @@ -3,6 +3,7 @@ Response for POST /2/object/ezsignsignature ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsignsignatureCreateObjectV2ResponseMPayload.md b/docs/EzsignsignatureCreateObjectV2ResponseMPayload.md index b9471db42..7b920d10a 100644 --- a/docs/EzsignsignatureCreateObjectV2ResponseMPayload.md +++ b/docs/EzsignsignatureCreateObjectV2ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for POST /2/object/ezsignsignature ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_pki_ezsignsignature_id** | **List[int]** | An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request. | diff --git a/docs/EzsignsignatureDeleteObjectV1Response.md b/docs/EzsignsignatureDeleteObjectV1Response.md index 5be8c7d24..f0625c508 100644 --- a/docs/EzsignsignatureDeleteObjectV1Response.md +++ b/docs/EzsignsignatureDeleteObjectV1Response.md @@ -3,6 +3,7 @@ Response for DELETE /1/object/ezsignsignature/{pkiEzsignsignatureID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsignsignatureEditObjectV1Request.md b/docs/EzsignsignatureEditObjectV1Request.md index 9a5bfd69c..a78ae409e 100644 --- a/docs/EzsignsignatureEditObjectV1Request.md +++ b/docs/EzsignsignatureEditObjectV1Request.md @@ -3,6 +3,7 @@ Request for PUT /1/object/ezsignsignature/{pkiEzsignsignatureID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_ezsignsignature** | [**EzsignsignatureRequestCompound**](EzsignsignatureRequestCompound.md) | | diff --git a/docs/EzsignsignatureEditObjectV1Response.md b/docs/EzsignsignatureEditObjectV1Response.md index 2ac1fd879..c9a9c4b63 100644 --- a/docs/EzsignsignatureEditObjectV1Response.md +++ b/docs/EzsignsignatureEditObjectV1Response.md @@ -3,6 +3,7 @@ Response for PUT /1/object/ezsignsignature/{pkiEzsignsignatureID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsignsignatureGetEzsignsignatureattachmentV1Response.md b/docs/EzsignsignatureGetEzsignsignatureattachmentV1Response.md index 9bb3a0bca..a664449fa 100644 --- a/docs/EzsignsignatureGetEzsignsignatureattachmentV1Response.md +++ b/docs/EzsignsignatureGetEzsignsignatureattachmentV1Response.md @@ -3,6 +3,7 @@ Response for GET /1/object/ezsignsignature/{pkiEzsignsignatureID}/getEzsignsignatureattachment ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsignsignatureGetEzsignsignatureattachmentV1ResponseMPayload.md b/docs/EzsignsignatureGetEzsignsignatureattachmentV1ResponseMPayload.md index cf57f8a0d..5b6d7353c 100644 --- a/docs/EzsignsignatureGetEzsignsignatureattachmentV1ResponseMPayload.md +++ b/docs/EzsignsignatureGetEzsignsignatureattachmentV1ResponseMPayload.md @@ -3,6 +3,7 @@ Response for GET /1/object/ezsignsignature/{pkiEzsignsignatureID}/getEzsignsignatureattachment ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_ezsignsignatureattachment** | [**List[EzsignsignatureattachmentResponse]**](EzsignsignatureattachmentResponse.md) | | diff --git a/docs/EzsignsignatureGetEzsignsignaturesAutomaticV1Response.md b/docs/EzsignsignatureGetEzsignsignaturesAutomaticV1Response.md index 8dcec895f..1ec5acac0 100644 --- a/docs/EzsignsignatureGetEzsignsignaturesAutomaticV1Response.md +++ b/docs/EzsignsignatureGetEzsignsignaturesAutomaticV1Response.md @@ -3,6 +3,7 @@ Response for GET /1/object/ezsignsignature/getEzsignsignaturesAutomatic ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsignsignatureGetEzsignsignaturesAutomaticV1ResponseMPayload.md b/docs/EzsignsignatureGetEzsignsignaturesAutomaticV1ResponseMPayload.md index 959d0d7ad..c96a550f8 100644 --- a/docs/EzsignsignatureGetEzsignsignaturesAutomaticV1ResponseMPayload.md +++ b/docs/EzsignsignatureGetEzsignsignaturesAutomaticV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for GET /1/object/ezsigsignature/getEzsignsignaturesAutomatic ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_e_ezsignsignature_type** | [**List[FieldEEzsignsignatureType]**](FieldEEzsignsignatureType.md) | All eEzsignsignatureType contained in the response | diff --git a/docs/EzsignsignatureGetObjectV2Response.md b/docs/EzsignsignatureGetObjectV2Response.md index f294b8968..2381ea30c 100644 --- a/docs/EzsignsignatureGetObjectV2Response.md +++ b/docs/EzsignsignatureGetObjectV2Response.md @@ -3,6 +3,7 @@ Response for GET /2/object/ezsignsignature/{pkiEzsignsignatureID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsignsignatureGetObjectV2ResponseMPayload.md b/docs/EzsignsignatureGetObjectV2ResponseMPayload.md index 2e9465f0d..fdc7a87af 100644 --- a/docs/EzsignsignatureGetObjectV2ResponseMPayload.md +++ b/docs/EzsignsignatureGetObjectV2ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for GET /2/object/ezsignsignature/{pkiEzsignsignatureID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_ezsignsignature** | [**EzsignsignatureResponseCompound**](EzsignsignatureResponseCompound.md) | | diff --git a/docs/EzsignsignatureRequest.md b/docs/EzsignsignatureRequest.md index 59a7631f3..18c67ae02 100644 --- a/docs/EzsignsignatureRequest.md +++ b/docs/EzsignsignatureRequest.md @@ -3,6 +3,7 @@ An Ezsignsignature Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsignsignature_id** | **int** | The unique ID of the Ezsignsignature | [optional] diff --git a/docs/EzsignsignatureRequestCompound.md b/docs/EzsignsignatureRequestCompound.md index a520fe154..269840c5f 100644 --- a/docs/EzsignsignatureRequestCompound.md +++ b/docs/EzsignsignatureRequestCompound.md @@ -3,6 +3,7 @@ An Ezsignsignature Object and children to create a complete structure ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsignsignature_id** | **int** | The unique ID of the Ezsignsignature | [optional] diff --git a/docs/EzsignsignatureResponse.md b/docs/EzsignsignatureResponse.md index 20ae2032d..c49ddcf41 100644 --- a/docs/EzsignsignatureResponse.md +++ b/docs/EzsignsignatureResponse.md @@ -3,11 +3,14 @@ An Ezsignsignature Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsignsignature_id** | **int** | The unique ID of the Ezsignsignature | **fki_ezsigndocument_id** | **int** | The unique ID of the Ezsigndocument | **fki_ezsignfoldersignerassociation_id** | **int** | The unique ID of the Ezsignfoldersignerassociation | +**fki_ezsignsigningreason_id** | **int** | The unique ID of the Ezsignsigningreason | [optional] +**s_ezsignsigningreason_description_x** | **str** | The description of the Ezsignsigningreason in the language of the requester | [optional] **i_ezsignpage_pagenumber** | **int** | The page number in the Ezsigndocument | **i_ezsignsignature_x** | **int** | The X coordinate (Horizontal) where to put the Ezsignsignature on the page. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsignsignature 2 inches from the left border of the page, you would use \"200\" for the X coordinate. | **i_ezsignsignature_y** | **int** | The Y coordinate (Vertical) where to put the Ezsignsignature on the page. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsignsignature 3 inches from the top border of the page, you would use \"300\" for the Y coordinate. | diff --git a/docs/EzsignsignatureResponseCompound.md b/docs/EzsignsignatureResponseCompound.md index c74da916e..4a0823f61 100644 --- a/docs/EzsignsignatureResponseCompound.md +++ b/docs/EzsignsignatureResponseCompound.md @@ -3,11 +3,14 @@ An Ezsignsignature Object and children to create a complete structure ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsignsignature_id** | **int** | The unique ID of the Ezsignsignature | **fki_ezsigndocument_id** | **int** | The unique ID of the Ezsigndocument | **fki_ezsignfoldersignerassociation_id** | **int** | The unique ID of the Ezsignfoldersignerassociation | +**fki_ezsignsigningreason_id** | **int** | The unique ID of the Ezsignsigningreason | [optional] +**s_ezsignsigningreason_description_x** | **str** | The description of the Ezsignsigningreason in the language of the requester | [optional] **i_ezsignpage_pagenumber** | **int** | The page number in the Ezsigndocument | **i_ezsignsignature_x** | **int** | The X coordinate (Horizontal) where to put the Ezsignsignature on the page. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsignsignature 2 inches from the left border of the page, you would use \"200\" for the X coordinate. | **i_ezsignsignature_y** | **int** | The Y coordinate (Vertical) where to put the Ezsignsignature on the page. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsignsignature 3 inches from the top border of the page, you would use \"300\" for the Y coordinate. | diff --git a/docs/EzsignsignatureSignV1Request.md b/docs/EzsignsignatureSignV1Request.md index 007d3edf1..8dac8dd47 100644 --- a/docs/EzsignsignatureSignV1Request.md +++ b/docs/EzsignsignatureSignV1Request.md @@ -3,8 +3,10 @@ Request for POST /1/object/ezsignsignature/{pkiEzsignsignatureID}/sign ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**fki_ezsignsigningreason_id** | **int** | The unique ID of the Ezsignsigningreason | [optional] **s_value** | **str** | The value required for the Ezsignsignature. This can only be set if eEzsignsignatureType is **City**, **FieldText** or **FieldTextarea** | [optional] **e_attachments_confirmation_decision** | **str** | Whether the attachment are accepted or refused. This can only be set if eEzsignsignatureType is **AttachmentsConfirmation** | [optional] **s_attachments_refusal_reason** | **str** | The reason of refused. This can only be set if eEzsignsignatureType is **AttachmentsConfirmation** | [optional] diff --git a/docs/EzsignsignatureSignV1Response.md b/docs/EzsignsignatureSignV1Response.md index 8d19eb695..30431a722 100644 --- a/docs/EzsignsignatureSignV1Response.md +++ b/docs/EzsignsignatureSignV1Response.md @@ -3,6 +3,7 @@ Response for POST /1/object/ezsignsignature/{pkiEzsignsignatureID}/sign ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsignsignatureattachmentResponse.md b/docs/EzsignsignatureattachmentResponse.md index fb90805c0..de5d8fea5 100644 --- a/docs/EzsignsignatureattachmentResponse.md +++ b/docs/EzsignsignatureattachmentResponse.md @@ -3,6 +3,7 @@ An Ezsignsignatureattachment Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsignsignatureattachment_id** | **int** | The unique ID of the Ezsignsignatureattachment | diff --git a/docs/EzsignsignaturecustomdateRequest.md b/docs/EzsignsignaturecustomdateRequest.md index a75159265..26277da2c 100644 --- a/docs/EzsignsignaturecustomdateRequest.md +++ b/docs/EzsignsignaturecustomdateRequest.md @@ -3,6 +3,7 @@ An Ezsignsignaturecustomdate Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsignsignaturecustomdate_id** | **int** | The unique ID of the Ezsignsignaturecustomdate | [optional] diff --git a/docs/EzsignsignaturecustomdateRequestCompound.md b/docs/EzsignsignaturecustomdateRequestCompound.md index 71a03b260..06596c7e4 100644 --- a/docs/EzsignsignaturecustomdateRequestCompound.md +++ b/docs/EzsignsignaturecustomdateRequestCompound.md @@ -3,6 +3,7 @@ An Ezsignsignaturecustomdate Object and children to create a complete structure ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsignsignaturecustomdate_id** | **int** | The unique ID of the Ezsignsignaturecustomdate | [optional] diff --git a/docs/EzsignsignaturecustomdateResponse.md b/docs/EzsignsignaturecustomdateResponse.md index 9f11a9db3..fa5dd3460 100644 --- a/docs/EzsignsignaturecustomdateResponse.md +++ b/docs/EzsignsignaturecustomdateResponse.md @@ -3,6 +3,7 @@ An Ezsignsignaturecustomdate Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsignsignaturecustomdate_id** | **int** | The unique ID of the Ezsignsignaturecustomdate | diff --git a/docs/EzsignsignaturecustomdateResponseCompound.md b/docs/EzsignsignaturecustomdateResponseCompound.md index 0bafd9d2f..bfabe1ca8 100644 --- a/docs/EzsignsignaturecustomdateResponseCompound.md +++ b/docs/EzsignsignaturecustomdateResponseCompound.md @@ -3,6 +3,7 @@ An Ezsignsignaturecustomdate Object and children to create a complete structure ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsignsignaturecustomdate_id** | **int** | The unique ID of the Ezsignsignaturecustomdate | diff --git a/docs/EzsignsignerRequest.md b/docs/EzsignsignerRequest.md index 05571cd1f..623b03066 100644 --- a/docs/EzsignsignerRequest.md +++ b/docs/EzsignsignerRequest.md @@ -3,6 +3,7 @@ An Ezsignsigner Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **fki_userlogintype_id** | **int** | The unique ID of the Userlogintype Valid values: |Value|Description|Detail| |-|-|-| |1|**Email Only**|The Ezsignsigner will receive a secure link by email| |2|**Email and phone or SMS**|The Ezsignsigner will receive a secure link by email and will need to authenticate using SMS or Phone call. **Additional fee applies**| |3|**Email and secret question**|The Ezsignsigner will receive a secure link by email and will need to authenticate using a predefined question and answer| |4|**In person only**|The Ezsignsigner will only be able to sign \"In-Person\" and there won't be any authentication. No email will be sent for invitation to sign. Make sure you evaluate the risk of signature denial and at minimum, we recommend you use a handwritten signature type| |5|**In person with phone or SMS**|The Ezsignsigner will only be able to sign \"In-Person\" and will need to authenticate using SMS or Phone call. No email will be sent for invitation to sign. **Additional fee applies**| | [optional] diff --git a/docs/EzsignsignerRequestCompound.md b/docs/EzsignsignerRequestCompound.md index 3786effef..a6ba3515b 100644 --- a/docs/EzsignsignerRequestCompound.md +++ b/docs/EzsignsignerRequestCompound.md @@ -3,6 +3,7 @@ An Ezsignsigner Object and children to create a complete structure ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **fki_userlogintype_id** | **int** | The unique ID of the Userlogintype Valid values: |Value|Description|Detail| |-|-|-| |1|**Email Only**|The Ezsignsigner will receive a secure link by email| |2|**Email and phone or SMS**|The Ezsignsigner will receive a secure link by email and will need to authenticate using SMS or Phone call. **Additional fee applies**| |3|**Email and secret question**|The Ezsignsigner will receive a secure link by email and will need to authenticate using a predefined question and answer| |4|**In person only**|The Ezsignsigner will only be able to sign \"In-Person\" and there won't be any authentication. No email will be sent for invitation to sign. Make sure you evaluate the risk of signature denial and at minimum, we recommend you use a handwritten signature type| |5|**In person with phone or SMS**|The Ezsignsigner will only be able to sign \"In-Person\" and will need to authenticate using SMS or Phone call. No email will be sent for invitation to sign. **Additional fee applies**| | [optional] diff --git a/docs/EzsignsignerRequestCompoundContact.md b/docs/EzsignsignerRequestCompoundContact.md index f4c0fd3fc..9c2a1cdb8 100644 --- a/docs/EzsignsignerRequestCompoundContact.md +++ b/docs/EzsignsignerRequestCompoundContact.md @@ -3,6 +3,7 @@ A Ezsignsigner->Contact Object and children to create a complete structure ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **s_contact_firstname** | **str** | The First name of the contact | diff --git a/docs/EzsignsignerResponse.md b/docs/EzsignsignerResponse.md index 97158967b..c18a6ee61 100644 --- a/docs/EzsignsignerResponse.md +++ b/docs/EzsignsignerResponse.md @@ -3,6 +3,7 @@ An Ezsignsigner Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsignsigner_id** | **int** | The unique ID of the Ezsignsigner | diff --git a/docs/EzsignsignerResponseCompound.md b/docs/EzsignsignerResponseCompound.md index 434574547..3177d1828 100644 --- a/docs/EzsignsignerResponseCompound.md +++ b/docs/EzsignsignerResponseCompound.md @@ -3,6 +3,7 @@ An Ezsignsigner Object and children to create a complete structure ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsignsigner_id** | **int** | The unique ID of the Ezsignsigner | diff --git a/docs/EzsignsignerResponseCompoundContact.md b/docs/EzsignsignerResponseCompoundContact.md index 359a2dc8e..1df8ec700 100644 --- a/docs/EzsignsignerResponseCompoundContact.md +++ b/docs/EzsignsignerResponseCompoundContact.md @@ -3,6 +3,7 @@ A Ezsignsigner->Contact Object and children to create a complete structure ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_contact_id** | **int** | The unique ID of the Contact | diff --git a/docs/EzsignsignergroupCreateObjectV1Request.md b/docs/EzsignsignergroupCreateObjectV1Request.md index ffa005e2b..81a1db68a 100644 --- a/docs/EzsignsignergroupCreateObjectV1Request.md +++ b/docs/EzsignsignergroupCreateObjectV1Request.md @@ -3,6 +3,7 @@ Request for POST /1/object/ezsignsignergroup ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_ezsignsignergroup** | [**List[EzsignsignergroupRequestCompound]**](EzsignsignergroupRequestCompound.md) | | diff --git a/docs/EzsignsignergroupCreateObjectV1Response.md b/docs/EzsignsignergroupCreateObjectV1Response.md index 92bf44d44..031345df5 100644 --- a/docs/EzsignsignergroupCreateObjectV1Response.md +++ b/docs/EzsignsignergroupCreateObjectV1Response.md @@ -3,6 +3,7 @@ Response for POST /1/object/ezsignsignergroup ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsignsignergroupCreateObjectV1ResponseMPayload.md b/docs/EzsignsignergroupCreateObjectV1ResponseMPayload.md index a039f98fe..9d118b839 100644 --- a/docs/EzsignsignergroupCreateObjectV1ResponseMPayload.md +++ b/docs/EzsignsignergroupCreateObjectV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for POST /1/object/ezsignsignergroup ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_pki_ezsignsignergroup_id** | **List[int]** | An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request. | diff --git a/docs/EzsignsignergroupDeleteObjectV1Response.md b/docs/EzsignsignergroupDeleteObjectV1Response.md index f08d02c36..ccfb779a8 100644 --- a/docs/EzsignsignergroupDeleteObjectV1Response.md +++ b/docs/EzsignsignergroupDeleteObjectV1Response.md @@ -3,6 +3,7 @@ Response for DELETE /1/object/ezsignsignergroup/{pkiEzsignsignergroupID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsignsignergroupEditEzsignsignergroupmembershipsV1Request.md b/docs/EzsignsignergroupEditEzsignsignergroupmembershipsV1Request.md index 34ad27220..e5fe31c33 100644 --- a/docs/EzsignsignergroupEditEzsignsignergroupmembershipsV1Request.md +++ b/docs/EzsignsignergroupEditEzsignsignergroupmembershipsV1Request.md @@ -3,6 +3,7 @@ Request for PUT /1/object/ezsignsignergroup/{pkiEzsignsignergroupID}/editEzsignsignergroupmemberships ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_ezsignsignergroupmembership** | [**List[EzsignsignergroupmembershipRequestCompound]**](EzsignsignergroupmembershipRequestCompound.md) | | diff --git a/docs/EzsignsignergroupEditEzsignsignergroupmembershipsV1Response.md b/docs/EzsignsignergroupEditEzsignsignergroupmembershipsV1Response.md index ca3d388ee..5c923893e 100644 --- a/docs/EzsignsignergroupEditEzsignsignergroupmembershipsV1Response.md +++ b/docs/EzsignsignergroupEditEzsignsignergroupmembershipsV1Response.md @@ -3,6 +3,7 @@ Response for PUT /1/object/ezsignsignergroup/{pkiEzsignsignergroupID}/editEzsignsignergroupmemberships ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsignsignergroupEditEzsignsignergroupmembershipsV1ResponseMPayload.md b/docs/EzsignsignergroupEditEzsignsignergroupmembershipsV1ResponseMPayload.md index a3f7ff9dd..5149e939d 100644 --- a/docs/EzsignsignergroupEditEzsignsignergroupmembershipsV1ResponseMPayload.md +++ b/docs/EzsignsignergroupEditEzsignsignergroupmembershipsV1ResponseMPayload.md @@ -3,6 +3,7 @@ Response for PUT /1/object/ezsignsignergroup/{pkiEzsignsignergroupID}/editEzsignsignergroupmemberships ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_pki_ezsignsignergroupmembership_id** | **List[int]** | | diff --git a/docs/EzsignsignergroupEditObjectV1Request.md b/docs/EzsignsignergroupEditObjectV1Request.md index 3522212c4..1c000edc8 100644 --- a/docs/EzsignsignergroupEditObjectV1Request.md +++ b/docs/EzsignsignergroupEditObjectV1Request.md @@ -3,6 +3,7 @@ Request for PUT /1/object/ezsignsignergroup/{pkiEzsignsignergroupID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_ezsignsignergroup** | [**EzsignsignergroupRequestCompound**](EzsignsignergroupRequestCompound.md) | | diff --git a/docs/EzsignsignergroupEditObjectV1Response.md b/docs/EzsignsignergroupEditObjectV1Response.md index 16eb9ad26..7efdcbebd 100644 --- a/docs/EzsignsignergroupEditObjectV1Response.md +++ b/docs/EzsignsignergroupEditObjectV1Response.md @@ -3,6 +3,7 @@ Response for PUT /1/object/ezsignsignergroup/{pkiEzsignsignergroupID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsignsignergroupGetEzsignsignergroupmembershipsV1Response.md b/docs/EzsignsignergroupGetEzsignsignergroupmembershipsV1Response.md index e1a0d4d06..2ed90c7aa 100644 --- a/docs/EzsignsignergroupGetEzsignsignergroupmembershipsV1Response.md +++ b/docs/EzsignsignergroupGetEzsignsignergroupmembershipsV1Response.md @@ -3,6 +3,7 @@ Response for GET /1/object/ezsignsignergroup/{pkiEzsignsignergroupID}/getEzsignsignergroupmemberships ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsignsignergroupGetEzsignsignergroupmembershipsV1ResponseMPayload.md b/docs/EzsignsignergroupGetEzsignsignergroupmembershipsV1ResponseMPayload.md index 06bcc0bc4..fb58ad960 100644 --- a/docs/EzsignsignergroupGetEzsignsignergroupmembershipsV1ResponseMPayload.md +++ b/docs/EzsignsignergroupGetEzsignsignergroupmembershipsV1ResponseMPayload.md @@ -3,6 +3,7 @@ Response for GET /1/object/ezsignsignergroup/{pkiEzsignsignergroupID}/getEzsignsignergroupmemberships ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_ezsignsignergroupmembership** | [**List[EzsignsignergroupmembershipResponseCompound]**](EzsignsignergroupmembershipResponseCompound.md) | | diff --git a/docs/EzsignsignergroupGetObjectV2Response.md b/docs/EzsignsignergroupGetObjectV2Response.md index 10ba18fa4..a897ddd26 100644 --- a/docs/EzsignsignergroupGetObjectV2Response.md +++ b/docs/EzsignsignergroupGetObjectV2Response.md @@ -3,6 +3,7 @@ Response for GET /2/object/ezsignsignergroup/{pkiEzsignsignergroupID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsignsignergroupGetObjectV2ResponseMPayload.md b/docs/EzsignsignergroupGetObjectV2ResponseMPayload.md index 6978d230e..a2249d6d3 100644 --- a/docs/EzsignsignergroupGetObjectV2ResponseMPayload.md +++ b/docs/EzsignsignergroupGetObjectV2ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for GET /2/object/ezsignsignergroup/{pkiEzsignsignergroupID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_ezsignsignergroup** | [**EzsignsignergroupResponseCompound**](EzsignsignergroupResponseCompound.md) | | diff --git a/docs/EzsignsignergroupRequest.md b/docs/EzsignsignergroupRequest.md index 8c57d084d..f372cc260 100644 --- a/docs/EzsignsignergroupRequest.md +++ b/docs/EzsignsignergroupRequest.md @@ -3,6 +3,7 @@ A Ezsignsignergroup Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsignsignergroup_id** | **int** | The unique ID of the Ezsignsignergroup | [optional] diff --git a/docs/EzsignsignergroupRequestCompound.md b/docs/EzsignsignergroupRequestCompound.md index 2fa87ead5..459db786d 100644 --- a/docs/EzsignsignergroupRequestCompound.md +++ b/docs/EzsignsignergroupRequestCompound.md @@ -3,6 +3,7 @@ A Ezsignsignergroup Object and children ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsignsignergroup_id** | **int** | The unique ID of the Ezsignsignergroup | [optional] diff --git a/docs/EzsignsignergroupResponse.md b/docs/EzsignsignergroupResponse.md index 841bdaa4a..b34966380 100644 --- a/docs/EzsignsignergroupResponse.md +++ b/docs/EzsignsignergroupResponse.md @@ -3,6 +3,7 @@ An Ezsignsignergroup Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsignsignergroup_id** | **int** | The unique ID of the Ezsignsignergroup | diff --git a/docs/EzsignsignergroupResponseCompound.md b/docs/EzsignsignergroupResponseCompound.md index 0a42dbd44..014f788f5 100644 --- a/docs/EzsignsignergroupResponseCompound.md +++ b/docs/EzsignsignergroupResponseCompound.md @@ -3,6 +3,7 @@ An Ezsignsignergroup Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsignsignergroup_id** | **int** | The unique ID of the Ezsignsignergroup | diff --git a/docs/EzsignsignergroupmembershipCreateObjectV1Request.md b/docs/EzsignsignergroupmembershipCreateObjectV1Request.md index b3ae786fa..24f451ac2 100644 --- a/docs/EzsignsignergroupmembershipCreateObjectV1Request.md +++ b/docs/EzsignsignergroupmembershipCreateObjectV1Request.md @@ -3,6 +3,7 @@ Request for POST /1/object/ezsignsignergroupmembership ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_ezsignsignergroupmembership** | [**List[EzsignsignergroupmembershipRequestCompound]**](EzsignsignergroupmembershipRequestCompound.md) | | diff --git a/docs/EzsignsignergroupmembershipCreateObjectV1Response.md b/docs/EzsignsignergroupmembershipCreateObjectV1Response.md index 3d0134b4c..f9af7e2ec 100644 --- a/docs/EzsignsignergroupmembershipCreateObjectV1Response.md +++ b/docs/EzsignsignergroupmembershipCreateObjectV1Response.md @@ -3,6 +3,7 @@ Response for POST /1/object/ezsignsignergroupmembership ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsignsignergroupmembershipCreateObjectV1ResponseMPayload.md b/docs/EzsignsignergroupmembershipCreateObjectV1ResponseMPayload.md index 8928b3c5f..a1fbe045c 100644 --- a/docs/EzsignsignergroupmembershipCreateObjectV1ResponseMPayload.md +++ b/docs/EzsignsignergroupmembershipCreateObjectV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for POST /1/object/ezsignsignergroupmembership ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_pki_ezsignsignergroupmembership_id** | **List[int]** | An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request. | diff --git a/docs/EzsignsignergroupmembershipDeleteObjectV1Response.md b/docs/EzsignsignergroupmembershipDeleteObjectV1Response.md index 582039737..0b06bb8f2 100644 --- a/docs/EzsignsignergroupmembershipDeleteObjectV1Response.md +++ b/docs/EzsignsignergroupmembershipDeleteObjectV1Response.md @@ -3,6 +3,7 @@ Response for DELETE /1/object/ezsignsignergroupmembership/{pkiEzsignsignergroupmembershipID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsignsignergroupmembershipGetObjectV2Response.md b/docs/EzsignsignergroupmembershipGetObjectV2Response.md index 4382e7a1b..ca038db55 100644 --- a/docs/EzsignsignergroupmembershipGetObjectV2Response.md +++ b/docs/EzsignsignergroupmembershipGetObjectV2Response.md @@ -3,6 +3,7 @@ Response for GET /2/object/ezsignsignergroupmembership/{pkiEzsignsignergroupmembershipID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsignsignergroupmembershipGetObjectV2ResponseMPayload.md b/docs/EzsignsignergroupmembershipGetObjectV2ResponseMPayload.md index f73558392..570474b87 100644 --- a/docs/EzsignsignergroupmembershipGetObjectV2ResponseMPayload.md +++ b/docs/EzsignsignergroupmembershipGetObjectV2ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for GET /2/object/ezsignsignergroupmembership/{pkiEzsignsignergroupmembershipID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_ezsignsignergroupmembership** | [**EzsignsignergroupmembershipResponseCompound**](EzsignsignergroupmembershipResponseCompound.md) | | diff --git a/docs/EzsignsignergroupmembershipRequest.md b/docs/EzsignsignergroupmembershipRequest.md index 00c77ee57..fcf0f9c1d 100644 --- a/docs/EzsignsignergroupmembershipRequest.md +++ b/docs/EzsignsignergroupmembershipRequest.md @@ -3,6 +3,7 @@ A Ezsignsignergroupmembership Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsignsignergroupmembership_id** | **int** | The unique ID of the Ezsignsignergroupmembership | [optional] diff --git a/docs/EzsignsignergroupmembershipRequestCompound.md b/docs/EzsignsignergroupmembershipRequestCompound.md index ade917a05..ac57bb845 100644 --- a/docs/EzsignsignergroupmembershipRequestCompound.md +++ b/docs/EzsignsignergroupmembershipRequestCompound.md @@ -3,6 +3,7 @@ A Ezsignsignergroupmembership Object and children ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsignsignergroupmembership_id** | **int** | The unique ID of the Ezsignsignergroupmembership | [optional] diff --git a/docs/EzsignsignergroupmembershipResponse.md b/docs/EzsignsignergroupmembershipResponse.md index 2e0164035..5c2ddb1e9 100644 --- a/docs/EzsignsignergroupmembershipResponse.md +++ b/docs/EzsignsignergroupmembershipResponse.md @@ -3,6 +3,7 @@ A Ezsignsignergroupmembership Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsignsignergroupmembership_id** | **int** | The unique ID of the Ezsignsignergroupmembership | diff --git a/docs/EzsignsignergroupmembershipResponseCompound.md b/docs/EzsignsignergroupmembershipResponseCompound.md index 228130eab..b8df773fa 100644 --- a/docs/EzsignsignergroupmembershipResponseCompound.md +++ b/docs/EzsignsignergroupmembershipResponseCompound.md @@ -3,6 +3,7 @@ A Ezsignsignergroupmembership Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsignsignergroupmembership_id** | **int** | The unique ID of the Ezsignsignergroupmembership | diff --git a/docs/EzsignsigningreasonAutocompleteElementResponse.md b/docs/EzsignsigningreasonAutocompleteElementResponse.md new file mode 100644 index 000000000..8ba021ec0 --- /dev/null +++ b/docs/EzsignsigningreasonAutocompleteElementResponse.md @@ -0,0 +1,32 @@ +# EzsignsigningreasonAutocompleteElementResponse + +A Ezsignsigningreason AutocompleteElement Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pki_ezsignsigningreason_id** | **int** | The unique ID of the Ezsignsigningreason | +**s_ezsignsigningreason_description_x** | **str** | The description of the Ezsignsigningreason in the language of the requester | +**b_ezsignsigningreason_isactive** | **bool** | Whether the ezsignsigningreason is active or not | + +## Example + +```python +from eZmaxApi.models.ezsignsigningreason_autocomplete_element_response import EzsignsigningreasonAutocompleteElementResponse + +# TODO update the JSON string below +json = "{}" +# create an instance of EzsignsigningreasonAutocompleteElementResponse from a JSON string +ezsignsigningreason_autocomplete_element_response_instance = EzsignsigningreasonAutocompleteElementResponse.from_json(json) +# print the JSON string representation of the object +print EzsignsigningreasonAutocompleteElementResponse.to_json() + +# convert the object into a dict +ezsignsigningreason_autocomplete_element_response_dict = ezsignsigningreason_autocomplete_element_response_instance.to_dict() +# create an instance of EzsignsigningreasonAutocompleteElementResponse from a dict +ezsignsigningreason_autocomplete_element_response_form_dict = ezsignsigningreason_autocomplete_element_response.from_dict(ezsignsigningreason_autocomplete_element_response_dict) +``` +[[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/docs/EzsignsigningreasonCreateObjectV1Request.md b/docs/EzsignsigningreasonCreateObjectV1Request.md new file mode 100644 index 000000000..7d5fe568b --- /dev/null +++ b/docs/EzsignsigningreasonCreateObjectV1Request.md @@ -0,0 +1,30 @@ +# EzsignsigningreasonCreateObjectV1Request + +Request for POST /1/object/ezsignsigningreason + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**a_obj_ezsignsigningreason** | [**List[EzsignsigningreasonRequestCompound]**](EzsignsigningreasonRequestCompound.md) | | + +## Example + +```python +from eZmaxApi.models.ezsignsigningreason_create_object_v1_request import EzsignsigningreasonCreateObjectV1Request + +# TODO update the JSON string below +json = "{}" +# create an instance of EzsignsigningreasonCreateObjectV1Request from a JSON string +ezsignsigningreason_create_object_v1_request_instance = EzsignsigningreasonCreateObjectV1Request.from_json(json) +# print the JSON string representation of the object +print EzsignsigningreasonCreateObjectV1Request.to_json() + +# convert the object into a dict +ezsignsigningreason_create_object_v1_request_dict = ezsignsigningreason_create_object_v1_request_instance.to_dict() +# create an instance of EzsignsigningreasonCreateObjectV1Request from a dict +ezsignsigningreason_create_object_v1_request_form_dict = ezsignsigningreason_create_object_v1_request.from_dict(ezsignsigningreason_create_object_v1_request_dict) +``` +[[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/docs/EzsignsigningreasonCreateObjectV1Response.md b/docs/EzsignsigningreasonCreateObjectV1Response.md new file mode 100644 index 000000000..13db4529b --- /dev/null +++ b/docs/EzsignsigningreasonCreateObjectV1Response.md @@ -0,0 +1,32 @@ +# EzsignsigningreasonCreateObjectV1Response + +Response for POST /1/object/ezsignsigningreason + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | +**obj_debug** | [**CommonResponseObjDebug**](CommonResponseObjDebug.md) | | [optional] +**m_payload** | [**EzsignsigningreasonCreateObjectV1ResponseMPayload**](EzsignsigningreasonCreateObjectV1ResponseMPayload.md) | | + +## Example + +```python +from eZmaxApi.models.ezsignsigningreason_create_object_v1_response import EzsignsigningreasonCreateObjectV1Response + +# TODO update the JSON string below +json = "{}" +# create an instance of EzsignsigningreasonCreateObjectV1Response from a JSON string +ezsignsigningreason_create_object_v1_response_instance = EzsignsigningreasonCreateObjectV1Response.from_json(json) +# print the JSON string representation of the object +print EzsignsigningreasonCreateObjectV1Response.to_json() + +# convert the object into a dict +ezsignsigningreason_create_object_v1_response_dict = ezsignsigningreason_create_object_v1_response_instance.to_dict() +# create an instance of EzsignsigningreasonCreateObjectV1Response from a dict +ezsignsigningreason_create_object_v1_response_form_dict = ezsignsigningreason_create_object_v1_response.from_dict(ezsignsigningreason_create_object_v1_response_dict) +``` +[[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/docs/EzsignsigningreasonCreateObjectV1ResponseMPayload.md b/docs/EzsignsigningreasonCreateObjectV1ResponseMPayload.md new file mode 100644 index 000000000..94820b0b2 --- /dev/null +++ b/docs/EzsignsigningreasonCreateObjectV1ResponseMPayload.md @@ -0,0 +1,30 @@ +# EzsignsigningreasonCreateObjectV1ResponseMPayload + +Payload for POST /1/object/ezsignsigningreason + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**a_pki_ezsignsigningreason_id** | **List[int]** | An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request. | + +## Example + +```python +from eZmaxApi.models.ezsignsigningreason_create_object_v1_response_m_payload import EzsignsigningreasonCreateObjectV1ResponseMPayload + +# TODO update the JSON string below +json = "{}" +# create an instance of EzsignsigningreasonCreateObjectV1ResponseMPayload from a JSON string +ezsignsigningreason_create_object_v1_response_m_payload_instance = EzsignsigningreasonCreateObjectV1ResponseMPayload.from_json(json) +# print the JSON string representation of the object +print EzsignsigningreasonCreateObjectV1ResponseMPayload.to_json() + +# convert the object into a dict +ezsignsigningreason_create_object_v1_response_m_payload_dict = ezsignsigningreason_create_object_v1_response_m_payload_instance.to_dict() +# create an instance of EzsignsigningreasonCreateObjectV1ResponseMPayload from a dict +ezsignsigningreason_create_object_v1_response_m_payload_form_dict = ezsignsigningreason_create_object_v1_response_m_payload.from_dict(ezsignsigningreason_create_object_v1_response_m_payload_dict) +``` +[[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/docs/EzsignsigningreasonEditObjectV1Request.md b/docs/EzsignsigningreasonEditObjectV1Request.md new file mode 100644 index 000000000..64ec40edf --- /dev/null +++ b/docs/EzsignsigningreasonEditObjectV1Request.md @@ -0,0 +1,30 @@ +# EzsignsigningreasonEditObjectV1Request + +Request for PUT /1/object/ezsignsigningreason/{pkiEzsignsigningreasonID} + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**obj_ezsignsigningreason** | [**EzsignsigningreasonRequestCompound**](EzsignsigningreasonRequestCompound.md) | | + +## Example + +```python +from eZmaxApi.models.ezsignsigningreason_edit_object_v1_request import EzsignsigningreasonEditObjectV1Request + +# TODO update the JSON string below +json = "{}" +# create an instance of EzsignsigningreasonEditObjectV1Request from a JSON string +ezsignsigningreason_edit_object_v1_request_instance = EzsignsigningreasonEditObjectV1Request.from_json(json) +# print the JSON string representation of the object +print EzsignsigningreasonEditObjectV1Request.to_json() + +# convert the object into a dict +ezsignsigningreason_edit_object_v1_request_dict = ezsignsigningreason_edit_object_v1_request_instance.to_dict() +# create an instance of EzsignsigningreasonEditObjectV1Request from a dict +ezsignsigningreason_edit_object_v1_request_form_dict = ezsignsigningreason_edit_object_v1_request.from_dict(ezsignsigningreason_edit_object_v1_request_dict) +``` +[[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/docs/EzsignsigningreasonEditObjectV1Response.md b/docs/EzsignsigningreasonEditObjectV1Response.md new file mode 100644 index 000000000..abaf111d9 --- /dev/null +++ b/docs/EzsignsigningreasonEditObjectV1Response.md @@ -0,0 +1,31 @@ +# EzsignsigningreasonEditObjectV1Response + +Response for PUT /1/object/ezsignsigningreason/{pkiEzsignsigningreasonID} + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | +**obj_debug** | [**CommonResponseObjDebug**](CommonResponseObjDebug.md) | | [optional] + +## Example + +```python +from eZmaxApi.models.ezsignsigningreason_edit_object_v1_response import EzsignsigningreasonEditObjectV1Response + +# TODO update the JSON string below +json = "{}" +# create an instance of EzsignsigningreasonEditObjectV1Response from a JSON string +ezsignsigningreason_edit_object_v1_response_instance = EzsignsigningreasonEditObjectV1Response.from_json(json) +# print the JSON string representation of the object +print EzsignsigningreasonEditObjectV1Response.to_json() + +# convert the object into a dict +ezsignsigningreason_edit_object_v1_response_dict = ezsignsigningreason_edit_object_v1_response_instance.to_dict() +# create an instance of EzsignsigningreasonEditObjectV1Response from a dict +ezsignsigningreason_edit_object_v1_response_form_dict = ezsignsigningreason_edit_object_v1_response.from_dict(ezsignsigningreason_edit_object_v1_response_dict) +``` +[[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/docs/EzsignsigningreasonGetAutocompleteV2Response.md b/docs/EzsignsigningreasonGetAutocompleteV2Response.md new file mode 100644 index 000000000..42901524e --- /dev/null +++ b/docs/EzsignsigningreasonGetAutocompleteV2Response.md @@ -0,0 +1,32 @@ +# EzsignsigningreasonGetAutocompleteV2Response + +Response for GET /2/object/ezsignsigningreason/getAutocomplete + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | +**obj_debug** | [**CommonResponseObjDebug**](CommonResponseObjDebug.md) | | [optional] +**m_payload** | [**EzsignsigningreasonGetAutocompleteV2ResponseMPayload**](EzsignsigningreasonGetAutocompleteV2ResponseMPayload.md) | | + +## Example + +```python +from eZmaxApi.models.ezsignsigningreason_get_autocomplete_v2_response import EzsignsigningreasonGetAutocompleteV2Response + +# TODO update the JSON string below +json = "{}" +# create an instance of EzsignsigningreasonGetAutocompleteV2Response from a JSON string +ezsignsigningreason_get_autocomplete_v2_response_instance = EzsignsigningreasonGetAutocompleteV2Response.from_json(json) +# print the JSON string representation of the object +print EzsignsigningreasonGetAutocompleteV2Response.to_json() + +# convert the object into a dict +ezsignsigningreason_get_autocomplete_v2_response_dict = ezsignsigningreason_get_autocomplete_v2_response_instance.to_dict() +# create an instance of EzsignsigningreasonGetAutocompleteV2Response from a dict +ezsignsigningreason_get_autocomplete_v2_response_form_dict = ezsignsigningreason_get_autocomplete_v2_response.from_dict(ezsignsigningreason_get_autocomplete_v2_response_dict) +``` +[[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/docs/EzsignsigningreasonGetAutocompleteV2ResponseMPayload.md b/docs/EzsignsigningreasonGetAutocompleteV2ResponseMPayload.md new file mode 100644 index 000000000..9f588105c --- /dev/null +++ b/docs/EzsignsigningreasonGetAutocompleteV2ResponseMPayload.md @@ -0,0 +1,30 @@ +# EzsignsigningreasonGetAutocompleteV2ResponseMPayload + +Payload for POST /2/object/ezsignsigningreason/getAutocomplete + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**a_obj_ezsignsigningreason** | [**List[EzsignsigningreasonAutocompleteElementResponse]**](EzsignsigningreasonAutocompleteElementResponse.md) | An array of Ezsignsigningreason autocomplete element response. | + +## Example + +```python +from eZmaxApi.models.ezsignsigningreason_get_autocomplete_v2_response_m_payload import EzsignsigningreasonGetAutocompleteV2ResponseMPayload + +# TODO update the JSON string below +json = "{}" +# create an instance of EzsignsigningreasonGetAutocompleteV2ResponseMPayload from a JSON string +ezsignsigningreason_get_autocomplete_v2_response_m_payload_instance = EzsignsigningreasonGetAutocompleteV2ResponseMPayload.from_json(json) +# print the JSON string representation of the object +print EzsignsigningreasonGetAutocompleteV2ResponseMPayload.to_json() + +# convert the object into a dict +ezsignsigningreason_get_autocomplete_v2_response_m_payload_dict = ezsignsigningreason_get_autocomplete_v2_response_m_payload_instance.to_dict() +# create an instance of EzsignsigningreasonGetAutocompleteV2ResponseMPayload from a dict +ezsignsigningreason_get_autocomplete_v2_response_m_payload_form_dict = ezsignsigningreason_get_autocomplete_v2_response_m_payload.from_dict(ezsignsigningreason_get_autocomplete_v2_response_m_payload_dict) +``` +[[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/docs/EzsignsigningreasonGetListV1Response.md b/docs/EzsignsigningreasonGetListV1Response.md new file mode 100644 index 000000000..653ed531b --- /dev/null +++ b/docs/EzsignsigningreasonGetListV1Response.md @@ -0,0 +1,32 @@ +# EzsignsigningreasonGetListV1Response + +Response for GET /1/object/ezsignsigningreason/getList + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**obj_debug_payload** | [**CommonResponseObjDebugPayloadGetList**](CommonResponseObjDebugPayloadGetList.md) | | +**obj_debug** | [**CommonResponseObjDebug**](CommonResponseObjDebug.md) | | [optional] +**m_payload** | [**EzsignsigningreasonGetListV1ResponseMPayload**](EzsignsigningreasonGetListV1ResponseMPayload.md) | | + +## Example + +```python +from eZmaxApi.models.ezsignsigningreason_get_list_v1_response import EzsignsigningreasonGetListV1Response + +# TODO update the JSON string below +json = "{}" +# create an instance of EzsignsigningreasonGetListV1Response from a JSON string +ezsignsigningreason_get_list_v1_response_instance = EzsignsigningreasonGetListV1Response.from_json(json) +# print the JSON string representation of the object +print EzsignsigningreasonGetListV1Response.to_json() + +# convert the object into a dict +ezsignsigningreason_get_list_v1_response_dict = ezsignsigningreason_get_list_v1_response_instance.to_dict() +# create an instance of EzsignsigningreasonGetListV1Response from a dict +ezsignsigningreason_get_list_v1_response_form_dict = ezsignsigningreason_get_list_v1_response.from_dict(ezsignsigningreason_get_list_v1_response_dict) +``` +[[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/docs/EzsignsigningreasonGetListV1ResponseMPayload.md b/docs/EzsignsigningreasonGetListV1ResponseMPayload.md new file mode 100644 index 000000000..92f80530a --- /dev/null +++ b/docs/EzsignsigningreasonGetListV1ResponseMPayload.md @@ -0,0 +1,32 @@ +# EzsignsigningreasonGetListV1ResponseMPayload + +Payload for GET /1/object/ezsignsigningreason/getList + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**i_row_returned** | **int** | The number of rows returned | +**i_row_filtered** | **int** | The number of rows matching your filters (if any) or the total number of rows | +**a_obj_ezsignsigningreason** | [**List[EzsignsigningreasonListElement]**](EzsignsigningreasonListElement.md) | | + +## Example + +```python +from eZmaxApi.models.ezsignsigningreason_get_list_v1_response_m_payload import EzsignsigningreasonGetListV1ResponseMPayload + +# TODO update the JSON string below +json = "{}" +# create an instance of EzsignsigningreasonGetListV1ResponseMPayload from a JSON string +ezsignsigningreason_get_list_v1_response_m_payload_instance = EzsignsigningreasonGetListV1ResponseMPayload.from_json(json) +# print the JSON string representation of the object +print EzsignsigningreasonGetListV1ResponseMPayload.to_json() + +# convert the object into a dict +ezsignsigningreason_get_list_v1_response_m_payload_dict = ezsignsigningreason_get_list_v1_response_m_payload_instance.to_dict() +# create an instance of EzsignsigningreasonGetListV1ResponseMPayload from a dict +ezsignsigningreason_get_list_v1_response_m_payload_form_dict = ezsignsigningreason_get_list_v1_response_m_payload.from_dict(ezsignsigningreason_get_list_v1_response_m_payload_dict) +``` +[[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/docs/EzsignsigningreasonGetObjectV2Response.md b/docs/EzsignsigningreasonGetObjectV2Response.md new file mode 100644 index 000000000..09ce0bf48 --- /dev/null +++ b/docs/EzsignsigningreasonGetObjectV2Response.md @@ -0,0 +1,32 @@ +# EzsignsigningreasonGetObjectV2Response + +Response for GET /2/object/ezsignsigningreason/{pkiEzsignsigningreasonID} + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | +**obj_debug** | [**CommonResponseObjDebug**](CommonResponseObjDebug.md) | | [optional] +**m_payload** | [**EzsignsigningreasonGetObjectV2ResponseMPayload**](EzsignsigningreasonGetObjectV2ResponseMPayload.md) | | + +## Example + +```python +from eZmaxApi.models.ezsignsigningreason_get_object_v2_response import EzsignsigningreasonGetObjectV2Response + +# TODO update the JSON string below +json = "{}" +# create an instance of EzsignsigningreasonGetObjectV2Response from a JSON string +ezsignsigningreason_get_object_v2_response_instance = EzsignsigningreasonGetObjectV2Response.from_json(json) +# print the JSON string representation of the object +print EzsignsigningreasonGetObjectV2Response.to_json() + +# convert the object into a dict +ezsignsigningreason_get_object_v2_response_dict = ezsignsigningreason_get_object_v2_response_instance.to_dict() +# create an instance of EzsignsigningreasonGetObjectV2Response from a dict +ezsignsigningreason_get_object_v2_response_form_dict = ezsignsigningreason_get_object_v2_response.from_dict(ezsignsigningreason_get_object_v2_response_dict) +``` +[[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/docs/EzsignsigningreasonGetObjectV2ResponseMPayload.md b/docs/EzsignsigningreasonGetObjectV2ResponseMPayload.md new file mode 100644 index 000000000..3d2ee0c69 --- /dev/null +++ b/docs/EzsignsigningreasonGetObjectV2ResponseMPayload.md @@ -0,0 +1,30 @@ +# EzsignsigningreasonGetObjectV2ResponseMPayload + +Payload for GET /2/object/ezsignsigningreason/{pkiEzsignsigningreasonID} + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**obj_ezsignsigningreason** | [**EzsignsigningreasonResponseCompound**](EzsignsigningreasonResponseCompound.md) | | + +## Example + +```python +from eZmaxApi.models.ezsignsigningreason_get_object_v2_response_m_payload import EzsignsigningreasonGetObjectV2ResponseMPayload + +# TODO update the JSON string below +json = "{}" +# create an instance of EzsignsigningreasonGetObjectV2ResponseMPayload from a JSON string +ezsignsigningreason_get_object_v2_response_m_payload_instance = EzsignsigningreasonGetObjectV2ResponseMPayload.from_json(json) +# print the JSON string representation of the object +print EzsignsigningreasonGetObjectV2ResponseMPayload.to_json() + +# convert the object into a dict +ezsignsigningreason_get_object_v2_response_m_payload_dict = ezsignsigningreason_get_object_v2_response_m_payload_instance.to_dict() +# create an instance of EzsignsigningreasonGetObjectV2ResponseMPayload from a dict +ezsignsigningreason_get_object_v2_response_m_payload_form_dict = ezsignsigningreason_get_object_v2_response_m_payload.from_dict(ezsignsigningreason_get_object_v2_response_m_payload_dict) +``` +[[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/docs/EzsignsigningreasonListElement.md b/docs/EzsignsigningreasonListElement.md new file mode 100644 index 000000000..53cc8a3d3 --- /dev/null +++ b/docs/EzsignsigningreasonListElement.md @@ -0,0 +1,32 @@ +# EzsignsigningreasonListElement + +A Ezsignsigningreason List Element + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pki_ezsignsigningreason_id** | **int** | The unique ID of the Ezsignsigningreason | +**s_ezsignsigningreason_description_x** | **str** | The description of the Ezsignsigningreason in the language of the requester | +**b_ezsignsigningreason_isactive** | **bool** | Whether the ezsignsigningreason is active or not | + +## Example + +```python +from eZmaxApi.models.ezsignsigningreason_list_element import EzsignsigningreasonListElement + +# TODO update the JSON string below +json = "{}" +# create an instance of EzsignsigningreasonListElement from a JSON string +ezsignsigningreason_list_element_instance = EzsignsigningreasonListElement.from_json(json) +# print the JSON string representation of the object +print EzsignsigningreasonListElement.to_json() + +# convert the object into a dict +ezsignsigningreason_list_element_dict = ezsignsigningreason_list_element_instance.to_dict() +# create an instance of EzsignsigningreasonListElement from a dict +ezsignsigningreason_list_element_form_dict = ezsignsigningreason_list_element.from_dict(ezsignsigningreason_list_element_dict) +``` +[[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/docs/EzsignsigningreasonRequest.md b/docs/EzsignsigningreasonRequest.md new file mode 100644 index 000000000..fc8782544 --- /dev/null +++ b/docs/EzsignsigningreasonRequest.md @@ -0,0 +1,32 @@ +# EzsignsigningreasonRequest + +A Ezsignsigningreason Object + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pki_ezsignsigningreason_id** | **int** | The unique ID of the Ezsignsigningreason | [optional] +**obj_ezsignsigningreason_description** | [**MultilingualEzsignsigningreasonDescription**](MultilingualEzsignsigningreasonDescription.md) | | +**b_ezsignsigningreason_isactive** | **bool** | Whether the ezsignsigningreason is active or not | + +## Example + +```python +from eZmaxApi.models.ezsignsigningreason_request import EzsignsigningreasonRequest + +# TODO update the JSON string below +json = "{}" +# create an instance of EzsignsigningreasonRequest from a JSON string +ezsignsigningreason_request_instance = EzsignsigningreasonRequest.from_json(json) +# print the JSON string representation of the object +print EzsignsigningreasonRequest.to_json() + +# convert the object into a dict +ezsignsigningreason_request_dict = ezsignsigningreason_request_instance.to_dict() +# create an instance of EzsignsigningreasonRequest from a dict +ezsignsigningreason_request_form_dict = ezsignsigningreason_request.from_dict(ezsignsigningreason_request_dict) +``` +[[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/docs/EzsignsigningreasonRequestCompound.md b/docs/EzsignsigningreasonRequestCompound.md new file mode 100644 index 000000000..f4a69aeb2 --- /dev/null +++ b/docs/EzsignsigningreasonRequestCompound.md @@ -0,0 +1,32 @@ +# EzsignsigningreasonRequestCompound + +A Ezsignsigningreason Object and children + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pki_ezsignsigningreason_id** | **int** | The unique ID of the Ezsignsigningreason | [optional] +**obj_ezsignsigningreason_description** | [**MultilingualEzsignsigningreasonDescription**](MultilingualEzsignsigningreasonDescription.md) | | +**b_ezsignsigningreason_isactive** | **bool** | Whether the ezsignsigningreason is active or not | + +## Example + +```python +from eZmaxApi.models.ezsignsigningreason_request_compound import EzsignsigningreasonRequestCompound + +# TODO update the JSON string below +json = "{}" +# create an instance of EzsignsigningreasonRequestCompound from a JSON string +ezsignsigningreason_request_compound_instance = EzsignsigningreasonRequestCompound.from_json(json) +# print the JSON string representation of the object +print EzsignsigningreasonRequestCompound.to_json() + +# convert the object into a dict +ezsignsigningreason_request_compound_dict = ezsignsigningreason_request_compound_instance.to_dict() +# create an instance of EzsignsigningreasonRequestCompound from a dict +ezsignsigningreason_request_compound_form_dict = ezsignsigningreason_request_compound.from_dict(ezsignsigningreason_request_compound_dict) +``` +[[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/docs/EzsignsigningreasonResponse.md b/docs/EzsignsigningreasonResponse.md new file mode 100644 index 000000000..6e390ab5a --- /dev/null +++ b/docs/EzsignsigningreasonResponse.md @@ -0,0 +1,32 @@ +# EzsignsigningreasonResponse + +A Ezsignsigningreason Object + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pki_ezsignsigningreason_id** | **int** | The unique ID of the Ezsignsigningreason | +**obj_ezsignsigningreason_description** | [**MultilingualEzsignsigningreasonDescription**](MultilingualEzsignsigningreasonDescription.md) | | +**b_ezsignsigningreason_isactive** | **bool** | Whether the ezsignsigningreason is active or not | + +## Example + +```python +from eZmaxApi.models.ezsignsigningreason_response import EzsignsigningreasonResponse + +# TODO update the JSON string below +json = "{}" +# create an instance of EzsignsigningreasonResponse from a JSON string +ezsignsigningreason_response_instance = EzsignsigningreasonResponse.from_json(json) +# print the JSON string representation of the object +print EzsignsigningreasonResponse.to_json() + +# convert the object into a dict +ezsignsigningreason_response_dict = ezsignsigningreason_response_instance.to_dict() +# create an instance of EzsignsigningreasonResponse from a dict +ezsignsigningreason_response_form_dict = ezsignsigningreason_response.from_dict(ezsignsigningreason_response_dict) +``` +[[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/docs/EzsignsigningreasonResponseCompound.md b/docs/EzsignsigningreasonResponseCompound.md new file mode 100644 index 000000000..2f9b992a8 --- /dev/null +++ b/docs/EzsignsigningreasonResponseCompound.md @@ -0,0 +1,32 @@ +# EzsignsigningreasonResponseCompound + +A Ezsignsigningreason Object + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pki_ezsignsigningreason_id** | **int** | The unique ID of the Ezsignsigningreason | +**obj_ezsignsigningreason_description** | [**MultilingualEzsignsigningreasonDescription**](MultilingualEzsignsigningreasonDescription.md) | | +**b_ezsignsigningreason_isactive** | **bool** | Whether the ezsignsigningreason is active or not | + +## Example + +```python +from eZmaxApi.models.ezsignsigningreason_response_compound import EzsignsigningreasonResponseCompound + +# TODO update the JSON string below +json = "{}" +# create an instance of EzsignsigningreasonResponseCompound from a JSON string +ezsignsigningreason_response_compound_instance = EzsignsigningreasonResponseCompound.from_json(json) +# print the JSON string representation of the object +print EzsignsigningreasonResponseCompound.to_json() + +# convert the object into a dict +ezsignsigningreason_response_compound_dict = ezsignsigningreason_response_compound_instance.to_dict() +# create an instance of EzsignsigningreasonResponseCompound from a dict +ezsignsigningreason_response_compound_form_dict = ezsignsigningreason_response_compound.from_dict(ezsignsigningreason_response_compound_dict) +``` +[[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/docs/EzsigntemplateAutocompleteElementResponse.md b/docs/EzsigntemplateAutocompleteElementResponse.md index d74049a38..eb8e13486 100644 --- a/docs/EzsigntemplateAutocompleteElementResponse.md +++ b/docs/EzsigntemplateAutocompleteElementResponse.md @@ -3,6 +3,7 @@ A Ezsigntemplate AutocompleteElement Response ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **e_ezsignfoldertype_privacylevel** | [**FieldEEzsignfoldertypePrivacylevel**](FieldEEzsignfoldertypePrivacylevel.md) | | diff --git a/docs/EzsigntemplateCopyV1Request.md b/docs/EzsigntemplateCopyV1Request.md index 0ed64eff6..9e122a298 100644 --- a/docs/EzsigntemplateCopyV1Request.md +++ b/docs/EzsigntemplateCopyV1Request.md @@ -3,6 +3,7 @@ Request for POST /1/object/ezsigntemplate/{pkiEzsigntemplateID}/copy ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_fki_ezsignfoldertype_id** | **List[int]** | | diff --git a/docs/EzsigntemplateCopyV1Response.md b/docs/EzsigntemplateCopyV1Response.md index 91803f236..05000cc47 100644 --- a/docs/EzsigntemplateCopyV1Response.md +++ b/docs/EzsigntemplateCopyV1Response.md @@ -3,6 +3,7 @@ Response for POST /1/object/ezsigntemplate/{pkiEzsigntemplateID}/copy ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsigntemplateCopyV1ResponseMPayload.md b/docs/EzsigntemplateCopyV1ResponseMPayload.md index ea91fc5a9..dc11079c9 100644 --- a/docs/EzsigntemplateCopyV1ResponseMPayload.md +++ b/docs/EzsigntemplateCopyV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for POST /1/object/ezsigntemplate/{pkiEzsigntemplateID}/copy ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_pki_ezsigntemplate_id** | **List[int]** | An array of unique IDs representing the object that were requested to be copied. They are returned in the same order as the array containing the objects to be created that was sent in the request. | diff --git a/docs/EzsigntemplateCreateObjectV1Request.md b/docs/EzsigntemplateCreateObjectV1Request.md index a3344b239..cbb57f7f3 100644 --- a/docs/EzsigntemplateCreateObjectV1Request.md +++ b/docs/EzsigntemplateCreateObjectV1Request.md @@ -3,6 +3,7 @@ Request for POST /1/object/ezsigntemplate ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_ezsigntemplate** | [**List[EzsigntemplateRequestCompound]**](EzsigntemplateRequestCompound.md) | | diff --git a/docs/EzsigntemplateCreateObjectV1Response.md b/docs/EzsigntemplateCreateObjectV1Response.md index 71a9a6d68..13dc66b54 100644 --- a/docs/EzsigntemplateCreateObjectV1Response.md +++ b/docs/EzsigntemplateCreateObjectV1Response.md @@ -3,6 +3,7 @@ Response for POST /1/object/ezsigntemplate ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsigntemplateCreateObjectV1ResponseMPayload.md b/docs/EzsigntemplateCreateObjectV1ResponseMPayload.md index ff8248492..247a5ac42 100644 --- a/docs/EzsigntemplateCreateObjectV1ResponseMPayload.md +++ b/docs/EzsigntemplateCreateObjectV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for POST /1/object/ezsigntemplate ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_pki_ezsigntemplate_id** | **List[int]** | An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request. | diff --git a/docs/EzsigntemplateDeleteObjectV1Response.md b/docs/EzsigntemplateDeleteObjectV1Response.md index 56b737d0e..eecdfb922 100644 --- a/docs/EzsigntemplateDeleteObjectV1Response.md +++ b/docs/EzsigntemplateDeleteObjectV1Response.md @@ -3,6 +3,7 @@ Response for DELETE /1/object/ezsigntemplate/{pkiEzsigntemplateID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsigntemplateEditObjectV1Request.md b/docs/EzsigntemplateEditObjectV1Request.md index 87977108e..9baf2c26d 100644 --- a/docs/EzsigntemplateEditObjectV1Request.md +++ b/docs/EzsigntemplateEditObjectV1Request.md @@ -3,6 +3,7 @@ Request for PUT /1/object/ezsigntemplate/{pkiEzsigntemplateID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_ezsigntemplate** | [**EzsigntemplateRequestCompound**](EzsigntemplateRequestCompound.md) | | diff --git a/docs/EzsigntemplateEditObjectV1Response.md b/docs/EzsigntemplateEditObjectV1Response.md index 6000c1d3e..8a01b93bd 100644 --- a/docs/EzsigntemplateEditObjectV1Response.md +++ b/docs/EzsigntemplateEditObjectV1Response.md @@ -3,6 +3,7 @@ Response for PUT /1/object/ezsigntemplate/{pkiEzsigntemplateID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsigntemplateGetAutocompleteV2Response.md b/docs/EzsigntemplateGetAutocompleteV2Response.md index bd2b6bee5..05ecaf037 100644 --- a/docs/EzsigntemplateGetAutocompleteV2Response.md +++ b/docs/EzsigntemplateGetAutocompleteV2Response.md @@ -3,6 +3,7 @@ Response for GET /2/object/ezsigntemplate/getAutocomplete ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsigntemplateGetAutocompleteV2ResponseMPayload.md b/docs/EzsigntemplateGetAutocompleteV2ResponseMPayload.md index 6a2ebc5e1..dfab7d969 100644 --- a/docs/EzsigntemplateGetAutocompleteV2ResponseMPayload.md +++ b/docs/EzsigntemplateGetAutocompleteV2ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for POST /2/object/ezsigntemplate/getAutocomplete ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_ezsigntemplate** | [**List[EzsigntemplateAutocompleteElementResponse]**](EzsigntemplateAutocompleteElementResponse.md) | An array of Ezsigntemplate autocomplete element response. | diff --git a/docs/EzsigntemplateGetListV1Response.md b/docs/EzsigntemplateGetListV1Response.md index a24b51fc2..13b70c705 100644 --- a/docs/EzsigntemplateGetListV1Response.md +++ b/docs/EzsigntemplateGetListV1Response.md @@ -3,6 +3,7 @@ Response for GET /1/object/ezsigntemplate/getList ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayloadGetList**](CommonResponseObjDebugPayloadGetList.md) | | diff --git a/docs/EzsigntemplateGetListV1ResponseMPayload.md b/docs/EzsigntemplateGetListV1ResponseMPayload.md index a60c5b72d..b567d4b8b 100644 --- a/docs/EzsigntemplateGetListV1ResponseMPayload.md +++ b/docs/EzsigntemplateGetListV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for GET /1/object/ezsigntemplate/getList ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **i_row_returned** | **int** | The number of rows returned | diff --git a/docs/EzsigntemplateGetObjectV1Response.md b/docs/EzsigntemplateGetObjectV1Response.md index d6c754779..b5031ffae 100644 --- a/docs/EzsigntemplateGetObjectV1Response.md +++ b/docs/EzsigntemplateGetObjectV1Response.md @@ -3,6 +3,7 @@ Response for GET /1/object/ezsigntemplate/{pkiEzsigntemplateID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsigntemplateGetObjectV1ResponseMPayload.md b/docs/EzsigntemplateGetObjectV1ResponseMPayload.md index 46bfc3489..94a5a29f1 100644 --- a/docs/EzsigntemplateGetObjectV1ResponseMPayload.md +++ b/docs/EzsigntemplateGetObjectV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for GET /1/object/ezsigntemplate/{pkiEzsigntemplateID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsigntemplate_id** | **int** | The unique ID of the Ezsigntemplate | diff --git a/docs/EzsigntemplateGetObjectV2Response.md b/docs/EzsigntemplateGetObjectV2Response.md index 0ed9c5042..90a5a00e4 100644 --- a/docs/EzsigntemplateGetObjectV2Response.md +++ b/docs/EzsigntemplateGetObjectV2Response.md @@ -3,6 +3,7 @@ Response for GET /2/object/ezsigntemplate/{pkiEzsigntemplateID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsigntemplateGetObjectV2ResponseMPayload.md b/docs/EzsigntemplateGetObjectV2ResponseMPayload.md index 072c9d007..c95a1ef52 100644 --- a/docs/EzsigntemplateGetObjectV2ResponseMPayload.md +++ b/docs/EzsigntemplateGetObjectV2ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for GET /2/object/ezsigntemplate/{pkiEzsigntemplateID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_ezsigntemplate** | [**EzsigntemplateResponseCompound**](EzsigntemplateResponseCompound.md) | | diff --git a/docs/EzsigntemplateListElement.md b/docs/EzsigntemplateListElement.md index f61596186..f4e849255 100644 --- a/docs/EzsigntemplateListElement.md +++ b/docs/EzsigntemplateListElement.md @@ -3,6 +3,7 @@ A Ezsigntemplate List Element ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsigntemplate_id** | **int** | The unique ID of the Ezsigntemplate | diff --git a/docs/EzsigntemplateRequest.md b/docs/EzsigntemplateRequest.md index 04ebbc5a2..c7a444a4f 100644 --- a/docs/EzsigntemplateRequest.md +++ b/docs/EzsigntemplateRequest.md @@ -3,6 +3,7 @@ A Ezsigntemplate Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsigntemplate_id** | **int** | The unique ID of the Ezsigntemplate | [optional] diff --git a/docs/EzsigntemplateRequestCompound.md b/docs/EzsigntemplateRequestCompound.md index a3415291a..726934334 100644 --- a/docs/EzsigntemplateRequestCompound.md +++ b/docs/EzsigntemplateRequestCompound.md @@ -3,6 +3,7 @@ A Ezsigntemplate Object and children ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsigntemplate_id** | **int** | The unique ID of the Ezsigntemplate | [optional] diff --git a/docs/EzsigntemplateResponse.md b/docs/EzsigntemplateResponse.md index da82d00da..04cd31ec1 100644 --- a/docs/EzsigntemplateResponse.md +++ b/docs/EzsigntemplateResponse.md @@ -3,6 +3,7 @@ A Ezsigntemplate Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsigntemplate_id** | **int** | The unique ID of the Ezsigntemplate | diff --git a/docs/EzsigntemplateResponseCompound.md b/docs/EzsigntemplateResponseCompound.md index d03e16608..d0aa51815 100644 --- a/docs/EzsigntemplateResponseCompound.md +++ b/docs/EzsigntemplateResponseCompound.md @@ -3,6 +3,7 @@ A Ezsigntemplate Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsigntemplate_id** | **int** | The unique ID of the Ezsigntemplate | diff --git a/docs/EzsigntemplatedocumentCreateObjectV1Request.md b/docs/EzsigntemplatedocumentCreateObjectV1Request.md index d3297f4df..9a5750eb8 100644 --- a/docs/EzsigntemplatedocumentCreateObjectV1Request.md +++ b/docs/EzsigntemplatedocumentCreateObjectV1Request.md @@ -3,6 +3,7 @@ Request for POST /1/object/ezsigntemplatedocument ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_ezsigntemplatedocument** | [**List[EzsigntemplatedocumentRequestCompound]**](EzsigntemplatedocumentRequestCompound.md) | | diff --git a/docs/EzsigntemplatedocumentCreateObjectV1Response.md b/docs/EzsigntemplatedocumentCreateObjectV1Response.md index 2e33829ea..4a0cafe31 100644 --- a/docs/EzsigntemplatedocumentCreateObjectV1Response.md +++ b/docs/EzsigntemplatedocumentCreateObjectV1Response.md @@ -3,6 +3,7 @@ Response for POST /1/object/ezsigntemplatedocument ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsigntemplatedocumentCreateObjectV1ResponseMPayload.md b/docs/EzsigntemplatedocumentCreateObjectV1ResponseMPayload.md index a689b5757..291dbbfa1 100644 --- a/docs/EzsigntemplatedocumentCreateObjectV1ResponseMPayload.md +++ b/docs/EzsigntemplatedocumentCreateObjectV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for POST /1/object/ezsigntemplatedocument ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_pki_ezsigntemplatedocument_id** | **List[int]** | An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request. | diff --git a/docs/EzsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1Request.md b/docs/EzsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1Request.md index 1f1960773..44c498286 100644 --- a/docs/EzsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1Request.md +++ b/docs/EzsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1Request.md @@ -3,6 +3,7 @@ Request for PUT /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/editEzsigntemplateformfieldgroups ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_ezsigntemplateformfieldgroup** | [**List[EzsigntemplateformfieldgroupRequestCompound]**](EzsigntemplateformfieldgroupRequestCompound.md) | | diff --git a/docs/EzsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1Response.md b/docs/EzsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1Response.md index 0363e2567..2876c2bed 100644 --- a/docs/EzsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1Response.md +++ b/docs/EzsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1Response.md @@ -3,6 +3,7 @@ Response for PUT /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/editEzsigntemplateformfieldgroups ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1ResponseMPayload.md b/docs/EzsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1ResponseMPayload.md index c184b65f7..db2a86c55 100644 --- a/docs/EzsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1ResponseMPayload.md +++ b/docs/EzsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for PUT /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/editEzsigntemplateformfieldgroups ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_pki_ezsigntemplateformfieldgroup_id** | **List[int]** | | diff --git a/docs/EzsigntemplatedocumentEditEzsigntemplatesignaturesV1Request.md b/docs/EzsigntemplatedocumentEditEzsigntemplatesignaturesV1Request.md index f0483ef43..dc09c06cb 100644 --- a/docs/EzsigntemplatedocumentEditEzsigntemplatesignaturesV1Request.md +++ b/docs/EzsigntemplatedocumentEditEzsigntemplatesignaturesV1Request.md @@ -3,6 +3,7 @@ Request for PUT /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/editEzsigntemplatesignatures ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_ezsigntemplatesignature** | [**List[EzsigntemplatesignatureRequestCompound]**](EzsigntemplatesignatureRequestCompound.md) | | diff --git a/docs/EzsigntemplatedocumentEditEzsigntemplatesignaturesV1Response.md b/docs/EzsigntemplatedocumentEditEzsigntemplatesignaturesV1Response.md index f441885d8..44a2d515d 100644 --- a/docs/EzsigntemplatedocumentEditEzsigntemplatesignaturesV1Response.md +++ b/docs/EzsigntemplatedocumentEditEzsigntemplatesignaturesV1Response.md @@ -3,6 +3,7 @@ Response for PUT /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/editEzsigntemplatesignatures ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsigntemplatedocumentEditEzsigntemplatesignaturesV1ResponseMPayload.md b/docs/EzsigntemplatedocumentEditEzsigntemplatesignaturesV1ResponseMPayload.md index a7ca76dc4..4c4db1f5a 100644 --- a/docs/EzsigntemplatedocumentEditEzsigntemplatesignaturesV1ResponseMPayload.md +++ b/docs/EzsigntemplatedocumentEditEzsigntemplatesignaturesV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for PUT /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/editEzsigntemplatesignatures ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_pki_ezsigntemplatesignature_id** | **List[int]** | | diff --git a/docs/EzsigntemplatedocumentEditObjectV1Request.md b/docs/EzsigntemplatedocumentEditObjectV1Request.md index f8eb58321..3f769fe0b 100644 --- a/docs/EzsigntemplatedocumentEditObjectV1Request.md +++ b/docs/EzsigntemplatedocumentEditObjectV1Request.md @@ -3,6 +3,7 @@ Request for PUT /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_ezsigntemplatedocument** | [**EzsigntemplatedocumentRequestCompound**](EzsigntemplatedocumentRequestCompound.md) | | diff --git a/docs/EzsigntemplatedocumentEditObjectV1Response.md b/docs/EzsigntemplatedocumentEditObjectV1Response.md index 0063e9c2a..bc54bd341 100644 --- a/docs/EzsigntemplatedocumentEditObjectV1Response.md +++ b/docs/EzsigntemplatedocumentEditObjectV1Response.md @@ -3,6 +3,7 @@ Response for PUT /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsigntemplatedocumentFlattenV1Response.md b/docs/EzsigntemplatedocumentFlattenV1Response.md index ecaf45917..6a5dedd25 100644 --- a/docs/EzsigntemplatedocumentFlattenV1Response.md +++ b/docs/EzsigntemplatedocumentFlattenV1Response.md @@ -3,6 +3,7 @@ Response for POST /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocument}/flatten ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsigntemplatedocumentGetEzsigntemplatedocumentpagesV1Response.md b/docs/EzsigntemplatedocumentGetEzsigntemplatedocumentpagesV1Response.md index 0d3278b94..470478dd1 100644 --- a/docs/EzsigntemplatedocumentGetEzsigntemplatedocumentpagesV1Response.md +++ b/docs/EzsigntemplatedocumentGetEzsigntemplatedocumentpagesV1Response.md @@ -3,6 +3,7 @@ Response for GET /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/getEzsigntemplatedocumentpages ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsigntemplatedocumentGetEzsigntemplatedocumentpagesV1ResponseMPayload.md b/docs/EzsigntemplatedocumentGetEzsigntemplatedocumentpagesV1ResponseMPayload.md index 5a91ffaa9..76d2592ba 100644 --- a/docs/EzsigntemplatedocumentGetEzsigntemplatedocumentpagesV1ResponseMPayload.md +++ b/docs/EzsigntemplatedocumentGetEzsigntemplatedocumentpagesV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for GET /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/getEzsigntemplatedocumentpages ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_ezsigntemplatedocumentpage** | [**List[EzsigntemplatedocumentpageResponseCompound]**](EzsigntemplatedocumentpageResponseCompound.md) | | diff --git a/docs/EzsigntemplatedocumentGetEzsigntemplateformfieldgroupsV1Response.md b/docs/EzsigntemplatedocumentGetEzsigntemplateformfieldgroupsV1Response.md index 002545135..589963f76 100644 --- a/docs/EzsigntemplatedocumentGetEzsigntemplateformfieldgroupsV1Response.md +++ b/docs/EzsigntemplatedocumentGetEzsigntemplateformfieldgroupsV1Response.md @@ -3,6 +3,7 @@ Response for GET /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocument}/getEzsigntemplateformfieldgroups ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsigntemplatedocumentGetEzsigntemplateformfieldgroupsV1ResponseMPayload.md b/docs/EzsigntemplatedocumentGetEzsigntemplateformfieldgroupsV1ResponseMPayload.md index 8470ea410..22c5e1277 100644 --- a/docs/EzsigntemplatedocumentGetEzsigntemplateformfieldgroupsV1ResponseMPayload.md +++ b/docs/EzsigntemplatedocumentGetEzsigntemplateformfieldgroupsV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for GET /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocument}/getEzsigntemplateformfieldgroups ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_ezsigntemplateformfieldgroup** | [**List[EzsigntemplateformfieldgroupResponseCompound]**](EzsigntemplateformfieldgroupResponseCompound.md) | | diff --git a/docs/EzsigntemplatedocumentGetEzsigntemplatesignaturesV1Response.md b/docs/EzsigntemplatedocumentGetEzsigntemplatesignaturesV1Response.md index 626cb613a..bd34281b0 100644 --- a/docs/EzsigntemplatedocumentGetEzsigntemplatesignaturesV1Response.md +++ b/docs/EzsigntemplatedocumentGetEzsigntemplatesignaturesV1Response.md @@ -3,6 +3,7 @@ Response for GET /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocument}/getEzsigntemplatesignatures ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsigntemplatedocumentGetEzsigntemplatesignaturesV1ResponseMPayload.md b/docs/EzsigntemplatedocumentGetEzsigntemplatesignaturesV1ResponseMPayload.md index 47708698f..b10c38619 100644 --- a/docs/EzsigntemplatedocumentGetEzsigntemplatesignaturesV1ResponseMPayload.md +++ b/docs/EzsigntemplatedocumentGetEzsigntemplatesignaturesV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for GET /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocument}/getEzsigntemplatesignatures ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_ezsigntemplatesignature** | [**List[EzsigntemplatesignatureResponseCompound]**](EzsigntemplatesignatureResponseCompound.md) | | diff --git a/docs/EzsigntemplatedocumentGetObjectV2Response.md b/docs/EzsigntemplatedocumentGetObjectV2Response.md index 38d2aadad..4c966d16d 100644 --- a/docs/EzsigntemplatedocumentGetObjectV2Response.md +++ b/docs/EzsigntemplatedocumentGetObjectV2Response.md @@ -3,6 +3,7 @@ Response for GET /2/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsigntemplatedocumentGetObjectV2ResponseMPayload.md b/docs/EzsigntemplatedocumentGetObjectV2ResponseMPayload.md index ddaba86aa..0a6aaf4f7 100644 --- a/docs/EzsigntemplatedocumentGetObjectV2ResponseMPayload.md +++ b/docs/EzsigntemplatedocumentGetObjectV2ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for GET /2/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_ezsigntemplatedocument** | [**EzsigntemplatedocumentResponseCompound**](EzsigntemplatedocumentResponseCompound.md) | | diff --git a/docs/EzsigntemplatedocumentGetWordsPositionsV1Request.md b/docs/EzsigntemplatedocumentGetWordsPositionsV1Request.md index bb2aaa173..8e8d99f7f 100644 --- a/docs/EzsigntemplatedocumentGetWordsPositionsV1Request.md +++ b/docs/EzsigntemplatedocumentGetWordsPositionsV1Request.md @@ -3,6 +3,7 @@ Request for POST /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/getWordsPositions ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **e_get** | **str** | Specify if you want to retrieve *All* words or specific *Words* from the document. If you specify *Words*, you must send the list of words to search for in *a_sWord*. | diff --git a/docs/EzsigntemplatedocumentGetWordsPositionsV1Response.md b/docs/EzsigntemplatedocumentGetWordsPositionsV1Response.md index 9a5caa833..d67a0b8bb 100644 --- a/docs/EzsigntemplatedocumentGetWordsPositionsV1Response.md +++ b/docs/EzsigntemplatedocumentGetWordsPositionsV1Response.md @@ -3,6 +3,7 @@ Response for POST /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/getWordsPositions ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsigntemplatedocumentPatchObjectV1Request.md b/docs/EzsigntemplatedocumentPatchObjectV1Request.md index 9823567d7..cacc9419f 100644 --- a/docs/EzsigntemplatedocumentPatchObjectV1Request.md +++ b/docs/EzsigntemplatedocumentPatchObjectV1Request.md @@ -3,6 +3,7 @@ Request for PATCH /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_ezsigntemplatedocument** | [**EzsigntemplatedocumentRequestPatch**](EzsigntemplatedocumentRequestPatch.md) | | diff --git a/docs/EzsigntemplatedocumentPatchObjectV1Response.md b/docs/EzsigntemplatedocumentPatchObjectV1Response.md index d4aac2cf5..91b4d105e 100644 --- a/docs/EzsigntemplatedocumentPatchObjectV1Response.md +++ b/docs/EzsigntemplatedocumentPatchObjectV1Response.md @@ -3,6 +3,7 @@ Response for PATCH /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsigntemplatedocumentRequest.md b/docs/EzsigntemplatedocumentRequest.md index 1ab821d38..47e41560a 100644 --- a/docs/EzsigntemplatedocumentRequest.md +++ b/docs/EzsigntemplatedocumentRequest.md @@ -3,6 +3,7 @@ A Ezsigntemplatedocument Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsigntemplatedocument_id** | **int** | The unique ID of the Ezsigntemplatedocument | [optional] diff --git a/docs/EzsigntemplatedocumentRequestCompound.md b/docs/EzsigntemplatedocumentRequestCompound.md index 3f23a8aad..d3772b5a4 100644 --- a/docs/EzsigntemplatedocumentRequestCompound.md +++ b/docs/EzsigntemplatedocumentRequestCompound.md @@ -3,6 +3,7 @@ A Ezsigntemplatedocument Object and children ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsigntemplatedocument_id** | **int** | The unique ID of the Ezsigntemplatedocument | [optional] diff --git a/docs/EzsigntemplatedocumentRequestPatch.md b/docs/EzsigntemplatedocumentRequestPatch.md index 7f5c074d9..d3bff3d70 100644 --- a/docs/EzsigntemplatedocumentRequestPatch.md +++ b/docs/EzsigntemplatedocumentRequestPatch.md @@ -3,6 +3,7 @@ An Ezsigntemplatedocument Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **s_ezsigntemplatedocument_name** | **str** | The name of the Ezsigntemplatedocument. | [optional] diff --git a/docs/EzsigntemplatedocumentResponse.md b/docs/EzsigntemplatedocumentResponse.md index 34d4ff9bf..ed28968ac 100644 --- a/docs/EzsigntemplatedocumentResponse.md +++ b/docs/EzsigntemplatedocumentResponse.md @@ -3,6 +3,7 @@ A Ezsigntemplatedocument Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsigntemplatedocument_id** | **int** | The unique ID of the Ezsigntemplatedocument | diff --git a/docs/EzsigntemplatedocumentResponseCompound.md b/docs/EzsigntemplatedocumentResponseCompound.md index 7d0086a4a..49299a053 100644 --- a/docs/EzsigntemplatedocumentResponseCompound.md +++ b/docs/EzsigntemplatedocumentResponseCompound.md @@ -3,6 +3,7 @@ A Ezsigntemplatedocument Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsigntemplatedocument_id** | **int** | The unique ID of the Ezsigntemplatedocument | diff --git a/docs/EzsigntemplatedocumentpageResponse.md b/docs/EzsigntemplatedocumentpageResponse.md index 6dc295b1b..ac68723e1 100644 --- a/docs/EzsigntemplatedocumentpageResponse.md +++ b/docs/EzsigntemplatedocumentpageResponse.md @@ -3,6 +3,7 @@ An Ezsigntemplatedocumentpage Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsigntemplatedocumentpage_id** | **int** | The unique ID of the Ezsigntemplatedocumentpage | diff --git a/docs/EzsigntemplatedocumentpageResponseCompound.md b/docs/EzsigntemplatedocumentpageResponseCompound.md index bddd2948e..05f262250 100644 --- a/docs/EzsigntemplatedocumentpageResponseCompound.md +++ b/docs/EzsigntemplatedocumentpageResponseCompound.md @@ -3,6 +3,7 @@ An Ezsigntemplatedocumentpage Object and children to create a complete structure ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsigntemplatedocumentpage_id** | **int** | The unique ID of the Ezsigntemplatedocumentpage | diff --git a/docs/EzsigntemplateelementdependencyRequest.md b/docs/EzsigntemplateelementdependencyRequest.md index 9a2f69ac8..5862fb542 100644 --- a/docs/EzsigntemplateelementdependencyRequest.md +++ b/docs/EzsigntemplateelementdependencyRequest.md @@ -3,6 +3,7 @@ An Ezsigntemplateelementdependency Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsigntemplateelementdependency_id** | **int** | The unique ID of the Ezsigntemplateelementdependency | [optional] diff --git a/docs/EzsigntemplateelementdependencyRequestCompound.md b/docs/EzsigntemplateelementdependencyRequestCompound.md index 6aa9e5231..29e3f0690 100644 --- a/docs/EzsigntemplateelementdependencyRequestCompound.md +++ b/docs/EzsigntemplateelementdependencyRequestCompound.md @@ -3,6 +3,7 @@ An Ezsigntemplateelementdependency Object and children to create a complete structure ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsigntemplateelementdependency_id** | **int** | The unique ID of the Ezsigntemplateelementdependency | [optional] diff --git a/docs/EzsigntemplateelementdependencyResponse.md b/docs/EzsigntemplateelementdependencyResponse.md index 72f5b08a8..e59676002 100644 --- a/docs/EzsigntemplateelementdependencyResponse.md +++ b/docs/EzsigntemplateelementdependencyResponse.md @@ -3,6 +3,7 @@ An Ezsigntemplateelementdependency Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsigntemplateelementdependency_id** | **int** | The unique ID of the Ezsigntemplateelementdependency | diff --git a/docs/EzsigntemplateelementdependencyResponseCompound.md b/docs/EzsigntemplateelementdependencyResponseCompound.md index bdcd6f035..91295e270 100644 --- a/docs/EzsigntemplateelementdependencyResponseCompound.md +++ b/docs/EzsigntemplateelementdependencyResponseCompound.md @@ -3,6 +3,7 @@ An Ezsigntemplateelementdependency Object and children to create a complete structure ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsigntemplateelementdependency_id** | **int** | The unique ID of the Ezsigntemplateelementdependency | diff --git a/docs/EzsigntemplateformfieldRequest.md b/docs/EzsigntemplateformfieldRequest.md index 671eeb9fb..01a526c4f 100644 --- a/docs/EzsigntemplateformfieldRequest.md +++ b/docs/EzsigntemplateformfieldRequest.md @@ -3,6 +3,7 @@ A Ezsigntemplateformfield Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsigntemplateformfield_id** | **int** | The unique ID of the Ezsigntemplateformfield | [optional] diff --git a/docs/EzsigntemplateformfieldRequestCompound.md b/docs/EzsigntemplateformfieldRequestCompound.md index 68de691e6..7804f231b 100644 --- a/docs/EzsigntemplateformfieldRequestCompound.md +++ b/docs/EzsigntemplateformfieldRequestCompound.md @@ -3,6 +3,7 @@ An Ezsigntemplateformfield Object and children to create a complete structure ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsigntemplateformfield_id** | **int** | The unique ID of the Ezsigntemplateformfield | [optional] diff --git a/docs/EzsigntemplateformfieldResponse.md b/docs/EzsigntemplateformfieldResponse.md index de369ee7b..3852207f4 100644 --- a/docs/EzsigntemplateformfieldResponse.md +++ b/docs/EzsigntemplateformfieldResponse.md @@ -3,6 +3,7 @@ An Ezsigntemplateformfield Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsigntemplateformfield_id** | **int** | The unique ID of the Ezsigntemplateformfield | diff --git a/docs/EzsigntemplateformfieldResponseCompound.md b/docs/EzsigntemplateformfieldResponseCompound.md index b3a665442..329b36ac5 100644 --- a/docs/EzsigntemplateformfieldResponseCompound.md +++ b/docs/EzsigntemplateformfieldResponseCompound.md @@ -3,6 +3,7 @@ An Ezsigntemplateformfield Object and children ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsigntemplateformfield_id** | **int** | The unique ID of the Ezsigntemplateformfield | diff --git a/docs/EzsigntemplateformfieldgroupCreateObjectV1Request.md b/docs/EzsigntemplateformfieldgroupCreateObjectV1Request.md index d2d82cc1b..9444178bb 100644 --- a/docs/EzsigntemplateformfieldgroupCreateObjectV1Request.md +++ b/docs/EzsigntemplateformfieldgroupCreateObjectV1Request.md @@ -3,6 +3,7 @@ Request for POST /1/object/ezsigntemplateformfieldgroup ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_ezsigntemplateformfieldgroup** | [**List[EzsigntemplateformfieldgroupRequestCompound]**](EzsigntemplateformfieldgroupRequestCompound.md) | | diff --git a/docs/EzsigntemplateformfieldgroupCreateObjectV1Response.md b/docs/EzsigntemplateformfieldgroupCreateObjectV1Response.md index 116820007..e0f8145cd 100644 --- a/docs/EzsigntemplateformfieldgroupCreateObjectV1Response.md +++ b/docs/EzsigntemplateformfieldgroupCreateObjectV1Response.md @@ -3,6 +3,7 @@ Response for POST /1/object/ezsigntemplateformfieldgroup ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsigntemplateformfieldgroupCreateObjectV1ResponseMPayload.md b/docs/EzsigntemplateformfieldgroupCreateObjectV1ResponseMPayload.md index 69eaad289..d4224f1a5 100644 --- a/docs/EzsigntemplateformfieldgroupCreateObjectV1ResponseMPayload.md +++ b/docs/EzsigntemplateformfieldgroupCreateObjectV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for POST /1/object/ezsigntemplateformfieldgroup ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_pki_ezsigntemplateformfieldgroup_id** | **List[int]** | An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request. | diff --git a/docs/EzsigntemplateformfieldgroupDeleteObjectV1Response.md b/docs/EzsigntemplateformfieldgroupDeleteObjectV1Response.md index 0f12df1fa..fa8e04f1e 100644 --- a/docs/EzsigntemplateformfieldgroupDeleteObjectV1Response.md +++ b/docs/EzsigntemplateformfieldgroupDeleteObjectV1Response.md @@ -3,6 +3,7 @@ Response for DELETE /1/object/ezsigntemplateformfieldgroup/{pkiEzsigntemplateformfieldgroupID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsigntemplateformfieldgroupEditObjectV1Request.md b/docs/EzsigntemplateformfieldgroupEditObjectV1Request.md index b5c28423f..a4356d3e3 100644 --- a/docs/EzsigntemplateformfieldgroupEditObjectV1Request.md +++ b/docs/EzsigntemplateformfieldgroupEditObjectV1Request.md @@ -3,6 +3,7 @@ Request for PUT /1/object/ezsigntemplateformfieldgroup/{pkiEzsigntemplateformfieldgroupID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_ezsigntemplateformfieldgroup** | [**EzsigntemplateformfieldgroupRequestCompound**](EzsigntemplateformfieldgroupRequestCompound.md) | | diff --git a/docs/EzsigntemplateformfieldgroupEditObjectV1Response.md b/docs/EzsigntemplateformfieldgroupEditObjectV1Response.md index 1c41de04f..ea2129468 100644 --- a/docs/EzsigntemplateformfieldgroupEditObjectV1Response.md +++ b/docs/EzsigntemplateformfieldgroupEditObjectV1Response.md @@ -3,6 +3,7 @@ Response for PUT /1/object/ezsigntemplateformfieldgroup/{pkiEzsigntemplateformfieldgroupID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsigntemplateformfieldgroupGetObjectV2Response.md b/docs/EzsigntemplateformfieldgroupGetObjectV2Response.md index 7ae5017a9..9a0e9680b 100644 --- a/docs/EzsigntemplateformfieldgroupGetObjectV2Response.md +++ b/docs/EzsigntemplateformfieldgroupGetObjectV2Response.md @@ -3,6 +3,7 @@ Response for GET /2/object/ezsigntemplateformfieldgroup/{pkiEzsigntemplateformfieldgroupID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsigntemplateformfieldgroupGetObjectV2ResponseMPayload.md b/docs/EzsigntemplateformfieldgroupGetObjectV2ResponseMPayload.md index 0ed984e2d..3ac798df4 100644 --- a/docs/EzsigntemplateformfieldgroupGetObjectV2ResponseMPayload.md +++ b/docs/EzsigntemplateformfieldgroupGetObjectV2ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for GET /2/object/ezsigntemplateformfieldgroup/{pkiEzsigntemplateformfieldgroupID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_ezsigntemplateformfieldgroup** | [**EzsigntemplateformfieldgroupResponseCompound**](EzsigntemplateformfieldgroupResponseCompound.md) | | diff --git a/docs/EzsigntemplateformfieldgroupRequest.md b/docs/EzsigntemplateformfieldgroupRequest.md index c1609f1ff..640090c73 100644 --- a/docs/EzsigntemplateformfieldgroupRequest.md +++ b/docs/EzsigntemplateformfieldgroupRequest.md @@ -3,6 +3,7 @@ A Ezsigntemplateformfieldgroup Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsigntemplateformfieldgroup_id** | **int** | The unique ID of the Ezsigntemplateformfieldgroup | [optional] diff --git a/docs/EzsigntemplateformfieldgroupRequestCompound.md b/docs/EzsigntemplateformfieldgroupRequestCompound.md index 0b475a150..9249fb678 100644 --- a/docs/EzsigntemplateformfieldgroupRequestCompound.md +++ b/docs/EzsigntemplateformfieldgroupRequestCompound.md @@ -3,6 +3,7 @@ A Ezsigntemplateformfieldgroup Object and children ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsigntemplateformfieldgroup_id** | **int** | The unique ID of the Ezsigntemplateformfieldgroup | [optional] diff --git a/docs/EzsigntemplateformfieldgroupResponse.md b/docs/EzsigntemplateformfieldgroupResponse.md index 86d4b4253..be9e7dd9a 100644 --- a/docs/EzsigntemplateformfieldgroupResponse.md +++ b/docs/EzsigntemplateformfieldgroupResponse.md @@ -3,6 +3,7 @@ A Ezsigntemplateformfieldgroup Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsigntemplateformfieldgroup_id** | **int** | The unique ID of the Ezsigntemplateformfieldgroup | diff --git a/docs/EzsigntemplateformfieldgroupResponseCompound.md b/docs/EzsigntemplateformfieldgroupResponseCompound.md index e6e5c2818..24aa9d689 100644 --- a/docs/EzsigntemplateformfieldgroupResponseCompound.md +++ b/docs/EzsigntemplateformfieldgroupResponseCompound.md @@ -3,6 +3,7 @@ A Ezsigntemplateformfieldgroup Object and children ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsigntemplateformfieldgroup_id** | **int** | The unique ID of the Ezsigntemplateformfieldgroup | diff --git a/docs/EzsigntemplateformfieldgroupsignerRequest.md b/docs/EzsigntemplateformfieldgroupsignerRequest.md index 40ee551c9..bcbccaf92 100644 --- a/docs/EzsigntemplateformfieldgroupsignerRequest.md +++ b/docs/EzsigntemplateformfieldgroupsignerRequest.md @@ -3,6 +3,7 @@ A Ezsigntemplateformfieldgroupsigner Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsigntemplateformfieldgroupsigner_id** | **int** | The unique ID of the Ezsigntemplateformfieldgroupsigner | [optional] diff --git a/docs/EzsigntemplateformfieldgroupsignerRequestCompound.md b/docs/EzsigntemplateformfieldgroupsignerRequestCompound.md index 9bc4e40cf..7074d10d9 100644 --- a/docs/EzsigntemplateformfieldgroupsignerRequestCompound.md +++ b/docs/EzsigntemplateformfieldgroupsignerRequestCompound.md @@ -3,6 +3,7 @@ An Ezsigntemplateformfieldgroupsigner Object and children to create a complete structure ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsigntemplateformfieldgroupsigner_id** | **int** | The unique ID of the Ezsigntemplateformfieldgroupsigner | [optional] diff --git a/docs/EzsigntemplateformfieldgroupsignerResponse.md b/docs/EzsigntemplateformfieldgroupsignerResponse.md index 86403cc60..ee56b7f1b 100644 --- a/docs/EzsigntemplateformfieldgroupsignerResponse.md +++ b/docs/EzsigntemplateformfieldgroupsignerResponse.md @@ -3,6 +3,7 @@ A Ezsigntemplateformfieldgroupsigner Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsigntemplateformfieldgroupsigner_id** | **int** | The unique ID of the Ezsigntemplateformfieldgroupsigner | diff --git a/docs/EzsigntemplateformfieldgroupsignerResponseCompound.md b/docs/EzsigntemplateformfieldgroupsignerResponseCompound.md index 9dbe81a02..92399e1b0 100644 --- a/docs/EzsigntemplateformfieldgroupsignerResponseCompound.md +++ b/docs/EzsigntemplateformfieldgroupsignerResponseCompound.md @@ -3,6 +3,7 @@ An Ezsigntemplateformfieldgroupsigner Object and children ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsigntemplateformfieldgroupsigner_id** | **int** | The unique ID of the Ezsigntemplateformfieldgroupsigner | diff --git a/docs/EzsigntemplatepackageAutocompleteElementResponse.md b/docs/EzsigntemplatepackageAutocompleteElementResponse.md index 7ad64dc51..c3ada0098 100644 --- a/docs/EzsigntemplatepackageAutocompleteElementResponse.md +++ b/docs/EzsigntemplatepackageAutocompleteElementResponse.md @@ -3,6 +3,7 @@ A Ezsigntemplatepackage AutocompleteElement Response ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **e_ezsignfoldertype_privacylevel** | [**FieldEEzsignfoldertypePrivacylevel**](FieldEEzsignfoldertypePrivacylevel.md) | | diff --git a/docs/EzsigntemplatepackageCreateObjectV1Request.md b/docs/EzsigntemplatepackageCreateObjectV1Request.md index eaafbd857..3028ecb9a 100644 --- a/docs/EzsigntemplatepackageCreateObjectV1Request.md +++ b/docs/EzsigntemplatepackageCreateObjectV1Request.md @@ -3,6 +3,7 @@ Request for POST /1/object/ezsigntemplatepackage ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_ezsigntemplatepackage** | [**List[EzsigntemplatepackageRequestCompound]**](EzsigntemplatepackageRequestCompound.md) | | diff --git a/docs/EzsigntemplatepackageCreateObjectV1Response.md b/docs/EzsigntemplatepackageCreateObjectV1Response.md index 7b761f99a..3ebad922f 100644 --- a/docs/EzsigntemplatepackageCreateObjectV1Response.md +++ b/docs/EzsigntemplatepackageCreateObjectV1Response.md @@ -3,6 +3,7 @@ Response for POST /1/object/ezsigntemplatepackage ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsigntemplatepackageCreateObjectV1ResponseMPayload.md b/docs/EzsigntemplatepackageCreateObjectV1ResponseMPayload.md index 11e7c3ac2..a6c341c7b 100644 --- a/docs/EzsigntemplatepackageCreateObjectV1ResponseMPayload.md +++ b/docs/EzsigntemplatepackageCreateObjectV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for POST /1/object/ezsigntemplatepackage ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_pki_ezsigntemplatepackage_id** | **List[int]** | An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request. | diff --git a/docs/EzsigntemplatepackageDeleteObjectV1Response.md b/docs/EzsigntemplatepackageDeleteObjectV1Response.md index 743c27b4f..7c010919d 100644 --- a/docs/EzsigntemplatepackageDeleteObjectV1Response.md +++ b/docs/EzsigntemplatepackageDeleteObjectV1Response.md @@ -3,6 +3,7 @@ Response for DELETE /1/object/ezsigntemplatepackage/{pkiEzsigntemplatepackageID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsigntemplatepackageEditEzsigntemplatepackagesignersV1Request.md b/docs/EzsigntemplatepackageEditEzsigntemplatepackagesignersV1Request.md index 0ea863c0e..bff1cd22a 100644 --- a/docs/EzsigntemplatepackageEditEzsigntemplatepackagesignersV1Request.md +++ b/docs/EzsigntemplatepackageEditEzsigntemplatepackagesignersV1Request.md @@ -3,6 +3,7 @@ Request for PUT /1/object/ezsigntemplatepackage/{pkiEzsigntemplatepackageID}/editEzsigntemplatepackagesigners ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_ezsigntemplatepackagesigner** | [**List[EzsigntemplatepackagesignerRequestCompound]**](EzsigntemplatepackagesignerRequestCompound.md) | | diff --git a/docs/EzsigntemplatepackageEditEzsigntemplatepackagesignersV1Response.md b/docs/EzsigntemplatepackageEditEzsigntemplatepackagesignersV1Response.md index 1fbe85801..03f7b0866 100644 --- a/docs/EzsigntemplatepackageEditEzsigntemplatepackagesignersV1Response.md +++ b/docs/EzsigntemplatepackageEditEzsigntemplatepackagesignersV1Response.md @@ -3,6 +3,7 @@ Response for PUT /1/object/ezsigntemplatepackage/{pkiEzsigntemplatepackageID}/editEzsigntemplatepackagesigners ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsigntemplatepackageEditEzsigntemplatepackagesignersV1ResponseMPayload.md b/docs/EzsigntemplatepackageEditEzsigntemplatepackagesignersV1ResponseMPayload.md index 09d826ee7..30fffdb95 100644 --- a/docs/EzsigntemplatepackageEditEzsigntemplatepackagesignersV1ResponseMPayload.md +++ b/docs/EzsigntemplatepackageEditEzsigntemplatepackagesignersV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for PUT /1/object/ezsigntemplatepackage/{pkiEzsigntemplatepackageID}/editEzsigntemplatepackagesigners ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_pki_ezsigntemplatepackagesigner_id** | **List[int]** | | diff --git a/docs/EzsigntemplatepackageEditObjectV1Request.md b/docs/EzsigntemplatepackageEditObjectV1Request.md index 7f174ae21..ffe435bfc 100644 --- a/docs/EzsigntemplatepackageEditObjectV1Request.md +++ b/docs/EzsigntemplatepackageEditObjectV1Request.md @@ -3,6 +3,7 @@ Request for PUT /1/object/ezsigntemplatepackage/{pkiEzsigntemplatepackageID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_ezsigntemplatepackage** | [**EzsigntemplatepackageRequestCompound**](EzsigntemplatepackageRequestCompound.md) | | diff --git a/docs/EzsigntemplatepackageEditObjectV1Response.md b/docs/EzsigntemplatepackageEditObjectV1Response.md index 837a1bc48..98931d12d 100644 --- a/docs/EzsigntemplatepackageEditObjectV1Response.md +++ b/docs/EzsigntemplatepackageEditObjectV1Response.md @@ -3,6 +3,7 @@ Response for PUT /1/object/ezsigntemplatepackage/{pkiEzsigntemplatepackageID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsigntemplatepackageGetAutocompleteV2Response.md b/docs/EzsigntemplatepackageGetAutocompleteV2Response.md index b64914762..cdffca407 100644 --- a/docs/EzsigntemplatepackageGetAutocompleteV2Response.md +++ b/docs/EzsigntemplatepackageGetAutocompleteV2Response.md @@ -3,6 +3,7 @@ Response for GET /2/object/ezsigntemplatepackage/getAutocomplete ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsigntemplatepackageGetAutocompleteV2ResponseMPayload.md b/docs/EzsigntemplatepackageGetAutocompleteV2ResponseMPayload.md index 7c5533435..2926e8e37 100644 --- a/docs/EzsigntemplatepackageGetAutocompleteV2ResponseMPayload.md +++ b/docs/EzsigntemplatepackageGetAutocompleteV2ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for POST /2/object/ezsigntemplatepackage/getAutocomplete ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_ezsigntemplatepackage** | [**List[EzsigntemplatepackageAutocompleteElementResponse]**](EzsigntemplatepackageAutocompleteElementResponse.md) | An array of Ezsigntemplatepackage autocomplete element response. | diff --git a/docs/EzsigntemplatepackageGetListV1Response.md b/docs/EzsigntemplatepackageGetListV1Response.md index ca17bc974..4a9131368 100644 --- a/docs/EzsigntemplatepackageGetListV1Response.md +++ b/docs/EzsigntemplatepackageGetListV1Response.md @@ -3,6 +3,7 @@ Response for GET /1/object/ezsigntemplatepackage/getList ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayloadGetList**](CommonResponseObjDebugPayloadGetList.md) | | diff --git a/docs/EzsigntemplatepackageGetListV1ResponseMPayload.md b/docs/EzsigntemplatepackageGetListV1ResponseMPayload.md index d8c953299..9833fb9ba 100644 --- a/docs/EzsigntemplatepackageGetListV1ResponseMPayload.md +++ b/docs/EzsigntemplatepackageGetListV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for GET /1/object/ezsigntemplatepackage/getList ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **i_row_returned** | **int** | The number of rows returned | diff --git a/docs/EzsigntemplatepackageGetObjectV2Response.md b/docs/EzsigntemplatepackageGetObjectV2Response.md index 3830b750e..2e742d189 100644 --- a/docs/EzsigntemplatepackageGetObjectV2Response.md +++ b/docs/EzsigntemplatepackageGetObjectV2Response.md @@ -3,6 +3,7 @@ Response for GET /2/object/ezsigntemplatepackage/{pkiEzsigntemplatepackageID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsigntemplatepackageGetObjectV2ResponseMPayload.md b/docs/EzsigntemplatepackageGetObjectV2ResponseMPayload.md index 6ccee6696..caca8ed91 100644 --- a/docs/EzsigntemplatepackageGetObjectV2ResponseMPayload.md +++ b/docs/EzsigntemplatepackageGetObjectV2ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for GET /2/object/ezsigntemplatepackage/{pkiEzsigntemplatepackageID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_ezsigntemplatepackage** | [**EzsigntemplatepackageResponseCompound**](EzsigntemplatepackageResponseCompound.md) | | diff --git a/docs/EzsigntemplatepackageListElement.md b/docs/EzsigntemplatepackageListElement.md index fc10241f5..1a936d3a2 100644 --- a/docs/EzsigntemplatepackageListElement.md +++ b/docs/EzsigntemplatepackageListElement.md @@ -3,6 +3,7 @@ An Ezsigntemplatepackage List Element ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsigntemplatepackage_id** | **int** | The unique ID of the Ezsigntemplatepackage | diff --git a/docs/EzsigntemplatepackageRequest.md b/docs/EzsigntemplatepackageRequest.md index 7649fbf54..93f547b04 100644 --- a/docs/EzsigntemplatepackageRequest.md +++ b/docs/EzsigntemplatepackageRequest.md @@ -3,6 +3,7 @@ A Ezsigntemplatepackage Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsigntemplatepackage_id** | **int** | The unique ID of the Ezsigntemplatepackage | [optional] diff --git a/docs/EzsigntemplatepackageRequestCompound.md b/docs/EzsigntemplatepackageRequestCompound.md index 2e0ca8fb6..c4da9cfae 100644 --- a/docs/EzsigntemplatepackageRequestCompound.md +++ b/docs/EzsigntemplatepackageRequestCompound.md @@ -3,6 +3,7 @@ A Ezsigntemplatepackage Object and children ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsigntemplatepackage_id** | **int** | The unique ID of the Ezsigntemplatepackage | [optional] diff --git a/docs/EzsigntemplatepackageResponse.md b/docs/EzsigntemplatepackageResponse.md index b9f593304..c25420ffa 100644 --- a/docs/EzsigntemplatepackageResponse.md +++ b/docs/EzsigntemplatepackageResponse.md @@ -3,6 +3,7 @@ A Ezsigntemplatepackage Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsigntemplatepackage_id** | **int** | The unique ID of the Ezsigntemplatepackage | diff --git a/docs/EzsigntemplatepackageResponseCompound.md b/docs/EzsigntemplatepackageResponseCompound.md index b6c815a1c..de2b3803f 100644 --- a/docs/EzsigntemplatepackageResponseCompound.md +++ b/docs/EzsigntemplatepackageResponseCompound.md @@ -3,6 +3,7 @@ A Ezsigntemplatepackage Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsigntemplatepackage_id** | **int** | The unique ID of the Ezsigntemplatepackage | diff --git a/docs/EzsigntemplatepackagemembershipCreateObjectV1Request.md b/docs/EzsigntemplatepackagemembershipCreateObjectV1Request.md index 4b2f2012e..d196d6158 100644 --- a/docs/EzsigntemplatepackagemembershipCreateObjectV1Request.md +++ b/docs/EzsigntemplatepackagemembershipCreateObjectV1Request.md @@ -3,6 +3,7 @@ Request for POST /1/object/ezsigntemplatepackagemembership ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_ezsigntemplatepackagemembership** | [**List[EzsigntemplatepackagemembershipRequestCompound]**](EzsigntemplatepackagemembershipRequestCompound.md) | | diff --git a/docs/EzsigntemplatepackagemembershipCreateObjectV1Response.md b/docs/EzsigntemplatepackagemembershipCreateObjectV1Response.md index 19569c82c..6f87f3a97 100644 --- a/docs/EzsigntemplatepackagemembershipCreateObjectV1Response.md +++ b/docs/EzsigntemplatepackagemembershipCreateObjectV1Response.md @@ -3,6 +3,7 @@ Response for POST /1/object/ezsigntemplatepackagemembership ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsigntemplatepackagemembershipCreateObjectV1ResponseMPayload.md b/docs/EzsigntemplatepackagemembershipCreateObjectV1ResponseMPayload.md index 4ce1bf496..7424fc609 100644 --- a/docs/EzsigntemplatepackagemembershipCreateObjectV1ResponseMPayload.md +++ b/docs/EzsigntemplatepackagemembershipCreateObjectV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for POST /1/object/ezsigntemplatepackagemembership ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_pki_ezsigntemplatepackagemembership_id** | **List[int]** | An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request. | diff --git a/docs/EzsigntemplatepackagemembershipDeleteObjectV1Response.md b/docs/EzsigntemplatepackagemembershipDeleteObjectV1Response.md index 764ee582a..66aff370d 100644 --- a/docs/EzsigntemplatepackagemembershipDeleteObjectV1Response.md +++ b/docs/EzsigntemplatepackagemembershipDeleteObjectV1Response.md @@ -3,6 +3,7 @@ Response for DELETE /1/object/ezsigntemplatepackagemembership/{pkiEzsigntemplatepackagemembershipID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsigntemplatepackagemembershipGetObjectV2Response.md b/docs/EzsigntemplatepackagemembershipGetObjectV2Response.md index e0e043d8e..f2794b8a9 100644 --- a/docs/EzsigntemplatepackagemembershipGetObjectV2Response.md +++ b/docs/EzsigntemplatepackagemembershipGetObjectV2Response.md @@ -3,6 +3,7 @@ Response for GET /2/object/ezsigntemplatepackagemembership/{pkiEzsigntemplatepackagemembershipID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsigntemplatepackagemembershipGetObjectV2ResponseMPayload.md b/docs/EzsigntemplatepackagemembershipGetObjectV2ResponseMPayload.md index e2cfb0b3b..1653f1a11 100644 --- a/docs/EzsigntemplatepackagemembershipGetObjectV2ResponseMPayload.md +++ b/docs/EzsigntemplatepackagemembershipGetObjectV2ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for GET /2/object/ezsigntemplatepackagemembership/{pkiEzsigntemplatepackagemembershipID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_ezsigntemplatepackagemembership** | [**EzsigntemplatepackagemembershipResponseCompound**](EzsigntemplatepackagemembershipResponseCompound.md) | | diff --git a/docs/EzsigntemplatepackagemembershipRequest.md b/docs/EzsigntemplatepackagemembershipRequest.md index ac14bc947..f9681a991 100644 --- a/docs/EzsigntemplatepackagemembershipRequest.md +++ b/docs/EzsigntemplatepackagemembershipRequest.md @@ -3,6 +3,7 @@ A Ezsigntemplatepackagemembership Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsigntemplatepackagemembership_id** | **int** | The unique ID of the Ezsigntemplatepackagemembership | [optional] diff --git a/docs/EzsigntemplatepackagemembershipRequestCompound.md b/docs/EzsigntemplatepackagemembershipRequestCompound.md index c372e94ff..ff1e413ff 100644 --- a/docs/EzsigntemplatepackagemembershipRequestCompound.md +++ b/docs/EzsigntemplatepackagemembershipRequestCompound.md @@ -3,6 +3,7 @@ A Ezsigntemplatepackagemembership Object and children ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsigntemplatepackagemembership_id** | **int** | The unique ID of the Ezsigntemplatepackagemembership | [optional] diff --git a/docs/EzsigntemplatepackagemembershipResponse.md b/docs/EzsigntemplatepackagemembershipResponse.md index 4f51749e2..27d8f6619 100644 --- a/docs/EzsigntemplatepackagemembershipResponse.md +++ b/docs/EzsigntemplatepackagemembershipResponse.md @@ -3,6 +3,7 @@ A Ezsigntemplatepackagemembership Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsigntemplatepackagemembership_id** | **int** | The unique ID of the Ezsigntemplatepackagemembership | diff --git a/docs/EzsigntemplatepackagemembershipResponseCompound.md b/docs/EzsigntemplatepackagemembershipResponseCompound.md index 5a534f2ff..369b6f221 100644 --- a/docs/EzsigntemplatepackagemembershipResponseCompound.md +++ b/docs/EzsigntemplatepackagemembershipResponseCompound.md @@ -3,6 +3,7 @@ A Ezsigntemplatepackagemembership Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsigntemplatepackagemembership_id** | **int** | The unique ID of the Ezsigntemplatepackagemembership | diff --git a/docs/EzsigntemplatepackagesignerCreateObjectV1Request.md b/docs/EzsigntemplatepackagesignerCreateObjectV1Request.md index 8cacc6cfd..60dc3b270 100644 --- a/docs/EzsigntemplatepackagesignerCreateObjectV1Request.md +++ b/docs/EzsigntemplatepackagesignerCreateObjectV1Request.md @@ -3,6 +3,7 @@ Request for POST /1/object/ezsigntemplatepackagesigner ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_ezsigntemplatepackagesigner** | [**List[EzsigntemplatepackagesignerRequestCompound]**](EzsigntemplatepackagesignerRequestCompound.md) | | diff --git a/docs/EzsigntemplatepackagesignerCreateObjectV1Response.md b/docs/EzsigntemplatepackagesignerCreateObjectV1Response.md index afcd2f691..b7e196f0a 100644 --- a/docs/EzsigntemplatepackagesignerCreateObjectV1Response.md +++ b/docs/EzsigntemplatepackagesignerCreateObjectV1Response.md @@ -3,6 +3,7 @@ Response for POST /1/object/ezsigntemplatepackagesigner ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsigntemplatepackagesignerCreateObjectV1ResponseMPayload.md b/docs/EzsigntemplatepackagesignerCreateObjectV1ResponseMPayload.md index c7f814a91..2a742dbd9 100644 --- a/docs/EzsigntemplatepackagesignerCreateObjectV1ResponseMPayload.md +++ b/docs/EzsigntemplatepackagesignerCreateObjectV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for POST /1/object/ezsigntemplatepackagesigner ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_pki_ezsigntemplatepackagesigner_id** | **List[int]** | An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request. | diff --git a/docs/EzsigntemplatepackagesignerDeleteObjectV1Response.md b/docs/EzsigntemplatepackagesignerDeleteObjectV1Response.md index 07381f8c8..2218d9e59 100644 --- a/docs/EzsigntemplatepackagesignerDeleteObjectV1Response.md +++ b/docs/EzsigntemplatepackagesignerDeleteObjectV1Response.md @@ -3,6 +3,7 @@ Response for DELETE /1/object/ezsigntemplatepackagesigner/{pkiEzsigntemplatepackagesignerID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsigntemplatepackagesignerDeleteObjectV1ResponseMPayload.md b/docs/EzsigntemplatepackagesignerDeleteObjectV1ResponseMPayload.md index 3e51ab121..9d088def3 100644 --- a/docs/EzsigntemplatepackagesignerDeleteObjectV1ResponseMPayload.md +++ b/docs/EzsigntemplatepackagesignerDeleteObjectV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for DELETE /1/object/ezsigntemplatepackagesigner/{pkiEzsigntemplatepackagesignerID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **b_ezsigntemplatepackage_needvalidation** | **bool** | Whether the Ezsignbulksend was automatically modified and needs a manual validation | diff --git a/docs/EzsigntemplatepackagesignerEditObjectV1Request.md b/docs/EzsigntemplatepackagesignerEditObjectV1Request.md index 3fab7cfb9..00f2dce52 100644 --- a/docs/EzsigntemplatepackagesignerEditObjectV1Request.md +++ b/docs/EzsigntemplatepackagesignerEditObjectV1Request.md @@ -3,6 +3,7 @@ Request for PUT /1/object/ezsigntemplatepackagesigner/{pkiEzsigntemplatepackagesignerID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_ezsigntemplatepackagesigner** | [**EzsigntemplatepackagesignerRequestCompound**](EzsigntemplatepackagesignerRequestCompound.md) | | diff --git a/docs/EzsigntemplatepackagesignerEditObjectV1Response.md b/docs/EzsigntemplatepackagesignerEditObjectV1Response.md index cce22dd49..a4ea175c5 100644 --- a/docs/EzsigntemplatepackagesignerEditObjectV1Response.md +++ b/docs/EzsigntemplatepackagesignerEditObjectV1Response.md @@ -3,6 +3,7 @@ Response for PUT /1/object/ezsigntemplatepackagesigner/{pkiEzsigntemplatepackagesignerID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsigntemplatepackagesignerGetObjectV2Response.md b/docs/EzsigntemplatepackagesignerGetObjectV2Response.md index 1110d492c..763869fd1 100644 --- a/docs/EzsigntemplatepackagesignerGetObjectV2Response.md +++ b/docs/EzsigntemplatepackagesignerGetObjectV2Response.md @@ -3,6 +3,7 @@ Response for GET /2/object/ezsigntemplatepackagesigner/{pkiEzsigntemplatepackagesignerID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsigntemplatepackagesignerGetObjectV2ResponseMPayload.md b/docs/EzsigntemplatepackagesignerGetObjectV2ResponseMPayload.md index 3b0d7251a..965ab675b 100644 --- a/docs/EzsigntemplatepackagesignerGetObjectV2ResponseMPayload.md +++ b/docs/EzsigntemplatepackagesignerGetObjectV2ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for GET /2/object/ezsigntemplatepackagesigner/{pkiEzsigntemplatepackagesignerID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_ezsigntemplatepackagesigner** | [**EzsigntemplatepackagesignerResponseCompound**](EzsigntemplatepackagesignerResponseCompound.md) | | diff --git a/docs/EzsigntemplatepackagesignerRequest.md b/docs/EzsigntemplatepackagesignerRequest.md index 79fbd9a4f..f9893e184 100644 --- a/docs/EzsigntemplatepackagesignerRequest.md +++ b/docs/EzsigntemplatepackagesignerRequest.md @@ -3,6 +3,7 @@ A Ezsigntemplatepackagesigner Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsigntemplatepackagesigner_id** | **int** | The unique ID of the Ezsigntemplatepackagesigner | [optional] diff --git a/docs/EzsigntemplatepackagesignerRequestCompound.md b/docs/EzsigntemplatepackagesignerRequestCompound.md index ff86a619c..dfcec995a 100644 --- a/docs/EzsigntemplatepackagesignerRequestCompound.md +++ b/docs/EzsigntemplatepackagesignerRequestCompound.md @@ -3,6 +3,7 @@ A Ezsigntemplatepackagesigner Object and children ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsigntemplatepackagesigner_id** | **int** | The unique ID of the Ezsigntemplatepackagesigner | [optional] diff --git a/docs/EzsigntemplatepackagesignerResponse.md b/docs/EzsigntemplatepackagesignerResponse.md index 394cd8ab7..461c7b174 100644 --- a/docs/EzsigntemplatepackagesignerResponse.md +++ b/docs/EzsigntemplatepackagesignerResponse.md @@ -3,6 +3,7 @@ A Ezsigntemplatepackagesigner Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsigntemplatepackagesigner_id** | **int** | The unique ID of the Ezsigntemplatepackagesigner | diff --git a/docs/EzsigntemplatepackagesignerResponseCompound.md b/docs/EzsigntemplatepackagesignerResponseCompound.md index c69a9fcf2..14ac3a82a 100644 --- a/docs/EzsigntemplatepackagesignerResponseCompound.md +++ b/docs/EzsigntemplatepackagesignerResponseCompound.md @@ -3,6 +3,7 @@ A Ezsigntemplatepackagesigner Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsigntemplatepackagesigner_id** | **int** | The unique ID of the Ezsigntemplatepackagesigner | diff --git a/docs/EzsigntemplatepackagesignermembershipCreateObjectV1Request.md b/docs/EzsigntemplatepackagesignermembershipCreateObjectV1Request.md index b27ca9736..2f4dfaa39 100644 --- a/docs/EzsigntemplatepackagesignermembershipCreateObjectV1Request.md +++ b/docs/EzsigntemplatepackagesignermembershipCreateObjectV1Request.md @@ -3,6 +3,7 @@ Request for POST /1/object/ezsigntemplatepackagesignermembership ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_ezsigntemplatepackagesignermembership** | [**List[EzsigntemplatepackagesignermembershipRequestCompound]**](EzsigntemplatepackagesignermembershipRequestCompound.md) | | diff --git a/docs/EzsigntemplatepackagesignermembershipCreateObjectV1Response.md b/docs/EzsigntemplatepackagesignermembershipCreateObjectV1Response.md index deba72366..30a521d7d 100644 --- a/docs/EzsigntemplatepackagesignermembershipCreateObjectV1Response.md +++ b/docs/EzsigntemplatepackagesignermembershipCreateObjectV1Response.md @@ -3,6 +3,7 @@ Response for POST /1/object/ezsigntemplatepackagesignermembership ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsigntemplatepackagesignermembershipCreateObjectV1ResponseMPayload.md b/docs/EzsigntemplatepackagesignermembershipCreateObjectV1ResponseMPayload.md index 04d6a1afb..af68a08f0 100644 --- a/docs/EzsigntemplatepackagesignermembershipCreateObjectV1ResponseMPayload.md +++ b/docs/EzsigntemplatepackagesignermembershipCreateObjectV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for POST /1/object/ezsigntemplatepackagesignermembership ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_pki_ezsigntemplatepackagesignermembership_id** | **List[int]** | An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request. | diff --git a/docs/EzsigntemplatepackagesignermembershipDeleteObjectV1Response.md b/docs/EzsigntemplatepackagesignermembershipDeleteObjectV1Response.md index fd2aa8ed9..76102f732 100644 --- a/docs/EzsigntemplatepackagesignermembershipDeleteObjectV1Response.md +++ b/docs/EzsigntemplatepackagesignermembershipDeleteObjectV1Response.md @@ -3,6 +3,7 @@ Response for DELETE /1/object/ezsigntemplatepackagesignermembership/{pkiEzsigntemplatepackagesignermembershipID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsigntemplatepackagesignermembershipDeleteObjectV1ResponseMPayload.md b/docs/EzsigntemplatepackagesignermembershipDeleteObjectV1ResponseMPayload.md index 37f597bd4..6e7182025 100644 --- a/docs/EzsigntemplatepackagesignermembershipDeleteObjectV1ResponseMPayload.md +++ b/docs/EzsigntemplatepackagesignermembershipDeleteObjectV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for DELETE /1/object/ezsigntemplatepackagesignermembership/{pkiEzsigntemplatepackagesignermembershipID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **b_ezsigntemplatepackage_needvalidation** | **bool** | Whether the Ezsignbulksend was automatically modified and needs a manual validation | diff --git a/docs/EzsigntemplatepackagesignermembershipGetObjectV2Response.md b/docs/EzsigntemplatepackagesignermembershipGetObjectV2Response.md index 11b0c7138..90808e99a 100644 --- a/docs/EzsigntemplatepackagesignermembershipGetObjectV2Response.md +++ b/docs/EzsigntemplatepackagesignermembershipGetObjectV2Response.md @@ -3,6 +3,7 @@ Response for GET /2/object/ezsigntemplatepackagesignermembership/{pkiEzsigntemplatepackagesignermembershipID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsigntemplatepackagesignermembershipGetObjectV2ResponseMPayload.md b/docs/EzsigntemplatepackagesignermembershipGetObjectV2ResponseMPayload.md index b371e2611..aaafb78a5 100644 --- a/docs/EzsigntemplatepackagesignermembershipGetObjectV2ResponseMPayload.md +++ b/docs/EzsigntemplatepackagesignermembershipGetObjectV2ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for GET /2/object/ezsigntemplatepackagesignermembership/{pkiEzsigntemplatepackagesignermembershipID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_ezsigntemplatepackagesignermembership** | [**EzsigntemplatepackagesignermembershipResponseCompound**](EzsigntemplatepackagesignermembershipResponseCompound.md) | | diff --git a/docs/EzsigntemplatepackagesignermembershipRequest.md b/docs/EzsigntemplatepackagesignermembershipRequest.md index ee691a57a..ab06ec1d0 100644 --- a/docs/EzsigntemplatepackagesignermembershipRequest.md +++ b/docs/EzsigntemplatepackagesignermembershipRequest.md @@ -3,6 +3,7 @@ A Ezsigntemplatepackagesignermembership Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsigntemplatepackagesignermembership_id** | **int** | The unique ID of the Ezsigntemplatepackagesignermembership | [optional] diff --git a/docs/EzsigntemplatepackagesignermembershipRequestCompound.md b/docs/EzsigntemplatepackagesignermembershipRequestCompound.md index 1c6a4564a..6be4863a7 100644 --- a/docs/EzsigntemplatepackagesignermembershipRequestCompound.md +++ b/docs/EzsigntemplatepackagesignermembershipRequestCompound.md @@ -3,6 +3,7 @@ A Ezsigntemplatepackagesignermembership Object and children ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsigntemplatepackagesignermembership_id** | **int** | The unique ID of the Ezsigntemplatepackagesignermembership | [optional] diff --git a/docs/EzsigntemplatepackagesignermembershipResponse.md b/docs/EzsigntemplatepackagesignermembershipResponse.md index dc82d58a7..a85c0ccae 100644 --- a/docs/EzsigntemplatepackagesignermembershipResponse.md +++ b/docs/EzsigntemplatepackagesignermembershipResponse.md @@ -3,6 +3,7 @@ A Ezsigntemplatepackagesignermembership Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsigntemplatepackagesignermembership_id** | **int** | The unique ID of the Ezsigntemplatepackagesignermembership | diff --git a/docs/EzsigntemplatepackagesignermembershipResponseCompound.md b/docs/EzsigntemplatepackagesignermembershipResponseCompound.md index 548dfb18d..683db51d0 100644 --- a/docs/EzsigntemplatepackagesignermembershipResponseCompound.md +++ b/docs/EzsigntemplatepackagesignermembershipResponseCompound.md @@ -3,6 +3,7 @@ A Ezsigntemplatepackagesignermembership Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsigntemplatepackagesignermembership_id** | **int** | The unique ID of the Ezsigntemplatepackagesignermembership | diff --git a/docs/EzsigntemplatesignatureCreateObjectV1Request.md b/docs/EzsigntemplatesignatureCreateObjectV1Request.md index 5fbcec0c2..95415c7e9 100644 --- a/docs/EzsigntemplatesignatureCreateObjectV1Request.md +++ b/docs/EzsigntemplatesignatureCreateObjectV1Request.md @@ -3,6 +3,7 @@ Request for POST /1/object/ezsigntemplatesignature ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_ezsigntemplatesignature** | [**List[EzsigntemplatesignatureRequestCompound]**](EzsigntemplatesignatureRequestCompound.md) | | diff --git a/docs/EzsigntemplatesignatureCreateObjectV1Response.md b/docs/EzsigntemplatesignatureCreateObjectV1Response.md index 04d443492..9d0cdc96c 100644 --- a/docs/EzsigntemplatesignatureCreateObjectV1Response.md +++ b/docs/EzsigntemplatesignatureCreateObjectV1Response.md @@ -3,6 +3,7 @@ Response for POST /1/object/ezsigntemplatesignature ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsigntemplatesignatureCreateObjectV1ResponseMPayload.md b/docs/EzsigntemplatesignatureCreateObjectV1ResponseMPayload.md index f0ed937cc..ce8df9d1a 100644 --- a/docs/EzsigntemplatesignatureCreateObjectV1ResponseMPayload.md +++ b/docs/EzsigntemplatesignatureCreateObjectV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for POST /1/object/ezsigntemplatesignature ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_pki_ezsigntemplatesignature_id** | **List[int]** | An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request. | diff --git a/docs/EzsigntemplatesignatureDeleteObjectV1Response.md b/docs/EzsigntemplatesignatureDeleteObjectV1Response.md index b506db8e7..9f2c7ff43 100644 --- a/docs/EzsigntemplatesignatureDeleteObjectV1Response.md +++ b/docs/EzsigntemplatesignatureDeleteObjectV1Response.md @@ -3,6 +3,7 @@ Response for DELETE /1/object/ezsigntemplatesignature/{pkiEzsigntemplatesignatureID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsigntemplatesignatureEditObjectV1Request.md b/docs/EzsigntemplatesignatureEditObjectV1Request.md index 28e3796c5..6d0dd86c9 100644 --- a/docs/EzsigntemplatesignatureEditObjectV1Request.md +++ b/docs/EzsigntemplatesignatureEditObjectV1Request.md @@ -3,6 +3,7 @@ Request for PUT /1/object/ezsigntemplatesignature/{pkiEzsigntemplatesignatureID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_ezsigntemplatesignature** | [**EzsigntemplatesignatureRequestCompound**](EzsigntemplatesignatureRequestCompound.md) | | diff --git a/docs/EzsigntemplatesignatureEditObjectV1Response.md b/docs/EzsigntemplatesignatureEditObjectV1Response.md index 0eab734d8..986241c92 100644 --- a/docs/EzsigntemplatesignatureEditObjectV1Response.md +++ b/docs/EzsigntemplatesignatureEditObjectV1Response.md @@ -3,6 +3,7 @@ Response for PUT /1/object/ezsigntemplatesignature/{pkiEzsigntemplatesignatureID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsigntemplatesignatureGetObjectV2Response.md b/docs/EzsigntemplatesignatureGetObjectV2Response.md index 5577ce687..be7bb8c59 100644 --- a/docs/EzsigntemplatesignatureGetObjectV2Response.md +++ b/docs/EzsigntemplatesignatureGetObjectV2Response.md @@ -3,6 +3,7 @@ Response for GET /2/object/ezsigntemplatesignature/{pkiEzsigntemplatesignatureID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsigntemplatesignatureGetObjectV2ResponseMPayload.md b/docs/EzsigntemplatesignatureGetObjectV2ResponseMPayload.md index 419d595e3..996b662a7 100644 --- a/docs/EzsigntemplatesignatureGetObjectV2ResponseMPayload.md +++ b/docs/EzsigntemplatesignatureGetObjectV2ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for GET /2/object/ezsigntemplatesignature/{pkiEzsigntemplatesignatureID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_ezsigntemplatesignature** | [**EzsigntemplatesignatureResponseCompound**](EzsigntemplatesignatureResponseCompound.md) | | diff --git a/docs/EzsigntemplatesignatureRequest.md b/docs/EzsigntemplatesignatureRequest.md index 2938d236c..fbd8214aa 100644 --- a/docs/EzsigntemplatesignatureRequest.md +++ b/docs/EzsigntemplatesignatureRequest.md @@ -3,6 +3,7 @@ A Ezsigntemplatesignature Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsigntemplatesignature_id** | **int** | The unique ID of the Ezsigntemplatesignature | [optional] diff --git a/docs/EzsigntemplatesignatureRequestCompound.md b/docs/EzsigntemplatesignatureRequestCompound.md index b2be6359f..c7d22d6a5 100644 --- a/docs/EzsigntemplatesignatureRequestCompound.md +++ b/docs/EzsigntemplatesignatureRequestCompound.md @@ -3,6 +3,7 @@ A Ezsigntemplatesignature Object and children ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsigntemplatesignature_id** | **int** | The unique ID of the Ezsigntemplatesignature | [optional] diff --git a/docs/EzsigntemplatesignatureResponse.md b/docs/EzsigntemplatesignatureResponse.md index c0693c67f..283a8efe5 100644 --- a/docs/EzsigntemplatesignatureResponse.md +++ b/docs/EzsigntemplatesignatureResponse.md @@ -3,6 +3,7 @@ A Ezsigntemplatesignature Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsigntemplatesignature_id** | **int** | The unique ID of the Ezsigntemplatesignature | diff --git a/docs/EzsigntemplatesignatureResponseCompound.md b/docs/EzsigntemplatesignatureResponseCompound.md index e754103bb..34bf4b012 100644 --- a/docs/EzsigntemplatesignatureResponseCompound.md +++ b/docs/EzsigntemplatesignatureResponseCompound.md @@ -3,6 +3,7 @@ A Ezsigntemplatesignature Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsigntemplatesignature_id** | **int** | The unique ID of the Ezsigntemplatesignature | diff --git a/docs/EzsigntemplatesignaturecustomdateRequest.md b/docs/EzsigntemplatesignaturecustomdateRequest.md index a73dd0a22..6b9810f30 100644 --- a/docs/EzsigntemplatesignaturecustomdateRequest.md +++ b/docs/EzsigntemplatesignaturecustomdateRequest.md @@ -3,6 +3,7 @@ An Ezsigntemplatesignaturecustomdate Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsigntemplatesignaturecustomdate_id** | **int** | The unique ID of the Ezsigntemplatesignaturecustomdate | [optional] diff --git a/docs/EzsigntemplatesignaturecustomdateRequestCompound.md b/docs/EzsigntemplatesignaturecustomdateRequestCompound.md index a0957761c..cb3bd9cde 100644 --- a/docs/EzsigntemplatesignaturecustomdateRequestCompound.md +++ b/docs/EzsigntemplatesignaturecustomdateRequestCompound.md @@ -3,6 +3,7 @@ An Ezsigntemplatesignaturecustomdate Object and children to create a complete structure ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsigntemplatesignaturecustomdate_id** | **int** | The unique ID of the Ezsigntemplatesignaturecustomdate | [optional] diff --git a/docs/EzsigntemplatesignaturecustomdateResponse.md b/docs/EzsigntemplatesignaturecustomdateResponse.md index 9ca013b7c..6ec1c4b87 100644 --- a/docs/EzsigntemplatesignaturecustomdateResponse.md +++ b/docs/EzsigntemplatesignaturecustomdateResponse.md @@ -3,6 +3,7 @@ An Ezsigntemplatesignaturecustomdate Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsigntemplatesignaturecustomdate_id** | **int** | The unique ID of the Ezsigntemplatesignaturecustomdate | diff --git a/docs/EzsigntemplatesignaturecustomdateResponseCompound.md b/docs/EzsigntemplatesignaturecustomdateResponseCompound.md index 1abba944f..fa624be6c 100644 --- a/docs/EzsigntemplatesignaturecustomdateResponseCompound.md +++ b/docs/EzsigntemplatesignaturecustomdateResponseCompound.md @@ -3,6 +3,7 @@ An Ezsigntemplatesignaturecustomdate Object and children to create a complete structure ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsigntemplatesignaturecustomdate_id** | **int** | The unique ID of the Ezsigntemplatesignaturecustomdate | diff --git a/docs/EzsigntemplatesignerCreateObjectV1Request.md b/docs/EzsigntemplatesignerCreateObjectV1Request.md index 44e5b4a2f..23d0f0823 100644 --- a/docs/EzsigntemplatesignerCreateObjectV1Request.md +++ b/docs/EzsigntemplatesignerCreateObjectV1Request.md @@ -3,6 +3,7 @@ Request for POST /1/object/ezsigntemplatesigner ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_ezsigntemplatesigner** | [**List[EzsigntemplatesignerRequestCompound]**](EzsigntemplatesignerRequestCompound.md) | | diff --git a/docs/EzsigntemplatesignerCreateObjectV1Response.md b/docs/EzsigntemplatesignerCreateObjectV1Response.md index 63b080a73..67dea882e 100644 --- a/docs/EzsigntemplatesignerCreateObjectV1Response.md +++ b/docs/EzsigntemplatesignerCreateObjectV1Response.md @@ -3,6 +3,7 @@ Response for POST /1/object/ezsigntemplatesigner ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsigntemplatesignerCreateObjectV1ResponseMPayload.md b/docs/EzsigntemplatesignerCreateObjectV1ResponseMPayload.md index 06ff4e8d7..cf2513e0a 100644 --- a/docs/EzsigntemplatesignerCreateObjectV1ResponseMPayload.md +++ b/docs/EzsigntemplatesignerCreateObjectV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for POST /1/object/ezsigntemplatesigner ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_pki_ezsigntemplatesigner_id** | **List[int]** | An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request. | diff --git a/docs/EzsigntemplatesignerDeleteObjectV1Response.md b/docs/EzsigntemplatesignerDeleteObjectV1Response.md index 22d895fa3..645bf68e7 100644 --- a/docs/EzsigntemplatesignerDeleteObjectV1Response.md +++ b/docs/EzsigntemplatesignerDeleteObjectV1Response.md @@ -3,6 +3,7 @@ Response for DELETE /1/object/ezsigntemplatesigner/{pkiEzsigntemplatesignerID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsigntemplatesignerEditObjectV1Request.md b/docs/EzsigntemplatesignerEditObjectV1Request.md index 5305460a8..02f420eb0 100644 --- a/docs/EzsigntemplatesignerEditObjectV1Request.md +++ b/docs/EzsigntemplatesignerEditObjectV1Request.md @@ -3,6 +3,7 @@ Request for PUT /1/object/ezsigntemplatesigner/{pkiEzsigntemplatesignerID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_ezsigntemplatesigner** | [**EzsigntemplatesignerRequestCompound**](EzsigntemplatesignerRequestCompound.md) | | diff --git a/docs/EzsigntemplatesignerEditObjectV1Response.md b/docs/EzsigntemplatesignerEditObjectV1Response.md index d2a11316a..eab6ff270 100644 --- a/docs/EzsigntemplatesignerEditObjectV1Response.md +++ b/docs/EzsigntemplatesignerEditObjectV1Response.md @@ -3,6 +3,7 @@ Response for PUT /1/object/ezsigntemplatesigner/{pkiEzsigntemplatesignerID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsigntemplatesignerGetObjectV2Response.md b/docs/EzsigntemplatesignerGetObjectV2Response.md index ac84cd9e3..23dbcf7c0 100644 --- a/docs/EzsigntemplatesignerGetObjectV2Response.md +++ b/docs/EzsigntemplatesignerGetObjectV2Response.md @@ -3,6 +3,7 @@ Response for GET /2/object/ezsigntemplatesigner/{pkiEzsigntemplatesignerID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsigntemplatesignerGetObjectV2ResponseMPayload.md b/docs/EzsigntemplatesignerGetObjectV2ResponseMPayload.md index b066ffc6c..07397e37f 100644 --- a/docs/EzsigntemplatesignerGetObjectV2ResponseMPayload.md +++ b/docs/EzsigntemplatesignerGetObjectV2ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for GET /2/object/ezsigntemplatesigner/{pkiEzsigntemplatesignerID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_ezsigntemplatesigner** | [**EzsigntemplatesignerResponseCompound**](EzsigntemplatesignerResponseCompound.md) | | diff --git a/docs/EzsigntemplatesignerRequest.md b/docs/EzsigntemplatesignerRequest.md index 58df7a437..349ccc036 100644 --- a/docs/EzsigntemplatesignerRequest.md +++ b/docs/EzsigntemplatesignerRequest.md @@ -3,6 +3,7 @@ A Ezsigntemplatesigner Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsigntemplatesigner_id** | **int** | The unique ID of the Ezsigntemplatesigner | [optional] diff --git a/docs/EzsigntemplatesignerRequestCompound.md b/docs/EzsigntemplatesignerRequestCompound.md index f5a742e8f..e489727fc 100644 --- a/docs/EzsigntemplatesignerRequestCompound.md +++ b/docs/EzsigntemplatesignerRequestCompound.md @@ -3,6 +3,7 @@ A Ezsigntemplatesigner Object and children ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsigntemplatesigner_id** | **int** | The unique ID of the Ezsigntemplatesigner | [optional] diff --git a/docs/EzsigntemplatesignerResponse.md b/docs/EzsigntemplatesignerResponse.md index b24c7572a..76f801b9a 100644 --- a/docs/EzsigntemplatesignerResponse.md +++ b/docs/EzsigntemplatesignerResponse.md @@ -3,6 +3,7 @@ A Ezsigntemplatesigner Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsigntemplatesigner_id** | **int** | The unique ID of the Ezsigntemplatesigner | diff --git a/docs/EzsigntemplatesignerResponseCompound.md b/docs/EzsigntemplatesignerResponseCompound.md index 73fbb8080..a1d44f727 100644 --- a/docs/EzsigntemplatesignerResponseCompound.md +++ b/docs/EzsigntemplatesignerResponseCompound.md @@ -3,6 +3,7 @@ A Ezsigntemplatesigner Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsigntemplatesigner_id** | **int** | The unique ID of the Ezsigntemplatesigner | diff --git a/docs/EzsigntsarequirementAutocompleteElementResponse.md b/docs/EzsigntsarequirementAutocompleteElementResponse.md index c5d2a60ed..b8b798425 100644 --- a/docs/EzsigntsarequirementAutocompleteElementResponse.md +++ b/docs/EzsigntsarequirementAutocompleteElementResponse.md @@ -3,6 +3,7 @@ A Ezsigntsarequirement AutocompleteElement Response ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **s_ezsigntsarequirement_description_x** | **str** | The description of the Ezsigntsarequirement in the language of the requester | diff --git a/docs/EzsigntsarequirementGetAutocompleteV2Response.md b/docs/EzsigntsarequirementGetAutocompleteV2Response.md index 56da490d7..f9ba08d00 100644 --- a/docs/EzsigntsarequirementGetAutocompleteV2Response.md +++ b/docs/EzsigntsarequirementGetAutocompleteV2Response.md @@ -3,6 +3,7 @@ Response for GET /2/object/ezsigntsarequirement/getAutocomplete ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/EzsigntsarequirementGetAutocompleteV2ResponseMPayload.md b/docs/EzsigntsarequirementGetAutocompleteV2ResponseMPayload.md index 1e59f0d6e..431953134 100644 --- a/docs/EzsigntsarequirementGetAutocompleteV2ResponseMPayload.md +++ b/docs/EzsigntsarequirementGetAutocompleteV2ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for POST /2/object/ezsigntsarequirement/getAutocomplete ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_ezsigntsarequirement** | [**List[EzsigntsarequirementAutocompleteElementResponse]**](EzsigntsarequirementAutocompleteElementResponse.md) | An array of Ezsigntsarequirement autocomplete element response. | diff --git a/docs/FieldEActivesessionOrigin.md b/docs/FieldEActivesessionOrigin.md index 39da9bfda..7154733ab 100644 --- a/docs/FieldEActivesessionOrigin.md +++ b/docs/FieldEActivesessionOrigin.md @@ -3,6 +3,7 @@ The Origin of User for the Activesession ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/FieldEActivesessionUsertype.md b/docs/FieldEActivesessionUsertype.md index 535ee9f8a..aa1aa604b 100644 --- a/docs/FieldEActivesessionUsertype.md +++ b/docs/FieldEActivesessionUsertype.md @@ -3,6 +3,7 @@ The Type of User for the Activesession ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/FieldEActivesessionWeekdaystart.md b/docs/FieldEActivesessionWeekdaystart.md index 5a8f01c68..6fe7d5267 100644 --- a/docs/FieldEActivesessionWeekdaystart.md +++ b/docs/FieldEActivesessionWeekdaystart.md @@ -3,6 +3,7 @@ The weekday start of the User. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/FieldEAttachmentDocumenttype.md b/docs/FieldEAttachmentDocumenttype.md new file mode 100644 index 000000000..ff0759385 --- /dev/null +++ b/docs/FieldEAttachmentDocumenttype.md @@ -0,0 +1,12 @@ +# FieldEAttachmentDocumenttype + +The documenttype of the Attachment + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[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/docs/FieldEAttachmentPrivacy.md b/docs/FieldEAttachmentPrivacy.md new file mode 100644 index 000000000..d3e62c6c8 --- /dev/null +++ b/docs/FieldEAttachmentPrivacy.md @@ -0,0 +1,12 @@ +# FieldEAttachmentPrivacy + +The privacy of the Attachment + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[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/docs/FieldEAttachmentType.md b/docs/FieldEAttachmentType.md new file mode 100644 index 000000000..ad6a66f42 --- /dev/null +++ b/docs/FieldEAttachmentType.md @@ -0,0 +1,12 @@ +# FieldEAttachmentType + +The type of the Attachment + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[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/docs/FieldEAttachmentVerified.md b/docs/FieldEAttachmentVerified.md new file mode 100644 index 000000000..441194deb --- /dev/null +++ b/docs/FieldEAttachmentVerified.md @@ -0,0 +1,12 @@ +# FieldEAttachmentVerified + +The verified of the Attachment + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[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/docs/FieldEAttachmentlogType.md b/docs/FieldEAttachmentlogType.md new file mode 100644 index 000000000..0d5dfbd96 --- /dev/null +++ b/docs/FieldEAttachmentlogType.md @@ -0,0 +1,12 @@ +# FieldEAttachmentlogType + +The Type for the Attachmentlog + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[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/docs/FieldEBrandingLogo.md b/docs/FieldEBrandingLogo.md index 81fb406aa..83a892a12 100644 --- a/docs/FieldEBrandingLogo.md +++ b/docs/FieldEBrandingLogo.md @@ -3,6 +3,7 @@ The logo for the Branding. Select the value 'Default' if you want to use the default logo and delete the custom one if you used one ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/FieldECommunicationImportance.md b/docs/FieldECommunicationImportance.md index 13a501738..b83d0c7f3 100644 --- a/docs/FieldECommunicationImportance.md +++ b/docs/FieldECommunicationImportance.md @@ -3,6 +3,7 @@ The importance of the Communication ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/FieldECommunicationType.md b/docs/FieldECommunicationType.md index 14766ac20..249b0b57a 100644 --- a/docs/FieldECommunicationType.md +++ b/docs/FieldECommunicationType.md @@ -3,6 +3,7 @@ The type of the Communication ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/FieldECommunicationexternalrecipientType.md b/docs/FieldECommunicationexternalrecipientType.md index c5eb83750..85afffcab 100644 --- a/docs/FieldECommunicationexternalrecipientType.md +++ b/docs/FieldECommunicationexternalrecipientType.md @@ -3,6 +3,7 @@ The type of Communicationexternalrecipient. Only used when eCommunicationType is **Email** ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/FieldECommunicationrecipientType.md b/docs/FieldECommunicationrecipientType.md index fb7d528ed..001ec7f18 100644 --- a/docs/FieldECommunicationrecipientType.md +++ b/docs/FieldECommunicationrecipientType.md @@ -3,6 +3,7 @@ The type for the Communicationrecipient. Only used when eCommunicationType is **Email** ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/FieldECreditcardtypeCodename.md b/docs/FieldECreditcardtypeCodename.md index 86090d6b9..a6cebde8c 100644 --- a/docs/FieldECreditcardtypeCodename.md +++ b/docs/FieldECreditcardtypeCodename.md @@ -3,6 +3,7 @@ The codename of the Creditcardtype ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/FieldEErrorCode.md b/docs/FieldEErrorCode.md index 963462185..af160e1e1 100644 --- a/docs/FieldEErrorCode.md +++ b/docs/FieldEErrorCode.md @@ -3,6 +3,7 @@ The error code. See documentation for valid values ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/FieldEEzmaxinvoicingPaymenttype.md b/docs/FieldEEzmaxinvoicingPaymenttype.md index b6664a356..10a1768a3 100644 --- a/docs/FieldEEzmaxinvoicingPaymenttype.md +++ b/docs/FieldEEzmaxinvoicingPaymenttype.md @@ -3,6 +3,7 @@ The Ezmaxinvoicing payment type ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/FieldEEzmaxinvoicingagentVariationezmax.md b/docs/FieldEEzmaxinvoicingagentVariationezmax.md index 37c53042f..e2db2ec2a 100644 --- a/docs/FieldEEzmaxinvoicingagentVariationezmax.md +++ b/docs/FieldEEzmaxinvoicingagentVariationezmax.md @@ -3,6 +3,7 @@ Variation type for eZmax ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/FieldEEzmaxinvoicingagentVariationezsign.md b/docs/FieldEEzmaxinvoicingagentVariationezsign.md index d1424a3aa..e3ad6d846 100644 --- a/docs/FieldEEzmaxinvoicingagentVariationezsign.md +++ b/docs/FieldEEzmaxinvoicingagentVariationezsign.md @@ -3,6 +3,7 @@ Variation type for eZsign ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/FieldEEzmaxinvoicingcontractPaymenttype.md b/docs/FieldEEzmaxinvoicingcontractPaymenttype.md index 0a1780149..0e3e037e4 100644 --- a/docs/FieldEEzmaxinvoicingcontractPaymenttype.md +++ b/docs/FieldEEzmaxinvoicingcontractPaymenttype.md @@ -3,6 +3,7 @@ The Ezmaxinvoicingcontract payment type ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/FieldEEzmaxinvoicinguserVariationezsign.md b/docs/FieldEEzmaxinvoicinguserVariationezsign.md index 7f1dfb3a1..5edd851e3 100644 --- a/docs/FieldEEzmaxinvoicinguserVariationezsign.md +++ b/docs/FieldEEzmaxinvoicinguserVariationezsign.md @@ -3,6 +3,7 @@ The variation type for eZsign ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/FieldEEzsignannotationType.md b/docs/FieldEEzsignannotationType.md index 292f875a0..1eea8df69 100644 --- a/docs/FieldEEzsignannotationType.md +++ b/docs/FieldEEzsignannotationType.md @@ -3,6 +3,7 @@ The type of the Ezsignannotation. 1. **StrikethroughBlock** is a box with hatching. 2. **StrikethroughLine** is a red line to cross words. 3. **Text** is a simple Text. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/FieldEEzsigndocumentStep.md b/docs/FieldEEzsigndocumentStep.md index 1c0a8ada1..586c3c059 100644 --- a/docs/FieldEEzsigndocumentStep.md +++ b/docs/FieldEEzsigndocumentStep.md @@ -3,6 +3,7 @@ The signature step of the Ezsigndocument. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/FieldEEzsigndocumentlogType.md b/docs/FieldEEzsigndocumentlogType.md index 5c0d59ffc..d2e9f4128 100644 --- a/docs/FieldEEzsigndocumentlogType.md +++ b/docs/FieldEEzsigndocumentlogType.md @@ -3,6 +3,7 @@ The Ezsigndocumentlog Type. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/FieldEEzsignelementdependencyOperator.md b/docs/FieldEEzsignelementdependencyOperator.md index 91163effc..b832c5017 100644 --- a/docs/FieldEEzsignelementdependencyOperator.md +++ b/docs/FieldEEzsignelementdependencyOperator.md @@ -3,6 +3,7 @@ The operator of the Ezsignelementdependency ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/FieldEEzsignelementdependencyValidation.md b/docs/FieldEEzsignelementdependencyValidation.md index 3c817aa14..be42c9e13 100644 --- a/docs/FieldEEzsignelementdependencyValidation.md +++ b/docs/FieldEEzsignelementdependencyValidation.md @@ -3,6 +3,7 @@ The validation type of the Ezsignelementdependency ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/FieldEEzsignfolderSendreminderfrequency.md b/docs/FieldEEzsignfolderSendreminderfrequency.md index 82d6c54be..1458daeac 100644 --- a/docs/FieldEEzsignfolderSendreminderfrequency.md +++ b/docs/FieldEEzsignfolderSendreminderfrequency.md @@ -3,6 +3,7 @@ Frequency at which reminders will be sent to signers that haven't signed the documents ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/FieldEEzsignfolderStep.md b/docs/FieldEEzsignfolderStep.md index 080deaa45..acbf5ec83 100644 --- a/docs/FieldEEzsignfolderStep.md +++ b/docs/FieldEEzsignfolderStep.md @@ -3,6 +3,7 @@ The signature step of the Ezsignfolder. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/FieldEEzsignfoldertypeDisposal.md b/docs/FieldEEzsignfoldertypeDisposal.md index 17c2390f8..36a76bcaf 100644 --- a/docs/FieldEEzsignfoldertypeDisposal.md +++ b/docs/FieldEEzsignfoldertypeDisposal.md @@ -3,6 +3,7 @@ The type of disposal ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/FieldEEzsignfoldertypePrivacylevel.md b/docs/FieldEEzsignfoldertypePrivacylevel.md index 4e1c99cd5..04867ca04 100644 --- a/docs/FieldEEzsignfoldertypePrivacylevel.md +++ b/docs/FieldEEzsignfoldertypePrivacylevel.md @@ -3,6 +3,7 @@ The Privacy level of the Ezsignfolder type. * **User** is for personal folders use and cannot be shared * **Usergroup** is for shared folders and complex permission can be configured to control access ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/FieldEEzsignfoldertypeSendreminderfrequency.md b/docs/FieldEEzsignfoldertypeSendreminderfrequency.md index a6963a7f7..f89f7edea 100644 --- a/docs/FieldEEzsignfoldertypeSendreminderfrequency.md +++ b/docs/FieldEEzsignfoldertypeSendreminderfrequency.md @@ -3,6 +3,7 @@ Frequency at which reminders will be sent to signers that haven't signed the documents ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/FieldEEzsignformfieldDependencyrequirement.md b/docs/FieldEEzsignformfieldDependencyrequirement.md index 53f879fda..510f137b7 100644 --- a/docs/FieldEEzsignformfieldDependencyrequirement.md +++ b/docs/FieldEEzsignformfieldDependencyrequirement.md @@ -3,6 +3,7 @@ The Dependency requirement of the Ezsignformfield ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/FieldEEzsignformfieldgroupSignerrequirement.md b/docs/FieldEEzsignformfieldgroupSignerrequirement.md index 91df45ad2..7030f704b 100644 --- a/docs/FieldEEzsignformfieldgroupSignerrequirement.md +++ b/docs/FieldEEzsignformfieldgroupSignerrequirement.md @@ -3,6 +3,7 @@ The Signer requirement of the Ezsignformfieldgroup. **All** means anyone can fill it, **One** means a specific person must fill it. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/FieldEEzsignformfieldgroupTooltipposition.md b/docs/FieldEEzsignformfieldgroupTooltipposition.md index 015ad1bcf..3163199b4 100644 --- a/docs/FieldEEzsignformfieldgroupTooltipposition.md +++ b/docs/FieldEEzsignformfieldgroupTooltipposition.md @@ -3,6 +3,7 @@ The location of the tooltip relative to the Ezsignformfieldgroup's location. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/FieldEEzsignformfieldgroupType.md b/docs/FieldEEzsignformfieldgroupType.md index 9820cc4d5..392f9ed9b 100644 --- a/docs/FieldEEzsignformfieldgroupType.md +++ b/docs/FieldEEzsignformfieldgroupType.md @@ -3,6 +3,7 @@ The Type of Ezsignformfieldgroup ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/FieldEEzsignsignatureAttachmentnamesource.md b/docs/FieldEEzsignsignatureAttachmentnamesource.md index c9114230a..be5121db7 100644 --- a/docs/FieldEEzsignsignatureAttachmentnamesource.md +++ b/docs/FieldEEzsignsignatureAttachmentnamesource.md @@ -3,6 +3,7 @@ The source of the name of the attachment added to the Ezsignsignature ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/FieldEEzsignsignatureDependencyrequirement.md b/docs/FieldEEzsignsignatureDependencyrequirement.md index f5038d5f9..06c0cea74 100644 --- a/docs/FieldEEzsignsignatureDependencyrequirement.md +++ b/docs/FieldEEzsignsignatureDependencyrequirement.md @@ -3,6 +3,7 @@ The Dependency requirement of the Ezsignsignature ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/FieldEEzsignsignatureFont.md b/docs/FieldEEzsignsignatureFont.md index e7ef886b5..727d28797 100644 --- a/docs/FieldEEzsignsignatureFont.md +++ b/docs/FieldEEzsignsignatureFont.md @@ -3,6 +3,7 @@ The font of the signature. This can only be set if eEzsignsignatureType is **Name** or **Initials** ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/FieldEEzsignsignatureTooltipposition.md b/docs/FieldEEzsignsignatureTooltipposition.md index 12966848b..fd1aad265 100644 --- a/docs/FieldEEzsignsignatureTooltipposition.md +++ b/docs/FieldEEzsignsignatureTooltipposition.md @@ -3,6 +3,7 @@ The location of the tooltip relative to the Ezsignsignature's location. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/FieldEEzsignsignatureType.md b/docs/FieldEEzsignsignatureType.md index fad7875e9..f2dcc64b9 100644 --- a/docs/FieldEEzsignsignatureType.md +++ b/docs/FieldEEzsignsignatureType.md @@ -1,8 +1,9 @@ # FieldEEzsignsignatureType -The type of signature. 1. **Acknowledgement** is for an acknowledgment of receipt. 2. **City** is to request the city where the document is signed. 3. **Handwritten** is for a handwritten kind of signature where users needs to \"draw\" their signature on screen. 4. **Initials** is a simple \"click to add initials\" block. 5. **Name** is a simple \"Click to sign\" block. This is the most common block of signature. 6. **Attachments** is to ask for files as attachment that may be validate in another step. 7. **FieldText** is to ask for a short text. 8. **Fieldtextarea** is to ask for a text +The type of signature. 1. **Acknowledgement** is for an acknowledgment of receipt. 2. **City** is to request the city where the document is signed. 3. **Handwritten** is for a handwritten kind of signature where users needs to \"draw\" their signature on screen. 4. **Initials** is a simple \"click to add initials\" block. 5. **Name** is a simple \"Click to sign\" block. This is the most common block of signature. 6. **NameReason** is to ask for a signing reason. 7. **Attachments** is to ask for files as attachment that may be validate in another step. 8. **FieldText** is to ask for a short text. 9. **Fieldtextarea** is to ask for a text ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/FieldEEzsigntemplateelementdependencyOperator.md b/docs/FieldEEzsigntemplateelementdependencyOperator.md index cfc73472b..f56efd62a 100644 --- a/docs/FieldEEzsigntemplateelementdependencyOperator.md +++ b/docs/FieldEEzsigntemplateelementdependencyOperator.md @@ -3,6 +3,7 @@ The operator of the Ezsigntemplateelementdependency ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/FieldEEzsigntemplateelementdependencyValidation.md b/docs/FieldEEzsigntemplateelementdependencyValidation.md index 9ade9b210..58f3b007d 100644 --- a/docs/FieldEEzsigntemplateelementdependencyValidation.md +++ b/docs/FieldEEzsigntemplateelementdependencyValidation.md @@ -3,6 +3,7 @@ The validation type of the Ezsigntemplateelementdependency ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/FieldEEzsigntemplateformfieldDependencyrequirement.md b/docs/FieldEEzsigntemplateformfieldDependencyrequirement.md index 789d2a928..a84762984 100644 --- a/docs/FieldEEzsigntemplateformfieldDependencyrequirement.md +++ b/docs/FieldEEzsigntemplateformfieldDependencyrequirement.md @@ -3,6 +3,7 @@ The Dependency requirement of the Ezsigntemplateformfield ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/FieldEEzsigntemplateformfieldgroupSignerrequirement.md b/docs/FieldEEzsigntemplateformfieldgroupSignerrequirement.md index 55f9194c0..e518115c3 100644 --- a/docs/FieldEEzsigntemplateformfieldgroupSignerrequirement.md +++ b/docs/FieldEEzsigntemplateformfieldgroupSignerrequirement.md @@ -3,6 +3,7 @@ The Signer requirement of the Ezsigntemplateformfieldgroup. **All** means anyone can fill it, **One** means a specific person must fill it. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/FieldEEzsigntemplateformfieldgroupTooltipposition.md b/docs/FieldEEzsigntemplateformfieldgroupTooltipposition.md index a2f9acd30..41befcf05 100644 --- a/docs/FieldEEzsigntemplateformfieldgroupTooltipposition.md +++ b/docs/FieldEEzsigntemplateformfieldgroupTooltipposition.md @@ -3,6 +3,7 @@ The location of the tooltip relative to the Ezsigntemplateformfieldgroup's location. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/FieldEEzsigntemplateformfieldgroupType.md b/docs/FieldEEzsigntemplateformfieldgroupType.md index 731061141..7d09babb7 100644 --- a/docs/FieldEEzsigntemplateformfieldgroupType.md +++ b/docs/FieldEEzsigntemplateformfieldgroupType.md @@ -3,6 +3,7 @@ The Type of Ezsigntemplateformfieldgroup ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/FieldEEzsigntemplatesignatureAttachmentnamesource.md b/docs/FieldEEzsigntemplatesignatureAttachmentnamesource.md index 044dfd7b9..ad1ed41a8 100644 --- a/docs/FieldEEzsigntemplatesignatureAttachmentnamesource.md +++ b/docs/FieldEEzsigntemplatesignatureAttachmentnamesource.md @@ -3,6 +3,7 @@ The source of the name of the attachment added to the Ezsigntemplatesignature ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/FieldEEzsigntemplatesignatureDependencyrequirement.md b/docs/FieldEEzsigntemplatesignatureDependencyrequirement.md index 4efefcfd6..5b9eb80d2 100644 --- a/docs/FieldEEzsigntemplatesignatureDependencyrequirement.md +++ b/docs/FieldEEzsigntemplatesignatureDependencyrequirement.md @@ -3,6 +3,7 @@ The Dependency requirement of the Ezsigntemplatesignature ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/FieldEEzsigntemplatesignatureFont.md b/docs/FieldEEzsigntemplatesignatureFont.md index ce9265697..9e7f736a1 100644 --- a/docs/FieldEEzsigntemplatesignatureFont.md +++ b/docs/FieldEEzsigntemplatesignatureFont.md @@ -3,6 +3,7 @@ The font of the signature. This can only be set if eEzsigntemplatesignatureType is **Name** or **Initials** ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/FieldEEzsigntemplatesignatureTooltipposition.md b/docs/FieldEEzsigntemplatesignatureTooltipposition.md index bbfab39ff..af5889a4e 100644 --- a/docs/FieldEEzsigntemplatesignatureTooltipposition.md +++ b/docs/FieldEEzsigntemplatesignatureTooltipposition.md @@ -3,6 +3,7 @@ The location of the tooltip relative to the Ezsigntemplatesignature's location. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/FieldEEzsigntemplatesignatureType.md b/docs/FieldEEzsigntemplatesignatureType.md index 947028255..bf30350bb 100644 --- a/docs/FieldEEzsigntemplatesignatureType.md +++ b/docs/FieldEEzsigntemplatesignatureType.md @@ -1,8 +1,9 @@ # FieldEEzsigntemplatesignatureType -The type of signature. 1. **Acknowledgement** is for an acknowledgment of receipt. 2. **City** is to request the city where the document is signed. 3. **Handwritten** is for a handwritten kind of signature where users needs to \"draw\" their signature on screen. 4. **Initials** is a simple \"click to add initials\" block. 5. **Name** is a simple \"Click to sign\" block. This is the most common block of signature. 6. **Attachments** is to ask for files as attachment that may be validate in another step. +The type of signature. 1. **Acknowledgement** is for an acknowledgment of receipt. 2. **City** is to request the city where the document is signed. 3. **Handwritten** is for a handwritten kind of signature where users needs to \"draw\" their signature on screen. 4. **Initials** is a simple \"click to add initials\" block. 5. **Name** is a simple \"Click to sign\" block. This is the most common block of signature. 6. **NameReason** is to ask for a signing reason. 7. **Attachments** is to ask for files as attachment that may be validate in another step. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/FieldENotificationpreferenceStatus.md b/docs/FieldENotificationpreferenceStatus.md index 8c5b724a6..b6af408ee 100644 --- a/docs/FieldENotificationpreferenceStatus.md +++ b/docs/FieldENotificationpreferenceStatus.md @@ -3,6 +3,7 @@ The display status for the Notificationtest. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/FieldEPaymenttermType.md b/docs/FieldEPaymenttermType.md index d12e6f293..a9ee97f61 100644 --- a/docs/FieldEPaymenttermType.md +++ b/docs/FieldEPaymenttermType.md @@ -3,6 +3,7 @@ The type of the Paymentterm ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/FieldEPhoneType.md b/docs/FieldEPhoneType.md index 953b7dbae..33f8f1efb 100644 --- a/docs/FieldEPhoneType.md +++ b/docs/FieldEPhoneType.md @@ -3,6 +3,7 @@ The type of phone number. **Local** refers to a north American phone number. You would then need to specify sPhoneRegion, sPhoneExchange, sPhoneNumber. **International** would be used for numbers outside of north america. You would then need to specify sPhoneInternational ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/FieldESessionhistoryEndby.md b/docs/FieldESessionhistoryEndby.md index 17f2985be..10874af06 100644 --- a/docs/FieldESessionhistoryEndby.md +++ b/docs/FieldESessionhistoryEndby.md @@ -3,6 +3,7 @@ The Type of the Sessionhistory ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/FieldESystemconfigurationEzsign.md b/docs/FieldESystemconfigurationEzsign.md index 20e51ec15..1f5a10438 100644 --- a/docs/FieldESystemconfigurationEzsign.md +++ b/docs/FieldESystemconfigurationEzsign.md @@ -3,6 +3,7 @@ Whether if Ezsign is paid by the company or not ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/FieldESystemconfigurationLanguage1.md b/docs/FieldESystemconfigurationLanguage1.md index 2c94d0da6..32c69fad6 100644 --- a/docs/FieldESystemconfigurationLanguage1.md +++ b/docs/FieldESystemconfigurationLanguage1.md @@ -3,6 +3,7 @@ The type of the french for the client ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/FieldESystemconfigurationLanguage2.md b/docs/FieldESystemconfigurationLanguage2.md index a6e740992..9a94d039b 100644 --- a/docs/FieldESystemconfigurationLanguage2.md +++ b/docs/FieldESystemconfigurationLanguage2.md @@ -3,6 +3,7 @@ The type of the english for the client ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/FieldESystemconfigurationNewexternaluseraction.md b/docs/FieldESystemconfigurationNewexternaluseraction.md index 30f304682..1e484751f 100644 --- a/docs/FieldESystemconfigurationNewexternaluseraction.md +++ b/docs/FieldESystemconfigurationNewexternaluseraction.md @@ -3,6 +3,7 @@ The action we do when a new external user connects itself ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/FieldEUserEzsignaccess.md b/docs/FieldEUserEzsignaccess.md index 22f23ea65..fab2ed199 100644 --- a/docs/FieldEUserEzsignaccess.md +++ b/docs/FieldEUserEzsignaccess.md @@ -1,8 +1,9 @@ # FieldEUserEzsignaccess -The type or eZsign access the User has +The type of eZsign access the User has ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/FieldEUserEzsignprepaid.md b/docs/FieldEUserEzsignprepaid.md new file mode 100644 index 000000000..9ba89b35d --- /dev/null +++ b/docs/FieldEUserEzsignprepaid.md @@ -0,0 +1,12 @@ +# FieldEUserEzsignprepaid + +Subscription level when a user has a Prepaid subscription. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[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/docs/FieldEUserEzsignsendreminderfrequency.md b/docs/FieldEUserEzsignsendreminderfrequency.md index ae2aa89ae..c4828877b 100644 --- a/docs/FieldEUserEzsignsendreminderfrequency.md +++ b/docs/FieldEUserEzsignsendreminderfrequency.md @@ -3,6 +3,7 @@ Frequency at which reminders will be sent to signers that haven't signed the documents ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/FieldEUserLogintype.md b/docs/FieldEUserLogintype.md index 0a388ec1c..d5345e7ee 100644 --- a/docs/FieldEUserLogintype.md +++ b/docs/FieldEUserLogintype.md @@ -3,6 +3,7 @@ The type of authentication for the User ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/FieldEUserOrigin.md b/docs/FieldEUserOrigin.md index ed2a0deff..f7e4959b7 100644 --- a/docs/FieldEUserOrigin.md +++ b/docs/FieldEUserOrigin.md @@ -3,6 +3,7 @@ The origin of the User ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/FieldEUserType.md b/docs/FieldEUserType.md index c81efa7fa..366053d0f 100644 --- a/docs/FieldEUserType.md +++ b/docs/FieldEUserType.md @@ -3,6 +3,7 @@ The user type of the User. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/FieldEVariableexpenseTaxable.md b/docs/FieldEVariableexpenseTaxable.md index 36d32abbc..bb772bb84 100644 --- a/docs/FieldEVariableexpenseTaxable.md +++ b/docs/FieldEVariableexpenseTaxable.md @@ -3,6 +3,7 @@ The taxable of the Variableexpense ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/FieldEVersionhistoryType.md b/docs/FieldEVersionhistoryType.md index 9b8f54428..6b4f09ab0 100644 --- a/docs/FieldEVersionhistoryType.md +++ b/docs/FieldEVersionhistoryType.md @@ -3,6 +3,7 @@ The type of Versionhistory. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/FieldEVersionhistoryUsertype.md b/docs/FieldEVersionhistoryUsertype.md index f65b71a03..a01f7062f 100644 --- a/docs/FieldEVersionhistoryUsertype.md +++ b/docs/FieldEVersionhistoryUsertype.md @@ -3,6 +3,7 @@ The Usertype by which the Versionhistory should be visible ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/FieldEWebhookEzsignevent.md b/docs/FieldEWebhookEzsignevent.md index 980932762..a11605308 100644 --- a/docs/FieldEWebhookEzsignevent.md +++ b/docs/FieldEWebhookEzsignevent.md @@ -3,6 +3,7 @@ This Ezsign Event. This property will be set only if the Module is \"Ezsign\" ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/FieldEWebhookManagementevent.md b/docs/FieldEWebhookManagementevent.md index 53421aedc..75c83621f 100644 --- a/docs/FieldEWebhookManagementevent.md +++ b/docs/FieldEWebhookManagementevent.md @@ -3,6 +3,7 @@ This Management Event. This property will be set only if the Module is \"Management\". ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/FieldEWebhookModule.md b/docs/FieldEWebhookModule.md index 54af5f759..55bc12734 100644 --- a/docs/FieldEWebhookModule.md +++ b/docs/FieldEWebhookModule.md @@ -3,6 +3,7 @@ The module for the Webhook ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/FieldPksEzmaxclientOs.md b/docs/FieldPksEzmaxclientOs.md index a3675ded1..23bff4170 100644 --- a/docs/FieldPksEzmaxclientOs.md +++ b/docs/FieldPksEzmaxclientOs.md @@ -3,6 +3,7 @@ The OS of the system running the application ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/FontAutocompleteElementResponse.md b/docs/FontAutocompleteElementResponse.md index 4094dd31f..fe62f60b3 100644 --- a/docs/FontAutocompleteElementResponse.md +++ b/docs/FontAutocompleteElementResponse.md @@ -3,6 +3,7 @@ A Font AutocompleteElement Response ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **s_font_name** | **str** | The name of the Font | diff --git a/docs/FontGetAutocompleteV2Response.md b/docs/FontGetAutocompleteV2Response.md index 9fa643fc3..92a148539 100644 --- a/docs/FontGetAutocompleteV2Response.md +++ b/docs/FontGetAutocompleteV2Response.md @@ -3,6 +3,7 @@ Response for GET /2/object/font/getAutocomplete ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/FontGetAutocompleteV2ResponseMPayload.md b/docs/FontGetAutocompleteV2ResponseMPayload.md index 03d5bf76b..70548250d 100644 --- a/docs/FontGetAutocompleteV2ResponseMPayload.md +++ b/docs/FontGetAutocompleteV2ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for POST /2/object/font/getAutocomplete ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_font** | [**List[FontAutocompleteElementResponse]**](FontAutocompleteElementResponse.md) | An array of Font autocomplete element response. | diff --git a/docs/FranchisebrokerAutocompleteElementResponse.md b/docs/FranchisebrokerAutocompleteElementResponse.md index f3184bd32..b1f606b3b 100644 --- a/docs/FranchisebrokerAutocompleteElementResponse.md +++ b/docs/FranchisebrokerAutocompleteElementResponse.md @@ -3,6 +3,7 @@ A Franchisebroker AutocompleteElement Response ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **s_franchisebroker_name** | **str** | The name of the Franchisebroker in the language of the requester | diff --git a/docs/FranchisebrokerGetAutocompleteV2Response.md b/docs/FranchisebrokerGetAutocompleteV2Response.md index 74901eb18..d43db9bcb 100644 --- a/docs/FranchisebrokerGetAutocompleteV2Response.md +++ b/docs/FranchisebrokerGetAutocompleteV2Response.md @@ -3,6 +3,7 @@ Response for GET /2/object/franchisebroker/getAutocomplete ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/FranchisebrokerGetAutocompleteV2ResponseMPayload.md b/docs/FranchisebrokerGetAutocompleteV2ResponseMPayload.md index b05b6f22b..6d769f0b3 100644 --- a/docs/FranchisebrokerGetAutocompleteV2ResponseMPayload.md +++ b/docs/FranchisebrokerGetAutocompleteV2ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for POST /2/object/franchisebroker/getAutocomplete ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_franchisebroker** | [**List[FranchisebrokerAutocompleteElementResponse]**](FranchisebrokerAutocompleteElementResponse.md) | An array of Franchisebroker autocomplete element response. | diff --git a/docs/FranchiseofficeAutocompleteElementResponse.md b/docs/FranchiseofficeAutocompleteElementResponse.md index 1e35fb0f4..740fbf293 100644 --- a/docs/FranchiseofficeAutocompleteElementResponse.md +++ b/docs/FranchiseofficeAutocompleteElementResponse.md @@ -3,6 +3,7 @@ A Franchiseoffice AutocompleteElement Response ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **s_franchiseoffice_description** | **str** | The description of the Franchiseoffice in the language of the requester | diff --git a/docs/FranchiseofficeGetAutocompleteV2Response.md b/docs/FranchiseofficeGetAutocompleteV2Response.md index 6eb2c0420..3c3ab735b 100644 --- a/docs/FranchiseofficeGetAutocompleteV2Response.md +++ b/docs/FranchiseofficeGetAutocompleteV2Response.md @@ -3,6 +3,7 @@ Response for GET /2/object/franchiseoffice/getAutocomplete ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/FranchiseofficeGetAutocompleteV2ResponseMPayload.md b/docs/FranchiseofficeGetAutocompleteV2ResponseMPayload.md index a373e53e0..3091c05b2 100644 --- a/docs/FranchiseofficeGetAutocompleteV2ResponseMPayload.md +++ b/docs/FranchiseofficeGetAutocompleteV2ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for POST /2/object/franchiseoffice/getAutocomplete ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_franchiseoffice** | [**List[FranchiseofficeAutocompleteElementResponse]**](FranchiseofficeAutocompleteElementResponse.md) | An array of Franchiseoffice autocomplete element response. | diff --git a/docs/FranchisereferalincomeCreateObjectV1Request.md b/docs/FranchisereferalincomeCreateObjectV1Request.md index 97428af9a..00a0366f8 100644 --- a/docs/FranchisereferalincomeCreateObjectV1Request.md +++ b/docs/FranchisereferalincomeCreateObjectV1Request.md @@ -3,6 +3,7 @@ Request for POST /1/object/franchisereferalincome ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_franchisereferalincome** | [**FranchisereferalincomeRequest**](FranchisereferalincomeRequest.md) | | [optional] diff --git a/docs/FranchisereferalincomeCreateObjectV1Response.md b/docs/FranchisereferalincomeCreateObjectV1Response.md index 6fe017198..3e47f97d4 100644 --- a/docs/FranchisereferalincomeCreateObjectV1Response.md +++ b/docs/FranchisereferalincomeCreateObjectV1Response.md @@ -3,6 +3,7 @@ Response for POST /1/object/franchisereferalincome ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/FranchisereferalincomeCreateObjectV1ResponseMPayload.md b/docs/FranchisereferalincomeCreateObjectV1ResponseMPayload.md index 20b8480f1..31f3aefba 100644 --- a/docs/FranchisereferalincomeCreateObjectV1ResponseMPayload.md +++ b/docs/FranchisereferalincomeCreateObjectV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for POST /1/object/franchisereferalincome ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_pki_franchisereferalincome_id** | **List[int]** | An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request. | diff --git a/docs/FranchisereferalincomeCreateObjectV2Request.md b/docs/FranchisereferalincomeCreateObjectV2Request.md index 88db2b390..af45d0661 100644 --- a/docs/FranchisereferalincomeCreateObjectV2Request.md +++ b/docs/FranchisereferalincomeCreateObjectV2Request.md @@ -3,6 +3,7 @@ Request for POST /2/object/franchisereferalincome ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_franchisereferalincome** | [**List[FranchisereferalincomeRequestCompound]**](FranchisereferalincomeRequestCompound.md) | | diff --git a/docs/FranchisereferalincomeCreateObjectV2Response.md b/docs/FranchisereferalincomeCreateObjectV2Response.md index edb09ccdf..4ef01f350 100644 --- a/docs/FranchisereferalincomeCreateObjectV2Response.md +++ b/docs/FranchisereferalincomeCreateObjectV2Response.md @@ -3,6 +3,7 @@ Response for POST /2/object/franchisereferalincome ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/FranchisereferalincomeCreateObjectV2ResponseMPayload.md b/docs/FranchisereferalincomeCreateObjectV2ResponseMPayload.md index 80c3eecc9..84ab683fe 100644 --- a/docs/FranchisereferalincomeCreateObjectV2ResponseMPayload.md +++ b/docs/FranchisereferalincomeCreateObjectV2ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for POST /2/object/franchisereferalincome ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_pki_franchisereferalincome_id** | **List[int]** | An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request. | diff --git a/docs/FranchisereferalincomeRequest.md b/docs/FranchisereferalincomeRequest.md index d90e2e05e..2133e132a 100644 --- a/docs/FranchisereferalincomeRequest.md +++ b/docs/FranchisereferalincomeRequest.md @@ -3,6 +3,7 @@ An Franchisereferalincome Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_franchisereferalincome_id** | **int** | The unique ID of the Franchisereferalincome | [optional] diff --git a/docs/FranchisereferalincomeRequestCompound.md b/docs/FranchisereferalincomeRequestCompound.md index d872af80f..9303717f2 100644 --- a/docs/FranchisereferalincomeRequestCompound.md +++ b/docs/FranchisereferalincomeRequestCompound.md @@ -3,6 +3,7 @@ A Franchisereferalincome Object and children to create a complete structure ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_franchisereferalincome_id** | **int** | The unique ID of the Franchisereferalincome | [optional] diff --git a/docs/GlobalCustomerApi.md b/docs/GlobalCustomerApi.md index 54be7103d..bff8b347e 100644 --- a/docs/GlobalCustomerApi.md +++ b/docs/GlobalCustomerApi.md @@ -16,6 +16,7 @@ Retrieve the customer's specific server endpoint where to send requests. This wi ### Example + ```python import time import os @@ -51,6 +52,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pks_customer_code** | **str**| | @@ -70,6 +72,7 @@ No authorization required - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | diff --git a/docs/GlobalCustomerGetEndpointV1Response.md b/docs/GlobalCustomerGetEndpointV1Response.md index 31845b9ca..16c874bf2 100644 --- a/docs/GlobalCustomerGetEndpointV1Response.md +++ b/docs/GlobalCustomerGetEndpointV1Response.md @@ -3,6 +3,7 @@ Response for GET /1/customer/{pksCustomerCode}/endpoint ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **s_endpoint_url** | **str** | The endpoint's URL | diff --git a/docs/GlobalEzmaxclientApi.md b/docs/GlobalEzmaxclientApi.md index 4434e82c7..59594f639 100644 --- a/docs/GlobalEzmaxclientApi.md +++ b/docs/GlobalEzmaxclientApi.md @@ -16,6 +16,7 @@ Retrieve the latest version of the Ezmaxclient that is available on the store. ### Example + ```python import time import os @@ -51,6 +52,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pks_ezmaxclient_os** | [**FieldPksEzmaxclientOs**](.md)| | @@ -69,6 +71,7 @@ No authorization required - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | diff --git a/docs/GlobalEzmaxclientVersionV1Response.md b/docs/GlobalEzmaxclientVersionV1Response.md index db5deb426..f98955036 100644 --- a/docs/GlobalEzmaxclientVersionV1Response.md +++ b/docs/GlobalEzmaxclientVersionV1Response.md @@ -3,9 +3,11 @@ Response for GET /1/ezmaxclient/{pksEzmaxclientOs}/version ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **s_ezmaxclient_version** | **str** | The version on the store | +**s_ezmaxclient_oslatestversion** | **str** | The latest OS version of the system running the application at the time of release | [default to '11'] ## Example diff --git a/docs/GlobalEzmaxcustomerApi.md b/docs/GlobalEzmaxcustomerApi.md index 9e15ce7f0..17be3f84a 100644 --- a/docs/GlobalEzmaxcustomerApi.md +++ b/docs/GlobalEzmaxcustomerApi.md @@ -16,6 +16,7 @@ Retrieve the ezmaxcustomer's specific configuration. This will help locate the p ### Example + ```python import time import os @@ -50,6 +51,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pks_ezmaxcustomer_code** | **str**| | @@ -68,6 +70,7 @@ No authorization required - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | diff --git a/docs/GlobalEzmaxcustomerGetConfigurationV1Response.md b/docs/GlobalEzmaxcustomerGetConfigurationV1Response.md index 58431dd71..ad8547ebc 100644 --- a/docs/GlobalEzmaxcustomerGetConfigurationV1Response.md +++ b/docs/GlobalEzmaxcustomerGetConfigurationV1Response.md @@ -3,6 +3,7 @@ Response for GET /1/ezmaxcustomer/{pksEzmaxcustomerCode}/getConfiguration ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **s_infrastructureregion_code** | **str** | The region code | diff --git a/docs/HeaderAcceptLanguage.md b/docs/HeaderAcceptLanguage.md index 2aa25c5a1..69f7f6ed5 100644 --- a/docs/HeaderAcceptLanguage.md +++ b/docs/HeaderAcceptLanguage.md @@ -3,6 +3,7 @@ The language of the returned content. 1. **\\*** (or header not defined) Default language 2. **en** English 2. **fr** French ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/InscriptionGetAttachmentsV1Response.md b/docs/InscriptionGetAttachmentsV1Response.md new file mode 100644 index 000000000..d48def1e6 --- /dev/null +++ b/docs/InscriptionGetAttachmentsV1Response.md @@ -0,0 +1,32 @@ +# InscriptionGetAttachmentsV1Response + +Response for GET /1/object/inscription/{pkiInscriptionID}/getAttachments + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | +**obj_debug** | [**CommonResponseObjDebug**](CommonResponseObjDebug.md) | | [optional] +**m_payload** | [**InscriptionGetAttachmentsV1ResponseMPayload**](InscriptionGetAttachmentsV1ResponseMPayload.md) | | + +## Example + +```python +from eZmaxApi.models.inscription_get_attachments_v1_response import InscriptionGetAttachmentsV1Response + +# TODO update the JSON string below +json = "{}" +# create an instance of InscriptionGetAttachmentsV1Response from a JSON string +inscription_get_attachments_v1_response_instance = InscriptionGetAttachmentsV1Response.from_json(json) +# print the JSON string representation of the object +print InscriptionGetAttachmentsV1Response.to_json() + +# convert the object into a dict +inscription_get_attachments_v1_response_dict = inscription_get_attachments_v1_response_instance.to_dict() +# create an instance of InscriptionGetAttachmentsV1Response from a dict +inscription_get_attachments_v1_response_form_dict = inscription_get_attachments_v1_response.from_dict(inscription_get_attachments_v1_response_dict) +``` +[[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/docs/InscriptionGetAttachmentsV1ResponseMPayload.md b/docs/InscriptionGetAttachmentsV1ResponseMPayload.md new file mode 100644 index 000000000..4ccce844b --- /dev/null +++ b/docs/InscriptionGetAttachmentsV1ResponseMPayload.md @@ -0,0 +1,30 @@ +# InscriptionGetAttachmentsV1ResponseMPayload + +Response for GET /1/object/inscription/{pkiInscriptionID}/getAttachments + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**a_obj_attachmentdocumenttype** | [**List[CustomAttachmentdocumenttypeResponse]**](CustomAttachmentdocumenttypeResponse.md) | | + +## Example + +```python +from eZmaxApi.models.inscription_get_attachments_v1_response_m_payload import InscriptionGetAttachmentsV1ResponseMPayload + +# TODO update the JSON string below +json = "{}" +# create an instance of InscriptionGetAttachmentsV1ResponseMPayload from a JSON string +inscription_get_attachments_v1_response_m_payload_instance = InscriptionGetAttachmentsV1ResponseMPayload.from_json(json) +# print the JSON string representation of the object +print InscriptionGetAttachmentsV1ResponseMPayload.to_json() + +# convert the object into a dict +inscription_get_attachments_v1_response_m_payload_dict = inscription_get_attachments_v1_response_m_payload_instance.to_dict() +# create an instance of InscriptionGetAttachmentsV1ResponseMPayload from a dict +inscription_get_attachments_v1_response_m_payload_form_dict = inscription_get_attachments_v1_response_m_payload.from_dict(inscription_get_attachments_v1_response_m_payload_dict) +``` +[[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/docs/InscriptionGetCommunicationListV1Response.md b/docs/InscriptionGetCommunicationListV1Response.md index d0110a9e3..79250ca88 100644 --- a/docs/InscriptionGetCommunicationListV1Response.md +++ b/docs/InscriptionGetCommunicationListV1Response.md @@ -3,6 +3,7 @@ Response for GET /1/object/inscription/{pkiInscriptionID}/getCommunicationList ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayloadGetList**](CommonResponseObjDebugPayloadGetList.md) | | diff --git a/docs/InscriptionGetCommunicationListV1ResponseMPayload.md b/docs/InscriptionGetCommunicationListV1ResponseMPayload.md index 2ff6df09d..6a7f8d157 100644 --- a/docs/InscriptionGetCommunicationListV1ResponseMPayload.md +++ b/docs/InscriptionGetCommunicationListV1ResponseMPayload.md @@ -3,6 +3,7 @@ Response for GET /1/object/inscription/{pkiInscriptionID}/getCommunicationList ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_communication** | [**List[CustomCommunicationListElementResponse]**](CustomCommunicationListElementResponse.md) | | diff --git a/docs/InscriptionGetCommunicationsendersV1Response.md b/docs/InscriptionGetCommunicationsendersV1Response.md new file mode 100644 index 000000000..c0dbca019 --- /dev/null +++ b/docs/InscriptionGetCommunicationsendersV1Response.md @@ -0,0 +1,32 @@ +# InscriptionGetCommunicationsendersV1Response + +Response for GET /1/object/inscription/{pkiInscriptionID}/getCommunicationrecipients + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | +**obj_debug** | [**CommonResponseObjDebug**](CommonResponseObjDebug.md) | | [optional] +**m_payload** | [**InscriptionGetCommunicationsendersV1ResponseMPayload**](InscriptionGetCommunicationsendersV1ResponseMPayload.md) | | + +## Example + +```python +from eZmaxApi.models.inscription_get_communicationsenders_v1_response import InscriptionGetCommunicationsendersV1Response + +# TODO update the JSON string below +json = "{}" +# create an instance of InscriptionGetCommunicationsendersV1Response from a JSON string +inscription_get_communicationsenders_v1_response_instance = InscriptionGetCommunicationsendersV1Response.from_json(json) +# print the JSON string representation of the object +print InscriptionGetCommunicationsendersV1Response.to_json() + +# convert the object into a dict +inscription_get_communicationsenders_v1_response_dict = inscription_get_communicationsenders_v1_response_instance.to_dict() +# create an instance of InscriptionGetCommunicationsendersV1Response from a dict +inscription_get_communicationsenders_v1_response_form_dict = inscription_get_communicationsenders_v1_response.from_dict(inscription_get_communicationsenders_v1_response_dict) +``` +[[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/docs/InscriptionGetCommunicationsendersV1ResponseMPayload.md b/docs/InscriptionGetCommunicationsendersV1ResponseMPayload.md new file mode 100644 index 000000000..75651c60c --- /dev/null +++ b/docs/InscriptionGetCommunicationsendersV1ResponseMPayload.md @@ -0,0 +1,30 @@ +# InscriptionGetCommunicationsendersV1ResponseMPayload + +Response for GET /1/object/inscription/{pkiInscriptionID}/getCommunicationsenders + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**a_obj_communicationsenders** | [**List[CustomCommunicationsenderResponse]**](CustomCommunicationsenderResponse.md) | | + +## Example + +```python +from eZmaxApi.models.inscription_get_communicationsenders_v1_response_m_payload import InscriptionGetCommunicationsendersV1ResponseMPayload + +# TODO update the JSON string below +json = "{}" +# create an instance of InscriptionGetCommunicationsendersV1ResponseMPayload from a JSON string +inscription_get_communicationsenders_v1_response_m_payload_instance = InscriptionGetCommunicationsendersV1ResponseMPayload.from_json(json) +# print the JSON string representation of the object +print InscriptionGetCommunicationsendersV1ResponseMPayload.to_json() + +# convert the object into a dict +inscription_get_communicationsenders_v1_response_m_payload_dict = inscription_get_communicationsenders_v1_response_m_payload_instance.to_dict() +# create an instance of InscriptionGetCommunicationsendersV1ResponseMPayload from a dict +inscription_get_communicationsenders_v1_response_m_payload_form_dict = inscription_get_communicationsenders_v1_response_m_payload.from_dict(inscription_get_communicationsenders_v1_response_m_payload_dict) +``` +[[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/docs/InscriptionnotauthenticatedGetCommunicationListV1Response.md b/docs/InscriptionnotauthenticatedGetCommunicationListV1Response.md index 596bbb0a7..641d8795e 100644 --- a/docs/InscriptionnotauthenticatedGetCommunicationListV1Response.md +++ b/docs/InscriptionnotauthenticatedGetCommunicationListV1Response.md @@ -3,6 +3,7 @@ Response for GET /1/object/inscriptionnotauthenticated/{pkiInscriptionnotauthenticatedID}/getCommunicationList ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayloadGetList**](CommonResponseObjDebugPayloadGetList.md) | | diff --git a/docs/InscriptionnotauthenticatedGetCommunicationListV1ResponseMPayload.md b/docs/InscriptionnotauthenticatedGetCommunicationListV1ResponseMPayload.md index d4548e437..197b9175c 100644 --- a/docs/InscriptionnotauthenticatedGetCommunicationListV1ResponseMPayload.md +++ b/docs/InscriptionnotauthenticatedGetCommunicationListV1ResponseMPayload.md @@ -3,6 +3,7 @@ Response for GET /1/object/inscriptionnotauthenticated/{pkiInscriptionnotauthenticatedID}/getCommunicationList ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_communication** | [**List[CustomCommunicationListElementResponse]**](CustomCommunicationListElementResponse.md) | | diff --git a/docs/InscriptiontempGetCommunicationListV1Response.md b/docs/InscriptiontempGetCommunicationListV1Response.md index 60c84db8d..2cb1b1ba7 100644 --- a/docs/InscriptiontempGetCommunicationListV1Response.md +++ b/docs/InscriptiontempGetCommunicationListV1Response.md @@ -3,6 +3,7 @@ Response for GET /1/object/inscriptiontemp/{pkiInscriptiontempID}/getCommunicationList ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayloadGetList**](CommonResponseObjDebugPayloadGetList.md) | | diff --git a/docs/InscriptiontempGetCommunicationListV1ResponseMPayload.md b/docs/InscriptiontempGetCommunicationListV1ResponseMPayload.md index 2f2153312..2be429f51 100644 --- a/docs/InscriptiontempGetCommunicationListV1ResponseMPayload.md +++ b/docs/InscriptiontempGetCommunicationListV1ResponseMPayload.md @@ -3,6 +3,7 @@ Response for GET /1/object/inscriptiontemp/{pkiInscriptiontempID}/getCommunicationList ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_communication** | [**List[CustomCommunicationListElementResponse]**](CustomCommunicationListElementResponse.md) | | diff --git a/docs/InvoiceGetAttachmentsV1Response.md b/docs/InvoiceGetAttachmentsV1Response.md new file mode 100644 index 000000000..78ac086e6 --- /dev/null +++ b/docs/InvoiceGetAttachmentsV1Response.md @@ -0,0 +1,32 @@ +# InvoiceGetAttachmentsV1Response + +Response for GET /1/object/invoice/{pkiInvoiceID}/getAttachments + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | +**obj_debug** | [**CommonResponseObjDebug**](CommonResponseObjDebug.md) | | [optional] +**m_payload** | [**InvoiceGetAttachmentsV1ResponseMPayload**](InvoiceGetAttachmentsV1ResponseMPayload.md) | | + +## Example + +```python +from eZmaxApi.models.invoice_get_attachments_v1_response import InvoiceGetAttachmentsV1Response + +# TODO update the JSON string below +json = "{}" +# create an instance of InvoiceGetAttachmentsV1Response from a JSON string +invoice_get_attachments_v1_response_instance = InvoiceGetAttachmentsV1Response.from_json(json) +# print the JSON string representation of the object +print InvoiceGetAttachmentsV1Response.to_json() + +# convert the object into a dict +invoice_get_attachments_v1_response_dict = invoice_get_attachments_v1_response_instance.to_dict() +# create an instance of InvoiceGetAttachmentsV1Response from a dict +invoice_get_attachments_v1_response_form_dict = invoice_get_attachments_v1_response.from_dict(invoice_get_attachments_v1_response_dict) +``` +[[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/docs/InvoiceGetAttachmentsV1ResponseMPayload.md b/docs/InvoiceGetAttachmentsV1ResponseMPayload.md new file mode 100644 index 000000000..97944985b --- /dev/null +++ b/docs/InvoiceGetAttachmentsV1ResponseMPayload.md @@ -0,0 +1,30 @@ +# InvoiceGetAttachmentsV1ResponseMPayload + +Response for GET /1/object/invoice/{pkiInvoiceID}/getAttachments + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**a_obj_attachmentdocumenttype** | [**List[CustomAttachmentdocumenttypeResponse]**](CustomAttachmentdocumenttypeResponse.md) | | + +## Example + +```python +from eZmaxApi.models.invoice_get_attachments_v1_response_m_payload import InvoiceGetAttachmentsV1ResponseMPayload + +# TODO update the JSON string below +json = "{}" +# create an instance of InvoiceGetAttachmentsV1ResponseMPayload from a JSON string +invoice_get_attachments_v1_response_m_payload_instance = InvoiceGetAttachmentsV1ResponseMPayload.from_json(json) +# print the JSON string representation of the object +print InvoiceGetAttachmentsV1ResponseMPayload.to_json() + +# convert the object into a dict +invoice_get_attachments_v1_response_m_payload_dict = invoice_get_attachments_v1_response_m_payload_instance.to_dict() +# create an instance of InvoiceGetAttachmentsV1ResponseMPayload from a dict +invoice_get_attachments_v1_response_m_payload_form_dict = invoice_get_attachments_v1_response_m_payload.from_dict(invoice_get_attachments_v1_response_m_payload_dict) +``` +[[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/docs/InvoiceGetCommunicationListV1Response.md b/docs/InvoiceGetCommunicationListV1Response.md index 4704cc4e4..615535fc9 100644 --- a/docs/InvoiceGetCommunicationListV1Response.md +++ b/docs/InvoiceGetCommunicationListV1Response.md @@ -3,6 +3,7 @@ Response for GET /1/object/invoice/{pkiInvoiceID}/getCommunicationList ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayloadGetList**](CommonResponseObjDebugPayloadGetList.md) | | diff --git a/docs/InvoiceGetCommunicationListV1ResponseMPayload.md b/docs/InvoiceGetCommunicationListV1ResponseMPayload.md index 4e889e6fc..3be395ac6 100644 --- a/docs/InvoiceGetCommunicationListV1ResponseMPayload.md +++ b/docs/InvoiceGetCommunicationListV1ResponseMPayload.md @@ -3,6 +3,7 @@ Response for GET /1/object/invoice/{pkiInvoiceID}/getCommunicationList ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_communication** | [**List[CustomCommunicationListElementResponse]**](CustomCommunicationListElementResponse.md) | | diff --git a/docs/LanguageAutocompleteElementResponse.md b/docs/LanguageAutocompleteElementResponse.md index 2a5bf7843..1357345a2 100644 --- a/docs/LanguageAutocompleteElementResponse.md +++ b/docs/LanguageAutocompleteElementResponse.md @@ -3,6 +3,7 @@ A Language AutocompleteElement Response ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_language_id** | **int** | The unique ID of the Language. Valid values: |Value|Description| |-|-| |1|French| |2|English| | diff --git a/docs/LanguageGetAutocompleteV2Response.md b/docs/LanguageGetAutocompleteV2Response.md index ca9d027d8..843400be1 100644 --- a/docs/LanguageGetAutocompleteV2Response.md +++ b/docs/LanguageGetAutocompleteV2Response.md @@ -3,6 +3,7 @@ Response for GET /2/object/language/getAutocomplete ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/LanguageGetAutocompleteV2ResponseMPayload.md b/docs/LanguageGetAutocompleteV2ResponseMPayload.md index 681507d7a..c8893f52d 100644 --- a/docs/LanguageGetAutocompleteV2ResponseMPayload.md +++ b/docs/LanguageGetAutocompleteV2ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for POST /2/object/language/getAutocomplete ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_language** | [**List[LanguageAutocompleteElementResponse]**](LanguageAutocompleteElementResponse.md) | An array of Language autocomplete element response. | diff --git a/docs/ModuleEzsignApi.md b/docs/ModuleEzsignApi.md index ac899a02e..130ba454d 100644 --- a/docs/ModuleEzsignApi.md +++ b/docs/ModuleEzsignApi.md @@ -18,6 +18,7 @@ Retrieve previously used Ezsignsigners and all users from the system ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -60,6 +61,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + This endpoint does not need any parameter. ### Return type @@ -76,6 +78,7 @@ This endpoint does not need any parameter. - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -92,6 +95,7 @@ Retrieve Ezsigntemplates and Ezsigntemplatepackages that can be imported in a Ez ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -136,6 +140,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **fki_ezsignfoldertype_id** | **int**| | [optional] @@ -154,6 +159,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | diff --git a/docs/ModuleReportApi.md b/docs/ModuleReportApi.md index 86ede9e64..36b680cfe 100644 --- a/docs/ModuleReportApi.md +++ b/docs/ModuleReportApi.md @@ -18,6 +18,7 @@ Retrieve a report that was previously generated and cached * Api Key Authentication (Authorization): * Api Key Authentication (Presigned): + ```python import time import os @@ -68,6 +69,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **s_reportgroup_cache_id** | **str**| | @@ -86,6 +88,7 @@ Name | Type | Description | Notes - **Accept**: application/json, application/pdf, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet, application/zip, text/html ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | diff --git a/docs/ModuleResponse.md b/docs/ModuleResponse.md index acd241564..261063ccb 100644 --- a/docs/ModuleResponse.md +++ b/docs/ModuleResponse.md @@ -3,6 +3,7 @@ A Module Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_module_id** | **int** | The unique ID of the Module | diff --git a/docs/ModuleResponseCompound.md b/docs/ModuleResponseCompound.md index 29b2c53e9..b7c93a595 100644 --- a/docs/ModuleResponseCompound.md +++ b/docs/ModuleResponseCompound.md @@ -3,6 +3,7 @@ A Module Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_module_id** | **int** | The unique ID of the Module | diff --git a/docs/ModuleUserApi.md b/docs/ModuleUserApi.md index 243b45097..475fbd645 100644 --- a/docs/ModuleUserApi.md +++ b/docs/ModuleUserApi.md @@ -17,6 +17,7 @@ The endpoint allows to initiate the creation or a user of type Ezsignuser. The ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -62,6 +63,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **user_create_ezsignuser_v1_request** | [**List[UserCreateEzsignuserV1Request]**](UserCreateEzsignuserV1Request.md)| | @@ -80,6 +82,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | diff --git a/docs/ModulegroupGetAllV1Response.md b/docs/ModulegroupGetAllV1Response.md index f54a4ce0f..c85d6e020 100644 --- a/docs/ModulegroupGetAllV1Response.md +++ b/docs/ModulegroupGetAllV1Response.md @@ -3,6 +3,7 @@ Response for GET /1/object/modulegroup/getAll ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/ModulegroupGetAllV1ResponseMPayload.md b/docs/ModulegroupGetAllV1ResponseMPayload.md index 31d91a153..d85764cad 100644 --- a/docs/ModulegroupGetAllV1ResponseMPayload.md +++ b/docs/ModulegroupGetAllV1ResponseMPayload.md @@ -3,6 +3,7 @@ Response for GET /1/object/modulegroup/getAll ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_modulegroup** | [**List[ModulegroupResponseCompound]**](ModulegroupResponseCompound.md) | | diff --git a/docs/ModulegroupResponse.md b/docs/ModulegroupResponse.md index 195544f22..34822e14d 100644 --- a/docs/ModulegroupResponse.md +++ b/docs/ModulegroupResponse.md @@ -3,6 +3,7 @@ A Modulegroup Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_modulegroup_id** | **int** | The unique ID of the Modulegroup | diff --git a/docs/ModulegroupResponseCompound.md b/docs/ModulegroupResponseCompound.md index d66919042..ace9c7ddb 100644 --- a/docs/ModulegroupResponseCompound.md +++ b/docs/ModulegroupResponseCompound.md @@ -3,6 +3,7 @@ A Modulegroup Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_modulegroup_id** | **int** | The unique ID of the Modulegroup | diff --git a/docs/ModulesectionResponse.md b/docs/ModulesectionResponse.md index 3f752fc9e..39bd306b6 100644 --- a/docs/ModulesectionResponse.md +++ b/docs/ModulesectionResponse.md @@ -3,6 +3,7 @@ A Modulesection Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_modulesection_id** | **int** | The unique ID of the Modulesection | diff --git a/docs/ModulesectionResponseCompound.md b/docs/ModulesectionResponseCompound.md index 702bfbb19..081b5aa60 100644 --- a/docs/ModulesectionResponseCompound.md +++ b/docs/ModulesectionResponseCompound.md @@ -3,6 +3,7 @@ A Modulesection Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_modulesection_id** | **int** | The unique ID of the Modulesection | diff --git a/docs/MultilingualApikeyDescription.md b/docs/MultilingualApikeyDescription.md index d571c99aa..3ec6c15ca 100644 --- a/docs/MultilingualApikeyDescription.md +++ b/docs/MultilingualApikeyDescription.md @@ -3,6 +3,7 @@ Description of the API Key ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **s_apikey_description1** | **str** | The description of the Apikey in French | [optional] diff --git a/docs/MultilingualBillingentityinternalDescription.md b/docs/MultilingualBillingentityinternalDescription.md index 0fffb6015..ba0b27d79 100644 --- a/docs/MultilingualBillingentityinternalDescription.md +++ b/docs/MultilingualBillingentityinternalDescription.md @@ -3,6 +3,7 @@ The description of the Billingentityinternal ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **s_billingentityinternal_description1** | **str** | The description of the Billingentityinternal in French | [optional] diff --git a/docs/MultilingualBrandingDescription.md b/docs/MultilingualBrandingDescription.md index 8f1de1d96..63b68cd74 100644 --- a/docs/MultilingualBrandingDescription.md +++ b/docs/MultilingualBrandingDescription.md @@ -3,6 +3,7 @@ Description of the Branding ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **s_branding_description1** | **str** | The description of the Branding in French | [optional] diff --git a/docs/MultilingualEzmaxinvoicingsummaryinternalDescription.md b/docs/MultilingualEzmaxinvoicingsummaryinternalDescription.md index 7698a2ed6..66982d988 100644 --- a/docs/MultilingualEzmaxinvoicingsummaryinternalDescription.md +++ b/docs/MultilingualEzmaxinvoicingsummaryinternalDescription.md @@ -3,6 +3,7 @@ Description of the Ezmaxinvoicingsummaryinternal ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **s_ezmaxinvoicingsummaryinternal_description1** | **str** | The Ezmaxinvoicingsummaryinternal description in French | [optional] diff --git a/docs/MultilingualEzsignfoldertypeName.md b/docs/MultilingualEzsignfoldertypeName.md index d157e8af9..570a553f9 100644 --- a/docs/MultilingualEzsignfoldertypeName.md +++ b/docs/MultilingualEzsignfoldertypeName.md @@ -3,6 +3,7 @@ Name of the Ezsignfoldertype ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **s_ezsignfoldertype_name1** | **str** | The name of the Ezsignfoldertype in French | [optional] diff --git a/docs/MultilingualEzsignsignergroupDescription.md b/docs/MultilingualEzsignsignergroupDescription.md index 5aec792ac..00ea4856f 100644 --- a/docs/MultilingualEzsignsignergroupDescription.md +++ b/docs/MultilingualEzsignsignergroupDescription.md @@ -3,6 +3,7 @@ Description of the Ezsignsignergroup ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **s_ezsignsignergroup_description1** | **str** | The description of the Ezsignsignergroup in French | [optional] diff --git a/docs/MultilingualEzsignsigningreasonDescription.md b/docs/MultilingualEzsignsigningreasonDescription.md new file mode 100644 index 000000000..97f534ed6 --- /dev/null +++ b/docs/MultilingualEzsignsigningreasonDescription.md @@ -0,0 +1,31 @@ +# MultilingualEzsignsigningreasonDescription + +The description of the Ezsignsigningreason + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**s_ezsignsigningreason_description1** | **str** | The description of the Ezsignsigningreason in French | [optional] +**s_ezsignsigningreason_description2** | **str** | The description of the Ezsignsigningreason in English | [optional] + +## Example + +```python +from eZmaxApi.models.multilingual_ezsignsigningreason_description import MultilingualEzsignsigningreasonDescription + +# TODO update the JSON string below +json = "{}" +# create an instance of MultilingualEzsignsigningreasonDescription from a JSON string +multilingual_ezsignsigningreason_description_instance = MultilingualEzsignsigningreasonDescription.from_json(json) +# print the JSON string representation of the object +print MultilingualEzsignsigningreasonDescription.to_json() + +# convert the object into a dict +multilingual_ezsignsigningreason_description_dict = multilingual_ezsignsigningreason_description_instance.to_dict() +# create an instance of MultilingualEzsignsigningreasonDescription from a dict +multilingual_ezsignsigningreason_description_form_dict = multilingual_ezsignsigningreason_description.from_dict(multilingual_ezsignsigningreason_description_dict) +``` +[[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/docs/MultilingualNotificationsubsectionName.md b/docs/MultilingualNotificationsubsectionName.md index ab1d5f4b0..fd1503576 100644 --- a/docs/MultilingualNotificationsubsectionName.md +++ b/docs/MultilingualNotificationsubsectionName.md @@ -3,6 +3,7 @@ Name of the Notificationsubsection ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **s_notificationsubsection_name1** | **str** | The name of the Notificationsubsection in French | [optional] diff --git a/docs/MultilingualNotificationtestName.md b/docs/MultilingualNotificationtestName.md index 38757a5ed..650169416 100644 --- a/docs/MultilingualNotificationtestName.md +++ b/docs/MultilingualNotificationtestName.md @@ -3,6 +3,7 @@ Name of the Notificationtest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **s_notificationtest_name1** | **str** | The name of the Notificationtest in French | [optional] diff --git a/docs/MultilingualPaymenttermDescription.md b/docs/MultilingualPaymenttermDescription.md index df93a682f..cf690234e 100644 --- a/docs/MultilingualPaymenttermDescription.md +++ b/docs/MultilingualPaymenttermDescription.md @@ -3,6 +3,7 @@ Description of the Paymentterm ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **s_paymentterm_description1** | **str** | The description of the Paymentterm in French | [optional] diff --git a/docs/MultilingualSubnetDescription.md b/docs/MultilingualSubnetDescription.md index 67f8105f5..94eefa941 100644 --- a/docs/MultilingualSubnetDescription.md +++ b/docs/MultilingualSubnetDescription.md @@ -3,6 +3,7 @@ The description of the Subnet ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **s_subnet_description1** | **str** | The description of the Subnet in French | [optional] diff --git a/docs/MultilingualUsergroupName.md b/docs/MultilingualUsergroupName.md index 24e911e0d..f9494cfea 100644 --- a/docs/MultilingualUsergroupName.md +++ b/docs/MultilingualUsergroupName.md @@ -3,6 +3,7 @@ The name of the Usergroup ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **s_usergroup_name1** | **str** | The name of the Usergroup in French | [optional] diff --git a/docs/MultilingualVariableexpenseDescription.md b/docs/MultilingualVariableexpenseDescription.md index 02d019374..bd3169f69 100644 --- a/docs/MultilingualVariableexpenseDescription.md +++ b/docs/MultilingualVariableexpenseDescription.md @@ -3,6 +3,7 @@ The description of the Variableexpense ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **s_variableexpense_description1** | **str** | The description of the Variableexpense in French | [optional] diff --git a/docs/MultilingualVersionhistoryDetail.md b/docs/MultilingualVersionhistoryDetail.md index 9db10bc21..82e9992cb 100644 --- a/docs/MultilingualVersionhistoryDetail.md +++ b/docs/MultilingualVersionhistoryDetail.md @@ -3,6 +3,7 @@ Detail of the Versionhistory ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **t_versionhistory_detail1** | **str** | Detail of the Versionhistory in French | [optional] diff --git a/docs/NotificationsectionGetNotificationtestsV1Response.md b/docs/NotificationsectionGetNotificationtestsV1Response.md index f7346cbe6..2a306d00e 100644 --- a/docs/NotificationsectionGetNotificationtestsV1Response.md +++ b/docs/NotificationsectionGetNotificationtestsV1Response.md @@ -3,6 +3,7 @@ Response for GET /1/object/notificationsection/{pkiNotificationsectionID}/getNotificationtests ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/NotificationsectionGetNotificationtestsV1ResponseMPayload.md b/docs/NotificationsectionGetNotificationtestsV1ResponseMPayload.md index c909b44b3..922091437 100644 --- a/docs/NotificationsectionGetNotificationtestsV1ResponseMPayload.md +++ b/docs/NotificationsectionGetNotificationtestsV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for GET /1/object/notificationsection/{pkiNotificationsectionID}/getNotificationtests ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_notificationsubsection** | [**List[CustomNotificationsubsectiongetnotificationtestsResponse]**](CustomNotificationsubsectiongetnotificationtestsResponse.md) | | diff --git a/docs/NotificationsubsectionResponse.md b/docs/NotificationsubsectionResponse.md index d326d7785..b044e8ce1 100644 --- a/docs/NotificationsubsectionResponse.md +++ b/docs/NotificationsubsectionResponse.md @@ -3,6 +3,7 @@ A Notificationsubsection Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_notificationsubsection_id** | **int** | The unique ID of the Notificationsubsection | diff --git a/docs/NotificationtestGetElementsV1Response.md b/docs/NotificationtestGetElementsV1Response.md index 820413f95..802b4ae66 100644 --- a/docs/NotificationtestGetElementsV1Response.md +++ b/docs/NotificationtestGetElementsV1Response.md @@ -3,6 +3,7 @@ Response for GET /1/object/notificationtest/{pkiNotificationtestID}/getElements ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/NotificationtestGetElementsV1ResponseMPayload.md b/docs/NotificationtestGetElementsV1ResponseMPayload.md index 4294723b1..53774e1a6 100644 --- a/docs/NotificationtestGetElementsV1ResponseMPayload.md +++ b/docs/NotificationtestGetElementsV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for GET /1/object/notificationtest/{pkiNotificationtestID}/getElements ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_notificationtest_id** | **int** | The unique ID of the Notificationtest | diff --git a/docs/NotificationtestResponse.md b/docs/NotificationtestResponse.md index 4df80a639..9a290698d 100644 --- a/docs/NotificationtestResponse.md +++ b/docs/NotificationtestResponse.md @@ -3,6 +3,7 @@ A Notificationtest Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_notificationtest_id** | **int** | The unique ID of the Notificationtest | diff --git a/docs/ObjectActivesessionApi.md b/docs/ObjectActivesessionApi.md index 0e86bf698..6d65c690b 100644 --- a/docs/ObjectActivesessionApi.md +++ b/docs/ObjectActivesessionApi.md @@ -18,6 +18,7 @@ Retrieve the details about the current activesession ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -60,6 +61,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + This endpoint does not need any parameter. ### Return type @@ -76,6 +78,7 @@ This endpoint does not need any parameter. - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | OK | - | @@ -97,6 +100,7 @@ Retrieve Activesession list ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -146,6 +150,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **e_order_by** | **str**| Specify how you want the results to be sorted | [optional] @@ -168,6 +173,7 @@ Name | Type | Description | Notes - **Accept**: application/json, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | diff --git a/docs/ObjectApikeyApi.md b/docs/ObjectApikeyApi.md index faf88dba2..252270975 100644 --- a/docs/ObjectApikeyApi.md +++ b/docs/ObjectApikeyApi.md @@ -25,6 +25,7 @@ The endpoint allows to create one or many elements at once. ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -70,6 +71,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **apikey_create_object_v2_request** | [**ApikeyCreateObjectV2Request**](ApikeyCreateObjectV2Request.md)| | @@ -88,6 +90,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **201** | Successful response | - | @@ -104,6 +107,7 @@ Edit an existing Apikey ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -150,6 +154,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_apikey_id** | **int**| The unique ID of the Apikey | @@ -169,6 +174,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -187,6 +193,7 @@ Using this endpoint, you can edit multiple Permissions at the same time. ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -233,6 +240,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_apikey_id** | **int**| | @@ -252,6 +260,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -268,6 +277,7 @@ Retrieve an existing Apikey's cors ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -312,6 +322,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_apikey_id** | **int**| | @@ -330,6 +341,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -347,6 +359,7 @@ Enum values that can be filtered in query parameter *sFilter*: | Variable | Val ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -396,6 +409,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **e_order_by** | **str**| Specify how you want the results to be sorted | [optional] @@ -418,6 +432,7 @@ Name | Type | Description | Notes - **Accept**: application/json, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -435,6 +450,7 @@ Retrieve an existing Apikey ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -479,6 +495,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_apikey_id** | **int**| The unique ID of the Apikey | @@ -497,6 +514,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -512,6 +530,7 @@ Retrieve an existing Apikey's Permissions ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -556,6 +575,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_apikey_id** | **int**| | @@ -574,6 +594,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -589,6 +610,7 @@ Retrieve an existing Apikey's subnets ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -633,6 +655,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_apikey_id** | **int**| | @@ -651,6 +674,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -668,6 +692,7 @@ Regenerate the Apikey ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -714,6 +739,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_apikey_id** | **int**| | @@ -733,6 +759,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | diff --git a/docs/ObjectAttachmentApi.md b/docs/ObjectAttachmentApi.md index e344be590..d2ba399cb 100644 --- a/docs/ObjectAttachmentApi.md +++ b/docs/ObjectAttachmentApi.md @@ -5,10 +5,12 @@ All URIs are relative to *https://prod.api.appcluster01.ca-central-1.ezmax.com/r Method | HTTP request | Description ------------- | ------------- | ------------- [**attachment_download_v1**](ObjectAttachmentApi.md#attachment_download_v1) | **GET** /1/object/attachment/{pkiAttachmentID}/download | Retrieve the content +[**attachment_get_attachmentlogs_v1**](ObjectAttachmentApi.md#attachment_get_attachmentlogs_v1) | **GET** /1/object/attachment/{pkiAttachmentID}/getAttachmentlogs | Retrieve the Attachmentlogs +[**attachment_get_download_url_v1**](ObjectAttachmentApi.md#attachment_get_download_url_v1) | **GET** /1/object/attachment/{pkiAttachmentID}/getDownloadUrl | Retrieve a URL to download attachments. # **attachment_download_v1** -> AttachmentDownloadV1Response attachment_download_v1(pki_attachment_id) +> attachment_download_v1(pki_attachment_id) Retrieve the content @@ -17,11 +19,12 @@ Using this endpoint, you can retrieve the content of an attachment. ### Example * Api Key Authentication (Authorization): +* Api Key Authentication (Presigned): + ```python import time import os import eZmaxApi -from eZmaxApi.models.attachment_download_v1_response import AttachmentDownloadV1Response from eZmaxApi.rest import ApiException from pprint import pprint @@ -42,6 +45,12 @@ configuration.api_key['Authorization'] = os.environ["API_KEY"] # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed # configuration.api_key_prefix['Authorization'] = 'Bearer' +# Configure API key authorization: Presigned +configuration.api_key['Presigned'] = os.environ["API_KEY"] + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['Presigned'] = 'Bearer' + # Enter a context with an instance of the API client with eZmaxApi.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -50,9 +59,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: try: # Retrieve the content - api_response = api_instance.attachment_download_v1(pki_attachment_id) - print("The response of ObjectAttachmentApi->attachment_download_v1:\n") - pprint(api_response) + api_instance.attachment_download_v1(pki_attachment_id) except Exception as e: print("Exception when calling ObjectAttachmentApi->attachment_download_v1: %s\n" % e) ``` @@ -61,13 +68,178 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_attachment_id** | **int**| | ### Return type -[**AttachmentDownloadV1Response**](AttachmentDownloadV1Response.md) +void (empty response body) + +### Authorization + +[Authorization](../README.md#Authorization), [Presigned](../README.md#Presigned) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**302** | The user has been redirected | - | +**404** | The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **attachment_get_attachmentlogs_v1** +> AttachmentGetAttachmentlogsV1Response attachment_get_attachmentlogs_v1(pki_attachment_id) + +Retrieve the Attachmentlogs + +Using this endpoint, you can retrieve the Attachmentlogs of an attachment. + +### Example + +* Api Key Authentication (Authorization): + +```python +import time +import os +import eZmaxApi +from eZmaxApi.models.attachment_get_attachmentlogs_v1_response import AttachmentGetAttachmentlogsV1Response +from eZmaxApi.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest +# See configuration.py for a list of all supported configuration parameters. +configuration = eZmaxApi.Configuration( + host = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: Authorization +configuration.api_key['Authorization'] = os.environ["API_KEY"] + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['Authorization'] = 'Bearer' + +# Enter a context with an instance of the API client +with eZmaxApi.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = eZmaxApi.ObjectAttachmentApi(api_client) + pki_attachment_id = 56 # int | + + try: + # Retrieve the Attachmentlogs + api_response = api_instance.attachment_get_attachmentlogs_v1(pki_attachment_id) + print("The response of ObjectAttachmentApi->attachment_get_attachmentlogs_v1:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ObjectAttachmentApi->attachment_get_attachmentlogs_v1: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pki_attachment_id** | **int**| | + +### Return type + +[**AttachmentGetAttachmentlogsV1Response**](AttachmentGetAttachmentlogsV1Response.md) + +### Authorization + +[Authorization](../README.md#Authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Successful response | - | +**404** | The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **attachment_get_download_url_v1** +> AttachmentGetDownloadUrlV1Response attachment_get_download_url_v1(pki_attachment_id) + +Retrieve a URL to download attachments. + +This endpoint returns an URL to download the attachment. These links will expire after 5 minutes so the download of the file should be made soon after retrieving the link. + +### Example + +* Api Key Authentication (Authorization): + +```python +import time +import os +import eZmaxApi +from eZmaxApi.models.attachment_get_download_url_v1_response import AttachmentGetDownloadUrlV1Response +from eZmaxApi.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest +# See configuration.py for a list of all supported configuration parameters. +configuration = eZmaxApi.Configuration( + host = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: Authorization +configuration.api_key['Authorization'] = os.environ["API_KEY"] + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['Authorization'] = 'Bearer' + +# Enter a context with an instance of the API client +with eZmaxApi.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = eZmaxApi.ObjectAttachmentApi(api_client) + pki_attachment_id = 56 # int | + + try: + # Retrieve a URL to download attachments. + api_response = api_instance.attachment_get_download_url_v1(pki_attachment_id) + print("The response of ObjectAttachmentApi->attachment_get_download_url_v1:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ObjectAttachmentApi->attachment_get_download_url_v1: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pki_attachment_id** | **int**| | + +### Return type + +[**AttachmentGetDownloadUrlV1Response**](AttachmentGetDownloadUrlV1Response.md) ### Authorization @@ -79,6 +251,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | diff --git a/docs/ObjectBillingentityexternalApi.md b/docs/ObjectBillingentityexternalApi.md index 2c606099d..11713b544 100644 --- a/docs/ObjectBillingentityexternalApi.md +++ b/docs/ObjectBillingentityexternalApi.md @@ -17,6 +17,7 @@ Get the list of Billingentityexternal to be used in a dropdown or autocomplete c ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -65,6 +66,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **s_selector** | **str**| The type of Billingentityexternals to return | @@ -86,6 +88,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | diff --git a/docs/ObjectBillingentityinternalApi.md b/docs/ObjectBillingentityinternalApi.md index 18da45c6c..c5680210a 100644 --- a/docs/ObjectBillingentityinternalApi.md +++ b/docs/ObjectBillingentityinternalApi.md @@ -21,6 +21,7 @@ The endpoint allows to create one or many elements at once. ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -66,6 +67,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **billingentityinternal_create_object_v1_request** | [**BillingentityinternalCreateObjectV1Request**](BillingentityinternalCreateObjectV1Request.md)| | @@ -84,6 +86,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **201** | Successful response | - | @@ -100,6 +103,7 @@ Edit an existing Billingentityinternal ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -146,6 +150,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_billingentityinternal_id** | **int**| | @@ -165,6 +170,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -183,6 +189,7 @@ Get the list of Billingentityinternal to be used in a dropdown or autocomplete c ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -231,6 +238,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **s_selector** | **str**| The type of Billingentityinternals to return | @@ -252,6 +260,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -268,6 +277,7 @@ Retrieve Billingentityinternal list ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -317,6 +327,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **e_order_by** | **str**| Specify how you want the results to be sorted | [optional] @@ -339,6 +350,7 @@ Name | Type | Description | Notes - **Accept**: application/json, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -356,6 +368,7 @@ Retrieve an existing Billingentityinternal ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -400,6 +413,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_billingentityinternal_id** | **int**| | @@ -418,6 +432,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | diff --git a/docs/ObjectBrandingApi.md b/docs/ObjectBrandingApi.md index 6b209e05e..edcaa7d7e 100644 --- a/docs/ObjectBrandingApi.md +++ b/docs/ObjectBrandingApi.md @@ -21,6 +21,7 @@ The endpoint allows to create one or many elements at once. ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -66,6 +67,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **branding_create_object_v1_request** | [**BrandingCreateObjectV1Request**](BrandingCreateObjectV1Request.md)| | @@ -84,6 +86,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **201** | Successful response | - | @@ -100,6 +103,7 @@ Edit an existing Branding ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -146,6 +150,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_branding_id** | **int**| | @@ -165,6 +170,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -182,6 +188,7 @@ Get the list of Branding to be used in a dropdown or autocomplete control. ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -230,6 +237,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **s_selector** | **str**| The type of Brandings to return | @@ -251,6 +259,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -267,6 +276,7 @@ Enum values that can be filtered in query parameter *sFilter*: | Variable | Val ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -316,6 +326,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **e_order_by** | **str**| Specify how you want the results to be sorted | [optional] @@ -338,6 +349,7 @@ Name | Type | Description | Notes - **Accept**: application/json, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -355,6 +367,7 @@ Retrieve an existing Branding ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -399,6 +412,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_branding_id** | **int**| | @@ -417,6 +431,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | diff --git a/docs/ObjectBuyercontractApi.md b/docs/ObjectBuyercontractApi.md index 77929b65e..507a88c3b 100644 --- a/docs/ObjectBuyercontractApi.md +++ b/docs/ObjectBuyercontractApi.md @@ -17,6 +17,7 @@ Retrieve Communication list ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -61,6 +62,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_buyercontract_id** | **int**| | @@ -79,6 +81,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | diff --git a/docs/ObjectClonehistoryApi.md b/docs/ObjectClonehistoryApi.md index d5bb1b38b..e6b1a9081 100644 --- a/docs/ObjectClonehistoryApi.md +++ b/docs/ObjectClonehistoryApi.md @@ -17,6 +17,7 @@ Retrieve Clonehistory list ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -66,6 +67,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **e_order_by** | **str**| Specify how you want the results to be sorted | [optional] @@ -88,6 +90,7 @@ Name | Type | Description | Notes - **Accept**: application/json, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | diff --git a/docs/ObjectCommunicationApi.md b/docs/ObjectCommunicationApi.md index b0584ddf0..ed74e28e8 100644 --- a/docs/ObjectCommunicationApi.md +++ b/docs/ObjectCommunicationApi.md @@ -17,6 +17,7 @@ The endpoint allows to send one or many elements at once. ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -62,6 +63,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **communication_send_v1_request** | [**CommunicationSendV1Request**](CommunicationSendV1Request.md)| | @@ -80,6 +82,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **201** | Successful response | - | diff --git a/docs/ObjectCompanyApi.md b/docs/ObjectCompanyApi.md index 6105e91d5..1165321ae 100644 --- a/docs/ObjectCompanyApi.md +++ b/docs/ObjectCompanyApi.md @@ -17,6 +17,7 @@ Get the list of Company to be used in a dropdown or autocomplete control. ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -65,6 +66,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **s_selector** | **str**| The type of Companys to return | @@ -86,6 +88,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | diff --git a/docs/ObjectCorsApi.md b/docs/ObjectCorsApi.md index 98da93a54..abf612e40 100644 --- a/docs/ObjectCorsApi.md +++ b/docs/ObjectCorsApi.md @@ -20,6 +20,7 @@ The endpoint allows to create one or many elements at once. ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -65,6 +66,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **cors_create_object_v1_request** | [**CorsCreateObjectV1Request**](CorsCreateObjectV1Request.md)| | @@ -83,6 +85,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **201** | Successful response | - | @@ -99,6 +102,7 @@ Delete an existing Cors ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -143,6 +147,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_cors_id** | **int**| The unique ID of the Cors | @@ -161,6 +166,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -178,6 +184,7 @@ Edit an existing Cors ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -224,6 +231,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_cors_id** | **int**| The unique ID of the Cors | @@ -243,6 +251,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -261,6 +270,7 @@ Retrieve an existing Cors ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -305,6 +315,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_cors_id** | **int**| The unique ID of the Cors | @@ -323,6 +334,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | diff --git a/docs/ObjectDepartmentApi.md b/docs/ObjectDepartmentApi.md index 2b45197b3..a9445abbf 100644 --- a/docs/ObjectDepartmentApi.md +++ b/docs/ObjectDepartmentApi.md @@ -17,6 +17,7 @@ Get the list of Department to be used in a dropdown or autocomplete control. ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -65,6 +66,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **s_selector** | **str**| The type of Departments to return | @@ -86,6 +88,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | diff --git a/docs/ObjectElectronicfundstransferApi.md b/docs/ObjectElectronicfundstransferApi.md index 0bb7b0486..fd7dbac00 100644 --- a/docs/ObjectElectronicfundstransferApi.md +++ b/docs/ObjectElectronicfundstransferApi.md @@ -4,11 +4,11 @@ All URIs are relative to *https://prod.api.appcluster01.ca-central-1.ezmax.com/r Method | HTTP request | Description ------------- | ------------- | ------------- -[**eletronicfundstransfer_get_communication_list_v1**](ObjectElectronicfundstransferApi.md#eletronicfundstransfer_get_communication_list_v1) | **GET** /1/object/electronicfundstransfer/{pkiElectronicfundstransferID}/getCommunicationList | Retrieve Communication list +[**electronicfundstransfer_get_communication_list_v1**](ObjectElectronicfundstransferApi.md#electronicfundstransfer_get_communication_list_v1) | **GET** /1/object/electronicfundstransfer/{pkiElectronicfundstransferID}/getCommunicationList | Retrieve Communication list -# **eletronicfundstransfer_get_communication_list_v1** -> ElectronicfundstransferGetCommunicationListV1Response eletronicfundstransfer_get_communication_list_v1(pki_electronicfundstransfer_id) +# **electronicfundstransfer_get_communication_list_v1** +> ElectronicfundstransferGetCommunicationListV1Response electronicfundstransfer_get_communication_list_v1(pki_electronicfundstransfer_id) Retrieve Communication list @@ -17,6 +17,7 @@ Retrieve Communication list ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -50,17 +51,18 @@ with eZmaxApi.ApiClient(configuration) as api_client: try: # Retrieve Communication list - api_response = api_instance.eletronicfundstransfer_get_communication_list_v1(pki_electronicfundstransfer_id) - print("The response of ObjectElectronicfundstransferApi->eletronicfundstransfer_get_communication_list_v1:\n") + api_response = api_instance.electronicfundstransfer_get_communication_list_v1(pki_electronicfundstransfer_id) + print("The response of ObjectElectronicfundstransferApi->electronicfundstransfer_get_communication_list_v1:\n") pprint(api_response) except Exception as e: - print("Exception when calling ObjectElectronicfundstransferApi->eletronicfundstransfer_get_communication_list_v1: %s\n" % e) + print("Exception when calling ObjectElectronicfundstransferApi->electronicfundstransfer_get_communication_list_v1: %s\n" % e) ``` ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_electronicfundstransfer_id** | **int**| | @@ -79,6 +81,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | diff --git a/docs/ObjectEmailtypeApi.md b/docs/ObjectEmailtypeApi.md index 3688ec6bc..42f54866c 100644 --- a/docs/ObjectEmailtypeApi.md +++ b/docs/ObjectEmailtypeApi.md @@ -17,6 +17,7 @@ Get the list of Emailtype to be used in a dropdown or autocomplete control. ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -65,6 +66,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **s_selector** | **str**| The type of Emailtypes to return | @@ -86,6 +88,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | diff --git a/docs/ObjectEzmaxinvoicingApi.md b/docs/ObjectEzmaxinvoicingApi.md index 9b5155a85..dd7b5b6df 100644 --- a/docs/ObjectEzmaxinvoicingApi.md +++ b/docs/ObjectEzmaxinvoicingApi.md @@ -20,6 +20,7 @@ Get the list of Ezmaxinvoicing to be used in a dropdown or autocomplete control. ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -68,6 +69,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **s_selector** | **str**| The type of Ezmaxinvoicings to return | @@ -89,6 +91,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -105,6 +108,7 @@ Get the list of Ezmaxinvoicing to be used in a dropdown or autocomplete control. ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -153,6 +157,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **s_selector** | **str**| The type of Ezmaxinvoicings to return | @@ -174,6 +179,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -190,6 +196,7 @@ Retrieve an existing Ezmaxinvoicing ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -234,6 +241,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezmaxinvoicing_id** | **int**| | @@ -252,6 +260,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -269,6 +278,7 @@ Retrieve provisional Ezmaxinvoicing ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -311,6 +321,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + This endpoint does not need any parameter. ### Return type @@ -327,6 +338,7 @@ This endpoint does not need any parameter. - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | diff --git a/docs/ObjectEzmaxproductApi.md b/docs/ObjectEzmaxproductApi.md index ebcc4813b..cd4481876 100644 --- a/docs/ObjectEzmaxproductApi.md +++ b/docs/ObjectEzmaxproductApi.md @@ -17,6 +17,7 @@ Get the list of Ezmaxproduct to be used in a dropdown or autocomplete control. ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -65,6 +66,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **s_selector** | **str**| The type of Ezmaxproducts to return | @@ -86,6 +88,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | diff --git a/docs/ObjectEzsignbulksendApi.md b/docs/ObjectEzsignbulksendApi.md index fbbfdb9c8..ac190f884 100644 --- a/docs/ObjectEzsignbulksendApi.md +++ b/docs/ObjectEzsignbulksendApi.md @@ -25,6 +25,7 @@ Create a new Ezsignbulksendtransmission in the Ezsignbulksend ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -71,6 +72,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsignbulksend_id** | **int**| | @@ -90,6 +92,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -108,6 +111,7 @@ The endpoint allows to create one or many elements at once. ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -153,6 +157,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ezsignbulksend_create_object_v1_request** | [**EzsignbulksendCreateObjectV1Request**](EzsignbulksendCreateObjectV1Request.md)| | @@ -171,6 +176,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **201** | Successful response | - | @@ -187,6 +193,7 @@ Delete an existing Ezsignbulksend ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -231,6 +238,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsignbulksend_id** | **int**| | @@ -249,6 +257,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -267,6 +276,7 @@ Edit an existing Ezsignbulksend ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -313,6 +323,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsignbulksend_id** | **int**| | @@ -332,6 +343,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -350,6 +362,7 @@ Retrieve an existing Ezsignbulksend's empty Csv template ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -394,6 +407,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsignbulksend_id** | **int**| | @@ -413,6 +427,7 @@ Name | Type | Description | Notes - **Accept**: text/csv, application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -432,6 +447,7 @@ Retrieve an existing Ezsignbulksend's Ezsignbulksendtransmissions ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -476,6 +492,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsignbulksend_id** | **int**| | @@ -494,6 +511,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -511,6 +529,7 @@ Return the Ezsignsignatures that can be signed by the current user at the curren ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -555,6 +574,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsignbulksend_id** | **int**| | @@ -573,6 +593,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -590,6 +611,7 @@ Retrieve an existing Ezsignbulksend's forms data ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -634,6 +656,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsignbulksend_id** | **int**| | @@ -652,6 +675,7 @@ Name | Type | Description | Notes - **Accept**: application/json, application/zip ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -671,6 +695,7 @@ Enum values that can be filtered in query parameter *sFilter*: | Variable | Val ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -720,6 +745,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **e_order_by** | **str**| Specify how you want the results to be sorted | [optional] @@ -742,6 +768,7 @@ Name | Type | Description | Notes - **Accept**: application/json, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -759,6 +786,7 @@ Retrieve an existing Ezsignbulksend ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -803,6 +831,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsignbulksend_id** | **int**| | @@ -821,6 +850,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -836,6 +866,7 @@ Reorder Ezsignbulksenddocumentmappings in the Ezsignbulksend ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -882,6 +913,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsignbulksend_id** | **int**| | @@ -901,6 +933,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | diff --git a/docs/ObjectEzsignbulksenddocumentmappingApi.md b/docs/ObjectEzsignbulksenddocumentmappingApi.md index 613e27514..5ac846c90 100644 --- a/docs/ObjectEzsignbulksenddocumentmappingApi.md +++ b/docs/ObjectEzsignbulksenddocumentmappingApi.md @@ -19,6 +19,7 @@ The endpoint allows to create one or many elements at once. ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -64,6 +65,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ezsignbulksenddocumentmapping_create_object_v1_request** | [**EzsignbulksenddocumentmappingCreateObjectV1Request**](EzsignbulksenddocumentmappingCreateObjectV1Request.md)| | @@ -82,6 +84,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **201** | Successful response | - | @@ -99,6 +102,7 @@ Delete an existing Ezsignbulksenddocumentmapping ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -143,6 +147,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsignbulksenddocumentmapping_id** | **int**| | @@ -161,6 +166,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -178,6 +184,7 @@ Retrieve an existing Ezsignbulksenddocumentmapping ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -222,6 +229,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsignbulksenddocumentmapping_id** | **int**| | @@ -240,6 +248,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | diff --git a/docs/ObjectEzsignbulksendsignermappingApi.md b/docs/ObjectEzsignbulksendsignermappingApi.md index c10035783..fc3770524 100644 --- a/docs/ObjectEzsignbulksendsignermappingApi.md +++ b/docs/ObjectEzsignbulksendsignermappingApi.md @@ -19,6 +19,7 @@ The endpoint allows to create one or many elements at once. ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -64,6 +65,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ezsignbulksendsignermapping_create_object_v1_request** | [**EzsignbulksendsignermappingCreateObjectV1Request**](EzsignbulksendsignermappingCreateObjectV1Request.md)| | @@ -82,6 +84,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **201** | Successful response | - | @@ -98,6 +101,7 @@ Delete an existing Ezsignbulksendsignermapping ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -142,6 +146,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsignbulksendsignermapping_id** | **int**| | @@ -160,6 +165,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -177,6 +183,7 @@ Retrieve an existing Ezsignbulksendsignermapping ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -221,6 +228,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsignbulksendsignermapping_id** | **int**| | @@ -239,6 +247,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | diff --git a/docs/ObjectEzsignbulksendtransmissionApi.md b/docs/ObjectEzsignbulksendtransmissionApi.md index ee48f4c08..3915671db 100644 --- a/docs/ObjectEzsignbulksendtransmissionApi.md +++ b/docs/ObjectEzsignbulksendtransmissionApi.md @@ -20,6 +20,7 @@ Retrieve an existing Ezsignbulksendtransmission's Csv containing errors ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -63,6 +64,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsignbulksendtransmission_id** | **int**| | @@ -81,6 +83,7 @@ Name | Type | Description | Notes - **Accept**: text/csv, application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -100,6 +103,7 @@ Return the Ezsignsignatures that can be signed by the current user at the curren ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -144,6 +148,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsignbulksendtransmission_id** | **int**| | @@ -162,6 +167,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -179,6 +185,7 @@ Retrieve an existing Ezsignbulksendtransmission's forms data ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -223,6 +230,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsignbulksendtransmission_id** | **int**| | @@ -241,6 +249,7 @@ Name | Type | Description | Notes - **Accept**: application/json, application/zip ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -260,6 +269,7 @@ Retrieve an existing Ezsignbulksendtransmission ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -304,6 +314,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsignbulksendtransmission_id** | **int**| | @@ -322,6 +333,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | diff --git a/docs/ObjectEzsigndocumentApi.md b/docs/ObjectEzsigndocumentApi.md index 412a3e62b..f164c5d05 100644 --- a/docs/ObjectEzsigndocumentApi.md +++ b/docs/ObjectEzsigndocumentApi.md @@ -15,6 +15,7 @@ Method | HTTP request | Description [**ezsigndocument_end_prematurely_v1**](ObjectEzsigndocumentApi.md#ezsigndocument_end_prematurely_v1) | **POST** /1/object/ezsigndocument/{pkiEzsigndocumentID}/endPrematurely | End prematurely [**ezsigndocument_flatten_v1**](ObjectEzsigndocumentApi.md#ezsigndocument_flatten_v1) | **POST** /1/object/ezsigndocument/{pkiEzsigndocumentID}/flatten | Flatten [**ezsigndocument_get_actionable_elements_v1**](ObjectEzsigndocumentApi.md#ezsigndocument_get_actionable_elements_v1) | **GET** /1/object/ezsigndocument/{pkiEzsigndocumentID}/getActionableElements | Retrieve actionable elements for the Ezsigndocument +[**ezsigndocument_get_attachments_v1**](ObjectEzsigndocumentApi.md#ezsigndocument_get_attachments_v1) | **GET** /1/object/ezsigndocument/{pkiEzsigndocumentID}/getAttachments | Retrieve Ezsigndocument's Attachments [**ezsigndocument_get_completed_elements_v1**](ObjectEzsigndocumentApi.md#ezsigndocument_get_completed_elements_v1) | **GET** /1/object/ezsigndocument/{pkiEzsigndocumentID}/getCompletedElements | Retrieve completed elements for the Ezsigndocument [**ezsigndocument_get_download_url_v1**](ObjectEzsigndocumentApi.md#ezsigndocument_get_download_url_v1) | **GET** /1/object/ezsigndocument/{pkiEzsigndocumentID}/getDownloadUrl/{eDocumentType} | Retrieve a URL to download documents. [**ezsigndocument_get_ezsignannotations_v1**](ObjectEzsigndocumentApi.md#ezsigndocument_get_ezsignannotations_v1) | **GET** /1/object/ezsigndocument/{pkiEzsigndocumentID}/getEzsignannotations | Retrieve an existing Ezsigndocument's Ezsignannotations @@ -42,6 +43,7 @@ This function is deprecated. Please use *applyEzsigntemplate* instead which is d ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -88,6 +90,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsigndocument_id** | **int**| | @@ -107,6 +110,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -125,6 +129,7 @@ This endpoint applies a predefined template to the ezsign document. This allows ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -171,6 +176,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsigndocument_id** | **int**| | @@ -190,6 +196,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -208,6 +215,7 @@ The endpoint allows to create one or many elements at once. The array can conta ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -253,6 +261,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ezsigndocument_create_object_v1_request** | [**List[EzsigndocumentCreateObjectV1Request]**](EzsigndocumentCreateObjectV1Request.md)| | @@ -271,6 +280,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **201** | Successful response | - | @@ -288,6 +298,7 @@ The endpoint allows to create one or many elements at once. ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -333,6 +344,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ezsigndocument_create_object_v2_request** | [**EzsigndocumentCreateObjectV2Request**](EzsigndocumentCreateObjectV2Request.md)| | @@ -351,6 +363,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **201** | Successful response | - | @@ -368,6 +381,7 @@ Decline to sign ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -414,6 +428,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsigndocument_id** | **int**| | @@ -433,6 +448,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -451,6 +467,7 @@ Delete an existing Ezsigndocument ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -495,6 +512,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsigndocument_id** | **int**| | @@ -513,6 +531,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -531,6 +550,7 @@ Using this endpoint, you can edit multiple Ezsignformfieldgroups at the same tim ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -577,6 +597,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsigndocument_id** | **int**| | @@ -596,6 +617,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -614,6 +636,7 @@ Using this endpoint, you can edit multiple Ezsignsignatures at the same time. ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -660,6 +683,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsigndocument_id** | **int**| | @@ -679,6 +703,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -697,6 +722,7 @@ End prematurely an Ezsigndocument when some signatures are still required ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -742,6 +768,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsigndocument_id** | **int**| | @@ -761,6 +788,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -779,6 +807,7 @@ Flatten an Ezsigndocument signatures, forms and annotations. This process finali ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -824,6 +853,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsigndocument_id** | **int**| | @@ -843,6 +873,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -861,6 +892,7 @@ Return the Ezsignsignatures that can be signed and Ezsignformfieldgroups that ca ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -905,6 +937,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsigndocument_id** | **int**| | @@ -923,6 +956,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -931,6 +965,88 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +# **ezsigndocument_get_attachments_v1** +> EzsigndocumentGetAttachmentsV1Response ezsigndocument_get_attachments_v1(pki_ezsigndocument_id) + +Retrieve Ezsigndocument's Attachments + + + +### Example + +* Api Key Authentication (Authorization): + +```python +import time +import os +import eZmaxApi +from eZmaxApi.models.ezsigndocument_get_attachments_v1_response import EzsigndocumentGetAttachmentsV1Response +from eZmaxApi.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest +# See configuration.py for a list of all supported configuration parameters. +configuration = eZmaxApi.Configuration( + host = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: Authorization +configuration.api_key['Authorization'] = os.environ["API_KEY"] + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['Authorization'] = 'Bearer' + +# Enter a context with an instance of the API client +with eZmaxApi.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = eZmaxApi.ObjectEzsigndocumentApi(api_client) + pki_ezsigndocument_id = 56 # int | + + try: + # Retrieve Ezsigndocument's Attachments + api_response = api_instance.ezsigndocument_get_attachments_v1(pki_ezsigndocument_id) + print("The response of ObjectEzsigndocumentApi->ezsigndocument_get_attachments_v1:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ObjectEzsigndocumentApi->ezsigndocument_get_attachments_v1: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pki_ezsigndocument_id** | **int**| | + +### Return type + +[**EzsigndocumentGetAttachmentsV1Response**](EzsigndocumentGetAttachmentsV1Response.md) + +### Authorization + +[Authorization](../README.md#Authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Successful response | - | +**404** | The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + # **ezsigndocument_get_completed_elements_v1** > EzsigndocumentGetCompletedElementsV1Response ezsigndocument_get_completed_elements_v1(pki_ezsigndocument_id) @@ -941,6 +1057,7 @@ Return the completed Ezsignsignatures, Ezsignformfieldgroups and Ezsignannotatio ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -985,6 +1102,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsigndocument_id** | **int**| | @@ -1003,6 +1121,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -1021,6 +1140,7 @@ This endpoint returns URLs to different files that can be downloaded during the ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -1066,6 +1186,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsigndocument_id** | **int**| | @@ -1085,6 +1206,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -1103,6 +1225,7 @@ Retrieve an existing Ezsigndocument's Ezsignannotations ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -1147,6 +1270,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsigndocument_id** | **int**| | @@ -1165,6 +1289,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -1183,6 +1308,7 @@ Retrieve an existing Ezsigndocument's Ezsignformfieldgroups ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -1227,6 +1353,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsigndocument_id** | **int**| | @@ -1245,6 +1372,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -1263,6 +1391,7 @@ Retrieve an existing Ezsigndocument's Ezsignpages ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -1307,6 +1436,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsigndocument_id** | **int**| | @@ -1325,6 +1455,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -1343,6 +1474,7 @@ Return the Ezsignsignatures that can be signed by the current user at the curren ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -1387,6 +1519,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsigndocument_id** | **int**| | @@ -1405,6 +1538,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -1422,6 +1556,7 @@ Retrieve an existing Ezsigndocument's Ezsignsignatures ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -1466,6 +1601,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsigndocument_id** | **int**| | @@ -1484,6 +1620,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -1502,6 +1639,7 @@ Retrieve an existing Ezsigndocument's Form Data ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -1546,6 +1684,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsigndocument_id** | **int**| | @@ -1564,6 +1703,7 @@ Name | Type | Description | Notes - **Accept**: application/json, application/zip, text/csv ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -1581,6 +1721,7 @@ Retrieve an existing Ezsigndocument ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -1625,6 +1766,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsigndocument_id** | **int**| | @@ -1643,6 +1785,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -1660,6 +1803,7 @@ Retrieve an existing Ezsigndocument ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -1704,6 +1848,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsigndocument_id** | **int**| | @@ -1722,6 +1867,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -1739,6 +1885,7 @@ Retrieve the temporary proof while the Ezsigndocument is being processed since t ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -1783,6 +1930,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsigndocument_id** | **int**| | @@ -1801,6 +1949,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -1819,6 +1968,7 @@ Retrieve positions X,Y of given words from a Ezsigndocument ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -1865,6 +2015,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsigndocument_id** | **int**| | @@ -1884,6 +2035,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -1902,6 +2054,7 @@ Patch an existing Ezsigndocument ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -1948,6 +2101,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsigndocument_id** | **int**| | @@ -1967,6 +2121,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -1985,6 +2140,7 @@ Submit the Ezsignform ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -2031,6 +2187,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsigndocument_id** | **int**| | @@ -2050,6 +2207,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -2068,6 +2226,7 @@ Once an Ezsigndocument has been sent to signatories, it cannot be modified. Usi ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -2113,6 +2272,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsigndocument_id** | **int**| | @@ -2132,6 +2292,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | diff --git a/docs/ObjectEzsignfolderApi.md b/docs/ObjectEzsignfolderApi.md index a5a65cfdb..de4204105 100644 --- a/docs/ObjectEzsignfolderApi.md +++ b/docs/ObjectEzsignfolderApi.md @@ -13,6 +13,8 @@ Method | HTTP request | Description [**ezsignfolder_dispose_v1**](ObjectEzsignfolderApi.md#ezsignfolder_dispose_v1) | **POST** /1/object/ezsignfolder/{pkiEzsignfolderID}/dispose | Dispose the Ezsignfolder [**ezsignfolder_edit_object_v1**](ObjectEzsignfolderApi.md#ezsignfolder_edit_object_v1) | **PUT** /1/object/ezsignfolder/{pkiEzsignfolderID} | Edit an existing Ezsignfolder [**ezsignfolder_get_actionable_elements_v1**](ObjectEzsignfolderApi.md#ezsignfolder_get_actionable_elements_v1) | **GET** /1/object/ezsignfolder/{pkiEzsignfolderID}/getActionableElements | Retrieve actionable elements for the Ezsignfolder +[**ezsignfolder_get_attachment_count_v1**](ObjectEzsignfolderApi.md#ezsignfolder_get_attachment_count_v1) | **GET** /1/object/ezsignfolder/{pkiEzsignfolderID}/getAttachmentCount | Retrieve Attachment count +[**ezsignfolder_get_attachments_v1**](ObjectEzsignfolderApi.md#ezsignfolder_get_attachments_v1) | **GET** /1/object/ezsignfolder/{pkiEzsignfolderID}/getAttachments | Retrieve Ezsignfolder's Attachments [**ezsignfolder_get_communication_count_v1**](ObjectEzsignfolderApi.md#ezsignfolder_get_communication_count_v1) | **GET** /1/object/ezsignfolder/{pkiEzsignfolderID}/getCommunicationCount | Retrieve Communication count [**ezsignfolder_get_communication_list_v1**](ObjectEzsignfolderApi.md#ezsignfolder_get_communication_list_v1) | **GET** /1/object/ezsignfolder/{pkiEzsignfolderID}/getCommunicationList | Retrieve Communication list [**ezsignfolder_get_communicationrecipients_v1**](ObjectEzsignfolderApi.md#ezsignfolder_get_communicationrecipients_v1) | **GET** /1/object/ezsignfolder/{pkiEzsignfolderID}/getCommunicationrecipients | Retrieve Ezsignfolder's Communicationrecipient @@ -43,6 +45,7 @@ Archive the Ezsignfolder ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -88,6 +91,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsignfolder_id** | **int**| | @@ -107,6 +111,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -123,6 +128,7 @@ Download multiples files from an Ezsignfolder ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -168,6 +174,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsignfolder_id** | **int**| | @@ -187,6 +194,7 @@ Name | Type | Description | Notes - **Accept**: application/zip, application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -206,6 +214,7 @@ The endpoint allows to create one or many elements at once. The array can conta ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -251,6 +260,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ezsignfolder_create_object_v1_request** | [**List[EzsignfolderCreateObjectV1Request]**](EzsignfolderCreateObjectV1Request.md)| | @@ -269,6 +279,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **201** | Successful response | - | @@ -285,6 +296,7 @@ The endpoint allows to create one or many elements at once. ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -330,6 +342,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ezsignfolder_create_object_v2_request** | [**EzsignfolderCreateObjectV2Request**](EzsignfolderCreateObjectV2Request.md)| | @@ -348,6 +361,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **201** | Successful response | - | @@ -362,6 +376,7 @@ Delete an existing Ezsignfolder ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -406,6 +421,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsignfolder_id** | **int**| | @@ -424,6 +440,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -442,6 +459,7 @@ Dispose Ezsignfolders ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -487,6 +505,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ezsignfolder_dispose_ezsignfolders_v1_request** | [**EzsignfolderDisposeEzsignfoldersV1Request**](EzsignfolderDisposeEzsignfoldersV1Request.md)| | @@ -505,6 +524,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -523,6 +543,7 @@ Dispose the Ezsignfolder ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -568,6 +589,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsignfolder_id** | **int**| | @@ -587,6 +609,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -605,6 +628,7 @@ Edit an existing Ezsignfolder ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -651,6 +675,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsignfolder_id** | **int**| | @@ -670,6 +695,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -688,6 +714,7 @@ Return the Ezsignsignatures that can be signed and Ezsignformfieldgroups that ca ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -732,6 +759,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsignfolder_id** | **int**| | @@ -750,6 +778,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -758,6 +787,170 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +# **ezsignfolder_get_attachment_count_v1** +> EzsignfolderGetAttachmentCountV1Response ezsignfolder_get_attachment_count_v1(pki_ezsignfolder_id) + +Retrieve Attachment count + + + +### Example + +* Api Key Authentication (Authorization): + +```python +import time +import os +import eZmaxApi +from eZmaxApi.models.ezsignfolder_get_attachment_count_v1_response import EzsignfolderGetAttachmentCountV1Response +from eZmaxApi.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest +# See configuration.py for a list of all supported configuration parameters. +configuration = eZmaxApi.Configuration( + host = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: Authorization +configuration.api_key['Authorization'] = os.environ["API_KEY"] + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['Authorization'] = 'Bearer' + +# Enter a context with an instance of the API client +with eZmaxApi.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = eZmaxApi.ObjectEzsignfolderApi(api_client) + pki_ezsignfolder_id = 56 # int | + + try: + # Retrieve Attachment count + api_response = api_instance.ezsignfolder_get_attachment_count_v1(pki_ezsignfolder_id) + print("The response of ObjectEzsignfolderApi->ezsignfolder_get_attachment_count_v1:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ObjectEzsignfolderApi->ezsignfolder_get_attachment_count_v1: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pki_ezsignfolder_id** | **int**| | + +### Return type + +[**EzsignfolderGetAttachmentCountV1Response**](EzsignfolderGetAttachmentCountV1Response.md) + +### Authorization + +[Authorization](../README.md#Authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Successful response | - | +**404** | The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **ezsignfolder_get_attachments_v1** +> EzsignfolderGetAttachmentsV1Response ezsignfolder_get_attachments_v1(pki_ezsignfolder_id) + +Retrieve Ezsignfolder's Attachments + + + +### Example + +* Api Key Authentication (Authorization): + +```python +import time +import os +import eZmaxApi +from eZmaxApi.models.ezsignfolder_get_attachments_v1_response import EzsignfolderGetAttachmentsV1Response +from eZmaxApi.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest +# See configuration.py for a list of all supported configuration parameters. +configuration = eZmaxApi.Configuration( + host = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: Authorization +configuration.api_key['Authorization'] = os.environ["API_KEY"] + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['Authorization'] = 'Bearer' + +# Enter a context with an instance of the API client +with eZmaxApi.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = eZmaxApi.ObjectEzsignfolderApi(api_client) + pki_ezsignfolder_id = 56 # int | + + try: + # Retrieve Ezsignfolder's Attachments + api_response = api_instance.ezsignfolder_get_attachments_v1(pki_ezsignfolder_id) + print("The response of ObjectEzsignfolderApi->ezsignfolder_get_attachments_v1:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ObjectEzsignfolderApi->ezsignfolder_get_attachments_v1: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pki_ezsignfolder_id** | **int**| | + +### Return type + +[**EzsignfolderGetAttachmentsV1Response**](EzsignfolderGetAttachmentsV1Response.md) + +### Authorization + +[Authorization](../README.md#Authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Successful response | - | +**404** | The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + # **ezsignfolder_get_communication_count_v1** > EzsignfolderGetCommunicationCountV1Response ezsignfolder_get_communication_count_v1(pki_ezsignfolder_id) @@ -768,6 +961,7 @@ Retrieve Communication count ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -812,6 +1006,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsignfolder_id** | **int**| | @@ -830,6 +1025,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -847,6 +1043,7 @@ Retrieve Communication list ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -891,6 +1088,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsignfolder_id** | **int**| | @@ -909,6 +1107,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -926,6 +1125,7 @@ Retrieve Ezsignfolder's Communicationrecipient ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -970,6 +1170,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsignfolder_id** | **int**| | @@ -988,6 +1189,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -1005,6 +1207,7 @@ Retrieve Ezsignfolder's Communicationsender ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -1049,6 +1252,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsignfolder_id** | **int**| | @@ -1067,6 +1271,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -1084,6 +1289,7 @@ Retrieve an existing Ezsignfolder's Ezsigndocuments ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -1128,6 +1334,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsignfolder_id** | **int**| | @@ -1146,6 +1353,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -1163,6 +1371,7 @@ Retrieve an existing Ezsignfolder's Ezsignfoldersignerassociations ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -1207,6 +1416,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsignfolder_id** | **int**| | @@ -1225,6 +1435,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -1242,6 +1453,7 @@ Return the Ezsignsignatures that can be signed by the current user at the curren ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -1286,6 +1498,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsignfolder_id** | **int**| | @@ -1304,6 +1517,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -1321,6 +1535,7 @@ Retrieve an existing Ezsignfolder's forms data ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -1365,6 +1580,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsignfolder_id** | **int**| | @@ -1383,6 +1599,7 @@ Name | Type | Description | Notes - **Accept**: application/json, application/zip ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -1402,6 +1619,7 @@ Enum values that can be filtered in query parameter *sFilter*: | Variable | Val ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -1451,6 +1669,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **e_order_by** | **str**| Specify how you want the results to be sorted | [optional] @@ -1473,6 +1692,7 @@ Name | Type | Description | Notes - **Accept**: application/json, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -1488,6 +1708,7 @@ Retrieve an existing Ezsignfolder ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -1532,6 +1753,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsignfolder_id** | **int**| | @@ -1550,6 +1772,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -1567,6 +1790,7 @@ Retrieve an existing Ezsignfolder ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -1611,6 +1835,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsignfolder_id** | **int**| | @@ -1629,6 +1854,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -1646,6 +1872,7 @@ Import an existing Ezsignfoldersignerassociation into this Ezsignfolder ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -1692,6 +1919,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsignfolder_id** | **int**| | @@ -1711,6 +1939,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -1730,6 +1959,7 @@ This endpoint imports all of the Ezsigntemplates from the Ezsigntemplatepackage ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -1776,6 +2006,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsignfolder_id** | **int**| | @@ -1795,6 +2026,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -1811,6 +2043,7 @@ Reorder Ezsigndocuments in the Ezsignfolder ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -1857,6 +2090,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsignfolder_id** | **int**| | @@ -1876,6 +2110,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -1894,6 +2129,7 @@ Send the Ezsignfolder to the signatories for signature ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -1940,6 +2176,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsignfolder_id** | **int**| | @@ -1959,6 +2196,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -1977,6 +2215,7 @@ Send the Ezsignfolder to the signatories for signature ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -2023,6 +2262,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsignfolder_id** | **int**| | @@ -2042,6 +2282,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -2060,6 +2301,7 @@ Send the Ezsignfolder to the signatories for signature ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -2106,6 +2348,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsignfolder_id** | **int**| | @@ -2125,6 +2368,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -2143,6 +2387,7 @@ Once an Ezsignfolder has been sent to signatories, it cannot be modified. Using ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -2188,6 +2433,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsignfolder_id** | **int**| | @@ -2207,6 +2453,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | diff --git a/docs/ObjectEzsignfoldersignerassociationApi.md b/docs/ObjectEzsignfoldersignerassociationApi.md index 17a37ed74..35c1498f4 100644 --- a/docs/ObjectEzsignfoldersignerassociationApi.md +++ b/docs/ObjectEzsignfoldersignerassociationApi.md @@ -25,6 +25,7 @@ The endpoint allows to create one or many elements at once. The array can conta ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -70,6 +71,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ezsignfoldersignerassociation_create_object_v1_request** | [**List[EzsignfoldersignerassociationCreateObjectV1Request]**](EzsignfoldersignerassociationCreateObjectV1Request.md)| | @@ -88,6 +90,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **201** | Successful response | - | @@ -104,6 +107,7 @@ The endpoint allows to create one or many elements at once. ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -149,6 +153,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ezsignfoldersignerassociation_create_object_v2_request** | [**EzsignfoldersignerassociationCreateObjectV2Request**](EzsignfoldersignerassociationCreateObjectV2Request.md)| | @@ -167,6 +172,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **201** | Successful response | - | @@ -183,6 +189,7 @@ Delete an existing Ezsignfoldersignerassociation ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -227,6 +234,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsignfoldersignerassociation_id** | **int**| | @@ -245,6 +253,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -263,6 +272,7 @@ Edit an existing Ezsignfoldersignerassociation ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -309,6 +319,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsignfoldersignerassociation_id** | **int**| | @@ -328,6 +339,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -346,6 +358,7 @@ Disconnects the Ezsignfoldersignerassociation ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -391,6 +404,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsignfoldersignerassociation_id** | **int**| | @@ -410,6 +424,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -428,6 +443,7 @@ This endpoint returns a Login Url that can be used in a browser or embedded in a ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -472,6 +488,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsignfoldersignerassociation_id** | **int**| | @@ -490,6 +507,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -508,6 +526,7 @@ Retrieve an existing Ezsignfoldersignerassociation ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -552,6 +571,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsignfoldersignerassociation_id** | **int**| | @@ -570,6 +590,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -587,6 +608,7 @@ Retrieve an existing Ezsignfoldersignerassociation ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -631,6 +653,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsignfoldersignerassociation_id** | **int**| | @@ -649,6 +672,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -664,6 +688,7 @@ Patch an existing Ezsignfoldersignerassociation ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -710,6 +735,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsignfoldersignerassociation_id** | **int**| | @@ -729,6 +755,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | diff --git a/docs/ObjectEzsignfoldertypeApi.md b/docs/ObjectEzsignfoldertypeApi.md index 6ceab39b3..7bc5d8f5b 100644 --- a/docs/ObjectEzsignfoldertypeApi.md +++ b/docs/ObjectEzsignfoldertypeApi.md @@ -22,6 +22,7 @@ The endpoint allows to create one or many elements at once. ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -67,6 +68,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ezsignfoldertype_create_object_v1_request** | [**EzsignfoldertypeCreateObjectV1Request**](EzsignfoldertypeCreateObjectV1Request.md)| | @@ -85,6 +87,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **201** | Successful response | - | @@ -101,6 +104,7 @@ Edit an existing Ezsignfoldertype ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -147,6 +151,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsignfoldertype_id** | **int**| | @@ -166,6 +171,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -184,6 +190,7 @@ Get the list of Ezsignfoldertypes to be used in a dropdown or autocomplete contr ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -232,6 +239,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **s_selector** | **str**| The type of Ezsignfoldertypes to return | @@ -253,6 +261,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -269,6 +278,7 @@ Get the list of Ezsignfoldertype to be used in a dropdown or autocomplete contro ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -317,6 +327,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **s_selector** | **str**| The type of Ezsignfoldertypes to return | @@ -338,6 +349,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -354,6 +366,7 @@ Enum values that can be filtered in query parameter *sFilter*: | Variable | Val ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -403,6 +416,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **e_order_by** | **str**| Specify how you want the results to be sorted | [optional] @@ -425,6 +439,7 @@ Name | Type | Description | Notes - **Accept**: application/json, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -442,6 +457,7 @@ Retrieve an existing Ezsignfoldertype ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -486,6 +502,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsignfoldertype_id** | **int**| | @@ -504,6 +521,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | diff --git a/docs/ObjectEzsignformfieldgroupApi.md b/docs/ObjectEzsignformfieldgroupApi.md index 758683c7d..ba95fab29 100644 --- a/docs/ObjectEzsignformfieldgroupApi.md +++ b/docs/ObjectEzsignformfieldgroupApi.md @@ -20,6 +20,7 @@ The endpoint allows to create one or many elements at once. ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -65,6 +66,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ezsignformfieldgroup_create_object_v1_request** | [**EzsignformfieldgroupCreateObjectV1Request**](EzsignformfieldgroupCreateObjectV1Request.md)| | @@ -83,6 +85,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **201** | Successful response | - | @@ -99,6 +102,7 @@ Delete an existing Ezsignformfieldgroup ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -143,6 +147,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsignformfieldgroup_id** | **int**| | @@ -161,6 +166,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -179,6 +185,7 @@ Edit an existing Ezsignformfieldgroup ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -225,6 +232,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsignformfieldgroup_id** | **int**| | @@ -244,6 +252,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -262,6 +271,7 @@ Retrieve an existing Ezsignformfieldgroup ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -306,6 +316,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsignformfieldgroup_id** | **int**| | @@ -324,6 +335,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | diff --git a/docs/ObjectEzsignpageApi.md b/docs/ObjectEzsignpageApi.md index 20aafacbb..31a8bf76d 100644 --- a/docs/ObjectEzsignpageApi.md +++ b/docs/ObjectEzsignpageApi.md @@ -15,6 +15,7 @@ Consult an Ezsignpage ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -60,6 +61,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsignpage_id** | **int**| | @@ -79,6 +81,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | diff --git a/docs/ObjectEzsignsignatureApi.md b/docs/ObjectEzsignsignatureApi.md index 6d451b80b..1b105776b 100644 --- a/docs/ObjectEzsignsignatureApi.md +++ b/docs/ObjectEzsignsignatureApi.md @@ -24,6 +24,7 @@ The endpoint allows to create one or many elements at once. The array can conta ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -69,6 +70,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ezsignsignature_create_object_v1_request** | [**List[EzsignsignatureCreateObjectV1Request]**](EzsignsignatureCreateObjectV1Request.md)| | @@ -87,6 +89,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **201** | Successful response | - | @@ -103,6 +106,7 @@ The endpoint allows to create one or many elements at once. ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -148,6 +152,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ezsignsignature_create_object_v2_request** | [**EzsignsignatureCreateObjectV2Request**](EzsignsignatureCreateObjectV2Request.md)| | @@ -166,6 +171,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **201** | Successful response | - | @@ -182,6 +188,7 @@ Delete an existing Ezsignsignature ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -226,6 +233,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsignsignature_id** | **int**| | @@ -244,6 +252,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -262,6 +271,7 @@ Edit an existing Ezsignsignature ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -308,6 +318,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsignsignature_id** | **int**| | @@ -327,6 +338,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -343,6 +355,7 @@ Retrieve an existing Ezsignsignature's Ezsignsignatureattachments ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -387,6 +400,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsignsignature_id** | **int**| | @@ -405,6 +419,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -423,6 +438,7 @@ Return all the Ezsignsignatures that can be signed by the current user ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -465,6 +481,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + This endpoint does not need any parameter. ### Return type @@ -481,6 +498,7 @@ This endpoint does not need any parameter. - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -497,6 +515,7 @@ Retrieve an existing Ezsignsignature ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -541,6 +560,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsignsignature_id** | **int**| | @@ -559,6 +579,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -576,6 +597,7 @@ Sign the Ezsignsignature ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -622,6 +644,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsignsignature_id** | **int**| | @@ -641,6 +664,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | diff --git a/docs/ObjectEzsignsignergroupApi.md b/docs/ObjectEzsignsignergroupApi.md index ce8e914d8..3726ac00d 100644 --- a/docs/ObjectEzsignsignergroupApi.md +++ b/docs/ObjectEzsignsignergroupApi.md @@ -22,6 +22,7 @@ The endpoint allows to create one or many elements at once. ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -67,6 +68,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ezsignsignergroup_create_object_v1_request** | [**EzsignsignergroupCreateObjectV1Request**](EzsignsignergroupCreateObjectV1Request.md)| | @@ -85,6 +87,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **201** | Successful response | - | @@ -101,6 +104,7 @@ Delete an existing Ezsignsignergroup ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -145,6 +149,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsignsignergroup_id** | **int**| The unique ID of the Ezsignsignergroup | @@ -163,6 +168,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -180,6 +186,7 @@ Using this endpoint, you can edit multiple Ezsignsignergroupmemberships at the s ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -226,6 +233,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsignsignergroup_id** | **int**| | @@ -245,6 +253,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -263,6 +272,7 @@ Edit an existing Ezsignsignergroup ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -309,6 +319,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsignsignergroup_id** | **int**| The unique ID of the Ezsignsignergroup | @@ -328,6 +339,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -343,6 +355,7 @@ Retrieve an existing Ezsignsignergroup's Ezsignsignergroupmemberships ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -387,6 +400,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsignsignergroup_id** | **int**| | @@ -405,6 +419,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -422,6 +437,7 @@ Retrieve an existing Ezsignsignergroup ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -466,6 +482,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsignsignergroup_id** | **int**| The unique ID of the Ezsignsignergroup | @@ -484,6 +501,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | diff --git a/docs/ObjectEzsignsignergroupmembershipApi.md b/docs/ObjectEzsignsignergroupmembershipApi.md index afe8660b4..9b848b060 100644 --- a/docs/ObjectEzsignsignergroupmembershipApi.md +++ b/docs/ObjectEzsignsignergroupmembershipApi.md @@ -19,6 +19,7 @@ The endpoint allows to create one or many elements at once. ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -64,6 +65,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ezsignsignergroupmembership_create_object_v1_request** | [**EzsignsignergroupmembershipCreateObjectV1Request**](EzsignsignergroupmembershipCreateObjectV1Request.md)| | @@ -82,6 +84,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **201** | Successful response | - | @@ -98,6 +101,7 @@ Delete an existing Ezsignsignergroupmembership ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -142,6 +146,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsignsignergroupmembership_id** | **int**| The unique ID of the Ezsignsignergroupmembership | @@ -160,6 +165,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -177,6 +183,7 @@ Retrieve an existing Ezsignsignergroupmembership ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -221,6 +228,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsignsignergroupmembership_id** | **int**| The unique ID of the Ezsignsignergroupmembership | @@ -239,6 +247,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | diff --git a/docs/ObjectEzsignsigningreasonApi.md b/docs/ObjectEzsignsigningreasonApi.md new file mode 100644 index 000000000..a0349fbb3 --- /dev/null +++ b/docs/ObjectEzsignsigningreasonApi.md @@ -0,0 +1,442 @@ +# eZmaxApi.ObjectEzsignsigningreasonApi + +All URIs are relative to *https://prod.api.appcluster01.ca-central-1.ezmax.com/rest* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**ezsignsigningreason_create_object_v1**](ObjectEzsignsigningreasonApi.md#ezsignsigningreason_create_object_v1) | **POST** /1/object/ezsignsigningreason | Create a new Ezsignsigningreason +[**ezsignsigningreason_edit_object_v1**](ObjectEzsignsigningreasonApi.md#ezsignsigningreason_edit_object_v1) | **PUT** /1/object/ezsignsigningreason/{pkiEzsignsigningreasonID} | Edit an existing Ezsignsigningreason +[**ezsignsigningreason_get_autocomplete_v2**](ObjectEzsignsigningreasonApi.md#ezsignsigningreason_get_autocomplete_v2) | **GET** /2/object/ezsignsigningreason/getAutocomplete/{sSelector} | Retrieve Ezsignsigningreasons and IDs +[**ezsignsigningreason_get_list_v1**](ObjectEzsignsigningreasonApi.md#ezsignsigningreason_get_list_v1) | **GET** /1/object/ezsignsigningreason/getList | Retrieve Ezsignsigningreason list +[**ezsignsigningreason_get_object_v2**](ObjectEzsignsigningreasonApi.md#ezsignsigningreason_get_object_v2) | **GET** /2/object/ezsignsigningreason/{pkiEzsignsigningreasonID} | Retrieve an existing Ezsignsigningreason + + +# **ezsignsigningreason_create_object_v1** +> EzsignsigningreasonCreateObjectV1Response ezsignsigningreason_create_object_v1(ezsignsigningreason_create_object_v1_request) + +Create a new Ezsignsigningreason + +The endpoint allows to create one or many elements at once. + +### Example + +* Api Key Authentication (Authorization): + +```python +import time +import os +import eZmaxApi +from eZmaxApi.models.ezsignsigningreason_create_object_v1_request import EzsignsigningreasonCreateObjectV1Request +from eZmaxApi.models.ezsignsigningreason_create_object_v1_response import EzsignsigningreasonCreateObjectV1Response +from eZmaxApi.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest +# See configuration.py for a list of all supported configuration parameters. +configuration = eZmaxApi.Configuration( + host = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: Authorization +configuration.api_key['Authorization'] = os.environ["API_KEY"] + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['Authorization'] = 'Bearer' + +# Enter a context with an instance of the API client +with eZmaxApi.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = eZmaxApi.ObjectEzsignsigningreasonApi(api_client) + ezsignsigningreason_create_object_v1_request = eZmaxApi.EzsignsigningreasonCreateObjectV1Request() # EzsignsigningreasonCreateObjectV1Request | + + try: + # Create a new Ezsignsigningreason + api_response = api_instance.ezsignsigningreason_create_object_v1(ezsignsigningreason_create_object_v1_request) + print("The response of ObjectEzsignsigningreasonApi->ezsignsigningreason_create_object_v1:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ObjectEzsignsigningreasonApi->ezsignsigningreason_create_object_v1: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ezsignsigningreason_create_object_v1_request** | [**EzsignsigningreasonCreateObjectV1Request**](EzsignsigningreasonCreateObjectV1Request.md)| | + +### Return type + +[**EzsignsigningreasonCreateObjectV1Response**](EzsignsigningreasonCreateObjectV1Response.md) + +### Authorization + +[Authorization](../README.md#Authorization) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**201** | Successful response | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **ezsignsigningreason_edit_object_v1** +> EzsignsigningreasonEditObjectV1Response ezsignsigningreason_edit_object_v1(pki_ezsignsigningreason_id, ezsignsigningreason_edit_object_v1_request) + +Edit an existing Ezsignsigningreason + + + +### Example + +* Api Key Authentication (Authorization): + +```python +import time +import os +import eZmaxApi +from eZmaxApi.models.ezsignsigningreason_edit_object_v1_request import EzsignsigningreasonEditObjectV1Request +from eZmaxApi.models.ezsignsigningreason_edit_object_v1_response import EzsignsigningreasonEditObjectV1Response +from eZmaxApi.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest +# See configuration.py for a list of all supported configuration parameters. +configuration = eZmaxApi.Configuration( + host = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: Authorization +configuration.api_key['Authorization'] = os.environ["API_KEY"] + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['Authorization'] = 'Bearer' + +# Enter a context with an instance of the API client +with eZmaxApi.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = eZmaxApi.ObjectEzsignsigningreasonApi(api_client) + pki_ezsignsigningreason_id = 56 # int | The unique ID of the Ezsignsigningreason + ezsignsigningreason_edit_object_v1_request = eZmaxApi.EzsignsigningreasonEditObjectV1Request() # EzsignsigningreasonEditObjectV1Request | + + try: + # Edit an existing Ezsignsigningreason + api_response = api_instance.ezsignsigningreason_edit_object_v1(pki_ezsignsigningreason_id, ezsignsigningreason_edit_object_v1_request) + print("The response of ObjectEzsignsigningreasonApi->ezsignsigningreason_edit_object_v1:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ObjectEzsignsigningreasonApi->ezsignsigningreason_edit_object_v1: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pki_ezsignsigningreason_id** | **int**| The unique ID of the Ezsignsigningreason | + **ezsignsigningreason_edit_object_v1_request** | [**EzsignsigningreasonEditObjectV1Request**](EzsignsigningreasonEditObjectV1Request.md)| | + +### Return type + +[**EzsignsigningreasonEditObjectV1Response**](EzsignsigningreasonEditObjectV1Response.md) + +### Authorization + +[Authorization](../README.md#Authorization) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Successful response | - | +**404** | The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body | - | +**422** | The request was syntactically valid but failed because of an interdependance condition. Look for detail about the error in the body | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **ezsignsigningreason_get_autocomplete_v2** +> EzsignsigningreasonGetAutocompleteV2Response ezsignsigningreason_get_autocomplete_v2(s_selector, e_filter_active=e_filter_active, s_query=s_query, accept_language=accept_language) + +Retrieve Ezsignsigningreasons and IDs + +Get the list of Ezsignsigningreason to be used in a dropdown or autocomplete control. + +### Example + +* Api Key Authentication (Authorization): + +```python +import time +import os +import eZmaxApi +from eZmaxApi.models.ezsignsigningreason_get_autocomplete_v2_response import EzsignsigningreasonGetAutocompleteV2Response +from eZmaxApi.models.header_accept_language import HeaderAcceptLanguage +from eZmaxApi.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest +# See configuration.py for a list of all supported configuration parameters. +configuration = eZmaxApi.Configuration( + host = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: Authorization +configuration.api_key['Authorization'] = os.environ["API_KEY"] + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['Authorization'] = 'Bearer' + +# Enter a context with an instance of the API client +with eZmaxApi.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = eZmaxApi.ObjectEzsignsigningreasonApi(api_client) + s_selector = 's_selector_example' # str | The type of Ezsignsigningreasons to return + e_filter_active = 'Active' # str | Specify which results we want to display. (optional) (default to 'Active') + s_query = 's_query_example' # str | Allow to filter the returned results (optional) + accept_language = eZmaxApi.HeaderAcceptLanguage() # HeaderAcceptLanguage | (optional) + + try: + # Retrieve Ezsignsigningreasons and IDs + api_response = api_instance.ezsignsigningreason_get_autocomplete_v2(s_selector, e_filter_active=e_filter_active, s_query=s_query, accept_language=accept_language) + print("The response of ObjectEzsignsigningreasonApi->ezsignsigningreason_get_autocomplete_v2:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ObjectEzsignsigningreasonApi->ezsignsigningreason_get_autocomplete_v2: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **s_selector** | **str**| The type of Ezsignsigningreasons to return | + **e_filter_active** | **str**| Specify which results we want to display. | [optional] [default to 'Active'] + **s_query** | **str**| Allow to filter the returned results | [optional] + **accept_language** | [**HeaderAcceptLanguage**](.md)| | [optional] + +### Return type + +[**EzsignsigningreasonGetAutocompleteV2Response**](EzsignsigningreasonGetAutocompleteV2Response.md) + +### Authorization + +[Authorization](../README.md#Authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Successful response | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **ezsignsigningreason_get_list_v1** +> EzsignsigningreasonGetListV1Response ezsignsigningreason_get_list_v1(e_order_by=e_order_by, i_row_max=i_row_max, i_row_offset=i_row_offset, accept_language=accept_language, s_filter=s_filter) + +Retrieve Ezsignsigningreason list + + + +### Example + +* Api Key Authentication (Authorization): + +```python +import time +import os +import eZmaxApi +from eZmaxApi.models.ezsignsigningreason_get_list_v1_response import EzsignsigningreasonGetListV1Response +from eZmaxApi.models.header_accept_language import HeaderAcceptLanguage +from eZmaxApi.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest +# See configuration.py for a list of all supported configuration parameters. +configuration = eZmaxApi.Configuration( + host = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: Authorization +configuration.api_key['Authorization'] = os.environ["API_KEY"] + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['Authorization'] = 'Bearer' + +# Enter a context with an instance of the API client +with eZmaxApi.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = eZmaxApi.ObjectEzsignsigningreasonApi(api_client) + e_order_by = 'e_order_by_example' # str | Specify how you want the results to be sorted (optional) + i_row_max = 56 # int | (optional) + i_row_offset = 0 # int | (optional) (default to 0) + accept_language = eZmaxApi.HeaderAcceptLanguage() # HeaderAcceptLanguage | (optional) + s_filter = 's_filter_example' # str | (optional) + + try: + # Retrieve Ezsignsigningreason list + api_response = api_instance.ezsignsigningreason_get_list_v1(e_order_by=e_order_by, i_row_max=i_row_max, i_row_offset=i_row_offset, accept_language=accept_language, s_filter=s_filter) + print("The response of ObjectEzsignsigningreasonApi->ezsignsigningreason_get_list_v1:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ObjectEzsignsigningreasonApi->ezsignsigningreason_get_list_v1: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **e_order_by** | **str**| Specify how you want the results to be sorted | [optional] + **i_row_max** | **int**| | [optional] + **i_row_offset** | **int**| | [optional] [default to 0] + **accept_language** | [**HeaderAcceptLanguage**](.md)| | [optional] + **s_filter** | **str**| | [optional] + +### Return type + +[**EzsignsigningreasonGetListV1Response**](EzsignsigningreasonGetListV1Response.md) + +### Authorization + +[Authorization](../README.md#Authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Successful response | - | +**406** | The URL is valid, but one of the Accept header is not defined or invalid. For example, you set the header \"Accept: application/json\" but the function can only return \"Content-type: image/png\" | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **ezsignsigningreason_get_object_v2** +> EzsignsigningreasonGetObjectV2Response ezsignsigningreason_get_object_v2(pki_ezsignsigningreason_id) + +Retrieve an existing Ezsignsigningreason + + + +### Example + +* Api Key Authentication (Authorization): + +```python +import time +import os +import eZmaxApi +from eZmaxApi.models.ezsignsigningreason_get_object_v2_response import EzsignsigningreasonGetObjectV2Response +from eZmaxApi.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest +# See configuration.py for a list of all supported configuration parameters. +configuration = eZmaxApi.Configuration( + host = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: Authorization +configuration.api_key['Authorization'] = os.environ["API_KEY"] + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['Authorization'] = 'Bearer' + +# Enter a context with an instance of the API client +with eZmaxApi.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = eZmaxApi.ObjectEzsignsigningreasonApi(api_client) + pki_ezsignsigningreason_id = 56 # int | The unique ID of the Ezsignsigningreason + + try: + # Retrieve an existing Ezsignsigningreason + api_response = api_instance.ezsignsigningreason_get_object_v2(pki_ezsignsigningreason_id) + print("The response of ObjectEzsignsigningreasonApi->ezsignsigningreason_get_object_v2:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ObjectEzsignsigningreasonApi->ezsignsigningreason_get_object_v2: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pki_ezsignsigningreason_id** | **int**| The unique ID of the Ezsignsigningreason | + +### Return type + +[**EzsignsigningreasonGetObjectV2Response**](EzsignsigningreasonGetObjectV2Response.md) + +### Authorization + +[Authorization](../README.md#Authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Successful response | - | +**404** | The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ObjectEzsigntemplateApi.md b/docs/ObjectEzsigntemplateApi.md index d464bc854..112a1d60c 100644 --- a/docs/ObjectEzsigntemplateApi.md +++ b/docs/ObjectEzsigntemplateApi.md @@ -24,6 +24,7 @@ Copy the Ezsigntemplate ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -70,6 +71,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsigntemplate_id** | **int**| | @@ -89,6 +91,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **201** | Successful response | - | @@ -106,6 +109,7 @@ The endpoint allows to create one or many elements at once. ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -151,6 +155,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ezsigntemplate_create_object_v1_request** | [**EzsigntemplateCreateObjectV1Request**](EzsigntemplateCreateObjectV1Request.md)| | @@ -169,6 +174,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **201** | Successful response | - | @@ -185,6 +191,7 @@ Delete an existing Ezsigntemplate ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -229,6 +236,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsigntemplate_id** | **int**| | @@ -247,6 +255,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -264,6 +273,7 @@ Edit an existing Ezsigntemplate ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -310,6 +320,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsigntemplate_id** | **int**| | @@ -329,6 +340,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -347,6 +359,7 @@ Get the list of Ezsigntemplate to be used in a dropdown or autocomplete control. ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -395,6 +408,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **s_selector** | **str**| The type of Ezsigntemplates to return | @@ -416,6 +430,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -432,6 +447,7 @@ Enum values that can be filtered in query parameter *sFilter*: | Variable | Val ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -481,6 +497,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **e_order_by** | **str**| Specify how you want the results to be sorted | [optional] @@ -503,6 +520,7 @@ Name | Type | Description | Notes - **Accept**: application/json, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -520,6 +538,7 @@ Retrieve an existing Ezsigntemplate ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -564,6 +583,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsigntemplate_id** | **int**| | @@ -582,6 +602,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -599,6 +620,7 @@ Retrieve an existing Ezsigntemplate ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -643,6 +665,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsigntemplate_id** | **int**| | @@ -661,6 +684,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | diff --git a/docs/ObjectEzsigntemplatedocumentApi.md b/docs/ObjectEzsigntemplatedocumentApi.md index 29171f6f2..432a63fc6 100644 --- a/docs/ObjectEzsigntemplatedocumentApi.md +++ b/docs/ObjectEzsigntemplatedocumentApi.md @@ -27,6 +27,7 @@ The endpoint allows to create one or many elements at once. ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -72,6 +73,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ezsigntemplatedocument_create_object_v1_request** | [**EzsigntemplatedocumentCreateObjectV1Request**](EzsigntemplatedocumentCreateObjectV1Request.md)| | @@ -90,6 +92,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **201** | Successful response | - | @@ -107,6 +110,7 @@ Using this endpoint, you can edit multiple Ezsigntemplateformfieldgroups at the ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -153,6 +157,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsigntemplatedocument_id** | **int**| | @@ -172,6 +177,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -190,6 +196,7 @@ Using this endpoint, you can edit multiple Ezsigntemplatesignatures at the same ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -236,6 +243,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsigntemplatedocument_id** | **int**| | @@ -255,6 +263,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -273,6 +282,7 @@ Edit an existing Ezsigntemplatedocument ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -319,6 +329,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsigntemplatedocument_id** | **int**| | @@ -338,6 +349,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -356,6 +368,7 @@ Flatten an Ezsigntemplatedocument signatures, forms and annotations. This proces ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -401,6 +414,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsigntemplatedocument_id** | **int**| | @@ -420,6 +434,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -438,6 +453,7 @@ Retrieve an existing Ezsigntemplatedocument's Ezsigntemplatedocumentpages ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -482,6 +498,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsigntemplatedocument_id** | **int**| | @@ -500,6 +517,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -517,6 +535,7 @@ Retrieve an existing Ezsigntemplatedocument's Ezsigntemplateformfieldgroups ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -561,6 +580,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsigntemplatedocument_id** | **int**| | @@ -579,6 +599,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -597,6 +618,7 @@ Retrieve an existing Ezsigntemplatedocument's Ezsigntemplatesignatures ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -641,6 +663,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsigntemplatedocument_id** | **int**| | @@ -659,6 +682,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -677,6 +701,7 @@ Retrieve an existing Ezsigntemplatedocument ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -721,6 +746,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsigntemplatedocument_id** | **int**| | @@ -739,6 +765,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -756,6 +783,7 @@ Retrieve positions X,Y of given words from a Ezsigntemplatedocument ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -802,6 +830,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsigntemplatedocument_id** | **int**| | @@ -821,6 +850,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -838,6 +868,7 @@ Patch an existing Ezsigntemplatedocument ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -884,6 +915,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsigntemplatedocument_id** | **int**| | @@ -903,6 +935,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | diff --git a/docs/ObjectEzsigntemplateformfieldgroupApi.md b/docs/ObjectEzsigntemplateformfieldgroupApi.md index 2abfbe292..0f43282b7 100644 --- a/docs/ObjectEzsigntemplateformfieldgroupApi.md +++ b/docs/ObjectEzsigntemplateformfieldgroupApi.md @@ -20,6 +20,7 @@ The endpoint allows to create one or many elements at once. ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -65,6 +66,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ezsigntemplateformfieldgroup_create_object_v1_request** | [**EzsigntemplateformfieldgroupCreateObjectV1Request**](EzsigntemplateformfieldgroupCreateObjectV1Request.md)| | @@ -83,6 +85,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **201** | Successful response | - | @@ -99,6 +102,7 @@ Delete an existing Ezsigntemplateformfieldgroup ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -143,6 +147,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsigntemplateformfieldgroup_id** | **int**| | @@ -161,6 +166,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -178,6 +184,7 @@ Edit an existing Ezsigntemplateformfieldgroup ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -224,6 +231,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsigntemplateformfieldgroup_id** | **int**| | @@ -243,6 +251,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -261,6 +270,7 @@ Retrieve an existing Ezsigntemplateformfieldgroup ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -305,6 +315,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsigntemplateformfieldgroup_id** | **int**| | @@ -323,6 +334,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | diff --git a/docs/ObjectEzsigntemplatepackageApi.md b/docs/ObjectEzsigntemplatepackageApi.md index f69445da7..e6765016d 100644 --- a/docs/ObjectEzsigntemplatepackageApi.md +++ b/docs/ObjectEzsigntemplatepackageApi.md @@ -23,6 +23,7 @@ The endpoint allows to create one or many elements at once. ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -68,6 +69,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ezsigntemplatepackage_create_object_v1_request** | [**EzsigntemplatepackageCreateObjectV1Request**](EzsigntemplatepackageCreateObjectV1Request.md)| | @@ -86,6 +88,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **201** | Successful response | - | @@ -102,6 +105,7 @@ Delete an existing Ezsigntemplatepackage ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -146,6 +150,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsigntemplatepackage_id** | **int**| | @@ -164,6 +169,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -181,6 +187,7 @@ Using this endpoint, you can edit multiple Ezsigntemplatepackagesigners at the s ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -227,6 +234,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsigntemplatepackage_id** | **int**| | @@ -246,6 +254,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -264,6 +273,7 @@ Edit an existing Ezsigntemplatepackage ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -310,6 +320,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsigntemplatepackage_id** | **int**| | @@ -329,6 +340,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -347,6 +359,7 @@ Get the list of Ezsigntemplatepackage to be used in a dropdown or autocomplete c ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -395,6 +408,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **s_selector** | **str**| The type of Ezsigntemplatepackages to return | @@ -416,6 +430,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -432,6 +447,7 @@ Enum values that can be filtered in query parameter *sFilter*: | Variable | Val ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -481,6 +497,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **e_order_by** | **str**| Specify how you want the results to be sorted | [optional] @@ -503,6 +520,7 @@ Name | Type | Description | Notes - **Accept**: application/json, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -520,6 +538,7 @@ Retrieve an existing Ezsigntemplatepackage ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -564,6 +583,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsigntemplatepackage_id** | **int**| | @@ -582,6 +602,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | diff --git a/docs/ObjectEzsigntemplatepackagemembershipApi.md b/docs/ObjectEzsigntemplatepackagemembershipApi.md index d55282cb9..452ea8e5b 100644 --- a/docs/ObjectEzsigntemplatepackagemembershipApi.md +++ b/docs/ObjectEzsigntemplatepackagemembershipApi.md @@ -19,6 +19,7 @@ The endpoint allows to create one or many elements at once. ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -64,6 +65,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ezsigntemplatepackagemembership_create_object_v1_request** | [**EzsigntemplatepackagemembershipCreateObjectV1Request**](EzsigntemplatepackagemembershipCreateObjectV1Request.md)| | @@ -82,6 +84,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **201** | Successful response | - | @@ -99,6 +102,7 @@ Delete an existing Ezsigntemplatepackagemembership ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -143,6 +147,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsigntemplatepackagemembership_id** | **int**| | @@ -161,6 +166,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -178,6 +184,7 @@ Retrieve an existing Ezsigntemplatepackagemembership ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -222,6 +229,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsigntemplatepackagemembership_id** | **int**| | @@ -240,6 +248,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | diff --git a/docs/ObjectEzsigntemplatepackagesignerApi.md b/docs/ObjectEzsigntemplatepackagesignerApi.md index 096cfe2a2..592fdf124 100644 --- a/docs/ObjectEzsigntemplatepackagesignerApi.md +++ b/docs/ObjectEzsigntemplatepackagesignerApi.md @@ -20,6 +20,7 @@ The endpoint allows to create one or many elements at once. ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -65,6 +66,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ezsigntemplatepackagesigner_create_object_v1_request** | [**EzsigntemplatepackagesignerCreateObjectV1Request**](EzsigntemplatepackagesignerCreateObjectV1Request.md)| | @@ -83,6 +85,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **201** | Successful response | - | @@ -99,6 +102,7 @@ Delete an existing Ezsigntemplatepackagesigner ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -143,6 +147,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsigntemplatepackagesigner_id** | **int**| | @@ -161,6 +166,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -178,6 +184,7 @@ Edit an existing Ezsigntemplatepackagesigner ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -224,6 +231,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsigntemplatepackagesigner_id** | **int**| | @@ -243,6 +251,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -261,6 +270,7 @@ Retrieve an existing Ezsigntemplatepackagesigner ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -305,6 +315,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsigntemplatepackagesigner_id** | **int**| | @@ -323,6 +334,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | diff --git a/docs/ObjectEzsigntemplatepackagesignermembershipApi.md b/docs/ObjectEzsigntemplatepackagesignermembershipApi.md index 879ddedc7..ef4f7f6e0 100644 --- a/docs/ObjectEzsigntemplatepackagesignermembershipApi.md +++ b/docs/ObjectEzsigntemplatepackagesignermembershipApi.md @@ -19,6 +19,7 @@ The endpoint allows to create one or many elements at once. ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -64,6 +65,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ezsigntemplatepackagesignermembership_create_object_v1_request** | [**EzsigntemplatepackagesignermembershipCreateObjectV1Request**](EzsigntemplatepackagesignermembershipCreateObjectV1Request.md)| | @@ -82,6 +84,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **201** | Successful response | - | @@ -99,6 +102,7 @@ Delete an existing Ezsigntemplatepackagesignermembership ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -143,6 +147,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsigntemplatepackagesignermembership_id** | **int**| | @@ -161,6 +166,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -178,6 +184,7 @@ Retrieve an existing Ezsigntemplatepackagesignermembership ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -222,6 +229,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsigntemplatepackagesignermembership_id** | **int**| | @@ -240,6 +248,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | diff --git a/docs/ObjectEzsigntemplatesignatureApi.md b/docs/ObjectEzsigntemplatesignatureApi.md index f240c8704..95a29e34d 100644 --- a/docs/ObjectEzsigntemplatesignatureApi.md +++ b/docs/ObjectEzsigntemplatesignatureApi.md @@ -20,6 +20,7 @@ The endpoint allows to create one or many elements at once. ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -65,6 +66,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ezsigntemplatesignature_create_object_v1_request** | [**EzsigntemplatesignatureCreateObjectV1Request**](EzsigntemplatesignatureCreateObjectV1Request.md)| | @@ -83,6 +85,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **201** | Successful response | - | @@ -99,6 +102,7 @@ Delete an existing Ezsigntemplatesignature ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -143,6 +147,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsigntemplatesignature_id** | **int**| | @@ -161,6 +166,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -178,6 +184,7 @@ Edit an existing Ezsigntemplatesignature ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -224,6 +231,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsigntemplatesignature_id** | **int**| | @@ -243,6 +251,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -261,6 +270,7 @@ Retrieve an existing Ezsigntemplatesignature ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -305,6 +315,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsigntemplatesignature_id** | **int**| | @@ -323,6 +334,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | diff --git a/docs/ObjectEzsigntemplatesignerApi.md b/docs/ObjectEzsigntemplatesignerApi.md index 861ea5141..e09bac394 100644 --- a/docs/ObjectEzsigntemplatesignerApi.md +++ b/docs/ObjectEzsigntemplatesignerApi.md @@ -20,6 +20,7 @@ The endpoint allows to create one or many elements at once. ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -65,6 +66,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ezsigntemplatesigner_create_object_v1_request** | [**EzsigntemplatesignerCreateObjectV1Request**](EzsigntemplatesignerCreateObjectV1Request.md)| | @@ -83,6 +85,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **201** | Successful response | - | @@ -99,6 +102,7 @@ Delete an existing Ezsigntemplatesigner ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -143,6 +147,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsigntemplatesigner_id** | **int**| | @@ -161,6 +166,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -178,6 +184,7 @@ Edit an existing Ezsigntemplatesigner ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -224,6 +231,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsigntemplatesigner_id** | **int**| | @@ -243,6 +251,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -261,6 +270,7 @@ Retrieve an existing Ezsigntemplatesigner ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -305,6 +315,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsigntemplatesigner_id** | **int**| | @@ -323,6 +334,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | diff --git a/docs/ObjectEzsigntsarequirementApi.md b/docs/ObjectEzsigntsarequirementApi.md index 43779e459..5cd5ea4e9 100644 --- a/docs/ObjectEzsigntsarequirementApi.md +++ b/docs/ObjectEzsigntsarequirementApi.md @@ -17,6 +17,7 @@ Get the list of Ezsigntsarequirement to be used in a dropdown or autocomplete co ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -66,6 +67,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **s_selector** | **str**| The type of Ezsigntsarequirements to return | @@ -88,6 +90,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | diff --git a/docs/ObjectFontApi.md b/docs/ObjectFontApi.md index 3efc6f332..0ac57aed1 100644 --- a/docs/ObjectFontApi.md +++ b/docs/ObjectFontApi.md @@ -17,6 +17,7 @@ Get the list of Font to be used in a dropdown or autocomplete control. ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -65,6 +66,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **s_selector** | **str**| The type of Fonts to return | @@ -86,6 +88,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | diff --git a/docs/ObjectFranchisebrokerApi.md b/docs/ObjectFranchisebrokerApi.md index 8a39be471..c7156cf68 100644 --- a/docs/ObjectFranchisebrokerApi.md +++ b/docs/ObjectFranchisebrokerApi.md @@ -18,6 +18,7 @@ Get the list of Franchisebrokers to be used in a dropdown or autocomplete contro ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -66,6 +67,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **s_selector** | **str**| The type of Franchisebrokers to return | @@ -87,6 +89,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -103,6 +106,7 @@ Get the list of Franchisebroker to be used in a dropdown or autocomplete control ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -151,6 +155,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **s_selector** | **str**| The type of Franchisebrokers to return | @@ -172,6 +177,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | diff --git a/docs/ObjectFranchiseofficeApi.md b/docs/ObjectFranchiseofficeApi.md index 42957e0e4..44ed01e57 100644 --- a/docs/ObjectFranchiseofficeApi.md +++ b/docs/ObjectFranchiseofficeApi.md @@ -17,6 +17,7 @@ Get the list of Franchiseoffice to be used in a dropdown or autocomplete control ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -65,6 +66,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **s_selector** | **str**| The type of Franchiseoffices to return | @@ -86,6 +88,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | diff --git a/docs/ObjectFranchisereferalincomeApi.md b/docs/ObjectFranchisereferalincomeApi.md index 4399831c8..713df5c62 100644 --- a/docs/ObjectFranchisereferalincomeApi.md +++ b/docs/ObjectFranchisereferalincomeApi.md @@ -18,6 +18,7 @@ The endpoint allows to create one or many elements at once. The array can conta ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -63,6 +64,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **franchisereferalincome_create_object_v1_request** | [**List[FranchisereferalincomeCreateObjectV1Request]**](FranchisereferalincomeCreateObjectV1Request.md)| | @@ -81,6 +83,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **201** | Successful response | - | @@ -97,6 +100,7 @@ The endpoint allows to create one or many elements at once. ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -142,6 +146,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **franchisereferalincome_create_object_v2_request** | [**FranchisereferalincomeCreateObjectV2Request**](FranchisereferalincomeCreateObjectV2Request.md)| | @@ -160,6 +165,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **201** | Successful response | - | diff --git a/docs/ObjectInscriptionApi.md b/docs/ObjectInscriptionApi.md index df47997b7..8d748048d 100644 --- a/docs/ObjectInscriptionApi.md +++ b/docs/ObjectInscriptionApi.md @@ -4,9 +4,93 @@ All URIs are relative to *https://prod.api.appcluster01.ca-central-1.ezmax.com/r Method | HTTP request | Description ------------- | ------------- | ------------- +[**inscription_get_attachments_v1**](ObjectInscriptionApi.md#inscription_get_attachments_v1) | **GET** /1/object/inscription/{pkiInscriptionID}/getAttachments | Retrieve Inscription's Attachments [**inscription_get_communication_list_v1**](ObjectInscriptionApi.md#inscription_get_communication_list_v1) | **GET** /1/object/inscription/{pkiInscriptionID}/getCommunicationList | Retrieve Communication list +[**inscription_get_communicationsenders_v1**](ObjectInscriptionApi.md#inscription_get_communicationsenders_v1) | **GET** /1/object/inscription/{pkiInscriptionID}/getCommunicationsenders | Retrieve Inscription's Communicationsender +# **inscription_get_attachments_v1** +> InscriptionGetAttachmentsV1Response inscription_get_attachments_v1(pki_inscription_id) + +Retrieve Inscription's Attachments + + + +### Example + +* Api Key Authentication (Authorization): + +```python +import time +import os +import eZmaxApi +from eZmaxApi.models.inscription_get_attachments_v1_response import InscriptionGetAttachmentsV1Response +from eZmaxApi.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest +# See configuration.py for a list of all supported configuration parameters. +configuration = eZmaxApi.Configuration( + host = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: Authorization +configuration.api_key['Authorization'] = os.environ["API_KEY"] + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['Authorization'] = 'Bearer' + +# Enter a context with an instance of the API client +with eZmaxApi.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = eZmaxApi.ObjectInscriptionApi(api_client) + pki_inscription_id = 56 # int | + + try: + # Retrieve Inscription's Attachments + api_response = api_instance.inscription_get_attachments_v1(pki_inscription_id) + print("The response of ObjectInscriptionApi->inscription_get_attachments_v1:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ObjectInscriptionApi->inscription_get_attachments_v1: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pki_inscription_id** | **int**| | + +### Return type + +[**InscriptionGetAttachmentsV1Response**](InscriptionGetAttachmentsV1Response.md) + +### Authorization + +[Authorization](../README.md#Authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Successful response | - | +**404** | The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + # **inscription_get_communication_list_v1** > InscriptionGetCommunicationListV1Response inscription_get_communication_list_v1(pki_inscription_id) @@ -17,6 +101,7 @@ Retrieve Communication list ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -61,6 +146,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_inscription_id** | **int**| | @@ -79,6 +165,89 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Successful response | - | +**404** | The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **inscription_get_communicationsenders_v1** +> InscriptionGetCommunicationsendersV1Response inscription_get_communicationsenders_v1(pki_inscription_id) + +Retrieve Inscription's Communicationsender + + + +### Example + +* Api Key Authentication (Authorization): + +```python +import time +import os +import eZmaxApi +from eZmaxApi.models.inscription_get_communicationsenders_v1_response import InscriptionGetCommunicationsendersV1Response +from eZmaxApi.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest +# See configuration.py for a list of all supported configuration parameters. +configuration = eZmaxApi.Configuration( + host = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: Authorization +configuration.api_key['Authorization'] = os.environ["API_KEY"] + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['Authorization'] = 'Bearer' + +# Enter a context with an instance of the API client +with eZmaxApi.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = eZmaxApi.ObjectInscriptionApi(api_client) + pki_inscription_id = 56 # int | + + try: + # Retrieve Inscription's Communicationsender + api_response = api_instance.inscription_get_communicationsenders_v1(pki_inscription_id) + print("The response of ObjectInscriptionApi->inscription_get_communicationsenders_v1:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ObjectInscriptionApi->inscription_get_communicationsenders_v1: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pki_inscription_id** | **int**| | + +### Return type + +[**InscriptionGetCommunicationsendersV1Response**](InscriptionGetCommunicationsendersV1Response.md) + +### Authorization + +[Authorization](../README.md#Authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | diff --git a/docs/ObjectInscriptionnotauthenticatedApi.md b/docs/ObjectInscriptionnotauthenticatedApi.md index e4c972ed0..b70da6fa8 100644 --- a/docs/ObjectInscriptionnotauthenticatedApi.md +++ b/docs/ObjectInscriptionnotauthenticatedApi.md @@ -17,6 +17,7 @@ Retrieve Communication list ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -61,6 +62,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_inscriptionnotauthenticated_id** | **int**| | @@ -79,6 +81,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | diff --git a/docs/ObjectInscriptiontempApi.md b/docs/ObjectInscriptiontempApi.md index ac4fe8ee1..70d8a8e10 100644 --- a/docs/ObjectInscriptiontempApi.md +++ b/docs/ObjectInscriptiontempApi.md @@ -17,6 +17,7 @@ Retrieve Communication list ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -61,6 +62,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_inscriptiontemp_id** | **int**| | @@ -79,6 +81,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | diff --git a/docs/ObjectInvoiceApi.md b/docs/ObjectInvoiceApi.md index c151d7765..330c7101b 100644 --- a/docs/ObjectInvoiceApi.md +++ b/docs/ObjectInvoiceApi.md @@ -4,9 +4,92 @@ All URIs are relative to *https://prod.api.appcluster01.ca-central-1.ezmax.com/r Method | HTTP request | Description ------------- | ------------- | ------------- +[**invoice_get_attachments_v1**](ObjectInvoiceApi.md#invoice_get_attachments_v1) | **GET** /1/object/invoice/{pkiInvoiceID}/getAttachments | Retrieve Invoice's Attachments [**invoice_get_communication_list_v1**](ObjectInvoiceApi.md#invoice_get_communication_list_v1) | **GET** /1/object/invoice/{pkiInvoiceID}/getCommunicationList | Retrieve Communication list +# **invoice_get_attachments_v1** +> InvoiceGetAttachmentsV1Response invoice_get_attachments_v1(pki_invoice_id) + +Retrieve Invoice's Attachments + + + +### Example + +* Api Key Authentication (Authorization): + +```python +import time +import os +import eZmaxApi +from eZmaxApi.models.invoice_get_attachments_v1_response import InvoiceGetAttachmentsV1Response +from eZmaxApi.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest +# See configuration.py for a list of all supported configuration parameters. +configuration = eZmaxApi.Configuration( + host = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: Authorization +configuration.api_key['Authorization'] = os.environ["API_KEY"] + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['Authorization'] = 'Bearer' + +# Enter a context with an instance of the API client +with eZmaxApi.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = eZmaxApi.ObjectInvoiceApi(api_client) + pki_invoice_id = 56 # int | + + try: + # Retrieve Invoice's Attachments + api_response = api_instance.invoice_get_attachments_v1(pki_invoice_id) + print("The response of ObjectInvoiceApi->invoice_get_attachments_v1:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ObjectInvoiceApi->invoice_get_attachments_v1: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pki_invoice_id** | **int**| | + +### Return type + +[**InvoiceGetAttachmentsV1Response**](InvoiceGetAttachmentsV1Response.md) + +### Authorization + +[Authorization](../README.md#Authorization) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Successful response | - | +**404** | The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + # **invoice_get_communication_list_v1** > InvoiceGetCommunicationListV1Response invoice_get_communication_list_v1(pki_invoice_id) @@ -17,6 +100,7 @@ Retrieve Communication list ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -61,6 +145,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_invoice_id** | **int**| | @@ -79,6 +164,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | diff --git a/docs/ObjectLanguageApi.md b/docs/ObjectLanguageApi.md index e01ce89ed..559b7b73c 100644 --- a/docs/ObjectLanguageApi.md +++ b/docs/ObjectLanguageApi.md @@ -17,6 +17,7 @@ Get the list of Language to be used in a dropdown or autocomplete control. ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -65,6 +66,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **s_selector** | **str**| The type of Languages to return | @@ -86,6 +88,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | diff --git a/docs/ObjectModulegroupApi.md b/docs/ObjectModulegroupApi.md index 3d381508c..eb90a1fcc 100644 --- a/docs/ObjectModulegroupApi.md +++ b/docs/ObjectModulegroupApi.md @@ -15,6 +15,7 @@ Retrieve all Modulegroups ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -59,6 +60,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **e_context** | **str**| The context of the Modulegroup | @@ -77,6 +79,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | diff --git a/docs/ObjectNotificationsectionApi.md b/docs/ObjectNotificationsectionApi.md index dc99a3468..575d381f0 100644 --- a/docs/ObjectNotificationsectionApi.md +++ b/docs/ObjectNotificationsectionApi.md @@ -17,6 +17,7 @@ Retrieve an existing Notificationsection's Notificationtests ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -62,6 +63,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_notificationsection_id** | **int**| | @@ -81,6 +83,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | diff --git a/docs/ObjectNotificationtestApi.md b/docs/ObjectNotificationtestApi.md index f50d4b8de..a0058df0e 100644 --- a/docs/ObjectNotificationtestApi.md +++ b/docs/ObjectNotificationtestApi.md @@ -17,6 +17,7 @@ Retrieve an existing Notificationtest's Elements ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -61,6 +62,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_notificationtest_id** | **int**| | @@ -79,6 +81,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | diff --git a/docs/ObjectOtherincomeApi.md b/docs/ObjectOtherincomeApi.md index 235817334..1d4385864 100644 --- a/docs/ObjectOtherincomeApi.md +++ b/docs/ObjectOtherincomeApi.md @@ -17,6 +17,7 @@ Retrieve Communication list ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -61,6 +62,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_otherincome_id** | **int**| | @@ -79,6 +81,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | diff --git a/docs/ObjectPaymenttermApi.md b/docs/ObjectPaymenttermApi.md index e7b306be0..8ba628ba7 100644 --- a/docs/ObjectPaymenttermApi.md +++ b/docs/ObjectPaymenttermApi.md @@ -21,6 +21,7 @@ The endpoint allows to create one or many elements at once. ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -66,6 +67,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **paymentterm_create_object_v1_request** | [**PaymenttermCreateObjectV1Request**](PaymenttermCreateObjectV1Request.md)| | @@ -84,6 +86,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **201** | Successful response | - | @@ -101,6 +104,7 @@ Edit an existing Paymentterm ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -147,6 +151,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_paymentterm_id** | **int**| | @@ -166,6 +171,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -184,6 +190,7 @@ Get the list of Paymentterm to be used in a dropdown or autocomplete control. ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -232,6 +239,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **s_selector** | **str**| The type of Paymentterms to return | @@ -253,6 +261,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -267,6 +276,7 @@ Retrieve Paymentterm list ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -316,6 +326,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **e_order_by** | **str**| Specify how you want the results to be sorted | [optional] @@ -338,6 +349,7 @@ Name | Type | Description | Notes - **Accept**: application/json, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -355,6 +367,7 @@ Retrieve an existing Paymentterm ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -399,6 +412,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_paymentterm_id** | **int**| | @@ -417,6 +431,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | diff --git a/docs/ObjectPeriodApi.md b/docs/ObjectPeriodApi.md index 95c10ba7a..66729626c 100644 --- a/docs/ObjectPeriodApi.md +++ b/docs/ObjectPeriodApi.md @@ -18,6 +18,7 @@ Get the list of Periods to be used in a dropdown or autocomplete control. ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -66,6 +67,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **s_selector** | **str**| The types of Periods to return | @@ -87,6 +89,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -103,6 +106,7 @@ Get the list of Period to be used in a dropdown or autocomplete control. ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -151,6 +155,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **s_selector** | **str**| The type of Periods to return | @@ -172,6 +177,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | diff --git a/docs/ObjectPermissionApi.md b/docs/ObjectPermissionApi.md index c027811b9..6bb93b7bc 100644 --- a/docs/ObjectPermissionApi.md +++ b/docs/ObjectPermissionApi.md @@ -20,6 +20,7 @@ The endpoint allows to create one or many elements at once. ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -65,6 +66,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **permission_create_object_v1_request** | [**PermissionCreateObjectV1Request**](PermissionCreateObjectV1Request.md)| | @@ -83,6 +85,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **201** | Successful response | - | @@ -100,6 +103,7 @@ Delete an existing Permission ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -144,6 +148,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_permission_id** | **int**| The unique ID of the Permission | @@ -162,6 +167,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -179,6 +185,7 @@ Edit an existing Permission ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -225,6 +232,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_permission_id** | **int**| The unique ID of the Permission | @@ -244,6 +252,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -262,6 +271,7 @@ Retrieve an existing Permission ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -306,6 +316,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_permission_id** | **int**| The unique ID of the Permission | @@ -324,6 +335,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | diff --git a/docs/ObjectPhonetypeApi.md b/docs/ObjectPhonetypeApi.md index bc2e2e994..f6c0e27ca 100644 --- a/docs/ObjectPhonetypeApi.md +++ b/docs/ObjectPhonetypeApi.md @@ -17,6 +17,7 @@ Get the list of Phonetype to be used in a dropdown or autocomplete control. ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -65,6 +66,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **s_selector** | **str**| The type of Phonetypes to return | @@ -86,6 +88,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | diff --git a/docs/ObjectRejectedoffertopurchaseApi.md b/docs/ObjectRejectedoffertopurchaseApi.md index 9603605a7..156f934fe 100644 --- a/docs/ObjectRejectedoffertopurchaseApi.md +++ b/docs/ObjectRejectedoffertopurchaseApi.md @@ -17,6 +17,7 @@ Retrieve Communication list ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -61,6 +62,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_rejectedoffertopurchase_id** | **int**| | @@ -79,6 +81,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | diff --git a/docs/ObjectSecretquestionApi.md b/docs/ObjectSecretquestionApi.md index c9ff83ea0..0ecc4a356 100644 --- a/docs/ObjectSecretquestionApi.md +++ b/docs/ObjectSecretquestionApi.md @@ -17,6 +17,7 @@ Get the list of Secretquestion to be used in a dropdown or autocomplete control. ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -65,6 +66,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **s_selector** | **str**| The type of Secretquestions to return | @@ -86,6 +88,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | diff --git a/docs/ObjectSessionhistoryApi.md b/docs/ObjectSessionhistoryApi.md index 766884b5d..88a25c135 100644 --- a/docs/ObjectSessionhistoryApi.md +++ b/docs/ObjectSessionhistoryApi.md @@ -15,6 +15,7 @@ Retrieve Sessionhistory list ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -64,6 +65,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **e_order_by** | **str**| Specify how you want the results to be sorted | [optional] @@ -86,6 +88,7 @@ Name | Type | Description | Notes - **Accept**: application/json, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | diff --git a/docs/ObjectSignatureApi.md b/docs/ObjectSignatureApi.md index 06bcc7e6b..98cf278c9 100644 --- a/docs/ObjectSignatureApi.md +++ b/docs/ObjectSignatureApi.md @@ -20,6 +20,7 @@ The endpoint allows to create one or many elements at once. ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -65,6 +66,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **signature_create_object_v1_request** | [**SignatureCreateObjectV1Request**](SignatureCreateObjectV1Request.md)| | @@ -83,6 +85,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **201** | Successful response | - | @@ -99,6 +102,7 @@ Delete an existing Signature ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -143,6 +147,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_signature_id** | **int**| The unique ID of the Signature | @@ -161,6 +166,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -178,6 +184,7 @@ Edit an existing Signature ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -224,6 +231,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_signature_id** | **int**| The unique ID of the Signature | @@ -243,6 +251,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -261,6 +270,7 @@ Retrieve an existing Signature ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -305,6 +315,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_signature_id** | **int**| The unique ID of the Signature | @@ -323,6 +334,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | diff --git a/docs/ObjectSubnetApi.md b/docs/ObjectSubnetApi.md index a758241f6..94c4b757b 100644 --- a/docs/ObjectSubnetApi.md +++ b/docs/ObjectSubnetApi.md @@ -20,6 +20,7 @@ The endpoint allows to create one or many elements at once. ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -65,6 +66,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **subnet_create_object_v1_request** | [**SubnetCreateObjectV1Request**](SubnetCreateObjectV1Request.md)| | @@ -83,6 +85,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **201** | Successful response | - | @@ -100,6 +103,7 @@ Delete an existing Subnet ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -144,6 +148,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_subnet_id** | **int**| The unique ID of the Subnet | @@ -162,6 +167,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -180,6 +186,7 @@ Edit an existing Subnet ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -226,6 +233,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_subnet_id** | **int**| The unique ID of the Subnet | @@ -245,6 +253,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -263,6 +272,7 @@ Retrieve an existing Subnet ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -307,6 +317,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_subnet_id** | **int**| The unique ID of the Subnet | @@ -325,6 +336,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | diff --git a/docs/ObjectSystemconfigurationApi.md b/docs/ObjectSystemconfigurationApi.md index 13333495c..46eb097ad 100644 --- a/docs/ObjectSystemconfigurationApi.md +++ b/docs/ObjectSystemconfigurationApi.md @@ -18,6 +18,7 @@ Edit an existing Systemconfiguration ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -64,6 +65,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_systemconfiguration_id** | **int**| The unique ID of the Systemconfiguration | @@ -83,6 +85,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -101,6 +104,7 @@ Retrieve an existing Systemconfiguration ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -145,6 +149,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_systemconfiguration_id** | **int**| The unique ID of the Systemconfiguration | @@ -163,6 +168,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | diff --git a/docs/ObjectTaxassignmentApi.md b/docs/ObjectTaxassignmentApi.md index bbceee81f..2f57cb678 100644 --- a/docs/ObjectTaxassignmentApi.md +++ b/docs/ObjectTaxassignmentApi.md @@ -17,6 +17,7 @@ Get the list of Taxassignment to be used in a dropdown or autocomplete control. ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -65,6 +66,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **s_selector** | **str**| The type of Taxassignments to return | @@ -86,6 +88,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | diff --git a/docs/ObjectTimezoneApi.md b/docs/ObjectTimezoneApi.md index d91034e91..f56f1dd16 100644 --- a/docs/ObjectTimezoneApi.md +++ b/docs/ObjectTimezoneApi.md @@ -17,6 +17,7 @@ Get the list of Timezone to be used in a dropdown or autocomplete control. ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -65,6 +66,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **s_selector** | **str**| The type of Timezones to return | @@ -86,6 +88,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | diff --git a/docs/ObjectUserApi.md b/docs/ObjectUserApi.md index b0d46bed2..baabc74a2 100644 --- a/docs/ObjectUserApi.md +++ b/docs/ObjectUserApi.md @@ -27,6 +27,7 @@ The endpoint allows to create one or many elements at once. ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -72,6 +73,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **user_create_object_v1_request** | [**UserCreateObjectV1Request**](UserCreateObjectV1Request.md)| | @@ -90,6 +92,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **201** | Successful response | - | @@ -106,6 +109,7 @@ Edit an existing User ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -152,6 +156,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_user_id** | **int**| The unique ID of the User | @@ -171,6 +176,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -189,6 +195,7 @@ Using this endpoint, you can edit multiple Permissions at the same time. ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -235,6 +242,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_user_id** | **int**| | @@ -254,6 +262,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -270,6 +279,7 @@ Retrieve an existing User's Apikeys ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -314,6 +324,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_user_id** | **int**| | @@ -332,6 +343,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -349,6 +361,7 @@ Get the list of User to be used in a dropdown or autocomplete control. ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -397,6 +410,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **s_selector** | **str**| The type of Users to return | @@ -418,6 +432,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -434,6 +449,7 @@ Effective Permissions refers to the combination of Permissions held by a User an ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -478,6 +494,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_user_id** | **int**| | @@ -496,6 +513,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -513,6 +531,7 @@ Enum values that can be filtered in query parameter *sFilter*: | Variable | Val ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -562,6 +581,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **e_order_by** | **str**| Specify how you want the results to be sorted | [optional] @@ -584,6 +604,7 @@ Name | Type | Description | Notes - **Accept**: application/json, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -601,6 +622,7 @@ Retrieve an existing User ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -645,6 +667,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_user_id** | **int**| The unique ID of the User | @@ -663,6 +686,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -678,6 +702,7 @@ Retrieve an existing User's Permissions ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -722,6 +747,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_user_id** | **int**| | @@ -740,6 +766,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -755,6 +782,7 @@ Retrieve an existing User's Subnets ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -799,6 +827,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_user_id** | **int**| | @@ -817,6 +846,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -834,6 +864,7 @@ Send the password reset email ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -879,6 +910,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_user_id** | **int**| | @@ -898,6 +930,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | diff --git a/docs/ObjectUsergroupApi.md b/docs/ObjectUsergroupApi.md index 7ef107eae..cbdd6a769 100644 --- a/docs/ObjectUsergroupApi.md +++ b/docs/ObjectUsergroupApi.md @@ -27,6 +27,7 @@ The endpoint allows to create one or many elements at once. ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -72,6 +73,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **usergroup_create_object_v1_request** | [**UsergroupCreateObjectV1Request**](UsergroupCreateObjectV1Request.md)| | @@ -90,6 +92,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **201** | Successful response | - | @@ -106,6 +109,7 @@ Edit an existing Usergroup ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -152,6 +156,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_usergroup_id** | **int**| | @@ -171,6 +176,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -189,6 +195,7 @@ Using this endpoint, you can edit multiple Permissions at the same time. ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -235,6 +242,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_usergroup_id** | **int**| | @@ -254,6 +262,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -272,6 +281,7 @@ Edit multiple Usergroupdelegations ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -318,6 +328,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_usergroup_id** | **int**| | @@ -337,6 +348,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -355,6 +367,7 @@ Using this endpoint, you can edit multiple Usergroupmemberships at the same time ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -401,6 +414,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_usergroup_id** | **int**| | @@ -420,6 +434,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -438,6 +453,7 @@ Get the list of Usergroup to be used in a dropdown or autocomplete control. ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -486,6 +502,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **s_selector** | **str**| The type of Usergroups to return | @@ -507,6 +524,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -523,6 +541,7 @@ Retrieve Usergroup list ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -572,6 +591,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **e_order_by** | **str**| Specify how you want the results to be sorted | [optional] @@ -594,6 +614,7 @@ Name | Type | Description | Notes - **Accept**: application/json, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -611,6 +632,7 @@ Retrieve an existing Usergroup ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -655,6 +677,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_usergroup_id** | **int**| | @@ -673,6 +696,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -688,6 +712,7 @@ Retrieve an existing Usergroup's Permissions ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -732,6 +757,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_usergroup_id** | **int**| | @@ -750,6 +776,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -765,6 +792,7 @@ Retrieve an existing Usergroup's Usergroupdelegations ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -809,6 +837,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_usergroup_id** | **int**| | @@ -827,6 +856,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -842,6 +872,7 @@ Retrieve an existing Usergroup's Usergroupmemberships ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -886,6 +917,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_usergroup_id** | **int**| | @@ -904,6 +936,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | diff --git a/docs/ObjectUsergroupdelegationApi.md b/docs/ObjectUsergroupdelegationApi.md index eca695ebf..3224b025a 100644 --- a/docs/ObjectUsergroupdelegationApi.md +++ b/docs/ObjectUsergroupdelegationApi.md @@ -20,6 +20,7 @@ The endpoint allows to create one or many elements at once. ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -65,6 +66,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **usergroupdelegation_create_object_v1_request** | [**UsergroupdelegationCreateObjectV1Request**](UsergroupdelegationCreateObjectV1Request.md)| | @@ -83,6 +85,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **201** | Successful response | - | @@ -99,6 +102,7 @@ Delete an existing Usergroupdelegation ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -143,6 +147,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_usergroupdelegation_id** | **int**| The unique ID of the Usergroupdelegation | @@ -161,6 +166,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -178,6 +184,7 @@ Edit an existing Usergroupdelegation ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -224,6 +231,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_usergroupdelegation_id** | **int**| The unique ID of the Usergroupdelegation | @@ -243,6 +251,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -261,6 +270,7 @@ Retrieve an existing Usergroupdelegation ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -305,6 +315,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_usergroupdelegation_id** | **int**| The unique ID of the Usergroupdelegation | @@ -323,6 +334,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | diff --git a/docs/ObjectUsergroupmembershipApi.md b/docs/ObjectUsergroupmembershipApi.md index 8004a9328..f7ac1ed1e 100644 --- a/docs/ObjectUsergroupmembershipApi.md +++ b/docs/ObjectUsergroupmembershipApi.md @@ -20,6 +20,7 @@ The endpoint allows to create one or many elements at once. ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -65,6 +66,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **usergroupmembership_create_object_v1_request** | [**UsergroupmembershipCreateObjectV1Request**](UsergroupmembershipCreateObjectV1Request.md)| | @@ -83,6 +85,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **201** | Successful response | - | @@ -99,6 +102,7 @@ Delete an existing Usergroupmembership ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -143,6 +147,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_usergroupmembership_id** | **int**| | @@ -161,6 +166,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -178,6 +184,7 @@ Edit an existing Usergroupmembership ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -224,6 +231,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_usergroupmembership_id** | **int**| | @@ -243,6 +251,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -261,6 +270,7 @@ Retrieve an existing Usergroupmembership ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -305,6 +315,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_usergroupmembership_id** | **int**| | @@ -323,6 +334,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | diff --git a/docs/ObjectUserlogintypeApi.md b/docs/ObjectUserlogintypeApi.md index e45e150ab..6fedb351f 100644 --- a/docs/ObjectUserlogintypeApi.md +++ b/docs/ObjectUserlogintypeApi.md @@ -17,6 +17,7 @@ Get the list of Userlogintype to be used in a dropdown or autocomplete control. ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -65,6 +66,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **s_selector** | **str**| The type of Userlogintypes to return | @@ -86,6 +88,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | diff --git a/docs/ObjectUserstagedApi.md b/docs/ObjectUserstagedApi.md index b3e2e02c9..ac78bfa5f 100644 --- a/docs/ObjectUserstagedApi.md +++ b/docs/ObjectUserstagedApi.md @@ -21,6 +21,7 @@ Default values will be used while creating the User. If you need to change those ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -66,6 +67,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_userstaged_id** | **int**| | @@ -85,6 +87,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -102,6 +105,7 @@ Delete an existing Userstaged ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -146,6 +150,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_userstaged_id** | **int**| | @@ -164,6 +169,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -181,6 +187,7 @@ Retrieve Userstaged list ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -230,6 +237,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **e_order_by** | **str**| Specify how you want the results to be sorted | [optional] @@ -252,6 +260,7 @@ Name | Type | Description | Notes - **Accept**: application/json, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -269,6 +278,7 @@ Retrieve an existing Userstaged ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -313,6 +323,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_userstaged_id** | **int**| | @@ -331,6 +342,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -348,6 +360,7 @@ Map the Userstaged to an existing user ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -394,6 +407,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_userstaged_id** | **int**| | @@ -413,6 +427,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | diff --git a/docs/ObjectVariableexpenseApi.md b/docs/ObjectVariableexpenseApi.md index 2f071dad7..9624903ed 100644 --- a/docs/ObjectVariableexpenseApi.md +++ b/docs/ObjectVariableexpenseApi.md @@ -21,6 +21,7 @@ The endpoint allows to create one or many elements at once. ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -66,6 +67,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **variableexpense_create_object_v1_request** | [**VariableexpenseCreateObjectV1Request**](VariableexpenseCreateObjectV1Request.md)| | @@ -84,6 +86,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **201** | Successful response | - | @@ -100,6 +103,7 @@ Edit an existing Variableexpense ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -146,6 +150,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_variableexpense_id** | **int**| | @@ -165,6 +170,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -183,6 +189,7 @@ Get the list of Variableexpense to be used in a dropdown or autocomplete control ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -231,6 +238,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **s_selector** | **str**| The type of Variableexpenses to return | @@ -252,6 +260,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -268,6 +277,7 @@ Enum values that can be filtered in query parameter *sFilter*: | Variable | Val ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -317,6 +327,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **e_order_by** | **str**| Specify how you want the results to be sorted | [optional] @@ -339,6 +350,7 @@ Name | Type | Description | Notes - **Accept**: application/json, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -356,6 +368,7 @@ Retrieve an existing Variableexpense ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -400,6 +413,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_variableexpense_id** | **int**| | @@ -418,6 +432,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | diff --git a/docs/ObjectVersionhistoryApi.md b/docs/ObjectVersionhistoryApi.md index 6bdbe75c4..347b7c72f 100644 --- a/docs/ObjectVersionhistoryApi.md +++ b/docs/ObjectVersionhistoryApi.md @@ -17,6 +17,7 @@ Retrieve an existing Versionhistory ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -61,6 +62,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_versionhistory_id** | **int**| | @@ -79,6 +81,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | diff --git a/docs/ObjectWebhookApi.md b/docs/ObjectWebhookApi.md index 2ca49ec51..22a6fef63 100644 --- a/docs/ObjectWebhookApi.md +++ b/docs/ObjectWebhookApi.md @@ -5,11 +5,13 @@ All URIs are relative to *https://prod.api.appcluster01.ca-central-1.ezmax.com/r Method | HTTP request | Description ------------- | ------------- | ------------- [**webhook_create_object_v1**](ObjectWebhookApi.md#webhook_create_object_v1) | **POST** /1/object/webhook | Create a new Webhook +[**webhook_create_object_v2**](ObjectWebhookApi.md#webhook_create_object_v2) | **POST** /2/object/webhook | Create a new Webhook [**webhook_delete_object_v1**](ObjectWebhookApi.md#webhook_delete_object_v1) | **DELETE** /1/object/webhook/{pkiWebhookID} | Delete an existing Webhook [**webhook_edit_object_v1**](ObjectWebhookApi.md#webhook_edit_object_v1) | **PUT** /1/object/webhook/{pkiWebhookID} | Edit an existing Webhook [**webhook_get_history_v1**](ObjectWebhookApi.md#webhook_get_history_v1) | **GET** /1/object/webhook/{pkiWebhookID}/getHistory | Retrieve the logs for recent Webhook calls [**webhook_get_list_v1**](ObjectWebhookApi.md#webhook_get_list_v1) | **GET** /1/object/webhook/getList | Retrieve Webhook list [**webhook_get_object_v2**](ObjectWebhookApi.md#webhook_get_object_v2) | **GET** /2/object/webhook/{pkiWebhookID} | Retrieve an existing Webhook +[**webhook_regenerate_apikey_v1**](ObjectWebhookApi.md#webhook_regenerate_apikey_v1) | **POST** /1/object/webhook/{pkiWebhookID}/regenerateApikey | Regenerate the Apikey [**webhook_test_v1**](ObjectWebhookApi.md#webhook_test_v1) | **POST** /1/object/webhook/{pkiWebhookID}/test | Test the Webhook by calling the Url @@ -23,6 +25,7 @@ The endpoint allows to create one or many elements at once. ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -68,6 +71,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **webhook_create_object_v1_request** | [**WebhookCreateObjectV1Request**](WebhookCreateObjectV1Request.md)| | @@ -86,6 +90,89 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**201** | Successful response | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **webhook_create_object_v2** +> WebhookCreateObjectV2Response webhook_create_object_v2(webhook_create_object_v2_request) + +Create a new Webhook + +The endpoint allows to create one or many elements at once. + +### Example + +* Api Key Authentication (Authorization): + +```python +import time +import os +import eZmaxApi +from eZmaxApi.models.webhook_create_object_v2_request import WebhookCreateObjectV2Request +from eZmaxApi.models.webhook_create_object_v2_response import WebhookCreateObjectV2Response +from eZmaxApi.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest +# See configuration.py for a list of all supported configuration parameters. +configuration = eZmaxApi.Configuration( + host = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: Authorization +configuration.api_key['Authorization'] = os.environ["API_KEY"] + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['Authorization'] = 'Bearer' + +# Enter a context with an instance of the API client +with eZmaxApi.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = eZmaxApi.ObjectWebhookApi(api_client) + webhook_create_object_v2_request = eZmaxApi.WebhookCreateObjectV2Request() # WebhookCreateObjectV2Request | + + try: + # Create a new Webhook + api_response = api_instance.webhook_create_object_v2(webhook_create_object_v2_request) + print("The response of ObjectWebhookApi->webhook_create_object_v2:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ObjectWebhookApi->webhook_create_object_v2: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **webhook_create_object_v2_request** | [**WebhookCreateObjectV2Request**](WebhookCreateObjectV2Request.md)| | + +### Return type + +[**WebhookCreateObjectV2Response**](WebhookCreateObjectV2Response.md) + +### Authorization + +[Authorization](../README.md#Authorization) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **201** | Successful response | - | @@ -102,6 +189,7 @@ Delete an existing Webhook ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -146,6 +234,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_webhook_id** | **int**| | @@ -164,6 +253,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -181,6 +271,7 @@ Edit an existing Webhook ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -227,6 +318,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_webhook_id** | **int**| | @@ -246,6 +338,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -263,6 +356,7 @@ Retrieve the logs for recent Webhook calls ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -308,6 +402,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_webhook_id** | **int**| | @@ -327,6 +422,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -345,6 +441,7 @@ Enum values that can be filtered in query parameter *sFilter*: | Variable | Val ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -394,6 +491,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **e_order_by** | **str**| Specify how you want the results to be sorted | [optional] @@ -416,6 +514,7 @@ Name | Type | Description | Notes - **Accept**: application/json, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -433,6 +532,7 @@ Retrieve an existing Webhook ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -477,6 +577,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_webhook_id** | **int**| | @@ -495,6 +596,92 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Successful response | - | +**404** | The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **webhook_regenerate_apikey_v1** +> WebhookRegenerateApikeyV1Response webhook_regenerate_apikey_v1(pki_webhook_id, webhook_regenerate_apikey_v1_request) + +Regenerate the Apikey + + + +### Example + +* Api Key Authentication (Authorization): + +```python +import time +import os +import eZmaxApi +from eZmaxApi.models.webhook_regenerate_apikey_v1_request import WebhookRegenerateApikeyV1Request +from eZmaxApi.models.webhook_regenerate_apikey_v1_response import WebhookRegenerateApikeyV1Response +from eZmaxApi.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest +# See configuration.py for a list of all supported configuration parameters. +configuration = eZmaxApi.Configuration( + host = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: Authorization +configuration.api_key['Authorization'] = os.environ["API_KEY"] + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['Authorization'] = 'Bearer' + +# Enter a context with an instance of the API client +with eZmaxApi.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = eZmaxApi.ObjectWebhookApi(api_client) + pki_webhook_id = 56 # int | + webhook_regenerate_apikey_v1_request = eZmaxApi.WebhookRegenerateApikeyV1Request() # WebhookRegenerateApikeyV1Request | + + try: + # Regenerate the Apikey + api_response = api_instance.webhook_regenerate_apikey_v1(pki_webhook_id, webhook_regenerate_apikey_v1_request) + print("The response of ObjectWebhookApi->webhook_regenerate_apikey_v1:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ObjectWebhookApi->webhook_regenerate_apikey_v1: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pki_webhook_id** | **int**| | + **webhook_regenerate_apikey_v1_request** | [**WebhookRegenerateApikeyV1Request**](WebhookRegenerateApikeyV1Request.md)| | + +### Return type + +[**WebhookRegenerateApikeyV1Response**](WebhookRegenerateApikeyV1Response.md) + +### Authorization + +[Authorization](../README.md#Authorization) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | @@ -512,6 +699,7 @@ Test the Webhook by calling the Url ### Example * Api Key Authentication (Authorization): + ```python import time import os @@ -557,6 +745,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_webhook_id** | **int**| | @@ -576,6 +765,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Successful response | - | diff --git a/docs/OtherincomeGetCommunicationListV1Response.md b/docs/OtherincomeGetCommunicationListV1Response.md index d7e9453da..45e53b94a 100644 --- a/docs/OtherincomeGetCommunicationListV1Response.md +++ b/docs/OtherincomeGetCommunicationListV1Response.md @@ -3,6 +3,7 @@ Response for GET /1/object/otherincome/{pkiOtherincomeID}/getCommunicationList ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayloadGetList**](CommonResponseObjDebugPayloadGetList.md) | | diff --git a/docs/OtherincomeGetCommunicationListV1ResponseMPayload.md b/docs/OtherincomeGetCommunicationListV1ResponseMPayload.md index 6d99fbb9e..2c8ac6c19 100644 --- a/docs/OtherincomeGetCommunicationListV1ResponseMPayload.md +++ b/docs/OtherincomeGetCommunicationListV1ResponseMPayload.md @@ -3,6 +3,7 @@ Response for GET /1/object/otherincome/{pkiOtherincomeID}/getCommunicationList ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_communication** | [**List[CustomCommunicationListElementResponse]**](CustomCommunicationListElementResponse.md) | | diff --git a/docs/PaymenttermAutocompleteElementResponse.md b/docs/PaymenttermAutocompleteElementResponse.md index b71f4c0a5..dfe36e8c3 100644 --- a/docs/PaymenttermAutocompleteElementResponse.md +++ b/docs/PaymenttermAutocompleteElementResponse.md @@ -3,6 +3,7 @@ A Paymentterm AutocompleteElement Response ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_paymentterm_id** | **int** | The unique ID of the Paymentterm | diff --git a/docs/PaymenttermCreateObjectV1Request.md b/docs/PaymenttermCreateObjectV1Request.md index 26bcc685a..3b736f9a4 100644 --- a/docs/PaymenttermCreateObjectV1Request.md +++ b/docs/PaymenttermCreateObjectV1Request.md @@ -3,6 +3,7 @@ Request for POST /1/object/paymentterm ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_paymentterm** | [**List[PaymenttermRequestCompound]**](PaymenttermRequestCompound.md) | | diff --git a/docs/PaymenttermCreateObjectV1Response.md b/docs/PaymenttermCreateObjectV1Response.md index b7164c484..4987f913e 100644 --- a/docs/PaymenttermCreateObjectV1Response.md +++ b/docs/PaymenttermCreateObjectV1Response.md @@ -3,6 +3,7 @@ Response for POST /1/object/paymentterm ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/PaymenttermCreateObjectV1ResponseMPayload.md b/docs/PaymenttermCreateObjectV1ResponseMPayload.md index c66f547d0..8e5d0ef8b 100644 --- a/docs/PaymenttermCreateObjectV1ResponseMPayload.md +++ b/docs/PaymenttermCreateObjectV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for POST /1/object/paymentterm ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_pki_paymentterm_id** | **List[int]** | An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request. | diff --git a/docs/PaymenttermEditObjectV1Request.md b/docs/PaymenttermEditObjectV1Request.md index 943cdc0c5..7083f1eaa 100644 --- a/docs/PaymenttermEditObjectV1Request.md +++ b/docs/PaymenttermEditObjectV1Request.md @@ -3,6 +3,7 @@ Request for PUT /1/object/paymentterm/{pkiPaymenttermID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_paymentterm** | [**PaymenttermRequestCompound**](PaymenttermRequestCompound.md) | | diff --git a/docs/PaymenttermEditObjectV1Response.md b/docs/PaymenttermEditObjectV1Response.md index a6bd79828..5ab0e7432 100644 --- a/docs/PaymenttermEditObjectV1Response.md +++ b/docs/PaymenttermEditObjectV1Response.md @@ -3,6 +3,7 @@ Response for PUT /1/object/paymentterm/{pkiPaymenttermID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/PaymenttermGetAutocompleteV2Response.md b/docs/PaymenttermGetAutocompleteV2Response.md index c704bbc29..2a086d2f4 100644 --- a/docs/PaymenttermGetAutocompleteV2Response.md +++ b/docs/PaymenttermGetAutocompleteV2Response.md @@ -3,6 +3,7 @@ Response for GET /2/object/paymentterm/getAutocomplete ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/PaymenttermGetAutocompleteV2ResponseMPayload.md b/docs/PaymenttermGetAutocompleteV2ResponseMPayload.md index e4c2a1627..c09dea87c 100644 --- a/docs/PaymenttermGetAutocompleteV2ResponseMPayload.md +++ b/docs/PaymenttermGetAutocompleteV2ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for POST /2/object/paymentterm/getAutocomplete ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_paymentterm** | [**List[PaymenttermAutocompleteElementResponse]**](PaymenttermAutocompleteElementResponse.md) | An array of Paymentterm autocomplete element response. | diff --git a/docs/PaymenttermGetListV1Response.md b/docs/PaymenttermGetListV1Response.md index 3e0fc8fc8..3a50df5fe 100644 --- a/docs/PaymenttermGetListV1Response.md +++ b/docs/PaymenttermGetListV1Response.md @@ -3,6 +3,7 @@ Response for GET /1/object/paymentterm/getList ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayloadGetList**](CommonResponseObjDebugPayloadGetList.md) | | diff --git a/docs/PaymenttermGetListV1ResponseMPayload.md b/docs/PaymenttermGetListV1ResponseMPayload.md index 72e43d7cd..233a29dac 100644 --- a/docs/PaymenttermGetListV1ResponseMPayload.md +++ b/docs/PaymenttermGetListV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for GET /1/object/paymentterm/getList ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **i_row_returned** | **int** | The number of rows returned | diff --git a/docs/PaymenttermGetObjectV2Response.md b/docs/PaymenttermGetObjectV2Response.md index 06ca3d8ac..68915bc7c 100644 --- a/docs/PaymenttermGetObjectV2Response.md +++ b/docs/PaymenttermGetObjectV2Response.md @@ -3,6 +3,7 @@ Response for GET /2/object/paymentterm/{pkiPaymenttermID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/PaymenttermGetObjectV2ResponseMPayload.md b/docs/PaymenttermGetObjectV2ResponseMPayload.md index cfa705455..2e5914f57 100644 --- a/docs/PaymenttermGetObjectV2ResponseMPayload.md +++ b/docs/PaymenttermGetObjectV2ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for GET /2/object/paymentterm/{pkiPaymenttermID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_paymentterm** | [**PaymenttermResponseCompound**](PaymenttermResponseCompound.md) | | diff --git a/docs/PaymenttermListElement.md b/docs/PaymenttermListElement.md index 8ed6d1c53..22dd4aa42 100644 --- a/docs/PaymenttermListElement.md +++ b/docs/PaymenttermListElement.md @@ -3,6 +3,7 @@ A Paymentterm List Element ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_paymentterm_id** | **int** | The unique ID of the Paymentterm | diff --git a/docs/PaymenttermRequest.md b/docs/PaymenttermRequest.md index bc8c0ee0e..3eff5e1f9 100644 --- a/docs/PaymenttermRequest.md +++ b/docs/PaymenttermRequest.md @@ -3,6 +3,7 @@ A Paymentterm Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_paymentterm_id** | **int** | The unique ID of the Paymentterm | [optional] diff --git a/docs/PaymenttermRequestCompound.md b/docs/PaymenttermRequestCompound.md index c20758b31..495ec4476 100644 --- a/docs/PaymenttermRequestCompound.md +++ b/docs/PaymenttermRequestCompound.md @@ -3,6 +3,7 @@ A Paymentterm Object and children ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_paymentterm_id** | **int** | The unique ID of the Paymentterm | [optional] diff --git a/docs/PaymenttermResponse.md b/docs/PaymenttermResponse.md index 719330ef4..3d5d4a3d3 100644 --- a/docs/PaymenttermResponse.md +++ b/docs/PaymenttermResponse.md @@ -3,6 +3,7 @@ A Paymentterm Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_paymentterm_id** | **int** | The unique ID of the Paymentterm | diff --git a/docs/PaymenttermResponseCompound.md b/docs/PaymenttermResponseCompound.md index 33a924afa..0d469471c 100644 --- a/docs/PaymenttermResponseCompound.md +++ b/docs/PaymenttermResponseCompound.md @@ -3,6 +3,7 @@ A Paymentterm Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_paymentterm_id** | **int** | The unique ID of the Paymentterm | diff --git a/docs/PeriodAutocompleteElementResponse.md b/docs/PeriodAutocompleteElementResponse.md index 8003143a1..4fa3b8175 100644 --- a/docs/PeriodAutocompleteElementResponse.md +++ b/docs/PeriodAutocompleteElementResponse.md @@ -3,6 +3,7 @@ A Period AutocompleteElement Response ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **s_period_yyyymm** | **str** | The YYYYMM of the Period | diff --git a/docs/PeriodGetAutocompleteV2Response.md b/docs/PeriodGetAutocompleteV2Response.md index b178fc8bd..c97932c69 100644 --- a/docs/PeriodGetAutocompleteV2Response.md +++ b/docs/PeriodGetAutocompleteV2Response.md @@ -3,6 +3,7 @@ Response for GET /2/object/period/getAutocomplete ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/PeriodGetAutocompleteV2ResponseMPayload.md b/docs/PeriodGetAutocompleteV2ResponseMPayload.md index 03d91d439..feed427da 100644 --- a/docs/PeriodGetAutocompleteV2ResponseMPayload.md +++ b/docs/PeriodGetAutocompleteV2ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for POST /2/object/period/getAutocomplete ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_period** | [**List[PeriodAutocompleteElementResponse]**](PeriodAutocompleteElementResponse.md) | An array of Period autocomplete element response. | diff --git a/docs/PermissionCreateObjectV1Request.md b/docs/PermissionCreateObjectV1Request.md index a97603719..38ccb7d36 100644 --- a/docs/PermissionCreateObjectV1Request.md +++ b/docs/PermissionCreateObjectV1Request.md @@ -3,6 +3,7 @@ Request for POST /1/object/permission ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_permission** | [**List[PermissionRequestCompound]**](PermissionRequestCompound.md) | | diff --git a/docs/PermissionCreateObjectV1Response.md b/docs/PermissionCreateObjectV1Response.md index f769009fb..027304a93 100644 --- a/docs/PermissionCreateObjectV1Response.md +++ b/docs/PermissionCreateObjectV1Response.md @@ -3,6 +3,7 @@ Response for POST /1/object/permission ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/PermissionCreateObjectV1ResponseMPayload.md b/docs/PermissionCreateObjectV1ResponseMPayload.md index 9249a1ef5..23e56fb41 100644 --- a/docs/PermissionCreateObjectV1ResponseMPayload.md +++ b/docs/PermissionCreateObjectV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for POST /1/object/permission ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_pki_permission_id** | **List[int]** | An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request. | diff --git a/docs/PermissionDeleteObjectV1Response.md b/docs/PermissionDeleteObjectV1Response.md index 298b40bb4..17c12b090 100644 --- a/docs/PermissionDeleteObjectV1Response.md +++ b/docs/PermissionDeleteObjectV1Response.md @@ -3,6 +3,7 @@ Response for DELETE /1/object/permission/{pkiPermissionID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/PermissionEditObjectV1Request.md b/docs/PermissionEditObjectV1Request.md index f5808d961..532e4a5ab 100644 --- a/docs/PermissionEditObjectV1Request.md +++ b/docs/PermissionEditObjectV1Request.md @@ -3,6 +3,7 @@ Request for PUT /1/object/permission/{pkiPermissionID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_permission** | [**PermissionRequestCompound**](PermissionRequestCompound.md) | | diff --git a/docs/PermissionEditObjectV1Response.md b/docs/PermissionEditObjectV1Response.md index 654447fa6..ff05a30c4 100644 --- a/docs/PermissionEditObjectV1Response.md +++ b/docs/PermissionEditObjectV1Response.md @@ -3,6 +3,7 @@ Response for PUT /1/object/permission/{pkiPermissionID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/PermissionGetObjectV2Response.md b/docs/PermissionGetObjectV2Response.md index 1c597b0ef..c49b82189 100644 --- a/docs/PermissionGetObjectV2Response.md +++ b/docs/PermissionGetObjectV2Response.md @@ -3,6 +3,7 @@ Response for GET /2/object/permission/{pkiPermissionID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/PermissionGetObjectV2ResponseMPayload.md b/docs/PermissionGetObjectV2ResponseMPayload.md index 9fa5d6501..db3a4422d 100644 --- a/docs/PermissionGetObjectV2ResponseMPayload.md +++ b/docs/PermissionGetObjectV2ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for GET /2/object/permission/{pkiPermissionID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_permission** | [**PermissionResponseCompound**](PermissionResponseCompound.md) | | diff --git a/docs/PermissionRequest.md b/docs/PermissionRequest.md index d14e50b23..a22d780db 100644 --- a/docs/PermissionRequest.md +++ b/docs/PermissionRequest.md @@ -3,6 +3,7 @@ A Permission Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_permission_id** | **int** | The unique ID of the Permission | [optional] diff --git a/docs/PermissionRequestCompound.md b/docs/PermissionRequestCompound.md index afcd3fdf7..625e5ac6d 100644 --- a/docs/PermissionRequestCompound.md +++ b/docs/PermissionRequestCompound.md @@ -3,6 +3,7 @@ A Permission Object and children to create a complete structure ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_permission_id** | **int** | The unique ID of the Permission | [optional] diff --git a/docs/PermissionResponse.md b/docs/PermissionResponse.md index 43234258e..7c24e75c1 100644 --- a/docs/PermissionResponse.md +++ b/docs/PermissionResponse.md @@ -3,6 +3,7 @@ A Permission Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_permission_id** | **int** | The unique ID of the Permission | diff --git a/docs/PermissionResponseCompound.md b/docs/PermissionResponseCompound.md index eef69f8e7..da0d09191 100644 --- a/docs/PermissionResponseCompound.md +++ b/docs/PermissionResponseCompound.md @@ -3,6 +3,7 @@ A Permission Object and children to create a complete structure ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_permission_id** | **int** | The unique ID of the Permission | diff --git a/docs/PhoneRequest.md b/docs/PhoneRequest.md index e46ea2954..353b08cc9 100644 --- a/docs/PhoneRequest.md +++ b/docs/PhoneRequest.md @@ -3,6 +3,7 @@ A Phone Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_phone_id** | **int** | The unique ID of the Phone. | [optional] diff --git a/docs/PhoneRequestCompound.md b/docs/PhoneRequestCompound.md index e06a786f9..016d14d1f 100644 --- a/docs/PhoneRequestCompound.md +++ b/docs/PhoneRequestCompound.md @@ -3,6 +3,7 @@ A Phone Object and children to create a complete structure ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_phone_id** | **int** | The unique ID of the Phone. | [optional] diff --git a/docs/PhoneResponse.md b/docs/PhoneResponse.md index 026533496..529e70a9f 100644 --- a/docs/PhoneResponse.md +++ b/docs/PhoneResponse.md @@ -3,6 +3,7 @@ A Phone Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_phone_id** | **int** | The unique ID of the Phone. | diff --git a/docs/PhoneResponseCompound.md b/docs/PhoneResponseCompound.md index 12e51c708..649e967c4 100644 --- a/docs/PhoneResponseCompound.md +++ b/docs/PhoneResponseCompound.md @@ -3,6 +3,7 @@ A Phone Object and children to create a complete structure ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_phone_id** | **int** | The unique ID of the Phone. | @@ -10,6 +11,7 @@ Name | Type | Description | Notes **e_phone_type** | [**FieldEPhoneType**](FieldEPhoneType.md) | | [optional] **s_phone_e164** | **str** | A phone number in E.164 Format | [optional] **s_phone_extension** | **str** | The extension of the phone number. The extension is the \"123\" section in this sample phone number: (514) 990-1516 x123. It can also be used with international phone numbers | [optional] +**b_phone_international** | **bool** | Indicate the phone number is an international phone number. | [optional] ## Example diff --git a/docs/PhonetypeAutocompleteElementResponse.md b/docs/PhonetypeAutocompleteElementResponse.md index b40a51eb3..22f90e390 100644 --- a/docs/PhonetypeAutocompleteElementResponse.md +++ b/docs/PhonetypeAutocompleteElementResponse.md @@ -3,6 +3,7 @@ A Phonetype AutocompleteElement Response ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_phonetype_id** | **int** | The unique ID of the Phonetype. Valid values: |Value|Description| |-|-| |1|Office| |2|Home| |3|Mobile| |4|Fax| |5|Pager| |6|Toll Free| | diff --git a/docs/PhonetypeGetAutocompleteV2Response.md b/docs/PhonetypeGetAutocompleteV2Response.md index fdab6b192..79fffdbdc 100644 --- a/docs/PhonetypeGetAutocompleteV2Response.md +++ b/docs/PhonetypeGetAutocompleteV2Response.md @@ -3,6 +3,7 @@ Response for GET /2/object/phonetype/getAutocomplete ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/PhonetypeGetAutocompleteV2ResponseMPayload.md b/docs/PhonetypeGetAutocompleteV2ResponseMPayload.md index 1982ec472..4321da167 100644 --- a/docs/PhonetypeGetAutocompleteV2ResponseMPayload.md +++ b/docs/PhonetypeGetAutocompleteV2ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for POST /2/object/phonetype/getAutocomplete ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_phonetype** | [**List[PhonetypeAutocompleteElementResponse]**](PhonetypeAutocompleteElementResponse.md) | An array of Phonetype autocomplete element response. | diff --git a/docs/RejectedoffertopurchaseGetCommunicationListV1Response.md b/docs/RejectedoffertopurchaseGetCommunicationListV1Response.md index 32c9778e0..2cca1028c 100644 --- a/docs/RejectedoffertopurchaseGetCommunicationListV1Response.md +++ b/docs/RejectedoffertopurchaseGetCommunicationListV1Response.md @@ -3,6 +3,7 @@ Response for GET /1/object/rejectedoffertopurchase/{pkiRejectedoffertopurchaseID}/getCommunicationList ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayloadGetList**](CommonResponseObjDebugPayloadGetList.md) | | diff --git a/docs/RejectedoffertopurchaseGetCommunicationListV1ResponseMPayload.md b/docs/RejectedoffertopurchaseGetCommunicationListV1ResponseMPayload.md index 442956ac0..720b5231b 100644 --- a/docs/RejectedoffertopurchaseGetCommunicationListV1ResponseMPayload.md +++ b/docs/RejectedoffertopurchaseGetCommunicationListV1ResponseMPayload.md @@ -3,6 +3,7 @@ Response for GET /1/object/rejectedoffertopurchase/{pkiRejectedoffertopurchaseID}/getCommunicationList ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_communication** | [**List[CustomCommunicationListElementResponse]**](CustomCommunicationListElementResponse.md) | | diff --git a/docs/ScimAuthenticationScheme.md b/docs/ScimAuthenticationScheme.md index 10225cfb8..87a086fc3 100644 --- a/docs/ScimAuthenticationScheme.md +++ b/docs/ScimAuthenticationScheme.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **description** | **str** | A description of the authentication scheme. | diff --git a/docs/ScimEmail.md b/docs/ScimEmail.md index 6016fc74b..ac79de539 100644 --- a/docs/ScimEmail.md +++ b/docs/ScimEmail.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **value** | **str** | The email address. | [optional] diff --git a/docs/ScimGroup.md b/docs/ScimGroup.md index 25fef3d1b..dba1968ec 100644 --- a/docs/ScimGroup.md +++ b/docs/ScimGroup.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | | [optional] diff --git a/docs/ScimGroupMember.md b/docs/ScimGroupMember.md index 23e4492c2..da820ecea 100644 --- a/docs/ScimGroupMember.md +++ b/docs/ScimGroupMember.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **value** | **str** | | [optional] diff --git a/docs/ScimGroupsApi.md b/docs/ScimGroupsApi.md index 1262f65f8..8e45bf0cc 100644 --- a/docs/ScimGroupsApi.md +++ b/docs/ScimGroupsApi.md @@ -19,6 +19,7 @@ Create a new Usergroup ### Example * Bearer Authentication (Bearer): + ```python import time import os @@ -62,6 +63,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **scim_group** | [**ScimGroup**](ScimGroup.md)| | @@ -80,6 +82,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **201** | Created | - | @@ -94,6 +97,7 @@ Delete an existing Usergroup ### Example * Bearer Authentication (Bearer): + ```python import time import os @@ -134,6 +138,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **group_id** | **str**| | @@ -152,6 +157,7 @@ void (empty response body) - **Accept**: Not defined ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **204** | No Content | - | @@ -166,6 +172,7 @@ Edit an existing Usergroup ### Example * Bearer Authentication (Bearer): + ```python import time import os @@ -210,6 +217,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **group_id** | **str**| | @@ -229,6 +237,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | OK | - | @@ -243,6 +252,7 @@ Retrieve Usergroup list ### Example * Bearer Authentication (Bearer): + ```python import time import os @@ -286,6 +296,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **filter** | **str**| Filter expression for searching groups | [optional] @@ -304,6 +315,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | OK | - | @@ -318,6 +330,7 @@ Retrieve an existing Usergroup ### Example * Bearer Authentication (Bearer): + ```python import time import os @@ -361,6 +374,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **group_id** | **str**| | @@ -379,6 +393,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | OK | - | diff --git a/docs/ScimServiceProviderConfig.md b/docs/ScimServiceProviderConfig.md index 26ae5c114..f358e51fd 100644 --- a/docs/ScimServiceProviderConfig.md +++ b/docs/ScimServiceProviderConfig.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **authentication_schemes** | [**List[ScimAuthenticationScheme]**](ScimAuthenticationScheme.md) | A multi-valued complex type that specifies supported authentication scheme properties. | diff --git a/docs/ScimServiceProviderConfigApi.md b/docs/ScimServiceProviderConfigApi.md index 9560685c3..bf95a95c9 100644 --- a/docs/ScimServiceProviderConfigApi.md +++ b/docs/ScimServiceProviderConfigApi.md @@ -14,6 +14,7 @@ Get Service Provider Configuration ### Example + ```python import time import os @@ -46,6 +47,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + This endpoint does not need any parameter. ### Return type @@ -62,6 +64,7 @@ No authorization required - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | OK | - | diff --git a/docs/ScimServiceProviderConfigBulk.md b/docs/ScimServiceProviderConfigBulk.md index 8e566c22c..26d2ef72f 100644 --- a/docs/ScimServiceProviderConfigBulk.md +++ b/docs/ScimServiceProviderConfigBulk.md @@ -3,6 +3,7 @@ A complex type that specifies bulk configuration options. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **supported** | **bool** | A Boolean value specifying whether or not the operation is supported. | diff --git a/docs/ScimServiceProviderConfigChangePassword.md b/docs/ScimServiceProviderConfigChangePassword.md index e40b6ff38..2e5bb9ec6 100644 --- a/docs/ScimServiceProviderConfigChangePassword.md +++ b/docs/ScimServiceProviderConfigChangePassword.md @@ -3,6 +3,7 @@ A complex type that specifies configuration options related to changing a password. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **supported** | **bool** | A Boolean value specifying whether or not the operation is supported. | diff --git a/docs/ScimServiceProviderConfigEtag.md b/docs/ScimServiceProviderConfigEtag.md index 7a92bdba2..66798d04d 100644 --- a/docs/ScimServiceProviderConfigEtag.md +++ b/docs/ScimServiceProviderConfigEtag.md @@ -3,6 +3,7 @@ A complex type that specifies ETag configuration options. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **supported** | **bool** | A Boolean value specifying whether or not the operation is supported. | diff --git a/docs/ScimServiceProviderConfigFilter.md b/docs/ScimServiceProviderConfigFilter.md index a134bc7a5..ef2de89ea 100644 --- a/docs/ScimServiceProviderConfigFilter.md +++ b/docs/ScimServiceProviderConfigFilter.md @@ -3,6 +3,7 @@ A complex type that specifies FILTER options. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **supported** | **bool** | A Boolean value specifying whether or not the operation is supported. | diff --git a/docs/ScimServiceProviderConfigPatch.md b/docs/ScimServiceProviderConfigPatch.md index 2fe510e41..0915cf3b2 100644 --- a/docs/ScimServiceProviderConfigPatch.md +++ b/docs/ScimServiceProviderConfigPatch.md @@ -3,6 +3,7 @@ A complex type that specifies PATCH configuration options. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **supported** | **bool** | A Boolean value specifying whether or not the operation is supported. | diff --git a/docs/ScimServiceProviderConfigSort.md b/docs/ScimServiceProviderConfigSort.md index 6ef929933..e95ad8914 100644 --- a/docs/ScimServiceProviderConfigSort.md +++ b/docs/ScimServiceProviderConfigSort.md @@ -3,6 +3,7 @@ A complex type that specifies Sort configuration options. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **supported** | **bool** | A Boolean value specifying whether or not sorting is supported. | diff --git a/docs/ScimUser.md b/docs/ScimUser.md index 2defbba41..eb9bd23a6 100644 --- a/docs/ScimUser.md +++ b/docs/ScimUser.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | | [optional] diff --git a/docs/ScimUserList.md b/docs/ScimUserList.md index d232da1ac..c5dfcfcad 100644 --- a/docs/ScimUserList.md +++ b/docs/ScimUserList.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **total_results** | **int** | | [optional] diff --git a/docs/ScimUsersApi.md b/docs/ScimUsersApi.md index 57fcf3067..03d85958e 100644 --- a/docs/ScimUsersApi.md +++ b/docs/ScimUsersApi.md @@ -19,6 +19,7 @@ Create a new User ### Example * Bearer Authentication (Bearer): + ```python import time import os @@ -62,6 +63,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **scim_user** | [**ScimUser**](ScimUser.md)| | @@ -80,6 +82,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **201** | Created | - | @@ -94,6 +97,7 @@ Delete an existing User ### Example * Bearer Authentication (Bearer): + ```python import time import os @@ -134,6 +138,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **user_id** | **str**| | @@ -152,6 +157,7 @@ void (empty response body) - **Accept**: Not defined ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **204** | No Content | - | @@ -166,6 +172,7 @@ Edit an existing User ### Example * Bearer Authentication (Bearer): + ```python import time import os @@ -210,6 +217,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **user_id** | **str**| | @@ -229,6 +237,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | OK | - | @@ -243,6 +252,7 @@ Retrieve User list ### Example * Bearer Authentication (Bearer): + ```python import time import os @@ -286,6 +296,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **filter** | **str**| Filter expression for searching users | [optional] @@ -304,6 +315,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | OK | - | @@ -318,6 +330,7 @@ Retrieve an existing User ### Example * Bearer Authentication (Bearer): + ```python import time import os @@ -361,6 +374,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **user_id** | **str**| | @@ -379,6 +393,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | OK | - | diff --git a/docs/SecretquestionAutocompleteElementResponse.md b/docs/SecretquestionAutocompleteElementResponse.md index 8c6bec5ad..cd2399890 100644 --- a/docs/SecretquestionAutocompleteElementResponse.md +++ b/docs/SecretquestionAutocompleteElementResponse.md @@ -3,6 +3,7 @@ A Secretquestion AutocompleteElement Response ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **s_secretquestion_text_x** | **str** | The text of the Secretquestion in the language of the requester | diff --git a/docs/SecretquestionGetAutocompleteV2Response.md b/docs/SecretquestionGetAutocompleteV2Response.md index cff5aafa5..8df49e7ac 100644 --- a/docs/SecretquestionGetAutocompleteV2Response.md +++ b/docs/SecretquestionGetAutocompleteV2Response.md @@ -3,6 +3,7 @@ Response for GET /2/object/secretquestion/getAutocomplete ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/SecretquestionGetAutocompleteV2ResponseMPayload.md b/docs/SecretquestionGetAutocompleteV2ResponseMPayload.md index 19f451b4f..34c9980e9 100644 --- a/docs/SecretquestionGetAutocompleteV2ResponseMPayload.md +++ b/docs/SecretquestionGetAutocompleteV2ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for POST /2/object/secretquestion/getAutocomplete ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_secretquestion** | [**List[SecretquestionAutocompleteElementResponse]**](SecretquestionAutocompleteElementResponse.md) | An array of Secretquestion autocomplete element response. | diff --git a/docs/SessionhistoryGetListV1Response.md b/docs/SessionhistoryGetListV1Response.md index 9751413cb..606b847a8 100644 --- a/docs/SessionhistoryGetListV1Response.md +++ b/docs/SessionhistoryGetListV1Response.md @@ -3,6 +3,7 @@ Response for GET /1/object/sessionhistory/getList ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayloadGetList**](CommonResponseObjDebugPayloadGetList.md) | | diff --git a/docs/SessionhistoryGetListV1ResponseMPayload.md b/docs/SessionhistoryGetListV1ResponseMPayload.md index 662f99b69..27010b695 100644 --- a/docs/SessionhistoryGetListV1ResponseMPayload.md +++ b/docs/SessionhistoryGetListV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for GET /1/object/sessionhistory/getList ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **i_row_returned** | **int** | The number of rows returned | diff --git a/docs/SessionhistoryListElement.md b/docs/SessionhistoryListElement.md index e4c53124c..d3f826ec4 100644 --- a/docs/SessionhistoryListElement.md +++ b/docs/SessionhistoryListElement.md @@ -3,6 +3,7 @@ A Sessionhistory List Element ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_sessionhistory_id** | **int** | The unique ID of the Sessionhistory | diff --git a/docs/SignatureCreateObjectV1Request.md b/docs/SignatureCreateObjectV1Request.md index 3abe092a7..a9f67f253 100644 --- a/docs/SignatureCreateObjectV1Request.md +++ b/docs/SignatureCreateObjectV1Request.md @@ -3,6 +3,7 @@ Request for POST /1/object/signature ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_signature** | [**List[SignatureRequestCompound]**](SignatureRequestCompound.md) | | diff --git a/docs/SignatureCreateObjectV1Response.md b/docs/SignatureCreateObjectV1Response.md index 135376e33..70bc43e70 100644 --- a/docs/SignatureCreateObjectV1Response.md +++ b/docs/SignatureCreateObjectV1Response.md @@ -3,6 +3,7 @@ Response for POST /1/object/signature ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/SignatureCreateObjectV1ResponseMPayload.md b/docs/SignatureCreateObjectV1ResponseMPayload.md index 84c4fdd78..6d3e4a7d1 100644 --- a/docs/SignatureCreateObjectV1ResponseMPayload.md +++ b/docs/SignatureCreateObjectV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for POST /1/object/signature ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_pki_signature_id** | **List[int]** | An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request. | diff --git a/docs/SignatureDeleteObjectV1Response.md b/docs/SignatureDeleteObjectV1Response.md index 2e2a3338a..b5c04a895 100644 --- a/docs/SignatureDeleteObjectV1Response.md +++ b/docs/SignatureDeleteObjectV1Response.md @@ -3,6 +3,7 @@ Response for DELETE /1/object/signature/{pkiSignatureID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/SignatureEditObjectV1Request.md b/docs/SignatureEditObjectV1Request.md index 8af5a3790..e86dfad0c 100644 --- a/docs/SignatureEditObjectV1Request.md +++ b/docs/SignatureEditObjectV1Request.md @@ -3,6 +3,7 @@ Request for PUT /1/object/signature/{pkiSignatureID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_signature** | [**SignatureRequestCompound**](SignatureRequestCompound.md) | | diff --git a/docs/SignatureEditObjectV1Response.md b/docs/SignatureEditObjectV1Response.md index c3fea891e..5d0a25006 100644 --- a/docs/SignatureEditObjectV1Response.md +++ b/docs/SignatureEditObjectV1Response.md @@ -3,6 +3,7 @@ Response for PUT /1/object/signature/{pkiSignatureID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/SignatureGetObjectV2Response.md b/docs/SignatureGetObjectV2Response.md index a379db30a..717b47ff2 100644 --- a/docs/SignatureGetObjectV2Response.md +++ b/docs/SignatureGetObjectV2Response.md @@ -3,6 +3,7 @@ Response for GET /2/object/signature/{pkiSignatureID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/SignatureGetObjectV2ResponseMPayload.md b/docs/SignatureGetObjectV2ResponseMPayload.md index 24795256a..ebb4770c7 100644 --- a/docs/SignatureGetObjectV2ResponseMPayload.md +++ b/docs/SignatureGetObjectV2ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for GET /2/object/signature/{pkiSignatureID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_signature** | [**SignatureResponseCompound**](SignatureResponseCompound.md) | | diff --git a/docs/SignatureRequest.md b/docs/SignatureRequest.md index fe7014878..665ea2106 100644 --- a/docs/SignatureRequest.md +++ b/docs/SignatureRequest.md @@ -3,6 +3,7 @@ A Signature Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_signature_id** | **int** | The unique ID of the Signature | [optional] diff --git a/docs/SignatureRequestCompound.md b/docs/SignatureRequestCompound.md index f2832d14a..f48a71e4a 100644 --- a/docs/SignatureRequestCompound.md +++ b/docs/SignatureRequestCompound.md @@ -3,6 +3,7 @@ A Signature Object and children ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_signature_id** | **int** | The unique ID of the Signature | [optional] diff --git a/docs/SignatureResponse.md b/docs/SignatureResponse.md index 175d1b9f6..c635582e0 100644 --- a/docs/SignatureResponse.md +++ b/docs/SignatureResponse.md @@ -3,6 +3,7 @@ A Signature Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_signature_id** | **int** | The unique ID of the Signature | diff --git a/docs/SignatureResponseCompound.md b/docs/SignatureResponseCompound.md index dfe37fc61..a6f356651 100644 --- a/docs/SignatureResponseCompound.md +++ b/docs/SignatureResponseCompound.md @@ -3,6 +3,7 @@ A Signature Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_signature_id** | **int** | The unique ID of the Signature | diff --git a/docs/SubnetCreateObjectV1Request.md b/docs/SubnetCreateObjectV1Request.md index 40915ae22..2e3fded2f 100644 --- a/docs/SubnetCreateObjectV1Request.md +++ b/docs/SubnetCreateObjectV1Request.md @@ -3,6 +3,7 @@ Request for POST /1/object/subnet ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_subnet** | [**List[SubnetRequestCompound]**](SubnetRequestCompound.md) | | diff --git a/docs/SubnetCreateObjectV1Response.md b/docs/SubnetCreateObjectV1Response.md index a17c725a4..25fe26a0f 100644 --- a/docs/SubnetCreateObjectV1Response.md +++ b/docs/SubnetCreateObjectV1Response.md @@ -3,6 +3,7 @@ Response for POST /1/object/subnet ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/SubnetCreateObjectV1ResponseMPayload.md b/docs/SubnetCreateObjectV1ResponseMPayload.md index 763736ee6..b258d84ea 100644 --- a/docs/SubnetCreateObjectV1ResponseMPayload.md +++ b/docs/SubnetCreateObjectV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for POST /1/object/subnet ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_pki_subnet_id** | **List[int]** | An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request. | diff --git a/docs/SubnetDeleteObjectV1Response.md b/docs/SubnetDeleteObjectV1Response.md index 0f075c933..a4a0d0a7d 100644 --- a/docs/SubnetDeleteObjectV1Response.md +++ b/docs/SubnetDeleteObjectV1Response.md @@ -3,6 +3,7 @@ Response for DELETE /1/object/subnet/{pkiSubnetID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/SubnetEditObjectV1Request.md b/docs/SubnetEditObjectV1Request.md index 24942c55b..804966628 100644 --- a/docs/SubnetEditObjectV1Request.md +++ b/docs/SubnetEditObjectV1Request.md @@ -3,6 +3,7 @@ Request for PUT /1/object/subnet/{pkiSubnetID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_subnet** | [**SubnetRequestCompound**](SubnetRequestCompound.md) | | diff --git a/docs/SubnetEditObjectV1Response.md b/docs/SubnetEditObjectV1Response.md index 97e1aeb97..6ca3f1e62 100644 --- a/docs/SubnetEditObjectV1Response.md +++ b/docs/SubnetEditObjectV1Response.md @@ -3,6 +3,7 @@ Response for PUT /1/object/subnet/{pkiSubnetID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/SubnetGetObjectV2Response.md b/docs/SubnetGetObjectV2Response.md index a395f5041..3e1d765b7 100644 --- a/docs/SubnetGetObjectV2Response.md +++ b/docs/SubnetGetObjectV2Response.md @@ -3,6 +3,7 @@ Response for GET /2/object/subnet/{pkiSubnetID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/SubnetGetObjectV2ResponseMPayload.md b/docs/SubnetGetObjectV2ResponseMPayload.md index a260347f2..0be41b674 100644 --- a/docs/SubnetGetObjectV2ResponseMPayload.md +++ b/docs/SubnetGetObjectV2ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for GET /2/object/subnet/{pkiSubnetID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_subnet** | [**SubnetResponseCompound**](SubnetResponseCompound.md) | | diff --git a/docs/SubnetRequest.md b/docs/SubnetRequest.md index eaefa0cee..6bb808804 100644 --- a/docs/SubnetRequest.md +++ b/docs/SubnetRequest.md @@ -3,6 +3,7 @@ A Subnet Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_subnet_id** | **int** | The unique ID of the Subnet | [optional] diff --git a/docs/SubnetRequestCompound.md b/docs/SubnetRequestCompound.md index 122c9e1d2..586f6e16a 100644 --- a/docs/SubnetRequestCompound.md +++ b/docs/SubnetRequestCompound.md @@ -3,6 +3,7 @@ A Subnet Object and children ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_subnet_id** | **int** | The unique ID of the Subnet | [optional] diff --git a/docs/SubnetResponse.md b/docs/SubnetResponse.md index f7780f438..0fe689d58 100644 --- a/docs/SubnetResponse.md +++ b/docs/SubnetResponse.md @@ -3,6 +3,7 @@ A Subnet Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_subnet_id** | **int** | The unique ID of the Subnet | diff --git a/docs/SubnetResponseCompound.md b/docs/SubnetResponseCompound.md index 4fa438645..2475e786a 100644 --- a/docs/SubnetResponseCompound.md +++ b/docs/SubnetResponseCompound.md @@ -3,6 +3,7 @@ A Subnet Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_subnet_id** | **int** | The unique ID of the Subnet | diff --git a/docs/SystemconfigurationEditObjectV1Request.md b/docs/SystemconfigurationEditObjectV1Request.md index 20520cd17..95039558d 100644 --- a/docs/SystemconfigurationEditObjectV1Request.md +++ b/docs/SystemconfigurationEditObjectV1Request.md @@ -3,6 +3,7 @@ Request for PUT /1/object/systemconfiguration/{pkiSystemconfigurationID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_systemconfiguration** | [**SystemconfigurationRequestCompound**](SystemconfigurationRequestCompound.md) | | diff --git a/docs/SystemconfigurationEditObjectV1Response.md b/docs/SystemconfigurationEditObjectV1Response.md index 2042cdbe6..ef0d34c8e 100644 --- a/docs/SystemconfigurationEditObjectV1Response.md +++ b/docs/SystemconfigurationEditObjectV1Response.md @@ -3,6 +3,7 @@ Response for PUT /1/object/systemconfiguration/{pkiSystemconfigurationID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/SystemconfigurationGetObjectV2Response.md b/docs/SystemconfigurationGetObjectV2Response.md index 474e6aef6..3fcff399d 100644 --- a/docs/SystemconfigurationGetObjectV2Response.md +++ b/docs/SystemconfigurationGetObjectV2Response.md @@ -3,6 +3,7 @@ Response for GET /2/object/systemconfiguration/{pkiSystemconfigurationID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/SystemconfigurationGetObjectV2ResponseMPayload.md b/docs/SystemconfigurationGetObjectV2ResponseMPayload.md index 731bc70db..c78a82dc7 100644 --- a/docs/SystemconfigurationGetObjectV2ResponseMPayload.md +++ b/docs/SystemconfigurationGetObjectV2ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for GET /2/object/systemconfiguration/{pkiSystemconfigurationID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_systemconfiguration** | [**SystemconfigurationResponseCompound**](SystemconfigurationResponseCompound.md) | | diff --git a/docs/SystemconfigurationRequest.md b/docs/SystemconfigurationRequest.md index 124fa74d3..5aacf8047 100644 --- a/docs/SystemconfigurationRequest.md +++ b/docs/SystemconfigurationRequest.md @@ -3,6 +3,7 @@ A Systemconfiguration Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_systemconfiguration_id** | **int** | The unique ID of the Systemconfiguration | [optional] diff --git a/docs/SystemconfigurationRequestCompound.md b/docs/SystemconfigurationRequestCompound.md index a7c840397..c8ff0ed68 100644 --- a/docs/SystemconfigurationRequestCompound.md +++ b/docs/SystemconfigurationRequestCompound.md @@ -3,6 +3,7 @@ A Systemconfiguration Object and children ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_systemconfiguration_id** | **int** | The unique ID of the Systemconfiguration | [optional] diff --git a/docs/SystemconfigurationResponse.md b/docs/SystemconfigurationResponse.md index 02d4e77a2..9563c3b66 100644 --- a/docs/SystemconfigurationResponse.md +++ b/docs/SystemconfigurationResponse.md @@ -3,6 +3,7 @@ A Systemconfiguration Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_systemconfiguration_id** | **int** | The unique ID of the Systemconfiguration | diff --git a/docs/SystemconfigurationResponseCompound.md b/docs/SystemconfigurationResponseCompound.md index 7583c1891..56ceb721a 100644 --- a/docs/SystemconfigurationResponseCompound.md +++ b/docs/SystemconfigurationResponseCompound.md @@ -3,6 +3,7 @@ A Systemconfiguration Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_systemconfiguration_id** | **int** | The unique ID of the Systemconfiguration | diff --git a/docs/TaxassignmentAutocompleteElementResponse.md b/docs/TaxassignmentAutocompleteElementResponse.md index d99ade74c..b66a3cf24 100644 --- a/docs/TaxassignmentAutocompleteElementResponse.md +++ b/docs/TaxassignmentAutocompleteElementResponse.md @@ -3,6 +3,7 @@ A Taxassignment AutocompleteElement Response ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **s_taxassignment_description_x** | **str** | The description of the Taxassignment in the language of the requester | diff --git a/docs/TaxassignmentGetAutocompleteV2Response.md b/docs/TaxassignmentGetAutocompleteV2Response.md index 54084d966..b1250ee28 100644 --- a/docs/TaxassignmentGetAutocompleteV2Response.md +++ b/docs/TaxassignmentGetAutocompleteV2Response.md @@ -3,6 +3,7 @@ Response for GET /2/object/taxassignment/getAutocomplete ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/TaxassignmentGetAutocompleteV2ResponseMPayload.md b/docs/TaxassignmentGetAutocompleteV2ResponseMPayload.md index f871a85a1..c7b822cde 100644 --- a/docs/TaxassignmentGetAutocompleteV2ResponseMPayload.md +++ b/docs/TaxassignmentGetAutocompleteV2ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for POST /2/object/taxassignment/getAutocomplete ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_taxassignment** | [**List[TaxassignmentAutocompleteElementResponse]**](TaxassignmentAutocompleteElementResponse.md) | An array of Taxassignment autocomplete element response. | diff --git a/docs/TextstylestaticResponse.md b/docs/TextstylestaticResponse.md index 632433c32..3804b4663 100644 --- a/docs/TextstylestaticResponse.md +++ b/docs/TextstylestaticResponse.md @@ -3,6 +3,7 @@ A Textstylestatic Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_textstylestatic_id** | **int** | The unique ID of the Textstylestatic | [optional] diff --git a/docs/TextstylestaticResponseCompound.md b/docs/TextstylestaticResponseCompound.md index 50f2228fd..ca6cb9f04 100644 --- a/docs/TextstylestaticResponseCompound.md +++ b/docs/TextstylestaticResponseCompound.md @@ -3,6 +3,7 @@ A Textstylestatic Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_textstylestatic_id** | **int** | The unique ID of the Textstylestatic | [optional] diff --git a/docs/TimezoneAutocompleteElementResponse.md b/docs/TimezoneAutocompleteElementResponse.md index a87b31af1..2db5635e0 100644 --- a/docs/TimezoneAutocompleteElementResponse.md +++ b/docs/TimezoneAutocompleteElementResponse.md @@ -3,6 +3,7 @@ A Timezone AutocompleteElement Response ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **s_timezone_name** | **str** | The description of the Timezone | diff --git a/docs/TimezoneGetAutocompleteV2Response.md b/docs/TimezoneGetAutocompleteV2Response.md index c98fc2bc2..0c61d3b12 100644 --- a/docs/TimezoneGetAutocompleteV2Response.md +++ b/docs/TimezoneGetAutocompleteV2Response.md @@ -3,6 +3,7 @@ Response for GET /2/object/timezone/getAutocomplete ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/TimezoneGetAutocompleteV2ResponseMPayload.md b/docs/TimezoneGetAutocompleteV2ResponseMPayload.md index 22d5e8b2e..9f9d531ec 100644 --- a/docs/TimezoneGetAutocompleteV2ResponseMPayload.md +++ b/docs/TimezoneGetAutocompleteV2ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for POST /2/object/timezone/getAutocomplete ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_timezone** | [**List[TimezoneAutocompleteElementResponse]**](TimezoneAutocompleteElementResponse.md) | An array of Timezone autocomplete element response. | diff --git a/docs/UserAutocompleteElementResponse.md b/docs/UserAutocompleteElementResponse.md index 542fa9f9a..0e971bdab 100644 --- a/docs/UserAutocompleteElementResponse.md +++ b/docs/UserAutocompleteElementResponse.md @@ -3,6 +3,7 @@ A User AutocompleteElement Response ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **e_user_type** | [**FieldEUserType**](FieldEUserType.md) | | diff --git a/docs/UserCreateEzsignuserV1Request.md b/docs/UserCreateEzsignuserV1Request.md index b30c99bbe..814579792 100644 --- a/docs/UserCreateEzsignuserV1Request.md +++ b/docs/UserCreateEzsignuserV1Request.md @@ -3,6 +3,7 @@ Request for POST /1/module/user/createEzsignuser ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **fki_language_id** | **int** | The unique ID of the Language. Valid values: |Value|Description| |-|-| |1|French| |2|English| | diff --git a/docs/UserCreateEzsignuserV1Response.md b/docs/UserCreateEzsignuserV1Response.md index 717cba7d7..5bc6d943f 100644 --- a/docs/UserCreateEzsignuserV1Response.md +++ b/docs/UserCreateEzsignuserV1Response.md @@ -3,6 +3,7 @@ Response for POST /1/module/user/createEzsignuser ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/UserCreateEzsignuserV1ResponseMPayload.md b/docs/UserCreateEzsignuserV1ResponseMPayload.md index 1852b3988..bf281ec09 100644 --- a/docs/UserCreateEzsignuserV1ResponseMPayload.md +++ b/docs/UserCreateEzsignuserV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for POST /1/module/user/createEzsignuser ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_s_email_address_success** | **List[str]** | An array of email addresses that succeeded. | diff --git a/docs/UserCreateObjectV1Request.md b/docs/UserCreateObjectV1Request.md index 88c348fb1..8e4c86f98 100644 --- a/docs/UserCreateObjectV1Request.md +++ b/docs/UserCreateObjectV1Request.md @@ -3,6 +3,7 @@ Request for POST /1/object/user ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_user** | [**List[UserRequestCompound]**](UserRequestCompound.md) | | diff --git a/docs/UserCreateObjectV1Response.md b/docs/UserCreateObjectV1Response.md index 017f00490..b5e60eaca 100644 --- a/docs/UserCreateObjectV1Response.md +++ b/docs/UserCreateObjectV1Response.md @@ -3,6 +3,7 @@ Response for POST /1/object/user ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/UserCreateObjectV1ResponseMPayload.md b/docs/UserCreateObjectV1ResponseMPayload.md index 6582221f4..7735659ac 100644 --- a/docs/UserCreateObjectV1ResponseMPayload.md +++ b/docs/UserCreateObjectV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for POST /1/object/user ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_pki_user_id** | **List[int]** | An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request. | diff --git a/docs/UserEditObjectV1Request.md b/docs/UserEditObjectV1Request.md index 51d8463d1..80544e137 100644 --- a/docs/UserEditObjectV1Request.md +++ b/docs/UserEditObjectV1Request.md @@ -3,6 +3,7 @@ Request for PUT /1/object/user/{pkiUserID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_user** | [**UserRequestCompound**](UserRequestCompound.md) | | diff --git a/docs/UserEditObjectV1Response.md b/docs/UserEditObjectV1Response.md index 84913da47..83f3c5cfc 100644 --- a/docs/UserEditObjectV1Response.md +++ b/docs/UserEditObjectV1Response.md @@ -3,6 +3,7 @@ Response for PUT /1/object/user/{pkiUserID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/UserEditPermissionsV1Request.md b/docs/UserEditPermissionsV1Request.md index 9296a8de5..f66ca07e6 100644 --- a/docs/UserEditPermissionsV1Request.md +++ b/docs/UserEditPermissionsV1Request.md @@ -3,6 +3,7 @@ Request for PUT /1/object/user/{pkiUserID}/editPermissions ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_permission** | [**List[PermissionRequestCompound]**](PermissionRequestCompound.md) | | diff --git a/docs/UserEditPermissionsV1Response.md b/docs/UserEditPermissionsV1Response.md index 4915ac718..6e0ebb53c 100644 --- a/docs/UserEditPermissionsV1Response.md +++ b/docs/UserEditPermissionsV1Response.md @@ -3,6 +3,7 @@ Response for PUT /1/object/user/{pkiUserID}/editPermissions ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/UserEditPermissionsV1ResponseMPayload.md b/docs/UserEditPermissionsV1ResponseMPayload.md index 0cc1e6c47..2750addd2 100644 --- a/docs/UserEditPermissionsV1ResponseMPayload.md +++ b/docs/UserEditPermissionsV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for PUT /1/object/user/{pkiUserID}/editPermissions ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_pki_permission_id** | **List[int]** | | diff --git a/docs/UserGetApikeysV1Response.md b/docs/UserGetApikeysV1Response.md index e9dbc309b..e5fe456ee 100644 --- a/docs/UserGetApikeysV1Response.md +++ b/docs/UserGetApikeysV1Response.md @@ -3,6 +3,7 @@ Response for GET /1/object/user/{pkiUserID}/getApikeys ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/UserGetApikeysV1ResponseMPayload.md b/docs/UserGetApikeysV1ResponseMPayload.md index 9efe45766..a851c60d5 100644 --- a/docs/UserGetApikeysV1ResponseMPayload.md +++ b/docs/UserGetApikeysV1ResponseMPayload.md @@ -3,6 +3,7 @@ Response for GET /1/object/user/{pkiUserID}/getApikeys ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_apikey** | [**List[ApikeyResponseCompound]**](ApikeyResponseCompound.md) | | diff --git a/docs/UserGetAutocompleteV2Response.md b/docs/UserGetAutocompleteV2Response.md index f8cbebccc..639d1d727 100644 --- a/docs/UserGetAutocompleteV2Response.md +++ b/docs/UserGetAutocompleteV2Response.md @@ -3,6 +3,7 @@ Response for GET /2/object/user/getAutocomplete ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/UserGetAutocompleteV2ResponseMPayload.md b/docs/UserGetAutocompleteV2ResponseMPayload.md index ca9670b81..023189a1b 100644 --- a/docs/UserGetAutocompleteV2ResponseMPayload.md +++ b/docs/UserGetAutocompleteV2ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for POST /2/object/user/getAutocomplete ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_user** | [**List[UserAutocompleteElementResponse]**](UserAutocompleteElementResponse.md) | An array of User autocomplete element response. | diff --git a/docs/UserGetEffectivePermissionsV1Response.md b/docs/UserGetEffectivePermissionsV1Response.md index 37560c220..ab011b603 100644 --- a/docs/UserGetEffectivePermissionsV1Response.md +++ b/docs/UserGetEffectivePermissionsV1Response.md @@ -3,6 +3,7 @@ Response for GET /1/object/user/{pkiUserID}/getEffectivePermissions ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/UserGetEffectivePermissionsV1ResponseMPayload.md b/docs/UserGetEffectivePermissionsV1ResponseMPayload.md index d7a48dcbd..d5f811baf 100644 --- a/docs/UserGetEffectivePermissionsV1ResponseMPayload.md +++ b/docs/UserGetEffectivePermissionsV1ResponseMPayload.md @@ -3,6 +3,7 @@ Response for GET /1/object/user/{pkiUserID}/getEffectivePermissions ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_modulegroup** | [**List[ModulegroupResponseCompound]**](ModulegroupResponseCompound.md) | | diff --git a/docs/UserGetListV1Response.md b/docs/UserGetListV1Response.md index 97107f696..e368b27f6 100644 --- a/docs/UserGetListV1Response.md +++ b/docs/UserGetListV1Response.md @@ -3,6 +3,7 @@ Response for GET /1/object/user/getList ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayloadGetList**](CommonResponseObjDebugPayloadGetList.md) | | diff --git a/docs/UserGetListV1ResponseMPayload.md b/docs/UserGetListV1ResponseMPayload.md index 604301dbf..f8944fb35 100644 --- a/docs/UserGetListV1ResponseMPayload.md +++ b/docs/UserGetListV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for GET /1/object/user/getList ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **i_row_returned** | **int** | The number of rows returned | diff --git a/docs/UserGetObjectV2Response.md b/docs/UserGetObjectV2Response.md index 5e66a4709..fd84d2571 100644 --- a/docs/UserGetObjectV2Response.md +++ b/docs/UserGetObjectV2Response.md @@ -3,6 +3,7 @@ Response for GET /2/object/user/{pkiUserID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/UserGetObjectV2ResponseMPayload.md b/docs/UserGetObjectV2ResponseMPayload.md index 6d6e58e46..11a8ebe89 100644 --- a/docs/UserGetObjectV2ResponseMPayload.md +++ b/docs/UserGetObjectV2ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for GET /2/object/user/{pkiUserID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_user** | [**UserResponseCompound**](UserResponseCompound.md) | | diff --git a/docs/UserGetPermissionsV1Response.md b/docs/UserGetPermissionsV1Response.md index f69efd196..53a98dc21 100644 --- a/docs/UserGetPermissionsV1Response.md +++ b/docs/UserGetPermissionsV1Response.md @@ -3,6 +3,7 @@ Response for GET /1/object/user/{pkiUserID}/getPermissions ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/UserGetPermissionsV1ResponseMPayload.md b/docs/UserGetPermissionsV1ResponseMPayload.md index b1076b5ef..49834dd52 100644 --- a/docs/UserGetPermissionsV1ResponseMPayload.md +++ b/docs/UserGetPermissionsV1ResponseMPayload.md @@ -3,6 +3,7 @@ Response for GET /1/object/user/{pkiUserID}/getPermissions ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_modulegroup** | [**List[ModulegroupResponseCompound]**](ModulegroupResponseCompound.md) | | diff --git a/docs/UserGetSubnetsV1Response.md b/docs/UserGetSubnetsV1Response.md index 109a4dccb..bc1ed723a 100644 --- a/docs/UserGetSubnetsV1Response.md +++ b/docs/UserGetSubnetsV1Response.md @@ -3,6 +3,7 @@ Response for GET /1/object/user/{pkiUserID}/getSubnets ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/UserGetSubnetsV1ResponseMPayload.md b/docs/UserGetSubnetsV1ResponseMPayload.md index 9d2e791a0..ebb9fbf4c 100644 --- a/docs/UserGetSubnetsV1ResponseMPayload.md +++ b/docs/UserGetSubnetsV1ResponseMPayload.md @@ -3,6 +3,7 @@ Response for GET /1/object/user/{pkiUserID}/getSubnets ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_subnet** | [**List[SubnetResponseCompound]**](SubnetResponseCompound.md) | | diff --git a/docs/UserListElement.md b/docs/UserListElement.md index 1597133d2..50b501ce1 100644 --- a/docs/UserListElement.md +++ b/docs/UserListElement.md @@ -3,6 +3,7 @@ A User List Element ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_user_id** | **int** | The unique ID of the User | diff --git a/docs/UserRequest.md b/docs/UserRequest.md index 11c6185ed..408e63136 100644 --- a/docs/UserRequest.md +++ b/docs/UserRequest.md @@ -3,6 +3,7 @@ A User Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_user_id** | **int** | The unique ID of the User | [optional] diff --git a/docs/UserRequestCompound.md b/docs/UserRequestCompound.md index 8e08eb122..5ce982888 100644 --- a/docs/UserRequestCompound.md +++ b/docs/UserRequestCompound.md @@ -3,6 +3,7 @@ A User Object and children ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_user_id** | **int** | The unique ID of the User | [optional] diff --git a/docs/UserResponse.md b/docs/UserResponse.md index 5cbf26806..3ba3364de 100644 --- a/docs/UserResponse.md +++ b/docs/UserResponse.md @@ -3,6 +3,7 @@ A User Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_user_id** | **int** | The unique ID of the User | diff --git a/docs/UserResponseCompound.md b/docs/UserResponseCompound.md index 617729734..f28818514 100644 --- a/docs/UserResponseCompound.md +++ b/docs/UserResponseCompound.md @@ -3,6 +3,7 @@ A User Object and children to create a complete structure ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_user_id** | **int** | The unique ID of the User | diff --git a/docs/UserSendPasswordResetV1Response.md b/docs/UserSendPasswordResetV1Response.md index c9326865d..0f15c303e 100644 --- a/docs/UserSendPasswordResetV1Response.md +++ b/docs/UserSendPasswordResetV1Response.md @@ -3,6 +3,7 @@ Response for POST /1/object/user/{pkiUserID}/sendPasswordReset ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/UsergroupAutocompleteElementResponse.md b/docs/UsergroupAutocompleteElementResponse.md index 31dc36ee6..457cf98fd 100644 --- a/docs/UsergroupAutocompleteElementResponse.md +++ b/docs/UsergroupAutocompleteElementResponse.md @@ -3,6 +3,7 @@ A Usergroup AutocompleteElement Response ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **s_usergroup_name_x** | **str** | The Name of the Usergroup in the language of the requester | diff --git a/docs/UsergroupCreateObjectV1Request.md b/docs/UsergroupCreateObjectV1Request.md index f213fc2a5..cb616a5e0 100644 --- a/docs/UsergroupCreateObjectV1Request.md +++ b/docs/UsergroupCreateObjectV1Request.md @@ -3,6 +3,7 @@ Request for POST /1/object/usergroup ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_usergroup** | [**List[UsergroupRequestCompound]**](UsergroupRequestCompound.md) | | diff --git a/docs/UsergroupCreateObjectV1Response.md b/docs/UsergroupCreateObjectV1Response.md index 9c2ef39bf..376e77980 100644 --- a/docs/UsergroupCreateObjectV1Response.md +++ b/docs/UsergroupCreateObjectV1Response.md @@ -3,6 +3,7 @@ Response for POST /1/object/usergroup ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/UsergroupCreateObjectV1ResponseMPayload.md b/docs/UsergroupCreateObjectV1ResponseMPayload.md index cfe50f7c3..9c4cbed4c 100644 --- a/docs/UsergroupCreateObjectV1ResponseMPayload.md +++ b/docs/UsergroupCreateObjectV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for POST /1/object/usergroup ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_pki_usergroup_id** | **List[int]** | An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request. | diff --git a/docs/UsergroupEditObjectV1Request.md b/docs/UsergroupEditObjectV1Request.md index b74b95ab8..ddac9fad9 100644 --- a/docs/UsergroupEditObjectV1Request.md +++ b/docs/UsergroupEditObjectV1Request.md @@ -3,6 +3,7 @@ Request for PUT /1/object/usergroup/{pkiUsergroupID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_usergroup** | [**UsergroupRequestCompound**](UsergroupRequestCompound.md) | | diff --git a/docs/UsergroupEditObjectV1Response.md b/docs/UsergroupEditObjectV1Response.md index 845fa293c..027924a48 100644 --- a/docs/UsergroupEditObjectV1Response.md +++ b/docs/UsergroupEditObjectV1Response.md @@ -3,6 +3,7 @@ Response for PUT /1/object/usergroup/{pkiUsergroupID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/UsergroupEditPermissionsV1Request.md b/docs/UsergroupEditPermissionsV1Request.md index fd179ecf5..ae7745174 100644 --- a/docs/UsergroupEditPermissionsV1Request.md +++ b/docs/UsergroupEditPermissionsV1Request.md @@ -3,6 +3,7 @@ Request for PUT /1/object/usergroup/{pkiUsergroupID}/editPermissions ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_permission** | [**List[PermissionRequestCompound]**](PermissionRequestCompound.md) | | diff --git a/docs/UsergroupEditPermissionsV1Response.md b/docs/UsergroupEditPermissionsV1Response.md index 887feeda9..ac6979165 100644 --- a/docs/UsergroupEditPermissionsV1Response.md +++ b/docs/UsergroupEditPermissionsV1Response.md @@ -3,6 +3,7 @@ Response for PUT /1/object/usergroup/{pkiUsergroupID}/editPermissions ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/UsergroupEditPermissionsV1ResponseMPayload.md b/docs/UsergroupEditPermissionsV1ResponseMPayload.md index a688f7b36..f08711b6c 100644 --- a/docs/UsergroupEditPermissionsV1ResponseMPayload.md +++ b/docs/UsergroupEditPermissionsV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for PUT /1/object/usergroup/{pkiUsergroupID}/editPermissions ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_pki_permission_id** | **List[int]** | | diff --git a/docs/UsergroupEditUsergroupdelegationsV1Request.md b/docs/UsergroupEditUsergroupdelegationsV1Request.md index 52cec23c7..b3c4a50b7 100644 --- a/docs/UsergroupEditUsergroupdelegationsV1Request.md +++ b/docs/UsergroupEditUsergroupdelegationsV1Request.md @@ -3,6 +3,7 @@ Request for PUT /1/object/usergroup/{pkiUsergroupID}/editUsergroupdelegations ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_usergroupdelegation** | [**List[UsergroupdelegationRequestCompound]**](UsergroupdelegationRequestCompound.md) | | diff --git a/docs/UsergroupEditUsergroupdelegationsV1Response.md b/docs/UsergroupEditUsergroupdelegationsV1Response.md index 7187d0ea7..3aeab3e74 100644 --- a/docs/UsergroupEditUsergroupdelegationsV1Response.md +++ b/docs/UsergroupEditUsergroupdelegationsV1Response.md @@ -3,6 +3,7 @@ Response for PUT /1/object/usergroup/{pkiUsergroupID}/editUsergroupdelegations ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/UsergroupEditUsergroupdelegationsV1ResponseMPayload.md b/docs/UsergroupEditUsergroupdelegationsV1ResponseMPayload.md index 402991481..6ad97b57c 100644 --- a/docs/UsergroupEditUsergroupdelegationsV1ResponseMPayload.md +++ b/docs/UsergroupEditUsergroupdelegationsV1ResponseMPayload.md @@ -3,6 +3,7 @@ Response for PUT /1/object/usergroup/{pkiUsergroupID}/EditUsergroupdelegations ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_pki_usergroupdelegation_id** | **List[int]** | | diff --git a/docs/UsergroupEditUsergroupmembershipsV1Request.md b/docs/UsergroupEditUsergroupmembershipsV1Request.md index 841a99c42..e009c23a8 100644 --- a/docs/UsergroupEditUsergroupmembershipsV1Request.md +++ b/docs/UsergroupEditUsergroupmembershipsV1Request.md @@ -3,6 +3,7 @@ Request for PUT /1/object/usergroup/{pkiUsergroupID}/editUsergroupmemberships ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_usergroupmembership** | [**List[UsergroupmembershipRequestCompound]**](UsergroupmembershipRequestCompound.md) | | diff --git a/docs/UsergroupEditUsergroupmembershipsV1Response.md b/docs/UsergroupEditUsergroupmembershipsV1Response.md index 86f89a964..3ac0b775e 100644 --- a/docs/UsergroupEditUsergroupmembershipsV1Response.md +++ b/docs/UsergroupEditUsergroupmembershipsV1Response.md @@ -3,6 +3,7 @@ Response for PUT /1/object/usergroup/{pkiUsergroupID}/editUsergroupmemberships ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/UsergroupEditUsergroupmembershipsV1ResponseMPayload.md b/docs/UsergroupEditUsergroupmembershipsV1ResponseMPayload.md index d43344f7d..fcfd6c03a 100644 --- a/docs/UsergroupEditUsergroupmembershipsV1ResponseMPayload.md +++ b/docs/UsergroupEditUsergroupmembershipsV1ResponseMPayload.md @@ -3,6 +3,7 @@ Response for PUT /1/object/usergroup/{pkiUsergroupID}/editUsergroupmemberships ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_pki_usergroupmembership_id** | **List[int]** | | diff --git a/docs/UsergroupGetAutocompleteV2Response.md b/docs/UsergroupGetAutocompleteV2Response.md index e52e1615d..ca11a4cad 100644 --- a/docs/UsergroupGetAutocompleteV2Response.md +++ b/docs/UsergroupGetAutocompleteV2Response.md @@ -3,6 +3,7 @@ Response for GET /2/object/usergroup/getAutocomplete ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/UsergroupGetAutocompleteV2ResponseMPayload.md b/docs/UsergroupGetAutocompleteV2ResponseMPayload.md index 0e7137799..250b1334f 100644 --- a/docs/UsergroupGetAutocompleteV2ResponseMPayload.md +++ b/docs/UsergroupGetAutocompleteV2ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for POST /2/object/usergroup/getAutocomplete ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_usergroup** | [**List[UsergroupAutocompleteElementResponse]**](UsergroupAutocompleteElementResponse.md) | An array of Usergroup autocomplete element response. | diff --git a/docs/UsergroupGetListV1Response.md b/docs/UsergroupGetListV1Response.md index 83eb43053..2db6479b8 100644 --- a/docs/UsergroupGetListV1Response.md +++ b/docs/UsergroupGetListV1Response.md @@ -3,6 +3,7 @@ Response for GET /1/object/usergroup/getList ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayloadGetList**](CommonResponseObjDebugPayloadGetList.md) | | diff --git a/docs/UsergroupGetListV1ResponseMPayload.md b/docs/UsergroupGetListV1ResponseMPayload.md index efc76bb42..58625fbe6 100644 --- a/docs/UsergroupGetListV1ResponseMPayload.md +++ b/docs/UsergroupGetListV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for GET /1/object/usergroup/getList ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **i_row_returned** | **int** | The number of rows returned | diff --git a/docs/UsergroupGetObjectV2Response.md b/docs/UsergroupGetObjectV2Response.md index 2a8d5cb32..e6fdfb3cf 100644 --- a/docs/UsergroupGetObjectV2Response.md +++ b/docs/UsergroupGetObjectV2Response.md @@ -3,6 +3,7 @@ Response for GET /2/object/usergroup/{pkiUsergroupID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/UsergroupGetObjectV2ResponseMPayload.md b/docs/UsergroupGetObjectV2ResponseMPayload.md index 92077f79e..38375210a 100644 --- a/docs/UsergroupGetObjectV2ResponseMPayload.md +++ b/docs/UsergroupGetObjectV2ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for GET /2/object/usergroup/{pkiUsergroupID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_usergroup** | [**UsergroupResponseCompound**](UsergroupResponseCompound.md) | | diff --git a/docs/UsergroupGetPermissionsV1Response.md b/docs/UsergroupGetPermissionsV1Response.md index 953e978d4..ce5c33069 100644 --- a/docs/UsergroupGetPermissionsV1Response.md +++ b/docs/UsergroupGetPermissionsV1Response.md @@ -3,6 +3,7 @@ Response for GET /1/object/usergroup/{pkiUsergroupID}/getPermissions ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/UsergroupGetPermissionsV1ResponseMPayload.md b/docs/UsergroupGetPermissionsV1ResponseMPayload.md index 4ced60ccb..3ebf359bd 100644 --- a/docs/UsergroupGetPermissionsV1ResponseMPayload.md +++ b/docs/UsergroupGetPermissionsV1ResponseMPayload.md @@ -3,6 +3,7 @@ Response for GET /1/object/usergroup/{pkiUsergroupID}/getPermissions ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_modulegroup** | [**List[ModulegroupResponseCompound]**](ModulegroupResponseCompound.md) | | diff --git a/docs/UsergroupGetUsergroupdelegationsV1Response.md b/docs/UsergroupGetUsergroupdelegationsV1Response.md index 9ace80787..0cf3709fc 100644 --- a/docs/UsergroupGetUsergroupdelegationsV1Response.md +++ b/docs/UsergroupGetUsergroupdelegationsV1Response.md @@ -3,6 +3,7 @@ Response for GET /1/object/usergroup/{pkiUsergroupID}/getUsergroupdelegations ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/UsergroupGetUsergroupdelegationsV1ResponseMPayload.md b/docs/UsergroupGetUsergroupdelegationsV1ResponseMPayload.md index 6d72d0f68..bde533a81 100644 --- a/docs/UsergroupGetUsergroupdelegationsV1ResponseMPayload.md +++ b/docs/UsergroupGetUsergroupdelegationsV1ResponseMPayload.md @@ -3,6 +3,7 @@ Response for GET /1/object/usergroup/{pkiUsergroupID}/getUsergroupdelegations ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_usergroupdelegation** | [**List[UsergroupdelegationResponseCompound]**](UsergroupdelegationResponseCompound.md) | | diff --git a/docs/UsergroupGetUsergroupmembershipsV1Response.md b/docs/UsergroupGetUsergroupmembershipsV1Response.md index a168203c7..eecbda6ce 100644 --- a/docs/UsergroupGetUsergroupmembershipsV1Response.md +++ b/docs/UsergroupGetUsergroupmembershipsV1Response.md @@ -3,6 +3,7 @@ Response for GET /1/object/usergroup/{pkiUsergroupID}/getUsergroupmemberships ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/UsergroupGetUsergroupmembershipsV1ResponseMPayload.md b/docs/UsergroupGetUsergroupmembershipsV1ResponseMPayload.md index 375e46c52..7520a27ea 100644 --- a/docs/UsergroupGetUsergroupmembershipsV1ResponseMPayload.md +++ b/docs/UsergroupGetUsergroupmembershipsV1ResponseMPayload.md @@ -3,6 +3,7 @@ Response for GET /1/object/usergroup/{pkiUsergroupID}/getUsergroupmemberships ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_usergroupmembership** | [**List[UsergroupmembershipResponseCompound]**](UsergroupmembershipResponseCompound.md) | | diff --git a/docs/UsergroupListElement.md b/docs/UsergroupListElement.md index a3f36df2e..44d55775f 100644 --- a/docs/UsergroupListElement.md +++ b/docs/UsergroupListElement.md @@ -3,6 +3,7 @@ A Usergroup List Element ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_usergroup_id** | **int** | The unique ID of the Usergroup | diff --git a/docs/UsergroupRequest.md b/docs/UsergroupRequest.md index 3a4d4791c..1153d15ce 100644 --- a/docs/UsergroupRequest.md +++ b/docs/UsergroupRequest.md @@ -3,6 +3,7 @@ A Usergroup Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_usergroup_id** | **int** | The unique ID of the Usergroup | [optional] diff --git a/docs/UsergroupRequestCompound.md b/docs/UsergroupRequestCompound.md index cd66e1c20..07fce9fef 100644 --- a/docs/UsergroupRequestCompound.md +++ b/docs/UsergroupRequestCompound.md @@ -3,6 +3,7 @@ A Usergroup Object and children ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_usergroup_id** | **int** | The unique ID of the Usergroup | [optional] diff --git a/docs/UsergroupResponse.md b/docs/UsergroupResponse.md index 042e95444..7a049bf4c 100644 --- a/docs/UsergroupResponse.md +++ b/docs/UsergroupResponse.md @@ -3,6 +3,7 @@ A Usergroup Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_usergroup_id** | **int** | The unique ID of the Usergroup | diff --git a/docs/UsergroupResponseCompound.md b/docs/UsergroupResponseCompound.md index 8838f9764..52c3adaf3 100644 --- a/docs/UsergroupResponseCompound.md +++ b/docs/UsergroupResponseCompound.md @@ -3,6 +3,7 @@ A Usergroup Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_usergroup_id** | **int** | The unique ID of the Usergroup | diff --git a/docs/UsergroupdelegationCreateObjectV1Request.md b/docs/UsergroupdelegationCreateObjectV1Request.md index 8ec0c4c64..3ed58fa2b 100644 --- a/docs/UsergroupdelegationCreateObjectV1Request.md +++ b/docs/UsergroupdelegationCreateObjectV1Request.md @@ -3,6 +3,7 @@ Request for POST /1/object/usergroupdelegation ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_usergroupdelegation** | [**List[UsergroupdelegationRequestCompound]**](UsergroupdelegationRequestCompound.md) | | diff --git a/docs/UsergroupdelegationCreateObjectV1Response.md b/docs/UsergroupdelegationCreateObjectV1Response.md index e921a184e..8cc5ecd79 100644 --- a/docs/UsergroupdelegationCreateObjectV1Response.md +++ b/docs/UsergroupdelegationCreateObjectV1Response.md @@ -3,6 +3,7 @@ Response for POST /1/object/usergroupdelegation ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/UsergroupdelegationCreateObjectV1ResponseMPayload.md b/docs/UsergroupdelegationCreateObjectV1ResponseMPayload.md index 367275a03..e446f3aa5 100644 --- a/docs/UsergroupdelegationCreateObjectV1ResponseMPayload.md +++ b/docs/UsergroupdelegationCreateObjectV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for POST /1/object/usergroupdelegation ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_pki_usergroupdelegation_id** | **List[int]** | An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request. | diff --git a/docs/UsergroupdelegationDeleteObjectV1Response.md b/docs/UsergroupdelegationDeleteObjectV1Response.md index af007e3b6..efb624fbc 100644 --- a/docs/UsergroupdelegationDeleteObjectV1Response.md +++ b/docs/UsergroupdelegationDeleteObjectV1Response.md @@ -3,6 +3,7 @@ Response for DELETE /1/object/usergroupdelegation/{pkiUsergroupdelegationID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/UsergroupdelegationEditObjectV1Request.md b/docs/UsergroupdelegationEditObjectV1Request.md index 7cccf936c..688659a9c 100644 --- a/docs/UsergroupdelegationEditObjectV1Request.md +++ b/docs/UsergroupdelegationEditObjectV1Request.md @@ -3,6 +3,7 @@ Request for PUT /1/object/usergroupdelegation/{pkiUsergroupdelegationID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_usergroupdelegation** | [**UsergroupdelegationRequestCompound**](UsergroupdelegationRequestCompound.md) | | diff --git a/docs/UsergroupdelegationEditObjectV1Response.md b/docs/UsergroupdelegationEditObjectV1Response.md index 560a98e34..eb19aa151 100644 --- a/docs/UsergroupdelegationEditObjectV1Response.md +++ b/docs/UsergroupdelegationEditObjectV1Response.md @@ -3,6 +3,7 @@ Response for PUT /1/object/usergroupdelegation/{pkiUsergroupdelegationID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/UsergroupdelegationGetObjectV2Response.md b/docs/UsergroupdelegationGetObjectV2Response.md index ea874b819..b0735e51b 100644 --- a/docs/UsergroupdelegationGetObjectV2Response.md +++ b/docs/UsergroupdelegationGetObjectV2Response.md @@ -3,6 +3,7 @@ Response for GET /2/object/usergroupdelegation/{pkiUsergroupdelegationID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/UsergroupdelegationGetObjectV2ResponseMPayload.md b/docs/UsergroupdelegationGetObjectV2ResponseMPayload.md index 628c9b1da..47b9dee02 100644 --- a/docs/UsergroupdelegationGetObjectV2ResponseMPayload.md +++ b/docs/UsergroupdelegationGetObjectV2ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for GET /2/object/usergroupdelegation/{pkiUsergroupdelegationID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_usergroupdelegation** | [**UsergroupdelegationResponseCompound**](UsergroupdelegationResponseCompound.md) | | diff --git a/docs/UsergroupdelegationRequest.md b/docs/UsergroupdelegationRequest.md index f47df119f..62669ce6e 100644 --- a/docs/UsergroupdelegationRequest.md +++ b/docs/UsergroupdelegationRequest.md @@ -3,6 +3,7 @@ A Usergroupdelegation Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_usergroupdelegation_id** | **int** | The unique ID of the Usergroupdelegation | [optional] diff --git a/docs/UsergroupdelegationRequestCompound.md b/docs/UsergroupdelegationRequestCompound.md index cb17716a0..2db3f3f73 100644 --- a/docs/UsergroupdelegationRequestCompound.md +++ b/docs/UsergroupdelegationRequestCompound.md @@ -3,6 +3,7 @@ A Usergroupdelegation Object and children ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_usergroupdelegation_id** | **int** | The unique ID of the Usergroupdelegation | [optional] diff --git a/docs/UsergroupdelegationResponse.md b/docs/UsergroupdelegationResponse.md index 1ed72f43c..a096bd236 100644 --- a/docs/UsergroupdelegationResponse.md +++ b/docs/UsergroupdelegationResponse.md @@ -3,6 +3,7 @@ A Usergroupdelegation Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_usergroupdelegation_id** | **int** | The unique ID of the Usergroupdelegation | diff --git a/docs/UsergroupdelegationResponseCompound.md b/docs/UsergroupdelegationResponseCompound.md index 31bfb5796..281e773e0 100644 --- a/docs/UsergroupdelegationResponseCompound.md +++ b/docs/UsergroupdelegationResponseCompound.md @@ -3,6 +3,7 @@ A Usergroupdelegation Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_usergroupdelegation_id** | **int** | The unique ID of the Usergroupdelegation | diff --git a/docs/UsergroupmembershipCreateObjectV1Request.md b/docs/UsergroupmembershipCreateObjectV1Request.md index 567ae8b94..e9f3b5458 100644 --- a/docs/UsergroupmembershipCreateObjectV1Request.md +++ b/docs/UsergroupmembershipCreateObjectV1Request.md @@ -3,6 +3,7 @@ Request for POST /1/object/usergroupmembership ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_usergroupmembership** | [**List[UsergroupmembershipRequestCompound]**](UsergroupmembershipRequestCompound.md) | | diff --git a/docs/UsergroupmembershipCreateObjectV1Response.md b/docs/UsergroupmembershipCreateObjectV1Response.md index 7cb6f9091..39e0a508a 100644 --- a/docs/UsergroupmembershipCreateObjectV1Response.md +++ b/docs/UsergroupmembershipCreateObjectV1Response.md @@ -3,6 +3,7 @@ Response for POST /1/object/usergroupmembership ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/UsergroupmembershipCreateObjectV1ResponseMPayload.md b/docs/UsergroupmembershipCreateObjectV1ResponseMPayload.md index d968bb325..1d20fd9ce 100644 --- a/docs/UsergroupmembershipCreateObjectV1ResponseMPayload.md +++ b/docs/UsergroupmembershipCreateObjectV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for POST /1/object/usergroupmembership ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_pki_usergroupmembership_id** | **List[int]** | An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request. | diff --git a/docs/UsergroupmembershipDeleteObjectV1Response.md b/docs/UsergroupmembershipDeleteObjectV1Response.md index 31d99daac..debb3909d 100644 --- a/docs/UsergroupmembershipDeleteObjectV1Response.md +++ b/docs/UsergroupmembershipDeleteObjectV1Response.md @@ -3,6 +3,7 @@ Response for DELETE /1/object/usergroupmembership/{pkiUsergroupmembershipID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/UsergroupmembershipEditObjectV1Request.md b/docs/UsergroupmembershipEditObjectV1Request.md index 727ab68c8..e59c01032 100644 --- a/docs/UsergroupmembershipEditObjectV1Request.md +++ b/docs/UsergroupmembershipEditObjectV1Request.md @@ -3,6 +3,7 @@ Request for PUT /1/object/usergroupmembership/{pkiUsergroupmembershipID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_usergroupmembership** | [**UsergroupmembershipRequestCompound**](UsergroupmembershipRequestCompound.md) | | diff --git a/docs/UsergroupmembershipEditObjectV1Response.md b/docs/UsergroupmembershipEditObjectV1Response.md index 42456ef8d..ed1743cb4 100644 --- a/docs/UsergroupmembershipEditObjectV1Response.md +++ b/docs/UsergroupmembershipEditObjectV1Response.md @@ -3,6 +3,7 @@ Response for PUT /1/object/usergroupmembership/{pkiUsergroupmembershipID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/UsergroupmembershipGetObjectV2Response.md b/docs/UsergroupmembershipGetObjectV2Response.md index 333d09c22..c8007561e 100644 --- a/docs/UsergroupmembershipGetObjectV2Response.md +++ b/docs/UsergroupmembershipGetObjectV2Response.md @@ -3,6 +3,7 @@ Response for GET /2/object/usergroupmembership/{pkiUsergroupmembershipID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/UsergroupmembershipGetObjectV2ResponseMPayload.md b/docs/UsergroupmembershipGetObjectV2ResponseMPayload.md index f217200a6..b611c59b4 100644 --- a/docs/UsergroupmembershipGetObjectV2ResponseMPayload.md +++ b/docs/UsergroupmembershipGetObjectV2ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for GET /2/object/usergroupmembership/{pkiUsergroupmembershipID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_usergroupmembership** | [**UsergroupmembershipResponseCompound**](UsergroupmembershipResponseCompound.md) | | diff --git a/docs/UsergroupmembershipRequest.md b/docs/UsergroupmembershipRequest.md index 16de343bd..09753f043 100644 --- a/docs/UsergroupmembershipRequest.md +++ b/docs/UsergroupmembershipRequest.md @@ -3,6 +3,7 @@ A Usergroupmembership Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_usergroupmembership_id** | **int** | The unique ID of the Usergroupmembership | [optional] diff --git a/docs/UsergroupmembershipRequestCompound.md b/docs/UsergroupmembershipRequestCompound.md index 6aa1e6195..81c5fd287 100644 --- a/docs/UsergroupmembershipRequestCompound.md +++ b/docs/UsergroupmembershipRequestCompound.md @@ -3,6 +3,7 @@ A Usergroupmembership Object and children ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_usergroupmembership_id** | **int** | The unique ID of the Usergroupmembership | [optional] diff --git a/docs/UsergroupmembershipResponse.md b/docs/UsergroupmembershipResponse.md index c3feae06b..179d22b91 100644 --- a/docs/UsergroupmembershipResponse.md +++ b/docs/UsergroupmembershipResponse.md @@ -3,6 +3,7 @@ A Usergroupmembership Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_usergroupmembership_id** | **int** | The unique ID of the Usergroupmembership | diff --git a/docs/UsergroupmembershipResponseCompound.md b/docs/UsergroupmembershipResponseCompound.md index f8208407d..394fcde8b 100644 --- a/docs/UsergroupmembershipResponseCompound.md +++ b/docs/UsergroupmembershipResponseCompound.md @@ -3,6 +3,7 @@ A Usergroupmembership Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_usergroupmembership_id** | **int** | The unique ID of the Usergroupmembership | diff --git a/docs/UserlogintypeAutocompleteElementResponse.md b/docs/UserlogintypeAutocompleteElementResponse.md index 1fb8dbed0..06ca83529 100644 --- a/docs/UserlogintypeAutocompleteElementResponse.md +++ b/docs/UserlogintypeAutocompleteElementResponse.md @@ -3,6 +3,7 @@ A Userlogintype AutocompleteElement Response ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_userlogintype_id** | **int** | The unique ID of the Userlogintype Valid values: |Value|Description|Detail| |-|-|-| |1|**Email Only**|The Ezsignsigner will receive a secure link by email| |2|**Email and phone or SMS**|The Ezsignsigner will receive a secure link by email and will need to authenticate using SMS or Phone call. **Additional fee applies**| |3|**Email and secret question**|The Ezsignsigner will receive a secure link by email and will need to authenticate using a predefined question and answer| |4|**In person only**|The Ezsignsigner will only be able to sign \"In-Person\" and there won't be any authentication. No email will be sent for invitation to sign. Make sure you evaluate the risk of signature denial and at minimum, we recommend you use a handwritten signature type| |5|**In person with phone or SMS**|The Ezsignsigner will only be able to sign \"In-Person\" and will need to authenticate using SMS or Phone call. No email will be sent for invitation to sign. **Additional fee applies**| | diff --git a/docs/UserlogintypeGetAutocompleteV2Response.md b/docs/UserlogintypeGetAutocompleteV2Response.md index 6ba7d7703..1ae0b1883 100644 --- a/docs/UserlogintypeGetAutocompleteV2Response.md +++ b/docs/UserlogintypeGetAutocompleteV2Response.md @@ -3,6 +3,7 @@ Response for GET /2/object/userlogintype/getAutocomplete ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/UserlogintypeGetAutocompleteV2ResponseMPayload.md b/docs/UserlogintypeGetAutocompleteV2ResponseMPayload.md index dd2e3e8f9..8fb457658 100644 --- a/docs/UserlogintypeGetAutocompleteV2ResponseMPayload.md +++ b/docs/UserlogintypeGetAutocompleteV2ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for POST /2/object/userlogintype/getAutocomplete ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_userlogintype** | [**List[UserlogintypeAutocompleteElementResponse]**](UserlogintypeAutocompleteElementResponse.md) | An array of Userlogintype autocomplete element response. | diff --git a/docs/UserstagedCreateUserV1Response.md b/docs/UserstagedCreateUserV1Response.md index 368f11c67..1427a9364 100644 --- a/docs/UserstagedCreateUserV1Response.md +++ b/docs/UserstagedCreateUserV1Response.md @@ -3,6 +3,7 @@ Response for POST /1/object/userstaged/{pkiUserstagedID}/createUser ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/UserstagedCreateUserV1ResponseMPayload.md b/docs/UserstagedCreateUserV1ResponseMPayload.md index f7547109d..caae2749b 100644 --- a/docs/UserstagedCreateUserV1ResponseMPayload.md +++ b/docs/UserstagedCreateUserV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for POST /1/object/userstaged/{pkiUserstagedID}/createUser ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_user_id** | **int** | The unique ID of the User | diff --git a/docs/UserstagedDeleteObjectV1Response.md b/docs/UserstagedDeleteObjectV1Response.md index 68c35adf2..d164891b6 100644 --- a/docs/UserstagedDeleteObjectV1Response.md +++ b/docs/UserstagedDeleteObjectV1Response.md @@ -3,6 +3,7 @@ Response for DELETE /1/object/userstaged/{pkiUserstagedID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/UserstagedGetListV1Response.md b/docs/UserstagedGetListV1Response.md index 71f9b74ef..659effbb9 100644 --- a/docs/UserstagedGetListV1Response.md +++ b/docs/UserstagedGetListV1Response.md @@ -3,6 +3,7 @@ Response for GET /1/object/userstaged/getList ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayloadGetList**](CommonResponseObjDebugPayloadGetList.md) | | diff --git a/docs/UserstagedGetListV1ResponseMPayload.md b/docs/UserstagedGetListV1ResponseMPayload.md index 81870c282..1fac2bfc4 100644 --- a/docs/UserstagedGetListV1ResponseMPayload.md +++ b/docs/UserstagedGetListV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for GET /1/object/userstaged/getList ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **i_row_returned** | **int** | The number of rows returned | diff --git a/docs/UserstagedGetObjectV2Response.md b/docs/UserstagedGetObjectV2Response.md index c1bbfaf6c..5fb0e86cc 100644 --- a/docs/UserstagedGetObjectV2Response.md +++ b/docs/UserstagedGetObjectV2Response.md @@ -3,6 +3,7 @@ Response for GET /2/object/userstaged/{pkiUserstagedID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/UserstagedGetObjectV2ResponseMPayload.md b/docs/UserstagedGetObjectV2ResponseMPayload.md index dd44ab189..6fc965cdd 100644 --- a/docs/UserstagedGetObjectV2ResponseMPayload.md +++ b/docs/UserstagedGetObjectV2ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for GET /2/object/userstaged/{pkiUserstagedID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_userstaged** | [**UserstagedResponseCompound**](UserstagedResponseCompound.md) | | diff --git a/docs/UserstagedListElement.md b/docs/UserstagedListElement.md index 02f287aad..1d9cb64a6 100644 --- a/docs/UserstagedListElement.md +++ b/docs/UserstagedListElement.md @@ -3,6 +3,7 @@ A Userstaged List Element ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_userstaged_id** | **int** | The unique ID of the Userstaged | diff --git a/docs/UserstagedMapV1Request.md b/docs/UserstagedMapV1Request.md index 03f6066db..eff162da9 100644 --- a/docs/UserstagedMapV1Request.md +++ b/docs/UserstagedMapV1Request.md @@ -3,6 +3,7 @@ Request for POST /1/object/userstaged/{pkiUserstagedID}/map ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **fki_user_id** | **int** | The unique ID of the User | diff --git a/docs/UserstagedMapV1Response.md b/docs/UserstagedMapV1Response.md index edc6dd20b..558061add 100644 --- a/docs/UserstagedMapV1Response.md +++ b/docs/UserstagedMapV1Response.md @@ -3,6 +3,7 @@ Response for POST /1/object/userstaged/{pkiUserstagedID}/map ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/UserstagedResponse.md b/docs/UserstagedResponse.md index 87c500603..467fa173c 100644 --- a/docs/UserstagedResponse.md +++ b/docs/UserstagedResponse.md @@ -3,6 +3,7 @@ A Userstaged Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_userstaged_id** | **int** | The unique ID of the Userstaged | diff --git a/docs/UserstagedResponseCompound.md b/docs/UserstagedResponseCompound.md index 94092a2fd..c064bb8d0 100644 --- a/docs/UserstagedResponseCompound.md +++ b/docs/UserstagedResponseCompound.md @@ -3,6 +3,7 @@ A Userstaged Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_userstaged_id** | **int** | The unique ID of the Userstaged | diff --git a/docs/VariableexpenseAutocompleteElementResponse.md b/docs/VariableexpenseAutocompleteElementResponse.md index 7e68cb86b..1fa4ea71e 100644 --- a/docs/VariableexpenseAutocompleteElementResponse.md +++ b/docs/VariableexpenseAutocompleteElementResponse.md @@ -3,6 +3,7 @@ A Variableexpense AutocompleteElement Response ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **s_variableexpense_description_x** | **str** | The description of the Variableexpense in the language of the requester | diff --git a/docs/VariableexpenseCreateObjectV1Request.md b/docs/VariableexpenseCreateObjectV1Request.md index 962eb2162..3f8f70b83 100644 --- a/docs/VariableexpenseCreateObjectV1Request.md +++ b/docs/VariableexpenseCreateObjectV1Request.md @@ -3,6 +3,7 @@ Request for POST /1/object/variableexpense ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_variableexpense** | [**List[VariableexpenseRequestCompound]**](VariableexpenseRequestCompound.md) | | diff --git a/docs/VariableexpenseCreateObjectV1Response.md b/docs/VariableexpenseCreateObjectV1Response.md index 0b985f984..681d9d4fc 100644 --- a/docs/VariableexpenseCreateObjectV1Response.md +++ b/docs/VariableexpenseCreateObjectV1Response.md @@ -3,6 +3,7 @@ Response for POST /1/object/variableexpense ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/VariableexpenseCreateObjectV1ResponseMPayload.md b/docs/VariableexpenseCreateObjectV1ResponseMPayload.md index 81ba13ea8..19747aef6 100644 --- a/docs/VariableexpenseCreateObjectV1ResponseMPayload.md +++ b/docs/VariableexpenseCreateObjectV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for POST /1/object/variableexpense ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_pki_variableexpense_id** | **List[int]** | An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request. | diff --git a/docs/VariableexpenseEditObjectV1Request.md b/docs/VariableexpenseEditObjectV1Request.md index b91f55791..4c76cc115 100644 --- a/docs/VariableexpenseEditObjectV1Request.md +++ b/docs/VariableexpenseEditObjectV1Request.md @@ -3,6 +3,7 @@ Request for PUT /1/object/variableexpense/{pkiVariableexpenseID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_variableexpense** | [**VariableexpenseRequestCompound**](VariableexpenseRequestCompound.md) | | diff --git a/docs/VariableexpenseEditObjectV1Response.md b/docs/VariableexpenseEditObjectV1Response.md index 59c6287c0..6712fb620 100644 --- a/docs/VariableexpenseEditObjectV1Response.md +++ b/docs/VariableexpenseEditObjectV1Response.md @@ -3,6 +3,7 @@ Response for PUT /1/object/variableexpense/{pkiVariableexpenseID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/VariableexpenseGetAutocompleteV2Response.md b/docs/VariableexpenseGetAutocompleteV2Response.md index 3a90d0c6e..3fab2d546 100644 --- a/docs/VariableexpenseGetAutocompleteV2Response.md +++ b/docs/VariableexpenseGetAutocompleteV2Response.md @@ -3,6 +3,7 @@ Response for GET /2/object/variableexpense/getAutocomplete ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/VariableexpenseGetAutocompleteV2ResponseMPayload.md b/docs/VariableexpenseGetAutocompleteV2ResponseMPayload.md index 674be71dc..b8041ec29 100644 --- a/docs/VariableexpenseGetAutocompleteV2ResponseMPayload.md +++ b/docs/VariableexpenseGetAutocompleteV2ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for POST /2/object/variableexpense/getAutocomplete ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_variableexpense** | [**List[VariableexpenseAutocompleteElementResponse]**](VariableexpenseAutocompleteElementResponse.md) | An array of Variableexpense autocomplete element response. | diff --git a/docs/VariableexpenseGetListV1Response.md b/docs/VariableexpenseGetListV1Response.md index 00ade2a57..c369d912f 100644 --- a/docs/VariableexpenseGetListV1Response.md +++ b/docs/VariableexpenseGetListV1Response.md @@ -3,6 +3,7 @@ Response for GET /1/object/variableexpense/getList ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayloadGetList**](CommonResponseObjDebugPayloadGetList.md) | | diff --git a/docs/VariableexpenseGetListV1ResponseMPayload.md b/docs/VariableexpenseGetListV1ResponseMPayload.md index aec5a2e96..7774b972c 100644 --- a/docs/VariableexpenseGetListV1ResponseMPayload.md +++ b/docs/VariableexpenseGetListV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for GET /1/object/variableexpense/getList ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **i_row_returned** | **int** | The number of rows returned | diff --git a/docs/VariableexpenseGetObjectV2Response.md b/docs/VariableexpenseGetObjectV2Response.md index 3dd7c2e32..ede40bc44 100644 --- a/docs/VariableexpenseGetObjectV2Response.md +++ b/docs/VariableexpenseGetObjectV2Response.md @@ -3,6 +3,7 @@ Response for GET /2/object/variableexpense/{pkiVariableexpenseID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/VariableexpenseGetObjectV2ResponseMPayload.md b/docs/VariableexpenseGetObjectV2ResponseMPayload.md index 616f47e44..17b145978 100644 --- a/docs/VariableexpenseGetObjectV2ResponseMPayload.md +++ b/docs/VariableexpenseGetObjectV2ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for GET /2/object/variableexpense/{pkiVariableexpenseID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_variableexpense** | [**VariableexpenseResponseCompound**](VariableexpenseResponseCompound.md) | | diff --git a/docs/VariableexpenseListElement.md b/docs/VariableexpenseListElement.md index b732727ab..ad057d00e 100644 --- a/docs/VariableexpenseListElement.md +++ b/docs/VariableexpenseListElement.md @@ -3,6 +3,7 @@ A Variableexpense List Element ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_variableexpense_id** | **int** | The unique ID of the Variableexpense | diff --git a/docs/VariableexpenseRequest.md b/docs/VariableexpenseRequest.md index e919e5d96..498591b6d 100644 --- a/docs/VariableexpenseRequest.md +++ b/docs/VariableexpenseRequest.md @@ -3,6 +3,7 @@ A Variableexpense Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_variableexpense_id** | **int** | The unique ID of the Variableexpense | [optional] diff --git a/docs/VariableexpenseRequestCompound.md b/docs/VariableexpenseRequestCompound.md index bb026d2d0..5cedd3ec8 100644 --- a/docs/VariableexpenseRequestCompound.md +++ b/docs/VariableexpenseRequestCompound.md @@ -3,6 +3,7 @@ A Variableexpense Object and children ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_variableexpense_id** | **int** | The unique ID of the Variableexpense | [optional] diff --git a/docs/VariableexpenseResponse.md b/docs/VariableexpenseResponse.md index e67187607..478f7434b 100644 --- a/docs/VariableexpenseResponse.md +++ b/docs/VariableexpenseResponse.md @@ -3,6 +3,7 @@ A Variableexpense Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_variableexpense_id** | **int** | The unique ID of the Variableexpense | diff --git a/docs/VariableexpenseResponseCompound.md b/docs/VariableexpenseResponseCompound.md index 47c475f1a..c52a810e8 100644 --- a/docs/VariableexpenseResponseCompound.md +++ b/docs/VariableexpenseResponseCompound.md @@ -3,6 +3,7 @@ A Variableexpense Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_variableexpense_id** | **int** | The unique ID of the Variableexpense | diff --git a/docs/VersionhistoryGetObjectV2Response.md b/docs/VersionhistoryGetObjectV2Response.md index 1a4961c8c..59de9340c 100644 --- a/docs/VersionhistoryGetObjectV2Response.md +++ b/docs/VersionhistoryGetObjectV2Response.md @@ -3,6 +3,7 @@ Response for GET /2/object/versionhistory/{pkiVersionhistoryID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/VersionhistoryGetObjectV2ResponseMPayload.md b/docs/VersionhistoryGetObjectV2ResponseMPayload.md index 4529553aa..6e319b2a5 100644 --- a/docs/VersionhistoryGetObjectV2ResponseMPayload.md +++ b/docs/VersionhistoryGetObjectV2ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for GET /2/object/versionhistory/{pkiVersionhistoryID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_versionhistory** | [**VersionhistoryResponseCompound**](VersionhistoryResponseCompound.md) | | diff --git a/docs/VersionhistoryResponse.md b/docs/VersionhistoryResponse.md index 7cdbb7921..9ed6577a4 100644 --- a/docs/VersionhistoryResponse.md +++ b/docs/VersionhistoryResponse.md @@ -3,6 +3,7 @@ A Versionhistory Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_versionhistory_id** | **int** | The unique ID of the Versionhistory | diff --git a/docs/VersionhistoryResponseCompound.md b/docs/VersionhistoryResponseCompound.md index f09a72c44..8f1724e83 100644 --- a/docs/VersionhistoryResponseCompound.md +++ b/docs/VersionhistoryResponseCompound.md @@ -3,6 +3,7 @@ A Versionhistory Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_versionhistory_id** | **int** | The unique ID of the Versionhistory | diff --git a/docs/WebhookCreateObjectV1Request.md b/docs/WebhookCreateObjectV1Request.md index fba181af9..83da36492 100644 --- a/docs/WebhookCreateObjectV1Request.md +++ b/docs/WebhookCreateObjectV1Request.md @@ -3,6 +3,7 @@ Request for POST /1/object/webhook ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_webhook** | [**List[WebhookRequestCompound]**](WebhookRequestCompound.md) | | diff --git a/docs/WebhookCreateObjectV1Response.md b/docs/WebhookCreateObjectV1Response.md index 31567a993..949d52019 100644 --- a/docs/WebhookCreateObjectV1Response.md +++ b/docs/WebhookCreateObjectV1Response.md @@ -3,6 +3,7 @@ Response for POST /1/object/webhook ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/WebhookCreateObjectV1ResponseMPayload.md b/docs/WebhookCreateObjectV1ResponseMPayload.md index 6ae381617..b0247842b 100644 --- a/docs/WebhookCreateObjectV1ResponseMPayload.md +++ b/docs/WebhookCreateObjectV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for POST /1/object/webhook ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_pki_webhook_id** | **List[int]** | An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request. | diff --git a/docs/WebhookCreateObjectV2Request.md b/docs/WebhookCreateObjectV2Request.md new file mode 100644 index 000000000..a1d1f82b1 --- /dev/null +++ b/docs/WebhookCreateObjectV2Request.md @@ -0,0 +1,30 @@ +# WebhookCreateObjectV2Request + +Request for POST /2/object/webhook + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**a_obj_webhook** | [**List[WebhookRequestCompound]**](WebhookRequestCompound.md) | | + +## Example + +```python +from eZmaxApi.models.webhook_create_object_v2_request import WebhookCreateObjectV2Request + +# TODO update the JSON string below +json = "{}" +# create an instance of WebhookCreateObjectV2Request from a JSON string +webhook_create_object_v2_request_instance = WebhookCreateObjectV2Request.from_json(json) +# print the JSON string representation of the object +print WebhookCreateObjectV2Request.to_json() + +# convert the object into a dict +webhook_create_object_v2_request_dict = webhook_create_object_v2_request_instance.to_dict() +# create an instance of WebhookCreateObjectV2Request from a dict +webhook_create_object_v2_request_form_dict = webhook_create_object_v2_request.from_dict(webhook_create_object_v2_request_dict) +``` +[[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/docs/WebhookCreateObjectV2Response.md b/docs/WebhookCreateObjectV2Response.md new file mode 100644 index 000000000..2b61419ef --- /dev/null +++ b/docs/WebhookCreateObjectV2Response.md @@ -0,0 +1,32 @@ +# WebhookCreateObjectV2Response + +Response for POST /2/object/webhook + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | +**obj_debug** | [**CommonResponseObjDebug**](CommonResponseObjDebug.md) | | [optional] +**m_payload** | [**WebhookCreateObjectV2ResponseMPayload**](WebhookCreateObjectV2ResponseMPayload.md) | | + +## Example + +```python +from eZmaxApi.models.webhook_create_object_v2_response import WebhookCreateObjectV2Response + +# TODO update the JSON string below +json = "{}" +# create an instance of WebhookCreateObjectV2Response from a JSON string +webhook_create_object_v2_response_instance = WebhookCreateObjectV2Response.from_json(json) +# print the JSON string representation of the object +print WebhookCreateObjectV2Response.to_json() + +# convert the object into a dict +webhook_create_object_v2_response_dict = webhook_create_object_v2_response_instance.to_dict() +# create an instance of WebhookCreateObjectV2Response from a dict +webhook_create_object_v2_response_form_dict = webhook_create_object_v2_response.from_dict(webhook_create_object_v2_response_dict) +``` +[[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/docs/WebhookCreateObjectV2ResponseMPayload.md b/docs/WebhookCreateObjectV2ResponseMPayload.md new file mode 100644 index 000000000..a3c71c6a8 --- /dev/null +++ b/docs/WebhookCreateObjectV2ResponseMPayload.md @@ -0,0 +1,30 @@ +# WebhookCreateObjectV2ResponseMPayload + +Payload for POST /2/object/webhook + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**a_obj_webhook** | [**List[WebhookResponseCompound]**](WebhookResponseCompound.md) | | + +## Example + +```python +from eZmaxApi.models.webhook_create_object_v2_response_m_payload import WebhookCreateObjectV2ResponseMPayload + +# TODO update the JSON string below +json = "{}" +# create an instance of WebhookCreateObjectV2ResponseMPayload from a JSON string +webhook_create_object_v2_response_m_payload_instance = WebhookCreateObjectV2ResponseMPayload.from_json(json) +# print the JSON string representation of the object +print WebhookCreateObjectV2ResponseMPayload.to_json() + +# convert the object into a dict +webhook_create_object_v2_response_m_payload_dict = webhook_create_object_v2_response_m_payload_instance.to_dict() +# create an instance of WebhookCreateObjectV2ResponseMPayload from a dict +webhook_create_object_v2_response_m_payload_form_dict = webhook_create_object_v2_response_m_payload.from_dict(webhook_create_object_v2_response_m_payload_dict) +``` +[[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/docs/WebhookDeleteObjectV1Response.md b/docs/WebhookDeleteObjectV1Response.md index dd77f953e..44038b9a5 100644 --- a/docs/WebhookDeleteObjectV1Response.md +++ b/docs/WebhookDeleteObjectV1Response.md @@ -3,6 +3,7 @@ Response for DELETE /1/object/webhook/{pkiWebhookID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/WebhookEditObjectV1Request.md b/docs/WebhookEditObjectV1Request.md index 75164a159..a564d76b3 100644 --- a/docs/WebhookEditObjectV1Request.md +++ b/docs/WebhookEditObjectV1Request.md @@ -3,6 +3,7 @@ Request for PUT /1/object/webhook/{pkiWebhookID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_webhook** | [**WebhookRequestCompound**](WebhookRequestCompound.md) | | diff --git a/docs/WebhookEditObjectV1Response.md b/docs/WebhookEditObjectV1Response.md index ff1bc0102..5c637fc35 100644 --- a/docs/WebhookEditObjectV1Response.md +++ b/docs/WebhookEditObjectV1Response.md @@ -3,6 +3,7 @@ Response for PUT /1/object/webhook/{pkiWebhookID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/WebhookEzsignDocumentCompleted.md b/docs/WebhookEzsignDocumentCompleted.md index 5f03ee16f..f11f108b7 100644 --- a/docs/WebhookEzsignDocumentCompleted.md +++ b/docs/WebhookEzsignDocumentCompleted.md @@ -3,6 +3,7 @@ This is the base Webhook object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_webhook** | [**CustomWebhookResponse**](CustomWebhookResponse.md) | | diff --git a/docs/WebhookEzsignEzsignsignerAcceptclause.md b/docs/WebhookEzsignEzsignsignerAcceptclause.md index 6535407ae..5d48365f1 100644 --- a/docs/WebhookEzsignEzsignsignerAcceptclause.md +++ b/docs/WebhookEzsignEzsignsignerAcceptclause.md @@ -3,6 +3,7 @@ This is the base Webhook object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_webhook** | [**CustomWebhookResponse**](CustomWebhookResponse.md) | | diff --git a/docs/WebhookEzsignEzsignsignerConnect.md b/docs/WebhookEzsignEzsignsignerConnect.md index ea7b90365..89cbf9f17 100644 --- a/docs/WebhookEzsignEzsignsignerConnect.md +++ b/docs/WebhookEzsignEzsignsignerConnect.md @@ -3,6 +3,7 @@ This is the base Webhook object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_webhook** | [**CustomWebhookResponse**](CustomWebhookResponse.md) | | diff --git a/docs/WebhookEzsignFolderCompleted.md b/docs/WebhookEzsignFolderCompleted.md index ee8eb1531..a7ff277da 100644 --- a/docs/WebhookEzsignFolderCompleted.md +++ b/docs/WebhookEzsignFolderCompleted.md @@ -3,6 +3,7 @@ This is the base Webhook object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_webhook** | [**CustomWebhookResponse**](CustomWebhookResponse.md) | | diff --git a/docs/WebhookGetHistoryV1Response.md b/docs/WebhookGetHistoryV1Response.md index 143016811..5d7709ffa 100644 --- a/docs/WebhookGetHistoryV1Response.md +++ b/docs/WebhookGetHistoryV1Response.md @@ -3,6 +3,7 @@ Response for GET /1/object/webhook/{pkiWebhookID}/getHistory ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/WebhookGetHistoryV1ResponseMPayload.md b/docs/WebhookGetHistoryV1ResponseMPayload.md index 009399109..5c96d4f35 100644 --- a/docs/WebhookGetHistoryV1ResponseMPayload.md +++ b/docs/WebhookGetHistoryV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for GET /1/object/webhook/{pkiWebhookID}/getHistory ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **a_obj_webhooklog** | [**List[CustomWebhooklogResponse]**](CustomWebhooklogResponse.md) | | diff --git a/docs/WebhookGetListV1Response.md b/docs/WebhookGetListV1Response.md index 590a23a0a..450d24483 100644 --- a/docs/WebhookGetListV1Response.md +++ b/docs/WebhookGetListV1Response.md @@ -3,6 +3,7 @@ Response for GET /1/object/webhook/getList ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayloadGetList**](CommonResponseObjDebugPayloadGetList.md) | | diff --git a/docs/WebhookGetListV1ResponseMPayload.md b/docs/WebhookGetListV1ResponseMPayload.md index b8814396e..fddcb755b 100644 --- a/docs/WebhookGetListV1ResponseMPayload.md +++ b/docs/WebhookGetListV1ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for GET /1/object/webhook/getList ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **i_row_returned** | **int** | The number of rows returned | diff --git a/docs/WebhookGetObjectV2Response.md b/docs/WebhookGetObjectV2Response.md index a1e2aca0f..a53529a82 100644 --- a/docs/WebhookGetObjectV2Response.md +++ b/docs/WebhookGetObjectV2Response.md @@ -3,6 +3,7 @@ Response for GET /2/object/webhook/{pkiWebhookID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/WebhookGetObjectV2ResponseMPayload.md b/docs/WebhookGetObjectV2ResponseMPayload.md index d69693080..602f0bb40 100644 --- a/docs/WebhookGetObjectV2ResponseMPayload.md +++ b/docs/WebhookGetObjectV2ResponseMPayload.md @@ -3,6 +3,7 @@ Payload for GET /2/object/webhook/{pkiWebhookID} ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_webhook** | [**WebhookResponseCompound**](WebhookResponseCompound.md) | | diff --git a/docs/WebhookListElement.md b/docs/WebhookListElement.md index 7bc14c374..754562e39 100644 --- a/docs/WebhookListElement.md +++ b/docs/WebhookListElement.md @@ -3,6 +3,7 @@ A Webhook List Element ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_webhook_id** | **int** | The unique ID of the Webhook | @@ -14,6 +15,7 @@ Name | Type | Description | Notes **e_webhook_ezsignevent** | [**FieldEWebhookEzsignevent**](FieldEWebhookEzsignevent.md) | | [optional] **e_webhook_managementevent** | [**FieldEWebhookManagementevent**](FieldEWebhookManagementevent.md) | | [optional] **b_webhook_isactive** | **bool** | Whether the Webhook is active or not | +**b_webhook_issigned** | **bool** | Whether the requests will be signed or not | ## Example diff --git a/docs/WebhookRegenerateApikeyV1Request.md b/docs/WebhookRegenerateApikeyV1Request.md new file mode 100644 index 000000000..0528b4388 --- /dev/null +++ b/docs/WebhookRegenerateApikeyV1Request.md @@ -0,0 +1,30 @@ +# WebhookRegenerateApikeyV1Request + +Request for POST /1/object/webhook/{pkiWebhookID}/regenerateApikey + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**b_webhook_issigned** | **bool** | Whether the requests will be signed or not | [optional] + +## Example + +```python +from eZmaxApi.models.webhook_regenerate_apikey_v1_request import WebhookRegenerateApikeyV1Request + +# TODO update the JSON string below +json = "{}" +# create an instance of WebhookRegenerateApikeyV1Request from a JSON string +webhook_regenerate_apikey_v1_request_instance = WebhookRegenerateApikeyV1Request.from_json(json) +# print the JSON string representation of the object +print WebhookRegenerateApikeyV1Request.to_json() + +# convert the object into a dict +webhook_regenerate_apikey_v1_request_dict = webhook_regenerate_apikey_v1_request_instance.to_dict() +# create an instance of WebhookRegenerateApikeyV1Request from a dict +webhook_regenerate_apikey_v1_request_form_dict = webhook_regenerate_apikey_v1_request.from_dict(webhook_regenerate_apikey_v1_request_dict) +``` +[[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/docs/WebhookRegenerateApikeyV1Response.md b/docs/WebhookRegenerateApikeyV1Response.md new file mode 100644 index 000000000..69d0451ab --- /dev/null +++ b/docs/WebhookRegenerateApikeyV1Response.md @@ -0,0 +1,32 @@ +# WebhookRegenerateApikeyV1Response + +Response for POST /1/object/webhook/{pkiWebhookID}/regenerateApikey + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | +**obj_debug** | [**CommonResponseObjDebug**](CommonResponseObjDebug.md) | | [optional] +**m_payload** | [**WebhookRegenerateApikeyV1ResponseMPayload**](WebhookRegenerateApikeyV1ResponseMPayload.md) | | + +## Example + +```python +from eZmaxApi.models.webhook_regenerate_apikey_v1_response import WebhookRegenerateApikeyV1Response + +# TODO update the JSON string below +json = "{}" +# create an instance of WebhookRegenerateApikeyV1Response from a JSON string +webhook_regenerate_apikey_v1_response_instance = WebhookRegenerateApikeyV1Response.from_json(json) +# print the JSON string representation of the object +print WebhookRegenerateApikeyV1Response.to_json() + +# convert the object into a dict +webhook_regenerate_apikey_v1_response_dict = webhook_regenerate_apikey_v1_response_instance.to_dict() +# create an instance of WebhookRegenerateApikeyV1Response from a dict +webhook_regenerate_apikey_v1_response_form_dict = webhook_regenerate_apikey_v1_response.from_dict(webhook_regenerate_apikey_v1_response_dict) +``` +[[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/docs/WebhookRegenerateApikeyV1ResponseMPayload.md b/docs/WebhookRegenerateApikeyV1ResponseMPayload.md new file mode 100644 index 000000000..c8f833961 --- /dev/null +++ b/docs/WebhookRegenerateApikeyV1ResponseMPayload.md @@ -0,0 +1,30 @@ +# WebhookRegenerateApikeyV1ResponseMPayload + +Response for POST /1/object/webhook/{pkiWebhookID}/regenerateApikey + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**obj_webhook** | [**WebhookResponseCompound**](WebhookResponseCompound.md) | | + +## Example + +```python +from eZmaxApi.models.webhook_regenerate_apikey_v1_response_m_payload import WebhookRegenerateApikeyV1ResponseMPayload + +# TODO update the JSON string below +json = "{}" +# create an instance of WebhookRegenerateApikeyV1ResponseMPayload from a JSON string +webhook_regenerate_apikey_v1_response_m_payload_instance = WebhookRegenerateApikeyV1ResponseMPayload.from_json(json) +# print the JSON string representation of the object +print WebhookRegenerateApikeyV1ResponseMPayload.to_json() + +# convert the object into a dict +webhook_regenerate_apikey_v1_response_m_payload_dict = webhook_regenerate_apikey_v1_response_m_payload_instance.to_dict() +# create an instance of WebhookRegenerateApikeyV1ResponseMPayload from a dict +webhook_regenerate_apikey_v1_response_m_payload_form_dict = webhook_regenerate_apikey_v1_response_m_payload.from_dict(webhook_regenerate_apikey_v1_response_m_payload_dict) +``` +[[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/docs/WebhookRequest.md b/docs/WebhookRequest.md index 6e614d7fa..37b900b96 100644 --- a/docs/WebhookRequest.md +++ b/docs/WebhookRequest.md @@ -3,6 +3,7 @@ A Webhook Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_webhook_id** | **int** | The unique ID of the Webhook | [optional] @@ -14,6 +15,7 @@ Name | Type | Description | Notes **s_webhook_url** | **str** | The URL of the Webhook callback | **s_webhook_emailfailed** | **str** | The email that will receive the Webhook in case all attempts fail | **b_webhook_isactive** | **bool** | Whether the Webhook is active or not | +**b_webhook_issigned** | **bool** | Whether the requests will be signed or not | [optional] **b_webhook_skipsslvalidation** | **bool** | Wheter the server's SSL certificate should be validated or not. Not recommended to skip for production use | ## Example diff --git a/docs/WebhookRequestCompound.md b/docs/WebhookRequestCompound.md index c54b6b761..2a27e43ec 100644 --- a/docs/WebhookRequestCompound.md +++ b/docs/WebhookRequestCompound.md @@ -3,6 +3,7 @@ A Webhook Object and children ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_webhook_id** | **int** | The unique ID of the Webhook | [optional] @@ -14,6 +15,7 @@ Name | Type | Description | Notes **s_webhook_url** | **str** | The URL of the Webhook callback | **s_webhook_emailfailed** | **str** | The email that will receive the Webhook in case all attempts fail | **b_webhook_isactive** | **bool** | Whether the Webhook is active or not | +**b_webhook_issigned** | **bool** | Whether the requests will be signed or not | [optional] **b_webhook_skipsslvalidation** | **bool** | Wheter the server's SSL certificate should be validated or not. Not recommended to skip for production use | ## Example diff --git a/docs/WebhookResponse.md b/docs/WebhookResponse.md index cdd1c7808..7a2b11279 100644 --- a/docs/WebhookResponse.md +++ b/docs/WebhookResponse.md @@ -3,6 +3,7 @@ A webhook object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_webhook_id** | **int** | The unique ID of the Webhook | @@ -14,7 +15,10 @@ Name | Type | Description | Notes **e_webhook_managementevent** | [**FieldEWebhookManagementevent**](FieldEWebhookManagementevent.md) | | [optional] **s_webhook_url** | **str** | The URL of the Webhook callback | **s_webhook_emailfailed** | **str** | The email that will receive the Webhook in case all attempts fail | +**s_webhook_apikey** | **str** | The Apikey for the Webhook. This will be hidden if we are not creating or regenerating the Apikey. | [optional] +**s_webhook_secret** | **str** | The Secret for the Webhook. This will be hidden if we are not creating or regenerating the Apikey. | [optional] **b_webhook_isactive** | **bool** | Whether the Webhook is active or not | +**b_webhook_issigned** | **bool** | Whether the requests will be signed or not | **b_webhook_skipsslvalidation** | **bool** | Wheter the server's SSL certificate should be validated or not. Not recommended to skip for production use | ## Example diff --git a/docs/WebhookResponseCompound.md b/docs/WebhookResponseCompound.md index ff3e1be47..b8780118b 100644 --- a/docs/WebhookResponseCompound.md +++ b/docs/WebhookResponseCompound.md @@ -3,6 +3,7 @@ A Webhook Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_webhook_id** | **int** | The unique ID of the Webhook | @@ -14,7 +15,10 @@ Name | Type | Description | Notes **e_webhook_managementevent** | [**FieldEWebhookManagementevent**](FieldEWebhookManagementevent.md) | | [optional] **s_webhook_url** | **str** | The URL of the Webhook callback | **s_webhook_emailfailed** | **str** | The email that will receive the Webhook in case all attempts fail | +**s_webhook_apikey** | **str** | The Apikey for the Webhook. This will be hidden if we are not creating or regenerating the Apikey. | [optional] +**s_webhook_secret** | **str** | The Secret for the Webhook. This will be hidden if we are not creating or regenerating the Apikey. | [optional] **b_webhook_isactive** | **bool** | Whether the Webhook is active or not | +**b_webhook_issigned** | **bool** | Whether the requests will be signed or not | **b_webhook_skipsslvalidation** | **bool** | Wheter the server's SSL certificate should be validated or not. Not recommended to skip for production use | **s_webhook_event** | **str** | The concatenated string to describe the Webhook event | [optional] diff --git a/docs/WebhookTestV1Response.md b/docs/WebhookTestV1Response.md index 71bb46ae9..3ec831921 100644 --- a/docs/WebhookTestV1Response.md +++ b/docs/WebhookTestV1Response.md @@ -3,6 +3,7 @@ Response for POST /1/object/webhook/{pkiWebhookID}/test ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | diff --git a/docs/WebhookUserUserCreated.md b/docs/WebhookUserUserCreated.md index 44158f90d..74fc2f1aa 100644 --- a/docs/WebhookUserUserCreated.md +++ b/docs/WebhookUserUserCreated.md @@ -3,6 +3,7 @@ This is the base Webhook object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_webhook** | [**CustomWebhookResponse**](CustomWebhookResponse.md) | | diff --git a/docs/WebhookUserstagedUserstagedCreated.md b/docs/WebhookUserstagedUserstagedCreated.md index 0604d52a4..f0cce02f7 100644 --- a/docs/WebhookUserstagedUserstagedCreated.md +++ b/docs/WebhookUserstagedUserstagedCreated.md @@ -3,6 +3,7 @@ This is the base Webhook object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_webhook** | [**CustomWebhookResponse**](CustomWebhookResponse.md) | | diff --git a/docs/WebsiteRequest.md b/docs/WebsiteRequest.md index ca05fd0c4..459f037ae 100644 --- a/docs/WebsiteRequest.md +++ b/docs/WebsiteRequest.md @@ -3,6 +3,7 @@ A Website Object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **fki_websitetype_id** | **int** | The unique ID of the Websitetype. Valid values: |Value|Description| |-|-| |1|Website| |2|Twitter| |3|Facebook| |4|Survey| | diff --git a/docs/WebsiteRequestCompound.md b/docs/WebsiteRequestCompound.md index d94c1cce3..7b821be87 100644 --- a/docs/WebsiteRequestCompound.md +++ b/docs/WebsiteRequestCompound.md @@ -3,6 +3,7 @@ A Website Object and children to create a complete structure ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **fki_websitetype_id** | **int** | The unique ID of the Websitetype. Valid values: |Value|Description| |-|-| |1|Website| |2|Twitter| |3|Facebook| |4|Survey| | diff --git a/docs/WebsocketRequestServerGetWebsocketIDV1.md b/docs/WebsocketRequestServerGetWebsocketIDV1.md index a3b4efdda..1502235ff 100644 --- a/docs/WebsocketRequestServerGetWebsocketIDV1.md +++ b/docs/WebsocketRequestServerGetWebsocketIDV1.md @@ -3,6 +3,7 @@ Request for Websocket GetWebsocketID V1 ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **e_websocket_messagetype** | **str** | The Type of message | diff --git a/docs/WebsocketResponseErrorV1.md b/docs/WebsocketResponseErrorV1.md index f6a3ff2c2..d6f0b1838 100644 --- a/docs/WebsocketResponseErrorV1.md +++ b/docs/WebsocketResponseErrorV1.md @@ -3,9 +3,11 @@ Response for Websocket Error V1 ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **e_websocket_messagetype** | **str** | The Type of message | +**s_websocket_channel** | **str** | The Channel on which to route the websocket message | **m_payload** | [**WebsocketResponseErrorV1MPayload**](WebsocketResponseErrorV1MPayload.md) | | ## Example diff --git a/docs/WebsocketResponseErrorV1MPayload.md b/docs/WebsocketResponseErrorV1MPayload.md index 53a0e3f7a..83dbd0bd3 100644 --- a/docs/WebsocketResponseErrorV1MPayload.md +++ b/docs/WebsocketResponseErrorV1MPayload.md @@ -3,6 +3,7 @@ Payload for Websocket Error V1 ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **s_error_message** | **str** | The message giving details about the error | diff --git a/docs/WebsocketResponseGetWebsocketIDV1.md b/docs/WebsocketResponseGetWebsocketIDV1.md index 637c5e2cd..81b1ac063 100644 --- a/docs/WebsocketResponseGetWebsocketIDV1.md +++ b/docs/WebsocketResponseGetWebsocketIDV1.md @@ -3,6 +3,7 @@ Response for Websocket GetWebsocketID V1 ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **e_websocket_messagetype** | **str** | The Type of message | diff --git a/docs/WebsocketResponseGetWebsocketIDV1MPayload.md b/docs/WebsocketResponseGetWebsocketIDV1MPayload.md index c30520537..a1fce34db 100644 --- a/docs/WebsocketResponseGetWebsocketIDV1MPayload.md +++ b/docs/WebsocketResponseGetWebsocketIDV1MPayload.md @@ -3,6 +3,7 @@ Payload for Websocket GetWebsocketID V1 ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **s_websocket_id** | **str** | The Unique ID of the Websocket Connection | diff --git a/docs/WebsocketResponseInformationV1.md b/docs/WebsocketResponseInformationV1.md index 2010572ac..94c5d405e 100644 --- a/docs/WebsocketResponseInformationV1.md +++ b/docs/WebsocketResponseInformationV1.md @@ -3,9 +3,11 @@ Response for Websocket Information V1 ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **e_websocket_messagetype** | **str** | The Type of message | +**s_websocket_channel** | **str** | The Channel on which to route the websocket message | **m_payload** | [**WebsocketResponseInformationV1MPayload**](WebsocketResponseInformationV1MPayload.md) | | ## Example diff --git a/docs/WebsocketResponseInformationV1MPayload.md b/docs/WebsocketResponseInformationV1MPayload.md index 5a3bf8e1d..0b95edd7b 100644 --- a/docs/WebsocketResponseInformationV1MPayload.md +++ b/docs/WebsocketResponseInformationV1MPayload.md @@ -3,6 +3,7 @@ Payload for Websocket Information V1 ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **s_information_message** | **str** | Information message | diff --git a/eZmaxApi/__init__.py b/eZmaxApi/__init__.py index e2f885f5d..0a7195c47 100644 --- a/eZmaxApi/__init__.py +++ b/eZmaxApi/__init__.py @@ -53,6 +53,7 @@ from eZmaxApi.api.object_ezsignsignature_api import ObjectEzsignsignatureApi from eZmaxApi.api.object_ezsignsignergroup_api import ObjectEzsignsignergroupApi from eZmaxApi.api.object_ezsignsignergroupmembership_api import ObjectEzsignsignergroupmembershipApi +from eZmaxApi.api.object_ezsignsigningreason_api import ObjectEzsignsigningreasonApi from eZmaxApi.api.object_ezsigntemplate_api import ObjectEzsigntemplateApi from eZmaxApi.api.object_ezsigntemplatedocument_api import ObjectEzsigntemplatedocumentApi from eZmaxApi.api.object_ezsigntemplateformfieldgroup_api import ObjectEzsigntemplateformfieldgroupApi @@ -150,7 +151,14 @@ from eZmaxApi.models.apikey_request_compound import ApikeyRequestCompound from eZmaxApi.models.apikey_response import ApikeyResponse from eZmaxApi.models.apikey_response_compound import ApikeyResponseCompound -from eZmaxApi.models.attachment_download_v1_response import AttachmentDownloadV1Response +from eZmaxApi.models.attachment_get_attachmentlogs_v1_response import AttachmentGetAttachmentlogsV1Response +from eZmaxApi.models.attachment_get_attachmentlogs_v1_response_m_payload import AttachmentGetAttachmentlogsV1ResponseMPayload +from eZmaxApi.models.attachment_get_download_url_v1_response import AttachmentGetDownloadUrlV1Response +from eZmaxApi.models.attachment_get_download_url_v1_response_m_payload import AttachmentGetDownloadUrlV1ResponseMPayload +from eZmaxApi.models.attachment_response import AttachmentResponse +from eZmaxApi.models.attachment_response_compound import AttachmentResponseCompound +from eZmaxApi.models.attachmentlog_response import AttachmentlogResponse +from eZmaxApi.models.attachmentlog_response_compound import AttachmentlogResponseCompound from eZmaxApi.models.attempt_response import AttemptResponse from eZmaxApi.models.attempt_response_compound import AttemptResponseCompound from eZmaxApi.models.billingentityexternal_autocomplete_element_response import BillingentityexternalAutocompleteElementResponse @@ -263,6 +271,8 @@ from eZmaxApi.models.cors_request_compound import CorsRequestCompound from eZmaxApi.models.cors_response import CorsResponse from eZmaxApi.models.cors_response_compound import CorsResponseCompound +from eZmaxApi.models.custom_attachment_response import CustomAttachmentResponse +from eZmaxApi.models.custom_attachmentdocumenttype_response import CustomAttachmentdocumenttypeResponse from eZmaxApi.models.custom_autocomplete_element_response import CustomAutocompleteElementResponse from eZmaxApi.models.custom_communication_list_element_response import CustomCommunicationListElementResponse from eZmaxApi.models.custom_communicationattachment_request import CustomCommunicationattachmentRequest @@ -436,6 +446,8 @@ from eZmaxApi.models.ezsigndocument_flatten_v1_response import EzsigndocumentFlattenV1Response from eZmaxApi.models.ezsigndocument_get_actionable_elements_v1_response import EzsigndocumentGetActionableElementsV1Response from eZmaxApi.models.ezsigndocument_get_actionable_elements_v1_response_m_payload import EzsigndocumentGetActionableElementsV1ResponseMPayload +from eZmaxApi.models.ezsigndocument_get_attachments_v1_response import EzsigndocumentGetAttachmentsV1Response +from eZmaxApi.models.ezsigndocument_get_attachments_v1_response_m_payload import EzsigndocumentGetAttachmentsV1ResponseMPayload from eZmaxApi.models.ezsigndocument_get_completed_elements_v1_response import EzsigndocumentGetCompletedElementsV1Response from eZmaxApi.models.ezsigndocument_get_completed_elements_v1_response_m_payload import EzsigndocumentGetCompletedElementsV1ResponseMPayload from eZmaxApi.models.ezsigndocument_get_download_url_v1_response import EzsigndocumentGetDownloadUrlV1Response @@ -492,6 +504,10 @@ from eZmaxApi.models.ezsignfolder_edit_object_v1_response import EzsignfolderEditObjectV1Response from eZmaxApi.models.ezsignfolder_get_actionable_elements_v1_response import EzsignfolderGetActionableElementsV1Response from eZmaxApi.models.ezsignfolder_get_actionable_elements_v1_response_m_payload import EzsignfolderGetActionableElementsV1ResponseMPayload +from eZmaxApi.models.ezsignfolder_get_attachment_count_v1_response import EzsignfolderGetAttachmentCountV1Response +from eZmaxApi.models.ezsignfolder_get_attachment_count_v1_response_m_payload import EzsignfolderGetAttachmentCountV1ResponseMPayload +from eZmaxApi.models.ezsignfolder_get_attachments_v1_response import EzsignfolderGetAttachmentsV1Response +from eZmaxApi.models.ezsignfolder_get_attachments_v1_response_m_payload import EzsignfolderGetAttachmentsV1ResponseMPayload from eZmaxApi.models.ezsignfolder_get_communication_count_v1_response import EzsignfolderGetCommunicationCountV1Response from eZmaxApi.models.ezsignfolder_get_communication_count_v1_response_m_payload import EzsignfolderGetCommunicationCountV1ResponseMPayload from eZmaxApi.models.ezsignfolder_get_communication_list_v1_response import EzsignfolderGetCommunicationListV1Response @@ -657,6 +673,23 @@ from eZmaxApi.models.ezsignsignergroupmembership_request_compound import EzsignsignergroupmembershipRequestCompound from eZmaxApi.models.ezsignsignergroupmembership_response import EzsignsignergroupmembershipResponse from eZmaxApi.models.ezsignsignergroupmembership_response_compound import EzsignsignergroupmembershipResponseCompound +from eZmaxApi.models.ezsignsigningreason_autocomplete_element_response import EzsignsigningreasonAutocompleteElementResponse +from eZmaxApi.models.ezsignsigningreason_create_object_v1_request import EzsignsigningreasonCreateObjectV1Request +from eZmaxApi.models.ezsignsigningreason_create_object_v1_response import EzsignsigningreasonCreateObjectV1Response +from eZmaxApi.models.ezsignsigningreason_create_object_v1_response_m_payload import EzsignsigningreasonCreateObjectV1ResponseMPayload +from eZmaxApi.models.ezsignsigningreason_edit_object_v1_request import EzsignsigningreasonEditObjectV1Request +from eZmaxApi.models.ezsignsigningreason_edit_object_v1_response import EzsignsigningreasonEditObjectV1Response +from eZmaxApi.models.ezsignsigningreason_get_autocomplete_v2_response import EzsignsigningreasonGetAutocompleteV2Response +from eZmaxApi.models.ezsignsigningreason_get_autocomplete_v2_response_m_payload import EzsignsigningreasonGetAutocompleteV2ResponseMPayload +from eZmaxApi.models.ezsignsigningreason_get_list_v1_response import EzsignsigningreasonGetListV1Response +from eZmaxApi.models.ezsignsigningreason_get_list_v1_response_m_payload import EzsignsigningreasonGetListV1ResponseMPayload +from eZmaxApi.models.ezsignsigningreason_get_object_v2_response import EzsignsigningreasonGetObjectV2Response +from eZmaxApi.models.ezsignsigningreason_get_object_v2_response_m_payload import EzsignsigningreasonGetObjectV2ResponseMPayload +from eZmaxApi.models.ezsignsigningreason_list_element import EzsignsigningreasonListElement +from eZmaxApi.models.ezsignsigningreason_request import EzsignsigningreasonRequest +from eZmaxApi.models.ezsignsigningreason_request_compound import EzsignsigningreasonRequestCompound +from eZmaxApi.models.ezsignsigningreason_response import EzsignsigningreasonResponse +from eZmaxApi.models.ezsignsigningreason_response_compound import EzsignsigningreasonResponseCompound from eZmaxApi.models.ezsigntemplate_autocomplete_element_response import EzsigntemplateAutocompleteElementResponse from eZmaxApi.models.ezsigntemplate_copy_v1_request import EzsigntemplateCopyV1Request from eZmaxApi.models.ezsigntemplate_copy_v1_response import EzsigntemplateCopyV1Response @@ -824,6 +857,11 @@ from eZmaxApi.models.field_e_activesession_origin import FieldEActivesessionOrigin from eZmaxApi.models.field_e_activesession_usertype import FieldEActivesessionUsertype from eZmaxApi.models.field_e_activesession_weekdaystart import FieldEActivesessionWeekdaystart +from eZmaxApi.models.field_e_attachment_documenttype import FieldEAttachmentDocumenttype +from eZmaxApi.models.field_e_attachment_privacy import FieldEAttachmentPrivacy +from eZmaxApi.models.field_e_attachment_type import FieldEAttachmentType +from eZmaxApi.models.field_e_attachment_verified import FieldEAttachmentVerified +from eZmaxApi.models.field_e_attachmentlog_type import FieldEAttachmentlogType from eZmaxApi.models.field_e_branding_logo import FieldEBrandingLogo from eZmaxApi.models.field_e_communication_importance import FieldECommunicationImportance from eZmaxApi.models.field_e_communication_type import FieldECommunicationType @@ -875,6 +913,7 @@ from eZmaxApi.models.field_e_systemconfiguration_language2 import FieldESystemconfigurationLanguage2 from eZmaxApi.models.field_e_systemconfiguration_newexternaluseraction import FieldESystemconfigurationNewexternaluseraction from eZmaxApi.models.field_e_user_ezsignaccess import FieldEUserEzsignaccess +from eZmaxApi.models.field_e_user_ezsignprepaid import FieldEUserEzsignprepaid from eZmaxApi.models.field_e_user_ezsignsendreminderfrequency import FieldEUserEzsignsendreminderfrequency from eZmaxApi.models.field_e_user_logintype import FieldEUserLogintype from eZmaxApi.models.field_e_user_origin import FieldEUserOrigin @@ -907,12 +946,18 @@ from eZmaxApi.models.global_ezmaxclient_version_v1_response import GlobalEzmaxclientVersionV1Response from eZmaxApi.models.global_ezmaxcustomer_get_configuration_v1_response import GlobalEzmaxcustomerGetConfigurationV1Response from eZmaxApi.models.header_accept_language import HeaderAcceptLanguage +from eZmaxApi.models.inscription_get_attachments_v1_response import InscriptionGetAttachmentsV1Response +from eZmaxApi.models.inscription_get_attachments_v1_response_m_payload import InscriptionGetAttachmentsV1ResponseMPayload from eZmaxApi.models.inscription_get_communication_list_v1_response import InscriptionGetCommunicationListV1Response from eZmaxApi.models.inscription_get_communication_list_v1_response_m_payload import InscriptionGetCommunicationListV1ResponseMPayload +from eZmaxApi.models.inscription_get_communicationsenders_v1_response import InscriptionGetCommunicationsendersV1Response +from eZmaxApi.models.inscription_get_communicationsenders_v1_response_m_payload import InscriptionGetCommunicationsendersV1ResponseMPayload from eZmaxApi.models.inscriptionnotauthenticated_get_communication_list_v1_response import InscriptionnotauthenticatedGetCommunicationListV1Response from eZmaxApi.models.inscriptionnotauthenticated_get_communication_list_v1_response_m_payload import InscriptionnotauthenticatedGetCommunicationListV1ResponseMPayload from eZmaxApi.models.inscriptiontemp_get_communication_list_v1_response import InscriptiontempGetCommunicationListV1Response from eZmaxApi.models.inscriptiontemp_get_communication_list_v1_response_m_payload import InscriptiontempGetCommunicationListV1ResponseMPayload +from eZmaxApi.models.invoice_get_attachments_v1_response import InvoiceGetAttachmentsV1Response +from eZmaxApi.models.invoice_get_attachments_v1_response_m_payload import InvoiceGetAttachmentsV1ResponseMPayload from eZmaxApi.models.invoice_get_communication_list_v1_response import InvoiceGetCommunicationListV1Response from eZmaxApi.models.invoice_get_communication_list_v1_response_m_payload import InvoiceGetCommunicationListV1ResponseMPayload from eZmaxApi.models.language_autocomplete_element_response import LanguageAutocompleteElementResponse @@ -932,6 +977,7 @@ from eZmaxApi.models.multilingual_ezmaxinvoicingsummaryinternal_description import MultilingualEzmaxinvoicingsummaryinternalDescription from eZmaxApi.models.multilingual_ezsignfoldertype_name import MultilingualEzsignfoldertypeName from eZmaxApi.models.multilingual_ezsignsignergroup_description import MultilingualEzsignsignergroupDescription +from eZmaxApi.models.multilingual_ezsignsigningreason_description import MultilingualEzsignsigningreasonDescription from eZmaxApi.models.multilingual_notificationsubsection_name import MultilingualNotificationsubsectionName from eZmaxApi.models.multilingual_notificationtest_name import MultilingualNotificationtestName from eZmaxApi.models.multilingual_paymentterm_description import MultilingualPaymenttermDescription @@ -1174,6 +1220,9 @@ from eZmaxApi.models.webhook_create_object_v1_request import WebhookCreateObjectV1Request from eZmaxApi.models.webhook_create_object_v1_response import WebhookCreateObjectV1Response from eZmaxApi.models.webhook_create_object_v1_response_m_payload import WebhookCreateObjectV1ResponseMPayload +from eZmaxApi.models.webhook_create_object_v2_request import WebhookCreateObjectV2Request +from eZmaxApi.models.webhook_create_object_v2_response import WebhookCreateObjectV2Response +from eZmaxApi.models.webhook_create_object_v2_response_m_payload import WebhookCreateObjectV2ResponseMPayload from eZmaxApi.models.webhook_delete_object_v1_response import WebhookDeleteObjectV1Response from eZmaxApi.models.webhook_edit_object_v1_request import WebhookEditObjectV1Request from eZmaxApi.models.webhook_edit_object_v1_response import WebhookEditObjectV1Response @@ -1188,6 +1237,9 @@ from eZmaxApi.models.webhook_get_object_v2_response import WebhookGetObjectV2Response from eZmaxApi.models.webhook_get_object_v2_response_m_payload import WebhookGetObjectV2ResponseMPayload from eZmaxApi.models.webhook_list_element import WebhookListElement +from eZmaxApi.models.webhook_regenerate_apikey_v1_request import WebhookRegenerateApikeyV1Request +from eZmaxApi.models.webhook_regenerate_apikey_v1_response import WebhookRegenerateApikeyV1Response +from eZmaxApi.models.webhook_regenerate_apikey_v1_response_m_payload import WebhookRegenerateApikeyV1ResponseMPayload from eZmaxApi.models.webhook_request import WebhookRequest from eZmaxApi.models.webhook_request_compound import WebhookRequestCompound from eZmaxApi.models.webhook_response import WebhookResponse diff --git a/eZmaxApi/api/__init__.py b/eZmaxApi/api/__init__.py index 982bb0da9..35d4ebdc7 100644 --- a/eZmaxApi/api/__init__.py +++ b/eZmaxApi/api/__init__.py @@ -36,6 +36,7 @@ from eZmaxApi.api.object_ezsignsignature_api import ObjectEzsignsignatureApi from eZmaxApi.api.object_ezsignsignergroup_api import ObjectEzsignsignergroupApi from eZmaxApi.api.object_ezsignsignergroupmembership_api import ObjectEzsignsignergroupmembershipApi +from eZmaxApi.api.object_ezsignsigningreason_api import ObjectEzsignsigningreasonApi from eZmaxApi.api.object_ezsigntemplate_api import ObjectEzsigntemplateApi from eZmaxApi.api.object_ezsigntemplatedocument_api import ObjectEzsigntemplatedocumentApi from eZmaxApi.api.object_ezsigntemplateformfieldgroup_api import ObjectEzsigntemplateformfieldgroupApi diff --git a/eZmaxApi/api/global_customer_api.py b/eZmaxApi/api/global_customer_api.py index dea579b02..2e8c01466 100644 --- a/eZmaxApi/api/global_customer_api.py +++ b/eZmaxApi/api/global_customer_api.py @@ -13,14 +13,20 @@ """ # noqa: E501 -import re # noqa: F401 import io import warnings -from pydantic import validate_arguments, ValidationError +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Dict, List, Optional, Tuple, Union, Any +try: + from typing import Annotated +except ImportError: + from typing_extensions import Annotated + +from pydantic import Field from typing_extensions import Annotated -from pydantic import Field, StrictStr, constr +from pydantic import StrictStr, field_validator from typing import Optional @@ -28,10 +34,7 @@ from eZmaxApi.api_client import ApiClient from eZmaxApi.api_response import ApiResponse -from eZmaxApi.exceptions import ( # noqa: F401 - ApiTypeError, - ApiValueError -) +from eZmaxApi.rest import RESTResponseType class GlobalCustomerApi: @@ -46,153 +49,282 @@ def __init__(self, api_client=None) -> None: api_client = ApiClient.get_default() self.api_client = api_client - @validate_arguments - def global_customer_get_endpoint_v1(self, pks_customer_code : constr(strict=True, max_length=6, min_length=2), s_infrastructureproduct_code : Annotated[Optional[StrictStr], Field(description="The infrastructure product Code If undefined, \"appcluster01\" is assumed")] = None, **kwargs) -> GlobalCustomerGetEndpointV1Response: # noqa: E501 - """(Deprecated) Get customer endpoint # noqa: E501 - Retrieve the customer's specific server endpoint where to send requests. This will help locate the proper region (ie: sInfrastructureregionCode) and the proper environment (ie: sInfrastructureenvironmenttypeDescription) where the customer's data is stored. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def global_customer_get_endpoint_v1( + self, + pks_customer_code: Annotated[str, Field(min_length=2, strict=True, max_length=6)], + s_infrastructureproduct_code: Annotated[Optional[StrictStr], Field(description="The infrastructure product Code If undefined, \"appcluster01\" is assumed")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> GlobalCustomerGetEndpointV1Response: + """(Deprecated) Get customer endpoint - >>> thread = api.global_customer_get_endpoint_v1(pks_customer_code, s_infrastructureproduct_code, async_req=True) - >>> result = thread.get() + Retrieve the customer's specific server endpoint where to send requests. This will help locate the proper region (ie: sInfrastructureregionCode) and the proper environment (ie: sInfrastructureenvironmenttypeDescription) where the customer's data is stored. :param pks_customer_code: (required) :type pks_customer_code: str :param s_infrastructureproduct_code: The infrastructure product Code If undefined, \"appcluster01\" is assumed :type s_infrastructureproduct_code: str - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: GlobalCustomerGetEndpointV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the global_customer_get_endpoint_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.global_customer_get_endpoint_v1_with_http_info(pks_customer_code, s_infrastructureproduct_code, **kwargs) # noqa: E501 - - @validate_arguments - def global_customer_get_endpoint_v1_with_http_info(self, pks_customer_code : constr(strict=True, max_length=6, min_length=2), s_infrastructureproduct_code : Annotated[Optional[StrictStr], Field(description="The infrastructure product Code If undefined, \"appcluster01\" is assumed")] = None, **kwargs) -> ApiResponse: # noqa: E501 - """(Deprecated) Get customer endpoint # noqa: E501 - - Retrieve the customer's specific server endpoint where to send requests. This will help locate the proper region (ie: sInfrastructureregionCode) and the proper environment (ie: sInfrastructureenvironmenttypeDescription) where the customer's data is stored. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.global_customer_get_endpoint_v1_with_http_info(pks_customer_code, s_infrastructureproduct_code, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + warnings.warn("GET /1/customer/{pksCustomerCode}/endpoint is deprecated.", DeprecationWarning) + + _param = self._global_customer_get_endpoint_v1_serialize( + pks_customer_code=pks_customer_code, + s_infrastructureproduct_code=s_infrastructureproduct_code, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "GlobalCustomerGetEndpointV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def global_customer_get_endpoint_v1_with_http_info( + self, + pks_customer_code: Annotated[str, Field(min_length=2, strict=True, max_length=6)], + s_infrastructureproduct_code: Annotated[Optional[StrictStr], Field(description="The infrastructure product Code If undefined, \"appcluster01\" is assumed")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[GlobalCustomerGetEndpointV1Response]: + """(Deprecated) Get customer endpoint + + Retrieve the customer's specific server endpoint where to send requests. This will help locate the proper region (ie: sInfrastructureregionCode) and the proper environment (ie: sInfrastructureenvironmenttypeDescription) where the customer's data is stored. :param pks_customer_code: (required) :type pks_customer_code: str :param s_infrastructureproduct_code: The infrastructure product Code If undefined, \"appcluster01\" is assumed :type s_infrastructureproduct_code: str - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(GlobalCustomerGetEndpointV1Response, status_code(int), headers(HTTPHeaderDict)) - """ - + """ # noqa: E501 warnings.warn("GET /1/customer/{pksCustomerCode}/endpoint is deprecated.", DeprecationWarning) - _params = locals() + _param = self._global_customer_get_endpoint_v1_serialize( + pks_customer_code=pks_customer_code, + s_infrastructureproduct_code=s_infrastructureproduct_code, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _all_params = [ - 'pks_customer_code', - 's_infrastructureproduct_code' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + _response_types_map: Dict[str, Optional[str]] = { + '200': "GlobalCustomerGetEndpointV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def global_customer_get_endpoint_v1_without_preload_content( + self, + pks_customer_code: Annotated[str, Field(min_length=2, strict=True, max_length=6)], + s_infrastructureproduct_code: Annotated[Optional[StrictStr], Field(description="The infrastructure product Code If undefined, \"appcluster01\" is assumed")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """(Deprecated) Get customer endpoint + + Retrieve the customer's specific server endpoint where to send requests. This will help locate the proper region (ie: sInfrastructureregionCode) and the proper environment (ie: sInfrastructureenvironmenttypeDescription) where the customer's data is stored. + + :param pks_customer_code: (required) + :type pks_customer_code: str + :param s_infrastructureproduct_code: The infrastructure product Code If undefined, \"appcluster01\" is assumed + :type s_infrastructureproduct_code: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + warnings.warn("GET /1/customer/{pksCustomerCode}/endpoint is deprecated.", DeprecationWarning) + + _param = self._global_customer_get_endpoint_v1_serialize( + pks_customer_code=pks_customer_code, + s_infrastructureproduct_code=s_infrastructureproduct_code, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method global_customer_get_endpoint_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "GlobalCustomerGetEndpointV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pks_customer_code']: - _path_params['pksCustomerCode'] = _params['pks_customer_code'] + def _global_customer_get_endpoint_v1_serialize( + self, + pks_customer_code, + s_infrastructureproduct_code, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None - # process the query parameters - _query_params = [] - if _params.get('s_infrastructureproduct_code') is not None: # noqa: E501 - _query_params.append(('sInfrastructureproductCode', _params['s_infrastructureproduct_code'])) + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if pks_customer_code is not None: + _path_params['pksCustomerCode'] = pks_customer_code + # process the query parameters + if s_infrastructureproduct_code is not None: + + _query_params.append(('sInfrastructureproductCode', s_infrastructureproduct_code)) + # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = [] # noqa: E501 - _response_types_map = { - '200': "GlobalCustomerGetEndpointV1Response", - '404': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + ] - return self.api_client.call_api( - '/1/customer/{pksCustomerCode}/endpoint', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/1/customer/{pksCustomerCode}/endpoint', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/eZmaxApi/api/global_ezmaxclient_api.py b/eZmaxApi/api/global_ezmaxclient_api.py index 6cb3e83dd..598891110 100644 --- a/eZmaxApi/api/global_ezmaxclient_api.py +++ b/eZmaxApi/api/global_ezmaxclient_api.py @@ -13,21 +13,23 @@ """ # noqa: E501 -import re # noqa: F401 import io import warnings -from pydantic import validate_arguments, ValidationError +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Dict, List, Optional, Tuple, Union, Any + +try: + from typing import Annotated +except ImportError: + from typing_extensions import Annotated from eZmaxApi.models.field_pks_ezmaxclient_os import FieldPksEzmaxclientOs from eZmaxApi.models.global_ezmaxclient_version_v1_response import GlobalEzmaxclientVersionV1Response from eZmaxApi.api_client import ApiClient from eZmaxApi.api_response import ApiResponse -from eZmaxApi.exceptions import ( # noqa: F401 - ApiTypeError, - ApiValueError -) +from eZmaxApi.rest import RESTResponseType class GlobalEzmaxclientApi: @@ -42,143 +44,262 @@ def __init__(self, api_client=None) -> None: api_client = ApiClient.get_default() self.api_client = api_client - @validate_arguments - def global_ezmaxclient_version_v1(self, pks_ezmaxclient_os : FieldPksEzmaxclientOs, **kwargs) -> GlobalEzmaxclientVersionV1Response: # noqa: E501 - """Retrieve the latest version of the Ezmaxclient # noqa: E501 - Retrieve the latest version of the Ezmaxclient that is available on the store. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def global_ezmaxclient_version_v1( + self, + pks_ezmaxclient_os: FieldPksEzmaxclientOs, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> GlobalEzmaxclientVersionV1Response: + """Retrieve the latest version of the Ezmaxclient - >>> thread = api.global_ezmaxclient_version_v1(pks_ezmaxclient_os, async_req=True) - >>> result = thread.get() + Retrieve the latest version of the Ezmaxclient that is available on the store. :param pks_ezmaxclient_os: (required) :type pks_ezmaxclient_os: FieldPksEzmaxclientOs - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: GlobalEzmaxclientVersionV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the global_ezmaxclient_version_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.global_ezmaxclient_version_v1_with_http_info(pks_ezmaxclient_os, **kwargs) # noqa: E501 - - @validate_arguments - def global_ezmaxclient_version_v1_with_http_info(self, pks_ezmaxclient_os : FieldPksEzmaxclientOs, **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve the latest version of the Ezmaxclient # noqa: E501 - - Retrieve the latest version of the Ezmaxclient that is available on the store. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.global_ezmaxclient_version_v1_with_http_info(pks_ezmaxclient_os, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._global_ezmaxclient_version_v1_serialize( + pks_ezmaxclient_os=pks_ezmaxclient_os, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "GlobalEzmaxclientVersionV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def global_ezmaxclient_version_v1_with_http_info( + self, + pks_ezmaxclient_os: FieldPksEzmaxclientOs, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[GlobalEzmaxclientVersionV1Response]: + """Retrieve the latest version of the Ezmaxclient + + Retrieve the latest version of the Ezmaxclient that is available on the store. :param pks_ezmaxclient_os: (required) :type pks_ezmaxclient_os: FieldPksEzmaxclientOs - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(GlobalEzmaxclientVersionV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 - _params = locals() + _param = self._global_ezmaxclient_version_v1_serialize( + pks_ezmaxclient_os=pks_ezmaxclient_os, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _all_params = [ - 'pks_ezmaxclient_os' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + _response_types_map: Dict[str, Optional[str]] = { + '200': "GlobalEzmaxclientVersionV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def global_ezmaxclient_version_v1_without_preload_content( + self, + pks_ezmaxclient_os: FieldPksEzmaxclientOs, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve the latest version of the Ezmaxclient + + Retrieve the latest version of the Ezmaxclient that is available on the store. + + :param pks_ezmaxclient_os: (required) + :type pks_ezmaxclient_os: FieldPksEzmaxclientOs + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._global_ezmaxclient_version_v1_serialize( + pks_ezmaxclient_os=pks_ezmaxclient_os, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method global_ezmaxclient_version_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "GlobalEzmaxclientVersionV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pks_ezmaxclient_os']: - _path_params['pksEzmaxclientOs'] = _params['pks_ezmaxclient_os'] + def _global_ezmaxclient_version_v1_serialize( + self, + pks_ezmaxclient_os, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if pks_ezmaxclient_os is not None: + _path_params['pksEzmaxclientOs'] = pks_ezmaxclient_os.value # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = [] # noqa: E501 - _response_types_map = { - '200': "GlobalEzmaxclientVersionV1Response", - '404': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + ] - return self.api_client.call_api( - '/1/ezmaxclient/{pksEzmaxclientOs}/version', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/1/ezmaxclient/{pksEzmaxclientOs}/version', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/eZmaxApi/api/global_ezmaxcustomer_api.py b/eZmaxApi/api/global_ezmaxcustomer_api.py index 657c77afa..81130b5ba 100644 --- a/eZmaxApi/api/global_ezmaxcustomer_api.py +++ b/eZmaxApi/api/global_ezmaxcustomer_api.py @@ -13,22 +13,26 @@ """ # noqa: E501 -import re # noqa: F401 import io import warnings -from pydantic import validate_arguments, ValidationError +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Dict, List, Optional, Tuple, Union, Any -from pydantic import constr, validator +try: + from typing import Annotated +except ImportError: + from typing_extensions import Annotated + +from pydantic import Field +from typing_extensions import Annotated +from pydantic import field_validator from eZmaxApi.models.global_ezmaxcustomer_get_configuration_v1_response import GlobalEzmaxcustomerGetConfigurationV1Response from eZmaxApi.api_client import ApiClient from eZmaxApi.api_response import ApiResponse -from eZmaxApi.exceptions import ( # noqa: F401 - ApiTypeError, - ApiValueError -) +from eZmaxApi.rest import RESTResponseType class GlobalEzmaxcustomerApi: @@ -43,143 +47,262 @@ def __init__(self, api_client=None) -> None: api_client = ApiClient.get_default() self.api_client = api_client - @validate_arguments - def global_ezmaxcustomer_get_configuration_v1(self, pks_ezmaxcustomer_code : constr(strict=True, max_length=6, min_length=2), **kwargs) -> GlobalEzmaxcustomerGetConfigurationV1Response: # noqa: E501 - """Get ezmaxcustomer configuration # noqa: E501 - Retrieve the ezmaxcustomer's specific configuration. This will help locate the proper region (ie: sInfrastructureregionCode) and the proper environment (ie: sInfrastructureenvironmenttypeDescription) where the customer's data is stored. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def global_ezmaxcustomer_get_configuration_v1( + self, + pks_ezmaxcustomer_code: Annotated[str, Field(min_length=2, strict=True, max_length=6)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> GlobalEzmaxcustomerGetConfigurationV1Response: + """Get ezmaxcustomer configuration - >>> thread = api.global_ezmaxcustomer_get_configuration_v1(pks_ezmaxcustomer_code, async_req=True) - >>> result = thread.get() + Retrieve the ezmaxcustomer's specific configuration. This will help locate the proper region (ie: sInfrastructureregionCode) and the proper environment (ie: sInfrastructureenvironmenttypeDescription) where the customer's data is stored. :param pks_ezmaxcustomer_code: (required) :type pks_ezmaxcustomer_code: str - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: GlobalEzmaxcustomerGetConfigurationV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the global_ezmaxcustomer_get_configuration_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.global_ezmaxcustomer_get_configuration_v1_with_http_info(pks_ezmaxcustomer_code, **kwargs) # noqa: E501 - - @validate_arguments - def global_ezmaxcustomer_get_configuration_v1_with_http_info(self, pks_ezmaxcustomer_code : constr(strict=True, max_length=6, min_length=2), **kwargs) -> ApiResponse: # noqa: E501 - """Get ezmaxcustomer configuration # noqa: E501 - - Retrieve the ezmaxcustomer's specific configuration. This will help locate the proper region (ie: sInfrastructureregionCode) and the proper environment (ie: sInfrastructureenvironmenttypeDescription) where the customer's data is stored. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.global_ezmaxcustomer_get_configuration_v1_with_http_info(pks_ezmaxcustomer_code, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._global_ezmaxcustomer_get_configuration_v1_serialize( + pks_ezmaxcustomer_code=pks_ezmaxcustomer_code, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "GlobalEzmaxcustomerGetConfigurationV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def global_ezmaxcustomer_get_configuration_v1_with_http_info( + self, + pks_ezmaxcustomer_code: Annotated[str, Field(min_length=2, strict=True, max_length=6)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[GlobalEzmaxcustomerGetConfigurationV1Response]: + """Get ezmaxcustomer configuration + + Retrieve the ezmaxcustomer's specific configuration. This will help locate the proper region (ie: sInfrastructureregionCode) and the proper environment (ie: sInfrastructureenvironmenttypeDescription) where the customer's data is stored. :param pks_ezmaxcustomer_code: (required) :type pks_ezmaxcustomer_code: str - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(GlobalEzmaxcustomerGetConfigurationV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._global_ezmaxcustomer_get_configuration_v1_serialize( + pks_ezmaxcustomer_code=pks_ezmaxcustomer_code, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '200': "GlobalEzmaxcustomerGetConfigurationV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'pks_ezmaxcustomer_code' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def global_ezmaxcustomer_get_configuration_v1_without_preload_content( + self, + pks_ezmaxcustomer_code: Annotated[str, Field(min_length=2, strict=True, max_length=6)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get ezmaxcustomer configuration + + Retrieve the ezmaxcustomer's specific configuration. This will help locate the proper region (ie: sInfrastructureregionCode) and the proper environment (ie: sInfrastructureenvironmenttypeDescription) where the customer's data is stored. + + :param pks_ezmaxcustomer_code: (required) + :type pks_ezmaxcustomer_code: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._global_ezmaxcustomer_get_configuration_v1_serialize( + pks_ezmaxcustomer_code=pks_ezmaxcustomer_code, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "GlobalEzmaxcustomerGetConfigurationV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) + return response_data.response - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method global_ezmaxcustomer_get_configuration_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] - _collection_formats = {} + def _global_ezmaxcustomer_get_configuration_v1_serialize( + self, + pks_ezmaxcustomer_code, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: - # process the path parameters - _path_params = {} - if _params['pks_ezmaxcustomer_code']: - _path_params['pksEzmaxcustomerCode'] = _params['pks_ezmaxcustomer_code'] + _host = None + + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if pks_ezmaxcustomer_code is not None: + _path_params['pksEzmaxcustomerCode'] = pks_ezmaxcustomer_code # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = [] # noqa: E501 - _response_types_map = { - '200': "GlobalEzmaxcustomerGetConfigurationV1Response", - '404': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + ] - return self.api_client.call_api( - '/1/ezmaxcustomer/{pksEzmaxcustomerCode}/getConfiguration', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/1/ezmaxcustomer/{pksEzmaxcustomerCode}/getConfiguration', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/eZmaxApi/api/module_ezsign_api.py b/eZmaxApi/api/module_ezsign_api.py index 76ca6f880..58232f708 100644 --- a/eZmaxApi/api/module_ezsign_api.py +++ b/eZmaxApi/api/module_ezsign_api.py @@ -13,14 +13,19 @@ """ # noqa: E501 -import re # noqa: F401 import io import warnings -from pydantic import validate_arguments, ValidationError +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Dict, List, Optional, Tuple, Union, Any -from pydantic import conint +try: + from typing import Annotated +except ImportError: + from typing_extensions import Annotated +from pydantic import Field +from typing_extensions import Annotated from typing import Optional from eZmaxApi.models.ezsign_suggest_signers_v1_response import EzsignSuggestSignersV1Response @@ -28,10 +33,7 @@ from eZmaxApi.api_client import ApiClient from eZmaxApi.api_response import ApiResponse -from eZmaxApi.exceptions import ( # noqa: F401 - ApiTypeError, - ApiValueError -) +from eZmaxApi.rest import RESTResponseType class ModuleEzsignApi: @@ -46,274 +48,505 @@ def __init__(self, api_client=None) -> None: api_client = ApiClient.get_default() self.api_client = api_client - @validate_arguments - def ezsign_suggest_signers_v1(self, **kwargs) -> EzsignSuggestSignersV1Response: # noqa: E501 - """Suggest signers # noqa: E501 - Retrieve previously used Ezsignsigners and all users from the system # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def ezsign_suggest_signers_v1( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsignSuggestSignersV1Response: + """Suggest signers - >>> thread = api.ezsign_suggest_signers_v1(async_req=True) - >>> result = thread.get() + Retrieve previously used Ezsignsigners and all users from the system - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsignSuggestSignersV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsign_suggest_signers_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsign_suggest_signers_v1_with_http_info(**kwargs) # noqa: E501 - - @validate_arguments - def ezsign_suggest_signers_v1_with_http_info(self, **kwargs) -> ApiResponse: # noqa: E501 - """Suggest signers # noqa: E501 - - Retrieve previously used Ezsignsigners and all users from the system # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsign_suggest_signers_v1_with_http_info(async_req=True) - >>> result = thread.get() - - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional + """ # noqa: E501 + + _param = self._ezsign_suggest_signers_v1_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignSuggestSignersV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsign_suggest_signers_v1_with_http_info( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsignSuggestSignersV1Response]: + """Suggest signers + + Retrieve previously used Ezsignsigners and all users from the system + :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsignSuggestSignersV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 - _params = locals() + _param = self._ezsign_suggest_signers_v1_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _all_params = [ - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignSuggestSignersV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def ezsign_suggest_signers_v1_without_preload_content( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Suggest signers + + Retrieve previously used Ezsignsigners and all users from the system + + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsign_suggest_signers_v1_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsign_suggest_signers_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignSuggestSignersV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} + def _ezsign_suggest_signers_v1_serialize( + self, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "EzsignSuggestSignersV1Response", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/module/ezsign/suggestSigners', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/1/module/ezsign/suggestSigners', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + - @validate_arguments - def ezsign_suggest_templates_v1(self, fki_ezsignfoldertype_id : Optional[conint(strict=True, ge=0)] = None, **kwargs) -> EzsignSuggestTemplatesV1Response: # noqa: E501 - """Suggest templates # noqa: E501 - Retrieve Ezsigntemplates and Ezsigntemplatepackages that can be imported in a Ezsignfolder # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.ezsign_suggest_templates_v1(fki_ezsignfoldertype_id, async_req=True) - >>> result = thread.get() + @validate_call + def ezsign_suggest_templates_v1( + self, + fki_ezsignfoldertype_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsignSuggestTemplatesV1Response: + """Suggest templates + + Retrieve Ezsigntemplates and Ezsigntemplatepackages that can be imported in a Ezsignfolder :param fki_ezsignfoldertype_id: :type fki_ezsignfoldertype_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsignSuggestTemplatesV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsign_suggest_templates_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsign_suggest_templates_v1_with_http_info(fki_ezsignfoldertype_id, **kwargs) # noqa: E501 - - @validate_arguments - def ezsign_suggest_templates_v1_with_http_info(self, fki_ezsignfoldertype_id : Optional[conint(strict=True, ge=0)] = None, **kwargs) -> ApiResponse: # noqa: E501 - """Suggest templates # noqa: E501 - - Retrieve Ezsigntemplates and Ezsigntemplatepackages that can be imported in a Ezsignfolder # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsign_suggest_templates_v1_with_http_info(fki_ezsignfoldertype_id, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._ezsign_suggest_templates_v1_serialize( + fki_ezsignfoldertype_id=fki_ezsignfoldertype_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignSuggestTemplatesV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsign_suggest_templates_v1_with_http_info( + self, + fki_ezsignfoldertype_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsignSuggestTemplatesV1Response]: + """Suggest templates + + Retrieve Ezsigntemplates and Ezsigntemplatepackages that can be imported in a Ezsignfolder :param fki_ezsignfoldertype_id: :type fki_ezsignfoldertype_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsignSuggestTemplatesV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._ezsign_suggest_templates_v1_serialize( + fki_ezsignfoldertype_id=fki_ezsignfoldertype_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignSuggestTemplatesV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'fki_ezsignfoldertype_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def ezsign_suggest_templates_v1_without_preload_content( + self, + fki_ezsignfoldertype_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Suggest templates + + Retrieve Ezsigntemplates and Ezsigntemplatepackages that can be imported in a Ezsignfolder + + :param fki_ezsignfoldertype_id: + :type fki_ezsignfoldertype_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsign_suggest_templates_v1_serialize( + fki_ezsignfoldertype_id=fki_ezsignfoldertype_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsign_suggest_templates_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignSuggestTemplatesV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} + def _ezsign_suggest_templates_v1_serialize( + self, + fki_ezsignfoldertype_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: - # process the query parameters - _query_params = [] - if _params.get('fki_ezsignfoldertype_id') is not None: # noqa: E501 - _query_params.append(('fkiEzsignfoldertypeID', _params['fki_ezsignfoldertype_id'])) + _host = None + + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if fki_ezsignfoldertype_id is not None: + + _query_params.append(('fkiEzsignfoldertypeID', fki_ezsignfoldertype_id)) + # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "EzsignSuggestTemplatesV1Response", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/module/ezsign/suggestTemplates', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/1/module/ezsign/suggestTemplates', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/eZmaxApi/api/module_report_api.py b/eZmaxApi/api/module_report_api.py index 3ac14628e..d4de66e6c 100644 --- a/eZmaxApi/api/module_report_api.py +++ b/eZmaxApi/api/module_report_api.py @@ -13,22 +13,26 @@ """ # noqa: E501 -import re # noqa: F401 import io import warnings -from pydantic import validate_arguments, ValidationError +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Dict, List, Optional, Tuple, Union, Any -from pydantic import constr, validator +try: + from typing import Annotated +except ImportError: + from typing_extensions import Annotated + +from pydantic import Field +from typing_extensions import Annotated +from pydantic import field_validator from eZmaxApi.models.common_get_report_v1_response import CommonGetReportV1Response from eZmaxApi.api_client import ApiClient from eZmaxApi.api_response import ApiResponse -from eZmaxApi.exceptions import ( # noqa: F401 - ApiTypeError, - ApiValueError -) +from eZmaxApi.rest import RESTResponseType class ModuleReportApi: @@ -43,143 +47,268 @@ def __init__(self, api_client=None) -> None: api_client = ApiClient.get_default() self.api_client = api_client - @validate_arguments - def report_get_report_from_cache_v1(self, s_reportgroup_cache_id : constr(strict=True), **kwargs) -> CommonGetReportV1Response: # noqa: E501 - """Retrieve report from cache # noqa: E501 - Retrieve a report that was previously generated and cached # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def report_get_report_from_cache_v1( + self, + s_reportgroup_cache_id: Annotated[str, Field(strict=True)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> CommonGetReportV1Response: + """Retrieve report from cache - >>> thread = api.report_get_report_from_cache_v1(s_reportgroup_cache_id, async_req=True) - >>> result = thread.get() + Retrieve a report that was previously generated and cached :param s_reportgroup_cache_id: (required) :type s_reportgroup_cache_id: str - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: CommonGetReportV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the report_get_report_from_cache_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.report_get_report_from_cache_v1_with_http_info(s_reportgroup_cache_id, **kwargs) # noqa: E501 - - @validate_arguments - def report_get_report_from_cache_v1_with_http_info(self, s_reportgroup_cache_id : constr(strict=True), **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve report from cache # noqa: E501 - - Retrieve a report that was previously generated and cached # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.report_get_report_from_cache_v1_with_http_info(s_reportgroup_cache_id, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._report_get_report_from_cache_v1_serialize( + s_reportgroup_cache_id=s_reportgroup_cache_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "CommonGetReportV1Response", + '406': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def report_get_report_from_cache_v1_with_http_info( + self, + s_reportgroup_cache_id: Annotated[str, Field(strict=True)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[CommonGetReportV1Response]: + """Retrieve report from cache + + Retrieve a report that was previously generated and cached :param s_reportgroup_cache_id: (required) :type s_reportgroup_cache_id: str - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(CommonGetReportV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._report_get_report_from_cache_v1_serialize( + s_reportgroup_cache_id=s_reportgroup_cache_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '200': "CommonGetReportV1Response", + '406': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 's_reportgroup_cache_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def report_get_report_from_cache_v1_without_preload_content( + self, + s_reportgroup_cache_id: Annotated[str, Field(strict=True)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve report from cache + + Retrieve a report that was previously generated and cached + + :param s_reportgroup_cache_id: (required) + :type s_reportgroup_cache_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._report_get_report_from_cache_v1_serialize( + s_reportgroup_cache_id=s_reportgroup_cache_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "CommonGetReportV1Response", + '406': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) + return response_data.response - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method report_get_report_from_cache_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] - _collection_formats = {} + def _report_get_report_from_cache_v1_serialize( + self, + s_reportgroup_cache_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: - # process the path parameters - _path_params = {} - if _params['s_reportgroup_cache_id']: - _path_params['sReportgroupCacheID'] = _params['s_reportgroup_cache_id'] + _host = None + + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if s_reportgroup_cache_id is not None: + _path_params['sReportgroupCacheID'] = s_reportgroup_cache_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json', 'application/pdf', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet', 'application/zip', 'text/html']) # noqa: E501 + [ + 'application/json', + 'application/pdf', + 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet', + 'application/zip', + 'text/html' + ] + ) - # authentication setting - _auth_settings = ['Authorization', 'Presigned'] # noqa: E501 - _response_types_map = { - '200': "CommonGetReportV1Response", - '406': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization', + 'Presigned' + ] - return self.api_client.call_api( - '/1/module/report/getReportFromCache/{sReportgroupCacheID}', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/1/module/report/getReportFromCache/{sReportgroupCacheID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/eZmaxApi/api/module_user_api.py b/eZmaxApi/api/module_user_api.py index 5e785735f..bbcbd1f51 100644 --- a/eZmaxApi/api/module_user_api.py +++ b/eZmaxApi/api/module_user_api.py @@ -13,23 +13,25 @@ """ # noqa: E501 -import re # noqa: F401 import io import warnings -from pydantic import validate_arguments, ValidationError +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Dict, List, Optional, Tuple, Union, Any -from pydantic import conlist +try: + from typing import Annotated +except ImportError: + from typing_extensions import Annotated + +from typing import List from eZmaxApi.models.user_create_ezsignuser_v1_request import UserCreateEzsignuserV1Request from eZmaxApi.models.user_create_ezsignuser_v1_response import UserCreateEzsignuserV1Response from eZmaxApi.api_client import ApiClient from eZmaxApi.api_response import ApiResponse -from eZmaxApi.exceptions import ( # noqa: F401 - ApiTypeError, - ApiValueError -) +from eZmaxApi.rest import RESTResponseType class ModuleUserApi: @@ -44,149 +46,274 @@ def __init__(self, api_client=None) -> None: api_client = ApiClient.get_default() self.api_client = api_client - @validate_arguments - def user_create_ezsignuser_v1(self, user_create_ezsignuser_v1_request : conlist(UserCreateEzsignuserV1Request), **kwargs) -> UserCreateEzsignuserV1Response: # noqa: E501 - """Create a new User of type Ezsignuser # noqa: E501 - The endpoint allows to initiate the creation or a user of type Ezsignuser. The user will be created only once the email verification process will be completed # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def user_create_ezsignuser_v1( + self, + user_create_ezsignuser_v1_request: List[UserCreateEzsignuserV1Request], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> UserCreateEzsignuserV1Response: + """Create a new User of type Ezsignuser - >>> thread = api.user_create_ezsignuser_v1(user_create_ezsignuser_v1_request, async_req=True) - >>> result = thread.get() + The endpoint allows to initiate the creation or a user of type Ezsignuser. The user will be created only once the email verification process will be completed :param user_create_ezsignuser_v1_request: (required) :type user_create_ezsignuser_v1_request: List[UserCreateEzsignuserV1Request] - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: UserCreateEzsignuserV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the user_create_ezsignuser_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.user_create_ezsignuser_v1_with_http_info(user_create_ezsignuser_v1_request, **kwargs) # noqa: E501 - - @validate_arguments - def user_create_ezsignuser_v1_with_http_info(self, user_create_ezsignuser_v1_request : conlist(UserCreateEzsignuserV1Request), **kwargs) -> ApiResponse: # noqa: E501 - """Create a new User of type Ezsignuser # noqa: E501 - - The endpoint allows to initiate the creation or a user of type Ezsignuser. The user will be created only once the email verification process will be completed # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.user_create_ezsignuser_v1_with_http_info(user_create_ezsignuser_v1_request, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._user_create_ezsignuser_v1_serialize( + user_create_ezsignuser_v1_request=user_create_ezsignuser_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "UserCreateEzsignuserV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def user_create_ezsignuser_v1_with_http_info( + self, + user_create_ezsignuser_v1_request: List[UserCreateEzsignuserV1Request], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[UserCreateEzsignuserV1Response]: + """Create a new User of type Ezsignuser + + The endpoint allows to initiate the creation or a user of type Ezsignuser. The user will be created only once the email verification process will be completed :param user_create_ezsignuser_v1_request: (required) :type user_create_ezsignuser_v1_request: List[UserCreateEzsignuserV1Request] - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(UserCreateEzsignuserV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._user_create_ezsignuser_v1_serialize( + user_create_ezsignuser_v1_request=user_create_ezsignuser_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '200': "UserCreateEzsignuserV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'user_create_ezsignuser_v1_request' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def user_create_ezsignuser_v1_without_preload_content( + self, + user_create_ezsignuser_v1_request: List[UserCreateEzsignuserV1Request], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Create a new User of type Ezsignuser + + The endpoint allows to initiate the creation or a user of type Ezsignuser. The user will be created only once the email verification process will be completed + + :param user_create_ezsignuser_v1_request: (required) + :type user_create_ezsignuser_v1_request: List[UserCreateEzsignuserV1Request] + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._user_create_ezsignuser_v1_serialize( + user_create_ezsignuser_v1_request=user_create_ezsignuser_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method user_create_ezsignuser_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "UserCreateEzsignuserV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} + def _user_create_ezsignuser_v1_serialize( + self, + user_create_ezsignuser_v1_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + 'UserCreateEzsignuserV1Request': '', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['user_create_ezsignuser_v1_request'] is not None: - _body_params = _params['user_create_ezsignuser_v1_request'] + if user_create_ezsignuser_v1_request is not None: + _body_params = user_create_ezsignuser_v1_request + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '200': "UserCreateEzsignuserV1Response", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/module/user/createezsignuser', 'POST', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='POST', + resource_path='/1/module/user/createezsignuser', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/eZmaxApi/api/object_activesession_api.py b/eZmaxApi/api/object_activesession_api.py index 5c8d17c43..e2fada150 100644 --- a/eZmaxApi/api/object_activesession_api.py +++ b/eZmaxApi/api/object_activesession_api.py @@ -13,14 +13,20 @@ """ # noqa: E501 -import re # noqa: F401 import io import warnings -from pydantic import validate_arguments, ValidationError +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Dict, List, Optional, Tuple, Union, Any +try: + from typing import Annotated +except ImportError: + from typing_extensions import Annotated + +from pydantic import Field from typing_extensions import Annotated -from pydantic import Field, StrictStr, conint +from pydantic import StrictStr, field_validator from typing import Optional @@ -30,10 +36,7 @@ from eZmaxApi.api_client import ApiClient from eZmaxApi.api_response import ApiResponse -from eZmaxApi.exceptions import ( # noqa: F401 - ApiTypeError, - ApiValueError -) +from eZmaxApi.rest import RESTResponseType class ObjectActivesessionApi: @@ -48,118 +51,197 @@ def __init__(self, api_client=None) -> None: api_client = ApiClient.get_default() self.api_client = api_client - @validate_arguments - def activesession_get_current_v1(self, **kwargs) -> ActivesessionGetCurrentV1Response: # noqa: E501 - """Get Current Activesession # noqa: E501 - Retrieve the details about the current activesession # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def activesession_get_current_v1( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ActivesessionGetCurrentV1Response: + """Get Current Activesession - >>> thread = api.activesession_get_current_v1(async_req=True) - >>> result = thread.get() + Retrieve the details about the current activesession - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: ActivesessionGetCurrentV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the activesession_get_current_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.activesession_get_current_v1_with_http_info(**kwargs) # noqa: E501 - - @validate_arguments - def activesession_get_current_v1_with_http_info(self, **kwargs) -> ApiResponse: # noqa: E501 - """Get Current Activesession # noqa: E501 - - Retrieve the details about the current activesession # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.activesession_get_current_v1_with_http_info(async_req=True) - >>> result = thread.get() - - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(ActivesessionGetCurrentV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 - _params = locals() + _param = self._activesession_get_current_v1_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _all_params = [ - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + _response_types_map: Dict[str, Optional[str]] = { + '200': "ActivesessionGetCurrentV1Response", + '350': None, + '351': None, + '352': "CommonResponseRedirectSSecretquestionTextX", + '353': None, + '354': None, + '355': None, + '356': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def activesession_get_current_v1_with_http_info( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ActivesessionGetCurrentV1Response]: + """Get Current Activesession + + Retrieve the details about the current activesession + + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._activesession_get_current_v1_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method activesession_get_current_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "ActivesessionGetCurrentV1Response", + '350': None, + '351': None, + '352': "CommonResponseRedirectSSecretquestionTextX", + '353': None, + '354': None, + '355': None, + '356': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _collection_formats = {} - # process the path parameters - _path_params = {} + @validate_call + def activesession_get_current_v1_without_preload_content( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get Current Activesession - # process the query parameters - _query_params = [] - # process the header parameters - _header_params = dict(_params.get('_headers', {})) - # process the form parameters - _form_params = [] - _files = {} - # process the body parameter - _body_params = None - # set the HTTP header `Accept` - _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + Retrieve the details about the current activesession - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 - _response_types_map = { + _param = self._activesession_get_current_v1_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { '200': "ActivesessionGetCurrentV1Response", '350': None, '351': None, @@ -169,33 +251,94 @@ def activesession_get_current_v1_with_http_info(self, **kwargs) -> ApiResponse: '355': None, '356': None, } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _activesession_get_current_v1_serialize( + self, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/activesession/getCurrent', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/1/object/activesession/getCurrent', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + - @validate_arguments - def activesession_get_list_v1(self, e_order_by : Annotated[Optional[StrictStr], Field(description="Specify how you want the results to be sorted")] = None, i_row_max : Optional[conint(strict=True, le=10000, ge=1)] = None, i_row_offset : Optional[conint(strict=True, ge=0)] = None, accept_language : Optional[HeaderAcceptLanguage] = None, s_filter : Optional[StrictStr] = None, **kwargs) -> ActivesessionGetListV1Response: # noqa: E501 - """Retrieve Activesession list # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.activesession_get_list_v1(e_order_by, i_row_max, i_row_offset, accept_language, s_filter, async_req=True) - >>> result = thread.get() + @validate_call + def activesession_get_list_v1( + self, + e_order_by: Annotated[Optional[StrictStr], Field(description="Specify how you want the results to be sorted")] = None, + i_row_max: Optional[Annotated[int, Field(le=10000, strict=True, ge=1)]] = None, + i_row_offset: Optional[Annotated[int, Field(strict=True, ge=0)]] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + s_filter: Optional[StrictStr] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ActivesessionGetListV1Response: + """Retrieve Activesession list + :param e_order_by: Specify how you want the results to be sorted :type e_order_by: str @@ -207,32 +350,78 @@ def activesession_get_list_v1(self, e_order_by : Annotated[Optional[StrictStr], :type accept_language: HeaderAcceptLanguage :param s_filter: :type s_filter: str - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: ActivesessionGetListV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the activesession_get_list_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.activesession_get_list_v1_with_http_info(e_order_by, i_row_max, i_row_offset, accept_language, s_filter, **kwargs) # noqa: E501 - - @validate_arguments - def activesession_get_list_v1_with_http_info(self, e_order_by : Annotated[Optional[StrictStr], Field(description="Specify how you want the results to be sorted")] = None, i_row_max : Optional[conint(strict=True, le=10000, ge=1)] = None, i_row_offset : Optional[conint(strict=True, ge=0)] = None, accept_language : Optional[HeaderAcceptLanguage] = None, s_filter : Optional[StrictStr] = None, **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve Activesession list # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.activesession_get_list_v1_with_http_info(e_order_by, i_row_max, i_row_offset, accept_language, s_filter, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._activesession_get_list_v1_serialize( + e_order_by=e_order_by, + i_row_max=i_row_max, + i_row_offset=i_row_offset, + accept_language=accept_language, + s_filter=s_filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ActivesessionGetListV1Response", + '406': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def activesession_get_list_v1_with_http_info( + self, + e_order_by: Annotated[Optional[StrictStr], Field(description="Specify how you want the results to be sorted")] = None, + i_row_max: Optional[Annotated[int, Field(le=10000, strict=True, ge=1)]] = None, + i_row_offset: Optional[Annotated[int, Field(strict=True, ge=0)]] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + s_filter: Optional[StrictStr] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ActivesessionGetListV1Response]: + """Retrieve Activesession list + :param e_order_by: Specify how you want the results to be sorted :type e_order_by: str @@ -244,116 +433,211 @@ def activesession_get_list_v1_with_http_info(self, e_order_by : Annotated[Option :type accept_language: HeaderAcceptLanguage :param s_filter: :type s_filter: str - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(ActivesessionGetListV1Response, status_code(int), headers(HTTPHeaderDict)) - """ - - _params = locals() - - _all_params = [ - 'e_order_by', - 'i_row_max', - 'i_row_offset', - 'accept_language', - 's_filter' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' - ] + """ # noqa: E501 + + _param = self._activesession_get_list_v1_serialize( + e_order_by=e_order_by, + i_row_max=i_row_max, + i_row_offset=i_row_offset, + accept_language=accept_language, + s_filter=s_filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method activesession_get_list_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "ActivesessionGetListV1Response", + '406': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _collection_formats = {} - # process the path parameters - _path_params = {} + @validate_call + def activesession_get_list_v1_without_preload_content( + self, + e_order_by: Annotated[Optional[StrictStr], Field(description="Specify how you want the results to be sorted")] = None, + i_row_max: Optional[Annotated[int, Field(le=10000, strict=True, ge=1)]] = None, + i_row_offset: Optional[Annotated[int, Field(strict=True, ge=0)]] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + s_filter: Optional[StrictStr] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve Activesession list - # process the query parameters - _query_params = [] - if _params.get('e_order_by') is not None: # noqa: E501 - _query_params.append(('eOrderBy', _params['e_order_by'])) - if _params.get('i_row_max') is not None: # noqa: E501 - _query_params.append(('iRowMax', _params['i_row_max'])) + :param e_order_by: Specify how you want the results to be sorted + :type e_order_by: str + :param i_row_max: + :type i_row_max: int + :param i_row_offset: + :type i_row_offset: int + :param accept_language: + :type accept_language: HeaderAcceptLanguage + :param s_filter: + :type s_filter: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._activesession_get_list_v1_serialize( + e_order_by=e_order_by, + i_row_max=i_row_max, + i_row_offset=i_row_offset, + accept_language=accept_language, + s_filter=s_filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ActivesessionGetListV1Response", + '406': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - if _params.get('i_row_offset') is not None: # noqa: E501 - _query_params.append(('iRowOffset', _params['i_row_offset'])) - if _params.get('s_filter') is not None: # noqa: E501 - _query_params.append(('sFilter', _params['s_filter'])) + def _activesession_get_list_v1_serialize( + self, + e_order_by, + i_row_max, + i_row_offset, + accept_language, + s_filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: - # process the header parameters - _header_params = dict(_params.get('_headers', {})) - if _params['accept_language']: - _header_params['Accept-Language'] = _params['accept_language'] + _host = None + + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if e_order_by is not None: + + _query_params.append(('eOrderBy', e_order_by)) + + if i_row_max is not None: + + _query_params.append(('iRowMax', i_row_max)) + + if i_row_offset is not None: + + _query_params.append(('iRowOffset', i_row_offset)) + + if s_filter is not None: + + _query_params.append(('sFilter', s_filter)) + + # process the header parameters + if accept_language is not None: + _header_params['Accept-Language'] = accept_language # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet']) # noqa: E501 + [ + 'application/json', + 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "ActivesessionGetListV1Response", - '406': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/activesession/getList', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/1/object/activesession/getList', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/eZmaxApi/api/object_apikey_api.py b/eZmaxApi/api/object_apikey_api.py index c2de1cb61..514d33430 100644 --- a/eZmaxApi/api/object_apikey_api.py +++ b/eZmaxApi/api/object_apikey_api.py @@ -13,14 +13,20 @@ """ # noqa: E501 -import re # noqa: F401 import io import warnings -from pydantic import validate_arguments, ValidationError +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Dict, List, Optional, Tuple, Union, Any +try: + from typing import Annotated +except ImportError: + from typing_extensions import Annotated + +from pydantic import Field from typing_extensions import Annotated -from pydantic import Field, StrictStr, conint +from pydantic import StrictStr, field_validator from typing import Optional @@ -41,10 +47,7 @@ from eZmaxApi.api_client import ApiClient from eZmaxApi.api_response import ApiResponse -from eZmaxApi.exceptions import ( # noqa: F401 - ApiTypeError, - ApiValueError -) +from eZmaxApi.rest import RESTResponseType class ObjectApikeyApi: @@ -59,616 +62,1144 @@ def __init__(self, api_client=None) -> None: api_client = ApiClient.get_default() self.api_client = api_client - @validate_arguments - def apikey_create_object_v2(self, apikey_create_object_v2_request : ApikeyCreateObjectV2Request, **kwargs) -> ApikeyCreateObjectV2Response: # noqa: E501 - """Create a new Apikey # noqa: E501 - The endpoint allows to create one or many elements at once. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def apikey_create_object_v2( + self, + apikey_create_object_v2_request: ApikeyCreateObjectV2Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApikeyCreateObjectV2Response: + """Create a new Apikey - >>> thread = api.apikey_create_object_v2(apikey_create_object_v2_request, async_req=True) - >>> result = thread.get() + The endpoint allows to create one or many elements at once. :param apikey_create_object_v2_request: (required) :type apikey_create_object_v2_request: ApikeyCreateObjectV2Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: ApikeyCreateObjectV2Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the apikey_create_object_v2_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.apikey_create_object_v2_with_http_info(apikey_create_object_v2_request, **kwargs) # noqa: E501 - - @validate_arguments - def apikey_create_object_v2_with_http_info(self, apikey_create_object_v2_request : ApikeyCreateObjectV2Request, **kwargs) -> ApiResponse: # noqa: E501 - """Create a new Apikey # noqa: E501 - - The endpoint allows to create one or many elements at once. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.apikey_create_object_v2_with_http_info(apikey_create_object_v2_request, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._apikey_create_object_v2_serialize( + apikey_create_object_v2_request=apikey_create_object_v2_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "ApikeyCreateObjectV2Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def apikey_create_object_v2_with_http_info( + self, + apikey_create_object_v2_request: ApikeyCreateObjectV2Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ApikeyCreateObjectV2Response]: + """Create a new Apikey + + The endpoint allows to create one or many elements at once. :param apikey_create_object_v2_request: (required) :type apikey_create_object_v2_request: ApikeyCreateObjectV2Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(ApikeyCreateObjectV2Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._apikey_create_object_v2_serialize( + apikey_create_object_v2_request=apikey_create_object_v2_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '201': "ApikeyCreateObjectV2Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'apikey_create_object_v2_request' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def apikey_create_object_v2_without_preload_content( + self, + apikey_create_object_v2_request: ApikeyCreateObjectV2Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Create a new Apikey + + The endpoint allows to create one or many elements at once. + + :param apikey_create_object_v2_request: (required) + :type apikey_create_object_v2_request: ApikeyCreateObjectV2Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._apikey_create_object_v2_serialize( + apikey_create_object_v2_request=apikey_create_object_v2_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method apikey_create_object_v2" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '201': "ApikeyCreateObjectV2Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} + def _apikey_create_object_v2_serialize( + self, + apikey_create_object_v2_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['apikey_create_object_v2_request'] is not None: - _body_params = _params['apikey_create_object_v2_request'] + if apikey_create_object_v2_request is not None: + _body_params = apikey_create_object_v2_request + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '201': "ApikeyCreateObjectV2Response", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/2/object/apikey', 'POST', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='POST', + resource_path='/2/object/apikey', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + - @validate_arguments - def apikey_edit_object_v1(self, pki_apikey_id : Annotated[conint(strict=True, ge=0), Field(..., description="The unique ID of the Apikey")], apikey_edit_object_v1_request : ApikeyEditObjectV1Request, **kwargs) -> ApikeyEditObjectV1Response: # noqa: E501 - """Edit an existing Apikey # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.apikey_edit_object_v1(pki_apikey_id, apikey_edit_object_v1_request, async_req=True) - >>> result = thread.get() + @validate_call + def apikey_edit_object_v1( + self, + pki_apikey_id: Annotated[int, Field(strict=True, ge=0, description="The unique ID of the Apikey")], + apikey_edit_object_v1_request: ApikeyEditObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApikeyEditObjectV1Response: + """Edit an existing Apikey + + :param pki_apikey_id: The unique ID of the Apikey (required) :type pki_apikey_id: int :param apikey_edit_object_v1_request: (required) :type apikey_edit_object_v1_request: ApikeyEditObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: ApikeyEditObjectV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the apikey_edit_object_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.apikey_edit_object_v1_with_http_info(pki_apikey_id, apikey_edit_object_v1_request, **kwargs) # noqa: E501 - - @validate_arguments - def apikey_edit_object_v1_with_http_info(self, pki_apikey_id : Annotated[conint(strict=True, ge=0), Field(..., description="The unique ID of the Apikey")], apikey_edit_object_v1_request : ApikeyEditObjectV1Request, **kwargs) -> ApiResponse: # noqa: E501 - """Edit an existing Apikey # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.apikey_edit_object_v1_with_http_info(pki_apikey_id, apikey_edit_object_v1_request, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._apikey_edit_object_v1_serialize( + pki_apikey_id=pki_apikey_id, + apikey_edit_object_v1_request=apikey_edit_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ApikeyEditObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def apikey_edit_object_v1_with_http_info( + self, + pki_apikey_id: Annotated[int, Field(strict=True, ge=0, description="The unique ID of the Apikey")], + apikey_edit_object_v1_request: ApikeyEditObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ApikeyEditObjectV1Response]: + """Edit an existing Apikey + + :param pki_apikey_id: The unique ID of the Apikey (required) :type pki_apikey_id: int :param apikey_edit_object_v1_request: (required) :type apikey_edit_object_v1_request: ApikeyEditObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(ApikeyEditObjectV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._apikey_edit_object_v1_serialize( + pki_apikey_id=pki_apikey_id, + apikey_edit_object_v1_request=apikey_edit_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ApikeyEditObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _params = locals() - _all_params = [ - 'pki_apikey_id', - 'apikey_edit_object_v1_request' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + @validate_call + def apikey_edit_object_v1_without_preload_content( + self, + pki_apikey_id: Annotated[int, Field(strict=True, ge=0, description="The unique ID of the Apikey")], + apikey_edit_object_v1_request: ApikeyEditObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Edit an existing Apikey + + + + :param pki_apikey_id: The unique ID of the Apikey (required) + :type pki_apikey_id: int + :param apikey_edit_object_v1_request: (required) + :type apikey_edit_object_v1_request: ApikeyEditObjectV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._apikey_edit_object_v1_serialize( + pki_apikey_id=pki_apikey_id, + apikey_edit_object_v1_request=apikey_edit_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method apikey_edit_object_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "ApikeyEditObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_apikey_id']: - _path_params['pkiApikeyID'] = _params['pki_apikey_id'] + def _apikey_edit_object_v1_serialize( + self, + pki_apikey_id, + apikey_edit_object_v1_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if pki_apikey_id is not None: + _path_params['pkiApikeyID'] = pki_apikey_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['apikey_edit_object_v1_request'] is not None: - _body_params = _params['apikey_edit_object_v1_request'] + if apikey_edit_object_v1_request is not None: + _body_params = apikey_edit_object_v1_request + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '200': "ApikeyEditObjectV1Response", - '404': "CommonResponseError", - '422': "CommonResponseError", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/apikey/{pkiApikeyID}', 'PUT', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='PUT', + resource_path='/1/object/apikey/{pkiApikeyID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) - @validate_arguments - def apikey_edit_permissions_v1(self, pki_apikey_id : conint(strict=True, ge=0), apikey_edit_permissions_v1_request : ApikeyEditPermissionsV1Request, **kwargs) -> ApikeyEditPermissionsV1Response: # noqa: E501 - """Edit multiple Permissions # noqa: E501 - Using this endpoint, you can edit multiple Permissions at the same time. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.apikey_edit_permissions_v1(pki_apikey_id, apikey_edit_permissions_v1_request, async_req=True) - >>> result = thread.get() + + @validate_call + def apikey_edit_permissions_v1( + self, + pki_apikey_id: Annotated[int, Field(strict=True, ge=0)], + apikey_edit_permissions_v1_request: ApikeyEditPermissionsV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApikeyEditPermissionsV1Response: + """Edit multiple Permissions + + Using this endpoint, you can edit multiple Permissions at the same time. :param pki_apikey_id: (required) :type pki_apikey_id: int :param apikey_edit_permissions_v1_request: (required) :type apikey_edit_permissions_v1_request: ApikeyEditPermissionsV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: ApikeyEditPermissionsV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the apikey_edit_permissions_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.apikey_edit_permissions_v1_with_http_info(pki_apikey_id, apikey_edit_permissions_v1_request, **kwargs) # noqa: E501 - - @validate_arguments - def apikey_edit_permissions_v1_with_http_info(self, pki_apikey_id : conint(strict=True, ge=0), apikey_edit_permissions_v1_request : ApikeyEditPermissionsV1Request, **kwargs) -> ApiResponse: # noqa: E501 - """Edit multiple Permissions # noqa: E501 - - Using this endpoint, you can edit multiple Permissions at the same time. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.apikey_edit_permissions_v1_with_http_info(pki_apikey_id, apikey_edit_permissions_v1_request, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._apikey_edit_permissions_v1_serialize( + pki_apikey_id=pki_apikey_id, + apikey_edit_permissions_v1_request=apikey_edit_permissions_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ApikeyEditPermissionsV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def apikey_edit_permissions_v1_with_http_info( + self, + pki_apikey_id: Annotated[int, Field(strict=True, ge=0)], + apikey_edit_permissions_v1_request: ApikeyEditPermissionsV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ApikeyEditPermissionsV1Response]: + """Edit multiple Permissions + + Using this endpoint, you can edit multiple Permissions at the same time. :param pki_apikey_id: (required) :type pki_apikey_id: int :param apikey_edit_permissions_v1_request: (required) :type apikey_edit_permissions_v1_request: ApikeyEditPermissionsV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(ApikeyEditPermissionsV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._apikey_edit_permissions_v1_serialize( + pki_apikey_id=pki_apikey_id, + apikey_edit_permissions_v1_request=apikey_edit_permissions_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '200': "ApikeyEditPermissionsV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'pki_apikey_id', - 'apikey_edit_permissions_v1_request' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def apikey_edit_permissions_v1_without_preload_content( + self, + pki_apikey_id: Annotated[int, Field(strict=True, ge=0)], + apikey_edit_permissions_v1_request: ApikeyEditPermissionsV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Edit multiple Permissions + + Using this endpoint, you can edit multiple Permissions at the same time. + + :param pki_apikey_id: (required) + :type pki_apikey_id: int + :param apikey_edit_permissions_v1_request: (required) + :type apikey_edit_permissions_v1_request: ApikeyEditPermissionsV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._apikey_edit_permissions_v1_serialize( + pki_apikey_id=pki_apikey_id, + apikey_edit_permissions_v1_request=apikey_edit_permissions_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method apikey_edit_permissions_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "ApikeyEditPermissionsV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_apikey_id']: - _path_params['pkiApikeyID'] = _params['pki_apikey_id'] + def _apikey_edit_permissions_v1_serialize( + self, + pki_apikey_id, + apikey_edit_permissions_v1_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if pki_apikey_id is not None: + _path_params['pkiApikeyID'] = pki_apikey_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['apikey_edit_permissions_v1_request'] is not None: - _body_params = _params['apikey_edit_permissions_v1_request'] + if apikey_edit_permissions_v1_request is not None: + _body_params = apikey_edit_permissions_v1_request + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '200': "ApikeyEditPermissionsV1Response", - '404': "CommonResponseError", - '422': "CommonResponseError", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/apikey/{pkiApikeyID}/editPermissions', 'PUT', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='PUT', + resource_path='/1/object/apikey/{pkiApikeyID}/editPermissions', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + - @validate_arguments - def apikey_get_cors_v1(self, pki_apikey_id : conint(strict=True, ge=0), **kwargs) -> ApikeyGetCorsV1Response: # noqa: E501 - """Retrieve an existing Apikey's cors # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.apikey_get_cors_v1(pki_apikey_id, async_req=True) - >>> result = thread.get() + @validate_call + def apikey_get_cors_v1( + self, + pki_apikey_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApikeyGetCorsV1Response: + """Retrieve an existing Apikey's cors + :param pki_apikey_id: (required) :type pki_apikey_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: ApikeyGetCorsV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the apikey_get_cors_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.apikey_get_cors_v1_with_http_info(pki_apikey_id, **kwargs) # noqa: E501 - - @validate_arguments - def apikey_get_cors_v1_with_http_info(self, pki_apikey_id : conint(strict=True, ge=0), **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve an existing Apikey's cors # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.apikey_get_cors_v1_with_http_info(pki_apikey_id, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._apikey_get_cors_v1_serialize( + pki_apikey_id=pki_apikey_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ApikeyGetCorsV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def apikey_get_cors_v1_with_http_info( + self, + pki_apikey_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ApikeyGetCorsV1Response]: + """Retrieve an existing Apikey's cors + :param pki_apikey_id: (required) :type pki_apikey_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(ApikeyGetCorsV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._apikey_get_cors_v1_serialize( + pki_apikey_id=pki_apikey_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ApikeyGetCorsV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _params = locals() - _all_params = [ - 'pki_apikey_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + @validate_call + def apikey_get_cors_v1_without_preload_content( + self, + pki_apikey_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve an existing Apikey's cors + + + :param pki_apikey_id: (required) + :type pki_apikey_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._apikey_get_cors_v1_serialize( + pki_apikey_id=pki_apikey_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method apikey_get_cors_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "ApikeyGetCorsV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_apikey_id']: - _path_params['pkiApikeyID'] = _params['pki_apikey_id'] + def _apikey_get_cors_v1_serialize( + self, + pki_apikey_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_apikey_id is not None: + _path_params['pkiApikeyID'] = pki_apikey_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "ApikeyGetCorsV1Response", - '404': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/apikey/{pkiApikeyID}/getCors', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/1/object/apikey/{pkiApikeyID}/getCors', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + - @validate_arguments - def apikey_get_list_v1(self, e_order_by : Annotated[Optional[StrictStr], Field(description="Specify how you want the results to be sorted")] = None, i_row_max : Optional[conint(strict=True, le=10000, ge=1)] = None, i_row_offset : Optional[conint(strict=True, ge=0)] = None, accept_language : Optional[HeaderAcceptLanguage] = None, s_filter : Optional[StrictStr] = None, **kwargs) -> ApikeyGetListV1Response: # noqa: E501 - """Retrieve Apikey list # noqa: E501 - Enum values that can be filtered in query parameter *sFilter*: | Variable | Valid values | |---|---| # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.apikey_get_list_v1(e_order_by, i_row_max, i_row_offset, accept_language, s_filter, async_req=True) - >>> result = thread.get() + @validate_call + def apikey_get_list_v1( + self, + e_order_by: Annotated[Optional[StrictStr], Field(description="Specify how you want the results to be sorted")] = None, + i_row_max: Optional[Annotated[int, Field(le=10000, strict=True, ge=1)]] = None, + i_row_offset: Optional[Annotated[int, Field(strict=True, ge=0)]] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + s_filter: Optional[StrictStr] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApikeyGetListV1Response: + """Retrieve Apikey list + + Enum values that can be filtered in query parameter *sFilter*: | Variable | Valid values | |---|---| :param e_order_by: Specify how you want the results to be sorted :type e_order_by: str @@ -680,33 +1211,79 @@ def apikey_get_list_v1(self, e_order_by : Annotated[Optional[StrictStr], Field(d :type accept_language: HeaderAcceptLanguage :param s_filter: :type s_filter: str - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: ApikeyGetListV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the apikey_get_list_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.apikey_get_list_v1_with_http_info(e_order_by, i_row_max, i_row_offset, accept_language, s_filter, **kwargs) # noqa: E501 - - @validate_arguments - def apikey_get_list_v1_with_http_info(self, e_order_by : Annotated[Optional[StrictStr], Field(description="Specify how you want the results to be sorted")] = None, i_row_max : Optional[conint(strict=True, le=10000, ge=1)] = None, i_row_offset : Optional[conint(strict=True, ge=0)] = None, accept_language : Optional[HeaderAcceptLanguage] = None, s_filter : Optional[StrictStr] = None, **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve Apikey list # noqa: E501 - - Enum values that can be filtered in query parameter *sFilter*: | Variable | Valid values | |---|---| # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.apikey_get_list_v1_with_http_info(e_order_by, i_row_max, i_row_offset, accept_language, s_filter, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._apikey_get_list_v1_serialize( + e_order_by=e_order_by, + i_row_max=i_row_max, + i_row_offset=i_row_offset, + accept_language=accept_language, + s_filter=s_filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ApikeyGetListV1Response", + '406': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def apikey_get_list_v1_with_http_info( + self, + e_order_by: Annotated[Optional[StrictStr], Field(description="Specify how you want the results to be sorted")] = None, + i_row_max: Optional[Annotated[int, Field(le=10000, strict=True, ge=1)]] = None, + i_row_offset: Optional[Annotated[int, Field(strict=True, ge=0)]] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + s_filter: Optional[StrictStr] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ApikeyGetListV1Response]: + """Retrieve Apikey list + + Enum values that can be filtered in query parameter *sFilter*: | Variable | Valid values | |---|---| :param e_order_by: Specify how you want the results to be sorted :type e_order_by: str @@ -718,691 +1295,1278 @@ def apikey_get_list_v1_with_http_info(self, e_order_by : Annotated[Optional[Stri :type accept_language: HeaderAcceptLanguage :param s_filter: :type s_filter: str - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(ApikeyGetListV1Response, status_code(int), headers(HTTPHeaderDict)) - """ - - _params = locals() - - _all_params = [ - 'e_order_by', - 'i_row_max', - 'i_row_offset', - 'accept_language', - 's_filter' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' - ] + """ # noqa: E501 + + _param = self._apikey_get_list_v1_serialize( + e_order_by=e_order_by, + i_row_max=i_row_max, + i_row_offset=i_row_offset, + accept_language=accept_language, + s_filter=s_filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method apikey_get_list_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "ApikeyGetListV1Response", + '406': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _collection_formats = {} - # process the path parameters - _path_params = {} + @validate_call + def apikey_get_list_v1_without_preload_content( + self, + e_order_by: Annotated[Optional[StrictStr], Field(description="Specify how you want the results to be sorted")] = None, + i_row_max: Optional[Annotated[int, Field(le=10000, strict=True, ge=1)]] = None, + i_row_offset: Optional[Annotated[int, Field(strict=True, ge=0)]] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + s_filter: Optional[StrictStr] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve Apikey list - # process the query parameters - _query_params = [] - if _params.get('e_order_by') is not None: # noqa: E501 - _query_params.append(('eOrderBy', _params['e_order_by'])) + Enum values that can be filtered in query parameter *sFilter*: | Variable | Valid values | |---|---| - if _params.get('i_row_max') is not None: # noqa: E501 - _query_params.append(('iRowMax', _params['i_row_max'])) + :param e_order_by: Specify how you want the results to be sorted + :type e_order_by: str + :param i_row_max: + :type i_row_max: int + :param i_row_offset: + :type i_row_offset: int + :param accept_language: + :type accept_language: HeaderAcceptLanguage + :param s_filter: + :type s_filter: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._apikey_get_list_v1_serialize( + e_order_by=e_order_by, + i_row_max=i_row_max, + i_row_offset=i_row_offset, + accept_language=accept_language, + s_filter=s_filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - if _params.get('i_row_offset') is not None: # noqa: E501 - _query_params.append(('iRowOffset', _params['i_row_offset'])) + _response_types_map: Dict[str, Optional[str]] = { + '200': "ApikeyGetListV1Response", + '406': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - if _params.get('s_filter') is not None: # noqa: E501 - _query_params.append(('sFilter', _params['s_filter'])) - # process the header parameters - _header_params = dict(_params.get('_headers', {})) - if _params['accept_language']: - _header_params['Accept-Language'] = _params['accept_language'] + def _apikey_get_list_v1_serialize( + self, + e_order_by, + i_row_max, + i_row_offset, + accept_language, + s_filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if e_order_by is not None: + + _query_params.append(('eOrderBy', e_order_by)) + + if i_row_max is not None: + + _query_params.append(('iRowMax', i_row_max)) + + if i_row_offset is not None: + + _query_params.append(('iRowOffset', i_row_offset)) + + if s_filter is not None: + + _query_params.append(('sFilter', s_filter)) + + # process the header parameters + if accept_language is not None: + _header_params['Accept-Language'] = accept_language # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet']) # noqa: E501 + [ + 'application/json', + 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "ApikeyGetListV1Response", - '406': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/apikey/getList', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/1/object/apikey/getList', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) - @validate_arguments - def apikey_get_object_v2(self, pki_apikey_id : Annotated[conint(strict=True, ge=0), Field(..., description="The unique ID of the Apikey")], **kwargs) -> ApikeyGetObjectV2Response: # noqa: E501 - """Retrieve an existing Apikey # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.apikey_get_object_v2(pki_apikey_id, async_req=True) - >>> result = thread.get() + + @validate_call + def apikey_get_object_v2( + self, + pki_apikey_id: Annotated[int, Field(strict=True, ge=0, description="The unique ID of the Apikey")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApikeyGetObjectV2Response: + """Retrieve an existing Apikey + + :param pki_apikey_id: The unique ID of the Apikey (required) :type pki_apikey_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: ApikeyGetObjectV2Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the apikey_get_object_v2_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.apikey_get_object_v2_with_http_info(pki_apikey_id, **kwargs) # noqa: E501 - - @validate_arguments - def apikey_get_object_v2_with_http_info(self, pki_apikey_id : Annotated[conint(strict=True, ge=0), Field(..., description="The unique ID of the Apikey")], **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve an existing Apikey # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.apikey_get_object_v2_with_http_info(pki_apikey_id, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._apikey_get_object_v2_serialize( + pki_apikey_id=pki_apikey_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ApikeyGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def apikey_get_object_v2_with_http_info( + self, + pki_apikey_id: Annotated[int, Field(strict=True, ge=0, description="The unique ID of the Apikey")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ApikeyGetObjectV2Response]: + """Retrieve an existing Apikey + + :param pki_apikey_id: The unique ID of the Apikey (required) :type pki_apikey_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(ApikeyGetObjectV2Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._apikey_get_object_v2_serialize( + pki_apikey_id=pki_apikey_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ApikeyGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _params = locals() - _all_params = [ - 'pki_apikey_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + @validate_call + def apikey_get_object_v2_without_preload_content( + self, + pki_apikey_id: Annotated[int, Field(strict=True, ge=0, description="The unique ID of the Apikey")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve an existing Apikey + + + + :param pki_apikey_id: The unique ID of the Apikey (required) + :type pki_apikey_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._apikey_get_object_v2_serialize( + pki_apikey_id=pki_apikey_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method apikey_get_object_v2" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "ApikeyGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_apikey_id']: - _path_params['pkiApikeyID'] = _params['pki_apikey_id'] + def _apikey_get_object_v2_serialize( + self, + pki_apikey_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_apikey_id is not None: + _path_params['pkiApikeyID'] = pki_apikey_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "ApikeyGetObjectV2Response", - '404': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/2/object/apikey/{pkiApikeyID}', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/2/object/apikey/{pkiApikeyID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + - @validate_arguments - def apikey_get_permissions_v1(self, pki_apikey_id : conint(strict=True, ge=0), **kwargs) -> ApikeyGetPermissionsV1Response: # noqa: E501 - """Retrieve an existing Apikey's Permissions # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.apikey_get_permissions_v1(pki_apikey_id, async_req=True) - >>> result = thread.get() + @validate_call + def apikey_get_permissions_v1( + self, + pki_apikey_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApikeyGetPermissionsV1Response: + """Retrieve an existing Apikey's Permissions + :param pki_apikey_id: (required) :type pki_apikey_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: ApikeyGetPermissionsV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the apikey_get_permissions_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.apikey_get_permissions_v1_with_http_info(pki_apikey_id, **kwargs) # noqa: E501 - - @validate_arguments - def apikey_get_permissions_v1_with_http_info(self, pki_apikey_id : conint(strict=True, ge=0), **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve an existing Apikey's Permissions # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.apikey_get_permissions_v1_with_http_info(pki_apikey_id, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._apikey_get_permissions_v1_serialize( + pki_apikey_id=pki_apikey_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ApikeyGetPermissionsV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def apikey_get_permissions_v1_with_http_info( + self, + pki_apikey_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ApikeyGetPermissionsV1Response]: + """Retrieve an existing Apikey's Permissions + :param pki_apikey_id: (required) :type pki_apikey_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(ApikeyGetPermissionsV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._apikey_get_permissions_v1_serialize( + pki_apikey_id=pki_apikey_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ApikeyGetPermissionsV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _params = locals() - _all_params = [ - 'pki_apikey_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + @validate_call + def apikey_get_permissions_v1_without_preload_content( + self, + pki_apikey_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve an existing Apikey's Permissions + + + :param pki_apikey_id: (required) + :type pki_apikey_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._apikey_get_permissions_v1_serialize( + pki_apikey_id=pki_apikey_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method apikey_get_permissions_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "ApikeyGetPermissionsV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_apikey_id']: - _path_params['pkiApikeyID'] = _params['pki_apikey_id'] + def _apikey_get_permissions_v1_serialize( + self, + pki_apikey_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_apikey_id is not None: + _path_params['pkiApikeyID'] = pki_apikey_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "ApikeyGetPermissionsV1Response", - '404': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/apikey/{pkiApikeyID}/getPermissions', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/1/object/apikey/{pkiApikeyID}/getPermissions', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + - @validate_arguments - def apikey_get_subnets_v1(self, pki_apikey_id : conint(strict=True, ge=0), **kwargs) -> ApikeyGetSubnetsV1Response: # noqa: E501 - """Retrieve an existing Apikey's subnets # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def apikey_get_subnets_v1( + self, + pki_apikey_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApikeyGetSubnetsV1Response: + """Retrieve an existing Apikey's subnets - >>> thread = api.apikey_get_subnets_v1(pki_apikey_id, async_req=True) - >>> result = thread.get() :param pki_apikey_id: (required) :type pki_apikey_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: ApikeyGetSubnetsV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the apikey_get_subnets_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.apikey_get_subnets_v1_with_http_info(pki_apikey_id, **kwargs) # noqa: E501 - - @validate_arguments - def apikey_get_subnets_v1_with_http_info(self, pki_apikey_id : conint(strict=True, ge=0), **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve an existing Apikey's subnets # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.apikey_get_subnets_v1_with_http_info(pki_apikey_id, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._apikey_get_subnets_v1_serialize( + pki_apikey_id=pki_apikey_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ApikeyGetSubnetsV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def apikey_get_subnets_v1_with_http_info( + self, + pki_apikey_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ApikeyGetSubnetsV1Response]: + """Retrieve an existing Apikey's subnets + :param pki_apikey_id: (required) :type pki_apikey_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(ApikeyGetSubnetsV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._apikey_get_subnets_v1_serialize( + pki_apikey_id=pki_apikey_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '200': "ApikeyGetSubnetsV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'pki_apikey_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def apikey_get_subnets_v1_without_preload_content( + self, + pki_apikey_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve an existing Apikey's subnets + + + :param pki_apikey_id: (required) + :type pki_apikey_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._apikey_get_subnets_v1_serialize( + pki_apikey_id=pki_apikey_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method apikey_get_subnets_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "ApikeyGetSubnetsV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_apikey_id']: - _path_params['pkiApikeyID'] = _params['pki_apikey_id'] + def _apikey_get_subnets_v1_serialize( + self, + pki_apikey_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None + + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_apikey_id is not None: + _path_params['pkiApikeyID'] = pki_apikey_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "ApikeyGetSubnetsV1Response", - '404': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/apikey/{pkiApikeyID}/getSubnets', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/1/object/apikey/{pkiApikeyID}/getSubnets', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) - @validate_arguments - def apikey_regenerate_v1(self, pki_apikey_id : conint(strict=True, ge=0), apikey_regenerate_v1_request : ApikeyRegenerateV1Request, **kwargs) -> ApikeyRegenerateV1Response: # noqa: E501 - """Regenerate the Apikey # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.apikey_regenerate_v1(pki_apikey_id, apikey_regenerate_v1_request, async_req=True) - >>> result = thread.get() + + @validate_call + def apikey_regenerate_v1( + self, + pki_apikey_id: Annotated[int, Field(strict=True, ge=0)], + apikey_regenerate_v1_request: ApikeyRegenerateV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApikeyRegenerateV1Response: + """Regenerate the Apikey + + :param pki_apikey_id: (required) :type pki_apikey_id: int :param apikey_regenerate_v1_request: (required) :type apikey_regenerate_v1_request: ApikeyRegenerateV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: ApikeyRegenerateV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the apikey_regenerate_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.apikey_regenerate_v1_with_http_info(pki_apikey_id, apikey_regenerate_v1_request, **kwargs) # noqa: E501 - - @validate_arguments - def apikey_regenerate_v1_with_http_info(self, pki_apikey_id : conint(strict=True, ge=0), apikey_regenerate_v1_request : ApikeyRegenerateV1Request, **kwargs) -> ApiResponse: # noqa: E501 - """Regenerate the Apikey # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.apikey_regenerate_v1_with_http_info(pki_apikey_id, apikey_regenerate_v1_request, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._apikey_regenerate_v1_serialize( + pki_apikey_id=pki_apikey_id, + apikey_regenerate_v1_request=apikey_regenerate_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ApikeyRegenerateV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def apikey_regenerate_v1_with_http_info( + self, + pki_apikey_id: Annotated[int, Field(strict=True, ge=0)], + apikey_regenerate_v1_request: ApikeyRegenerateV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ApikeyRegenerateV1Response]: + """Regenerate the Apikey + + :param pki_apikey_id: (required) :type pki_apikey_id: int :param apikey_regenerate_v1_request: (required) :type apikey_regenerate_v1_request: ApikeyRegenerateV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(ApikeyRegenerateV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._apikey_regenerate_v1_serialize( + pki_apikey_id=pki_apikey_id, + apikey_regenerate_v1_request=apikey_regenerate_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ApikeyRegenerateV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _params = locals() - _all_params = [ - 'pki_apikey_id', - 'apikey_regenerate_v1_request' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + @validate_call + def apikey_regenerate_v1_without_preload_content( + self, + pki_apikey_id: Annotated[int, Field(strict=True, ge=0)], + apikey_regenerate_v1_request: ApikeyRegenerateV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Regenerate the Apikey + + + + :param pki_apikey_id: (required) + :type pki_apikey_id: int + :param apikey_regenerate_v1_request: (required) + :type apikey_regenerate_v1_request: ApikeyRegenerateV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._apikey_regenerate_v1_serialize( + pki_apikey_id=pki_apikey_id, + apikey_regenerate_v1_request=apikey_regenerate_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method apikey_regenerate_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "ApikeyRegenerateV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_apikey_id']: - _path_params['pkiApikeyID'] = _params['pki_apikey_id'] + def _apikey_regenerate_v1_serialize( + self, + pki_apikey_id, + apikey_regenerate_v1_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if pki_apikey_id is not None: + _path_params['pkiApikeyID'] = pki_apikey_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['apikey_regenerate_v1_request'] is not None: - _body_params = _params['apikey_regenerate_v1_request'] + if apikey_regenerate_v1_request is not None: + _body_params = apikey_regenerate_v1_request + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '200': "ApikeyRegenerateV1Response", - '404': "CommonResponseError", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/apikey/{pkiApikeyID}/regenerate', 'POST', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='POST', + resource_path='/1/object/apikey/{pkiApikeyID}/regenerate', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/eZmaxApi/api/object_attachment_api.py b/eZmaxApi/api/object_attachment_api.py index bd030a5eb..0ad0b5faa 100644 --- a/eZmaxApi/api/object_attachment_api.py +++ b/eZmaxApi/api/object_attachment_api.py @@ -13,22 +13,25 @@ """ # noqa: E501 -import re # noqa: F401 import io import warnings -from pydantic import validate_arguments, ValidationError +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Dict, List, Optional, Tuple, Union, Any -from pydantic import conint +try: + from typing import Annotated +except ImportError: + from typing_extensions import Annotated -from eZmaxApi.models.attachment_download_v1_response import AttachmentDownloadV1Response +from pydantic import Field +from typing_extensions import Annotated +from eZmaxApi.models.attachment_get_attachmentlogs_v1_response import AttachmentGetAttachmentlogsV1Response +from eZmaxApi.models.attachment_get_download_url_v1_response import AttachmentGetDownloadUrlV1Response from eZmaxApi.api_client import ApiClient from eZmaxApi.api_response import ApiResponse -from eZmaxApi.exceptions import ( # noqa: F401 - ApiTypeError, - ApiValueError -) +from eZmaxApi.rest import RESTResponseType class ObjectAttachmentApi: @@ -43,144 +46,789 @@ def __init__(self, api_client=None) -> None: api_client = ApiClient.get_default() self.api_client = api_client - @validate_arguments - def attachment_download_v1(self, pki_attachment_id : conint(strict=True, ge=0), **kwargs) -> AttachmentDownloadV1Response: # noqa: E501 - """Retrieve the content # noqa: E501 - Using this endpoint, you can retrieve the content of an attachment. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def attachment_download_v1( + self, + pki_attachment_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Retrieve the content - >>> thread = api.attachment_download_v1(pki_attachment_id, async_req=True) - >>> result = thread.get() + Using this endpoint, you can retrieve the content of an attachment. :param pki_attachment_id: (required) :type pki_attachment_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: AttachmentDownloadV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the attachment_download_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.attachment_download_v1_with_http_info(pki_attachment_id, **kwargs) # noqa: E501 - - @validate_arguments - def attachment_download_v1_with_http_info(self, pki_attachment_id : conint(strict=True, ge=0), **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve the content # noqa: E501 - - Using this endpoint, you can retrieve the content of an attachment. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.attachment_download_v1_with_http_info(pki_attachment_id, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._attachment_download_v1_serialize( + pki_attachment_id=pki_attachment_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '302': None, + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def attachment_download_v1_with_http_info( + self, + pki_attachment_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Retrieve the content + + Using this endpoint, you can retrieve the content of an attachment. :param pki_attachment_id: (required) :type pki_attachment_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(AttachmentDownloadV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._attachment_download_v1_serialize( + pki_attachment_id=pki_attachment_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '302': None, + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'pki_attachment_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def attachment_download_v1_without_preload_content( + self, + pki_attachment_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve the content + + Using this endpoint, you can retrieve the content of an attachment. + + :param pki_attachment_id: (required) + :type pki_attachment_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._attachment_download_v1_serialize( + pki_attachment_id=pki_attachment_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method attachment_download_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '302': None, + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + - _collection_formats = {} + def _attachment_download_v1_serialize( + self, + pki_attachment_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None # process the path parameters - _path_params = {} - if _params['pki_attachment_id']: - _path_params['pkiAttachmentID'] = _params['pki_attachment_id'] + if pki_attachment_id is not None: + _path_params['pkiAttachmentID'] = pki_attachment_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'Authorization', + 'Presigned' + ] + return self.api_client.param_serialize( + method='GET', + resource_path='/1/object/attachment/{pkiAttachmentID}/download', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def attachment_get_attachmentlogs_v1( + self, + pki_attachment_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> AttachmentGetAttachmentlogsV1Response: + """Retrieve the Attachmentlogs + + Using this endpoint, you can retrieve the Attachmentlogs of an attachment. + + :param pki_attachment_id: (required) + :type pki_attachment_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._attachment_get_attachmentlogs_v1_serialize( + pki_attachment_id=pki_attachment_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AttachmentGetAttachmentlogsV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def attachment_get_attachmentlogs_v1_with_http_info( + self, + pki_attachment_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[AttachmentGetAttachmentlogsV1Response]: + """Retrieve the Attachmentlogs + Using this endpoint, you can retrieve the Attachmentlogs of an attachment. + + :param pki_attachment_id: (required) + :type pki_attachment_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._attachment_get_attachmentlogs_v1_serialize( + pki_attachment_id=pki_attachment_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AttachmentGetAttachmentlogsV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def attachment_get_attachmentlogs_v1_without_preload_content( + self, + pki_attachment_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve the Attachmentlogs + + Using this endpoint, you can retrieve the Attachmentlogs of an attachment. + + :param pki_attachment_id: (required) + :type pki_attachment_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._attachment_get_attachmentlogs_v1_serialize( + pki_attachment_id=pki_attachment_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AttachmentGetAttachmentlogsV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _attachment_get_attachmentlogs_v1_serialize( + self, + pki_attachment_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_attachment_id is not None: + _path_params['pkiAttachmentID'] = pki_attachment_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) + # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 + _auth_settings: List[str] = [ + 'Authorization' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/1/object/attachment/{pkiAttachmentID}/getAttachmentlogs', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) - _response_types_map = { - '200': "AttachmentDownloadV1Response", + + + + @validate_call + def attachment_get_download_url_v1( + self, + pki_attachment_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> AttachmentGetDownloadUrlV1Response: + """Retrieve a URL to download attachments. + + This endpoint returns an URL to download the attachment. These links will expire after 5 minutes so the download of the file should be made soon after retrieving the link. + + :param pki_attachment_id: (required) + :type pki_attachment_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._attachment_get_download_url_v1_serialize( + pki_attachment_id=pki_attachment_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AttachmentGetDownloadUrlV1Response", '404': "CommonResponseError", '422': "CommonResponseError", } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def attachment_get_download_url_v1_with_http_info( + self, + pki_attachment_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[AttachmentGetDownloadUrlV1Response]: + """Retrieve a URL to download attachments. + + This endpoint returns an URL to download the attachment. These links will expire after 5 minutes so the download of the file should be made soon after retrieving the link. - return self.api_client.call_api( - '/1/object/attachment/{pkiAttachmentID}/download', 'GET', - _path_params, - _query_params, - _header_params, + :param pki_attachment_id: (required) + :type pki_attachment_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._attachment_get_download_url_v1_serialize( + pki_attachment_id=pki_attachment_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AttachmentGetDownloadUrlV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def attachment_get_download_url_v1_without_preload_content( + self, + pki_attachment_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve a URL to download attachments. + + This endpoint returns an URL to download the attachment. These links will expire after 5 minutes so the download of the file should be made soon after retrieving the link. + + :param pki_attachment_id: (required) + :type pki_attachment_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._attachment_get_download_url_v1_serialize( + pki_attachment_id=pki_attachment_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "AttachmentGetDownloadUrlV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _attachment_get_download_url_v1_serialize( + self, + pki_attachment_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_attachment_id is not None: + _path_params['pkiAttachmentID'] = pki_attachment_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/1/object/attachment/{pkiAttachmentID}/getDownloadUrl', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/eZmaxApi/api/object_billingentityexternal_api.py b/eZmaxApi/api/object_billingentityexternal_api.py index b72e1ca2e..5bdc79858 100644 --- a/eZmaxApi/api/object_billingentityexternal_api.py +++ b/eZmaxApi/api/object_billingentityexternal_api.py @@ -13,14 +13,20 @@ """ # noqa: E501 -import re # noqa: F401 import io import warnings -from pydantic import validate_arguments, ValidationError +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Dict, List, Optional, Tuple, Union, Any +try: + from typing import Annotated +except ImportError: + from typing_extensions import Annotated + +from pydantic import Field from typing_extensions import Annotated -from pydantic import Field, StrictStr +from pydantic import StrictStr, field_validator from typing import Optional @@ -29,10 +35,7 @@ from eZmaxApi.api_client import ApiClient from eZmaxApi.api_response import ApiResponse -from eZmaxApi.exceptions import ( # noqa: F401 - ApiTypeError, - ApiValueError -) +from eZmaxApi.rest import RESTResponseType class ObjectBillingentityexternalApi: @@ -47,16 +50,30 @@ def __init__(self, api_client=None) -> None: api_client = ApiClient.get_default() self.api_client = api_client - @validate_arguments - def billingentityexternal_get_autocomplete_v2(self, s_selector : Annotated[StrictStr, Field(..., description="The type of Billingentityexternals to return")], e_filter_active : Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, s_query : Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, accept_language : Optional[HeaderAcceptLanguage] = None, **kwargs) -> BillingentityexternalGetAutocompleteV2Response: # noqa: E501 - """Retrieve Billingentityexternals and IDs # noqa: E501 - Get the list of Billingentityexternal to be used in a dropdown or autocomplete control. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def billingentityexternal_get_autocomplete_v2( + self, + s_selector: Annotated[StrictStr, Field(description="The type of Billingentityexternals to return")], + e_filter_active: Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, + s_query: Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> BillingentityexternalGetAutocompleteV2Response: + """Retrieve Billingentityexternals and IDs - >>> thread = api.billingentityexternal_get_autocomplete_v2(s_selector, e_filter_active, s_query, accept_language, async_req=True) - >>> result = thread.get() + Get the list of Billingentityexternal to be used in a dropdown or autocomplete control. :param s_selector: The type of Billingentityexternals to return (required) :type s_selector: str @@ -66,33 +83,76 @@ def billingentityexternal_get_autocomplete_v2(self, s_selector : Annotated[Stric :type s_query: str :param accept_language: :type accept_language: HeaderAcceptLanguage - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: BillingentityexternalGetAutocompleteV2Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the billingentityexternal_get_autocomplete_v2_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.billingentityexternal_get_autocomplete_v2_with_http_info(s_selector, e_filter_active, s_query, accept_language, **kwargs) # noqa: E501 - - @validate_arguments - def billingentityexternal_get_autocomplete_v2_with_http_info(self, s_selector : Annotated[StrictStr, Field(..., description="The type of Billingentityexternals to return")], e_filter_active : Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, s_query : Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, accept_language : Optional[HeaderAcceptLanguage] = None, **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve Billingentityexternals and IDs # noqa: E501 - - Get the list of Billingentityexternal to be used in a dropdown or autocomplete control. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.billingentityexternal_get_autocomplete_v2_with_http_info(s_selector, e_filter_active, s_query, accept_language, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._billingentityexternal_get_autocomplete_v2_serialize( + s_selector=s_selector, + e_filter_active=e_filter_active, + s_query=s_query, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "BillingentityexternalGetAutocompleteV2Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def billingentityexternal_get_autocomplete_v2_with_http_info( + self, + s_selector: Annotated[StrictStr, Field(description="The type of Billingentityexternals to return")], + e_filter_active: Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, + s_query: Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[BillingentityexternalGetAutocompleteV2Response]: + """Retrieve Billingentityexternals and IDs + + Get the list of Billingentityexternal to be used in a dropdown or autocomplete control. :param s_selector: The type of Billingentityexternals to return (required) :type s_selector: str @@ -102,111 +162,197 @@ def billingentityexternal_get_autocomplete_v2_with_http_info(self, s_selector : :type s_query: str :param accept_language: :type accept_language: HeaderAcceptLanguage - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(BillingentityexternalGetAutocompleteV2Response, status_code(int), headers(HTTPHeaderDict)) - """ - - _params = locals() - - _all_params = [ - 's_selector', - 'e_filter_active', - 's_query', - 'accept_language' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + """ # noqa: E501 + + _param = self._billingentityexternal_get_autocomplete_v2_serialize( + s_selector=s_selector, + e_filter_active=e_filter_active, + s_query=s_query, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "BillingentityexternalGetAutocompleteV2Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def billingentityexternal_get_autocomplete_v2_without_preload_content( + self, + s_selector: Annotated[StrictStr, Field(description="The type of Billingentityexternals to return")], + e_filter_active: Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, + s_query: Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve Billingentityexternals and IDs + + Get the list of Billingentityexternal to be used in a dropdown or autocomplete control. + + :param s_selector: The type of Billingentityexternals to return (required) + :type s_selector: str + :param e_filter_active: Specify which results we want to display. + :type e_filter_active: str + :param s_query: Allow to filter the returned results + :type s_query: str + :param accept_language: + :type accept_language: HeaderAcceptLanguage + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._billingentityexternal_get_autocomplete_v2_serialize( + s_selector=s_selector, + e_filter_active=e_filter_active, + s_query=s_query, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method billingentityexternal_get_autocomplete_v2" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "BillingentityexternalGetAutocompleteV2Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['s_selector']: - _path_params['sSelector'] = _params['s_selector'] + def _billingentityexternal_get_autocomplete_v2_serialize( + self, + s_selector, + e_filter_active, + s_query, + accept_language, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None - # process the query parameters - _query_params = [] - if _params.get('e_filter_active') is not None: # noqa: E501 - _query_params.append(('eFilterActive', _params['e_filter_active'])) + _collection_formats: Dict[str, str] = { + } - if _params.get('s_query') is not None: # noqa: E501 - _query_params.append(('sQuery', _params['s_query'])) + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if s_selector is not None: + _path_params['sSelector'] = s_selector + # process the query parameters + if e_filter_active is not None: + + _query_params.append(('eFilterActive', e_filter_active)) + + if s_query is not None: + + _query_params.append(('sQuery', s_query)) + # process the header parameters - _header_params = dict(_params.get('_headers', {})) - if _params['accept_language']: - _header_params['Accept-Language'] = _params['accept_language'] - + if accept_language is not None: + _header_params['Accept-Language'] = accept_language # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "BillingentityexternalGetAutocompleteV2Response", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/2/object/billingentityexternal/getAutocomplete/{sSelector}', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/2/object/billingentityexternal/getAutocomplete/{sSelector}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/eZmaxApi/api/object_billingentityinternal_api.py b/eZmaxApi/api/object_billingentityinternal_api.py index 5b94c2052..d04509516 100644 --- a/eZmaxApi/api/object_billingentityinternal_api.py +++ b/eZmaxApi/api/object_billingentityinternal_api.py @@ -13,14 +13,20 @@ """ # noqa: E501 -import re # noqa: F401 import io import warnings -from pydantic import validate_arguments, ValidationError +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Dict, List, Optional, Tuple, Union, Any +try: + from typing import Annotated +except ImportError: + from typing_extensions import Annotated + +from pydantic import Field from typing_extensions import Annotated -from pydantic import Field, StrictStr, conint +from pydantic import StrictStr, field_validator from typing import Optional @@ -35,10 +41,7 @@ from eZmaxApi.api_client import ApiClient from eZmaxApi.api_response import ApiResponse -from eZmaxApi.exceptions import ( # noqa: F401 - ApiTypeError, - ApiValueError -) +from eZmaxApi.rest import RESTResponseType class ObjectBillingentityinternalApi: @@ -53,320 +56,593 @@ def __init__(self, api_client=None) -> None: api_client = ApiClient.get_default() self.api_client = api_client - @validate_arguments - def billingentityinternal_create_object_v1(self, billingentityinternal_create_object_v1_request : BillingentityinternalCreateObjectV1Request, **kwargs) -> BillingentityinternalCreateObjectV1Response: # noqa: E501 - """Create a new Billingentityinternal # noqa: E501 - The endpoint allows to create one or many elements at once. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def billingentityinternal_create_object_v1( + self, + billingentityinternal_create_object_v1_request: BillingentityinternalCreateObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> BillingentityinternalCreateObjectV1Response: + """Create a new Billingentityinternal - >>> thread = api.billingentityinternal_create_object_v1(billingentityinternal_create_object_v1_request, async_req=True) - >>> result = thread.get() + The endpoint allows to create one or many elements at once. :param billingentityinternal_create_object_v1_request: (required) :type billingentityinternal_create_object_v1_request: BillingentityinternalCreateObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: BillingentityinternalCreateObjectV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the billingentityinternal_create_object_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.billingentityinternal_create_object_v1_with_http_info(billingentityinternal_create_object_v1_request, **kwargs) # noqa: E501 - - @validate_arguments - def billingentityinternal_create_object_v1_with_http_info(self, billingentityinternal_create_object_v1_request : BillingentityinternalCreateObjectV1Request, **kwargs) -> ApiResponse: # noqa: E501 - """Create a new Billingentityinternal # noqa: E501 - - The endpoint allows to create one or many elements at once. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.billingentityinternal_create_object_v1_with_http_info(billingentityinternal_create_object_v1_request, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._billingentityinternal_create_object_v1_serialize( + billingentityinternal_create_object_v1_request=billingentityinternal_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "BillingentityinternalCreateObjectV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def billingentityinternal_create_object_v1_with_http_info( + self, + billingentityinternal_create_object_v1_request: BillingentityinternalCreateObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[BillingentityinternalCreateObjectV1Response]: + """Create a new Billingentityinternal + + The endpoint allows to create one or many elements at once. :param billingentityinternal_create_object_v1_request: (required) :type billingentityinternal_create_object_v1_request: BillingentityinternalCreateObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(BillingentityinternalCreateObjectV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._billingentityinternal_create_object_v1_serialize( + billingentityinternal_create_object_v1_request=billingentityinternal_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "BillingentityinternalCreateObjectV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _params = locals() - _all_params = [ - 'billingentityinternal_create_object_v1_request' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + @validate_call + def billingentityinternal_create_object_v1_without_preload_content( + self, + billingentityinternal_create_object_v1_request: BillingentityinternalCreateObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Create a new Billingentityinternal + + The endpoint allows to create one or many elements at once. + + :param billingentityinternal_create_object_v1_request: (required) + :type billingentityinternal_create_object_v1_request: BillingentityinternalCreateObjectV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._billingentityinternal_create_object_v1_serialize( + billingentityinternal_create_object_v1_request=billingentityinternal_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method billingentityinternal_create_object_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '201': "BillingentityinternalCreateObjectV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} + def _billingentityinternal_create_object_v1_serialize( + self, + billingentityinternal_create_object_v1_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['billingentityinternal_create_object_v1_request'] is not None: - _body_params = _params['billingentityinternal_create_object_v1_request'] + if billingentityinternal_create_object_v1_request is not None: + _body_params = billingentityinternal_create_object_v1_request + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '201': "BillingentityinternalCreateObjectV1Response", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/billingentityinternal', 'POST', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='POST', + resource_path='/1/object/billingentityinternal', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + - @validate_arguments - def billingentityinternal_edit_object_v1(self, pki_billingentityinternal_id : conint(strict=True, ge=0), billingentityinternal_edit_object_v1_request : BillingentityinternalEditObjectV1Request, **kwargs) -> BillingentityinternalEditObjectV1Response: # noqa: E501 - """Edit an existing Billingentityinternal # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.billingentityinternal_edit_object_v1(pki_billingentityinternal_id, billingentityinternal_edit_object_v1_request, async_req=True) - >>> result = thread.get() + @validate_call + def billingentityinternal_edit_object_v1( + self, + pki_billingentityinternal_id: Annotated[int, Field(strict=True, ge=0)], + billingentityinternal_edit_object_v1_request: BillingentityinternalEditObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> BillingentityinternalEditObjectV1Response: + """Edit an existing Billingentityinternal + + :param pki_billingentityinternal_id: (required) :type pki_billingentityinternal_id: int :param billingentityinternal_edit_object_v1_request: (required) :type billingentityinternal_edit_object_v1_request: BillingentityinternalEditObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: BillingentityinternalEditObjectV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the billingentityinternal_edit_object_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.billingentityinternal_edit_object_v1_with_http_info(pki_billingentityinternal_id, billingentityinternal_edit_object_v1_request, **kwargs) # noqa: E501 - - @validate_arguments - def billingentityinternal_edit_object_v1_with_http_info(self, pki_billingentityinternal_id : conint(strict=True, ge=0), billingentityinternal_edit_object_v1_request : BillingentityinternalEditObjectV1Request, **kwargs) -> ApiResponse: # noqa: E501 - """Edit an existing Billingentityinternal # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.billingentityinternal_edit_object_v1_with_http_info(pki_billingentityinternal_id, billingentityinternal_edit_object_v1_request, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._billingentityinternal_edit_object_v1_serialize( + pki_billingentityinternal_id=pki_billingentityinternal_id, + billingentityinternal_edit_object_v1_request=billingentityinternal_edit_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "BillingentityinternalEditObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def billingentityinternal_edit_object_v1_with_http_info( + self, + pki_billingentityinternal_id: Annotated[int, Field(strict=True, ge=0)], + billingentityinternal_edit_object_v1_request: BillingentityinternalEditObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[BillingentityinternalEditObjectV1Response]: + """Edit an existing Billingentityinternal + + :param pki_billingentityinternal_id: (required) :type pki_billingentityinternal_id: int :param billingentityinternal_edit_object_v1_request: (required) :type billingentityinternal_edit_object_v1_request: BillingentityinternalEditObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(BillingentityinternalEditObjectV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._billingentityinternal_edit_object_v1_serialize( + pki_billingentityinternal_id=pki_billingentityinternal_id, + billingentityinternal_edit_object_v1_request=billingentityinternal_edit_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '200': "BillingentityinternalEditObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'pki_billingentityinternal_id', - 'billingentityinternal_edit_object_v1_request' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def billingentityinternal_edit_object_v1_without_preload_content( + self, + pki_billingentityinternal_id: Annotated[int, Field(strict=True, ge=0)], + billingentityinternal_edit_object_v1_request: BillingentityinternalEditObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Edit an existing Billingentityinternal + + + + :param pki_billingentityinternal_id: (required) + :type pki_billingentityinternal_id: int + :param billingentityinternal_edit_object_v1_request: (required) + :type billingentityinternal_edit_object_v1_request: BillingentityinternalEditObjectV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._billingentityinternal_edit_object_v1_serialize( + pki_billingentityinternal_id=pki_billingentityinternal_id, + billingentityinternal_edit_object_v1_request=billingentityinternal_edit_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method billingentityinternal_edit_object_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "BillingentityinternalEditObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_billingentityinternal_id']: - _path_params['pkiBillingentityinternalID'] = _params['pki_billingentityinternal_id'] + def _billingentityinternal_edit_object_v1_serialize( + self, + pki_billingentityinternal_id, + billingentityinternal_edit_object_v1_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if pki_billingentityinternal_id is not None: + _path_params['pkiBillingentityinternalID'] = pki_billingentityinternal_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['billingentityinternal_edit_object_v1_request'] is not None: - _body_params = _params['billingentityinternal_edit_object_v1_request'] + if billingentityinternal_edit_object_v1_request is not None: + _body_params = billingentityinternal_edit_object_v1_request + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '200': "BillingentityinternalEditObjectV1Response", - '404': "CommonResponseError", - '422': "CommonResponseError", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/billingentityinternal/{pkiBillingentityinternalID}', 'PUT', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='PUT', + resource_path='/1/object/billingentityinternal/{pkiBillingentityinternalID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) - @validate_arguments - def billingentityinternal_get_autocomplete_v2(self, s_selector : Annotated[StrictStr, Field(..., description="The type of Billingentityinternals to return")], e_filter_active : Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, s_query : Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, accept_language : Optional[HeaderAcceptLanguage] = None, **kwargs) -> BillingentityinternalGetAutocompleteV2Response: # noqa: E501 - """Retrieve Billingentityinternals and IDs # noqa: E501 - Get the list of Billingentityinternal to be used in a dropdown or autocomplete control. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.billingentityinternal_get_autocomplete_v2(s_selector, e_filter_active, s_query, accept_language, async_req=True) - >>> result = thread.get() + + @validate_call + def billingentityinternal_get_autocomplete_v2( + self, + s_selector: Annotated[StrictStr, Field(description="The type of Billingentityinternals to return")], + e_filter_active: Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, + s_query: Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> BillingentityinternalGetAutocompleteV2Response: + """Retrieve Billingentityinternals and IDs + + Get the list of Billingentityinternal to be used in a dropdown or autocomplete control. :param s_selector: The type of Billingentityinternals to return (required) :type s_selector: str @@ -376,33 +652,76 @@ def billingentityinternal_get_autocomplete_v2(self, s_selector : Annotated[Stric :type s_query: str :param accept_language: :type accept_language: HeaderAcceptLanguage - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: BillingentityinternalGetAutocompleteV2Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the billingentityinternal_get_autocomplete_v2_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.billingentityinternal_get_autocomplete_v2_with_http_info(s_selector, e_filter_active, s_query, accept_language, **kwargs) # noqa: E501 - - @validate_arguments - def billingentityinternal_get_autocomplete_v2_with_http_info(self, s_selector : Annotated[StrictStr, Field(..., description="The type of Billingentityinternals to return")], e_filter_active : Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, s_query : Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, accept_language : Optional[HeaderAcceptLanguage] = None, **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve Billingentityinternals and IDs # noqa: E501 - - Get the list of Billingentityinternal to be used in a dropdown or autocomplete control. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.billingentityinternal_get_autocomplete_v2_with_http_info(s_selector, e_filter_active, s_query, accept_language, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._billingentityinternal_get_autocomplete_v2_serialize( + s_selector=s_selector, + e_filter_active=e_filter_active, + s_query=s_query, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "BillingentityinternalGetAutocompleteV2Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def billingentityinternal_get_autocomplete_v2_with_http_info( + self, + s_selector: Annotated[StrictStr, Field(description="The type of Billingentityinternals to return")], + e_filter_active: Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, + s_query: Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[BillingentityinternalGetAutocompleteV2Response]: + """Retrieve Billingentityinternals and IDs + + Get the list of Billingentityinternal to be used in a dropdown or autocomplete control. :param s_selector: The type of Billingentityinternals to return (required) :type s_selector: str @@ -412,125 +731,226 @@ def billingentityinternal_get_autocomplete_v2_with_http_info(self, s_selector : :type s_query: str :param accept_language: :type accept_language: HeaderAcceptLanguage - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(BillingentityinternalGetAutocompleteV2Response, status_code(int), headers(HTTPHeaderDict)) - """ - - _params = locals() - - _all_params = [ - 's_selector', - 'e_filter_active', - 's_query', - 'accept_language' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + """ # noqa: E501 + + _param = self._billingentityinternal_get_autocomplete_v2_serialize( + s_selector=s_selector, + e_filter_active=e_filter_active, + s_query=s_query, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "BillingentityinternalGetAutocompleteV2Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def billingentityinternal_get_autocomplete_v2_without_preload_content( + self, + s_selector: Annotated[StrictStr, Field(description="The type of Billingentityinternals to return")], + e_filter_active: Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, + s_query: Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve Billingentityinternals and IDs + + Get the list of Billingentityinternal to be used in a dropdown or autocomplete control. + + :param s_selector: The type of Billingentityinternals to return (required) + :type s_selector: str + :param e_filter_active: Specify which results we want to display. + :type e_filter_active: str + :param s_query: Allow to filter the returned results + :type s_query: str + :param accept_language: + :type accept_language: HeaderAcceptLanguage + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._billingentityinternal_get_autocomplete_v2_serialize( + s_selector=s_selector, + e_filter_active=e_filter_active, + s_query=s_query, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method billingentityinternal_get_autocomplete_v2" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "BillingentityinternalGetAutocompleteV2Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['s_selector']: - _path_params['sSelector'] = _params['s_selector'] + def _billingentityinternal_get_autocomplete_v2_serialize( + self, + s_selector, + e_filter_active, + s_query, + accept_language, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None - # process the query parameters - _query_params = [] - if _params.get('e_filter_active') is not None: # noqa: E501 - _query_params.append(('eFilterActive', _params['e_filter_active'])) + _collection_formats: Dict[str, str] = { + } - if _params.get('s_query') is not None: # noqa: E501 - _query_params.append(('sQuery', _params['s_query'])) + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if s_selector is not None: + _path_params['sSelector'] = s_selector + # process the query parameters + if e_filter_active is not None: + + _query_params.append(('eFilterActive', e_filter_active)) + + if s_query is not None: + + _query_params.append(('sQuery', s_query)) + # process the header parameters - _header_params = dict(_params.get('_headers', {})) - if _params['accept_language']: - _header_params['Accept-Language'] = _params['accept_language'] - + if accept_language is not None: + _header_params['Accept-Language'] = accept_language # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "BillingentityinternalGetAutocompleteV2Response", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/2/object/billingentityinternal/getAutocomplete/{sSelector}', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/2/object/billingentityinternal/getAutocomplete/{sSelector}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) - @validate_arguments - def billingentityinternal_get_list_v1(self, e_order_by : Annotated[Optional[StrictStr], Field(description="Specify how you want the results to be sorted")] = None, i_row_max : Optional[conint(strict=True, le=10000, ge=1)] = None, i_row_offset : Optional[conint(strict=True, ge=0)] = None, accept_language : Optional[HeaderAcceptLanguage] = None, s_filter : Optional[StrictStr] = None, **kwargs) -> BillingentityinternalGetListV1Response: # noqa: E501 - """Retrieve Billingentityinternal list # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.billingentityinternal_get_list_v1(e_order_by, i_row_max, i_row_offset, accept_language, s_filter, async_req=True) - >>> result = thread.get() + + @validate_call + def billingentityinternal_get_list_v1( + self, + e_order_by: Annotated[Optional[StrictStr], Field(description="Specify how you want the results to be sorted")] = None, + i_row_max: Optional[Annotated[int, Field(le=10000, strict=True, ge=1)]] = None, + i_row_offset: Optional[Annotated[int, Field(strict=True, ge=0)]] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + s_filter: Optional[StrictStr] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> BillingentityinternalGetListV1Response: + """Retrieve Billingentityinternal list + + :param e_order_by: Specify how you want the results to be sorted :type e_order_by: str @@ -542,33 +962,79 @@ def billingentityinternal_get_list_v1(self, e_order_by : Annotated[Optional[Stri :type accept_language: HeaderAcceptLanguage :param s_filter: :type s_filter: str - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: BillingentityinternalGetListV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the billingentityinternal_get_list_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.billingentityinternal_get_list_v1_with_http_info(e_order_by, i_row_max, i_row_offset, accept_language, s_filter, **kwargs) # noqa: E501 - - @validate_arguments - def billingentityinternal_get_list_v1_with_http_info(self, e_order_by : Annotated[Optional[StrictStr], Field(description="Specify how you want the results to be sorted")] = None, i_row_max : Optional[conint(strict=True, le=10000, ge=1)] = None, i_row_offset : Optional[conint(strict=True, ge=0)] = None, accept_language : Optional[HeaderAcceptLanguage] = None, s_filter : Optional[StrictStr] = None, **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve Billingentityinternal list # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.billingentityinternal_get_list_v1_with_http_info(e_order_by, i_row_max, i_row_offset, accept_language, s_filter, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._billingentityinternal_get_list_v1_serialize( + e_order_by=e_order_by, + i_row_max=i_row_max, + i_row_offset=i_row_offset, + accept_language=accept_language, + s_filter=s_filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "BillingentityinternalGetListV1Response", + '406': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def billingentityinternal_get_list_v1_with_http_info( + self, + e_order_by: Annotated[Optional[StrictStr], Field(description="Specify how you want the results to be sorted")] = None, + i_row_max: Optional[Annotated[int, Field(le=10000, strict=True, ge=1)]] = None, + i_row_offset: Optional[Annotated[int, Field(strict=True, ge=0)]] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + s_filter: Optional[StrictStr] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[BillingentityinternalGetListV1Response]: + """Retrieve Billingentityinternal list + + :param e_order_by: Specify how you want the results to be sorted :type e_order_by: str @@ -580,257 +1046,473 @@ def billingentityinternal_get_list_v1_with_http_info(self, e_order_by : Annotate :type accept_language: HeaderAcceptLanguage :param s_filter: :type s_filter: str - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(BillingentityinternalGetListV1Response, status_code(int), headers(HTTPHeaderDict)) - """ - - _params = locals() - - _all_params = [ - 'e_order_by', - 'i_row_max', - 'i_row_offset', - 'accept_language', - 's_filter' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' - ] + """ # noqa: E501 + + _param = self._billingentityinternal_get_list_v1_serialize( + e_order_by=e_order_by, + i_row_max=i_row_max, + i_row_offset=i_row_offset, + accept_language=accept_language, + s_filter=s_filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method billingentityinternal_get_list_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "BillingentityinternalGetListV1Response", + '406': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _collection_formats = {} - # process the path parameters - _path_params = {} + @validate_call + def billingentityinternal_get_list_v1_without_preload_content( + self, + e_order_by: Annotated[Optional[StrictStr], Field(description="Specify how you want the results to be sorted")] = None, + i_row_max: Optional[Annotated[int, Field(le=10000, strict=True, ge=1)]] = None, + i_row_offset: Optional[Annotated[int, Field(strict=True, ge=0)]] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + s_filter: Optional[StrictStr] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve Billingentityinternal list - # process the query parameters - _query_params = [] - if _params.get('e_order_by') is not None: # noqa: E501 - _query_params.append(('eOrderBy', _params['e_order_by'])) + - if _params.get('i_row_max') is not None: # noqa: E501 - _query_params.append(('iRowMax', _params['i_row_max'])) + :param e_order_by: Specify how you want the results to be sorted + :type e_order_by: str + :param i_row_max: + :type i_row_max: int + :param i_row_offset: + :type i_row_offset: int + :param accept_language: + :type accept_language: HeaderAcceptLanguage + :param s_filter: + :type s_filter: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._billingentityinternal_get_list_v1_serialize( + e_order_by=e_order_by, + i_row_max=i_row_max, + i_row_offset=i_row_offset, + accept_language=accept_language, + s_filter=s_filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "BillingentityinternalGetListV1Response", + '406': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - if _params.get('i_row_offset') is not None: # noqa: E501 - _query_params.append(('iRowOffset', _params['i_row_offset'])) - if _params.get('s_filter') is not None: # noqa: E501 - _query_params.append(('sFilter', _params['s_filter'])) + def _billingentityinternal_get_list_v1_serialize( + self, + e_order_by, + i_row_max, + i_row_offset, + accept_language, + s_filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: - # process the header parameters - _header_params = dict(_params.get('_headers', {})) - if _params['accept_language']: - _header_params['Accept-Language'] = _params['accept_language'] + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + # process the query parameters + if e_order_by is not None: + + _query_params.append(('eOrderBy', e_order_by)) + + if i_row_max is not None: + + _query_params.append(('iRowMax', i_row_max)) + + if i_row_offset is not None: + + _query_params.append(('iRowOffset', i_row_offset)) + + if s_filter is not None: + + _query_params.append(('sFilter', s_filter)) + + # process the header parameters + if accept_language is not None: + _header_params['Accept-Language'] = accept_language # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet']) # noqa: E501 + [ + 'application/json', + 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "BillingentityinternalGetListV1Response", - '406': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/billingentityinternal/getList', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/1/object/billingentityinternal/getList', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + - @validate_arguments - def billingentityinternal_get_object_v2(self, pki_billingentityinternal_id : conint(strict=True, ge=0), **kwargs) -> BillingentityinternalGetObjectV2Response: # noqa: E501 - """Retrieve an existing Billingentityinternal # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.billingentityinternal_get_object_v2(pki_billingentityinternal_id, async_req=True) - >>> result = thread.get() + @validate_call + def billingentityinternal_get_object_v2( + self, + pki_billingentityinternal_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> BillingentityinternalGetObjectV2Response: + """Retrieve an existing Billingentityinternal + + :param pki_billingentityinternal_id: (required) :type pki_billingentityinternal_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: BillingentityinternalGetObjectV2Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the billingentityinternal_get_object_v2_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.billingentityinternal_get_object_v2_with_http_info(pki_billingentityinternal_id, **kwargs) # noqa: E501 - - @validate_arguments - def billingentityinternal_get_object_v2_with_http_info(self, pki_billingentityinternal_id : conint(strict=True, ge=0), **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve an existing Billingentityinternal # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.billingentityinternal_get_object_v2_with_http_info(pki_billingentityinternal_id, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._billingentityinternal_get_object_v2_serialize( + pki_billingentityinternal_id=pki_billingentityinternal_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "BillingentityinternalGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def billingentityinternal_get_object_v2_with_http_info( + self, + pki_billingentityinternal_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[BillingentityinternalGetObjectV2Response]: + """Retrieve an existing Billingentityinternal + + :param pki_billingentityinternal_id: (required) :type pki_billingentityinternal_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(BillingentityinternalGetObjectV2Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._billingentityinternal_get_object_v2_serialize( + pki_billingentityinternal_id=pki_billingentityinternal_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "BillingentityinternalGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _params = locals() - _all_params = [ - 'pki_billingentityinternal_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + @validate_call + def billingentityinternal_get_object_v2_without_preload_content( + self, + pki_billingentityinternal_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve an existing Billingentityinternal + + + + :param pki_billingentityinternal_id: (required) + :type pki_billingentityinternal_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._billingentityinternal_get_object_v2_serialize( + pki_billingentityinternal_id=pki_billingentityinternal_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method billingentityinternal_get_object_v2" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "BillingentityinternalGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_billingentityinternal_id']: - _path_params['pkiBillingentityinternalID'] = _params['pki_billingentityinternal_id'] + def _billingentityinternal_get_object_v2_serialize( + self, + pki_billingentityinternal_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_billingentityinternal_id is not None: + _path_params['pkiBillingentityinternalID'] = pki_billingentityinternal_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "BillingentityinternalGetObjectV2Response", - '404': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/2/object/billingentityinternal/{pkiBillingentityinternalID}', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/2/object/billingentityinternal/{pkiBillingentityinternalID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/eZmaxApi/api/object_branding_api.py b/eZmaxApi/api/object_branding_api.py index 41fc136f2..a1a92f840 100644 --- a/eZmaxApi/api/object_branding_api.py +++ b/eZmaxApi/api/object_branding_api.py @@ -13,14 +13,20 @@ """ # noqa: E501 -import re # noqa: F401 import io import warnings -from pydantic import validate_arguments, ValidationError +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Dict, List, Optional, Tuple, Union, Any +try: + from typing import Annotated +except ImportError: + from typing_extensions import Annotated + +from pydantic import Field from typing_extensions import Annotated -from pydantic import Field, StrictStr, conint +from pydantic import StrictStr, field_validator from typing import Optional @@ -35,10 +41,7 @@ from eZmaxApi.api_client import ApiClient from eZmaxApi.api_response import ApiResponse -from eZmaxApi.exceptions import ( # noqa: F401 - ApiTypeError, - ApiValueError -) +from eZmaxApi.rest import RESTResponseType class ObjectBrandingApi: @@ -53,319 +56,590 @@ def __init__(self, api_client=None) -> None: api_client = ApiClient.get_default() self.api_client = api_client - @validate_arguments - def branding_create_object_v1(self, branding_create_object_v1_request : BrandingCreateObjectV1Request, **kwargs) -> BrandingCreateObjectV1Response: # noqa: E501 - """Create a new Branding # noqa: E501 - The endpoint allows to create one or many elements at once. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def branding_create_object_v1( + self, + branding_create_object_v1_request: BrandingCreateObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> BrandingCreateObjectV1Response: + """Create a new Branding - >>> thread = api.branding_create_object_v1(branding_create_object_v1_request, async_req=True) - >>> result = thread.get() + The endpoint allows to create one or many elements at once. :param branding_create_object_v1_request: (required) :type branding_create_object_v1_request: BrandingCreateObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: BrandingCreateObjectV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the branding_create_object_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.branding_create_object_v1_with_http_info(branding_create_object_v1_request, **kwargs) # noqa: E501 - - @validate_arguments - def branding_create_object_v1_with_http_info(self, branding_create_object_v1_request : BrandingCreateObjectV1Request, **kwargs) -> ApiResponse: # noqa: E501 - """Create a new Branding # noqa: E501 - - The endpoint allows to create one or many elements at once. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.branding_create_object_v1_with_http_info(branding_create_object_v1_request, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._branding_create_object_v1_serialize( + branding_create_object_v1_request=branding_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "BrandingCreateObjectV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def branding_create_object_v1_with_http_info( + self, + branding_create_object_v1_request: BrandingCreateObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[BrandingCreateObjectV1Response]: + """Create a new Branding + + The endpoint allows to create one or many elements at once. :param branding_create_object_v1_request: (required) :type branding_create_object_v1_request: BrandingCreateObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(BrandingCreateObjectV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._branding_create_object_v1_serialize( + branding_create_object_v1_request=branding_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '201': "BrandingCreateObjectV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'branding_create_object_v1_request' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def branding_create_object_v1_without_preload_content( + self, + branding_create_object_v1_request: BrandingCreateObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Create a new Branding + + The endpoint allows to create one or many elements at once. + + :param branding_create_object_v1_request: (required) + :type branding_create_object_v1_request: BrandingCreateObjectV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._branding_create_object_v1_serialize( + branding_create_object_v1_request=branding_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method branding_create_object_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '201': "BrandingCreateObjectV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} + def _branding_create_object_v1_serialize( + self, + branding_create_object_v1_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['branding_create_object_v1_request'] is not None: - _body_params = _params['branding_create_object_v1_request'] + if branding_create_object_v1_request is not None: + _body_params = branding_create_object_v1_request + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '201': "BrandingCreateObjectV1Response", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/branding', 'POST', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='POST', + resource_path='/1/object/branding', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) - @validate_arguments - def branding_edit_object_v1(self, pki_branding_id : conint(strict=True, ge=0), branding_edit_object_v1_request : BrandingEditObjectV1Request, **kwargs) -> BrandingEditObjectV1Response: # noqa: E501 - """Edit an existing Branding # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.branding_edit_object_v1(pki_branding_id, branding_edit_object_v1_request, async_req=True) - >>> result = thread.get() + + @validate_call + def branding_edit_object_v1( + self, + pki_branding_id: Annotated[int, Field(strict=True, ge=0)], + branding_edit_object_v1_request: BrandingEditObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> BrandingEditObjectV1Response: + """Edit an existing Branding + + :param pki_branding_id: (required) :type pki_branding_id: int :param branding_edit_object_v1_request: (required) :type branding_edit_object_v1_request: BrandingEditObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: BrandingEditObjectV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the branding_edit_object_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.branding_edit_object_v1_with_http_info(pki_branding_id, branding_edit_object_v1_request, **kwargs) # noqa: E501 - - @validate_arguments - def branding_edit_object_v1_with_http_info(self, pki_branding_id : conint(strict=True, ge=0), branding_edit_object_v1_request : BrandingEditObjectV1Request, **kwargs) -> ApiResponse: # noqa: E501 - """Edit an existing Branding # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.branding_edit_object_v1_with_http_info(pki_branding_id, branding_edit_object_v1_request, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._branding_edit_object_v1_serialize( + pki_branding_id=pki_branding_id, + branding_edit_object_v1_request=branding_edit_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "BrandingEditObjectV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def branding_edit_object_v1_with_http_info( + self, + pki_branding_id: Annotated[int, Field(strict=True, ge=0)], + branding_edit_object_v1_request: BrandingEditObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[BrandingEditObjectV1Response]: + """Edit an existing Branding + + :param pki_branding_id: (required) :type pki_branding_id: int :param branding_edit_object_v1_request: (required) :type branding_edit_object_v1_request: BrandingEditObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(BrandingEditObjectV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._branding_edit_object_v1_serialize( + pki_branding_id=pki_branding_id, + branding_edit_object_v1_request=branding_edit_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '200': "BrandingEditObjectV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'pki_branding_id', - 'branding_edit_object_v1_request' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def branding_edit_object_v1_without_preload_content( + self, + pki_branding_id: Annotated[int, Field(strict=True, ge=0)], + branding_edit_object_v1_request: BrandingEditObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Edit an existing Branding + + + + :param pki_branding_id: (required) + :type pki_branding_id: int + :param branding_edit_object_v1_request: (required) + :type branding_edit_object_v1_request: BrandingEditObjectV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._branding_edit_object_v1_serialize( + pki_branding_id=pki_branding_id, + branding_edit_object_v1_request=branding_edit_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method branding_edit_object_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "BrandingEditObjectV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_branding_id']: - _path_params['pkiBrandingID'] = _params['pki_branding_id'] + def _branding_edit_object_v1_serialize( + self, + pki_branding_id, + branding_edit_object_v1_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_branding_id is not None: + _path_params['pkiBrandingID'] = pki_branding_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['branding_edit_object_v1_request'] is not None: - _body_params = _params['branding_edit_object_v1_request'] + if branding_edit_object_v1_request is not None: + _body_params = branding_edit_object_v1_request + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '200': "BrandingEditObjectV1Response", - '404': "CommonResponseError", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/branding/{pkiBrandingID}', 'PUT', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='PUT', + resource_path='/1/object/branding/{pkiBrandingID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + - @validate_arguments - def branding_get_autocomplete_v2(self, s_selector : Annotated[StrictStr, Field(..., description="The type of Brandings to return")], e_filter_active : Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, s_query : Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, accept_language : Optional[HeaderAcceptLanguage] = None, **kwargs) -> BrandingGetAutocompleteV2Response: # noqa: E501 - """Retrieve Brandings and IDs # noqa: E501 - Get the list of Branding to be used in a dropdown or autocomplete control. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.branding_get_autocomplete_v2(s_selector, e_filter_active, s_query, accept_language, async_req=True) - >>> result = thread.get() + @validate_call + def branding_get_autocomplete_v2( + self, + s_selector: Annotated[StrictStr, Field(description="The type of Brandings to return")], + e_filter_active: Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, + s_query: Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> BrandingGetAutocompleteV2Response: + """Retrieve Brandings and IDs + + Get the list of Branding to be used in a dropdown or autocomplete control. :param s_selector: The type of Brandings to return (required) :type s_selector: str @@ -375,33 +649,76 @@ def branding_get_autocomplete_v2(self, s_selector : Annotated[StrictStr, Field(. :type s_query: str :param accept_language: :type accept_language: HeaderAcceptLanguage - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: BrandingGetAutocompleteV2Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the branding_get_autocomplete_v2_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.branding_get_autocomplete_v2_with_http_info(s_selector, e_filter_active, s_query, accept_language, **kwargs) # noqa: E501 - - @validate_arguments - def branding_get_autocomplete_v2_with_http_info(self, s_selector : Annotated[StrictStr, Field(..., description="The type of Brandings to return")], e_filter_active : Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, s_query : Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, accept_language : Optional[HeaderAcceptLanguage] = None, **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve Brandings and IDs # noqa: E501 - - Get the list of Branding to be used in a dropdown or autocomplete control. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.branding_get_autocomplete_v2_with_http_info(s_selector, e_filter_active, s_query, accept_language, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._branding_get_autocomplete_v2_serialize( + s_selector=s_selector, + e_filter_active=e_filter_active, + s_query=s_query, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "BrandingGetAutocompleteV2Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def branding_get_autocomplete_v2_with_http_info( + self, + s_selector: Annotated[StrictStr, Field(description="The type of Brandings to return")], + e_filter_active: Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, + s_query: Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[BrandingGetAutocompleteV2Response]: + """Retrieve Brandings and IDs + + Get the list of Branding to be used in a dropdown or autocomplete control. :param s_selector: The type of Brandings to return (required) :type s_selector: str @@ -411,125 +728,226 @@ def branding_get_autocomplete_v2_with_http_info(self, s_selector : Annotated[Str :type s_query: str :param accept_language: :type accept_language: HeaderAcceptLanguage - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(BrandingGetAutocompleteV2Response, status_code(int), headers(HTTPHeaderDict)) - """ - - _params = locals() - - _all_params = [ - 's_selector', - 'e_filter_active', - 's_query', - 'accept_language' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + """ # noqa: E501 + + _param = self._branding_get_autocomplete_v2_serialize( + s_selector=s_selector, + e_filter_active=e_filter_active, + s_query=s_query, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "BrandingGetAutocompleteV2Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def branding_get_autocomplete_v2_without_preload_content( + self, + s_selector: Annotated[StrictStr, Field(description="The type of Brandings to return")], + e_filter_active: Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, + s_query: Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve Brandings and IDs + + Get the list of Branding to be used in a dropdown or autocomplete control. + + :param s_selector: The type of Brandings to return (required) + :type s_selector: str + :param e_filter_active: Specify which results we want to display. + :type e_filter_active: str + :param s_query: Allow to filter the returned results + :type s_query: str + :param accept_language: + :type accept_language: HeaderAcceptLanguage + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._branding_get_autocomplete_v2_serialize( + s_selector=s_selector, + e_filter_active=e_filter_active, + s_query=s_query, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method branding_get_autocomplete_v2" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "BrandingGetAutocompleteV2Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['s_selector']: - _path_params['sSelector'] = _params['s_selector'] + def _branding_get_autocomplete_v2_serialize( + self, + s_selector, + e_filter_active, + s_query, + accept_language, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None - # process the query parameters - _query_params = [] - if _params.get('e_filter_active') is not None: # noqa: E501 - _query_params.append(('eFilterActive', _params['e_filter_active'])) + _collection_formats: Dict[str, str] = { + } - if _params.get('s_query') is not None: # noqa: E501 - _query_params.append(('sQuery', _params['s_query'])) + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if s_selector is not None: + _path_params['sSelector'] = s_selector + # process the query parameters + if e_filter_active is not None: + + _query_params.append(('eFilterActive', e_filter_active)) + + if s_query is not None: + + _query_params.append(('sQuery', s_query)) + # process the header parameters - _header_params = dict(_params.get('_headers', {})) - if _params['accept_language']: - _header_params['Accept-Language'] = _params['accept_language'] - + if accept_language is not None: + _header_params['Accept-Language'] = accept_language # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "BrandingGetAutocompleteV2Response", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/2/object/branding/getAutocomplete/{sSelector}', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/2/object/branding/getAutocomplete/{sSelector}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + - @validate_arguments - def branding_get_list_v1(self, e_order_by : Annotated[Optional[StrictStr], Field(description="Specify how you want the results to be sorted")] = None, i_row_max : Optional[conint(strict=True, le=10000, ge=1)] = None, i_row_offset : Optional[conint(strict=True, ge=0)] = None, accept_language : Optional[HeaderAcceptLanguage] = None, s_filter : Optional[StrictStr] = None, **kwargs) -> BrandingGetListV1Response: # noqa: E501 - """Retrieve Branding list # noqa: E501 - Enum values that can be filtered in query parameter *sFilter*: | Variable | Valid values | |---|---| | eBrandingLogo | Default
JPEG
PNG | # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def branding_get_list_v1( + self, + e_order_by: Annotated[Optional[StrictStr], Field(description="Specify how you want the results to be sorted")] = None, + i_row_max: Optional[Annotated[int, Field(le=10000, strict=True, ge=1)]] = None, + i_row_offset: Optional[Annotated[int, Field(strict=True, ge=0)]] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + s_filter: Optional[StrictStr] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> BrandingGetListV1Response: + """Retrieve Branding list - >>> thread = api.branding_get_list_v1(e_order_by, i_row_max, i_row_offset, accept_language, s_filter, async_req=True) - >>> result = thread.get() + Enum values that can be filtered in query parameter *sFilter*: | Variable | Valid values | |---|---| | eBrandingLogo | Default
JPEG
PNG | :param e_order_by: Specify how you want the results to be sorted :type e_order_by: str @@ -541,33 +959,79 @@ def branding_get_list_v1(self, e_order_by : Annotated[Optional[StrictStr], Field :type accept_language: HeaderAcceptLanguage :param s_filter: :type s_filter: str - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: BrandingGetListV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the branding_get_list_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.branding_get_list_v1_with_http_info(e_order_by, i_row_max, i_row_offset, accept_language, s_filter, **kwargs) # noqa: E501 - - @validate_arguments - def branding_get_list_v1_with_http_info(self, e_order_by : Annotated[Optional[StrictStr], Field(description="Specify how you want the results to be sorted")] = None, i_row_max : Optional[conint(strict=True, le=10000, ge=1)] = None, i_row_offset : Optional[conint(strict=True, ge=0)] = None, accept_language : Optional[HeaderAcceptLanguage] = None, s_filter : Optional[StrictStr] = None, **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve Branding list # noqa: E501 - - Enum values that can be filtered in query parameter *sFilter*: | Variable | Valid values | |---|---| | eBrandingLogo | Default
JPEG
PNG | # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.branding_get_list_v1_with_http_info(e_order_by, i_row_max, i_row_offset, accept_language, s_filter, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._branding_get_list_v1_serialize( + e_order_by=e_order_by, + i_row_max=i_row_max, + i_row_offset=i_row_offset, + accept_language=accept_language, + s_filter=s_filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "BrandingGetListV1Response", + '406': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def branding_get_list_v1_with_http_info( + self, + e_order_by: Annotated[Optional[StrictStr], Field(description="Specify how you want the results to be sorted")] = None, + i_row_max: Optional[Annotated[int, Field(le=10000, strict=True, ge=1)]] = None, + i_row_offset: Optional[Annotated[int, Field(strict=True, ge=0)]] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + s_filter: Optional[StrictStr] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[BrandingGetListV1Response]: + """Retrieve Branding list + + Enum values that can be filtered in query parameter *sFilter*: | Variable | Valid values | |---|---| | eBrandingLogo | Default
JPEG
PNG | :param e_order_by: Specify how you want the results to be sorted :type e_order_by: str @@ -579,257 +1043,473 @@ def branding_get_list_v1_with_http_info(self, e_order_by : Annotated[Optional[St :type accept_language: HeaderAcceptLanguage :param s_filter: :type s_filter: str - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(BrandingGetListV1Response, status_code(int), headers(HTTPHeaderDict)) - """ - - _params = locals() - - _all_params = [ - 'e_order_by', - 'i_row_max', - 'i_row_offset', - 'accept_language', - 's_filter' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' - ] + """ # noqa: E501 + + _param = self._branding_get_list_v1_serialize( + e_order_by=e_order_by, + i_row_max=i_row_max, + i_row_offset=i_row_offset, + accept_language=accept_language, + s_filter=s_filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method branding_get_list_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "BrandingGetListV1Response", + '406': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _collection_formats = {} - # process the path parameters - _path_params = {} + @validate_call + def branding_get_list_v1_without_preload_content( + self, + e_order_by: Annotated[Optional[StrictStr], Field(description="Specify how you want the results to be sorted")] = None, + i_row_max: Optional[Annotated[int, Field(le=10000, strict=True, ge=1)]] = None, + i_row_offset: Optional[Annotated[int, Field(strict=True, ge=0)]] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + s_filter: Optional[StrictStr] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve Branding list - # process the query parameters - _query_params = [] - if _params.get('e_order_by') is not None: # noqa: E501 - _query_params.append(('eOrderBy', _params['e_order_by'])) + Enum values that can be filtered in query parameter *sFilter*: | Variable | Valid values | |---|---| | eBrandingLogo | Default
JPEG
PNG | + + :param e_order_by: Specify how you want the results to be sorted + :type e_order_by: str + :param i_row_max: + :type i_row_max: int + :param i_row_offset: + :type i_row_offset: int + :param accept_language: + :type accept_language: HeaderAcceptLanguage + :param s_filter: + :type s_filter: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._branding_get_list_v1_serialize( + e_order_by=e_order_by, + i_row_max=i_row_max, + i_row_offset=i_row_offset, + accept_language=accept_language, + s_filter=s_filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "BrandingGetListV1Response", + '406': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - if _params.get('i_row_max') is not None: # noqa: E501 - _query_params.append(('iRowMax', _params['i_row_max'])) - if _params.get('i_row_offset') is not None: # noqa: E501 - _query_params.append(('iRowOffset', _params['i_row_offset'])) + def _branding_get_list_v1_serialize( + self, + e_order_by, + i_row_max, + i_row_offset, + accept_language, + s_filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: - if _params.get('s_filter') is not None: # noqa: E501 - _query_params.append(('sFilter', _params['s_filter'])) + _host = None - # process the header parameters - _header_params = dict(_params.get('_headers', {})) - if _params['accept_language']: - _header_params['Accept-Language'] = _params['accept_language'] + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if e_order_by is not None: + + _query_params.append(('eOrderBy', e_order_by)) + + if i_row_max is not None: + + _query_params.append(('iRowMax', i_row_max)) + + if i_row_offset is not None: + + _query_params.append(('iRowOffset', i_row_offset)) + + if s_filter is not None: + + _query_params.append(('sFilter', s_filter)) + + # process the header parameters + if accept_language is not None: + _header_params['Accept-Language'] = accept_language # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet']) # noqa: E501 + [ + 'application/json', + 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "BrandingGetListV1Response", - '406': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/branding/getList', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/1/object/branding/getList', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + - @validate_arguments - def branding_get_object_v2(self, pki_branding_id : conint(strict=True, ge=0), **kwargs) -> BrandingGetObjectV2Response: # noqa: E501 - """Retrieve an existing Branding # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.branding_get_object_v2(pki_branding_id, async_req=True) - >>> result = thread.get() + @validate_call + def branding_get_object_v2( + self, + pki_branding_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> BrandingGetObjectV2Response: + """Retrieve an existing Branding + + :param pki_branding_id: (required) :type pki_branding_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: BrandingGetObjectV2Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the branding_get_object_v2_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.branding_get_object_v2_with_http_info(pki_branding_id, **kwargs) # noqa: E501 - - @validate_arguments - def branding_get_object_v2_with_http_info(self, pki_branding_id : conint(strict=True, ge=0), **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve an existing Branding # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.branding_get_object_v2_with_http_info(pki_branding_id, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._branding_get_object_v2_serialize( + pki_branding_id=pki_branding_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "BrandingGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def branding_get_object_v2_with_http_info( + self, + pki_branding_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[BrandingGetObjectV2Response]: + """Retrieve an existing Branding + + :param pki_branding_id: (required) :type pki_branding_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(BrandingGetObjectV2Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._branding_get_object_v2_serialize( + pki_branding_id=pki_branding_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '200': "BrandingGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'pki_branding_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def branding_get_object_v2_without_preload_content( + self, + pki_branding_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve an existing Branding + + + + :param pki_branding_id: (required) + :type pki_branding_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._branding_get_object_v2_serialize( + pki_branding_id=pki_branding_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method branding_get_object_v2" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "BrandingGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_branding_id']: - _path_params['pkiBrandingID'] = _params['pki_branding_id'] + def _branding_get_object_v2_serialize( + self, + pki_branding_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_branding_id is not None: + _path_params['pkiBrandingID'] = pki_branding_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "BrandingGetObjectV2Response", - '404': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/2/object/branding/{pkiBrandingID}', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/2/object/branding/{pkiBrandingID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/eZmaxApi/api/object_buyercontract_api.py b/eZmaxApi/api/object_buyercontract_api.py index acb77734d..de24183e3 100644 --- a/eZmaxApi/api/object_buyercontract_api.py +++ b/eZmaxApi/api/object_buyercontract_api.py @@ -13,22 +13,24 @@ """ # noqa: E501 -import re # noqa: F401 import io import warnings -from pydantic import validate_arguments, ValidationError +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Dict, List, Optional, Tuple, Union, Any -from pydantic import conint +try: + from typing import Annotated +except ImportError: + from typing_extensions import Annotated +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.buyercontract_get_communication_list_v1_response import BuyercontractGetCommunicationListV1Response from eZmaxApi.api_client import ApiClient from eZmaxApi.api_response import ApiResponse -from eZmaxApi.exceptions import ( # noqa: F401 - ApiTypeError, - ApiValueError -) +from eZmaxApi.rest import RESTResponseType class ObjectBuyercontractApi: @@ -43,143 +45,263 @@ def __init__(self, api_client=None) -> None: api_client = ApiClient.get_default() self.api_client = api_client - @validate_arguments - def buyercontract_get_communication_list_v1(self, pki_buyercontract_id : conint(strict=True, le=65535, ge=1), **kwargs) -> BuyercontractGetCommunicationListV1Response: # noqa: E501 - """Retrieve Communication list # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def buyercontract_get_communication_list_v1( + self, + pki_buyercontract_id: Annotated[int, Field(le=65535, strict=True, ge=1)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> BuyercontractGetCommunicationListV1Response: + """Retrieve Communication list - >>> thread = api.buyercontract_get_communication_list_v1(pki_buyercontract_id, async_req=True) - >>> result = thread.get() + :param pki_buyercontract_id: (required) :type pki_buyercontract_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: BuyercontractGetCommunicationListV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the buyercontract_get_communication_list_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.buyercontract_get_communication_list_v1_with_http_info(pki_buyercontract_id, **kwargs) # noqa: E501 - - @validate_arguments - def buyercontract_get_communication_list_v1_with_http_info(self, pki_buyercontract_id : conint(strict=True, le=65535, ge=1), **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve Communication list # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.buyercontract_get_communication_list_v1_with_http_info(pki_buyercontract_id, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._buyercontract_get_communication_list_v1_serialize( + pki_buyercontract_id=pki_buyercontract_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "BuyercontractGetCommunicationListV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def buyercontract_get_communication_list_v1_with_http_info( + self, + pki_buyercontract_id: Annotated[int, Field(le=65535, strict=True, ge=1)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[BuyercontractGetCommunicationListV1Response]: + """Retrieve Communication list + + :param pki_buyercontract_id: (required) :type pki_buyercontract_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(BuyercontractGetCommunicationListV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._buyercontract_get_communication_list_v1_serialize( + pki_buyercontract_id=pki_buyercontract_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '200': "BuyercontractGetCommunicationListV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'pki_buyercontract_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def buyercontract_get_communication_list_v1_without_preload_content( + self, + pki_buyercontract_id: Annotated[int, Field(le=65535, strict=True, ge=1)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve Communication list + + + + :param pki_buyercontract_id: (required) + :type pki_buyercontract_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._buyercontract_get_communication_list_v1_serialize( + pki_buyercontract_id=pki_buyercontract_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method buyercontract_get_communication_list_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "BuyercontractGetCommunicationListV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_buyercontract_id']: - _path_params['pkiBuyercontractID'] = _params['pki_buyercontract_id'] + def _buyercontract_get_communication_list_v1_serialize( + self, + pki_buyercontract_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_buyercontract_id is not None: + _path_params['pkiBuyercontractID'] = pki_buyercontract_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "BuyercontractGetCommunicationListV1Response", - '404': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/buyercontract/{pkiBuyercontractID}/getCommunicationList', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/1/object/buyercontract/{pkiBuyercontractID}/getCommunicationList', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/eZmaxApi/api/object_clonehistory_api.py b/eZmaxApi/api/object_clonehistory_api.py index e6e33d591..4e1b2b26b 100644 --- a/eZmaxApi/api/object_clonehistory_api.py +++ b/eZmaxApi/api/object_clonehistory_api.py @@ -13,14 +13,20 @@ """ # noqa: E501 -import re # noqa: F401 import io import warnings -from pydantic import validate_arguments, ValidationError +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Dict, List, Optional, Tuple, Union, Any +try: + from typing import Annotated +except ImportError: + from typing_extensions import Annotated + +from pydantic import Field from typing_extensions import Annotated -from pydantic import Field, StrictStr, conint +from pydantic import StrictStr, field_validator from typing import Optional @@ -29,10 +35,7 @@ from eZmaxApi.api_client import ApiClient from eZmaxApi.api_response import ApiResponse -from eZmaxApi.exceptions import ( # noqa: F401 - ApiTypeError, - ApiValueError -) +from eZmaxApi.rest import RESTResponseType class ObjectClonehistoryApi: @@ -47,16 +50,31 @@ def __init__(self, api_client=None) -> None: api_client = ApiClient.get_default() self.api_client = api_client - @validate_arguments - def clonehistory_get_list_v1(self, e_order_by : Annotated[Optional[StrictStr], Field(description="Specify how you want the results to be sorted")] = None, i_row_max : Optional[conint(strict=True, le=10000, ge=1)] = None, i_row_offset : Optional[conint(strict=True, ge=0)] = None, accept_language : Optional[HeaderAcceptLanguage] = None, s_filter : Optional[StrictStr] = None, **kwargs) -> ClonehistoryGetListV1Response: # noqa: E501 - """Retrieve Clonehistory list # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def clonehistory_get_list_v1( + self, + e_order_by: Annotated[Optional[StrictStr], Field(description="Specify how you want the results to be sorted")] = None, + i_row_max: Optional[Annotated[int, Field(le=10000, strict=True, ge=1)]] = None, + i_row_offset: Optional[Annotated[int, Field(strict=True, ge=0)]] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + s_filter: Optional[StrictStr] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ClonehistoryGetListV1Response: + """Retrieve Clonehistory list - >>> thread = api.clonehistory_get_list_v1(e_order_by, i_row_max, i_row_offset, accept_language, s_filter, async_req=True) - >>> result = thread.get() + :param e_order_by: Specify how you want the results to be sorted :type e_order_by: str @@ -68,33 +86,79 @@ def clonehistory_get_list_v1(self, e_order_by : Annotated[Optional[StrictStr], F :type accept_language: HeaderAcceptLanguage :param s_filter: :type s_filter: str - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: ClonehistoryGetListV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the clonehistory_get_list_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.clonehistory_get_list_v1_with_http_info(e_order_by, i_row_max, i_row_offset, accept_language, s_filter, **kwargs) # noqa: E501 - - @validate_arguments - def clonehistory_get_list_v1_with_http_info(self, e_order_by : Annotated[Optional[StrictStr], Field(description="Specify how you want the results to be sorted")] = None, i_row_max : Optional[conint(strict=True, le=10000, ge=1)] = None, i_row_offset : Optional[conint(strict=True, ge=0)] = None, accept_language : Optional[HeaderAcceptLanguage] = None, s_filter : Optional[StrictStr] = None, **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve Clonehistory list # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.clonehistory_get_list_v1_with_http_info(e_order_by, i_row_max, i_row_offset, accept_language, s_filter, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._clonehistory_get_list_v1_serialize( + e_order_by=e_order_by, + i_row_max=i_row_max, + i_row_offset=i_row_offset, + accept_language=accept_language, + s_filter=s_filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ClonehistoryGetListV1Response", + '406': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def clonehistory_get_list_v1_with_http_info( + self, + e_order_by: Annotated[Optional[StrictStr], Field(description="Specify how you want the results to be sorted")] = None, + i_row_max: Optional[Annotated[int, Field(le=10000, strict=True, ge=1)]] = None, + i_row_offset: Optional[Annotated[int, Field(strict=True, ge=0)]] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + s_filter: Optional[StrictStr] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ClonehistoryGetListV1Response]: + """Retrieve Clonehistory list + + :param e_order_by: Specify how you want the results to be sorted :type e_order_by: str @@ -106,116 +170,212 @@ def clonehistory_get_list_v1_with_http_info(self, e_order_by : Annotated[Optiona :type accept_language: HeaderAcceptLanguage :param s_filter: :type s_filter: str - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(ClonehistoryGetListV1Response, status_code(int), headers(HTTPHeaderDict)) - """ - - _params = locals() - - _all_params = [ - 'e_order_by', - 'i_row_max', - 'i_row_offset', - 'accept_language', - 's_filter' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' - ] + """ # noqa: E501 + + _param = self._clonehistory_get_list_v1_serialize( + e_order_by=e_order_by, + i_row_max=i_row_max, + i_row_offset=i_row_offset, + accept_language=accept_language, + s_filter=s_filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method clonehistory_get_list_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "ClonehistoryGetListV1Response", + '406': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _collection_formats = {} - # process the path parameters - _path_params = {} + @validate_call + def clonehistory_get_list_v1_without_preload_content( + self, + e_order_by: Annotated[Optional[StrictStr], Field(description="Specify how you want the results to be sorted")] = None, + i_row_max: Optional[Annotated[int, Field(le=10000, strict=True, ge=1)]] = None, + i_row_offset: Optional[Annotated[int, Field(strict=True, ge=0)]] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + s_filter: Optional[StrictStr] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve Clonehistory list - # process the query parameters - _query_params = [] - if _params.get('e_order_by') is not None: # noqa: E501 - _query_params.append(('eOrderBy', _params['e_order_by'])) + + + :param e_order_by: Specify how you want the results to be sorted + :type e_order_by: str + :param i_row_max: + :type i_row_max: int + :param i_row_offset: + :type i_row_offset: int + :param accept_language: + :type accept_language: HeaderAcceptLanguage + :param s_filter: + :type s_filter: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._clonehistory_get_list_v1_serialize( + e_order_by=e_order_by, + i_row_max=i_row_max, + i_row_offset=i_row_offset, + accept_language=accept_language, + s_filter=s_filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - if _params.get('i_row_max') is not None: # noqa: E501 - _query_params.append(('iRowMax', _params['i_row_max'])) + _response_types_map: Dict[str, Optional[str]] = { + '200': "ClonehistoryGetListV1Response", + '406': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - if _params.get('i_row_offset') is not None: # noqa: E501 - _query_params.append(('iRowOffset', _params['i_row_offset'])) - if _params.get('s_filter') is not None: # noqa: E501 - _query_params.append(('sFilter', _params['s_filter'])) + def _clonehistory_get_list_v1_serialize( + self, + e_order_by, + i_row_max, + i_row_offset, + accept_language, + s_filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: - # process the header parameters - _header_params = dict(_params.get('_headers', {})) - if _params['accept_language']: - _header_params['Accept-Language'] = _params['accept_language'] + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + # process the query parameters + if e_order_by is not None: + + _query_params.append(('eOrderBy', e_order_by)) + + if i_row_max is not None: + + _query_params.append(('iRowMax', i_row_max)) + + if i_row_offset is not None: + + _query_params.append(('iRowOffset', i_row_offset)) + + if s_filter is not None: + + _query_params.append(('sFilter', s_filter)) + + # process the header parameters + if accept_language is not None: + _header_params['Accept-Language'] = accept_language # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet']) # noqa: E501 + [ + 'application/json', + 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "ClonehistoryGetListV1Response", - '406': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/clonehistory/getList', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/1/object/clonehistory/getList', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/eZmaxApi/api/object_communication_api.py b/eZmaxApi/api/object_communication_api.py index bb38d7dad..ebb5ffac1 100644 --- a/eZmaxApi/api/object_communication_api.py +++ b/eZmaxApi/api/object_communication_api.py @@ -13,21 +13,23 @@ """ # noqa: E501 -import re # noqa: F401 import io import warnings -from pydantic import validate_arguments, ValidationError +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Dict, List, Optional, Tuple, Union, Any + +try: + from typing import Annotated +except ImportError: + from typing_extensions import Annotated from eZmaxApi.models.communication_send_v1_request import CommunicationSendV1Request from eZmaxApi.models.communication_send_v1_response import CommunicationSendV1Response from eZmaxApi.api_client import ApiClient from eZmaxApi.api_response import ApiResponse -from eZmaxApi.exceptions import ( # noqa: F401 - ApiTypeError, - ApiValueError -) +from eZmaxApi.rest import RESTResponseType class ObjectCommunicationApi: @@ -42,149 +44,273 @@ def __init__(self, api_client=None) -> None: api_client = ApiClient.get_default() self.api_client = api_client - @validate_arguments - def communication_send_v1(self, communication_send_v1_request : CommunicationSendV1Request, **kwargs) -> CommunicationSendV1Response: # noqa: E501 - """Send a new Communication # noqa: E501 - The endpoint allows to send one or many elements at once. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def communication_send_v1( + self, + communication_send_v1_request: CommunicationSendV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> CommunicationSendV1Response: + """Send a new Communication - >>> thread = api.communication_send_v1(communication_send_v1_request, async_req=True) - >>> result = thread.get() + The endpoint allows to send one or many elements at once. :param communication_send_v1_request: (required) :type communication_send_v1_request: CommunicationSendV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: CommunicationSendV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the communication_send_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.communication_send_v1_with_http_info(communication_send_v1_request, **kwargs) # noqa: E501 - - @validate_arguments - def communication_send_v1_with_http_info(self, communication_send_v1_request : CommunicationSendV1Request, **kwargs) -> ApiResponse: # noqa: E501 - """Send a new Communication # noqa: E501 - - The endpoint allows to send one or many elements at once. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.communication_send_v1_with_http_info(communication_send_v1_request, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._communication_send_v1_serialize( + communication_send_v1_request=communication_send_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "CommunicationSendV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def communication_send_v1_with_http_info( + self, + communication_send_v1_request: CommunicationSendV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[CommunicationSendV1Response]: + """Send a new Communication + + The endpoint allows to send one or many elements at once. :param communication_send_v1_request: (required) :type communication_send_v1_request: CommunicationSendV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(CommunicationSendV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._communication_send_v1_serialize( + communication_send_v1_request=communication_send_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '201': "CommunicationSendV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'communication_send_v1_request' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def communication_send_v1_without_preload_content( + self, + communication_send_v1_request: CommunicationSendV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Send a new Communication + + The endpoint allows to send one or many elements at once. + + :param communication_send_v1_request: (required) + :type communication_send_v1_request: CommunicationSendV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._communication_send_v1_serialize( + communication_send_v1_request=communication_send_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method communication_send_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '201': "CommunicationSendV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} + def _communication_send_v1_serialize( + self, + communication_send_v1_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['communication_send_v1_request'] is not None: - _body_params = _params['communication_send_v1_request'] + if communication_send_v1_request is not None: + _body_params = communication_send_v1_request + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '201': "CommunicationSendV1Response", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/communication/send', 'POST', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='POST', + resource_path='/1/object/communication/send', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/eZmaxApi/api/object_company_api.py b/eZmaxApi/api/object_company_api.py index 2cbaab460..86d1d0ce2 100644 --- a/eZmaxApi/api/object_company_api.py +++ b/eZmaxApi/api/object_company_api.py @@ -13,14 +13,20 @@ """ # noqa: E501 -import re # noqa: F401 import io import warnings -from pydantic import validate_arguments, ValidationError +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Dict, List, Optional, Tuple, Union, Any +try: + from typing import Annotated +except ImportError: + from typing_extensions import Annotated + +from pydantic import Field from typing_extensions import Annotated -from pydantic import Field, StrictStr +from pydantic import StrictStr, field_validator from typing import Optional @@ -29,10 +35,7 @@ from eZmaxApi.api_client import ApiClient from eZmaxApi.api_response import ApiResponse -from eZmaxApi.exceptions import ( # noqa: F401 - ApiTypeError, - ApiValueError -) +from eZmaxApi.rest import RESTResponseType class ObjectCompanyApi: @@ -47,16 +50,30 @@ def __init__(self, api_client=None) -> None: api_client = ApiClient.get_default() self.api_client = api_client - @validate_arguments - def company_get_autocomplete_v2(self, s_selector : Annotated[StrictStr, Field(..., description="The type of Companys to return")], e_filter_active : Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, s_query : Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, accept_language : Optional[HeaderAcceptLanguage] = None, **kwargs) -> CompanyGetAutocompleteV2Response: # noqa: E501 - """Retrieve Companys and IDs # noqa: E501 - Get the list of Company to be used in a dropdown or autocomplete control. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def company_get_autocomplete_v2( + self, + s_selector: Annotated[StrictStr, Field(description="The type of Companys to return")], + e_filter_active: Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, + s_query: Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> CompanyGetAutocompleteV2Response: + """Retrieve Companys and IDs - >>> thread = api.company_get_autocomplete_v2(s_selector, e_filter_active, s_query, accept_language, async_req=True) - >>> result = thread.get() + Get the list of Company to be used in a dropdown or autocomplete control. :param s_selector: The type of Companys to return (required) :type s_selector: str @@ -66,33 +83,76 @@ def company_get_autocomplete_v2(self, s_selector : Annotated[StrictStr, Field(.. :type s_query: str :param accept_language: :type accept_language: HeaderAcceptLanguage - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: CompanyGetAutocompleteV2Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the company_get_autocomplete_v2_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.company_get_autocomplete_v2_with_http_info(s_selector, e_filter_active, s_query, accept_language, **kwargs) # noqa: E501 - - @validate_arguments - def company_get_autocomplete_v2_with_http_info(self, s_selector : Annotated[StrictStr, Field(..., description="The type of Companys to return")], e_filter_active : Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, s_query : Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, accept_language : Optional[HeaderAcceptLanguage] = None, **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve Companys and IDs # noqa: E501 - - Get the list of Company to be used in a dropdown or autocomplete control. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.company_get_autocomplete_v2_with_http_info(s_selector, e_filter_active, s_query, accept_language, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._company_get_autocomplete_v2_serialize( + s_selector=s_selector, + e_filter_active=e_filter_active, + s_query=s_query, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "CompanyGetAutocompleteV2Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def company_get_autocomplete_v2_with_http_info( + self, + s_selector: Annotated[StrictStr, Field(description="The type of Companys to return")], + e_filter_active: Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, + s_query: Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[CompanyGetAutocompleteV2Response]: + """Retrieve Companys and IDs + + Get the list of Company to be used in a dropdown or autocomplete control. :param s_selector: The type of Companys to return (required) :type s_selector: str @@ -102,111 +162,197 @@ def company_get_autocomplete_v2_with_http_info(self, s_selector : Annotated[Stri :type s_query: str :param accept_language: :type accept_language: HeaderAcceptLanguage - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(CompanyGetAutocompleteV2Response, status_code(int), headers(HTTPHeaderDict)) - """ - - _params = locals() - - _all_params = [ - 's_selector', - 'e_filter_active', - 's_query', - 'accept_language' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + """ # noqa: E501 + + _param = self._company_get_autocomplete_v2_serialize( + s_selector=s_selector, + e_filter_active=e_filter_active, + s_query=s_query, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "CompanyGetAutocompleteV2Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def company_get_autocomplete_v2_without_preload_content( + self, + s_selector: Annotated[StrictStr, Field(description="The type of Companys to return")], + e_filter_active: Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, + s_query: Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve Companys and IDs + + Get the list of Company to be used in a dropdown or autocomplete control. + + :param s_selector: The type of Companys to return (required) + :type s_selector: str + :param e_filter_active: Specify which results we want to display. + :type e_filter_active: str + :param s_query: Allow to filter the returned results + :type s_query: str + :param accept_language: + :type accept_language: HeaderAcceptLanguage + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._company_get_autocomplete_v2_serialize( + s_selector=s_selector, + e_filter_active=e_filter_active, + s_query=s_query, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method company_get_autocomplete_v2" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "CompanyGetAutocompleteV2Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['s_selector']: - _path_params['sSelector'] = _params['s_selector'] + def _company_get_autocomplete_v2_serialize( + self, + s_selector, + e_filter_active, + s_query, + accept_language, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None - # process the query parameters - _query_params = [] - if _params.get('e_filter_active') is not None: # noqa: E501 - _query_params.append(('eFilterActive', _params['e_filter_active'])) + _collection_formats: Dict[str, str] = { + } - if _params.get('s_query') is not None: # noqa: E501 - _query_params.append(('sQuery', _params['s_query'])) + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if s_selector is not None: + _path_params['sSelector'] = s_selector + # process the query parameters + if e_filter_active is not None: + + _query_params.append(('eFilterActive', e_filter_active)) + + if s_query is not None: + + _query_params.append(('sQuery', s_query)) + # process the header parameters - _header_params = dict(_params.get('_headers', {})) - if _params['accept_language']: - _header_params['Accept-Language'] = _params['accept_language'] - + if accept_language is not None: + _header_params['Accept-Language'] = accept_language # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "CompanyGetAutocompleteV2Response", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/2/object/company/getAutocomplete/{sSelector}', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/2/object/company/getAutocomplete/{sSelector}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/eZmaxApi/api/object_cors_api.py b/eZmaxApi/api/object_cors_api.py index b6f667ee8..1ba3e4686 100644 --- a/eZmaxApi/api/object_cors_api.py +++ b/eZmaxApi/api/object_cors_api.py @@ -13,15 +13,19 @@ """ # noqa: E501 -import re # noqa: F401 import io import warnings -from pydantic import validate_arguments, ValidationError +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Dict, List, Optional, Tuple, Union, Any -from typing_extensions import Annotated -from pydantic import Field, conint +try: + from typing import Annotated +except ImportError: + from typing_extensions import Annotated +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.cors_create_object_v1_request import CorsCreateObjectV1Request from eZmaxApi.models.cors_create_object_v1_response import CorsCreateObjectV1Response from eZmaxApi.models.cors_delete_object_v1_response import CorsDeleteObjectV1Response @@ -31,10 +35,7 @@ from eZmaxApi.api_client import ApiClient from eZmaxApi.api_response import ApiResponse -from eZmaxApi.exceptions import ( # noqa: F401 - ApiTypeError, - ApiValueError -) +from eZmaxApi.rest import RESTResponseType class ObjectCorsApi: @@ -49,588 +50,1087 @@ def __init__(self, api_client=None) -> None: api_client = ApiClient.get_default() self.api_client = api_client - @validate_arguments - def cors_create_object_v1(self, cors_create_object_v1_request : CorsCreateObjectV1Request, **kwargs) -> CorsCreateObjectV1Response: # noqa: E501 - """Create a new Cors # noqa: E501 - The endpoint allows to create one or many elements at once. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def cors_create_object_v1( + self, + cors_create_object_v1_request: CorsCreateObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> CorsCreateObjectV1Response: + """Create a new Cors - >>> thread = api.cors_create_object_v1(cors_create_object_v1_request, async_req=True) - >>> result = thread.get() + The endpoint allows to create one or many elements at once. :param cors_create_object_v1_request: (required) :type cors_create_object_v1_request: CorsCreateObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: CorsCreateObjectV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the cors_create_object_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.cors_create_object_v1_with_http_info(cors_create_object_v1_request, **kwargs) # noqa: E501 - - @validate_arguments - def cors_create_object_v1_with_http_info(self, cors_create_object_v1_request : CorsCreateObjectV1Request, **kwargs) -> ApiResponse: # noqa: E501 - """Create a new Cors # noqa: E501 - - The endpoint allows to create one or many elements at once. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.cors_create_object_v1_with_http_info(cors_create_object_v1_request, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._cors_create_object_v1_serialize( + cors_create_object_v1_request=cors_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "CorsCreateObjectV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def cors_create_object_v1_with_http_info( + self, + cors_create_object_v1_request: CorsCreateObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[CorsCreateObjectV1Response]: + """Create a new Cors + + The endpoint allows to create one or many elements at once. :param cors_create_object_v1_request: (required) :type cors_create_object_v1_request: CorsCreateObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(CorsCreateObjectV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._cors_create_object_v1_serialize( + cors_create_object_v1_request=cors_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '201': "CorsCreateObjectV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'cors_create_object_v1_request' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def cors_create_object_v1_without_preload_content( + self, + cors_create_object_v1_request: CorsCreateObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Create a new Cors + + The endpoint allows to create one or many elements at once. + + :param cors_create_object_v1_request: (required) + :type cors_create_object_v1_request: CorsCreateObjectV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._cors_create_object_v1_serialize( + cors_create_object_v1_request=cors_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method cors_create_object_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '201': "CorsCreateObjectV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} + def _cors_create_object_v1_serialize( + self, + cors_create_object_v1_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['cors_create_object_v1_request'] is not None: - _body_params = _params['cors_create_object_v1_request'] + if cors_create_object_v1_request is not None: + _body_params = cors_create_object_v1_request + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '201': "CorsCreateObjectV1Response", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/cors', 'POST', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='POST', + resource_path='/1/object/cors', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) - @validate_arguments - def cors_delete_object_v1(self, pki_cors_id : Annotated[conint(strict=True, le=65535, ge=0), Field(..., description="The unique ID of the Cors")], **kwargs) -> CorsDeleteObjectV1Response: # noqa: E501 - """Delete an existing Cors # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.cors_delete_object_v1(pki_cors_id, async_req=True) - >>> result = thread.get() + + @validate_call + def cors_delete_object_v1( + self, + pki_cors_id: Annotated[int, Field(le=65535, strict=True, ge=0, description="The unique ID of the Cors")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> CorsDeleteObjectV1Response: + """Delete an existing Cors + + :param pki_cors_id: The unique ID of the Cors (required) :type pki_cors_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: CorsDeleteObjectV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the cors_delete_object_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.cors_delete_object_v1_with_http_info(pki_cors_id, **kwargs) # noqa: E501 - - @validate_arguments - def cors_delete_object_v1_with_http_info(self, pki_cors_id : Annotated[conint(strict=True, le=65535, ge=0), Field(..., description="The unique ID of the Cors")], **kwargs) -> ApiResponse: # noqa: E501 - """Delete an existing Cors # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.cors_delete_object_v1_with_http_info(pki_cors_id, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._cors_delete_object_v1_serialize( + pki_cors_id=pki_cors_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "CorsDeleteObjectV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def cors_delete_object_v1_with_http_info( + self, + pki_cors_id: Annotated[int, Field(le=65535, strict=True, ge=0, description="The unique ID of the Cors")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[CorsDeleteObjectV1Response]: + """Delete an existing Cors + + :param pki_cors_id: The unique ID of the Cors (required) :type pki_cors_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(CorsDeleteObjectV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._cors_delete_object_v1_serialize( + pki_cors_id=pki_cors_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "CorsDeleteObjectV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _params = locals() - _all_params = [ - 'pki_cors_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + @validate_call + def cors_delete_object_v1_without_preload_content( + self, + pki_cors_id: Annotated[int, Field(le=65535, strict=True, ge=0, description="The unique ID of the Cors")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete an existing Cors + + + + :param pki_cors_id: The unique ID of the Cors (required) + :type pki_cors_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._cors_delete_object_v1_serialize( + pki_cors_id=pki_cors_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method cors_delete_object_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "CorsDeleteObjectV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_cors_id']: - _path_params['pkiCorsID'] = _params['pki_cors_id'] + def _cors_delete_object_v1_serialize( + self, + pki_cors_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_cors_id is not None: + _path_params['pkiCorsID'] = pki_cors_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "CorsDeleteObjectV1Response", - '404': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/cors/{pkiCorsID}', 'DELETE', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='DELETE', + resource_path='/1/object/cors/{pkiCorsID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + - @validate_arguments - def cors_edit_object_v1(self, pki_cors_id : Annotated[conint(strict=True, le=65535, ge=0), Field(..., description="The unique ID of the Cors")], cors_edit_object_v1_request : CorsEditObjectV1Request, **kwargs) -> CorsEditObjectV1Response: # noqa: E501 - """Edit an existing Cors # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.cors_edit_object_v1(pki_cors_id, cors_edit_object_v1_request, async_req=True) - >>> result = thread.get() + @validate_call + def cors_edit_object_v1( + self, + pki_cors_id: Annotated[int, Field(le=65535, strict=True, ge=0, description="The unique ID of the Cors")], + cors_edit_object_v1_request: CorsEditObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> CorsEditObjectV1Response: + """Edit an existing Cors + + :param pki_cors_id: The unique ID of the Cors (required) :type pki_cors_id: int :param cors_edit_object_v1_request: (required) :type cors_edit_object_v1_request: CorsEditObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: CorsEditObjectV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the cors_edit_object_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.cors_edit_object_v1_with_http_info(pki_cors_id, cors_edit_object_v1_request, **kwargs) # noqa: E501 - - @validate_arguments - def cors_edit_object_v1_with_http_info(self, pki_cors_id : Annotated[conint(strict=True, le=65535, ge=0), Field(..., description="The unique ID of the Cors")], cors_edit_object_v1_request : CorsEditObjectV1Request, **kwargs) -> ApiResponse: # noqa: E501 - """Edit an existing Cors # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.cors_edit_object_v1_with_http_info(pki_cors_id, cors_edit_object_v1_request, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._cors_edit_object_v1_serialize( + pki_cors_id=pki_cors_id, + cors_edit_object_v1_request=cors_edit_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "CorsEditObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def cors_edit_object_v1_with_http_info( + self, + pki_cors_id: Annotated[int, Field(le=65535, strict=True, ge=0, description="The unique ID of the Cors")], + cors_edit_object_v1_request: CorsEditObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[CorsEditObjectV1Response]: + """Edit an existing Cors + + :param pki_cors_id: The unique ID of the Cors (required) :type pki_cors_id: int :param cors_edit_object_v1_request: (required) :type cors_edit_object_v1_request: CorsEditObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(CorsEditObjectV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._cors_edit_object_v1_serialize( + pki_cors_id=pki_cors_id, + cors_edit_object_v1_request=cors_edit_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "CorsEditObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _params = locals() - _all_params = [ - 'pki_cors_id', - 'cors_edit_object_v1_request' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + @validate_call + def cors_edit_object_v1_without_preload_content( + self, + pki_cors_id: Annotated[int, Field(le=65535, strict=True, ge=0, description="The unique ID of the Cors")], + cors_edit_object_v1_request: CorsEditObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Edit an existing Cors + + + + :param pki_cors_id: The unique ID of the Cors (required) + :type pki_cors_id: int + :param cors_edit_object_v1_request: (required) + :type cors_edit_object_v1_request: CorsEditObjectV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._cors_edit_object_v1_serialize( + pki_cors_id=pki_cors_id, + cors_edit_object_v1_request=cors_edit_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method cors_edit_object_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "CorsEditObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_cors_id']: - _path_params['pkiCorsID'] = _params['pki_cors_id'] + def _cors_edit_object_v1_serialize( + self, + pki_cors_id, + cors_edit_object_v1_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_cors_id is not None: + _path_params['pkiCorsID'] = pki_cors_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['cors_edit_object_v1_request'] is not None: - _body_params = _params['cors_edit_object_v1_request'] + if cors_edit_object_v1_request is not None: + _body_params = cors_edit_object_v1_request + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '200': "CorsEditObjectV1Response", - '404': "CommonResponseError", - '422': "CommonResponseError", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/cors/{pkiCorsID}', 'PUT', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='PUT', + resource_path='/1/object/cors/{pkiCorsID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + - @validate_arguments - def cors_get_object_v2(self, pki_cors_id : Annotated[conint(strict=True, le=65535, ge=0), Field(..., description="The unique ID of the Cors")], **kwargs) -> CorsGetObjectV2Response: # noqa: E501 - """Retrieve an existing Cors # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.cors_get_object_v2(pki_cors_id, async_req=True) - >>> result = thread.get() + @validate_call + def cors_get_object_v2( + self, + pki_cors_id: Annotated[int, Field(le=65535, strict=True, ge=0, description="The unique ID of the Cors")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> CorsGetObjectV2Response: + """Retrieve an existing Cors + + :param pki_cors_id: The unique ID of the Cors (required) :type pki_cors_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: CorsGetObjectV2Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the cors_get_object_v2_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.cors_get_object_v2_with_http_info(pki_cors_id, **kwargs) # noqa: E501 - - @validate_arguments - def cors_get_object_v2_with_http_info(self, pki_cors_id : Annotated[conint(strict=True, le=65535, ge=0), Field(..., description="The unique ID of the Cors")], **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve an existing Cors # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.cors_get_object_v2_with_http_info(pki_cors_id, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._cors_get_object_v2_serialize( + pki_cors_id=pki_cors_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "CorsGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def cors_get_object_v2_with_http_info( + self, + pki_cors_id: Annotated[int, Field(le=65535, strict=True, ge=0, description="The unique ID of the Cors")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[CorsGetObjectV2Response]: + """Retrieve an existing Cors + + :param pki_cors_id: The unique ID of the Cors (required) :type pki_cors_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(CorsGetObjectV2Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._cors_get_object_v2_serialize( + pki_cors_id=pki_cors_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '200': "CorsGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'pki_cors_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def cors_get_object_v2_without_preload_content( + self, + pki_cors_id: Annotated[int, Field(le=65535, strict=True, ge=0, description="The unique ID of the Cors")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve an existing Cors + + + + :param pki_cors_id: The unique ID of the Cors (required) + :type pki_cors_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._cors_get_object_v2_serialize( + pki_cors_id=pki_cors_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method cors_get_object_v2" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "CorsGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_cors_id']: - _path_params['pkiCorsID'] = _params['pki_cors_id'] + def _cors_get_object_v2_serialize( + self, + pki_cors_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_cors_id is not None: + _path_params['pkiCorsID'] = pki_cors_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "CorsGetObjectV2Response", - '404': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/2/object/cors/{pkiCorsID}', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/2/object/cors/{pkiCorsID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/eZmaxApi/api/object_department_api.py b/eZmaxApi/api/object_department_api.py index ffce80420..7a4de3519 100644 --- a/eZmaxApi/api/object_department_api.py +++ b/eZmaxApi/api/object_department_api.py @@ -13,14 +13,20 @@ """ # noqa: E501 -import re # noqa: F401 import io import warnings -from pydantic import validate_arguments, ValidationError +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Dict, List, Optional, Tuple, Union, Any +try: + from typing import Annotated +except ImportError: + from typing_extensions import Annotated + +from pydantic import Field from typing_extensions import Annotated -from pydantic import Field, StrictStr +from pydantic import StrictStr, field_validator from typing import Optional @@ -29,10 +35,7 @@ from eZmaxApi.api_client import ApiClient from eZmaxApi.api_response import ApiResponse -from eZmaxApi.exceptions import ( # noqa: F401 - ApiTypeError, - ApiValueError -) +from eZmaxApi.rest import RESTResponseType class ObjectDepartmentApi: @@ -47,16 +50,30 @@ def __init__(self, api_client=None) -> None: api_client = ApiClient.get_default() self.api_client = api_client - @validate_arguments - def department_get_autocomplete_v2(self, s_selector : Annotated[StrictStr, Field(..., description="The type of Departments to return")], e_filter_active : Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, s_query : Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, accept_language : Optional[HeaderAcceptLanguage] = None, **kwargs) -> DepartmentGetAutocompleteV2Response: # noqa: E501 - """Retrieve Departments and IDs # noqa: E501 - Get the list of Department to be used in a dropdown or autocomplete control. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def department_get_autocomplete_v2( + self, + s_selector: Annotated[StrictStr, Field(description="The type of Departments to return")], + e_filter_active: Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, + s_query: Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DepartmentGetAutocompleteV2Response: + """Retrieve Departments and IDs - >>> thread = api.department_get_autocomplete_v2(s_selector, e_filter_active, s_query, accept_language, async_req=True) - >>> result = thread.get() + Get the list of Department to be used in a dropdown or autocomplete control. :param s_selector: The type of Departments to return (required) :type s_selector: str @@ -66,33 +83,76 @@ def department_get_autocomplete_v2(self, s_selector : Annotated[StrictStr, Field :type s_query: str :param accept_language: :type accept_language: HeaderAcceptLanguage - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: DepartmentGetAutocompleteV2Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the department_get_autocomplete_v2_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.department_get_autocomplete_v2_with_http_info(s_selector, e_filter_active, s_query, accept_language, **kwargs) # noqa: E501 - - @validate_arguments - def department_get_autocomplete_v2_with_http_info(self, s_selector : Annotated[StrictStr, Field(..., description="The type of Departments to return")], e_filter_active : Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, s_query : Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, accept_language : Optional[HeaderAcceptLanguage] = None, **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve Departments and IDs # noqa: E501 - - Get the list of Department to be used in a dropdown or autocomplete control. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.department_get_autocomplete_v2_with_http_info(s_selector, e_filter_active, s_query, accept_language, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._department_get_autocomplete_v2_serialize( + s_selector=s_selector, + e_filter_active=e_filter_active, + s_query=s_query, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DepartmentGetAutocompleteV2Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def department_get_autocomplete_v2_with_http_info( + self, + s_selector: Annotated[StrictStr, Field(description="The type of Departments to return")], + e_filter_active: Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, + s_query: Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DepartmentGetAutocompleteV2Response]: + """Retrieve Departments and IDs + + Get the list of Department to be used in a dropdown or autocomplete control. :param s_selector: The type of Departments to return (required) :type s_selector: str @@ -102,111 +162,197 @@ def department_get_autocomplete_v2_with_http_info(self, s_selector : Annotated[S :type s_query: str :param accept_language: :type accept_language: HeaderAcceptLanguage - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(DepartmentGetAutocompleteV2Response, status_code(int), headers(HTTPHeaderDict)) - """ - - _params = locals() - - _all_params = [ - 's_selector', - 'e_filter_active', - 's_query', - 'accept_language' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + """ # noqa: E501 + + _param = self._department_get_autocomplete_v2_serialize( + s_selector=s_selector, + e_filter_active=e_filter_active, + s_query=s_query, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DepartmentGetAutocompleteV2Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def department_get_autocomplete_v2_without_preload_content( + self, + s_selector: Annotated[StrictStr, Field(description="The type of Departments to return")], + e_filter_active: Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, + s_query: Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve Departments and IDs + + Get the list of Department to be used in a dropdown or autocomplete control. + + :param s_selector: The type of Departments to return (required) + :type s_selector: str + :param e_filter_active: Specify which results we want to display. + :type e_filter_active: str + :param s_query: Allow to filter the returned results + :type s_query: str + :param accept_language: + :type accept_language: HeaderAcceptLanguage + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._department_get_autocomplete_v2_serialize( + s_selector=s_selector, + e_filter_active=e_filter_active, + s_query=s_query, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method department_get_autocomplete_v2" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "DepartmentGetAutocompleteV2Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['s_selector']: - _path_params['sSelector'] = _params['s_selector'] + def _department_get_autocomplete_v2_serialize( + self, + s_selector, + e_filter_active, + s_query, + accept_language, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None - # process the query parameters - _query_params = [] - if _params.get('e_filter_active') is not None: # noqa: E501 - _query_params.append(('eFilterActive', _params['e_filter_active'])) + _collection_formats: Dict[str, str] = { + } - if _params.get('s_query') is not None: # noqa: E501 - _query_params.append(('sQuery', _params['s_query'])) + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if s_selector is not None: + _path_params['sSelector'] = s_selector + # process the query parameters + if e_filter_active is not None: + + _query_params.append(('eFilterActive', e_filter_active)) + + if s_query is not None: + + _query_params.append(('sQuery', s_query)) + # process the header parameters - _header_params = dict(_params.get('_headers', {})) - if _params['accept_language']: - _header_params['Accept-Language'] = _params['accept_language'] - + if accept_language is not None: + _header_params['Accept-Language'] = accept_language # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "DepartmentGetAutocompleteV2Response", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/2/object/department/getAutocomplete/{sSelector}', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/2/object/department/getAutocomplete/{sSelector}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/eZmaxApi/api/object_electronicfundstransfer_api.py b/eZmaxApi/api/object_electronicfundstransfer_api.py index 5556678b9..3afa257eb 100644 --- a/eZmaxApi/api/object_electronicfundstransfer_api.py +++ b/eZmaxApi/api/object_electronicfundstransfer_api.py @@ -13,22 +13,24 @@ """ # noqa: E501 -import re # noqa: F401 import io import warnings -from pydantic import validate_arguments, ValidationError +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Dict, List, Optional, Tuple, Union, Any -from pydantic import conint +try: + from typing import Annotated +except ImportError: + from typing_extensions import Annotated +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.electronicfundstransfer_get_communication_list_v1_response import ElectronicfundstransferGetCommunicationListV1Response from eZmaxApi.api_client import ApiClient from eZmaxApi.api_response import ApiResponse -from eZmaxApi.exceptions import ( # noqa: F401 - ApiTypeError, - ApiValueError -) +from eZmaxApi.rest import RESTResponseType class ObjectElectronicfundstransferApi: @@ -43,143 +45,263 @@ def __init__(self, api_client=None) -> None: api_client = ApiClient.get_default() self.api_client = api_client - @validate_arguments - def eletronicfundstransfer_get_communication_list_v1(self, pki_electronicfundstransfer_id : conint(strict=True, le=65535, ge=1), **kwargs) -> ElectronicfundstransferGetCommunicationListV1Response: # noqa: E501 - """Retrieve Communication list # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def electronicfundstransfer_get_communication_list_v1( + self, + pki_electronicfundstransfer_id: Annotated[int, Field(le=65535, strict=True, ge=1)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ElectronicfundstransferGetCommunicationListV1Response: + """Retrieve Communication list - >>> thread = api.eletronicfundstransfer_get_communication_list_v1(pki_electronicfundstransfer_id, async_req=True) - >>> result = thread.get() + :param pki_electronicfundstransfer_id: (required) :type pki_electronicfundstransfer_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: ElectronicfundstransferGetCommunicationListV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the eletronicfundstransfer_get_communication_list_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.eletronicfundstransfer_get_communication_list_v1_with_http_info(pki_electronicfundstransfer_id, **kwargs) # noqa: E501 - - @validate_arguments - def eletronicfundstransfer_get_communication_list_v1_with_http_info(self, pki_electronicfundstransfer_id : conint(strict=True, le=65535, ge=1), **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve Communication list # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.eletronicfundstransfer_get_communication_list_v1_with_http_info(pki_electronicfundstransfer_id, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._electronicfundstransfer_get_communication_list_v1_serialize( + pki_electronicfundstransfer_id=pki_electronicfundstransfer_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ElectronicfundstransferGetCommunicationListV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def electronicfundstransfer_get_communication_list_v1_with_http_info( + self, + pki_electronicfundstransfer_id: Annotated[int, Field(le=65535, strict=True, ge=1)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ElectronicfundstransferGetCommunicationListV1Response]: + """Retrieve Communication list + + :param pki_electronicfundstransfer_id: (required) :type pki_electronicfundstransfer_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(ElectronicfundstransferGetCommunicationListV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._electronicfundstransfer_get_communication_list_v1_serialize( + pki_electronicfundstransfer_id=pki_electronicfundstransfer_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '200': "ElectronicfundstransferGetCommunicationListV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'pki_electronicfundstransfer_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def electronicfundstransfer_get_communication_list_v1_without_preload_content( + self, + pki_electronicfundstransfer_id: Annotated[int, Field(le=65535, strict=True, ge=1)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve Communication list + + + + :param pki_electronicfundstransfer_id: (required) + :type pki_electronicfundstransfer_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._electronicfundstransfer_get_communication_list_v1_serialize( + pki_electronicfundstransfer_id=pki_electronicfundstransfer_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method eletronicfundstransfer_get_communication_list_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "ElectronicfundstransferGetCommunicationListV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_electronicfundstransfer_id']: - _path_params['pkiElectronicfundstransferID'] = _params['pki_electronicfundstransfer_id'] + def _electronicfundstransfer_get_communication_list_v1_serialize( + self, + pki_electronicfundstransfer_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_electronicfundstransfer_id is not None: + _path_params['pkiElectronicfundstransferID'] = pki_electronicfundstransfer_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "ElectronicfundstransferGetCommunicationListV1Response", - '404': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/electronicfundstransfer/{pkiElectronicfundstransferID}/getCommunicationList', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/1/object/electronicfundstransfer/{pkiElectronicfundstransferID}/getCommunicationList', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/eZmaxApi/api/object_emailtype_api.py b/eZmaxApi/api/object_emailtype_api.py index 063b858fb..521261054 100644 --- a/eZmaxApi/api/object_emailtype_api.py +++ b/eZmaxApi/api/object_emailtype_api.py @@ -13,14 +13,20 @@ """ # noqa: E501 -import re # noqa: F401 import io import warnings -from pydantic import validate_arguments, ValidationError +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Dict, List, Optional, Tuple, Union, Any +try: + from typing import Annotated +except ImportError: + from typing_extensions import Annotated + +from pydantic import Field from typing_extensions import Annotated -from pydantic import Field, StrictStr +from pydantic import StrictStr, field_validator from typing import Optional @@ -29,10 +35,7 @@ from eZmaxApi.api_client import ApiClient from eZmaxApi.api_response import ApiResponse -from eZmaxApi.exceptions import ( # noqa: F401 - ApiTypeError, - ApiValueError -) +from eZmaxApi.rest import RESTResponseType class ObjectEmailtypeApi: @@ -47,16 +50,30 @@ def __init__(self, api_client=None) -> None: api_client = ApiClient.get_default() self.api_client = api_client - @validate_arguments - def emailtype_get_autocomplete_v2(self, s_selector : Annotated[StrictStr, Field(..., description="The type of Emailtypes to return")], e_filter_active : Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, s_query : Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, accept_language : Optional[HeaderAcceptLanguage] = None, **kwargs) -> EmailtypeGetAutocompleteV2Response: # noqa: E501 - """Retrieve Emailtypes and IDs # noqa: E501 - Get the list of Emailtype to be used in a dropdown or autocomplete control. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def emailtype_get_autocomplete_v2( + self, + s_selector: Annotated[StrictStr, Field(description="The type of Emailtypes to return")], + e_filter_active: Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, + s_query: Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EmailtypeGetAutocompleteV2Response: + """Retrieve Emailtypes and IDs - >>> thread = api.emailtype_get_autocomplete_v2(s_selector, e_filter_active, s_query, accept_language, async_req=True) - >>> result = thread.get() + Get the list of Emailtype to be used in a dropdown or autocomplete control. :param s_selector: The type of Emailtypes to return (required) :type s_selector: str @@ -66,33 +83,76 @@ def emailtype_get_autocomplete_v2(self, s_selector : Annotated[StrictStr, Field( :type s_query: str :param accept_language: :type accept_language: HeaderAcceptLanguage - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EmailtypeGetAutocompleteV2Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the emailtype_get_autocomplete_v2_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.emailtype_get_autocomplete_v2_with_http_info(s_selector, e_filter_active, s_query, accept_language, **kwargs) # noqa: E501 - - @validate_arguments - def emailtype_get_autocomplete_v2_with_http_info(self, s_selector : Annotated[StrictStr, Field(..., description="The type of Emailtypes to return")], e_filter_active : Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, s_query : Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, accept_language : Optional[HeaderAcceptLanguage] = None, **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve Emailtypes and IDs # noqa: E501 - - Get the list of Emailtype to be used in a dropdown or autocomplete control. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.emailtype_get_autocomplete_v2_with_http_info(s_selector, e_filter_active, s_query, accept_language, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._emailtype_get_autocomplete_v2_serialize( + s_selector=s_selector, + e_filter_active=e_filter_active, + s_query=s_query, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EmailtypeGetAutocompleteV2Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def emailtype_get_autocomplete_v2_with_http_info( + self, + s_selector: Annotated[StrictStr, Field(description="The type of Emailtypes to return")], + e_filter_active: Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, + s_query: Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EmailtypeGetAutocompleteV2Response]: + """Retrieve Emailtypes and IDs + + Get the list of Emailtype to be used in a dropdown or autocomplete control. :param s_selector: The type of Emailtypes to return (required) :type s_selector: str @@ -102,111 +162,197 @@ def emailtype_get_autocomplete_v2_with_http_info(self, s_selector : Annotated[St :type s_query: str :param accept_language: :type accept_language: HeaderAcceptLanguage - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EmailtypeGetAutocompleteV2Response, status_code(int), headers(HTTPHeaderDict)) - """ - - _params = locals() - - _all_params = [ - 's_selector', - 'e_filter_active', - 's_query', - 'accept_language' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + """ # noqa: E501 + + _param = self._emailtype_get_autocomplete_v2_serialize( + s_selector=s_selector, + e_filter_active=e_filter_active, + s_query=s_query, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EmailtypeGetAutocompleteV2Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def emailtype_get_autocomplete_v2_without_preload_content( + self, + s_selector: Annotated[StrictStr, Field(description="The type of Emailtypes to return")], + e_filter_active: Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, + s_query: Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve Emailtypes and IDs + + Get the list of Emailtype to be used in a dropdown or autocomplete control. + + :param s_selector: The type of Emailtypes to return (required) + :type s_selector: str + :param e_filter_active: Specify which results we want to display. + :type e_filter_active: str + :param s_query: Allow to filter the returned results + :type s_query: str + :param accept_language: + :type accept_language: HeaderAcceptLanguage + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._emailtype_get_autocomplete_v2_serialize( + s_selector=s_selector, + e_filter_active=e_filter_active, + s_query=s_query, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method emailtype_get_autocomplete_v2" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "EmailtypeGetAutocompleteV2Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['s_selector']: - _path_params['sSelector'] = _params['s_selector'] + def _emailtype_get_autocomplete_v2_serialize( + self, + s_selector, + e_filter_active, + s_query, + accept_language, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None - # process the query parameters - _query_params = [] - if _params.get('e_filter_active') is not None: # noqa: E501 - _query_params.append(('eFilterActive', _params['e_filter_active'])) + _collection_formats: Dict[str, str] = { + } - if _params.get('s_query') is not None: # noqa: E501 - _query_params.append(('sQuery', _params['s_query'])) + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if s_selector is not None: + _path_params['sSelector'] = s_selector + # process the query parameters + if e_filter_active is not None: + + _query_params.append(('eFilterActive', e_filter_active)) + + if s_query is not None: + + _query_params.append(('sQuery', s_query)) + # process the header parameters - _header_params = dict(_params.get('_headers', {})) - if _params['accept_language']: - _header_params['Accept-Language'] = _params['accept_language'] - + if accept_language is not None: + _header_params['Accept-Language'] = accept_language # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "EmailtypeGetAutocompleteV2Response", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/2/object/emailtype/getAutocomplete/{sSelector}', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/2/object/emailtype/getAutocomplete/{sSelector}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/eZmaxApi/api/object_ezmaxinvoicing_api.py b/eZmaxApi/api/object_ezmaxinvoicing_api.py index e333f3032..b63204c44 100644 --- a/eZmaxApi/api/object_ezmaxinvoicing_api.py +++ b/eZmaxApi/api/object_ezmaxinvoicing_api.py @@ -13,14 +13,20 @@ """ # noqa: E501 -import re # noqa: F401 import io import warnings -from pydantic import validate_arguments, ValidationError +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Dict, List, Optional, Tuple, Union, Any +try: + from typing import Annotated +except ImportError: + from typing_extensions import Annotated + +from pydantic import Field from typing_extensions import Annotated -from pydantic import Field, StrictStr, conint +from pydantic import StrictStr, field_validator from typing import Optional @@ -32,10 +38,7 @@ from eZmaxApi.api_client import ApiClient from eZmaxApi.api_response import ApiResponse -from eZmaxApi.exceptions import ( # noqa: F401 - ApiTypeError, - ApiValueError -) +from eZmaxApi.rest import RESTResponseType class ObjectEzmaxinvoicingApi: @@ -50,16 +53,30 @@ def __init__(self, api_client=None) -> None: api_client = ApiClient.get_default() self.api_client = api_client - @validate_arguments - def ezmaxinvoicing_get_autocomplete_v1(self, s_selector : Annotated[StrictStr, Field(..., description="The type of Ezmaxinvoicings to return")], e_filter_active : Annotated[Optional[StrictStr], Field(description="Specify which results we want to display. Active is the default value.")] = None, s_query : Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, accept_language : Optional[HeaderAcceptLanguage] = None, **kwargs) -> CommonGetAutocompleteV1Response: # noqa: E501 - """(Deprecated) Retrieve Ezmaxinvoicings and IDs # noqa: E501 - Get the list of Ezmaxinvoicing to be used in a dropdown or autocomplete control. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def ezmaxinvoicing_get_autocomplete_v1( + self, + s_selector: Annotated[StrictStr, Field(description="The type of Ezmaxinvoicings to return")], + e_filter_active: Annotated[Optional[StrictStr], Field(description="Specify which results we want to display. Active is the default value.")] = None, + s_query: Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> CommonGetAutocompleteV1Response: + """(Deprecated) Retrieve Ezmaxinvoicings and IDs - >>> thread = api.ezmaxinvoicing_get_autocomplete_v1(s_selector, e_filter_active, s_query, accept_language, async_req=True) - >>> result = thread.get() + Get the list of Ezmaxinvoicing to be used in a dropdown or autocomplete control. :param s_selector: The type of Ezmaxinvoicings to return (required) :type s_selector: str @@ -69,33 +86,77 @@ def ezmaxinvoicing_get_autocomplete_v1(self, s_selector : Annotated[StrictStr, F :type s_query: str :param accept_language: :type accept_language: HeaderAcceptLanguage - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: CommonGetAutocompleteV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezmaxinvoicing_get_autocomplete_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezmaxinvoicing_get_autocomplete_v1_with_http_info(s_selector, e_filter_active, s_query, accept_language, **kwargs) # noqa: E501 - - @validate_arguments - def ezmaxinvoicing_get_autocomplete_v1_with_http_info(self, s_selector : Annotated[StrictStr, Field(..., description="The type of Ezmaxinvoicings to return")], e_filter_active : Annotated[Optional[StrictStr], Field(description="Specify which results we want to display. Active is the default value.")] = None, s_query : Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, accept_language : Optional[HeaderAcceptLanguage] = None, **kwargs) -> ApiResponse: # noqa: E501 - """(Deprecated) Retrieve Ezmaxinvoicings and IDs # noqa: E501 - - Get the list of Ezmaxinvoicing to be used in a dropdown or autocomplete control. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezmaxinvoicing_get_autocomplete_v1_with_http_info(s_selector, e_filter_active, s_query, accept_language, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + warnings.warn("GET /1/object/ezmaxinvoicing/getAutocomplete/{sSelector} is deprecated.", DeprecationWarning) + + _param = self._ezmaxinvoicing_get_autocomplete_v1_serialize( + s_selector=s_selector, + e_filter_active=e_filter_active, + s_query=s_query, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "CommonGetAutocompleteV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezmaxinvoicing_get_autocomplete_v1_with_http_info( + self, + s_selector: Annotated[StrictStr, Field(description="The type of Ezmaxinvoicings to return")], + e_filter_active: Annotated[Optional[StrictStr], Field(description="Specify which results we want to display. Active is the default value.")] = None, + s_query: Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[CommonGetAutocompleteV1Response]: + """(Deprecated) Retrieve Ezmaxinvoicings and IDs + + Get the list of Ezmaxinvoicing to be used in a dropdown or autocomplete control. :param s_selector: The type of Ezmaxinvoicings to return (required) :type s_selector: str @@ -105,127 +166,227 @@ def ezmaxinvoicing_get_autocomplete_v1_with_http_info(self, s_selector : Annotat :type s_query: str :param accept_language: :type accept_language: HeaderAcceptLanguage - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(CommonGetAutocompleteV1Response, status_code(int), headers(HTTPHeaderDict)) - """ - + """ # noqa: E501 warnings.warn("GET /1/object/ezmaxinvoicing/getAutocomplete/{sSelector} is deprecated.", DeprecationWarning) - _params = locals() + _param = self._ezmaxinvoicing_get_autocomplete_v1_serialize( + s_selector=s_selector, + e_filter_active=e_filter_active, + s_query=s_query, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _all_params = [ - 's_selector', - 'e_filter_active', - 's_query', - 'accept_language' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + _response_types_map: Dict[str, Optional[str]] = { + '200': "CommonGetAutocompleteV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def ezmaxinvoicing_get_autocomplete_v1_without_preload_content( + self, + s_selector: Annotated[StrictStr, Field(description="The type of Ezmaxinvoicings to return")], + e_filter_active: Annotated[Optional[StrictStr], Field(description="Specify which results we want to display. Active is the default value.")] = None, + s_query: Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """(Deprecated) Retrieve Ezmaxinvoicings and IDs + + Get the list of Ezmaxinvoicing to be used in a dropdown or autocomplete control. + + :param s_selector: The type of Ezmaxinvoicings to return (required) + :type s_selector: str + :param e_filter_active: Specify which results we want to display. Active is the default value. + :type e_filter_active: str + :param s_query: Allow to filter the returned results + :type s_query: str + :param accept_language: + :type accept_language: HeaderAcceptLanguage + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + warnings.warn("GET /1/object/ezmaxinvoicing/getAutocomplete/{sSelector} is deprecated.", DeprecationWarning) + + _param = self._ezmaxinvoicing_get_autocomplete_v1_serialize( + s_selector=s_selector, + e_filter_active=e_filter_active, + s_query=s_query, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezmaxinvoicing_get_autocomplete_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "CommonGetAutocompleteV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['s_selector']: - _path_params['sSelector'] = _params['s_selector'] + def _ezmaxinvoicing_get_autocomplete_v1_serialize( + self, + s_selector, + e_filter_active, + s_query, + accept_language, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None - # process the query parameters - _query_params = [] - if _params.get('e_filter_active') is not None: # noqa: E501 - _query_params.append(('eFilterActive', _params['e_filter_active'])) + _collection_formats: Dict[str, str] = { + } - if _params.get('s_query') is not None: # noqa: E501 - _query_params.append(('sQuery', _params['s_query'])) + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if s_selector is not None: + _path_params['sSelector'] = s_selector + # process the query parameters + if e_filter_active is not None: + + _query_params.append(('eFilterActive', e_filter_active)) + + if s_query is not None: + + _query_params.append(('sQuery', s_query)) + # process the header parameters - _header_params = dict(_params.get('_headers', {})) - if _params['accept_language']: - _header_params['Accept-Language'] = _params['accept_language'] - + if accept_language is not None: + _header_params['Accept-Language'] = accept_language # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "CommonGetAutocompleteV1Response", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezmaxinvoicing/getAutocomplete/{sSelector}', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/1/object/ezmaxinvoicing/getAutocomplete/{sSelector}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) - @validate_arguments - def ezmaxinvoicing_get_autocomplete_v2(self, s_selector : Annotated[StrictStr, Field(..., description="The type of Ezmaxinvoicings to return")], e_filter_active : Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, s_query : Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, accept_language : Optional[HeaderAcceptLanguage] = None, **kwargs) -> EzmaxinvoicingGetAutocompleteV2Response: # noqa: E501 - """Retrieve Ezmaxinvoicings and IDs # noqa: E501 - Get the list of Ezmaxinvoicing to be used in a dropdown or autocomplete control. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.ezmaxinvoicing_get_autocomplete_v2(s_selector, e_filter_active, s_query, accept_language, async_req=True) - >>> result = thread.get() + + @validate_call + def ezmaxinvoicing_get_autocomplete_v2( + self, + s_selector: Annotated[StrictStr, Field(description="The type of Ezmaxinvoicings to return")], + e_filter_active: Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, + s_query: Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzmaxinvoicingGetAutocompleteV2Response: + """Retrieve Ezmaxinvoicings and IDs + + Get the list of Ezmaxinvoicing to be used in a dropdown or autocomplete control. :param s_selector: The type of Ezmaxinvoicings to return (required) :type s_selector: str @@ -235,33 +396,76 @@ def ezmaxinvoicing_get_autocomplete_v2(self, s_selector : Annotated[StrictStr, F :type s_query: str :param accept_language: :type accept_language: HeaderAcceptLanguage - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzmaxinvoicingGetAutocompleteV2Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezmaxinvoicing_get_autocomplete_v2_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezmaxinvoicing_get_autocomplete_v2_with_http_info(s_selector, e_filter_active, s_query, accept_language, **kwargs) # noqa: E501 - - @validate_arguments - def ezmaxinvoicing_get_autocomplete_v2_with_http_info(self, s_selector : Annotated[StrictStr, Field(..., description="The type of Ezmaxinvoicings to return")], e_filter_active : Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, s_query : Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, accept_language : Optional[HeaderAcceptLanguage] = None, **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve Ezmaxinvoicings and IDs # noqa: E501 - - Get the list of Ezmaxinvoicing to be used in a dropdown or autocomplete control. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezmaxinvoicing_get_autocomplete_v2_with_http_info(s_selector, e_filter_active, s_query, accept_language, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._ezmaxinvoicing_get_autocomplete_v2_serialize( + s_selector=s_selector, + e_filter_active=e_filter_active, + s_query=s_query, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzmaxinvoicingGetAutocompleteV2Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezmaxinvoicing_get_autocomplete_v2_with_http_info( + self, + s_selector: Annotated[StrictStr, Field(description="The type of Ezmaxinvoicings to return")], + e_filter_active: Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, + s_query: Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzmaxinvoicingGetAutocompleteV2Response]: + """Retrieve Ezmaxinvoicings and IDs + + Get the list of Ezmaxinvoicing to be used in a dropdown or autocomplete control. :param s_selector: The type of Ezmaxinvoicings to return (required) :type s_selector: str @@ -271,385 +475,704 @@ def ezmaxinvoicing_get_autocomplete_v2_with_http_info(self, s_selector : Annotat :type s_query: str :param accept_language: :type accept_language: HeaderAcceptLanguage - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzmaxinvoicingGetAutocompleteV2Response, status_code(int), headers(HTTPHeaderDict)) - """ - - _params = locals() - - _all_params = [ - 's_selector', - 'e_filter_active', - 's_query', - 'accept_language' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + """ # noqa: E501 + + _param = self._ezmaxinvoicing_get_autocomplete_v2_serialize( + s_selector=s_selector, + e_filter_active=e_filter_active, + s_query=s_query, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzmaxinvoicingGetAutocompleteV2Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def ezmaxinvoicing_get_autocomplete_v2_without_preload_content( + self, + s_selector: Annotated[StrictStr, Field(description="The type of Ezmaxinvoicings to return")], + e_filter_active: Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, + s_query: Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve Ezmaxinvoicings and IDs + + Get the list of Ezmaxinvoicing to be used in a dropdown or autocomplete control. + + :param s_selector: The type of Ezmaxinvoicings to return (required) + :type s_selector: str + :param e_filter_active: Specify which results we want to display. + :type e_filter_active: str + :param s_query: Allow to filter the returned results + :type s_query: str + :param accept_language: + :type accept_language: HeaderAcceptLanguage + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezmaxinvoicing_get_autocomplete_v2_serialize( + s_selector=s_selector, + e_filter_active=e_filter_active, + s_query=s_query, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezmaxinvoicing_get_autocomplete_v2" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzmaxinvoicingGetAutocompleteV2Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['s_selector']: - _path_params['sSelector'] = _params['s_selector'] + def _ezmaxinvoicing_get_autocomplete_v2_serialize( + self, + s_selector, + e_filter_active, + s_query, + accept_language, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None - # process the query parameters - _query_params = [] - if _params.get('e_filter_active') is not None: # noqa: E501 - _query_params.append(('eFilterActive', _params['e_filter_active'])) + _collection_formats: Dict[str, str] = { + } - if _params.get('s_query') is not None: # noqa: E501 - _query_params.append(('sQuery', _params['s_query'])) + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if s_selector is not None: + _path_params['sSelector'] = s_selector + # process the query parameters + if e_filter_active is not None: + + _query_params.append(('eFilterActive', e_filter_active)) + + if s_query is not None: + + _query_params.append(('sQuery', s_query)) + # process the header parameters - _header_params = dict(_params.get('_headers', {})) - if _params['accept_language']: - _header_params['Accept-Language'] = _params['accept_language'] - + if accept_language is not None: + _header_params['Accept-Language'] = accept_language # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "EzmaxinvoicingGetAutocompleteV2Response", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/2/object/ezmaxinvoicing/getAutocomplete/{sSelector}', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/2/object/ezmaxinvoicing/getAutocomplete/{sSelector}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) - @validate_arguments - def ezmaxinvoicing_get_object_v2(self, pki_ezmaxinvoicing_id : conint(strict=True, ge=0), **kwargs) -> EzmaxinvoicingGetObjectV2Response: # noqa: E501 - """Retrieve an existing Ezmaxinvoicing # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.ezmaxinvoicing_get_object_v2(pki_ezmaxinvoicing_id, async_req=True) - >>> result = thread.get() + + @validate_call + def ezmaxinvoicing_get_object_v2( + self, + pki_ezmaxinvoicing_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzmaxinvoicingGetObjectV2Response: + """Retrieve an existing Ezmaxinvoicing + + :param pki_ezmaxinvoicing_id: (required) :type pki_ezmaxinvoicing_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzmaxinvoicingGetObjectV2Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezmaxinvoicing_get_object_v2_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezmaxinvoicing_get_object_v2_with_http_info(pki_ezmaxinvoicing_id, **kwargs) # noqa: E501 - - @validate_arguments - def ezmaxinvoicing_get_object_v2_with_http_info(self, pki_ezmaxinvoicing_id : conint(strict=True, ge=0), **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve an existing Ezmaxinvoicing # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezmaxinvoicing_get_object_v2_with_http_info(pki_ezmaxinvoicing_id, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._ezmaxinvoicing_get_object_v2_serialize( + pki_ezmaxinvoicing_id=pki_ezmaxinvoicing_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzmaxinvoicingGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezmaxinvoicing_get_object_v2_with_http_info( + self, + pki_ezmaxinvoicing_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzmaxinvoicingGetObjectV2Response]: + """Retrieve an existing Ezmaxinvoicing + + :param pki_ezmaxinvoicing_id: (required) :type pki_ezmaxinvoicing_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzmaxinvoicingGetObjectV2Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._ezmaxinvoicing_get_object_v2_serialize( + pki_ezmaxinvoicing_id=pki_ezmaxinvoicing_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzmaxinvoicingGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _params = locals() - _all_params = [ - 'pki_ezmaxinvoicing_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + @validate_call + def ezmaxinvoicing_get_object_v2_without_preload_content( + self, + pki_ezmaxinvoicing_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve an existing Ezmaxinvoicing + + + + :param pki_ezmaxinvoicing_id: (required) + :type pki_ezmaxinvoicing_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezmaxinvoicing_get_object_v2_serialize( + pki_ezmaxinvoicing_id=pki_ezmaxinvoicing_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzmaxinvoicingGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) + return response_data.response - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezmaxinvoicing_get_object_v2" % _key - ) - _params[_key] = _val - del _params['kwargs'] - _collection_formats = {} + def _ezmaxinvoicing_get_object_v2_serialize( + self, + pki_ezmaxinvoicing_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: - # process the path parameters - _path_params = {} - if _params['pki_ezmaxinvoicing_id']: - _path_params['pkiEzmaxinvoicingID'] = _params['pki_ezmaxinvoicing_id'] + _host = None + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_ezmaxinvoicing_id is not None: + _path_params['pkiEzmaxinvoicingID'] = pki_ezmaxinvoicing_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "EzmaxinvoicingGetObjectV2Response", - '404': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/2/object/ezmaxinvoicing/{pkiEzmaxinvoicingID}', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/2/object/ezmaxinvoicing/{pkiEzmaxinvoicingID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) - @validate_arguments - def ezmaxinvoicing_get_provisional_v1(self, **kwargs) -> EzmaxinvoicingGetProvisionalV1Response: # noqa: E501 - """Retrieve provisional Ezmaxinvoicing # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.ezmaxinvoicing_get_provisional_v1(async_req=True) - >>> result = thread.get() - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + @validate_call + def ezmaxinvoicing_get_provisional_v1( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzmaxinvoicingGetProvisionalV1Response: + """Retrieve provisional Ezmaxinvoicing + + + + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzmaxinvoicingGetProvisionalV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezmaxinvoicing_get_provisional_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezmaxinvoicing_get_provisional_v1_with_http_info(**kwargs) # noqa: E501 - - @validate_arguments - def ezmaxinvoicing_get_provisional_v1_with_http_info(self, **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve provisional Ezmaxinvoicing # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezmaxinvoicing_get_provisional_v1_with_http_info(async_req=True) - >>> result = thread.get() - - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional + """ # noqa: E501 + + _param = self._ezmaxinvoicing_get_provisional_v1_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzmaxinvoicingGetProvisionalV1Response", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezmaxinvoicing_get_provisional_v1_with_http_info( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzmaxinvoicingGetProvisionalV1Response]: + """Retrieve provisional Ezmaxinvoicing + + + :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzmaxinvoicingGetProvisionalV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 - _params = locals() + _param = self._ezmaxinvoicing_get_provisional_v1_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _all_params = [ - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzmaxinvoicingGetProvisionalV1Response", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def ezmaxinvoicing_get_provisional_v1_without_preload_content( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve provisional Ezmaxinvoicing + + + + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezmaxinvoicing_get_provisional_v1_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzmaxinvoicingGetProvisionalV1Response", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) + return response_data.response - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezmaxinvoicing_get_provisional_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] - _collection_formats = {} + def _ezmaxinvoicing_get_provisional_v1_serialize( + self, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: - # process the path parameters - _path_params = {} + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "EzmaxinvoicingGetProvisionalV1Response", - '422': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezmaxinvoicing/getProvisional', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/1/object/ezmaxinvoicing/getProvisional', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/eZmaxApi/api/object_ezmaxproduct_api.py b/eZmaxApi/api/object_ezmaxproduct_api.py index 56053c240..e1e22408b 100644 --- a/eZmaxApi/api/object_ezmaxproduct_api.py +++ b/eZmaxApi/api/object_ezmaxproduct_api.py @@ -13,14 +13,20 @@ """ # noqa: E501 -import re # noqa: F401 import io import warnings -from pydantic import validate_arguments, ValidationError +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Dict, List, Optional, Tuple, Union, Any +try: + from typing import Annotated +except ImportError: + from typing_extensions import Annotated + +from pydantic import Field from typing_extensions import Annotated -from pydantic import Field, StrictStr +from pydantic import StrictStr, field_validator from typing import Optional @@ -29,10 +35,7 @@ from eZmaxApi.api_client import ApiClient from eZmaxApi.api_response import ApiResponse -from eZmaxApi.exceptions import ( # noqa: F401 - ApiTypeError, - ApiValueError -) +from eZmaxApi.rest import RESTResponseType class ObjectEzmaxproductApi: @@ -47,16 +50,30 @@ def __init__(self, api_client=None) -> None: api_client = ApiClient.get_default() self.api_client = api_client - @validate_arguments - def ezmaxproduct_get_autocomplete_v2(self, s_selector : Annotated[StrictStr, Field(..., description="The type of Ezmaxproducts to return")], e_filter_active : Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, s_query : Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, accept_language : Optional[HeaderAcceptLanguage] = None, **kwargs) -> EzmaxproductGetAutocompleteV2Response: # noqa: E501 - """Retrieve Ezmaxproducts and IDs # noqa: E501 - Get the list of Ezmaxproduct to be used in a dropdown or autocomplete control. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def ezmaxproduct_get_autocomplete_v2( + self, + s_selector: Annotated[StrictStr, Field(description="The type of Ezmaxproducts to return")], + e_filter_active: Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, + s_query: Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzmaxproductGetAutocompleteV2Response: + """Retrieve Ezmaxproducts and IDs - >>> thread = api.ezmaxproduct_get_autocomplete_v2(s_selector, e_filter_active, s_query, accept_language, async_req=True) - >>> result = thread.get() + Get the list of Ezmaxproduct to be used in a dropdown or autocomplete control. :param s_selector: The type of Ezmaxproducts to return (required) :type s_selector: str @@ -66,33 +83,76 @@ def ezmaxproduct_get_autocomplete_v2(self, s_selector : Annotated[StrictStr, Fie :type s_query: str :param accept_language: :type accept_language: HeaderAcceptLanguage - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzmaxproductGetAutocompleteV2Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezmaxproduct_get_autocomplete_v2_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezmaxproduct_get_autocomplete_v2_with_http_info(s_selector, e_filter_active, s_query, accept_language, **kwargs) # noqa: E501 - - @validate_arguments - def ezmaxproduct_get_autocomplete_v2_with_http_info(self, s_selector : Annotated[StrictStr, Field(..., description="The type of Ezmaxproducts to return")], e_filter_active : Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, s_query : Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, accept_language : Optional[HeaderAcceptLanguage] = None, **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve Ezmaxproducts and IDs # noqa: E501 - - Get the list of Ezmaxproduct to be used in a dropdown or autocomplete control. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezmaxproduct_get_autocomplete_v2_with_http_info(s_selector, e_filter_active, s_query, accept_language, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._ezmaxproduct_get_autocomplete_v2_serialize( + s_selector=s_selector, + e_filter_active=e_filter_active, + s_query=s_query, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzmaxproductGetAutocompleteV2Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezmaxproduct_get_autocomplete_v2_with_http_info( + self, + s_selector: Annotated[StrictStr, Field(description="The type of Ezmaxproducts to return")], + e_filter_active: Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, + s_query: Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzmaxproductGetAutocompleteV2Response]: + """Retrieve Ezmaxproducts and IDs + + Get the list of Ezmaxproduct to be used in a dropdown or autocomplete control. :param s_selector: The type of Ezmaxproducts to return (required) :type s_selector: str @@ -102,111 +162,197 @@ def ezmaxproduct_get_autocomplete_v2_with_http_info(self, s_selector : Annotated :type s_query: str :param accept_language: :type accept_language: HeaderAcceptLanguage - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzmaxproductGetAutocompleteV2Response, status_code(int), headers(HTTPHeaderDict)) - """ - - _params = locals() - - _all_params = [ - 's_selector', - 'e_filter_active', - 's_query', - 'accept_language' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + """ # noqa: E501 + + _param = self._ezmaxproduct_get_autocomplete_v2_serialize( + s_selector=s_selector, + e_filter_active=e_filter_active, + s_query=s_query, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzmaxproductGetAutocompleteV2Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def ezmaxproduct_get_autocomplete_v2_without_preload_content( + self, + s_selector: Annotated[StrictStr, Field(description="The type of Ezmaxproducts to return")], + e_filter_active: Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, + s_query: Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve Ezmaxproducts and IDs + + Get the list of Ezmaxproduct to be used in a dropdown or autocomplete control. + + :param s_selector: The type of Ezmaxproducts to return (required) + :type s_selector: str + :param e_filter_active: Specify which results we want to display. + :type e_filter_active: str + :param s_query: Allow to filter the returned results + :type s_query: str + :param accept_language: + :type accept_language: HeaderAcceptLanguage + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezmaxproduct_get_autocomplete_v2_serialize( + s_selector=s_selector, + e_filter_active=e_filter_active, + s_query=s_query, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezmaxproduct_get_autocomplete_v2" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzmaxproductGetAutocompleteV2Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['s_selector']: - _path_params['sSelector'] = _params['s_selector'] + def _ezmaxproduct_get_autocomplete_v2_serialize( + self, + s_selector, + e_filter_active, + s_query, + accept_language, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None - # process the query parameters - _query_params = [] - if _params.get('e_filter_active') is not None: # noqa: E501 - _query_params.append(('eFilterActive', _params['e_filter_active'])) + _collection_formats: Dict[str, str] = { + } - if _params.get('s_query') is not None: # noqa: E501 - _query_params.append(('sQuery', _params['s_query'])) + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if s_selector is not None: + _path_params['sSelector'] = s_selector + # process the query parameters + if e_filter_active is not None: + + _query_params.append(('eFilterActive', e_filter_active)) + + if s_query is not None: + + _query_params.append(('sQuery', s_query)) + # process the header parameters - _header_params = dict(_params.get('_headers', {})) - if _params['accept_language']: - _header_params['Accept-Language'] = _params['accept_language'] - + if accept_language is not None: + _header_params['Accept-Language'] = accept_language # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "EzmaxproductGetAutocompleteV2Response", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/2/object/ezmaxproduct/getAutocomplete/{sSelector}', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/2/object/ezmaxproduct/getAutocomplete/{sSelector}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/eZmaxApi/api/object_ezsignbulksend_api.py b/eZmaxApi/api/object_ezsignbulksend_api.py index 672f03718..56c7723b3 100644 --- a/eZmaxApi/api/object_ezsignbulksend_api.py +++ b/eZmaxApi/api/object_ezsignbulksend_api.py @@ -13,14 +13,20 @@ """ # noqa: E501 -import re # noqa: F401 import io import warnings -from pydantic import validate_arguments, ValidationError +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Dict, List, Optional, Tuple, Union, Any +try: + from typing import Annotated +except ImportError: + from typing_extensions import Annotated + +from pydantic import Field from typing_extensions import Annotated -from pydantic import Field, StrictStr, conint +from pydantic import StrictStr, field_validator from typing import Optional @@ -42,10 +48,7 @@ from eZmaxApi.api_client import ApiClient from eZmaxApi.api_response import ApiResponse -from eZmaxApi.exceptions import ( # noqa: F401 - ApiTypeError, - ApiValueError -) +from eZmaxApi.rest import RESTResponseType class ObjectEzsignbulksendApi: @@ -60,1193 +63,2306 @@ def __init__(self, api_client=None) -> None: api_client = ApiClient.get_default() self.api_client = api_client - @validate_arguments - def ezsignbulksend_create_ezsignbulksendtransmission_v1(self, pki_ezsignbulksend_id : conint(strict=True, ge=0), ezsignbulksend_create_ezsignbulksendtransmission_v1_request : EzsignbulksendCreateEzsignbulksendtransmissionV1Request, **kwargs) -> EzsignbulksendCreateEzsignbulksendtransmissionV1Response: # noqa: E501 - """Create a new Ezsignbulksendtransmission in the Ezsignbulksend # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def ezsignbulksend_create_ezsignbulksendtransmission_v1( + self, + pki_ezsignbulksend_id: Annotated[int, Field(strict=True, ge=0)], + ezsignbulksend_create_ezsignbulksendtransmission_v1_request: EzsignbulksendCreateEzsignbulksendtransmissionV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsignbulksendCreateEzsignbulksendtransmissionV1Response: + """Create a new Ezsignbulksendtransmission in the Ezsignbulksend - >>> thread = api.ezsignbulksend_create_ezsignbulksendtransmission_v1(pki_ezsignbulksend_id, ezsignbulksend_create_ezsignbulksendtransmission_v1_request, async_req=True) - >>> result = thread.get() :param pki_ezsignbulksend_id: (required) :type pki_ezsignbulksend_id: int :param ezsignbulksend_create_ezsignbulksendtransmission_v1_request: (required) :type ezsignbulksend_create_ezsignbulksendtransmission_v1_request: EzsignbulksendCreateEzsignbulksendtransmissionV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsignbulksendCreateEzsignbulksendtransmissionV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsignbulksend_create_ezsignbulksendtransmission_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsignbulksend_create_ezsignbulksendtransmission_v1_with_http_info(pki_ezsignbulksend_id, ezsignbulksend_create_ezsignbulksendtransmission_v1_request, **kwargs) # noqa: E501 - - @validate_arguments - def ezsignbulksend_create_ezsignbulksendtransmission_v1_with_http_info(self, pki_ezsignbulksend_id : conint(strict=True, ge=0), ezsignbulksend_create_ezsignbulksendtransmission_v1_request : EzsignbulksendCreateEzsignbulksendtransmissionV1Request, **kwargs) -> ApiResponse: # noqa: E501 - """Create a new Ezsignbulksendtransmission in the Ezsignbulksend # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsignbulksend_create_ezsignbulksendtransmission_v1_with_http_info(pki_ezsignbulksend_id, ezsignbulksend_create_ezsignbulksendtransmission_v1_request, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._ezsignbulksend_create_ezsignbulksendtransmission_v1_serialize( + pki_ezsignbulksend_id=pki_ezsignbulksend_id, + ezsignbulksend_create_ezsignbulksendtransmission_v1_request=ezsignbulksend_create_ezsignbulksendtransmission_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignbulksendCreateEzsignbulksendtransmissionV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsignbulksend_create_ezsignbulksendtransmission_v1_with_http_info( + self, + pki_ezsignbulksend_id: Annotated[int, Field(strict=True, ge=0)], + ezsignbulksend_create_ezsignbulksendtransmission_v1_request: EzsignbulksendCreateEzsignbulksendtransmissionV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsignbulksendCreateEzsignbulksendtransmissionV1Response]: + """Create a new Ezsignbulksendtransmission in the Ezsignbulksend + :param pki_ezsignbulksend_id: (required) :type pki_ezsignbulksend_id: int :param ezsignbulksend_create_ezsignbulksendtransmission_v1_request: (required) :type ezsignbulksend_create_ezsignbulksendtransmission_v1_request: EzsignbulksendCreateEzsignbulksendtransmissionV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsignbulksendCreateEzsignbulksendtransmissionV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._ezsignbulksend_create_ezsignbulksendtransmission_v1_serialize( + pki_ezsignbulksend_id=pki_ezsignbulksend_id, + ezsignbulksend_create_ezsignbulksendtransmission_v1_request=ezsignbulksend_create_ezsignbulksendtransmission_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignbulksendCreateEzsignbulksendtransmissionV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _params = locals() - _all_params = [ - 'pki_ezsignbulksend_id', - 'ezsignbulksend_create_ezsignbulksendtransmission_v1_request' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + @validate_call + def ezsignbulksend_create_ezsignbulksendtransmission_v1_without_preload_content( + self, + pki_ezsignbulksend_id: Annotated[int, Field(strict=True, ge=0)], + ezsignbulksend_create_ezsignbulksendtransmission_v1_request: EzsignbulksendCreateEzsignbulksendtransmissionV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Create a new Ezsignbulksendtransmission in the Ezsignbulksend + + + :param pki_ezsignbulksend_id: (required) + :type pki_ezsignbulksend_id: int + :param ezsignbulksend_create_ezsignbulksendtransmission_v1_request: (required) + :type ezsignbulksend_create_ezsignbulksendtransmission_v1_request: EzsignbulksendCreateEzsignbulksendtransmissionV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignbulksend_create_ezsignbulksendtransmission_v1_serialize( + pki_ezsignbulksend_id=pki_ezsignbulksend_id, + ezsignbulksend_create_ezsignbulksendtransmission_v1_request=ezsignbulksend_create_ezsignbulksendtransmission_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsignbulksend_create_ezsignbulksendtransmission_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignbulksendCreateEzsignbulksendtransmissionV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_ezsignbulksend_id']: - _path_params['pkiEzsignbulksendID'] = _params['pki_ezsignbulksend_id'] + def _ezsignbulksend_create_ezsignbulksendtransmission_v1_serialize( + self, + pki_ezsignbulksend_id, + ezsignbulksend_create_ezsignbulksendtransmission_v1_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if pki_ezsignbulksend_id is not None: + _path_params['pkiEzsignbulksendID'] = pki_ezsignbulksend_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['ezsignbulksend_create_ezsignbulksendtransmission_v1_request'] is not None: - _body_params = _params['ezsignbulksend_create_ezsignbulksendtransmission_v1_request'] + if ezsignbulksend_create_ezsignbulksendtransmission_v1_request is not None: + _body_params = ezsignbulksend_create_ezsignbulksendtransmission_v1_request + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '200': "EzsignbulksendCreateEzsignbulksendtransmissionV1Response", - '404': "CommonResponseError", - '422': "CommonResponseError", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsignbulksend/{pkiEzsignbulksendID}/createEzsignbulksendtransmission', 'POST', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='POST', + resource_path='/1/object/ezsignbulksend/{pkiEzsignbulksendID}/createEzsignbulksendtransmission', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + - @validate_arguments - def ezsignbulksend_create_object_v1(self, ezsignbulksend_create_object_v1_request : EzsignbulksendCreateObjectV1Request, **kwargs) -> EzsignbulksendCreateObjectV1Response: # noqa: E501 - """Create a new Ezsignbulksend # noqa: E501 - The endpoint allows to create one or many elements at once. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def ezsignbulksend_create_object_v1( + self, + ezsignbulksend_create_object_v1_request: EzsignbulksendCreateObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsignbulksendCreateObjectV1Response: + """Create a new Ezsignbulksend - >>> thread = api.ezsignbulksend_create_object_v1(ezsignbulksend_create_object_v1_request, async_req=True) - >>> result = thread.get() + The endpoint allows to create one or many elements at once. :param ezsignbulksend_create_object_v1_request: (required) :type ezsignbulksend_create_object_v1_request: EzsignbulksendCreateObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsignbulksendCreateObjectV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsignbulksend_create_object_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsignbulksend_create_object_v1_with_http_info(ezsignbulksend_create_object_v1_request, **kwargs) # noqa: E501 - - @validate_arguments - def ezsignbulksend_create_object_v1_with_http_info(self, ezsignbulksend_create_object_v1_request : EzsignbulksendCreateObjectV1Request, **kwargs) -> ApiResponse: # noqa: E501 - """Create a new Ezsignbulksend # noqa: E501 - - The endpoint allows to create one or many elements at once. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsignbulksend_create_object_v1_with_http_info(ezsignbulksend_create_object_v1_request, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._ezsignbulksend_create_object_v1_serialize( + ezsignbulksend_create_object_v1_request=ezsignbulksend_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "EzsignbulksendCreateObjectV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsignbulksend_create_object_v1_with_http_info( + self, + ezsignbulksend_create_object_v1_request: EzsignbulksendCreateObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsignbulksendCreateObjectV1Response]: + """Create a new Ezsignbulksend + + The endpoint allows to create one or many elements at once. :param ezsignbulksend_create_object_v1_request: (required) :type ezsignbulksend_create_object_v1_request: EzsignbulksendCreateObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsignbulksendCreateObjectV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._ezsignbulksend_create_object_v1_serialize( + ezsignbulksend_create_object_v1_request=ezsignbulksend_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "EzsignbulksendCreateObjectV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _params = locals() - _all_params = [ - 'ezsignbulksend_create_object_v1_request' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + @validate_call + def ezsignbulksend_create_object_v1_without_preload_content( + self, + ezsignbulksend_create_object_v1_request: EzsignbulksendCreateObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Create a new Ezsignbulksend + + The endpoint allows to create one or many elements at once. + + :param ezsignbulksend_create_object_v1_request: (required) + :type ezsignbulksend_create_object_v1_request: EzsignbulksendCreateObjectV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignbulksend_create_object_v1_serialize( + ezsignbulksend_create_object_v1_request=ezsignbulksend_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsignbulksend_create_object_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '201': "EzsignbulksendCreateObjectV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} + def _ezsignbulksend_create_object_v1_serialize( + self, + ezsignbulksend_create_object_v1_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['ezsignbulksend_create_object_v1_request'] is not None: - _body_params = _params['ezsignbulksend_create_object_v1_request'] + if ezsignbulksend_create_object_v1_request is not None: + _body_params = ezsignbulksend_create_object_v1_request + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '201': "EzsignbulksendCreateObjectV1Response", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsignbulksend', 'POST', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='POST', + resource_path='/1/object/ezsignbulksend', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) - @validate_arguments - def ezsignbulksend_delete_object_v1(self, pki_ezsignbulksend_id : conint(strict=True, ge=0), **kwargs) -> EzsignbulksendDeleteObjectV1Response: # noqa: E501 - """Delete an existing Ezsignbulksend # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.ezsignbulksend_delete_object_v1(pki_ezsignbulksend_id, async_req=True) - >>> result = thread.get() - :param pki_ezsignbulksend_id: (required) - :type pki_ezsignbulksend_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsignbulksendDeleteObjectV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsignbulksend_delete_object_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsignbulksend_delete_object_v1_with_http_info(pki_ezsignbulksend_id, **kwargs) # noqa: E501 - - @validate_arguments - def ezsignbulksend_delete_object_v1_with_http_info(self, pki_ezsignbulksend_id : conint(strict=True, ge=0), **kwargs) -> ApiResponse: # noqa: E501 - """Delete an existing Ezsignbulksend # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsignbulksend_delete_object_v1_with_http_info(pki_ezsignbulksend_id, async_req=True) - >>> result = thread.get() + @validate_call + def ezsignbulksend_delete_object_v1( + self, + pki_ezsignbulksend_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsignbulksendDeleteObjectV1Response: + """Delete an existing Ezsignbulksend + + :param pki_ezsignbulksend_id: (required) :type pki_ezsignbulksend_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsignbulksendDeleteObjectV1Response, status_code(int), headers(HTTPHeaderDict)) - """ - - _params = locals() - - _all_params = [ - 'pki_ezsignbulksend_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' - ] + """ # noqa: E501 + + _param = self._ezsignbulksend_delete_object_v1_serialize( + pki_ezsignbulksend_id=pki_ezsignbulksend_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsignbulksend_delete_object_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] - - _collection_formats = {} - - # process the path parameters - _path_params = {} - if _params['pki_ezsignbulksend_id']: - _path_params['pkiEzsignbulksendID'] = _params['pki_ezsignbulksend_id'] - - - # process the query parameters - _query_params = [] - # process the header parameters - _header_params = dict(_params.get('_headers', {})) - # process the form parameters - _form_params = [] - _files = {} - # process the body parameter - _body_params = None - # set the HTTP header `Accept` - _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 - - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { + _response_types_map: Dict[str, Optional[str]] = { '200': "EzsignbulksendDeleteObjectV1Response", '404': "CommonResponseError", '422': "CommonResponseError", } - - return self.api_client.call_api( - '/1/object/ezsignbulksend/{pkiEzsignbulksendID}', 'DELETE', - _path_params, - _query_params, - _header_params, - body=_body_params, - post_params=_form_params, - files=_files, + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, response_types_map=_response_types_map, - auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), - collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) - - @validate_arguments - def ezsignbulksend_edit_object_v1(self, pki_ezsignbulksend_id : conint(strict=True, ge=0), ezsignbulksend_edit_object_v1_request : EzsignbulksendEditObjectV1Request, **kwargs) -> EzsignbulksendEditObjectV1Response: # noqa: E501 - """Edit an existing Ezsignbulksend # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsignbulksend_edit_object_v1(pki_ezsignbulksend_id, ezsignbulksend_edit_object_v1_request, async_req=True) - >>> result = thread.get() + ).data + + + @validate_call + def ezsignbulksend_delete_object_v1_with_http_info( + self, + pki_ezsignbulksend_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsignbulksendDeleteObjectV1Response]: + """Delete an existing Ezsignbulksend - :param pki_ezsignbulksend_id: (required) - :type pki_ezsignbulksend_id: int - :param ezsignbulksend_edit_object_v1_request: (required) - :type ezsignbulksend_edit_object_v1_request: EzsignbulksendEditObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsignbulksendEditObjectV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsignbulksend_edit_object_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsignbulksend_edit_object_v1_with_http_info(pki_ezsignbulksend_id, ezsignbulksend_edit_object_v1_request, **kwargs) # noqa: E501 - - @validate_arguments - def ezsignbulksend_edit_object_v1_with_http_info(self, pki_ezsignbulksend_id : conint(strict=True, ge=0), ezsignbulksend_edit_object_v1_request : EzsignbulksendEditObjectV1Request, **kwargs) -> ApiResponse: # noqa: E501 - """Edit an existing Ezsignbulksend # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsignbulksend_edit_object_v1_with_http_info(pki_ezsignbulksend_id, ezsignbulksend_edit_object_v1_request, async_req=True) - >>> result = thread.get() + :param pki_ezsignbulksend_id: (required) :type pki_ezsignbulksend_id: int - :param ezsignbulksend_edit_object_v1_request: (required) - :type ezsignbulksend_edit_object_v1_request: EzsignbulksendEditObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsignbulksendEditObjectV1Response, status_code(int), headers(HTTPHeaderDict)) - """ - - _params = locals() - - _all_params = [ - 'pki_ezsignbulksend_id', - 'ezsignbulksend_edit_object_v1_request' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' - ] + """ # noqa: E501 + + _param = self._ezsignbulksend_delete_object_v1_serialize( + pki_ezsignbulksend_id=pki_ezsignbulksend_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsignbulksend_edit_object_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] - - _collection_formats = {} - - # process the path parameters - _path_params = {} - if _params['pki_ezsignbulksend_id']: - _path_params['pkiEzsignbulksendID'] = _params['pki_ezsignbulksend_id'] - - - # process the query parameters - _query_params = [] - # process the header parameters - _header_params = dict(_params.get('_headers', {})) - # process the form parameters - _form_params = [] - _files = {} - # process the body parameter - _body_params = None - if _params['ezsignbulksend_edit_object_v1_request'] is not None: - _body_params = _params['ezsignbulksend_edit_object_v1_request'] - - # set the HTTP header `Accept` - _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 - - # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list - - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '200': "EzsignbulksendEditObjectV1Response", + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignbulksendDeleteObjectV1Response", '404': "CommonResponseError", '422': "CommonResponseError", } - - return self.api_client.call_api( - '/1/object/ezsignbulksend/{pkiEzsignbulksendID}', 'PUT', - _path_params, - _query_params, - _header_params, - body=_body_params, - post_params=_form_params, - files=_files, + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, response_types_map=_response_types_map, - auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), - collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) - - @validate_arguments - def ezsignbulksend_get_csv_template_v1(self, pki_ezsignbulksend_id : conint(strict=True, ge=0), e_csv_separator : Annotated[StrictStr, Field(..., description="Separator that will be used to separate fields")], **kwargs) -> str: # noqa: E501 - """Retrieve an existing Ezsignbulksend's empty Csv template # noqa: E501 + ) - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.ezsignbulksend_get_csv_template_v1(pki_ezsignbulksend_id, e_csv_separator, async_req=True) - >>> result = thread.get() + @validate_call + def ezsignbulksend_delete_object_v1_without_preload_content( + self, + pki_ezsignbulksend_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete an existing Ezsignbulksend - :param pki_ezsignbulksend_id: (required) - :type pki_ezsignbulksend_id: int - :param e_csv_separator: Separator that will be used to separate fields (required) - :type e_csv_separator: str - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: str - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsignbulksend_get_csv_template_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsignbulksend_get_csv_template_v1_with_http_info(pki_ezsignbulksend_id, e_csv_separator, **kwargs) # noqa: E501 - - @validate_arguments - def ezsignbulksend_get_csv_template_v1_with_http_info(self, pki_ezsignbulksend_id : conint(strict=True, ge=0), e_csv_separator : Annotated[StrictStr, Field(..., description="Separator that will be used to separate fields")], **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve an existing Ezsignbulksend's empty Csv template # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsignbulksend_get_csv_template_v1_with_http_info(pki_ezsignbulksend_id, e_csv_separator, async_req=True) - >>> result = thread.get() + :param pki_ezsignbulksend_id: (required) :type pki_ezsignbulksend_id: int - :param e_csv_separator: Separator that will be used to separate fields (required) - :type e_csv_separator: str - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(str, status_code(int), headers(HTTPHeaderDict)) - """ - - _params = locals() + """ # noqa: E501 + + _param = self._ezsignbulksend_delete_object_v1_serialize( + pki_ezsignbulksend_id=pki_ezsignbulksend_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _all_params = [ - 'pki_ezsignbulksend_id', - 'e_csv_separator' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' - ] + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignbulksendDeleteObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) + return response_data.response - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsignbulksend_get_csv_template_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] - _collection_formats = {} + def _ezsignbulksend_delete_object_v1_serialize( + self, + pki_ezsignbulksend_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: - # process the path parameters - _path_params = {} - if _params['pki_ezsignbulksend_id']: - _path_params['pkiEzsignbulksendID'] = _params['pki_ezsignbulksend_id'] + _host = None + _collection_formats: Dict[str, str] = { + } - # process the query parameters - _query_params = [] - if _params.get('e_csv_separator') is not None: # noqa: E501 - _query_params.append(('eCsvSeparator', _params['e_csv_separator'])) + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if pki_ezsignbulksend_id is not None: + _path_params['pkiEzsignbulksendID'] = pki_ezsignbulksend_id + # process the query parameters # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['text/csv', 'application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "str", - '404': "CommonResponseError", - '406': "CommonResponseError", - '422': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsignbulksend/{pkiEzsignbulksendID}/getCsvTemplate', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='DELETE', + resource_path='/1/object/ezsignbulksend/{pkiEzsignbulksendID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) - @validate_arguments - def ezsignbulksend_get_ezsignbulksendtransmissions_v1(self, pki_ezsignbulksend_id : conint(strict=True, ge=0), **kwargs) -> EzsignbulksendGetEzsignbulksendtransmissionsV1Response: # noqa: E501 - """Retrieve an existing Ezsignbulksend's Ezsignbulksendtransmissions # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.ezsignbulksend_get_ezsignbulksendtransmissions_v1(pki_ezsignbulksend_id, async_req=True) - >>> result = thread.get() - :param pki_ezsignbulksend_id: (required) - :type pki_ezsignbulksend_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsignbulksendGetEzsignbulksendtransmissionsV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsignbulksend_get_ezsignbulksendtransmissions_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsignbulksend_get_ezsignbulksendtransmissions_v1_with_http_info(pki_ezsignbulksend_id, **kwargs) # noqa: E501 - - @validate_arguments - def ezsignbulksend_get_ezsignbulksendtransmissions_v1_with_http_info(self, pki_ezsignbulksend_id : conint(strict=True, ge=0), **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve an existing Ezsignbulksend's Ezsignbulksendtransmissions # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsignbulksend_get_ezsignbulksendtransmissions_v1_with_http_info(pki_ezsignbulksend_id, async_req=True) - >>> result = thread.get() + @validate_call + def ezsignbulksend_edit_object_v1( + self, + pki_ezsignbulksend_id: Annotated[int, Field(strict=True, ge=0)], + ezsignbulksend_edit_object_v1_request: EzsignbulksendEditObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsignbulksendEditObjectV1Response: + """Edit an existing Ezsignbulksend + + :param pki_ezsignbulksend_id: (required) :type pki_ezsignbulksend_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional + :param ezsignbulksend_edit_object_v1_request: (required) + :type ezsignbulksend_edit_object_v1_request: EzsignbulksendEditObjectV1Request :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsignbulksendGetEzsignbulksendtransmissionsV1Response, status_code(int), headers(HTTPHeaderDict)) - """ - - _params = locals() - - _all_params = [ - 'pki_ezsignbulksend_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' - ] + """ # noqa: E501 + + _param = self._ezsignbulksend_edit_object_v1_serialize( + pki_ezsignbulksend_id=pki_ezsignbulksend_id, + ezsignbulksend_edit_object_v1_request=ezsignbulksend_edit_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsignbulksend_get_ezsignbulksendtransmissions_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] - - _collection_formats = {} - - # process the path parameters - _path_params = {} - if _params['pki_ezsignbulksend_id']: - _path_params['pkiEzsignbulksendID'] = _params['pki_ezsignbulksend_id'] - + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignbulksendEditObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsignbulksend_edit_object_v1_with_http_info( + self, + pki_ezsignbulksend_id: Annotated[int, Field(strict=True, ge=0)], + ezsignbulksend_edit_object_v1_request: EzsignbulksendEditObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsignbulksendEditObjectV1Response]: + """Edit an existing Ezsignbulksend + + + + :param pki_ezsignbulksend_id: (required) + :type pki_ezsignbulksend_id: int + :param ezsignbulksend_edit_object_v1_request: (required) + :type ezsignbulksend_edit_object_v1_request: EzsignbulksendEditObjectV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignbulksend_edit_object_v1_serialize( + pki_ezsignbulksend_id=pki_ezsignbulksend_id, + ezsignbulksend_edit_object_v1_request=ezsignbulksend_edit_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignbulksendEditObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def ezsignbulksend_edit_object_v1_without_preload_content( + self, + pki_ezsignbulksend_id: Annotated[int, Field(strict=True, ge=0)], + ezsignbulksend_edit_object_v1_request: EzsignbulksendEditObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Edit an existing Ezsignbulksend + + + + :param pki_ezsignbulksend_id: (required) + :type pki_ezsignbulksend_id: int + :param ezsignbulksend_edit_object_v1_request: (required) + :type ezsignbulksend_edit_object_v1_request: EzsignbulksendEditObjectV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignbulksend_edit_object_v1_serialize( + pki_ezsignbulksend_id=pki_ezsignbulksend_id, + ezsignbulksend_edit_object_v1_request=ezsignbulksend_edit_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignbulksendEditObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _ezsignbulksend_edit_object_v1_serialize( + self, + pki_ezsignbulksend_id, + ezsignbulksend_edit_object_v1_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_ezsignbulksend_id is not None: + _path_params['pkiEzsignbulksendID'] = pki_ezsignbulksend_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if ezsignbulksend_edit_object_v1_request is not None: + _body_params = ezsignbulksend_edit_object_v1_request + + + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/1/object/ezsignbulksend/{pkiEzsignbulksendID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def ezsignbulksend_get_csv_template_v1( + self, + pki_ezsignbulksend_id: Annotated[int, Field(strict=True, ge=0)], + e_csv_separator: Annotated[StrictStr, Field(description="Separator that will be used to separate fields")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> str: + """Retrieve an existing Ezsignbulksend's empty Csv template + + + + :param pki_ezsignbulksend_id: (required) + :type pki_ezsignbulksend_id: int + :param e_csv_separator: Separator that will be used to separate fields (required) + :type e_csv_separator: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignbulksend_get_csv_template_v1_serialize( + pki_ezsignbulksend_id=pki_ezsignbulksend_id, + e_csv_separator=e_csv_separator, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "str", + '404': "CommonResponseError", + '406': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsignbulksend_get_csv_template_v1_with_http_info( + self, + pki_ezsignbulksend_id: Annotated[int, Field(strict=True, ge=0)], + e_csv_separator: Annotated[StrictStr, Field(description="Separator that will be used to separate fields")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[str]: + """Retrieve an existing Ezsignbulksend's empty Csv template + + + + :param pki_ezsignbulksend_id: (required) + :type pki_ezsignbulksend_id: int + :param e_csv_separator: Separator that will be used to separate fields (required) + :type e_csv_separator: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignbulksend_get_csv_template_v1_serialize( + pki_ezsignbulksend_id=pki_ezsignbulksend_id, + e_csv_separator=e_csv_separator, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "str", + '404': "CommonResponseError", + '406': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def ezsignbulksend_get_csv_template_v1_without_preload_content( + self, + pki_ezsignbulksend_id: Annotated[int, Field(strict=True, ge=0)], + e_csv_separator: Annotated[StrictStr, Field(description="Separator that will be used to separate fields")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve an existing Ezsignbulksend's empty Csv template + + + + :param pki_ezsignbulksend_id: (required) + :type pki_ezsignbulksend_id: int + :param e_csv_separator: Separator that will be used to separate fields (required) + :type e_csv_separator: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignbulksend_get_csv_template_v1_serialize( + pki_ezsignbulksend_id=pki_ezsignbulksend_id, + e_csv_separator=e_csv_separator, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + _response_types_map: Dict[str, Optional[str]] = { + '200': "str", + '404': "CommonResponseError", + '406': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _ezsignbulksend_get_csv_template_v1_serialize( + self, + pki_ezsignbulksend_id, + e_csv_separator, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_ezsignbulksend_id is not None: + _path_params['pkiEzsignbulksendID'] = pki_ezsignbulksend_id # process the query parameters - _query_params = [] + if e_csv_separator is not None: + + _query_params.append(('eCsvSeparator', e_csv_separator)) + # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'text/csv', + 'application/json' + ] + ) + # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 + _auth_settings: List[str] = [ + 'Authorization' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/1/object/ezsignbulksend/{pkiEzsignbulksendID}/getCsvTemplate', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + - _response_types_map = { + + @validate_call + def ezsignbulksend_get_ezsignbulksendtransmissions_v1( + self, + pki_ezsignbulksend_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsignbulksendGetEzsignbulksendtransmissionsV1Response: + """Retrieve an existing Ezsignbulksend's Ezsignbulksendtransmissions + + + + :param pki_ezsignbulksend_id: (required) + :type pki_ezsignbulksend_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignbulksend_get_ezsignbulksendtransmissions_v1_serialize( + pki_ezsignbulksend_id=pki_ezsignbulksend_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { '200': "EzsignbulksendGetEzsignbulksendtransmissionsV1Response", '404': "CommonResponseError", } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsignbulksend_get_ezsignbulksendtransmissions_v1_with_http_info( + self, + pki_ezsignbulksend_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsignbulksendGetEzsignbulksendtransmissionsV1Response]: + """Retrieve an existing Ezsignbulksend's Ezsignbulksendtransmissions - return self.api_client.call_api( - '/1/object/ezsignbulksend/{pkiEzsignbulksendID}/getEzsignbulksendtransmissions', 'GET', - _path_params, - _query_params, - _header_params, + + + :param pki_ezsignbulksend_id: (required) + :type pki_ezsignbulksend_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignbulksend_get_ezsignbulksendtransmissions_v1_serialize( + pki_ezsignbulksend_id=pki_ezsignbulksend_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignbulksendGetEzsignbulksendtransmissionsV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def ezsignbulksend_get_ezsignbulksendtransmissions_v1_without_preload_content( + self, + pki_ezsignbulksend_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve an existing Ezsignbulksend's Ezsignbulksendtransmissions + + + + :param pki_ezsignbulksend_id: (required) + :type pki_ezsignbulksend_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignbulksend_get_ezsignbulksendtransmissions_v1_serialize( + pki_ezsignbulksend_id=pki_ezsignbulksend_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignbulksendGetEzsignbulksendtransmissionsV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _ezsignbulksend_get_ezsignbulksendtransmissions_v1_serialize( + self, + pki_ezsignbulksend_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_ezsignbulksend_id is not None: + _path_params['pkiEzsignbulksendID'] = pki_ezsignbulksend_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/1/object/ezsignbulksend/{pkiEzsignbulksendID}/getEzsignbulksendtransmissions', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def ezsignbulksend_get_ezsignsignatures_automatic_v1( + self, + pki_ezsignbulksend_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsignbulksendGetEzsignsignaturesAutomaticV1Response: + """Retrieve an existing Ezsignbulksend's automatic Ezsignsignatures + + Return the Ezsignsignatures that can be signed by the current user at the current step in the process + + :param pki_ezsignbulksend_id: (required) + :type pki_ezsignbulksend_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignbulksend_get_ezsignsignatures_automatic_v1_serialize( + pki_ezsignbulksend_id=pki_ezsignbulksend_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignbulksendGetEzsignsignaturesAutomaticV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsignbulksend_get_ezsignsignatures_automatic_v1_with_http_info( + self, + pki_ezsignbulksend_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsignbulksendGetEzsignsignaturesAutomaticV1Response]: + """Retrieve an existing Ezsignbulksend's automatic Ezsignsignatures + + Return the Ezsignsignatures that can be signed by the current user at the current step in the process + + :param pki_ezsignbulksend_id: (required) + :type pki_ezsignbulksend_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignbulksend_get_ezsignsignatures_automatic_v1_serialize( + pki_ezsignbulksend_id=pki_ezsignbulksend_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignbulksendGetEzsignsignaturesAutomaticV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def ezsignbulksend_get_ezsignsignatures_automatic_v1_without_preload_content( + self, + pki_ezsignbulksend_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve an existing Ezsignbulksend's automatic Ezsignsignatures + + Return the Ezsignsignatures that can be signed by the current user at the current step in the process + + :param pki_ezsignbulksend_id: (required) + :type pki_ezsignbulksend_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignbulksend_get_ezsignsignatures_automatic_v1_serialize( + pki_ezsignbulksend_id=pki_ezsignbulksend_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignbulksendGetEzsignsignaturesAutomaticV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _ezsignbulksend_get_ezsignsignatures_automatic_v1_serialize( + self, + pki_ezsignbulksend_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_ezsignbulksend_id is not None: + _path_params['pkiEzsignbulksendID'] = pki_ezsignbulksend_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/1/object/ezsignbulksend/{pkiEzsignbulksendID}/getEzsignsignaturesAutomatic', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + - @validate_arguments - def ezsignbulksend_get_ezsignsignatures_automatic_v1(self, pki_ezsignbulksend_id : conint(strict=True, ge=0), **kwargs) -> EzsignbulksendGetEzsignsignaturesAutomaticV1Response: # noqa: E501 - """Retrieve an existing Ezsignbulksend's automatic Ezsignsignatures # noqa: E501 - Return the Ezsignsignatures that can be signed by the current user at the current step in the process # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.ezsignbulksend_get_ezsignsignatures_automatic_v1(pki_ezsignbulksend_id, async_req=True) - >>> result = thread.get() + @validate_call + def ezsignbulksend_get_forms_data_v1( + self, + pki_ezsignbulksend_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsignbulksendGetFormsDataV1Response: + """Retrieve an existing Ezsignbulksend's forms data + + :param pki_ezsignbulksend_id: (required) :type pki_ezsignbulksend_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsignbulksendGetEzsignsignaturesAutomaticV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsignbulksend_get_ezsignsignatures_automatic_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsignbulksend_get_ezsignsignatures_automatic_v1_with_http_info(pki_ezsignbulksend_id, **kwargs) # noqa: E501 - - @validate_arguments - def ezsignbulksend_get_ezsignsignatures_automatic_v1_with_http_info(self, pki_ezsignbulksend_id : conint(strict=True, ge=0), **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve an existing Ezsignbulksend's automatic Ezsignsignatures # noqa: E501 - - Return the Ezsignsignatures that can be signed by the current user at the current step in the process # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsignbulksend_get_ezsignsignatures_automatic_v1_with_http_info(pki_ezsignbulksend_id, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._ezsignbulksend_get_forms_data_v1_serialize( + pki_ezsignbulksend_id=pki_ezsignbulksend_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignbulksendGetFormsDataV1Response", + '404': "CommonResponseError", + '406': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsignbulksend_get_forms_data_v1_with_http_info( + self, + pki_ezsignbulksend_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsignbulksendGetFormsDataV1Response]: + """Retrieve an existing Ezsignbulksend's forms data + + + + :param pki_ezsignbulksend_id: (required) + :type pki_ezsignbulksend_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignbulksend_get_forms_data_v1_serialize( + pki_ezsignbulksend_id=pki_ezsignbulksend_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignbulksendGetFormsDataV1Response", + '404': "CommonResponseError", + '406': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def ezsignbulksend_get_forms_data_v1_without_preload_content( + self, + pki_ezsignbulksend_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve an existing Ezsignbulksend's forms data + + :param pki_ezsignbulksend_id: (required) :type pki_ezsignbulksend_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsignbulksendGetEzsignsignaturesAutomaticV1Response, status_code(int), headers(HTTPHeaderDict)) - """ - - _params = locals() + """ # noqa: E501 + + _param = self._ezsignbulksend_get_forms_data_v1_serialize( + pki_ezsignbulksend_id=pki_ezsignbulksend_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _all_params = [ - 'pki_ezsignbulksend_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' - ] + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignbulksendGetFormsDataV1Response", + '404': "CommonResponseError", + '406': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) + return response_data.response - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsignbulksend_get_ezsignsignatures_automatic_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] - _collection_formats = {} + def _ezsignbulksend_get_forms_data_v1_serialize( + self, + pki_ezsignbulksend_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: - # process the path parameters - _path_params = {} - if _params['pki_ezsignbulksend_id']: - _path_params['pkiEzsignbulksendID'] = _params['pki_ezsignbulksend_id'] + _host = None + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if pki_ezsignbulksend_id is not None: + _path_params['pkiEzsignbulksendID'] = pki_ezsignbulksend_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json', + 'application/zip' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "EzsignbulksendGetEzsignsignaturesAutomaticV1Response", - '404': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsignbulksend/{pkiEzsignbulksendID}/getEzsignsignaturesAutomatic', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/1/object/ezsignbulksend/{pkiEzsignbulksendID}/getFormsData', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) - @validate_arguments - def ezsignbulksend_get_forms_data_v1(self, pki_ezsignbulksend_id : conint(strict=True, ge=0), **kwargs) -> EzsignbulksendGetFormsDataV1Response: # noqa: E501 - """Retrieve an existing Ezsignbulksend's forms data # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.ezsignbulksend_get_forms_data_v1(pki_ezsignbulksend_id, async_req=True) - >>> result = thread.get() - :param pki_ezsignbulksend_id: (required) - :type pki_ezsignbulksend_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsignbulksendGetFormsDataV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsignbulksend_get_forms_data_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsignbulksend_get_forms_data_v1_with_http_info(pki_ezsignbulksend_id, **kwargs) # noqa: E501 - - @validate_arguments - def ezsignbulksend_get_forms_data_v1_with_http_info(self, pki_ezsignbulksend_id : conint(strict=True, ge=0), **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve an existing Ezsignbulksend's forms data # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsignbulksend_get_forms_data_v1_with_http_info(pki_ezsignbulksend_id, async_req=True) - >>> result = thread.get() + @validate_call + def ezsignbulksend_get_list_v1( + self, + e_order_by: Annotated[Optional[StrictStr], Field(description="Specify how you want the results to be sorted")] = None, + i_row_max: Optional[Annotated[int, Field(le=10000, strict=True, ge=1)]] = None, + i_row_offset: Optional[Annotated[int, Field(strict=True, ge=0)]] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + s_filter: Optional[StrictStr] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsignbulksendGetListV1Response: + """Retrieve Ezsignbulksend list - :param pki_ezsignbulksend_id: (required) - :type pki_ezsignbulksend_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional + Enum values that can be filtered in query parameter *sFilter*: | Variable | Valid values | |---|---| | eEzsignfoldertypePrivacylevel | User
Usergroup | + + :param e_order_by: Specify how you want the results to be sorted + :type e_order_by: str + :param i_row_max: + :type i_row_max: int + :param i_row_offset: + :type i_row_offset: int + :param accept_language: + :type accept_language: HeaderAcceptLanguage + :param s_filter: + :type s_filter: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsignbulksendGetFormsDataV1Response, status_code(int), headers(HTTPHeaderDict)) - """ - - _params = locals() - - _all_params = [ - 'pki_ezsignbulksend_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' - ] + """ # noqa: E501 + + _param = self._ezsignbulksend_get_list_v1_serialize( + e_order_by=e_order_by, + i_row_max=i_row_max, + i_row_offset=i_row_offset, + accept_language=accept_language, + s_filter=s_filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsignbulksend_get_forms_data_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] - - _collection_formats = {} - - # process the path parameters - _path_params = {} - if _params['pki_ezsignbulksend_id']: - _path_params['pkiEzsignbulksendID'] = _params['pki_ezsignbulksend_id'] - - - # process the query parameters - _query_params = [] - # process the header parameters - _header_params = dict(_params.get('_headers', {})) - # process the form parameters - _form_params = [] - _files = {} - # process the body parameter - _body_params = None - # set the HTTP header `Accept` - _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json', 'application/zip']) # noqa: E501 - - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '200': "EzsignbulksendGetFormsDataV1Response", - '404': "CommonResponseError", + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignbulksendGetListV1Response", '406': "CommonResponseError", - '422': "CommonResponseError", } - - return self.api_client.call_api( - '/1/object/ezsignbulksend/{pkiEzsignbulksendID}/getFormsData', 'GET', - _path_params, - _query_params, - _header_params, - body=_body_params, - post_params=_form_params, - files=_files, + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, response_types_map=_response_types_map, - auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), - collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) - - @validate_arguments - def ezsignbulksend_get_list_v1(self, e_order_by : Annotated[Optional[StrictStr], Field(description="Specify how you want the results to be sorted")] = None, i_row_max : Optional[conint(strict=True, le=10000, ge=1)] = None, i_row_offset : Optional[conint(strict=True, ge=0)] = None, accept_language : Optional[HeaderAcceptLanguage] = None, s_filter : Optional[StrictStr] = None, **kwargs) -> EzsignbulksendGetListV1Response: # noqa: E501 - """Retrieve Ezsignbulksend list # noqa: E501 - - Enum values that can be filtered in query parameter *sFilter*: | Variable | Valid values | |---|---| | eEzsignfoldertypePrivacylevel | User
Usergroup | # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + ).data + + + @validate_call + def ezsignbulksend_get_list_v1_with_http_info( + self, + e_order_by: Annotated[Optional[StrictStr], Field(description="Specify how you want the results to be sorted")] = None, + i_row_max: Optional[Annotated[int, Field(le=10000, strict=True, ge=1)]] = None, + i_row_offset: Optional[Annotated[int, Field(strict=True, ge=0)]] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + s_filter: Optional[StrictStr] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsignbulksendGetListV1Response]: + """Retrieve Ezsignbulksend list - >>> thread = api.ezsignbulksend_get_list_v1(e_order_by, i_row_max, i_row_offset, accept_language, s_filter, async_req=True) - >>> result = thread.get() + Enum values that can be filtered in query parameter *sFilter*: | Variable | Valid values | |---|---| | eEzsignfoldertypePrivacylevel | User
Usergroup | :param e_order_by: Specify how you want the results to be sorted :type e_order_by: str @@ -1258,33 +2374,79 @@ def ezsignbulksend_get_list_v1(self, e_order_by : Annotated[Optional[StrictStr], :type accept_language: HeaderAcceptLanguage :param s_filter: :type s_filter: str - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsignbulksendGetListV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsignbulksend_get_list_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsignbulksend_get_list_v1_with_http_info(e_order_by, i_row_max, i_row_offset, accept_language, s_filter, **kwargs) # noqa: E501 - - @validate_arguments - def ezsignbulksend_get_list_v1_with_http_info(self, e_order_by : Annotated[Optional[StrictStr], Field(description="Specify how you want the results to be sorted")] = None, i_row_max : Optional[conint(strict=True, le=10000, ge=1)] = None, i_row_offset : Optional[conint(strict=True, ge=0)] = None, accept_language : Optional[HeaderAcceptLanguage] = None, s_filter : Optional[StrictStr] = None, **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve Ezsignbulksend list # noqa: E501 - - Enum values that can be filtered in query parameter *sFilter*: | Variable | Valid values | |---|---| | eEzsignfoldertypePrivacylevel | User
Usergroup | # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsignbulksend_get_list_v1_with_http_info(e_order_by, i_row_max, i_row_offset, accept_language, s_filter, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._ezsignbulksend_get_list_v1_serialize( + e_order_by=e_order_by, + i_row_max=i_row_max, + i_row_offset=i_row_offset, + accept_language=accept_language, + s_filter=s_filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignbulksendGetListV1Response", + '406': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def ezsignbulksend_get_list_v1_without_preload_content( + self, + e_order_by: Annotated[Optional[StrictStr], Field(description="Specify how you want the results to be sorted")] = None, + i_row_max: Optional[Annotated[int, Field(le=10000, strict=True, ge=1)]] = None, + i_row_offset: Optional[Annotated[int, Field(strict=True, ge=0)]] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + s_filter: Optional[StrictStr] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve Ezsignbulksend list + + Enum values that can be filtered in query parameter *sFilter*: | Variable | Valid values | |---|---| | eEzsignfoldertypePrivacylevel | User
Usergroup | :param e_order_by: Specify how you want the results to be sorted :type e_order_by: str @@ -1296,412 +2458,678 @@ def ezsignbulksend_get_list_v1_with_http_info(self, e_order_by : Annotated[Optio :type accept_language: HeaderAcceptLanguage :param s_filter: :type s_filter: str - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsignbulksendGetListV1Response, status_code(int), headers(HTTPHeaderDict)) - """ - - _params = locals() - - _all_params = [ - 'e_order_by', - 'i_row_max', - 'i_row_offset', - 'accept_language', - 's_filter' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' - ] + """ # noqa: E501 + + _param = self._ezsignbulksend_get_list_v1_serialize( + e_order_by=e_order_by, + i_row_max=i_row_max, + i_row_offset=i_row_offset, + accept_language=accept_language, + s_filter=s_filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsignbulksend_get_list_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] - - _collection_formats = {} + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignbulksendGetListV1Response", + '406': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - # process the path parameters - _path_params = {} - # process the query parameters - _query_params = [] - if _params.get('e_order_by') is not None: # noqa: E501 - _query_params.append(('eOrderBy', _params['e_order_by'])) + def _ezsignbulksend_get_list_v1_serialize( + self, + e_order_by, + i_row_max, + i_row_offset, + accept_language, + s_filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: - if _params.get('i_row_max') is not None: # noqa: E501 - _query_params.append(('iRowMax', _params['i_row_max'])) + _host = None - if _params.get('i_row_offset') is not None: # noqa: E501 - _query_params.append(('iRowOffset', _params['i_row_offset'])) + _collection_formats: Dict[str, str] = { + } - if _params.get('s_filter') is not None: # noqa: E501 - _query_params.append(('sFilter', _params['s_filter'])) + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + # process the query parameters + if e_order_by is not None: + + _query_params.append(('eOrderBy', e_order_by)) + + if i_row_max is not None: + + _query_params.append(('iRowMax', i_row_max)) + + if i_row_offset is not None: + + _query_params.append(('iRowOffset', i_row_offset)) + + if s_filter is not None: + + _query_params.append(('sFilter', s_filter)) + # process the header parameters - _header_params = dict(_params.get('_headers', {})) - if _params['accept_language']: - _header_params['Accept-Language'] = _params['accept_language'] - + if accept_language is not None: + _header_params['Accept-Language'] = accept_language # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet']) # noqa: E501 + [ + 'application/json', + 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "EzsignbulksendGetListV1Response", - '406': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsignbulksend/getList', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/1/object/ezsignbulksend/getList', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + - @validate_arguments - def ezsignbulksend_get_object_v2(self, pki_ezsignbulksend_id : conint(strict=True, ge=0), **kwargs) -> EzsignbulksendGetObjectV2Response: # noqa: E501 - """Retrieve an existing Ezsignbulksend # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.ezsignbulksend_get_object_v2(pki_ezsignbulksend_id, async_req=True) - >>> result = thread.get() + @validate_call + def ezsignbulksend_get_object_v2( + self, + pki_ezsignbulksend_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsignbulksendGetObjectV2Response: + """Retrieve an existing Ezsignbulksend + + :param pki_ezsignbulksend_id: (required) :type pki_ezsignbulksend_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsignbulksendGetObjectV2Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsignbulksend_get_object_v2_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsignbulksend_get_object_v2_with_http_info(pki_ezsignbulksend_id, **kwargs) # noqa: E501 - - @validate_arguments - def ezsignbulksend_get_object_v2_with_http_info(self, pki_ezsignbulksend_id : conint(strict=True, ge=0), **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve an existing Ezsignbulksend # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsignbulksend_get_object_v2_with_http_info(pki_ezsignbulksend_id, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._ezsignbulksend_get_object_v2_serialize( + pki_ezsignbulksend_id=pki_ezsignbulksend_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignbulksendGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsignbulksend_get_object_v2_with_http_info( + self, + pki_ezsignbulksend_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsignbulksendGetObjectV2Response]: + """Retrieve an existing Ezsignbulksend + + :param pki_ezsignbulksend_id: (required) :type pki_ezsignbulksend_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsignbulksendGetObjectV2Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._ezsignbulksend_get_object_v2_serialize( + pki_ezsignbulksend_id=pki_ezsignbulksend_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignbulksendGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'pki_ezsignbulksend_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def ezsignbulksend_get_object_v2_without_preload_content( + self, + pki_ezsignbulksend_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve an existing Ezsignbulksend + + + + :param pki_ezsignbulksend_id: (required) + :type pki_ezsignbulksend_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignbulksend_get_object_v2_serialize( + pki_ezsignbulksend_id=pki_ezsignbulksend_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsignbulksend_get_object_v2" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignbulksendGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_ezsignbulksend_id']: - _path_params['pkiEzsignbulksendID'] = _params['pki_ezsignbulksend_id'] + def _ezsignbulksend_get_object_v2_serialize( + self, + pki_ezsignbulksend_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if pki_ezsignbulksend_id is not None: + _path_params['pkiEzsignbulksendID'] = pki_ezsignbulksend_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "EzsignbulksendGetObjectV2Response", - '404': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/2/object/ezsignbulksend/{pkiEzsignbulksendID}', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/2/object/ezsignbulksend/{pkiEzsignbulksendID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + - @validate_arguments - def ezsignbulksend_reorder_v1(self, pki_ezsignbulksend_id : conint(strict=True, ge=0), ezsignbulksend_reorder_v1_request : EzsignbulksendReorderV1Request, **kwargs) -> EzsignbulksendReorderV1Response: # noqa: E501 - """Reorder Ezsignbulksenddocumentmappings in the Ezsignbulksend # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.ezsignbulksend_reorder_v1(pki_ezsignbulksend_id, ezsignbulksend_reorder_v1_request, async_req=True) - >>> result = thread.get() + @validate_call + def ezsignbulksend_reorder_v1( + self, + pki_ezsignbulksend_id: Annotated[int, Field(strict=True, ge=0)], + ezsignbulksend_reorder_v1_request: EzsignbulksendReorderV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsignbulksendReorderV1Response: + """Reorder Ezsignbulksenddocumentmappings in the Ezsignbulksend + :param pki_ezsignbulksend_id: (required) :type pki_ezsignbulksend_id: int :param ezsignbulksend_reorder_v1_request: (required) :type ezsignbulksend_reorder_v1_request: EzsignbulksendReorderV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsignbulksendReorderV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsignbulksend_reorder_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsignbulksend_reorder_v1_with_http_info(pki_ezsignbulksend_id, ezsignbulksend_reorder_v1_request, **kwargs) # noqa: E501 - - @validate_arguments - def ezsignbulksend_reorder_v1_with_http_info(self, pki_ezsignbulksend_id : conint(strict=True, ge=0), ezsignbulksend_reorder_v1_request : EzsignbulksendReorderV1Request, **kwargs) -> ApiResponse: # noqa: E501 - """Reorder Ezsignbulksenddocumentmappings in the Ezsignbulksend # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsignbulksend_reorder_v1_with_http_info(pki_ezsignbulksend_id, ezsignbulksend_reorder_v1_request, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._ezsignbulksend_reorder_v1_serialize( + pki_ezsignbulksend_id=pki_ezsignbulksend_id, + ezsignbulksend_reorder_v1_request=ezsignbulksend_reorder_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignbulksendReorderV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsignbulksend_reorder_v1_with_http_info( + self, + pki_ezsignbulksend_id: Annotated[int, Field(strict=True, ge=0)], + ezsignbulksend_reorder_v1_request: EzsignbulksendReorderV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsignbulksendReorderV1Response]: + """Reorder Ezsignbulksenddocumentmappings in the Ezsignbulksend + :param pki_ezsignbulksend_id: (required) :type pki_ezsignbulksend_id: int :param ezsignbulksend_reorder_v1_request: (required) :type ezsignbulksend_reorder_v1_request: EzsignbulksendReorderV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsignbulksendReorderV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._ezsignbulksend_reorder_v1_serialize( + pki_ezsignbulksend_id=pki_ezsignbulksend_id, + ezsignbulksend_reorder_v1_request=ezsignbulksend_reorder_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignbulksendReorderV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _params = locals() - _all_params = [ - 'pki_ezsignbulksend_id', - 'ezsignbulksend_reorder_v1_request' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + @validate_call + def ezsignbulksend_reorder_v1_without_preload_content( + self, + pki_ezsignbulksend_id: Annotated[int, Field(strict=True, ge=0)], + ezsignbulksend_reorder_v1_request: EzsignbulksendReorderV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Reorder Ezsignbulksenddocumentmappings in the Ezsignbulksend + + + :param pki_ezsignbulksend_id: (required) + :type pki_ezsignbulksend_id: int + :param ezsignbulksend_reorder_v1_request: (required) + :type ezsignbulksend_reorder_v1_request: EzsignbulksendReorderV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignbulksend_reorder_v1_serialize( + pki_ezsignbulksend_id=pki_ezsignbulksend_id, + ezsignbulksend_reorder_v1_request=ezsignbulksend_reorder_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsignbulksend_reorder_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignbulksendReorderV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_ezsignbulksend_id']: - _path_params['pkiEzsignbulksendID'] = _params['pki_ezsignbulksend_id'] + def _ezsignbulksend_reorder_v1_serialize( + self, + pki_ezsignbulksend_id, + ezsignbulksend_reorder_v1_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if pki_ezsignbulksend_id is not None: + _path_params['pkiEzsignbulksendID'] = pki_ezsignbulksend_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['ezsignbulksend_reorder_v1_request'] is not None: - _body_params = _params['ezsignbulksend_reorder_v1_request'] + if ezsignbulksend_reorder_v1_request is not None: + _body_params = ezsignbulksend_reorder_v1_request + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '200': "EzsignbulksendReorderV1Response", - '404': "CommonResponseError", - '422': "CommonResponseError", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsignbulksend/{pkiEzsignbulksendID}/reorder', 'POST', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='POST', + resource_path='/1/object/ezsignbulksend/{pkiEzsignbulksendID}/reorder', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/eZmaxApi/api/object_ezsignbulksenddocumentmapping_api.py b/eZmaxApi/api/object_ezsignbulksenddocumentmapping_api.py index 494d7eb08..1ff5a4bde 100644 --- a/eZmaxApi/api/object_ezsignbulksenddocumentmapping_api.py +++ b/eZmaxApi/api/object_ezsignbulksenddocumentmapping_api.py @@ -13,14 +13,19 @@ """ # noqa: E501 -import re # noqa: F401 import io import warnings -from pydantic import validate_arguments, ValidationError +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Dict, List, Optional, Tuple, Union, Any -from pydantic import conint +try: + from typing import Annotated +except ImportError: + from typing_extensions import Annotated +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.ezsignbulksenddocumentmapping_create_object_v1_request import EzsignbulksenddocumentmappingCreateObjectV1Request from eZmaxApi.models.ezsignbulksenddocumentmapping_create_object_v1_response import EzsignbulksenddocumentmappingCreateObjectV1Response from eZmaxApi.models.ezsignbulksenddocumentmapping_delete_object_v1_response import EzsignbulksenddocumentmappingDeleteObjectV1Response @@ -28,10 +33,7 @@ from eZmaxApi.api_client import ApiClient from eZmaxApi.api_response import ApiResponse -from eZmaxApi.exceptions import ( # noqa: F401 - ApiTypeError, - ApiValueError -) +from eZmaxApi.rest import RESTResponseType class ObjectEzsignbulksenddocumentmappingApi: @@ -46,432 +48,798 @@ def __init__(self, api_client=None) -> None: api_client = ApiClient.get_default() self.api_client = api_client - @validate_arguments - def ezsignbulksenddocumentmapping_create_object_v1(self, ezsignbulksenddocumentmapping_create_object_v1_request : EzsignbulksenddocumentmappingCreateObjectV1Request, **kwargs) -> EzsignbulksenddocumentmappingCreateObjectV1Response: # noqa: E501 - """Create a new Ezsignbulksenddocumentmapping # noqa: E501 - The endpoint allows to create one or many elements at once. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def ezsignbulksenddocumentmapping_create_object_v1( + self, + ezsignbulksenddocumentmapping_create_object_v1_request: EzsignbulksenddocumentmappingCreateObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsignbulksenddocumentmappingCreateObjectV1Response: + """Create a new Ezsignbulksenddocumentmapping - >>> thread = api.ezsignbulksenddocumentmapping_create_object_v1(ezsignbulksenddocumentmapping_create_object_v1_request, async_req=True) - >>> result = thread.get() + The endpoint allows to create one or many elements at once. :param ezsignbulksenddocumentmapping_create_object_v1_request: (required) :type ezsignbulksenddocumentmapping_create_object_v1_request: EzsignbulksenddocumentmappingCreateObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsignbulksenddocumentmappingCreateObjectV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsignbulksenddocumentmapping_create_object_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsignbulksenddocumentmapping_create_object_v1_with_http_info(ezsignbulksenddocumentmapping_create_object_v1_request, **kwargs) # noqa: E501 - - @validate_arguments - def ezsignbulksenddocumentmapping_create_object_v1_with_http_info(self, ezsignbulksenddocumentmapping_create_object_v1_request : EzsignbulksenddocumentmappingCreateObjectV1Request, **kwargs) -> ApiResponse: # noqa: E501 - """Create a new Ezsignbulksenddocumentmapping # noqa: E501 - - The endpoint allows to create one or many elements at once. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsignbulksenddocumentmapping_create_object_v1_with_http_info(ezsignbulksenddocumentmapping_create_object_v1_request, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._ezsignbulksenddocumentmapping_create_object_v1_serialize( + ezsignbulksenddocumentmapping_create_object_v1_request=ezsignbulksenddocumentmapping_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "EzsignbulksenddocumentmappingCreateObjectV1Response", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsignbulksenddocumentmapping_create_object_v1_with_http_info( + self, + ezsignbulksenddocumentmapping_create_object_v1_request: EzsignbulksenddocumentmappingCreateObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsignbulksenddocumentmappingCreateObjectV1Response]: + """Create a new Ezsignbulksenddocumentmapping + + The endpoint allows to create one or many elements at once. :param ezsignbulksenddocumentmapping_create_object_v1_request: (required) :type ezsignbulksenddocumentmapping_create_object_v1_request: EzsignbulksenddocumentmappingCreateObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsignbulksenddocumentmappingCreateObjectV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._ezsignbulksenddocumentmapping_create_object_v1_serialize( + ezsignbulksenddocumentmapping_create_object_v1_request=ezsignbulksenddocumentmapping_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '201': "EzsignbulksenddocumentmappingCreateObjectV1Response", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'ezsignbulksenddocumentmapping_create_object_v1_request' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def ezsignbulksenddocumentmapping_create_object_v1_without_preload_content( + self, + ezsignbulksenddocumentmapping_create_object_v1_request: EzsignbulksenddocumentmappingCreateObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Create a new Ezsignbulksenddocumentmapping + + The endpoint allows to create one or many elements at once. + + :param ezsignbulksenddocumentmapping_create_object_v1_request: (required) + :type ezsignbulksenddocumentmapping_create_object_v1_request: EzsignbulksenddocumentmappingCreateObjectV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignbulksenddocumentmapping_create_object_v1_serialize( + ezsignbulksenddocumentmapping_create_object_v1_request=ezsignbulksenddocumentmapping_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsignbulksenddocumentmapping_create_object_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '201': "EzsignbulksenddocumentmappingCreateObjectV1Response", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} + def _ezsignbulksenddocumentmapping_create_object_v1_serialize( + self, + ezsignbulksenddocumentmapping_create_object_v1_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['ezsignbulksenddocumentmapping_create_object_v1_request'] is not None: - _body_params = _params['ezsignbulksenddocumentmapping_create_object_v1_request'] + if ezsignbulksenddocumentmapping_create_object_v1_request is not None: + _body_params = ezsignbulksenddocumentmapping_create_object_v1_request + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '201': "EzsignbulksenddocumentmappingCreateObjectV1Response", - '422': "CommonResponseError", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsignbulksenddocumentmapping', 'POST', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='POST', + resource_path='/1/object/ezsignbulksenddocumentmapping', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + - @validate_arguments - def ezsignbulksenddocumentmapping_delete_object_v1(self, pki_ezsignbulksenddocumentmapping_id : conint(strict=True, ge=0), **kwargs) -> EzsignbulksenddocumentmappingDeleteObjectV1Response: # noqa: E501 - """Delete an existing Ezsignbulksenddocumentmapping # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def ezsignbulksenddocumentmapping_delete_object_v1( + self, + pki_ezsignbulksenddocumentmapping_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsignbulksenddocumentmappingDeleteObjectV1Response: + """Delete an existing Ezsignbulksenddocumentmapping - >>> thread = api.ezsignbulksenddocumentmapping_delete_object_v1(pki_ezsignbulksenddocumentmapping_id, async_req=True) - >>> result = thread.get() + :param pki_ezsignbulksenddocumentmapping_id: (required) :type pki_ezsignbulksenddocumentmapping_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsignbulksenddocumentmappingDeleteObjectV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsignbulksenddocumentmapping_delete_object_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsignbulksenddocumentmapping_delete_object_v1_with_http_info(pki_ezsignbulksenddocumentmapping_id, **kwargs) # noqa: E501 - - @validate_arguments - def ezsignbulksenddocumentmapping_delete_object_v1_with_http_info(self, pki_ezsignbulksenddocumentmapping_id : conint(strict=True, ge=0), **kwargs) -> ApiResponse: # noqa: E501 - """Delete an existing Ezsignbulksenddocumentmapping # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsignbulksenddocumentmapping_delete_object_v1_with_http_info(pki_ezsignbulksenddocumentmapping_id, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._ezsignbulksenddocumentmapping_delete_object_v1_serialize( + pki_ezsignbulksenddocumentmapping_id=pki_ezsignbulksenddocumentmapping_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignbulksenddocumentmappingDeleteObjectV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsignbulksenddocumentmapping_delete_object_v1_with_http_info( + self, + pki_ezsignbulksenddocumentmapping_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsignbulksenddocumentmappingDeleteObjectV1Response]: + """Delete an existing Ezsignbulksenddocumentmapping + + :param pki_ezsignbulksenddocumentmapping_id: (required) :type pki_ezsignbulksenddocumentmapping_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsignbulksenddocumentmappingDeleteObjectV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._ezsignbulksenddocumentmapping_delete_object_v1_serialize( + pki_ezsignbulksenddocumentmapping_id=pki_ezsignbulksenddocumentmapping_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignbulksenddocumentmappingDeleteObjectV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'pki_ezsignbulksenddocumentmapping_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def ezsignbulksenddocumentmapping_delete_object_v1_without_preload_content( + self, + pki_ezsignbulksenddocumentmapping_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete an existing Ezsignbulksenddocumentmapping + + + + :param pki_ezsignbulksenddocumentmapping_id: (required) + :type pki_ezsignbulksenddocumentmapping_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignbulksenddocumentmapping_delete_object_v1_serialize( + pki_ezsignbulksenddocumentmapping_id=pki_ezsignbulksenddocumentmapping_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsignbulksenddocumentmapping_delete_object_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignbulksenddocumentmappingDeleteObjectV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_ezsignbulksenddocumentmapping_id']: - _path_params['pkiEzsignbulksenddocumentmappingID'] = _params['pki_ezsignbulksenddocumentmapping_id'] + def _ezsignbulksenddocumentmapping_delete_object_v1_serialize( + self, + pki_ezsignbulksenddocumentmapping_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_ezsignbulksenddocumentmapping_id is not None: + _path_params['pkiEzsignbulksenddocumentmappingID'] = pki_ezsignbulksenddocumentmapping_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "EzsignbulksenddocumentmappingDeleteObjectV1Response", - '404': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsignbulksenddocumentmapping/{pkiEzsignbulksenddocumentmappingID}', 'DELETE', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='DELETE', + resource_path='/1/object/ezsignbulksenddocumentmapping/{pkiEzsignbulksenddocumentmappingID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + - @validate_arguments - def ezsignbulksenddocumentmapping_get_object_v2(self, pki_ezsignbulksenddocumentmapping_id : conint(strict=True, ge=0), **kwargs) -> EzsignbulksenddocumentmappingGetObjectV2Response: # noqa: E501 - """Retrieve an existing Ezsignbulksenddocumentmapping # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.ezsignbulksenddocumentmapping_get_object_v2(pki_ezsignbulksenddocumentmapping_id, async_req=True) - >>> result = thread.get() + @validate_call + def ezsignbulksenddocumentmapping_get_object_v2( + self, + pki_ezsignbulksenddocumentmapping_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsignbulksenddocumentmappingGetObjectV2Response: + """Retrieve an existing Ezsignbulksenddocumentmapping + + :param pki_ezsignbulksenddocumentmapping_id: (required) :type pki_ezsignbulksenddocumentmapping_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsignbulksenddocumentmappingGetObjectV2Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsignbulksenddocumentmapping_get_object_v2_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsignbulksenddocumentmapping_get_object_v2_with_http_info(pki_ezsignbulksenddocumentmapping_id, **kwargs) # noqa: E501 - - @validate_arguments - def ezsignbulksenddocumentmapping_get_object_v2_with_http_info(self, pki_ezsignbulksenddocumentmapping_id : conint(strict=True, ge=0), **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve an existing Ezsignbulksenddocumentmapping # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsignbulksenddocumentmapping_get_object_v2_with_http_info(pki_ezsignbulksenddocumentmapping_id, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._ezsignbulksenddocumentmapping_get_object_v2_serialize( + pki_ezsignbulksenddocumentmapping_id=pki_ezsignbulksenddocumentmapping_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignbulksenddocumentmappingGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsignbulksenddocumentmapping_get_object_v2_with_http_info( + self, + pki_ezsignbulksenddocumentmapping_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsignbulksenddocumentmappingGetObjectV2Response]: + """Retrieve an existing Ezsignbulksenddocumentmapping + + :param pki_ezsignbulksenddocumentmapping_id: (required) :type pki_ezsignbulksenddocumentmapping_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsignbulksenddocumentmappingGetObjectV2Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._ezsignbulksenddocumentmapping_get_object_v2_serialize( + pki_ezsignbulksenddocumentmapping_id=pki_ezsignbulksenddocumentmapping_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignbulksenddocumentmappingGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _params = locals() - _all_params = [ - 'pki_ezsignbulksenddocumentmapping_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + @validate_call + def ezsignbulksenddocumentmapping_get_object_v2_without_preload_content( + self, + pki_ezsignbulksenddocumentmapping_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve an existing Ezsignbulksenddocumentmapping + + + + :param pki_ezsignbulksenddocumentmapping_id: (required) + :type pki_ezsignbulksenddocumentmapping_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignbulksenddocumentmapping_get_object_v2_serialize( + pki_ezsignbulksenddocumentmapping_id=pki_ezsignbulksenddocumentmapping_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsignbulksenddocumentmapping_get_object_v2" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignbulksenddocumentmappingGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_ezsignbulksenddocumentmapping_id']: - _path_params['pkiEzsignbulksenddocumentmappingID'] = _params['pki_ezsignbulksenddocumentmapping_id'] + def _ezsignbulksenddocumentmapping_get_object_v2_serialize( + self, + pki_ezsignbulksenddocumentmapping_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if pki_ezsignbulksenddocumentmapping_id is not None: + _path_params['pkiEzsignbulksenddocumentmappingID'] = pki_ezsignbulksenddocumentmapping_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "EzsignbulksenddocumentmappingGetObjectV2Response", - '404': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/2/object/ezsignbulksenddocumentmapping/{pkiEzsignbulksenddocumentmappingID}', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/2/object/ezsignbulksenddocumentmapping/{pkiEzsignbulksenddocumentmappingID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/eZmaxApi/api/object_ezsignbulksendsignermapping_api.py b/eZmaxApi/api/object_ezsignbulksendsignermapping_api.py index 1145b7a97..17915e857 100644 --- a/eZmaxApi/api/object_ezsignbulksendsignermapping_api.py +++ b/eZmaxApi/api/object_ezsignbulksendsignermapping_api.py @@ -13,14 +13,19 @@ """ # noqa: E501 -import re # noqa: F401 import io import warnings -from pydantic import validate_arguments, ValidationError +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Dict, List, Optional, Tuple, Union, Any -from pydantic import conint +try: + from typing import Annotated +except ImportError: + from typing_extensions import Annotated +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.ezsignbulksendsignermapping_create_object_v1_request import EzsignbulksendsignermappingCreateObjectV1Request from eZmaxApi.models.ezsignbulksendsignermapping_create_object_v1_response import EzsignbulksendsignermappingCreateObjectV1Response from eZmaxApi.models.ezsignbulksendsignermapping_delete_object_v1_response import EzsignbulksendsignermappingDeleteObjectV1Response @@ -28,10 +33,7 @@ from eZmaxApi.api_client import ApiClient from eZmaxApi.api_response import ApiResponse -from eZmaxApi.exceptions import ( # noqa: F401 - ApiTypeError, - ApiValueError -) +from eZmaxApi.rest import RESTResponseType class ObjectEzsignbulksendsignermappingApi: @@ -46,431 +48,795 @@ def __init__(self, api_client=None) -> None: api_client = ApiClient.get_default() self.api_client = api_client - @validate_arguments - def ezsignbulksendsignermapping_create_object_v1(self, ezsignbulksendsignermapping_create_object_v1_request : EzsignbulksendsignermappingCreateObjectV1Request, **kwargs) -> EzsignbulksendsignermappingCreateObjectV1Response: # noqa: E501 - """Create a new Ezsignbulksendsignermapping # noqa: E501 - The endpoint allows to create one or many elements at once. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def ezsignbulksendsignermapping_create_object_v1( + self, + ezsignbulksendsignermapping_create_object_v1_request: EzsignbulksendsignermappingCreateObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsignbulksendsignermappingCreateObjectV1Response: + """Create a new Ezsignbulksendsignermapping - >>> thread = api.ezsignbulksendsignermapping_create_object_v1(ezsignbulksendsignermapping_create_object_v1_request, async_req=True) - >>> result = thread.get() + The endpoint allows to create one or many elements at once. :param ezsignbulksendsignermapping_create_object_v1_request: (required) :type ezsignbulksendsignermapping_create_object_v1_request: EzsignbulksendsignermappingCreateObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsignbulksendsignermappingCreateObjectV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsignbulksendsignermapping_create_object_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsignbulksendsignermapping_create_object_v1_with_http_info(ezsignbulksendsignermapping_create_object_v1_request, **kwargs) # noqa: E501 - - @validate_arguments - def ezsignbulksendsignermapping_create_object_v1_with_http_info(self, ezsignbulksendsignermapping_create_object_v1_request : EzsignbulksendsignermappingCreateObjectV1Request, **kwargs) -> ApiResponse: # noqa: E501 - """Create a new Ezsignbulksendsignermapping # noqa: E501 - - The endpoint allows to create one or many elements at once. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsignbulksendsignermapping_create_object_v1_with_http_info(ezsignbulksendsignermapping_create_object_v1_request, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._ezsignbulksendsignermapping_create_object_v1_serialize( + ezsignbulksendsignermapping_create_object_v1_request=ezsignbulksendsignermapping_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "EzsignbulksendsignermappingCreateObjectV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsignbulksendsignermapping_create_object_v1_with_http_info( + self, + ezsignbulksendsignermapping_create_object_v1_request: EzsignbulksendsignermappingCreateObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsignbulksendsignermappingCreateObjectV1Response]: + """Create a new Ezsignbulksendsignermapping + + The endpoint allows to create one or many elements at once. :param ezsignbulksendsignermapping_create_object_v1_request: (required) :type ezsignbulksendsignermapping_create_object_v1_request: EzsignbulksendsignermappingCreateObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsignbulksendsignermappingCreateObjectV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._ezsignbulksendsignermapping_create_object_v1_serialize( + ezsignbulksendsignermapping_create_object_v1_request=ezsignbulksendsignermapping_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '201': "EzsignbulksendsignermappingCreateObjectV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'ezsignbulksendsignermapping_create_object_v1_request' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def ezsignbulksendsignermapping_create_object_v1_without_preload_content( + self, + ezsignbulksendsignermapping_create_object_v1_request: EzsignbulksendsignermappingCreateObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Create a new Ezsignbulksendsignermapping + + The endpoint allows to create one or many elements at once. + + :param ezsignbulksendsignermapping_create_object_v1_request: (required) + :type ezsignbulksendsignermapping_create_object_v1_request: EzsignbulksendsignermappingCreateObjectV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignbulksendsignermapping_create_object_v1_serialize( + ezsignbulksendsignermapping_create_object_v1_request=ezsignbulksendsignermapping_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsignbulksendsignermapping_create_object_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '201': "EzsignbulksendsignermappingCreateObjectV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} + def _ezsignbulksendsignermapping_create_object_v1_serialize( + self, + ezsignbulksendsignermapping_create_object_v1_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['ezsignbulksendsignermapping_create_object_v1_request'] is not None: - _body_params = _params['ezsignbulksendsignermapping_create_object_v1_request'] + if ezsignbulksendsignermapping_create_object_v1_request is not None: + _body_params = ezsignbulksendsignermapping_create_object_v1_request + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '201': "EzsignbulksendsignermappingCreateObjectV1Response", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsignbulksendsignermapping', 'POST', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='POST', + resource_path='/1/object/ezsignbulksendsignermapping', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + - @validate_arguments - def ezsignbulksendsignermapping_delete_object_v1(self, pki_ezsignbulksendsignermapping_id : conint(strict=True, ge=0), **kwargs) -> EzsignbulksendsignermappingDeleteObjectV1Response: # noqa: E501 - """Delete an existing Ezsignbulksendsignermapping # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.ezsignbulksendsignermapping_delete_object_v1(pki_ezsignbulksendsignermapping_id, async_req=True) - >>> result = thread.get() + @validate_call + def ezsignbulksendsignermapping_delete_object_v1( + self, + pki_ezsignbulksendsignermapping_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsignbulksendsignermappingDeleteObjectV1Response: + """Delete an existing Ezsignbulksendsignermapping + + :param pki_ezsignbulksendsignermapping_id: (required) :type pki_ezsignbulksendsignermapping_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsignbulksendsignermappingDeleteObjectV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsignbulksendsignermapping_delete_object_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsignbulksendsignermapping_delete_object_v1_with_http_info(pki_ezsignbulksendsignermapping_id, **kwargs) # noqa: E501 - - @validate_arguments - def ezsignbulksendsignermapping_delete_object_v1_with_http_info(self, pki_ezsignbulksendsignermapping_id : conint(strict=True, ge=0), **kwargs) -> ApiResponse: # noqa: E501 - """Delete an existing Ezsignbulksendsignermapping # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsignbulksendsignermapping_delete_object_v1_with_http_info(pki_ezsignbulksendsignermapping_id, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._ezsignbulksendsignermapping_delete_object_v1_serialize( + pki_ezsignbulksendsignermapping_id=pki_ezsignbulksendsignermapping_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignbulksendsignermappingDeleteObjectV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsignbulksendsignermapping_delete_object_v1_with_http_info( + self, + pki_ezsignbulksendsignermapping_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsignbulksendsignermappingDeleteObjectV1Response]: + """Delete an existing Ezsignbulksendsignermapping + + :param pki_ezsignbulksendsignermapping_id: (required) :type pki_ezsignbulksendsignermapping_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsignbulksendsignermappingDeleteObjectV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._ezsignbulksendsignermapping_delete_object_v1_serialize( + pki_ezsignbulksendsignermapping_id=pki_ezsignbulksendsignermapping_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignbulksendsignermappingDeleteObjectV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _params = locals() - _all_params = [ - 'pki_ezsignbulksendsignermapping_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + @validate_call + def ezsignbulksendsignermapping_delete_object_v1_without_preload_content( + self, + pki_ezsignbulksendsignermapping_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete an existing Ezsignbulksendsignermapping + + + + :param pki_ezsignbulksendsignermapping_id: (required) + :type pki_ezsignbulksendsignermapping_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignbulksendsignermapping_delete_object_v1_serialize( + pki_ezsignbulksendsignermapping_id=pki_ezsignbulksendsignermapping_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsignbulksendsignermapping_delete_object_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignbulksendsignermappingDeleteObjectV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_ezsignbulksendsignermapping_id']: - _path_params['pkiEzsignbulksendsignermappingID'] = _params['pki_ezsignbulksendsignermapping_id'] + def _ezsignbulksendsignermapping_delete_object_v1_serialize( + self, + pki_ezsignbulksendsignermapping_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_ezsignbulksendsignermapping_id is not None: + _path_params['pkiEzsignbulksendsignermappingID'] = pki_ezsignbulksendsignermapping_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "EzsignbulksendsignermappingDeleteObjectV1Response", - '404': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsignbulksendsignermapping/{pkiEzsignbulksendsignermappingID}', 'DELETE', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='DELETE', + resource_path='/1/object/ezsignbulksendsignermapping/{pkiEzsignbulksendsignermappingID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + - @validate_arguments - def ezsignbulksendsignermapping_get_object_v2(self, pki_ezsignbulksendsignermapping_id : conint(strict=True, ge=0), **kwargs) -> EzsignbulksendsignermappingGetObjectV2Response: # noqa: E501 - """Retrieve an existing Ezsignbulksendsignermapping # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def ezsignbulksendsignermapping_get_object_v2( + self, + pki_ezsignbulksendsignermapping_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsignbulksendsignermappingGetObjectV2Response: + """Retrieve an existing Ezsignbulksendsignermapping - >>> thread = api.ezsignbulksendsignermapping_get_object_v2(pki_ezsignbulksendsignermapping_id, async_req=True) - >>> result = thread.get() + :param pki_ezsignbulksendsignermapping_id: (required) :type pki_ezsignbulksendsignermapping_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsignbulksendsignermappingGetObjectV2Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsignbulksendsignermapping_get_object_v2_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsignbulksendsignermapping_get_object_v2_with_http_info(pki_ezsignbulksendsignermapping_id, **kwargs) # noqa: E501 - - @validate_arguments - def ezsignbulksendsignermapping_get_object_v2_with_http_info(self, pki_ezsignbulksendsignermapping_id : conint(strict=True, ge=0), **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve an existing Ezsignbulksendsignermapping # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsignbulksendsignermapping_get_object_v2_with_http_info(pki_ezsignbulksendsignermapping_id, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._ezsignbulksendsignermapping_get_object_v2_serialize( + pki_ezsignbulksendsignermapping_id=pki_ezsignbulksendsignermapping_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignbulksendsignermappingGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsignbulksendsignermapping_get_object_v2_with_http_info( + self, + pki_ezsignbulksendsignermapping_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsignbulksendsignermappingGetObjectV2Response]: + """Retrieve an existing Ezsignbulksendsignermapping + + :param pki_ezsignbulksendsignermapping_id: (required) :type pki_ezsignbulksendsignermapping_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsignbulksendsignermappingGetObjectV2Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._ezsignbulksendsignermapping_get_object_v2_serialize( + pki_ezsignbulksendsignermapping_id=pki_ezsignbulksendsignermapping_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignbulksendsignermappingGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'pki_ezsignbulksendsignermapping_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def ezsignbulksendsignermapping_get_object_v2_without_preload_content( + self, + pki_ezsignbulksendsignermapping_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve an existing Ezsignbulksendsignermapping + + + + :param pki_ezsignbulksendsignermapping_id: (required) + :type pki_ezsignbulksendsignermapping_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignbulksendsignermapping_get_object_v2_serialize( + pki_ezsignbulksendsignermapping_id=pki_ezsignbulksendsignermapping_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsignbulksendsignermapping_get_object_v2" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignbulksendsignermappingGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_ezsignbulksendsignermapping_id']: - _path_params['pkiEzsignbulksendsignermappingID'] = _params['pki_ezsignbulksendsignermapping_id'] + def _ezsignbulksendsignermapping_get_object_v2_serialize( + self, + pki_ezsignbulksendsignermapping_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if pki_ezsignbulksendsignermapping_id is not None: + _path_params['pkiEzsignbulksendsignermappingID'] = pki_ezsignbulksendsignermapping_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "EzsignbulksendsignermappingGetObjectV2Response", - '404': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/2/object/ezsignbulksendsignermapping/{pkiEzsignbulksendsignermappingID}', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/2/object/ezsignbulksendsignermapping/{pkiEzsignbulksendsignermappingID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/eZmaxApi/api/object_ezsignbulksendtransmission_api.py b/eZmaxApi/api/object_ezsignbulksendtransmission_api.py index 183cf305a..5d1bd97c6 100644 --- a/eZmaxApi/api/object_ezsignbulksendtransmission_api.py +++ b/eZmaxApi/api/object_ezsignbulksendtransmission_api.py @@ -13,24 +13,26 @@ """ # noqa: E501 -import re # noqa: F401 import io import warnings -from pydantic import validate_arguments, ValidationError +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Dict, List, Optional, Tuple, Union, Any -from pydantic import conint +try: + from typing import Annotated +except ImportError: + from typing_extensions import Annotated +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.ezsignbulksendtransmission_get_ezsignsignatures_automatic_v1_response import EzsignbulksendtransmissionGetEzsignsignaturesAutomaticV1Response from eZmaxApi.models.ezsignbulksendtransmission_get_forms_data_v1_response import EzsignbulksendtransmissionGetFormsDataV1Response from eZmaxApi.models.ezsignbulksendtransmission_get_object_v2_response import EzsignbulksendtransmissionGetObjectV2Response from eZmaxApi.api_client import ApiClient from eZmaxApi.api_response import ApiResponse -from eZmaxApi.exceptions import ( # noqa: F401 - ApiTypeError, - ApiValueError -) +from eZmaxApi.rest import RESTResponseType class ObjectEzsignbulksendtransmissionApi: @@ -45,570 +47,1060 @@ def __init__(self, api_client=None) -> None: api_client = ApiClient.get_default() self.api_client = api_client - @validate_arguments - def ezsignbulksendtransmission_get_csv_errors_v1(self, pki_ezsignbulksendtransmission_id : conint(strict=True, ge=0), **kwargs) -> str: # noqa: E501 - """Retrieve an existing Ezsignbulksendtransmission's Csv containing errors # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def ezsignbulksendtransmission_get_csv_errors_v1( + self, + pki_ezsignbulksendtransmission_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> str: + """Retrieve an existing Ezsignbulksendtransmission's Csv containing errors - >>> thread = api.ezsignbulksendtransmission_get_csv_errors_v1(pki_ezsignbulksendtransmission_id, async_req=True) - >>> result = thread.get() + :param pki_ezsignbulksendtransmission_id: (required) :type pki_ezsignbulksendtransmission_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: str - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsignbulksendtransmission_get_csv_errors_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsignbulksendtransmission_get_csv_errors_v1_with_http_info(pki_ezsignbulksendtransmission_id, **kwargs) # noqa: E501 - - @validate_arguments - def ezsignbulksendtransmission_get_csv_errors_v1_with_http_info(self, pki_ezsignbulksendtransmission_id : conint(strict=True, ge=0), **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve an existing Ezsignbulksendtransmission's Csv containing errors # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsignbulksendtransmission_get_csv_errors_v1_with_http_info(pki_ezsignbulksendtransmission_id, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._ezsignbulksendtransmission_get_csv_errors_v1_serialize( + pki_ezsignbulksendtransmission_id=pki_ezsignbulksendtransmission_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "str", + '404': "CommonResponseError", + '406': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsignbulksendtransmission_get_csv_errors_v1_with_http_info( + self, + pki_ezsignbulksendtransmission_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[str]: + """Retrieve an existing Ezsignbulksendtransmission's Csv containing errors + + :param pki_ezsignbulksendtransmission_id: (required) :type pki_ezsignbulksendtransmission_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(str, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._ezsignbulksendtransmission_get_csv_errors_v1_serialize( + pki_ezsignbulksendtransmission_id=pki_ezsignbulksendtransmission_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "str", + '404': "CommonResponseError", + '406': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _params = locals() - _all_params = [ - 'pki_ezsignbulksendtransmission_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + @validate_call + def ezsignbulksendtransmission_get_csv_errors_v1_without_preload_content( + self, + pki_ezsignbulksendtransmission_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve an existing Ezsignbulksendtransmission's Csv containing errors + + + + :param pki_ezsignbulksendtransmission_id: (required) + :type pki_ezsignbulksendtransmission_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignbulksendtransmission_get_csv_errors_v1_serialize( + pki_ezsignbulksendtransmission_id=pki_ezsignbulksendtransmission_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsignbulksendtransmission_get_csv_errors_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "str", + '404': "CommonResponseError", + '406': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_ezsignbulksendtransmission_id']: - _path_params['pkiEzsignbulksendtransmissionID'] = _params['pki_ezsignbulksendtransmission_id'] + def _ezsignbulksendtransmission_get_csv_errors_v1_serialize( + self, + pki_ezsignbulksendtransmission_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if pki_ezsignbulksendtransmission_id is not None: + _path_params['pkiEzsignbulksendtransmissionID'] = pki_ezsignbulksendtransmission_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['text/csv', 'application/json']) # noqa: E501 + [ + 'text/csv', + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "str", - '404': "CommonResponseError", - '406': "CommonResponseError", - '422': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsignbulksendtransmission/{pkiEzsignbulksendtransmissionID}/getCsvErrors', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/1/object/ezsignbulksendtransmission/{pkiEzsignbulksendtransmissionID}/getCsvErrors', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + - @validate_arguments - def ezsignbulksendtransmission_get_ezsignsignatures_automatic_v1(self, pki_ezsignbulksendtransmission_id : conint(strict=True, ge=0), **kwargs) -> EzsignbulksendtransmissionGetEzsignsignaturesAutomaticV1Response: # noqa: E501 - """Retrieve an existing Ezsignbulksendtransmission's automatic Ezsignsignatures # noqa: E501 - Return the Ezsignsignatures that can be signed by the current user at the current step in the process # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.ezsignbulksendtransmission_get_ezsignsignatures_automatic_v1(pki_ezsignbulksendtransmission_id, async_req=True) - >>> result = thread.get() + @validate_call + def ezsignbulksendtransmission_get_ezsignsignatures_automatic_v1( + self, + pki_ezsignbulksendtransmission_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsignbulksendtransmissionGetEzsignsignaturesAutomaticV1Response: + """Retrieve an existing Ezsignbulksendtransmission's automatic Ezsignsignatures + + Return the Ezsignsignatures that can be signed by the current user at the current step in the process :param pki_ezsignbulksendtransmission_id: (required) :type pki_ezsignbulksendtransmission_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsignbulksendtransmissionGetEzsignsignaturesAutomaticV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsignbulksendtransmission_get_ezsignsignatures_automatic_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsignbulksendtransmission_get_ezsignsignatures_automatic_v1_with_http_info(pki_ezsignbulksendtransmission_id, **kwargs) # noqa: E501 - - @validate_arguments - def ezsignbulksendtransmission_get_ezsignsignatures_automatic_v1_with_http_info(self, pki_ezsignbulksendtransmission_id : conint(strict=True, ge=0), **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve an existing Ezsignbulksendtransmission's automatic Ezsignsignatures # noqa: E501 - - Return the Ezsignsignatures that can be signed by the current user at the current step in the process # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsignbulksendtransmission_get_ezsignsignatures_automatic_v1_with_http_info(pki_ezsignbulksendtransmission_id, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._ezsignbulksendtransmission_get_ezsignsignatures_automatic_v1_serialize( + pki_ezsignbulksendtransmission_id=pki_ezsignbulksendtransmission_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignbulksendtransmissionGetEzsignsignaturesAutomaticV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsignbulksendtransmission_get_ezsignsignatures_automatic_v1_with_http_info( + self, + pki_ezsignbulksendtransmission_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsignbulksendtransmissionGetEzsignsignaturesAutomaticV1Response]: + """Retrieve an existing Ezsignbulksendtransmission's automatic Ezsignsignatures + + Return the Ezsignsignatures that can be signed by the current user at the current step in the process :param pki_ezsignbulksendtransmission_id: (required) :type pki_ezsignbulksendtransmission_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsignbulksendtransmissionGetEzsignsignaturesAutomaticV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._ezsignbulksendtransmission_get_ezsignsignatures_automatic_v1_serialize( + pki_ezsignbulksendtransmission_id=pki_ezsignbulksendtransmission_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignbulksendtransmissionGetEzsignsignaturesAutomaticV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _params = locals() - _all_params = [ - 'pki_ezsignbulksendtransmission_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + @validate_call + def ezsignbulksendtransmission_get_ezsignsignatures_automatic_v1_without_preload_content( + self, + pki_ezsignbulksendtransmission_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve an existing Ezsignbulksendtransmission's automatic Ezsignsignatures + + Return the Ezsignsignatures that can be signed by the current user at the current step in the process + + :param pki_ezsignbulksendtransmission_id: (required) + :type pki_ezsignbulksendtransmission_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignbulksendtransmission_get_ezsignsignatures_automatic_v1_serialize( + pki_ezsignbulksendtransmission_id=pki_ezsignbulksendtransmission_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsignbulksendtransmission_get_ezsignsignatures_automatic_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignbulksendtransmissionGetEzsignsignaturesAutomaticV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_ezsignbulksendtransmission_id']: - _path_params['pkiEzsignbulksendtransmissionID'] = _params['pki_ezsignbulksendtransmission_id'] + def _ezsignbulksendtransmission_get_ezsignsignatures_automatic_v1_serialize( + self, + pki_ezsignbulksendtransmission_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if pki_ezsignbulksendtransmission_id is not None: + _path_params['pkiEzsignbulksendtransmissionID'] = pki_ezsignbulksendtransmission_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "EzsignbulksendtransmissionGetEzsignsignaturesAutomaticV1Response", - '404': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsignbulksendtransmission/{pkiEzsignbulksendtransmissionID}/getEzsignsignaturesAutomatic', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/1/object/ezsignbulksendtransmission/{pkiEzsignbulksendtransmissionID}/getEzsignsignaturesAutomatic', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + - @validate_arguments - def ezsignbulksendtransmission_get_forms_data_v1(self, pki_ezsignbulksendtransmission_id : conint(strict=True, ge=0), **kwargs) -> EzsignbulksendtransmissionGetFormsDataV1Response: # noqa: E501 - """Retrieve an existing Ezsignbulksendtransmission's forms data # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def ezsignbulksendtransmission_get_forms_data_v1( + self, + pki_ezsignbulksendtransmission_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsignbulksendtransmissionGetFormsDataV1Response: + """Retrieve an existing Ezsignbulksendtransmission's forms data - >>> thread = api.ezsignbulksendtransmission_get_forms_data_v1(pki_ezsignbulksendtransmission_id, async_req=True) - >>> result = thread.get() + :param pki_ezsignbulksendtransmission_id: (required) :type pki_ezsignbulksendtransmission_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsignbulksendtransmissionGetFormsDataV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsignbulksendtransmission_get_forms_data_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsignbulksendtransmission_get_forms_data_v1_with_http_info(pki_ezsignbulksendtransmission_id, **kwargs) # noqa: E501 - - @validate_arguments - def ezsignbulksendtransmission_get_forms_data_v1_with_http_info(self, pki_ezsignbulksendtransmission_id : conint(strict=True, ge=0), **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve an existing Ezsignbulksendtransmission's forms data # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsignbulksendtransmission_get_forms_data_v1_with_http_info(pki_ezsignbulksendtransmission_id, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._ezsignbulksendtransmission_get_forms_data_v1_serialize( + pki_ezsignbulksendtransmission_id=pki_ezsignbulksendtransmission_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignbulksendtransmissionGetFormsDataV1Response", + '404': "CommonResponseError", + '406': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsignbulksendtransmission_get_forms_data_v1_with_http_info( + self, + pki_ezsignbulksendtransmission_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsignbulksendtransmissionGetFormsDataV1Response]: + """Retrieve an existing Ezsignbulksendtransmission's forms data + + :param pki_ezsignbulksendtransmission_id: (required) :type pki_ezsignbulksendtransmission_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsignbulksendtransmissionGetFormsDataV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._ezsignbulksendtransmission_get_forms_data_v1_serialize( + pki_ezsignbulksendtransmission_id=pki_ezsignbulksendtransmission_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignbulksendtransmissionGetFormsDataV1Response", + '404': "CommonResponseError", + '406': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _params = locals() - _all_params = [ - 'pki_ezsignbulksendtransmission_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + @validate_call + def ezsignbulksendtransmission_get_forms_data_v1_without_preload_content( + self, + pki_ezsignbulksendtransmission_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve an existing Ezsignbulksendtransmission's forms data + + + + :param pki_ezsignbulksendtransmission_id: (required) + :type pki_ezsignbulksendtransmission_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignbulksendtransmission_get_forms_data_v1_serialize( + pki_ezsignbulksendtransmission_id=pki_ezsignbulksendtransmission_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsignbulksendtransmission_get_forms_data_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignbulksendtransmissionGetFormsDataV1Response", + '404': "CommonResponseError", + '406': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_ezsignbulksendtransmission_id']: - _path_params['pkiEzsignbulksendtransmissionID'] = _params['pki_ezsignbulksendtransmission_id'] + def _ezsignbulksendtransmission_get_forms_data_v1_serialize( + self, + pki_ezsignbulksendtransmission_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if pki_ezsignbulksendtransmission_id is not None: + _path_params['pkiEzsignbulksendtransmissionID'] = pki_ezsignbulksendtransmission_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json', 'application/zip']) # noqa: E501 + [ + 'application/json', + 'application/zip' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "EzsignbulksendtransmissionGetFormsDataV1Response", - '404': "CommonResponseError", - '406': "CommonResponseError", - '422': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsignbulksendtransmission/{pkiEzsignbulksendtransmissionID}/getFormsData', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/1/object/ezsignbulksendtransmission/{pkiEzsignbulksendtransmissionID}/getFormsData', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + - @validate_arguments - def ezsignbulksendtransmission_get_object_v2(self, pki_ezsignbulksendtransmission_id : conint(strict=True, ge=0), **kwargs) -> EzsignbulksendtransmissionGetObjectV2Response: # noqa: E501 - """Retrieve an existing Ezsignbulksendtransmission # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.ezsignbulksendtransmission_get_object_v2(pki_ezsignbulksendtransmission_id, async_req=True) - >>> result = thread.get() + @validate_call + def ezsignbulksendtransmission_get_object_v2( + self, + pki_ezsignbulksendtransmission_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsignbulksendtransmissionGetObjectV2Response: + """Retrieve an existing Ezsignbulksendtransmission + + :param pki_ezsignbulksendtransmission_id: (required) :type pki_ezsignbulksendtransmission_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsignbulksendtransmissionGetObjectV2Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsignbulksendtransmission_get_object_v2_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsignbulksendtransmission_get_object_v2_with_http_info(pki_ezsignbulksendtransmission_id, **kwargs) # noqa: E501 - - @validate_arguments - def ezsignbulksendtransmission_get_object_v2_with_http_info(self, pki_ezsignbulksendtransmission_id : conint(strict=True, ge=0), **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve an existing Ezsignbulksendtransmission # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsignbulksendtransmission_get_object_v2_with_http_info(pki_ezsignbulksendtransmission_id, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._ezsignbulksendtransmission_get_object_v2_serialize( + pki_ezsignbulksendtransmission_id=pki_ezsignbulksendtransmission_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignbulksendtransmissionGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsignbulksendtransmission_get_object_v2_with_http_info( + self, + pki_ezsignbulksendtransmission_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsignbulksendtransmissionGetObjectV2Response]: + """Retrieve an existing Ezsignbulksendtransmission + + :param pki_ezsignbulksendtransmission_id: (required) :type pki_ezsignbulksendtransmission_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsignbulksendtransmissionGetObjectV2Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._ezsignbulksendtransmission_get_object_v2_serialize( + pki_ezsignbulksendtransmission_id=pki_ezsignbulksendtransmission_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignbulksendtransmissionGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _params = locals() - _all_params = [ - 'pki_ezsignbulksendtransmission_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + @validate_call + def ezsignbulksendtransmission_get_object_v2_without_preload_content( + self, + pki_ezsignbulksendtransmission_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve an existing Ezsignbulksendtransmission + + + + :param pki_ezsignbulksendtransmission_id: (required) + :type pki_ezsignbulksendtransmission_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignbulksendtransmission_get_object_v2_serialize( + pki_ezsignbulksendtransmission_id=pki_ezsignbulksendtransmission_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsignbulksendtransmission_get_object_v2" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignbulksendtransmissionGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_ezsignbulksendtransmission_id']: - _path_params['pkiEzsignbulksendtransmissionID'] = _params['pki_ezsignbulksendtransmission_id'] + def _ezsignbulksendtransmission_get_object_v2_serialize( + self, + pki_ezsignbulksendtransmission_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if pki_ezsignbulksendtransmission_id is not None: + _path_params['pkiEzsignbulksendtransmissionID'] = pki_ezsignbulksendtransmission_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "EzsignbulksendtransmissionGetObjectV2Response", - '404': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/2/object/ezsignbulksendtransmission/{pkiEzsignbulksendtransmissionID}', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/2/object/ezsignbulksendtransmission/{pkiEzsignbulksendtransmissionID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/eZmaxApi/api/object_ezsigndocument_api.py b/eZmaxApi/api/object_ezsigndocument_api.py index ea156f44c..8f837b786 100644 --- a/eZmaxApi/api/object_ezsigndocument_api.py +++ b/eZmaxApi/api/object_ezsigndocument_api.py @@ -13,16 +13,22 @@ """ # noqa: E501 -import re # noqa: F401 import io import warnings -from pydantic import validate_arguments, ValidationError +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Dict, List, Optional, Tuple, Union, Any +try: + from typing import Annotated +except ImportError: + from typing_extensions import Annotated + +from pydantic import Field from typing_extensions import Annotated -from pydantic import Field, StrictStr, conint, conlist +from pydantic import StrictStr, field_validator -from typing import Any, Dict +from typing import Any, Dict, List from eZmaxApi.models.ezsigndocument_apply_ezsigntemplate_v1_request import EzsigndocumentApplyEzsigntemplateV1Request from eZmaxApi.models.ezsigndocument_apply_ezsigntemplate_v1_response import EzsigndocumentApplyEzsigntemplateV1Response @@ -42,6 +48,7 @@ from eZmaxApi.models.ezsigndocument_end_prematurely_v1_response import EzsigndocumentEndPrematurelyV1Response from eZmaxApi.models.ezsigndocument_flatten_v1_response import EzsigndocumentFlattenV1Response from eZmaxApi.models.ezsigndocument_get_actionable_elements_v1_response import EzsigndocumentGetActionableElementsV1Response +from eZmaxApi.models.ezsigndocument_get_attachments_v1_response import EzsigndocumentGetAttachmentsV1Response from eZmaxApi.models.ezsigndocument_get_completed_elements_v1_response import EzsigndocumentGetCompletedElementsV1Response from eZmaxApi.models.ezsigndocument_get_download_url_v1_response import EzsigndocumentGetDownloadUrlV1Response from eZmaxApi.models.ezsigndocument_get_ezsignannotations_v1_response import EzsigndocumentGetEzsignannotationsV1Response @@ -63,10 +70,7 @@ from eZmaxApi.api_client import ApiClient from eZmaxApi.api_response import ApiResponse -from eZmaxApi.exceptions import ( # noqa: F401 - ApiTypeError, - ApiValueError -) +from eZmaxApi.rest import RESTResponseType class ObjectEzsigndocumentApi: @@ -81,3881 +85,7473 @@ def __init__(self, api_client=None) -> None: api_client = ApiClient.get_default() self.api_client = api_client - @validate_arguments - def ezsigndocument_apply_ezsigntemplate_v1(self, pki_ezsigndocument_id : conint(strict=True, ge=0), ezsigndocument_apply_ezsigntemplate_v1_request : EzsigndocumentApplyEzsigntemplateV1Request, **kwargs) -> EzsigndocumentApplyEzsigntemplateV1Response: # noqa: E501 - """(Deprecated) Apply an Ezsigntemplate to the Ezsigndocument. # noqa: E501 - This function is deprecated. Please use *applyEzsigntemplate* instead which is doing the same thing but with a capital \"E\" to normalize the nomenclature. This endpoint applies a predefined template to the ezsign document. This allows to automatically apply all the form and signature fields on a document in a single step. The document must not already have fields otherwise an error will be returned. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def ezsigndocument_apply_ezsigntemplate_v1( + self, + pki_ezsigndocument_id: Annotated[int, Field(strict=True, ge=0)], + ezsigndocument_apply_ezsigntemplate_v1_request: EzsigndocumentApplyEzsigntemplateV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsigndocumentApplyEzsigntemplateV1Response: + """(Deprecated) Apply an Ezsigntemplate to the Ezsigndocument. - >>> thread = api.ezsigndocument_apply_ezsigntemplate_v1(pki_ezsigndocument_id, ezsigndocument_apply_ezsigntemplate_v1_request, async_req=True) - >>> result = thread.get() + This function is deprecated. Please use *applyEzsigntemplate* instead which is doing the same thing but with a capital \"E\" to normalize the nomenclature. This endpoint applies a predefined template to the ezsign document. This allows to automatically apply all the form and signature fields on a document in a single step. The document must not already have fields otherwise an error will be returned. :param pki_ezsigndocument_id: (required) :type pki_ezsigndocument_id: int :param ezsigndocument_apply_ezsigntemplate_v1_request: (required) :type ezsigndocument_apply_ezsigntemplate_v1_request: EzsigndocumentApplyEzsigntemplateV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsigndocumentApplyEzsigntemplateV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsigndocument_apply_ezsigntemplate_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsigndocument_apply_ezsigntemplate_v1_with_http_info(pki_ezsigndocument_id, ezsigndocument_apply_ezsigntemplate_v1_request, **kwargs) # noqa: E501 + """ # noqa: E501 + warnings.warn("POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/applyezsigntemplate is deprecated.", DeprecationWarning) - @validate_arguments - def ezsigndocument_apply_ezsigntemplate_v1_with_http_info(self, pki_ezsigndocument_id : conint(strict=True, ge=0), ezsigndocument_apply_ezsigntemplate_v1_request : EzsigndocumentApplyEzsigntemplateV1Request, **kwargs) -> ApiResponse: # noqa: E501 - """(Deprecated) Apply an Ezsigntemplate to the Ezsigndocument. # noqa: E501 + _param = self._ezsigndocument_apply_ezsigntemplate_v1_serialize( + pki_ezsigndocument_id=pki_ezsigndocument_id, + ezsigndocument_apply_ezsigntemplate_v1_request=ezsigndocument_apply_ezsigntemplate_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - This function is deprecated. Please use *applyEzsigntemplate* instead which is doing the same thing but with a capital \"E\" to normalize the nomenclature. This endpoint applies a predefined template to the ezsign document. This allows to automatically apply all the form and signature fields on a document in a single step. The document must not already have fields otherwise an error will be returned. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigndocumentApplyEzsigntemplateV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsigndocument_apply_ezsigntemplate_v1_with_http_info( + self, + pki_ezsigndocument_id: Annotated[int, Field(strict=True, ge=0)], + ezsigndocument_apply_ezsigntemplate_v1_request: EzsigndocumentApplyEzsigntemplateV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsigndocumentApplyEzsigntemplateV1Response]: + """(Deprecated) Apply an Ezsigntemplate to the Ezsigndocument. - >>> thread = api.ezsigndocument_apply_ezsigntemplate_v1_with_http_info(pki_ezsigndocument_id, ezsigndocument_apply_ezsigntemplate_v1_request, async_req=True) - >>> result = thread.get() + This function is deprecated. Please use *applyEzsigntemplate* instead which is doing the same thing but with a capital \"E\" to normalize the nomenclature. This endpoint applies a predefined template to the ezsign document. This allows to automatically apply all the form and signature fields on a document in a single step. The document must not already have fields otherwise an error will be returned. :param pki_ezsigndocument_id: (required) :type pki_ezsigndocument_id: int :param ezsigndocument_apply_ezsigntemplate_v1_request: (required) :type ezsigndocument_apply_ezsigntemplate_v1_request: EzsigndocumentApplyEzsigntemplateV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsigndocumentApplyEzsigntemplateV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + warnings.warn("POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/applyezsigntemplate is deprecated.", DeprecationWarning) + + _param = self._ezsigndocument_apply_ezsigntemplate_v1_serialize( + pki_ezsigndocument_id=pki_ezsigndocument_id, + ezsigndocument_apply_ezsigntemplate_v1_request=ezsigndocument_apply_ezsigntemplate_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigndocumentApplyEzsigntemplateV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def ezsigndocument_apply_ezsigntemplate_v1_without_preload_content( + self, + pki_ezsigndocument_id: Annotated[int, Field(strict=True, ge=0)], + ezsigndocument_apply_ezsigntemplate_v1_request: EzsigndocumentApplyEzsigntemplateV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """(Deprecated) Apply an Ezsigntemplate to the Ezsigndocument. + + This function is deprecated. Please use *applyEzsigntemplate* instead which is doing the same thing but with a capital \"E\" to normalize the nomenclature. This endpoint applies a predefined template to the ezsign document. This allows to automatically apply all the form and signature fields on a document in a single step. The document must not already have fields otherwise an error will be returned. + :param pki_ezsigndocument_id: (required) + :type pki_ezsigndocument_id: int + :param ezsigndocument_apply_ezsigntemplate_v1_request: (required) + :type ezsigndocument_apply_ezsigntemplate_v1_request: EzsigndocumentApplyEzsigntemplateV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 warnings.warn("POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/applyezsigntemplate is deprecated.", DeprecationWarning) - _params = locals() + _param = self._ezsigndocument_apply_ezsigntemplate_v1_serialize( + pki_ezsigndocument_id=pki_ezsigndocument_id, + ezsigndocument_apply_ezsigntemplate_v1_request=ezsigndocument_apply_ezsigntemplate_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _all_params = [ - 'pki_ezsigndocument_id', - 'ezsigndocument_apply_ezsigntemplate_v1_request' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' - ] - ) - - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsigndocument_apply_ezsigntemplate_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigndocumentApplyEzsigntemplateV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_ezsigndocument_id']: - _path_params['pkiEzsigndocumentID'] = _params['pki_ezsigndocument_id'] + def _ezsigndocument_apply_ezsigntemplate_v1_serialize( + self, + pki_ezsigndocument_id, + ezsigndocument_apply_ezsigntemplate_v1_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if pki_ezsigndocument_id is not None: + _path_params['pkiEzsigndocumentID'] = pki_ezsigndocument_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['ezsigndocument_apply_ezsigntemplate_v1_request'] is not None: - _body_params = _params['ezsigndocument_apply_ezsigntemplate_v1_request'] + if ezsigndocument_apply_ezsigntemplate_v1_request is not None: + _body_params = ezsigndocument_apply_ezsigntemplate_v1_request + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '200': "EzsigndocumentApplyEzsigntemplateV1Response", - '404': "CommonResponseError", - '422': "CommonResponseError", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsigndocument/{pkiEzsigndocumentID}/applyezsigntemplate', 'POST', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='POST', + resource_path='/1/object/ezsigndocument/{pkiEzsigndocumentID}/applyezsigntemplate', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + - @validate_arguments - def ezsigndocument_apply_ezsigntemplate_v2(self, pki_ezsigndocument_id : conint(strict=True, ge=0), ezsigndocument_apply_ezsigntemplate_v2_request : EzsigndocumentApplyEzsigntemplateV2Request, **kwargs) -> EzsigndocumentApplyEzsigntemplateV2Response: # noqa: E501 - """Apply an Ezsigntemplate to the Ezsigndocument. # noqa: E501 - This endpoint applies a predefined template to the ezsign document. This allows to automatically apply all the form and signature fields on a document in a single step. The document must not already have fields otherwise an error will be returned. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def ezsigndocument_apply_ezsigntemplate_v2( + self, + pki_ezsigndocument_id: Annotated[int, Field(strict=True, ge=0)], + ezsigndocument_apply_ezsigntemplate_v2_request: EzsigndocumentApplyEzsigntemplateV2Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsigndocumentApplyEzsigntemplateV2Response: + """Apply an Ezsigntemplate to the Ezsigndocument. - >>> thread = api.ezsigndocument_apply_ezsigntemplate_v2(pki_ezsigndocument_id, ezsigndocument_apply_ezsigntemplate_v2_request, async_req=True) - >>> result = thread.get() + This endpoint applies a predefined template to the ezsign document. This allows to automatically apply all the form and signature fields on a document in a single step. The document must not already have fields otherwise an error will be returned. :param pki_ezsigndocument_id: (required) :type pki_ezsigndocument_id: int :param ezsigndocument_apply_ezsigntemplate_v2_request: (required) :type ezsigndocument_apply_ezsigntemplate_v2_request: EzsigndocumentApplyEzsigntemplateV2Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsigndocumentApplyEzsigntemplateV2Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsigndocument_apply_ezsigntemplate_v2_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsigndocument_apply_ezsigntemplate_v2_with_http_info(pki_ezsigndocument_id, ezsigndocument_apply_ezsigntemplate_v2_request, **kwargs) # noqa: E501 - - @validate_arguments - def ezsigndocument_apply_ezsigntemplate_v2_with_http_info(self, pki_ezsigndocument_id : conint(strict=True, ge=0), ezsigndocument_apply_ezsigntemplate_v2_request : EzsigndocumentApplyEzsigntemplateV2Request, **kwargs) -> ApiResponse: # noqa: E501 - """Apply an Ezsigntemplate to the Ezsigndocument. # noqa: E501 + """ # noqa: E501 + + _param = self._ezsigndocument_apply_ezsigntemplate_v2_serialize( + pki_ezsigndocument_id=pki_ezsigndocument_id, + ezsigndocument_apply_ezsigntemplate_v2_request=ezsigndocument_apply_ezsigntemplate_v2_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - This endpoint applies a predefined template to the ezsign document. This allows to automatically apply all the form and signature fields on a document in a single step. The document must not already have fields otherwise an error will be returned. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigndocumentApplyEzsigntemplateV2Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsigndocument_apply_ezsigntemplate_v2_with_http_info( + self, + pki_ezsigndocument_id: Annotated[int, Field(strict=True, ge=0)], + ezsigndocument_apply_ezsigntemplate_v2_request: EzsigndocumentApplyEzsigntemplateV2Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsigndocumentApplyEzsigntemplateV2Response]: + """Apply an Ezsigntemplate to the Ezsigndocument. - >>> thread = api.ezsigndocument_apply_ezsigntemplate_v2_with_http_info(pki_ezsigndocument_id, ezsigndocument_apply_ezsigntemplate_v2_request, async_req=True) - >>> result = thread.get() + This endpoint applies a predefined template to the ezsign document. This allows to automatically apply all the form and signature fields on a document in a single step. The document must not already have fields otherwise an error will be returned. :param pki_ezsigndocument_id: (required) :type pki_ezsigndocument_id: int :param ezsigndocument_apply_ezsigntemplate_v2_request: (required) :type ezsigndocument_apply_ezsigntemplate_v2_request: EzsigndocumentApplyEzsigntemplateV2Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsigndocumentApplyEzsigntemplateV2Response, status_code(int), headers(HTTPHeaderDict)) - """ - - _params = locals() - - _all_params = [ - 'pki_ezsigndocument_id', - 'ezsigndocument_apply_ezsigntemplate_v2_request' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' - ] - ) - - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsigndocument_apply_ezsigntemplate_v2" % _key - ) - _params[_key] = _val - del _params['kwargs'] - - _collection_formats = {} - - # process the path parameters - _path_params = {} - if _params['pki_ezsigndocument_id']: - _path_params['pkiEzsigndocumentID'] = _params['pki_ezsigndocument_id'] - - - # process the query parameters - _query_params = [] - # process the header parameters - _header_params = dict(_params.get('_headers', {})) - # process the form parameters - _form_params = [] - _files = {} - # process the body parameter - _body_params = None - if _params['ezsigndocument_apply_ezsigntemplate_v2_request'] is not None: - _body_params = _params['ezsigndocument_apply_ezsigntemplate_v2_request'] - - # set the HTTP header `Accept` - _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 - - # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list - - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 + """ # noqa: E501 + + _param = self._ezsigndocument_apply_ezsigntemplate_v2_serialize( + pki_ezsigndocument_id=pki_ezsigndocument_id, + ezsigndocument_apply_ezsigntemplate_v2_request=ezsigndocument_apply_ezsigntemplate_v2_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _response_types_map = { + _response_types_map: Dict[str, Optional[str]] = { '200': "EzsigndocumentApplyEzsigntemplateV2Response", '404': "CommonResponseError", '422': "CommonResponseError", } - - return self.api_client.call_api( - '/2/object/ezsigndocument/{pkiEzsigndocumentID}/applyEzsigntemplate', 'POST', - _path_params, - _query_params, - _header_params, - body=_body_params, - post_params=_form_params, - files=_files, + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, response_types_map=_response_types_map, - auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), - collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) - - @validate_arguments - def ezsigndocument_create_object_v1(self, ezsigndocument_create_object_v1_request : conlist(EzsigndocumentCreateObjectV1Request), **kwargs) -> EzsigndocumentCreateObjectV1Response: # noqa: E501 - """(Deprecated) Create a new Ezsigndocument # noqa: E501 + ) - The endpoint allows to create one or many elements at once. The array can contain simple (Just the object) or compound (The object and its child) objects. Creating compound elements allows to reduce the multiple requests to create all child objects. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.ezsigndocument_create_object_v1(ezsigndocument_create_object_v1_request, async_req=True) - >>> result = thread.get() + @validate_call + def ezsigndocument_apply_ezsigntemplate_v2_without_preload_content( + self, + pki_ezsigndocument_id: Annotated[int, Field(strict=True, ge=0)], + ezsigndocument_apply_ezsigntemplate_v2_request: EzsigndocumentApplyEzsigntemplateV2Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Apply an Ezsigntemplate to the Ezsigndocument. - :param ezsigndocument_create_object_v1_request: (required) - :type ezsigndocument_create_object_v1_request: List[EzsigndocumentCreateObjectV1Request] - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsigndocumentCreateObjectV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsigndocument_create_object_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsigndocument_create_object_v1_with_http_info(ezsigndocument_create_object_v1_request, **kwargs) # noqa: E501 - - @validate_arguments - def ezsigndocument_create_object_v1_with_http_info(self, ezsigndocument_create_object_v1_request : conlist(EzsigndocumentCreateObjectV1Request), **kwargs) -> ApiResponse: # noqa: E501 - """(Deprecated) Create a new Ezsigndocument # noqa: E501 - - The endpoint allows to create one or many elements at once. The array can contain simple (Just the object) or compound (The object and its child) objects. Creating compound elements allows to reduce the multiple requests to create all child objects. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsigndocument_create_object_v1_with_http_info(ezsigndocument_create_object_v1_request, async_req=True) - >>> result = thread.get() + This endpoint applies a predefined template to the ezsign document. This allows to automatically apply all the form and signature fields on a document in a single step. The document must not already have fields otherwise an error will be returned. - :param ezsigndocument_create_object_v1_request: (required) - :type ezsigndocument_create_object_v1_request: List[EzsigndocumentCreateObjectV1Request] - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional + :param pki_ezsigndocument_id: (required) + :type pki_ezsigndocument_id: int + :param ezsigndocument_apply_ezsigntemplate_v2_request: (required) + :type ezsigndocument_apply_ezsigntemplate_v2_request: EzsigndocumentApplyEzsigntemplateV2Request :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsigndocumentCreateObjectV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._ezsigndocument_apply_ezsigntemplate_v2_serialize( + pki_ezsigndocument_id=pki_ezsigndocument_id, + ezsigndocument_apply_ezsigntemplate_v2_request=ezsigndocument_apply_ezsigntemplate_v2_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - warnings.warn("POST /1/object/ezsigndocument is deprecated.", DeprecationWarning) + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigndocumentApplyEzsigntemplateV2Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _params = locals() - _all_params = [ - 'ezsigndocument_create_object_v1_request' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' - ] - ) - - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsigndocument_create_object_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + def _ezsigndocument_apply_ezsigntemplate_v2_serialize( + self, + pki_ezsigndocument_id, + ezsigndocument_apply_ezsigntemplate_v2_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: - _collection_formats = {} + _host = None - # process the path parameters - _path_params = {} + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_ezsigndocument_id is not None: + _path_params['pkiEzsigndocumentID'] = pki_ezsigndocument_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['ezsigndocument_create_object_v1_request'] is not None: - _body_params = _params['ezsigndocument_create_object_v1_request'] + if ezsigndocument_apply_ezsigntemplate_v2_request is not None: + _body_params = ezsigndocument_apply_ezsigntemplate_v2_request + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '201': "EzsigndocumentCreateObjectV1Response", - '422': "CommonResponseErrorSTemporaryFileUrl", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsigndocument', 'POST', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='POST', + resource_path='/2/object/ezsigndocument/{pkiEzsigndocumentID}/applyEzsigntemplate', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) - @validate_arguments - def ezsigndocument_create_object_v2(self, ezsigndocument_create_object_v2_request : EzsigndocumentCreateObjectV2Request, **kwargs) -> EzsigndocumentCreateObjectV2Response: # noqa: E501 - """Create a new Ezsigndocument # noqa: E501 - The endpoint allows to create one or many elements at once. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.ezsigndocument_create_object_v2(ezsigndocument_create_object_v2_request, async_req=True) - >>> result = thread.get() - :param ezsigndocument_create_object_v2_request: (required) - :type ezsigndocument_create_object_v2_request: EzsigndocumentCreateObjectV2Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsigndocumentCreateObjectV2Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsigndocument_create_object_v2_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsigndocument_create_object_v2_with_http_info(ezsigndocument_create_object_v2_request, **kwargs) # noqa: E501 - - @validate_arguments - def ezsigndocument_create_object_v2_with_http_info(self, ezsigndocument_create_object_v2_request : EzsigndocumentCreateObjectV2Request, **kwargs) -> ApiResponse: # noqa: E501 - """Create a new Ezsigndocument # noqa: E501 - - The endpoint allows to create one or many elements at once. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsigndocument_create_object_v2_with_http_info(ezsigndocument_create_object_v2_request, async_req=True) - >>> result = thread.get() + @validate_call + def ezsigndocument_create_object_v1( + self, + ezsigndocument_create_object_v1_request: List[EzsigndocumentCreateObjectV1Request], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsigndocumentCreateObjectV1Response: + """(Deprecated) Create a new Ezsigndocument - :param ezsigndocument_create_object_v2_request: (required) - :type ezsigndocument_create_object_v2_request: EzsigndocumentCreateObjectV2Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional + The endpoint allows to create one or many elements at once. The array can contain simple (Just the object) or compound (The object and its child) objects. Creating compound elements allows to reduce the multiple requests to create all child objects. + + :param ezsigndocument_create_object_v1_request: (required) + :type ezsigndocument_create_object_v1_request: List[EzsigndocumentCreateObjectV1Request] :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsigndocumentCreateObjectV2Response, status_code(int), headers(HTTPHeaderDict)) - """ - - _params = locals() - - _all_params = [ - 'ezsigndocument_create_object_v2_request' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' - ] - ) - - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsigndocument_create_object_v2" % _key - ) - _params[_key] = _val - del _params['kwargs'] - - _collection_formats = {} - - # process the path parameters - _path_params = {} - - # process the query parameters - _query_params = [] - # process the header parameters - _header_params = dict(_params.get('_headers', {})) - # process the form parameters - _form_params = [] - _files = {} - # process the body parameter - _body_params = None - if _params['ezsigndocument_create_object_v2_request'] is not None: - _body_params = _params['ezsigndocument_create_object_v2_request'] - - # set the HTTP header `Accept` - _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 - - # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + """ # noqa: E501 + warnings.warn("POST /1/object/ezsigndocument is deprecated.", DeprecationWarning) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 + _param = self._ezsigndocument_create_object_v1_serialize( + ezsigndocument_create_object_v1_request=ezsigndocument_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _response_types_map = { - '201': "EzsigndocumentCreateObjectV2Response", + _response_types_map: Dict[str, Optional[str]] = { + '201': "EzsigndocumentCreateObjectV1Response", '422': "CommonResponseErrorSTemporaryFileUrl", } - - return self.api_client.call_api( - '/2/object/ezsigndocument', 'POST', - _path_params, - _query_params, - _header_params, - body=_body_params, - post_params=_form_params, - files=_files, + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, response_types_map=_response_types_map, - auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), - collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + ).data + + + @validate_call + def ezsigndocument_create_object_v1_with_http_info( + self, + ezsigndocument_create_object_v1_request: List[EzsigndocumentCreateObjectV1Request], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsigndocumentCreateObjectV1Response]: + """(Deprecated) Create a new Ezsigndocument - @validate_arguments - def ezsigndocument_decline_to_sign_v1(self, pki_ezsigndocument_id : conint(strict=True, ge=0), ezsigndocument_decline_to_sign_v1_request : EzsigndocumentDeclineToSignV1Request, **kwargs) -> EzsigndocumentDeclineToSignV1Response: # noqa: E501 - """Decline to sign # noqa: E501 + The endpoint allows to create one or many elements at once. The array can contain simple (Just the object) or compound (The object and its child) objects. Creating compound elements allows to reduce the multiple requests to create all child objects. - Decline to sign # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + :param ezsigndocument_create_object_v1_request: (required) + :type ezsigndocument_create_object_v1_request: List[EzsigndocumentCreateObjectV1Request] + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + warnings.warn("POST /1/object/ezsigndocument is deprecated.", DeprecationWarning) - >>> thread = api.ezsigndocument_decline_to_sign_v1(pki_ezsigndocument_id, ezsigndocument_decline_to_sign_v1_request, async_req=True) - >>> result = thread.get() + _param = self._ezsigndocument_create_object_v1_serialize( + ezsigndocument_create_object_v1_request=ezsigndocument_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - :param pki_ezsigndocument_id: (required) - :type pki_ezsigndocument_id: int - :param ezsigndocument_decline_to_sign_v1_request: (required) - :type ezsigndocument_decline_to_sign_v1_request: EzsigndocumentDeclineToSignV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsigndocumentDeclineToSignV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsigndocument_decline_to_sign_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsigndocument_decline_to_sign_v1_with_http_info(pki_ezsigndocument_id, ezsigndocument_decline_to_sign_v1_request, **kwargs) # noqa: E501 + _response_types_map: Dict[str, Optional[str]] = { + '201': "EzsigndocumentCreateObjectV1Response", + '422': "CommonResponseErrorSTemporaryFileUrl", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - @validate_arguments - def ezsigndocument_decline_to_sign_v1_with_http_info(self, pki_ezsigndocument_id : conint(strict=True, ge=0), ezsigndocument_decline_to_sign_v1_request : EzsigndocumentDeclineToSignV1Request, **kwargs) -> ApiResponse: # noqa: E501 - """Decline to sign # noqa: E501 - Decline to sign # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def ezsigndocument_create_object_v1_without_preload_content( + self, + ezsigndocument_create_object_v1_request: List[EzsigndocumentCreateObjectV1Request], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """(Deprecated) Create a new Ezsigndocument - >>> thread = api.ezsigndocument_decline_to_sign_v1_with_http_info(pki_ezsigndocument_id, ezsigndocument_decline_to_sign_v1_request, async_req=True) - >>> result = thread.get() + The endpoint allows to create one or many elements at once. The array can contain simple (Just the object) or compound (The object and its child) objects. Creating compound elements allows to reduce the multiple requests to create all child objects. - :param pki_ezsigndocument_id: (required) - :type pki_ezsigndocument_id: int - :param ezsigndocument_decline_to_sign_v1_request: (required) - :type ezsigndocument_decline_to_sign_v1_request: EzsigndocumentDeclineToSignV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional + :param ezsigndocument_create_object_v1_request: (required) + :type ezsigndocument_create_object_v1_request: List[EzsigndocumentCreateObjectV1Request] :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsigndocumentDeclineToSignV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + warnings.warn("POST /1/object/ezsigndocument is deprecated.", DeprecationWarning) + + _param = self._ezsigndocument_create_object_v1_serialize( + ezsigndocument_create_object_v1_request=ezsigndocument_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '201': "EzsigndocumentCreateObjectV1Response", + '422': "CommonResponseErrorSTemporaryFileUrl", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _all_params = [ - 'pki_ezsigndocument_id', - 'ezsigndocument_decline_to_sign_v1_request' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' - ] - ) - - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsigndocument_decline_to_sign_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] - _collection_formats = {} + def _ezsigndocument_create_object_v1_serialize( + self, + ezsigndocument_create_object_v1_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: - # process the path parameters - _path_params = {} - if _params['pki_ezsigndocument_id']: - _path_params['pkiEzsigndocumentID'] = _params['pki_ezsigndocument_id'] + _host = None + + _collection_formats: Dict[str, str] = { + 'EzsigndocumentCreateObjectV1Request': '', + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['ezsigndocument_decline_to_sign_v1_request'] is not None: - _body_params = _params['ezsigndocument_decline_to_sign_v1_request'] + if ezsigndocument_create_object_v1_request is not None: + _body_params = ezsigndocument_create_object_v1_request + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '200': "EzsigndocumentDeclineToSignV1Response", - '404': "CommonResponseError", - '422': "CommonResponseError", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsigndocument/{pkiEzsigndocumentID}/declineToSign', 'POST', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='POST', + resource_path='/1/object/ezsigndocument', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) - - @validate_arguments - def ezsigndocument_delete_object_v1(self, pki_ezsigndocument_id : conint(strict=True, ge=0), **kwargs) -> EzsigndocumentDeleteObjectV1Response: # noqa: E501 - """Delete an existing Ezsigndocument # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + _host=_host, + _request_auth=_request_auth + ) - >>> thread = api.ezsigndocument_delete_object_v1(pki_ezsigndocument_id, async_req=True) - >>> result = thread.get() - :param pki_ezsigndocument_id: (required) - :type pki_ezsigndocument_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsigndocumentDeleteObjectV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsigndocument_delete_object_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsigndocument_delete_object_v1_with_http_info(pki_ezsigndocument_id, **kwargs) # noqa: E501 - @validate_arguments - def ezsigndocument_delete_object_v1_with_http_info(self, pki_ezsigndocument_id : conint(strict=True, ge=0), **kwargs) -> ApiResponse: # noqa: E501 - """Delete an existing Ezsigndocument # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def ezsigndocument_create_object_v2( + self, + ezsigndocument_create_object_v2_request: EzsigndocumentCreateObjectV2Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsigndocumentCreateObjectV2Response: + """Create a new Ezsigndocument - >>> thread = api.ezsigndocument_delete_object_v1_with_http_info(pki_ezsigndocument_id, async_req=True) - >>> result = thread.get() + The endpoint allows to create one or many elements at once. - :param pki_ezsigndocument_id: (required) + :param ezsigndocument_create_object_v2_request: (required) + :type ezsigndocument_create_object_v2_request: EzsigndocumentCreateObjectV2Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsigndocument_create_object_v2_serialize( + ezsigndocument_create_object_v2_request=ezsigndocument_create_object_v2_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "EzsigndocumentCreateObjectV2Response", + '422': "CommonResponseErrorSTemporaryFileUrl", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsigndocument_create_object_v2_with_http_info( + self, + ezsigndocument_create_object_v2_request: EzsigndocumentCreateObjectV2Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsigndocumentCreateObjectV2Response]: + """Create a new Ezsigndocument + + The endpoint allows to create one or many elements at once. + + :param ezsigndocument_create_object_v2_request: (required) + :type ezsigndocument_create_object_v2_request: EzsigndocumentCreateObjectV2Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsigndocument_create_object_v2_serialize( + ezsigndocument_create_object_v2_request=ezsigndocument_create_object_v2_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "EzsigndocumentCreateObjectV2Response", + '422': "CommonResponseErrorSTemporaryFileUrl", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def ezsigndocument_create_object_v2_without_preload_content( + self, + ezsigndocument_create_object_v2_request: EzsigndocumentCreateObjectV2Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Create a new Ezsigndocument + + The endpoint allows to create one or many elements at once. + + :param ezsigndocument_create_object_v2_request: (required) + :type ezsigndocument_create_object_v2_request: EzsigndocumentCreateObjectV2Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsigndocument_create_object_v2_serialize( + ezsigndocument_create_object_v2_request=ezsigndocument_create_object_v2_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "EzsigndocumentCreateObjectV2Response", + '422': "CommonResponseErrorSTemporaryFileUrl", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _ezsigndocument_create_object_v2_serialize( + self, + ezsigndocument_create_object_v2_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if ezsigndocument_create_object_v2_request is not None: + _body_params = ezsigndocument_create_object_v2_request + + + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/2/object/ezsigndocument', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def ezsigndocument_decline_to_sign_v1( + self, + pki_ezsigndocument_id: Annotated[int, Field(strict=True, ge=0)], + ezsigndocument_decline_to_sign_v1_request: EzsigndocumentDeclineToSignV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsigndocumentDeclineToSignV1Response: + """Decline to sign + + Decline to sign + + :param pki_ezsigndocument_id: (required) + :type pki_ezsigndocument_id: int + :param ezsigndocument_decline_to_sign_v1_request: (required) + :type ezsigndocument_decline_to_sign_v1_request: EzsigndocumentDeclineToSignV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsigndocument_decline_to_sign_v1_serialize( + pki_ezsigndocument_id=pki_ezsigndocument_id, + ezsigndocument_decline_to_sign_v1_request=ezsigndocument_decline_to_sign_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigndocumentDeclineToSignV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsigndocument_decline_to_sign_v1_with_http_info( + self, + pki_ezsigndocument_id: Annotated[int, Field(strict=True, ge=0)], + ezsigndocument_decline_to_sign_v1_request: EzsigndocumentDeclineToSignV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsigndocumentDeclineToSignV1Response]: + """Decline to sign + + Decline to sign + + :param pki_ezsigndocument_id: (required) + :type pki_ezsigndocument_id: int + :param ezsigndocument_decline_to_sign_v1_request: (required) + :type ezsigndocument_decline_to_sign_v1_request: EzsigndocumentDeclineToSignV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsigndocument_decline_to_sign_v1_serialize( + pki_ezsigndocument_id=pki_ezsigndocument_id, + ezsigndocument_decline_to_sign_v1_request=ezsigndocument_decline_to_sign_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigndocumentDeclineToSignV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def ezsigndocument_decline_to_sign_v1_without_preload_content( + self, + pki_ezsigndocument_id: Annotated[int, Field(strict=True, ge=0)], + ezsigndocument_decline_to_sign_v1_request: EzsigndocumentDeclineToSignV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Decline to sign + + Decline to sign + + :param pki_ezsigndocument_id: (required) + :type pki_ezsigndocument_id: int + :param ezsigndocument_decline_to_sign_v1_request: (required) + :type ezsigndocument_decline_to_sign_v1_request: EzsigndocumentDeclineToSignV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsigndocument_decline_to_sign_v1_serialize( + pki_ezsigndocument_id=pki_ezsigndocument_id, + ezsigndocument_decline_to_sign_v1_request=ezsigndocument_decline_to_sign_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigndocumentDeclineToSignV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _ezsigndocument_decline_to_sign_v1_serialize( + self, + pki_ezsigndocument_id, + ezsigndocument_decline_to_sign_v1_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_ezsigndocument_id is not None: + _path_params['pkiEzsigndocumentID'] = pki_ezsigndocument_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if ezsigndocument_decline_to_sign_v1_request is not None: + _body_params = ezsigndocument_decline_to_sign_v1_request + + + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/1/object/ezsigndocument/{pkiEzsigndocumentID}/declineToSign', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def ezsigndocument_delete_object_v1( + self, + pki_ezsigndocument_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsigndocumentDeleteObjectV1Response: + """Delete an existing Ezsigndocument + + + + :param pki_ezsigndocument_id: (required) + :type pki_ezsigndocument_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsigndocument_delete_object_v1_serialize( + pki_ezsigndocument_id=pki_ezsigndocument_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigndocumentDeleteObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsigndocument_delete_object_v1_with_http_info( + self, + pki_ezsigndocument_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsigndocumentDeleteObjectV1Response]: + """Delete an existing Ezsigndocument + + + + :param pki_ezsigndocument_id: (required) + :type pki_ezsigndocument_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsigndocument_delete_object_v1_serialize( + pki_ezsigndocument_id=pki_ezsigndocument_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigndocumentDeleteObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def ezsigndocument_delete_object_v1_without_preload_content( + self, + pki_ezsigndocument_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete an existing Ezsigndocument + + + + :param pki_ezsigndocument_id: (required) + :type pki_ezsigndocument_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsigndocument_delete_object_v1_serialize( + pki_ezsigndocument_id=pki_ezsigndocument_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigndocumentDeleteObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _ezsigndocument_delete_object_v1_serialize( + self, + pki_ezsigndocument_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_ezsigndocument_id is not None: + _path_params['pkiEzsigndocumentID'] = pki_ezsigndocument_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/1/object/ezsigndocument/{pkiEzsigndocumentID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def ezsigndocument_edit_ezsignformfieldgroups_v1( + self, + pki_ezsigndocument_id: Annotated[int, Field(strict=True, ge=0)], + ezsigndocument_edit_ezsignformfieldgroups_v1_request: EzsigndocumentEditEzsignformfieldgroupsV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsigndocumentEditEzsignformfieldgroupsV1Response: + """Edit multiple Ezsignformfieldgroups + + Using this endpoint, you can edit multiple Ezsignformfieldgroups at the same time. + + :param pki_ezsigndocument_id: (required) + :type pki_ezsigndocument_id: int + :param ezsigndocument_edit_ezsignformfieldgroups_v1_request: (required) + :type ezsigndocument_edit_ezsignformfieldgroups_v1_request: EzsigndocumentEditEzsignformfieldgroupsV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsigndocument_edit_ezsignformfieldgroups_v1_serialize( + pki_ezsigndocument_id=pki_ezsigndocument_id, + ezsigndocument_edit_ezsignformfieldgroups_v1_request=ezsigndocument_edit_ezsignformfieldgroups_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigndocumentEditEzsignformfieldgroupsV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsigndocument_edit_ezsignformfieldgroups_v1_with_http_info( + self, + pki_ezsigndocument_id: Annotated[int, Field(strict=True, ge=0)], + ezsigndocument_edit_ezsignformfieldgroups_v1_request: EzsigndocumentEditEzsignformfieldgroupsV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsigndocumentEditEzsignformfieldgroupsV1Response]: + """Edit multiple Ezsignformfieldgroups + + Using this endpoint, you can edit multiple Ezsignformfieldgroups at the same time. + + :param pki_ezsigndocument_id: (required) + :type pki_ezsigndocument_id: int + :param ezsigndocument_edit_ezsignformfieldgroups_v1_request: (required) + :type ezsigndocument_edit_ezsignformfieldgroups_v1_request: EzsigndocumentEditEzsignformfieldgroupsV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsigndocument_edit_ezsignformfieldgroups_v1_serialize( + pki_ezsigndocument_id=pki_ezsigndocument_id, + ezsigndocument_edit_ezsignformfieldgroups_v1_request=ezsigndocument_edit_ezsignformfieldgroups_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigndocumentEditEzsignformfieldgroupsV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def ezsigndocument_edit_ezsignformfieldgroups_v1_without_preload_content( + self, + pki_ezsigndocument_id: Annotated[int, Field(strict=True, ge=0)], + ezsigndocument_edit_ezsignformfieldgroups_v1_request: EzsigndocumentEditEzsignformfieldgroupsV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Edit multiple Ezsignformfieldgroups + + Using this endpoint, you can edit multiple Ezsignformfieldgroups at the same time. + + :param pki_ezsigndocument_id: (required) + :type pki_ezsigndocument_id: int + :param ezsigndocument_edit_ezsignformfieldgroups_v1_request: (required) + :type ezsigndocument_edit_ezsignformfieldgroups_v1_request: EzsigndocumentEditEzsignformfieldgroupsV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsigndocument_edit_ezsignformfieldgroups_v1_serialize( + pki_ezsigndocument_id=pki_ezsigndocument_id, + ezsigndocument_edit_ezsignformfieldgroups_v1_request=ezsigndocument_edit_ezsignformfieldgroups_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigndocumentEditEzsignformfieldgroupsV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _ezsigndocument_edit_ezsignformfieldgroups_v1_serialize( + self, + pki_ezsigndocument_id, + ezsigndocument_edit_ezsignformfieldgroups_v1_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_ezsigndocument_id is not None: + _path_params['pkiEzsigndocumentID'] = pki_ezsigndocument_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if ezsigndocument_edit_ezsignformfieldgroups_v1_request is not None: + _body_params = ezsigndocument_edit_ezsignformfieldgroups_v1_request + + + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/1/object/ezsigndocument/{pkiEzsigndocumentID}/editEzsignformfieldgroups', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def ezsigndocument_edit_ezsignsignatures_v1( + self, + pki_ezsigndocument_id: Annotated[int, Field(strict=True, ge=0)], + ezsigndocument_edit_ezsignsignatures_v1_request: EzsigndocumentEditEzsignsignaturesV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsigndocumentEditEzsignsignaturesV1Response: + """Edit multiple Ezsignsignatures + + Using this endpoint, you can edit multiple Ezsignsignatures at the same time. + + :param pki_ezsigndocument_id: (required) + :type pki_ezsigndocument_id: int + :param ezsigndocument_edit_ezsignsignatures_v1_request: (required) + :type ezsigndocument_edit_ezsignsignatures_v1_request: EzsigndocumentEditEzsignsignaturesV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsigndocument_edit_ezsignsignatures_v1_serialize( + pki_ezsigndocument_id=pki_ezsigndocument_id, + ezsigndocument_edit_ezsignsignatures_v1_request=ezsigndocument_edit_ezsignsignatures_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigndocumentEditEzsignsignaturesV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsigndocument_edit_ezsignsignatures_v1_with_http_info( + self, + pki_ezsigndocument_id: Annotated[int, Field(strict=True, ge=0)], + ezsigndocument_edit_ezsignsignatures_v1_request: EzsigndocumentEditEzsignsignaturesV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsigndocumentEditEzsignsignaturesV1Response]: + """Edit multiple Ezsignsignatures + + Using this endpoint, you can edit multiple Ezsignsignatures at the same time. + + :param pki_ezsigndocument_id: (required) + :type pki_ezsigndocument_id: int + :param ezsigndocument_edit_ezsignsignatures_v1_request: (required) + :type ezsigndocument_edit_ezsignsignatures_v1_request: EzsigndocumentEditEzsignsignaturesV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsigndocument_edit_ezsignsignatures_v1_serialize( + pki_ezsigndocument_id=pki_ezsigndocument_id, + ezsigndocument_edit_ezsignsignatures_v1_request=ezsigndocument_edit_ezsignsignatures_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigndocumentEditEzsignsignaturesV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def ezsigndocument_edit_ezsignsignatures_v1_without_preload_content( + self, + pki_ezsigndocument_id: Annotated[int, Field(strict=True, ge=0)], + ezsigndocument_edit_ezsignsignatures_v1_request: EzsigndocumentEditEzsignsignaturesV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Edit multiple Ezsignsignatures + + Using this endpoint, you can edit multiple Ezsignsignatures at the same time. + + :param pki_ezsigndocument_id: (required) + :type pki_ezsigndocument_id: int + :param ezsigndocument_edit_ezsignsignatures_v1_request: (required) + :type ezsigndocument_edit_ezsignsignatures_v1_request: EzsigndocumentEditEzsignsignaturesV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsigndocument_edit_ezsignsignatures_v1_serialize( + pki_ezsigndocument_id=pki_ezsigndocument_id, + ezsigndocument_edit_ezsignsignatures_v1_request=ezsigndocument_edit_ezsignsignatures_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigndocumentEditEzsignsignaturesV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _ezsigndocument_edit_ezsignsignatures_v1_serialize( + self, + pki_ezsigndocument_id, + ezsigndocument_edit_ezsignsignatures_v1_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_ezsigndocument_id is not None: + _path_params['pkiEzsigndocumentID'] = pki_ezsigndocument_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if ezsigndocument_edit_ezsignsignatures_v1_request is not None: + _body_params = ezsigndocument_edit_ezsignsignatures_v1_request + + + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/1/object/ezsigndocument/{pkiEzsigndocumentID}/editEzsignsignatures', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def ezsigndocument_end_prematurely_v1( + self, + pki_ezsigndocument_id: Annotated[int, Field(strict=True, ge=0)], + body: Dict[str, Any], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsigndocumentEndPrematurelyV1Response: + """End prematurely + + End prematurely an Ezsigndocument when some signatures are still required + + :param pki_ezsigndocument_id: (required) + :type pki_ezsigndocument_id: int + :param body: (required) + :type body: object + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsigndocument_end_prematurely_v1_serialize( + pki_ezsigndocument_id=pki_ezsigndocument_id, + body=body, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigndocumentEndPrematurelyV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsigndocument_end_prematurely_v1_with_http_info( + self, + pki_ezsigndocument_id: Annotated[int, Field(strict=True, ge=0)], + body: Dict[str, Any], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsigndocumentEndPrematurelyV1Response]: + """End prematurely + + End prematurely an Ezsigndocument when some signatures are still required + + :param pki_ezsigndocument_id: (required) + :type pki_ezsigndocument_id: int + :param body: (required) + :type body: object + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsigndocument_end_prematurely_v1_serialize( + pki_ezsigndocument_id=pki_ezsigndocument_id, + body=body, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigndocumentEndPrematurelyV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def ezsigndocument_end_prematurely_v1_without_preload_content( + self, + pki_ezsigndocument_id: Annotated[int, Field(strict=True, ge=0)], + body: Dict[str, Any], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """End prematurely + + End prematurely an Ezsigndocument when some signatures are still required + + :param pki_ezsigndocument_id: (required) + :type pki_ezsigndocument_id: int + :param body: (required) + :type body: object + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsigndocument_end_prematurely_v1_serialize( + pki_ezsigndocument_id=pki_ezsigndocument_id, + body=body, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigndocumentEndPrematurelyV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _ezsigndocument_end_prematurely_v1_serialize( + self, + pki_ezsigndocument_id, + body, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_ezsigndocument_id is not None: + _path_params['pkiEzsigndocumentID'] = pki_ezsigndocument_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if body is not None: + _body_params = body + + + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/1/object/ezsigndocument/{pkiEzsigndocumentID}/endPrematurely', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def ezsigndocument_flatten_v1( + self, + pki_ezsigndocument_id: Annotated[int, Field(strict=True, ge=0)], + body: Dict[str, Any], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsigndocumentFlattenV1Response: + """Flatten + + Flatten an Ezsigndocument signatures, forms and annotations. This process finalizes the PDF so that the forms and annotations become part of the document content and cannot be edited. + + :param pki_ezsigndocument_id: (required) + :type pki_ezsigndocument_id: int + :param body: (required) + :type body: object + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsigndocument_flatten_v1_serialize( + pki_ezsigndocument_id=pki_ezsigndocument_id, + body=body, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigndocumentFlattenV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsigndocument_flatten_v1_with_http_info( + self, + pki_ezsigndocument_id: Annotated[int, Field(strict=True, ge=0)], + body: Dict[str, Any], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsigndocumentFlattenV1Response]: + """Flatten + + Flatten an Ezsigndocument signatures, forms and annotations. This process finalizes the PDF so that the forms and annotations become part of the document content and cannot be edited. + + :param pki_ezsigndocument_id: (required) + :type pki_ezsigndocument_id: int + :param body: (required) + :type body: object + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsigndocument_flatten_v1_serialize( + pki_ezsigndocument_id=pki_ezsigndocument_id, + body=body, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigndocumentFlattenV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def ezsigndocument_flatten_v1_without_preload_content( + self, + pki_ezsigndocument_id: Annotated[int, Field(strict=True, ge=0)], + body: Dict[str, Any], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Flatten + + Flatten an Ezsigndocument signatures, forms and annotations. This process finalizes the PDF so that the forms and annotations become part of the document content and cannot be edited. + + :param pki_ezsigndocument_id: (required) + :type pki_ezsigndocument_id: int + :param body: (required) + :type body: object + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsigndocument_flatten_v1_serialize( + pki_ezsigndocument_id=pki_ezsigndocument_id, + body=body, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigndocumentFlattenV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _ezsigndocument_flatten_v1_serialize( + self, + pki_ezsigndocument_id, + body, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_ezsigndocument_id is not None: + _path_params['pkiEzsigndocumentID'] = pki_ezsigndocument_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if body is not None: + _body_params = body + + + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/1/object/ezsigndocument/{pkiEzsigndocumentID}/flatten', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def ezsigndocument_get_actionable_elements_v1( + self, + pki_ezsigndocument_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsigndocumentGetActionableElementsV1Response: + """Retrieve actionable elements for the Ezsigndocument + + Return the Ezsignsignatures that can be signed and Ezsignformfieldgroups that can be filled by the current user at the current step in the process + + :param pki_ezsigndocument_id: (required) + :type pki_ezsigndocument_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsigndocument_get_actionable_elements_v1_serialize( + pki_ezsigndocument_id=pki_ezsigndocument_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigndocumentGetActionableElementsV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsigndocument_get_actionable_elements_v1_with_http_info( + self, + pki_ezsigndocument_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsigndocumentGetActionableElementsV1Response]: + """Retrieve actionable elements for the Ezsigndocument + + Return the Ezsignsignatures that can be signed and Ezsignformfieldgroups that can be filled by the current user at the current step in the process + + :param pki_ezsigndocument_id: (required) + :type pki_ezsigndocument_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsigndocument_get_actionable_elements_v1_serialize( + pki_ezsigndocument_id=pki_ezsigndocument_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigndocumentGetActionableElementsV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def ezsigndocument_get_actionable_elements_v1_without_preload_content( + self, + pki_ezsigndocument_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve actionable elements for the Ezsigndocument + + Return the Ezsignsignatures that can be signed and Ezsignformfieldgroups that can be filled by the current user at the current step in the process + + :param pki_ezsigndocument_id: (required) + :type pki_ezsigndocument_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsigndocument_get_actionable_elements_v1_serialize( + pki_ezsigndocument_id=pki_ezsigndocument_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigndocumentGetActionableElementsV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _ezsigndocument_get_actionable_elements_v1_serialize( + self, + pki_ezsigndocument_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_ezsigndocument_id is not None: + _path_params['pkiEzsigndocumentID'] = pki_ezsigndocument_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/1/object/ezsigndocument/{pkiEzsigndocumentID}/getActionableElements', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def ezsigndocument_get_attachments_v1( + self, + pki_ezsigndocument_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsigndocumentGetAttachmentsV1Response: + """Retrieve Ezsigndocument's Attachments + + + + :param pki_ezsigndocument_id: (required) + :type pki_ezsigndocument_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsigndocument_get_attachments_v1_serialize( + pki_ezsigndocument_id=pki_ezsigndocument_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigndocumentGetAttachmentsV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsigndocument_get_attachments_v1_with_http_info( + self, + pki_ezsigndocument_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsigndocumentGetAttachmentsV1Response]: + """Retrieve Ezsigndocument's Attachments + + + + :param pki_ezsigndocument_id: (required) + :type pki_ezsigndocument_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsigndocument_get_attachments_v1_serialize( + pki_ezsigndocument_id=pki_ezsigndocument_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigndocumentGetAttachmentsV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def ezsigndocument_get_attachments_v1_without_preload_content( + self, + pki_ezsigndocument_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve Ezsigndocument's Attachments + + + + :param pki_ezsigndocument_id: (required) + :type pki_ezsigndocument_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsigndocument_get_attachments_v1_serialize( + pki_ezsigndocument_id=pki_ezsigndocument_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigndocumentGetAttachmentsV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _ezsigndocument_get_attachments_v1_serialize( + self, + pki_ezsigndocument_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_ezsigndocument_id is not None: + _path_params['pkiEzsigndocumentID'] = pki_ezsigndocument_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/1/object/ezsigndocument/{pkiEzsigndocumentID}/getAttachments', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def ezsigndocument_get_completed_elements_v1( + self, + pki_ezsigndocument_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsigndocumentGetCompletedElementsV1Response: + """Retrieve completed elements for the Ezsigndocument + + Return the completed Ezsignsignatures, Ezsignformfieldgroups and Ezsignannotations at the current step in the process + + :param pki_ezsigndocument_id: (required) + :type pki_ezsigndocument_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsigndocument_get_completed_elements_v1_serialize( + pki_ezsigndocument_id=pki_ezsigndocument_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigndocumentGetCompletedElementsV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsigndocument_get_completed_elements_v1_with_http_info( + self, + pki_ezsigndocument_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsigndocumentGetCompletedElementsV1Response]: + """Retrieve completed elements for the Ezsigndocument + + Return the completed Ezsignsignatures, Ezsignformfieldgroups and Ezsignannotations at the current step in the process + + :param pki_ezsigndocument_id: (required) + :type pki_ezsigndocument_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsigndocument_get_completed_elements_v1_serialize( + pki_ezsigndocument_id=pki_ezsigndocument_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigndocumentGetCompletedElementsV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def ezsigndocument_get_completed_elements_v1_without_preload_content( + self, + pki_ezsigndocument_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve completed elements for the Ezsigndocument + + Return the completed Ezsignsignatures, Ezsignformfieldgroups and Ezsignannotations at the current step in the process + + :param pki_ezsigndocument_id: (required) + :type pki_ezsigndocument_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsigndocument_get_completed_elements_v1_serialize( + pki_ezsigndocument_id=pki_ezsigndocument_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigndocumentGetCompletedElementsV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _ezsigndocument_get_completed_elements_v1_serialize( + self, + pki_ezsigndocument_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_ezsigndocument_id is not None: + _path_params['pkiEzsigndocumentID'] = pki_ezsigndocument_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/1/object/ezsigndocument/{pkiEzsigndocumentID}/getCompletedElements', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def ezsigndocument_get_download_url_v1( + self, + pki_ezsigndocument_id: Annotated[int, Field(strict=True, ge=0)], + e_document_type: Annotated[StrictStr, Field(description="The type of document to retrieve. 1. **Initial** Is the initial document before any signature were applied. 2. **SignatureReady** Is the version containing the annotations/form to show the signer. 3. **Signed** Is the final document once all signatures were applied. 4. **Proofdocument** Is the evidence report. 5. **Proof** Is the complete evidence archive including all of the above and more. ")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsigndocumentGetDownloadUrlV1Response: + """Retrieve a URL to download documents. + + This endpoint returns URLs to different files that can be downloaded during the signing process. These links will expire after 5 minutes so the download of the file should be made soon after retrieving the link. + + :param pki_ezsigndocument_id: (required) + :type pki_ezsigndocument_id: int + :param e_document_type: The type of document to retrieve. 1. **Initial** Is the initial document before any signature were applied. 2. **SignatureReady** Is the version containing the annotations/form to show the signer. 3. **Signed** Is the final document once all signatures were applied. 4. **Proofdocument** Is the evidence report. 5. **Proof** Is the complete evidence archive including all of the above and more. (required) + :type e_document_type: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsigndocument_get_download_url_v1_serialize( + pki_ezsigndocument_id=pki_ezsigndocument_id, + e_document_type=e_document_type, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigndocumentGetDownloadUrlV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsigndocument_get_download_url_v1_with_http_info( + self, + pki_ezsigndocument_id: Annotated[int, Field(strict=True, ge=0)], + e_document_type: Annotated[StrictStr, Field(description="The type of document to retrieve. 1. **Initial** Is the initial document before any signature were applied. 2. **SignatureReady** Is the version containing the annotations/form to show the signer. 3. **Signed** Is the final document once all signatures were applied. 4. **Proofdocument** Is the evidence report. 5. **Proof** Is the complete evidence archive including all of the above and more. ")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsigndocumentGetDownloadUrlV1Response]: + """Retrieve a URL to download documents. + + This endpoint returns URLs to different files that can be downloaded during the signing process. These links will expire after 5 minutes so the download of the file should be made soon after retrieving the link. + + :param pki_ezsigndocument_id: (required) + :type pki_ezsigndocument_id: int + :param e_document_type: The type of document to retrieve. 1. **Initial** Is the initial document before any signature were applied. 2. **SignatureReady** Is the version containing the annotations/form to show the signer. 3. **Signed** Is the final document once all signatures were applied. 4. **Proofdocument** Is the evidence report. 5. **Proof** Is the complete evidence archive including all of the above and more. (required) + :type e_document_type: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsigndocument_get_download_url_v1_serialize( + pki_ezsigndocument_id=pki_ezsigndocument_id, + e_document_type=e_document_type, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigndocumentGetDownloadUrlV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def ezsigndocument_get_download_url_v1_without_preload_content( + self, + pki_ezsigndocument_id: Annotated[int, Field(strict=True, ge=0)], + e_document_type: Annotated[StrictStr, Field(description="The type of document to retrieve. 1. **Initial** Is the initial document before any signature were applied. 2. **SignatureReady** Is the version containing the annotations/form to show the signer. 3. **Signed** Is the final document once all signatures were applied. 4. **Proofdocument** Is the evidence report. 5. **Proof** Is the complete evidence archive including all of the above and more. ")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve a URL to download documents. + + This endpoint returns URLs to different files that can be downloaded during the signing process. These links will expire after 5 minutes so the download of the file should be made soon after retrieving the link. + + :param pki_ezsigndocument_id: (required) :type pki_ezsigndocument_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional + :param e_document_type: The type of document to retrieve. 1. **Initial** Is the initial document before any signature were applied. 2. **SignatureReady** Is the version containing the annotations/form to show the signer. 3. **Signed** Is the final document once all signatures were applied. 4. **Proofdocument** Is the evidence report. 5. **Proof** Is the complete evidence archive including all of the above and more. (required) + :type e_document_type: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsigndocumentDeleteObjectV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._ezsigndocument_get_download_url_v1_serialize( + pki_ezsigndocument_id=pki_ezsigndocument_id, + e_document_type=e_document_type, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigndocumentGetDownloadUrlV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _all_params = [ - 'pki_ezsigndocument_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' - ] - ) - - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsigndocument_delete_object_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] - _collection_formats = {} + def _ezsigndocument_get_download_url_v1_serialize( + self, + pki_ezsigndocument_id, + e_document_type, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: - # process the path parameters - _path_params = {} - if _params['pki_ezsigndocument_id']: - _path_params['pkiEzsigndocumentID'] = _params['pki_ezsigndocument_id'] + _host = None + + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if pki_ezsigndocument_id is not None: + _path_params['pkiEzsigndocumentID'] = pki_ezsigndocument_id + if e_document_type is not None: + _path_params['eDocumentType'] = e_document_type # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "EzsigndocumentDeleteObjectV1Response", - '404': "CommonResponseError", - '422': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsigndocument/{pkiEzsigndocumentID}', 'DELETE', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/1/object/ezsigndocument/{pkiEzsigndocumentID}/getDownloadUrl/{eDocumentType}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + - @validate_arguments - def ezsigndocument_edit_ezsignformfieldgroups_v1(self, pki_ezsigndocument_id : conint(strict=True, ge=0), ezsigndocument_edit_ezsignformfieldgroups_v1_request : EzsigndocumentEditEzsignformfieldgroupsV1Request, **kwargs) -> EzsigndocumentEditEzsignformfieldgroupsV1Response: # noqa: E501 - """Edit multiple Ezsignformfieldgroups # noqa: E501 - Using this endpoint, you can edit multiple Ezsignformfieldgroups at the same time. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.ezsigndocument_edit_ezsignformfieldgroups_v1(pki_ezsigndocument_id, ezsigndocument_edit_ezsignformfieldgroups_v1_request, async_req=True) - >>> result = thread.get() + @validate_call + def ezsigndocument_get_ezsignannotations_v1( + self, + pki_ezsigndocument_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsigndocumentGetEzsignannotationsV1Response: + """Retrieve an existing Ezsigndocument's Ezsignannotations + + :param pki_ezsigndocument_id: (required) :type pki_ezsigndocument_id: int - :param ezsigndocument_edit_ezsignformfieldgroups_v1_request: (required) - :type ezsigndocument_edit_ezsignformfieldgroups_v1_request: EzsigndocumentEditEzsignformfieldgroupsV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsigndocument_get_ezsignannotations_v1_serialize( + pki_ezsigndocument_id=pki_ezsigndocument_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigndocumentGetEzsignannotationsV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsigndocument_get_ezsignannotations_v1_with_http_info( + self, + pki_ezsigndocument_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsigndocumentGetEzsignannotationsV1Response]: + """Retrieve an existing Ezsigndocument's Ezsignannotations + + + + :param pki_ezsigndocument_id: (required) + :type pki_ezsigndocument_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsigndocumentEditEzsignformfieldgroupsV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsigndocument_edit_ezsignformfieldgroups_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsigndocument_edit_ezsignformfieldgroups_v1_with_http_info(pki_ezsigndocument_id, ezsigndocument_edit_ezsignformfieldgroups_v1_request, **kwargs) # noqa: E501 + """ # noqa: E501 + + _param = self._ezsigndocument_get_ezsignannotations_v1_serialize( + pki_ezsigndocument_id=pki_ezsigndocument_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigndocumentGetEzsignannotationsV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - @validate_arguments - def ezsigndocument_edit_ezsignformfieldgroups_v1_with_http_info(self, pki_ezsigndocument_id : conint(strict=True, ge=0), ezsigndocument_edit_ezsignformfieldgroups_v1_request : EzsigndocumentEditEzsignformfieldgroupsV1Request, **kwargs) -> ApiResponse: # noqa: E501 - """Edit multiple Ezsignformfieldgroups # noqa: E501 - Using this endpoint, you can edit multiple Ezsignformfieldgroups at the same time. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def ezsigndocument_get_ezsignannotations_v1_without_preload_content( + self, + pki_ezsigndocument_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve an existing Ezsigndocument's Ezsignannotations - >>> thread = api.ezsigndocument_edit_ezsignformfieldgroups_v1_with_http_info(pki_ezsigndocument_id, ezsigndocument_edit_ezsignformfieldgroups_v1_request, async_req=True) - >>> result = thread.get() + :param pki_ezsigndocument_id: (required) :type pki_ezsigndocument_id: int - :param ezsigndocument_edit_ezsignformfieldgroups_v1_request: (required) - :type ezsigndocument_edit_ezsignformfieldgroups_v1_request: EzsigndocumentEditEzsignformfieldgroupsV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsigndocumentEditEzsignformfieldgroupsV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._ezsigndocument_get_ezsignannotations_v1_serialize( + pki_ezsigndocument_id=pki_ezsigndocument_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigndocumentGetEzsignannotationsV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _all_params = [ - 'pki_ezsigndocument_id', - 'ezsigndocument_edit_ezsignformfieldgroups_v1_request' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' - ] - ) - - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsigndocument_edit_ezsignformfieldgroups_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] - _collection_formats = {} + def _ezsigndocument_get_ezsignannotations_v1_serialize( + self, + pki_ezsigndocument_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: - # process the path parameters - _path_params = {} - if _params['pki_ezsigndocument_id']: - _path_params['pkiEzsigndocumentID'] = _params['pki_ezsigndocument_id'] + _host = None + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if pki_ezsigndocument_id is not None: + _path_params['pkiEzsigndocumentID'] = pki_ezsigndocument_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['ezsigndocument_edit_ezsignformfieldgroups_v1_request'] is not None: - _body_params = _params['ezsigndocument_edit_ezsignformfieldgroups_v1_request'] + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '200': "EzsigndocumentEditEzsignformfieldgroupsV1Response", - '404': "CommonResponseError", - '422': "CommonResponseError", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsigndocument/{pkiEzsigndocumentID}/editEzsignformfieldgroups', 'PUT', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/1/object/ezsigndocument/{pkiEzsigndocumentID}/getEzsignannotations', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) - @validate_arguments - def ezsigndocument_edit_ezsignsignatures_v1(self, pki_ezsigndocument_id : conint(strict=True, ge=0), ezsigndocument_edit_ezsignsignatures_v1_request : EzsigndocumentEditEzsignsignaturesV1Request, **kwargs) -> EzsigndocumentEditEzsignsignaturesV1Response: # noqa: E501 - """Edit multiple Ezsignsignatures # noqa: E501 - Using this endpoint, you can edit multiple Ezsignsignatures at the same time. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.ezsigndocument_edit_ezsignsignatures_v1(pki_ezsigndocument_id, ezsigndocument_edit_ezsignsignatures_v1_request, async_req=True) - >>> result = thread.get() + + @validate_call + def ezsigndocument_get_ezsignformfieldgroups_v1( + self, + pki_ezsigndocument_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsigndocumentGetEzsignformfieldgroupsV1Response: + """Retrieve an existing Ezsigndocument's Ezsignformfieldgroups + + :param pki_ezsigndocument_id: (required) :type pki_ezsigndocument_id: int - :param ezsigndocument_edit_ezsignsignatures_v1_request: (required) - :type ezsigndocument_edit_ezsignsignatures_v1_request: EzsigndocumentEditEzsignsignaturesV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsigndocument_get_ezsignformfieldgroups_v1_serialize( + pki_ezsigndocument_id=pki_ezsigndocument_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigndocumentGetEzsignformfieldgroupsV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsigndocument_get_ezsignformfieldgroups_v1_with_http_info( + self, + pki_ezsigndocument_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsigndocumentGetEzsignformfieldgroupsV1Response]: + """Retrieve an existing Ezsigndocument's Ezsignformfieldgroups + + + + :param pki_ezsigndocument_id: (required) + :type pki_ezsigndocument_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsigndocumentEditEzsignsignaturesV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsigndocument_edit_ezsignsignatures_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsigndocument_edit_ezsignsignatures_v1_with_http_info(pki_ezsigndocument_id, ezsigndocument_edit_ezsignsignatures_v1_request, **kwargs) # noqa: E501 + """ # noqa: E501 + + _param = self._ezsigndocument_get_ezsignformfieldgroups_v1_serialize( + pki_ezsigndocument_id=pki_ezsigndocument_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigndocumentGetEzsignformfieldgroupsV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - @validate_arguments - def ezsigndocument_edit_ezsignsignatures_v1_with_http_info(self, pki_ezsigndocument_id : conint(strict=True, ge=0), ezsigndocument_edit_ezsignsignatures_v1_request : EzsigndocumentEditEzsignsignaturesV1Request, **kwargs) -> ApiResponse: # noqa: E501 - """Edit multiple Ezsignsignatures # noqa: E501 - Using this endpoint, you can edit multiple Ezsignsignatures at the same time. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def ezsigndocument_get_ezsignformfieldgroups_v1_without_preload_content( + self, + pki_ezsigndocument_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve an existing Ezsigndocument's Ezsignformfieldgroups - >>> thread = api.ezsigndocument_edit_ezsignsignatures_v1_with_http_info(pki_ezsigndocument_id, ezsigndocument_edit_ezsignsignatures_v1_request, async_req=True) - >>> result = thread.get() + :param pki_ezsigndocument_id: (required) :type pki_ezsigndocument_id: int - :param ezsigndocument_edit_ezsignsignatures_v1_request: (required) - :type ezsigndocument_edit_ezsignsignatures_v1_request: EzsigndocumentEditEzsignsignaturesV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsigndocumentEditEzsignsignaturesV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._ezsigndocument_get_ezsignformfieldgroups_v1_serialize( + pki_ezsigndocument_id=pki_ezsigndocument_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigndocumentGetEzsignformfieldgroupsV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _params = locals() - _all_params = [ - 'pki_ezsigndocument_id', - 'ezsigndocument_edit_ezsignsignatures_v1_request' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' - ] - ) - - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsigndocument_edit_ezsignsignatures_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + def _ezsigndocument_get_ezsignformfieldgroups_v1_serialize( + self, + pki_ezsigndocument_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: - _collection_formats = {} + _host = None - # process the path parameters - _path_params = {} - if _params['pki_ezsigndocument_id']: - _path_params['pkiEzsigndocumentID'] = _params['pki_ezsigndocument_id'] + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if pki_ezsigndocument_id is not None: + _path_params['pkiEzsigndocumentID'] = pki_ezsigndocument_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['ezsigndocument_edit_ezsignsignatures_v1_request'] is not None: - _body_params = _params['ezsigndocument_edit_ezsignsignatures_v1_request'] + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '200': "EzsigndocumentEditEzsignsignaturesV1Response", - '404': "CommonResponseError", - '422': "CommonResponseError", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsigndocument/{pkiEzsigndocumentID}/editEzsignsignatures', 'PUT', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/1/object/ezsigndocument/{pkiEzsigndocumentID}/getEzsignformfieldgroups', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + - @validate_arguments - def ezsigndocument_end_prematurely_v1(self, pki_ezsigndocument_id : conint(strict=True, ge=0), body : Dict[str, Any], **kwargs) -> EzsigndocumentEndPrematurelyV1Response: # noqa: E501 - """End prematurely # noqa: E501 - End prematurely an Ezsigndocument when some signatures are still required # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.ezsigndocument_end_prematurely_v1(pki_ezsigndocument_id, body, async_req=True) - >>> result = thread.get() + @validate_call + def ezsigndocument_get_ezsignpages_v1( + self, + pki_ezsigndocument_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsigndocumentGetEzsignpagesV1Response: + """Retrieve an existing Ezsigndocument's Ezsignpages + + :param pki_ezsigndocument_id: (required) :type pki_ezsigndocument_id: int - :param body: (required) - :type body: object - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsigndocument_get_ezsignpages_v1_serialize( + pki_ezsigndocument_id=pki_ezsigndocument_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigndocumentGetEzsignpagesV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsigndocument_get_ezsignpages_v1_with_http_info( + self, + pki_ezsigndocument_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsigndocumentGetEzsignpagesV1Response]: + """Retrieve an existing Ezsigndocument's Ezsignpages + + + + :param pki_ezsigndocument_id: (required) + :type pki_ezsigndocument_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsigndocumentEndPrematurelyV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsigndocument_end_prematurely_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsigndocument_end_prematurely_v1_with_http_info(pki_ezsigndocument_id, body, **kwargs) # noqa: E501 + """ # noqa: E501 + + _param = self._ezsigndocument_get_ezsignpages_v1_serialize( + pki_ezsigndocument_id=pki_ezsigndocument_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigndocumentGetEzsignpagesV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - @validate_arguments - def ezsigndocument_end_prematurely_v1_with_http_info(self, pki_ezsigndocument_id : conint(strict=True, ge=0), body : Dict[str, Any], **kwargs) -> ApiResponse: # noqa: E501 - """End prematurely # noqa: E501 - End prematurely an Ezsigndocument when some signatures are still required # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def ezsigndocument_get_ezsignpages_v1_without_preload_content( + self, + pki_ezsigndocument_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve an existing Ezsigndocument's Ezsignpages - >>> thread = api.ezsigndocument_end_prematurely_v1_with_http_info(pki_ezsigndocument_id, body, async_req=True) - >>> result = thread.get() + :param pki_ezsigndocument_id: (required) :type pki_ezsigndocument_id: int - :param body: (required) - :type body: object - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsigndocumentEndPrematurelyV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._ezsigndocument_get_ezsignpages_v1_serialize( + pki_ezsigndocument_id=pki_ezsigndocument_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigndocumentGetEzsignpagesV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _all_params = [ - 'pki_ezsigndocument_id', - 'body' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' - ] - ) - - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsigndocument_end_prematurely_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] - _collection_formats = {} + def _ezsigndocument_get_ezsignpages_v1_serialize( + self, + pki_ezsigndocument_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: - # process the path parameters - _path_params = {} - if _params['pki_ezsigndocument_id']: - _path_params['pkiEzsigndocumentID'] = _params['pki_ezsigndocument_id'] + _host = None + + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if pki_ezsigndocument_id is not None: + _path_params['pkiEzsigndocumentID'] = pki_ezsigndocument_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['body'] is not None: - _body_params = _params['body'] + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '200': "EzsigndocumentEndPrematurelyV1Response", - '404': "CommonResponseError", - '422': "CommonResponseError", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsigndocument/{pkiEzsigndocumentID}/endPrematurely', 'POST', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/1/object/ezsigndocument/{pkiEzsigndocumentID}/getEzsignpages', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def ezsigndocument_get_ezsignsignatures_automatic_v1( + self, + pki_ezsigndocument_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsigndocumentGetEzsignsignaturesAutomaticV1Response: + """Retrieve an existing Ezsigndocument's automatic Ezsignsignatures + + Return the Ezsignsignatures that can be signed by the current user at the current step in the process - @validate_arguments - def ezsigndocument_flatten_v1(self, pki_ezsigndocument_id : conint(strict=True, ge=0), body : Dict[str, Any], **kwargs) -> EzsigndocumentFlattenV1Response: # noqa: E501 - """Flatten # noqa: E501 + :param pki_ezsigndocument_id: (required) + :type pki_ezsigndocument_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsigndocument_get_ezsignsignatures_automatic_v1_serialize( + pki_ezsigndocument_id=pki_ezsigndocument_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - Flatten an Ezsigndocument signatures, forms and annotations. This process finalizes the PDF so that the forms and annotations become part of the document content and cannot be edited. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigndocumentGetEzsignsignaturesAutomaticV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsigndocument_get_ezsignsignatures_automatic_v1_with_http_info( + self, + pki_ezsigndocument_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsigndocumentGetEzsignsignaturesAutomaticV1Response]: + """Retrieve an existing Ezsigndocument's automatic Ezsignsignatures - >>> thread = api.ezsigndocument_flatten_v1(pki_ezsigndocument_id, body, async_req=True) - >>> result = thread.get() + Return the Ezsignsignatures that can be signed by the current user at the current step in the process :param pki_ezsigndocument_id: (required) :type pki_ezsigndocument_id: int - :param body: (required) - :type body: object - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsigndocumentFlattenV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsigndocument_flatten_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsigndocument_flatten_v1_with_http_info(pki_ezsigndocument_id, body, **kwargs) # noqa: E501 + """ # noqa: E501 + + _param = self._ezsigndocument_get_ezsignsignatures_automatic_v1_serialize( + pki_ezsigndocument_id=pki_ezsigndocument_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigndocumentGetEzsignsignaturesAutomaticV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - @validate_arguments - def ezsigndocument_flatten_v1_with_http_info(self, pki_ezsigndocument_id : conint(strict=True, ge=0), body : Dict[str, Any], **kwargs) -> ApiResponse: # noqa: E501 - """Flatten # noqa: E501 - Flatten an Ezsigndocument signatures, forms and annotations. This process finalizes the PDF so that the forms and annotations become part of the document content and cannot be edited. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def ezsigndocument_get_ezsignsignatures_automatic_v1_without_preload_content( + self, + pki_ezsigndocument_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve an existing Ezsigndocument's automatic Ezsignsignatures - >>> thread = api.ezsigndocument_flatten_v1_with_http_info(pki_ezsigndocument_id, body, async_req=True) - >>> result = thread.get() + Return the Ezsignsignatures that can be signed by the current user at the current step in the process :param pki_ezsigndocument_id: (required) :type pki_ezsigndocument_id: int - :param body: (required) - :type body: object - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsigndocumentFlattenV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._ezsigndocument_get_ezsignsignatures_automatic_v1_serialize( + pki_ezsigndocument_id=pki_ezsigndocument_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigndocumentGetEzsignsignaturesAutomaticV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _params = locals() - _all_params = [ - 'pki_ezsigndocument_id', - 'body' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' - ] - ) - - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsigndocument_flatten_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + def _ezsigndocument_get_ezsignsignatures_automatic_v1_serialize( + self, + pki_ezsigndocument_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: - _collection_formats = {} + _host = None - # process the path parameters - _path_params = {} - if _params['pki_ezsigndocument_id']: - _path_params['pkiEzsigndocumentID'] = _params['pki_ezsigndocument_id'] + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if pki_ezsigndocument_id is not None: + _path_params['pkiEzsigndocumentID'] = pki_ezsigndocument_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['body'] is not None: - _body_params = _params['body'] + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '200': "EzsigndocumentFlattenV1Response", - '404': "CommonResponseError", - '422': "CommonResponseError", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsigndocument/{pkiEzsigndocumentID}/flatten', 'POST', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/1/object/ezsigndocument/{pkiEzsigndocumentID}/getEzsignsignaturesAutomatic', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) - - @validate_arguments - def ezsigndocument_get_actionable_elements_v1(self, pki_ezsigndocument_id : conint(strict=True, ge=0), **kwargs) -> EzsigndocumentGetActionableElementsV1Response: # noqa: E501 - """Retrieve actionable elements for the Ezsigndocument # noqa: E501 - - Return the Ezsignsignatures that can be signed and Ezsignformfieldgroups that can be filled by the current user at the current step in the process # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + _host=_host, + _request_auth=_request_auth + ) - >>> thread = api.ezsigndocument_get_actionable_elements_v1(pki_ezsigndocument_id, async_req=True) - >>> result = thread.get() - :param pki_ezsigndocument_id: (required) - :type pki_ezsigndocument_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsigndocumentGetActionableElementsV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsigndocument_get_actionable_elements_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsigndocument_get_actionable_elements_v1_with_http_info(pki_ezsigndocument_id, **kwargs) # noqa: E501 - @validate_arguments - def ezsigndocument_get_actionable_elements_v1_with_http_info(self, pki_ezsigndocument_id : conint(strict=True, ge=0), **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve actionable elements for the Ezsigndocument # noqa: E501 - Return the Ezsignsignatures that can be signed and Ezsignformfieldgroups that can be filled by the current user at the current step in the process # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def ezsigndocument_get_ezsignsignatures_v1( + self, + pki_ezsigndocument_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsigndocumentGetEzsignsignaturesV1Response: + """Retrieve an existing Ezsigndocument's Ezsignsignatures - >>> thread = api.ezsigndocument_get_actionable_elements_v1_with_http_info(pki_ezsigndocument_id, async_req=True) - >>> result = thread.get() + :param pki_ezsigndocument_id: (required) :type pki_ezsigndocument_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsigndocumentGetActionableElementsV1Response, status_code(int), headers(HTTPHeaderDict)) - """ - - _params = locals() - - _all_params = [ - 'pki_ezsigndocument_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' - ] - ) - - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsigndocument_get_actionable_elements_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] - - _collection_formats = {} - - # process the path parameters - _path_params = {} - if _params['pki_ezsigndocument_id']: - _path_params['pkiEzsigndocumentID'] = _params['pki_ezsigndocument_id'] - - - # process the query parameters - _query_params = [] - # process the header parameters - _header_params = dict(_params.get('_headers', {})) - # process the form parameters - _form_params = [] - _files = {} - # process the body parameter - _body_params = None - # set the HTTP header `Accept` - _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 - - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 + """ # noqa: E501 + + _param = self._ezsigndocument_get_ezsignsignatures_v1_serialize( + pki_ezsigndocument_id=pki_ezsigndocument_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _response_types_map = { - '200': "EzsigndocumentGetActionableElementsV1Response", + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigndocumentGetEzsignsignaturesV1Response", '404': "CommonResponseError", '422': "CommonResponseError", } - - return self.api_client.call_api( - '/1/object/ezsigndocument/{pkiEzsigndocumentID}/getActionableElements', 'GET', - _path_params, - _query_params, - _header_params, - body=_body_params, - post_params=_form_params, - files=_files, + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, response_types_map=_response_types_map, - auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), - collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) - - @validate_arguments - def ezsigndocument_get_completed_elements_v1(self, pki_ezsigndocument_id : conint(strict=True, ge=0), **kwargs) -> EzsigndocumentGetCompletedElementsV1Response: # noqa: E501 - """Retrieve completed elements for the Ezsigndocument # noqa: E501 - - Return the completed Ezsignsignatures, Ezsignformfieldgroups and Ezsignannotations at the current step in the process # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + ).data + + + @validate_call + def ezsigndocument_get_ezsignsignatures_v1_with_http_info( + self, + pki_ezsigndocument_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsigndocumentGetEzsignsignaturesV1Response]: + """Retrieve an existing Ezsigndocument's Ezsignsignatures - >>> thread = api.ezsigndocument_get_completed_elements_v1(pki_ezsigndocument_id, async_req=True) - >>> result = thread.get() + :param pki_ezsigndocument_id: (required) :type pki_ezsigndocument_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsigndocumentGetCompletedElementsV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsigndocument_get_completed_elements_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsigndocument_get_completed_elements_v1_with_http_info(pki_ezsigndocument_id, **kwargs) # noqa: E501 + """ # noqa: E501 + + _param = self._ezsigndocument_get_ezsignsignatures_v1_serialize( + pki_ezsigndocument_id=pki_ezsigndocument_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigndocumentGetEzsignsignaturesV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - @validate_arguments - def ezsigndocument_get_completed_elements_v1_with_http_info(self, pki_ezsigndocument_id : conint(strict=True, ge=0), **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve completed elements for the Ezsigndocument # noqa: E501 - Return the completed Ezsignsignatures, Ezsignformfieldgroups and Ezsignannotations at the current step in the process # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def ezsigndocument_get_ezsignsignatures_v1_without_preload_content( + self, + pki_ezsigndocument_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve an existing Ezsigndocument's Ezsignsignatures - >>> thread = api.ezsigndocument_get_completed_elements_v1_with_http_info(pki_ezsigndocument_id, async_req=True) - >>> result = thread.get() + :param pki_ezsigndocument_id: (required) :type pki_ezsigndocument_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsigndocumentGetCompletedElementsV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._ezsigndocument_get_ezsignsignatures_v1_serialize( + pki_ezsigndocument_id=pki_ezsigndocument_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigndocumentGetEzsignsignaturesV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _all_params = [ - 'pki_ezsigndocument_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' - ] - ) - - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsigndocument_get_completed_elements_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] - _collection_formats = {} + def _ezsigndocument_get_ezsignsignatures_v1_serialize( + self, + pki_ezsigndocument_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: - # process the path parameters - _path_params = {} - if _params['pki_ezsigndocument_id']: - _path_params['pkiEzsigndocumentID'] = _params['pki_ezsigndocument_id'] + _host = None + + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if pki_ezsigndocument_id is not None: + _path_params['pkiEzsigndocumentID'] = pki_ezsigndocument_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "EzsigndocumentGetCompletedElementsV1Response", - '404': "CommonResponseError", - '422': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsigndocument/{pkiEzsigndocumentID}/getCompletedElements', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/1/object/ezsigndocument/{pkiEzsigndocumentID}/getEzsignsignatures', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) - - @validate_arguments - def ezsigndocument_get_download_url_v1(self, pki_ezsigndocument_id : conint(strict=True, ge=0), e_document_type : Annotated[StrictStr, Field(..., description="The type of document to retrieve. 1. **Initial** Is the initial document before any signature were applied. 2. **SignatureReady** Is the version containing the annotations/form to show the signer. 3. **Signed** Is the final document once all signatures were applied. 4. **Proofdocument** Is the evidence report. 5. **Proof** Is the complete evidence archive including all of the above and more. ")], **kwargs) -> EzsigndocumentGetDownloadUrlV1Response: # noqa: E501 - """Retrieve a URL to download documents. # noqa: E501 - - This endpoint returns URLs to different files that can be downloaded during the signing process. These links will expire after 5 minutes so the download of the file should be made soon after retrieving the link. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + _host=_host, + _request_auth=_request_auth + ) - >>> thread = api.ezsigndocument_get_download_url_v1(pki_ezsigndocument_id, e_document_type, async_req=True) - >>> result = thread.get() - :param pki_ezsigndocument_id: (required) - :type pki_ezsigndocument_id: int - :param e_document_type: The type of document to retrieve. 1. **Initial** Is the initial document before any signature were applied. 2. **SignatureReady** Is the version containing the annotations/form to show the signer. 3. **Signed** Is the final document once all signatures were applied. 4. **Proofdocument** Is the evidence report. 5. **Proof** Is the complete evidence archive including all of the above and more. (required) - :type e_document_type: str - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsigndocumentGetDownloadUrlV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsigndocument_get_download_url_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsigndocument_get_download_url_v1_with_http_info(pki_ezsigndocument_id, e_document_type, **kwargs) # noqa: E501 - @validate_arguments - def ezsigndocument_get_download_url_v1_with_http_info(self, pki_ezsigndocument_id : conint(strict=True, ge=0), e_document_type : Annotated[StrictStr, Field(..., description="The type of document to retrieve. 1. **Initial** Is the initial document before any signature were applied. 2. **SignatureReady** Is the version containing the annotations/form to show the signer. 3. **Signed** Is the final document once all signatures were applied. 4. **Proofdocument** Is the evidence report. 5. **Proof** Is the complete evidence archive including all of the above and more. ")], **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve a URL to download documents. # noqa: E501 - This endpoint returns URLs to different files that can be downloaded during the signing process. These links will expire after 5 minutes so the download of the file should be made soon after retrieving the link. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def ezsigndocument_get_form_data_v1( + self, + pki_ezsigndocument_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsigndocumentGetFormDataV1Response: + """Retrieve an existing Ezsigndocument's Form Data - >>> thread = api.ezsigndocument_get_download_url_v1_with_http_info(pki_ezsigndocument_id, e_document_type, async_req=True) - >>> result = thread.get() + :param pki_ezsigndocument_id: (required) :type pki_ezsigndocument_id: int - :param e_document_type: The type of document to retrieve. 1. **Initial** Is the initial document before any signature were applied. 2. **SignatureReady** Is the version containing the annotations/form to show the signer. 3. **Signed** Is the final document once all signatures were applied. 4. **Proofdocument** Is the evidence report. 5. **Proof** Is the complete evidence archive including all of the above and more. (required) - :type e_document_type: str - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsigndocumentGetDownloadUrlV1Response, status_code(int), headers(HTTPHeaderDict)) - """ - - _params = locals() - - _all_params = [ - 'pki_ezsigndocument_id', - 'e_document_type' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' - ] - ) - - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsigndocument_get_download_url_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] - - _collection_formats = {} - - # process the path parameters - _path_params = {} - if _params['pki_ezsigndocument_id']: - _path_params['pkiEzsigndocumentID'] = _params['pki_ezsigndocument_id'] - - if _params['e_document_type']: - _path_params['eDocumentType'] = _params['e_document_type'] - - - # process the query parameters - _query_params = [] - # process the header parameters - _header_params = dict(_params.get('_headers', {})) - # process the form parameters - _form_params = [] - _files = {} - # process the body parameter - _body_params = None - # set the HTTP header `Accept` - _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 - - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 + """ # noqa: E501 + + _param = self._ezsigndocument_get_form_data_v1_serialize( + pki_ezsigndocument_id=pki_ezsigndocument_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _response_types_map = { - '200': "EzsigndocumentGetDownloadUrlV1Response", + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigndocumentGetFormDataV1Response", '404': "CommonResponseError", + '406': "CommonResponseError", '422': "CommonResponseError", } - - return self.api_client.call_api( - '/1/object/ezsigndocument/{pkiEzsigndocumentID}/getDownloadUrl/{eDocumentType}', 'GET', - _path_params, - _query_params, - _header_params, - body=_body_params, - post_params=_form_params, - files=_files, + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, response_types_map=_response_types_map, - auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), - collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) - - @validate_arguments - def ezsigndocument_get_ezsignannotations_v1(self, pki_ezsigndocument_id : conint(strict=True, ge=0), **kwargs) -> EzsigndocumentGetEzsignannotationsV1Response: # noqa: E501 - """Retrieve an existing Ezsigndocument's Ezsignannotations # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + ).data + + + @validate_call + def ezsigndocument_get_form_data_v1_with_http_info( + self, + pki_ezsigndocument_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsigndocumentGetFormDataV1Response]: + """Retrieve an existing Ezsigndocument's Form Data - >>> thread = api.ezsigndocument_get_ezsignannotations_v1(pki_ezsigndocument_id, async_req=True) - >>> result = thread.get() + :param pki_ezsigndocument_id: (required) :type pki_ezsigndocument_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsigndocumentGetEzsignannotationsV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsigndocument_get_ezsignannotations_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsigndocument_get_ezsignannotations_v1_with_http_info(pki_ezsigndocument_id, **kwargs) # noqa: E501 + """ # noqa: E501 + + _param = self._ezsigndocument_get_form_data_v1_serialize( + pki_ezsigndocument_id=pki_ezsigndocument_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigndocumentGetFormDataV1Response", + '404': "CommonResponseError", + '406': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - @validate_arguments - def ezsigndocument_get_ezsignannotations_v1_with_http_info(self, pki_ezsigndocument_id : conint(strict=True, ge=0), **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve an existing Ezsigndocument's Ezsignannotations # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def ezsigndocument_get_form_data_v1_without_preload_content( + self, + pki_ezsigndocument_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve an existing Ezsigndocument's Form Data - >>> thread = api.ezsigndocument_get_ezsignannotations_v1_with_http_info(pki_ezsigndocument_id, async_req=True) - >>> result = thread.get() + :param pki_ezsigndocument_id: (required) :type pki_ezsigndocument_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsigndocumentGetEzsignannotationsV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._ezsigndocument_get_form_data_v1_serialize( + pki_ezsigndocument_id=pki_ezsigndocument_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigndocumentGetFormDataV1Response", + '404': "CommonResponseError", + '406': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _all_params = [ - 'pki_ezsigndocument_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' - ] - ) - - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsigndocument_get_ezsignannotations_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] - _collection_formats = {} + def _ezsigndocument_get_form_data_v1_serialize( + self, + pki_ezsigndocument_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: - # process the path parameters - _path_params = {} - if _params['pki_ezsigndocument_id']: - _path_params['pkiEzsigndocumentID'] = _params['pki_ezsigndocument_id'] + _host = None + + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if pki_ezsigndocument_id is not None: + _path_params['pkiEzsigndocumentID'] = pki_ezsigndocument_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json', + 'application/zip', + 'text/csv' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "EzsigndocumentGetEzsignannotationsV1Response", - '404': "CommonResponseError", - '422': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsigndocument/{pkiEzsigndocumentID}/getEzsignannotations', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/1/object/ezsigndocument/{pkiEzsigndocumentID}/getFormData', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) - - @validate_arguments - def ezsigndocument_get_ezsignformfieldgroups_v1(self, pki_ezsigndocument_id : conint(strict=True, ge=0), **kwargs) -> EzsigndocumentGetEzsignformfieldgroupsV1Response: # noqa: E501 - """Retrieve an existing Ezsigndocument's Ezsignformfieldgroups # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + _host=_host, + _request_auth=_request_auth + ) - >>> thread = api.ezsigndocument_get_ezsignformfieldgroups_v1(pki_ezsigndocument_id, async_req=True) - >>> result = thread.get() - :param pki_ezsigndocument_id: (required) - :type pki_ezsigndocument_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsigndocumentGetEzsignformfieldgroupsV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsigndocument_get_ezsignformfieldgroups_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsigndocument_get_ezsignformfieldgroups_v1_with_http_info(pki_ezsigndocument_id, **kwargs) # noqa: E501 - @validate_arguments - def ezsigndocument_get_ezsignformfieldgroups_v1_with_http_info(self, pki_ezsigndocument_id : conint(strict=True, ge=0), **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve an existing Ezsigndocument's Ezsignformfieldgroups # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def ezsigndocument_get_object_v1( + self, + pki_ezsigndocument_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsigndocumentGetObjectV1Response: + """(Deprecated) Retrieve an existing Ezsigndocument - >>> thread = api.ezsigndocument_get_ezsignformfieldgroups_v1_with_http_info(pki_ezsigndocument_id, async_req=True) - >>> result = thread.get() :param pki_ezsigndocument_id: (required) :type pki_ezsigndocument_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsigndocumentGetEzsignformfieldgroupsV1Response, status_code(int), headers(HTTPHeaderDict)) - """ - - _params = locals() - - _all_params = [ - 'pki_ezsigndocument_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' - ] - ) - - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsigndocument_get_ezsignformfieldgroups_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] - - _collection_formats = {} - - # process the path parameters - _path_params = {} - if _params['pki_ezsigndocument_id']: - _path_params['pkiEzsigndocumentID'] = _params['pki_ezsigndocument_id'] - - - # process the query parameters - _query_params = [] - # process the header parameters - _header_params = dict(_params.get('_headers', {})) - # process the form parameters - _form_params = [] - _files = {} - # process the body parameter - _body_params = None - # set the HTTP header `Accept` - _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + """ # noqa: E501 + warnings.warn("GET /1/object/ezsigndocument/{pkiEzsigndocumentID} is deprecated.", DeprecationWarning) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 + _param = self._ezsigndocument_get_object_v1_serialize( + pki_ezsigndocument_id=pki_ezsigndocument_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _response_types_map = { - '200': "EzsigndocumentGetEzsignformfieldgroupsV1Response", + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigndocumentGetObjectV1Response", '404': "CommonResponseError", - '422': "CommonResponseError", } - - return self.api_client.call_api( - '/1/object/ezsigndocument/{pkiEzsigndocumentID}/getEzsignformfieldgroups', 'GET', - _path_params, - _query_params, - _header_params, - body=_body_params, - post_params=_form_params, - files=_files, + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, response_types_map=_response_types_map, - auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), - collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + ).data + + + @validate_call + def ezsigndocument_get_object_v1_with_http_info( + self, + pki_ezsigndocument_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsigndocumentGetObjectV1Response]: + """(Deprecated) Retrieve an existing Ezsigndocument - @validate_arguments - def ezsigndocument_get_ezsignpages_v1(self, pki_ezsigndocument_id : conint(strict=True, ge=0), **kwargs) -> EzsigndocumentGetEzsignpagesV1Response: # noqa: E501 - """Retrieve an existing Ezsigndocument's Ezsignpages # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + :param pki_ezsigndocument_id: (required) + :type pki_ezsigndocument_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + warnings.warn("GET /1/object/ezsigndocument/{pkiEzsigndocumentID} is deprecated.", DeprecationWarning) - >>> thread = api.ezsigndocument_get_ezsignpages_v1(pki_ezsigndocument_id, async_req=True) - >>> result = thread.get() + _param = self._ezsigndocument_get_object_v1_serialize( + pki_ezsigndocument_id=pki_ezsigndocument_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - :param pki_ezsigndocument_id: (required) - :type pki_ezsigndocument_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsigndocumentGetEzsignpagesV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsigndocument_get_ezsignpages_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsigndocument_get_ezsignpages_v1_with_http_info(pki_ezsigndocument_id, **kwargs) # noqa: E501 + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigndocumentGetObjectV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - @validate_arguments - def ezsigndocument_get_ezsignpages_v1_with_http_info(self, pki_ezsigndocument_id : conint(strict=True, ge=0), **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve an existing Ezsigndocument's Ezsignpages # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def ezsigndocument_get_object_v1_without_preload_content( + self, + pki_ezsigndocument_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """(Deprecated) Retrieve an existing Ezsigndocument - >>> thread = api.ezsigndocument_get_ezsignpages_v1_with_http_info(pki_ezsigndocument_id, async_req=True) - >>> result = thread.get() :param pki_ezsigndocument_id: (required) :type pki_ezsigndocument_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsigndocumentGetEzsignpagesV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + warnings.warn("GET /1/object/ezsigndocument/{pkiEzsigndocumentID} is deprecated.", DeprecationWarning) - _params = locals() + _param = self._ezsigndocument_get_object_v1_serialize( + pki_ezsigndocument_id=pki_ezsigndocument_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _all_params = [ - 'pki_ezsigndocument_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' - ] - ) - - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsigndocument_get_ezsignpages_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigndocumentGetObjectV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_ezsigndocument_id']: - _path_params['pkiEzsigndocumentID'] = _params['pki_ezsigndocument_id'] + def _ezsigndocument_get_object_v1_serialize( + self, + pki_ezsigndocument_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if pki_ezsigndocument_id is not None: + _path_params['pkiEzsigndocumentID'] = pki_ezsigndocument_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "EzsigndocumentGetEzsignpagesV1Response", - '404': "CommonResponseError", - '422': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsigndocument/{pkiEzsigndocumentID}/getEzsignpages', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/1/object/ezsigndocument/{pkiEzsigndocumentID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) - - @validate_arguments - def ezsigndocument_get_ezsignsignatures_automatic_v1(self, pki_ezsigndocument_id : conint(strict=True, ge=0), **kwargs) -> EzsigndocumentGetEzsignsignaturesAutomaticV1Response: # noqa: E501 - """Retrieve an existing Ezsigndocument's automatic Ezsignsignatures # noqa: E501 - - Return the Ezsignsignatures that can be signed by the current user at the current step in the process # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + _host=_host, + _request_auth=_request_auth + ) - >>> thread = api.ezsigndocument_get_ezsignsignatures_automatic_v1(pki_ezsigndocument_id, async_req=True) - >>> result = thread.get() - :param pki_ezsigndocument_id: (required) - :type pki_ezsigndocument_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsigndocumentGetEzsignsignaturesAutomaticV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsigndocument_get_ezsignsignatures_automatic_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsigndocument_get_ezsignsignatures_automatic_v1_with_http_info(pki_ezsigndocument_id, **kwargs) # noqa: E501 - @validate_arguments - def ezsigndocument_get_ezsignsignatures_automatic_v1_with_http_info(self, pki_ezsigndocument_id : conint(strict=True, ge=0), **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve an existing Ezsigndocument's automatic Ezsignsignatures # noqa: E501 - Return the Ezsignsignatures that can be signed by the current user at the current step in the process # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def ezsigndocument_get_object_v2( + self, + pki_ezsigndocument_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsigndocumentGetObjectV2Response: + """Retrieve an existing Ezsigndocument - >>> thread = api.ezsigndocument_get_ezsignsignatures_automatic_v1_with_http_info(pki_ezsigndocument_id, async_req=True) - >>> result = thread.get() + :param pki_ezsigndocument_id: (required) :type pki_ezsigndocument_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsigndocumentGetEzsignsignaturesAutomaticV1Response, status_code(int), headers(HTTPHeaderDict)) - """ - - _params = locals() - - _all_params = [ - 'pki_ezsigndocument_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' - ] - ) - - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsigndocument_get_ezsignsignatures_automatic_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] - - _collection_formats = {} - - # process the path parameters - _path_params = {} - if _params['pki_ezsigndocument_id']: - _path_params['pkiEzsigndocumentID'] = _params['pki_ezsigndocument_id'] - - - # process the query parameters - _query_params = [] - # process the header parameters - _header_params = dict(_params.get('_headers', {})) - # process the form parameters - _form_params = [] - _files = {} - # process the body parameter - _body_params = None - # set the HTTP header `Accept` - _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 - - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 + """ # noqa: E501 + + _param = self._ezsigndocument_get_object_v2_serialize( + pki_ezsigndocument_id=pki_ezsigndocument_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _response_types_map = { - '200': "EzsigndocumentGetEzsignsignaturesAutomaticV1Response", + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigndocumentGetObjectV2Response", '404': "CommonResponseError", } - - return self.api_client.call_api( - '/1/object/ezsigndocument/{pkiEzsigndocumentID}/getEzsignsignaturesAutomatic', 'GET', - _path_params, - _query_params, - _header_params, - body=_body_params, - post_params=_form_params, - files=_files, + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, response_types_map=_response_types_map, - auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), - collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) - - @validate_arguments - def ezsigndocument_get_ezsignsignatures_v1(self, pki_ezsigndocument_id : conint(strict=True, ge=0), **kwargs) -> EzsigndocumentGetEzsignsignaturesV1Response: # noqa: E501 - """Retrieve an existing Ezsigndocument's Ezsignsignatures # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + ).data + + + @validate_call + def ezsigndocument_get_object_v2_with_http_info( + self, + pki_ezsigndocument_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsigndocumentGetObjectV2Response]: + """Retrieve an existing Ezsigndocument - >>> thread = api.ezsigndocument_get_ezsignsignatures_v1(pki_ezsigndocument_id, async_req=True) - >>> result = thread.get() + :param pki_ezsigndocument_id: (required) :type pki_ezsigndocument_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsigndocumentGetEzsignsignaturesV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsigndocument_get_ezsignsignatures_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsigndocument_get_ezsignsignatures_v1_with_http_info(pki_ezsigndocument_id, **kwargs) # noqa: E501 + """ # noqa: E501 + + _param = self._ezsigndocument_get_object_v2_serialize( + pki_ezsigndocument_id=pki_ezsigndocument_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigndocumentGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - @validate_arguments - def ezsigndocument_get_ezsignsignatures_v1_with_http_info(self, pki_ezsigndocument_id : conint(strict=True, ge=0), **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve an existing Ezsigndocument's Ezsignsignatures # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def ezsigndocument_get_object_v2_without_preload_content( + self, + pki_ezsigndocument_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve an existing Ezsigndocument - >>> thread = api.ezsigndocument_get_ezsignsignatures_v1_with_http_info(pki_ezsigndocument_id, async_req=True) - >>> result = thread.get() + :param pki_ezsigndocument_id: (required) :type pki_ezsigndocument_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsigndocumentGetEzsignsignaturesV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._ezsigndocument_get_object_v2_serialize( + pki_ezsigndocument_id=pki_ezsigndocument_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigndocumentGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _params = locals() - _all_params = [ - 'pki_ezsigndocument_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' - ] - ) - - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsigndocument_get_ezsignsignatures_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + def _ezsigndocument_get_object_v2_serialize( + self, + pki_ezsigndocument_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: - _collection_formats = {} + _host = None - # process the path parameters - _path_params = {} - if _params['pki_ezsigndocument_id']: - _path_params['pkiEzsigndocumentID'] = _params['pki_ezsigndocument_id'] + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if pki_ezsigndocument_id is not None: + _path_params['pkiEzsigndocumentID'] = pki_ezsigndocument_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "EzsigndocumentGetEzsignsignaturesV1Response", - '404': "CommonResponseError", - '422': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsigndocument/{pkiEzsigndocumentID}/getEzsignsignatures', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/2/object/ezsigndocument/{pkiEzsigndocumentID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) - - @validate_arguments - def ezsigndocument_get_form_data_v1(self, pki_ezsigndocument_id : conint(strict=True, ge=0), **kwargs) -> EzsigndocumentGetFormDataV1Response: # noqa: E501 - """Retrieve an existing Ezsigndocument's Form Data # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + _host=_host, + _request_auth=_request_auth + ) - >>> thread = api.ezsigndocument_get_form_data_v1(pki_ezsigndocument_id, async_req=True) - >>> result = thread.get() - :param pki_ezsigndocument_id: (required) - :type pki_ezsigndocument_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsigndocumentGetFormDataV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsigndocument_get_form_data_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsigndocument_get_form_data_v1_with_http_info(pki_ezsigndocument_id, **kwargs) # noqa: E501 - @validate_arguments - def ezsigndocument_get_form_data_v1_with_http_info(self, pki_ezsigndocument_id : conint(strict=True, ge=0), **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve an existing Ezsigndocument's Form Data # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def ezsigndocument_get_temporary_proof_v1( + self, + pki_ezsigndocument_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsigndocumentGetTemporaryProofV1Response: + """Retrieve the temporary proof - >>> thread = api.ezsigndocument_get_form_data_v1_with_http_info(pki_ezsigndocument_id, async_req=True) - >>> result = thread.get() + Retrieve the temporary proof while the Ezsigndocument is being processed since the proof isn't available until the Ezsigndocument is completed :param pki_ezsigndocument_id: (required) :type pki_ezsigndocument_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsigndocumentGetFormDataV1Response, status_code(int), headers(HTTPHeaderDict)) - """ - - _params = locals() - - _all_params = [ - 'pki_ezsigndocument_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' - ] - ) - - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsigndocument_get_form_data_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] - - _collection_formats = {} - - # process the path parameters - _path_params = {} - if _params['pki_ezsigndocument_id']: - _path_params['pkiEzsigndocumentID'] = _params['pki_ezsigndocument_id'] - - - # process the query parameters - _query_params = [] - # process the header parameters - _header_params = dict(_params.get('_headers', {})) - # process the form parameters - _form_params = [] - _files = {} - # process the body parameter - _body_params = None - # set the HTTP header `Accept` - _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json', 'application/zip', 'text/csv']) # noqa: E501 - - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 + """ # noqa: E501 + + _param = self._ezsigndocument_get_temporary_proof_v1_serialize( + pki_ezsigndocument_id=pki_ezsigndocument_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _response_types_map = { - '200': "EzsigndocumentGetFormDataV1Response", + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigndocumentGetTemporaryProofV1Response", '404': "CommonResponseError", - '406': "CommonResponseError", '422': "CommonResponseError", } - - return self.api_client.call_api( - '/1/object/ezsigndocument/{pkiEzsigndocumentID}/getFormData', 'GET', - _path_params, - _query_params, - _header_params, - body=_body_params, - post_params=_form_params, - files=_files, + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, response_types_map=_response_types_map, - auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), - collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) - - @validate_arguments - def ezsigndocument_get_object_v1(self, pki_ezsigndocument_id : conint(strict=True, ge=0), **kwargs) -> EzsigndocumentGetObjectV1Response: # noqa: E501 - """(Deprecated) Retrieve an existing Ezsigndocument # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + ).data + + + @validate_call + def ezsigndocument_get_temporary_proof_v1_with_http_info( + self, + pki_ezsigndocument_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsigndocumentGetTemporaryProofV1Response]: + """Retrieve the temporary proof - >>> thread = api.ezsigndocument_get_object_v1(pki_ezsigndocument_id, async_req=True) - >>> result = thread.get() + Retrieve the temporary proof while the Ezsigndocument is being processed since the proof isn't available until the Ezsigndocument is completed :param pki_ezsigndocument_id: (required) :type pki_ezsigndocument_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsigndocumentGetObjectV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsigndocument_get_object_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsigndocument_get_object_v1_with_http_info(pki_ezsigndocument_id, **kwargs) # noqa: E501 + """ # noqa: E501 + + _param = self._ezsigndocument_get_temporary_proof_v1_serialize( + pki_ezsigndocument_id=pki_ezsigndocument_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigndocumentGetTemporaryProofV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - @validate_arguments - def ezsigndocument_get_object_v1_with_http_info(self, pki_ezsigndocument_id : conint(strict=True, ge=0), **kwargs) -> ApiResponse: # noqa: E501 - """(Deprecated) Retrieve an existing Ezsigndocument # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def ezsigndocument_get_temporary_proof_v1_without_preload_content( + self, + pki_ezsigndocument_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve the temporary proof - >>> thread = api.ezsigndocument_get_object_v1_with_http_info(pki_ezsigndocument_id, async_req=True) - >>> result = thread.get() + Retrieve the temporary proof while the Ezsigndocument is being processed since the proof isn't available until the Ezsigndocument is completed :param pki_ezsigndocument_id: (required) :type pki_ezsigndocument_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsigndocumentGetObjectV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._ezsigndocument_get_temporary_proof_v1_serialize( + pki_ezsigndocument_id=pki_ezsigndocument_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - warnings.warn("GET /1/object/ezsigndocument/{pkiEzsigndocumentID} is deprecated.", DeprecationWarning) + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigndocumentGetTemporaryProofV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _params = locals() - _all_params = [ - 'pki_ezsigndocument_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' - ] - ) - - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsigndocument_get_object_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + def _ezsigndocument_get_temporary_proof_v1_serialize( + self, + pki_ezsigndocument_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: - _collection_formats = {} + _host = None - # process the path parameters - _path_params = {} - if _params['pki_ezsigndocument_id']: - _path_params['pkiEzsigndocumentID'] = _params['pki_ezsigndocument_id'] + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if pki_ezsigndocument_id is not None: + _path_params['pkiEzsigndocumentID'] = pki_ezsigndocument_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "EzsigndocumentGetObjectV1Response", - '404': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsigndocument/{pkiEzsigndocumentID}', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/1/object/ezsigndocument/{pkiEzsigndocumentID}/getTemporaryProof', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) - - @validate_arguments - def ezsigndocument_get_object_v2(self, pki_ezsigndocument_id : conint(strict=True, ge=0), **kwargs) -> EzsigndocumentGetObjectV2Response: # noqa: E501 - """Retrieve an existing Ezsigndocument # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + _host=_host, + _request_auth=_request_auth + ) - >>> thread = api.ezsigndocument_get_object_v2(pki_ezsigndocument_id, async_req=True) - >>> result = thread.get() - :param pki_ezsigndocument_id: (required) - :type pki_ezsigndocument_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsigndocumentGetObjectV2Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsigndocument_get_object_v2_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsigndocument_get_object_v2_with_http_info(pki_ezsigndocument_id, **kwargs) # noqa: E501 - @validate_arguments - def ezsigndocument_get_object_v2_with_http_info(self, pki_ezsigndocument_id : conint(strict=True, ge=0), **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve an existing Ezsigndocument # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def ezsigndocument_get_words_positions_v1( + self, + pki_ezsigndocument_id: Annotated[int, Field(strict=True, ge=0)], + ezsigndocument_get_words_positions_v1_request: EzsigndocumentGetWordsPositionsV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsigndocumentGetWordsPositionsV1Response: + """Retrieve positions X,Y of given words from a Ezsigndocument - >>> thread = api.ezsigndocument_get_object_v2_with_http_info(pki_ezsigndocument_id, async_req=True) - >>> result = thread.get() + :param pki_ezsigndocument_id: (required) :type pki_ezsigndocument_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional + :param ezsigndocument_get_words_positions_v1_request: (required) + :type ezsigndocument_get_words_positions_v1_request: EzsigndocumentGetWordsPositionsV1Request :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsigndocumentGetObjectV2Response, status_code(int), headers(HTTPHeaderDict)) - """ - - _params = locals() - - _all_params = [ - 'pki_ezsigndocument_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' - ] - ) - - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsigndocument_get_object_v2" % _key - ) - _params[_key] = _val - del _params['kwargs'] - - _collection_formats = {} - - # process the path parameters - _path_params = {} - if _params['pki_ezsigndocument_id']: - _path_params['pkiEzsigndocumentID'] = _params['pki_ezsigndocument_id'] - - - # process the query parameters - _query_params = [] - # process the header parameters - _header_params = dict(_params.get('_headers', {})) - # process the form parameters - _form_params = [] - _files = {} - # process the body parameter - _body_params = None - # set the HTTP header `Accept` - _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 - - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 + """ # noqa: E501 + + _param = self._ezsigndocument_get_words_positions_v1_serialize( + pki_ezsigndocument_id=pki_ezsigndocument_id, + ezsigndocument_get_words_positions_v1_request=ezsigndocument_get_words_positions_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _response_types_map = { - '200': "EzsigndocumentGetObjectV2Response", + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigndocumentGetWordsPositionsV1Response", '404': "CommonResponseError", + '422': "CommonResponseError", } - - return self.api_client.call_api( - '/2/object/ezsigndocument/{pkiEzsigndocumentID}', 'GET', - _path_params, - _query_params, - _header_params, - body=_body_params, - post_params=_form_params, - files=_files, + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, response_types_map=_response_types_map, - auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), - collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) - - @validate_arguments - def ezsigndocument_get_temporary_proof_v1(self, pki_ezsigndocument_id : conint(strict=True, ge=0), **kwargs) -> EzsigndocumentGetTemporaryProofV1Response: # noqa: E501 - """Retrieve the temporary proof # noqa: E501 - - Retrieve the temporary proof while the Ezsigndocument is being processed since the proof isn't available until the Ezsigndocument is completed # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + ).data + + + @validate_call + def ezsigndocument_get_words_positions_v1_with_http_info( + self, + pki_ezsigndocument_id: Annotated[int, Field(strict=True, ge=0)], + ezsigndocument_get_words_positions_v1_request: EzsigndocumentGetWordsPositionsV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsigndocumentGetWordsPositionsV1Response]: + """Retrieve positions X,Y of given words from a Ezsigndocument - >>> thread = api.ezsigndocument_get_temporary_proof_v1(pki_ezsigndocument_id, async_req=True) - >>> result = thread.get() + :param pki_ezsigndocument_id: (required) :type pki_ezsigndocument_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param ezsigndocument_get_words_positions_v1_request: (required) + :type ezsigndocument_get_words_positions_v1_request: EzsigndocumentGetWordsPositionsV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsigndocumentGetTemporaryProofV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsigndocument_get_temporary_proof_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsigndocument_get_temporary_proof_v1_with_http_info(pki_ezsigndocument_id, **kwargs) # noqa: E501 + """ # noqa: E501 + + _param = self._ezsigndocument_get_words_positions_v1_serialize( + pki_ezsigndocument_id=pki_ezsigndocument_id, + ezsigndocument_get_words_positions_v1_request=ezsigndocument_get_words_positions_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigndocumentGetWordsPositionsV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - @validate_arguments - def ezsigndocument_get_temporary_proof_v1_with_http_info(self, pki_ezsigndocument_id : conint(strict=True, ge=0), **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve the temporary proof # noqa: E501 - Retrieve the temporary proof while the Ezsigndocument is being processed since the proof isn't available until the Ezsigndocument is completed # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def ezsigndocument_get_words_positions_v1_without_preload_content( + self, + pki_ezsigndocument_id: Annotated[int, Field(strict=True, ge=0)], + ezsigndocument_get_words_positions_v1_request: EzsigndocumentGetWordsPositionsV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve positions X,Y of given words from a Ezsigndocument - >>> thread = api.ezsigndocument_get_temporary_proof_v1_with_http_info(pki_ezsigndocument_id, async_req=True) - >>> result = thread.get() + :param pki_ezsigndocument_id: (required) :type pki_ezsigndocument_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional + :param ezsigndocument_get_words_positions_v1_request: (required) + :type ezsigndocument_get_words_positions_v1_request: EzsigndocumentGetWordsPositionsV1Request :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsigndocumentGetTemporaryProofV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._ezsigndocument_get_words_positions_v1_serialize( + pki_ezsigndocument_id=pki_ezsigndocument_id, + ezsigndocument_get_words_positions_v1_request=ezsigndocument_get_words_positions_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigndocumentGetWordsPositionsV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _params = locals() - _all_params = [ - 'pki_ezsigndocument_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' - ] - ) - - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsigndocument_get_temporary_proof_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + def _ezsigndocument_get_words_positions_v1_serialize( + self, + pki_ezsigndocument_id, + ezsigndocument_get_words_positions_v1_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: - _collection_formats = {} + _host = None - # process the path parameters - _path_params = {} - if _params['pki_ezsigndocument_id']: - _path_params['pkiEzsigndocumentID'] = _params['pki_ezsigndocument_id'] + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if pki_ezsigndocument_id is not None: + _path_params['pkiEzsigndocumentID'] = pki_ezsigndocument_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + if ezsigndocument_get_words_positions_v1_request is not None: + _body_params = ezsigndocument_get_words_positions_v1_request + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type - _response_types_map = { - '200': "EzsigndocumentGetTemporaryProofV1Response", - '404': "CommonResponseError", - '422': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsigndocument/{pkiEzsigndocumentID}/getTemporaryProof', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='POST', + resource_path='/1/object/ezsigndocument/{pkiEzsigndocumentID}/getWordsPositions', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) - - @validate_arguments - def ezsigndocument_get_words_positions_v1(self, pki_ezsigndocument_id : conint(strict=True, ge=0), ezsigndocument_get_words_positions_v1_request : EzsigndocumentGetWordsPositionsV1Request, **kwargs) -> EzsigndocumentGetWordsPositionsV1Response: # noqa: E501 - """Retrieve positions X,Y of given words from a Ezsigndocument # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + _host=_host, + _request_auth=_request_auth + ) - >>> thread = api.ezsigndocument_get_words_positions_v1(pki_ezsigndocument_id, ezsigndocument_get_words_positions_v1_request, async_req=True) - >>> result = thread.get() - :param pki_ezsigndocument_id: (required) - :type pki_ezsigndocument_id: int - :param ezsigndocument_get_words_positions_v1_request: (required) - :type ezsigndocument_get_words_positions_v1_request: EzsigndocumentGetWordsPositionsV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsigndocumentGetWordsPositionsV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsigndocument_get_words_positions_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsigndocument_get_words_positions_v1_with_http_info(pki_ezsigndocument_id, ezsigndocument_get_words_positions_v1_request, **kwargs) # noqa: E501 - @validate_arguments - def ezsigndocument_get_words_positions_v1_with_http_info(self, pki_ezsigndocument_id : conint(strict=True, ge=0), ezsigndocument_get_words_positions_v1_request : EzsigndocumentGetWordsPositionsV1Request, **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve positions X,Y of given words from a Ezsigndocument # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def ezsigndocument_patch_object_v1( + self, + pki_ezsigndocument_id: Annotated[int, Field(strict=True, ge=0)], + ezsigndocument_patch_object_v1_request: EzsigndocumentPatchObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsigndocumentPatchObjectV1Response: + """Patch an existing Ezsigndocument - >>> thread = api.ezsigndocument_get_words_positions_v1_with_http_info(pki_ezsigndocument_id, ezsigndocument_get_words_positions_v1_request, async_req=True) - >>> result = thread.get() + :param pki_ezsigndocument_id: (required) :type pki_ezsigndocument_id: int - :param ezsigndocument_get_words_positions_v1_request: (required) - :type ezsigndocument_get_words_positions_v1_request: EzsigndocumentGetWordsPositionsV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional + :param ezsigndocument_patch_object_v1_request: (required) + :type ezsigndocument_patch_object_v1_request: EzsigndocumentPatchObjectV1Request :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsigndocumentGetWordsPositionsV1Response, status_code(int), headers(HTTPHeaderDict)) - """ - - _params = locals() - - _all_params = [ - 'pki_ezsigndocument_id', - 'ezsigndocument_get_words_positions_v1_request' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' - ] - ) - - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsigndocument_get_words_positions_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] - - _collection_formats = {} - - # process the path parameters - _path_params = {} - if _params['pki_ezsigndocument_id']: - _path_params['pkiEzsigndocumentID'] = _params['pki_ezsigndocument_id'] - - - # process the query parameters - _query_params = [] - # process the header parameters - _header_params = dict(_params.get('_headers', {})) - # process the form parameters - _form_params = [] - _files = {} - # process the body parameter - _body_params = None - if _params['ezsigndocument_get_words_positions_v1_request'] is not None: - _body_params = _params['ezsigndocument_get_words_positions_v1_request'] - - # set the HTTP header `Accept` - _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 - - # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list - - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 + """ # noqa: E501 + + _param = self._ezsigndocument_patch_object_v1_serialize( + pki_ezsigndocument_id=pki_ezsigndocument_id, + ezsigndocument_patch_object_v1_request=ezsigndocument_patch_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _response_types_map = { - '200': "EzsigndocumentGetWordsPositionsV1Response", + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigndocumentPatchObjectV1Response", '404': "CommonResponseError", '422': "CommonResponseError", } - - return self.api_client.call_api( - '/1/object/ezsigndocument/{pkiEzsigndocumentID}/getWordsPositions', 'POST', - _path_params, - _query_params, - _header_params, - body=_body_params, - post_params=_form_params, - files=_files, + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, response_types_map=_response_types_map, - auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), - collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) - - @validate_arguments - def ezsigndocument_patch_object_v1(self, pki_ezsigndocument_id : conint(strict=True, ge=0), ezsigndocument_patch_object_v1_request : EzsigndocumentPatchObjectV1Request, **kwargs) -> EzsigndocumentPatchObjectV1Response: # noqa: E501 - """Patch an existing Ezsigndocument # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + ).data + + + @validate_call + def ezsigndocument_patch_object_v1_with_http_info( + self, + pki_ezsigndocument_id: Annotated[int, Field(strict=True, ge=0)], + ezsigndocument_patch_object_v1_request: EzsigndocumentPatchObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsigndocumentPatchObjectV1Response]: + """Patch an existing Ezsigndocument - >>> thread = api.ezsigndocument_patch_object_v1(pki_ezsigndocument_id, ezsigndocument_patch_object_v1_request, async_req=True) - >>> result = thread.get() + :param pki_ezsigndocument_id: (required) :type pki_ezsigndocument_id: int :param ezsigndocument_patch_object_v1_request: (required) :type ezsigndocument_patch_object_v1_request: EzsigndocumentPatchObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsigndocumentPatchObjectV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsigndocument_patch_object_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsigndocument_patch_object_v1_with_http_info(pki_ezsigndocument_id, ezsigndocument_patch_object_v1_request, **kwargs) # noqa: E501 + """ # noqa: E501 + + _param = self._ezsigndocument_patch_object_v1_serialize( + pki_ezsigndocument_id=pki_ezsigndocument_id, + ezsigndocument_patch_object_v1_request=ezsigndocument_patch_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigndocumentPatchObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - @validate_arguments - def ezsigndocument_patch_object_v1_with_http_info(self, pki_ezsigndocument_id : conint(strict=True, ge=0), ezsigndocument_patch_object_v1_request : EzsigndocumentPatchObjectV1Request, **kwargs) -> ApiResponse: # noqa: E501 - """Patch an existing Ezsigndocument # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def ezsigndocument_patch_object_v1_without_preload_content( + self, + pki_ezsigndocument_id: Annotated[int, Field(strict=True, ge=0)], + ezsigndocument_patch_object_v1_request: EzsigndocumentPatchObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Patch an existing Ezsigndocument - >>> thread = api.ezsigndocument_patch_object_v1_with_http_info(pki_ezsigndocument_id, ezsigndocument_patch_object_v1_request, async_req=True) - >>> result = thread.get() + :param pki_ezsigndocument_id: (required) :type pki_ezsigndocument_id: int :param ezsigndocument_patch_object_v1_request: (required) :type ezsigndocument_patch_object_v1_request: EzsigndocumentPatchObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsigndocumentPatchObjectV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._ezsigndocument_patch_object_v1_serialize( + pki_ezsigndocument_id=pki_ezsigndocument_id, + ezsigndocument_patch_object_v1_request=ezsigndocument_patch_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigndocumentPatchObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _params = locals() - _all_params = [ - 'pki_ezsigndocument_id', - 'ezsigndocument_patch_object_v1_request' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' - ] - ) - - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsigndocument_patch_object_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + def _ezsigndocument_patch_object_v1_serialize( + self, + pki_ezsigndocument_id, + ezsigndocument_patch_object_v1_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: - _collection_formats = {} + _host = None - # process the path parameters - _path_params = {} - if _params['pki_ezsigndocument_id']: - _path_params['pkiEzsigndocumentID'] = _params['pki_ezsigndocument_id'] + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if pki_ezsigndocument_id is not None: + _path_params['pkiEzsigndocumentID'] = pki_ezsigndocument_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['ezsigndocument_patch_object_v1_request'] is not None: - _body_params = _params['ezsigndocument_patch_object_v1_request'] + if ezsigndocument_patch_object_v1_request is not None: + _body_params = ezsigndocument_patch_object_v1_request + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '200': "EzsigndocumentPatchObjectV1Response", - '404': "CommonResponseError", - '422': "CommonResponseError", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsigndocument/{pkiEzsigndocumentID}', 'PATCH', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='PATCH', + resource_path='/1/object/ezsigndocument/{pkiEzsigndocumentID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) - @validate_arguments - def ezsigndocument_submit_ezsignform_v1(self, pki_ezsigndocument_id : conint(strict=True, ge=0), ezsigndocument_submit_ezsignform_v1_request : EzsigndocumentSubmitEzsignformV1Request, **kwargs) -> EzsigndocumentSubmitEzsignformV1Response: # noqa: E501 - """Submit the Ezsignform # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.ezsigndocument_submit_ezsignform_v1(pki_ezsigndocument_id, ezsigndocument_submit_ezsignform_v1_request, async_req=True) - >>> result = thread.get() + + @validate_call + def ezsigndocument_submit_ezsignform_v1( + self, + pki_ezsigndocument_id: Annotated[int, Field(strict=True, ge=0)], + ezsigndocument_submit_ezsignform_v1_request: EzsigndocumentSubmitEzsignformV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsigndocumentSubmitEzsignformV1Response: + """Submit the Ezsignform + + + + :param pki_ezsigndocument_id: (required) + :type pki_ezsigndocument_id: int + :param ezsigndocument_submit_ezsignform_v1_request: (required) + :type ezsigndocument_submit_ezsignform_v1_request: EzsigndocumentSubmitEzsignformV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsigndocument_submit_ezsignform_v1_serialize( + pki_ezsigndocument_id=pki_ezsigndocument_id, + ezsigndocument_submit_ezsignform_v1_request=ezsigndocument_submit_ezsignform_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigndocumentSubmitEzsignformV1Response", + '404': "CommonResponseError", + '422': "CommonResponseErrorEzsignformValidation", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsigndocument_submit_ezsignform_v1_with_http_info( + self, + pki_ezsigndocument_id: Annotated[int, Field(strict=True, ge=0)], + ezsigndocument_submit_ezsignform_v1_request: EzsigndocumentSubmitEzsignformV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsigndocumentSubmitEzsignformV1Response]: + """Submit the Ezsignform + + :param pki_ezsigndocument_id: (required) :type pki_ezsigndocument_id: int :param ezsigndocument_submit_ezsignform_v1_request: (required) :type ezsigndocument_submit_ezsignform_v1_request: EzsigndocumentSubmitEzsignformV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsigndocumentSubmitEzsignformV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsigndocument_submit_ezsignform_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsigndocument_submit_ezsignform_v1_with_http_info(pki_ezsigndocument_id, ezsigndocument_submit_ezsignform_v1_request, **kwargs) # noqa: E501 + """ # noqa: E501 + + _param = self._ezsigndocument_submit_ezsignform_v1_serialize( + pki_ezsigndocument_id=pki_ezsigndocument_id, + ezsigndocument_submit_ezsignform_v1_request=ezsigndocument_submit_ezsignform_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigndocumentSubmitEzsignformV1Response", + '404': "CommonResponseError", + '422': "CommonResponseErrorEzsignformValidation", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - @validate_arguments - def ezsigndocument_submit_ezsignform_v1_with_http_info(self, pki_ezsigndocument_id : conint(strict=True, ge=0), ezsigndocument_submit_ezsignform_v1_request : EzsigndocumentSubmitEzsignformV1Request, **kwargs) -> ApiResponse: # noqa: E501 - """Submit the Ezsignform # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def ezsigndocument_submit_ezsignform_v1_without_preload_content( + self, + pki_ezsigndocument_id: Annotated[int, Field(strict=True, ge=0)], + ezsigndocument_submit_ezsignform_v1_request: EzsigndocumentSubmitEzsignformV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Submit the Ezsignform - >>> thread = api.ezsigndocument_submit_ezsignform_v1_with_http_info(pki_ezsigndocument_id, ezsigndocument_submit_ezsignform_v1_request, async_req=True) - >>> result = thread.get() + :param pki_ezsigndocument_id: (required) :type pki_ezsigndocument_id: int :param ezsigndocument_submit_ezsignform_v1_request: (required) :type ezsigndocument_submit_ezsignform_v1_request: EzsigndocumentSubmitEzsignformV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsigndocumentSubmitEzsignformV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._ezsigndocument_submit_ezsignform_v1_serialize( + pki_ezsigndocument_id=pki_ezsigndocument_id, + ezsigndocument_submit_ezsignform_v1_request=ezsigndocument_submit_ezsignform_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigndocumentSubmitEzsignformV1Response", + '404': "CommonResponseError", + '422': "CommonResponseErrorEzsignformValidation", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _all_params = [ - 'pki_ezsigndocument_id', - 'ezsigndocument_submit_ezsignform_v1_request' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' - ] - ) - - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsigndocument_submit_ezsignform_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] - _collection_formats = {} + def _ezsigndocument_submit_ezsignform_v1_serialize( + self, + pki_ezsigndocument_id, + ezsigndocument_submit_ezsignform_v1_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: - # process the path parameters - _path_params = {} - if _params['pki_ezsigndocument_id']: - _path_params['pkiEzsigndocumentID'] = _params['pki_ezsigndocument_id'] + _host = None + + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if pki_ezsigndocument_id is not None: + _path_params['pkiEzsigndocumentID'] = pki_ezsigndocument_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['ezsigndocument_submit_ezsignform_v1_request'] is not None: - _body_params = _params['ezsigndocument_submit_ezsignform_v1_request'] + if ezsigndocument_submit_ezsignform_v1_request is not None: + _body_params = ezsigndocument_submit_ezsignform_v1_request + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '200': "EzsigndocumentSubmitEzsignformV1Response", - '404': "CommonResponseError", - '422': "CommonResponseErrorEzsignformValidation", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsigndocument/{pkiEzsigndocumentID}/submitEzsignform', 'POST', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='POST', + resource_path='/1/object/ezsigndocument/{pkiEzsigndocumentID}/submitEzsignform', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def ezsigndocument_unsend_v1( + self, + pki_ezsigndocument_id: Annotated[int, Field(strict=True, ge=0)], + body: Dict[str, Any], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsigndocumentUnsendV1Response: + """Unsend the Ezsigndocument - @validate_arguments - def ezsigndocument_unsend_v1(self, pki_ezsigndocument_id : conint(strict=True, ge=0), body : Dict[str, Any], **kwargs) -> EzsigndocumentUnsendV1Response: # noqa: E501 - """Unsend the Ezsigndocument # noqa: E501 + Once an Ezsigndocument has been sent to signatories, it cannot be modified. Using this endpoint, you can unsend the Ezsigndocument and make it modifiable again. Signatories will receive an email informing them the signature process was aborted and they might receive a new invitation to sign. ⚠️ Warning: Any signature previously made by signatories on this Ezsigndocumentswill be lost. - Once an Ezsigndocument has been sent to signatories, it cannot be modified. Using this endpoint, you can unsend the Ezsigndocument and make it modifiable again. Signatories will receive an email informing them the signature process was aborted and they might receive a new invitation to sign. ⚠️ Warning: Any signature previously made by signatories on this Ezsigndocumentswill be lost. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + :param pki_ezsigndocument_id: (required) + :type pki_ezsigndocument_id: int + :param body: (required) + :type body: object + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsigndocument_unsend_v1_serialize( + pki_ezsigndocument_id=pki_ezsigndocument_id, + body=body, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigndocumentUnsendV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsigndocument_unsend_v1_with_http_info( + self, + pki_ezsigndocument_id: Annotated[int, Field(strict=True, ge=0)], + body: Dict[str, Any], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsigndocumentUnsendV1Response]: + """Unsend the Ezsigndocument - >>> thread = api.ezsigndocument_unsend_v1(pki_ezsigndocument_id, body, async_req=True) - >>> result = thread.get() + Once an Ezsigndocument has been sent to signatories, it cannot be modified. Using this endpoint, you can unsend the Ezsigndocument and make it modifiable again. Signatories will receive an email informing them the signature process was aborted and they might receive a new invitation to sign. ⚠️ Warning: Any signature previously made by signatories on this Ezsigndocumentswill be lost. :param pki_ezsigndocument_id: (required) :type pki_ezsigndocument_id: int :param body: (required) :type body: object - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsigndocumentUnsendV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsigndocument_unsend_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsigndocument_unsend_v1_with_http_info(pki_ezsigndocument_id, body, **kwargs) # noqa: E501 + """ # noqa: E501 + + _param = self._ezsigndocument_unsend_v1_serialize( + pki_ezsigndocument_id=pki_ezsigndocument_id, + body=body, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigndocumentUnsendV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - @validate_arguments - def ezsigndocument_unsend_v1_with_http_info(self, pki_ezsigndocument_id : conint(strict=True, ge=0), body : Dict[str, Any], **kwargs) -> ApiResponse: # noqa: E501 - """Unsend the Ezsigndocument # noqa: E501 - Once an Ezsigndocument has been sent to signatories, it cannot be modified. Using this endpoint, you can unsend the Ezsigndocument and make it modifiable again. Signatories will receive an email informing them the signature process was aborted and they might receive a new invitation to sign. ⚠️ Warning: Any signature previously made by signatories on this Ezsigndocumentswill be lost. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def ezsigndocument_unsend_v1_without_preload_content( + self, + pki_ezsigndocument_id: Annotated[int, Field(strict=True, ge=0)], + body: Dict[str, Any], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Unsend the Ezsigndocument - >>> thread = api.ezsigndocument_unsend_v1_with_http_info(pki_ezsigndocument_id, body, async_req=True) - >>> result = thread.get() + Once an Ezsigndocument has been sent to signatories, it cannot be modified. Using this endpoint, you can unsend the Ezsigndocument and make it modifiable again. Signatories will receive an email informing them the signature process was aborted and they might receive a new invitation to sign. ⚠️ Warning: Any signature previously made by signatories on this Ezsigndocumentswill be lost. :param pki_ezsigndocument_id: (required) :type pki_ezsigndocument_id: int :param body: (required) :type body: object - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsigndocumentUnsendV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._ezsigndocument_unsend_v1_serialize( + pki_ezsigndocument_id=pki_ezsigndocument_id, + body=body, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigndocumentUnsendV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _params = locals() - _all_params = [ - 'pki_ezsigndocument_id', - 'body' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' - ] - ) - - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsigndocument_unsend_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + def _ezsigndocument_unsend_v1_serialize( + self, + pki_ezsigndocument_id, + body, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: - _collection_formats = {} + _host = None - # process the path parameters - _path_params = {} - if _params['pki_ezsigndocument_id']: - _path_params['pkiEzsigndocumentID'] = _params['pki_ezsigndocument_id'] + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if pki_ezsigndocument_id is not None: + _path_params['pkiEzsigndocumentID'] = pki_ezsigndocument_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['body'] is not None: - _body_params = _params['body'] + if body is not None: + _body_params = body + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '200': "EzsigndocumentUnsendV1Response", - '404': "CommonResponseError", - '422': "CommonResponseError", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsigndocument/{pkiEzsigndocumentID}/unsend', 'POST', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='POST', + resource_path='/1/object/ezsigndocument/{pkiEzsigndocumentID}/unsend', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/eZmaxApi/api/object_ezsignfolder_api.py b/eZmaxApi/api/object_ezsignfolder_api.py index 551fa3a74..792c92c74 100644 --- a/eZmaxApi/api/object_ezsignfolder_api.py +++ b/eZmaxApi/api/object_ezsignfolder_api.py @@ -13,16 +13,22 @@ """ # noqa: E501 -import re # noqa: F401 import io import warnings -from pydantic import validate_arguments, ValidationError +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Dict, List, Optional, Tuple, Union, Any +try: + from typing import Annotated +except ImportError: + from typing_extensions import Annotated + +from pydantic import Field from typing_extensions import Annotated -from pydantic import Field, StrictStr, conint, conlist +from pydantic import StrictStr, field_validator -from typing import Any, Dict, Optional, Union +from typing import Any, Dict, List, Optional, Union from eZmaxApi.models.ezsignfolder_archive_v1_response import EzsignfolderArchiveV1Response from eZmaxApi.models.ezsignfolder_batch_download_v1_request import EzsignfolderBatchDownloadV1Request @@ -37,6 +43,8 @@ from eZmaxApi.models.ezsignfolder_edit_object_v1_request import EzsignfolderEditObjectV1Request from eZmaxApi.models.ezsignfolder_edit_object_v1_response import EzsignfolderEditObjectV1Response from eZmaxApi.models.ezsignfolder_get_actionable_elements_v1_response import EzsignfolderGetActionableElementsV1Response +from eZmaxApi.models.ezsignfolder_get_attachment_count_v1_response import EzsignfolderGetAttachmentCountV1Response +from eZmaxApi.models.ezsignfolder_get_attachments_v1_response import EzsignfolderGetAttachmentsV1Response from eZmaxApi.models.ezsignfolder_get_communication_count_v1_response import EzsignfolderGetCommunicationCountV1Response from eZmaxApi.models.ezsignfolder_get_communication_list_v1_response import EzsignfolderGetCommunicationListV1Response from eZmaxApi.models.ezsignfolder_get_communicationrecipients_v1_response import EzsignfolderGetCommunicationrecipientsV1Response @@ -65,10 +73,7 @@ from eZmaxApi.api_client import ApiClient from eZmaxApi.api_response import ApiResponse -from eZmaxApi.exceptions import ( # noqa: F401 - ApiTypeError, - ApiValueError -) +from eZmaxApi.rest import RESTResponseType class ObjectEzsignfolderApi: @@ -83,4043 +88,8038 @@ def __init__(self, api_client=None) -> None: api_client = ApiClient.get_default() self.api_client = api_client - @validate_arguments - def ezsignfolder_archive_v1(self, pki_ezsignfolder_id : conint(strict=True, ge=0), body : Dict[str, Any], **kwargs) -> EzsignfolderArchiveV1Response: # noqa: E501 - """Archive the Ezsignfolder # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def ezsignfolder_archive_v1( + self, + pki_ezsignfolder_id: Annotated[int, Field(strict=True, ge=0)], + body: Dict[str, Any], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsignfolderArchiveV1Response: + """Archive the Ezsignfolder - >>> thread = api.ezsignfolder_archive_v1(pki_ezsignfolder_id, body, async_req=True) - >>> result = thread.get() + :param pki_ezsignfolder_id: (required) :type pki_ezsignfolder_id: int :param body: (required) :type body: object - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsignfolderArchiveV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsignfolder_archive_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsignfolder_archive_v1_with_http_info(pki_ezsignfolder_id, body, **kwargs) # noqa: E501 - - @validate_arguments - def ezsignfolder_archive_v1_with_http_info(self, pki_ezsignfolder_id : conint(strict=True, ge=0), body : Dict[str, Any], **kwargs) -> ApiResponse: # noqa: E501 - """Archive the Ezsignfolder # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsignfolder_archive_v1_with_http_info(pki_ezsignfolder_id, body, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._ezsignfolder_archive_v1_serialize( + pki_ezsignfolder_id=pki_ezsignfolder_id, + body=body, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfolderArchiveV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsignfolder_archive_v1_with_http_info( + self, + pki_ezsignfolder_id: Annotated[int, Field(strict=True, ge=0)], + body: Dict[str, Any], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsignfolderArchiveV1Response]: + """Archive the Ezsignfolder + + :param pki_ezsignfolder_id: (required) :type pki_ezsignfolder_id: int :param body: (required) :type body: object - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsignfolderArchiveV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._ezsignfolder_archive_v1_serialize( + pki_ezsignfolder_id=pki_ezsignfolder_id, + body=body, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfolderArchiveV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _params = locals() - _all_params = [ - 'pki_ezsignfolder_id', - 'body' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + @validate_call + def ezsignfolder_archive_v1_without_preload_content( + self, + pki_ezsignfolder_id: Annotated[int, Field(strict=True, ge=0)], + body: Dict[str, Any], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Archive the Ezsignfolder + + + + :param pki_ezsignfolder_id: (required) + :type pki_ezsignfolder_id: int + :param body: (required) + :type body: object + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignfolder_archive_v1_serialize( + pki_ezsignfolder_id=pki_ezsignfolder_id, + body=body, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsignfolder_archive_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfolderArchiveV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_ezsignfolder_id']: - _path_params['pkiEzsignfolderID'] = _params['pki_ezsignfolder_id'] + def _ezsignfolder_archive_v1_serialize( + self, + pki_ezsignfolder_id, + body, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if pki_ezsignfolder_id is not None: + _path_params['pkiEzsignfolderID'] = pki_ezsignfolder_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['body'] is not None: - _body_params = _params['body'] + if body is not None: + _body_params = body + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '200': "EzsignfolderArchiveV1Response", - '404': "CommonResponseError", - '422': "CommonResponseError", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsignfolder/{pkiEzsignfolderID}/archive', 'POST', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='POST', + resource_path='/1/object/ezsignfolder/{pkiEzsignfolderID}/archive', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + - @validate_arguments - def ezsignfolder_batch_download_v1(self, pki_ezsignfolder_id : conint(strict=True, ge=0), ezsignfolder_batch_download_v1_request : EzsignfolderBatchDownloadV1Request, **kwargs) -> bytearray: # noqa: E501 - """Download multiples files from an Ezsignfolder # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def ezsignfolder_batch_download_v1( + self, + pki_ezsignfolder_id: Annotated[int, Field(strict=True, ge=0)], + ezsignfolder_batch_download_v1_request: EzsignfolderBatchDownloadV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> bytearray: + """Download multiples files from an Ezsignfolder - >>> thread = api.ezsignfolder_batch_download_v1(pki_ezsignfolder_id, ezsignfolder_batch_download_v1_request, async_req=True) - >>> result = thread.get() :param pki_ezsignfolder_id: (required) :type pki_ezsignfolder_id: int :param ezsignfolder_batch_download_v1_request: (required) :type ezsignfolder_batch_download_v1_request: EzsignfolderBatchDownloadV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: bytearray - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsignfolder_batch_download_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsignfolder_batch_download_v1_with_http_info(pki_ezsignfolder_id, ezsignfolder_batch_download_v1_request, **kwargs) # noqa: E501 - - @validate_arguments - def ezsignfolder_batch_download_v1_with_http_info(self, pki_ezsignfolder_id : conint(strict=True, ge=0), ezsignfolder_batch_download_v1_request : EzsignfolderBatchDownloadV1Request, **kwargs) -> ApiResponse: # noqa: E501 - """Download multiples files from an Ezsignfolder # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsignfolder_batch_download_v1_with_http_info(pki_ezsignfolder_id, ezsignfolder_batch_download_v1_request, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._ezsignfolder_batch_download_v1_serialize( + pki_ezsignfolder_id=pki_ezsignfolder_id, + ezsignfolder_batch_download_v1_request=ezsignfolder_batch_download_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "bytearray", + '404': "CommonResponseError", + '406': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsignfolder_batch_download_v1_with_http_info( + self, + pki_ezsignfolder_id: Annotated[int, Field(strict=True, ge=0)], + ezsignfolder_batch_download_v1_request: EzsignfolderBatchDownloadV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[bytearray]: + """Download multiples files from an Ezsignfolder + :param pki_ezsignfolder_id: (required) :type pki_ezsignfolder_id: int :param ezsignfolder_batch_download_v1_request: (required) :type ezsignfolder_batch_download_v1_request: EzsignfolderBatchDownloadV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(bytearray, status_code(int), headers(HTTPHeaderDict)) - """ - - _params = locals() - - _all_params = [ - 'pki_ezsignfolder_id', - 'ezsignfolder_batch_download_v1_request' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' - ] + """ # noqa: E501 + + _param = self._ezsignfolder_batch_download_v1_serialize( + pki_ezsignfolder_id=pki_ezsignfolder_id, + ezsignfolder_batch_download_v1_request=ezsignfolder_batch_download_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsignfolder_batch_download_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] - - _collection_formats = {} - - # process the path parameters - _path_params = {} - if _params['pki_ezsignfolder_id']: - _path_params['pkiEzsignfolderID'] = _params['pki_ezsignfolder_id'] - - - # process the query parameters - _query_params = [] - # process the header parameters - _header_params = dict(_params.get('_headers', {})) - # process the form parameters - _form_params = [] - _files = {} - # process the body parameter - _body_params = None - if _params['ezsignfolder_batch_download_v1_request'] is not None: - _body_params = _params['ezsignfolder_batch_download_v1_request'] - - # set the HTTP header `Accept` - _header_params['Accept'] = self.api_client.select_header_accept( - ['application/zip', 'application/json']) # noqa: E501 - - # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list - - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { + _response_types_map: Dict[str, Optional[str]] = { '200': "bytearray", '404': "CommonResponseError", '406': "CommonResponseError", '422': "CommonResponseError", } - - return self.api_client.call_api( - '/1/object/ezsignfolder/{pkiEzsignfolderID}/batchDownload', 'POST', - _path_params, - _query_params, - _header_params, - body=_body_params, - post_params=_form_params, - files=_files, + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, response_types_map=_response_types_map, - auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), - collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) - - @validate_arguments - def ezsignfolder_create_object_v1(self, ezsignfolder_create_object_v1_request : conlist(EzsignfolderCreateObjectV1Request), **kwargs) -> EzsignfolderCreateObjectV1Response: # noqa: E501 - """(Deprecated) Create a new Ezsignfolder # noqa: E501 + ) - The endpoint allows to create one or many elements at once. The array can contain simple (Just the object) or compound (The object and its child) objects. Creating compound elements allows to reduce the multiple requests to create all child objects. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.ezsignfolder_create_object_v1(ezsignfolder_create_object_v1_request, async_req=True) - >>> result = thread.get() + @validate_call + def ezsignfolder_batch_download_v1_without_preload_content( + self, + pki_ezsignfolder_id: Annotated[int, Field(strict=True, ge=0)], + ezsignfolder_batch_download_v1_request: EzsignfolderBatchDownloadV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Download multiples files from an Ezsignfolder - :param ezsignfolder_create_object_v1_request: (required) - :type ezsignfolder_create_object_v1_request: List[EzsignfolderCreateObjectV1Request] - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsignfolderCreateObjectV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsignfolder_create_object_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsignfolder_create_object_v1_with_http_info(ezsignfolder_create_object_v1_request, **kwargs) # noqa: E501 - - @validate_arguments - def ezsignfolder_create_object_v1_with_http_info(self, ezsignfolder_create_object_v1_request : conlist(EzsignfolderCreateObjectV1Request), **kwargs) -> ApiResponse: # noqa: E501 - """(Deprecated) Create a new Ezsignfolder # noqa: E501 - - The endpoint allows to create one or many elements at once. The array can contain simple (Just the object) or compound (The object and its child) objects. Creating compound elements allows to reduce the multiple requests to create all child objects. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsignfolder_create_object_v1_with_http_info(ezsignfolder_create_object_v1_request, async_req=True) - >>> result = thread.get() - :param ezsignfolder_create_object_v1_request: (required) - :type ezsignfolder_create_object_v1_request: List[EzsignfolderCreateObjectV1Request] - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional + :param pki_ezsignfolder_id: (required) + :type pki_ezsignfolder_id: int + :param ezsignfolder_batch_download_v1_request: (required) + :type ezsignfolder_batch_download_v1_request: EzsignfolderBatchDownloadV1Request :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsignfolderCreateObjectV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._ezsignfolder_batch_download_v1_serialize( + pki_ezsignfolder_id=pki_ezsignfolder_id, + ezsignfolder_batch_download_v1_request=ezsignfolder_batch_download_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - warnings.warn("POST /1/object/ezsignfolder is deprecated.", DeprecationWarning) + _response_types_map: Dict[str, Optional[str]] = { + '200': "bytearray", + '404': "CommonResponseError", + '406': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _params = locals() - _all_params = [ - 'ezsignfolder_create_object_v1_request' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' - ] - ) + def _ezsignfolder_batch_download_v1_serialize( + self, + pki_ezsignfolder_id, + ezsignfolder_batch_download_v1_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsignfolder_create_object_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _host = None + + _collection_formats: Dict[str, str] = { + } - _collection_formats = {} + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None # process the path parameters - _path_params = {} - + if pki_ezsignfolder_id is not None: + _path_params['pkiEzsignfolderID'] = pki_ezsignfolder_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['ezsignfolder_create_object_v1_request'] is not None: - _body_params = _params['ezsignfolder_create_object_v1_request'] + if ezsignfolder_batch_download_v1_request is not None: + _body_params = ezsignfolder_batch_download_v1_request + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/zip', + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '201': "EzsignfolderCreateObjectV1Response", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsignfolder', 'POST', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='POST', + resource_path='/1/object/ezsignfolder/{pkiEzsignfolderID}/batchDownload', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) - @validate_arguments - def ezsignfolder_create_object_v2(self, ezsignfolder_create_object_v2_request : EzsignfolderCreateObjectV2Request, **kwargs) -> EzsignfolderCreateObjectV2Response: # noqa: E501 - """Create a new Ezsignfolder # noqa: E501 - The endpoint allows to create one or many elements at once. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.ezsignfolder_create_object_v2(ezsignfolder_create_object_v2_request, async_req=True) - >>> result = thread.get() - :param ezsignfolder_create_object_v2_request: (required) - :type ezsignfolder_create_object_v2_request: EzsignfolderCreateObjectV2Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsignfolderCreateObjectV2Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsignfolder_create_object_v2_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsignfolder_create_object_v2_with_http_info(ezsignfolder_create_object_v2_request, **kwargs) # noqa: E501 - - @validate_arguments - def ezsignfolder_create_object_v2_with_http_info(self, ezsignfolder_create_object_v2_request : EzsignfolderCreateObjectV2Request, **kwargs) -> ApiResponse: # noqa: E501 - """Create a new Ezsignfolder # noqa: E501 - - The endpoint allows to create one or many elements at once. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsignfolder_create_object_v2_with_http_info(ezsignfolder_create_object_v2_request, async_req=True) - >>> result = thread.get() + @validate_call + def ezsignfolder_create_object_v1( + self, + ezsignfolder_create_object_v1_request: List[EzsignfolderCreateObjectV1Request], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsignfolderCreateObjectV1Response: + """(Deprecated) Create a new Ezsignfolder - :param ezsignfolder_create_object_v2_request: (required) - :type ezsignfolder_create_object_v2_request: EzsignfolderCreateObjectV2Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional + The endpoint allows to create one or many elements at once. The array can contain simple (Just the object) or compound (The object and its child) objects. Creating compound elements allows to reduce the multiple requests to create all child objects. + + :param ezsignfolder_create_object_v1_request: (required) + :type ezsignfolder_create_object_v1_request: List[EzsignfolderCreateObjectV1Request] :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsignfolderCreateObjectV2Response, status_code(int), headers(HTTPHeaderDict)) - """ - - _params = locals() + """ # noqa: E501 + warnings.warn("POST /1/object/ezsignfolder is deprecated.", DeprecationWarning) - _all_params = [ - 'ezsignfolder_create_object_v2_request' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' - ] + _param = self._ezsignfolder_create_object_v1_serialize( + ezsignfolder_create_object_v1_request=ezsignfolder_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsignfolder_create_object_v2" % _key - ) - _params[_key] = _val - del _params['kwargs'] - - _collection_formats = {} - - # process the path parameters - _path_params = {} - - # process the query parameters - _query_params = [] - # process the header parameters - _header_params = dict(_params.get('_headers', {})) - # process the form parameters - _form_params = [] - _files = {} - # process the body parameter - _body_params = None - if _params['ezsignfolder_create_object_v2_request'] is not None: - _body_params = _params['ezsignfolder_create_object_v2_request'] + _response_types_map: Dict[str, Optional[str]] = { + '201': "EzsignfolderCreateObjectV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsignfolder_create_object_v1_with_http_info( + self, + ezsignfolder_create_object_v1_request: List[EzsignfolderCreateObjectV1Request], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsignfolderCreateObjectV1Response]: + """(Deprecated) Create a new Ezsignfolder - # set the HTTP header `Accept` - _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + The endpoint allows to create one or many elements at once. The array can contain simple (Just the object) or compound (The object and its child) objects. Creating compound elements allows to reduce the multiple requests to create all child objects. - # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + :param ezsignfolder_create_object_v1_request: (required) + :type ezsignfolder_create_object_v1_request: List[EzsignfolderCreateObjectV1Request] + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + warnings.warn("POST /1/object/ezsignfolder is deprecated.", DeprecationWarning) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 + _param = self._ezsignfolder_create_object_v1_serialize( + ezsignfolder_create_object_v1_request=ezsignfolder_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _response_types_map = { - '201': "EzsignfolderCreateObjectV2Response", + _response_types_map: Dict[str, Optional[str]] = { + '201': "EzsignfolderCreateObjectV1Response", } - - return self.api_client.call_api( - '/2/object/ezsignfolder', 'POST', - _path_params, - _query_params, - _header_params, - body=_body_params, - post_params=_form_params, - files=_files, + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, response_types_map=_response_types_map, - auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), - collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) - - @validate_arguments - def ezsignfolder_delete_object_v1(self, pki_ezsignfolder_id : conint(strict=True, ge=0), **kwargs) -> EzsignfolderDeleteObjectV1Response: # noqa: E501 - """Delete an existing Ezsignfolder # noqa: E501 + ) - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.ezsignfolder_delete_object_v1(pki_ezsignfolder_id, async_req=True) - >>> result = thread.get() + @validate_call + def ezsignfolder_create_object_v1_without_preload_content( + self, + ezsignfolder_create_object_v1_request: List[EzsignfolderCreateObjectV1Request], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """(Deprecated) Create a new Ezsignfolder - :param pki_ezsignfolder_id: (required) - :type pki_ezsignfolder_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsignfolderDeleteObjectV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsignfolder_delete_object_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsignfolder_delete_object_v1_with_http_info(pki_ezsignfolder_id, **kwargs) # noqa: E501 - - @validate_arguments - def ezsignfolder_delete_object_v1_with_http_info(self, pki_ezsignfolder_id : conint(strict=True, ge=0), **kwargs) -> ApiResponse: # noqa: E501 - """Delete an existing Ezsignfolder # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsignfolder_delete_object_v1_with_http_info(pki_ezsignfolder_id, async_req=True) - >>> result = thread.get() + The endpoint allows to create one or many elements at once. The array can contain simple (Just the object) or compound (The object and its child) objects. Creating compound elements allows to reduce the multiple requests to create all child objects. - :param pki_ezsignfolder_id: (required) - :type pki_ezsignfolder_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional + :param ezsignfolder_create_object_v1_request: (required) + :type ezsignfolder_create_object_v1_request: List[EzsignfolderCreateObjectV1Request] :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsignfolderDeleteObjectV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + warnings.warn("POST /1/object/ezsignfolder is deprecated.", DeprecationWarning) - _params = locals() + _param = self._ezsignfolder_create_object_v1_serialize( + ezsignfolder_create_object_v1_request=ezsignfolder_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _all_params = [ - 'pki_ezsignfolder_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' - ] + _response_types_map: Dict[str, Optional[str]] = { + '201': "EzsignfolderCreateObjectV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) + return response_data.response - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsignfolder_delete_object_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] - _collection_formats = {} + def _ezsignfolder_create_object_v1_serialize( + self, + ezsignfolder_create_object_v1_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: - # process the path parameters - _path_params = {} - if _params['pki_ezsignfolder_id']: - _path_params['pkiEzsignfolderID'] = _params['pki_ezsignfolder_id'] + _host = None + + _collection_formats: Dict[str, str] = { + 'EzsignfolderCreateObjectV1Request': '', + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + if ezsignfolder_create_object_v1_request is not None: + _body_params = ezsignfolder_create_object_v1_request + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type - _response_types_map = { - '200': "EzsignfolderDeleteObjectV1Response", - '404': "CommonResponseError", - '422': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsignfolder/{pkiEzsignfolderID}', 'DELETE', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='POST', + resource_path='/1/object/ezsignfolder', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) - @validate_arguments - def ezsignfolder_dispose_ezsignfolders_v1(self, ezsignfolder_dispose_ezsignfolders_v1_request : EzsignfolderDisposeEzsignfoldersV1Request, **kwargs) -> EzsignfolderDisposeEzsignfoldersV1Response: # noqa: E501 - """Dispose Ezsignfolders # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.ezsignfolder_dispose_ezsignfolders_v1(ezsignfolder_dispose_ezsignfolders_v1_request, async_req=True) - >>> result = thread.get() - :param ezsignfolder_dispose_ezsignfolders_v1_request: (required) - :type ezsignfolder_dispose_ezsignfolders_v1_request: EzsignfolderDisposeEzsignfoldersV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsignfolderDisposeEzsignfoldersV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsignfolder_dispose_ezsignfolders_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsignfolder_dispose_ezsignfolders_v1_with_http_info(ezsignfolder_dispose_ezsignfolders_v1_request, **kwargs) # noqa: E501 - - @validate_arguments - def ezsignfolder_dispose_ezsignfolders_v1_with_http_info(self, ezsignfolder_dispose_ezsignfolders_v1_request : EzsignfolderDisposeEzsignfoldersV1Request, **kwargs) -> ApiResponse: # noqa: E501 - """Dispose Ezsignfolders # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsignfolder_dispose_ezsignfolders_v1_with_http_info(ezsignfolder_dispose_ezsignfolders_v1_request, async_req=True) - >>> result = thread.get() + @validate_call + def ezsignfolder_create_object_v2( + self, + ezsignfolder_create_object_v2_request: EzsignfolderCreateObjectV2Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsignfolderCreateObjectV2Response: + """Create a new Ezsignfolder - :param ezsignfolder_dispose_ezsignfolders_v1_request: (required) - :type ezsignfolder_dispose_ezsignfolders_v1_request: EzsignfolderDisposeEzsignfoldersV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional + The endpoint allows to create one or many elements at once. + + :param ezsignfolder_create_object_v2_request: (required) + :type ezsignfolder_create_object_v2_request: EzsignfolderCreateObjectV2Request :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsignfolderDisposeEzsignfoldersV1Response, status_code(int), headers(HTTPHeaderDict)) - """ - - _params = locals() + """ # noqa: E501 + + _param = self._ezsignfolder_create_object_v2_serialize( + ezsignfolder_create_object_v2_request=ezsignfolder_create_object_v2_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _all_params = [ - 'ezsignfolder_dispose_ezsignfolders_v1_request' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' - ] + _response_types_map: Dict[str, Optional[str]] = { + '201': "EzsignfolderCreateObjectV2Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsignfolder_create_object_v2_with_http_info( + self, + ezsignfolder_create_object_v2_request: EzsignfolderCreateObjectV2Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsignfolderCreateObjectV2Response]: + """Create a new Ezsignfolder - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsignfolder_dispose_ezsignfolders_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] - - _collection_formats = {} - - # process the path parameters - _path_params = {} - - # process the query parameters - _query_params = [] - # process the header parameters - _header_params = dict(_params.get('_headers', {})) - # process the form parameters - _form_params = [] - _files = {} - # process the body parameter - _body_params = None - if _params['ezsignfolder_dispose_ezsignfolders_v1_request'] is not None: - _body_params = _params['ezsignfolder_dispose_ezsignfolders_v1_request'] - - # set the HTTP header `Accept` - _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 - - # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + The endpoint allows to create one or many elements at once. - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 + :param ezsignfolder_create_object_v2_request: (required) + :type ezsignfolder_create_object_v2_request: EzsignfolderCreateObjectV2Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignfolder_create_object_v2_serialize( + ezsignfolder_create_object_v2_request=ezsignfolder_create_object_v2_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _response_types_map = { - '200': "EzsignfolderDisposeEzsignfoldersV1Response", - '404': "CommonResponseError", - '422': "CommonResponseError", + _response_types_map: Dict[str, Optional[str]] = { + '201': "EzsignfolderCreateObjectV2Response", } - - return self.api_client.call_api( - '/1/object/ezsignfolder/disposeEzsignfolders', 'POST', - _path_params, - _query_params, - _header_params, - body=_body_params, - post_params=_form_params, - files=_files, + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, response_types_map=_response_types_map, - auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), - collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) - - @validate_arguments - def ezsignfolder_dispose_v1(self, pki_ezsignfolder_id : conint(strict=True, ge=0), body : Dict[str, Any], **kwargs) -> EzsignfolderDisposeV1Response: # noqa: E501 - """Dispose the Ezsignfolder # noqa: E501 + ) - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.ezsignfolder_dispose_v1(pki_ezsignfolder_id, body, async_req=True) - >>> result = thread.get() + @validate_call + def ezsignfolder_create_object_v2_without_preload_content( + self, + ezsignfolder_create_object_v2_request: EzsignfolderCreateObjectV2Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Create a new Ezsignfolder - :param pki_ezsignfolder_id: (required) - :type pki_ezsignfolder_id: int - :param body: (required) - :type body: object - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsignfolderDisposeV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsignfolder_dispose_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsignfolder_dispose_v1_with_http_info(pki_ezsignfolder_id, body, **kwargs) # noqa: E501 - - @validate_arguments - def ezsignfolder_dispose_v1_with_http_info(self, pki_ezsignfolder_id : conint(strict=True, ge=0), body : Dict[str, Any], **kwargs) -> ApiResponse: # noqa: E501 - """Dispose the Ezsignfolder # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsignfolder_dispose_v1_with_http_info(pki_ezsignfolder_id, body, async_req=True) - >>> result = thread.get() + The endpoint allows to create one or many elements at once. - :param pki_ezsignfolder_id: (required) - :type pki_ezsignfolder_id: int - :param body: (required) - :type body: object - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional + :param ezsignfolder_create_object_v2_request: (required) + :type ezsignfolder_create_object_v2_request: EzsignfolderCreateObjectV2Request :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsignfolderDisposeV1Response, status_code(int), headers(HTTPHeaderDict)) - """ - - _params = locals() + """ # noqa: E501 + + _param = self._ezsignfolder_create_object_v2_serialize( + ezsignfolder_create_object_v2_request=ezsignfolder_create_object_v2_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _all_params = [ - 'pki_ezsignfolder_id', - 'body' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' - ] + _response_types_map: Dict[str, Optional[str]] = { + '201': "EzsignfolderCreateObjectV2Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) + return response_data.response - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsignfolder_dispose_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] - _collection_formats = {} + def _ezsignfolder_create_object_v2_serialize( + self, + ezsignfolder_create_object_v2_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: - # process the path parameters - _path_params = {} - if _params['pki_ezsignfolder_id']: - _path_params['pkiEzsignfolderID'] = _params['pki_ezsignfolder_id'] + _host = None + + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['body'] is not None: - _body_params = _params['body'] + if ezsignfolder_create_object_v2_request is not None: + _body_params = ezsignfolder_create_object_v2_request + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '200': "EzsignfolderDisposeV1Response", - '404': "CommonResponseError", - '422': "CommonResponseError", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsignfolder/{pkiEzsignfolderID}/dispose', 'POST', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='POST', + resource_path='/2/object/ezsignfolder', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + - @validate_arguments - def ezsignfolder_edit_object_v1(self, pki_ezsignfolder_id : conint(strict=True, ge=0), ezsignfolder_edit_object_v1_request : EzsignfolderEditObjectV1Request, **kwargs) -> EzsignfolderEditObjectV1Response: # noqa: E501 - """Edit an existing Ezsignfolder # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def ezsignfolder_delete_object_v1( + self, + pki_ezsignfolder_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsignfolderDeleteObjectV1Response: + """Delete an existing Ezsignfolder - >>> thread = api.ezsignfolder_edit_object_v1(pki_ezsignfolder_id, ezsignfolder_edit_object_v1_request, async_req=True) - >>> result = thread.get() :param pki_ezsignfolder_id: (required) :type pki_ezsignfolder_id: int - :param ezsignfolder_edit_object_v1_request: (required) - :type ezsignfolder_edit_object_v1_request: EzsignfolderEditObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsignfolderEditObjectV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsignfolder_edit_object_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsignfolder_edit_object_v1_with_http_info(pki_ezsignfolder_id, ezsignfolder_edit_object_v1_request, **kwargs) # noqa: E501 - - @validate_arguments - def ezsignfolder_edit_object_v1_with_http_info(self, pki_ezsignfolder_id : conint(strict=True, ge=0), ezsignfolder_edit_object_v1_request : EzsignfolderEditObjectV1Request, **kwargs) -> ApiResponse: # noqa: E501 - """Edit an existing Ezsignfolder # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsignfolder_edit_object_v1_with_http_info(pki_ezsignfolder_id, ezsignfolder_edit_object_v1_request, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._ezsignfolder_delete_object_v1_serialize( + pki_ezsignfolder_id=pki_ezsignfolder_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfolderDeleteObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsignfolder_delete_object_v1_with_http_info( + self, + pki_ezsignfolder_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsignfolderDeleteObjectV1Response]: + """Delete an existing Ezsignfolder + :param pki_ezsignfolder_id: (required) :type pki_ezsignfolder_id: int - :param ezsignfolder_edit_object_v1_request: (required) - :type ezsignfolder_edit_object_v1_request: EzsignfolderEditObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsignfolderEditObjectV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._ezsignfolder_delete_object_v1_serialize( + pki_ezsignfolder_id=pki_ezsignfolder_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfolderDeleteObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _params = locals() - _all_params = [ - 'pki_ezsignfolder_id', - 'ezsignfolder_edit_object_v1_request' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + @validate_call + def ezsignfolder_delete_object_v1_without_preload_content( + self, + pki_ezsignfolder_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete an existing Ezsignfolder + + + :param pki_ezsignfolder_id: (required) + :type pki_ezsignfolder_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignfolder_delete_object_v1_serialize( + pki_ezsignfolder_id=pki_ezsignfolder_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsignfolder_edit_object_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfolderDeleteObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_ezsignfolder_id']: - _path_params['pkiEzsignfolderID'] = _params['pki_ezsignfolder_id'] + def _ezsignfolder_delete_object_v1_serialize( + self, + pki_ezsignfolder_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if pki_ezsignfolder_id is not None: + _path_params['pkiEzsignfolderID'] = pki_ezsignfolder_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['ezsignfolder_edit_object_v1_request'] is not None: - _body_params = _params['ezsignfolder_edit_object_v1_request'] + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '200': "EzsignfolderEditObjectV1Response", - '404': "CommonResponseError", - '422': "CommonResponseError", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsignfolder/{pkiEzsignfolderID}', 'PUT', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='DELETE', + resource_path='/1/object/ezsignfolder/{pkiEzsignfolderID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) - @validate_arguments - def ezsignfolder_get_actionable_elements_v1(self, pki_ezsignfolder_id : conint(strict=True, ge=0), **kwargs) -> EzsignfolderGetActionableElementsV1Response: # noqa: E501 - """Retrieve actionable elements for the Ezsignfolder # noqa: E501 - Return the Ezsignsignatures that can be signed and Ezsignformfieldgroups that can be filled by the current user at the current step in the process # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.ezsignfolder_get_actionable_elements_v1(pki_ezsignfolder_id, async_req=True) - >>> result = thread.get() - :param pki_ezsignfolder_id: (required) - :type pki_ezsignfolder_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsignfolderGetActionableElementsV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsignfolder_get_actionable_elements_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsignfolder_get_actionable_elements_v1_with_http_info(pki_ezsignfolder_id, **kwargs) # noqa: E501 - - @validate_arguments - def ezsignfolder_get_actionable_elements_v1_with_http_info(self, pki_ezsignfolder_id : conint(strict=True, ge=0), **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve actionable elements for the Ezsignfolder # noqa: E501 - - Return the Ezsignsignatures that can be signed and Ezsignformfieldgroups that can be filled by the current user at the current step in the process # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsignfolder_get_actionable_elements_v1_with_http_info(pki_ezsignfolder_id, async_req=True) - >>> result = thread.get() + @validate_call + def ezsignfolder_dispose_ezsignfolders_v1( + self, + ezsignfolder_dispose_ezsignfolders_v1_request: EzsignfolderDisposeEzsignfoldersV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsignfolderDisposeEzsignfoldersV1Response: + """Dispose Ezsignfolders - :param pki_ezsignfolder_id: (required) - :type pki_ezsignfolder_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional + + + :param ezsignfolder_dispose_ezsignfolders_v1_request: (required) + :type ezsignfolder_dispose_ezsignfolders_v1_request: EzsignfolderDisposeEzsignfoldersV1Request :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsignfolderGetActionableElementsV1Response, status_code(int), headers(HTTPHeaderDict)) - """ - - _params = locals() - - _all_params = [ - 'pki_ezsignfolder_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' - ] + """ # noqa: E501 + + _param = self._ezsignfolder_dispose_ezsignfolders_v1_serialize( + ezsignfolder_dispose_ezsignfolders_v1_request=ezsignfolder_dispose_ezsignfolders_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsignfolder_get_actionable_elements_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] - - _collection_formats = {} - - # process the path parameters - _path_params = {} - if _params['pki_ezsignfolder_id']: - _path_params['pkiEzsignfolderID'] = _params['pki_ezsignfolder_id'] - + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfolderDisposeEzsignfoldersV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsignfolder_dispose_ezsignfolders_v1_with_http_info( + self, + ezsignfolder_dispose_ezsignfolders_v1_request: EzsignfolderDisposeEzsignfoldersV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsignfolderDisposeEzsignfoldersV1Response]: + """Dispose Ezsignfolders - # process the query parameters - _query_params = [] - # process the header parameters - _header_params = dict(_params.get('_headers', {})) - # process the form parameters - _form_params = [] - _files = {} - # process the body parameter - _body_params = None - # set the HTTP header `Accept` - _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 + :param ezsignfolder_dispose_ezsignfolders_v1_request: (required) + :type ezsignfolder_dispose_ezsignfolders_v1_request: EzsignfolderDisposeEzsignfoldersV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignfolder_dispose_ezsignfolders_v1_serialize( + ezsignfolder_dispose_ezsignfolders_v1_request=ezsignfolder_dispose_ezsignfolders_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _response_types_map = { - '200': "EzsignfolderGetActionableElementsV1Response", + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfolderDisposeEzsignfoldersV1Response", '404': "CommonResponseError", '422': "CommonResponseError", } - - return self.api_client.call_api( - '/1/object/ezsignfolder/{pkiEzsignfolderID}/getActionableElements', 'GET', - _path_params, - _query_params, - _header_params, - body=_body_params, - post_params=_form_params, - files=_files, + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, response_types_map=_response_types_map, - auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), - collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) - - @validate_arguments - def ezsignfolder_get_communication_count_v1(self, pki_ezsignfolder_id : conint(strict=True, ge=0), **kwargs) -> EzsignfolderGetCommunicationCountV1Response: # noqa: E501 - """Retrieve Communication count # noqa: E501 + ) - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.ezsignfolder_get_communication_count_v1(pki_ezsignfolder_id, async_req=True) - >>> result = thread.get() + @validate_call + def ezsignfolder_dispose_ezsignfolders_v1_without_preload_content( + self, + ezsignfolder_dispose_ezsignfolders_v1_request: EzsignfolderDisposeEzsignfoldersV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Dispose Ezsignfolders - :param pki_ezsignfolder_id: (required) - :type pki_ezsignfolder_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsignfolderGetCommunicationCountV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsignfolder_get_communication_count_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsignfolder_get_communication_count_v1_with_http_info(pki_ezsignfolder_id, **kwargs) # noqa: E501 - - @validate_arguments - def ezsignfolder_get_communication_count_v1_with_http_info(self, pki_ezsignfolder_id : conint(strict=True, ge=0), **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve Communication count # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsignfolder_get_communication_count_v1_with_http_info(pki_ezsignfolder_id, async_req=True) - >>> result = thread.get() + - :param pki_ezsignfolder_id: (required) - :type pki_ezsignfolder_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional + :param ezsignfolder_dispose_ezsignfolders_v1_request: (required) + :type ezsignfolder_dispose_ezsignfolders_v1_request: EzsignfolderDisposeEzsignfoldersV1Request :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsignfolderGetCommunicationCountV1Response, status_code(int), headers(HTTPHeaderDict)) - """ - - _params = locals() + """ # noqa: E501 + + _param = self._ezsignfolder_dispose_ezsignfolders_v1_serialize( + ezsignfolder_dispose_ezsignfolders_v1_request=ezsignfolder_dispose_ezsignfolders_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _all_params = [ - 'pki_ezsignfolder_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' - ] + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfolderDisposeEzsignfoldersV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) + return response_data.response - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsignfolder_get_communication_count_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] - _collection_formats = {} + def _ezsignfolder_dispose_ezsignfolders_v1_serialize( + self, + ezsignfolder_dispose_ezsignfolders_v1_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: - # process the path parameters - _path_params = {} - if _params['pki_ezsignfolder_id']: - _path_params['pkiEzsignfolderID'] = _params['pki_ezsignfolder_id'] + _host = None + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + if ezsignfolder_dispose_ezsignfolders_v1_request is not None: + _body_params = ezsignfolder_dispose_ezsignfolders_v1_request + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type - _response_types_map = { - '200': "EzsignfolderGetCommunicationCountV1Response", - '404': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsignfolder/{pkiEzsignfolderID}/getCommunicationCount', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='POST', + resource_path='/1/object/ezsignfolder/disposeEzsignfolders', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) - @validate_arguments - def ezsignfolder_get_communication_list_v1(self, pki_ezsignfolder_id : conint(strict=True, ge=0), **kwargs) -> EzsignfolderGetCommunicationListV1Response: # noqa: E501 - """Retrieve Communication list # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.ezsignfolder_get_communication_list_v1(pki_ezsignfolder_id, async_req=True) - >>> result = thread.get() - :param pki_ezsignfolder_id: (required) - :type pki_ezsignfolder_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsignfolderGetCommunicationListV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsignfolder_get_communication_list_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsignfolder_get_communication_list_v1_with_http_info(pki_ezsignfolder_id, **kwargs) # noqa: E501 - - @validate_arguments - def ezsignfolder_get_communication_list_v1_with_http_info(self, pki_ezsignfolder_id : conint(strict=True, ge=0), **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve Communication list # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsignfolder_get_communication_list_v1_with_http_info(pki_ezsignfolder_id, async_req=True) - >>> result = thread.get() + @validate_call + def ezsignfolder_dispose_v1( + self, + pki_ezsignfolder_id: Annotated[int, Field(strict=True, ge=0)], + body: Dict[str, Any], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsignfolderDisposeV1Response: + """Dispose the Ezsignfolder + + :param pki_ezsignfolder_id: (required) :type pki_ezsignfolder_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional + :param body: (required) + :type body: object :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsignfolderGetCommunicationListV1Response, status_code(int), headers(HTTPHeaderDict)) - """ - - _params = locals() - - _all_params = [ - 'pki_ezsignfolder_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' - ] + """ # noqa: E501 + + _param = self._ezsignfolder_dispose_v1_serialize( + pki_ezsignfolder_id=pki_ezsignfolder_id, + body=body, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsignfolder_get_communication_list_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] - - _collection_formats = {} - - # process the path parameters - _path_params = {} - if _params['pki_ezsignfolder_id']: - _path_params['pkiEzsignfolderID'] = _params['pki_ezsignfolder_id'] - + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfolderDisposeV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsignfolder_dispose_v1_with_http_info( + self, + pki_ezsignfolder_id: Annotated[int, Field(strict=True, ge=0)], + body: Dict[str, Any], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsignfolderDisposeV1Response]: + """Dispose the Ezsignfolder - # process the query parameters - _query_params = [] - # process the header parameters - _header_params = dict(_params.get('_headers', {})) - # process the form parameters - _form_params = [] - _files = {} - # process the body parameter - _body_params = None - # set the HTTP header `Accept` - _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 + :param pki_ezsignfolder_id: (required) + :type pki_ezsignfolder_id: int + :param body: (required) + :type body: object + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignfolder_dispose_v1_serialize( + pki_ezsignfolder_id=pki_ezsignfolder_id, + body=body, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _response_types_map = { - '200': "EzsignfolderGetCommunicationListV1Response", + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfolderDisposeV1Response", '404': "CommonResponseError", + '422': "CommonResponseError", } - - return self.api_client.call_api( - '/1/object/ezsignfolder/{pkiEzsignfolderID}/getCommunicationList', 'GET', - _path_params, - _query_params, - _header_params, - body=_body_params, - post_params=_form_params, - files=_files, + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, response_types_map=_response_types_map, - auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), - collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) - - @validate_arguments - def ezsignfolder_get_communicationrecipients_v1(self, pki_ezsignfolder_id : conint(strict=True, ge=0), **kwargs) -> EzsignfolderGetCommunicationrecipientsV1Response: # noqa: E501 - """Retrieve Ezsignfolder's Communicationrecipient # noqa: E501 + ) - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.ezsignfolder_get_communicationrecipients_v1(pki_ezsignfolder_id, async_req=True) - >>> result = thread.get() + @validate_call + def ezsignfolder_dispose_v1_without_preload_content( + self, + pki_ezsignfolder_id: Annotated[int, Field(strict=True, ge=0)], + body: Dict[str, Any], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Dispose the Ezsignfolder - :param pki_ezsignfolder_id: (required) - :type pki_ezsignfolder_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsignfolderGetCommunicationrecipientsV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsignfolder_get_communicationrecipients_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsignfolder_get_communicationrecipients_v1_with_http_info(pki_ezsignfolder_id, **kwargs) # noqa: E501 - - @validate_arguments - def ezsignfolder_get_communicationrecipients_v1_with_http_info(self, pki_ezsignfolder_id : conint(strict=True, ge=0), **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve Ezsignfolder's Communicationrecipient # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsignfolder_get_communicationrecipients_v1_with_http_info(pki_ezsignfolder_id, async_req=True) - >>> result = thread.get() + :param pki_ezsignfolder_id: (required) :type pki_ezsignfolder_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional + :param body: (required) + :type body: object :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsignfolderGetCommunicationrecipientsV1Response, status_code(int), headers(HTTPHeaderDict)) - """ - - _params = locals() + """ # noqa: E501 + + _param = self._ezsignfolder_dispose_v1_serialize( + pki_ezsignfolder_id=pki_ezsignfolder_id, + body=body, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _all_params = [ - 'pki_ezsignfolder_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' - ] + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfolderDisposeV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) + return response_data.response - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsignfolder_get_communicationrecipients_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] - _collection_formats = {} + def _ezsignfolder_dispose_v1_serialize( + self, + pki_ezsignfolder_id, + body, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: - # process the path parameters - _path_params = {} - if _params['pki_ezsignfolder_id']: - _path_params['pkiEzsignfolderID'] = _params['pki_ezsignfolder_id'] + _host = None + + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if pki_ezsignfolder_id is not None: + _path_params['pkiEzsignfolderID'] = pki_ezsignfolder_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + if body is not None: + _body_params = body + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type - _response_types_map = { - '200': "EzsignfolderGetCommunicationrecipientsV1Response", - '404': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsignfolder/{pkiEzsignfolderID}/getCommunicationrecipients', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='POST', + resource_path='/1/object/ezsignfolder/{pkiEzsignfolderID}/dispose', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) - @validate_arguments - def ezsignfolder_get_communicationsenders_v1(self, pki_ezsignfolder_id : conint(strict=True, ge=0), **kwargs) -> EzsignfolderGetCommunicationsendersV1Response: # noqa: E501 - """Retrieve Ezsignfolder's Communicationsender # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.ezsignfolder_get_communicationsenders_v1(pki_ezsignfolder_id, async_req=True) - >>> result = thread.get() - :param pki_ezsignfolder_id: (required) - :type pki_ezsignfolder_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsignfolderGetCommunicationsendersV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsignfolder_get_communicationsenders_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsignfolder_get_communicationsenders_v1_with_http_info(pki_ezsignfolder_id, **kwargs) # noqa: E501 - - @validate_arguments - def ezsignfolder_get_communicationsenders_v1_with_http_info(self, pki_ezsignfolder_id : conint(strict=True, ge=0), **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve Ezsignfolder's Communicationsender # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsignfolder_get_communicationsenders_v1_with_http_info(pki_ezsignfolder_id, async_req=True) - >>> result = thread.get() + @validate_call + def ezsignfolder_edit_object_v1( + self, + pki_ezsignfolder_id: Annotated[int, Field(strict=True, ge=0)], + ezsignfolder_edit_object_v1_request: EzsignfolderEditObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsignfolderEditObjectV1Response: + """Edit an existing Ezsignfolder + + :param pki_ezsignfolder_id: (required) :type pki_ezsignfolder_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional + :param ezsignfolder_edit_object_v1_request: (required) + :type ezsignfolder_edit_object_v1_request: EzsignfolderEditObjectV1Request :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsignfolderGetCommunicationsendersV1Response, status_code(int), headers(HTTPHeaderDict)) - """ - - _params = locals() - - _all_params = [ - 'pki_ezsignfolder_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' - ] + """ # noqa: E501 + + _param = self._ezsignfolder_edit_object_v1_serialize( + pki_ezsignfolder_id=pki_ezsignfolder_id, + ezsignfolder_edit_object_v1_request=ezsignfolder_edit_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsignfolder_get_communicationsenders_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] - - _collection_formats = {} - - # process the path parameters - _path_params = {} - if _params['pki_ezsignfolder_id']: - _path_params['pkiEzsignfolderID'] = _params['pki_ezsignfolder_id'] - + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfolderEditObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsignfolder_edit_object_v1_with_http_info( + self, + pki_ezsignfolder_id: Annotated[int, Field(strict=True, ge=0)], + ezsignfolder_edit_object_v1_request: EzsignfolderEditObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsignfolderEditObjectV1Response]: + """Edit an existing Ezsignfolder - # process the query parameters - _query_params = [] - # process the header parameters - _header_params = dict(_params.get('_headers', {})) - # process the form parameters - _form_params = [] - _files = {} - # process the body parameter - _body_params = None - # set the HTTP header `Accept` - _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 + :param pki_ezsignfolder_id: (required) + :type pki_ezsignfolder_id: int + :param ezsignfolder_edit_object_v1_request: (required) + :type ezsignfolder_edit_object_v1_request: EzsignfolderEditObjectV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignfolder_edit_object_v1_serialize( + pki_ezsignfolder_id=pki_ezsignfolder_id, + ezsignfolder_edit_object_v1_request=ezsignfolder_edit_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _response_types_map = { - '200': "EzsignfolderGetCommunicationsendersV1Response", + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfolderEditObjectV1Response", '404': "CommonResponseError", + '422': "CommonResponseError", } - - return self.api_client.call_api( - '/1/object/ezsignfolder/{pkiEzsignfolderID}/getCommunicationsenders', 'GET', - _path_params, - _query_params, - _header_params, - body=_body_params, - post_params=_form_params, - files=_files, + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, response_types_map=_response_types_map, - auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), - collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) - - @validate_arguments - def ezsignfolder_get_ezsigndocuments_v1(self, pki_ezsignfolder_id : conint(strict=True, ge=0), **kwargs) -> EzsignfolderGetEzsigndocumentsV1Response: # noqa: E501 - """Retrieve an existing Ezsignfolder's Ezsigndocuments # noqa: E501 + ) - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.ezsignfolder_get_ezsigndocuments_v1(pki_ezsignfolder_id, async_req=True) - >>> result = thread.get() + @validate_call + def ezsignfolder_edit_object_v1_without_preload_content( + self, + pki_ezsignfolder_id: Annotated[int, Field(strict=True, ge=0)], + ezsignfolder_edit_object_v1_request: EzsignfolderEditObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Edit an existing Ezsignfolder - :param pki_ezsignfolder_id: (required) - :type pki_ezsignfolder_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsignfolderGetEzsigndocumentsV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsignfolder_get_ezsigndocuments_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsignfolder_get_ezsigndocuments_v1_with_http_info(pki_ezsignfolder_id, **kwargs) # noqa: E501 - - @validate_arguments - def ezsignfolder_get_ezsigndocuments_v1_with_http_info(self, pki_ezsignfolder_id : conint(strict=True, ge=0), **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve an existing Ezsignfolder's Ezsigndocuments # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsignfolder_get_ezsigndocuments_v1_with_http_info(pki_ezsignfolder_id, async_req=True) - >>> result = thread.get() + :param pki_ezsignfolder_id: (required) :type pki_ezsignfolder_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional + :param ezsignfolder_edit_object_v1_request: (required) + :type ezsignfolder_edit_object_v1_request: EzsignfolderEditObjectV1Request :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsignfolderGetEzsigndocumentsV1Response, status_code(int), headers(HTTPHeaderDict)) - """ - - _params = locals() + """ # noqa: E501 + + _param = self._ezsignfolder_edit_object_v1_serialize( + pki_ezsignfolder_id=pki_ezsignfolder_id, + ezsignfolder_edit_object_v1_request=ezsignfolder_edit_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _all_params = [ - 'pki_ezsignfolder_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' - ] + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfolderEditObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) + return response_data.response - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsignfolder_get_ezsigndocuments_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] - _collection_formats = {} + def _ezsignfolder_edit_object_v1_serialize( + self, + pki_ezsignfolder_id, + ezsignfolder_edit_object_v1_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: - # process the path parameters - _path_params = {} - if _params['pki_ezsignfolder_id']: - _path_params['pkiEzsignfolderID'] = _params['pki_ezsignfolder_id'] + _host = None + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if pki_ezsignfolder_id is not None: + _path_params['pkiEzsignfolderID'] = pki_ezsignfolder_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + if ezsignfolder_edit_object_v1_request is not None: + _body_params = ezsignfolder_edit_object_v1_request + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type - _response_types_map = { - '200': "EzsignfolderGetEzsigndocumentsV1Response", - '404': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsignfolder/{pkiEzsignfolderID}/getEzsigndocuments', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='PUT', + resource_path='/1/object/ezsignfolder/{pkiEzsignfolderID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) - @validate_arguments - def ezsignfolder_get_ezsignfoldersignerassociations_v1(self, pki_ezsignfolder_id : conint(strict=True, ge=0), **kwargs) -> EzsignfolderGetEzsignfoldersignerassociationsV1Response: # noqa: E501 - """Retrieve an existing Ezsignfolder's Ezsignfoldersignerassociations # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.ezsignfolder_get_ezsignfoldersignerassociations_v1(pki_ezsignfolder_id, async_req=True) - >>> result = thread.get() - :param pki_ezsignfolder_id: (required) - :type pki_ezsignfolder_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsignfolderGetEzsignfoldersignerassociationsV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsignfolder_get_ezsignfoldersignerassociations_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsignfolder_get_ezsignfoldersignerassociations_v1_with_http_info(pki_ezsignfolder_id, **kwargs) # noqa: E501 - - @validate_arguments - def ezsignfolder_get_ezsignfoldersignerassociations_v1_with_http_info(self, pki_ezsignfolder_id : conint(strict=True, ge=0), **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve an existing Ezsignfolder's Ezsignfoldersignerassociations # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsignfolder_get_ezsignfoldersignerassociations_v1_with_http_info(pki_ezsignfolder_id, async_req=True) - >>> result = thread.get() + @validate_call + def ezsignfolder_get_actionable_elements_v1( + self, + pki_ezsignfolder_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsignfolderGetActionableElementsV1Response: + """Retrieve actionable elements for the Ezsignfolder + + Return the Ezsignsignatures that can be signed and Ezsignformfieldgroups that can be filled by the current user at the current step in the process :param pki_ezsignfolder_id: (required) :type pki_ezsignfolder_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsignfolderGetEzsignfoldersignerassociationsV1Response, status_code(int), headers(HTTPHeaderDict)) - """ - - _params = locals() - - _all_params = [ - 'pki_ezsignfolder_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' - ] + """ # noqa: E501 + + _param = self._ezsignfolder_get_actionable_elements_v1_serialize( + pki_ezsignfolder_id=pki_ezsignfolder_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsignfolder_get_ezsignfoldersignerassociations_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] - - _collection_formats = {} - - # process the path parameters - _path_params = {} - if _params['pki_ezsignfolder_id']: - _path_params['pkiEzsignfolderID'] = _params['pki_ezsignfolder_id'] - + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfolderGetActionableElementsV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsignfolder_get_actionable_elements_v1_with_http_info( + self, + pki_ezsignfolder_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsignfolderGetActionableElementsV1Response]: + """Retrieve actionable elements for the Ezsignfolder - # process the query parameters - _query_params = [] - # process the header parameters - _header_params = dict(_params.get('_headers', {})) - # process the form parameters - _form_params = [] - _files = {} - # process the body parameter - _body_params = None - # set the HTTP header `Accept` - _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + Return the Ezsignsignatures that can be signed and Ezsignformfieldgroups that can be filled by the current user at the current step in the process - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 + :param pki_ezsignfolder_id: (required) + :type pki_ezsignfolder_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignfolder_get_actionable_elements_v1_serialize( + pki_ezsignfolder_id=pki_ezsignfolder_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _response_types_map = { - '200': "EzsignfolderGetEzsignfoldersignerassociationsV1Response", + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfolderGetActionableElementsV1Response", '404': "CommonResponseError", + '422': "CommonResponseError", } - - return self.api_client.call_api( - '/1/object/ezsignfolder/{pkiEzsignfolderID}/getEzsignfoldersignerassociations', 'GET', - _path_params, - _query_params, - _header_params, - body=_body_params, - post_params=_form_params, - files=_files, + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, response_types_map=_response_types_map, - auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), - collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) - - @validate_arguments - def ezsignfolder_get_ezsignsignatures_automatic_v1(self, pki_ezsignfolder_id : conint(strict=True, ge=0), **kwargs) -> EzsignfolderGetEzsignsignaturesAutomaticV1Response: # noqa: E501 - """Retrieve an existing Ezsignfolder's automatic Ezsignsignatures # noqa: E501 + ) - Return the Ezsignsignatures that can be signed by the current user at the current step in the process # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.ezsignfolder_get_ezsignsignatures_automatic_v1(pki_ezsignfolder_id, async_req=True) - >>> result = thread.get() + @validate_call + def ezsignfolder_get_actionable_elements_v1_without_preload_content( + self, + pki_ezsignfolder_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve actionable elements for the Ezsignfolder - :param pki_ezsignfolder_id: (required) - :type pki_ezsignfolder_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsignfolderGetEzsignsignaturesAutomaticV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsignfolder_get_ezsignsignatures_automatic_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsignfolder_get_ezsignsignatures_automatic_v1_with_http_info(pki_ezsignfolder_id, **kwargs) # noqa: E501 - - @validate_arguments - def ezsignfolder_get_ezsignsignatures_automatic_v1_with_http_info(self, pki_ezsignfolder_id : conint(strict=True, ge=0), **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve an existing Ezsignfolder's automatic Ezsignsignatures # noqa: E501 - - Return the Ezsignsignatures that can be signed by the current user at the current step in the process # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsignfolder_get_ezsignsignatures_automatic_v1_with_http_info(pki_ezsignfolder_id, async_req=True) - >>> result = thread.get() + Return the Ezsignsignatures that can be signed and Ezsignformfieldgroups that can be filled by the current user at the current step in the process :param pki_ezsignfolder_id: (required) :type pki_ezsignfolder_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsignfolderGetEzsignsignaturesAutomaticV1Response, status_code(int), headers(HTTPHeaderDict)) - """ - - _params = locals() + """ # noqa: E501 + + _param = self._ezsignfolder_get_actionable_elements_v1_serialize( + pki_ezsignfolder_id=pki_ezsignfolder_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _all_params = [ - 'pki_ezsignfolder_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' - ] + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfolderGetActionableElementsV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) + return response_data.response - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsignfolder_get_ezsignsignatures_automatic_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] - _collection_formats = {} + def _ezsignfolder_get_actionable_elements_v1_serialize( + self, + pki_ezsignfolder_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: - # process the path parameters - _path_params = {} - if _params['pki_ezsignfolder_id']: - _path_params['pkiEzsignfolderID'] = _params['pki_ezsignfolder_id'] + _host = None + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if pki_ezsignfolder_id is not None: + _path_params['pkiEzsignfolderID'] = pki_ezsignfolder_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "EzsignfolderGetEzsignsignaturesAutomaticV1Response", - '404': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsignfolder/{pkiEzsignfolderID}/getEzsignsignaturesAutomatic', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/1/object/ezsignfolder/{pkiEzsignfolderID}/getActionableElements', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) - @validate_arguments - def ezsignfolder_get_forms_data_v1(self, pki_ezsignfolder_id : conint(strict=True, ge=0), **kwargs) -> EzsignfolderGetFormsDataV1Response: # noqa: E501 - """Retrieve an existing Ezsignfolder's forms data # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.ezsignfolder_get_forms_data_v1(pki_ezsignfolder_id, async_req=True) - >>> result = thread.get() - :param pki_ezsignfolder_id: (required) - :type pki_ezsignfolder_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsignfolderGetFormsDataV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsignfolder_get_forms_data_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsignfolder_get_forms_data_v1_with_http_info(pki_ezsignfolder_id, **kwargs) # noqa: E501 - - @validate_arguments - def ezsignfolder_get_forms_data_v1_with_http_info(self, pki_ezsignfolder_id : conint(strict=True, ge=0), **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve an existing Ezsignfolder's forms data # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsignfolder_get_forms_data_v1_with_http_info(pki_ezsignfolder_id, async_req=True) - >>> result = thread.get() + @validate_call + def ezsignfolder_get_attachment_count_v1( + self, + pki_ezsignfolder_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsignfolderGetAttachmentCountV1Response: + """Retrieve Attachment count + + :param pki_ezsignfolder_id: (required) :type pki_ezsignfolder_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsignfolderGetFormsDataV1Response, status_code(int), headers(HTTPHeaderDict)) - """ - - _params = locals() + """ # noqa: E501 + + _param = self._ezsignfolder_get_attachment_count_v1_serialize( + pki_ezsignfolder_id=pki_ezsignfolder_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _all_params = [ - 'pki_ezsignfolder_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfolderGetAttachmentCountV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsignfolder_get_attachment_count_v1_with_http_info( + self, + pki_ezsignfolder_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsignfolderGetAttachmentCountV1Response]: + """Retrieve Attachment count + + + + :param pki_ezsignfolder_id: (required) + :type pki_ezsignfolder_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignfolder_get_attachment_count_v1_serialize( + pki_ezsignfolder_id=pki_ezsignfolder_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsignfolder_get_forms_data_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfolderGetAttachmentCountV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_ezsignfolder_id']: - _path_params['pkiEzsignfolderID'] = _params['pki_ezsignfolder_id'] + @validate_call + def ezsignfolder_get_attachment_count_v1_without_preload_content( + self, + pki_ezsignfolder_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve Attachment count + + + + :param pki_ezsignfolder_id: (required) + :type pki_ezsignfolder_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignfolder_get_attachment_count_v1_serialize( + pki_ezsignfolder_id=pki_ezsignfolder_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfolderGetAttachmentCountV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + def _ezsignfolder_get_attachment_count_v1_serialize( + self, + pki_ezsignfolder_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_ezsignfolder_id is not None: + _path_params['pkiEzsignfolderID'] = pki_ezsignfolder_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json', 'application/zip']) # noqa: E501 + [ + 'application/json' + ] + ) + # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 + _auth_settings: List[str] = [ + 'Authorization' + ] - _response_types_map = { - '200': "EzsignfolderGetFormsDataV1Response", + return self.api_client.param_serialize( + method='GET', + resource_path='/1/object/ezsignfolder/{pkiEzsignfolderID}/getAttachmentCount', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def ezsignfolder_get_attachments_v1( + self, + pki_ezsignfolder_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsignfolderGetAttachmentsV1Response: + """Retrieve Ezsignfolder's Attachments + + + + :param pki_ezsignfolder_id: (required) + :type pki_ezsignfolder_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignfolder_get_attachments_v1_serialize( + pki_ezsignfolder_id=pki_ezsignfolder_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfolderGetAttachmentsV1Response", '404': "CommonResponseError", - '406': "CommonResponseError", - '422': "CommonResponseError", } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsignfolder_get_attachments_v1_with_http_info( + self, + pki_ezsignfolder_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsignfolderGetAttachmentsV1Response]: + """Retrieve Ezsignfolder's Attachments + + + + :param pki_ezsignfolder_id: (required) + :type pki_ezsignfolder_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignfolder_get_attachments_v1_serialize( + pki_ezsignfolder_id=pki_ezsignfolder_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfolderGetAttachmentsV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def ezsignfolder_get_attachments_v1_without_preload_content( + self, + pki_ezsignfolder_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve Ezsignfolder's Attachments + + + + :param pki_ezsignfolder_id: (required) + :type pki_ezsignfolder_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignfolder_get_attachments_v1_serialize( + pki_ezsignfolder_id=pki_ezsignfolder_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfolderGetAttachmentsV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _ezsignfolder_get_attachments_v1_serialize( + self, + pki_ezsignfolder_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_ezsignfolder_id is not None: + _path_params['pkiEzsignfolderID'] = pki_ezsignfolder_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + - return self.api_client.call_api( - '/1/object/ezsignfolder/{pkiEzsignfolderID}/getFormsData', 'GET', - _path_params, - _query_params, - _header_params, + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/1/object/ezsignfolder/{pkiEzsignfolderID}/getAttachments', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) - @validate_arguments - def ezsignfolder_get_list_v1(self, e_order_by : Annotated[Optional[StrictStr], Field(description="Specify how you want the results to be sorted")] = None, i_row_max : Optional[conint(strict=True, le=10000, ge=1)] = None, i_row_offset : Optional[conint(strict=True, ge=0)] = None, accept_language : Optional[HeaderAcceptLanguage] = None, s_filter : Optional[StrictStr] = None, **kwargs) -> EzsignfolderGetListV1Response: # noqa: E501 - """Retrieve Ezsignfolder list # noqa: E501 - Enum values that can be filtered in query parameter *sFilter*: | Variable | Valid values | |---|---| | eEzsignfolderStep | Unsent
Sent
PartiallySigned
Expired
Completed
Archived
Disposed| | eEzsignfoldertypePrivacylevel | User
Usergroup | Advanced filters that can be used in query parameter *sFilter*: | Variable | |---| | fkiUserID | | sContactFirstname | | sContactLastname | | sEzsigndocumentName | # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.ezsignfolder_get_list_v1(e_order_by, i_row_max, i_row_offset, accept_language, s_filter, async_req=True) - >>> result = thread.get() - :param e_order_by: Specify how you want the results to be sorted - :type e_order_by: str - :param i_row_max: - :type i_row_max: int - :param i_row_offset: - :type i_row_offset: int - :param accept_language: - :type accept_language: HeaderAcceptLanguage - :param s_filter: - :type s_filter: str - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsignfolderGetListV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsignfolder_get_list_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsignfolder_get_list_v1_with_http_info(e_order_by, i_row_max, i_row_offset, accept_language, s_filter, **kwargs) # noqa: E501 - - @validate_arguments - def ezsignfolder_get_list_v1_with_http_info(self, e_order_by : Annotated[Optional[StrictStr], Field(description="Specify how you want the results to be sorted")] = None, i_row_max : Optional[conint(strict=True, le=10000, ge=1)] = None, i_row_offset : Optional[conint(strict=True, ge=0)] = None, accept_language : Optional[HeaderAcceptLanguage] = None, s_filter : Optional[StrictStr] = None, **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve Ezsignfolder list # noqa: E501 - - Enum values that can be filtered in query parameter *sFilter*: | Variable | Valid values | |---|---| | eEzsignfolderStep | Unsent
Sent
PartiallySigned
Expired
Completed
Archived
Disposed| | eEzsignfoldertypePrivacylevel | User
Usergroup | Advanced filters that can be used in query parameter *sFilter*: | Variable | |---| | fkiUserID | | sContactFirstname | | sContactLastname | | sEzsigndocumentName | # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsignfolder_get_list_v1_with_http_info(e_order_by, i_row_max, i_row_offset, accept_language, s_filter, async_req=True) - >>> result = thread.get() + @validate_call + def ezsignfolder_get_communication_count_v1( + self, + pki_ezsignfolder_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsignfolderGetCommunicationCountV1Response: + """Retrieve Communication count - :param e_order_by: Specify how you want the results to be sorted - :type e_order_by: str - :param i_row_max: - :type i_row_max: int - :param i_row_offset: - :type i_row_offset: int - :param accept_language: - :type accept_language: HeaderAcceptLanguage - :param s_filter: - :type s_filter: str - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional + + + :param pki_ezsignfolder_id: (required) + :type pki_ezsignfolder_id: int :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsignfolderGetListV1Response, status_code(int), headers(HTTPHeaderDict)) - """ - - _params = locals() - - _all_params = [ - 'e_order_by', - 'i_row_max', - 'i_row_offset', - 'accept_language', - 's_filter' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + """ # noqa: E501 + + _param = self._ezsignfolder_get_communication_count_v1_serialize( + pki_ezsignfolder_id=pki_ezsignfolder_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfolderGetCommunicationCountV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsignfolder_get_communication_count_v1_with_http_info( + self, + pki_ezsignfolder_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsignfolderGetCommunicationCountV1Response]: + """Retrieve Communication count + + + + :param pki_ezsignfolder_id: (required) + :type pki_ezsignfolder_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignfolder_get_communication_count_v1_serialize( + pki_ezsignfolder_id=pki_ezsignfolder_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsignfolder_get_list_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfolderGetCommunicationCountV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _collection_formats = {} - # process the path parameters - _path_params = {} + @validate_call + def ezsignfolder_get_communication_count_v1_without_preload_content( + self, + pki_ezsignfolder_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve Communication count - # process the query parameters - _query_params = [] - if _params.get('e_order_by') is not None: # noqa: E501 - _query_params.append(('eOrderBy', _params['e_order_by'])) + + + :param pki_ezsignfolder_id: (required) + :type pki_ezsignfolder_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignfolder_get_communication_count_v1_serialize( + pki_ezsignfolder_id=pki_ezsignfolder_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - if _params.get('i_row_max') is not None: # noqa: E501 - _query_params.append(('iRowMax', _params['i_row_max'])) + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfolderGetCommunicationCountV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - if _params.get('i_row_offset') is not None: # noqa: E501 - _query_params.append(('iRowOffset', _params['i_row_offset'])) - if _params.get('s_filter') is not None: # noqa: E501 - _query_params.append(('sFilter', _params['s_filter'])) + def _ezsignfolder_get_communication_count_v1_serialize( + self, + pki_ezsignfolder_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: - # process the header parameters - _header_params = dict(_params.get('_headers', {})) - if _params['accept_language']: - _header_params['Accept-Language'] = _params['accept_language'] + _host = None + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_ezsignfolder_id is not None: + _path_params['pkiEzsignfolderID'] = pki_ezsignfolder_id + # process the query parameters + # process the header parameters # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "EzsignfolderGetListV1Response", - '406': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsignfolder/getList', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/1/object/ezsignfolder/{pkiEzsignfolderID}/getCommunicationCount', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def ezsignfolder_get_communication_list_v1( + self, + pki_ezsignfolder_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsignfolderGetCommunicationListV1Response: + """Retrieve Communication list - @validate_arguments - def ezsignfolder_get_object_v1(self, pki_ezsignfolder_id : conint(strict=True, ge=0), **kwargs) -> EzsignfolderGetObjectV1Response: # noqa: E501 - """(Deprecated) Retrieve an existing Ezsignfolder # noqa: E501 + + + :param pki_ezsignfolder_id: (required) + :type pki_ezsignfolder_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignfolder_get_communication_list_v1_serialize( + pki_ezsignfolder_id=pki_ezsignfolder_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfolderGetCommunicationListV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsignfolder_get_communication_list_v1_with_http_info( + self, + pki_ezsignfolder_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsignfolderGetCommunicationListV1Response]: + """Retrieve Communication list + + + + :param pki_ezsignfolder_id: (required) + :type pki_ezsignfolder_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignfolder_get_communication_list_v1_serialize( + pki_ezsignfolder_id=pki_ezsignfolder_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfolderGetCommunicationListV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def ezsignfolder_get_communication_list_v1_without_preload_content( + self, + pki_ezsignfolder_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve Communication list + + + + :param pki_ezsignfolder_id: (required) + :type pki_ezsignfolder_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignfolder_get_communication_list_v1_serialize( + pki_ezsignfolder_id=pki_ezsignfolder_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfolderGetCommunicationListV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _ezsignfolder_get_communication_list_v1_serialize( + self, + pki_ezsignfolder_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_ezsignfolder_id is not None: + _path_params['pkiEzsignfolderID'] = pki_ezsignfolder_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/1/object/ezsignfolder/{pkiEzsignfolderID}/getCommunicationList', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def ezsignfolder_get_communicationrecipients_v1( + self, + pki_ezsignfolder_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsignfolderGetCommunicationrecipientsV1Response: + """Retrieve Ezsignfolder's Communicationrecipient + + + + :param pki_ezsignfolder_id: (required) + :type pki_ezsignfolder_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignfolder_get_communicationrecipients_v1_serialize( + pki_ezsignfolder_id=pki_ezsignfolder_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfolderGetCommunicationrecipientsV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsignfolder_get_communicationrecipients_v1_with_http_info( + self, + pki_ezsignfolder_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsignfolderGetCommunicationrecipientsV1Response]: + """Retrieve Ezsignfolder's Communicationrecipient + + + + :param pki_ezsignfolder_id: (required) + :type pki_ezsignfolder_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignfolder_get_communicationrecipients_v1_serialize( + pki_ezsignfolder_id=pki_ezsignfolder_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfolderGetCommunicationrecipientsV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def ezsignfolder_get_communicationrecipients_v1_without_preload_content( + self, + pki_ezsignfolder_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve Ezsignfolder's Communicationrecipient + + + + :param pki_ezsignfolder_id: (required) + :type pki_ezsignfolder_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignfolder_get_communicationrecipients_v1_serialize( + pki_ezsignfolder_id=pki_ezsignfolder_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfolderGetCommunicationrecipientsV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _ezsignfolder_get_communicationrecipients_v1_serialize( + self, + pki_ezsignfolder_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_ezsignfolder_id is not None: + _path_params['pkiEzsignfolderID'] = pki_ezsignfolder_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/1/object/ezsignfolder/{pkiEzsignfolderID}/getCommunicationrecipients', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def ezsignfolder_get_communicationsenders_v1( + self, + pki_ezsignfolder_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsignfolderGetCommunicationsendersV1Response: + """Retrieve Ezsignfolder's Communicationsender + + + + :param pki_ezsignfolder_id: (required) + :type pki_ezsignfolder_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignfolder_get_communicationsenders_v1_serialize( + pki_ezsignfolder_id=pki_ezsignfolder_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfolderGetCommunicationsendersV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsignfolder_get_communicationsenders_v1_with_http_info( + self, + pki_ezsignfolder_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsignfolderGetCommunicationsendersV1Response]: + """Retrieve Ezsignfolder's Communicationsender + + + + :param pki_ezsignfolder_id: (required) + :type pki_ezsignfolder_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignfolder_get_communicationsenders_v1_serialize( + pki_ezsignfolder_id=pki_ezsignfolder_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfolderGetCommunicationsendersV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def ezsignfolder_get_communicationsenders_v1_without_preload_content( + self, + pki_ezsignfolder_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve Ezsignfolder's Communicationsender + + + + :param pki_ezsignfolder_id: (required) + :type pki_ezsignfolder_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignfolder_get_communicationsenders_v1_serialize( + pki_ezsignfolder_id=pki_ezsignfolder_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfolderGetCommunicationsendersV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _ezsignfolder_get_communicationsenders_v1_serialize( + self, + pki_ezsignfolder_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_ezsignfolder_id is not None: + _path_params['pkiEzsignfolderID'] = pki_ezsignfolder_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/1/object/ezsignfolder/{pkiEzsignfolderID}/getCommunicationsenders', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def ezsignfolder_get_ezsigndocuments_v1( + self, + pki_ezsignfolder_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsignfolderGetEzsigndocumentsV1Response: + """Retrieve an existing Ezsignfolder's Ezsigndocuments + + + + :param pki_ezsignfolder_id: (required) + :type pki_ezsignfolder_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignfolder_get_ezsigndocuments_v1_serialize( + pki_ezsignfolder_id=pki_ezsignfolder_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfolderGetEzsigndocumentsV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsignfolder_get_ezsigndocuments_v1_with_http_info( + self, + pki_ezsignfolder_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsignfolderGetEzsigndocumentsV1Response]: + """Retrieve an existing Ezsignfolder's Ezsigndocuments + + + + :param pki_ezsignfolder_id: (required) + :type pki_ezsignfolder_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignfolder_get_ezsigndocuments_v1_serialize( + pki_ezsignfolder_id=pki_ezsignfolder_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfolderGetEzsigndocumentsV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def ezsignfolder_get_ezsigndocuments_v1_without_preload_content( + self, + pki_ezsignfolder_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve an existing Ezsignfolder's Ezsigndocuments + + + + :param pki_ezsignfolder_id: (required) + :type pki_ezsignfolder_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignfolder_get_ezsigndocuments_v1_serialize( + pki_ezsignfolder_id=pki_ezsignfolder_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfolderGetEzsigndocumentsV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _ezsignfolder_get_ezsigndocuments_v1_serialize( + self, + pki_ezsignfolder_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_ezsignfolder_id is not None: + _path_params['pkiEzsignfolderID'] = pki_ezsignfolder_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/1/object/ezsignfolder/{pkiEzsignfolderID}/getEzsigndocuments', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def ezsignfolder_get_ezsignfoldersignerassociations_v1( + self, + pki_ezsignfolder_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsignfolderGetEzsignfoldersignerassociationsV1Response: + """Retrieve an existing Ezsignfolder's Ezsignfoldersignerassociations + + + + :param pki_ezsignfolder_id: (required) + :type pki_ezsignfolder_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignfolder_get_ezsignfoldersignerassociations_v1_serialize( + pki_ezsignfolder_id=pki_ezsignfolder_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfolderGetEzsignfoldersignerassociationsV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsignfolder_get_ezsignfoldersignerassociations_v1_with_http_info( + self, + pki_ezsignfolder_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsignfolderGetEzsignfoldersignerassociationsV1Response]: + """Retrieve an existing Ezsignfolder's Ezsignfoldersignerassociations + + + + :param pki_ezsignfolder_id: (required) + :type pki_ezsignfolder_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignfolder_get_ezsignfoldersignerassociations_v1_serialize( + pki_ezsignfolder_id=pki_ezsignfolder_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfolderGetEzsignfoldersignerassociationsV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def ezsignfolder_get_ezsignfoldersignerassociations_v1_without_preload_content( + self, + pki_ezsignfolder_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve an existing Ezsignfolder's Ezsignfoldersignerassociations + + + + :param pki_ezsignfolder_id: (required) + :type pki_ezsignfolder_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignfolder_get_ezsignfoldersignerassociations_v1_serialize( + pki_ezsignfolder_id=pki_ezsignfolder_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfolderGetEzsignfoldersignerassociationsV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _ezsignfolder_get_ezsignfoldersignerassociations_v1_serialize( + self, + pki_ezsignfolder_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_ezsignfolder_id is not None: + _path_params['pkiEzsignfolderID'] = pki_ezsignfolder_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/1/object/ezsignfolder/{pkiEzsignfolderID}/getEzsignfoldersignerassociations', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def ezsignfolder_get_ezsignsignatures_automatic_v1( + self, + pki_ezsignfolder_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsignfolderGetEzsignsignaturesAutomaticV1Response: + """Retrieve an existing Ezsignfolder's automatic Ezsignsignatures + + Return the Ezsignsignatures that can be signed by the current user at the current step in the process + + :param pki_ezsignfolder_id: (required) + :type pki_ezsignfolder_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignfolder_get_ezsignsignatures_automatic_v1_serialize( + pki_ezsignfolder_id=pki_ezsignfolder_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfolderGetEzsignsignaturesAutomaticV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsignfolder_get_ezsignsignatures_automatic_v1_with_http_info( + self, + pki_ezsignfolder_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsignfolderGetEzsignsignaturesAutomaticV1Response]: + """Retrieve an existing Ezsignfolder's automatic Ezsignsignatures + + Return the Ezsignsignatures that can be signed by the current user at the current step in the process + + :param pki_ezsignfolder_id: (required) + :type pki_ezsignfolder_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignfolder_get_ezsignsignatures_automatic_v1_serialize( + pki_ezsignfolder_id=pki_ezsignfolder_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfolderGetEzsignsignaturesAutomaticV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def ezsignfolder_get_ezsignsignatures_automatic_v1_without_preload_content( + self, + pki_ezsignfolder_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve an existing Ezsignfolder's automatic Ezsignsignatures + + Return the Ezsignsignatures that can be signed by the current user at the current step in the process + + :param pki_ezsignfolder_id: (required) + :type pki_ezsignfolder_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignfolder_get_ezsignsignatures_automatic_v1_serialize( + pki_ezsignfolder_id=pki_ezsignfolder_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfolderGetEzsignsignaturesAutomaticV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _ezsignfolder_get_ezsignsignatures_automatic_v1_serialize( + self, + pki_ezsignfolder_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_ezsignfolder_id is not None: + _path_params['pkiEzsignfolderID'] = pki_ezsignfolder_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/1/object/ezsignfolder/{pkiEzsignfolderID}/getEzsignsignaturesAutomatic', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def ezsignfolder_get_forms_data_v1( + self, + pki_ezsignfolder_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsignfolderGetFormsDataV1Response: + """Retrieve an existing Ezsignfolder's forms data + + + + :param pki_ezsignfolder_id: (required) + :type pki_ezsignfolder_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignfolder_get_forms_data_v1_serialize( + pki_ezsignfolder_id=pki_ezsignfolder_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfolderGetFormsDataV1Response", + '404': "CommonResponseError", + '406': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsignfolder_get_forms_data_v1_with_http_info( + self, + pki_ezsignfolder_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsignfolderGetFormsDataV1Response]: + """Retrieve an existing Ezsignfolder's forms data + + + + :param pki_ezsignfolder_id: (required) + :type pki_ezsignfolder_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignfolder_get_forms_data_v1_serialize( + pki_ezsignfolder_id=pki_ezsignfolder_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfolderGetFormsDataV1Response", + '404': "CommonResponseError", + '406': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def ezsignfolder_get_forms_data_v1_without_preload_content( + self, + pki_ezsignfolder_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve an existing Ezsignfolder's forms data + + + + :param pki_ezsignfolder_id: (required) + :type pki_ezsignfolder_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignfolder_get_forms_data_v1_serialize( + pki_ezsignfolder_id=pki_ezsignfolder_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfolderGetFormsDataV1Response", + '404': "CommonResponseError", + '406': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _ezsignfolder_get_forms_data_v1_serialize( + self, + pki_ezsignfolder_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_ezsignfolder_id is not None: + _path_params['pkiEzsignfolderID'] = pki_ezsignfolder_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json', + 'application/zip' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/1/object/ezsignfolder/{pkiEzsignfolderID}/getFormsData', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def ezsignfolder_get_list_v1( + self, + e_order_by: Annotated[Optional[StrictStr], Field(description="Specify how you want the results to be sorted")] = None, + i_row_max: Optional[Annotated[int, Field(le=10000, strict=True, ge=1)]] = None, + i_row_offset: Optional[Annotated[int, Field(strict=True, ge=0)]] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + s_filter: Optional[StrictStr] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsignfolderGetListV1Response: + """Retrieve Ezsignfolder list + + Enum values that can be filtered in query parameter *sFilter*: | Variable | Valid values | |---|---| | eEzsignfolderStep | Unsent
Sent
PartiallySigned
Expired
Completed
Archived
Disposed| | eEzsignfoldertypePrivacylevel | User
Usergroup | Advanced filters that can be used in query parameter *sFilter*: | Variable | |---| | fkiUserID | | sContactFirstname | | sContactLastname | | sEzsigndocumentName | + + :param e_order_by: Specify how you want the results to be sorted + :type e_order_by: str + :param i_row_max: + :type i_row_max: int + :param i_row_offset: + :type i_row_offset: int + :param accept_language: + :type accept_language: HeaderAcceptLanguage + :param s_filter: + :type s_filter: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignfolder_get_list_v1_serialize( + e_order_by=e_order_by, + i_row_max=i_row_max, + i_row_offset=i_row_offset, + accept_language=accept_language, + s_filter=s_filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfolderGetListV1Response", + '406': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsignfolder_get_list_v1_with_http_info( + self, + e_order_by: Annotated[Optional[StrictStr], Field(description="Specify how you want the results to be sorted")] = None, + i_row_max: Optional[Annotated[int, Field(le=10000, strict=True, ge=1)]] = None, + i_row_offset: Optional[Annotated[int, Field(strict=True, ge=0)]] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + s_filter: Optional[StrictStr] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsignfolderGetListV1Response]: + """Retrieve Ezsignfolder list + + Enum values that can be filtered in query parameter *sFilter*: | Variable | Valid values | |---|---| | eEzsignfolderStep | Unsent
Sent
PartiallySigned
Expired
Completed
Archived
Disposed| | eEzsignfoldertypePrivacylevel | User
Usergroup | Advanced filters that can be used in query parameter *sFilter*: | Variable | |---| | fkiUserID | | sContactFirstname | | sContactLastname | | sEzsigndocumentName | + + :param e_order_by: Specify how you want the results to be sorted + :type e_order_by: str + :param i_row_max: + :type i_row_max: int + :param i_row_offset: + :type i_row_offset: int + :param accept_language: + :type accept_language: HeaderAcceptLanguage + :param s_filter: + :type s_filter: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignfolder_get_list_v1_serialize( + e_order_by=e_order_by, + i_row_max=i_row_max, + i_row_offset=i_row_offset, + accept_language=accept_language, + s_filter=s_filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfolderGetListV1Response", + '406': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def ezsignfolder_get_list_v1_without_preload_content( + self, + e_order_by: Annotated[Optional[StrictStr], Field(description="Specify how you want the results to be sorted")] = None, + i_row_max: Optional[Annotated[int, Field(le=10000, strict=True, ge=1)]] = None, + i_row_offset: Optional[Annotated[int, Field(strict=True, ge=0)]] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + s_filter: Optional[StrictStr] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve Ezsignfolder list + + Enum values that can be filtered in query parameter *sFilter*: | Variable | Valid values | |---|---| | eEzsignfolderStep | Unsent
Sent
PartiallySigned
Expired
Completed
Archived
Disposed| | eEzsignfoldertypePrivacylevel | User
Usergroup | Advanced filters that can be used in query parameter *sFilter*: | Variable | |---| | fkiUserID | | sContactFirstname | | sContactLastname | | sEzsigndocumentName | + + :param e_order_by: Specify how you want the results to be sorted + :type e_order_by: str + :param i_row_max: + :type i_row_max: int + :param i_row_offset: + :type i_row_offset: int + :param accept_language: + :type accept_language: HeaderAcceptLanguage + :param s_filter: + :type s_filter: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignfolder_get_list_v1_serialize( + e_order_by=e_order_by, + i_row_max=i_row_max, + i_row_offset=i_row_offset, + accept_language=accept_language, + s_filter=s_filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfolderGetListV1Response", + '406': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _ezsignfolder_get_list_v1_serialize( + self, + e_order_by, + i_row_max, + i_row_offset, + accept_language, + s_filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if e_order_by is not None: + + _query_params.append(('eOrderBy', e_order_by)) + + if i_row_max is not None: + + _query_params.append(('iRowMax', i_row_max)) + + if i_row_offset is not None: + + _query_params.append(('iRowOffset', i_row_offset)) + + if s_filter is not None: + + _query_params.append(('sFilter', s_filter)) + + # process the header parameters + if accept_language is not None: + _header_params['Accept-Language'] = accept_language + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json', + 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/1/object/ezsignfolder/getList', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def ezsignfolder_get_object_v1( + self, + pki_ezsignfolder_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsignfolderGetObjectV1Response: + """(Deprecated) Retrieve an existing Ezsignfolder + + + :param pki_ezsignfolder_id: (required) + :type pki_ezsignfolder_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + warnings.warn("GET /1/object/ezsignfolder/{pkiEzsignfolderID} is deprecated.", DeprecationWarning) + + _param = self._ezsignfolder_get_object_v1_serialize( + pki_ezsignfolder_id=pki_ezsignfolder_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfolderGetObjectV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsignfolder_get_object_v1_with_http_info( + self, + pki_ezsignfolder_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsignfolderGetObjectV1Response]: + """(Deprecated) Retrieve an existing Ezsignfolder + + + :param pki_ezsignfolder_id: (required) + :type pki_ezsignfolder_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + warnings.warn("GET /1/object/ezsignfolder/{pkiEzsignfolderID} is deprecated.", DeprecationWarning) + + _param = self._ezsignfolder_get_object_v1_serialize( + pki_ezsignfolder_id=pki_ezsignfolder_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfolderGetObjectV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def ezsignfolder_get_object_v1_without_preload_content( + self, + pki_ezsignfolder_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """(Deprecated) Retrieve an existing Ezsignfolder + + + :param pki_ezsignfolder_id: (required) + :type pki_ezsignfolder_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + warnings.warn("GET /1/object/ezsignfolder/{pkiEzsignfolderID} is deprecated.", DeprecationWarning) + + _param = self._ezsignfolder_get_object_v1_serialize( + pki_ezsignfolder_id=pki_ezsignfolder_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfolderGetObjectV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _ezsignfolder_get_object_v1_serialize( + self, + pki_ezsignfolder_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_ezsignfolder_id is not None: + _path_params['pkiEzsignfolderID'] = pki_ezsignfolder_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/1/object/ezsignfolder/{pkiEzsignfolderID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def ezsignfolder_get_object_v2( + self, + pki_ezsignfolder_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsignfolderGetObjectV2Response: + """Retrieve an existing Ezsignfolder + + + + :param pki_ezsignfolder_id: (required) + :type pki_ezsignfolder_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignfolder_get_object_v2_serialize( + pki_ezsignfolder_id=pki_ezsignfolder_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfolderGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsignfolder_get_object_v2_with_http_info( + self, + pki_ezsignfolder_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsignfolderGetObjectV2Response]: + """Retrieve an existing Ezsignfolder + + + + :param pki_ezsignfolder_id: (required) + :type pki_ezsignfolder_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignfolder_get_object_v2_serialize( + pki_ezsignfolder_id=pki_ezsignfolder_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfolderGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def ezsignfolder_get_object_v2_without_preload_content( + self, + pki_ezsignfolder_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve an existing Ezsignfolder + + + + :param pki_ezsignfolder_id: (required) + :type pki_ezsignfolder_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignfolder_get_object_v2_serialize( + pki_ezsignfolder_id=pki_ezsignfolder_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfolderGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _ezsignfolder_get_object_v2_serialize( + self, + pki_ezsignfolder_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_ezsignfolder_id is not None: + _path_params['pkiEzsignfolderID'] = pki_ezsignfolder_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/2/object/ezsignfolder/{pkiEzsignfolderID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def ezsignfolder_import_ezsignfoldersignerassociations_v1( + self, + pki_ezsignfolder_id: Annotated[int, Field(strict=True, ge=0)], + ezsignfolder_import_ezsignfoldersignerassociations_v1_request: EzsignfolderImportEzsignfoldersignerassociationsV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsignfolderImportEzsignfoldersignerassociationsV1Response: + """Import an existing Ezsignfoldersignerassociation into this Ezsignfolder + + + + :param pki_ezsignfolder_id: (required) + :type pki_ezsignfolder_id: int + :param ezsignfolder_import_ezsignfoldersignerassociations_v1_request: (required) + :type ezsignfolder_import_ezsignfoldersignerassociations_v1_request: EzsignfolderImportEzsignfoldersignerassociationsV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignfolder_import_ezsignfoldersignerassociations_v1_serialize( + pki_ezsignfolder_id=pki_ezsignfolder_id, + ezsignfolder_import_ezsignfoldersignerassociations_v1_request=ezsignfolder_import_ezsignfoldersignerassociations_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfolderImportEzsignfoldersignerassociationsV1Response", + '403': "CommonResponseError", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsignfolder_import_ezsignfoldersignerassociations_v1_with_http_info( + self, + pki_ezsignfolder_id: Annotated[int, Field(strict=True, ge=0)], + ezsignfolder_import_ezsignfoldersignerassociations_v1_request: EzsignfolderImportEzsignfoldersignerassociationsV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsignfolderImportEzsignfoldersignerassociationsV1Response]: + """Import an existing Ezsignfoldersignerassociation into this Ezsignfolder + + + + :param pki_ezsignfolder_id: (required) + :type pki_ezsignfolder_id: int + :param ezsignfolder_import_ezsignfoldersignerassociations_v1_request: (required) + :type ezsignfolder_import_ezsignfoldersignerassociations_v1_request: EzsignfolderImportEzsignfoldersignerassociationsV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignfolder_import_ezsignfoldersignerassociations_v1_serialize( + pki_ezsignfolder_id=pki_ezsignfolder_id, + ezsignfolder_import_ezsignfoldersignerassociations_v1_request=ezsignfolder_import_ezsignfoldersignerassociations_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfolderImportEzsignfoldersignerassociationsV1Response", + '403': "CommonResponseError", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.ezsignfolder_get_object_v1(pki_ezsignfolder_id, async_req=True) - >>> result = thread.get() + @validate_call + def ezsignfolder_import_ezsignfoldersignerassociations_v1_without_preload_content( + self, + pki_ezsignfolder_id: Annotated[int, Field(strict=True, ge=0)], + ezsignfolder_import_ezsignfoldersignerassociations_v1_request: EzsignfolderImportEzsignfoldersignerassociationsV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Import an existing Ezsignfoldersignerassociation into this Ezsignfolder - :param pki_ezsignfolder_id: (required) - :type pki_ezsignfolder_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsignfolderGetObjectV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsignfolder_get_object_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsignfolder_get_object_v1_with_http_info(pki_ezsignfolder_id, **kwargs) # noqa: E501 - - @validate_arguments - def ezsignfolder_get_object_v1_with_http_info(self, pki_ezsignfolder_id : conint(strict=True, ge=0), **kwargs) -> ApiResponse: # noqa: E501 - """(Deprecated) Retrieve an existing Ezsignfolder # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsignfolder_get_object_v1_with_http_info(pki_ezsignfolder_id, async_req=True) - >>> result = thread.get() + :param pki_ezsignfolder_id: (required) :type pki_ezsignfolder_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional + :param ezsignfolder_import_ezsignfoldersignerassociations_v1_request: (required) + :type ezsignfolder_import_ezsignfoldersignerassociations_v1_request: EzsignfolderImportEzsignfoldersignerassociationsV1Request :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsignfolderGetObjectV1Response, status_code(int), headers(HTTPHeaderDict)) - """ - - warnings.warn("GET /1/object/ezsignfolder/{pkiEzsignfolderID} is deprecated.", DeprecationWarning) - - _params = locals() + """ # noqa: E501 + + _param = self._ezsignfolder_import_ezsignfoldersignerassociations_v1_serialize( + pki_ezsignfolder_id=pki_ezsignfolder_id, + ezsignfolder_import_ezsignfoldersignerassociations_v1_request=ezsignfolder_import_ezsignfoldersignerassociations_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _all_params = [ - 'pki_ezsignfolder_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' - ] + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfolderImportEzsignfoldersignerassociationsV1Response", + '403': "CommonResponseError", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) + return response_data.response - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsignfolder_get_object_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] - _collection_formats = {} + def _ezsignfolder_import_ezsignfoldersignerassociations_v1_serialize( + self, + pki_ezsignfolder_id, + ezsignfolder_import_ezsignfoldersignerassociations_v1_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: - # process the path parameters - _path_params = {} - if _params['pki_ezsignfolder_id']: - _path_params['pkiEzsignfolderID'] = _params['pki_ezsignfolder_id'] + _host = None + + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if pki_ezsignfolder_id is not None: + _path_params['pkiEzsignfolderID'] = pki_ezsignfolder_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + if ezsignfolder_import_ezsignfoldersignerassociations_v1_request is not None: + _body_params = ezsignfolder_import_ezsignfoldersignerassociations_v1_request + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type - _response_types_map = { - '200': "EzsignfolderGetObjectV1Response", - '404': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsignfolder/{pkiEzsignfolderID}', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='POST', + resource_path='/1/object/ezsignfolder/{pkiEzsignfolderID}/importEzsignfoldersignerassociations', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) - @validate_arguments - def ezsignfolder_get_object_v2(self, pki_ezsignfolder_id : conint(strict=True, ge=0), **kwargs) -> EzsignfolderGetObjectV2Response: # noqa: E501 - """Retrieve an existing Ezsignfolder # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.ezsignfolder_get_object_v2(pki_ezsignfolder_id, async_req=True) - >>> result = thread.get() - :param pki_ezsignfolder_id: (required) - :type pki_ezsignfolder_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsignfolderGetObjectV2Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsignfolder_get_object_v2_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsignfolder_get_object_v2_with_http_info(pki_ezsignfolder_id, **kwargs) # noqa: E501 - - @validate_arguments - def ezsignfolder_get_object_v2_with_http_info(self, pki_ezsignfolder_id : conint(strict=True, ge=0), **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve an existing Ezsignfolder # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsignfolder_get_object_v2_with_http_info(pki_ezsignfolder_id, async_req=True) - >>> result = thread.get() + @validate_call + def ezsignfolder_import_ezsigntemplatepackage_v1( + self, + pki_ezsignfolder_id: Annotated[int, Field(strict=True, ge=0)], + ezsignfolder_import_ezsigntemplatepackage_v1_request: EzsignfolderImportEzsigntemplatepackageV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsignfolderImportEzsigntemplatepackageV1Response: + """Import an Ezsigntemplatepackage in the Ezsignfolder. + + This endpoint imports all of the Ezsigntemplates from the Ezsigntemplatepackage into the Ezsignfolder as Ezsigndocuments. This allows to automatically apply all the Ezsigntemplateformfieldgroups and Ezsigntemplatesignatures on the newly created Ezsigndocuments in a single step. :param pki_ezsignfolder_id: (required) :type pki_ezsignfolder_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional + :param ezsignfolder_import_ezsigntemplatepackage_v1_request: (required) + :type ezsignfolder_import_ezsigntemplatepackage_v1_request: EzsignfolderImportEzsigntemplatepackageV1Request :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsignfolderGetObjectV2Response, status_code(int), headers(HTTPHeaderDict)) - """ - - _params = locals() - - _all_params = [ - 'pki_ezsignfolder_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' - ] + """ # noqa: E501 + + _param = self._ezsignfolder_import_ezsigntemplatepackage_v1_serialize( + pki_ezsignfolder_id=pki_ezsignfolder_id, + ezsignfolder_import_ezsigntemplatepackage_v1_request=ezsignfolder_import_ezsigntemplatepackage_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsignfolder_get_object_v2" % _key - ) - _params[_key] = _val - del _params['kwargs'] - - _collection_formats = {} - - # process the path parameters - _path_params = {} - if _params['pki_ezsignfolder_id']: - _path_params['pkiEzsignfolderID'] = _params['pki_ezsignfolder_id'] - + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfolderImportEzsigntemplatepackageV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsignfolder_import_ezsigntemplatepackage_v1_with_http_info( + self, + pki_ezsignfolder_id: Annotated[int, Field(strict=True, ge=0)], + ezsignfolder_import_ezsigntemplatepackage_v1_request: EzsignfolderImportEzsigntemplatepackageV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsignfolderImportEzsigntemplatepackageV1Response]: + """Import an Ezsigntemplatepackage in the Ezsignfolder. - # process the query parameters - _query_params = [] - # process the header parameters - _header_params = dict(_params.get('_headers', {})) - # process the form parameters - _form_params = [] - _files = {} - # process the body parameter - _body_params = None - # set the HTTP header `Accept` - _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + This endpoint imports all of the Ezsigntemplates from the Ezsigntemplatepackage into the Ezsignfolder as Ezsigndocuments. This allows to automatically apply all the Ezsigntemplateformfieldgroups and Ezsigntemplatesignatures on the newly created Ezsigndocuments in a single step. - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 + :param pki_ezsignfolder_id: (required) + :type pki_ezsignfolder_id: int + :param ezsignfolder_import_ezsigntemplatepackage_v1_request: (required) + :type ezsignfolder_import_ezsigntemplatepackage_v1_request: EzsignfolderImportEzsigntemplatepackageV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignfolder_import_ezsigntemplatepackage_v1_serialize( + pki_ezsignfolder_id=pki_ezsignfolder_id, + ezsignfolder_import_ezsigntemplatepackage_v1_request=ezsignfolder_import_ezsigntemplatepackage_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _response_types_map = { - '200': "EzsignfolderGetObjectV2Response", + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfolderImportEzsigntemplatepackageV1Response", '404': "CommonResponseError", + '422': "CommonResponseError", } - - return self.api_client.call_api( - '/2/object/ezsignfolder/{pkiEzsignfolderID}', 'GET', - _path_params, - _query_params, - _header_params, - body=_body_params, - post_params=_form_params, - files=_files, + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, response_types_map=_response_types_map, - auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), - collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) - - @validate_arguments - def ezsignfolder_import_ezsignfoldersignerassociations_v1(self, pki_ezsignfolder_id : conint(strict=True, ge=0), ezsignfolder_import_ezsignfoldersignerassociations_v1_request : EzsignfolderImportEzsignfoldersignerassociationsV1Request, **kwargs) -> EzsignfolderImportEzsignfoldersignerassociationsV1Response: # noqa: E501 - """Import an existing Ezsignfoldersignerassociation into this Ezsignfolder # noqa: E501 + ) - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.ezsignfolder_import_ezsignfoldersignerassociations_v1(pki_ezsignfolder_id, ezsignfolder_import_ezsignfoldersignerassociations_v1_request, async_req=True) - >>> result = thread.get() + @validate_call + def ezsignfolder_import_ezsigntemplatepackage_v1_without_preload_content( + self, + pki_ezsignfolder_id: Annotated[int, Field(strict=True, ge=0)], + ezsignfolder_import_ezsigntemplatepackage_v1_request: EzsignfolderImportEzsigntemplatepackageV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Import an Ezsigntemplatepackage in the Ezsignfolder. - :param pki_ezsignfolder_id: (required) - :type pki_ezsignfolder_id: int - :param ezsignfolder_import_ezsignfoldersignerassociations_v1_request: (required) - :type ezsignfolder_import_ezsignfoldersignerassociations_v1_request: EzsignfolderImportEzsignfoldersignerassociationsV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsignfolderImportEzsignfoldersignerassociationsV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsignfolder_import_ezsignfoldersignerassociations_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsignfolder_import_ezsignfoldersignerassociations_v1_with_http_info(pki_ezsignfolder_id, ezsignfolder_import_ezsignfoldersignerassociations_v1_request, **kwargs) # noqa: E501 - - @validate_arguments - def ezsignfolder_import_ezsignfoldersignerassociations_v1_with_http_info(self, pki_ezsignfolder_id : conint(strict=True, ge=0), ezsignfolder_import_ezsignfoldersignerassociations_v1_request : EzsignfolderImportEzsignfoldersignerassociationsV1Request, **kwargs) -> ApiResponse: # noqa: E501 - """Import an existing Ezsignfoldersignerassociation into this Ezsignfolder # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsignfolder_import_ezsignfoldersignerassociations_v1_with_http_info(pki_ezsignfolder_id, ezsignfolder_import_ezsignfoldersignerassociations_v1_request, async_req=True) - >>> result = thread.get() + This endpoint imports all of the Ezsigntemplates from the Ezsigntemplatepackage into the Ezsignfolder as Ezsigndocuments. This allows to automatically apply all the Ezsigntemplateformfieldgroups and Ezsigntemplatesignatures on the newly created Ezsigndocuments in a single step. :param pki_ezsignfolder_id: (required) :type pki_ezsignfolder_id: int - :param ezsignfolder_import_ezsignfoldersignerassociations_v1_request: (required) - :type ezsignfolder_import_ezsignfoldersignerassociations_v1_request: EzsignfolderImportEzsignfoldersignerassociationsV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional + :param ezsignfolder_import_ezsigntemplatepackage_v1_request: (required) + :type ezsignfolder_import_ezsigntemplatepackage_v1_request: EzsignfolderImportEzsigntemplatepackageV1Request :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsignfolderImportEzsignfoldersignerassociationsV1Response, status_code(int), headers(HTTPHeaderDict)) - """ - - _params = locals() + """ # noqa: E501 + + _param = self._ezsignfolder_import_ezsigntemplatepackage_v1_serialize( + pki_ezsignfolder_id=pki_ezsignfolder_id, + ezsignfolder_import_ezsigntemplatepackage_v1_request=ezsignfolder_import_ezsigntemplatepackage_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _all_params = [ - 'pki_ezsignfolder_id', - 'ezsignfolder_import_ezsignfoldersignerassociations_v1_request' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' - ] + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfolderImportEzsigntemplatepackageV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) + return response_data.response - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsignfolder_import_ezsignfoldersignerassociations_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] - _collection_formats = {} + def _ezsignfolder_import_ezsigntemplatepackage_v1_serialize( + self, + pki_ezsignfolder_id, + ezsignfolder_import_ezsigntemplatepackage_v1_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: - # process the path parameters - _path_params = {} - if _params['pki_ezsignfolder_id']: - _path_params['pkiEzsignfolderID'] = _params['pki_ezsignfolder_id'] + _host = None + + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if pki_ezsignfolder_id is not None: + _path_params['pkiEzsignfolderID'] = pki_ezsignfolder_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['ezsignfolder_import_ezsignfoldersignerassociations_v1_request'] is not None: - _body_params = _params['ezsignfolder_import_ezsignfoldersignerassociations_v1_request'] + if ezsignfolder_import_ezsigntemplatepackage_v1_request is not None: + _body_params = ezsignfolder_import_ezsigntemplatepackage_v1_request + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '200': "EzsignfolderImportEzsignfoldersignerassociationsV1Response", - '403': "CommonResponseError", - '404': "CommonResponseError", - '422': "CommonResponseError", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsignfolder/{pkiEzsignfolderID}/importEzsignfoldersignerassociations', 'POST', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='POST', + resource_path='/1/object/ezsignfolder/{pkiEzsignfolderID}/importEzsigntemplatepackage', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + - @validate_arguments - def ezsignfolder_import_ezsigntemplatepackage_v1(self, pki_ezsignfolder_id : conint(strict=True, ge=0), ezsignfolder_import_ezsigntemplatepackage_v1_request : EzsignfolderImportEzsigntemplatepackageV1Request, **kwargs) -> EzsignfolderImportEzsigntemplatepackageV1Response: # noqa: E501 - """Import an Ezsigntemplatepackage in the Ezsignfolder. # noqa: E501 - This endpoint imports all of the Ezsigntemplates from the Ezsigntemplatepackage into the Ezsignfolder as Ezsigndocuments. This allows to automatically apply all the Ezsigntemplateformfieldgroups and Ezsigntemplatesignatures on the newly created Ezsigndocuments in a single step. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def ezsignfolder_reorder_v1( + self, + pki_ezsignfolder_id: Annotated[int, Field(strict=True, ge=0)], + ezsignfolder_reorder_v1_request: EzsignfolderReorderV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsignfolderReorderV1Response: + """Reorder Ezsigndocuments in the Ezsignfolder - >>> thread = api.ezsignfolder_import_ezsigntemplatepackage_v1(pki_ezsignfolder_id, ezsignfolder_import_ezsigntemplatepackage_v1_request, async_req=True) - >>> result = thread.get() :param pki_ezsignfolder_id: (required) :type pki_ezsignfolder_id: int - :param ezsignfolder_import_ezsigntemplatepackage_v1_request: (required) - :type ezsignfolder_import_ezsigntemplatepackage_v1_request: EzsignfolderImportEzsigntemplatepackageV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param ezsignfolder_reorder_v1_request: (required) + :type ezsignfolder_reorder_v1_request: EzsignfolderReorderV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsignfolderImportEzsigntemplatepackageV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsignfolder_import_ezsigntemplatepackage_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsignfolder_import_ezsigntemplatepackage_v1_with_http_info(pki_ezsignfolder_id, ezsignfolder_import_ezsigntemplatepackage_v1_request, **kwargs) # noqa: E501 - - @validate_arguments - def ezsignfolder_import_ezsigntemplatepackage_v1_with_http_info(self, pki_ezsignfolder_id : conint(strict=True, ge=0), ezsignfolder_import_ezsigntemplatepackage_v1_request : EzsignfolderImportEzsigntemplatepackageV1Request, **kwargs) -> ApiResponse: # noqa: E501 - """Import an Ezsigntemplatepackage in the Ezsignfolder. # noqa: E501 - - This endpoint imports all of the Ezsigntemplates from the Ezsigntemplatepackage into the Ezsignfolder as Ezsigndocuments. This allows to automatically apply all the Ezsigntemplateformfieldgroups and Ezsigntemplatesignatures on the newly created Ezsigndocuments in a single step. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsignfolder_import_ezsigntemplatepackage_v1_with_http_info(pki_ezsignfolder_id, ezsignfolder_import_ezsigntemplatepackage_v1_request, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._ezsignfolder_reorder_v1_serialize( + pki_ezsignfolder_id=pki_ezsignfolder_id, + ezsignfolder_reorder_v1_request=ezsignfolder_reorder_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfolderReorderV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsignfolder_reorder_v1_with_http_info( + self, + pki_ezsignfolder_id: Annotated[int, Field(strict=True, ge=0)], + ezsignfolder_reorder_v1_request: EzsignfolderReorderV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsignfolderReorderV1Response]: + """Reorder Ezsigndocuments in the Ezsignfolder + :param pki_ezsignfolder_id: (required) :type pki_ezsignfolder_id: int - :param ezsignfolder_import_ezsigntemplatepackage_v1_request: (required) - :type ezsignfolder_import_ezsigntemplatepackage_v1_request: EzsignfolderImportEzsigntemplatepackageV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional + :param ezsignfolder_reorder_v1_request: (required) + :type ezsignfolder_reorder_v1_request: EzsignfolderReorderV1Request :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsignfolderImportEzsigntemplatepackageV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._ezsignfolder_reorder_v1_serialize( + pki_ezsignfolder_id=pki_ezsignfolder_id, + ezsignfolder_reorder_v1_request=ezsignfolder_reorder_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfolderReorderV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _params = locals() - _all_params = [ - 'pki_ezsignfolder_id', - 'ezsignfolder_import_ezsigntemplatepackage_v1_request' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + @validate_call + def ezsignfolder_reorder_v1_without_preload_content( + self, + pki_ezsignfolder_id: Annotated[int, Field(strict=True, ge=0)], + ezsignfolder_reorder_v1_request: EzsignfolderReorderV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Reorder Ezsigndocuments in the Ezsignfolder + + + :param pki_ezsignfolder_id: (required) + :type pki_ezsignfolder_id: int + :param ezsignfolder_reorder_v1_request: (required) + :type ezsignfolder_reorder_v1_request: EzsignfolderReorderV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignfolder_reorder_v1_serialize( + pki_ezsignfolder_id=pki_ezsignfolder_id, + ezsignfolder_reorder_v1_request=ezsignfolder_reorder_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsignfolder_import_ezsigntemplatepackage_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfolderReorderV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_ezsignfolder_id']: - _path_params['pkiEzsignfolderID'] = _params['pki_ezsignfolder_id'] + def _ezsignfolder_reorder_v1_serialize( + self, + pki_ezsignfolder_id, + ezsignfolder_reorder_v1_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_ezsignfolder_id is not None: + _path_params['pkiEzsignfolderID'] = pki_ezsignfolder_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['ezsignfolder_import_ezsigntemplatepackage_v1_request'] is not None: - _body_params = _params['ezsignfolder_import_ezsigntemplatepackage_v1_request'] + if ezsignfolder_reorder_v1_request is not None: + _body_params = ezsignfolder_reorder_v1_request + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '200': "EzsignfolderImportEzsigntemplatepackageV1Response", - '404': "CommonResponseError", - '422': "CommonResponseError", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsignfolder/{pkiEzsignfolderID}/importEzsigntemplatepackage', 'POST', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='POST', + resource_path='/1/object/ezsignfolder/{pkiEzsignfolderID}/reorder', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) - @validate_arguments - def ezsignfolder_reorder_v1(self, pki_ezsignfolder_id : conint(strict=True, ge=0), ezsignfolder_reorder_v1_request : EzsignfolderReorderV1Request, **kwargs) -> EzsignfolderReorderV1Response: # noqa: E501 - """Reorder Ezsigndocuments in the Ezsignfolder # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.ezsignfolder_reorder_v1(pki_ezsignfolder_id, ezsignfolder_reorder_v1_request, async_req=True) - >>> result = thread.get() - :param pki_ezsignfolder_id: (required) - :type pki_ezsignfolder_id: int - :param ezsignfolder_reorder_v1_request: (required) - :type ezsignfolder_reorder_v1_request: EzsignfolderReorderV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsignfolderReorderV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsignfolder_reorder_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsignfolder_reorder_v1_with_http_info(pki_ezsignfolder_id, ezsignfolder_reorder_v1_request, **kwargs) # noqa: E501 - - @validate_arguments - def ezsignfolder_reorder_v1_with_http_info(self, pki_ezsignfolder_id : conint(strict=True, ge=0), ezsignfolder_reorder_v1_request : EzsignfolderReorderV1Request, **kwargs) -> ApiResponse: # noqa: E501 - """Reorder Ezsigndocuments in the Ezsignfolder # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsignfolder_reorder_v1_with_http_info(pki_ezsignfolder_id, ezsignfolder_reorder_v1_request, async_req=True) - >>> result = thread.get() + @validate_call + def ezsignfolder_send_v1( + self, + pki_ezsignfolder_id: Annotated[int, Field(strict=True, ge=0)], + ezsignfolder_send_v1_request: EzsignfolderSendV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsignfolderSendV1Response: + """(Deprecated) Send the Ezsignfolder to the signatories for signature + + :param pki_ezsignfolder_id: (required) :type pki_ezsignfolder_id: int - :param ezsignfolder_reorder_v1_request: (required) - :type ezsignfolder_reorder_v1_request: EzsignfolderReorderV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional + :param ezsignfolder_send_v1_request: (required) + :type ezsignfolder_send_v1_request: EzsignfolderSendV1Request :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsignfolderReorderV1Response, status_code(int), headers(HTTPHeaderDict)) - """ - - _params = locals() + """ # noqa: E501 + warnings.warn("POST /1/object/ezsignfolder/{pkiEzsignfolderID}/send is deprecated.", DeprecationWarning) - _all_params = [ - 'pki_ezsignfolder_id', - 'ezsignfolder_reorder_v1_request' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' - ] + _param = self._ezsignfolder_send_v1_serialize( + pki_ezsignfolder_id=pki_ezsignfolder_id, + ezsignfolder_send_v1_request=ezsignfolder_send_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsignfolder_reorder_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] - - _collection_formats = {} - - # process the path parameters - _path_params = {} - if _params['pki_ezsignfolder_id']: - _path_params['pkiEzsignfolderID'] = _params['pki_ezsignfolder_id'] - - - # process the query parameters - _query_params = [] - # process the header parameters - _header_params = dict(_params.get('_headers', {})) - # process the form parameters - _form_params = [] - _files = {} - # process the body parameter - _body_params = None - if _params['ezsignfolder_reorder_v1_request'] is not None: - _body_params = _params['ezsignfolder_reorder_v1_request'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfolderSendV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsignfolder_send_v1_with_http_info( + self, + pki_ezsignfolder_id: Annotated[int, Field(strict=True, ge=0)], + ezsignfolder_send_v1_request: EzsignfolderSendV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsignfolderSendV1Response]: + """(Deprecated) Send the Ezsignfolder to the signatories for signature - # set the HTTP header `Accept` - _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + - # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + :param pki_ezsignfolder_id: (required) + :type pki_ezsignfolder_id: int + :param ezsignfolder_send_v1_request: (required) + :type ezsignfolder_send_v1_request: EzsignfolderSendV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + warnings.warn("POST /1/object/ezsignfolder/{pkiEzsignfolderID}/send is deprecated.", DeprecationWarning) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 + _param = self._ezsignfolder_send_v1_serialize( + pki_ezsignfolder_id=pki_ezsignfolder_id, + ezsignfolder_send_v1_request=ezsignfolder_send_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _response_types_map = { - '200': "EzsignfolderReorderV1Response", + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfolderSendV1Response", '404': "CommonResponseError", '422': "CommonResponseError", } - - return self.api_client.call_api( - '/1/object/ezsignfolder/{pkiEzsignfolderID}/reorder', 'POST', - _path_params, - _query_params, - _header_params, - body=_body_params, - post_params=_form_params, - files=_files, + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, response_types_map=_response_types_map, - auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), - collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) - - @validate_arguments - def ezsignfolder_send_v1(self, pki_ezsignfolder_id : conint(strict=True, ge=0), ezsignfolder_send_v1_request : EzsignfolderSendV1Request, **kwargs) -> EzsignfolderSendV1Response: # noqa: E501 - """(Deprecated) Send the Ezsignfolder to the signatories for signature # noqa: E501 + ) - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.ezsignfolder_send_v1(pki_ezsignfolder_id, ezsignfolder_send_v1_request, async_req=True) - >>> result = thread.get() + @validate_call + def ezsignfolder_send_v1_without_preload_content( + self, + pki_ezsignfolder_id: Annotated[int, Field(strict=True, ge=0)], + ezsignfolder_send_v1_request: EzsignfolderSendV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """(Deprecated) Send the Ezsignfolder to the signatories for signature - :param pki_ezsignfolder_id: (required) - :type pki_ezsignfolder_id: int - :param ezsignfolder_send_v1_request: (required) - :type ezsignfolder_send_v1_request: EzsignfolderSendV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsignfolderSendV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsignfolder_send_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsignfolder_send_v1_with_http_info(pki_ezsignfolder_id, ezsignfolder_send_v1_request, **kwargs) # noqa: E501 - - @validate_arguments - def ezsignfolder_send_v1_with_http_info(self, pki_ezsignfolder_id : conint(strict=True, ge=0), ezsignfolder_send_v1_request : EzsignfolderSendV1Request, **kwargs) -> ApiResponse: # noqa: E501 - """(Deprecated) Send the Ezsignfolder to the signatories for signature # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsignfolder_send_v1_with_http_info(pki_ezsignfolder_id, ezsignfolder_send_v1_request, async_req=True) - >>> result = thread.get() + :param pki_ezsignfolder_id: (required) :type pki_ezsignfolder_id: int :param ezsignfolder_send_v1_request: (required) :type ezsignfolder_send_v1_request: EzsignfolderSendV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsignfolderSendV1Response, status_code(int), headers(HTTPHeaderDict)) - """ - + """ # noqa: E501 warnings.warn("POST /1/object/ezsignfolder/{pkiEzsignfolderID}/send is deprecated.", DeprecationWarning) - _params = locals() + _param = self._ezsignfolder_send_v1_serialize( + pki_ezsignfolder_id=pki_ezsignfolder_id, + ezsignfolder_send_v1_request=ezsignfolder_send_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _all_params = [ - 'pki_ezsignfolder_id', - 'ezsignfolder_send_v1_request' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' - ] + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfolderSendV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) + return response_data.response - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsignfolder_send_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] - _collection_formats = {} + def _ezsignfolder_send_v1_serialize( + self, + pki_ezsignfolder_id, + ezsignfolder_send_v1_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: - # process the path parameters - _path_params = {} - if _params['pki_ezsignfolder_id']: - _path_params['pkiEzsignfolderID'] = _params['pki_ezsignfolder_id'] + _host = None + + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if pki_ezsignfolder_id is not None: + _path_params['pkiEzsignfolderID'] = pki_ezsignfolder_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['ezsignfolder_send_v1_request'] is not None: - _body_params = _params['ezsignfolder_send_v1_request'] + if ezsignfolder_send_v1_request is not None: + _body_params = ezsignfolder_send_v1_request + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '200': "EzsignfolderSendV1Response", - '404': "CommonResponseError", - '422': "CommonResponseError", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsignfolder/{pkiEzsignfolderID}/send', 'POST', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='POST', + resource_path='/1/object/ezsignfolder/{pkiEzsignfolderID}/send', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + - @validate_arguments - def ezsignfolder_send_v2(self, pki_ezsignfolder_id : conint(strict=True, ge=0), ezsignfolder_send_v2_request : EzsignfolderSendV2Request, **kwargs) -> EzsignfolderSendV2Response: # noqa: E501 - """(Deprecated) Send the Ezsignfolder to the signatories for signature # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.ezsignfolder_send_v2(pki_ezsignfolder_id, ezsignfolder_send_v2_request, async_req=True) - >>> result = thread.get() + @validate_call + def ezsignfolder_send_v2( + self, + pki_ezsignfolder_id: Annotated[int, Field(strict=True, ge=0)], + ezsignfolder_send_v2_request: EzsignfolderSendV2Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsignfolderSendV2Response: + """(Deprecated) Send the Ezsignfolder to the signatories for signature + + :param pki_ezsignfolder_id: (required) :type pki_ezsignfolder_id: int :param ezsignfolder_send_v2_request: (required) :type ezsignfolder_send_v2_request: EzsignfolderSendV2Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsignfolderSendV2Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsignfolder_send_v2_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsignfolder_send_v2_with_http_info(pki_ezsignfolder_id, ezsignfolder_send_v2_request, **kwargs) # noqa: E501 - - @validate_arguments - def ezsignfolder_send_v2_with_http_info(self, pki_ezsignfolder_id : conint(strict=True, ge=0), ezsignfolder_send_v2_request : EzsignfolderSendV2Request, **kwargs) -> ApiResponse: # noqa: E501 - """(Deprecated) Send the Ezsignfolder to the signatories for signature # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsignfolder_send_v2_with_http_info(pki_ezsignfolder_id, ezsignfolder_send_v2_request, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + warnings.warn("POST /2/object/ezsignfolder/{pkiEzsignfolderID}/send is deprecated.", DeprecationWarning) + + _param = self._ezsignfolder_send_v2_serialize( + pki_ezsignfolder_id=pki_ezsignfolder_id, + ezsignfolder_send_v2_request=ezsignfolder_send_v2_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfolderSendV2Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsignfolder_send_v2_with_http_info( + self, + pki_ezsignfolder_id: Annotated[int, Field(strict=True, ge=0)], + ezsignfolder_send_v2_request: EzsignfolderSendV2Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsignfolderSendV2Response]: + """(Deprecated) Send the Ezsignfolder to the signatories for signature + + :param pki_ezsignfolder_id: (required) :type pki_ezsignfolder_id: int :param ezsignfolder_send_v2_request: (required) :type ezsignfolder_send_v2_request: EzsignfolderSendV2Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsignfolderSendV2Response, status_code(int), headers(HTTPHeaderDict)) - """ - + """ # noqa: E501 warnings.warn("POST /2/object/ezsignfolder/{pkiEzsignfolderID}/send is deprecated.", DeprecationWarning) - _params = locals() + _param = self._ezsignfolder_send_v2_serialize( + pki_ezsignfolder_id=pki_ezsignfolder_id, + ezsignfolder_send_v2_request=ezsignfolder_send_v2_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _all_params = [ - 'pki_ezsignfolder_id', - 'ezsignfolder_send_v2_request' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfolderSendV2Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def ezsignfolder_send_v2_without_preload_content( + self, + pki_ezsignfolder_id: Annotated[int, Field(strict=True, ge=0)], + ezsignfolder_send_v2_request: EzsignfolderSendV2Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """(Deprecated) Send the Ezsignfolder to the signatories for signature + + + + :param pki_ezsignfolder_id: (required) + :type pki_ezsignfolder_id: int + :param ezsignfolder_send_v2_request: (required) + :type ezsignfolder_send_v2_request: EzsignfolderSendV2Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + warnings.warn("POST /2/object/ezsignfolder/{pkiEzsignfolderID}/send is deprecated.", DeprecationWarning) + + _param = self._ezsignfolder_send_v2_serialize( + pki_ezsignfolder_id=pki_ezsignfolder_id, + ezsignfolder_send_v2_request=ezsignfolder_send_v2_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsignfolder_send_v2" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfolderSendV2Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_ezsignfolder_id']: - _path_params['pkiEzsignfolderID'] = _params['pki_ezsignfolder_id'] + def _ezsignfolder_send_v2_serialize( + self, + pki_ezsignfolder_id, + ezsignfolder_send_v2_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if pki_ezsignfolder_id is not None: + _path_params['pkiEzsignfolderID'] = pki_ezsignfolder_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['ezsignfolder_send_v2_request'] is not None: - _body_params = _params['ezsignfolder_send_v2_request'] + if ezsignfolder_send_v2_request is not None: + _body_params = ezsignfolder_send_v2_request + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '200': "EzsignfolderSendV2Response", - '404': "CommonResponseError", - '422': "CommonResponseError", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/2/object/ezsignfolder/{pkiEzsignfolderID}/send', 'POST', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='POST', + resource_path='/2/object/ezsignfolder/{pkiEzsignfolderID}/send', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) - @validate_arguments - def ezsignfolder_send_v3(self, pki_ezsignfolder_id : conint(strict=True, ge=0), ezsignfolder_send_v3_request : EzsignfolderSendV3Request, **kwargs) -> EzsignfolderSendV3Response: # noqa: E501 - """Send the Ezsignfolder to the signatories for signature # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.ezsignfolder_send_v3(pki_ezsignfolder_id, ezsignfolder_send_v3_request, async_req=True) - >>> result = thread.get() + + @validate_call + def ezsignfolder_send_v3( + self, + pki_ezsignfolder_id: Annotated[int, Field(strict=True, ge=0)], + ezsignfolder_send_v3_request: EzsignfolderSendV3Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsignfolderSendV3Response: + """Send the Ezsignfolder to the signatories for signature + + :param pki_ezsignfolder_id: (required) :type pki_ezsignfolder_id: int :param ezsignfolder_send_v3_request: (required) :type ezsignfolder_send_v3_request: EzsignfolderSendV3Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsignfolderSendV3Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsignfolder_send_v3_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsignfolder_send_v3_with_http_info(pki_ezsignfolder_id, ezsignfolder_send_v3_request, **kwargs) # noqa: E501 - - @validate_arguments - def ezsignfolder_send_v3_with_http_info(self, pki_ezsignfolder_id : conint(strict=True, ge=0), ezsignfolder_send_v3_request : EzsignfolderSendV3Request, **kwargs) -> ApiResponse: # noqa: E501 - """Send the Ezsignfolder to the signatories for signature # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsignfolder_send_v3_with_http_info(pki_ezsignfolder_id, ezsignfolder_send_v3_request, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._ezsignfolder_send_v3_serialize( + pki_ezsignfolder_id=pki_ezsignfolder_id, + ezsignfolder_send_v3_request=ezsignfolder_send_v3_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfolderSendV3Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsignfolder_send_v3_with_http_info( + self, + pki_ezsignfolder_id: Annotated[int, Field(strict=True, ge=0)], + ezsignfolder_send_v3_request: EzsignfolderSendV3Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsignfolderSendV3Response]: + """Send the Ezsignfolder to the signatories for signature + + :param pki_ezsignfolder_id: (required) :type pki_ezsignfolder_id: int :param ezsignfolder_send_v3_request: (required) :type ezsignfolder_send_v3_request: EzsignfolderSendV3Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsignfolderSendV3Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._ezsignfolder_send_v3_serialize( + pki_ezsignfolder_id=pki_ezsignfolder_id, + ezsignfolder_send_v3_request=ezsignfolder_send_v3_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfolderSendV3Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _params = locals() - _all_params = [ - 'pki_ezsignfolder_id', - 'ezsignfolder_send_v3_request' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + @validate_call + def ezsignfolder_send_v3_without_preload_content( + self, + pki_ezsignfolder_id: Annotated[int, Field(strict=True, ge=0)], + ezsignfolder_send_v3_request: EzsignfolderSendV3Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Send the Ezsignfolder to the signatories for signature + + + + :param pki_ezsignfolder_id: (required) + :type pki_ezsignfolder_id: int + :param ezsignfolder_send_v3_request: (required) + :type ezsignfolder_send_v3_request: EzsignfolderSendV3Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignfolder_send_v3_serialize( + pki_ezsignfolder_id=pki_ezsignfolder_id, + ezsignfolder_send_v3_request=ezsignfolder_send_v3_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsignfolder_send_v3" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfolderSendV3Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_ezsignfolder_id']: - _path_params['pkiEzsignfolderID'] = _params['pki_ezsignfolder_id'] + def _ezsignfolder_send_v3_serialize( + self, + pki_ezsignfolder_id, + ezsignfolder_send_v3_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if pki_ezsignfolder_id is not None: + _path_params['pkiEzsignfolderID'] = pki_ezsignfolder_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['ezsignfolder_send_v3_request'] is not None: - _body_params = _params['ezsignfolder_send_v3_request'] + if ezsignfolder_send_v3_request is not None: + _body_params = ezsignfolder_send_v3_request + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '200': "EzsignfolderSendV3Response", - '404': "CommonResponseError", - '422': "CommonResponseError", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/3/object/ezsignfolder/{pkiEzsignfolderID}/send', 'POST', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='POST', + resource_path='/3/object/ezsignfolder/{pkiEzsignfolderID}/send', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + - @validate_arguments - def ezsignfolder_unsend_v1(self, pki_ezsignfolder_id : conint(strict=True, ge=0), body : Dict[str, Any], **kwargs) -> EzsignfolderUnsendV1Response: # noqa: E501 - """Unsend the Ezsignfolder # noqa: E501 - Once an Ezsignfolder has been sent to signatories, it cannot be modified. Using this endpoint, you can unsend the Ezsignfolder and make it modifiable again. Signatories will receive an email informing them the signature process was aborted and they might receive a new invitation to sign. ⚠️ Warning: Any signature previously made by signatories on \"Non-completed\" Ezsigndocuments will be lost. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.ezsignfolder_unsend_v1(pki_ezsignfolder_id, body, async_req=True) - >>> result = thread.get() + @validate_call + def ezsignfolder_unsend_v1( + self, + pki_ezsignfolder_id: Annotated[int, Field(strict=True, ge=0)], + body: Dict[str, Any], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsignfolderUnsendV1Response: + """Unsend the Ezsignfolder + + Once an Ezsignfolder has been sent to signatories, it cannot be modified. Using this endpoint, you can unsend the Ezsignfolder and make it modifiable again. Signatories will receive an email informing them the signature process was aborted and they might receive a new invitation to sign. ⚠️ Warning: Any signature previously made by signatories on \"Non-completed\" Ezsigndocuments will be lost. :param pki_ezsignfolder_id: (required) :type pki_ezsignfolder_id: int :param body: (required) :type body: object - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsignfolderUnsendV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsignfolder_unsend_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsignfolder_unsend_v1_with_http_info(pki_ezsignfolder_id, body, **kwargs) # noqa: E501 - - @validate_arguments - def ezsignfolder_unsend_v1_with_http_info(self, pki_ezsignfolder_id : conint(strict=True, ge=0), body : Dict[str, Any], **kwargs) -> ApiResponse: # noqa: E501 - """Unsend the Ezsignfolder # noqa: E501 - - Once an Ezsignfolder has been sent to signatories, it cannot be modified. Using this endpoint, you can unsend the Ezsignfolder and make it modifiable again. Signatories will receive an email informing them the signature process was aborted and they might receive a new invitation to sign. ⚠️ Warning: Any signature previously made by signatories on \"Non-completed\" Ezsigndocuments will be lost. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsignfolder_unsend_v1_with_http_info(pki_ezsignfolder_id, body, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._ezsignfolder_unsend_v1_serialize( + pki_ezsignfolder_id=pki_ezsignfolder_id, + body=body, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfolderUnsendV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsignfolder_unsend_v1_with_http_info( + self, + pki_ezsignfolder_id: Annotated[int, Field(strict=True, ge=0)], + body: Dict[str, Any], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsignfolderUnsendV1Response]: + """Unsend the Ezsignfolder + + Once an Ezsignfolder has been sent to signatories, it cannot be modified. Using this endpoint, you can unsend the Ezsignfolder and make it modifiable again. Signatories will receive an email informing them the signature process was aborted and they might receive a new invitation to sign. ⚠️ Warning: Any signature previously made by signatories on \"Non-completed\" Ezsigndocuments will be lost. :param pki_ezsignfolder_id: (required) :type pki_ezsignfolder_id: int :param body: (required) :type body: object - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsignfolderUnsendV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._ezsignfolder_unsend_v1_serialize( + pki_ezsignfolder_id=pki_ezsignfolder_id, + body=body, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfolderUnsendV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _params = locals() - _all_params = [ - 'pki_ezsignfolder_id', - 'body' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + @validate_call + def ezsignfolder_unsend_v1_without_preload_content( + self, + pki_ezsignfolder_id: Annotated[int, Field(strict=True, ge=0)], + body: Dict[str, Any], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Unsend the Ezsignfolder + + Once an Ezsignfolder has been sent to signatories, it cannot be modified. Using this endpoint, you can unsend the Ezsignfolder and make it modifiable again. Signatories will receive an email informing them the signature process was aborted and they might receive a new invitation to sign. ⚠️ Warning: Any signature previously made by signatories on \"Non-completed\" Ezsigndocuments will be lost. + + :param pki_ezsignfolder_id: (required) + :type pki_ezsignfolder_id: int + :param body: (required) + :type body: object + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignfolder_unsend_v1_serialize( + pki_ezsignfolder_id=pki_ezsignfolder_id, + body=body, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsignfolder_unsend_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfolderUnsendV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_ezsignfolder_id']: - _path_params['pkiEzsignfolderID'] = _params['pki_ezsignfolder_id'] + def _ezsignfolder_unsend_v1_serialize( + self, + pki_ezsignfolder_id, + body, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if pki_ezsignfolder_id is not None: + _path_params['pkiEzsignfolderID'] = pki_ezsignfolder_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['body'] is not None: - _body_params = _params['body'] + if body is not None: + _body_params = body + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '200': "EzsignfolderUnsendV1Response", - '404': "CommonResponseError", - '422': "CommonResponseError", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsignfolder/{pkiEzsignfolderID}/unsend', 'POST', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='POST', + resource_path='/1/object/ezsignfolder/{pkiEzsignfolderID}/unsend', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/eZmaxApi/api/object_ezsignfoldersignerassociation_api.py b/eZmaxApi/api/object_ezsignfoldersignerassociation_api.py index 0d3a4eacc..9615516a2 100644 --- a/eZmaxApi/api/object_ezsignfoldersignerassociation_api.py +++ b/eZmaxApi/api/object_ezsignfoldersignerassociation_api.py @@ -13,15 +13,20 @@ """ # noqa: E501 -import re # noqa: F401 import io import warnings -from pydantic import validate_arguments, ValidationError +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Dict, List, Optional, Tuple, Union, Any -from pydantic import conint, conlist +try: + from typing import Annotated +except ImportError: + from typing_extensions import Annotated -from typing import Any, Dict +from pydantic import Field +from typing_extensions import Annotated +from typing import Any, Dict, List from eZmaxApi.models.ezsignfoldersignerassociation_create_object_v1_request import EzsignfoldersignerassociationCreateObjectV1Request from eZmaxApi.models.ezsignfoldersignerassociation_create_object_v1_response import EzsignfoldersignerassociationCreateObjectV1Response @@ -39,10 +44,7 @@ from eZmaxApi.api_client import ApiClient from eZmaxApi.api_response import ApiResponse -from eZmaxApi.exceptions import ( # noqa: F401 - ApiTypeError, - ApiValueError -) +from eZmaxApi.rest import RESTResponseType class ObjectEzsignfoldersignerassociationApi: @@ -57,1335 +59,2474 @@ def __init__(self, api_client=None) -> None: api_client = ApiClient.get_default() self.api_client = api_client - @validate_arguments - def ezsignfoldersignerassociation_create_object_v1(self, ezsignfoldersignerassociation_create_object_v1_request : conlist(EzsignfoldersignerassociationCreateObjectV1Request), **kwargs) -> EzsignfoldersignerassociationCreateObjectV1Response: # noqa: E501 - """(Deprecated) Create a new Ezsignfoldersignerassociation # noqa: E501 - The endpoint allows to create one or many elements at once. The array can contain simple (Just the object) or compound (The object and its child) objects. Creating compound elements allows to reduce the multiple requests to create all child objects. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def ezsignfoldersignerassociation_create_object_v1( + self, + ezsignfoldersignerassociation_create_object_v1_request: List[EzsignfoldersignerassociationCreateObjectV1Request], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsignfoldersignerassociationCreateObjectV1Response: + """(Deprecated) Create a new Ezsignfoldersignerassociation - >>> thread = api.ezsignfoldersignerassociation_create_object_v1(ezsignfoldersignerassociation_create_object_v1_request, async_req=True) - >>> result = thread.get() + The endpoint allows to create one or many elements at once. The array can contain simple (Just the object) or compound (The object and its child) objects. Creating compound elements allows to reduce the multiple requests to create all child objects. :param ezsignfoldersignerassociation_create_object_v1_request: (required) :type ezsignfoldersignerassociation_create_object_v1_request: List[EzsignfoldersignerassociationCreateObjectV1Request] - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsignfoldersignerassociationCreateObjectV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsignfoldersignerassociation_create_object_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsignfoldersignerassociation_create_object_v1_with_http_info(ezsignfoldersignerassociation_create_object_v1_request, **kwargs) # noqa: E501 - - @validate_arguments - def ezsignfoldersignerassociation_create_object_v1_with_http_info(self, ezsignfoldersignerassociation_create_object_v1_request : conlist(EzsignfoldersignerassociationCreateObjectV1Request), **kwargs) -> ApiResponse: # noqa: E501 - """(Deprecated) Create a new Ezsignfoldersignerassociation # noqa: E501 - - The endpoint allows to create one or many elements at once. The array can contain simple (Just the object) or compound (The object and its child) objects. Creating compound elements allows to reduce the multiple requests to create all child objects. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsignfoldersignerassociation_create_object_v1_with_http_info(ezsignfoldersignerassociation_create_object_v1_request, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + warnings.warn("POST /1/object/ezsignfoldersignerassociation is deprecated.", DeprecationWarning) + + _param = self._ezsignfoldersignerassociation_create_object_v1_serialize( + ezsignfoldersignerassociation_create_object_v1_request=ezsignfoldersignerassociation_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "EzsignfoldersignerassociationCreateObjectV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsignfoldersignerassociation_create_object_v1_with_http_info( + self, + ezsignfoldersignerassociation_create_object_v1_request: List[EzsignfoldersignerassociationCreateObjectV1Request], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsignfoldersignerassociationCreateObjectV1Response]: + """(Deprecated) Create a new Ezsignfoldersignerassociation + + The endpoint allows to create one or many elements at once. The array can contain simple (Just the object) or compound (The object and its child) objects. Creating compound elements allows to reduce the multiple requests to create all child objects. :param ezsignfoldersignerassociation_create_object_v1_request: (required) :type ezsignfoldersignerassociation_create_object_v1_request: List[EzsignfoldersignerassociationCreateObjectV1Request] - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsignfoldersignerassociationCreateObjectV1Response, status_code(int), headers(HTTPHeaderDict)) - """ - + """ # noqa: E501 warnings.warn("POST /1/object/ezsignfoldersignerassociation is deprecated.", DeprecationWarning) - _params = locals() + _param = self._ezsignfoldersignerassociation_create_object_v1_serialize( + ezsignfoldersignerassociation_create_object_v1_request=ezsignfoldersignerassociation_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _all_params = [ - 'ezsignfoldersignerassociation_create_object_v1_request' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + _response_types_map: Dict[str, Optional[str]] = { + '201': "EzsignfoldersignerassociationCreateObjectV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def ezsignfoldersignerassociation_create_object_v1_without_preload_content( + self, + ezsignfoldersignerassociation_create_object_v1_request: List[EzsignfoldersignerassociationCreateObjectV1Request], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """(Deprecated) Create a new Ezsignfoldersignerassociation + + The endpoint allows to create one or many elements at once. The array can contain simple (Just the object) or compound (The object and its child) objects. Creating compound elements allows to reduce the multiple requests to create all child objects. + + :param ezsignfoldersignerassociation_create_object_v1_request: (required) + :type ezsignfoldersignerassociation_create_object_v1_request: List[EzsignfoldersignerassociationCreateObjectV1Request] + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + warnings.warn("POST /1/object/ezsignfoldersignerassociation is deprecated.", DeprecationWarning) + + _param = self._ezsignfoldersignerassociation_create_object_v1_serialize( + ezsignfoldersignerassociation_create_object_v1_request=ezsignfoldersignerassociation_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsignfoldersignerassociation_create_object_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '201': "EzsignfoldersignerassociationCreateObjectV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} + def _ezsignfoldersignerassociation_create_object_v1_serialize( + self, + ezsignfoldersignerassociation_create_object_v1_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + 'EzsignfoldersignerassociationCreateObjectV1Request': '', + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['ezsignfoldersignerassociation_create_object_v1_request'] is not None: - _body_params = _params['ezsignfoldersignerassociation_create_object_v1_request'] + if ezsignfoldersignerassociation_create_object_v1_request is not None: + _body_params = ezsignfoldersignerassociation_create_object_v1_request + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '201': "EzsignfoldersignerassociationCreateObjectV1Response", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsignfoldersignerassociation', 'POST', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='POST', + resource_path='/1/object/ezsignfoldersignerassociation', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) - @validate_arguments - def ezsignfoldersignerassociation_create_object_v2(self, ezsignfoldersignerassociation_create_object_v2_request : EzsignfoldersignerassociationCreateObjectV2Request, **kwargs) -> EzsignfoldersignerassociationCreateObjectV2Response: # noqa: E501 - """Create a new Ezsignfoldersignerassociation # noqa: E501 - The endpoint allows to create one or many elements at once. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.ezsignfoldersignerassociation_create_object_v2(ezsignfoldersignerassociation_create_object_v2_request, async_req=True) - >>> result = thread.get() + + @validate_call + def ezsignfoldersignerassociation_create_object_v2( + self, + ezsignfoldersignerassociation_create_object_v2_request: EzsignfoldersignerassociationCreateObjectV2Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsignfoldersignerassociationCreateObjectV2Response: + """Create a new Ezsignfoldersignerassociation + + The endpoint allows to create one or many elements at once. :param ezsignfoldersignerassociation_create_object_v2_request: (required) :type ezsignfoldersignerassociation_create_object_v2_request: EzsignfoldersignerassociationCreateObjectV2Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsignfoldersignerassociationCreateObjectV2Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsignfoldersignerassociation_create_object_v2_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsignfoldersignerassociation_create_object_v2_with_http_info(ezsignfoldersignerassociation_create_object_v2_request, **kwargs) # noqa: E501 - - @validate_arguments - def ezsignfoldersignerassociation_create_object_v2_with_http_info(self, ezsignfoldersignerassociation_create_object_v2_request : EzsignfoldersignerassociationCreateObjectV2Request, **kwargs) -> ApiResponse: # noqa: E501 - """Create a new Ezsignfoldersignerassociation # noqa: E501 - - The endpoint allows to create one or many elements at once. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsignfoldersignerassociation_create_object_v2_with_http_info(ezsignfoldersignerassociation_create_object_v2_request, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._ezsignfoldersignerassociation_create_object_v2_serialize( + ezsignfoldersignerassociation_create_object_v2_request=ezsignfoldersignerassociation_create_object_v2_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "EzsignfoldersignerassociationCreateObjectV2Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsignfoldersignerassociation_create_object_v2_with_http_info( + self, + ezsignfoldersignerassociation_create_object_v2_request: EzsignfoldersignerassociationCreateObjectV2Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsignfoldersignerassociationCreateObjectV2Response]: + """Create a new Ezsignfoldersignerassociation + + The endpoint allows to create one or many elements at once. :param ezsignfoldersignerassociation_create_object_v2_request: (required) :type ezsignfoldersignerassociation_create_object_v2_request: EzsignfoldersignerassociationCreateObjectV2Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsignfoldersignerassociationCreateObjectV2Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._ezsignfoldersignerassociation_create_object_v2_serialize( + ezsignfoldersignerassociation_create_object_v2_request=ezsignfoldersignerassociation_create_object_v2_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '201': "EzsignfoldersignerassociationCreateObjectV2Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'ezsignfoldersignerassociation_create_object_v2_request' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def ezsignfoldersignerassociation_create_object_v2_without_preload_content( + self, + ezsignfoldersignerassociation_create_object_v2_request: EzsignfoldersignerassociationCreateObjectV2Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Create a new Ezsignfoldersignerassociation + + The endpoint allows to create one or many elements at once. + + :param ezsignfoldersignerassociation_create_object_v2_request: (required) + :type ezsignfoldersignerassociation_create_object_v2_request: EzsignfoldersignerassociationCreateObjectV2Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignfoldersignerassociation_create_object_v2_serialize( + ezsignfoldersignerassociation_create_object_v2_request=ezsignfoldersignerassociation_create_object_v2_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsignfoldersignerassociation_create_object_v2" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '201': "EzsignfoldersignerassociationCreateObjectV2Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} + def _ezsignfoldersignerassociation_create_object_v2_serialize( + self, + ezsignfoldersignerassociation_create_object_v2_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['ezsignfoldersignerassociation_create_object_v2_request'] is not None: - _body_params = _params['ezsignfoldersignerassociation_create_object_v2_request'] + if ezsignfoldersignerassociation_create_object_v2_request is not None: + _body_params = ezsignfoldersignerassociation_create_object_v2_request + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '201': "EzsignfoldersignerassociationCreateObjectV2Response", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/2/object/ezsignfoldersignerassociation', 'POST', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='POST', + resource_path='/2/object/ezsignfoldersignerassociation', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) - @validate_arguments - def ezsignfoldersignerassociation_delete_object_v1(self, pki_ezsignfoldersignerassociation_id : conint(strict=True, ge=0), **kwargs) -> EzsignfoldersignerassociationDeleteObjectV1Response: # noqa: E501 - """Delete an existing Ezsignfoldersignerassociation # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.ezsignfoldersignerassociation_delete_object_v1(pki_ezsignfoldersignerassociation_id, async_req=True) - >>> result = thread.get() + + @validate_call + def ezsignfoldersignerassociation_delete_object_v1( + self, + pki_ezsignfoldersignerassociation_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsignfoldersignerassociationDeleteObjectV1Response: + """Delete an existing Ezsignfoldersignerassociation + + :param pki_ezsignfoldersignerassociation_id: (required) :type pki_ezsignfoldersignerassociation_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsignfoldersignerassociationDeleteObjectV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsignfoldersignerassociation_delete_object_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsignfoldersignerassociation_delete_object_v1_with_http_info(pki_ezsignfoldersignerassociation_id, **kwargs) # noqa: E501 - - @validate_arguments - def ezsignfoldersignerassociation_delete_object_v1_with_http_info(self, pki_ezsignfoldersignerassociation_id : conint(strict=True, ge=0), **kwargs) -> ApiResponse: # noqa: E501 - """Delete an existing Ezsignfoldersignerassociation # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsignfoldersignerassociation_delete_object_v1_with_http_info(pki_ezsignfoldersignerassociation_id, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._ezsignfoldersignerassociation_delete_object_v1_serialize( + pki_ezsignfoldersignerassociation_id=pki_ezsignfoldersignerassociation_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfoldersignerassociationDeleteObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsignfoldersignerassociation_delete_object_v1_with_http_info( + self, + pki_ezsignfoldersignerassociation_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsignfoldersignerassociationDeleteObjectV1Response]: + """Delete an existing Ezsignfoldersignerassociation + + :param pki_ezsignfoldersignerassociation_id: (required) :type pki_ezsignfoldersignerassociation_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsignfoldersignerassociationDeleteObjectV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._ezsignfoldersignerassociation_delete_object_v1_serialize( + pki_ezsignfoldersignerassociation_id=pki_ezsignfoldersignerassociation_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfoldersignerassociationDeleteObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _params = locals() - _all_params = [ - 'pki_ezsignfoldersignerassociation_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + @validate_call + def ezsignfoldersignerassociation_delete_object_v1_without_preload_content( + self, + pki_ezsignfoldersignerassociation_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete an existing Ezsignfoldersignerassociation + + + + :param pki_ezsignfoldersignerassociation_id: (required) + :type pki_ezsignfoldersignerassociation_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignfoldersignerassociation_delete_object_v1_serialize( + pki_ezsignfoldersignerassociation_id=pki_ezsignfoldersignerassociation_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsignfoldersignerassociation_delete_object_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfoldersignerassociationDeleteObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_ezsignfoldersignerassociation_id']: - _path_params['pkiEzsignfoldersignerassociationID'] = _params['pki_ezsignfoldersignerassociation_id'] + def _ezsignfoldersignerassociation_delete_object_v1_serialize( + self, + pki_ezsignfoldersignerassociation_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if pki_ezsignfoldersignerassociation_id is not None: + _path_params['pkiEzsignfoldersignerassociationID'] = pki_ezsignfoldersignerassociation_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "EzsignfoldersignerassociationDeleteObjectV1Response", - '404': "CommonResponseError", - '422': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociationID}', 'DELETE', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='DELETE', + resource_path='/1/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociationID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + - @validate_arguments - def ezsignfoldersignerassociation_edit_object_v1(self, pki_ezsignfoldersignerassociation_id : conint(strict=True, ge=0), ezsignfoldersignerassociation_edit_object_v1_request : EzsignfoldersignerassociationEditObjectV1Request, **kwargs) -> EzsignfoldersignerassociationEditObjectV1Response: # noqa: E501 - """Edit an existing Ezsignfoldersignerassociation # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.ezsignfoldersignerassociation_edit_object_v1(pki_ezsignfoldersignerassociation_id, ezsignfoldersignerassociation_edit_object_v1_request, async_req=True) - >>> result = thread.get() + @validate_call + def ezsignfoldersignerassociation_edit_object_v1( + self, + pki_ezsignfoldersignerassociation_id: Annotated[int, Field(strict=True, ge=0)], + ezsignfoldersignerassociation_edit_object_v1_request: EzsignfoldersignerassociationEditObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsignfoldersignerassociationEditObjectV1Response: + """Edit an existing Ezsignfoldersignerassociation + + :param pki_ezsignfoldersignerassociation_id: (required) :type pki_ezsignfoldersignerassociation_id: int :param ezsignfoldersignerassociation_edit_object_v1_request: (required) :type ezsignfoldersignerassociation_edit_object_v1_request: EzsignfoldersignerassociationEditObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsignfoldersignerassociationEditObjectV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsignfoldersignerassociation_edit_object_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsignfoldersignerassociation_edit_object_v1_with_http_info(pki_ezsignfoldersignerassociation_id, ezsignfoldersignerassociation_edit_object_v1_request, **kwargs) # noqa: E501 - - @validate_arguments - def ezsignfoldersignerassociation_edit_object_v1_with_http_info(self, pki_ezsignfoldersignerassociation_id : conint(strict=True, ge=0), ezsignfoldersignerassociation_edit_object_v1_request : EzsignfoldersignerassociationEditObjectV1Request, **kwargs) -> ApiResponse: # noqa: E501 - """Edit an existing Ezsignfoldersignerassociation # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsignfoldersignerassociation_edit_object_v1_with_http_info(pki_ezsignfoldersignerassociation_id, ezsignfoldersignerassociation_edit_object_v1_request, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._ezsignfoldersignerassociation_edit_object_v1_serialize( + pki_ezsignfoldersignerassociation_id=pki_ezsignfoldersignerassociation_id, + ezsignfoldersignerassociation_edit_object_v1_request=ezsignfoldersignerassociation_edit_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfoldersignerassociationEditObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsignfoldersignerassociation_edit_object_v1_with_http_info( + self, + pki_ezsignfoldersignerassociation_id: Annotated[int, Field(strict=True, ge=0)], + ezsignfoldersignerassociation_edit_object_v1_request: EzsignfoldersignerassociationEditObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsignfoldersignerassociationEditObjectV1Response]: + """Edit an existing Ezsignfoldersignerassociation + + :param pki_ezsignfoldersignerassociation_id: (required) :type pki_ezsignfoldersignerassociation_id: int :param ezsignfoldersignerassociation_edit_object_v1_request: (required) :type ezsignfoldersignerassociation_edit_object_v1_request: EzsignfoldersignerassociationEditObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsignfoldersignerassociationEditObjectV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._ezsignfoldersignerassociation_edit_object_v1_serialize( + pki_ezsignfoldersignerassociation_id=pki_ezsignfoldersignerassociation_id, + ezsignfoldersignerassociation_edit_object_v1_request=ezsignfoldersignerassociation_edit_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfoldersignerassociationEditObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'pki_ezsignfoldersignerassociation_id', - 'ezsignfoldersignerassociation_edit_object_v1_request' - ] - _all_params.extend( + + @validate_call + def ezsignfoldersignerassociation_edit_object_v1_without_preload_content( + self, + pki_ezsignfoldersignerassociation_id: Annotated[int, Field(strict=True, ge=0)], + ezsignfoldersignerassociation_edit_object_v1_request: EzsignfoldersignerassociationEditObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Edit an existing Ezsignfoldersignerassociation + + + + :param pki_ezsignfoldersignerassociation_id: (required) + :type pki_ezsignfoldersignerassociation_id: int + :param ezsignfoldersignerassociation_edit_object_v1_request: (required) + :type ezsignfoldersignerassociation_edit_object_v1_request: EzsignfoldersignerassociationEditObjectV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignfoldersignerassociation_edit_object_v1_serialize( + pki_ezsignfoldersignerassociation_id=pki_ezsignfoldersignerassociation_id, + ezsignfoldersignerassociation_edit_object_v1_request=ezsignfoldersignerassociation_edit_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfoldersignerassociationEditObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _ezsignfoldersignerassociation_edit_object_v1_serialize( + self, + pki_ezsignfoldersignerassociation_id, + ezsignfoldersignerassociation_edit_object_v1_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_ezsignfoldersignerassociation_id is not None: + _path_params['pkiEzsignfoldersignerassociationID'] = pki_ezsignfoldersignerassociation_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if ezsignfoldersignerassociation_edit_object_v1_request is not None: + _body_params = ezsignfoldersignerassociation_edit_object_v1_request + + + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + 'application/json' ] ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsignfoldersignerassociation_edit_object_v1" % _key + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] ) - _params[_key] = _val - del _params['kwargs'] + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/1/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociationID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_ezsignfoldersignerassociation_id']: - _path_params['pkiEzsignfoldersignerassociationID'] = _params['pki_ezsignfoldersignerassociation_id'] + @validate_call + def ezsignfoldersignerassociation_force_disconnect_v1( + self, + pki_ezsignfoldersignerassociation_id: Annotated[int, Field(strict=True, ge=0)], + body: Dict[str, Any], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsignfoldersignerassociationForceDisconnectV1Response: + """Disconnects the Ezsignfoldersignerassociation + + + + :param pki_ezsignfoldersignerassociation_id: (required) + :type pki_ezsignfoldersignerassociation_id: int + :param body: (required) + :type body: object + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignfoldersignerassociation_force_disconnect_v1_serialize( + pki_ezsignfoldersignerassociation_id=pki_ezsignfoldersignerassociation_id, + body=body, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfoldersignerassociationForceDisconnectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsignfoldersignerassociation_force_disconnect_v1_with_http_info( + self, + pki_ezsignfoldersignerassociation_id: Annotated[int, Field(strict=True, ge=0)], + body: Dict[str, Any], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsignfoldersignerassociationForceDisconnectV1Response]: + """Disconnects the Ezsignfoldersignerassociation + + + + :param pki_ezsignfoldersignerassociation_id: (required) + :type pki_ezsignfoldersignerassociation_id: int + :param body: (required) + :type body: object + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignfoldersignerassociation_force_disconnect_v1_serialize( + pki_ezsignfoldersignerassociation_id=pki_ezsignfoldersignerassociation_id, + body=body, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfoldersignerassociationForceDisconnectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def ezsignfoldersignerassociation_force_disconnect_v1_without_preload_content( + self, + pki_ezsignfoldersignerassociation_id: Annotated[int, Field(strict=True, ge=0)], + body: Dict[str, Any], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Disconnects the Ezsignfoldersignerassociation + + + + :param pki_ezsignfoldersignerassociation_id: (required) + :type pki_ezsignfoldersignerassociation_id: int + :param body: (required) + :type body: object + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignfoldersignerassociation_force_disconnect_v1_serialize( + pki_ezsignfoldersignerassociation_id=pki_ezsignfoldersignerassociation_id, + body=body, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfoldersignerassociationForceDisconnectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _ezsignfoldersignerassociation_force_disconnect_v1_serialize( + self, + pki_ezsignfoldersignerassociation_id, + body, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_ezsignfoldersignerassociation_id is not None: + _path_params['pkiEzsignfoldersignerassociationID'] = pki_ezsignfoldersignerassociation_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['ezsignfoldersignerassociation_edit_object_v1_request'] is not None: - _body_params = _params['ezsignfoldersignerassociation_edit_object_v1_request'] + if body is not None: + _body_params = body + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 + _auth_settings: List[str] = [ + 'Authorization' + ] - _response_types_map = { - '200': "EzsignfoldersignerassociationEditObjectV1Response", + return self.api_client.param_serialize( + method='POST', + resource_path='/1/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociationID}/forceDisconnect', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def ezsignfoldersignerassociation_get_in_person_login_url_v1( + self, + pki_ezsignfoldersignerassociation_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsignfoldersignerassociationGetInPersonLoginUrlV1Response: + """Retrieve a Login Url to allow In-Person signing + + This endpoint returns a Login Url that can be used in a browser or embedded in an I-Frame to allow in person signing. The signer Login type must be configured as In-Person. + + :param pki_ezsignfoldersignerassociation_id: (required) + :type pki_ezsignfoldersignerassociation_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignfoldersignerassociation_get_in_person_login_url_v1_serialize( + pki_ezsignfoldersignerassociation_id=pki_ezsignfoldersignerassociation_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfoldersignerassociationGetInPersonLoginUrlV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsignfoldersignerassociation_get_in_person_login_url_v1_with_http_info( + self, + pki_ezsignfoldersignerassociation_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsignfoldersignerassociationGetInPersonLoginUrlV1Response]: + """Retrieve a Login Url to allow In-Person signing + + This endpoint returns a Login Url that can be used in a browser or embedded in an I-Frame to allow in person signing. The signer Login type must be configured as In-Person. + + :param pki_ezsignfoldersignerassociation_id: (required) + :type pki_ezsignfoldersignerassociation_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignfoldersignerassociation_get_in_person_login_url_v1_serialize( + pki_ezsignfoldersignerassociation_id=pki_ezsignfoldersignerassociation_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfoldersignerassociationGetInPersonLoginUrlV1Response", '404': "CommonResponseError", '422': "CommonResponseError", } - - return self.api_client.call_api( - '/1/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociationID}', 'PUT', - _path_params, - _query_params, - _header_params, - body=_body_params, - post_params=_form_params, - files=_files, + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, response_types_map=_response_types_map, - auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), - collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) - - @validate_arguments - def ezsignfoldersignerassociation_force_disconnect_v1(self, pki_ezsignfoldersignerassociation_id : conint(strict=True, ge=0), body : Dict[str, Any], **kwargs) -> EzsignfoldersignerassociationForceDisconnectV1Response: # noqa: E501 - """Disconnects the Ezsignfoldersignerassociation # noqa: E501 + ) - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.ezsignfoldersignerassociation_force_disconnect_v1(pki_ezsignfoldersignerassociation_id, body, async_req=True) - >>> result = thread.get() + @validate_call + def ezsignfoldersignerassociation_get_in_person_login_url_v1_without_preload_content( + self, + pki_ezsignfoldersignerassociation_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve a Login Url to allow In-Person signing - :param pki_ezsignfoldersignerassociation_id: (required) - :type pki_ezsignfoldersignerassociation_id: int - :param body: (required) - :type body: object - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsignfoldersignerassociationForceDisconnectV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsignfoldersignerassociation_force_disconnect_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsignfoldersignerassociation_force_disconnect_v1_with_http_info(pki_ezsignfoldersignerassociation_id, body, **kwargs) # noqa: E501 - - @validate_arguments - def ezsignfoldersignerassociation_force_disconnect_v1_with_http_info(self, pki_ezsignfoldersignerassociation_id : conint(strict=True, ge=0), body : Dict[str, Any], **kwargs) -> ApiResponse: # noqa: E501 - """Disconnects the Ezsignfoldersignerassociation # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsignfoldersignerassociation_force_disconnect_v1_with_http_info(pki_ezsignfoldersignerassociation_id, body, async_req=True) - >>> result = thread.get() + This endpoint returns a Login Url that can be used in a browser or embedded in an I-Frame to allow in person signing. The signer Login type must be configured as In-Person. :param pki_ezsignfoldersignerassociation_id: (required) :type pki_ezsignfoldersignerassociation_id: int - :param body: (required) - :type body: object - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsignfoldersignerassociationForceDisconnectV1Response, status_code(int), headers(HTTPHeaderDict)) - """ - - _params = locals() + """ # noqa: E501 + + _param = self._ezsignfoldersignerassociation_get_in_person_login_url_v1_serialize( + pki_ezsignfoldersignerassociation_id=pki_ezsignfoldersignerassociation_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _all_params = [ - 'pki_ezsignfoldersignerassociation_id', - 'body' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' - ] + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfoldersignerassociationGetInPersonLoginUrlV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) + return response_data.response - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsignfoldersignerassociation_force_disconnect_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] - _collection_formats = {} + def _ezsignfoldersignerassociation_get_in_person_login_url_v1_serialize( + self, + pki_ezsignfoldersignerassociation_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: - # process the path parameters - _path_params = {} - if _params['pki_ezsignfoldersignerassociation_id']: - _path_params['pkiEzsignfoldersignerassociationID'] = _params['pki_ezsignfoldersignerassociation_id'] + _host = None + + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if pki_ezsignfoldersignerassociation_id is not None: + _path_params['pkiEzsignfoldersignerassociationID'] = pki_ezsignfoldersignerassociation_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['body'] is not None: - _body_params = _params['body'] + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '200': "EzsignfoldersignerassociationForceDisconnectV1Response", - '404': "CommonResponseError", - '422': "CommonResponseError", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociationID}/forceDisconnect', 'POST', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/1/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociationID}/getInPersonLoginUrl', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) - @validate_arguments - def ezsignfoldersignerassociation_get_in_person_login_url_v1(self, pki_ezsignfoldersignerassociation_id : conint(strict=True, ge=0), **kwargs) -> EzsignfoldersignerassociationGetInPersonLoginUrlV1Response: # noqa: E501 - """Retrieve a Login Url to allow In-Person signing # noqa: E501 - This endpoint returns a Login Url that can be used in a browser or embedded in an I-Frame to allow in person signing. The signer Login type must be configured as In-Person. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.ezsignfoldersignerassociation_get_in_person_login_url_v1(pki_ezsignfoldersignerassociation_id, async_req=True) - >>> result = thread.get() - :param pki_ezsignfoldersignerassociation_id: (required) - :type pki_ezsignfoldersignerassociation_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsignfoldersignerassociationGetInPersonLoginUrlV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsignfoldersignerassociation_get_in_person_login_url_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsignfoldersignerassociation_get_in_person_login_url_v1_with_http_info(pki_ezsignfoldersignerassociation_id, **kwargs) # noqa: E501 - - @validate_arguments - def ezsignfoldersignerassociation_get_in_person_login_url_v1_with_http_info(self, pki_ezsignfoldersignerassociation_id : conint(strict=True, ge=0), **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve a Login Url to allow In-Person signing # noqa: E501 - - This endpoint returns a Login Url that can be used in a browser or embedded in an I-Frame to allow in person signing. The signer Login type must be configured as In-Person. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsignfoldersignerassociation_get_in_person_login_url_v1_with_http_info(pki_ezsignfoldersignerassociation_id, async_req=True) - >>> result = thread.get() + @validate_call + def ezsignfoldersignerassociation_get_object_v1( + self, + pki_ezsignfoldersignerassociation_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsignfoldersignerassociationGetObjectV1Response: + """(Deprecated) Retrieve an existing Ezsignfoldersignerassociation + + :param pki_ezsignfoldersignerassociation_id: (required) :type pki_ezsignfoldersignerassociation_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsignfoldersignerassociationGetInPersonLoginUrlV1Response, status_code(int), headers(HTTPHeaderDict)) - """ - - _params = locals() + """ # noqa: E501 + warnings.warn("GET /1/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociationID} is deprecated.", DeprecationWarning) - _all_params = [ - 'pki_ezsignfoldersignerassociation_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' - ] + _param = self._ezsignfoldersignerassociation_get_object_v1_serialize( + pki_ezsignfoldersignerassociation_id=pki_ezsignfoldersignerassociation_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsignfoldersignerassociation_get_in_person_login_url_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] - - _collection_formats = {} - - # process the path parameters - _path_params = {} - if _params['pki_ezsignfoldersignerassociation_id']: - _path_params['pkiEzsignfoldersignerassociationID'] = _params['pki_ezsignfoldersignerassociation_id'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfoldersignerassociationGetObjectV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsignfoldersignerassociation_get_object_v1_with_http_info( + self, + pki_ezsignfoldersignerassociation_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsignfoldersignerassociationGetObjectV1Response]: + """(Deprecated) Retrieve an existing Ezsignfoldersignerassociation + - # process the query parameters - _query_params = [] - # process the header parameters - _header_params = dict(_params.get('_headers', {})) - # process the form parameters - _form_params = [] - _files = {} - # process the body parameter - _body_params = None - # set the HTTP header `Accept` - _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + :param pki_ezsignfoldersignerassociation_id: (required) + :type pki_ezsignfoldersignerassociation_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + warnings.warn("GET /1/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociationID} is deprecated.", DeprecationWarning) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 + _param = self._ezsignfoldersignerassociation_get_object_v1_serialize( + pki_ezsignfoldersignerassociation_id=pki_ezsignfoldersignerassociation_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _response_types_map = { - '200': "EzsignfoldersignerassociationGetInPersonLoginUrlV1Response", + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfoldersignerassociationGetObjectV1Response", '404': "CommonResponseError", - '422': "CommonResponseError", } - - return self.api_client.call_api( - '/1/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociationID}/getInPersonLoginUrl', 'GET', - _path_params, - _query_params, - _header_params, - body=_body_params, - post_params=_form_params, - files=_files, + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, response_types_map=_response_types_map, - auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), - collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) - - @validate_arguments - def ezsignfoldersignerassociation_get_object_v1(self, pki_ezsignfoldersignerassociation_id : conint(strict=True, ge=0), **kwargs) -> EzsignfoldersignerassociationGetObjectV1Response: # noqa: E501 - """(Deprecated) Retrieve an existing Ezsignfoldersignerassociation # noqa: E501 + ) - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.ezsignfoldersignerassociation_get_object_v1(pki_ezsignfoldersignerassociation_id, async_req=True) - >>> result = thread.get() + @validate_call + def ezsignfoldersignerassociation_get_object_v1_without_preload_content( + self, + pki_ezsignfoldersignerassociation_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """(Deprecated) Retrieve an existing Ezsignfoldersignerassociation - :param pki_ezsignfoldersignerassociation_id: (required) - :type pki_ezsignfoldersignerassociation_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsignfoldersignerassociationGetObjectV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsignfoldersignerassociation_get_object_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsignfoldersignerassociation_get_object_v1_with_http_info(pki_ezsignfoldersignerassociation_id, **kwargs) # noqa: E501 - - @validate_arguments - def ezsignfoldersignerassociation_get_object_v1_with_http_info(self, pki_ezsignfoldersignerassociation_id : conint(strict=True, ge=0), **kwargs) -> ApiResponse: # noqa: E501 - """(Deprecated) Retrieve an existing Ezsignfoldersignerassociation # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsignfoldersignerassociation_get_object_v1_with_http_info(pki_ezsignfoldersignerassociation_id, async_req=True) - >>> result = thread.get() + :param pki_ezsignfoldersignerassociation_id: (required) :type pki_ezsignfoldersignerassociation_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsignfoldersignerassociationGetObjectV1Response, status_code(int), headers(HTTPHeaderDict)) - """ - + """ # noqa: E501 warnings.warn("GET /1/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociationID} is deprecated.", DeprecationWarning) - _params = locals() + _param = self._ezsignfoldersignerassociation_get_object_v1_serialize( + pki_ezsignfoldersignerassociation_id=pki_ezsignfoldersignerassociation_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _all_params = [ - 'pki_ezsignfoldersignerassociation_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' - ] + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfoldersignerassociationGetObjectV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) + return response_data.response - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsignfoldersignerassociation_get_object_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] - _collection_formats = {} + def _ezsignfoldersignerassociation_get_object_v1_serialize( + self, + pki_ezsignfoldersignerassociation_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: - # process the path parameters - _path_params = {} - if _params['pki_ezsignfoldersignerassociation_id']: - _path_params['pkiEzsignfoldersignerassociationID'] = _params['pki_ezsignfoldersignerassociation_id'] + _host = None + + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if pki_ezsignfoldersignerassociation_id is not None: + _path_params['pkiEzsignfoldersignerassociationID'] = pki_ezsignfoldersignerassociation_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "EzsignfoldersignerassociationGetObjectV1Response", - '404': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociationID}', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/1/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociationID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + - @validate_arguments - def ezsignfoldersignerassociation_get_object_v2(self, pki_ezsignfoldersignerassociation_id : conint(strict=True, ge=0), **kwargs) -> EzsignfoldersignerassociationGetObjectV2Response: # noqa: E501 - """Retrieve an existing Ezsignfoldersignerassociation # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.ezsignfoldersignerassociation_get_object_v2(pki_ezsignfoldersignerassociation_id, async_req=True) - >>> result = thread.get() + @validate_call + def ezsignfoldersignerassociation_get_object_v2( + self, + pki_ezsignfoldersignerassociation_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsignfoldersignerassociationGetObjectV2Response: + """Retrieve an existing Ezsignfoldersignerassociation + + :param pki_ezsignfoldersignerassociation_id: (required) :type pki_ezsignfoldersignerassociation_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsignfoldersignerassociationGetObjectV2Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsignfoldersignerassociation_get_object_v2_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsignfoldersignerassociation_get_object_v2_with_http_info(pki_ezsignfoldersignerassociation_id, **kwargs) # noqa: E501 - - @validate_arguments - def ezsignfoldersignerassociation_get_object_v2_with_http_info(self, pki_ezsignfoldersignerassociation_id : conint(strict=True, ge=0), **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve an existing Ezsignfoldersignerassociation # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsignfoldersignerassociation_get_object_v2_with_http_info(pki_ezsignfoldersignerassociation_id, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._ezsignfoldersignerassociation_get_object_v2_serialize( + pki_ezsignfoldersignerassociation_id=pki_ezsignfoldersignerassociation_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfoldersignerassociationGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsignfoldersignerassociation_get_object_v2_with_http_info( + self, + pki_ezsignfoldersignerassociation_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsignfoldersignerassociationGetObjectV2Response]: + """Retrieve an existing Ezsignfoldersignerassociation + + :param pki_ezsignfoldersignerassociation_id: (required) :type pki_ezsignfoldersignerassociation_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsignfoldersignerassociationGetObjectV2Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._ezsignfoldersignerassociation_get_object_v2_serialize( + pki_ezsignfoldersignerassociation_id=pki_ezsignfoldersignerassociation_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfoldersignerassociationGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'pki_ezsignfoldersignerassociation_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def ezsignfoldersignerassociation_get_object_v2_without_preload_content( + self, + pki_ezsignfoldersignerassociation_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve an existing Ezsignfoldersignerassociation + + + + :param pki_ezsignfoldersignerassociation_id: (required) + :type pki_ezsignfoldersignerassociation_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignfoldersignerassociation_get_object_v2_serialize( + pki_ezsignfoldersignerassociation_id=pki_ezsignfoldersignerassociation_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsignfoldersignerassociation_get_object_v2" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfoldersignerassociationGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_ezsignfoldersignerassociation_id']: - _path_params['pkiEzsignfoldersignerassociationID'] = _params['pki_ezsignfoldersignerassociation_id'] + def _ezsignfoldersignerassociation_get_object_v2_serialize( + self, + pki_ezsignfoldersignerassociation_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if pki_ezsignfoldersignerassociation_id is not None: + _path_params['pkiEzsignfoldersignerassociationID'] = pki_ezsignfoldersignerassociation_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "EzsignfoldersignerassociationGetObjectV2Response", - '404': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/2/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociationID}', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/2/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociationID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + - @validate_arguments - def ezsignfoldersignerassociation_patch_object_v1(self, pki_ezsignfoldersignerassociation_id : conint(strict=True, ge=0), ezsignfoldersignerassociation_patch_object_v1_request : EzsignfoldersignerassociationPatchObjectV1Request, **kwargs) -> EzsignfoldersignerassociationPatchObjectV1Response: # noqa: E501 - """Patch an existing Ezsignfoldersignerassociation # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.ezsignfoldersignerassociation_patch_object_v1(pki_ezsignfoldersignerassociation_id, ezsignfoldersignerassociation_patch_object_v1_request, async_req=True) - >>> result = thread.get() + @validate_call + def ezsignfoldersignerassociation_patch_object_v1( + self, + pki_ezsignfoldersignerassociation_id: Annotated[int, Field(strict=True, ge=0)], + ezsignfoldersignerassociation_patch_object_v1_request: EzsignfoldersignerassociationPatchObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsignfoldersignerassociationPatchObjectV1Response: + """Patch an existing Ezsignfoldersignerassociation + :param pki_ezsignfoldersignerassociation_id: (required) :type pki_ezsignfoldersignerassociation_id: int :param ezsignfoldersignerassociation_patch_object_v1_request: (required) :type ezsignfoldersignerassociation_patch_object_v1_request: EzsignfoldersignerassociationPatchObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsignfoldersignerassociationPatchObjectV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsignfoldersignerassociation_patch_object_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsignfoldersignerassociation_patch_object_v1_with_http_info(pki_ezsignfoldersignerassociation_id, ezsignfoldersignerassociation_patch_object_v1_request, **kwargs) # noqa: E501 - - @validate_arguments - def ezsignfoldersignerassociation_patch_object_v1_with_http_info(self, pki_ezsignfoldersignerassociation_id : conint(strict=True, ge=0), ezsignfoldersignerassociation_patch_object_v1_request : EzsignfoldersignerassociationPatchObjectV1Request, **kwargs) -> ApiResponse: # noqa: E501 - """Patch an existing Ezsignfoldersignerassociation # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsignfoldersignerassociation_patch_object_v1_with_http_info(pki_ezsignfoldersignerassociation_id, ezsignfoldersignerassociation_patch_object_v1_request, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._ezsignfoldersignerassociation_patch_object_v1_serialize( + pki_ezsignfoldersignerassociation_id=pki_ezsignfoldersignerassociation_id, + ezsignfoldersignerassociation_patch_object_v1_request=ezsignfoldersignerassociation_patch_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfoldersignerassociationPatchObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsignfoldersignerassociation_patch_object_v1_with_http_info( + self, + pki_ezsignfoldersignerassociation_id: Annotated[int, Field(strict=True, ge=0)], + ezsignfoldersignerassociation_patch_object_v1_request: EzsignfoldersignerassociationPatchObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsignfoldersignerassociationPatchObjectV1Response]: + """Patch an existing Ezsignfoldersignerassociation + :param pki_ezsignfoldersignerassociation_id: (required) :type pki_ezsignfoldersignerassociation_id: int :param ezsignfoldersignerassociation_patch_object_v1_request: (required) :type ezsignfoldersignerassociation_patch_object_v1_request: EzsignfoldersignerassociationPatchObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsignfoldersignerassociationPatchObjectV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._ezsignfoldersignerassociation_patch_object_v1_serialize( + pki_ezsignfoldersignerassociation_id=pki_ezsignfoldersignerassociation_id, + ezsignfoldersignerassociation_patch_object_v1_request=ezsignfoldersignerassociation_patch_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfoldersignerassociationPatchObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _params = locals() - _all_params = [ - 'pki_ezsignfoldersignerassociation_id', - 'ezsignfoldersignerassociation_patch_object_v1_request' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + @validate_call + def ezsignfoldersignerassociation_patch_object_v1_without_preload_content( + self, + pki_ezsignfoldersignerassociation_id: Annotated[int, Field(strict=True, ge=0)], + ezsignfoldersignerassociation_patch_object_v1_request: EzsignfoldersignerassociationPatchObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Patch an existing Ezsignfoldersignerassociation + + + :param pki_ezsignfoldersignerassociation_id: (required) + :type pki_ezsignfoldersignerassociation_id: int + :param ezsignfoldersignerassociation_patch_object_v1_request: (required) + :type ezsignfoldersignerassociation_patch_object_v1_request: EzsignfoldersignerassociationPatchObjectV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignfoldersignerassociation_patch_object_v1_serialize( + pki_ezsignfoldersignerassociation_id=pki_ezsignfoldersignerassociation_id, + ezsignfoldersignerassociation_patch_object_v1_request=ezsignfoldersignerassociation_patch_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsignfoldersignerassociation_patch_object_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfoldersignerassociationPatchObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_ezsignfoldersignerassociation_id']: - _path_params['pkiEzsignfoldersignerassociationID'] = _params['pki_ezsignfoldersignerassociation_id'] + def _ezsignfoldersignerassociation_patch_object_v1_serialize( + self, + pki_ezsignfoldersignerassociation_id, + ezsignfoldersignerassociation_patch_object_v1_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if pki_ezsignfoldersignerassociation_id is not None: + _path_params['pkiEzsignfoldersignerassociationID'] = pki_ezsignfoldersignerassociation_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['ezsignfoldersignerassociation_patch_object_v1_request'] is not None: - _body_params = _params['ezsignfoldersignerassociation_patch_object_v1_request'] + if ezsignfoldersignerassociation_patch_object_v1_request is not None: + _body_params = ezsignfoldersignerassociation_patch_object_v1_request + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '200': "EzsignfoldersignerassociationPatchObjectV1Response", - '404': "CommonResponseError", - '422': "CommonResponseError", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociationID}', 'PATCH', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='PATCH', + resource_path='/1/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociationID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/eZmaxApi/api/object_ezsignfoldertype_api.py b/eZmaxApi/api/object_ezsignfoldertype_api.py index bce4c5104..24379efca 100644 --- a/eZmaxApi/api/object_ezsignfoldertype_api.py +++ b/eZmaxApi/api/object_ezsignfoldertype_api.py @@ -13,14 +13,20 @@ """ # noqa: E501 -import re # noqa: F401 import io import warnings -from pydantic import validate_arguments, ValidationError +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Dict, List, Optional, Tuple, Union, Any +try: + from typing import Annotated +except ImportError: + from typing_extensions import Annotated + +from pydantic import Field from typing_extensions import Annotated -from pydantic import Field, StrictStr, conint +from pydantic import StrictStr, field_validator from typing import Optional @@ -36,10 +42,7 @@ from eZmaxApi.api_client import ApiClient from eZmaxApi.api_response import ApiResponse -from eZmaxApi.exceptions import ( # noqa: F401 - ApiTypeError, - ApiValueError -) +from eZmaxApi.rest import RESTResponseType class ObjectEzsignfoldertypeApi: @@ -54,320 +57,593 @@ def __init__(self, api_client=None) -> None: api_client = ApiClient.get_default() self.api_client = api_client - @validate_arguments - def ezsignfoldertype_create_object_v1(self, ezsignfoldertype_create_object_v1_request : EzsignfoldertypeCreateObjectV1Request, **kwargs) -> EzsignfoldertypeCreateObjectV1Response: # noqa: E501 - """Create a new Ezsignfoldertype # noqa: E501 - The endpoint allows to create one or many elements at once. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def ezsignfoldertype_create_object_v1( + self, + ezsignfoldertype_create_object_v1_request: EzsignfoldertypeCreateObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsignfoldertypeCreateObjectV1Response: + """Create a new Ezsignfoldertype - >>> thread = api.ezsignfoldertype_create_object_v1(ezsignfoldertype_create_object_v1_request, async_req=True) - >>> result = thread.get() + The endpoint allows to create one or many elements at once. :param ezsignfoldertype_create_object_v1_request: (required) :type ezsignfoldertype_create_object_v1_request: EzsignfoldertypeCreateObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsignfoldertypeCreateObjectV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsignfoldertype_create_object_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsignfoldertype_create_object_v1_with_http_info(ezsignfoldertype_create_object_v1_request, **kwargs) # noqa: E501 - - @validate_arguments - def ezsignfoldertype_create_object_v1_with_http_info(self, ezsignfoldertype_create_object_v1_request : EzsignfoldertypeCreateObjectV1Request, **kwargs) -> ApiResponse: # noqa: E501 - """Create a new Ezsignfoldertype # noqa: E501 - - The endpoint allows to create one or many elements at once. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsignfoldertype_create_object_v1_with_http_info(ezsignfoldertype_create_object_v1_request, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._ezsignfoldertype_create_object_v1_serialize( + ezsignfoldertype_create_object_v1_request=ezsignfoldertype_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "EzsignfoldertypeCreateObjectV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsignfoldertype_create_object_v1_with_http_info( + self, + ezsignfoldertype_create_object_v1_request: EzsignfoldertypeCreateObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsignfoldertypeCreateObjectV1Response]: + """Create a new Ezsignfoldertype + + The endpoint allows to create one or many elements at once. :param ezsignfoldertype_create_object_v1_request: (required) :type ezsignfoldertype_create_object_v1_request: EzsignfoldertypeCreateObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsignfoldertypeCreateObjectV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._ezsignfoldertype_create_object_v1_serialize( + ezsignfoldertype_create_object_v1_request=ezsignfoldertype_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "EzsignfoldertypeCreateObjectV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _params = locals() - _all_params = [ - 'ezsignfoldertype_create_object_v1_request' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + @validate_call + def ezsignfoldertype_create_object_v1_without_preload_content( + self, + ezsignfoldertype_create_object_v1_request: EzsignfoldertypeCreateObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Create a new Ezsignfoldertype + + The endpoint allows to create one or many elements at once. + + :param ezsignfoldertype_create_object_v1_request: (required) + :type ezsignfoldertype_create_object_v1_request: EzsignfoldertypeCreateObjectV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignfoldertype_create_object_v1_serialize( + ezsignfoldertype_create_object_v1_request=ezsignfoldertype_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsignfoldertype_create_object_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '201': "EzsignfoldertypeCreateObjectV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} + def _ezsignfoldertype_create_object_v1_serialize( + self, + ezsignfoldertype_create_object_v1_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['ezsignfoldertype_create_object_v1_request'] is not None: - _body_params = _params['ezsignfoldertype_create_object_v1_request'] + if ezsignfoldertype_create_object_v1_request is not None: + _body_params = ezsignfoldertype_create_object_v1_request + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '201': "EzsignfoldertypeCreateObjectV1Response", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsignfoldertype', 'POST', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='POST', + resource_path='/1/object/ezsignfoldertype', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) - @validate_arguments - def ezsignfoldertype_edit_object_v1(self, pki_ezsignfoldertype_id : conint(strict=True, ge=0), ezsignfoldertype_edit_object_v1_request : EzsignfoldertypeEditObjectV1Request, **kwargs) -> EzsignfoldertypeEditObjectV1Response: # noqa: E501 - """Edit an existing Ezsignfoldertype # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.ezsignfoldertype_edit_object_v1(pki_ezsignfoldertype_id, ezsignfoldertype_edit_object_v1_request, async_req=True) - >>> result = thread.get() + + @validate_call + def ezsignfoldertype_edit_object_v1( + self, + pki_ezsignfoldertype_id: Annotated[int, Field(strict=True, ge=0)], + ezsignfoldertype_edit_object_v1_request: EzsignfoldertypeEditObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsignfoldertypeEditObjectV1Response: + """Edit an existing Ezsignfoldertype + + :param pki_ezsignfoldertype_id: (required) :type pki_ezsignfoldertype_id: int :param ezsignfoldertype_edit_object_v1_request: (required) :type ezsignfoldertype_edit_object_v1_request: EzsignfoldertypeEditObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsignfoldertypeEditObjectV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsignfoldertype_edit_object_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsignfoldertype_edit_object_v1_with_http_info(pki_ezsignfoldertype_id, ezsignfoldertype_edit_object_v1_request, **kwargs) # noqa: E501 - - @validate_arguments - def ezsignfoldertype_edit_object_v1_with_http_info(self, pki_ezsignfoldertype_id : conint(strict=True, ge=0), ezsignfoldertype_edit_object_v1_request : EzsignfoldertypeEditObjectV1Request, **kwargs) -> ApiResponse: # noqa: E501 - """Edit an existing Ezsignfoldertype # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsignfoldertype_edit_object_v1_with_http_info(pki_ezsignfoldertype_id, ezsignfoldertype_edit_object_v1_request, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._ezsignfoldertype_edit_object_v1_serialize( + pki_ezsignfoldertype_id=pki_ezsignfoldertype_id, + ezsignfoldertype_edit_object_v1_request=ezsignfoldertype_edit_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfoldertypeEditObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsignfoldertype_edit_object_v1_with_http_info( + self, + pki_ezsignfoldertype_id: Annotated[int, Field(strict=True, ge=0)], + ezsignfoldertype_edit_object_v1_request: EzsignfoldertypeEditObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsignfoldertypeEditObjectV1Response]: + """Edit an existing Ezsignfoldertype + + :param pki_ezsignfoldertype_id: (required) :type pki_ezsignfoldertype_id: int :param ezsignfoldertype_edit_object_v1_request: (required) :type ezsignfoldertype_edit_object_v1_request: EzsignfoldertypeEditObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsignfoldertypeEditObjectV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._ezsignfoldertype_edit_object_v1_serialize( + pki_ezsignfoldertype_id=pki_ezsignfoldertype_id, + ezsignfoldertype_edit_object_v1_request=ezsignfoldertype_edit_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfoldertypeEditObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'pki_ezsignfoldertype_id', - 'ezsignfoldertype_edit_object_v1_request' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def ezsignfoldertype_edit_object_v1_without_preload_content( + self, + pki_ezsignfoldertype_id: Annotated[int, Field(strict=True, ge=0)], + ezsignfoldertype_edit_object_v1_request: EzsignfoldertypeEditObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Edit an existing Ezsignfoldertype + + + + :param pki_ezsignfoldertype_id: (required) + :type pki_ezsignfoldertype_id: int + :param ezsignfoldertype_edit_object_v1_request: (required) + :type ezsignfoldertype_edit_object_v1_request: EzsignfoldertypeEditObjectV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignfoldertype_edit_object_v1_serialize( + pki_ezsignfoldertype_id=pki_ezsignfoldertype_id, + ezsignfoldertype_edit_object_v1_request=ezsignfoldertype_edit_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsignfoldertype_edit_object_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfoldertypeEditObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_ezsignfoldertype_id']: - _path_params['pkiEzsignfoldertypeID'] = _params['pki_ezsignfoldertype_id'] + def _ezsignfoldertype_edit_object_v1_serialize( + self, + pki_ezsignfoldertype_id, + ezsignfoldertype_edit_object_v1_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_ezsignfoldertype_id is not None: + _path_params['pkiEzsignfoldertypeID'] = pki_ezsignfoldertype_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['ezsignfoldertype_edit_object_v1_request'] is not None: - _body_params = _params['ezsignfoldertype_edit_object_v1_request'] + if ezsignfoldertype_edit_object_v1_request is not None: + _body_params = ezsignfoldertype_edit_object_v1_request + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '200': "EzsignfoldertypeEditObjectV1Response", - '404': "CommonResponseError", - '422': "CommonResponseError", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsignfoldertype/{pkiEzsignfoldertypeID}', 'PUT', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='PUT', + resource_path='/1/object/ezsignfoldertype/{pkiEzsignfoldertypeID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + - @validate_arguments - def ezsignfoldertype_get_autocomplete_v1(self, s_selector : Annotated[StrictStr, Field(..., description="The type of Ezsignfoldertypes to return")], e_filter_active : Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, s_query : Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, accept_language : Optional[HeaderAcceptLanguage] = None, **kwargs) -> CommonGetAutocompleteV1Response: # noqa: E501 - """(Deprecated) Retrieve Ezsignfoldertypes and IDs # noqa: E501 - Get the list of Ezsignfoldertypes to be used in a dropdown or autocomplete control. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.ezsignfoldertype_get_autocomplete_v1(s_selector, e_filter_active, s_query, accept_language, async_req=True) - >>> result = thread.get() + @validate_call + def ezsignfoldertype_get_autocomplete_v1( + self, + s_selector: Annotated[StrictStr, Field(description="The type of Ezsignfoldertypes to return")], + e_filter_active: Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, + s_query: Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> CommonGetAutocompleteV1Response: + """(Deprecated) Retrieve Ezsignfoldertypes and IDs + + Get the list of Ezsignfoldertypes to be used in a dropdown or autocomplete control. :param s_selector: The type of Ezsignfoldertypes to return (required) :type s_selector: str @@ -377,33 +653,77 @@ def ezsignfoldertype_get_autocomplete_v1(self, s_selector : Annotated[StrictStr, :type s_query: str :param accept_language: :type accept_language: HeaderAcceptLanguage - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: CommonGetAutocompleteV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsignfoldertype_get_autocomplete_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsignfoldertype_get_autocomplete_v1_with_http_info(s_selector, e_filter_active, s_query, accept_language, **kwargs) # noqa: E501 - - @validate_arguments - def ezsignfoldertype_get_autocomplete_v1_with_http_info(self, s_selector : Annotated[StrictStr, Field(..., description="The type of Ezsignfoldertypes to return")], e_filter_active : Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, s_query : Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, accept_language : Optional[HeaderAcceptLanguage] = None, **kwargs) -> ApiResponse: # noqa: E501 - """(Deprecated) Retrieve Ezsignfoldertypes and IDs # noqa: E501 - - Get the list of Ezsignfoldertypes to be used in a dropdown or autocomplete control. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsignfoldertype_get_autocomplete_v1_with_http_info(s_selector, e_filter_active, s_query, accept_language, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + warnings.warn("GET /1/object/ezsignfoldertype/getAutocomplete/{sSelector} is deprecated.", DeprecationWarning) + + _param = self._ezsignfoldertype_get_autocomplete_v1_serialize( + s_selector=s_selector, + e_filter_active=e_filter_active, + s_query=s_query, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "CommonGetAutocompleteV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsignfoldertype_get_autocomplete_v1_with_http_info( + self, + s_selector: Annotated[StrictStr, Field(description="The type of Ezsignfoldertypes to return")], + e_filter_active: Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, + s_query: Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[CommonGetAutocompleteV1Response]: + """(Deprecated) Retrieve Ezsignfoldertypes and IDs + + Get the list of Ezsignfoldertypes to be used in a dropdown or autocomplete control. :param s_selector: The type of Ezsignfoldertypes to return (required) :type s_selector: str @@ -413,127 +733,227 @@ def ezsignfoldertype_get_autocomplete_v1_with_http_info(self, s_selector : Annot :type s_query: str :param accept_language: :type accept_language: HeaderAcceptLanguage - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(CommonGetAutocompleteV1Response, status_code(int), headers(HTTPHeaderDict)) - """ - + """ # noqa: E501 warnings.warn("GET /1/object/ezsignfoldertype/getAutocomplete/{sSelector} is deprecated.", DeprecationWarning) - _params = locals() + _param = self._ezsignfoldertype_get_autocomplete_v1_serialize( + s_selector=s_selector, + e_filter_active=e_filter_active, + s_query=s_query, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _all_params = [ - 's_selector', - 'e_filter_active', - 's_query', - 'accept_language' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + _response_types_map: Dict[str, Optional[str]] = { + '200': "CommonGetAutocompleteV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def ezsignfoldertype_get_autocomplete_v1_without_preload_content( + self, + s_selector: Annotated[StrictStr, Field(description="The type of Ezsignfoldertypes to return")], + e_filter_active: Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, + s_query: Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """(Deprecated) Retrieve Ezsignfoldertypes and IDs + + Get the list of Ezsignfoldertypes to be used in a dropdown or autocomplete control. + + :param s_selector: The type of Ezsignfoldertypes to return (required) + :type s_selector: str + :param e_filter_active: Specify which results we want to display. + :type e_filter_active: str + :param s_query: Allow to filter the returned results + :type s_query: str + :param accept_language: + :type accept_language: HeaderAcceptLanguage + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + warnings.warn("GET /1/object/ezsignfoldertype/getAutocomplete/{sSelector} is deprecated.", DeprecationWarning) + + _param = self._ezsignfoldertype_get_autocomplete_v1_serialize( + s_selector=s_selector, + e_filter_active=e_filter_active, + s_query=s_query, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsignfoldertype_get_autocomplete_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "CommonGetAutocompleteV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['s_selector']: - _path_params['sSelector'] = _params['s_selector'] + def _ezsignfoldertype_get_autocomplete_v1_serialize( + self, + s_selector, + e_filter_active, + s_query, + accept_language, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None - # process the query parameters - _query_params = [] - if _params.get('e_filter_active') is not None: # noqa: E501 - _query_params.append(('eFilterActive', _params['e_filter_active'])) + _collection_formats: Dict[str, str] = { + } - if _params.get('s_query') is not None: # noqa: E501 - _query_params.append(('sQuery', _params['s_query'])) + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if s_selector is not None: + _path_params['sSelector'] = s_selector + # process the query parameters + if e_filter_active is not None: + + _query_params.append(('eFilterActive', e_filter_active)) + + if s_query is not None: + + _query_params.append(('sQuery', s_query)) + # process the header parameters - _header_params = dict(_params.get('_headers', {})) - if _params['accept_language']: - _header_params['Accept-Language'] = _params['accept_language'] - + if accept_language is not None: + _header_params['Accept-Language'] = accept_language # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "CommonGetAutocompleteV1Response", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsignfoldertype/getAutocomplete/{sSelector}', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/1/object/ezsignfoldertype/getAutocomplete/{sSelector}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + - @validate_arguments - def ezsignfoldertype_get_autocomplete_v2(self, s_selector : Annotated[StrictStr, Field(..., description="The type of Ezsignfoldertypes to return")], e_filter_active : Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, s_query : Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, accept_language : Optional[HeaderAcceptLanguage] = None, **kwargs) -> EzsignfoldertypeGetAutocompleteV2Response: # noqa: E501 - """Retrieve Ezsignfoldertypes and IDs # noqa: E501 - Get the list of Ezsignfoldertype to be used in a dropdown or autocomplete control. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def ezsignfoldertype_get_autocomplete_v2( + self, + s_selector: Annotated[StrictStr, Field(description="The type of Ezsignfoldertypes to return")], + e_filter_active: Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, + s_query: Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsignfoldertypeGetAutocompleteV2Response: + """Retrieve Ezsignfoldertypes and IDs - >>> thread = api.ezsignfoldertype_get_autocomplete_v2(s_selector, e_filter_active, s_query, accept_language, async_req=True) - >>> result = thread.get() + Get the list of Ezsignfoldertype to be used in a dropdown or autocomplete control. :param s_selector: The type of Ezsignfoldertypes to return (required) :type s_selector: str @@ -543,33 +963,76 @@ def ezsignfoldertype_get_autocomplete_v2(self, s_selector : Annotated[StrictStr, :type s_query: str :param accept_language: :type accept_language: HeaderAcceptLanguage - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsignfoldertypeGetAutocompleteV2Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsignfoldertype_get_autocomplete_v2_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsignfoldertype_get_autocomplete_v2_with_http_info(s_selector, e_filter_active, s_query, accept_language, **kwargs) # noqa: E501 - - @validate_arguments - def ezsignfoldertype_get_autocomplete_v2_with_http_info(self, s_selector : Annotated[StrictStr, Field(..., description="The type of Ezsignfoldertypes to return")], e_filter_active : Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, s_query : Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, accept_language : Optional[HeaderAcceptLanguage] = None, **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve Ezsignfoldertypes and IDs # noqa: E501 - - Get the list of Ezsignfoldertype to be used in a dropdown or autocomplete control. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsignfoldertype_get_autocomplete_v2_with_http_info(s_selector, e_filter_active, s_query, accept_language, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._ezsignfoldertype_get_autocomplete_v2_serialize( + s_selector=s_selector, + e_filter_active=e_filter_active, + s_query=s_query, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfoldertypeGetAutocompleteV2Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsignfoldertype_get_autocomplete_v2_with_http_info( + self, + s_selector: Annotated[StrictStr, Field(description="The type of Ezsignfoldertypes to return")], + e_filter_active: Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, + s_query: Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsignfoldertypeGetAutocompleteV2Response]: + """Retrieve Ezsignfoldertypes and IDs + + Get the list of Ezsignfoldertype to be used in a dropdown or autocomplete control. :param s_selector: The type of Ezsignfoldertypes to return (required) :type s_selector: str @@ -579,125 +1042,226 @@ def ezsignfoldertype_get_autocomplete_v2_with_http_info(self, s_selector : Annot :type s_query: str :param accept_language: :type accept_language: HeaderAcceptLanguage - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsignfoldertypeGetAutocompleteV2Response, status_code(int), headers(HTTPHeaderDict)) - """ - - _params = locals() - - _all_params = [ - 's_selector', - 'e_filter_active', - 's_query', - 'accept_language' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + """ # noqa: E501 + + _param = self._ezsignfoldertype_get_autocomplete_v2_serialize( + s_selector=s_selector, + e_filter_active=e_filter_active, + s_query=s_query, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfoldertypeGetAutocompleteV2Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def ezsignfoldertype_get_autocomplete_v2_without_preload_content( + self, + s_selector: Annotated[StrictStr, Field(description="The type of Ezsignfoldertypes to return")], + e_filter_active: Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, + s_query: Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve Ezsignfoldertypes and IDs + + Get the list of Ezsignfoldertype to be used in a dropdown or autocomplete control. + + :param s_selector: The type of Ezsignfoldertypes to return (required) + :type s_selector: str + :param e_filter_active: Specify which results we want to display. + :type e_filter_active: str + :param s_query: Allow to filter the returned results + :type s_query: str + :param accept_language: + :type accept_language: HeaderAcceptLanguage + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignfoldertype_get_autocomplete_v2_serialize( + s_selector=s_selector, + e_filter_active=e_filter_active, + s_query=s_query, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsignfoldertype_get_autocomplete_v2" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfoldertypeGetAutocompleteV2Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['s_selector']: - _path_params['sSelector'] = _params['s_selector'] + def _ezsignfoldertype_get_autocomplete_v2_serialize( + self, + s_selector, + e_filter_active, + s_query, + accept_language, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None - # process the query parameters - _query_params = [] - if _params.get('e_filter_active') is not None: # noqa: E501 - _query_params.append(('eFilterActive', _params['e_filter_active'])) + _collection_formats: Dict[str, str] = { + } - if _params.get('s_query') is not None: # noqa: E501 - _query_params.append(('sQuery', _params['s_query'])) + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if s_selector is not None: + _path_params['sSelector'] = s_selector + # process the query parameters + if e_filter_active is not None: + + _query_params.append(('eFilterActive', e_filter_active)) + + if s_query is not None: + + _query_params.append(('sQuery', s_query)) + # process the header parameters - _header_params = dict(_params.get('_headers', {})) - if _params['accept_language']: - _header_params['Accept-Language'] = _params['accept_language'] - + if accept_language is not None: + _header_params['Accept-Language'] = accept_language # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "EzsignfoldertypeGetAutocompleteV2Response", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/2/object/ezsignfoldertype/getAutocomplete/{sSelector}', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/2/object/ezsignfoldertype/getAutocomplete/{sSelector}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) - @validate_arguments - def ezsignfoldertype_get_list_v1(self, e_order_by : Annotated[Optional[StrictStr], Field(description="Specify how you want the results to be sorted")] = None, i_row_max : Optional[conint(strict=True, le=10000, ge=1)] = None, i_row_offset : Optional[conint(strict=True, ge=0)] = None, accept_language : Optional[HeaderAcceptLanguage] = None, s_filter : Optional[StrictStr] = None, **kwargs) -> EzsignfoldertypeGetListV1Response: # noqa: E501 - """Retrieve Ezsignfoldertype list # noqa: E501 - Enum values that can be filtered in query parameter *sFilter*: | Variable | Valid values | |---|---| | eEzsignfoldertypePrivacylevel | User
Usergroup | # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.ezsignfoldertype_get_list_v1(e_order_by, i_row_max, i_row_offset, accept_language, s_filter, async_req=True) - >>> result = thread.get() + + @validate_call + def ezsignfoldertype_get_list_v1( + self, + e_order_by: Annotated[Optional[StrictStr], Field(description="Specify how you want the results to be sorted")] = None, + i_row_max: Optional[Annotated[int, Field(le=10000, strict=True, ge=1)]] = None, + i_row_offset: Optional[Annotated[int, Field(strict=True, ge=0)]] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + s_filter: Optional[StrictStr] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsignfoldertypeGetListV1Response: + """Retrieve Ezsignfoldertype list + + Enum values that can be filtered in query parameter *sFilter*: | Variable | Valid values | |---|---| | eEzsignfoldertypePrivacylevel | User
Usergroup | :param e_order_by: Specify how you want the results to be sorted :type e_order_by: str @@ -709,33 +1273,79 @@ def ezsignfoldertype_get_list_v1(self, e_order_by : Annotated[Optional[StrictStr :type accept_language: HeaderAcceptLanguage :param s_filter: :type s_filter: str - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsignfoldertypeGetListV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsignfoldertype_get_list_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsignfoldertype_get_list_v1_with_http_info(e_order_by, i_row_max, i_row_offset, accept_language, s_filter, **kwargs) # noqa: E501 - - @validate_arguments - def ezsignfoldertype_get_list_v1_with_http_info(self, e_order_by : Annotated[Optional[StrictStr], Field(description="Specify how you want the results to be sorted")] = None, i_row_max : Optional[conint(strict=True, le=10000, ge=1)] = None, i_row_offset : Optional[conint(strict=True, ge=0)] = None, accept_language : Optional[HeaderAcceptLanguage] = None, s_filter : Optional[StrictStr] = None, **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve Ezsignfoldertype list # noqa: E501 - - Enum values that can be filtered in query parameter *sFilter*: | Variable | Valid values | |---|---| | eEzsignfoldertypePrivacylevel | User
Usergroup | # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsignfoldertype_get_list_v1_with_http_info(e_order_by, i_row_max, i_row_offset, accept_language, s_filter, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._ezsignfoldertype_get_list_v1_serialize( + e_order_by=e_order_by, + i_row_max=i_row_max, + i_row_offset=i_row_offset, + accept_language=accept_language, + s_filter=s_filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfoldertypeGetListV1Response", + '406': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsignfoldertype_get_list_v1_with_http_info( + self, + e_order_by: Annotated[Optional[StrictStr], Field(description="Specify how you want the results to be sorted")] = None, + i_row_max: Optional[Annotated[int, Field(le=10000, strict=True, ge=1)]] = None, + i_row_offset: Optional[Annotated[int, Field(strict=True, ge=0)]] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + s_filter: Optional[StrictStr] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsignfoldertypeGetListV1Response]: + """Retrieve Ezsignfoldertype list + + Enum values that can be filtered in query parameter *sFilter*: | Variable | Valid values | |---|---| | eEzsignfoldertypePrivacylevel | User
Usergroup | :param e_order_by: Specify how you want the results to be sorted :type e_order_by: str @@ -747,257 +1357,473 @@ def ezsignfoldertype_get_list_v1_with_http_info(self, e_order_by : Annotated[Opt :type accept_language: HeaderAcceptLanguage :param s_filter: :type s_filter: str - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsignfoldertypeGetListV1Response, status_code(int), headers(HTTPHeaderDict)) - """ - - _params = locals() - - _all_params = [ - 'e_order_by', - 'i_row_max', - 'i_row_offset', - 'accept_language', - 's_filter' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' - ] + """ # noqa: E501 + + _param = self._ezsignfoldertype_get_list_v1_serialize( + e_order_by=e_order_by, + i_row_max=i_row_max, + i_row_offset=i_row_offset, + accept_language=accept_language, + s_filter=s_filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsignfoldertype_get_list_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfoldertypeGetListV1Response", + '406': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _collection_formats = {} - # process the path parameters - _path_params = {} + @validate_call + def ezsignfoldertype_get_list_v1_without_preload_content( + self, + e_order_by: Annotated[Optional[StrictStr], Field(description="Specify how you want the results to be sorted")] = None, + i_row_max: Optional[Annotated[int, Field(le=10000, strict=True, ge=1)]] = None, + i_row_offset: Optional[Annotated[int, Field(strict=True, ge=0)]] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + s_filter: Optional[StrictStr] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve Ezsignfoldertype list - # process the query parameters - _query_params = [] - if _params.get('e_order_by') is not None: # noqa: E501 - _query_params.append(('eOrderBy', _params['e_order_by'])) + Enum values that can be filtered in query parameter *sFilter*: | Variable | Valid values | |---|---| | eEzsignfoldertypePrivacylevel | User
Usergroup | + + :param e_order_by: Specify how you want the results to be sorted + :type e_order_by: str + :param i_row_max: + :type i_row_max: int + :param i_row_offset: + :type i_row_offset: int + :param accept_language: + :type accept_language: HeaderAcceptLanguage + :param s_filter: + :type s_filter: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignfoldertype_get_list_v1_serialize( + e_order_by=e_order_by, + i_row_max=i_row_max, + i_row_offset=i_row_offset, + accept_language=accept_language, + s_filter=s_filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - if _params.get('i_row_max') is not None: # noqa: E501 - _query_params.append(('iRowMax', _params['i_row_max'])) + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfoldertypeGetListV1Response", + '406': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - if _params.get('i_row_offset') is not None: # noqa: E501 - _query_params.append(('iRowOffset', _params['i_row_offset'])) - if _params.get('s_filter') is not None: # noqa: E501 - _query_params.append(('sFilter', _params['s_filter'])) + def _ezsignfoldertype_get_list_v1_serialize( + self, + e_order_by, + i_row_max, + i_row_offset, + accept_language, + s_filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: - # process the header parameters - _header_params = dict(_params.get('_headers', {})) - if _params['accept_language']: - _header_params['Accept-Language'] = _params['accept_language'] + _host = None + + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if e_order_by is not None: + + _query_params.append(('eOrderBy', e_order_by)) + + if i_row_max is not None: + + _query_params.append(('iRowMax', i_row_max)) + + if i_row_offset is not None: + + _query_params.append(('iRowOffset', i_row_offset)) + + if s_filter is not None: + + _query_params.append(('sFilter', s_filter)) + + # process the header parameters + if accept_language is not None: + _header_params['Accept-Language'] = accept_language # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet']) # noqa: E501 + [ + 'application/json', + 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "EzsignfoldertypeGetListV1Response", - '406': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsignfoldertype/getList', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/1/object/ezsignfoldertype/getList', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + - @validate_arguments - def ezsignfoldertype_get_object_v2(self, pki_ezsignfoldertype_id : conint(strict=True, ge=0), **kwargs) -> EzsignfoldertypeGetObjectV2Response: # noqa: E501 - """Retrieve an existing Ezsignfoldertype # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.ezsignfoldertype_get_object_v2(pki_ezsignfoldertype_id, async_req=True) - >>> result = thread.get() + @validate_call + def ezsignfoldertype_get_object_v2( + self, + pki_ezsignfoldertype_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsignfoldertypeGetObjectV2Response: + """Retrieve an existing Ezsignfoldertype + + :param pki_ezsignfoldertype_id: (required) :type pki_ezsignfoldertype_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsignfoldertypeGetObjectV2Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsignfoldertype_get_object_v2_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsignfoldertype_get_object_v2_with_http_info(pki_ezsignfoldertype_id, **kwargs) # noqa: E501 - - @validate_arguments - def ezsignfoldertype_get_object_v2_with_http_info(self, pki_ezsignfoldertype_id : conint(strict=True, ge=0), **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve an existing Ezsignfoldertype # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsignfoldertype_get_object_v2_with_http_info(pki_ezsignfoldertype_id, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._ezsignfoldertype_get_object_v2_serialize( + pki_ezsignfoldertype_id=pki_ezsignfoldertype_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfoldertypeGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsignfoldertype_get_object_v2_with_http_info( + self, + pki_ezsignfoldertype_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsignfoldertypeGetObjectV2Response]: + """Retrieve an existing Ezsignfoldertype + + :param pki_ezsignfoldertype_id: (required) :type pki_ezsignfoldertype_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsignfoldertypeGetObjectV2Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._ezsignfoldertype_get_object_v2_serialize( + pki_ezsignfoldertype_id=pki_ezsignfoldertype_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfoldertypeGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'pki_ezsignfoldertype_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def ezsignfoldertype_get_object_v2_without_preload_content( + self, + pki_ezsignfoldertype_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve an existing Ezsignfoldertype + + + + :param pki_ezsignfoldertype_id: (required) + :type pki_ezsignfoldertype_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignfoldertype_get_object_v2_serialize( + pki_ezsignfoldertype_id=pki_ezsignfoldertype_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsignfoldertype_get_object_v2" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignfoldertypeGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_ezsignfoldertype_id']: - _path_params['pkiEzsignfoldertypeID'] = _params['pki_ezsignfoldertype_id'] + def _ezsignfoldertype_get_object_v2_serialize( + self, + pki_ezsignfoldertype_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_ezsignfoldertype_id is not None: + _path_params['pkiEzsignfoldertypeID'] = pki_ezsignfoldertype_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "EzsignfoldertypeGetObjectV2Response", - '404': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/2/object/ezsignfoldertype/{pkiEzsignfoldertypeID}', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/2/object/ezsignfoldertype/{pkiEzsignfoldertypeID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/eZmaxApi/api/object_ezsignformfieldgroup_api.py b/eZmaxApi/api/object_ezsignformfieldgroup_api.py index e01f8b7f5..c5c07ec10 100644 --- a/eZmaxApi/api/object_ezsignformfieldgroup_api.py +++ b/eZmaxApi/api/object_ezsignformfieldgroup_api.py @@ -13,14 +13,19 @@ """ # noqa: E501 -import re # noqa: F401 import io import warnings -from pydantic import validate_arguments, ValidationError +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Dict, List, Optional, Tuple, Union, Any -from pydantic import conint +try: + from typing import Annotated +except ImportError: + from typing_extensions import Annotated +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.ezsignformfieldgroup_create_object_v1_request import EzsignformfieldgroupCreateObjectV1Request from eZmaxApi.models.ezsignformfieldgroup_create_object_v1_response import EzsignformfieldgroupCreateObjectV1Response from eZmaxApi.models.ezsignformfieldgroup_delete_object_v1_response import EzsignformfieldgroupDeleteObjectV1Response @@ -30,10 +35,7 @@ from eZmaxApi.api_client import ApiClient from eZmaxApi.api_response import ApiResponse -from eZmaxApi.exceptions import ( # noqa: F401 - ApiTypeError, - ApiValueError -) +from eZmaxApi.rest import RESTResponseType class ObjectEzsignformfieldgroupApi: @@ -48,589 +50,1090 @@ def __init__(self, api_client=None) -> None: api_client = ApiClient.get_default() self.api_client = api_client - @validate_arguments - def ezsignformfieldgroup_create_object_v1(self, ezsignformfieldgroup_create_object_v1_request : EzsignformfieldgroupCreateObjectV1Request, **kwargs) -> EzsignformfieldgroupCreateObjectV1Response: # noqa: E501 - """Create a new Ezsignformfieldgroup # noqa: E501 - The endpoint allows to create one or many elements at once. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def ezsignformfieldgroup_create_object_v1( + self, + ezsignformfieldgroup_create_object_v1_request: EzsignformfieldgroupCreateObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsignformfieldgroupCreateObjectV1Response: + """Create a new Ezsignformfieldgroup - >>> thread = api.ezsignformfieldgroup_create_object_v1(ezsignformfieldgroup_create_object_v1_request, async_req=True) - >>> result = thread.get() + The endpoint allows to create one or many elements at once. :param ezsignformfieldgroup_create_object_v1_request: (required) :type ezsignformfieldgroup_create_object_v1_request: EzsignformfieldgroupCreateObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsignformfieldgroupCreateObjectV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsignformfieldgroup_create_object_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsignformfieldgroup_create_object_v1_with_http_info(ezsignformfieldgroup_create_object_v1_request, **kwargs) # noqa: E501 - - @validate_arguments - def ezsignformfieldgroup_create_object_v1_with_http_info(self, ezsignformfieldgroup_create_object_v1_request : EzsignformfieldgroupCreateObjectV1Request, **kwargs) -> ApiResponse: # noqa: E501 - """Create a new Ezsignformfieldgroup # noqa: E501 - - The endpoint allows to create one or many elements at once. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsignformfieldgroup_create_object_v1_with_http_info(ezsignformfieldgroup_create_object_v1_request, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._ezsignformfieldgroup_create_object_v1_serialize( + ezsignformfieldgroup_create_object_v1_request=ezsignformfieldgroup_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "EzsignformfieldgroupCreateObjectV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsignformfieldgroup_create_object_v1_with_http_info( + self, + ezsignformfieldgroup_create_object_v1_request: EzsignformfieldgroupCreateObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsignformfieldgroupCreateObjectV1Response]: + """Create a new Ezsignformfieldgroup + + The endpoint allows to create one or many elements at once. :param ezsignformfieldgroup_create_object_v1_request: (required) :type ezsignformfieldgroup_create_object_v1_request: EzsignformfieldgroupCreateObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsignformfieldgroupCreateObjectV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._ezsignformfieldgroup_create_object_v1_serialize( + ezsignformfieldgroup_create_object_v1_request=ezsignformfieldgroup_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '201': "EzsignformfieldgroupCreateObjectV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'ezsignformfieldgroup_create_object_v1_request' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def ezsignformfieldgroup_create_object_v1_without_preload_content( + self, + ezsignformfieldgroup_create_object_v1_request: EzsignformfieldgroupCreateObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Create a new Ezsignformfieldgroup + + The endpoint allows to create one or many elements at once. + + :param ezsignformfieldgroup_create_object_v1_request: (required) + :type ezsignformfieldgroup_create_object_v1_request: EzsignformfieldgroupCreateObjectV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignformfieldgroup_create_object_v1_serialize( + ezsignformfieldgroup_create_object_v1_request=ezsignformfieldgroup_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsignformfieldgroup_create_object_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '201': "EzsignformfieldgroupCreateObjectV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} + def _ezsignformfieldgroup_create_object_v1_serialize( + self, + ezsignformfieldgroup_create_object_v1_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['ezsignformfieldgroup_create_object_v1_request'] is not None: - _body_params = _params['ezsignformfieldgroup_create_object_v1_request'] + if ezsignformfieldgroup_create_object_v1_request is not None: + _body_params = ezsignformfieldgroup_create_object_v1_request + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '201': "EzsignformfieldgroupCreateObjectV1Response", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsignformfieldgroup', 'POST', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='POST', + resource_path='/1/object/ezsignformfieldgroup', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) - @validate_arguments - def ezsignformfieldgroup_delete_object_v1(self, pki_ezsignformfieldgroup_id : conint(strict=True, ge=0), **kwargs) -> EzsignformfieldgroupDeleteObjectV1Response: # noqa: E501 - """Delete an existing Ezsignformfieldgroup # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.ezsignformfieldgroup_delete_object_v1(pki_ezsignformfieldgroup_id, async_req=True) - >>> result = thread.get() + + @validate_call + def ezsignformfieldgroup_delete_object_v1( + self, + pki_ezsignformfieldgroup_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsignformfieldgroupDeleteObjectV1Response: + """Delete an existing Ezsignformfieldgroup + + :param pki_ezsignformfieldgroup_id: (required) :type pki_ezsignformfieldgroup_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsignformfieldgroupDeleteObjectV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsignformfieldgroup_delete_object_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsignformfieldgroup_delete_object_v1_with_http_info(pki_ezsignformfieldgroup_id, **kwargs) # noqa: E501 - - @validate_arguments - def ezsignformfieldgroup_delete_object_v1_with_http_info(self, pki_ezsignformfieldgroup_id : conint(strict=True, ge=0), **kwargs) -> ApiResponse: # noqa: E501 - """Delete an existing Ezsignformfieldgroup # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsignformfieldgroup_delete_object_v1_with_http_info(pki_ezsignformfieldgroup_id, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._ezsignformfieldgroup_delete_object_v1_serialize( + pki_ezsignformfieldgroup_id=pki_ezsignformfieldgroup_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignformfieldgroupDeleteObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsignformfieldgroup_delete_object_v1_with_http_info( + self, + pki_ezsignformfieldgroup_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsignformfieldgroupDeleteObjectV1Response]: + """Delete an existing Ezsignformfieldgroup + + :param pki_ezsignformfieldgroup_id: (required) :type pki_ezsignformfieldgroup_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsignformfieldgroupDeleteObjectV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._ezsignformfieldgroup_delete_object_v1_serialize( + pki_ezsignformfieldgroup_id=pki_ezsignformfieldgroup_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignformfieldgroupDeleteObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _params = locals() - _all_params = [ - 'pki_ezsignformfieldgroup_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + @validate_call + def ezsignformfieldgroup_delete_object_v1_without_preload_content( + self, + pki_ezsignformfieldgroup_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete an existing Ezsignformfieldgroup + + + + :param pki_ezsignformfieldgroup_id: (required) + :type pki_ezsignformfieldgroup_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignformfieldgroup_delete_object_v1_serialize( + pki_ezsignformfieldgroup_id=pki_ezsignformfieldgroup_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsignformfieldgroup_delete_object_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignformfieldgroupDeleteObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_ezsignformfieldgroup_id']: - _path_params['pkiEzsignformfieldgroupID'] = _params['pki_ezsignformfieldgroup_id'] + def _ezsignformfieldgroup_delete_object_v1_serialize( + self, + pki_ezsignformfieldgroup_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_ezsignformfieldgroup_id is not None: + _path_params['pkiEzsignformfieldgroupID'] = pki_ezsignformfieldgroup_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "EzsignformfieldgroupDeleteObjectV1Response", - '404': "CommonResponseError", - '422': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsignformfieldgroup/{pkiEzsignformfieldgroupID}', 'DELETE', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='DELETE', + resource_path='/1/object/ezsignformfieldgroup/{pkiEzsignformfieldgroupID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) - @validate_arguments - def ezsignformfieldgroup_edit_object_v1(self, pki_ezsignformfieldgroup_id : conint(strict=True, ge=0), ezsignformfieldgroup_edit_object_v1_request : EzsignformfieldgroupEditObjectV1Request, **kwargs) -> EzsignformfieldgroupEditObjectV1Response: # noqa: E501 - """Edit an existing Ezsignformfieldgroup # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.ezsignformfieldgroup_edit_object_v1(pki_ezsignformfieldgroup_id, ezsignformfieldgroup_edit_object_v1_request, async_req=True) - >>> result = thread.get() + + @validate_call + def ezsignformfieldgroup_edit_object_v1( + self, + pki_ezsignformfieldgroup_id: Annotated[int, Field(strict=True, ge=0)], + ezsignformfieldgroup_edit_object_v1_request: EzsignformfieldgroupEditObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsignformfieldgroupEditObjectV1Response: + """Edit an existing Ezsignformfieldgroup + + :param pki_ezsignformfieldgroup_id: (required) :type pki_ezsignformfieldgroup_id: int :param ezsignformfieldgroup_edit_object_v1_request: (required) :type ezsignformfieldgroup_edit_object_v1_request: EzsignformfieldgroupEditObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsignformfieldgroupEditObjectV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsignformfieldgroup_edit_object_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsignformfieldgroup_edit_object_v1_with_http_info(pki_ezsignformfieldgroup_id, ezsignformfieldgroup_edit_object_v1_request, **kwargs) # noqa: E501 - - @validate_arguments - def ezsignformfieldgroup_edit_object_v1_with_http_info(self, pki_ezsignformfieldgroup_id : conint(strict=True, ge=0), ezsignformfieldgroup_edit_object_v1_request : EzsignformfieldgroupEditObjectV1Request, **kwargs) -> ApiResponse: # noqa: E501 - """Edit an existing Ezsignformfieldgroup # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsignformfieldgroup_edit_object_v1_with_http_info(pki_ezsignformfieldgroup_id, ezsignformfieldgroup_edit_object_v1_request, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._ezsignformfieldgroup_edit_object_v1_serialize( + pki_ezsignformfieldgroup_id=pki_ezsignformfieldgroup_id, + ezsignformfieldgroup_edit_object_v1_request=ezsignformfieldgroup_edit_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignformfieldgroupEditObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsignformfieldgroup_edit_object_v1_with_http_info( + self, + pki_ezsignformfieldgroup_id: Annotated[int, Field(strict=True, ge=0)], + ezsignformfieldgroup_edit_object_v1_request: EzsignformfieldgroupEditObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsignformfieldgroupEditObjectV1Response]: + """Edit an existing Ezsignformfieldgroup + + :param pki_ezsignformfieldgroup_id: (required) :type pki_ezsignformfieldgroup_id: int :param ezsignformfieldgroup_edit_object_v1_request: (required) :type ezsignformfieldgroup_edit_object_v1_request: EzsignformfieldgroupEditObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsignformfieldgroupEditObjectV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._ezsignformfieldgroup_edit_object_v1_serialize( + pki_ezsignformfieldgroup_id=pki_ezsignformfieldgroup_id, + ezsignformfieldgroup_edit_object_v1_request=ezsignformfieldgroup_edit_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignformfieldgroupEditObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _params = locals() - _all_params = [ - 'pki_ezsignformfieldgroup_id', - 'ezsignformfieldgroup_edit_object_v1_request' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + @validate_call + def ezsignformfieldgroup_edit_object_v1_without_preload_content( + self, + pki_ezsignformfieldgroup_id: Annotated[int, Field(strict=True, ge=0)], + ezsignformfieldgroup_edit_object_v1_request: EzsignformfieldgroupEditObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Edit an existing Ezsignformfieldgroup + + + + :param pki_ezsignformfieldgroup_id: (required) + :type pki_ezsignformfieldgroup_id: int + :param ezsignformfieldgroup_edit_object_v1_request: (required) + :type ezsignformfieldgroup_edit_object_v1_request: EzsignformfieldgroupEditObjectV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignformfieldgroup_edit_object_v1_serialize( + pki_ezsignformfieldgroup_id=pki_ezsignformfieldgroup_id, + ezsignformfieldgroup_edit_object_v1_request=ezsignformfieldgroup_edit_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsignformfieldgroup_edit_object_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignformfieldgroupEditObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_ezsignformfieldgroup_id']: - _path_params['pkiEzsignformfieldgroupID'] = _params['pki_ezsignformfieldgroup_id'] + def _ezsignformfieldgroup_edit_object_v1_serialize( + self, + pki_ezsignformfieldgroup_id, + ezsignformfieldgroup_edit_object_v1_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if pki_ezsignformfieldgroup_id is not None: + _path_params['pkiEzsignformfieldgroupID'] = pki_ezsignformfieldgroup_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['ezsignformfieldgroup_edit_object_v1_request'] is not None: - _body_params = _params['ezsignformfieldgroup_edit_object_v1_request'] + if ezsignformfieldgroup_edit_object_v1_request is not None: + _body_params = ezsignformfieldgroup_edit_object_v1_request + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '200': "EzsignformfieldgroupEditObjectV1Response", - '404': "CommonResponseError", - '422': "CommonResponseError", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsignformfieldgroup/{pkiEzsignformfieldgroupID}', 'PUT', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='PUT', + resource_path='/1/object/ezsignformfieldgroup/{pkiEzsignformfieldgroupID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + - @validate_arguments - def ezsignformfieldgroup_get_object_v2(self, pki_ezsignformfieldgroup_id : conint(strict=True, ge=0), **kwargs) -> EzsignformfieldgroupGetObjectV2Response: # noqa: E501 - """Retrieve an existing Ezsignformfieldgroup # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.ezsignformfieldgroup_get_object_v2(pki_ezsignformfieldgroup_id, async_req=True) - >>> result = thread.get() + @validate_call + def ezsignformfieldgroup_get_object_v2( + self, + pki_ezsignformfieldgroup_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsignformfieldgroupGetObjectV2Response: + """Retrieve an existing Ezsignformfieldgroup + + :param pki_ezsignformfieldgroup_id: (required) :type pki_ezsignformfieldgroup_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsignformfieldgroupGetObjectV2Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsignformfieldgroup_get_object_v2_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsignformfieldgroup_get_object_v2_with_http_info(pki_ezsignformfieldgroup_id, **kwargs) # noqa: E501 - - @validate_arguments - def ezsignformfieldgroup_get_object_v2_with_http_info(self, pki_ezsignformfieldgroup_id : conint(strict=True, ge=0), **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve an existing Ezsignformfieldgroup # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsignformfieldgroup_get_object_v2_with_http_info(pki_ezsignformfieldgroup_id, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._ezsignformfieldgroup_get_object_v2_serialize( + pki_ezsignformfieldgroup_id=pki_ezsignformfieldgroup_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignformfieldgroupGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsignformfieldgroup_get_object_v2_with_http_info( + self, + pki_ezsignformfieldgroup_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsignformfieldgroupGetObjectV2Response]: + """Retrieve an existing Ezsignformfieldgroup + + :param pki_ezsignformfieldgroup_id: (required) :type pki_ezsignformfieldgroup_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsignformfieldgroupGetObjectV2Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._ezsignformfieldgroup_get_object_v2_serialize( + pki_ezsignformfieldgroup_id=pki_ezsignformfieldgroup_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignformfieldgroupGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _params = locals() - _all_params = [ - 'pki_ezsignformfieldgroup_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + @validate_call + def ezsignformfieldgroup_get_object_v2_without_preload_content( + self, + pki_ezsignformfieldgroup_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve an existing Ezsignformfieldgroup + + + + :param pki_ezsignformfieldgroup_id: (required) + :type pki_ezsignformfieldgroup_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignformfieldgroup_get_object_v2_serialize( + pki_ezsignformfieldgroup_id=pki_ezsignformfieldgroup_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsignformfieldgroup_get_object_v2" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignformfieldgroupGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_ezsignformfieldgroup_id']: - _path_params['pkiEzsignformfieldgroupID'] = _params['pki_ezsignformfieldgroup_id'] + def _ezsignformfieldgroup_get_object_v2_serialize( + self, + pki_ezsignformfieldgroup_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_ezsignformfieldgroup_id is not None: + _path_params['pkiEzsignformfieldgroupID'] = pki_ezsignformfieldgroup_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "EzsignformfieldgroupGetObjectV2Response", - '404': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/2/object/ezsignformfieldgroup/{pkiEzsignformfieldgroupID}', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/2/object/ezsignformfieldgroup/{pkiEzsignformfieldgroupID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/eZmaxApi/api/object_ezsignpage_api.py b/eZmaxApi/api/object_ezsignpage_api.py index dd935add8..cc3249aa1 100644 --- a/eZmaxApi/api/object_ezsignpage_api.py +++ b/eZmaxApi/api/object_ezsignpage_api.py @@ -13,24 +13,26 @@ """ # noqa: E501 -import re # noqa: F401 import io import warnings -from pydantic import validate_arguments, ValidationError +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Dict, List, Optional, Tuple, Union, Any -from pydantic import conint +try: + from typing import Annotated +except ImportError: + from typing_extensions import Annotated +from pydantic import Field +from typing_extensions import Annotated from typing import Any, Dict from eZmaxApi.models.ezsignpage_consult_v1_response import EzsignpageConsultV1Response from eZmaxApi.api_client import ApiClient from eZmaxApi.api_response import ApiResponse -from eZmaxApi.exceptions import ( # noqa: F401 - ApiTypeError, - ApiValueError -) +from eZmaxApi.rest import RESTResponseType class ObjectEzsignpageApi: @@ -45,157 +47,291 @@ def __init__(self, api_client=None) -> None: api_client = ApiClient.get_default() self.api_client = api_client - @validate_arguments - def ezsignpage_consult_v1(self, pki_ezsignpage_id : conint(strict=True, ge=0), body : Dict[str, Any], **kwargs) -> EzsignpageConsultV1Response: # noqa: E501 - """Consult an Ezsignpage # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def ezsignpage_consult_v1( + self, + pki_ezsignpage_id: Annotated[int, Field(strict=True, ge=0)], + body: Dict[str, Any], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsignpageConsultV1Response: + """Consult an Ezsignpage - >>> thread = api.ezsignpage_consult_v1(pki_ezsignpage_id, body, async_req=True) - >>> result = thread.get() :param pki_ezsignpage_id: (required) :type pki_ezsignpage_id: int :param body: (required) :type body: object - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsignpageConsultV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsignpage_consult_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsignpage_consult_v1_with_http_info(pki_ezsignpage_id, body, **kwargs) # noqa: E501 - - @validate_arguments - def ezsignpage_consult_v1_with_http_info(self, pki_ezsignpage_id : conint(strict=True, ge=0), body : Dict[str, Any], **kwargs) -> ApiResponse: # noqa: E501 - """Consult an Ezsignpage # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsignpage_consult_v1_with_http_info(pki_ezsignpage_id, body, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._ezsignpage_consult_v1_serialize( + pki_ezsignpage_id=pki_ezsignpage_id, + body=body, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignpageConsultV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsignpage_consult_v1_with_http_info( + self, + pki_ezsignpage_id: Annotated[int, Field(strict=True, ge=0)], + body: Dict[str, Any], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsignpageConsultV1Response]: + """Consult an Ezsignpage + :param pki_ezsignpage_id: (required) :type pki_ezsignpage_id: int :param body: (required) :type body: object - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsignpageConsultV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._ezsignpage_consult_v1_serialize( + pki_ezsignpage_id=pki_ezsignpage_id, + body=body, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignpageConsultV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'pki_ezsignpage_id', - 'body' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def ezsignpage_consult_v1_without_preload_content( + self, + pki_ezsignpage_id: Annotated[int, Field(strict=True, ge=0)], + body: Dict[str, Any], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Consult an Ezsignpage + + + :param pki_ezsignpage_id: (required) + :type pki_ezsignpage_id: int + :param body: (required) + :type body: object + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignpage_consult_v1_serialize( + pki_ezsignpage_id=pki_ezsignpage_id, + body=body, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsignpage_consult_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignpageConsultV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_ezsignpage_id']: - _path_params['pkiEzsignpageID'] = _params['pki_ezsignpage_id'] + def _ezsignpage_consult_v1_serialize( + self, + pki_ezsignpage_id, + body, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if pki_ezsignpage_id is not None: + _path_params['pkiEzsignpageID'] = pki_ezsignpage_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['body'] is not None: - _body_params = _params['body'] + if body is not None: + _body_params = body + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '200': "EzsignpageConsultV1Response", - '404': "CommonResponseError", - '422': "CommonResponseError", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsignpage/{pkiEzsignpageID}/consult', 'POST', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='POST', + resource_path='/1/object/ezsignpage/{pkiEzsignpageID}/consult', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/eZmaxApi/api/object_ezsignsignature_api.py b/eZmaxApi/api/object_ezsignsignature_api.py index db3af3cb7..1a8c51560 100644 --- a/eZmaxApi/api/object_ezsignsignature_api.py +++ b/eZmaxApi/api/object_ezsignsignature_api.py @@ -13,13 +13,20 @@ """ # noqa: E501 -import re # noqa: F401 import io import warnings -from pydantic import validate_arguments, ValidationError +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Dict, List, Optional, Tuple, Union, Any -from pydantic import conint, conlist +try: + from typing import Annotated +except ImportError: + from typing_extensions import Annotated + +from pydantic import Field +from typing_extensions import Annotated +from typing import List from eZmaxApi.models.ezsignsignature_create_object_v1_request import EzsignsignatureCreateObjectV1Request from eZmaxApi.models.ezsignsignature_create_object_v1_response import EzsignsignatureCreateObjectV1Response @@ -36,10 +43,7 @@ from eZmaxApi.api_client import ApiClient from eZmaxApi.api_response import ApiResponse -from eZmaxApi.exceptions import ( # noqa: F401 - ApiTypeError, - ApiValueError -) +from eZmaxApi.rest import RESTResponseType class ObjectEzsignsignatureApi: @@ -54,1167 +58,2161 @@ def __init__(self, api_client=None) -> None: api_client = ApiClient.get_default() self.api_client = api_client - @validate_arguments - def ezsignsignature_create_object_v1(self, ezsignsignature_create_object_v1_request : conlist(EzsignsignatureCreateObjectV1Request), **kwargs) -> EzsignsignatureCreateObjectV1Response: # noqa: E501 - """(Deprecated) Create a new Ezsignsignature # noqa: E501 - The endpoint allows to create one or many elements at once. The array can contain simple (Just the object) or compound (The object and its child) objects. Creating compound elements allows to reduce the multiple requests to create all child objects. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def ezsignsignature_create_object_v1( + self, + ezsignsignature_create_object_v1_request: List[EzsignsignatureCreateObjectV1Request], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsignsignatureCreateObjectV1Response: + """(Deprecated) Create a new Ezsignsignature - >>> thread = api.ezsignsignature_create_object_v1(ezsignsignature_create_object_v1_request, async_req=True) - >>> result = thread.get() + The endpoint allows to create one or many elements at once. The array can contain simple (Just the object) or compound (The object and its child) objects. Creating compound elements allows to reduce the multiple requests to create all child objects. :param ezsignsignature_create_object_v1_request: (required) :type ezsignsignature_create_object_v1_request: List[EzsignsignatureCreateObjectV1Request] - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsignsignatureCreateObjectV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsignsignature_create_object_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsignsignature_create_object_v1_with_http_info(ezsignsignature_create_object_v1_request, **kwargs) # noqa: E501 - - @validate_arguments - def ezsignsignature_create_object_v1_with_http_info(self, ezsignsignature_create_object_v1_request : conlist(EzsignsignatureCreateObjectV1Request), **kwargs) -> ApiResponse: # noqa: E501 - """(Deprecated) Create a new Ezsignsignature # noqa: E501 - - The endpoint allows to create one or many elements at once. The array can contain simple (Just the object) or compound (The object and its child) objects. Creating compound elements allows to reduce the multiple requests to create all child objects. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsignsignature_create_object_v1_with_http_info(ezsignsignature_create_object_v1_request, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + warnings.warn("POST /1/object/ezsignsignature is deprecated.", DeprecationWarning) + + _param = self._ezsignsignature_create_object_v1_serialize( + ezsignsignature_create_object_v1_request=ezsignsignature_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "EzsignsignatureCreateObjectV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsignsignature_create_object_v1_with_http_info( + self, + ezsignsignature_create_object_v1_request: List[EzsignsignatureCreateObjectV1Request], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsignsignatureCreateObjectV1Response]: + """(Deprecated) Create a new Ezsignsignature + + The endpoint allows to create one or many elements at once. The array can contain simple (Just the object) or compound (The object and its child) objects. Creating compound elements allows to reduce the multiple requests to create all child objects. :param ezsignsignature_create_object_v1_request: (required) :type ezsignsignature_create_object_v1_request: List[EzsignsignatureCreateObjectV1Request] - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsignsignatureCreateObjectV1Response, status_code(int), headers(HTTPHeaderDict)) - """ - + """ # noqa: E501 warnings.warn("POST /1/object/ezsignsignature is deprecated.", DeprecationWarning) - _params = locals() + _param = self._ezsignsignature_create_object_v1_serialize( + ezsignsignature_create_object_v1_request=ezsignsignature_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _all_params = [ - 'ezsignsignature_create_object_v1_request' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + _response_types_map: Dict[str, Optional[str]] = { + '201': "EzsignsignatureCreateObjectV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def ezsignsignature_create_object_v1_without_preload_content( + self, + ezsignsignature_create_object_v1_request: List[EzsignsignatureCreateObjectV1Request], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """(Deprecated) Create a new Ezsignsignature + + The endpoint allows to create one or many elements at once. The array can contain simple (Just the object) or compound (The object and its child) objects. Creating compound elements allows to reduce the multiple requests to create all child objects. + + :param ezsignsignature_create_object_v1_request: (required) + :type ezsignsignature_create_object_v1_request: List[EzsignsignatureCreateObjectV1Request] + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + warnings.warn("POST /1/object/ezsignsignature is deprecated.", DeprecationWarning) + + _param = self._ezsignsignature_create_object_v1_serialize( + ezsignsignature_create_object_v1_request=ezsignsignature_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsignsignature_create_object_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '201': "EzsignsignatureCreateObjectV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} + def _ezsignsignature_create_object_v1_serialize( + self, + ezsignsignature_create_object_v1_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + _collection_formats: Dict[str, str] = { + 'EzsignsignatureCreateObjectV1Request': '', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['ezsignsignature_create_object_v1_request'] is not None: - _body_params = _params['ezsignsignature_create_object_v1_request'] + if ezsignsignature_create_object_v1_request is not None: + _body_params = ezsignsignature_create_object_v1_request + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '201': "EzsignsignatureCreateObjectV1Response", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsignsignature', 'POST', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='POST', + resource_path='/1/object/ezsignsignature', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + - @validate_arguments - def ezsignsignature_create_object_v2(self, ezsignsignature_create_object_v2_request : EzsignsignatureCreateObjectV2Request, **kwargs) -> EzsignsignatureCreateObjectV2Response: # noqa: E501 - """Create a new Ezsignsignature # noqa: E501 - The endpoint allows to create one or many elements at once. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.ezsignsignature_create_object_v2(ezsignsignature_create_object_v2_request, async_req=True) - >>> result = thread.get() + @validate_call + def ezsignsignature_create_object_v2( + self, + ezsignsignature_create_object_v2_request: EzsignsignatureCreateObjectV2Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsignsignatureCreateObjectV2Response: + """Create a new Ezsignsignature + + The endpoint allows to create one or many elements at once. :param ezsignsignature_create_object_v2_request: (required) :type ezsignsignature_create_object_v2_request: EzsignsignatureCreateObjectV2Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsignsignatureCreateObjectV2Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsignsignature_create_object_v2_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsignsignature_create_object_v2_with_http_info(ezsignsignature_create_object_v2_request, **kwargs) # noqa: E501 - - @validate_arguments - def ezsignsignature_create_object_v2_with_http_info(self, ezsignsignature_create_object_v2_request : EzsignsignatureCreateObjectV2Request, **kwargs) -> ApiResponse: # noqa: E501 - """Create a new Ezsignsignature # noqa: E501 - - The endpoint allows to create one or many elements at once. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsignsignature_create_object_v2_with_http_info(ezsignsignature_create_object_v2_request, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._ezsignsignature_create_object_v2_serialize( + ezsignsignature_create_object_v2_request=ezsignsignature_create_object_v2_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "EzsignsignatureCreateObjectV2Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsignsignature_create_object_v2_with_http_info( + self, + ezsignsignature_create_object_v2_request: EzsignsignatureCreateObjectV2Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsignsignatureCreateObjectV2Response]: + """Create a new Ezsignsignature + + The endpoint allows to create one or many elements at once. :param ezsignsignature_create_object_v2_request: (required) :type ezsignsignature_create_object_v2_request: EzsignsignatureCreateObjectV2Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsignsignatureCreateObjectV2Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._ezsignsignature_create_object_v2_serialize( + ezsignsignature_create_object_v2_request=ezsignsignature_create_object_v2_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '201': "EzsignsignatureCreateObjectV2Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'ezsignsignature_create_object_v2_request' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def ezsignsignature_create_object_v2_without_preload_content( + self, + ezsignsignature_create_object_v2_request: EzsignsignatureCreateObjectV2Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Create a new Ezsignsignature + + The endpoint allows to create one or many elements at once. + + :param ezsignsignature_create_object_v2_request: (required) + :type ezsignsignature_create_object_v2_request: EzsignsignatureCreateObjectV2Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignsignature_create_object_v2_serialize( + ezsignsignature_create_object_v2_request=ezsignsignature_create_object_v2_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsignsignature_create_object_v2" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '201': "EzsignsignatureCreateObjectV2Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} + def _ezsignsignature_create_object_v2_serialize( + self, + ezsignsignature_create_object_v2_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['ezsignsignature_create_object_v2_request'] is not None: - _body_params = _params['ezsignsignature_create_object_v2_request'] + if ezsignsignature_create_object_v2_request is not None: + _body_params = ezsignsignature_create_object_v2_request + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '201': "EzsignsignatureCreateObjectV2Response", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/2/object/ezsignsignature', 'POST', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='POST', + resource_path='/2/object/ezsignsignature', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + - @validate_arguments - def ezsignsignature_delete_object_v1(self, pki_ezsignsignature_id : conint(strict=True, ge=0), **kwargs) -> EzsignsignatureDeleteObjectV1Response: # noqa: E501 - """Delete an existing Ezsignsignature # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.ezsignsignature_delete_object_v1(pki_ezsignsignature_id, async_req=True) - >>> result = thread.get() + @validate_call + def ezsignsignature_delete_object_v1( + self, + pki_ezsignsignature_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsignsignatureDeleteObjectV1Response: + """Delete an existing Ezsignsignature + + :param pki_ezsignsignature_id: (required) :type pki_ezsignsignature_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsignsignatureDeleteObjectV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsignsignature_delete_object_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsignsignature_delete_object_v1_with_http_info(pki_ezsignsignature_id, **kwargs) # noqa: E501 - - @validate_arguments - def ezsignsignature_delete_object_v1_with_http_info(self, pki_ezsignsignature_id : conint(strict=True, ge=0), **kwargs) -> ApiResponse: # noqa: E501 - """Delete an existing Ezsignsignature # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsignsignature_delete_object_v1_with_http_info(pki_ezsignsignature_id, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._ezsignsignature_delete_object_v1_serialize( + pki_ezsignsignature_id=pki_ezsignsignature_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignsignatureDeleteObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsignsignature_delete_object_v1_with_http_info( + self, + pki_ezsignsignature_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsignsignatureDeleteObjectV1Response]: + """Delete an existing Ezsignsignature + + :param pki_ezsignsignature_id: (required) :type pki_ezsignsignature_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsignsignatureDeleteObjectV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._ezsignsignature_delete_object_v1_serialize( + pki_ezsignsignature_id=pki_ezsignsignature_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignsignatureDeleteObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _params = locals() - _all_params = [ - 'pki_ezsignsignature_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + @validate_call + def ezsignsignature_delete_object_v1_without_preload_content( + self, + pki_ezsignsignature_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete an existing Ezsignsignature + + + + :param pki_ezsignsignature_id: (required) + :type pki_ezsignsignature_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignsignature_delete_object_v1_serialize( + pki_ezsignsignature_id=pki_ezsignsignature_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsignsignature_delete_object_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignsignatureDeleteObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_ezsignsignature_id']: - _path_params['pkiEzsignsignatureID'] = _params['pki_ezsignsignature_id'] + def _ezsignsignature_delete_object_v1_serialize( + self, + pki_ezsignsignature_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if pki_ezsignsignature_id is not None: + _path_params['pkiEzsignsignatureID'] = pki_ezsignsignature_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "EzsignsignatureDeleteObjectV1Response", - '404': "CommonResponseError", - '422': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsignsignature/{pkiEzsignsignatureID}', 'DELETE', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='DELETE', + resource_path='/1/object/ezsignsignature/{pkiEzsignsignatureID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + - @validate_arguments - def ezsignsignature_edit_object_v1(self, pki_ezsignsignature_id : conint(strict=True, ge=0), ezsignsignature_edit_object_v1_request : EzsignsignatureEditObjectV1Request, **kwargs) -> EzsignsignatureEditObjectV1Response: # noqa: E501 - """Edit an existing Ezsignsignature # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.ezsignsignature_edit_object_v1(pki_ezsignsignature_id, ezsignsignature_edit_object_v1_request, async_req=True) - >>> result = thread.get() + @validate_call + def ezsignsignature_edit_object_v1( + self, + pki_ezsignsignature_id: Annotated[int, Field(strict=True, ge=0)], + ezsignsignature_edit_object_v1_request: EzsignsignatureEditObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsignsignatureEditObjectV1Response: + """Edit an existing Ezsignsignature + + :param pki_ezsignsignature_id: (required) :type pki_ezsignsignature_id: int :param ezsignsignature_edit_object_v1_request: (required) :type ezsignsignature_edit_object_v1_request: EzsignsignatureEditObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsignsignatureEditObjectV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsignsignature_edit_object_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsignsignature_edit_object_v1_with_http_info(pki_ezsignsignature_id, ezsignsignature_edit_object_v1_request, **kwargs) # noqa: E501 - - @validate_arguments - def ezsignsignature_edit_object_v1_with_http_info(self, pki_ezsignsignature_id : conint(strict=True, ge=0), ezsignsignature_edit_object_v1_request : EzsignsignatureEditObjectV1Request, **kwargs) -> ApiResponse: # noqa: E501 - """Edit an existing Ezsignsignature # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsignsignature_edit_object_v1_with_http_info(pki_ezsignsignature_id, ezsignsignature_edit_object_v1_request, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._ezsignsignature_edit_object_v1_serialize( + pki_ezsignsignature_id=pki_ezsignsignature_id, + ezsignsignature_edit_object_v1_request=ezsignsignature_edit_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignsignatureEditObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsignsignature_edit_object_v1_with_http_info( + self, + pki_ezsignsignature_id: Annotated[int, Field(strict=True, ge=0)], + ezsignsignature_edit_object_v1_request: EzsignsignatureEditObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsignsignatureEditObjectV1Response]: + """Edit an existing Ezsignsignature + + :param pki_ezsignsignature_id: (required) :type pki_ezsignsignature_id: int :param ezsignsignature_edit_object_v1_request: (required) :type ezsignsignature_edit_object_v1_request: EzsignsignatureEditObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsignsignatureEditObjectV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._ezsignsignature_edit_object_v1_serialize( + pki_ezsignsignature_id=pki_ezsignsignature_id, + ezsignsignature_edit_object_v1_request=ezsignsignature_edit_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignsignatureEditObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _params = locals() - _all_params = [ - 'pki_ezsignsignature_id', - 'ezsignsignature_edit_object_v1_request' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + @validate_call + def ezsignsignature_edit_object_v1_without_preload_content( + self, + pki_ezsignsignature_id: Annotated[int, Field(strict=True, ge=0)], + ezsignsignature_edit_object_v1_request: EzsignsignatureEditObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Edit an existing Ezsignsignature + + + + :param pki_ezsignsignature_id: (required) + :type pki_ezsignsignature_id: int + :param ezsignsignature_edit_object_v1_request: (required) + :type ezsignsignature_edit_object_v1_request: EzsignsignatureEditObjectV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignsignature_edit_object_v1_serialize( + pki_ezsignsignature_id=pki_ezsignsignature_id, + ezsignsignature_edit_object_v1_request=ezsignsignature_edit_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsignsignature_edit_object_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignsignatureEditObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_ezsignsignature_id']: - _path_params['pkiEzsignsignatureID'] = _params['pki_ezsignsignature_id'] + def _ezsignsignature_edit_object_v1_serialize( + self, + pki_ezsignsignature_id, + ezsignsignature_edit_object_v1_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if pki_ezsignsignature_id is not None: + _path_params['pkiEzsignsignatureID'] = pki_ezsignsignature_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['ezsignsignature_edit_object_v1_request'] is not None: - _body_params = _params['ezsignsignature_edit_object_v1_request'] + if ezsignsignature_edit_object_v1_request is not None: + _body_params = ezsignsignature_edit_object_v1_request + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '200': "EzsignsignatureEditObjectV1Response", - '404': "CommonResponseError", - '422': "CommonResponseError", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsignsignature/{pkiEzsignsignatureID}', 'PUT', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='PUT', + resource_path='/1/object/ezsignsignature/{pkiEzsignsignatureID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + - @validate_arguments - def ezsignsignature_get_ezsignsignatureattachment_v1(self, pki_ezsignsignature_id : conint(strict=True, ge=0), **kwargs) -> EzsignsignatureGetEzsignsignatureattachmentV1Response: # noqa: E501 - """Retrieve an existing Ezsignsignature's Ezsignsignatureattachments # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def ezsignsignature_get_ezsignsignatureattachment_v1( + self, + pki_ezsignsignature_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsignsignatureGetEzsignsignatureattachmentV1Response: + """Retrieve an existing Ezsignsignature's Ezsignsignatureattachments - >>> thread = api.ezsignsignature_get_ezsignsignatureattachment_v1(pki_ezsignsignature_id, async_req=True) - >>> result = thread.get() :param pki_ezsignsignature_id: (required) :type pki_ezsignsignature_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsignsignatureGetEzsignsignatureattachmentV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsignsignature_get_ezsignsignatureattachment_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsignsignature_get_ezsignsignatureattachment_v1_with_http_info(pki_ezsignsignature_id, **kwargs) # noqa: E501 - - @validate_arguments - def ezsignsignature_get_ezsignsignatureattachment_v1_with_http_info(self, pki_ezsignsignature_id : conint(strict=True, ge=0), **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve an existing Ezsignsignature's Ezsignsignatureattachments # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsignsignature_get_ezsignsignatureattachment_v1_with_http_info(pki_ezsignsignature_id, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._ezsignsignature_get_ezsignsignatureattachment_v1_serialize( + pki_ezsignsignature_id=pki_ezsignsignature_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignsignatureGetEzsignsignatureattachmentV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsignsignature_get_ezsignsignatureattachment_v1_with_http_info( + self, + pki_ezsignsignature_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsignsignatureGetEzsignsignatureattachmentV1Response]: + """Retrieve an existing Ezsignsignature's Ezsignsignatureattachments + :param pki_ezsignsignature_id: (required) :type pki_ezsignsignature_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsignsignatureGetEzsignsignatureattachmentV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._ezsignsignature_get_ezsignsignatureattachment_v1_serialize( + pki_ezsignsignature_id=pki_ezsignsignature_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignsignatureGetEzsignsignatureattachmentV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _params = locals() - _all_params = [ - 'pki_ezsignsignature_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + @validate_call + def ezsignsignature_get_ezsignsignatureattachment_v1_without_preload_content( + self, + pki_ezsignsignature_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve an existing Ezsignsignature's Ezsignsignatureattachments + + + :param pki_ezsignsignature_id: (required) + :type pki_ezsignsignature_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignsignature_get_ezsignsignatureattachment_v1_serialize( + pki_ezsignsignature_id=pki_ezsignsignature_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsignsignature_get_ezsignsignatureattachment_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignsignatureGetEzsignsignatureattachmentV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_ezsignsignature_id']: - _path_params['pkiEzsignsignatureID'] = _params['pki_ezsignsignature_id'] + def _ezsignsignature_get_ezsignsignatureattachment_v1_serialize( + self, + pki_ezsignsignature_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if pki_ezsignsignature_id is not None: + _path_params['pkiEzsignsignatureID'] = pki_ezsignsignature_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "EzsignsignatureGetEzsignsignatureattachmentV1Response", - '404': "CommonResponseError", - '422': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsignsignature/{pkiEzsignsignatureID}/getEzsignsignatureattachment', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/1/object/ezsignsignature/{pkiEzsignsignatureID}/getEzsignsignatureattachment', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) - @validate_arguments - def ezsignsignature_get_ezsignsignatures_automatic_v1(self, **kwargs) -> EzsignsignatureGetEzsignsignaturesAutomaticV1Response: # noqa: E501 - """Retrieve all automatic Ezsignsignatures # noqa: E501 - Return all the Ezsignsignatures that can be signed by the current user # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.ezsignsignature_get_ezsignsignatures_automatic_v1(async_req=True) - >>> result = thread.get() - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + @validate_call + def ezsignsignature_get_ezsignsignatures_automatic_v1( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsignsignatureGetEzsignsignaturesAutomaticV1Response: + """Retrieve all automatic Ezsignsignatures + + Return all the Ezsignsignatures that can be signed by the current user + + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsignsignatureGetEzsignsignaturesAutomaticV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsignsignature_get_ezsignsignatures_automatic_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsignsignature_get_ezsignsignatures_automatic_v1_with_http_info(**kwargs) # noqa: E501 - - @validate_arguments - def ezsignsignature_get_ezsignsignatures_automatic_v1_with_http_info(self, **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve all automatic Ezsignsignatures # noqa: E501 - - Return all the Ezsignsignatures that can be signed by the current user # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsignsignature_get_ezsignsignatures_automatic_v1_with_http_info(async_req=True) - >>> result = thread.get() - - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional + """ # noqa: E501 + + _param = self._ezsignsignature_get_ezsignsignatures_automatic_v1_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignsignatureGetEzsignsignaturesAutomaticV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsignsignature_get_ezsignsignatures_automatic_v1_with_http_info( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsignsignatureGetEzsignsignaturesAutomaticV1Response]: + """Retrieve all automatic Ezsignsignatures + + Return all the Ezsignsignatures that can be signed by the current user + :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsignsignatureGetEzsignsignaturesAutomaticV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 - _params = locals() + _param = self._ezsignsignature_get_ezsignsignatures_automatic_v1_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _all_params = [ - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignsignatureGetEzsignsignaturesAutomaticV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def ezsignsignature_get_ezsignsignatures_automatic_v1_without_preload_content( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve all automatic Ezsignsignatures + + Return all the Ezsignsignatures that can be signed by the current user + + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignsignature_get_ezsignsignatures_automatic_v1_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsignsignature_get_ezsignsignatures_automatic_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignsignatureGetEzsignsignaturesAutomaticV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} + def _ezsignsignature_get_ezsignsignatures_automatic_v1_serialize( + self, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "EzsignsignatureGetEzsignsignaturesAutomaticV1Response", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsignsignature/getEzsignsignaturesAutomatic', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/1/object/ezsignsignature/getEzsignsignaturesAutomatic', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + - @validate_arguments - def ezsignsignature_get_object_v2(self, pki_ezsignsignature_id : conint(strict=True, ge=0), **kwargs) -> EzsignsignatureGetObjectV2Response: # noqa: E501 - """Retrieve an existing Ezsignsignature # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.ezsignsignature_get_object_v2(pki_ezsignsignature_id, async_req=True) - >>> result = thread.get() + @validate_call + def ezsignsignature_get_object_v2( + self, + pki_ezsignsignature_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsignsignatureGetObjectV2Response: + """Retrieve an existing Ezsignsignature + + :param pki_ezsignsignature_id: (required) :type pki_ezsignsignature_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsignsignatureGetObjectV2Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsignsignature_get_object_v2_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsignsignature_get_object_v2_with_http_info(pki_ezsignsignature_id, **kwargs) # noqa: E501 - - @validate_arguments - def ezsignsignature_get_object_v2_with_http_info(self, pki_ezsignsignature_id : conint(strict=True, ge=0), **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve an existing Ezsignsignature # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsignsignature_get_object_v2_with_http_info(pki_ezsignsignature_id, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._ezsignsignature_get_object_v2_serialize( + pki_ezsignsignature_id=pki_ezsignsignature_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignsignatureGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsignsignature_get_object_v2_with_http_info( + self, + pki_ezsignsignature_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsignsignatureGetObjectV2Response]: + """Retrieve an existing Ezsignsignature + + :param pki_ezsignsignature_id: (required) :type pki_ezsignsignature_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsignsignatureGetObjectV2Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._ezsignsignature_get_object_v2_serialize( + pki_ezsignsignature_id=pki_ezsignsignature_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignsignatureGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'pki_ezsignsignature_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def ezsignsignature_get_object_v2_without_preload_content( + self, + pki_ezsignsignature_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve an existing Ezsignsignature + + + + :param pki_ezsignsignature_id: (required) + :type pki_ezsignsignature_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignsignature_get_object_v2_serialize( + pki_ezsignsignature_id=pki_ezsignsignature_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsignsignature_get_object_v2" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignsignatureGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_ezsignsignature_id']: - _path_params['pkiEzsignsignatureID'] = _params['pki_ezsignsignature_id'] + def _ezsignsignature_get_object_v2_serialize( + self, + pki_ezsignsignature_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if pki_ezsignsignature_id is not None: + _path_params['pkiEzsignsignatureID'] = pki_ezsignsignature_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "EzsignsignatureGetObjectV2Response", - '404': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/2/object/ezsignsignature/{pkiEzsignsignatureID}', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/2/object/ezsignsignature/{pkiEzsignsignatureID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + - @validate_arguments - def ezsignsignature_sign_v1(self, pki_ezsignsignature_id : conint(strict=True, ge=0), ezsignsignature_sign_v1_request : EzsignsignatureSignV1Request, **kwargs) -> EzsignsignatureSignV1Response: # noqa: E501 - """Sign the Ezsignsignature # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.ezsignsignature_sign_v1(pki_ezsignsignature_id, ezsignsignature_sign_v1_request, async_req=True) - >>> result = thread.get() + @validate_call + def ezsignsignature_sign_v1( + self, + pki_ezsignsignature_id: Annotated[int, Field(strict=True, ge=0)], + ezsignsignature_sign_v1_request: EzsignsignatureSignV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsignsignatureSignV1Response: + """Sign the Ezsignsignature + + :param pki_ezsignsignature_id: (required) :type pki_ezsignsignature_id: int :param ezsignsignature_sign_v1_request: (required) :type ezsignsignature_sign_v1_request: EzsignsignatureSignV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsignsignatureSignV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsignsignature_sign_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsignsignature_sign_v1_with_http_info(pki_ezsignsignature_id, ezsignsignature_sign_v1_request, **kwargs) # noqa: E501 - - @validate_arguments - def ezsignsignature_sign_v1_with_http_info(self, pki_ezsignsignature_id : conint(strict=True, ge=0), ezsignsignature_sign_v1_request : EzsignsignatureSignV1Request, **kwargs) -> ApiResponse: # noqa: E501 - """Sign the Ezsignsignature # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsignsignature_sign_v1_with_http_info(pki_ezsignsignature_id, ezsignsignature_sign_v1_request, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._ezsignsignature_sign_v1_serialize( + pki_ezsignsignature_id=pki_ezsignsignature_id, + ezsignsignature_sign_v1_request=ezsignsignature_sign_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignsignatureSignV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsignsignature_sign_v1_with_http_info( + self, + pki_ezsignsignature_id: Annotated[int, Field(strict=True, ge=0)], + ezsignsignature_sign_v1_request: EzsignsignatureSignV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsignsignatureSignV1Response]: + """Sign the Ezsignsignature + + :param pki_ezsignsignature_id: (required) :type pki_ezsignsignature_id: int :param ezsignsignature_sign_v1_request: (required) :type ezsignsignature_sign_v1_request: EzsignsignatureSignV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsignsignatureSignV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._ezsignsignature_sign_v1_serialize( + pki_ezsignsignature_id=pki_ezsignsignature_id, + ezsignsignature_sign_v1_request=ezsignsignature_sign_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignsignatureSignV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _params = locals() - _all_params = [ - 'pki_ezsignsignature_id', - 'ezsignsignature_sign_v1_request' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + @validate_call + def ezsignsignature_sign_v1_without_preload_content( + self, + pki_ezsignsignature_id: Annotated[int, Field(strict=True, ge=0)], + ezsignsignature_sign_v1_request: EzsignsignatureSignV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Sign the Ezsignsignature + + + + :param pki_ezsignsignature_id: (required) + :type pki_ezsignsignature_id: int + :param ezsignsignature_sign_v1_request: (required) + :type ezsignsignature_sign_v1_request: EzsignsignatureSignV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignsignature_sign_v1_serialize( + pki_ezsignsignature_id=pki_ezsignsignature_id, + ezsignsignature_sign_v1_request=ezsignsignature_sign_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsignsignature_sign_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignsignatureSignV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_ezsignsignature_id']: - _path_params['pkiEzsignsignatureID'] = _params['pki_ezsignsignature_id'] + def _ezsignsignature_sign_v1_serialize( + self, + pki_ezsignsignature_id, + ezsignsignature_sign_v1_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if pki_ezsignsignature_id is not None: + _path_params['pkiEzsignsignatureID'] = pki_ezsignsignature_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['ezsignsignature_sign_v1_request'] is not None: - _body_params = _params['ezsignsignature_sign_v1_request'] + if ezsignsignature_sign_v1_request is not None: + _body_params = ezsignsignature_sign_v1_request + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '200': "EzsignsignatureSignV1Response", - '404': "CommonResponseError", - '422': "CommonResponseError", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsignsignature/{pkiEzsignsignatureID}/sign', 'POST', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='POST', + resource_path='/1/object/ezsignsignature/{pkiEzsignsignatureID}/sign', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/eZmaxApi/api/object_ezsignsignergroup_api.py b/eZmaxApi/api/object_ezsignsignergroup_api.py index dd9c252d9..0acf93731 100644 --- a/eZmaxApi/api/object_ezsignsignergroup_api.py +++ b/eZmaxApi/api/object_ezsignsignergroup_api.py @@ -13,15 +13,19 @@ """ # noqa: E501 -import re # noqa: F401 import io import warnings -from pydantic import validate_arguments, ValidationError +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Dict, List, Optional, Tuple, Union, Any -from typing_extensions import Annotated -from pydantic import Field, conint +try: + from typing import Annotated +except ImportError: + from typing_extensions import Annotated +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.ezsignsignergroup_create_object_v1_request import EzsignsignergroupCreateObjectV1Request from eZmaxApi.models.ezsignsignergroup_create_object_v1_response import EzsignsignergroupCreateObjectV1Response from eZmaxApi.models.ezsignsignergroup_delete_object_v1_response import EzsignsignergroupDeleteObjectV1Response @@ -34,10 +38,7 @@ from eZmaxApi.api_client import ApiClient from eZmaxApi.api_response import ApiResponse -from eZmaxApi.exceptions import ( # noqa: F401 - ApiTypeError, - ApiValueError -) +from eZmaxApi.rest import RESTResponseType class ObjectEzsignsignergroupApi: @@ -52,883 +53,1634 @@ def __init__(self, api_client=None) -> None: api_client = ApiClient.get_default() self.api_client = api_client - @validate_arguments - def ezsignsignergroup_create_object_v1(self, ezsignsignergroup_create_object_v1_request : EzsignsignergroupCreateObjectV1Request, **kwargs) -> EzsignsignergroupCreateObjectV1Response: # noqa: E501 - """Create a new Ezsignsignergroup # noqa: E501 - The endpoint allows to create one or many elements at once. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def ezsignsignergroup_create_object_v1( + self, + ezsignsignergroup_create_object_v1_request: EzsignsignergroupCreateObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsignsignergroupCreateObjectV1Response: + """Create a new Ezsignsignergroup - >>> thread = api.ezsignsignergroup_create_object_v1(ezsignsignergroup_create_object_v1_request, async_req=True) - >>> result = thread.get() + The endpoint allows to create one or many elements at once. :param ezsignsignergroup_create_object_v1_request: (required) :type ezsignsignergroup_create_object_v1_request: EzsignsignergroupCreateObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsignsignergroupCreateObjectV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsignsignergroup_create_object_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsignsignergroup_create_object_v1_with_http_info(ezsignsignergroup_create_object_v1_request, **kwargs) # noqa: E501 - - @validate_arguments - def ezsignsignergroup_create_object_v1_with_http_info(self, ezsignsignergroup_create_object_v1_request : EzsignsignergroupCreateObjectV1Request, **kwargs) -> ApiResponse: # noqa: E501 - """Create a new Ezsignsignergroup # noqa: E501 - - The endpoint allows to create one or many elements at once. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsignsignergroup_create_object_v1_with_http_info(ezsignsignergroup_create_object_v1_request, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._ezsignsignergroup_create_object_v1_serialize( + ezsignsignergroup_create_object_v1_request=ezsignsignergroup_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "EzsignsignergroupCreateObjectV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsignsignergroup_create_object_v1_with_http_info( + self, + ezsignsignergroup_create_object_v1_request: EzsignsignergroupCreateObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsignsignergroupCreateObjectV1Response]: + """Create a new Ezsignsignergroup + + The endpoint allows to create one or many elements at once. :param ezsignsignergroup_create_object_v1_request: (required) :type ezsignsignergroup_create_object_v1_request: EzsignsignergroupCreateObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsignsignergroupCreateObjectV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._ezsignsignergroup_create_object_v1_serialize( + ezsignsignergroup_create_object_v1_request=ezsignsignergroup_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '201': "EzsignsignergroupCreateObjectV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'ezsignsignergroup_create_object_v1_request' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def ezsignsignergroup_create_object_v1_without_preload_content( + self, + ezsignsignergroup_create_object_v1_request: EzsignsignergroupCreateObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Create a new Ezsignsignergroup + + The endpoint allows to create one or many elements at once. + + :param ezsignsignergroup_create_object_v1_request: (required) + :type ezsignsignergroup_create_object_v1_request: EzsignsignergroupCreateObjectV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignsignergroup_create_object_v1_serialize( + ezsignsignergroup_create_object_v1_request=ezsignsignergroup_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsignsignergroup_create_object_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '201': "EzsignsignergroupCreateObjectV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} + def _ezsignsignergroup_create_object_v1_serialize( + self, + ezsignsignergroup_create_object_v1_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['ezsignsignergroup_create_object_v1_request'] is not None: - _body_params = _params['ezsignsignergroup_create_object_v1_request'] + if ezsignsignergroup_create_object_v1_request is not None: + _body_params = ezsignsignergroup_create_object_v1_request + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '201': "EzsignsignergroupCreateObjectV1Response", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsignsignergroup', 'POST', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='POST', + resource_path='/1/object/ezsignsignergroup', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + - @validate_arguments - def ezsignsignergroup_delete_object_v1(self, pki_ezsignsignergroup_id : Annotated[conint(strict=True, le=65535, ge=0), Field(..., description="The unique ID of the Ezsignsignergroup")], **kwargs) -> EzsignsignergroupDeleteObjectV1Response: # noqa: E501 - """Delete an existing Ezsignsignergroup # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.ezsignsignergroup_delete_object_v1(pki_ezsignsignergroup_id, async_req=True) - >>> result = thread.get() + @validate_call + def ezsignsignergroup_delete_object_v1( + self, + pki_ezsignsignergroup_id: Annotated[int, Field(le=65535, strict=True, ge=0, description="The unique ID of the Ezsignsignergroup")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsignsignergroupDeleteObjectV1Response: + """Delete an existing Ezsignsignergroup + + :param pki_ezsignsignergroup_id: The unique ID of the Ezsignsignergroup (required) :type pki_ezsignsignergroup_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsignsignergroupDeleteObjectV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsignsignergroup_delete_object_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsignsignergroup_delete_object_v1_with_http_info(pki_ezsignsignergroup_id, **kwargs) # noqa: E501 - - @validate_arguments - def ezsignsignergroup_delete_object_v1_with_http_info(self, pki_ezsignsignergroup_id : Annotated[conint(strict=True, le=65535, ge=0), Field(..., description="The unique ID of the Ezsignsignergroup")], **kwargs) -> ApiResponse: # noqa: E501 - """Delete an existing Ezsignsignergroup # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsignsignergroup_delete_object_v1_with_http_info(pki_ezsignsignergroup_id, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._ezsignsignergroup_delete_object_v1_serialize( + pki_ezsignsignergroup_id=pki_ezsignsignergroup_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignsignergroupDeleteObjectV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsignsignergroup_delete_object_v1_with_http_info( + self, + pki_ezsignsignergroup_id: Annotated[int, Field(le=65535, strict=True, ge=0, description="The unique ID of the Ezsignsignergroup")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsignsignergroupDeleteObjectV1Response]: + """Delete an existing Ezsignsignergroup + + :param pki_ezsignsignergroup_id: The unique ID of the Ezsignsignergroup (required) :type pki_ezsignsignergroup_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsignsignergroupDeleteObjectV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._ezsignsignergroup_delete_object_v1_serialize( + pki_ezsignsignergroup_id=pki_ezsignsignergroup_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignsignergroupDeleteObjectV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'pki_ezsignsignergroup_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def ezsignsignergroup_delete_object_v1_without_preload_content( + self, + pki_ezsignsignergroup_id: Annotated[int, Field(le=65535, strict=True, ge=0, description="The unique ID of the Ezsignsignergroup")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete an existing Ezsignsignergroup + + + + :param pki_ezsignsignergroup_id: The unique ID of the Ezsignsignergroup (required) + :type pki_ezsignsignergroup_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignsignergroup_delete_object_v1_serialize( + pki_ezsignsignergroup_id=pki_ezsignsignergroup_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsignsignergroup_delete_object_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignsignergroupDeleteObjectV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_ezsignsignergroup_id']: - _path_params['pkiEzsignsignergroupID'] = _params['pki_ezsignsignergroup_id'] + def _ezsignsignergroup_delete_object_v1_serialize( + self, + pki_ezsignsignergroup_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if pki_ezsignsignergroup_id is not None: + _path_params['pkiEzsignsignergroupID'] = pki_ezsignsignergroup_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "EzsignsignergroupDeleteObjectV1Response", - '404': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsignsignergroup/{pkiEzsignsignergroupID}', 'DELETE', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='DELETE', + resource_path='/1/object/ezsignsignergroup/{pkiEzsignsignergroupID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + - @validate_arguments - def ezsignsignergroup_edit_ezsignsignergroupmemberships_v1(self, pki_ezsignsignergroup_id : conint(strict=True, le=65535, ge=0), ezsignsignergroup_edit_ezsignsignergroupmemberships_v1_request : EzsignsignergroupEditEzsignsignergroupmembershipsV1Request, **kwargs) -> EzsignsignergroupEditEzsignsignergroupmembershipsV1Response: # noqa: E501 - """Edit multiple Ezsignsignergroupmemberships # noqa: E501 - Using this endpoint, you can edit multiple Ezsignsignergroupmemberships at the same time. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.ezsignsignergroup_edit_ezsignsignergroupmemberships_v1(pki_ezsignsignergroup_id, ezsignsignergroup_edit_ezsignsignergroupmemberships_v1_request, async_req=True) - >>> result = thread.get() + @validate_call + def ezsignsignergroup_edit_ezsignsignergroupmemberships_v1( + self, + pki_ezsignsignergroup_id: Annotated[int, Field(le=65535, strict=True, ge=0)], + ezsignsignergroup_edit_ezsignsignergroupmemberships_v1_request: EzsignsignergroupEditEzsignsignergroupmembershipsV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsignsignergroupEditEzsignsignergroupmembershipsV1Response: + """Edit multiple Ezsignsignergroupmemberships + + Using this endpoint, you can edit multiple Ezsignsignergroupmemberships at the same time. :param pki_ezsignsignergroup_id: (required) :type pki_ezsignsignergroup_id: int :param ezsignsignergroup_edit_ezsignsignergroupmemberships_v1_request: (required) :type ezsignsignergroup_edit_ezsignsignergroupmemberships_v1_request: EzsignsignergroupEditEzsignsignergroupmembershipsV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsignsignergroupEditEzsignsignergroupmembershipsV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsignsignergroup_edit_ezsignsignergroupmemberships_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsignsignergroup_edit_ezsignsignergroupmemberships_v1_with_http_info(pki_ezsignsignergroup_id, ezsignsignergroup_edit_ezsignsignergroupmemberships_v1_request, **kwargs) # noqa: E501 - - @validate_arguments - def ezsignsignergroup_edit_ezsignsignergroupmemberships_v1_with_http_info(self, pki_ezsignsignergroup_id : conint(strict=True, le=65535, ge=0), ezsignsignergroup_edit_ezsignsignergroupmemberships_v1_request : EzsignsignergroupEditEzsignsignergroupmembershipsV1Request, **kwargs) -> ApiResponse: # noqa: E501 - """Edit multiple Ezsignsignergroupmemberships # noqa: E501 - - Using this endpoint, you can edit multiple Ezsignsignergroupmemberships at the same time. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsignsignergroup_edit_ezsignsignergroupmemberships_v1_with_http_info(pki_ezsignsignergroup_id, ezsignsignergroup_edit_ezsignsignergroupmemberships_v1_request, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._ezsignsignergroup_edit_ezsignsignergroupmemberships_v1_serialize( + pki_ezsignsignergroup_id=pki_ezsignsignergroup_id, + ezsignsignergroup_edit_ezsignsignergroupmemberships_v1_request=ezsignsignergroup_edit_ezsignsignergroupmemberships_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignsignergroupEditEzsignsignergroupmembershipsV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsignsignergroup_edit_ezsignsignergroupmemberships_v1_with_http_info( + self, + pki_ezsignsignergroup_id: Annotated[int, Field(le=65535, strict=True, ge=0)], + ezsignsignergroup_edit_ezsignsignergroupmemberships_v1_request: EzsignsignergroupEditEzsignsignergroupmembershipsV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsignsignergroupEditEzsignsignergroupmembershipsV1Response]: + """Edit multiple Ezsignsignergroupmemberships + + Using this endpoint, you can edit multiple Ezsignsignergroupmemberships at the same time. :param pki_ezsignsignergroup_id: (required) :type pki_ezsignsignergroup_id: int :param ezsignsignergroup_edit_ezsignsignergroupmemberships_v1_request: (required) :type ezsignsignergroup_edit_ezsignsignergroupmemberships_v1_request: EzsignsignergroupEditEzsignsignergroupmembershipsV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsignsignergroupEditEzsignsignergroupmembershipsV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._ezsignsignergroup_edit_ezsignsignergroupmemberships_v1_serialize( + pki_ezsignsignergroup_id=pki_ezsignsignergroup_id, + ezsignsignergroup_edit_ezsignsignergroupmemberships_v1_request=ezsignsignergroup_edit_ezsignsignergroupmemberships_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignsignergroupEditEzsignsignergroupmembershipsV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _params = locals() - _all_params = [ - 'pki_ezsignsignergroup_id', - 'ezsignsignergroup_edit_ezsignsignergroupmemberships_v1_request' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + @validate_call + def ezsignsignergroup_edit_ezsignsignergroupmemberships_v1_without_preload_content( + self, + pki_ezsignsignergroup_id: Annotated[int, Field(le=65535, strict=True, ge=0)], + ezsignsignergroup_edit_ezsignsignergroupmemberships_v1_request: EzsignsignergroupEditEzsignsignergroupmembershipsV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Edit multiple Ezsignsignergroupmemberships + + Using this endpoint, you can edit multiple Ezsignsignergroupmemberships at the same time. + + :param pki_ezsignsignergroup_id: (required) + :type pki_ezsignsignergroup_id: int + :param ezsignsignergroup_edit_ezsignsignergroupmemberships_v1_request: (required) + :type ezsignsignergroup_edit_ezsignsignergroupmemberships_v1_request: EzsignsignergroupEditEzsignsignergroupmembershipsV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignsignergroup_edit_ezsignsignergroupmemberships_v1_serialize( + pki_ezsignsignergroup_id=pki_ezsignsignergroup_id, + ezsignsignergroup_edit_ezsignsignergroupmemberships_v1_request=ezsignsignergroup_edit_ezsignsignergroupmemberships_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsignsignergroup_edit_ezsignsignergroupmemberships_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignsignergroupEditEzsignsignergroupmembershipsV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_ezsignsignergroup_id']: - _path_params['pkiEzsignsignergroupID'] = _params['pki_ezsignsignergroup_id'] + def _ezsignsignergroup_edit_ezsignsignergroupmemberships_v1_serialize( + self, + pki_ezsignsignergroup_id, + ezsignsignergroup_edit_ezsignsignergroupmemberships_v1_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if pki_ezsignsignergroup_id is not None: + _path_params['pkiEzsignsignergroupID'] = pki_ezsignsignergroup_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['ezsignsignergroup_edit_ezsignsignergroupmemberships_v1_request'] is not None: - _body_params = _params['ezsignsignergroup_edit_ezsignsignergroupmemberships_v1_request'] + if ezsignsignergroup_edit_ezsignsignergroupmemberships_v1_request is not None: + _body_params = ezsignsignergroup_edit_ezsignsignergroupmemberships_v1_request + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '200': "EzsignsignergroupEditEzsignsignergroupmembershipsV1Response", - '404': "CommonResponseError", - '422': "CommonResponseError", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsignsignergroup/{pkiEzsignsignergroupID}/editEzsignsignergroupmemberships', 'PUT', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='PUT', + resource_path='/1/object/ezsignsignergroup/{pkiEzsignsignergroupID}/editEzsignsignergroupmemberships', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + - @validate_arguments - def ezsignsignergroup_edit_object_v1(self, pki_ezsignsignergroup_id : Annotated[conint(strict=True, le=65535, ge=0), Field(..., description="The unique ID of the Ezsignsignergroup")], ezsignsignergroup_edit_object_v1_request : EzsignsignergroupEditObjectV1Request, **kwargs) -> EzsignsignergroupEditObjectV1Response: # noqa: E501 - """Edit an existing Ezsignsignergroup # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.ezsignsignergroup_edit_object_v1(pki_ezsignsignergroup_id, ezsignsignergroup_edit_object_v1_request, async_req=True) - >>> result = thread.get() + @validate_call + def ezsignsignergroup_edit_object_v1( + self, + pki_ezsignsignergroup_id: Annotated[int, Field(le=65535, strict=True, ge=0, description="The unique ID of the Ezsignsignergroup")], + ezsignsignergroup_edit_object_v1_request: EzsignsignergroupEditObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsignsignergroupEditObjectV1Response: + """Edit an existing Ezsignsignergroup + + :param pki_ezsignsignergroup_id: The unique ID of the Ezsignsignergroup (required) :type pki_ezsignsignergroup_id: int :param ezsignsignergroup_edit_object_v1_request: (required) :type ezsignsignergroup_edit_object_v1_request: EzsignsignergroupEditObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsignsignergroupEditObjectV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsignsignergroup_edit_object_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsignsignergroup_edit_object_v1_with_http_info(pki_ezsignsignergroup_id, ezsignsignergroup_edit_object_v1_request, **kwargs) # noqa: E501 - - @validate_arguments - def ezsignsignergroup_edit_object_v1_with_http_info(self, pki_ezsignsignergroup_id : Annotated[conint(strict=True, le=65535, ge=0), Field(..., description="The unique ID of the Ezsignsignergroup")], ezsignsignergroup_edit_object_v1_request : EzsignsignergroupEditObjectV1Request, **kwargs) -> ApiResponse: # noqa: E501 - """Edit an existing Ezsignsignergroup # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsignsignergroup_edit_object_v1_with_http_info(pki_ezsignsignergroup_id, ezsignsignergroup_edit_object_v1_request, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._ezsignsignergroup_edit_object_v1_serialize( + pki_ezsignsignergroup_id=pki_ezsignsignergroup_id, + ezsignsignergroup_edit_object_v1_request=ezsignsignergroup_edit_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignsignergroupEditObjectV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsignsignergroup_edit_object_v1_with_http_info( + self, + pki_ezsignsignergroup_id: Annotated[int, Field(le=65535, strict=True, ge=0, description="The unique ID of the Ezsignsignergroup")], + ezsignsignergroup_edit_object_v1_request: EzsignsignergroupEditObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsignsignergroupEditObjectV1Response]: + """Edit an existing Ezsignsignergroup + + :param pki_ezsignsignergroup_id: The unique ID of the Ezsignsignergroup (required) :type pki_ezsignsignergroup_id: int :param ezsignsignergroup_edit_object_v1_request: (required) :type ezsignsignergroup_edit_object_v1_request: EzsignsignergroupEditObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsignsignergroupEditObjectV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._ezsignsignergroup_edit_object_v1_serialize( + pki_ezsignsignergroup_id=pki_ezsignsignergroup_id, + ezsignsignergroup_edit_object_v1_request=ezsignsignergroup_edit_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignsignergroupEditObjectV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'pki_ezsignsignergroup_id', - 'ezsignsignergroup_edit_object_v1_request' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def ezsignsignergroup_edit_object_v1_without_preload_content( + self, + pki_ezsignsignergroup_id: Annotated[int, Field(le=65535, strict=True, ge=0, description="The unique ID of the Ezsignsignergroup")], + ezsignsignergroup_edit_object_v1_request: EzsignsignergroupEditObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Edit an existing Ezsignsignergroup + + + + :param pki_ezsignsignergroup_id: The unique ID of the Ezsignsignergroup (required) + :type pki_ezsignsignergroup_id: int + :param ezsignsignergroup_edit_object_v1_request: (required) + :type ezsignsignergroup_edit_object_v1_request: EzsignsignergroupEditObjectV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignsignergroup_edit_object_v1_serialize( + pki_ezsignsignergroup_id=pki_ezsignsignergroup_id, + ezsignsignergroup_edit_object_v1_request=ezsignsignergroup_edit_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsignsignergroup_edit_object_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignsignergroupEditObjectV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_ezsignsignergroup_id']: - _path_params['pkiEzsignsignergroupID'] = _params['pki_ezsignsignergroup_id'] + def _ezsignsignergroup_edit_object_v1_serialize( + self, + pki_ezsignsignergroup_id, + ezsignsignergroup_edit_object_v1_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if pki_ezsignsignergroup_id is not None: + _path_params['pkiEzsignsignergroupID'] = pki_ezsignsignergroup_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['ezsignsignergroup_edit_object_v1_request'] is not None: - _body_params = _params['ezsignsignergroup_edit_object_v1_request'] + if ezsignsignergroup_edit_object_v1_request is not None: + _body_params = ezsignsignergroup_edit_object_v1_request + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '200': "EzsignsignergroupEditObjectV1Response", - '404': "CommonResponseError", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsignsignergroup/{pkiEzsignsignergroupID}', 'PUT', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='PUT', + resource_path='/1/object/ezsignsignergroup/{pkiEzsignsignergroupID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) - @validate_arguments - def ezsignsignergroup_get_ezsignsignergroupmemberships_v1(self, pki_ezsignsignergroup_id : conint(strict=True, le=65535, ge=0), **kwargs) -> EzsignsignergroupGetEzsignsignergroupmembershipsV1Response: # noqa: E501 - """Retrieve an existing Ezsignsignergroup's Ezsignsignergroupmemberships # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.ezsignsignergroup_get_ezsignsignergroupmemberships_v1(pki_ezsignsignergroup_id, async_req=True) - >>> result = thread.get() + + @validate_call + def ezsignsignergroup_get_ezsignsignergroupmemberships_v1( + self, + pki_ezsignsignergroup_id: Annotated[int, Field(le=65535, strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsignsignergroupGetEzsignsignergroupmembershipsV1Response: + """Retrieve an existing Ezsignsignergroup's Ezsignsignergroupmemberships + :param pki_ezsignsignergroup_id: (required) :type pki_ezsignsignergroup_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsignsignergroupGetEzsignsignergroupmembershipsV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsignsignergroup_get_ezsignsignergroupmemberships_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsignsignergroup_get_ezsignsignergroupmemberships_v1_with_http_info(pki_ezsignsignergroup_id, **kwargs) # noqa: E501 - - @validate_arguments - def ezsignsignergroup_get_ezsignsignergroupmemberships_v1_with_http_info(self, pki_ezsignsignergroup_id : conint(strict=True, le=65535, ge=0), **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve an existing Ezsignsignergroup's Ezsignsignergroupmemberships # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsignsignergroup_get_ezsignsignergroupmemberships_v1_with_http_info(pki_ezsignsignergroup_id, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._ezsignsignergroup_get_ezsignsignergroupmemberships_v1_serialize( + pki_ezsignsignergroup_id=pki_ezsignsignergroup_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignsignergroupGetEzsignsignergroupmembershipsV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsignsignergroup_get_ezsignsignergroupmemberships_v1_with_http_info( + self, + pki_ezsignsignergroup_id: Annotated[int, Field(le=65535, strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsignsignergroupGetEzsignsignergroupmembershipsV1Response]: + """Retrieve an existing Ezsignsignergroup's Ezsignsignergroupmemberships + :param pki_ezsignsignergroup_id: (required) :type pki_ezsignsignergroup_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsignsignergroupGetEzsignsignergroupmembershipsV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._ezsignsignergroup_get_ezsignsignergroupmemberships_v1_serialize( + pki_ezsignsignergroup_id=pki_ezsignsignergroup_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignsignergroupGetEzsignsignergroupmembershipsV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'pki_ezsignsignergroup_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def ezsignsignergroup_get_ezsignsignergroupmemberships_v1_without_preload_content( + self, + pki_ezsignsignergroup_id: Annotated[int, Field(le=65535, strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve an existing Ezsignsignergroup's Ezsignsignergroupmemberships + + + :param pki_ezsignsignergroup_id: (required) + :type pki_ezsignsignergroup_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignsignergroup_get_ezsignsignergroupmemberships_v1_serialize( + pki_ezsignsignergroup_id=pki_ezsignsignergroup_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsignsignergroup_get_ezsignsignergroupmemberships_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignsignergroupGetEzsignsignergroupmembershipsV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_ezsignsignergroup_id']: - _path_params['pkiEzsignsignergroupID'] = _params['pki_ezsignsignergroup_id'] + def _ezsignsignergroup_get_ezsignsignergroupmemberships_v1_serialize( + self, + pki_ezsignsignergroup_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if pki_ezsignsignergroup_id is not None: + _path_params['pkiEzsignsignergroupID'] = pki_ezsignsignergroup_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "EzsignsignergroupGetEzsignsignergroupmembershipsV1Response", - '404': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsignsignergroup/{pkiEzsignsignergroupID}/getEzsignsignergroupmemberships', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/1/object/ezsignsignergroup/{pkiEzsignsignergroupID}/getEzsignsignergroupmemberships', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) - @validate_arguments - def ezsignsignergroup_get_object_v2(self, pki_ezsignsignergroup_id : Annotated[conint(strict=True, le=65535, ge=0), Field(..., description="The unique ID of the Ezsignsignergroup")], **kwargs) -> EzsignsignergroupGetObjectV2Response: # noqa: E501 - """Retrieve an existing Ezsignsignergroup # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.ezsignsignergroup_get_object_v2(pki_ezsignsignergroup_id, async_req=True) - >>> result = thread.get() + + @validate_call + def ezsignsignergroup_get_object_v2( + self, + pki_ezsignsignergroup_id: Annotated[int, Field(le=65535, strict=True, ge=0, description="The unique ID of the Ezsignsignergroup")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsignsignergroupGetObjectV2Response: + """Retrieve an existing Ezsignsignergroup + + :param pki_ezsignsignergroup_id: The unique ID of the Ezsignsignergroup (required) :type pki_ezsignsignergroup_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsignsignergroupGetObjectV2Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsignsignergroup_get_object_v2_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsignsignergroup_get_object_v2_with_http_info(pki_ezsignsignergroup_id, **kwargs) # noqa: E501 - - @validate_arguments - def ezsignsignergroup_get_object_v2_with_http_info(self, pki_ezsignsignergroup_id : Annotated[conint(strict=True, le=65535, ge=0), Field(..., description="The unique ID of the Ezsignsignergroup")], **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve an existing Ezsignsignergroup # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsignsignergroup_get_object_v2_with_http_info(pki_ezsignsignergroup_id, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._ezsignsignergroup_get_object_v2_serialize( + pki_ezsignsignergroup_id=pki_ezsignsignergroup_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignsignergroupGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsignsignergroup_get_object_v2_with_http_info( + self, + pki_ezsignsignergroup_id: Annotated[int, Field(le=65535, strict=True, ge=0, description="The unique ID of the Ezsignsignergroup")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsignsignergroupGetObjectV2Response]: + """Retrieve an existing Ezsignsignergroup + + :param pki_ezsignsignergroup_id: The unique ID of the Ezsignsignergroup (required) :type pki_ezsignsignergroup_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsignsignergroupGetObjectV2Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._ezsignsignergroup_get_object_v2_serialize( + pki_ezsignsignergroup_id=pki_ezsignsignergroup_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignsignergroupGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _params = locals() - _all_params = [ - 'pki_ezsignsignergroup_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + @validate_call + def ezsignsignergroup_get_object_v2_without_preload_content( + self, + pki_ezsignsignergroup_id: Annotated[int, Field(le=65535, strict=True, ge=0, description="The unique ID of the Ezsignsignergroup")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve an existing Ezsignsignergroup + + + + :param pki_ezsignsignergroup_id: The unique ID of the Ezsignsignergroup (required) + :type pki_ezsignsignergroup_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignsignergroup_get_object_v2_serialize( + pki_ezsignsignergroup_id=pki_ezsignsignergroup_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsignsignergroup_get_object_v2" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignsignergroupGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_ezsignsignergroup_id']: - _path_params['pkiEzsignsignergroupID'] = _params['pki_ezsignsignergroup_id'] + def _ezsignsignergroup_get_object_v2_serialize( + self, + pki_ezsignsignergroup_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if pki_ezsignsignergroup_id is not None: + _path_params['pkiEzsignsignergroupID'] = pki_ezsignsignergroup_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "EzsignsignergroupGetObjectV2Response", - '404': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/2/object/ezsignsignergroup/{pkiEzsignsignergroupID}', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/2/object/ezsignsignergroup/{pkiEzsignsignergroupID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/eZmaxApi/api/object_ezsignsignergroupmembership_api.py b/eZmaxApi/api/object_ezsignsignergroupmembership_api.py index 0913cf694..c3d5c4d77 100644 --- a/eZmaxApi/api/object_ezsignsignergroupmembership_api.py +++ b/eZmaxApi/api/object_ezsignsignergroupmembership_api.py @@ -13,15 +13,19 @@ """ # noqa: E501 -import re # noqa: F401 import io import warnings -from pydantic import validate_arguments, ValidationError +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Dict, List, Optional, Tuple, Union, Any -from typing_extensions import Annotated -from pydantic import Field, conint +try: + from typing import Annotated +except ImportError: + from typing_extensions import Annotated +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.ezsignsignergroupmembership_create_object_v1_request import EzsignsignergroupmembershipCreateObjectV1Request from eZmaxApi.models.ezsignsignergroupmembership_create_object_v1_response import EzsignsignergroupmembershipCreateObjectV1Response from eZmaxApi.models.ezsignsignergroupmembership_delete_object_v1_response import EzsignsignergroupmembershipDeleteObjectV1Response @@ -29,10 +33,7 @@ from eZmaxApi.api_client import ApiClient from eZmaxApi.api_response import ApiResponse -from eZmaxApi.exceptions import ( # noqa: F401 - ApiTypeError, - ApiValueError -) +from eZmaxApi.rest import RESTResponseType class ObjectEzsignsignergroupmembershipApi: @@ -47,431 +48,795 @@ def __init__(self, api_client=None) -> None: api_client = ApiClient.get_default() self.api_client = api_client - @validate_arguments - def ezsignsignergroupmembership_create_object_v1(self, ezsignsignergroupmembership_create_object_v1_request : EzsignsignergroupmembershipCreateObjectV1Request, **kwargs) -> EzsignsignergroupmembershipCreateObjectV1Response: # noqa: E501 - """Create a new Ezsignsignergroupmembership # noqa: E501 - The endpoint allows to create one or many elements at once. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def ezsignsignergroupmembership_create_object_v1( + self, + ezsignsignergroupmembership_create_object_v1_request: EzsignsignergroupmembershipCreateObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsignsignergroupmembershipCreateObjectV1Response: + """Create a new Ezsignsignergroupmembership - >>> thread = api.ezsignsignergroupmembership_create_object_v1(ezsignsignergroupmembership_create_object_v1_request, async_req=True) - >>> result = thread.get() + The endpoint allows to create one or many elements at once. :param ezsignsignergroupmembership_create_object_v1_request: (required) :type ezsignsignergroupmembership_create_object_v1_request: EzsignsignergroupmembershipCreateObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsignsignergroupmembershipCreateObjectV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsignsignergroupmembership_create_object_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsignsignergroupmembership_create_object_v1_with_http_info(ezsignsignergroupmembership_create_object_v1_request, **kwargs) # noqa: E501 - - @validate_arguments - def ezsignsignergroupmembership_create_object_v1_with_http_info(self, ezsignsignergroupmembership_create_object_v1_request : EzsignsignergroupmembershipCreateObjectV1Request, **kwargs) -> ApiResponse: # noqa: E501 - """Create a new Ezsignsignergroupmembership # noqa: E501 - - The endpoint allows to create one or many elements at once. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsignsignergroupmembership_create_object_v1_with_http_info(ezsignsignergroupmembership_create_object_v1_request, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._ezsignsignergroupmembership_create_object_v1_serialize( + ezsignsignergroupmembership_create_object_v1_request=ezsignsignergroupmembership_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "EzsignsignergroupmembershipCreateObjectV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsignsignergroupmembership_create_object_v1_with_http_info( + self, + ezsignsignergroupmembership_create_object_v1_request: EzsignsignergroupmembershipCreateObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsignsignergroupmembershipCreateObjectV1Response]: + """Create a new Ezsignsignergroupmembership + + The endpoint allows to create one or many elements at once. :param ezsignsignergroupmembership_create_object_v1_request: (required) :type ezsignsignergroupmembership_create_object_v1_request: EzsignsignergroupmembershipCreateObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsignsignergroupmembershipCreateObjectV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._ezsignsignergroupmembership_create_object_v1_serialize( + ezsignsignergroupmembership_create_object_v1_request=ezsignsignergroupmembership_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "EzsignsignergroupmembershipCreateObjectV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _params = locals() - _all_params = [ - 'ezsignsignergroupmembership_create_object_v1_request' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + @validate_call + def ezsignsignergroupmembership_create_object_v1_without_preload_content( + self, + ezsignsignergroupmembership_create_object_v1_request: EzsignsignergroupmembershipCreateObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Create a new Ezsignsignergroupmembership + + The endpoint allows to create one or many elements at once. + + :param ezsignsignergroupmembership_create_object_v1_request: (required) + :type ezsignsignergroupmembership_create_object_v1_request: EzsignsignergroupmembershipCreateObjectV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignsignergroupmembership_create_object_v1_serialize( + ezsignsignergroupmembership_create_object_v1_request=ezsignsignergroupmembership_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsignsignergroupmembership_create_object_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '201': "EzsignsignergroupmembershipCreateObjectV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} + def _ezsignsignergroupmembership_create_object_v1_serialize( + self, + ezsignsignergroupmembership_create_object_v1_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['ezsignsignergroupmembership_create_object_v1_request'] is not None: - _body_params = _params['ezsignsignergroupmembership_create_object_v1_request'] + if ezsignsignergroupmembership_create_object_v1_request is not None: + _body_params = ezsignsignergroupmembership_create_object_v1_request + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '201': "EzsignsignergroupmembershipCreateObjectV1Response", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsignsignergroupmembership', 'POST', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='POST', + resource_path='/1/object/ezsignsignergroupmembership', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) - @validate_arguments - def ezsignsignergroupmembership_delete_object_v1(self, pki_ezsignsignergroupmembership_id : Annotated[conint(strict=True, le=16777215, ge=0), Field(..., description="The unique ID of the Ezsignsignergroupmembership")], **kwargs) -> EzsignsignergroupmembershipDeleteObjectV1Response: # noqa: E501 - """Delete an existing Ezsignsignergroupmembership # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.ezsignsignergroupmembership_delete_object_v1(pki_ezsignsignergroupmembership_id, async_req=True) - >>> result = thread.get() + + @validate_call + def ezsignsignergroupmembership_delete_object_v1( + self, + pki_ezsignsignergroupmembership_id: Annotated[int, Field(le=16777215, strict=True, ge=0, description="The unique ID of the Ezsignsignergroupmembership")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsignsignergroupmembershipDeleteObjectV1Response: + """Delete an existing Ezsignsignergroupmembership + + :param pki_ezsignsignergroupmembership_id: The unique ID of the Ezsignsignergroupmembership (required) :type pki_ezsignsignergroupmembership_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsignsignergroupmembershipDeleteObjectV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsignsignergroupmembership_delete_object_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsignsignergroupmembership_delete_object_v1_with_http_info(pki_ezsignsignergroupmembership_id, **kwargs) # noqa: E501 - - @validate_arguments - def ezsignsignergroupmembership_delete_object_v1_with_http_info(self, pki_ezsignsignergroupmembership_id : Annotated[conint(strict=True, le=16777215, ge=0), Field(..., description="The unique ID of the Ezsignsignergroupmembership")], **kwargs) -> ApiResponse: # noqa: E501 - """Delete an existing Ezsignsignergroupmembership # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsignsignergroupmembership_delete_object_v1_with_http_info(pki_ezsignsignergroupmembership_id, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._ezsignsignergroupmembership_delete_object_v1_serialize( + pki_ezsignsignergroupmembership_id=pki_ezsignsignergroupmembership_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignsignergroupmembershipDeleteObjectV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsignsignergroupmembership_delete_object_v1_with_http_info( + self, + pki_ezsignsignergroupmembership_id: Annotated[int, Field(le=16777215, strict=True, ge=0, description="The unique ID of the Ezsignsignergroupmembership")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsignsignergroupmembershipDeleteObjectV1Response]: + """Delete an existing Ezsignsignergroupmembership + + :param pki_ezsignsignergroupmembership_id: The unique ID of the Ezsignsignergroupmembership (required) :type pki_ezsignsignergroupmembership_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsignsignergroupmembershipDeleteObjectV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._ezsignsignergroupmembership_delete_object_v1_serialize( + pki_ezsignsignergroupmembership_id=pki_ezsignsignergroupmembership_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignsignergroupmembershipDeleteObjectV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'pki_ezsignsignergroupmembership_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def ezsignsignergroupmembership_delete_object_v1_without_preload_content( + self, + pki_ezsignsignergroupmembership_id: Annotated[int, Field(le=16777215, strict=True, ge=0, description="The unique ID of the Ezsignsignergroupmembership")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete an existing Ezsignsignergroupmembership + + + + :param pki_ezsignsignergroupmembership_id: The unique ID of the Ezsignsignergroupmembership (required) + :type pki_ezsignsignergroupmembership_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignsignergroupmembership_delete_object_v1_serialize( + pki_ezsignsignergroupmembership_id=pki_ezsignsignergroupmembership_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsignsignergroupmembership_delete_object_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignsignergroupmembershipDeleteObjectV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_ezsignsignergroupmembership_id']: - _path_params['pkiEzsignsignergroupmembershipID'] = _params['pki_ezsignsignergroupmembership_id'] + def _ezsignsignergroupmembership_delete_object_v1_serialize( + self, + pki_ezsignsignergroupmembership_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_ezsignsignergroupmembership_id is not None: + _path_params['pkiEzsignsignergroupmembershipID'] = pki_ezsignsignergroupmembership_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "EzsignsignergroupmembershipDeleteObjectV1Response", - '404': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsignsignergroupmembership/{pkiEzsignsignergroupmembershipID}', 'DELETE', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='DELETE', + resource_path='/1/object/ezsignsignergroupmembership/{pkiEzsignsignergroupmembershipID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + - @validate_arguments - def ezsignsignergroupmembership_get_object_v2(self, pki_ezsignsignergroupmembership_id : Annotated[conint(strict=True, le=16777215, ge=0), Field(..., description="The unique ID of the Ezsignsignergroupmembership")], **kwargs) -> EzsignsignergroupmembershipGetObjectV2Response: # noqa: E501 - """Retrieve an existing Ezsignsignergroupmembership # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.ezsignsignergroupmembership_get_object_v2(pki_ezsignsignergroupmembership_id, async_req=True) - >>> result = thread.get() + @validate_call + def ezsignsignergroupmembership_get_object_v2( + self, + pki_ezsignsignergroupmembership_id: Annotated[int, Field(le=16777215, strict=True, ge=0, description="The unique ID of the Ezsignsignergroupmembership")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsignsignergroupmembershipGetObjectV2Response: + """Retrieve an existing Ezsignsignergroupmembership + + :param pki_ezsignsignergroupmembership_id: The unique ID of the Ezsignsignergroupmembership (required) :type pki_ezsignsignergroupmembership_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsignsignergroupmembershipGetObjectV2Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsignsignergroupmembership_get_object_v2_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsignsignergroupmembership_get_object_v2_with_http_info(pki_ezsignsignergroupmembership_id, **kwargs) # noqa: E501 - - @validate_arguments - def ezsignsignergroupmembership_get_object_v2_with_http_info(self, pki_ezsignsignergroupmembership_id : Annotated[conint(strict=True, le=16777215, ge=0), Field(..., description="The unique ID of the Ezsignsignergroupmembership")], **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve an existing Ezsignsignergroupmembership # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsignsignergroupmembership_get_object_v2_with_http_info(pki_ezsignsignergroupmembership_id, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._ezsignsignergroupmembership_get_object_v2_serialize( + pki_ezsignsignergroupmembership_id=pki_ezsignsignergroupmembership_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignsignergroupmembershipGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsignsignergroupmembership_get_object_v2_with_http_info( + self, + pki_ezsignsignergroupmembership_id: Annotated[int, Field(le=16777215, strict=True, ge=0, description="The unique ID of the Ezsignsignergroupmembership")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsignsignergroupmembershipGetObjectV2Response]: + """Retrieve an existing Ezsignsignergroupmembership + + :param pki_ezsignsignergroupmembership_id: The unique ID of the Ezsignsignergroupmembership (required) :type pki_ezsignsignergroupmembership_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsignsignergroupmembershipGetObjectV2Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._ezsignsignergroupmembership_get_object_v2_serialize( + pki_ezsignsignergroupmembership_id=pki_ezsignsignergroupmembership_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignsignergroupmembershipGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _params = locals() - _all_params = [ - 'pki_ezsignsignergroupmembership_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + @validate_call + def ezsignsignergroupmembership_get_object_v2_without_preload_content( + self, + pki_ezsignsignergroupmembership_id: Annotated[int, Field(le=16777215, strict=True, ge=0, description="The unique ID of the Ezsignsignergroupmembership")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve an existing Ezsignsignergroupmembership + + + + :param pki_ezsignsignergroupmembership_id: The unique ID of the Ezsignsignergroupmembership (required) + :type pki_ezsignsignergroupmembership_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignsignergroupmembership_get_object_v2_serialize( + pki_ezsignsignergroupmembership_id=pki_ezsignsignergroupmembership_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsignsignergroupmembership_get_object_v2" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignsignergroupmembershipGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_ezsignsignergroupmembership_id']: - _path_params['pkiEzsignsignergroupmembershipID'] = _params['pki_ezsignsignergroupmembership_id'] + def _ezsignsignergroupmembership_get_object_v2_serialize( + self, + pki_ezsignsignergroupmembership_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if pki_ezsignsignergroupmembership_id is not None: + _path_params['pkiEzsignsignergroupmembershipID'] = pki_ezsignsignergroupmembership_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "EzsignsignergroupmembershipGetObjectV2Response", - '404': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/2/object/ezsignsignergroupmembership/{pkiEzsignsignergroupmembershipID}', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/2/object/ezsignsignergroupmembership/{pkiEzsignsignergroupmembershipID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/eZmaxApi/api/object_ezsignsigningreason_api.py b/eZmaxApi/api/object_ezsignsigningreason_api.py new file mode 100644 index 000000000..499b069ed --- /dev/null +++ b/eZmaxApi/api/object_ezsignsigningreason_api.py @@ -0,0 +1,1518 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import io +import warnings + +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Dict, List, Optional, Tuple, Union, Any + +try: + from typing import Annotated +except ImportError: + from typing_extensions import Annotated + +from pydantic import Field +from typing_extensions import Annotated +from pydantic import StrictStr, field_validator + +from typing import Optional + +from eZmaxApi.models.ezsignsigningreason_create_object_v1_request import EzsignsigningreasonCreateObjectV1Request +from eZmaxApi.models.ezsignsigningreason_create_object_v1_response import EzsignsigningreasonCreateObjectV1Response +from eZmaxApi.models.ezsignsigningreason_edit_object_v1_request import EzsignsigningreasonEditObjectV1Request +from eZmaxApi.models.ezsignsigningreason_edit_object_v1_response import EzsignsigningreasonEditObjectV1Response +from eZmaxApi.models.ezsignsigningreason_get_autocomplete_v2_response import EzsignsigningreasonGetAutocompleteV2Response +from eZmaxApi.models.ezsignsigningreason_get_list_v1_response import EzsignsigningreasonGetListV1Response +from eZmaxApi.models.ezsignsigningreason_get_object_v2_response import EzsignsigningreasonGetObjectV2Response +from eZmaxApi.models.header_accept_language import HeaderAcceptLanguage + +from eZmaxApi.api_client import ApiClient +from eZmaxApi.api_response import ApiResponse +from eZmaxApi.rest import RESTResponseType + + +class ObjectEzsignsigningreasonApi: + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None) -> None: + if api_client is None: + api_client = ApiClient.get_default() + self.api_client = api_client + + + @validate_call + def ezsignsigningreason_create_object_v1( + self, + ezsignsigningreason_create_object_v1_request: EzsignsigningreasonCreateObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsignsigningreasonCreateObjectV1Response: + """Create a new Ezsignsigningreason + + The endpoint allows to create one or many elements at once. + + :param ezsignsigningreason_create_object_v1_request: (required) + :type ezsignsigningreason_create_object_v1_request: EzsignsigningreasonCreateObjectV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignsigningreason_create_object_v1_serialize( + ezsignsigningreason_create_object_v1_request=ezsignsigningreason_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "EzsignsigningreasonCreateObjectV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsignsigningreason_create_object_v1_with_http_info( + self, + ezsignsigningreason_create_object_v1_request: EzsignsigningreasonCreateObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsignsigningreasonCreateObjectV1Response]: + """Create a new Ezsignsigningreason + + The endpoint allows to create one or many elements at once. + + :param ezsignsigningreason_create_object_v1_request: (required) + :type ezsignsigningreason_create_object_v1_request: EzsignsigningreasonCreateObjectV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignsigningreason_create_object_v1_serialize( + ezsignsigningreason_create_object_v1_request=ezsignsigningreason_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "EzsignsigningreasonCreateObjectV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def ezsignsigningreason_create_object_v1_without_preload_content( + self, + ezsignsigningreason_create_object_v1_request: EzsignsigningreasonCreateObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Create a new Ezsignsigningreason + + The endpoint allows to create one or many elements at once. + + :param ezsignsigningreason_create_object_v1_request: (required) + :type ezsignsigningreason_create_object_v1_request: EzsignsigningreasonCreateObjectV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignsigningreason_create_object_v1_serialize( + ezsignsigningreason_create_object_v1_request=ezsignsigningreason_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "EzsignsigningreasonCreateObjectV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _ezsignsigningreason_create_object_v1_serialize( + self, + ezsignsigningreason_create_object_v1_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if ezsignsigningreason_create_object_v1_request is not None: + _body_params = ezsignsigningreason_create_object_v1_request + + + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/1/object/ezsignsigningreason', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def ezsignsigningreason_edit_object_v1( + self, + pki_ezsignsigningreason_id: Annotated[int, Field(le=255, strict=True, ge=0, description="The unique ID of the Ezsignsigningreason")], + ezsignsigningreason_edit_object_v1_request: EzsignsigningreasonEditObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsignsigningreasonEditObjectV1Response: + """Edit an existing Ezsignsigningreason + + + + :param pki_ezsignsigningreason_id: The unique ID of the Ezsignsigningreason (required) + :type pki_ezsignsigningreason_id: int + :param ezsignsigningreason_edit_object_v1_request: (required) + :type ezsignsigningreason_edit_object_v1_request: EzsignsigningreasonEditObjectV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignsigningreason_edit_object_v1_serialize( + pki_ezsignsigningreason_id=pki_ezsignsigningreason_id, + ezsignsigningreason_edit_object_v1_request=ezsignsigningreason_edit_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignsigningreasonEditObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsignsigningreason_edit_object_v1_with_http_info( + self, + pki_ezsignsigningreason_id: Annotated[int, Field(le=255, strict=True, ge=0, description="The unique ID of the Ezsignsigningreason")], + ezsignsigningreason_edit_object_v1_request: EzsignsigningreasonEditObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsignsigningreasonEditObjectV1Response]: + """Edit an existing Ezsignsigningreason + + + + :param pki_ezsignsigningreason_id: The unique ID of the Ezsignsigningreason (required) + :type pki_ezsignsigningreason_id: int + :param ezsignsigningreason_edit_object_v1_request: (required) + :type ezsignsigningreason_edit_object_v1_request: EzsignsigningreasonEditObjectV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignsigningreason_edit_object_v1_serialize( + pki_ezsignsigningreason_id=pki_ezsignsigningreason_id, + ezsignsigningreason_edit_object_v1_request=ezsignsigningreason_edit_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignsigningreasonEditObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def ezsignsigningreason_edit_object_v1_without_preload_content( + self, + pki_ezsignsigningreason_id: Annotated[int, Field(le=255, strict=True, ge=0, description="The unique ID of the Ezsignsigningreason")], + ezsignsigningreason_edit_object_v1_request: EzsignsigningreasonEditObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Edit an existing Ezsignsigningreason + + + + :param pki_ezsignsigningreason_id: The unique ID of the Ezsignsigningreason (required) + :type pki_ezsignsigningreason_id: int + :param ezsignsigningreason_edit_object_v1_request: (required) + :type ezsignsigningreason_edit_object_v1_request: EzsignsigningreasonEditObjectV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignsigningreason_edit_object_v1_serialize( + pki_ezsignsigningreason_id=pki_ezsignsigningreason_id, + ezsignsigningreason_edit_object_v1_request=ezsignsigningreason_edit_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignsigningreasonEditObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _ezsignsigningreason_edit_object_v1_serialize( + self, + pki_ezsignsigningreason_id, + ezsignsigningreason_edit_object_v1_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_ezsignsigningreason_id is not None: + _path_params['pkiEzsignsigningreasonID'] = pki_ezsignsigningreason_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if ezsignsigningreason_edit_object_v1_request is not None: + _body_params = ezsignsigningreason_edit_object_v1_request + + + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] + + return self.api_client.param_serialize( + method='PUT', + resource_path='/1/object/ezsignsigningreason/{pkiEzsignsigningreasonID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def ezsignsigningreason_get_autocomplete_v2( + self, + s_selector: Annotated[StrictStr, Field(description="The type of Ezsignsigningreasons to return")], + e_filter_active: Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, + s_query: Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsignsigningreasonGetAutocompleteV2Response: + """Retrieve Ezsignsigningreasons and IDs + + Get the list of Ezsignsigningreason to be used in a dropdown or autocomplete control. + + :param s_selector: The type of Ezsignsigningreasons to return (required) + :type s_selector: str + :param e_filter_active: Specify which results we want to display. + :type e_filter_active: str + :param s_query: Allow to filter the returned results + :type s_query: str + :param accept_language: + :type accept_language: HeaderAcceptLanguage + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignsigningreason_get_autocomplete_v2_serialize( + s_selector=s_selector, + e_filter_active=e_filter_active, + s_query=s_query, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignsigningreasonGetAutocompleteV2Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsignsigningreason_get_autocomplete_v2_with_http_info( + self, + s_selector: Annotated[StrictStr, Field(description="The type of Ezsignsigningreasons to return")], + e_filter_active: Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, + s_query: Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsignsigningreasonGetAutocompleteV2Response]: + """Retrieve Ezsignsigningreasons and IDs + + Get the list of Ezsignsigningreason to be used in a dropdown or autocomplete control. + + :param s_selector: The type of Ezsignsigningreasons to return (required) + :type s_selector: str + :param e_filter_active: Specify which results we want to display. + :type e_filter_active: str + :param s_query: Allow to filter the returned results + :type s_query: str + :param accept_language: + :type accept_language: HeaderAcceptLanguage + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignsigningreason_get_autocomplete_v2_serialize( + s_selector=s_selector, + e_filter_active=e_filter_active, + s_query=s_query, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignsigningreasonGetAutocompleteV2Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def ezsignsigningreason_get_autocomplete_v2_without_preload_content( + self, + s_selector: Annotated[StrictStr, Field(description="The type of Ezsignsigningreasons to return")], + e_filter_active: Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, + s_query: Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve Ezsignsigningreasons and IDs + + Get the list of Ezsignsigningreason to be used in a dropdown or autocomplete control. + + :param s_selector: The type of Ezsignsigningreasons to return (required) + :type s_selector: str + :param e_filter_active: Specify which results we want to display. + :type e_filter_active: str + :param s_query: Allow to filter the returned results + :type s_query: str + :param accept_language: + :type accept_language: HeaderAcceptLanguage + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignsigningreason_get_autocomplete_v2_serialize( + s_selector=s_selector, + e_filter_active=e_filter_active, + s_query=s_query, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignsigningreasonGetAutocompleteV2Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _ezsignsigningreason_get_autocomplete_v2_serialize( + self, + s_selector, + e_filter_active, + s_query, + accept_language, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if s_selector is not None: + _path_params['sSelector'] = s_selector + # process the query parameters + if e_filter_active is not None: + + _query_params.append(('eFilterActive', e_filter_active)) + + if s_query is not None: + + _query_params.append(('sQuery', s_query)) + + # process the header parameters + if accept_language is not None: + _header_params['Accept-Language'] = accept_language + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/2/object/ezsignsigningreason/getAutocomplete/{sSelector}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def ezsignsigningreason_get_list_v1( + self, + e_order_by: Annotated[Optional[StrictStr], Field(description="Specify how you want the results to be sorted")] = None, + i_row_max: Optional[Annotated[int, Field(le=10000, strict=True, ge=1)]] = None, + i_row_offset: Optional[Annotated[int, Field(strict=True, ge=0)]] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + s_filter: Optional[StrictStr] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsignsigningreasonGetListV1Response: + """Retrieve Ezsignsigningreason list + + + + :param e_order_by: Specify how you want the results to be sorted + :type e_order_by: str + :param i_row_max: + :type i_row_max: int + :param i_row_offset: + :type i_row_offset: int + :param accept_language: + :type accept_language: HeaderAcceptLanguage + :param s_filter: + :type s_filter: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignsigningreason_get_list_v1_serialize( + e_order_by=e_order_by, + i_row_max=i_row_max, + i_row_offset=i_row_offset, + accept_language=accept_language, + s_filter=s_filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignsigningreasonGetListV1Response", + '406': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsignsigningreason_get_list_v1_with_http_info( + self, + e_order_by: Annotated[Optional[StrictStr], Field(description="Specify how you want the results to be sorted")] = None, + i_row_max: Optional[Annotated[int, Field(le=10000, strict=True, ge=1)]] = None, + i_row_offset: Optional[Annotated[int, Field(strict=True, ge=0)]] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + s_filter: Optional[StrictStr] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsignsigningreasonGetListV1Response]: + """Retrieve Ezsignsigningreason list + + + + :param e_order_by: Specify how you want the results to be sorted + :type e_order_by: str + :param i_row_max: + :type i_row_max: int + :param i_row_offset: + :type i_row_offset: int + :param accept_language: + :type accept_language: HeaderAcceptLanguage + :param s_filter: + :type s_filter: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignsigningreason_get_list_v1_serialize( + e_order_by=e_order_by, + i_row_max=i_row_max, + i_row_offset=i_row_offset, + accept_language=accept_language, + s_filter=s_filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignsigningreasonGetListV1Response", + '406': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def ezsignsigningreason_get_list_v1_without_preload_content( + self, + e_order_by: Annotated[Optional[StrictStr], Field(description="Specify how you want the results to be sorted")] = None, + i_row_max: Optional[Annotated[int, Field(le=10000, strict=True, ge=1)]] = None, + i_row_offset: Optional[Annotated[int, Field(strict=True, ge=0)]] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + s_filter: Optional[StrictStr] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve Ezsignsigningreason list + + + + :param e_order_by: Specify how you want the results to be sorted + :type e_order_by: str + :param i_row_max: + :type i_row_max: int + :param i_row_offset: + :type i_row_offset: int + :param accept_language: + :type accept_language: HeaderAcceptLanguage + :param s_filter: + :type s_filter: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignsigningreason_get_list_v1_serialize( + e_order_by=e_order_by, + i_row_max=i_row_max, + i_row_offset=i_row_offset, + accept_language=accept_language, + s_filter=s_filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignsigningreasonGetListV1Response", + '406': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _ezsignsigningreason_get_list_v1_serialize( + self, + e_order_by, + i_row_max, + i_row_offset, + accept_language, + s_filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if e_order_by is not None: + + _query_params.append(('eOrderBy', e_order_by)) + + if i_row_max is not None: + + _query_params.append(('iRowMax', i_row_max)) + + if i_row_offset is not None: + + _query_params.append(('iRowOffset', i_row_offset)) + + if s_filter is not None: + + _query_params.append(('sFilter', s_filter)) + + # process the header parameters + if accept_language is not None: + _header_params['Accept-Language'] = accept_language + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json', + 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/1/object/ezsignsigningreason/getList', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def ezsignsigningreason_get_object_v2( + self, + pki_ezsignsigningreason_id: Annotated[int, Field(le=255, strict=True, ge=0, description="The unique ID of the Ezsignsigningreason")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsignsigningreasonGetObjectV2Response: + """Retrieve an existing Ezsignsigningreason + + + + :param pki_ezsignsigningreason_id: The unique ID of the Ezsignsigningreason (required) + :type pki_ezsignsigningreason_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignsigningreason_get_object_v2_serialize( + pki_ezsignsigningreason_id=pki_ezsignsigningreason_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignsigningreasonGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsignsigningreason_get_object_v2_with_http_info( + self, + pki_ezsignsigningreason_id: Annotated[int, Field(le=255, strict=True, ge=0, description="The unique ID of the Ezsignsigningreason")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsignsigningreasonGetObjectV2Response]: + """Retrieve an existing Ezsignsigningreason + + + + :param pki_ezsignsigningreason_id: The unique ID of the Ezsignsigningreason (required) + :type pki_ezsignsigningreason_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignsigningreason_get_object_v2_serialize( + pki_ezsignsigningreason_id=pki_ezsignsigningreason_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignsigningreasonGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def ezsignsigningreason_get_object_v2_without_preload_content( + self, + pki_ezsignsigningreason_id: Annotated[int, Field(le=255, strict=True, ge=0, description="The unique ID of the Ezsignsigningreason")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve an existing Ezsignsigningreason + + + + :param pki_ezsignsigningreason_id: The unique ID of the Ezsignsigningreason (required) + :type pki_ezsignsigningreason_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsignsigningreason_get_object_v2_serialize( + pki_ezsignsigningreason_id=pki_ezsignsigningreason_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsignsigningreasonGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _ezsignsigningreason_get_object_v2_serialize( + self, + pki_ezsignsigningreason_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_ezsignsigningreason_id is not None: + _path_params['pkiEzsignsigningreasonID'] = pki_ezsignsigningreason_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/2/object/ezsignsigningreason/{pkiEzsignsigningreasonID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/eZmaxApi/api/object_ezsigntemplate_api.py b/eZmaxApi/api/object_ezsigntemplate_api.py index fa0ecbe8a..43847d0e1 100644 --- a/eZmaxApi/api/object_ezsigntemplate_api.py +++ b/eZmaxApi/api/object_ezsigntemplate_api.py @@ -13,14 +13,20 @@ """ # noqa: E501 -import re # noqa: F401 import io import warnings -from pydantic import validate_arguments, ValidationError +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Dict, List, Optional, Tuple, Union, Any +try: + from typing import Annotated +except ImportError: + from typing_extensions import Annotated + +from pydantic import Field from typing_extensions import Annotated -from pydantic import Field, StrictStr, conint +from pydantic import StrictStr, field_validator from typing import Optional @@ -39,10 +45,7 @@ from eZmaxApi.api_client import ApiClient from eZmaxApi.api_response import ApiResponse -from eZmaxApi.exceptions import ( # noqa: F401 - ApiTypeError, - ApiValueError -) +from eZmaxApi.rest import RESTResponseType class ObjectEzsigntemplateApi: @@ -57,617 +60,1143 @@ def __init__(self, api_client=None) -> None: api_client = ApiClient.get_default() self.api_client = api_client - @validate_arguments - def ezsigntemplate_copy_v1(self, pki_ezsigntemplate_id : conint(strict=True, ge=0), ezsigntemplate_copy_v1_request : EzsigntemplateCopyV1Request, **kwargs) -> EzsigntemplateCopyV1Response: # noqa: E501 - """Copy the Ezsigntemplate # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def ezsigntemplate_copy_v1( + self, + pki_ezsigntemplate_id: Annotated[int, Field(strict=True, ge=0)], + ezsigntemplate_copy_v1_request: EzsigntemplateCopyV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsigntemplateCopyV1Response: + """Copy the Ezsigntemplate - >>> thread = api.ezsigntemplate_copy_v1(pki_ezsigntemplate_id, ezsigntemplate_copy_v1_request, async_req=True) - >>> result = thread.get() + :param pki_ezsigntemplate_id: (required) :type pki_ezsigntemplate_id: int :param ezsigntemplate_copy_v1_request: (required) :type ezsigntemplate_copy_v1_request: EzsigntemplateCopyV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsigntemplateCopyV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsigntemplate_copy_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsigntemplate_copy_v1_with_http_info(pki_ezsigntemplate_id, ezsigntemplate_copy_v1_request, **kwargs) # noqa: E501 - - @validate_arguments - def ezsigntemplate_copy_v1_with_http_info(self, pki_ezsigntemplate_id : conint(strict=True, ge=0), ezsigntemplate_copy_v1_request : EzsigntemplateCopyV1Request, **kwargs) -> ApiResponse: # noqa: E501 - """Copy the Ezsigntemplate # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsigntemplate_copy_v1_with_http_info(pki_ezsigntemplate_id, ezsigntemplate_copy_v1_request, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._ezsigntemplate_copy_v1_serialize( + pki_ezsigntemplate_id=pki_ezsigntemplate_id, + ezsigntemplate_copy_v1_request=ezsigntemplate_copy_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "EzsigntemplateCopyV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsigntemplate_copy_v1_with_http_info( + self, + pki_ezsigntemplate_id: Annotated[int, Field(strict=True, ge=0)], + ezsigntemplate_copy_v1_request: EzsigntemplateCopyV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsigntemplateCopyV1Response]: + """Copy the Ezsigntemplate + + :param pki_ezsigntemplate_id: (required) :type pki_ezsigntemplate_id: int :param ezsigntemplate_copy_v1_request: (required) :type ezsigntemplate_copy_v1_request: EzsigntemplateCopyV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsigntemplateCopyV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._ezsigntemplate_copy_v1_serialize( + pki_ezsigntemplate_id=pki_ezsigntemplate_id, + ezsigntemplate_copy_v1_request=ezsigntemplate_copy_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "EzsigntemplateCopyV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _params = locals() - _all_params = [ - 'pki_ezsigntemplate_id', - 'ezsigntemplate_copy_v1_request' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + @validate_call + def ezsigntemplate_copy_v1_without_preload_content( + self, + pki_ezsigntemplate_id: Annotated[int, Field(strict=True, ge=0)], + ezsigntemplate_copy_v1_request: EzsigntemplateCopyV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Copy the Ezsigntemplate + + + + :param pki_ezsigntemplate_id: (required) + :type pki_ezsigntemplate_id: int + :param ezsigntemplate_copy_v1_request: (required) + :type ezsigntemplate_copy_v1_request: EzsigntemplateCopyV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsigntemplate_copy_v1_serialize( + pki_ezsigntemplate_id=pki_ezsigntemplate_id, + ezsigntemplate_copy_v1_request=ezsigntemplate_copy_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsigntemplate_copy_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '201': "EzsigntemplateCopyV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_ezsigntemplate_id']: - _path_params['pkiEzsigntemplateID'] = _params['pki_ezsigntemplate_id'] + def _ezsigntemplate_copy_v1_serialize( + self, + pki_ezsigntemplate_id, + ezsigntemplate_copy_v1_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if pki_ezsigntemplate_id is not None: + _path_params['pkiEzsigntemplateID'] = pki_ezsigntemplate_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['ezsigntemplate_copy_v1_request'] is not None: - _body_params = _params['ezsigntemplate_copy_v1_request'] + if ezsigntemplate_copy_v1_request is not None: + _body_params = ezsigntemplate_copy_v1_request + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '201': "EzsigntemplateCopyV1Response", - '404': "CommonResponseError", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsigntemplate/{pkiEzsigntemplateID}/copy', 'POST', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='POST', + resource_path='/1/object/ezsigntemplate/{pkiEzsigntemplateID}/copy', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + - @validate_arguments - def ezsigntemplate_create_object_v1(self, ezsigntemplate_create_object_v1_request : EzsigntemplateCreateObjectV1Request, **kwargs) -> EzsigntemplateCreateObjectV1Response: # noqa: E501 - """Create a new Ezsigntemplate # noqa: E501 - The endpoint allows to create one or many elements at once. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def ezsigntemplate_create_object_v1( + self, + ezsigntemplate_create_object_v1_request: EzsigntemplateCreateObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsigntemplateCreateObjectV1Response: + """Create a new Ezsigntemplate - >>> thread = api.ezsigntemplate_create_object_v1(ezsigntemplate_create_object_v1_request, async_req=True) - >>> result = thread.get() + The endpoint allows to create one or many elements at once. :param ezsigntemplate_create_object_v1_request: (required) :type ezsigntemplate_create_object_v1_request: EzsigntemplateCreateObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsigntemplateCreateObjectV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsigntemplate_create_object_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsigntemplate_create_object_v1_with_http_info(ezsigntemplate_create_object_v1_request, **kwargs) # noqa: E501 - - @validate_arguments - def ezsigntemplate_create_object_v1_with_http_info(self, ezsigntemplate_create_object_v1_request : EzsigntemplateCreateObjectV1Request, **kwargs) -> ApiResponse: # noqa: E501 - """Create a new Ezsigntemplate # noqa: E501 - - The endpoint allows to create one or many elements at once. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsigntemplate_create_object_v1_with_http_info(ezsigntemplate_create_object_v1_request, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._ezsigntemplate_create_object_v1_serialize( + ezsigntemplate_create_object_v1_request=ezsigntemplate_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "EzsigntemplateCreateObjectV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsigntemplate_create_object_v1_with_http_info( + self, + ezsigntemplate_create_object_v1_request: EzsigntemplateCreateObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsigntemplateCreateObjectV1Response]: + """Create a new Ezsigntemplate + + The endpoint allows to create one or many elements at once. :param ezsigntemplate_create_object_v1_request: (required) :type ezsigntemplate_create_object_v1_request: EzsigntemplateCreateObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsigntemplateCreateObjectV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._ezsigntemplate_create_object_v1_serialize( + ezsigntemplate_create_object_v1_request=ezsigntemplate_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '201': "EzsigntemplateCreateObjectV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'ezsigntemplate_create_object_v1_request' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def ezsigntemplate_create_object_v1_without_preload_content( + self, + ezsigntemplate_create_object_v1_request: EzsigntemplateCreateObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Create a new Ezsigntemplate + + The endpoint allows to create one or many elements at once. + + :param ezsigntemplate_create_object_v1_request: (required) + :type ezsigntemplate_create_object_v1_request: EzsigntemplateCreateObjectV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsigntemplate_create_object_v1_serialize( + ezsigntemplate_create_object_v1_request=ezsigntemplate_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsigntemplate_create_object_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '201': "EzsigntemplateCreateObjectV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} + def _ezsigntemplate_create_object_v1_serialize( + self, + ezsigntemplate_create_object_v1_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['ezsigntemplate_create_object_v1_request'] is not None: - _body_params = _params['ezsigntemplate_create_object_v1_request'] + if ezsigntemplate_create_object_v1_request is not None: + _body_params = ezsigntemplate_create_object_v1_request + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '201': "EzsigntemplateCreateObjectV1Response", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsigntemplate', 'POST', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='POST', + resource_path='/1/object/ezsigntemplate', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) - @validate_arguments - def ezsigntemplate_delete_object_v1(self, pki_ezsigntemplate_id : conint(strict=True, ge=0), **kwargs) -> EzsigntemplateDeleteObjectV1Response: # noqa: E501 - """Delete an existing Ezsigntemplate # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.ezsigntemplate_delete_object_v1(pki_ezsigntemplate_id, async_req=True) - >>> result = thread.get() + + @validate_call + def ezsigntemplate_delete_object_v1( + self, + pki_ezsigntemplate_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsigntemplateDeleteObjectV1Response: + """Delete an existing Ezsigntemplate + + :param pki_ezsigntemplate_id: (required) :type pki_ezsigntemplate_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsigntemplateDeleteObjectV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsigntemplate_delete_object_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsigntemplate_delete_object_v1_with_http_info(pki_ezsigntemplate_id, **kwargs) # noqa: E501 - - @validate_arguments - def ezsigntemplate_delete_object_v1_with_http_info(self, pki_ezsigntemplate_id : conint(strict=True, ge=0), **kwargs) -> ApiResponse: # noqa: E501 - """Delete an existing Ezsigntemplate # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsigntemplate_delete_object_v1_with_http_info(pki_ezsigntemplate_id, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._ezsigntemplate_delete_object_v1_serialize( + pki_ezsigntemplate_id=pki_ezsigntemplate_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplateDeleteObjectV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsigntemplate_delete_object_v1_with_http_info( + self, + pki_ezsigntemplate_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsigntemplateDeleteObjectV1Response]: + """Delete an existing Ezsigntemplate + + :param pki_ezsigntemplate_id: (required) :type pki_ezsigntemplate_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsigntemplateDeleteObjectV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._ezsigntemplate_delete_object_v1_serialize( + pki_ezsigntemplate_id=pki_ezsigntemplate_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplateDeleteObjectV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _params = locals() - _all_params = [ - 'pki_ezsigntemplate_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + @validate_call + def ezsigntemplate_delete_object_v1_without_preload_content( + self, + pki_ezsigntemplate_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete an existing Ezsigntemplate + + + + :param pki_ezsigntemplate_id: (required) + :type pki_ezsigntemplate_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsigntemplate_delete_object_v1_serialize( + pki_ezsigntemplate_id=pki_ezsigntemplate_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsigntemplate_delete_object_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplateDeleteObjectV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_ezsigntemplate_id']: - _path_params['pkiEzsigntemplateID'] = _params['pki_ezsigntemplate_id'] + def _ezsigntemplate_delete_object_v1_serialize( + self, + pki_ezsigntemplate_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if pki_ezsigntemplate_id is not None: + _path_params['pkiEzsigntemplateID'] = pki_ezsigntemplate_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "EzsigntemplateDeleteObjectV1Response", - '404': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsigntemplate/{pkiEzsigntemplateID}', 'DELETE', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='DELETE', + resource_path='/1/object/ezsigntemplate/{pkiEzsigntemplateID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + - @validate_arguments - def ezsigntemplate_edit_object_v1(self, pki_ezsigntemplate_id : conint(strict=True, ge=0), ezsigntemplate_edit_object_v1_request : EzsigntemplateEditObjectV1Request, **kwargs) -> EzsigntemplateEditObjectV1Response: # noqa: E501 - """Edit an existing Ezsigntemplate # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def ezsigntemplate_edit_object_v1( + self, + pki_ezsigntemplate_id: Annotated[int, Field(strict=True, ge=0)], + ezsigntemplate_edit_object_v1_request: EzsigntemplateEditObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsigntemplateEditObjectV1Response: + """Edit an existing Ezsigntemplate - >>> thread = api.ezsigntemplate_edit_object_v1(pki_ezsigntemplate_id, ezsigntemplate_edit_object_v1_request, async_req=True) - >>> result = thread.get() + :param pki_ezsigntemplate_id: (required) :type pki_ezsigntemplate_id: int :param ezsigntemplate_edit_object_v1_request: (required) :type ezsigntemplate_edit_object_v1_request: EzsigntemplateEditObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsigntemplateEditObjectV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsigntemplate_edit_object_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsigntemplate_edit_object_v1_with_http_info(pki_ezsigntemplate_id, ezsigntemplate_edit_object_v1_request, **kwargs) # noqa: E501 - - @validate_arguments - def ezsigntemplate_edit_object_v1_with_http_info(self, pki_ezsigntemplate_id : conint(strict=True, ge=0), ezsigntemplate_edit_object_v1_request : EzsigntemplateEditObjectV1Request, **kwargs) -> ApiResponse: # noqa: E501 - """Edit an existing Ezsigntemplate # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsigntemplate_edit_object_v1_with_http_info(pki_ezsigntemplate_id, ezsigntemplate_edit_object_v1_request, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._ezsigntemplate_edit_object_v1_serialize( + pki_ezsigntemplate_id=pki_ezsigntemplate_id, + ezsigntemplate_edit_object_v1_request=ezsigntemplate_edit_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplateEditObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsigntemplate_edit_object_v1_with_http_info( + self, + pki_ezsigntemplate_id: Annotated[int, Field(strict=True, ge=0)], + ezsigntemplate_edit_object_v1_request: EzsigntemplateEditObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsigntemplateEditObjectV1Response]: + """Edit an existing Ezsigntemplate + + :param pki_ezsigntemplate_id: (required) :type pki_ezsigntemplate_id: int :param ezsigntemplate_edit_object_v1_request: (required) :type ezsigntemplate_edit_object_v1_request: EzsigntemplateEditObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsigntemplateEditObjectV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._ezsigntemplate_edit_object_v1_serialize( + pki_ezsigntemplate_id=pki_ezsigntemplate_id, + ezsigntemplate_edit_object_v1_request=ezsigntemplate_edit_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplateEditObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _params = locals() - _all_params = [ - 'pki_ezsigntemplate_id', - 'ezsigntemplate_edit_object_v1_request' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + @validate_call + def ezsigntemplate_edit_object_v1_without_preload_content( + self, + pki_ezsigntemplate_id: Annotated[int, Field(strict=True, ge=0)], + ezsigntemplate_edit_object_v1_request: EzsigntemplateEditObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Edit an existing Ezsigntemplate + + + + :param pki_ezsigntemplate_id: (required) + :type pki_ezsigntemplate_id: int + :param ezsigntemplate_edit_object_v1_request: (required) + :type ezsigntemplate_edit_object_v1_request: EzsigntemplateEditObjectV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsigntemplate_edit_object_v1_serialize( + pki_ezsigntemplate_id=pki_ezsigntemplate_id, + ezsigntemplate_edit_object_v1_request=ezsigntemplate_edit_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsigntemplate_edit_object_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplateEditObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_ezsigntemplate_id']: - _path_params['pkiEzsigntemplateID'] = _params['pki_ezsigntemplate_id'] + def _ezsigntemplate_edit_object_v1_serialize( + self, + pki_ezsigntemplate_id, + ezsigntemplate_edit_object_v1_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_ezsigntemplate_id is not None: + _path_params['pkiEzsigntemplateID'] = pki_ezsigntemplate_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['ezsigntemplate_edit_object_v1_request'] is not None: - _body_params = _params['ezsigntemplate_edit_object_v1_request'] + if ezsigntemplate_edit_object_v1_request is not None: + _body_params = ezsigntemplate_edit_object_v1_request + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '200': "EzsigntemplateEditObjectV1Response", - '404': "CommonResponseError", - '422': "CommonResponseError", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsigntemplate/{pkiEzsigntemplateID}', 'PUT', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='PUT', + resource_path='/1/object/ezsigntemplate/{pkiEzsigntemplateID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + - @validate_arguments - def ezsigntemplate_get_autocomplete_v2(self, s_selector : Annotated[StrictStr, Field(..., description="The type of Ezsigntemplates to return")], e_filter_active : Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, s_query : Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, accept_language : Optional[HeaderAcceptLanguage] = None, **kwargs) -> EzsigntemplateGetAutocompleteV2Response: # noqa: E501 - """Retrieve Ezsigntemplates and IDs # noqa: E501 - Get the list of Ezsigntemplate to be used in a dropdown or autocomplete control. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.ezsigntemplate_get_autocomplete_v2(s_selector, e_filter_active, s_query, accept_language, async_req=True) - >>> result = thread.get() + @validate_call + def ezsigntemplate_get_autocomplete_v2( + self, + s_selector: Annotated[StrictStr, Field(description="The type of Ezsigntemplates to return")], + e_filter_active: Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, + s_query: Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsigntemplateGetAutocompleteV2Response: + """Retrieve Ezsigntemplates and IDs + + Get the list of Ezsigntemplate to be used in a dropdown or autocomplete control. :param s_selector: The type of Ezsigntemplates to return (required) :type s_selector: str @@ -677,161 +1206,305 @@ def ezsigntemplate_get_autocomplete_v2(self, s_selector : Annotated[StrictStr, F :type s_query: str :param accept_language: :type accept_language: HeaderAcceptLanguage - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsigntemplateGetAutocompleteV2Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsigntemplate_get_autocomplete_v2_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsigntemplate_get_autocomplete_v2_with_http_info(s_selector, e_filter_active, s_query, accept_language, **kwargs) # noqa: E501 - - @validate_arguments - def ezsigntemplate_get_autocomplete_v2_with_http_info(self, s_selector : Annotated[StrictStr, Field(..., description="The type of Ezsigntemplates to return")], e_filter_active : Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, s_query : Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, accept_language : Optional[HeaderAcceptLanguage] = None, **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve Ezsigntemplates and IDs # noqa: E501 - - Get the list of Ezsigntemplate to be used in a dropdown or autocomplete control. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsigntemplate_get_autocomplete_v2_with_http_info(s_selector, e_filter_active, s_query, accept_language, async_req=True) - >>> result = thread.get() - - :param s_selector: The type of Ezsigntemplates to return (required) - :type s_selector: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsigntemplate_get_autocomplete_v2_serialize( + s_selector=s_selector, + e_filter_active=e_filter_active, + s_query=s_query, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplateGetAutocompleteV2Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsigntemplate_get_autocomplete_v2_with_http_info( + self, + s_selector: Annotated[StrictStr, Field(description="The type of Ezsigntemplates to return")], + e_filter_active: Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, + s_query: Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsigntemplateGetAutocompleteV2Response]: + """Retrieve Ezsigntemplates and IDs + + Get the list of Ezsigntemplate to be used in a dropdown or autocomplete control. + + :param s_selector: The type of Ezsigntemplates to return (required) + :type s_selector: str :param e_filter_active: Specify which results we want to display. :type e_filter_active: str :param s_query: Allow to filter the returned results :type s_query: str :param accept_language: :type accept_language: HeaderAcceptLanguage - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsigntemplateGetAutocompleteV2Response, status_code(int), headers(HTTPHeaderDict)) - """ - - _params = locals() - - _all_params = [ - 's_selector', - 'e_filter_active', - 's_query', - 'accept_language' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + """ # noqa: E501 + + _param = self._ezsigntemplate_get_autocomplete_v2_serialize( + s_selector=s_selector, + e_filter_active=e_filter_active, + s_query=s_query, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplateGetAutocompleteV2Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def ezsigntemplate_get_autocomplete_v2_without_preload_content( + self, + s_selector: Annotated[StrictStr, Field(description="The type of Ezsigntemplates to return")], + e_filter_active: Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, + s_query: Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve Ezsigntemplates and IDs + + Get the list of Ezsigntemplate to be used in a dropdown or autocomplete control. + + :param s_selector: The type of Ezsigntemplates to return (required) + :type s_selector: str + :param e_filter_active: Specify which results we want to display. + :type e_filter_active: str + :param s_query: Allow to filter the returned results + :type s_query: str + :param accept_language: + :type accept_language: HeaderAcceptLanguage + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsigntemplate_get_autocomplete_v2_serialize( + s_selector=s_selector, + e_filter_active=e_filter_active, + s_query=s_query, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsigntemplate_get_autocomplete_v2" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplateGetAutocompleteV2Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['s_selector']: - _path_params['sSelector'] = _params['s_selector'] + def _ezsigntemplate_get_autocomplete_v2_serialize( + self, + s_selector, + e_filter_active, + s_query, + accept_language, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None - # process the query parameters - _query_params = [] - if _params.get('e_filter_active') is not None: # noqa: E501 - _query_params.append(('eFilterActive', _params['e_filter_active'])) + _collection_formats: Dict[str, str] = { + } - if _params.get('s_query') is not None: # noqa: E501 - _query_params.append(('sQuery', _params['s_query'])) + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if s_selector is not None: + _path_params['sSelector'] = s_selector + # process the query parameters + if e_filter_active is not None: + + _query_params.append(('eFilterActive', e_filter_active)) + + if s_query is not None: + + _query_params.append(('sQuery', s_query)) + # process the header parameters - _header_params = dict(_params.get('_headers', {})) - if _params['accept_language']: - _header_params['Accept-Language'] = _params['accept_language'] - + if accept_language is not None: + _header_params['Accept-Language'] = accept_language # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "EzsigntemplateGetAutocompleteV2Response", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/2/object/ezsigntemplate/getAutocomplete/{sSelector}', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/2/object/ezsigntemplate/getAutocomplete/{sSelector}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) - @validate_arguments - def ezsigntemplate_get_list_v1(self, e_order_by : Annotated[Optional[StrictStr], Field(description="Specify how you want the results to be sorted")] = None, i_row_max : Optional[conint(strict=True, le=10000, ge=1)] = None, i_row_offset : Optional[conint(strict=True, ge=0)] = None, accept_language : Optional[HeaderAcceptLanguage] = None, s_filter : Optional[StrictStr] = None, **kwargs) -> EzsigntemplateGetListV1Response: # noqa: E501 - """Retrieve Ezsigntemplate list # noqa: E501 - Enum values that can be filtered in query parameter *sFilter*: | Variable | Valid values | |---|---| | eEzsigntemplateType | Company
Team
User
Usergroup | # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.ezsigntemplate_get_list_v1(e_order_by, i_row_max, i_row_offset, accept_language, s_filter, async_req=True) - >>> result = thread.get() + + @validate_call + def ezsigntemplate_get_list_v1( + self, + e_order_by: Annotated[Optional[StrictStr], Field(description="Specify how you want the results to be sorted")] = None, + i_row_max: Optional[Annotated[int, Field(le=10000, strict=True, ge=1)]] = None, + i_row_offset: Optional[Annotated[int, Field(strict=True, ge=0)]] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + s_filter: Optional[StrictStr] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsigntemplateGetListV1Response: + """Retrieve Ezsigntemplate list + + Enum values that can be filtered in query parameter *sFilter*: | Variable | Valid values | |---|---| | eEzsigntemplateType | Company
Team
User
Usergroup | :param e_order_by: Specify how you want the results to be sorted :type e_order_by: str @@ -843,33 +1516,79 @@ def ezsigntemplate_get_list_v1(self, e_order_by : Annotated[Optional[StrictStr], :type accept_language: HeaderAcceptLanguage :param s_filter: :type s_filter: str - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsigntemplateGetListV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsigntemplate_get_list_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsigntemplate_get_list_v1_with_http_info(e_order_by, i_row_max, i_row_offset, accept_language, s_filter, **kwargs) # noqa: E501 - - @validate_arguments - def ezsigntemplate_get_list_v1_with_http_info(self, e_order_by : Annotated[Optional[StrictStr], Field(description="Specify how you want the results to be sorted")] = None, i_row_max : Optional[conint(strict=True, le=10000, ge=1)] = None, i_row_offset : Optional[conint(strict=True, ge=0)] = None, accept_language : Optional[HeaderAcceptLanguage] = None, s_filter : Optional[StrictStr] = None, **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve Ezsigntemplate list # noqa: E501 - - Enum values that can be filtered in query parameter *sFilter*: | Variable | Valid values | |---|---| | eEzsigntemplateType | Company
Team
User
Usergroup | # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsigntemplate_get_list_v1_with_http_info(e_order_by, i_row_max, i_row_offset, accept_language, s_filter, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._ezsigntemplate_get_list_v1_serialize( + e_order_by=e_order_by, + i_row_max=i_row_max, + i_row_offset=i_row_offset, + accept_language=accept_language, + s_filter=s_filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplateGetListV1Response", + '406': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsigntemplate_get_list_v1_with_http_info( + self, + e_order_by: Annotated[Optional[StrictStr], Field(description="Specify how you want the results to be sorted")] = None, + i_row_max: Optional[Annotated[int, Field(le=10000, strict=True, ge=1)]] = None, + i_row_offset: Optional[Annotated[int, Field(strict=True, ge=0)]] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + s_filter: Optional[StrictStr] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsigntemplateGetListV1Response]: + """Retrieve Ezsigntemplate list + + Enum values that can be filtered in query parameter *sFilter*: | Variable | Valid values | |---|---| | eEzsigntemplateType | Company
Team
User
Usergroup | :param e_order_by: Specify how you want the results to be sorted :type e_order_by: str @@ -881,400 +1600,737 @@ def ezsigntemplate_get_list_v1_with_http_info(self, e_order_by : Annotated[Optio :type accept_language: HeaderAcceptLanguage :param s_filter: :type s_filter: str - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsigntemplateGetListV1Response, status_code(int), headers(HTTPHeaderDict)) - """ - - _params = locals() - - _all_params = [ - 'e_order_by', - 'i_row_max', - 'i_row_offset', - 'accept_language', - 's_filter' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' - ] + """ # noqa: E501 + + _param = self._ezsigntemplate_get_list_v1_serialize( + e_order_by=e_order_by, + i_row_max=i_row_max, + i_row_offset=i_row_offset, + accept_language=accept_language, + s_filter=s_filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsigntemplate_get_list_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplateGetListV1Response", + '406': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _collection_formats = {} - # process the path parameters - _path_params = {} + @validate_call + def ezsigntemplate_get_list_v1_without_preload_content( + self, + e_order_by: Annotated[Optional[StrictStr], Field(description="Specify how you want the results to be sorted")] = None, + i_row_max: Optional[Annotated[int, Field(le=10000, strict=True, ge=1)]] = None, + i_row_offset: Optional[Annotated[int, Field(strict=True, ge=0)]] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + s_filter: Optional[StrictStr] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve Ezsigntemplate list - # process the query parameters - _query_params = [] - if _params.get('e_order_by') is not None: # noqa: E501 - _query_params.append(('eOrderBy', _params['e_order_by'])) + Enum values that can be filtered in query parameter *sFilter*: | Variable | Valid values | |---|---| | eEzsigntemplateType | Company
Team
User
Usergroup | + + :param e_order_by: Specify how you want the results to be sorted + :type e_order_by: str + :param i_row_max: + :type i_row_max: int + :param i_row_offset: + :type i_row_offset: int + :param accept_language: + :type accept_language: HeaderAcceptLanguage + :param s_filter: + :type s_filter: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsigntemplate_get_list_v1_serialize( + e_order_by=e_order_by, + i_row_max=i_row_max, + i_row_offset=i_row_offset, + accept_language=accept_language, + s_filter=s_filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplateGetListV1Response", + '406': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - if _params.get('i_row_max') is not None: # noqa: E501 - _query_params.append(('iRowMax', _params['i_row_max'])) - if _params.get('i_row_offset') is not None: # noqa: E501 - _query_params.append(('iRowOffset', _params['i_row_offset'])) + def _ezsigntemplate_get_list_v1_serialize( + self, + e_order_by, + i_row_max, + i_row_offset, + accept_language, + s_filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: - if _params.get('s_filter') is not None: # noqa: E501 - _query_params.append(('sFilter', _params['s_filter'])) + _host = None - # process the header parameters - _header_params = dict(_params.get('_headers', {})) - if _params['accept_language']: - _header_params['Accept-Language'] = _params['accept_language'] + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if e_order_by is not None: + + _query_params.append(('eOrderBy', e_order_by)) + + if i_row_max is not None: + + _query_params.append(('iRowMax', i_row_max)) + + if i_row_offset is not None: + + _query_params.append(('iRowOffset', i_row_offset)) + + if s_filter is not None: + + _query_params.append(('sFilter', s_filter)) + + # process the header parameters + if accept_language is not None: + _header_params['Accept-Language'] = accept_language # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet']) # noqa: E501 + [ + 'application/json', + 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "EzsigntemplateGetListV1Response", - '406': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsigntemplate/getList', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/1/object/ezsigntemplate/getList', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) - @validate_arguments - def ezsigntemplate_get_object_v1(self, pki_ezsigntemplate_id : conint(strict=True, ge=0), **kwargs) -> EzsigntemplateGetObjectV1Response: # noqa: E501 - """(Deprecated) Retrieve an existing Ezsigntemplate # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.ezsigntemplate_get_object_v1(pki_ezsigntemplate_id, async_req=True) - >>> result = thread.get() + + @validate_call + def ezsigntemplate_get_object_v1( + self, + pki_ezsigntemplate_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsigntemplateGetObjectV1Response: + """(Deprecated) Retrieve an existing Ezsigntemplate + + :param pki_ezsigntemplate_id: (required) :type pki_ezsigntemplate_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsigntemplateGetObjectV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsigntemplate_get_object_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsigntemplate_get_object_v1_with_http_info(pki_ezsigntemplate_id, **kwargs) # noqa: E501 - - @validate_arguments - def ezsigntemplate_get_object_v1_with_http_info(self, pki_ezsigntemplate_id : conint(strict=True, ge=0), **kwargs) -> ApiResponse: # noqa: E501 - """(Deprecated) Retrieve an existing Ezsigntemplate # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsigntemplate_get_object_v1_with_http_info(pki_ezsigntemplate_id, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + warnings.warn("GET /1/object/ezsigntemplate/{pkiEzsigntemplateID} is deprecated.", DeprecationWarning) + + _param = self._ezsigntemplate_get_object_v1_serialize( + pki_ezsigntemplate_id=pki_ezsigntemplate_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplateGetObjectV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsigntemplate_get_object_v1_with_http_info( + self, + pki_ezsigntemplate_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsigntemplateGetObjectV1Response]: + """(Deprecated) Retrieve an existing Ezsigntemplate + + :param pki_ezsigntemplate_id: (required) :type pki_ezsigntemplate_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsigntemplateGetObjectV1Response, status_code(int), headers(HTTPHeaderDict)) - """ - + """ # noqa: E501 warnings.warn("GET /1/object/ezsigntemplate/{pkiEzsigntemplateID} is deprecated.", DeprecationWarning) - _params = locals() + _param = self._ezsigntemplate_get_object_v1_serialize( + pki_ezsigntemplate_id=pki_ezsigntemplate_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _all_params = [ - 'pki_ezsigntemplate_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplateGetObjectV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def ezsigntemplate_get_object_v1_without_preload_content( + self, + pki_ezsigntemplate_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """(Deprecated) Retrieve an existing Ezsigntemplate + + + + :param pki_ezsigntemplate_id: (required) + :type pki_ezsigntemplate_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + warnings.warn("GET /1/object/ezsigntemplate/{pkiEzsigntemplateID} is deprecated.", DeprecationWarning) + + _param = self._ezsigntemplate_get_object_v1_serialize( + pki_ezsigntemplate_id=pki_ezsigntemplate_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsigntemplate_get_object_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplateGetObjectV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_ezsigntemplate_id']: - _path_params['pkiEzsigntemplateID'] = _params['pki_ezsigntemplate_id'] + def _ezsigntemplate_get_object_v1_serialize( + self, + pki_ezsigntemplate_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_ezsigntemplate_id is not None: + _path_params['pkiEzsigntemplateID'] = pki_ezsigntemplate_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "EzsigntemplateGetObjectV1Response", - '404': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsigntemplate/{pkiEzsigntemplateID}', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/1/object/ezsigntemplate/{pkiEzsigntemplateID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) - @validate_arguments - def ezsigntemplate_get_object_v2(self, pki_ezsigntemplate_id : conint(strict=True, ge=0), **kwargs) -> EzsigntemplateGetObjectV2Response: # noqa: E501 - """Retrieve an existing Ezsigntemplate # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.ezsigntemplate_get_object_v2(pki_ezsigntemplate_id, async_req=True) - >>> result = thread.get() + + @validate_call + def ezsigntemplate_get_object_v2( + self, + pki_ezsigntemplate_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsigntemplateGetObjectV2Response: + """Retrieve an existing Ezsigntemplate + + :param pki_ezsigntemplate_id: (required) :type pki_ezsigntemplate_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsigntemplateGetObjectV2Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsigntemplate_get_object_v2_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsigntemplate_get_object_v2_with_http_info(pki_ezsigntemplate_id, **kwargs) # noqa: E501 - - @validate_arguments - def ezsigntemplate_get_object_v2_with_http_info(self, pki_ezsigntemplate_id : conint(strict=True, ge=0), **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve an existing Ezsigntemplate # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsigntemplate_get_object_v2_with_http_info(pki_ezsigntemplate_id, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._ezsigntemplate_get_object_v2_serialize( + pki_ezsigntemplate_id=pki_ezsigntemplate_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplateGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsigntemplate_get_object_v2_with_http_info( + self, + pki_ezsigntemplate_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsigntemplateGetObjectV2Response]: + """Retrieve an existing Ezsigntemplate + + :param pki_ezsigntemplate_id: (required) :type pki_ezsigntemplate_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsigntemplateGetObjectV2Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._ezsigntemplate_get_object_v2_serialize( + pki_ezsigntemplate_id=pki_ezsigntemplate_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplateGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'pki_ezsigntemplate_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def ezsigntemplate_get_object_v2_without_preload_content( + self, + pki_ezsigntemplate_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve an existing Ezsigntemplate + + + + :param pki_ezsigntemplate_id: (required) + :type pki_ezsigntemplate_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsigntemplate_get_object_v2_serialize( + pki_ezsigntemplate_id=pki_ezsigntemplate_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsigntemplate_get_object_v2" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplateGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_ezsigntemplate_id']: - _path_params['pkiEzsigntemplateID'] = _params['pki_ezsigntemplate_id'] + def _ezsigntemplate_get_object_v2_serialize( + self, + pki_ezsigntemplate_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if pki_ezsigntemplate_id is not None: + _path_params['pkiEzsigntemplateID'] = pki_ezsigntemplate_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "EzsigntemplateGetObjectV2Response", - '404': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/2/object/ezsigntemplate/{pkiEzsigntemplateID}', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/2/object/ezsigntemplate/{pkiEzsigntemplateID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/eZmaxApi/api/object_ezsigntemplatedocument_api.py b/eZmaxApi/api/object_ezsigntemplatedocument_api.py index e2a92e9b1..b9b60c916 100644 --- a/eZmaxApi/api/object_ezsigntemplatedocument_api.py +++ b/eZmaxApi/api/object_ezsigntemplatedocument_api.py @@ -13,14 +13,19 @@ """ # noqa: E501 -import re # noqa: F401 import io import warnings -from pydantic import validate_arguments, ValidationError +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Dict, List, Optional, Tuple, Union, Any -from pydantic import conint +try: + from typing import Annotated +except ImportError: + from typing_extensions import Annotated +from pydantic import Field +from typing_extensions import Annotated from typing import Any, Dict from eZmaxApi.models.ezsigntemplatedocument_create_object_v1_request import EzsigntemplatedocumentCreateObjectV1Request @@ -43,10 +48,7 @@ from eZmaxApi.api_client import ApiClient from eZmaxApi.api_response import ApiResponse -from eZmaxApi.exceptions import ( # noqa: F401 - ApiTypeError, - ApiValueError -) +from eZmaxApi.rest import RESTResponseType class ObjectEzsigntemplatedocumentApi: @@ -61,1656 +63,3072 @@ def __init__(self, api_client=None) -> None: api_client = ApiClient.get_default() self.api_client = api_client - @validate_arguments - def ezsigntemplatedocument_create_object_v1(self, ezsigntemplatedocument_create_object_v1_request : EzsigntemplatedocumentCreateObjectV1Request, **kwargs) -> EzsigntemplatedocumentCreateObjectV1Response: # noqa: E501 - """Create a new Ezsigntemplatedocument # noqa: E501 - The endpoint allows to create one or many elements at once. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def ezsigntemplatedocument_create_object_v1( + self, + ezsigntemplatedocument_create_object_v1_request: EzsigntemplatedocumentCreateObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsigntemplatedocumentCreateObjectV1Response: + """Create a new Ezsigntemplatedocument - >>> thread = api.ezsigntemplatedocument_create_object_v1(ezsigntemplatedocument_create_object_v1_request, async_req=True) - >>> result = thread.get() + The endpoint allows to create one or many elements at once. :param ezsigntemplatedocument_create_object_v1_request: (required) :type ezsigntemplatedocument_create_object_v1_request: EzsigntemplatedocumentCreateObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsigntemplatedocumentCreateObjectV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsigntemplatedocument_create_object_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsigntemplatedocument_create_object_v1_with_http_info(ezsigntemplatedocument_create_object_v1_request, **kwargs) # noqa: E501 - - @validate_arguments - def ezsigntemplatedocument_create_object_v1_with_http_info(self, ezsigntemplatedocument_create_object_v1_request : EzsigntemplatedocumentCreateObjectV1Request, **kwargs) -> ApiResponse: # noqa: E501 - """Create a new Ezsigntemplatedocument # noqa: E501 - - The endpoint allows to create one or many elements at once. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsigntemplatedocument_create_object_v1_with_http_info(ezsigntemplatedocument_create_object_v1_request, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._ezsigntemplatedocument_create_object_v1_serialize( + ezsigntemplatedocument_create_object_v1_request=ezsigntemplatedocument_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "EzsigntemplatedocumentCreateObjectV1Response", + '422': "CommonResponseErrorSTemporaryFileUrl", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsigntemplatedocument_create_object_v1_with_http_info( + self, + ezsigntemplatedocument_create_object_v1_request: EzsigntemplatedocumentCreateObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsigntemplatedocumentCreateObjectV1Response]: + """Create a new Ezsigntemplatedocument + + The endpoint allows to create one or many elements at once. :param ezsigntemplatedocument_create_object_v1_request: (required) :type ezsigntemplatedocument_create_object_v1_request: EzsigntemplatedocumentCreateObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsigntemplatedocumentCreateObjectV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._ezsigntemplatedocument_create_object_v1_serialize( + ezsigntemplatedocument_create_object_v1_request=ezsigntemplatedocument_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '201': "EzsigntemplatedocumentCreateObjectV1Response", + '422': "CommonResponseErrorSTemporaryFileUrl", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'ezsigntemplatedocument_create_object_v1_request' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def ezsigntemplatedocument_create_object_v1_without_preload_content( + self, + ezsigntemplatedocument_create_object_v1_request: EzsigntemplatedocumentCreateObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Create a new Ezsigntemplatedocument + + The endpoint allows to create one or many elements at once. + + :param ezsigntemplatedocument_create_object_v1_request: (required) + :type ezsigntemplatedocument_create_object_v1_request: EzsigntemplatedocumentCreateObjectV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsigntemplatedocument_create_object_v1_serialize( + ezsigntemplatedocument_create_object_v1_request=ezsigntemplatedocument_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsigntemplatedocument_create_object_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '201': "EzsigntemplatedocumentCreateObjectV1Response", + '422': "CommonResponseErrorSTemporaryFileUrl", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} + def _ezsigntemplatedocument_create_object_v1_serialize( + self, + ezsigntemplatedocument_create_object_v1_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['ezsigntemplatedocument_create_object_v1_request'] is not None: - _body_params = _params['ezsigntemplatedocument_create_object_v1_request'] + if ezsigntemplatedocument_create_object_v1_request is not None: + _body_params = ezsigntemplatedocument_create_object_v1_request + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '201': "EzsigntemplatedocumentCreateObjectV1Response", - '422': "CommonResponseErrorSTemporaryFileUrl", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsigntemplatedocument', 'POST', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='POST', + resource_path='/1/object/ezsigntemplatedocument', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) - @validate_arguments - def ezsigntemplatedocument_edit_ezsigntemplateformfieldgroups_v1(self, pki_ezsigntemplatedocument_id : conint(strict=True, ge=0), ezsigntemplatedocument_edit_ezsigntemplateformfieldgroups_v1_request : EzsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1Request, **kwargs) -> EzsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1Response: # noqa: E501 - """Edit multiple Ezsigntemplateformfieldgroups # noqa: E501 - Using this endpoint, you can edit multiple Ezsigntemplateformfieldgroups at the same time. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.ezsigntemplatedocument_edit_ezsigntemplateformfieldgroups_v1(pki_ezsigntemplatedocument_id, ezsigntemplatedocument_edit_ezsigntemplateformfieldgroups_v1_request, async_req=True) - >>> result = thread.get() + + @validate_call + def ezsigntemplatedocument_edit_ezsigntemplateformfieldgroups_v1( + self, + pki_ezsigntemplatedocument_id: Annotated[int, Field(strict=True, ge=0)], + ezsigntemplatedocument_edit_ezsigntemplateformfieldgroups_v1_request: EzsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1Response: + """Edit multiple Ezsigntemplateformfieldgroups + + Using this endpoint, you can edit multiple Ezsigntemplateformfieldgroups at the same time. :param pki_ezsigntemplatedocument_id: (required) :type pki_ezsigntemplatedocument_id: int :param ezsigntemplatedocument_edit_ezsigntemplateformfieldgroups_v1_request: (required) :type ezsigntemplatedocument_edit_ezsigntemplateformfieldgroups_v1_request: EzsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsigntemplatedocument_edit_ezsigntemplateformfieldgroups_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsigntemplatedocument_edit_ezsigntemplateformfieldgroups_v1_with_http_info(pki_ezsigntemplatedocument_id, ezsigntemplatedocument_edit_ezsigntemplateformfieldgroups_v1_request, **kwargs) # noqa: E501 - - @validate_arguments - def ezsigntemplatedocument_edit_ezsigntemplateformfieldgroups_v1_with_http_info(self, pki_ezsigntemplatedocument_id : conint(strict=True, ge=0), ezsigntemplatedocument_edit_ezsigntemplateformfieldgroups_v1_request : EzsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1Request, **kwargs) -> ApiResponse: # noqa: E501 - """Edit multiple Ezsigntemplateformfieldgroups # noqa: E501 - - Using this endpoint, you can edit multiple Ezsigntemplateformfieldgroups at the same time. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsigntemplatedocument_edit_ezsigntemplateformfieldgroups_v1_with_http_info(pki_ezsigntemplatedocument_id, ezsigntemplatedocument_edit_ezsigntemplateformfieldgroups_v1_request, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._ezsigntemplatedocument_edit_ezsigntemplateformfieldgroups_v1_serialize( + pki_ezsigntemplatedocument_id=pki_ezsigntemplatedocument_id, + ezsigntemplatedocument_edit_ezsigntemplateformfieldgroups_v1_request=ezsigntemplatedocument_edit_ezsigntemplateformfieldgroups_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsigntemplatedocument_edit_ezsigntemplateformfieldgroups_v1_with_http_info( + self, + pki_ezsigntemplatedocument_id: Annotated[int, Field(strict=True, ge=0)], + ezsigntemplatedocument_edit_ezsigntemplateformfieldgroups_v1_request: EzsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1Response]: + """Edit multiple Ezsigntemplateformfieldgroups + + Using this endpoint, you can edit multiple Ezsigntemplateformfieldgroups at the same time. :param pki_ezsigntemplatedocument_id: (required) :type pki_ezsigntemplatedocument_id: int :param ezsigntemplatedocument_edit_ezsigntemplateformfieldgroups_v1_request: (required) :type ezsigntemplatedocument_edit_ezsigntemplateformfieldgroups_v1_request: EzsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._ezsigntemplatedocument_edit_ezsigntemplateformfieldgroups_v1_serialize( + pki_ezsigntemplatedocument_id=pki_ezsigntemplatedocument_id, + ezsigntemplatedocument_edit_ezsigntemplateformfieldgroups_v1_request=ezsigntemplatedocument_edit_ezsigntemplateformfieldgroups_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'pki_ezsigntemplatedocument_id', - 'ezsigntemplatedocument_edit_ezsigntemplateformfieldgroups_v1_request' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def ezsigntemplatedocument_edit_ezsigntemplateformfieldgroups_v1_without_preload_content( + self, + pki_ezsigntemplatedocument_id: Annotated[int, Field(strict=True, ge=0)], + ezsigntemplatedocument_edit_ezsigntemplateformfieldgroups_v1_request: EzsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Edit multiple Ezsigntemplateformfieldgroups + + Using this endpoint, you can edit multiple Ezsigntemplateformfieldgroups at the same time. + + :param pki_ezsigntemplatedocument_id: (required) + :type pki_ezsigntemplatedocument_id: int + :param ezsigntemplatedocument_edit_ezsigntemplateformfieldgroups_v1_request: (required) + :type ezsigntemplatedocument_edit_ezsigntemplateformfieldgroups_v1_request: EzsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsigntemplatedocument_edit_ezsigntemplateformfieldgroups_v1_serialize( + pki_ezsigntemplatedocument_id=pki_ezsigntemplatedocument_id, + ezsigntemplatedocument_edit_ezsigntemplateformfieldgroups_v1_request=ezsigntemplatedocument_edit_ezsigntemplateformfieldgroups_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsigntemplatedocument_edit_ezsigntemplateformfieldgroups_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_ezsigntemplatedocument_id']: - _path_params['pkiEzsigntemplatedocumentID'] = _params['pki_ezsigntemplatedocument_id'] + def _ezsigntemplatedocument_edit_ezsigntemplateformfieldgroups_v1_serialize( + self, + pki_ezsigntemplatedocument_id, + ezsigntemplatedocument_edit_ezsigntemplateformfieldgroups_v1_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if pki_ezsigntemplatedocument_id is not None: + _path_params['pkiEzsigntemplatedocumentID'] = pki_ezsigntemplatedocument_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['ezsigntemplatedocument_edit_ezsigntemplateformfieldgroups_v1_request'] is not None: - _body_params = _params['ezsigntemplatedocument_edit_ezsigntemplateformfieldgroups_v1_request'] + if ezsigntemplatedocument_edit_ezsigntemplateformfieldgroups_v1_request is not None: + _body_params = ezsigntemplatedocument_edit_ezsigntemplateformfieldgroups_v1_request + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '200': "EzsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1Response", - '404': "CommonResponseError", - '422': "CommonResponseError", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/editEzsigntemplateformfieldgroups', 'PUT', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='PUT', + resource_path='/1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/editEzsigntemplateformfieldgroups', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + - @validate_arguments - def ezsigntemplatedocument_edit_ezsigntemplatesignatures_v1(self, pki_ezsigntemplatedocument_id : conint(strict=True, ge=0), ezsigntemplatedocument_edit_ezsigntemplatesignatures_v1_request : EzsigntemplatedocumentEditEzsigntemplatesignaturesV1Request, **kwargs) -> EzsigntemplatedocumentEditEzsigntemplatesignaturesV1Response: # noqa: E501 - """Edit multiple Ezsigntemplatesignatures # noqa: E501 - Using this endpoint, you can edit multiple Ezsigntemplatesignatures at the same time. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.ezsigntemplatedocument_edit_ezsigntemplatesignatures_v1(pki_ezsigntemplatedocument_id, ezsigntemplatedocument_edit_ezsigntemplatesignatures_v1_request, async_req=True) - >>> result = thread.get() + @validate_call + def ezsigntemplatedocument_edit_ezsigntemplatesignatures_v1( + self, + pki_ezsigntemplatedocument_id: Annotated[int, Field(strict=True, ge=0)], + ezsigntemplatedocument_edit_ezsigntemplatesignatures_v1_request: EzsigntemplatedocumentEditEzsigntemplatesignaturesV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsigntemplatedocumentEditEzsigntemplatesignaturesV1Response: + """Edit multiple Ezsigntemplatesignatures + + Using this endpoint, you can edit multiple Ezsigntemplatesignatures at the same time. :param pki_ezsigntemplatedocument_id: (required) :type pki_ezsigntemplatedocument_id: int :param ezsigntemplatedocument_edit_ezsigntemplatesignatures_v1_request: (required) :type ezsigntemplatedocument_edit_ezsigntemplatesignatures_v1_request: EzsigntemplatedocumentEditEzsigntemplatesignaturesV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsigntemplatedocumentEditEzsigntemplatesignaturesV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsigntemplatedocument_edit_ezsigntemplatesignatures_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsigntemplatedocument_edit_ezsigntemplatesignatures_v1_with_http_info(pki_ezsigntemplatedocument_id, ezsigntemplatedocument_edit_ezsigntemplatesignatures_v1_request, **kwargs) # noqa: E501 - - @validate_arguments - def ezsigntemplatedocument_edit_ezsigntemplatesignatures_v1_with_http_info(self, pki_ezsigntemplatedocument_id : conint(strict=True, ge=0), ezsigntemplatedocument_edit_ezsigntemplatesignatures_v1_request : EzsigntemplatedocumentEditEzsigntemplatesignaturesV1Request, **kwargs) -> ApiResponse: # noqa: E501 - """Edit multiple Ezsigntemplatesignatures # noqa: E501 - - Using this endpoint, you can edit multiple Ezsigntemplatesignatures at the same time. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsigntemplatedocument_edit_ezsigntemplatesignatures_v1_with_http_info(pki_ezsigntemplatedocument_id, ezsigntemplatedocument_edit_ezsigntemplatesignatures_v1_request, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._ezsigntemplatedocument_edit_ezsigntemplatesignatures_v1_serialize( + pki_ezsigntemplatedocument_id=pki_ezsigntemplatedocument_id, + ezsigntemplatedocument_edit_ezsigntemplatesignatures_v1_request=ezsigntemplatedocument_edit_ezsigntemplatesignatures_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplatedocumentEditEzsigntemplatesignaturesV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsigntemplatedocument_edit_ezsigntemplatesignatures_v1_with_http_info( + self, + pki_ezsigntemplatedocument_id: Annotated[int, Field(strict=True, ge=0)], + ezsigntemplatedocument_edit_ezsigntemplatesignatures_v1_request: EzsigntemplatedocumentEditEzsigntemplatesignaturesV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsigntemplatedocumentEditEzsigntemplatesignaturesV1Response]: + """Edit multiple Ezsigntemplatesignatures + + Using this endpoint, you can edit multiple Ezsigntemplatesignatures at the same time. :param pki_ezsigntemplatedocument_id: (required) :type pki_ezsigntemplatedocument_id: int :param ezsigntemplatedocument_edit_ezsigntemplatesignatures_v1_request: (required) :type ezsigntemplatedocument_edit_ezsigntemplatesignatures_v1_request: EzsigntemplatedocumentEditEzsigntemplatesignaturesV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsigntemplatedocumentEditEzsigntemplatesignaturesV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._ezsigntemplatedocument_edit_ezsigntemplatesignatures_v1_serialize( + pki_ezsigntemplatedocument_id=pki_ezsigntemplatedocument_id, + ezsigntemplatedocument_edit_ezsigntemplatesignatures_v1_request=ezsigntemplatedocument_edit_ezsigntemplatesignatures_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplatedocumentEditEzsigntemplatesignaturesV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _params = locals() - _all_params = [ - 'pki_ezsigntemplatedocument_id', - 'ezsigntemplatedocument_edit_ezsigntemplatesignatures_v1_request' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + @validate_call + def ezsigntemplatedocument_edit_ezsigntemplatesignatures_v1_without_preload_content( + self, + pki_ezsigntemplatedocument_id: Annotated[int, Field(strict=True, ge=0)], + ezsigntemplatedocument_edit_ezsigntemplatesignatures_v1_request: EzsigntemplatedocumentEditEzsigntemplatesignaturesV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Edit multiple Ezsigntemplatesignatures + + Using this endpoint, you can edit multiple Ezsigntemplatesignatures at the same time. + + :param pki_ezsigntemplatedocument_id: (required) + :type pki_ezsigntemplatedocument_id: int + :param ezsigntemplatedocument_edit_ezsigntemplatesignatures_v1_request: (required) + :type ezsigntemplatedocument_edit_ezsigntemplatesignatures_v1_request: EzsigntemplatedocumentEditEzsigntemplatesignaturesV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsigntemplatedocument_edit_ezsigntemplatesignatures_v1_serialize( + pki_ezsigntemplatedocument_id=pki_ezsigntemplatedocument_id, + ezsigntemplatedocument_edit_ezsigntemplatesignatures_v1_request=ezsigntemplatedocument_edit_ezsigntemplatesignatures_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsigntemplatedocument_edit_ezsigntemplatesignatures_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplatedocumentEditEzsigntemplatesignaturesV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_ezsigntemplatedocument_id']: - _path_params['pkiEzsigntemplatedocumentID'] = _params['pki_ezsigntemplatedocument_id'] + def _ezsigntemplatedocument_edit_ezsigntemplatesignatures_v1_serialize( + self, + pki_ezsigntemplatedocument_id, + ezsigntemplatedocument_edit_ezsigntemplatesignatures_v1_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if pki_ezsigntemplatedocument_id is not None: + _path_params['pkiEzsigntemplatedocumentID'] = pki_ezsigntemplatedocument_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['ezsigntemplatedocument_edit_ezsigntemplatesignatures_v1_request'] is not None: - _body_params = _params['ezsigntemplatedocument_edit_ezsigntemplatesignatures_v1_request'] + if ezsigntemplatedocument_edit_ezsigntemplatesignatures_v1_request is not None: + _body_params = ezsigntemplatedocument_edit_ezsigntemplatesignatures_v1_request + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '200': "EzsigntemplatedocumentEditEzsigntemplatesignaturesV1Response", - '404': "CommonResponseError", - '422': "CommonResponseError", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/editEzsigntemplatesignatures', 'PUT', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='PUT', + resource_path='/1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/editEzsigntemplatesignatures', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + - @validate_arguments - def ezsigntemplatedocument_edit_object_v1(self, pki_ezsigntemplatedocument_id : conint(strict=True, ge=0), ezsigntemplatedocument_edit_object_v1_request : EzsigntemplatedocumentEditObjectV1Request, **kwargs) -> EzsigntemplatedocumentEditObjectV1Response: # noqa: E501 - """Edit an existing Ezsigntemplatedocument # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def ezsigntemplatedocument_edit_object_v1( + self, + pki_ezsigntemplatedocument_id: Annotated[int, Field(strict=True, ge=0)], + ezsigntemplatedocument_edit_object_v1_request: EzsigntemplatedocumentEditObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsigntemplatedocumentEditObjectV1Response: + """Edit an existing Ezsigntemplatedocument - >>> thread = api.ezsigntemplatedocument_edit_object_v1(pki_ezsigntemplatedocument_id, ezsigntemplatedocument_edit_object_v1_request, async_req=True) - >>> result = thread.get() + :param pki_ezsigntemplatedocument_id: (required) :type pki_ezsigntemplatedocument_id: int :param ezsigntemplatedocument_edit_object_v1_request: (required) :type ezsigntemplatedocument_edit_object_v1_request: EzsigntemplatedocumentEditObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsigntemplatedocumentEditObjectV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsigntemplatedocument_edit_object_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsigntemplatedocument_edit_object_v1_with_http_info(pki_ezsigntemplatedocument_id, ezsigntemplatedocument_edit_object_v1_request, **kwargs) # noqa: E501 - - @validate_arguments - def ezsigntemplatedocument_edit_object_v1_with_http_info(self, pki_ezsigntemplatedocument_id : conint(strict=True, ge=0), ezsigntemplatedocument_edit_object_v1_request : EzsigntemplatedocumentEditObjectV1Request, **kwargs) -> ApiResponse: # noqa: E501 - """Edit an existing Ezsigntemplatedocument # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsigntemplatedocument_edit_object_v1_with_http_info(pki_ezsigntemplatedocument_id, ezsigntemplatedocument_edit_object_v1_request, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._ezsigntemplatedocument_edit_object_v1_serialize( + pki_ezsigntemplatedocument_id=pki_ezsigntemplatedocument_id, + ezsigntemplatedocument_edit_object_v1_request=ezsigntemplatedocument_edit_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplatedocumentEditObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseErrorSTemporaryFileUrl", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsigntemplatedocument_edit_object_v1_with_http_info( + self, + pki_ezsigntemplatedocument_id: Annotated[int, Field(strict=True, ge=0)], + ezsigntemplatedocument_edit_object_v1_request: EzsigntemplatedocumentEditObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsigntemplatedocumentEditObjectV1Response]: + """Edit an existing Ezsigntemplatedocument + + :param pki_ezsigntemplatedocument_id: (required) :type pki_ezsigntemplatedocument_id: int :param ezsigntemplatedocument_edit_object_v1_request: (required) :type ezsigntemplatedocument_edit_object_v1_request: EzsigntemplatedocumentEditObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsigntemplatedocumentEditObjectV1Response, status_code(int), headers(HTTPHeaderDict)) - """ - - _params = locals() - - _all_params = [ - 'pki_ezsigntemplatedocument_id', - 'ezsigntemplatedocument_edit_object_v1_request' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' - ] + """ # noqa: E501 + + _param = self._ezsigntemplatedocument_edit_object_v1_serialize( + pki_ezsigntemplatedocument_id=pki_ezsigntemplatedocument_id, + ezsigntemplatedocument_edit_object_v1_request=ezsigntemplatedocument_edit_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsigntemplatedocument_edit_object_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] - - _collection_formats = {} - - # process the path parameters - _path_params = {} - if _params['pki_ezsigntemplatedocument_id']: - _path_params['pkiEzsigntemplatedocumentID'] = _params['pki_ezsigntemplatedocument_id'] - - - # process the query parameters - _query_params = [] - # process the header parameters - _header_params = dict(_params.get('_headers', {})) - # process the form parameters - _form_params = [] - _files = {} - # process the body parameter - _body_params = None - if _params['ezsigntemplatedocument_edit_object_v1_request'] is not None: - _body_params = _params['ezsigntemplatedocument_edit_object_v1_request'] - - # set the HTTP header `Accept` - _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 - - # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list - - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { + _response_types_map: Dict[str, Optional[str]] = { '200': "EzsigntemplatedocumentEditObjectV1Response", '404': "CommonResponseError", '422': "CommonResponseErrorSTemporaryFileUrl", } - - return self.api_client.call_api( - '/1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}', 'PUT', - _path_params, - _query_params, - _header_params, - body=_body_params, - post_params=_form_params, - files=_files, + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, response_types_map=_response_types_map, - auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), - collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) - - @validate_arguments - def ezsigntemplatedocument_flatten_v1(self, pki_ezsigntemplatedocument_id : conint(strict=True, ge=0), body : Dict[str, Any], **kwargs) -> EzsigntemplatedocumentFlattenV1Response: # noqa: E501 - """Flatten # noqa: E501 + ) - Flatten an Ezsigntemplatedocument signatures, forms and annotations. This process finalizes the PDF so that the forms and annotations become part of the document content and cannot be edited. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.ezsigntemplatedocument_flatten_v1(pki_ezsigntemplatedocument_id, body, async_req=True) - >>> result = thread.get() + @validate_call + def ezsigntemplatedocument_edit_object_v1_without_preload_content( + self, + pki_ezsigntemplatedocument_id: Annotated[int, Field(strict=True, ge=0)], + ezsigntemplatedocument_edit_object_v1_request: EzsigntemplatedocumentEditObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Edit an existing Ezsigntemplatedocument - :param pki_ezsigntemplatedocument_id: (required) - :type pki_ezsigntemplatedocument_id: int - :param body: (required) - :type body: object - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsigntemplatedocumentFlattenV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsigntemplatedocument_flatten_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsigntemplatedocument_flatten_v1_with_http_info(pki_ezsigntemplatedocument_id, body, **kwargs) # noqa: E501 - - @validate_arguments - def ezsigntemplatedocument_flatten_v1_with_http_info(self, pki_ezsigntemplatedocument_id : conint(strict=True, ge=0), body : Dict[str, Any], **kwargs) -> ApiResponse: # noqa: E501 - """Flatten # noqa: E501 - - Flatten an Ezsigntemplatedocument signatures, forms and annotations. This process finalizes the PDF so that the forms and annotations become part of the document content and cannot be edited. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsigntemplatedocument_flatten_v1_with_http_info(pki_ezsigntemplatedocument_id, body, async_req=True) - >>> result = thread.get() + :param pki_ezsigntemplatedocument_id: (required) :type pki_ezsigntemplatedocument_id: int - :param body: (required) - :type body: object - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional + :param ezsigntemplatedocument_edit_object_v1_request: (required) + :type ezsigntemplatedocument_edit_object_v1_request: EzsigntemplatedocumentEditObjectV1Request :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsigntemplatedocumentFlattenV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._ezsigntemplatedocument_edit_object_v1_serialize( + pki_ezsigntemplatedocument_id=pki_ezsigntemplatedocument_id, + ezsigntemplatedocument_edit_object_v1_request=ezsigntemplatedocument_edit_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplatedocumentEditObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseErrorSTemporaryFileUrl", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _all_params = [ - 'pki_ezsigntemplatedocument_id', - 'body' - ] - _all_params.extend( + + def _ezsigntemplatedocument_edit_object_v1_serialize( + self, + pki_ezsigntemplatedocument_id, + ezsigntemplatedocument_edit_object_v1_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_ezsigntemplatedocument_id is not None: + _path_params['pkiEzsigntemplatedocumentID'] = pki_ezsigntemplatedocument_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if ezsigntemplatedocument_edit_object_v1_request is not None: + _body_params = ezsigntemplatedocument_edit_object_v1_request + + + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + 'application/json' ] ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsigntemplatedocument_flatten_v1" % _key + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] ) - _params[_key] = _val - del _params['kwargs'] + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type - _collection_formats = {} + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - # process the path parameters - _path_params = {} - if _params['pki_ezsigntemplatedocument_id']: - _path_params['pkiEzsigntemplatedocumentID'] = _params['pki_ezsigntemplatedocument_id'] + return self.api_client.param_serialize( + method='PUT', + resource_path='/1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def ezsigntemplatedocument_flatten_v1( + self, + pki_ezsigntemplatedocument_id: Annotated[int, Field(strict=True, ge=0)], + body: Dict[str, Any], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsigntemplatedocumentFlattenV1Response: + """Flatten + + Flatten an Ezsigntemplatedocument signatures, forms and annotations. This process finalizes the PDF so that the forms and annotations become part of the document content and cannot be edited. + + :param pki_ezsigntemplatedocument_id: (required) + :type pki_ezsigntemplatedocument_id: int + :param body: (required) + :type body: object + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsigntemplatedocument_flatten_v1_serialize( + pki_ezsigntemplatedocument_id=pki_ezsigntemplatedocument_id, + body=body, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplatedocumentFlattenV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsigntemplatedocument_flatten_v1_with_http_info( + self, + pki_ezsigntemplatedocument_id: Annotated[int, Field(strict=True, ge=0)], + body: Dict[str, Any], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsigntemplatedocumentFlattenV1Response]: + """Flatten + + Flatten an Ezsigntemplatedocument signatures, forms and annotations. This process finalizes the PDF so that the forms and annotations become part of the document content and cannot be edited. + + :param pki_ezsigntemplatedocument_id: (required) + :type pki_ezsigntemplatedocument_id: int + :param body: (required) + :type body: object + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsigntemplatedocument_flatten_v1_serialize( + pki_ezsigntemplatedocument_id=pki_ezsigntemplatedocument_id, + body=body, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplatedocumentFlattenV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def ezsigntemplatedocument_flatten_v1_without_preload_content( + self, + pki_ezsigntemplatedocument_id: Annotated[int, Field(strict=True, ge=0)], + body: Dict[str, Any], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Flatten + + Flatten an Ezsigntemplatedocument signatures, forms and annotations. This process finalizes the PDF so that the forms and annotations become part of the document content and cannot be edited. + + :param pki_ezsigntemplatedocument_id: (required) + :type pki_ezsigntemplatedocument_id: int + :param body: (required) + :type body: object + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsigntemplatedocument_flatten_v1_serialize( + pki_ezsigntemplatedocument_id=pki_ezsigntemplatedocument_id, + body=body, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplatedocumentFlattenV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _ezsigntemplatedocument_flatten_v1_serialize( + self, + pki_ezsigntemplatedocument_id, + body, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if pki_ezsigntemplatedocument_id is not None: + _path_params['pkiEzsigntemplatedocumentID'] = pki_ezsigntemplatedocument_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['body'] is not None: - _body_params = _params['body'] + if body is not None: + _body_params = body + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 + _auth_settings: List[str] = [ + 'Authorization' + ] - _response_types_map = { - '200': "EzsigntemplatedocumentFlattenV1Response", + return self.api_client.param_serialize( + method='POST', + resource_path='/1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/flatten', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def ezsigntemplatedocument_get_ezsigntemplatedocumentpages_v1( + self, + pki_ezsigntemplatedocument_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsigntemplatedocumentGetEzsigntemplatedocumentpagesV1Response: + """Retrieve an existing Ezsigntemplatedocument's Ezsigntemplatedocumentpages + + + + :param pki_ezsigntemplatedocument_id: (required) + :type pki_ezsigntemplatedocument_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsigntemplatedocument_get_ezsigntemplatedocumentpages_v1_serialize( + pki_ezsigntemplatedocument_id=pki_ezsigntemplatedocument_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplatedocumentGetEzsigntemplatedocumentpagesV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsigntemplatedocument_get_ezsigntemplatedocumentpages_v1_with_http_info( + self, + pki_ezsigntemplatedocument_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsigntemplatedocumentGetEzsigntemplatedocumentpagesV1Response]: + """Retrieve an existing Ezsigntemplatedocument's Ezsigntemplatedocumentpages + + + + :param pki_ezsigntemplatedocument_id: (required) + :type pki_ezsigntemplatedocument_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsigntemplatedocument_get_ezsigntemplatedocumentpages_v1_serialize( + pki_ezsigntemplatedocument_id=pki_ezsigntemplatedocument_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplatedocumentGetEzsigntemplatedocumentpagesV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def ezsigntemplatedocument_get_ezsigntemplatedocumentpages_v1_without_preload_content( + self, + pki_ezsigntemplatedocument_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve an existing Ezsigntemplatedocument's Ezsigntemplatedocumentpages + + + + :param pki_ezsigntemplatedocument_id: (required) + :type pki_ezsigntemplatedocument_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsigntemplatedocument_get_ezsigntemplatedocumentpages_v1_serialize( + pki_ezsigntemplatedocument_id=pki_ezsigntemplatedocument_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplatedocumentGetEzsigntemplatedocumentpagesV1Response", '404': "CommonResponseError", - '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _ezsigntemplatedocument_get_ezsigntemplatedocumentpages_v1_serialize( + self, + pki_ezsigntemplatedocument_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { } - return self.api_client.call_api( - '/1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/flatten', 'POST', - _path_params, - _query_params, - _header_params, + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_ezsigntemplatedocument_id is not None: + _path_params['pkiEzsigntemplatedocumentID'] = pki_ezsigntemplatedocument_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/getEzsigntemplatedocumentpages', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def ezsigntemplatedocument_get_ezsigntemplateformfieldgroups_v1( + self, + pki_ezsigntemplatedocument_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsigntemplatedocumentGetEzsigntemplateformfieldgroupsV1Response: + """Retrieve an existing Ezsigntemplatedocument's Ezsigntemplateformfieldgroups + + + + :param pki_ezsigntemplatedocument_id: (required) + :type pki_ezsigntemplatedocument_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsigntemplatedocument_get_ezsigntemplateformfieldgroups_v1_serialize( + pki_ezsigntemplatedocument_id=pki_ezsigntemplatedocument_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplatedocumentGetEzsigntemplateformfieldgroupsV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsigntemplatedocument_get_ezsigntemplateformfieldgroups_v1_with_http_info( + self, + pki_ezsigntemplatedocument_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsigntemplatedocumentGetEzsigntemplateformfieldgroupsV1Response]: + """Retrieve an existing Ezsigntemplatedocument's Ezsigntemplateformfieldgroups + + + + :param pki_ezsigntemplatedocument_id: (required) + :type pki_ezsigntemplatedocument_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsigntemplatedocument_get_ezsigntemplateformfieldgroups_v1_serialize( + pki_ezsigntemplatedocument_id=pki_ezsigntemplatedocument_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplatedocumentGetEzsigntemplateformfieldgroupsV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def ezsigntemplatedocument_get_ezsigntemplateformfieldgroups_v1_without_preload_content( + self, + pki_ezsigntemplatedocument_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve an existing Ezsigntemplatedocument's Ezsigntemplateformfieldgroups + + + + :param pki_ezsigntemplatedocument_id: (required) + :type pki_ezsigntemplatedocument_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsigntemplatedocument_get_ezsigntemplateformfieldgroups_v1_serialize( + pki_ezsigntemplatedocument_id=pki_ezsigntemplatedocument_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplatedocumentGetEzsigntemplateformfieldgroupsV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _ezsigntemplatedocument_get_ezsigntemplateformfieldgroups_v1_serialize( + self, + pki_ezsigntemplatedocument_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_ezsigntemplatedocument_id is not None: + _path_params['pkiEzsigntemplatedocumentID'] = pki_ezsigntemplatedocument_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/getEzsigntemplateformfieldgroups', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + - @validate_arguments - def ezsigntemplatedocument_get_ezsigntemplatedocumentpages_v1(self, pki_ezsigntemplatedocument_id : conint(strict=True, ge=0), **kwargs) -> EzsigntemplatedocumentGetEzsigntemplatedocumentpagesV1Response: # noqa: E501 - """Retrieve an existing Ezsigntemplatedocument's Ezsigntemplatedocumentpages # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.ezsigntemplatedocument_get_ezsigntemplatedocumentpages_v1(pki_ezsigntemplatedocument_id, async_req=True) - >>> result = thread.get() + @validate_call + def ezsigntemplatedocument_get_ezsigntemplatesignatures_v1( + self, + pki_ezsigntemplatedocument_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsigntemplatedocumentGetEzsigntemplatesignaturesV1Response: + """Retrieve an existing Ezsigntemplatedocument's Ezsigntemplatesignatures + + :param pki_ezsigntemplatedocument_id: (required) :type pki_ezsigntemplatedocument_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsigntemplatedocumentGetEzsigntemplatedocumentpagesV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsigntemplatedocument_get_ezsigntemplatedocumentpages_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsigntemplatedocument_get_ezsigntemplatedocumentpages_v1_with_http_info(pki_ezsigntemplatedocument_id, **kwargs) # noqa: E501 - - @validate_arguments - def ezsigntemplatedocument_get_ezsigntemplatedocumentpages_v1_with_http_info(self, pki_ezsigntemplatedocument_id : conint(strict=True, ge=0), **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve an existing Ezsigntemplatedocument's Ezsigntemplatedocumentpages # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsigntemplatedocument_get_ezsigntemplatedocumentpages_v1_with_http_info(pki_ezsigntemplatedocument_id, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._ezsigntemplatedocument_get_ezsigntemplatesignatures_v1_serialize( + pki_ezsigntemplatedocument_id=pki_ezsigntemplatedocument_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplatedocumentGetEzsigntemplatesignaturesV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsigntemplatedocument_get_ezsigntemplatesignatures_v1_with_http_info( + self, + pki_ezsigntemplatedocument_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsigntemplatedocumentGetEzsigntemplatesignaturesV1Response]: + """Retrieve an existing Ezsigntemplatedocument's Ezsigntemplatesignatures + + + + :param pki_ezsigntemplatedocument_id: (required) + :type pki_ezsigntemplatedocument_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsigntemplatedocument_get_ezsigntemplatesignatures_v1_serialize( + pki_ezsigntemplatedocument_id=pki_ezsigntemplatedocument_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplatedocumentGetEzsigntemplatesignaturesV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def ezsigntemplatedocument_get_ezsigntemplatesignatures_v1_without_preload_content( + self, + pki_ezsigntemplatedocument_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve an existing Ezsigntemplatedocument's Ezsigntemplatesignatures + + :param pki_ezsigntemplatedocument_id: (required) :type pki_ezsigntemplatedocument_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsigntemplatedocumentGetEzsigntemplatedocumentpagesV1Response, status_code(int), headers(HTTPHeaderDict)) - """ - - _params = locals() + """ # noqa: E501 + + _param = self._ezsigntemplatedocument_get_ezsigntemplatesignatures_v1_serialize( + pki_ezsigntemplatedocument_id=pki_ezsigntemplatedocument_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _all_params = [ - 'pki_ezsigntemplatedocument_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' - ] + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplatedocumentGetEzsigntemplatesignaturesV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) + return response_data.response - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsigntemplatedocument_get_ezsigntemplatedocumentpages_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] - _collection_formats = {} + def _ezsigntemplatedocument_get_ezsigntemplatesignatures_v1_serialize( + self, + pki_ezsigntemplatedocument_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: - # process the path parameters - _path_params = {} - if _params['pki_ezsigntemplatedocument_id']: - _path_params['pkiEzsigntemplatedocumentID'] = _params['pki_ezsigntemplatedocument_id'] + _host = None + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if pki_ezsigntemplatedocument_id is not None: + _path_params['pkiEzsigntemplatedocumentID'] = pki_ezsigntemplatedocument_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "EzsigntemplatedocumentGetEzsigntemplatedocumentpagesV1Response", - '404': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/getEzsigntemplatedocumentpages', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/getEzsigntemplatesignatures', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) - @validate_arguments - def ezsigntemplatedocument_get_ezsigntemplateformfieldgroups_v1(self, pki_ezsigntemplatedocument_id : conint(strict=True, ge=0), **kwargs) -> EzsigntemplatedocumentGetEzsigntemplateformfieldgroupsV1Response: # noqa: E501 - """Retrieve an existing Ezsigntemplatedocument's Ezsigntemplateformfieldgroups # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.ezsigntemplatedocument_get_ezsigntemplateformfieldgroups_v1(pki_ezsigntemplatedocument_id, async_req=True) - >>> result = thread.get() - :param pki_ezsigntemplatedocument_id: (required) - :type pki_ezsigntemplatedocument_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsigntemplatedocumentGetEzsigntemplateformfieldgroupsV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsigntemplatedocument_get_ezsigntemplateformfieldgroups_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsigntemplatedocument_get_ezsigntemplateformfieldgroups_v1_with_http_info(pki_ezsigntemplatedocument_id, **kwargs) # noqa: E501 - - @validate_arguments - def ezsigntemplatedocument_get_ezsigntemplateformfieldgroups_v1_with_http_info(self, pki_ezsigntemplatedocument_id : conint(strict=True, ge=0), **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve an existing Ezsigntemplatedocument's Ezsigntemplateformfieldgroups # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsigntemplatedocument_get_ezsigntemplateformfieldgroups_v1_with_http_info(pki_ezsigntemplatedocument_id, async_req=True) - >>> result = thread.get() + @validate_call + def ezsigntemplatedocument_get_object_v2( + self, + pki_ezsigntemplatedocument_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsigntemplatedocumentGetObjectV2Response: + """Retrieve an existing Ezsigntemplatedocument + + :param pki_ezsigntemplatedocument_id: (required) :type pki_ezsigntemplatedocument_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsigntemplatedocumentGetEzsigntemplateformfieldgroupsV1Response, status_code(int), headers(HTTPHeaderDict)) - """ - - _params = locals() - - _all_params = [ - 'pki_ezsigntemplatedocument_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' - ] + """ # noqa: E501 + + _param = self._ezsigntemplatedocument_get_object_v2_serialize( + pki_ezsigntemplatedocument_id=pki_ezsigntemplatedocument_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsigntemplatedocument_get_ezsigntemplateformfieldgroups_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] - - _collection_formats = {} - - # process the path parameters - _path_params = {} - if _params['pki_ezsigntemplatedocument_id']: - _path_params['pkiEzsigntemplatedocumentID'] = _params['pki_ezsigntemplatedocument_id'] - + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplatedocumentGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsigntemplatedocument_get_object_v2_with_http_info( + self, + pki_ezsigntemplatedocument_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsigntemplatedocumentGetObjectV2Response]: + """Retrieve an existing Ezsigntemplatedocument - # process the query parameters - _query_params = [] - # process the header parameters - _header_params = dict(_params.get('_headers', {})) - # process the form parameters - _form_params = [] - _files = {} - # process the body parameter - _body_params = None - # set the HTTP header `Accept` - _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 + :param pki_ezsigntemplatedocument_id: (required) + :type pki_ezsigntemplatedocument_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsigntemplatedocument_get_object_v2_serialize( + pki_ezsigntemplatedocument_id=pki_ezsigntemplatedocument_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _response_types_map = { - '200': "EzsigntemplatedocumentGetEzsigntemplateformfieldgroupsV1Response", + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplatedocumentGetObjectV2Response", '404': "CommonResponseError", - '422': "CommonResponseError", } - - return self.api_client.call_api( - '/1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/getEzsigntemplateformfieldgroups', 'GET', - _path_params, - _query_params, - _header_params, - body=_body_params, - post_params=_form_params, - files=_files, + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, response_types_map=_response_types_map, - auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), - collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) - - @validate_arguments - def ezsigntemplatedocument_get_ezsigntemplatesignatures_v1(self, pki_ezsigntemplatedocument_id : conint(strict=True, ge=0), **kwargs) -> EzsigntemplatedocumentGetEzsigntemplatesignaturesV1Response: # noqa: E501 - """Retrieve an existing Ezsigntemplatedocument's Ezsigntemplatesignatures # noqa: E501 + ) - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.ezsigntemplatedocument_get_ezsigntemplatesignatures_v1(pki_ezsigntemplatedocument_id, async_req=True) - >>> result = thread.get() + @validate_call + def ezsigntemplatedocument_get_object_v2_without_preload_content( + self, + pki_ezsigntemplatedocument_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve an existing Ezsigntemplatedocument - :param pki_ezsigntemplatedocument_id: (required) - :type pki_ezsigntemplatedocument_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsigntemplatedocumentGetEzsigntemplatesignaturesV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsigntemplatedocument_get_ezsigntemplatesignatures_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsigntemplatedocument_get_ezsigntemplatesignatures_v1_with_http_info(pki_ezsigntemplatedocument_id, **kwargs) # noqa: E501 - - @validate_arguments - def ezsigntemplatedocument_get_ezsigntemplatesignatures_v1_with_http_info(self, pki_ezsigntemplatedocument_id : conint(strict=True, ge=0), **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve an existing Ezsigntemplatedocument's Ezsigntemplatesignatures # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsigntemplatedocument_get_ezsigntemplatesignatures_v1_with_http_info(pki_ezsigntemplatedocument_id, async_req=True) - >>> result = thread.get() + :param pki_ezsigntemplatedocument_id: (required) :type pki_ezsigntemplatedocument_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsigntemplatedocumentGetEzsigntemplatesignaturesV1Response, status_code(int), headers(HTTPHeaderDict)) - """ - - _params = locals() + """ # noqa: E501 + + _param = self._ezsigntemplatedocument_get_object_v2_serialize( + pki_ezsigntemplatedocument_id=pki_ezsigntemplatedocument_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _all_params = [ - 'pki_ezsigntemplatedocument_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' - ] + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplatedocumentGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) + return response_data.response - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsigntemplatedocument_get_ezsigntemplatesignatures_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] - _collection_formats = {} + def _ezsigntemplatedocument_get_object_v2_serialize( + self, + pki_ezsigntemplatedocument_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: - # process the path parameters - _path_params = {} - if _params['pki_ezsigntemplatedocument_id']: - _path_params['pkiEzsigntemplatedocumentID'] = _params['pki_ezsigntemplatedocument_id'] + _host = None + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if pki_ezsigntemplatedocument_id is not None: + _path_params['pkiEzsigntemplatedocumentID'] = pki_ezsigntemplatedocument_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "EzsigntemplatedocumentGetEzsigntemplatesignaturesV1Response", - '404': "CommonResponseError", - '422': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/getEzsigntemplatesignatures', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/2/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) - @validate_arguments - def ezsigntemplatedocument_get_object_v2(self, pki_ezsigntemplatedocument_id : conint(strict=True, ge=0), **kwargs) -> EzsigntemplatedocumentGetObjectV2Response: # noqa: E501 - """Retrieve an existing Ezsigntemplatedocument # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.ezsigntemplatedocument_get_object_v2(pki_ezsigntemplatedocument_id, async_req=True) - >>> result = thread.get() - :param pki_ezsigntemplatedocument_id: (required) - :type pki_ezsigntemplatedocument_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsigntemplatedocumentGetObjectV2Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsigntemplatedocument_get_object_v2_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsigntemplatedocument_get_object_v2_with_http_info(pki_ezsigntemplatedocument_id, **kwargs) # noqa: E501 - - @validate_arguments - def ezsigntemplatedocument_get_object_v2_with_http_info(self, pki_ezsigntemplatedocument_id : conint(strict=True, ge=0), **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve an existing Ezsigntemplatedocument # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsigntemplatedocument_get_object_v2_with_http_info(pki_ezsigntemplatedocument_id, async_req=True) - >>> result = thread.get() + @validate_call + def ezsigntemplatedocument_get_words_positions_v1( + self, + pki_ezsigntemplatedocument_id: Annotated[int, Field(strict=True, ge=0)], + ezsigntemplatedocument_get_words_positions_v1_request: EzsigntemplatedocumentGetWordsPositionsV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsigntemplatedocumentGetWordsPositionsV1Response: + """Retrieve positions X,Y of given words from a Ezsigntemplatedocument + + :param pki_ezsigntemplatedocument_id: (required) :type pki_ezsigntemplatedocument_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional + :param ezsigntemplatedocument_get_words_positions_v1_request: (required) + :type ezsigntemplatedocument_get_words_positions_v1_request: EzsigntemplatedocumentGetWordsPositionsV1Request :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsigntemplatedocumentGetObjectV2Response, status_code(int), headers(HTTPHeaderDict)) - """ - - _params = locals() - - _all_params = [ - 'pki_ezsigntemplatedocument_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' - ] + """ # noqa: E501 + + _param = self._ezsigntemplatedocument_get_words_positions_v1_serialize( + pki_ezsigntemplatedocument_id=pki_ezsigntemplatedocument_id, + ezsigntemplatedocument_get_words_positions_v1_request=ezsigntemplatedocument_get_words_positions_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsigntemplatedocument_get_object_v2" % _key - ) - _params[_key] = _val - del _params['kwargs'] - - _collection_formats = {} - - # process the path parameters - _path_params = {} - if _params['pki_ezsigntemplatedocument_id']: - _path_params['pkiEzsigntemplatedocumentID'] = _params['pki_ezsigntemplatedocument_id'] - - - # process the query parameters - _query_params = [] - # process the header parameters - _header_params = dict(_params.get('_headers', {})) - # process the form parameters - _form_params = [] - _files = {} - # process the body parameter - _body_params = None - # set the HTTP header `Accept` - _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 - - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '200': "EzsigntemplatedocumentGetObjectV2Response", + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplatedocumentGetWordsPositionsV1Response", '404': "CommonResponseError", } - - return self.api_client.call_api( - '/2/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}', 'GET', - _path_params, - _query_params, - _header_params, - body=_body_params, - post_params=_form_params, - files=_files, + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, response_types_map=_response_types_map, - auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), - collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) - - @validate_arguments - def ezsigntemplatedocument_get_words_positions_v1(self, pki_ezsigntemplatedocument_id : conint(strict=True, ge=0), ezsigntemplatedocument_get_words_positions_v1_request : EzsigntemplatedocumentGetWordsPositionsV1Request, **kwargs) -> EzsigntemplatedocumentGetWordsPositionsV1Response: # noqa: E501 - """Retrieve positions X,Y of given words from a Ezsigntemplatedocument # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + ).data + + + @validate_call + def ezsigntemplatedocument_get_words_positions_v1_with_http_info( + self, + pki_ezsigntemplatedocument_id: Annotated[int, Field(strict=True, ge=0)], + ezsigntemplatedocument_get_words_positions_v1_request: EzsigntemplatedocumentGetWordsPositionsV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsigntemplatedocumentGetWordsPositionsV1Response]: + """Retrieve positions X,Y of given words from a Ezsigntemplatedocument - >>> thread = api.ezsigntemplatedocument_get_words_positions_v1(pki_ezsigntemplatedocument_id, ezsigntemplatedocument_get_words_positions_v1_request, async_req=True) - >>> result = thread.get() + :param pki_ezsigntemplatedocument_id: (required) :type pki_ezsigntemplatedocument_id: int :param ezsigntemplatedocument_get_words_positions_v1_request: (required) :type ezsigntemplatedocument_get_words_positions_v1_request: EzsigntemplatedocumentGetWordsPositionsV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsigntemplatedocumentGetWordsPositionsV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsigntemplatedocument_get_words_positions_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsigntemplatedocument_get_words_positions_v1_with_http_info(pki_ezsigntemplatedocument_id, ezsigntemplatedocument_get_words_positions_v1_request, **kwargs) # noqa: E501 - - @validate_arguments - def ezsigntemplatedocument_get_words_positions_v1_with_http_info(self, pki_ezsigntemplatedocument_id : conint(strict=True, ge=0), ezsigntemplatedocument_get_words_positions_v1_request : EzsigntemplatedocumentGetWordsPositionsV1Request, **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve positions X,Y of given words from a Ezsigntemplatedocument # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsigntemplatedocument_get_words_positions_v1_with_http_info(pki_ezsigntemplatedocument_id, ezsigntemplatedocument_get_words_positions_v1_request, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._ezsigntemplatedocument_get_words_positions_v1_serialize( + pki_ezsigntemplatedocument_id=pki_ezsigntemplatedocument_id, + ezsigntemplatedocument_get_words_positions_v1_request=ezsigntemplatedocument_get_words_positions_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplatedocumentGetWordsPositionsV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def ezsigntemplatedocument_get_words_positions_v1_without_preload_content( + self, + pki_ezsigntemplatedocument_id: Annotated[int, Field(strict=True, ge=0)], + ezsigntemplatedocument_get_words_positions_v1_request: EzsigntemplatedocumentGetWordsPositionsV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve positions X,Y of given words from a Ezsigntemplatedocument + + :param pki_ezsigntemplatedocument_id: (required) :type pki_ezsigntemplatedocument_id: int :param ezsigntemplatedocument_get_words_positions_v1_request: (required) :type ezsigntemplatedocument_get_words_positions_v1_request: EzsigntemplatedocumentGetWordsPositionsV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsigntemplatedocumentGetWordsPositionsV1Response, status_code(int), headers(HTTPHeaderDict)) - """ - - _params = locals() + """ # noqa: E501 + + _param = self._ezsigntemplatedocument_get_words_positions_v1_serialize( + pki_ezsigntemplatedocument_id=pki_ezsigntemplatedocument_id, + ezsigntemplatedocument_get_words_positions_v1_request=ezsigntemplatedocument_get_words_positions_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _all_params = [ - 'pki_ezsigntemplatedocument_id', - 'ezsigntemplatedocument_get_words_positions_v1_request' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' - ] + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplatedocumentGetWordsPositionsV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) + return response_data.response - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsigntemplatedocument_get_words_positions_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] - _collection_formats = {} + def _ezsigntemplatedocument_get_words_positions_v1_serialize( + self, + pki_ezsigntemplatedocument_id, + ezsigntemplatedocument_get_words_positions_v1_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: - # process the path parameters - _path_params = {} - if _params['pki_ezsigntemplatedocument_id']: - _path_params['pkiEzsigntemplatedocumentID'] = _params['pki_ezsigntemplatedocument_id'] + _host = None + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if pki_ezsigntemplatedocument_id is not None: + _path_params['pkiEzsigntemplatedocumentID'] = pki_ezsigntemplatedocument_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['ezsigntemplatedocument_get_words_positions_v1_request'] is not None: - _body_params = _params['ezsigntemplatedocument_get_words_positions_v1_request'] + if ezsigntemplatedocument_get_words_positions_v1_request is not None: + _body_params = ezsigntemplatedocument_get_words_positions_v1_request + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '200': "EzsigntemplatedocumentGetWordsPositionsV1Response", - '404': "CommonResponseError", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/getWordsPositions', 'POST', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='POST', + resource_path='/1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/getWordsPositions', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + - @validate_arguments - def ezsigntemplatedocument_patch_object_v1(self, pki_ezsigntemplatedocument_id : conint(strict=True, ge=0), ezsigntemplatedocument_patch_object_v1_request : EzsigntemplatedocumentPatchObjectV1Request, **kwargs) -> EzsigntemplatedocumentPatchObjectV1Response: # noqa: E501 - """Patch an existing Ezsigntemplatedocument # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.ezsigntemplatedocument_patch_object_v1(pki_ezsigntemplatedocument_id, ezsigntemplatedocument_patch_object_v1_request, async_req=True) - >>> result = thread.get() + @validate_call + def ezsigntemplatedocument_patch_object_v1( + self, + pki_ezsigntemplatedocument_id: Annotated[int, Field(strict=True, ge=0)], + ezsigntemplatedocument_patch_object_v1_request: EzsigntemplatedocumentPatchObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsigntemplatedocumentPatchObjectV1Response: + """Patch an existing Ezsigntemplatedocument + + :param pki_ezsigntemplatedocument_id: (required) :type pki_ezsigntemplatedocument_id: int :param ezsigntemplatedocument_patch_object_v1_request: (required) :type ezsigntemplatedocument_patch_object_v1_request: EzsigntemplatedocumentPatchObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsigntemplatedocumentPatchObjectV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsigntemplatedocument_patch_object_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsigntemplatedocument_patch_object_v1_with_http_info(pki_ezsigntemplatedocument_id, ezsigntemplatedocument_patch_object_v1_request, **kwargs) # noqa: E501 - - @validate_arguments - def ezsigntemplatedocument_patch_object_v1_with_http_info(self, pki_ezsigntemplatedocument_id : conint(strict=True, ge=0), ezsigntemplatedocument_patch_object_v1_request : EzsigntemplatedocumentPatchObjectV1Request, **kwargs) -> ApiResponse: # noqa: E501 - """Patch an existing Ezsigntemplatedocument # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsigntemplatedocument_patch_object_v1_with_http_info(pki_ezsigntemplatedocument_id, ezsigntemplatedocument_patch_object_v1_request, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._ezsigntemplatedocument_patch_object_v1_serialize( + pki_ezsigntemplatedocument_id=pki_ezsigntemplatedocument_id, + ezsigntemplatedocument_patch_object_v1_request=ezsigntemplatedocument_patch_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplatedocumentPatchObjectV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsigntemplatedocument_patch_object_v1_with_http_info( + self, + pki_ezsigntemplatedocument_id: Annotated[int, Field(strict=True, ge=0)], + ezsigntemplatedocument_patch_object_v1_request: EzsigntemplatedocumentPatchObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsigntemplatedocumentPatchObjectV1Response]: + """Patch an existing Ezsigntemplatedocument + + :param pki_ezsigntemplatedocument_id: (required) :type pki_ezsigntemplatedocument_id: int :param ezsigntemplatedocument_patch_object_v1_request: (required) :type ezsigntemplatedocument_patch_object_v1_request: EzsigntemplatedocumentPatchObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsigntemplatedocumentPatchObjectV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._ezsigntemplatedocument_patch_object_v1_serialize( + pki_ezsigntemplatedocument_id=pki_ezsigntemplatedocument_id, + ezsigntemplatedocument_patch_object_v1_request=ezsigntemplatedocument_patch_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplatedocumentPatchObjectV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _params = locals() - _all_params = [ - 'pki_ezsigntemplatedocument_id', - 'ezsigntemplatedocument_patch_object_v1_request' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + @validate_call + def ezsigntemplatedocument_patch_object_v1_without_preload_content( + self, + pki_ezsigntemplatedocument_id: Annotated[int, Field(strict=True, ge=0)], + ezsigntemplatedocument_patch_object_v1_request: EzsigntemplatedocumentPatchObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Patch an existing Ezsigntemplatedocument + + + + :param pki_ezsigntemplatedocument_id: (required) + :type pki_ezsigntemplatedocument_id: int + :param ezsigntemplatedocument_patch_object_v1_request: (required) + :type ezsigntemplatedocument_patch_object_v1_request: EzsigntemplatedocumentPatchObjectV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsigntemplatedocument_patch_object_v1_serialize( + pki_ezsigntemplatedocument_id=pki_ezsigntemplatedocument_id, + ezsigntemplatedocument_patch_object_v1_request=ezsigntemplatedocument_patch_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsigntemplatedocument_patch_object_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplatedocumentPatchObjectV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_ezsigntemplatedocument_id']: - _path_params['pkiEzsigntemplatedocumentID'] = _params['pki_ezsigntemplatedocument_id'] + def _ezsigntemplatedocument_patch_object_v1_serialize( + self, + pki_ezsigntemplatedocument_id, + ezsigntemplatedocument_patch_object_v1_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if pki_ezsigntemplatedocument_id is not None: + _path_params['pkiEzsigntemplatedocumentID'] = pki_ezsigntemplatedocument_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['ezsigntemplatedocument_patch_object_v1_request'] is not None: - _body_params = _params['ezsigntemplatedocument_patch_object_v1_request'] + if ezsigntemplatedocument_patch_object_v1_request is not None: + _body_params = ezsigntemplatedocument_patch_object_v1_request + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '200': "EzsigntemplatedocumentPatchObjectV1Response", - '404': "CommonResponseError", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}', 'PATCH', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='PATCH', + resource_path='/1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/eZmaxApi/api/object_ezsigntemplateformfieldgroup_api.py b/eZmaxApi/api/object_ezsigntemplateformfieldgroup_api.py index 914145776..266cfcdab 100644 --- a/eZmaxApi/api/object_ezsigntemplateformfieldgroup_api.py +++ b/eZmaxApi/api/object_ezsigntemplateformfieldgroup_api.py @@ -13,14 +13,19 @@ """ # noqa: E501 -import re # noqa: F401 import io import warnings -from pydantic import validate_arguments, ValidationError +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Dict, List, Optional, Tuple, Union, Any -from pydantic import conint +try: + from typing import Annotated +except ImportError: + from typing_extensions import Annotated +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.ezsigntemplateformfieldgroup_create_object_v1_request import EzsigntemplateformfieldgroupCreateObjectV1Request from eZmaxApi.models.ezsigntemplateformfieldgroup_create_object_v1_response import EzsigntemplateformfieldgroupCreateObjectV1Response from eZmaxApi.models.ezsigntemplateformfieldgroup_delete_object_v1_response import EzsigntemplateformfieldgroupDeleteObjectV1Response @@ -30,10 +35,7 @@ from eZmaxApi.api_client import ApiClient from eZmaxApi.api_response import ApiResponse -from eZmaxApi.exceptions import ( # noqa: F401 - ApiTypeError, - ApiValueError -) +from eZmaxApi.rest import RESTResponseType class ObjectEzsigntemplateformfieldgroupApi: @@ -48,588 +50,1087 @@ def __init__(self, api_client=None) -> None: api_client = ApiClient.get_default() self.api_client = api_client - @validate_arguments - def ezsigntemplateformfieldgroup_create_object_v1(self, ezsigntemplateformfieldgroup_create_object_v1_request : EzsigntemplateformfieldgroupCreateObjectV1Request, **kwargs) -> EzsigntemplateformfieldgroupCreateObjectV1Response: # noqa: E501 - """Create a new Ezsigntemplateformfieldgroup # noqa: E501 - The endpoint allows to create one or many elements at once. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def ezsigntemplateformfieldgroup_create_object_v1( + self, + ezsigntemplateformfieldgroup_create_object_v1_request: EzsigntemplateformfieldgroupCreateObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsigntemplateformfieldgroupCreateObjectV1Response: + """Create a new Ezsigntemplateformfieldgroup - >>> thread = api.ezsigntemplateformfieldgroup_create_object_v1(ezsigntemplateformfieldgroup_create_object_v1_request, async_req=True) - >>> result = thread.get() + The endpoint allows to create one or many elements at once. :param ezsigntemplateformfieldgroup_create_object_v1_request: (required) :type ezsigntemplateformfieldgroup_create_object_v1_request: EzsigntemplateformfieldgroupCreateObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsigntemplateformfieldgroupCreateObjectV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsigntemplateformfieldgroup_create_object_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsigntemplateformfieldgroup_create_object_v1_with_http_info(ezsigntemplateformfieldgroup_create_object_v1_request, **kwargs) # noqa: E501 - - @validate_arguments - def ezsigntemplateformfieldgroup_create_object_v1_with_http_info(self, ezsigntemplateformfieldgroup_create_object_v1_request : EzsigntemplateformfieldgroupCreateObjectV1Request, **kwargs) -> ApiResponse: # noqa: E501 - """Create a new Ezsigntemplateformfieldgroup # noqa: E501 - - The endpoint allows to create one or many elements at once. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsigntemplateformfieldgroup_create_object_v1_with_http_info(ezsigntemplateformfieldgroup_create_object_v1_request, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._ezsigntemplateformfieldgroup_create_object_v1_serialize( + ezsigntemplateformfieldgroup_create_object_v1_request=ezsigntemplateformfieldgroup_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "EzsigntemplateformfieldgroupCreateObjectV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsigntemplateformfieldgroup_create_object_v1_with_http_info( + self, + ezsigntemplateformfieldgroup_create_object_v1_request: EzsigntemplateformfieldgroupCreateObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsigntemplateformfieldgroupCreateObjectV1Response]: + """Create a new Ezsigntemplateformfieldgroup + + The endpoint allows to create one or many elements at once. :param ezsigntemplateformfieldgroup_create_object_v1_request: (required) :type ezsigntemplateformfieldgroup_create_object_v1_request: EzsigntemplateformfieldgroupCreateObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsigntemplateformfieldgroupCreateObjectV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._ezsigntemplateformfieldgroup_create_object_v1_serialize( + ezsigntemplateformfieldgroup_create_object_v1_request=ezsigntemplateformfieldgroup_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '201': "EzsigntemplateformfieldgroupCreateObjectV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'ezsigntemplateformfieldgroup_create_object_v1_request' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def ezsigntemplateformfieldgroup_create_object_v1_without_preload_content( + self, + ezsigntemplateformfieldgroup_create_object_v1_request: EzsigntemplateformfieldgroupCreateObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Create a new Ezsigntemplateformfieldgroup + + The endpoint allows to create one or many elements at once. + + :param ezsigntemplateformfieldgroup_create_object_v1_request: (required) + :type ezsigntemplateformfieldgroup_create_object_v1_request: EzsigntemplateformfieldgroupCreateObjectV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsigntemplateformfieldgroup_create_object_v1_serialize( + ezsigntemplateformfieldgroup_create_object_v1_request=ezsigntemplateformfieldgroup_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsigntemplateformfieldgroup_create_object_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '201': "EzsigntemplateformfieldgroupCreateObjectV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} + def _ezsigntemplateformfieldgroup_create_object_v1_serialize( + self, + ezsigntemplateformfieldgroup_create_object_v1_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['ezsigntemplateformfieldgroup_create_object_v1_request'] is not None: - _body_params = _params['ezsigntemplateformfieldgroup_create_object_v1_request'] + if ezsigntemplateformfieldgroup_create_object_v1_request is not None: + _body_params = ezsigntemplateformfieldgroup_create_object_v1_request + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '201': "EzsigntemplateformfieldgroupCreateObjectV1Response", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsigntemplateformfieldgroup', 'POST', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='POST', + resource_path='/1/object/ezsigntemplateformfieldgroup', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) - @validate_arguments - def ezsigntemplateformfieldgroup_delete_object_v1(self, pki_ezsigntemplateformfieldgroup_id : conint(strict=True, ge=0), **kwargs) -> EzsigntemplateformfieldgroupDeleteObjectV1Response: # noqa: E501 - """Delete an existing Ezsigntemplateformfieldgroup # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.ezsigntemplateformfieldgroup_delete_object_v1(pki_ezsigntemplateformfieldgroup_id, async_req=True) - >>> result = thread.get() + + @validate_call + def ezsigntemplateformfieldgroup_delete_object_v1( + self, + pki_ezsigntemplateformfieldgroup_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsigntemplateformfieldgroupDeleteObjectV1Response: + """Delete an existing Ezsigntemplateformfieldgroup + + :param pki_ezsigntemplateformfieldgroup_id: (required) :type pki_ezsigntemplateformfieldgroup_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsigntemplateformfieldgroupDeleteObjectV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsigntemplateformfieldgroup_delete_object_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsigntemplateformfieldgroup_delete_object_v1_with_http_info(pki_ezsigntemplateformfieldgroup_id, **kwargs) # noqa: E501 - - @validate_arguments - def ezsigntemplateformfieldgroup_delete_object_v1_with_http_info(self, pki_ezsigntemplateformfieldgroup_id : conint(strict=True, ge=0), **kwargs) -> ApiResponse: # noqa: E501 - """Delete an existing Ezsigntemplateformfieldgroup # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsigntemplateformfieldgroup_delete_object_v1_with_http_info(pki_ezsigntemplateformfieldgroup_id, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._ezsigntemplateformfieldgroup_delete_object_v1_serialize( + pki_ezsigntemplateformfieldgroup_id=pki_ezsigntemplateformfieldgroup_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplateformfieldgroupDeleteObjectV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsigntemplateformfieldgroup_delete_object_v1_with_http_info( + self, + pki_ezsigntemplateformfieldgroup_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsigntemplateformfieldgroupDeleteObjectV1Response]: + """Delete an existing Ezsigntemplateformfieldgroup + + :param pki_ezsigntemplateformfieldgroup_id: (required) :type pki_ezsigntemplateformfieldgroup_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsigntemplateformfieldgroupDeleteObjectV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._ezsigntemplateformfieldgroup_delete_object_v1_serialize( + pki_ezsigntemplateformfieldgroup_id=pki_ezsigntemplateformfieldgroup_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplateformfieldgroupDeleteObjectV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'pki_ezsigntemplateformfieldgroup_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def ezsigntemplateformfieldgroup_delete_object_v1_without_preload_content( + self, + pki_ezsigntemplateformfieldgroup_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete an existing Ezsigntemplateformfieldgroup + + + + :param pki_ezsigntemplateformfieldgroup_id: (required) + :type pki_ezsigntemplateformfieldgroup_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsigntemplateformfieldgroup_delete_object_v1_serialize( + pki_ezsigntemplateformfieldgroup_id=pki_ezsigntemplateformfieldgroup_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsigntemplateformfieldgroup_delete_object_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplateformfieldgroupDeleteObjectV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_ezsigntemplateformfieldgroup_id']: - _path_params['pkiEzsigntemplateformfieldgroupID'] = _params['pki_ezsigntemplateformfieldgroup_id'] + def _ezsigntemplateformfieldgroup_delete_object_v1_serialize( + self, + pki_ezsigntemplateformfieldgroup_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if pki_ezsigntemplateformfieldgroup_id is not None: + _path_params['pkiEzsigntemplateformfieldgroupID'] = pki_ezsigntemplateformfieldgroup_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "EzsigntemplateformfieldgroupDeleteObjectV1Response", - '404': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsigntemplateformfieldgroup/{pkiEzsigntemplateformfieldgroupID}', 'DELETE', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='DELETE', + resource_path='/1/object/ezsigntemplateformfieldgroup/{pkiEzsigntemplateformfieldgroupID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) - @validate_arguments - def ezsigntemplateformfieldgroup_edit_object_v1(self, pki_ezsigntemplateformfieldgroup_id : conint(strict=True, ge=0), ezsigntemplateformfieldgroup_edit_object_v1_request : EzsigntemplateformfieldgroupEditObjectV1Request, **kwargs) -> EzsigntemplateformfieldgroupEditObjectV1Response: # noqa: E501 - """Edit an existing Ezsigntemplateformfieldgroup # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.ezsigntemplateformfieldgroup_edit_object_v1(pki_ezsigntemplateformfieldgroup_id, ezsigntemplateformfieldgroup_edit_object_v1_request, async_req=True) - >>> result = thread.get() + + @validate_call + def ezsigntemplateformfieldgroup_edit_object_v1( + self, + pki_ezsigntemplateformfieldgroup_id: Annotated[int, Field(strict=True, ge=0)], + ezsigntemplateformfieldgroup_edit_object_v1_request: EzsigntemplateformfieldgroupEditObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsigntemplateformfieldgroupEditObjectV1Response: + """Edit an existing Ezsigntemplateformfieldgroup + + :param pki_ezsigntemplateformfieldgroup_id: (required) :type pki_ezsigntemplateformfieldgroup_id: int :param ezsigntemplateformfieldgroup_edit_object_v1_request: (required) :type ezsigntemplateformfieldgroup_edit_object_v1_request: EzsigntemplateformfieldgroupEditObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsigntemplateformfieldgroupEditObjectV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsigntemplateformfieldgroup_edit_object_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsigntemplateformfieldgroup_edit_object_v1_with_http_info(pki_ezsigntemplateformfieldgroup_id, ezsigntemplateformfieldgroup_edit_object_v1_request, **kwargs) # noqa: E501 - - @validate_arguments - def ezsigntemplateformfieldgroup_edit_object_v1_with_http_info(self, pki_ezsigntemplateformfieldgroup_id : conint(strict=True, ge=0), ezsigntemplateformfieldgroup_edit_object_v1_request : EzsigntemplateformfieldgroupEditObjectV1Request, **kwargs) -> ApiResponse: # noqa: E501 - """Edit an existing Ezsigntemplateformfieldgroup # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsigntemplateformfieldgroup_edit_object_v1_with_http_info(pki_ezsigntemplateformfieldgroup_id, ezsigntemplateformfieldgroup_edit_object_v1_request, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._ezsigntemplateformfieldgroup_edit_object_v1_serialize( + pki_ezsigntemplateformfieldgroup_id=pki_ezsigntemplateformfieldgroup_id, + ezsigntemplateformfieldgroup_edit_object_v1_request=ezsigntemplateformfieldgroup_edit_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplateformfieldgroupEditObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsigntemplateformfieldgroup_edit_object_v1_with_http_info( + self, + pki_ezsigntemplateformfieldgroup_id: Annotated[int, Field(strict=True, ge=0)], + ezsigntemplateformfieldgroup_edit_object_v1_request: EzsigntemplateformfieldgroupEditObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsigntemplateformfieldgroupEditObjectV1Response]: + """Edit an existing Ezsigntemplateformfieldgroup + + :param pki_ezsigntemplateformfieldgroup_id: (required) :type pki_ezsigntemplateformfieldgroup_id: int :param ezsigntemplateformfieldgroup_edit_object_v1_request: (required) :type ezsigntemplateformfieldgroup_edit_object_v1_request: EzsigntemplateformfieldgroupEditObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsigntemplateformfieldgroupEditObjectV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._ezsigntemplateformfieldgroup_edit_object_v1_serialize( + pki_ezsigntemplateformfieldgroup_id=pki_ezsigntemplateformfieldgroup_id, + ezsigntemplateformfieldgroup_edit_object_v1_request=ezsigntemplateformfieldgroup_edit_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplateformfieldgroupEditObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'pki_ezsigntemplateformfieldgroup_id', - 'ezsigntemplateformfieldgroup_edit_object_v1_request' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def ezsigntemplateformfieldgroup_edit_object_v1_without_preload_content( + self, + pki_ezsigntemplateformfieldgroup_id: Annotated[int, Field(strict=True, ge=0)], + ezsigntemplateformfieldgroup_edit_object_v1_request: EzsigntemplateformfieldgroupEditObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Edit an existing Ezsigntemplateformfieldgroup + + + + :param pki_ezsigntemplateformfieldgroup_id: (required) + :type pki_ezsigntemplateformfieldgroup_id: int + :param ezsigntemplateformfieldgroup_edit_object_v1_request: (required) + :type ezsigntemplateformfieldgroup_edit_object_v1_request: EzsigntemplateformfieldgroupEditObjectV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsigntemplateformfieldgroup_edit_object_v1_serialize( + pki_ezsigntemplateformfieldgroup_id=pki_ezsigntemplateformfieldgroup_id, + ezsigntemplateformfieldgroup_edit_object_v1_request=ezsigntemplateformfieldgroup_edit_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsigntemplateformfieldgroup_edit_object_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplateformfieldgroupEditObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_ezsigntemplateformfieldgroup_id']: - _path_params['pkiEzsigntemplateformfieldgroupID'] = _params['pki_ezsigntemplateformfieldgroup_id'] + def _ezsigntemplateformfieldgroup_edit_object_v1_serialize( + self, + pki_ezsigntemplateformfieldgroup_id, + ezsigntemplateformfieldgroup_edit_object_v1_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_ezsigntemplateformfieldgroup_id is not None: + _path_params['pkiEzsigntemplateformfieldgroupID'] = pki_ezsigntemplateformfieldgroup_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['ezsigntemplateformfieldgroup_edit_object_v1_request'] is not None: - _body_params = _params['ezsigntemplateformfieldgroup_edit_object_v1_request'] + if ezsigntemplateformfieldgroup_edit_object_v1_request is not None: + _body_params = ezsigntemplateformfieldgroup_edit_object_v1_request + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '200': "EzsigntemplateformfieldgroupEditObjectV1Response", - '404': "CommonResponseError", - '422': "CommonResponseError", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsigntemplateformfieldgroup/{pkiEzsigntemplateformfieldgroupID}', 'PUT', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='PUT', + resource_path='/1/object/ezsigntemplateformfieldgroup/{pkiEzsigntemplateformfieldgroupID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + - @validate_arguments - def ezsigntemplateformfieldgroup_get_object_v2(self, pki_ezsigntemplateformfieldgroup_id : conint(strict=True, ge=0), **kwargs) -> EzsigntemplateformfieldgroupGetObjectV2Response: # noqa: E501 - """Retrieve an existing Ezsigntemplateformfieldgroup # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def ezsigntemplateformfieldgroup_get_object_v2( + self, + pki_ezsigntemplateformfieldgroup_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsigntemplateformfieldgroupGetObjectV2Response: + """Retrieve an existing Ezsigntemplateformfieldgroup - >>> thread = api.ezsigntemplateformfieldgroup_get_object_v2(pki_ezsigntemplateformfieldgroup_id, async_req=True) - >>> result = thread.get() + :param pki_ezsigntemplateformfieldgroup_id: (required) :type pki_ezsigntemplateformfieldgroup_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsigntemplateformfieldgroupGetObjectV2Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsigntemplateformfieldgroup_get_object_v2_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsigntemplateformfieldgroup_get_object_v2_with_http_info(pki_ezsigntemplateformfieldgroup_id, **kwargs) # noqa: E501 - - @validate_arguments - def ezsigntemplateformfieldgroup_get_object_v2_with_http_info(self, pki_ezsigntemplateformfieldgroup_id : conint(strict=True, ge=0), **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve an existing Ezsigntemplateformfieldgroup # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsigntemplateformfieldgroup_get_object_v2_with_http_info(pki_ezsigntemplateformfieldgroup_id, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._ezsigntemplateformfieldgroup_get_object_v2_serialize( + pki_ezsigntemplateformfieldgroup_id=pki_ezsigntemplateformfieldgroup_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplateformfieldgroupGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsigntemplateformfieldgroup_get_object_v2_with_http_info( + self, + pki_ezsigntemplateformfieldgroup_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsigntemplateformfieldgroupGetObjectV2Response]: + """Retrieve an existing Ezsigntemplateformfieldgroup + + :param pki_ezsigntemplateformfieldgroup_id: (required) :type pki_ezsigntemplateformfieldgroup_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsigntemplateformfieldgroupGetObjectV2Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._ezsigntemplateformfieldgroup_get_object_v2_serialize( + pki_ezsigntemplateformfieldgroup_id=pki_ezsigntemplateformfieldgroup_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplateformfieldgroupGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'pki_ezsigntemplateformfieldgroup_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def ezsigntemplateformfieldgroup_get_object_v2_without_preload_content( + self, + pki_ezsigntemplateformfieldgroup_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve an existing Ezsigntemplateformfieldgroup + + + + :param pki_ezsigntemplateformfieldgroup_id: (required) + :type pki_ezsigntemplateformfieldgroup_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsigntemplateformfieldgroup_get_object_v2_serialize( + pki_ezsigntemplateformfieldgroup_id=pki_ezsigntemplateformfieldgroup_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsigntemplateformfieldgroup_get_object_v2" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplateformfieldgroupGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_ezsigntemplateformfieldgroup_id']: - _path_params['pkiEzsigntemplateformfieldgroupID'] = _params['pki_ezsigntemplateformfieldgroup_id'] + def _ezsigntemplateformfieldgroup_get_object_v2_serialize( + self, + pki_ezsigntemplateformfieldgroup_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_ezsigntemplateformfieldgroup_id is not None: + _path_params['pkiEzsigntemplateformfieldgroupID'] = pki_ezsigntemplateformfieldgroup_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "EzsigntemplateformfieldgroupGetObjectV2Response", - '404': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/2/object/ezsigntemplateformfieldgroup/{pkiEzsigntemplateformfieldgroupID}', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/2/object/ezsigntemplateformfieldgroup/{pkiEzsigntemplateformfieldgroupID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/eZmaxApi/api/object_ezsigntemplatepackage_api.py b/eZmaxApi/api/object_ezsigntemplatepackage_api.py index 850eee7a2..22e3363f3 100644 --- a/eZmaxApi/api/object_ezsigntemplatepackage_api.py +++ b/eZmaxApi/api/object_ezsigntemplatepackage_api.py @@ -13,14 +13,20 @@ """ # noqa: E501 -import re # noqa: F401 import io import warnings -from pydantic import validate_arguments, ValidationError +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Dict, List, Optional, Tuple, Union, Any +try: + from typing import Annotated +except ImportError: + from typing_extensions import Annotated + +from pydantic import Field from typing_extensions import Annotated -from pydantic import Field, StrictStr, conint +from pydantic import StrictStr, field_validator from typing import Optional @@ -38,10 +44,7 @@ from eZmaxApi.api_client import ApiClient from eZmaxApi.api_response import ApiResponse -from eZmaxApi.exceptions import ( # noqa: F401 - ApiTypeError, - ApiValueError -) +from eZmaxApi.rest import RESTResponseType class ObjectEzsigntemplatepackageApi: @@ -56,618 +59,1146 @@ def __init__(self, api_client=None) -> None: api_client = ApiClient.get_default() self.api_client = api_client - @validate_arguments - def ezsigntemplatepackage_create_object_v1(self, ezsigntemplatepackage_create_object_v1_request : EzsigntemplatepackageCreateObjectV1Request, **kwargs) -> EzsigntemplatepackageCreateObjectV1Response: # noqa: E501 - """Create a new Ezsigntemplatepackage # noqa: E501 - The endpoint allows to create one or many elements at once. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def ezsigntemplatepackage_create_object_v1( + self, + ezsigntemplatepackage_create_object_v1_request: EzsigntemplatepackageCreateObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsigntemplatepackageCreateObjectV1Response: + """Create a new Ezsigntemplatepackage - >>> thread = api.ezsigntemplatepackage_create_object_v1(ezsigntemplatepackage_create_object_v1_request, async_req=True) - >>> result = thread.get() + The endpoint allows to create one or many elements at once. :param ezsigntemplatepackage_create_object_v1_request: (required) :type ezsigntemplatepackage_create_object_v1_request: EzsigntemplatepackageCreateObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsigntemplatepackageCreateObjectV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsigntemplatepackage_create_object_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsigntemplatepackage_create_object_v1_with_http_info(ezsigntemplatepackage_create_object_v1_request, **kwargs) # noqa: E501 - - @validate_arguments - def ezsigntemplatepackage_create_object_v1_with_http_info(self, ezsigntemplatepackage_create_object_v1_request : EzsigntemplatepackageCreateObjectV1Request, **kwargs) -> ApiResponse: # noqa: E501 - """Create a new Ezsigntemplatepackage # noqa: E501 - - The endpoint allows to create one or many elements at once. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsigntemplatepackage_create_object_v1_with_http_info(ezsigntemplatepackage_create_object_v1_request, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._ezsigntemplatepackage_create_object_v1_serialize( + ezsigntemplatepackage_create_object_v1_request=ezsigntemplatepackage_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "EzsigntemplatepackageCreateObjectV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsigntemplatepackage_create_object_v1_with_http_info( + self, + ezsigntemplatepackage_create_object_v1_request: EzsigntemplatepackageCreateObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsigntemplatepackageCreateObjectV1Response]: + """Create a new Ezsigntemplatepackage + + The endpoint allows to create one or many elements at once. :param ezsigntemplatepackage_create_object_v1_request: (required) :type ezsigntemplatepackage_create_object_v1_request: EzsigntemplatepackageCreateObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsigntemplatepackageCreateObjectV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._ezsigntemplatepackage_create_object_v1_serialize( + ezsigntemplatepackage_create_object_v1_request=ezsigntemplatepackage_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "EzsigntemplatepackageCreateObjectV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _params = locals() - _all_params = [ - 'ezsigntemplatepackage_create_object_v1_request' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + @validate_call + def ezsigntemplatepackage_create_object_v1_without_preload_content( + self, + ezsigntemplatepackage_create_object_v1_request: EzsigntemplatepackageCreateObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Create a new Ezsigntemplatepackage + + The endpoint allows to create one or many elements at once. + + :param ezsigntemplatepackage_create_object_v1_request: (required) + :type ezsigntemplatepackage_create_object_v1_request: EzsigntemplatepackageCreateObjectV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsigntemplatepackage_create_object_v1_serialize( + ezsigntemplatepackage_create_object_v1_request=ezsigntemplatepackage_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsigntemplatepackage_create_object_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '201': "EzsigntemplatepackageCreateObjectV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} + def _ezsigntemplatepackage_create_object_v1_serialize( + self, + ezsigntemplatepackage_create_object_v1_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['ezsigntemplatepackage_create_object_v1_request'] is not None: - _body_params = _params['ezsigntemplatepackage_create_object_v1_request'] + if ezsigntemplatepackage_create_object_v1_request is not None: + _body_params = ezsigntemplatepackage_create_object_v1_request + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '201': "EzsigntemplatepackageCreateObjectV1Response", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsigntemplatepackage', 'POST', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='POST', + resource_path='/1/object/ezsigntemplatepackage', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) - @validate_arguments - def ezsigntemplatepackage_delete_object_v1(self, pki_ezsigntemplatepackage_id : conint(strict=True, ge=0), **kwargs) -> EzsigntemplatepackageDeleteObjectV1Response: # noqa: E501 - """Delete an existing Ezsigntemplatepackage # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.ezsigntemplatepackage_delete_object_v1(pki_ezsigntemplatepackage_id, async_req=True) - >>> result = thread.get() + + @validate_call + def ezsigntemplatepackage_delete_object_v1( + self, + pki_ezsigntemplatepackage_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsigntemplatepackageDeleteObjectV1Response: + """Delete an existing Ezsigntemplatepackage + + :param pki_ezsigntemplatepackage_id: (required) :type pki_ezsigntemplatepackage_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsigntemplatepackageDeleteObjectV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsigntemplatepackage_delete_object_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsigntemplatepackage_delete_object_v1_with_http_info(pki_ezsigntemplatepackage_id, **kwargs) # noqa: E501 - - @validate_arguments - def ezsigntemplatepackage_delete_object_v1_with_http_info(self, pki_ezsigntemplatepackage_id : conint(strict=True, ge=0), **kwargs) -> ApiResponse: # noqa: E501 - """Delete an existing Ezsigntemplatepackage # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsigntemplatepackage_delete_object_v1_with_http_info(pki_ezsigntemplatepackage_id, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._ezsigntemplatepackage_delete_object_v1_serialize( + pki_ezsigntemplatepackage_id=pki_ezsigntemplatepackage_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplatepackageDeleteObjectV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsigntemplatepackage_delete_object_v1_with_http_info( + self, + pki_ezsigntemplatepackage_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsigntemplatepackageDeleteObjectV1Response]: + """Delete an existing Ezsigntemplatepackage + + :param pki_ezsigntemplatepackage_id: (required) :type pki_ezsigntemplatepackage_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsigntemplatepackageDeleteObjectV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._ezsigntemplatepackage_delete_object_v1_serialize( + pki_ezsigntemplatepackage_id=pki_ezsigntemplatepackage_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplatepackageDeleteObjectV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _params = locals() - _all_params = [ - 'pki_ezsigntemplatepackage_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + @validate_call + def ezsigntemplatepackage_delete_object_v1_without_preload_content( + self, + pki_ezsigntemplatepackage_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete an existing Ezsigntemplatepackage + + + + :param pki_ezsigntemplatepackage_id: (required) + :type pki_ezsigntemplatepackage_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsigntemplatepackage_delete_object_v1_serialize( + pki_ezsigntemplatepackage_id=pki_ezsigntemplatepackage_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsigntemplatepackage_delete_object_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplatepackageDeleteObjectV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_ezsigntemplatepackage_id']: - _path_params['pkiEzsigntemplatepackageID'] = _params['pki_ezsigntemplatepackage_id'] + def _ezsigntemplatepackage_delete_object_v1_serialize( + self, + pki_ezsigntemplatepackage_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if pki_ezsigntemplatepackage_id is not None: + _path_params['pkiEzsigntemplatepackageID'] = pki_ezsigntemplatepackage_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "EzsigntemplatepackageDeleteObjectV1Response", - '404': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsigntemplatepackage/{pkiEzsigntemplatepackageID}', 'DELETE', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='DELETE', + resource_path='/1/object/ezsigntemplatepackage/{pkiEzsigntemplatepackageID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) - @validate_arguments - def ezsigntemplatepackage_edit_ezsigntemplatepackagesigners_v1(self, pki_ezsigntemplatepackage_id : conint(strict=True, ge=0), ezsigntemplatepackage_edit_ezsigntemplatepackagesigners_v1_request : EzsigntemplatepackageEditEzsigntemplatepackagesignersV1Request, **kwargs) -> EzsigntemplatepackageEditEzsigntemplatepackagesignersV1Response: # noqa: E501 - """Edit multiple Ezsigntemplatepackagesigners # noqa: E501 - Using this endpoint, you can edit multiple Ezsigntemplatepackagesigners at the same time. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.ezsigntemplatepackage_edit_ezsigntemplatepackagesigners_v1(pki_ezsigntemplatepackage_id, ezsigntemplatepackage_edit_ezsigntemplatepackagesigners_v1_request, async_req=True) - >>> result = thread.get() + + @validate_call + def ezsigntemplatepackage_edit_ezsigntemplatepackagesigners_v1( + self, + pki_ezsigntemplatepackage_id: Annotated[int, Field(strict=True, ge=0)], + ezsigntemplatepackage_edit_ezsigntemplatepackagesigners_v1_request: EzsigntemplatepackageEditEzsigntemplatepackagesignersV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsigntemplatepackageEditEzsigntemplatepackagesignersV1Response: + """Edit multiple Ezsigntemplatepackagesigners + + Using this endpoint, you can edit multiple Ezsigntemplatepackagesigners at the same time. :param pki_ezsigntemplatepackage_id: (required) :type pki_ezsigntemplatepackage_id: int :param ezsigntemplatepackage_edit_ezsigntemplatepackagesigners_v1_request: (required) :type ezsigntemplatepackage_edit_ezsigntemplatepackagesigners_v1_request: EzsigntemplatepackageEditEzsigntemplatepackagesignersV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsigntemplatepackageEditEzsigntemplatepackagesignersV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsigntemplatepackage_edit_ezsigntemplatepackagesigners_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsigntemplatepackage_edit_ezsigntemplatepackagesigners_v1_with_http_info(pki_ezsigntemplatepackage_id, ezsigntemplatepackage_edit_ezsigntemplatepackagesigners_v1_request, **kwargs) # noqa: E501 - - @validate_arguments - def ezsigntemplatepackage_edit_ezsigntemplatepackagesigners_v1_with_http_info(self, pki_ezsigntemplatepackage_id : conint(strict=True, ge=0), ezsigntemplatepackage_edit_ezsigntemplatepackagesigners_v1_request : EzsigntemplatepackageEditEzsigntemplatepackagesignersV1Request, **kwargs) -> ApiResponse: # noqa: E501 - """Edit multiple Ezsigntemplatepackagesigners # noqa: E501 - - Using this endpoint, you can edit multiple Ezsigntemplatepackagesigners at the same time. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsigntemplatepackage_edit_ezsigntemplatepackagesigners_v1_with_http_info(pki_ezsigntemplatepackage_id, ezsigntemplatepackage_edit_ezsigntemplatepackagesigners_v1_request, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._ezsigntemplatepackage_edit_ezsigntemplatepackagesigners_v1_serialize( + pki_ezsigntemplatepackage_id=pki_ezsigntemplatepackage_id, + ezsigntemplatepackage_edit_ezsigntemplatepackagesigners_v1_request=ezsigntemplatepackage_edit_ezsigntemplatepackagesigners_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplatepackageEditEzsigntemplatepackagesignersV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsigntemplatepackage_edit_ezsigntemplatepackagesigners_v1_with_http_info( + self, + pki_ezsigntemplatepackage_id: Annotated[int, Field(strict=True, ge=0)], + ezsigntemplatepackage_edit_ezsigntemplatepackagesigners_v1_request: EzsigntemplatepackageEditEzsigntemplatepackagesignersV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsigntemplatepackageEditEzsigntemplatepackagesignersV1Response]: + """Edit multiple Ezsigntemplatepackagesigners + + Using this endpoint, you can edit multiple Ezsigntemplatepackagesigners at the same time. :param pki_ezsigntemplatepackage_id: (required) :type pki_ezsigntemplatepackage_id: int :param ezsigntemplatepackage_edit_ezsigntemplatepackagesigners_v1_request: (required) :type ezsigntemplatepackage_edit_ezsigntemplatepackagesigners_v1_request: EzsigntemplatepackageEditEzsigntemplatepackagesignersV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsigntemplatepackageEditEzsigntemplatepackagesignersV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._ezsigntemplatepackage_edit_ezsigntemplatepackagesigners_v1_serialize( + pki_ezsigntemplatepackage_id=pki_ezsigntemplatepackage_id, + ezsigntemplatepackage_edit_ezsigntemplatepackagesigners_v1_request=ezsigntemplatepackage_edit_ezsigntemplatepackagesigners_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplatepackageEditEzsigntemplatepackagesignersV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'pki_ezsigntemplatepackage_id', - 'ezsigntemplatepackage_edit_ezsigntemplatepackagesigners_v1_request' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def ezsigntemplatepackage_edit_ezsigntemplatepackagesigners_v1_without_preload_content( + self, + pki_ezsigntemplatepackage_id: Annotated[int, Field(strict=True, ge=0)], + ezsigntemplatepackage_edit_ezsigntemplatepackagesigners_v1_request: EzsigntemplatepackageEditEzsigntemplatepackagesignersV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Edit multiple Ezsigntemplatepackagesigners + + Using this endpoint, you can edit multiple Ezsigntemplatepackagesigners at the same time. + + :param pki_ezsigntemplatepackage_id: (required) + :type pki_ezsigntemplatepackage_id: int + :param ezsigntemplatepackage_edit_ezsigntemplatepackagesigners_v1_request: (required) + :type ezsigntemplatepackage_edit_ezsigntemplatepackagesigners_v1_request: EzsigntemplatepackageEditEzsigntemplatepackagesignersV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsigntemplatepackage_edit_ezsigntemplatepackagesigners_v1_serialize( + pki_ezsigntemplatepackage_id=pki_ezsigntemplatepackage_id, + ezsigntemplatepackage_edit_ezsigntemplatepackagesigners_v1_request=ezsigntemplatepackage_edit_ezsigntemplatepackagesigners_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsigntemplatepackage_edit_ezsigntemplatepackagesigners_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplatepackageEditEzsigntemplatepackagesignersV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_ezsigntemplatepackage_id']: - _path_params['pkiEzsigntemplatepackageID'] = _params['pki_ezsigntemplatepackage_id'] + def _ezsigntemplatepackage_edit_ezsigntemplatepackagesigners_v1_serialize( + self, + pki_ezsigntemplatepackage_id, + ezsigntemplatepackage_edit_ezsigntemplatepackagesigners_v1_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if pki_ezsigntemplatepackage_id is not None: + _path_params['pkiEzsigntemplatepackageID'] = pki_ezsigntemplatepackage_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['ezsigntemplatepackage_edit_ezsigntemplatepackagesigners_v1_request'] is not None: - _body_params = _params['ezsigntemplatepackage_edit_ezsigntemplatepackagesigners_v1_request'] + if ezsigntemplatepackage_edit_ezsigntemplatepackagesigners_v1_request is not None: + _body_params = ezsigntemplatepackage_edit_ezsigntemplatepackagesigners_v1_request + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '200': "EzsigntemplatepackageEditEzsigntemplatepackagesignersV1Response", - '404': "CommonResponseError", - '422': "CommonResponseError", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsigntemplatepackage/{pkiEzsigntemplatepackageID}/editEzsigntemplatepackagesigners', 'PUT', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='PUT', + resource_path='/1/object/ezsigntemplatepackage/{pkiEzsigntemplatepackageID}/editEzsigntemplatepackagesigners', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) - @validate_arguments - def ezsigntemplatepackage_edit_object_v1(self, pki_ezsigntemplatepackage_id : conint(strict=True, ge=0), ezsigntemplatepackage_edit_object_v1_request : EzsigntemplatepackageEditObjectV1Request, **kwargs) -> EzsigntemplatepackageEditObjectV1Response: # noqa: E501 - """Edit an existing Ezsigntemplatepackage # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.ezsigntemplatepackage_edit_object_v1(pki_ezsigntemplatepackage_id, ezsigntemplatepackage_edit_object_v1_request, async_req=True) - >>> result = thread.get() + + @validate_call + def ezsigntemplatepackage_edit_object_v1( + self, + pki_ezsigntemplatepackage_id: Annotated[int, Field(strict=True, ge=0)], + ezsigntemplatepackage_edit_object_v1_request: EzsigntemplatepackageEditObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsigntemplatepackageEditObjectV1Response: + """Edit an existing Ezsigntemplatepackage + + :param pki_ezsigntemplatepackage_id: (required) :type pki_ezsigntemplatepackage_id: int :param ezsigntemplatepackage_edit_object_v1_request: (required) :type ezsigntemplatepackage_edit_object_v1_request: EzsigntemplatepackageEditObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsigntemplatepackageEditObjectV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsigntemplatepackage_edit_object_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsigntemplatepackage_edit_object_v1_with_http_info(pki_ezsigntemplatepackage_id, ezsigntemplatepackage_edit_object_v1_request, **kwargs) # noqa: E501 - - @validate_arguments - def ezsigntemplatepackage_edit_object_v1_with_http_info(self, pki_ezsigntemplatepackage_id : conint(strict=True, ge=0), ezsigntemplatepackage_edit_object_v1_request : EzsigntemplatepackageEditObjectV1Request, **kwargs) -> ApiResponse: # noqa: E501 - """Edit an existing Ezsigntemplatepackage # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsigntemplatepackage_edit_object_v1_with_http_info(pki_ezsigntemplatepackage_id, ezsigntemplatepackage_edit_object_v1_request, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._ezsigntemplatepackage_edit_object_v1_serialize( + pki_ezsigntemplatepackage_id=pki_ezsigntemplatepackage_id, + ezsigntemplatepackage_edit_object_v1_request=ezsigntemplatepackage_edit_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplatepackageEditObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsigntemplatepackage_edit_object_v1_with_http_info( + self, + pki_ezsigntemplatepackage_id: Annotated[int, Field(strict=True, ge=0)], + ezsigntemplatepackage_edit_object_v1_request: EzsigntemplatepackageEditObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsigntemplatepackageEditObjectV1Response]: + """Edit an existing Ezsigntemplatepackage + + :param pki_ezsigntemplatepackage_id: (required) :type pki_ezsigntemplatepackage_id: int :param ezsigntemplatepackage_edit_object_v1_request: (required) :type ezsigntemplatepackage_edit_object_v1_request: EzsigntemplatepackageEditObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsigntemplatepackageEditObjectV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._ezsigntemplatepackage_edit_object_v1_serialize( + pki_ezsigntemplatepackage_id=pki_ezsigntemplatepackage_id, + ezsigntemplatepackage_edit_object_v1_request=ezsigntemplatepackage_edit_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplatepackageEditObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'pki_ezsigntemplatepackage_id', - 'ezsigntemplatepackage_edit_object_v1_request' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def ezsigntemplatepackage_edit_object_v1_without_preload_content( + self, + pki_ezsigntemplatepackage_id: Annotated[int, Field(strict=True, ge=0)], + ezsigntemplatepackage_edit_object_v1_request: EzsigntemplatepackageEditObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Edit an existing Ezsigntemplatepackage + + + + :param pki_ezsigntemplatepackage_id: (required) + :type pki_ezsigntemplatepackage_id: int + :param ezsigntemplatepackage_edit_object_v1_request: (required) + :type ezsigntemplatepackage_edit_object_v1_request: EzsigntemplatepackageEditObjectV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsigntemplatepackage_edit_object_v1_serialize( + pki_ezsigntemplatepackage_id=pki_ezsigntemplatepackage_id, + ezsigntemplatepackage_edit_object_v1_request=ezsigntemplatepackage_edit_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsigntemplatepackage_edit_object_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplatepackageEditObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_ezsigntemplatepackage_id']: - _path_params['pkiEzsigntemplatepackageID'] = _params['pki_ezsigntemplatepackage_id'] + def _ezsigntemplatepackage_edit_object_v1_serialize( + self, + pki_ezsigntemplatepackage_id, + ezsigntemplatepackage_edit_object_v1_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_ezsigntemplatepackage_id is not None: + _path_params['pkiEzsigntemplatepackageID'] = pki_ezsigntemplatepackage_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['ezsigntemplatepackage_edit_object_v1_request'] is not None: - _body_params = _params['ezsigntemplatepackage_edit_object_v1_request'] + if ezsigntemplatepackage_edit_object_v1_request is not None: + _body_params = ezsigntemplatepackage_edit_object_v1_request + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '200': "EzsigntemplatepackageEditObjectV1Response", - '404': "CommonResponseError", - '422': "CommonResponseError", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsigntemplatepackage/{pkiEzsigntemplatepackageID}', 'PUT', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='PUT', + resource_path='/1/object/ezsigntemplatepackage/{pkiEzsigntemplatepackageID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) - @validate_arguments - def ezsigntemplatepackage_get_autocomplete_v2(self, s_selector : Annotated[StrictStr, Field(..., description="The type of Ezsigntemplatepackages to return")], e_filter_active : Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, s_query : Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, accept_language : Optional[HeaderAcceptLanguage] = None, **kwargs) -> EzsigntemplatepackageGetAutocompleteV2Response: # noqa: E501 - """Retrieve Ezsigntemplatepackages and IDs # noqa: E501 - Get the list of Ezsigntemplatepackage to be used in a dropdown or autocomplete control. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.ezsigntemplatepackage_get_autocomplete_v2(s_selector, e_filter_active, s_query, accept_language, async_req=True) - >>> result = thread.get() + + @validate_call + def ezsigntemplatepackage_get_autocomplete_v2( + self, + s_selector: Annotated[StrictStr, Field(description="The type of Ezsigntemplatepackages to return")], + e_filter_active: Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, + s_query: Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsigntemplatepackageGetAutocompleteV2Response: + """Retrieve Ezsigntemplatepackages and IDs + + Get the list of Ezsigntemplatepackage to be used in a dropdown or autocomplete control. :param s_selector: The type of Ezsigntemplatepackages to return (required) :type s_selector: str @@ -677,33 +1208,76 @@ def ezsigntemplatepackage_get_autocomplete_v2(self, s_selector : Annotated[Stric :type s_query: str :param accept_language: :type accept_language: HeaderAcceptLanguage - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsigntemplatepackageGetAutocompleteV2Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsigntemplatepackage_get_autocomplete_v2_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsigntemplatepackage_get_autocomplete_v2_with_http_info(s_selector, e_filter_active, s_query, accept_language, **kwargs) # noqa: E501 - - @validate_arguments - def ezsigntemplatepackage_get_autocomplete_v2_with_http_info(self, s_selector : Annotated[StrictStr, Field(..., description="The type of Ezsigntemplatepackages to return")], e_filter_active : Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, s_query : Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, accept_language : Optional[HeaderAcceptLanguage] = None, **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve Ezsigntemplatepackages and IDs # noqa: E501 - - Get the list of Ezsigntemplatepackage to be used in a dropdown or autocomplete control. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsigntemplatepackage_get_autocomplete_v2_with_http_info(s_selector, e_filter_active, s_query, accept_language, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._ezsigntemplatepackage_get_autocomplete_v2_serialize( + s_selector=s_selector, + e_filter_active=e_filter_active, + s_query=s_query, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplatepackageGetAutocompleteV2Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsigntemplatepackage_get_autocomplete_v2_with_http_info( + self, + s_selector: Annotated[StrictStr, Field(description="The type of Ezsigntemplatepackages to return")], + e_filter_active: Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, + s_query: Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsigntemplatepackageGetAutocompleteV2Response]: + """Retrieve Ezsigntemplatepackages and IDs + + Get the list of Ezsigntemplatepackage to be used in a dropdown or autocomplete control. :param s_selector: The type of Ezsigntemplatepackages to return (required) :type s_selector: str @@ -713,125 +1287,226 @@ def ezsigntemplatepackage_get_autocomplete_v2_with_http_info(self, s_selector : :type s_query: str :param accept_language: :type accept_language: HeaderAcceptLanguage - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsigntemplatepackageGetAutocompleteV2Response, status_code(int), headers(HTTPHeaderDict)) - """ - - _params = locals() - - _all_params = [ - 's_selector', - 'e_filter_active', - 's_query', - 'accept_language' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + """ # noqa: E501 + + _param = self._ezsigntemplatepackage_get_autocomplete_v2_serialize( + s_selector=s_selector, + e_filter_active=e_filter_active, + s_query=s_query, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplatepackageGetAutocompleteV2Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def ezsigntemplatepackage_get_autocomplete_v2_without_preload_content( + self, + s_selector: Annotated[StrictStr, Field(description="The type of Ezsigntemplatepackages to return")], + e_filter_active: Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, + s_query: Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve Ezsigntemplatepackages and IDs + + Get the list of Ezsigntemplatepackage to be used in a dropdown or autocomplete control. + + :param s_selector: The type of Ezsigntemplatepackages to return (required) + :type s_selector: str + :param e_filter_active: Specify which results we want to display. + :type e_filter_active: str + :param s_query: Allow to filter the returned results + :type s_query: str + :param accept_language: + :type accept_language: HeaderAcceptLanguage + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsigntemplatepackage_get_autocomplete_v2_serialize( + s_selector=s_selector, + e_filter_active=e_filter_active, + s_query=s_query, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsigntemplatepackage_get_autocomplete_v2" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplatepackageGetAutocompleteV2Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['s_selector']: - _path_params['sSelector'] = _params['s_selector'] + def _ezsigntemplatepackage_get_autocomplete_v2_serialize( + self, + s_selector, + e_filter_active, + s_query, + accept_language, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None - # process the query parameters - _query_params = [] - if _params.get('e_filter_active') is not None: # noqa: E501 - _query_params.append(('eFilterActive', _params['e_filter_active'])) + _collection_formats: Dict[str, str] = { + } - if _params.get('s_query') is not None: # noqa: E501 - _query_params.append(('sQuery', _params['s_query'])) + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if s_selector is not None: + _path_params['sSelector'] = s_selector + # process the query parameters + if e_filter_active is not None: + + _query_params.append(('eFilterActive', e_filter_active)) + + if s_query is not None: + + _query_params.append(('sQuery', s_query)) + # process the header parameters - _header_params = dict(_params.get('_headers', {})) - if _params['accept_language']: - _header_params['Accept-Language'] = _params['accept_language'] - + if accept_language is not None: + _header_params['Accept-Language'] = accept_language # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "EzsigntemplatepackageGetAutocompleteV2Response", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/2/object/ezsigntemplatepackage/getAutocomplete/{sSelector}', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/2/object/ezsigntemplatepackage/getAutocomplete/{sSelector}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) - @validate_arguments - def ezsigntemplatepackage_get_list_v1(self, e_order_by : Annotated[Optional[StrictStr], Field(description="Specify how you want the results to be sorted")] = None, i_row_max : Optional[conint(strict=True, le=10000, ge=1)] = None, i_row_offset : Optional[conint(strict=True, ge=0)] = None, accept_language : Optional[HeaderAcceptLanguage] = None, s_filter : Optional[StrictStr] = None, **kwargs) -> EzsigntemplatepackageGetListV1Response: # noqa: E501 - """Retrieve Ezsigntemplatepackage list # noqa: E501 - Enum values that can be filtered in query parameter *sFilter*: | Variable | Valid values | |---|---| | eEzsigntemplatepackageType | Company
Team
User
Usergroup | # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.ezsigntemplatepackage_get_list_v1(e_order_by, i_row_max, i_row_offset, accept_language, s_filter, async_req=True) - >>> result = thread.get() + + @validate_call + def ezsigntemplatepackage_get_list_v1( + self, + e_order_by: Annotated[Optional[StrictStr], Field(description="Specify how you want the results to be sorted")] = None, + i_row_max: Optional[Annotated[int, Field(le=10000, strict=True, ge=1)]] = None, + i_row_offset: Optional[Annotated[int, Field(strict=True, ge=0)]] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + s_filter: Optional[StrictStr] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsigntemplatepackageGetListV1Response: + """Retrieve Ezsigntemplatepackage list + + Enum values that can be filtered in query parameter *sFilter*: | Variable | Valid values | |---|---| | eEzsigntemplatepackageType | Company
Team
User
Usergroup | :param e_order_by: Specify how you want the results to be sorted :type e_order_by: str @@ -843,33 +1518,79 @@ def ezsigntemplatepackage_get_list_v1(self, e_order_by : Annotated[Optional[Stri :type accept_language: HeaderAcceptLanguage :param s_filter: :type s_filter: str - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsigntemplatepackageGetListV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsigntemplatepackage_get_list_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsigntemplatepackage_get_list_v1_with_http_info(e_order_by, i_row_max, i_row_offset, accept_language, s_filter, **kwargs) # noqa: E501 - - @validate_arguments - def ezsigntemplatepackage_get_list_v1_with_http_info(self, e_order_by : Annotated[Optional[StrictStr], Field(description="Specify how you want the results to be sorted")] = None, i_row_max : Optional[conint(strict=True, le=10000, ge=1)] = None, i_row_offset : Optional[conint(strict=True, ge=0)] = None, accept_language : Optional[HeaderAcceptLanguage] = None, s_filter : Optional[StrictStr] = None, **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve Ezsigntemplatepackage list # noqa: E501 - - Enum values that can be filtered in query parameter *sFilter*: | Variable | Valid values | |---|---| | eEzsigntemplatepackageType | Company
Team
User
Usergroup | # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsigntemplatepackage_get_list_v1_with_http_info(e_order_by, i_row_max, i_row_offset, accept_language, s_filter, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._ezsigntemplatepackage_get_list_v1_serialize( + e_order_by=e_order_by, + i_row_max=i_row_max, + i_row_offset=i_row_offset, + accept_language=accept_language, + s_filter=s_filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplatepackageGetListV1Response", + '406': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsigntemplatepackage_get_list_v1_with_http_info( + self, + e_order_by: Annotated[Optional[StrictStr], Field(description="Specify how you want the results to be sorted")] = None, + i_row_max: Optional[Annotated[int, Field(le=10000, strict=True, ge=1)]] = None, + i_row_offset: Optional[Annotated[int, Field(strict=True, ge=0)]] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + s_filter: Optional[StrictStr] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsigntemplatepackageGetListV1Response]: + """Retrieve Ezsigntemplatepackage list + + Enum values that can be filtered in query parameter *sFilter*: | Variable | Valid values | |---|---| | eEzsigntemplatepackageType | Company
Team
User
Usergroup | :param e_order_by: Specify how you want the results to be sorted :type e_order_by: str @@ -881,257 +1602,473 @@ def ezsigntemplatepackage_get_list_v1_with_http_info(self, e_order_by : Annotate :type accept_language: HeaderAcceptLanguage :param s_filter: :type s_filter: str - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsigntemplatepackageGetListV1Response, status_code(int), headers(HTTPHeaderDict)) - """ - - _params = locals() - - _all_params = [ - 'e_order_by', - 'i_row_max', - 'i_row_offset', - 'accept_language', - 's_filter' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' - ] + """ # noqa: E501 + + _param = self._ezsigntemplatepackage_get_list_v1_serialize( + e_order_by=e_order_by, + i_row_max=i_row_max, + i_row_offset=i_row_offset, + accept_language=accept_language, + s_filter=s_filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsigntemplatepackage_get_list_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplatepackageGetListV1Response", + '406': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _collection_formats = {} - # process the path parameters - _path_params = {} + @validate_call + def ezsigntemplatepackage_get_list_v1_without_preload_content( + self, + e_order_by: Annotated[Optional[StrictStr], Field(description="Specify how you want the results to be sorted")] = None, + i_row_max: Optional[Annotated[int, Field(le=10000, strict=True, ge=1)]] = None, + i_row_offset: Optional[Annotated[int, Field(strict=True, ge=0)]] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + s_filter: Optional[StrictStr] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve Ezsigntemplatepackage list - # process the query parameters - _query_params = [] - if _params.get('e_order_by') is not None: # noqa: E501 - _query_params.append(('eOrderBy', _params['e_order_by'])) + Enum values that can be filtered in query parameter *sFilter*: | Variable | Valid values | |---|---| | eEzsigntemplatepackageType | Company
Team
User
Usergroup | - if _params.get('i_row_max') is not None: # noqa: E501 - _query_params.append(('iRowMax', _params['i_row_max'])) + :param e_order_by: Specify how you want the results to be sorted + :type e_order_by: str + :param i_row_max: + :type i_row_max: int + :param i_row_offset: + :type i_row_offset: int + :param accept_language: + :type accept_language: HeaderAcceptLanguage + :param s_filter: + :type s_filter: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsigntemplatepackage_get_list_v1_serialize( + e_order_by=e_order_by, + i_row_max=i_row_max, + i_row_offset=i_row_offset, + accept_language=accept_language, + s_filter=s_filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - if _params.get('i_row_offset') is not None: # noqa: E501 - _query_params.append(('iRowOffset', _params['i_row_offset'])) + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplatepackageGetListV1Response", + '406': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - if _params.get('s_filter') is not None: # noqa: E501 - _query_params.append(('sFilter', _params['s_filter'])) - # process the header parameters - _header_params = dict(_params.get('_headers', {})) - if _params['accept_language']: - _header_params['Accept-Language'] = _params['accept_language'] + def _ezsigntemplatepackage_get_list_v1_serialize( + self, + e_order_by, + i_row_max, + i_row_offset, + accept_language, + s_filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if e_order_by is not None: + + _query_params.append(('eOrderBy', e_order_by)) + + if i_row_max is not None: + + _query_params.append(('iRowMax', i_row_max)) + + if i_row_offset is not None: + + _query_params.append(('iRowOffset', i_row_offset)) + + if s_filter is not None: + + _query_params.append(('sFilter', s_filter)) + + # process the header parameters + if accept_language is not None: + _header_params['Accept-Language'] = accept_language # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet']) # noqa: E501 + [ + 'application/json', + 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "EzsigntemplatepackageGetListV1Response", - '406': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsigntemplatepackage/getList', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/1/object/ezsigntemplatepackage/getList', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) - @validate_arguments - def ezsigntemplatepackage_get_object_v2(self, pki_ezsigntemplatepackage_id : conint(strict=True, ge=0), **kwargs) -> EzsigntemplatepackageGetObjectV2Response: # noqa: E501 - """Retrieve an existing Ezsigntemplatepackage # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.ezsigntemplatepackage_get_object_v2(pki_ezsigntemplatepackage_id, async_req=True) - >>> result = thread.get() + + @validate_call + def ezsigntemplatepackage_get_object_v2( + self, + pki_ezsigntemplatepackage_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsigntemplatepackageGetObjectV2Response: + """Retrieve an existing Ezsigntemplatepackage + + :param pki_ezsigntemplatepackage_id: (required) :type pki_ezsigntemplatepackage_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsigntemplatepackageGetObjectV2Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsigntemplatepackage_get_object_v2_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsigntemplatepackage_get_object_v2_with_http_info(pki_ezsigntemplatepackage_id, **kwargs) # noqa: E501 - - @validate_arguments - def ezsigntemplatepackage_get_object_v2_with_http_info(self, pki_ezsigntemplatepackage_id : conint(strict=True, ge=0), **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve an existing Ezsigntemplatepackage # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsigntemplatepackage_get_object_v2_with_http_info(pki_ezsigntemplatepackage_id, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._ezsigntemplatepackage_get_object_v2_serialize( + pki_ezsigntemplatepackage_id=pki_ezsigntemplatepackage_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplatepackageGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsigntemplatepackage_get_object_v2_with_http_info( + self, + pki_ezsigntemplatepackage_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsigntemplatepackageGetObjectV2Response]: + """Retrieve an existing Ezsigntemplatepackage + + :param pki_ezsigntemplatepackage_id: (required) :type pki_ezsigntemplatepackage_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsigntemplatepackageGetObjectV2Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._ezsigntemplatepackage_get_object_v2_serialize( + pki_ezsigntemplatepackage_id=pki_ezsigntemplatepackage_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplatepackageGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'pki_ezsigntemplatepackage_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def ezsigntemplatepackage_get_object_v2_without_preload_content( + self, + pki_ezsigntemplatepackage_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve an existing Ezsigntemplatepackage + + + + :param pki_ezsigntemplatepackage_id: (required) + :type pki_ezsigntemplatepackage_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsigntemplatepackage_get_object_v2_serialize( + pki_ezsigntemplatepackage_id=pki_ezsigntemplatepackage_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsigntemplatepackage_get_object_v2" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplatepackageGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_ezsigntemplatepackage_id']: - _path_params['pkiEzsigntemplatepackageID'] = _params['pki_ezsigntemplatepackage_id'] + def _ezsigntemplatepackage_get_object_v2_serialize( + self, + pki_ezsigntemplatepackage_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None + + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_ezsigntemplatepackage_id is not None: + _path_params['pkiEzsigntemplatepackageID'] = pki_ezsigntemplatepackage_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "EzsigntemplatepackageGetObjectV2Response", - '404': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/2/object/ezsigntemplatepackage/{pkiEzsigntemplatepackageID}', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/2/object/ezsigntemplatepackage/{pkiEzsigntemplatepackageID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/eZmaxApi/api/object_ezsigntemplatepackagemembership_api.py b/eZmaxApi/api/object_ezsigntemplatepackagemembership_api.py index 7347fb319..138920fb2 100644 --- a/eZmaxApi/api/object_ezsigntemplatepackagemembership_api.py +++ b/eZmaxApi/api/object_ezsigntemplatepackagemembership_api.py @@ -13,14 +13,19 @@ """ # noqa: E501 -import re # noqa: F401 import io import warnings -from pydantic import validate_arguments, ValidationError +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Dict, List, Optional, Tuple, Union, Any -from pydantic import conint +try: + from typing import Annotated +except ImportError: + from typing_extensions import Annotated +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.ezsigntemplatepackagemembership_create_object_v1_request import EzsigntemplatepackagemembershipCreateObjectV1Request from eZmaxApi.models.ezsigntemplatepackagemembership_create_object_v1_response import EzsigntemplatepackagemembershipCreateObjectV1Response from eZmaxApi.models.ezsigntemplatepackagemembership_delete_object_v1_response import EzsigntemplatepackagemembershipDeleteObjectV1Response @@ -28,10 +33,7 @@ from eZmaxApi.api_client import ApiClient from eZmaxApi.api_response import ApiResponse -from eZmaxApi.exceptions import ( # noqa: F401 - ApiTypeError, - ApiValueError -) +from eZmaxApi.rest import RESTResponseType class ObjectEzsigntemplatepackagemembershipApi: @@ -46,432 +48,798 @@ def __init__(self, api_client=None) -> None: api_client = ApiClient.get_default() self.api_client = api_client - @validate_arguments - def ezsigntemplatepackagemembership_create_object_v1(self, ezsigntemplatepackagemembership_create_object_v1_request : EzsigntemplatepackagemembershipCreateObjectV1Request, **kwargs) -> EzsigntemplatepackagemembershipCreateObjectV1Response: # noqa: E501 - """Create a new Ezsigntemplatepackagemembership # noqa: E501 - The endpoint allows to create one or many elements at once. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def ezsigntemplatepackagemembership_create_object_v1( + self, + ezsigntemplatepackagemembership_create_object_v1_request: EzsigntemplatepackagemembershipCreateObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsigntemplatepackagemembershipCreateObjectV1Response: + """Create a new Ezsigntemplatepackagemembership - >>> thread = api.ezsigntemplatepackagemembership_create_object_v1(ezsigntemplatepackagemembership_create_object_v1_request, async_req=True) - >>> result = thread.get() + The endpoint allows to create one or many elements at once. :param ezsigntemplatepackagemembership_create_object_v1_request: (required) :type ezsigntemplatepackagemembership_create_object_v1_request: EzsigntemplatepackagemembershipCreateObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsigntemplatepackagemembershipCreateObjectV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsigntemplatepackagemembership_create_object_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsigntemplatepackagemembership_create_object_v1_with_http_info(ezsigntemplatepackagemembership_create_object_v1_request, **kwargs) # noqa: E501 - - @validate_arguments - def ezsigntemplatepackagemembership_create_object_v1_with_http_info(self, ezsigntemplatepackagemembership_create_object_v1_request : EzsigntemplatepackagemembershipCreateObjectV1Request, **kwargs) -> ApiResponse: # noqa: E501 - """Create a new Ezsigntemplatepackagemembership # noqa: E501 - - The endpoint allows to create one or many elements at once. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsigntemplatepackagemembership_create_object_v1_with_http_info(ezsigntemplatepackagemembership_create_object_v1_request, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._ezsigntemplatepackagemembership_create_object_v1_serialize( + ezsigntemplatepackagemembership_create_object_v1_request=ezsigntemplatepackagemembership_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "EzsigntemplatepackagemembershipCreateObjectV1Response", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsigntemplatepackagemembership_create_object_v1_with_http_info( + self, + ezsigntemplatepackagemembership_create_object_v1_request: EzsigntemplatepackagemembershipCreateObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsigntemplatepackagemembershipCreateObjectV1Response]: + """Create a new Ezsigntemplatepackagemembership + + The endpoint allows to create one or many elements at once. :param ezsigntemplatepackagemembership_create_object_v1_request: (required) :type ezsigntemplatepackagemembership_create_object_v1_request: EzsigntemplatepackagemembershipCreateObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsigntemplatepackagemembershipCreateObjectV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._ezsigntemplatepackagemembership_create_object_v1_serialize( + ezsigntemplatepackagemembership_create_object_v1_request=ezsigntemplatepackagemembership_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '201': "EzsigntemplatepackagemembershipCreateObjectV1Response", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'ezsigntemplatepackagemembership_create_object_v1_request' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def ezsigntemplatepackagemembership_create_object_v1_without_preload_content( + self, + ezsigntemplatepackagemembership_create_object_v1_request: EzsigntemplatepackagemembershipCreateObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Create a new Ezsigntemplatepackagemembership + + The endpoint allows to create one or many elements at once. + + :param ezsigntemplatepackagemembership_create_object_v1_request: (required) + :type ezsigntemplatepackagemembership_create_object_v1_request: EzsigntemplatepackagemembershipCreateObjectV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsigntemplatepackagemembership_create_object_v1_serialize( + ezsigntemplatepackagemembership_create_object_v1_request=ezsigntemplatepackagemembership_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsigntemplatepackagemembership_create_object_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '201': "EzsigntemplatepackagemembershipCreateObjectV1Response", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} + def _ezsigntemplatepackagemembership_create_object_v1_serialize( + self, + ezsigntemplatepackagemembership_create_object_v1_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['ezsigntemplatepackagemembership_create_object_v1_request'] is not None: - _body_params = _params['ezsigntemplatepackagemembership_create_object_v1_request'] + if ezsigntemplatepackagemembership_create_object_v1_request is not None: + _body_params = ezsigntemplatepackagemembership_create_object_v1_request + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '201': "EzsigntemplatepackagemembershipCreateObjectV1Response", - '422': "CommonResponseError", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsigntemplatepackagemembership', 'POST', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='POST', + resource_path='/1/object/ezsigntemplatepackagemembership', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + - @validate_arguments - def ezsigntemplatepackagemembership_delete_object_v1(self, pki_ezsigntemplatepackagemembership_id : conint(strict=True, ge=0), **kwargs) -> EzsigntemplatepackagemembershipDeleteObjectV1Response: # noqa: E501 - """Delete an existing Ezsigntemplatepackagemembership # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def ezsigntemplatepackagemembership_delete_object_v1( + self, + pki_ezsigntemplatepackagemembership_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsigntemplatepackagemembershipDeleteObjectV1Response: + """Delete an existing Ezsigntemplatepackagemembership - >>> thread = api.ezsigntemplatepackagemembership_delete_object_v1(pki_ezsigntemplatepackagemembership_id, async_req=True) - >>> result = thread.get() + :param pki_ezsigntemplatepackagemembership_id: (required) :type pki_ezsigntemplatepackagemembership_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsigntemplatepackagemembershipDeleteObjectV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsigntemplatepackagemembership_delete_object_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsigntemplatepackagemembership_delete_object_v1_with_http_info(pki_ezsigntemplatepackagemembership_id, **kwargs) # noqa: E501 - - @validate_arguments - def ezsigntemplatepackagemembership_delete_object_v1_with_http_info(self, pki_ezsigntemplatepackagemembership_id : conint(strict=True, ge=0), **kwargs) -> ApiResponse: # noqa: E501 - """Delete an existing Ezsigntemplatepackagemembership # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsigntemplatepackagemembership_delete_object_v1_with_http_info(pki_ezsigntemplatepackagemembership_id, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._ezsigntemplatepackagemembership_delete_object_v1_serialize( + pki_ezsigntemplatepackagemembership_id=pki_ezsigntemplatepackagemembership_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplatepackagemembershipDeleteObjectV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsigntemplatepackagemembership_delete_object_v1_with_http_info( + self, + pki_ezsigntemplatepackagemembership_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsigntemplatepackagemembershipDeleteObjectV1Response]: + """Delete an existing Ezsigntemplatepackagemembership + + :param pki_ezsigntemplatepackagemembership_id: (required) :type pki_ezsigntemplatepackagemembership_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsigntemplatepackagemembershipDeleteObjectV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._ezsigntemplatepackagemembership_delete_object_v1_serialize( + pki_ezsigntemplatepackagemembership_id=pki_ezsigntemplatepackagemembership_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplatepackagemembershipDeleteObjectV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'pki_ezsigntemplatepackagemembership_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def ezsigntemplatepackagemembership_delete_object_v1_without_preload_content( + self, + pki_ezsigntemplatepackagemembership_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete an existing Ezsigntemplatepackagemembership + + + + :param pki_ezsigntemplatepackagemembership_id: (required) + :type pki_ezsigntemplatepackagemembership_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsigntemplatepackagemembership_delete_object_v1_serialize( + pki_ezsigntemplatepackagemembership_id=pki_ezsigntemplatepackagemembership_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsigntemplatepackagemembership_delete_object_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplatepackagemembershipDeleteObjectV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_ezsigntemplatepackagemembership_id']: - _path_params['pkiEzsigntemplatepackagemembershipID'] = _params['pki_ezsigntemplatepackagemembership_id'] + def _ezsigntemplatepackagemembership_delete_object_v1_serialize( + self, + pki_ezsigntemplatepackagemembership_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_ezsigntemplatepackagemembership_id is not None: + _path_params['pkiEzsigntemplatepackagemembershipID'] = pki_ezsigntemplatepackagemembership_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "EzsigntemplatepackagemembershipDeleteObjectV1Response", - '404': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsigntemplatepackagemembership/{pkiEzsigntemplatepackagemembershipID}', 'DELETE', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='DELETE', + resource_path='/1/object/ezsigntemplatepackagemembership/{pkiEzsigntemplatepackagemembershipID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + - @validate_arguments - def ezsigntemplatepackagemembership_get_object_v2(self, pki_ezsigntemplatepackagemembership_id : conint(strict=True, ge=0), **kwargs) -> EzsigntemplatepackagemembershipGetObjectV2Response: # noqa: E501 - """Retrieve an existing Ezsigntemplatepackagemembership # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.ezsigntemplatepackagemembership_get_object_v2(pki_ezsigntemplatepackagemembership_id, async_req=True) - >>> result = thread.get() + @validate_call + def ezsigntemplatepackagemembership_get_object_v2( + self, + pki_ezsigntemplatepackagemembership_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsigntemplatepackagemembershipGetObjectV2Response: + """Retrieve an existing Ezsigntemplatepackagemembership + + :param pki_ezsigntemplatepackagemembership_id: (required) :type pki_ezsigntemplatepackagemembership_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsigntemplatepackagemembershipGetObjectV2Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsigntemplatepackagemembership_get_object_v2_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsigntemplatepackagemembership_get_object_v2_with_http_info(pki_ezsigntemplatepackagemembership_id, **kwargs) # noqa: E501 - - @validate_arguments - def ezsigntemplatepackagemembership_get_object_v2_with_http_info(self, pki_ezsigntemplatepackagemembership_id : conint(strict=True, ge=0), **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve an existing Ezsigntemplatepackagemembership # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsigntemplatepackagemembership_get_object_v2_with_http_info(pki_ezsigntemplatepackagemembership_id, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._ezsigntemplatepackagemembership_get_object_v2_serialize( + pki_ezsigntemplatepackagemembership_id=pki_ezsigntemplatepackagemembership_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplatepackagemembershipGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsigntemplatepackagemembership_get_object_v2_with_http_info( + self, + pki_ezsigntemplatepackagemembership_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsigntemplatepackagemembershipGetObjectV2Response]: + """Retrieve an existing Ezsigntemplatepackagemembership + + :param pki_ezsigntemplatepackagemembership_id: (required) :type pki_ezsigntemplatepackagemembership_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsigntemplatepackagemembershipGetObjectV2Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._ezsigntemplatepackagemembership_get_object_v2_serialize( + pki_ezsigntemplatepackagemembership_id=pki_ezsigntemplatepackagemembership_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplatepackagemembershipGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _params = locals() - _all_params = [ - 'pki_ezsigntemplatepackagemembership_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + @validate_call + def ezsigntemplatepackagemembership_get_object_v2_without_preload_content( + self, + pki_ezsigntemplatepackagemembership_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve an existing Ezsigntemplatepackagemembership + + + + :param pki_ezsigntemplatepackagemembership_id: (required) + :type pki_ezsigntemplatepackagemembership_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsigntemplatepackagemembership_get_object_v2_serialize( + pki_ezsigntemplatepackagemembership_id=pki_ezsigntemplatepackagemembership_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsigntemplatepackagemembership_get_object_v2" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplatepackagemembershipGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_ezsigntemplatepackagemembership_id']: - _path_params['pkiEzsigntemplatepackagemembershipID'] = _params['pki_ezsigntemplatepackagemembership_id'] + def _ezsigntemplatepackagemembership_get_object_v2_serialize( + self, + pki_ezsigntemplatepackagemembership_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if pki_ezsigntemplatepackagemembership_id is not None: + _path_params['pkiEzsigntemplatepackagemembershipID'] = pki_ezsigntemplatepackagemembership_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "EzsigntemplatepackagemembershipGetObjectV2Response", - '404': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/2/object/ezsigntemplatepackagemembership/{pkiEzsigntemplatepackagemembershipID}', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/2/object/ezsigntemplatepackagemembership/{pkiEzsigntemplatepackagemembershipID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/eZmaxApi/api/object_ezsigntemplatepackagesigner_api.py b/eZmaxApi/api/object_ezsigntemplatepackagesigner_api.py index 284770db2..4bae7279a 100644 --- a/eZmaxApi/api/object_ezsigntemplatepackagesigner_api.py +++ b/eZmaxApi/api/object_ezsigntemplatepackagesigner_api.py @@ -13,14 +13,19 @@ """ # noqa: E501 -import re # noqa: F401 import io import warnings -from pydantic import validate_arguments, ValidationError +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Dict, List, Optional, Tuple, Union, Any -from pydantic import conint +try: + from typing import Annotated +except ImportError: + from typing_extensions import Annotated +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.ezsigntemplatepackagesigner_create_object_v1_request import EzsigntemplatepackagesignerCreateObjectV1Request from eZmaxApi.models.ezsigntemplatepackagesigner_create_object_v1_response import EzsigntemplatepackagesignerCreateObjectV1Response from eZmaxApi.models.ezsigntemplatepackagesigner_delete_object_v1_response import EzsigntemplatepackagesignerDeleteObjectV1Response @@ -30,10 +35,7 @@ from eZmaxApi.api_client import ApiClient from eZmaxApi.api_response import ApiResponse -from eZmaxApi.exceptions import ( # noqa: F401 - ApiTypeError, - ApiValueError -) +from eZmaxApi.rest import RESTResponseType class ObjectEzsigntemplatepackagesignerApi: @@ -48,588 +50,1087 @@ def __init__(self, api_client=None) -> None: api_client = ApiClient.get_default() self.api_client = api_client - @validate_arguments - def ezsigntemplatepackagesigner_create_object_v1(self, ezsigntemplatepackagesigner_create_object_v1_request : EzsigntemplatepackagesignerCreateObjectV1Request, **kwargs) -> EzsigntemplatepackagesignerCreateObjectV1Response: # noqa: E501 - """Create a new Ezsigntemplatepackagesigner # noqa: E501 - The endpoint allows to create one or many elements at once. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def ezsigntemplatepackagesigner_create_object_v1( + self, + ezsigntemplatepackagesigner_create_object_v1_request: EzsigntemplatepackagesignerCreateObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsigntemplatepackagesignerCreateObjectV1Response: + """Create a new Ezsigntemplatepackagesigner - >>> thread = api.ezsigntemplatepackagesigner_create_object_v1(ezsigntemplatepackagesigner_create_object_v1_request, async_req=True) - >>> result = thread.get() + The endpoint allows to create one or many elements at once. :param ezsigntemplatepackagesigner_create_object_v1_request: (required) :type ezsigntemplatepackagesigner_create_object_v1_request: EzsigntemplatepackagesignerCreateObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsigntemplatepackagesignerCreateObjectV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsigntemplatepackagesigner_create_object_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsigntemplatepackagesigner_create_object_v1_with_http_info(ezsigntemplatepackagesigner_create_object_v1_request, **kwargs) # noqa: E501 - - @validate_arguments - def ezsigntemplatepackagesigner_create_object_v1_with_http_info(self, ezsigntemplatepackagesigner_create_object_v1_request : EzsigntemplatepackagesignerCreateObjectV1Request, **kwargs) -> ApiResponse: # noqa: E501 - """Create a new Ezsigntemplatepackagesigner # noqa: E501 - - The endpoint allows to create one or many elements at once. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsigntemplatepackagesigner_create_object_v1_with_http_info(ezsigntemplatepackagesigner_create_object_v1_request, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._ezsigntemplatepackagesigner_create_object_v1_serialize( + ezsigntemplatepackagesigner_create_object_v1_request=ezsigntemplatepackagesigner_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "EzsigntemplatepackagesignerCreateObjectV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsigntemplatepackagesigner_create_object_v1_with_http_info( + self, + ezsigntemplatepackagesigner_create_object_v1_request: EzsigntemplatepackagesignerCreateObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsigntemplatepackagesignerCreateObjectV1Response]: + """Create a new Ezsigntemplatepackagesigner + + The endpoint allows to create one or many elements at once. :param ezsigntemplatepackagesigner_create_object_v1_request: (required) :type ezsigntemplatepackagesigner_create_object_v1_request: EzsigntemplatepackagesignerCreateObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsigntemplatepackagesignerCreateObjectV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._ezsigntemplatepackagesigner_create_object_v1_serialize( + ezsigntemplatepackagesigner_create_object_v1_request=ezsigntemplatepackagesigner_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '201': "EzsigntemplatepackagesignerCreateObjectV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'ezsigntemplatepackagesigner_create_object_v1_request' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def ezsigntemplatepackagesigner_create_object_v1_without_preload_content( + self, + ezsigntemplatepackagesigner_create_object_v1_request: EzsigntemplatepackagesignerCreateObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Create a new Ezsigntemplatepackagesigner + + The endpoint allows to create one or many elements at once. + + :param ezsigntemplatepackagesigner_create_object_v1_request: (required) + :type ezsigntemplatepackagesigner_create_object_v1_request: EzsigntemplatepackagesignerCreateObjectV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsigntemplatepackagesigner_create_object_v1_serialize( + ezsigntemplatepackagesigner_create_object_v1_request=ezsigntemplatepackagesigner_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsigntemplatepackagesigner_create_object_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '201': "EzsigntemplatepackagesignerCreateObjectV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} + def _ezsigntemplatepackagesigner_create_object_v1_serialize( + self, + ezsigntemplatepackagesigner_create_object_v1_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['ezsigntemplatepackagesigner_create_object_v1_request'] is not None: - _body_params = _params['ezsigntemplatepackagesigner_create_object_v1_request'] + if ezsigntemplatepackagesigner_create_object_v1_request is not None: + _body_params = ezsigntemplatepackagesigner_create_object_v1_request + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '201': "EzsigntemplatepackagesignerCreateObjectV1Response", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsigntemplatepackagesigner', 'POST', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='POST', + resource_path='/1/object/ezsigntemplatepackagesigner', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) - @validate_arguments - def ezsigntemplatepackagesigner_delete_object_v1(self, pki_ezsigntemplatepackagesigner_id : conint(strict=True, ge=0), **kwargs) -> EzsigntemplatepackagesignerDeleteObjectV1Response: # noqa: E501 - """Delete an existing Ezsigntemplatepackagesigner # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.ezsigntemplatepackagesigner_delete_object_v1(pki_ezsigntemplatepackagesigner_id, async_req=True) - >>> result = thread.get() + + @validate_call + def ezsigntemplatepackagesigner_delete_object_v1( + self, + pki_ezsigntemplatepackagesigner_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsigntemplatepackagesignerDeleteObjectV1Response: + """Delete an existing Ezsigntemplatepackagesigner + + :param pki_ezsigntemplatepackagesigner_id: (required) :type pki_ezsigntemplatepackagesigner_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsigntemplatepackagesignerDeleteObjectV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsigntemplatepackagesigner_delete_object_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsigntemplatepackagesigner_delete_object_v1_with_http_info(pki_ezsigntemplatepackagesigner_id, **kwargs) # noqa: E501 - - @validate_arguments - def ezsigntemplatepackagesigner_delete_object_v1_with_http_info(self, pki_ezsigntemplatepackagesigner_id : conint(strict=True, ge=0), **kwargs) -> ApiResponse: # noqa: E501 - """Delete an existing Ezsigntemplatepackagesigner # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsigntemplatepackagesigner_delete_object_v1_with_http_info(pki_ezsigntemplatepackagesigner_id, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._ezsigntemplatepackagesigner_delete_object_v1_serialize( + pki_ezsigntemplatepackagesigner_id=pki_ezsigntemplatepackagesigner_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplatepackagesignerDeleteObjectV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsigntemplatepackagesigner_delete_object_v1_with_http_info( + self, + pki_ezsigntemplatepackagesigner_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsigntemplatepackagesignerDeleteObjectV1Response]: + """Delete an existing Ezsigntemplatepackagesigner + + :param pki_ezsigntemplatepackagesigner_id: (required) :type pki_ezsigntemplatepackagesigner_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsigntemplatepackagesignerDeleteObjectV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._ezsigntemplatepackagesigner_delete_object_v1_serialize( + pki_ezsigntemplatepackagesigner_id=pki_ezsigntemplatepackagesigner_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplatepackagesignerDeleteObjectV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'pki_ezsigntemplatepackagesigner_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def ezsigntemplatepackagesigner_delete_object_v1_without_preload_content( + self, + pki_ezsigntemplatepackagesigner_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete an existing Ezsigntemplatepackagesigner + + + + :param pki_ezsigntemplatepackagesigner_id: (required) + :type pki_ezsigntemplatepackagesigner_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsigntemplatepackagesigner_delete_object_v1_serialize( + pki_ezsigntemplatepackagesigner_id=pki_ezsigntemplatepackagesigner_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsigntemplatepackagesigner_delete_object_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplatepackagesignerDeleteObjectV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_ezsigntemplatepackagesigner_id']: - _path_params['pkiEzsigntemplatepackagesignerID'] = _params['pki_ezsigntemplatepackagesigner_id'] + def _ezsigntemplatepackagesigner_delete_object_v1_serialize( + self, + pki_ezsigntemplatepackagesigner_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if pki_ezsigntemplatepackagesigner_id is not None: + _path_params['pkiEzsigntemplatepackagesignerID'] = pki_ezsigntemplatepackagesigner_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "EzsigntemplatepackagesignerDeleteObjectV1Response", - '404': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsigntemplatepackagesigner/{pkiEzsigntemplatepackagesignerID}', 'DELETE', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='DELETE', + resource_path='/1/object/ezsigntemplatepackagesigner/{pkiEzsigntemplatepackagesignerID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) - @validate_arguments - def ezsigntemplatepackagesigner_edit_object_v1(self, pki_ezsigntemplatepackagesigner_id : conint(strict=True, ge=0), ezsigntemplatepackagesigner_edit_object_v1_request : EzsigntemplatepackagesignerEditObjectV1Request, **kwargs) -> EzsigntemplatepackagesignerEditObjectV1Response: # noqa: E501 - """Edit an existing Ezsigntemplatepackagesigner # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.ezsigntemplatepackagesigner_edit_object_v1(pki_ezsigntemplatepackagesigner_id, ezsigntemplatepackagesigner_edit_object_v1_request, async_req=True) - >>> result = thread.get() + + @validate_call + def ezsigntemplatepackagesigner_edit_object_v1( + self, + pki_ezsigntemplatepackagesigner_id: Annotated[int, Field(strict=True, ge=0)], + ezsigntemplatepackagesigner_edit_object_v1_request: EzsigntemplatepackagesignerEditObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsigntemplatepackagesignerEditObjectV1Response: + """Edit an existing Ezsigntemplatepackagesigner + + :param pki_ezsigntemplatepackagesigner_id: (required) :type pki_ezsigntemplatepackagesigner_id: int :param ezsigntemplatepackagesigner_edit_object_v1_request: (required) :type ezsigntemplatepackagesigner_edit_object_v1_request: EzsigntemplatepackagesignerEditObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsigntemplatepackagesignerEditObjectV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsigntemplatepackagesigner_edit_object_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsigntemplatepackagesigner_edit_object_v1_with_http_info(pki_ezsigntemplatepackagesigner_id, ezsigntemplatepackagesigner_edit_object_v1_request, **kwargs) # noqa: E501 - - @validate_arguments - def ezsigntemplatepackagesigner_edit_object_v1_with_http_info(self, pki_ezsigntemplatepackagesigner_id : conint(strict=True, ge=0), ezsigntemplatepackagesigner_edit_object_v1_request : EzsigntemplatepackagesignerEditObjectV1Request, **kwargs) -> ApiResponse: # noqa: E501 - """Edit an existing Ezsigntemplatepackagesigner # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsigntemplatepackagesigner_edit_object_v1_with_http_info(pki_ezsigntemplatepackagesigner_id, ezsigntemplatepackagesigner_edit_object_v1_request, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._ezsigntemplatepackagesigner_edit_object_v1_serialize( + pki_ezsigntemplatepackagesigner_id=pki_ezsigntemplatepackagesigner_id, + ezsigntemplatepackagesigner_edit_object_v1_request=ezsigntemplatepackagesigner_edit_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplatepackagesignerEditObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsigntemplatepackagesigner_edit_object_v1_with_http_info( + self, + pki_ezsigntemplatepackagesigner_id: Annotated[int, Field(strict=True, ge=0)], + ezsigntemplatepackagesigner_edit_object_v1_request: EzsigntemplatepackagesignerEditObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsigntemplatepackagesignerEditObjectV1Response]: + """Edit an existing Ezsigntemplatepackagesigner + + :param pki_ezsigntemplatepackagesigner_id: (required) :type pki_ezsigntemplatepackagesigner_id: int :param ezsigntemplatepackagesigner_edit_object_v1_request: (required) :type ezsigntemplatepackagesigner_edit_object_v1_request: EzsigntemplatepackagesignerEditObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsigntemplatepackagesignerEditObjectV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._ezsigntemplatepackagesigner_edit_object_v1_serialize( + pki_ezsigntemplatepackagesigner_id=pki_ezsigntemplatepackagesigner_id, + ezsigntemplatepackagesigner_edit_object_v1_request=ezsigntemplatepackagesigner_edit_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplatepackagesignerEditObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'pki_ezsigntemplatepackagesigner_id', - 'ezsigntemplatepackagesigner_edit_object_v1_request' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def ezsigntemplatepackagesigner_edit_object_v1_without_preload_content( + self, + pki_ezsigntemplatepackagesigner_id: Annotated[int, Field(strict=True, ge=0)], + ezsigntemplatepackagesigner_edit_object_v1_request: EzsigntemplatepackagesignerEditObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Edit an existing Ezsigntemplatepackagesigner + + + + :param pki_ezsigntemplatepackagesigner_id: (required) + :type pki_ezsigntemplatepackagesigner_id: int + :param ezsigntemplatepackagesigner_edit_object_v1_request: (required) + :type ezsigntemplatepackagesigner_edit_object_v1_request: EzsigntemplatepackagesignerEditObjectV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsigntemplatepackagesigner_edit_object_v1_serialize( + pki_ezsigntemplatepackagesigner_id=pki_ezsigntemplatepackagesigner_id, + ezsigntemplatepackagesigner_edit_object_v1_request=ezsigntemplatepackagesigner_edit_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsigntemplatepackagesigner_edit_object_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplatepackagesignerEditObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_ezsigntemplatepackagesigner_id']: - _path_params['pkiEzsigntemplatepackagesignerID'] = _params['pki_ezsigntemplatepackagesigner_id'] + def _ezsigntemplatepackagesigner_edit_object_v1_serialize( + self, + pki_ezsigntemplatepackagesigner_id, + ezsigntemplatepackagesigner_edit_object_v1_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_ezsigntemplatepackagesigner_id is not None: + _path_params['pkiEzsigntemplatepackagesignerID'] = pki_ezsigntemplatepackagesigner_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['ezsigntemplatepackagesigner_edit_object_v1_request'] is not None: - _body_params = _params['ezsigntemplatepackagesigner_edit_object_v1_request'] + if ezsigntemplatepackagesigner_edit_object_v1_request is not None: + _body_params = ezsigntemplatepackagesigner_edit_object_v1_request + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '200': "EzsigntemplatepackagesignerEditObjectV1Response", - '404': "CommonResponseError", - '422': "CommonResponseError", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsigntemplatepackagesigner/{pkiEzsigntemplatepackagesignerID}', 'PUT', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='PUT', + resource_path='/1/object/ezsigntemplatepackagesigner/{pkiEzsigntemplatepackagesignerID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + - @validate_arguments - def ezsigntemplatepackagesigner_get_object_v2(self, pki_ezsigntemplatepackagesigner_id : conint(strict=True, ge=0), **kwargs) -> EzsigntemplatepackagesignerGetObjectV2Response: # noqa: E501 - """Retrieve an existing Ezsigntemplatepackagesigner # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def ezsigntemplatepackagesigner_get_object_v2( + self, + pki_ezsigntemplatepackagesigner_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsigntemplatepackagesignerGetObjectV2Response: + """Retrieve an existing Ezsigntemplatepackagesigner - >>> thread = api.ezsigntemplatepackagesigner_get_object_v2(pki_ezsigntemplatepackagesigner_id, async_req=True) - >>> result = thread.get() + :param pki_ezsigntemplatepackagesigner_id: (required) :type pki_ezsigntemplatepackagesigner_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsigntemplatepackagesignerGetObjectV2Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsigntemplatepackagesigner_get_object_v2_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsigntemplatepackagesigner_get_object_v2_with_http_info(pki_ezsigntemplatepackagesigner_id, **kwargs) # noqa: E501 - - @validate_arguments - def ezsigntemplatepackagesigner_get_object_v2_with_http_info(self, pki_ezsigntemplatepackagesigner_id : conint(strict=True, ge=0), **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve an existing Ezsigntemplatepackagesigner # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsigntemplatepackagesigner_get_object_v2_with_http_info(pki_ezsigntemplatepackagesigner_id, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._ezsigntemplatepackagesigner_get_object_v2_serialize( + pki_ezsigntemplatepackagesigner_id=pki_ezsigntemplatepackagesigner_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplatepackagesignerGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsigntemplatepackagesigner_get_object_v2_with_http_info( + self, + pki_ezsigntemplatepackagesigner_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsigntemplatepackagesignerGetObjectV2Response]: + """Retrieve an existing Ezsigntemplatepackagesigner + + :param pki_ezsigntemplatepackagesigner_id: (required) :type pki_ezsigntemplatepackagesigner_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsigntemplatepackagesignerGetObjectV2Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._ezsigntemplatepackagesigner_get_object_v2_serialize( + pki_ezsigntemplatepackagesigner_id=pki_ezsigntemplatepackagesigner_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplatepackagesignerGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'pki_ezsigntemplatepackagesigner_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def ezsigntemplatepackagesigner_get_object_v2_without_preload_content( + self, + pki_ezsigntemplatepackagesigner_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve an existing Ezsigntemplatepackagesigner + + + + :param pki_ezsigntemplatepackagesigner_id: (required) + :type pki_ezsigntemplatepackagesigner_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsigntemplatepackagesigner_get_object_v2_serialize( + pki_ezsigntemplatepackagesigner_id=pki_ezsigntemplatepackagesigner_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsigntemplatepackagesigner_get_object_v2" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplatepackagesignerGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_ezsigntemplatepackagesigner_id']: - _path_params['pkiEzsigntemplatepackagesignerID'] = _params['pki_ezsigntemplatepackagesigner_id'] + def _ezsigntemplatepackagesigner_get_object_v2_serialize( + self, + pki_ezsigntemplatepackagesigner_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_ezsigntemplatepackagesigner_id is not None: + _path_params['pkiEzsigntemplatepackagesignerID'] = pki_ezsigntemplatepackagesigner_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "EzsigntemplatepackagesignerGetObjectV2Response", - '404': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/2/object/ezsigntemplatepackagesigner/{pkiEzsigntemplatepackagesignerID}', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/2/object/ezsigntemplatepackagesigner/{pkiEzsigntemplatepackagesignerID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/eZmaxApi/api/object_ezsigntemplatepackagesignermembership_api.py b/eZmaxApi/api/object_ezsigntemplatepackagesignermembership_api.py index ebfb96e40..c91357f37 100644 --- a/eZmaxApi/api/object_ezsigntemplatepackagesignermembership_api.py +++ b/eZmaxApi/api/object_ezsigntemplatepackagesignermembership_api.py @@ -13,14 +13,19 @@ """ # noqa: E501 -import re # noqa: F401 import io import warnings -from pydantic import validate_arguments, ValidationError +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Dict, List, Optional, Tuple, Union, Any -from pydantic import conint +try: + from typing import Annotated +except ImportError: + from typing_extensions import Annotated +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.ezsigntemplatepackagesignermembership_create_object_v1_request import EzsigntemplatepackagesignermembershipCreateObjectV1Request from eZmaxApi.models.ezsigntemplatepackagesignermembership_create_object_v1_response import EzsigntemplatepackagesignermembershipCreateObjectV1Response from eZmaxApi.models.ezsigntemplatepackagesignermembership_delete_object_v1_response import EzsigntemplatepackagesignermembershipDeleteObjectV1Response @@ -28,10 +33,7 @@ from eZmaxApi.api_client import ApiClient from eZmaxApi.api_response import ApiResponse -from eZmaxApi.exceptions import ( # noqa: F401 - ApiTypeError, - ApiValueError -) +from eZmaxApi.rest import RESTResponseType class ObjectEzsigntemplatepackagesignermembershipApi: @@ -46,432 +48,798 @@ def __init__(self, api_client=None) -> None: api_client = ApiClient.get_default() self.api_client = api_client - @validate_arguments - def ezsigntemplatepackagesignermembership_create_object_v1(self, ezsigntemplatepackagesignermembership_create_object_v1_request : EzsigntemplatepackagesignermembershipCreateObjectV1Request, **kwargs) -> EzsigntemplatepackagesignermembershipCreateObjectV1Response: # noqa: E501 - """Create a new Ezsigntemplatepackagesignermembership # noqa: E501 - The endpoint allows to create one or many elements at once. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def ezsigntemplatepackagesignermembership_create_object_v1( + self, + ezsigntemplatepackagesignermembership_create_object_v1_request: EzsigntemplatepackagesignermembershipCreateObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsigntemplatepackagesignermembershipCreateObjectV1Response: + """Create a new Ezsigntemplatepackagesignermembership - >>> thread = api.ezsigntemplatepackagesignermembership_create_object_v1(ezsigntemplatepackagesignermembership_create_object_v1_request, async_req=True) - >>> result = thread.get() + The endpoint allows to create one or many elements at once. :param ezsigntemplatepackagesignermembership_create_object_v1_request: (required) :type ezsigntemplatepackagesignermembership_create_object_v1_request: EzsigntemplatepackagesignermembershipCreateObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsigntemplatepackagesignermembershipCreateObjectV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsigntemplatepackagesignermembership_create_object_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsigntemplatepackagesignermembership_create_object_v1_with_http_info(ezsigntemplatepackagesignermembership_create_object_v1_request, **kwargs) # noqa: E501 - - @validate_arguments - def ezsigntemplatepackagesignermembership_create_object_v1_with_http_info(self, ezsigntemplatepackagesignermembership_create_object_v1_request : EzsigntemplatepackagesignermembershipCreateObjectV1Request, **kwargs) -> ApiResponse: # noqa: E501 - """Create a new Ezsigntemplatepackagesignermembership # noqa: E501 - - The endpoint allows to create one or many elements at once. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsigntemplatepackagesignermembership_create_object_v1_with_http_info(ezsigntemplatepackagesignermembership_create_object_v1_request, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._ezsigntemplatepackagesignermembership_create_object_v1_serialize( + ezsigntemplatepackagesignermembership_create_object_v1_request=ezsigntemplatepackagesignermembership_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "EzsigntemplatepackagesignermembershipCreateObjectV1Response", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsigntemplatepackagesignermembership_create_object_v1_with_http_info( + self, + ezsigntemplatepackagesignermembership_create_object_v1_request: EzsigntemplatepackagesignermembershipCreateObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsigntemplatepackagesignermembershipCreateObjectV1Response]: + """Create a new Ezsigntemplatepackagesignermembership + + The endpoint allows to create one or many elements at once. :param ezsigntemplatepackagesignermembership_create_object_v1_request: (required) :type ezsigntemplatepackagesignermembership_create_object_v1_request: EzsigntemplatepackagesignermembershipCreateObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsigntemplatepackagesignermembershipCreateObjectV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._ezsigntemplatepackagesignermembership_create_object_v1_serialize( + ezsigntemplatepackagesignermembership_create_object_v1_request=ezsigntemplatepackagesignermembership_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '201': "EzsigntemplatepackagesignermembershipCreateObjectV1Response", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'ezsigntemplatepackagesignermembership_create_object_v1_request' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def ezsigntemplatepackagesignermembership_create_object_v1_without_preload_content( + self, + ezsigntemplatepackagesignermembership_create_object_v1_request: EzsigntemplatepackagesignermembershipCreateObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Create a new Ezsigntemplatepackagesignermembership + + The endpoint allows to create one or many elements at once. + + :param ezsigntemplatepackagesignermembership_create_object_v1_request: (required) + :type ezsigntemplatepackagesignermembership_create_object_v1_request: EzsigntemplatepackagesignermembershipCreateObjectV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsigntemplatepackagesignermembership_create_object_v1_serialize( + ezsigntemplatepackagesignermembership_create_object_v1_request=ezsigntemplatepackagesignermembership_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsigntemplatepackagesignermembership_create_object_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '201': "EzsigntemplatepackagesignermembershipCreateObjectV1Response", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} + def _ezsigntemplatepackagesignermembership_create_object_v1_serialize( + self, + ezsigntemplatepackagesignermembership_create_object_v1_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['ezsigntemplatepackagesignermembership_create_object_v1_request'] is not None: - _body_params = _params['ezsigntemplatepackagesignermembership_create_object_v1_request'] + if ezsigntemplatepackagesignermembership_create_object_v1_request is not None: + _body_params = ezsigntemplatepackagesignermembership_create_object_v1_request + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '201': "EzsigntemplatepackagesignermembershipCreateObjectV1Response", - '422': "CommonResponseError", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsigntemplatepackagesignermembership', 'POST', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='POST', + resource_path='/1/object/ezsigntemplatepackagesignermembership', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + - @validate_arguments - def ezsigntemplatepackagesignermembership_delete_object_v1(self, pki_ezsigntemplatepackagesignermembership_id : conint(strict=True, ge=0), **kwargs) -> EzsigntemplatepackagesignermembershipDeleteObjectV1Response: # noqa: E501 - """Delete an existing Ezsigntemplatepackagesignermembership # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def ezsigntemplatepackagesignermembership_delete_object_v1( + self, + pki_ezsigntemplatepackagesignermembership_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsigntemplatepackagesignermembershipDeleteObjectV1Response: + """Delete an existing Ezsigntemplatepackagesignermembership - >>> thread = api.ezsigntemplatepackagesignermembership_delete_object_v1(pki_ezsigntemplatepackagesignermembership_id, async_req=True) - >>> result = thread.get() + :param pki_ezsigntemplatepackagesignermembership_id: (required) :type pki_ezsigntemplatepackagesignermembership_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsigntemplatepackagesignermembershipDeleteObjectV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsigntemplatepackagesignermembership_delete_object_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsigntemplatepackagesignermembership_delete_object_v1_with_http_info(pki_ezsigntemplatepackagesignermembership_id, **kwargs) # noqa: E501 - - @validate_arguments - def ezsigntemplatepackagesignermembership_delete_object_v1_with_http_info(self, pki_ezsigntemplatepackagesignermembership_id : conint(strict=True, ge=0), **kwargs) -> ApiResponse: # noqa: E501 - """Delete an existing Ezsigntemplatepackagesignermembership # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsigntemplatepackagesignermembership_delete_object_v1_with_http_info(pki_ezsigntemplatepackagesignermembership_id, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._ezsigntemplatepackagesignermembership_delete_object_v1_serialize( + pki_ezsigntemplatepackagesignermembership_id=pki_ezsigntemplatepackagesignermembership_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplatepackagesignermembershipDeleteObjectV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsigntemplatepackagesignermembership_delete_object_v1_with_http_info( + self, + pki_ezsigntemplatepackagesignermembership_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsigntemplatepackagesignermembershipDeleteObjectV1Response]: + """Delete an existing Ezsigntemplatepackagesignermembership + + :param pki_ezsigntemplatepackagesignermembership_id: (required) :type pki_ezsigntemplatepackagesignermembership_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsigntemplatepackagesignermembershipDeleteObjectV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._ezsigntemplatepackagesignermembership_delete_object_v1_serialize( + pki_ezsigntemplatepackagesignermembership_id=pki_ezsigntemplatepackagesignermembership_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplatepackagesignermembershipDeleteObjectV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'pki_ezsigntemplatepackagesignermembership_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def ezsigntemplatepackagesignermembership_delete_object_v1_without_preload_content( + self, + pki_ezsigntemplatepackagesignermembership_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete an existing Ezsigntemplatepackagesignermembership + + + + :param pki_ezsigntemplatepackagesignermembership_id: (required) + :type pki_ezsigntemplatepackagesignermembership_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsigntemplatepackagesignermembership_delete_object_v1_serialize( + pki_ezsigntemplatepackagesignermembership_id=pki_ezsigntemplatepackagesignermembership_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsigntemplatepackagesignermembership_delete_object_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplatepackagesignermembershipDeleteObjectV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_ezsigntemplatepackagesignermembership_id']: - _path_params['pkiEzsigntemplatepackagesignermembershipID'] = _params['pki_ezsigntemplatepackagesignermembership_id'] + def _ezsigntemplatepackagesignermembership_delete_object_v1_serialize( + self, + pki_ezsigntemplatepackagesignermembership_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_ezsigntemplatepackagesignermembership_id is not None: + _path_params['pkiEzsigntemplatepackagesignermembershipID'] = pki_ezsigntemplatepackagesignermembership_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "EzsigntemplatepackagesignermembershipDeleteObjectV1Response", - '404': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsigntemplatepackagesignermembership/{pkiEzsigntemplatepackagesignermembershipID}', 'DELETE', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='DELETE', + resource_path='/1/object/ezsigntemplatepackagesignermembership/{pkiEzsigntemplatepackagesignermembershipID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + - @validate_arguments - def ezsigntemplatepackagesignermembership_get_object_v2(self, pki_ezsigntemplatepackagesignermembership_id : conint(strict=True, ge=0), **kwargs) -> EzsigntemplatepackagesignermembershipGetObjectV2Response: # noqa: E501 - """Retrieve an existing Ezsigntemplatepackagesignermembership # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.ezsigntemplatepackagesignermembership_get_object_v2(pki_ezsigntemplatepackagesignermembership_id, async_req=True) - >>> result = thread.get() + @validate_call + def ezsigntemplatepackagesignermembership_get_object_v2( + self, + pki_ezsigntemplatepackagesignermembership_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsigntemplatepackagesignermembershipGetObjectV2Response: + """Retrieve an existing Ezsigntemplatepackagesignermembership + + :param pki_ezsigntemplatepackagesignermembership_id: (required) :type pki_ezsigntemplatepackagesignermembership_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsigntemplatepackagesignermembershipGetObjectV2Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsigntemplatepackagesignermembership_get_object_v2_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsigntemplatepackagesignermembership_get_object_v2_with_http_info(pki_ezsigntemplatepackagesignermembership_id, **kwargs) # noqa: E501 - - @validate_arguments - def ezsigntemplatepackagesignermembership_get_object_v2_with_http_info(self, pki_ezsigntemplatepackagesignermembership_id : conint(strict=True, ge=0), **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve an existing Ezsigntemplatepackagesignermembership # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsigntemplatepackagesignermembership_get_object_v2_with_http_info(pki_ezsigntemplatepackagesignermembership_id, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._ezsigntemplatepackagesignermembership_get_object_v2_serialize( + pki_ezsigntemplatepackagesignermembership_id=pki_ezsigntemplatepackagesignermembership_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplatepackagesignermembershipGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsigntemplatepackagesignermembership_get_object_v2_with_http_info( + self, + pki_ezsigntemplatepackagesignermembership_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsigntemplatepackagesignermembershipGetObjectV2Response]: + """Retrieve an existing Ezsigntemplatepackagesignermembership + + :param pki_ezsigntemplatepackagesignermembership_id: (required) :type pki_ezsigntemplatepackagesignermembership_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsigntemplatepackagesignermembershipGetObjectV2Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._ezsigntemplatepackagesignermembership_get_object_v2_serialize( + pki_ezsigntemplatepackagesignermembership_id=pki_ezsigntemplatepackagesignermembership_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplatepackagesignermembershipGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _params = locals() - _all_params = [ - 'pki_ezsigntemplatepackagesignermembership_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + @validate_call + def ezsigntemplatepackagesignermembership_get_object_v2_without_preload_content( + self, + pki_ezsigntemplatepackagesignermembership_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve an existing Ezsigntemplatepackagesignermembership + + + + :param pki_ezsigntemplatepackagesignermembership_id: (required) + :type pki_ezsigntemplatepackagesignermembership_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsigntemplatepackagesignermembership_get_object_v2_serialize( + pki_ezsigntemplatepackagesignermembership_id=pki_ezsigntemplatepackagesignermembership_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsigntemplatepackagesignermembership_get_object_v2" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplatepackagesignermembershipGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_ezsigntemplatepackagesignermembership_id']: - _path_params['pkiEzsigntemplatepackagesignermembershipID'] = _params['pki_ezsigntemplatepackagesignermembership_id'] + def _ezsigntemplatepackagesignermembership_get_object_v2_serialize( + self, + pki_ezsigntemplatepackagesignermembership_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if pki_ezsigntemplatepackagesignermembership_id is not None: + _path_params['pkiEzsigntemplatepackagesignermembershipID'] = pki_ezsigntemplatepackagesignermembership_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "EzsigntemplatepackagesignermembershipGetObjectV2Response", - '404': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/2/object/ezsigntemplatepackagesignermembership/{pkiEzsigntemplatepackagesignermembershipID}', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/2/object/ezsigntemplatepackagesignermembership/{pkiEzsigntemplatepackagesignermembershipID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/eZmaxApi/api/object_ezsigntemplatesignature_api.py b/eZmaxApi/api/object_ezsigntemplatesignature_api.py index 8d707a2be..8a41f063f 100644 --- a/eZmaxApi/api/object_ezsigntemplatesignature_api.py +++ b/eZmaxApi/api/object_ezsigntemplatesignature_api.py @@ -13,14 +13,19 @@ """ # noqa: E501 -import re # noqa: F401 import io import warnings -from pydantic import validate_arguments, ValidationError +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Dict, List, Optional, Tuple, Union, Any -from pydantic import conint +try: + from typing import Annotated +except ImportError: + from typing_extensions import Annotated +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.ezsigntemplatesignature_create_object_v1_request import EzsigntemplatesignatureCreateObjectV1Request from eZmaxApi.models.ezsigntemplatesignature_create_object_v1_response import EzsigntemplatesignatureCreateObjectV1Response from eZmaxApi.models.ezsigntemplatesignature_delete_object_v1_response import EzsigntemplatesignatureDeleteObjectV1Response @@ -30,10 +35,7 @@ from eZmaxApi.api_client import ApiClient from eZmaxApi.api_response import ApiResponse -from eZmaxApi.exceptions import ( # noqa: F401 - ApiTypeError, - ApiValueError -) +from eZmaxApi.rest import RESTResponseType class ObjectEzsigntemplatesignatureApi: @@ -48,588 +50,1087 @@ def __init__(self, api_client=None) -> None: api_client = ApiClient.get_default() self.api_client = api_client - @validate_arguments - def ezsigntemplatesignature_create_object_v1(self, ezsigntemplatesignature_create_object_v1_request : EzsigntemplatesignatureCreateObjectV1Request, **kwargs) -> EzsigntemplatesignatureCreateObjectV1Response: # noqa: E501 - """Create a new Ezsigntemplatesignature # noqa: E501 - The endpoint allows to create one or many elements at once. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def ezsigntemplatesignature_create_object_v1( + self, + ezsigntemplatesignature_create_object_v1_request: EzsigntemplatesignatureCreateObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsigntemplatesignatureCreateObjectV1Response: + """Create a new Ezsigntemplatesignature - >>> thread = api.ezsigntemplatesignature_create_object_v1(ezsigntemplatesignature_create_object_v1_request, async_req=True) - >>> result = thread.get() + The endpoint allows to create one or many elements at once. :param ezsigntemplatesignature_create_object_v1_request: (required) :type ezsigntemplatesignature_create_object_v1_request: EzsigntemplatesignatureCreateObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsigntemplatesignatureCreateObjectV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsigntemplatesignature_create_object_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsigntemplatesignature_create_object_v1_with_http_info(ezsigntemplatesignature_create_object_v1_request, **kwargs) # noqa: E501 - - @validate_arguments - def ezsigntemplatesignature_create_object_v1_with_http_info(self, ezsigntemplatesignature_create_object_v1_request : EzsigntemplatesignatureCreateObjectV1Request, **kwargs) -> ApiResponse: # noqa: E501 - """Create a new Ezsigntemplatesignature # noqa: E501 - - The endpoint allows to create one or many elements at once. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsigntemplatesignature_create_object_v1_with_http_info(ezsigntemplatesignature_create_object_v1_request, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._ezsigntemplatesignature_create_object_v1_serialize( + ezsigntemplatesignature_create_object_v1_request=ezsigntemplatesignature_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "EzsigntemplatesignatureCreateObjectV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsigntemplatesignature_create_object_v1_with_http_info( + self, + ezsigntemplatesignature_create_object_v1_request: EzsigntemplatesignatureCreateObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsigntemplatesignatureCreateObjectV1Response]: + """Create a new Ezsigntemplatesignature + + The endpoint allows to create one or many elements at once. :param ezsigntemplatesignature_create_object_v1_request: (required) :type ezsigntemplatesignature_create_object_v1_request: EzsigntemplatesignatureCreateObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsigntemplatesignatureCreateObjectV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._ezsigntemplatesignature_create_object_v1_serialize( + ezsigntemplatesignature_create_object_v1_request=ezsigntemplatesignature_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '201': "EzsigntemplatesignatureCreateObjectV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'ezsigntemplatesignature_create_object_v1_request' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def ezsigntemplatesignature_create_object_v1_without_preload_content( + self, + ezsigntemplatesignature_create_object_v1_request: EzsigntemplatesignatureCreateObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Create a new Ezsigntemplatesignature + + The endpoint allows to create one or many elements at once. + + :param ezsigntemplatesignature_create_object_v1_request: (required) + :type ezsigntemplatesignature_create_object_v1_request: EzsigntemplatesignatureCreateObjectV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsigntemplatesignature_create_object_v1_serialize( + ezsigntemplatesignature_create_object_v1_request=ezsigntemplatesignature_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsigntemplatesignature_create_object_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '201': "EzsigntemplatesignatureCreateObjectV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} + def _ezsigntemplatesignature_create_object_v1_serialize( + self, + ezsigntemplatesignature_create_object_v1_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['ezsigntemplatesignature_create_object_v1_request'] is not None: - _body_params = _params['ezsigntemplatesignature_create_object_v1_request'] + if ezsigntemplatesignature_create_object_v1_request is not None: + _body_params = ezsigntemplatesignature_create_object_v1_request + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '201': "EzsigntemplatesignatureCreateObjectV1Response", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsigntemplatesignature', 'POST', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='POST', + resource_path='/1/object/ezsigntemplatesignature', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) - @validate_arguments - def ezsigntemplatesignature_delete_object_v1(self, pki_ezsigntemplatesignature_id : conint(strict=True, ge=0), **kwargs) -> EzsigntemplatesignatureDeleteObjectV1Response: # noqa: E501 - """Delete an existing Ezsigntemplatesignature # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.ezsigntemplatesignature_delete_object_v1(pki_ezsigntemplatesignature_id, async_req=True) - >>> result = thread.get() + + @validate_call + def ezsigntemplatesignature_delete_object_v1( + self, + pki_ezsigntemplatesignature_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsigntemplatesignatureDeleteObjectV1Response: + """Delete an existing Ezsigntemplatesignature + + :param pki_ezsigntemplatesignature_id: (required) :type pki_ezsigntemplatesignature_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsigntemplatesignatureDeleteObjectV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsigntemplatesignature_delete_object_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsigntemplatesignature_delete_object_v1_with_http_info(pki_ezsigntemplatesignature_id, **kwargs) # noqa: E501 - - @validate_arguments - def ezsigntemplatesignature_delete_object_v1_with_http_info(self, pki_ezsigntemplatesignature_id : conint(strict=True, ge=0), **kwargs) -> ApiResponse: # noqa: E501 - """Delete an existing Ezsigntemplatesignature # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsigntemplatesignature_delete_object_v1_with_http_info(pki_ezsigntemplatesignature_id, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._ezsigntemplatesignature_delete_object_v1_serialize( + pki_ezsigntemplatesignature_id=pki_ezsigntemplatesignature_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplatesignatureDeleteObjectV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsigntemplatesignature_delete_object_v1_with_http_info( + self, + pki_ezsigntemplatesignature_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsigntemplatesignatureDeleteObjectV1Response]: + """Delete an existing Ezsigntemplatesignature + + :param pki_ezsigntemplatesignature_id: (required) :type pki_ezsigntemplatesignature_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsigntemplatesignatureDeleteObjectV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._ezsigntemplatesignature_delete_object_v1_serialize( + pki_ezsigntemplatesignature_id=pki_ezsigntemplatesignature_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplatesignatureDeleteObjectV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'pki_ezsigntemplatesignature_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def ezsigntemplatesignature_delete_object_v1_without_preload_content( + self, + pki_ezsigntemplatesignature_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete an existing Ezsigntemplatesignature + + + + :param pki_ezsigntemplatesignature_id: (required) + :type pki_ezsigntemplatesignature_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsigntemplatesignature_delete_object_v1_serialize( + pki_ezsigntemplatesignature_id=pki_ezsigntemplatesignature_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsigntemplatesignature_delete_object_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplatesignatureDeleteObjectV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_ezsigntemplatesignature_id']: - _path_params['pkiEzsigntemplatesignatureID'] = _params['pki_ezsigntemplatesignature_id'] + def _ezsigntemplatesignature_delete_object_v1_serialize( + self, + pki_ezsigntemplatesignature_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if pki_ezsigntemplatesignature_id is not None: + _path_params['pkiEzsigntemplatesignatureID'] = pki_ezsigntemplatesignature_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "EzsigntemplatesignatureDeleteObjectV1Response", - '404': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsigntemplatesignature/{pkiEzsigntemplatesignatureID}', 'DELETE', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='DELETE', + resource_path='/1/object/ezsigntemplatesignature/{pkiEzsigntemplatesignatureID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) - @validate_arguments - def ezsigntemplatesignature_edit_object_v1(self, pki_ezsigntemplatesignature_id : conint(strict=True, ge=0), ezsigntemplatesignature_edit_object_v1_request : EzsigntemplatesignatureEditObjectV1Request, **kwargs) -> EzsigntemplatesignatureEditObjectV1Response: # noqa: E501 - """Edit an existing Ezsigntemplatesignature # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.ezsigntemplatesignature_edit_object_v1(pki_ezsigntemplatesignature_id, ezsigntemplatesignature_edit_object_v1_request, async_req=True) - >>> result = thread.get() + + @validate_call + def ezsigntemplatesignature_edit_object_v1( + self, + pki_ezsigntemplatesignature_id: Annotated[int, Field(strict=True, ge=0)], + ezsigntemplatesignature_edit_object_v1_request: EzsigntemplatesignatureEditObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsigntemplatesignatureEditObjectV1Response: + """Edit an existing Ezsigntemplatesignature + + :param pki_ezsigntemplatesignature_id: (required) :type pki_ezsigntemplatesignature_id: int :param ezsigntemplatesignature_edit_object_v1_request: (required) :type ezsigntemplatesignature_edit_object_v1_request: EzsigntemplatesignatureEditObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsigntemplatesignatureEditObjectV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsigntemplatesignature_edit_object_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsigntemplatesignature_edit_object_v1_with_http_info(pki_ezsigntemplatesignature_id, ezsigntemplatesignature_edit_object_v1_request, **kwargs) # noqa: E501 - - @validate_arguments - def ezsigntemplatesignature_edit_object_v1_with_http_info(self, pki_ezsigntemplatesignature_id : conint(strict=True, ge=0), ezsigntemplatesignature_edit_object_v1_request : EzsigntemplatesignatureEditObjectV1Request, **kwargs) -> ApiResponse: # noqa: E501 - """Edit an existing Ezsigntemplatesignature # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsigntemplatesignature_edit_object_v1_with_http_info(pki_ezsigntemplatesignature_id, ezsigntemplatesignature_edit_object_v1_request, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._ezsigntemplatesignature_edit_object_v1_serialize( + pki_ezsigntemplatesignature_id=pki_ezsigntemplatesignature_id, + ezsigntemplatesignature_edit_object_v1_request=ezsigntemplatesignature_edit_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplatesignatureEditObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsigntemplatesignature_edit_object_v1_with_http_info( + self, + pki_ezsigntemplatesignature_id: Annotated[int, Field(strict=True, ge=0)], + ezsigntemplatesignature_edit_object_v1_request: EzsigntemplatesignatureEditObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsigntemplatesignatureEditObjectV1Response]: + """Edit an existing Ezsigntemplatesignature + + :param pki_ezsigntemplatesignature_id: (required) :type pki_ezsigntemplatesignature_id: int :param ezsigntemplatesignature_edit_object_v1_request: (required) :type ezsigntemplatesignature_edit_object_v1_request: EzsigntemplatesignatureEditObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsigntemplatesignatureEditObjectV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._ezsigntemplatesignature_edit_object_v1_serialize( + pki_ezsigntemplatesignature_id=pki_ezsigntemplatesignature_id, + ezsigntemplatesignature_edit_object_v1_request=ezsigntemplatesignature_edit_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplatesignatureEditObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'pki_ezsigntemplatesignature_id', - 'ezsigntemplatesignature_edit_object_v1_request' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def ezsigntemplatesignature_edit_object_v1_without_preload_content( + self, + pki_ezsigntemplatesignature_id: Annotated[int, Field(strict=True, ge=0)], + ezsigntemplatesignature_edit_object_v1_request: EzsigntemplatesignatureEditObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Edit an existing Ezsigntemplatesignature + + + + :param pki_ezsigntemplatesignature_id: (required) + :type pki_ezsigntemplatesignature_id: int + :param ezsigntemplatesignature_edit_object_v1_request: (required) + :type ezsigntemplatesignature_edit_object_v1_request: EzsigntemplatesignatureEditObjectV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsigntemplatesignature_edit_object_v1_serialize( + pki_ezsigntemplatesignature_id=pki_ezsigntemplatesignature_id, + ezsigntemplatesignature_edit_object_v1_request=ezsigntemplatesignature_edit_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsigntemplatesignature_edit_object_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplatesignatureEditObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_ezsigntemplatesignature_id']: - _path_params['pkiEzsigntemplatesignatureID'] = _params['pki_ezsigntemplatesignature_id'] + def _ezsigntemplatesignature_edit_object_v1_serialize( + self, + pki_ezsigntemplatesignature_id, + ezsigntemplatesignature_edit_object_v1_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_ezsigntemplatesignature_id is not None: + _path_params['pkiEzsigntemplatesignatureID'] = pki_ezsigntemplatesignature_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['ezsigntemplatesignature_edit_object_v1_request'] is not None: - _body_params = _params['ezsigntemplatesignature_edit_object_v1_request'] + if ezsigntemplatesignature_edit_object_v1_request is not None: + _body_params = ezsigntemplatesignature_edit_object_v1_request + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '200': "EzsigntemplatesignatureEditObjectV1Response", - '404': "CommonResponseError", - '422': "CommonResponseError", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsigntemplatesignature/{pkiEzsigntemplatesignatureID}', 'PUT', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='PUT', + resource_path='/1/object/ezsigntemplatesignature/{pkiEzsigntemplatesignatureID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + - @validate_arguments - def ezsigntemplatesignature_get_object_v2(self, pki_ezsigntemplatesignature_id : conint(strict=True, ge=0), **kwargs) -> EzsigntemplatesignatureGetObjectV2Response: # noqa: E501 - """Retrieve an existing Ezsigntemplatesignature # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def ezsigntemplatesignature_get_object_v2( + self, + pki_ezsigntemplatesignature_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsigntemplatesignatureGetObjectV2Response: + """Retrieve an existing Ezsigntemplatesignature - >>> thread = api.ezsigntemplatesignature_get_object_v2(pki_ezsigntemplatesignature_id, async_req=True) - >>> result = thread.get() + :param pki_ezsigntemplatesignature_id: (required) :type pki_ezsigntemplatesignature_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsigntemplatesignatureGetObjectV2Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsigntemplatesignature_get_object_v2_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsigntemplatesignature_get_object_v2_with_http_info(pki_ezsigntemplatesignature_id, **kwargs) # noqa: E501 - - @validate_arguments - def ezsigntemplatesignature_get_object_v2_with_http_info(self, pki_ezsigntemplatesignature_id : conint(strict=True, ge=0), **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve an existing Ezsigntemplatesignature # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsigntemplatesignature_get_object_v2_with_http_info(pki_ezsigntemplatesignature_id, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._ezsigntemplatesignature_get_object_v2_serialize( + pki_ezsigntemplatesignature_id=pki_ezsigntemplatesignature_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplatesignatureGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsigntemplatesignature_get_object_v2_with_http_info( + self, + pki_ezsigntemplatesignature_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsigntemplatesignatureGetObjectV2Response]: + """Retrieve an existing Ezsigntemplatesignature + + :param pki_ezsigntemplatesignature_id: (required) :type pki_ezsigntemplatesignature_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsigntemplatesignatureGetObjectV2Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._ezsigntemplatesignature_get_object_v2_serialize( + pki_ezsigntemplatesignature_id=pki_ezsigntemplatesignature_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplatesignatureGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'pki_ezsigntemplatesignature_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def ezsigntemplatesignature_get_object_v2_without_preload_content( + self, + pki_ezsigntemplatesignature_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve an existing Ezsigntemplatesignature + + + + :param pki_ezsigntemplatesignature_id: (required) + :type pki_ezsigntemplatesignature_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsigntemplatesignature_get_object_v2_serialize( + pki_ezsigntemplatesignature_id=pki_ezsigntemplatesignature_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsigntemplatesignature_get_object_v2" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplatesignatureGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_ezsigntemplatesignature_id']: - _path_params['pkiEzsigntemplatesignatureID'] = _params['pki_ezsigntemplatesignature_id'] + def _ezsigntemplatesignature_get_object_v2_serialize( + self, + pki_ezsigntemplatesignature_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_ezsigntemplatesignature_id is not None: + _path_params['pkiEzsigntemplatesignatureID'] = pki_ezsigntemplatesignature_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "EzsigntemplatesignatureGetObjectV2Response", - '404': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/2/object/ezsigntemplatesignature/{pkiEzsigntemplatesignatureID}', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/2/object/ezsigntemplatesignature/{pkiEzsigntemplatesignatureID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/eZmaxApi/api/object_ezsigntemplatesigner_api.py b/eZmaxApi/api/object_ezsigntemplatesigner_api.py index 026a185d4..3542c0310 100644 --- a/eZmaxApi/api/object_ezsigntemplatesigner_api.py +++ b/eZmaxApi/api/object_ezsigntemplatesigner_api.py @@ -13,14 +13,19 @@ """ # noqa: E501 -import re # noqa: F401 import io import warnings -from pydantic import validate_arguments, ValidationError +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Dict, List, Optional, Tuple, Union, Any -from pydantic import conint +try: + from typing import Annotated +except ImportError: + from typing_extensions import Annotated +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.ezsigntemplatesigner_create_object_v1_request import EzsigntemplatesignerCreateObjectV1Request from eZmaxApi.models.ezsigntemplatesigner_create_object_v1_response import EzsigntemplatesignerCreateObjectV1Response from eZmaxApi.models.ezsigntemplatesigner_delete_object_v1_response import EzsigntemplatesignerDeleteObjectV1Response @@ -30,10 +35,7 @@ from eZmaxApi.api_client import ApiClient from eZmaxApi.api_response import ApiResponse -from eZmaxApi.exceptions import ( # noqa: F401 - ApiTypeError, - ApiValueError -) +from eZmaxApi.rest import RESTResponseType class ObjectEzsigntemplatesignerApi: @@ -48,588 +50,1087 @@ def __init__(self, api_client=None) -> None: api_client = ApiClient.get_default() self.api_client = api_client - @validate_arguments - def ezsigntemplatesigner_create_object_v1(self, ezsigntemplatesigner_create_object_v1_request : EzsigntemplatesignerCreateObjectV1Request, **kwargs) -> EzsigntemplatesignerCreateObjectV1Response: # noqa: E501 - """Create a new Ezsigntemplatesigner # noqa: E501 - The endpoint allows to create one or many elements at once. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def ezsigntemplatesigner_create_object_v1( + self, + ezsigntemplatesigner_create_object_v1_request: EzsigntemplatesignerCreateObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsigntemplatesignerCreateObjectV1Response: + """Create a new Ezsigntemplatesigner - >>> thread = api.ezsigntemplatesigner_create_object_v1(ezsigntemplatesigner_create_object_v1_request, async_req=True) - >>> result = thread.get() + The endpoint allows to create one or many elements at once. :param ezsigntemplatesigner_create_object_v1_request: (required) :type ezsigntemplatesigner_create_object_v1_request: EzsigntemplatesignerCreateObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsigntemplatesignerCreateObjectV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsigntemplatesigner_create_object_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsigntemplatesigner_create_object_v1_with_http_info(ezsigntemplatesigner_create_object_v1_request, **kwargs) # noqa: E501 - - @validate_arguments - def ezsigntemplatesigner_create_object_v1_with_http_info(self, ezsigntemplatesigner_create_object_v1_request : EzsigntemplatesignerCreateObjectV1Request, **kwargs) -> ApiResponse: # noqa: E501 - """Create a new Ezsigntemplatesigner # noqa: E501 - - The endpoint allows to create one or many elements at once. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsigntemplatesigner_create_object_v1_with_http_info(ezsigntemplatesigner_create_object_v1_request, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._ezsigntemplatesigner_create_object_v1_serialize( + ezsigntemplatesigner_create_object_v1_request=ezsigntemplatesigner_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "EzsigntemplatesignerCreateObjectV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsigntemplatesigner_create_object_v1_with_http_info( + self, + ezsigntemplatesigner_create_object_v1_request: EzsigntemplatesignerCreateObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsigntemplatesignerCreateObjectV1Response]: + """Create a new Ezsigntemplatesigner + + The endpoint allows to create one or many elements at once. :param ezsigntemplatesigner_create_object_v1_request: (required) :type ezsigntemplatesigner_create_object_v1_request: EzsigntemplatesignerCreateObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsigntemplatesignerCreateObjectV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._ezsigntemplatesigner_create_object_v1_serialize( + ezsigntemplatesigner_create_object_v1_request=ezsigntemplatesigner_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '201': "EzsigntemplatesignerCreateObjectV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'ezsigntemplatesigner_create_object_v1_request' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def ezsigntemplatesigner_create_object_v1_without_preload_content( + self, + ezsigntemplatesigner_create_object_v1_request: EzsigntemplatesignerCreateObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Create a new Ezsigntemplatesigner + + The endpoint allows to create one or many elements at once. + + :param ezsigntemplatesigner_create_object_v1_request: (required) + :type ezsigntemplatesigner_create_object_v1_request: EzsigntemplatesignerCreateObjectV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsigntemplatesigner_create_object_v1_serialize( + ezsigntemplatesigner_create_object_v1_request=ezsigntemplatesigner_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsigntemplatesigner_create_object_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '201': "EzsigntemplatesignerCreateObjectV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} + def _ezsigntemplatesigner_create_object_v1_serialize( + self, + ezsigntemplatesigner_create_object_v1_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['ezsigntemplatesigner_create_object_v1_request'] is not None: - _body_params = _params['ezsigntemplatesigner_create_object_v1_request'] + if ezsigntemplatesigner_create_object_v1_request is not None: + _body_params = ezsigntemplatesigner_create_object_v1_request + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '201': "EzsigntemplatesignerCreateObjectV1Response", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsigntemplatesigner', 'POST', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='POST', + resource_path='/1/object/ezsigntemplatesigner', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) - @validate_arguments - def ezsigntemplatesigner_delete_object_v1(self, pki_ezsigntemplatesigner_id : conint(strict=True, ge=0), **kwargs) -> EzsigntemplatesignerDeleteObjectV1Response: # noqa: E501 - """Delete an existing Ezsigntemplatesigner # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.ezsigntemplatesigner_delete_object_v1(pki_ezsigntemplatesigner_id, async_req=True) - >>> result = thread.get() + + @validate_call + def ezsigntemplatesigner_delete_object_v1( + self, + pki_ezsigntemplatesigner_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsigntemplatesignerDeleteObjectV1Response: + """Delete an existing Ezsigntemplatesigner + + :param pki_ezsigntemplatesigner_id: (required) :type pki_ezsigntemplatesigner_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsigntemplatesignerDeleteObjectV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsigntemplatesigner_delete_object_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsigntemplatesigner_delete_object_v1_with_http_info(pki_ezsigntemplatesigner_id, **kwargs) # noqa: E501 - - @validate_arguments - def ezsigntemplatesigner_delete_object_v1_with_http_info(self, pki_ezsigntemplatesigner_id : conint(strict=True, ge=0), **kwargs) -> ApiResponse: # noqa: E501 - """Delete an existing Ezsigntemplatesigner # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsigntemplatesigner_delete_object_v1_with_http_info(pki_ezsigntemplatesigner_id, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._ezsigntemplatesigner_delete_object_v1_serialize( + pki_ezsigntemplatesigner_id=pki_ezsigntemplatesigner_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplatesignerDeleteObjectV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsigntemplatesigner_delete_object_v1_with_http_info( + self, + pki_ezsigntemplatesigner_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsigntemplatesignerDeleteObjectV1Response]: + """Delete an existing Ezsigntemplatesigner + + :param pki_ezsigntemplatesigner_id: (required) :type pki_ezsigntemplatesigner_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsigntemplatesignerDeleteObjectV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._ezsigntemplatesigner_delete_object_v1_serialize( + pki_ezsigntemplatesigner_id=pki_ezsigntemplatesigner_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplatesignerDeleteObjectV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'pki_ezsigntemplatesigner_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def ezsigntemplatesigner_delete_object_v1_without_preload_content( + self, + pki_ezsigntemplatesigner_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete an existing Ezsigntemplatesigner + + + + :param pki_ezsigntemplatesigner_id: (required) + :type pki_ezsigntemplatesigner_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsigntemplatesigner_delete_object_v1_serialize( + pki_ezsigntemplatesigner_id=pki_ezsigntemplatesigner_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsigntemplatesigner_delete_object_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplatesignerDeleteObjectV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_ezsigntemplatesigner_id']: - _path_params['pkiEzsigntemplatesignerID'] = _params['pki_ezsigntemplatesigner_id'] + def _ezsigntemplatesigner_delete_object_v1_serialize( + self, + pki_ezsigntemplatesigner_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if pki_ezsigntemplatesigner_id is not None: + _path_params['pkiEzsigntemplatesignerID'] = pki_ezsigntemplatesigner_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "EzsigntemplatesignerDeleteObjectV1Response", - '404': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsigntemplatesigner/{pkiEzsigntemplatesignerID}', 'DELETE', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='DELETE', + resource_path='/1/object/ezsigntemplatesigner/{pkiEzsigntemplatesignerID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) - @validate_arguments - def ezsigntemplatesigner_edit_object_v1(self, pki_ezsigntemplatesigner_id : conint(strict=True, ge=0), ezsigntemplatesigner_edit_object_v1_request : EzsigntemplatesignerEditObjectV1Request, **kwargs) -> EzsigntemplatesignerEditObjectV1Response: # noqa: E501 - """Edit an existing Ezsigntemplatesigner # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.ezsigntemplatesigner_edit_object_v1(pki_ezsigntemplatesigner_id, ezsigntemplatesigner_edit_object_v1_request, async_req=True) - >>> result = thread.get() + + @validate_call + def ezsigntemplatesigner_edit_object_v1( + self, + pki_ezsigntemplatesigner_id: Annotated[int, Field(strict=True, ge=0)], + ezsigntemplatesigner_edit_object_v1_request: EzsigntemplatesignerEditObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsigntemplatesignerEditObjectV1Response: + """Edit an existing Ezsigntemplatesigner + + :param pki_ezsigntemplatesigner_id: (required) :type pki_ezsigntemplatesigner_id: int :param ezsigntemplatesigner_edit_object_v1_request: (required) :type ezsigntemplatesigner_edit_object_v1_request: EzsigntemplatesignerEditObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsigntemplatesignerEditObjectV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsigntemplatesigner_edit_object_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsigntemplatesigner_edit_object_v1_with_http_info(pki_ezsigntemplatesigner_id, ezsigntemplatesigner_edit_object_v1_request, **kwargs) # noqa: E501 - - @validate_arguments - def ezsigntemplatesigner_edit_object_v1_with_http_info(self, pki_ezsigntemplatesigner_id : conint(strict=True, ge=0), ezsigntemplatesigner_edit_object_v1_request : EzsigntemplatesignerEditObjectV1Request, **kwargs) -> ApiResponse: # noqa: E501 - """Edit an existing Ezsigntemplatesigner # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsigntemplatesigner_edit_object_v1_with_http_info(pki_ezsigntemplatesigner_id, ezsigntemplatesigner_edit_object_v1_request, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._ezsigntemplatesigner_edit_object_v1_serialize( + pki_ezsigntemplatesigner_id=pki_ezsigntemplatesigner_id, + ezsigntemplatesigner_edit_object_v1_request=ezsigntemplatesigner_edit_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplatesignerEditObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsigntemplatesigner_edit_object_v1_with_http_info( + self, + pki_ezsigntemplatesigner_id: Annotated[int, Field(strict=True, ge=0)], + ezsigntemplatesigner_edit_object_v1_request: EzsigntemplatesignerEditObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsigntemplatesignerEditObjectV1Response]: + """Edit an existing Ezsigntemplatesigner + + :param pki_ezsigntemplatesigner_id: (required) :type pki_ezsigntemplatesigner_id: int :param ezsigntemplatesigner_edit_object_v1_request: (required) :type ezsigntemplatesigner_edit_object_v1_request: EzsigntemplatesignerEditObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsigntemplatesignerEditObjectV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._ezsigntemplatesigner_edit_object_v1_serialize( + pki_ezsigntemplatesigner_id=pki_ezsigntemplatesigner_id, + ezsigntemplatesigner_edit_object_v1_request=ezsigntemplatesigner_edit_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplatesignerEditObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'pki_ezsigntemplatesigner_id', - 'ezsigntemplatesigner_edit_object_v1_request' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def ezsigntemplatesigner_edit_object_v1_without_preload_content( + self, + pki_ezsigntemplatesigner_id: Annotated[int, Field(strict=True, ge=0)], + ezsigntemplatesigner_edit_object_v1_request: EzsigntemplatesignerEditObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Edit an existing Ezsigntemplatesigner + + + + :param pki_ezsigntemplatesigner_id: (required) + :type pki_ezsigntemplatesigner_id: int + :param ezsigntemplatesigner_edit_object_v1_request: (required) + :type ezsigntemplatesigner_edit_object_v1_request: EzsigntemplatesignerEditObjectV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsigntemplatesigner_edit_object_v1_serialize( + pki_ezsigntemplatesigner_id=pki_ezsigntemplatesigner_id, + ezsigntemplatesigner_edit_object_v1_request=ezsigntemplatesigner_edit_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsigntemplatesigner_edit_object_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplatesignerEditObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_ezsigntemplatesigner_id']: - _path_params['pkiEzsigntemplatesignerID'] = _params['pki_ezsigntemplatesigner_id'] + def _ezsigntemplatesigner_edit_object_v1_serialize( + self, + pki_ezsigntemplatesigner_id, + ezsigntemplatesigner_edit_object_v1_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_ezsigntemplatesigner_id is not None: + _path_params['pkiEzsigntemplatesignerID'] = pki_ezsigntemplatesigner_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['ezsigntemplatesigner_edit_object_v1_request'] is not None: - _body_params = _params['ezsigntemplatesigner_edit_object_v1_request'] + if ezsigntemplatesigner_edit_object_v1_request is not None: + _body_params = ezsigntemplatesigner_edit_object_v1_request + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '200': "EzsigntemplatesignerEditObjectV1Response", - '404': "CommonResponseError", - '422': "CommonResponseError", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/ezsigntemplatesigner/{pkiEzsigntemplatesignerID}', 'PUT', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='PUT', + resource_path='/1/object/ezsigntemplatesigner/{pkiEzsigntemplatesignerID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + - @validate_arguments - def ezsigntemplatesigner_get_object_v2(self, pki_ezsigntemplatesigner_id : conint(strict=True, ge=0), **kwargs) -> EzsigntemplatesignerGetObjectV2Response: # noqa: E501 - """Retrieve an existing Ezsigntemplatesigner # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def ezsigntemplatesigner_get_object_v2( + self, + pki_ezsigntemplatesigner_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsigntemplatesignerGetObjectV2Response: + """Retrieve an existing Ezsigntemplatesigner - >>> thread = api.ezsigntemplatesigner_get_object_v2(pki_ezsigntemplatesigner_id, async_req=True) - >>> result = thread.get() + :param pki_ezsigntemplatesigner_id: (required) :type pki_ezsigntemplatesigner_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsigntemplatesignerGetObjectV2Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsigntemplatesigner_get_object_v2_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsigntemplatesigner_get_object_v2_with_http_info(pki_ezsigntemplatesigner_id, **kwargs) # noqa: E501 - - @validate_arguments - def ezsigntemplatesigner_get_object_v2_with_http_info(self, pki_ezsigntemplatesigner_id : conint(strict=True, ge=0), **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve an existing Ezsigntemplatesigner # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsigntemplatesigner_get_object_v2_with_http_info(pki_ezsigntemplatesigner_id, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._ezsigntemplatesigner_get_object_v2_serialize( + pki_ezsigntemplatesigner_id=pki_ezsigntemplatesigner_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplatesignerGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsigntemplatesigner_get_object_v2_with_http_info( + self, + pki_ezsigntemplatesigner_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsigntemplatesignerGetObjectV2Response]: + """Retrieve an existing Ezsigntemplatesigner + + :param pki_ezsigntemplatesigner_id: (required) :type pki_ezsigntemplatesigner_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsigntemplatesignerGetObjectV2Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._ezsigntemplatesigner_get_object_v2_serialize( + pki_ezsigntemplatesigner_id=pki_ezsigntemplatesigner_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplatesignerGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'pki_ezsigntemplatesigner_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def ezsigntemplatesigner_get_object_v2_without_preload_content( + self, + pki_ezsigntemplatesigner_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve an existing Ezsigntemplatesigner + + + + :param pki_ezsigntemplatesigner_id: (required) + :type pki_ezsigntemplatesigner_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsigntemplatesigner_get_object_v2_serialize( + pki_ezsigntemplatesigner_id=pki_ezsigntemplatesigner_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsigntemplatesigner_get_object_v2" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntemplatesignerGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_ezsigntemplatesigner_id']: - _path_params['pkiEzsigntemplatesignerID'] = _params['pki_ezsigntemplatesigner_id'] + def _ezsigntemplatesigner_get_object_v2_serialize( + self, + pki_ezsigntemplatesigner_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_ezsigntemplatesigner_id is not None: + _path_params['pkiEzsigntemplatesignerID'] = pki_ezsigntemplatesigner_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "EzsigntemplatesignerGetObjectV2Response", - '404': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/2/object/ezsigntemplatesigner/{pkiEzsigntemplatesignerID}', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/2/object/ezsigntemplatesigner/{pkiEzsigntemplatesignerID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/eZmaxApi/api/object_ezsigntsarequirement_api.py b/eZmaxApi/api/object_ezsigntsarequirement_api.py index 827a974e0..d2c8eaa63 100644 --- a/eZmaxApi/api/object_ezsigntsarequirement_api.py +++ b/eZmaxApi/api/object_ezsigntsarequirement_api.py @@ -13,14 +13,20 @@ """ # noqa: E501 -import re # noqa: F401 import io import warnings -from pydantic import validate_arguments, ValidationError +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Dict, List, Optional, Tuple, Union, Any +try: + from typing import Annotated +except ImportError: + from typing_extensions import Annotated + +from pydantic import Field from typing_extensions import Annotated -from pydantic import Field, StrictStr, conint +from pydantic import StrictStr, field_validator from typing import Optional @@ -29,10 +35,7 @@ from eZmaxApi.api_client import ApiClient from eZmaxApi.api_response import ApiResponse -from eZmaxApi.exceptions import ( # noqa: F401 - ApiTypeError, - ApiValueError -) +from eZmaxApi.rest import RESTResponseType class ObjectEzsigntsarequirementApi: @@ -47,16 +50,31 @@ def __init__(self, api_client=None) -> None: api_client = ApiClient.get_default() self.api_client = api_client - @validate_arguments - def ezsigntsarequirement_get_autocomplete_v2(self, s_selector : Annotated[StrictStr, Field(..., description="The type of Ezsigntsarequirements to return")], fki_ezsignfoldertype_id : Optional[conint(strict=True, ge=0)] = None, e_filter_active : Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, s_query : Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, accept_language : Optional[HeaderAcceptLanguage] = None, **kwargs) -> EzsigntsarequirementGetAutocompleteV2Response: # noqa: E501 - """Retrieve Ezsigntsarequirements and IDs # noqa: E501 - Get the list of Ezsigntsarequirement to be used in a dropdown or autocomplete control. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def ezsigntsarequirement_get_autocomplete_v2( + self, + s_selector: Annotated[StrictStr, Field(description="The type of Ezsigntsarequirements to return")], + fki_ezsignfoldertype_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = None, + e_filter_active: Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, + s_query: Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsigntsarequirementGetAutocompleteV2Response: + """Retrieve Ezsigntsarequirements and IDs - >>> thread = api.ezsigntsarequirement_get_autocomplete_v2(s_selector, fki_ezsignfoldertype_id, e_filter_active, s_query, accept_language, async_req=True) - >>> result = thread.get() + Get the list of Ezsigntsarequirement to be used in a dropdown or autocomplete control. :param s_selector: The type of Ezsigntsarequirements to return (required) :type s_selector: str @@ -68,33 +86,78 @@ def ezsigntsarequirement_get_autocomplete_v2(self, s_selector : Annotated[Strict :type s_query: str :param accept_language: :type accept_language: HeaderAcceptLanguage - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: EzsigntsarequirementGetAutocompleteV2Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the ezsigntsarequirement_get_autocomplete_v2_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.ezsigntsarequirement_get_autocomplete_v2_with_http_info(s_selector, fki_ezsignfoldertype_id, e_filter_active, s_query, accept_language, **kwargs) # noqa: E501 - - @validate_arguments - def ezsigntsarequirement_get_autocomplete_v2_with_http_info(self, s_selector : Annotated[StrictStr, Field(..., description="The type of Ezsigntsarequirements to return")], fki_ezsignfoldertype_id : Optional[conint(strict=True, ge=0)] = None, e_filter_active : Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, s_query : Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, accept_language : Optional[HeaderAcceptLanguage] = None, **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve Ezsigntsarequirements and IDs # noqa: E501 - - Get the list of Ezsigntsarequirement to be used in a dropdown or autocomplete control. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ezsigntsarequirement_get_autocomplete_v2_with_http_info(s_selector, fki_ezsignfoldertype_id, e_filter_active, s_query, accept_language, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._ezsigntsarequirement_get_autocomplete_v2_serialize( + s_selector=s_selector, + fki_ezsignfoldertype_id=fki_ezsignfoldertype_id, + e_filter_active=e_filter_active, + s_query=s_query, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntsarequirementGetAutocompleteV2Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsigntsarequirement_get_autocomplete_v2_with_http_info( + self, + s_selector: Annotated[StrictStr, Field(description="The type of Ezsigntsarequirements to return")], + fki_ezsignfoldertype_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = None, + e_filter_active: Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, + s_query: Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsigntsarequirementGetAutocompleteV2Response]: + """Retrieve Ezsigntsarequirements and IDs + + Get the list of Ezsigntsarequirement to be used in a dropdown or autocomplete control. :param s_selector: The type of Ezsigntsarequirements to return (required) :type s_selector: str @@ -106,115 +169,207 @@ def ezsigntsarequirement_get_autocomplete_v2_with_http_info(self, s_selector : A :type s_query: str :param accept_language: :type accept_language: HeaderAcceptLanguage - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(EzsigntsarequirementGetAutocompleteV2Response, status_code(int), headers(HTTPHeaderDict)) - """ - - _params = locals() - - _all_params = [ - 's_selector', - 'fki_ezsignfoldertype_id', - 'e_filter_active', - 's_query', - 'accept_language' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' - ] + """ # noqa: E501 + + _param = self._ezsigntsarequirement_get_autocomplete_v2_serialize( + s_selector=s_selector, + fki_ezsignfoldertype_id=fki_ezsignfoldertype_id, + e_filter_active=e_filter_active, + s_query=s_query, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method ezsigntsarequirement_get_autocomplete_v2" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntsarequirementGetAutocompleteV2Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['s_selector']: - _path_params['sSelector'] = _params['s_selector'] + @validate_call + def ezsigntsarequirement_get_autocomplete_v2_without_preload_content( + self, + s_selector: Annotated[StrictStr, Field(description="The type of Ezsigntsarequirements to return")], + fki_ezsignfoldertype_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = None, + e_filter_active: Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, + s_query: Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve Ezsigntsarequirements and IDs + Get the list of Ezsigntsarequirement to be used in a dropdown or autocomplete control. - # process the query parameters - _query_params = [] - if _params.get('fki_ezsignfoldertype_id') is not None: # noqa: E501 - _query_params.append(('fkiEzsignfoldertypeID', _params['fki_ezsignfoldertype_id'])) + :param s_selector: The type of Ezsigntsarequirements to return (required) + :type s_selector: str + :param fki_ezsignfoldertype_id: + :type fki_ezsignfoldertype_id: int + :param e_filter_active: Specify which results we want to display. + :type e_filter_active: str + :param s_query: Allow to filter the returned results + :type s_query: str + :param accept_language: + :type accept_language: HeaderAcceptLanguage + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsigntsarequirement_get_autocomplete_v2_serialize( + s_selector=s_selector, + fki_ezsignfoldertype_id=fki_ezsignfoldertype_id, + e_filter_active=e_filter_active, + s_query=s_query, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - if _params.get('e_filter_active') is not None: # noqa: E501 - _query_params.append(('eFilterActive', _params['e_filter_active'])) + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigntsarequirementGetAutocompleteV2Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - if _params.get('s_query') is not None: # noqa: E501 - _query_params.append(('sQuery', _params['s_query'])) - # process the header parameters - _header_params = dict(_params.get('_headers', {})) - if _params['accept_language']: - _header_params['Accept-Language'] = _params['accept_language'] + def _ezsigntsarequirement_get_autocomplete_v2_serialize( + self, + s_selector, + fki_ezsignfoldertype_id, + e_filter_active, + s_query, + accept_language, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if s_selector is not None: + _path_params['sSelector'] = s_selector + # process the query parameters + if fki_ezsignfoldertype_id is not None: + + _query_params.append(('fkiEzsignfoldertypeID', fki_ezsignfoldertype_id)) + + if e_filter_active is not None: + + _query_params.append(('eFilterActive', e_filter_active)) + + if s_query is not None: + + _query_params.append(('sQuery', s_query)) + + # process the header parameters + if accept_language is not None: + _header_params['Accept-Language'] = accept_language # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "EzsigntsarequirementGetAutocompleteV2Response", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/2/object/ezsigntsarequirement/getAutocomplete/{sSelector}', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/2/object/ezsigntsarequirement/getAutocomplete/{sSelector}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/eZmaxApi/api/object_font_api.py b/eZmaxApi/api/object_font_api.py index b7de2bd77..819fd259b 100644 --- a/eZmaxApi/api/object_font_api.py +++ b/eZmaxApi/api/object_font_api.py @@ -13,14 +13,20 @@ """ # noqa: E501 -import re # noqa: F401 import io import warnings -from pydantic import validate_arguments, ValidationError +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Dict, List, Optional, Tuple, Union, Any +try: + from typing import Annotated +except ImportError: + from typing_extensions import Annotated + +from pydantic import Field from typing_extensions import Annotated -from pydantic import Field, StrictStr +from pydantic import StrictStr, field_validator from typing import Optional @@ -29,10 +35,7 @@ from eZmaxApi.api_client import ApiClient from eZmaxApi.api_response import ApiResponse -from eZmaxApi.exceptions import ( # noqa: F401 - ApiTypeError, - ApiValueError -) +from eZmaxApi.rest import RESTResponseType class ObjectFontApi: @@ -47,16 +50,30 @@ def __init__(self, api_client=None) -> None: api_client = ApiClient.get_default() self.api_client = api_client - @validate_arguments - def font_get_autocomplete_v2(self, s_selector : Annotated[StrictStr, Field(..., description="The type of Fonts to return")], e_filter_active : Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, s_query : Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, accept_language : Optional[HeaderAcceptLanguage] = None, **kwargs) -> FontGetAutocompleteV2Response: # noqa: E501 - """Retrieve Fonts and IDs # noqa: E501 - Get the list of Font to be used in a dropdown or autocomplete control. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def font_get_autocomplete_v2( + self, + s_selector: Annotated[StrictStr, Field(description="The type of Fonts to return")], + e_filter_active: Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, + s_query: Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> FontGetAutocompleteV2Response: + """Retrieve Fonts and IDs - >>> thread = api.font_get_autocomplete_v2(s_selector, e_filter_active, s_query, accept_language, async_req=True) - >>> result = thread.get() + Get the list of Font to be used in a dropdown or autocomplete control. :param s_selector: The type of Fonts to return (required) :type s_selector: str @@ -66,33 +83,76 @@ def font_get_autocomplete_v2(self, s_selector : Annotated[StrictStr, Field(..., :type s_query: str :param accept_language: :type accept_language: HeaderAcceptLanguage - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: FontGetAutocompleteV2Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the font_get_autocomplete_v2_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.font_get_autocomplete_v2_with_http_info(s_selector, e_filter_active, s_query, accept_language, **kwargs) # noqa: E501 - - @validate_arguments - def font_get_autocomplete_v2_with_http_info(self, s_selector : Annotated[StrictStr, Field(..., description="The type of Fonts to return")], e_filter_active : Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, s_query : Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, accept_language : Optional[HeaderAcceptLanguage] = None, **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve Fonts and IDs # noqa: E501 - - Get the list of Font to be used in a dropdown or autocomplete control. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.font_get_autocomplete_v2_with_http_info(s_selector, e_filter_active, s_query, accept_language, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._font_get_autocomplete_v2_serialize( + s_selector=s_selector, + e_filter_active=e_filter_active, + s_query=s_query, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "FontGetAutocompleteV2Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def font_get_autocomplete_v2_with_http_info( + self, + s_selector: Annotated[StrictStr, Field(description="The type of Fonts to return")], + e_filter_active: Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, + s_query: Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[FontGetAutocompleteV2Response]: + """Retrieve Fonts and IDs + + Get the list of Font to be used in a dropdown or autocomplete control. :param s_selector: The type of Fonts to return (required) :type s_selector: str @@ -102,111 +162,197 @@ def font_get_autocomplete_v2_with_http_info(self, s_selector : Annotated[StrictS :type s_query: str :param accept_language: :type accept_language: HeaderAcceptLanguage - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(FontGetAutocompleteV2Response, status_code(int), headers(HTTPHeaderDict)) - """ - - _params = locals() - - _all_params = [ - 's_selector', - 'e_filter_active', - 's_query', - 'accept_language' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + """ # noqa: E501 + + _param = self._font_get_autocomplete_v2_serialize( + s_selector=s_selector, + e_filter_active=e_filter_active, + s_query=s_query, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "FontGetAutocompleteV2Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def font_get_autocomplete_v2_without_preload_content( + self, + s_selector: Annotated[StrictStr, Field(description="The type of Fonts to return")], + e_filter_active: Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, + s_query: Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve Fonts and IDs + + Get the list of Font to be used in a dropdown or autocomplete control. + + :param s_selector: The type of Fonts to return (required) + :type s_selector: str + :param e_filter_active: Specify which results we want to display. + :type e_filter_active: str + :param s_query: Allow to filter the returned results + :type s_query: str + :param accept_language: + :type accept_language: HeaderAcceptLanguage + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._font_get_autocomplete_v2_serialize( + s_selector=s_selector, + e_filter_active=e_filter_active, + s_query=s_query, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method font_get_autocomplete_v2" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "FontGetAutocompleteV2Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['s_selector']: - _path_params['sSelector'] = _params['s_selector'] + def _font_get_autocomplete_v2_serialize( + self, + s_selector, + e_filter_active, + s_query, + accept_language, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None - # process the query parameters - _query_params = [] - if _params.get('e_filter_active') is not None: # noqa: E501 - _query_params.append(('eFilterActive', _params['e_filter_active'])) + _collection_formats: Dict[str, str] = { + } - if _params.get('s_query') is not None: # noqa: E501 - _query_params.append(('sQuery', _params['s_query'])) + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if s_selector is not None: + _path_params['sSelector'] = s_selector + # process the query parameters + if e_filter_active is not None: + + _query_params.append(('eFilterActive', e_filter_active)) + + if s_query is not None: + + _query_params.append(('sQuery', s_query)) + # process the header parameters - _header_params = dict(_params.get('_headers', {})) - if _params['accept_language']: - _header_params['Accept-Language'] = _params['accept_language'] - + if accept_language is not None: + _header_params['Accept-Language'] = accept_language # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "FontGetAutocompleteV2Response", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/2/object/font/getAutocomplete/{sSelector}', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/2/object/font/getAutocomplete/{sSelector}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/eZmaxApi/api/object_franchisebroker_api.py b/eZmaxApi/api/object_franchisebroker_api.py index 5a7543fba..6de770279 100644 --- a/eZmaxApi/api/object_franchisebroker_api.py +++ b/eZmaxApi/api/object_franchisebroker_api.py @@ -13,14 +13,20 @@ """ # noqa: E501 -import re # noqa: F401 import io import warnings -from pydantic import validate_arguments, ValidationError +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Dict, List, Optional, Tuple, Union, Any +try: + from typing import Annotated +except ImportError: + from typing_extensions import Annotated + +from pydantic import Field from typing_extensions import Annotated -from pydantic import Field, StrictStr +from pydantic import StrictStr, field_validator from typing import Optional @@ -30,10 +36,7 @@ from eZmaxApi.api_client import ApiClient from eZmaxApi.api_response import ApiResponse -from eZmaxApi.exceptions import ( # noqa: F401 - ApiTypeError, - ApiValueError -) +from eZmaxApi.rest import RESTResponseType class ObjectFranchisebrokerApi: @@ -48,16 +51,30 @@ def __init__(self, api_client=None) -> None: api_client = ApiClient.get_default() self.api_client = api_client - @validate_arguments - def franchisebroker_get_autocomplete_v1(self, s_selector : Annotated[StrictStr, Field(..., description="The type of Franchisebrokers to return")], e_filter_active : Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, s_query : Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, accept_language : Optional[HeaderAcceptLanguage] = None, **kwargs) -> CommonGetAutocompleteV1Response: # noqa: E501 - """(Deprecated) Retrieve Franchisebrokers and IDs # noqa: E501 - Get the list of Franchisebrokers to be used in a dropdown or autocomplete control. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def franchisebroker_get_autocomplete_v1( + self, + s_selector: Annotated[StrictStr, Field(description="The type of Franchisebrokers to return")], + e_filter_active: Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, + s_query: Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> CommonGetAutocompleteV1Response: + """(Deprecated) Retrieve Franchisebrokers and IDs - >>> thread = api.franchisebroker_get_autocomplete_v1(s_selector, e_filter_active, s_query, accept_language, async_req=True) - >>> result = thread.get() + Get the list of Franchisebrokers to be used in a dropdown or autocomplete control. :param s_selector: The type of Franchisebrokers to return (required) :type s_selector: str @@ -67,33 +84,77 @@ def franchisebroker_get_autocomplete_v1(self, s_selector : Annotated[StrictStr, :type s_query: str :param accept_language: :type accept_language: HeaderAcceptLanguage - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: CommonGetAutocompleteV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the franchisebroker_get_autocomplete_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.franchisebroker_get_autocomplete_v1_with_http_info(s_selector, e_filter_active, s_query, accept_language, **kwargs) # noqa: E501 - - @validate_arguments - def franchisebroker_get_autocomplete_v1_with_http_info(self, s_selector : Annotated[StrictStr, Field(..., description="The type of Franchisebrokers to return")], e_filter_active : Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, s_query : Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, accept_language : Optional[HeaderAcceptLanguage] = None, **kwargs) -> ApiResponse: # noqa: E501 - """(Deprecated) Retrieve Franchisebrokers and IDs # noqa: E501 - - Get the list of Franchisebrokers to be used in a dropdown or autocomplete control. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.franchisebroker_get_autocomplete_v1_with_http_info(s_selector, e_filter_active, s_query, accept_language, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + warnings.warn("GET /1/object/franchisebroker/getAutocomplete/{sSelector} is deprecated.", DeprecationWarning) + + _param = self._franchisebroker_get_autocomplete_v1_serialize( + s_selector=s_selector, + e_filter_active=e_filter_active, + s_query=s_query, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "CommonGetAutocompleteV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def franchisebroker_get_autocomplete_v1_with_http_info( + self, + s_selector: Annotated[StrictStr, Field(description="The type of Franchisebrokers to return")], + e_filter_active: Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, + s_query: Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[CommonGetAutocompleteV1Response]: + """(Deprecated) Retrieve Franchisebrokers and IDs + + Get the list of Franchisebrokers to be used in a dropdown or autocomplete control. :param s_selector: The type of Franchisebrokers to return (required) :type s_selector: str @@ -103,127 +164,227 @@ def franchisebroker_get_autocomplete_v1_with_http_info(self, s_selector : Annota :type s_query: str :param accept_language: :type accept_language: HeaderAcceptLanguage - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(CommonGetAutocompleteV1Response, status_code(int), headers(HTTPHeaderDict)) - """ - + """ # noqa: E501 warnings.warn("GET /1/object/franchisebroker/getAutocomplete/{sSelector} is deprecated.", DeprecationWarning) - _params = locals() + _param = self._franchisebroker_get_autocomplete_v1_serialize( + s_selector=s_selector, + e_filter_active=e_filter_active, + s_query=s_query, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _all_params = [ - 's_selector', - 'e_filter_active', - 's_query', - 'accept_language' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + _response_types_map: Dict[str, Optional[str]] = { + '200': "CommonGetAutocompleteV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def franchisebroker_get_autocomplete_v1_without_preload_content( + self, + s_selector: Annotated[StrictStr, Field(description="The type of Franchisebrokers to return")], + e_filter_active: Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, + s_query: Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """(Deprecated) Retrieve Franchisebrokers and IDs + + Get the list of Franchisebrokers to be used in a dropdown or autocomplete control. + + :param s_selector: The type of Franchisebrokers to return (required) + :type s_selector: str + :param e_filter_active: Specify which results we want to display. + :type e_filter_active: str + :param s_query: Allow to filter the returned results + :type s_query: str + :param accept_language: + :type accept_language: HeaderAcceptLanguage + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + warnings.warn("GET /1/object/franchisebroker/getAutocomplete/{sSelector} is deprecated.", DeprecationWarning) + + _param = self._franchisebroker_get_autocomplete_v1_serialize( + s_selector=s_selector, + e_filter_active=e_filter_active, + s_query=s_query, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method franchisebroker_get_autocomplete_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "CommonGetAutocompleteV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['s_selector']: - _path_params['sSelector'] = _params['s_selector'] + def _franchisebroker_get_autocomplete_v1_serialize( + self, + s_selector, + e_filter_active, + s_query, + accept_language, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None - # process the query parameters - _query_params = [] - if _params.get('e_filter_active') is not None: # noqa: E501 - _query_params.append(('eFilterActive', _params['e_filter_active'])) + _collection_formats: Dict[str, str] = { + } - if _params.get('s_query') is not None: # noqa: E501 - _query_params.append(('sQuery', _params['s_query'])) + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if s_selector is not None: + _path_params['sSelector'] = s_selector + # process the query parameters + if e_filter_active is not None: + + _query_params.append(('eFilterActive', e_filter_active)) + + if s_query is not None: + + _query_params.append(('sQuery', s_query)) + # process the header parameters - _header_params = dict(_params.get('_headers', {})) - if _params['accept_language']: - _header_params['Accept-Language'] = _params['accept_language'] - + if accept_language is not None: + _header_params['Accept-Language'] = accept_language # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "CommonGetAutocompleteV1Response", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/franchisebroker/getAutocomplete/{sSelector}', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/1/object/franchisebroker/getAutocomplete/{sSelector}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) - @validate_arguments - def franchisebroker_get_autocomplete_v2(self, s_selector : Annotated[StrictStr, Field(..., description="The type of Franchisebrokers to return")], e_filter_active : Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, s_query : Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, accept_language : Optional[HeaderAcceptLanguage] = None, **kwargs) -> FranchisebrokerGetAutocompleteV2Response: # noqa: E501 - """Retrieve Franchisebrokers and IDs # noqa: E501 - Get the list of Franchisebroker to be used in a dropdown or autocomplete control. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.franchisebroker_get_autocomplete_v2(s_selector, e_filter_active, s_query, accept_language, async_req=True) - >>> result = thread.get() + + @validate_call + def franchisebroker_get_autocomplete_v2( + self, + s_selector: Annotated[StrictStr, Field(description="The type of Franchisebrokers to return")], + e_filter_active: Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, + s_query: Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> FranchisebrokerGetAutocompleteV2Response: + """Retrieve Franchisebrokers and IDs + + Get the list of Franchisebroker to be used in a dropdown or autocomplete control. :param s_selector: The type of Franchisebrokers to return (required) :type s_selector: str @@ -233,33 +394,76 @@ def franchisebroker_get_autocomplete_v2(self, s_selector : Annotated[StrictStr, :type s_query: str :param accept_language: :type accept_language: HeaderAcceptLanguage - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: FranchisebrokerGetAutocompleteV2Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the franchisebroker_get_autocomplete_v2_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.franchisebroker_get_autocomplete_v2_with_http_info(s_selector, e_filter_active, s_query, accept_language, **kwargs) # noqa: E501 - - @validate_arguments - def franchisebroker_get_autocomplete_v2_with_http_info(self, s_selector : Annotated[StrictStr, Field(..., description="The type of Franchisebrokers to return")], e_filter_active : Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, s_query : Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, accept_language : Optional[HeaderAcceptLanguage] = None, **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve Franchisebrokers and IDs # noqa: E501 - - Get the list of Franchisebroker to be used in a dropdown or autocomplete control. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.franchisebroker_get_autocomplete_v2_with_http_info(s_selector, e_filter_active, s_query, accept_language, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._franchisebroker_get_autocomplete_v2_serialize( + s_selector=s_selector, + e_filter_active=e_filter_active, + s_query=s_query, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "FranchisebrokerGetAutocompleteV2Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def franchisebroker_get_autocomplete_v2_with_http_info( + self, + s_selector: Annotated[StrictStr, Field(description="The type of Franchisebrokers to return")], + e_filter_active: Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, + s_query: Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[FranchisebrokerGetAutocompleteV2Response]: + """Retrieve Franchisebrokers and IDs + + Get the list of Franchisebroker to be used in a dropdown or autocomplete control. :param s_selector: The type of Franchisebrokers to return (required) :type s_selector: str @@ -269,111 +473,197 @@ def franchisebroker_get_autocomplete_v2_with_http_info(self, s_selector : Annota :type s_query: str :param accept_language: :type accept_language: HeaderAcceptLanguage - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(FranchisebrokerGetAutocompleteV2Response, status_code(int), headers(HTTPHeaderDict)) - """ - - _params = locals() - - _all_params = [ - 's_selector', - 'e_filter_active', - 's_query', - 'accept_language' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + """ # noqa: E501 + + _param = self._franchisebroker_get_autocomplete_v2_serialize( + s_selector=s_selector, + e_filter_active=e_filter_active, + s_query=s_query, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "FranchisebrokerGetAutocompleteV2Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def franchisebroker_get_autocomplete_v2_without_preload_content( + self, + s_selector: Annotated[StrictStr, Field(description="The type of Franchisebrokers to return")], + e_filter_active: Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, + s_query: Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve Franchisebrokers and IDs + + Get the list of Franchisebroker to be used in a dropdown or autocomplete control. + + :param s_selector: The type of Franchisebrokers to return (required) + :type s_selector: str + :param e_filter_active: Specify which results we want to display. + :type e_filter_active: str + :param s_query: Allow to filter the returned results + :type s_query: str + :param accept_language: + :type accept_language: HeaderAcceptLanguage + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._franchisebroker_get_autocomplete_v2_serialize( + s_selector=s_selector, + e_filter_active=e_filter_active, + s_query=s_query, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method franchisebroker_get_autocomplete_v2" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "FranchisebrokerGetAutocompleteV2Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['s_selector']: - _path_params['sSelector'] = _params['s_selector'] + def _franchisebroker_get_autocomplete_v2_serialize( + self, + s_selector, + e_filter_active, + s_query, + accept_language, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None - # process the query parameters - _query_params = [] - if _params.get('e_filter_active') is not None: # noqa: E501 - _query_params.append(('eFilterActive', _params['e_filter_active'])) + _collection_formats: Dict[str, str] = { + } - if _params.get('s_query') is not None: # noqa: E501 - _query_params.append(('sQuery', _params['s_query'])) + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if s_selector is not None: + _path_params['sSelector'] = s_selector + # process the query parameters + if e_filter_active is not None: + + _query_params.append(('eFilterActive', e_filter_active)) + + if s_query is not None: + + _query_params.append(('sQuery', s_query)) + # process the header parameters - _header_params = dict(_params.get('_headers', {})) - if _params['accept_language']: - _header_params['Accept-Language'] = _params['accept_language'] - + if accept_language is not None: + _header_params['Accept-Language'] = accept_language # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "FranchisebrokerGetAutocompleteV2Response", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/2/object/franchisebroker/getAutocomplete/{sSelector}', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/2/object/franchisebroker/getAutocomplete/{sSelector}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/eZmaxApi/api/object_franchiseoffice_api.py b/eZmaxApi/api/object_franchiseoffice_api.py index 313acb0ed..026ec902f 100644 --- a/eZmaxApi/api/object_franchiseoffice_api.py +++ b/eZmaxApi/api/object_franchiseoffice_api.py @@ -13,14 +13,20 @@ """ # noqa: E501 -import re # noqa: F401 import io import warnings -from pydantic import validate_arguments, ValidationError +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Dict, List, Optional, Tuple, Union, Any +try: + from typing import Annotated +except ImportError: + from typing_extensions import Annotated + +from pydantic import Field from typing_extensions import Annotated -from pydantic import Field, StrictStr +from pydantic import StrictStr, field_validator from typing import Optional @@ -29,10 +35,7 @@ from eZmaxApi.api_client import ApiClient from eZmaxApi.api_response import ApiResponse -from eZmaxApi.exceptions import ( # noqa: F401 - ApiTypeError, - ApiValueError -) +from eZmaxApi.rest import RESTResponseType class ObjectFranchiseofficeApi: @@ -47,16 +50,30 @@ def __init__(self, api_client=None) -> None: api_client = ApiClient.get_default() self.api_client = api_client - @validate_arguments - def franchiseoffice_get_autocomplete_v2(self, s_selector : Annotated[StrictStr, Field(..., description="The type of Franchiseoffices to return")], e_filter_active : Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, s_query : Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, accept_language : Optional[HeaderAcceptLanguage] = None, **kwargs) -> FranchiseofficeGetAutocompleteV2Response: # noqa: E501 - """Retrieve Franchiseoffices and IDs # noqa: E501 - Get the list of Franchiseoffice to be used in a dropdown or autocomplete control. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def franchiseoffice_get_autocomplete_v2( + self, + s_selector: Annotated[StrictStr, Field(description="The type of Franchiseoffices to return")], + e_filter_active: Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, + s_query: Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> FranchiseofficeGetAutocompleteV2Response: + """Retrieve Franchiseoffices and IDs - >>> thread = api.franchiseoffice_get_autocomplete_v2(s_selector, e_filter_active, s_query, accept_language, async_req=True) - >>> result = thread.get() + Get the list of Franchiseoffice to be used in a dropdown or autocomplete control. :param s_selector: The type of Franchiseoffices to return (required) :type s_selector: str @@ -66,33 +83,76 @@ def franchiseoffice_get_autocomplete_v2(self, s_selector : Annotated[StrictStr, :type s_query: str :param accept_language: :type accept_language: HeaderAcceptLanguage - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: FranchiseofficeGetAutocompleteV2Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the franchiseoffice_get_autocomplete_v2_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.franchiseoffice_get_autocomplete_v2_with_http_info(s_selector, e_filter_active, s_query, accept_language, **kwargs) # noqa: E501 - - @validate_arguments - def franchiseoffice_get_autocomplete_v2_with_http_info(self, s_selector : Annotated[StrictStr, Field(..., description="The type of Franchiseoffices to return")], e_filter_active : Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, s_query : Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, accept_language : Optional[HeaderAcceptLanguage] = None, **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve Franchiseoffices and IDs # noqa: E501 - - Get the list of Franchiseoffice to be used in a dropdown or autocomplete control. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.franchiseoffice_get_autocomplete_v2_with_http_info(s_selector, e_filter_active, s_query, accept_language, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._franchiseoffice_get_autocomplete_v2_serialize( + s_selector=s_selector, + e_filter_active=e_filter_active, + s_query=s_query, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "FranchiseofficeGetAutocompleteV2Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def franchiseoffice_get_autocomplete_v2_with_http_info( + self, + s_selector: Annotated[StrictStr, Field(description="The type of Franchiseoffices to return")], + e_filter_active: Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, + s_query: Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[FranchiseofficeGetAutocompleteV2Response]: + """Retrieve Franchiseoffices and IDs + + Get the list of Franchiseoffice to be used in a dropdown or autocomplete control. :param s_selector: The type of Franchiseoffices to return (required) :type s_selector: str @@ -102,111 +162,197 @@ def franchiseoffice_get_autocomplete_v2_with_http_info(self, s_selector : Annota :type s_query: str :param accept_language: :type accept_language: HeaderAcceptLanguage - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(FranchiseofficeGetAutocompleteV2Response, status_code(int), headers(HTTPHeaderDict)) - """ - - _params = locals() - - _all_params = [ - 's_selector', - 'e_filter_active', - 's_query', - 'accept_language' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + """ # noqa: E501 + + _param = self._franchiseoffice_get_autocomplete_v2_serialize( + s_selector=s_selector, + e_filter_active=e_filter_active, + s_query=s_query, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "FranchiseofficeGetAutocompleteV2Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def franchiseoffice_get_autocomplete_v2_without_preload_content( + self, + s_selector: Annotated[StrictStr, Field(description="The type of Franchiseoffices to return")], + e_filter_active: Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, + s_query: Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve Franchiseoffices and IDs + + Get the list of Franchiseoffice to be used in a dropdown or autocomplete control. + + :param s_selector: The type of Franchiseoffices to return (required) + :type s_selector: str + :param e_filter_active: Specify which results we want to display. + :type e_filter_active: str + :param s_query: Allow to filter the returned results + :type s_query: str + :param accept_language: + :type accept_language: HeaderAcceptLanguage + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._franchiseoffice_get_autocomplete_v2_serialize( + s_selector=s_selector, + e_filter_active=e_filter_active, + s_query=s_query, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method franchiseoffice_get_autocomplete_v2" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "FranchiseofficeGetAutocompleteV2Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['s_selector']: - _path_params['sSelector'] = _params['s_selector'] + def _franchiseoffice_get_autocomplete_v2_serialize( + self, + s_selector, + e_filter_active, + s_query, + accept_language, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None - # process the query parameters - _query_params = [] - if _params.get('e_filter_active') is not None: # noqa: E501 - _query_params.append(('eFilterActive', _params['e_filter_active'])) + _collection_formats: Dict[str, str] = { + } - if _params.get('s_query') is not None: # noqa: E501 - _query_params.append(('sQuery', _params['s_query'])) + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if s_selector is not None: + _path_params['sSelector'] = s_selector + # process the query parameters + if e_filter_active is not None: + + _query_params.append(('eFilterActive', e_filter_active)) + + if s_query is not None: + + _query_params.append(('sQuery', s_query)) + # process the header parameters - _header_params = dict(_params.get('_headers', {})) - if _params['accept_language']: - _header_params['Accept-Language'] = _params['accept_language'] - + if accept_language is not None: + _header_params['Accept-Language'] = accept_language # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "FranchiseofficeGetAutocompleteV2Response", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/2/object/franchiseoffice/getAutocomplete/{sSelector}', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/2/object/franchiseoffice/getAutocomplete/{sSelector}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/eZmaxApi/api/object_franchisereferalincome_api.py b/eZmaxApi/api/object_franchisereferalincome_api.py index 73fc2d637..3bfbb7adc 100644 --- a/eZmaxApi/api/object_franchisereferalincome_api.py +++ b/eZmaxApi/api/object_franchisereferalincome_api.py @@ -13,13 +13,18 @@ """ # noqa: E501 -import re # noqa: F401 import io import warnings -from pydantic import validate_arguments, ValidationError +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Dict, List, Optional, Tuple, Union, Any -from pydantic import conlist +try: + from typing import Annotated +except ImportError: + from typing_extensions import Annotated + +from typing import List from eZmaxApi.models.franchisereferalincome_create_object_v1_request import FranchisereferalincomeCreateObjectV1Request from eZmaxApi.models.franchisereferalincome_create_object_v1_response import FranchisereferalincomeCreateObjectV1Response @@ -28,10 +33,7 @@ from eZmaxApi.api_client import ApiClient from eZmaxApi.api_response import ApiResponse -from eZmaxApi.exceptions import ( # noqa: F401 - ApiTypeError, - ApiValueError -) +from eZmaxApi.rest import RESTResponseType class ObjectFranchisereferalincomeApi: @@ -46,298 +48,548 @@ def __init__(self, api_client=None) -> None: api_client = ApiClient.get_default() self.api_client = api_client - @validate_arguments - def franchisereferalincome_create_object_v1(self, franchisereferalincome_create_object_v1_request : conlist(FranchisereferalincomeCreateObjectV1Request), **kwargs) -> FranchisereferalincomeCreateObjectV1Response: # noqa: E501 - """(Deprecated) Create a new Franchisereferalincome # noqa: E501 - The endpoint allows to create one or many elements at once. The array can contain simple (Just the object) or compound (The object and its child) objects. Creating compound elements allows to reduce the multiple requests to create all child objects. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def franchisereferalincome_create_object_v1( + self, + franchisereferalincome_create_object_v1_request: List[FranchisereferalincomeCreateObjectV1Request], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> FranchisereferalincomeCreateObjectV1Response: + """(Deprecated) Create a new Franchisereferalincome - >>> thread = api.franchisereferalincome_create_object_v1(franchisereferalincome_create_object_v1_request, async_req=True) - >>> result = thread.get() + The endpoint allows to create one or many elements at once. The array can contain simple (Just the object) or compound (The object and its child) objects. Creating compound elements allows to reduce the multiple requests to create all child objects. :param franchisereferalincome_create_object_v1_request: (required) :type franchisereferalincome_create_object_v1_request: List[FranchisereferalincomeCreateObjectV1Request] - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: FranchisereferalincomeCreateObjectV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the franchisereferalincome_create_object_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.franchisereferalincome_create_object_v1_with_http_info(franchisereferalincome_create_object_v1_request, **kwargs) # noqa: E501 - - @validate_arguments - def franchisereferalincome_create_object_v1_with_http_info(self, franchisereferalincome_create_object_v1_request : conlist(FranchisereferalincomeCreateObjectV1Request), **kwargs) -> ApiResponse: # noqa: E501 - """(Deprecated) Create a new Franchisereferalincome # noqa: E501 - - The endpoint allows to create one or many elements at once. The array can contain simple (Just the object) or compound (The object and its child) objects. Creating compound elements allows to reduce the multiple requests to create all child objects. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.franchisereferalincome_create_object_v1_with_http_info(franchisereferalincome_create_object_v1_request, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + warnings.warn("POST /1/object/franchisereferalincome is deprecated.", DeprecationWarning) + + _param = self._franchisereferalincome_create_object_v1_serialize( + franchisereferalincome_create_object_v1_request=franchisereferalincome_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "FranchisereferalincomeCreateObjectV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def franchisereferalincome_create_object_v1_with_http_info( + self, + franchisereferalincome_create_object_v1_request: List[FranchisereferalincomeCreateObjectV1Request], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[FranchisereferalincomeCreateObjectV1Response]: + """(Deprecated) Create a new Franchisereferalincome + + The endpoint allows to create one or many elements at once. The array can contain simple (Just the object) or compound (The object and its child) objects. Creating compound elements allows to reduce the multiple requests to create all child objects. :param franchisereferalincome_create_object_v1_request: (required) :type franchisereferalincome_create_object_v1_request: List[FranchisereferalincomeCreateObjectV1Request] - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(FranchisereferalincomeCreateObjectV1Response, status_code(int), headers(HTTPHeaderDict)) - """ - + """ # noqa: E501 warnings.warn("POST /1/object/franchisereferalincome is deprecated.", DeprecationWarning) - _params = locals() + _param = self._franchisereferalincome_create_object_v1_serialize( + franchisereferalincome_create_object_v1_request=franchisereferalincome_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _all_params = [ - 'franchisereferalincome_create_object_v1_request' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + _response_types_map: Dict[str, Optional[str]] = { + '201': "FranchisereferalincomeCreateObjectV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def franchisereferalincome_create_object_v1_without_preload_content( + self, + franchisereferalincome_create_object_v1_request: List[FranchisereferalincomeCreateObjectV1Request], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """(Deprecated) Create a new Franchisereferalincome + + The endpoint allows to create one or many elements at once. The array can contain simple (Just the object) or compound (The object and its child) objects. Creating compound elements allows to reduce the multiple requests to create all child objects. + + :param franchisereferalincome_create_object_v1_request: (required) + :type franchisereferalincome_create_object_v1_request: List[FranchisereferalincomeCreateObjectV1Request] + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + warnings.warn("POST /1/object/franchisereferalincome is deprecated.", DeprecationWarning) + + _param = self._franchisereferalincome_create_object_v1_serialize( + franchisereferalincome_create_object_v1_request=franchisereferalincome_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method franchisereferalincome_create_object_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '201': "FranchisereferalincomeCreateObjectV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} + def _franchisereferalincome_create_object_v1_serialize( + self, + franchisereferalincome_create_object_v1_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None + + _collection_formats: Dict[str, str] = { + 'FranchisereferalincomeCreateObjectV1Request': '', + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['franchisereferalincome_create_object_v1_request'] is not None: - _body_params = _params['franchisereferalincome_create_object_v1_request'] + if franchisereferalincome_create_object_v1_request is not None: + _body_params = franchisereferalincome_create_object_v1_request + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '201': "FranchisereferalincomeCreateObjectV1Response", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/franchisereferalincome', 'POST', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='POST', + resource_path='/1/object/franchisereferalincome', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + - @validate_arguments - def franchisereferalincome_create_object_v2(self, franchisereferalincome_create_object_v2_request : FranchisereferalincomeCreateObjectV2Request, **kwargs) -> FranchisereferalincomeCreateObjectV2Response: # noqa: E501 - """Create a new Franchisereferalincome # noqa: E501 - The endpoint allows to create one or many elements at once. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.franchisereferalincome_create_object_v2(franchisereferalincome_create_object_v2_request, async_req=True) - >>> result = thread.get() + @validate_call + def franchisereferalincome_create_object_v2( + self, + franchisereferalincome_create_object_v2_request: FranchisereferalincomeCreateObjectV2Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> FranchisereferalincomeCreateObjectV2Response: + """Create a new Franchisereferalincome + + The endpoint allows to create one or many elements at once. :param franchisereferalincome_create_object_v2_request: (required) :type franchisereferalincome_create_object_v2_request: FranchisereferalincomeCreateObjectV2Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: FranchisereferalincomeCreateObjectV2Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the franchisereferalincome_create_object_v2_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.franchisereferalincome_create_object_v2_with_http_info(franchisereferalincome_create_object_v2_request, **kwargs) # noqa: E501 - - @validate_arguments - def franchisereferalincome_create_object_v2_with_http_info(self, franchisereferalincome_create_object_v2_request : FranchisereferalincomeCreateObjectV2Request, **kwargs) -> ApiResponse: # noqa: E501 - """Create a new Franchisereferalincome # noqa: E501 - - The endpoint allows to create one or many elements at once. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.franchisereferalincome_create_object_v2_with_http_info(franchisereferalincome_create_object_v2_request, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._franchisereferalincome_create_object_v2_serialize( + franchisereferalincome_create_object_v2_request=franchisereferalincome_create_object_v2_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "FranchisereferalincomeCreateObjectV2Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def franchisereferalincome_create_object_v2_with_http_info( + self, + franchisereferalincome_create_object_v2_request: FranchisereferalincomeCreateObjectV2Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[FranchisereferalincomeCreateObjectV2Response]: + """Create a new Franchisereferalincome + + The endpoint allows to create one or many elements at once. :param franchisereferalincome_create_object_v2_request: (required) :type franchisereferalincome_create_object_v2_request: FranchisereferalincomeCreateObjectV2Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(FranchisereferalincomeCreateObjectV2Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._franchisereferalincome_create_object_v2_serialize( + franchisereferalincome_create_object_v2_request=franchisereferalincome_create_object_v2_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '201': "FranchisereferalincomeCreateObjectV2Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'franchisereferalincome_create_object_v2_request' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def franchisereferalincome_create_object_v2_without_preload_content( + self, + franchisereferalincome_create_object_v2_request: FranchisereferalincomeCreateObjectV2Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Create a new Franchisereferalincome + + The endpoint allows to create one or many elements at once. + + :param franchisereferalincome_create_object_v2_request: (required) + :type franchisereferalincome_create_object_v2_request: FranchisereferalincomeCreateObjectV2Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._franchisereferalincome_create_object_v2_serialize( + franchisereferalincome_create_object_v2_request=franchisereferalincome_create_object_v2_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method franchisereferalincome_create_object_v2" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '201': "FranchisereferalincomeCreateObjectV2Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} + def _franchisereferalincome_create_object_v2_serialize( + self, + franchisereferalincome_create_object_v2_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['franchisereferalincome_create_object_v2_request'] is not None: - _body_params = _params['franchisereferalincome_create_object_v2_request'] + if franchisereferalincome_create_object_v2_request is not None: + _body_params = franchisereferalincome_create_object_v2_request + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '201': "FranchisereferalincomeCreateObjectV2Response", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/2/object/franchisereferalincome', 'POST', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='POST', + resource_path='/2/object/franchisereferalincome', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/eZmaxApi/api/object_inscription_api.py b/eZmaxApi/api/object_inscription_api.py index a535abb00..9fb2c28e2 100644 --- a/eZmaxApi/api/object_inscription_api.py +++ b/eZmaxApi/api/object_inscription_api.py @@ -13,22 +13,26 @@ """ # noqa: E501 -import re # noqa: F401 import io import warnings -from pydantic import validate_arguments, ValidationError +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Dict, List, Optional, Tuple, Union, Any -from pydantic import conint +try: + from typing import Annotated +except ImportError: + from typing_extensions import Annotated +from pydantic import Field +from typing_extensions import Annotated +from eZmaxApi.models.inscription_get_attachments_v1_response import InscriptionGetAttachmentsV1Response from eZmaxApi.models.inscription_get_communication_list_v1_response import InscriptionGetCommunicationListV1Response +from eZmaxApi.models.inscription_get_communicationsenders_v1_response import InscriptionGetCommunicationsendersV1Response from eZmaxApi.api_client import ApiClient from eZmaxApi.api_response import ApiResponse -from eZmaxApi.exceptions import ( # noqa: F401 - ApiTypeError, - ApiValueError -) +from eZmaxApi.rest import RESTResponseType class ObjectInscriptionApi: @@ -43,143 +47,785 @@ def __init__(self, api_client=None) -> None: api_client = ApiClient.get_default() self.api_client = api_client - @validate_arguments - def inscription_get_communication_list_v1(self, pki_inscription_id : conint(strict=True, ge=0), **kwargs) -> InscriptionGetCommunicationListV1Response: # noqa: E501 - """Retrieve Communication list # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def inscription_get_attachments_v1( + self, + pki_inscription_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> InscriptionGetAttachmentsV1Response: + """Retrieve Inscription's Attachments - >>> thread = api.inscription_get_communication_list_v1(pki_inscription_id, async_req=True) - >>> result = thread.get() + :param pki_inscription_id: (required) :type pki_inscription_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: InscriptionGetCommunicationListV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the inscription_get_communication_list_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.inscription_get_communication_list_v1_with_http_info(pki_inscription_id, **kwargs) # noqa: E501 - - @validate_arguments - def inscription_get_communication_list_v1_with_http_info(self, pki_inscription_id : conint(strict=True, ge=0), **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve Communication list # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.inscription_get_communication_list_v1_with_http_info(pki_inscription_id, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._inscription_get_attachments_v1_serialize( + pki_inscription_id=pki_inscription_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "InscriptionGetAttachmentsV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def inscription_get_attachments_v1_with_http_info( + self, + pki_inscription_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[InscriptionGetAttachmentsV1Response]: + """Retrieve Inscription's Attachments + + :param pki_inscription_id: (required) :type pki_inscription_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(InscriptionGetCommunicationListV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._inscription_get_attachments_v1_serialize( + pki_inscription_id=pki_inscription_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '200': "InscriptionGetAttachmentsV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'pki_inscription_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def inscription_get_attachments_v1_without_preload_content( + self, + pki_inscription_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve Inscription's Attachments + + + + :param pki_inscription_id: (required) + :type pki_inscription_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._inscription_get_attachments_v1_serialize( + pki_inscription_id=pki_inscription_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method inscription_get_communication_list_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "InscriptionGetAttachmentsV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_inscription_id']: - _path_params['pkiInscriptionID'] = _params['pki_inscription_id'] + def _inscription_get_attachments_v1_serialize( + self, + pki_inscription_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None + + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_inscription_id is not None: + _path_params['pkiInscriptionID'] = pki_inscription_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) + # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 + _auth_settings: List[str] = [ + 'Authorization' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/1/object/inscription/{pkiInscriptionID}/getAttachments', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + - _response_types_map = { + + + @validate_call + def inscription_get_communication_list_v1( + self, + pki_inscription_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> InscriptionGetCommunicationListV1Response: + """Retrieve Communication list + + + + :param pki_inscription_id: (required) + :type pki_inscription_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._inscription_get_communication_list_v1_serialize( + pki_inscription_id=pki_inscription_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "InscriptionGetCommunicationListV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def inscription_get_communication_list_v1_with_http_info( + self, + pki_inscription_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[InscriptionGetCommunicationListV1Response]: + """Retrieve Communication list + + + + :param pki_inscription_id: (required) + :type pki_inscription_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._inscription_get_communication_list_v1_serialize( + pki_inscription_id=pki_inscription_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { '200': "InscriptionGetCommunicationListV1Response", '404': "CommonResponseError", } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def inscription_get_communication_list_v1_without_preload_content( + self, + pki_inscription_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve Communication list + + + + :param pki_inscription_id: (required) + :type pki_inscription_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._inscription_get_communication_list_v1_serialize( + pki_inscription_id=pki_inscription_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "InscriptionGetCommunicationListV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - return self.api_client.call_api( - '/1/object/inscription/{pkiInscriptionID}/getCommunicationList', 'GET', - _path_params, - _query_params, - _header_params, + + def _inscription_get_communication_list_v1_serialize( + self, + pki_inscription_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_inscription_id is not None: + _path_params['pkiInscriptionID'] = pki_inscription_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/1/object/inscription/{pkiInscriptionID}/getCommunicationList', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def inscription_get_communicationsenders_v1( + self, + pki_inscription_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> InscriptionGetCommunicationsendersV1Response: + """Retrieve Inscription's Communicationsender + + + + :param pki_inscription_id: (required) + :type pki_inscription_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._inscription_get_communicationsenders_v1_serialize( + pki_inscription_id=pki_inscription_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "InscriptionGetCommunicationsendersV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, response_types_map=_response_types_map, + ).data + + + @validate_call + def inscription_get_communicationsenders_v1_with_http_info( + self, + pki_inscription_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[InscriptionGetCommunicationsendersV1Response]: + """Retrieve Inscription's Communicationsender + + + + :param pki_inscription_id: (required) + :type pki_inscription_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._inscription_get_communicationsenders_v1_serialize( + pki_inscription_id=pki_inscription_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "InscriptionGetCommunicationsendersV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def inscription_get_communicationsenders_v1_without_preload_content( + self, + pki_inscription_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve Inscription's Communicationsender + + + + :param pki_inscription_id: (required) + :type pki_inscription_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._inscription_get_communicationsenders_v1_serialize( + pki_inscription_id=pki_inscription_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "InscriptionGetCommunicationsendersV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _inscription_get_communicationsenders_v1_serialize( + self, + pki_inscription_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_inscription_id is not None: + _path_params['pkiInscriptionID'] = pki_inscription_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/1/object/inscription/{pkiInscriptionID}/getCommunicationsenders', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/eZmaxApi/api/object_inscriptionnotauthenticated_api.py b/eZmaxApi/api/object_inscriptionnotauthenticated_api.py index fdb9b897b..d93e28bab 100644 --- a/eZmaxApi/api/object_inscriptionnotauthenticated_api.py +++ b/eZmaxApi/api/object_inscriptionnotauthenticated_api.py @@ -13,22 +13,24 @@ """ # noqa: E501 -import re # noqa: F401 import io import warnings -from pydantic import validate_arguments, ValidationError +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Dict, List, Optional, Tuple, Union, Any -from pydantic import conint +try: + from typing import Annotated +except ImportError: + from typing_extensions import Annotated +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.inscriptionnotauthenticated_get_communication_list_v1_response import InscriptionnotauthenticatedGetCommunicationListV1Response from eZmaxApi.api_client import ApiClient from eZmaxApi.api_response import ApiResponse -from eZmaxApi.exceptions import ( # noqa: F401 - ApiTypeError, - ApiValueError -) +from eZmaxApi.rest import RESTResponseType class ObjectInscriptionnotauthenticatedApi: @@ -43,143 +45,263 @@ def __init__(self, api_client=None) -> None: api_client = ApiClient.get_default() self.api_client = api_client - @validate_arguments - def inscriptionnotauthenticated_get_communication_list_v1(self, pki_inscriptionnotauthenticated_id : conint(strict=True, ge=0), **kwargs) -> InscriptionnotauthenticatedGetCommunicationListV1Response: # noqa: E501 - """Retrieve Communication list # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def inscriptionnotauthenticated_get_communication_list_v1( + self, + pki_inscriptionnotauthenticated_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> InscriptionnotauthenticatedGetCommunicationListV1Response: + """Retrieve Communication list - >>> thread = api.inscriptionnotauthenticated_get_communication_list_v1(pki_inscriptionnotauthenticated_id, async_req=True) - >>> result = thread.get() + :param pki_inscriptionnotauthenticated_id: (required) :type pki_inscriptionnotauthenticated_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: InscriptionnotauthenticatedGetCommunicationListV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the inscriptionnotauthenticated_get_communication_list_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.inscriptionnotauthenticated_get_communication_list_v1_with_http_info(pki_inscriptionnotauthenticated_id, **kwargs) # noqa: E501 - - @validate_arguments - def inscriptionnotauthenticated_get_communication_list_v1_with_http_info(self, pki_inscriptionnotauthenticated_id : conint(strict=True, ge=0), **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve Communication list # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.inscriptionnotauthenticated_get_communication_list_v1_with_http_info(pki_inscriptionnotauthenticated_id, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._inscriptionnotauthenticated_get_communication_list_v1_serialize( + pki_inscriptionnotauthenticated_id=pki_inscriptionnotauthenticated_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "InscriptionnotauthenticatedGetCommunicationListV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def inscriptionnotauthenticated_get_communication_list_v1_with_http_info( + self, + pki_inscriptionnotauthenticated_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[InscriptionnotauthenticatedGetCommunicationListV1Response]: + """Retrieve Communication list + + :param pki_inscriptionnotauthenticated_id: (required) :type pki_inscriptionnotauthenticated_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(InscriptionnotauthenticatedGetCommunicationListV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._inscriptionnotauthenticated_get_communication_list_v1_serialize( + pki_inscriptionnotauthenticated_id=pki_inscriptionnotauthenticated_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '200': "InscriptionnotauthenticatedGetCommunicationListV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'pki_inscriptionnotauthenticated_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def inscriptionnotauthenticated_get_communication_list_v1_without_preload_content( + self, + pki_inscriptionnotauthenticated_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve Communication list + + + + :param pki_inscriptionnotauthenticated_id: (required) + :type pki_inscriptionnotauthenticated_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._inscriptionnotauthenticated_get_communication_list_v1_serialize( + pki_inscriptionnotauthenticated_id=pki_inscriptionnotauthenticated_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method inscriptionnotauthenticated_get_communication_list_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "InscriptionnotauthenticatedGetCommunicationListV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_inscriptionnotauthenticated_id']: - _path_params['pkiInscriptionnotauthenticatedID'] = _params['pki_inscriptionnotauthenticated_id'] + def _inscriptionnotauthenticated_get_communication_list_v1_serialize( + self, + pki_inscriptionnotauthenticated_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_inscriptionnotauthenticated_id is not None: + _path_params['pkiInscriptionnotauthenticatedID'] = pki_inscriptionnotauthenticated_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "InscriptionnotauthenticatedGetCommunicationListV1Response", - '404': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/inscriptionnotauthenticated/{pkiInscriptionnotauthenticatedID}/getCommunicationList', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/1/object/inscriptionnotauthenticated/{pkiInscriptionnotauthenticatedID}/getCommunicationList', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/eZmaxApi/api/object_inscriptiontemp_api.py b/eZmaxApi/api/object_inscriptiontemp_api.py index 714780979..13d9f2797 100644 --- a/eZmaxApi/api/object_inscriptiontemp_api.py +++ b/eZmaxApi/api/object_inscriptiontemp_api.py @@ -13,22 +13,24 @@ """ # noqa: E501 -import re # noqa: F401 import io import warnings -from pydantic import validate_arguments, ValidationError +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Dict, List, Optional, Tuple, Union, Any -from pydantic import conint +try: + from typing import Annotated +except ImportError: + from typing_extensions import Annotated +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.inscriptiontemp_get_communication_list_v1_response import InscriptiontempGetCommunicationListV1Response from eZmaxApi.api_client import ApiClient from eZmaxApi.api_response import ApiResponse -from eZmaxApi.exceptions import ( # noqa: F401 - ApiTypeError, - ApiValueError -) +from eZmaxApi.rest import RESTResponseType class ObjectInscriptiontempApi: @@ -43,143 +45,263 @@ def __init__(self, api_client=None) -> None: api_client = ApiClient.get_default() self.api_client = api_client - @validate_arguments - def inscriptiontemp_get_communication_list_v1(self, pki_inscriptiontemp_id : conint(strict=True, le=16777215, ge=1), **kwargs) -> InscriptiontempGetCommunicationListV1Response: # noqa: E501 - """Retrieve Communication list # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def inscriptiontemp_get_communication_list_v1( + self, + pki_inscriptiontemp_id: Annotated[int, Field(le=16777215, strict=True, ge=1)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> InscriptiontempGetCommunicationListV1Response: + """Retrieve Communication list - >>> thread = api.inscriptiontemp_get_communication_list_v1(pki_inscriptiontemp_id, async_req=True) - >>> result = thread.get() + :param pki_inscriptiontemp_id: (required) :type pki_inscriptiontemp_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: InscriptiontempGetCommunicationListV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the inscriptiontemp_get_communication_list_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.inscriptiontemp_get_communication_list_v1_with_http_info(pki_inscriptiontemp_id, **kwargs) # noqa: E501 - - @validate_arguments - def inscriptiontemp_get_communication_list_v1_with_http_info(self, pki_inscriptiontemp_id : conint(strict=True, le=16777215, ge=1), **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve Communication list # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.inscriptiontemp_get_communication_list_v1_with_http_info(pki_inscriptiontemp_id, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._inscriptiontemp_get_communication_list_v1_serialize( + pki_inscriptiontemp_id=pki_inscriptiontemp_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "InscriptiontempGetCommunicationListV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def inscriptiontemp_get_communication_list_v1_with_http_info( + self, + pki_inscriptiontemp_id: Annotated[int, Field(le=16777215, strict=True, ge=1)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[InscriptiontempGetCommunicationListV1Response]: + """Retrieve Communication list + + :param pki_inscriptiontemp_id: (required) :type pki_inscriptiontemp_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(InscriptiontempGetCommunicationListV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._inscriptiontemp_get_communication_list_v1_serialize( + pki_inscriptiontemp_id=pki_inscriptiontemp_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '200': "InscriptiontempGetCommunicationListV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'pki_inscriptiontemp_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def inscriptiontemp_get_communication_list_v1_without_preload_content( + self, + pki_inscriptiontemp_id: Annotated[int, Field(le=16777215, strict=True, ge=1)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve Communication list + + + + :param pki_inscriptiontemp_id: (required) + :type pki_inscriptiontemp_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._inscriptiontemp_get_communication_list_v1_serialize( + pki_inscriptiontemp_id=pki_inscriptiontemp_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method inscriptiontemp_get_communication_list_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "InscriptiontempGetCommunicationListV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_inscriptiontemp_id']: - _path_params['pkiInscriptiontempID'] = _params['pki_inscriptiontemp_id'] + def _inscriptiontemp_get_communication_list_v1_serialize( + self, + pki_inscriptiontemp_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_inscriptiontemp_id is not None: + _path_params['pkiInscriptiontempID'] = pki_inscriptiontemp_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "InscriptiontempGetCommunicationListV1Response", - '404': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/inscriptiontemp/{pkiInscriptiontempID}/getCommunicationList', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/1/object/inscriptiontemp/{pkiInscriptiontempID}/getCommunicationList', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/eZmaxApi/api/object_invoice_api.py b/eZmaxApi/api/object_invoice_api.py index 5284e769f..477397223 100644 --- a/eZmaxApi/api/object_invoice_api.py +++ b/eZmaxApi/api/object_invoice_api.py @@ -13,22 +13,25 @@ """ # noqa: E501 -import re # noqa: F401 import io import warnings -from pydantic import validate_arguments, ValidationError +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Dict, List, Optional, Tuple, Union, Any -from pydantic import conint +try: + from typing import Annotated +except ImportError: + from typing_extensions import Annotated +from pydantic import Field +from typing_extensions import Annotated +from eZmaxApi.models.invoice_get_attachments_v1_response import InvoiceGetAttachmentsV1Response from eZmaxApi.models.invoice_get_communication_list_v1_response import InvoiceGetCommunicationListV1Response from eZmaxApi.api_client import ApiClient from eZmaxApi.api_response import ApiResponse -from eZmaxApi.exceptions import ( # noqa: F401 - ApiTypeError, - ApiValueError -) +from eZmaxApi.rest import RESTResponseType class ObjectInvoiceApi: @@ -43,143 +46,524 @@ def __init__(self, api_client=None) -> None: api_client = ApiClient.get_default() self.api_client = api_client - @validate_arguments - def invoice_get_communication_list_v1(self, pki_invoice_id : conint(strict=True, ge=0), **kwargs) -> InvoiceGetCommunicationListV1Response: # noqa: E501 - """Retrieve Communication list # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def invoice_get_attachments_v1( + self, + pki_invoice_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> InvoiceGetAttachmentsV1Response: + """Retrieve Invoice's Attachments - >>> thread = api.invoice_get_communication_list_v1(pki_invoice_id, async_req=True) - >>> result = thread.get() + :param pki_invoice_id: (required) :type pki_invoice_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: InvoiceGetCommunicationListV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the invoice_get_communication_list_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.invoice_get_communication_list_v1_with_http_info(pki_invoice_id, **kwargs) # noqa: E501 - - @validate_arguments - def invoice_get_communication_list_v1_with_http_info(self, pki_invoice_id : conint(strict=True, ge=0), **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve Communication list # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.invoice_get_communication_list_v1_with_http_info(pki_invoice_id, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._invoice_get_attachments_v1_serialize( + pki_invoice_id=pki_invoice_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "InvoiceGetAttachmentsV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def invoice_get_attachments_v1_with_http_info( + self, + pki_invoice_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[InvoiceGetAttachmentsV1Response]: + """Retrieve Invoice's Attachments + + :param pki_invoice_id: (required) :type pki_invoice_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(InvoiceGetCommunicationListV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._invoice_get_attachments_v1_serialize( + pki_invoice_id=pki_invoice_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "InvoiceGetAttachmentsV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _params = locals() - _all_params = [ - 'pki_invoice_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + @validate_call + def invoice_get_attachments_v1_without_preload_content( + self, + pki_invoice_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve Invoice's Attachments + + + + :param pki_invoice_id: (required) + :type pki_invoice_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._invoice_get_attachments_v1_serialize( + pki_invoice_id=pki_invoice_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "InvoiceGetAttachmentsV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) + return response_data.response - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method invoice_get_communication_list_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] - _collection_formats = {} + def _invoice_get_attachments_v1_serialize( + self, + pki_invoice_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: - # process the path parameters - _path_params = {} - if _params['pki_invoice_id']: - _path_params['pkiInvoiceID'] = _params['pki_invoice_id'] + _host = None + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_invoice_id is not None: + _path_params['pkiInvoiceID'] = pki_invoice_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) + # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 + _auth_settings: List[str] = [ + 'Authorization' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/1/object/invoice/{pkiInvoiceID}/getAttachments', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def invoice_get_communication_list_v1( + self, + pki_invoice_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> InvoiceGetCommunicationListV1Response: + """Retrieve Communication list + + - _response_types_map = { + :param pki_invoice_id: (required) + :type pki_invoice_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._invoice_get_communication_list_v1_serialize( + pki_invoice_id=pki_invoice_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "InvoiceGetCommunicationListV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def invoice_get_communication_list_v1_with_http_info( + self, + pki_invoice_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[InvoiceGetCommunicationListV1Response]: + """Retrieve Communication list + + + + :param pki_invoice_id: (required) + :type pki_invoice_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._invoice_get_communication_list_v1_serialize( + pki_invoice_id=pki_invoice_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { '200': "InvoiceGetCommunicationListV1Response", '404': "CommonResponseError", } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def invoice_get_communication_list_v1_without_preload_content( + self, + pki_invoice_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve Communication list - return self.api_client.call_api( - '/1/object/invoice/{pkiInvoiceID}/getCommunicationList', 'GET', - _path_params, - _query_params, - _header_params, + + + :param pki_invoice_id: (required) + :type pki_invoice_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._invoice_get_communication_list_v1_serialize( + pki_invoice_id=pki_invoice_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "InvoiceGetCommunicationListV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _invoice_get_communication_list_v1_serialize( + self, + pki_invoice_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_invoice_id is not None: + _path_params['pkiInvoiceID'] = pki_invoice_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/1/object/invoice/{pkiInvoiceID}/getCommunicationList', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/eZmaxApi/api/object_language_api.py b/eZmaxApi/api/object_language_api.py index a4da1a65f..8758839d6 100644 --- a/eZmaxApi/api/object_language_api.py +++ b/eZmaxApi/api/object_language_api.py @@ -13,14 +13,20 @@ """ # noqa: E501 -import re # noqa: F401 import io import warnings -from pydantic import validate_arguments, ValidationError +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Dict, List, Optional, Tuple, Union, Any +try: + from typing import Annotated +except ImportError: + from typing_extensions import Annotated + +from pydantic import Field from typing_extensions import Annotated -from pydantic import Field, StrictStr +from pydantic import StrictStr, field_validator from typing import Optional @@ -29,10 +35,7 @@ from eZmaxApi.api_client import ApiClient from eZmaxApi.api_response import ApiResponse -from eZmaxApi.exceptions import ( # noqa: F401 - ApiTypeError, - ApiValueError -) +from eZmaxApi.rest import RESTResponseType class ObjectLanguageApi: @@ -47,16 +50,30 @@ def __init__(self, api_client=None) -> None: api_client = ApiClient.get_default() self.api_client = api_client - @validate_arguments - def language_get_autocomplete_v2(self, s_selector : Annotated[StrictStr, Field(..., description="The type of Languages to return")], e_filter_active : Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, s_query : Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, accept_language : Optional[HeaderAcceptLanguage] = None, **kwargs) -> LanguageGetAutocompleteV2Response: # noqa: E501 - """Retrieve Languages and IDs # noqa: E501 - Get the list of Language to be used in a dropdown or autocomplete control. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def language_get_autocomplete_v2( + self, + s_selector: Annotated[StrictStr, Field(description="The type of Languages to return")], + e_filter_active: Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, + s_query: Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> LanguageGetAutocompleteV2Response: + """Retrieve Languages and IDs - >>> thread = api.language_get_autocomplete_v2(s_selector, e_filter_active, s_query, accept_language, async_req=True) - >>> result = thread.get() + Get the list of Language to be used in a dropdown or autocomplete control. :param s_selector: The type of Languages to return (required) :type s_selector: str @@ -66,33 +83,76 @@ def language_get_autocomplete_v2(self, s_selector : Annotated[StrictStr, Field(. :type s_query: str :param accept_language: :type accept_language: HeaderAcceptLanguage - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: LanguageGetAutocompleteV2Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the language_get_autocomplete_v2_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.language_get_autocomplete_v2_with_http_info(s_selector, e_filter_active, s_query, accept_language, **kwargs) # noqa: E501 - - @validate_arguments - def language_get_autocomplete_v2_with_http_info(self, s_selector : Annotated[StrictStr, Field(..., description="The type of Languages to return")], e_filter_active : Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, s_query : Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, accept_language : Optional[HeaderAcceptLanguage] = None, **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve Languages and IDs # noqa: E501 - - Get the list of Language to be used in a dropdown or autocomplete control. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.language_get_autocomplete_v2_with_http_info(s_selector, e_filter_active, s_query, accept_language, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._language_get_autocomplete_v2_serialize( + s_selector=s_selector, + e_filter_active=e_filter_active, + s_query=s_query, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "LanguageGetAutocompleteV2Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def language_get_autocomplete_v2_with_http_info( + self, + s_selector: Annotated[StrictStr, Field(description="The type of Languages to return")], + e_filter_active: Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, + s_query: Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[LanguageGetAutocompleteV2Response]: + """Retrieve Languages and IDs + + Get the list of Language to be used in a dropdown or autocomplete control. :param s_selector: The type of Languages to return (required) :type s_selector: str @@ -102,111 +162,197 @@ def language_get_autocomplete_v2_with_http_info(self, s_selector : Annotated[Str :type s_query: str :param accept_language: :type accept_language: HeaderAcceptLanguage - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(LanguageGetAutocompleteV2Response, status_code(int), headers(HTTPHeaderDict)) - """ - - _params = locals() - - _all_params = [ - 's_selector', - 'e_filter_active', - 's_query', - 'accept_language' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + """ # noqa: E501 + + _param = self._language_get_autocomplete_v2_serialize( + s_selector=s_selector, + e_filter_active=e_filter_active, + s_query=s_query, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "LanguageGetAutocompleteV2Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def language_get_autocomplete_v2_without_preload_content( + self, + s_selector: Annotated[StrictStr, Field(description="The type of Languages to return")], + e_filter_active: Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, + s_query: Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve Languages and IDs + + Get the list of Language to be used in a dropdown or autocomplete control. + + :param s_selector: The type of Languages to return (required) + :type s_selector: str + :param e_filter_active: Specify which results we want to display. + :type e_filter_active: str + :param s_query: Allow to filter the returned results + :type s_query: str + :param accept_language: + :type accept_language: HeaderAcceptLanguage + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._language_get_autocomplete_v2_serialize( + s_selector=s_selector, + e_filter_active=e_filter_active, + s_query=s_query, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method language_get_autocomplete_v2" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "LanguageGetAutocompleteV2Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['s_selector']: - _path_params['sSelector'] = _params['s_selector'] + def _language_get_autocomplete_v2_serialize( + self, + s_selector, + e_filter_active, + s_query, + accept_language, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None - # process the query parameters - _query_params = [] - if _params.get('e_filter_active') is not None: # noqa: E501 - _query_params.append(('eFilterActive', _params['e_filter_active'])) + _collection_formats: Dict[str, str] = { + } - if _params.get('s_query') is not None: # noqa: E501 - _query_params.append(('sQuery', _params['s_query'])) + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if s_selector is not None: + _path_params['sSelector'] = s_selector + # process the query parameters + if e_filter_active is not None: + + _query_params.append(('eFilterActive', e_filter_active)) + + if s_query is not None: + + _query_params.append(('sQuery', s_query)) + # process the header parameters - _header_params = dict(_params.get('_headers', {})) - if _params['accept_language']: - _header_params['Accept-Language'] = _params['accept_language'] - + if accept_language is not None: + _header_params['Accept-Language'] = accept_language # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "LanguageGetAutocompleteV2Response", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/2/object/language/getAutocomplete/{sSelector}', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/2/object/language/getAutocomplete/{sSelector}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/eZmaxApi/api/object_modulegroup_api.py b/eZmaxApi/api/object_modulegroup_api.py index 63af67073..ce4247940 100644 --- a/eZmaxApi/api/object_modulegroup_api.py +++ b/eZmaxApi/api/object_modulegroup_api.py @@ -13,23 +13,26 @@ """ # noqa: E501 -import re # noqa: F401 import io import warnings -from pydantic import validate_arguments, ValidationError +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Dict, List, Optional, Tuple, Union, Any +try: + from typing import Annotated +except ImportError: + from typing_extensions import Annotated + +from pydantic import Field from typing_extensions import Annotated -from pydantic import Field, StrictStr +from pydantic import StrictStr, field_validator from eZmaxApi.models.modulegroup_get_all_v1_response import ModulegroupGetAllV1Response from eZmaxApi.api_client import ApiClient from eZmaxApi.api_response import ApiResponse -from eZmaxApi.exceptions import ( # noqa: F401 - ApiTypeError, - ApiValueError -) +from eZmaxApi.rest import RESTResponseType class ObjectModulegroupApi: @@ -44,140 +47,257 @@ def __init__(self, api_client=None) -> None: api_client = ApiClient.get_default() self.api_client = api_client - @validate_arguments - def modulegroup_get_all_v1(self, e_context : Annotated[StrictStr, Field(..., description="The context of the Modulegroup")], **kwargs) -> ModulegroupGetAllV1Response: # noqa: E501 - """Retrieve all Modulegroups # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def modulegroup_get_all_v1( + self, + e_context: Annotated[StrictStr, Field(description="The context of the Modulegroup")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ModulegroupGetAllV1Response: + """Retrieve all Modulegroups - >>> thread = api.modulegroup_get_all_v1(e_context, async_req=True) - >>> result = thread.get() :param e_context: The context of the Modulegroup (required) :type e_context: str - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: ModulegroupGetAllV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the modulegroup_get_all_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.modulegroup_get_all_v1_with_http_info(e_context, **kwargs) # noqa: E501 - - @validate_arguments - def modulegroup_get_all_v1_with_http_info(self, e_context : Annotated[StrictStr, Field(..., description="The context of the Modulegroup")], **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve all Modulegroups # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.modulegroup_get_all_v1_with_http_info(e_context, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._modulegroup_get_all_v1_serialize( + e_context=e_context, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ModulegroupGetAllV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def modulegroup_get_all_v1_with_http_info( + self, + e_context: Annotated[StrictStr, Field(description="The context of the Modulegroup")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ModulegroupGetAllV1Response]: + """Retrieve all Modulegroups + :param e_context: The context of the Modulegroup (required) :type e_context: str - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(ModulegroupGetAllV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._modulegroup_get_all_v1_serialize( + e_context=e_context, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ModulegroupGetAllV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _params = locals() - _all_params = [ - 'e_context' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + @validate_call + def modulegroup_get_all_v1_without_preload_content( + self, + e_context: Annotated[StrictStr, Field(description="The context of the Modulegroup")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve all Modulegroups + + + :param e_context: The context of the Modulegroup (required) + :type e_context: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._modulegroup_get_all_v1_serialize( + e_context=e_context, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method modulegroup_get_all_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "ModulegroupGetAllV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['e_context']: - _path_params['eContext'] = _params['e_context'] + def _modulegroup_get_all_v1_serialize( + self, + e_context, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if e_context is not None: + _path_params['eContext'] = e_context # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "ModulegroupGetAllV1Response", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/modulegroup/getAll/{eContext}', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/1/object/modulegroup/getAll/{eContext}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/eZmaxApi/api/object_notificationsection_api.py b/eZmaxApi/api/object_notificationsection_api.py index f66448dd7..eab43d858 100644 --- a/eZmaxApi/api/object_notificationsection_api.py +++ b/eZmaxApi/api/object_notificationsection_api.py @@ -13,23 +13,26 @@ """ # noqa: E501 -import re # noqa: F401 import io import warnings -from pydantic import validate_arguments, ValidationError +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Dict, List, Optional, Tuple, Union, Any +try: + from typing import Annotated +except ImportError: + from typing_extensions import Annotated + +from pydantic import Field from typing_extensions import Annotated -from pydantic import Field, StrictBool, conint +from pydantic import StrictBool from eZmaxApi.models.notificationsection_get_notificationtests_v1_response import NotificationsectionGetNotificationtestsV1Response from eZmaxApi.api_client import ApiClient from eZmaxApi.api_response import ApiResponse -from eZmaxApi.exceptions import ( # noqa: F401 - ApiTypeError, - ApiValueError -) +from eZmaxApi.rest import RESTResponseType class ObjectNotificationsectionApi: @@ -44,151 +47,280 @@ def __init__(self, api_client=None) -> None: api_client = ApiClient.get_default() self.api_client = api_client - @validate_arguments - def notificationsection_get_notificationtests_v1(self, pki_notificationsection_id : conint(strict=True, ge=0), b_show_hidden : Annotated[StrictBool, Field(..., description="Whether or not to return the hidden Notificationtests")], **kwargs) -> NotificationsectionGetNotificationtestsV1Response: # noqa: E501 - """Retrieve an existing Notificationsection's Notificationtests # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def notificationsection_get_notificationtests_v1( + self, + pki_notificationsection_id: Annotated[int, Field(strict=True, ge=0)], + b_show_hidden: Annotated[StrictBool, Field(description="Whether or not to return the hidden Notificationtests")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> NotificationsectionGetNotificationtestsV1Response: + """Retrieve an existing Notificationsection's Notificationtests - >>> thread = api.notificationsection_get_notificationtests_v1(pki_notificationsection_id, b_show_hidden, async_req=True) - >>> result = thread.get() + :param pki_notificationsection_id: (required) :type pki_notificationsection_id: int :param b_show_hidden: Whether or not to return the hidden Notificationtests (required) :type b_show_hidden: bool - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: NotificationsectionGetNotificationtestsV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the notificationsection_get_notificationtests_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.notificationsection_get_notificationtests_v1_with_http_info(pki_notificationsection_id, b_show_hidden, **kwargs) # noqa: E501 - - @validate_arguments - def notificationsection_get_notificationtests_v1_with_http_info(self, pki_notificationsection_id : conint(strict=True, ge=0), b_show_hidden : Annotated[StrictBool, Field(..., description="Whether or not to return the hidden Notificationtests")], **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve an existing Notificationsection's Notificationtests # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.notificationsection_get_notificationtests_v1_with_http_info(pki_notificationsection_id, b_show_hidden, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._notificationsection_get_notificationtests_v1_serialize( + pki_notificationsection_id=pki_notificationsection_id, + b_show_hidden=b_show_hidden, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "NotificationsectionGetNotificationtestsV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def notificationsection_get_notificationtests_v1_with_http_info( + self, + pki_notificationsection_id: Annotated[int, Field(strict=True, ge=0)], + b_show_hidden: Annotated[StrictBool, Field(description="Whether or not to return the hidden Notificationtests")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[NotificationsectionGetNotificationtestsV1Response]: + """Retrieve an existing Notificationsection's Notificationtests + + :param pki_notificationsection_id: (required) :type pki_notificationsection_id: int :param b_show_hidden: Whether or not to return the hidden Notificationtests (required) :type b_show_hidden: bool - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(NotificationsectionGetNotificationtestsV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._notificationsection_get_notificationtests_v1_serialize( + pki_notificationsection_id=pki_notificationsection_id, + b_show_hidden=b_show_hidden, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '200': "NotificationsectionGetNotificationtestsV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'pki_notificationsection_id', - 'b_show_hidden' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def notificationsection_get_notificationtests_v1_without_preload_content( + self, + pki_notificationsection_id: Annotated[int, Field(strict=True, ge=0)], + b_show_hidden: Annotated[StrictBool, Field(description="Whether or not to return the hidden Notificationtests")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve an existing Notificationsection's Notificationtests + + + + :param pki_notificationsection_id: (required) + :type pki_notificationsection_id: int + :param b_show_hidden: Whether or not to return the hidden Notificationtests (required) + :type b_show_hidden: bool + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._notificationsection_get_notificationtests_v1_serialize( + pki_notificationsection_id=pki_notificationsection_id, + b_show_hidden=b_show_hidden, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "NotificationsectionGetNotificationtestsV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout ) + return response_data.response - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method notificationsection_get_notificationtests_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] - _collection_formats = {} + def _notificationsection_get_notificationtests_v1_serialize( + self, + pki_notificationsection_id, + b_show_hidden, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: - # process the path parameters - _path_params = {} - if _params['pki_notificationsection_id']: - _path_params['pkiNotificationsectionID'] = _params['pki_notificationsection_id'] + _host = None + _collection_formats: Dict[str, str] = { + } - # process the query parameters - _query_params = [] - if _params.get('b_show_hidden') is not None: # noqa: E501 - _query_params.append(('bShowHidden', _params['b_show_hidden'])) + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if pki_notificationsection_id is not None: + _path_params['pkiNotificationsectionID'] = pki_notificationsection_id + # process the query parameters + if b_show_hidden is not None: + + _query_params.append(('bShowHidden', b_show_hidden)) + # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "NotificationsectionGetNotificationtestsV1Response", - '404': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/notificationsection/{pkiNotificationsectionID}/getNotificationtests', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/1/object/notificationsection/{pkiNotificationsectionID}/getNotificationtests', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/eZmaxApi/api/object_notificationtest_api.py b/eZmaxApi/api/object_notificationtest_api.py index 80484adb5..b52bd3d36 100644 --- a/eZmaxApi/api/object_notificationtest_api.py +++ b/eZmaxApi/api/object_notificationtest_api.py @@ -13,22 +13,24 @@ """ # noqa: E501 -import re # noqa: F401 import io import warnings -from pydantic import validate_arguments, ValidationError +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Dict, List, Optional, Tuple, Union, Any -from pydantic import conint +try: + from typing import Annotated +except ImportError: + from typing_extensions import Annotated +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.notificationtest_get_elements_v1_response import NotificationtestGetElementsV1Response from eZmaxApi.api_client import ApiClient from eZmaxApi.api_response import ApiResponse -from eZmaxApi.exceptions import ( # noqa: F401 - ApiTypeError, - ApiValueError -) +from eZmaxApi.rest import RESTResponseType class ObjectNotificationtestApi: @@ -43,143 +45,263 @@ def __init__(self, api_client=None) -> None: api_client = ApiClient.get_default() self.api_client = api_client - @validate_arguments - def notificationtest_get_elements_v1(self, pki_notificationtest_id : conint(strict=True, ge=0), **kwargs) -> NotificationtestGetElementsV1Response: # noqa: E501 - """Retrieve an existing Notificationtest's Elements # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def notificationtest_get_elements_v1( + self, + pki_notificationtest_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> NotificationtestGetElementsV1Response: + """Retrieve an existing Notificationtest's Elements - >>> thread = api.notificationtest_get_elements_v1(pki_notificationtest_id, async_req=True) - >>> result = thread.get() + :param pki_notificationtest_id: (required) :type pki_notificationtest_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: NotificationtestGetElementsV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the notificationtest_get_elements_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.notificationtest_get_elements_v1_with_http_info(pki_notificationtest_id, **kwargs) # noqa: E501 - - @validate_arguments - def notificationtest_get_elements_v1_with_http_info(self, pki_notificationtest_id : conint(strict=True, ge=0), **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve an existing Notificationtest's Elements # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.notificationtest_get_elements_v1_with_http_info(pki_notificationtest_id, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._notificationtest_get_elements_v1_serialize( + pki_notificationtest_id=pki_notificationtest_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "NotificationtestGetElementsV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def notificationtest_get_elements_v1_with_http_info( + self, + pki_notificationtest_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[NotificationtestGetElementsV1Response]: + """Retrieve an existing Notificationtest's Elements + + :param pki_notificationtest_id: (required) :type pki_notificationtest_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(NotificationtestGetElementsV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._notificationtest_get_elements_v1_serialize( + pki_notificationtest_id=pki_notificationtest_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '200': "NotificationtestGetElementsV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'pki_notificationtest_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def notificationtest_get_elements_v1_without_preload_content( + self, + pki_notificationtest_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve an existing Notificationtest's Elements + + + + :param pki_notificationtest_id: (required) + :type pki_notificationtest_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._notificationtest_get_elements_v1_serialize( + pki_notificationtest_id=pki_notificationtest_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method notificationtest_get_elements_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "NotificationtestGetElementsV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_notificationtest_id']: - _path_params['pkiNotificationtestID'] = _params['pki_notificationtest_id'] + def _notificationtest_get_elements_v1_serialize( + self, + pki_notificationtest_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_notificationtest_id is not None: + _path_params['pkiNotificationtestID'] = pki_notificationtest_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "NotificationtestGetElementsV1Response", - '404': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/notificationtest/{pkiNotificationtestID}/getElements', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/1/object/notificationtest/{pkiNotificationtestID}/getElements', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/eZmaxApi/api/object_otherincome_api.py b/eZmaxApi/api/object_otherincome_api.py index 84b7a8386..469cbcce7 100644 --- a/eZmaxApi/api/object_otherincome_api.py +++ b/eZmaxApi/api/object_otherincome_api.py @@ -13,22 +13,24 @@ """ # noqa: E501 -import re # noqa: F401 import io import warnings -from pydantic import validate_arguments, ValidationError +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Dict, List, Optional, Tuple, Union, Any -from pydantic import conint +try: + from typing import Annotated +except ImportError: + from typing_extensions import Annotated +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.otherincome_get_communication_list_v1_response import OtherincomeGetCommunicationListV1Response from eZmaxApi.api_client import ApiClient from eZmaxApi.api_response import ApiResponse -from eZmaxApi.exceptions import ( # noqa: F401 - ApiTypeError, - ApiValueError -) +from eZmaxApi.rest import RESTResponseType class ObjectOtherincomeApi: @@ -43,143 +45,263 @@ def __init__(self, api_client=None) -> None: api_client = ApiClient.get_default() self.api_client = api_client - @validate_arguments - def otherincome_get_communication_list_v1(self, pki_otherincome_id : conint(strict=True, le=65535, ge=1), **kwargs) -> OtherincomeGetCommunicationListV1Response: # noqa: E501 - """Retrieve Communication list # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def otherincome_get_communication_list_v1( + self, + pki_otherincome_id: Annotated[int, Field(le=65535, strict=True, ge=1)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> OtherincomeGetCommunicationListV1Response: + """Retrieve Communication list - >>> thread = api.otherincome_get_communication_list_v1(pki_otherincome_id, async_req=True) - >>> result = thread.get() + :param pki_otherincome_id: (required) :type pki_otherincome_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: OtherincomeGetCommunicationListV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the otherincome_get_communication_list_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.otherincome_get_communication_list_v1_with_http_info(pki_otherincome_id, **kwargs) # noqa: E501 - - @validate_arguments - def otherincome_get_communication_list_v1_with_http_info(self, pki_otherincome_id : conint(strict=True, le=65535, ge=1), **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve Communication list # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.otherincome_get_communication_list_v1_with_http_info(pki_otherincome_id, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._otherincome_get_communication_list_v1_serialize( + pki_otherincome_id=pki_otherincome_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "OtherincomeGetCommunicationListV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def otherincome_get_communication_list_v1_with_http_info( + self, + pki_otherincome_id: Annotated[int, Field(le=65535, strict=True, ge=1)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[OtherincomeGetCommunicationListV1Response]: + """Retrieve Communication list + + :param pki_otherincome_id: (required) :type pki_otherincome_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(OtherincomeGetCommunicationListV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._otherincome_get_communication_list_v1_serialize( + pki_otherincome_id=pki_otherincome_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '200': "OtherincomeGetCommunicationListV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'pki_otherincome_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def otherincome_get_communication_list_v1_without_preload_content( + self, + pki_otherincome_id: Annotated[int, Field(le=65535, strict=True, ge=1)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve Communication list + + + + :param pki_otherincome_id: (required) + :type pki_otherincome_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._otherincome_get_communication_list_v1_serialize( + pki_otherincome_id=pki_otherincome_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method otherincome_get_communication_list_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "OtherincomeGetCommunicationListV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_otherincome_id']: - _path_params['pkiOtherincomeID'] = _params['pki_otherincome_id'] + def _otherincome_get_communication_list_v1_serialize( + self, + pki_otherincome_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_otherincome_id is not None: + _path_params['pkiOtherincomeID'] = pki_otherincome_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "OtherincomeGetCommunicationListV1Response", - '404': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/otherincome/{pkiOtherincomeID}/getCommunicationList', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/1/object/otherincome/{pkiOtherincomeID}/getCommunicationList', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/eZmaxApi/api/object_paymentterm_api.py b/eZmaxApi/api/object_paymentterm_api.py index 806f311ee..dadc67904 100644 --- a/eZmaxApi/api/object_paymentterm_api.py +++ b/eZmaxApi/api/object_paymentterm_api.py @@ -13,14 +13,20 @@ """ # noqa: E501 -import re # noqa: F401 import io import warnings -from pydantic import validate_arguments, ValidationError +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Dict, List, Optional, Tuple, Union, Any +try: + from typing import Annotated +except ImportError: + from typing_extensions import Annotated + +from pydantic import Field from typing_extensions import Annotated -from pydantic import Field, StrictInt, StrictStr, conint +from pydantic import StrictInt, StrictStr, field_validator from typing import Optional @@ -35,10 +41,7 @@ from eZmaxApi.api_client import ApiClient from eZmaxApi.api_response import ApiResponse -from eZmaxApi.exceptions import ( # noqa: F401 - ApiTypeError, - ApiValueError -) +from eZmaxApi.rest import RESTResponseType class ObjectPaymenttermApi: @@ -53,321 +56,596 @@ def __init__(self, api_client=None) -> None: api_client = ApiClient.get_default() self.api_client = api_client - @validate_arguments - def paymentterm_create_object_v1(self, paymentterm_create_object_v1_request : PaymenttermCreateObjectV1Request, **kwargs) -> PaymenttermCreateObjectV1Response: # noqa: E501 - """Create a new Paymentterm # noqa: E501 - The endpoint allows to create one or many elements at once. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def paymentterm_create_object_v1( + self, + paymentterm_create_object_v1_request: PaymenttermCreateObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> PaymenttermCreateObjectV1Response: + """Create a new Paymentterm - >>> thread = api.paymentterm_create_object_v1(paymentterm_create_object_v1_request, async_req=True) - >>> result = thread.get() + The endpoint allows to create one or many elements at once. :param paymentterm_create_object_v1_request: (required) :type paymentterm_create_object_v1_request: PaymenttermCreateObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: PaymenttermCreateObjectV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the paymentterm_create_object_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.paymentterm_create_object_v1_with_http_info(paymentterm_create_object_v1_request, **kwargs) # noqa: E501 - - @validate_arguments - def paymentterm_create_object_v1_with_http_info(self, paymentterm_create_object_v1_request : PaymenttermCreateObjectV1Request, **kwargs) -> ApiResponse: # noqa: E501 - """Create a new Paymentterm # noqa: E501 - - The endpoint allows to create one or many elements at once. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.paymentterm_create_object_v1_with_http_info(paymentterm_create_object_v1_request, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._paymentterm_create_object_v1_serialize( + paymentterm_create_object_v1_request=paymentterm_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "PaymenttermCreateObjectV1Response", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def paymentterm_create_object_v1_with_http_info( + self, + paymentterm_create_object_v1_request: PaymenttermCreateObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[PaymenttermCreateObjectV1Response]: + """Create a new Paymentterm + + The endpoint allows to create one or many elements at once. :param paymentterm_create_object_v1_request: (required) :type paymentterm_create_object_v1_request: PaymenttermCreateObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(PaymenttermCreateObjectV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._paymentterm_create_object_v1_serialize( + paymentterm_create_object_v1_request=paymentterm_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "PaymenttermCreateObjectV1Response", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _params = locals() - _all_params = [ - 'paymentterm_create_object_v1_request' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + @validate_call + def paymentterm_create_object_v1_without_preload_content( + self, + paymentterm_create_object_v1_request: PaymenttermCreateObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Create a new Paymentterm + + The endpoint allows to create one or many elements at once. + + :param paymentterm_create_object_v1_request: (required) + :type paymentterm_create_object_v1_request: PaymenttermCreateObjectV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._paymentterm_create_object_v1_serialize( + paymentterm_create_object_v1_request=paymentterm_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method paymentterm_create_object_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '201': "PaymenttermCreateObjectV1Response", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} + def _paymentterm_create_object_v1_serialize( + self, + paymentterm_create_object_v1_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['paymentterm_create_object_v1_request'] is not None: - _body_params = _params['paymentterm_create_object_v1_request'] + if paymentterm_create_object_v1_request is not None: + _body_params = paymentterm_create_object_v1_request + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '201': "PaymenttermCreateObjectV1Response", - '422': "CommonResponseError", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/paymentterm', 'POST', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='POST', + resource_path='/1/object/paymentterm', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + - @validate_arguments - def paymentterm_edit_object_v1(self, pki_paymentterm_id : StrictInt, paymentterm_edit_object_v1_request : PaymenttermEditObjectV1Request, **kwargs) -> PaymenttermEditObjectV1Response: # noqa: E501 - """Edit an existing Paymentterm # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def paymentterm_edit_object_v1( + self, + pki_paymentterm_id: StrictInt, + paymentterm_edit_object_v1_request: PaymenttermEditObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> PaymenttermEditObjectV1Response: + """Edit an existing Paymentterm - >>> thread = api.paymentterm_edit_object_v1(pki_paymentterm_id, paymentterm_edit_object_v1_request, async_req=True) - >>> result = thread.get() + :param pki_paymentterm_id: (required) :type pki_paymentterm_id: int :param paymentterm_edit_object_v1_request: (required) :type paymentterm_edit_object_v1_request: PaymenttermEditObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: PaymenttermEditObjectV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the paymentterm_edit_object_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.paymentterm_edit_object_v1_with_http_info(pki_paymentterm_id, paymentterm_edit_object_v1_request, **kwargs) # noqa: E501 - - @validate_arguments - def paymentterm_edit_object_v1_with_http_info(self, pki_paymentterm_id : StrictInt, paymentterm_edit_object_v1_request : PaymenttermEditObjectV1Request, **kwargs) -> ApiResponse: # noqa: E501 - """Edit an existing Paymentterm # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.paymentterm_edit_object_v1_with_http_info(pki_paymentterm_id, paymentterm_edit_object_v1_request, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._paymentterm_edit_object_v1_serialize( + pki_paymentterm_id=pki_paymentterm_id, + paymentterm_edit_object_v1_request=paymentterm_edit_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "PaymenttermEditObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def paymentterm_edit_object_v1_with_http_info( + self, + pki_paymentterm_id: StrictInt, + paymentterm_edit_object_v1_request: PaymenttermEditObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[PaymenttermEditObjectV1Response]: + """Edit an existing Paymentterm + + :param pki_paymentterm_id: (required) :type pki_paymentterm_id: int :param paymentterm_edit_object_v1_request: (required) :type paymentterm_edit_object_v1_request: PaymenttermEditObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(PaymenttermEditObjectV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._paymentterm_edit_object_v1_serialize( + pki_paymentterm_id=pki_paymentterm_id, + paymentterm_edit_object_v1_request=paymentterm_edit_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '200': "PaymenttermEditObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'pki_paymentterm_id', - 'paymentterm_edit_object_v1_request' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def paymentterm_edit_object_v1_without_preload_content( + self, + pki_paymentterm_id: StrictInt, + paymentterm_edit_object_v1_request: PaymenttermEditObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Edit an existing Paymentterm + + + + :param pki_paymentterm_id: (required) + :type pki_paymentterm_id: int + :param paymentterm_edit_object_v1_request: (required) + :type paymentterm_edit_object_v1_request: PaymenttermEditObjectV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._paymentterm_edit_object_v1_serialize( + pki_paymentterm_id=pki_paymentterm_id, + paymentterm_edit_object_v1_request=paymentterm_edit_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method paymentterm_edit_object_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "PaymenttermEditObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_paymentterm_id']: - _path_params['pkiPaymenttermID'] = _params['pki_paymentterm_id'] + def _paymentterm_edit_object_v1_serialize( + self, + pki_paymentterm_id, + paymentterm_edit_object_v1_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_paymentterm_id is not None: + _path_params['pkiPaymenttermID'] = pki_paymentterm_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['paymentterm_edit_object_v1_request'] is not None: - _body_params = _params['paymentterm_edit_object_v1_request'] + if paymentterm_edit_object_v1_request is not None: + _body_params = paymentterm_edit_object_v1_request + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '200': "PaymenttermEditObjectV1Response", - '404': "CommonResponseError", - '422': "CommonResponseError", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/paymentterm/{pkiPaymenttermID}', 'PUT', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='PUT', + resource_path='/1/object/paymentterm/{pkiPaymenttermID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + - @validate_arguments - def paymentterm_get_autocomplete_v2(self, s_selector : Annotated[StrictStr, Field(..., description="The type of Paymentterms to return")], e_filter_active : Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, s_query : Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, accept_language : Optional[HeaderAcceptLanguage] = None, **kwargs) -> PaymenttermGetAutocompleteV2Response: # noqa: E501 - """Retrieve Paymentterms and IDs # noqa: E501 - Get the list of Paymentterm to be used in a dropdown or autocomplete control. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.paymentterm_get_autocomplete_v2(s_selector, e_filter_active, s_query, accept_language, async_req=True) - >>> result = thread.get() + @validate_call + def paymentterm_get_autocomplete_v2( + self, + s_selector: Annotated[StrictStr, Field(description="The type of Paymentterms to return")], + e_filter_active: Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, + s_query: Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> PaymenttermGetAutocompleteV2Response: + """Retrieve Paymentterms and IDs + + Get the list of Paymentterm to be used in a dropdown or autocomplete control. :param s_selector: The type of Paymentterms to return (required) :type s_selector: str @@ -377,33 +655,76 @@ def paymentterm_get_autocomplete_v2(self, s_selector : Annotated[StrictStr, Fiel :type s_query: str :param accept_language: :type accept_language: HeaderAcceptLanguage - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: PaymenttermGetAutocompleteV2Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the paymentterm_get_autocomplete_v2_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.paymentterm_get_autocomplete_v2_with_http_info(s_selector, e_filter_active, s_query, accept_language, **kwargs) # noqa: E501 - - @validate_arguments - def paymentterm_get_autocomplete_v2_with_http_info(self, s_selector : Annotated[StrictStr, Field(..., description="The type of Paymentterms to return")], e_filter_active : Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, s_query : Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, accept_language : Optional[HeaderAcceptLanguage] = None, **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve Paymentterms and IDs # noqa: E501 - - Get the list of Paymentterm to be used in a dropdown or autocomplete control. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.paymentterm_get_autocomplete_v2_with_http_info(s_selector, e_filter_active, s_query, accept_language, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._paymentterm_get_autocomplete_v2_serialize( + s_selector=s_selector, + e_filter_active=e_filter_active, + s_query=s_query, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "PaymenttermGetAutocompleteV2Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def paymentterm_get_autocomplete_v2_with_http_info( + self, + s_selector: Annotated[StrictStr, Field(description="The type of Paymentterms to return")], + e_filter_active: Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, + s_query: Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[PaymenttermGetAutocompleteV2Response]: + """Retrieve Paymentterms and IDs + + Get the list of Paymentterm to be used in a dropdown or autocomplete control. :param s_selector: The type of Paymentterms to return (required) :type s_selector: str @@ -413,124 +734,225 @@ def paymentterm_get_autocomplete_v2_with_http_info(self, s_selector : Annotated[ :type s_query: str :param accept_language: :type accept_language: HeaderAcceptLanguage - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(PaymenttermGetAutocompleteV2Response, status_code(int), headers(HTTPHeaderDict)) - """ - - _params = locals() - - _all_params = [ - 's_selector', - 'e_filter_active', - 's_query', - 'accept_language' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + """ # noqa: E501 + + _param = self._paymentterm_get_autocomplete_v2_serialize( + s_selector=s_selector, + e_filter_active=e_filter_active, + s_query=s_query, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "PaymenttermGetAutocompleteV2Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def paymentterm_get_autocomplete_v2_without_preload_content( + self, + s_selector: Annotated[StrictStr, Field(description="The type of Paymentterms to return")], + e_filter_active: Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, + s_query: Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve Paymentterms and IDs + + Get the list of Paymentterm to be used in a dropdown or autocomplete control. + + :param s_selector: The type of Paymentterms to return (required) + :type s_selector: str + :param e_filter_active: Specify which results we want to display. + :type e_filter_active: str + :param s_query: Allow to filter the returned results + :type s_query: str + :param accept_language: + :type accept_language: HeaderAcceptLanguage + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._paymentterm_get_autocomplete_v2_serialize( + s_selector=s_selector, + e_filter_active=e_filter_active, + s_query=s_query, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method paymentterm_get_autocomplete_v2" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "PaymenttermGetAutocompleteV2Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['s_selector']: - _path_params['sSelector'] = _params['s_selector'] + def _paymentterm_get_autocomplete_v2_serialize( + self, + s_selector, + e_filter_active, + s_query, + accept_language, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None - # process the query parameters - _query_params = [] - if _params.get('e_filter_active') is not None: # noqa: E501 - _query_params.append(('eFilterActive', _params['e_filter_active'])) + _collection_formats: Dict[str, str] = { + } - if _params.get('s_query') is not None: # noqa: E501 - _query_params.append(('sQuery', _params['s_query'])) + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if s_selector is not None: + _path_params['sSelector'] = s_selector + # process the query parameters + if e_filter_active is not None: + + _query_params.append(('eFilterActive', e_filter_active)) + + if s_query is not None: + + _query_params.append(('sQuery', s_query)) + # process the header parameters - _header_params = dict(_params.get('_headers', {})) - if _params['accept_language']: - _header_params['Accept-Language'] = _params['accept_language'] - + if accept_language is not None: + _header_params['Accept-Language'] = accept_language # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "PaymenttermGetAutocompleteV2Response", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/2/object/paymentterm/getAutocomplete/{sSelector}', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/2/object/paymentterm/getAutocomplete/{sSelector}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + - @validate_arguments - def paymentterm_get_list_v1(self, e_order_by : Annotated[Optional[StrictStr], Field(description="Specify how you want the results to be sorted")] = None, i_row_max : Optional[conint(strict=True, le=10000, ge=1)] = None, i_row_offset : Optional[conint(strict=True, ge=0)] = None, accept_language : Optional[HeaderAcceptLanguage] = None, s_filter : Optional[StrictStr] = None, **kwargs) -> PaymenttermGetListV1Response: # noqa: E501 - """Retrieve Paymentterm list # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.paymentterm_get_list_v1(e_order_by, i_row_max, i_row_offset, accept_language, s_filter, async_req=True) - >>> result = thread.get() + @validate_call + def paymentterm_get_list_v1( + self, + e_order_by: Annotated[Optional[StrictStr], Field(description="Specify how you want the results to be sorted")] = None, + i_row_max: Optional[Annotated[int, Field(le=10000, strict=True, ge=1)]] = None, + i_row_offset: Optional[Annotated[int, Field(strict=True, ge=0)]] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + s_filter: Optional[StrictStr] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> PaymenttermGetListV1Response: + """Retrieve Paymentterm list + :param e_order_by: Specify how you want the results to be sorted :type e_order_by: str @@ -542,32 +964,78 @@ def paymentterm_get_list_v1(self, e_order_by : Annotated[Optional[StrictStr], Fi :type accept_language: HeaderAcceptLanguage :param s_filter: :type s_filter: str - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: PaymenttermGetListV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the paymentterm_get_list_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.paymentterm_get_list_v1_with_http_info(e_order_by, i_row_max, i_row_offset, accept_language, s_filter, **kwargs) # noqa: E501 - - @validate_arguments - def paymentterm_get_list_v1_with_http_info(self, e_order_by : Annotated[Optional[StrictStr], Field(description="Specify how you want the results to be sorted")] = None, i_row_max : Optional[conint(strict=True, le=10000, ge=1)] = None, i_row_offset : Optional[conint(strict=True, ge=0)] = None, accept_language : Optional[HeaderAcceptLanguage] = None, s_filter : Optional[StrictStr] = None, **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve Paymentterm list # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.paymentterm_get_list_v1_with_http_info(e_order_by, i_row_max, i_row_offset, accept_language, s_filter, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._paymentterm_get_list_v1_serialize( + e_order_by=e_order_by, + i_row_max=i_row_max, + i_row_offset=i_row_offset, + accept_language=accept_language, + s_filter=s_filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "PaymenttermGetListV1Response", + '406': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def paymentterm_get_list_v1_with_http_info( + self, + e_order_by: Annotated[Optional[StrictStr], Field(description="Specify how you want the results to be sorted")] = None, + i_row_max: Optional[Annotated[int, Field(le=10000, strict=True, ge=1)]] = None, + i_row_offset: Optional[Annotated[int, Field(strict=True, ge=0)]] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + s_filter: Optional[StrictStr] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[PaymenttermGetListV1Response]: + """Retrieve Paymentterm list + :param e_order_by: Specify how you want the results to be sorted :type e_order_by: str @@ -579,257 +1047,472 @@ def paymentterm_get_list_v1_with_http_info(self, e_order_by : Annotated[Optional :type accept_language: HeaderAcceptLanguage :param s_filter: :type s_filter: str - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(PaymenttermGetListV1Response, status_code(int), headers(HTTPHeaderDict)) - """ - - _params = locals() - - _all_params = [ - 'e_order_by', - 'i_row_max', - 'i_row_offset', - 'accept_language', - 's_filter' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' - ] + """ # noqa: E501 + + _param = self._paymentterm_get_list_v1_serialize( + e_order_by=e_order_by, + i_row_max=i_row_max, + i_row_offset=i_row_offset, + accept_language=accept_language, + s_filter=s_filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method paymentterm_get_list_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "PaymenttermGetListV1Response", + '406': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _collection_formats = {} - # process the path parameters - _path_params = {} + @validate_call + def paymentterm_get_list_v1_without_preload_content( + self, + e_order_by: Annotated[Optional[StrictStr], Field(description="Specify how you want the results to be sorted")] = None, + i_row_max: Optional[Annotated[int, Field(le=10000, strict=True, ge=1)]] = None, + i_row_offset: Optional[Annotated[int, Field(strict=True, ge=0)]] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + s_filter: Optional[StrictStr] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve Paymentterm list - # process the query parameters - _query_params = [] - if _params.get('e_order_by') is not None: # noqa: E501 - _query_params.append(('eOrderBy', _params['e_order_by'])) - if _params.get('i_row_max') is not None: # noqa: E501 - _query_params.append(('iRowMax', _params['i_row_max'])) + :param e_order_by: Specify how you want the results to be sorted + :type e_order_by: str + :param i_row_max: + :type i_row_max: int + :param i_row_offset: + :type i_row_offset: int + :param accept_language: + :type accept_language: HeaderAcceptLanguage + :param s_filter: + :type s_filter: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._paymentterm_get_list_v1_serialize( + e_order_by=e_order_by, + i_row_max=i_row_max, + i_row_offset=i_row_offset, + accept_language=accept_language, + s_filter=s_filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "PaymenttermGetListV1Response", + '406': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - if _params.get('i_row_offset') is not None: # noqa: E501 - _query_params.append(('iRowOffset', _params['i_row_offset'])) - if _params.get('s_filter') is not None: # noqa: E501 - _query_params.append(('sFilter', _params['s_filter'])) + def _paymentterm_get_list_v1_serialize( + self, + e_order_by, + i_row_max, + i_row_offset, + accept_language, + s_filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: - # process the header parameters - _header_params = dict(_params.get('_headers', {})) - if _params['accept_language']: - _header_params['Accept-Language'] = _params['accept_language'] + _host = None + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if e_order_by is not None: + + _query_params.append(('eOrderBy', e_order_by)) + + if i_row_max is not None: + + _query_params.append(('iRowMax', i_row_max)) + + if i_row_offset is not None: + + _query_params.append(('iRowOffset', i_row_offset)) + + if s_filter is not None: + + _query_params.append(('sFilter', s_filter)) + + # process the header parameters + if accept_language is not None: + _header_params['Accept-Language'] = accept_language # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet']) # noqa: E501 + [ + 'application/json', + 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "PaymenttermGetListV1Response", - '406': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/paymentterm/getList', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/1/object/paymentterm/getList', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + - @validate_arguments - def paymentterm_get_object_v2(self, pki_paymentterm_id : StrictInt, **kwargs) -> PaymenttermGetObjectV2Response: # noqa: E501 - """Retrieve an existing Paymentterm # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def paymentterm_get_object_v2( + self, + pki_paymentterm_id: StrictInt, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> PaymenttermGetObjectV2Response: + """Retrieve an existing Paymentterm - >>> thread = api.paymentterm_get_object_v2(pki_paymentterm_id, async_req=True) - >>> result = thread.get() + :param pki_paymentterm_id: (required) :type pki_paymentterm_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: PaymenttermGetObjectV2Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the paymentterm_get_object_v2_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.paymentterm_get_object_v2_with_http_info(pki_paymentterm_id, **kwargs) # noqa: E501 - - @validate_arguments - def paymentterm_get_object_v2_with_http_info(self, pki_paymentterm_id : StrictInt, **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve an existing Paymentterm # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.paymentterm_get_object_v2_with_http_info(pki_paymentterm_id, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._paymentterm_get_object_v2_serialize( + pki_paymentterm_id=pki_paymentterm_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "PaymenttermGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def paymentterm_get_object_v2_with_http_info( + self, + pki_paymentterm_id: StrictInt, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[PaymenttermGetObjectV2Response]: + """Retrieve an existing Paymentterm + + :param pki_paymentterm_id: (required) :type pki_paymentterm_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(PaymenttermGetObjectV2Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._paymentterm_get_object_v2_serialize( + pki_paymentterm_id=pki_paymentterm_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '200': "PaymenttermGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'pki_paymentterm_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def paymentterm_get_object_v2_without_preload_content( + self, + pki_paymentterm_id: StrictInt, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve an existing Paymentterm + + + + :param pki_paymentterm_id: (required) + :type pki_paymentterm_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._paymentterm_get_object_v2_serialize( + pki_paymentterm_id=pki_paymentterm_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method paymentterm_get_object_v2" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "PaymenttermGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_paymentterm_id']: - _path_params['pkiPaymenttermID'] = _params['pki_paymentterm_id'] + def _paymentterm_get_object_v2_serialize( + self, + pki_paymentterm_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_paymentterm_id is not None: + _path_params['pkiPaymenttermID'] = pki_paymentterm_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "PaymenttermGetObjectV2Response", - '404': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/2/object/paymentterm/{pkiPaymenttermID}', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/2/object/paymentterm/{pkiPaymenttermID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/eZmaxApi/api/object_period_api.py b/eZmaxApi/api/object_period_api.py index 0bfd4374b..7d882e223 100644 --- a/eZmaxApi/api/object_period_api.py +++ b/eZmaxApi/api/object_period_api.py @@ -13,14 +13,20 @@ """ # noqa: E501 -import re # noqa: F401 import io import warnings -from pydantic import validate_arguments, ValidationError +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Dict, List, Optional, Tuple, Union, Any +try: + from typing import Annotated +except ImportError: + from typing_extensions import Annotated + +from pydantic import Field from typing_extensions import Annotated -from pydantic import Field, StrictStr +from pydantic import StrictStr, field_validator from typing import Optional @@ -30,10 +36,7 @@ from eZmaxApi.api_client import ApiClient from eZmaxApi.api_response import ApiResponse -from eZmaxApi.exceptions import ( # noqa: F401 - ApiTypeError, - ApiValueError -) +from eZmaxApi.rest import RESTResponseType class ObjectPeriodApi: @@ -48,16 +51,30 @@ def __init__(self, api_client=None) -> None: api_client = ApiClient.get_default() self.api_client = api_client - @validate_arguments - def period_get_autocomplete_v1(self, s_selector : Annotated[StrictStr, Field(..., description="The types of Periods to return")], e_filter_active : Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, s_query : Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, accept_language : Optional[HeaderAcceptLanguage] = None, **kwargs) -> CommonGetAutocompleteV1Response: # noqa: E501 - """(Deprecated) Retrieve Periods and IDs # noqa: E501 - Get the list of Periods to be used in a dropdown or autocomplete control. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def period_get_autocomplete_v1( + self, + s_selector: Annotated[StrictStr, Field(description="The types of Periods to return")], + e_filter_active: Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, + s_query: Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> CommonGetAutocompleteV1Response: + """(Deprecated) Retrieve Periods and IDs - >>> thread = api.period_get_autocomplete_v1(s_selector, e_filter_active, s_query, accept_language, async_req=True) - >>> result = thread.get() + Get the list of Periods to be used in a dropdown or autocomplete control. :param s_selector: The types of Periods to return (required) :type s_selector: str @@ -67,33 +84,77 @@ def period_get_autocomplete_v1(self, s_selector : Annotated[StrictStr, Field(... :type s_query: str :param accept_language: :type accept_language: HeaderAcceptLanguage - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: CommonGetAutocompleteV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the period_get_autocomplete_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.period_get_autocomplete_v1_with_http_info(s_selector, e_filter_active, s_query, accept_language, **kwargs) # noqa: E501 - - @validate_arguments - def period_get_autocomplete_v1_with_http_info(self, s_selector : Annotated[StrictStr, Field(..., description="The types of Periods to return")], e_filter_active : Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, s_query : Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, accept_language : Optional[HeaderAcceptLanguage] = None, **kwargs) -> ApiResponse: # noqa: E501 - """(Deprecated) Retrieve Periods and IDs # noqa: E501 - - Get the list of Periods to be used in a dropdown or autocomplete control. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.period_get_autocomplete_v1_with_http_info(s_selector, e_filter_active, s_query, accept_language, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + warnings.warn("GET /1/object/period/getAutocomplete/{sSelector} is deprecated.", DeprecationWarning) + + _param = self._period_get_autocomplete_v1_serialize( + s_selector=s_selector, + e_filter_active=e_filter_active, + s_query=s_query, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "CommonGetAutocompleteV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def period_get_autocomplete_v1_with_http_info( + self, + s_selector: Annotated[StrictStr, Field(description="The types of Periods to return")], + e_filter_active: Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, + s_query: Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[CommonGetAutocompleteV1Response]: + """(Deprecated) Retrieve Periods and IDs + + Get the list of Periods to be used in a dropdown or autocomplete control. :param s_selector: The types of Periods to return (required) :type s_selector: str @@ -103,127 +164,227 @@ def period_get_autocomplete_v1_with_http_info(self, s_selector : Annotated[Stric :type s_query: str :param accept_language: :type accept_language: HeaderAcceptLanguage - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(CommonGetAutocompleteV1Response, status_code(int), headers(HTTPHeaderDict)) - """ - + """ # noqa: E501 warnings.warn("GET /1/object/period/getAutocomplete/{sSelector} is deprecated.", DeprecationWarning) - _params = locals() + _param = self._period_get_autocomplete_v1_serialize( + s_selector=s_selector, + e_filter_active=e_filter_active, + s_query=s_query, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _all_params = [ - 's_selector', - 'e_filter_active', - 's_query', - 'accept_language' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + _response_types_map: Dict[str, Optional[str]] = { + '200': "CommonGetAutocompleteV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def period_get_autocomplete_v1_without_preload_content( + self, + s_selector: Annotated[StrictStr, Field(description="The types of Periods to return")], + e_filter_active: Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, + s_query: Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """(Deprecated) Retrieve Periods and IDs + + Get the list of Periods to be used in a dropdown or autocomplete control. + + :param s_selector: The types of Periods to return (required) + :type s_selector: str + :param e_filter_active: Specify which results we want to display. + :type e_filter_active: str + :param s_query: Allow to filter the returned results + :type s_query: str + :param accept_language: + :type accept_language: HeaderAcceptLanguage + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + warnings.warn("GET /1/object/period/getAutocomplete/{sSelector} is deprecated.", DeprecationWarning) + + _param = self._period_get_autocomplete_v1_serialize( + s_selector=s_selector, + e_filter_active=e_filter_active, + s_query=s_query, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method period_get_autocomplete_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "CommonGetAutocompleteV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['s_selector']: - _path_params['sSelector'] = _params['s_selector'] + def _period_get_autocomplete_v1_serialize( + self, + s_selector, + e_filter_active, + s_query, + accept_language, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None - # process the query parameters - _query_params = [] - if _params.get('e_filter_active') is not None: # noqa: E501 - _query_params.append(('eFilterActive', _params['e_filter_active'])) + _collection_formats: Dict[str, str] = { + } - if _params.get('s_query') is not None: # noqa: E501 - _query_params.append(('sQuery', _params['s_query'])) + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if s_selector is not None: + _path_params['sSelector'] = s_selector + # process the query parameters + if e_filter_active is not None: + + _query_params.append(('eFilterActive', e_filter_active)) + + if s_query is not None: + + _query_params.append(('sQuery', s_query)) + # process the header parameters - _header_params = dict(_params.get('_headers', {})) - if _params['accept_language']: - _header_params['Accept-Language'] = _params['accept_language'] - + if accept_language is not None: + _header_params['Accept-Language'] = accept_language # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "CommonGetAutocompleteV1Response", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/period/getAutocomplete/{sSelector}', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/1/object/period/getAutocomplete/{sSelector}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) - @validate_arguments - def period_get_autocomplete_v2(self, s_selector : Annotated[StrictStr, Field(..., description="The type of Periods to return")], e_filter_active : Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, s_query : Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, accept_language : Optional[HeaderAcceptLanguage] = None, **kwargs) -> PeriodGetAutocompleteV2Response: # noqa: E501 - """Retrieve Periods and IDs # noqa: E501 - Get the list of Period to be used in a dropdown or autocomplete control. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.period_get_autocomplete_v2(s_selector, e_filter_active, s_query, accept_language, async_req=True) - >>> result = thread.get() + + @validate_call + def period_get_autocomplete_v2( + self, + s_selector: Annotated[StrictStr, Field(description="The type of Periods to return")], + e_filter_active: Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, + s_query: Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> PeriodGetAutocompleteV2Response: + """Retrieve Periods and IDs + + Get the list of Period to be used in a dropdown or autocomplete control. :param s_selector: The type of Periods to return (required) :type s_selector: str @@ -233,33 +394,76 @@ def period_get_autocomplete_v2(self, s_selector : Annotated[StrictStr, Field(... :type s_query: str :param accept_language: :type accept_language: HeaderAcceptLanguage - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: PeriodGetAutocompleteV2Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the period_get_autocomplete_v2_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.period_get_autocomplete_v2_with_http_info(s_selector, e_filter_active, s_query, accept_language, **kwargs) # noqa: E501 - - @validate_arguments - def period_get_autocomplete_v2_with_http_info(self, s_selector : Annotated[StrictStr, Field(..., description="The type of Periods to return")], e_filter_active : Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, s_query : Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, accept_language : Optional[HeaderAcceptLanguage] = None, **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve Periods and IDs # noqa: E501 - - Get the list of Period to be used in a dropdown or autocomplete control. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.period_get_autocomplete_v2_with_http_info(s_selector, e_filter_active, s_query, accept_language, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._period_get_autocomplete_v2_serialize( + s_selector=s_selector, + e_filter_active=e_filter_active, + s_query=s_query, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "PeriodGetAutocompleteV2Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def period_get_autocomplete_v2_with_http_info( + self, + s_selector: Annotated[StrictStr, Field(description="The type of Periods to return")], + e_filter_active: Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, + s_query: Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[PeriodGetAutocompleteV2Response]: + """Retrieve Periods and IDs + + Get the list of Period to be used in a dropdown or autocomplete control. :param s_selector: The type of Periods to return (required) :type s_selector: str @@ -269,111 +473,197 @@ def period_get_autocomplete_v2_with_http_info(self, s_selector : Annotated[Stric :type s_query: str :param accept_language: :type accept_language: HeaderAcceptLanguage - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(PeriodGetAutocompleteV2Response, status_code(int), headers(HTTPHeaderDict)) - """ - - _params = locals() - - _all_params = [ - 's_selector', - 'e_filter_active', - 's_query', - 'accept_language' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + """ # noqa: E501 + + _param = self._period_get_autocomplete_v2_serialize( + s_selector=s_selector, + e_filter_active=e_filter_active, + s_query=s_query, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "PeriodGetAutocompleteV2Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def period_get_autocomplete_v2_without_preload_content( + self, + s_selector: Annotated[StrictStr, Field(description="The type of Periods to return")], + e_filter_active: Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, + s_query: Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve Periods and IDs + + Get the list of Period to be used in a dropdown or autocomplete control. + + :param s_selector: The type of Periods to return (required) + :type s_selector: str + :param e_filter_active: Specify which results we want to display. + :type e_filter_active: str + :param s_query: Allow to filter the returned results + :type s_query: str + :param accept_language: + :type accept_language: HeaderAcceptLanguage + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._period_get_autocomplete_v2_serialize( + s_selector=s_selector, + e_filter_active=e_filter_active, + s_query=s_query, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method period_get_autocomplete_v2" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "PeriodGetAutocompleteV2Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['s_selector']: - _path_params['sSelector'] = _params['s_selector'] + def _period_get_autocomplete_v2_serialize( + self, + s_selector, + e_filter_active, + s_query, + accept_language, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None - # process the query parameters - _query_params = [] - if _params.get('e_filter_active') is not None: # noqa: E501 - _query_params.append(('eFilterActive', _params['e_filter_active'])) + _collection_formats: Dict[str, str] = { + } - if _params.get('s_query') is not None: # noqa: E501 - _query_params.append(('sQuery', _params['s_query'])) + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if s_selector is not None: + _path_params['sSelector'] = s_selector + # process the query parameters + if e_filter_active is not None: + + _query_params.append(('eFilterActive', e_filter_active)) + + if s_query is not None: + + _query_params.append(('sQuery', s_query)) + # process the header parameters - _header_params = dict(_params.get('_headers', {})) - if _params['accept_language']: - _header_params['Accept-Language'] = _params['accept_language'] - + if accept_language is not None: + _header_params['Accept-Language'] = accept_language # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "PeriodGetAutocompleteV2Response", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/2/object/period/getAutocomplete/{sSelector}', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/2/object/period/getAutocomplete/{sSelector}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/eZmaxApi/api/object_permission_api.py b/eZmaxApi/api/object_permission_api.py index acc565ec7..5add29bc0 100644 --- a/eZmaxApi/api/object_permission_api.py +++ b/eZmaxApi/api/object_permission_api.py @@ -13,15 +13,19 @@ """ # noqa: E501 -import re # noqa: F401 import io import warnings -from pydantic import validate_arguments, ValidationError +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Dict, List, Optional, Tuple, Union, Any -from typing_extensions import Annotated -from pydantic import Field, conint +try: + from typing import Annotated +except ImportError: + from typing_extensions import Annotated +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.permission_create_object_v1_request import PermissionCreateObjectV1Request from eZmaxApi.models.permission_create_object_v1_response import PermissionCreateObjectV1Response from eZmaxApi.models.permission_delete_object_v1_response import PermissionDeleteObjectV1Response @@ -31,10 +35,7 @@ from eZmaxApi.api_client import ApiClient from eZmaxApi.api_response import ApiResponse -from eZmaxApi.exceptions import ( # noqa: F401 - ApiTypeError, - ApiValueError -) +from eZmaxApi.rest import RESTResponseType class ObjectPermissionApi: @@ -49,589 +50,1090 @@ def __init__(self, api_client=None) -> None: api_client = ApiClient.get_default() self.api_client = api_client - @validate_arguments - def permission_create_object_v1(self, permission_create_object_v1_request : PermissionCreateObjectV1Request, **kwargs) -> PermissionCreateObjectV1Response: # noqa: E501 - """Create a new Permission # noqa: E501 - The endpoint allows to create one or many elements at once. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def permission_create_object_v1( + self, + permission_create_object_v1_request: PermissionCreateObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> PermissionCreateObjectV1Response: + """Create a new Permission - >>> thread = api.permission_create_object_v1(permission_create_object_v1_request, async_req=True) - >>> result = thread.get() + The endpoint allows to create one or many elements at once. :param permission_create_object_v1_request: (required) :type permission_create_object_v1_request: PermissionCreateObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: PermissionCreateObjectV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the permission_create_object_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.permission_create_object_v1_with_http_info(permission_create_object_v1_request, **kwargs) # noqa: E501 - - @validate_arguments - def permission_create_object_v1_with_http_info(self, permission_create_object_v1_request : PermissionCreateObjectV1Request, **kwargs) -> ApiResponse: # noqa: E501 - """Create a new Permission # noqa: E501 - - The endpoint allows to create one or many elements at once. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.permission_create_object_v1_with_http_info(permission_create_object_v1_request, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._permission_create_object_v1_serialize( + permission_create_object_v1_request=permission_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "PermissionCreateObjectV1Response", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def permission_create_object_v1_with_http_info( + self, + permission_create_object_v1_request: PermissionCreateObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[PermissionCreateObjectV1Response]: + """Create a new Permission + + The endpoint allows to create one or many elements at once. :param permission_create_object_v1_request: (required) :type permission_create_object_v1_request: PermissionCreateObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(PermissionCreateObjectV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._permission_create_object_v1_serialize( + permission_create_object_v1_request=permission_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "PermissionCreateObjectV1Response", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _params = locals() - _all_params = [ - 'permission_create_object_v1_request' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + @validate_call + def permission_create_object_v1_without_preload_content( + self, + permission_create_object_v1_request: PermissionCreateObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Create a new Permission + + The endpoint allows to create one or many elements at once. + + :param permission_create_object_v1_request: (required) + :type permission_create_object_v1_request: PermissionCreateObjectV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._permission_create_object_v1_serialize( + permission_create_object_v1_request=permission_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method permission_create_object_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '201': "PermissionCreateObjectV1Response", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} + def _permission_create_object_v1_serialize( + self, + permission_create_object_v1_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['permission_create_object_v1_request'] is not None: - _body_params = _params['permission_create_object_v1_request'] + if permission_create_object_v1_request is not None: + _body_params = permission_create_object_v1_request + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '201': "PermissionCreateObjectV1Response", - '422': "CommonResponseError", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/permission', 'POST', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='POST', + resource_path='/1/object/permission', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + - @validate_arguments - def permission_delete_object_v1(self, pki_permission_id : Annotated[conint(strict=True, le=65535, ge=0), Field(..., description="The unique ID of the Permission")], **kwargs) -> PermissionDeleteObjectV1Response: # noqa: E501 - """Delete an existing Permission # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def permission_delete_object_v1( + self, + pki_permission_id: Annotated[int, Field(le=65535, strict=True, ge=0, description="The unique ID of the Permission")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> PermissionDeleteObjectV1Response: + """Delete an existing Permission - >>> thread = api.permission_delete_object_v1(pki_permission_id, async_req=True) - >>> result = thread.get() + :param pki_permission_id: The unique ID of the Permission (required) :type pki_permission_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: PermissionDeleteObjectV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the permission_delete_object_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.permission_delete_object_v1_with_http_info(pki_permission_id, **kwargs) # noqa: E501 - - @validate_arguments - def permission_delete_object_v1_with_http_info(self, pki_permission_id : Annotated[conint(strict=True, le=65535, ge=0), Field(..., description="The unique ID of the Permission")], **kwargs) -> ApiResponse: # noqa: E501 - """Delete an existing Permission # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.permission_delete_object_v1_with_http_info(pki_permission_id, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._permission_delete_object_v1_serialize( + pki_permission_id=pki_permission_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "PermissionDeleteObjectV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def permission_delete_object_v1_with_http_info( + self, + pki_permission_id: Annotated[int, Field(le=65535, strict=True, ge=0, description="The unique ID of the Permission")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[PermissionDeleteObjectV1Response]: + """Delete an existing Permission + + :param pki_permission_id: The unique ID of the Permission (required) :type pki_permission_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(PermissionDeleteObjectV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._permission_delete_object_v1_serialize( + pki_permission_id=pki_permission_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '200': "PermissionDeleteObjectV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'pki_permission_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def permission_delete_object_v1_without_preload_content( + self, + pki_permission_id: Annotated[int, Field(le=65535, strict=True, ge=0, description="The unique ID of the Permission")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete an existing Permission + + + + :param pki_permission_id: The unique ID of the Permission (required) + :type pki_permission_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._permission_delete_object_v1_serialize( + pki_permission_id=pki_permission_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method permission_delete_object_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "PermissionDeleteObjectV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_permission_id']: - _path_params['pkiPermissionID'] = _params['pki_permission_id'] + def _permission_delete_object_v1_serialize( + self, + pki_permission_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if pki_permission_id is not None: + _path_params['pkiPermissionID'] = pki_permission_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "PermissionDeleteObjectV1Response", - '404': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/permission/{pkiPermissionID}', 'DELETE', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='DELETE', + resource_path='/1/object/permission/{pkiPermissionID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) - @validate_arguments - def permission_edit_object_v1(self, pki_permission_id : Annotated[conint(strict=True, le=65535, ge=0), Field(..., description="The unique ID of the Permission")], permission_edit_object_v1_request : PermissionEditObjectV1Request, **kwargs) -> PermissionEditObjectV1Response: # noqa: E501 - """Edit an existing Permission # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.permission_edit_object_v1(pki_permission_id, permission_edit_object_v1_request, async_req=True) - >>> result = thread.get() + + @validate_call + def permission_edit_object_v1( + self, + pki_permission_id: Annotated[int, Field(le=65535, strict=True, ge=0, description="The unique ID of the Permission")], + permission_edit_object_v1_request: PermissionEditObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> PermissionEditObjectV1Response: + """Edit an existing Permission + + :param pki_permission_id: The unique ID of the Permission (required) :type pki_permission_id: int :param permission_edit_object_v1_request: (required) :type permission_edit_object_v1_request: PermissionEditObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: PermissionEditObjectV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the permission_edit_object_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.permission_edit_object_v1_with_http_info(pki_permission_id, permission_edit_object_v1_request, **kwargs) # noqa: E501 - - @validate_arguments - def permission_edit_object_v1_with_http_info(self, pki_permission_id : Annotated[conint(strict=True, le=65535, ge=0), Field(..., description="The unique ID of the Permission")], permission_edit_object_v1_request : PermissionEditObjectV1Request, **kwargs) -> ApiResponse: # noqa: E501 - """Edit an existing Permission # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.permission_edit_object_v1_with_http_info(pki_permission_id, permission_edit_object_v1_request, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._permission_edit_object_v1_serialize( + pki_permission_id=pki_permission_id, + permission_edit_object_v1_request=permission_edit_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "PermissionEditObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def permission_edit_object_v1_with_http_info( + self, + pki_permission_id: Annotated[int, Field(le=65535, strict=True, ge=0, description="The unique ID of the Permission")], + permission_edit_object_v1_request: PermissionEditObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[PermissionEditObjectV1Response]: + """Edit an existing Permission + + :param pki_permission_id: The unique ID of the Permission (required) :type pki_permission_id: int :param permission_edit_object_v1_request: (required) :type permission_edit_object_v1_request: PermissionEditObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(PermissionEditObjectV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._permission_edit_object_v1_serialize( + pki_permission_id=pki_permission_id, + permission_edit_object_v1_request=permission_edit_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '200': "PermissionEditObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'pki_permission_id', - 'permission_edit_object_v1_request' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def permission_edit_object_v1_without_preload_content( + self, + pki_permission_id: Annotated[int, Field(le=65535, strict=True, ge=0, description="The unique ID of the Permission")], + permission_edit_object_v1_request: PermissionEditObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Edit an existing Permission + + + + :param pki_permission_id: The unique ID of the Permission (required) + :type pki_permission_id: int + :param permission_edit_object_v1_request: (required) + :type permission_edit_object_v1_request: PermissionEditObjectV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._permission_edit_object_v1_serialize( + pki_permission_id=pki_permission_id, + permission_edit_object_v1_request=permission_edit_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method permission_edit_object_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "PermissionEditObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_permission_id']: - _path_params['pkiPermissionID'] = _params['pki_permission_id'] + def _permission_edit_object_v1_serialize( + self, + pki_permission_id, + permission_edit_object_v1_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if pki_permission_id is not None: + _path_params['pkiPermissionID'] = pki_permission_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['permission_edit_object_v1_request'] is not None: - _body_params = _params['permission_edit_object_v1_request'] + if permission_edit_object_v1_request is not None: + _body_params = permission_edit_object_v1_request + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '200': "PermissionEditObjectV1Response", - '404': "CommonResponseError", - '422': "CommonResponseError", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/permission/{pkiPermissionID}', 'PUT', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='PUT', + resource_path='/1/object/permission/{pkiPermissionID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) - @validate_arguments - def permission_get_object_v2(self, pki_permission_id : Annotated[conint(strict=True, le=65535, ge=0), Field(..., description="The unique ID of the Permission")], **kwargs) -> PermissionGetObjectV2Response: # noqa: E501 - """Retrieve an existing Permission # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.permission_get_object_v2(pki_permission_id, async_req=True) - >>> result = thread.get() + + @validate_call + def permission_get_object_v2( + self, + pki_permission_id: Annotated[int, Field(le=65535, strict=True, ge=0, description="The unique ID of the Permission")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> PermissionGetObjectV2Response: + """Retrieve an existing Permission + + :param pki_permission_id: The unique ID of the Permission (required) :type pki_permission_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: PermissionGetObjectV2Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the permission_get_object_v2_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.permission_get_object_v2_with_http_info(pki_permission_id, **kwargs) # noqa: E501 - - @validate_arguments - def permission_get_object_v2_with_http_info(self, pki_permission_id : Annotated[conint(strict=True, le=65535, ge=0), Field(..., description="The unique ID of the Permission")], **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve an existing Permission # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.permission_get_object_v2_with_http_info(pki_permission_id, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._permission_get_object_v2_serialize( + pki_permission_id=pki_permission_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "PermissionGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def permission_get_object_v2_with_http_info( + self, + pki_permission_id: Annotated[int, Field(le=65535, strict=True, ge=0, description="The unique ID of the Permission")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[PermissionGetObjectV2Response]: + """Retrieve an existing Permission + + :param pki_permission_id: The unique ID of the Permission (required) :type pki_permission_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(PermissionGetObjectV2Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._permission_get_object_v2_serialize( + pki_permission_id=pki_permission_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "PermissionGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _params = locals() - _all_params = [ - 'pki_permission_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + @validate_call + def permission_get_object_v2_without_preload_content( + self, + pki_permission_id: Annotated[int, Field(le=65535, strict=True, ge=0, description="The unique ID of the Permission")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve an existing Permission + + + + :param pki_permission_id: The unique ID of the Permission (required) + :type pki_permission_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._permission_get_object_v2_serialize( + pki_permission_id=pki_permission_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method permission_get_object_v2" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "PermissionGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_permission_id']: - _path_params['pkiPermissionID'] = _params['pki_permission_id'] + def _permission_get_object_v2_serialize( + self, + pki_permission_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_permission_id is not None: + _path_params['pkiPermissionID'] = pki_permission_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "PermissionGetObjectV2Response", - '404': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/2/object/permission/{pkiPermissionID}', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/2/object/permission/{pkiPermissionID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/eZmaxApi/api/object_phonetype_api.py b/eZmaxApi/api/object_phonetype_api.py index 120b0adf3..f5b903e06 100644 --- a/eZmaxApi/api/object_phonetype_api.py +++ b/eZmaxApi/api/object_phonetype_api.py @@ -13,14 +13,20 @@ """ # noqa: E501 -import re # noqa: F401 import io import warnings -from pydantic import validate_arguments, ValidationError +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Dict, List, Optional, Tuple, Union, Any +try: + from typing import Annotated +except ImportError: + from typing_extensions import Annotated + +from pydantic import Field from typing_extensions import Annotated -from pydantic import Field, StrictStr +from pydantic import StrictStr, field_validator from typing import Optional @@ -29,10 +35,7 @@ from eZmaxApi.api_client import ApiClient from eZmaxApi.api_response import ApiResponse -from eZmaxApi.exceptions import ( # noqa: F401 - ApiTypeError, - ApiValueError -) +from eZmaxApi.rest import RESTResponseType class ObjectPhonetypeApi: @@ -47,16 +50,30 @@ def __init__(self, api_client=None) -> None: api_client = ApiClient.get_default() self.api_client = api_client - @validate_arguments - def phonetype_get_autocomplete_v2(self, s_selector : Annotated[StrictStr, Field(..., description="The type of Phonetypes to return")], e_filter_active : Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, s_query : Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, accept_language : Optional[HeaderAcceptLanguage] = None, **kwargs) -> PhonetypeGetAutocompleteV2Response: # noqa: E501 - """Retrieve Phonetypes and IDs # noqa: E501 - Get the list of Phonetype to be used in a dropdown or autocomplete control. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def phonetype_get_autocomplete_v2( + self, + s_selector: Annotated[StrictStr, Field(description="The type of Phonetypes to return")], + e_filter_active: Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, + s_query: Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> PhonetypeGetAutocompleteV2Response: + """Retrieve Phonetypes and IDs - >>> thread = api.phonetype_get_autocomplete_v2(s_selector, e_filter_active, s_query, accept_language, async_req=True) - >>> result = thread.get() + Get the list of Phonetype to be used in a dropdown or autocomplete control. :param s_selector: The type of Phonetypes to return (required) :type s_selector: str @@ -66,33 +83,76 @@ def phonetype_get_autocomplete_v2(self, s_selector : Annotated[StrictStr, Field( :type s_query: str :param accept_language: :type accept_language: HeaderAcceptLanguage - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: PhonetypeGetAutocompleteV2Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the phonetype_get_autocomplete_v2_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.phonetype_get_autocomplete_v2_with_http_info(s_selector, e_filter_active, s_query, accept_language, **kwargs) # noqa: E501 - - @validate_arguments - def phonetype_get_autocomplete_v2_with_http_info(self, s_selector : Annotated[StrictStr, Field(..., description="The type of Phonetypes to return")], e_filter_active : Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, s_query : Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, accept_language : Optional[HeaderAcceptLanguage] = None, **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve Phonetypes and IDs # noqa: E501 - - Get the list of Phonetype to be used in a dropdown or autocomplete control. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.phonetype_get_autocomplete_v2_with_http_info(s_selector, e_filter_active, s_query, accept_language, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._phonetype_get_autocomplete_v2_serialize( + s_selector=s_selector, + e_filter_active=e_filter_active, + s_query=s_query, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "PhonetypeGetAutocompleteV2Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def phonetype_get_autocomplete_v2_with_http_info( + self, + s_selector: Annotated[StrictStr, Field(description="The type of Phonetypes to return")], + e_filter_active: Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, + s_query: Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[PhonetypeGetAutocompleteV2Response]: + """Retrieve Phonetypes and IDs + + Get the list of Phonetype to be used in a dropdown or autocomplete control. :param s_selector: The type of Phonetypes to return (required) :type s_selector: str @@ -102,111 +162,197 @@ def phonetype_get_autocomplete_v2_with_http_info(self, s_selector : Annotated[St :type s_query: str :param accept_language: :type accept_language: HeaderAcceptLanguage - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(PhonetypeGetAutocompleteV2Response, status_code(int), headers(HTTPHeaderDict)) - """ - - _params = locals() - - _all_params = [ - 's_selector', - 'e_filter_active', - 's_query', - 'accept_language' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + """ # noqa: E501 + + _param = self._phonetype_get_autocomplete_v2_serialize( + s_selector=s_selector, + e_filter_active=e_filter_active, + s_query=s_query, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "PhonetypeGetAutocompleteV2Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def phonetype_get_autocomplete_v2_without_preload_content( + self, + s_selector: Annotated[StrictStr, Field(description="The type of Phonetypes to return")], + e_filter_active: Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, + s_query: Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve Phonetypes and IDs + + Get the list of Phonetype to be used in a dropdown or autocomplete control. + + :param s_selector: The type of Phonetypes to return (required) + :type s_selector: str + :param e_filter_active: Specify which results we want to display. + :type e_filter_active: str + :param s_query: Allow to filter the returned results + :type s_query: str + :param accept_language: + :type accept_language: HeaderAcceptLanguage + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._phonetype_get_autocomplete_v2_serialize( + s_selector=s_selector, + e_filter_active=e_filter_active, + s_query=s_query, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method phonetype_get_autocomplete_v2" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "PhonetypeGetAutocompleteV2Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['s_selector']: - _path_params['sSelector'] = _params['s_selector'] + def _phonetype_get_autocomplete_v2_serialize( + self, + s_selector, + e_filter_active, + s_query, + accept_language, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None - # process the query parameters - _query_params = [] - if _params.get('e_filter_active') is not None: # noqa: E501 - _query_params.append(('eFilterActive', _params['e_filter_active'])) + _collection_formats: Dict[str, str] = { + } - if _params.get('s_query') is not None: # noqa: E501 - _query_params.append(('sQuery', _params['s_query'])) + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if s_selector is not None: + _path_params['sSelector'] = s_selector + # process the query parameters + if e_filter_active is not None: + + _query_params.append(('eFilterActive', e_filter_active)) + + if s_query is not None: + + _query_params.append(('sQuery', s_query)) + # process the header parameters - _header_params = dict(_params.get('_headers', {})) - if _params['accept_language']: - _header_params['Accept-Language'] = _params['accept_language'] - + if accept_language is not None: + _header_params['Accept-Language'] = accept_language # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "PhonetypeGetAutocompleteV2Response", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/2/object/phonetype/getAutocomplete/{sSelector}', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/2/object/phonetype/getAutocomplete/{sSelector}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/eZmaxApi/api/object_rejectedoffertopurchase_api.py b/eZmaxApi/api/object_rejectedoffertopurchase_api.py index 6c504a8df..a96de4a82 100644 --- a/eZmaxApi/api/object_rejectedoffertopurchase_api.py +++ b/eZmaxApi/api/object_rejectedoffertopurchase_api.py @@ -13,22 +13,24 @@ """ # noqa: E501 -import re # noqa: F401 import io import warnings -from pydantic import validate_arguments, ValidationError +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Dict, List, Optional, Tuple, Union, Any -from pydantic import conint +try: + from typing import Annotated +except ImportError: + from typing_extensions import Annotated +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.rejectedoffertopurchase_get_communication_list_v1_response import RejectedoffertopurchaseGetCommunicationListV1Response from eZmaxApi.api_client import ApiClient from eZmaxApi.api_response import ApiResponse -from eZmaxApi.exceptions import ( # noqa: F401 - ApiTypeError, - ApiValueError -) +from eZmaxApi.rest import RESTResponseType class ObjectRejectedoffertopurchaseApi: @@ -43,143 +45,263 @@ def __init__(self, api_client=None) -> None: api_client = ApiClient.get_default() self.api_client = api_client - @validate_arguments - def rejectedoffertopurchase_get_communication_list_v1(self, pki_rejectedoffertopurchase_id : conint(strict=True, le=65535, ge=1), **kwargs) -> RejectedoffertopurchaseGetCommunicationListV1Response: # noqa: E501 - """Retrieve Communication list # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def rejectedoffertopurchase_get_communication_list_v1( + self, + pki_rejectedoffertopurchase_id: Annotated[int, Field(le=65535, strict=True, ge=1)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RejectedoffertopurchaseGetCommunicationListV1Response: + """Retrieve Communication list - >>> thread = api.rejectedoffertopurchase_get_communication_list_v1(pki_rejectedoffertopurchase_id, async_req=True) - >>> result = thread.get() + :param pki_rejectedoffertopurchase_id: (required) :type pki_rejectedoffertopurchase_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: RejectedoffertopurchaseGetCommunicationListV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the rejectedoffertopurchase_get_communication_list_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.rejectedoffertopurchase_get_communication_list_v1_with_http_info(pki_rejectedoffertopurchase_id, **kwargs) # noqa: E501 - - @validate_arguments - def rejectedoffertopurchase_get_communication_list_v1_with_http_info(self, pki_rejectedoffertopurchase_id : conint(strict=True, le=65535, ge=1), **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve Communication list # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.rejectedoffertopurchase_get_communication_list_v1_with_http_info(pki_rejectedoffertopurchase_id, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._rejectedoffertopurchase_get_communication_list_v1_serialize( + pki_rejectedoffertopurchase_id=pki_rejectedoffertopurchase_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "RejectedoffertopurchaseGetCommunicationListV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def rejectedoffertopurchase_get_communication_list_v1_with_http_info( + self, + pki_rejectedoffertopurchase_id: Annotated[int, Field(le=65535, strict=True, ge=1)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[RejectedoffertopurchaseGetCommunicationListV1Response]: + """Retrieve Communication list + + :param pki_rejectedoffertopurchase_id: (required) :type pki_rejectedoffertopurchase_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(RejectedoffertopurchaseGetCommunicationListV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._rejectedoffertopurchase_get_communication_list_v1_serialize( + pki_rejectedoffertopurchase_id=pki_rejectedoffertopurchase_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '200': "RejectedoffertopurchaseGetCommunicationListV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'pki_rejectedoffertopurchase_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def rejectedoffertopurchase_get_communication_list_v1_without_preload_content( + self, + pki_rejectedoffertopurchase_id: Annotated[int, Field(le=65535, strict=True, ge=1)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve Communication list + + + + :param pki_rejectedoffertopurchase_id: (required) + :type pki_rejectedoffertopurchase_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._rejectedoffertopurchase_get_communication_list_v1_serialize( + pki_rejectedoffertopurchase_id=pki_rejectedoffertopurchase_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method rejectedoffertopurchase_get_communication_list_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "RejectedoffertopurchaseGetCommunicationListV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_rejectedoffertopurchase_id']: - _path_params['pkiRejectedoffertopurchaseID'] = _params['pki_rejectedoffertopurchase_id'] + def _rejectedoffertopurchase_get_communication_list_v1_serialize( + self, + pki_rejectedoffertopurchase_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_rejectedoffertopurchase_id is not None: + _path_params['pkiRejectedoffertopurchaseID'] = pki_rejectedoffertopurchase_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "RejectedoffertopurchaseGetCommunicationListV1Response", - '404': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/rejectedoffertopurchase/{pkiRejectedoffertopurchaseID}/getCommunicationList', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/1/object/rejectedoffertopurchase/{pkiRejectedoffertopurchaseID}/getCommunicationList', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/eZmaxApi/api/object_secretquestion_api.py b/eZmaxApi/api/object_secretquestion_api.py index f7d1fad3b..fd5240f90 100644 --- a/eZmaxApi/api/object_secretquestion_api.py +++ b/eZmaxApi/api/object_secretquestion_api.py @@ -13,14 +13,20 @@ """ # noqa: E501 -import re # noqa: F401 import io import warnings -from pydantic import validate_arguments, ValidationError +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Dict, List, Optional, Tuple, Union, Any +try: + from typing import Annotated +except ImportError: + from typing_extensions import Annotated + +from pydantic import Field from typing_extensions import Annotated -from pydantic import Field, StrictStr +from pydantic import StrictStr, field_validator from typing import Optional @@ -29,10 +35,7 @@ from eZmaxApi.api_client import ApiClient from eZmaxApi.api_response import ApiResponse -from eZmaxApi.exceptions import ( # noqa: F401 - ApiTypeError, - ApiValueError -) +from eZmaxApi.rest import RESTResponseType class ObjectSecretquestionApi: @@ -47,16 +50,30 @@ def __init__(self, api_client=None) -> None: api_client = ApiClient.get_default() self.api_client = api_client - @validate_arguments - def secretquestion_get_autocomplete_v2(self, s_selector : Annotated[StrictStr, Field(..., description="The type of Secretquestions to return")], e_filter_active : Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, s_query : Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, accept_language : Optional[HeaderAcceptLanguage] = None, **kwargs) -> SecretquestionGetAutocompleteV2Response: # noqa: E501 - """Retrieve Secretquestions and IDs # noqa: E501 - Get the list of Secretquestion to be used in a dropdown or autocomplete control. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def secretquestion_get_autocomplete_v2( + self, + s_selector: Annotated[StrictStr, Field(description="The type of Secretquestions to return")], + e_filter_active: Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, + s_query: Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> SecretquestionGetAutocompleteV2Response: + """Retrieve Secretquestions and IDs - >>> thread = api.secretquestion_get_autocomplete_v2(s_selector, e_filter_active, s_query, accept_language, async_req=True) - >>> result = thread.get() + Get the list of Secretquestion to be used in a dropdown or autocomplete control. :param s_selector: The type of Secretquestions to return (required) :type s_selector: str @@ -66,33 +83,76 @@ def secretquestion_get_autocomplete_v2(self, s_selector : Annotated[StrictStr, F :type s_query: str :param accept_language: :type accept_language: HeaderAcceptLanguage - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: SecretquestionGetAutocompleteV2Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the secretquestion_get_autocomplete_v2_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.secretquestion_get_autocomplete_v2_with_http_info(s_selector, e_filter_active, s_query, accept_language, **kwargs) # noqa: E501 - - @validate_arguments - def secretquestion_get_autocomplete_v2_with_http_info(self, s_selector : Annotated[StrictStr, Field(..., description="The type of Secretquestions to return")], e_filter_active : Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, s_query : Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, accept_language : Optional[HeaderAcceptLanguage] = None, **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve Secretquestions and IDs # noqa: E501 - - Get the list of Secretquestion to be used in a dropdown or autocomplete control. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.secretquestion_get_autocomplete_v2_with_http_info(s_selector, e_filter_active, s_query, accept_language, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._secretquestion_get_autocomplete_v2_serialize( + s_selector=s_selector, + e_filter_active=e_filter_active, + s_query=s_query, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "SecretquestionGetAutocompleteV2Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def secretquestion_get_autocomplete_v2_with_http_info( + self, + s_selector: Annotated[StrictStr, Field(description="The type of Secretquestions to return")], + e_filter_active: Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, + s_query: Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[SecretquestionGetAutocompleteV2Response]: + """Retrieve Secretquestions and IDs + + Get the list of Secretquestion to be used in a dropdown or autocomplete control. :param s_selector: The type of Secretquestions to return (required) :type s_selector: str @@ -102,111 +162,197 @@ def secretquestion_get_autocomplete_v2_with_http_info(self, s_selector : Annotat :type s_query: str :param accept_language: :type accept_language: HeaderAcceptLanguage - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(SecretquestionGetAutocompleteV2Response, status_code(int), headers(HTTPHeaderDict)) - """ - - _params = locals() - - _all_params = [ - 's_selector', - 'e_filter_active', - 's_query', - 'accept_language' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + """ # noqa: E501 + + _param = self._secretquestion_get_autocomplete_v2_serialize( + s_selector=s_selector, + e_filter_active=e_filter_active, + s_query=s_query, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "SecretquestionGetAutocompleteV2Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def secretquestion_get_autocomplete_v2_without_preload_content( + self, + s_selector: Annotated[StrictStr, Field(description="The type of Secretquestions to return")], + e_filter_active: Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, + s_query: Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve Secretquestions and IDs + + Get the list of Secretquestion to be used in a dropdown or autocomplete control. + + :param s_selector: The type of Secretquestions to return (required) + :type s_selector: str + :param e_filter_active: Specify which results we want to display. + :type e_filter_active: str + :param s_query: Allow to filter the returned results + :type s_query: str + :param accept_language: + :type accept_language: HeaderAcceptLanguage + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._secretquestion_get_autocomplete_v2_serialize( + s_selector=s_selector, + e_filter_active=e_filter_active, + s_query=s_query, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method secretquestion_get_autocomplete_v2" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "SecretquestionGetAutocompleteV2Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['s_selector']: - _path_params['sSelector'] = _params['s_selector'] + def _secretquestion_get_autocomplete_v2_serialize( + self, + s_selector, + e_filter_active, + s_query, + accept_language, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None - # process the query parameters - _query_params = [] - if _params.get('e_filter_active') is not None: # noqa: E501 - _query_params.append(('eFilterActive', _params['e_filter_active'])) + _collection_formats: Dict[str, str] = { + } - if _params.get('s_query') is not None: # noqa: E501 - _query_params.append(('sQuery', _params['s_query'])) + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if s_selector is not None: + _path_params['sSelector'] = s_selector + # process the query parameters + if e_filter_active is not None: + + _query_params.append(('eFilterActive', e_filter_active)) + + if s_query is not None: + + _query_params.append(('sQuery', s_query)) + # process the header parameters - _header_params = dict(_params.get('_headers', {})) - if _params['accept_language']: - _header_params['Accept-Language'] = _params['accept_language'] - + if accept_language is not None: + _header_params['Accept-Language'] = accept_language # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "SecretquestionGetAutocompleteV2Response", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/2/object/secretquestion/getAutocomplete/{sSelector}', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/2/object/secretquestion/getAutocomplete/{sSelector}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/eZmaxApi/api/object_sessionhistory_api.py b/eZmaxApi/api/object_sessionhistory_api.py index 0f9659587..55cd3376f 100644 --- a/eZmaxApi/api/object_sessionhistory_api.py +++ b/eZmaxApi/api/object_sessionhistory_api.py @@ -13,14 +13,20 @@ """ # noqa: E501 -import re # noqa: F401 import io import warnings -from pydantic import validate_arguments, ValidationError +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Dict, List, Optional, Tuple, Union, Any +try: + from typing import Annotated +except ImportError: + from typing_extensions import Annotated + +from pydantic import Field from typing_extensions import Annotated -from pydantic import Field, StrictStr, conint +from pydantic import StrictStr, field_validator from typing import Optional @@ -29,10 +35,7 @@ from eZmaxApi.api_client import ApiClient from eZmaxApi.api_response import ApiResponse -from eZmaxApi.exceptions import ( # noqa: F401 - ApiTypeError, - ApiValueError -) +from eZmaxApi.rest import RESTResponseType class ObjectSessionhistoryApi: @@ -47,15 +50,30 @@ def __init__(self, api_client=None) -> None: api_client = ApiClient.get_default() self.api_client = api_client - @validate_arguments - def sessionhistory_get_list_v1(self, e_order_by : Annotated[Optional[StrictStr], Field(description="Specify how you want the results to be sorted")] = None, i_row_max : Optional[conint(strict=True, le=10000, ge=1)] = None, i_row_offset : Optional[conint(strict=True, ge=0)] = None, accept_language : Optional[HeaderAcceptLanguage] = None, s_filter : Optional[StrictStr] = None, **kwargs) -> SessionhistoryGetListV1Response: # noqa: E501 - """Retrieve Sessionhistory list # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def sessionhistory_get_list_v1( + self, + e_order_by: Annotated[Optional[StrictStr], Field(description="Specify how you want the results to be sorted")] = None, + i_row_max: Optional[Annotated[int, Field(le=10000, strict=True, ge=1)]] = None, + i_row_offset: Optional[Annotated[int, Field(strict=True, ge=0)]] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + s_filter: Optional[StrictStr] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> SessionhistoryGetListV1Response: + """Retrieve Sessionhistory list - >>> thread = api.sessionhistory_get_list_v1(e_order_by, i_row_max, i_row_offset, accept_language, s_filter, async_req=True) - >>> result = thread.get() :param e_order_by: Specify how you want the results to be sorted :type e_order_by: str @@ -67,32 +85,78 @@ def sessionhistory_get_list_v1(self, e_order_by : Annotated[Optional[StrictStr], :type accept_language: HeaderAcceptLanguage :param s_filter: :type s_filter: str - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: SessionhistoryGetListV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the sessionhistory_get_list_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.sessionhistory_get_list_v1_with_http_info(e_order_by, i_row_max, i_row_offset, accept_language, s_filter, **kwargs) # noqa: E501 - - @validate_arguments - def sessionhistory_get_list_v1_with_http_info(self, e_order_by : Annotated[Optional[StrictStr], Field(description="Specify how you want the results to be sorted")] = None, i_row_max : Optional[conint(strict=True, le=10000, ge=1)] = None, i_row_offset : Optional[conint(strict=True, ge=0)] = None, accept_language : Optional[HeaderAcceptLanguage] = None, s_filter : Optional[StrictStr] = None, **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve Sessionhistory list # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.sessionhistory_get_list_v1_with_http_info(e_order_by, i_row_max, i_row_offset, accept_language, s_filter, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._sessionhistory_get_list_v1_serialize( + e_order_by=e_order_by, + i_row_max=i_row_max, + i_row_offset=i_row_offset, + accept_language=accept_language, + s_filter=s_filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "SessionhistoryGetListV1Response", + '406': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def sessionhistory_get_list_v1_with_http_info( + self, + e_order_by: Annotated[Optional[StrictStr], Field(description="Specify how you want the results to be sorted")] = None, + i_row_max: Optional[Annotated[int, Field(le=10000, strict=True, ge=1)]] = None, + i_row_offset: Optional[Annotated[int, Field(strict=True, ge=0)]] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + s_filter: Optional[StrictStr] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[SessionhistoryGetListV1Response]: + """Retrieve Sessionhistory list + :param e_order_by: Specify how you want the results to be sorted :type e_order_by: str @@ -104,116 +168,211 @@ def sessionhistory_get_list_v1_with_http_info(self, e_order_by : Annotated[Optio :type accept_language: HeaderAcceptLanguage :param s_filter: :type s_filter: str - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(SessionhistoryGetListV1Response, status_code(int), headers(HTTPHeaderDict)) - """ - - _params = locals() - - _all_params = [ - 'e_order_by', - 'i_row_max', - 'i_row_offset', - 'accept_language', - 's_filter' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' - ] + """ # noqa: E501 + + _param = self._sessionhistory_get_list_v1_serialize( + e_order_by=e_order_by, + i_row_max=i_row_max, + i_row_offset=i_row_offset, + accept_language=accept_language, + s_filter=s_filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method sessionhistory_get_list_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "SessionhistoryGetListV1Response", + '406': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _collection_formats = {} - # process the path parameters - _path_params = {} + @validate_call + def sessionhistory_get_list_v1_without_preload_content( + self, + e_order_by: Annotated[Optional[StrictStr], Field(description="Specify how you want the results to be sorted")] = None, + i_row_max: Optional[Annotated[int, Field(le=10000, strict=True, ge=1)]] = None, + i_row_offset: Optional[Annotated[int, Field(strict=True, ge=0)]] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + s_filter: Optional[StrictStr] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve Sessionhistory list - # process the query parameters - _query_params = [] - if _params.get('e_order_by') is not None: # noqa: E501 - _query_params.append(('eOrderBy', _params['e_order_by'])) - if _params.get('i_row_max') is not None: # noqa: E501 - _query_params.append(('iRowMax', _params['i_row_max'])) + :param e_order_by: Specify how you want the results to be sorted + :type e_order_by: str + :param i_row_max: + :type i_row_max: int + :param i_row_offset: + :type i_row_offset: int + :param accept_language: + :type accept_language: HeaderAcceptLanguage + :param s_filter: + :type s_filter: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._sessionhistory_get_list_v1_serialize( + e_order_by=e_order_by, + i_row_max=i_row_max, + i_row_offset=i_row_offset, + accept_language=accept_language, + s_filter=s_filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "SessionhistoryGetListV1Response", + '406': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - if _params.get('i_row_offset') is not None: # noqa: E501 - _query_params.append(('iRowOffset', _params['i_row_offset'])) - if _params.get('s_filter') is not None: # noqa: E501 - _query_params.append(('sFilter', _params['s_filter'])) + def _sessionhistory_get_list_v1_serialize( + self, + e_order_by, + i_row_max, + i_row_offset, + accept_language, + s_filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: - # process the header parameters - _header_params = dict(_params.get('_headers', {})) - if _params['accept_language']: - _header_params['Accept-Language'] = _params['accept_language'] + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + # process the query parameters + if e_order_by is not None: + + _query_params.append(('eOrderBy', e_order_by)) + + if i_row_max is not None: + + _query_params.append(('iRowMax', i_row_max)) + + if i_row_offset is not None: + + _query_params.append(('iRowOffset', i_row_offset)) + + if s_filter is not None: + + _query_params.append(('sFilter', s_filter)) + + # process the header parameters + if accept_language is not None: + _header_params['Accept-Language'] = accept_language # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet']) # noqa: E501 + [ + 'application/json', + 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "SessionhistoryGetListV1Response", - '406': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/sessionhistory/getList', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/1/object/sessionhistory/getList', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/eZmaxApi/api/object_signature_api.py b/eZmaxApi/api/object_signature_api.py index 7dd24784e..b63cc596e 100644 --- a/eZmaxApi/api/object_signature_api.py +++ b/eZmaxApi/api/object_signature_api.py @@ -13,15 +13,19 @@ """ # noqa: E501 -import re # noqa: F401 import io import warnings -from pydantic import validate_arguments, ValidationError +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Dict, List, Optional, Tuple, Union, Any -from typing_extensions import Annotated -from pydantic import Field, conint +try: + from typing import Annotated +except ImportError: + from typing_extensions import Annotated +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.signature_create_object_v1_request import SignatureCreateObjectV1Request from eZmaxApi.models.signature_create_object_v1_response import SignatureCreateObjectV1Response from eZmaxApi.models.signature_delete_object_v1_response import SignatureDeleteObjectV1Response @@ -31,10 +35,7 @@ from eZmaxApi.api_client import ApiClient from eZmaxApi.api_response import ApiResponse -from eZmaxApi.exceptions import ( # noqa: F401 - ApiTypeError, - ApiValueError -) +from eZmaxApi.rest import RESTResponseType class ObjectSignatureApi: @@ -49,588 +50,1087 @@ def __init__(self, api_client=None) -> None: api_client = ApiClient.get_default() self.api_client = api_client - @validate_arguments - def signature_create_object_v1(self, signature_create_object_v1_request : SignatureCreateObjectV1Request, **kwargs) -> SignatureCreateObjectV1Response: # noqa: E501 - """Create a new Signature # noqa: E501 - The endpoint allows to create one or many elements at once. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def signature_create_object_v1( + self, + signature_create_object_v1_request: SignatureCreateObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> SignatureCreateObjectV1Response: + """Create a new Signature - >>> thread = api.signature_create_object_v1(signature_create_object_v1_request, async_req=True) - >>> result = thread.get() + The endpoint allows to create one or many elements at once. :param signature_create_object_v1_request: (required) :type signature_create_object_v1_request: SignatureCreateObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: SignatureCreateObjectV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the signature_create_object_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.signature_create_object_v1_with_http_info(signature_create_object_v1_request, **kwargs) # noqa: E501 - - @validate_arguments - def signature_create_object_v1_with_http_info(self, signature_create_object_v1_request : SignatureCreateObjectV1Request, **kwargs) -> ApiResponse: # noqa: E501 - """Create a new Signature # noqa: E501 - - The endpoint allows to create one or many elements at once. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.signature_create_object_v1_with_http_info(signature_create_object_v1_request, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._signature_create_object_v1_serialize( + signature_create_object_v1_request=signature_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "SignatureCreateObjectV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def signature_create_object_v1_with_http_info( + self, + signature_create_object_v1_request: SignatureCreateObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[SignatureCreateObjectV1Response]: + """Create a new Signature + + The endpoint allows to create one or many elements at once. :param signature_create_object_v1_request: (required) :type signature_create_object_v1_request: SignatureCreateObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(SignatureCreateObjectV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._signature_create_object_v1_serialize( + signature_create_object_v1_request=signature_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '201': "SignatureCreateObjectV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'signature_create_object_v1_request' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def signature_create_object_v1_without_preload_content( + self, + signature_create_object_v1_request: SignatureCreateObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Create a new Signature + + The endpoint allows to create one or many elements at once. + + :param signature_create_object_v1_request: (required) + :type signature_create_object_v1_request: SignatureCreateObjectV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._signature_create_object_v1_serialize( + signature_create_object_v1_request=signature_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method signature_create_object_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '201': "SignatureCreateObjectV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} + def _signature_create_object_v1_serialize( + self, + signature_create_object_v1_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['signature_create_object_v1_request'] is not None: - _body_params = _params['signature_create_object_v1_request'] + if signature_create_object_v1_request is not None: + _body_params = signature_create_object_v1_request + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '201': "SignatureCreateObjectV1Response", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/signature', 'POST', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='POST', + resource_path='/1/object/signature', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) - @validate_arguments - def signature_delete_object_v1(self, pki_signature_id : Annotated[conint(strict=True, le=16777215, ge=0), Field(..., description="The unique ID of the Signature")], **kwargs) -> SignatureDeleteObjectV1Response: # noqa: E501 - """Delete an existing Signature # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.signature_delete_object_v1(pki_signature_id, async_req=True) - >>> result = thread.get() + + @validate_call + def signature_delete_object_v1( + self, + pki_signature_id: Annotated[int, Field(le=16777215, strict=True, ge=0, description="The unique ID of the Signature")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> SignatureDeleteObjectV1Response: + """Delete an existing Signature + + :param pki_signature_id: The unique ID of the Signature (required) :type pki_signature_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: SignatureDeleteObjectV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the signature_delete_object_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.signature_delete_object_v1_with_http_info(pki_signature_id, **kwargs) # noqa: E501 - - @validate_arguments - def signature_delete_object_v1_with_http_info(self, pki_signature_id : Annotated[conint(strict=True, le=16777215, ge=0), Field(..., description="The unique ID of the Signature")], **kwargs) -> ApiResponse: # noqa: E501 - """Delete an existing Signature # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.signature_delete_object_v1_with_http_info(pki_signature_id, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._signature_delete_object_v1_serialize( + pki_signature_id=pki_signature_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "SignatureDeleteObjectV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def signature_delete_object_v1_with_http_info( + self, + pki_signature_id: Annotated[int, Field(le=16777215, strict=True, ge=0, description="The unique ID of the Signature")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[SignatureDeleteObjectV1Response]: + """Delete an existing Signature + + :param pki_signature_id: The unique ID of the Signature (required) :type pki_signature_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(SignatureDeleteObjectV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._signature_delete_object_v1_serialize( + pki_signature_id=pki_signature_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "SignatureDeleteObjectV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _params = locals() - _all_params = [ - 'pki_signature_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + @validate_call + def signature_delete_object_v1_without_preload_content( + self, + pki_signature_id: Annotated[int, Field(le=16777215, strict=True, ge=0, description="The unique ID of the Signature")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete an existing Signature + + + + :param pki_signature_id: The unique ID of the Signature (required) + :type pki_signature_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._signature_delete_object_v1_serialize( + pki_signature_id=pki_signature_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method signature_delete_object_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "SignatureDeleteObjectV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_signature_id']: - _path_params['pkiSignatureID'] = _params['pki_signature_id'] + def _signature_delete_object_v1_serialize( + self, + pki_signature_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_signature_id is not None: + _path_params['pkiSignatureID'] = pki_signature_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "SignatureDeleteObjectV1Response", - '404': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/signature/{pkiSignatureID}', 'DELETE', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='DELETE', + resource_path='/1/object/signature/{pkiSignatureID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + - @validate_arguments - def signature_edit_object_v1(self, pki_signature_id : Annotated[conint(strict=True, le=16777215, ge=0), Field(..., description="The unique ID of the Signature")], signature_edit_object_v1_request : SignatureEditObjectV1Request, **kwargs) -> SignatureEditObjectV1Response: # noqa: E501 - """Edit an existing Signature # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.signature_edit_object_v1(pki_signature_id, signature_edit_object_v1_request, async_req=True) - >>> result = thread.get() + @validate_call + def signature_edit_object_v1( + self, + pki_signature_id: Annotated[int, Field(le=16777215, strict=True, ge=0, description="The unique ID of the Signature")], + signature_edit_object_v1_request: SignatureEditObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> SignatureEditObjectV1Response: + """Edit an existing Signature + + :param pki_signature_id: The unique ID of the Signature (required) :type pki_signature_id: int :param signature_edit_object_v1_request: (required) :type signature_edit_object_v1_request: SignatureEditObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: SignatureEditObjectV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the signature_edit_object_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.signature_edit_object_v1_with_http_info(pki_signature_id, signature_edit_object_v1_request, **kwargs) # noqa: E501 - - @validate_arguments - def signature_edit_object_v1_with_http_info(self, pki_signature_id : Annotated[conint(strict=True, le=16777215, ge=0), Field(..., description="The unique ID of the Signature")], signature_edit_object_v1_request : SignatureEditObjectV1Request, **kwargs) -> ApiResponse: # noqa: E501 - """Edit an existing Signature # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.signature_edit_object_v1_with_http_info(pki_signature_id, signature_edit_object_v1_request, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._signature_edit_object_v1_serialize( + pki_signature_id=pki_signature_id, + signature_edit_object_v1_request=signature_edit_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "SignatureEditObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def signature_edit_object_v1_with_http_info( + self, + pki_signature_id: Annotated[int, Field(le=16777215, strict=True, ge=0, description="The unique ID of the Signature")], + signature_edit_object_v1_request: SignatureEditObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[SignatureEditObjectV1Response]: + """Edit an existing Signature + + :param pki_signature_id: The unique ID of the Signature (required) :type pki_signature_id: int :param signature_edit_object_v1_request: (required) :type signature_edit_object_v1_request: SignatureEditObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(SignatureEditObjectV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._signature_edit_object_v1_serialize( + pki_signature_id=pki_signature_id, + signature_edit_object_v1_request=signature_edit_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "SignatureEditObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _params = locals() - _all_params = [ - 'pki_signature_id', - 'signature_edit_object_v1_request' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + @validate_call + def signature_edit_object_v1_without_preload_content( + self, + pki_signature_id: Annotated[int, Field(le=16777215, strict=True, ge=0, description="The unique ID of the Signature")], + signature_edit_object_v1_request: SignatureEditObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Edit an existing Signature + + + + :param pki_signature_id: The unique ID of the Signature (required) + :type pki_signature_id: int + :param signature_edit_object_v1_request: (required) + :type signature_edit_object_v1_request: SignatureEditObjectV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._signature_edit_object_v1_serialize( + pki_signature_id=pki_signature_id, + signature_edit_object_v1_request=signature_edit_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method signature_edit_object_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "SignatureEditObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_signature_id']: - _path_params['pkiSignatureID'] = _params['pki_signature_id'] + def _signature_edit_object_v1_serialize( + self, + pki_signature_id, + signature_edit_object_v1_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_signature_id is not None: + _path_params['pkiSignatureID'] = pki_signature_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['signature_edit_object_v1_request'] is not None: - _body_params = _params['signature_edit_object_v1_request'] + if signature_edit_object_v1_request is not None: + _body_params = signature_edit_object_v1_request + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '200': "SignatureEditObjectV1Response", - '404': "CommonResponseError", - '422': "CommonResponseError", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/signature/{pkiSignatureID}', 'PUT', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='PUT', + resource_path='/1/object/signature/{pkiSignatureID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + - @validate_arguments - def signature_get_object_v2(self, pki_signature_id : Annotated[conint(strict=True, le=16777215, ge=0), Field(..., description="The unique ID of the Signature")], **kwargs) -> SignatureGetObjectV2Response: # noqa: E501 - """Retrieve an existing Signature # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.signature_get_object_v2(pki_signature_id, async_req=True) - >>> result = thread.get() + @validate_call + def signature_get_object_v2( + self, + pki_signature_id: Annotated[int, Field(le=16777215, strict=True, ge=0, description="The unique ID of the Signature")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> SignatureGetObjectV2Response: + """Retrieve an existing Signature + + :param pki_signature_id: The unique ID of the Signature (required) :type pki_signature_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: SignatureGetObjectV2Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the signature_get_object_v2_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.signature_get_object_v2_with_http_info(pki_signature_id, **kwargs) # noqa: E501 - - @validate_arguments - def signature_get_object_v2_with_http_info(self, pki_signature_id : Annotated[conint(strict=True, le=16777215, ge=0), Field(..., description="The unique ID of the Signature")], **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve an existing Signature # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.signature_get_object_v2_with_http_info(pki_signature_id, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._signature_get_object_v2_serialize( + pki_signature_id=pki_signature_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "SignatureGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def signature_get_object_v2_with_http_info( + self, + pki_signature_id: Annotated[int, Field(le=16777215, strict=True, ge=0, description="The unique ID of the Signature")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[SignatureGetObjectV2Response]: + """Retrieve an existing Signature + + :param pki_signature_id: The unique ID of the Signature (required) :type pki_signature_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(SignatureGetObjectV2Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._signature_get_object_v2_serialize( + pki_signature_id=pki_signature_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '200': "SignatureGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'pki_signature_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def signature_get_object_v2_without_preload_content( + self, + pki_signature_id: Annotated[int, Field(le=16777215, strict=True, ge=0, description="The unique ID of the Signature")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve an existing Signature + + + + :param pki_signature_id: The unique ID of the Signature (required) + :type pki_signature_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._signature_get_object_v2_serialize( + pki_signature_id=pki_signature_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method signature_get_object_v2" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "SignatureGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_signature_id']: - _path_params['pkiSignatureID'] = _params['pki_signature_id'] + def _signature_get_object_v2_serialize( + self, + pki_signature_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_signature_id is not None: + _path_params['pkiSignatureID'] = pki_signature_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "SignatureGetObjectV2Response", - '404': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/2/object/signature/{pkiSignatureID}', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/2/object/signature/{pkiSignatureID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/eZmaxApi/api/object_subnet_api.py b/eZmaxApi/api/object_subnet_api.py index eff26b969..4d9d4b6ea 100644 --- a/eZmaxApi/api/object_subnet_api.py +++ b/eZmaxApi/api/object_subnet_api.py @@ -13,15 +13,19 @@ """ # noqa: E501 -import re # noqa: F401 import io import warnings -from pydantic import validate_arguments, ValidationError +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Dict, List, Optional, Tuple, Union, Any -from typing_extensions import Annotated -from pydantic import Field, conint +try: + from typing import Annotated +except ImportError: + from typing_extensions import Annotated +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.subnet_create_object_v1_request import SubnetCreateObjectV1Request from eZmaxApi.models.subnet_create_object_v1_response import SubnetCreateObjectV1Response from eZmaxApi.models.subnet_delete_object_v1_response import SubnetDeleteObjectV1Response @@ -31,10 +35,7 @@ from eZmaxApi.api_client import ApiClient from eZmaxApi.api_response import ApiResponse -from eZmaxApi.exceptions import ( # noqa: F401 - ApiTypeError, - ApiValueError -) +from eZmaxApi.rest import RESTResponseType class ObjectSubnetApi: @@ -49,590 +50,1093 @@ def __init__(self, api_client=None) -> None: api_client = ApiClient.get_default() self.api_client = api_client - @validate_arguments - def subnet_create_object_v1(self, subnet_create_object_v1_request : SubnetCreateObjectV1Request, **kwargs) -> SubnetCreateObjectV1Response: # noqa: E501 - """Create a new Subnet # noqa: E501 - The endpoint allows to create one or many elements at once. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def subnet_create_object_v1( + self, + subnet_create_object_v1_request: SubnetCreateObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> SubnetCreateObjectV1Response: + """Create a new Subnet - >>> thread = api.subnet_create_object_v1(subnet_create_object_v1_request, async_req=True) - >>> result = thread.get() + The endpoint allows to create one or many elements at once. :param subnet_create_object_v1_request: (required) :type subnet_create_object_v1_request: SubnetCreateObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: SubnetCreateObjectV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the subnet_create_object_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.subnet_create_object_v1_with_http_info(subnet_create_object_v1_request, **kwargs) # noqa: E501 - - @validate_arguments - def subnet_create_object_v1_with_http_info(self, subnet_create_object_v1_request : SubnetCreateObjectV1Request, **kwargs) -> ApiResponse: # noqa: E501 - """Create a new Subnet # noqa: E501 - - The endpoint allows to create one or many elements at once. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.subnet_create_object_v1_with_http_info(subnet_create_object_v1_request, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._subnet_create_object_v1_serialize( + subnet_create_object_v1_request=subnet_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "SubnetCreateObjectV1Response", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def subnet_create_object_v1_with_http_info( + self, + subnet_create_object_v1_request: SubnetCreateObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[SubnetCreateObjectV1Response]: + """Create a new Subnet + + The endpoint allows to create one or many elements at once. :param subnet_create_object_v1_request: (required) :type subnet_create_object_v1_request: SubnetCreateObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(SubnetCreateObjectV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._subnet_create_object_v1_serialize( + subnet_create_object_v1_request=subnet_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "SubnetCreateObjectV1Response", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _params = locals() - _all_params = [ - 'subnet_create_object_v1_request' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + @validate_call + def subnet_create_object_v1_without_preload_content( + self, + subnet_create_object_v1_request: SubnetCreateObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Create a new Subnet + + The endpoint allows to create one or many elements at once. + + :param subnet_create_object_v1_request: (required) + :type subnet_create_object_v1_request: SubnetCreateObjectV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._subnet_create_object_v1_serialize( + subnet_create_object_v1_request=subnet_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method subnet_create_object_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '201': "SubnetCreateObjectV1Response", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} + def _subnet_create_object_v1_serialize( + self, + subnet_create_object_v1_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['subnet_create_object_v1_request'] is not None: - _body_params = _params['subnet_create_object_v1_request'] + if subnet_create_object_v1_request is not None: + _body_params = subnet_create_object_v1_request + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '201': "SubnetCreateObjectV1Response", - '422': "CommonResponseError", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/subnet', 'POST', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='POST', + resource_path='/1/object/subnet', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + - @validate_arguments - def subnet_delete_object_v1(self, pki_subnet_id : Annotated[conint(strict=True, le=65535, ge=0), Field(..., description="The unique ID of the Subnet")], **kwargs) -> SubnetDeleteObjectV1Response: # noqa: E501 - """Delete an existing Subnet # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.subnet_delete_object_v1(pki_subnet_id, async_req=True) - >>> result = thread.get() + @validate_call + def subnet_delete_object_v1( + self, + pki_subnet_id: Annotated[int, Field(le=65535, strict=True, ge=0, description="The unique ID of the Subnet")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> SubnetDeleteObjectV1Response: + """Delete an existing Subnet + + :param pki_subnet_id: The unique ID of the Subnet (required) :type pki_subnet_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: SubnetDeleteObjectV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the subnet_delete_object_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.subnet_delete_object_v1_with_http_info(pki_subnet_id, **kwargs) # noqa: E501 - - @validate_arguments - def subnet_delete_object_v1_with_http_info(self, pki_subnet_id : Annotated[conint(strict=True, le=65535, ge=0), Field(..., description="The unique ID of the Subnet")], **kwargs) -> ApiResponse: # noqa: E501 - """Delete an existing Subnet # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.subnet_delete_object_v1_with_http_info(pki_subnet_id, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._subnet_delete_object_v1_serialize( + pki_subnet_id=pki_subnet_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "SubnetDeleteObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def subnet_delete_object_v1_with_http_info( + self, + pki_subnet_id: Annotated[int, Field(le=65535, strict=True, ge=0, description="The unique ID of the Subnet")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[SubnetDeleteObjectV1Response]: + """Delete an existing Subnet + + :param pki_subnet_id: The unique ID of the Subnet (required) :type pki_subnet_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(SubnetDeleteObjectV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._subnet_delete_object_v1_serialize( + pki_subnet_id=pki_subnet_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '200': "SubnetDeleteObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'pki_subnet_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def subnet_delete_object_v1_without_preload_content( + self, + pki_subnet_id: Annotated[int, Field(le=65535, strict=True, ge=0, description="The unique ID of the Subnet")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete an existing Subnet + + + + :param pki_subnet_id: The unique ID of the Subnet (required) + :type pki_subnet_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._subnet_delete_object_v1_serialize( + pki_subnet_id=pki_subnet_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method subnet_delete_object_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "SubnetDeleteObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_subnet_id']: - _path_params['pkiSubnetID'] = _params['pki_subnet_id'] + def _subnet_delete_object_v1_serialize( + self, + pki_subnet_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_subnet_id is not None: + _path_params['pkiSubnetID'] = pki_subnet_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "SubnetDeleteObjectV1Response", - '404': "CommonResponseError", - '422': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/subnet/{pkiSubnetID}', 'DELETE', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='DELETE', + resource_path='/1/object/subnet/{pkiSubnetID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) - @validate_arguments - def subnet_edit_object_v1(self, pki_subnet_id : Annotated[conint(strict=True, le=65535, ge=0), Field(..., description="The unique ID of the Subnet")], subnet_edit_object_v1_request : SubnetEditObjectV1Request, **kwargs) -> SubnetEditObjectV1Response: # noqa: E501 - """Edit an existing Subnet # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.subnet_edit_object_v1(pki_subnet_id, subnet_edit_object_v1_request, async_req=True) - >>> result = thread.get() + + @validate_call + def subnet_edit_object_v1( + self, + pki_subnet_id: Annotated[int, Field(le=65535, strict=True, ge=0, description="The unique ID of the Subnet")], + subnet_edit_object_v1_request: SubnetEditObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> SubnetEditObjectV1Response: + """Edit an existing Subnet + + :param pki_subnet_id: The unique ID of the Subnet (required) :type pki_subnet_id: int :param subnet_edit_object_v1_request: (required) :type subnet_edit_object_v1_request: SubnetEditObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: SubnetEditObjectV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the subnet_edit_object_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.subnet_edit_object_v1_with_http_info(pki_subnet_id, subnet_edit_object_v1_request, **kwargs) # noqa: E501 - - @validate_arguments - def subnet_edit_object_v1_with_http_info(self, pki_subnet_id : Annotated[conint(strict=True, le=65535, ge=0), Field(..., description="The unique ID of the Subnet")], subnet_edit_object_v1_request : SubnetEditObjectV1Request, **kwargs) -> ApiResponse: # noqa: E501 - """Edit an existing Subnet # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.subnet_edit_object_v1_with_http_info(pki_subnet_id, subnet_edit_object_v1_request, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._subnet_edit_object_v1_serialize( + pki_subnet_id=pki_subnet_id, + subnet_edit_object_v1_request=subnet_edit_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "SubnetEditObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def subnet_edit_object_v1_with_http_info( + self, + pki_subnet_id: Annotated[int, Field(le=65535, strict=True, ge=0, description="The unique ID of the Subnet")], + subnet_edit_object_v1_request: SubnetEditObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[SubnetEditObjectV1Response]: + """Edit an existing Subnet + + :param pki_subnet_id: The unique ID of the Subnet (required) :type pki_subnet_id: int :param subnet_edit_object_v1_request: (required) :type subnet_edit_object_v1_request: SubnetEditObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(SubnetEditObjectV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._subnet_edit_object_v1_serialize( + pki_subnet_id=pki_subnet_id, + subnet_edit_object_v1_request=subnet_edit_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "SubnetEditObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _params = locals() - _all_params = [ - 'pki_subnet_id', - 'subnet_edit_object_v1_request' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + @validate_call + def subnet_edit_object_v1_without_preload_content( + self, + pki_subnet_id: Annotated[int, Field(le=65535, strict=True, ge=0, description="The unique ID of the Subnet")], + subnet_edit_object_v1_request: SubnetEditObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Edit an existing Subnet + + + + :param pki_subnet_id: The unique ID of the Subnet (required) + :type pki_subnet_id: int + :param subnet_edit_object_v1_request: (required) + :type subnet_edit_object_v1_request: SubnetEditObjectV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._subnet_edit_object_v1_serialize( + pki_subnet_id=pki_subnet_id, + subnet_edit_object_v1_request=subnet_edit_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method subnet_edit_object_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "SubnetEditObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_subnet_id']: - _path_params['pkiSubnetID'] = _params['pki_subnet_id'] + def _subnet_edit_object_v1_serialize( + self, + pki_subnet_id, + subnet_edit_object_v1_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if pki_subnet_id is not None: + _path_params['pkiSubnetID'] = pki_subnet_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['subnet_edit_object_v1_request'] is not None: - _body_params = _params['subnet_edit_object_v1_request'] + if subnet_edit_object_v1_request is not None: + _body_params = subnet_edit_object_v1_request + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '200': "SubnetEditObjectV1Response", - '404': "CommonResponseError", - '422': "CommonResponseError", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/subnet/{pkiSubnetID}', 'PUT', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='PUT', + resource_path='/1/object/subnet/{pkiSubnetID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) - @validate_arguments - def subnet_get_object_v2(self, pki_subnet_id : Annotated[conint(strict=True, le=65535, ge=0), Field(..., description="The unique ID of the Subnet")], **kwargs) -> SubnetGetObjectV2Response: # noqa: E501 - """Retrieve an existing Subnet # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.subnet_get_object_v2(pki_subnet_id, async_req=True) - >>> result = thread.get() + + @validate_call + def subnet_get_object_v2( + self, + pki_subnet_id: Annotated[int, Field(le=65535, strict=True, ge=0, description="The unique ID of the Subnet")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> SubnetGetObjectV2Response: + """Retrieve an existing Subnet + + :param pki_subnet_id: The unique ID of the Subnet (required) :type pki_subnet_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: SubnetGetObjectV2Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the subnet_get_object_v2_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.subnet_get_object_v2_with_http_info(pki_subnet_id, **kwargs) # noqa: E501 - - @validate_arguments - def subnet_get_object_v2_with_http_info(self, pki_subnet_id : Annotated[conint(strict=True, le=65535, ge=0), Field(..., description="The unique ID of the Subnet")], **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve an existing Subnet # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.subnet_get_object_v2_with_http_info(pki_subnet_id, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._subnet_get_object_v2_serialize( + pki_subnet_id=pki_subnet_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "SubnetGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def subnet_get_object_v2_with_http_info( + self, + pki_subnet_id: Annotated[int, Field(le=65535, strict=True, ge=0, description="The unique ID of the Subnet")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[SubnetGetObjectV2Response]: + """Retrieve an existing Subnet + + :param pki_subnet_id: The unique ID of the Subnet (required) :type pki_subnet_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(SubnetGetObjectV2Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._subnet_get_object_v2_serialize( + pki_subnet_id=pki_subnet_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "SubnetGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _params = locals() - _all_params = [ - 'pki_subnet_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + @validate_call + def subnet_get_object_v2_without_preload_content( + self, + pki_subnet_id: Annotated[int, Field(le=65535, strict=True, ge=0, description="The unique ID of the Subnet")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve an existing Subnet + + + + :param pki_subnet_id: The unique ID of the Subnet (required) + :type pki_subnet_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._subnet_get_object_v2_serialize( + pki_subnet_id=pki_subnet_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method subnet_get_object_v2" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "SubnetGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_subnet_id']: - _path_params['pkiSubnetID'] = _params['pki_subnet_id'] + def _subnet_get_object_v2_serialize( + self, + pki_subnet_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if pki_subnet_id is not None: + _path_params['pkiSubnetID'] = pki_subnet_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "SubnetGetObjectV2Response", - '404': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/2/object/subnet/{pkiSubnetID}', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/2/object/subnet/{pkiSubnetID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/eZmaxApi/api/object_systemconfiguration_api.py b/eZmaxApi/api/object_systemconfiguration_api.py index 5647d212d..75594ab66 100644 --- a/eZmaxApi/api/object_systemconfiguration_api.py +++ b/eZmaxApi/api/object_systemconfiguration_api.py @@ -13,25 +13,26 @@ """ # noqa: E501 -import re # noqa: F401 import io import warnings -from pydantic import validate_arguments, ValidationError +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Dict, List, Optional, Tuple, Union, Any -from typing_extensions import Annotated -from pydantic import Field, conint +try: + from typing import Annotated +except ImportError: + from typing_extensions import Annotated +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.systemconfiguration_edit_object_v1_request import SystemconfigurationEditObjectV1Request from eZmaxApi.models.systemconfiguration_edit_object_v1_response import SystemconfigurationEditObjectV1Response from eZmaxApi.models.systemconfiguration_get_object_v2_response import SystemconfigurationGetObjectV2Response from eZmaxApi.api_client import ApiClient from eZmaxApi.api_response import ApiResponse -from eZmaxApi.exceptions import ( # noqa: F401 - ApiTypeError, - ApiValueError -) +from eZmaxApi.rest import RESTResponseType class ObjectSystemconfigurationApi: @@ -46,300 +47,555 @@ def __init__(self, api_client=None) -> None: api_client = ApiClient.get_default() self.api_client = api_client - @validate_arguments - def systemconfiguration_edit_object_v1(self, pki_systemconfiguration_id : Annotated[conint(strict=True, le=1, ge=1), Field(..., description="The unique ID of the Systemconfiguration")], systemconfiguration_edit_object_v1_request : SystemconfigurationEditObjectV1Request, **kwargs) -> SystemconfigurationEditObjectV1Response: # noqa: E501 - """Edit an existing Systemconfiguration # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def systemconfiguration_edit_object_v1( + self, + pki_systemconfiguration_id: Annotated[int, Field(le=1, strict=True, ge=1, description="The unique ID of the Systemconfiguration")], + systemconfiguration_edit_object_v1_request: SystemconfigurationEditObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> SystemconfigurationEditObjectV1Response: + """Edit an existing Systemconfiguration - >>> thread = api.systemconfiguration_edit_object_v1(pki_systemconfiguration_id, systemconfiguration_edit_object_v1_request, async_req=True) - >>> result = thread.get() + :param pki_systemconfiguration_id: The unique ID of the Systemconfiguration (required) :type pki_systemconfiguration_id: int :param systemconfiguration_edit_object_v1_request: (required) :type systemconfiguration_edit_object_v1_request: SystemconfigurationEditObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: SystemconfigurationEditObjectV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the systemconfiguration_edit_object_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.systemconfiguration_edit_object_v1_with_http_info(pki_systemconfiguration_id, systemconfiguration_edit_object_v1_request, **kwargs) # noqa: E501 - - @validate_arguments - def systemconfiguration_edit_object_v1_with_http_info(self, pki_systemconfiguration_id : Annotated[conint(strict=True, le=1, ge=1), Field(..., description="The unique ID of the Systemconfiguration")], systemconfiguration_edit_object_v1_request : SystemconfigurationEditObjectV1Request, **kwargs) -> ApiResponse: # noqa: E501 - """Edit an existing Systemconfiguration # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.systemconfiguration_edit_object_v1_with_http_info(pki_systemconfiguration_id, systemconfiguration_edit_object_v1_request, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._systemconfiguration_edit_object_v1_serialize( + pki_systemconfiguration_id=pki_systemconfiguration_id, + systemconfiguration_edit_object_v1_request=systemconfiguration_edit_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "SystemconfigurationEditObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def systemconfiguration_edit_object_v1_with_http_info( + self, + pki_systemconfiguration_id: Annotated[int, Field(le=1, strict=True, ge=1, description="The unique ID of the Systemconfiguration")], + systemconfiguration_edit_object_v1_request: SystemconfigurationEditObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[SystemconfigurationEditObjectV1Response]: + """Edit an existing Systemconfiguration + + :param pki_systemconfiguration_id: The unique ID of the Systemconfiguration (required) :type pki_systemconfiguration_id: int :param systemconfiguration_edit_object_v1_request: (required) :type systemconfiguration_edit_object_v1_request: SystemconfigurationEditObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(SystemconfigurationEditObjectV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._systemconfiguration_edit_object_v1_serialize( + pki_systemconfiguration_id=pki_systemconfiguration_id, + systemconfiguration_edit_object_v1_request=systemconfiguration_edit_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "SystemconfigurationEditObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _params = locals() - _all_params = [ - 'pki_systemconfiguration_id', - 'systemconfiguration_edit_object_v1_request' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + @validate_call + def systemconfiguration_edit_object_v1_without_preload_content( + self, + pki_systemconfiguration_id: Annotated[int, Field(le=1, strict=True, ge=1, description="The unique ID of the Systemconfiguration")], + systemconfiguration_edit_object_v1_request: SystemconfigurationEditObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Edit an existing Systemconfiguration + + + + :param pki_systemconfiguration_id: The unique ID of the Systemconfiguration (required) + :type pki_systemconfiguration_id: int + :param systemconfiguration_edit_object_v1_request: (required) + :type systemconfiguration_edit_object_v1_request: SystemconfigurationEditObjectV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._systemconfiguration_edit_object_v1_serialize( + pki_systemconfiguration_id=pki_systemconfiguration_id, + systemconfiguration_edit_object_v1_request=systemconfiguration_edit_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method systemconfiguration_edit_object_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "SystemconfigurationEditObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_systemconfiguration_id']: - _path_params['pkiSystemconfigurationID'] = _params['pki_systemconfiguration_id'] + def _systemconfiguration_edit_object_v1_serialize( + self, + pki_systemconfiguration_id, + systemconfiguration_edit_object_v1_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_systemconfiguration_id is not None: + _path_params['pkiSystemconfigurationID'] = pki_systemconfiguration_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['systemconfiguration_edit_object_v1_request'] is not None: - _body_params = _params['systemconfiguration_edit_object_v1_request'] + if systemconfiguration_edit_object_v1_request is not None: + _body_params = systemconfiguration_edit_object_v1_request + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '200': "SystemconfigurationEditObjectV1Response", - '404': "CommonResponseError", - '422': "CommonResponseError", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/systemconfiguration/{pkiSystemconfigurationID}', 'PUT', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='PUT', + resource_path='/1/object/systemconfiguration/{pkiSystemconfigurationID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + - @validate_arguments - def systemconfiguration_get_object_v2(self, pki_systemconfiguration_id : Annotated[conint(strict=True, le=1, ge=1), Field(..., description="The unique ID of the Systemconfiguration")], **kwargs) -> SystemconfigurationGetObjectV2Response: # noqa: E501 - """Retrieve an existing Systemconfiguration # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.systemconfiguration_get_object_v2(pki_systemconfiguration_id, async_req=True) - >>> result = thread.get() + @validate_call + def systemconfiguration_get_object_v2( + self, + pki_systemconfiguration_id: Annotated[int, Field(le=1, strict=True, ge=1, description="The unique ID of the Systemconfiguration")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> SystemconfigurationGetObjectV2Response: + """Retrieve an existing Systemconfiguration + + :param pki_systemconfiguration_id: The unique ID of the Systemconfiguration (required) :type pki_systemconfiguration_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: SystemconfigurationGetObjectV2Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the systemconfiguration_get_object_v2_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.systemconfiguration_get_object_v2_with_http_info(pki_systemconfiguration_id, **kwargs) # noqa: E501 - - @validate_arguments - def systemconfiguration_get_object_v2_with_http_info(self, pki_systemconfiguration_id : Annotated[conint(strict=True, le=1, ge=1), Field(..., description="The unique ID of the Systemconfiguration")], **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve an existing Systemconfiguration # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.systemconfiguration_get_object_v2_with_http_info(pki_systemconfiguration_id, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._systemconfiguration_get_object_v2_serialize( + pki_systemconfiguration_id=pki_systemconfiguration_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "SystemconfigurationGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def systemconfiguration_get_object_v2_with_http_info( + self, + pki_systemconfiguration_id: Annotated[int, Field(le=1, strict=True, ge=1, description="The unique ID of the Systemconfiguration")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[SystemconfigurationGetObjectV2Response]: + """Retrieve an existing Systemconfiguration + + :param pki_systemconfiguration_id: The unique ID of the Systemconfiguration (required) :type pki_systemconfiguration_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(SystemconfigurationGetObjectV2Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._systemconfiguration_get_object_v2_serialize( + pki_systemconfiguration_id=pki_systemconfiguration_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "SystemconfigurationGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _params = locals() - _all_params = [ - 'pki_systemconfiguration_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + @validate_call + def systemconfiguration_get_object_v2_without_preload_content( + self, + pki_systemconfiguration_id: Annotated[int, Field(le=1, strict=True, ge=1, description="The unique ID of the Systemconfiguration")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve an existing Systemconfiguration + + + + :param pki_systemconfiguration_id: The unique ID of the Systemconfiguration (required) + :type pki_systemconfiguration_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._systemconfiguration_get_object_v2_serialize( + pki_systemconfiguration_id=pki_systemconfiguration_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method systemconfiguration_get_object_v2" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "SystemconfigurationGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_systemconfiguration_id']: - _path_params['pkiSystemconfigurationID'] = _params['pki_systemconfiguration_id'] + def _systemconfiguration_get_object_v2_serialize( + self, + pki_systemconfiguration_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if pki_systemconfiguration_id is not None: + _path_params['pkiSystemconfigurationID'] = pki_systemconfiguration_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "SystemconfigurationGetObjectV2Response", - '404': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/2/object/systemconfiguration/{pkiSystemconfigurationID}', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/2/object/systemconfiguration/{pkiSystemconfigurationID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/eZmaxApi/api/object_taxassignment_api.py b/eZmaxApi/api/object_taxassignment_api.py index 7164ed79d..b8d2c310b 100644 --- a/eZmaxApi/api/object_taxassignment_api.py +++ b/eZmaxApi/api/object_taxassignment_api.py @@ -13,14 +13,20 @@ """ # noqa: E501 -import re # noqa: F401 import io import warnings -from pydantic import validate_arguments, ValidationError +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Dict, List, Optional, Tuple, Union, Any +try: + from typing import Annotated +except ImportError: + from typing_extensions import Annotated + +from pydantic import Field from typing_extensions import Annotated -from pydantic import Field, StrictStr +from pydantic import StrictStr, field_validator from typing import Optional @@ -29,10 +35,7 @@ from eZmaxApi.api_client import ApiClient from eZmaxApi.api_response import ApiResponse -from eZmaxApi.exceptions import ( # noqa: F401 - ApiTypeError, - ApiValueError -) +from eZmaxApi.rest import RESTResponseType class ObjectTaxassignmentApi: @@ -47,16 +50,30 @@ def __init__(self, api_client=None) -> None: api_client = ApiClient.get_default() self.api_client = api_client - @validate_arguments - def taxassignment_get_autocomplete_v2(self, s_selector : Annotated[StrictStr, Field(..., description="The type of Taxassignments to return")], e_filter_active : Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, s_query : Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, accept_language : Optional[HeaderAcceptLanguage] = None, **kwargs) -> TaxassignmentGetAutocompleteV2Response: # noqa: E501 - """Retrieve Taxassignments and IDs # noqa: E501 - Get the list of Taxassignment to be used in a dropdown or autocomplete control. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def taxassignment_get_autocomplete_v2( + self, + s_selector: Annotated[StrictStr, Field(description="The type of Taxassignments to return")], + e_filter_active: Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, + s_query: Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> TaxassignmentGetAutocompleteV2Response: + """Retrieve Taxassignments and IDs - >>> thread = api.taxassignment_get_autocomplete_v2(s_selector, e_filter_active, s_query, accept_language, async_req=True) - >>> result = thread.get() + Get the list of Taxassignment to be used in a dropdown or autocomplete control. :param s_selector: The type of Taxassignments to return (required) :type s_selector: str @@ -66,33 +83,76 @@ def taxassignment_get_autocomplete_v2(self, s_selector : Annotated[StrictStr, Fi :type s_query: str :param accept_language: :type accept_language: HeaderAcceptLanguage - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: TaxassignmentGetAutocompleteV2Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the taxassignment_get_autocomplete_v2_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.taxassignment_get_autocomplete_v2_with_http_info(s_selector, e_filter_active, s_query, accept_language, **kwargs) # noqa: E501 - - @validate_arguments - def taxassignment_get_autocomplete_v2_with_http_info(self, s_selector : Annotated[StrictStr, Field(..., description="The type of Taxassignments to return")], e_filter_active : Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, s_query : Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, accept_language : Optional[HeaderAcceptLanguage] = None, **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve Taxassignments and IDs # noqa: E501 - - Get the list of Taxassignment to be used in a dropdown or autocomplete control. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.taxassignment_get_autocomplete_v2_with_http_info(s_selector, e_filter_active, s_query, accept_language, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._taxassignment_get_autocomplete_v2_serialize( + s_selector=s_selector, + e_filter_active=e_filter_active, + s_query=s_query, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "TaxassignmentGetAutocompleteV2Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def taxassignment_get_autocomplete_v2_with_http_info( + self, + s_selector: Annotated[StrictStr, Field(description="The type of Taxassignments to return")], + e_filter_active: Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, + s_query: Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[TaxassignmentGetAutocompleteV2Response]: + """Retrieve Taxassignments and IDs + + Get the list of Taxassignment to be used in a dropdown or autocomplete control. :param s_selector: The type of Taxassignments to return (required) :type s_selector: str @@ -102,111 +162,197 @@ def taxassignment_get_autocomplete_v2_with_http_info(self, s_selector : Annotate :type s_query: str :param accept_language: :type accept_language: HeaderAcceptLanguage - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(TaxassignmentGetAutocompleteV2Response, status_code(int), headers(HTTPHeaderDict)) - """ - - _params = locals() - - _all_params = [ - 's_selector', - 'e_filter_active', - 's_query', - 'accept_language' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + """ # noqa: E501 + + _param = self._taxassignment_get_autocomplete_v2_serialize( + s_selector=s_selector, + e_filter_active=e_filter_active, + s_query=s_query, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "TaxassignmentGetAutocompleteV2Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def taxassignment_get_autocomplete_v2_without_preload_content( + self, + s_selector: Annotated[StrictStr, Field(description="The type of Taxassignments to return")], + e_filter_active: Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, + s_query: Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve Taxassignments and IDs + + Get the list of Taxassignment to be used in a dropdown or autocomplete control. + + :param s_selector: The type of Taxassignments to return (required) + :type s_selector: str + :param e_filter_active: Specify which results we want to display. + :type e_filter_active: str + :param s_query: Allow to filter the returned results + :type s_query: str + :param accept_language: + :type accept_language: HeaderAcceptLanguage + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._taxassignment_get_autocomplete_v2_serialize( + s_selector=s_selector, + e_filter_active=e_filter_active, + s_query=s_query, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method taxassignment_get_autocomplete_v2" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "TaxassignmentGetAutocompleteV2Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['s_selector']: - _path_params['sSelector'] = _params['s_selector'] + def _taxassignment_get_autocomplete_v2_serialize( + self, + s_selector, + e_filter_active, + s_query, + accept_language, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None - # process the query parameters - _query_params = [] - if _params.get('e_filter_active') is not None: # noqa: E501 - _query_params.append(('eFilterActive', _params['e_filter_active'])) + _collection_formats: Dict[str, str] = { + } - if _params.get('s_query') is not None: # noqa: E501 - _query_params.append(('sQuery', _params['s_query'])) + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if s_selector is not None: + _path_params['sSelector'] = s_selector + # process the query parameters + if e_filter_active is not None: + + _query_params.append(('eFilterActive', e_filter_active)) + + if s_query is not None: + + _query_params.append(('sQuery', s_query)) + # process the header parameters - _header_params = dict(_params.get('_headers', {})) - if _params['accept_language']: - _header_params['Accept-Language'] = _params['accept_language'] - + if accept_language is not None: + _header_params['Accept-Language'] = accept_language # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "TaxassignmentGetAutocompleteV2Response", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/2/object/taxassignment/getAutocomplete/{sSelector}', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/2/object/taxassignment/getAutocomplete/{sSelector}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/eZmaxApi/api/object_timezone_api.py b/eZmaxApi/api/object_timezone_api.py index 9f85a037a..8300269cb 100644 --- a/eZmaxApi/api/object_timezone_api.py +++ b/eZmaxApi/api/object_timezone_api.py @@ -13,14 +13,20 @@ """ # noqa: E501 -import re # noqa: F401 import io import warnings -from pydantic import validate_arguments, ValidationError +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Dict, List, Optional, Tuple, Union, Any +try: + from typing import Annotated +except ImportError: + from typing_extensions import Annotated + +from pydantic import Field from typing_extensions import Annotated -from pydantic import Field, StrictStr +from pydantic import StrictStr, field_validator from typing import Optional @@ -29,10 +35,7 @@ from eZmaxApi.api_client import ApiClient from eZmaxApi.api_response import ApiResponse -from eZmaxApi.exceptions import ( # noqa: F401 - ApiTypeError, - ApiValueError -) +from eZmaxApi.rest import RESTResponseType class ObjectTimezoneApi: @@ -47,16 +50,30 @@ def __init__(self, api_client=None) -> None: api_client = ApiClient.get_default() self.api_client = api_client - @validate_arguments - def timezone_get_autocomplete_v2(self, s_selector : Annotated[StrictStr, Field(..., description="The type of Timezones to return")], e_filter_active : Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, s_query : Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, accept_language : Optional[HeaderAcceptLanguage] = None, **kwargs) -> TimezoneGetAutocompleteV2Response: # noqa: E501 - """Retrieve Timezones and IDs # noqa: E501 - Get the list of Timezone to be used in a dropdown or autocomplete control. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def timezone_get_autocomplete_v2( + self, + s_selector: Annotated[StrictStr, Field(description="The type of Timezones to return")], + e_filter_active: Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, + s_query: Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> TimezoneGetAutocompleteV2Response: + """Retrieve Timezones and IDs - >>> thread = api.timezone_get_autocomplete_v2(s_selector, e_filter_active, s_query, accept_language, async_req=True) - >>> result = thread.get() + Get the list of Timezone to be used in a dropdown or autocomplete control. :param s_selector: The type of Timezones to return (required) :type s_selector: str @@ -66,33 +83,76 @@ def timezone_get_autocomplete_v2(self, s_selector : Annotated[StrictStr, Field(. :type s_query: str :param accept_language: :type accept_language: HeaderAcceptLanguage - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: TimezoneGetAutocompleteV2Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the timezone_get_autocomplete_v2_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.timezone_get_autocomplete_v2_with_http_info(s_selector, e_filter_active, s_query, accept_language, **kwargs) # noqa: E501 - - @validate_arguments - def timezone_get_autocomplete_v2_with_http_info(self, s_selector : Annotated[StrictStr, Field(..., description="The type of Timezones to return")], e_filter_active : Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, s_query : Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, accept_language : Optional[HeaderAcceptLanguage] = None, **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve Timezones and IDs # noqa: E501 - - Get the list of Timezone to be used in a dropdown or autocomplete control. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.timezone_get_autocomplete_v2_with_http_info(s_selector, e_filter_active, s_query, accept_language, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._timezone_get_autocomplete_v2_serialize( + s_selector=s_selector, + e_filter_active=e_filter_active, + s_query=s_query, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "TimezoneGetAutocompleteV2Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def timezone_get_autocomplete_v2_with_http_info( + self, + s_selector: Annotated[StrictStr, Field(description="The type of Timezones to return")], + e_filter_active: Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, + s_query: Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[TimezoneGetAutocompleteV2Response]: + """Retrieve Timezones and IDs + + Get the list of Timezone to be used in a dropdown or autocomplete control. :param s_selector: The type of Timezones to return (required) :type s_selector: str @@ -102,111 +162,197 @@ def timezone_get_autocomplete_v2_with_http_info(self, s_selector : Annotated[Str :type s_query: str :param accept_language: :type accept_language: HeaderAcceptLanguage - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(TimezoneGetAutocompleteV2Response, status_code(int), headers(HTTPHeaderDict)) - """ - - _params = locals() - - _all_params = [ - 's_selector', - 'e_filter_active', - 's_query', - 'accept_language' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + """ # noqa: E501 + + _param = self._timezone_get_autocomplete_v2_serialize( + s_selector=s_selector, + e_filter_active=e_filter_active, + s_query=s_query, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "TimezoneGetAutocompleteV2Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def timezone_get_autocomplete_v2_without_preload_content( + self, + s_selector: Annotated[StrictStr, Field(description="The type of Timezones to return")], + e_filter_active: Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, + s_query: Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve Timezones and IDs + + Get the list of Timezone to be used in a dropdown or autocomplete control. + + :param s_selector: The type of Timezones to return (required) + :type s_selector: str + :param e_filter_active: Specify which results we want to display. + :type e_filter_active: str + :param s_query: Allow to filter the returned results + :type s_query: str + :param accept_language: + :type accept_language: HeaderAcceptLanguage + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._timezone_get_autocomplete_v2_serialize( + s_selector=s_selector, + e_filter_active=e_filter_active, + s_query=s_query, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method timezone_get_autocomplete_v2" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "TimezoneGetAutocompleteV2Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['s_selector']: - _path_params['sSelector'] = _params['s_selector'] + def _timezone_get_autocomplete_v2_serialize( + self, + s_selector, + e_filter_active, + s_query, + accept_language, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None - # process the query parameters - _query_params = [] - if _params.get('e_filter_active') is not None: # noqa: E501 - _query_params.append(('eFilterActive', _params['e_filter_active'])) + _collection_formats: Dict[str, str] = { + } - if _params.get('s_query') is not None: # noqa: E501 - _query_params.append(('sQuery', _params['s_query'])) + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if s_selector is not None: + _path_params['sSelector'] = s_selector + # process the query parameters + if e_filter_active is not None: + + _query_params.append(('eFilterActive', e_filter_active)) + + if s_query is not None: + + _query_params.append(('sQuery', s_query)) + # process the header parameters - _header_params = dict(_params.get('_headers', {})) - if _params['accept_language']: - _header_params['Accept-Language'] = _params['accept_language'] - + if accept_language is not None: + _header_params['Accept-Language'] = accept_language # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "TimezoneGetAutocompleteV2Response", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/2/object/timezone/getAutocomplete/{sSelector}', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/2/object/timezone/getAutocomplete/{sSelector}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/eZmaxApi/api/object_user_api.py b/eZmaxApi/api/object_user_api.py index 99d7cf2ad..02f5a348e 100644 --- a/eZmaxApi/api/object_user_api.py +++ b/eZmaxApi/api/object_user_api.py @@ -13,14 +13,20 @@ """ # noqa: E501 -import re # noqa: F401 import io import warnings -from pydantic import validate_arguments, ValidationError +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Dict, List, Optional, Tuple, Union, Any +try: + from typing import Annotated +except ImportError: + from typing_extensions import Annotated + +from pydantic import Field from typing_extensions import Annotated -from pydantic import Field, StrictStr, conint +from pydantic import StrictStr, field_validator from typing import Any, Dict, Optional @@ -42,10 +48,7 @@ from eZmaxApi.api_client import ApiClient from eZmaxApi.api_response import ApiResponse -from eZmaxApi.exceptions import ( # noqa: F401 - ApiTypeError, - ApiValueError -) +from eZmaxApi.rest import RESTResponseType class ObjectUserApi: @@ -60,616 +63,1143 @@ def __init__(self, api_client=None) -> None: api_client = ApiClient.get_default() self.api_client = api_client - @validate_arguments - def user_create_object_v1(self, user_create_object_v1_request : UserCreateObjectV1Request, **kwargs) -> UserCreateObjectV1Response: # noqa: E501 - """Create a new User # noqa: E501 - The endpoint allows to create one or many elements at once. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def user_create_object_v1( + self, + user_create_object_v1_request: UserCreateObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> UserCreateObjectV1Response: + """Create a new User - >>> thread = api.user_create_object_v1(user_create_object_v1_request, async_req=True) - >>> result = thread.get() + The endpoint allows to create one or many elements at once. :param user_create_object_v1_request: (required) :type user_create_object_v1_request: UserCreateObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: UserCreateObjectV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the user_create_object_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.user_create_object_v1_with_http_info(user_create_object_v1_request, **kwargs) # noqa: E501 - - @validate_arguments - def user_create_object_v1_with_http_info(self, user_create_object_v1_request : UserCreateObjectV1Request, **kwargs) -> ApiResponse: # noqa: E501 - """Create a new User # noqa: E501 - - The endpoint allows to create one or many elements at once. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.user_create_object_v1_with_http_info(user_create_object_v1_request, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._user_create_object_v1_serialize( + user_create_object_v1_request=user_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "UserCreateObjectV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def user_create_object_v1_with_http_info( + self, + user_create_object_v1_request: UserCreateObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[UserCreateObjectV1Response]: + """Create a new User + + The endpoint allows to create one or many elements at once. :param user_create_object_v1_request: (required) :type user_create_object_v1_request: UserCreateObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(UserCreateObjectV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._user_create_object_v1_serialize( + user_create_object_v1_request=user_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '201': "UserCreateObjectV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'user_create_object_v1_request' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def user_create_object_v1_without_preload_content( + self, + user_create_object_v1_request: UserCreateObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Create a new User + + The endpoint allows to create one or many elements at once. + + :param user_create_object_v1_request: (required) + :type user_create_object_v1_request: UserCreateObjectV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._user_create_object_v1_serialize( + user_create_object_v1_request=user_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method user_create_object_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '201': "UserCreateObjectV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} + def _user_create_object_v1_serialize( + self, + user_create_object_v1_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['user_create_object_v1_request'] is not None: - _body_params = _params['user_create_object_v1_request'] + if user_create_object_v1_request is not None: + _body_params = user_create_object_v1_request + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '201': "UserCreateObjectV1Response", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/user', 'POST', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='POST', + resource_path='/1/object/user', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + - @validate_arguments - def user_edit_object_v1(self, pki_user_id : Annotated[conint(strict=True, ge=0), Field(..., description="The unique ID of the User")], user_edit_object_v1_request : UserEditObjectV1Request, **kwargs) -> UserEditObjectV1Response: # noqa: E501 - """Edit an existing User # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.user_edit_object_v1(pki_user_id, user_edit_object_v1_request, async_req=True) - >>> result = thread.get() + @validate_call + def user_edit_object_v1( + self, + pki_user_id: Annotated[int, Field(strict=True, ge=0, description="The unique ID of the User")], + user_edit_object_v1_request: UserEditObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> UserEditObjectV1Response: + """Edit an existing User + + :param pki_user_id: The unique ID of the User (required) :type pki_user_id: int :param user_edit_object_v1_request: (required) :type user_edit_object_v1_request: UserEditObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: UserEditObjectV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the user_edit_object_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.user_edit_object_v1_with_http_info(pki_user_id, user_edit_object_v1_request, **kwargs) # noqa: E501 - - @validate_arguments - def user_edit_object_v1_with_http_info(self, pki_user_id : Annotated[conint(strict=True, ge=0), Field(..., description="The unique ID of the User")], user_edit_object_v1_request : UserEditObjectV1Request, **kwargs) -> ApiResponse: # noqa: E501 - """Edit an existing User # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.user_edit_object_v1_with_http_info(pki_user_id, user_edit_object_v1_request, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._user_edit_object_v1_serialize( + pki_user_id=pki_user_id, + user_edit_object_v1_request=user_edit_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "UserEditObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def user_edit_object_v1_with_http_info( + self, + pki_user_id: Annotated[int, Field(strict=True, ge=0, description="The unique ID of the User")], + user_edit_object_v1_request: UserEditObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[UserEditObjectV1Response]: + """Edit an existing User + + :param pki_user_id: The unique ID of the User (required) :type pki_user_id: int :param user_edit_object_v1_request: (required) :type user_edit_object_v1_request: UserEditObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(UserEditObjectV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._user_edit_object_v1_serialize( + pki_user_id=pki_user_id, + user_edit_object_v1_request=user_edit_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "UserEditObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _params = locals() - _all_params = [ - 'pki_user_id', - 'user_edit_object_v1_request' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + @validate_call + def user_edit_object_v1_without_preload_content( + self, + pki_user_id: Annotated[int, Field(strict=True, ge=0, description="The unique ID of the User")], + user_edit_object_v1_request: UserEditObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Edit an existing User + + + + :param pki_user_id: The unique ID of the User (required) + :type pki_user_id: int + :param user_edit_object_v1_request: (required) + :type user_edit_object_v1_request: UserEditObjectV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._user_edit_object_v1_serialize( + pki_user_id=pki_user_id, + user_edit_object_v1_request=user_edit_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method user_edit_object_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "UserEditObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_user_id']: - _path_params['pkiUserID'] = _params['pki_user_id'] + def _user_edit_object_v1_serialize( + self, + pki_user_id, + user_edit_object_v1_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if pki_user_id is not None: + _path_params['pkiUserID'] = pki_user_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['user_edit_object_v1_request'] is not None: - _body_params = _params['user_edit_object_v1_request'] + if user_edit_object_v1_request is not None: + _body_params = user_edit_object_v1_request + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '200': "UserEditObjectV1Response", - '404': "CommonResponseError", - '422': "CommonResponseError", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/user/{pkiUserID}', 'PUT', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='PUT', + resource_path='/1/object/user/{pkiUserID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) - @validate_arguments - def user_edit_permissions_v1(self, pki_user_id : conint(strict=True, ge=0), user_edit_permissions_v1_request : UserEditPermissionsV1Request, **kwargs) -> UserEditPermissionsV1Response: # noqa: E501 - """Edit multiple Permissions # noqa: E501 - Using this endpoint, you can edit multiple Permissions at the same time. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.user_edit_permissions_v1(pki_user_id, user_edit_permissions_v1_request, async_req=True) - >>> result = thread.get() + + @validate_call + def user_edit_permissions_v1( + self, + pki_user_id: Annotated[int, Field(strict=True, ge=0)], + user_edit_permissions_v1_request: UserEditPermissionsV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> UserEditPermissionsV1Response: + """Edit multiple Permissions + + Using this endpoint, you can edit multiple Permissions at the same time. :param pki_user_id: (required) :type pki_user_id: int :param user_edit_permissions_v1_request: (required) :type user_edit_permissions_v1_request: UserEditPermissionsV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: UserEditPermissionsV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the user_edit_permissions_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.user_edit_permissions_v1_with_http_info(pki_user_id, user_edit_permissions_v1_request, **kwargs) # noqa: E501 - - @validate_arguments - def user_edit_permissions_v1_with_http_info(self, pki_user_id : conint(strict=True, ge=0), user_edit_permissions_v1_request : UserEditPermissionsV1Request, **kwargs) -> ApiResponse: # noqa: E501 - """Edit multiple Permissions # noqa: E501 - - Using this endpoint, you can edit multiple Permissions at the same time. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.user_edit_permissions_v1_with_http_info(pki_user_id, user_edit_permissions_v1_request, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._user_edit_permissions_v1_serialize( + pki_user_id=pki_user_id, + user_edit_permissions_v1_request=user_edit_permissions_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "UserEditPermissionsV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def user_edit_permissions_v1_with_http_info( + self, + pki_user_id: Annotated[int, Field(strict=True, ge=0)], + user_edit_permissions_v1_request: UserEditPermissionsV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[UserEditPermissionsV1Response]: + """Edit multiple Permissions + + Using this endpoint, you can edit multiple Permissions at the same time. :param pki_user_id: (required) :type pki_user_id: int :param user_edit_permissions_v1_request: (required) :type user_edit_permissions_v1_request: UserEditPermissionsV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(UserEditPermissionsV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._user_edit_permissions_v1_serialize( + pki_user_id=pki_user_id, + user_edit_permissions_v1_request=user_edit_permissions_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '200': "UserEditPermissionsV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'pki_user_id', - 'user_edit_permissions_v1_request' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def user_edit_permissions_v1_without_preload_content( + self, + pki_user_id: Annotated[int, Field(strict=True, ge=0)], + user_edit_permissions_v1_request: UserEditPermissionsV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Edit multiple Permissions + + Using this endpoint, you can edit multiple Permissions at the same time. + + :param pki_user_id: (required) + :type pki_user_id: int + :param user_edit_permissions_v1_request: (required) + :type user_edit_permissions_v1_request: UserEditPermissionsV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._user_edit_permissions_v1_serialize( + pki_user_id=pki_user_id, + user_edit_permissions_v1_request=user_edit_permissions_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method user_edit_permissions_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "UserEditPermissionsV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_user_id']: - _path_params['pkiUserID'] = _params['pki_user_id'] + def _user_edit_permissions_v1_serialize( + self, + pki_user_id, + user_edit_permissions_v1_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if pki_user_id is not None: + _path_params['pkiUserID'] = pki_user_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['user_edit_permissions_v1_request'] is not None: - _body_params = _params['user_edit_permissions_v1_request'] + if user_edit_permissions_v1_request is not None: + _body_params = user_edit_permissions_v1_request + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '200': "UserEditPermissionsV1Response", - '404': "CommonResponseError", - '422': "CommonResponseError", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/user/{pkiUserID}/editPermissions', 'PUT', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='PUT', + resource_path='/1/object/user/{pkiUserID}/editPermissions', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + - @validate_arguments - def user_get_apikeys_v1(self, pki_user_id : conint(strict=True, ge=0), **kwargs) -> UserGetApikeysV1Response: # noqa: E501 - """Retrieve an existing User's Apikeys # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.user_get_apikeys_v1(pki_user_id, async_req=True) - >>> result = thread.get() + @validate_call + def user_get_apikeys_v1( + self, + pki_user_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> UserGetApikeysV1Response: + """Retrieve an existing User's Apikeys + :param pki_user_id: (required) :type pki_user_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: UserGetApikeysV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the user_get_apikeys_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.user_get_apikeys_v1_with_http_info(pki_user_id, **kwargs) # noqa: E501 - - @validate_arguments - def user_get_apikeys_v1_with_http_info(self, pki_user_id : conint(strict=True, ge=0), **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve an existing User's Apikeys # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.user_get_apikeys_v1_with_http_info(pki_user_id, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._user_get_apikeys_v1_serialize( + pki_user_id=pki_user_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "UserGetApikeysV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def user_get_apikeys_v1_with_http_info( + self, + pki_user_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[UserGetApikeysV1Response]: + """Retrieve an existing User's Apikeys + :param pki_user_id: (required) :type pki_user_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(UserGetApikeysV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._user_get_apikeys_v1_serialize( + pki_user_id=pki_user_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "UserGetApikeysV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _params = locals() - _all_params = [ - 'pki_user_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + @validate_call + def user_get_apikeys_v1_without_preload_content( + self, + pki_user_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve an existing User's Apikeys + + + :param pki_user_id: (required) + :type pki_user_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._user_get_apikeys_v1_serialize( + pki_user_id=pki_user_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method user_get_apikeys_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "UserGetApikeysV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_user_id']: - _path_params['pkiUserID'] = _params['pki_user_id'] + def _user_get_apikeys_v1_serialize( + self, + pki_user_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_user_id is not None: + _path_params['pkiUserID'] = pki_user_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "UserGetApikeysV1Response", - '404': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/user/{pkiUserID}/getApikeys', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/1/object/user/{pkiUserID}/getApikeys', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + - @validate_arguments - def user_get_autocomplete_v2(self, s_selector : Annotated[StrictStr, Field(..., description="The type of Users to return")], e_filter_active : Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, s_query : Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, accept_language : Optional[HeaderAcceptLanguage] = None, **kwargs) -> UserGetAutocompleteV2Response: # noqa: E501 - """Retrieve Users and IDs # noqa: E501 - Get the list of User to be used in a dropdown or autocomplete control. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.user_get_autocomplete_v2(s_selector, e_filter_active, s_query, accept_language, async_req=True) - >>> result = thread.get() + @validate_call + def user_get_autocomplete_v2( + self, + s_selector: Annotated[StrictStr, Field(description="The type of Users to return")], + e_filter_active: Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, + s_query: Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> UserGetAutocompleteV2Response: + """Retrieve Users and IDs + + Get the list of User to be used in a dropdown or autocomplete control. :param s_selector: The type of Users to return (required) :type s_selector: str @@ -679,33 +1209,76 @@ def user_get_autocomplete_v2(self, s_selector : Annotated[StrictStr, Field(..., :type s_query: str :param accept_language: :type accept_language: HeaderAcceptLanguage - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: UserGetAutocompleteV2Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the user_get_autocomplete_v2_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.user_get_autocomplete_v2_with_http_info(s_selector, e_filter_active, s_query, accept_language, **kwargs) # noqa: E501 - - @validate_arguments - def user_get_autocomplete_v2_with_http_info(self, s_selector : Annotated[StrictStr, Field(..., description="The type of Users to return")], e_filter_active : Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, s_query : Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, accept_language : Optional[HeaderAcceptLanguage] = None, **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve Users and IDs # noqa: E501 - - Get the list of User to be used in a dropdown or autocomplete control. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.user_get_autocomplete_v2_with_http_info(s_selector, e_filter_active, s_query, accept_language, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._user_get_autocomplete_v2_serialize( + s_selector=s_selector, + e_filter_active=e_filter_active, + s_query=s_query, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "UserGetAutocompleteV2Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def user_get_autocomplete_v2_with_http_info( + self, + s_selector: Annotated[StrictStr, Field(description="The type of Users to return")], + e_filter_active: Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, + s_query: Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[UserGetAutocompleteV2Response]: + """Retrieve Users and IDs + + Get the list of User to be used in a dropdown or autocomplete control. :param s_selector: The type of Users to return (required) :type s_selector: str @@ -715,266 +1288,487 @@ def user_get_autocomplete_v2_with_http_info(self, s_selector : Annotated[StrictS :type s_query: str :param accept_language: :type accept_language: HeaderAcceptLanguage - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(UserGetAutocompleteV2Response, status_code(int), headers(HTTPHeaderDict)) - """ - - _params = locals() - - _all_params = [ - 's_selector', - 'e_filter_active', - 's_query', - 'accept_language' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + """ # noqa: E501 + + _param = self._user_get_autocomplete_v2_serialize( + s_selector=s_selector, + e_filter_active=e_filter_active, + s_query=s_query, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "UserGetAutocompleteV2Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def user_get_autocomplete_v2_without_preload_content( + self, + s_selector: Annotated[StrictStr, Field(description="The type of Users to return")], + e_filter_active: Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, + s_query: Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve Users and IDs + + Get the list of User to be used in a dropdown or autocomplete control. + + :param s_selector: The type of Users to return (required) + :type s_selector: str + :param e_filter_active: Specify which results we want to display. + :type e_filter_active: str + :param s_query: Allow to filter the returned results + :type s_query: str + :param accept_language: + :type accept_language: HeaderAcceptLanguage + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._user_get_autocomplete_v2_serialize( + s_selector=s_selector, + e_filter_active=e_filter_active, + s_query=s_query, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method user_get_autocomplete_v2" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "UserGetAutocompleteV2Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['s_selector']: - _path_params['sSelector'] = _params['s_selector'] + def _user_get_autocomplete_v2_serialize( + self, + s_selector, + e_filter_active, + s_query, + accept_language, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None - # process the query parameters - _query_params = [] - if _params.get('e_filter_active') is not None: # noqa: E501 - _query_params.append(('eFilterActive', _params['e_filter_active'])) + _collection_formats: Dict[str, str] = { + } - if _params.get('s_query') is not None: # noqa: E501 - _query_params.append(('sQuery', _params['s_query'])) + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if s_selector is not None: + _path_params['sSelector'] = s_selector + # process the query parameters + if e_filter_active is not None: + + _query_params.append(('eFilterActive', e_filter_active)) + + if s_query is not None: + + _query_params.append(('sQuery', s_query)) + # process the header parameters - _header_params = dict(_params.get('_headers', {})) - if _params['accept_language']: - _header_params['Accept-Language'] = _params['accept_language'] - + if accept_language is not None: + _header_params['Accept-Language'] = accept_language # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "UserGetAutocompleteV2Response", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/2/object/user/getAutocomplete/{sSelector}', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/2/object/user/getAutocomplete/{sSelector}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) - @validate_arguments - def user_get_effective_permissions_v1(self, pki_user_id : conint(strict=True, ge=0), **kwargs) -> UserGetEffectivePermissionsV1Response: # noqa: E501 - """Retrieve an existing User's Effective Permissions # noqa: E501 - Effective Permissions refers to the combination of Permissions held by a User and the Permissions associated with the Usergroups they belong to. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.user_get_effective_permissions_v1(pki_user_id, async_req=True) - >>> result = thread.get() + + @validate_call + def user_get_effective_permissions_v1( + self, + pki_user_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> UserGetEffectivePermissionsV1Response: + """Retrieve an existing User's Effective Permissions + + Effective Permissions refers to the combination of Permissions held by a User and the Permissions associated with the Usergroups they belong to. :param pki_user_id: (required) :type pki_user_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: UserGetEffectivePermissionsV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the user_get_effective_permissions_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.user_get_effective_permissions_v1_with_http_info(pki_user_id, **kwargs) # noqa: E501 - - @validate_arguments - def user_get_effective_permissions_v1_with_http_info(self, pki_user_id : conint(strict=True, ge=0), **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve an existing User's Effective Permissions # noqa: E501 - - Effective Permissions refers to the combination of Permissions held by a User and the Permissions associated with the Usergroups they belong to. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.user_get_effective_permissions_v1_with_http_info(pki_user_id, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._user_get_effective_permissions_v1_serialize( + pki_user_id=pki_user_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "UserGetEffectivePermissionsV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def user_get_effective_permissions_v1_with_http_info( + self, + pki_user_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[UserGetEffectivePermissionsV1Response]: + """Retrieve an existing User's Effective Permissions + + Effective Permissions refers to the combination of Permissions held by a User and the Permissions associated with the Usergroups they belong to. :param pki_user_id: (required) :type pki_user_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(UserGetEffectivePermissionsV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._user_get_effective_permissions_v1_serialize( + pki_user_id=pki_user_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '200': "UserGetEffectivePermissionsV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'pki_user_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def user_get_effective_permissions_v1_without_preload_content( + self, + pki_user_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve an existing User's Effective Permissions + + Effective Permissions refers to the combination of Permissions held by a User and the Permissions associated with the Usergroups they belong to. + + :param pki_user_id: (required) + :type pki_user_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._user_get_effective_permissions_v1_serialize( + pki_user_id=pki_user_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method user_get_effective_permissions_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "UserGetEffectivePermissionsV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_user_id']: - _path_params['pkiUserID'] = _params['pki_user_id'] + def _user_get_effective_permissions_v1_serialize( + self, + pki_user_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None + + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_user_id is not None: + _path_params['pkiUserID'] = pki_user_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "UserGetEffectivePermissionsV1Response", - '404': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/user/{pkiUserID}/getEffectivePermissions', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/1/object/user/{pkiUserID}/getEffectivePermissions', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) - @validate_arguments - def user_get_list_v1(self, e_order_by : Annotated[Optional[StrictStr], Field(description="Specify how you want the results to be sorted")] = None, i_row_max : Optional[conint(strict=True, le=10000, ge=1)] = None, i_row_offset : Optional[conint(strict=True, ge=0)] = None, accept_language : Optional[HeaderAcceptLanguage] = None, s_filter : Optional[StrictStr] = None, **kwargs) -> UserGetListV1Response: # noqa: E501 - """Retrieve User list # noqa: E501 - Enum values that can be filtered in query parameter *sFilter*: | Variable | Valid values | |---|---| | eUserType | AgentBroker
Assistant
Employee
EzsignUser
Normal | | eUserOrigin | BuiltIn
External | | eUserEzsignaccess | No
PaidByOffice
PerDocument
Prepaid | # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.user_get_list_v1(e_order_by, i_row_max, i_row_offset, accept_language, s_filter, async_req=True) - >>> result = thread.get() + + @validate_call + def user_get_list_v1( + self, + e_order_by: Annotated[Optional[StrictStr], Field(description="Specify how you want the results to be sorted")] = None, + i_row_max: Optional[Annotated[int, Field(le=10000, strict=True, ge=1)]] = None, + i_row_offset: Optional[Annotated[int, Field(strict=True, ge=0)]] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + s_filter: Optional[StrictStr] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> UserGetListV1Response: + """Retrieve User list + + Enum values that can be filtered in query parameter *sFilter*: | Variable | Valid values | |---|---| | eUserType | AgentBroker
Assistant
Employee
EzsignUser
Normal | | eUserOrigin | BuiltIn
External | | eUserEzsignaccess | No
PaidByOffice
PerDocument
Prepaid | :param e_order_by: Specify how you want the results to be sorted :type e_order_by: str @@ -986,33 +1780,79 @@ def user_get_list_v1(self, e_order_by : Annotated[Optional[StrictStr], Field(des :type accept_language: HeaderAcceptLanguage :param s_filter: :type s_filter: str - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: UserGetListV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the user_get_list_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.user_get_list_v1_with_http_info(e_order_by, i_row_max, i_row_offset, accept_language, s_filter, **kwargs) # noqa: E501 - - @validate_arguments - def user_get_list_v1_with_http_info(self, e_order_by : Annotated[Optional[StrictStr], Field(description="Specify how you want the results to be sorted")] = None, i_row_max : Optional[conint(strict=True, le=10000, ge=1)] = None, i_row_offset : Optional[conint(strict=True, ge=0)] = None, accept_language : Optional[HeaderAcceptLanguage] = None, s_filter : Optional[StrictStr] = None, **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve User list # noqa: E501 - - Enum values that can be filtered in query parameter *sFilter*: | Variable | Valid values | |---|---| | eUserType | AgentBroker
Assistant
Employee
EzsignUser
Normal | | eUserOrigin | BuiltIn
External | | eUserEzsignaccess | No
PaidByOffice
PerDocument
Prepaid | # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.user_get_list_v1_with_http_info(e_order_by, i_row_max, i_row_offset, accept_language, s_filter, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._user_get_list_v1_serialize( + e_order_by=e_order_by, + i_row_max=i_row_max, + i_row_offset=i_row_offset, + accept_language=accept_language, + s_filter=s_filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "UserGetListV1Response", + '406': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def user_get_list_v1_with_http_info( + self, + e_order_by: Annotated[Optional[StrictStr], Field(description="Specify how you want the results to be sorted")] = None, + i_row_max: Optional[Annotated[int, Field(le=10000, strict=True, ge=1)]] = None, + i_row_offset: Optional[Annotated[int, Field(strict=True, ge=0)]] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + s_filter: Optional[StrictStr] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[UserGetListV1Response]: + """Retrieve User list + + Enum values that can be filtered in query parameter *sFilter*: | Variable | Valid values | |---|---| | eUserType | AgentBroker
Assistant
Employee
EzsignUser
Normal | | eUserOrigin | BuiltIn
External | | eUserEzsignaccess | No
PaidByOffice
PerDocument
Prepaid | :param e_order_by: Specify how you want the results to be sorted :type e_order_by: str @@ -1024,692 +1864,1281 @@ def user_get_list_v1_with_http_info(self, e_order_by : Annotated[Optional[Strict :type accept_language: HeaderAcceptLanguage :param s_filter: :type s_filter: str - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(UserGetListV1Response, status_code(int), headers(HTTPHeaderDict)) - """ - - _params = locals() - - _all_params = [ - 'e_order_by', - 'i_row_max', - 'i_row_offset', - 'accept_language', - 's_filter' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' - ] + """ # noqa: E501 + + _param = self._user_get_list_v1_serialize( + e_order_by=e_order_by, + i_row_max=i_row_max, + i_row_offset=i_row_offset, + accept_language=accept_language, + s_filter=s_filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method user_get_list_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "UserGetListV1Response", + '406': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _collection_formats = {} - # process the path parameters - _path_params = {} + @validate_call + def user_get_list_v1_without_preload_content( + self, + e_order_by: Annotated[Optional[StrictStr], Field(description="Specify how you want the results to be sorted")] = None, + i_row_max: Optional[Annotated[int, Field(le=10000, strict=True, ge=1)]] = None, + i_row_offset: Optional[Annotated[int, Field(strict=True, ge=0)]] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + s_filter: Optional[StrictStr] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve User list - # process the query parameters - _query_params = [] - if _params.get('e_order_by') is not None: # noqa: E501 - _query_params.append(('eOrderBy', _params['e_order_by'])) + Enum values that can be filtered in query parameter *sFilter*: | Variable | Valid values | |---|---| | eUserType | AgentBroker
Assistant
Employee
EzsignUser
Normal | | eUserOrigin | BuiltIn
External | | eUserEzsignaccess | No
PaidByOffice
PerDocument
Prepaid | + + :param e_order_by: Specify how you want the results to be sorted + :type e_order_by: str + :param i_row_max: + :type i_row_max: int + :param i_row_offset: + :type i_row_offset: int + :param accept_language: + :type accept_language: HeaderAcceptLanguage + :param s_filter: + :type s_filter: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._user_get_list_v1_serialize( + e_order_by=e_order_by, + i_row_max=i_row_max, + i_row_offset=i_row_offset, + accept_language=accept_language, + s_filter=s_filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - if _params.get('i_row_max') is not None: # noqa: E501 - _query_params.append(('iRowMax', _params['i_row_max'])) + _response_types_map: Dict[str, Optional[str]] = { + '200': "UserGetListV1Response", + '406': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - if _params.get('i_row_offset') is not None: # noqa: E501 - _query_params.append(('iRowOffset', _params['i_row_offset'])) - if _params.get('s_filter') is not None: # noqa: E501 - _query_params.append(('sFilter', _params['s_filter'])) + def _user_get_list_v1_serialize( + self, + e_order_by, + i_row_max, + i_row_offset, + accept_language, + s_filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: - # process the header parameters - _header_params = dict(_params.get('_headers', {})) - if _params['accept_language']: - _header_params['Accept-Language'] = _params['accept_language'] + _host = None + + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if e_order_by is not None: + + _query_params.append(('eOrderBy', e_order_by)) + + if i_row_max is not None: + + _query_params.append(('iRowMax', i_row_max)) + + if i_row_offset is not None: + + _query_params.append(('iRowOffset', i_row_offset)) + + if s_filter is not None: + + _query_params.append(('sFilter', s_filter)) + + # process the header parameters + if accept_language is not None: + _header_params['Accept-Language'] = accept_language # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet']) # noqa: E501 + [ + 'application/json', + 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "UserGetListV1Response", - '406': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/user/getList', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/1/object/user/getList', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) - @validate_arguments - def user_get_object_v2(self, pki_user_id : Annotated[conint(strict=True, ge=0), Field(..., description="The unique ID of the User")], **kwargs) -> UserGetObjectV2Response: # noqa: E501 - """Retrieve an existing User # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.user_get_object_v2(pki_user_id, async_req=True) - >>> result = thread.get() + + @validate_call + def user_get_object_v2( + self, + pki_user_id: Annotated[int, Field(strict=True, ge=0, description="The unique ID of the User")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> UserGetObjectV2Response: + """Retrieve an existing User + + :param pki_user_id: The unique ID of the User (required) :type pki_user_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: UserGetObjectV2Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the user_get_object_v2_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.user_get_object_v2_with_http_info(pki_user_id, **kwargs) # noqa: E501 - - @validate_arguments - def user_get_object_v2_with_http_info(self, pki_user_id : Annotated[conint(strict=True, ge=0), Field(..., description="The unique ID of the User")], **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve an existing User # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.user_get_object_v2_with_http_info(pki_user_id, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._user_get_object_v2_serialize( + pki_user_id=pki_user_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "UserGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def user_get_object_v2_with_http_info( + self, + pki_user_id: Annotated[int, Field(strict=True, ge=0, description="The unique ID of the User")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[UserGetObjectV2Response]: + """Retrieve an existing User + + :param pki_user_id: The unique ID of the User (required) :type pki_user_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(UserGetObjectV2Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._user_get_object_v2_serialize( + pki_user_id=pki_user_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "UserGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _params = locals() - _all_params = [ - 'pki_user_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + @validate_call + def user_get_object_v2_without_preload_content( + self, + pki_user_id: Annotated[int, Field(strict=True, ge=0, description="The unique ID of the User")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve an existing User + + + + :param pki_user_id: The unique ID of the User (required) + :type pki_user_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._user_get_object_v2_serialize( + pki_user_id=pki_user_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method user_get_object_v2" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "UserGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_user_id']: - _path_params['pkiUserID'] = _params['pki_user_id'] + def _user_get_object_v2_serialize( + self, + pki_user_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None + + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_user_id is not None: + _path_params['pkiUserID'] = pki_user_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "UserGetObjectV2Response", - '404': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/2/object/user/{pkiUserID}', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/2/object/user/{pkiUserID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + - @validate_arguments - def user_get_permissions_v1(self, pki_user_id : conint(strict=True, ge=0), **kwargs) -> UserGetPermissionsV1Response: # noqa: E501 - """Retrieve an existing User's Permissions # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def user_get_permissions_v1( + self, + pki_user_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> UserGetPermissionsV1Response: + """Retrieve an existing User's Permissions - >>> thread = api.user_get_permissions_v1(pki_user_id, async_req=True) - >>> result = thread.get() :param pki_user_id: (required) :type pki_user_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: UserGetPermissionsV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the user_get_permissions_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.user_get_permissions_v1_with_http_info(pki_user_id, **kwargs) # noqa: E501 - - @validate_arguments - def user_get_permissions_v1_with_http_info(self, pki_user_id : conint(strict=True, ge=0), **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve an existing User's Permissions # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.user_get_permissions_v1_with_http_info(pki_user_id, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._user_get_permissions_v1_serialize( + pki_user_id=pki_user_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "UserGetPermissionsV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def user_get_permissions_v1_with_http_info( + self, + pki_user_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[UserGetPermissionsV1Response]: + """Retrieve an existing User's Permissions + :param pki_user_id: (required) :type pki_user_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(UserGetPermissionsV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._user_get_permissions_v1_serialize( + pki_user_id=pki_user_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "UserGetPermissionsV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _params = locals() - _all_params = [ - 'pki_user_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + @validate_call + def user_get_permissions_v1_without_preload_content( + self, + pki_user_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve an existing User's Permissions + + + :param pki_user_id: (required) + :type pki_user_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._user_get_permissions_v1_serialize( + pki_user_id=pki_user_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method user_get_permissions_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "UserGetPermissionsV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_user_id']: - _path_params['pkiUserID'] = _params['pki_user_id'] + def _user_get_permissions_v1_serialize( + self, + pki_user_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_user_id is not None: + _path_params['pkiUserID'] = pki_user_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "UserGetPermissionsV1Response", - '404': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/user/{pkiUserID}/getPermissions', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/1/object/user/{pkiUserID}/getPermissions', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) - @validate_arguments - def user_get_subnets_v1(self, pki_user_id : conint(strict=True, ge=0), **kwargs) -> UserGetSubnetsV1Response: # noqa: E501 - """Retrieve an existing User's Subnets # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.user_get_subnets_v1(pki_user_id, async_req=True) - >>> result = thread.get() + + @validate_call + def user_get_subnets_v1( + self, + pki_user_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> UserGetSubnetsV1Response: + """Retrieve an existing User's Subnets + :param pki_user_id: (required) :type pki_user_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: UserGetSubnetsV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the user_get_subnets_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.user_get_subnets_v1_with_http_info(pki_user_id, **kwargs) # noqa: E501 - - @validate_arguments - def user_get_subnets_v1_with_http_info(self, pki_user_id : conint(strict=True, ge=0), **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve an existing User's Subnets # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.user_get_subnets_v1_with_http_info(pki_user_id, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._user_get_subnets_v1_serialize( + pki_user_id=pki_user_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "UserGetSubnetsV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def user_get_subnets_v1_with_http_info( + self, + pki_user_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[UserGetSubnetsV1Response]: + """Retrieve an existing User's Subnets + :param pki_user_id: (required) :type pki_user_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(UserGetSubnetsV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._user_get_subnets_v1_serialize( + pki_user_id=pki_user_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '200': "UserGetSubnetsV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'pki_user_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def user_get_subnets_v1_without_preload_content( + self, + pki_user_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve an existing User's Subnets + + + :param pki_user_id: (required) + :type pki_user_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._user_get_subnets_v1_serialize( + pki_user_id=pki_user_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method user_get_subnets_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "UserGetSubnetsV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_user_id']: - _path_params['pkiUserID'] = _params['pki_user_id'] + def _user_get_subnets_v1_serialize( + self, + pki_user_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_user_id is not None: + _path_params['pkiUserID'] = pki_user_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "UserGetSubnetsV1Response", - '404': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/user/{pkiUserID}/getSubnets', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/1/object/user/{pkiUserID}/getSubnets', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + - @validate_arguments - def user_send_password_reset_v1(self, pki_user_id : conint(strict=True, ge=0), body : Dict[str, Any], **kwargs) -> UserSendPasswordResetV1Response: # noqa: E501 - """Send password reset # noqa: E501 - Send the password reset email # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.user_send_password_reset_v1(pki_user_id, body, async_req=True) - >>> result = thread.get() + @validate_call + def user_send_password_reset_v1( + self, + pki_user_id: Annotated[int, Field(strict=True, ge=0)], + body: Dict[str, Any], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> UserSendPasswordResetV1Response: + """Send password reset + + Send the password reset email :param pki_user_id: (required) :type pki_user_id: int :param body: (required) :type body: object - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: UserSendPasswordResetV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the user_send_password_reset_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.user_send_password_reset_v1_with_http_info(pki_user_id, body, **kwargs) # noqa: E501 - - @validate_arguments - def user_send_password_reset_v1_with_http_info(self, pki_user_id : conint(strict=True, ge=0), body : Dict[str, Any], **kwargs) -> ApiResponse: # noqa: E501 - """Send password reset # noqa: E501 - - Send the password reset email # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.user_send_password_reset_v1_with_http_info(pki_user_id, body, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._user_send_password_reset_v1_serialize( + pki_user_id=pki_user_id, + body=body, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "UserSendPasswordResetV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def user_send_password_reset_v1_with_http_info( + self, + pki_user_id: Annotated[int, Field(strict=True, ge=0)], + body: Dict[str, Any], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[UserSendPasswordResetV1Response]: + """Send password reset + + Send the password reset email :param pki_user_id: (required) :type pki_user_id: int :param body: (required) :type body: object - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(UserSendPasswordResetV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._user_send_password_reset_v1_serialize( + pki_user_id=pki_user_id, + body=body, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "UserSendPasswordResetV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _params = locals() - _all_params = [ - 'pki_user_id', - 'body' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + @validate_call + def user_send_password_reset_v1_without_preload_content( + self, + pki_user_id: Annotated[int, Field(strict=True, ge=0)], + body: Dict[str, Any], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Send password reset + + Send the password reset email + + :param pki_user_id: (required) + :type pki_user_id: int + :param body: (required) + :type body: object + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._user_send_password_reset_v1_serialize( + pki_user_id=pki_user_id, + body=body, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method user_send_password_reset_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "UserSendPasswordResetV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_user_id']: - _path_params['pkiUserID'] = _params['pki_user_id'] + def _user_send_password_reset_v1_serialize( + self, + pki_user_id, + body, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None + + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_user_id is not None: + _path_params['pkiUserID'] = pki_user_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['body'] is not None: - _body_params = _params['body'] + if body is not None: + _body_params = body + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '200': "UserSendPasswordResetV1Response", - '404': "CommonResponseError", - '422': "CommonResponseError", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/user/{pkiUserID}/sendPasswordReset', 'POST', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='POST', + resource_path='/1/object/user/{pkiUserID}/sendPasswordReset', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/eZmaxApi/api/object_usergroup_api.py b/eZmaxApi/api/object_usergroup_api.py index 04e92f72a..dfb57a2df 100644 --- a/eZmaxApi/api/object_usergroup_api.py +++ b/eZmaxApi/api/object_usergroup_api.py @@ -13,14 +13,20 @@ """ # noqa: E501 -import re # noqa: F401 import io import warnings -from pydantic import validate_arguments, ValidationError +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Dict, List, Optional, Tuple, Union, Any +try: + from typing import Annotated +except ImportError: + from typing_extensions import Annotated + +from pydantic import Field from typing_extensions import Annotated -from pydantic import Field, StrictStr, conint +from pydantic import StrictStr, field_validator from typing import Optional @@ -44,10 +50,7 @@ from eZmaxApi.api_client import ApiClient from eZmaxApi.api_response import ApiResponse -from eZmaxApi.exceptions import ( # noqa: F401 - ApiTypeError, - ApiValueError -) +from eZmaxApi.rest import RESTResponseType class ObjectUsergroupApi: @@ -62,791 +65,1469 @@ def __init__(self, api_client=None) -> None: api_client = ApiClient.get_default() self.api_client = api_client - @validate_arguments - def usergroup_create_object_v1(self, usergroup_create_object_v1_request : UsergroupCreateObjectV1Request, **kwargs) -> UsergroupCreateObjectV1Response: # noqa: E501 - """Create a new Usergroup # noqa: E501 - The endpoint allows to create one or many elements at once. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def usergroup_create_object_v1( + self, + usergroup_create_object_v1_request: UsergroupCreateObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> UsergroupCreateObjectV1Response: + """Create a new Usergroup - >>> thread = api.usergroup_create_object_v1(usergroup_create_object_v1_request, async_req=True) - >>> result = thread.get() + The endpoint allows to create one or many elements at once. :param usergroup_create_object_v1_request: (required) :type usergroup_create_object_v1_request: UsergroupCreateObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: UsergroupCreateObjectV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the usergroup_create_object_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.usergroup_create_object_v1_with_http_info(usergroup_create_object_v1_request, **kwargs) # noqa: E501 - - @validate_arguments - def usergroup_create_object_v1_with_http_info(self, usergroup_create_object_v1_request : UsergroupCreateObjectV1Request, **kwargs) -> ApiResponse: # noqa: E501 - """Create a new Usergroup # noqa: E501 - - The endpoint allows to create one or many elements at once. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.usergroup_create_object_v1_with_http_info(usergroup_create_object_v1_request, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._usergroup_create_object_v1_serialize( + usergroup_create_object_v1_request=usergroup_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "UsergroupCreateObjectV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def usergroup_create_object_v1_with_http_info( + self, + usergroup_create_object_v1_request: UsergroupCreateObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[UsergroupCreateObjectV1Response]: + """Create a new Usergroup + + The endpoint allows to create one or many elements at once. :param usergroup_create_object_v1_request: (required) :type usergroup_create_object_v1_request: UsergroupCreateObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(UsergroupCreateObjectV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._usergroup_create_object_v1_serialize( + usergroup_create_object_v1_request=usergroup_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '201': "UsergroupCreateObjectV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'usergroup_create_object_v1_request' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def usergroup_create_object_v1_without_preload_content( + self, + usergroup_create_object_v1_request: UsergroupCreateObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Create a new Usergroup + + The endpoint allows to create one or many elements at once. + + :param usergroup_create_object_v1_request: (required) + :type usergroup_create_object_v1_request: UsergroupCreateObjectV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._usergroup_create_object_v1_serialize( + usergroup_create_object_v1_request=usergroup_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method usergroup_create_object_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '201': "UsergroupCreateObjectV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} + def _usergroup_create_object_v1_serialize( + self, + usergroup_create_object_v1_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['usergroup_create_object_v1_request'] is not None: - _body_params = _params['usergroup_create_object_v1_request'] + if usergroup_create_object_v1_request is not None: + _body_params = usergroup_create_object_v1_request + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '201': "UsergroupCreateObjectV1Response", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/usergroup', 'POST', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='POST', + resource_path='/1/object/usergroup', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + - @validate_arguments - def usergroup_edit_object_v1(self, pki_usergroup_id : conint(strict=True, le=255, ge=0), usergroup_edit_object_v1_request : UsergroupEditObjectV1Request, **kwargs) -> UsergroupEditObjectV1Response: # noqa: E501 - """Edit an existing Usergroup # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.usergroup_edit_object_v1(pki_usergroup_id, usergroup_edit_object_v1_request, async_req=True) - >>> result = thread.get() + @validate_call + def usergroup_edit_object_v1( + self, + pki_usergroup_id: Annotated[int, Field(le=255, strict=True, ge=0)], + usergroup_edit_object_v1_request: UsergroupEditObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> UsergroupEditObjectV1Response: + """Edit an existing Usergroup + + :param pki_usergroup_id: (required) :type pki_usergroup_id: int :param usergroup_edit_object_v1_request: (required) :type usergroup_edit_object_v1_request: UsergroupEditObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: UsergroupEditObjectV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the usergroup_edit_object_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.usergroup_edit_object_v1_with_http_info(pki_usergroup_id, usergroup_edit_object_v1_request, **kwargs) # noqa: E501 - - @validate_arguments - def usergroup_edit_object_v1_with_http_info(self, pki_usergroup_id : conint(strict=True, le=255, ge=0), usergroup_edit_object_v1_request : UsergroupEditObjectV1Request, **kwargs) -> ApiResponse: # noqa: E501 - """Edit an existing Usergroup # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.usergroup_edit_object_v1_with_http_info(pki_usergroup_id, usergroup_edit_object_v1_request, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._usergroup_edit_object_v1_serialize( + pki_usergroup_id=pki_usergroup_id, + usergroup_edit_object_v1_request=usergroup_edit_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "UsergroupEditObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def usergroup_edit_object_v1_with_http_info( + self, + pki_usergroup_id: Annotated[int, Field(le=255, strict=True, ge=0)], + usergroup_edit_object_v1_request: UsergroupEditObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[UsergroupEditObjectV1Response]: + """Edit an existing Usergroup + + :param pki_usergroup_id: (required) :type pki_usergroup_id: int :param usergroup_edit_object_v1_request: (required) :type usergroup_edit_object_v1_request: UsergroupEditObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(UsergroupEditObjectV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._usergroup_edit_object_v1_serialize( + pki_usergroup_id=pki_usergroup_id, + usergroup_edit_object_v1_request=usergroup_edit_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "UsergroupEditObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _params = locals() - _all_params = [ - 'pki_usergroup_id', - 'usergroup_edit_object_v1_request' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + @validate_call + def usergroup_edit_object_v1_without_preload_content( + self, + pki_usergroup_id: Annotated[int, Field(le=255, strict=True, ge=0)], + usergroup_edit_object_v1_request: UsergroupEditObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Edit an existing Usergroup + + + + :param pki_usergroup_id: (required) + :type pki_usergroup_id: int + :param usergroup_edit_object_v1_request: (required) + :type usergroup_edit_object_v1_request: UsergroupEditObjectV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._usergroup_edit_object_v1_serialize( + pki_usergroup_id=pki_usergroup_id, + usergroup_edit_object_v1_request=usergroup_edit_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method usergroup_edit_object_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "UsergroupEditObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_usergroup_id']: - _path_params['pkiUsergroupID'] = _params['pki_usergroup_id'] + def _usergroup_edit_object_v1_serialize( + self, + pki_usergroup_id, + usergroup_edit_object_v1_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if pki_usergroup_id is not None: + _path_params['pkiUsergroupID'] = pki_usergroup_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['usergroup_edit_object_v1_request'] is not None: - _body_params = _params['usergroup_edit_object_v1_request'] + if usergroup_edit_object_v1_request is not None: + _body_params = usergroup_edit_object_v1_request + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '200': "UsergroupEditObjectV1Response", - '404': "CommonResponseError", - '422': "CommonResponseError", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/usergroup/{pkiUsergroupID}', 'PUT', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='PUT', + resource_path='/1/object/usergroup/{pkiUsergroupID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) - @validate_arguments - def usergroup_edit_permissions_v1(self, pki_usergroup_id : conint(strict=True, le=255, ge=0), usergroup_edit_permissions_v1_request : UsergroupEditPermissionsV1Request, **kwargs) -> UsergroupEditPermissionsV1Response: # noqa: E501 - """Edit multiple Permissions # noqa: E501 - Using this endpoint, you can edit multiple Permissions at the same time. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.usergroup_edit_permissions_v1(pki_usergroup_id, usergroup_edit_permissions_v1_request, async_req=True) - >>> result = thread.get() + + @validate_call + def usergroup_edit_permissions_v1( + self, + pki_usergroup_id: Annotated[int, Field(le=255, strict=True, ge=0)], + usergroup_edit_permissions_v1_request: UsergroupEditPermissionsV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> UsergroupEditPermissionsV1Response: + """Edit multiple Permissions + + Using this endpoint, you can edit multiple Permissions at the same time. :param pki_usergroup_id: (required) :type pki_usergroup_id: int :param usergroup_edit_permissions_v1_request: (required) :type usergroup_edit_permissions_v1_request: UsergroupEditPermissionsV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: UsergroupEditPermissionsV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the usergroup_edit_permissions_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.usergroup_edit_permissions_v1_with_http_info(pki_usergroup_id, usergroup_edit_permissions_v1_request, **kwargs) # noqa: E501 - - @validate_arguments - def usergroup_edit_permissions_v1_with_http_info(self, pki_usergroup_id : conint(strict=True, le=255, ge=0), usergroup_edit_permissions_v1_request : UsergroupEditPermissionsV1Request, **kwargs) -> ApiResponse: # noqa: E501 - """Edit multiple Permissions # noqa: E501 - - Using this endpoint, you can edit multiple Permissions at the same time. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.usergroup_edit_permissions_v1_with_http_info(pki_usergroup_id, usergroup_edit_permissions_v1_request, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._usergroup_edit_permissions_v1_serialize( + pki_usergroup_id=pki_usergroup_id, + usergroup_edit_permissions_v1_request=usergroup_edit_permissions_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "UsergroupEditPermissionsV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def usergroup_edit_permissions_v1_with_http_info( + self, + pki_usergroup_id: Annotated[int, Field(le=255, strict=True, ge=0)], + usergroup_edit_permissions_v1_request: UsergroupEditPermissionsV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[UsergroupEditPermissionsV1Response]: + """Edit multiple Permissions + + Using this endpoint, you can edit multiple Permissions at the same time. :param pki_usergroup_id: (required) :type pki_usergroup_id: int :param usergroup_edit_permissions_v1_request: (required) :type usergroup_edit_permissions_v1_request: UsergroupEditPermissionsV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(UsergroupEditPermissionsV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._usergroup_edit_permissions_v1_serialize( + pki_usergroup_id=pki_usergroup_id, + usergroup_edit_permissions_v1_request=usergroup_edit_permissions_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '200': "UsergroupEditPermissionsV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'pki_usergroup_id', - 'usergroup_edit_permissions_v1_request' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def usergroup_edit_permissions_v1_without_preload_content( + self, + pki_usergroup_id: Annotated[int, Field(le=255, strict=True, ge=0)], + usergroup_edit_permissions_v1_request: UsergroupEditPermissionsV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Edit multiple Permissions + + Using this endpoint, you can edit multiple Permissions at the same time. + + :param pki_usergroup_id: (required) + :type pki_usergroup_id: int + :param usergroup_edit_permissions_v1_request: (required) + :type usergroup_edit_permissions_v1_request: UsergroupEditPermissionsV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._usergroup_edit_permissions_v1_serialize( + pki_usergroup_id=pki_usergroup_id, + usergroup_edit_permissions_v1_request=usergroup_edit_permissions_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method usergroup_edit_permissions_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "UsergroupEditPermissionsV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_usergroup_id']: - _path_params['pkiUsergroupID'] = _params['pki_usergroup_id'] + def _usergroup_edit_permissions_v1_serialize( + self, + pki_usergroup_id, + usergroup_edit_permissions_v1_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if pki_usergroup_id is not None: + _path_params['pkiUsergroupID'] = pki_usergroup_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['usergroup_edit_permissions_v1_request'] is not None: - _body_params = _params['usergroup_edit_permissions_v1_request'] + if usergroup_edit_permissions_v1_request is not None: + _body_params = usergroup_edit_permissions_v1_request + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '200': "UsergroupEditPermissionsV1Response", - '404': "CommonResponseError", - '422': "CommonResponseError", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/usergroup/{pkiUsergroupID}/editPermissions', 'PUT', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='PUT', + resource_path='/1/object/usergroup/{pkiUsergroupID}/editPermissions', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + - @validate_arguments - def usergroup_edit_usergroupdelegations_v1(self, pki_usergroup_id : conint(strict=True, le=255, ge=0), usergroup_edit_usergroupdelegations_v1_request : UsergroupEditUsergroupdelegationsV1Request, **kwargs) -> UsergroupEditUsergroupdelegationsV1Response: # noqa: E501 - """Edit multiple Usergroupdelegations # noqa: E501 - Edit multiple Usergroupdelegations # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.usergroup_edit_usergroupdelegations_v1(pki_usergroup_id, usergroup_edit_usergroupdelegations_v1_request, async_req=True) - >>> result = thread.get() + @validate_call + def usergroup_edit_usergroupdelegations_v1( + self, + pki_usergroup_id: Annotated[int, Field(le=255, strict=True, ge=0)], + usergroup_edit_usergroupdelegations_v1_request: UsergroupEditUsergroupdelegationsV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> UsergroupEditUsergroupdelegationsV1Response: + """Edit multiple Usergroupdelegations + + Edit multiple Usergroupdelegations :param pki_usergroup_id: (required) :type pki_usergroup_id: int :param usergroup_edit_usergroupdelegations_v1_request: (required) :type usergroup_edit_usergroupdelegations_v1_request: UsergroupEditUsergroupdelegationsV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: UsergroupEditUsergroupdelegationsV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the usergroup_edit_usergroupdelegations_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.usergroup_edit_usergroupdelegations_v1_with_http_info(pki_usergroup_id, usergroup_edit_usergroupdelegations_v1_request, **kwargs) # noqa: E501 - - @validate_arguments - def usergroup_edit_usergroupdelegations_v1_with_http_info(self, pki_usergroup_id : conint(strict=True, le=255, ge=0), usergroup_edit_usergroupdelegations_v1_request : UsergroupEditUsergroupdelegationsV1Request, **kwargs) -> ApiResponse: # noqa: E501 - """Edit multiple Usergroupdelegations # noqa: E501 - - Edit multiple Usergroupdelegations # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.usergroup_edit_usergroupdelegations_v1_with_http_info(pki_usergroup_id, usergroup_edit_usergroupdelegations_v1_request, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._usergroup_edit_usergroupdelegations_v1_serialize( + pki_usergroup_id=pki_usergroup_id, + usergroup_edit_usergroupdelegations_v1_request=usergroup_edit_usergroupdelegations_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "UsergroupEditUsergroupdelegationsV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def usergroup_edit_usergroupdelegations_v1_with_http_info( + self, + pki_usergroup_id: Annotated[int, Field(le=255, strict=True, ge=0)], + usergroup_edit_usergroupdelegations_v1_request: UsergroupEditUsergroupdelegationsV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[UsergroupEditUsergroupdelegationsV1Response]: + """Edit multiple Usergroupdelegations + + Edit multiple Usergroupdelegations :param pki_usergroup_id: (required) :type pki_usergroup_id: int :param usergroup_edit_usergroupdelegations_v1_request: (required) :type usergroup_edit_usergroupdelegations_v1_request: UsergroupEditUsergroupdelegationsV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(UsergroupEditUsergroupdelegationsV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._usergroup_edit_usergroupdelegations_v1_serialize( + pki_usergroup_id=pki_usergroup_id, + usergroup_edit_usergroupdelegations_v1_request=usergroup_edit_usergroupdelegations_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "UsergroupEditUsergroupdelegationsV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _params = locals() - _all_params = [ - 'pki_usergroup_id', - 'usergroup_edit_usergroupdelegations_v1_request' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + @validate_call + def usergroup_edit_usergroupdelegations_v1_without_preload_content( + self, + pki_usergroup_id: Annotated[int, Field(le=255, strict=True, ge=0)], + usergroup_edit_usergroupdelegations_v1_request: UsergroupEditUsergroupdelegationsV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Edit multiple Usergroupdelegations + + Edit multiple Usergroupdelegations + + :param pki_usergroup_id: (required) + :type pki_usergroup_id: int + :param usergroup_edit_usergroupdelegations_v1_request: (required) + :type usergroup_edit_usergroupdelegations_v1_request: UsergroupEditUsergroupdelegationsV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._usergroup_edit_usergroupdelegations_v1_serialize( + pki_usergroup_id=pki_usergroup_id, + usergroup_edit_usergroupdelegations_v1_request=usergroup_edit_usergroupdelegations_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method usergroup_edit_usergroupdelegations_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "UsergroupEditUsergroupdelegationsV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_usergroup_id']: - _path_params['pkiUsergroupID'] = _params['pki_usergroup_id'] + def _usergroup_edit_usergroupdelegations_v1_serialize( + self, + pki_usergroup_id, + usergroup_edit_usergroupdelegations_v1_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if pki_usergroup_id is not None: + _path_params['pkiUsergroupID'] = pki_usergroup_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['usergroup_edit_usergroupdelegations_v1_request'] is not None: - _body_params = _params['usergroup_edit_usergroupdelegations_v1_request'] + if usergroup_edit_usergroupdelegations_v1_request is not None: + _body_params = usergroup_edit_usergroupdelegations_v1_request + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '200': "UsergroupEditUsergroupdelegationsV1Response", - '404': "CommonResponseError", - '422': "CommonResponseError", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/usergroup/{pkiUsergroupID}/editUsergroupdelegations', 'PUT', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='PUT', + resource_path='/1/object/usergroup/{pkiUsergroupID}/editUsergroupdelegations', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + - @validate_arguments - def usergroup_edit_usergroupmemberships_v1(self, pki_usergroup_id : conint(strict=True, le=255, ge=0), usergroup_edit_usergroupmemberships_v1_request : UsergroupEditUsergroupmembershipsV1Request, **kwargs) -> UsergroupEditUsergroupmembershipsV1Response: # noqa: E501 - """Edit multiple Usergroupmemberships # noqa: E501 - Using this endpoint, you can edit multiple Usergroupmemberships at the same time. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def usergroup_edit_usergroupmemberships_v1( + self, + pki_usergroup_id: Annotated[int, Field(le=255, strict=True, ge=0)], + usergroup_edit_usergroupmemberships_v1_request: UsergroupEditUsergroupmembershipsV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> UsergroupEditUsergroupmembershipsV1Response: + """Edit multiple Usergroupmemberships - >>> thread = api.usergroup_edit_usergroupmemberships_v1(pki_usergroup_id, usergroup_edit_usergroupmemberships_v1_request, async_req=True) - >>> result = thread.get() + Using this endpoint, you can edit multiple Usergroupmemberships at the same time. :param pki_usergroup_id: (required) :type pki_usergroup_id: int :param usergroup_edit_usergroupmemberships_v1_request: (required) :type usergroup_edit_usergroupmemberships_v1_request: UsergroupEditUsergroupmembershipsV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: UsergroupEditUsergroupmembershipsV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the usergroup_edit_usergroupmemberships_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.usergroup_edit_usergroupmemberships_v1_with_http_info(pki_usergroup_id, usergroup_edit_usergroupmemberships_v1_request, **kwargs) # noqa: E501 - - @validate_arguments - def usergroup_edit_usergroupmemberships_v1_with_http_info(self, pki_usergroup_id : conint(strict=True, le=255, ge=0), usergroup_edit_usergroupmemberships_v1_request : UsergroupEditUsergroupmembershipsV1Request, **kwargs) -> ApiResponse: # noqa: E501 - """Edit multiple Usergroupmemberships # noqa: E501 - - Using this endpoint, you can edit multiple Usergroupmemberships at the same time. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.usergroup_edit_usergroupmemberships_v1_with_http_info(pki_usergroup_id, usergroup_edit_usergroupmemberships_v1_request, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._usergroup_edit_usergroupmemberships_v1_serialize( + pki_usergroup_id=pki_usergroup_id, + usergroup_edit_usergroupmemberships_v1_request=usergroup_edit_usergroupmemberships_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "UsergroupEditUsergroupmembershipsV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def usergroup_edit_usergroupmemberships_v1_with_http_info( + self, + pki_usergroup_id: Annotated[int, Field(le=255, strict=True, ge=0)], + usergroup_edit_usergroupmemberships_v1_request: UsergroupEditUsergroupmembershipsV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[UsergroupEditUsergroupmembershipsV1Response]: + """Edit multiple Usergroupmemberships + + Using this endpoint, you can edit multiple Usergroupmemberships at the same time. :param pki_usergroup_id: (required) :type pki_usergroup_id: int :param usergroup_edit_usergroupmemberships_v1_request: (required) :type usergroup_edit_usergroupmemberships_v1_request: UsergroupEditUsergroupmembershipsV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(UsergroupEditUsergroupmembershipsV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._usergroup_edit_usergroupmemberships_v1_serialize( + pki_usergroup_id=pki_usergroup_id, + usergroup_edit_usergroupmemberships_v1_request=usergroup_edit_usergroupmemberships_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "UsergroupEditUsergroupmembershipsV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _params = locals() - _all_params = [ - 'pki_usergroup_id', - 'usergroup_edit_usergroupmemberships_v1_request' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + @validate_call + def usergroup_edit_usergroupmemberships_v1_without_preload_content( + self, + pki_usergroup_id: Annotated[int, Field(le=255, strict=True, ge=0)], + usergroup_edit_usergroupmemberships_v1_request: UsergroupEditUsergroupmembershipsV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Edit multiple Usergroupmemberships + + Using this endpoint, you can edit multiple Usergroupmemberships at the same time. + + :param pki_usergroup_id: (required) + :type pki_usergroup_id: int + :param usergroup_edit_usergroupmemberships_v1_request: (required) + :type usergroup_edit_usergroupmemberships_v1_request: UsergroupEditUsergroupmembershipsV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._usergroup_edit_usergroupmemberships_v1_serialize( + pki_usergroup_id=pki_usergroup_id, + usergroup_edit_usergroupmemberships_v1_request=usergroup_edit_usergroupmemberships_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method usergroup_edit_usergroupmemberships_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "UsergroupEditUsergroupmembershipsV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_usergroup_id']: - _path_params['pkiUsergroupID'] = _params['pki_usergroup_id'] + def _usergroup_edit_usergroupmemberships_v1_serialize( + self, + pki_usergroup_id, + usergroup_edit_usergroupmemberships_v1_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if pki_usergroup_id is not None: + _path_params['pkiUsergroupID'] = pki_usergroup_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['usergroup_edit_usergroupmemberships_v1_request'] is not None: - _body_params = _params['usergroup_edit_usergroupmemberships_v1_request'] + if usergroup_edit_usergroupmemberships_v1_request is not None: + _body_params = usergroup_edit_usergroupmemberships_v1_request + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '200': "UsergroupEditUsergroupmembershipsV1Response", - '404': "CommonResponseError", - '422': "CommonResponseError", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/usergroup/{pkiUsergroupID}/editUsergroupmemberships', 'PUT', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='PUT', + resource_path='/1/object/usergroup/{pkiUsergroupID}/editUsergroupmemberships', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) - @validate_arguments - def usergroup_get_autocomplete_v2(self, s_selector : Annotated[StrictStr, Field(..., description="The type of Usergroups to return")], e_filter_active : Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, s_query : Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, accept_language : Optional[HeaderAcceptLanguage] = None, **kwargs) -> UsergroupGetAutocompleteV2Response: # noqa: E501 - """Retrieve Usergroups and IDs # noqa: E501 - Get the list of Usergroup to be used in a dropdown or autocomplete control. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.usergroup_get_autocomplete_v2(s_selector, e_filter_active, s_query, accept_language, async_req=True) - >>> result = thread.get() + + @validate_call + def usergroup_get_autocomplete_v2( + self, + s_selector: Annotated[StrictStr, Field(description="The type of Usergroups to return")], + e_filter_active: Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, + s_query: Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> UsergroupGetAutocompleteV2Response: + """Retrieve Usergroups and IDs + + Get the list of Usergroup to be used in a dropdown or autocomplete control. :param s_selector: The type of Usergroups to return (required) :type s_selector: str @@ -856,33 +1537,76 @@ def usergroup_get_autocomplete_v2(self, s_selector : Annotated[StrictStr, Field( :type s_query: str :param accept_language: :type accept_language: HeaderAcceptLanguage - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: UsergroupGetAutocompleteV2Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the usergroup_get_autocomplete_v2_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.usergroup_get_autocomplete_v2_with_http_info(s_selector, e_filter_active, s_query, accept_language, **kwargs) # noqa: E501 - - @validate_arguments - def usergroup_get_autocomplete_v2_with_http_info(self, s_selector : Annotated[StrictStr, Field(..., description="The type of Usergroups to return")], e_filter_active : Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, s_query : Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, accept_language : Optional[HeaderAcceptLanguage] = None, **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve Usergroups and IDs # noqa: E501 - - Get the list of Usergroup to be used in a dropdown or autocomplete control. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.usergroup_get_autocomplete_v2_with_http_info(s_selector, e_filter_active, s_query, accept_language, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._usergroup_get_autocomplete_v2_serialize( + s_selector=s_selector, + e_filter_active=e_filter_active, + s_query=s_query, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "UsergroupGetAutocompleteV2Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def usergroup_get_autocomplete_v2_with_http_info( + self, + s_selector: Annotated[StrictStr, Field(description="The type of Usergroups to return")], + e_filter_active: Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, + s_query: Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[UsergroupGetAutocompleteV2Response]: + """Retrieve Usergroups and IDs + + Get the list of Usergroup to be used in a dropdown or autocomplete control. :param s_selector: The type of Usergroups to return (required) :type s_selector: str @@ -892,125 +1616,226 @@ def usergroup_get_autocomplete_v2_with_http_info(self, s_selector : Annotated[St :type s_query: str :param accept_language: :type accept_language: HeaderAcceptLanguage - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(UsergroupGetAutocompleteV2Response, status_code(int), headers(HTTPHeaderDict)) - """ - - _params = locals() - - _all_params = [ - 's_selector', - 'e_filter_active', - 's_query', - 'accept_language' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + """ # noqa: E501 + + _param = self._usergroup_get_autocomplete_v2_serialize( + s_selector=s_selector, + e_filter_active=e_filter_active, + s_query=s_query, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "UsergroupGetAutocompleteV2Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def usergroup_get_autocomplete_v2_without_preload_content( + self, + s_selector: Annotated[StrictStr, Field(description="The type of Usergroups to return")], + e_filter_active: Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, + s_query: Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve Usergroups and IDs + + Get the list of Usergroup to be used in a dropdown or autocomplete control. + + :param s_selector: The type of Usergroups to return (required) + :type s_selector: str + :param e_filter_active: Specify which results we want to display. + :type e_filter_active: str + :param s_query: Allow to filter the returned results + :type s_query: str + :param accept_language: + :type accept_language: HeaderAcceptLanguage + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._usergroup_get_autocomplete_v2_serialize( + s_selector=s_selector, + e_filter_active=e_filter_active, + s_query=s_query, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method usergroup_get_autocomplete_v2" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "UsergroupGetAutocompleteV2Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['s_selector']: - _path_params['sSelector'] = _params['s_selector'] + def _usergroup_get_autocomplete_v2_serialize( + self, + s_selector, + e_filter_active, + s_query, + accept_language, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None - # process the query parameters - _query_params = [] - if _params.get('e_filter_active') is not None: # noqa: E501 - _query_params.append(('eFilterActive', _params['e_filter_active'])) + _collection_formats: Dict[str, str] = { + } - if _params.get('s_query') is not None: # noqa: E501 - _query_params.append(('sQuery', _params['s_query'])) + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if s_selector is not None: + _path_params['sSelector'] = s_selector + # process the query parameters + if e_filter_active is not None: + + _query_params.append(('eFilterActive', e_filter_active)) + + if s_query is not None: + + _query_params.append(('sQuery', s_query)) + # process the header parameters - _header_params = dict(_params.get('_headers', {})) - if _params['accept_language']: - _header_params['Accept-Language'] = _params['accept_language'] - + if accept_language is not None: + _header_params['Accept-Language'] = accept_language # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "UsergroupGetAutocompleteV2Response", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/2/object/usergroup/getAutocomplete/{sSelector}', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/2/object/usergroup/getAutocomplete/{sSelector}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + - @validate_arguments - def usergroup_get_list_v1(self, e_order_by : Annotated[Optional[StrictStr], Field(description="Specify how you want the results to be sorted")] = None, i_row_max : Optional[conint(strict=True, le=10000, ge=1)] = None, i_row_offset : Optional[conint(strict=True, ge=0)] = None, accept_language : Optional[HeaderAcceptLanguage] = None, s_filter : Optional[StrictStr] = None, **kwargs) -> UsergroupGetListV1Response: # noqa: E501 - """Retrieve Usergroup list # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.usergroup_get_list_v1(e_order_by, i_row_max, i_row_offset, accept_language, s_filter, async_req=True) - >>> result = thread.get() + @validate_call + def usergroup_get_list_v1( + self, + e_order_by: Annotated[Optional[StrictStr], Field(description="Specify how you want the results to be sorted")] = None, + i_row_max: Optional[Annotated[int, Field(le=10000, strict=True, ge=1)]] = None, + i_row_offset: Optional[Annotated[int, Field(strict=True, ge=0)]] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + s_filter: Optional[StrictStr] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> UsergroupGetListV1Response: + """Retrieve Usergroup list + + :param e_order_by: Specify how you want the results to be sorted :type e_order_by: str @@ -1022,33 +1847,79 @@ def usergroup_get_list_v1(self, e_order_by : Annotated[Optional[StrictStr], Fiel :type accept_language: HeaderAcceptLanguage :param s_filter: :type s_filter: str - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: UsergroupGetListV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the usergroup_get_list_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.usergroup_get_list_v1_with_http_info(e_order_by, i_row_max, i_row_offset, accept_language, s_filter, **kwargs) # noqa: E501 - - @validate_arguments - def usergroup_get_list_v1_with_http_info(self, e_order_by : Annotated[Optional[StrictStr], Field(description="Specify how you want the results to be sorted")] = None, i_row_max : Optional[conint(strict=True, le=10000, ge=1)] = None, i_row_offset : Optional[conint(strict=True, ge=0)] = None, accept_language : Optional[HeaderAcceptLanguage] = None, s_filter : Optional[StrictStr] = None, **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve Usergroup list # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.usergroup_get_list_v1_with_http_info(e_order_by, i_row_max, i_row_offset, accept_language, s_filter, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._usergroup_get_list_v1_serialize( + e_order_by=e_order_by, + i_row_max=i_row_max, + i_row_offset=i_row_offset, + accept_language=accept_language, + s_filter=s_filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "UsergroupGetListV1Response", + '406': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def usergroup_get_list_v1_with_http_info( + self, + e_order_by: Annotated[Optional[StrictStr], Field(description="Specify how you want the results to be sorted")] = None, + i_row_max: Optional[Annotated[int, Field(le=10000, strict=True, ge=1)]] = None, + i_row_offset: Optional[Annotated[int, Field(strict=True, ge=0)]] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + s_filter: Optional[StrictStr] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[UsergroupGetListV1Response]: + """Retrieve Usergroup list + + :param e_order_by: Specify how you want the results to be sorted :type e_order_by: str @@ -1060,674 +1931,1247 @@ def usergroup_get_list_v1_with_http_info(self, e_order_by : Annotated[Optional[S :type accept_language: HeaderAcceptLanguage :param s_filter: :type s_filter: str - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(UsergroupGetListV1Response, status_code(int), headers(HTTPHeaderDict)) - """ - - _params = locals() - - _all_params = [ - 'e_order_by', - 'i_row_max', - 'i_row_offset', - 'accept_language', - 's_filter' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' - ] + """ # noqa: E501 + + _param = self._usergroup_get_list_v1_serialize( + e_order_by=e_order_by, + i_row_max=i_row_max, + i_row_offset=i_row_offset, + accept_language=accept_language, + s_filter=s_filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method usergroup_get_list_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "UsergroupGetListV1Response", + '406': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _collection_formats = {} - # process the path parameters - _path_params = {} + @validate_call + def usergroup_get_list_v1_without_preload_content( + self, + e_order_by: Annotated[Optional[StrictStr], Field(description="Specify how you want the results to be sorted")] = None, + i_row_max: Optional[Annotated[int, Field(le=10000, strict=True, ge=1)]] = None, + i_row_offset: Optional[Annotated[int, Field(strict=True, ge=0)]] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + s_filter: Optional[StrictStr] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve Usergroup list - # process the query parameters - _query_params = [] - if _params.get('e_order_by') is not None: # noqa: E501 - _query_params.append(('eOrderBy', _params['e_order_by'])) + - if _params.get('i_row_max') is not None: # noqa: E501 - _query_params.append(('iRowMax', _params['i_row_max'])) + :param e_order_by: Specify how you want the results to be sorted + :type e_order_by: str + :param i_row_max: + :type i_row_max: int + :param i_row_offset: + :type i_row_offset: int + :param accept_language: + :type accept_language: HeaderAcceptLanguage + :param s_filter: + :type s_filter: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._usergroup_get_list_v1_serialize( + e_order_by=e_order_by, + i_row_max=i_row_max, + i_row_offset=i_row_offset, + accept_language=accept_language, + s_filter=s_filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - if _params.get('i_row_offset') is not None: # noqa: E501 - _query_params.append(('iRowOffset', _params['i_row_offset'])) + _response_types_map: Dict[str, Optional[str]] = { + '200': "UsergroupGetListV1Response", + '406': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - if _params.get('s_filter') is not None: # noqa: E501 - _query_params.append(('sFilter', _params['s_filter'])) - # process the header parameters - _header_params = dict(_params.get('_headers', {})) - if _params['accept_language']: - _header_params['Accept-Language'] = _params['accept_language'] + def _usergroup_get_list_v1_serialize( + self, + e_order_by, + i_row_max, + i_row_offset, + accept_language, + s_filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if e_order_by is not None: + + _query_params.append(('eOrderBy', e_order_by)) + + if i_row_max is not None: + + _query_params.append(('iRowMax', i_row_max)) + + if i_row_offset is not None: + + _query_params.append(('iRowOffset', i_row_offset)) + + if s_filter is not None: + + _query_params.append(('sFilter', s_filter)) + + # process the header parameters + if accept_language is not None: + _header_params['Accept-Language'] = accept_language # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet']) # noqa: E501 + [ + 'application/json', + 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "UsergroupGetListV1Response", - '406': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/usergroup/getList', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/1/object/usergroup/getList', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + - @validate_arguments - def usergroup_get_object_v2(self, pki_usergroup_id : conint(strict=True, le=255, ge=0), **kwargs) -> UsergroupGetObjectV2Response: # noqa: E501 - """Retrieve an existing Usergroup # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.usergroup_get_object_v2(pki_usergroup_id, async_req=True) - >>> result = thread.get() + @validate_call + def usergroup_get_object_v2( + self, + pki_usergroup_id: Annotated[int, Field(le=255, strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> UsergroupGetObjectV2Response: + """Retrieve an existing Usergroup + + :param pki_usergroup_id: (required) :type pki_usergroup_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: UsergroupGetObjectV2Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the usergroup_get_object_v2_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.usergroup_get_object_v2_with_http_info(pki_usergroup_id, **kwargs) # noqa: E501 - - @validate_arguments - def usergroup_get_object_v2_with_http_info(self, pki_usergroup_id : conint(strict=True, le=255, ge=0), **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve an existing Usergroup # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.usergroup_get_object_v2_with_http_info(pki_usergroup_id, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._usergroup_get_object_v2_serialize( + pki_usergroup_id=pki_usergroup_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "UsergroupGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def usergroup_get_object_v2_with_http_info( + self, + pki_usergroup_id: Annotated[int, Field(le=255, strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[UsergroupGetObjectV2Response]: + """Retrieve an existing Usergroup + + :param pki_usergroup_id: (required) :type pki_usergroup_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(UsergroupGetObjectV2Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._usergroup_get_object_v2_serialize( + pki_usergroup_id=pki_usergroup_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "UsergroupGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _params = locals() - _all_params = [ - 'pki_usergroup_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + @validate_call + def usergroup_get_object_v2_without_preload_content( + self, + pki_usergroup_id: Annotated[int, Field(le=255, strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve an existing Usergroup + + + + :param pki_usergroup_id: (required) + :type pki_usergroup_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._usergroup_get_object_v2_serialize( + pki_usergroup_id=pki_usergroup_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method usergroup_get_object_v2" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "UsergroupGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_usergroup_id']: - _path_params['pkiUsergroupID'] = _params['pki_usergroup_id'] + def _usergroup_get_object_v2_serialize( + self, + pki_usergroup_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_usergroup_id is not None: + _path_params['pkiUsergroupID'] = pki_usergroup_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "UsergroupGetObjectV2Response", - '404': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/2/object/usergroup/{pkiUsergroupID}', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/2/object/usergroup/{pkiUsergroupID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + - @validate_arguments - def usergroup_get_permissions_v1(self, pki_usergroup_id : conint(strict=True, le=255, ge=0), **kwargs) -> UsergroupGetPermissionsV1Response: # noqa: E501 - """Retrieve an existing Usergroup's Permissions # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.usergroup_get_permissions_v1(pki_usergroup_id, async_req=True) - >>> result = thread.get() + @validate_call + def usergroup_get_permissions_v1( + self, + pki_usergroup_id: Annotated[int, Field(le=255, strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> UsergroupGetPermissionsV1Response: + """Retrieve an existing Usergroup's Permissions + :param pki_usergroup_id: (required) :type pki_usergroup_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: UsergroupGetPermissionsV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the usergroup_get_permissions_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.usergroup_get_permissions_v1_with_http_info(pki_usergroup_id, **kwargs) # noqa: E501 - - @validate_arguments - def usergroup_get_permissions_v1_with_http_info(self, pki_usergroup_id : conint(strict=True, le=255, ge=0), **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve an existing Usergroup's Permissions # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.usergroup_get_permissions_v1_with_http_info(pki_usergroup_id, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._usergroup_get_permissions_v1_serialize( + pki_usergroup_id=pki_usergroup_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "UsergroupGetPermissionsV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def usergroup_get_permissions_v1_with_http_info( + self, + pki_usergroup_id: Annotated[int, Field(le=255, strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[UsergroupGetPermissionsV1Response]: + """Retrieve an existing Usergroup's Permissions + :param pki_usergroup_id: (required) :type pki_usergroup_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(UsergroupGetPermissionsV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._usergroup_get_permissions_v1_serialize( + pki_usergroup_id=pki_usergroup_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '200': "UsergroupGetPermissionsV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'pki_usergroup_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def usergroup_get_permissions_v1_without_preload_content( + self, + pki_usergroup_id: Annotated[int, Field(le=255, strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve an existing Usergroup's Permissions + + + :param pki_usergroup_id: (required) + :type pki_usergroup_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._usergroup_get_permissions_v1_serialize( + pki_usergroup_id=pki_usergroup_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method usergroup_get_permissions_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "UsergroupGetPermissionsV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_usergroup_id']: - _path_params['pkiUsergroupID'] = _params['pki_usergroup_id'] + def _usergroup_get_permissions_v1_serialize( + self, + pki_usergroup_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_usergroup_id is not None: + _path_params['pkiUsergroupID'] = pki_usergroup_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "UsergroupGetPermissionsV1Response", - '404': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/usergroup/{pkiUsergroupID}/getPermissions', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/1/object/usergroup/{pkiUsergroupID}/getPermissions', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) - @validate_arguments - def usergroup_get_usergroupdelegations_v1(self, pki_usergroup_id : conint(strict=True, le=255, ge=0), **kwargs) -> UsergroupGetUsergroupdelegationsV1Response: # noqa: E501 - """Retrieve an existing Usergroup's Usergroupdelegations # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.usergroup_get_usergroupdelegations_v1(pki_usergroup_id, async_req=True) - >>> result = thread.get() + + @validate_call + def usergroup_get_usergroupdelegations_v1( + self, + pki_usergroup_id: Annotated[int, Field(le=255, strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> UsergroupGetUsergroupdelegationsV1Response: + """Retrieve an existing Usergroup's Usergroupdelegations + :param pki_usergroup_id: (required) :type pki_usergroup_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: UsergroupGetUsergroupdelegationsV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the usergroup_get_usergroupdelegations_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.usergroup_get_usergroupdelegations_v1_with_http_info(pki_usergroup_id, **kwargs) # noqa: E501 - - @validate_arguments - def usergroup_get_usergroupdelegations_v1_with_http_info(self, pki_usergroup_id : conint(strict=True, le=255, ge=0), **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve an existing Usergroup's Usergroupdelegations # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.usergroup_get_usergroupdelegations_v1_with_http_info(pki_usergroup_id, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._usergroup_get_usergroupdelegations_v1_serialize( + pki_usergroup_id=pki_usergroup_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "UsergroupGetUsergroupdelegationsV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def usergroup_get_usergroupdelegations_v1_with_http_info( + self, + pki_usergroup_id: Annotated[int, Field(le=255, strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[UsergroupGetUsergroupdelegationsV1Response]: + """Retrieve an existing Usergroup's Usergroupdelegations + :param pki_usergroup_id: (required) :type pki_usergroup_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(UsergroupGetUsergroupdelegationsV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._usergroup_get_usergroupdelegations_v1_serialize( + pki_usergroup_id=pki_usergroup_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '200': "UsergroupGetUsergroupdelegationsV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'pki_usergroup_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def usergroup_get_usergroupdelegations_v1_without_preload_content( + self, + pki_usergroup_id: Annotated[int, Field(le=255, strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve an existing Usergroup's Usergroupdelegations + + + :param pki_usergroup_id: (required) + :type pki_usergroup_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._usergroup_get_usergroupdelegations_v1_serialize( + pki_usergroup_id=pki_usergroup_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method usergroup_get_usergroupdelegations_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "UsergroupGetUsergroupdelegationsV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_usergroup_id']: - _path_params['pkiUsergroupID'] = _params['pki_usergroup_id'] + def _usergroup_get_usergroupdelegations_v1_serialize( + self, + pki_usergroup_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if pki_usergroup_id is not None: + _path_params['pkiUsergroupID'] = pki_usergroup_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "UsergroupGetUsergroupdelegationsV1Response", - '404': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/usergroup/{pkiUsergroupID}/getUsergroupdelegations', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/1/object/usergroup/{pkiUsergroupID}/getUsergroupdelegations', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) - @validate_arguments - def usergroup_get_usergroupmemberships_v1(self, pki_usergroup_id : conint(strict=True, le=255, ge=0), **kwargs) -> UsergroupGetUsergroupmembershipsV1Response: # noqa: E501 - """Retrieve an existing Usergroup's Usergroupmemberships # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.usergroup_get_usergroupmemberships_v1(pki_usergroup_id, async_req=True) - >>> result = thread.get() + + @validate_call + def usergroup_get_usergroupmemberships_v1( + self, + pki_usergroup_id: Annotated[int, Field(le=255, strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> UsergroupGetUsergroupmembershipsV1Response: + """Retrieve an existing Usergroup's Usergroupmemberships + :param pki_usergroup_id: (required) :type pki_usergroup_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: UsergroupGetUsergroupmembershipsV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the usergroup_get_usergroupmemberships_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.usergroup_get_usergroupmemberships_v1_with_http_info(pki_usergroup_id, **kwargs) # noqa: E501 - - @validate_arguments - def usergroup_get_usergroupmemberships_v1_with_http_info(self, pki_usergroup_id : conint(strict=True, le=255, ge=0), **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve an existing Usergroup's Usergroupmemberships # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.usergroup_get_usergroupmemberships_v1_with_http_info(pki_usergroup_id, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._usergroup_get_usergroupmemberships_v1_serialize( + pki_usergroup_id=pki_usergroup_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "UsergroupGetUsergroupmembershipsV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def usergroup_get_usergroupmemberships_v1_with_http_info( + self, + pki_usergroup_id: Annotated[int, Field(le=255, strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[UsergroupGetUsergroupmembershipsV1Response]: + """Retrieve an existing Usergroup's Usergroupmemberships + :param pki_usergroup_id: (required) :type pki_usergroup_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(UsergroupGetUsergroupmembershipsV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._usergroup_get_usergroupmemberships_v1_serialize( + pki_usergroup_id=pki_usergroup_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '200': "UsergroupGetUsergroupmembershipsV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'pki_usergroup_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def usergroup_get_usergroupmemberships_v1_without_preload_content( + self, + pki_usergroup_id: Annotated[int, Field(le=255, strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve an existing Usergroup's Usergroupmemberships + + + :param pki_usergroup_id: (required) + :type pki_usergroup_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._usergroup_get_usergroupmemberships_v1_serialize( + pki_usergroup_id=pki_usergroup_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method usergroup_get_usergroupmemberships_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "UsergroupGetUsergroupmembershipsV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_usergroup_id']: - _path_params['pkiUsergroupID'] = _params['pki_usergroup_id'] + def _usergroup_get_usergroupmemberships_v1_serialize( + self, + pki_usergroup_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None + + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_usergroup_id is not None: + _path_params['pkiUsergroupID'] = pki_usergroup_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "UsergroupGetUsergroupmembershipsV1Response", - '404': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/usergroup/{pkiUsergroupID}/getUsergroupmemberships', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/1/object/usergroup/{pkiUsergroupID}/getUsergroupmemberships', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/eZmaxApi/api/object_usergroupdelegation_api.py b/eZmaxApi/api/object_usergroupdelegation_api.py index bc1526c08..6f8aa9f36 100644 --- a/eZmaxApi/api/object_usergroupdelegation_api.py +++ b/eZmaxApi/api/object_usergroupdelegation_api.py @@ -13,15 +13,19 @@ """ # noqa: E501 -import re # noqa: F401 import io import warnings -from pydantic import validate_arguments, ValidationError +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Dict, List, Optional, Tuple, Union, Any -from typing_extensions import Annotated -from pydantic import Field, conint +try: + from typing import Annotated +except ImportError: + from typing_extensions import Annotated +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.usergroupdelegation_create_object_v1_request import UsergroupdelegationCreateObjectV1Request from eZmaxApi.models.usergroupdelegation_create_object_v1_response import UsergroupdelegationCreateObjectV1Response from eZmaxApi.models.usergroupdelegation_delete_object_v1_response import UsergroupdelegationDeleteObjectV1Response @@ -31,10 +35,7 @@ from eZmaxApi.api_client import ApiClient from eZmaxApi.api_response import ApiResponse -from eZmaxApi.exceptions import ( # noqa: F401 - ApiTypeError, - ApiValueError -) +from eZmaxApi.rest import RESTResponseType class ObjectUsergroupdelegationApi: @@ -49,588 +50,1087 @@ def __init__(self, api_client=None) -> None: api_client = ApiClient.get_default() self.api_client = api_client - @validate_arguments - def usergroupdelegation_create_object_v1(self, usergroupdelegation_create_object_v1_request : UsergroupdelegationCreateObjectV1Request, **kwargs) -> UsergroupdelegationCreateObjectV1Response: # noqa: E501 - """Create a new Usergroupdelegation # noqa: E501 - The endpoint allows to create one or many elements at once. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def usergroupdelegation_create_object_v1( + self, + usergroupdelegation_create_object_v1_request: UsergroupdelegationCreateObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> UsergroupdelegationCreateObjectV1Response: + """Create a new Usergroupdelegation - >>> thread = api.usergroupdelegation_create_object_v1(usergroupdelegation_create_object_v1_request, async_req=True) - >>> result = thread.get() + The endpoint allows to create one or many elements at once. :param usergroupdelegation_create_object_v1_request: (required) :type usergroupdelegation_create_object_v1_request: UsergroupdelegationCreateObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: UsergroupdelegationCreateObjectV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the usergroupdelegation_create_object_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.usergroupdelegation_create_object_v1_with_http_info(usergroupdelegation_create_object_v1_request, **kwargs) # noqa: E501 - - @validate_arguments - def usergroupdelegation_create_object_v1_with_http_info(self, usergroupdelegation_create_object_v1_request : UsergroupdelegationCreateObjectV1Request, **kwargs) -> ApiResponse: # noqa: E501 - """Create a new Usergroupdelegation # noqa: E501 - - The endpoint allows to create one or many elements at once. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.usergroupdelegation_create_object_v1_with_http_info(usergroupdelegation_create_object_v1_request, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._usergroupdelegation_create_object_v1_serialize( + usergroupdelegation_create_object_v1_request=usergroupdelegation_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "UsergroupdelegationCreateObjectV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def usergroupdelegation_create_object_v1_with_http_info( + self, + usergroupdelegation_create_object_v1_request: UsergroupdelegationCreateObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[UsergroupdelegationCreateObjectV1Response]: + """Create a new Usergroupdelegation + + The endpoint allows to create one or many elements at once. :param usergroupdelegation_create_object_v1_request: (required) :type usergroupdelegation_create_object_v1_request: UsergroupdelegationCreateObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(UsergroupdelegationCreateObjectV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._usergroupdelegation_create_object_v1_serialize( + usergroupdelegation_create_object_v1_request=usergroupdelegation_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '201': "UsergroupdelegationCreateObjectV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'usergroupdelegation_create_object_v1_request' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def usergroupdelegation_create_object_v1_without_preload_content( + self, + usergroupdelegation_create_object_v1_request: UsergroupdelegationCreateObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Create a new Usergroupdelegation + + The endpoint allows to create one or many elements at once. + + :param usergroupdelegation_create_object_v1_request: (required) + :type usergroupdelegation_create_object_v1_request: UsergroupdelegationCreateObjectV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._usergroupdelegation_create_object_v1_serialize( + usergroupdelegation_create_object_v1_request=usergroupdelegation_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method usergroupdelegation_create_object_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '201': "UsergroupdelegationCreateObjectV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} + def _usergroupdelegation_create_object_v1_serialize( + self, + usergroupdelegation_create_object_v1_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['usergroupdelegation_create_object_v1_request'] is not None: - _body_params = _params['usergroupdelegation_create_object_v1_request'] + if usergroupdelegation_create_object_v1_request is not None: + _body_params = usergroupdelegation_create_object_v1_request + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '201': "UsergroupdelegationCreateObjectV1Response", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/usergroupdelegation', 'POST', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='POST', + resource_path='/1/object/usergroupdelegation', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) - @validate_arguments - def usergroupdelegation_delete_object_v1(self, pki_usergroupdelegation_id : Annotated[conint(strict=True, le=65535, ge=0), Field(..., description="The unique ID of the Usergroupdelegation")], **kwargs) -> UsergroupdelegationDeleteObjectV1Response: # noqa: E501 - """Delete an existing Usergroupdelegation # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.usergroupdelegation_delete_object_v1(pki_usergroupdelegation_id, async_req=True) - >>> result = thread.get() + + @validate_call + def usergroupdelegation_delete_object_v1( + self, + pki_usergroupdelegation_id: Annotated[int, Field(le=65535, strict=True, ge=0, description="The unique ID of the Usergroupdelegation")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> UsergroupdelegationDeleteObjectV1Response: + """Delete an existing Usergroupdelegation + + :param pki_usergroupdelegation_id: The unique ID of the Usergroupdelegation (required) :type pki_usergroupdelegation_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: UsergroupdelegationDeleteObjectV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the usergroupdelegation_delete_object_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.usergroupdelegation_delete_object_v1_with_http_info(pki_usergroupdelegation_id, **kwargs) # noqa: E501 - - @validate_arguments - def usergroupdelegation_delete_object_v1_with_http_info(self, pki_usergroupdelegation_id : Annotated[conint(strict=True, le=65535, ge=0), Field(..., description="The unique ID of the Usergroupdelegation")], **kwargs) -> ApiResponse: # noqa: E501 - """Delete an existing Usergroupdelegation # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.usergroupdelegation_delete_object_v1_with_http_info(pki_usergroupdelegation_id, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._usergroupdelegation_delete_object_v1_serialize( + pki_usergroupdelegation_id=pki_usergroupdelegation_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "UsergroupdelegationDeleteObjectV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def usergroupdelegation_delete_object_v1_with_http_info( + self, + pki_usergroupdelegation_id: Annotated[int, Field(le=65535, strict=True, ge=0, description="The unique ID of the Usergroupdelegation")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[UsergroupdelegationDeleteObjectV1Response]: + """Delete an existing Usergroupdelegation + + :param pki_usergroupdelegation_id: The unique ID of the Usergroupdelegation (required) :type pki_usergroupdelegation_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(UsergroupdelegationDeleteObjectV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._usergroupdelegation_delete_object_v1_serialize( + pki_usergroupdelegation_id=pki_usergroupdelegation_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "UsergroupdelegationDeleteObjectV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _params = locals() - _all_params = [ - 'pki_usergroupdelegation_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + @validate_call + def usergroupdelegation_delete_object_v1_without_preload_content( + self, + pki_usergroupdelegation_id: Annotated[int, Field(le=65535, strict=True, ge=0, description="The unique ID of the Usergroupdelegation")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete an existing Usergroupdelegation + + + + :param pki_usergroupdelegation_id: The unique ID of the Usergroupdelegation (required) + :type pki_usergroupdelegation_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._usergroupdelegation_delete_object_v1_serialize( + pki_usergroupdelegation_id=pki_usergroupdelegation_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method usergroupdelegation_delete_object_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "UsergroupdelegationDeleteObjectV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_usergroupdelegation_id']: - _path_params['pkiUsergroupdelegationID'] = _params['pki_usergroupdelegation_id'] + def _usergroupdelegation_delete_object_v1_serialize( + self, + pki_usergroupdelegation_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_usergroupdelegation_id is not None: + _path_params['pkiUsergroupdelegationID'] = pki_usergroupdelegation_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "UsergroupdelegationDeleteObjectV1Response", - '404': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/usergroupdelegation/{pkiUsergroupdelegationID}', 'DELETE', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='DELETE', + resource_path='/1/object/usergroupdelegation/{pkiUsergroupdelegationID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + - @validate_arguments - def usergroupdelegation_edit_object_v1(self, pki_usergroupdelegation_id : Annotated[conint(strict=True, le=65535, ge=0), Field(..., description="The unique ID of the Usergroupdelegation")], usergroupdelegation_edit_object_v1_request : UsergroupdelegationEditObjectV1Request, **kwargs) -> UsergroupdelegationEditObjectV1Response: # noqa: E501 - """Edit an existing Usergroupdelegation # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.usergroupdelegation_edit_object_v1(pki_usergroupdelegation_id, usergroupdelegation_edit_object_v1_request, async_req=True) - >>> result = thread.get() + @validate_call + def usergroupdelegation_edit_object_v1( + self, + pki_usergroupdelegation_id: Annotated[int, Field(le=65535, strict=True, ge=0, description="The unique ID of the Usergroupdelegation")], + usergroupdelegation_edit_object_v1_request: UsergroupdelegationEditObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> UsergroupdelegationEditObjectV1Response: + """Edit an existing Usergroupdelegation + + :param pki_usergroupdelegation_id: The unique ID of the Usergroupdelegation (required) :type pki_usergroupdelegation_id: int :param usergroupdelegation_edit_object_v1_request: (required) :type usergroupdelegation_edit_object_v1_request: UsergroupdelegationEditObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: UsergroupdelegationEditObjectV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the usergroupdelegation_edit_object_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.usergroupdelegation_edit_object_v1_with_http_info(pki_usergroupdelegation_id, usergroupdelegation_edit_object_v1_request, **kwargs) # noqa: E501 - - @validate_arguments - def usergroupdelegation_edit_object_v1_with_http_info(self, pki_usergroupdelegation_id : Annotated[conint(strict=True, le=65535, ge=0), Field(..., description="The unique ID of the Usergroupdelegation")], usergroupdelegation_edit_object_v1_request : UsergroupdelegationEditObjectV1Request, **kwargs) -> ApiResponse: # noqa: E501 - """Edit an existing Usergroupdelegation # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.usergroupdelegation_edit_object_v1_with_http_info(pki_usergroupdelegation_id, usergroupdelegation_edit_object_v1_request, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._usergroupdelegation_edit_object_v1_serialize( + pki_usergroupdelegation_id=pki_usergroupdelegation_id, + usergroupdelegation_edit_object_v1_request=usergroupdelegation_edit_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "UsergroupdelegationEditObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def usergroupdelegation_edit_object_v1_with_http_info( + self, + pki_usergroupdelegation_id: Annotated[int, Field(le=65535, strict=True, ge=0, description="The unique ID of the Usergroupdelegation")], + usergroupdelegation_edit_object_v1_request: UsergroupdelegationEditObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[UsergroupdelegationEditObjectV1Response]: + """Edit an existing Usergroupdelegation + + :param pki_usergroupdelegation_id: The unique ID of the Usergroupdelegation (required) :type pki_usergroupdelegation_id: int :param usergroupdelegation_edit_object_v1_request: (required) :type usergroupdelegation_edit_object_v1_request: UsergroupdelegationEditObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(UsergroupdelegationEditObjectV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._usergroupdelegation_edit_object_v1_serialize( + pki_usergroupdelegation_id=pki_usergroupdelegation_id, + usergroupdelegation_edit_object_v1_request=usergroupdelegation_edit_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "UsergroupdelegationEditObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _params = locals() - _all_params = [ - 'pki_usergroupdelegation_id', - 'usergroupdelegation_edit_object_v1_request' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + @validate_call + def usergroupdelegation_edit_object_v1_without_preload_content( + self, + pki_usergroupdelegation_id: Annotated[int, Field(le=65535, strict=True, ge=0, description="The unique ID of the Usergroupdelegation")], + usergroupdelegation_edit_object_v1_request: UsergroupdelegationEditObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Edit an existing Usergroupdelegation + + + + :param pki_usergroupdelegation_id: The unique ID of the Usergroupdelegation (required) + :type pki_usergroupdelegation_id: int + :param usergroupdelegation_edit_object_v1_request: (required) + :type usergroupdelegation_edit_object_v1_request: UsergroupdelegationEditObjectV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._usergroupdelegation_edit_object_v1_serialize( + pki_usergroupdelegation_id=pki_usergroupdelegation_id, + usergroupdelegation_edit_object_v1_request=usergroupdelegation_edit_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method usergroupdelegation_edit_object_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "UsergroupdelegationEditObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_usergroupdelegation_id']: - _path_params['pkiUsergroupdelegationID'] = _params['pki_usergroupdelegation_id'] + def _usergroupdelegation_edit_object_v1_serialize( + self, + pki_usergroupdelegation_id, + usergroupdelegation_edit_object_v1_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_usergroupdelegation_id is not None: + _path_params['pkiUsergroupdelegationID'] = pki_usergroupdelegation_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['usergroupdelegation_edit_object_v1_request'] is not None: - _body_params = _params['usergroupdelegation_edit_object_v1_request'] + if usergroupdelegation_edit_object_v1_request is not None: + _body_params = usergroupdelegation_edit_object_v1_request + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '200': "UsergroupdelegationEditObjectV1Response", - '404': "CommonResponseError", - '422': "CommonResponseError", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/usergroupdelegation/{pkiUsergroupdelegationID}', 'PUT', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='PUT', + resource_path='/1/object/usergroupdelegation/{pkiUsergroupdelegationID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + - @validate_arguments - def usergroupdelegation_get_object_v2(self, pki_usergroupdelegation_id : Annotated[conint(strict=True, le=65535, ge=0), Field(..., description="The unique ID of the Usergroupdelegation")], **kwargs) -> UsergroupdelegationGetObjectV2Response: # noqa: E501 - """Retrieve an existing Usergroupdelegation # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.usergroupdelegation_get_object_v2(pki_usergroupdelegation_id, async_req=True) - >>> result = thread.get() + @validate_call + def usergroupdelegation_get_object_v2( + self, + pki_usergroupdelegation_id: Annotated[int, Field(le=65535, strict=True, ge=0, description="The unique ID of the Usergroupdelegation")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> UsergroupdelegationGetObjectV2Response: + """Retrieve an existing Usergroupdelegation + + :param pki_usergroupdelegation_id: The unique ID of the Usergroupdelegation (required) :type pki_usergroupdelegation_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: UsergroupdelegationGetObjectV2Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the usergroupdelegation_get_object_v2_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.usergroupdelegation_get_object_v2_with_http_info(pki_usergroupdelegation_id, **kwargs) # noqa: E501 - - @validate_arguments - def usergroupdelegation_get_object_v2_with_http_info(self, pki_usergroupdelegation_id : Annotated[conint(strict=True, le=65535, ge=0), Field(..., description="The unique ID of the Usergroupdelegation")], **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve an existing Usergroupdelegation # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.usergroupdelegation_get_object_v2_with_http_info(pki_usergroupdelegation_id, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._usergroupdelegation_get_object_v2_serialize( + pki_usergroupdelegation_id=pki_usergroupdelegation_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "UsergroupdelegationGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def usergroupdelegation_get_object_v2_with_http_info( + self, + pki_usergroupdelegation_id: Annotated[int, Field(le=65535, strict=True, ge=0, description="The unique ID of the Usergroupdelegation")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[UsergroupdelegationGetObjectV2Response]: + """Retrieve an existing Usergroupdelegation + + :param pki_usergroupdelegation_id: The unique ID of the Usergroupdelegation (required) :type pki_usergroupdelegation_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(UsergroupdelegationGetObjectV2Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._usergroupdelegation_get_object_v2_serialize( + pki_usergroupdelegation_id=pki_usergroupdelegation_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '200': "UsergroupdelegationGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'pki_usergroupdelegation_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def usergroupdelegation_get_object_v2_without_preload_content( + self, + pki_usergroupdelegation_id: Annotated[int, Field(le=65535, strict=True, ge=0, description="The unique ID of the Usergroupdelegation")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve an existing Usergroupdelegation + + + + :param pki_usergroupdelegation_id: The unique ID of the Usergroupdelegation (required) + :type pki_usergroupdelegation_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._usergroupdelegation_get_object_v2_serialize( + pki_usergroupdelegation_id=pki_usergroupdelegation_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method usergroupdelegation_get_object_v2" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "UsergroupdelegationGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_usergroupdelegation_id']: - _path_params['pkiUsergroupdelegationID'] = _params['pki_usergroupdelegation_id'] + def _usergroupdelegation_get_object_v2_serialize( + self, + pki_usergroupdelegation_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_usergroupdelegation_id is not None: + _path_params['pkiUsergroupdelegationID'] = pki_usergroupdelegation_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "UsergroupdelegationGetObjectV2Response", - '404': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/2/object/usergroupdelegation/{pkiUsergroupdelegationID}', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/2/object/usergroupdelegation/{pkiUsergroupdelegationID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/eZmaxApi/api/object_usergroupmembership_api.py b/eZmaxApi/api/object_usergroupmembership_api.py index 5fca73682..96d37dedb 100644 --- a/eZmaxApi/api/object_usergroupmembership_api.py +++ b/eZmaxApi/api/object_usergroupmembership_api.py @@ -13,14 +13,19 @@ """ # noqa: E501 -import re # noqa: F401 import io import warnings -from pydantic import validate_arguments, ValidationError +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Dict, List, Optional, Tuple, Union, Any -from pydantic import conint +try: + from typing import Annotated +except ImportError: + from typing_extensions import Annotated +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.usergroupmembership_create_object_v1_request import UsergroupmembershipCreateObjectV1Request from eZmaxApi.models.usergroupmembership_create_object_v1_response import UsergroupmembershipCreateObjectV1Response from eZmaxApi.models.usergroupmembership_delete_object_v1_response import UsergroupmembershipDeleteObjectV1Response @@ -30,10 +35,7 @@ from eZmaxApi.api_client import ApiClient from eZmaxApi.api_response import ApiResponse -from eZmaxApi.exceptions import ( # noqa: F401 - ApiTypeError, - ApiValueError -) +from eZmaxApi.rest import RESTResponseType class ObjectUsergroupmembershipApi: @@ -48,588 +50,1087 @@ def __init__(self, api_client=None) -> None: api_client = ApiClient.get_default() self.api_client = api_client - @validate_arguments - def usergroupmembership_create_object_v1(self, usergroupmembership_create_object_v1_request : UsergroupmembershipCreateObjectV1Request, **kwargs) -> UsergroupmembershipCreateObjectV1Response: # noqa: E501 - """Create a new Usergroupmembership # noqa: E501 - The endpoint allows to create one or many elements at once. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def usergroupmembership_create_object_v1( + self, + usergroupmembership_create_object_v1_request: UsergroupmembershipCreateObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> UsergroupmembershipCreateObjectV1Response: + """Create a new Usergroupmembership - >>> thread = api.usergroupmembership_create_object_v1(usergroupmembership_create_object_v1_request, async_req=True) - >>> result = thread.get() + The endpoint allows to create one or many elements at once. :param usergroupmembership_create_object_v1_request: (required) :type usergroupmembership_create_object_v1_request: UsergroupmembershipCreateObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: UsergroupmembershipCreateObjectV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the usergroupmembership_create_object_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.usergroupmembership_create_object_v1_with_http_info(usergroupmembership_create_object_v1_request, **kwargs) # noqa: E501 - - @validate_arguments - def usergroupmembership_create_object_v1_with_http_info(self, usergroupmembership_create_object_v1_request : UsergroupmembershipCreateObjectV1Request, **kwargs) -> ApiResponse: # noqa: E501 - """Create a new Usergroupmembership # noqa: E501 - - The endpoint allows to create one or many elements at once. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.usergroupmembership_create_object_v1_with_http_info(usergroupmembership_create_object_v1_request, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._usergroupmembership_create_object_v1_serialize( + usergroupmembership_create_object_v1_request=usergroupmembership_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "UsergroupmembershipCreateObjectV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def usergroupmembership_create_object_v1_with_http_info( + self, + usergroupmembership_create_object_v1_request: UsergroupmembershipCreateObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[UsergroupmembershipCreateObjectV1Response]: + """Create a new Usergroupmembership + + The endpoint allows to create one or many elements at once. :param usergroupmembership_create_object_v1_request: (required) :type usergroupmembership_create_object_v1_request: UsergroupmembershipCreateObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(UsergroupmembershipCreateObjectV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._usergroupmembership_create_object_v1_serialize( + usergroupmembership_create_object_v1_request=usergroupmembership_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '201': "UsergroupmembershipCreateObjectV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'usergroupmembership_create_object_v1_request' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def usergroupmembership_create_object_v1_without_preload_content( + self, + usergroupmembership_create_object_v1_request: UsergroupmembershipCreateObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Create a new Usergroupmembership + + The endpoint allows to create one or many elements at once. + + :param usergroupmembership_create_object_v1_request: (required) + :type usergroupmembership_create_object_v1_request: UsergroupmembershipCreateObjectV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._usergroupmembership_create_object_v1_serialize( + usergroupmembership_create_object_v1_request=usergroupmembership_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method usergroupmembership_create_object_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '201': "UsergroupmembershipCreateObjectV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} + def _usergroupmembership_create_object_v1_serialize( + self, + usergroupmembership_create_object_v1_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['usergroupmembership_create_object_v1_request'] is not None: - _body_params = _params['usergroupmembership_create_object_v1_request'] + if usergroupmembership_create_object_v1_request is not None: + _body_params = usergroupmembership_create_object_v1_request + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '201': "UsergroupmembershipCreateObjectV1Response", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/usergroupmembership', 'POST', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='POST', + resource_path='/1/object/usergroupmembership', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) - @validate_arguments - def usergroupmembership_delete_object_v1(self, pki_usergroupmembership_id : conint(strict=True, le=65535, ge=0), **kwargs) -> UsergroupmembershipDeleteObjectV1Response: # noqa: E501 - """Delete an existing Usergroupmembership # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.usergroupmembership_delete_object_v1(pki_usergroupmembership_id, async_req=True) - >>> result = thread.get() + + @validate_call + def usergroupmembership_delete_object_v1( + self, + pki_usergroupmembership_id: Annotated[int, Field(le=65535, strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> UsergroupmembershipDeleteObjectV1Response: + """Delete an existing Usergroupmembership + + :param pki_usergroupmembership_id: (required) :type pki_usergroupmembership_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: UsergroupmembershipDeleteObjectV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the usergroupmembership_delete_object_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.usergroupmembership_delete_object_v1_with_http_info(pki_usergroupmembership_id, **kwargs) # noqa: E501 - - @validate_arguments - def usergroupmembership_delete_object_v1_with_http_info(self, pki_usergroupmembership_id : conint(strict=True, le=65535, ge=0), **kwargs) -> ApiResponse: # noqa: E501 - """Delete an existing Usergroupmembership # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.usergroupmembership_delete_object_v1_with_http_info(pki_usergroupmembership_id, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._usergroupmembership_delete_object_v1_serialize( + pki_usergroupmembership_id=pki_usergroupmembership_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "UsergroupmembershipDeleteObjectV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def usergroupmembership_delete_object_v1_with_http_info( + self, + pki_usergroupmembership_id: Annotated[int, Field(le=65535, strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[UsergroupmembershipDeleteObjectV1Response]: + """Delete an existing Usergroupmembership + + :param pki_usergroupmembership_id: (required) :type pki_usergroupmembership_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(UsergroupmembershipDeleteObjectV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._usergroupmembership_delete_object_v1_serialize( + pki_usergroupmembership_id=pki_usergroupmembership_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '200': "UsergroupmembershipDeleteObjectV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'pki_usergroupmembership_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def usergroupmembership_delete_object_v1_without_preload_content( + self, + pki_usergroupmembership_id: Annotated[int, Field(le=65535, strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete an existing Usergroupmembership + + + + :param pki_usergroupmembership_id: (required) + :type pki_usergroupmembership_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._usergroupmembership_delete_object_v1_serialize( + pki_usergroupmembership_id=pki_usergroupmembership_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method usergroupmembership_delete_object_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "UsergroupmembershipDeleteObjectV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_usergroupmembership_id']: - _path_params['pkiUsergroupmembershipID'] = _params['pki_usergroupmembership_id'] + def _usergroupmembership_delete_object_v1_serialize( + self, + pki_usergroupmembership_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if pki_usergroupmembership_id is not None: + _path_params['pkiUsergroupmembershipID'] = pki_usergroupmembership_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "UsergroupmembershipDeleteObjectV1Response", - '404': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/usergroupmembership/{pkiUsergroupmembershipID}', 'DELETE', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='DELETE', + resource_path='/1/object/usergroupmembership/{pkiUsergroupmembershipID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) - @validate_arguments - def usergroupmembership_edit_object_v1(self, pki_usergroupmembership_id : conint(strict=True, le=65535, ge=0), usergroupmembership_edit_object_v1_request : UsergroupmembershipEditObjectV1Request, **kwargs) -> UsergroupmembershipEditObjectV1Response: # noqa: E501 - """Edit an existing Usergroupmembership # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.usergroupmembership_edit_object_v1(pki_usergroupmembership_id, usergroupmembership_edit_object_v1_request, async_req=True) - >>> result = thread.get() + + @validate_call + def usergroupmembership_edit_object_v1( + self, + pki_usergroupmembership_id: Annotated[int, Field(le=65535, strict=True, ge=0)], + usergroupmembership_edit_object_v1_request: UsergroupmembershipEditObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> UsergroupmembershipEditObjectV1Response: + """Edit an existing Usergroupmembership + + :param pki_usergroupmembership_id: (required) :type pki_usergroupmembership_id: int :param usergroupmembership_edit_object_v1_request: (required) :type usergroupmembership_edit_object_v1_request: UsergroupmembershipEditObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: UsergroupmembershipEditObjectV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the usergroupmembership_edit_object_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.usergroupmembership_edit_object_v1_with_http_info(pki_usergroupmembership_id, usergroupmembership_edit_object_v1_request, **kwargs) # noqa: E501 - - @validate_arguments - def usergroupmembership_edit_object_v1_with_http_info(self, pki_usergroupmembership_id : conint(strict=True, le=65535, ge=0), usergroupmembership_edit_object_v1_request : UsergroupmembershipEditObjectV1Request, **kwargs) -> ApiResponse: # noqa: E501 - """Edit an existing Usergroupmembership # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.usergroupmembership_edit_object_v1_with_http_info(pki_usergroupmembership_id, usergroupmembership_edit_object_v1_request, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._usergroupmembership_edit_object_v1_serialize( + pki_usergroupmembership_id=pki_usergroupmembership_id, + usergroupmembership_edit_object_v1_request=usergroupmembership_edit_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "UsergroupmembershipEditObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def usergroupmembership_edit_object_v1_with_http_info( + self, + pki_usergroupmembership_id: Annotated[int, Field(le=65535, strict=True, ge=0)], + usergroupmembership_edit_object_v1_request: UsergroupmembershipEditObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[UsergroupmembershipEditObjectV1Response]: + """Edit an existing Usergroupmembership + + :param pki_usergroupmembership_id: (required) :type pki_usergroupmembership_id: int :param usergroupmembership_edit_object_v1_request: (required) :type usergroupmembership_edit_object_v1_request: UsergroupmembershipEditObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(UsergroupmembershipEditObjectV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._usergroupmembership_edit_object_v1_serialize( + pki_usergroupmembership_id=pki_usergroupmembership_id, + usergroupmembership_edit_object_v1_request=usergroupmembership_edit_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '200': "UsergroupmembershipEditObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'pki_usergroupmembership_id', - 'usergroupmembership_edit_object_v1_request' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def usergroupmembership_edit_object_v1_without_preload_content( + self, + pki_usergroupmembership_id: Annotated[int, Field(le=65535, strict=True, ge=0)], + usergroupmembership_edit_object_v1_request: UsergroupmembershipEditObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Edit an existing Usergroupmembership + + + + :param pki_usergroupmembership_id: (required) + :type pki_usergroupmembership_id: int + :param usergroupmembership_edit_object_v1_request: (required) + :type usergroupmembership_edit_object_v1_request: UsergroupmembershipEditObjectV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._usergroupmembership_edit_object_v1_serialize( + pki_usergroupmembership_id=pki_usergroupmembership_id, + usergroupmembership_edit_object_v1_request=usergroupmembership_edit_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method usergroupmembership_edit_object_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "UsergroupmembershipEditObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_usergroupmembership_id']: - _path_params['pkiUsergroupmembershipID'] = _params['pki_usergroupmembership_id'] + def _usergroupmembership_edit_object_v1_serialize( + self, + pki_usergroupmembership_id, + usergroupmembership_edit_object_v1_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_usergroupmembership_id is not None: + _path_params['pkiUsergroupmembershipID'] = pki_usergroupmembership_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['usergroupmembership_edit_object_v1_request'] is not None: - _body_params = _params['usergroupmembership_edit_object_v1_request'] + if usergroupmembership_edit_object_v1_request is not None: + _body_params = usergroupmembership_edit_object_v1_request + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '200': "UsergroupmembershipEditObjectV1Response", - '404': "CommonResponseError", - '422': "CommonResponseError", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/usergroupmembership/{pkiUsergroupmembershipID}', 'PUT', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='PUT', + resource_path='/1/object/usergroupmembership/{pkiUsergroupmembershipID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + - @validate_arguments - def usergroupmembership_get_object_v2(self, pki_usergroupmembership_id : conint(strict=True, le=65535, ge=0), **kwargs) -> UsergroupmembershipGetObjectV2Response: # noqa: E501 - """Retrieve an existing Usergroupmembership # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def usergroupmembership_get_object_v2( + self, + pki_usergroupmembership_id: Annotated[int, Field(le=65535, strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> UsergroupmembershipGetObjectV2Response: + """Retrieve an existing Usergroupmembership - >>> thread = api.usergroupmembership_get_object_v2(pki_usergroupmembership_id, async_req=True) - >>> result = thread.get() + :param pki_usergroupmembership_id: (required) :type pki_usergroupmembership_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: UsergroupmembershipGetObjectV2Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the usergroupmembership_get_object_v2_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.usergroupmembership_get_object_v2_with_http_info(pki_usergroupmembership_id, **kwargs) # noqa: E501 - - @validate_arguments - def usergroupmembership_get_object_v2_with_http_info(self, pki_usergroupmembership_id : conint(strict=True, le=65535, ge=0), **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve an existing Usergroupmembership # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.usergroupmembership_get_object_v2_with_http_info(pki_usergroupmembership_id, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._usergroupmembership_get_object_v2_serialize( + pki_usergroupmembership_id=pki_usergroupmembership_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "UsergroupmembershipGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def usergroupmembership_get_object_v2_with_http_info( + self, + pki_usergroupmembership_id: Annotated[int, Field(le=65535, strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[UsergroupmembershipGetObjectV2Response]: + """Retrieve an existing Usergroupmembership + + :param pki_usergroupmembership_id: (required) :type pki_usergroupmembership_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(UsergroupmembershipGetObjectV2Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._usergroupmembership_get_object_v2_serialize( + pki_usergroupmembership_id=pki_usergroupmembership_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '200': "UsergroupmembershipGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'pki_usergroupmembership_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def usergroupmembership_get_object_v2_without_preload_content( + self, + pki_usergroupmembership_id: Annotated[int, Field(le=65535, strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve an existing Usergroupmembership + + + + :param pki_usergroupmembership_id: (required) + :type pki_usergroupmembership_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._usergroupmembership_get_object_v2_serialize( + pki_usergroupmembership_id=pki_usergroupmembership_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method usergroupmembership_get_object_v2" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "UsergroupmembershipGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_usergroupmembership_id']: - _path_params['pkiUsergroupmembershipID'] = _params['pki_usergroupmembership_id'] + def _usergroupmembership_get_object_v2_serialize( + self, + pki_usergroupmembership_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_usergroupmembership_id is not None: + _path_params['pkiUsergroupmembershipID'] = pki_usergroupmembership_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "UsergroupmembershipGetObjectV2Response", - '404': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/2/object/usergroupmembership/{pkiUsergroupmembershipID}', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/2/object/usergroupmembership/{pkiUsergroupmembershipID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/eZmaxApi/api/object_userlogintype_api.py b/eZmaxApi/api/object_userlogintype_api.py index 54de619a5..7a6256273 100644 --- a/eZmaxApi/api/object_userlogintype_api.py +++ b/eZmaxApi/api/object_userlogintype_api.py @@ -13,14 +13,20 @@ """ # noqa: E501 -import re # noqa: F401 import io import warnings -from pydantic import validate_arguments, ValidationError +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Dict, List, Optional, Tuple, Union, Any +try: + from typing import Annotated +except ImportError: + from typing_extensions import Annotated + +from pydantic import Field from typing_extensions import Annotated -from pydantic import Field, StrictStr +from pydantic import StrictStr, field_validator from typing import Optional @@ -29,10 +35,7 @@ from eZmaxApi.api_client import ApiClient from eZmaxApi.api_response import ApiResponse -from eZmaxApi.exceptions import ( # noqa: F401 - ApiTypeError, - ApiValueError -) +from eZmaxApi.rest import RESTResponseType class ObjectUserlogintypeApi: @@ -47,16 +50,30 @@ def __init__(self, api_client=None) -> None: api_client = ApiClient.get_default() self.api_client = api_client - @validate_arguments - def userlogintype_get_autocomplete_v2(self, s_selector : Annotated[StrictStr, Field(..., description="The type of Userlogintypes to return")], e_filter_active : Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, s_query : Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, accept_language : Optional[HeaderAcceptLanguage] = None, **kwargs) -> UserlogintypeGetAutocompleteV2Response: # noqa: E501 - """Retrieve Userlogintypes and IDs # noqa: E501 - Get the list of Userlogintype to be used in a dropdown or autocomplete control. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def userlogintype_get_autocomplete_v2( + self, + s_selector: Annotated[StrictStr, Field(description="The type of Userlogintypes to return")], + e_filter_active: Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, + s_query: Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> UserlogintypeGetAutocompleteV2Response: + """Retrieve Userlogintypes and IDs - >>> thread = api.userlogintype_get_autocomplete_v2(s_selector, e_filter_active, s_query, accept_language, async_req=True) - >>> result = thread.get() + Get the list of Userlogintype to be used in a dropdown or autocomplete control. :param s_selector: The type of Userlogintypes to return (required) :type s_selector: str @@ -66,33 +83,76 @@ def userlogintype_get_autocomplete_v2(self, s_selector : Annotated[StrictStr, Fi :type s_query: str :param accept_language: :type accept_language: HeaderAcceptLanguage - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: UserlogintypeGetAutocompleteV2Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the userlogintype_get_autocomplete_v2_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.userlogintype_get_autocomplete_v2_with_http_info(s_selector, e_filter_active, s_query, accept_language, **kwargs) # noqa: E501 - - @validate_arguments - def userlogintype_get_autocomplete_v2_with_http_info(self, s_selector : Annotated[StrictStr, Field(..., description="The type of Userlogintypes to return")], e_filter_active : Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, s_query : Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, accept_language : Optional[HeaderAcceptLanguage] = None, **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve Userlogintypes and IDs # noqa: E501 - - Get the list of Userlogintype to be used in a dropdown or autocomplete control. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.userlogintype_get_autocomplete_v2_with_http_info(s_selector, e_filter_active, s_query, accept_language, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._userlogintype_get_autocomplete_v2_serialize( + s_selector=s_selector, + e_filter_active=e_filter_active, + s_query=s_query, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "UserlogintypeGetAutocompleteV2Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def userlogintype_get_autocomplete_v2_with_http_info( + self, + s_selector: Annotated[StrictStr, Field(description="The type of Userlogintypes to return")], + e_filter_active: Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, + s_query: Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[UserlogintypeGetAutocompleteV2Response]: + """Retrieve Userlogintypes and IDs + + Get the list of Userlogintype to be used in a dropdown or autocomplete control. :param s_selector: The type of Userlogintypes to return (required) :type s_selector: str @@ -102,111 +162,197 @@ def userlogintype_get_autocomplete_v2_with_http_info(self, s_selector : Annotate :type s_query: str :param accept_language: :type accept_language: HeaderAcceptLanguage - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(UserlogintypeGetAutocompleteV2Response, status_code(int), headers(HTTPHeaderDict)) - """ - - _params = locals() - - _all_params = [ - 's_selector', - 'e_filter_active', - 's_query', - 'accept_language' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + """ # noqa: E501 + + _param = self._userlogintype_get_autocomplete_v2_serialize( + s_selector=s_selector, + e_filter_active=e_filter_active, + s_query=s_query, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "UserlogintypeGetAutocompleteV2Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def userlogintype_get_autocomplete_v2_without_preload_content( + self, + s_selector: Annotated[StrictStr, Field(description="The type of Userlogintypes to return")], + e_filter_active: Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, + s_query: Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve Userlogintypes and IDs + + Get the list of Userlogintype to be used in a dropdown or autocomplete control. + + :param s_selector: The type of Userlogintypes to return (required) + :type s_selector: str + :param e_filter_active: Specify which results we want to display. + :type e_filter_active: str + :param s_query: Allow to filter the returned results + :type s_query: str + :param accept_language: + :type accept_language: HeaderAcceptLanguage + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._userlogintype_get_autocomplete_v2_serialize( + s_selector=s_selector, + e_filter_active=e_filter_active, + s_query=s_query, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method userlogintype_get_autocomplete_v2" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "UserlogintypeGetAutocompleteV2Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['s_selector']: - _path_params['sSelector'] = _params['s_selector'] + def _userlogintype_get_autocomplete_v2_serialize( + self, + s_selector, + e_filter_active, + s_query, + accept_language, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None - # process the query parameters - _query_params = [] - if _params.get('e_filter_active') is not None: # noqa: E501 - _query_params.append(('eFilterActive', _params['e_filter_active'])) + _collection_formats: Dict[str, str] = { + } - if _params.get('s_query') is not None: # noqa: E501 - _query_params.append(('sQuery', _params['s_query'])) + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if s_selector is not None: + _path_params['sSelector'] = s_selector + # process the query parameters + if e_filter_active is not None: + + _query_params.append(('eFilterActive', e_filter_active)) + + if s_query is not None: + + _query_params.append(('sQuery', s_query)) + # process the header parameters - _header_params = dict(_params.get('_headers', {})) - if _params['accept_language']: - _header_params['Accept-Language'] = _params['accept_language'] - + if accept_language is not None: + _header_params['Accept-Language'] = accept_language # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "UserlogintypeGetAutocompleteV2Response", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/2/object/userlogintype/getAutocomplete/{sSelector}', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/2/object/userlogintype/getAutocomplete/{sSelector}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/eZmaxApi/api/object_userstaged_api.py b/eZmaxApi/api/object_userstaged_api.py index 14fb40752..76f5e2f6f 100644 --- a/eZmaxApi/api/object_userstaged_api.py +++ b/eZmaxApi/api/object_userstaged_api.py @@ -13,14 +13,20 @@ """ # noqa: E501 -import re # noqa: F401 import io import warnings -from pydantic import validate_arguments, ValidationError +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Dict, List, Optional, Tuple, Union, Any +try: + from typing import Annotated +except ImportError: + from typing_extensions import Annotated + +from pydantic import Field from typing_extensions import Annotated -from pydantic import Field, StrictStr, conint +from pydantic import StrictStr, field_validator from typing import Any, Dict, Optional @@ -34,10 +40,7 @@ from eZmaxApi.api_client import ApiClient from eZmaxApi.api_response import ApiResponse -from eZmaxApi.exceptions import ( # noqa: F401 - ApiTypeError, - ApiValueError -) +from eZmaxApi.rest import RESTResponseType class ObjectUserstagedApi: @@ -52,313 +55,581 @@ def __init__(self, api_client=None) -> None: api_client = ApiClient.get_default() self.api_client = api_client - @validate_arguments - def userstaged_create_user_v1(self, pki_userstaged_id : conint(strict=True, le=65535, ge=1), body : Dict[str, Any], **kwargs) -> UserstagedCreateUserV1Response: # noqa: E501 - """Create a User from a Userstaged and then map it # noqa: E501 - Default values will be used while creating the User. If you need to change those values, you should use the route to edit a User. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def userstaged_create_user_v1( + self, + pki_userstaged_id: Annotated[int, Field(le=65535, strict=True, ge=1)], + body: Dict[str, Any], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> UserstagedCreateUserV1Response: + """Create a User from a Userstaged and then map it - >>> thread = api.userstaged_create_user_v1(pki_userstaged_id, body, async_req=True) - >>> result = thread.get() + Default values will be used while creating the User. If you need to change those values, you should use the route to edit a User. :param pki_userstaged_id: (required) :type pki_userstaged_id: int :param body: (required) :type body: object - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: UserstagedCreateUserV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the userstaged_create_user_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.userstaged_create_user_v1_with_http_info(pki_userstaged_id, body, **kwargs) # noqa: E501 - - @validate_arguments - def userstaged_create_user_v1_with_http_info(self, pki_userstaged_id : conint(strict=True, le=65535, ge=1), body : Dict[str, Any], **kwargs) -> ApiResponse: # noqa: E501 - """Create a User from a Userstaged and then map it # noqa: E501 - - Default values will be used while creating the User. If you need to change those values, you should use the route to edit a User. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.userstaged_create_user_v1_with_http_info(pki_userstaged_id, body, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._userstaged_create_user_v1_serialize( + pki_userstaged_id=pki_userstaged_id, + body=body, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "UserstagedCreateUserV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def userstaged_create_user_v1_with_http_info( + self, + pki_userstaged_id: Annotated[int, Field(le=65535, strict=True, ge=1)], + body: Dict[str, Any], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[UserstagedCreateUserV1Response]: + """Create a User from a Userstaged and then map it + + Default values will be used while creating the User. If you need to change those values, you should use the route to edit a User. :param pki_userstaged_id: (required) :type pki_userstaged_id: int :param body: (required) :type body: object - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(UserstagedCreateUserV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._userstaged_create_user_v1_serialize( + pki_userstaged_id=pki_userstaged_id, + body=body, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "UserstagedCreateUserV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _params = locals() - _all_params = [ - 'pki_userstaged_id', - 'body' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + @validate_call + def userstaged_create_user_v1_without_preload_content( + self, + pki_userstaged_id: Annotated[int, Field(le=65535, strict=True, ge=1)], + body: Dict[str, Any], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Create a User from a Userstaged and then map it + + Default values will be used while creating the User. If you need to change those values, you should use the route to edit a User. + + :param pki_userstaged_id: (required) + :type pki_userstaged_id: int + :param body: (required) + :type body: object + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._userstaged_create_user_v1_serialize( + pki_userstaged_id=pki_userstaged_id, + body=body, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method userstaged_create_user_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "UserstagedCreateUserV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_userstaged_id']: - _path_params['pkiUserstagedID'] = _params['pki_userstaged_id'] + def _userstaged_create_user_v1_serialize( + self, + pki_userstaged_id, + body, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_userstaged_id is not None: + _path_params['pkiUserstagedID'] = pki_userstaged_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['body'] is not None: - _body_params = _params['body'] + if body is not None: + _body_params = body + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '200': "UserstagedCreateUserV1Response", - '404': "CommonResponseError", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/userstaged/{pkiUserstagedID}/createUser', 'POST', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='POST', + resource_path='/1/object/userstaged/{pkiUserstagedID}/createUser', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) - @validate_arguments - def userstaged_delete_object_v1(self, pki_userstaged_id : conint(strict=True, le=65535, ge=1), **kwargs) -> UserstagedDeleteObjectV1Response: # noqa: E501 - """Delete an existing Userstaged # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.userstaged_delete_object_v1(pki_userstaged_id, async_req=True) - >>> result = thread.get() + + @validate_call + def userstaged_delete_object_v1( + self, + pki_userstaged_id: Annotated[int, Field(le=65535, strict=True, ge=1)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> UserstagedDeleteObjectV1Response: + """Delete an existing Userstaged + + :param pki_userstaged_id: (required) :type pki_userstaged_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: UserstagedDeleteObjectV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the userstaged_delete_object_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.userstaged_delete_object_v1_with_http_info(pki_userstaged_id, **kwargs) # noqa: E501 - - @validate_arguments - def userstaged_delete_object_v1_with_http_info(self, pki_userstaged_id : conint(strict=True, le=65535, ge=1), **kwargs) -> ApiResponse: # noqa: E501 - """Delete an existing Userstaged # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.userstaged_delete_object_v1_with_http_info(pki_userstaged_id, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._userstaged_delete_object_v1_serialize( + pki_userstaged_id=pki_userstaged_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "UserstagedDeleteObjectV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def userstaged_delete_object_v1_with_http_info( + self, + pki_userstaged_id: Annotated[int, Field(le=65535, strict=True, ge=1)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[UserstagedDeleteObjectV1Response]: + """Delete an existing Userstaged + + :param pki_userstaged_id: (required) :type pki_userstaged_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(UserstagedDeleteObjectV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._userstaged_delete_object_v1_serialize( + pki_userstaged_id=pki_userstaged_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '200': "UserstagedDeleteObjectV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'pki_userstaged_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def userstaged_delete_object_v1_without_preload_content( + self, + pki_userstaged_id: Annotated[int, Field(le=65535, strict=True, ge=1)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete an existing Userstaged + + + + :param pki_userstaged_id: (required) + :type pki_userstaged_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._userstaged_delete_object_v1_serialize( + pki_userstaged_id=pki_userstaged_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method userstaged_delete_object_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "UserstagedDeleteObjectV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_userstaged_id']: - _path_params['pkiUserstagedID'] = _params['pki_userstaged_id'] + def _userstaged_delete_object_v1_serialize( + self, + pki_userstaged_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if pki_userstaged_id is not None: + _path_params['pkiUserstagedID'] = pki_userstaged_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "UserstagedDeleteObjectV1Response", - '404': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/userstaged/{pkiUserstagedID}', 'DELETE', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='DELETE', + resource_path='/1/object/userstaged/{pkiUserstagedID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) - @validate_arguments - def userstaged_get_list_v1(self, e_order_by : Annotated[Optional[StrictStr], Field(description="Specify how you want the results to be sorted")] = None, i_row_max : Optional[conint(strict=True, le=10000, ge=1)] = None, i_row_offset : Optional[conint(strict=True, ge=0)] = None, accept_language : Optional[HeaderAcceptLanguage] = None, s_filter : Optional[StrictStr] = None, **kwargs) -> UserstagedGetListV1Response: # noqa: E501 - """Retrieve Userstaged list # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.userstaged_get_list_v1(e_order_by, i_row_max, i_row_offset, accept_language, s_filter, async_req=True) - >>> result = thread.get() + + @validate_call + def userstaged_get_list_v1( + self, + e_order_by: Annotated[Optional[StrictStr], Field(description="Specify how you want the results to be sorted")] = None, + i_row_max: Optional[Annotated[int, Field(le=10000, strict=True, ge=1)]] = None, + i_row_offset: Optional[Annotated[int, Field(strict=True, ge=0)]] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + s_filter: Optional[StrictStr] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> UserstagedGetListV1Response: + """Retrieve Userstaged list + + :param e_order_by: Specify how you want the results to be sorted :type e_order_by: str @@ -370,33 +641,79 @@ def userstaged_get_list_v1(self, e_order_by : Annotated[Optional[StrictStr], Fie :type accept_language: HeaderAcceptLanguage :param s_filter: :type s_filter: str - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: UserstagedGetListV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the userstaged_get_list_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.userstaged_get_list_v1_with_http_info(e_order_by, i_row_max, i_row_offset, accept_language, s_filter, **kwargs) # noqa: E501 - - @validate_arguments - def userstaged_get_list_v1_with_http_info(self, e_order_by : Annotated[Optional[StrictStr], Field(description="Specify how you want the results to be sorted")] = None, i_row_max : Optional[conint(strict=True, le=10000, ge=1)] = None, i_row_offset : Optional[conint(strict=True, ge=0)] = None, accept_language : Optional[HeaderAcceptLanguage] = None, s_filter : Optional[StrictStr] = None, **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve Userstaged list # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.userstaged_get_list_v1_with_http_info(e_order_by, i_row_max, i_row_offset, accept_language, s_filter, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._userstaged_get_list_v1_serialize( + e_order_by=e_order_by, + i_row_max=i_row_max, + i_row_offset=i_row_offset, + accept_language=accept_language, + s_filter=s_filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "UserstagedGetListV1Response", + '406': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def userstaged_get_list_v1_with_http_info( + self, + e_order_by: Annotated[Optional[StrictStr], Field(description="Specify how you want the results to be sorted")] = None, + i_row_max: Optional[Annotated[int, Field(le=10000, strict=True, ge=1)]] = None, + i_row_offset: Optional[Annotated[int, Field(strict=True, ge=0)]] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + s_filter: Optional[StrictStr] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[UserstagedGetListV1Response]: + """Retrieve Userstaged list + + :param e_order_by: Specify how you want the results to be sorted :type e_order_by: str @@ -408,414 +725,765 @@ def userstaged_get_list_v1_with_http_info(self, e_order_by : Annotated[Optional[ :type accept_language: HeaderAcceptLanguage :param s_filter: :type s_filter: str - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(UserstagedGetListV1Response, status_code(int), headers(HTTPHeaderDict)) - """ - - _params = locals() - - _all_params = [ - 'e_order_by', - 'i_row_max', - 'i_row_offset', - 'accept_language', - 's_filter' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' - ] + """ # noqa: E501 + + _param = self._userstaged_get_list_v1_serialize( + e_order_by=e_order_by, + i_row_max=i_row_max, + i_row_offset=i_row_offset, + accept_language=accept_language, + s_filter=s_filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method userstaged_get_list_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "UserstagedGetListV1Response", + '406': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _collection_formats = {} - # process the path parameters - _path_params = {} + @validate_call + def userstaged_get_list_v1_without_preload_content( + self, + e_order_by: Annotated[Optional[StrictStr], Field(description="Specify how you want the results to be sorted")] = None, + i_row_max: Optional[Annotated[int, Field(le=10000, strict=True, ge=1)]] = None, + i_row_offset: Optional[Annotated[int, Field(strict=True, ge=0)]] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + s_filter: Optional[StrictStr] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve Userstaged list - # process the query parameters - _query_params = [] - if _params.get('e_order_by') is not None: # noqa: E501 - _query_params.append(('eOrderBy', _params['e_order_by'])) + - if _params.get('i_row_max') is not None: # noqa: E501 - _query_params.append(('iRowMax', _params['i_row_max'])) + :param e_order_by: Specify how you want the results to be sorted + :type e_order_by: str + :param i_row_max: + :type i_row_max: int + :param i_row_offset: + :type i_row_offset: int + :param accept_language: + :type accept_language: HeaderAcceptLanguage + :param s_filter: + :type s_filter: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._userstaged_get_list_v1_serialize( + e_order_by=e_order_by, + i_row_max=i_row_max, + i_row_offset=i_row_offset, + accept_language=accept_language, + s_filter=s_filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - if _params.get('i_row_offset') is not None: # noqa: E501 - _query_params.append(('iRowOffset', _params['i_row_offset'])) + _response_types_map: Dict[str, Optional[str]] = { + '200': "UserstagedGetListV1Response", + '406': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - if _params.get('s_filter') is not None: # noqa: E501 - _query_params.append(('sFilter', _params['s_filter'])) - # process the header parameters - _header_params = dict(_params.get('_headers', {})) - if _params['accept_language']: - _header_params['Accept-Language'] = _params['accept_language'] + def _userstaged_get_list_v1_serialize( + self, + e_order_by, + i_row_max, + i_row_offset, + accept_language, + s_filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if e_order_by is not None: + + _query_params.append(('eOrderBy', e_order_by)) + + if i_row_max is not None: + + _query_params.append(('iRowMax', i_row_max)) + + if i_row_offset is not None: + + _query_params.append(('iRowOffset', i_row_offset)) + + if s_filter is not None: + + _query_params.append(('sFilter', s_filter)) + + # process the header parameters + if accept_language is not None: + _header_params['Accept-Language'] = accept_language # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet']) # noqa: E501 + [ + 'application/json', + 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "UserstagedGetListV1Response", - '406': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/userstaged/getList', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/1/object/userstaged/getList', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + - @validate_arguments - def userstaged_get_object_v2(self, pki_userstaged_id : conint(strict=True, le=65535, ge=1), **kwargs) -> UserstagedGetObjectV2Response: # noqa: E501 - """Retrieve an existing Userstaged # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.userstaged_get_object_v2(pki_userstaged_id, async_req=True) - >>> result = thread.get() + @validate_call + def userstaged_get_object_v2( + self, + pki_userstaged_id: Annotated[int, Field(le=65535, strict=True, ge=1)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> UserstagedGetObjectV2Response: + """Retrieve an existing Userstaged + + :param pki_userstaged_id: (required) :type pki_userstaged_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: UserstagedGetObjectV2Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the userstaged_get_object_v2_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.userstaged_get_object_v2_with_http_info(pki_userstaged_id, **kwargs) # noqa: E501 - - @validate_arguments - def userstaged_get_object_v2_with_http_info(self, pki_userstaged_id : conint(strict=True, le=65535, ge=1), **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve an existing Userstaged # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.userstaged_get_object_v2_with_http_info(pki_userstaged_id, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._userstaged_get_object_v2_serialize( + pki_userstaged_id=pki_userstaged_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "UserstagedGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def userstaged_get_object_v2_with_http_info( + self, + pki_userstaged_id: Annotated[int, Field(le=65535, strict=True, ge=1)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[UserstagedGetObjectV2Response]: + """Retrieve an existing Userstaged + + :param pki_userstaged_id: (required) :type pki_userstaged_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(UserstagedGetObjectV2Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._userstaged_get_object_v2_serialize( + pki_userstaged_id=pki_userstaged_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '200': "UserstagedGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'pki_userstaged_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def userstaged_get_object_v2_without_preload_content( + self, + pki_userstaged_id: Annotated[int, Field(le=65535, strict=True, ge=1)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve an existing Userstaged + + + + :param pki_userstaged_id: (required) + :type pki_userstaged_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._userstaged_get_object_v2_serialize( + pki_userstaged_id=pki_userstaged_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method userstaged_get_object_v2" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "UserstagedGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_userstaged_id']: - _path_params['pkiUserstagedID'] = _params['pki_userstaged_id'] + def _userstaged_get_object_v2_serialize( + self, + pki_userstaged_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_userstaged_id is not None: + _path_params['pkiUserstagedID'] = pki_userstaged_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "UserstagedGetObjectV2Response", - '404': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/2/object/userstaged/{pkiUserstagedID}', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/2/object/userstaged/{pkiUserstagedID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + - @validate_arguments - def userstaged_map_v1(self, pki_userstaged_id : conint(strict=True, le=65535, ge=1), userstaged_map_v1_request : UserstagedMapV1Request, **kwargs) -> UserstagedMapV1Response: # noqa: E501 - """Map the Userstaged to an existing user # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.userstaged_map_v1(pki_userstaged_id, userstaged_map_v1_request, async_req=True) - >>> result = thread.get() + @validate_call + def userstaged_map_v1( + self, + pki_userstaged_id: Annotated[int, Field(le=65535, strict=True, ge=1)], + userstaged_map_v1_request: UserstagedMapV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> UserstagedMapV1Response: + """Map the Userstaged to an existing user + + :param pki_userstaged_id: (required) :type pki_userstaged_id: int :param userstaged_map_v1_request: (required) :type userstaged_map_v1_request: UserstagedMapV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: UserstagedMapV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the userstaged_map_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.userstaged_map_v1_with_http_info(pki_userstaged_id, userstaged_map_v1_request, **kwargs) # noqa: E501 - - @validate_arguments - def userstaged_map_v1_with_http_info(self, pki_userstaged_id : conint(strict=True, le=65535, ge=1), userstaged_map_v1_request : UserstagedMapV1Request, **kwargs) -> ApiResponse: # noqa: E501 - """Map the Userstaged to an existing user # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.userstaged_map_v1_with_http_info(pki_userstaged_id, userstaged_map_v1_request, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._userstaged_map_v1_serialize( + pki_userstaged_id=pki_userstaged_id, + userstaged_map_v1_request=userstaged_map_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "UserstagedMapV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def userstaged_map_v1_with_http_info( + self, + pki_userstaged_id: Annotated[int, Field(le=65535, strict=True, ge=1)], + userstaged_map_v1_request: UserstagedMapV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[UserstagedMapV1Response]: + """Map the Userstaged to an existing user + + :param pki_userstaged_id: (required) :type pki_userstaged_id: int :param userstaged_map_v1_request: (required) :type userstaged_map_v1_request: UserstagedMapV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(UserstagedMapV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._userstaged_map_v1_serialize( + pki_userstaged_id=pki_userstaged_id, + userstaged_map_v1_request=userstaged_map_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '200': "UserstagedMapV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'pki_userstaged_id', - 'userstaged_map_v1_request' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def userstaged_map_v1_without_preload_content( + self, + pki_userstaged_id: Annotated[int, Field(le=65535, strict=True, ge=1)], + userstaged_map_v1_request: UserstagedMapV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Map the Userstaged to an existing user + + + + :param pki_userstaged_id: (required) + :type pki_userstaged_id: int + :param userstaged_map_v1_request: (required) + :type userstaged_map_v1_request: UserstagedMapV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._userstaged_map_v1_serialize( + pki_userstaged_id=pki_userstaged_id, + userstaged_map_v1_request=userstaged_map_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method userstaged_map_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "UserstagedMapV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_userstaged_id']: - _path_params['pkiUserstagedID'] = _params['pki_userstaged_id'] + def _userstaged_map_v1_serialize( + self, + pki_userstaged_id, + userstaged_map_v1_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_userstaged_id is not None: + _path_params['pkiUserstagedID'] = pki_userstaged_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['userstaged_map_v1_request'] is not None: - _body_params = _params['userstaged_map_v1_request'] + if userstaged_map_v1_request is not None: + _body_params = userstaged_map_v1_request + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '200': "UserstagedMapV1Response", - '404': "CommonResponseError", - '422': "CommonResponseError", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/userstaged/{pkiUserstagedID}/map', 'POST', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='POST', + resource_path='/1/object/userstaged/{pkiUserstagedID}/map', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/eZmaxApi/api/object_variableexpense_api.py b/eZmaxApi/api/object_variableexpense_api.py index adb6a1660..7e8f1599d 100644 --- a/eZmaxApi/api/object_variableexpense_api.py +++ b/eZmaxApi/api/object_variableexpense_api.py @@ -13,14 +13,20 @@ """ # noqa: E501 -import re # noqa: F401 import io import warnings -from pydantic import validate_arguments, ValidationError +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Dict, List, Optional, Tuple, Union, Any +try: + from typing import Annotated +except ImportError: + from typing_extensions import Annotated + +from pydantic import Field from typing_extensions import Annotated -from pydantic import Field, StrictStr, conint +from pydantic import StrictStr, field_validator from typing import Optional @@ -35,10 +41,7 @@ from eZmaxApi.api_client import ApiClient from eZmaxApi.api_response import ApiResponse -from eZmaxApi.exceptions import ( # noqa: F401 - ApiTypeError, - ApiValueError -) +from eZmaxApi.rest import RESTResponseType class ObjectVariableexpenseApi: @@ -53,320 +56,593 @@ def __init__(self, api_client=None) -> None: api_client = ApiClient.get_default() self.api_client = api_client - @validate_arguments - def variableexpense_create_object_v1(self, variableexpense_create_object_v1_request : VariableexpenseCreateObjectV1Request, **kwargs) -> VariableexpenseCreateObjectV1Response: # noqa: E501 - """Create a new Variableexpense # noqa: E501 - The endpoint allows to create one or many elements at once. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def variableexpense_create_object_v1( + self, + variableexpense_create_object_v1_request: VariableexpenseCreateObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> VariableexpenseCreateObjectV1Response: + """Create a new Variableexpense - >>> thread = api.variableexpense_create_object_v1(variableexpense_create_object_v1_request, async_req=True) - >>> result = thread.get() + The endpoint allows to create one or many elements at once. :param variableexpense_create_object_v1_request: (required) :type variableexpense_create_object_v1_request: VariableexpenseCreateObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: VariableexpenseCreateObjectV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the variableexpense_create_object_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.variableexpense_create_object_v1_with_http_info(variableexpense_create_object_v1_request, **kwargs) # noqa: E501 - - @validate_arguments - def variableexpense_create_object_v1_with_http_info(self, variableexpense_create_object_v1_request : VariableexpenseCreateObjectV1Request, **kwargs) -> ApiResponse: # noqa: E501 - """Create a new Variableexpense # noqa: E501 - - The endpoint allows to create one or many elements at once. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.variableexpense_create_object_v1_with_http_info(variableexpense_create_object_v1_request, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._variableexpense_create_object_v1_serialize( + variableexpense_create_object_v1_request=variableexpense_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "VariableexpenseCreateObjectV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def variableexpense_create_object_v1_with_http_info( + self, + variableexpense_create_object_v1_request: VariableexpenseCreateObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[VariableexpenseCreateObjectV1Response]: + """Create a new Variableexpense + + The endpoint allows to create one or many elements at once. :param variableexpense_create_object_v1_request: (required) :type variableexpense_create_object_v1_request: VariableexpenseCreateObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(VariableexpenseCreateObjectV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._variableexpense_create_object_v1_serialize( + variableexpense_create_object_v1_request=variableexpense_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "VariableexpenseCreateObjectV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _params = locals() - _all_params = [ - 'variableexpense_create_object_v1_request' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + @validate_call + def variableexpense_create_object_v1_without_preload_content( + self, + variableexpense_create_object_v1_request: VariableexpenseCreateObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Create a new Variableexpense + + The endpoint allows to create one or many elements at once. + + :param variableexpense_create_object_v1_request: (required) + :type variableexpense_create_object_v1_request: VariableexpenseCreateObjectV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._variableexpense_create_object_v1_serialize( + variableexpense_create_object_v1_request=variableexpense_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method variableexpense_create_object_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '201': "VariableexpenseCreateObjectV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} + def _variableexpense_create_object_v1_serialize( + self, + variableexpense_create_object_v1_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['variableexpense_create_object_v1_request'] is not None: - _body_params = _params['variableexpense_create_object_v1_request'] + if variableexpense_create_object_v1_request is not None: + _body_params = variableexpense_create_object_v1_request + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '201': "VariableexpenseCreateObjectV1Response", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/variableexpense', 'POST', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='POST', + resource_path='/1/object/variableexpense', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + - @validate_arguments - def variableexpense_edit_object_v1(self, pki_variableexpense_id : conint(strict=True, le=255, ge=1), variableexpense_edit_object_v1_request : VariableexpenseEditObjectV1Request, **kwargs) -> VariableexpenseEditObjectV1Response: # noqa: E501 - """Edit an existing Variableexpense # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.variableexpense_edit_object_v1(pki_variableexpense_id, variableexpense_edit_object_v1_request, async_req=True) - >>> result = thread.get() + @validate_call + def variableexpense_edit_object_v1( + self, + pki_variableexpense_id: Annotated[int, Field(le=255, strict=True, ge=1)], + variableexpense_edit_object_v1_request: VariableexpenseEditObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> VariableexpenseEditObjectV1Response: + """Edit an existing Variableexpense + + :param pki_variableexpense_id: (required) :type pki_variableexpense_id: int :param variableexpense_edit_object_v1_request: (required) :type variableexpense_edit_object_v1_request: VariableexpenseEditObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: VariableexpenseEditObjectV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the variableexpense_edit_object_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.variableexpense_edit_object_v1_with_http_info(pki_variableexpense_id, variableexpense_edit_object_v1_request, **kwargs) # noqa: E501 - - @validate_arguments - def variableexpense_edit_object_v1_with_http_info(self, pki_variableexpense_id : conint(strict=True, le=255, ge=1), variableexpense_edit_object_v1_request : VariableexpenseEditObjectV1Request, **kwargs) -> ApiResponse: # noqa: E501 - """Edit an existing Variableexpense # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.variableexpense_edit_object_v1_with_http_info(pki_variableexpense_id, variableexpense_edit_object_v1_request, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._variableexpense_edit_object_v1_serialize( + pki_variableexpense_id=pki_variableexpense_id, + variableexpense_edit_object_v1_request=variableexpense_edit_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "VariableexpenseEditObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def variableexpense_edit_object_v1_with_http_info( + self, + pki_variableexpense_id: Annotated[int, Field(le=255, strict=True, ge=1)], + variableexpense_edit_object_v1_request: VariableexpenseEditObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[VariableexpenseEditObjectV1Response]: + """Edit an existing Variableexpense + + :param pki_variableexpense_id: (required) :type pki_variableexpense_id: int :param variableexpense_edit_object_v1_request: (required) :type variableexpense_edit_object_v1_request: VariableexpenseEditObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(VariableexpenseEditObjectV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._variableexpense_edit_object_v1_serialize( + pki_variableexpense_id=pki_variableexpense_id, + variableexpense_edit_object_v1_request=variableexpense_edit_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '200': "VariableexpenseEditObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'pki_variableexpense_id', - 'variableexpense_edit_object_v1_request' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def variableexpense_edit_object_v1_without_preload_content( + self, + pki_variableexpense_id: Annotated[int, Field(le=255, strict=True, ge=1)], + variableexpense_edit_object_v1_request: VariableexpenseEditObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Edit an existing Variableexpense + + + + :param pki_variableexpense_id: (required) + :type pki_variableexpense_id: int + :param variableexpense_edit_object_v1_request: (required) + :type variableexpense_edit_object_v1_request: VariableexpenseEditObjectV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._variableexpense_edit_object_v1_serialize( + pki_variableexpense_id=pki_variableexpense_id, + variableexpense_edit_object_v1_request=variableexpense_edit_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method variableexpense_edit_object_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "VariableexpenseEditObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_variableexpense_id']: - _path_params['pkiVariableexpenseID'] = _params['pki_variableexpense_id'] + def _variableexpense_edit_object_v1_serialize( + self, + pki_variableexpense_id, + variableexpense_edit_object_v1_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if pki_variableexpense_id is not None: + _path_params['pkiVariableexpenseID'] = pki_variableexpense_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['variableexpense_edit_object_v1_request'] is not None: - _body_params = _params['variableexpense_edit_object_v1_request'] + if variableexpense_edit_object_v1_request is not None: + _body_params = variableexpense_edit_object_v1_request + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '200': "VariableexpenseEditObjectV1Response", - '404': "CommonResponseError", - '422': "CommonResponseError", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/variableexpense/{pkiVariableexpenseID}', 'PUT', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='PUT', + resource_path='/1/object/variableexpense/{pkiVariableexpenseID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) - @validate_arguments - def variableexpense_get_autocomplete_v2(self, s_selector : Annotated[StrictStr, Field(..., description="The type of Variableexpenses to return")], e_filter_active : Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, s_query : Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, accept_language : Optional[HeaderAcceptLanguage] = None, **kwargs) -> VariableexpenseGetAutocompleteV2Response: # noqa: E501 - """Retrieve Variableexpenses and IDs # noqa: E501 - Get the list of Variableexpense to be used in a dropdown or autocomplete control. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.variableexpense_get_autocomplete_v2(s_selector, e_filter_active, s_query, accept_language, async_req=True) - >>> result = thread.get() + + @validate_call + def variableexpense_get_autocomplete_v2( + self, + s_selector: Annotated[StrictStr, Field(description="The type of Variableexpenses to return")], + e_filter_active: Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, + s_query: Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> VariableexpenseGetAutocompleteV2Response: + """Retrieve Variableexpenses and IDs + + Get the list of Variableexpense to be used in a dropdown or autocomplete control. :param s_selector: The type of Variableexpenses to return (required) :type s_selector: str @@ -376,33 +652,76 @@ def variableexpense_get_autocomplete_v2(self, s_selector : Annotated[StrictStr, :type s_query: str :param accept_language: :type accept_language: HeaderAcceptLanguage - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: VariableexpenseGetAutocompleteV2Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the variableexpense_get_autocomplete_v2_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.variableexpense_get_autocomplete_v2_with_http_info(s_selector, e_filter_active, s_query, accept_language, **kwargs) # noqa: E501 - - @validate_arguments - def variableexpense_get_autocomplete_v2_with_http_info(self, s_selector : Annotated[StrictStr, Field(..., description="The type of Variableexpenses to return")], e_filter_active : Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, s_query : Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, accept_language : Optional[HeaderAcceptLanguage] = None, **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve Variableexpenses and IDs # noqa: E501 - - Get the list of Variableexpense to be used in a dropdown or autocomplete control. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.variableexpense_get_autocomplete_v2_with_http_info(s_selector, e_filter_active, s_query, accept_language, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._variableexpense_get_autocomplete_v2_serialize( + s_selector=s_selector, + e_filter_active=e_filter_active, + s_query=s_query, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "VariableexpenseGetAutocompleteV2Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def variableexpense_get_autocomplete_v2_with_http_info( + self, + s_selector: Annotated[StrictStr, Field(description="The type of Variableexpenses to return")], + e_filter_active: Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, + s_query: Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[VariableexpenseGetAutocompleteV2Response]: + """Retrieve Variableexpenses and IDs + + Get the list of Variableexpense to be used in a dropdown or autocomplete control. :param s_selector: The type of Variableexpenses to return (required) :type s_selector: str @@ -412,125 +731,226 @@ def variableexpense_get_autocomplete_v2_with_http_info(self, s_selector : Annota :type s_query: str :param accept_language: :type accept_language: HeaderAcceptLanguage - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(VariableexpenseGetAutocompleteV2Response, status_code(int), headers(HTTPHeaderDict)) - """ - - _params = locals() - - _all_params = [ - 's_selector', - 'e_filter_active', - 's_query', - 'accept_language' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + """ # noqa: E501 + + _param = self._variableexpense_get_autocomplete_v2_serialize( + s_selector=s_selector, + e_filter_active=e_filter_active, + s_query=s_query, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "VariableexpenseGetAutocompleteV2Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def variableexpense_get_autocomplete_v2_without_preload_content( + self, + s_selector: Annotated[StrictStr, Field(description="The type of Variableexpenses to return")], + e_filter_active: Annotated[Optional[StrictStr], Field(description="Specify which results we want to display.")] = None, + s_query: Annotated[Optional[StrictStr], Field(description="Allow to filter the returned results")] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve Variableexpenses and IDs + + Get the list of Variableexpense to be used in a dropdown or autocomplete control. + + :param s_selector: The type of Variableexpenses to return (required) + :type s_selector: str + :param e_filter_active: Specify which results we want to display. + :type e_filter_active: str + :param s_query: Allow to filter the returned results + :type s_query: str + :param accept_language: + :type accept_language: HeaderAcceptLanguage + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._variableexpense_get_autocomplete_v2_serialize( + s_selector=s_selector, + e_filter_active=e_filter_active, + s_query=s_query, + accept_language=accept_language, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method variableexpense_get_autocomplete_v2" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "VariableexpenseGetAutocompleteV2Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['s_selector']: - _path_params['sSelector'] = _params['s_selector'] + def _variableexpense_get_autocomplete_v2_serialize( + self, + s_selector, + e_filter_active, + s_query, + accept_language, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None - # process the query parameters - _query_params = [] - if _params.get('e_filter_active') is not None: # noqa: E501 - _query_params.append(('eFilterActive', _params['e_filter_active'])) + _collection_formats: Dict[str, str] = { + } - if _params.get('s_query') is not None: # noqa: E501 - _query_params.append(('sQuery', _params['s_query'])) + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if s_selector is not None: + _path_params['sSelector'] = s_selector + # process the query parameters + if e_filter_active is not None: + + _query_params.append(('eFilterActive', e_filter_active)) + + if s_query is not None: + + _query_params.append(('sQuery', s_query)) + # process the header parameters - _header_params = dict(_params.get('_headers', {})) - if _params['accept_language']: - _header_params['Accept-Language'] = _params['accept_language'] - + if accept_language is not None: + _header_params['Accept-Language'] = accept_language # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "VariableexpenseGetAutocompleteV2Response", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/2/object/variableexpense/getAutocomplete/{sSelector}', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/2/object/variableexpense/getAutocomplete/{sSelector}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) - @validate_arguments - def variableexpense_get_list_v1(self, e_order_by : Annotated[Optional[StrictStr], Field(description="Specify how you want the results to be sorted")] = None, i_row_max : Optional[conint(strict=True, le=10000, ge=1)] = None, i_row_offset : Optional[conint(strict=True, ge=0)] = None, accept_language : Optional[HeaderAcceptLanguage] = None, s_filter : Optional[StrictStr] = None, **kwargs) -> VariableexpenseGetListV1Response: # noqa: E501 - """Retrieve Variableexpense list # noqa: E501 - Enum values that can be filtered in query parameter *sFilter*: | Variable | Valid values | |---|---| | eVariableexpenseTaxable | Yes
No
Included | # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.variableexpense_get_list_v1(e_order_by, i_row_max, i_row_offset, accept_language, s_filter, async_req=True) - >>> result = thread.get() + + @validate_call + def variableexpense_get_list_v1( + self, + e_order_by: Annotated[Optional[StrictStr], Field(description="Specify how you want the results to be sorted")] = None, + i_row_max: Optional[Annotated[int, Field(le=10000, strict=True, ge=1)]] = None, + i_row_offset: Optional[Annotated[int, Field(strict=True, ge=0)]] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + s_filter: Optional[StrictStr] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> VariableexpenseGetListV1Response: + """Retrieve Variableexpense list + + Enum values that can be filtered in query parameter *sFilter*: | Variable | Valid values | |---|---| | eVariableexpenseTaxable | Yes
No
Included | :param e_order_by: Specify how you want the results to be sorted :type e_order_by: str @@ -542,33 +962,79 @@ def variableexpense_get_list_v1(self, e_order_by : Annotated[Optional[StrictStr] :type accept_language: HeaderAcceptLanguage :param s_filter: :type s_filter: str - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: VariableexpenseGetListV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the variableexpense_get_list_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.variableexpense_get_list_v1_with_http_info(e_order_by, i_row_max, i_row_offset, accept_language, s_filter, **kwargs) # noqa: E501 - - @validate_arguments - def variableexpense_get_list_v1_with_http_info(self, e_order_by : Annotated[Optional[StrictStr], Field(description="Specify how you want the results to be sorted")] = None, i_row_max : Optional[conint(strict=True, le=10000, ge=1)] = None, i_row_offset : Optional[conint(strict=True, ge=0)] = None, accept_language : Optional[HeaderAcceptLanguage] = None, s_filter : Optional[StrictStr] = None, **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve Variableexpense list # noqa: E501 - - Enum values that can be filtered in query parameter *sFilter*: | Variable | Valid values | |---|---| | eVariableexpenseTaxable | Yes
No
Included | # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.variableexpense_get_list_v1_with_http_info(e_order_by, i_row_max, i_row_offset, accept_language, s_filter, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._variableexpense_get_list_v1_serialize( + e_order_by=e_order_by, + i_row_max=i_row_max, + i_row_offset=i_row_offset, + accept_language=accept_language, + s_filter=s_filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "VariableexpenseGetListV1Response", + '406': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def variableexpense_get_list_v1_with_http_info( + self, + e_order_by: Annotated[Optional[StrictStr], Field(description="Specify how you want the results to be sorted")] = None, + i_row_max: Optional[Annotated[int, Field(le=10000, strict=True, ge=1)]] = None, + i_row_offset: Optional[Annotated[int, Field(strict=True, ge=0)]] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + s_filter: Optional[StrictStr] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[VariableexpenseGetListV1Response]: + """Retrieve Variableexpense list + + Enum values that can be filtered in query parameter *sFilter*: | Variable | Valid values | |---|---| | eVariableexpenseTaxable | Yes
No
Included | :param e_order_by: Specify how you want the results to be sorted :type e_order_by: str @@ -580,257 +1046,473 @@ def variableexpense_get_list_v1_with_http_info(self, e_order_by : Annotated[Opti :type accept_language: HeaderAcceptLanguage :param s_filter: :type s_filter: str - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(VariableexpenseGetListV1Response, status_code(int), headers(HTTPHeaderDict)) - """ - - _params = locals() - - _all_params = [ - 'e_order_by', - 'i_row_max', - 'i_row_offset', - 'accept_language', - 's_filter' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' - ] + """ # noqa: E501 + + _param = self._variableexpense_get_list_v1_serialize( + e_order_by=e_order_by, + i_row_max=i_row_max, + i_row_offset=i_row_offset, + accept_language=accept_language, + s_filter=s_filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method variableexpense_get_list_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "VariableexpenseGetListV1Response", + '406': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _collection_formats = {} - # process the path parameters - _path_params = {} + @validate_call + def variableexpense_get_list_v1_without_preload_content( + self, + e_order_by: Annotated[Optional[StrictStr], Field(description="Specify how you want the results to be sorted")] = None, + i_row_max: Optional[Annotated[int, Field(le=10000, strict=True, ge=1)]] = None, + i_row_offset: Optional[Annotated[int, Field(strict=True, ge=0)]] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + s_filter: Optional[StrictStr] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve Variableexpense list - # process the query parameters - _query_params = [] - if _params.get('e_order_by') is not None: # noqa: E501 - _query_params.append(('eOrderBy', _params['e_order_by'])) + Enum values that can be filtered in query parameter *sFilter*: | Variable | Valid values | |---|---| | eVariableexpenseTaxable | Yes
No
Included | - if _params.get('i_row_max') is not None: # noqa: E501 - _query_params.append(('iRowMax', _params['i_row_max'])) + :param e_order_by: Specify how you want the results to be sorted + :type e_order_by: str + :param i_row_max: + :type i_row_max: int + :param i_row_offset: + :type i_row_offset: int + :param accept_language: + :type accept_language: HeaderAcceptLanguage + :param s_filter: + :type s_filter: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._variableexpense_get_list_v1_serialize( + e_order_by=e_order_by, + i_row_max=i_row_max, + i_row_offset=i_row_offset, + accept_language=accept_language, + s_filter=s_filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "VariableexpenseGetListV1Response", + '406': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - if _params.get('i_row_offset') is not None: # noqa: E501 - _query_params.append(('iRowOffset', _params['i_row_offset'])) - if _params.get('s_filter') is not None: # noqa: E501 - _query_params.append(('sFilter', _params['s_filter'])) + def _variableexpense_get_list_v1_serialize( + self, + e_order_by, + i_row_max, + i_row_offset, + accept_language, + s_filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: - # process the header parameters - _header_params = dict(_params.get('_headers', {})) - if _params['accept_language']: - _header_params['Accept-Language'] = _params['accept_language'] + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + # process the query parameters + if e_order_by is not None: + + _query_params.append(('eOrderBy', e_order_by)) + + if i_row_max is not None: + + _query_params.append(('iRowMax', i_row_max)) + + if i_row_offset is not None: + + _query_params.append(('iRowOffset', i_row_offset)) + + if s_filter is not None: + + _query_params.append(('sFilter', s_filter)) + + # process the header parameters + if accept_language is not None: + _header_params['Accept-Language'] = accept_language # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet']) # noqa: E501 + [ + 'application/json', + 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "VariableexpenseGetListV1Response", - '406': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/variableexpense/getList', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/1/object/variableexpense/getList', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + - @validate_arguments - def variableexpense_get_object_v2(self, pki_variableexpense_id : conint(strict=True, le=255, ge=1), **kwargs) -> VariableexpenseGetObjectV2Response: # noqa: E501 - """Retrieve an existing Variableexpense # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.variableexpense_get_object_v2(pki_variableexpense_id, async_req=True) - >>> result = thread.get() + @validate_call + def variableexpense_get_object_v2( + self, + pki_variableexpense_id: Annotated[int, Field(le=255, strict=True, ge=1)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> VariableexpenseGetObjectV2Response: + """Retrieve an existing Variableexpense + + :param pki_variableexpense_id: (required) :type pki_variableexpense_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: VariableexpenseGetObjectV2Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the variableexpense_get_object_v2_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.variableexpense_get_object_v2_with_http_info(pki_variableexpense_id, **kwargs) # noqa: E501 - - @validate_arguments - def variableexpense_get_object_v2_with_http_info(self, pki_variableexpense_id : conint(strict=True, le=255, ge=1), **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve an existing Variableexpense # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.variableexpense_get_object_v2_with_http_info(pki_variableexpense_id, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._variableexpense_get_object_v2_serialize( + pki_variableexpense_id=pki_variableexpense_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "VariableexpenseGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def variableexpense_get_object_v2_with_http_info( + self, + pki_variableexpense_id: Annotated[int, Field(le=255, strict=True, ge=1)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[VariableexpenseGetObjectV2Response]: + """Retrieve an existing Variableexpense + + :param pki_variableexpense_id: (required) :type pki_variableexpense_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(VariableexpenseGetObjectV2Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._variableexpense_get_object_v2_serialize( + pki_variableexpense_id=pki_variableexpense_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "VariableexpenseGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _params = locals() - _all_params = [ - 'pki_variableexpense_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + @validate_call + def variableexpense_get_object_v2_without_preload_content( + self, + pki_variableexpense_id: Annotated[int, Field(le=255, strict=True, ge=1)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve an existing Variableexpense + + + + :param pki_variableexpense_id: (required) + :type pki_variableexpense_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._variableexpense_get_object_v2_serialize( + pki_variableexpense_id=pki_variableexpense_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method variableexpense_get_object_v2" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "VariableexpenseGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_variableexpense_id']: - _path_params['pkiVariableexpenseID'] = _params['pki_variableexpense_id'] + def _variableexpense_get_object_v2_serialize( + self, + pki_variableexpense_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_variableexpense_id is not None: + _path_params['pkiVariableexpenseID'] = pki_variableexpense_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "VariableexpenseGetObjectV2Response", - '404': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/2/object/variableexpense/{pkiVariableexpenseID}', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/2/object/variableexpense/{pkiVariableexpenseID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/eZmaxApi/api/object_versionhistory_api.py b/eZmaxApi/api/object_versionhistory_api.py index b1fa8c0f1..88e2f190d 100644 --- a/eZmaxApi/api/object_versionhistory_api.py +++ b/eZmaxApi/api/object_versionhistory_api.py @@ -13,22 +13,24 @@ """ # noqa: E501 -import re # noqa: F401 import io import warnings -from pydantic import validate_arguments, ValidationError +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Dict, List, Optional, Tuple, Union, Any -from pydantic import conint +try: + from typing import Annotated +except ImportError: + from typing_extensions import Annotated +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.versionhistory_get_object_v2_response import VersionhistoryGetObjectV2Response from eZmaxApi.api_client import ApiClient from eZmaxApi.api_response import ApiResponse -from eZmaxApi.exceptions import ( # noqa: F401 - ApiTypeError, - ApiValueError -) +from eZmaxApi.rest import RESTResponseType class ObjectVersionhistoryApi: @@ -43,143 +45,263 @@ def __init__(self, api_client=None) -> None: api_client = ApiClient.get_default() self.api_client = api_client - @validate_arguments - def versionhistory_get_object_v2(self, pki_versionhistory_id : conint(strict=True, ge=0), **kwargs) -> VersionhistoryGetObjectV2Response: # noqa: E501 - """Retrieve an existing Versionhistory # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def versionhistory_get_object_v2( + self, + pki_versionhistory_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> VersionhistoryGetObjectV2Response: + """Retrieve an existing Versionhistory - >>> thread = api.versionhistory_get_object_v2(pki_versionhistory_id, async_req=True) - >>> result = thread.get() + :param pki_versionhistory_id: (required) :type pki_versionhistory_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: VersionhistoryGetObjectV2Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the versionhistory_get_object_v2_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.versionhistory_get_object_v2_with_http_info(pki_versionhistory_id, **kwargs) # noqa: E501 - - @validate_arguments - def versionhistory_get_object_v2_with_http_info(self, pki_versionhistory_id : conint(strict=True, ge=0), **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve an existing Versionhistory # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.versionhistory_get_object_v2_with_http_info(pki_versionhistory_id, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._versionhistory_get_object_v2_serialize( + pki_versionhistory_id=pki_versionhistory_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "VersionhistoryGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def versionhistory_get_object_v2_with_http_info( + self, + pki_versionhistory_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[VersionhistoryGetObjectV2Response]: + """Retrieve an existing Versionhistory + + :param pki_versionhistory_id: (required) :type pki_versionhistory_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(VersionhistoryGetObjectV2Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._versionhistory_get_object_v2_serialize( + pki_versionhistory_id=pki_versionhistory_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '200': "VersionhistoryGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'pki_versionhistory_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def versionhistory_get_object_v2_without_preload_content( + self, + pki_versionhistory_id: Annotated[int, Field(strict=True, ge=0)], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve an existing Versionhistory + + + + :param pki_versionhistory_id: (required) + :type pki_versionhistory_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._versionhistory_get_object_v2_serialize( + pki_versionhistory_id=pki_versionhistory_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method versionhistory_get_object_v2" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "VersionhistoryGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_versionhistory_id']: - _path_params['pkiVersionhistoryID'] = _params['pki_versionhistory_id'] + def _versionhistory_get_object_v2_serialize( + self, + pki_versionhistory_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_versionhistory_id is not None: + _path_params['pkiVersionhistoryID'] = pki_versionhistory_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "VersionhistoryGetObjectV2Response", - '404': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/2/object/versionhistory/{pkiVersionhistoryID}', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/2/object/versionhistory/{pkiVersionhistoryID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/eZmaxApi/api/object_webhook_api.py b/eZmaxApi/api/object_webhook_api.py index 92071d282..c365daaca 100644 --- a/eZmaxApi/api/object_webhook_api.py +++ b/eZmaxApi/api/object_webhook_api.py @@ -13,34 +13,41 @@ """ # noqa: E501 -import re # noqa: F401 import io import warnings -from pydantic import validate_arguments, ValidationError +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Dict, List, Optional, Tuple, Union, Any +try: + from typing import Annotated +except ImportError: + from typing_extensions import Annotated + +from pydantic import Field from typing_extensions import Annotated -from pydantic import Field, StrictInt, StrictStr, conint +from pydantic import StrictInt, StrictStr, field_validator from typing import Any, Dict, Optional from eZmaxApi.models.header_accept_language import HeaderAcceptLanguage from eZmaxApi.models.webhook_create_object_v1_request import WebhookCreateObjectV1Request from eZmaxApi.models.webhook_create_object_v1_response import WebhookCreateObjectV1Response +from eZmaxApi.models.webhook_create_object_v2_request import WebhookCreateObjectV2Request +from eZmaxApi.models.webhook_create_object_v2_response import WebhookCreateObjectV2Response from eZmaxApi.models.webhook_delete_object_v1_response import WebhookDeleteObjectV1Response from eZmaxApi.models.webhook_edit_object_v1_request import WebhookEditObjectV1Request from eZmaxApi.models.webhook_edit_object_v1_response import WebhookEditObjectV1Response from eZmaxApi.models.webhook_get_history_v1_response import WebhookGetHistoryV1Response from eZmaxApi.models.webhook_get_list_v1_response import WebhookGetListV1Response from eZmaxApi.models.webhook_get_object_v2_response import WebhookGetObjectV2Response +from eZmaxApi.models.webhook_regenerate_apikey_v1_request import WebhookRegenerateApikeyV1Request +from eZmaxApi.models.webhook_regenerate_apikey_v1_response import WebhookRegenerateApikeyV1Response from eZmaxApi.models.webhook_test_v1_response import WebhookTestV1Response from eZmaxApi.api_client import ApiClient from eZmaxApi.api_response import ApiResponse -from eZmaxApi.exceptions import ( # noqa: F401 - ApiTypeError, - ApiValueError -) +from eZmaxApi.rest import RESTResponseType class ObjectWebhookApi: @@ -55,648 +62,1491 @@ def __init__(self, api_client=None) -> None: api_client = ApiClient.get_default() self.api_client = api_client - @validate_arguments - def webhook_create_object_v1(self, webhook_create_object_v1_request : WebhookCreateObjectV1Request, **kwargs) -> WebhookCreateObjectV1Response: # noqa: E501 - """Create a new Webhook # noqa: E501 - The endpoint allows to create one or many elements at once. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def webhook_create_object_v1( + self, + webhook_create_object_v1_request: WebhookCreateObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> WebhookCreateObjectV1Response: + """(Deprecated) Create a new Webhook - >>> thread = api.webhook_create_object_v1(webhook_create_object_v1_request, async_req=True) - >>> result = thread.get() + The endpoint allows to create one or many elements at once. :param webhook_create_object_v1_request: (required) :type webhook_create_object_v1_request: WebhookCreateObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: WebhookCreateObjectV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the webhook_create_object_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.webhook_create_object_v1_with_http_info(webhook_create_object_v1_request, **kwargs) # noqa: E501 - - @validate_arguments - def webhook_create_object_v1_with_http_info(self, webhook_create_object_v1_request : WebhookCreateObjectV1Request, **kwargs) -> ApiResponse: # noqa: E501 - """Create a new Webhook # noqa: E501 - - The endpoint allows to create one or many elements at once. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.webhook_create_object_v1_with_http_info(webhook_create_object_v1_request, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + warnings.warn("POST /1/object/webhook is deprecated.", DeprecationWarning) + + _param = self._webhook_create_object_v1_serialize( + webhook_create_object_v1_request=webhook_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "WebhookCreateObjectV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def webhook_create_object_v1_with_http_info( + self, + webhook_create_object_v1_request: WebhookCreateObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[WebhookCreateObjectV1Response]: + """(Deprecated) Create a new Webhook + + The endpoint allows to create one or many elements at once. :param webhook_create_object_v1_request: (required) :type webhook_create_object_v1_request: WebhookCreateObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(WebhookCreateObjectV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + warnings.warn("POST /1/object/webhook is deprecated.", DeprecationWarning) + + _param = self._webhook_create_object_v1_serialize( + webhook_create_object_v1_request=webhook_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '201': "WebhookCreateObjectV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'webhook_create_object_v1_request' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def webhook_create_object_v1_without_preload_content( + self, + webhook_create_object_v1_request: WebhookCreateObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """(Deprecated) Create a new Webhook + + The endpoint allows to create one or many elements at once. + + :param webhook_create_object_v1_request: (required) + :type webhook_create_object_v1_request: WebhookCreateObjectV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + warnings.warn("POST /1/object/webhook is deprecated.", DeprecationWarning) + + _param = self._webhook_create_object_v1_serialize( + webhook_create_object_v1_request=webhook_create_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method webhook_create_object_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '201': "WebhookCreateObjectV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} + def _webhook_create_object_v1_serialize( + self, + webhook_create_object_v1_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['webhook_create_object_v1_request'] is not None: - _body_params = _params['webhook_create_object_v1_request'] + if webhook_create_object_v1_request is not None: + _body_params = webhook_create_object_v1_request + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '201': "WebhookCreateObjectV1Response", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/webhook', 'POST', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='POST', + resource_path='/1/object/webhook', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) - @validate_arguments - def webhook_delete_object_v1(self, pki_webhook_id : StrictInt, **kwargs) -> WebhookDeleteObjectV1Response: # noqa: E501 - """Delete an existing Webhook # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.webhook_delete_object_v1(pki_webhook_id, async_req=True) - >>> result = thread.get() - :param pki_webhook_id: (required) - :type pki_webhook_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + @validate_call + def webhook_create_object_v2( + self, + webhook_create_object_v2_request: WebhookCreateObjectV2Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> WebhookCreateObjectV2Response: + """Create a new Webhook + + The endpoint allows to create one or many elements at once. + + :param webhook_create_object_v2_request: (required) + :type webhook_create_object_v2_request: WebhookCreateObjectV2Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: WebhookDeleteObjectV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the webhook_delete_object_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.webhook_delete_object_v1_with_http_info(pki_webhook_id, **kwargs) # noqa: E501 - - @validate_arguments - def webhook_delete_object_v1_with_http_info(self, pki_webhook_id : StrictInt, **kwargs) -> ApiResponse: # noqa: E501 - """Delete an existing Webhook # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.webhook_delete_object_v1_with_http_info(pki_webhook_id, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._webhook_create_object_v2_serialize( + webhook_create_object_v2_request=webhook_create_object_v2_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - :param pki_webhook_id: (required) - :type pki_webhook_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional + _response_types_map: Dict[str, Optional[str]] = { + '201': "WebhookCreateObjectV2Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def webhook_create_object_v2_with_http_info( + self, + webhook_create_object_v2_request: WebhookCreateObjectV2Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[WebhookCreateObjectV2Response]: + """Create a new Webhook + + The endpoint allows to create one or many elements at once. + + :param webhook_create_object_v2_request: (required) + :type webhook_create_object_v2_request: WebhookCreateObjectV2Request :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(WebhookDeleteObjectV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._webhook_create_object_v2_serialize( + webhook_create_object_v2_request=webhook_create_object_v2_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '201': "WebhookCreateObjectV2Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'pki_webhook_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def webhook_create_object_v2_without_preload_content( + self, + webhook_create_object_v2_request: WebhookCreateObjectV2Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Create a new Webhook + + The endpoint allows to create one or many elements at once. + + :param webhook_create_object_v2_request: (required) + :type webhook_create_object_v2_request: WebhookCreateObjectV2Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._webhook_create_object_v2_serialize( + webhook_create_object_v2_request=webhook_create_object_v2_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method webhook_delete_object_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '201': "WebhookCreateObjectV2Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_webhook_id']: - _path_params['pkiWebhookID'] = _params['pki_webhook_id'] + def _webhook_create_object_v2_serialize( + self, + webhook_create_object_v2_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + if webhook_create_object_v2_request is not None: + _body_params = webhook_create_object_v2_request + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type - _response_types_map = { - '200': "WebhookDeleteObjectV1Response", - '404': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/webhook/{pkiWebhookID}', 'DELETE', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='POST', + resource_path='/2/object/webhook', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + - @validate_arguments - def webhook_edit_object_v1(self, pki_webhook_id : StrictInt, webhook_edit_object_v1_request : WebhookEditObjectV1Request, **kwargs) -> WebhookEditObjectV1Response: # noqa: E501 - """Edit an existing Webhook # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.webhook_edit_object_v1(pki_webhook_id, webhook_edit_object_v1_request, async_req=True) - >>> result = thread.get() + @validate_call + def webhook_delete_object_v1( + self, + pki_webhook_id: StrictInt, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> WebhookDeleteObjectV1Response: + """Delete an existing Webhook + + :param pki_webhook_id: (required) :type pki_webhook_id: int - :param webhook_edit_object_v1_request: (required) - :type webhook_edit_object_v1_request: WebhookEditObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: WebhookEditObjectV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the webhook_edit_object_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.webhook_edit_object_v1_with_http_info(pki_webhook_id, webhook_edit_object_v1_request, **kwargs) # noqa: E501 - - @validate_arguments - def webhook_edit_object_v1_with_http_info(self, pki_webhook_id : StrictInt, webhook_edit_object_v1_request : WebhookEditObjectV1Request, **kwargs) -> ApiResponse: # noqa: E501 - """Edit an existing Webhook # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.webhook_edit_object_v1_with_http_info(pki_webhook_id, webhook_edit_object_v1_request, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._webhook_delete_object_v1_serialize( + pki_webhook_id=pki_webhook_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "WebhookDeleteObjectV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def webhook_delete_object_v1_with_http_info( + self, + pki_webhook_id: StrictInt, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[WebhookDeleteObjectV1Response]: + """Delete an existing Webhook + + :param pki_webhook_id: (required) :type pki_webhook_id: int - :param webhook_edit_object_v1_request: (required) - :type webhook_edit_object_v1_request: WebhookEditObjectV1Request - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(WebhookEditObjectV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._webhook_delete_object_v1_serialize( + pki_webhook_id=pki_webhook_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "WebhookDeleteObjectV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _params = locals() - _all_params = [ - 'pki_webhook_id', - 'webhook_edit_object_v1_request' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + @validate_call + def webhook_delete_object_v1_without_preload_content( + self, + pki_webhook_id: StrictInt, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete an existing Webhook + + + + :param pki_webhook_id: (required) + :type pki_webhook_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._webhook_delete_object_v1_serialize( + pki_webhook_id=pki_webhook_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method webhook_edit_object_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "WebhookDeleteObjectV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_webhook_id']: - _path_params['pkiWebhookID'] = _params['pki_webhook_id'] + def _webhook_delete_object_v1_serialize( + self, + pki_webhook_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_webhook_id is not None: + _path_params['pkiWebhookID'] = pki_webhook_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['webhook_edit_object_v1_request'] is not None: - _body_params = _params['webhook_edit_object_v1_request'] + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '200': "WebhookEditObjectV1Response", - '404': "CommonResponseError", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/webhook/{pkiWebhookID}', 'PUT', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='DELETE', + resource_path='/1/object/webhook/{pkiWebhookID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) - @validate_arguments - def webhook_get_history_v1(self, pki_webhook_id : StrictInt, e_webhook_historyinterval : Annotated[StrictStr, Field(..., description="The number of days to return")], **kwargs) -> WebhookGetHistoryV1Response: # noqa: E501 - """Retrieve the logs for recent Webhook calls # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.webhook_get_history_v1(pki_webhook_id, e_webhook_historyinterval, async_req=True) - >>> result = thread.get() + + @validate_call + def webhook_edit_object_v1( + self, + pki_webhook_id: StrictInt, + webhook_edit_object_v1_request: WebhookEditObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> WebhookEditObjectV1Response: + """Edit an existing Webhook + + :param pki_webhook_id: (required) :type pki_webhook_id: int - :param e_webhook_historyinterval: The number of days to return (required) - :type e_webhook_historyinterval: str - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param webhook_edit_object_v1_request: (required) + :type webhook_edit_object_v1_request: WebhookEditObjectV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: WebhookGetHistoryV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the webhook_get_history_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.webhook_get_history_v1_with_http_info(pki_webhook_id, e_webhook_historyinterval, **kwargs) # noqa: E501 - - @validate_arguments - def webhook_get_history_v1_with_http_info(self, pki_webhook_id : StrictInt, e_webhook_historyinterval : Annotated[StrictStr, Field(..., description="The number of days to return")], **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve the logs for recent Webhook calls # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.webhook_get_history_v1_with_http_info(pki_webhook_id, e_webhook_historyinterval, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._webhook_edit_object_v1_serialize( + pki_webhook_id=pki_webhook_id, + webhook_edit_object_v1_request=webhook_edit_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "WebhookEditObjectV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def webhook_edit_object_v1_with_http_info( + self, + pki_webhook_id: StrictInt, + webhook_edit_object_v1_request: WebhookEditObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[WebhookEditObjectV1Response]: + """Edit an existing Webhook + + :param pki_webhook_id: (required) :type pki_webhook_id: int - :param e_webhook_historyinterval: The number of days to return (required) - :type e_webhook_historyinterval: str - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional + :param webhook_edit_object_v1_request: (required) + :type webhook_edit_object_v1_request: WebhookEditObjectV1Request :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(WebhookGetHistoryV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._webhook_edit_object_v1_serialize( + pki_webhook_id=pki_webhook_id, + webhook_edit_object_v1_request=webhook_edit_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "WebhookEditObjectV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _params = locals() - _all_params = [ - 'pki_webhook_id', - 'e_webhook_historyinterval' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + @validate_call + def webhook_edit_object_v1_without_preload_content( + self, + pki_webhook_id: StrictInt, + webhook_edit_object_v1_request: WebhookEditObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Edit an existing Webhook + + + + :param pki_webhook_id: (required) + :type pki_webhook_id: int + :param webhook_edit_object_v1_request: (required) + :type webhook_edit_object_v1_request: WebhookEditObjectV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._webhook_edit_object_v1_serialize( + pki_webhook_id=pki_webhook_id, + webhook_edit_object_v1_request=webhook_edit_object_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method webhook_get_history_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "WebhookEditObjectV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_webhook_id']: - _path_params['pkiWebhookID'] = _params['pki_webhook_id'] + def _webhook_edit_object_v1_serialize( + self, + pki_webhook_id, + webhook_edit_object_v1_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None - # process the query parameters - _query_params = [] - if _params.get('e_webhook_historyinterval') is not None: # noqa: E501 - _query_params.append(('eWebhookHistoryinterval', _params['e_webhook_historyinterval'])) + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if pki_webhook_id is not None: + _path_params['pkiWebhookID'] = pki_webhook_id + # process the query parameters # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + if webhook_edit_object_v1_request is not None: + _body_params = webhook_edit_object_v1_request + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type - _response_types_map = { - '200': "WebhookGetHistoryV1Response", - '404': "CommonResponseError", - '429': "CommonResponseErrorTooManyRequests", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/webhook/{pkiWebhookID}/getHistory', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='PUT', + resource_path='/1/object/webhook/{pkiWebhookID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) - @validate_arguments - def webhook_get_list_v1(self, e_order_by : Annotated[Optional[StrictStr], Field(description="Specify how you want the results to be sorted")] = None, i_row_max : Optional[conint(strict=True, le=10000, ge=1)] = None, i_row_offset : Optional[conint(strict=True, ge=0)] = None, accept_language : Optional[HeaderAcceptLanguage] = None, s_filter : Optional[StrictStr] = None, **kwargs) -> WebhookGetListV1Response: # noqa: E501 - """Retrieve Webhook list # noqa: E501 - Enum values that can be filtered in query parameter *sFilter*: | Variable | Valid values | |---|---| | eWebhookModule | Ezsign
Management | | eWebhookEzsignevent | DocumentCompleted
FolderCompleted | | eWebhookManagementevent | UserCreated | # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.webhook_get_list_v1(e_order_by, i_row_max, i_row_offset, accept_language, s_filter, async_req=True) - >>> result = thread.get() - :param e_order_by: Specify how you want the results to be sorted - :type e_order_by: str - :param i_row_max: - :type i_row_max: int + @validate_call + def webhook_get_history_v1( + self, + pki_webhook_id: StrictInt, + e_webhook_historyinterval: Annotated[StrictStr, Field(description="The number of days to return")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> WebhookGetHistoryV1Response: + """Retrieve the logs for recent Webhook calls + + + + :param pki_webhook_id: (required) + :type pki_webhook_id: int + :param e_webhook_historyinterval: The number of days to return (required) + :type e_webhook_historyinterval: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._webhook_get_history_v1_serialize( + pki_webhook_id=pki_webhook_id, + e_webhook_historyinterval=e_webhook_historyinterval, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "WebhookGetHistoryV1Response", + '404': "CommonResponseError", + '429': "CommonResponseErrorTooManyRequests", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def webhook_get_history_v1_with_http_info( + self, + pki_webhook_id: StrictInt, + e_webhook_historyinterval: Annotated[StrictStr, Field(description="The number of days to return")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[WebhookGetHistoryV1Response]: + """Retrieve the logs for recent Webhook calls + + + + :param pki_webhook_id: (required) + :type pki_webhook_id: int + :param e_webhook_historyinterval: The number of days to return (required) + :type e_webhook_historyinterval: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._webhook_get_history_v1_serialize( + pki_webhook_id=pki_webhook_id, + e_webhook_historyinterval=e_webhook_historyinterval, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "WebhookGetHistoryV1Response", + '404': "CommonResponseError", + '429': "CommonResponseErrorTooManyRequests", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def webhook_get_history_v1_without_preload_content( + self, + pki_webhook_id: StrictInt, + e_webhook_historyinterval: Annotated[StrictStr, Field(description="The number of days to return")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve the logs for recent Webhook calls + + + + :param pki_webhook_id: (required) + :type pki_webhook_id: int + :param e_webhook_historyinterval: The number of days to return (required) + :type e_webhook_historyinterval: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._webhook_get_history_v1_serialize( + pki_webhook_id=pki_webhook_id, + e_webhook_historyinterval=e_webhook_historyinterval, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "WebhookGetHistoryV1Response", + '404': "CommonResponseError", + '429': "CommonResponseErrorTooManyRequests", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _webhook_get_history_v1_serialize( + self, + pki_webhook_id, + e_webhook_historyinterval, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_webhook_id is not None: + _path_params['pkiWebhookID'] = pki_webhook_id + # process the query parameters + if e_webhook_historyinterval is not None: + + _query_params.append(('eWebhookHistoryinterval', e_webhook_historyinterval)) + + # process the header parameters + # process the form parameters + # process the body parameter + + + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) + + + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] + + return self.api_client.param_serialize( + method='GET', + resource_path='/1/object/webhook/{pkiWebhookID}/getHistory', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def webhook_get_list_v1( + self, + e_order_by: Annotated[Optional[StrictStr], Field(description="Specify how you want the results to be sorted")] = None, + i_row_max: Optional[Annotated[int, Field(le=10000, strict=True, ge=1)]] = None, + i_row_offset: Optional[Annotated[int, Field(strict=True, ge=0)]] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + s_filter: Optional[StrictStr] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> WebhookGetListV1Response: + """Retrieve Webhook list + + Enum values that can be filtered in query parameter *sFilter*: | Variable | Valid values | |---|---| | eWebhookModule | Ezsign
Management | | eWebhookEzsignevent | DocumentCompleted
FolderCompleted | | eWebhookManagementevent | UserCreated | + + :param e_order_by: Specify how you want the results to be sorted + :type e_order_by: str + :param i_row_max: + :type i_row_max: int :param i_row_offset: :type i_row_offset: int :param accept_language: :type accept_language: HeaderAcceptLanguage :param s_filter: :type s_filter: str - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: WebhookGetListV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the webhook_get_list_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.webhook_get_list_v1_with_http_info(e_order_by, i_row_max, i_row_offset, accept_language, s_filter, **kwargs) # noqa: E501 - - @validate_arguments - def webhook_get_list_v1_with_http_info(self, e_order_by : Annotated[Optional[StrictStr], Field(description="Specify how you want the results to be sorted")] = None, i_row_max : Optional[conint(strict=True, le=10000, ge=1)] = None, i_row_offset : Optional[conint(strict=True, ge=0)] = None, accept_language : Optional[HeaderAcceptLanguage] = None, s_filter : Optional[StrictStr] = None, **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve Webhook list # noqa: E501 - - Enum values that can be filtered in query parameter *sFilter*: | Variable | Valid values | |---|---| | eWebhookModule | Ezsign
Management | | eWebhookEzsignevent | DocumentCompleted
FolderCompleted | | eWebhookManagementevent | UserCreated | # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.webhook_get_list_v1_with_http_info(e_order_by, i_row_max, i_row_offset, accept_language, s_filter, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._webhook_get_list_v1_serialize( + e_order_by=e_order_by, + i_row_max=i_row_max, + i_row_offset=i_row_offset, + accept_language=accept_language, + s_filter=s_filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "WebhookGetListV1Response", + '406': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def webhook_get_list_v1_with_http_info( + self, + e_order_by: Annotated[Optional[StrictStr], Field(description="Specify how you want the results to be sorted")] = None, + i_row_max: Optional[Annotated[int, Field(le=10000, strict=True, ge=1)]] = None, + i_row_offset: Optional[Annotated[int, Field(strict=True, ge=0)]] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + s_filter: Optional[StrictStr] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[WebhookGetListV1Response]: + """Retrieve Webhook list + + Enum values that can be filtered in query parameter *sFilter*: | Variable | Valid values | |---|---| | eWebhookModule | Ezsign
Management | | eWebhookEzsignevent | DocumentCompleted
FolderCompleted | | eWebhookManagementevent | UserCreated | :param e_order_by: Specify how you want the results to be sorted :type e_order_by: str @@ -708,413 +1558,1051 @@ def webhook_get_list_v1_with_http_info(self, e_order_by : Annotated[Optional[Str :type accept_language: HeaderAcceptLanguage :param s_filter: :type s_filter: str - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(WebhookGetListV1Response, status_code(int), headers(HTTPHeaderDict)) - """ - - _params = locals() - - _all_params = [ - 'e_order_by', - 'i_row_max', - 'i_row_offset', - 'accept_language', - 's_filter' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' - ] + """ # noqa: E501 + + _param = self._webhook_get_list_v1_serialize( + e_order_by=e_order_by, + i_row_max=i_row_max, + i_row_offset=i_row_offset, + accept_language=accept_language, + s_filter=s_filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method webhook_get_list_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "WebhookGetListV1Response", + '406': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _collection_formats = {} - # process the path parameters - _path_params = {} + @validate_call + def webhook_get_list_v1_without_preload_content( + self, + e_order_by: Annotated[Optional[StrictStr], Field(description="Specify how you want the results to be sorted")] = None, + i_row_max: Optional[Annotated[int, Field(le=10000, strict=True, ge=1)]] = None, + i_row_offset: Optional[Annotated[int, Field(strict=True, ge=0)]] = None, + accept_language: Optional[HeaderAcceptLanguage] = None, + s_filter: Optional[StrictStr] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve Webhook list - # process the query parameters - _query_params = [] - if _params.get('e_order_by') is not None: # noqa: E501 - _query_params.append(('eOrderBy', _params['e_order_by'])) + Enum values that can be filtered in query parameter *sFilter*: | Variable | Valid values | |---|---| | eWebhookModule | Ezsign
Management | | eWebhookEzsignevent | DocumentCompleted
FolderCompleted | | eWebhookManagementevent | UserCreated | + + :param e_order_by: Specify how you want the results to be sorted + :type e_order_by: str + :param i_row_max: + :type i_row_max: int + :param i_row_offset: + :type i_row_offset: int + :param accept_language: + :type accept_language: HeaderAcceptLanguage + :param s_filter: + :type s_filter: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._webhook_get_list_v1_serialize( + e_order_by=e_order_by, + i_row_max=i_row_max, + i_row_offset=i_row_offset, + accept_language=accept_language, + s_filter=s_filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - if _params.get('i_row_max') is not None: # noqa: E501 - _query_params.append(('iRowMax', _params['i_row_max'])) + _response_types_map: Dict[str, Optional[str]] = { + '200': "WebhookGetListV1Response", + '406': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - if _params.get('i_row_offset') is not None: # noqa: E501 - _query_params.append(('iRowOffset', _params['i_row_offset'])) - if _params.get('s_filter') is not None: # noqa: E501 - _query_params.append(('sFilter', _params['s_filter'])) + def _webhook_get_list_v1_serialize( + self, + e_order_by, + i_row_max, + i_row_offset, + accept_language, + s_filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: - # process the header parameters - _header_params = dict(_params.get('_headers', {})) - if _params['accept_language']: - _header_params['Accept-Language'] = _params['accept_language'] + _host = None + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if e_order_by is not None: + + _query_params.append(('eOrderBy', e_order_by)) + + if i_row_max is not None: + + _query_params.append(('iRowMax', i_row_max)) + + if i_row_offset is not None: + + _query_params.append(('iRowOffset', i_row_offset)) + + if s_filter is not None: + + _query_params.append(('sFilter', s_filter)) + + # process the header parameters + if accept_language is not None: + _header_params['Accept-Language'] = accept_language # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet']) # noqa: E501 + [ + 'application/json', + 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet' + ] + ) - # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - _response_types_map = { - '200': "WebhookGetListV1Response", - '406': "CommonResponseError", - } + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/webhook/getList', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/1/object/webhook/getList', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + - @validate_arguments - def webhook_get_object_v2(self, pki_webhook_id : StrictInt, **kwargs) -> WebhookGetObjectV2Response: # noqa: E501 - """Retrieve an existing Webhook # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def webhook_get_object_v2( + self, + pki_webhook_id: StrictInt, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> WebhookGetObjectV2Response: + """Retrieve an existing Webhook - >>> thread = api.webhook_get_object_v2(pki_webhook_id, async_req=True) - >>> result = thread.get() + :param pki_webhook_id: (required) :type pki_webhook_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: WebhookGetObjectV2Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the webhook_get_object_v2_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.webhook_get_object_v2_with_http_info(pki_webhook_id, **kwargs) # noqa: E501 - - @validate_arguments - def webhook_get_object_v2_with_http_info(self, pki_webhook_id : StrictInt, **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve an existing Webhook # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.webhook_get_object_v2_with_http_info(pki_webhook_id, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._webhook_get_object_v2_serialize( + pki_webhook_id=pki_webhook_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "WebhookGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def webhook_get_object_v2_with_http_info( + self, + pki_webhook_id: StrictInt, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[WebhookGetObjectV2Response]: + """Retrieve an existing Webhook + + :param pki_webhook_id: (required) :type pki_webhook_id: int - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(WebhookGetObjectV2Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._webhook_get_object_v2_serialize( + pki_webhook_id=pki_webhook_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '200': "WebhookGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'pki_webhook_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def webhook_get_object_v2_without_preload_content( + self, + pki_webhook_id: StrictInt, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve an existing Webhook + + + + :param pki_webhook_id: (required) + :type pki_webhook_id: int + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._webhook_get_object_v2_serialize( + pki_webhook_id=pki_webhook_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method webhook_get_object_v2" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "WebhookGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_webhook_id']: - _path_params['pkiWebhookID'] = _params['pki_webhook_id'] + def _webhook_get_object_v2_serialize( + self, + pki_webhook_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if pki_webhook_id is not None: + _path_params['pkiWebhookID'] = pki_webhook_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) + # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 + _auth_settings: List[str] = [ + 'Authorization' + ] - _response_types_map = { - '200': "WebhookGetObjectV2Response", + return self.api_client.param_serialize( + method='GET', + resource_path='/2/object/webhook/{pkiWebhookID}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth + ) + + + + + @validate_call + def webhook_regenerate_apikey_v1( + self, + pki_webhook_id: StrictInt, + webhook_regenerate_apikey_v1_request: WebhookRegenerateApikeyV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> WebhookRegenerateApikeyV1Response: + """Regenerate the Apikey + + + + :param pki_webhook_id: (required) + :type pki_webhook_id: int + :param webhook_regenerate_apikey_v1_request: (required) + :type webhook_regenerate_apikey_v1_request: WebhookRegenerateApikeyV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._webhook_regenerate_apikey_v1_serialize( + pki_webhook_id=pki_webhook_id, + webhook_regenerate_apikey_v1_request=webhook_regenerate_apikey_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "WebhookRegenerateApikeyV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def webhook_regenerate_apikey_v1_with_http_info( + self, + pki_webhook_id: StrictInt, + webhook_regenerate_apikey_v1_request: WebhookRegenerateApikeyV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[WebhookRegenerateApikeyV1Response]: + """Regenerate the Apikey + + + + :param pki_webhook_id: (required) + :type pki_webhook_id: int + :param webhook_regenerate_apikey_v1_request: (required) + :type webhook_regenerate_apikey_v1_request: WebhookRegenerateApikeyV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._webhook_regenerate_apikey_v1_serialize( + pki_webhook_id=pki_webhook_id, + webhook_regenerate_apikey_v1_request=webhook_regenerate_apikey_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "WebhookRegenerateApikeyV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def webhook_regenerate_apikey_v1_without_preload_content( + self, + pki_webhook_id: StrictInt, + webhook_regenerate_apikey_v1_request: WebhookRegenerateApikeyV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Regenerate the Apikey + + + + :param pki_webhook_id: (required) + :type pki_webhook_id: int + :param webhook_regenerate_apikey_v1_request: (required) + :type webhook_regenerate_apikey_v1_request: WebhookRegenerateApikeyV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._webhook_regenerate_apikey_v1_serialize( + pki_webhook_id=pki_webhook_id, + webhook_regenerate_apikey_v1_request=webhook_regenerate_apikey_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "WebhookRegenerateApikeyV1Response", '404': "CommonResponseError", } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _webhook_regenerate_apikey_v1_serialize( + self, + pki_webhook_id, + webhook_regenerate_apikey_v1_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_webhook_id is not None: + _path_params['pkiWebhookID'] = pki_webhook_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if webhook_regenerate_apikey_v1_request is not None: + _body_params = webhook_regenerate_apikey_v1_request + + + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + [ + 'application/json' + ] + ) - return self.api_client.call_api( - '/2/object/webhook/{pkiWebhookID}', 'GET', - _path_params, - _query_params, - _header_params, + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = [ + 'Authorization' + ] + + return self.api_client.param_serialize( + method='POST', + resource_path='/1/object/webhook/{pkiWebhookID}/regenerateApikey', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + - @validate_arguments - def webhook_test_v1(self, pki_webhook_id : StrictInt, body : Dict[str, Any], **kwargs) -> WebhookTestV1Response: # noqa: E501 - """Test the Webhook by calling the Url # noqa: E501 - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.webhook_test_v1(pki_webhook_id, body, async_req=True) - >>> result = thread.get() + @validate_call + def webhook_test_v1( + self, + pki_webhook_id: StrictInt, + body: Dict[str, Any], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> WebhookTestV1Response: + """Test the Webhook by calling the Url + + :param pki_webhook_id: (required) :type pki_webhook_id: int :param body: (required) :type body: object - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: WebhookTestV1Response - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the webhook_test_v1_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.webhook_test_v1_with_http_info(pki_webhook_id, body, **kwargs) # noqa: E501 - - @validate_arguments - def webhook_test_v1_with_http_info(self, pki_webhook_id : StrictInt, body : Dict[str, Any], **kwargs) -> ApiResponse: # noqa: E501 - """Test the Webhook by calling the Url # noqa: E501 - - # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.webhook_test_v1_with_http_info(pki_webhook_id, body, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._webhook_test_v1_serialize( + pki_webhook_id=pki_webhook_id, + body=body, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "WebhookTestV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def webhook_test_v1_with_http_info( + self, + pki_webhook_id: StrictInt, + body: Dict[str, Any], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[WebhookTestV1Response]: + """Test the Webhook by calling the Url + + :param pki_webhook_id: (required) :type pki_webhook_id: int :param body: (required) :type body: object - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(WebhookTestV1Response, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._webhook_test_v1_serialize( + pki_webhook_id=pki_webhook_id, + body=body, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '200': "WebhookTestV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'pki_webhook_id', - 'body' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def webhook_test_v1_without_preload_content( + self, + pki_webhook_id: StrictInt, + body: Dict[str, Any], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Test the Webhook by calling the Url + + + + :param pki_webhook_id: (required) + :type pki_webhook_id: int + :param body: (required) + :type body: object + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._webhook_test_v1_serialize( + pki_webhook_id=pki_webhook_id, + body=body, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method webhook_test_v1" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "WebhookTestV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['pki_webhook_id']: - _path_params['pkiWebhookID'] = _params['pki_webhook_id'] + def _webhook_test_v1_serialize( + self, + pki_webhook_id, + body, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if pki_webhook_id is not None: + _path_params['pkiWebhookID'] = pki_webhook_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['body'] is not None: - _body_params = _params['body'] + if body is not None: + _body_params = body + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Authorization'] # noqa: E501 - - _response_types_map = { - '200': "WebhookTestV1Response", - '404': "CommonResponseError", - } + _auth_settings: List[str] = [ + 'Authorization' + ] - return self.api_client.call_api( - '/1/object/webhook/{pkiWebhookID}/test', 'POST', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='POST', + resource_path='/1/object/webhook/{pkiWebhookID}/test', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/eZmaxApi/api/scim_groups_api.py b/eZmaxApi/api/scim_groups_api.py index 7b47717c8..eb2454362 100644 --- a/eZmaxApi/api/scim_groups_api.py +++ b/eZmaxApi/api/scim_groups_api.py @@ -13,14 +13,20 @@ """ # noqa: E501 -import re # noqa: F401 import io import warnings -from pydantic import validate_arguments, ValidationError +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Dict, List, Optional, Tuple, Union, Any +try: + from typing import Annotated +except ImportError: + from typing_extensions import Annotated + +from pydantic import Field from typing_extensions import Annotated -from pydantic import Field, StrictStr +from pydantic import StrictStr from typing import Optional @@ -28,10 +34,7 @@ from eZmaxApi.api_client import ApiClient from eZmaxApi.api_response import ApiResponse -from eZmaxApi.exceptions import ( # noqa: F401 - ApiTypeError, - ApiValueError -) +from eZmaxApi.rest import RESTResponseType class ScimGroupsApi: @@ -46,708 +49,1314 @@ def __init__(self, api_client=None) -> None: api_client = ApiClient.get_default() self.api_client = api_client - @validate_arguments - def groups_create_object_scim_v2(self, scim_group : ScimGroup, **kwargs) -> ScimGroup: # noqa: E501 - """Create a new Usergroup # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def groups_create_object_scim_v2( + self, + scim_group: ScimGroup, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ScimGroup: + """Create a new Usergroup - >>> thread = api.groups_create_object_scim_v2(scim_group, async_req=True) - >>> result = thread.get() :param scim_group: (required) :type scim_group: ScimGroup - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: ScimGroup - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the groups_create_object_scim_v2_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.groups_create_object_scim_v2_with_http_info(scim_group, **kwargs) # noqa: E501 - - @validate_arguments - def groups_create_object_scim_v2_with_http_info(self, scim_group : ScimGroup, **kwargs) -> ApiResponse: # noqa: E501 - """Create a new Usergroup # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.groups_create_object_scim_v2_with_http_info(scim_group, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._groups_create_object_scim_v2_serialize( + scim_group=scim_group, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "ScimGroup", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def groups_create_object_scim_v2_with_http_info( + self, + scim_group: ScimGroup, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ScimGroup]: + """Create a new Usergroup + :param scim_group: (required) :type scim_group: ScimGroup - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(ScimGroup, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._groups_create_object_scim_v2_serialize( + scim_group=scim_group, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "ScimGroup", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _params = locals() - _all_params = [ - 'scim_group' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + @validate_call + def groups_create_object_scim_v2_without_preload_content( + self, + scim_group: ScimGroup, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Create a new Usergroup + + + :param scim_group: (required) + :type scim_group: ScimGroup + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._groups_create_object_scim_v2_serialize( + scim_group=scim_group, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method groups_create_object_scim_v2" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '201': "ScimGroup", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} + def _groups_create_object_scim_v2_serialize( + self, + scim_group, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['scim_group'] is not None: - _body_params = _params['scim_group'] + if scim_group is not None: + _body_params = scim_group + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Bearer'] # noqa: E501 - - _response_types_map = { - '201': "ScimGroup", - } + _auth_settings: List[str] = [ + 'Bearer' + ] - return self.api_client.call_api( - '/2/scim/Groups', 'POST', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='POST', + resource_path='/2/scim/Groups', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) - @validate_arguments - def groups_delete_object_scim_v2(self, group_id : StrictStr, **kwargs) -> None: # noqa: E501 - """Delete an existing Usergroup # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.groups_delete_object_scim_v2(group_id, async_req=True) - >>> result = thread.get() + + @validate_call + def groups_delete_object_scim_v2( + self, + group_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Delete an existing Usergroup + :param group_id: (required) :type group_id: str - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: None - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the groups_delete_object_scim_v2_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.groups_delete_object_scim_v2_with_http_info(group_id, **kwargs) # noqa: E501 - - @validate_arguments - def groups_delete_object_scim_v2_with_http_info(self, group_id : StrictStr, **kwargs) -> ApiResponse: # noqa: E501 - """Delete an existing Usergroup # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.groups_delete_object_scim_v2_with_http_info(group_id, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._groups_delete_object_scim_v2_serialize( + group_id=group_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def groups_delete_object_scim_v2_with_http_info( + self, + group_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Delete an existing Usergroup + :param group_id: (required) :type group_id: str - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: None - """ + """ # noqa: E501 + + _param = self._groups_delete_object_scim_v2_serialize( + group_id=group_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'group_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def groups_delete_object_scim_v2_without_preload_content( + self, + group_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete an existing Usergroup + + + :param group_id: (required) + :type group_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._groups_delete_object_scim_v2_serialize( + group_id=group_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method groups_delete_object_scim_v2" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['group_id']: - _path_params['groupId'] = _params['group_id'] + def _groups_delete_object_scim_v2_serialize( + self, + group_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if group_id is not None: + _path_params['groupId'] = group_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - # authentication setting - _auth_settings = ['Bearer'] # noqa: E501 - _response_types_map = {} - return self.api_client.call_api( - '/2/scim/Groups/{groupId}', 'DELETE', - _path_params, - _query_params, - _header_params, + + + # authentication setting + _auth_settings: List[str] = [ + 'Bearer' + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/2/scim/Groups/{groupId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) - @validate_arguments - def groups_edit_object_scim_v2(self, group_id : StrictStr, scim_group : ScimGroup, **kwargs) -> ScimGroup: # noqa: E501 - """Edit an existing Usergroup # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.groups_edit_object_scim_v2(group_id, scim_group, async_req=True) - >>> result = thread.get() + + @validate_call + def groups_edit_object_scim_v2( + self, + group_id: StrictStr, + scim_group: ScimGroup, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ScimGroup: + """Edit an existing Usergroup + :param group_id: (required) :type group_id: str :param scim_group: (required) :type scim_group: ScimGroup - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: ScimGroup - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the groups_edit_object_scim_v2_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.groups_edit_object_scim_v2_with_http_info(group_id, scim_group, **kwargs) # noqa: E501 - - @validate_arguments - def groups_edit_object_scim_v2_with_http_info(self, group_id : StrictStr, scim_group : ScimGroup, **kwargs) -> ApiResponse: # noqa: E501 - """Edit an existing Usergroup # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.groups_edit_object_scim_v2_with_http_info(group_id, scim_group, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._groups_edit_object_scim_v2_serialize( + group_id=group_id, + scim_group=scim_group, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ScimGroup", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def groups_edit_object_scim_v2_with_http_info( + self, + group_id: StrictStr, + scim_group: ScimGroup, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ScimGroup]: + """Edit an existing Usergroup + :param group_id: (required) :type group_id: str :param scim_group: (required) :type scim_group: ScimGroup - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(ScimGroup, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._groups_edit_object_scim_v2_serialize( + group_id=group_id, + scim_group=scim_group, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '200': "ScimGroup", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'group_id', - 'scim_group' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def groups_edit_object_scim_v2_without_preload_content( + self, + group_id: StrictStr, + scim_group: ScimGroup, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Edit an existing Usergroup + + + :param group_id: (required) + :type group_id: str + :param scim_group: (required) + :type scim_group: ScimGroup + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._groups_edit_object_scim_v2_serialize( + group_id=group_id, + scim_group=scim_group, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method groups_edit_object_scim_v2" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "ScimGroup", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['group_id']: - _path_params['groupId'] = _params['group_id'] + def _groups_edit_object_scim_v2_serialize( + self, + group_id, + scim_group, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if group_id is not None: + _path_params['groupId'] = group_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['scim_group'] is not None: - _body_params = _params['scim_group'] + if scim_group is not None: + _body_params = scim_group + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Bearer'] # noqa: E501 - - _response_types_map = { - '200': "ScimGroup", - } + _auth_settings: List[str] = [ + 'Bearer' + ] - return self.api_client.call_api( - '/2/scim/Groups/{groupId}', 'PUT', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='PUT', + resource_path='/2/scim/Groups/{groupId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) - @validate_arguments - def groups_get_list_scim_v2(self, filter : Annotated[Optional[StrictStr], Field(description="Filter expression for searching groups")] = None, **kwargs) -> ScimGroup: # noqa: E501 - """Retrieve Usergroup list # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.groups_get_list_scim_v2(filter, async_req=True) - >>> result = thread.get() + + @validate_call + def groups_get_list_scim_v2( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filter expression for searching groups")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ScimGroup: + """Retrieve Usergroup list + :param filter: Filter expression for searching groups :type filter: str - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: ScimGroup - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the groups_get_list_scim_v2_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.groups_get_list_scim_v2_with_http_info(filter, **kwargs) # noqa: E501 - - @validate_arguments - def groups_get_list_scim_v2_with_http_info(self, filter : Annotated[Optional[StrictStr], Field(description="Filter expression for searching groups")] = None, **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve Usergroup list # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.groups_get_list_scim_v2_with_http_info(filter, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._groups_get_list_scim_v2_serialize( + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ScimGroup", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def groups_get_list_scim_v2_with_http_info( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filter expression for searching groups")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ScimGroup]: + """Retrieve Usergroup list + :param filter: Filter expression for searching groups :type filter: str - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(ScimGroup, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._groups_get_list_scim_v2_serialize( + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ScimGroup", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _params = locals() - _all_params = [ - 'filter' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + @validate_call + def groups_get_list_scim_v2_without_preload_content( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filter expression for searching groups")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve Usergroup list + + + :param filter: Filter expression for searching groups + :type filter: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._groups_get_list_scim_v2_serialize( + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method groups_get_list_scim_v2" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "ScimGroup", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} + def _groups_get_list_scim_v2_serialize( + self, + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: - # process the query parameters - _query_params = [] - if _params.get('filter') is not None: # noqa: E501 - _query_params.append(('filter', _params['filter'])) + _host = None + + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Bearer'] # noqa: E501 - _response_types_map = { - '200': "ScimGroup", - } + # authentication setting + _auth_settings: List[str] = [ + 'Bearer' + ] - return self.api_client.call_api( - '/2/scim/Groups', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/2/scim/Groups', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + - @validate_arguments - def groups_get_object_scim_v2(self, group_id : StrictStr, **kwargs) -> ScimGroup: # noqa: E501 - """Retrieve an existing Usergroup # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.groups_get_object_scim_v2(group_id, async_req=True) - >>> result = thread.get() + @validate_call + def groups_get_object_scim_v2( + self, + group_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ScimGroup: + """Retrieve an existing Usergroup + :param group_id: (required) :type group_id: str - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: ScimGroup - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the groups_get_object_scim_v2_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.groups_get_object_scim_v2_with_http_info(group_id, **kwargs) # noqa: E501 - - @validate_arguments - def groups_get_object_scim_v2_with_http_info(self, group_id : StrictStr, **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve an existing Usergroup # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.groups_get_object_scim_v2_with_http_info(group_id, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._groups_get_object_scim_v2_serialize( + group_id=group_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ScimGroup", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def groups_get_object_scim_v2_with_http_info( + self, + group_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ScimGroup]: + """Retrieve an existing Usergroup + :param group_id: (required) :type group_id: str - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(ScimGroup, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._groups_get_object_scim_v2_serialize( + group_id=group_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '200': "ScimGroup", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'group_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def groups_get_object_scim_v2_without_preload_content( + self, + group_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve an existing Usergroup + + + :param group_id: (required) + :type group_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._groups_get_object_scim_v2_serialize( + group_id=group_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method groups_get_object_scim_v2" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "ScimGroup", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['group_id']: - _path_params['groupId'] = _params['group_id'] + def _groups_get_object_scim_v2_serialize( + self, + group_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if group_id is not None: + _path_params['groupId'] = group_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Bearer'] # noqa: E501 - _response_types_map = { - '200': "ScimGroup", - } + # authentication setting + _auth_settings: List[str] = [ + 'Bearer' + ] - return self.api_client.call_api( - '/2/scim/Groups/{groupId}', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/2/scim/Groups/{groupId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/eZmaxApi/api/scim_service_provider_config_api.py b/eZmaxApi/api/scim_service_provider_config_api.py index 6af8179e6..ea153c6a5 100644 --- a/eZmaxApi/api/scim_service_provider_config_api.py +++ b/eZmaxApi/api/scim_service_provider_config_api.py @@ -13,20 +13,22 @@ """ # noqa: E501 -import re # noqa: F401 import io import warnings -from pydantic import validate_arguments, ValidationError +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Dict, List, Optional, Tuple, Union, Any + +try: + from typing import Annotated +except ImportError: + from typing_extensions import Annotated from eZmaxApi.models.scim_service_provider_config import ScimServiceProviderConfig from eZmaxApi.api_client import ApiClient from eZmaxApi.api_response import ApiResponse -from eZmaxApi.exceptions import ( # noqa: F401 - ApiTypeError, - ApiValueError -) +from eZmaxApi.rest import RESTResponseType class ScimServiceProviderConfigApi: @@ -41,132 +43,241 @@ def __init__(self, api_client=None) -> None: api_client = ApiClient.get_default() self.api_client = api_client - @validate_arguments - def service_provider_config_get_object_scim_v2(self, **kwargs) -> ScimServiceProviderConfig: # noqa: E501 - """Get Service Provider Configuration # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def service_provider_config_get_object_scim_v2( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ScimServiceProviderConfig: + """Get Service Provider Configuration - >>> thread = api.service_provider_config_get_object_scim_v2(async_req=True) - >>> result = thread.get() - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: ScimServiceProviderConfig - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the service_provider_config_get_object_scim_v2_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.service_provider_config_get_object_scim_v2_with_http_info(**kwargs) # noqa: E501 - - @validate_arguments - def service_provider_config_get_object_scim_v2_with_http_info(self, **kwargs) -> ApiResponse: # noqa: E501 - """Get Service Provider Configuration # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.service_provider_config_get_object_scim_v2_with_http_info(async_req=True) - >>> result = thread.get() - - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional + """ # noqa: E501 + + _param = self._service_provider_config_get_object_scim_v2_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ScimServiceProviderConfig", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def service_provider_config_get_object_scim_v2_with_http_info( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ScimServiceProviderConfig]: + """Get Service Provider Configuration + + :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(ScimServiceProviderConfig, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 - _params = locals() + _param = self._service_provider_config_get_object_scim_v2_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _all_params = [ - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + _response_types_map: Dict[str, Optional[str]] = { + '200': "ScimServiceProviderConfig", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + + @validate_call + def service_provider_config_get_object_scim_v2_without_preload_content( + self, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Get Service Provider Configuration + + + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._service_provider_config_get_object_scim_v2_serialize( + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method service_provider_config_get_object_scim_v2" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "ScimServiceProviderConfig", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} + def _service_provider_config_get_object_scim_v2_serialize( + self, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = [] # noqa: E501 - _response_types_map = { - '200': "ScimServiceProviderConfig", - } + # authentication setting + _auth_settings: List[str] = [ + ] - return self.api_client.call_api( - '/2/scim/ServiceProviderConfig', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/2/scim/ServiceProviderConfig', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/eZmaxApi/api/scim_users_api.py b/eZmaxApi/api/scim_users_api.py index e7212d03c..d7d34298e 100644 --- a/eZmaxApi/api/scim_users_api.py +++ b/eZmaxApi/api/scim_users_api.py @@ -13,14 +13,20 @@ """ # noqa: E501 -import re # noqa: F401 import io import warnings -from pydantic import validate_arguments, ValidationError +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Dict, List, Optional, Tuple, Union, Any +try: + from typing import Annotated +except ImportError: + from typing_extensions import Annotated + +from pydantic import Field from typing_extensions import Annotated -from pydantic import Field, StrictStr +from pydantic import StrictStr from typing import Optional @@ -29,10 +35,7 @@ from eZmaxApi.api_client import ApiClient from eZmaxApi.api_response import ApiResponse -from eZmaxApi.exceptions import ( # noqa: F401 - ApiTypeError, - ApiValueError -) +from eZmaxApi.rest import RESTResponseType class ScimUsersApi: @@ -47,708 +50,1314 @@ def __init__(self, api_client=None) -> None: api_client = ApiClient.get_default() self.api_client = api_client - @validate_arguments - def users_create_object_scim_v2(self, scim_user : ScimUser, **kwargs) -> ScimUser: # noqa: E501 - """Create a new User # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True + @validate_call + def users_create_object_scim_v2( + self, + scim_user: ScimUser, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ScimUser: + """Create a new User - >>> thread = api.users_create_object_scim_v2(scim_user, async_req=True) - >>> result = thread.get() :param scim_user: (required) :type scim_user: ScimUser - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: ScimUser - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the users_create_object_scim_v2_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.users_create_object_scim_v2_with_http_info(scim_user, **kwargs) # noqa: E501 - - @validate_arguments - def users_create_object_scim_v2_with_http_info(self, scim_user : ScimUser, **kwargs) -> ApiResponse: # noqa: E501 - """Create a new User # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.users_create_object_scim_v2_with_http_info(scim_user, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._users_create_object_scim_v2_serialize( + scim_user=scim_user, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "ScimUser", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def users_create_object_scim_v2_with_http_info( + self, + scim_user: ScimUser, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ScimUser]: + """Create a new User + :param scim_user: (required) :type scim_user: ScimUser - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(ScimUser, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._users_create_object_scim_v2_serialize( + scim_user=scim_user, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "ScimUser", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _params = locals() - _all_params = [ - 'scim_user' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + @validate_call + def users_create_object_scim_v2_without_preload_content( + self, + scim_user: ScimUser, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Create a new User + + + :param scim_user: (required) + :type scim_user: ScimUser + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._users_create_object_scim_v2_serialize( + scim_user=scim_user, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method users_create_object_scim_v2" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '201': "ScimUser", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} + def _users_create_object_scim_v2_serialize( + self, + scim_user, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['scim_user'] is not None: - _body_params = _params['scim_user'] + if scim_user is not None: + _body_params = scim_user + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Bearer'] # noqa: E501 - - _response_types_map = { - '201': "ScimUser", - } + _auth_settings: List[str] = [ + 'Bearer' + ] - return self.api_client.call_api( - '/2/scim/Users', 'POST', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='POST', + resource_path='/2/scim/Users', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) - @validate_arguments - def users_delete_object_scim_v2(self, user_id : StrictStr, **kwargs) -> None: # noqa: E501 - """Delete an existing User # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.users_delete_object_scim_v2(user_id, async_req=True) - >>> result = thread.get() + + @validate_call + def users_delete_object_scim_v2( + self, + user_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Delete an existing User + :param user_id: (required) :type user_id: str - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: None - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the users_delete_object_scim_v2_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.users_delete_object_scim_v2_with_http_info(user_id, **kwargs) # noqa: E501 - - @validate_arguments - def users_delete_object_scim_v2_with_http_info(self, user_id : StrictStr, **kwargs) -> ApiResponse: # noqa: E501 - """Delete an existing User # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.users_delete_object_scim_v2_with_http_info(user_id, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._users_delete_object_scim_v2_serialize( + user_id=user_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def users_delete_object_scim_v2_with_http_info( + self, + user_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Delete an existing User + :param user_id: (required) :type user_id: str - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: None - """ + """ # noqa: E501 + + _param = self._users_delete_object_scim_v2_serialize( + user_id=user_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'user_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def users_delete_object_scim_v2_without_preload_content( + self, + user_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete an existing User + + + :param user_id: (required) + :type user_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._users_delete_object_scim_v2_serialize( + user_id=user_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method users_delete_object_scim_v2" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '204': None, + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['user_id']: - _path_params['userId'] = _params['user_id'] + def _users_delete_object_scim_v2_serialize( + self, + user_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if user_id is not None: + _path_params['userId'] = user_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - # authentication setting - _auth_settings = ['Bearer'] # noqa: E501 - _response_types_map = {} - return self.api_client.call_api( - '/2/scim/Users/{userId}', 'DELETE', - _path_params, - _query_params, - _header_params, + + + # authentication setting + _auth_settings: List[str] = [ + 'Bearer' + ] + + return self.api_client.param_serialize( + method='DELETE', + resource_path='/2/scim/Users/{userId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) - @validate_arguments - def users_edit_object_scim_v2(self, user_id : StrictStr, scim_user : ScimUser, **kwargs) -> ScimUser: # noqa: E501 - """Edit an existing User # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.users_edit_object_scim_v2(user_id, scim_user, async_req=True) - >>> result = thread.get() + + @validate_call + def users_edit_object_scim_v2( + self, + user_id: StrictStr, + scim_user: ScimUser, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ScimUser: + """Edit an existing User + :param user_id: (required) :type user_id: str :param scim_user: (required) :type scim_user: ScimUser - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: ScimUser - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the users_edit_object_scim_v2_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.users_edit_object_scim_v2_with_http_info(user_id, scim_user, **kwargs) # noqa: E501 - - @validate_arguments - def users_edit_object_scim_v2_with_http_info(self, user_id : StrictStr, scim_user : ScimUser, **kwargs) -> ApiResponse: # noqa: E501 - """Edit an existing User # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.users_edit_object_scim_v2_with_http_info(user_id, scim_user, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._users_edit_object_scim_v2_serialize( + user_id=user_id, + scim_user=scim_user, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ScimUser", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def users_edit_object_scim_v2_with_http_info( + self, + user_id: StrictStr, + scim_user: ScimUser, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ScimUser]: + """Edit an existing User + :param user_id: (required) :type user_id: str :param scim_user: (required) :type scim_user: ScimUser - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(ScimUser, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._users_edit_object_scim_v2_serialize( + user_id=user_id, + scim_user=scim_user, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '200': "ScimUser", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'user_id', - 'scim_user' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def users_edit_object_scim_v2_without_preload_content( + self, + user_id: StrictStr, + scim_user: ScimUser, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Edit an existing User + + + :param user_id: (required) + :type user_id: str + :param scim_user: (required) + :type scim_user: ScimUser + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._users_edit_object_scim_v2_serialize( + user_id=user_id, + scim_user=scim_user, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method users_edit_object_scim_v2" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "ScimUser", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['user_id']: - _path_params['userId'] = _params['user_id'] + def _users_edit_object_scim_v2_serialize( + self, + user_id, + scim_user, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + + _host = None + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + # process the path parameters + if user_id is not None: + _path_params['userId'] = user_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None - if _params['scim_user'] is not None: - _body_params = _params['scim_user'] + if scim_user is not None: + _body_params = scim_user + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) # set the HTTP header `Content-Type` - _content_types_list = _params.get('_content_type', - self.api_client.select_header_content_type( - ['application/json'])) - if _content_types_list: - _header_params['Content-Type'] = _content_types_list + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting - _auth_settings = ['Bearer'] # noqa: E501 - - _response_types_map = { - '200': "ScimUser", - } + _auth_settings: List[str] = [ + 'Bearer' + ] - return self.api_client.call_api( - '/2/scim/Users/{userId}', 'PUT', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='PUT', + resource_path='/2/scim/Users/{userId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) - @validate_arguments - def users_get_list_scim_v2(self, filter : Annotated[Optional[StrictStr], Field(description="Filter expression for searching users")] = None, **kwargs) -> ScimUserList: # noqa: E501 - """Retrieve User list # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.users_get_list_scim_v2(filter, async_req=True) - >>> result = thread.get() + + @validate_call + def users_get_list_scim_v2( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filter expression for searching users")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ScimUserList: + """Retrieve User list + :param filter: Filter expression for searching users :type filter: str - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: ScimUserList - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the users_get_list_scim_v2_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.users_get_list_scim_v2_with_http_info(filter, **kwargs) # noqa: E501 - - @validate_arguments - def users_get_list_scim_v2_with_http_info(self, filter : Annotated[Optional[StrictStr], Field(description="Filter expression for searching users")] = None, **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve User list # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.users_get_list_scim_v2_with_http_info(filter, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._users_get_list_scim_v2_serialize( + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ScimUserList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def users_get_list_scim_v2_with_http_info( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filter expression for searching users")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ScimUserList]: + """Retrieve User list + :param filter: Filter expression for searching users :type filter: str - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(ScimUserList, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._users_get_list_scim_v2_serialize( + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ScimUserList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _params = locals() - _all_params = [ - 'filter' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + @validate_call + def users_get_list_scim_v2_without_preload_content( + self, + filter: Annotated[Optional[StrictStr], Field(description="Filter expression for searching users")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve User list + + + :param filter: Filter expression for searching users + :type filter: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._users_get_list_scim_v2_serialize( + filter=filter, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method users_get_list_scim_v2" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "ScimUserList", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} + def _users_get_list_scim_v2_serialize( + self, + filter, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: - # process the query parameters - _query_params = [] - if _params.get('filter') is not None: # noqa: E501 - _query_params.append(('filter', _params['filter'])) + _host = None + + _collection_formats: Dict[str, str] = { + } + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if filter is not None: + + _query_params.append(('filter', filter)) + # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Bearer'] # noqa: E501 - _response_types_map = { - '200': "ScimUserList", - } + # authentication setting + _auth_settings: List[str] = [ + 'Bearer' + ] - return self.api_client.call_api( - '/2/scim/Users', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/2/scim/Users', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + - @validate_arguments - def users_get_object_scim_v2(self, user_id : StrictStr, **kwargs) -> ScimUser: # noqa: E501 - """Retrieve an existing User # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.users_get_object_scim_v2(user_id, async_req=True) - >>> result = thread.get() + @validate_call + def users_get_object_scim_v2( + self, + user_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ScimUser: + """Retrieve an existing User + :param user_id: (required) :type user_id: str - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _request_timeout: timeout setting for this request. - If one number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: ScimUser - """ - kwargs['_return_http_data_only'] = True - if '_preload_content' in kwargs: - message = "Error! Please call the users_get_object_scim_v2_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501 - raise ValueError(message) - return self.users_get_object_scim_v2_with_http_info(user_id, **kwargs) # noqa: E501 - - @validate_arguments - def users_get_object_scim_v2_with_http_info(self, user_id : StrictStr, **kwargs) -> ApiResponse: # noqa: E501 - """Retrieve an existing User # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.users_get_object_scim_v2_with_http_info(user_id, async_req=True) - >>> result = thread.get() + """ # noqa: E501 + + _param = self._users_get_object_scim_v2_serialize( + user_id=user_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ScimUser", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def users_get_object_scim_v2_with_http_info( + self, + user_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ScimUser]: + """Retrieve an existing User + :param user_id: (required) :type user_id: str - :param async_req: Whether to execute the request asynchronously. - :type async_req: bool, optional - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :type _preload_content: bool, optional - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :type _return_http_data_only: bool, optional :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. + request; this effectively ignores the + authentication in the spec for a single request. :type _request_auth: dict, optional - :type _content_type: string, optional: force content-type for the request + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional :return: Returns the result object. - If the method is called asynchronously, - returns the request thread. - :rtype: tuple(ScimUser, status_code(int), headers(HTTPHeaderDict)) - """ + """ # noqa: E501 + + _param = self._users_get_object_scim_v2_serialize( + user_id=user_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) - _params = locals() + _response_types_map: Dict[str, Optional[str]] = { + '200': "ScimUser", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) - _all_params = [ - 'user_id' - ] - _all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout', - '_request_auth', - '_content_type', - '_headers' + + @validate_call + def users_get_object_scim_v2_without_preload_content( + self, + user_id: StrictStr, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve an existing User + + + :param user_id: (required) + :type user_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._users_get_object_scim_v2_serialize( + user_id=user_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index ) - # validate the arguments - for _key, _val in _params['kwargs'].items(): - if _key not in _all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method users_get_object_scim_v2" % _key - ) - _params[_key] = _val - del _params['kwargs'] + _response_types_map: Dict[str, Optional[str]] = { + '200': "ScimUser", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response - _collection_formats = {} - # process the path parameters - _path_params = {} - if _params['user_id']: - _path_params['userId'] = _params['user_id'] + def _users_get_object_scim_v2_serialize( + self, + user_id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> Tuple: + _host = None + _collection_formats: Dict[str, str] = { + } + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, str] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if user_id is not None: + _path_params['userId'] = user_id # process the query parameters - _query_params = [] # process the header parameters - _header_params = dict(_params.get('_headers', {})) # process the form parameters - _form_params = [] - _files = {} # process the body parameter - _body_params = None + + # set the HTTP header `Accept` _header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 + [ + 'application/json' + ] + ) - # authentication setting - _auth_settings = ['Bearer'] # noqa: E501 - _response_types_map = { - '200': "ScimUser", - } + # authentication setting + _auth_settings: List[str] = [ + 'Bearer' + ] - return self.api_client.call_api( - '/2/scim/Users/{userId}', 'GET', - _path_params, - _query_params, - _header_params, + return self.api_client.param_serialize( + method='GET', + resource_path='/2/scim/Users/{userId}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, body=_body_params, post_params=_form_params, files=_files, - response_types_map=_response_types_map, auth_settings=_auth_settings, - async_req=_params.get('async_req'), - _return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=_params.get('_preload_content', True), - _request_timeout=_params.get('_request_timeout'), collection_formats=_collection_formats, - _request_auth=_params.get('_request_auth')) + _host=_host, + _request_auth=_request_auth + ) + + diff --git a/eZmaxApi/api_client.py b/eZmaxApi/api_client.py index 4289b079b..aac8b7ce8 100644 --- a/eZmaxApi/api_client.py +++ b/eZmaxApi/api_client.py @@ -18,18 +18,26 @@ from dateutil.parser import parse import json import mimetypes -from multiprocessing.pool import ThreadPool import os import re import tempfile from urllib.parse import quote +from typing import Tuple, Optional, List from eZmaxApi.configuration import Configuration from eZmaxApi.api_response import ApiResponse import eZmaxApi.models from eZmaxApi import rest -from eZmaxApi.exceptions import ApiValueError, ApiException +from eZmaxApi.exceptions import ( + ApiValueError, + ApiException, + BadRequestException, + UnauthorizedException, + ForbiddenException, + NotFoundException, + ServiceException +) class ApiClient: @@ -46,8 +54,6 @@ class ApiClient: the API. :param cookie: a cookie to include in the header when making calls to the API - :param pool_threads: The number of threads to use for async requests - to the API. More threads means more concurrent API requests. """ PRIMITIVE_TYPES = (float, bool, bytes, str, int) @@ -63,13 +69,17 @@ class ApiClient: } _pool = None - def __init__(self, configuration=None, header_name=None, header_value=None, - cookie=None, pool_threads=1) -> None: + def __init__( + self, + configuration=None, + header_name=None, + header_value=None, + cookie=None + ) -> None: # use default configuration if none is provided if configuration is None: configuration = Configuration.get_default() self.configuration = configuration - self.pool_threads = pool_threads self.rest_client = rest.RESTClientObject(configuration) self.default_headers = {} @@ -84,25 +94,7 @@ def __enter__(self): return self def __exit__(self, exc_type, exc_value, traceback): - self.close() - - def close(self): - if self._pool: - self._pool.close() - self._pool.join() - self._pool = None - if hasattr(atexit, 'unregister'): - atexit.unregister(self.close) - - @property - def pool(self): - """Create thread pool on first request - avoids instantiating unused threadpool for blocking clients. - """ - if self._pool is None: - atexit.register(self.close) - self._pool = ThreadPool(self.pool_threads) - return self._pool + pass @property def user_agent(self): @@ -143,13 +135,42 @@ def set_default(cls, default): """ cls._default = default - def __call_api( - self, resource_path, method, path_params=None, - query_params=None, header_params=None, body=None, post_params=None, - files=None, response_types_map=None, auth_settings=None, - _return_http_data_only=None, collection_formats=None, - _preload_content=True, _request_timeout=None, _host=None, - _request_auth=None): + def param_serialize( + self, + method, + resource_path, + path_params=None, + query_params=None, + header_params=None, + body=None, + post_params=None, + files=None, auth_settings=None, + collection_formats=None, + _host=None, + _request_auth=None + ) -> Tuple: + + """Builds the HTTP request params needed by the request. + :param method: Method to call. + :param resource_path: Path to method endpoint. + :param path_params: Path parameters in the url. + :param query_params: Query parameters in the url. + :param header_params: Header parameters to be + placed in the request header. + :param body: Request body. + :param post_params dict: Request post form parameters, + for `application/x-www-form-urlencoded`, `multipart/form-data`. + :param auth_settings list: Auth Settings names for the request. + :param files dict: key -> filename, value -> filepath, + for `multipart/form-data`. + :param collection_formats: dict of collection formats for path, query, + header, and post parameters. + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + :return: tuple of form (path, http_method, query_params, header_params, + body, post_params, files) + """ config = self.configuration @@ -160,14 +181,17 @@ def __call_api( header_params['Cookie'] = self.cookie if header_params: header_params = self.sanitize_for_serialization(header_params) - header_params = dict(self.parameters_to_tuples(header_params, - collection_formats)) + header_params = dict( + self.parameters_to_tuples(header_params,collection_formats) + ) # path parameters if path_params: path_params = self.sanitize_for_serialization(path_params) - path_params = self.parameters_to_tuples(path_params, - collection_formats) + path_params = self.parameters_to_tuples( + path_params, + collection_formats + ) for k, v in path_params: # specified safe chars, encode everything resource_path = resource_path.replace( @@ -179,15 +203,22 @@ def __call_api( if post_params or files: post_params = post_params if post_params else [] post_params = self.sanitize_for_serialization(post_params) - post_params = self.parameters_to_tuples(post_params, - collection_formats) + post_params = self.parameters_to_tuples( + post_params, + collection_formats + ) post_params.extend(self.files_parameters(files)) # auth setting self.update_params_for_auth( - header_params, query_params, auth_settings, - resource_path, method, body, - request_auth=_request_auth) + header_params, + query_params, + auth_settings, + resource_path, + method, + body, + request_auth=_request_auth + ) # body if body: @@ -203,59 +234,99 @@ def __call_api( # query parameters if query_params: query_params = self.sanitize_for_serialization(query_params) - url_query = self.parameters_to_url_query(query_params, - collection_formats) + url_query = self.parameters_to_url_query( + query_params, + collection_formats + ) url += "?" + url_query + return method, url, header_params, body, post_params + + + def call_api( + self, + method, + url, + header_params=None, + body=None, + post_params=None, + _request_timeout=None + ) -> rest.RESTResponse: + """Makes the HTTP request (synchronous) + :param method: Method to call. + :param url: Path to method endpoint. + :param header_params: Header parameters to be + placed in the request header. + :param body: Request body. + :param post_params dict: Request post form parameters, + for `application/x-www-form-urlencoded`, `multipart/form-data`. + :param _request_timeout: timeout setting for this request. + :return: RESTResponse + """ + try: # perform request and return response - response_data = self.request( + response_data = self.rest_client.request( method, url, - query_params=query_params, headers=header_params, - post_params=post_params, body=body, - _preload_content=_preload_content, - _request_timeout=_request_timeout) + body=body, post_params=post_params, + _request_timeout=_request_timeout + ) + except ApiException as e: if e.body: e.body = e.body.decode('utf-8') raise e - self.last_response = response_data - - return_data = None # assuming derialization is not needed - # data needs deserialization or returns HTTP data (deserialized) only - if _preload_content or _return_http_data_only: - response_type = response_types_map.get(str(response_data.status), None) - if not response_type and isinstance(response_data.status, int) and 100 <= response_data.status <= 599: - # if not found, look for '1XX', '2XX', etc. - response_type = response_types_map.get(str(response_data.status)[0] + "XX", None) - - if response_type == "bytearray": - response_data.data = response_data.data - else: - match = None - content_type = response_data.getheader('content-type') - if content_type is not None: - match = re.search(r"charset=([a-zA-Z\-\d]+)[\s;]?", content_type) - encoding = match.group(1) if match else "utf-8" - response_data.data = response_data.data.decode(encoding) - - # deserialize response data - if response_type == "bytearray": - return_data = response_data.data - elif response_type: - return_data = self.deserialize(response_data, response_type) - else: - return_data = None - - if _return_http_data_only: - return return_data - else: - return ApiResponse(status_code = response_data.status, - data = return_data, - headers = response_data.getheaders(), - raw_data = response_data.data) + return response_data + + def response_deserialize( + self, + response_data: rest.RESTResponse = None, + response_types_map=None + ) -> ApiResponse: + """Deserializes response into an object. + :param response_data: RESTResponse object to be deserialized. + :param response_types_map: dict of response types. + :return: ApiResponse + """ + + + response_type = response_types_map.get(str(response_data.status), None) + if not response_type and isinstance(response_data.status, int) and 100 <= response_data.status <= 599: + # if not found, look for '1XX', '2XX', etc. + response_type = response_types_map.get(str(response_data.status)[0] + "XX", None) + + # deserialize response data + response_text = None + return_data = None + try: + if response_type == "bytearray": + return_data = response_data.data + elif response_type == "file": + return_data = self.__deserialize_file(response_data) + elif response_type is not None: + match = None + content_type = response_data.getheader('content-type') + if content_type is not None: + match = re.search(r"charset=([a-zA-Z\-\d]+)[\s;]?", content_type) + encoding = match.group(1) if match else "utf-8" + response_text = response_data.data.decode(encoding) + return_data = self.deserialize(response_text, response_type) + finally: + if not 200 <= response_data.status <= 299: + raise ApiException.from_response( + http_resp=response_data, + body=response_text, + data=return_data, + ) + + return ApiResponse( + status_code = response_data.status, + data = return_data, + headers = response_data.getheaders(), + raw_data = response_data.data + ) def sanitize_for_serialization(self, obj): """Builds a JSON POST object. @@ -276,15 +347,17 @@ def sanitize_for_serialization(self, obj): elif isinstance(obj, self.PRIMITIVE_TYPES): return obj elif isinstance(obj, list): - return [self.sanitize_for_serialization(sub_obj) - for sub_obj in obj] + return [ + self.sanitize_for_serialization(sub_obj) for sub_obj in obj + ] elif isinstance(obj, tuple): - return tuple(self.sanitize_for_serialization(sub_obj) - for sub_obj in obj) + return tuple( + self.sanitize_for_serialization(sub_obj) for sub_obj in obj + ) elif isinstance(obj, (datetime.datetime, datetime.date)): return obj.isoformat() - if isinstance(obj, dict): + elif isinstance(obj, dict): obj_dict = obj else: # Convert model obj to dict except @@ -294,10 +367,12 @@ def sanitize_for_serialization(self, obj): # model definition for request. obj_dict = obj.to_dict() - return {key: self.sanitize_for_serialization(val) - for key, val in obj_dict.items()} + return { + key: self.sanitize_for_serialization(val) + for key, val in obj_dict.items() + } - def deserialize(self, response, response_type): + def deserialize(self, response_text, response_type): """Deserializes response into an object. :param response: RESTResponse object to be deserialized. @@ -306,16 +381,12 @@ def deserialize(self, response, response_type): :return: deserialized object. """ - # handle file downloading - # save response body into a tmp file and return the instance - if response_type == "file": - return self.__deserialize_file(response) # fetch data from response object try: - data = json.loads(response.data) + data = json.loads(response_text) except ValueError: - data = response.data + data = response_text return self.__deserialize(data, response_type) @@ -358,135 +429,6 @@ def __deserialize(self, data, klass): else: return self.__deserialize_model(data, klass) - def call_api(self, resource_path, method, - path_params=None, query_params=None, header_params=None, - body=None, post_params=None, files=None, - response_types_map=None, auth_settings=None, - async_req=None, _return_http_data_only=None, - collection_formats=None, _preload_content=True, - _request_timeout=None, _host=None, _request_auth=None): - """Makes the HTTP request (synchronous) and returns deserialized data. - - To make an async_req request, set the async_req parameter. - - :param resource_path: Path to method endpoint. - :param method: Method to call. - :param path_params: Path parameters in the url. - :param query_params: Query parameters in the url. - :param header_params: Header parameters to be - placed in the request header. - :param body: Request body. - :param post_params dict: Request post form parameters, - for `application/x-www-form-urlencoded`, `multipart/form-data`. - :param auth_settings list: Auth Settings names for the request. - :param response: Response data type. - :param files dict: key -> filename, value -> filepath, - for `multipart/form-data`. - :param async_req bool: execute request asynchronously - :param _return_http_data_only: response data instead of ApiResponse - object with status code, headers, etc - :param _preload_content: if False, the ApiResponse.data will - be set to none and raw_data will store the - HTTP response body without reading/decoding. - Default is True. - :param collection_formats: dict of collection formats for path, query, - header, and post parameters. - :param _request_timeout: timeout setting for this request. If one - number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :param _request_auth: set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - :type _request_token: dict, optional - :return: - If async_req parameter is True, - the request will be called asynchronously. - The method will return the request thread. - If parameter async_req is False or missing, - then the method will return the response directly. - """ - if not async_req: - return self.__call_api(resource_path, method, - path_params, query_params, header_params, - body, post_params, files, - response_types_map, auth_settings, - _return_http_data_only, collection_formats, - _preload_content, _request_timeout, _host, - _request_auth) - - return self.pool.apply_async(self.__call_api, (resource_path, - method, path_params, - query_params, - header_params, body, - post_params, files, - response_types_map, - auth_settings, - _return_http_data_only, - collection_formats, - _preload_content, - _request_timeout, - _host, _request_auth)) - - def request(self, method, url, query_params=None, headers=None, - post_params=None, body=None, _preload_content=True, - _request_timeout=None): - """Makes the HTTP request using RESTClient.""" - if method == "GET": - return self.rest_client.get_request(url, - query_params=query_params, - _preload_content=_preload_content, - _request_timeout=_request_timeout, - headers=headers) - elif method == "HEAD": - return self.rest_client.head_request(url, - query_params=query_params, - _preload_content=_preload_content, - _request_timeout=_request_timeout, - headers=headers) - elif method == "OPTIONS": - return self.rest_client.options_request(url, - query_params=query_params, - headers=headers, - _preload_content=_preload_content, - _request_timeout=_request_timeout) - elif method == "POST": - return self.rest_client.post_request(url, - query_params=query_params, - headers=headers, - post_params=post_params, - _preload_content=_preload_content, - _request_timeout=_request_timeout, - body=body) - elif method == "PUT": - return self.rest_client.put_request(url, - query_params=query_params, - headers=headers, - post_params=post_params, - _preload_content=_preload_content, - _request_timeout=_request_timeout, - body=body) - elif method == "PATCH": - return self.rest_client.patch_request(url, - query_params=query_params, - headers=headers, - post_params=post_params, - _preload_content=_preload_content, - _request_timeout=_request_timeout, - body=body) - elif method == "DELETE": - return self.rest_client.delete_request(url, - query_params=query_params, - headers=headers, - _preload_content=_preload_content, - _request_timeout=_request_timeout, - body=body) - else: - raise ApiValueError( - "http method must be `GET`, `HEAD`, `OPTIONS`," - " `POST`, `PATCH`, `PUT` or `DELETE`." - ) - def parameters_to_tuples(self, params, collection_formats): """Get parameters as list of tuples, formatting collections. @@ -497,7 +439,7 @@ def parameters_to_tuples(self, params, collection_formats): new_params = [] if collection_formats is None: collection_formats = {} - for k, v in params.items() if isinstance(params, dict) else params: # noqa: E501 + for k, v in params.items() if isinstance(params, dict) else params: if k in collection_formats: collection_format = collection_formats[k] if collection_format == 'multi': @@ -527,11 +469,11 @@ def parameters_to_url_query(self, params, collection_formats): new_params = [] if collection_formats is None: collection_formats = {} - for k, v in params.items() if isinstance(params, dict) else params: # noqa: E501 - if isinstance(v, (int, float)): - v = str(v) + for k, v in params.items() if isinstance(params, dict) else params: if isinstance(v, bool): v = str(v).lower() + if isinstance(v, (int, float)): + v = str(v) if isinstance(v, dict): v = json.dumps(v) @@ -549,7 +491,8 @@ def parameters_to_url_query(self, params, collection_formats): else: # csv is the default delimiter = ',' new_params.append( - (k, delimiter.join(quote(str(value)) for value in v))) + (k, delimiter.join(quote(str(value)) for value in v)) + ) else: new_params.append((k, quote(str(v)))) @@ -572,21 +515,24 @@ def files_parameters(self, files=None): with open(n, 'rb') as f: filename = os.path.basename(f.name) filedata = f.read() - mimetype = (mimetypes.guess_type(filename)[0] or - 'application/octet-stream') + mimetype = ( + mimetypes.guess_type(filename)[0] + or 'application/octet-stream' + ) params.append( - tuple([k, tuple([filename, filedata, mimetype])])) + tuple([k, tuple([filename, filedata, mimetype])]) + ) return params - def select_header_accept(self, accepts): + def select_header_accept(self, accepts: List[str]) -> Optional[str]: """Returns `Accept` based on an array of accepts provided. :param accepts: List of headers. :return: Accept (e.g. application/json). """ if not accepts: - return + return None for accept in accepts: if re.search('json', accept, re.IGNORECASE): @@ -609,9 +555,16 @@ def select_header_content_type(self, content_types): return content_types[0] - def update_params_for_auth(self, headers, queries, auth_settings, - resource_path, method, body, - request_auth=None): + def update_params_for_auth( + self, + headers, + queries, + auth_settings, + resource_path, + method, + body, + request_auth=None + ) -> None: """Updates header and query params based on authentication setting. :param headers: Header parameters dict to be updated. @@ -628,21 +581,36 @@ def update_params_for_auth(self, headers, queries, auth_settings, return if request_auth: - self._apply_auth_params(headers, queries, - resource_path, method, body, - request_auth) - return - - for auth in auth_settings: - auth_setting = self.configuration.auth_settings().get(auth) - if auth_setting: - self._apply_auth_params(headers, queries, - resource_path, method, body, - auth_setting) - - def _apply_auth_params(self, headers, queries, - resource_path, method, body, - auth_setting): + self._apply_auth_params( + headers, + queries, + resource_path, + method, + body, + request_auth + ) + else: + for auth in auth_settings: + auth_setting = self.configuration.auth_settings().get(auth) + if auth_setting: + self._apply_auth_params( + headers, + queries, + resource_path, + method, + body, + auth_setting + ) + + def _apply_auth_params( + self, + headers, + queries, + resource_path, + method, + body, + auth_setting + ) -> None: """Updates the request parameters based on a single auth_setting :param headers: Header parameters dict to be updated. @@ -671,6 +639,9 @@ def __deserialize_file(self, response): Saves response body into a file in a temporary folder, using the filename from the `Content-Disposition` header if provided. + handle file downloading + save response body into a tmp file and return the instance + :param response: RESTResponse. :return: file path. """ @@ -680,8 +651,10 @@ def __deserialize_file(self, response): content_disposition = response.getheader("Content-Disposition") if content_disposition: - filename = re.search(r'filename=[\'"]?([^\'"\s]+)[\'"]?', - content_disposition).group(1) + filename = re.search( + r'filename=[\'"]?([^\'"\s]+)[\'"]?', + content_disposition + ).group(1) path = os.path.join(os.path.dirname(path), filename) with open(path, "wb") as f: diff --git a/eZmaxApi/api_response.py b/eZmaxApi/api_response.py index a0b62b952..2ac1ada6e 100644 --- a/eZmaxApi/api_response.py +++ b/eZmaxApi/api_response.py @@ -1,25 +1,21 @@ """API response object.""" from __future__ import annotations -from typing import Any, Dict, Optional -from pydantic import Field, StrictInt, StrictStr +from typing import Any, Dict, Optional, Generic, TypeVar +from pydantic import Field, StrictInt, StrictStr, StrictBytes, BaseModel -class ApiResponse: +T = TypeVar("T") + +class ApiResponse(BaseModel, Generic[T]): """ API response object """ - status_code: Optional[StrictInt] = Field(None, description="HTTP status code") + status_code: StrictInt = Field(description="HTTP status code") headers: Optional[Dict[StrictStr, StrictStr]] = Field(None, description="HTTP headers") - data: Optional[Any] = Field(None, description="Deserialized data given the data type") - raw_data: Optional[Any] = Field(None, description="Raw data (HTTP response body)") + data: T = Field(description="Deserialized data given the data type") + raw_data: StrictBytes = Field(description="Raw data (HTTP response body)") - def __init__(self, - status_code=None, - headers=None, - data=None, - raw_data=None) -> None: - self.status_code = status_code - self.headers = headers - self.data = data - self.raw_data = raw_data + model_config = { + "arbitrary_types_allowed": True + } diff --git a/eZmaxApi/configuration.py b/eZmaxApi/configuration.py index 8efc7bdb0..2a2de343f 100644 --- a/eZmaxApi/configuration.py +++ b/eZmaxApi/configuration.py @@ -431,6 +431,7 @@ def get_host_settings(self): 'description': "The environment on on which to call the API. Should always be \"prod\" unless instructed otherwise by support.", 'default_value': "prod", 'enum_values': [ + "iso", "prod", "stg", "qa", @@ -455,8 +456,6 @@ def get_host_settings(self): 'default_value': "prod", 'enum_values': [ "prod", - "stg", - "qa", "dev" ] } @@ -470,6 +469,7 @@ def get_host_settings(self): 'description': "The environment on on which to call the API. Should always be \"prod\" unless instructed otherwise by support.", 'default_value': "prod", 'enum_values': [ + "iso", "prod", "stg", "qa", diff --git a/eZmaxApi/exceptions.py b/eZmaxApi/exceptions.py index e1584dffd..f09fbf503 100644 --- a/eZmaxApi/exceptions.py +++ b/eZmaxApi/exceptions.py @@ -12,6 +12,9 @@ Do not edit the class manually. """ # noqa: E501 +from typing import Any, Optional + +from typing_extensions import Self class OpenApiException(Exception): """The base exception class for all OpenAPIExceptions""" @@ -102,17 +105,56 @@ def __init__(self, msg, path_to_item=None) -> None: class ApiException(OpenApiException): - def __init__(self, status=None, reason=None, http_resp=None) -> None: + def __init__( + self, + status=None, + reason=None, + http_resp=None, + *, + body: Optional[str] = None, + data: Optional[Any] = None, + ) -> None: + self.status = status + self.reason = reason + self.body = body + self.data = data + self.headers = None + if http_resp: - self.status = http_resp.status - self.reason = http_resp.reason - self.body = http_resp.data + if self.status is None: + self.status = http_resp.status + if self.reason is None: + self.reason = http_resp.reason + if self.body is None: + try: + self.body = http_resp.data.decode('utf-8') + except Exception: + pass self.headers = http_resp.getheaders() - else: - self.status = status - self.reason = reason - self.body = None - self.headers = None + + @classmethod + def from_response( + cls, + *, + http_resp, + body: Optional[str], + data: Optional[Any], + ) -> Self: + if http_resp.status == 400: + raise BadRequestException(http_resp=http_resp, body=body, data=data) + + if http_resp.status == 401: + raise UnauthorizedException(http_resp=http_resp, body=body, data=data) + + if http_resp.status == 403: + raise ForbiddenException(http_resp=http_resp, body=body, data=data) + + if http_resp.status == 404: + raise NotFoundException(http_resp=http_resp, body=body, data=data) + + if 500 <= http_resp.status <= 599: + raise ServiceException(http_resp=http_resp, body=body, data=data) + raise ApiException(http_resp=http_resp, body=body, data=data) def __str__(self): """Custom error messages for exception""" @@ -122,38 +164,30 @@ def __str__(self): error_message += "HTTP response headers: {0}\n".format( self.headers) - if self.body: - error_message += "HTTP response body: {0}\n".format(self.body) + if self.data or self.body: + error_message += "HTTP response body: {0}\n".format(self.data or self.body) return error_message + class BadRequestException(ApiException): + pass - def __init__(self, status=None, reason=None, http_resp=None) -> None: - super(BadRequestException, self).__init__(status, reason, http_resp) class NotFoundException(ApiException): - - def __init__(self, status=None, reason=None, http_resp=None) -> None: - super(NotFoundException, self).__init__(status, reason, http_resp) + pass class UnauthorizedException(ApiException): - - def __init__(self, status=None, reason=None, http_resp=None) -> None: - super(UnauthorizedException, self).__init__(status, reason, http_resp) + pass class ForbiddenException(ApiException): - - def __init__(self, status=None, reason=None, http_resp=None) -> None: - super(ForbiddenException, self).__init__(status, reason, http_resp) + pass class ServiceException(ApiException): - - def __init__(self, status=None, reason=None, http_resp=None) -> None: - super(ServiceException, self).__init__(status, reason, http_resp) + pass def render_path(path_to_item): diff --git a/eZmaxApi/models/__init__.py b/eZmaxApi/models/__init__.py index 5176f1678..8b03cd9a8 100644 --- a/eZmaxApi/models/__init__.py +++ b/eZmaxApi/models/__init__.py @@ -52,7 +52,14 @@ from eZmaxApi.models.apikey_request_compound import ApikeyRequestCompound from eZmaxApi.models.apikey_response import ApikeyResponse from eZmaxApi.models.apikey_response_compound import ApikeyResponseCompound -from eZmaxApi.models.attachment_download_v1_response import AttachmentDownloadV1Response +from eZmaxApi.models.attachment_get_attachmentlogs_v1_response import AttachmentGetAttachmentlogsV1Response +from eZmaxApi.models.attachment_get_attachmentlogs_v1_response_m_payload import AttachmentGetAttachmentlogsV1ResponseMPayload +from eZmaxApi.models.attachment_get_download_url_v1_response import AttachmentGetDownloadUrlV1Response +from eZmaxApi.models.attachment_get_download_url_v1_response_m_payload import AttachmentGetDownloadUrlV1ResponseMPayload +from eZmaxApi.models.attachment_response import AttachmentResponse +from eZmaxApi.models.attachment_response_compound import AttachmentResponseCompound +from eZmaxApi.models.attachmentlog_response import AttachmentlogResponse +from eZmaxApi.models.attachmentlog_response_compound import AttachmentlogResponseCompound from eZmaxApi.models.attempt_response import AttemptResponse from eZmaxApi.models.attempt_response_compound import AttemptResponseCompound from eZmaxApi.models.billingentityexternal_autocomplete_element_response import BillingentityexternalAutocompleteElementResponse @@ -165,6 +172,8 @@ from eZmaxApi.models.cors_request_compound import CorsRequestCompound from eZmaxApi.models.cors_response import CorsResponse from eZmaxApi.models.cors_response_compound import CorsResponseCompound +from eZmaxApi.models.custom_attachment_response import CustomAttachmentResponse +from eZmaxApi.models.custom_attachmentdocumenttype_response import CustomAttachmentdocumenttypeResponse from eZmaxApi.models.custom_autocomplete_element_response import CustomAutocompleteElementResponse from eZmaxApi.models.custom_communication_list_element_response import CustomCommunicationListElementResponse from eZmaxApi.models.custom_communicationattachment_request import CustomCommunicationattachmentRequest @@ -338,6 +347,8 @@ from eZmaxApi.models.ezsigndocument_flatten_v1_response import EzsigndocumentFlattenV1Response from eZmaxApi.models.ezsigndocument_get_actionable_elements_v1_response import EzsigndocumentGetActionableElementsV1Response from eZmaxApi.models.ezsigndocument_get_actionable_elements_v1_response_m_payload import EzsigndocumentGetActionableElementsV1ResponseMPayload +from eZmaxApi.models.ezsigndocument_get_attachments_v1_response import EzsigndocumentGetAttachmentsV1Response +from eZmaxApi.models.ezsigndocument_get_attachments_v1_response_m_payload import EzsigndocumentGetAttachmentsV1ResponseMPayload from eZmaxApi.models.ezsigndocument_get_completed_elements_v1_response import EzsigndocumentGetCompletedElementsV1Response from eZmaxApi.models.ezsigndocument_get_completed_elements_v1_response_m_payload import EzsigndocumentGetCompletedElementsV1ResponseMPayload from eZmaxApi.models.ezsigndocument_get_download_url_v1_response import EzsigndocumentGetDownloadUrlV1Response @@ -394,6 +405,10 @@ from eZmaxApi.models.ezsignfolder_edit_object_v1_response import EzsignfolderEditObjectV1Response from eZmaxApi.models.ezsignfolder_get_actionable_elements_v1_response import EzsignfolderGetActionableElementsV1Response from eZmaxApi.models.ezsignfolder_get_actionable_elements_v1_response_m_payload import EzsignfolderGetActionableElementsV1ResponseMPayload +from eZmaxApi.models.ezsignfolder_get_attachment_count_v1_response import EzsignfolderGetAttachmentCountV1Response +from eZmaxApi.models.ezsignfolder_get_attachment_count_v1_response_m_payload import EzsignfolderGetAttachmentCountV1ResponseMPayload +from eZmaxApi.models.ezsignfolder_get_attachments_v1_response import EzsignfolderGetAttachmentsV1Response +from eZmaxApi.models.ezsignfolder_get_attachments_v1_response_m_payload import EzsignfolderGetAttachmentsV1ResponseMPayload from eZmaxApi.models.ezsignfolder_get_communication_count_v1_response import EzsignfolderGetCommunicationCountV1Response from eZmaxApi.models.ezsignfolder_get_communication_count_v1_response_m_payload import EzsignfolderGetCommunicationCountV1ResponseMPayload from eZmaxApi.models.ezsignfolder_get_communication_list_v1_response import EzsignfolderGetCommunicationListV1Response @@ -559,6 +574,23 @@ from eZmaxApi.models.ezsignsignergroupmembership_request_compound import EzsignsignergroupmembershipRequestCompound from eZmaxApi.models.ezsignsignergroupmembership_response import EzsignsignergroupmembershipResponse from eZmaxApi.models.ezsignsignergroupmembership_response_compound import EzsignsignergroupmembershipResponseCompound +from eZmaxApi.models.ezsignsigningreason_autocomplete_element_response import EzsignsigningreasonAutocompleteElementResponse +from eZmaxApi.models.ezsignsigningreason_create_object_v1_request import EzsignsigningreasonCreateObjectV1Request +from eZmaxApi.models.ezsignsigningreason_create_object_v1_response import EzsignsigningreasonCreateObjectV1Response +from eZmaxApi.models.ezsignsigningreason_create_object_v1_response_m_payload import EzsignsigningreasonCreateObjectV1ResponseMPayload +from eZmaxApi.models.ezsignsigningreason_edit_object_v1_request import EzsignsigningreasonEditObjectV1Request +from eZmaxApi.models.ezsignsigningreason_edit_object_v1_response import EzsignsigningreasonEditObjectV1Response +from eZmaxApi.models.ezsignsigningreason_get_autocomplete_v2_response import EzsignsigningreasonGetAutocompleteV2Response +from eZmaxApi.models.ezsignsigningreason_get_autocomplete_v2_response_m_payload import EzsignsigningreasonGetAutocompleteV2ResponseMPayload +from eZmaxApi.models.ezsignsigningreason_get_list_v1_response import EzsignsigningreasonGetListV1Response +from eZmaxApi.models.ezsignsigningreason_get_list_v1_response_m_payload import EzsignsigningreasonGetListV1ResponseMPayload +from eZmaxApi.models.ezsignsigningreason_get_object_v2_response import EzsignsigningreasonGetObjectV2Response +from eZmaxApi.models.ezsignsigningreason_get_object_v2_response_m_payload import EzsignsigningreasonGetObjectV2ResponseMPayload +from eZmaxApi.models.ezsignsigningreason_list_element import EzsignsigningreasonListElement +from eZmaxApi.models.ezsignsigningreason_request import EzsignsigningreasonRequest +from eZmaxApi.models.ezsignsigningreason_request_compound import EzsignsigningreasonRequestCompound +from eZmaxApi.models.ezsignsigningreason_response import EzsignsigningreasonResponse +from eZmaxApi.models.ezsignsigningreason_response_compound import EzsignsigningreasonResponseCompound from eZmaxApi.models.ezsigntemplate_autocomplete_element_response import EzsigntemplateAutocompleteElementResponse from eZmaxApi.models.ezsigntemplate_copy_v1_request import EzsigntemplateCopyV1Request from eZmaxApi.models.ezsigntemplate_copy_v1_response import EzsigntemplateCopyV1Response @@ -726,6 +758,11 @@ from eZmaxApi.models.field_e_activesession_origin import FieldEActivesessionOrigin from eZmaxApi.models.field_e_activesession_usertype import FieldEActivesessionUsertype from eZmaxApi.models.field_e_activesession_weekdaystart import FieldEActivesessionWeekdaystart +from eZmaxApi.models.field_e_attachment_documenttype import FieldEAttachmentDocumenttype +from eZmaxApi.models.field_e_attachment_privacy import FieldEAttachmentPrivacy +from eZmaxApi.models.field_e_attachment_type import FieldEAttachmentType +from eZmaxApi.models.field_e_attachment_verified import FieldEAttachmentVerified +from eZmaxApi.models.field_e_attachmentlog_type import FieldEAttachmentlogType from eZmaxApi.models.field_e_branding_logo import FieldEBrandingLogo from eZmaxApi.models.field_e_communication_importance import FieldECommunicationImportance from eZmaxApi.models.field_e_communication_type import FieldECommunicationType @@ -777,6 +814,7 @@ from eZmaxApi.models.field_e_systemconfiguration_language2 import FieldESystemconfigurationLanguage2 from eZmaxApi.models.field_e_systemconfiguration_newexternaluseraction import FieldESystemconfigurationNewexternaluseraction from eZmaxApi.models.field_e_user_ezsignaccess import FieldEUserEzsignaccess +from eZmaxApi.models.field_e_user_ezsignprepaid import FieldEUserEzsignprepaid from eZmaxApi.models.field_e_user_ezsignsendreminderfrequency import FieldEUserEzsignsendreminderfrequency from eZmaxApi.models.field_e_user_logintype import FieldEUserLogintype from eZmaxApi.models.field_e_user_origin import FieldEUserOrigin @@ -809,12 +847,18 @@ from eZmaxApi.models.global_ezmaxclient_version_v1_response import GlobalEzmaxclientVersionV1Response from eZmaxApi.models.global_ezmaxcustomer_get_configuration_v1_response import GlobalEzmaxcustomerGetConfigurationV1Response from eZmaxApi.models.header_accept_language import HeaderAcceptLanguage +from eZmaxApi.models.inscription_get_attachments_v1_response import InscriptionGetAttachmentsV1Response +from eZmaxApi.models.inscription_get_attachments_v1_response_m_payload import InscriptionGetAttachmentsV1ResponseMPayload from eZmaxApi.models.inscription_get_communication_list_v1_response import InscriptionGetCommunicationListV1Response from eZmaxApi.models.inscription_get_communication_list_v1_response_m_payload import InscriptionGetCommunicationListV1ResponseMPayload +from eZmaxApi.models.inscription_get_communicationsenders_v1_response import InscriptionGetCommunicationsendersV1Response +from eZmaxApi.models.inscription_get_communicationsenders_v1_response_m_payload import InscriptionGetCommunicationsendersV1ResponseMPayload from eZmaxApi.models.inscriptionnotauthenticated_get_communication_list_v1_response import InscriptionnotauthenticatedGetCommunicationListV1Response from eZmaxApi.models.inscriptionnotauthenticated_get_communication_list_v1_response_m_payload import InscriptionnotauthenticatedGetCommunicationListV1ResponseMPayload from eZmaxApi.models.inscriptiontemp_get_communication_list_v1_response import InscriptiontempGetCommunicationListV1Response from eZmaxApi.models.inscriptiontemp_get_communication_list_v1_response_m_payload import InscriptiontempGetCommunicationListV1ResponseMPayload +from eZmaxApi.models.invoice_get_attachments_v1_response import InvoiceGetAttachmentsV1Response +from eZmaxApi.models.invoice_get_attachments_v1_response_m_payload import InvoiceGetAttachmentsV1ResponseMPayload from eZmaxApi.models.invoice_get_communication_list_v1_response import InvoiceGetCommunicationListV1Response from eZmaxApi.models.invoice_get_communication_list_v1_response_m_payload import InvoiceGetCommunicationListV1ResponseMPayload from eZmaxApi.models.language_autocomplete_element_response import LanguageAutocompleteElementResponse @@ -834,6 +878,7 @@ from eZmaxApi.models.multilingual_ezmaxinvoicingsummaryinternal_description import MultilingualEzmaxinvoicingsummaryinternalDescription from eZmaxApi.models.multilingual_ezsignfoldertype_name import MultilingualEzsignfoldertypeName from eZmaxApi.models.multilingual_ezsignsignergroup_description import MultilingualEzsignsignergroupDescription +from eZmaxApi.models.multilingual_ezsignsigningreason_description import MultilingualEzsignsigningreasonDescription from eZmaxApi.models.multilingual_notificationsubsection_name import MultilingualNotificationsubsectionName from eZmaxApi.models.multilingual_notificationtest_name import MultilingualNotificationtestName from eZmaxApi.models.multilingual_paymentterm_description import MultilingualPaymenttermDescription @@ -1076,6 +1121,9 @@ from eZmaxApi.models.webhook_create_object_v1_request import WebhookCreateObjectV1Request from eZmaxApi.models.webhook_create_object_v1_response import WebhookCreateObjectV1Response from eZmaxApi.models.webhook_create_object_v1_response_m_payload import WebhookCreateObjectV1ResponseMPayload +from eZmaxApi.models.webhook_create_object_v2_request import WebhookCreateObjectV2Request +from eZmaxApi.models.webhook_create_object_v2_response import WebhookCreateObjectV2Response +from eZmaxApi.models.webhook_create_object_v2_response_m_payload import WebhookCreateObjectV2ResponseMPayload from eZmaxApi.models.webhook_delete_object_v1_response import WebhookDeleteObjectV1Response from eZmaxApi.models.webhook_edit_object_v1_request import WebhookEditObjectV1Request from eZmaxApi.models.webhook_edit_object_v1_response import WebhookEditObjectV1Response @@ -1090,6 +1138,9 @@ from eZmaxApi.models.webhook_get_object_v2_response import WebhookGetObjectV2Response from eZmaxApi.models.webhook_get_object_v2_response_m_payload import WebhookGetObjectV2ResponseMPayload from eZmaxApi.models.webhook_list_element import WebhookListElement +from eZmaxApi.models.webhook_regenerate_apikey_v1_request import WebhookRegenerateApikeyV1Request +from eZmaxApi.models.webhook_regenerate_apikey_v1_response import WebhookRegenerateApikeyV1Response +from eZmaxApi.models.webhook_regenerate_apikey_v1_response_m_payload import WebhookRegenerateApikeyV1ResponseMPayload from eZmaxApi.models.webhook_request import WebhookRequest from eZmaxApi.models.webhook_request_compound import WebhookRequestCompound from eZmaxApi.models.webhook_response import WebhookResponse diff --git a/eZmaxApi/models/activesession_get_current_v1_response.py b/eZmaxApi/models/activesession_get_current_v1_response.py index 3724dd1a2..13c38756b 100644 --- a/eZmaxApi/models/activesession_get_current_v1_response.py +++ b/eZmaxApi/models/activesession_get_current_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.activesession_get_current_v1_response_m_payload import ActivesessionGetCurrentV1ResponseMPayload from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class ActivesessionGetCurrentV1Response(BaseModel): """ - Response for GET /1/object/activesession/getCurrent # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: ActivesessionGetCurrentV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /1/object/activesession/getCurrent + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: ActivesessionGetCurrentV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> ActivesessionGetCurrentV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of ActivesessionGetCurrentV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> ActivesessionGetCurrentV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of ActivesessionGetCurrentV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return ActivesessionGetCurrentV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = ActivesessionGetCurrentV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": ActivesessionGetCurrentV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": ActivesessionGetCurrentV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/activesession_get_current_v1_response_m_payload.py b/eZmaxApi/models/activesession_get_current_v1_response_m_payload.py index 01209ded0..f08d95b75 100644 --- a/eZmaxApi/models/activesession_get_current_v1_response_m_payload.py +++ b/eZmaxApi/models/activesession_get_current_v1_response_m_payload.py @@ -19,60 +19,94 @@ import json -from typing import List, Optional -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint, conlist, constr +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, StrictStr, field_validator +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.activesession_response_compound_apikey import ActivesessionResponseCompoundApikey from eZmaxApi.models.activesession_response_compound_user import ActivesessionResponseCompoundUser from eZmaxApi.models.field_e_activesession_origin import FieldEActivesessionOrigin from eZmaxApi.models.field_e_activesession_usertype import FieldEActivesessionUsertype from eZmaxApi.models.field_e_activesession_weekdaystart import FieldEActivesessionWeekdaystart +from eZmaxApi.models.field_e_user_ezsignaccess import FieldEUserEzsignaccess +from eZmaxApi.models.field_e_user_ezsignprepaid import FieldEUserEzsignprepaid +try: + from typing import Self +except ImportError: + from typing_extensions import Self class ActivesessionGetCurrentV1ResponseMPayload(BaseModel): """ - Payload for GET /1/object/activesession/getCurrent # noqa: E501 - """ - e_activesession_usertype: FieldEActivesessionUsertype = Field(..., alias="eActivesessionUsertype") - e_activesession_origin: FieldEActivesessionOrigin = Field(..., alias="eActivesessionOrigin") - e_activesession_weekdaystart: FieldEActivesessionWeekdaystart = Field(..., alias="eActivesessionWeekdaystart") - fki_language_id: conint(strict=True, le=2, ge=1) = Field(..., alias="fkiLanguageID", description="The unique ID of the Language. Valid values: |Value|Description| |-|-| |1|French| |2|English|") - s_company_name_x: StrictStr = Field(..., alias="sCompanyNameX", description="The Name of the Company in the language of the requester") - s_department_name_x: StrictStr = Field(..., alias="sDepartmentNameX", description="The Name of the Department in the language of the requester") - b_activesession_debug: StrictBool = Field(..., alias="bActivesessionDebug", description="Whether the active session is in debug or not") - b_activesession_issuperadmin: StrictBool = Field(..., alias="bActivesessionIssuperadmin", description="Whether the active session is superadmin or not") - pks_customer_code: constr(strict=True, max_length=6, min_length=2) = Field(..., alias="pksCustomerCode", description="The customer code assigned to your account") - fki_systemconfigurationtype_id: conint(strict=True, ge=1) = Field(..., alias="fkiSystemconfigurationtypeID", description="The unique ID of the Systemconfigurationtype") - fki_signature_id: Optional[conint(strict=True, le=16777215, ge=0)] = Field(None, alias="fkiSignatureID", description="The unique ID of the Signature") - a_pki_permission_id: conlist(conint(strict=True, ge=0)) = Field(..., alias="a_pkiPermissionID", description="An array of permissions granted to the user or api key") - obj_user_real: ActivesessionResponseCompoundUser = Field(..., alias="objUserReal") - obj_user_cloned: Optional[ActivesessionResponseCompoundUser] = Field(None, alias="objUserCloned") - obj_apikey: Optional[ActivesessionResponseCompoundApikey] = Field(None, alias="objApikey") - a_e_module_internalname: conlist(StrictStr) = Field(..., alias="a_eModuleInternalname", description="An Array of Registered modules. These are the modules that are Licensed to be used by the User or the API Key.") - __properties = ["eActivesessionUsertype", "eActivesessionOrigin", "eActivesessionWeekdaystart", "fkiLanguageID", "sCompanyNameX", "sDepartmentNameX", "bActivesessionDebug", "bActivesessionIssuperadmin", "pksCustomerCode", "fkiSystemconfigurationtypeID", "fkiSignatureID", "a_pkiPermissionID", "objUserReal", "objUserCloned", "objApikey", "a_eModuleInternalname"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + Payload for GET /1/object/activesession/getCurrent + """ # noqa: E501 + e_activesession_usertype: FieldEActivesessionUsertype = Field(alias="eActivesessionUsertype") + e_activesession_origin: FieldEActivesessionOrigin = Field(alias="eActivesessionOrigin") + e_activesession_weekdaystart: FieldEActivesessionWeekdaystart = Field(alias="eActivesessionWeekdaystart") + fki_language_id: Annotated[int, Field(le=2, strict=True, ge=1)] = Field(description="The unique ID of the Language. Valid values: |Value|Description| |-|-| |1|French| |2|English|", alias="fkiLanguageID") + s_company_name_x: StrictStr = Field(description="The Name of the Company in the language of the requester", alias="sCompanyNameX") + s_department_name_x: StrictStr = Field(description="The Name of the Department in the language of the requester", alias="sDepartmentNameX") + b_activesession_debug: StrictBool = Field(description="Whether the active session is in debug or not", alias="bActivesessionDebug") + b_activesession_issuperadmin: StrictBool = Field(description="Whether the active session is superadmin or not", alias="bActivesessionIssuperadmin") + pks_customer_code: Annotated[str, Field(min_length=2, strict=True, max_length=6)] = Field(description="The customer code assigned to your account", alias="pksCustomerCode") + fki_systemconfigurationtype_id: Annotated[int, Field(strict=True, ge=1)] = Field(description="The unique ID of the Systemconfigurationtype", alias="fkiSystemconfigurationtypeID") + fki_signature_id: Optional[Annotated[int, Field(le=16777215, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Signature", alias="fkiSignatureID") + e_user_ezsignaccess: FieldEUserEzsignaccess = Field(alias="eUserEzsignaccess") + e_user_ezsignprepaid: Optional[FieldEUserEzsignprepaid] = Field(default=None, alias="eUserEzsignprepaid") + dt_user_ezsignprepaidexpiration: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="The eZsign prepaid expiration date", alias="dtUserEzsignprepaidexpiration") + a_pki_permission_id: List[Annotated[int, Field(strict=True, ge=0)]] = Field(description="An array of permissions granted to the user or api key", alias="a_pkiPermissionID") + obj_user_real: ActivesessionResponseCompoundUser = Field(alias="objUserReal") + obj_user_cloned: Optional[ActivesessionResponseCompoundUser] = Field(default=None, alias="objUserCloned") + obj_apikey: Optional[ActivesessionResponseCompoundApikey] = Field(default=None, alias="objApikey") + a_e_module_internalname: List[StrictStr] = Field(description="An Array of Registered modules. These are the modules that are Licensed to be used by the User or the API Key.", alias="a_eModuleInternalname") + __properties: ClassVar[List[str]] = ["eActivesessionUsertype", "eActivesessionOrigin", "eActivesessionWeekdaystart", "fkiLanguageID", "sCompanyNameX", "sDepartmentNameX", "bActivesessionDebug", "bActivesessionIssuperadmin", "pksCustomerCode", "fkiSystemconfigurationtypeID", "fkiSignatureID", "eUserEzsignaccess", "eUserEzsignprepaid", "dtUserEzsignprepaidexpiration", "a_pkiPermissionID", "objUserReal", "objUserCloned", "objApikey", "a_eModuleInternalname"] + + @field_validator('dt_user_ezsignprepaidexpiration') + def dt_user_ezsignprepaidexpiration_validate_regular_expression(cls, value): + """Validates the regular expression""" + if value is None: + return value + + if not re.match(r"^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$", value): + raise ValueError(r"must validate the regular expression /^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$/") + return value + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> ActivesessionGetCurrentV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of ActivesessionGetCurrentV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_user_real if self.obj_user_real: _dict['objUserReal'] = self.obj_user_real.to_dict() @@ -85,31 +119,34 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> ActivesessionGetCurrentV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of ActivesessionGetCurrentV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return ActivesessionGetCurrentV1ResponseMPayload.parse_obj(obj) - - _obj = ActivesessionGetCurrentV1ResponseMPayload.parse_obj({ - "e_activesession_usertype": obj.get("eActivesessionUsertype"), - "e_activesession_origin": obj.get("eActivesessionOrigin"), - "e_activesession_weekdaystart": obj.get("eActivesessionWeekdaystart"), - "fki_language_id": obj.get("fkiLanguageID"), - "s_company_name_x": obj.get("sCompanyNameX"), - "s_department_name_x": obj.get("sDepartmentNameX"), - "b_activesession_debug": obj.get("bActivesessionDebug"), - "b_activesession_issuperadmin": obj.get("bActivesessionIssuperadmin"), - "pks_customer_code": obj.get("pksCustomerCode"), - "fki_systemconfigurationtype_id": obj.get("fkiSystemconfigurationtypeID"), - "fki_signature_id": obj.get("fkiSignatureID"), - "a_pki_permission_id": obj.get("a_pkiPermissionID"), - "obj_user_real": ActivesessionResponseCompoundUser.from_dict(obj.get("objUserReal")) if obj.get("objUserReal") is not None else None, - "obj_user_cloned": ActivesessionResponseCompoundUser.from_dict(obj.get("objUserCloned")) if obj.get("objUserCloned") is not None else None, - "obj_apikey": ActivesessionResponseCompoundApikey.from_dict(obj.get("objApikey")) if obj.get("objApikey") is not None else None, - "a_e_module_internalname": obj.get("a_eModuleInternalname") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "eActivesessionUsertype": obj.get("eActivesessionUsertype"), + "eActivesessionOrigin": obj.get("eActivesessionOrigin"), + "eActivesessionWeekdaystart": obj.get("eActivesessionWeekdaystart"), + "fkiLanguageID": obj.get("fkiLanguageID"), + "sCompanyNameX": obj.get("sCompanyNameX"), + "sDepartmentNameX": obj.get("sDepartmentNameX"), + "bActivesessionDebug": obj.get("bActivesessionDebug"), + "bActivesessionIssuperadmin": obj.get("bActivesessionIssuperadmin"), + "pksCustomerCode": obj.get("pksCustomerCode"), + "fkiSystemconfigurationtypeID": obj.get("fkiSystemconfigurationtypeID"), + "fkiSignatureID": obj.get("fkiSignatureID"), + "eUserEzsignaccess": obj.get("eUserEzsignaccess"), + "eUserEzsignprepaid": obj.get("eUserEzsignprepaid"), + "dtUserEzsignprepaidexpiration": obj.get("dtUserEzsignprepaidexpiration"), + "a_pkiPermissionID": obj.get("a_pkiPermissionID"), + "objUserReal": ActivesessionResponseCompoundUser.from_dict(obj.get("objUserReal")) if obj.get("objUserReal") is not None else None, + "objUserCloned": ActivesessionResponseCompoundUser.from_dict(obj.get("objUserCloned")) if obj.get("objUserCloned") is not None else None, + "objApikey": ActivesessionResponseCompoundApikey.from_dict(obj.get("objApikey")) if obj.get("objApikey") is not None else None, + "a_eModuleInternalname": obj.get("a_eModuleInternalname") }) return _obj diff --git a/eZmaxApi/models/activesession_get_list_v1_response.py b/eZmaxApi/models/activesession_get_list_v1_response.py index fdeecd6c6..251de1c08 100644 --- a/eZmaxApi/models/activesession_get_list_v1_response.py +++ b/eZmaxApi/models/activesession_get_list_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.activesession_get_list_v1_response_m_payload import ActivesessionGetListV1ResponseMPayload from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload_get_list import CommonResponseObjDebugPayloadGetList +try: + from typing import Self +except ImportError: + from typing_extensions import Self class ActivesessionGetListV1Response(BaseModel): """ - Response for GET /1/object/activesession/getList # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayloadGetList = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: ActivesessionGetListV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /1/object/activesession/getList + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayloadGetList = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: ActivesessionGetListV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> ActivesessionGetListV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of ActivesessionGetListV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> ActivesessionGetListV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of ActivesessionGetListV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return ActivesessionGetListV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = ActivesessionGetListV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayloadGetList.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": ActivesessionGetListV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayloadGetList.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": ActivesessionGetListV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/activesession_get_list_v1_response_m_payload.py b/eZmaxApi/models/activesession_get_list_v1_response_m_payload.py index 0d078ebd0..20a0a84d2 100644 --- a/eZmaxApi/models/activesession_get_list_v1_response_m_payload.py +++ b/eZmaxApi/models/activesession_get_list_v1_response_m_payload.py @@ -19,43 +19,61 @@ import json -from typing import List -from pydantic import BaseModel, Field, StrictInt, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictInt +from pydantic import Field from eZmaxApi.models.activesession_list_element import ActivesessionListElement +try: + from typing import Self +except ImportError: + from typing_extensions import Self class ActivesessionGetListV1ResponseMPayload(BaseModel): """ - Payload for GET /1/object/activesession/getList # noqa: E501 - """ - i_row_returned: StrictInt = Field(..., alias="iRowReturned", description="The number of rows returned") - i_row_filtered: StrictInt = Field(..., alias="iRowFiltered", description="The number of rows matching your filters (if any) or the total number of rows") - a_obj_activesession: conlist(ActivesessionListElement) = Field(..., alias="a_objActivesession") - __properties = ["iRowReturned", "iRowFiltered", "a_objActivesession"] + Payload for GET /1/object/activesession/getList + """ # noqa: E501 + i_row_returned: StrictInt = Field(description="The number of rows returned", alias="iRowReturned") + i_row_filtered: StrictInt = Field(description="The number of rows matching your filters (if any) or the total number of rows", alias="iRowFiltered") + a_obj_activesession: List[ActivesessionListElement] = Field(alias="a_objActivesession") + __properties: ClassVar[List[str]] = ["iRowReturned", "iRowFiltered", "a_objActivesession"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> ActivesessionGetListV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of ActivesessionGetListV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_activesession (list) _items = [] if self.a_obj_activesession: @@ -66,18 +84,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> ActivesessionGetListV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of ActivesessionGetListV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return ActivesessionGetListV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = ActivesessionGetListV1ResponseMPayload.parse_obj({ - "i_row_returned": obj.get("iRowReturned"), - "i_row_filtered": obj.get("iRowFiltered"), - "a_obj_activesession": [ActivesessionListElement.from_dict(_item) for _item in obj.get("a_objActivesession")] if obj.get("a_objActivesession") is not None else None + _obj = cls.model_validate({ + "iRowReturned": obj.get("iRowReturned"), + "iRowFiltered": obj.get("iRowFiltered"), + "a_objActivesession": [ActivesessionListElement.from_dict(_item) for _item in obj.get("a_objActivesession")] if obj.get("a_objActivesession") is not None else None }) return _obj diff --git a/eZmaxApi/models/activesession_list_element.py b/eZmaxApi/models/activesession_list_element.py index 2c3ed7189..82dedab30 100644 --- a/eZmaxApi/models/activesession_list_element.py +++ b/eZmaxApi/models/activesession_list_element.py @@ -19,103 +19,122 @@ import json - -from pydantic import BaseModel, Field, StrictInt, StrictStr, conint, constr, validator +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictInt, StrictStr, field_validator +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class ActivesessionListElement(BaseModel): """ - A Activesession List Element # noqa: E501 - """ - pki_activesession_id: StrictInt = Field(..., alias="pkiActivesessionID", description="The unique ID of the Activesession") - fki_user_id: conint(strict=True, ge=0) = Field(..., alias="fkiUserID", description="The unique ID of the User") - fki_computer_id: conint(strict=True, le=65535, ge=1) = Field(..., alias="fkiComputerID", description="The unique ID of the Computer") - fki_company_id: conint(strict=True, le=255, ge=1) = Field(..., alias="fkiCompanyID", description="The unique ID of the Company") - fki_department_id: conint(strict=True, ge=0) = Field(..., alias="fkiDepartmentID", description="The unique ID of the Department") - s_company_name_x: StrictStr = Field(..., alias="sCompanyNameX", description="The Name of the Company in the language of the requester") - s_department_name_x: StrictStr = Field(..., alias="sDepartmentNameX", description="The Name of the Department in the language of the requester") - s_activesession_loginname: constr(strict=True) = Field(..., alias="sActivesessionLoginname", description="The loginname of the Activesession") - s_computer_description: constr(strict=True) = Field(..., alias="sComputerDescription", description="The description of the Computer") - dt_activesession_firsthit: constr(strict=True) = Field(..., alias="dtActivesessionFirsthit", description="The first hit of the Activesession") - dt_activesession_lasthit: constr(strict=True) = Field(..., alias="dtActivesessionLasthit", description="The last hit of the Activesession") - s_activesession_ip: StrictStr = Field(..., alias="sActivesessionIP", description="Represent an IP address.") - __properties = ["pkiActivesessionID", "fkiUserID", "fkiComputerID", "fkiCompanyID", "fkiDepartmentID", "sCompanyNameX", "sDepartmentNameX", "sActivesessionLoginname", "sComputerDescription", "dtActivesessionFirsthit", "dtActivesessionLasthit", "sActivesessionIP"] - - @validator('s_activesession_loginname') + A Activesession List Element + """ # noqa: E501 + pki_activesession_id: StrictInt = Field(description="The unique ID of the Activesession", alias="pkiActivesessionID") + fki_user_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the User", alias="fkiUserID") + fki_computer_id: Annotated[int, Field(le=65535, strict=True, ge=1)] = Field(description="The unique ID of the Computer", alias="fkiComputerID") + fki_company_id: Annotated[int, Field(le=255, strict=True, ge=1)] = Field(description="The unique ID of the Company", alias="fkiCompanyID") + fki_department_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Department", alias="fkiDepartmentID") + s_company_name_x: StrictStr = Field(description="The Name of the Company in the language of the requester", alias="sCompanyNameX") + s_department_name_x: StrictStr = Field(description="The Name of the Department in the language of the requester", alias="sDepartmentNameX") + s_activesession_loginname: Annotated[str, Field(strict=True)] = Field(description="The loginname of the Activesession", alias="sActivesessionLoginname") + s_computer_description: Annotated[str, Field(strict=True)] = Field(description="The description of the Computer", alias="sComputerDescription") + dt_activesession_firsthit: Annotated[str, Field(strict=True)] = Field(description="The first hit of the Activesession", alias="dtActivesessionFirsthit") + dt_activesession_lasthit: Annotated[str, Field(strict=True)] = Field(description="The last hit of the Activesession", alias="dtActivesessionLasthit") + s_activesession_ip: StrictStr = Field(description="Represent an IP address.", alias="sActivesessionIP") + __properties: ClassVar[List[str]] = ["pkiActivesessionID", "fkiUserID", "fkiComputerID", "fkiCompanyID", "fkiDepartmentID", "sCompanyNameX", "sDepartmentNameX", "sActivesessionLoginname", "sComputerDescription", "dtActivesessionFirsthit", "dtActivesessionLasthit", "sActivesessionIP"] + + @field_validator('s_activesession_loginname') def s_activesession_loginname_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^.{0,32}$", value): raise ValueError(r"must validate the regular expression /^.{0,32}$/") return value - @validator('s_computer_description') + @field_validator('s_computer_description') def s_computer_description_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^.{0,50}$", value): raise ValueError(r"must validate the regular expression /^.{0,50}$/") return value - @validator('dt_activesession_firsthit') + @field_validator('dt_activesession_firsthit') def dt_activesession_firsthit_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1]) ([01]?[0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9])$", value): raise ValueError(r"must validate the regular expression /^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1]) ([01]?[0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9])$/") return value - @validator('dt_activesession_lasthit') + @field_validator('dt_activesession_lasthit') def dt_activesession_lasthit_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1]) ([01]?[0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9])$", value): raise ValueError(r"must validate the regular expression /^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1]) ([01]?[0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9])$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> ActivesessionListElement: + def from_json(cls, json_str: str) -> Self: """Create an instance of ActivesessionListElement from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> ActivesessionListElement: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of ActivesessionListElement from a dict""" if obj is None: return None if not isinstance(obj, dict): - return ActivesessionListElement.parse_obj(obj) - - _obj = ActivesessionListElement.parse_obj({ - "pki_activesession_id": obj.get("pkiActivesessionID"), - "fki_user_id": obj.get("fkiUserID"), - "fki_computer_id": obj.get("fkiComputerID"), - "fki_company_id": obj.get("fkiCompanyID"), - "fki_department_id": obj.get("fkiDepartmentID"), - "s_company_name_x": obj.get("sCompanyNameX"), - "s_department_name_x": obj.get("sDepartmentNameX"), - "s_activesession_loginname": obj.get("sActivesessionLoginname"), - "s_computer_description": obj.get("sComputerDescription"), - "dt_activesession_firsthit": obj.get("dtActivesessionFirsthit"), - "dt_activesession_lasthit": obj.get("dtActivesessionLasthit"), - "s_activesession_ip": obj.get("sActivesessionIP") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiActivesessionID": obj.get("pkiActivesessionID"), + "fkiUserID": obj.get("fkiUserID"), + "fkiComputerID": obj.get("fkiComputerID"), + "fkiCompanyID": obj.get("fkiCompanyID"), + "fkiDepartmentID": obj.get("fkiDepartmentID"), + "sCompanyNameX": obj.get("sCompanyNameX"), + "sDepartmentNameX": obj.get("sDepartmentNameX"), + "sActivesessionLoginname": obj.get("sActivesessionLoginname"), + "sComputerDescription": obj.get("sComputerDescription"), + "dtActivesessionFirsthit": obj.get("dtActivesessionFirsthit"), + "dtActivesessionLasthit": obj.get("dtActivesessionLasthit"), + "sActivesessionIP": obj.get("sActivesessionIP") }) return _obj diff --git a/eZmaxApi/models/activesession_response.py b/eZmaxApi/models/activesession_response.py index da84ddb8a..cd3249286 100644 --- a/eZmaxApi/models/activesession_response.py +++ b/eZmaxApi/models/activesession_response.py @@ -19,76 +19,95 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint, constr +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, StrictStr +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.field_e_activesession_origin import FieldEActivesessionOrigin from eZmaxApi.models.field_e_activesession_usertype import FieldEActivesessionUsertype from eZmaxApi.models.field_e_activesession_weekdaystart import FieldEActivesessionWeekdaystart +try: + from typing import Self +except ImportError: + from typing_extensions import Self class ActivesessionResponse(BaseModel): """ - An Activesession Object # noqa: E501 - """ - e_activesession_usertype: FieldEActivesessionUsertype = Field(..., alias="eActivesessionUsertype") - e_activesession_origin: FieldEActivesessionOrigin = Field(..., alias="eActivesessionOrigin") - e_activesession_weekdaystart: FieldEActivesessionWeekdaystart = Field(..., alias="eActivesessionWeekdaystart") - fki_language_id: conint(strict=True, le=2, ge=1) = Field(..., alias="fkiLanguageID", description="The unique ID of the Language. Valid values: |Value|Description| |-|-| |1|French| |2|English|") - s_company_name_x: StrictStr = Field(..., alias="sCompanyNameX", description="The Name of the Company in the language of the requester") - s_department_name_x: StrictStr = Field(..., alias="sDepartmentNameX", description="The Name of the Department in the language of the requester") - b_activesession_debug: StrictBool = Field(..., alias="bActivesessionDebug", description="Whether the active session is in debug or not") - b_activesession_issuperadmin: StrictBool = Field(..., alias="bActivesessionIssuperadmin", description="Whether the active session is superadmin or not") - pks_customer_code: constr(strict=True, max_length=6, min_length=2) = Field(..., alias="pksCustomerCode", description="The customer code assigned to your account") - fki_systemconfigurationtype_id: conint(strict=True, ge=1) = Field(..., alias="fkiSystemconfigurationtypeID", description="The unique ID of the Systemconfigurationtype") - fki_signature_id: Optional[conint(strict=True, le=16777215, ge=0)] = Field(None, alias="fkiSignatureID", description="The unique ID of the Signature") - __properties = ["eActivesessionUsertype", "eActivesessionOrigin", "eActivesessionWeekdaystart", "fkiLanguageID", "sCompanyNameX", "sDepartmentNameX", "bActivesessionDebug", "bActivesessionIssuperadmin", "pksCustomerCode", "fkiSystemconfigurationtypeID", "fkiSignatureID"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + An Activesession Object + """ # noqa: E501 + e_activesession_usertype: FieldEActivesessionUsertype = Field(alias="eActivesessionUsertype") + e_activesession_origin: FieldEActivesessionOrigin = Field(alias="eActivesessionOrigin") + e_activesession_weekdaystart: FieldEActivesessionWeekdaystart = Field(alias="eActivesessionWeekdaystart") + fki_language_id: Annotated[int, Field(le=2, strict=True, ge=1)] = Field(description="The unique ID of the Language. Valid values: |Value|Description| |-|-| |1|French| |2|English|", alias="fkiLanguageID") + s_company_name_x: StrictStr = Field(description="The Name of the Company in the language of the requester", alias="sCompanyNameX") + s_department_name_x: StrictStr = Field(description="The Name of the Department in the language of the requester", alias="sDepartmentNameX") + b_activesession_debug: StrictBool = Field(description="Whether the active session is in debug or not", alias="bActivesessionDebug") + b_activesession_issuperadmin: StrictBool = Field(description="Whether the active session is superadmin or not", alias="bActivesessionIssuperadmin") + pks_customer_code: Annotated[str, Field(min_length=2, strict=True, max_length=6)] = Field(description="The customer code assigned to your account", alias="pksCustomerCode") + fki_systemconfigurationtype_id: Annotated[int, Field(strict=True, ge=1)] = Field(description="The unique ID of the Systemconfigurationtype", alias="fkiSystemconfigurationtypeID") + fki_signature_id: Optional[Annotated[int, Field(le=16777215, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Signature", alias="fkiSignatureID") + __properties: ClassVar[List[str]] = ["eActivesessionUsertype", "eActivesessionOrigin", "eActivesessionWeekdaystart", "fkiLanguageID", "sCompanyNameX", "sDepartmentNameX", "bActivesessionDebug", "bActivesessionIssuperadmin", "pksCustomerCode", "fkiSystemconfigurationtypeID", "fkiSignatureID"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> ActivesessionResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of ActivesessionResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> ActivesessionResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of ActivesessionResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return ActivesessionResponse.parse_obj(obj) - - _obj = ActivesessionResponse.parse_obj({ - "e_activesession_usertype": obj.get("eActivesessionUsertype"), - "e_activesession_origin": obj.get("eActivesessionOrigin"), - "e_activesession_weekdaystart": obj.get("eActivesessionWeekdaystart"), - "fki_language_id": obj.get("fkiLanguageID"), - "s_company_name_x": obj.get("sCompanyNameX"), - "s_department_name_x": obj.get("sDepartmentNameX"), - "b_activesession_debug": obj.get("bActivesessionDebug"), - "b_activesession_issuperadmin": obj.get("bActivesessionIssuperadmin"), - "pks_customer_code": obj.get("pksCustomerCode"), - "fki_systemconfigurationtype_id": obj.get("fkiSystemconfigurationtypeID"), - "fki_signature_id": obj.get("fkiSignatureID") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "eActivesessionUsertype": obj.get("eActivesessionUsertype"), + "eActivesessionOrigin": obj.get("eActivesessionOrigin"), + "eActivesessionWeekdaystart": obj.get("eActivesessionWeekdaystart"), + "fkiLanguageID": obj.get("fkiLanguageID"), + "sCompanyNameX": obj.get("sCompanyNameX"), + "sDepartmentNameX": obj.get("sDepartmentNameX"), + "bActivesessionDebug": obj.get("bActivesessionDebug"), + "bActivesessionIssuperadmin": obj.get("bActivesessionIssuperadmin"), + "pksCustomerCode": obj.get("pksCustomerCode"), + "fkiSystemconfigurationtypeID": obj.get("fkiSystemconfigurationtypeID"), + "fkiSignatureID": obj.get("fkiSignatureID") }) return _obj diff --git a/eZmaxApi/models/activesession_response_compound.py b/eZmaxApi/models/activesession_response_compound.py index d652776cc..dc0376b41 100644 --- a/eZmaxApi/models/activesession_response_compound.py +++ b/eZmaxApi/models/activesession_response_compound.py @@ -19,60 +19,94 @@ import json -from typing import List, Optional -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint, conlist, constr +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, StrictStr, field_validator +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.activesession_response_compound_apikey import ActivesessionResponseCompoundApikey from eZmaxApi.models.activesession_response_compound_user import ActivesessionResponseCompoundUser from eZmaxApi.models.field_e_activesession_origin import FieldEActivesessionOrigin from eZmaxApi.models.field_e_activesession_usertype import FieldEActivesessionUsertype from eZmaxApi.models.field_e_activesession_weekdaystart import FieldEActivesessionWeekdaystart +from eZmaxApi.models.field_e_user_ezsignaccess import FieldEUserEzsignaccess +from eZmaxApi.models.field_e_user_ezsignprepaid import FieldEUserEzsignprepaid +try: + from typing import Self +except ImportError: + from typing_extensions import Self class ActivesessionResponseCompound(BaseModel): """ - Payload for GET /1/object/activesession/getCurrent # noqa: E501 - """ - e_activesession_usertype: FieldEActivesessionUsertype = Field(..., alias="eActivesessionUsertype") - e_activesession_origin: FieldEActivesessionOrigin = Field(..., alias="eActivesessionOrigin") - e_activesession_weekdaystart: FieldEActivesessionWeekdaystart = Field(..., alias="eActivesessionWeekdaystart") - fki_language_id: conint(strict=True, le=2, ge=1) = Field(..., alias="fkiLanguageID", description="The unique ID of the Language. Valid values: |Value|Description| |-|-| |1|French| |2|English|") - s_company_name_x: StrictStr = Field(..., alias="sCompanyNameX", description="The Name of the Company in the language of the requester") - s_department_name_x: StrictStr = Field(..., alias="sDepartmentNameX", description="The Name of the Department in the language of the requester") - b_activesession_debug: StrictBool = Field(..., alias="bActivesessionDebug", description="Whether the active session is in debug or not") - b_activesession_issuperadmin: StrictBool = Field(..., alias="bActivesessionIssuperadmin", description="Whether the active session is superadmin or not") - pks_customer_code: constr(strict=True, max_length=6, min_length=2) = Field(..., alias="pksCustomerCode", description="The customer code assigned to your account") - fki_systemconfigurationtype_id: conint(strict=True, ge=1) = Field(..., alias="fkiSystemconfigurationtypeID", description="The unique ID of the Systemconfigurationtype") - fki_signature_id: Optional[conint(strict=True, le=16777215, ge=0)] = Field(None, alias="fkiSignatureID", description="The unique ID of the Signature") - a_pki_permission_id: conlist(conint(strict=True, ge=0)) = Field(..., alias="a_pkiPermissionID", description="An array of permissions granted to the user or api key") - obj_user_real: ActivesessionResponseCompoundUser = Field(..., alias="objUserReal") - obj_user_cloned: Optional[ActivesessionResponseCompoundUser] = Field(None, alias="objUserCloned") - obj_apikey: Optional[ActivesessionResponseCompoundApikey] = Field(None, alias="objApikey") - a_e_module_internalname: conlist(StrictStr) = Field(..., alias="a_eModuleInternalname", description="An Array of Registered modules. These are the modules that are Licensed to be used by the User or the API Key.") - __properties = ["eActivesessionUsertype", "eActivesessionOrigin", "eActivesessionWeekdaystart", "fkiLanguageID", "sCompanyNameX", "sDepartmentNameX", "bActivesessionDebug", "bActivesessionIssuperadmin", "pksCustomerCode", "fkiSystemconfigurationtypeID", "fkiSignatureID", "a_pkiPermissionID", "objUserReal", "objUserCloned", "objApikey", "a_eModuleInternalname"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + Payload for GET /1/object/activesession/getCurrent + """ # noqa: E501 + e_activesession_usertype: FieldEActivesessionUsertype = Field(alias="eActivesessionUsertype") + e_activesession_origin: FieldEActivesessionOrigin = Field(alias="eActivesessionOrigin") + e_activesession_weekdaystart: FieldEActivesessionWeekdaystart = Field(alias="eActivesessionWeekdaystart") + fki_language_id: Annotated[int, Field(le=2, strict=True, ge=1)] = Field(description="The unique ID of the Language. Valid values: |Value|Description| |-|-| |1|French| |2|English|", alias="fkiLanguageID") + s_company_name_x: StrictStr = Field(description="The Name of the Company in the language of the requester", alias="sCompanyNameX") + s_department_name_x: StrictStr = Field(description="The Name of the Department in the language of the requester", alias="sDepartmentNameX") + b_activesession_debug: StrictBool = Field(description="Whether the active session is in debug or not", alias="bActivesessionDebug") + b_activesession_issuperadmin: StrictBool = Field(description="Whether the active session is superadmin or not", alias="bActivesessionIssuperadmin") + pks_customer_code: Annotated[str, Field(min_length=2, strict=True, max_length=6)] = Field(description="The customer code assigned to your account", alias="pksCustomerCode") + fki_systemconfigurationtype_id: Annotated[int, Field(strict=True, ge=1)] = Field(description="The unique ID of the Systemconfigurationtype", alias="fkiSystemconfigurationtypeID") + fki_signature_id: Optional[Annotated[int, Field(le=16777215, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Signature", alias="fkiSignatureID") + e_user_ezsignaccess: FieldEUserEzsignaccess = Field(alias="eUserEzsignaccess") + e_user_ezsignprepaid: Optional[FieldEUserEzsignprepaid] = Field(default=None, alias="eUserEzsignprepaid") + dt_user_ezsignprepaidexpiration: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="The eZsign prepaid expiration date", alias="dtUserEzsignprepaidexpiration") + a_pki_permission_id: List[Annotated[int, Field(strict=True, ge=0)]] = Field(description="An array of permissions granted to the user or api key", alias="a_pkiPermissionID") + obj_user_real: ActivesessionResponseCompoundUser = Field(alias="objUserReal") + obj_user_cloned: Optional[ActivesessionResponseCompoundUser] = Field(default=None, alias="objUserCloned") + obj_apikey: Optional[ActivesessionResponseCompoundApikey] = Field(default=None, alias="objApikey") + a_e_module_internalname: List[StrictStr] = Field(description="An Array of Registered modules. These are the modules that are Licensed to be used by the User or the API Key.", alias="a_eModuleInternalname") + __properties: ClassVar[List[str]] = ["eActivesessionUsertype", "eActivesessionOrigin", "eActivesessionWeekdaystart", "fkiLanguageID", "sCompanyNameX", "sDepartmentNameX", "bActivesessionDebug", "bActivesessionIssuperadmin", "pksCustomerCode", "fkiSystemconfigurationtypeID", "fkiSignatureID", "eUserEzsignaccess", "eUserEzsignprepaid", "dtUserEzsignprepaidexpiration", "a_pkiPermissionID", "objUserReal", "objUserCloned", "objApikey", "a_eModuleInternalname"] + + @field_validator('dt_user_ezsignprepaidexpiration') + def dt_user_ezsignprepaidexpiration_validate_regular_expression(cls, value): + """Validates the regular expression""" + if value is None: + return value + + if not re.match(r"^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$", value): + raise ValueError(r"must validate the regular expression /^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$/") + return value + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> ActivesessionResponseCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of ActivesessionResponseCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_user_real if self.obj_user_real: _dict['objUserReal'] = self.obj_user_real.to_dict() @@ -85,31 +119,34 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> ActivesessionResponseCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of ActivesessionResponseCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return ActivesessionResponseCompound.parse_obj(obj) - - _obj = ActivesessionResponseCompound.parse_obj({ - "e_activesession_usertype": obj.get("eActivesessionUsertype"), - "e_activesession_origin": obj.get("eActivesessionOrigin"), - "e_activesession_weekdaystart": obj.get("eActivesessionWeekdaystart"), - "fki_language_id": obj.get("fkiLanguageID"), - "s_company_name_x": obj.get("sCompanyNameX"), - "s_department_name_x": obj.get("sDepartmentNameX"), - "b_activesession_debug": obj.get("bActivesessionDebug"), - "b_activesession_issuperadmin": obj.get("bActivesessionIssuperadmin"), - "pks_customer_code": obj.get("pksCustomerCode"), - "fki_systemconfigurationtype_id": obj.get("fkiSystemconfigurationtypeID"), - "fki_signature_id": obj.get("fkiSignatureID"), - "a_pki_permission_id": obj.get("a_pkiPermissionID"), - "obj_user_real": ActivesessionResponseCompoundUser.from_dict(obj.get("objUserReal")) if obj.get("objUserReal") is not None else None, - "obj_user_cloned": ActivesessionResponseCompoundUser.from_dict(obj.get("objUserCloned")) if obj.get("objUserCloned") is not None else None, - "obj_apikey": ActivesessionResponseCompoundApikey.from_dict(obj.get("objApikey")) if obj.get("objApikey") is not None else None, - "a_e_module_internalname": obj.get("a_eModuleInternalname") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "eActivesessionUsertype": obj.get("eActivesessionUsertype"), + "eActivesessionOrigin": obj.get("eActivesessionOrigin"), + "eActivesessionWeekdaystart": obj.get("eActivesessionWeekdaystart"), + "fkiLanguageID": obj.get("fkiLanguageID"), + "sCompanyNameX": obj.get("sCompanyNameX"), + "sDepartmentNameX": obj.get("sDepartmentNameX"), + "bActivesessionDebug": obj.get("bActivesessionDebug"), + "bActivesessionIssuperadmin": obj.get("bActivesessionIssuperadmin"), + "pksCustomerCode": obj.get("pksCustomerCode"), + "fkiSystemconfigurationtypeID": obj.get("fkiSystemconfigurationtypeID"), + "fkiSignatureID": obj.get("fkiSignatureID"), + "eUserEzsignaccess": obj.get("eUserEzsignaccess"), + "eUserEzsignprepaid": obj.get("eUserEzsignprepaid"), + "dtUserEzsignprepaidexpiration": obj.get("dtUserEzsignprepaidexpiration"), + "a_pkiPermissionID": obj.get("a_pkiPermissionID"), + "objUserReal": ActivesessionResponseCompoundUser.from_dict(obj.get("objUserReal")) if obj.get("objUserReal") is not None else None, + "objUserCloned": ActivesessionResponseCompoundUser.from_dict(obj.get("objUserCloned")) if obj.get("objUserCloned") is not None else None, + "objApikey": ActivesessionResponseCompoundApikey.from_dict(obj.get("objApikey")) if obj.get("objApikey") is not None else None, + "a_eModuleInternalname": obj.get("a_eModuleInternalname") }) return _obj diff --git a/eZmaxApi/models/activesession_response_compound_apikey.py b/eZmaxApi/models/activesession_response_compound_apikey.py index 98834baf7..6a5d21ade 100644 --- a/eZmaxApi/models/activesession_response_compound_apikey.py +++ b/eZmaxApi/models/activesession_response_compound_apikey.py @@ -19,55 +19,74 @@ import json - -from pydantic import BaseModel, Field, StrictStr, conint +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictStr +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class ActivesessionResponseCompoundApikey(BaseModel): """ - An Activesession->Apikey object and children to create a complete structure # noqa: E501 - """ - pki_apikey_id: conint(strict=True, ge=0) = Field(..., alias="pkiApikeyID", description="The unique ID of the Apikey") - s_apikey_description_x: StrictStr = Field(..., alias="sApikeyDescriptionX", description="The description of the Apikey in the language of the requester") - __properties = ["pkiApikeyID", "sApikeyDescriptionX"] + An Activesession->Apikey object and children to create a complete structure + """ # noqa: E501 + pki_apikey_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Apikey", alias="pkiApikeyID") + s_apikey_description_x: StrictStr = Field(description="The description of the Apikey in the language of the requester", alias="sApikeyDescriptionX") + __properties: ClassVar[List[str]] = ["pkiApikeyID", "sApikeyDescriptionX"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> ActivesessionResponseCompoundApikey: + def from_json(cls, json_str: str) -> Self: """Create an instance of ActivesessionResponseCompoundApikey from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> ActivesessionResponseCompoundApikey: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of ActivesessionResponseCompoundApikey from a dict""" if obj is None: return None if not isinstance(obj, dict): - return ActivesessionResponseCompoundApikey.parse_obj(obj) + return cls.model_validate(obj) - _obj = ActivesessionResponseCompoundApikey.parse_obj({ - "pki_apikey_id": obj.get("pkiApikeyID"), - "s_apikey_description_x": obj.get("sApikeyDescriptionX") + _obj = cls.model_validate({ + "pkiApikeyID": obj.get("pkiApikeyID"), + "sApikeyDescriptionX": obj.get("sApikeyDescriptionX") }) return _obj diff --git a/eZmaxApi/models/activesession_response_compound_user.py b/eZmaxApi/models/activesession_response_compound_user.py index 4d2a3dea3..e556c7591 100644 --- a/eZmaxApi/models/activesession_response_compound_user.py +++ b/eZmaxApi/models/activesession_response_compound_user.py @@ -19,72 +19,91 @@ import json - -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictBool, StrictStr +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.field_e_user_ezsignsendreminderfrequency import FieldEUserEzsignsendreminderfrequency +try: + from typing import Self +except ImportError: + from typing_extensions import Self class ActivesessionResponseCompoundUser(BaseModel): """ - An Activesession->User Object and children to create a complete structure # noqa: E501 - """ - pki_user_id: conint(strict=True, ge=0) = Field(..., alias="pkiUserID", description="The unique ID of the User") - fki_timezone_id: conint(strict=True, ge=0) = Field(..., alias="fkiTimezoneID", description="The unique ID of the Timezone") - s_avatar_url: StrictStr = Field(..., alias="sAvatarUrl", description="The url of the picture used as avatar") - s_user_firstname: StrictStr = Field(..., alias="sUserFirstname", description="The first name of the user") - s_user_lastname: StrictStr = Field(..., alias="sUserLastname", description="The last name of the user") - s_email_address: StrictStr = Field(..., alias="sEmailAddress", description="The email address.") - e_user_ezsignsendreminderfrequency: FieldEUserEzsignsendreminderfrequency = Field(..., alias="eUserEzsignsendreminderfrequency") - i_user_interfacecolor: conint(strict=True, ge=0) = Field(..., alias="iUserInterfacecolor", description="The int32 representation of the interface color. For example, RGB color #39435B would be 3752795") - b_user_interfacedark: StrictBool = Field(..., alias="bUserInterfacedark", description="Whether to use a dark mode interface") - i_user_listresult: conint(strict=True, le=500, ge=5) = Field(..., alias="iUserListresult", description="The number of rows to return by default in lists") - __properties = ["pkiUserID", "fkiTimezoneID", "sAvatarUrl", "sUserFirstname", "sUserLastname", "sEmailAddress", "eUserEzsignsendreminderfrequency", "iUserInterfacecolor", "bUserInterfacedark", "iUserListresult"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + An Activesession->User Object and children to create a complete structure + """ # noqa: E501 + pki_user_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the User", alias="pkiUserID") + fki_timezone_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Timezone", alias="fkiTimezoneID") + s_avatar_url: StrictStr = Field(description="The url of the picture used as avatar", alias="sAvatarUrl") + s_user_firstname: StrictStr = Field(description="The first name of the user", alias="sUserFirstname") + s_user_lastname: StrictStr = Field(description="The last name of the user", alias="sUserLastname") + s_email_address: StrictStr = Field(description="The email address.", alias="sEmailAddress") + e_user_ezsignsendreminderfrequency: FieldEUserEzsignsendreminderfrequency = Field(alias="eUserEzsignsendreminderfrequency") + i_user_interfacecolor: Annotated[int, Field(strict=True, ge=0)] = Field(description="The int32 representation of the interface color. For example, RGB color #39435B would be 3752795", alias="iUserInterfacecolor") + b_user_interfacedark: StrictBool = Field(description="Whether to use a dark mode interface", alias="bUserInterfacedark") + i_user_listresult: Annotated[int, Field(le=500, strict=True, ge=5)] = Field(description="The number of rows to return by default in lists", alias="iUserListresult") + __properties: ClassVar[List[str]] = ["pkiUserID", "fkiTimezoneID", "sAvatarUrl", "sUserFirstname", "sUserLastname", "sEmailAddress", "eUserEzsignsendreminderfrequency", "iUserInterfacecolor", "bUserInterfacedark", "iUserListresult"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> ActivesessionResponseCompoundUser: + def from_json(cls, json_str: str) -> Self: """Create an instance of ActivesessionResponseCompoundUser from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> ActivesessionResponseCompoundUser: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of ActivesessionResponseCompoundUser from a dict""" if obj is None: return None if not isinstance(obj, dict): - return ActivesessionResponseCompoundUser.parse_obj(obj) - - _obj = ActivesessionResponseCompoundUser.parse_obj({ - "pki_user_id": obj.get("pkiUserID"), - "fki_timezone_id": obj.get("fkiTimezoneID"), - "s_avatar_url": obj.get("sAvatarUrl"), - "s_user_firstname": obj.get("sUserFirstname"), - "s_user_lastname": obj.get("sUserLastname"), - "s_email_address": obj.get("sEmailAddress"), - "e_user_ezsignsendreminderfrequency": obj.get("eUserEzsignsendreminderfrequency"), - "i_user_interfacecolor": obj.get("iUserInterfacecolor"), - "b_user_interfacedark": obj.get("bUserInterfacedark"), - "i_user_listresult": obj.get("iUserListresult") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiUserID": obj.get("pkiUserID"), + "fkiTimezoneID": obj.get("fkiTimezoneID"), + "sAvatarUrl": obj.get("sAvatarUrl"), + "sUserFirstname": obj.get("sUserFirstname"), + "sUserLastname": obj.get("sUserLastname"), + "sEmailAddress": obj.get("sEmailAddress"), + "eUserEzsignsendreminderfrequency": obj.get("eUserEzsignsendreminderfrequency"), + "iUserInterfacecolor": obj.get("iUserInterfacecolor"), + "bUserInterfacedark": obj.get("bUserInterfacedark"), + "iUserListresult": obj.get("iUserListresult") }) return _obj diff --git a/eZmaxApi/models/address_request.py b/eZmaxApi/models/address_request.py index 7f13be062..ed7bf3450 100644 --- a/eZmaxApi/models/address_request.py +++ b/eZmaxApi/models/address_request.py @@ -19,67 +19,86 @@ import json - -from pydantic import BaseModel, Field, StrictStr, conint +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictStr +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class AddressRequest(BaseModel): """ - An Address Object # noqa: E501 - """ - fki_addresstype_id: conint(strict=True, ge=0) = Field(..., alias="fkiAddresstypeID", description="The unique ID of the Addresstype. Valid values: |Value|Description| |-|-| |1|Office| |2|Home| |3|Real Estate Invoice| |4|Invoicing| |5|Shipping|") - s_address_civic: StrictStr = Field(..., alias="sAddressCivic", description="The Civic number.") - s_address_street: StrictStr = Field(..., alias="sAddressStreet", description="The Street Name") - s_address_suite: StrictStr = Field(..., alias="sAddressSuite", description="The Suite or appartment number") - s_address_city: StrictStr = Field(..., alias="sAddressCity", description="The City name") - fki_province_id: conint(strict=True, ge=0) = Field(..., alias="fkiProvinceID", description="The unique ID of the Province. Here are some common values (Complete list must be retrieved from API): |Value|Description| |-|-| |1|(Canada) Alberta |2|(Canada) British Columbia| |3|(Canada) Manitoba| |3|(Canada) Manitoba| |4|(Canada) New Brunswick| |5|(Canada) Newfoundland| |6|(Canada) Northwest Territories| |7|(Canada) Nova Scotia| |8|(Canada) Nunavut| |9|(Canada) Ontario| |10|(Canada) Prince Edward Island| |11|(Canada) Quebec| |12|(Canada) Saskatchewan| |13|(Canada) Yukon| |14|(United-States) Alabama| |15|(United-States) Alaska| |16|(United-States) Arizona| |17|(United-States) Arkansas| |18|(United-States) California| |19|(United-States) Colorado| |20|(United-States) Connecticut| |21|(United-States) Delaware| |22|(United-States) District of Columbia| |23|(United-States) Florida| |24|(United-States) Georgia| |25|(United-States) Hawaii| |26|(United-States) Idaho| |27|(United-States) Illinois| |28|(United-States) Indiana| |29|(United-States) Iowa| |30|(United-States) Kansas| |31|(United-States) Kentucky| |32|(United-States) Louisiane| |33|(United-States) Maine| |34|(United-States) Maryland| |35|(United-States) Massachusetts| |36|(United-States) Michigan| |37|(United-States) Minnesota| |38|(United-States) Mississippi| |39|(United-States) Missouri| |40|(United-States) Montana| |41|(United-States) Nebraska| |42|(United-States) Nevada| |43|(United-States) New Hampshire| |44|(United-States) New Jersey| |45|(United-States) New Mexico| |46|(United-States) New York| |47|(United-States) North Carolina| |48|(United-States) North Dakota| |49|(United-States) Ohio| |50|(United-States) Oklahoma| |51|(United-States) Oregon| |52|(United-States) Pennsylvania| |53|(United-States) Rhode Island| |54|(United-States) South Carolina| |55|(United-States) South Dakota| |56|(United-States) Tennessee| |57|(United-States) Texas| |58|(United-States) Utah| |60|(United-States) Vermont| |59|(United-States) Virginia| |61|(United-States) Washington| |62|(United-States) West Virginia| |63|(United-States) Wisconsin| |64|(United-States) Wyoming|") - fki_country_id: conint(strict=True, ge=0) = Field(..., alias="fkiCountryID", description="The unique ID of the Country. Here are some common values (Complete list must be retrieved from API): |Value|Description| |-|-| |1|Canada| |2|United-States|") - s_address_zip: StrictStr = Field(..., alias="sAddressZip", description="The Postal/Zip Code The value must be entered without spaces") - __properties = ["fkiAddresstypeID", "sAddressCivic", "sAddressStreet", "sAddressSuite", "sAddressCity", "fkiProvinceID", "fkiCountryID", "sAddressZip"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + An Address Object + """ # noqa: E501 + fki_addresstype_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Addresstype. Valid values: |Value|Description| |-|-| |1|Office| |2|Home| |3|Real Estate Invoice| |4|Invoicing| |5|Shipping|", alias="fkiAddresstypeID") + s_address_civic: StrictStr = Field(description="The Civic number.", alias="sAddressCivic") + s_address_street: StrictStr = Field(description="The Street Name", alias="sAddressStreet") + s_address_suite: StrictStr = Field(description="The Suite or appartment number", alias="sAddressSuite") + s_address_city: StrictStr = Field(description="The City name", alias="sAddressCity") + fki_province_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Province. Here are some common values (Complete list must be retrieved from API): |Value|Description| |-|-| |1|(Canada) Alberta |2|(Canada) British Columbia| |3|(Canada) Manitoba| |3|(Canada) Manitoba| |4|(Canada) New Brunswick| |5|(Canada) Newfoundland| |6|(Canada) Northwest Territories| |7|(Canada) Nova Scotia| |8|(Canada) Nunavut| |9|(Canada) Ontario| |10|(Canada) Prince Edward Island| |11|(Canada) Quebec| |12|(Canada) Saskatchewan| |13|(Canada) Yukon| |14|(United-States) Alabama| |15|(United-States) Alaska| |16|(United-States) Arizona| |17|(United-States) Arkansas| |18|(United-States) California| |19|(United-States) Colorado| |20|(United-States) Connecticut| |21|(United-States) Delaware| |22|(United-States) District of Columbia| |23|(United-States) Florida| |24|(United-States) Georgia| |25|(United-States) Hawaii| |26|(United-States) Idaho| |27|(United-States) Illinois| |28|(United-States) Indiana| |29|(United-States) Iowa| |30|(United-States) Kansas| |31|(United-States) Kentucky| |32|(United-States) Louisiane| |33|(United-States) Maine| |34|(United-States) Maryland| |35|(United-States) Massachusetts| |36|(United-States) Michigan| |37|(United-States) Minnesota| |38|(United-States) Mississippi| |39|(United-States) Missouri| |40|(United-States) Montana| |41|(United-States) Nebraska| |42|(United-States) Nevada| |43|(United-States) New Hampshire| |44|(United-States) New Jersey| |45|(United-States) New Mexico| |46|(United-States) New York| |47|(United-States) North Carolina| |48|(United-States) North Dakota| |49|(United-States) Ohio| |50|(United-States) Oklahoma| |51|(United-States) Oregon| |52|(United-States) Pennsylvania| |53|(United-States) Rhode Island| |54|(United-States) South Carolina| |55|(United-States) South Dakota| |56|(United-States) Tennessee| |57|(United-States) Texas| |58|(United-States) Utah| |60|(United-States) Vermont| |59|(United-States) Virginia| |61|(United-States) Washington| |62|(United-States) West Virginia| |63|(United-States) Wisconsin| |64|(United-States) Wyoming|", alias="fkiProvinceID") + fki_country_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Country. Here are some common values (Complete list must be retrieved from API): |Value|Description| |-|-| |1|Canada| |2|United-States|", alias="fkiCountryID") + s_address_zip: StrictStr = Field(description="The Postal/Zip Code The value must be entered without spaces", alias="sAddressZip") + __properties: ClassVar[List[str]] = ["fkiAddresstypeID", "sAddressCivic", "sAddressStreet", "sAddressSuite", "sAddressCity", "fkiProvinceID", "fkiCountryID", "sAddressZip"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> AddressRequest: + def from_json(cls, json_str: str) -> Self: """Create an instance of AddressRequest from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> AddressRequest: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of AddressRequest from a dict""" if obj is None: return None if not isinstance(obj, dict): - return AddressRequest.parse_obj(obj) - - _obj = AddressRequest.parse_obj({ - "fki_addresstype_id": obj.get("fkiAddresstypeID"), - "s_address_civic": obj.get("sAddressCivic"), - "s_address_street": obj.get("sAddressStreet"), - "s_address_suite": obj.get("sAddressSuite"), - "s_address_city": obj.get("sAddressCity"), - "fki_province_id": obj.get("fkiProvinceID"), - "fki_country_id": obj.get("fkiCountryID"), - "s_address_zip": obj.get("sAddressZip") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "fkiAddresstypeID": obj.get("fkiAddresstypeID"), + "sAddressCivic": obj.get("sAddressCivic"), + "sAddressStreet": obj.get("sAddressStreet"), + "sAddressSuite": obj.get("sAddressSuite"), + "sAddressCity": obj.get("sAddressCity"), + "fkiProvinceID": obj.get("fkiProvinceID"), + "fkiCountryID": obj.get("fkiCountryID"), + "sAddressZip": obj.get("sAddressZip") }) return _obj diff --git a/eZmaxApi/models/address_request_compound.py b/eZmaxApi/models/address_request_compound.py index e6164aea1..cd8ad2876 100644 --- a/eZmaxApi/models/address_request_compound.py +++ b/eZmaxApi/models/address_request_compound.py @@ -19,67 +19,86 @@ import json - -from pydantic import BaseModel, Field, StrictStr, conint +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictStr +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class AddressRequestCompound(BaseModel): """ - An Address Object and children to create a complete structure # noqa: E501 - """ - fki_addresstype_id: conint(strict=True, ge=0) = Field(..., alias="fkiAddresstypeID", description="The unique ID of the Addresstype. Valid values: |Value|Description| |-|-| |1|Office| |2|Home| |3|Real Estate Invoice| |4|Invoicing| |5|Shipping|") - s_address_civic: StrictStr = Field(..., alias="sAddressCivic", description="The Civic number.") - s_address_street: StrictStr = Field(..., alias="sAddressStreet", description="The Street Name") - s_address_suite: StrictStr = Field(..., alias="sAddressSuite", description="The Suite or appartment number") - s_address_city: StrictStr = Field(..., alias="sAddressCity", description="The City name") - fki_province_id: conint(strict=True, ge=0) = Field(..., alias="fkiProvinceID", description="The unique ID of the Province. Here are some common values (Complete list must be retrieved from API): |Value|Description| |-|-| |1|(Canada) Alberta |2|(Canada) British Columbia| |3|(Canada) Manitoba| |3|(Canada) Manitoba| |4|(Canada) New Brunswick| |5|(Canada) Newfoundland| |6|(Canada) Northwest Territories| |7|(Canada) Nova Scotia| |8|(Canada) Nunavut| |9|(Canada) Ontario| |10|(Canada) Prince Edward Island| |11|(Canada) Quebec| |12|(Canada) Saskatchewan| |13|(Canada) Yukon| |14|(United-States) Alabama| |15|(United-States) Alaska| |16|(United-States) Arizona| |17|(United-States) Arkansas| |18|(United-States) California| |19|(United-States) Colorado| |20|(United-States) Connecticut| |21|(United-States) Delaware| |22|(United-States) District of Columbia| |23|(United-States) Florida| |24|(United-States) Georgia| |25|(United-States) Hawaii| |26|(United-States) Idaho| |27|(United-States) Illinois| |28|(United-States) Indiana| |29|(United-States) Iowa| |30|(United-States) Kansas| |31|(United-States) Kentucky| |32|(United-States) Louisiane| |33|(United-States) Maine| |34|(United-States) Maryland| |35|(United-States) Massachusetts| |36|(United-States) Michigan| |37|(United-States) Minnesota| |38|(United-States) Mississippi| |39|(United-States) Missouri| |40|(United-States) Montana| |41|(United-States) Nebraska| |42|(United-States) Nevada| |43|(United-States) New Hampshire| |44|(United-States) New Jersey| |45|(United-States) New Mexico| |46|(United-States) New York| |47|(United-States) North Carolina| |48|(United-States) North Dakota| |49|(United-States) Ohio| |50|(United-States) Oklahoma| |51|(United-States) Oregon| |52|(United-States) Pennsylvania| |53|(United-States) Rhode Island| |54|(United-States) South Carolina| |55|(United-States) South Dakota| |56|(United-States) Tennessee| |57|(United-States) Texas| |58|(United-States) Utah| |60|(United-States) Vermont| |59|(United-States) Virginia| |61|(United-States) Washington| |62|(United-States) West Virginia| |63|(United-States) Wisconsin| |64|(United-States) Wyoming|") - fki_country_id: conint(strict=True, ge=0) = Field(..., alias="fkiCountryID", description="The unique ID of the Country. Here are some common values (Complete list must be retrieved from API): |Value|Description| |-|-| |1|Canada| |2|United-States|") - s_address_zip: StrictStr = Field(..., alias="sAddressZip", description="The Postal/Zip Code The value must be entered without spaces") - __properties = ["fkiAddresstypeID", "sAddressCivic", "sAddressStreet", "sAddressSuite", "sAddressCity", "fkiProvinceID", "fkiCountryID", "sAddressZip"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + An Address Object and children to create a complete structure + """ # noqa: E501 + fki_addresstype_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Addresstype. Valid values: |Value|Description| |-|-| |1|Office| |2|Home| |3|Real Estate Invoice| |4|Invoicing| |5|Shipping|", alias="fkiAddresstypeID") + s_address_civic: StrictStr = Field(description="The Civic number.", alias="sAddressCivic") + s_address_street: StrictStr = Field(description="The Street Name", alias="sAddressStreet") + s_address_suite: StrictStr = Field(description="The Suite or appartment number", alias="sAddressSuite") + s_address_city: StrictStr = Field(description="The City name", alias="sAddressCity") + fki_province_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Province. Here are some common values (Complete list must be retrieved from API): |Value|Description| |-|-| |1|(Canada) Alberta |2|(Canada) British Columbia| |3|(Canada) Manitoba| |3|(Canada) Manitoba| |4|(Canada) New Brunswick| |5|(Canada) Newfoundland| |6|(Canada) Northwest Territories| |7|(Canada) Nova Scotia| |8|(Canada) Nunavut| |9|(Canada) Ontario| |10|(Canada) Prince Edward Island| |11|(Canada) Quebec| |12|(Canada) Saskatchewan| |13|(Canada) Yukon| |14|(United-States) Alabama| |15|(United-States) Alaska| |16|(United-States) Arizona| |17|(United-States) Arkansas| |18|(United-States) California| |19|(United-States) Colorado| |20|(United-States) Connecticut| |21|(United-States) Delaware| |22|(United-States) District of Columbia| |23|(United-States) Florida| |24|(United-States) Georgia| |25|(United-States) Hawaii| |26|(United-States) Idaho| |27|(United-States) Illinois| |28|(United-States) Indiana| |29|(United-States) Iowa| |30|(United-States) Kansas| |31|(United-States) Kentucky| |32|(United-States) Louisiane| |33|(United-States) Maine| |34|(United-States) Maryland| |35|(United-States) Massachusetts| |36|(United-States) Michigan| |37|(United-States) Minnesota| |38|(United-States) Mississippi| |39|(United-States) Missouri| |40|(United-States) Montana| |41|(United-States) Nebraska| |42|(United-States) Nevada| |43|(United-States) New Hampshire| |44|(United-States) New Jersey| |45|(United-States) New Mexico| |46|(United-States) New York| |47|(United-States) North Carolina| |48|(United-States) North Dakota| |49|(United-States) Ohio| |50|(United-States) Oklahoma| |51|(United-States) Oregon| |52|(United-States) Pennsylvania| |53|(United-States) Rhode Island| |54|(United-States) South Carolina| |55|(United-States) South Dakota| |56|(United-States) Tennessee| |57|(United-States) Texas| |58|(United-States) Utah| |60|(United-States) Vermont| |59|(United-States) Virginia| |61|(United-States) Washington| |62|(United-States) West Virginia| |63|(United-States) Wisconsin| |64|(United-States) Wyoming|", alias="fkiProvinceID") + fki_country_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Country. Here are some common values (Complete list must be retrieved from API): |Value|Description| |-|-| |1|Canada| |2|United-States|", alias="fkiCountryID") + s_address_zip: StrictStr = Field(description="The Postal/Zip Code The value must be entered without spaces", alias="sAddressZip") + __properties: ClassVar[List[str]] = ["fkiAddresstypeID", "sAddressCivic", "sAddressStreet", "sAddressSuite", "sAddressCity", "fkiProvinceID", "fkiCountryID", "sAddressZip"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> AddressRequestCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of AddressRequestCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> AddressRequestCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of AddressRequestCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return AddressRequestCompound.parse_obj(obj) - - _obj = AddressRequestCompound.parse_obj({ - "fki_addresstype_id": obj.get("fkiAddresstypeID"), - "s_address_civic": obj.get("sAddressCivic"), - "s_address_street": obj.get("sAddressStreet"), - "s_address_suite": obj.get("sAddressSuite"), - "s_address_city": obj.get("sAddressCity"), - "fki_province_id": obj.get("fkiProvinceID"), - "fki_country_id": obj.get("fkiCountryID"), - "s_address_zip": obj.get("sAddressZip") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "fkiAddresstypeID": obj.get("fkiAddresstypeID"), + "sAddressCivic": obj.get("sAddressCivic"), + "sAddressStreet": obj.get("sAddressStreet"), + "sAddressSuite": obj.get("sAddressSuite"), + "sAddressCity": obj.get("sAddressCity"), + "fkiProvinceID": obj.get("fkiProvinceID"), + "fkiCountryID": obj.get("fkiCountryID"), + "sAddressZip": obj.get("sAddressZip") }) return _obj diff --git a/eZmaxApi/models/apikey_create_object_v2_request.py b/eZmaxApi/models/apikey_create_object_v2_request.py index 0fb8889e5..36f6ecaca 100644 --- a/eZmaxApi/models/apikey_create_object_v2_request.py +++ b/eZmaxApi/models/apikey_create_object_v2_request.py @@ -19,41 +19,60 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.apikey_request_compound import ApikeyRequestCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class ApikeyCreateObjectV2Request(BaseModel): """ - Request for POST /2/object/apikey # noqa: E501 - """ - a_obj_apikey: conlist(ApikeyRequestCompound, min_items=1) = Field(..., alias="a_objApikey") - __properties = ["a_objApikey"] + Request for POST /2/object/apikey + """ # noqa: E501 + a_obj_apikey: Annotated[List[ApikeyRequestCompound], Field(min_length=1)] = Field(alias="a_objApikey") + __properties: ClassVar[List[str]] = ["a_objApikey"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> ApikeyCreateObjectV2Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of ApikeyCreateObjectV2Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_apikey (list) _items = [] if self.a_obj_apikey: @@ -64,16 +83,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> ApikeyCreateObjectV2Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of ApikeyCreateObjectV2Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return ApikeyCreateObjectV2Request.parse_obj(obj) + return cls.model_validate(obj) - _obj = ApikeyCreateObjectV2Request.parse_obj({ - "a_obj_apikey": [ApikeyRequestCompound.from_dict(_item) for _item in obj.get("a_objApikey")] if obj.get("a_objApikey") is not None else None + _obj = cls.model_validate({ + "a_objApikey": [ApikeyRequestCompound.from_dict(_item) for _item in obj.get("a_objApikey")] if obj.get("a_objApikey") is not None else None }) return _obj diff --git a/eZmaxApi/models/apikey_create_object_v2_response.py b/eZmaxApi/models/apikey_create_object_v2_response.py index e8c3ede2a..36cb8e3f6 100644 --- a/eZmaxApi/models/apikey_create_object_v2_response.py +++ b/eZmaxApi/models/apikey_create_object_v2_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.apikey_create_object_v2_response_m_payload import ApikeyCreateObjectV2ResponseMPayload from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class ApikeyCreateObjectV2Response(BaseModel): """ - Response for POST /2/object/apikey # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: ApikeyCreateObjectV2ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for POST /2/object/apikey + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: ApikeyCreateObjectV2ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> ApikeyCreateObjectV2Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of ApikeyCreateObjectV2Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> ApikeyCreateObjectV2Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of ApikeyCreateObjectV2Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return ApikeyCreateObjectV2Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = ApikeyCreateObjectV2Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": ApikeyCreateObjectV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": ApikeyCreateObjectV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/apikey_create_object_v2_response_m_payload.py b/eZmaxApi/models/apikey_create_object_v2_response_m_payload.py index a188519fc..66f1fb8ad 100644 --- a/eZmaxApi/models/apikey_create_object_v2_response_m_payload.py +++ b/eZmaxApi/models/apikey_create_object_v2_response_m_payload.py @@ -19,41 +19,60 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.apikey_response_compound import ApikeyResponseCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class ApikeyCreateObjectV2ResponseMPayload(BaseModel): """ - Payload for POST /2/object/apikey # noqa: E501 - """ - a_obj_apikey: conlist(ApikeyResponseCompound, min_items=1) = Field(..., alias="a_objApikey") - __properties = ["a_objApikey"] + Payload for POST /2/object/apikey + """ # noqa: E501 + a_obj_apikey: Annotated[List[ApikeyResponseCompound], Field(min_length=1)] = Field(alias="a_objApikey") + __properties: ClassVar[List[str]] = ["a_objApikey"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> ApikeyCreateObjectV2ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of ApikeyCreateObjectV2ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_apikey (list) _items = [] if self.a_obj_apikey: @@ -64,16 +83,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> ApikeyCreateObjectV2ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of ApikeyCreateObjectV2ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return ApikeyCreateObjectV2ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = ApikeyCreateObjectV2ResponseMPayload.parse_obj({ - "a_obj_apikey": [ApikeyResponseCompound.from_dict(_item) for _item in obj.get("a_objApikey")] if obj.get("a_objApikey") is not None else None + _obj = cls.model_validate({ + "a_objApikey": [ApikeyResponseCompound.from_dict(_item) for _item in obj.get("a_objApikey")] if obj.get("a_objApikey") is not None else None }) return _obj diff --git a/eZmaxApi/models/apikey_edit_object_v1_request.py b/eZmaxApi/models/apikey_edit_object_v1_request.py index a13a26c84..345588c84 100644 --- a/eZmaxApi/models/apikey_edit_object_v1_request.py +++ b/eZmaxApi/models/apikey_edit_object_v1_request.py @@ -19,57 +19,75 @@ import json - -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.apikey_request_compound import ApikeyRequestCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class ApikeyEditObjectV1Request(BaseModel): """ - Request for PUT /1/object/apikey/{pkiApikeyID} # noqa: E501 - """ - obj_apikey: ApikeyRequestCompound = Field(..., alias="objApikey") - __properties = ["objApikey"] + Request for PUT /1/object/apikey/{pkiApikeyID} + """ # noqa: E501 + obj_apikey: ApikeyRequestCompound = Field(alias="objApikey") + __properties: ClassVar[List[str]] = ["objApikey"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> ApikeyEditObjectV1Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of ApikeyEditObjectV1Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_apikey if self.obj_apikey: _dict['objApikey'] = self.obj_apikey.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> ApikeyEditObjectV1Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of ApikeyEditObjectV1Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return ApikeyEditObjectV1Request.parse_obj(obj) + return cls.model_validate(obj) - _obj = ApikeyEditObjectV1Request.parse_obj({ - "obj_apikey": ApikeyRequestCompound.from_dict(obj.get("objApikey")) if obj.get("objApikey") is not None else None + _obj = cls.model_validate({ + "objApikey": ApikeyRequestCompound.from_dict(obj.get("objApikey")) if obj.get("objApikey") is not None else None }) return _obj diff --git a/eZmaxApi/models/apikey_edit_object_v1_response.py b/eZmaxApi/models/apikey_edit_object_v1_response.py index 1c130438a..293f03858 100644 --- a/eZmaxApi/models/apikey_edit_object_v1_response.py +++ b/eZmaxApi/models/apikey_edit_object_v1_response.py @@ -19,43 +19,61 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class ApikeyEditObjectV1Response(BaseModel): """ - Response for PUT /1/object/apikey/{pkiApikeyID} # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - __properties = ["objDebugPayload", "objDebug"] + Response for PUT /1/object/apikey/{pkiApikeyID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> ApikeyEditObjectV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of ApikeyEditObjectV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -65,17 +83,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> ApikeyEditObjectV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of ApikeyEditObjectV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return ApikeyEditObjectV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = ApikeyEditObjectV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None }) return _obj diff --git a/eZmaxApi/models/apikey_edit_permissions_v1_request.py b/eZmaxApi/models/apikey_edit_permissions_v1_request.py index e8e4d22be..32e10902c 100644 --- a/eZmaxApi/models/apikey_edit_permissions_v1_request.py +++ b/eZmaxApi/models/apikey_edit_permissions_v1_request.py @@ -19,41 +19,59 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.permission_request_compound import PermissionRequestCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class ApikeyEditPermissionsV1Request(BaseModel): """ - Request for PUT /1/object/apikey/{pkiApikeyID}/editPermissions # noqa: E501 - """ - a_obj_permission: conlist(PermissionRequestCompound) = Field(..., alias="a_objPermission") - __properties = ["a_objPermission"] + Request for PUT /1/object/apikey/{pkiApikeyID}/editPermissions + """ # noqa: E501 + a_obj_permission: List[PermissionRequestCompound] = Field(alias="a_objPermission") + __properties: ClassVar[List[str]] = ["a_objPermission"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> ApikeyEditPermissionsV1Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of ApikeyEditPermissionsV1Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_permission (list) _items = [] if self.a_obj_permission: @@ -64,16 +82,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> ApikeyEditPermissionsV1Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of ApikeyEditPermissionsV1Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return ApikeyEditPermissionsV1Request.parse_obj(obj) + return cls.model_validate(obj) - _obj = ApikeyEditPermissionsV1Request.parse_obj({ - "a_obj_permission": [PermissionRequestCompound.from_dict(_item) for _item in obj.get("a_objPermission")] if obj.get("a_objPermission") is not None else None + _obj = cls.model_validate({ + "a_objPermission": [PermissionRequestCompound.from_dict(_item) for _item in obj.get("a_objPermission")] if obj.get("a_objPermission") is not None else None }) return _obj diff --git a/eZmaxApi/models/apikey_edit_permissions_v1_response.py b/eZmaxApi/models/apikey_edit_permissions_v1_response.py index 066905e1e..8c2e07a4f 100644 --- a/eZmaxApi/models/apikey_edit_permissions_v1_response.py +++ b/eZmaxApi/models/apikey_edit_permissions_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.apikey_edit_permissions_v1_response_m_payload import ApikeyEditPermissionsV1ResponseMPayload from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class ApikeyEditPermissionsV1Response(BaseModel): """ - Response for PUT /1/object/apikey/{pkiApikeyID}/editPermissions # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: ApikeyEditPermissionsV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for PUT /1/object/apikey/{pkiApikeyID}/editPermissions + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: ApikeyEditPermissionsV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> ApikeyEditPermissionsV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of ApikeyEditPermissionsV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> ApikeyEditPermissionsV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of ApikeyEditPermissionsV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return ApikeyEditPermissionsV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = ApikeyEditPermissionsV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": ApikeyEditPermissionsV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": ApikeyEditPermissionsV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/apikey_edit_permissions_v1_response_m_payload.py b/eZmaxApi/models/apikey_edit_permissions_v1_response_m_payload.py index 627b2b6af..09a1cd0fd 100644 --- a/eZmaxApi/models/apikey_edit_permissions_v1_response_m_payload.py +++ b/eZmaxApi/models/apikey_edit_permissions_v1_response_m_payload.py @@ -19,53 +19,72 @@ import json -from typing import List -from pydantic import BaseModel, Field, conint, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class ApikeyEditPermissionsV1ResponseMPayload(BaseModel): """ - Payload for PUT /1/object/apikey/{pkiApikeyID}/editPermissions # noqa: E501 - """ - a_pki_permission_id: conlist(conint(strict=True, le=65535, ge=0)) = Field(..., alias="a_pkiPermissionID") - __properties = ["a_pkiPermissionID"] + Payload for PUT /1/object/apikey/{pkiApikeyID}/editPermissions + """ # noqa: E501 + a_pki_permission_id: List[Annotated[int, Field(le=65535, strict=True, ge=0)]] = Field(alias="a_pkiPermissionID") + __properties: ClassVar[List[str]] = ["a_pkiPermissionID"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> ApikeyEditPermissionsV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of ApikeyEditPermissionsV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> ApikeyEditPermissionsV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of ApikeyEditPermissionsV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return ApikeyEditPermissionsV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = ApikeyEditPermissionsV1ResponseMPayload.parse_obj({ - "a_pki_permission_id": obj.get("a_pkiPermissionID") + _obj = cls.model_validate({ + "a_pkiPermissionID": obj.get("a_pkiPermissionID") }) return _obj diff --git a/eZmaxApi/models/apikey_get_cors_v1_response.py b/eZmaxApi/models/apikey_get_cors_v1_response.py index 9b8896ebf..cfa7acc5e 100644 --- a/eZmaxApi/models/apikey_get_cors_v1_response.py +++ b/eZmaxApi/models/apikey_get_cors_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.apikey_get_cors_v1_response_m_payload import ApikeyGetCorsV1ResponseMPayload from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class ApikeyGetCorsV1Response(BaseModel): """ - Response for GET /1/object/apikey/{pkiApikeyID}/getCors # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: ApikeyGetCorsV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /1/object/apikey/{pkiApikeyID}/getCors + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: ApikeyGetCorsV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> ApikeyGetCorsV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of ApikeyGetCorsV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> ApikeyGetCorsV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of ApikeyGetCorsV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return ApikeyGetCorsV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = ApikeyGetCorsV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": ApikeyGetCorsV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": ApikeyGetCorsV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/apikey_get_cors_v1_response_m_payload.py b/eZmaxApi/models/apikey_get_cors_v1_response_m_payload.py index 52b856850..ec4d7b263 100644 --- a/eZmaxApi/models/apikey_get_cors_v1_response_m_payload.py +++ b/eZmaxApi/models/apikey_get_cors_v1_response_m_payload.py @@ -19,41 +19,59 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.cors_response_compound import CorsResponseCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class ApikeyGetCorsV1ResponseMPayload(BaseModel): """ - Response for GET /1/object/apikey/{pkiApikeyID}/getCors # noqa: E501 - """ - a_obj_cors: conlist(CorsResponseCompound) = Field(..., alias="a_objCors") - __properties = ["a_objCors"] + Response for GET /1/object/apikey/{pkiApikeyID}/getCors + """ # noqa: E501 + a_obj_cors: List[CorsResponseCompound] = Field(alias="a_objCors") + __properties: ClassVar[List[str]] = ["a_objCors"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> ApikeyGetCorsV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of ApikeyGetCorsV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_cors (list) _items = [] if self.a_obj_cors: @@ -64,16 +82,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> ApikeyGetCorsV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of ApikeyGetCorsV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return ApikeyGetCorsV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = ApikeyGetCorsV1ResponseMPayload.parse_obj({ - "a_obj_cors": [CorsResponseCompound.from_dict(_item) for _item in obj.get("a_objCors")] if obj.get("a_objCors") is not None else None + _obj = cls.model_validate({ + "a_objCors": [CorsResponseCompound.from_dict(_item) for _item in obj.get("a_objCors")] if obj.get("a_objCors") is not None else None }) return _obj diff --git a/eZmaxApi/models/apikey_get_list_v1_response.py b/eZmaxApi/models/apikey_get_list_v1_response.py index 10cce9c99..75629c640 100644 --- a/eZmaxApi/models/apikey_get_list_v1_response.py +++ b/eZmaxApi/models/apikey_get_list_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.apikey_get_list_v1_response_m_payload import ApikeyGetListV1ResponseMPayload from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload_get_list import CommonResponseObjDebugPayloadGetList +try: + from typing import Self +except ImportError: + from typing_extensions import Self class ApikeyGetListV1Response(BaseModel): """ - Response for GET /1/object/apikey/getList # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayloadGetList = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: ApikeyGetListV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /1/object/apikey/getList + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayloadGetList = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: ApikeyGetListV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> ApikeyGetListV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of ApikeyGetListV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> ApikeyGetListV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of ApikeyGetListV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return ApikeyGetListV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = ApikeyGetListV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayloadGetList.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": ApikeyGetListV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayloadGetList.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": ApikeyGetListV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/apikey_get_list_v1_response_m_payload.py b/eZmaxApi/models/apikey_get_list_v1_response_m_payload.py index c83a18975..926c5d770 100644 --- a/eZmaxApi/models/apikey_get_list_v1_response_m_payload.py +++ b/eZmaxApi/models/apikey_get_list_v1_response_m_payload.py @@ -19,43 +19,61 @@ import json -from typing import List -from pydantic import BaseModel, Field, StrictInt, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictInt +from pydantic import Field from eZmaxApi.models.apikey_list_element import ApikeyListElement +try: + from typing import Self +except ImportError: + from typing_extensions import Self class ApikeyGetListV1ResponseMPayload(BaseModel): """ - Payload for GET /1/object/apikey/getList # noqa: E501 - """ - i_row_returned: StrictInt = Field(..., alias="iRowReturned", description="The number of rows returned") - i_row_filtered: StrictInt = Field(..., alias="iRowFiltered", description="The number of rows matching your filters (if any) or the total number of rows") - a_obj_apikey: conlist(ApikeyListElement) = Field(..., alias="a_objApikey") - __properties = ["iRowReturned", "iRowFiltered", "a_objApikey"] + Payload for GET /1/object/apikey/getList + """ # noqa: E501 + i_row_returned: StrictInt = Field(description="The number of rows returned", alias="iRowReturned") + i_row_filtered: StrictInt = Field(description="The number of rows matching your filters (if any) or the total number of rows", alias="iRowFiltered") + a_obj_apikey: List[ApikeyListElement] = Field(alias="a_objApikey") + __properties: ClassVar[List[str]] = ["iRowReturned", "iRowFiltered", "a_objApikey"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> ApikeyGetListV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of ApikeyGetListV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_apikey (list) _items = [] if self.a_obj_apikey: @@ -66,18 +84,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> ApikeyGetListV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of ApikeyGetListV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return ApikeyGetListV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = ApikeyGetListV1ResponseMPayload.parse_obj({ - "i_row_returned": obj.get("iRowReturned"), - "i_row_filtered": obj.get("iRowFiltered"), - "a_obj_apikey": [ApikeyListElement.from_dict(_item) for _item in obj.get("a_objApikey")] if obj.get("a_objApikey") is not None else None + _obj = cls.model_validate({ + "iRowReturned": obj.get("iRowReturned"), + "iRowFiltered": obj.get("iRowFiltered"), + "a_objApikey": [ApikeyListElement.from_dict(_item) for _item in obj.get("a_objApikey")] if obj.get("a_objApikey") is not None else None }) return _obj diff --git a/eZmaxApi/models/apikey_get_object_v2_response.py b/eZmaxApi/models/apikey_get_object_v2_response.py index 7658576ed..b5a992d94 100644 --- a/eZmaxApi/models/apikey_get_object_v2_response.py +++ b/eZmaxApi/models/apikey_get_object_v2_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.apikey_get_object_v2_response_m_payload import ApikeyGetObjectV2ResponseMPayload from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class ApikeyGetObjectV2Response(BaseModel): """ - Response for GET /2/object/apikey/{pkiApikeyID} # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: ApikeyGetObjectV2ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /2/object/apikey/{pkiApikeyID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: ApikeyGetObjectV2ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> ApikeyGetObjectV2Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of ApikeyGetObjectV2Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> ApikeyGetObjectV2Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of ApikeyGetObjectV2Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return ApikeyGetObjectV2Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = ApikeyGetObjectV2Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": ApikeyGetObjectV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": ApikeyGetObjectV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/apikey_get_object_v2_response_m_payload.py b/eZmaxApi/models/apikey_get_object_v2_response_m_payload.py index 565b56f5b..280d86290 100644 --- a/eZmaxApi/models/apikey_get_object_v2_response_m_payload.py +++ b/eZmaxApi/models/apikey_get_object_v2_response_m_payload.py @@ -19,57 +19,75 @@ import json - -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.apikey_response_compound import ApikeyResponseCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class ApikeyGetObjectV2ResponseMPayload(BaseModel): """ - Payload for GET /2/object/apikey/{pkiApikeyID} # noqa: E501 - """ - obj_apikey: ApikeyResponseCompound = Field(..., alias="objApikey") - __properties = ["objApikey"] + Payload for GET /2/object/apikey/{pkiApikeyID} + """ # noqa: E501 + obj_apikey: ApikeyResponseCompound = Field(alias="objApikey") + __properties: ClassVar[List[str]] = ["objApikey"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> ApikeyGetObjectV2ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of ApikeyGetObjectV2ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_apikey if self.obj_apikey: _dict['objApikey'] = self.obj_apikey.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> ApikeyGetObjectV2ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of ApikeyGetObjectV2ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return ApikeyGetObjectV2ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = ApikeyGetObjectV2ResponseMPayload.parse_obj({ - "obj_apikey": ApikeyResponseCompound.from_dict(obj.get("objApikey")) if obj.get("objApikey") is not None else None + _obj = cls.model_validate({ + "objApikey": ApikeyResponseCompound.from_dict(obj.get("objApikey")) if obj.get("objApikey") is not None else None }) return _obj diff --git a/eZmaxApi/models/apikey_get_permissions_v1_response.py b/eZmaxApi/models/apikey_get_permissions_v1_response.py index 77c5e7801..264ff0fd5 100644 --- a/eZmaxApi/models/apikey_get_permissions_v1_response.py +++ b/eZmaxApi/models/apikey_get_permissions_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.apikey_get_permissions_v1_response_m_payload import ApikeyGetPermissionsV1ResponseMPayload from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class ApikeyGetPermissionsV1Response(BaseModel): """ - Response for GET /1/object/apikey/{pkiApikeyID}/getPermissions # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: ApikeyGetPermissionsV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /1/object/apikey/{pkiApikeyID}/getPermissions + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: ApikeyGetPermissionsV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> ApikeyGetPermissionsV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of ApikeyGetPermissionsV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> ApikeyGetPermissionsV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of ApikeyGetPermissionsV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return ApikeyGetPermissionsV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = ApikeyGetPermissionsV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": ApikeyGetPermissionsV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": ApikeyGetPermissionsV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/apikey_get_permissions_v1_response_m_payload.py b/eZmaxApi/models/apikey_get_permissions_v1_response_m_payload.py index 64eed9d89..6a4343013 100644 --- a/eZmaxApi/models/apikey_get_permissions_v1_response_m_payload.py +++ b/eZmaxApi/models/apikey_get_permissions_v1_response_m_payload.py @@ -19,41 +19,59 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.modulegroup_response_compound import ModulegroupResponseCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class ApikeyGetPermissionsV1ResponseMPayload(BaseModel): """ - Response for GET /1/object/apikey/{pkiApikeyID}/getPermissions # noqa: E501 - """ - a_obj_modulegroup: conlist(ModulegroupResponseCompound) = Field(..., alias="a_objModulegroup") - __properties = ["a_objModulegroup"] + Response for GET /1/object/apikey/{pkiApikeyID}/getPermissions + """ # noqa: E501 + a_obj_modulegroup: List[ModulegroupResponseCompound] = Field(alias="a_objModulegroup") + __properties: ClassVar[List[str]] = ["a_objModulegroup"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> ApikeyGetPermissionsV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of ApikeyGetPermissionsV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_modulegroup (list) _items = [] if self.a_obj_modulegroup: @@ -64,16 +82,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> ApikeyGetPermissionsV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of ApikeyGetPermissionsV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return ApikeyGetPermissionsV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = ApikeyGetPermissionsV1ResponseMPayload.parse_obj({ - "a_obj_modulegroup": [ModulegroupResponseCompound.from_dict(_item) for _item in obj.get("a_objModulegroup")] if obj.get("a_objModulegroup") is not None else None + _obj = cls.model_validate({ + "a_objModulegroup": [ModulegroupResponseCompound.from_dict(_item) for _item in obj.get("a_objModulegroup")] if obj.get("a_objModulegroup") is not None else None }) return _obj diff --git a/eZmaxApi/models/apikey_get_subnets_v1_response.py b/eZmaxApi/models/apikey_get_subnets_v1_response.py index 9dac552ae..b53f7741f 100644 --- a/eZmaxApi/models/apikey_get_subnets_v1_response.py +++ b/eZmaxApi/models/apikey_get_subnets_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.apikey_get_subnets_v1_response_m_payload import ApikeyGetSubnetsV1ResponseMPayload from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class ApikeyGetSubnetsV1Response(BaseModel): """ - Response for GET /1/object/apikey/{pkiApikeyID}/getSubnets # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: ApikeyGetSubnetsV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /1/object/apikey/{pkiApikeyID}/getSubnets + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: ApikeyGetSubnetsV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> ApikeyGetSubnetsV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of ApikeyGetSubnetsV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> ApikeyGetSubnetsV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of ApikeyGetSubnetsV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return ApikeyGetSubnetsV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = ApikeyGetSubnetsV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": ApikeyGetSubnetsV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": ApikeyGetSubnetsV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/apikey_get_subnets_v1_response_m_payload.py b/eZmaxApi/models/apikey_get_subnets_v1_response_m_payload.py index 7938c987e..ce8fef93d 100644 --- a/eZmaxApi/models/apikey_get_subnets_v1_response_m_payload.py +++ b/eZmaxApi/models/apikey_get_subnets_v1_response_m_payload.py @@ -19,41 +19,59 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.subnet_response_compound import SubnetResponseCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class ApikeyGetSubnetsV1ResponseMPayload(BaseModel): """ - Response for GET /1/object/apikey/{pkiApikeyID}/getSubnets # noqa: E501 - """ - a_obj_subnet: conlist(SubnetResponseCompound) = Field(..., alias="a_objSubnet") - __properties = ["a_objSubnet"] + Response for GET /1/object/apikey/{pkiApikeyID}/getSubnets + """ # noqa: E501 + a_obj_subnet: List[SubnetResponseCompound] = Field(alias="a_objSubnet") + __properties: ClassVar[List[str]] = ["a_objSubnet"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> ApikeyGetSubnetsV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of ApikeyGetSubnetsV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_subnet (list) _items = [] if self.a_obj_subnet: @@ -64,16 +82,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> ApikeyGetSubnetsV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of ApikeyGetSubnetsV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return ApikeyGetSubnetsV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = ApikeyGetSubnetsV1ResponseMPayload.parse_obj({ - "a_obj_subnet": [SubnetResponseCompound.from_dict(_item) for _item in obj.get("a_objSubnet")] if obj.get("a_objSubnet") is not None else None + _obj = cls.model_validate({ + "a_objSubnet": [SubnetResponseCompound.from_dict(_item) for _item in obj.get("a_objSubnet")] if obj.get("a_objSubnet") is not None else None }) return _obj diff --git a/eZmaxApi/models/apikey_list_element.py b/eZmaxApi/models/apikey_list_element.py index bad2b1cda..097acd99a 100644 --- a/eZmaxApi/models/apikey_list_element.py +++ b/eZmaxApi/models/apikey_list_element.py @@ -19,63 +19,82 @@ import json - -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictBool, StrictStr +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class ApikeyListElement(BaseModel): """ - A Branding List Element # noqa: E501 - """ - pki_apikey_id: conint(strict=True, ge=0) = Field(..., alias="pkiApikeyID", description="The unique ID of the Apikey") - s_apikey_description_x: StrictStr = Field(..., alias="sApikeyDescriptionX", description="The description of the Apikey in the language of the requester") - s_user_firstname: StrictStr = Field(..., alias="sUserFirstname", description="The first name of the user") - s_user_lastname: StrictStr = Field(..., alias="sUserLastname", description="The last name of the user") - b_apikey_isactive: StrictBool = Field(..., alias="bApikeyIsactive", description="Whether the apikey is active or not") - b_apikey_issigned: StrictBool = Field(..., alias="bApikeyIssigned", description="Whether the apikey is signed or not") - __properties = ["pkiApikeyID", "sApikeyDescriptionX", "sUserFirstname", "sUserLastname", "bApikeyIsactive", "bApikeyIssigned"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + A Branding List Element + """ # noqa: E501 + pki_apikey_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Apikey", alias="pkiApikeyID") + s_apikey_description_x: StrictStr = Field(description="The description of the Apikey in the language of the requester", alias="sApikeyDescriptionX") + s_user_firstname: StrictStr = Field(description="The first name of the user", alias="sUserFirstname") + s_user_lastname: StrictStr = Field(description="The last name of the user", alias="sUserLastname") + b_apikey_isactive: StrictBool = Field(description="Whether the apikey is active or not", alias="bApikeyIsactive") + b_apikey_issigned: StrictBool = Field(description="Whether the apikey is signed or not", alias="bApikeyIssigned") + __properties: ClassVar[List[str]] = ["pkiApikeyID", "sApikeyDescriptionX", "sUserFirstname", "sUserLastname", "bApikeyIsactive", "bApikeyIssigned"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> ApikeyListElement: + def from_json(cls, json_str: str) -> Self: """Create an instance of ApikeyListElement from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> ApikeyListElement: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of ApikeyListElement from a dict""" if obj is None: return None if not isinstance(obj, dict): - return ApikeyListElement.parse_obj(obj) - - _obj = ApikeyListElement.parse_obj({ - "pki_apikey_id": obj.get("pkiApikeyID"), - "s_apikey_description_x": obj.get("sApikeyDescriptionX"), - "s_user_firstname": obj.get("sUserFirstname"), - "s_user_lastname": obj.get("sUserLastname"), - "b_apikey_isactive": obj.get("bApikeyIsactive"), - "b_apikey_issigned": obj.get("bApikeyIssigned") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiApikeyID": obj.get("pkiApikeyID"), + "sApikeyDescriptionX": obj.get("sApikeyDescriptionX"), + "sUserFirstname": obj.get("sUserFirstname"), + "sUserLastname": obj.get("sUserLastname"), + "bApikeyIsactive": obj.get("bApikeyIsactive"), + "bApikeyIssigned": obj.get("bApikeyIssigned") }) return _obj diff --git a/eZmaxApi/models/apikey_regenerate_v1_request.py b/eZmaxApi/models/apikey_regenerate_v1_request.py index 61797264d..cf16c0c9b 100644 --- a/eZmaxApi/models/apikey_regenerate_v1_request.py +++ b/eZmaxApi/models/apikey_regenerate_v1_request.py @@ -19,53 +19,71 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictBool +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool +from pydantic import Field +try: + from typing import Self +except ImportError: + from typing_extensions import Self class ApikeyRegenerateV1Request(BaseModel): """ - Request for POST /1/object/apikey/{pkiApikeyID}/regenerate # noqa: E501 - """ - b_apikey_issigned: Optional[StrictBool] = Field(None, alias="bApikeyIssigned", description="Whether the apikey is signed or not") - __properties = ["bApikeyIssigned"] + Request for POST /1/object/apikey/{pkiApikeyID}/regenerate + """ # noqa: E501 + b_apikey_issigned: Optional[StrictBool] = Field(default=None, description="Whether the apikey is signed or not", alias="bApikeyIssigned") + __properties: ClassVar[List[str]] = ["bApikeyIssigned"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> ApikeyRegenerateV1Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of ApikeyRegenerateV1Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> ApikeyRegenerateV1Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of ApikeyRegenerateV1Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return ApikeyRegenerateV1Request.parse_obj(obj) + return cls.model_validate(obj) - _obj = ApikeyRegenerateV1Request.parse_obj({ - "b_apikey_issigned": obj.get("bApikeyIssigned") + _obj = cls.model_validate({ + "bApikeyIssigned": obj.get("bApikeyIssigned") }) return _obj diff --git a/eZmaxApi/models/apikey_regenerate_v1_response.py b/eZmaxApi/models/apikey_regenerate_v1_response.py index f4b6819cb..f0d070d6a 100644 --- a/eZmaxApi/models/apikey_regenerate_v1_response.py +++ b/eZmaxApi/models/apikey_regenerate_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.apikey_regenerate_v1_response_m_payload import ApikeyRegenerateV1ResponseMPayload from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class ApikeyRegenerateV1Response(BaseModel): """ - Response for GET /1/object/apikey/{pkiApikeyID}/regenerate # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: ApikeyRegenerateV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /1/object/apikey/{pkiApikeyID}/regenerate + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: ApikeyRegenerateV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> ApikeyRegenerateV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of ApikeyRegenerateV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> ApikeyRegenerateV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of ApikeyRegenerateV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return ApikeyRegenerateV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = ApikeyRegenerateV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": ApikeyRegenerateV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": ApikeyRegenerateV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/apikey_regenerate_v1_response_m_payload.py b/eZmaxApi/models/apikey_regenerate_v1_response_m_payload.py index d05a4d34f..0745756e2 100644 --- a/eZmaxApi/models/apikey_regenerate_v1_response_m_payload.py +++ b/eZmaxApi/models/apikey_regenerate_v1_response_m_payload.py @@ -19,57 +19,75 @@ import json - -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.apikey_response_compound import ApikeyResponseCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class ApikeyRegenerateV1ResponseMPayload(BaseModel): """ - Response for GET /1/object/apikey/{pkiApikeyID}/regenerate # noqa: E501 - """ - obj_apikey: ApikeyResponseCompound = Field(..., alias="objApikey") - __properties = ["objApikey"] + Response for GET /1/object/apikey/{pkiApikeyID}/regenerate + """ # noqa: E501 + obj_apikey: ApikeyResponseCompound = Field(alias="objApikey") + __properties: ClassVar[List[str]] = ["objApikey"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> ApikeyRegenerateV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of ApikeyRegenerateV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_apikey if self.obj_apikey: _dict['objApikey'] = self.obj_apikey.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> ApikeyRegenerateV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of ApikeyRegenerateV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return ApikeyRegenerateV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = ApikeyRegenerateV1ResponseMPayload.parse_obj({ - "obj_apikey": ApikeyResponseCompound.from_dict(obj.get("objApikey")) if obj.get("objApikey") is not None else None + _obj = cls.model_validate({ + "objApikey": ApikeyResponseCompound.from_dict(obj.get("objApikey")) if obj.get("objApikey") is not None else None }) return _obj diff --git a/eZmaxApi/models/apikey_request.py b/eZmaxApi/models/apikey_request.py index b60a673dc..4ad072499 100644 --- a/eZmaxApi/models/apikey_request.py +++ b/eZmaxApi/models/apikey_request.py @@ -19,65 +19,84 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictBool, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.multilingual_apikey_description import MultilingualApikeyDescription +try: + from typing import Self +except ImportError: + from typing_extensions import Self class ApikeyRequest(BaseModel): """ - An Apikey Object # noqa: E501 - """ - pki_apikey_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="pkiApikeyID", description="The unique ID of the Apikey") - fki_user_id: conint(strict=True, ge=0) = Field(..., alias="fkiUserID", description="The unique ID of the User") - obj_apikey_description: MultilingualApikeyDescription = Field(..., alias="objApikeyDescription") - b_apikey_isactive: Optional[StrictBool] = Field(None, alias="bApikeyIsactive", description="Whether the apikey is active or not") - b_apikey_issigned: Optional[StrictBool] = Field(None, alias="bApikeyIssigned", description="Whether the apikey is signed or not") - __properties = ["pkiApikeyID", "fkiUserID", "objApikeyDescription", "bApikeyIsactive", "bApikeyIssigned"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + An Apikey Object + """ # noqa: E501 + pki_apikey_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Apikey", alias="pkiApikeyID") + fki_user_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the User", alias="fkiUserID") + obj_apikey_description: MultilingualApikeyDescription = Field(alias="objApikeyDescription") + b_apikey_isactive: Optional[StrictBool] = Field(default=None, description="Whether the apikey is active or not", alias="bApikeyIsactive") + b_apikey_issigned: Optional[StrictBool] = Field(default=None, description="Whether the apikey is signed or not", alias="bApikeyIssigned") + __properties: ClassVar[List[str]] = ["pkiApikeyID", "fkiUserID", "objApikeyDescription", "bApikeyIsactive", "bApikeyIssigned"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> ApikeyRequest: + def from_json(cls, json_str: str) -> Self: """Create an instance of ApikeyRequest from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_apikey_description if self.obj_apikey_description: _dict['objApikeyDescription'] = self.obj_apikey_description.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> ApikeyRequest: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of ApikeyRequest from a dict""" if obj is None: return None if not isinstance(obj, dict): - return ApikeyRequest.parse_obj(obj) - - _obj = ApikeyRequest.parse_obj({ - "pki_apikey_id": obj.get("pkiApikeyID"), - "fki_user_id": obj.get("fkiUserID"), - "obj_apikey_description": MultilingualApikeyDescription.from_dict(obj.get("objApikeyDescription")) if obj.get("objApikeyDescription") is not None else None, - "b_apikey_isactive": obj.get("bApikeyIsactive"), - "b_apikey_issigned": obj.get("bApikeyIssigned") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiApikeyID": obj.get("pkiApikeyID"), + "fkiUserID": obj.get("fkiUserID"), + "objApikeyDescription": MultilingualApikeyDescription.from_dict(obj.get("objApikeyDescription")) if obj.get("objApikeyDescription") is not None else None, + "bApikeyIsactive": obj.get("bApikeyIsactive"), + "bApikeyIssigned": obj.get("bApikeyIssigned") }) return _obj diff --git a/eZmaxApi/models/apikey_request_compound.py b/eZmaxApi/models/apikey_request_compound.py index d553eef5a..eeee80897 100644 --- a/eZmaxApi/models/apikey_request_compound.py +++ b/eZmaxApi/models/apikey_request_compound.py @@ -19,65 +19,84 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictBool, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.multilingual_apikey_description import MultilingualApikeyDescription +try: + from typing import Self +except ImportError: + from typing_extensions import Self class ApikeyRequestCompound(BaseModel): """ - An Apikey Object and children to create a complete structure # noqa: E501 - """ - pki_apikey_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="pkiApikeyID", description="The unique ID of the Apikey") - fki_user_id: conint(strict=True, ge=0) = Field(..., alias="fkiUserID", description="The unique ID of the User") - obj_apikey_description: MultilingualApikeyDescription = Field(..., alias="objApikeyDescription") - b_apikey_isactive: Optional[StrictBool] = Field(None, alias="bApikeyIsactive", description="Whether the apikey is active or not") - b_apikey_issigned: Optional[StrictBool] = Field(None, alias="bApikeyIssigned", description="Whether the apikey is signed or not") - __properties = ["pkiApikeyID", "fkiUserID", "objApikeyDescription", "bApikeyIsactive", "bApikeyIssigned"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + An Apikey Object and children to create a complete structure + """ # noqa: E501 + pki_apikey_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Apikey", alias="pkiApikeyID") + fki_user_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the User", alias="fkiUserID") + obj_apikey_description: MultilingualApikeyDescription = Field(alias="objApikeyDescription") + b_apikey_isactive: Optional[StrictBool] = Field(default=None, description="Whether the apikey is active or not", alias="bApikeyIsactive") + b_apikey_issigned: Optional[StrictBool] = Field(default=None, description="Whether the apikey is signed or not", alias="bApikeyIssigned") + __properties: ClassVar[List[str]] = ["pkiApikeyID", "fkiUserID", "objApikeyDescription", "bApikeyIsactive", "bApikeyIssigned"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> ApikeyRequestCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of ApikeyRequestCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_apikey_description if self.obj_apikey_description: _dict['objApikeyDescription'] = self.obj_apikey_description.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> ApikeyRequestCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of ApikeyRequestCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return ApikeyRequestCompound.parse_obj(obj) - - _obj = ApikeyRequestCompound.parse_obj({ - "pki_apikey_id": obj.get("pkiApikeyID"), - "fki_user_id": obj.get("fkiUserID"), - "obj_apikey_description": MultilingualApikeyDescription.from_dict(obj.get("objApikeyDescription")) if obj.get("objApikeyDescription") is not None else None, - "b_apikey_isactive": obj.get("bApikeyIsactive"), - "b_apikey_issigned": obj.get("bApikeyIssigned") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiApikeyID": obj.get("pkiApikeyID"), + "fkiUserID": obj.get("fkiUserID"), + "objApikeyDescription": MultilingualApikeyDescription.from_dict(obj.get("objApikeyDescription")) if obj.get("objApikeyDescription") is not None else None, + "bApikeyIsactive": obj.get("bApikeyIsactive"), + "bApikeyIssigned": obj.get("bApikeyIssigned") }) return _obj diff --git a/eZmaxApi/models/apikey_response.py b/eZmaxApi/models/apikey_response.py index d2e980506..8a1b8edca 100644 --- a/eZmaxApi/models/apikey_response.py +++ b/eZmaxApi/models/apikey_response.py @@ -19,51 +19,70 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, StrictStr +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.common_audit import CommonAudit from eZmaxApi.models.custom_contact_name_response import CustomContactNameResponse from eZmaxApi.models.multilingual_apikey_description import MultilingualApikeyDescription +try: + from typing import Self +except ImportError: + from typing_extensions import Self class ApikeyResponse(BaseModel): """ - An Apikey Object # noqa: E501 - """ - pki_apikey_id: conint(strict=True, ge=0) = Field(..., alias="pkiApikeyID", description="The unique ID of the Apikey") - fki_user_id: conint(strict=True, ge=0) = Field(..., alias="fkiUserID", description="The unique ID of the User") - obj_apikey_description: MultilingualApikeyDescription = Field(..., alias="objApikeyDescription") - obj_contact_name: CustomContactNameResponse = Field(..., alias="objContactName") - s_apikey_apikey: Optional[StrictStr] = Field(None, alias="sApikeyApikey", description="The Apikey for the API key. This will be hidden if we are not creating or regenerating the Apikey.") - s_apikey_secret: Optional[StrictStr] = Field(None, alias="sApikeySecret", description="The Secret for the API key. This will be hidden if we are not creating or regenerating the Apikey.") - b_apikey_isactive: StrictBool = Field(..., alias="bApikeyIsactive", description="Whether the apikey is active or not") - b_apikey_issigned: Optional[StrictBool] = Field(None, alias="bApikeyIssigned", description="Whether the apikey is signed or not") - obj_audit: CommonAudit = Field(..., alias="objAudit") - __properties = ["pkiApikeyID", "fkiUserID", "objApikeyDescription", "objContactName", "sApikeyApikey", "sApikeySecret", "bApikeyIsactive", "bApikeyIssigned", "objAudit"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + An Apikey Object + """ # noqa: E501 + pki_apikey_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Apikey", alias="pkiApikeyID") + fki_user_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the User", alias="fkiUserID") + obj_apikey_description: MultilingualApikeyDescription = Field(alias="objApikeyDescription") + obj_contact_name: CustomContactNameResponse = Field(alias="objContactName") + s_apikey_apikey: Optional[StrictStr] = Field(default=None, description="The Apikey for the API key. This will be hidden if we are not creating or regenerating the Apikey.", alias="sApikeyApikey") + s_apikey_secret: Optional[StrictStr] = Field(default=None, description="The Secret for the API key. This will be hidden if we are not creating or regenerating the Apikey.", alias="sApikeySecret") + b_apikey_isactive: StrictBool = Field(description="Whether the apikey is active or not", alias="bApikeyIsactive") + b_apikey_issigned: Optional[StrictBool] = Field(default=None, description="Whether the apikey is signed or not", alias="bApikeyIssigned") + obj_audit: CommonAudit = Field(alias="objAudit") + __properties: ClassVar[List[str]] = ["pkiApikeyID", "fkiUserID", "objApikeyDescription", "objContactName", "sApikeyApikey", "sApikeySecret", "bApikeyIsactive", "bApikeyIssigned", "objAudit"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> ApikeyResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of ApikeyResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_apikey_description if self.obj_apikey_description: _dict['objApikeyDescription'] = self.obj_apikey_description.to_dict() @@ -76,24 +95,24 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> ApikeyResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of ApikeyResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return ApikeyResponse.parse_obj(obj) - - _obj = ApikeyResponse.parse_obj({ - "pki_apikey_id": obj.get("pkiApikeyID"), - "fki_user_id": obj.get("fkiUserID"), - "obj_apikey_description": MultilingualApikeyDescription.from_dict(obj.get("objApikeyDescription")) if obj.get("objApikeyDescription") is not None else None, - "obj_contact_name": CustomContactNameResponse.from_dict(obj.get("objContactName")) if obj.get("objContactName") is not None else None, - "s_apikey_apikey": obj.get("sApikeyApikey"), - "s_apikey_secret": obj.get("sApikeySecret"), - "b_apikey_isactive": obj.get("bApikeyIsactive"), - "b_apikey_issigned": obj.get("bApikeyIssigned"), - "obj_audit": CommonAudit.from_dict(obj.get("objAudit")) if obj.get("objAudit") is not None else None + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiApikeyID": obj.get("pkiApikeyID"), + "fkiUserID": obj.get("fkiUserID"), + "objApikeyDescription": MultilingualApikeyDescription.from_dict(obj.get("objApikeyDescription")) if obj.get("objApikeyDescription") is not None else None, + "objContactName": CustomContactNameResponse.from_dict(obj.get("objContactName")) if obj.get("objContactName") is not None else None, + "sApikeyApikey": obj.get("sApikeyApikey"), + "sApikeySecret": obj.get("sApikeySecret"), + "bApikeyIsactive": obj.get("bApikeyIsactive"), + "bApikeyIssigned": obj.get("bApikeyIssigned"), + "objAudit": CommonAudit.from_dict(obj.get("objAudit")) if obj.get("objAudit") is not None else None }) return _obj diff --git a/eZmaxApi/models/apikey_response_compound.py b/eZmaxApi/models/apikey_response_compound.py index 2536ae223..df3456114 100644 --- a/eZmaxApi/models/apikey_response_compound.py +++ b/eZmaxApi/models/apikey_response_compound.py @@ -19,51 +19,70 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, StrictStr +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.common_audit import CommonAudit from eZmaxApi.models.custom_contact_name_response import CustomContactNameResponse from eZmaxApi.models.multilingual_apikey_description import MultilingualApikeyDescription +try: + from typing import Self +except ImportError: + from typing_extensions import Self class ApikeyResponseCompound(BaseModel): """ - An Apikey Object and children to create a complete structure # noqa: E501 - """ - pki_apikey_id: conint(strict=True, ge=0) = Field(..., alias="pkiApikeyID", description="The unique ID of the Apikey") - fki_user_id: conint(strict=True, ge=0) = Field(..., alias="fkiUserID", description="The unique ID of the User") - obj_apikey_description: MultilingualApikeyDescription = Field(..., alias="objApikeyDescription") - obj_contact_name: CustomContactNameResponse = Field(..., alias="objContactName") - s_apikey_apikey: Optional[StrictStr] = Field(None, alias="sApikeyApikey", description="The Apikey for the API key. This will be hidden if we are not creating or regenerating the Apikey.") - s_apikey_secret: Optional[StrictStr] = Field(None, alias="sApikeySecret", description="The Secret for the API key. This will be hidden if we are not creating or regenerating the Apikey.") - b_apikey_isactive: StrictBool = Field(..., alias="bApikeyIsactive", description="Whether the apikey is active or not") - b_apikey_issigned: Optional[StrictBool] = Field(None, alias="bApikeyIssigned", description="Whether the apikey is signed or not") - obj_audit: CommonAudit = Field(..., alias="objAudit") - __properties = ["pkiApikeyID", "fkiUserID", "objApikeyDescription", "objContactName", "sApikeyApikey", "sApikeySecret", "bApikeyIsactive", "bApikeyIssigned", "objAudit"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + An Apikey Object and children to create a complete structure + """ # noqa: E501 + pki_apikey_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Apikey", alias="pkiApikeyID") + fki_user_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the User", alias="fkiUserID") + obj_apikey_description: MultilingualApikeyDescription = Field(alias="objApikeyDescription") + obj_contact_name: CustomContactNameResponse = Field(alias="objContactName") + s_apikey_apikey: Optional[StrictStr] = Field(default=None, description="The Apikey for the API key. This will be hidden if we are not creating or regenerating the Apikey.", alias="sApikeyApikey") + s_apikey_secret: Optional[StrictStr] = Field(default=None, description="The Secret for the API key. This will be hidden if we are not creating or regenerating the Apikey.", alias="sApikeySecret") + b_apikey_isactive: StrictBool = Field(description="Whether the apikey is active or not", alias="bApikeyIsactive") + b_apikey_issigned: Optional[StrictBool] = Field(default=None, description="Whether the apikey is signed or not", alias="bApikeyIssigned") + obj_audit: CommonAudit = Field(alias="objAudit") + __properties: ClassVar[List[str]] = ["pkiApikeyID", "fkiUserID", "objApikeyDescription", "objContactName", "sApikeyApikey", "sApikeySecret", "bApikeyIsactive", "bApikeyIssigned", "objAudit"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> ApikeyResponseCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of ApikeyResponseCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_apikey_description if self.obj_apikey_description: _dict['objApikeyDescription'] = self.obj_apikey_description.to_dict() @@ -76,24 +95,24 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> ApikeyResponseCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of ApikeyResponseCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return ApikeyResponseCompound.parse_obj(obj) - - _obj = ApikeyResponseCompound.parse_obj({ - "pki_apikey_id": obj.get("pkiApikeyID"), - "fki_user_id": obj.get("fkiUserID"), - "obj_apikey_description": MultilingualApikeyDescription.from_dict(obj.get("objApikeyDescription")) if obj.get("objApikeyDescription") is not None else None, - "obj_contact_name": CustomContactNameResponse.from_dict(obj.get("objContactName")) if obj.get("objContactName") is not None else None, - "s_apikey_apikey": obj.get("sApikeyApikey"), - "s_apikey_secret": obj.get("sApikeySecret"), - "b_apikey_isactive": obj.get("bApikeyIsactive"), - "b_apikey_issigned": obj.get("bApikeyIssigned"), - "obj_audit": CommonAudit.from_dict(obj.get("objAudit")) if obj.get("objAudit") is not None else None + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiApikeyID": obj.get("pkiApikeyID"), + "fkiUserID": obj.get("fkiUserID"), + "objApikeyDescription": MultilingualApikeyDescription.from_dict(obj.get("objApikeyDescription")) if obj.get("objApikeyDescription") is not None else None, + "objContactName": CustomContactNameResponse.from_dict(obj.get("objContactName")) if obj.get("objContactName") is not None else None, + "sApikeyApikey": obj.get("sApikeyApikey"), + "sApikeySecret": obj.get("sApikeySecret"), + "bApikeyIsactive": obj.get("bApikeyIsactive"), + "bApikeyIssigned": obj.get("bApikeyIssigned"), + "objAudit": CommonAudit.from_dict(obj.get("objAudit")) if obj.get("objAudit") is not None else None }) return _obj diff --git a/eZmaxApi/models/attachment_download_v1_response.py b/eZmaxApi/models/attachment_download_v1_response.py deleted file mode 100644 index e9a5257c0..000000000 --- a/eZmaxApi/models/attachment_download_v1_response.py +++ /dev/null @@ -1,82 +0,0 @@ -# coding: utf-8 - -""" - eZmax API Definition (Full) - - This API expose all the functionnalities for the eZmax and eZsign applications. - - The version of the OpenAPI document: 1.2.0 - Contact: support-api@ezmax.ca - Generated by OpenAPI Generator (https://openapi-generator.tech) - - Do not edit the class manually. -""" # noqa: E501 - - -from __future__ import annotations -import pprint -import re # noqa: F401 -import json - - -from typing import Optional -from pydantic import BaseModel, Field -from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug -from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload - -class AttachmentDownloadV1Response(BaseModel): - """ - Response for POST /1/object/ezsignfolder/{pkiEzsignfolderID}/send # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - __properties = ["objDebugPayload", "objDebug"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True - - def to_str(self) -> str: - """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) - - def to_json(self) -> str: - """Returns the JSON representation of the model using alias""" - return json.dumps(self.to_dict()) - - @classmethod - def from_json(cls, json_str: str) -> AttachmentDownloadV1Response: - """Create an instance of AttachmentDownloadV1Response from a JSON string""" - return cls.from_dict(json.loads(json_str)) - - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) - # override the default output from pydantic by calling `to_dict()` of obj_debug_payload - if self.obj_debug_payload: - _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() - # override the default output from pydantic by calling `to_dict()` of obj_debug - if self.obj_debug: - _dict['objDebug'] = self.obj_debug.to_dict() - return _dict - - @classmethod - def from_dict(cls, obj: dict) -> AttachmentDownloadV1Response: - """Create an instance of AttachmentDownloadV1Response from a dict""" - if obj is None: - return None - - if not isinstance(obj, dict): - return AttachmentDownloadV1Response.parse_obj(obj) - - _obj = AttachmentDownloadV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None - }) - return _obj - - diff --git a/eZmaxApi/models/attachment_get_attachmentlogs_v1_response.py b/eZmaxApi/models/attachment_get_attachmentlogs_v1_response.py new file mode 100644 index 000000000..964a4d562 --- /dev/null +++ b/eZmaxApi/models/attachment_get_attachmentlogs_v1_response.py @@ -0,0 +1,106 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field +from eZmaxApi.models.attachment_get_attachmentlogs_v1_response_m_payload import AttachmentGetAttachmentlogsV1ResponseMPayload +from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug +from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self + +class AttachmentGetAttachmentlogsV1Response(BaseModel): + """ + Response for GET /1/object/attachment/{pkiAttachmentID}/getAttachmentlogs + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: AttachmentGetAttachmentlogsV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of AttachmentGetAttachmentlogsV1Response from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of obj_debug_payload + if self.obj_debug_payload: + _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() + # override the default output from pydantic by calling `to_dict()` of obj_debug + if self.obj_debug: + _dict['objDebug'] = self.obj_debug.to_dict() + # override the default output from pydantic by calling `to_dict()` of m_payload + if self.m_payload: + _dict['mPayload'] = self.m_payload.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Dict) -> Self: + """Create an instance of AttachmentGetAttachmentlogsV1Response from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": AttachmentGetAttachmentlogsV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + }) + return _obj + + diff --git a/eZmaxApi/models/attachment_get_attachmentlogs_v1_response_m_payload.py b/eZmaxApi/models/attachment_get_attachmentlogs_v1_response_m_payload.py new file mode 100644 index 000000000..d8a8b9819 --- /dev/null +++ b/eZmaxApi/models/attachment_get_attachmentlogs_v1_response_m_payload.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from eZmaxApi.models.attachmentlog_response_compound import AttachmentlogResponseCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self + +class AttachmentGetAttachmentlogsV1ResponseMPayload(BaseModel): + """ + Response for GET /1/object/attachment/{pkiAttachmentID}/getAttachmentlogs + """ # noqa: E501 + a_obj_attachmentlog: List[AttachmentlogResponseCompound] = Field(alias="a_objAttachmentlog") + __properties: ClassVar[List[str]] = ["a_objAttachmentlog"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of AttachmentGetAttachmentlogsV1ResponseMPayload from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in a_obj_attachmentlog (list) + _items = [] + if self.a_obj_attachmentlog: + for _item in self.a_obj_attachmentlog: + if _item: + _items.append(_item.to_dict()) + _dict['a_objAttachmentlog'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Dict) -> Self: + """Create an instance of AttachmentGetAttachmentlogsV1ResponseMPayload from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "a_objAttachmentlog": [AttachmentlogResponseCompound.from_dict(_item) for _item in obj.get("a_objAttachmentlog")] if obj.get("a_objAttachmentlog") is not None else None + }) + return _obj + + diff --git a/eZmaxApi/models/attachment_get_download_url_v1_response.py b/eZmaxApi/models/attachment_get_download_url_v1_response.py new file mode 100644 index 000000000..a91801e4a --- /dev/null +++ b/eZmaxApi/models/attachment_get_download_url_v1_response.py @@ -0,0 +1,106 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field +from eZmaxApi.models.attachment_get_download_url_v1_response_m_payload import AttachmentGetDownloadUrlV1ResponseMPayload +from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug +from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self + +class AttachmentGetDownloadUrlV1Response(BaseModel): + """ + Response for GET /1/object/attachment/{pkiAttachmentID}/getDownloadUrl + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: AttachmentGetDownloadUrlV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of AttachmentGetDownloadUrlV1Response from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of obj_debug_payload + if self.obj_debug_payload: + _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() + # override the default output from pydantic by calling `to_dict()` of obj_debug + if self.obj_debug: + _dict['objDebug'] = self.obj_debug.to_dict() + # override the default output from pydantic by calling `to_dict()` of m_payload + if self.m_payload: + _dict['mPayload'] = self.m_payload.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Dict) -> Self: + """Create an instance of AttachmentGetDownloadUrlV1Response from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": AttachmentGetDownloadUrlV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + }) + return _obj + + diff --git a/eZmaxApi/models/attachment_get_download_url_v1_response_m_payload.py b/eZmaxApi/models/attachment_get_download_url_v1_response_m_payload.py new file mode 100644 index 000000000..b4abe4c0c --- /dev/null +++ b/eZmaxApi/models/attachment_get_download_url_v1_response_m_payload.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictStr +from pydantic import Field +try: + from typing import Self +except ImportError: + from typing_extensions import Self + +class AttachmentGetDownloadUrlV1ResponseMPayload(BaseModel): + """ + Payload for GET /1/object/attachment/{pkiAttachmentID}/getDownloadUrl + """ # noqa: E501 + s_download_url: StrictStr = Field(description="The Url to the requested attachment. Url will expire after 5 minutes.", alias="sDownloadUrl") + __properties: ClassVar[List[str]] = ["sDownloadUrl"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of AttachmentGetDownloadUrlV1ResponseMPayload from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Dict) -> Self: + """Create an instance of AttachmentGetDownloadUrlV1ResponseMPayload from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "sDownloadUrl": obj.get("sDownloadUrl") + }) + return _obj + + diff --git a/eZmaxApi/models/attachment_response.py b/eZmaxApi/models/attachment_response.py new file mode 100644 index 000000000..62a979a2c --- /dev/null +++ b/eZmaxApi/models/attachment_response.py @@ -0,0 +1,243 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, StrictInt, field_validator +from pydantic import Field +from typing_extensions import Annotated +from eZmaxApi.models.common_audit import CommonAudit +from eZmaxApi.models.field_e_attachment_documenttype import FieldEAttachmentDocumenttype +from eZmaxApi.models.field_e_attachment_privacy import FieldEAttachmentPrivacy +from eZmaxApi.models.field_e_attachment_type import FieldEAttachmentType +from eZmaxApi.models.field_e_attachment_verified import FieldEAttachmentVerified +try: + from typing import Self +except ImportError: + from typing_extensions import Self + +class AttachmentResponse(BaseModel): + """ + An Attachment Object + """ # noqa: E501 + pki_attachment_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Attachment.", alias="pkiAttachmentID") + fki_computer_id: Optional[Annotated[int, Field(le=65535, strict=True, ge=1)]] = Field(default=None, description="The unique ID of the Computer", alias="fkiComputerID") + fki_adjustment_id: Optional[Annotated[int, Field(le=65535, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Adjustment", alias="fkiAdjustmentID") + fki_agent_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Agent.", alias="fkiAgentID") + fki_bankaccount_id: Optional[Annotated[int, Field(le=255, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Bankaccount", alias="fkiBankaccountID") + fki_broker_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Broker.", alias="fkiBrokerID") + fki_commissionadvance_id: Optional[Annotated[int, Field(le=65535, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Commissionadvance", alias="fkiCommissionadvanceID") + fki_communication_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Communication.", alias="fkiCommunicationID") + fki_customer_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Customer.", alias="fkiCustomerID") + fki_customertemplate_id: Optional[Annotated[int, Field(le=65535, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Customertemplate", alias="fkiCustomertemplateID") + fki_deposit_id: Optional[Annotated[int, Field(le=16777215, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Deposit", alias="fkiDepositID") + fki_deposittransitcheque_id: Optional[Annotated[int, Field(le=65535, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Deposittransitcheque", alias="fkiDeposittransitchequeID") + fki_electronicfundstransfer_id: Optional[Annotated[int, Field(le=65535, strict=True, ge=1)]] = Field(default=None, description="The unique ID of the Electronicfundstransfer", alias="fkiElectronicfundstransferID") + fki_employee_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Employee.", alias="fkiEmployeeID") + fki_externalbroker_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Externalbroker.", alias="fkiExternalbrokerID") + fki_ezcomadvanceserver_id: Optional[Annotated[int, Field(le=16777215, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezcomadvanceserver", alias="fkiEzcomadvanceserverID") + fki_ezcomcompany_id: Optional[Annotated[int, Field(le=65535, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezcomcompany", alias="fkiEzcomcompanyID") + fki_ezsigndocument_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsigndocument", alias="fkiEzsigndocumentID") + fki_ghacqcontract_id: Optional[Annotated[int, Field(le=16777215, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ghacqcontract", alias="fkiGhacqcontractID") + fki_inscription_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Inscription.", alias="fkiInscriptionID") + fki_inscriptiontemp_id: Optional[Annotated[int, Field(le=16777215, strict=True, ge=1)]] = Field(default=None, description="The unique ID of the Inscriptiontemp", alias="fkiInscriptiontempID") + fki_inscriptionnotauthenticated_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Inscriptionnotauthenticated.", alias="fkiInscriptionnotauthenticatedID") + fki_invoice_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Invoice.", alias="fkiInvoiceID") + fki_buyercontract_id: Optional[Annotated[int, Field(le=65535, strict=True, ge=1)]] = Field(default=None, description="The unique ID of the Buyercontract", alias="fkiBuyercontractID") + fki_franchisebroker_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Franchisebroker", alias="fkiFranchisebrokerID") + fki_franchiseagence_id: Optional[Annotated[int, Field(le=65535, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Franchiseagence", alias="fkiFranchiseagenceID") + fki_franchiseoffice_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Franchisereoffice", alias="fkiFranchiseofficeID") + fki_franchisefranchise_id: Optional[Annotated[int, Field(le=65535, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Franchisefranchise", alias="fkiFranchisefranchiseID") + fki_franchisecomplaint_id: Optional[Annotated[int, Field(le=65535, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Franchisecomplaint", alias="fkiFranchisecomplaintID") + fki_lead_id: Optional[Annotated[int, Field(le=65535, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Lead", alias="fkiLeadID") + fki_marketingprogram_id: Optional[Annotated[int, Field(le=255, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Marketingprogram", alias="fkiMarketingprogramID") + fki_marketingfollow_id: Optional[Annotated[int, Field(le=65535, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Marketingfollow", alias="fkiMarketingfollowID") + fki_notary_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Notary.", alias="fkiNotaryID") + fki_officetaxreport_id: Optional[Annotated[int, Field(le=65535, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Officetaxreport", alias="fkiOfficetaxreportID") + fki_otherincome_id: Optional[Annotated[int, Field(le=65535, strict=True, ge=1)]] = Field(default=None, description="The unique ID of the Otherincome", alias="fkiOtherincomeID") + fki_paymentpreparation_id: Optional[Annotated[int, Field(le=16777215, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Paymentpreparation", alias="fkiPaymentpreparationID") + fki_purchase_id: Optional[StrictInt] = Field(default=None, description="The unique ID of the Purchase", alias="fkiPurchaseID") + fki_salary_id: Optional[Annotated[int, Field(le=16777215, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Salary", alias="fkiSalaryID") + fki_supplier_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Supplier.", alias="fkiSupplierID") + fki_tranqcontract_id: Optional[Annotated[int, Field(le=16777215, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Tranqcontract", alias="fkiTranqcontractID") + fki_template_id: Optional[Annotated[int, Field(le=65535, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Template", alias="fkiTemplateID") + fki_inscriptionchecklist_id: Optional[Annotated[int, Field(le=16777215, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Inscriptionchecklist", alias="fkiInscriptionchecklistID") + fki_folder_id: Optional[Annotated[int, Field(le=65535, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Folder", alias="fkiFolderID") + fki_rejectedoffertopurchase_id: Optional[Annotated[int, Field(le=65535, strict=True, ge=1)]] = Field(default=None, description="The unique ID of the Rejectedoffertopurchase", alias="fkiRejectedoffertopurchaseID") + fki_disclosure_id: Optional[Annotated[int, Field(le=65535, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Disclosure", alias="fkiDisclosureID") + fki_reconciliation_id: Optional[Annotated[int, Field(le=65535, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Reconciliation", alias="fkiReconciliationID") + fki_ezsigndocument_id_reference: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsigndocument", alias="fkiEzsigndocumentIDReference") + e_attachment_documenttype: FieldEAttachmentDocumenttype = Field(alias="eAttachmentDocumenttype") + s_attachment_name: Annotated[str, Field(strict=True)] = Field(description="The name of the Attachment", alias="sAttachmentName") + e_attachment_privacy: FieldEAttachmentPrivacy = Field(alias="eAttachmentPrivacy") + fki_user_id_specific: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the User", alias="fkiUserIDSpecific") + e_attachment_type: FieldEAttachmentType = Field(alias="eAttachmentType") + i_attachment_size: Annotated[int, Field(le=4294967295, strict=True, ge=0)] = Field(description="The size of the Attachment", alias="iAttachmentSize") + i_attachment_ed_mmoduleflag: Optional[Annotated[int, Field(le=255, strict=True, ge=0)]] = Field(default=None, description="The edmmoduleflag of the Attachment", alias="iAttachmentEDMmoduleflag") + s_attachment_md5: Annotated[str, Field(strict=True)] = Field(description="The md5 of the Attachment", alias="sAttachmentMD5") + b_attachment_deleted: StrictBool = Field(description="Whether if it's deleted", alias="bAttachmentDeleted") + b_attachment_valid: StrictBool = Field(description="Whether if it's valid", alias="bAttachmentValid") + e_attachment_verified: FieldEAttachmentVerified = Field(alias="eAttachmentVerified") + t_attachment_rejectioncomment: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="The rejectioncomment of the Attachment", alias="tAttachmentRejectioncomment") + fki_user_id_owner: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the User", alias="fkiUserIDOwner") + obj_audit: Optional[CommonAudit] = Field(default=None, alias="objAudit") + __properties: ClassVar[List[str]] = ["pkiAttachmentID", "fkiComputerID", "fkiAdjustmentID", "fkiAgentID", "fkiBankaccountID", "fkiBrokerID", "fkiCommissionadvanceID", "fkiCommunicationID", "fkiCustomerID", "fkiCustomertemplateID", "fkiDepositID", "fkiDeposittransitchequeID", "fkiElectronicfundstransferID", "fkiEmployeeID", "fkiExternalbrokerID", "fkiEzcomadvanceserverID", "fkiEzcomcompanyID", "fkiEzsigndocumentID", "fkiGhacqcontractID", "fkiInscriptionID", "fkiInscriptiontempID", "fkiInscriptionnotauthenticatedID", "fkiInvoiceID", "fkiBuyercontractID", "fkiFranchisebrokerID", "fkiFranchiseagenceID", "fkiFranchiseofficeID", "fkiFranchisefranchiseID", "fkiFranchisecomplaintID", "fkiLeadID", "fkiMarketingprogramID", "fkiMarketingfollowID", "fkiNotaryID", "fkiOfficetaxreportID", "fkiOtherincomeID", "fkiPaymentpreparationID", "fkiPurchaseID", "fkiSalaryID", "fkiSupplierID", "fkiTranqcontractID", "fkiTemplateID", "fkiInscriptionchecklistID", "fkiFolderID", "fkiRejectedoffertopurchaseID", "fkiDisclosureID", "fkiReconciliationID", "fkiEzsigndocumentIDReference", "eAttachmentDocumenttype", "sAttachmentName", "eAttachmentPrivacy", "fkiUserIDSpecific", "eAttachmentType", "iAttachmentSize", "iAttachmentEDMmoduleflag", "sAttachmentMD5", "bAttachmentDeleted", "bAttachmentValid", "eAttachmentVerified", "tAttachmentRejectioncomment", "fkiUserIDOwner", "objAudit"] + + @field_validator('s_attachment_name') + def s_attachment_name_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^.{0,75}$", value): + raise ValueError(r"must validate the regular expression /^.{0,75}$/") + return value + + @field_validator('s_attachment_md5') + def s_attachment_md5_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^.{0,32}$", value): + raise ValueError(r"must validate the regular expression /^.{0,32}$/") + return value + + @field_validator('t_attachment_rejectioncomment') + def t_attachment_rejectioncomment_validate_regular_expression(cls, value): + """Validates the regular expression""" + if value is None: + return value + + if not re.match(r"^.{0,65535}$", value): + raise ValueError(r"must validate the regular expression /^.{0,65535}$/") + return value + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of AttachmentResponse from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of obj_audit + if self.obj_audit: + _dict['objAudit'] = self.obj_audit.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Dict) -> Self: + """Create an instance of AttachmentResponse from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiAttachmentID": obj.get("pkiAttachmentID"), + "fkiComputerID": obj.get("fkiComputerID"), + "fkiAdjustmentID": obj.get("fkiAdjustmentID"), + "fkiAgentID": obj.get("fkiAgentID"), + "fkiBankaccountID": obj.get("fkiBankaccountID"), + "fkiBrokerID": obj.get("fkiBrokerID"), + "fkiCommissionadvanceID": obj.get("fkiCommissionadvanceID"), + "fkiCommunicationID": obj.get("fkiCommunicationID"), + "fkiCustomerID": obj.get("fkiCustomerID"), + "fkiCustomertemplateID": obj.get("fkiCustomertemplateID"), + "fkiDepositID": obj.get("fkiDepositID"), + "fkiDeposittransitchequeID": obj.get("fkiDeposittransitchequeID"), + "fkiElectronicfundstransferID": obj.get("fkiElectronicfundstransferID"), + "fkiEmployeeID": obj.get("fkiEmployeeID"), + "fkiExternalbrokerID": obj.get("fkiExternalbrokerID"), + "fkiEzcomadvanceserverID": obj.get("fkiEzcomadvanceserverID"), + "fkiEzcomcompanyID": obj.get("fkiEzcomcompanyID"), + "fkiEzsigndocumentID": obj.get("fkiEzsigndocumentID"), + "fkiGhacqcontractID": obj.get("fkiGhacqcontractID"), + "fkiInscriptionID": obj.get("fkiInscriptionID"), + "fkiInscriptiontempID": obj.get("fkiInscriptiontempID"), + "fkiInscriptionnotauthenticatedID": obj.get("fkiInscriptionnotauthenticatedID"), + "fkiInvoiceID": obj.get("fkiInvoiceID"), + "fkiBuyercontractID": obj.get("fkiBuyercontractID"), + "fkiFranchisebrokerID": obj.get("fkiFranchisebrokerID"), + "fkiFranchiseagenceID": obj.get("fkiFranchiseagenceID"), + "fkiFranchiseofficeID": obj.get("fkiFranchiseofficeID"), + "fkiFranchisefranchiseID": obj.get("fkiFranchisefranchiseID"), + "fkiFranchisecomplaintID": obj.get("fkiFranchisecomplaintID"), + "fkiLeadID": obj.get("fkiLeadID"), + "fkiMarketingprogramID": obj.get("fkiMarketingprogramID"), + "fkiMarketingfollowID": obj.get("fkiMarketingfollowID"), + "fkiNotaryID": obj.get("fkiNotaryID"), + "fkiOfficetaxreportID": obj.get("fkiOfficetaxreportID"), + "fkiOtherincomeID": obj.get("fkiOtherincomeID"), + "fkiPaymentpreparationID": obj.get("fkiPaymentpreparationID"), + "fkiPurchaseID": obj.get("fkiPurchaseID"), + "fkiSalaryID": obj.get("fkiSalaryID"), + "fkiSupplierID": obj.get("fkiSupplierID"), + "fkiTranqcontractID": obj.get("fkiTranqcontractID"), + "fkiTemplateID": obj.get("fkiTemplateID"), + "fkiInscriptionchecklistID": obj.get("fkiInscriptionchecklistID"), + "fkiFolderID": obj.get("fkiFolderID"), + "fkiRejectedoffertopurchaseID": obj.get("fkiRejectedoffertopurchaseID"), + "fkiDisclosureID": obj.get("fkiDisclosureID"), + "fkiReconciliationID": obj.get("fkiReconciliationID"), + "fkiEzsigndocumentIDReference": obj.get("fkiEzsigndocumentIDReference"), + "eAttachmentDocumenttype": obj.get("eAttachmentDocumenttype"), + "sAttachmentName": obj.get("sAttachmentName"), + "eAttachmentPrivacy": obj.get("eAttachmentPrivacy"), + "fkiUserIDSpecific": obj.get("fkiUserIDSpecific"), + "eAttachmentType": obj.get("eAttachmentType"), + "iAttachmentSize": obj.get("iAttachmentSize"), + "iAttachmentEDMmoduleflag": obj.get("iAttachmentEDMmoduleflag"), + "sAttachmentMD5": obj.get("sAttachmentMD5"), + "bAttachmentDeleted": obj.get("bAttachmentDeleted"), + "bAttachmentValid": obj.get("bAttachmentValid"), + "eAttachmentVerified": obj.get("eAttachmentVerified"), + "tAttachmentRejectioncomment": obj.get("tAttachmentRejectioncomment"), + "fkiUserIDOwner": obj.get("fkiUserIDOwner"), + "objAudit": CommonAudit.from_dict(obj.get("objAudit")) if obj.get("objAudit") is not None else None + }) + return _obj + + diff --git a/eZmaxApi/models/attachment_response_compound.py b/eZmaxApi/models/attachment_response_compound.py new file mode 100644 index 000000000..031ff5c4a --- /dev/null +++ b/eZmaxApi/models/attachment_response_compound.py @@ -0,0 +1,243 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, StrictInt, field_validator +from pydantic import Field +from typing_extensions import Annotated +from eZmaxApi.models.common_audit import CommonAudit +from eZmaxApi.models.field_e_attachment_documenttype import FieldEAttachmentDocumenttype +from eZmaxApi.models.field_e_attachment_privacy import FieldEAttachmentPrivacy +from eZmaxApi.models.field_e_attachment_type import FieldEAttachmentType +from eZmaxApi.models.field_e_attachment_verified import FieldEAttachmentVerified +try: + from typing import Self +except ImportError: + from typing_extensions import Self + +class AttachmentResponseCompound(BaseModel): + """ + A Attachment Object + """ # noqa: E501 + pki_attachment_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Attachment.", alias="pkiAttachmentID") + fki_computer_id: Optional[Annotated[int, Field(le=65535, strict=True, ge=1)]] = Field(default=None, description="The unique ID of the Computer", alias="fkiComputerID") + fki_adjustment_id: Optional[Annotated[int, Field(le=65535, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Adjustment", alias="fkiAdjustmentID") + fki_agent_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Agent.", alias="fkiAgentID") + fki_bankaccount_id: Optional[Annotated[int, Field(le=255, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Bankaccount", alias="fkiBankaccountID") + fki_broker_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Broker.", alias="fkiBrokerID") + fki_commissionadvance_id: Optional[Annotated[int, Field(le=65535, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Commissionadvance", alias="fkiCommissionadvanceID") + fki_communication_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Communication.", alias="fkiCommunicationID") + fki_customer_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Customer.", alias="fkiCustomerID") + fki_customertemplate_id: Optional[Annotated[int, Field(le=65535, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Customertemplate", alias="fkiCustomertemplateID") + fki_deposit_id: Optional[Annotated[int, Field(le=16777215, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Deposit", alias="fkiDepositID") + fki_deposittransitcheque_id: Optional[Annotated[int, Field(le=65535, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Deposittransitcheque", alias="fkiDeposittransitchequeID") + fki_electronicfundstransfer_id: Optional[Annotated[int, Field(le=65535, strict=True, ge=1)]] = Field(default=None, description="The unique ID of the Electronicfundstransfer", alias="fkiElectronicfundstransferID") + fki_employee_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Employee.", alias="fkiEmployeeID") + fki_externalbroker_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Externalbroker.", alias="fkiExternalbrokerID") + fki_ezcomadvanceserver_id: Optional[Annotated[int, Field(le=16777215, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezcomadvanceserver", alias="fkiEzcomadvanceserverID") + fki_ezcomcompany_id: Optional[Annotated[int, Field(le=65535, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezcomcompany", alias="fkiEzcomcompanyID") + fki_ezsigndocument_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsigndocument", alias="fkiEzsigndocumentID") + fki_ghacqcontract_id: Optional[Annotated[int, Field(le=16777215, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ghacqcontract", alias="fkiGhacqcontractID") + fki_inscription_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Inscription.", alias="fkiInscriptionID") + fki_inscriptiontemp_id: Optional[Annotated[int, Field(le=16777215, strict=True, ge=1)]] = Field(default=None, description="The unique ID of the Inscriptiontemp", alias="fkiInscriptiontempID") + fki_inscriptionnotauthenticated_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Inscriptionnotauthenticated.", alias="fkiInscriptionnotauthenticatedID") + fki_invoice_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Invoice.", alias="fkiInvoiceID") + fki_buyercontract_id: Optional[Annotated[int, Field(le=65535, strict=True, ge=1)]] = Field(default=None, description="The unique ID of the Buyercontract", alias="fkiBuyercontractID") + fki_franchisebroker_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Franchisebroker", alias="fkiFranchisebrokerID") + fki_franchiseagence_id: Optional[Annotated[int, Field(le=65535, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Franchiseagence", alias="fkiFranchiseagenceID") + fki_franchiseoffice_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Franchisereoffice", alias="fkiFranchiseofficeID") + fki_franchisefranchise_id: Optional[Annotated[int, Field(le=65535, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Franchisefranchise", alias="fkiFranchisefranchiseID") + fki_franchisecomplaint_id: Optional[Annotated[int, Field(le=65535, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Franchisecomplaint", alias="fkiFranchisecomplaintID") + fki_lead_id: Optional[Annotated[int, Field(le=65535, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Lead", alias="fkiLeadID") + fki_marketingprogram_id: Optional[Annotated[int, Field(le=255, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Marketingprogram", alias="fkiMarketingprogramID") + fki_marketingfollow_id: Optional[Annotated[int, Field(le=65535, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Marketingfollow", alias="fkiMarketingfollowID") + fki_notary_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Notary.", alias="fkiNotaryID") + fki_officetaxreport_id: Optional[Annotated[int, Field(le=65535, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Officetaxreport", alias="fkiOfficetaxreportID") + fki_otherincome_id: Optional[Annotated[int, Field(le=65535, strict=True, ge=1)]] = Field(default=None, description="The unique ID of the Otherincome", alias="fkiOtherincomeID") + fki_paymentpreparation_id: Optional[Annotated[int, Field(le=16777215, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Paymentpreparation", alias="fkiPaymentpreparationID") + fki_purchase_id: Optional[StrictInt] = Field(default=None, description="The unique ID of the Purchase", alias="fkiPurchaseID") + fki_salary_id: Optional[Annotated[int, Field(le=16777215, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Salary", alias="fkiSalaryID") + fki_supplier_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Supplier.", alias="fkiSupplierID") + fki_tranqcontract_id: Optional[Annotated[int, Field(le=16777215, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Tranqcontract", alias="fkiTranqcontractID") + fki_template_id: Optional[Annotated[int, Field(le=65535, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Template", alias="fkiTemplateID") + fki_inscriptionchecklist_id: Optional[Annotated[int, Field(le=16777215, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Inscriptionchecklist", alias="fkiInscriptionchecklistID") + fki_folder_id: Optional[Annotated[int, Field(le=65535, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Folder", alias="fkiFolderID") + fki_rejectedoffertopurchase_id: Optional[Annotated[int, Field(le=65535, strict=True, ge=1)]] = Field(default=None, description="The unique ID of the Rejectedoffertopurchase", alias="fkiRejectedoffertopurchaseID") + fki_disclosure_id: Optional[Annotated[int, Field(le=65535, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Disclosure", alias="fkiDisclosureID") + fki_reconciliation_id: Optional[Annotated[int, Field(le=65535, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Reconciliation", alias="fkiReconciliationID") + fki_ezsigndocument_id_reference: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsigndocument", alias="fkiEzsigndocumentIDReference") + e_attachment_documenttype: FieldEAttachmentDocumenttype = Field(alias="eAttachmentDocumenttype") + s_attachment_name: Annotated[str, Field(strict=True)] = Field(description="The name of the Attachment", alias="sAttachmentName") + e_attachment_privacy: FieldEAttachmentPrivacy = Field(alias="eAttachmentPrivacy") + fki_user_id_specific: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the User", alias="fkiUserIDSpecific") + e_attachment_type: FieldEAttachmentType = Field(alias="eAttachmentType") + i_attachment_size: Annotated[int, Field(le=4294967295, strict=True, ge=0)] = Field(description="The size of the Attachment", alias="iAttachmentSize") + i_attachment_ed_mmoduleflag: Optional[Annotated[int, Field(le=255, strict=True, ge=0)]] = Field(default=None, description="The edmmoduleflag of the Attachment", alias="iAttachmentEDMmoduleflag") + s_attachment_md5: Annotated[str, Field(strict=True)] = Field(description="The md5 of the Attachment", alias="sAttachmentMD5") + b_attachment_deleted: StrictBool = Field(description="Whether if it's deleted", alias="bAttachmentDeleted") + b_attachment_valid: StrictBool = Field(description="Whether if it's valid", alias="bAttachmentValid") + e_attachment_verified: FieldEAttachmentVerified = Field(alias="eAttachmentVerified") + t_attachment_rejectioncomment: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="The rejectioncomment of the Attachment", alias="tAttachmentRejectioncomment") + fki_user_id_owner: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the User", alias="fkiUserIDOwner") + obj_audit: Optional[CommonAudit] = Field(default=None, alias="objAudit") + __properties: ClassVar[List[str]] = ["pkiAttachmentID", "fkiComputerID", "fkiAdjustmentID", "fkiAgentID", "fkiBankaccountID", "fkiBrokerID", "fkiCommissionadvanceID", "fkiCommunicationID", "fkiCustomerID", "fkiCustomertemplateID", "fkiDepositID", "fkiDeposittransitchequeID", "fkiElectronicfundstransferID", "fkiEmployeeID", "fkiExternalbrokerID", "fkiEzcomadvanceserverID", "fkiEzcomcompanyID", "fkiEzsigndocumentID", "fkiGhacqcontractID", "fkiInscriptionID", "fkiInscriptiontempID", "fkiInscriptionnotauthenticatedID", "fkiInvoiceID", "fkiBuyercontractID", "fkiFranchisebrokerID", "fkiFranchiseagenceID", "fkiFranchiseofficeID", "fkiFranchisefranchiseID", "fkiFranchisecomplaintID", "fkiLeadID", "fkiMarketingprogramID", "fkiMarketingfollowID", "fkiNotaryID", "fkiOfficetaxreportID", "fkiOtherincomeID", "fkiPaymentpreparationID", "fkiPurchaseID", "fkiSalaryID", "fkiSupplierID", "fkiTranqcontractID", "fkiTemplateID", "fkiInscriptionchecklistID", "fkiFolderID", "fkiRejectedoffertopurchaseID", "fkiDisclosureID", "fkiReconciliationID", "fkiEzsigndocumentIDReference", "eAttachmentDocumenttype", "sAttachmentName", "eAttachmentPrivacy", "fkiUserIDSpecific", "eAttachmentType", "iAttachmentSize", "iAttachmentEDMmoduleflag", "sAttachmentMD5", "bAttachmentDeleted", "bAttachmentValid", "eAttachmentVerified", "tAttachmentRejectioncomment", "fkiUserIDOwner", "objAudit"] + + @field_validator('s_attachment_name') + def s_attachment_name_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^.{0,75}$", value): + raise ValueError(r"must validate the regular expression /^.{0,75}$/") + return value + + @field_validator('s_attachment_md5') + def s_attachment_md5_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^.{0,32}$", value): + raise ValueError(r"must validate the regular expression /^.{0,32}$/") + return value + + @field_validator('t_attachment_rejectioncomment') + def t_attachment_rejectioncomment_validate_regular_expression(cls, value): + """Validates the regular expression""" + if value is None: + return value + + if not re.match(r"^.{0,65535}$", value): + raise ValueError(r"must validate the regular expression /^.{0,65535}$/") + return value + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of AttachmentResponseCompound from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of obj_audit + if self.obj_audit: + _dict['objAudit'] = self.obj_audit.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Dict) -> Self: + """Create an instance of AttachmentResponseCompound from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiAttachmentID": obj.get("pkiAttachmentID"), + "fkiComputerID": obj.get("fkiComputerID"), + "fkiAdjustmentID": obj.get("fkiAdjustmentID"), + "fkiAgentID": obj.get("fkiAgentID"), + "fkiBankaccountID": obj.get("fkiBankaccountID"), + "fkiBrokerID": obj.get("fkiBrokerID"), + "fkiCommissionadvanceID": obj.get("fkiCommissionadvanceID"), + "fkiCommunicationID": obj.get("fkiCommunicationID"), + "fkiCustomerID": obj.get("fkiCustomerID"), + "fkiCustomertemplateID": obj.get("fkiCustomertemplateID"), + "fkiDepositID": obj.get("fkiDepositID"), + "fkiDeposittransitchequeID": obj.get("fkiDeposittransitchequeID"), + "fkiElectronicfundstransferID": obj.get("fkiElectronicfundstransferID"), + "fkiEmployeeID": obj.get("fkiEmployeeID"), + "fkiExternalbrokerID": obj.get("fkiExternalbrokerID"), + "fkiEzcomadvanceserverID": obj.get("fkiEzcomadvanceserverID"), + "fkiEzcomcompanyID": obj.get("fkiEzcomcompanyID"), + "fkiEzsigndocumentID": obj.get("fkiEzsigndocumentID"), + "fkiGhacqcontractID": obj.get("fkiGhacqcontractID"), + "fkiInscriptionID": obj.get("fkiInscriptionID"), + "fkiInscriptiontempID": obj.get("fkiInscriptiontempID"), + "fkiInscriptionnotauthenticatedID": obj.get("fkiInscriptionnotauthenticatedID"), + "fkiInvoiceID": obj.get("fkiInvoiceID"), + "fkiBuyercontractID": obj.get("fkiBuyercontractID"), + "fkiFranchisebrokerID": obj.get("fkiFranchisebrokerID"), + "fkiFranchiseagenceID": obj.get("fkiFranchiseagenceID"), + "fkiFranchiseofficeID": obj.get("fkiFranchiseofficeID"), + "fkiFranchisefranchiseID": obj.get("fkiFranchisefranchiseID"), + "fkiFranchisecomplaintID": obj.get("fkiFranchisecomplaintID"), + "fkiLeadID": obj.get("fkiLeadID"), + "fkiMarketingprogramID": obj.get("fkiMarketingprogramID"), + "fkiMarketingfollowID": obj.get("fkiMarketingfollowID"), + "fkiNotaryID": obj.get("fkiNotaryID"), + "fkiOfficetaxreportID": obj.get("fkiOfficetaxreportID"), + "fkiOtherincomeID": obj.get("fkiOtherincomeID"), + "fkiPaymentpreparationID": obj.get("fkiPaymentpreparationID"), + "fkiPurchaseID": obj.get("fkiPurchaseID"), + "fkiSalaryID": obj.get("fkiSalaryID"), + "fkiSupplierID": obj.get("fkiSupplierID"), + "fkiTranqcontractID": obj.get("fkiTranqcontractID"), + "fkiTemplateID": obj.get("fkiTemplateID"), + "fkiInscriptionchecklistID": obj.get("fkiInscriptionchecklistID"), + "fkiFolderID": obj.get("fkiFolderID"), + "fkiRejectedoffertopurchaseID": obj.get("fkiRejectedoffertopurchaseID"), + "fkiDisclosureID": obj.get("fkiDisclosureID"), + "fkiReconciliationID": obj.get("fkiReconciliationID"), + "fkiEzsigndocumentIDReference": obj.get("fkiEzsigndocumentIDReference"), + "eAttachmentDocumenttype": obj.get("eAttachmentDocumenttype"), + "sAttachmentName": obj.get("sAttachmentName"), + "eAttachmentPrivacy": obj.get("eAttachmentPrivacy"), + "fkiUserIDSpecific": obj.get("fkiUserIDSpecific"), + "eAttachmentType": obj.get("eAttachmentType"), + "iAttachmentSize": obj.get("iAttachmentSize"), + "iAttachmentEDMmoduleflag": obj.get("iAttachmentEDMmoduleflag"), + "sAttachmentMD5": obj.get("sAttachmentMD5"), + "bAttachmentDeleted": obj.get("bAttachmentDeleted"), + "bAttachmentValid": obj.get("bAttachmentValid"), + "eAttachmentVerified": obj.get("eAttachmentVerified"), + "tAttachmentRejectioncomment": obj.get("tAttachmentRejectioncomment"), + "fkiUserIDOwner": obj.get("fkiUserIDOwner"), + "objAudit": CommonAudit.from_dict(obj.get("objAudit")) if obj.get("objAudit") is not None else None + }) + return _obj + + diff --git a/eZmaxApi/models/attachmentlog_response.py b/eZmaxApi/models/attachmentlog_response.py new file mode 100644 index 000000000..ea3a942ea --- /dev/null +++ b/eZmaxApi/models/attachmentlog_response.py @@ -0,0 +1,117 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, field_validator +from pydantic import Field +from typing_extensions import Annotated +from eZmaxApi.models.field_e_attachmentlog_type import FieldEAttachmentlogType +try: + from typing import Self +except ImportError: + from typing_extensions import Self + +class AttachmentlogResponse(BaseModel): + """ + An Attachmentlog Object + """ # noqa: E501 + fki_attachment_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Attachment.", alias="fkiAttachmentID") + fki_user_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the User", alias="fkiUserID") + dt_attachmentlog_datetime: Annotated[str, Field(strict=True)] = Field(description="The created date", alias="dtAttachmentlogDatetime") + e_attachmentlog_type: FieldEAttachmentlogType = Field(alias="eAttachmentlogType") + s_attachmentlog_detail: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="The additionnal detail", alias="sAttachmentlogDetail") + __properties: ClassVar[List[str]] = ["fkiAttachmentID", "fkiUserID", "dtAttachmentlogDatetime", "eAttachmentlogType", "sAttachmentlogDetail"] + + @field_validator('dt_attachmentlog_datetime') + def dt_attachmentlog_datetime_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1]) ([01]?[0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9])$", value): + raise ValueError(r"must validate the regular expression /^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1]) ([01]?[0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9])$/") + return value + + @field_validator('s_attachmentlog_detail') + def s_attachmentlog_detail_validate_regular_expression(cls, value): + """Validates the regular expression""" + if value is None: + return value + + if not re.match(r"^.{0,75}$", value): + raise ValueError(r"must validate the regular expression /^.{0,75}$/") + return value + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of AttachmentlogResponse from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Dict) -> Self: + """Create an instance of AttachmentlogResponse from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "fkiAttachmentID": obj.get("fkiAttachmentID"), + "fkiUserID": obj.get("fkiUserID"), + "dtAttachmentlogDatetime": obj.get("dtAttachmentlogDatetime"), + "eAttachmentlogType": obj.get("eAttachmentlogType"), + "sAttachmentlogDetail": obj.get("sAttachmentlogDetail") + }) + return _obj + + diff --git a/eZmaxApi/models/attachmentlog_response_compound.py b/eZmaxApi/models/attachmentlog_response_compound.py new file mode 100644 index 000000000..7bd08b5b8 --- /dev/null +++ b/eZmaxApi/models/attachmentlog_response_compound.py @@ -0,0 +1,117 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, field_validator +from pydantic import Field +from typing_extensions import Annotated +from eZmaxApi.models.field_e_attachmentlog_type import FieldEAttachmentlogType +try: + from typing import Self +except ImportError: + from typing_extensions import Self + +class AttachmentlogResponseCompound(BaseModel): + """ + A Attachmentlog Object + """ # noqa: E501 + fki_attachment_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Attachment.", alias="fkiAttachmentID") + fki_user_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the User", alias="fkiUserID") + dt_attachmentlog_datetime: Annotated[str, Field(strict=True)] = Field(description="The created date", alias="dtAttachmentlogDatetime") + e_attachmentlog_type: FieldEAttachmentlogType = Field(alias="eAttachmentlogType") + s_attachmentlog_detail: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="The additionnal detail", alias="sAttachmentlogDetail") + __properties: ClassVar[List[str]] = ["fkiAttachmentID", "fkiUserID", "dtAttachmentlogDatetime", "eAttachmentlogType", "sAttachmentlogDetail"] + + @field_validator('dt_attachmentlog_datetime') + def dt_attachmentlog_datetime_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1]) ([01]?[0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9])$", value): + raise ValueError(r"must validate the regular expression /^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1]) ([01]?[0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9])$/") + return value + + @field_validator('s_attachmentlog_detail') + def s_attachmentlog_detail_validate_regular_expression(cls, value): + """Validates the regular expression""" + if value is None: + return value + + if not re.match(r"^.{0,75}$", value): + raise ValueError(r"must validate the regular expression /^.{0,75}$/") + return value + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of AttachmentlogResponseCompound from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Dict) -> Self: + """Create an instance of AttachmentlogResponseCompound from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "fkiAttachmentID": obj.get("fkiAttachmentID"), + "fkiUserID": obj.get("fkiUserID"), + "dtAttachmentlogDatetime": obj.get("dtAttachmentlogDatetime"), + "eAttachmentlogType": obj.get("eAttachmentlogType"), + "sAttachmentlogDetail": obj.get("sAttachmentlogDetail") + }) + return _obj + + diff --git a/eZmaxApi/models/attempt_response.py b/eZmaxApi/models/attempt_response.py index 8e0cf2dbc..ed5b8a856 100644 --- a/eZmaxApi/models/attempt_response.py +++ b/eZmaxApi/models/attempt_response.py @@ -19,57 +19,75 @@ import json - -from pydantic import BaseModel, Field, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictInt, StrictStr +from pydantic import Field +try: + from typing import Self +except ImportError: + from typing_extensions import Self class AttemptResponse(BaseModel): """ - An Attempt object # noqa: E501 - """ - dt_attempt_start: StrictStr = Field(..., alias="dtAttemptStart", description="Represent a Date Time. The timezone is the one configured in the User's profile.") - s_attempt_result: StrictStr = Field(..., alias="sAttemptResult", description="The Success or Failure message of the attempt when we tried to call the URL to deliver the webhook event.") - i_attempt_duration: StrictInt = Field(..., alias="iAttemptDuration", description="The number of second it took to process the webhook or get an error") - __properties = ["dtAttemptStart", "sAttemptResult", "iAttemptDuration"] + An Attempt object + """ # noqa: E501 + dt_attempt_start: StrictStr = Field(description="Represent a Date Time. The timezone is the one configured in the User's profile.", alias="dtAttemptStart") + s_attempt_result: StrictStr = Field(description="The Success or Failure message of the attempt when we tried to call the URL to deliver the webhook event.", alias="sAttemptResult") + i_attempt_duration: StrictInt = Field(description="The number of second it took to process the webhook or get an error", alias="iAttemptDuration") + __properties: ClassVar[List[str]] = ["dtAttemptStart", "sAttemptResult", "iAttemptDuration"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> AttemptResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of AttemptResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> AttemptResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of AttemptResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return AttemptResponse.parse_obj(obj) + return cls.model_validate(obj) - _obj = AttemptResponse.parse_obj({ - "dt_attempt_start": obj.get("dtAttemptStart"), - "s_attempt_result": obj.get("sAttemptResult"), - "i_attempt_duration": obj.get("iAttemptDuration") + _obj = cls.model_validate({ + "dtAttemptStart": obj.get("dtAttemptStart"), + "sAttemptResult": obj.get("sAttemptResult"), + "iAttemptDuration": obj.get("iAttemptDuration") }) return _obj diff --git a/eZmaxApi/models/attempt_response_compound.py b/eZmaxApi/models/attempt_response_compound.py index f74780c32..690cff5d5 100644 --- a/eZmaxApi/models/attempt_response_compound.py +++ b/eZmaxApi/models/attempt_response_compound.py @@ -19,57 +19,75 @@ import json - -from pydantic import BaseModel, Field, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictInt, StrictStr +from pydantic import Field +try: + from typing import Self +except ImportError: + from typing_extensions import Self class AttemptResponseCompound(BaseModel): """ - An Attempt object and children to create a complete structure # noqa: E501 - """ - dt_attempt_start: StrictStr = Field(..., alias="dtAttemptStart", description="Represent a Date Time. The timezone is the one configured in the User's profile.") - s_attempt_result: StrictStr = Field(..., alias="sAttemptResult", description="The Success or Failure message of the attempt when we tried to call the URL to deliver the webhook event.") - i_attempt_duration: StrictInt = Field(..., alias="iAttemptDuration", description="The number of second it took to process the webhook or get an error") - __properties = ["dtAttemptStart", "sAttemptResult", "iAttemptDuration"] + An Attempt object and children to create a complete structure + """ # noqa: E501 + dt_attempt_start: StrictStr = Field(description="Represent a Date Time. The timezone is the one configured in the User's profile.", alias="dtAttemptStart") + s_attempt_result: StrictStr = Field(description="The Success or Failure message of the attempt when we tried to call the URL to deliver the webhook event.", alias="sAttemptResult") + i_attempt_duration: StrictInt = Field(description="The number of second it took to process the webhook or get an error", alias="iAttemptDuration") + __properties: ClassVar[List[str]] = ["dtAttemptStart", "sAttemptResult", "iAttemptDuration"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> AttemptResponseCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of AttemptResponseCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> AttemptResponseCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of AttemptResponseCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return AttemptResponseCompound.parse_obj(obj) + return cls.model_validate(obj) - _obj = AttemptResponseCompound.parse_obj({ - "dt_attempt_start": obj.get("dtAttemptStart"), - "s_attempt_result": obj.get("sAttemptResult"), - "i_attempt_duration": obj.get("iAttemptDuration") + _obj = cls.model_validate({ + "dtAttemptStart": obj.get("dtAttemptStart"), + "sAttemptResult": obj.get("sAttemptResult"), + "iAttemptDuration": obj.get("iAttemptDuration") }) return _obj diff --git a/eZmaxApi/models/billingentityexternal_autocomplete_element_response.py b/eZmaxApi/models/billingentityexternal_autocomplete_element_response.py index cc1556616..34899e99a 100644 --- a/eZmaxApi/models/billingentityexternal_autocomplete_element_response.py +++ b/eZmaxApi/models/billingentityexternal_autocomplete_element_response.py @@ -19,57 +19,76 @@ import json - -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictBool, StrictStr +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class BillingentityexternalAutocompleteElementResponse(BaseModel): """ - A Billingentityexternal AutocompleteElement Response # noqa: E501 - """ - pki_billingentityexternal_id: conint(strict=True, ge=1) = Field(..., alias="pkiBillingentityexternalID", description="The unique ID of the Billingentityexternal") - s_billingentityexternal_description: StrictStr = Field(..., alias="sBillingentityexternalDescription", description="The description of the Billingentityexternal") - b_billingentityexternal_isactive: StrictBool = Field(..., alias="bBillingentityexternalIsactive", description="Whether the Billingentityexternal is active or not") - __properties = ["pkiBillingentityexternalID", "sBillingentityexternalDescription", "bBillingentityexternalIsactive"] + A Billingentityexternal AutocompleteElement Response + """ # noqa: E501 + pki_billingentityexternal_id: Annotated[int, Field(strict=True, ge=1)] = Field(description="The unique ID of the Billingentityexternal", alias="pkiBillingentityexternalID") + s_billingentityexternal_description: StrictStr = Field(description="The description of the Billingentityexternal", alias="sBillingentityexternalDescription") + b_billingentityexternal_isactive: StrictBool = Field(description="Whether the Billingentityexternal is active or not", alias="bBillingentityexternalIsactive") + __properties: ClassVar[List[str]] = ["pkiBillingentityexternalID", "sBillingentityexternalDescription", "bBillingentityexternalIsactive"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> BillingentityexternalAutocompleteElementResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of BillingentityexternalAutocompleteElementResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> BillingentityexternalAutocompleteElementResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of BillingentityexternalAutocompleteElementResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return BillingentityexternalAutocompleteElementResponse.parse_obj(obj) + return cls.model_validate(obj) - _obj = BillingentityexternalAutocompleteElementResponse.parse_obj({ - "pki_billingentityexternal_id": obj.get("pkiBillingentityexternalID"), - "s_billingentityexternal_description": obj.get("sBillingentityexternalDescription"), - "b_billingentityexternal_isactive": obj.get("bBillingentityexternalIsactive") + _obj = cls.model_validate({ + "pkiBillingentityexternalID": obj.get("pkiBillingentityexternalID"), + "sBillingentityexternalDescription": obj.get("sBillingentityexternalDescription"), + "bBillingentityexternalIsactive": obj.get("bBillingentityexternalIsactive") }) return _obj diff --git a/eZmaxApi/models/billingentityexternal_get_autocomplete_v2_response.py b/eZmaxApi/models/billingentityexternal_get_autocomplete_v2_response.py index ca581bb09..f85bf861e 100644 --- a/eZmaxApi/models/billingentityexternal_get_autocomplete_v2_response.py +++ b/eZmaxApi/models/billingentityexternal_get_autocomplete_v2_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.billingentityexternal_get_autocomplete_v2_response_m_payload import BillingentityexternalGetAutocompleteV2ResponseMPayload from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class BillingentityexternalGetAutocompleteV2Response(BaseModel): """ - Response for GET /2/object/billingentityexternal/getAutocomplete # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: BillingentityexternalGetAutocompleteV2ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /2/object/billingentityexternal/getAutocomplete + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: BillingentityexternalGetAutocompleteV2ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> BillingentityexternalGetAutocompleteV2Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of BillingentityexternalGetAutocompleteV2Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> BillingentityexternalGetAutocompleteV2Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of BillingentityexternalGetAutocompleteV2Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return BillingentityexternalGetAutocompleteV2Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = BillingentityexternalGetAutocompleteV2Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": BillingentityexternalGetAutocompleteV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": BillingentityexternalGetAutocompleteV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/billingentityexternal_get_autocomplete_v2_response_m_payload.py b/eZmaxApi/models/billingentityexternal_get_autocomplete_v2_response_m_payload.py index c9480b00d..387c16b6e 100644 --- a/eZmaxApi/models/billingentityexternal_get_autocomplete_v2_response_m_payload.py +++ b/eZmaxApi/models/billingentityexternal_get_autocomplete_v2_response_m_payload.py @@ -19,41 +19,59 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.billingentityexternal_autocomplete_element_response import BillingentityexternalAutocompleteElementResponse +try: + from typing import Self +except ImportError: + from typing_extensions import Self class BillingentityexternalGetAutocompleteV2ResponseMPayload(BaseModel): """ - Payload for POST /2/object/billingentityexternal/getAutocomplete # noqa: E501 - """ - a_obj_billingentityexternal: conlist(BillingentityexternalAutocompleteElementResponse) = Field(..., alias="a_objBillingentityexternal", description="An array of Billingentityexternal autocomplete element response.") - __properties = ["a_objBillingentityexternal"] + Payload for POST /2/object/billingentityexternal/getAutocomplete + """ # noqa: E501 + a_obj_billingentityexternal: List[BillingentityexternalAutocompleteElementResponse] = Field(description="An array of Billingentityexternal autocomplete element response.", alias="a_objBillingentityexternal") + __properties: ClassVar[List[str]] = ["a_objBillingentityexternal"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> BillingentityexternalGetAutocompleteV2ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of BillingentityexternalGetAutocompleteV2ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_billingentityexternal (list) _items = [] if self.a_obj_billingentityexternal: @@ -64,16 +82,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> BillingentityexternalGetAutocompleteV2ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of BillingentityexternalGetAutocompleteV2ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return BillingentityexternalGetAutocompleteV2ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = BillingentityexternalGetAutocompleteV2ResponseMPayload.parse_obj({ - "a_obj_billingentityexternal": [BillingentityexternalAutocompleteElementResponse.from_dict(_item) for _item in obj.get("a_objBillingentityexternal")] if obj.get("a_objBillingentityexternal") is not None else None + _obj = cls.model_validate({ + "a_objBillingentityexternal": [BillingentityexternalAutocompleteElementResponse.from_dict(_item) for _item in obj.get("a_objBillingentityexternal")] if obj.get("a_objBillingentityexternal") is not None else None }) return _obj diff --git a/eZmaxApi/models/billingentityinternal_autocomplete_element_response.py b/eZmaxApi/models/billingentityinternal_autocomplete_element_response.py index 94b96a4b3..14e121ae0 100644 --- a/eZmaxApi/models/billingentityinternal_autocomplete_element_response.py +++ b/eZmaxApi/models/billingentityinternal_autocomplete_element_response.py @@ -19,57 +19,76 @@ import json - -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictBool, StrictStr +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class BillingentityinternalAutocompleteElementResponse(BaseModel): """ - A Billingentityinternal AutocompleteElement Response # noqa: E501 - """ - pki_billingentityinternal_id: conint(strict=True, ge=0) = Field(..., alias="pkiBillingentityinternalID", description="The unique ID of the Billingentityinternal.") - s_billingentityinternal_description_x: StrictStr = Field(..., alias="sBillingentityinternalDescriptionX", description="The description of the Billingentityinternal in the language of the requester") - b_billingentityinternal_isactive: StrictBool = Field(..., alias="bBillingentityinternalIsactive", description="Whether the Billingentityinternal is active or not") - __properties = ["pkiBillingentityinternalID", "sBillingentityinternalDescriptionX", "bBillingentityinternalIsactive"] + A Billingentityinternal AutocompleteElement Response + """ # noqa: E501 + pki_billingentityinternal_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Billingentityinternal.", alias="pkiBillingentityinternalID") + s_billingentityinternal_description_x: StrictStr = Field(description="The description of the Billingentityinternal in the language of the requester", alias="sBillingentityinternalDescriptionX") + b_billingentityinternal_isactive: StrictBool = Field(description="Whether the Billingentityinternal is active or not", alias="bBillingentityinternalIsactive") + __properties: ClassVar[List[str]] = ["pkiBillingentityinternalID", "sBillingentityinternalDescriptionX", "bBillingentityinternalIsactive"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> BillingentityinternalAutocompleteElementResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of BillingentityinternalAutocompleteElementResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> BillingentityinternalAutocompleteElementResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of BillingentityinternalAutocompleteElementResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return BillingentityinternalAutocompleteElementResponse.parse_obj(obj) + return cls.model_validate(obj) - _obj = BillingentityinternalAutocompleteElementResponse.parse_obj({ - "pki_billingentityinternal_id": obj.get("pkiBillingentityinternalID"), - "s_billingentityinternal_description_x": obj.get("sBillingentityinternalDescriptionX"), - "b_billingentityinternal_isactive": obj.get("bBillingentityinternalIsactive") + _obj = cls.model_validate({ + "pkiBillingentityinternalID": obj.get("pkiBillingentityinternalID"), + "sBillingentityinternalDescriptionX": obj.get("sBillingentityinternalDescriptionX"), + "bBillingentityinternalIsactive": obj.get("bBillingentityinternalIsactive") }) return _obj diff --git a/eZmaxApi/models/billingentityinternal_create_object_v1_request.py b/eZmaxApi/models/billingentityinternal_create_object_v1_request.py index cd1371db3..c6c22739d 100644 --- a/eZmaxApi/models/billingentityinternal_create_object_v1_request.py +++ b/eZmaxApi/models/billingentityinternal_create_object_v1_request.py @@ -19,41 +19,60 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.billingentityinternal_request_compound import BillingentityinternalRequestCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class BillingentityinternalCreateObjectV1Request(BaseModel): """ - Request for POST /1/object/billingentityinternal # noqa: E501 - """ - a_obj_billingentityinternal: conlist(BillingentityinternalRequestCompound, min_items=1) = Field(..., alias="a_objBillingentityinternal") - __properties = ["a_objBillingentityinternal"] + Request for POST /1/object/billingentityinternal + """ # noqa: E501 + a_obj_billingentityinternal: Annotated[List[BillingentityinternalRequestCompound], Field(min_length=1)] = Field(alias="a_objBillingentityinternal") + __properties: ClassVar[List[str]] = ["a_objBillingentityinternal"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> BillingentityinternalCreateObjectV1Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of BillingentityinternalCreateObjectV1Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_billingentityinternal (list) _items = [] if self.a_obj_billingentityinternal: @@ -64,16 +83,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> BillingentityinternalCreateObjectV1Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of BillingentityinternalCreateObjectV1Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return BillingentityinternalCreateObjectV1Request.parse_obj(obj) + return cls.model_validate(obj) - _obj = BillingentityinternalCreateObjectV1Request.parse_obj({ - "a_obj_billingentityinternal": [BillingentityinternalRequestCompound.from_dict(_item) for _item in obj.get("a_objBillingentityinternal")] if obj.get("a_objBillingentityinternal") is not None else None + _obj = cls.model_validate({ + "a_objBillingentityinternal": [BillingentityinternalRequestCompound.from_dict(_item) for _item in obj.get("a_objBillingentityinternal")] if obj.get("a_objBillingentityinternal") is not None else None }) return _obj diff --git a/eZmaxApi/models/billingentityinternal_create_object_v1_response.py b/eZmaxApi/models/billingentityinternal_create_object_v1_response.py index 80d69baf9..bdb30d28b 100644 --- a/eZmaxApi/models/billingentityinternal_create_object_v1_response.py +++ b/eZmaxApi/models/billingentityinternal_create_object_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.billingentityinternal_create_object_v1_response_m_payload import BillingentityinternalCreateObjectV1ResponseMPayload from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class BillingentityinternalCreateObjectV1Response(BaseModel): """ - Response for POST /1/object/billingentityinternal # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: BillingentityinternalCreateObjectV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for POST /1/object/billingentityinternal + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: BillingentityinternalCreateObjectV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> BillingentityinternalCreateObjectV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of BillingentityinternalCreateObjectV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> BillingentityinternalCreateObjectV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of BillingentityinternalCreateObjectV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return BillingentityinternalCreateObjectV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = BillingentityinternalCreateObjectV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": BillingentityinternalCreateObjectV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": BillingentityinternalCreateObjectV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/billingentityinternal_create_object_v1_response_m_payload.py b/eZmaxApi/models/billingentityinternal_create_object_v1_response_m_payload.py index a79cd1bd4..667a87a98 100644 --- a/eZmaxApi/models/billingentityinternal_create_object_v1_response_m_payload.py +++ b/eZmaxApi/models/billingentityinternal_create_object_v1_response_m_payload.py @@ -19,53 +19,72 @@ import json -from typing import List -from pydantic import BaseModel, Field, conint, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class BillingentityinternalCreateObjectV1ResponseMPayload(BaseModel): """ - Payload for POST /1/object/billingentityinternal # noqa: E501 - """ - a_pki_billingentityinternal_id: conlist(conint(strict=True, ge=0)) = Field(..., alias="a_pkiBillingentityinternalID", description="An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request.") - __properties = ["a_pkiBillingentityinternalID"] + Payload for POST /1/object/billingentityinternal + """ # noqa: E501 + a_pki_billingentityinternal_id: List[Annotated[int, Field(strict=True, ge=0)]] = Field(description="An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request.", alias="a_pkiBillingentityinternalID") + __properties: ClassVar[List[str]] = ["a_pkiBillingentityinternalID"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> BillingentityinternalCreateObjectV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of BillingentityinternalCreateObjectV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> BillingentityinternalCreateObjectV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of BillingentityinternalCreateObjectV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return BillingentityinternalCreateObjectV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = BillingentityinternalCreateObjectV1ResponseMPayload.parse_obj({ - "a_pki_billingentityinternal_id": obj.get("a_pkiBillingentityinternalID") + _obj = cls.model_validate({ + "a_pkiBillingentityinternalID": obj.get("a_pkiBillingentityinternalID") }) return _obj diff --git a/eZmaxApi/models/billingentityinternal_edit_object_v1_request.py b/eZmaxApi/models/billingentityinternal_edit_object_v1_request.py index 5eeeaac6a..d026b75dc 100644 --- a/eZmaxApi/models/billingentityinternal_edit_object_v1_request.py +++ b/eZmaxApi/models/billingentityinternal_edit_object_v1_request.py @@ -19,57 +19,75 @@ import json - -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.billingentityinternal_request_compound import BillingentityinternalRequestCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class BillingentityinternalEditObjectV1Request(BaseModel): """ - Request for PUT /1/object/billingentityinternal/{pkiBillingentityinternalID} # noqa: E501 - """ - obj_billingentityinternal: BillingentityinternalRequestCompound = Field(..., alias="objBillingentityinternal") - __properties = ["objBillingentityinternal"] + Request for PUT /1/object/billingentityinternal/{pkiBillingentityinternalID} + """ # noqa: E501 + obj_billingentityinternal: BillingentityinternalRequestCompound = Field(alias="objBillingentityinternal") + __properties: ClassVar[List[str]] = ["objBillingentityinternal"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> BillingentityinternalEditObjectV1Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of BillingentityinternalEditObjectV1Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_billingentityinternal if self.obj_billingentityinternal: _dict['objBillingentityinternal'] = self.obj_billingentityinternal.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> BillingentityinternalEditObjectV1Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of BillingentityinternalEditObjectV1Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return BillingentityinternalEditObjectV1Request.parse_obj(obj) + return cls.model_validate(obj) - _obj = BillingentityinternalEditObjectV1Request.parse_obj({ - "obj_billingentityinternal": BillingentityinternalRequestCompound.from_dict(obj.get("objBillingentityinternal")) if obj.get("objBillingentityinternal") is not None else None + _obj = cls.model_validate({ + "objBillingentityinternal": BillingentityinternalRequestCompound.from_dict(obj.get("objBillingentityinternal")) if obj.get("objBillingentityinternal") is not None else None }) return _obj diff --git a/eZmaxApi/models/billingentityinternal_edit_object_v1_response.py b/eZmaxApi/models/billingentityinternal_edit_object_v1_response.py index f195e5b11..d93d47ffb 100644 --- a/eZmaxApi/models/billingentityinternal_edit_object_v1_response.py +++ b/eZmaxApi/models/billingentityinternal_edit_object_v1_response.py @@ -19,43 +19,61 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class BillingentityinternalEditObjectV1Response(BaseModel): """ - Response for PUT /1/object/billingentityinternal/{pkiBillingentityinternalID} # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - __properties = ["objDebugPayload", "objDebug"] + Response for PUT /1/object/billingentityinternal/{pkiBillingentityinternalID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> BillingentityinternalEditObjectV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of BillingentityinternalEditObjectV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -65,17 +83,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> BillingentityinternalEditObjectV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of BillingentityinternalEditObjectV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return BillingentityinternalEditObjectV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = BillingentityinternalEditObjectV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None }) return _obj diff --git a/eZmaxApi/models/billingentityinternal_get_autocomplete_v2_response.py b/eZmaxApi/models/billingentityinternal_get_autocomplete_v2_response.py index 6d81078cf..df123aa29 100644 --- a/eZmaxApi/models/billingentityinternal_get_autocomplete_v2_response.py +++ b/eZmaxApi/models/billingentityinternal_get_autocomplete_v2_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.billingentityinternal_get_autocomplete_v2_response_m_payload import BillingentityinternalGetAutocompleteV2ResponseMPayload from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class BillingentityinternalGetAutocompleteV2Response(BaseModel): """ - Response for GET /2/object/billingentityinternal/getAutocomplete # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: BillingentityinternalGetAutocompleteV2ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /2/object/billingentityinternal/getAutocomplete + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: BillingentityinternalGetAutocompleteV2ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> BillingentityinternalGetAutocompleteV2Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of BillingentityinternalGetAutocompleteV2Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> BillingentityinternalGetAutocompleteV2Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of BillingentityinternalGetAutocompleteV2Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return BillingentityinternalGetAutocompleteV2Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = BillingentityinternalGetAutocompleteV2Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": BillingentityinternalGetAutocompleteV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": BillingentityinternalGetAutocompleteV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/billingentityinternal_get_autocomplete_v2_response_m_payload.py b/eZmaxApi/models/billingentityinternal_get_autocomplete_v2_response_m_payload.py index 2a5a07f3f..75fbfc0bb 100644 --- a/eZmaxApi/models/billingentityinternal_get_autocomplete_v2_response_m_payload.py +++ b/eZmaxApi/models/billingentityinternal_get_autocomplete_v2_response_m_payload.py @@ -19,41 +19,59 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.billingentityinternal_autocomplete_element_response import BillingentityinternalAutocompleteElementResponse +try: + from typing import Self +except ImportError: + from typing_extensions import Self class BillingentityinternalGetAutocompleteV2ResponseMPayload(BaseModel): """ - Payload for POST /2/object/billingentityinternal/getAutocomplete # noqa: E501 - """ - a_obj_billingentityinternal: conlist(BillingentityinternalAutocompleteElementResponse) = Field(..., alias="a_objBillingentityinternal", description="An array of Billingentityinternal object containing the description, ID and active status about the element.") - __properties = ["a_objBillingentityinternal"] + Payload for POST /2/object/billingentityinternal/getAutocomplete + """ # noqa: E501 + a_obj_billingentityinternal: List[BillingentityinternalAutocompleteElementResponse] = Field(description="An array of Billingentityinternal object containing the description, ID and active status about the element.", alias="a_objBillingentityinternal") + __properties: ClassVar[List[str]] = ["a_objBillingentityinternal"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> BillingentityinternalGetAutocompleteV2ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of BillingentityinternalGetAutocompleteV2ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_billingentityinternal (list) _items = [] if self.a_obj_billingentityinternal: @@ -64,16 +82,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> BillingentityinternalGetAutocompleteV2ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of BillingentityinternalGetAutocompleteV2ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return BillingentityinternalGetAutocompleteV2ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = BillingentityinternalGetAutocompleteV2ResponseMPayload.parse_obj({ - "a_obj_billingentityinternal": [BillingentityinternalAutocompleteElementResponse.from_dict(_item) for _item in obj.get("a_objBillingentityinternal")] if obj.get("a_objBillingentityinternal") is not None else None + _obj = cls.model_validate({ + "a_objBillingentityinternal": [BillingentityinternalAutocompleteElementResponse.from_dict(_item) for _item in obj.get("a_objBillingentityinternal")] if obj.get("a_objBillingentityinternal") is not None else None }) return _obj diff --git a/eZmaxApi/models/billingentityinternal_get_list_v1_response.py b/eZmaxApi/models/billingentityinternal_get_list_v1_response.py index 04f862286..6ca78317e 100644 --- a/eZmaxApi/models/billingentityinternal_get_list_v1_response.py +++ b/eZmaxApi/models/billingentityinternal_get_list_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.billingentityinternal_get_list_v1_response_m_payload import BillingentityinternalGetListV1ResponseMPayload from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload_get_list import CommonResponseObjDebugPayloadGetList +try: + from typing import Self +except ImportError: + from typing_extensions import Self class BillingentityinternalGetListV1Response(BaseModel): """ - Response for GET /1/object/billingentityinternal/getList # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayloadGetList = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: BillingentityinternalGetListV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /1/object/billingentityinternal/getList + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayloadGetList = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: BillingentityinternalGetListV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> BillingentityinternalGetListV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of BillingentityinternalGetListV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> BillingentityinternalGetListV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of BillingentityinternalGetListV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return BillingentityinternalGetListV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = BillingentityinternalGetListV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayloadGetList.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": BillingentityinternalGetListV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayloadGetList.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": BillingentityinternalGetListV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/billingentityinternal_get_list_v1_response_m_payload.py b/eZmaxApi/models/billingentityinternal_get_list_v1_response_m_payload.py index d2210ebe5..98a2383fc 100644 --- a/eZmaxApi/models/billingentityinternal_get_list_v1_response_m_payload.py +++ b/eZmaxApi/models/billingentityinternal_get_list_v1_response_m_payload.py @@ -19,43 +19,61 @@ import json -from typing import List -from pydantic import BaseModel, Field, StrictInt, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictInt +from pydantic import Field from eZmaxApi.models.billingentityinternal_list_element import BillingentityinternalListElement +try: + from typing import Self +except ImportError: + from typing_extensions import Self class BillingentityinternalGetListV1ResponseMPayload(BaseModel): """ - Payload for GET /1/object/billingentityinternal/getList # noqa: E501 - """ - i_row_returned: StrictInt = Field(..., alias="iRowReturned", description="The number of rows returned") - i_row_filtered: StrictInt = Field(..., alias="iRowFiltered", description="The number of rows matching your filters (if any) or the total number of rows") - a_obj_billingentityinternal: conlist(BillingentityinternalListElement) = Field(..., alias="a_objBillingentityinternal") - __properties = ["iRowReturned", "iRowFiltered", "a_objBillingentityinternal"] + Payload for GET /1/object/billingentityinternal/getList + """ # noqa: E501 + i_row_returned: StrictInt = Field(description="The number of rows returned", alias="iRowReturned") + i_row_filtered: StrictInt = Field(description="The number of rows matching your filters (if any) or the total number of rows", alias="iRowFiltered") + a_obj_billingentityinternal: List[BillingentityinternalListElement] = Field(alias="a_objBillingentityinternal") + __properties: ClassVar[List[str]] = ["iRowReturned", "iRowFiltered", "a_objBillingentityinternal"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> BillingentityinternalGetListV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of BillingentityinternalGetListV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_billingentityinternal (list) _items = [] if self.a_obj_billingentityinternal: @@ -66,18 +84,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> BillingentityinternalGetListV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of BillingentityinternalGetListV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return BillingentityinternalGetListV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = BillingentityinternalGetListV1ResponseMPayload.parse_obj({ - "i_row_returned": obj.get("iRowReturned"), - "i_row_filtered": obj.get("iRowFiltered"), - "a_obj_billingentityinternal": [BillingentityinternalListElement.from_dict(_item) for _item in obj.get("a_objBillingentityinternal")] if obj.get("a_objBillingentityinternal") is not None else None + _obj = cls.model_validate({ + "iRowReturned": obj.get("iRowReturned"), + "iRowFiltered": obj.get("iRowFiltered"), + "a_objBillingentityinternal": [BillingentityinternalListElement.from_dict(_item) for _item in obj.get("a_objBillingentityinternal")] if obj.get("a_objBillingentityinternal") is not None else None }) return _obj diff --git a/eZmaxApi/models/billingentityinternal_get_object_v2_response.py b/eZmaxApi/models/billingentityinternal_get_object_v2_response.py index 3a0799cf7..0896dc07c 100644 --- a/eZmaxApi/models/billingentityinternal_get_object_v2_response.py +++ b/eZmaxApi/models/billingentityinternal_get_object_v2_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.billingentityinternal_get_object_v2_response_m_payload import BillingentityinternalGetObjectV2ResponseMPayload from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class BillingentityinternalGetObjectV2Response(BaseModel): """ - Response for GET /2/object/billingentityinternal/{pkiBillingentityinternalID} # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: BillingentityinternalGetObjectV2ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /2/object/billingentityinternal/{pkiBillingentityinternalID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: BillingentityinternalGetObjectV2ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> BillingentityinternalGetObjectV2Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of BillingentityinternalGetObjectV2Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> BillingentityinternalGetObjectV2Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of BillingentityinternalGetObjectV2Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return BillingentityinternalGetObjectV2Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = BillingentityinternalGetObjectV2Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": BillingentityinternalGetObjectV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": BillingentityinternalGetObjectV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/billingentityinternal_get_object_v2_response_m_payload.py b/eZmaxApi/models/billingentityinternal_get_object_v2_response_m_payload.py index 7f2eb1d2c..4c6a0302e 100644 --- a/eZmaxApi/models/billingentityinternal_get_object_v2_response_m_payload.py +++ b/eZmaxApi/models/billingentityinternal_get_object_v2_response_m_payload.py @@ -19,57 +19,75 @@ import json - -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.billingentityinternal_response_compound import BillingentityinternalResponseCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class BillingentityinternalGetObjectV2ResponseMPayload(BaseModel): """ - Payload for GET /2/object/billingentityinternal/{pkiBillingentityinternalID} # noqa: E501 - """ - obj_billingentityinternal: BillingentityinternalResponseCompound = Field(..., alias="objBillingentityinternal") - __properties = ["objBillingentityinternal"] + Payload for GET /2/object/billingentityinternal/{pkiBillingentityinternalID} + """ # noqa: E501 + obj_billingentityinternal: BillingentityinternalResponseCompound = Field(alias="objBillingentityinternal") + __properties: ClassVar[List[str]] = ["objBillingentityinternal"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> BillingentityinternalGetObjectV2ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of BillingentityinternalGetObjectV2ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_billingentityinternal if self.obj_billingentityinternal: _dict['objBillingentityinternal'] = self.obj_billingentityinternal.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> BillingentityinternalGetObjectV2ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of BillingentityinternalGetObjectV2ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return BillingentityinternalGetObjectV2ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = BillingentityinternalGetObjectV2ResponseMPayload.parse_obj({ - "obj_billingentityinternal": BillingentityinternalResponseCompound.from_dict(obj.get("objBillingentityinternal")) if obj.get("objBillingentityinternal") is not None else None + _obj = cls.model_validate({ + "objBillingentityinternal": BillingentityinternalResponseCompound.from_dict(obj.get("objBillingentityinternal")) if obj.get("objBillingentityinternal") is not None else None }) return _obj diff --git a/eZmaxApi/models/billingentityinternal_list_element.py b/eZmaxApi/models/billingentityinternal_list_element.py index 5dfbc0db6..5ed302f8a 100644 --- a/eZmaxApi/models/billingentityinternal_list_element.py +++ b/eZmaxApi/models/billingentityinternal_list_element.py @@ -19,55 +19,74 @@ import json - -from pydantic import BaseModel, Field, StrictStr, conint +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictStr +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class BillingentityinternalListElement(BaseModel): """ - A Billingentityinternal List Element # noqa: E501 - """ - pki_billingentityinternal_id: conint(strict=True, ge=0) = Field(..., alias="pkiBillingentityinternalID", description="The unique ID of the Billingentityinternal.") - s_billingentityinternal_description_x: StrictStr = Field(..., alias="sBillingentityinternalDescriptionX", description="The description of the Billingentityinternal in the language of the requester") - __properties = ["pkiBillingentityinternalID", "sBillingentityinternalDescriptionX"] + A Billingentityinternal List Element + """ # noqa: E501 + pki_billingentityinternal_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Billingentityinternal.", alias="pkiBillingentityinternalID") + s_billingentityinternal_description_x: StrictStr = Field(description="The description of the Billingentityinternal in the language of the requester", alias="sBillingentityinternalDescriptionX") + __properties: ClassVar[List[str]] = ["pkiBillingentityinternalID", "sBillingentityinternalDescriptionX"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> BillingentityinternalListElement: + def from_json(cls, json_str: str) -> Self: """Create an instance of BillingentityinternalListElement from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> BillingentityinternalListElement: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of BillingentityinternalListElement from a dict""" if obj is None: return None if not isinstance(obj, dict): - return BillingentityinternalListElement.parse_obj(obj) + return cls.model_validate(obj) - _obj = BillingentityinternalListElement.parse_obj({ - "pki_billingentityinternal_id": obj.get("pkiBillingentityinternalID"), - "s_billingentityinternal_description_x": obj.get("sBillingentityinternalDescriptionX") + _obj = cls.model_validate({ + "pkiBillingentityinternalID": obj.get("pkiBillingentityinternalID"), + "sBillingentityinternalDescriptionX": obj.get("sBillingentityinternalDescriptionX") }) return _obj diff --git a/eZmaxApi/models/billingentityinternal_request.py b/eZmaxApi/models/billingentityinternal_request.py index 2827c2c94..6382d71e7 100644 --- a/eZmaxApi/models/billingentityinternal_request.py +++ b/eZmaxApi/models/billingentityinternal_request.py @@ -19,59 +19,78 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.multilingual_billingentityinternal_description import MultilingualBillingentityinternalDescription +try: + from typing import Self +except ImportError: + from typing_extensions import Self class BillingentityinternalRequest(BaseModel): """ - A Billingentityinternal Object # noqa: E501 - """ - pki_billingentityinternal_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="pkiBillingentityinternalID", description="The unique ID of the Billingentityinternal.") - obj_billingentityinternal_description: MultilingualBillingentityinternalDescription = Field(..., alias="objBillingentityinternalDescription") - __properties = ["pkiBillingentityinternalID", "objBillingentityinternalDescription"] + A Billingentityinternal Object + """ # noqa: E501 + pki_billingentityinternal_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Billingentityinternal.", alias="pkiBillingentityinternalID") + obj_billingentityinternal_description: MultilingualBillingentityinternalDescription = Field(alias="objBillingentityinternalDescription") + __properties: ClassVar[List[str]] = ["pkiBillingentityinternalID", "objBillingentityinternalDescription"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> BillingentityinternalRequest: + def from_json(cls, json_str: str) -> Self: """Create an instance of BillingentityinternalRequest from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_billingentityinternal_description if self.obj_billingentityinternal_description: _dict['objBillingentityinternalDescription'] = self.obj_billingentityinternal_description.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> BillingentityinternalRequest: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of BillingentityinternalRequest from a dict""" if obj is None: return None if not isinstance(obj, dict): - return BillingentityinternalRequest.parse_obj(obj) + return cls.model_validate(obj) - _obj = BillingentityinternalRequest.parse_obj({ - "pki_billingentityinternal_id": obj.get("pkiBillingentityinternalID"), - "obj_billingentityinternal_description": MultilingualBillingentityinternalDescription.from_dict(obj.get("objBillingentityinternalDescription")) if obj.get("objBillingentityinternalDescription") is not None else None + _obj = cls.model_validate({ + "pkiBillingentityinternalID": obj.get("pkiBillingentityinternalID"), + "objBillingentityinternalDescription": MultilingualBillingentityinternalDescription.from_dict(obj.get("objBillingentityinternalDescription")) if obj.get("objBillingentityinternalDescription") is not None else None }) return _obj diff --git a/eZmaxApi/models/billingentityinternal_request_compound.py b/eZmaxApi/models/billingentityinternal_request_compound.py index 0fce9aa32..fe0915308 100644 --- a/eZmaxApi/models/billingentityinternal_request_compound.py +++ b/eZmaxApi/models/billingentityinternal_request_compound.py @@ -19,44 +19,63 @@ import json -from typing import List, Optional -from pydantic import BaseModel, Field, conint, conlist +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.billingentityinternalproduct_request_compound import BillingentityinternalproductRequestCompound from eZmaxApi.models.multilingual_billingentityinternal_description import MultilingualBillingentityinternalDescription +try: + from typing import Self +except ImportError: + from typing_extensions import Self class BillingentityinternalRequestCompound(BaseModel): """ - A Billingentityinternal Object and children # noqa: E501 - """ - pki_billingentityinternal_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="pkiBillingentityinternalID", description="The unique ID of the Billingentityinternal.") - obj_billingentityinternal_description: MultilingualBillingentityinternalDescription = Field(..., alias="objBillingentityinternalDescription") - a_obj_billingentityinternalproduct: conlist(BillingentityinternalproductRequestCompound) = Field(..., alias="a_objBillingentityinternalproduct") - __properties = ["pkiBillingentityinternalID", "objBillingentityinternalDescription", "a_objBillingentityinternalproduct"] + A Billingentityinternal Object and children + """ # noqa: E501 + pki_billingentityinternal_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Billingentityinternal.", alias="pkiBillingentityinternalID") + obj_billingentityinternal_description: MultilingualBillingentityinternalDescription = Field(alias="objBillingentityinternalDescription") + a_obj_billingentityinternalproduct: List[BillingentityinternalproductRequestCompound] = Field(alias="a_objBillingentityinternalproduct") + __properties: ClassVar[List[str]] = ["pkiBillingentityinternalID", "objBillingentityinternalDescription", "a_objBillingentityinternalproduct"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> BillingentityinternalRequestCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of BillingentityinternalRequestCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_billingentityinternal_description if self.obj_billingentityinternal_description: _dict['objBillingentityinternalDescription'] = self.obj_billingentityinternal_description.to_dict() @@ -70,18 +89,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> BillingentityinternalRequestCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of BillingentityinternalRequestCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return BillingentityinternalRequestCompound.parse_obj(obj) + return cls.model_validate(obj) - _obj = BillingentityinternalRequestCompound.parse_obj({ - "pki_billingentityinternal_id": obj.get("pkiBillingentityinternalID"), - "obj_billingentityinternal_description": MultilingualBillingentityinternalDescription.from_dict(obj.get("objBillingentityinternalDescription")) if obj.get("objBillingentityinternalDescription") is not None else None, - "a_obj_billingentityinternalproduct": [BillingentityinternalproductRequestCompound.from_dict(_item) for _item in obj.get("a_objBillingentityinternalproduct")] if obj.get("a_objBillingentityinternalproduct") is not None else None + _obj = cls.model_validate({ + "pkiBillingentityinternalID": obj.get("pkiBillingentityinternalID"), + "objBillingentityinternalDescription": MultilingualBillingentityinternalDescription.from_dict(obj.get("objBillingentityinternalDescription")) if obj.get("objBillingentityinternalDescription") is not None else None, + "a_objBillingentityinternalproduct": [BillingentityinternalproductRequestCompound.from_dict(_item) for _item in obj.get("a_objBillingentityinternalproduct")] if obj.get("a_objBillingentityinternalproduct") is not None else None }) return _obj diff --git a/eZmaxApi/models/billingentityinternal_response.py b/eZmaxApi/models/billingentityinternal_response.py index 86a13e9b3..f5c08acbf 100644 --- a/eZmaxApi/models/billingentityinternal_response.py +++ b/eZmaxApi/models/billingentityinternal_response.py @@ -19,59 +19,78 @@ import json - -from pydantic import BaseModel, Field, conint +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.multilingual_billingentityinternal_description import MultilingualBillingentityinternalDescription +try: + from typing import Self +except ImportError: + from typing_extensions import Self class BillingentityinternalResponse(BaseModel): """ - A Billingentityinternal Object # noqa: E501 - """ - pki_billingentityinternal_id: conint(strict=True, ge=0) = Field(..., alias="pkiBillingentityinternalID", description="The unique ID of the Billingentityinternal.") - obj_billingentityinternal_description: MultilingualBillingentityinternalDescription = Field(..., alias="objBillingentityinternalDescription") - __properties = ["pkiBillingentityinternalID", "objBillingentityinternalDescription"] + A Billingentityinternal Object + """ # noqa: E501 + pki_billingentityinternal_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Billingentityinternal.", alias="pkiBillingentityinternalID") + obj_billingentityinternal_description: MultilingualBillingentityinternalDescription = Field(alias="objBillingentityinternalDescription") + __properties: ClassVar[List[str]] = ["pkiBillingentityinternalID", "objBillingentityinternalDescription"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> BillingentityinternalResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of BillingentityinternalResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_billingentityinternal_description if self.obj_billingentityinternal_description: _dict['objBillingentityinternalDescription'] = self.obj_billingentityinternal_description.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> BillingentityinternalResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of BillingentityinternalResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return BillingentityinternalResponse.parse_obj(obj) + return cls.model_validate(obj) - _obj = BillingentityinternalResponse.parse_obj({ - "pki_billingentityinternal_id": obj.get("pkiBillingentityinternalID"), - "obj_billingentityinternal_description": MultilingualBillingentityinternalDescription.from_dict(obj.get("objBillingentityinternalDescription")) if obj.get("objBillingentityinternalDescription") is not None else None + _obj = cls.model_validate({ + "pkiBillingentityinternalID": obj.get("pkiBillingentityinternalID"), + "objBillingentityinternalDescription": MultilingualBillingentityinternalDescription.from_dict(obj.get("objBillingentityinternalDescription")) if obj.get("objBillingentityinternalDescription") is not None else None }) return _obj diff --git a/eZmaxApi/models/billingentityinternal_response_compound.py b/eZmaxApi/models/billingentityinternal_response_compound.py index 4418b8987..a799edc20 100644 --- a/eZmaxApi/models/billingentityinternal_response_compound.py +++ b/eZmaxApi/models/billingentityinternal_response_compound.py @@ -19,44 +19,63 @@ import json -from typing import List -from pydantic import BaseModel, Field, conint, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.billingentityinternalproduct_response_compound import BillingentityinternalproductResponseCompound from eZmaxApi.models.multilingual_billingentityinternal_description import MultilingualBillingentityinternalDescription +try: + from typing import Self +except ImportError: + from typing_extensions import Self class BillingentityinternalResponseCompound(BaseModel): """ - A Billingentityinternal Object # noqa: E501 - """ - pki_billingentityinternal_id: conint(strict=True, ge=0) = Field(..., alias="pkiBillingentityinternalID", description="The unique ID of the Billingentityinternal.") - obj_billingentityinternal_description: MultilingualBillingentityinternalDescription = Field(..., alias="objBillingentityinternalDescription") - a_obj_billingentityinternalproduct: conlist(BillingentityinternalproductResponseCompound) = Field(..., alias="a_objBillingentityinternalproduct") - __properties = ["pkiBillingentityinternalID", "objBillingentityinternalDescription", "a_objBillingentityinternalproduct"] + A Billingentityinternal Object + """ # noqa: E501 + pki_billingentityinternal_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Billingentityinternal.", alias="pkiBillingentityinternalID") + obj_billingentityinternal_description: MultilingualBillingentityinternalDescription = Field(alias="objBillingentityinternalDescription") + a_obj_billingentityinternalproduct: List[BillingentityinternalproductResponseCompound] = Field(alias="a_objBillingentityinternalproduct") + __properties: ClassVar[List[str]] = ["pkiBillingentityinternalID", "objBillingentityinternalDescription", "a_objBillingentityinternalproduct"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> BillingentityinternalResponseCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of BillingentityinternalResponseCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_billingentityinternal_description if self.obj_billingentityinternal_description: _dict['objBillingentityinternalDescription'] = self.obj_billingentityinternal_description.to_dict() @@ -70,18 +89,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> BillingentityinternalResponseCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of BillingentityinternalResponseCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return BillingentityinternalResponseCompound.parse_obj(obj) + return cls.model_validate(obj) - _obj = BillingentityinternalResponseCompound.parse_obj({ - "pki_billingentityinternal_id": obj.get("pkiBillingentityinternalID"), - "obj_billingentityinternal_description": MultilingualBillingentityinternalDescription.from_dict(obj.get("objBillingentityinternalDescription")) if obj.get("objBillingentityinternalDescription") is not None else None, - "a_obj_billingentityinternalproduct": [BillingentityinternalproductResponseCompound.from_dict(_item) for _item in obj.get("a_objBillingentityinternalproduct")] if obj.get("a_objBillingentityinternalproduct") is not None else None + _obj = cls.model_validate({ + "pkiBillingentityinternalID": obj.get("pkiBillingentityinternalID"), + "objBillingentityinternalDescription": MultilingualBillingentityinternalDescription.from_dict(obj.get("objBillingentityinternalDescription")) if obj.get("objBillingentityinternalDescription") is not None else None, + "a_objBillingentityinternalproduct": [BillingentityinternalproductResponseCompound.from_dict(_item) for _item in obj.get("a_objBillingentityinternalproduct")] if obj.get("a_objBillingentityinternalproduct") is not None else None }) return _obj diff --git a/eZmaxApi/models/billingentityinternalproduct_request.py b/eZmaxApi/models/billingentityinternalproduct_request.py index 2baaa6bc1..25ab1cad9 100644 --- a/eZmaxApi/models/billingentityinternalproduct_request.py +++ b/eZmaxApi/models/billingentityinternalproduct_request.py @@ -19,57 +19,76 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class BillingentityinternalproductRequest(BaseModel): """ - A Billingentityinternalproduct Object # noqa: E501 - """ - pki_billingentityinternalproduct_id: Optional[conint(strict=True, le=255, ge=0)] = Field(None, alias="pkiBillingentityinternalproductID", description="The unique ID of the Billingentityinternalproduct") - fki_ezmaxproduct_id: conint(strict=True, ge=1) = Field(..., alias="fkiEzmaxproductID", description="The unique ID of the Ezmaxproduct") - fki_billingentityexternal_id: conint(strict=True, ge=1) = Field(..., alias="fkiBillingentityexternalID", description="The unique ID of the Billingentityexternal") - __properties = ["pkiBillingentityinternalproductID", "fkiEzmaxproductID", "fkiBillingentityexternalID"] + A Billingentityinternalproduct Object + """ # noqa: E501 + pki_billingentityinternalproduct_id: Optional[Annotated[int, Field(le=255, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Billingentityinternalproduct", alias="pkiBillingentityinternalproductID") + fki_ezmaxproduct_id: Annotated[int, Field(strict=True, ge=1)] = Field(description="The unique ID of the Ezmaxproduct", alias="fkiEzmaxproductID") + fki_billingentityexternal_id: Annotated[int, Field(strict=True, ge=1)] = Field(description="The unique ID of the Billingentityexternal", alias="fkiBillingentityexternalID") + __properties: ClassVar[List[str]] = ["pkiBillingentityinternalproductID", "fkiEzmaxproductID", "fkiBillingentityexternalID"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> BillingentityinternalproductRequest: + def from_json(cls, json_str: str) -> Self: """Create an instance of BillingentityinternalproductRequest from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> BillingentityinternalproductRequest: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of BillingentityinternalproductRequest from a dict""" if obj is None: return None if not isinstance(obj, dict): - return BillingentityinternalproductRequest.parse_obj(obj) + return cls.model_validate(obj) - _obj = BillingentityinternalproductRequest.parse_obj({ - "pki_billingentityinternalproduct_id": obj.get("pkiBillingentityinternalproductID"), - "fki_ezmaxproduct_id": obj.get("fkiEzmaxproductID"), - "fki_billingentityexternal_id": obj.get("fkiBillingentityexternalID") + _obj = cls.model_validate({ + "pkiBillingentityinternalproductID": obj.get("pkiBillingentityinternalproductID"), + "fkiEzmaxproductID": obj.get("fkiEzmaxproductID"), + "fkiBillingentityexternalID": obj.get("fkiBillingentityexternalID") }) return _obj diff --git a/eZmaxApi/models/billingentityinternalproduct_request_compound.py b/eZmaxApi/models/billingentityinternalproduct_request_compound.py index 22e664fa3..fad8a1381 100644 --- a/eZmaxApi/models/billingentityinternalproduct_request_compound.py +++ b/eZmaxApi/models/billingentityinternalproduct_request_compound.py @@ -19,57 +19,76 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class BillingentityinternalproductRequestCompound(BaseModel): """ - A Billingentityinternalproduct Object and children # noqa: E501 - """ - pki_billingentityinternalproduct_id: Optional[conint(strict=True, le=255, ge=0)] = Field(None, alias="pkiBillingentityinternalproductID", description="The unique ID of the Billingentityinternalproduct") - fki_ezmaxproduct_id: conint(strict=True, ge=1) = Field(..., alias="fkiEzmaxproductID", description="The unique ID of the Ezmaxproduct") - fki_billingentityexternal_id: conint(strict=True, ge=1) = Field(..., alias="fkiBillingentityexternalID", description="The unique ID of the Billingentityexternal") - __properties = ["pkiBillingentityinternalproductID", "fkiEzmaxproductID", "fkiBillingentityexternalID"] + A Billingentityinternalproduct Object and children + """ # noqa: E501 + pki_billingentityinternalproduct_id: Optional[Annotated[int, Field(le=255, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Billingentityinternalproduct", alias="pkiBillingentityinternalproductID") + fki_ezmaxproduct_id: Annotated[int, Field(strict=True, ge=1)] = Field(description="The unique ID of the Ezmaxproduct", alias="fkiEzmaxproductID") + fki_billingentityexternal_id: Annotated[int, Field(strict=True, ge=1)] = Field(description="The unique ID of the Billingentityexternal", alias="fkiBillingentityexternalID") + __properties: ClassVar[List[str]] = ["pkiBillingentityinternalproductID", "fkiEzmaxproductID", "fkiBillingentityexternalID"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> BillingentityinternalproductRequestCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of BillingentityinternalproductRequestCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> BillingentityinternalproductRequestCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of BillingentityinternalproductRequestCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return BillingentityinternalproductRequestCompound.parse_obj(obj) + return cls.model_validate(obj) - _obj = BillingentityinternalproductRequestCompound.parse_obj({ - "pki_billingentityinternalproduct_id": obj.get("pkiBillingentityinternalproductID"), - "fki_ezmaxproduct_id": obj.get("fkiEzmaxproductID"), - "fki_billingentityexternal_id": obj.get("fkiBillingentityexternalID") + _obj = cls.model_validate({ + "pkiBillingentityinternalproductID": obj.get("pkiBillingentityinternalproductID"), + "fkiEzmaxproductID": obj.get("fkiEzmaxproductID"), + "fkiBillingentityexternalID": obj.get("fkiBillingentityexternalID") }) return _obj diff --git a/eZmaxApi/models/billingentityinternalproduct_response.py b/eZmaxApi/models/billingentityinternalproduct_response.py index 3e0cb5137..9217c9115 100644 --- a/eZmaxApi/models/billingentityinternalproduct_response.py +++ b/eZmaxApi/models/billingentityinternalproduct_response.py @@ -19,65 +19,84 @@ import json - -from pydantic import BaseModel, Field, StrictStr, conint +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictStr +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class BillingentityinternalproductResponse(BaseModel): """ - A Billingentityinternalproduct Object # noqa: E501 - """ - pki_billingentityinternalproduct_id: conint(strict=True, le=255, ge=0) = Field(..., alias="pkiBillingentityinternalproductID", description="The unique ID of the Billingentityinternalproduct") - fki_billingentityinternal_id: conint(strict=True, ge=0) = Field(..., alias="fkiBillingentityinternalID", description="The unique ID of the Billingentityinternal.") - s_billingentityinternal_description_x: StrictStr = Field(..., alias="sBillingentityinternalDescriptionX", description="The description of the Billingentityinternal in the language of the requester") - fki_ezmaxproduct_id: conint(strict=True, ge=1) = Field(..., alias="fkiEzmaxproductID", description="The unique ID of the Ezmaxproduct") - s_ezmaxproduct_description_x: StrictStr = Field(..., alias="sEzmaxproductDescriptionX", description="The description of the Ezmaxproduct in the language of the requester") - fki_billingentityexternal_id: conint(strict=True, ge=1) = Field(..., alias="fkiBillingentityexternalID", description="The unique ID of the Billingentityexternal") - s_billingentityexternal_description: StrictStr = Field(..., alias="sBillingentityexternalDescription", description="The description of the Billingentityexternal") - __properties = ["pkiBillingentityinternalproductID", "fkiBillingentityinternalID", "sBillingentityinternalDescriptionX", "fkiEzmaxproductID", "sEzmaxproductDescriptionX", "fkiBillingentityexternalID", "sBillingentityexternalDescription"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + A Billingentityinternalproduct Object + """ # noqa: E501 + pki_billingentityinternalproduct_id: Annotated[int, Field(le=255, strict=True, ge=0)] = Field(description="The unique ID of the Billingentityinternalproduct", alias="pkiBillingentityinternalproductID") + fki_billingentityinternal_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Billingentityinternal.", alias="fkiBillingentityinternalID") + s_billingentityinternal_description_x: StrictStr = Field(description="The description of the Billingentityinternal in the language of the requester", alias="sBillingentityinternalDescriptionX") + fki_ezmaxproduct_id: Annotated[int, Field(strict=True, ge=1)] = Field(description="The unique ID of the Ezmaxproduct", alias="fkiEzmaxproductID") + s_ezmaxproduct_description_x: StrictStr = Field(description="The description of the Ezmaxproduct in the language of the requester", alias="sEzmaxproductDescriptionX") + fki_billingentityexternal_id: Annotated[int, Field(strict=True, ge=1)] = Field(description="The unique ID of the Billingentityexternal", alias="fkiBillingentityexternalID") + s_billingentityexternal_description: StrictStr = Field(description="The description of the Billingentityexternal", alias="sBillingentityexternalDescription") + __properties: ClassVar[List[str]] = ["pkiBillingentityinternalproductID", "fkiBillingentityinternalID", "sBillingentityinternalDescriptionX", "fkiEzmaxproductID", "sEzmaxproductDescriptionX", "fkiBillingentityexternalID", "sBillingentityexternalDescription"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> BillingentityinternalproductResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of BillingentityinternalproductResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> BillingentityinternalproductResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of BillingentityinternalproductResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return BillingentityinternalproductResponse.parse_obj(obj) - - _obj = BillingentityinternalproductResponse.parse_obj({ - "pki_billingentityinternalproduct_id": obj.get("pkiBillingentityinternalproductID"), - "fki_billingentityinternal_id": obj.get("fkiBillingentityinternalID"), - "s_billingentityinternal_description_x": obj.get("sBillingentityinternalDescriptionX"), - "fki_ezmaxproduct_id": obj.get("fkiEzmaxproductID"), - "s_ezmaxproduct_description_x": obj.get("sEzmaxproductDescriptionX"), - "fki_billingentityexternal_id": obj.get("fkiBillingentityexternalID"), - "s_billingentityexternal_description": obj.get("sBillingentityexternalDescription") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiBillingentityinternalproductID": obj.get("pkiBillingentityinternalproductID"), + "fkiBillingentityinternalID": obj.get("fkiBillingentityinternalID"), + "sBillingentityinternalDescriptionX": obj.get("sBillingentityinternalDescriptionX"), + "fkiEzmaxproductID": obj.get("fkiEzmaxproductID"), + "sEzmaxproductDescriptionX": obj.get("sEzmaxproductDescriptionX"), + "fkiBillingentityexternalID": obj.get("fkiBillingentityexternalID"), + "sBillingentityexternalDescription": obj.get("sBillingentityexternalDescription") }) return _obj diff --git a/eZmaxApi/models/billingentityinternalproduct_response_compound.py b/eZmaxApi/models/billingentityinternalproduct_response_compound.py index f4ad31612..2bfa24d07 100644 --- a/eZmaxApi/models/billingentityinternalproduct_response_compound.py +++ b/eZmaxApi/models/billingentityinternalproduct_response_compound.py @@ -19,65 +19,84 @@ import json - -from pydantic import BaseModel, Field, StrictStr, conint +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictStr +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class BillingentityinternalproductResponseCompound(BaseModel): """ - A Billingentityinternalproduct Object # noqa: E501 - """ - pki_billingentityinternalproduct_id: conint(strict=True, le=255, ge=0) = Field(..., alias="pkiBillingentityinternalproductID", description="The unique ID of the Billingentityinternalproduct") - fki_billingentityinternal_id: conint(strict=True, ge=0) = Field(..., alias="fkiBillingentityinternalID", description="The unique ID of the Billingentityinternal.") - s_billingentityinternal_description_x: StrictStr = Field(..., alias="sBillingentityinternalDescriptionX", description="The description of the Billingentityinternal in the language of the requester") - fki_ezmaxproduct_id: conint(strict=True, ge=1) = Field(..., alias="fkiEzmaxproductID", description="The unique ID of the Ezmaxproduct") - s_ezmaxproduct_description_x: StrictStr = Field(..., alias="sEzmaxproductDescriptionX", description="The description of the Ezmaxproduct in the language of the requester") - fki_billingentityexternal_id: conint(strict=True, ge=1) = Field(..., alias="fkiBillingentityexternalID", description="The unique ID of the Billingentityexternal") - s_billingentityexternal_description: StrictStr = Field(..., alias="sBillingentityexternalDescription", description="The description of the Billingentityexternal") - __properties = ["pkiBillingentityinternalproductID", "fkiBillingentityinternalID", "sBillingentityinternalDescriptionX", "fkiEzmaxproductID", "sEzmaxproductDescriptionX", "fkiBillingentityexternalID", "sBillingentityexternalDescription"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + A Billingentityinternalproduct Object + """ # noqa: E501 + pki_billingentityinternalproduct_id: Annotated[int, Field(le=255, strict=True, ge=0)] = Field(description="The unique ID of the Billingentityinternalproduct", alias="pkiBillingentityinternalproductID") + fki_billingentityinternal_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Billingentityinternal.", alias="fkiBillingentityinternalID") + s_billingentityinternal_description_x: StrictStr = Field(description="The description of the Billingentityinternal in the language of the requester", alias="sBillingentityinternalDescriptionX") + fki_ezmaxproduct_id: Annotated[int, Field(strict=True, ge=1)] = Field(description="The unique ID of the Ezmaxproduct", alias="fkiEzmaxproductID") + s_ezmaxproduct_description_x: StrictStr = Field(description="The description of the Ezmaxproduct in the language of the requester", alias="sEzmaxproductDescriptionX") + fki_billingentityexternal_id: Annotated[int, Field(strict=True, ge=1)] = Field(description="The unique ID of the Billingentityexternal", alias="fkiBillingentityexternalID") + s_billingentityexternal_description: StrictStr = Field(description="The description of the Billingentityexternal", alias="sBillingentityexternalDescription") + __properties: ClassVar[List[str]] = ["pkiBillingentityinternalproductID", "fkiBillingentityinternalID", "sBillingentityinternalDescriptionX", "fkiEzmaxproductID", "sEzmaxproductDescriptionX", "fkiBillingentityexternalID", "sBillingentityexternalDescription"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> BillingentityinternalproductResponseCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of BillingentityinternalproductResponseCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> BillingentityinternalproductResponseCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of BillingentityinternalproductResponseCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return BillingentityinternalproductResponseCompound.parse_obj(obj) - - _obj = BillingentityinternalproductResponseCompound.parse_obj({ - "pki_billingentityinternalproduct_id": obj.get("pkiBillingentityinternalproductID"), - "fki_billingentityinternal_id": obj.get("fkiBillingentityinternalID"), - "s_billingentityinternal_description_x": obj.get("sBillingentityinternalDescriptionX"), - "fki_ezmaxproduct_id": obj.get("fkiEzmaxproductID"), - "s_ezmaxproduct_description_x": obj.get("sEzmaxproductDescriptionX"), - "fki_billingentityexternal_id": obj.get("fkiBillingentityexternalID"), - "s_billingentityexternal_description": obj.get("sBillingentityexternalDescription") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiBillingentityinternalproductID": obj.get("pkiBillingentityinternalproductID"), + "fkiBillingentityinternalID": obj.get("fkiBillingentityinternalID"), + "sBillingentityinternalDescriptionX": obj.get("sBillingentityinternalDescriptionX"), + "fkiEzmaxproductID": obj.get("fkiEzmaxproductID"), + "sEzmaxproductDescriptionX": obj.get("sEzmaxproductDescriptionX"), + "fkiBillingentityexternalID": obj.get("fkiBillingentityexternalID"), + "sBillingentityexternalDescription": obj.get("sBillingentityexternalDescription") }) return _obj diff --git a/eZmaxApi/models/branding_autocomplete_element_response.py b/eZmaxApi/models/branding_autocomplete_element_response.py index 8558bb37c..9918872d4 100644 --- a/eZmaxApi/models/branding_autocomplete_element_response.py +++ b/eZmaxApi/models/branding_autocomplete_element_response.py @@ -19,57 +19,76 @@ import json - -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictBool, StrictStr +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class BrandingAutocompleteElementResponse(BaseModel): """ - Branding AutocompleteElement Response # noqa: E501 - """ - s_branding_description_x: StrictStr = Field(..., alias="sBrandingDescriptionX", description="The Description of the Branding in the language of the requester") - pki_branding_id: conint(strict=True, ge=0) = Field(..., alias="pkiBrandingID", description="The unique ID of the Branding") - b_branding_isactive: StrictBool = Field(..., alias="bBrandingIsactive", description="Whether the Branding is active or not") - __properties = ["sBrandingDescriptionX", "pkiBrandingID", "bBrandingIsactive"] + Branding AutocompleteElement Response + """ # noqa: E501 + s_branding_description_x: StrictStr = Field(description="The Description of the Branding in the language of the requester", alias="sBrandingDescriptionX") + pki_branding_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Branding", alias="pkiBrandingID") + b_branding_isactive: StrictBool = Field(description="Whether the Branding is active or not", alias="bBrandingIsactive") + __properties: ClassVar[List[str]] = ["sBrandingDescriptionX", "pkiBrandingID", "bBrandingIsactive"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> BrandingAutocompleteElementResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of BrandingAutocompleteElementResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> BrandingAutocompleteElementResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of BrandingAutocompleteElementResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return BrandingAutocompleteElementResponse.parse_obj(obj) + return cls.model_validate(obj) - _obj = BrandingAutocompleteElementResponse.parse_obj({ - "s_branding_description_x": obj.get("sBrandingDescriptionX"), - "pki_branding_id": obj.get("pkiBrandingID"), - "b_branding_isactive": obj.get("bBrandingIsactive") + _obj = cls.model_validate({ + "sBrandingDescriptionX": obj.get("sBrandingDescriptionX"), + "pkiBrandingID": obj.get("pkiBrandingID"), + "bBrandingIsactive": obj.get("bBrandingIsactive") }) return _obj diff --git a/eZmaxApi/models/branding_create_object_v1_request.py b/eZmaxApi/models/branding_create_object_v1_request.py index 59803fe07..4a1c74057 100644 --- a/eZmaxApi/models/branding_create_object_v1_request.py +++ b/eZmaxApi/models/branding_create_object_v1_request.py @@ -19,41 +19,60 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.branding_request_compound import BrandingRequestCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class BrandingCreateObjectV1Request(BaseModel): """ - Request for POST /1/object/branding # noqa: E501 - """ - a_obj_branding: conlist(BrandingRequestCompound, min_items=1) = Field(..., alias="a_objBranding") - __properties = ["a_objBranding"] + Request for POST /1/object/branding + """ # noqa: E501 + a_obj_branding: Annotated[List[BrandingRequestCompound], Field(min_length=1)] = Field(alias="a_objBranding") + __properties: ClassVar[List[str]] = ["a_objBranding"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> BrandingCreateObjectV1Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of BrandingCreateObjectV1Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_branding (list) _items = [] if self.a_obj_branding: @@ -64,16 +83,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> BrandingCreateObjectV1Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of BrandingCreateObjectV1Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return BrandingCreateObjectV1Request.parse_obj(obj) + return cls.model_validate(obj) - _obj = BrandingCreateObjectV1Request.parse_obj({ - "a_obj_branding": [BrandingRequestCompound.from_dict(_item) for _item in obj.get("a_objBranding")] if obj.get("a_objBranding") is not None else None + _obj = cls.model_validate({ + "a_objBranding": [BrandingRequestCompound.from_dict(_item) for _item in obj.get("a_objBranding")] if obj.get("a_objBranding") is not None else None }) return _obj diff --git a/eZmaxApi/models/branding_create_object_v1_response.py b/eZmaxApi/models/branding_create_object_v1_response.py index 244af7a5b..b1223b2f3 100644 --- a/eZmaxApi/models/branding_create_object_v1_response.py +++ b/eZmaxApi/models/branding_create_object_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.branding_create_object_v1_response_m_payload import BrandingCreateObjectV1ResponseMPayload from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class BrandingCreateObjectV1Response(BaseModel): """ - Response for POST /1/object/branding # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: BrandingCreateObjectV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for POST /1/object/branding + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: BrandingCreateObjectV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> BrandingCreateObjectV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of BrandingCreateObjectV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> BrandingCreateObjectV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of BrandingCreateObjectV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return BrandingCreateObjectV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = BrandingCreateObjectV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": BrandingCreateObjectV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": BrandingCreateObjectV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/branding_create_object_v1_response_m_payload.py b/eZmaxApi/models/branding_create_object_v1_response_m_payload.py index c6adbf689..0befbc481 100644 --- a/eZmaxApi/models/branding_create_object_v1_response_m_payload.py +++ b/eZmaxApi/models/branding_create_object_v1_response_m_payload.py @@ -19,53 +19,72 @@ import json -from typing import List -from pydantic import BaseModel, Field, conint, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class BrandingCreateObjectV1ResponseMPayload(BaseModel): """ - Payload for POST /1/object/branding # noqa: E501 - """ - a_pki_branding_id: conlist(conint(strict=True, ge=0), min_items=1) = Field(..., alias="a_pkiBrandingID", description="An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request.") - __properties = ["a_pkiBrandingID"] + Payload for POST /1/object/branding + """ # noqa: E501 + a_pki_branding_id: Annotated[List[Annotated[int, Field(strict=True, ge=0)]], Field(min_length=1)] = Field(description="An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request.", alias="a_pkiBrandingID") + __properties: ClassVar[List[str]] = ["a_pkiBrandingID"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> BrandingCreateObjectV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of BrandingCreateObjectV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> BrandingCreateObjectV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of BrandingCreateObjectV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return BrandingCreateObjectV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = BrandingCreateObjectV1ResponseMPayload.parse_obj({ - "a_pki_branding_id": obj.get("a_pkiBrandingID") + _obj = cls.model_validate({ + "a_pkiBrandingID": obj.get("a_pkiBrandingID") }) return _obj diff --git a/eZmaxApi/models/branding_edit_object_v1_request.py b/eZmaxApi/models/branding_edit_object_v1_request.py index b70f5a521..5932a0973 100644 --- a/eZmaxApi/models/branding_edit_object_v1_request.py +++ b/eZmaxApi/models/branding_edit_object_v1_request.py @@ -19,57 +19,75 @@ import json - -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.branding_request_compound import BrandingRequestCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class BrandingEditObjectV1Request(BaseModel): """ - Request for PUT /1/object/branding/{pkiBrandingID} # noqa: E501 - """ - obj_branding: BrandingRequestCompound = Field(..., alias="objBranding") - __properties = ["objBranding"] + Request for PUT /1/object/branding/{pkiBrandingID} + """ # noqa: E501 + obj_branding: BrandingRequestCompound = Field(alias="objBranding") + __properties: ClassVar[List[str]] = ["objBranding"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> BrandingEditObjectV1Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of BrandingEditObjectV1Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_branding if self.obj_branding: _dict['objBranding'] = self.obj_branding.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> BrandingEditObjectV1Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of BrandingEditObjectV1Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return BrandingEditObjectV1Request.parse_obj(obj) + return cls.model_validate(obj) - _obj = BrandingEditObjectV1Request.parse_obj({ - "obj_branding": BrandingRequestCompound.from_dict(obj.get("objBranding")) if obj.get("objBranding") is not None else None + _obj = cls.model_validate({ + "objBranding": BrandingRequestCompound.from_dict(obj.get("objBranding")) if obj.get("objBranding") is not None else None }) return _obj diff --git a/eZmaxApi/models/branding_edit_object_v1_response.py b/eZmaxApi/models/branding_edit_object_v1_response.py index 06e04d5fc..9e2f7191a 100644 --- a/eZmaxApi/models/branding_edit_object_v1_response.py +++ b/eZmaxApi/models/branding_edit_object_v1_response.py @@ -19,43 +19,61 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class BrandingEditObjectV1Response(BaseModel): """ - Response for PUT /1/object/branding/{pkiBrandingID} # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - __properties = ["objDebugPayload", "objDebug"] + Response for PUT /1/object/branding/{pkiBrandingID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> BrandingEditObjectV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of BrandingEditObjectV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -65,17 +83,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> BrandingEditObjectV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of BrandingEditObjectV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return BrandingEditObjectV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = BrandingEditObjectV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None }) return _obj diff --git a/eZmaxApi/models/branding_get_autocomplete_v2_response.py b/eZmaxApi/models/branding_get_autocomplete_v2_response.py index 8b455939f..f3fcf5c4a 100644 --- a/eZmaxApi/models/branding_get_autocomplete_v2_response.py +++ b/eZmaxApi/models/branding_get_autocomplete_v2_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.branding_get_autocomplete_v2_response_m_payload import BrandingGetAutocompleteV2ResponseMPayload from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class BrandingGetAutocompleteV2Response(BaseModel): """ - Response for GET /2/object/branding/getAutocomplete # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: BrandingGetAutocompleteV2ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /2/object/branding/getAutocomplete + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: BrandingGetAutocompleteV2ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> BrandingGetAutocompleteV2Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of BrandingGetAutocompleteV2Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> BrandingGetAutocompleteV2Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of BrandingGetAutocompleteV2Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return BrandingGetAutocompleteV2Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = BrandingGetAutocompleteV2Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": BrandingGetAutocompleteV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": BrandingGetAutocompleteV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/branding_get_autocomplete_v2_response_m_payload.py b/eZmaxApi/models/branding_get_autocomplete_v2_response_m_payload.py index 50b1b2361..694648a28 100644 --- a/eZmaxApi/models/branding_get_autocomplete_v2_response_m_payload.py +++ b/eZmaxApi/models/branding_get_autocomplete_v2_response_m_payload.py @@ -19,41 +19,59 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.branding_autocomplete_element_response import BrandingAutocompleteElementResponse +try: + from typing import Self +except ImportError: + from typing_extensions import Self class BrandingGetAutocompleteV2ResponseMPayload(BaseModel): """ - Payload for POST /2/object/branding/getAutocomplete # noqa: E501 - """ - a_obj_branding: conlist(BrandingAutocompleteElementResponse) = Field(..., alias="a_objBranding", description="An array of Branding object containing the description, ID and active status about the element.") - __properties = ["a_objBranding"] + Payload for POST /2/object/branding/getAutocomplete + """ # noqa: E501 + a_obj_branding: List[BrandingAutocompleteElementResponse] = Field(description="An array of Branding object containing the description, ID and active status about the element.", alias="a_objBranding") + __properties: ClassVar[List[str]] = ["a_objBranding"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> BrandingGetAutocompleteV2ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of BrandingGetAutocompleteV2ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_branding (list) _items = [] if self.a_obj_branding: @@ -64,16 +82,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> BrandingGetAutocompleteV2ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of BrandingGetAutocompleteV2ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return BrandingGetAutocompleteV2ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = BrandingGetAutocompleteV2ResponseMPayload.parse_obj({ - "a_obj_branding": [BrandingAutocompleteElementResponse.from_dict(_item) for _item in obj.get("a_objBranding")] if obj.get("a_objBranding") is not None else None + _obj = cls.model_validate({ + "a_objBranding": [BrandingAutocompleteElementResponse.from_dict(_item) for _item in obj.get("a_objBranding")] if obj.get("a_objBranding") is not None else None }) return _obj diff --git a/eZmaxApi/models/branding_get_list_v1_response.py b/eZmaxApi/models/branding_get_list_v1_response.py index 6c773df23..1c4c248d0 100644 --- a/eZmaxApi/models/branding_get_list_v1_response.py +++ b/eZmaxApi/models/branding_get_list_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.branding_get_list_v1_response_m_payload import BrandingGetListV1ResponseMPayload from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload_get_list import CommonResponseObjDebugPayloadGetList +try: + from typing import Self +except ImportError: + from typing_extensions import Self class BrandingGetListV1Response(BaseModel): """ - Response for GET /1/object/branding/getList # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayloadGetList = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: BrandingGetListV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /1/object/branding/getList + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayloadGetList = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: BrandingGetListV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> BrandingGetListV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of BrandingGetListV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> BrandingGetListV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of BrandingGetListV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return BrandingGetListV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = BrandingGetListV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayloadGetList.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": BrandingGetListV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayloadGetList.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": BrandingGetListV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/branding_get_list_v1_response_m_payload.py b/eZmaxApi/models/branding_get_list_v1_response_m_payload.py index 9da3ef141..ac091bf9a 100644 --- a/eZmaxApi/models/branding_get_list_v1_response_m_payload.py +++ b/eZmaxApi/models/branding_get_list_v1_response_m_payload.py @@ -19,43 +19,61 @@ import json -from typing import List -from pydantic import BaseModel, Field, StrictInt, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictInt +from pydantic import Field from eZmaxApi.models.branding_list_element import BrandingListElement +try: + from typing import Self +except ImportError: + from typing_extensions import Self class BrandingGetListV1ResponseMPayload(BaseModel): """ - Payload for GET /1/object/branding/getList # noqa: E501 - """ - i_row_returned: StrictInt = Field(..., alias="iRowReturned", description="The number of rows returned") - i_row_filtered: StrictInt = Field(..., alias="iRowFiltered", description="The number of rows matching your filters (if any) or the total number of rows") - a_obj_branding: conlist(BrandingListElement) = Field(..., alias="a_objBranding") - __properties = ["iRowReturned", "iRowFiltered", "a_objBranding"] + Payload for GET /1/object/branding/getList + """ # noqa: E501 + i_row_returned: StrictInt = Field(description="The number of rows returned", alias="iRowReturned") + i_row_filtered: StrictInt = Field(description="The number of rows matching your filters (if any) or the total number of rows", alias="iRowFiltered") + a_obj_branding: List[BrandingListElement] = Field(alias="a_objBranding") + __properties: ClassVar[List[str]] = ["iRowReturned", "iRowFiltered", "a_objBranding"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> BrandingGetListV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of BrandingGetListV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_branding (list) _items = [] if self.a_obj_branding: @@ -66,18 +84,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> BrandingGetListV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of BrandingGetListV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return BrandingGetListV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = BrandingGetListV1ResponseMPayload.parse_obj({ - "i_row_returned": obj.get("iRowReturned"), - "i_row_filtered": obj.get("iRowFiltered"), - "a_obj_branding": [BrandingListElement.from_dict(_item) for _item in obj.get("a_objBranding")] if obj.get("a_objBranding") is not None else None + _obj = cls.model_validate({ + "iRowReturned": obj.get("iRowReturned"), + "iRowFiltered": obj.get("iRowFiltered"), + "a_objBranding": [BrandingListElement.from_dict(_item) for _item in obj.get("a_objBranding")] if obj.get("a_objBranding") is not None else None }) return _obj diff --git a/eZmaxApi/models/branding_get_object_v2_response.py b/eZmaxApi/models/branding_get_object_v2_response.py index 72f7d0b92..c8be9ffd2 100644 --- a/eZmaxApi/models/branding_get_object_v2_response.py +++ b/eZmaxApi/models/branding_get_object_v2_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.branding_get_object_v2_response_m_payload import BrandingGetObjectV2ResponseMPayload from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class BrandingGetObjectV2Response(BaseModel): """ - Response for GET /2/object/branding/{pkiBrandingID} # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: BrandingGetObjectV2ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /2/object/branding/{pkiBrandingID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: BrandingGetObjectV2ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> BrandingGetObjectV2Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of BrandingGetObjectV2Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> BrandingGetObjectV2Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of BrandingGetObjectV2Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return BrandingGetObjectV2Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = BrandingGetObjectV2Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": BrandingGetObjectV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": BrandingGetObjectV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/branding_get_object_v2_response_m_payload.py b/eZmaxApi/models/branding_get_object_v2_response_m_payload.py index 195357878..0a02c7aed 100644 --- a/eZmaxApi/models/branding_get_object_v2_response_m_payload.py +++ b/eZmaxApi/models/branding_get_object_v2_response_m_payload.py @@ -19,57 +19,75 @@ import json - -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.branding_response_compound import BrandingResponseCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class BrandingGetObjectV2ResponseMPayload(BaseModel): """ - Payload for GET /2/object/branding/{pkiBrandingID} # noqa: E501 - """ - obj_branding: BrandingResponseCompound = Field(..., alias="objBranding") - __properties = ["objBranding"] + Payload for GET /2/object/branding/{pkiBrandingID} + """ # noqa: E501 + obj_branding: BrandingResponseCompound = Field(alias="objBranding") + __properties: ClassVar[List[str]] = ["objBranding"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> BrandingGetObjectV2ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of BrandingGetObjectV2ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_branding if self.obj_branding: _dict['objBranding'] = self.obj_branding.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> BrandingGetObjectV2ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of BrandingGetObjectV2ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return BrandingGetObjectV2ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = BrandingGetObjectV2ResponseMPayload.parse_obj({ - "obj_branding": BrandingResponseCompound.from_dict(obj.get("objBranding")) if obj.get("objBranding") is not None else None + _obj = cls.model_validate({ + "objBranding": BrandingResponseCompound.from_dict(obj.get("objBranding")) if obj.get("objBranding") is not None else None }) return _obj diff --git a/eZmaxApi/models/branding_list_element.py b/eZmaxApi/models/branding_list_element.py index 1eeee6b94..a12442116 100644 --- a/eZmaxApi/models/branding_list_element.py +++ b/eZmaxApi/models/branding_list_element.py @@ -19,69 +19,88 @@ import json - -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictBool, StrictStr +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class BrandingListElement(BaseModel): """ - A Branding List Element # noqa: E501 - """ - pki_branding_id: conint(strict=True, ge=0) = Field(..., alias="pkiBrandingID", description="The unique ID of the Branding") - s_branding_description_x: StrictStr = Field(..., alias="sBrandingDescriptionX", description="The Description of the Branding in the language of the requester") - i_branding_colortext: conint(strict=True, le=16777215, ge=0) = Field(..., alias="iBrandingColortext", description="The color of the text. This is a RGB color converted into integer") - i_branding_colortextlinkbox: conint(strict=True, le=16777215, ge=0) = Field(..., alias="iBrandingColortextlinkbox", description="The color of the text in the link box. This is a RGB color converted into integer") - i_branding_colortextbutton: conint(strict=True, le=16777215, ge=0) = Field(..., alias="iBrandingColortextbutton", description="The color of the text in the button. This is a RGB color converted into integer") - i_branding_colorbackground: conint(strict=True, le=16777215, ge=0) = Field(..., alias="iBrandingColorbackground", description="The color of the background. This is a RGB color converted into integer") - i_branding_colorbackgroundbutton: conint(strict=True, le=16777215, ge=0) = Field(..., alias="iBrandingColorbackgroundbutton", description="The color of the background of the button. This is a RGB color converted into integer") - i_branding_colorbackgroundsmallbox: conint(strict=True, le=16777215, ge=0) = Field(..., alias="iBrandingColorbackgroundsmallbox", description="The color of the background of the small box. This is a RGB color converted into integer") - b_branding_isactive: StrictBool = Field(..., alias="bBrandingIsactive", description="Whether the Branding is active or not") - __properties = ["pkiBrandingID", "sBrandingDescriptionX", "iBrandingColortext", "iBrandingColortextlinkbox", "iBrandingColortextbutton", "iBrandingColorbackground", "iBrandingColorbackgroundbutton", "iBrandingColorbackgroundsmallbox", "bBrandingIsactive"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + A Branding List Element + """ # noqa: E501 + pki_branding_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Branding", alias="pkiBrandingID") + s_branding_description_x: StrictStr = Field(description="The Description of the Branding in the language of the requester", alias="sBrandingDescriptionX") + i_branding_colortext: Annotated[int, Field(le=16777215, strict=True, ge=0)] = Field(description="The color of the text. This is a RGB color converted into integer", alias="iBrandingColortext") + i_branding_colortextlinkbox: Annotated[int, Field(le=16777215, strict=True, ge=0)] = Field(description="The color of the text in the link box. This is a RGB color converted into integer", alias="iBrandingColortextlinkbox") + i_branding_colortextbutton: Annotated[int, Field(le=16777215, strict=True, ge=0)] = Field(description="The color of the text in the button. This is a RGB color converted into integer", alias="iBrandingColortextbutton") + i_branding_colorbackground: Annotated[int, Field(le=16777215, strict=True, ge=0)] = Field(description="The color of the background. This is a RGB color converted into integer", alias="iBrandingColorbackground") + i_branding_colorbackgroundbutton: Annotated[int, Field(le=16777215, strict=True, ge=0)] = Field(description="The color of the background of the button. This is a RGB color converted into integer", alias="iBrandingColorbackgroundbutton") + i_branding_colorbackgroundsmallbox: Annotated[int, Field(le=16777215, strict=True, ge=0)] = Field(description="The color of the background of the small box. This is a RGB color converted into integer", alias="iBrandingColorbackgroundsmallbox") + b_branding_isactive: StrictBool = Field(description="Whether the Branding is active or not", alias="bBrandingIsactive") + __properties: ClassVar[List[str]] = ["pkiBrandingID", "sBrandingDescriptionX", "iBrandingColortext", "iBrandingColortextlinkbox", "iBrandingColortextbutton", "iBrandingColorbackground", "iBrandingColorbackgroundbutton", "iBrandingColorbackgroundsmallbox", "bBrandingIsactive"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> BrandingListElement: + def from_json(cls, json_str: str) -> Self: """Create an instance of BrandingListElement from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> BrandingListElement: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of BrandingListElement from a dict""" if obj is None: return None if not isinstance(obj, dict): - return BrandingListElement.parse_obj(obj) - - _obj = BrandingListElement.parse_obj({ - "pki_branding_id": obj.get("pkiBrandingID"), - "s_branding_description_x": obj.get("sBrandingDescriptionX"), - "i_branding_colortext": obj.get("iBrandingColortext"), - "i_branding_colortextlinkbox": obj.get("iBrandingColortextlinkbox"), - "i_branding_colortextbutton": obj.get("iBrandingColortextbutton"), - "i_branding_colorbackground": obj.get("iBrandingColorbackground"), - "i_branding_colorbackgroundbutton": obj.get("iBrandingColorbackgroundbutton"), - "i_branding_colorbackgroundsmallbox": obj.get("iBrandingColorbackgroundsmallbox"), - "b_branding_isactive": obj.get("bBrandingIsactive") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiBrandingID": obj.get("pkiBrandingID"), + "sBrandingDescriptionX": obj.get("sBrandingDescriptionX"), + "iBrandingColortext": obj.get("iBrandingColortext"), + "iBrandingColortextlinkbox": obj.get("iBrandingColortextlinkbox"), + "iBrandingColortextbutton": obj.get("iBrandingColortextbutton"), + "iBrandingColorbackground": obj.get("iBrandingColorbackground"), + "iBrandingColorbackgroundbutton": obj.get("iBrandingColorbackgroundbutton"), + "iBrandingColorbackgroundsmallbox": obj.get("iBrandingColorbackgroundsmallbox"), + "bBrandingIsactive": obj.get("bBrandingIsactive") }) return _obj diff --git a/eZmaxApi/models/branding_request.py b/eZmaxApi/models/branding_request.py index 3d95d488f..56eacdcec 100644 --- a/eZmaxApi/models/branding_request.py +++ b/eZmaxApi/models/branding_request.py @@ -19,31 +19,37 @@ import json -from typing import Optional, Union -from pydantic import BaseModel, Field, StrictBool, StrictBytes, StrictStr, conint, constr, validator +from typing import Any, ClassVar, Dict, List, Optional, Union +from pydantic import BaseModel, StrictBool, StrictBytes, StrictStr, field_validator +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.field_e_branding_logo import FieldEBrandingLogo from eZmaxApi.models.multilingual_branding_description import MultilingualBrandingDescription +try: + from typing import Self +except ImportError: + from typing_extensions import Self class BrandingRequest(BaseModel): """ - A Branding Object # noqa: E501 - """ - pki_branding_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="pkiBrandingID", description="The unique ID of the Branding") - obj_branding_description: MultilingualBrandingDescription = Field(..., alias="objBrandingDescription") - e_branding_logo: FieldEBrandingLogo = Field(..., alias="eBrandingLogo") - s_branding_base64: Optional[Union[StrictBytes, StrictStr]] = Field(None, alias="sBrandingBase64", description="The Base64 encoded binary content of the branding logo. This need to match image type selected in eBrandingLogo if you supply an image. If you select 'Default', the logo will be deleted and the default one will be used.") - i_branding_colortext: conint(strict=True, le=16777215, ge=0) = Field(..., alias="iBrandingColortext", description="The color of the text. This is a RGB color converted into integer") - i_branding_colortextlinkbox: conint(strict=True, le=16777215, ge=0) = Field(..., alias="iBrandingColortextlinkbox", description="The color of the text in the link box. This is a RGB color converted into integer") - i_branding_colortextbutton: conint(strict=True, le=16777215, ge=0) = Field(..., alias="iBrandingColortextbutton", description="The color of the text in the button. This is a RGB color converted into integer") - i_branding_colorbackground: conint(strict=True, le=16777215, ge=0) = Field(..., alias="iBrandingColorbackground", description="The color of the background. This is a RGB color converted into integer") - i_branding_colorbackgroundbutton: conint(strict=True, le=16777215, ge=0) = Field(..., alias="iBrandingColorbackgroundbutton", description="The color of the background of the button. This is a RGB color converted into integer") - i_branding_colorbackgroundsmallbox: conint(strict=True, le=16777215, ge=0) = Field(..., alias="iBrandingColorbackgroundsmallbox", description="The color of the background of the small box. This is a RGB color converted into integer") - s_branding_name: Optional[constr(strict=True)] = Field(None, alias="sBrandingName", description="The name of the Branding This value will only be set if you wish to overwrite the default name. If you want to keep the default name, leave this property empty") - s_email_address: Optional[StrictStr] = Field(None, alias="sEmailAddress", description="The email address.") - b_branding_isactive: StrictBool = Field(..., alias="bBrandingIsactive", description="Whether the Branding is active or not") - __properties = ["pkiBrandingID", "objBrandingDescription", "eBrandingLogo", "sBrandingBase64", "iBrandingColortext", "iBrandingColortextlinkbox", "iBrandingColortextbutton", "iBrandingColorbackground", "iBrandingColorbackgroundbutton", "iBrandingColorbackgroundsmallbox", "sBrandingName", "sEmailAddress", "bBrandingIsactive"] - - @validator('s_branding_name') + A Branding Object + """ # noqa: E501 + pki_branding_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Branding", alias="pkiBrandingID") + obj_branding_description: MultilingualBrandingDescription = Field(alias="objBrandingDescription") + e_branding_logo: FieldEBrandingLogo = Field(alias="eBrandingLogo") + s_branding_base64: Optional[Union[StrictBytes, StrictStr]] = Field(default=None, description="The Base64 encoded binary content of the branding logo. This need to match image type selected in eBrandingLogo if you supply an image. If you select 'Default', the logo will be deleted and the default one will be used.", alias="sBrandingBase64") + i_branding_colortext: Annotated[int, Field(le=16777215, strict=True, ge=0)] = Field(description="The color of the text. This is a RGB color converted into integer", alias="iBrandingColortext") + i_branding_colortextlinkbox: Annotated[int, Field(le=16777215, strict=True, ge=0)] = Field(description="The color of the text in the link box. This is a RGB color converted into integer", alias="iBrandingColortextlinkbox") + i_branding_colortextbutton: Annotated[int, Field(le=16777215, strict=True, ge=0)] = Field(description="The color of the text in the button. This is a RGB color converted into integer", alias="iBrandingColortextbutton") + i_branding_colorbackground: Annotated[int, Field(le=16777215, strict=True, ge=0)] = Field(description="The color of the background. This is a RGB color converted into integer", alias="iBrandingColorbackground") + i_branding_colorbackgroundbutton: Annotated[int, Field(le=16777215, strict=True, ge=0)] = Field(description="The color of the background of the button. This is a RGB color converted into integer", alias="iBrandingColorbackgroundbutton") + i_branding_colorbackgroundsmallbox: Annotated[int, Field(le=16777215, strict=True, ge=0)] = Field(description="The color of the background of the small box. This is a RGB color converted into integer", alias="iBrandingColorbackgroundsmallbox") + s_branding_name: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="The name of the Branding This value will only be set if you wish to overwrite the default name. If you want to keep the default name, leave this property empty", alias="sBrandingName") + s_email_address: Optional[StrictStr] = Field(default=None, description="The email address.", alias="sEmailAddress") + b_branding_isactive: StrictBool = Field(description="Whether the Branding is active or not", alias="bBrandingIsactive") + __properties: ClassVar[List[str]] = ["pkiBrandingID", "objBrandingDescription", "eBrandingLogo", "sBrandingBase64", "iBrandingColortext", "iBrandingColortextlinkbox", "iBrandingColortextbutton", "iBrandingColorbackground", "iBrandingColorbackgroundbutton", "iBrandingColorbackgroundsmallbox", "sBrandingName", "sEmailAddress", "bBrandingIsactive"] + + @field_validator('s_branding_name') def s_branding_name_validate_regular_expression(cls, value): """Validates the regular expression""" if value is None: @@ -53,58 +59,71 @@ def s_branding_name_validate_regular_expression(cls, value): raise ValueError(r"must validate the regular expression /^.{0,55}$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> BrandingRequest: + def from_json(cls, json_str: str) -> Self: """Create an instance of BrandingRequest from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_branding_description if self.obj_branding_description: _dict['objBrandingDescription'] = self.obj_branding_description.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> BrandingRequest: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of BrandingRequest from a dict""" if obj is None: return None if not isinstance(obj, dict): - return BrandingRequest.parse_obj(obj) - - _obj = BrandingRequest.parse_obj({ - "pki_branding_id": obj.get("pkiBrandingID"), - "obj_branding_description": MultilingualBrandingDescription.from_dict(obj.get("objBrandingDescription")) if obj.get("objBrandingDescription") is not None else None, - "e_branding_logo": obj.get("eBrandingLogo"), - "s_branding_base64": obj.get("sBrandingBase64"), - "i_branding_colortext": obj.get("iBrandingColortext"), - "i_branding_colortextlinkbox": obj.get("iBrandingColortextlinkbox"), - "i_branding_colortextbutton": obj.get("iBrandingColortextbutton"), - "i_branding_colorbackground": obj.get("iBrandingColorbackground"), - "i_branding_colorbackgroundbutton": obj.get("iBrandingColorbackgroundbutton"), - "i_branding_colorbackgroundsmallbox": obj.get("iBrandingColorbackgroundsmallbox"), - "s_branding_name": obj.get("sBrandingName"), - "s_email_address": obj.get("sEmailAddress"), - "b_branding_isactive": obj.get("bBrandingIsactive") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiBrandingID": obj.get("pkiBrandingID"), + "objBrandingDescription": MultilingualBrandingDescription.from_dict(obj.get("objBrandingDescription")) if obj.get("objBrandingDescription") is not None else None, + "eBrandingLogo": obj.get("eBrandingLogo"), + "sBrandingBase64": obj.get("sBrandingBase64"), + "iBrandingColortext": obj.get("iBrandingColortext"), + "iBrandingColortextlinkbox": obj.get("iBrandingColortextlinkbox"), + "iBrandingColortextbutton": obj.get("iBrandingColortextbutton"), + "iBrandingColorbackground": obj.get("iBrandingColorbackground"), + "iBrandingColorbackgroundbutton": obj.get("iBrandingColorbackgroundbutton"), + "iBrandingColorbackgroundsmallbox": obj.get("iBrandingColorbackgroundsmallbox"), + "sBrandingName": obj.get("sBrandingName"), + "sEmailAddress": obj.get("sEmailAddress"), + "bBrandingIsactive": obj.get("bBrandingIsactive") }) return _obj diff --git a/eZmaxApi/models/branding_request_compound.py b/eZmaxApi/models/branding_request_compound.py index a92ecc672..82c674e0c 100644 --- a/eZmaxApi/models/branding_request_compound.py +++ b/eZmaxApi/models/branding_request_compound.py @@ -19,31 +19,37 @@ import json -from typing import Optional, Union -from pydantic import BaseModel, Field, StrictBool, StrictBytes, StrictStr, conint, constr, validator +from typing import Any, ClassVar, Dict, List, Optional, Union +from pydantic import BaseModel, StrictBool, StrictBytes, StrictStr, field_validator +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.field_e_branding_logo import FieldEBrandingLogo from eZmaxApi.models.multilingual_branding_description import MultilingualBrandingDescription +try: + from typing import Self +except ImportError: + from typing_extensions import Self class BrandingRequestCompound(BaseModel): """ - A Branding Object and children # noqa: E501 - """ - pki_branding_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="pkiBrandingID", description="The unique ID of the Branding") - obj_branding_description: MultilingualBrandingDescription = Field(..., alias="objBrandingDescription") - e_branding_logo: FieldEBrandingLogo = Field(..., alias="eBrandingLogo") - s_branding_base64: Optional[Union[StrictBytes, StrictStr]] = Field(None, alias="sBrandingBase64", description="The Base64 encoded binary content of the branding logo. This need to match image type selected in eBrandingLogo if you supply an image. If you select 'Default', the logo will be deleted and the default one will be used.") - i_branding_colortext: conint(strict=True, le=16777215, ge=0) = Field(..., alias="iBrandingColortext", description="The color of the text. This is a RGB color converted into integer") - i_branding_colortextlinkbox: conint(strict=True, le=16777215, ge=0) = Field(..., alias="iBrandingColortextlinkbox", description="The color of the text in the link box. This is a RGB color converted into integer") - i_branding_colortextbutton: conint(strict=True, le=16777215, ge=0) = Field(..., alias="iBrandingColortextbutton", description="The color of the text in the button. This is a RGB color converted into integer") - i_branding_colorbackground: conint(strict=True, le=16777215, ge=0) = Field(..., alias="iBrandingColorbackground", description="The color of the background. This is a RGB color converted into integer") - i_branding_colorbackgroundbutton: conint(strict=True, le=16777215, ge=0) = Field(..., alias="iBrandingColorbackgroundbutton", description="The color of the background of the button. This is a RGB color converted into integer") - i_branding_colorbackgroundsmallbox: conint(strict=True, le=16777215, ge=0) = Field(..., alias="iBrandingColorbackgroundsmallbox", description="The color of the background of the small box. This is a RGB color converted into integer") - s_branding_name: Optional[constr(strict=True)] = Field(None, alias="sBrandingName", description="The name of the Branding This value will only be set if you wish to overwrite the default name. If you want to keep the default name, leave this property empty") - s_email_address: Optional[StrictStr] = Field(None, alias="sEmailAddress", description="The email address.") - b_branding_isactive: StrictBool = Field(..., alias="bBrandingIsactive", description="Whether the Branding is active or not") - __properties = ["pkiBrandingID", "objBrandingDescription", "eBrandingLogo", "sBrandingBase64", "iBrandingColortext", "iBrandingColortextlinkbox", "iBrandingColortextbutton", "iBrandingColorbackground", "iBrandingColorbackgroundbutton", "iBrandingColorbackgroundsmallbox", "sBrandingName", "sEmailAddress", "bBrandingIsactive"] - - @validator('s_branding_name') + A Branding Object and children + """ # noqa: E501 + pki_branding_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Branding", alias="pkiBrandingID") + obj_branding_description: MultilingualBrandingDescription = Field(alias="objBrandingDescription") + e_branding_logo: FieldEBrandingLogo = Field(alias="eBrandingLogo") + s_branding_base64: Optional[Union[StrictBytes, StrictStr]] = Field(default=None, description="The Base64 encoded binary content of the branding logo. This need to match image type selected in eBrandingLogo if you supply an image. If you select 'Default', the logo will be deleted and the default one will be used.", alias="sBrandingBase64") + i_branding_colortext: Annotated[int, Field(le=16777215, strict=True, ge=0)] = Field(description="The color of the text. This is a RGB color converted into integer", alias="iBrandingColortext") + i_branding_colortextlinkbox: Annotated[int, Field(le=16777215, strict=True, ge=0)] = Field(description="The color of the text in the link box. This is a RGB color converted into integer", alias="iBrandingColortextlinkbox") + i_branding_colortextbutton: Annotated[int, Field(le=16777215, strict=True, ge=0)] = Field(description="The color of the text in the button. This is a RGB color converted into integer", alias="iBrandingColortextbutton") + i_branding_colorbackground: Annotated[int, Field(le=16777215, strict=True, ge=0)] = Field(description="The color of the background. This is a RGB color converted into integer", alias="iBrandingColorbackground") + i_branding_colorbackgroundbutton: Annotated[int, Field(le=16777215, strict=True, ge=0)] = Field(description="The color of the background of the button. This is a RGB color converted into integer", alias="iBrandingColorbackgroundbutton") + i_branding_colorbackgroundsmallbox: Annotated[int, Field(le=16777215, strict=True, ge=0)] = Field(description="The color of the background of the small box. This is a RGB color converted into integer", alias="iBrandingColorbackgroundsmallbox") + s_branding_name: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="The name of the Branding This value will only be set if you wish to overwrite the default name. If you want to keep the default name, leave this property empty", alias="sBrandingName") + s_email_address: Optional[StrictStr] = Field(default=None, description="The email address.", alias="sEmailAddress") + b_branding_isactive: StrictBool = Field(description="Whether the Branding is active or not", alias="bBrandingIsactive") + __properties: ClassVar[List[str]] = ["pkiBrandingID", "objBrandingDescription", "eBrandingLogo", "sBrandingBase64", "iBrandingColortext", "iBrandingColortextlinkbox", "iBrandingColortextbutton", "iBrandingColorbackground", "iBrandingColorbackgroundbutton", "iBrandingColorbackgroundsmallbox", "sBrandingName", "sEmailAddress", "bBrandingIsactive"] + + @field_validator('s_branding_name') def s_branding_name_validate_regular_expression(cls, value): """Validates the regular expression""" if value is None: @@ -53,58 +59,71 @@ def s_branding_name_validate_regular_expression(cls, value): raise ValueError(r"must validate the regular expression /^.{0,55}$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> BrandingRequestCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of BrandingRequestCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_branding_description if self.obj_branding_description: _dict['objBrandingDescription'] = self.obj_branding_description.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> BrandingRequestCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of BrandingRequestCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return BrandingRequestCompound.parse_obj(obj) - - _obj = BrandingRequestCompound.parse_obj({ - "pki_branding_id": obj.get("pkiBrandingID"), - "obj_branding_description": MultilingualBrandingDescription.from_dict(obj.get("objBrandingDescription")) if obj.get("objBrandingDescription") is not None else None, - "e_branding_logo": obj.get("eBrandingLogo"), - "s_branding_base64": obj.get("sBrandingBase64"), - "i_branding_colortext": obj.get("iBrandingColortext"), - "i_branding_colortextlinkbox": obj.get("iBrandingColortextlinkbox"), - "i_branding_colortextbutton": obj.get("iBrandingColortextbutton"), - "i_branding_colorbackground": obj.get("iBrandingColorbackground"), - "i_branding_colorbackgroundbutton": obj.get("iBrandingColorbackgroundbutton"), - "i_branding_colorbackgroundsmallbox": obj.get("iBrandingColorbackgroundsmallbox"), - "s_branding_name": obj.get("sBrandingName"), - "s_email_address": obj.get("sEmailAddress"), - "b_branding_isactive": obj.get("bBrandingIsactive") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiBrandingID": obj.get("pkiBrandingID"), + "objBrandingDescription": MultilingualBrandingDescription.from_dict(obj.get("objBrandingDescription")) if obj.get("objBrandingDescription") is not None else None, + "eBrandingLogo": obj.get("eBrandingLogo"), + "sBrandingBase64": obj.get("sBrandingBase64"), + "iBrandingColortext": obj.get("iBrandingColortext"), + "iBrandingColortextlinkbox": obj.get("iBrandingColortextlinkbox"), + "iBrandingColortextbutton": obj.get("iBrandingColortextbutton"), + "iBrandingColorbackground": obj.get("iBrandingColorbackground"), + "iBrandingColorbackgroundbutton": obj.get("iBrandingColorbackgroundbutton"), + "iBrandingColorbackgroundsmallbox": obj.get("iBrandingColorbackgroundsmallbox"), + "sBrandingName": obj.get("sBrandingName"), + "sEmailAddress": obj.get("sEmailAddress"), + "bBrandingIsactive": obj.get("bBrandingIsactive") }) return _obj diff --git a/eZmaxApi/models/branding_response.py b/eZmaxApi/models/branding_response.py index ec6fb3304..69a0ff992 100644 --- a/eZmaxApi/models/branding_response.py +++ b/eZmaxApi/models/branding_response.py @@ -19,32 +19,38 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint, constr, validator +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, StrictStr, field_validator +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.field_e_branding_logo import FieldEBrandingLogo from eZmaxApi.models.multilingual_branding_description import MultilingualBrandingDescription +try: + from typing import Self +except ImportError: + from typing_extensions import Self class BrandingResponse(BaseModel): """ - A Branding Object # noqa: E501 - """ - pki_branding_id: conint(strict=True, ge=0) = Field(..., alias="pkiBrandingID", description="The unique ID of the Branding") - fki_email_id: Optional[conint(strict=True, le=16777215, ge=1)] = Field(None, alias="fkiEmailID", description="The unique ID of the Email") - obj_branding_description: MultilingualBrandingDescription = Field(..., alias="objBrandingDescription") - s_branding_description_x: StrictStr = Field(..., alias="sBrandingDescriptionX", description="The Description of the Branding in the language of the requester") - s_branding_name: Optional[constr(strict=True)] = Field(None, alias="sBrandingName", description="The name of the Branding This value will only be set if you wish to overwrite the default name. If you want to keep the default name, leave this property empty") - s_email_address: Optional[StrictStr] = Field(None, alias="sEmailAddress", description="The email address.") - e_branding_logo: FieldEBrandingLogo = Field(..., alias="eBrandingLogo") - i_branding_colortext: conint(strict=True, le=16777215, ge=0) = Field(..., alias="iBrandingColortext", description="The color of the text. This is a RGB color converted into integer") - i_branding_colortextlinkbox: conint(strict=True, le=16777215, ge=0) = Field(..., alias="iBrandingColortextlinkbox", description="The color of the text in the link box. This is a RGB color converted into integer") - i_branding_colortextbutton: conint(strict=True, le=16777215, ge=0) = Field(..., alias="iBrandingColortextbutton", description="The color of the text in the button. This is a RGB color converted into integer") - i_branding_colorbackground: conint(strict=True, le=16777215, ge=0) = Field(..., alias="iBrandingColorbackground", description="The color of the background. This is a RGB color converted into integer") - i_branding_colorbackgroundbutton: conint(strict=True, le=16777215, ge=0) = Field(..., alias="iBrandingColorbackgroundbutton", description="The color of the background of the button. This is a RGB color converted into integer") - i_branding_colorbackgroundsmallbox: conint(strict=True, le=16777215, ge=0) = Field(..., alias="iBrandingColorbackgroundsmallbox", description="The color of the background of the small box. This is a RGB color converted into integer") - b_branding_isactive: StrictBool = Field(..., alias="bBrandingIsactive", description="Whether the Branding is active or not") - __properties = ["pkiBrandingID", "fkiEmailID", "objBrandingDescription", "sBrandingDescriptionX", "sBrandingName", "sEmailAddress", "eBrandingLogo", "iBrandingColortext", "iBrandingColortextlinkbox", "iBrandingColortextbutton", "iBrandingColorbackground", "iBrandingColorbackgroundbutton", "iBrandingColorbackgroundsmallbox", "bBrandingIsactive"] - - @validator('s_branding_name') + A Branding Object + """ # noqa: E501 + pki_branding_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Branding", alias="pkiBrandingID") + fki_email_id: Optional[Annotated[int, Field(le=16777215, strict=True, ge=1)]] = Field(default=None, description="The unique ID of the Email", alias="fkiEmailID") + obj_branding_description: MultilingualBrandingDescription = Field(alias="objBrandingDescription") + s_branding_description_x: StrictStr = Field(description="The Description of the Branding in the language of the requester", alias="sBrandingDescriptionX") + s_branding_name: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="The name of the Branding This value will only be set if you wish to overwrite the default name. If you want to keep the default name, leave this property empty", alias="sBrandingName") + s_email_address: Optional[StrictStr] = Field(default=None, description="The email address.", alias="sEmailAddress") + e_branding_logo: FieldEBrandingLogo = Field(alias="eBrandingLogo") + i_branding_colortext: Annotated[int, Field(le=16777215, strict=True, ge=0)] = Field(description="The color of the text. This is a RGB color converted into integer", alias="iBrandingColortext") + i_branding_colortextlinkbox: Annotated[int, Field(le=16777215, strict=True, ge=0)] = Field(description="The color of the text in the link box. This is a RGB color converted into integer", alias="iBrandingColortextlinkbox") + i_branding_colortextbutton: Annotated[int, Field(le=16777215, strict=True, ge=0)] = Field(description="The color of the text in the button. This is a RGB color converted into integer", alias="iBrandingColortextbutton") + i_branding_colorbackground: Annotated[int, Field(le=16777215, strict=True, ge=0)] = Field(description="The color of the background. This is a RGB color converted into integer", alias="iBrandingColorbackground") + i_branding_colorbackgroundbutton: Annotated[int, Field(le=16777215, strict=True, ge=0)] = Field(description="The color of the background of the button. This is a RGB color converted into integer", alias="iBrandingColorbackgroundbutton") + i_branding_colorbackgroundsmallbox: Annotated[int, Field(le=16777215, strict=True, ge=0)] = Field(description="The color of the background of the small box. This is a RGB color converted into integer", alias="iBrandingColorbackgroundsmallbox") + b_branding_isactive: StrictBool = Field(description="Whether the Branding is active or not", alias="bBrandingIsactive") + __properties: ClassVar[List[str]] = ["pkiBrandingID", "fkiEmailID", "objBrandingDescription", "sBrandingDescriptionX", "sBrandingName", "sEmailAddress", "eBrandingLogo", "iBrandingColortext", "iBrandingColortextlinkbox", "iBrandingColortextbutton", "iBrandingColorbackground", "iBrandingColorbackgroundbutton", "iBrandingColorbackgroundsmallbox", "bBrandingIsactive"] + + @field_validator('s_branding_name') def s_branding_name_validate_regular_expression(cls, value): """Validates the regular expression""" if value is None: @@ -54,59 +60,72 @@ def s_branding_name_validate_regular_expression(cls, value): raise ValueError(r"must validate the regular expression /^.{0,55}$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> BrandingResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of BrandingResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_branding_description if self.obj_branding_description: _dict['objBrandingDescription'] = self.obj_branding_description.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> BrandingResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of BrandingResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return BrandingResponse.parse_obj(obj) - - _obj = BrandingResponse.parse_obj({ - "pki_branding_id": obj.get("pkiBrandingID"), - "fki_email_id": obj.get("fkiEmailID"), - "obj_branding_description": MultilingualBrandingDescription.from_dict(obj.get("objBrandingDescription")) if obj.get("objBrandingDescription") is not None else None, - "s_branding_description_x": obj.get("sBrandingDescriptionX"), - "s_branding_name": obj.get("sBrandingName"), - "s_email_address": obj.get("sEmailAddress"), - "e_branding_logo": obj.get("eBrandingLogo"), - "i_branding_colortext": obj.get("iBrandingColortext"), - "i_branding_colortextlinkbox": obj.get("iBrandingColortextlinkbox"), - "i_branding_colortextbutton": obj.get("iBrandingColortextbutton"), - "i_branding_colorbackground": obj.get("iBrandingColorbackground"), - "i_branding_colorbackgroundbutton": obj.get("iBrandingColorbackgroundbutton"), - "i_branding_colorbackgroundsmallbox": obj.get("iBrandingColorbackgroundsmallbox"), - "b_branding_isactive": obj.get("bBrandingIsactive") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiBrandingID": obj.get("pkiBrandingID"), + "fkiEmailID": obj.get("fkiEmailID"), + "objBrandingDescription": MultilingualBrandingDescription.from_dict(obj.get("objBrandingDescription")) if obj.get("objBrandingDescription") is not None else None, + "sBrandingDescriptionX": obj.get("sBrandingDescriptionX"), + "sBrandingName": obj.get("sBrandingName"), + "sEmailAddress": obj.get("sEmailAddress"), + "eBrandingLogo": obj.get("eBrandingLogo"), + "iBrandingColortext": obj.get("iBrandingColortext"), + "iBrandingColortextlinkbox": obj.get("iBrandingColortextlinkbox"), + "iBrandingColortextbutton": obj.get("iBrandingColortextbutton"), + "iBrandingColorbackground": obj.get("iBrandingColorbackground"), + "iBrandingColorbackgroundbutton": obj.get("iBrandingColorbackgroundbutton"), + "iBrandingColorbackgroundsmallbox": obj.get("iBrandingColorbackgroundsmallbox"), + "bBrandingIsactive": obj.get("bBrandingIsactive") }) return _obj diff --git a/eZmaxApi/models/branding_response_compound.py b/eZmaxApi/models/branding_response_compound.py index 059c68f24..88d3b64e9 100644 --- a/eZmaxApi/models/branding_response_compound.py +++ b/eZmaxApi/models/branding_response_compound.py @@ -19,33 +19,39 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint, constr, validator +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, StrictStr, field_validator +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.field_e_branding_logo import FieldEBrandingLogo from eZmaxApi.models.multilingual_branding_description import MultilingualBrandingDescription +try: + from typing import Self +except ImportError: + from typing_extensions import Self class BrandingResponseCompound(BaseModel): """ - A Branding Object # noqa: E501 - """ - pki_branding_id: conint(strict=True, ge=0) = Field(..., alias="pkiBrandingID", description="The unique ID of the Branding") - fki_email_id: Optional[conint(strict=True, le=16777215, ge=1)] = Field(None, alias="fkiEmailID", description="The unique ID of the Email") - obj_branding_description: MultilingualBrandingDescription = Field(..., alias="objBrandingDescription") - s_branding_description_x: StrictStr = Field(..., alias="sBrandingDescriptionX", description="The Description of the Branding in the language of the requester") - s_branding_name: Optional[constr(strict=True)] = Field(None, alias="sBrandingName", description="The name of the Branding This value will only be set if you wish to overwrite the default name. If you want to keep the default name, leave this property empty") - s_email_address: Optional[StrictStr] = Field(None, alias="sEmailAddress", description="The email address.") - e_branding_logo: FieldEBrandingLogo = Field(..., alias="eBrandingLogo") - i_branding_colortext: conint(strict=True, le=16777215, ge=0) = Field(..., alias="iBrandingColortext", description="The color of the text. This is a RGB color converted into integer") - i_branding_colortextlinkbox: conint(strict=True, le=16777215, ge=0) = Field(..., alias="iBrandingColortextlinkbox", description="The color of the text in the link box. This is a RGB color converted into integer") - i_branding_colortextbutton: conint(strict=True, le=16777215, ge=0) = Field(..., alias="iBrandingColortextbutton", description="The color of the text in the button. This is a RGB color converted into integer") - i_branding_colorbackground: conint(strict=True, le=16777215, ge=0) = Field(..., alias="iBrandingColorbackground", description="The color of the background. This is a RGB color converted into integer") - i_branding_colorbackgroundbutton: conint(strict=True, le=16777215, ge=0) = Field(..., alias="iBrandingColorbackgroundbutton", description="The color of the background of the button. This is a RGB color converted into integer") - i_branding_colorbackgroundsmallbox: conint(strict=True, le=16777215, ge=0) = Field(..., alias="iBrandingColorbackgroundsmallbox", description="The color of the background of the small box. This is a RGB color converted into integer") - b_branding_isactive: StrictBool = Field(..., alias="bBrandingIsactive", description="Whether the Branding is active or not") - s_branding_logourl: Optional[StrictStr] = Field(None, alias="sBrandingLogourl", description="The url of the picture used as logo in the Branding") - __properties = ["pkiBrandingID", "fkiEmailID", "objBrandingDescription", "sBrandingDescriptionX", "sBrandingName", "sEmailAddress", "eBrandingLogo", "iBrandingColortext", "iBrandingColortextlinkbox", "iBrandingColortextbutton", "iBrandingColorbackground", "iBrandingColorbackgroundbutton", "iBrandingColorbackgroundsmallbox", "bBrandingIsactive", "sBrandingLogourl"] - - @validator('s_branding_name') + A Branding Object + """ # noqa: E501 + pki_branding_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Branding", alias="pkiBrandingID") + fki_email_id: Optional[Annotated[int, Field(le=16777215, strict=True, ge=1)]] = Field(default=None, description="The unique ID of the Email", alias="fkiEmailID") + obj_branding_description: MultilingualBrandingDescription = Field(alias="objBrandingDescription") + s_branding_description_x: StrictStr = Field(description="The Description of the Branding in the language of the requester", alias="sBrandingDescriptionX") + s_branding_name: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="The name of the Branding This value will only be set if you wish to overwrite the default name. If you want to keep the default name, leave this property empty", alias="sBrandingName") + s_email_address: Optional[StrictStr] = Field(default=None, description="The email address.", alias="sEmailAddress") + e_branding_logo: FieldEBrandingLogo = Field(alias="eBrandingLogo") + i_branding_colortext: Annotated[int, Field(le=16777215, strict=True, ge=0)] = Field(description="The color of the text. This is a RGB color converted into integer", alias="iBrandingColortext") + i_branding_colortextlinkbox: Annotated[int, Field(le=16777215, strict=True, ge=0)] = Field(description="The color of the text in the link box. This is a RGB color converted into integer", alias="iBrandingColortextlinkbox") + i_branding_colortextbutton: Annotated[int, Field(le=16777215, strict=True, ge=0)] = Field(description="The color of the text in the button. This is a RGB color converted into integer", alias="iBrandingColortextbutton") + i_branding_colorbackground: Annotated[int, Field(le=16777215, strict=True, ge=0)] = Field(description="The color of the background. This is a RGB color converted into integer", alias="iBrandingColorbackground") + i_branding_colorbackgroundbutton: Annotated[int, Field(le=16777215, strict=True, ge=0)] = Field(description="The color of the background of the button. This is a RGB color converted into integer", alias="iBrandingColorbackgroundbutton") + i_branding_colorbackgroundsmallbox: Annotated[int, Field(le=16777215, strict=True, ge=0)] = Field(description="The color of the background of the small box. This is a RGB color converted into integer", alias="iBrandingColorbackgroundsmallbox") + b_branding_isactive: StrictBool = Field(description="Whether the Branding is active or not", alias="bBrandingIsactive") + s_branding_logourl: Optional[StrictStr] = Field(default=None, description="The url of the picture used as logo in the Branding", alias="sBrandingLogourl") + __properties: ClassVar[List[str]] = ["pkiBrandingID", "fkiEmailID", "objBrandingDescription", "sBrandingDescriptionX", "sBrandingName", "sEmailAddress", "eBrandingLogo", "iBrandingColortext", "iBrandingColortextlinkbox", "iBrandingColortextbutton", "iBrandingColorbackground", "iBrandingColorbackgroundbutton", "iBrandingColorbackgroundsmallbox", "bBrandingIsactive", "sBrandingLogourl"] + + @field_validator('s_branding_name') def s_branding_name_validate_regular_expression(cls, value): """Validates the regular expression""" if value is None: @@ -55,60 +61,73 @@ def s_branding_name_validate_regular_expression(cls, value): raise ValueError(r"must validate the regular expression /^.{0,55}$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> BrandingResponseCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of BrandingResponseCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_branding_description if self.obj_branding_description: _dict['objBrandingDescription'] = self.obj_branding_description.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> BrandingResponseCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of BrandingResponseCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return BrandingResponseCompound.parse_obj(obj) - - _obj = BrandingResponseCompound.parse_obj({ - "pki_branding_id": obj.get("pkiBrandingID"), - "fki_email_id": obj.get("fkiEmailID"), - "obj_branding_description": MultilingualBrandingDescription.from_dict(obj.get("objBrandingDescription")) if obj.get("objBrandingDescription") is not None else None, - "s_branding_description_x": obj.get("sBrandingDescriptionX"), - "s_branding_name": obj.get("sBrandingName"), - "s_email_address": obj.get("sEmailAddress"), - "e_branding_logo": obj.get("eBrandingLogo"), - "i_branding_colortext": obj.get("iBrandingColortext"), - "i_branding_colortextlinkbox": obj.get("iBrandingColortextlinkbox"), - "i_branding_colortextbutton": obj.get("iBrandingColortextbutton"), - "i_branding_colorbackground": obj.get("iBrandingColorbackground"), - "i_branding_colorbackgroundbutton": obj.get("iBrandingColorbackgroundbutton"), - "i_branding_colorbackgroundsmallbox": obj.get("iBrandingColorbackgroundsmallbox"), - "b_branding_isactive": obj.get("bBrandingIsactive"), - "s_branding_logourl": obj.get("sBrandingLogourl") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiBrandingID": obj.get("pkiBrandingID"), + "fkiEmailID": obj.get("fkiEmailID"), + "objBrandingDescription": MultilingualBrandingDescription.from_dict(obj.get("objBrandingDescription")) if obj.get("objBrandingDescription") is not None else None, + "sBrandingDescriptionX": obj.get("sBrandingDescriptionX"), + "sBrandingName": obj.get("sBrandingName"), + "sEmailAddress": obj.get("sEmailAddress"), + "eBrandingLogo": obj.get("eBrandingLogo"), + "iBrandingColortext": obj.get("iBrandingColortext"), + "iBrandingColortextlinkbox": obj.get("iBrandingColortextlinkbox"), + "iBrandingColortextbutton": obj.get("iBrandingColortextbutton"), + "iBrandingColorbackground": obj.get("iBrandingColorbackground"), + "iBrandingColorbackgroundbutton": obj.get("iBrandingColorbackgroundbutton"), + "iBrandingColorbackgroundsmallbox": obj.get("iBrandingColorbackgroundsmallbox"), + "bBrandingIsactive": obj.get("bBrandingIsactive"), + "sBrandingLogourl": obj.get("sBrandingLogourl") }) return _obj diff --git a/eZmaxApi/models/buyercontract_get_communication_list_v1_response.py b/eZmaxApi/models/buyercontract_get_communication_list_v1_response.py index 126d3bf13..1c1cd2292 100644 --- a/eZmaxApi/models/buyercontract_get_communication_list_v1_response.py +++ b/eZmaxApi/models/buyercontract_get_communication_list_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.buyercontract_get_communication_list_v1_response_m_payload import BuyercontractGetCommunicationListV1ResponseMPayload from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload_get_list import CommonResponseObjDebugPayloadGetList +try: + from typing import Self +except ImportError: + from typing_extensions import Self class BuyercontractGetCommunicationListV1Response(BaseModel): """ - Response for GET /1/object/buyercontract/{pkiBuyercontractID}/getCommunicationList # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayloadGetList = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: BuyercontractGetCommunicationListV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /1/object/buyercontract/{pkiBuyercontractID}/getCommunicationList + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayloadGetList = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: BuyercontractGetCommunicationListV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> BuyercontractGetCommunicationListV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of BuyercontractGetCommunicationListV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> BuyercontractGetCommunicationListV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of BuyercontractGetCommunicationListV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return BuyercontractGetCommunicationListV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = BuyercontractGetCommunicationListV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayloadGetList.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": BuyercontractGetCommunicationListV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayloadGetList.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": BuyercontractGetCommunicationListV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/buyercontract_get_communication_list_v1_response_m_payload.py b/eZmaxApi/models/buyercontract_get_communication_list_v1_response_m_payload.py index 6dbf886a0..d66c1bb49 100644 --- a/eZmaxApi/models/buyercontract_get_communication_list_v1_response_m_payload.py +++ b/eZmaxApi/models/buyercontract_get_communication_list_v1_response_m_payload.py @@ -19,41 +19,59 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.custom_communication_list_element_response import CustomCommunicationListElementResponse +try: + from typing import Self +except ImportError: + from typing_extensions import Self class BuyercontractGetCommunicationListV1ResponseMPayload(BaseModel): """ - Response for GET /1/object/buyercontract/{pkiBuyercontractID}/getCommunicationList # noqa: E501 - """ - a_obj_communication: conlist(CustomCommunicationListElementResponse) = Field(..., alias="a_objCommunication") - __properties = ["a_objCommunication"] + Response for GET /1/object/buyercontract/{pkiBuyercontractID}/getCommunicationList + """ # noqa: E501 + a_obj_communication: List[CustomCommunicationListElementResponse] = Field(alias="a_objCommunication") + __properties: ClassVar[List[str]] = ["a_objCommunication"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> BuyercontractGetCommunicationListV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of BuyercontractGetCommunicationListV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_communication (list) _items = [] if self.a_obj_communication: @@ -64,16 +82,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> BuyercontractGetCommunicationListV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of BuyercontractGetCommunicationListV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return BuyercontractGetCommunicationListV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = BuyercontractGetCommunicationListV1ResponseMPayload.parse_obj({ - "a_obj_communication": [CustomCommunicationListElementResponse.from_dict(_item) for _item in obj.get("a_objCommunication")] if obj.get("a_objCommunication") is not None else None + _obj = cls.model_validate({ + "a_objCommunication": [CustomCommunicationListElementResponse.from_dict(_item) for _item in obj.get("a_objCommunication")] if obj.get("a_objCommunication") is not None else None }) return _obj diff --git a/eZmaxApi/models/clonehistory_get_list_v1_response.py b/eZmaxApi/models/clonehistory_get_list_v1_response.py index ff7a8e4d7..9b6843176 100644 --- a/eZmaxApi/models/clonehistory_get_list_v1_response.py +++ b/eZmaxApi/models/clonehistory_get_list_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.clonehistory_get_list_v1_response_m_payload import ClonehistoryGetListV1ResponseMPayload from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload_get_list import CommonResponseObjDebugPayloadGetList +try: + from typing import Self +except ImportError: + from typing_extensions import Self class ClonehistoryGetListV1Response(BaseModel): """ - Response for GET /1/object/clonehistory/getList # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayloadGetList = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: ClonehistoryGetListV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /1/object/clonehistory/getList + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayloadGetList = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: ClonehistoryGetListV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> ClonehistoryGetListV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of ClonehistoryGetListV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> ClonehistoryGetListV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of ClonehistoryGetListV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return ClonehistoryGetListV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = ClonehistoryGetListV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayloadGetList.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": ClonehistoryGetListV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayloadGetList.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": ClonehistoryGetListV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/clonehistory_get_list_v1_response_m_payload.py b/eZmaxApi/models/clonehistory_get_list_v1_response_m_payload.py index 683d4b2ac..81d4652f7 100644 --- a/eZmaxApi/models/clonehistory_get_list_v1_response_m_payload.py +++ b/eZmaxApi/models/clonehistory_get_list_v1_response_m_payload.py @@ -19,43 +19,61 @@ import json -from typing import List -from pydantic import BaseModel, Field, StrictInt, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictInt +from pydantic import Field from eZmaxApi.models.clonehistory_list_element import ClonehistoryListElement +try: + from typing import Self +except ImportError: + from typing_extensions import Self class ClonehistoryGetListV1ResponseMPayload(BaseModel): """ - Payload for GET /1/object/clonehistory/getList # noqa: E501 - """ - i_row_returned: StrictInt = Field(..., alias="iRowReturned", description="The number of rows returned") - i_row_filtered: StrictInt = Field(..., alias="iRowFiltered", description="The number of rows matching your filters (if any) or the total number of rows") - a_obj_clonehistory: conlist(ClonehistoryListElement) = Field(..., alias="a_objClonehistory") - __properties = ["iRowReturned", "iRowFiltered", "a_objClonehistory"] + Payload for GET /1/object/clonehistory/getList + """ # noqa: E501 + i_row_returned: StrictInt = Field(description="The number of rows returned", alias="iRowReturned") + i_row_filtered: StrictInt = Field(description="The number of rows matching your filters (if any) or the total number of rows", alias="iRowFiltered") + a_obj_clonehistory: List[ClonehistoryListElement] = Field(alias="a_objClonehistory") + __properties: ClassVar[List[str]] = ["iRowReturned", "iRowFiltered", "a_objClonehistory"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> ClonehistoryGetListV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of ClonehistoryGetListV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_clonehistory (list) _items = [] if self.a_obj_clonehistory: @@ -66,18 +84,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> ClonehistoryGetListV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of ClonehistoryGetListV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return ClonehistoryGetListV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = ClonehistoryGetListV1ResponseMPayload.parse_obj({ - "i_row_returned": obj.get("iRowReturned"), - "i_row_filtered": obj.get("iRowFiltered"), - "a_obj_clonehistory": [ClonehistoryListElement.from_dict(_item) for _item in obj.get("a_objClonehistory")] if obj.get("a_objClonehistory") is not None else None + _obj = cls.model_validate({ + "iRowReturned": obj.get("iRowReturned"), + "iRowFiltered": obj.get("iRowFiltered"), + "a_objClonehistory": [ClonehistoryListElement.from_dict(_item) for _item in obj.get("a_objClonehistory")] if obj.get("a_objClonehistory") is not None else None }) return _obj diff --git a/eZmaxApi/models/clonehistory_list_element.py b/eZmaxApi/models/clonehistory_list_element.py index 6a9d98f8e..5a2f7e24c 100644 --- a/eZmaxApi/models/clonehistory_list_element.py +++ b/eZmaxApi/models/clonehistory_list_element.py @@ -19,34 +19,40 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictStr, conint, constr, validator +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictStr, field_validator +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class ClonehistoryListElement(BaseModel): """ - A Clonehistory List Element # noqa: E501 - """ - pki_clonehistory_id: conint(strict=True, le=16777215, ge=1) = Field(..., alias="pkiClonehistoryID", description="The unique ID of the Clonehistory") - fki_user_id_cloning: conint(strict=True, ge=0) = Field(..., alias="fkiUserIDCloning", description="The unique ID of the User") - fki_user_id_cloned: conint(strict=True, ge=0) = Field(..., alias="fkiUserIDCloned", description="The unique ID of the User") - dt_clonehistory_firsthit: constr(strict=True) = Field(..., alias="dtClonehistoryFirsthit", description="The firsthit of the Clonehistory") - dt_clonehistory_lasthit: Optional[constr(strict=True)] = Field(None, alias="dtClonehistoryLasthit", description="The lasthit of the Clonehistory") - s_user_loginname_cloning: constr(strict=True) = Field(..., alias="sUserLoginnameCloning", description="The login name of the User.") - s_user_firstname_cloning: StrictStr = Field(..., alias="sUserFirstnameCloning", description="The first name of the user") - s_user_lastname_cloning: StrictStr = Field(..., alias="sUserLastnameCloning", description="The last name of the user") - s_user_loginname_cloned: constr(strict=True) = Field(..., alias="sUserLoginnameCloned", description="The login name of the User.") - s_user_firstname_cloned: StrictStr = Field(..., alias="sUserFirstnameCloned", description="The first name of the user") - s_user_lastname_cloned: StrictStr = Field(..., alias="sUserLastnameCloned", description="The last name of the user") - __properties = ["pkiClonehistoryID", "fkiUserIDCloning", "fkiUserIDCloned", "dtClonehistoryFirsthit", "dtClonehistoryLasthit", "sUserLoginnameCloning", "sUserFirstnameCloning", "sUserLastnameCloning", "sUserLoginnameCloned", "sUserFirstnameCloned", "sUserLastnameCloned"] - - @validator('dt_clonehistory_firsthit') + A Clonehistory List Element + """ # noqa: E501 + pki_clonehistory_id: Annotated[int, Field(le=16777215, strict=True, ge=1)] = Field(description="The unique ID of the Clonehistory", alias="pkiClonehistoryID") + fki_user_id_cloning: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the User", alias="fkiUserIDCloning") + fki_user_id_cloned: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the User", alias="fkiUserIDCloned") + dt_clonehistory_firsthit: Annotated[str, Field(strict=True)] = Field(description="The firsthit of the Clonehistory", alias="dtClonehistoryFirsthit") + dt_clonehistory_lasthit: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="The lasthit of the Clonehistory", alias="dtClonehistoryLasthit") + s_user_loginname_cloning: Annotated[str, Field(strict=True)] = Field(description="The login name of the User.", alias="sUserLoginnameCloning") + s_user_firstname_cloning: StrictStr = Field(description="The first name of the user", alias="sUserFirstnameCloning") + s_user_lastname_cloning: StrictStr = Field(description="The last name of the user", alias="sUserLastnameCloning") + s_user_loginname_cloned: Annotated[str, Field(strict=True)] = Field(description="The login name of the User.", alias="sUserLoginnameCloned") + s_user_firstname_cloned: StrictStr = Field(description="The first name of the user", alias="sUserFirstnameCloned") + s_user_lastname_cloned: StrictStr = Field(description="The last name of the user", alias="sUserLastnameCloned") + __properties: ClassVar[List[str]] = ["pkiClonehistoryID", "fkiUserIDCloning", "fkiUserIDCloned", "dtClonehistoryFirsthit", "dtClonehistoryLasthit", "sUserLoginnameCloning", "sUserFirstnameCloning", "sUserLastnameCloning", "sUserLoginnameCloned", "sUserFirstnameCloned", "sUserLastnameCloned"] + + @field_validator('dt_clonehistory_firsthit') def dt_clonehistory_firsthit_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1]) ([01]?[0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9])$", value): raise ValueError(r"must validate the regular expression /^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1]) ([01]?[0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9])$/") return value - @validator('dt_clonehistory_lasthit') + @field_validator('dt_clonehistory_lasthit') def dt_clonehistory_lasthit_validate_regular_expression(cls, value): """Validates the regular expression""" if value is None: @@ -56,67 +62,80 @@ def dt_clonehistory_lasthit_validate_regular_expression(cls, value): raise ValueError(r"must validate the regular expression /^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1]) ([01]?[0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9])$/") return value - @validator('s_user_loginname_cloning') + @field_validator('s_user_loginname_cloning') def s_user_loginname_cloning_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^(?:([\w\.-]+@[\w\.-]+\.\w{2,20})|([a-zA-Z0-9]){1,32})$", value): raise ValueError(r"must validate the regular expression /^(?:([\w\.-]+@[\w\.-]+\.\w{2,20})|([a-zA-Z0-9]){1,32})$/") return value - @validator('s_user_loginname_cloned') + @field_validator('s_user_loginname_cloned') def s_user_loginname_cloned_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^(?:([\w\.-]+@[\w\.-]+\.\w{2,20})|([a-zA-Z0-9]){1,32})$", value): raise ValueError(r"must validate the regular expression /^(?:([\w\.-]+@[\w\.-]+\.\w{2,20})|([a-zA-Z0-9]){1,32})$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> ClonehistoryListElement: + def from_json(cls, json_str: str) -> Self: """Create an instance of ClonehistoryListElement from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> ClonehistoryListElement: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of ClonehistoryListElement from a dict""" if obj is None: return None if not isinstance(obj, dict): - return ClonehistoryListElement.parse_obj(obj) - - _obj = ClonehistoryListElement.parse_obj({ - "pki_clonehistory_id": obj.get("pkiClonehistoryID"), - "fki_user_id_cloning": obj.get("fkiUserIDCloning"), - "fki_user_id_cloned": obj.get("fkiUserIDCloned"), - "dt_clonehistory_firsthit": obj.get("dtClonehistoryFirsthit"), - "dt_clonehistory_lasthit": obj.get("dtClonehistoryLasthit"), - "s_user_loginname_cloning": obj.get("sUserLoginnameCloning"), - "s_user_firstname_cloning": obj.get("sUserFirstnameCloning"), - "s_user_lastname_cloning": obj.get("sUserLastnameCloning"), - "s_user_loginname_cloned": obj.get("sUserLoginnameCloned"), - "s_user_firstname_cloned": obj.get("sUserFirstnameCloned"), - "s_user_lastname_cloned": obj.get("sUserLastnameCloned") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiClonehistoryID": obj.get("pkiClonehistoryID"), + "fkiUserIDCloning": obj.get("fkiUserIDCloning"), + "fkiUserIDCloned": obj.get("fkiUserIDCloned"), + "dtClonehistoryFirsthit": obj.get("dtClonehistoryFirsthit"), + "dtClonehistoryLasthit": obj.get("dtClonehistoryLasthit"), + "sUserLoginnameCloning": obj.get("sUserLoginnameCloning"), + "sUserFirstnameCloning": obj.get("sUserFirstnameCloning"), + "sUserLastnameCloning": obj.get("sUserLastnameCloning"), + "sUserLoginnameCloned": obj.get("sUserLoginnameCloned"), + "sUserFirstnameCloned": obj.get("sUserFirstnameCloned"), + "sUserLastnameCloned": obj.get("sUserLastnameCloned") }) return _obj diff --git a/eZmaxApi/models/common_audit.py b/eZmaxApi/models/common_audit.py index 3115819b5..222790bea 100644 --- a/eZmaxApi/models/common_audit.py +++ b/eZmaxApi/models/common_audit.py @@ -19,42 +19,60 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_auditdetail import CommonAuditdetail +try: + from typing import Self +except ImportError: + from typing_extensions import Self class CommonAudit(BaseModel): """ - Gives informations about the user that created the object and the last user to have modified it. If the object was never modified after creation, objAuditdetailModified won't be returned. # noqa: E501 - """ - obj_auditdetail_created: CommonAuditdetail = Field(..., alias="objAuditdetailCreated") - obj_auditdetail_modified: Optional[CommonAuditdetail] = Field(None, alias="objAuditdetailModified") - __properties = ["objAuditdetailCreated", "objAuditdetailModified"] + Gives informations about the user that created the object and the last user to have modified it. If the object was never modified after creation, objAuditdetailModified won't be returned. + """ # noqa: E501 + obj_auditdetail_created: CommonAuditdetail = Field(alias="objAuditdetailCreated") + obj_auditdetail_modified: Optional[CommonAuditdetail] = Field(default=None, alias="objAuditdetailModified") + __properties: ClassVar[List[str]] = ["objAuditdetailCreated", "objAuditdetailModified"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> CommonAudit: + def from_json(cls, json_str: str) -> Self: """Create an instance of CommonAudit from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_auditdetail_created if self.obj_auditdetail_created: _dict['objAuditdetailCreated'] = self.obj_auditdetail_created.to_dict() @@ -64,17 +82,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> CommonAudit: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of CommonAudit from a dict""" if obj is None: return None if not isinstance(obj, dict): - return CommonAudit.parse_obj(obj) + return cls.model_validate(obj) - _obj = CommonAudit.parse_obj({ - "obj_auditdetail_created": CommonAuditdetail.from_dict(obj.get("objAuditdetailCreated")) if obj.get("objAuditdetailCreated") is not None else None, - "obj_auditdetail_modified": CommonAuditdetail.from_dict(obj.get("objAuditdetailModified")) if obj.get("objAuditdetailModified") is not None else None + _obj = cls.model_validate({ + "objAuditdetailCreated": CommonAuditdetail.from_dict(obj.get("objAuditdetailCreated")) if obj.get("objAuditdetailCreated") is not None else None, + "objAuditdetailModified": CommonAuditdetail.from_dict(obj.get("objAuditdetailModified")) if obj.get("objAuditdetailModified") is not None else None }) return _obj diff --git a/eZmaxApi/models/common_auditdetail.py b/eZmaxApi/models/common_auditdetail.py index 329fef2fe..5b659f099 100644 --- a/eZmaxApi/models/common_auditdetail.py +++ b/eZmaxApi/models/common_auditdetail.py @@ -19,72 +19,91 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictStr, conint, constr, validator +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictStr, field_validator +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class CommonAuditdetail(BaseModel): """ - Gives informations about the user that created the object or the last user to have modified it. If the object was never modified after creation, both Created and Modified informations will be the same. # noqa: E501 - """ - fki_user_id: conint(strict=True, ge=0) = Field(..., alias="fkiUserID", description="The unique ID of the User") - fki_apikey_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiApikeyID", description="The unique ID of the Apikey") - s_user_loginname: constr(strict=True) = Field(..., alias="sUserLoginname", description="The login name of the User.") - s_user_lastname: StrictStr = Field(..., alias="sUserLastname", description="The last name of the user") - s_user_firstname: StrictStr = Field(..., alias="sUserFirstname", description="The first name of the user") - s_apikey_description_x: Optional[StrictStr] = Field(None, alias="sApikeyDescriptionX", description="The description of the Apikey in the language of the requester") - dt_auditdetail_date: StrictStr = Field(..., alias="dtAuditdetailDate", description="Represent a Date Time. The timezone is the one configured in the User's profile.") - __properties = ["fkiUserID", "fkiApikeyID", "sUserLoginname", "sUserLastname", "sUserFirstname", "sApikeyDescriptionX", "dtAuditdetailDate"] - - @validator('s_user_loginname') + Gives informations about the user that created the object or the last user to have modified it. If the object was never modified after creation, both Created and Modified informations will be the same. + """ # noqa: E501 + fki_user_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the User", alias="fkiUserID") + fki_apikey_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Apikey", alias="fkiApikeyID") + s_user_loginname: Annotated[str, Field(strict=True)] = Field(description="The login name of the User.", alias="sUserLoginname") + s_user_lastname: StrictStr = Field(description="The last name of the user", alias="sUserLastname") + s_user_firstname: StrictStr = Field(description="The first name of the user", alias="sUserFirstname") + s_apikey_description_x: Optional[StrictStr] = Field(default=None, description="The description of the Apikey in the language of the requester", alias="sApikeyDescriptionX") + dt_auditdetail_date: StrictStr = Field(description="Represent a Date Time. The timezone is the one configured in the User's profile.", alias="dtAuditdetailDate") + __properties: ClassVar[List[str]] = ["fkiUserID", "fkiApikeyID", "sUserLoginname", "sUserLastname", "sUserFirstname", "sApikeyDescriptionX", "dtAuditdetailDate"] + + @field_validator('s_user_loginname') def s_user_loginname_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^(?:([\w\.-]+@[\w\.-]+\.\w{2,20})|([a-zA-Z0-9]){1,32})$", value): raise ValueError(r"must validate the regular expression /^(?:([\w\.-]+@[\w\.-]+\.\w{2,20})|([a-zA-Z0-9]){1,32})$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> CommonAuditdetail: + def from_json(cls, json_str: str) -> Self: """Create an instance of CommonAuditdetail from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> CommonAuditdetail: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of CommonAuditdetail from a dict""" if obj is None: return None if not isinstance(obj, dict): - return CommonAuditdetail.parse_obj(obj) - - _obj = CommonAuditdetail.parse_obj({ - "fki_user_id": obj.get("fkiUserID"), - "fki_apikey_id": obj.get("fkiApikeyID"), - "s_user_loginname": obj.get("sUserLoginname"), - "s_user_lastname": obj.get("sUserLastname"), - "s_user_firstname": obj.get("sUserFirstname"), - "s_apikey_description_x": obj.get("sApikeyDescriptionX"), - "dt_auditdetail_date": obj.get("dtAuditdetailDate") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "fkiUserID": obj.get("fkiUserID"), + "fkiApikeyID": obj.get("fkiApikeyID"), + "sUserLoginname": obj.get("sUserLoginname"), + "sUserLastname": obj.get("sUserLastname"), + "sUserFirstname": obj.get("sUserFirstname"), + "sApikeyDescriptionX": obj.get("sApikeyDescriptionX"), + "dtAuditdetailDate": obj.get("dtAuditdetailDate") }) return _obj diff --git a/eZmaxApi/models/common_file.py b/eZmaxApi/models/common_file.py index 97c555d7e..df6595cfb 100644 --- a/eZmaxApi/models/common_file.py +++ b/eZmaxApi/models/common_file.py @@ -19,66 +19,84 @@ import json -from typing import Optional, Union -from pydantic import BaseModel, Field, StrictBytes, StrictStr, validator +from typing import Any, ClassVar, Dict, List, Optional, Union +from pydantic import BaseModel, StrictBytes, StrictStr, field_validator +from pydantic import Field +try: + from typing import Self +except ImportError: + from typing_extensions import Self class CommonFile(BaseModel): """ - Object representing a file used in a request or response context # noqa: E501 - """ - s_file_name: StrictStr = Field(..., alias="sFileName", description="The name of the file") - s_file_url: Optional[StrictStr] = Field(None, alias="sFileUrl", description="The URL used to reach the File") - s_file_base64: Optional[Union[StrictBytes, StrictStr]] = Field(None, alias="sFileBase64", description="The Base64 encoded binary content of the File") - e_file_source: StrictStr = Field(..., alias="eFileSource", description="The source of the File") - __properties = ["sFileName", "sFileUrl", "sFileBase64", "eFileSource"] - - @validator('e_file_source') + Object representing a file used in a request or response context + """ # noqa: E501 + s_file_name: StrictStr = Field(description="The name of the file", alias="sFileName") + s_file_url: Optional[StrictStr] = Field(default=None, description="The URL used to reach the File", alias="sFileUrl") + s_file_base64: Optional[Union[StrictBytes, StrictStr]] = Field(default=None, description="The Base64 encoded binary content of the File", alias="sFileBase64") + e_file_source: StrictStr = Field(description="The source of the File", alias="eFileSource") + __properties: ClassVar[List[str]] = ["sFileName", "sFileUrl", "sFileBase64", "eFileSource"] + + @field_validator('e_file_source') def e_file_source_validate_enum(cls, value): """Validates the enum""" if value not in ('Base64', 'Url'): raise ValueError("must be one of enum values ('Base64', 'Url')") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> CommonFile: + def from_json(cls, json_str: str) -> Self: """Create an instance of CommonFile from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> CommonFile: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of CommonFile from a dict""" if obj is None: return None if not isinstance(obj, dict): - return CommonFile.parse_obj(obj) + return cls.model_validate(obj) - _obj = CommonFile.parse_obj({ - "s_file_name": obj.get("sFileName"), - "s_file_url": obj.get("sFileUrl"), - "s_file_base64": obj.get("sFileBase64"), - "e_file_source": obj.get("eFileSource") + _obj = cls.model_validate({ + "sFileName": obj.get("sFileName"), + "sFileUrl": obj.get("sFileUrl"), + "sFileBase64": obj.get("sFileBase64"), + "eFileSource": obj.get("eFileSource") }) return _obj diff --git a/eZmaxApi/models/common_get_autocomplete_v1_response.py b/eZmaxApi/models/common_get_autocomplete_v1_response.py index 6df19af9e..79f19c2df 100644 --- a/eZmaxApi/models/common_get_autocomplete_v1_response.py +++ b/eZmaxApi/models/common_get_autocomplete_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import List, Optional -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.custom_autocomplete_element_response import CustomAutocompleteElementResponse +try: + from typing import Self +except ImportError: + from typing_extensions import Self class CommonGetAutocompleteV1Response(BaseModel): """ - Response for GET /1/object/xxx/getAutocomplete # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: conlist(CustomAutocompleteElementResponse) = Field(..., alias="mPayload", description="Generic Autocomplete Response") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /1/object/xxx/getAutocomplete + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: List[CustomAutocompleteElementResponse] = Field(description="Generic Autocomplete Response", alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> CommonGetAutocompleteV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of CommonGetAutocompleteV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -74,18 +92,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> CommonGetAutocompleteV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of CommonGetAutocompleteV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return CommonGetAutocompleteV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = CommonGetAutocompleteV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": [CustomAutocompleteElementResponse.from_dict(_item) for _item in obj.get("mPayload")] if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": [CustomAutocompleteElementResponse.from_dict(_item) for _item in obj.get("mPayload")] if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/common_get_list_v1_response_m_payload.py b/eZmaxApi/models/common_get_list_v1_response_m_payload.py index 9f8b73c07..b4399b6b6 100644 --- a/eZmaxApi/models/common_get_list_v1_response_m_payload.py +++ b/eZmaxApi/models/common_get_list_v1_response_m_payload.py @@ -19,55 +19,73 @@ import json - -from pydantic import BaseModel, Field, StrictInt +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictInt +from pydantic import Field +try: + from typing import Self +except ImportError: + from typing_extensions import Self class CommonGetListV1ResponseMPayload(BaseModel): """ - Generic List Response # noqa: E501 - """ - i_row_returned: StrictInt = Field(..., alias="iRowReturned", description="The number of rows returned") - i_row_filtered: StrictInt = Field(..., alias="iRowFiltered", description="The number of rows matching your filters (if any) or the total number of rows") - __properties = ["iRowReturned", "iRowFiltered"] + Generic List Response + """ # noqa: E501 + i_row_returned: StrictInt = Field(description="The number of rows returned", alias="iRowReturned") + i_row_filtered: StrictInt = Field(description="The number of rows matching your filters (if any) or the total number of rows", alias="iRowFiltered") + __properties: ClassVar[List[str]] = ["iRowReturned", "iRowFiltered"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> CommonGetListV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of CommonGetListV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> CommonGetListV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of CommonGetListV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return CommonGetListV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = CommonGetListV1ResponseMPayload.parse_obj({ - "i_row_returned": obj.get("iRowReturned"), - "i_row_filtered": obj.get("iRowFiltered") + _obj = cls.model_validate({ + "iRowReturned": obj.get("iRowReturned"), + "iRowFiltered": obj.get("iRowFiltered") }) return _obj diff --git a/eZmaxApi/models/common_get_report_v1_response.py b/eZmaxApi/models/common_get_report_v1_response.py index 4f9617acc..c58a79534 100644 --- a/eZmaxApi/models/common_get_report_v1_response.py +++ b/eZmaxApi/models/common_get_report_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_get_report_v1_response_m_payload import CommonGetReportV1ResponseMPayload from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class CommonGetReportV1Response(BaseModel): """ - Response for POST /1/report/xxx/xxx and /1/module/report/getReportFromCache # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: CommonGetReportV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for POST /1/report/xxx/xxx and /1/module/report/getReportFromCache + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: CommonGetReportV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> CommonGetReportV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of CommonGetReportV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> CommonGetReportV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of CommonGetReportV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return CommonGetReportV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = CommonGetReportV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": CommonGetReportV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": CommonGetReportV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/common_get_report_v1_response_m_payload.py b/eZmaxApi/models/common_get_report_v1_response_m_payload.py index a147c3d49..429dc984f 100644 --- a/eZmaxApi/models/common_get_report_v1_response_m_payload.py +++ b/eZmaxApi/models/common_get_report_v1_response_m_payload.py @@ -19,57 +19,75 @@ import json - -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_reportgroup import CommonReportgroup +try: + from typing import Self +except ImportError: + from typing_extensions import Self class CommonGetReportV1ResponseMPayload(BaseModel): """ - Payload for POST /1/report/xxx/xxx and and /1/module/report/getReportFromCache # noqa: E501 - """ - obj_reportgroup: CommonReportgroup = Field(..., alias="objReportgroup") - __properties = ["objReportgroup"] + Payload for POST /1/report/xxx/xxx and and /1/module/report/getReportFromCache + """ # noqa: E501 + obj_reportgroup: CommonReportgroup = Field(alias="objReportgroup") + __properties: ClassVar[List[str]] = ["objReportgroup"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> CommonGetReportV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of CommonGetReportV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_reportgroup if self.obj_reportgroup: _dict['objReportgroup'] = self.obj_reportgroup.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> CommonGetReportV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of CommonGetReportV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return CommonGetReportV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = CommonGetReportV1ResponseMPayload.parse_obj({ - "obj_reportgroup": CommonReportgroup.from_dict(obj.get("objReportgroup")) if obj.get("objReportgroup") is not None else None + _obj = cls.model_validate({ + "objReportgroup": CommonReportgroup.from_dict(obj.get("objReportgroup")) if obj.get("objReportgroup") is not None else None }) return _obj diff --git a/eZmaxApi/models/common_report.py b/eZmaxApi/models/common_report.py index 474a55689..6cd0c905b 100644 --- a/eZmaxApi/models/common_report.py +++ b/eZmaxApi/models/common_report.py @@ -19,41 +19,59 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_reportsection import CommonReportsection +try: + from typing import Self +except ImportError: + from typing_extensions import Self class CommonReport(BaseModel): """ - A Report containing Reportsections # noqa: E501 - """ - a_obj_reportsection: conlist(CommonReportsection) = Field(..., alias="a_objReportsection") - __properties = ["a_objReportsection"] + A Report containing Reportsections + """ # noqa: E501 + a_obj_reportsection: List[CommonReportsection] = Field(alias="a_objReportsection") + __properties: ClassVar[List[str]] = ["a_objReportsection"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> CommonReport: + def from_json(cls, json_str: str) -> Self: """Create an instance of CommonReport from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_reportsection (list) _items = [] if self.a_obj_reportsection: @@ -64,16 +82,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> CommonReport: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of CommonReport from a dict""" if obj is None: return None if not isinstance(obj, dict): - return CommonReport.parse_obj(obj) + return cls.model_validate(obj) - _obj = CommonReport.parse_obj({ - "a_obj_reportsection": [CommonReportsection.from_dict(_item) for _item in obj.get("a_objReportsection")] if obj.get("a_objReportsection") is not None else None + _obj = cls.model_validate({ + "a_objReportsection": [CommonReportsection.from_dict(_item) for _item in obj.get("a_objReportsection")] if obj.get("a_objReportsection") is not None else None }) return _obj diff --git a/eZmaxApi/models/common_reportcell.py b/eZmaxApi/models/common_reportcell.py index b666bccc1..1ac2a43c8 100644 --- a/eZmaxApi/models/common_reportcell.py +++ b/eZmaxApi/models/common_reportcell.py @@ -19,55 +19,73 @@ import json - -from pydantic import BaseModel, Field, StrictInt +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictInt +from pydantic import Field +try: + from typing import Self +except ImportError: + from typing_extensions import Self class CommonReportcell(BaseModel): """ - A cell in a Reportrow # noqa: E501 - """ - i_reportcell_columnspan: StrictInt = Field(..., alias="iReportcellColumnspan", description="The number of Reportcolumns the Reportcell spans") - i_reportcell_rowspan: StrictInt = Field(..., alias="iReportcellRowspan", description="The number of Reportrows the Reportcell spans") - __properties = ["iReportcellColumnspan", "iReportcellRowspan"] + A cell in a Reportrow + """ # noqa: E501 + i_reportcell_columnspan: StrictInt = Field(description="The number of Reportcolumns the Reportcell spans", alias="iReportcellColumnspan") + i_reportcell_rowspan: StrictInt = Field(description="The number of Reportrows the Reportcell spans", alias="iReportcellRowspan") + __properties: ClassVar[List[str]] = ["iReportcellColumnspan", "iReportcellRowspan"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> CommonReportcell: + def from_json(cls, json_str: str) -> Self: """Create an instance of CommonReportcell from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> CommonReportcell: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of CommonReportcell from a dict""" if obj is None: return None if not isinstance(obj, dict): - return CommonReportcell.parse_obj(obj) + return cls.model_validate(obj) - _obj = CommonReportcell.parse_obj({ - "i_reportcell_columnspan": obj.get("iReportcellColumnspan"), - "i_reportcell_rowspan": obj.get("iReportcellRowspan") + _obj = cls.model_validate({ + "iReportcellColumnspan": obj.get("iReportcellColumnspan"), + "iReportcellRowspan": obj.get("iReportcellRowspan") }) return _obj diff --git a/eZmaxApi/models/common_reportcellstyle.py b/eZmaxApi/models/common_reportcellstyle.py index 330b822b7..38beb9385 100644 --- a/eZmaxApi/models/common_reportcellstyle.py +++ b/eZmaxApi/models/common_reportcellstyle.py @@ -19,71 +19,89 @@ import json - -from pydantic import BaseModel, Field, StrictBool +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictBool +from pydantic import Field from eZmaxApi.models.enum_fontunderline import EnumFontunderline from eZmaxApi.models.enum_fontweight import EnumFontweight from eZmaxApi.models.enum_horizontalalignment import EnumHorizontalalignment from eZmaxApi.models.enum_verticalalignment import EnumVerticalalignment +try: + from typing import Self +except ImportError: + from typing_extensions import Self class CommonReportcellstyle(BaseModel): """ - Styles applied to a Reportcell # noqa: E501 - """ - b_reportcellstyle_bordertop: StrictBool = Field(..., alias="bReportcellstyleBordertop", description="Whether there is a border at the top of the Reportcell") - b_reportcellstyle_borderbottom: StrictBool = Field(..., alias="bReportcellstyleBorderbottom", description="Whether there is a border at the bottom of the Reportcell") - b_reportcellstyle_borderleft: StrictBool = Field(..., alias="bReportcellstyleBorderleft", description="Whether there is a border at the left of the Reportcell") - b_reportcellstyle_borderright: StrictBool = Field(..., alias="bReportcellstyleBorderright", description="Whether there is a border at the right of the Reportcell") - e_reportcell_horizontalalignment: EnumHorizontalalignment = Field(..., alias="eReportcellHorizontalalignment") - e_reportcell_verticalalignment: EnumVerticalalignment = Field(..., alias="eReportcellVerticalalignment") - e_reportcell_fontweight: EnumFontweight = Field(..., alias="eReportcellFontweight") - e_reportcell_fontunderline: EnumFontunderline = Field(..., alias="eReportcellFontunderline") - __properties = ["bReportcellstyleBordertop", "bReportcellstyleBorderbottom", "bReportcellstyleBorderleft", "bReportcellstyleBorderright", "eReportcellHorizontalalignment", "eReportcellVerticalalignment", "eReportcellFontweight", "eReportcellFontunderline"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + Styles applied to a Reportcell + """ # noqa: E501 + b_reportcellstyle_bordertop: StrictBool = Field(description="Whether there is a border at the top of the Reportcell", alias="bReportcellstyleBordertop") + b_reportcellstyle_borderbottom: StrictBool = Field(description="Whether there is a border at the bottom of the Reportcell", alias="bReportcellstyleBorderbottom") + b_reportcellstyle_borderleft: StrictBool = Field(description="Whether there is a border at the left of the Reportcell", alias="bReportcellstyleBorderleft") + b_reportcellstyle_borderright: StrictBool = Field(description="Whether there is a border at the right of the Reportcell", alias="bReportcellstyleBorderright") + e_reportcell_horizontalalignment: EnumHorizontalalignment = Field(alias="eReportcellHorizontalalignment") + e_reportcell_verticalalignment: EnumVerticalalignment = Field(alias="eReportcellVerticalalignment") + e_reportcell_fontweight: EnumFontweight = Field(alias="eReportcellFontweight") + e_reportcell_fontunderline: EnumFontunderline = Field(alias="eReportcellFontunderline") + __properties: ClassVar[List[str]] = ["bReportcellstyleBordertop", "bReportcellstyleBorderbottom", "bReportcellstyleBorderleft", "bReportcellstyleBorderright", "eReportcellHorizontalalignment", "eReportcellVerticalalignment", "eReportcellFontweight", "eReportcellFontunderline"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> CommonReportcellstyle: + def from_json(cls, json_str: str) -> Self: """Create an instance of CommonReportcellstyle from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> CommonReportcellstyle: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of CommonReportcellstyle from a dict""" if obj is None: return None if not isinstance(obj, dict): - return CommonReportcellstyle.parse_obj(obj) - - _obj = CommonReportcellstyle.parse_obj({ - "b_reportcellstyle_bordertop": obj.get("bReportcellstyleBordertop"), - "b_reportcellstyle_borderbottom": obj.get("bReportcellstyleBorderbottom"), - "b_reportcellstyle_borderleft": obj.get("bReportcellstyleBorderleft"), - "b_reportcellstyle_borderright": obj.get("bReportcellstyleBorderright"), - "e_reportcell_horizontalalignment": obj.get("eReportcellHorizontalalignment"), - "e_reportcell_verticalalignment": obj.get("eReportcellVerticalalignment"), - "e_reportcell_fontweight": obj.get("eReportcellFontweight"), - "e_reportcell_fontunderline": obj.get("eReportcellFontunderline") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "bReportcellstyleBordertop": obj.get("bReportcellstyleBordertop"), + "bReportcellstyleBorderbottom": obj.get("bReportcellstyleBorderbottom"), + "bReportcellstyleBorderleft": obj.get("bReportcellstyleBorderleft"), + "bReportcellstyleBorderright": obj.get("bReportcellstyleBorderright"), + "eReportcellHorizontalalignment": obj.get("eReportcellHorizontalalignment"), + "eReportcellVerticalalignment": obj.get("eReportcellVerticalalignment"), + "eReportcellFontweight": obj.get("eReportcellFontweight"), + "eReportcellFontunderline": obj.get("eReportcellFontunderline") }) return _obj diff --git a/eZmaxApi/models/common_reportcolumn.py b/eZmaxApi/models/common_reportcolumn.py index 5bfaad5cc..5aebec0d7 100644 --- a/eZmaxApi/models/common_reportcolumn.py +++ b/eZmaxApi/models/common_reportcolumn.py @@ -19,59 +19,77 @@ import json - -from pydantic import BaseModel, Field, StrictInt +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictInt +from pydantic import Field from eZmaxApi.models.common_reportcellstyle import CommonReportcellstyle +try: + from typing import Self +except ImportError: + from typing_extensions import Self class CommonReportcolumn(BaseModel): """ - A column in a Reportsection # noqa: E501 - """ - obj_reportcellstyle_default: CommonReportcellstyle = Field(..., alias="objReportcellstyleDefault") - i_reportcolumn_width: StrictInt = Field(..., alias="iReportcolumnWidth", description="The Reportcolumn width in pixels") - __properties = ["objReportcellstyleDefault", "iReportcolumnWidth"] + A column in a Reportsection + """ # noqa: E501 + obj_reportcellstyle_default: CommonReportcellstyle = Field(alias="objReportcellstyleDefault") + i_reportcolumn_width: StrictInt = Field(description="The Reportcolumn width in pixels", alias="iReportcolumnWidth") + __properties: ClassVar[List[str]] = ["objReportcellstyleDefault", "iReportcolumnWidth"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> CommonReportcolumn: + def from_json(cls, json_str: str) -> Self: """Create an instance of CommonReportcolumn from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_reportcellstyle_default if self.obj_reportcellstyle_default: _dict['objReportcellstyleDefault'] = self.obj_reportcellstyle_default.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> CommonReportcolumn: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of CommonReportcolumn from a dict""" if obj is None: return None if not isinstance(obj, dict): - return CommonReportcolumn.parse_obj(obj) + return cls.model_validate(obj) - _obj = CommonReportcolumn.parse_obj({ - "obj_reportcellstyle_default": CommonReportcellstyle.from_dict(obj.get("objReportcellstyleDefault")) if obj.get("objReportcellstyleDefault") is not None else None, - "i_reportcolumn_width": obj.get("iReportcolumnWidth") + _obj = cls.model_validate({ + "objReportcellstyleDefault": CommonReportcellstyle.from_dict(obj.get("objReportcellstyleDefault")) if obj.get("objReportcellstyleDefault") is not None else None, + "iReportcolumnWidth": obj.get("iReportcolumnWidth") }) return _obj diff --git a/eZmaxApi/models/common_reportgroup.py b/eZmaxApi/models/common_reportgroup.py index 7a0a1b5cf..d328169d4 100644 --- a/eZmaxApi/models/common_reportgroup.py +++ b/eZmaxApi/models/common_reportgroup.py @@ -19,43 +19,61 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_report import CommonReport from eZmaxApi.models.common_reportcellstyle import CommonReportcellstyle +try: + from typing import Self +except ImportError: + from typing_extensions import Self class CommonReportgroup(BaseModel): """ - A group of reports Each Reportgroup is for a specific recipient or for a specific context. # noqa: E501 - """ - a_obj_report: conlist(CommonReport) = Field(..., alias="a_objReport") - a_obj_reportcellstyle_custom: conlist(CommonReportcellstyle) = Field(..., alias="a_objReportcellstyleCustom") - __properties = ["a_objReport", "a_objReportcellstyleCustom"] + A group of reports Each Reportgroup is for a specific recipient or for a specific context. + """ # noqa: E501 + a_obj_report: List[CommonReport] = Field(alias="a_objReport") + a_obj_reportcellstyle_custom: List[CommonReportcellstyle] = Field(alias="a_objReportcellstyleCustom") + __properties: ClassVar[List[str]] = ["a_objReport", "a_objReportcellstyleCustom"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> CommonReportgroup: + def from_json(cls, json_str: str) -> Self: """Create an instance of CommonReportgroup from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_report (list) _items = [] if self.a_obj_report: @@ -73,17 +91,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> CommonReportgroup: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of CommonReportgroup from a dict""" if obj is None: return None if not isinstance(obj, dict): - return CommonReportgroup.parse_obj(obj) + return cls.model_validate(obj) - _obj = CommonReportgroup.parse_obj({ - "a_obj_report": [CommonReport.from_dict(_item) for _item in obj.get("a_objReport")] if obj.get("a_objReport") is not None else None, - "a_obj_reportcellstyle_custom": [CommonReportcellstyle.from_dict(_item) for _item in obj.get("a_objReportcellstyleCustom")] if obj.get("a_objReportcellstyleCustom") is not None else None + _obj = cls.model_validate({ + "a_objReport": [CommonReport.from_dict(_item) for _item in obj.get("a_objReport")] if obj.get("a_objReport") is not None else None, + "a_objReportcellstyleCustom": [CommonReportcellstyle.from_dict(_item) for _item in obj.get("a_objReportcellstyleCustom")] if obj.get("a_objReportcellstyleCustom") is not None else None }) return _obj diff --git a/eZmaxApi/models/common_reportrow.py b/eZmaxApi/models/common_reportrow.py index 2bbc80838..aedc89c17 100644 --- a/eZmaxApi/models/common_reportrow.py +++ b/eZmaxApi/models/common_reportrow.py @@ -19,42 +19,60 @@ import json -from typing import List -from pydantic import BaseModel, Field, StrictInt, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictInt +from pydantic import Field from eZmaxApi.models.common_reportcell import CommonReportcell +try: + from typing import Self +except ImportError: + from typing_extensions import Self class CommonReportrow(BaseModel): """ - A row in a Reportsubsectionpart # noqa: E501 - """ - a_obj_reportcell: conlist(CommonReportcell) = Field(..., alias="a_objReportcell") - i_reportrow_height: StrictInt = Field(..., alias="iReportrowHeight", description="The reportrow height in pixels") - __properties = ["a_objReportcell", "iReportrowHeight"] + A row in a Reportsubsectionpart + """ # noqa: E501 + a_obj_reportcell: List[CommonReportcell] = Field(alias="a_objReportcell") + i_reportrow_height: StrictInt = Field(description="The reportrow height in pixels", alias="iReportrowHeight") + __properties: ClassVar[List[str]] = ["a_objReportcell", "iReportrowHeight"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> CommonReportrow: + def from_json(cls, json_str: str) -> Self: """Create an instance of CommonReportrow from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_reportcell (list) _items = [] if self.a_obj_reportcell: @@ -65,17 +83,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> CommonReportrow: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of CommonReportrow from a dict""" if obj is None: return None if not isinstance(obj, dict): - return CommonReportrow.parse_obj(obj) + return cls.model_validate(obj) - _obj = CommonReportrow.parse_obj({ - "a_obj_reportcell": [CommonReportcell.from_dict(_item) for _item in obj.get("a_objReportcell")] if obj.get("a_objReportcell") is not None else None, - "i_reportrow_height": obj.get("iReportrowHeight") + _obj = cls.model_validate({ + "a_objReportcell": [CommonReportcell.from_dict(_item) for _item in obj.get("a_objReportcell")] if obj.get("a_objReportcell") is not None else None, + "iReportrowHeight": obj.get("iReportrowHeight") }) return _obj diff --git a/eZmaxApi/models/common_reportsection.py b/eZmaxApi/models/common_reportsection.py index 56a954119..d5971e7d7 100644 --- a/eZmaxApi/models/common_reportsection.py +++ b/eZmaxApi/models/common_reportsection.py @@ -19,47 +19,65 @@ import json -from typing import List -from pydantic import BaseModel, Field, StrictInt, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictInt +from pydantic import Field from eZmaxApi.models.common_reportcolumn import CommonReportcolumn from eZmaxApi.models.common_reportsubsection import CommonReportsubsection from eZmaxApi.models.enum_horizontalalignment import EnumHorizontalalignment +try: + from typing import Self +except ImportError: + from typing_extensions import Self class CommonReportsection(BaseModel): """ - A section in a Report. Each Reportsection shares Reportcolumns disposition with all its Reportsubsection # noqa: E501 - """ - a_obj_reportsubsection: conlist(CommonReportsubsection) = Field(..., alias="a_objReportsubsection") - a_obj_reportcolumn: conlist(CommonReportcolumn) = Field(..., alias="a_objReportcolumn") - e_reportsection_horizontalalignment: EnumHorizontalalignment = Field(..., alias="eReportsectionHorizontalalignment") - i_reportsection_columncount: StrictInt = Field(..., alias="iReportsectionColumncount", description="The number of Reportcolumns in the Reportsection") - i_reportsection_width: StrictInt = Field(..., alias="iReportsectionWidth", description="The combined width of all the Reportcolumns in the Reportsection") - __properties = ["a_objReportsubsection", "a_objReportcolumn", "eReportsectionHorizontalalignment", "iReportsectionColumncount", "iReportsectionWidth"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + A section in a Report. Each Reportsection shares Reportcolumns disposition with all its Reportsubsection + """ # noqa: E501 + a_obj_reportsubsection: List[CommonReportsubsection] = Field(alias="a_objReportsubsection") + a_obj_reportcolumn: List[CommonReportcolumn] = Field(alias="a_objReportcolumn") + e_reportsection_horizontalalignment: EnumHorizontalalignment = Field(alias="eReportsectionHorizontalalignment") + i_reportsection_columncount: StrictInt = Field(description="The number of Reportcolumns in the Reportsection", alias="iReportsectionColumncount") + i_reportsection_width: StrictInt = Field(description="The combined width of all the Reportcolumns in the Reportsection", alias="iReportsectionWidth") + __properties: ClassVar[List[str]] = ["a_objReportsubsection", "a_objReportcolumn", "eReportsectionHorizontalalignment", "iReportsectionColumncount", "iReportsectionWidth"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> CommonReportsection: + def from_json(cls, json_str: str) -> Self: """Create an instance of CommonReportsection from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_reportsubsection (list) _items = [] if self.a_obj_reportsubsection: @@ -77,20 +95,20 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> CommonReportsection: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of CommonReportsection from a dict""" if obj is None: return None if not isinstance(obj, dict): - return CommonReportsection.parse_obj(obj) - - _obj = CommonReportsection.parse_obj({ - "a_obj_reportsubsection": [CommonReportsubsection.from_dict(_item) for _item in obj.get("a_objReportsubsection")] if obj.get("a_objReportsubsection") is not None else None, - "a_obj_reportcolumn": [CommonReportcolumn.from_dict(_item) for _item in obj.get("a_objReportcolumn")] if obj.get("a_objReportcolumn") is not None else None, - "e_reportsection_horizontalalignment": obj.get("eReportsectionHorizontalalignment"), - "i_reportsection_columncount": obj.get("iReportsectionColumncount"), - "i_reportsection_width": obj.get("iReportsectionWidth") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "a_objReportsubsection": [CommonReportsubsection.from_dict(_item) for _item in obj.get("a_objReportsubsection")] if obj.get("a_objReportsubsection") is not None else None, + "a_objReportcolumn": [CommonReportcolumn.from_dict(_item) for _item in obj.get("a_objReportcolumn")] if obj.get("a_objReportcolumn") is not None else None, + "eReportsectionHorizontalalignment": obj.get("eReportsectionHorizontalalignment"), + "iReportsectionColumncount": obj.get("iReportsectionColumncount"), + "iReportsectionWidth": obj.get("iReportsectionWidth") }) return _obj diff --git a/eZmaxApi/models/common_reportsubsection.py b/eZmaxApi/models/common_reportsubsection.py index a023251c9..73ac6f7a9 100644 --- a/eZmaxApi/models/common_reportsubsection.py +++ b/eZmaxApi/models/common_reportsubsection.py @@ -19,43 +19,61 @@ import json - -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_reportsubsectionpart import CommonReportsubsectionpart +try: + from typing import Self +except ImportError: + from typing_extensions import Self class CommonReportsubsection(BaseModel): """ - A Subsection in a Reportsection. It contains 3 Reportsubsectionparts (Header, Body and Footer) # noqa: E501 - """ - obj_reportsubsectionpart_header: CommonReportsubsectionpart = Field(..., alias="objReportsubsectionpartHeader") - obj_reportsubsectionpart_body: CommonReportsubsectionpart = Field(..., alias="objReportsubsectionpartBody") - obj_reportsubsectionpart_footer: CommonReportsubsectionpart = Field(..., alias="objReportsubsectionpartFooter") - __properties = ["objReportsubsectionpartHeader", "objReportsubsectionpartBody", "objReportsubsectionpartFooter"] + A Subsection in a Reportsection. It contains 3 Reportsubsectionparts (Header, Body and Footer) + """ # noqa: E501 + obj_reportsubsectionpart_header: CommonReportsubsectionpart = Field(alias="objReportsubsectionpartHeader") + obj_reportsubsectionpart_body: CommonReportsubsectionpart = Field(alias="objReportsubsectionpartBody") + obj_reportsubsectionpart_footer: CommonReportsubsectionpart = Field(alias="objReportsubsectionpartFooter") + __properties: ClassVar[List[str]] = ["objReportsubsectionpartHeader", "objReportsubsectionpartBody", "objReportsubsectionpartFooter"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> CommonReportsubsection: + def from_json(cls, json_str: str) -> Self: """Create an instance of CommonReportsubsection from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_reportsubsectionpart_header if self.obj_reportsubsectionpart_header: _dict['objReportsubsectionpartHeader'] = self.obj_reportsubsectionpart_header.to_dict() @@ -68,18 +86,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> CommonReportsubsection: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of CommonReportsubsection from a dict""" if obj is None: return None if not isinstance(obj, dict): - return CommonReportsubsection.parse_obj(obj) + return cls.model_validate(obj) - _obj = CommonReportsubsection.parse_obj({ - "obj_reportsubsectionpart_header": CommonReportsubsectionpart.from_dict(obj.get("objReportsubsectionpartHeader")) if obj.get("objReportsubsectionpartHeader") is not None else None, - "obj_reportsubsectionpart_body": CommonReportsubsectionpart.from_dict(obj.get("objReportsubsectionpartBody")) if obj.get("objReportsubsectionpartBody") is not None else None, - "obj_reportsubsectionpart_footer": CommonReportsubsectionpart.from_dict(obj.get("objReportsubsectionpartFooter")) if obj.get("objReportsubsectionpartFooter") is not None else None + _obj = cls.model_validate({ + "objReportsubsectionpartHeader": CommonReportsubsectionpart.from_dict(obj.get("objReportsubsectionpartHeader")) if obj.get("objReportsubsectionpartHeader") is not None else None, + "objReportsubsectionpartBody": CommonReportsubsectionpart.from_dict(obj.get("objReportsubsectionpartBody")) if obj.get("objReportsubsectionpartBody") is not None else None, + "objReportsubsectionpartFooter": CommonReportsubsectionpart.from_dict(obj.get("objReportsubsectionpartFooter")) if obj.get("objReportsubsectionpartFooter") is not None else None }) return _obj diff --git a/eZmaxApi/models/common_reportsubsectionpart.py b/eZmaxApi/models/common_reportsubsectionpart.py index a348ea14b..8ae35818e 100644 --- a/eZmaxApi/models/common_reportsubsectionpart.py +++ b/eZmaxApi/models/common_reportsubsectionpart.py @@ -19,49 +19,67 @@ import json -from typing import List -from pydantic import BaseModel, Field, StrictStr, conlist, validator +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictStr, field_validator +from pydantic import Field from eZmaxApi.models.common_reportrow import CommonReportrow +try: + from typing import Self +except ImportError: + from typing_extensions import Self class CommonReportsubsectionpart(BaseModel): """ - A part in the Reportsubsection # noqa: E501 - """ - e_reportsubsectionpart_type: StrictStr = Field(..., alias="eReportsubsectionpartType", description="The type of the Reportsubsectionpart") - a_obj_reportrow: conlist(CommonReportrow) = Field(..., alias="a_objReportrow") - __properties = ["eReportsubsectionpartType", "a_objReportrow"] + A part in the Reportsubsection + """ # noqa: E501 + e_reportsubsectionpart_type: StrictStr = Field(description="The type of the Reportsubsectionpart", alias="eReportsubsectionpartType") + a_obj_reportrow: List[CommonReportrow] = Field(alias="a_objReportrow") + __properties: ClassVar[List[str]] = ["eReportsubsectionpartType", "a_objReportrow"] - @validator('e_reportsubsectionpart_type') + @field_validator('e_reportsubsectionpart_type') def e_reportsubsectionpart_type_validate_enum(cls, value): """Validates the enum""" if value not in ('Header', 'Body', 'Footer'): raise ValueError("must be one of enum values ('Header', 'Body', 'Footer')") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> CommonReportsubsectionpart: + def from_json(cls, json_str: str) -> Self: """Create an instance of CommonReportsubsectionpart from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_reportrow (list) _items = [] if self.a_obj_reportrow: @@ -72,17 +90,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> CommonReportsubsectionpart: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of CommonReportsubsectionpart from a dict""" if obj is None: return None if not isinstance(obj, dict): - return CommonReportsubsectionpart.parse_obj(obj) + return cls.model_validate(obj) - _obj = CommonReportsubsectionpart.parse_obj({ - "e_reportsubsectionpart_type": obj.get("eReportsubsectionpartType"), - "a_obj_reportrow": [CommonReportrow.from_dict(_item) for _item in obj.get("a_objReportrow")] if obj.get("a_objReportrow") is not None else None + _obj = cls.model_validate({ + "eReportsubsectionpartType": obj.get("eReportsubsectionpartType"), + "a_objReportrow": [CommonReportrow.from_dict(_item) for _item in obj.get("a_objReportrow")] if obj.get("a_objReportrow") is not None else None }) return _obj diff --git a/eZmaxApi/models/common_response.py b/eZmaxApi/models/common_response.py index e7e81ec85..39475bbdc 100644 --- a/eZmaxApi/models/common_response.py +++ b/eZmaxApi/models/common_response.py @@ -19,43 +19,61 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class CommonResponse(BaseModel): """ - All API response will inherit this based Response # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - __properties = ["objDebugPayload", "objDebug"] + All API response will inherit this based Response + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> CommonResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of CommonResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -65,17 +83,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> CommonResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of CommonResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return CommonResponse.parse_obj(obj) + return cls.model_validate(obj) - _obj = CommonResponse.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None }) return _obj diff --git a/eZmaxApi/models/common_response_error.py b/eZmaxApi/models/common_response_error.py index f20f7213b..741f1d10b 100644 --- a/eZmaxApi/models/common_response_error.py +++ b/eZmaxApi/models/common_response_error.py @@ -19,63 +19,82 @@ import json - -from pydantic import BaseModel, Field, constr, validator +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, field_validator +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.field_e_error_code import FieldEErrorCode +try: + from typing import Self +except ImportError: + from typing_extensions import Self class CommonResponseError(BaseModel): """ - Generic Error Message # noqa: E501 - """ - s_error_message: constr(strict=True) = Field(..., alias="sErrorMessage", description="The message giving details about the error") - e_error_code: FieldEErrorCode = Field(..., alias="eErrorCode") - __properties = ["sErrorMessage", "eErrorCode"] + Generic Error Message + """ # noqa: E501 + s_error_message: Annotated[str, Field(strict=True)] = Field(description="The message giving details about the error", alias="sErrorMessage") + e_error_code: FieldEErrorCode = Field(alias="eErrorCode") + __properties: ClassVar[List[str]] = ["sErrorMessage", "eErrorCode"] - @validator('s_error_message') + @field_validator('s_error_message') def s_error_message_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^.{0,500}$", value): raise ValueError(r"must validate the regular expression /^.{0,500}$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> CommonResponseError: + def from_json(cls, json_str: str) -> Self: """Create an instance of CommonResponseError from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> CommonResponseError: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of CommonResponseError from a dict""" if obj is None: return None if not isinstance(obj, dict): - return CommonResponseError.parse_obj(obj) + return cls.model_validate(obj) - _obj = CommonResponseError.parse_obj({ - "s_error_message": obj.get("sErrorMessage"), - "e_error_code": obj.get("eErrorCode") + _obj = cls.model_validate({ + "sErrorMessage": obj.get("sErrorMessage"), + "eErrorCode": obj.get("eErrorCode") }) return _obj diff --git a/eZmaxApi/models/common_response_error_ezsignform_validation.py b/eZmaxApi/models/common_response_error_ezsignform_validation.py index 4fea1ef5f..5e57e84fd 100644 --- a/eZmaxApi/models/common_response_error_ezsignform_validation.py +++ b/eZmaxApi/models/common_response_error_ezsignform_validation.py @@ -19,51 +19,70 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist, constr, validator +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, field_validator +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.custom_ezsignformfielderror_response import CustomEzsignformfielderrorResponse from eZmaxApi.models.field_e_error_code import FieldEErrorCode +try: + from typing import Self +except ImportError: + from typing_extensions import Self class CommonResponseErrorEzsignformValidation(BaseModel): """ - Generic Error Message # noqa: E501 - """ - s_error_message: constr(strict=True) = Field(..., alias="sErrorMessage", description="The message giving details about the error") - e_error_code: FieldEErrorCode = Field(..., alias="eErrorCode") - a_obj_ezsignformfielderror: conlist(CustomEzsignformfielderrorResponse) = Field(..., alias="a_objEzsignformfielderror") - __properties = ["sErrorMessage", "eErrorCode", "a_objEzsignformfielderror"] - - @validator('s_error_message') + Generic Error Message + """ # noqa: E501 + s_error_message: Annotated[str, Field(strict=True)] = Field(description="The message giving details about the error", alias="sErrorMessage") + e_error_code: FieldEErrorCode = Field(alias="eErrorCode") + a_obj_ezsignformfielderror: List[CustomEzsignformfielderrorResponse] = Field(alias="a_objEzsignformfielderror") + __properties: ClassVar[List[str]] = ["sErrorMessage", "eErrorCode", "a_objEzsignformfielderror"] + + @field_validator('s_error_message') def s_error_message_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^.{0,500}$", value): raise ValueError(r"must validate the regular expression /^.{0,500}$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> CommonResponseErrorEzsignformValidation: + def from_json(cls, json_str: str) -> Self: """Create an instance of CommonResponseErrorEzsignformValidation from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_ezsignformfielderror (list) _items = [] if self.a_obj_ezsignformfielderror: @@ -74,18 +93,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> CommonResponseErrorEzsignformValidation: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of CommonResponseErrorEzsignformValidation from a dict""" if obj is None: return None if not isinstance(obj, dict): - return CommonResponseErrorEzsignformValidation.parse_obj(obj) + return cls.model_validate(obj) - _obj = CommonResponseErrorEzsignformValidation.parse_obj({ - "s_error_message": obj.get("sErrorMessage"), - "e_error_code": obj.get("eErrorCode"), - "a_obj_ezsignformfielderror": [CustomEzsignformfielderrorResponse.from_dict(_item) for _item in obj.get("a_objEzsignformfielderror")] if obj.get("a_objEzsignformfielderror") is not None else None + _obj = cls.model_validate({ + "sErrorMessage": obj.get("sErrorMessage"), + "eErrorCode": obj.get("eErrorCode"), + "a_objEzsignformfielderror": [CustomEzsignformfielderrorResponse.from_dict(_item) for _item in obj.get("a_objEzsignformfielderror")] if obj.get("a_objEzsignformfielderror") is not None else None }) return _obj diff --git a/eZmaxApi/models/common_response_error_s_temporary_file_url.py b/eZmaxApi/models/common_response_error_s_temporary_file_url.py index 01af710c8..bdd23f830 100644 --- a/eZmaxApi/models/common_response_error_s_temporary_file_url.py +++ b/eZmaxApi/models/common_response_error_s_temporary_file_url.py @@ -19,65 +19,84 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictStr, constr, validator +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictStr, field_validator +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.field_e_error_code import FieldEErrorCode +try: + from typing import Self +except ImportError: + from typing_extensions import Self class CommonResponseErrorSTemporaryFileUrl(BaseModel): """ - Generic Error Message # noqa: E501 - """ - s_error_message: constr(strict=True) = Field(..., alias="sErrorMessage", description="The message giving details about the error") - e_error_code: FieldEErrorCode = Field(..., alias="eErrorCode") - s_temporary_file_url: Optional[StrictStr] = Field(None, alias="sTemporaryFileUrl", description="The Temporary File Url of the document that was uploaded. That url can be reused instead of uploading the file again.") - __properties = ["sErrorMessage", "eErrorCode", "sTemporaryFileUrl"] - - @validator('s_error_message') + Generic Error Message + """ # noqa: E501 + s_error_message: Annotated[str, Field(strict=True)] = Field(description="The message giving details about the error", alias="sErrorMessage") + e_error_code: FieldEErrorCode = Field(alias="eErrorCode") + s_temporary_file_url: Optional[StrictStr] = Field(default=None, description="The Temporary File Url of the document that was uploaded. That url can be reused instead of uploading the file again.", alias="sTemporaryFileUrl") + __properties: ClassVar[List[str]] = ["sErrorMessage", "eErrorCode", "sTemporaryFileUrl"] + + @field_validator('s_error_message') def s_error_message_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^.{0,500}$", value): raise ValueError(r"must validate the regular expression /^.{0,500}$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> CommonResponseErrorSTemporaryFileUrl: + def from_json(cls, json_str: str) -> Self: """Create an instance of CommonResponseErrorSTemporaryFileUrl from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> CommonResponseErrorSTemporaryFileUrl: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of CommonResponseErrorSTemporaryFileUrl from a dict""" if obj is None: return None if not isinstance(obj, dict): - return CommonResponseErrorSTemporaryFileUrl.parse_obj(obj) + return cls.model_validate(obj) - _obj = CommonResponseErrorSTemporaryFileUrl.parse_obj({ - "s_error_message": obj.get("sErrorMessage"), - "e_error_code": obj.get("eErrorCode"), - "s_temporary_file_url": obj.get("sTemporaryFileUrl") + _obj = cls.model_validate({ + "sErrorMessage": obj.get("sErrorMessage"), + "eErrorCode": obj.get("eErrorCode"), + "sTemporaryFileUrl": obj.get("sTemporaryFileUrl") }) return _obj diff --git a/eZmaxApi/models/common_response_error_too_many_requests.py b/eZmaxApi/models/common_response_error_too_many_requests.py index ea77d292e..45de41d0a 100644 --- a/eZmaxApi/models/common_response_error_too_many_requests.py +++ b/eZmaxApi/models/common_response_error_too_many_requests.py @@ -19,63 +19,82 @@ import json - -from pydantic import BaseModel, Field, constr, validator +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, field_validator +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.field_e_error_code import FieldEErrorCode +try: + from typing import Self +except ImportError: + from typing_extensions import Self class CommonResponseErrorTooManyRequests(BaseModel): """ - Generic Error Message # noqa: E501 - """ - s_error_message: constr(strict=True) = Field(..., alias="sErrorMessage", description="The message giving details about the error") - e_error_code: FieldEErrorCode = Field(..., alias="eErrorCode") - __properties = ["sErrorMessage", "eErrorCode"] + Generic Error Message + """ # noqa: E501 + s_error_message: Annotated[str, Field(strict=True)] = Field(description="The message giving details about the error", alias="sErrorMessage") + e_error_code: FieldEErrorCode = Field(alias="eErrorCode") + __properties: ClassVar[List[str]] = ["sErrorMessage", "eErrorCode"] - @validator('s_error_message') + @field_validator('s_error_message') def s_error_message_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^.{0,500}$", value): raise ValueError(r"must validate the regular expression /^.{0,500}$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> CommonResponseErrorTooManyRequests: + def from_json(cls, json_str: str) -> Self: """Create an instance of CommonResponseErrorTooManyRequests from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> CommonResponseErrorTooManyRequests: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of CommonResponseErrorTooManyRequests from a dict""" if obj is None: return None if not isinstance(obj, dict): - return CommonResponseErrorTooManyRequests.parse_obj(obj) + return cls.model_validate(obj) - _obj = CommonResponseErrorTooManyRequests.parse_obj({ - "s_error_message": obj.get("sErrorMessage"), - "e_error_code": obj.get("eErrorCode") + _obj = cls.model_validate({ + "sErrorMessage": obj.get("sErrorMessage"), + "eErrorCode": obj.get("eErrorCode") }) return _obj diff --git a/eZmaxApi/models/common_response_filter.py b/eZmaxApi/models/common_response_filter.py index 65e8393c6..619d7a72e 100644 --- a/eZmaxApi/models/common_response_filter.py +++ b/eZmaxApi/models/common_response_filter.py @@ -19,57 +19,75 @@ import json -from typing import Dict, Optional -from pydantic import BaseModel, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictStr +from pydantic import Field +try: + from typing import Self +except ImportError: + from typing_extensions import Self class CommonResponseFilter(BaseModel): """ - Definition of Filters for getList # noqa: E501 - """ - a_auto_type: Optional[Dict[str, StrictStr]] = Field(None, alias="a_AutoType", description="List of filters that can be used in *sFilter* (Automatic types)") - a_auto_type_having: Optional[Dict[str, StrictStr]] = Field(None, alias="a_AutoTypeHaving", description="List of computed filters that can be used in *sFilter* (Automatic types)") - a_enum: Optional[Dict[str, Dict[str, StrictStr]]] = Field(None, alias="a_Enum", description="List of filters that can be used in *sFilter* (Enum types)") - __properties = ["a_AutoType", "a_AutoTypeHaving", "a_Enum"] + Definition of Filters for getList + """ # noqa: E501 + a_auto_type: Optional[Dict[str, StrictStr]] = Field(default=None, description="List of filters that can be used in *sFilter* (Automatic types)", alias="a_AutoType") + a_auto_type_having: Optional[Dict[str, StrictStr]] = Field(default=None, description="List of computed filters that can be used in *sFilter* (Automatic types)", alias="a_AutoTypeHaving") + a_enum: Optional[Dict[str, Dict[str, StrictStr]]] = Field(default=None, description="List of filters that can be used in *sFilter* (Enum types)", alias="a_Enum") + __properties: ClassVar[List[str]] = ["a_AutoType", "a_AutoTypeHaving", "a_Enum"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> CommonResponseFilter: + def from_json(cls, json_str: str) -> Self: """Create an instance of CommonResponseFilter from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> CommonResponseFilter: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of CommonResponseFilter from a dict""" if obj is None: return None if not isinstance(obj, dict): - return CommonResponseFilter.parse_obj(obj) + return cls.model_validate(obj) - _obj = CommonResponseFilter.parse_obj({ - "a_auto_type": obj.get("a_AutoType"), - "a_auto_type_having": obj.get("a_AutoTypeHaving"), - "a_enum": obj.get("a_Enum") + _obj = cls.model_validate({ + "a_AutoType": obj.get("a_AutoType"), + "a_AutoTypeHaving": obj.get("a_AutoTypeHaving"), + "a_Enum": obj.get("a_Enum") }) return _obj diff --git a/eZmaxApi/models/common_response_get_list.py b/eZmaxApi/models/common_response_get_list.py index 5afbcbb6f..84a6375ab 100644 --- a/eZmaxApi/models/common_response_get_list.py +++ b/eZmaxApi/models/common_response_get_list.py @@ -19,43 +19,61 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload_get_list import CommonResponseObjDebugPayloadGetList +try: + from typing import Self +except ImportError: + from typing_extensions import Self class CommonResponseGetList(BaseModel): """ - All API response will inherit this based Response # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayloadGetList = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - __properties = ["objDebugPayload", "objDebug"] + All API response will inherit this based Response + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayloadGetList = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> CommonResponseGetList: + def from_json(cls, json_str: str) -> Self: """Create an instance of CommonResponseGetList from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -65,17 +83,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> CommonResponseGetList: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of CommonResponseGetList from a dict""" if obj is None: return None if not isinstance(obj, dict): - return CommonResponseGetList.parse_obj(obj) + return cls.model_validate(obj) - _obj = CommonResponseGetList.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayloadGetList.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayloadGetList.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None }) return _obj diff --git a/eZmaxApi/models/common_response_obj_debug.py b/eZmaxApi/models/common_response_obj_debug.py index fe95a82c1..200bf4e1d 100644 --- a/eZmaxApi/models/common_response_obj_debug.py +++ b/eZmaxApi/models/common_response_obj_debug.py @@ -19,45 +19,63 @@ import json -from typing import List -from pydantic import BaseModel, Field, StrictInt, StrictStr, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictInt, StrictStr +from pydantic import Field from eZmaxApi.models.common_response_obj_sql_query import CommonResponseObjSQLQuery +try: + from typing import Self +except ImportError: + from typing_extensions import Self class CommonResponseObjDebug(BaseModel): """ - This is a generic debug object that is returned by all API requests # noqa: E501 - """ - s_memory_usage: StrictStr = Field(..., alias="sMemoryUsage", description="The peak memory allocated during the API request execution. Formatted as a human readable string") - s_run_time: StrictStr = Field(..., alias="sRunTime", description="The total server execution time of the API request execution. Formatted as a human readable string") - i_sql_selects: StrictInt = Field(..., alias="iSQLSelects", description="The number of SQL SELECT queries that were sent to the database server during the API request execution") - i_sql_queries: StrictInt = Field(..., alias="iSQLQueries", description="The number of SQL INSERT/UPDATE/DELETE queries that were sent to the database server during the API request execution") - a_obj_sql_query: conlist(CommonResponseObjSQLQuery) = Field(..., alias="a_objSQLQuery", description="An array of the SQL Queries that were executed during the API request execution") - __properties = ["sMemoryUsage", "sRunTime", "iSQLSelects", "iSQLQueries", "a_objSQLQuery"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + This is a generic debug object that is returned by all API requests + """ # noqa: E501 + s_memory_usage: StrictStr = Field(description="The peak memory allocated during the API request execution. Formatted as a human readable string", alias="sMemoryUsage") + s_run_time: StrictStr = Field(description="The total server execution time of the API request execution. Formatted as a human readable string", alias="sRunTime") + i_sql_selects: StrictInt = Field(description="The number of SQL SELECT queries that were sent to the database server during the API request execution", alias="iSQLSelects") + i_sql_queries: StrictInt = Field(description="The number of SQL INSERT/UPDATE/DELETE queries that were sent to the database server during the API request execution", alias="iSQLQueries") + a_obj_sql_query: List[CommonResponseObjSQLQuery] = Field(description="An array of the SQL Queries that were executed during the API request execution", alias="a_objSQLQuery") + __properties: ClassVar[List[str]] = ["sMemoryUsage", "sRunTime", "iSQLSelects", "iSQLQueries", "a_objSQLQuery"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> CommonResponseObjDebug: + def from_json(cls, json_str: str) -> Self: """Create an instance of CommonResponseObjDebug from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_sql_query (list) _items = [] if self.a_obj_sql_query: @@ -68,20 +86,20 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> CommonResponseObjDebug: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of CommonResponseObjDebug from a dict""" if obj is None: return None if not isinstance(obj, dict): - return CommonResponseObjDebug.parse_obj(obj) - - _obj = CommonResponseObjDebug.parse_obj({ - "s_memory_usage": obj.get("sMemoryUsage"), - "s_run_time": obj.get("sRunTime"), - "i_sql_selects": obj.get("iSQLSelects"), - "i_sql_queries": obj.get("iSQLQueries"), - "a_obj_sql_query": [CommonResponseObjSQLQuery.from_dict(_item) for _item in obj.get("a_objSQLQuery")] if obj.get("a_objSQLQuery") is not None else None + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "sMemoryUsage": obj.get("sMemoryUsage"), + "sRunTime": obj.get("sRunTime"), + "iSQLSelects": obj.get("iSQLSelects"), + "iSQLQueries": obj.get("iSQLQueries"), + "a_objSQLQuery": [CommonResponseObjSQLQuery.from_dict(_item) for _item in obj.get("a_objSQLQuery")] if obj.get("a_objSQLQuery") is not None else None }) return _obj diff --git a/eZmaxApi/models/common_response_obj_debug_payload.py b/eZmaxApi/models/common_response_obj_debug_payload.py index 9087f2a42..a76f07343 100644 --- a/eZmaxApi/models/common_response_obj_debug_payload.py +++ b/eZmaxApi/models/common_response_obj_debug_payload.py @@ -19,59 +19,77 @@ import json -from typing import List -from pydantic import BaseModel, Field, StrictBool, StrictInt, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictBool, StrictInt +from pydantic import Field +try: + from typing import Self +except ImportError: + from typing_extensions import Self class CommonResponseObjDebugPayload(BaseModel): """ - This is a debug object containing debugging information on the actual function # noqa: E501 - """ - i_version_min: StrictInt = Field(..., alias="iVersionMin", description="The minimum version of the function that can be called") - i_version_max: StrictInt = Field(..., alias="iVersionMax", description="The maximum version of the function that can be called") - a_required_permission: conlist(StrictInt) = Field(..., alias="a_RequiredPermission", description="An array of permissions required to access this function. If the value \"0\" is present in the array, anyone can call this function. You must have one of the permission to access the function. You don't need to have all of them.") - b_version_deprecated: StrictBool = Field(..., alias="bVersionDeprecated", description="Wheter the current route is deprecated or not") - __properties = ["iVersionMin", "iVersionMax", "a_RequiredPermission", "bVersionDeprecated"] + This is a debug object containing debugging information on the actual function + """ # noqa: E501 + i_version_min: StrictInt = Field(description="The minimum version of the function that can be called", alias="iVersionMin") + i_version_max: StrictInt = Field(description="The maximum version of the function that can be called", alias="iVersionMax") + a_required_permission: List[StrictInt] = Field(description="An array of permissions required to access this function. If the value \"0\" is present in the array, anyone can call this function. You must have one of the permission to access the function. You don't need to have all of them.", alias="a_RequiredPermission") + b_version_deprecated: StrictBool = Field(description="Wheter the current route is deprecated or not", alias="bVersionDeprecated") + __properties: ClassVar[List[str]] = ["iVersionMin", "iVersionMax", "a_RequiredPermission", "bVersionDeprecated"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> CommonResponseObjDebugPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of CommonResponseObjDebugPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> CommonResponseObjDebugPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of CommonResponseObjDebugPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return CommonResponseObjDebugPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = CommonResponseObjDebugPayload.parse_obj({ - "i_version_min": obj.get("iVersionMin"), - "i_version_max": obj.get("iVersionMax"), - "a_required_permission": obj.get("a_RequiredPermission"), - "b_version_deprecated": obj.get("bVersionDeprecated") + _obj = cls.model_validate({ + "iVersionMin": obj.get("iVersionMin"), + "iVersionMax": obj.get("iVersionMax"), + "a_RequiredPermission": obj.get("a_RequiredPermission"), + "bVersionDeprecated": obj.get("bVersionDeprecated") }) return _obj diff --git a/eZmaxApi/models/common_response_obj_debug_payload_get_list.py b/eZmaxApi/models/common_response_obj_debug_payload_get_list.py index 94e713b27..9b9b1fc86 100644 --- a/eZmaxApi/models/common_response_obj_debug_payload_get_list.py +++ b/eZmaxApi/models/common_response_obj_debug_payload_get_list.py @@ -19,71 +19,90 @@ import json -from typing import Dict, List -from pydantic import BaseModel, Field, StrictBool, StrictInt, StrictStr, conint, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictBool, StrictInt, StrictStr +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.common_response_filter import CommonResponseFilter +try: + from typing import Self +except ImportError: + from typing_extensions import Self class CommonResponseObjDebugPayloadGetList(BaseModel): """ - This is a debug object containing debugging information on the actual function # noqa: E501 - """ - i_version_min: StrictInt = Field(..., alias="iVersionMin", description="The minimum version of the function that can be called") - i_version_max: StrictInt = Field(..., alias="iVersionMax", description="The maximum version of the function that can be called") - a_required_permission: conlist(StrictInt) = Field(..., alias="a_RequiredPermission", description="An array of permissions required to access this function. If the value \"0\" is present in the array, anyone can call this function. You must have one of the permission to access the function. You don't need to have all of them.") - b_version_deprecated: StrictBool = Field(..., alias="bVersionDeprecated", description="Wheter the current route is deprecated or not") - a_filter: CommonResponseFilter = Field(..., alias="a_Filter") - a_order_by: Dict[str, StrictStr] = Field(..., alias="a_OrderBy", description="List of available values for *eOrderBy*") - i_row_max: conint(strict=True, le=10000, ge=1) = Field(..., alias="iRowMax", description="The maximum numbers of results to be returned. When the content-type is **application/json** there is an implicit default of 10 000. When it's **application/vnd.openxmlformats-officedocument.spreadsheetml.sheet** the is no implicit default so if you do not specify iRowMax, all records will be returned.") - i_row_offset: conint(strict=True, ge=0) = Field(..., alias="iRowOffset", description="The starting element from where to start retrieving the results. For example if you started at iRowOffset=0 and asked for iRowMax=100, to get the next 100 results, you could specify iRowOffset=100&iRowMax=100,") - __properties = ["iVersionMin", "iVersionMax", "a_RequiredPermission", "bVersionDeprecated", "a_Filter", "a_OrderBy", "iRowMax", "iRowOffset"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + This is a debug object containing debugging information on the actual function + """ # noqa: E501 + i_version_min: StrictInt = Field(description="The minimum version of the function that can be called", alias="iVersionMin") + i_version_max: StrictInt = Field(description="The maximum version of the function that can be called", alias="iVersionMax") + a_required_permission: List[StrictInt] = Field(description="An array of permissions required to access this function. If the value \"0\" is present in the array, anyone can call this function. You must have one of the permission to access the function. You don't need to have all of them.", alias="a_RequiredPermission") + b_version_deprecated: StrictBool = Field(description="Wheter the current route is deprecated or not", alias="bVersionDeprecated") + a_filter: CommonResponseFilter = Field(alias="a_Filter") + a_order_by: Dict[str, StrictStr] = Field(description="List of available values for *eOrderBy*", alias="a_OrderBy") + i_row_max: Annotated[int, Field(le=10000, strict=True, ge=1)] = Field(description="The maximum numbers of results to be returned. When the content-type is **application/json** there is an implicit default of 10 000. When it's **application/vnd.openxmlformats-officedocument.spreadsheetml.sheet** the is no implicit default so if you do not specify iRowMax, all records will be returned.", alias="iRowMax") + i_row_offset: Annotated[int, Field(strict=True, ge=0)] = Field(description="The starting element from where to start retrieving the results. For example if you started at iRowOffset=0 and asked for iRowMax=100, to get the next 100 results, you could specify iRowOffset=100&iRowMax=100,", alias="iRowOffset") + __properties: ClassVar[List[str]] = ["iVersionMin", "iVersionMax", "a_RequiredPermission", "bVersionDeprecated", "a_Filter", "a_OrderBy", "iRowMax", "iRowOffset"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> CommonResponseObjDebugPayloadGetList: + def from_json(cls, json_str: str) -> Self: """Create an instance of CommonResponseObjDebugPayloadGetList from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of a_filter if self.a_filter: _dict['a_Filter'] = self.a_filter.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> CommonResponseObjDebugPayloadGetList: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of CommonResponseObjDebugPayloadGetList from a dict""" if obj is None: return None if not isinstance(obj, dict): - return CommonResponseObjDebugPayloadGetList.parse_obj(obj) - - _obj = CommonResponseObjDebugPayloadGetList.parse_obj({ - "i_version_min": obj.get("iVersionMin"), - "i_version_max": obj.get("iVersionMax"), - "a_required_permission": obj.get("a_RequiredPermission"), - "b_version_deprecated": obj.get("bVersionDeprecated"), - "a_filter": CommonResponseFilter.from_dict(obj.get("a_Filter")) if obj.get("a_Filter") is not None else None, - "a_order_by": obj.get("a_OrderBy"), - "i_row_max": obj.get("iRowMax"), - "i_row_offset": obj.get("iRowOffset") if obj.get("iRowOffset") is not None else 0 + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "iVersionMin": obj.get("iVersionMin"), + "iVersionMax": obj.get("iVersionMax"), + "a_RequiredPermission": obj.get("a_RequiredPermission"), + "bVersionDeprecated": obj.get("bVersionDeprecated"), + "a_Filter": CommonResponseFilter.from_dict(obj.get("a_Filter")) if obj.get("a_Filter") is not None else None, + "a_OrderBy": obj.get("a_OrderBy"), + "iRowMax": obj.get("iRowMax"), + "iRowOffset": obj.get("iRowOffset") if obj.get("iRowOffset") is not None else 0 }) return _obj diff --git a/eZmaxApi/models/common_response_obj_sql_query.py b/eZmaxApi/models/common_response_obj_sql_query.py index 38894727c..73e66fa61 100644 --- a/eZmaxApi/models/common_response_obj_sql_query.py +++ b/eZmaxApi/models/common_response_obj_sql_query.py @@ -19,55 +19,73 @@ import json -from typing import Union -from pydantic import BaseModel, Field, StrictFloat, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Union +from pydantic import BaseModel, StrictFloat, StrictInt, StrictStr +from pydantic import Field +try: + from typing import Self +except ImportError: + from typing_extensions import Self class CommonResponseObjSQLQuery(BaseModel): """ - Definition of objSQLQuery Object # noqa: E501 - """ - s_query: StrictStr = Field(..., alias="sQuery", description="The SQL Query") - f_duration: Union[StrictFloat, StrictInt] = Field(..., alias="fDuration", description="Execution time of the SQL Query in seconds") - __properties = ["sQuery", "fDuration"] + Definition of objSQLQuery Object + """ # noqa: E501 + s_query: StrictStr = Field(description="The SQL Query", alias="sQuery") + f_duration: Union[StrictFloat, StrictInt] = Field(description="Execution time of the SQL Query in seconds", alias="fDuration") + __properties: ClassVar[List[str]] = ["sQuery", "fDuration"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> CommonResponseObjSQLQuery: + def from_json(cls, json_str: str) -> Self: """Create an instance of CommonResponseObjSQLQuery from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> CommonResponseObjSQLQuery: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of CommonResponseObjSQLQuery from a dict""" if obj is None: return None if not isinstance(obj, dict): - return CommonResponseObjSQLQuery.parse_obj(obj) + return cls.model_validate(obj) - _obj = CommonResponseObjSQLQuery.parse_obj({ - "s_query": obj.get("sQuery"), - "f_duration": obj.get("fDuration") + _obj = cls.model_validate({ + "sQuery": obj.get("sQuery"), + "fDuration": obj.get("fDuration") }) return _obj diff --git a/eZmaxApi/models/common_response_redirect_s_secretquestion_text_x.py b/eZmaxApi/models/common_response_redirect_s_secretquestion_text_x.py index c6f15e45a..07fabd4e0 100644 --- a/eZmaxApi/models/common_response_redirect_s_secretquestion_text_x.py +++ b/eZmaxApi/models/common_response_redirect_s_secretquestion_text_x.py @@ -19,53 +19,71 @@ import json - -from pydantic import BaseModel, Field, StrictStr +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictStr +from pydantic import Field +try: + from typing import Self +except ImportError: + from typing_extensions import Self class CommonResponseRedirectSSecretquestionTextX(BaseModel): """ - 352 Redirect Message containing secret question # noqa: E501 - """ - s_secretquestion_text_x: StrictStr = Field(..., alias="sSecretquestionTextX", description="The text of the Secretquestion in the language of the requester") - __properties = ["sSecretquestionTextX"] + 352 Redirect Message containing secret question + """ # noqa: E501 + s_secretquestion_text_x: StrictStr = Field(description="The text of the Secretquestion in the language of the requester", alias="sSecretquestionTextX") + __properties: ClassVar[List[str]] = ["sSecretquestionTextX"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> CommonResponseRedirectSSecretquestionTextX: + def from_json(cls, json_str: str) -> Self: """Create an instance of CommonResponseRedirectSSecretquestionTextX from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> CommonResponseRedirectSSecretquestionTextX: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of CommonResponseRedirectSSecretquestionTextX from a dict""" if obj is None: return None if not isinstance(obj, dict): - return CommonResponseRedirectSSecretquestionTextX.parse_obj(obj) + return cls.model_validate(obj) - _obj = CommonResponseRedirectSSecretquestionTextX.parse_obj({ - "s_secretquestion_text_x": obj.get("sSecretquestionTextX") + _obj = cls.model_validate({ + "sSecretquestionTextX": obj.get("sSecretquestionTextX") }) return _obj diff --git a/eZmaxApi/models/common_response_warning.py b/eZmaxApi/models/common_response_warning.py index 725fe9930..d4412bd34 100644 --- a/eZmaxApi/models/common_response_warning.py +++ b/eZmaxApi/models/common_response_warning.py @@ -19,55 +19,73 @@ import json - -from pydantic import BaseModel, Field, StrictStr +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictStr +from pydantic import Field +try: + from typing import Self +except ImportError: + from typing_extensions import Self class CommonResponseWarning(BaseModel): """ - Generic Warning Message # noqa: E501 - """ - s_warning_message: StrictStr = Field(..., alias="sWarningMessage", description="More detail about the warning") - e_warning_code: StrictStr = Field(..., alias="eWarningCode", description="The warning code. See documentation for valid values") - __properties = ["sWarningMessage", "eWarningCode"] + Generic Warning Message + """ # noqa: E501 + s_warning_message: StrictStr = Field(description="More detail about the warning", alias="sWarningMessage") + e_warning_code: StrictStr = Field(description="The warning code. See documentation for valid values", alias="eWarningCode") + __properties: ClassVar[List[str]] = ["sWarningMessage", "eWarningCode"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> CommonResponseWarning: + def from_json(cls, json_str: str) -> Self: """Create an instance of CommonResponseWarning from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> CommonResponseWarning: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of CommonResponseWarning from a dict""" if obj is None: return None if not isinstance(obj, dict): - return CommonResponseWarning.parse_obj(obj) + return cls.model_validate(obj) - _obj = CommonResponseWarning.parse_obj({ - "s_warning_message": obj.get("sWarningMessage"), - "e_warning_code": obj.get("eWarningCode") + _obj = cls.model_validate({ + "sWarningMessage": obj.get("sWarningMessage"), + "eWarningCode": obj.get("eWarningCode") }) return _obj diff --git a/eZmaxApi/models/common_webhook.py b/eZmaxApi/models/common_webhook.py index 617ef701b..557971189 100644 --- a/eZmaxApi/models/common_webhook.py +++ b/eZmaxApi/models/common_webhook.py @@ -19,43 +19,61 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.attempt_response_compound import AttemptResponseCompound from eZmaxApi.models.custom_webhook_response import CustomWebhookResponse +try: + from typing import Self +except ImportError: + from typing_extensions import Self class CommonWebhook(BaseModel): """ - This is the base Webhook object # noqa: E501 - """ - obj_webhook: CustomWebhookResponse = Field(..., alias="objWebhook") - a_obj_attempt: conlist(AttemptResponseCompound) = Field(..., alias="a_objAttempt", description="An array containing details of previous attempts that were made to deliver the message. The array is empty if it's the first attempt.") - __properties = ["objWebhook", "a_objAttempt"] + This is the base Webhook object + """ # noqa: E501 + obj_webhook: CustomWebhookResponse = Field(alias="objWebhook") + a_obj_attempt: List[AttemptResponseCompound] = Field(description="An array containing details of previous attempts that were made to deliver the message. The array is empty if it's the first attempt.", alias="a_objAttempt") + __properties: ClassVar[List[str]] = ["objWebhook", "a_objAttempt"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> CommonWebhook: + def from_json(cls, json_str: str) -> Self: """Create an instance of CommonWebhook from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_webhook if self.obj_webhook: _dict['objWebhook'] = self.obj_webhook.to_dict() @@ -69,17 +87,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> CommonWebhook: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of CommonWebhook from a dict""" if obj is None: return None if not isinstance(obj, dict): - return CommonWebhook.parse_obj(obj) + return cls.model_validate(obj) - _obj = CommonWebhook.parse_obj({ - "obj_webhook": CustomWebhookResponse.from_dict(obj.get("objWebhook")) if obj.get("objWebhook") is not None else None, - "a_obj_attempt": [AttemptResponseCompound.from_dict(_item) for _item in obj.get("a_objAttempt")] if obj.get("a_objAttempt") is not None else None + _obj = cls.model_validate({ + "objWebhook": CustomWebhookResponse.from_dict(obj.get("objWebhook")) if obj.get("objWebhook") is not None else None, + "a_objAttempt": [AttemptResponseCompound.from_dict(_item) for _item in obj.get("a_objAttempt")] if obj.get("a_objAttempt") is not None else None }) return _obj diff --git a/eZmaxApi/models/communication_create_object_v1_response_m_payload.py b/eZmaxApi/models/communication_create_object_v1_response_m_payload.py index 774e3056c..3aa72bd6e 100644 --- a/eZmaxApi/models/communication_create_object_v1_response_m_payload.py +++ b/eZmaxApi/models/communication_create_object_v1_response_m_payload.py @@ -19,53 +19,72 @@ import json -from typing import List -from pydantic import BaseModel, Field, conint, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class CommunicationCreateObjectV1ResponseMPayload(BaseModel): """ - Payload for POST /1/object/communication # noqa: E501 - """ - a_pki_communication_id: conlist(conint(strict=True, ge=0)) = Field(..., alias="a_pkiCommunicationID", description="An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request.") - __properties = ["a_pkiCommunicationID"] + Payload for POST /1/object/communication + """ # noqa: E501 + a_pki_communication_id: List[Annotated[int, Field(strict=True, ge=0)]] = Field(description="An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request.", alias="a_pkiCommunicationID") + __properties: ClassVar[List[str]] = ["a_pkiCommunicationID"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> CommunicationCreateObjectV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of CommunicationCreateObjectV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> CommunicationCreateObjectV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of CommunicationCreateObjectV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return CommunicationCreateObjectV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = CommunicationCreateObjectV1ResponseMPayload.parse_obj({ - "a_pki_communication_id": obj.get("a_pkiCommunicationID") + _obj = cls.model_validate({ + "a_pkiCommunicationID": obj.get("a_pkiCommunicationID") }) return _obj diff --git a/eZmaxApi/models/communication_request.py b/eZmaxApi/models/communication_request.py index 596d771db..0a7a362aa 100644 --- a/eZmaxApi/models/communication_request.py +++ b/eZmaxApi/models/communication_request.py @@ -19,39 +19,45 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint, constr, validator +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, StrictStr, field_validator +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.custom_communicationsender_request import CustomCommunicationsenderRequest from eZmaxApi.models.field_e_communication_importance import FieldECommunicationImportance from eZmaxApi.models.field_e_communication_type import FieldECommunicationType +try: + from typing import Self +except ImportError: + from typing_extensions import Self class CommunicationRequest(BaseModel): """ - Request for POST /1/object/communication # noqa: E501 - """ - pki_communication_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="pkiCommunicationID", description="The unique ID of the Communication.") - e_communication_importance: Optional[FieldECommunicationImportance] = Field(None, alias="eCommunicationImportance") - e_communication_type: FieldECommunicationType = Field(..., alias="eCommunicationType") - obj_communicationsender: Optional[CustomCommunicationsenderRequest] = Field(None, alias="objCommunicationsender") - s_communication_subject: Optional[constr(strict=True)] = Field(None, alias="sCommunicationSubject", description="The subject of the Communication") - t_communication_body: StrictStr = Field(..., alias="tCommunicationBody", description="The Body of the Communication") - b_communication_private: StrictBool = Field(..., alias="bCommunicationPrivate", description="Whether the Communication is private or not") - e_communication_attachmenttype: Optional[StrictStr] = Field(None, alias="eCommunicationAttachmenttype", description="How the attachment should be included in the email. Only used if eCommunicationType is **Email**") - i_communication_attachmentlinkexpiration: Optional[conint(strict=True, le=30, ge=1)] = Field(None, alias="iCommunicationAttachmentlinkexpiration", description="The number of days before the attachment link expired. Only used if eCommunicationType is **Email** and eCommunicationattachmentType is **Link**") - b_communication_readreceipt: Optional[StrictBool] = Field(None, alias="bCommunicationReadreceipt", description="Whether we ask for a read receipt or not.") - __properties = ["pkiCommunicationID", "eCommunicationImportance", "eCommunicationType", "objCommunicationsender", "sCommunicationSubject", "tCommunicationBody", "bCommunicationPrivate", "eCommunicationAttachmenttype", "iCommunicationAttachmentlinkexpiration", "bCommunicationReadreceipt"] - - @validator('s_communication_subject') + Request for POST /1/object/communication + """ # noqa: E501 + pki_communication_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Communication.", alias="pkiCommunicationID") + e_communication_importance: Optional[FieldECommunicationImportance] = Field(default=None, alias="eCommunicationImportance") + e_communication_type: FieldECommunicationType = Field(alias="eCommunicationType") + obj_communicationsender: Optional[CustomCommunicationsenderRequest] = Field(default=None, alias="objCommunicationsender") + s_communication_subject: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="The subject of the Communication", alias="sCommunicationSubject") + t_communication_body: StrictStr = Field(description="The Body of the Communication", alias="tCommunicationBody") + b_communication_private: StrictBool = Field(description="Whether the Communication is private or not", alias="bCommunicationPrivate") + e_communication_attachmenttype: Optional[StrictStr] = Field(default=None, description="How the attachment should be included in the email. Only used if eCommunicationType is **Email**", alias="eCommunicationAttachmenttype") + i_communication_attachmentlinkexpiration: Optional[Annotated[int, Field(le=30, strict=True, ge=1)]] = Field(default=None, description="The number of days before the attachment link expired. Only used if eCommunicationType is **Email** and eCommunicationattachmentType is **Link**", alias="iCommunicationAttachmentlinkexpiration") + b_communication_readreceipt: Optional[StrictBool] = Field(default=None, description="Whether we ask for a read receipt or not.", alias="bCommunicationReadreceipt") + __properties: ClassVar[List[str]] = ["pkiCommunicationID", "eCommunicationImportance", "eCommunicationType", "objCommunicationsender", "sCommunicationSubject", "tCommunicationBody", "bCommunicationPrivate", "eCommunicationAttachmenttype", "iCommunicationAttachmentlinkexpiration", "bCommunicationReadreceipt"] + + @field_validator('s_communication_subject') def s_communication_subject_validate_regular_expression(cls, value): """Validates the regular expression""" if value is None: return value - if not re.match(r"^.{0,150}$", value): - raise ValueError(r"must validate the regular expression /^.{0,150}$/") + if not re.match(r"^.{0,200}$", value): + raise ValueError(r"must validate the regular expression /^.{0,200}$/") return value - @validator('e_communication_attachmenttype') + @field_validator('e_communication_attachmenttype') def e_communication_attachmenttype_validate_enum(cls, value): """Validates the enum""" if value is None: @@ -61,55 +67,68 @@ def e_communication_attachmenttype_validate_enum(cls, value): raise ValueError("must be one of enum values ('Attachment', 'Url')") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> CommunicationRequest: + def from_json(cls, json_str: str) -> Self: """Create an instance of CommunicationRequest from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_communicationsender if self.obj_communicationsender: _dict['objCommunicationsender'] = self.obj_communicationsender.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> CommunicationRequest: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of CommunicationRequest from a dict""" if obj is None: return None if not isinstance(obj, dict): - return CommunicationRequest.parse_obj(obj) - - _obj = CommunicationRequest.parse_obj({ - "pki_communication_id": obj.get("pkiCommunicationID"), - "e_communication_importance": obj.get("eCommunicationImportance"), - "e_communication_type": obj.get("eCommunicationType"), - "obj_communicationsender": CustomCommunicationsenderRequest.from_dict(obj.get("objCommunicationsender")) if obj.get("objCommunicationsender") is not None else None, - "s_communication_subject": obj.get("sCommunicationSubject"), - "t_communication_body": obj.get("tCommunicationBody"), - "b_communication_private": obj.get("bCommunicationPrivate"), - "e_communication_attachmenttype": obj.get("eCommunicationAttachmenttype"), - "i_communication_attachmentlinkexpiration": obj.get("iCommunicationAttachmentlinkexpiration"), - "b_communication_readreceipt": obj.get("bCommunicationReadreceipt") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiCommunicationID": obj.get("pkiCommunicationID"), + "eCommunicationImportance": obj.get("eCommunicationImportance"), + "eCommunicationType": obj.get("eCommunicationType"), + "objCommunicationsender": CustomCommunicationsenderRequest.from_dict(obj.get("objCommunicationsender")) if obj.get("objCommunicationsender") is not None else None, + "sCommunicationSubject": obj.get("sCommunicationSubject"), + "tCommunicationBody": obj.get("tCommunicationBody"), + "bCommunicationPrivate": obj.get("bCommunicationPrivate"), + "eCommunicationAttachmenttype": obj.get("eCommunicationAttachmenttype"), + "iCommunicationAttachmentlinkexpiration": obj.get("iCommunicationAttachmentlinkexpiration"), + "bCommunicationReadreceipt": obj.get("bCommunicationReadreceipt") }) return _obj diff --git a/eZmaxApi/models/communication_request_compound.py b/eZmaxApi/models/communication_request_compound.py index 014884f50..d16a44e48 100644 --- a/eZmaxApi/models/communication_request_compound.py +++ b/eZmaxApi/models/communication_request_compound.py @@ -19,8 +19,10 @@ import json -from typing import List, Optional -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint, conlist, constr, validator +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, StrictStr, field_validator +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.communicationexternalrecipient_request_compound import CommunicationexternalrecipientRequestCompound from eZmaxApi.models.communicationrecipient_request_compound import CommunicationrecipientRequestCompound from eZmaxApi.models.communicationreference_request_compound import CommunicationreferenceRequestCompound @@ -28,38 +30,42 @@ from eZmaxApi.models.custom_communicationsender_request import CustomCommunicationsenderRequest from eZmaxApi.models.field_e_communication_importance import FieldECommunicationImportance from eZmaxApi.models.field_e_communication_type import FieldECommunicationType +try: + from typing import Self +except ImportError: + from typing_extensions import Self class CommunicationRequestCompound(BaseModel): """ - Request for POST /1/object/communication # noqa: E501 - """ - pki_communication_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="pkiCommunicationID", description="The unique ID of the Communication.") - e_communication_importance: Optional[FieldECommunicationImportance] = Field(None, alias="eCommunicationImportance") - e_communication_type: FieldECommunicationType = Field(..., alias="eCommunicationType") - obj_communicationsender: Optional[CustomCommunicationsenderRequest] = Field(None, alias="objCommunicationsender") - s_communication_subject: Optional[constr(strict=True)] = Field(None, alias="sCommunicationSubject", description="The subject of the Communication") - t_communication_body: StrictStr = Field(..., alias="tCommunicationBody", description="The Body of the Communication") - b_communication_private: StrictBool = Field(..., alias="bCommunicationPrivate", description="Whether the Communication is private or not") - e_communication_attachmenttype: Optional[StrictStr] = Field(None, alias="eCommunicationAttachmenttype", description="How the attachment should be included in the email. Only used if eCommunicationType is **Email**") - i_communication_attachmentlinkexpiration: Optional[conint(strict=True, le=30, ge=1)] = Field(None, alias="iCommunicationAttachmentlinkexpiration", description="The number of days before the attachment link expired. Only used if eCommunicationType is **Email** and eCommunicationattachmentType is **Link**") - b_communication_readreceipt: Optional[StrictBool] = Field(None, alias="bCommunicationReadreceipt", description="Whether we ask for a read receipt or not.") - a_obj_communicationattachment: conlist(CustomCommunicationattachmentRequest, min_items=0) = Field(..., alias="a_objCommunicationattachment") - a_obj_communicationrecipient: conlist(CommunicationrecipientRequestCompound, min_items=0) = Field(..., alias="a_objCommunicationrecipient") - a_obj_communicationreference: conlist(CommunicationreferenceRequestCompound, min_items=0) = Field(..., alias="a_objCommunicationreference") - a_obj_communicationexternalrecipient: conlist(CommunicationexternalrecipientRequestCompound, min_items=0) = Field(..., alias="a_objCommunicationexternalrecipient") - __properties = ["pkiCommunicationID", "eCommunicationImportance", "eCommunicationType", "objCommunicationsender", "sCommunicationSubject", "tCommunicationBody", "bCommunicationPrivate", "eCommunicationAttachmenttype", "iCommunicationAttachmentlinkexpiration", "bCommunicationReadreceipt", "a_objCommunicationattachment", "a_objCommunicationrecipient", "a_objCommunicationreference", "a_objCommunicationexternalrecipient"] - - @validator('s_communication_subject') + Request for POST /1/object/communication + """ # noqa: E501 + pki_communication_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Communication.", alias="pkiCommunicationID") + e_communication_importance: Optional[FieldECommunicationImportance] = Field(default=None, alias="eCommunicationImportance") + e_communication_type: FieldECommunicationType = Field(alias="eCommunicationType") + obj_communicationsender: Optional[CustomCommunicationsenderRequest] = Field(default=None, alias="objCommunicationsender") + s_communication_subject: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="The subject of the Communication", alias="sCommunicationSubject") + t_communication_body: StrictStr = Field(description="The Body of the Communication", alias="tCommunicationBody") + b_communication_private: StrictBool = Field(description="Whether the Communication is private or not", alias="bCommunicationPrivate") + e_communication_attachmenttype: Optional[StrictStr] = Field(default=None, description="How the attachment should be included in the email. Only used if eCommunicationType is **Email**", alias="eCommunicationAttachmenttype") + i_communication_attachmentlinkexpiration: Optional[Annotated[int, Field(le=30, strict=True, ge=1)]] = Field(default=None, description="The number of days before the attachment link expired. Only used if eCommunicationType is **Email** and eCommunicationattachmentType is **Link**", alias="iCommunicationAttachmentlinkexpiration") + b_communication_readreceipt: Optional[StrictBool] = Field(default=None, description="Whether we ask for a read receipt or not.", alias="bCommunicationReadreceipt") + a_obj_communicationattachment: Annotated[List[CustomCommunicationattachmentRequest], Field(min_length=0)] = Field(alias="a_objCommunicationattachment") + a_obj_communicationrecipient: Annotated[List[CommunicationrecipientRequestCompound], Field(min_length=0)] = Field(alias="a_objCommunicationrecipient") + a_obj_communicationreference: Annotated[List[CommunicationreferenceRequestCompound], Field(min_length=0)] = Field(alias="a_objCommunicationreference") + a_obj_communicationexternalrecipient: Annotated[List[CommunicationexternalrecipientRequestCompound], Field(min_length=0)] = Field(alias="a_objCommunicationexternalrecipient") + __properties: ClassVar[List[str]] = ["pkiCommunicationID", "eCommunicationImportance", "eCommunicationType", "objCommunicationsender", "sCommunicationSubject", "tCommunicationBody", "bCommunicationPrivate", "eCommunicationAttachmenttype", "iCommunicationAttachmentlinkexpiration", "bCommunicationReadreceipt", "a_objCommunicationattachment", "a_objCommunicationrecipient", "a_objCommunicationreference", "a_objCommunicationexternalrecipient"] + + @field_validator('s_communication_subject') def s_communication_subject_validate_regular_expression(cls, value): """Validates the regular expression""" if value is None: return value - if not re.match(r"^.{0,150}$", value): - raise ValueError(r"must validate the regular expression /^.{0,150}$/") + if not re.match(r"^.{0,200}$", value): + raise ValueError(r"must validate the regular expression /^.{0,200}$/") return value - @validator('e_communication_attachmenttype') + @field_validator('e_communication_attachmenttype') def e_communication_attachmenttype_validate_enum(cls, value): """Validates the enum""" if value is None: @@ -69,30 +75,43 @@ def e_communication_attachmenttype_validate_enum(cls, value): raise ValueError("must be one of enum values ('Attachment', 'Url')") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> CommunicationRequestCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of CommunicationRequestCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_communicationsender if self.obj_communicationsender: _dict['objCommunicationsender'] = self.obj_communicationsender.to_dict() @@ -127,29 +146,29 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> CommunicationRequestCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of CommunicationRequestCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return CommunicationRequestCompound.parse_obj(obj) - - _obj = CommunicationRequestCompound.parse_obj({ - "pki_communication_id": obj.get("pkiCommunicationID"), - "e_communication_importance": obj.get("eCommunicationImportance"), - "e_communication_type": obj.get("eCommunicationType"), - "obj_communicationsender": CustomCommunicationsenderRequest.from_dict(obj.get("objCommunicationsender")) if obj.get("objCommunicationsender") is not None else None, - "s_communication_subject": obj.get("sCommunicationSubject"), - "t_communication_body": obj.get("tCommunicationBody"), - "b_communication_private": obj.get("bCommunicationPrivate"), - "e_communication_attachmenttype": obj.get("eCommunicationAttachmenttype"), - "i_communication_attachmentlinkexpiration": obj.get("iCommunicationAttachmentlinkexpiration"), - "b_communication_readreceipt": obj.get("bCommunicationReadreceipt"), - "a_obj_communicationattachment": [CustomCommunicationattachmentRequest.from_dict(_item) for _item in obj.get("a_objCommunicationattachment")] if obj.get("a_objCommunicationattachment") is not None else None, - "a_obj_communicationrecipient": [CommunicationrecipientRequestCompound.from_dict(_item) for _item in obj.get("a_objCommunicationrecipient")] if obj.get("a_objCommunicationrecipient") is not None else None, - "a_obj_communicationreference": [CommunicationreferenceRequestCompound.from_dict(_item) for _item in obj.get("a_objCommunicationreference")] if obj.get("a_objCommunicationreference") is not None else None, - "a_obj_communicationexternalrecipient": [CommunicationexternalrecipientRequestCompound.from_dict(_item) for _item in obj.get("a_objCommunicationexternalrecipient")] if obj.get("a_objCommunicationexternalrecipient") is not None else None + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiCommunicationID": obj.get("pkiCommunicationID"), + "eCommunicationImportance": obj.get("eCommunicationImportance"), + "eCommunicationType": obj.get("eCommunicationType"), + "objCommunicationsender": CustomCommunicationsenderRequest.from_dict(obj.get("objCommunicationsender")) if obj.get("objCommunicationsender") is not None else None, + "sCommunicationSubject": obj.get("sCommunicationSubject"), + "tCommunicationBody": obj.get("tCommunicationBody"), + "bCommunicationPrivate": obj.get("bCommunicationPrivate"), + "eCommunicationAttachmenttype": obj.get("eCommunicationAttachmenttype"), + "iCommunicationAttachmentlinkexpiration": obj.get("iCommunicationAttachmentlinkexpiration"), + "bCommunicationReadreceipt": obj.get("bCommunicationReadreceipt"), + "a_objCommunicationattachment": [CustomCommunicationattachmentRequest.from_dict(_item) for _item in obj.get("a_objCommunicationattachment")] if obj.get("a_objCommunicationattachment") is not None else None, + "a_objCommunicationrecipient": [CommunicationrecipientRequestCompound.from_dict(_item) for _item in obj.get("a_objCommunicationrecipient")] if obj.get("a_objCommunicationrecipient") is not None else None, + "a_objCommunicationreference": [CommunicationreferenceRequestCompound.from_dict(_item) for _item in obj.get("a_objCommunicationreference")] if obj.get("a_objCommunicationreference") is not None else None, + "a_objCommunicationexternalrecipient": [CommunicationexternalrecipientRequestCompound.from_dict(_item) for _item in obj.get("a_objCommunicationexternalrecipient")] if obj.get("a_objCommunicationexternalrecipient") is not None else None }) return _obj diff --git a/eZmaxApi/models/communication_send_v1_request.py b/eZmaxApi/models/communication_send_v1_request.py index 39197e974..7f1ed80e8 100644 --- a/eZmaxApi/models/communication_send_v1_request.py +++ b/eZmaxApi/models/communication_send_v1_request.py @@ -19,41 +19,60 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.communication_request_compound import CommunicationRequestCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class CommunicationSendV1Request(BaseModel): """ - Request for POST /1/object/communication # noqa: E501 - """ - a_obj_communication: conlist(CommunicationRequestCompound, min_items=1) = Field(..., alias="a_objCommunication") - __properties = ["a_objCommunication"] + Request for POST /1/object/communication + """ # noqa: E501 + a_obj_communication: Annotated[List[CommunicationRequestCompound], Field(min_length=1)] = Field(alias="a_objCommunication") + __properties: ClassVar[List[str]] = ["a_objCommunication"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> CommunicationSendV1Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of CommunicationSendV1Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_communication (list) _items = [] if self.a_obj_communication: @@ -64,16 +83,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> CommunicationSendV1Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of CommunicationSendV1Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return CommunicationSendV1Request.parse_obj(obj) + return cls.model_validate(obj) - _obj = CommunicationSendV1Request.parse_obj({ - "a_obj_communication": [CommunicationRequestCompound.from_dict(_item) for _item in obj.get("a_objCommunication")] if obj.get("a_objCommunication") is not None else None + _obj = cls.model_validate({ + "a_objCommunication": [CommunicationRequestCompound.from_dict(_item) for _item in obj.get("a_objCommunication")] if obj.get("a_objCommunication") is not None else None }) return _obj diff --git a/eZmaxApi/models/communication_send_v1_response.py b/eZmaxApi/models/communication_send_v1_response.py index 943c8f85c..39b3f7c24 100644 --- a/eZmaxApi/models/communication_send_v1_response.py +++ b/eZmaxApi/models/communication_send_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.communication_create_object_v1_response_m_payload import CommunicationCreateObjectV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class CommunicationSendV1Response(BaseModel): """ - Response for POST /1/object/communication # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: CommunicationCreateObjectV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for POST /1/object/communication + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: CommunicationCreateObjectV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> CommunicationSendV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of CommunicationSendV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> CommunicationSendV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of CommunicationSendV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return CommunicationSendV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = CommunicationSendV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": CommunicationCreateObjectV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": CommunicationCreateObjectV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/communicationattachment_request.py b/eZmaxApi/models/communicationattachment_request.py index d1825be80..fcc121b52 100644 --- a/eZmaxApi/models/communicationattachment_request.py +++ b/eZmaxApi/models/communicationattachment_request.py @@ -19,59 +19,78 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictInt, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictInt +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class CommunicationattachmentRequest(BaseModel): """ - A Communicationattachment Object # noqa: E501 - """ - pki_communicationattachment_id: Optional[StrictInt] = Field(None, alias="pkiCommunicationattachmentID", description="The unique ID of the Communicationattachment") - fki_attachment_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiAttachmentID", description="The unique ID of the Attachment.") - fki_invoice_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiInvoiceID", description="The unique ID of the Invoice.") - fki_salarypreparation_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiSalarypreparationID", description="The unique ID of the Salarypreparation.") - __properties = ["pkiCommunicationattachmentID", "fkiAttachmentID", "fkiInvoiceID", "fkiSalarypreparationID"] + A Communicationattachment Object + """ # noqa: E501 + pki_communicationattachment_id: Optional[StrictInt] = Field(default=None, description="The unique ID of the Communicationattachment", alias="pkiCommunicationattachmentID") + fki_attachment_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Attachment.", alias="fkiAttachmentID") + fki_invoice_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Invoice.", alias="fkiInvoiceID") + fki_salarypreparation_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Salarypreparation.", alias="fkiSalarypreparationID") + __properties: ClassVar[List[str]] = ["pkiCommunicationattachmentID", "fkiAttachmentID", "fkiInvoiceID", "fkiSalarypreparationID"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> CommunicationattachmentRequest: + def from_json(cls, json_str: str) -> Self: """Create an instance of CommunicationattachmentRequest from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> CommunicationattachmentRequest: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of CommunicationattachmentRequest from a dict""" if obj is None: return None if not isinstance(obj, dict): - return CommunicationattachmentRequest.parse_obj(obj) + return cls.model_validate(obj) - _obj = CommunicationattachmentRequest.parse_obj({ - "pki_communicationattachment_id": obj.get("pkiCommunicationattachmentID"), - "fki_attachment_id": obj.get("fkiAttachmentID"), - "fki_invoice_id": obj.get("fkiInvoiceID"), - "fki_salarypreparation_id": obj.get("fkiSalarypreparationID") + _obj = cls.model_validate({ + "pkiCommunicationattachmentID": obj.get("pkiCommunicationattachmentID"), + "fkiAttachmentID": obj.get("fkiAttachmentID"), + "fkiInvoiceID": obj.get("fkiInvoiceID"), + "fkiSalarypreparationID": obj.get("fkiSalarypreparationID") }) return _obj diff --git a/eZmaxApi/models/communicationattachment_request_compound.py b/eZmaxApi/models/communicationattachment_request_compound.py index a9ae237c4..f141523a3 100644 --- a/eZmaxApi/models/communicationattachment_request_compound.py +++ b/eZmaxApi/models/communicationattachment_request_compound.py @@ -19,59 +19,78 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictInt, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictInt +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class CommunicationattachmentRequestCompound(BaseModel): """ - A Communicationattachment Object and children # noqa: E501 - """ - pki_communicationattachment_id: Optional[StrictInt] = Field(None, alias="pkiCommunicationattachmentID", description="The unique ID of the Communicationattachment") - fki_attachment_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiAttachmentID", description="The unique ID of the Attachment.") - fki_invoice_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiInvoiceID", description="The unique ID of the Invoice.") - fki_salarypreparation_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiSalarypreparationID", description="The unique ID of the Salarypreparation.") - __properties = ["pkiCommunicationattachmentID", "fkiAttachmentID", "fkiInvoiceID", "fkiSalarypreparationID"] + A Communicationattachment Object and children + """ # noqa: E501 + pki_communicationattachment_id: Optional[StrictInt] = Field(default=None, description="The unique ID of the Communicationattachment", alias="pkiCommunicationattachmentID") + fki_attachment_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Attachment.", alias="fkiAttachmentID") + fki_invoice_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Invoice.", alias="fkiInvoiceID") + fki_salarypreparation_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Salarypreparation.", alias="fkiSalarypreparationID") + __properties: ClassVar[List[str]] = ["pkiCommunicationattachmentID", "fkiAttachmentID", "fkiInvoiceID", "fkiSalarypreparationID"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> CommunicationattachmentRequestCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of CommunicationattachmentRequestCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> CommunicationattachmentRequestCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of CommunicationattachmentRequestCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return CommunicationattachmentRequestCompound.parse_obj(obj) + return cls.model_validate(obj) - _obj = CommunicationattachmentRequestCompound.parse_obj({ - "pki_communicationattachment_id": obj.get("pkiCommunicationattachmentID"), - "fki_attachment_id": obj.get("fkiAttachmentID"), - "fki_invoice_id": obj.get("fkiInvoiceID"), - "fki_salarypreparation_id": obj.get("fkiSalarypreparationID") + _obj = cls.model_validate({ + "pkiCommunicationattachmentID": obj.get("pkiCommunicationattachmentID"), + "fkiAttachmentID": obj.get("fkiAttachmentID"), + "fkiInvoiceID": obj.get("fkiInvoiceID"), + "fkiSalarypreparationID": obj.get("fkiSalarypreparationID") }) return _obj diff --git a/eZmaxApi/models/communicationexternalrecipient_request.py b/eZmaxApi/models/communicationexternalrecipient_request.py index e886deef5..2b7b5c93c 100644 --- a/eZmaxApi/models/communicationexternalrecipient_request.py +++ b/eZmaxApi/models/communicationexternalrecipient_request.py @@ -19,22 +19,28 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictInt, StrictStr, constr, validator +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictInt, StrictStr, field_validator +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.field_e_communicationexternalrecipient_type import FieldECommunicationexternalrecipientType +try: + from typing import Self +except ImportError: + from typing_extensions import Self class CommunicationexternalrecipientRequest(BaseModel): """ - A Communicationexternalrecipient Object # noqa: E501 - """ - pki_communicationexternalrecipient_id: Optional[StrictInt] = Field(None, alias="pkiCommunicationexternalrecipientID", description="The unique ID of the Communicationexternalrecipient") - s_email_address: Optional[StrictStr] = Field(None, alias="sEmailAddress", description="The email address.") - s_phone_e164: Optional[constr(strict=True)] = Field(None, alias="sPhoneE164", description="A phone number in E.164 Format") - e_communicationexternalrecipient_type: Optional[FieldECommunicationexternalrecipientType] = Field(None, alias="eCommunicationexternalrecipientType") - s_communicationexternalrecipient_name: constr(strict=True) = Field(..., alias="sCommunicationexternalrecipientName", description="The name of the Communicationexternalrecipient") - __properties = ["pkiCommunicationexternalrecipientID", "sEmailAddress", "sPhoneE164", "eCommunicationexternalrecipientType", "sCommunicationexternalrecipientName"] - - @validator('s_phone_e164') + A Communicationexternalrecipient Object + """ # noqa: E501 + pki_communicationexternalrecipient_id: Optional[StrictInt] = Field(default=None, description="The unique ID of the Communicationexternalrecipient", alias="pkiCommunicationexternalrecipientID") + s_email_address: Optional[StrictStr] = Field(default=None, description="The email address.", alias="sEmailAddress") + s_phone_e164: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="A phone number in E.164 Format", alias="sPhoneE164") + e_communicationexternalrecipient_type: Optional[FieldECommunicationexternalrecipientType] = Field(default=None, alias="eCommunicationexternalrecipientType") + s_communicationexternalrecipient_name: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="The name of the Communicationexternalrecipient", alias="sCommunicationexternalrecipientName") + __properties: ClassVar[List[str]] = ["pkiCommunicationexternalrecipientID", "sEmailAddress", "sPhoneE164", "eCommunicationexternalrecipientType", "sCommunicationexternalrecipientName"] + + @field_validator('s_phone_e164') def s_phone_e164_validate_regular_expression(cls, value): """Validates the regular expression""" if value is None: @@ -44,54 +50,70 @@ def s_phone_e164_validate_regular_expression(cls, value): raise ValueError(r"must validate the regular expression /^\+[1-9]\d{1,14}$/") return value - @validator('s_communicationexternalrecipient_name') + @field_validator('s_communicationexternalrecipient_name') def s_communicationexternalrecipient_name_validate_regular_expression(cls, value): """Validates the regular expression""" + if value is None: + return value + if not re.match(r"^.{0,50}$", value): raise ValueError(r"must validate the regular expression /^.{0,50}$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> CommunicationexternalrecipientRequest: + def from_json(cls, json_str: str) -> Self: """Create an instance of CommunicationexternalrecipientRequest from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> CommunicationexternalrecipientRequest: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of CommunicationexternalrecipientRequest from a dict""" if obj is None: return None if not isinstance(obj, dict): - return CommunicationexternalrecipientRequest.parse_obj(obj) - - _obj = CommunicationexternalrecipientRequest.parse_obj({ - "pki_communicationexternalrecipient_id": obj.get("pkiCommunicationexternalrecipientID"), - "s_email_address": obj.get("sEmailAddress"), - "s_phone_e164": obj.get("sPhoneE164"), - "e_communicationexternalrecipient_type": obj.get("eCommunicationexternalrecipientType"), - "s_communicationexternalrecipient_name": obj.get("sCommunicationexternalrecipientName") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiCommunicationexternalrecipientID": obj.get("pkiCommunicationexternalrecipientID"), + "sEmailAddress": obj.get("sEmailAddress"), + "sPhoneE164": obj.get("sPhoneE164"), + "eCommunicationexternalrecipientType": obj.get("eCommunicationexternalrecipientType"), + "sCommunicationexternalrecipientName": obj.get("sCommunicationexternalrecipientName") }) return _obj diff --git a/eZmaxApi/models/communicationexternalrecipient_request_compound.py b/eZmaxApi/models/communicationexternalrecipient_request_compound.py index 53c9e11a5..143de618f 100644 --- a/eZmaxApi/models/communicationexternalrecipient_request_compound.py +++ b/eZmaxApi/models/communicationexternalrecipient_request_compound.py @@ -19,22 +19,28 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictInt, StrictStr, constr, validator +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictInt, StrictStr, field_validator +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.field_e_communicationexternalrecipient_type import FieldECommunicationexternalrecipientType +try: + from typing import Self +except ImportError: + from typing_extensions import Self class CommunicationexternalrecipientRequestCompound(BaseModel): """ - A Communicationexternalrecipient Object and children # noqa: E501 - """ - pki_communicationexternalrecipient_id: Optional[StrictInt] = Field(None, alias="pkiCommunicationexternalrecipientID", description="The unique ID of the Communicationexternalrecipient") - s_email_address: Optional[StrictStr] = Field(None, alias="sEmailAddress", description="The email address.") - s_phone_e164: Optional[constr(strict=True)] = Field(None, alias="sPhoneE164", description="A phone number in E.164 Format") - e_communicationexternalrecipient_type: Optional[FieldECommunicationexternalrecipientType] = Field(None, alias="eCommunicationexternalrecipientType") - s_communicationexternalrecipient_name: constr(strict=True) = Field(..., alias="sCommunicationexternalrecipientName", description="The name of the Communicationexternalrecipient") - __properties = ["pkiCommunicationexternalrecipientID", "sEmailAddress", "sPhoneE164", "eCommunicationexternalrecipientType", "sCommunicationexternalrecipientName"] - - @validator('s_phone_e164') + A Communicationexternalrecipient Object and children + """ # noqa: E501 + pki_communicationexternalrecipient_id: Optional[StrictInt] = Field(default=None, description="The unique ID of the Communicationexternalrecipient", alias="pkiCommunicationexternalrecipientID") + s_email_address: Optional[StrictStr] = Field(default=None, description="The email address.", alias="sEmailAddress") + s_phone_e164: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="A phone number in E.164 Format", alias="sPhoneE164") + e_communicationexternalrecipient_type: Optional[FieldECommunicationexternalrecipientType] = Field(default=None, alias="eCommunicationexternalrecipientType") + s_communicationexternalrecipient_name: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="The name of the Communicationexternalrecipient", alias="sCommunicationexternalrecipientName") + __properties: ClassVar[List[str]] = ["pkiCommunicationexternalrecipientID", "sEmailAddress", "sPhoneE164", "eCommunicationexternalrecipientType", "sCommunicationexternalrecipientName"] + + @field_validator('s_phone_e164') def s_phone_e164_validate_regular_expression(cls, value): """Validates the regular expression""" if value is None: @@ -44,54 +50,70 @@ def s_phone_e164_validate_regular_expression(cls, value): raise ValueError(r"must validate the regular expression /^\+[1-9]\d{1,14}$/") return value - @validator('s_communicationexternalrecipient_name') + @field_validator('s_communicationexternalrecipient_name') def s_communicationexternalrecipient_name_validate_regular_expression(cls, value): """Validates the regular expression""" + if value is None: + return value + if not re.match(r"^.{0,50}$", value): raise ValueError(r"must validate the regular expression /^.{0,50}$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> CommunicationexternalrecipientRequestCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of CommunicationexternalrecipientRequestCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> CommunicationexternalrecipientRequestCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of CommunicationexternalrecipientRequestCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return CommunicationexternalrecipientRequestCompound.parse_obj(obj) - - _obj = CommunicationexternalrecipientRequestCompound.parse_obj({ - "pki_communicationexternalrecipient_id": obj.get("pkiCommunicationexternalrecipientID"), - "s_email_address": obj.get("sEmailAddress"), - "s_phone_e164": obj.get("sPhoneE164"), - "e_communicationexternalrecipient_type": obj.get("eCommunicationexternalrecipientType"), - "s_communicationexternalrecipient_name": obj.get("sCommunicationexternalrecipientName") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiCommunicationexternalrecipientID": obj.get("pkiCommunicationexternalrecipientID"), + "sEmailAddress": obj.get("sEmailAddress"), + "sPhoneE164": obj.get("sPhoneE164"), + "eCommunicationexternalrecipientType": obj.get("eCommunicationexternalrecipientType"), + "sCommunicationexternalrecipientName": obj.get("sCommunicationexternalrecipientName") }) return _obj diff --git a/eZmaxApi/models/communicationrecipient_request.py b/eZmaxApi/models/communicationrecipient_request.py index b49d2ccd4..0ef630207 100644 --- a/eZmaxApi/models/communicationrecipient_request.py +++ b/eZmaxApi/models/communicationrecipient_request.py @@ -19,78 +19,101 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.field_e_communicationrecipient_type import FieldECommunicationrecipientType +try: + from typing import Self +except ImportError: + from typing_extensions import Self class CommunicationrecipientRequest(BaseModel): """ - A Communicationrecipient Object # noqa: E501 - """ - pki_communicationrecipient_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="pkiCommunicationrecipientID", description="The unique ID of the Communicationrecipient.") - fki_agent_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiAgentID", description="The unique ID of the Agent.") - fki_agentincorporation_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiAgentincorporationID", description="The unique ID of the Agentincorporation.") - fki_broker_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiBrokerID", description="The unique ID of the Broker.") - fki_customer_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiCustomerID", description="The unique ID of the Customer.") - fki_employee_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiEmployeeID", description="The unique ID of the Employee.") - fki_assistant_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiAssistantID", description="The unique ID of the Assistant.") - fki_externalbroker_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiExternalbrokerID", description="The unique ID of the Externalbroker.") - fki_ezsignsigner_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiEzsignsignerID", description="The unique ID of the Ezsignsigner") - fki_notary_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiNotaryID", description="The unique ID of the Notary.") - fki_supplier_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiSupplierID", description="The unique ID of the Supplier.") - fki_user_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiUserID", description="The unique ID of the User") - e_communicationrecipient_type: Optional[FieldECommunicationrecipientType] = Field(None, alias="eCommunicationrecipientType") - __properties = ["pkiCommunicationrecipientID", "fkiAgentID", "fkiAgentincorporationID", "fkiBrokerID", "fkiCustomerID", "fkiEmployeeID", "fkiAssistantID", "fkiExternalbrokerID", "fkiEzsignsignerID", "fkiNotaryID", "fkiSupplierID", "fkiUserID", "eCommunicationrecipientType"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + A Communicationrecipient Object + """ # noqa: E501 + pki_communicationrecipient_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Communicationrecipient.", alias="pkiCommunicationrecipientID") + fki_agent_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Agent.", alias="fkiAgentID") + fki_broker_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Broker.", alias="fkiBrokerID") + fki_contact_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Contact", alias="fkiContactID") + fki_customer_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Customer.", alias="fkiCustomerID") + fki_employee_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Employee.", alias="fkiEmployeeID") + fki_assistant_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Assistant.", alias="fkiAssistantID") + fki_externalbroker_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Externalbroker.", alias="fkiExternalbrokerID") + fki_ezsignsigner_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsignsigner", alias="fkiEzsignsignerID") + fki_notary_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Notary.", alias="fkiNotaryID") + fki_supplier_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Supplier.", alias="fkiSupplierID") + fki_user_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the User", alias="fkiUserID") + fki_mailboxshared_id: Optional[Annotated[int, Field(le=255, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Mailboxshared", alias="fkiMailboxsharedID") + fki_phonelineshared_id: Optional[Annotated[int, Field(le=255, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Phonelineshared", alias="fkiPhonelinesharedID") + e_communicationrecipient_type: Optional[FieldECommunicationrecipientType] = Field(default=None, alias="eCommunicationrecipientType") + __properties: ClassVar[List[str]] = ["pkiCommunicationrecipientID", "fkiAgentID", "fkiBrokerID", "fkiContactID", "fkiCustomerID", "fkiEmployeeID", "fkiAssistantID", "fkiExternalbrokerID", "fkiEzsignsignerID", "fkiNotaryID", "fkiSupplierID", "fkiUserID", "fkiMailboxsharedID", "fkiPhonelinesharedID", "eCommunicationrecipientType"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> CommunicationrecipientRequest: + def from_json(cls, json_str: str) -> Self: """Create an instance of CommunicationrecipientRequest from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> CommunicationrecipientRequest: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of CommunicationrecipientRequest from a dict""" if obj is None: return None if not isinstance(obj, dict): - return CommunicationrecipientRequest.parse_obj(obj) - - _obj = CommunicationrecipientRequest.parse_obj({ - "pki_communicationrecipient_id": obj.get("pkiCommunicationrecipientID"), - "fki_agent_id": obj.get("fkiAgentID"), - "fki_agentincorporation_id": obj.get("fkiAgentincorporationID"), - "fki_broker_id": obj.get("fkiBrokerID"), - "fki_customer_id": obj.get("fkiCustomerID"), - "fki_employee_id": obj.get("fkiEmployeeID"), - "fki_assistant_id": obj.get("fkiAssistantID"), - "fki_externalbroker_id": obj.get("fkiExternalbrokerID"), - "fki_ezsignsigner_id": obj.get("fkiEzsignsignerID"), - "fki_notary_id": obj.get("fkiNotaryID"), - "fki_supplier_id": obj.get("fkiSupplierID"), - "fki_user_id": obj.get("fkiUserID"), - "e_communicationrecipient_type": obj.get("eCommunicationrecipientType") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiCommunicationrecipientID": obj.get("pkiCommunicationrecipientID"), + "fkiAgentID": obj.get("fkiAgentID"), + "fkiBrokerID": obj.get("fkiBrokerID"), + "fkiContactID": obj.get("fkiContactID"), + "fkiCustomerID": obj.get("fkiCustomerID"), + "fkiEmployeeID": obj.get("fkiEmployeeID"), + "fkiAssistantID": obj.get("fkiAssistantID"), + "fkiExternalbrokerID": obj.get("fkiExternalbrokerID"), + "fkiEzsignsignerID": obj.get("fkiEzsignsignerID"), + "fkiNotaryID": obj.get("fkiNotaryID"), + "fkiSupplierID": obj.get("fkiSupplierID"), + "fkiUserID": obj.get("fkiUserID"), + "fkiMailboxsharedID": obj.get("fkiMailboxsharedID"), + "fkiPhonelinesharedID": obj.get("fkiPhonelinesharedID"), + "eCommunicationrecipientType": obj.get("eCommunicationrecipientType") }) return _obj diff --git a/eZmaxApi/models/communicationrecipient_request_compound.py b/eZmaxApi/models/communicationrecipient_request_compound.py index 5642012bd..f5de7a6df 100644 --- a/eZmaxApi/models/communicationrecipient_request_compound.py +++ b/eZmaxApi/models/communicationrecipient_request_compound.py @@ -19,78 +19,101 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.field_e_communicationrecipient_type import FieldECommunicationrecipientType +try: + from typing import Self +except ImportError: + from typing_extensions import Self class CommunicationrecipientRequestCompound(BaseModel): """ - A Communicationrecipient Object and children # noqa: E501 - """ - pki_communicationrecipient_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="pkiCommunicationrecipientID", description="The unique ID of the Communicationrecipient.") - fki_agent_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiAgentID", description="The unique ID of the Agent.") - fki_agentincorporation_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiAgentincorporationID", description="The unique ID of the Agentincorporation.") - fki_broker_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiBrokerID", description="The unique ID of the Broker.") - fki_customer_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiCustomerID", description="The unique ID of the Customer.") - fki_employee_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiEmployeeID", description="The unique ID of the Employee.") - fki_assistant_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiAssistantID", description="The unique ID of the Assistant.") - fki_externalbroker_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiExternalbrokerID", description="The unique ID of the Externalbroker.") - fki_ezsignsigner_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiEzsignsignerID", description="The unique ID of the Ezsignsigner") - fki_notary_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiNotaryID", description="The unique ID of the Notary.") - fki_supplier_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiSupplierID", description="The unique ID of the Supplier.") - fki_user_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiUserID", description="The unique ID of the User") - e_communicationrecipient_type: Optional[FieldECommunicationrecipientType] = Field(None, alias="eCommunicationrecipientType") - __properties = ["pkiCommunicationrecipientID", "fkiAgentID", "fkiAgentincorporationID", "fkiBrokerID", "fkiCustomerID", "fkiEmployeeID", "fkiAssistantID", "fkiExternalbrokerID", "fkiEzsignsignerID", "fkiNotaryID", "fkiSupplierID", "fkiUserID", "eCommunicationrecipientType"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + A Communicationrecipient Object and children + """ # noqa: E501 + pki_communicationrecipient_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Communicationrecipient.", alias="pkiCommunicationrecipientID") + fki_agent_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Agent.", alias="fkiAgentID") + fki_broker_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Broker.", alias="fkiBrokerID") + fki_contact_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Contact", alias="fkiContactID") + fki_customer_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Customer.", alias="fkiCustomerID") + fki_employee_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Employee.", alias="fkiEmployeeID") + fki_assistant_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Assistant.", alias="fkiAssistantID") + fki_externalbroker_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Externalbroker.", alias="fkiExternalbrokerID") + fki_ezsignsigner_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsignsigner", alias="fkiEzsignsignerID") + fki_notary_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Notary.", alias="fkiNotaryID") + fki_supplier_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Supplier.", alias="fkiSupplierID") + fki_user_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the User", alias="fkiUserID") + fki_mailboxshared_id: Optional[Annotated[int, Field(le=255, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Mailboxshared", alias="fkiMailboxsharedID") + fki_phonelineshared_id: Optional[Annotated[int, Field(le=255, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Phonelineshared", alias="fkiPhonelinesharedID") + e_communicationrecipient_type: Optional[FieldECommunicationrecipientType] = Field(default=None, alias="eCommunicationrecipientType") + __properties: ClassVar[List[str]] = ["pkiCommunicationrecipientID", "fkiAgentID", "fkiBrokerID", "fkiContactID", "fkiCustomerID", "fkiEmployeeID", "fkiAssistantID", "fkiExternalbrokerID", "fkiEzsignsignerID", "fkiNotaryID", "fkiSupplierID", "fkiUserID", "fkiMailboxsharedID", "fkiPhonelinesharedID", "eCommunicationrecipientType"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> CommunicationrecipientRequestCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of CommunicationrecipientRequestCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> CommunicationrecipientRequestCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of CommunicationrecipientRequestCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return CommunicationrecipientRequestCompound.parse_obj(obj) - - _obj = CommunicationrecipientRequestCompound.parse_obj({ - "pki_communicationrecipient_id": obj.get("pkiCommunicationrecipientID"), - "fki_agent_id": obj.get("fkiAgentID"), - "fki_agentincorporation_id": obj.get("fkiAgentincorporationID"), - "fki_broker_id": obj.get("fkiBrokerID"), - "fki_customer_id": obj.get("fkiCustomerID"), - "fki_employee_id": obj.get("fkiEmployeeID"), - "fki_assistant_id": obj.get("fkiAssistantID"), - "fki_externalbroker_id": obj.get("fkiExternalbrokerID"), - "fki_ezsignsigner_id": obj.get("fkiEzsignsignerID"), - "fki_notary_id": obj.get("fkiNotaryID"), - "fki_supplier_id": obj.get("fkiSupplierID"), - "fki_user_id": obj.get("fkiUserID"), - "e_communicationrecipient_type": obj.get("eCommunicationrecipientType") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiCommunicationrecipientID": obj.get("pkiCommunicationrecipientID"), + "fkiAgentID": obj.get("fkiAgentID"), + "fkiBrokerID": obj.get("fkiBrokerID"), + "fkiContactID": obj.get("fkiContactID"), + "fkiCustomerID": obj.get("fkiCustomerID"), + "fkiEmployeeID": obj.get("fkiEmployeeID"), + "fkiAssistantID": obj.get("fkiAssistantID"), + "fkiExternalbrokerID": obj.get("fkiExternalbrokerID"), + "fkiEzsignsignerID": obj.get("fkiEzsignsignerID"), + "fkiNotaryID": obj.get("fkiNotaryID"), + "fkiSupplierID": obj.get("fkiSupplierID"), + "fkiUserID": obj.get("fkiUserID"), + "fkiMailboxsharedID": obj.get("fkiMailboxsharedID"), + "fkiPhonelinesharedID": obj.get("fkiPhonelinesharedID"), + "eCommunicationrecipientType": obj.get("eCommunicationrecipientType") }) return _obj diff --git a/eZmaxApi/models/communicationreference_request.py b/eZmaxApi/models/communicationreference_request.py index 524f495c9..c9b438d21 100644 --- a/eZmaxApi/models/communicationreference_request.py +++ b/eZmaxApi/models/communicationreference_request.py @@ -19,69 +19,88 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class CommunicationreferenceRequest(BaseModel): """ - A Communicationreference Object # noqa: E501 - """ - pki_communicationreference_id: Optional[conint(strict=True, le=4294967295, ge=0)] = Field(None, alias="pkiCommunicationreferenceID", description="The unique ID of the Communicationreference") - fki_buyercontract_id: Optional[conint(strict=True, le=65535, ge=1)] = Field(None, alias="fkiBuyercontractID", description="The unique ID of the Buyercontract") - fki_ezsignfolder_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiEzsignfolderID", description="The unique ID of the Ezsignfolder") - fki_inscription_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiInscriptionID", description="The unique ID of the Inscription.") - fki_inscriptiontemp_id: Optional[conint(strict=True, le=16777215, ge=1)] = Field(None, alias="fkiInscriptiontempID", description="The unique ID of the Inscriptiontemp") - fki_invoice_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiInvoiceID", description="The unique ID of the Invoice.") - fki_otherincome_id: Optional[conint(strict=True, le=65535, ge=1)] = Field(None, alias="fkiOtherincomeID", description="The unique ID of the Otherincome") - fki_electronicfundstransfer_id: Optional[conint(strict=True, le=65535, ge=1)] = Field(None, alias="fkiElectronicfundstransferID", description="The unique ID of the Electronicfundstransfer") - fki_rejectedoffertopurchase_id: Optional[conint(strict=True, le=65535, ge=1)] = Field(None, alias="fkiRejectedoffertopurchaseID", description="The unique ID of the Rejectedoffertopurchase") - __properties = ["pkiCommunicationreferenceID", "fkiBuyercontractID", "fkiEzsignfolderID", "fkiInscriptionID", "fkiInscriptiontempID", "fkiInvoiceID", "fkiOtherincomeID", "fkiElectronicfundstransferID", "fkiRejectedoffertopurchaseID"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + A Communicationreference Object + """ # noqa: E501 + pki_communicationreference_id: Optional[Annotated[int, Field(le=4294967295, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Communicationreference", alias="pkiCommunicationreferenceID") + fki_buyercontract_id: Optional[Annotated[int, Field(le=65535, strict=True, ge=1)]] = Field(default=None, description="The unique ID of the Buyercontract", alias="fkiBuyercontractID") + fki_ezsignfolder_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsignfolder", alias="fkiEzsignfolderID") + fki_inscription_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Inscription.", alias="fkiInscriptionID") + fki_inscriptiontemp_id: Optional[Annotated[int, Field(le=16777215, strict=True, ge=1)]] = Field(default=None, description="The unique ID of the Inscriptiontemp", alias="fkiInscriptiontempID") + fki_invoice_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Invoice.", alias="fkiInvoiceID") + fki_otherincome_id: Optional[Annotated[int, Field(le=65535, strict=True, ge=1)]] = Field(default=None, description="The unique ID of the Otherincome", alias="fkiOtherincomeID") + fki_electronicfundstransfer_id: Optional[Annotated[int, Field(le=65535, strict=True, ge=1)]] = Field(default=None, description="The unique ID of the Electronicfundstransfer", alias="fkiElectronicfundstransferID") + fki_rejectedoffertopurchase_id: Optional[Annotated[int, Field(le=65535, strict=True, ge=1)]] = Field(default=None, description="The unique ID of the Rejectedoffertopurchase", alias="fkiRejectedoffertopurchaseID") + __properties: ClassVar[List[str]] = ["pkiCommunicationreferenceID", "fkiBuyercontractID", "fkiEzsignfolderID", "fkiInscriptionID", "fkiInscriptiontempID", "fkiInvoiceID", "fkiOtherincomeID", "fkiElectronicfundstransferID", "fkiRejectedoffertopurchaseID"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> CommunicationreferenceRequest: + def from_json(cls, json_str: str) -> Self: """Create an instance of CommunicationreferenceRequest from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> CommunicationreferenceRequest: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of CommunicationreferenceRequest from a dict""" if obj is None: return None if not isinstance(obj, dict): - return CommunicationreferenceRequest.parse_obj(obj) - - _obj = CommunicationreferenceRequest.parse_obj({ - "pki_communicationreference_id": obj.get("pkiCommunicationreferenceID"), - "fki_buyercontract_id": obj.get("fkiBuyercontractID"), - "fki_ezsignfolder_id": obj.get("fkiEzsignfolderID"), - "fki_inscription_id": obj.get("fkiInscriptionID"), - "fki_inscriptiontemp_id": obj.get("fkiInscriptiontempID"), - "fki_invoice_id": obj.get("fkiInvoiceID"), - "fki_otherincome_id": obj.get("fkiOtherincomeID"), - "fki_electronicfundstransfer_id": obj.get("fkiElectronicfundstransferID"), - "fki_rejectedoffertopurchase_id": obj.get("fkiRejectedoffertopurchaseID") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiCommunicationreferenceID": obj.get("pkiCommunicationreferenceID"), + "fkiBuyercontractID": obj.get("fkiBuyercontractID"), + "fkiEzsignfolderID": obj.get("fkiEzsignfolderID"), + "fkiInscriptionID": obj.get("fkiInscriptionID"), + "fkiInscriptiontempID": obj.get("fkiInscriptiontempID"), + "fkiInvoiceID": obj.get("fkiInvoiceID"), + "fkiOtherincomeID": obj.get("fkiOtherincomeID"), + "fkiElectronicfundstransferID": obj.get("fkiElectronicfundstransferID"), + "fkiRejectedoffertopurchaseID": obj.get("fkiRejectedoffertopurchaseID") }) return _obj diff --git a/eZmaxApi/models/communicationreference_request_compound.py b/eZmaxApi/models/communicationreference_request_compound.py index 26ca2389c..00ec921f8 100644 --- a/eZmaxApi/models/communicationreference_request_compound.py +++ b/eZmaxApi/models/communicationreference_request_compound.py @@ -19,69 +19,88 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class CommunicationreferenceRequestCompound(BaseModel): """ - A Communicationreference Object and children # noqa: E501 - """ - pki_communicationreference_id: Optional[conint(strict=True, le=4294967295, ge=0)] = Field(None, alias="pkiCommunicationreferenceID", description="The unique ID of the Communicationreference") - fki_buyercontract_id: Optional[conint(strict=True, le=65535, ge=1)] = Field(None, alias="fkiBuyercontractID", description="The unique ID of the Buyercontract") - fki_ezsignfolder_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiEzsignfolderID", description="The unique ID of the Ezsignfolder") - fki_inscription_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiInscriptionID", description="The unique ID of the Inscription.") - fki_inscriptiontemp_id: Optional[conint(strict=True, le=16777215, ge=1)] = Field(None, alias="fkiInscriptiontempID", description="The unique ID of the Inscriptiontemp") - fki_invoice_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiInvoiceID", description="The unique ID of the Invoice.") - fki_otherincome_id: Optional[conint(strict=True, le=65535, ge=1)] = Field(None, alias="fkiOtherincomeID", description="The unique ID of the Otherincome") - fki_electronicfundstransfer_id: Optional[conint(strict=True, le=65535, ge=1)] = Field(None, alias="fkiElectronicfundstransferID", description="The unique ID of the Electronicfundstransfer") - fki_rejectedoffertopurchase_id: Optional[conint(strict=True, le=65535, ge=1)] = Field(None, alias="fkiRejectedoffertopurchaseID", description="The unique ID of the Rejectedoffertopurchase") - __properties = ["pkiCommunicationreferenceID", "fkiBuyercontractID", "fkiEzsignfolderID", "fkiInscriptionID", "fkiInscriptiontempID", "fkiInvoiceID", "fkiOtherincomeID", "fkiElectronicfundstransferID", "fkiRejectedoffertopurchaseID"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + A Communicationreference Object and children + """ # noqa: E501 + pki_communicationreference_id: Optional[Annotated[int, Field(le=4294967295, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Communicationreference", alias="pkiCommunicationreferenceID") + fki_buyercontract_id: Optional[Annotated[int, Field(le=65535, strict=True, ge=1)]] = Field(default=None, description="The unique ID of the Buyercontract", alias="fkiBuyercontractID") + fki_ezsignfolder_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsignfolder", alias="fkiEzsignfolderID") + fki_inscription_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Inscription.", alias="fkiInscriptionID") + fki_inscriptiontemp_id: Optional[Annotated[int, Field(le=16777215, strict=True, ge=1)]] = Field(default=None, description="The unique ID of the Inscriptiontemp", alias="fkiInscriptiontempID") + fki_invoice_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Invoice.", alias="fkiInvoiceID") + fki_otherincome_id: Optional[Annotated[int, Field(le=65535, strict=True, ge=1)]] = Field(default=None, description="The unique ID of the Otherincome", alias="fkiOtherincomeID") + fki_electronicfundstransfer_id: Optional[Annotated[int, Field(le=65535, strict=True, ge=1)]] = Field(default=None, description="The unique ID of the Electronicfundstransfer", alias="fkiElectronicfundstransferID") + fki_rejectedoffertopurchase_id: Optional[Annotated[int, Field(le=65535, strict=True, ge=1)]] = Field(default=None, description="The unique ID of the Rejectedoffertopurchase", alias="fkiRejectedoffertopurchaseID") + __properties: ClassVar[List[str]] = ["pkiCommunicationreferenceID", "fkiBuyercontractID", "fkiEzsignfolderID", "fkiInscriptionID", "fkiInscriptiontempID", "fkiInvoiceID", "fkiOtherincomeID", "fkiElectronicfundstransferID", "fkiRejectedoffertopurchaseID"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> CommunicationreferenceRequestCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of CommunicationreferenceRequestCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> CommunicationreferenceRequestCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of CommunicationreferenceRequestCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return CommunicationreferenceRequestCompound.parse_obj(obj) - - _obj = CommunicationreferenceRequestCompound.parse_obj({ - "pki_communicationreference_id": obj.get("pkiCommunicationreferenceID"), - "fki_buyercontract_id": obj.get("fkiBuyercontractID"), - "fki_ezsignfolder_id": obj.get("fkiEzsignfolderID"), - "fki_inscription_id": obj.get("fkiInscriptionID"), - "fki_inscriptiontemp_id": obj.get("fkiInscriptiontempID"), - "fki_invoice_id": obj.get("fkiInvoiceID"), - "fki_otherincome_id": obj.get("fkiOtherincomeID"), - "fki_electronicfundstransfer_id": obj.get("fkiElectronicfundstransferID"), - "fki_rejectedoffertopurchase_id": obj.get("fkiRejectedoffertopurchaseID") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiCommunicationreferenceID": obj.get("pkiCommunicationreferenceID"), + "fkiBuyercontractID": obj.get("fkiBuyercontractID"), + "fkiEzsignfolderID": obj.get("fkiEzsignfolderID"), + "fkiInscriptionID": obj.get("fkiInscriptionID"), + "fkiInscriptiontempID": obj.get("fkiInscriptiontempID"), + "fkiInvoiceID": obj.get("fkiInvoiceID"), + "fkiOtherincomeID": obj.get("fkiOtherincomeID"), + "fkiElectronicfundstransferID": obj.get("fkiElectronicfundstransferID"), + "fkiRejectedoffertopurchaseID": obj.get("fkiRejectedoffertopurchaseID") }) return _obj diff --git a/eZmaxApi/models/company_autocomplete_element_response.py b/eZmaxApi/models/company_autocomplete_element_response.py index 93edc303b..12500fcab 100644 --- a/eZmaxApi/models/company_autocomplete_element_response.py +++ b/eZmaxApi/models/company_autocomplete_element_response.py @@ -19,57 +19,76 @@ import json - -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictBool, StrictStr +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class CompanyAutocompleteElementResponse(BaseModel): """ - A Company AutocompleteElement Response # noqa: E501 - """ - pki_company_id: conint(strict=True, le=255, ge=1) = Field(..., alias="pkiCompanyID", description="The unique ID of the Company") - s_company_name_x: StrictStr = Field(..., alias="sCompanyNameX", description="The Name of the Company in the language of the requester") - b_company_isactive: StrictBool = Field(..., alias="bCompanyIsactive", description="Whether the Company is active or not") - __properties = ["pkiCompanyID", "sCompanyNameX", "bCompanyIsactive"] + A Company AutocompleteElement Response + """ # noqa: E501 + pki_company_id: Annotated[int, Field(le=255, strict=True, ge=1)] = Field(description="The unique ID of the Company", alias="pkiCompanyID") + s_company_name_x: StrictStr = Field(description="The Name of the Company in the language of the requester", alias="sCompanyNameX") + b_company_isactive: StrictBool = Field(description="Whether the Company is active or not", alias="bCompanyIsactive") + __properties: ClassVar[List[str]] = ["pkiCompanyID", "sCompanyNameX", "bCompanyIsactive"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> CompanyAutocompleteElementResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of CompanyAutocompleteElementResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> CompanyAutocompleteElementResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of CompanyAutocompleteElementResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return CompanyAutocompleteElementResponse.parse_obj(obj) + return cls.model_validate(obj) - _obj = CompanyAutocompleteElementResponse.parse_obj({ - "pki_company_id": obj.get("pkiCompanyID"), - "s_company_name_x": obj.get("sCompanyNameX"), - "b_company_isactive": obj.get("bCompanyIsactive") + _obj = cls.model_validate({ + "pkiCompanyID": obj.get("pkiCompanyID"), + "sCompanyNameX": obj.get("sCompanyNameX"), + "bCompanyIsactive": obj.get("bCompanyIsactive") }) return _obj diff --git a/eZmaxApi/models/company_get_autocomplete_v2_response.py b/eZmaxApi/models/company_get_autocomplete_v2_response.py index 3e02da385..a0e2ccd07 100644 --- a/eZmaxApi/models/company_get_autocomplete_v2_response.py +++ b/eZmaxApi/models/company_get_autocomplete_v2_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.company_get_autocomplete_v2_response_m_payload import CompanyGetAutocompleteV2ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class CompanyGetAutocompleteV2Response(BaseModel): """ - Response for GET /2/object/company/getAutocomplete # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: CompanyGetAutocompleteV2ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /2/object/company/getAutocomplete + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: CompanyGetAutocompleteV2ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> CompanyGetAutocompleteV2Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of CompanyGetAutocompleteV2Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> CompanyGetAutocompleteV2Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of CompanyGetAutocompleteV2Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return CompanyGetAutocompleteV2Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = CompanyGetAutocompleteV2Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": CompanyGetAutocompleteV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": CompanyGetAutocompleteV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/company_get_autocomplete_v2_response_m_payload.py b/eZmaxApi/models/company_get_autocomplete_v2_response_m_payload.py index 04e7ed211..e6a1e6bd6 100644 --- a/eZmaxApi/models/company_get_autocomplete_v2_response_m_payload.py +++ b/eZmaxApi/models/company_get_autocomplete_v2_response_m_payload.py @@ -19,41 +19,59 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.company_autocomplete_element_response import CompanyAutocompleteElementResponse +try: + from typing import Self +except ImportError: + from typing_extensions import Self class CompanyGetAutocompleteV2ResponseMPayload(BaseModel): """ - Payload for POST /2/object/company/getAutocomplete # noqa: E501 - """ - a_obj_company: conlist(CompanyAutocompleteElementResponse) = Field(..., alias="a_objCompany", description="An array of Company autocomplete element response.") - __properties = ["a_objCompany"] + Payload for POST /2/object/company/getAutocomplete + """ # noqa: E501 + a_obj_company: List[CompanyAutocompleteElementResponse] = Field(description="An array of Company autocomplete element response.", alias="a_objCompany") + __properties: ClassVar[List[str]] = ["a_objCompany"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> CompanyGetAutocompleteV2ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of CompanyGetAutocompleteV2ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_company (list) _items = [] if self.a_obj_company: @@ -64,16 +82,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> CompanyGetAutocompleteV2ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of CompanyGetAutocompleteV2ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return CompanyGetAutocompleteV2ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = CompanyGetAutocompleteV2ResponseMPayload.parse_obj({ - "a_obj_company": [CompanyAutocompleteElementResponse.from_dict(_item) for _item in obj.get("a_objCompany")] if obj.get("a_objCompany") is not None else None + _obj = cls.model_validate({ + "a_objCompany": [CompanyAutocompleteElementResponse.from_dict(_item) for _item in obj.get("a_objCompany")] if obj.get("a_objCompany") is not None else None }) return _obj diff --git a/eZmaxApi/models/computed_e_communication_direction.py b/eZmaxApi/models/computed_e_communication_direction.py index 9870ea875..6c5c1c121 100644 --- a/eZmaxApi/models/computed_e_communication_direction.py +++ b/eZmaxApi/models/computed_e_communication_direction.py @@ -13,13 +13,18 @@ """ # noqa: E501 +from __future__ import annotations import json import pprint import re # noqa: F401 -from aenum import Enum, no_arg +from enum import Enum +try: + from typing import Self +except ImportError: + from typing_extensions import Self class ComputedECommunicationDirection(str, Enum): @@ -34,8 +39,8 @@ class ComputedECommunicationDirection(str, Enum): INBOUND = 'Inbound' @classmethod - def from_json(cls, json_str: str) -> ComputedECommunicationDirection: + def from_json(cls, json_str: str) -> Self: """Create an instance of ComputedECommunicationDirection from a JSON string""" - return ComputedECommunicationDirection(json.loads(json_str)) + return cls(json.loads(json_str)) diff --git a/eZmaxApi/models/computed_e_ezsigndocument_steptype.py b/eZmaxApi/models/computed_e_ezsigndocument_steptype.py index 02c44c78b..fb352a46f 100644 --- a/eZmaxApi/models/computed_e_ezsigndocument_steptype.py +++ b/eZmaxApi/models/computed_e_ezsigndocument_steptype.py @@ -13,13 +13,18 @@ """ # noqa: E501 +from __future__ import annotations import json import pprint import re # noqa: F401 -from aenum import Enum, no_arg +from enum import Enum +try: + from typing import Self +except ImportError: + from typing_extensions import Self class ComputedEEzsigndocumentSteptype(str, Enum): @@ -35,8 +40,8 @@ class ComputedEEzsigndocumentSteptype(str, Enum): NONE = 'None' @classmethod - def from_json(cls, json_str: str) -> ComputedEEzsigndocumentSteptype: + def from_json(cls, json_str: str) -> Self: """Create an instance of ComputedEEzsigndocumentSteptype from a JSON string""" - return ComputedEEzsigndocumentSteptype(json.loads(json_str)) + return cls(json.loads(json_str)) diff --git a/eZmaxApi/models/contact_request.py b/eZmaxApi/models/contact_request.py index 38c76fdcb..77c045172 100644 --- a/eZmaxApi/models/contact_request.py +++ b/eZmaxApi/models/contact_request.py @@ -19,63 +19,82 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictStr, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictStr +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class ContactRequest(BaseModel): """ - A Contact Object # noqa: E501 - """ - fki_contacttitle_id: conint(strict=True, ge=0) = Field(..., alias="fkiContacttitleID", description="The unique ID of the Contacttitle. Valid values: |Value|Description| |-|-| |1|Ms.| |2|Mr.| |4|(Blank)| |5|Me (For Notaries)|") - fki_language_id: conint(strict=True, le=2, ge=1) = Field(..., alias="fkiLanguageID", description="The unique ID of the Language. Valid values: |Value|Description| |-|-| |1|French| |2|English|") - s_contact_firstname: StrictStr = Field(..., alias="sContactFirstname", description="The First name of the contact") - s_contact_lastname: StrictStr = Field(..., alias="sContactLastname", description="The Last name of the contact") - s_contact_company: StrictStr = Field(..., alias="sContactCompany", description="The Company name of the contact") - dt_contact_birthdate: Optional[StrictStr] = Field(None, alias="dtContactBirthdate", description="The Birth Date of the contact") - __properties = ["fkiContacttitleID", "fkiLanguageID", "sContactFirstname", "sContactLastname", "sContactCompany", "dtContactBirthdate"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + A Contact Object + """ # noqa: E501 + fki_contacttitle_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Contacttitle. Valid values: |Value|Description| |-|-| |1|Ms.| |2|Mr.| |4|(Blank)| |5|Me (For Notaries)|", alias="fkiContacttitleID") + fki_language_id: Annotated[int, Field(le=2, strict=True, ge=1)] = Field(description="The unique ID of the Language. Valid values: |Value|Description| |-|-| |1|French| |2|English|", alias="fkiLanguageID") + s_contact_firstname: StrictStr = Field(description="The First name of the contact", alias="sContactFirstname") + s_contact_lastname: StrictStr = Field(description="The Last name of the contact", alias="sContactLastname") + s_contact_company: StrictStr = Field(description="The Company name of the contact", alias="sContactCompany") + dt_contact_birthdate: Optional[StrictStr] = Field(default=None, description="The Birth Date of the contact", alias="dtContactBirthdate") + __properties: ClassVar[List[str]] = ["fkiContacttitleID", "fkiLanguageID", "sContactFirstname", "sContactLastname", "sContactCompany", "dtContactBirthdate"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> ContactRequest: + def from_json(cls, json_str: str) -> Self: """Create an instance of ContactRequest from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> ContactRequest: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of ContactRequest from a dict""" if obj is None: return None if not isinstance(obj, dict): - return ContactRequest.parse_obj(obj) - - _obj = ContactRequest.parse_obj({ - "fki_contacttitle_id": obj.get("fkiContacttitleID"), - "fki_language_id": obj.get("fkiLanguageID"), - "s_contact_firstname": obj.get("sContactFirstname"), - "s_contact_lastname": obj.get("sContactLastname"), - "s_contact_company": obj.get("sContactCompany"), - "dt_contact_birthdate": obj.get("dtContactBirthdate") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "fkiContacttitleID": obj.get("fkiContacttitleID"), + "fkiLanguageID": obj.get("fkiLanguageID"), + "sContactFirstname": obj.get("sContactFirstname"), + "sContactLastname": obj.get("sContactLastname"), + "sContactCompany": obj.get("sContactCompany"), + "dtContactBirthdate": obj.get("dtContactBirthdate") }) return _obj diff --git a/eZmaxApi/models/contact_request_compound.py b/eZmaxApi/models/contact_request_compound.py index bbbef3f14..37b453691 100644 --- a/eZmaxApi/models/contact_request_compound.py +++ b/eZmaxApi/models/contact_request_compound.py @@ -19,69 +19,88 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictStr, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictStr +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.contactinformations_request_compound import ContactinformationsRequestCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class ContactRequestCompound(BaseModel): """ - A Contact Object and children to create a complete structure # noqa: E501 - """ - fki_contacttitle_id: conint(strict=True, ge=0) = Field(..., alias="fkiContacttitleID", description="The unique ID of the Contacttitle. Valid values: |Value|Description| |-|-| |1|Ms.| |2|Mr.| |4|(Blank)| |5|Me (For Notaries)|") - fki_language_id: conint(strict=True, le=2, ge=1) = Field(..., alias="fkiLanguageID", description="The unique ID of the Language. Valid values: |Value|Description| |-|-| |1|French| |2|English|") - s_contact_firstname: StrictStr = Field(..., alias="sContactFirstname", description="The First name of the contact") - s_contact_lastname: StrictStr = Field(..., alias="sContactLastname", description="The Last name of the contact") - s_contact_company: StrictStr = Field(..., alias="sContactCompany", description="The Company name of the contact") - dt_contact_birthdate: Optional[StrictStr] = Field(None, alias="dtContactBirthdate", description="The Birth Date of the contact") - obj_contactinformations: ContactinformationsRequestCompound = Field(..., alias="objContactinformations") - __properties = ["fkiContacttitleID", "fkiLanguageID", "sContactFirstname", "sContactLastname", "sContactCompany", "dtContactBirthdate", "objContactinformations"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + A Contact Object and children to create a complete structure + """ # noqa: E501 + fki_contacttitle_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Contacttitle. Valid values: |Value|Description| |-|-| |1|Ms.| |2|Mr.| |4|(Blank)| |5|Me (For Notaries)|", alias="fkiContacttitleID") + fki_language_id: Annotated[int, Field(le=2, strict=True, ge=1)] = Field(description="The unique ID of the Language. Valid values: |Value|Description| |-|-| |1|French| |2|English|", alias="fkiLanguageID") + s_contact_firstname: StrictStr = Field(description="The First name of the contact", alias="sContactFirstname") + s_contact_lastname: StrictStr = Field(description="The Last name of the contact", alias="sContactLastname") + s_contact_company: StrictStr = Field(description="The Company name of the contact", alias="sContactCompany") + dt_contact_birthdate: Optional[StrictStr] = Field(default=None, description="The Birth Date of the contact", alias="dtContactBirthdate") + obj_contactinformations: ContactinformationsRequestCompound = Field(alias="objContactinformations") + __properties: ClassVar[List[str]] = ["fkiContacttitleID", "fkiLanguageID", "sContactFirstname", "sContactLastname", "sContactCompany", "dtContactBirthdate", "objContactinformations"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> ContactRequestCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of ContactRequestCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_contactinformations if self.obj_contactinformations: _dict['objContactinformations'] = self.obj_contactinformations.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> ContactRequestCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of ContactRequestCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return ContactRequestCompound.parse_obj(obj) - - _obj = ContactRequestCompound.parse_obj({ - "fki_contacttitle_id": obj.get("fkiContacttitleID"), - "fki_language_id": obj.get("fkiLanguageID"), - "s_contact_firstname": obj.get("sContactFirstname"), - "s_contact_lastname": obj.get("sContactLastname"), - "s_contact_company": obj.get("sContactCompany"), - "dt_contact_birthdate": obj.get("dtContactBirthdate"), - "obj_contactinformations": ContactinformationsRequestCompound.from_dict(obj.get("objContactinformations")) if obj.get("objContactinformations") is not None else None + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "fkiContacttitleID": obj.get("fkiContacttitleID"), + "fkiLanguageID": obj.get("fkiLanguageID"), + "sContactFirstname": obj.get("sContactFirstname"), + "sContactLastname": obj.get("sContactLastname"), + "sContactCompany": obj.get("sContactCompany"), + "dtContactBirthdate": obj.get("dtContactBirthdate"), + "objContactinformations": ContactinformationsRequestCompound.from_dict(obj.get("objContactinformations")) if obj.get("objContactinformations") is not None else None }) return _obj diff --git a/eZmaxApi/models/contactinformations_request.py b/eZmaxApi/models/contactinformations_request.py index c5f676b51..608e9d382 100644 --- a/eZmaxApi/models/contactinformations_request.py +++ b/eZmaxApi/models/contactinformations_request.py @@ -19,59 +19,77 @@ import json - -from pydantic import BaseModel, Field, StrictInt +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictInt +from pydantic import Field +try: + from typing import Self +except ImportError: + from typing_extensions import Self class ContactinformationsRequest(BaseModel): """ - A Contactinformations Object # noqa: E501 - """ - i_address_default: StrictInt = Field(..., alias="iAddressDefault", description="The index in the a_objAddress array (zero based index) representing the Address object that should become the default one. You can leave the value to 0 if the array is empty.") - i_phone_default: StrictInt = Field(..., alias="iPhoneDefault", description="The index in the a_objPhone array (zero based index) representing the Phone object that should become the default one. You can leave the value to 0 if the array is empty.") - i_email_default: StrictInt = Field(..., alias="iEmailDefault", description="The index in the a_objEmail array (zero based index) representing the Email object that should become the default one. You can leave the value to 0 if the array is empty.") - i_website_default: StrictInt = Field(..., alias="iWebsiteDefault", description="The index in the a_objWebsite array (zero based index) representing the Website object that should become the default one. You can leave the value to 0 if the array is empty.") - __properties = ["iAddressDefault", "iPhoneDefault", "iEmailDefault", "iWebsiteDefault"] + A Contactinformations Object + """ # noqa: E501 + i_address_default: StrictInt = Field(description="The index in the a_objAddress array (zero based index) representing the Address object that should become the default one. You can leave the value to 0 if the array is empty.", alias="iAddressDefault") + i_phone_default: StrictInt = Field(description="The index in the a_objPhone array (zero based index) representing the Phone object that should become the default one. You can leave the value to 0 if the array is empty.", alias="iPhoneDefault") + i_email_default: StrictInt = Field(description="The index in the a_objEmail array (zero based index) representing the Email object that should become the default one. You can leave the value to 0 if the array is empty.", alias="iEmailDefault") + i_website_default: StrictInt = Field(description="The index in the a_objWebsite array (zero based index) representing the Website object that should become the default one. You can leave the value to 0 if the array is empty.", alias="iWebsiteDefault") + __properties: ClassVar[List[str]] = ["iAddressDefault", "iPhoneDefault", "iEmailDefault", "iWebsiteDefault"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> ContactinformationsRequest: + def from_json(cls, json_str: str) -> Self: """Create an instance of ContactinformationsRequest from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> ContactinformationsRequest: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of ContactinformationsRequest from a dict""" if obj is None: return None if not isinstance(obj, dict): - return ContactinformationsRequest.parse_obj(obj) + return cls.model_validate(obj) - _obj = ContactinformationsRequest.parse_obj({ - "i_address_default": obj.get("iAddressDefault"), - "i_phone_default": obj.get("iPhoneDefault"), - "i_email_default": obj.get("iEmailDefault"), - "i_website_default": obj.get("iWebsiteDefault") + _obj = cls.model_validate({ + "iAddressDefault": obj.get("iAddressDefault"), + "iPhoneDefault": obj.get("iPhoneDefault"), + "iEmailDefault": obj.get("iEmailDefault"), + "iWebsiteDefault": obj.get("iWebsiteDefault") }) return _obj diff --git a/eZmaxApi/models/contactinformations_request_compound.py b/eZmaxApi/models/contactinformations_request_compound.py index 169e802b8..35e810e2f 100644 --- a/eZmaxApi/models/contactinformations_request_compound.py +++ b/eZmaxApi/models/contactinformations_request_compound.py @@ -19,51 +19,69 @@ import json -from typing import List -from pydantic import BaseModel, Field, StrictInt, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictInt +from pydantic import Field from eZmaxApi.models.address_request_compound import AddressRequestCompound from eZmaxApi.models.email_request_compound import EmailRequestCompound from eZmaxApi.models.phone_request_compound import PhoneRequestCompound from eZmaxApi.models.website_request_compound import WebsiteRequestCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class ContactinformationsRequestCompound(BaseModel): """ - A Contactinformations Object and children to create a complete structure # noqa: E501 - """ - i_address_default: StrictInt = Field(..., alias="iAddressDefault", description="The index in the a_objAddress array (zero based index) representing the Address object that should become the default one. You can leave the value to 0 if the array is empty.") - i_phone_default: StrictInt = Field(..., alias="iPhoneDefault", description="The index in the a_objPhone array (zero based index) representing the Phone object that should become the default one. You can leave the value to 0 if the array is empty.") - i_email_default: StrictInt = Field(..., alias="iEmailDefault", description="The index in the a_objEmail array (zero based index) representing the Email object that should become the default one. You can leave the value to 0 if the array is empty.") - i_website_default: StrictInt = Field(..., alias="iWebsiteDefault", description="The index in the a_objWebsite array (zero based index) representing the Website object that should become the default one. You can leave the value to 0 if the array is empty.") - a_obj_address: conlist(AddressRequestCompound) = Field(..., alias="a_objAddress") - a_obj_phone: conlist(PhoneRequestCompound) = Field(..., alias="a_objPhone") - a_obj_email: conlist(EmailRequestCompound) = Field(..., alias="a_objEmail") - a_obj_website: conlist(WebsiteRequestCompound) = Field(..., alias="a_objWebsite") - __properties = ["iAddressDefault", "iPhoneDefault", "iEmailDefault", "iWebsiteDefault", "a_objAddress", "a_objPhone", "a_objEmail", "a_objWebsite"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + A Contactinformations Object and children to create a complete structure + """ # noqa: E501 + i_address_default: StrictInt = Field(description="The index in the a_objAddress array (zero based index) representing the Address object that should become the default one. You can leave the value to 0 if the array is empty.", alias="iAddressDefault") + i_phone_default: StrictInt = Field(description="The index in the a_objPhone array (zero based index) representing the Phone object that should become the default one. You can leave the value to 0 if the array is empty.", alias="iPhoneDefault") + i_email_default: StrictInt = Field(description="The index in the a_objEmail array (zero based index) representing the Email object that should become the default one. You can leave the value to 0 if the array is empty.", alias="iEmailDefault") + i_website_default: StrictInt = Field(description="The index in the a_objWebsite array (zero based index) representing the Website object that should become the default one. You can leave the value to 0 if the array is empty.", alias="iWebsiteDefault") + a_obj_address: List[AddressRequestCompound] = Field(alias="a_objAddress") + a_obj_phone: List[PhoneRequestCompound] = Field(alias="a_objPhone") + a_obj_email: List[EmailRequestCompound] = Field(alias="a_objEmail") + a_obj_website: List[WebsiteRequestCompound] = Field(alias="a_objWebsite") + __properties: ClassVar[List[str]] = ["iAddressDefault", "iPhoneDefault", "iEmailDefault", "iWebsiteDefault", "a_objAddress", "a_objPhone", "a_objEmail", "a_objWebsite"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> ContactinformationsRequestCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of ContactinformationsRequestCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_address (list) _items = [] if self.a_obj_address: @@ -95,23 +113,23 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> ContactinformationsRequestCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of ContactinformationsRequestCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return ContactinformationsRequestCompound.parse_obj(obj) - - _obj = ContactinformationsRequestCompound.parse_obj({ - "i_address_default": obj.get("iAddressDefault"), - "i_phone_default": obj.get("iPhoneDefault"), - "i_email_default": obj.get("iEmailDefault"), - "i_website_default": obj.get("iWebsiteDefault"), - "a_obj_address": [AddressRequestCompound.from_dict(_item) for _item in obj.get("a_objAddress")] if obj.get("a_objAddress") is not None else None, - "a_obj_phone": [PhoneRequestCompound.from_dict(_item) for _item in obj.get("a_objPhone")] if obj.get("a_objPhone") is not None else None, - "a_obj_email": [EmailRequestCompound.from_dict(_item) for _item in obj.get("a_objEmail")] if obj.get("a_objEmail") is not None else None, - "a_obj_website": [WebsiteRequestCompound.from_dict(_item) for _item in obj.get("a_objWebsite")] if obj.get("a_objWebsite") is not None else None + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "iAddressDefault": obj.get("iAddressDefault"), + "iPhoneDefault": obj.get("iPhoneDefault"), + "iEmailDefault": obj.get("iEmailDefault"), + "iWebsiteDefault": obj.get("iWebsiteDefault"), + "a_objAddress": [AddressRequestCompound.from_dict(_item) for _item in obj.get("a_objAddress")] if obj.get("a_objAddress") is not None else None, + "a_objPhone": [PhoneRequestCompound.from_dict(_item) for _item in obj.get("a_objPhone")] if obj.get("a_objPhone") is not None else None, + "a_objEmail": [EmailRequestCompound.from_dict(_item) for _item in obj.get("a_objEmail")] if obj.get("a_objEmail") is not None else None, + "a_objWebsite": [WebsiteRequestCompound.from_dict(_item) for _item in obj.get("a_objWebsite")] if obj.get("a_objWebsite") is not None else None }) return _obj diff --git a/eZmaxApi/models/cors_create_object_v1_request.py b/eZmaxApi/models/cors_create_object_v1_request.py index 581ddabed..fe938fea1 100644 --- a/eZmaxApi/models/cors_create_object_v1_request.py +++ b/eZmaxApi/models/cors_create_object_v1_request.py @@ -19,41 +19,60 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.cors_request_compound import CorsRequestCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class CorsCreateObjectV1Request(BaseModel): """ - Request for POST /1/object/cors # noqa: E501 - """ - a_obj_cors: conlist(CorsRequestCompound, min_items=1) = Field(..., alias="a_objCors") - __properties = ["a_objCors"] + Request for POST /1/object/cors + """ # noqa: E501 + a_obj_cors: Annotated[List[CorsRequestCompound], Field(min_length=1)] = Field(alias="a_objCors") + __properties: ClassVar[List[str]] = ["a_objCors"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> CorsCreateObjectV1Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of CorsCreateObjectV1Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_cors (list) _items = [] if self.a_obj_cors: @@ -64,16 +83,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> CorsCreateObjectV1Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of CorsCreateObjectV1Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return CorsCreateObjectV1Request.parse_obj(obj) + return cls.model_validate(obj) - _obj = CorsCreateObjectV1Request.parse_obj({ - "a_obj_cors": [CorsRequestCompound.from_dict(_item) for _item in obj.get("a_objCors")] if obj.get("a_objCors") is not None else None + _obj = cls.model_validate({ + "a_objCors": [CorsRequestCompound.from_dict(_item) for _item in obj.get("a_objCors")] if obj.get("a_objCors") is not None else None }) return _obj diff --git a/eZmaxApi/models/cors_create_object_v1_response.py b/eZmaxApi/models/cors_create_object_v1_response.py index 6f2c0c678..4fbbac845 100644 --- a/eZmaxApi/models/cors_create_object_v1_response.py +++ b/eZmaxApi/models/cors_create_object_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.cors_create_object_v1_response_m_payload import CorsCreateObjectV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class CorsCreateObjectV1Response(BaseModel): """ - Response for POST /1/object/cors # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: CorsCreateObjectV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for POST /1/object/cors + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: CorsCreateObjectV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> CorsCreateObjectV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of CorsCreateObjectV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> CorsCreateObjectV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of CorsCreateObjectV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return CorsCreateObjectV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = CorsCreateObjectV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": CorsCreateObjectV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": CorsCreateObjectV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/cors_create_object_v1_response_m_payload.py b/eZmaxApi/models/cors_create_object_v1_response_m_payload.py index 24d7bee16..1af398ce2 100644 --- a/eZmaxApi/models/cors_create_object_v1_response_m_payload.py +++ b/eZmaxApi/models/cors_create_object_v1_response_m_payload.py @@ -19,53 +19,72 @@ import json -from typing import List -from pydantic import BaseModel, Field, conint, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class CorsCreateObjectV1ResponseMPayload(BaseModel): """ - Payload for POST /1/object/cors # noqa: E501 - """ - a_pki_cors_id: conlist(conint(strict=True, le=65535, ge=0)) = Field(..., alias="a_pkiCorsID", description="An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request.") - __properties = ["a_pkiCorsID"] + Payload for POST /1/object/cors + """ # noqa: E501 + a_pki_cors_id: List[Annotated[int, Field(le=65535, strict=True, ge=0)]] = Field(description="An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request.", alias="a_pkiCorsID") + __properties: ClassVar[List[str]] = ["a_pkiCorsID"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> CorsCreateObjectV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of CorsCreateObjectV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> CorsCreateObjectV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of CorsCreateObjectV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return CorsCreateObjectV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = CorsCreateObjectV1ResponseMPayload.parse_obj({ - "a_pki_cors_id": obj.get("a_pkiCorsID") + _obj = cls.model_validate({ + "a_pkiCorsID": obj.get("a_pkiCorsID") }) return _obj diff --git a/eZmaxApi/models/cors_delete_object_v1_response.py b/eZmaxApi/models/cors_delete_object_v1_response.py index 214b91b5c..ee91215db 100644 --- a/eZmaxApi/models/cors_delete_object_v1_response.py +++ b/eZmaxApi/models/cors_delete_object_v1_response.py @@ -19,43 +19,61 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class CorsDeleteObjectV1Response(BaseModel): """ - Response for DELETE /1/object/cors/{pkiCorsID} # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - __properties = ["objDebugPayload", "objDebug"] + Response for DELETE /1/object/cors/{pkiCorsID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> CorsDeleteObjectV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of CorsDeleteObjectV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -65,17 +83,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> CorsDeleteObjectV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of CorsDeleteObjectV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return CorsDeleteObjectV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = CorsDeleteObjectV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None }) return _obj diff --git a/eZmaxApi/models/cors_edit_object_v1_request.py b/eZmaxApi/models/cors_edit_object_v1_request.py index e5ec805be..559f58ed4 100644 --- a/eZmaxApi/models/cors_edit_object_v1_request.py +++ b/eZmaxApi/models/cors_edit_object_v1_request.py @@ -19,57 +19,75 @@ import json - -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.cors_request_compound import CorsRequestCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class CorsEditObjectV1Request(BaseModel): """ - Request for PUT /1/object/cors/{pkiCorsID} # noqa: E501 - """ - obj_cors: CorsRequestCompound = Field(..., alias="objCors") - __properties = ["objCors"] + Request for PUT /1/object/cors/{pkiCorsID} + """ # noqa: E501 + obj_cors: CorsRequestCompound = Field(alias="objCors") + __properties: ClassVar[List[str]] = ["objCors"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> CorsEditObjectV1Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of CorsEditObjectV1Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_cors if self.obj_cors: _dict['objCors'] = self.obj_cors.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> CorsEditObjectV1Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of CorsEditObjectV1Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return CorsEditObjectV1Request.parse_obj(obj) + return cls.model_validate(obj) - _obj = CorsEditObjectV1Request.parse_obj({ - "obj_cors": CorsRequestCompound.from_dict(obj.get("objCors")) if obj.get("objCors") is not None else None + _obj = cls.model_validate({ + "objCors": CorsRequestCompound.from_dict(obj.get("objCors")) if obj.get("objCors") is not None else None }) return _obj diff --git a/eZmaxApi/models/cors_edit_object_v1_response.py b/eZmaxApi/models/cors_edit_object_v1_response.py index 4c5f1e451..baf913d9c 100644 --- a/eZmaxApi/models/cors_edit_object_v1_response.py +++ b/eZmaxApi/models/cors_edit_object_v1_response.py @@ -19,43 +19,61 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class CorsEditObjectV1Response(BaseModel): """ - Response for PUT /1/object/cors/{pkiCorsID} # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - __properties = ["objDebugPayload", "objDebug"] + Response for PUT /1/object/cors/{pkiCorsID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> CorsEditObjectV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of CorsEditObjectV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -65,17 +83,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> CorsEditObjectV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of CorsEditObjectV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return CorsEditObjectV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = CorsEditObjectV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None }) return _obj diff --git a/eZmaxApi/models/cors_get_object_v2_response.py b/eZmaxApi/models/cors_get_object_v2_response.py index 29ae7db72..0bbba2e24 100644 --- a/eZmaxApi/models/cors_get_object_v2_response.py +++ b/eZmaxApi/models/cors_get_object_v2_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.cors_get_object_v2_response_m_payload import CorsGetObjectV2ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class CorsGetObjectV2Response(BaseModel): """ - Response for GET /2/object/cors/{pkiCorsID} # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: CorsGetObjectV2ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /2/object/cors/{pkiCorsID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: CorsGetObjectV2ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> CorsGetObjectV2Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of CorsGetObjectV2Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> CorsGetObjectV2Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of CorsGetObjectV2Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return CorsGetObjectV2Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = CorsGetObjectV2Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": CorsGetObjectV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": CorsGetObjectV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/cors_get_object_v2_response_m_payload.py b/eZmaxApi/models/cors_get_object_v2_response_m_payload.py index 3617e2fae..318c510b7 100644 --- a/eZmaxApi/models/cors_get_object_v2_response_m_payload.py +++ b/eZmaxApi/models/cors_get_object_v2_response_m_payload.py @@ -19,57 +19,75 @@ import json - -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.cors_response_compound import CorsResponseCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class CorsGetObjectV2ResponseMPayload(BaseModel): """ - Payload for GET /2/object/cors/{pkiCorsID} # noqa: E501 - """ - obj_cors: CorsResponseCompound = Field(..., alias="objCors") - __properties = ["objCors"] + Payload for GET /2/object/cors/{pkiCorsID} + """ # noqa: E501 + obj_cors: CorsResponseCompound = Field(alias="objCors") + __properties: ClassVar[List[str]] = ["objCors"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> CorsGetObjectV2ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of CorsGetObjectV2ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_cors if self.obj_cors: _dict['objCors'] = self.obj_cors.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> CorsGetObjectV2ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of CorsGetObjectV2ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return CorsGetObjectV2ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = CorsGetObjectV2ResponseMPayload.parse_obj({ - "obj_cors": CorsResponseCompound.from_dict(obj.get("objCors")) if obj.get("objCors") is not None else None + _obj = cls.model_validate({ + "objCors": CorsResponseCompound.from_dict(obj.get("objCors")) if obj.get("objCors") is not None else None }) return _obj diff --git a/eZmaxApi/models/cors_request.py b/eZmaxApi/models/cors_request.py index 0db35e1bd..a3e0d80ec 100644 --- a/eZmaxApi/models/cors_request.py +++ b/eZmaxApi/models/cors_request.py @@ -19,64 +19,83 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, conint, constr, validator +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, field_validator +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class CorsRequest(BaseModel): """ - A Cors Object # noqa: E501 - """ - pki_cors_id: Optional[conint(strict=True, le=65535, ge=0)] = Field(None, alias="pkiCorsID", description="The unique ID of the Cors") - fki_apikey_id: conint(strict=True, ge=0) = Field(..., alias="fkiApikeyID", description="The unique ID of the Apikey") - s_cors_entryurl: constr(strict=True) = Field(..., alias="sCorsEntryurl", description="The entryurl of the Cors") - __properties = ["pkiCorsID", "fkiApikeyID", "sCorsEntryurl"] - - @validator('s_cors_entryurl') + A Cors Object + """ # noqa: E501 + pki_cors_id: Optional[Annotated[int, Field(le=65535, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Cors", alias="pkiCorsID") + fki_apikey_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Apikey", alias="fkiApikeyID") + s_cors_entryurl: Annotated[str, Field(strict=True)] = Field(description="The entryurl of the Cors", alias="sCorsEntryurl") + __properties: ClassVar[List[str]] = ["pkiCorsID", "fkiApikeyID", "sCorsEntryurl"] + + @field_validator('s_cors_entryurl') def s_cors_entryurl_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^.{0,2048}$", value): raise ValueError(r"must validate the regular expression /^.{0,2048}$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> CorsRequest: + def from_json(cls, json_str: str) -> Self: """Create an instance of CorsRequest from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> CorsRequest: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of CorsRequest from a dict""" if obj is None: return None if not isinstance(obj, dict): - return CorsRequest.parse_obj(obj) + return cls.model_validate(obj) - _obj = CorsRequest.parse_obj({ - "pki_cors_id": obj.get("pkiCorsID"), - "fki_apikey_id": obj.get("fkiApikeyID"), - "s_cors_entryurl": obj.get("sCorsEntryurl") + _obj = cls.model_validate({ + "pkiCorsID": obj.get("pkiCorsID"), + "fkiApikeyID": obj.get("fkiApikeyID"), + "sCorsEntryurl": obj.get("sCorsEntryurl") }) return _obj diff --git a/eZmaxApi/models/cors_request_compound.py b/eZmaxApi/models/cors_request_compound.py index 9598a1b9b..1fc77141b 100644 --- a/eZmaxApi/models/cors_request_compound.py +++ b/eZmaxApi/models/cors_request_compound.py @@ -19,64 +19,83 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, conint, constr, validator +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, field_validator +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class CorsRequestCompound(BaseModel): """ - A Cors Object and children # noqa: E501 - """ - pki_cors_id: Optional[conint(strict=True, le=65535, ge=0)] = Field(None, alias="pkiCorsID", description="The unique ID of the Cors") - fki_apikey_id: conint(strict=True, ge=0) = Field(..., alias="fkiApikeyID", description="The unique ID of the Apikey") - s_cors_entryurl: constr(strict=True) = Field(..., alias="sCorsEntryurl", description="The entryurl of the Cors") - __properties = ["pkiCorsID", "fkiApikeyID", "sCorsEntryurl"] - - @validator('s_cors_entryurl') + A Cors Object and children + """ # noqa: E501 + pki_cors_id: Optional[Annotated[int, Field(le=65535, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Cors", alias="pkiCorsID") + fki_apikey_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Apikey", alias="fkiApikeyID") + s_cors_entryurl: Annotated[str, Field(strict=True)] = Field(description="The entryurl of the Cors", alias="sCorsEntryurl") + __properties: ClassVar[List[str]] = ["pkiCorsID", "fkiApikeyID", "sCorsEntryurl"] + + @field_validator('s_cors_entryurl') def s_cors_entryurl_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^.{0,2048}$", value): raise ValueError(r"must validate the regular expression /^.{0,2048}$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> CorsRequestCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of CorsRequestCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> CorsRequestCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of CorsRequestCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return CorsRequestCompound.parse_obj(obj) + return cls.model_validate(obj) - _obj = CorsRequestCompound.parse_obj({ - "pki_cors_id": obj.get("pkiCorsID"), - "fki_apikey_id": obj.get("fkiApikeyID"), - "s_cors_entryurl": obj.get("sCorsEntryurl") + _obj = cls.model_validate({ + "pkiCorsID": obj.get("pkiCorsID"), + "fkiApikeyID": obj.get("fkiApikeyID"), + "sCorsEntryurl": obj.get("sCorsEntryurl") }) return _obj diff --git a/eZmaxApi/models/cors_response.py b/eZmaxApi/models/cors_response.py index 4ba079fd6..d7cc910d0 100644 --- a/eZmaxApi/models/cors_response.py +++ b/eZmaxApi/models/cors_response.py @@ -19,64 +19,83 @@ import json - -from pydantic import BaseModel, Field, conint, constr, validator +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, field_validator +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class CorsResponse(BaseModel): """ - A Cors Object # noqa: E501 - """ - pki_cors_id: conint(strict=True, le=65535, ge=0) = Field(..., alias="pkiCorsID", description="The unique ID of the Cors") - fki_apikey_id: conint(strict=True, ge=0) = Field(..., alias="fkiApikeyID", description="The unique ID of the Apikey") - s_cors_entryurl: constr(strict=True) = Field(..., alias="sCorsEntryurl", description="The entryurl of the Cors") - __properties = ["pkiCorsID", "fkiApikeyID", "sCorsEntryurl"] - - @validator('s_cors_entryurl') + A Cors Object + """ # noqa: E501 + pki_cors_id: Annotated[int, Field(le=65535, strict=True, ge=0)] = Field(description="The unique ID of the Cors", alias="pkiCorsID") + fki_apikey_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Apikey", alias="fkiApikeyID") + s_cors_entryurl: Annotated[str, Field(strict=True)] = Field(description="The entryurl of the Cors", alias="sCorsEntryurl") + __properties: ClassVar[List[str]] = ["pkiCorsID", "fkiApikeyID", "sCorsEntryurl"] + + @field_validator('s_cors_entryurl') def s_cors_entryurl_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^.{0,2048}$", value): raise ValueError(r"must validate the regular expression /^.{0,2048}$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> CorsResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of CorsResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> CorsResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of CorsResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return CorsResponse.parse_obj(obj) + return cls.model_validate(obj) - _obj = CorsResponse.parse_obj({ - "pki_cors_id": obj.get("pkiCorsID"), - "fki_apikey_id": obj.get("fkiApikeyID"), - "s_cors_entryurl": obj.get("sCorsEntryurl") + _obj = cls.model_validate({ + "pkiCorsID": obj.get("pkiCorsID"), + "fkiApikeyID": obj.get("fkiApikeyID"), + "sCorsEntryurl": obj.get("sCorsEntryurl") }) return _obj diff --git a/eZmaxApi/models/cors_response_compound.py b/eZmaxApi/models/cors_response_compound.py index 6c78a1112..8181f1ce6 100644 --- a/eZmaxApi/models/cors_response_compound.py +++ b/eZmaxApi/models/cors_response_compound.py @@ -19,64 +19,83 @@ import json - -from pydantic import BaseModel, Field, conint, constr, validator +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, field_validator +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class CorsResponseCompound(BaseModel): """ - A Cors Object # noqa: E501 - """ - pki_cors_id: conint(strict=True, le=65535, ge=0) = Field(..., alias="pkiCorsID", description="The unique ID of the Cors") - fki_apikey_id: conint(strict=True, ge=0) = Field(..., alias="fkiApikeyID", description="The unique ID of the Apikey") - s_cors_entryurl: constr(strict=True) = Field(..., alias="sCorsEntryurl", description="The entryurl of the Cors") - __properties = ["pkiCorsID", "fkiApikeyID", "sCorsEntryurl"] - - @validator('s_cors_entryurl') + A Cors Object + """ # noqa: E501 + pki_cors_id: Annotated[int, Field(le=65535, strict=True, ge=0)] = Field(description="The unique ID of the Cors", alias="pkiCorsID") + fki_apikey_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Apikey", alias="fkiApikeyID") + s_cors_entryurl: Annotated[str, Field(strict=True)] = Field(description="The entryurl of the Cors", alias="sCorsEntryurl") + __properties: ClassVar[List[str]] = ["pkiCorsID", "fkiApikeyID", "sCorsEntryurl"] + + @field_validator('s_cors_entryurl') def s_cors_entryurl_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^.{0,2048}$", value): raise ValueError(r"must validate the regular expression /^.{0,2048}$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> CorsResponseCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of CorsResponseCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> CorsResponseCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of CorsResponseCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return CorsResponseCompound.parse_obj(obj) + return cls.model_validate(obj) - _obj = CorsResponseCompound.parse_obj({ - "pki_cors_id": obj.get("pkiCorsID"), - "fki_apikey_id": obj.get("fkiApikeyID"), - "s_cors_entryurl": obj.get("sCorsEntryurl") + _obj = cls.model_validate({ + "pkiCorsID": obj.get("pkiCorsID"), + "fkiApikeyID": obj.get("fkiApikeyID"), + "sCorsEntryurl": obj.get("sCorsEntryurl") }) return _obj diff --git a/eZmaxApi/models/custom_attachment_response.py b/eZmaxApi/models/custom_attachment_response.py new file mode 100644 index 000000000..e353cf9cc --- /dev/null +++ b/eZmaxApi/models/custom_attachment_response.py @@ -0,0 +1,272 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, StrictInt, field_validator +from pydantic import Field +from typing_extensions import Annotated +from eZmaxApi.models.attachment_response_compound import AttachmentResponseCompound +from eZmaxApi.models.common_audit import CommonAudit +from eZmaxApi.models.field_e_attachment_documenttype import FieldEAttachmentDocumenttype +from eZmaxApi.models.field_e_attachment_privacy import FieldEAttachmentPrivacy +from eZmaxApi.models.field_e_attachment_type import FieldEAttachmentType +from eZmaxApi.models.field_e_attachment_verified import FieldEAttachmentVerified +try: + from typing import Self +except ImportError: + from typing_extensions import Self + +class CustomAttachmentResponse(BaseModel): + """ + A Custom Attachment Object + """ # noqa: E501 + pki_attachment_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Attachment.", alias="pkiAttachmentID") + fki_computer_id: Optional[Annotated[int, Field(le=65535, strict=True, ge=1)]] = Field(default=None, description="The unique ID of the Computer", alias="fkiComputerID") + fki_adjustment_id: Optional[Annotated[int, Field(le=65535, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Adjustment", alias="fkiAdjustmentID") + fki_agent_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Agent.", alias="fkiAgentID") + fki_bankaccount_id: Optional[Annotated[int, Field(le=255, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Bankaccount", alias="fkiBankaccountID") + fki_broker_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Broker.", alias="fkiBrokerID") + fki_commissionadvance_id: Optional[Annotated[int, Field(le=65535, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Commissionadvance", alias="fkiCommissionadvanceID") + fki_communication_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Communication.", alias="fkiCommunicationID") + fki_customer_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Customer.", alias="fkiCustomerID") + fki_customertemplate_id: Optional[Annotated[int, Field(le=65535, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Customertemplate", alias="fkiCustomertemplateID") + fki_deposit_id: Optional[Annotated[int, Field(le=16777215, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Deposit", alias="fkiDepositID") + fki_deposittransitcheque_id: Optional[Annotated[int, Field(le=65535, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Deposittransitcheque", alias="fkiDeposittransitchequeID") + fki_electronicfundstransfer_id: Optional[Annotated[int, Field(le=65535, strict=True, ge=1)]] = Field(default=None, description="The unique ID of the Electronicfundstransfer", alias="fkiElectronicfundstransferID") + fki_employee_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Employee.", alias="fkiEmployeeID") + fki_externalbroker_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Externalbroker.", alias="fkiExternalbrokerID") + fki_ezcomadvanceserver_id: Optional[Annotated[int, Field(le=16777215, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezcomadvanceserver", alias="fkiEzcomadvanceserverID") + fki_ezcomcompany_id: Optional[Annotated[int, Field(le=65535, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezcomcompany", alias="fkiEzcomcompanyID") + fki_ezsigndocument_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsigndocument", alias="fkiEzsigndocumentID") + fki_ghacqcontract_id: Optional[Annotated[int, Field(le=16777215, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ghacqcontract", alias="fkiGhacqcontractID") + fki_inscription_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Inscription.", alias="fkiInscriptionID") + fki_inscriptiontemp_id: Optional[Annotated[int, Field(le=16777215, strict=True, ge=1)]] = Field(default=None, description="The unique ID of the Inscriptiontemp", alias="fkiInscriptiontempID") + fki_inscriptionnotauthenticated_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Inscriptionnotauthenticated.", alias="fkiInscriptionnotauthenticatedID") + fki_invoice_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Invoice.", alias="fkiInvoiceID") + fki_buyercontract_id: Optional[Annotated[int, Field(le=65535, strict=True, ge=1)]] = Field(default=None, description="The unique ID of the Buyercontract", alias="fkiBuyercontractID") + fki_franchisebroker_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Franchisebroker", alias="fkiFranchisebrokerID") + fki_franchiseagence_id: Optional[Annotated[int, Field(le=65535, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Franchiseagence", alias="fkiFranchiseagenceID") + fki_franchiseoffice_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Franchisereoffice", alias="fkiFranchiseofficeID") + fki_franchisefranchise_id: Optional[Annotated[int, Field(le=65535, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Franchisefranchise", alias="fkiFranchisefranchiseID") + fki_franchisecomplaint_id: Optional[Annotated[int, Field(le=65535, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Franchisecomplaint", alias="fkiFranchisecomplaintID") + fki_lead_id: Optional[Annotated[int, Field(le=65535, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Lead", alias="fkiLeadID") + fki_marketingprogram_id: Optional[Annotated[int, Field(le=255, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Marketingprogram", alias="fkiMarketingprogramID") + fki_marketingfollow_id: Optional[Annotated[int, Field(le=65535, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Marketingfollow", alias="fkiMarketingfollowID") + fki_notary_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Notary.", alias="fkiNotaryID") + fki_officetaxreport_id: Optional[Annotated[int, Field(le=65535, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Officetaxreport", alias="fkiOfficetaxreportID") + fki_otherincome_id: Optional[Annotated[int, Field(le=65535, strict=True, ge=1)]] = Field(default=None, description="The unique ID of the Otherincome", alias="fkiOtherincomeID") + fki_paymentpreparation_id: Optional[Annotated[int, Field(le=16777215, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Paymentpreparation", alias="fkiPaymentpreparationID") + fki_purchase_id: Optional[StrictInt] = Field(default=None, description="The unique ID of the Purchase", alias="fkiPurchaseID") + fki_salary_id: Optional[Annotated[int, Field(le=16777215, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Salary", alias="fkiSalaryID") + fki_supplier_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Supplier.", alias="fkiSupplierID") + fki_tranqcontract_id: Optional[Annotated[int, Field(le=16777215, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Tranqcontract", alias="fkiTranqcontractID") + fki_template_id: Optional[Annotated[int, Field(le=65535, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Template", alias="fkiTemplateID") + fki_inscriptionchecklist_id: Optional[Annotated[int, Field(le=16777215, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Inscriptionchecklist", alias="fkiInscriptionchecklistID") + fki_folder_id: Optional[Annotated[int, Field(le=65535, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Folder", alias="fkiFolderID") + fki_rejectedoffertopurchase_id: Optional[Annotated[int, Field(le=65535, strict=True, ge=1)]] = Field(default=None, description="The unique ID of the Rejectedoffertopurchase", alias="fkiRejectedoffertopurchaseID") + fki_disclosure_id: Optional[Annotated[int, Field(le=65535, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Disclosure", alias="fkiDisclosureID") + fki_reconciliation_id: Optional[Annotated[int, Field(le=65535, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Reconciliation", alias="fkiReconciliationID") + fki_ezsigndocument_id_reference: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsigndocument", alias="fkiEzsigndocumentIDReference") + e_attachment_documenttype: FieldEAttachmentDocumenttype = Field(alias="eAttachmentDocumenttype") + s_attachment_name: Annotated[str, Field(strict=True)] = Field(description="The name of the Attachment", alias="sAttachmentName") + e_attachment_privacy: FieldEAttachmentPrivacy = Field(alias="eAttachmentPrivacy") + fki_user_id_specific: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the User", alias="fkiUserIDSpecific") + e_attachment_type: FieldEAttachmentType = Field(alias="eAttachmentType") + i_attachment_size: Annotated[int, Field(le=4294967295, strict=True, ge=0)] = Field(description="The size of the Attachment", alias="iAttachmentSize") + i_attachment_ed_mmoduleflag: Optional[Annotated[int, Field(le=255, strict=True, ge=0)]] = Field(default=None, description="The edmmoduleflag of the Attachment", alias="iAttachmentEDMmoduleflag") + s_attachment_md5: Annotated[str, Field(strict=True)] = Field(description="The md5 of the Attachment", alias="sAttachmentMD5") + b_attachment_deleted: StrictBool = Field(description="Whether if it's deleted", alias="bAttachmentDeleted") + b_attachment_valid: StrictBool = Field(description="Whether if it's valid", alias="bAttachmentValid") + e_attachment_verified: FieldEAttachmentVerified = Field(alias="eAttachmentVerified") + t_attachment_rejectioncomment: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="The rejectioncomment of the Attachment", alias="tAttachmentRejectioncomment") + fki_user_id_owner: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the User", alias="fkiUserIDOwner") + obj_audit: Optional[CommonAudit] = Field(default=None, alias="objAudit") + obj_attachment_proof: Optional[AttachmentResponseCompound] = Field(default=None, alias="objAttachmentProof") + obj_attachment_proofdocument: Optional[AttachmentResponseCompound] = Field(default=None, alias="objAttachmentProofdocument") + a_obj_attachment_attachment: Optional[List[AttachmentResponseCompound]] = Field(default=None, alias="a_objAttachmentAttachment") + a_obj_attachment_version: Optional[List[AttachmentResponseCompound]] = Field(default=None, alias="a_objAttachmentVersion") + __properties: ClassVar[List[str]] = ["pkiAttachmentID", "fkiComputerID", "fkiAdjustmentID", "fkiAgentID", "fkiBankaccountID", "fkiBrokerID", "fkiCommissionadvanceID", "fkiCommunicationID", "fkiCustomerID", "fkiCustomertemplateID", "fkiDepositID", "fkiDeposittransitchequeID", "fkiElectronicfundstransferID", "fkiEmployeeID", "fkiExternalbrokerID", "fkiEzcomadvanceserverID", "fkiEzcomcompanyID", "fkiEzsigndocumentID", "fkiGhacqcontractID", "fkiInscriptionID", "fkiInscriptiontempID", "fkiInscriptionnotauthenticatedID", "fkiInvoiceID", "fkiBuyercontractID", "fkiFranchisebrokerID", "fkiFranchiseagenceID", "fkiFranchiseofficeID", "fkiFranchisefranchiseID", "fkiFranchisecomplaintID", "fkiLeadID", "fkiMarketingprogramID", "fkiMarketingfollowID", "fkiNotaryID", "fkiOfficetaxreportID", "fkiOtherincomeID", "fkiPaymentpreparationID", "fkiPurchaseID", "fkiSalaryID", "fkiSupplierID", "fkiTranqcontractID", "fkiTemplateID", "fkiInscriptionchecklistID", "fkiFolderID", "fkiRejectedoffertopurchaseID", "fkiDisclosureID", "fkiReconciliationID", "fkiEzsigndocumentIDReference", "eAttachmentDocumenttype", "sAttachmentName", "eAttachmentPrivacy", "fkiUserIDSpecific", "eAttachmentType", "iAttachmentSize", "iAttachmentEDMmoduleflag", "sAttachmentMD5", "bAttachmentDeleted", "bAttachmentValid", "eAttachmentVerified", "tAttachmentRejectioncomment", "fkiUserIDOwner", "objAudit", "objAttachmentProof", "objAttachmentProofdocument", "a_objAttachmentAttachment", "a_objAttachmentVersion"] + + @field_validator('s_attachment_name') + def s_attachment_name_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^.{0,75}$", value): + raise ValueError(r"must validate the regular expression /^.{0,75}$/") + return value + + @field_validator('s_attachment_md5') + def s_attachment_md5_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^.{0,32}$", value): + raise ValueError(r"must validate the regular expression /^.{0,32}$/") + return value + + @field_validator('t_attachment_rejectioncomment') + def t_attachment_rejectioncomment_validate_regular_expression(cls, value): + """Validates the regular expression""" + if value is None: + return value + + if not re.match(r"^.{0,65535}$", value): + raise ValueError(r"must validate the regular expression /^.{0,65535}$/") + return value + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of CustomAttachmentResponse from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of obj_audit + if self.obj_audit: + _dict['objAudit'] = self.obj_audit.to_dict() + # override the default output from pydantic by calling `to_dict()` of obj_attachment_proof + if self.obj_attachment_proof: + _dict['objAttachmentProof'] = self.obj_attachment_proof.to_dict() + # override the default output from pydantic by calling `to_dict()` of obj_attachment_proofdocument + if self.obj_attachment_proofdocument: + _dict['objAttachmentProofdocument'] = self.obj_attachment_proofdocument.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in a_obj_attachment_attachment (list) + _items = [] + if self.a_obj_attachment_attachment: + for _item in self.a_obj_attachment_attachment: + if _item: + _items.append(_item.to_dict()) + _dict['a_objAttachmentAttachment'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in a_obj_attachment_version (list) + _items = [] + if self.a_obj_attachment_version: + for _item in self.a_obj_attachment_version: + if _item: + _items.append(_item.to_dict()) + _dict['a_objAttachmentVersion'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Dict) -> Self: + """Create an instance of CustomAttachmentResponse from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiAttachmentID": obj.get("pkiAttachmentID"), + "fkiComputerID": obj.get("fkiComputerID"), + "fkiAdjustmentID": obj.get("fkiAdjustmentID"), + "fkiAgentID": obj.get("fkiAgentID"), + "fkiBankaccountID": obj.get("fkiBankaccountID"), + "fkiBrokerID": obj.get("fkiBrokerID"), + "fkiCommissionadvanceID": obj.get("fkiCommissionadvanceID"), + "fkiCommunicationID": obj.get("fkiCommunicationID"), + "fkiCustomerID": obj.get("fkiCustomerID"), + "fkiCustomertemplateID": obj.get("fkiCustomertemplateID"), + "fkiDepositID": obj.get("fkiDepositID"), + "fkiDeposittransitchequeID": obj.get("fkiDeposittransitchequeID"), + "fkiElectronicfundstransferID": obj.get("fkiElectronicfundstransferID"), + "fkiEmployeeID": obj.get("fkiEmployeeID"), + "fkiExternalbrokerID": obj.get("fkiExternalbrokerID"), + "fkiEzcomadvanceserverID": obj.get("fkiEzcomadvanceserverID"), + "fkiEzcomcompanyID": obj.get("fkiEzcomcompanyID"), + "fkiEzsigndocumentID": obj.get("fkiEzsigndocumentID"), + "fkiGhacqcontractID": obj.get("fkiGhacqcontractID"), + "fkiInscriptionID": obj.get("fkiInscriptionID"), + "fkiInscriptiontempID": obj.get("fkiInscriptiontempID"), + "fkiInscriptionnotauthenticatedID": obj.get("fkiInscriptionnotauthenticatedID"), + "fkiInvoiceID": obj.get("fkiInvoiceID"), + "fkiBuyercontractID": obj.get("fkiBuyercontractID"), + "fkiFranchisebrokerID": obj.get("fkiFranchisebrokerID"), + "fkiFranchiseagenceID": obj.get("fkiFranchiseagenceID"), + "fkiFranchiseofficeID": obj.get("fkiFranchiseofficeID"), + "fkiFranchisefranchiseID": obj.get("fkiFranchisefranchiseID"), + "fkiFranchisecomplaintID": obj.get("fkiFranchisecomplaintID"), + "fkiLeadID": obj.get("fkiLeadID"), + "fkiMarketingprogramID": obj.get("fkiMarketingprogramID"), + "fkiMarketingfollowID": obj.get("fkiMarketingfollowID"), + "fkiNotaryID": obj.get("fkiNotaryID"), + "fkiOfficetaxreportID": obj.get("fkiOfficetaxreportID"), + "fkiOtherincomeID": obj.get("fkiOtherincomeID"), + "fkiPaymentpreparationID": obj.get("fkiPaymentpreparationID"), + "fkiPurchaseID": obj.get("fkiPurchaseID"), + "fkiSalaryID": obj.get("fkiSalaryID"), + "fkiSupplierID": obj.get("fkiSupplierID"), + "fkiTranqcontractID": obj.get("fkiTranqcontractID"), + "fkiTemplateID": obj.get("fkiTemplateID"), + "fkiInscriptionchecklistID": obj.get("fkiInscriptionchecklistID"), + "fkiFolderID": obj.get("fkiFolderID"), + "fkiRejectedoffertopurchaseID": obj.get("fkiRejectedoffertopurchaseID"), + "fkiDisclosureID": obj.get("fkiDisclosureID"), + "fkiReconciliationID": obj.get("fkiReconciliationID"), + "fkiEzsigndocumentIDReference": obj.get("fkiEzsigndocumentIDReference"), + "eAttachmentDocumenttype": obj.get("eAttachmentDocumenttype"), + "sAttachmentName": obj.get("sAttachmentName"), + "eAttachmentPrivacy": obj.get("eAttachmentPrivacy"), + "fkiUserIDSpecific": obj.get("fkiUserIDSpecific"), + "eAttachmentType": obj.get("eAttachmentType"), + "iAttachmentSize": obj.get("iAttachmentSize"), + "iAttachmentEDMmoduleflag": obj.get("iAttachmentEDMmoduleflag"), + "sAttachmentMD5": obj.get("sAttachmentMD5"), + "bAttachmentDeleted": obj.get("bAttachmentDeleted"), + "bAttachmentValid": obj.get("bAttachmentValid"), + "eAttachmentVerified": obj.get("eAttachmentVerified"), + "tAttachmentRejectioncomment": obj.get("tAttachmentRejectioncomment"), + "fkiUserIDOwner": obj.get("fkiUserIDOwner"), + "objAudit": CommonAudit.from_dict(obj.get("objAudit")) if obj.get("objAudit") is not None else None, + "objAttachmentProof": AttachmentResponseCompound.from_dict(obj.get("objAttachmentProof")) if obj.get("objAttachmentProof") is not None else None, + "objAttachmentProofdocument": AttachmentResponseCompound.from_dict(obj.get("objAttachmentProofdocument")) if obj.get("objAttachmentProofdocument") is not None else None, + "a_objAttachmentAttachment": [AttachmentResponseCompound.from_dict(_item) for _item in obj.get("a_objAttachmentAttachment")] if obj.get("a_objAttachmentAttachment") is not None else None, + "a_objAttachmentVersion": [AttachmentResponseCompound.from_dict(_item) for _item in obj.get("a_objAttachmentVersion")] if obj.get("a_objAttachmentVersion") is not None else None + }) + return _obj + + diff --git a/eZmaxApi/models/custom_attachmentdocumenttype_response.py b/eZmaxApi/models/custom_attachmentdocumenttype_response.py new file mode 100644 index 000000000..adf7a02a2 --- /dev/null +++ b/eZmaxApi/models/custom_attachmentdocumenttype_response.py @@ -0,0 +1,101 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from eZmaxApi.models.custom_attachment_response import CustomAttachmentResponse +from eZmaxApi.models.field_e_attachment_documenttype import FieldEAttachmentDocumenttype +try: + from typing import Self +except ImportError: + from typing_extensions import Self + +class CustomAttachmentdocumenttypeResponse(BaseModel): + """ + An Attachmentdocumenttype + """ # noqa: E501 + e_attachment_documenttype: FieldEAttachmentDocumenttype = Field(alias="eAttachmentDocumenttype") + a_obj_attachment: List[CustomAttachmentResponse] = Field(alias="a_objAttachment") + __properties: ClassVar[List[str]] = ["eAttachmentDocumenttype", "a_objAttachment"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of CustomAttachmentdocumenttypeResponse from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in a_obj_attachment (list) + _items = [] + if self.a_obj_attachment: + for _item in self.a_obj_attachment: + if _item: + _items.append(_item.to_dict()) + _dict['a_objAttachment'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Dict) -> Self: + """Create an instance of CustomAttachmentdocumenttypeResponse from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "eAttachmentDocumenttype": obj.get("eAttachmentDocumenttype"), + "a_objAttachment": [CustomAttachmentResponse.from_dict(_item) for _item in obj.get("a_objAttachment")] if obj.get("a_objAttachment") is not None else None + }) + return _obj + + diff --git a/eZmaxApi/models/custom_autocomplete_element_response.py b/eZmaxApi/models/custom_autocomplete_element_response.py index 89a7d722c..793fe44fc 100644 --- a/eZmaxApi/models/custom_autocomplete_element_response.py +++ b/eZmaxApi/models/custom_autocomplete_element_response.py @@ -19,61 +19,79 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, StrictStr +from pydantic import Field +try: + from typing import Self +except ImportError: + from typing_extensions import Self class CustomAutocompleteElementResponse(BaseModel): """ - Generic AutocompleteElement Response # noqa: E501 - """ - s_category: StrictStr = Field(..., alias="sCategory", description="The Category for the dropdown or an empty string if not categorized") - s_label: StrictStr = Field(..., alias="sLabel", description="The Description of the element") - s_value: StrictStr = Field(..., alias="sValue", description="The Unique ID of the element") - m_value: Optional[StrictStr] = Field(None, alias="mValue", description="The Unique ID of the element") - b_active: StrictBool = Field(..., alias="bActive", description="Indicates if the element is active") - __properties = ["sCategory", "sLabel", "sValue", "mValue", "bActive"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + Generic AutocompleteElement Response + """ # noqa: E501 + s_category: StrictStr = Field(description="The Category for the dropdown or an empty string if not categorized", alias="sCategory") + s_label: StrictStr = Field(description="The Description of the element", alias="sLabel") + s_value: StrictStr = Field(description="The Unique ID of the element", alias="sValue") + m_value: Optional[StrictStr] = Field(default=None, description="The Unique ID of the element", alias="mValue") + b_active: StrictBool = Field(description="Indicates if the element is active", alias="bActive") + __properties: ClassVar[List[str]] = ["sCategory", "sLabel", "sValue", "mValue", "bActive"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> CustomAutocompleteElementResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of CustomAutocompleteElementResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> CustomAutocompleteElementResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of CustomAutocompleteElementResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return CustomAutocompleteElementResponse.parse_obj(obj) - - _obj = CustomAutocompleteElementResponse.parse_obj({ - "s_category": obj.get("sCategory"), - "s_label": obj.get("sLabel"), - "s_value": obj.get("sValue"), - "m_value": obj.get("mValue"), - "b_active": obj.get("bActive") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "sCategory": obj.get("sCategory"), + "sLabel": obj.get("sLabel"), + "sValue": obj.get("sValue"), + "mValue": obj.get("mValue"), + "bActive": obj.get("bActive") }) return _obj diff --git a/eZmaxApi/models/custom_communication_list_element_response.py b/eZmaxApi/models/custom_communication_list_element_response.py index d72f0be51..f30fe2f15 100644 --- a/eZmaxApi/models/custom_communication_list_element_response.py +++ b/eZmaxApi/models/custom_communication_list_element_response.py @@ -19,79 +19,98 @@ import json - -from pydantic import BaseModel, Field, StrictInt, StrictStr, conint, constr, validator +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictInt, StrictStr, field_validator +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.computed_e_communication_direction import ComputedECommunicationDirection from eZmaxApi.models.field_e_communication_importance import FieldECommunicationImportance from eZmaxApi.models.field_e_communication_type import FieldECommunicationType +try: + from typing import Self +except ImportError: + from typing_extensions import Self class CustomCommunicationListElementResponse(BaseModel): """ - A Communication List Element # noqa: E501 - """ - pki_communication_id: conint(strict=True, ge=0) = Field(..., alias="pkiCommunicationID", description="The unique ID of the Communication.") - dt_created_date: StrictStr = Field(..., alias="dtCreatedDate", description="The date and time at which the object was created") - e_communication_direction: ComputedECommunicationDirection = Field(..., alias="eCommunicationDirection") - e_communication_importance: FieldECommunicationImportance = Field(..., alias="eCommunicationImportance") - e_communication_type: FieldECommunicationType = Field(..., alias="eCommunicationType") - i_communicationrecipient_count: StrictInt = Field(..., alias="iCommunicationrecipientCount", description="The count of Communicationrecipient") - s_communication_subject: constr(strict=True) = Field(..., alias="sCommunicationSubject", description="The subject of the Communication") - s_communication_sender: StrictStr = Field(..., alias="sCommunicationSender", description="The sender name of the Communication") - s_communication_recipient: StrictStr = Field(..., alias="sCommunicationRecipient", description="The recipients' name of the Communication") - __properties = ["pkiCommunicationID", "dtCreatedDate", "eCommunicationDirection", "eCommunicationImportance", "eCommunicationType", "iCommunicationrecipientCount", "sCommunicationSubject", "sCommunicationSender", "sCommunicationRecipient"] - - @validator('s_communication_subject') + A Communication List Element + """ # noqa: E501 + pki_communication_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Communication.", alias="pkiCommunicationID") + dt_created_date: StrictStr = Field(description="The date and time at which the object was created", alias="dtCreatedDate") + e_communication_direction: ComputedECommunicationDirection = Field(alias="eCommunicationDirection") + e_communication_importance: FieldECommunicationImportance = Field(alias="eCommunicationImportance") + e_communication_type: FieldECommunicationType = Field(alias="eCommunicationType") + i_communicationrecipient_count: StrictInt = Field(description="The count of Communicationrecipient", alias="iCommunicationrecipientCount") + s_communication_subject: Annotated[str, Field(strict=True)] = Field(description="The subject of the Communication", alias="sCommunicationSubject") + s_communication_sender: StrictStr = Field(description="The sender name of the Communication", alias="sCommunicationSender") + s_communication_recipient: StrictStr = Field(description="The recipients' name of the Communication", alias="sCommunicationRecipient") + __properties: ClassVar[List[str]] = ["pkiCommunicationID", "dtCreatedDate", "eCommunicationDirection", "eCommunicationImportance", "eCommunicationType", "iCommunicationrecipientCount", "sCommunicationSubject", "sCommunicationSender", "sCommunicationRecipient"] + + @field_validator('s_communication_subject') def s_communication_subject_validate_regular_expression(cls, value): """Validates the regular expression""" - if not re.match(r"^.{0,150}$", value): - raise ValueError(r"must validate the regular expression /^.{0,150}$/") + if not re.match(r"^.{0,200}$", value): + raise ValueError(r"must validate the regular expression /^.{0,200}$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> CustomCommunicationListElementResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of CustomCommunicationListElementResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> CustomCommunicationListElementResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of CustomCommunicationListElementResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return CustomCommunicationListElementResponse.parse_obj(obj) - - _obj = CustomCommunicationListElementResponse.parse_obj({ - "pki_communication_id": obj.get("pkiCommunicationID"), - "dt_created_date": obj.get("dtCreatedDate"), - "e_communication_direction": obj.get("eCommunicationDirection"), - "e_communication_importance": obj.get("eCommunicationImportance"), - "e_communication_type": obj.get("eCommunicationType"), - "i_communicationrecipient_count": obj.get("iCommunicationrecipientCount"), - "s_communication_subject": obj.get("sCommunicationSubject"), - "s_communication_sender": obj.get("sCommunicationSender"), - "s_communication_recipient": obj.get("sCommunicationRecipient") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiCommunicationID": obj.get("pkiCommunicationID"), + "dtCreatedDate": obj.get("dtCreatedDate"), + "eCommunicationDirection": obj.get("eCommunicationDirection"), + "eCommunicationImportance": obj.get("eCommunicationImportance"), + "eCommunicationType": obj.get("eCommunicationType"), + "iCommunicationrecipientCount": obj.get("iCommunicationrecipientCount"), + "sCommunicationSubject": obj.get("sCommunicationSubject"), + "sCommunicationSender": obj.get("sCommunicationSender"), + "sCommunicationRecipient": obj.get("sCommunicationRecipient") }) return _obj diff --git a/eZmaxApi/models/custom_communicationattachment_request.py b/eZmaxApi/models/custom_communicationattachment_request.py index 96998d0a7..07b7ee907 100644 --- a/eZmaxApi/models/custom_communicationattachment_request.py +++ b/eZmaxApi/models/custom_communicationattachment_request.py @@ -19,43 +19,61 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_file import CommonFile from eZmaxApi.models.communicationattachment_request_compound import CommunicationattachmentRequestCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class CustomCommunicationattachmentRequest(BaseModel): """ - A Custom Communicationattachment Object # noqa: E501 - """ - obj_communicationattachment: Optional[CommunicationattachmentRequestCompound] = Field(None, alias="objCommunicationattachment") - obj_communicationexternalattachment: Optional[CommonFile] = Field(None, alias="objCommunicationexternalattachment") - __properties = ["objCommunicationattachment", "objCommunicationexternalattachment"] + A Custom Communicationattachment Object + """ # noqa: E501 + obj_communicationattachment: Optional[CommunicationattachmentRequestCompound] = Field(default=None, alias="objCommunicationattachment") + obj_communicationexternalattachment: Optional[CommonFile] = Field(default=None, alias="objCommunicationexternalattachment") + __properties: ClassVar[List[str]] = ["objCommunicationattachment", "objCommunicationexternalattachment"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> CustomCommunicationattachmentRequest: + def from_json(cls, json_str: str) -> Self: """Create an instance of CustomCommunicationattachmentRequest from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_communicationattachment if self.obj_communicationattachment: _dict['objCommunicationattachment'] = self.obj_communicationattachment.to_dict() @@ -65,17 +83,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> CustomCommunicationattachmentRequest: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of CustomCommunicationattachmentRequest from a dict""" if obj is None: return None if not isinstance(obj, dict): - return CustomCommunicationattachmentRequest.parse_obj(obj) + return cls.model_validate(obj) - _obj = CustomCommunicationattachmentRequest.parse_obj({ - "obj_communicationattachment": CommunicationattachmentRequestCompound.from_dict(obj.get("objCommunicationattachment")) if obj.get("objCommunicationattachment") is not None else None, - "obj_communicationexternalattachment": CommonFile.from_dict(obj.get("objCommunicationexternalattachment")) if obj.get("objCommunicationexternalattachment") is not None else None + _obj = cls.model_validate({ + "objCommunicationattachment": CommunicationattachmentRequestCompound.from_dict(obj.get("objCommunicationattachment")) if obj.get("objCommunicationattachment") is not None else None, + "objCommunicationexternalattachment": CommonFile.from_dict(obj.get("objCommunicationexternalattachment")) if obj.get("objCommunicationexternalattachment") is not None else None }) return _obj diff --git a/eZmaxApi/models/custom_communicationrecipientsgroup_response.py b/eZmaxApi/models/custom_communicationrecipientsgroup_response.py index fe7cd9d27..6aa3b1ac5 100644 --- a/eZmaxApi/models/custom_communicationrecipientsgroup_response.py +++ b/eZmaxApi/models/custom_communicationrecipientsgroup_response.py @@ -19,42 +19,60 @@ import json -from typing import List -from pydantic import BaseModel, Field, StrictStr, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictStr +from pydantic import Field from eZmaxApi.models.custom_communicationrecipientsrecipient_response import CustomCommunicationrecipientsrecipientResponse +try: + from typing import Self +except ImportError: + from typing_extensions import Self class CustomCommunicationrecipientsgroupResponse(BaseModel): """ - Generic CommunicationrecipientsGroup Response # noqa: E501 - """ - s_communicationrecipientsgroup_label: StrictStr = Field(..., alias="sCommunicationrecipientsgroupLabel", description="The label for the Communicationrecipientsgroup") - a_obj_communicationrecipientsrecipient: conlist(CustomCommunicationrecipientsrecipientResponse) = Field(..., alias="a_objCommunicationrecipientsrecipient") - __properties = ["sCommunicationrecipientsgroupLabel", "a_objCommunicationrecipientsrecipient"] + Generic CommunicationrecipientsGroup Response + """ # noqa: E501 + s_communicationrecipientsgroup_label: StrictStr = Field(description="The label for the Communicationrecipientsgroup", alias="sCommunicationrecipientsgroupLabel") + a_obj_communicationrecipientsrecipient: List[CustomCommunicationrecipientsrecipientResponse] = Field(alias="a_objCommunicationrecipientsrecipient") + __properties: ClassVar[List[str]] = ["sCommunicationrecipientsgroupLabel", "a_objCommunicationrecipientsrecipient"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> CustomCommunicationrecipientsgroupResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of CustomCommunicationrecipientsgroupResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_communicationrecipientsrecipient (list) _items = [] if self.a_obj_communicationrecipientsrecipient: @@ -65,17 +83,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> CustomCommunicationrecipientsgroupResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of CustomCommunicationrecipientsgroupResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return CustomCommunicationrecipientsgroupResponse.parse_obj(obj) + return cls.model_validate(obj) - _obj = CustomCommunicationrecipientsgroupResponse.parse_obj({ - "s_communicationrecipientsgroup_label": obj.get("sCommunicationrecipientsgroupLabel"), - "a_obj_communicationrecipientsrecipient": [CustomCommunicationrecipientsrecipientResponse.from_dict(_item) for _item in obj.get("a_objCommunicationrecipientsrecipient")] if obj.get("a_objCommunicationrecipientsrecipient") is not None else None + _obj = cls.model_validate({ + "sCommunicationrecipientsgroupLabel": obj.get("sCommunicationrecipientsgroupLabel"), + "a_objCommunicationrecipientsrecipient": [CustomCommunicationrecipientsrecipientResponse.from_dict(_item) for _item in obj.get("a_objCommunicationrecipientsrecipient")] if obj.get("a_objCommunicationrecipientsrecipient") is not None else None }) return _obj diff --git a/eZmaxApi/models/custom_communicationrecipientsrecipient_response.py b/eZmaxApi/models/custom_communicationrecipientsrecipient_response.py index a8b1867fb..b0d073528 100644 --- a/eZmaxApi/models/custom_communicationrecipientsrecipient_response.py +++ b/eZmaxApi/models/custom_communicationrecipientsrecipient_response.py @@ -19,69 +19,88 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictStr, conint, validator +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictStr, field_validator +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.custom_contact_name_response import CustomContactNameResponse from eZmaxApi.models.email_response_compound import EmailResponseCompound from eZmaxApi.models.phone_response_compound import PhoneResponseCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class CustomCommunicationrecipientsrecipientResponse(BaseModel): """ - Generic AutocompleteElement Response # noqa: E501 - """ - fki_agent_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiAgentID", description="The unique ID of the Agent.") - fki_broker_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiBrokerID", description="The unique ID of the Broker.") - fki_contact_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiContactID", description="The unique ID of the Contact") - fki_customer_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiCustomerID", description="The unique ID of the Customer.") - fki_employee_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiEmployeeID", description="The unique ID of the Employee.") - fki_ezsignsigner_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiEzsignsignerID", description="The unique ID of the Ezsignsigner") - fki_franchiseoffice_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiFranchiseofficeID", description="The unique ID of the Franchisereoffice") - fki_user_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiUserID", description="The unique ID of the User") - fki_agentincorporation_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiAgentincorporationID", description="The unique ID of the Agentincorporation.") - fki_assistant_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiAssistantID", description="The unique ID of the Assistant.") - fki_externalbroker_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiExternalbrokerID", description="The unique ID of the Externalbroker.") - fki_ezcomagent_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiEzcomagentID", description="The unique ID of the Ezcomagent.") - fki_notary_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiNotaryID", description="The unique ID of the Notary.") - fki_rewardmember_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiRewardmemberID", description="The unique ID of the Rewardmember.") - fki_supplier_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiSupplierID", description="The unique ID of the Supplier.") - e_communicationrecipientsrecipient_objecttype: StrictStr = Field(..., alias="eCommunicationrecipientsrecipientObjecttype") - obj_contact_name: CustomContactNameResponse = Field(..., alias="objContactName") - obj_email: Optional[EmailResponseCompound] = Field(None, alias="objEmail") - obj_phone_fax: Optional[PhoneResponseCompound] = Field(None, alias="objPhoneFax") - obj_phone_sms: Optional[PhoneResponseCompound] = Field(None, alias="objPhoneSMS") - __properties = ["fkiAgentID", "fkiBrokerID", "fkiContactID", "fkiCustomerID", "fkiEmployeeID", "fkiEzsignsignerID", "fkiFranchiseofficeID", "fkiUserID", "fkiAgentincorporationID", "fkiAssistantID", "fkiExternalbrokerID", "fkiEzcomagentID", "fkiNotaryID", "fkiRewardmemberID", "fkiSupplierID", "eCommunicationrecipientsrecipientObjecttype", "objContactName", "objEmail", "objPhoneFax", "objPhoneSMS"] - - @validator('e_communicationrecipientsrecipient_objecttype') + Generic AutocompleteElement Response + """ # noqa: E501 + fki_agent_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Agent.", alias="fkiAgentID") + fki_broker_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Broker.", alias="fkiBrokerID") + fki_contact_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Contact", alias="fkiContactID") + fki_customer_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Customer.", alias="fkiCustomerID") + fki_employee_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Employee.", alias="fkiEmployeeID") + fki_ezsignsigner_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsignsigner", alias="fkiEzsignsignerID") + fki_franchiseoffice_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Franchisereoffice", alias="fkiFranchiseofficeID") + fki_user_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the User", alias="fkiUserID") + fki_agentincorporation_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Agentincorporation.", alias="fkiAgentincorporationID") + fki_assistant_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Assistant.", alias="fkiAssistantID") + fki_externalbroker_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Externalbroker.", alias="fkiExternalbrokerID") + fki_ezcomagent_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezcomagent.", alias="fkiEzcomagentID") + fki_notary_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Notary.", alias="fkiNotaryID") + fki_rewardmember_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Rewardmember.", alias="fkiRewardmemberID") + fki_supplier_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Supplier.", alias="fkiSupplierID") + e_communicationrecipientsrecipient_objecttype: StrictStr = Field(alias="eCommunicationrecipientsrecipientObjecttype") + obj_contact_name: CustomContactNameResponse = Field(alias="objContactName") + obj_email: Optional[EmailResponseCompound] = Field(default=None, alias="objEmail") + obj_phone_fax: Optional[PhoneResponseCompound] = Field(default=None, alias="objPhoneFax") + obj_phone_sms: Optional[PhoneResponseCompound] = Field(default=None, alias="objPhoneSMS") + __properties: ClassVar[List[str]] = ["fkiAgentID", "fkiBrokerID", "fkiContactID", "fkiCustomerID", "fkiEmployeeID", "fkiEzsignsignerID", "fkiFranchiseofficeID", "fkiUserID", "fkiAgentincorporationID", "fkiAssistantID", "fkiExternalbrokerID", "fkiEzcomagentID", "fkiNotaryID", "fkiRewardmemberID", "fkiSupplierID", "eCommunicationrecipientsrecipientObjecttype", "objContactName", "objEmail", "objPhoneFax", "objPhoneSMS"] + + @field_validator('e_communicationrecipientsrecipient_objecttype') def e_communicationrecipientsrecipient_objecttype_validate_enum(cls, value): """Validates the enum""" if value not in ('Agent', 'Agentincorporation', 'Assistant', 'Broker', 'Contact', 'Customer', 'Employee', 'Externalbroker', 'Ezcomagent', 'Ezcomcompany', 'Ezsignsigner', 'Franchiseoffice', 'Notary', 'Rewardmember', 'Supplier', 'User'): raise ValueError("must be one of enum values ('Agent', 'Agentincorporation', 'Assistant', 'Broker', 'Contact', 'Customer', 'Employee', 'Externalbroker', 'Ezcomagent', 'Ezcomcompany', 'Ezsignsigner', 'Franchiseoffice', 'Notary', 'Rewardmember', 'Supplier', 'User')") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> CustomCommunicationrecipientsrecipientResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of CustomCommunicationrecipientsrecipientResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_contact_name if self.obj_contact_name: _dict['objContactName'] = self.obj_contact_name.to_dict() @@ -97,35 +116,35 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> CustomCommunicationrecipientsrecipientResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of CustomCommunicationrecipientsrecipientResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return CustomCommunicationrecipientsrecipientResponse.parse_obj(obj) - - _obj = CustomCommunicationrecipientsrecipientResponse.parse_obj({ - "fki_agent_id": obj.get("fkiAgentID"), - "fki_broker_id": obj.get("fkiBrokerID"), - "fki_contact_id": obj.get("fkiContactID"), - "fki_customer_id": obj.get("fkiCustomerID"), - "fki_employee_id": obj.get("fkiEmployeeID"), - "fki_ezsignsigner_id": obj.get("fkiEzsignsignerID"), - "fki_franchiseoffice_id": obj.get("fkiFranchiseofficeID"), - "fki_user_id": obj.get("fkiUserID"), - "fki_agentincorporation_id": obj.get("fkiAgentincorporationID"), - "fki_assistant_id": obj.get("fkiAssistantID"), - "fki_externalbroker_id": obj.get("fkiExternalbrokerID"), - "fki_ezcomagent_id": obj.get("fkiEzcomagentID"), - "fki_notary_id": obj.get("fkiNotaryID"), - "fki_rewardmember_id": obj.get("fkiRewardmemberID"), - "fki_supplier_id": obj.get("fkiSupplierID"), - "e_communicationrecipientsrecipient_objecttype": obj.get("eCommunicationrecipientsrecipientObjecttype"), - "obj_contact_name": CustomContactNameResponse.from_dict(obj.get("objContactName")) if obj.get("objContactName") is not None else None, - "obj_email": EmailResponseCompound.from_dict(obj.get("objEmail")) if obj.get("objEmail") is not None else None, - "obj_phone_fax": PhoneResponseCompound.from_dict(obj.get("objPhoneFax")) if obj.get("objPhoneFax") is not None else None, - "obj_phone_sms": PhoneResponseCompound.from_dict(obj.get("objPhoneSMS")) if obj.get("objPhoneSMS") is not None else None + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "fkiAgentID": obj.get("fkiAgentID"), + "fkiBrokerID": obj.get("fkiBrokerID"), + "fkiContactID": obj.get("fkiContactID"), + "fkiCustomerID": obj.get("fkiCustomerID"), + "fkiEmployeeID": obj.get("fkiEmployeeID"), + "fkiEzsignsignerID": obj.get("fkiEzsignsignerID"), + "fkiFranchiseofficeID": obj.get("fkiFranchiseofficeID"), + "fkiUserID": obj.get("fkiUserID"), + "fkiAgentincorporationID": obj.get("fkiAgentincorporationID"), + "fkiAssistantID": obj.get("fkiAssistantID"), + "fkiExternalbrokerID": obj.get("fkiExternalbrokerID"), + "fkiEzcomagentID": obj.get("fkiEzcomagentID"), + "fkiNotaryID": obj.get("fkiNotaryID"), + "fkiRewardmemberID": obj.get("fkiRewardmemberID"), + "fkiSupplierID": obj.get("fkiSupplierID"), + "eCommunicationrecipientsrecipientObjecttype": obj.get("eCommunicationrecipientsrecipientObjecttype"), + "objContactName": CustomContactNameResponse.from_dict(obj.get("objContactName")) if obj.get("objContactName") is not None else None, + "objEmail": EmailResponseCompound.from_dict(obj.get("objEmail")) if obj.get("objEmail") is not None else None, + "objPhoneFax": PhoneResponseCompound.from_dict(obj.get("objPhoneFax")) if obj.get("objPhoneFax") is not None else None, + "objPhoneSMS": PhoneResponseCompound.from_dict(obj.get("objPhoneSMS")) if obj.get("objPhoneSMS") is not None else None }) return _obj diff --git a/eZmaxApi/models/custom_communicationsender_request.py b/eZmaxApi/models/custom_communicationsender_request.py index 9ab04786f..f1793ceeb 100644 --- a/eZmaxApi/models/custom_communicationsender_request.py +++ b/eZmaxApi/models/custom_communicationsender_request.py @@ -19,59 +19,80 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class CustomCommunicationsenderRequest(BaseModel): """ - A Communicationsender Object # noqa: E501 - """ - fki_agent_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiAgentID", description="The unique ID of the Agent.") - fki_broker_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiBrokerID", description="The unique ID of the Broker.") - fki_mailboxshared_id: Optional[conint(strict=True, le=255, ge=0)] = Field(None, alias="fkiMailboxsharedID", description="The unique ID of the Mailboxshared") - fki_user_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiUserID", description="The unique ID of the User") - __properties = ["fkiAgentID", "fkiBrokerID", "fkiMailboxsharedID", "fkiUserID"] + A Communicationsender Object + """ # noqa: E501 + fki_agent_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Agent.", alias="fkiAgentID") + fki_broker_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Broker.", alias="fkiBrokerID") + fki_mailboxshared_id: Optional[Annotated[int, Field(le=255, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Mailboxshared", alias="fkiMailboxsharedID") + fki_phonelineshared_id: Optional[Annotated[int, Field(le=255, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Phonelineshared", alias="fkiPhonelinesharedID") + fki_user_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the User", alias="fkiUserID") + __properties: ClassVar[List[str]] = ["fkiAgentID", "fkiBrokerID", "fkiMailboxsharedID", "fkiPhonelinesharedID", "fkiUserID"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> CustomCommunicationsenderRequest: + def from_json(cls, json_str: str) -> Self: """Create an instance of CustomCommunicationsenderRequest from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> CustomCommunicationsenderRequest: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of CustomCommunicationsenderRequest from a dict""" if obj is None: return None if not isinstance(obj, dict): - return CustomCommunicationsenderRequest.parse_obj(obj) - - _obj = CustomCommunicationsenderRequest.parse_obj({ - "fki_agent_id": obj.get("fkiAgentID"), - "fki_broker_id": obj.get("fkiBrokerID"), - "fki_mailboxshared_id": obj.get("fkiMailboxsharedID"), - "fki_user_id": obj.get("fkiUserID") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "fkiAgentID": obj.get("fkiAgentID"), + "fkiBrokerID": obj.get("fkiBrokerID"), + "fkiMailboxsharedID": obj.get("fkiMailboxsharedID"), + "fkiPhonelinesharedID": obj.get("fkiPhonelinesharedID"), + "fkiUserID": obj.get("fkiUserID") }) return _obj diff --git a/eZmaxApi/models/custom_communicationsender_response.py b/eZmaxApi/models/custom_communicationsender_response.py index 7e47592d3..630d12feb 100644 --- a/eZmaxApi/models/custom_communicationsender_response.py +++ b/eZmaxApi/models/custom_communicationsender_response.py @@ -19,88 +19,112 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictStr, conint, constr, validator +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictStr, field_validator +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.custom_contact_name_response import CustomContactNameResponse +from eZmaxApi.models.email_response_compound import EmailResponseCompound +from eZmaxApi.models.phone_response_compound import PhoneResponseCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class CustomCommunicationsenderResponse(BaseModel): """ - Generic Communicationsender Response # noqa: E501 - """ - fki_agent_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiAgentID", description="The unique ID of the Agent.") - fki_broker_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiBrokerID", description="The unique ID of the Broker.") - fki_user_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiUserID", description="The unique ID of the User") - fki_mailboxshared_id: Optional[conint(strict=True, le=255, ge=0)] = Field(None, alias="fkiMailboxsharedID", description="The unique ID of the Mailboxshared") - e_communicationsender_objecttype: StrictStr = Field(..., alias="eCommunicationsenderObjecttype") - obj_contact_name: CustomContactNameResponse = Field(..., alias="objContactName") - s_email_address: Optional[StrictStr] = Field(None, alias="sEmailAddress", description="The email address.") - s_phone_e164: Optional[constr(strict=True)] = Field(None, alias="sPhoneE164", description="A phone number in E.164 Format") - __properties = ["fkiAgentID", "fkiBrokerID", "fkiUserID", "fkiMailboxsharedID", "eCommunicationsenderObjecttype", "objContactName", "sEmailAddress", "sPhoneE164"] - - @validator('e_communicationsender_objecttype') + Generic Communicationsender Response + """ # noqa: E501 + fki_agent_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Agent.", alias="fkiAgentID") + fki_broker_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Broker.", alias="fkiBrokerID") + fki_user_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the User", alias="fkiUserID") + fki_mailboxshared_id: Optional[Annotated[int, Field(le=255, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Mailboxshared", alias="fkiMailboxsharedID") + fki_phonelineshared_id: Optional[Annotated[int, Field(le=255, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Phonelineshared", alias="fkiPhonelinesharedID") + e_communicationsender_objecttype: StrictStr = Field(alias="eCommunicationsenderObjecttype") + obj_contact_name: CustomContactNameResponse = Field(alias="objContactName") + obj_email: Optional[EmailResponseCompound] = Field(default=None, alias="objEmail") + obj_phone_fax: Optional[PhoneResponseCompound] = Field(default=None, alias="objPhoneFax") + obj_phone_sms: Optional[PhoneResponseCompound] = Field(default=None, alias="objPhoneSMS") + __properties: ClassVar[List[str]] = ["fkiAgentID", "fkiBrokerID", "fkiUserID", "fkiMailboxsharedID", "fkiPhonelinesharedID", "eCommunicationsenderObjecttype", "objContactName", "objEmail", "objPhoneFax", "objPhoneSMS"] + + @field_validator('e_communicationsender_objecttype') def e_communicationsender_objecttype_validate_enum(cls, value): """Validates the enum""" - if value not in ('Agent', 'Broker', 'User', 'Mailboxshared'): - raise ValueError("must be one of enum values ('Agent', 'Broker', 'User', 'Mailboxshared')") + if value not in ('Agent', 'Broker', 'User', 'Mailboxshared', 'Phonelineshared'): + raise ValueError("must be one of enum values ('Agent', 'Broker', 'User', 'Mailboxshared', 'Phonelineshared')") return value - @validator('s_phone_e164') - def s_phone_e164_validate_regular_expression(cls, value): - """Validates the regular expression""" - if value is None: - return value - - if not re.match(r"^\+[1-9]\d{1,14}$", value): - raise ValueError(r"must validate the regular expression /^\+[1-9]\d{1,14}$/") - return value + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> CustomCommunicationsenderResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of CustomCommunicationsenderResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_contact_name if self.obj_contact_name: _dict['objContactName'] = self.obj_contact_name.to_dict() + # override the default output from pydantic by calling `to_dict()` of obj_email + if self.obj_email: + _dict['objEmail'] = self.obj_email.to_dict() + # override the default output from pydantic by calling `to_dict()` of obj_phone_fax + if self.obj_phone_fax: + _dict['objPhoneFax'] = self.obj_phone_fax.to_dict() + # override the default output from pydantic by calling `to_dict()` of obj_phone_sms + if self.obj_phone_sms: + _dict['objPhoneSMS'] = self.obj_phone_sms.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> CustomCommunicationsenderResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of CustomCommunicationsenderResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return CustomCommunicationsenderResponse.parse_obj(obj) - - _obj = CustomCommunicationsenderResponse.parse_obj({ - "fki_agent_id": obj.get("fkiAgentID"), - "fki_broker_id": obj.get("fkiBrokerID"), - "fki_user_id": obj.get("fkiUserID"), - "fki_mailboxshared_id": obj.get("fkiMailboxsharedID"), - "e_communicationsender_objecttype": obj.get("eCommunicationsenderObjecttype"), - "obj_contact_name": CustomContactNameResponse.from_dict(obj.get("objContactName")) if obj.get("objContactName") is not None else None, - "s_email_address": obj.get("sEmailAddress"), - "s_phone_e164": obj.get("sPhoneE164") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "fkiAgentID": obj.get("fkiAgentID"), + "fkiBrokerID": obj.get("fkiBrokerID"), + "fkiUserID": obj.get("fkiUserID"), + "fkiMailboxsharedID": obj.get("fkiMailboxsharedID"), + "fkiPhonelinesharedID": obj.get("fkiPhonelinesharedID"), + "eCommunicationsenderObjecttype": obj.get("eCommunicationsenderObjecttype"), + "objContactName": CustomContactNameResponse.from_dict(obj.get("objContactName")) if obj.get("objContactName") is not None else None, + "objEmail": EmailResponseCompound.from_dict(obj.get("objEmail")) if obj.get("objEmail") is not None else None, + "objPhoneFax": PhoneResponseCompound.from_dict(obj.get("objPhoneFax")) if obj.get("objPhoneFax") is not None else None, + "objPhoneSMS": PhoneResponseCompound.from_dict(obj.get("objPhoneSMS")) if obj.get("objPhoneSMS") is not None else None }) return _obj diff --git a/eZmaxApi/models/custom_contact_name_response.py b/eZmaxApi/models/custom_contact_name_response.py index 919e1625f..015b24a61 100644 --- a/eZmaxApi/models/custom_contact_name_response.py +++ b/eZmaxApi/models/custom_contact_name_response.py @@ -19,57 +19,75 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictStr +from pydantic import Field +try: + from typing import Self +except ImportError: + from typing_extensions import Self class CustomContactNameResponse(BaseModel): """ - A Custom ContactName Object # noqa: E501 - """ - s_contact_firstname: Optional[StrictStr] = Field(None, alias="sContactFirstname", description="The First name of the contact") - s_contact_lastname: Optional[StrictStr] = Field(None, alias="sContactLastname", description="The Last name of the contact") - s_contact_company: Optional[StrictStr] = Field(None, alias="sContactCompany", description="The Company name of the contact") - __properties = ["sContactFirstname", "sContactLastname", "sContactCompany"] + A Custom ContactName Object + """ # noqa: E501 + s_contact_firstname: Optional[StrictStr] = Field(default=None, description="The First name of the contact", alias="sContactFirstname") + s_contact_lastname: Optional[StrictStr] = Field(default=None, description="The Last name of the contact", alias="sContactLastname") + s_contact_company: Optional[StrictStr] = Field(default=None, description="The Company name of the contact", alias="sContactCompany") + __properties: ClassVar[List[str]] = ["sContactFirstname", "sContactLastname", "sContactCompany"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> CustomContactNameResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of CustomContactNameResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> CustomContactNameResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of CustomContactNameResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return CustomContactNameResponse.parse_obj(obj) + return cls.model_validate(obj) - _obj = CustomContactNameResponse.parse_obj({ - "s_contact_firstname": obj.get("sContactFirstname"), - "s_contact_lastname": obj.get("sContactLastname"), - "s_contact_company": obj.get("sContactCompany") + _obj = cls.model_validate({ + "sContactFirstname": obj.get("sContactFirstname"), + "sContactLastname": obj.get("sContactLastname"), + "sContactCompany": obj.get("sContactCompany") }) return _obj diff --git a/eZmaxApi/models/custom_creditcardtransaction_response.py b/eZmaxApi/models/custom_creditcardtransaction_response.py index b5ac9e784..f1836276e 100644 --- a/eZmaxApi/models/custom_creditcardtransaction_response.py +++ b/eZmaxApi/models/custom_creditcardtransaction_response.py @@ -19,81 +19,100 @@ import json - -from pydantic import BaseModel, Field, constr, validator +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, field_validator +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.field_e_creditcardtype_codename import FieldECreditcardtypeCodename +try: + from typing import Self +except ImportError: + from typing_extensions import Self class CustomCreditcardtransactionResponse(BaseModel): """ - A custom Creditcardtransaction Object # noqa: E501 - """ - e_creditcardtype_codename: FieldECreditcardtypeCodename = Field(..., alias="eCreditcardtypeCodename") - d_creditcardtransaction_amount: constr(strict=True) = Field(..., alias="dCreditcardtransactionAmount", description="The amount of the Creditcardtransaction") - s_creditcardtransaction_partiallydecryptednumber: constr(strict=True) = Field(..., alias="sCreditcardtransactionPartiallydecryptednumber", description="The partially decrypted credit card number used in the Creditcardtransaction") - s_creditcardtransaction_referencenumber: constr(strict=True) = Field(..., alias="sCreditcardtransactionReferencenumber", description="The reference number on the creditcard service for the Creditcardtransaction") - __properties = ["eCreditcardtypeCodename", "dCreditcardtransactionAmount", "sCreditcardtransactionPartiallydecryptednumber", "sCreditcardtransactionReferencenumber"] - - @validator('d_creditcardtransaction_amount') + A custom Creditcardtransaction Object + """ # noqa: E501 + e_creditcardtype_codename: FieldECreditcardtypeCodename = Field(alias="eCreditcardtypeCodename") + d_creditcardtransaction_amount: Annotated[str, Field(strict=True)] = Field(description="The amount of the Creditcardtransaction", alias="dCreditcardtransactionAmount") + s_creditcardtransaction_partiallydecryptednumber: Annotated[str, Field(strict=True)] = Field(description="The partially decrypted credit card number used in the Creditcardtransaction", alias="sCreditcardtransactionPartiallydecryptednumber") + s_creditcardtransaction_referencenumber: Annotated[str, Field(strict=True)] = Field(description="The reference number on the creditcard service for the Creditcardtransaction", alias="sCreditcardtransactionReferencenumber") + __properties: ClassVar[List[str]] = ["eCreditcardtypeCodename", "dCreditcardtransactionAmount", "sCreditcardtransactionPartiallydecryptednumber", "sCreditcardtransactionReferencenumber"] + + @field_validator('d_creditcardtransaction_amount') def d_creditcardtransaction_amount_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^-{0,1}[\d]{1,9}?\.[\d]{2}$", value): raise ValueError(r"must validate the regular expression /^-{0,1}[\d]{1,9}?\.[\d]{2}$/") return value - @validator('s_creditcardtransaction_partiallydecryptednumber') + @field_validator('s_creditcardtransaction_partiallydecryptednumber') def s_creditcardtransaction_partiallydecryptednumber_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^([X]{4}[ ]){3}(\d){4}$", value): raise ValueError(r"must validate the regular expression /^([X]{4}[ ]){3}(\d){4}$/") return value - @validator('s_creditcardtransaction_referencenumber') + @field_validator('s_creditcardtransaction_referencenumber') def s_creditcardtransaction_referencenumber_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^[\d]{18}$", value): raise ValueError(r"must validate the regular expression /^[\d]{18}$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> CustomCreditcardtransactionResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of CustomCreditcardtransactionResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> CustomCreditcardtransactionResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of CustomCreditcardtransactionResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return CustomCreditcardtransactionResponse.parse_obj(obj) + return cls.model_validate(obj) - _obj = CustomCreditcardtransactionResponse.parse_obj({ - "e_creditcardtype_codename": obj.get("eCreditcardtypeCodename"), - "d_creditcardtransaction_amount": obj.get("dCreditcardtransactionAmount"), - "s_creditcardtransaction_partiallydecryptednumber": obj.get("sCreditcardtransactionPartiallydecryptednumber"), - "s_creditcardtransaction_referencenumber": obj.get("sCreditcardtransactionReferencenumber") + _obj = cls.model_validate({ + "eCreditcardtypeCodename": obj.get("eCreditcardtypeCodename"), + "dCreditcardtransactionAmount": obj.get("dCreditcardtransactionAmount"), + "sCreditcardtransactionPartiallydecryptednumber": obj.get("sCreditcardtransactionPartiallydecryptednumber"), + "sCreditcardtransactionReferencenumber": obj.get("sCreditcardtransactionReferencenumber") }) return _obj diff --git a/eZmaxApi/models/custom_dropdown_element_request.py b/eZmaxApi/models/custom_dropdown_element_request.py index ab9eb169a..c6eb8ac45 100644 --- a/eZmaxApi/models/custom_dropdown_element_request.py +++ b/eZmaxApi/models/custom_dropdown_element_request.py @@ -19,55 +19,73 @@ import json - -from pydantic import BaseModel, Field, StrictStr +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictStr +from pydantic import Field +try: + from typing import Self +except ImportError: + from typing_extensions import Self class CustomDropdownElementRequest(BaseModel): """ - Generic DropdownElement Request # noqa: E501 - """ - s_label: StrictStr = Field(..., alias="sLabel", description="The Description of the element") - s_value: StrictStr = Field(..., alias="sValue", description="The Value of the element") - __properties = ["sLabel", "sValue"] + Generic DropdownElement Request + """ # noqa: E501 + s_label: StrictStr = Field(description="The Description of the element", alias="sLabel") + s_value: StrictStr = Field(description="The Value of the element", alias="sValue") + __properties: ClassVar[List[str]] = ["sLabel", "sValue"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> CustomDropdownElementRequest: + def from_json(cls, json_str: str) -> Self: """Create an instance of CustomDropdownElementRequest from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> CustomDropdownElementRequest: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of CustomDropdownElementRequest from a dict""" if obj is None: return None if not isinstance(obj, dict): - return CustomDropdownElementRequest.parse_obj(obj) + return cls.model_validate(obj) - _obj = CustomDropdownElementRequest.parse_obj({ - "s_label": obj.get("sLabel"), - "s_value": obj.get("sValue") + _obj = cls.model_validate({ + "sLabel": obj.get("sLabel"), + "sValue": obj.get("sValue") }) return _obj diff --git a/eZmaxApi/models/custom_dropdown_element_request_compound.py b/eZmaxApi/models/custom_dropdown_element_request_compound.py index fc562be0f..4cbc1f0bb 100644 --- a/eZmaxApi/models/custom_dropdown_element_request_compound.py +++ b/eZmaxApi/models/custom_dropdown_element_request_compound.py @@ -19,55 +19,73 @@ import json - -from pydantic import BaseModel, Field, StrictStr +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictStr +from pydantic import Field +try: + from typing import Self +except ImportError: + from typing_extensions import Self class CustomDropdownElementRequestCompound(BaseModel): """ - A Generic DropdownElement Object and children to create a complete structure # noqa: E501 - """ - s_label: StrictStr = Field(..., alias="sLabel", description="The Description of the element") - s_value: StrictStr = Field(..., alias="sValue", description="The Value of the element") - __properties = ["sLabel", "sValue"] + A Generic DropdownElement Object and children to create a complete structure + """ # noqa: E501 + s_label: StrictStr = Field(description="The Description of the element", alias="sLabel") + s_value: StrictStr = Field(description="The Value of the element", alias="sValue") + __properties: ClassVar[List[str]] = ["sLabel", "sValue"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> CustomDropdownElementRequestCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of CustomDropdownElementRequestCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> CustomDropdownElementRequestCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of CustomDropdownElementRequestCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return CustomDropdownElementRequestCompound.parse_obj(obj) + return cls.model_validate(obj) - _obj = CustomDropdownElementRequestCompound.parse_obj({ - "s_label": obj.get("sLabel"), - "s_value": obj.get("sValue") + _obj = cls.model_validate({ + "sLabel": obj.get("sLabel"), + "sValue": obj.get("sValue") }) return _obj diff --git a/eZmaxApi/models/custom_dropdown_element_response.py b/eZmaxApi/models/custom_dropdown_element_response.py index 4f4ad9953..ec097f464 100644 --- a/eZmaxApi/models/custom_dropdown_element_response.py +++ b/eZmaxApi/models/custom_dropdown_element_response.py @@ -19,55 +19,73 @@ import json - -from pydantic import BaseModel, Field, StrictStr +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictStr +from pydantic import Field +try: + from typing import Self +except ImportError: + from typing_extensions import Self class CustomDropdownElementResponse(BaseModel): """ - Generic DropdownElement Response # noqa: E501 - """ - s_label: StrictStr = Field(..., alias="sLabel", description="The Description of the element") - s_value: StrictStr = Field(..., alias="sValue", description="The Value of the element") - __properties = ["sLabel", "sValue"] + Generic DropdownElement Response + """ # noqa: E501 + s_label: StrictStr = Field(description="The Description of the element", alias="sLabel") + s_value: StrictStr = Field(description="The Value of the element", alias="sValue") + __properties: ClassVar[List[str]] = ["sLabel", "sValue"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> CustomDropdownElementResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of CustomDropdownElementResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> CustomDropdownElementResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of CustomDropdownElementResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return CustomDropdownElementResponse.parse_obj(obj) + return cls.model_validate(obj) - _obj = CustomDropdownElementResponse.parse_obj({ - "s_label": obj.get("sLabel"), - "s_value": obj.get("sValue") + _obj = cls.model_validate({ + "sLabel": obj.get("sLabel"), + "sValue": obj.get("sValue") }) return _obj diff --git a/eZmaxApi/models/custom_dropdown_element_response_compound.py b/eZmaxApi/models/custom_dropdown_element_response_compound.py index b738761ec..9346507b8 100644 --- a/eZmaxApi/models/custom_dropdown_element_response_compound.py +++ b/eZmaxApi/models/custom_dropdown_element_response_compound.py @@ -19,55 +19,73 @@ import json - -from pydantic import BaseModel, Field, StrictStr +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictStr +from pydantic import Field +try: + from typing import Self +except ImportError: + from typing_extensions import Self class CustomDropdownElementResponseCompound(BaseModel): """ - A Generic DropdownElement Object and children to create a complete structure # noqa: E501 - """ - s_label: StrictStr = Field(..., alias="sLabel", description="The Description of the element") - s_value: StrictStr = Field(..., alias="sValue", description="The Value of the element") - __properties = ["sLabel", "sValue"] + A Generic DropdownElement Object and children to create a complete structure + """ # noqa: E501 + s_label: StrictStr = Field(description="The Description of the element", alias="sLabel") + s_value: StrictStr = Field(description="The Value of the element", alias="sValue") + __properties: ClassVar[List[str]] = ["sLabel", "sValue"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> CustomDropdownElementResponseCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of CustomDropdownElementResponseCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> CustomDropdownElementResponseCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of CustomDropdownElementResponseCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return CustomDropdownElementResponseCompound.parse_obj(obj) + return cls.model_validate(obj) - _obj = CustomDropdownElementResponseCompound.parse_obj({ - "s_label": obj.get("sLabel"), - "s_value": obj.get("sValue") + _obj = cls.model_validate({ + "sLabel": obj.get("sLabel"), + "sValue": obj.get("sValue") }) return _obj diff --git a/eZmaxApi/models/custom_ezmaxinvoicing_ezsigndocument_response.py b/eZmaxApi/models/custom_ezmaxinvoicing_ezsigndocument_response.py index e365d387b..8cfa27d99 100644 --- a/eZmaxApi/models/custom_ezmaxinvoicing_ezsigndocument_response.py +++ b/eZmaxApi/models/custom_ezmaxinvoicing_ezsigndocument_response.py @@ -19,61 +19,80 @@ import json - -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictBool, StrictStr +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class CustomEzmaxinvoicingEzsigndocumentResponse(BaseModel): """ - An EzmaxinvoicingEzsigndocument object containing information about the Ezmaxinvoicing for an Ezsigndocument # noqa: E501 - """ - fki_ezsignfolder_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsignfolderID", description="The unique ID of the Ezsignfolder") - s_name: StrictStr = Field(..., alias="sName") - s_ezsignfolder_description: StrictStr = Field(..., alias="sEzsignfolderDescription", description="The description of the Ezsignfolder") - s_ezsigndocument_name: StrictStr = Field(..., alias="sEzsigndocumentName", description="The name of the document that will be presented to Ezsignfoldersignerassociations") - b_ezsignfolder_allowed: StrictBool = Field(..., alias="bEzsignfolderAllowed", description="Whether you have access to the Ezsignfolder or not") - __properties = ["fkiEzsignfolderID", "sName", "sEzsignfolderDescription", "sEzsigndocumentName", "bEzsignfolderAllowed"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + An EzmaxinvoicingEzsigndocument object containing information about the Ezmaxinvoicing for an Ezsigndocument + """ # noqa: E501 + fki_ezsignfolder_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsignfolder", alias="fkiEzsignfolderID") + s_name: StrictStr = Field(alias="sName") + s_ezsignfolder_description: StrictStr = Field(description="The description of the Ezsignfolder", alias="sEzsignfolderDescription") + s_ezsigndocument_name: StrictStr = Field(description="The name of the document that will be presented to Ezsignfoldersignerassociations", alias="sEzsigndocumentName") + b_ezsignfolder_allowed: StrictBool = Field(description="Whether you have access to the Ezsignfolder or not", alias="bEzsignfolderAllowed") + __properties: ClassVar[List[str]] = ["fkiEzsignfolderID", "sName", "sEzsignfolderDescription", "sEzsigndocumentName", "bEzsignfolderAllowed"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> CustomEzmaxinvoicingEzsigndocumentResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of CustomEzmaxinvoicingEzsigndocumentResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> CustomEzmaxinvoicingEzsigndocumentResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of CustomEzmaxinvoicingEzsigndocumentResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return CustomEzmaxinvoicingEzsigndocumentResponse.parse_obj(obj) - - _obj = CustomEzmaxinvoicingEzsigndocumentResponse.parse_obj({ - "fki_ezsignfolder_id": obj.get("fkiEzsignfolderID"), - "s_name": obj.get("sName"), - "s_ezsignfolder_description": obj.get("sEzsignfolderDescription"), - "s_ezsigndocument_name": obj.get("sEzsigndocumentName"), - "b_ezsignfolder_allowed": obj.get("bEzsignfolderAllowed") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "fkiEzsignfolderID": obj.get("fkiEzsignfolderID"), + "sName": obj.get("sName"), + "sEzsignfolderDescription": obj.get("sEzsignfolderDescription"), + "sEzsigndocumentName": obj.get("sEzsigndocumentName"), + "bEzsignfolderAllowed": obj.get("bEzsignfolderAllowed") }) return _obj diff --git a/eZmaxApi/models/custom_ezmaxinvoicing_ezsignfolder_response.py b/eZmaxApi/models/custom_ezmaxinvoicing_ezsignfolder_response.py index 4c1e6609c..70a6f1117 100644 --- a/eZmaxApi/models/custom_ezmaxinvoicing_ezsignfolder_response.py +++ b/eZmaxApi/models/custom_ezmaxinvoicing_ezsignfolder_response.py @@ -19,63 +19,82 @@ import json - -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictBool, StrictStr +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class CustomEzmaxinvoicingEzsignfolderResponse(BaseModel): """ - An EzmaxinvoicingEzsignfolder object containing information about the Ezmaxinvoicing for an Ezsignfolder # noqa: E501 - """ - fki_ezsignfolder_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsignfolderID", description="The unique ID of the Ezsignfolder") - s_ezsignfolder_description: StrictStr = Field(..., alias="sEzsignfolderDescription", description="The description of the Ezsignfolder") - b_ezsigntsarequirement_billable: StrictBool = Field(..., alias="bEzsigntsarequirementBillable", description="Whether the TSA requirement is billable or not") - b_ezsignfolder_mfaused: StrictBool = Field(..., alias="bEzsignfolderMfaused", description="Whether the MFA was used or not for the Ezsignfolder") - b_ezsignfolder_paymentused: StrictBool = Field(..., alias="bEzsignfolderPaymentused", description="Whether there was a signature is of type payment") - b_ezsignfolder_allowed: StrictBool = Field(..., alias="bEzsignfolderAllowed", description="Whether you have access to the Ezsignfolder or not") - __properties = ["fkiEzsignfolderID", "sEzsignfolderDescription", "bEzsigntsarequirementBillable", "bEzsignfolderMfaused", "bEzsignfolderPaymentused", "bEzsignfolderAllowed"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + An EzmaxinvoicingEzsignfolder object containing information about the Ezmaxinvoicing for an Ezsignfolder + """ # noqa: E501 + fki_ezsignfolder_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsignfolder", alias="fkiEzsignfolderID") + s_ezsignfolder_description: StrictStr = Field(description="The description of the Ezsignfolder", alias="sEzsignfolderDescription") + b_ezsigntsarequirement_billable: StrictBool = Field(description="Whether the TSA requirement is billable or not", alias="bEzsigntsarequirementBillable") + b_ezsignfolder_mfaused: StrictBool = Field(description="Whether the MFA was used or not for the Ezsignfolder", alias="bEzsignfolderMfaused") + b_ezsignfolder_paymentused: StrictBool = Field(description="Whether there was a signature is of type payment", alias="bEzsignfolderPaymentused") + b_ezsignfolder_allowed: StrictBool = Field(description="Whether you have access to the Ezsignfolder or not", alias="bEzsignfolderAllowed") + __properties: ClassVar[List[str]] = ["fkiEzsignfolderID", "sEzsignfolderDescription", "bEzsigntsarequirementBillable", "bEzsignfolderMfaused", "bEzsignfolderPaymentused", "bEzsignfolderAllowed"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> CustomEzmaxinvoicingEzsignfolderResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of CustomEzmaxinvoicingEzsignfolderResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> CustomEzmaxinvoicingEzsignfolderResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of CustomEzmaxinvoicingEzsignfolderResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return CustomEzmaxinvoicingEzsignfolderResponse.parse_obj(obj) - - _obj = CustomEzmaxinvoicingEzsignfolderResponse.parse_obj({ - "fki_ezsignfolder_id": obj.get("fkiEzsignfolderID"), - "s_ezsignfolder_description": obj.get("sEzsignfolderDescription"), - "b_ezsigntsarequirement_billable": obj.get("bEzsigntsarequirementBillable"), - "b_ezsignfolder_mfaused": obj.get("bEzsignfolderMfaused"), - "b_ezsignfolder_paymentused": obj.get("bEzsignfolderPaymentused"), - "b_ezsignfolder_allowed": obj.get("bEzsignfolderAllowed") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "fkiEzsignfolderID": obj.get("fkiEzsignfolderID"), + "sEzsignfolderDescription": obj.get("sEzsignfolderDescription"), + "bEzsigntsarequirementBillable": obj.get("bEzsigntsarequirementBillable"), + "bEzsignfolderMfaused": obj.get("bEzsignfolderMfaused"), + "bEzsignfolderPaymentused": obj.get("bEzsignfolderPaymentused"), + "bEzsignfolderAllowed": obj.get("bEzsignfolderAllowed") }) return _obj diff --git a/eZmaxApi/models/custom_ezmaxpricing_response.py b/eZmaxApi/models/custom_ezmaxpricing_response.py index 6b77a7f72..939eab7e1 100644 --- a/eZmaxApi/models/custom_ezmaxpricing_response.py +++ b/eZmaxApi/models/custom_ezmaxpricing_response.py @@ -19,66 +19,85 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictStr, conint, constr, validator +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictStr, field_validator +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class CustomEzmaxpricingResponse(BaseModel): """ - A Custom Ezmaxpricing Object # noqa: E501 - """ - pki_ezmaxpricing_id: conint(strict=True, ge=1) = Field(..., alias="pkiEzmaxpricingID", description="The unique ID of the Ezmaxpricing") - d_ezmaxpricing_rebateezsignallagents: constr(strict=True) = Field(..., alias="dEzmaxpricingRebateezsignallagents", description="The rebate offered when eZsign is taken for all agents") - dt_ezmaxpricing_start: StrictStr = Field(..., alias="dtEzmaxpricingStart", description="The start date of the Ezmaxpricing") - dt_ezmaxpricing_end: Optional[StrictStr] = Field(None, alias="dtEzmaxpricingEnd", description="The end date of the Ezmaxpricing") - __properties = ["pkiEzmaxpricingID", "dEzmaxpricingRebateezsignallagents", "dtEzmaxpricingStart", "dtEzmaxpricingEnd"] - - @validator('d_ezmaxpricing_rebateezsignallagents') + A Custom Ezmaxpricing Object + """ # noqa: E501 + pki_ezmaxpricing_id: Annotated[int, Field(strict=True, ge=1)] = Field(description="The unique ID of the Ezmaxpricing", alias="pkiEzmaxpricingID") + d_ezmaxpricing_rebateezsignallagents: Annotated[str, Field(strict=True)] = Field(description="The rebate offered when eZsign is taken for all agents", alias="dEzmaxpricingRebateezsignallagents") + dt_ezmaxpricing_start: StrictStr = Field(description="The start date of the Ezmaxpricing", alias="dtEzmaxpricingStart") + dt_ezmaxpricing_end: Optional[StrictStr] = Field(default=None, description="The end date of the Ezmaxpricing", alias="dtEzmaxpricingEnd") + __properties: ClassVar[List[str]] = ["pkiEzmaxpricingID", "dEzmaxpricingRebateezsignallagents", "dtEzmaxpricingStart", "dtEzmaxpricingEnd"] + + @field_validator('d_ezmaxpricing_rebateezsignallagents') def d_ezmaxpricing_rebateezsignallagents_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^-{0,1}[\d]{1,9}?\.[\d]{2}$", value): raise ValueError(r"must validate the regular expression /^-{0,1}[\d]{1,9}?\.[\d]{2}$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> CustomEzmaxpricingResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of CustomEzmaxpricingResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> CustomEzmaxpricingResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of CustomEzmaxpricingResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return CustomEzmaxpricingResponse.parse_obj(obj) + return cls.model_validate(obj) - _obj = CustomEzmaxpricingResponse.parse_obj({ - "pki_ezmaxpricing_id": obj.get("pkiEzmaxpricingID"), - "d_ezmaxpricing_rebateezsignallagents": obj.get("dEzmaxpricingRebateezsignallagents"), - "dt_ezmaxpricing_start": obj.get("dtEzmaxpricingStart"), - "dt_ezmaxpricing_end": obj.get("dtEzmaxpricingEnd") + _obj = cls.model_validate({ + "pkiEzmaxpricingID": obj.get("pkiEzmaxpricingID"), + "dEzmaxpricingRebateezsignallagents": obj.get("dEzmaxpricingRebateezsignallagents"), + "dtEzmaxpricingStart": obj.get("dtEzmaxpricingStart"), + "dtEzmaxpricingEnd": obj.get("dtEzmaxpricingEnd") }) return _obj diff --git a/eZmaxApi/models/custom_ezsigndocument_ezsignsignatures_automatic_response.py b/eZmaxApi/models/custom_ezsigndocument_ezsignsignatures_automatic_response.py index 30752190b..5aa2f2f90 100644 --- a/eZmaxApi/models/custom_ezsigndocument_ezsignsignatures_automatic_response.py +++ b/eZmaxApi/models/custom_ezsigndocument_ezsignsignatures_automatic_response.py @@ -19,43 +19,62 @@ import json -from typing import List -from pydantic import BaseModel, Field, StrictStr, conint, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictStr +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.custom_ezsignsignature_ezsignsignatures_automatic_response import CustomEzsignsignatureEzsignsignaturesAutomaticResponse +try: + from typing import Self +except ImportError: + from typing_extensions import Self class CustomEzsigndocumentEzsignsignaturesAutomaticResponse(BaseModel): """ - An Ezsigndocument Object in the context of an EzsignsignaturesAutomatic path # noqa: E501 - """ - pki_ezsigndocument_id: conint(strict=True, ge=0) = Field(..., alias="pkiEzsigndocumentID", description="The unique ID of the Ezsigndocument") - s_ezsigndocument_name: StrictStr = Field(..., alias="sEzsigndocumentName", description="The name of the document that will be presented to Ezsignfoldersignerassociations") - a_obj_ezsignsignature: conlist(CustomEzsignsignatureEzsignsignaturesAutomaticResponse) = Field(..., alias="a_objEzsignsignature") - __properties = ["pkiEzsigndocumentID", "sEzsigndocumentName", "a_objEzsignsignature"] + An Ezsigndocument Object in the context of an EzsignsignaturesAutomatic path + """ # noqa: E501 + pki_ezsigndocument_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsigndocument", alias="pkiEzsigndocumentID") + s_ezsigndocument_name: StrictStr = Field(description="The name of the document that will be presented to Ezsignfoldersignerassociations", alias="sEzsigndocumentName") + a_obj_ezsignsignature: List[CustomEzsignsignatureEzsignsignaturesAutomaticResponse] = Field(alias="a_objEzsignsignature") + __properties: ClassVar[List[str]] = ["pkiEzsigndocumentID", "sEzsigndocumentName", "a_objEzsignsignature"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> CustomEzsigndocumentEzsignsignaturesAutomaticResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of CustomEzsigndocumentEzsignsignaturesAutomaticResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_ezsignsignature (list) _items = [] if self.a_obj_ezsignsignature: @@ -66,18 +85,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> CustomEzsigndocumentEzsignsignaturesAutomaticResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of CustomEzsigndocumentEzsignsignaturesAutomaticResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return CustomEzsigndocumentEzsignsignaturesAutomaticResponse.parse_obj(obj) + return cls.model_validate(obj) - _obj = CustomEzsigndocumentEzsignsignaturesAutomaticResponse.parse_obj({ - "pki_ezsigndocument_id": obj.get("pkiEzsigndocumentID"), - "s_ezsigndocument_name": obj.get("sEzsigndocumentName"), - "a_obj_ezsignsignature": [CustomEzsignsignatureEzsignsignaturesAutomaticResponse.from_dict(_item) for _item in obj.get("a_objEzsignsignature")] if obj.get("a_objEzsignsignature") is not None else None + _obj = cls.model_validate({ + "pkiEzsigndocumentID": obj.get("pkiEzsigndocumentID"), + "sEzsigndocumentName": obj.get("sEzsigndocumentName"), + "a_objEzsignsignature": [CustomEzsignsignatureEzsignsignaturesAutomaticResponse.from_dict(_item) for _item in obj.get("a_objEzsignsignature")] if obj.get("a_objEzsignsignature") is not None else None }) return _obj diff --git a/eZmaxApi/models/custom_ezsignfolder_ezsignsignatures_automatic_response.py b/eZmaxApi/models/custom_ezsignfolder_ezsignsignatures_automatic_response.py index 95509c1fb..b679a866e 100644 --- a/eZmaxApi/models/custom_ezsignfolder_ezsignsignatures_automatic_response.py +++ b/eZmaxApi/models/custom_ezsignfolder_ezsignsignatures_automatic_response.py @@ -19,43 +19,62 @@ import json -from typing import List -from pydantic import BaseModel, Field, StrictStr, conint, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictStr +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.custom_ezsigndocument_ezsignsignatures_automatic_response import CustomEzsigndocumentEzsignsignaturesAutomaticResponse +try: + from typing import Self +except ImportError: + from typing_extensions import Self class CustomEzsignfolderEzsignsignaturesAutomaticResponse(BaseModel): """ - An Ezsignfolder Object in the context of an EzsignsignaturesAutomatic path # noqa: E501 - """ - pki_ezsignfolder_id: conint(strict=True, ge=0) = Field(..., alias="pkiEzsignfolderID", description="The unique ID of the Ezsignfolder") - s_ezsignfolder_description: StrictStr = Field(..., alias="sEzsignfolderDescription", description="The description of the Ezsignfolder") - a_obj_ezsigndocument: conlist(CustomEzsigndocumentEzsignsignaturesAutomaticResponse) = Field(..., alias="a_objEzsigndocument") - __properties = ["pkiEzsignfolderID", "sEzsignfolderDescription", "a_objEzsigndocument"] + An Ezsignfolder Object in the context of an EzsignsignaturesAutomatic path + """ # noqa: E501 + pki_ezsignfolder_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsignfolder", alias="pkiEzsignfolderID") + s_ezsignfolder_description: StrictStr = Field(description="The description of the Ezsignfolder", alias="sEzsignfolderDescription") + a_obj_ezsigndocument: List[CustomEzsigndocumentEzsignsignaturesAutomaticResponse] = Field(alias="a_objEzsigndocument") + __properties: ClassVar[List[str]] = ["pkiEzsignfolderID", "sEzsignfolderDescription", "a_objEzsigndocument"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> CustomEzsignfolderEzsignsignaturesAutomaticResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of CustomEzsignfolderEzsignsignaturesAutomaticResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_ezsigndocument (list) _items = [] if self.a_obj_ezsigndocument: @@ -66,18 +85,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> CustomEzsignfolderEzsignsignaturesAutomaticResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of CustomEzsignfolderEzsignsignaturesAutomaticResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return CustomEzsignfolderEzsignsignaturesAutomaticResponse.parse_obj(obj) + return cls.model_validate(obj) - _obj = CustomEzsignfolderEzsignsignaturesAutomaticResponse.parse_obj({ - "pki_ezsignfolder_id": obj.get("pkiEzsignfolderID"), - "s_ezsignfolder_description": obj.get("sEzsignfolderDescription"), - "a_obj_ezsigndocument": [CustomEzsigndocumentEzsignsignaturesAutomaticResponse.from_dict(_item) for _item in obj.get("a_objEzsigndocument")] if obj.get("a_objEzsigndocument") is not None else None + _obj = cls.model_validate({ + "pkiEzsignfolderID": obj.get("pkiEzsignfolderID"), + "sEzsignfolderDescription": obj.get("sEzsignfolderDescription"), + "a_objEzsigndocument": [CustomEzsigndocumentEzsignsignaturesAutomaticResponse.from_dict(_item) for _item in obj.get("a_objEzsigndocument")] if obj.get("a_objEzsigndocument") is not None else None }) return _obj diff --git a/eZmaxApi/models/custom_ezsignfoldersignerassociation_actionable_element_response.py b/eZmaxApi/models/custom_ezsignfoldersignerassociation_actionable_element_response.py index 65366093e..983b4c9da 100644 --- a/eZmaxApi/models/custom_ezsignfoldersignerassociation_actionable_element_response.py +++ b/eZmaxApi/models/custom_ezsignfoldersignerassociation_actionable_element_response.py @@ -19,52 +19,71 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, StrictStr +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.ezsignfoldersignerassociation_response_compound_user import EzsignfoldersignerassociationResponseCompoundUser from eZmaxApi.models.ezsignsigner_response_compound import EzsignsignerResponseCompound from eZmaxApi.models.ezsignsignergroup_response_compound import EzsignsignergroupResponseCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class CustomEzsignfoldersignerassociationActionableElementResponse(BaseModel): """ - A Ezsignfoldersignerassociation Object with actionable elements # noqa: E501 - """ - pki_ezsignfoldersignerassociation_id: conint(strict=True, ge=0) = Field(..., alias="pkiEzsignfoldersignerassociationID", description="The unique ID of the Ezsignfoldersignerassociation") - fki_ezsignfolder_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsignfolderID", description="The unique ID of the Ezsignfolder") - b_ezsignfoldersignerassociation_delayedsend: StrictBool = Field(..., alias="bEzsignfoldersignerassociationDelayedsend", description="If this flag is true the signatory is part of a delayed send.") - b_ezsignfoldersignerassociation_receivecopy: StrictBool = Field(..., alias="bEzsignfoldersignerassociationReceivecopy", description="If this flag is true. The signatory will receive a copy of every signed Ezsigndocument even if it ain't required to sign the document.") - t_ezsignfoldersignerassociation_message: StrictStr = Field(..., alias="tEzsignfoldersignerassociationMessage", description="A custom text message that will be added to the email sent.") - obj_ezsignsignergroup: Optional[EzsignsignergroupResponseCompound] = Field(None, alias="objEzsignsignergroup") - obj_user: Optional[EzsignfoldersignerassociationResponseCompoundUser] = Field(None, alias="objUser") - obj_ezsignsigner: Optional[EzsignsignerResponseCompound] = Field(None, alias="objEzsignsigner") - b_ezsignfoldersignerassociation_hasactionableelements_current: StrictBool = Field(..., alias="bEzsignfoldersignerassociationHasactionableelementsCurrent", description="Indicates if the Ezsignfoldersignerassociation has actionable elements in the current step") - b_ezsignfoldersignerassociation_hasactionableelements_future: StrictBool = Field(..., alias="bEzsignfoldersignerassociationHasactionableelementsFuture", description="Indicates if the Ezsignfoldersignerassociation has actionable elements in a future step") - __properties = ["pkiEzsignfoldersignerassociationID", "fkiEzsignfolderID", "bEzsignfoldersignerassociationDelayedsend", "bEzsignfoldersignerassociationReceivecopy", "tEzsignfoldersignerassociationMessage", "objEzsignsignergroup", "objUser", "objEzsignsigner", "bEzsignfoldersignerassociationHasactionableelementsCurrent", "bEzsignfoldersignerassociationHasactionableelementsFuture"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + A Ezsignfoldersignerassociation Object with actionable elements + """ # noqa: E501 + pki_ezsignfoldersignerassociation_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsignfoldersignerassociation", alias="pkiEzsignfoldersignerassociationID") + fki_ezsignfolder_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsignfolder", alias="fkiEzsignfolderID") + b_ezsignfoldersignerassociation_delayedsend: StrictBool = Field(description="If this flag is true the signatory is part of a delayed send.", alias="bEzsignfoldersignerassociationDelayedsend") + b_ezsignfoldersignerassociation_receivecopy: StrictBool = Field(description="If this flag is true. The signatory will receive a copy of every signed Ezsigndocument even if it ain't required to sign the document.", alias="bEzsignfoldersignerassociationReceivecopy") + t_ezsignfoldersignerassociation_message: StrictStr = Field(description="A custom text message that will be added to the email sent.", alias="tEzsignfoldersignerassociationMessage") + obj_ezsignsignergroup: Optional[EzsignsignergroupResponseCompound] = Field(default=None, alias="objEzsignsignergroup") + obj_user: Optional[EzsignfoldersignerassociationResponseCompoundUser] = Field(default=None, alias="objUser") + obj_ezsignsigner: Optional[EzsignsignerResponseCompound] = Field(default=None, alias="objEzsignsigner") + b_ezsignfoldersignerassociation_hasactionableelements_current: StrictBool = Field(description="Indicates if the Ezsignfoldersignerassociation has actionable elements in the current step", alias="bEzsignfoldersignerassociationHasactionableelementsCurrent") + b_ezsignfoldersignerassociation_hasactionableelements_future: StrictBool = Field(description="Indicates if the Ezsignfoldersignerassociation has actionable elements in a future step", alias="bEzsignfoldersignerassociationHasactionableelementsFuture") + __properties: ClassVar[List[str]] = ["pkiEzsignfoldersignerassociationID", "fkiEzsignfolderID", "bEzsignfoldersignerassociationDelayedsend", "bEzsignfoldersignerassociationReceivecopy", "tEzsignfoldersignerassociationMessage", "objEzsignsignergroup", "objUser", "objEzsignsigner", "bEzsignfoldersignerassociationHasactionableelementsCurrent", "bEzsignfoldersignerassociationHasactionableelementsFuture"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> CustomEzsignfoldersignerassociationActionableElementResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of CustomEzsignfoldersignerassociationActionableElementResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_ezsignsignergroup if self.obj_ezsignsignergroup: _dict['objEzsignsignergroup'] = self.obj_ezsignsignergroup.to_dict() @@ -77,25 +96,25 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> CustomEzsignfoldersignerassociationActionableElementResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of CustomEzsignfoldersignerassociationActionableElementResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return CustomEzsignfoldersignerassociationActionableElementResponse.parse_obj(obj) - - _obj = CustomEzsignfoldersignerassociationActionableElementResponse.parse_obj({ - "pki_ezsignfoldersignerassociation_id": obj.get("pkiEzsignfoldersignerassociationID"), - "fki_ezsignfolder_id": obj.get("fkiEzsignfolderID"), - "b_ezsignfoldersignerassociation_delayedsend": obj.get("bEzsignfoldersignerassociationDelayedsend"), - "b_ezsignfoldersignerassociation_receivecopy": obj.get("bEzsignfoldersignerassociationReceivecopy"), - "t_ezsignfoldersignerassociation_message": obj.get("tEzsignfoldersignerassociationMessage"), - "obj_ezsignsignergroup": EzsignsignergroupResponseCompound.from_dict(obj.get("objEzsignsignergroup")) if obj.get("objEzsignsignergroup") is not None else None, - "obj_user": EzsignfoldersignerassociationResponseCompoundUser.from_dict(obj.get("objUser")) if obj.get("objUser") is not None else None, - "obj_ezsignsigner": EzsignsignerResponseCompound.from_dict(obj.get("objEzsignsigner")) if obj.get("objEzsignsigner") is not None else None, - "b_ezsignfoldersignerassociation_hasactionableelements_current": obj.get("bEzsignfoldersignerassociationHasactionableelementsCurrent"), - "b_ezsignfoldersignerassociation_hasactionableelements_future": obj.get("bEzsignfoldersignerassociationHasactionableelementsFuture") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsignfoldersignerassociationID": obj.get("pkiEzsignfoldersignerassociationID"), + "fkiEzsignfolderID": obj.get("fkiEzsignfolderID"), + "bEzsignfoldersignerassociationDelayedsend": obj.get("bEzsignfoldersignerassociationDelayedsend"), + "bEzsignfoldersignerassociationReceivecopy": obj.get("bEzsignfoldersignerassociationReceivecopy"), + "tEzsignfoldersignerassociationMessage": obj.get("tEzsignfoldersignerassociationMessage"), + "objEzsignsignergroup": EzsignsignergroupResponseCompound.from_dict(obj.get("objEzsignsignergroup")) if obj.get("objEzsignsignergroup") is not None else None, + "objUser": EzsignfoldersignerassociationResponseCompoundUser.from_dict(obj.get("objUser")) if obj.get("objUser") is not None else None, + "objEzsignsigner": EzsignsignerResponseCompound.from_dict(obj.get("objEzsignsigner")) if obj.get("objEzsignsigner") is not None else None, + "bEzsignfoldersignerassociationHasactionableelementsCurrent": obj.get("bEzsignfoldersignerassociationHasactionableelementsCurrent"), + "bEzsignfoldersignerassociationHasactionableelementsFuture": obj.get("bEzsignfoldersignerassociationHasactionableelementsFuture") }) return _obj diff --git a/eZmaxApi/models/custom_ezsignfoldersignerassociationmessage_request.py b/eZmaxApi/models/custom_ezsignfoldersignerassociationmessage_request.py index 21da17164..3f9ace8fa 100644 --- a/eZmaxApi/models/custom_ezsignfoldersignerassociationmessage_request.py +++ b/eZmaxApi/models/custom_ezsignfoldersignerassociationmessage_request.py @@ -19,55 +19,74 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictStr, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictStr +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class CustomEzsignfoldersignerassociationmessageRequest(BaseModel): """ - A custom message Object in the context of an Ezsignfolder's send function # noqa: E501 - """ - fki_ezsignfoldersignerassociation_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsignfoldersignerassociationID", description="The unique ID of the Ezsignfoldersignerassociation") - t_ezsignfoldersignerassociation_message: Optional[StrictStr] = Field(None, alias="tEzsignfoldersignerassociationMessage", description="A custom text message that will be added to the email sent.") - __properties = ["fkiEzsignfoldersignerassociationID", "tEzsignfoldersignerassociationMessage"] + A custom message Object in the context of an Ezsignfolder's send function + """ # noqa: E501 + fki_ezsignfoldersignerassociation_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsignfoldersignerassociation", alias="fkiEzsignfoldersignerassociationID") + t_ezsignfoldersignerassociation_message: Optional[StrictStr] = Field(default=None, description="A custom text message that will be added to the email sent.", alias="tEzsignfoldersignerassociationMessage") + __properties: ClassVar[List[str]] = ["fkiEzsignfoldersignerassociationID", "tEzsignfoldersignerassociationMessage"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> CustomEzsignfoldersignerassociationmessageRequest: + def from_json(cls, json_str: str) -> Self: """Create an instance of CustomEzsignfoldersignerassociationmessageRequest from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> CustomEzsignfoldersignerassociationmessageRequest: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of CustomEzsignfoldersignerassociationmessageRequest from a dict""" if obj is None: return None if not isinstance(obj, dict): - return CustomEzsignfoldersignerassociationmessageRequest.parse_obj(obj) + return cls.model_validate(obj) - _obj = CustomEzsignfoldersignerassociationmessageRequest.parse_obj({ - "fki_ezsignfoldersignerassociation_id": obj.get("fkiEzsignfoldersignerassociationID"), - "t_ezsignfoldersignerassociation_message": obj.get("tEzsignfoldersignerassociationMessage") + _obj = cls.model_validate({ + "fkiEzsignfoldersignerassociationID": obj.get("fkiEzsignfoldersignerassociationID"), + "tEzsignfoldersignerassociationMessage": obj.get("tEzsignfoldersignerassociationMessage") }) return _obj diff --git a/eZmaxApi/models/custom_ezsignfoldersignerassociationstatus_response.py b/eZmaxApi/models/custom_ezsignfoldersignerassociationstatus_response.py index 1fe275743..59a39eded 100644 --- a/eZmaxApi/models/custom_ezsignfoldersignerassociationstatus_response.py +++ b/eZmaxApi/models/custom_ezsignfoldersignerassociationstatus_response.py @@ -19,45 +19,64 @@ import json -from typing import List, Optional -from pydantic import BaseModel, Field, StrictStr, conint, conlist +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictStr +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.custom_ezsignsignaturestatus_response import CustomEzsignsignaturestatusResponse +try: + from typing import Self +except ImportError: + from typing_extensions import Self class CustomEzsignfoldersignerassociationstatusResponse(BaseModel): """ - A Ezsignfoldersignerassociationstatus Object and children to create a complete structure # noqa: E501 - """ - fki_ezsignfoldersignerassociation_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsignfoldersignerassociationID", description="The unique ID of the Ezsignfoldersignerassociation") - s_ezsignfoldersignerassociationstatus_lastname: Optional[StrictStr] = Field(None, alias="sEzsignfoldersignerassociationstatusLastname", description="The last name of the Ezsignsigner") - s_ezsignfoldersignerassociationstatus_firstname: Optional[StrictStr] = Field(None, alias="sEzsignfoldersignerassociationstatusFirstname", description="The first name of the Ezsignsigner") - s_ezsignfoldersignerassociationstatus_description_x: Optional[StrictStr] = Field(None, alias="sEzsignfoldersignerassociationstatusDescriptionX", description="The description of the Ezsignsigner") - a_obj_ezsignsignaturestatus: conlist(CustomEzsignsignaturestatusResponse) = Field(..., alias="a_objEzsignsignaturestatus") - __properties = ["fkiEzsignfoldersignerassociationID", "sEzsignfoldersignerassociationstatusLastname", "sEzsignfoldersignerassociationstatusFirstname", "sEzsignfoldersignerassociationstatusDescriptionX", "a_objEzsignsignaturestatus"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + A Ezsignfoldersignerassociationstatus Object and children to create a complete structure + """ # noqa: E501 + fki_ezsignfoldersignerassociation_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsignfoldersignerassociation", alias="fkiEzsignfoldersignerassociationID") + s_ezsignfoldersignerassociationstatus_lastname: Optional[StrictStr] = Field(default=None, description="The last name of the Ezsignsigner", alias="sEzsignfoldersignerassociationstatusLastname") + s_ezsignfoldersignerassociationstatus_firstname: Optional[StrictStr] = Field(default=None, description="The first name of the Ezsignsigner", alias="sEzsignfoldersignerassociationstatusFirstname") + s_ezsignfoldersignerassociationstatus_description_x: Optional[StrictStr] = Field(default=None, description="The description of the Ezsignsigner", alias="sEzsignfoldersignerassociationstatusDescriptionX") + a_obj_ezsignsignaturestatus: List[CustomEzsignsignaturestatusResponse] = Field(alias="a_objEzsignsignaturestatus") + __properties: ClassVar[List[str]] = ["fkiEzsignfoldersignerassociationID", "sEzsignfoldersignerassociationstatusLastname", "sEzsignfoldersignerassociationstatusFirstname", "sEzsignfoldersignerassociationstatusDescriptionX", "a_objEzsignsignaturestatus"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> CustomEzsignfoldersignerassociationstatusResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of CustomEzsignfoldersignerassociationstatusResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_ezsignsignaturestatus (list) _items = [] if self.a_obj_ezsignsignaturestatus: @@ -68,20 +87,20 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> CustomEzsignfoldersignerassociationstatusResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of CustomEzsignfoldersignerassociationstatusResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return CustomEzsignfoldersignerassociationstatusResponse.parse_obj(obj) - - _obj = CustomEzsignfoldersignerassociationstatusResponse.parse_obj({ - "fki_ezsignfoldersignerassociation_id": obj.get("fkiEzsignfoldersignerassociationID"), - "s_ezsignfoldersignerassociationstatus_lastname": obj.get("sEzsignfoldersignerassociationstatusLastname"), - "s_ezsignfoldersignerassociationstatus_firstname": obj.get("sEzsignfoldersignerassociationstatusFirstname"), - "s_ezsignfoldersignerassociationstatus_description_x": obj.get("sEzsignfoldersignerassociationstatusDescriptionX"), - "a_obj_ezsignsignaturestatus": [CustomEzsignsignaturestatusResponse.from_dict(_item) for _item in obj.get("a_objEzsignsignaturestatus")] if obj.get("a_objEzsignsignaturestatus") is not None else None + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "fkiEzsignfoldersignerassociationID": obj.get("fkiEzsignfoldersignerassociationID"), + "sEzsignfoldersignerassociationstatusLastname": obj.get("sEzsignfoldersignerassociationstatusLastname"), + "sEzsignfoldersignerassociationstatusFirstname": obj.get("sEzsignfoldersignerassociationstatusFirstname"), + "sEzsignfoldersignerassociationstatusDescriptionX": obj.get("sEzsignfoldersignerassociationstatusDescriptionX"), + "a_objEzsignsignaturestatus": [CustomEzsignsignaturestatusResponse.from_dict(_item) for _item in obj.get("a_objEzsignsignaturestatus")] if obj.get("a_objEzsignsignaturestatus") is not None else None }) return _obj diff --git a/eZmaxApi/models/custom_ezsignfoldertransmission_response.py b/eZmaxApi/models/custom_ezsignfoldertransmission_response.py index 508838c85..8ecd45e1f 100644 --- a/eZmaxApi/models/custom_ezsignfoldertransmission_response.py +++ b/eZmaxApi/models/custom_ezsignfoldertransmission_response.py @@ -19,47 +19,66 @@ import json -from typing import List -from pydantic import BaseModel, Field, StrictInt, StrictStr, conint, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictInt, StrictStr +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.custom_ezsignfoldertransmission_signer_response import CustomEzsignfoldertransmissionSignerResponse from eZmaxApi.models.field_e_ezsignfolder_step import FieldEEzsignfolderStep +try: + from typing import Self +except ImportError: + from typing_extensions import Self class CustomEzsignfoldertransmissionResponse(BaseModel): """ - An Ezsignfolder Object in the context of an Ezsignbulksendtransmission # noqa: E501 - """ - pki_ezsignfolder_id: conint(strict=True, ge=0) = Field(..., alias="pkiEzsignfolderID", description="The unique ID of the Ezsignfolder") - s_ezsignfolder_description: StrictStr = Field(..., alias="sEzsignfolderDescription", description="The description of the Ezsignfolder") - e_ezsignfolder_step: FieldEEzsignfolderStep = Field(..., alias="eEzsignfolderStep") - i_ezsignfolder_signaturetotal: StrictInt = Field(..., alias="iEzsignfolderSignaturetotal", description="The number of total signatures that were requested in the Ezsignfolder") - i_ezsignfolder_signaturesigned: StrictInt = Field(..., alias="iEzsignfolderSignaturesigned", description="The number of signatures that were signed in the Ezsignfolder.") - a_obj_ezsignfoldertransmission_signer: conlist(CustomEzsignfoldertransmissionSignerResponse) = Field(..., alias="a_objEzsignfoldertransmissionSigner") - __properties = ["pkiEzsignfolderID", "sEzsignfolderDescription", "eEzsignfolderStep", "iEzsignfolderSignaturetotal", "iEzsignfolderSignaturesigned", "a_objEzsignfoldertransmissionSigner"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + An Ezsignfolder Object in the context of an Ezsignbulksendtransmission + """ # noqa: E501 + pki_ezsignfolder_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsignfolder", alias="pkiEzsignfolderID") + s_ezsignfolder_description: StrictStr = Field(description="The description of the Ezsignfolder", alias="sEzsignfolderDescription") + e_ezsignfolder_step: FieldEEzsignfolderStep = Field(alias="eEzsignfolderStep") + i_ezsignfolder_signaturetotal: StrictInt = Field(description="The number of total signatures that were requested in the Ezsignfolder", alias="iEzsignfolderSignaturetotal") + i_ezsignfolder_signaturesigned: StrictInt = Field(description="The number of signatures that were signed in the Ezsignfolder.", alias="iEzsignfolderSignaturesigned") + a_obj_ezsignfoldertransmission_signer: List[CustomEzsignfoldertransmissionSignerResponse] = Field(alias="a_objEzsignfoldertransmissionSigner") + __properties: ClassVar[List[str]] = ["pkiEzsignfolderID", "sEzsignfolderDescription", "eEzsignfolderStep", "iEzsignfolderSignaturetotal", "iEzsignfolderSignaturesigned", "a_objEzsignfoldertransmissionSigner"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> CustomEzsignfoldertransmissionResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of CustomEzsignfoldertransmissionResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_ezsignfoldertransmission_signer (list) _items = [] if self.a_obj_ezsignfoldertransmission_signer: @@ -70,21 +89,21 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> CustomEzsignfoldertransmissionResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of CustomEzsignfoldertransmissionResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return CustomEzsignfoldertransmissionResponse.parse_obj(obj) - - _obj = CustomEzsignfoldertransmissionResponse.parse_obj({ - "pki_ezsignfolder_id": obj.get("pkiEzsignfolderID"), - "s_ezsignfolder_description": obj.get("sEzsignfolderDescription"), - "e_ezsignfolder_step": obj.get("eEzsignfolderStep"), - "i_ezsignfolder_signaturetotal": obj.get("iEzsignfolderSignaturetotal"), - "i_ezsignfolder_signaturesigned": obj.get("iEzsignfolderSignaturesigned"), - "a_obj_ezsignfoldertransmission_signer": [CustomEzsignfoldertransmissionSignerResponse.from_dict(_item) for _item in obj.get("a_objEzsignfoldertransmissionSigner")] if obj.get("a_objEzsignfoldertransmissionSigner") is not None else None + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsignfolderID": obj.get("pkiEzsignfolderID"), + "sEzsignfolderDescription": obj.get("sEzsignfolderDescription"), + "eEzsignfolderStep": obj.get("eEzsignfolderStep"), + "iEzsignfolderSignaturetotal": obj.get("iEzsignfolderSignaturetotal"), + "iEzsignfolderSignaturesigned": obj.get("iEzsignfolderSignaturesigned"), + "a_objEzsignfoldertransmissionSigner": [CustomEzsignfoldertransmissionSignerResponse.from_dict(_item) for _item in obj.get("a_objEzsignfoldertransmissionSigner")] if obj.get("a_objEzsignfoldertransmissionSigner") is not None else None }) return _obj diff --git a/eZmaxApi/models/custom_ezsignfoldertransmission_signer_response.py b/eZmaxApi/models/custom_ezsignfoldertransmission_signer_response.py index dd35984cf..c9016269d 100644 --- a/eZmaxApi/models/custom_ezsignfoldertransmission_signer_response.py +++ b/eZmaxApi/models/custom_ezsignfoldertransmission_signer_response.py @@ -19,57 +19,76 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictStr, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictStr +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class CustomEzsignfoldertransmissionSignerResponse(BaseModel): """ - A form Signer Object in the context of an Ezsignfoldertransmissions # noqa: E501 - """ - fki_user_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiUserID", description="The unique ID of the User") - s_contact_firstname: StrictStr = Field(..., alias="sContactFirstname", description="The First name of the contact") - s_contact_lastname: StrictStr = Field(..., alias="sContactLastname", description="The Last name of the contact") - __properties = ["fkiUserID", "sContactFirstname", "sContactLastname"] + A form Signer Object in the context of an Ezsignfoldertransmissions + """ # noqa: E501 + fki_user_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the User", alias="fkiUserID") + s_contact_firstname: StrictStr = Field(description="The First name of the contact", alias="sContactFirstname") + s_contact_lastname: StrictStr = Field(description="The Last name of the contact", alias="sContactLastname") + __properties: ClassVar[List[str]] = ["fkiUserID", "sContactFirstname", "sContactLastname"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> CustomEzsignfoldertransmissionSignerResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of CustomEzsignfoldertransmissionSignerResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> CustomEzsignfoldertransmissionSignerResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of CustomEzsignfoldertransmissionSignerResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return CustomEzsignfoldertransmissionSignerResponse.parse_obj(obj) + return cls.model_validate(obj) - _obj = CustomEzsignfoldertransmissionSignerResponse.parse_obj({ - "fki_user_id": obj.get("fkiUserID"), - "s_contact_firstname": obj.get("sContactFirstname"), - "s_contact_lastname": obj.get("sContactLastname") + _obj = cls.model_validate({ + "fkiUserID": obj.get("fkiUserID"), + "sContactFirstname": obj.get("sContactFirstname"), + "sContactLastname": obj.get("sContactLastname") }) return _obj diff --git a/eZmaxApi/models/custom_ezsignfoldertype_response.py b/eZmaxApi/models/custom_ezsignfoldertype_response.py index 6e3f300cc..d82dcb23e 100644 --- a/eZmaxApi/models/custom_ezsignfoldertype_response.py +++ b/eZmaxApi/models/custom_ezsignfoldertype_response.py @@ -19,63 +19,88 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, StrictStr +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class CustomEzsignfoldertypeResponse(BaseModel): """ - A Custom Ezsignfoldertype Object # noqa: E501 - """ - pki_ezsignfoldertype_id: conint(strict=True, ge=0) = Field(..., alias="pkiEzsignfoldertypeID", description="The unique ID of the Ezsignfoldertype.") - s_ezsignfoldertype_name_x: Optional[StrictStr] = Field(None, alias="sEzsignfoldertypeNameX", description="The name of the Ezsignfoldertype in the language of the requester") - b_ezsignfoldertype_includeproofsigner: Optional[StrictBool] = Field(None, alias="bEzsignfoldertypeIncludeproofsigner", description="Whether we include the proof with the signed Ezsigndocument for Ezsignsigners") - b_ezsignfoldertype_includeproofuser: Optional[StrictBool] = Field(None, alias="bEzsignfoldertypeIncludeproofuser", description="Whether we include the proof with the signed Ezsigndocument for users") - b_ezsignfoldertype_delegate: Optional[StrictBool] = Field(None, alias="bEzsignfoldertypeDelegate", description="Wheter if delegation of signature is allowed to another user or not") - b_ezsignfoldertype_reassign: Optional[StrictBool] = Field(None, alias="bEzsignfoldertypeReassign", description="Wheter if Reassignment of signature is allowed to another signatory or not") - __properties = ["pkiEzsignfoldertypeID", "sEzsignfoldertypeNameX", "bEzsignfoldertypeIncludeproofsigner", "bEzsignfoldertypeIncludeproofuser", "bEzsignfoldertypeDelegate", "bEzsignfoldertypeReassign"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + A Custom Ezsignfoldertype Object + """ # noqa: E501 + pki_ezsignfoldertype_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsignfoldertype.", alias="pkiEzsignfoldertypeID") + s_ezsignfoldertype_name_x: Optional[StrictStr] = Field(default=None, description="The name of the Ezsignfoldertype in the language of the requester", alias="sEzsignfoldertypeNameX") + b_ezsignfoldertype_sendproofezsignsigner: Optional[StrictBool] = Field(default=None, description="Whether we send the proof in the email to Ezsignsigner", alias="bEzsignfoldertypeSendproofezsignsigner") + b_ezsignfoldertype_includeproofsigner: Optional[StrictBool] = Field(default=None, description="THIS FIELD WILL BE DELETED. Whether we include the proof with the signed Ezsigndocument for Ezsignsigners", alias="bEzsignfoldertypeIncludeproofsigner") + b_ezsignfoldertype_includeproofuser: Optional[StrictBool] = Field(default=None, description="Whether we include the proof with the signed Ezsigndocument for users", alias="bEzsignfoldertypeIncludeproofuser") + b_ezsignfoldertype_allowdownloadattachmentezsignsigner: Optional[StrictBool] = Field(default=None, description="Whether we allow the Ezsigndocument to be downloaded by an Ezsignsigner", alias="bEzsignfoldertypeAllowdownloadattachmentezsignsigner") + b_ezsignfoldertype_allowdownloadproofezsignsigner: Optional[StrictBool] = Field(default=None, description="Whether we allow the proof to be downloaded by an Ezsignsigner", alias="bEzsignfoldertypeAllowdownloadproofezsignsigner") + b_ezsignfoldertype_delegate: Optional[StrictBool] = Field(default=None, description="Wheter if delegation of signature is allowed to another user or not", alias="bEzsignfoldertypeDelegate") + b_ezsignfoldertype_reassign: Optional[StrictBool] = Field(default=None, description="Wheter if Reassignment of signature is allowed to another signatory or not", alias="bEzsignfoldertypeReassign") + __properties: ClassVar[List[str]] = ["pkiEzsignfoldertypeID", "sEzsignfoldertypeNameX", "bEzsignfoldertypeSendproofezsignsigner", "bEzsignfoldertypeIncludeproofsigner", "bEzsignfoldertypeIncludeproofuser", "bEzsignfoldertypeAllowdownloadattachmentezsignsigner", "bEzsignfoldertypeAllowdownloadproofezsignsigner", "bEzsignfoldertypeDelegate", "bEzsignfoldertypeReassign"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> CustomEzsignfoldertypeResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of CustomEzsignfoldertypeResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> CustomEzsignfoldertypeResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of CustomEzsignfoldertypeResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return CustomEzsignfoldertypeResponse.parse_obj(obj) - - _obj = CustomEzsignfoldertypeResponse.parse_obj({ - "pki_ezsignfoldertype_id": obj.get("pkiEzsignfoldertypeID"), - "s_ezsignfoldertype_name_x": obj.get("sEzsignfoldertypeNameX"), - "b_ezsignfoldertype_includeproofsigner": obj.get("bEzsignfoldertypeIncludeproofsigner"), - "b_ezsignfoldertype_includeproofuser": obj.get("bEzsignfoldertypeIncludeproofuser"), - "b_ezsignfoldertype_delegate": obj.get("bEzsignfoldertypeDelegate"), - "b_ezsignfoldertype_reassign": obj.get("bEzsignfoldertypeReassign") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsignfoldertypeID": obj.get("pkiEzsignfoldertypeID"), + "sEzsignfoldertypeNameX": obj.get("sEzsignfoldertypeNameX"), + "bEzsignfoldertypeSendproofezsignsigner": obj.get("bEzsignfoldertypeSendproofezsignsigner"), + "bEzsignfoldertypeIncludeproofsigner": obj.get("bEzsignfoldertypeIncludeproofsigner"), + "bEzsignfoldertypeIncludeproofuser": obj.get("bEzsignfoldertypeIncludeproofuser"), + "bEzsignfoldertypeAllowdownloadattachmentezsignsigner": obj.get("bEzsignfoldertypeAllowdownloadattachmentezsignsigner"), + "bEzsignfoldertypeAllowdownloadproofezsignsigner": obj.get("bEzsignfoldertypeAllowdownloadproofezsignsigner"), + "bEzsignfoldertypeDelegate": obj.get("bEzsignfoldertypeDelegate"), + "bEzsignfoldertypeReassign": obj.get("bEzsignfoldertypeReassign") }) return _obj diff --git a/eZmaxApi/models/custom_ezsignformfield_request.py b/eZmaxApi/models/custom_ezsignformfield_request.py index a317d4032..b8760bb25 100644 --- a/eZmaxApi/models/custom_ezsignformfield_request.py +++ b/eZmaxApi/models/custom_ezsignformfield_request.py @@ -19,59 +19,78 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, StrictStr +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class CustomEzsignformfieldRequest(BaseModel): """ - A Custom Ezsignformfield Object to fill an Ezsignform using submitForm # noqa: E501 - """ - pki_ezsignformfield_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="pkiEzsignformfieldID", description="The unique ID of the Ezsignformfield") - s_ezsignformfield_label: Optional[StrictStr] = Field(None, alias="sEzsignformfieldLabel", description="The Label for the Ezsignformfield") - b_ezsignformfield_selected: Optional[StrictBool] = Field(None, alias="bEzsignformfieldSelected", description="Whether the Ezsignformfield is selected or not by default. This can only be set if eEzsignformfieldgroupType is **Checkbox** or **Radio**") - s_ezsignformfield_enteredvalue: Optional[StrictStr] = Field(None, alias="sEzsignformfieldEnteredvalue", description="This is the value enterred for the Ezsignformfield This can only be set if eEzsignformfieldgroupType is **Dropdown**, **Text** or **Textarea**") - __properties = ["pkiEzsignformfieldID", "sEzsignformfieldLabel", "bEzsignformfieldSelected", "sEzsignformfieldEnteredvalue"] + A Custom Ezsignformfield Object to fill an Ezsignform using submitForm + """ # noqa: E501 + pki_ezsignformfield_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsignformfield", alias="pkiEzsignformfieldID") + s_ezsignformfield_label: Optional[StrictStr] = Field(default=None, description="The Label for the Ezsignformfield", alias="sEzsignformfieldLabel") + b_ezsignformfield_selected: Optional[StrictBool] = Field(default=None, description="Whether the Ezsignformfield is selected or not by default. This can only be set if eEzsignformfieldgroupType is **Checkbox** or **Radio**", alias="bEzsignformfieldSelected") + s_ezsignformfield_enteredvalue: Optional[StrictStr] = Field(default=None, description="This is the value enterred for the Ezsignformfield This can only be set if eEzsignformfieldgroupType is **Dropdown**, **Text** or **Textarea**", alias="sEzsignformfieldEnteredvalue") + __properties: ClassVar[List[str]] = ["pkiEzsignformfieldID", "sEzsignformfieldLabel", "bEzsignformfieldSelected", "sEzsignformfieldEnteredvalue"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> CustomEzsignformfieldRequest: + def from_json(cls, json_str: str) -> Self: """Create an instance of CustomEzsignformfieldRequest from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> CustomEzsignformfieldRequest: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of CustomEzsignformfieldRequest from a dict""" if obj is None: return None if not isinstance(obj, dict): - return CustomEzsignformfieldRequest.parse_obj(obj) + return cls.model_validate(obj) - _obj = CustomEzsignformfieldRequest.parse_obj({ - "pki_ezsignformfield_id": obj.get("pkiEzsignformfieldID"), - "s_ezsignformfield_label": obj.get("sEzsignformfieldLabel"), - "b_ezsignformfield_selected": obj.get("bEzsignformfieldSelected"), - "s_ezsignformfield_enteredvalue": obj.get("sEzsignformfieldEnteredvalue") + _obj = cls.model_validate({ + "pkiEzsignformfieldID": obj.get("pkiEzsignformfieldID"), + "sEzsignformfieldLabel": obj.get("sEzsignformfieldLabel"), + "bEzsignformfieldSelected": obj.get("bEzsignformfieldSelected"), + "sEzsignformfieldEnteredvalue": obj.get("sEzsignformfieldEnteredvalue") }) return _obj diff --git a/eZmaxApi/models/custom_ezsignformfielderror_response.py b/eZmaxApi/models/custom_ezsignformfielderror_response.py index 1bf7ffd24..aaf08715d 100644 --- a/eZmaxApi/models/custom_ezsignformfielderror_response.py +++ b/eZmaxApi/models/custom_ezsignformfielderror_response.py @@ -19,42 +19,60 @@ import json -from typing import List -from pydantic import BaseModel, Field, StrictStr, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictStr +from pydantic import Field from eZmaxApi.models.custom_ezsignformfielderrortest_response import CustomEzsignformfielderrortestResponse +try: + from typing import Self +except ImportError: + from typing_extensions import Self class CustomEzsignformfielderrorResponse(BaseModel): """ - A Custom Ezsignformfield Object to contain an error list # noqa: E501 - """ - s_ezsignformfield_label: StrictStr = Field(..., alias="sEzsignformfieldLabel", description="The Label for the Ezsignformfield") - a_obj_ezsignformfielderrortest: conlist(CustomEzsignformfielderrortestResponse) = Field(..., alias="a_objEzsignformfielderrortest") - __properties = ["sEzsignformfieldLabel", "a_objEzsignformfielderrortest"] + A Custom Ezsignformfield Object to contain an error list + """ # noqa: E501 + s_ezsignformfield_label: StrictStr = Field(description="The Label for the Ezsignformfield", alias="sEzsignformfieldLabel") + a_obj_ezsignformfielderrortest: List[CustomEzsignformfielderrortestResponse] = Field(alias="a_objEzsignformfielderrortest") + __properties: ClassVar[List[str]] = ["sEzsignformfieldLabel", "a_objEzsignformfielderrortest"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> CustomEzsignformfielderrorResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of CustomEzsignformfielderrorResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_ezsignformfielderrortest (list) _items = [] if self.a_obj_ezsignformfielderrortest: @@ -65,17 +83,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> CustomEzsignformfielderrorResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of CustomEzsignformfielderrorResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return CustomEzsignformfielderrorResponse.parse_obj(obj) + return cls.model_validate(obj) - _obj = CustomEzsignformfielderrorResponse.parse_obj({ - "s_ezsignformfield_label": obj.get("sEzsignformfieldLabel"), - "a_obj_ezsignformfielderrortest": [CustomEzsignformfielderrortestResponse.from_dict(_item) for _item in obj.get("a_objEzsignformfielderrortest")] if obj.get("a_objEzsignformfielderrortest") is not None else None + _obj = cls.model_validate({ + "sEzsignformfieldLabel": obj.get("sEzsignformfieldLabel"), + "a_objEzsignformfielderrortest": [CustomEzsignformfielderrortestResponse.from_dict(_item) for _item in obj.get("a_objEzsignformfielderrortest")] if obj.get("a_objEzsignformfielderrortest") is not None else None }) return _obj diff --git a/eZmaxApi/models/custom_ezsignformfielderrortest_response.py b/eZmaxApi/models/custom_ezsignformfielderrortest_response.py index c5283cf00..0c9f3760f 100644 --- a/eZmaxApi/models/custom_ezsignformfielderrortest_response.py +++ b/eZmaxApi/models/custom_ezsignformfielderrortest_response.py @@ -19,69 +19,88 @@ import json - -from pydantic import BaseModel, Field, constr, validator +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, field_validator +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class CustomEzsignformfielderrortestResponse(BaseModel): """ - A Custom Ezsignformfielderrortest Object to contain the detail of the test error # noqa: E501 - """ - s_ezsignformfielderrortest_name: constr(strict=True) = Field(..., alias="sEzsignformfielderrortestName", description="The name of the test") - s_ezsignformfielderrortest_detail: constr(strict=True) = Field(..., alias="sEzsignformfielderrortestDetail", description="The detail why the test failed") - __properties = ["sEzsignformfielderrortestName", "sEzsignformfielderrortestDetail"] + A Custom Ezsignformfielderrortest Object to contain the detail of the test error + """ # noqa: E501 + s_ezsignformfielderrortest_name: Annotated[str, Field(strict=True)] = Field(description="The name of the test", alias="sEzsignformfielderrortestName") + s_ezsignformfielderrortest_detail: Annotated[str, Field(strict=True)] = Field(description="The detail why the test failed", alias="sEzsignformfielderrortestDetail") + __properties: ClassVar[List[str]] = ["sEzsignformfielderrortestName", "sEzsignformfielderrortestDetail"] - @validator('s_ezsignformfielderrortest_name') + @field_validator('s_ezsignformfielderrortest_name') def s_ezsignformfielderrortest_name_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^.{0,50}$", value): raise ValueError(r"must validate the regular expression /^.{0,50}$/") return value - @validator('s_ezsignformfielderrortest_detail') + @field_validator('s_ezsignformfielderrortest_detail') def s_ezsignformfielderrortest_detail_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^.{0,255}$", value): raise ValueError(r"must validate the regular expression /^.{0,255}$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> CustomEzsignformfielderrortestResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of CustomEzsignformfielderrortestResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> CustomEzsignformfielderrortestResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of CustomEzsignformfielderrortestResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return CustomEzsignformfielderrortestResponse.parse_obj(obj) + return cls.model_validate(obj) - _obj = CustomEzsignformfielderrortestResponse.parse_obj({ - "s_ezsignformfielderrortest_name": obj.get("sEzsignformfielderrortestName"), - "s_ezsignformfielderrortest_detail": obj.get("sEzsignformfielderrortestDetail") + _obj = cls.model_validate({ + "sEzsignformfielderrortestName": obj.get("sEzsignformfielderrortestName"), + "sEzsignformfielderrortestDetail": obj.get("sEzsignformfielderrortestDetail") }) return _obj diff --git a/eZmaxApi/models/custom_ezsignformfieldgroup_request.py b/eZmaxApi/models/custom_ezsignformfieldgroup_request.py index d4a1c2886..20e8baabf 100644 --- a/eZmaxApi/models/custom_ezsignformfieldgroup_request.py +++ b/eZmaxApi/models/custom_ezsignformfieldgroup_request.py @@ -19,43 +19,62 @@ import json -from typing import List, Optional -from pydantic import BaseModel, Field, conint, conlist, constr +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.custom_ezsignformfield_request import CustomEzsignformfieldRequest +try: + from typing import Self +except ImportError: + from typing_extensions import Self class CustomEzsignformfieldgroupRequest(BaseModel): """ - A Custom Ezsignformfieldgroup Object to fill an Ezsignform using submitForm # noqa: E501 - """ - pki_ezsignformfieldgroup_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="pkiEzsignformfieldgroupID", description="The unique ID of the Ezsignformfieldgroup") - s_ezsignformfieldgroup_label: Optional[constr(strict=True, max_length=50, min_length=1)] = Field(None, alias="sEzsignformfieldgroupLabel", description="The Label for the Ezsignformfieldgroup") - a_obj_ezsignformfield: conlist(CustomEzsignformfieldRequest, min_items=1) = Field(..., alias="a_objEzsignformfield", description="An array containing all the values to fill the Ezsignform.") - __properties = ["pkiEzsignformfieldgroupID", "sEzsignformfieldgroupLabel", "a_objEzsignformfield"] + A Custom Ezsignformfieldgroup Object to fill an Ezsignform using submitForm + """ # noqa: E501 + pki_ezsignformfieldgroup_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsignformfieldgroup", alias="pkiEzsignformfieldgroupID") + s_ezsignformfieldgroup_label: Optional[Annotated[str, Field(min_length=1, strict=True, max_length=50)]] = Field(default=None, description="The Label for the Ezsignformfieldgroup", alias="sEzsignformfieldgroupLabel") + a_obj_ezsignformfield: Annotated[List[CustomEzsignformfieldRequest], Field(min_length=1)] = Field(description="An array containing all the values to fill the Ezsignform.", alias="a_objEzsignformfield") + __properties: ClassVar[List[str]] = ["pkiEzsignformfieldgroupID", "sEzsignformfieldgroupLabel", "a_objEzsignformfield"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> CustomEzsignformfieldgroupRequest: + def from_json(cls, json_str: str) -> Self: """Create an instance of CustomEzsignformfieldgroupRequest from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_ezsignformfield (list) _items = [] if self.a_obj_ezsignformfield: @@ -66,18 +85,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> CustomEzsignformfieldgroupRequest: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of CustomEzsignformfieldgroupRequest from a dict""" if obj is None: return None if not isinstance(obj, dict): - return CustomEzsignformfieldgroupRequest.parse_obj(obj) + return cls.model_validate(obj) - _obj = CustomEzsignformfieldgroupRequest.parse_obj({ - "pki_ezsignformfieldgroup_id": obj.get("pkiEzsignformfieldgroupID"), - "s_ezsignformfieldgroup_label": obj.get("sEzsignformfieldgroupLabel"), - "a_obj_ezsignformfield": [CustomEzsignformfieldRequest.from_dict(_item) for _item in obj.get("a_objEzsignformfield")] if obj.get("a_objEzsignformfield") is not None else None + _obj = cls.model_validate({ + "pkiEzsignformfieldgroupID": obj.get("pkiEzsignformfieldgroupID"), + "sEzsignformfieldgroupLabel": obj.get("sEzsignformfieldgroupLabel"), + "a_objEzsignformfield": [CustomEzsignformfieldRequest.from_dict(_item) for _item in obj.get("a_objEzsignformfield")] if obj.get("a_objEzsignformfield") is not None else None }) return _obj diff --git a/eZmaxApi/models/custom_ezsignsignature_ezsignsignatures_automatic_response.py b/eZmaxApi/models/custom_ezsignsignature_ezsignsignatures_automatic_response.py index f60f250d7..925e67d04 100644 --- a/eZmaxApi/models/custom_ezsignsignature_ezsignsignatures_automatic_response.py +++ b/eZmaxApi/models/custom_ezsignsignature_ezsignsignatures_automatic_response.py @@ -19,58 +19,77 @@ import json - -from pydantic import BaseModel, Field, conint +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.field_e_ezsignsignature_type import FieldEEzsignsignatureType +try: + from typing import Self +except ImportError: + from typing_extensions import Self class CustomEzsignsignatureEzsignsignaturesAutomaticResponse(BaseModel): """ - An Ezsignsignature Object in the context of an EzsignsignaturesAutomatic path # noqa: E501 - """ - pki_ezsignsignature_id: conint(strict=True, ge=0) = Field(..., alias="pkiEzsignsignatureID", description="The unique ID of the Ezsignsignature") - e_ezsignsignature_type: FieldEEzsignsignatureType = Field(..., alias="eEzsignsignatureType") - i_ezsignpage_pagenumber: conint(strict=True, ge=1) = Field(..., alias="iEzsignpagePagenumber", description="The page number in the Ezsigndocument") - __properties = ["pkiEzsignsignatureID", "eEzsignsignatureType", "iEzsignpagePagenumber"] + An Ezsignsignature Object in the context of an EzsignsignaturesAutomatic path + """ # noqa: E501 + pki_ezsignsignature_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsignsignature", alias="pkiEzsignsignatureID") + e_ezsignsignature_type: FieldEEzsignsignatureType = Field(alias="eEzsignsignatureType") + i_ezsignpage_pagenumber: Annotated[int, Field(strict=True, ge=1)] = Field(description="The page number in the Ezsigndocument", alias="iEzsignpagePagenumber") + __properties: ClassVar[List[str]] = ["pkiEzsignsignatureID", "eEzsignsignatureType", "iEzsignpagePagenumber"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> CustomEzsignsignatureEzsignsignaturesAutomaticResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of CustomEzsignsignatureEzsignsignaturesAutomaticResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> CustomEzsignsignatureEzsignsignaturesAutomaticResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of CustomEzsignsignatureEzsignsignaturesAutomaticResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return CustomEzsignsignatureEzsignsignaturesAutomaticResponse.parse_obj(obj) + return cls.model_validate(obj) - _obj = CustomEzsignsignatureEzsignsignaturesAutomaticResponse.parse_obj({ - "pki_ezsignsignature_id": obj.get("pkiEzsignsignatureID"), - "e_ezsignsignature_type": obj.get("eEzsignsignatureType"), - "i_ezsignpage_pagenumber": obj.get("iEzsignpagePagenumber") + _obj = cls.model_validate({ + "pkiEzsignsignatureID": obj.get("pkiEzsignsignatureID"), + "eEzsignsignatureType": obj.get("eEzsignsignatureType"), + "iEzsignpagePagenumber": obj.get("iEzsignpagePagenumber") }) return _obj diff --git a/eZmaxApi/models/custom_ezsignsignaturestatus_response.py b/eZmaxApi/models/custom_ezsignsignaturestatus_response.py index 528ee9735..8b9ea4d71 100644 --- a/eZmaxApi/models/custom_ezsignsignaturestatus_response.py +++ b/eZmaxApi/models/custom_ezsignsignaturestatus_response.py @@ -19,66 +19,84 @@ import json - -from pydantic import BaseModel, Field, StrictInt, StrictStr, validator +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictInt, StrictStr, field_validator +from pydantic import Field +try: + from typing import Self +except ImportError: + from typing_extensions import Self class CustomEzsignsignaturestatusResponse(BaseModel): """ - A Ezsignsignaturestatus Object and children to create a complete structure # noqa: E501 - """ - e_ezsignsignaturestatus_steptype: StrictStr = Field(..., alias="eEzsignsignaturestatusSteptype", description="Type of step") - i_ezsignsignaturestatus_step: StrictInt = Field(..., alias="iEzsignsignaturestatusStep", description="The step at which the Ezsignsigner will be invited to sign or fill the form fields") - i_ezsignsignaturestatus_total: StrictInt = Field(..., alias="iEzsignsignaturestatusTotal", description="The total number of signature or form fields the Ezsignsigner must process at the current step") - i_ezsignsignaturestatus_signed: StrictInt = Field(..., alias="iEzsignsignaturestatusSigned", description="The number of signature or form fields the Ezsignsigner has already processed at the current step") - __properties = ["eEzsignsignaturestatusSteptype", "iEzsignsignaturestatusStep", "iEzsignsignaturestatusTotal", "iEzsignsignaturestatusSigned"] - - @validator('e_ezsignsignaturestatus_steptype') + A Ezsignsignaturestatus Object and children to create a complete structure + """ # noqa: E501 + e_ezsignsignaturestatus_steptype: StrictStr = Field(description="Type of step", alias="eEzsignsignaturestatusSteptype") + i_ezsignsignaturestatus_step: StrictInt = Field(description="The step at which the Ezsignsigner will be invited to sign or fill the form fields", alias="iEzsignsignaturestatusStep") + i_ezsignsignaturestatus_total: StrictInt = Field(description="The total number of signature or form fields the Ezsignsigner must process at the current step", alias="iEzsignsignaturestatusTotal") + i_ezsignsignaturestatus_signed: StrictInt = Field(description="The number of signature or form fields the Ezsignsigner has already processed at the current step", alias="iEzsignsignaturestatusSigned") + __properties: ClassVar[List[str]] = ["eEzsignsignaturestatusSteptype", "iEzsignsignaturestatusStep", "iEzsignsignaturestatusTotal", "iEzsignsignaturestatusSigned"] + + @field_validator('e_ezsignsignaturestatus_steptype') def e_ezsignsignaturestatus_steptype_validate_enum(cls, value): """Validates the enum""" if value not in ('Form', 'Signature'): raise ValueError("must be one of enum values ('Form', 'Signature')") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> CustomEzsignsignaturestatusResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of CustomEzsignsignaturestatusResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> CustomEzsignsignaturestatusResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of CustomEzsignsignaturestatusResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return CustomEzsignsignaturestatusResponse.parse_obj(obj) + return cls.model_validate(obj) - _obj = CustomEzsignsignaturestatusResponse.parse_obj({ - "e_ezsignsignaturestatus_steptype": obj.get("eEzsignsignaturestatusSteptype"), - "i_ezsignsignaturestatus_step": obj.get("iEzsignsignaturestatusStep"), - "i_ezsignsignaturestatus_total": obj.get("iEzsignsignaturestatusTotal"), - "i_ezsignsignaturestatus_signed": obj.get("iEzsignsignaturestatusSigned") + _obj = cls.model_validate({ + "eEzsignsignaturestatusSteptype": obj.get("eEzsignsignaturestatusSteptype"), + "iEzsignsignaturestatusStep": obj.get("iEzsignsignaturestatusStep"), + "iEzsignsignaturestatusTotal": obj.get("iEzsignsignaturestatusTotal"), + "iEzsignsignaturestatusSigned": obj.get("iEzsignsignaturestatusSigned") }) return _obj diff --git a/eZmaxApi/models/custom_form_data_document_response.py b/eZmaxApi/models/custom_form_data_document_response.py index 0fa35464f..a6adfdf8d 100644 --- a/eZmaxApi/models/custom_form_data_document_response.py +++ b/eZmaxApi/models/custom_form_data_document_response.py @@ -19,45 +19,64 @@ import json -from typing import List -from pydantic import BaseModel, Field, StrictStr, conint, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictStr +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.custom_form_data_signer_response import CustomFormDataSignerResponse +try: + from typing import Self +except ImportError: + from typing_extensions import Self class CustomFormDataDocumentResponse(BaseModel): """ - A form Data Document Object # noqa: E501 - """ - pki_ezsigndocument_id: conint(strict=True, ge=0) = Field(..., alias="pkiEzsigndocumentID", description="The unique ID of the Ezsigndocument") - fki_ezsignfolder_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsignfolderID", description="The unique ID of the Ezsignfolder") - s_ezsigndocument_name: StrictStr = Field(..., alias="sEzsigndocumentName", description="The name of the document that will be presented to Ezsignfoldersignerassociations") - dt_modified_date: StrictStr = Field(..., alias="dtModifiedDate", description="The date and time at which the object was last modified") - a_obj_form_data_signer: conlist(CustomFormDataSignerResponse) = Field(..., alias="a_objFormDataSigner") - __properties = ["pkiEzsigndocumentID", "fkiEzsignfolderID", "sEzsigndocumentName", "dtModifiedDate", "a_objFormDataSigner"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + A form Data Document Object + """ # noqa: E501 + pki_ezsigndocument_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsigndocument", alias="pkiEzsigndocumentID") + fki_ezsignfolder_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsignfolder", alias="fkiEzsignfolderID") + s_ezsigndocument_name: StrictStr = Field(description="The name of the document that will be presented to Ezsignfoldersignerassociations", alias="sEzsigndocumentName") + dt_modified_date: StrictStr = Field(description="The date and time at which the object was last modified", alias="dtModifiedDate") + a_obj_form_data_signer: List[CustomFormDataSignerResponse] = Field(alias="a_objFormDataSigner") + __properties: ClassVar[List[str]] = ["pkiEzsigndocumentID", "fkiEzsignfolderID", "sEzsigndocumentName", "dtModifiedDate", "a_objFormDataSigner"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> CustomFormDataDocumentResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of CustomFormDataDocumentResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_form_data_signer (list) _items = [] if self.a_obj_form_data_signer: @@ -68,20 +87,20 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> CustomFormDataDocumentResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of CustomFormDataDocumentResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return CustomFormDataDocumentResponse.parse_obj(obj) - - _obj = CustomFormDataDocumentResponse.parse_obj({ - "pki_ezsigndocument_id": obj.get("pkiEzsigndocumentID"), - "fki_ezsignfolder_id": obj.get("fkiEzsignfolderID"), - "s_ezsigndocument_name": obj.get("sEzsigndocumentName"), - "dt_modified_date": obj.get("dtModifiedDate"), - "a_obj_form_data_signer": [CustomFormDataSignerResponse.from_dict(_item) for _item in obj.get("a_objFormDataSigner")] if obj.get("a_objFormDataSigner") is not None else None + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsigndocumentID": obj.get("pkiEzsigndocumentID"), + "fkiEzsignfolderID": obj.get("fkiEzsignfolderID"), + "sEzsigndocumentName": obj.get("sEzsigndocumentName"), + "dtModifiedDate": obj.get("dtModifiedDate"), + "a_objFormDataSigner": [CustomFormDataSignerResponse.from_dict(_item) for _item in obj.get("a_objFormDataSigner")] if obj.get("a_objFormDataSigner") is not None else None }) return _obj diff --git a/eZmaxApi/models/custom_form_data_ezsignformfield_response.py b/eZmaxApi/models/custom_form_data_ezsignformfield_response.py index 2be01dfec..873b34b9e 100644 --- a/eZmaxApi/models/custom_form_data_ezsignformfield_response.py +++ b/eZmaxApi/models/custom_form_data_ezsignformfield_response.py @@ -19,55 +19,73 @@ import json - -from pydantic import BaseModel, Field, StrictStr +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictStr +from pydantic import Field +try: + from typing import Self +except ImportError: + from typing_extensions import Self class CustomFormDataEzsignformfieldResponse(BaseModel): """ - An Ezsignformfield Object # noqa: E501 - """ - s_ezsignformfield_label: StrictStr = Field(..., alias="sEzsignformfieldLabel", description="The Label for the Ezsignformfield") - s_ezsignformfield_value: StrictStr = Field(..., alias="sEzsignformfieldValue", description="The value for the Ezsignformfield This can only be set if eEzsignformfieldgroupType is Checkbox or Radio") - __properties = ["sEzsignformfieldLabel", "sEzsignformfieldValue"] + An Ezsignformfield Object + """ # noqa: E501 + s_ezsignformfield_label: StrictStr = Field(description="The Label for the Ezsignformfield", alias="sEzsignformfieldLabel") + s_ezsignformfield_value: StrictStr = Field(description="The value for the Ezsignformfield This can only be set if eEzsignformfieldgroupType is Checkbox or Radio", alias="sEzsignformfieldValue") + __properties: ClassVar[List[str]] = ["sEzsignformfieldLabel", "sEzsignformfieldValue"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> CustomFormDataEzsignformfieldResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of CustomFormDataEzsignformfieldResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> CustomFormDataEzsignformfieldResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of CustomFormDataEzsignformfieldResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return CustomFormDataEzsignformfieldResponse.parse_obj(obj) + return cls.model_validate(obj) - _obj = CustomFormDataEzsignformfieldResponse.parse_obj({ - "s_ezsignformfield_label": obj.get("sEzsignformfieldLabel"), - "s_ezsignformfield_value": obj.get("sEzsignformfieldValue") + _obj = cls.model_validate({ + "sEzsignformfieldLabel": obj.get("sEzsignformfieldLabel"), + "sEzsignformfieldValue": obj.get("sEzsignformfieldValue") }) return _obj diff --git a/eZmaxApi/models/custom_form_data_ezsignformfieldgroup_response.py b/eZmaxApi/models/custom_form_data_ezsignformfieldgroup_response.py index 2738be72e..738f9aa39 100644 --- a/eZmaxApi/models/custom_form_data_ezsignformfieldgroup_response.py +++ b/eZmaxApi/models/custom_form_data_ezsignformfieldgroup_response.py @@ -19,42 +19,61 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist, constr +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.custom_form_data_ezsignformfield_response import CustomFormDataEzsignformfieldResponse +try: + from typing import Self +except ImportError: + from typing_extensions import Self class CustomFormDataEzsignformfieldgroupResponse(BaseModel): """ - An FormDataSigner->Ezsignformfieldgroup Object and children to create a complete structure # noqa: E501 - """ - s_ezsignformfieldgroup_label: constr(strict=True, max_length=50, min_length=1) = Field(..., alias="sEzsignformfieldgroupLabel", description="The Label for the Ezsignformfieldgroup") - a_obj_ezsignformfield: conlist(CustomFormDataEzsignformfieldResponse) = Field(..., alias="a_objEzsignformfield") - __properties = ["sEzsignformfieldgroupLabel", "a_objEzsignformfield"] + An FormDataSigner->Ezsignformfieldgroup Object and children to create a complete structure + """ # noqa: E501 + s_ezsignformfieldgroup_label: Annotated[str, Field(min_length=1, strict=True, max_length=50)] = Field(description="The Label for the Ezsignformfieldgroup", alias="sEzsignformfieldgroupLabel") + a_obj_ezsignformfield: List[CustomFormDataEzsignformfieldResponse] = Field(alias="a_objEzsignformfield") + __properties: ClassVar[List[str]] = ["sEzsignformfieldgroupLabel", "a_objEzsignformfield"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> CustomFormDataEzsignformfieldgroupResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of CustomFormDataEzsignformfieldgroupResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_ezsignformfield (list) _items = [] if self.a_obj_ezsignformfield: @@ -65,17 +84,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> CustomFormDataEzsignformfieldgroupResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of CustomFormDataEzsignformfieldgroupResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return CustomFormDataEzsignformfieldgroupResponse.parse_obj(obj) + return cls.model_validate(obj) - _obj = CustomFormDataEzsignformfieldgroupResponse.parse_obj({ - "s_ezsignformfieldgroup_label": obj.get("sEzsignformfieldgroupLabel"), - "a_obj_ezsignformfield": [CustomFormDataEzsignformfieldResponse.from_dict(_item) for _item in obj.get("a_objEzsignformfield")] if obj.get("a_objEzsignformfield") is not None else None + _obj = cls.model_validate({ + "sEzsignformfieldgroupLabel": obj.get("sEzsignformfieldgroupLabel"), + "a_objEzsignformfield": [CustomFormDataEzsignformfieldResponse.from_dict(_item) for _item in obj.get("a_objEzsignformfield")] if obj.get("a_objEzsignformfield") is not None else None }) return _obj diff --git a/eZmaxApi/models/custom_form_data_signer_response.py b/eZmaxApi/models/custom_form_data_signer_response.py index 45a694262..6853e454e 100644 --- a/eZmaxApi/models/custom_form_data_signer_response.py +++ b/eZmaxApi/models/custom_form_data_signer_response.py @@ -19,45 +19,64 @@ import json -from typing import List, Optional -from pydantic import BaseModel, Field, StrictStr, conint, conlist +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictStr +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.custom_form_data_ezsignformfieldgroup_response import CustomFormDataEzsignformfieldgroupResponse +try: + from typing import Self +except ImportError: + from typing_extensions import Self class CustomFormDataSignerResponse(BaseModel): """ - A form Data Signer Object # noqa: E501 - """ - fki_ezsignfoldersignerassociation_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsignfoldersignerassociationID", description="The unique ID of the Ezsignfoldersignerassociation") - fki_user_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiUserID", description="The unique ID of the User") - s_contact_firstname: StrictStr = Field(..., alias="sContactFirstname", description="The First name of the contact") - s_contact_lastname: StrictStr = Field(..., alias="sContactLastname", description="The Last name of the contact") - a_obj_ezsignformfieldgroup: conlist(CustomFormDataEzsignformfieldgroupResponse) = Field(..., alias="a_objEzsignformfieldgroup") - __properties = ["fkiEzsignfoldersignerassociationID", "fkiUserID", "sContactFirstname", "sContactLastname", "a_objEzsignformfieldgroup"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + A form Data Signer Object + """ # noqa: E501 + fki_ezsignfoldersignerassociation_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsignfoldersignerassociation", alias="fkiEzsignfoldersignerassociationID") + fki_user_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the User", alias="fkiUserID") + s_contact_firstname: StrictStr = Field(description="The First name of the contact", alias="sContactFirstname") + s_contact_lastname: StrictStr = Field(description="The Last name of the contact", alias="sContactLastname") + a_obj_ezsignformfieldgroup: List[CustomFormDataEzsignformfieldgroupResponse] = Field(alias="a_objEzsignformfieldgroup") + __properties: ClassVar[List[str]] = ["fkiEzsignfoldersignerassociationID", "fkiUserID", "sContactFirstname", "sContactLastname", "a_objEzsignformfieldgroup"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> CustomFormDataSignerResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of CustomFormDataSignerResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_ezsignformfieldgroup (list) _items = [] if self.a_obj_ezsignformfieldgroup: @@ -68,20 +87,20 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> CustomFormDataSignerResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of CustomFormDataSignerResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return CustomFormDataSignerResponse.parse_obj(obj) - - _obj = CustomFormDataSignerResponse.parse_obj({ - "fki_ezsignfoldersignerassociation_id": obj.get("fkiEzsignfoldersignerassociationID"), - "fki_user_id": obj.get("fkiUserID"), - "s_contact_firstname": obj.get("sContactFirstname"), - "s_contact_lastname": obj.get("sContactLastname"), - "a_obj_ezsignformfieldgroup": [CustomFormDataEzsignformfieldgroupResponse.from_dict(_item) for _item in obj.get("a_objEzsignformfieldgroup")] if obj.get("a_objEzsignformfieldgroup") is not None else None + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "fkiEzsignfoldersignerassociationID": obj.get("fkiEzsignfoldersignerassociationID"), + "fkiUserID": obj.get("fkiUserID"), + "sContactFirstname": obj.get("sContactFirstname"), + "sContactLastname": obj.get("sContactLastname"), + "a_objEzsignformfieldgroup": [CustomFormDataEzsignformfieldgroupResponse.from_dict(_item) for _item in obj.get("a_objEzsignformfieldgroup")] if obj.get("a_objEzsignformfieldgroup") is not None else None }) return _obj diff --git a/eZmaxApi/models/custom_forms_data_folder_response.py b/eZmaxApi/models/custom_forms_data_folder_response.py index 088167798..a50dce913 100644 --- a/eZmaxApi/models/custom_forms_data_folder_response.py +++ b/eZmaxApi/models/custom_forms_data_folder_response.py @@ -19,43 +19,62 @@ import json -from typing import List -from pydantic import BaseModel, Field, StrictStr, conint, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictStr +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.custom_form_data_document_response import CustomFormDataDocumentResponse +try: + from typing import Self +except ImportError: + from typing_extensions import Self class CustomFormsDataFolderResponse(BaseModel): """ - A forms Data Folder Object # noqa: E501 - """ - pki_ezsignfolder_id: conint(strict=True, ge=0) = Field(..., alias="pkiEzsignfolderID", description="The unique ID of the Ezsignfolder") - s_ezsignfolder_description: StrictStr = Field(..., alias="sEzsignfolderDescription", description="The description of the Ezsignfolder") - a_obj_form_data_document: conlist(CustomFormDataDocumentResponse) = Field(..., alias="a_objFormDataDocument") - __properties = ["pkiEzsignfolderID", "sEzsignfolderDescription", "a_objFormDataDocument"] + A forms Data Folder Object + """ # noqa: E501 + pki_ezsignfolder_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsignfolder", alias="pkiEzsignfolderID") + s_ezsignfolder_description: StrictStr = Field(description="The description of the Ezsignfolder", alias="sEzsignfolderDescription") + a_obj_form_data_document: List[CustomFormDataDocumentResponse] = Field(alias="a_objFormDataDocument") + __properties: ClassVar[List[str]] = ["pkiEzsignfolderID", "sEzsignfolderDescription", "a_objFormDataDocument"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> CustomFormsDataFolderResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of CustomFormsDataFolderResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_form_data_document (list) _items = [] if self.a_obj_form_data_document: @@ -66,18 +85,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> CustomFormsDataFolderResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of CustomFormsDataFolderResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return CustomFormsDataFolderResponse.parse_obj(obj) + return cls.model_validate(obj) - _obj = CustomFormsDataFolderResponse.parse_obj({ - "pki_ezsignfolder_id": obj.get("pkiEzsignfolderID"), - "s_ezsignfolder_description": obj.get("sEzsignfolderDescription"), - "a_obj_form_data_document": [CustomFormDataDocumentResponse.from_dict(_item) for _item in obj.get("a_objFormDataDocument")] if obj.get("a_objFormDataDocument") is not None else None + _obj = cls.model_validate({ + "pkiEzsignfolderID": obj.get("pkiEzsignfolderID"), + "sEzsignfolderDescription": obj.get("sEzsignfolderDescription"), + "a_objFormDataDocument": [CustomFormDataDocumentResponse.from_dict(_item) for _item in obj.get("a_objFormDataDocument")] if obj.get("a_objFormDataDocument") is not None else None }) return _obj diff --git a/eZmaxApi/models/custom_import_ezsigntemplatepackage_relation_request.py b/eZmaxApi/models/custom_import_ezsigntemplatepackage_relation_request.py index 36b0457d2..fd14021ab 100644 --- a/eZmaxApi/models/custom_import_ezsigntemplatepackage_relation_request.py +++ b/eZmaxApi/models/custom_import_ezsigntemplatepackage_relation_request.py @@ -19,57 +19,76 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictStr, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictStr +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class CustomImportEzsigntemplatepackageRelationRequest(BaseModel): """ - The object used in /1/object/ezsignfolder/{pkiEzsignfolderID}/importEzsigntemplatepackage Request # noqa: E501 - """ - fki_ezsigntemplatepackagesigner_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiEzsigntemplatepackagesignerID", description="The unique ID of the Ezsigntemplatepackagesigner") - fki_ezsignfoldersignerassociation_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsignfoldersignerassociationID", description="The unique ID of the Ezsignfoldersignerassociation") - s_ezsigntemplatepackagesigner_description: Optional[StrictStr] = Field(None, alias="sEzsigntemplatepackagesignerDescription", description="The description of the Ezsigntemplatepackagesigner") - __properties = ["fkiEzsigntemplatepackagesignerID", "fkiEzsignfoldersignerassociationID", "sEzsigntemplatepackagesignerDescription"] + The object used in /1/object/ezsignfolder/{pkiEzsignfolderID}/importEzsigntemplatepackage Request + """ # noqa: E501 + fki_ezsigntemplatepackagesigner_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsigntemplatepackagesigner", alias="fkiEzsigntemplatepackagesignerID") + fki_ezsignfoldersignerassociation_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsignfoldersignerassociation", alias="fkiEzsignfoldersignerassociationID") + s_ezsigntemplatepackagesigner_description: Optional[StrictStr] = Field(default=None, description="The description of the Ezsigntemplatepackagesigner", alias="sEzsigntemplatepackagesignerDescription") + __properties: ClassVar[List[str]] = ["fkiEzsigntemplatepackagesignerID", "fkiEzsignfoldersignerassociationID", "sEzsigntemplatepackagesignerDescription"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> CustomImportEzsigntemplatepackageRelationRequest: + def from_json(cls, json_str: str) -> Self: """Create an instance of CustomImportEzsigntemplatepackageRelationRequest from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> CustomImportEzsigntemplatepackageRelationRequest: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of CustomImportEzsigntemplatepackageRelationRequest from a dict""" if obj is None: return None if not isinstance(obj, dict): - return CustomImportEzsigntemplatepackageRelationRequest.parse_obj(obj) + return cls.model_validate(obj) - _obj = CustomImportEzsigntemplatepackageRelationRequest.parse_obj({ - "fki_ezsigntemplatepackagesigner_id": obj.get("fkiEzsigntemplatepackagesignerID"), - "fki_ezsignfoldersignerassociation_id": obj.get("fkiEzsignfoldersignerassociationID"), - "s_ezsigntemplatepackagesigner_description": obj.get("sEzsigntemplatepackagesignerDescription") + _obj = cls.model_validate({ + "fkiEzsigntemplatepackagesignerID": obj.get("fkiEzsigntemplatepackagesignerID"), + "fkiEzsignfoldersignerassociationID": obj.get("fkiEzsignfoldersignerassociationID"), + "sEzsigntemplatepackagesignerDescription": obj.get("sEzsigntemplatepackagesignerDescription") }) return _obj diff --git a/eZmaxApi/models/custom_notificationsubsectiongetnotificationtests_response.py b/eZmaxApi/models/custom_notificationsubsectiongetnotificationtests_response.py index 272114115..5959cb6cb 100644 --- a/eZmaxApi/models/custom_notificationsubsectiongetnotificationtests_response.py +++ b/eZmaxApi/models/custom_notificationsubsectiongetnotificationtests_response.py @@ -19,47 +19,66 @@ import json -from typing import List, Optional -from pydantic import BaseModel, Field, StrictStr, conint, conlist +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictStr +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.custom_notificationtestgetnotificationtests_response import CustomNotificationtestgetnotificationtestsResponse from eZmaxApi.models.multilingual_notificationsubsection_name import MultilingualNotificationsubsectionName +try: + from typing import Self +except ImportError: + from typing_extensions import Self class CustomNotificationsubsectiongetnotificationtestsResponse(BaseModel): """ - A Notificationsubsection Object in the context of getNotificationtests # noqa: E501 - """ - pki_notificationsubsection_id: conint(strict=True, ge=0) = Field(..., alias="pkiNotificationsubsectionID", description="The unique ID of the Notificationsubsection") - fki_notificationsection_id: conint(strict=True, ge=0) = Field(..., alias="fkiNotificationsectionID", description="The unique ID of the Notificationsection") - obj_notificationsubsection_name: Optional[MultilingualNotificationsubsectionName] = Field(None, alias="objNotificationsubsectionName") - s_notificationsection_name_x: Optional[StrictStr] = Field(None, alias="sNotificationsectionNameX", description="The name of the Notificationsection in the language of the requester") - s_notificationsubsection_name_x: StrictStr = Field(..., alias="sNotificationsubsectionNameX", description="The name of the Notificationsubsection in the language of the requester") - a_obj_notificationtest: conlist(CustomNotificationtestgetnotificationtestsResponse) = Field(..., alias="a_objNotificationtest") - __properties = ["pkiNotificationsubsectionID", "fkiNotificationsectionID", "objNotificationsubsectionName", "sNotificationsectionNameX", "sNotificationsubsectionNameX", "a_objNotificationtest"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + A Notificationsubsection Object in the context of getNotificationtests + """ # noqa: E501 + pki_notificationsubsection_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Notificationsubsection", alias="pkiNotificationsubsectionID") + fki_notificationsection_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Notificationsection", alias="fkiNotificationsectionID") + obj_notificationsubsection_name: Optional[MultilingualNotificationsubsectionName] = Field(default=None, alias="objNotificationsubsectionName") + s_notificationsection_name_x: Optional[StrictStr] = Field(default=None, description="The name of the Notificationsection in the language of the requester", alias="sNotificationsectionNameX") + s_notificationsubsection_name_x: StrictStr = Field(description="The name of the Notificationsubsection in the language of the requester", alias="sNotificationsubsectionNameX") + a_obj_notificationtest: List[CustomNotificationtestgetnotificationtestsResponse] = Field(alias="a_objNotificationtest") + __properties: ClassVar[List[str]] = ["pkiNotificationsubsectionID", "fkiNotificationsectionID", "objNotificationsubsectionName", "sNotificationsectionNameX", "sNotificationsubsectionNameX", "a_objNotificationtest"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> CustomNotificationsubsectiongetnotificationtestsResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of CustomNotificationsubsectiongetnotificationtestsResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_notificationsubsection_name if self.obj_notificationsubsection_name: _dict['objNotificationsubsectionName'] = self.obj_notificationsubsection_name.to_dict() @@ -73,21 +92,21 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> CustomNotificationsubsectiongetnotificationtestsResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of CustomNotificationsubsectiongetnotificationtestsResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return CustomNotificationsubsectiongetnotificationtestsResponse.parse_obj(obj) - - _obj = CustomNotificationsubsectiongetnotificationtestsResponse.parse_obj({ - "pki_notificationsubsection_id": obj.get("pkiNotificationsubsectionID"), - "fki_notificationsection_id": obj.get("fkiNotificationsectionID"), - "obj_notificationsubsection_name": MultilingualNotificationsubsectionName.from_dict(obj.get("objNotificationsubsectionName")) if obj.get("objNotificationsubsectionName") is not None else None, - "s_notificationsection_name_x": obj.get("sNotificationsectionNameX"), - "s_notificationsubsection_name_x": obj.get("sNotificationsubsectionNameX"), - "a_obj_notificationtest": [CustomNotificationtestgetnotificationtestsResponse.from_dict(_item) for _item in obj.get("a_objNotificationtest")] if obj.get("a_objNotificationtest") is not None else None + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiNotificationsubsectionID": obj.get("pkiNotificationsubsectionID"), + "fkiNotificationsectionID": obj.get("fkiNotificationsectionID"), + "objNotificationsubsectionName": MultilingualNotificationsubsectionName.from_dict(obj.get("objNotificationsubsectionName")) if obj.get("objNotificationsubsectionName") is not None else None, + "sNotificationsectionNameX": obj.get("sNotificationsectionNameX"), + "sNotificationsubsectionNameX": obj.get("sNotificationsubsectionNameX"), + "a_objNotificationtest": [CustomNotificationtestgetnotificationtestsResponse.from_dict(_item) for _item in obj.get("a_objNotificationtest")] if obj.get("a_objNotificationtest") is not None else None }) return _obj diff --git a/eZmaxApi/models/custom_notificationtestgetnotificationtests_response.py b/eZmaxApi/models/custom_notificationtestgetnotificationtests_response.py index 1733defd1..480889913 100644 --- a/eZmaxApi/models/custom_notificationtestgetnotificationtests_response.py +++ b/eZmaxApi/models/custom_notificationtestgetnotificationtests_response.py @@ -19,70 +19,89 @@ import json - -from pydantic import BaseModel, Field, StrictInt, StrictStr, conint +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictInt, StrictStr +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.field_e_notificationpreference_status import FieldENotificationpreferenceStatus from eZmaxApi.models.multilingual_notificationtest_name import MultilingualNotificationtestName +try: + from typing import Self +except ImportError: + from typing_extensions import Self class CustomNotificationtestgetnotificationtestsResponse(BaseModel): """ - A Notificationtest Object in the context of getNotificationtests # noqa: E501 - """ - pki_notificationtest_id: conint(strict=True, ge=0) = Field(..., alias="pkiNotificationtestID", description="The unique ID of the Notificationtest") - obj_notificationtest_name: MultilingualNotificationtestName = Field(..., alias="objNotificationtestName") - fki_notificationsubsection_id: conint(strict=True, ge=0) = Field(..., alias="fkiNotificationsubsectionID", description="The unique ID of the Notificationsubsection") - s_notificationtest_function: StrictStr = Field(..., alias="sNotificationtestFunction", description="The function name of the Notificationtest") - s_notificationtest_name_x: StrictStr = Field(..., alias="sNotificationtestNameX", description="The name of the Notificationtest in the language of the requester") - e_notificationpreference_status: FieldENotificationpreferenceStatus = Field(..., alias="eNotificationpreferenceStatus") - i_notificationtest: StrictInt = Field(..., alias="iNotificationtest", description="The number of elements returned by the Notificationtest") - __properties = ["pkiNotificationtestID", "objNotificationtestName", "fkiNotificationsubsectionID", "sNotificationtestFunction", "sNotificationtestNameX", "eNotificationpreferenceStatus", "iNotificationtest"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + A Notificationtest Object in the context of getNotificationtests + """ # noqa: E501 + pki_notificationtest_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Notificationtest", alias="pkiNotificationtestID") + obj_notificationtest_name: MultilingualNotificationtestName = Field(alias="objNotificationtestName") + fki_notificationsubsection_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Notificationsubsection", alias="fkiNotificationsubsectionID") + s_notificationtest_function: StrictStr = Field(description="The function name of the Notificationtest", alias="sNotificationtestFunction") + s_notificationtest_name_x: StrictStr = Field(description="The name of the Notificationtest in the language of the requester", alias="sNotificationtestNameX") + e_notificationpreference_status: FieldENotificationpreferenceStatus = Field(alias="eNotificationpreferenceStatus") + i_notificationtest: StrictInt = Field(description="The number of elements returned by the Notificationtest", alias="iNotificationtest") + __properties: ClassVar[List[str]] = ["pkiNotificationtestID", "objNotificationtestName", "fkiNotificationsubsectionID", "sNotificationtestFunction", "sNotificationtestNameX", "eNotificationpreferenceStatus", "iNotificationtest"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> CustomNotificationtestgetnotificationtestsResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of CustomNotificationtestgetnotificationtestsResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_notificationtest_name if self.obj_notificationtest_name: _dict['objNotificationtestName'] = self.obj_notificationtest_name.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> CustomNotificationtestgetnotificationtestsResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of CustomNotificationtestgetnotificationtestsResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return CustomNotificationtestgetnotificationtestsResponse.parse_obj(obj) - - _obj = CustomNotificationtestgetnotificationtestsResponse.parse_obj({ - "pki_notificationtest_id": obj.get("pkiNotificationtestID"), - "obj_notificationtest_name": MultilingualNotificationtestName.from_dict(obj.get("objNotificationtestName")) if obj.get("objNotificationtestName") is not None else None, - "fki_notificationsubsection_id": obj.get("fkiNotificationsubsectionID"), - "s_notificationtest_function": obj.get("sNotificationtestFunction"), - "s_notificationtest_name_x": obj.get("sNotificationtestNameX"), - "e_notificationpreference_status": obj.get("eNotificationpreferenceStatus"), - "i_notificationtest": obj.get("iNotificationtest") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiNotificationtestID": obj.get("pkiNotificationtestID"), + "objNotificationtestName": MultilingualNotificationtestName.from_dict(obj.get("objNotificationtestName")) if obj.get("objNotificationtestName") is not None else None, + "fkiNotificationsubsectionID": obj.get("fkiNotificationsubsectionID"), + "sNotificationtestFunction": obj.get("sNotificationtestFunction"), + "sNotificationtestNameX": obj.get("sNotificationtestNameX"), + "eNotificationpreferenceStatus": obj.get("eNotificationpreferenceStatus"), + "iNotificationtest": obj.get("iNotificationtest") }) return _obj diff --git a/eZmaxApi/models/custom_user_response.py b/eZmaxApi/models/custom_user_response.py index 4be848cbb..ee0023993 100644 --- a/eZmaxApi/models/custom_user_response.py +++ b/eZmaxApi/models/custom_user_response.py @@ -19,59 +19,78 @@ import json - -from pydantic import BaseModel, Field, StrictStr, conint +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictStr +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class CustomUserResponse(BaseModel): """ - A User Object # noqa: E501 - """ - pki_user_id: conint(strict=True, ge=0) = Field(..., alias="pkiUserID", description="The unique ID of the User") - s_user_lastname: StrictStr = Field(..., alias="sUserLastname", description="The last name of the user") - s_user_firstname: StrictStr = Field(..., alias="sUserFirstname", description="The first name of the user") - s_email_address: StrictStr = Field(..., alias="sEmailAddress", description="The email address.") - __properties = ["pkiUserID", "sUserLastname", "sUserFirstname", "sEmailAddress"] + A User Object + """ # noqa: E501 + pki_user_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the User", alias="pkiUserID") + s_user_lastname: StrictStr = Field(description="The last name of the user", alias="sUserLastname") + s_user_firstname: StrictStr = Field(description="The first name of the user", alias="sUserFirstname") + s_email_address: StrictStr = Field(description="The email address.", alias="sEmailAddress") + __properties: ClassVar[List[str]] = ["pkiUserID", "sUserLastname", "sUserFirstname", "sEmailAddress"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> CustomUserResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of CustomUserResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> CustomUserResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of CustomUserResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return CustomUserResponse.parse_obj(obj) + return cls.model_validate(obj) - _obj = CustomUserResponse.parse_obj({ - "pki_user_id": obj.get("pkiUserID"), - "s_user_lastname": obj.get("sUserLastname"), - "s_user_firstname": obj.get("sUserFirstname"), - "s_email_address": obj.get("sEmailAddress") + _obj = cls.model_validate({ + "pkiUserID": obj.get("pkiUserID"), + "sUserLastname": obj.get("sUserLastname"), + "sUserFirstname": obj.get("sUserFirstname"), + "sEmailAddress": obj.get("sEmailAddress") }) return _obj diff --git a/eZmaxApi/models/custom_webhook_response.py b/eZmaxApi/models/custom_webhook_response.py index 360b288d3..5b444bb52 100644 --- a/eZmaxApi/models/custom_webhook_response.py +++ b/eZmaxApi/models/custom_webhook_response.py @@ -19,80 +19,105 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictBool, StrictInt, StrictStr, conint, constr +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, StrictInt, StrictStr +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.field_e_webhook_ezsignevent import FieldEWebhookEzsignevent from eZmaxApi.models.field_e_webhook_managementevent import FieldEWebhookManagementevent from eZmaxApi.models.field_e_webhook_module import FieldEWebhookModule +try: + from typing import Self +except ImportError: + from typing_extensions import Self class CustomWebhookResponse(BaseModel): """ - A custom Webhook object # noqa: E501 - """ - pki_webhook_id: StrictInt = Field(..., alias="pkiWebhookID", description="The unique ID of the Webhook") - s_webhook_description: StrictStr = Field(..., alias="sWebhookDescription", description="The description of the Webhook") - fki_ezsignfoldertype_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiEzsignfoldertypeID", description="The unique ID of the Ezsignfoldertype.") - s_ezsignfoldertype_name_x: Optional[StrictStr] = Field(None, alias="sEzsignfoldertypeNameX", description="The name of the Ezsignfoldertype in the language of the requester") - e_webhook_module: FieldEWebhookModule = Field(..., alias="eWebhookModule") - e_webhook_ezsignevent: Optional[FieldEWebhookEzsignevent] = Field(None, alias="eWebhookEzsignevent") - e_webhook_managementevent: Optional[FieldEWebhookManagementevent] = Field(None, alias="eWebhookManagementevent") - s_webhook_url: StrictStr = Field(..., alias="sWebhookUrl", description="The URL of the Webhook callback") - s_webhook_emailfailed: StrictStr = Field(..., alias="sWebhookEmailfailed", description="The email that will receive the Webhook in case all attempts fail") - b_webhook_isactive: StrictBool = Field(..., alias="bWebhookIsactive", description="Whether the Webhook is active or not") - b_webhook_skipsslvalidation: StrictBool = Field(..., alias="bWebhookSkipsslvalidation", description="Wheter the server's SSL certificate should be validated or not. Not recommended to skip for production use") - pks_customer_code: constr(strict=True, max_length=6, min_length=2) = Field(..., alias="pksCustomerCode", description="The customer code assigned to your account") - b_webhook_test: StrictBool = Field(..., alias="bWebhookTest", description="Wheter the webhook received is a manual test or a real event") - __properties = ["pkiWebhookID", "sWebhookDescription", "fkiEzsignfoldertypeID", "sEzsignfoldertypeNameX", "eWebhookModule", "eWebhookEzsignevent", "eWebhookManagementevent", "sWebhookUrl", "sWebhookEmailfailed", "bWebhookIsactive", "bWebhookSkipsslvalidation", "pksCustomerCode", "bWebhookTest"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + A custom Webhook object + """ # noqa: E501 + pki_webhook_id: StrictInt = Field(description="The unique ID of the Webhook", alias="pkiWebhookID") + s_webhook_description: StrictStr = Field(description="The description of the Webhook", alias="sWebhookDescription") + fki_ezsignfoldertype_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsignfoldertype.", alias="fkiEzsignfoldertypeID") + s_ezsignfoldertype_name_x: Optional[StrictStr] = Field(default=None, description="The name of the Ezsignfoldertype in the language of the requester", alias="sEzsignfoldertypeNameX") + e_webhook_module: FieldEWebhookModule = Field(alias="eWebhookModule") + e_webhook_ezsignevent: Optional[FieldEWebhookEzsignevent] = Field(default=None, alias="eWebhookEzsignevent") + e_webhook_managementevent: Optional[FieldEWebhookManagementevent] = Field(default=None, alias="eWebhookManagementevent") + s_webhook_url: StrictStr = Field(description="The URL of the Webhook callback", alias="sWebhookUrl") + s_webhook_emailfailed: StrictStr = Field(description="The email that will receive the Webhook in case all attempts fail", alias="sWebhookEmailfailed") + s_webhook_apikey: Optional[StrictStr] = Field(default=None, description="The Apikey for the Webhook. This will be hidden if we are not creating or regenerating the Apikey.", alias="sWebhookApikey") + s_webhook_secret: Optional[StrictStr] = Field(default=None, description="The Secret for the Webhook. This will be hidden if we are not creating or regenerating the Apikey.", alias="sWebhookSecret") + b_webhook_isactive: StrictBool = Field(description="Whether the Webhook is active or not", alias="bWebhookIsactive") + b_webhook_issigned: StrictBool = Field(description="Whether the requests will be signed or not", alias="bWebhookIssigned") + b_webhook_skipsslvalidation: StrictBool = Field(description="Wheter the server's SSL certificate should be validated or not. Not recommended to skip for production use", alias="bWebhookSkipsslvalidation") + pks_customer_code: Annotated[str, Field(min_length=2, strict=True, max_length=6)] = Field(description="The customer code assigned to your account", alias="pksCustomerCode") + b_webhook_test: StrictBool = Field(description="Wheter the webhook received is a manual test or a real event", alias="bWebhookTest") + __properties: ClassVar[List[str]] = ["pkiWebhookID", "sWebhookDescription", "fkiEzsignfoldertypeID", "sEzsignfoldertypeNameX", "eWebhookModule", "eWebhookEzsignevent", "eWebhookManagementevent", "sWebhookUrl", "sWebhookEmailfailed", "sWebhookApikey", "sWebhookSecret", "bWebhookIsactive", "bWebhookIssigned", "bWebhookSkipsslvalidation", "pksCustomerCode", "bWebhookTest"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> CustomWebhookResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of CustomWebhookResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> CustomWebhookResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of CustomWebhookResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return CustomWebhookResponse.parse_obj(obj) - - _obj = CustomWebhookResponse.parse_obj({ - "pki_webhook_id": obj.get("pkiWebhookID"), - "s_webhook_description": obj.get("sWebhookDescription"), - "fki_ezsignfoldertype_id": obj.get("fkiEzsignfoldertypeID"), - "s_ezsignfoldertype_name_x": obj.get("sEzsignfoldertypeNameX"), - "e_webhook_module": obj.get("eWebhookModule"), - "e_webhook_ezsignevent": obj.get("eWebhookEzsignevent"), - "e_webhook_managementevent": obj.get("eWebhookManagementevent"), - "s_webhook_url": obj.get("sWebhookUrl"), - "s_webhook_emailfailed": obj.get("sWebhookEmailfailed"), - "b_webhook_isactive": obj.get("bWebhookIsactive"), - "b_webhook_skipsslvalidation": obj.get("bWebhookSkipsslvalidation"), - "pks_customer_code": obj.get("pksCustomerCode"), - "b_webhook_test": obj.get("bWebhookTest") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiWebhookID": obj.get("pkiWebhookID"), + "sWebhookDescription": obj.get("sWebhookDescription"), + "fkiEzsignfoldertypeID": obj.get("fkiEzsignfoldertypeID"), + "sEzsignfoldertypeNameX": obj.get("sEzsignfoldertypeNameX"), + "eWebhookModule": obj.get("eWebhookModule"), + "eWebhookEzsignevent": obj.get("eWebhookEzsignevent"), + "eWebhookManagementevent": obj.get("eWebhookManagementevent"), + "sWebhookUrl": obj.get("sWebhookUrl"), + "sWebhookEmailfailed": obj.get("sWebhookEmailfailed"), + "sWebhookApikey": obj.get("sWebhookApikey"), + "sWebhookSecret": obj.get("sWebhookSecret"), + "bWebhookIsactive": obj.get("bWebhookIsactive"), + "bWebhookIssigned": obj.get("bWebhookIssigned"), + "bWebhookSkipsslvalidation": obj.get("bWebhookSkipsslvalidation"), + "pksCustomerCode": obj.get("pksCustomerCode"), + "bWebhookTest": obj.get("bWebhookTest") }) return _obj diff --git a/eZmaxApi/models/custom_webhooklog_response.py b/eZmaxApi/models/custom_webhooklog_response.py index e502b2cf4..f1cfe78c1 100644 --- a/eZmaxApi/models/custom_webhooklog_response.py +++ b/eZmaxApi/models/custom_webhooklog_response.py @@ -19,55 +19,73 @@ import json - -from pydantic import BaseModel, Field, StrictStr +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictStr +from pydantic import Field +try: + from typing import Self +except ImportError: + from typing_extensions import Self class CustomWebhooklogResponse(BaseModel): """ - A custom Webhooklog object # noqa: E501 - """ - dt_webhooklog_date: StrictStr = Field(..., alias="dtWebhooklogDate", description="The date and time at which the Webhooklog happened.") - t_webhooklog_json: StrictStr = Field(..., alias="tWebhooklogJson", description="The Json containing the Webhook call and return") - __properties = ["dtWebhooklogDate", "tWebhooklogJson"] + A custom Webhooklog object + """ # noqa: E501 + dt_webhooklog_date: StrictStr = Field(description="The date and time at which the Webhooklog happened.", alias="dtWebhooklogDate") + t_webhooklog_json: StrictStr = Field(description="The Json containing the Webhook call and return", alias="tWebhooklogJson") + __properties: ClassVar[List[str]] = ["dtWebhooklogDate", "tWebhooklogJson"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> CustomWebhooklogResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of CustomWebhooklogResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> CustomWebhooklogResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of CustomWebhooklogResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return CustomWebhooklogResponse.parse_obj(obj) + return cls.model_validate(obj) - _obj = CustomWebhooklogResponse.parse_obj({ - "dt_webhooklog_date": obj.get("dtWebhooklogDate"), - "t_webhooklog_json": obj.get("tWebhooklogJson") + _obj = cls.model_validate({ + "dtWebhooklogDate": obj.get("dtWebhooklogDate"), + "tWebhooklogJson": obj.get("tWebhooklogJson") }) return _obj diff --git a/eZmaxApi/models/custom_word_position_occurence_response.py b/eZmaxApi/models/custom_word_position_occurence_response.py index 081edb01b..fa34f962d 100644 --- a/eZmaxApi/models/custom_word_position_occurence_response.py +++ b/eZmaxApi/models/custom_word_position_occurence_response.py @@ -19,57 +19,76 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class CustomWordPositionOccurenceResponse(BaseModel): """ - A Word Position Object # noqa: E501 - """ - i_page: Optional[conint(strict=True, ge=1)] = Field(None, alias="iPage", description="The page where the word occurence was found") - i_x: Optional[conint(strict=True, ge=0)] = Field(None, alias="iX", description="The X coordinate (Horizontal) where the Word occurence was found. Coordinate is calculated at 100dpi (dot per inch).") - i_y: Optional[conint(strict=True, ge=0)] = Field(None, alias="iY", description="The Y coordinate (Vertical) where the Word occurence was found. Coordinate is calculated at 100dpi (dot per inch).") - __properties = ["iPage", "iX", "iY"] + A Word Position Object + """ # noqa: E501 + i_page: Optional[Annotated[int, Field(strict=True, ge=1)]] = Field(default=None, description="The page where the word occurence was found", alias="iPage") + i_x: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The X coordinate (Horizontal) where the Word occurence was found. Coordinate is calculated at 100dpi (dot per inch).", alias="iX") + i_y: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The Y coordinate (Vertical) where the Word occurence was found. Coordinate is calculated at 100dpi (dot per inch).", alias="iY") + __properties: ClassVar[List[str]] = ["iPage", "iX", "iY"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> CustomWordPositionOccurenceResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of CustomWordPositionOccurenceResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> CustomWordPositionOccurenceResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of CustomWordPositionOccurenceResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return CustomWordPositionOccurenceResponse.parse_obj(obj) + return cls.model_validate(obj) - _obj = CustomWordPositionOccurenceResponse.parse_obj({ - "i_page": obj.get("iPage"), - "i_x": obj.get("iX"), - "i_y": obj.get("iY") + _obj = cls.model_validate({ + "iPage": obj.get("iPage"), + "iX": obj.get("iX"), + "iY": obj.get("iY") }) return _obj diff --git a/eZmaxApi/models/custom_word_position_word_response.py b/eZmaxApi/models/custom_word_position_word_response.py index d84b4ce48..a589ae39e 100644 --- a/eZmaxApi/models/custom_word_position_word_response.py +++ b/eZmaxApi/models/custom_word_position_word_response.py @@ -19,42 +19,60 @@ import json -from typing import List -from pydantic import BaseModel, Field, StrictStr, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictStr +from pydantic import Field from eZmaxApi.models.custom_word_position_occurence_response import CustomWordPositionOccurenceResponse +try: + from typing import Self +except ImportError: + from typing_extensions import Self class CustomWordPositionWordResponse(BaseModel): """ - A Word Position Object # noqa: E501 - """ - s_word: StrictStr = Field(..., alias="sWord", description="The searched word") - a_obj_word_position_occurence: conlist(CustomWordPositionOccurenceResponse) = Field(..., alias="a_objWordPositionOccurence", description="The found occurences for the seached word") - __properties = ["sWord", "a_objWordPositionOccurence"] + A Word Position Object + """ # noqa: E501 + s_word: StrictStr = Field(description="The searched word", alias="sWord") + a_obj_word_position_occurence: List[CustomWordPositionOccurenceResponse] = Field(description="The found occurences for the seached word", alias="a_objWordPositionOccurence") + __properties: ClassVar[List[str]] = ["sWord", "a_objWordPositionOccurence"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> CustomWordPositionWordResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of CustomWordPositionWordResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_word_position_occurence (list) _items = [] if self.a_obj_word_position_occurence: @@ -65,17 +83,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> CustomWordPositionWordResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of CustomWordPositionWordResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return CustomWordPositionWordResponse.parse_obj(obj) + return cls.model_validate(obj) - _obj = CustomWordPositionWordResponse.parse_obj({ - "s_word": obj.get("sWord"), - "a_obj_word_position_occurence": [CustomWordPositionOccurenceResponse.from_dict(_item) for _item in obj.get("a_objWordPositionOccurence")] if obj.get("a_objWordPositionOccurence") is not None else None + _obj = cls.model_validate({ + "sWord": obj.get("sWord"), + "a_objWordPositionOccurence": [CustomWordPositionOccurenceResponse.from_dict(_item) for _item in obj.get("a_objWordPositionOccurence")] if obj.get("a_objWordPositionOccurence") is not None else None }) return _obj diff --git a/eZmaxApi/models/department_autocomplete_element_response.py b/eZmaxApi/models/department_autocomplete_element_response.py index 404cb29eb..0e202d4cf 100644 --- a/eZmaxApi/models/department_autocomplete_element_response.py +++ b/eZmaxApi/models/department_autocomplete_element_response.py @@ -19,59 +19,78 @@ import json - -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictBool, StrictStr +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class DepartmentAutocompleteElementResponse(BaseModel): """ - A Department AutocompleteElement Response # noqa: E501 - """ - s_company_name_x: StrictStr = Field(..., alias="sCompanyNameX", description="The Name of the Company in the language of the requester") - s_department_name_x: StrictStr = Field(..., alias="sDepartmentNameX", description="The Name of the Department in the language of the requester") - pki_department_id: conint(strict=True, ge=0) = Field(..., alias="pkiDepartmentID", description="The unique ID of the Department") - b_department_isactive: StrictBool = Field(..., alias="bDepartmentIsactive", description="Whether the Department is active or not") - __properties = ["sCompanyNameX", "sDepartmentNameX", "pkiDepartmentID", "bDepartmentIsactive"] + A Department AutocompleteElement Response + """ # noqa: E501 + s_company_name_x: StrictStr = Field(description="The Name of the Company in the language of the requester", alias="sCompanyNameX") + s_department_name_x: StrictStr = Field(description="The Name of the Department in the language of the requester", alias="sDepartmentNameX") + pki_department_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Department", alias="pkiDepartmentID") + b_department_isactive: StrictBool = Field(description="Whether the Department is active or not", alias="bDepartmentIsactive") + __properties: ClassVar[List[str]] = ["sCompanyNameX", "sDepartmentNameX", "pkiDepartmentID", "bDepartmentIsactive"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> DepartmentAutocompleteElementResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of DepartmentAutocompleteElementResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> DepartmentAutocompleteElementResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of DepartmentAutocompleteElementResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return DepartmentAutocompleteElementResponse.parse_obj(obj) + return cls.model_validate(obj) - _obj = DepartmentAutocompleteElementResponse.parse_obj({ - "s_company_name_x": obj.get("sCompanyNameX"), - "s_department_name_x": obj.get("sDepartmentNameX"), - "pki_department_id": obj.get("pkiDepartmentID"), - "b_department_isactive": obj.get("bDepartmentIsactive") + _obj = cls.model_validate({ + "sCompanyNameX": obj.get("sCompanyNameX"), + "sDepartmentNameX": obj.get("sDepartmentNameX"), + "pkiDepartmentID": obj.get("pkiDepartmentID"), + "bDepartmentIsactive": obj.get("bDepartmentIsactive") }) return _obj diff --git a/eZmaxApi/models/department_get_autocomplete_v2_response.py b/eZmaxApi/models/department_get_autocomplete_v2_response.py index 4e2c3e2ec..5bfba5827 100644 --- a/eZmaxApi/models/department_get_autocomplete_v2_response.py +++ b/eZmaxApi/models/department_get_autocomplete_v2_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.department_get_autocomplete_v2_response_m_payload import DepartmentGetAutocompleteV2ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class DepartmentGetAutocompleteV2Response(BaseModel): """ - Response for GET /2/object/department/getAutocomplete # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: DepartmentGetAutocompleteV2ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /2/object/department/getAutocomplete + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: DepartmentGetAutocompleteV2ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> DepartmentGetAutocompleteV2Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of DepartmentGetAutocompleteV2Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> DepartmentGetAutocompleteV2Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of DepartmentGetAutocompleteV2Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return DepartmentGetAutocompleteV2Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = DepartmentGetAutocompleteV2Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": DepartmentGetAutocompleteV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": DepartmentGetAutocompleteV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/department_get_autocomplete_v2_response_m_payload.py b/eZmaxApi/models/department_get_autocomplete_v2_response_m_payload.py index b5049bd67..1913a2f0d 100644 --- a/eZmaxApi/models/department_get_autocomplete_v2_response_m_payload.py +++ b/eZmaxApi/models/department_get_autocomplete_v2_response_m_payload.py @@ -19,41 +19,59 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.department_autocomplete_element_response import DepartmentAutocompleteElementResponse +try: + from typing import Self +except ImportError: + from typing_extensions import Self class DepartmentGetAutocompleteV2ResponseMPayload(BaseModel): """ - Payload for POST /2/object/department/getAutocomplete # noqa: E501 - """ - a_obj_department: conlist(DepartmentAutocompleteElementResponse) = Field(..., alias="a_objDepartment", description="An array of Department autocomplete element response.") - __properties = ["a_objDepartment"] + Payload for POST /2/object/department/getAutocomplete + """ # noqa: E501 + a_obj_department: List[DepartmentAutocompleteElementResponse] = Field(description="An array of Department autocomplete element response.", alias="a_objDepartment") + __properties: ClassVar[List[str]] = ["a_objDepartment"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> DepartmentGetAutocompleteV2ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of DepartmentGetAutocompleteV2ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_department (list) _items = [] if self.a_obj_department: @@ -64,16 +82,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> DepartmentGetAutocompleteV2ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of DepartmentGetAutocompleteV2ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return DepartmentGetAutocompleteV2ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = DepartmentGetAutocompleteV2ResponseMPayload.parse_obj({ - "a_obj_department": [DepartmentAutocompleteElementResponse.from_dict(_item) for _item in obj.get("a_objDepartment")] if obj.get("a_objDepartment") is not None else None + _obj = cls.model_validate({ + "a_objDepartment": [DepartmentAutocompleteElementResponse.from_dict(_item) for _item in obj.get("a_objDepartment")] if obj.get("a_objDepartment") is not None else None }) return _obj diff --git a/eZmaxApi/models/electronicfundstransfer_get_communication_list_v1_response.py b/eZmaxApi/models/electronicfundstransfer_get_communication_list_v1_response.py index ad623fa41..065f46352 100644 --- a/eZmaxApi/models/electronicfundstransfer_get_communication_list_v1_response.py +++ b/eZmaxApi/models/electronicfundstransfer_get_communication_list_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload_get_list import CommonResponseObjDebugPayloadGetList from eZmaxApi.models.electronicfundstransfer_get_communication_list_v1_response_m_payload import ElectronicfundstransferGetCommunicationListV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class ElectronicfundstransferGetCommunicationListV1Response(BaseModel): """ - Response for GET /1/object/electronicfundstransfer/{pkiElectronicfundstransferID}/getCommunicationList # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayloadGetList = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: ElectronicfundstransferGetCommunicationListV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /1/object/electronicfundstransfer/{pkiElectronicfundstransferID}/getCommunicationList + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayloadGetList = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: ElectronicfundstransferGetCommunicationListV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> ElectronicfundstransferGetCommunicationListV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of ElectronicfundstransferGetCommunicationListV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> ElectronicfundstransferGetCommunicationListV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of ElectronicfundstransferGetCommunicationListV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return ElectronicfundstransferGetCommunicationListV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = ElectronicfundstransferGetCommunicationListV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayloadGetList.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": ElectronicfundstransferGetCommunicationListV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayloadGetList.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": ElectronicfundstransferGetCommunicationListV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/electronicfundstransfer_get_communication_list_v1_response_m_payload.py b/eZmaxApi/models/electronicfundstransfer_get_communication_list_v1_response_m_payload.py index f1eb882f7..9dd2c2875 100644 --- a/eZmaxApi/models/electronicfundstransfer_get_communication_list_v1_response_m_payload.py +++ b/eZmaxApi/models/electronicfundstransfer_get_communication_list_v1_response_m_payload.py @@ -19,41 +19,59 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.custom_communication_list_element_response import CustomCommunicationListElementResponse +try: + from typing import Self +except ImportError: + from typing_extensions import Self class ElectronicfundstransferGetCommunicationListV1ResponseMPayload(BaseModel): """ - Response for GET /1/object/electronicfundstransfer/{pkiElectronicfundstransferID}/getCommunicationList # noqa: E501 - """ - a_obj_communication: conlist(CustomCommunicationListElementResponse) = Field(..., alias="a_objCommunication") - __properties = ["a_objCommunication"] + Response for GET /1/object/electronicfundstransfer/{pkiElectronicfundstransferID}/getCommunicationList + """ # noqa: E501 + a_obj_communication: List[CustomCommunicationListElementResponse] = Field(alias="a_objCommunication") + __properties: ClassVar[List[str]] = ["a_objCommunication"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> ElectronicfundstransferGetCommunicationListV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of ElectronicfundstransferGetCommunicationListV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_communication (list) _items = [] if self.a_obj_communication: @@ -64,16 +82,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> ElectronicfundstransferGetCommunicationListV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of ElectronicfundstransferGetCommunicationListV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return ElectronicfundstransferGetCommunicationListV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = ElectronicfundstransferGetCommunicationListV1ResponseMPayload.parse_obj({ - "a_obj_communication": [CustomCommunicationListElementResponse.from_dict(_item) for _item in obj.get("a_objCommunication")] if obj.get("a_objCommunication") is not None else None + _obj = cls.model_validate({ + "a_objCommunication": [CustomCommunicationListElementResponse.from_dict(_item) for _item in obj.get("a_objCommunication")] if obj.get("a_objCommunication") is not None else None }) return _obj diff --git a/eZmaxApi/models/email_request.py b/eZmaxApi/models/email_request.py index 51c8211d1..da579a502 100644 --- a/eZmaxApi/models/email_request.py +++ b/eZmaxApi/models/email_request.py @@ -19,57 +19,76 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictStr, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictStr +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EmailRequest(BaseModel): """ - An Email Object # noqa: E501 - """ - pki_email_id: Optional[conint(strict=True, le=16777215, ge=1)] = Field(None, alias="pkiEmailID", description="The unique ID of the Email") - fki_emailtype_id: conint(strict=True, ge=0) = Field(..., alias="fkiEmailtypeID", description="The unique ID of the Emailtype. Valid values: |Value|Description| |-|-| |1|Office| |2|Home|") - s_email_address: StrictStr = Field(..., alias="sEmailAddress", description="The email address.") - __properties = ["pkiEmailID", "fkiEmailtypeID", "sEmailAddress"] + An Email Object + """ # noqa: E501 + pki_email_id: Optional[Annotated[int, Field(le=16777215, strict=True, ge=1)]] = Field(default=None, description="The unique ID of the Email", alias="pkiEmailID") + fki_emailtype_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Emailtype. Valid values: |Value|Description| |-|-| |1|Office| |2|Home|", alias="fkiEmailtypeID") + s_email_address: StrictStr = Field(description="The email address.", alias="sEmailAddress") + __properties: ClassVar[List[str]] = ["pkiEmailID", "fkiEmailtypeID", "sEmailAddress"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EmailRequest: + def from_json(cls, json_str: str) -> Self: """Create an instance of EmailRequest from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EmailRequest: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EmailRequest from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EmailRequest.parse_obj(obj) + return cls.model_validate(obj) - _obj = EmailRequest.parse_obj({ - "pki_email_id": obj.get("pkiEmailID"), - "fki_emailtype_id": obj.get("fkiEmailtypeID"), - "s_email_address": obj.get("sEmailAddress") + _obj = cls.model_validate({ + "pkiEmailID": obj.get("pkiEmailID"), + "fkiEmailtypeID": obj.get("fkiEmailtypeID"), + "sEmailAddress": obj.get("sEmailAddress") }) return _obj diff --git a/eZmaxApi/models/email_request_compound.py b/eZmaxApi/models/email_request_compound.py index 315f5bcd4..3f8ef3176 100644 --- a/eZmaxApi/models/email_request_compound.py +++ b/eZmaxApi/models/email_request_compound.py @@ -19,57 +19,76 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictStr, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictStr +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EmailRequestCompound(BaseModel): """ - An Email Object and children to create a complete structure # noqa: E501 - """ - pki_email_id: Optional[conint(strict=True, le=16777215, ge=1)] = Field(None, alias="pkiEmailID", description="The unique ID of the Email") - fki_emailtype_id: conint(strict=True, ge=0) = Field(..., alias="fkiEmailtypeID", description="The unique ID of the Emailtype. Valid values: |Value|Description| |-|-| |1|Office| |2|Home|") - s_email_address: StrictStr = Field(..., alias="sEmailAddress", description="The email address.") - __properties = ["pkiEmailID", "fkiEmailtypeID", "sEmailAddress"] + An Email Object and children to create a complete structure + """ # noqa: E501 + pki_email_id: Optional[Annotated[int, Field(le=16777215, strict=True, ge=1)]] = Field(default=None, description="The unique ID of the Email", alias="pkiEmailID") + fki_emailtype_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Emailtype. Valid values: |Value|Description| |-|-| |1|Office| |2|Home|", alias="fkiEmailtypeID") + s_email_address: StrictStr = Field(description="The email address.", alias="sEmailAddress") + __properties: ClassVar[List[str]] = ["pkiEmailID", "fkiEmailtypeID", "sEmailAddress"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EmailRequestCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of EmailRequestCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EmailRequestCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EmailRequestCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EmailRequestCompound.parse_obj(obj) + return cls.model_validate(obj) - _obj = EmailRequestCompound.parse_obj({ - "pki_email_id": obj.get("pkiEmailID"), - "fki_emailtype_id": obj.get("fkiEmailtypeID"), - "s_email_address": obj.get("sEmailAddress") + _obj = cls.model_validate({ + "pkiEmailID": obj.get("pkiEmailID"), + "fkiEmailtypeID": obj.get("fkiEmailtypeID"), + "sEmailAddress": obj.get("sEmailAddress") }) return _obj diff --git a/eZmaxApi/models/email_response.py b/eZmaxApi/models/email_response.py index b09361db4..d24377135 100644 --- a/eZmaxApi/models/email_response.py +++ b/eZmaxApi/models/email_response.py @@ -19,57 +19,76 @@ import json - -from pydantic import BaseModel, Field, StrictStr, conint +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictStr +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EmailResponse(BaseModel): """ - An Email Object # noqa: E501 - """ - pki_email_id: conint(strict=True, le=16777215, ge=1) = Field(..., alias="pkiEmailID", description="The unique ID of the Email") - fki_emailtype_id: conint(strict=True, ge=0) = Field(..., alias="fkiEmailtypeID", description="The unique ID of the Emailtype. Valid values: |Value|Description| |-|-| |1|Office| |2|Home|") - s_email_address: StrictStr = Field(..., alias="sEmailAddress", description="The email address.") - __properties = ["pkiEmailID", "fkiEmailtypeID", "sEmailAddress"] + An Email Object + """ # noqa: E501 + pki_email_id: Annotated[int, Field(le=16777215, strict=True, ge=1)] = Field(description="The unique ID of the Email", alias="pkiEmailID") + fki_emailtype_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Emailtype. Valid values: |Value|Description| |-|-| |1|Office| |2|Home|", alias="fkiEmailtypeID") + s_email_address: StrictStr = Field(description="The email address.", alias="sEmailAddress") + __properties: ClassVar[List[str]] = ["pkiEmailID", "fkiEmailtypeID", "sEmailAddress"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EmailResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of EmailResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EmailResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EmailResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EmailResponse.parse_obj(obj) + return cls.model_validate(obj) - _obj = EmailResponse.parse_obj({ - "pki_email_id": obj.get("pkiEmailID"), - "fki_emailtype_id": obj.get("fkiEmailtypeID"), - "s_email_address": obj.get("sEmailAddress") + _obj = cls.model_validate({ + "pkiEmailID": obj.get("pkiEmailID"), + "fkiEmailtypeID": obj.get("fkiEmailtypeID"), + "sEmailAddress": obj.get("sEmailAddress") }) return _obj diff --git a/eZmaxApi/models/email_response_compound.py b/eZmaxApi/models/email_response_compound.py index 358d7ca24..9098db67a 100644 --- a/eZmaxApi/models/email_response_compound.py +++ b/eZmaxApi/models/email_response_compound.py @@ -19,57 +19,76 @@ import json - -from pydantic import BaseModel, Field, StrictStr, conint +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictStr +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EmailResponseCompound(BaseModel): """ - An Email Object and children to create a complete structure # noqa: E501 - """ - pki_email_id: conint(strict=True, le=16777215, ge=1) = Field(..., alias="pkiEmailID", description="The unique ID of the Email") - fki_emailtype_id: conint(strict=True, ge=0) = Field(..., alias="fkiEmailtypeID", description="The unique ID of the Emailtype. Valid values: |Value|Description| |-|-| |1|Office| |2|Home|") - s_email_address: StrictStr = Field(..., alias="sEmailAddress", description="The email address.") - __properties = ["pkiEmailID", "fkiEmailtypeID", "sEmailAddress"] + An Email Object and children to create a complete structure + """ # noqa: E501 + pki_email_id: Annotated[int, Field(le=16777215, strict=True, ge=1)] = Field(description="The unique ID of the Email", alias="pkiEmailID") + fki_emailtype_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Emailtype. Valid values: |Value|Description| |-|-| |1|Office| |2|Home|", alias="fkiEmailtypeID") + s_email_address: StrictStr = Field(description="The email address.", alias="sEmailAddress") + __properties: ClassVar[List[str]] = ["pkiEmailID", "fkiEmailtypeID", "sEmailAddress"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EmailResponseCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of EmailResponseCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EmailResponseCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EmailResponseCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EmailResponseCompound.parse_obj(obj) + return cls.model_validate(obj) - _obj = EmailResponseCompound.parse_obj({ - "pki_email_id": obj.get("pkiEmailID"), - "fki_emailtype_id": obj.get("fkiEmailtypeID"), - "s_email_address": obj.get("sEmailAddress") + _obj = cls.model_validate({ + "pkiEmailID": obj.get("pkiEmailID"), + "fkiEmailtypeID": obj.get("fkiEmailtypeID"), + "sEmailAddress": obj.get("sEmailAddress") }) return _obj diff --git a/eZmaxApi/models/emailtype_autocomplete_element_response.py b/eZmaxApi/models/emailtype_autocomplete_element_response.py index 42372d1e6..a90d6fd3e 100644 --- a/eZmaxApi/models/emailtype_autocomplete_element_response.py +++ b/eZmaxApi/models/emailtype_autocomplete_element_response.py @@ -19,64 +19,83 @@ import json - -from pydantic import BaseModel, Field, StrictBool, conint, constr, validator +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictBool, field_validator +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EmailtypeAutocompleteElementResponse(BaseModel): """ - A Emailtype AutocompleteElement Response # noqa: E501 - """ - pki_emailtype_id: conint(strict=True, ge=0) = Field(..., alias="pkiEmailtypeID", description="The unique ID of the Emailtype. Valid values: |Value|Description| |-|-| |1|Office| |2|Home|") - s_emailtype_name_x: constr(strict=True) = Field(..., alias="sEmailtypeNameX", description="The name of the Emailtype in the language of the requester") - b_emailtype_isactive: StrictBool = Field(..., alias="bEmailtypeIsactive", description="Whether the Emailtype is active or not") - __properties = ["pkiEmailtypeID", "sEmailtypeNameX", "bEmailtypeIsactive"] - - @validator('s_emailtype_name_x') + A Emailtype AutocompleteElement Response + """ # noqa: E501 + pki_emailtype_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Emailtype. Valid values: |Value|Description| |-|-| |1|Office| |2|Home|", alias="pkiEmailtypeID") + s_emailtype_name_x: Annotated[str, Field(strict=True)] = Field(description="The name of the Emailtype in the language of the requester", alias="sEmailtypeNameX") + b_emailtype_isactive: StrictBool = Field(description="Whether the Emailtype is active or not", alias="bEmailtypeIsactive") + __properties: ClassVar[List[str]] = ["pkiEmailtypeID", "sEmailtypeNameX", "bEmailtypeIsactive"] + + @field_validator('s_emailtype_name_x') def s_emailtype_name_x_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^.{0,15}$", value): raise ValueError(r"must validate the regular expression /^.{0,15}$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EmailtypeAutocompleteElementResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of EmailtypeAutocompleteElementResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EmailtypeAutocompleteElementResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EmailtypeAutocompleteElementResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EmailtypeAutocompleteElementResponse.parse_obj(obj) + return cls.model_validate(obj) - _obj = EmailtypeAutocompleteElementResponse.parse_obj({ - "pki_emailtype_id": obj.get("pkiEmailtypeID"), - "s_emailtype_name_x": obj.get("sEmailtypeNameX"), - "b_emailtype_isactive": obj.get("bEmailtypeIsactive") + _obj = cls.model_validate({ + "pkiEmailtypeID": obj.get("pkiEmailtypeID"), + "sEmailtypeNameX": obj.get("sEmailtypeNameX"), + "bEmailtypeIsactive": obj.get("bEmailtypeIsactive") }) return _obj diff --git a/eZmaxApi/models/emailtype_get_autocomplete_v2_response.py b/eZmaxApi/models/emailtype_get_autocomplete_v2_response.py index dd4750a1a..d614d30e8 100644 --- a/eZmaxApi/models/emailtype_get_autocomplete_v2_response.py +++ b/eZmaxApi/models/emailtype_get_autocomplete_v2_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.emailtype_get_autocomplete_v2_response_m_payload import EmailtypeGetAutocompleteV2ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EmailtypeGetAutocompleteV2Response(BaseModel): """ - Response for GET /2/object/emailtype/getAutocomplete # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EmailtypeGetAutocompleteV2ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /2/object/emailtype/getAutocomplete + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EmailtypeGetAutocompleteV2ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EmailtypeGetAutocompleteV2Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EmailtypeGetAutocompleteV2Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EmailtypeGetAutocompleteV2Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EmailtypeGetAutocompleteV2Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EmailtypeGetAutocompleteV2Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EmailtypeGetAutocompleteV2Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EmailtypeGetAutocompleteV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EmailtypeGetAutocompleteV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/emailtype_get_autocomplete_v2_response_m_payload.py b/eZmaxApi/models/emailtype_get_autocomplete_v2_response_m_payload.py index ef57bb4b9..c8e96bc1b 100644 --- a/eZmaxApi/models/emailtype_get_autocomplete_v2_response_m_payload.py +++ b/eZmaxApi/models/emailtype_get_autocomplete_v2_response_m_payload.py @@ -19,41 +19,59 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.emailtype_autocomplete_element_response import EmailtypeAutocompleteElementResponse +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EmailtypeGetAutocompleteV2ResponseMPayload(BaseModel): """ - Payload for POST /2/object/emailtype/getAutocomplete # noqa: E501 - """ - a_obj_emailtype: conlist(EmailtypeAutocompleteElementResponse) = Field(..., alias="a_objEmailtype", description="An array of Emailtype autocomplete element response.") - __properties = ["a_objEmailtype"] + Payload for POST /2/object/emailtype/getAutocomplete + """ # noqa: E501 + a_obj_emailtype: List[EmailtypeAutocompleteElementResponse] = Field(description="An array of Emailtype autocomplete element response.", alias="a_objEmailtype") + __properties: ClassVar[List[str]] = ["a_objEmailtype"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EmailtypeGetAutocompleteV2ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EmailtypeGetAutocompleteV2ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_emailtype (list) _items = [] if self.a_obj_emailtype: @@ -64,16 +82,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EmailtypeGetAutocompleteV2ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EmailtypeGetAutocompleteV2ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EmailtypeGetAutocompleteV2ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = EmailtypeGetAutocompleteV2ResponseMPayload.parse_obj({ - "a_obj_emailtype": [EmailtypeAutocompleteElementResponse.from_dict(_item) for _item in obj.get("a_objEmailtype")] if obj.get("a_objEmailtype") is not None else None + _obj = cls.model_validate({ + "a_objEmailtype": [EmailtypeAutocompleteElementResponse.from_dict(_item) for _item in obj.get("a_objEmailtype")] if obj.get("a_objEmailtype") is not None else None }) return _obj diff --git a/eZmaxApi/models/enum_fontunderline.py b/eZmaxApi/models/enum_fontunderline.py index ae7440552..480b2cfeb 100644 --- a/eZmaxApi/models/enum_fontunderline.py +++ b/eZmaxApi/models/enum_fontunderline.py @@ -13,13 +13,18 @@ """ # noqa: E501 +from __future__ import annotations import json import pprint import re # noqa: F401 -from aenum import Enum, no_arg +from enum import Enum +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EnumFontunderline(str, Enum): @@ -35,8 +40,8 @@ class EnumFontunderline(str, Enum): DOUBLE = 'Double' @classmethod - def from_json(cls, json_str: str) -> EnumFontunderline: + def from_json(cls, json_str: str) -> Self: """Create an instance of EnumFontunderline from a JSON string""" - return EnumFontunderline(json.loads(json_str)) + return cls(json.loads(json_str)) diff --git a/eZmaxApi/models/enum_fontweight.py b/eZmaxApi/models/enum_fontweight.py index abc9a93a1..6ffa9f66e 100644 --- a/eZmaxApi/models/enum_fontweight.py +++ b/eZmaxApi/models/enum_fontweight.py @@ -13,13 +13,18 @@ """ # noqa: E501 +from __future__ import annotations import json import pprint import re # noqa: F401 -from aenum import Enum, no_arg +from enum import Enum +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EnumFontweight(str, Enum): @@ -34,8 +39,8 @@ class EnumFontweight(str, Enum): BOLD = 'Bold' @classmethod - def from_json(cls, json_str: str) -> EnumFontweight: + def from_json(cls, json_str: str) -> Self: """Create an instance of EnumFontweight from a JSON string""" - return EnumFontweight(json.loads(json_str)) + return cls(json.loads(json_str)) diff --git a/eZmaxApi/models/enum_horizontalalignment.py b/eZmaxApi/models/enum_horizontalalignment.py index 36c3ed877..222ecace6 100644 --- a/eZmaxApi/models/enum_horizontalalignment.py +++ b/eZmaxApi/models/enum_horizontalalignment.py @@ -13,13 +13,18 @@ """ # noqa: E501 +from __future__ import annotations import json import pprint import re # noqa: F401 -from aenum import Enum, no_arg +from enum import Enum +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EnumHorizontalalignment(str, Enum): @@ -35,8 +40,8 @@ class EnumHorizontalalignment(str, Enum): RIGHT = 'Right' @classmethod - def from_json(cls, json_str: str) -> EnumHorizontalalignment: + def from_json(cls, json_str: str) -> Self: """Create an instance of EnumHorizontalalignment from a JSON string""" - return EnumHorizontalalignment(json.loads(json_str)) + return cls(json.loads(json_str)) diff --git a/eZmaxApi/models/enum_textvalidation.py b/eZmaxApi/models/enum_textvalidation.py index f15e8df31..9a316b271 100644 --- a/eZmaxApi/models/enum_textvalidation.py +++ b/eZmaxApi/models/enum_textvalidation.py @@ -13,13 +13,18 @@ """ # noqa: E501 +from __future__ import annotations import json import pprint import re # noqa: F401 -from aenum import Enum, no_arg +from enum import Enum +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EnumTextvalidation(str, Enum): @@ -45,8 +50,8 @@ class EnumTextvalidation(str, Enum): CUSTOM = 'Custom' @classmethod - def from_json(cls, json_str: str) -> EnumTextvalidation: + def from_json(cls, json_str: str) -> Self: """Create an instance of EnumTextvalidation from a JSON string""" - return EnumTextvalidation(json.loads(json_str)) + return cls(json.loads(json_str)) diff --git a/eZmaxApi/models/enum_verticalalignment.py b/eZmaxApi/models/enum_verticalalignment.py index 302eded40..e2c26c19d 100644 --- a/eZmaxApi/models/enum_verticalalignment.py +++ b/eZmaxApi/models/enum_verticalalignment.py @@ -13,13 +13,18 @@ """ # noqa: E501 +from __future__ import annotations import json import pprint import re # noqa: F401 -from aenum import Enum, no_arg +from enum import Enum +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EnumVerticalalignment(str, Enum): @@ -35,8 +40,8 @@ class EnumVerticalalignment(str, Enum): TOP = 'Top' @classmethod - def from_json(cls, json_str: str) -> EnumVerticalalignment: + def from_json(cls, json_str: str) -> Self: """Create an instance of EnumVerticalalignment from a JSON string""" - return EnumVerticalalignment(json.loads(json_str)) + return cls(json.loads(json_str)) diff --git a/eZmaxApi/models/ezmaxinvoicing_autocomplete_element_response.py b/eZmaxApi/models/ezmaxinvoicing_autocomplete_element_response.py index 3a2da7c2f..e88b9e20b 100644 --- a/eZmaxApi/models/ezmaxinvoicing_autocomplete_element_response.py +++ b/eZmaxApi/models/ezmaxinvoicing_autocomplete_element_response.py @@ -19,57 +19,76 @@ import json - -from pydantic import BaseModel, Field, StrictBool, conint, constr +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictBool +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzmaxinvoicingAutocompleteElementResponse(BaseModel): """ - A Ezmaxinvoicing AutocompleteElement Response # noqa: E501 - """ - yyyymm_ezmaxinvoicing: constr(strict=True, max_length=7) = Field(..., alias="yyyymmEzmaxinvoicing", description="The YYYYMM period of the Ezmaxinvoicing") - pki_ezmaxinvoicing_id: conint(strict=True, ge=0) = Field(..., alias="pkiEzmaxinvoicingID", description="The unique ID of the Ezmaxinvoicing") - b_ezmaxinvoicing_isactive: StrictBool = Field(..., alias="bEzmaxinvoicingIsactive", description="Whether the Ezmaxinvoicing is active or not") - __properties = ["yyyymmEzmaxinvoicing", "pkiEzmaxinvoicingID", "bEzmaxinvoicingIsactive"] + A Ezmaxinvoicing AutocompleteElement Response + """ # noqa: E501 + yyyymm_ezmaxinvoicing: Annotated[str, Field(strict=True, max_length=7)] = Field(description="The YYYYMM period of the Ezmaxinvoicing", alias="yyyymmEzmaxinvoicing") + pki_ezmaxinvoicing_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezmaxinvoicing", alias="pkiEzmaxinvoicingID") + b_ezmaxinvoicing_isactive: StrictBool = Field(description="Whether the Ezmaxinvoicing is active or not", alias="bEzmaxinvoicingIsactive") + __properties: ClassVar[List[str]] = ["yyyymmEzmaxinvoicing", "pkiEzmaxinvoicingID", "bEzmaxinvoicingIsactive"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzmaxinvoicingAutocompleteElementResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzmaxinvoicingAutocompleteElementResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzmaxinvoicingAutocompleteElementResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzmaxinvoicingAutocompleteElementResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzmaxinvoicingAutocompleteElementResponse.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzmaxinvoicingAutocompleteElementResponse.parse_obj({ - "yyyymm_ezmaxinvoicing": obj.get("yyyymmEzmaxinvoicing"), - "pki_ezmaxinvoicing_id": obj.get("pkiEzmaxinvoicingID"), - "b_ezmaxinvoicing_isactive": obj.get("bEzmaxinvoicingIsactive") + _obj = cls.model_validate({ + "yyyymmEzmaxinvoicing": obj.get("yyyymmEzmaxinvoicing"), + "pkiEzmaxinvoicingID": obj.get("pkiEzmaxinvoicingID"), + "bEzmaxinvoicingIsactive": obj.get("bEzmaxinvoicingIsactive") }) return _obj diff --git a/eZmaxApi/models/ezmaxinvoicing_get_autocomplete_v2_response.py b/eZmaxApi/models/ezmaxinvoicing_get_autocomplete_v2_response.py index 9e16e69e6..e6ba0e955 100644 --- a/eZmaxApi/models/ezmaxinvoicing_get_autocomplete_v2_response.py +++ b/eZmaxApi/models/ezmaxinvoicing_get_autocomplete_v2_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.ezmaxinvoicing_get_autocomplete_v2_response_m_payload import EzmaxinvoicingGetAutocompleteV2ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzmaxinvoicingGetAutocompleteV2Response(BaseModel): """ - Response for GET /2/object/ezmaxinvoicing/getAutocomplete # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzmaxinvoicingGetAutocompleteV2ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /2/object/ezmaxinvoicing/getAutocomplete + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzmaxinvoicingGetAutocompleteV2ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzmaxinvoicingGetAutocompleteV2Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzmaxinvoicingGetAutocompleteV2Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzmaxinvoicingGetAutocompleteV2Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzmaxinvoicingGetAutocompleteV2Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzmaxinvoicingGetAutocompleteV2Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzmaxinvoicingGetAutocompleteV2Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzmaxinvoicingGetAutocompleteV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzmaxinvoicingGetAutocompleteV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezmaxinvoicing_get_autocomplete_v2_response_m_payload.py b/eZmaxApi/models/ezmaxinvoicing_get_autocomplete_v2_response_m_payload.py index 0e62f7fd8..1f6c13a61 100644 --- a/eZmaxApi/models/ezmaxinvoicing_get_autocomplete_v2_response_m_payload.py +++ b/eZmaxApi/models/ezmaxinvoicing_get_autocomplete_v2_response_m_payload.py @@ -19,41 +19,59 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.ezmaxinvoicing_autocomplete_element_response import EzmaxinvoicingAutocompleteElementResponse +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzmaxinvoicingGetAutocompleteV2ResponseMPayload(BaseModel): """ - Payload for POST /2/object/ezmaxinvoicing/getAutocomplete # noqa: E501 - """ - a_obj_ezmaxinvoicing: conlist(EzmaxinvoicingAutocompleteElementResponse) = Field(..., alias="a_objEzmaxinvoicing", description="An array of Ezmaxinvoicing autocomplete element response.") - __properties = ["a_objEzmaxinvoicing"] + Payload for POST /2/object/ezmaxinvoicing/getAutocomplete + """ # noqa: E501 + a_obj_ezmaxinvoicing: List[EzmaxinvoicingAutocompleteElementResponse] = Field(description="An array of Ezmaxinvoicing autocomplete element response.", alias="a_objEzmaxinvoicing") + __properties: ClassVar[List[str]] = ["a_objEzmaxinvoicing"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzmaxinvoicingGetAutocompleteV2ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzmaxinvoicingGetAutocompleteV2ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_ezmaxinvoicing (list) _items = [] if self.a_obj_ezmaxinvoicing: @@ -64,16 +82,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzmaxinvoicingGetAutocompleteV2ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzmaxinvoicingGetAutocompleteV2ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzmaxinvoicingGetAutocompleteV2ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzmaxinvoicingGetAutocompleteV2ResponseMPayload.parse_obj({ - "a_obj_ezmaxinvoicing": [EzmaxinvoicingAutocompleteElementResponse.from_dict(_item) for _item in obj.get("a_objEzmaxinvoicing")] if obj.get("a_objEzmaxinvoicing") is not None else None + _obj = cls.model_validate({ + "a_objEzmaxinvoicing": [EzmaxinvoicingAutocompleteElementResponse.from_dict(_item) for _item in obj.get("a_objEzmaxinvoicing")] if obj.get("a_objEzmaxinvoicing") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezmaxinvoicing_get_object_v2_response.py b/eZmaxApi/models/ezmaxinvoicing_get_object_v2_response.py index 91982697c..8a09ff063 100644 --- a/eZmaxApi/models/ezmaxinvoicing_get_object_v2_response.py +++ b/eZmaxApi/models/ezmaxinvoicing_get_object_v2_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.ezmaxinvoicing_get_object_v2_response_m_payload import EzmaxinvoicingGetObjectV2ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzmaxinvoicingGetObjectV2Response(BaseModel): """ - Response for GET /2/object/ezmaxinvoicing/{pkiEzmaxinvoicingID} # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzmaxinvoicingGetObjectV2ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /2/object/ezmaxinvoicing/{pkiEzmaxinvoicingID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzmaxinvoicingGetObjectV2ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzmaxinvoicingGetObjectV2Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzmaxinvoicingGetObjectV2Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzmaxinvoicingGetObjectV2Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzmaxinvoicingGetObjectV2Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzmaxinvoicingGetObjectV2Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzmaxinvoicingGetObjectV2Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzmaxinvoicingGetObjectV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzmaxinvoicingGetObjectV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezmaxinvoicing_get_object_v2_response_m_payload.py b/eZmaxApi/models/ezmaxinvoicing_get_object_v2_response_m_payload.py index d4d312ef0..c8a5cd220 100644 --- a/eZmaxApi/models/ezmaxinvoicing_get_object_v2_response_m_payload.py +++ b/eZmaxApi/models/ezmaxinvoicing_get_object_v2_response_m_payload.py @@ -19,57 +19,75 @@ import json - -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.ezmaxinvoicing_response_compound import EzmaxinvoicingResponseCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzmaxinvoicingGetObjectV2ResponseMPayload(BaseModel): """ - Payload for GET /2/object/ezmaxinvoicing/{pkiEzmaxinvoicingID} # noqa: E501 - """ - obj_ezmaxinvoicing: EzmaxinvoicingResponseCompound = Field(..., alias="objEzmaxinvoicing") - __properties = ["objEzmaxinvoicing"] + Payload for GET /2/object/ezmaxinvoicing/{pkiEzmaxinvoicingID} + """ # noqa: E501 + obj_ezmaxinvoicing: EzmaxinvoicingResponseCompound = Field(alias="objEzmaxinvoicing") + __properties: ClassVar[List[str]] = ["objEzmaxinvoicing"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzmaxinvoicingGetObjectV2ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzmaxinvoicingGetObjectV2ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_ezmaxinvoicing if self.obj_ezmaxinvoicing: _dict['objEzmaxinvoicing'] = self.obj_ezmaxinvoicing.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> EzmaxinvoicingGetObjectV2ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzmaxinvoicingGetObjectV2ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzmaxinvoicingGetObjectV2ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzmaxinvoicingGetObjectV2ResponseMPayload.parse_obj({ - "obj_ezmaxinvoicing": EzmaxinvoicingResponseCompound.from_dict(obj.get("objEzmaxinvoicing")) if obj.get("objEzmaxinvoicing") is not None else None + _obj = cls.model_validate({ + "objEzmaxinvoicing": EzmaxinvoicingResponseCompound.from_dict(obj.get("objEzmaxinvoicing")) if obj.get("objEzmaxinvoicing") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezmaxinvoicing_get_provisional_v1_response.py b/eZmaxApi/models/ezmaxinvoicing_get_provisional_v1_response.py index d8e400a5b..a1e1e529c 100644 --- a/eZmaxApi/models/ezmaxinvoicing_get_provisional_v1_response.py +++ b/eZmaxApi/models/ezmaxinvoicing_get_provisional_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.ezmaxinvoicing_get_provisional_v1_response_m_payload import EzmaxinvoicingGetProvisionalV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzmaxinvoicingGetProvisionalV1Response(BaseModel): """ - Response for GET /1/object/ezmaxinvoicing/getProvisional # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzmaxinvoicingGetProvisionalV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /1/object/ezmaxinvoicing/getProvisional + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzmaxinvoicingGetProvisionalV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzmaxinvoicingGetProvisionalV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzmaxinvoicingGetProvisionalV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzmaxinvoicingGetProvisionalV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzmaxinvoicingGetProvisionalV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzmaxinvoicingGetProvisionalV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzmaxinvoicingGetProvisionalV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzmaxinvoicingGetProvisionalV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzmaxinvoicingGetProvisionalV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezmaxinvoicing_get_provisional_v1_response_m_payload.py b/eZmaxApi/models/ezmaxinvoicing_get_provisional_v1_response_m_payload.py index 44c3a3f29..caa3dc836 100644 --- a/eZmaxApi/models/ezmaxinvoicing_get_provisional_v1_response_m_payload.py +++ b/eZmaxApi/models/ezmaxinvoicing_get_provisional_v1_response_m_payload.py @@ -19,8 +19,10 @@ import json -from typing import List, Optional -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint, conlist, constr, validator +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, StrictStr, field_validator +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.common_audit import CommonAudit from eZmaxApi.models.custom_ezmaxinvoicing_ezsigndocument_response import CustomEzmaxinvoicingEzsigndocumentResponse from eZmaxApi.models.custom_ezmaxinvoicing_ezsignfolder_response import CustomEzmaxinvoicingEzsignfolderResponse @@ -32,73 +34,90 @@ from eZmaxApi.models.ezmaxinvoicingsummaryinternal_response_compound import EzmaxinvoicingsummaryinternalResponseCompound from eZmaxApi.models.ezmaxinvoicinguser_response_compound import EzmaxinvoicinguserResponseCompound from eZmaxApi.models.field_e_ezmaxinvoicing_paymenttype import FieldEEzmaxinvoicingPaymenttype +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzmaxinvoicingGetProvisionalV1ResponseMPayload(BaseModel): """ - Payload for GET /1/object/ezmaxinvoicing/getProvisional # noqa: E501 - """ - pki_ezmaxinvoicing_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="pkiEzmaxinvoicingID", description="The unique ID of the Ezmaxinvoicing") - fki_ezmaxinvoicingcontract_id: conint(strict=True, ge=1) = Field(..., alias="fkiEzmaxinvoicingcontractID", description="The unique ID of the Ezmaxinvoicingcontract") - fki_ezmaxpricing_id: conint(strict=True, ge=1) = Field(..., alias="fkiEzmaxpricingID", description="The unique ID of the Ezmaxpricing") - fki_systemconfigurationtype_id: conint(strict=True, ge=1) = Field(..., alias="fkiSystemconfigurationtypeID", description="The unique ID of the Systemconfigurationtype") - s_systemconfigurationtype_description_x: StrictStr = Field(..., alias="sSystemconfigurationtypeDescriptionX", description="The description of the Systemconfigurationtype in the language of the requester") - yyyymm_ezmaxinvoicing: constr(strict=True, max_length=7) = Field(..., alias="yyyymmEzmaxinvoicing", description="The YYYYMM period of the Ezmaxinvoicing") - i_ezmaxinvoicing_days: conint(strict=True, ge=1) = Field(..., alias="iEzmaxinvoicingDays", description="The number of days invoiced") - e_ezmaxinvoicing_paymenttype: FieldEEzmaxinvoicingPaymenttype = Field(..., alias="eEzmaxinvoicingPaymenttype") - d_ezmaxinvoicing_rebatepaymenttype: constr(strict=True) = Field(..., alias="dEzmaxinvoicingRebatepaymenttype", description="The percentage of rebate depending of the payment type") - i_ezmaxinvoicing_contractlength: conint(strict=True, ge=1) = Field(..., alias="iEzmaxinvoicingContractlength", description="The length of the contract in years") - d_ezmaxinvoicing_rebatecontractlength: constr(strict=True) = Field(..., alias="dEzmaxinvoicingRebatecontractlength", description="The percentage of rebate depending of the contract length") - b_ezmaxinvoicing_rebate_ezsignallagents: StrictBool = Field(..., alias="bEzmaxinvoicingRebateEzsignallagents", description="Whether the rebate for eZsign is for all agents") - obj_audit: Optional[CommonAudit] = Field(None, alias="objAudit") - obj_ezmaxinvoicingcontract: EzmaxinvoicingcontractResponseCompound = Field(..., alias="objEzmaxinvoicingcontract") - obj_ezmaxpricing: CustomEzmaxpricingResponse = Field(..., alias="objEzmaxpricing") - a_obj_ezmaxinvoicingsummaryglobal: conlist(EzmaxinvoicingsummaryglobalResponseCompound) = Field(..., alias="a_objEzmaxinvoicingsummaryglobal") - a_obj_ezmaxinvoicingsummaryexternal: conlist(EzmaxinvoicingsummaryexternalResponseCompound) = Field(..., alias="a_objEzmaxinvoicingsummaryexternal") - a_obj_ezmaxinvoicingsummaryinternal: conlist(EzmaxinvoicingsummaryinternalResponseCompound) = Field(..., alias="a_objEzmaxinvoicingsummaryinternal") - a_obj_ezmaxinvoicingagent: conlist(EzmaxinvoicingagentResponseCompound) = Field(..., alias="a_objEzmaxinvoicingagent") - a_obj_ezmaxinvoicinguser: conlist(EzmaxinvoicinguserResponseCompound) = Field(..., alias="a_objEzmaxinvoicinguser") - a_obj_ezmaxinvoicingezsignfolder: conlist(CustomEzmaxinvoicingEzsignfolderResponse) = Field(..., alias="a_objEzmaxinvoicingezsignfolder") - a_obj_ezmaxinvoicingezsigndocument: conlist(CustomEzmaxinvoicingEzsigndocumentResponse) = Field(..., alias="a_objEzmaxinvoicingezsigndocument") - __properties = ["pkiEzmaxinvoicingID", "fkiEzmaxinvoicingcontractID", "fkiEzmaxpricingID", "fkiSystemconfigurationtypeID", "sSystemconfigurationtypeDescriptionX", "yyyymmEzmaxinvoicing", "iEzmaxinvoicingDays", "eEzmaxinvoicingPaymenttype", "dEzmaxinvoicingRebatepaymenttype", "iEzmaxinvoicingContractlength", "dEzmaxinvoicingRebatecontractlength", "bEzmaxinvoicingRebateEzsignallagents", "objAudit", "objEzmaxinvoicingcontract", "objEzmaxpricing", "a_objEzmaxinvoicingsummaryglobal", "a_objEzmaxinvoicingsummaryexternal", "a_objEzmaxinvoicingsummaryinternal", "a_objEzmaxinvoicingagent", "a_objEzmaxinvoicinguser", "a_objEzmaxinvoicingezsignfolder", "a_objEzmaxinvoicingezsigndocument"] - - @validator('d_ezmaxinvoicing_rebatepaymenttype') + Payload for GET /1/object/ezmaxinvoicing/getProvisional + """ # noqa: E501 + pki_ezmaxinvoicing_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezmaxinvoicing", alias="pkiEzmaxinvoicingID") + fki_ezmaxinvoicingcontract_id: Annotated[int, Field(strict=True, ge=1)] = Field(description="The unique ID of the Ezmaxinvoicingcontract", alias="fkiEzmaxinvoicingcontractID") + fki_ezmaxpricing_id: Annotated[int, Field(strict=True, ge=1)] = Field(description="The unique ID of the Ezmaxpricing", alias="fkiEzmaxpricingID") + fki_systemconfigurationtype_id: Annotated[int, Field(strict=True, ge=1)] = Field(description="The unique ID of the Systemconfigurationtype", alias="fkiSystemconfigurationtypeID") + s_systemconfigurationtype_description_x: StrictStr = Field(description="The description of the Systemconfigurationtype in the language of the requester", alias="sSystemconfigurationtypeDescriptionX") + yyyymm_ezmaxinvoicing: Annotated[str, Field(strict=True, max_length=7)] = Field(description="The YYYYMM period of the Ezmaxinvoicing", alias="yyyymmEzmaxinvoicing") + i_ezmaxinvoicing_days: Annotated[int, Field(strict=True, ge=1)] = Field(description="The number of days invoiced", alias="iEzmaxinvoicingDays") + e_ezmaxinvoicing_paymenttype: FieldEEzmaxinvoicingPaymenttype = Field(alias="eEzmaxinvoicingPaymenttype") + d_ezmaxinvoicing_rebatepaymenttype: Annotated[str, Field(strict=True)] = Field(description="The percentage of rebate depending of the payment type", alias="dEzmaxinvoicingRebatepaymenttype") + i_ezmaxinvoicing_contractlength: Annotated[int, Field(strict=True, ge=1)] = Field(description="The length of the contract in years", alias="iEzmaxinvoicingContractlength") + d_ezmaxinvoicing_rebatecontractlength: Annotated[str, Field(strict=True)] = Field(description="The percentage of rebate depending of the contract length", alias="dEzmaxinvoicingRebatecontractlength") + b_ezmaxinvoicing_rebate_ezsignallagents: StrictBool = Field(description="Whether the rebate for eZsign is for all agents", alias="bEzmaxinvoicingRebateEzsignallagents") + obj_audit: Optional[CommonAudit] = Field(default=None, alias="objAudit") + obj_ezmaxinvoicingcontract: EzmaxinvoicingcontractResponseCompound = Field(alias="objEzmaxinvoicingcontract") + obj_ezmaxpricing: CustomEzmaxpricingResponse = Field(alias="objEzmaxpricing") + a_obj_ezmaxinvoicingsummaryglobal: List[EzmaxinvoicingsummaryglobalResponseCompound] = Field(alias="a_objEzmaxinvoicingsummaryglobal") + a_obj_ezmaxinvoicingsummaryexternal: List[EzmaxinvoicingsummaryexternalResponseCompound] = Field(alias="a_objEzmaxinvoicingsummaryexternal") + a_obj_ezmaxinvoicingsummaryinternal: List[EzmaxinvoicingsummaryinternalResponseCompound] = Field(alias="a_objEzmaxinvoicingsummaryinternal") + a_obj_ezmaxinvoicingagent: List[EzmaxinvoicingagentResponseCompound] = Field(alias="a_objEzmaxinvoicingagent") + a_obj_ezmaxinvoicinguser: List[EzmaxinvoicinguserResponseCompound] = Field(alias="a_objEzmaxinvoicinguser") + a_obj_ezmaxinvoicingezsignfolder: List[CustomEzmaxinvoicingEzsignfolderResponse] = Field(alias="a_objEzmaxinvoicingezsignfolder") + a_obj_ezmaxinvoicingezsigndocument: List[CustomEzmaxinvoicingEzsigndocumentResponse] = Field(alias="a_objEzmaxinvoicingezsigndocument") + __properties: ClassVar[List[str]] = ["pkiEzmaxinvoicingID", "fkiEzmaxinvoicingcontractID", "fkiEzmaxpricingID", "fkiSystemconfigurationtypeID", "sSystemconfigurationtypeDescriptionX", "yyyymmEzmaxinvoicing", "iEzmaxinvoicingDays", "eEzmaxinvoicingPaymenttype", "dEzmaxinvoicingRebatepaymenttype", "iEzmaxinvoicingContractlength", "dEzmaxinvoicingRebatecontractlength", "bEzmaxinvoicingRebateEzsignallagents", "objAudit", "objEzmaxinvoicingcontract", "objEzmaxpricing", "a_objEzmaxinvoicingsummaryglobal", "a_objEzmaxinvoicingsummaryexternal", "a_objEzmaxinvoicingsummaryinternal", "a_objEzmaxinvoicingagent", "a_objEzmaxinvoicinguser", "a_objEzmaxinvoicingezsignfolder", "a_objEzmaxinvoicingezsigndocument"] + + @field_validator('d_ezmaxinvoicing_rebatepaymenttype') def d_ezmaxinvoicing_rebatepaymenttype_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^-{0,1}[\d]{1,3}?\.[\d]{2}$", value): raise ValueError(r"must validate the regular expression /^-{0,1}[\d]{1,3}?\.[\d]{2}$/") return value - @validator('d_ezmaxinvoicing_rebatecontractlength') + @field_validator('d_ezmaxinvoicing_rebatecontractlength') def d_ezmaxinvoicing_rebatecontractlength_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^-{0,1}[\d]{1,3}?\.[\d]{2}$", value): raise ValueError(r"must validate the regular expression /^-{0,1}[\d]{1,3}?\.[\d]{2}$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzmaxinvoicingGetProvisionalV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzmaxinvoicingGetProvisionalV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_audit if self.obj_audit: _dict['objAudit'] = self.obj_audit.to_dict() @@ -160,37 +179,37 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzmaxinvoicingGetProvisionalV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzmaxinvoicingGetProvisionalV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzmaxinvoicingGetProvisionalV1ResponseMPayload.parse_obj(obj) - - _obj = EzmaxinvoicingGetProvisionalV1ResponseMPayload.parse_obj({ - "pki_ezmaxinvoicing_id": obj.get("pkiEzmaxinvoicingID"), - "fki_ezmaxinvoicingcontract_id": obj.get("fkiEzmaxinvoicingcontractID"), - "fki_ezmaxpricing_id": obj.get("fkiEzmaxpricingID"), - "fki_systemconfigurationtype_id": obj.get("fkiSystemconfigurationtypeID"), - "s_systemconfigurationtype_description_x": obj.get("sSystemconfigurationtypeDescriptionX"), - "yyyymm_ezmaxinvoicing": obj.get("yyyymmEzmaxinvoicing"), - "i_ezmaxinvoicing_days": obj.get("iEzmaxinvoicingDays"), - "e_ezmaxinvoicing_paymenttype": obj.get("eEzmaxinvoicingPaymenttype"), - "d_ezmaxinvoicing_rebatepaymenttype": obj.get("dEzmaxinvoicingRebatepaymenttype"), - "i_ezmaxinvoicing_contractlength": obj.get("iEzmaxinvoicingContractlength"), - "d_ezmaxinvoicing_rebatecontractlength": obj.get("dEzmaxinvoicingRebatecontractlength"), - "b_ezmaxinvoicing_rebate_ezsignallagents": obj.get("bEzmaxinvoicingRebateEzsignallagents"), - "obj_audit": CommonAudit.from_dict(obj.get("objAudit")) if obj.get("objAudit") is not None else None, - "obj_ezmaxinvoicingcontract": EzmaxinvoicingcontractResponseCompound.from_dict(obj.get("objEzmaxinvoicingcontract")) if obj.get("objEzmaxinvoicingcontract") is not None else None, - "obj_ezmaxpricing": CustomEzmaxpricingResponse.from_dict(obj.get("objEzmaxpricing")) if obj.get("objEzmaxpricing") is not None else None, - "a_obj_ezmaxinvoicingsummaryglobal": [EzmaxinvoicingsummaryglobalResponseCompound.from_dict(_item) for _item in obj.get("a_objEzmaxinvoicingsummaryglobal")] if obj.get("a_objEzmaxinvoicingsummaryglobal") is not None else None, - "a_obj_ezmaxinvoicingsummaryexternal": [EzmaxinvoicingsummaryexternalResponseCompound.from_dict(_item) for _item in obj.get("a_objEzmaxinvoicingsummaryexternal")] if obj.get("a_objEzmaxinvoicingsummaryexternal") is not None else None, - "a_obj_ezmaxinvoicingsummaryinternal": [EzmaxinvoicingsummaryinternalResponseCompound.from_dict(_item) for _item in obj.get("a_objEzmaxinvoicingsummaryinternal")] if obj.get("a_objEzmaxinvoicingsummaryinternal") is not None else None, - "a_obj_ezmaxinvoicingagent": [EzmaxinvoicingagentResponseCompound.from_dict(_item) for _item in obj.get("a_objEzmaxinvoicingagent")] if obj.get("a_objEzmaxinvoicingagent") is not None else None, - "a_obj_ezmaxinvoicinguser": [EzmaxinvoicinguserResponseCompound.from_dict(_item) for _item in obj.get("a_objEzmaxinvoicinguser")] if obj.get("a_objEzmaxinvoicinguser") is not None else None, - "a_obj_ezmaxinvoicingezsignfolder": [CustomEzmaxinvoicingEzsignfolderResponse.from_dict(_item) for _item in obj.get("a_objEzmaxinvoicingezsignfolder")] if obj.get("a_objEzmaxinvoicingezsignfolder") is not None else None, - "a_obj_ezmaxinvoicingezsigndocument": [CustomEzmaxinvoicingEzsigndocumentResponse.from_dict(_item) for _item in obj.get("a_objEzmaxinvoicingezsigndocument")] if obj.get("a_objEzmaxinvoicingezsigndocument") is not None else None + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzmaxinvoicingID": obj.get("pkiEzmaxinvoicingID"), + "fkiEzmaxinvoicingcontractID": obj.get("fkiEzmaxinvoicingcontractID"), + "fkiEzmaxpricingID": obj.get("fkiEzmaxpricingID"), + "fkiSystemconfigurationtypeID": obj.get("fkiSystemconfigurationtypeID"), + "sSystemconfigurationtypeDescriptionX": obj.get("sSystemconfigurationtypeDescriptionX"), + "yyyymmEzmaxinvoicing": obj.get("yyyymmEzmaxinvoicing"), + "iEzmaxinvoicingDays": obj.get("iEzmaxinvoicingDays"), + "eEzmaxinvoicingPaymenttype": obj.get("eEzmaxinvoicingPaymenttype"), + "dEzmaxinvoicingRebatepaymenttype": obj.get("dEzmaxinvoicingRebatepaymenttype"), + "iEzmaxinvoicingContractlength": obj.get("iEzmaxinvoicingContractlength"), + "dEzmaxinvoicingRebatecontractlength": obj.get("dEzmaxinvoicingRebatecontractlength"), + "bEzmaxinvoicingRebateEzsignallagents": obj.get("bEzmaxinvoicingRebateEzsignallagents"), + "objAudit": CommonAudit.from_dict(obj.get("objAudit")) if obj.get("objAudit") is not None else None, + "objEzmaxinvoicingcontract": EzmaxinvoicingcontractResponseCompound.from_dict(obj.get("objEzmaxinvoicingcontract")) if obj.get("objEzmaxinvoicingcontract") is not None else None, + "objEzmaxpricing": CustomEzmaxpricingResponse.from_dict(obj.get("objEzmaxpricing")) if obj.get("objEzmaxpricing") is not None else None, + "a_objEzmaxinvoicingsummaryglobal": [EzmaxinvoicingsummaryglobalResponseCompound.from_dict(_item) for _item in obj.get("a_objEzmaxinvoicingsummaryglobal")] if obj.get("a_objEzmaxinvoicingsummaryglobal") is not None else None, + "a_objEzmaxinvoicingsummaryexternal": [EzmaxinvoicingsummaryexternalResponseCompound.from_dict(_item) for _item in obj.get("a_objEzmaxinvoicingsummaryexternal")] if obj.get("a_objEzmaxinvoicingsummaryexternal") is not None else None, + "a_objEzmaxinvoicingsummaryinternal": [EzmaxinvoicingsummaryinternalResponseCompound.from_dict(_item) for _item in obj.get("a_objEzmaxinvoicingsummaryinternal")] if obj.get("a_objEzmaxinvoicingsummaryinternal") is not None else None, + "a_objEzmaxinvoicingagent": [EzmaxinvoicingagentResponseCompound.from_dict(_item) for _item in obj.get("a_objEzmaxinvoicingagent")] if obj.get("a_objEzmaxinvoicingagent") is not None else None, + "a_objEzmaxinvoicinguser": [EzmaxinvoicinguserResponseCompound.from_dict(_item) for _item in obj.get("a_objEzmaxinvoicinguser")] if obj.get("a_objEzmaxinvoicinguser") is not None else None, + "a_objEzmaxinvoicingezsignfolder": [CustomEzmaxinvoicingEzsignfolderResponse.from_dict(_item) for _item in obj.get("a_objEzmaxinvoicingezsignfolder")] if obj.get("a_objEzmaxinvoicingezsignfolder") is not None else None, + "a_objEzmaxinvoicingezsigndocument": [CustomEzmaxinvoicingEzsigndocumentResponse.from_dict(_item) for _item in obj.get("a_objEzmaxinvoicingezsigndocument")] if obj.get("a_objEzmaxinvoicingezsigndocument") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezmaxinvoicing_response.py b/eZmaxApi/models/ezmaxinvoicing_response.py index 8b94ae62e..90d08f287 100644 --- a/eZmaxApi/models/ezmaxinvoicing_response.py +++ b/eZmaxApi/models/ezmaxinvoicing_response.py @@ -19,96 +19,115 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint, constr, validator +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, StrictStr, field_validator +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.common_audit import CommonAudit from eZmaxApi.models.field_e_ezmaxinvoicing_paymenttype import FieldEEzmaxinvoicingPaymenttype +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzmaxinvoicingResponse(BaseModel): """ - A Ezmaxinvoicing Object # noqa: E501 - """ - pki_ezmaxinvoicing_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="pkiEzmaxinvoicingID", description="The unique ID of the Ezmaxinvoicing") - fki_ezmaxinvoicingcontract_id: conint(strict=True, ge=1) = Field(..., alias="fkiEzmaxinvoicingcontractID", description="The unique ID of the Ezmaxinvoicingcontract") - fki_ezmaxpricing_id: conint(strict=True, ge=1) = Field(..., alias="fkiEzmaxpricingID", description="The unique ID of the Ezmaxpricing") - fki_systemconfigurationtype_id: conint(strict=True, ge=1) = Field(..., alias="fkiSystemconfigurationtypeID", description="The unique ID of the Systemconfigurationtype") - s_systemconfigurationtype_description_x: StrictStr = Field(..., alias="sSystemconfigurationtypeDescriptionX", description="The description of the Systemconfigurationtype in the language of the requester") - yyyymm_ezmaxinvoicing: constr(strict=True, max_length=7) = Field(..., alias="yyyymmEzmaxinvoicing", description="The YYYYMM period of the Ezmaxinvoicing") - i_ezmaxinvoicing_days: conint(strict=True, ge=1) = Field(..., alias="iEzmaxinvoicingDays", description="The number of days invoiced") - e_ezmaxinvoicing_paymenttype: FieldEEzmaxinvoicingPaymenttype = Field(..., alias="eEzmaxinvoicingPaymenttype") - d_ezmaxinvoicing_rebatepaymenttype: constr(strict=True) = Field(..., alias="dEzmaxinvoicingRebatepaymenttype", description="The percentage of rebate depending of the payment type") - i_ezmaxinvoicing_contractlength: conint(strict=True, ge=1) = Field(..., alias="iEzmaxinvoicingContractlength", description="The length of the contract in years") - d_ezmaxinvoicing_rebatecontractlength: constr(strict=True) = Field(..., alias="dEzmaxinvoicingRebatecontractlength", description="The percentage of rebate depending of the contract length") - b_ezmaxinvoicing_rebate_ezsignallagents: StrictBool = Field(..., alias="bEzmaxinvoicingRebateEzsignallagents", description="Whether the rebate for eZsign is for all agents") - obj_audit: Optional[CommonAudit] = Field(None, alias="objAudit") - __properties = ["pkiEzmaxinvoicingID", "fkiEzmaxinvoicingcontractID", "fkiEzmaxpricingID", "fkiSystemconfigurationtypeID", "sSystemconfigurationtypeDescriptionX", "yyyymmEzmaxinvoicing", "iEzmaxinvoicingDays", "eEzmaxinvoicingPaymenttype", "dEzmaxinvoicingRebatepaymenttype", "iEzmaxinvoicingContractlength", "dEzmaxinvoicingRebatecontractlength", "bEzmaxinvoicingRebateEzsignallagents", "objAudit"] - - @validator('d_ezmaxinvoicing_rebatepaymenttype') + A Ezmaxinvoicing Object + """ # noqa: E501 + pki_ezmaxinvoicing_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezmaxinvoicing", alias="pkiEzmaxinvoicingID") + fki_ezmaxinvoicingcontract_id: Annotated[int, Field(strict=True, ge=1)] = Field(description="The unique ID of the Ezmaxinvoicingcontract", alias="fkiEzmaxinvoicingcontractID") + fki_ezmaxpricing_id: Annotated[int, Field(strict=True, ge=1)] = Field(description="The unique ID of the Ezmaxpricing", alias="fkiEzmaxpricingID") + fki_systemconfigurationtype_id: Annotated[int, Field(strict=True, ge=1)] = Field(description="The unique ID of the Systemconfigurationtype", alias="fkiSystemconfigurationtypeID") + s_systemconfigurationtype_description_x: StrictStr = Field(description="The description of the Systemconfigurationtype in the language of the requester", alias="sSystemconfigurationtypeDescriptionX") + yyyymm_ezmaxinvoicing: Annotated[str, Field(strict=True, max_length=7)] = Field(description="The YYYYMM period of the Ezmaxinvoicing", alias="yyyymmEzmaxinvoicing") + i_ezmaxinvoicing_days: Annotated[int, Field(strict=True, ge=1)] = Field(description="The number of days invoiced", alias="iEzmaxinvoicingDays") + e_ezmaxinvoicing_paymenttype: FieldEEzmaxinvoicingPaymenttype = Field(alias="eEzmaxinvoicingPaymenttype") + d_ezmaxinvoicing_rebatepaymenttype: Annotated[str, Field(strict=True)] = Field(description="The percentage of rebate depending of the payment type", alias="dEzmaxinvoicingRebatepaymenttype") + i_ezmaxinvoicing_contractlength: Annotated[int, Field(strict=True, ge=1)] = Field(description="The length of the contract in years", alias="iEzmaxinvoicingContractlength") + d_ezmaxinvoicing_rebatecontractlength: Annotated[str, Field(strict=True)] = Field(description="The percentage of rebate depending of the contract length", alias="dEzmaxinvoicingRebatecontractlength") + b_ezmaxinvoicing_rebate_ezsignallagents: StrictBool = Field(description="Whether the rebate for eZsign is for all agents", alias="bEzmaxinvoicingRebateEzsignallagents") + obj_audit: Optional[CommonAudit] = Field(default=None, alias="objAudit") + __properties: ClassVar[List[str]] = ["pkiEzmaxinvoicingID", "fkiEzmaxinvoicingcontractID", "fkiEzmaxpricingID", "fkiSystemconfigurationtypeID", "sSystemconfigurationtypeDescriptionX", "yyyymmEzmaxinvoicing", "iEzmaxinvoicingDays", "eEzmaxinvoicingPaymenttype", "dEzmaxinvoicingRebatepaymenttype", "iEzmaxinvoicingContractlength", "dEzmaxinvoicingRebatecontractlength", "bEzmaxinvoicingRebateEzsignallagents", "objAudit"] + + @field_validator('d_ezmaxinvoicing_rebatepaymenttype') def d_ezmaxinvoicing_rebatepaymenttype_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^-{0,1}[\d]{1,3}?\.[\d]{2}$", value): raise ValueError(r"must validate the regular expression /^-{0,1}[\d]{1,3}?\.[\d]{2}$/") return value - @validator('d_ezmaxinvoicing_rebatecontractlength') + @field_validator('d_ezmaxinvoicing_rebatecontractlength') def d_ezmaxinvoicing_rebatecontractlength_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^-{0,1}[\d]{1,3}?\.[\d]{2}$", value): raise ValueError(r"must validate the regular expression /^-{0,1}[\d]{1,3}?\.[\d]{2}$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzmaxinvoicingResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzmaxinvoicingResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_audit if self.obj_audit: _dict['objAudit'] = self.obj_audit.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> EzmaxinvoicingResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzmaxinvoicingResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzmaxinvoicingResponse.parse_obj(obj) - - _obj = EzmaxinvoicingResponse.parse_obj({ - "pki_ezmaxinvoicing_id": obj.get("pkiEzmaxinvoicingID"), - "fki_ezmaxinvoicingcontract_id": obj.get("fkiEzmaxinvoicingcontractID"), - "fki_ezmaxpricing_id": obj.get("fkiEzmaxpricingID"), - "fki_systemconfigurationtype_id": obj.get("fkiSystemconfigurationtypeID"), - "s_systemconfigurationtype_description_x": obj.get("sSystemconfigurationtypeDescriptionX"), - "yyyymm_ezmaxinvoicing": obj.get("yyyymmEzmaxinvoicing"), - "i_ezmaxinvoicing_days": obj.get("iEzmaxinvoicingDays"), - "e_ezmaxinvoicing_paymenttype": obj.get("eEzmaxinvoicingPaymenttype"), - "d_ezmaxinvoicing_rebatepaymenttype": obj.get("dEzmaxinvoicingRebatepaymenttype"), - "i_ezmaxinvoicing_contractlength": obj.get("iEzmaxinvoicingContractlength"), - "d_ezmaxinvoicing_rebatecontractlength": obj.get("dEzmaxinvoicingRebatecontractlength"), - "b_ezmaxinvoicing_rebate_ezsignallagents": obj.get("bEzmaxinvoicingRebateEzsignallagents"), - "obj_audit": CommonAudit.from_dict(obj.get("objAudit")) if obj.get("objAudit") is not None else None + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzmaxinvoicingID": obj.get("pkiEzmaxinvoicingID"), + "fkiEzmaxinvoicingcontractID": obj.get("fkiEzmaxinvoicingcontractID"), + "fkiEzmaxpricingID": obj.get("fkiEzmaxpricingID"), + "fkiSystemconfigurationtypeID": obj.get("fkiSystemconfigurationtypeID"), + "sSystemconfigurationtypeDescriptionX": obj.get("sSystemconfigurationtypeDescriptionX"), + "yyyymmEzmaxinvoicing": obj.get("yyyymmEzmaxinvoicing"), + "iEzmaxinvoicingDays": obj.get("iEzmaxinvoicingDays"), + "eEzmaxinvoicingPaymenttype": obj.get("eEzmaxinvoicingPaymenttype"), + "dEzmaxinvoicingRebatepaymenttype": obj.get("dEzmaxinvoicingRebatepaymenttype"), + "iEzmaxinvoicingContractlength": obj.get("iEzmaxinvoicingContractlength"), + "dEzmaxinvoicingRebatecontractlength": obj.get("dEzmaxinvoicingRebatecontractlength"), + "bEzmaxinvoicingRebateEzsignallagents": obj.get("bEzmaxinvoicingRebateEzsignallagents"), + "objAudit": CommonAudit.from_dict(obj.get("objAudit")) if obj.get("objAudit") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezmaxinvoicing_response_compound.py b/eZmaxApi/models/ezmaxinvoicing_response_compound.py index e12b740d8..1acfd86f7 100644 --- a/eZmaxApi/models/ezmaxinvoicing_response_compound.py +++ b/eZmaxApi/models/ezmaxinvoicing_response_compound.py @@ -19,8 +19,10 @@ import json -from typing import List, Optional -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint, conlist, constr, validator +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, StrictStr, field_validator +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.common_audit import CommonAudit from eZmaxApi.models.custom_ezmaxinvoicing_ezsigndocument_response import CustomEzmaxinvoicingEzsigndocumentResponse from eZmaxApi.models.custom_ezmaxinvoicing_ezsignfolder_response import CustomEzmaxinvoicingEzsignfolderResponse @@ -32,73 +34,90 @@ from eZmaxApi.models.ezmaxinvoicingsummaryinternal_response_compound import EzmaxinvoicingsummaryinternalResponseCompound from eZmaxApi.models.ezmaxinvoicinguser_response_compound import EzmaxinvoicinguserResponseCompound from eZmaxApi.models.field_e_ezmaxinvoicing_paymenttype import FieldEEzmaxinvoicingPaymenttype +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzmaxinvoicingResponseCompound(BaseModel): """ - A Ezmaxinvoicing Object # noqa: E501 - """ - pki_ezmaxinvoicing_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="pkiEzmaxinvoicingID", description="The unique ID of the Ezmaxinvoicing") - fki_ezmaxinvoicingcontract_id: conint(strict=True, ge=1) = Field(..., alias="fkiEzmaxinvoicingcontractID", description="The unique ID of the Ezmaxinvoicingcontract") - fki_ezmaxpricing_id: conint(strict=True, ge=1) = Field(..., alias="fkiEzmaxpricingID", description="The unique ID of the Ezmaxpricing") - fki_systemconfigurationtype_id: conint(strict=True, ge=1) = Field(..., alias="fkiSystemconfigurationtypeID", description="The unique ID of the Systemconfigurationtype") - s_systemconfigurationtype_description_x: StrictStr = Field(..., alias="sSystemconfigurationtypeDescriptionX", description="The description of the Systemconfigurationtype in the language of the requester") - yyyymm_ezmaxinvoicing: constr(strict=True, max_length=7) = Field(..., alias="yyyymmEzmaxinvoicing", description="The YYYYMM period of the Ezmaxinvoicing") - i_ezmaxinvoicing_days: conint(strict=True, ge=1) = Field(..., alias="iEzmaxinvoicingDays", description="The number of days invoiced") - e_ezmaxinvoicing_paymenttype: FieldEEzmaxinvoicingPaymenttype = Field(..., alias="eEzmaxinvoicingPaymenttype") - d_ezmaxinvoicing_rebatepaymenttype: constr(strict=True) = Field(..., alias="dEzmaxinvoicingRebatepaymenttype", description="The percentage of rebate depending of the payment type") - i_ezmaxinvoicing_contractlength: conint(strict=True, ge=1) = Field(..., alias="iEzmaxinvoicingContractlength", description="The length of the contract in years") - d_ezmaxinvoicing_rebatecontractlength: constr(strict=True) = Field(..., alias="dEzmaxinvoicingRebatecontractlength", description="The percentage of rebate depending of the contract length") - b_ezmaxinvoicing_rebate_ezsignallagents: StrictBool = Field(..., alias="bEzmaxinvoicingRebateEzsignallagents", description="Whether the rebate for eZsign is for all agents") - obj_audit: Optional[CommonAudit] = Field(None, alias="objAudit") - obj_ezmaxinvoicingcontract: EzmaxinvoicingcontractResponseCompound = Field(..., alias="objEzmaxinvoicingcontract") - obj_ezmaxpricing: CustomEzmaxpricingResponse = Field(..., alias="objEzmaxpricing") - a_obj_ezmaxinvoicingsummaryglobal: conlist(EzmaxinvoicingsummaryglobalResponseCompound) = Field(..., alias="a_objEzmaxinvoicingsummaryglobal") - a_obj_ezmaxinvoicingsummaryexternal: conlist(EzmaxinvoicingsummaryexternalResponseCompound) = Field(..., alias="a_objEzmaxinvoicingsummaryexternal") - a_obj_ezmaxinvoicingsummaryinternal: conlist(EzmaxinvoicingsummaryinternalResponseCompound) = Field(..., alias="a_objEzmaxinvoicingsummaryinternal") - a_obj_ezmaxinvoicingagent: conlist(EzmaxinvoicingagentResponseCompound) = Field(..., alias="a_objEzmaxinvoicingagent") - a_obj_ezmaxinvoicinguser: conlist(EzmaxinvoicinguserResponseCompound) = Field(..., alias="a_objEzmaxinvoicinguser") - a_obj_ezmaxinvoicingezsignfolder: conlist(CustomEzmaxinvoicingEzsignfolderResponse) = Field(..., alias="a_objEzmaxinvoicingezsignfolder") - a_obj_ezmaxinvoicingezsigndocument: conlist(CustomEzmaxinvoicingEzsigndocumentResponse) = Field(..., alias="a_objEzmaxinvoicingezsigndocument") - __properties = ["pkiEzmaxinvoicingID", "fkiEzmaxinvoicingcontractID", "fkiEzmaxpricingID", "fkiSystemconfigurationtypeID", "sSystemconfigurationtypeDescriptionX", "yyyymmEzmaxinvoicing", "iEzmaxinvoicingDays", "eEzmaxinvoicingPaymenttype", "dEzmaxinvoicingRebatepaymenttype", "iEzmaxinvoicingContractlength", "dEzmaxinvoicingRebatecontractlength", "bEzmaxinvoicingRebateEzsignallagents", "objAudit", "objEzmaxinvoicingcontract", "objEzmaxpricing", "a_objEzmaxinvoicingsummaryglobal", "a_objEzmaxinvoicingsummaryexternal", "a_objEzmaxinvoicingsummaryinternal", "a_objEzmaxinvoicingagent", "a_objEzmaxinvoicinguser", "a_objEzmaxinvoicingezsignfolder", "a_objEzmaxinvoicingezsigndocument"] - - @validator('d_ezmaxinvoicing_rebatepaymenttype') + A Ezmaxinvoicing Object + """ # noqa: E501 + pki_ezmaxinvoicing_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezmaxinvoicing", alias="pkiEzmaxinvoicingID") + fki_ezmaxinvoicingcontract_id: Annotated[int, Field(strict=True, ge=1)] = Field(description="The unique ID of the Ezmaxinvoicingcontract", alias="fkiEzmaxinvoicingcontractID") + fki_ezmaxpricing_id: Annotated[int, Field(strict=True, ge=1)] = Field(description="The unique ID of the Ezmaxpricing", alias="fkiEzmaxpricingID") + fki_systemconfigurationtype_id: Annotated[int, Field(strict=True, ge=1)] = Field(description="The unique ID of the Systemconfigurationtype", alias="fkiSystemconfigurationtypeID") + s_systemconfigurationtype_description_x: StrictStr = Field(description="The description of the Systemconfigurationtype in the language of the requester", alias="sSystemconfigurationtypeDescriptionX") + yyyymm_ezmaxinvoicing: Annotated[str, Field(strict=True, max_length=7)] = Field(description="The YYYYMM period of the Ezmaxinvoicing", alias="yyyymmEzmaxinvoicing") + i_ezmaxinvoicing_days: Annotated[int, Field(strict=True, ge=1)] = Field(description="The number of days invoiced", alias="iEzmaxinvoicingDays") + e_ezmaxinvoicing_paymenttype: FieldEEzmaxinvoicingPaymenttype = Field(alias="eEzmaxinvoicingPaymenttype") + d_ezmaxinvoicing_rebatepaymenttype: Annotated[str, Field(strict=True)] = Field(description="The percentage of rebate depending of the payment type", alias="dEzmaxinvoicingRebatepaymenttype") + i_ezmaxinvoicing_contractlength: Annotated[int, Field(strict=True, ge=1)] = Field(description="The length of the contract in years", alias="iEzmaxinvoicingContractlength") + d_ezmaxinvoicing_rebatecontractlength: Annotated[str, Field(strict=True)] = Field(description="The percentage of rebate depending of the contract length", alias="dEzmaxinvoicingRebatecontractlength") + b_ezmaxinvoicing_rebate_ezsignallagents: StrictBool = Field(description="Whether the rebate for eZsign is for all agents", alias="bEzmaxinvoicingRebateEzsignallagents") + obj_audit: Optional[CommonAudit] = Field(default=None, alias="objAudit") + obj_ezmaxinvoicingcontract: EzmaxinvoicingcontractResponseCompound = Field(alias="objEzmaxinvoicingcontract") + obj_ezmaxpricing: CustomEzmaxpricingResponse = Field(alias="objEzmaxpricing") + a_obj_ezmaxinvoicingsummaryglobal: List[EzmaxinvoicingsummaryglobalResponseCompound] = Field(alias="a_objEzmaxinvoicingsummaryglobal") + a_obj_ezmaxinvoicingsummaryexternal: List[EzmaxinvoicingsummaryexternalResponseCompound] = Field(alias="a_objEzmaxinvoicingsummaryexternal") + a_obj_ezmaxinvoicingsummaryinternal: List[EzmaxinvoicingsummaryinternalResponseCompound] = Field(alias="a_objEzmaxinvoicingsummaryinternal") + a_obj_ezmaxinvoicingagent: List[EzmaxinvoicingagentResponseCompound] = Field(alias="a_objEzmaxinvoicingagent") + a_obj_ezmaxinvoicinguser: List[EzmaxinvoicinguserResponseCompound] = Field(alias="a_objEzmaxinvoicinguser") + a_obj_ezmaxinvoicingezsignfolder: List[CustomEzmaxinvoicingEzsignfolderResponse] = Field(alias="a_objEzmaxinvoicingezsignfolder") + a_obj_ezmaxinvoicingezsigndocument: List[CustomEzmaxinvoicingEzsigndocumentResponse] = Field(alias="a_objEzmaxinvoicingezsigndocument") + __properties: ClassVar[List[str]] = ["pkiEzmaxinvoicingID", "fkiEzmaxinvoicingcontractID", "fkiEzmaxpricingID", "fkiSystemconfigurationtypeID", "sSystemconfigurationtypeDescriptionX", "yyyymmEzmaxinvoicing", "iEzmaxinvoicingDays", "eEzmaxinvoicingPaymenttype", "dEzmaxinvoicingRebatepaymenttype", "iEzmaxinvoicingContractlength", "dEzmaxinvoicingRebatecontractlength", "bEzmaxinvoicingRebateEzsignallagents", "objAudit", "objEzmaxinvoicingcontract", "objEzmaxpricing", "a_objEzmaxinvoicingsummaryglobal", "a_objEzmaxinvoicingsummaryexternal", "a_objEzmaxinvoicingsummaryinternal", "a_objEzmaxinvoicingagent", "a_objEzmaxinvoicinguser", "a_objEzmaxinvoicingezsignfolder", "a_objEzmaxinvoicingezsigndocument"] + + @field_validator('d_ezmaxinvoicing_rebatepaymenttype') def d_ezmaxinvoicing_rebatepaymenttype_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^-{0,1}[\d]{1,3}?\.[\d]{2}$", value): raise ValueError(r"must validate the regular expression /^-{0,1}[\d]{1,3}?\.[\d]{2}$/") return value - @validator('d_ezmaxinvoicing_rebatecontractlength') + @field_validator('d_ezmaxinvoicing_rebatecontractlength') def d_ezmaxinvoicing_rebatecontractlength_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^-{0,1}[\d]{1,3}?\.[\d]{2}$", value): raise ValueError(r"must validate the regular expression /^-{0,1}[\d]{1,3}?\.[\d]{2}$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzmaxinvoicingResponseCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzmaxinvoicingResponseCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_audit if self.obj_audit: _dict['objAudit'] = self.obj_audit.to_dict() @@ -160,37 +179,37 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzmaxinvoicingResponseCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzmaxinvoicingResponseCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzmaxinvoicingResponseCompound.parse_obj(obj) - - _obj = EzmaxinvoicingResponseCompound.parse_obj({ - "pki_ezmaxinvoicing_id": obj.get("pkiEzmaxinvoicingID"), - "fki_ezmaxinvoicingcontract_id": obj.get("fkiEzmaxinvoicingcontractID"), - "fki_ezmaxpricing_id": obj.get("fkiEzmaxpricingID"), - "fki_systemconfigurationtype_id": obj.get("fkiSystemconfigurationtypeID"), - "s_systemconfigurationtype_description_x": obj.get("sSystemconfigurationtypeDescriptionX"), - "yyyymm_ezmaxinvoicing": obj.get("yyyymmEzmaxinvoicing"), - "i_ezmaxinvoicing_days": obj.get("iEzmaxinvoicingDays"), - "e_ezmaxinvoicing_paymenttype": obj.get("eEzmaxinvoicingPaymenttype"), - "d_ezmaxinvoicing_rebatepaymenttype": obj.get("dEzmaxinvoicingRebatepaymenttype"), - "i_ezmaxinvoicing_contractlength": obj.get("iEzmaxinvoicingContractlength"), - "d_ezmaxinvoicing_rebatecontractlength": obj.get("dEzmaxinvoicingRebatecontractlength"), - "b_ezmaxinvoicing_rebate_ezsignallagents": obj.get("bEzmaxinvoicingRebateEzsignallagents"), - "obj_audit": CommonAudit.from_dict(obj.get("objAudit")) if obj.get("objAudit") is not None else None, - "obj_ezmaxinvoicingcontract": EzmaxinvoicingcontractResponseCompound.from_dict(obj.get("objEzmaxinvoicingcontract")) if obj.get("objEzmaxinvoicingcontract") is not None else None, - "obj_ezmaxpricing": CustomEzmaxpricingResponse.from_dict(obj.get("objEzmaxpricing")) if obj.get("objEzmaxpricing") is not None else None, - "a_obj_ezmaxinvoicingsummaryglobal": [EzmaxinvoicingsummaryglobalResponseCompound.from_dict(_item) for _item in obj.get("a_objEzmaxinvoicingsummaryglobal")] if obj.get("a_objEzmaxinvoicingsummaryglobal") is not None else None, - "a_obj_ezmaxinvoicingsummaryexternal": [EzmaxinvoicingsummaryexternalResponseCompound.from_dict(_item) for _item in obj.get("a_objEzmaxinvoicingsummaryexternal")] if obj.get("a_objEzmaxinvoicingsummaryexternal") is not None else None, - "a_obj_ezmaxinvoicingsummaryinternal": [EzmaxinvoicingsummaryinternalResponseCompound.from_dict(_item) for _item in obj.get("a_objEzmaxinvoicingsummaryinternal")] if obj.get("a_objEzmaxinvoicingsummaryinternal") is not None else None, - "a_obj_ezmaxinvoicingagent": [EzmaxinvoicingagentResponseCompound.from_dict(_item) for _item in obj.get("a_objEzmaxinvoicingagent")] if obj.get("a_objEzmaxinvoicingagent") is not None else None, - "a_obj_ezmaxinvoicinguser": [EzmaxinvoicinguserResponseCompound.from_dict(_item) for _item in obj.get("a_objEzmaxinvoicinguser")] if obj.get("a_objEzmaxinvoicinguser") is not None else None, - "a_obj_ezmaxinvoicingezsignfolder": [CustomEzmaxinvoicingEzsignfolderResponse.from_dict(_item) for _item in obj.get("a_objEzmaxinvoicingezsignfolder")] if obj.get("a_objEzmaxinvoicingezsignfolder") is not None else None, - "a_obj_ezmaxinvoicingezsigndocument": [CustomEzmaxinvoicingEzsigndocumentResponse.from_dict(_item) for _item in obj.get("a_objEzmaxinvoicingezsigndocument")] if obj.get("a_objEzmaxinvoicingezsigndocument") is not None else None + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzmaxinvoicingID": obj.get("pkiEzmaxinvoicingID"), + "fkiEzmaxinvoicingcontractID": obj.get("fkiEzmaxinvoicingcontractID"), + "fkiEzmaxpricingID": obj.get("fkiEzmaxpricingID"), + "fkiSystemconfigurationtypeID": obj.get("fkiSystemconfigurationtypeID"), + "sSystemconfigurationtypeDescriptionX": obj.get("sSystemconfigurationtypeDescriptionX"), + "yyyymmEzmaxinvoicing": obj.get("yyyymmEzmaxinvoicing"), + "iEzmaxinvoicingDays": obj.get("iEzmaxinvoicingDays"), + "eEzmaxinvoicingPaymenttype": obj.get("eEzmaxinvoicingPaymenttype"), + "dEzmaxinvoicingRebatepaymenttype": obj.get("dEzmaxinvoicingRebatepaymenttype"), + "iEzmaxinvoicingContractlength": obj.get("iEzmaxinvoicingContractlength"), + "dEzmaxinvoicingRebatecontractlength": obj.get("dEzmaxinvoicingRebatecontractlength"), + "bEzmaxinvoicingRebateEzsignallagents": obj.get("bEzmaxinvoicingRebateEzsignallagents"), + "objAudit": CommonAudit.from_dict(obj.get("objAudit")) if obj.get("objAudit") is not None else None, + "objEzmaxinvoicingcontract": EzmaxinvoicingcontractResponseCompound.from_dict(obj.get("objEzmaxinvoicingcontract")) if obj.get("objEzmaxinvoicingcontract") is not None else None, + "objEzmaxpricing": CustomEzmaxpricingResponse.from_dict(obj.get("objEzmaxpricing")) if obj.get("objEzmaxpricing") is not None else None, + "a_objEzmaxinvoicingsummaryglobal": [EzmaxinvoicingsummaryglobalResponseCompound.from_dict(_item) for _item in obj.get("a_objEzmaxinvoicingsummaryglobal")] if obj.get("a_objEzmaxinvoicingsummaryglobal") is not None else None, + "a_objEzmaxinvoicingsummaryexternal": [EzmaxinvoicingsummaryexternalResponseCompound.from_dict(_item) for _item in obj.get("a_objEzmaxinvoicingsummaryexternal")] if obj.get("a_objEzmaxinvoicingsummaryexternal") is not None else None, + "a_objEzmaxinvoicingsummaryinternal": [EzmaxinvoicingsummaryinternalResponseCompound.from_dict(_item) for _item in obj.get("a_objEzmaxinvoicingsummaryinternal")] if obj.get("a_objEzmaxinvoicingsummaryinternal") is not None else None, + "a_objEzmaxinvoicingagent": [EzmaxinvoicingagentResponseCompound.from_dict(_item) for _item in obj.get("a_objEzmaxinvoicingagent")] if obj.get("a_objEzmaxinvoicingagent") is not None else None, + "a_objEzmaxinvoicinguser": [EzmaxinvoicinguserResponseCompound.from_dict(_item) for _item in obj.get("a_objEzmaxinvoicinguser")] if obj.get("a_objEzmaxinvoicinguser") is not None else None, + "a_objEzmaxinvoicingezsignfolder": [CustomEzmaxinvoicingEzsignfolderResponse.from_dict(_item) for _item in obj.get("a_objEzmaxinvoicingezsignfolder")] if obj.get("a_objEzmaxinvoicingezsignfolder") is not None else None, + "a_objEzmaxinvoicingezsigndocument": [CustomEzmaxinvoicingEzsigndocumentResponse.from_dict(_item) for _item in obj.get("a_objEzmaxinvoicingezsigndocument")] if obj.get("a_objEzmaxinvoicingezsigndocument") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezmaxinvoicingagent_response.py b/eZmaxApi/models/ezmaxinvoicingagent_response.py index 4d580dd1e..a89f80459 100644 --- a/eZmaxApi/models/ezmaxinvoicingagent_response.py +++ b/eZmaxApi/models/ezmaxinvoicingagent_response.py @@ -19,93 +19,112 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, StrictStr +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.field_e_ezmaxinvoicingagent_variationezmax import FieldEEzmaxinvoicingagentVariationezmax from eZmaxApi.models.field_e_ezmaxinvoicingagent_variationezsign import FieldEEzmaxinvoicingagentVariationezsign +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzmaxinvoicingagentResponse(BaseModel): """ - A Ezmaxinvoicingagent Object # noqa: E501 - """ - pki_ezmaxinvoicingagent_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="pkiEzmaxinvoicingagentID", description="The unique ID of the Ezmaxinvoicingagent") - fki_ezmaxinvoicing_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiEzmaxinvoicingID", description="The unique ID of the Ezmaxinvoicing") - fki_billingentityinternal_id: conint(strict=True, ge=0) = Field(..., alias="fkiBillingentityinternalID", description="The unique ID of the Billingentityinternal.") - s_billingentityinternal_description_x: StrictStr = Field(..., alias="sBillingentityinternalDescriptionX", description="The description of the Billingentityinternal in the language of the requester") - fki_agent_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiAgentID", description="The unique ID of the Agent.") - fki_broker_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiBrokerID", description="The unique ID of the Broker.") - i_ezmaxinvoicingagent_session: conint(strict=True, ge=0) = Field(..., alias="iEzmaxinvoicingagentSession", description="The number of sessions") - i_ezmaxinvoicingagent_cloned: conint(strict=True, ge=0) = Field(..., alias="iEzmaxinvoicingagentCloned", description="The number of times this user was cloned") - i_ezmaxinvoicingagent_invoice: conint(strict=True, ge=0) = Field(..., alias="iEzmaxinvoicingagentInvoice", description="The number of invoices") - i_ezmaxinvoicingagent_inscription: conint(strict=True, ge=0) = Field(..., alias="iEzmaxinvoicingagentInscription", description="The number of inscriptions") - i_ezmaxinvoicingagent_inscriptionactive: conint(strict=True, ge=0) = Field(..., alias="iEzmaxinvoicingagentInscriptionactive", description="The number of active inscriptions") - i_ezmaxinvoicingagent_sale: conint(strict=True, ge=0) = Field(..., alias="iEzmaxinvoicingagentSale", description="The number of sales") - i_ezmaxinvoicingagent_otherincome: conint(strict=True, ge=0) = Field(..., alias="iEzmaxinvoicingagentOtherincome", description="The number of otherincomes") - i_ezmaxinvoicingagent_commissioncalculation: conint(strict=True, ge=0) = Field(..., alias="iEzmaxinvoicingagentCommissioncalculation", description="The number of commission calculations") - i_ezmaxinvoicingagent_ezsigndocument: conint(strict=True, ge=0) = Field(..., alias="iEzmaxinvoicingagentEzsigndocument", description="The number of ezsign documents") - b_ezmaxinvoicingagent_ezsignaccount: StrictBool = Field(..., alias="bEzmaxinvoicingagentEzsignaccount", description="Whether the agent has an eZsign account") - b_ezmaxinvoicingagent_billableezmax: StrictBool = Field(..., alias="bEzmaxinvoicingagentBillableezmax", description="Whether it is billable for eZmax") - e_ezmaxinvoicingagent_variationezmax: FieldEEzmaxinvoicingagentVariationezmax = Field(..., alias="eEzmaxinvoicingagentVariationezmax") - b_ezmaxinvoicingagent_billableezsign: StrictBool = Field(..., alias="bEzmaxinvoicingagentBillableezsign", description="Whether it is billable for eZsign") - e_ezmaxinvoicingagent_variationezsign: FieldEEzmaxinvoicingagentVariationezsign = Field(..., alias="eEzmaxinvoicingagentVariationezsign") - __properties = ["pkiEzmaxinvoicingagentID", "fkiEzmaxinvoicingID", "fkiBillingentityinternalID", "sBillingentityinternalDescriptionX", "fkiAgentID", "fkiBrokerID", "iEzmaxinvoicingagentSession", "iEzmaxinvoicingagentCloned", "iEzmaxinvoicingagentInvoice", "iEzmaxinvoicingagentInscription", "iEzmaxinvoicingagentInscriptionactive", "iEzmaxinvoicingagentSale", "iEzmaxinvoicingagentOtherincome", "iEzmaxinvoicingagentCommissioncalculation", "iEzmaxinvoicingagentEzsigndocument", "bEzmaxinvoicingagentEzsignaccount", "bEzmaxinvoicingagentBillableezmax", "eEzmaxinvoicingagentVariationezmax", "bEzmaxinvoicingagentBillableezsign", "eEzmaxinvoicingagentVariationezsign"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + A Ezmaxinvoicingagent Object + """ # noqa: E501 + pki_ezmaxinvoicingagent_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezmaxinvoicingagent", alias="pkiEzmaxinvoicingagentID") + fki_ezmaxinvoicing_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezmaxinvoicing", alias="fkiEzmaxinvoicingID") + fki_billingentityinternal_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Billingentityinternal.", alias="fkiBillingentityinternalID") + s_billingentityinternal_description_x: StrictStr = Field(description="The description of the Billingentityinternal in the language of the requester", alias="sBillingentityinternalDescriptionX") + fki_agent_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Agent.", alias="fkiAgentID") + fki_broker_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Broker.", alias="fkiBrokerID") + i_ezmaxinvoicingagent_session: Annotated[int, Field(strict=True, ge=0)] = Field(description="The number of sessions", alias="iEzmaxinvoicingagentSession") + i_ezmaxinvoicingagent_cloned: Annotated[int, Field(strict=True, ge=0)] = Field(description="The number of times this user was cloned", alias="iEzmaxinvoicingagentCloned") + i_ezmaxinvoicingagent_invoice: Annotated[int, Field(strict=True, ge=0)] = Field(description="The number of invoices", alias="iEzmaxinvoicingagentInvoice") + i_ezmaxinvoicingagent_inscription: Annotated[int, Field(strict=True, ge=0)] = Field(description="The number of inscriptions", alias="iEzmaxinvoicingagentInscription") + i_ezmaxinvoicingagent_inscriptionactive: Annotated[int, Field(strict=True, ge=0)] = Field(description="The number of active inscriptions", alias="iEzmaxinvoicingagentInscriptionactive") + i_ezmaxinvoicingagent_sale: Annotated[int, Field(strict=True, ge=0)] = Field(description="The number of sales", alias="iEzmaxinvoicingagentSale") + i_ezmaxinvoicingagent_otherincome: Annotated[int, Field(strict=True, ge=0)] = Field(description="The number of otherincomes", alias="iEzmaxinvoicingagentOtherincome") + i_ezmaxinvoicingagent_commissioncalculation: Annotated[int, Field(strict=True, ge=0)] = Field(description="The number of commission calculations", alias="iEzmaxinvoicingagentCommissioncalculation") + i_ezmaxinvoicingagent_ezsigndocument: Annotated[int, Field(strict=True, ge=0)] = Field(description="The number of ezsign documents", alias="iEzmaxinvoicingagentEzsigndocument") + b_ezmaxinvoicingagent_ezsignaccount: StrictBool = Field(description="Whether the agent has an eZsign account", alias="bEzmaxinvoicingagentEzsignaccount") + b_ezmaxinvoicingagent_billableezmax: StrictBool = Field(description="Whether it is billable for eZmax", alias="bEzmaxinvoicingagentBillableezmax") + e_ezmaxinvoicingagent_variationezmax: FieldEEzmaxinvoicingagentVariationezmax = Field(alias="eEzmaxinvoicingagentVariationezmax") + b_ezmaxinvoicingagent_billableezsign: StrictBool = Field(description="Whether it is billable for eZsign", alias="bEzmaxinvoicingagentBillableezsign") + e_ezmaxinvoicingagent_variationezsign: FieldEEzmaxinvoicingagentVariationezsign = Field(alias="eEzmaxinvoicingagentVariationezsign") + __properties: ClassVar[List[str]] = ["pkiEzmaxinvoicingagentID", "fkiEzmaxinvoicingID", "fkiBillingentityinternalID", "sBillingentityinternalDescriptionX", "fkiAgentID", "fkiBrokerID", "iEzmaxinvoicingagentSession", "iEzmaxinvoicingagentCloned", "iEzmaxinvoicingagentInvoice", "iEzmaxinvoicingagentInscription", "iEzmaxinvoicingagentInscriptionactive", "iEzmaxinvoicingagentSale", "iEzmaxinvoicingagentOtherincome", "iEzmaxinvoicingagentCommissioncalculation", "iEzmaxinvoicingagentEzsigndocument", "bEzmaxinvoicingagentEzsignaccount", "bEzmaxinvoicingagentBillableezmax", "eEzmaxinvoicingagentVariationezmax", "bEzmaxinvoicingagentBillableezsign", "eEzmaxinvoicingagentVariationezsign"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzmaxinvoicingagentResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzmaxinvoicingagentResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzmaxinvoicingagentResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzmaxinvoicingagentResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzmaxinvoicingagentResponse.parse_obj(obj) - - _obj = EzmaxinvoicingagentResponse.parse_obj({ - "pki_ezmaxinvoicingagent_id": obj.get("pkiEzmaxinvoicingagentID"), - "fki_ezmaxinvoicing_id": obj.get("fkiEzmaxinvoicingID"), - "fki_billingentityinternal_id": obj.get("fkiBillingentityinternalID"), - "s_billingentityinternal_description_x": obj.get("sBillingentityinternalDescriptionX"), - "fki_agent_id": obj.get("fkiAgentID"), - "fki_broker_id": obj.get("fkiBrokerID"), - "i_ezmaxinvoicingagent_session": obj.get("iEzmaxinvoicingagentSession"), - "i_ezmaxinvoicingagent_cloned": obj.get("iEzmaxinvoicingagentCloned"), - "i_ezmaxinvoicingagent_invoice": obj.get("iEzmaxinvoicingagentInvoice"), - "i_ezmaxinvoicingagent_inscription": obj.get("iEzmaxinvoicingagentInscription"), - "i_ezmaxinvoicingagent_inscriptionactive": obj.get("iEzmaxinvoicingagentInscriptionactive"), - "i_ezmaxinvoicingagent_sale": obj.get("iEzmaxinvoicingagentSale"), - "i_ezmaxinvoicingagent_otherincome": obj.get("iEzmaxinvoicingagentOtherincome"), - "i_ezmaxinvoicingagent_commissioncalculation": obj.get("iEzmaxinvoicingagentCommissioncalculation"), - "i_ezmaxinvoicingagent_ezsigndocument": obj.get("iEzmaxinvoicingagentEzsigndocument"), - "b_ezmaxinvoicingagent_ezsignaccount": obj.get("bEzmaxinvoicingagentEzsignaccount"), - "b_ezmaxinvoicingagent_billableezmax": obj.get("bEzmaxinvoicingagentBillableezmax"), - "e_ezmaxinvoicingagent_variationezmax": obj.get("eEzmaxinvoicingagentVariationezmax"), - "b_ezmaxinvoicingagent_billableezsign": obj.get("bEzmaxinvoicingagentBillableezsign"), - "e_ezmaxinvoicingagent_variationezsign": obj.get("eEzmaxinvoicingagentVariationezsign") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzmaxinvoicingagentID": obj.get("pkiEzmaxinvoicingagentID"), + "fkiEzmaxinvoicingID": obj.get("fkiEzmaxinvoicingID"), + "fkiBillingentityinternalID": obj.get("fkiBillingentityinternalID"), + "sBillingentityinternalDescriptionX": obj.get("sBillingentityinternalDescriptionX"), + "fkiAgentID": obj.get("fkiAgentID"), + "fkiBrokerID": obj.get("fkiBrokerID"), + "iEzmaxinvoicingagentSession": obj.get("iEzmaxinvoicingagentSession"), + "iEzmaxinvoicingagentCloned": obj.get("iEzmaxinvoicingagentCloned"), + "iEzmaxinvoicingagentInvoice": obj.get("iEzmaxinvoicingagentInvoice"), + "iEzmaxinvoicingagentInscription": obj.get("iEzmaxinvoicingagentInscription"), + "iEzmaxinvoicingagentInscriptionactive": obj.get("iEzmaxinvoicingagentInscriptionactive"), + "iEzmaxinvoicingagentSale": obj.get("iEzmaxinvoicingagentSale"), + "iEzmaxinvoicingagentOtherincome": obj.get("iEzmaxinvoicingagentOtherincome"), + "iEzmaxinvoicingagentCommissioncalculation": obj.get("iEzmaxinvoicingagentCommissioncalculation"), + "iEzmaxinvoicingagentEzsigndocument": obj.get("iEzmaxinvoicingagentEzsigndocument"), + "bEzmaxinvoicingagentEzsignaccount": obj.get("bEzmaxinvoicingagentEzsignaccount"), + "bEzmaxinvoicingagentBillableezmax": obj.get("bEzmaxinvoicingagentBillableezmax"), + "eEzmaxinvoicingagentVariationezmax": obj.get("eEzmaxinvoicingagentVariationezmax"), + "bEzmaxinvoicingagentBillableezsign": obj.get("bEzmaxinvoicingagentBillableezsign"), + "eEzmaxinvoicingagentVariationezsign": obj.get("eEzmaxinvoicingagentVariationezsign") }) return _obj diff --git a/eZmaxApi/models/ezmaxinvoicingagent_response_compound.py b/eZmaxApi/models/ezmaxinvoicingagent_response_compound.py index bc5183d06..d721b5778 100644 --- a/eZmaxApi/models/ezmaxinvoicingagent_response_compound.py +++ b/eZmaxApi/models/ezmaxinvoicingagent_response_compound.py @@ -19,99 +19,118 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, StrictStr +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.custom_contact_name_response import CustomContactNameResponse from eZmaxApi.models.field_e_ezmaxinvoicingagent_variationezmax import FieldEEzmaxinvoicingagentVariationezmax from eZmaxApi.models.field_e_ezmaxinvoicingagent_variationezsign import FieldEEzmaxinvoicingagentVariationezsign +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzmaxinvoicingagentResponseCompound(BaseModel): """ - A Ezmaxinvoicingagent Object # noqa: E501 - """ - pki_ezmaxinvoicingagent_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="pkiEzmaxinvoicingagentID", description="The unique ID of the Ezmaxinvoicingagent") - fki_ezmaxinvoicing_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiEzmaxinvoicingID", description="The unique ID of the Ezmaxinvoicing") - fki_billingentityinternal_id: conint(strict=True, ge=0) = Field(..., alias="fkiBillingentityinternalID", description="The unique ID of the Billingentityinternal.") - s_billingentityinternal_description_x: StrictStr = Field(..., alias="sBillingentityinternalDescriptionX", description="The description of the Billingentityinternal in the language of the requester") - fki_agent_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiAgentID", description="The unique ID of the Agent.") - fki_broker_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiBrokerID", description="The unique ID of the Broker.") - i_ezmaxinvoicingagent_session: conint(strict=True, ge=0) = Field(..., alias="iEzmaxinvoicingagentSession", description="The number of sessions") - i_ezmaxinvoicingagent_cloned: conint(strict=True, ge=0) = Field(..., alias="iEzmaxinvoicingagentCloned", description="The number of times this user was cloned") - i_ezmaxinvoicingagent_invoice: conint(strict=True, ge=0) = Field(..., alias="iEzmaxinvoicingagentInvoice", description="The number of invoices") - i_ezmaxinvoicingagent_inscription: conint(strict=True, ge=0) = Field(..., alias="iEzmaxinvoicingagentInscription", description="The number of inscriptions") - i_ezmaxinvoicingagent_inscriptionactive: conint(strict=True, ge=0) = Field(..., alias="iEzmaxinvoicingagentInscriptionactive", description="The number of active inscriptions") - i_ezmaxinvoicingagent_sale: conint(strict=True, ge=0) = Field(..., alias="iEzmaxinvoicingagentSale", description="The number of sales") - i_ezmaxinvoicingagent_otherincome: conint(strict=True, ge=0) = Field(..., alias="iEzmaxinvoicingagentOtherincome", description="The number of otherincomes") - i_ezmaxinvoicingagent_commissioncalculation: conint(strict=True, ge=0) = Field(..., alias="iEzmaxinvoicingagentCommissioncalculation", description="The number of commission calculations") - i_ezmaxinvoicingagent_ezsigndocument: conint(strict=True, ge=0) = Field(..., alias="iEzmaxinvoicingagentEzsigndocument", description="The number of ezsign documents") - b_ezmaxinvoicingagent_ezsignaccount: StrictBool = Field(..., alias="bEzmaxinvoicingagentEzsignaccount", description="Whether the agent has an eZsign account") - b_ezmaxinvoicingagent_billableezmax: StrictBool = Field(..., alias="bEzmaxinvoicingagentBillableezmax", description="Whether it is billable for eZmax") - e_ezmaxinvoicingagent_variationezmax: FieldEEzmaxinvoicingagentVariationezmax = Field(..., alias="eEzmaxinvoicingagentVariationezmax") - b_ezmaxinvoicingagent_billableezsign: StrictBool = Field(..., alias="bEzmaxinvoicingagentBillableezsign", description="Whether it is billable for eZsign") - e_ezmaxinvoicingagent_variationezsign: FieldEEzmaxinvoicingagentVariationezsign = Field(..., alias="eEzmaxinvoicingagentVariationezsign") - obj_contact_name: CustomContactNameResponse = Field(..., alias="objContactName") - __properties = ["pkiEzmaxinvoicingagentID", "fkiEzmaxinvoicingID", "fkiBillingentityinternalID", "sBillingentityinternalDescriptionX", "fkiAgentID", "fkiBrokerID", "iEzmaxinvoicingagentSession", "iEzmaxinvoicingagentCloned", "iEzmaxinvoicingagentInvoice", "iEzmaxinvoicingagentInscription", "iEzmaxinvoicingagentInscriptionactive", "iEzmaxinvoicingagentSale", "iEzmaxinvoicingagentOtherincome", "iEzmaxinvoicingagentCommissioncalculation", "iEzmaxinvoicingagentEzsigndocument", "bEzmaxinvoicingagentEzsignaccount", "bEzmaxinvoicingagentBillableezmax", "eEzmaxinvoicingagentVariationezmax", "bEzmaxinvoicingagentBillableezsign", "eEzmaxinvoicingagentVariationezsign", "objContactName"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + A Ezmaxinvoicingagent Object + """ # noqa: E501 + pki_ezmaxinvoicingagent_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezmaxinvoicingagent", alias="pkiEzmaxinvoicingagentID") + fki_ezmaxinvoicing_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezmaxinvoicing", alias="fkiEzmaxinvoicingID") + fki_billingentityinternal_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Billingentityinternal.", alias="fkiBillingentityinternalID") + s_billingentityinternal_description_x: StrictStr = Field(description="The description of the Billingentityinternal in the language of the requester", alias="sBillingentityinternalDescriptionX") + fki_agent_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Agent.", alias="fkiAgentID") + fki_broker_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Broker.", alias="fkiBrokerID") + i_ezmaxinvoicingagent_session: Annotated[int, Field(strict=True, ge=0)] = Field(description="The number of sessions", alias="iEzmaxinvoicingagentSession") + i_ezmaxinvoicingagent_cloned: Annotated[int, Field(strict=True, ge=0)] = Field(description="The number of times this user was cloned", alias="iEzmaxinvoicingagentCloned") + i_ezmaxinvoicingagent_invoice: Annotated[int, Field(strict=True, ge=0)] = Field(description="The number of invoices", alias="iEzmaxinvoicingagentInvoice") + i_ezmaxinvoicingagent_inscription: Annotated[int, Field(strict=True, ge=0)] = Field(description="The number of inscriptions", alias="iEzmaxinvoicingagentInscription") + i_ezmaxinvoicingagent_inscriptionactive: Annotated[int, Field(strict=True, ge=0)] = Field(description="The number of active inscriptions", alias="iEzmaxinvoicingagentInscriptionactive") + i_ezmaxinvoicingagent_sale: Annotated[int, Field(strict=True, ge=0)] = Field(description="The number of sales", alias="iEzmaxinvoicingagentSale") + i_ezmaxinvoicingagent_otherincome: Annotated[int, Field(strict=True, ge=0)] = Field(description="The number of otherincomes", alias="iEzmaxinvoicingagentOtherincome") + i_ezmaxinvoicingagent_commissioncalculation: Annotated[int, Field(strict=True, ge=0)] = Field(description="The number of commission calculations", alias="iEzmaxinvoicingagentCommissioncalculation") + i_ezmaxinvoicingagent_ezsigndocument: Annotated[int, Field(strict=True, ge=0)] = Field(description="The number of ezsign documents", alias="iEzmaxinvoicingagentEzsigndocument") + b_ezmaxinvoicingagent_ezsignaccount: StrictBool = Field(description="Whether the agent has an eZsign account", alias="bEzmaxinvoicingagentEzsignaccount") + b_ezmaxinvoicingagent_billableezmax: StrictBool = Field(description="Whether it is billable for eZmax", alias="bEzmaxinvoicingagentBillableezmax") + e_ezmaxinvoicingagent_variationezmax: FieldEEzmaxinvoicingagentVariationezmax = Field(alias="eEzmaxinvoicingagentVariationezmax") + b_ezmaxinvoicingagent_billableezsign: StrictBool = Field(description="Whether it is billable for eZsign", alias="bEzmaxinvoicingagentBillableezsign") + e_ezmaxinvoicingagent_variationezsign: FieldEEzmaxinvoicingagentVariationezsign = Field(alias="eEzmaxinvoicingagentVariationezsign") + obj_contact_name: CustomContactNameResponse = Field(alias="objContactName") + __properties: ClassVar[List[str]] = ["pkiEzmaxinvoicingagentID", "fkiEzmaxinvoicingID", "fkiBillingentityinternalID", "sBillingentityinternalDescriptionX", "fkiAgentID", "fkiBrokerID", "iEzmaxinvoicingagentSession", "iEzmaxinvoicingagentCloned", "iEzmaxinvoicingagentInvoice", "iEzmaxinvoicingagentInscription", "iEzmaxinvoicingagentInscriptionactive", "iEzmaxinvoicingagentSale", "iEzmaxinvoicingagentOtherincome", "iEzmaxinvoicingagentCommissioncalculation", "iEzmaxinvoicingagentEzsigndocument", "bEzmaxinvoicingagentEzsignaccount", "bEzmaxinvoicingagentBillableezmax", "eEzmaxinvoicingagentVariationezmax", "bEzmaxinvoicingagentBillableezsign", "eEzmaxinvoicingagentVariationezsign", "objContactName"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzmaxinvoicingagentResponseCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzmaxinvoicingagentResponseCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_contact_name if self.obj_contact_name: _dict['objContactName'] = self.obj_contact_name.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> EzmaxinvoicingagentResponseCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzmaxinvoicingagentResponseCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzmaxinvoicingagentResponseCompound.parse_obj(obj) - - _obj = EzmaxinvoicingagentResponseCompound.parse_obj({ - "pki_ezmaxinvoicingagent_id": obj.get("pkiEzmaxinvoicingagentID"), - "fki_ezmaxinvoicing_id": obj.get("fkiEzmaxinvoicingID"), - "fki_billingentityinternal_id": obj.get("fkiBillingentityinternalID"), - "s_billingentityinternal_description_x": obj.get("sBillingentityinternalDescriptionX"), - "fki_agent_id": obj.get("fkiAgentID"), - "fki_broker_id": obj.get("fkiBrokerID"), - "i_ezmaxinvoicingagent_session": obj.get("iEzmaxinvoicingagentSession"), - "i_ezmaxinvoicingagent_cloned": obj.get("iEzmaxinvoicingagentCloned"), - "i_ezmaxinvoicingagent_invoice": obj.get("iEzmaxinvoicingagentInvoice"), - "i_ezmaxinvoicingagent_inscription": obj.get("iEzmaxinvoicingagentInscription"), - "i_ezmaxinvoicingagent_inscriptionactive": obj.get("iEzmaxinvoicingagentInscriptionactive"), - "i_ezmaxinvoicingagent_sale": obj.get("iEzmaxinvoicingagentSale"), - "i_ezmaxinvoicingagent_otherincome": obj.get("iEzmaxinvoicingagentOtherincome"), - "i_ezmaxinvoicingagent_commissioncalculation": obj.get("iEzmaxinvoicingagentCommissioncalculation"), - "i_ezmaxinvoicingagent_ezsigndocument": obj.get("iEzmaxinvoicingagentEzsigndocument"), - "b_ezmaxinvoicingagent_ezsignaccount": obj.get("bEzmaxinvoicingagentEzsignaccount"), - "b_ezmaxinvoicingagent_billableezmax": obj.get("bEzmaxinvoicingagentBillableezmax"), - "e_ezmaxinvoicingagent_variationezmax": obj.get("eEzmaxinvoicingagentVariationezmax"), - "b_ezmaxinvoicingagent_billableezsign": obj.get("bEzmaxinvoicingagentBillableezsign"), - "e_ezmaxinvoicingagent_variationezsign": obj.get("eEzmaxinvoicingagentVariationezsign"), - "obj_contact_name": CustomContactNameResponse.from_dict(obj.get("objContactName")) if obj.get("objContactName") is not None else None + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzmaxinvoicingagentID": obj.get("pkiEzmaxinvoicingagentID"), + "fkiEzmaxinvoicingID": obj.get("fkiEzmaxinvoicingID"), + "fkiBillingentityinternalID": obj.get("fkiBillingentityinternalID"), + "sBillingentityinternalDescriptionX": obj.get("sBillingentityinternalDescriptionX"), + "fkiAgentID": obj.get("fkiAgentID"), + "fkiBrokerID": obj.get("fkiBrokerID"), + "iEzmaxinvoicingagentSession": obj.get("iEzmaxinvoicingagentSession"), + "iEzmaxinvoicingagentCloned": obj.get("iEzmaxinvoicingagentCloned"), + "iEzmaxinvoicingagentInvoice": obj.get("iEzmaxinvoicingagentInvoice"), + "iEzmaxinvoicingagentInscription": obj.get("iEzmaxinvoicingagentInscription"), + "iEzmaxinvoicingagentInscriptionactive": obj.get("iEzmaxinvoicingagentInscriptionactive"), + "iEzmaxinvoicingagentSale": obj.get("iEzmaxinvoicingagentSale"), + "iEzmaxinvoicingagentOtherincome": obj.get("iEzmaxinvoicingagentOtherincome"), + "iEzmaxinvoicingagentCommissioncalculation": obj.get("iEzmaxinvoicingagentCommissioncalculation"), + "iEzmaxinvoicingagentEzsigndocument": obj.get("iEzmaxinvoicingagentEzsigndocument"), + "bEzmaxinvoicingagentEzsignaccount": obj.get("bEzmaxinvoicingagentEzsignaccount"), + "bEzmaxinvoicingagentBillableezmax": obj.get("bEzmaxinvoicingagentBillableezmax"), + "eEzmaxinvoicingagentVariationezmax": obj.get("eEzmaxinvoicingagentVariationezmax"), + "bEzmaxinvoicingagentBillableezsign": obj.get("bEzmaxinvoicingagentBillableezsign"), + "eEzmaxinvoicingagentVariationezsign": obj.get("eEzmaxinvoicingagentVariationezsign"), + "objContactName": CustomContactNameResponse.from_dict(obj.get("objContactName")) if obj.get("objContactName") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezmaxinvoicingcommission_response.py b/eZmaxApi/models/ezmaxinvoicingcommission_response.py index fd604b976..3ca6a1b43 100644 --- a/eZmaxApi/models/ezmaxinvoicingcommission_response.py +++ b/eZmaxApi/models/ezmaxinvoicingcommission_response.py @@ -19,74 +19,93 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictInt, StrictStr, conint, constr, validator +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictInt, StrictStr, field_validator +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzmaxinvoicingcommissionResponse(BaseModel): """ - A Ezmaxinvoicingcommission Object # noqa: E501 - """ - pki_ezmaxinvoicingcommission_id: Optional[StrictInt] = Field(None, alias="pkiEzmaxinvoicingcommissionID", description="The unique ID of the Ezmaxinvoicingcommission") - fki_ezmaxinvoicingsummaryglobal_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiEzmaxinvoicingsummaryglobalID", description="The unique ID of the Ezmaxinvoicingsummaryglobal") - fki_ezmaxpartner_id: Optional[conint(strict=True, ge=1)] = Field(None, alias="fkiEzmaxpartnerID", description="The unique ID of the Ezmaxpartner") - fki_ezmaxrepresentative_id: Optional[conint(strict=True, ge=1)] = Field(None, alias="fkiEzmaxrepresentativeID", description="The unique ID of the Ezmaxrepresentative") - dt_ezmaxinvoicingcommission_start: StrictStr = Field(..., alias="dtEzmaxinvoicingcommissionStart", description="The start date for the Ezmaxinvoicingcommission") - dt_ezmaxinvoicingcommission_end: StrictStr = Field(..., alias="dtEzmaxinvoicingcommissionEnd", description="The end date for the Ezmaxinvoicingcommission") - i_ezmaxinvoicingcommission_days: conint(strict=True, ge=0) = Field(..., alias="iEzmaxinvoicingcommissionDays", description="This is the number of days during the month on which the Ezmaxinvoigcommission applies") - d_ezmaxinvoicingcommission_amount: constr(strict=True) = Field(..., alias="dEzmaxinvoicingcommissionAmount", description="The amount of Ezmaxinvoicingcommission") - __properties = ["pkiEzmaxinvoicingcommissionID", "fkiEzmaxinvoicingsummaryglobalID", "fkiEzmaxpartnerID", "fkiEzmaxrepresentativeID", "dtEzmaxinvoicingcommissionStart", "dtEzmaxinvoicingcommissionEnd", "iEzmaxinvoicingcommissionDays", "dEzmaxinvoicingcommissionAmount"] - - @validator('d_ezmaxinvoicingcommission_amount') + A Ezmaxinvoicingcommission Object + """ # noqa: E501 + pki_ezmaxinvoicingcommission_id: Optional[StrictInt] = Field(default=None, description="The unique ID of the Ezmaxinvoicingcommission", alias="pkiEzmaxinvoicingcommissionID") + fki_ezmaxinvoicingsummaryglobal_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezmaxinvoicingsummaryglobal", alias="fkiEzmaxinvoicingsummaryglobalID") + fki_ezmaxpartner_id: Optional[Annotated[int, Field(strict=True, ge=1)]] = Field(default=None, description="The unique ID of the Ezmaxpartner", alias="fkiEzmaxpartnerID") + fki_ezmaxrepresentative_id: Optional[Annotated[int, Field(strict=True, ge=1)]] = Field(default=None, description="The unique ID of the Ezmaxrepresentative", alias="fkiEzmaxrepresentativeID") + dt_ezmaxinvoicingcommission_start: StrictStr = Field(description="The start date for the Ezmaxinvoicingcommission", alias="dtEzmaxinvoicingcommissionStart") + dt_ezmaxinvoicingcommission_end: StrictStr = Field(description="The end date for the Ezmaxinvoicingcommission", alias="dtEzmaxinvoicingcommissionEnd") + i_ezmaxinvoicingcommission_days: Annotated[int, Field(strict=True, ge=0)] = Field(description="This is the number of days during the month on which the Ezmaxinvoigcommission applies", alias="iEzmaxinvoicingcommissionDays") + d_ezmaxinvoicingcommission_amount: Annotated[str, Field(strict=True)] = Field(description="The amount of Ezmaxinvoicingcommission", alias="dEzmaxinvoicingcommissionAmount") + __properties: ClassVar[List[str]] = ["pkiEzmaxinvoicingcommissionID", "fkiEzmaxinvoicingsummaryglobalID", "fkiEzmaxpartnerID", "fkiEzmaxrepresentativeID", "dtEzmaxinvoicingcommissionStart", "dtEzmaxinvoicingcommissionEnd", "iEzmaxinvoicingcommissionDays", "dEzmaxinvoicingcommissionAmount"] + + @field_validator('d_ezmaxinvoicingcommission_amount') def d_ezmaxinvoicingcommission_amount_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^-{0,1}[\d]{1,9}?\.[\d]{2}$", value): raise ValueError(r"must validate the regular expression /^-{0,1}[\d]{1,9}?\.[\d]{2}$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzmaxinvoicingcommissionResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzmaxinvoicingcommissionResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzmaxinvoicingcommissionResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzmaxinvoicingcommissionResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzmaxinvoicingcommissionResponse.parse_obj(obj) - - _obj = EzmaxinvoicingcommissionResponse.parse_obj({ - "pki_ezmaxinvoicingcommission_id": obj.get("pkiEzmaxinvoicingcommissionID"), - "fki_ezmaxinvoicingsummaryglobal_id": obj.get("fkiEzmaxinvoicingsummaryglobalID"), - "fki_ezmaxpartner_id": obj.get("fkiEzmaxpartnerID"), - "fki_ezmaxrepresentative_id": obj.get("fkiEzmaxrepresentativeID"), - "dt_ezmaxinvoicingcommission_start": obj.get("dtEzmaxinvoicingcommissionStart"), - "dt_ezmaxinvoicingcommission_end": obj.get("dtEzmaxinvoicingcommissionEnd"), - "i_ezmaxinvoicingcommission_days": obj.get("iEzmaxinvoicingcommissionDays"), - "d_ezmaxinvoicingcommission_amount": obj.get("dEzmaxinvoicingcommissionAmount") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzmaxinvoicingcommissionID": obj.get("pkiEzmaxinvoicingcommissionID"), + "fkiEzmaxinvoicingsummaryglobalID": obj.get("fkiEzmaxinvoicingsummaryglobalID"), + "fkiEzmaxpartnerID": obj.get("fkiEzmaxpartnerID"), + "fkiEzmaxrepresentativeID": obj.get("fkiEzmaxrepresentativeID"), + "dtEzmaxinvoicingcommissionStart": obj.get("dtEzmaxinvoicingcommissionStart"), + "dtEzmaxinvoicingcommissionEnd": obj.get("dtEzmaxinvoicingcommissionEnd"), + "iEzmaxinvoicingcommissionDays": obj.get("iEzmaxinvoicingcommissionDays"), + "dEzmaxinvoicingcommissionAmount": obj.get("dEzmaxinvoicingcommissionAmount") }) return _obj diff --git a/eZmaxApi/models/ezmaxinvoicingcommission_response_compound.py b/eZmaxApi/models/ezmaxinvoicingcommission_response_compound.py index 638120562..1a5a3c24b 100644 --- a/eZmaxApi/models/ezmaxinvoicingcommission_response_compound.py +++ b/eZmaxApi/models/ezmaxinvoicingcommission_response_compound.py @@ -19,80 +19,99 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictInt, StrictStr, conint, constr, validator +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictInt, StrictStr, field_validator +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.custom_contact_name_response import CustomContactNameResponse +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzmaxinvoicingcommissionResponseCompound(BaseModel): """ - A Ezmaxinvoicingcommission Object # noqa: E501 - """ - pki_ezmaxinvoicingcommission_id: Optional[StrictInt] = Field(None, alias="pkiEzmaxinvoicingcommissionID", description="The unique ID of the Ezmaxinvoicingcommission") - fki_ezmaxinvoicingsummaryglobal_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiEzmaxinvoicingsummaryglobalID", description="The unique ID of the Ezmaxinvoicingsummaryglobal") - fki_ezmaxpartner_id: Optional[conint(strict=True, ge=1)] = Field(None, alias="fkiEzmaxpartnerID", description="The unique ID of the Ezmaxpartner") - fki_ezmaxrepresentative_id: Optional[conint(strict=True, ge=1)] = Field(None, alias="fkiEzmaxrepresentativeID", description="The unique ID of the Ezmaxrepresentative") - dt_ezmaxinvoicingcommission_start: StrictStr = Field(..., alias="dtEzmaxinvoicingcommissionStart", description="The start date for the Ezmaxinvoicingcommission") - dt_ezmaxinvoicingcommission_end: StrictStr = Field(..., alias="dtEzmaxinvoicingcommissionEnd", description="The end date for the Ezmaxinvoicingcommission") - i_ezmaxinvoicingcommission_days: conint(strict=True, ge=0) = Field(..., alias="iEzmaxinvoicingcommissionDays", description="This is the number of days during the month on which the Ezmaxinvoigcommission applies") - d_ezmaxinvoicingcommission_amount: constr(strict=True) = Field(..., alias="dEzmaxinvoicingcommissionAmount", description="The amount of Ezmaxinvoicingcommission") - obj_contact_name: Optional[CustomContactNameResponse] = Field(None, alias="objContactName") - __properties = ["pkiEzmaxinvoicingcommissionID", "fkiEzmaxinvoicingsummaryglobalID", "fkiEzmaxpartnerID", "fkiEzmaxrepresentativeID", "dtEzmaxinvoicingcommissionStart", "dtEzmaxinvoicingcommissionEnd", "iEzmaxinvoicingcommissionDays", "dEzmaxinvoicingcommissionAmount", "objContactName"] - - @validator('d_ezmaxinvoicingcommission_amount') + A Ezmaxinvoicingcommission Object + """ # noqa: E501 + pki_ezmaxinvoicingcommission_id: Optional[StrictInt] = Field(default=None, description="The unique ID of the Ezmaxinvoicingcommission", alias="pkiEzmaxinvoicingcommissionID") + fki_ezmaxinvoicingsummaryglobal_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezmaxinvoicingsummaryglobal", alias="fkiEzmaxinvoicingsummaryglobalID") + fki_ezmaxpartner_id: Optional[Annotated[int, Field(strict=True, ge=1)]] = Field(default=None, description="The unique ID of the Ezmaxpartner", alias="fkiEzmaxpartnerID") + fki_ezmaxrepresentative_id: Optional[Annotated[int, Field(strict=True, ge=1)]] = Field(default=None, description="The unique ID of the Ezmaxrepresentative", alias="fkiEzmaxrepresentativeID") + dt_ezmaxinvoicingcommission_start: StrictStr = Field(description="The start date for the Ezmaxinvoicingcommission", alias="dtEzmaxinvoicingcommissionStart") + dt_ezmaxinvoicingcommission_end: StrictStr = Field(description="The end date for the Ezmaxinvoicingcommission", alias="dtEzmaxinvoicingcommissionEnd") + i_ezmaxinvoicingcommission_days: Annotated[int, Field(strict=True, ge=0)] = Field(description="This is the number of days during the month on which the Ezmaxinvoigcommission applies", alias="iEzmaxinvoicingcommissionDays") + d_ezmaxinvoicingcommission_amount: Annotated[str, Field(strict=True)] = Field(description="The amount of Ezmaxinvoicingcommission", alias="dEzmaxinvoicingcommissionAmount") + obj_contact_name: Optional[CustomContactNameResponse] = Field(default=None, alias="objContactName") + __properties: ClassVar[List[str]] = ["pkiEzmaxinvoicingcommissionID", "fkiEzmaxinvoicingsummaryglobalID", "fkiEzmaxpartnerID", "fkiEzmaxrepresentativeID", "dtEzmaxinvoicingcommissionStart", "dtEzmaxinvoicingcommissionEnd", "iEzmaxinvoicingcommissionDays", "dEzmaxinvoicingcommissionAmount", "objContactName"] + + @field_validator('d_ezmaxinvoicingcommission_amount') def d_ezmaxinvoicingcommission_amount_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^-{0,1}[\d]{1,9}?\.[\d]{2}$", value): raise ValueError(r"must validate the regular expression /^-{0,1}[\d]{1,9}?\.[\d]{2}$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzmaxinvoicingcommissionResponseCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzmaxinvoicingcommissionResponseCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_contact_name if self.obj_contact_name: _dict['objContactName'] = self.obj_contact_name.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> EzmaxinvoicingcommissionResponseCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzmaxinvoicingcommissionResponseCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzmaxinvoicingcommissionResponseCompound.parse_obj(obj) - - _obj = EzmaxinvoicingcommissionResponseCompound.parse_obj({ - "pki_ezmaxinvoicingcommission_id": obj.get("pkiEzmaxinvoicingcommissionID"), - "fki_ezmaxinvoicingsummaryglobal_id": obj.get("fkiEzmaxinvoicingsummaryglobalID"), - "fki_ezmaxpartner_id": obj.get("fkiEzmaxpartnerID"), - "fki_ezmaxrepresentative_id": obj.get("fkiEzmaxrepresentativeID"), - "dt_ezmaxinvoicingcommission_start": obj.get("dtEzmaxinvoicingcommissionStart"), - "dt_ezmaxinvoicingcommission_end": obj.get("dtEzmaxinvoicingcommissionEnd"), - "i_ezmaxinvoicingcommission_days": obj.get("iEzmaxinvoicingcommissionDays"), - "d_ezmaxinvoicingcommission_amount": obj.get("dEzmaxinvoicingcommissionAmount"), - "obj_contact_name": CustomContactNameResponse.from_dict(obj.get("objContactName")) if obj.get("objContactName") is not None else None + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzmaxinvoicingcommissionID": obj.get("pkiEzmaxinvoicingcommissionID"), + "fkiEzmaxinvoicingsummaryglobalID": obj.get("fkiEzmaxinvoicingsummaryglobalID"), + "fkiEzmaxpartnerID": obj.get("fkiEzmaxpartnerID"), + "fkiEzmaxrepresentativeID": obj.get("fkiEzmaxrepresentativeID"), + "dtEzmaxinvoicingcommissionStart": obj.get("dtEzmaxinvoicingcommissionStart"), + "dtEzmaxinvoicingcommissionEnd": obj.get("dtEzmaxinvoicingcommissionEnd"), + "iEzmaxinvoicingcommissionDays": obj.get("iEzmaxinvoicingcommissionDays"), + "dEzmaxinvoicingcommissionAmount": obj.get("dEzmaxinvoicingcommissionAmount"), + "objContactName": CustomContactNameResponse.from_dict(obj.get("objContactName")) if obj.get("objContactName") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezmaxinvoicingcontract_response.py b/eZmaxApi/models/ezmaxinvoicingcontract_response.py index 1b5903811..74c6cf888 100644 --- a/eZmaxApi/models/ezmaxinvoicingcontract_response.py +++ b/eZmaxApi/models/ezmaxinvoicingcontract_response.py @@ -19,88 +19,107 @@ import json - -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint, constr, validator +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictBool, StrictStr, field_validator +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.common_audit import CommonAudit from eZmaxApi.models.field_e_ezmaxinvoicingcontract_paymenttype import FieldEEzmaxinvoicingcontractPaymenttype +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzmaxinvoicingcontractResponse(BaseModel): """ - A Ezmaxinvoicingcontract Object # noqa: E501 - """ - pki_ezmaxinvoicingcontract_id: conint(strict=True, ge=1) = Field(..., alias="pkiEzmaxinvoicingcontractID", description="The unique ID of the Ezmaxinvoicingcontract") - e_ezmaxinvoicingcontract_paymenttype: FieldEEzmaxinvoicingcontractPaymenttype = Field(..., alias="eEzmaxinvoicingcontractPaymenttype") - i_ezmaxinvoicingcontract_length: conint(strict=True, ge=1) = Field(..., alias="iEzmaxinvoicingcontractLength", description="The length in years of the Ezmaxinvoicingcontract") - dt_ezmaxinvoicingcontract_start: StrictStr = Field(..., alias="dtEzmaxinvoicingcontractStart", description="The start date of the Ezmaxinvoicingcontract") - dt_ezmaxinvoicingcontract_end: StrictStr = Field(..., alias="dtEzmaxinvoicingcontractEnd", description="The end date of the Ezmaxinvoicingcontract") - d_ezmaxinvoicingcontract_license: constr(strict=True) = Field(..., alias="dEzmaxinvoicingcontractLicense", description="The price of the license") - d_ezmaxinvoicingcontract121qa: constr(strict=True) = Field(..., alias="dEzmaxinvoicingcontract121qa", description="The price for 121QA") - b_ezmaxinvoicingcontract_ezsignallagents: StrictBool = Field(..., alias="bEzmaxinvoicingcontractEzsignallagents", description="Whether eZsign is for all agents") - obj_audit: CommonAudit = Field(..., alias="objAudit") - __properties = ["pkiEzmaxinvoicingcontractID", "eEzmaxinvoicingcontractPaymenttype", "iEzmaxinvoicingcontractLength", "dtEzmaxinvoicingcontractStart", "dtEzmaxinvoicingcontractEnd", "dEzmaxinvoicingcontractLicense", "dEzmaxinvoicingcontract121qa", "bEzmaxinvoicingcontractEzsignallagents", "objAudit"] - - @validator('d_ezmaxinvoicingcontract_license') + A Ezmaxinvoicingcontract Object + """ # noqa: E501 + pki_ezmaxinvoicingcontract_id: Annotated[int, Field(strict=True, ge=1)] = Field(description="The unique ID of the Ezmaxinvoicingcontract", alias="pkiEzmaxinvoicingcontractID") + e_ezmaxinvoicingcontract_paymenttype: FieldEEzmaxinvoicingcontractPaymenttype = Field(alias="eEzmaxinvoicingcontractPaymenttype") + i_ezmaxinvoicingcontract_length: Annotated[int, Field(strict=True, ge=1)] = Field(description="The length in years of the Ezmaxinvoicingcontract", alias="iEzmaxinvoicingcontractLength") + dt_ezmaxinvoicingcontract_start: StrictStr = Field(description="The start date of the Ezmaxinvoicingcontract", alias="dtEzmaxinvoicingcontractStart") + dt_ezmaxinvoicingcontract_end: StrictStr = Field(description="The end date of the Ezmaxinvoicingcontract", alias="dtEzmaxinvoicingcontractEnd") + d_ezmaxinvoicingcontract_license: Annotated[str, Field(strict=True)] = Field(description="The price of the license", alias="dEzmaxinvoicingcontractLicense") + d_ezmaxinvoicingcontract121qa: Annotated[str, Field(strict=True)] = Field(description="The price for 121QA", alias="dEzmaxinvoicingcontract121qa") + b_ezmaxinvoicingcontract_ezsignallagents: StrictBool = Field(description="Whether eZsign is for all agents", alias="bEzmaxinvoicingcontractEzsignallagents") + obj_audit: CommonAudit = Field(alias="objAudit") + __properties: ClassVar[List[str]] = ["pkiEzmaxinvoicingcontractID", "eEzmaxinvoicingcontractPaymenttype", "iEzmaxinvoicingcontractLength", "dtEzmaxinvoicingcontractStart", "dtEzmaxinvoicingcontractEnd", "dEzmaxinvoicingcontractLicense", "dEzmaxinvoicingcontract121qa", "bEzmaxinvoicingcontractEzsignallagents", "objAudit"] + + @field_validator('d_ezmaxinvoicingcontract_license') def d_ezmaxinvoicingcontract_license_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^-{0,1}[\d]{1,9}?\.[\d]{2}$", value): raise ValueError(r"must validate the regular expression /^-{0,1}[\d]{1,9}?\.[\d]{2}$/") return value - @validator('d_ezmaxinvoicingcontract121qa') + @field_validator('d_ezmaxinvoicingcontract121qa') def d_ezmaxinvoicingcontract121qa_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^-{0,1}[\d]{1,9}?\.[\d]{2}$", value): raise ValueError(r"must validate the regular expression /^-{0,1}[\d]{1,9}?\.[\d]{2}$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzmaxinvoicingcontractResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzmaxinvoicingcontractResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_audit if self.obj_audit: _dict['objAudit'] = self.obj_audit.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> EzmaxinvoicingcontractResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzmaxinvoicingcontractResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzmaxinvoicingcontractResponse.parse_obj(obj) - - _obj = EzmaxinvoicingcontractResponse.parse_obj({ - "pki_ezmaxinvoicingcontract_id": obj.get("pkiEzmaxinvoicingcontractID"), - "e_ezmaxinvoicingcontract_paymenttype": obj.get("eEzmaxinvoicingcontractPaymenttype"), - "i_ezmaxinvoicingcontract_length": obj.get("iEzmaxinvoicingcontractLength"), - "dt_ezmaxinvoicingcontract_start": obj.get("dtEzmaxinvoicingcontractStart"), - "dt_ezmaxinvoicingcontract_end": obj.get("dtEzmaxinvoicingcontractEnd"), - "d_ezmaxinvoicingcontract_license": obj.get("dEzmaxinvoicingcontractLicense"), - "d_ezmaxinvoicingcontract121qa": obj.get("dEzmaxinvoicingcontract121qa"), - "b_ezmaxinvoicingcontract_ezsignallagents": obj.get("bEzmaxinvoicingcontractEzsignallagents"), - "obj_audit": CommonAudit.from_dict(obj.get("objAudit")) if obj.get("objAudit") is not None else None + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzmaxinvoicingcontractID": obj.get("pkiEzmaxinvoicingcontractID"), + "eEzmaxinvoicingcontractPaymenttype": obj.get("eEzmaxinvoicingcontractPaymenttype"), + "iEzmaxinvoicingcontractLength": obj.get("iEzmaxinvoicingcontractLength"), + "dtEzmaxinvoicingcontractStart": obj.get("dtEzmaxinvoicingcontractStart"), + "dtEzmaxinvoicingcontractEnd": obj.get("dtEzmaxinvoicingcontractEnd"), + "dEzmaxinvoicingcontractLicense": obj.get("dEzmaxinvoicingcontractLicense"), + "dEzmaxinvoicingcontract121qa": obj.get("dEzmaxinvoicingcontract121qa"), + "bEzmaxinvoicingcontractEzsignallagents": obj.get("bEzmaxinvoicingcontractEzsignallagents"), + "objAudit": CommonAudit.from_dict(obj.get("objAudit")) if obj.get("objAudit") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezmaxinvoicingcontract_response_compound.py b/eZmaxApi/models/ezmaxinvoicingcontract_response_compound.py index d14d90f40..edc39e2e1 100644 --- a/eZmaxApi/models/ezmaxinvoicingcontract_response_compound.py +++ b/eZmaxApi/models/ezmaxinvoicingcontract_response_compound.py @@ -19,88 +19,107 @@ import json - -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint, constr, validator +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictBool, StrictStr, field_validator +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.common_audit import CommonAudit from eZmaxApi.models.field_e_ezmaxinvoicingcontract_paymenttype import FieldEEzmaxinvoicingcontractPaymenttype +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzmaxinvoicingcontractResponseCompound(BaseModel): """ - A Ezmaxinvoicingcontract Object # noqa: E501 - """ - pki_ezmaxinvoicingcontract_id: conint(strict=True, ge=1) = Field(..., alias="pkiEzmaxinvoicingcontractID", description="The unique ID of the Ezmaxinvoicingcontract") - e_ezmaxinvoicingcontract_paymenttype: FieldEEzmaxinvoicingcontractPaymenttype = Field(..., alias="eEzmaxinvoicingcontractPaymenttype") - i_ezmaxinvoicingcontract_length: conint(strict=True, ge=1) = Field(..., alias="iEzmaxinvoicingcontractLength", description="The length in years of the Ezmaxinvoicingcontract") - dt_ezmaxinvoicingcontract_start: StrictStr = Field(..., alias="dtEzmaxinvoicingcontractStart", description="The start date of the Ezmaxinvoicingcontract") - dt_ezmaxinvoicingcontract_end: StrictStr = Field(..., alias="dtEzmaxinvoicingcontractEnd", description="The end date of the Ezmaxinvoicingcontract") - d_ezmaxinvoicingcontract_license: constr(strict=True) = Field(..., alias="dEzmaxinvoicingcontractLicense", description="The price of the license") - d_ezmaxinvoicingcontract121qa: constr(strict=True) = Field(..., alias="dEzmaxinvoicingcontract121qa", description="The price for 121QA") - b_ezmaxinvoicingcontract_ezsignallagents: StrictBool = Field(..., alias="bEzmaxinvoicingcontractEzsignallagents", description="Whether eZsign is for all agents") - obj_audit: CommonAudit = Field(..., alias="objAudit") - __properties = ["pkiEzmaxinvoicingcontractID", "eEzmaxinvoicingcontractPaymenttype", "iEzmaxinvoicingcontractLength", "dtEzmaxinvoicingcontractStart", "dtEzmaxinvoicingcontractEnd", "dEzmaxinvoicingcontractLicense", "dEzmaxinvoicingcontract121qa", "bEzmaxinvoicingcontractEzsignallagents", "objAudit"] - - @validator('d_ezmaxinvoicingcontract_license') + A Ezmaxinvoicingcontract Object + """ # noqa: E501 + pki_ezmaxinvoicingcontract_id: Annotated[int, Field(strict=True, ge=1)] = Field(description="The unique ID of the Ezmaxinvoicingcontract", alias="pkiEzmaxinvoicingcontractID") + e_ezmaxinvoicingcontract_paymenttype: FieldEEzmaxinvoicingcontractPaymenttype = Field(alias="eEzmaxinvoicingcontractPaymenttype") + i_ezmaxinvoicingcontract_length: Annotated[int, Field(strict=True, ge=1)] = Field(description="The length in years of the Ezmaxinvoicingcontract", alias="iEzmaxinvoicingcontractLength") + dt_ezmaxinvoicingcontract_start: StrictStr = Field(description="The start date of the Ezmaxinvoicingcontract", alias="dtEzmaxinvoicingcontractStart") + dt_ezmaxinvoicingcontract_end: StrictStr = Field(description="The end date of the Ezmaxinvoicingcontract", alias="dtEzmaxinvoicingcontractEnd") + d_ezmaxinvoicingcontract_license: Annotated[str, Field(strict=True)] = Field(description="The price of the license", alias="dEzmaxinvoicingcontractLicense") + d_ezmaxinvoicingcontract121qa: Annotated[str, Field(strict=True)] = Field(description="The price for 121QA", alias="dEzmaxinvoicingcontract121qa") + b_ezmaxinvoicingcontract_ezsignallagents: StrictBool = Field(description="Whether eZsign is for all agents", alias="bEzmaxinvoicingcontractEzsignallagents") + obj_audit: CommonAudit = Field(alias="objAudit") + __properties: ClassVar[List[str]] = ["pkiEzmaxinvoicingcontractID", "eEzmaxinvoicingcontractPaymenttype", "iEzmaxinvoicingcontractLength", "dtEzmaxinvoicingcontractStart", "dtEzmaxinvoicingcontractEnd", "dEzmaxinvoicingcontractLicense", "dEzmaxinvoicingcontract121qa", "bEzmaxinvoicingcontractEzsignallagents", "objAudit"] + + @field_validator('d_ezmaxinvoicingcontract_license') def d_ezmaxinvoicingcontract_license_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^-{0,1}[\d]{1,9}?\.[\d]{2}$", value): raise ValueError(r"must validate the regular expression /^-{0,1}[\d]{1,9}?\.[\d]{2}$/") return value - @validator('d_ezmaxinvoicingcontract121qa') + @field_validator('d_ezmaxinvoicingcontract121qa') def d_ezmaxinvoicingcontract121qa_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^-{0,1}[\d]{1,9}?\.[\d]{2}$", value): raise ValueError(r"must validate the regular expression /^-{0,1}[\d]{1,9}?\.[\d]{2}$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzmaxinvoicingcontractResponseCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzmaxinvoicingcontractResponseCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_audit if self.obj_audit: _dict['objAudit'] = self.obj_audit.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> EzmaxinvoicingcontractResponseCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzmaxinvoicingcontractResponseCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzmaxinvoicingcontractResponseCompound.parse_obj(obj) - - _obj = EzmaxinvoicingcontractResponseCompound.parse_obj({ - "pki_ezmaxinvoicingcontract_id": obj.get("pkiEzmaxinvoicingcontractID"), - "e_ezmaxinvoicingcontract_paymenttype": obj.get("eEzmaxinvoicingcontractPaymenttype"), - "i_ezmaxinvoicingcontract_length": obj.get("iEzmaxinvoicingcontractLength"), - "dt_ezmaxinvoicingcontract_start": obj.get("dtEzmaxinvoicingcontractStart"), - "dt_ezmaxinvoicingcontract_end": obj.get("dtEzmaxinvoicingcontractEnd"), - "d_ezmaxinvoicingcontract_license": obj.get("dEzmaxinvoicingcontractLicense"), - "d_ezmaxinvoicingcontract121qa": obj.get("dEzmaxinvoicingcontract121qa"), - "b_ezmaxinvoicingcontract_ezsignallagents": obj.get("bEzmaxinvoicingcontractEzsignallagents"), - "obj_audit": CommonAudit.from_dict(obj.get("objAudit")) if obj.get("objAudit") is not None else None + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzmaxinvoicingcontractID": obj.get("pkiEzmaxinvoicingcontractID"), + "eEzmaxinvoicingcontractPaymenttype": obj.get("eEzmaxinvoicingcontractPaymenttype"), + "iEzmaxinvoicingcontractLength": obj.get("iEzmaxinvoicingcontractLength"), + "dtEzmaxinvoicingcontractStart": obj.get("dtEzmaxinvoicingcontractStart"), + "dtEzmaxinvoicingcontractEnd": obj.get("dtEzmaxinvoicingcontractEnd"), + "dEzmaxinvoicingcontractLicense": obj.get("dEzmaxinvoicingcontractLicense"), + "dEzmaxinvoicingcontract121qa": obj.get("dEzmaxinvoicingcontract121qa"), + "bEzmaxinvoicingcontractEzsignallagents": obj.get("bEzmaxinvoicingcontractEzsignallagents"), + "objAudit": CommonAudit.from_dict(obj.get("objAudit")) if obj.get("objAudit") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezmaxinvoicingsummaryexternal_response.py b/eZmaxApi/models/ezmaxinvoicingsummaryexternal_response.py index 97a6b5732..f33651f18 100644 --- a/eZmaxApi/models/ezmaxinvoicingsummaryexternal_response.py +++ b/eZmaxApi/models/ezmaxinvoicingsummaryexternal_response.py @@ -19,61 +19,80 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictStr, conint, constr +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictStr +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzmaxinvoicingsummaryexternalResponse(BaseModel): """ - A Ezmaxinvoicingsummaryexternal Object # noqa: E501 - """ - pki_ezmaxinvoicingsummaryexternal_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="pkiEzmaxinvoicingsummaryexternalID", description="The unique ID of the Ezmaxinvoicingsummaryexternal") - fki_ezmaxinvoicing_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiEzmaxinvoicingID", description="The unique ID of the Ezmaxinvoicing") - fki_billingentityexternal_id: conint(strict=True, ge=1) = Field(..., alias="fkiBillingentityexternalID", description="The unique ID of the Billingentityexternal") - s_billingentityexternal_description: StrictStr = Field(..., alias="sBillingentityexternalDescription", description="The description of the Billingentityexternal") - s_ezmaxinvoicingsummaryexternal_description: constr(strict=True, max_length=70) = Field(..., alias="sEzmaxinvoicingsummaryexternalDescription", description="The description of the Ezmaxinvoicingsummaryexternal") - __properties = ["pkiEzmaxinvoicingsummaryexternalID", "fkiEzmaxinvoicingID", "fkiBillingentityexternalID", "sBillingentityexternalDescription", "sEzmaxinvoicingsummaryexternalDescription"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + A Ezmaxinvoicingsummaryexternal Object + """ # noqa: E501 + pki_ezmaxinvoicingsummaryexternal_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezmaxinvoicingsummaryexternal", alias="pkiEzmaxinvoicingsummaryexternalID") + fki_ezmaxinvoicing_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezmaxinvoicing", alias="fkiEzmaxinvoicingID") + fki_billingentityexternal_id: Annotated[int, Field(strict=True, ge=1)] = Field(description="The unique ID of the Billingentityexternal", alias="fkiBillingentityexternalID") + s_billingentityexternal_description: StrictStr = Field(description="The description of the Billingentityexternal", alias="sBillingentityexternalDescription") + s_ezmaxinvoicingsummaryexternal_description: Annotated[str, Field(strict=True, max_length=70)] = Field(description="The description of the Ezmaxinvoicingsummaryexternal", alias="sEzmaxinvoicingsummaryexternalDescription") + __properties: ClassVar[List[str]] = ["pkiEzmaxinvoicingsummaryexternalID", "fkiEzmaxinvoicingID", "fkiBillingentityexternalID", "sBillingentityexternalDescription", "sEzmaxinvoicingsummaryexternalDescription"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzmaxinvoicingsummaryexternalResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzmaxinvoicingsummaryexternalResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzmaxinvoicingsummaryexternalResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzmaxinvoicingsummaryexternalResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzmaxinvoicingsummaryexternalResponse.parse_obj(obj) - - _obj = EzmaxinvoicingsummaryexternalResponse.parse_obj({ - "pki_ezmaxinvoicingsummaryexternal_id": obj.get("pkiEzmaxinvoicingsummaryexternalID"), - "fki_ezmaxinvoicing_id": obj.get("fkiEzmaxinvoicingID"), - "fki_billingentityexternal_id": obj.get("fkiBillingentityexternalID"), - "s_billingentityexternal_description": obj.get("sBillingentityexternalDescription"), - "s_ezmaxinvoicingsummaryexternal_description": obj.get("sEzmaxinvoicingsummaryexternalDescription") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzmaxinvoicingsummaryexternalID": obj.get("pkiEzmaxinvoicingsummaryexternalID"), + "fkiEzmaxinvoicingID": obj.get("fkiEzmaxinvoicingID"), + "fkiBillingentityexternalID": obj.get("fkiBillingentityexternalID"), + "sBillingentityexternalDescription": obj.get("sBillingentityexternalDescription"), + "sEzmaxinvoicingsummaryexternalDescription": obj.get("sEzmaxinvoicingsummaryexternalDescription") }) return _obj diff --git a/eZmaxApi/models/ezmaxinvoicingsummaryexternal_response_compound.py b/eZmaxApi/models/ezmaxinvoicingsummaryexternal_response_compound.py index 11934e03b..b07ccf63b 100644 --- a/eZmaxApi/models/ezmaxinvoicingsummaryexternal_response_compound.py +++ b/eZmaxApi/models/ezmaxinvoicingsummaryexternal_response_compound.py @@ -19,46 +19,65 @@ import json -from typing import List, Optional -from pydantic import BaseModel, Field, StrictStr, conint, conlist, constr +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictStr +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.ezmaxinvoicingsummaryexternaldetail_response_compound import EzmaxinvoicingsummaryexternaldetailResponseCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzmaxinvoicingsummaryexternalResponseCompound(BaseModel): """ - A Ezmaxinvoicingsummaryexternal Object # noqa: E501 - """ - pki_ezmaxinvoicingsummaryexternal_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="pkiEzmaxinvoicingsummaryexternalID", description="The unique ID of the Ezmaxinvoicingsummaryexternal") - fki_ezmaxinvoicing_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiEzmaxinvoicingID", description="The unique ID of the Ezmaxinvoicing") - fki_billingentityexternal_id: conint(strict=True, ge=1) = Field(..., alias="fkiBillingentityexternalID", description="The unique ID of the Billingentityexternal") - s_billingentityexternal_description: StrictStr = Field(..., alias="sBillingentityexternalDescription", description="The description of the Billingentityexternal") - s_ezmaxinvoicingsummaryexternal_description: constr(strict=True, max_length=70) = Field(..., alias="sEzmaxinvoicingsummaryexternalDescription", description="The description of the Ezmaxinvoicingsummaryexternal") - a_obj_ezmaxinvoicingsummaryexternaldetail: conlist(EzmaxinvoicingsummaryexternaldetailResponseCompound) = Field(..., alias="a_objEzmaxinvoicingsummaryexternaldetail") - __properties = ["pkiEzmaxinvoicingsummaryexternalID", "fkiEzmaxinvoicingID", "fkiBillingentityexternalID", "sBillingentityexternalDescription", "sEzmaxinvoicingsummaryexternalDescription", "a_objEzmaxinvoicingsummaryexternaldetail"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + A Ezmaxinvoicingsummaryexternal Object + """ # noqa: E501 + pki_ezmaxinvoicingsummaryexternal_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezmaxinvoicingsummaryexternal", alias="pkiEzmaxinvoicingsummaryexternalID") + fki_ezmaxinvoicing_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezmaxinvoicing", alias="fkiEzmaxinvoicingID") + fki_billingentityexternal_id: Annotated[int, Field(strict=True, ge=1)] = Field(description="The unique ID of the Billingentityexternal", alias="fkiBillingentityexternalID") + s_billingentityexternal_description: StrictStr = Field(description="The description of the Billingentityexternal", alias="sBillingentityexternalDescription") + s_ezmaxinvoicingsummaryexternal_description: Annotated[str, Field(strict=True, max_length=70)] = Field(description="The description of the Ezmaxinvoicingsummaryexternal", alias="sEzmaxinvoicingsummaryexternalDescription") + a_obj_ezmaxinvoicingsummaryexternaldetail: List[EzmaxinvoicingsummaryexternaldetailResponseCompound] = Field(alias="a_objEzmaxinvoicingsummaryexternaldetail") + __properties: ClassVar[List[str]] = ["pkiEzmaxinvoicingsummaryexternalID", "fkiEzmaxinvoicingID", "fkiBillingentityexternalID", "sBillingentityexternalDescription", "sEzmaxinvoicingsummaryexternalDescription", "a_objEzmaxinvoicingsummaryexternaldetail"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzmaxinvoicingsummaryexternalResponseCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzmaxinvoicingsummaryexternalResponseCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_ezmaxinvoicingsummaryexternaldetail (list) _items = [] if self.a_obj_ezmaxinvoicingsummaryexternaldetail: @@ -69,21 +88,21 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzmaxinvoicingsummaryexternalResponseCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzmaxinvoicingsummaryexternalResponseCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzmaxinvoicingsummaryexternalResponseCompound.parse_obj(obj) - - _obj = EzmaxinvoicingsummaryexternalResponseCompound.parse_obj({ - "pki_ezmaxinvoicingsummaryexternal_id": obj.get("pkiEzmaxinvoicingsummaryexternalID"), - "fki_ezmaxinvoicing_id": obj.get("fkiEzmaxinvoicingID"), - "fki_billingentityexternal_id": obj.get("fkiBillingentityexternalID"), - "s_billingentityexternal_description": obj.get("sBillingentityexternalDescription"), - "s_ezmaxinvoicingsummaryexternal_description": obj.get("sEzmaxinvoicingsummaryexternalDescription"), - "a_obj_ezmaxinvoicingsummaryexternaldetail": [EzmaxinvoicingsummaryexternaldetailResponseCompound.from_dict(_item) for _item in obj.get("a_objEzmaxinvoicingsummaryexternaldetail")] if obj.get("a_objEzmaxinvoicingsummaryexternaldetail") is not None else None + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzmaxinvoicingsummaryexternalID": obj.get("pkiEzmaxinvoicingsummaryexternalID"), + "fkiEzmaxinvoicingID": obj.get("fkiEzmaxinvoicingID"), + "fkiBillingentityexternalID": obj.get("fkiBillingentityexternalID"), + "sBillingentityexternalDescription": obj.get("sBillingentityexternalDescription"), + "sEzmaxinvoicingsummaryexternalDescription": obj.get("sEzmaxinvoicingsummaryexternalDescription"), + "a_objEzmaxinvoicingsummaryexternaldetail": [EzmaxinvoicingsummaryexternaldetailResponseCompound.from_dict(_item) for _item in obj.get("a_objEzmaxinvoicingsummaryexternaldetail")] if obj.get("a_objEzmaxinvoicingsummaryexternaldetail") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezmaxinvoicingsummaryexternaldetail_response.py b/eZmaxApi/models/ezmaxinvoicingsummaryexternaldetail_response.py index 3acb78510..a64be4374 100644 --- a/eZmaxApi/models/ezmaxinvoicingsummaryexternaldetail_response.py +++ b/eZmaxApi/models/ezmaxinvoicingsummaryexternaldetail_response.py @@ -19,99 +19,118 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint, constr, validator +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, StrictStr, field_validator +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzmaxinvoicingsummaryexternaldetailResponse(BaseModel): """ - A Ezmaxinvoicingsummaryexternaldetail Object # noqa: E501 - """ - pki_ezmaxinvoicingsummaryexternaldetail_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="pkiEzmaxinvoicingsummaryexternaldetailID", description="The unique ID of the Ezmaxinvoicingsummaryexternaldetail") - fki_ezmaxinvoicingsummaryexternal_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiEzmaxinvoicingsummaryexternalID", description="The unique ID of the Ezmaxinvoicingsummaryexternal") - fki_ezmaxproduct_id: conint(strict=True, ge=1) = Field(..., alias="fkiEzmaxproductID", description="The unique ID of the Ezmaxproduct") - s_ezmaxproduct_description_x: StrictStr = Field(..., alias="sEzmaxproductDescriptionX", description="The description of the Ezmaxproduct in the language of the requester") - d_ezmaxinvoicingsummaryexternaldetail_countreal: constr(strict=True) = Field(..., alias="dEzmaxinvoicingsummaryexternaldetailCountreal", description="The count item invoiced for the product") - d_ezmaxinvoicingsummaryexternaldetail_subtotal: constr(strict=True) = Field(..., alias="dEzmaxinvoicingsummaryexternaldetailSubtotal", description="The subtotal invoiced for the product") - d_ezmaxinvoicingsummaryexternaldetail_rebate: constr(strict=True) = Field(..., alias="dEzmaxinvoicingsummaryexternaldetailRebate", description="The rebate for the product") - d_ezmaxinvoicingsummaryexternaldetail_total: constr(strict=True) = Field(..., alias="dEzmaxinvoicingsummaryexternaldetailTotal", description="The total invoiced for the product") - b_ezmaxinvoicingsummaryexternaldetail_adjustment: StrictBool = Field(..., alias="bEzmaxinvoicingsummaryexternaldetailAdjustment", description="Whether it's an adjustment") - t_ezmaxproduct_help_x: StrictStr = Field(..., alias="tEzmaxproductHelpX", description="The help message of the Ezmaxproduct in the language of the requester") - __properties = ["pkiEzmaxinvoicingsummaryexternaldetailID", "fkiEzmaxinvoicingsummaryexternalID", "fkiEzmaxproductID", "sEzmaxproductDescriptionX", "dEzmaxinvoicingsummaryexternaldetailCountreal", "dEzmaxinvoicingsummaryexternaldetailSubtotal", "dEzmaxinvoicingsummaryexternaldetailRebate", "dEzmaxinvoicingsummaryexternaldetailTotal", "bEzmaxinvoicingsummaryexternaldetailAdjustment", "tEzmaxproductHelpX"] - - @validator('d_ezmaxinvoicingsummaryexternaldetail_countreal') + A Ezmaxinvoicingsummaryexternaldetail Object + """ # noqa: E501 + pki_ezmaxinvoicingsummaryexternaldetail_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezmaxinvoicingsummaryexternaldetail", alias="pkiEzmaxinvoicingsummaryexternaldetailID") + fki_ezmaxinvoicingsummaryexternal_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezmaxinvoicingsummaryexternal", alias="fkiEzmaxinvoicingsummaryexternalID") + fki_ezmaxproduct_id: Annotated[int, Field(strict=True, ge=1)] = Field(description="The unique ID of the Ezmaxproduct", alias="fkiEzmaxproductID") + s_ezmaxproduct_description_x: StrictStr = Field(description="The description of the Ezmaxproduct in the language of the requester", alias="sEzmaxproductDescriptionX") + d_ezmaxinvoicingsummaryexternaldetail_countreal: Annotated[str, Field(strict=True)] = Field(description="The count item invoiced for the product", alias="dEzmaxinvoicingsummaryexternaldetailCountreal") + d_ezmaxinvoicingsummaryexternaldetail_subtotal: Annotated[str, Field(strict=True)] = Field(description="The subtotal invoiced for the product", alias="dEzmaxinvoicingsummaryexternaldetailSubtotal") + d_ezmaxinvoicingsummaryexternaldetail_rebate: Annotated[str, Field(strict=True)] = Field(description="The rebate for the product", alias="dEzmaxinvoicingsummaryexternaldetailRebate") + d_ezmaxinvoicingsummaryexternaldetail_total: Annotated[str, Field(strict=True)] = Field(description="The total invoiced for the product", alias="dEzmaxinvoicingsummaryexternaldetailTotal") + b_ezmaxinvoicingsummaryexternaldetail_adjustment: StrictBool = Field(description="Whether it's an adjustment", alias="bEzmaxinvoicingsummaryexternaldetailAdjustment") + t_ezmaxproduct_help_x: StrictStr = Field(description="The help message of the Ezmaxproduct in the language of the requester", alias="tEzmaxproductHelpX") + __properties: ClassVar[List[str]] = ["pkiEzmaxinvoicingsummaryexternaldetailID", "fkiEzmaxinvoicingsummaryexternalID", "fkiEzmaxproductID", "sEzmaxproductDescriptionX", "dEzmaxinvoicingsummaryexternaldetailCountreal", "dEzmaxinvoicingsummaryexternaldetailSubtotal", "dEzmaxinvoicingsummaryexternaldetailRebate", "dEzmaxinvoicingsummaryexternaldetailTotal", "bEzmaxinvoicingsummaryexternaldetailAdjustment", "tEzmaxproductHelpX"] + + @field_validator('d_ezmaxinvoicingsummaryexternaldetail_countreal') def d_ezmaxinvoicingsummaryexternaldetail_countreal_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^-{0,1}[\d]{1,6}?\.[\d]{2}$", value): raise ValueError(r"must validate the regular expression /^-{0,1}[\d]{1,6}?\.[\d]{2}$/") return value - @validator('d_ezmaxinvoicingsummaryexternaldetail_subtotal') + @field_validator('d_ezmaxinvoicingsummaryexternaldetail_subtotal') def d_ezmaxinvoicingsummaryexternaldetail_subtotal_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^-{0,1}[\d]{1,9}?\.[\d]{2}$", value): raise ValueError(r"must validate the regular expression /^-{0,1}[\d]{1,9}?\.[\d]{2}$/") return value - @validator('d_ezmaxinvoicingsummaryexternaldetail_rebate') + @field_validator('d_ezmaxinvoicingsummaryexternaldetail_rebate') def d_ezmaxinvoicingsummaryexternaldetail_rebate_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^-{0,1}[\d]{1,9}?\.[\d]{2}$", value): raise ValueError(r"must validate the regular expression /^-{0,1}[\d]{1,9}?\.[\d]{2}$/") return value - @validator('d_ezmaxinvoicingsummaryexternaldetail_total') + @field_validator('d_ezmaxinvoicingsummaryexternaldetail_total') def d_ezmaxinvoicingsummaryexternaldetail_total_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^-{0,1}[\d]{1,9}?\.[\d]{2}$", value): raise ValueError(r"must validate the regular expression /^-{0,1}[\d]{1,9}?\.[\d]{2}$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzmaxinvoicingsummaryexternaldetailResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzmaxinvoicingsummaryexternaldetailResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzmaxinvoicingsummaryexternaldetailResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzmaxinvoicingsummaryexternaldetailResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzmaxinvoicingsummaryexternaldetailResponse.parse_obj(obj) - - _obj = EzmaxinvoicingsummaryexternaldetailResponse.parse_obj({ - "pki_ezmaxinvoicingsummaryexternaldetail_id": obj.get("pkiEzmaxinvoicingsummaryexternaldetailID"), - "fki_ezmaxinvoicingsummaryexternal_id": obj.get("fkiEzmaxinvoicingsummaryexternalID"), - "fki_ezmaxproduct_id": obj.get("fkiEzmaxproductID"), - "s_ezmaxproduct_description_x": obj.get("sEzmaxproductDescriptionX"), - "d_ezmaxinvoicingsummaryexternaldetail_countreal": obj.get("dEzmaxinvoicingsummaryexternaldetailCountreal"), - "d_ezmaxinvoicingsummaryexternaldetail_subtotal": obj.get("dEzmaxinvoicingsummaryexternaldetailSubtotal"), - "d_ezmaxinvoicingsummaryexternaldetail_rebate": obj.get("dEzmaxinvoicingsummaryexternaldetailRebate"), - "d_ezmaxinvoicingsummaryexternaldetail_total": obj.get("dEzmaxinvoicingsummaryexternaldetailTotal"), - "b_ezmaxinvoicingsummaryexternaldetail_adjustment": obj.get("bEzmaxinvoicingsummaryexternaldetailAdjustment"), - "t_ezmaxproduct_help_x": obj.get("tEzmaxproductHelpX") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzmaxinvoicingsummaryexternaldetailID": obj.get("pkiEzmaxinvoicingsummaryexternaldetailID"), + "fkiEzmaxinvoicingsummaryexternalID": obj.get("fkiEzmaxinvoicingsummaryexternalID"), + "fkiEzmaxproductID": obj.get("fkiEzmaxproductID"), + "sEzmaxproductDescriptionX": obj.get("sEzmaxproductDescriptionX"), + "dEzmaxinvoicingsummaryexternaldetailCountreal": obj.get("dEzmaxinvoicingsummaryexternaldetailCountreal"), + "dEzmaxinvoicingsummaryexternaldetailSubtotal": obj.get("dEzmaxinvoicingsummaryexternaldetailSubtotal"), + "dEzmaxinvoicingsummaryexternaldetailRebate": obj.get("dEzmaxinvoicingsummaryexternaldetailRebate"), + "dEzmaxinvoicingsummaryexternaldetailTotal": obj.get("dEzmaxinvoicingsummaryexternaldetailTotal"), + "bEzmaxinvoicingsummaryexternaldetailAdjustment": obj.get("bEzmaxinvoicingsummaryexternaldetailAdjustment"), + "tEzmaxproductHelpX": obj.get("tEzmaxproductHelpX") }) return _obj diff --git a/eZmaxApi/models/ezmaxinvoicingsummaryexternaldetail_response_compound.py b/eZmaxApi/models/ezmaxinvoicingsummaryexternaldetail_response_compound.py index 886420401..6e2f2741b 100644 --- a/eZmaxApi/models/ezmaxinvoicingsummaryexternaldetail_response_compound.py +++ b/eZmaxApi/models/ezmaxinvoicingsummaryexternaldetail_response_compound.py @@ -19,99 +19,118 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint, constr, validator +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, StrictStr, field_validator +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzmaxinvoicingsummaryexternaldetailResponseCompound(BaseModel): """ - A Ezmaxinvoicingsummaryexternaldetail Object # noqa: E501 - """ - pki_ezmaxinvoicingsummaryexternaldetail_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="pkiEzmaxinvoicingsummaryexternaldetailID", description="The unique ID of the Ezmaxinvoicingsummaryexternaldetail") - fki_ezmaxinvoicingsummaryexternal_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiEzmaxinvoicingsummaryexternalID", description="The unique ID of the Ezmaxinvoicingsummaryexternal") - fki_ezmaxproduct_id: conint(strict=True, ge=1) = Field(..., alias="fkiEzmaxproductID", description="The unique ID of the Ezmaxproduct") - s_ezmaxproduct_description_x: StrictStr = Field(..., alias="sEzmaxproductDescriptionX", description="The description of the Ezmaxproduct in the language of the requester") - d_ezmaxinvoicingsummaryexternaldetail_countreal: constr(strict=True) = Field(..., alias="dEzmaxinvoicingsummaryexternaldetailCountreal", description="The count item invoiced for the product") - d_ezmaxinvoicingsummaryexternaldetail_subtotal: constr(strict=True) = Field(..., alias="dEzmaxinvoicingsummaryexternaldetailSubtotal", description="The subtotal invoiced for the product") - d_ezmaxinvoicingsummaryexternaldetail_rebate: constr(strict=True) = Field(..., alias="dEzmaxinvoicingsummaryexternaldetailRebate", description="The rebate for the product") - d_ezmaxinvoicingsummaryexternaldetail_total: constr(strict=True) = Field(..., alias="dEzmaxinvoicingsummaryexternaldetailTotal", description="The total invoiced for the product") - b_ezmaxinvoicingsummaryexternaldetail_adjustment: StrictBool = Field(..., alias="bEzmaxinvoicingsummaryexternaldetailAdjustment", description="Whether it's an adjustment") - t_ezmaxproduct_help_x: StrictStr = Field(..., alias="tEzmaxproductHelpX", description="The help message of the Ezmaxproduct in the language of the requester") - __properties = ["pkiEzmaxinvoicingsummaryexternaldetailID", "fkiEzmaxinvoicingsummaryexternalID", "fkiEzmaxproductID", "sEzmaxproductDescriptionX", "dEzmaxinvoicingsummaryexternaldetailCountreal", "dEzmaxinvoicingsummaryexternaldetailSubtotal", "dEzmaxinvoicingsummaryexternaldetailRebate", "dEzmaxinvoicingsummaryexternaldetailTotal", "bEzmaxinvoicingsummaryexternaldetailAdjustment", "tEzmaxproductHelpX"] - - @validator('d_ezmaxinvoicingsummaryexternaldetail_countreal') + A Ezmaxinvoicingsummaryexternaldetail Object + """ # noqa: E501 + pki_ezmaxinvoicingsummaryexternaldetail_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezmaxinvoicingsummaryexternaldetail", alias="pkiEzmaxinvoicingsummaryexternaldetailID") + fki_ezmaxinvoicingsummaryexternal_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezmaxinvoicingsummaryexternal", alias="fkiEzmaxinvoicingsummaryexternalID") + fki_ezmaxproduct_id: Annotated[int, Field(strict=True, ge=1)] = Field(description="The unique ID of the Ezmaxproduct", alias="fkiEzmaxproductID") + s_ezmaxproduct_description_x: StrictStr = Field(description="The description of the Ezmaxproduct in the language of the requester", alias="sEzmaxproductDescriptionX") + d_ezmaxinvoicingsummaryexternaldetail_countreal: Annotated[str, Field(strict=True)] = Field(description="The count item invoiced for the product", alias="dEzmaxinvoicingsummaryexternaldetailCountreal") + d_ezmaxinvoicingsummaryexternaldetail_subtotal: Annotated[str, Field(strict=True)] = Field(description="The subtotal invoiced for the product", alias="dEzmaxinvoicingsummaryexternaldetailSubtotal") + d_ezmaxinvoicingsummaryexternaldetail_rebate: Annotated[str, Field(strict=True)] = Field(description="The rebate for the product", alias="dEzmaxinvoicingsummaryexternaldetailRebate") + d_ezmaxinvoicingsummaryexternaldetail_total: Annotated[str, Field(strict=True)] = Field(description="The total invoiced for the product", alias="dEzmaxinvoicingsummaryexternaldetailTotal") + b_ezmaxinvoicingsummaryexternaldetail_adjustment: StrictBool = Field(description="Whether it's an adjustment", alias="bEzmaxinvoicingsummaryexternaldetailAdjustment") + t_ezmaxproduct_help_x: StrictStr = Field(description="The help message of the Ezmaxproduct in the language of the requester", alias="tEzmaxproductHelpX") + __properties: ClassVar[List[str]] = ["pkiEzmaxinvoicingsummaryexternaldetailID", "fkiEzmaxinvoicingsummaryexternalID", "fkiEzmaxproductID", "sEzmaxproductDescriptionX", "dEzmaxinvoicingsummaryexternaldetailCountreal", "dEzmaxinvoicingsummaryexternaldetailSubtotal", "dEzmaxinvoicingsummaryexternaldetailRebate", "dEzmaxinvoicingsummaryexternaldetailTotal", "bEzmaxinvoicingsummaryexternaldetailAdjustment", "tEzmaxproductHelpX"] + + @field_validator('d_ezmaxinvoicingsummaryexternaldetail_countreal') def d_ezmaxinvoicingsummaryexternaldetail_countreal_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^-{0,1}[\d]{1,6}?\.[\d]{2}$", value): raise ValueError(r"must validate the regular expression /^-{0,1}[\d]{1,6}?\.[\d]{2}$/") return value - @validator('d_ezmaxinvoicingsummaryexternaldetail_subtotal') + @field_validator('d_ezmaxinvoicingsummaryexternaldetail_subtotal') def d_ezmaxinvoicingsummaryexternaldetail_subtotal_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^-{0,1}[\d]{1,9}?\.[\d]{2}$", value): raise ValueError(r"must validate the regular expression /^-{0,1}[\d]{1,9}?\.[\d]{2}$/") return value - @validator('d_ezmaxinvoicingsummaryexternaldetail_rebate') + @field_validator('d_ezmaxinvoicingsummaryexternaldetail_rebate') def d_ezmaxinvoicingsummaryexternaldetail_rebate_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^-{0,1}[\d]{1,9}?\.[\d]{2}$", value): raise ValueError(r"must validate the regular expression /^-{0,1}[\d]{1,9}?\.[\d]{2}$/") return value - @validator('d_ezmaxinvoicingsummaryexternaldetail_total') + @field_validator('d_ezmaxinvoicingsummaryexternaldetail_total') def d_ezmaxinvoicingsummaryexternaldetail_total_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^-{0,1}[\d]{1,9}?\.[\d]{2}$", value): raise ValueError(r"must validate the regular expression /^-{0,1}[\d]{1,9}?\.[\d]{2}$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzmaxinvoicingsummaryexternaldetailResponseCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzmaxinvoicingsummaryexternaldetailResponseCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzmaxinvoicingsummaryexternaldetailResponseCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzmaxinvoicingsummaryexternaldetailResponseCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzmaxinvoicingsummaryexternaldetailResponseCompound.parse_obj(obj) - - _obj = EzmaxinvoicingsummaryexternaldetailResponseCompound.parse_obj({ - "pki_ezmaxinvoicingsummaryexternaldetail_id": obj.get("pkiEzmaxinvoicingsummaryexternaldetailID"), - "fki_ezmaxinvoicingsummaryexternal_id": obj.get("fkiEzmaxinvoicingsummaryexternalID"), - "fki_ezmaxproduct_id": obj.get("fkiEzmaxproductID"), - "s_ezmaxproduct_description_x": obj.get("sEzmaxproductDescriptionX"), - "d_ezmaxinvoicingsummaryexternaldetail_countreal": obj.get("dEzmaxinvoicingsummaryexternaldetailCountreal"), - "d_ezmaxinvoicingsummaryexternaldetail_subtotal": obj.get("dEzmaxinvoicingsummaryexternaldetailSubtotal"), - "d_ezmaxinvoicingsummaryexternaldetail_rebate": obj.get("dEzmaxinvoicingsummaryexternaldetailRebate"), - "d_ezmaxinvoicingsummaryexternaldetail_total": obj.get("dEzmaxinvoicingsummaryexternaldetailTotal"), - "b_ezmaxinvoicingsummaryexternaldetail_adjustment": obj.get("bEzmaxinvoicingsummaryexternaldetailAdjustment"), - "t_ezmaxproduct_help_x": obj.get("tEzmaxproductHelpX") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzmaxinvoicingsummaryexternaldetailID": obj.get("pkiEzmaxinvoicingsummaryexternaldetailID"), + "fkiEzmaxinvoicingsummaryexternalID": obj.get("fkiEzmaxinvoicingsummaryexternalID"), + "fkiEzmaxproductID": obj.get("fkiEzmaxproductID"), + "sEzmaxproductDescriptionX": obj.get("sEzmaxproductDescriptionX"), + "dEzmaxinvoicingsummaryexternaldetailCountreal": obj.get("dEzmaxinvoicingsummaryexternaldetailCountreal"), + "dEzmaxinvoicingsummaryexternaldetailSubtotal": obj.get("dEzmaxinvoicingsummaryexternaldetailSubtotal"), + "dEzmaxinvoicingsummaryexternaldetailRebate": obj.get("dEzmaxinvoicingsummaryexternaldetailRebate"), + "dEzmaxinvoicingsummaryexternaldetailTotal": obj.get("dEzmaxinvoicingsummaryexternaldetailTotal"), + "bEzmaxinvoicingsummaryexternaldetailAdjustment": obj.get("bEzmaxinvoicingsummaryexternaldetailAdjustment"), + "tEzmaxproductHelpX": obj.get("tEzmaxproductHelpX") }) return _obj diff --git a/eZmaxApi/models/ezmaxinvoicingsummaryglobal_response.py b/eZmaxApi/models/ezmaxinvoicingsummaryglobal_response.py index 9cc85f8d4..342ac0edc 100644 --- a/eZmaxApi/models/ezmaxinvoicingsummaryglobal_response.py +++ b/eZmaxApi/models/ezmaxinvoicingsummaryglobal_response.py @@ -19,84 +19,90 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint, constr, validator +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, StrictStr, field_validator +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzmaxinvoicingsummaryglobalResponse(BaseModel): """ - A Ezmaxinvoicingsummaryglobal Object # noqa: E501 - """ - pki_ezmaxinvoicingsummaryglobal_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="pkiEzmaxinvoicingsummaryglobalID", description="The unique ID of the Ezmaxinvoicingsummaryglobal") - fki_ezmaxinvoicing_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiEzmaxinvoicingID", description="The unique ID of the Ezmaxinvoicing") - fki_ezmaxproduct_id: conint(strict=True, ge=1) = Field(..., alias="fkiEzmaxproductID", description="The unique ID of the Ezmaxproduct") - s_ezmaxproduct_description_x: StrictStr = Field(..., alias="sEzmaxproductDescriptionX", description="The description of the Ezmaxproduct in the language of the requester") - dt_ezmaxinvoicingsummaryglobal_start: StrictStr = Field(..., alias="dtEzmaxinvoicingsummaryglobalStart", description="The start date for the Ezmaxinvoicingsummaryglobal") - dt_ezmaxinvoicingsummaryglobal_end: StrictStr = Field(..., alias="dtEzmaxinvoicingsummaryglobalEnd", description="The end date for the Ezmaxinvoicingsummaryglobal") - i_ezmaxinvoicingsummaryglobal_days: conint(strict=True, ge=1) = Field(..., alias="iEzmaxinvoicingsummaryglobalDays", description="The number of days for the Ezmaxinvoicingsummaryglobal") - d_ezmaxinvoicingsummaryglobal_countreal: constr(strict=True) = Field(..., alias="dEzmaxinvoicingsummaryglobalCountreal", description="The count item calculated") - d_ezmaxinvoicingsummaryglobal_countbilled: constr(strict=True) = Field(..., alias="dEzmaxinvoicingsummaryglobalCountbilled", description="The count item billed") - d_ezmaxinvoicingsummaryglobal_subtotal: constr(strict=True) = Field(..., alias="dEzmaxinvoicingsummaryglobalSubtotal", description="The Ezmaxinvoicingsummaryglobal subtotal") - d_ezmaxinvoicingsummaryglobal_rebateamount: constr(strict=True) = Field(..., alias="dEzmaxinvoicingsummaryglobalRebateamount", description="The rebate amount for the Ezmaxinvoicingsummaryglobal") - d_ezmaxinvoicingsummaryglobal_rebatepercent: constr(strict=True) = Field(..., alias="dEzmaxinvoicingsummaryglobalRebatepercent", description="The rebate percentage of the Ezmaxinvoicingsummaryglobal") - d_ezmaxinvoicingsummaryglobal_rebatetotal: constr(strict=True) = Field(..., alias="dEzmaxinvoicingsummaryglobalRebatetotal", description="The rebate amount total for the Ezmaxinvoicingsummaryglobal") - d_ezmaxinvoicingsummaryglobal_total: constr(strict=True) = Field(..., alias="dEzmaxinvoicingsummaryglobalTotal", description="The Ezmaxinvoicingsummaryglobal total") - d_ezmaxinvoicingsummaryglobal_representative: Optional[constr(strict=True)] = Field(None, alias="dEzmaxinvoicingsummaryglobalRepresentative", description="The amount of commission for the representative") - d_ezmaxinvoicingsummaryglobal_partner: Optional[constr(strict=True)] = Field(None, alias="dEzmaxinvoicingsummaryglobalPartner", description="The amount of commission for the partner") - d_ezmaxinvoicingsummaryglobal_net: Optional[constr(strict=True)] = Field(None, alias="dEzmaxinvoicingsummaryglobalNet", description="The net amount of the Ezmaxinvoicingsummaryglobal") - b_ezmaxinvoicingsummaryglobal_adjustment: StrictBool = Field(..., alias="bEzmaxinvoicingsummaryglobalAdjustment", description="Whether it is adjustment for the Ezmaxinvoicingsummaryglobal") - t_ezmaxproduct_help_x: StrictStr = Field(..., alias="tEzmaxproductHelpX", description="The help message of the Ezmaxproduct in the language of the requester") - __properties = ["pkiEzmaxinvoicingsummaryglobalID", "fkiEzmaxinvoicingID", "fkiEzmaxproductID", "sEzmaxproductDescriptionX", "dtEzmaxinvoicingsummaryglobalStart", "dtEzmaxinvoicingsummaryglobalEnd", "iEzmaxinvoicingsummaryglobalDays", "dEzmaxinvoicingsummaryglobalCountreal", "dEzmaxinvoicingsummaryglobalCountbilled", "dEzmaxinvoicingsummaryglobalSubtotal", "dEzmaxinvoicingsummaryglobalRebateamount", "dEzmaxinvoicingsummaryglobalRebatepercent", "dEzmaxinvoicingsummaryglobalRebatetotal", "dEzmaxinvoicingsummaryglobalTotal", "dEzmaxinvoicingsummaryglobalRepresentative", "dEzmaxinvoicingsummaryglobalPartner", "dEzmaxinvoicingsummaryglobalNet", "bEzmaxinvoicingsummaryglobalAdjustment", "tEzmaxproductHelpX"] - - @validator('d_ezmaxinvoicingsummaryglobal_countreal') + A Ezmaxinvoicingsummaryglobal Object + """ # noqa: E501 + pki_ezmaxinvoicingsummaryglobal_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezmaxinvoicingsummaryglobal", alias="pkiEzmaxinvoicingsummaryglobalID") + fki_ezmaxinvoicing_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezmaxinvoicing", alias="fkiEzmaxinvoicingID") + fki_ezmaxproduct_id: Annotated[int, Field(strict=True, ge=1)] = Field(description="The unique ID of the Ezmaxproduct", alias="fkiEzmaxproductID") + s_ezmaxproduct_description_x: StrictStr = Field(description="The description of the Ezmaxproduct in the language of the requester", alias="sEzmaxproductDescriptionX") + dt_ezmaxinvoicingsummaryglobal_start: StrictStr = Field(description="The start date for the Ezmaxinvoicingsummaryglobal", alias="dtEzmaxinvoicingsummaryglobalStart") + dt_ezmaxinvoicingsummaryglobal_end: StrictStr = Field(description="The end date for the Ezmaxinvoicingsummaryglobal", alias="dtEzmaxinvoicingsummaryglobalEnd") + i_ezmaxinvoicingsummaryglobal_days: Annotated[int, Field(strict=True, ge=1)] = Field(description="The number of days for the Ezmaxinvoicingsummaryglobal", alias="iEzmaxinvoicingsummaryglobalDays") + d_ezmaxinvoicingsummaryglobal_countreal: Annotated[str, Field(strict=True)] = Field(description="The count item calculated", alias="dEzmaxinvoicingsummaryglobalCountreal") + d_ezmaxinvoicingsummaryglobal_countbilled: Annotated[str, Field(strict=True)] = Field(description="The count item billed", alias="dEzmaxinvoicingsummaryglobalCountbilled") + d_ezmaxinvoicingsummaryglobal_subtotal: Annotated[str, Field(strict=True)] = Field(description="The Ezmaxinvoicingsummaryglobal subtotal", alias="dEzmaxinvoicingsummaryglobalSubtotal") + d_ezmaxinvoicingsummaryglobal_rebateamount: Annotated[str, Field(strict=True)] = Field(description="The rebate amount for the Ezmaxinvoicingsummaryglobal", alias="dEzmaxinvoicingsummaryglobalRebateamount") + d_ezmaxinvoicingsummaryglobal_rebatepercent: Annotated[str, Field(strict=True)] = Field(description="The rebate percentage of the Ezmaxinvoicingsummaryglobal", alias="dEzmaxinvoicingsummaryglobalRebatepercent") + d_ezmaxinvoicingsummaryglobal_rebatetotal: Annotated[str, Field(strict=True)] = Field(description="The rebate amount total for the Ezmaxinvoicingsummaryglobal", alias="dEzmaxinvoicingsummaryglobalRebatetotal") + d_ezmaxinvoicingsummaryglobal_total: Annotated[str, Field(strict=True)] = Field(description="The Ezmaxinvoicingsummaryglobal total", alias="dEzmaxinvoicingsummaryglobalTotal") + d_ezmaxinvoicingsummaryglobal_representative: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="The amount of commission for the representative", alias="dEzmaxinvoicingsummaryglobalRepresentative") + d_ezmaxinvoicingsummaryglobal_partner: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="The amount of commission for the partner", alias="dEzmaxinvoicingsummaryglobalPartner") + d_ezmaxinvoicingsummaryglobal_net: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="The net amount of the Ezmaxinvoicingsummaryglobal", alias="dEzmaxinvoicingsummaryglobalNet") + b_ezmaxinvoicingsummaryglobal_adjustment: StrictBool = Field(description="Whether it is adjustment for the Ezmaxinvoicingsummaryglobal", alias="bEzmaxinvoicingsummaryglobalAdjustment") + t_ezmaxproduct_help_x: StrictStr = Field(description="The help message of the Ezmaxproduct in the language of the requester", alias="tEzmaxproductHelpX") + __properties: ClassVar[List[str]] = ["pkiEzmaxinvoicingsummaryglobalID", "fkiEzmaxinvoicingID", "fkiEzmaxproductID", "sEzmaxproductDescriptionX", "dtEzmaxinvoicingsummaryglobalStart", "dtEzmaxinvoicingsummaryglobalEnd", "iEzmaxinvoicingsummaryglobalDays", "dEzmaxinvoicingsummaryglobalCountreal", "dEzmaxinvoicingsummaryglobalCountbilled", "dEzmaxinvoicingsummaryglobalSubtotal", "dEzmaxinvoicingsummaryglobalRebateamount", "dEzmaxinvoicingsummaryglobalRebatepercent", "dEzmaxinvoicingsummaryglobalRebatetotal", "dEzmaxinvoicingsummaryglobalTotal", "dEzmaxinvoicingsummaryglobalRepresentative", "dEzmaxinvoicingsummaryglobalPartner", "dEzmaxinvoicingsummaryglobalNet", "bEzmaxinvoicingsummaryglobalAdjustment", "tEzmaxproductHelpX"] + + @field_validator('d_ezmaxinvoicingsummaryglobal_countreal') def d_ezmaxinvoicingsummaryglobal_countreal_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^-{0,1}[\d]{1,6}?\.[\d]{2}$", value): raise ValueError(r"must validate the regular expression /^-{0,1}[\d]{1,6}?\.[\d]{2}$/") return value - @validator('d_ezmaxinvoicingsummaryglobal_countbilled') + @field_validator('d_ezmaxinvoicingsummaryglobal_countbilled') def d_ezmaxinvoicingsummaryglobal_countbilled_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^-{0,1}[\d]{1,6}?\.[\d]{2}$", value): raise ValueError(r"must validate the regular expression /^-{0,1}[\d]{1,6}?\.[\d]{2}$/") return value - @validator('d_ezmaxinvoicingsummaryglobal_subtotal') + @field_validator('d_ezmaxinvoicingsummaryglobal_subtotal') def d_ezmaxinvoicingsummaryglobal_subtotal_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^-{0,1}[\d]{1,9}?\.[\d]{2}$", value): raise ValueError(r"must validate the regular expression /^-{0,1}[\d]{1,9}?\.[\d]{2}$/") return value - @validator('d_ezmaxinvoicingsummaryglobal_rebateamount') + @field_validator('d_ezmaxinvoicingsummaryglobal_rebateamount') def d_ezmaxinvoicingsummaryglobal_rebateamount_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^-{0,1}[\d]{1,9}?\.[\d]{2}$", value): raise ValueError(r"must validate the regular expression /^-{0,1}[\d]{1,9}?\.[\d]{2}$/") return value - @validator('d_ezmaxinvoicingsummaryglobal_rebatepercent') + @field_validator('d_ezmaxinvoicingsummaryglobal_rebatepercent') def d_ezmaxinvoicingsummaryglobal_rebatepercent_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^-{0,1}[\d]{1,3}?\.[\d]{2}$", value): raise ValueError(r"must validate the regular expression /^-{0,1}[\d]{1,3}?\.[\d]{2}$/") return value - @validator('d_ezmaxinvoicingsummaryglobal_rebatetotal') + @field_validator('d_ezmaxinvoicingsummaryglobal_rebatetotal') def d_ezmaxinvoicingsummaryglobal_rebatetotal_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^-{0,1}[\d]{1,9}?\.[\d]{2}$", value): raise ValueError(r"must validate the regular expression /^-{0,1}[\d]{1,9}?\.[\d]{2}$/") return value - @validator('d_ezmaxinvoicingsummaryglobal_total') + @field_validator('d_ezmaxinvoicingsummaryglobal_total') def d_ezmaxinvoicingsummaryglobal_total_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^-{0,1}[\d]{1,9}?\.[\d]{2}$", value): raise ValueError(r"must validate the regular expression /^-{0,1}[\d]{1,9}?\.[\d]{2}$/") return value - @validator('d_ezmaxinvoicingsummaryglobal_representative') + @field_validator('d_ezmaxinvoicingsummaryglobal_representative') def d_ezmaxinvoicingsummaryglobal_representative_validate_regular_expression(cls, value): """Validates the regular expression""" if value is None: @@ -106,7 +112,7 @@ def d_ezmaxinvoicingsummaryglobal_representative_validate_regular_expression(cls raise ValueError(r"must validate the regular expression /^-{0,1}[\d]{1,9}?\.[\d]{2}$/") return value - @validator('d_ezmaxinvoicingsummaryglobal_partner') + @field_validator('d_ezmaxinvoicingsummaryglobal_partner') def d_ezmaxinvoicingsummaryglobal_partner_validate_regular_expression(cls, value): """Validates the regular expression""" if value is None: @@ -116,7 +122,7 @@ def d_ezmaxinvoicingsummaryglobal_partner_validate_regular_expression(cls, value raise ValueError(r"must validate the regular expression /^-{0,1}[\d]{1,9}?\.[\d]{2}$/") return value - @validator('d_ezmaxinvoicingsummaryglobal_net') + @field_validator('d_ezmaxinvoicingsummaryglobal_net') def d_ezmaxinvoicingsummaryglobal_net_validate_regular_expression(cls, value): """Validates the regular expression""" if value is None: @@ -126,61 +132,74 @@ def d_ezmaxinvoicingsummaryglobal_net_validate_regular_expression(cls, value): raise ValueError(r"must validate the regular expression /^-{0,1}[\d]{1,9}?\.[\d]{2}$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzmaxinvoicingsummaryglobalResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzmaxinvoicingsummaryglobalResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzmaxinvoicingsummaryglobalResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzmaxinvoicingsummaryglobalResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzmaxinvoicingsummaryglobalResponse.parse_obj(obj) - - _obj = EzmaxinvoicingsummaryglobalResponse.parse_obj({ - "pki_ezmaxinvoicingsummaryglobal_id": obj.get("pkiEzmaxinvoicingsummaryglobalID"), - "fki_ezmaxinvoicing_id": obj.get("fkiEzmaxinvoicingID"), - "fki_ezmaxproduct_id": obj.get("fkiEzmaxproductID"), - "s_ezmaxproduct_description_x": obj.get("sEzmaxproductDescriptionX"), - "dt_ezmaxinvoicingsummaryglobal_start": obj.get("dtEzmaxinvoicingsummaryglobalStart"), - "dt_ezmaxinvoicingsummaryglobal_end": obj.get("dtEzmaxinvoicingsummaryglobalEnd"), - "i_ezmaxinvoicingsummaryglobal_days": obj.get("iEzmaxinvoicingsummaryglobalDays"), - "d_ezmaxinvoicingsummaryglobal_countreal": obj.get("dEzmaxinvoicingsummaryglobalCountreal"), - "d_ezmaxinvoicingsummaryglobal_countbilled": obj.get("dEzmaxinvoicingsummaryglobalCountbilled"), - "d_ezmaxinvoicingsummaryglobal_subtotal": obj.get("dEzmaxinvoicingsummaryglobalSubtotal"), - "d_ezmaxinvoicingsummaryglobal_rebateamount": obj.get("dEzmaxinvoicingsummaryglobalRebateamount"), - "d_ezmaxinvoicingsummaryglobal_rebatepercent": obj.get("dEzmaxinvoicingsummaryglobalRebatepercent"), - "d_ezmaxinvoicingsummaryglobal_rebatetotal": obj.get("dEzmaxinvoicingsummaryglobalRebatetotal"), - "d_ezmaxinvoicingsummaryglobal_total": obj.get("dEzmaxinvoicingsummaryglobalTotal"), - "d_ezmaxinvoicingsummaryglobal_representative": obj.get("dEzmaxinvoicingsummaryglobalRepresentative"), - "d_ezmaxinvoicingsummaryglobal_partner": obj.get("dEzmaxinvoicingsummaryglobalPartner"), - "d_ezmaxinvoicingsummaryglobal_net": obj.get("dEzmaxinvoicingsummaryglobalNet"), - "b_ezmaxinvoicingsummaryglobal_adjustment": obj.get("bEzmaxinvoicingsummaryglobalAdjustment"), - "t_ezmaxproduct_help_x": obj.get("tEzmaxproductHelpX") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzmaxinvoicingsummaryglobalID": obj.get("pkiEzmaxinvoicingsummaryglobalID"), + "fkiEzmaxinvoicingID": obj.get("fkiEzmaxinvoicingID"), + "fkiEzmaxproductID": obj.get("fkiEzmaxproductID"), + "sEzmaxproductDescriptionX": obj.get("sEzmaxproductDescriptionX"), + "dtEzmaxinvoicingsummaryglobalStart": obj.get("dtEzmaxinvoicingsummaryglobalStart"), + "dtEzmaxinvoicingsummaryglobalEnd": obj.get("dtEzmaxinvoicingsummaryglobalEnd"), + "iEzmaxinvoicingsummaryglobalDays": obj.get("iEzmaxinvoicingsummaryglobalDays"), + "dEzmaxinvoicingsummaryglobalCountreal": obj.get("dEzmaxinvoicingsummaryglobalCountreal"), + "dEzmaxinvoicingsummaryglobalCountbilled": obj.get("dEzmaxinvoicingsummaryglobalCountbilled"), + "dEzmaxinvoicingsummaryglobalSubtotal": obj.get("dEzmaxinvoicingsummaryglobalSubtotal"), + "dEzmaxinvoicingsummaryglobalRebateamount": obj.get("dEzmaxinvoicingsummaryglobalRebateamount"), + "dEzmaxinvoicingsummaryglobalRebatepercent": obj.get("dEzmaxinvoicingsummaryglobalRebatepercent"), + "dEzmaxinvoicingsummaryglobalRebatetotal": obj.get("dEzmaxinvoicingsummaryglobalRebatetotal"), + "dEzmaxinvoicingsummaryglobalTotal": obj.get("dEzmaxinvoicingsummaryglobalTotal"), + "dEzmaxinvoicingsummaryglobalRepresentative": obj.get("dEzmaxinvoicingsummaryglobalRepresentative"), + "dEzmaxinvoicingsummaryglobalPartner": obj.get("dEzmaxinvoicingsummaryglobalPartner"), + "dEzmaxinvoicingsummaryglobalNet": obj.get("dEzmaxinvoicingsummaryglobalNet"), + "bEzmaxinvoicingsummaryglobalAdjustment": obj.get("bEzmaxinvoicingsummaryglobalAdjustment"), + "tEzmaxproductHelpX": obj.get("tEzmaxproductHelpX") }) return _obj diff --git a/eZmaxApi/models/ezmaxinvoicingsummaryglobal_response_compound.py b/eZmaxApi/models/ezmaxinvoicingsummaryglobal_response_compound.py index 90ada8b60..b60993680 100644 --- a/eZmaxApi/models/ezmaxinvoicingsummaryglobal_response_compound.py +++ b/eZmaxApi/models/ezmaxinvoicingsummaryglobal_response_compound.py @@ -19,86 +19,92 @@ import json -from typing import List, Optional -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint, conlist, constr, validator +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, StrictStr, field_validator +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.ezmaxinvoicingcommission_response_compound import EzmaxinvoicingcommissionResponseCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzmaxinvoicingsummaryglobalResponseCompound(BaseModel): """ - A Ezmaxinvoicingsummaryglobal Object # noqa: E501 - """ - pki_ezmaxinvoicingsummaryglobal_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="pkiEzmaxinvoicingsummaryglobalID", description="The unique ID of the Ezmaxinvoicingsummaryglobal") - fki_ezmaxinvoicing_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiEzmaxinvoicingID", description="The unique ID of the Ezmaxinvoicing") - fki_ezmaxproduct_id: conint(strict=True, ge=1) = Field(..., alias="fkiEzmaxproductID", description="The unique ID of the Ezmaxproduct") - s_ezmaxproduct_description_x: StrictStr = Field(..., alias="sEzmaxproductDescriptionX", description="The description of the Ezmaxproduct in the language of the requester") - dt_ezmaxinvoicingsummaryglobal_start: StrictStr = Field(..., alias="dtEzmaxinvoicingsummaryglobalStart", description="The start date for the Ezmaxinvoicingsummaryglobal") - dt_ezmaxinvoicingsummaryglobal_end: StrictStr = Field(..., alias="dtEzmaxinvoicingsummaryglobalEnd", description="The end date for the Ezmaxinvoicingsummaryglobal") - i_ezmaxinvoicingsummaryglobal_days: conint(strict=True, ge=1) = Field(..., alias="iEzmaxinvoicingsummaryglobalDays", description="The number of days for the Ezmaxinvoicingsummaryglobal") - d_ezmaxinvoicingsummaryglobal_countreal: constr(strict=True) = Field(..., alias="dEzmaxinvoicingsummaryglobalCountreal", description="The count item calculated") - d_ezmaxinvoicingsummaryglobal_countbilled: constr(strict=True) = Field(..., alias="dEzmaxinvoicingsummaryglobalCountbilled", description="The count item billed") - d_ezmaxinvoicingsummaryglobal_subtotal: constr(strict=True) = Field(..., alias="dEzmaxinvoicingsummaryglobalSubtotal", description="The Ezmaxinvoicingsummaryglobal subtotal") - d_ezmaxinvoicingsummaryglobal_rebateamount: constr(strict=True) = Field(..., alias="dEzmaxinvoicingsummaryglobalRebateamount", description="The rebate amount for the Ezmaxinvoicingsummaryglobal") - d_ezmaxinvoicingsummaryglobal_rebatepercent: constr(strict=True) = Field(..., alias="dEzmaxinvoicingsummaryglobalRebatepercent", description="The rebate percentage of the Ezmaxinvoicingsummaryglobal") - d_ezmaxinvoicingsummaryglobal_rebatetotal: constr(strict=True) = Field(..., alias="dEzmaxinvoicingsummaryglobalRebatetotal", description="The rebate amount total for the Ezmaxinvoicingsummaryglobal") - d_ezmaxinvoicingsummaryglobal_total: constr(strict=True) = Field(..., alias="dEzmaxinvoicingsummaryglobalTotal", description="The Ezmaxinvoicingsummaryglobal total") - d_ezmaxinvoicingsummaryglobal_representative: Optional[constr(strict=True)] = Field(None, alias="dEzmaxinvoicingsummaryglobalRepresentative", description="The amount of commission for the representative") - d_ezmaxinvoicingsummaryglobal_partner: Optional[constr(strict=True)] = Field(None, alias="dEzmaxinvoicingsummaryglobalPartner", description="The amount of commission for the partner") - d_ezmaxinvoicingsummaryglobal_net: Optional[constr(strict=True)] = Field(None, alias="dEzmaxinvoicingsummaryglobalNet", description="The net amount of the Ezmaxinvoicingsummaryglobal") - b_ezmaxinvoicingsummaryglobal_adjustment: StrictBool = Field(..., alias="bEzmaxinvoicingsummaryglobalAdjustment", description="Whether it is adjustment for the Ezmaxinvoicingsummaryglobal") - t_ezmaxproduct_help_x: StrictStr = Field(..., alias="tEzmaxproductHelpX", description="The help message of the Ezmaxproduct in the language of the requester") - a_obj_ezmaxinvoicingcommission: Optional[conlist(EzmaxinvoicingcommissionResponseCompound)] = Field(None, alias="a_objEzmaxinvoicingcommission") - __properties = ["pkiEzmaxinvoicingsummaryglobalID", "fkiEzmaxinvoicingID", "fkiEzmaxproductID", "sEzmaxproductDescriptionX", "dtEzmaxinvoicingsummaryglobalStart", "dtEzmaxinvoicingsummaryglobalEnd", "iEzmaxinvoicingsummaryglobalDays", "dEzmaxinvoicingsummaryglobalCountreal", "dEzmaxinvoicingsummaryglobalCountbilled", "dEzmaxinvoicingsummaryglobalSubtotal", "dEzmaxinvoicingsummaryglobalRebateamount", "dEzmaxinvoicingsummaryglobalRebatepercent", "dEzmaxinvoicingsummaryglobalRebatetotal", "dEzmaxinvoicingsummaryglobalTotal", "dEzmaxinvoicingsummaryglobalRepresentative", "dEzmaxinvoicingsummaryglobalPartner", "dEzmaxinvoicingsummaryglobalNet", "bEzmaxinvoicingsummaryglobalAdjustment", "tEzmaxproductHelpX", "a_objEzmaxinvoicingcommission"] - - @validator('d_ezmaxinvoicingsummaryglobal_countreal') + A Ezmaxinvoicingsummaryglobal Object + """ # noqa: E501 + pki_ezmaxinvoicingsummaryglobal_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezmaxinvoicingsummaryglobal", alias="pkiEzmaxinvoicingsummaryglobalID") + fki_ezmaxinvoicing_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezmaxinvoicing", alias="fkiEzmaxinvoicingID") + fki_ezmaxproduct_id: Annotated[int, Field(strict=True, ge=1)] = Field(description="The unique ID of the Ezmaxproduct", alias="fkiEzmaxproductID") + s_ezmaxproduct_description_x: StrictStr = Field(description="The description of the Ezmaxproduct in the language of the requester", alias="sEzmaxproductDescriptionX") + dt_ezmaxinvoicingsummaryglobal_start: StrictStr = Field(description="The start date for the Ezmaxinvoicingsummaryglobal", alias="dtEzmaxinvoicingsummaryglobalStart") + dt_ezmaxinvoicingsummaryglobal_end: StrictStr = Field(description="The end date for the Ezmaxinvoicingsummaryglobal", alias="dtEzmaxinvoicingsummaryglobalEnd") + i_ezmaxinvoicingsummaryglobal_days: Annotated[int, Field(strict=True, ge=1)] = Field(description="The number of days for the Ezmaxinvoicingsummaryglobal", alias="iEzmaxinvoicingsummaryglobalDays") + d_ezmaxinvoicingsummaryglobal_countreal: Annotated[str, Field(strict=True)] = Field(description="The count item calculated", alias="dEzmaxinvoicingsummaryglobalCountreal") + d_ezmaxinvoicingsummaryglobal_countbilled: Annotated[str, Field(strict=True)] = Field(description="The count item billed", alias="dEzmaxinvoicingsummaryglobalCountbilled") + d_ezmaxinvoicingsummaryglobal_subtotal: Annotated[str, Field(strict=True)] = Field(description="The Ezmaxinvoicingsummaryglobal subtotal", alias="dEzmaxinvoicingsummaryglobalSubtotal") + d_ezmaxinvoicingsummaryglobal_rebateamount: Annotated[str, Field(strict=True)] = Field(description="The rebate amount for the Ezmaxinvoicingsummaryglobal", alias="dEzmaxinvoicingsummaryglobalRebateamount") + d_ezmaxinvoicingsummaryglobal_rebatepercent: Annotated[str, Field(strict=True)] = Field(description="The rebate percentage of the Ezmaxinvoicingsummaryglobal", alias="dEzmaxinvoicingsummaryglobalRebatepercent") + d_ezmaxinvoicingsummaryglobal_rebatetotal: Annotated[str, Field(strict=True)] = Field(description="The rebate amount total for the Ezmaxinvoicingsummaryglobal", alias="dEzmaxinvoicingsummaryglobalRebatetotal") + d_ezmaxinvoicingsummaryglobal_total: Annotated[str, Field(strict=True)] = Field(description="The Ezmaxinvoicingsummaryglobal total", alias="dEzmaxinvoicingsummaryglobalTotal") + d_ezmaxinvoicingsummaryglobal_representative: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="The amount of commission for the representative", alias="dEzmaxinvoicingsummaryglobalRepresentative") + d_ezmaxinvoicingsummaryglobal_partner: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="The amount of commission for the partner", alias="dEzmaxinvoicingsummaryglobalPartner") + d_ezmaxinvoicingsummaryglobal_net: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="The net amount of the Ezmaxinvoicingsummaryglobal", alias="dEzmaxinvoicingsummaryglobalNet") + b_ezmaxinvoicingsummaryglobal_adjustment: StrictBool = Field(description="Whether it is adjustment for the Ezmaxinvoicingsummaryglobal", alias="bEzmaxinvoicingsummaryglobalAdjustment") + t_ezmaxproduct_help_x: StrictStr = Field(description="The help message of the Ezmaxproduct in the language of the requester", alias="tEzmaxproductHelpX") + a_obj_ezmaxinvoicingcommission: Optional[List[EzmaxinvoicingcommissionResponseCompound]] = Field(default=None, alias="a_objEzmaxinvoicingcommission") + __properties: ClassVar[List[str]] = ["pkiEzmaxinvoicingsummaryglobalID", "fkiEzmaxinvoicingID", "fkiEzmaxproductID", "sEzmaxproductDescriptionX", "dtEzmaxinvoicingsummaryglobalStart", "dtEzmaxinvoicingsummaryglobalEnd", "iEzmaxinvoicingsummaryglobalDays", "dEzmaxinvoicingsummaryglobalCountreal", "dEzmaxinvoicingsummaryglobalCountbilled", "dEzmaxinvoicingsummaryglobalSubtotal", "dEzmaxinvoicingsummaryglobalRebateamount", "dEzmaxinvoicingsummaryglobalRebatepercent", "dEzmaxinvoicingsummaryglobalRebatetotal", "dEzmaxinvoicingsummaryglobalTotal", "dEzmaxinvoicingsummaryglobalRepresentative", "dEzmaxinvoicingsummaryglobalPartner", "dEzmaxinvoicingsummaryglobalNet", "bEzmaxinvoicingsummaryglobalAdjustment", "tEzmaxproductHelpX", "a_objEzmaxinvoicingcommission"] + + @field_validator('d_ezmaxinvoicingsummaryglobal_countreal') def d_ezmaxinvoicingsummaryglobal_countreal_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^-{0,1}[\d]{1,6}?\.[\d]{2}$", value): raise ValueError(r"must validate the regular expression /^-{0,1}[\d]{1,6}?\.[\d]{2}$/") return value - @validator('d_ezmaxinvoicingsummaryglobal_countbilled') + @field_validator('d_ezmaxinvoicingsummaryglobal_countbilled') def d_ezmaxinvoicingsummaryglobal_countbilled_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^-{0,1}[\d]{1,6}?\.[\d]{2}$", value): raise ValueError(r"must validate the regular expression /^-{0,1}[\d]{1,6}?\.[\d]{2}$/") return value - @validator('d_ezmaxinvoicingsummaryglobal_subtotal') + @field_validator('d_ezmaxinvoicingsummaryglobal_subtotal') def d_ezmaxinvoicingsummaryglobal_subtotal_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^-{0,1}[\d]{1,9}?\.[\d]{2}$", value): raise ValueError(r"must validate the regular expression /^-{0,1}[\d]{1,9}?\.[\d]{2}$/") return value - @validator('d_ezmaxinvoicingsummaryglobal_rebateamount') + @field_validator('d_ezmaxinvoicingsummaryglobal_rebateamount') def d_ezmaxinvoicingsummaryglobal_rebateamount_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^-{0,1}[\d]{1,9}?\.[\d]{2}$", value): raise ValueError(r"must validate the regular expression /^-{0,1}[\d]{1,9}?\.[\d]{2}$/") return value - @validator('d_ezmaxinvoicingsummaryglobal_rebatepercent') + @field_validator('d_ezmaxinvoicingsummaryglobal_rebatepercent') def d_ezmaxinvoicingsummaryglobal_rebatepercent_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^-{0,1}[\d]{1,3}?\.[\d]{2}$", value): raise ValueError(r"must validate the regular expression /^-{0,1}[\d]{1,3}?\.[\d]{2}$/") return value - @validator('d_ezmaxinvoicingsummaryglobal_rebatetotal') + @field_validator('d_ezmaxinvoicingsummaryglobal_rebatetotal') def d_ezmaxinvoicingsummaryglobal_rebatetotal_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^-{0,1}[\d]{1,9}?\.[\d]{2}$", value): raise ValueError(r"must validate the regular expression /^-{0,1}[\d]{1,9}?\.[\d]{2}$/") return value - @validator('d_ezmaxinvoicingsummaryglobal_total') + @field_validator('d_ezmaxinvoicingsummaryglobal_total') def d_ezmaxinvoicingsummaryglobal_total_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^-{0,1}[\d]{1,9}?\.[\d]{2}$", value): raise ValueError(r"must validate the regular expression /^-{0,1}[\d]{1,9}?\.[\d]{2}$/") return value - @validator('d_ezmaxinvoicingsummaryglobal_representative') + @field_validator('d_ezmaxinvoicingsummaryglobal_representative') def d_ezmaxinvoicingsummaryglobal_representative_validate_regular_expression(cls, value): """Validates the regular expression""" if value is None: @@ -108,7 +114,7 @@ def d_ezmaxinvoicingsummaryglobal_representative_validate_regular_expression(cls raise ValueError(r"must validate the regular expression /^-{0,1}[\d]{1,9}?\.[\d]{2}$/") return value - @validator('d_ezmaxinvoicingsummaryglobal_partner') + @field_validator('d_ezmaxinvoicingsummaryglobal_partner') def d_ezmaxinvoicingsummaryglobal_partner_validate_regular_expression(cls, value): """Validates the regular expression""" if value is None: @@ -118,7 +124,7 @@ def d_ezmaxinvoicingsummaryglobal_partner_validate_regular_expression(cls, value raise ValueError(r"must validate the regular expression /^-{0,1}[\d]{1,9}?\.[\d]{2}$/") return value - @validator('d_ezmaxinvoicingsummaryglobal_net') + @field_validator('d_ezmaxinvoicingsummaryglobal_net') def d_ezmaxinvoicingsummaryglobal_net_validate_regular_expression(cls, value): """Validates the regular expression""" if value is None: @@ -128,30 +134,43 @@ def d_ezmaxinvoicingsummaryglobal_net_validate_regular_expression(cls, value): raise ValueError(r"must validate the regular expression /^-{0,1}[\d]{1,9}?\.[\d]{2}$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzmaxinvoicingsummaryglobalResponseCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzmaxinvoicingsummaryglobalResponseCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_ezmaxinvoicingcommission (list) _items = [] if self.a_obj_ezmaxinvoicingcommission: @@ -162,35 +181,35 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzmaxinvoicingsummaryglobalResponseCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzmaxinvoicingsummaryglobalResponseCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzmaxinvoicingsummaryglobalResponseCompound.parse_obj(obj) - - _obj = EzmaxinvoicingsummaryglobalResponseCompound.parse_obj({ - "pki_ezmaxinvoicingsummaryglobal_id": obj.get("pkiEzmaxinvoicingsummaryglobalID"), - "fki_ezmaxinvoicing_id": obj.get("fkiEzmaxinvoicingID"), - "fki_ezmaxproduct_id": obj.get("fkiEzmaxproductID"), - "s_ezmaxproduct_description_x": obj.get("sEzmaxproductDescriptionX"), - "dt_ezmaxinvoicingsummaryglobal_start": obj.get("dtEzmaxinvoicingsummaryglobalStart"), - "dt_ezmaxinvoicingsummaryglobal_end": obj.get("dtEzmaxinvoicingsummaryglobalEnd"), - "i_ezmaxinvoicingsummaryglobal_days": obj.get("iEzmaxinvoicingsummaryglobalDays"), - "d_ezmaxinvoicingsummaryglobal_countreal": obj.get("dEzmaxinvoicingsummaryglobalCountreal"), - "d_ezmaxinvoicingsummaryglobal_countbilled": obj.get("dEzmaxinvoicingsummaryglobalCountbilled"), - "d_ezmaxinvoicingsummaryglobal_subtotal": obj.get("dEzmaxinvoicingsummaryglobalSubtotal"), - "d_ezmaxinvoicingsummaryglobal_rebateamount": obj.get("dEzmaxinvoicingsummaryglobalRebateamount"), - "d_ezmaxinvoicingsummaryglobal_rebatepercent": obj.get("dEzmaxinvoicingsummaryglobalRebatepercent"), - "d_ezmaxinvoicingsummaryglobal_rebatetotal": obj.get("dEzmaxinvoicingsummaryglobalRebatetotal"), - "d_ezmaxinvoicingsummaryglobal_total": obj.get("dEzmaxinvoicingsummaryglobalTotal"), - "d_ezmaxinvoicingsummaryglobal_representative": obj.get("dEzmaxinvoicingsummaryglobalRepresentative"), - "d_ezmaxinvoicingsummaryglobal_partner": obj.get("dEzmaxinvoicingsummaryglobalPartner"), - "d_ezmaxinvoicingsummaryglobal_net": obj.get("dEzmaxinvoicingsummaryglobalNet"), - "b_ezmaxinvoicingsummaryglobal_adjustment": obj.get("bEzmaxinvoicingsummaryglobalAdjustment"), - "t_ezmaxproduct_help_x": obj.get("tEzmaxproductHelpX"), - "a_obj_ezmaxinvoicingcommission": [EzmaxinvoicingcommissionResponseCompound.from_dict(_item) for _item in obj.get("a_objEzmaxinvoicingcommission")] if obj.get("a_objEzmaxinvoicingcommission") is not None else None + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzmaxinvoicingsummaryglobalID": obj.get("pkiEzmaxinvoicingsummaryglobalID"), + "fkiEzmaxinvoicingID": obj.get("fkiEzmaxinvoicingID"), + "fkiEzmaxproductID": obj.get("fkiEzmaxproductID"), + "sEzmaxproductDescriptionX": obj.get("sEzmaxproductDescriptionX"), + "dtEzmaxinvoicingsummaryglobalStart": obj.get("dtEzmaxinvoicingsummaryglobalStart"), + "dtEzmaxinvoicingsummaryglobalEnd": obj.get("dtEzmaxinvoicingsummaryglobalEnd"), + "iEzmaxinvoicingsummaryglobalDays": obj.get("iEzmaxinvoicingsummaryglobalDays"), + "dEzmaxinvoicingsummaryglobalCountreal": obj.get("dEzmaxinvoicingsummaryglobalCountreal"), + "dEzmaxinvoicingsummaryglobalCountbilled": obj.get("dEzmaxinvoicingsummaryglobalCountbilled"), + "dEzmaxinvoicingsummaryglobalSubtotal": obj.get("dEzmaxinvoicingsummaryglobalSubtotal"), + "dEzmaxinvoicingsummaryglobalRebateamount": obj.get("dEzmaxinvoicingsummaryglobalRebateamount"), + "dEzmaxinvoicingsummaryglobalRebatepercent": obj.get("dEzmaxinvoicingsummaryglobalRebatepercent"), + "dEzmaxinvoicingsummaryglobalRebatetotal": obj.get("dEzmaxinvoicingsummaryglobalRebatetotal"), + "dEzmaxinvoicingsummaryglobalTotal": obj.get("dEzmaxinvoicingsummaryglobalTotal"), + "dEzmaxinvoicingsummaryglobalRepresentative": obj.get("dEzmaxinvoicingsummaryglobalRepresentative"), + "dEzmaxinvoicingsummaryglobalPartner": obj.get("dEzmaxinvoicingsummaryglobalPartner"), + "dEzmaxinvoicingsummaryglobalNet": obj.get("dEzmaxinvoicingsummaryglobalNet"), + "bEzmaxinvoicingsummaryglobalAdjustment": obj.get("bEzmaxinvoicingsummaryglobalAdjustment"), + "tEzmaxproductHelpX": obj.get("tEzmaxproductHelpX"), + "a_objEzmaxinvoicingcommission": [EzmaxinvoicingcommissionResponseCompound.from_dict(_item) for _item in obj.get("a_objEzmaxinvoicingcommission")] if obj.get("a_objEzmaxinvoicingcommission") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezmaxinvoicingsummaryinternal_response.py b/eZmaxApi/models/ezmaxinvoicingsummaryinternal_response.py index 7e5cadb91..2e72d77d6 100644 --- a/eZmaxApi/models/ezmaxinvoicingsummaryinternal_response.py +++ b/eZmaxApi/models/ezmaxinvoicingsummaryinternal_response.py @@ -19,67 +19,86 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictStr, conint, constr +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictStr +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.multilingual_ezmaxinvoicingsummaryinternal_description import MultilingualEzmaxinvoicingsummaryinternalDescription +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzmaxinvoicingsummaryinternalResponse(BaseModel): """ - A Ezmaxinvoicingsummaryinternal Object # noqa: E501 - """ - pki_ezmaxinvoicingsummaryinternal_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="pkiEzmaxinvoicingsummaryinternalID", description="The unique ID of the Ezmaxinvoicingsummaryinternal") - obj_ezmaxinvoicingsummaryinternal_description: MultilingualEzmaxinvoicingsummaryinternalDescription = Field(..., alias="objEzmaxinvoicingsummaryinternalDescription") - s_ezmaxinvoicingsummaryinternal_description_x: constr(strict=True, max_length=70) = Field(..., alias="sEzmaxinvoicingsummaryinternalDescriptionX", description="The Ezmaxinvoicingsummaryinternal description in the language of the requester") - fki_ezmaxinvoicing_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiEzmaxinvoicingID", description="The unique ID of the Ezmaxinvoicing") - fki_billingentityinternal_id: conint(strict=True, ge=0) = Field(..., alias="fkiBillingentityinternalID", description="The unique ID of the Billingentityinternal.") - s_billingentityinternal_description_x: StrictStr = Field(..., alias="sBillingentityinternalDescriptionX", description="The description of the Billingentityinternal in the language of the requester") - __properties = ["pkiEzmaxinvoicingsummaryinternalID", "objEzmaxinvoicingsummaryinternalDescription", "sEzmaxinvoicingsummaryinternalDescriptionX", "fkiEzmaxinvoicingID", "fkiBillingentityinternalID", "sBillingentityinternalDescriptionX"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + A Ezmaxinvoicingsummaryinternal Object + """ # noqa: E501 + pki_ezmaxinvoicingsummaryinternal_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezmaxinvoicingsummaryinternal", alias="pkiEzmaxinvoicingsummaryinternalID") + obj_ezmaxinvoicingsummaryinternal_description: MultilingualEzmaxinvoicingsummaryinternalDescription = Field(alias="objEzmaxinvoicingsummaryinternalDescription") + s_ezmaxinvoicingsummaryinternal_description_x: Annotated[str, Field(strict=True, max_length=70)] = Field(description="The Ezmaxinvoicingsummaryinternal description in the language of the requester", alias="sEzmaxinvoicingsummaryinternalDescriptionX") + fki_ezmaxinvoicing_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezmaxinvoicing", alias="fkiEzmaxinvoicingID") + fki_billingentityinternal_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Billingentityinternal.", alias="fkiBillingentityinternalID") + s_billingentityinternal_description_x: StrictStr = Field(description="The description of the Billingentityinternal in the language of the requester", alias="sBillingentityinternalDescriptionX") + __properties: ClassVar[List[str]] = ["pkiEzmaxinvoicingsummaryinternalID", "objEzmaxinvoicingsummaryinternalDescription", "sEzmaxinvoicingsummaryinternalDescriptionX", "fkiEzmaxinvoicingID", "fkiBillingentityinternalID", "sBillingentityinternalDescriptionX"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzmaxinvoicingsummaryinternalResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzmaxinvoicingsummaryinternalResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_ezmaxinvoicingsummaryinternal_description if self.obj_ezmaxinvoicingsummaryinternal_description: _dict['objEzmaxinvoicingsummaryinternalDescription'] = self.obj_ezmaxinvoicingsummaryinternal_description.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> EzmaxinvoicingsummaryinternalResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzmaxinvoicingsummaryinternalResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzmaxinvoicingsummaryinternalResponse.parse_obj(obj) - - _obj = EzmaxinvoicingsummaryinternalResponse.parse_obj({ - "pki_ezmaxinvoicingsummaryinternal_id": obj.get("pkiEzmaxinvoicingsummaryinternalID"), - "obj_ezmaxinvoicingsummaryinternal_description": MultilingualEzmaxinvoicingsummaryinternalDescription.from_dict(obj.get("objEzmaxinvoicingsummaryinternalDescription")) if obj.get("objEzmaxinvoicingsummaryinternalDescription") is not None else None, - "s_ezmaxinvoicingsummaryinternal_description_x": obj.get("sEzmaxinvoicingsummaryinternalDescriptionX"), - "fki_ezmaxinvoicing_id": obj.get("fkiEzmaxinvoicingID"), - "fki_billingentityinternal_id": obj.get("fkiBillingentityinternalID"), - "s_billingentityinternal_description_x": obj.get("sBillingentityinternalDescriptionX") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzmaxinvoicingsummaryinternalID": obj.get("pkiEzmaxinvoicingsummaryinternalID"), + "objEzmaxinvoicingsummaryinternalDescription": MultilingualEzmaxinvoicingsummaryinternalDescription.from_dict(obj.get("objEzmaxinvoicingsummaryinternalDescription")) if obj.get("objEzmaxinvoicingsummaryinternalDescription") is not None else None, + "sEzmaxinvoicingsummaryinternalDescriptionX": obj.get("sEzmaxinvoicingsummaryinternalDescriptionX"), + "fkiEzmaxinvoicingID": obj.get("fkiEzmaxinvoicingID"), + "fkiBillingentityinternalID": obj.get("fkiBillingentityinternalID"), + "sBillingentityinternalDescriptionX": obj.get("sBillingentityinternalDescriptionX") }) return _obj diff --git a/eZmaxApi/models/ezmaxinvoicingsummaryinternal_response_compound.py b/eZmaxApi/models/ezmaxinvoicingsummaryinternal_response_compound.py index 95458bdcc..3be9cd7da 100644 --- a/eZmaxApi/models/ezmaxinvoicingsummaryinternal_response_compound.py +++ b/eZmaxApi/models/ezmaxinvoicingsummaryinternal_response_compound.py @@ -19,48 +19,67 @@ import json -from typing import List, Optional -from pydantic import BaseModel, Field, StrictStr, conint, conlist, constr +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictStr +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.ezmaxinvoicingsummaryinternaldetail_response_compound import EzmaxinvoicingsummaryinternaldetailResponseCompound from eZmaxApi.models.multilingual_ezmaxinvoicingsummaryinternal_description import MultilingualEzmaxinvoicingsummaryinternalDescription +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzmaxinvoicingsummaryinternalResponseCompound(BaseModel): """ - A Ezmaxinvoicingsummaryinternal Object # noqa: E501 - """ - pki_ezmaxinvoicingsummaryinternal_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="pkiEzmaxinvoicingsummaryinternalID", description="The unique ID of the Ezmaxinvoicingsummaryinternal") - obj_ezmaxinvoicingsummaryinternal_description: MultilingualEzmaxinvoicingsummaryinternalDescription = Field(..., alias="objEzmaxinvoicingsummaryinternalDescription") - s_ezmaxinvoicingsummaryinternal_description_x: constr(strict=True, max_length=70) = Field(..., alias="sEzmaxinvoicingsummaryinternalDescriptionX", description="The Ezmaxinvoicingsummaryinternal description in the language of the requester") - fki_ezmaxinvoicing_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiEzmaxinvoicingID", description="The unique ID of the Ezmaxinvoicing") - fki_billingentityinternal_id: conint(strict=True, ge=0) = Field(..., alias="fkiBillingentityinternalID", description="The unique ID of the Billingentityinternal.") - s_billingentityinternal_description_x: StrictStr = Field(..., alias="sBillingentityinternalDescriptionX", description="The description of the Billingentityinternal in the language of the requester") - a_obj_ezmaxinvoicingsummaryinternaldetail: conlist(EzmaxinvoicingsummaryinternaldetailResponseCompound) = Field(..., alias="a_objEzmaxinvoicingsummaryinternaldetail") - __properties = ["pkiEzmaxinvoicingsummaryinternalID", "objEzmaxinvoicingsummaryinternalDescription", "sEzmaxinvoicingsummaryinternalDescriptionX", "fkiEzmaxinvoicingID", "fkiBillingentityinternalID", "sBillingentityinternalDescriptionX", "a_objEzmaxinvoicingsummaryinternaldetail"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + A Ezmaxinvoicingsummaryinternal Object + """ # noqa: E501 + pki_ezmaxinvoicingsummaryinternal_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezmaxinvoicingsummaryinternal", alias="pkiEzmaxinvoicingsummaryinternalID") + obj_ezmaxinvoicingsummaryinternal_description: MultilingualEzmaxinvoicingsummaryinternalDescription = Field(alias="objEzmaxinvoicingsummaryinternalDescription") + s_ezmaxinvoicingsummaryinternal_description_x: Annotated[str, Field(strict=True, max_length=70)] = Field(description="The Ezmaxinvoicingsummaryinternal description in the language of the requester", alias="sEzmaxinvoicingsummaryinternalDescriptionX") + fki_ezmaxinvoicing_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezmaxinvoicing", alias="fkiEzmaxinvoicingID") + fki_billingentityinternal_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Billingentityinternal.", alias="fkiBillingentityinternalID") + s_billingentityinternal_description_x: StrictStr = Field(description="The description of the Billingentityinternal in the language of the requester", alias="sBillingentityinternalDescriptionX") + a_obj_ezmaxinvoicingsummaryinternaldetail: List[EzmaxinvoicingsummaryinternaldetailResponseCompound] = Field(alias="a_objEzmaxinvoicingsummaryinternaldetail") + __properties: ClassVar[List[str]] = ["pkiEzmaxinvoicingsummaryinternalID", "objEzmaxinvoicingsummaryinternalDescription", "sEzmaxinvoicingsummaryinternalDescriptionX", "fkiEzmaxinvoicingID", "fkiBillingentityinternalID", "sBillingentityinternalDescriptionX", "a_objEzmaxinvoicingsummaryinternaldetail"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzmaxinvoicingsummaryinternalResponseCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzmaxinvoicingsummaryinternalResponseCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_ezmaxinvoicingsummaryinternal_description if self.obj_ezmaxinvoicingsummaryinternal_description: _dict['objEzmaxinvoicingsummaryinternalDescription'] = self.obj_ezmaxinvoicingsummaryinternal_description.to_dict() @@ -74,22 +93,22 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzmaxinvoicingsummaryinternalResponseCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzmaxinvoicingsummaryinternalResponseCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzmaxinvoicingsummaryinternalResponseCompound.parse_obj(obj) - - _obj = EzmaxinvoicingsummaryinternalResponseCompound.parse_obj({ - "pki_ezmaxinvoicingsummaryinternal_id": obj.get("pkiEzmaxinvoicingsummaryinternalID"), - "obj_ezmaxinvoicingsummaryinternal_description": MultilingualEzmaxinvoicingsummaryinternalDescription.from_dict(obj.get("objEzmaxinvoicingsummaryinternalDescription")) if obj.get("objEzmaxinvoicingsummaryinternalDescription") is not None else None, - "s_ezmaxinvoicingsummaryinternal_description_x": obj.get("sEzmaxinvoicingsummaryinternalDescriptionX"), - "fki_ezmaxinvoicing_id": obj.get("fkiEzmaxinvoicingID"), - "fki_billingentityinternal_id": obj.get("fkiBillingentityinternalID"), - "s_billingentityinternal_description_x": obj.get("sBillingentityinternalDescriptionX"), - "a_obj_ezmaxinvoicingsummaryinternaldetail": [EzmaxinvoicingsummaryinternaldetailResponseCompound.from_dict(_item) for _item in obj.get("a_objEzmaxinvoicingsummaryinternaldetail")] if obj.get("a_objEzmaxinvoicingsummaryinternaldetail") is not None else None + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzmaxinvoicingsummaryinternalID": obj.get("pkiEzmaxinvoicingsummaryinternalID"), + "objEzmaxinvoicingsummaryinternalDescription": MultilingualEzmaxinvoicingsummaryinternalDescription.from_dict(obj.get("objEzmaxinvoicingsummaryinternalDescription")) if obj.get("objEzmaxinvoicingsummaryinternalDescription") is not None else None, + "sEzmaxinvoicingsummaryinternalDescriptionX": obj.get("sEzmaxinvoicingsummaryinternalDescriptionX"), + "fkiEzmaxinvoicingID": obj.get("fkiEzmaxinvoicingID"), + "fkiBillingentityinternalID": obj.get("fkiBillingentityinternalID"), + "sBillingentityinternalDescriptionX": obj.get("sBillingentityinternalDescriptionX"), + "a_objEzmaxinvoicingsummaryinternaldetail": [EzmaxinvoicingsummaryinternaldetailResponseCompound.from_dict(_item) for _item in obj.get("a_objEzmaxinvoicingsummaryinternaldetail")] if obj.get("a_objEzmaxinvoicingsummaryinternaldetail") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezmaxinvoicingsummaryinternaldetail_response.py b/eZmaxApi/models/ezmaxinvoicingsummaryinternaldetail_response.py index 85e3a086b..a6e406c44 100644 --- a/eZmaxApi/models/ezmaxinvoicingsummaryinternaldetail_response.py +++ b/eZmaxApi/models/ezmaxinvoicingsummaryinternaldetail_response.py @@ -19,103 +19,122 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint, constr, validator +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, StrictStr, field_validator +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzmaxinvoicingsummaryinternaldetailResponse(BaseModel): """ - A Ezmaxinvoicingsummaryinternaldetail Object # noqa: E501 - """ - pki_ezmaxinvoicingsummaryinternaldetail_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="pkiEzmaxinvoicingsummaryinternaldetailID", description="The unique ID of the Ezmaxinvoicingsummaryinternaldetail") - fki_ezmaxinvoicingsummaryinternal_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiEzmaxinvoicingsummaryinternalID", description="The unique ID of the Ezmaxinvoicingsummaryinternal") - fki_ezmaxproduct_id: conint(strict=True, ge=1) = Field(..., alias="fkiEzmaxproductID", description="The unique ID of the Ezmaxproduct") - s_ezmaxproduct_description_x: StrictStr = Field(..., alias="sEzmaxproductDescriptionX", description="The description of the Ezmaxproduct in the language of the requester") - fki_billingentityexternal_id: conint(strict=True, ge=1) = Field(..., alias="fkiBillingentityexternalID", description="The unique ID of the Billingentityexternal") - s_billingentityexternal_description: StrictStr = Field(..., alias="sBillingentityexternalDescription", description="The description of the Billingentityexternal") - d_ezmaxinvoicingsummaryinternaldetail_countreal: constr(strict=True) = Field(..., alias="dEzmaxinvoicingsummaryinternaldetailCountreal", description="The count item invoiced for the product") - d_ezmaxinvoicingsummaryinternaldetail_subtotal: constr(strict=True) = Field(..., alias="dEzmaxinvoicingsummaryinternaldetailSubtotal", description="The subtotal invoiced for the product") - d_ezmaxinvoicingsummaryinternaldetail_rebate: constr(strict=True) = Field(..., alias="dEzmaxinvoicingsummaryinternaldetailRebate", description="The rebate for the product") - d_ezmaxinvoicingsummaryinternaldetail_total: constr(strict=True) = Field(..., alias="dEzmaxinvoicingsummaryinternaldetailTotal", description="The total invoiced for the product") - b_ezmaxinvoicingsummaryinternaldetail_adjustment: StrictBool = Field(..., alias="bEzmaxinvoicingsummaryinternaldetailAdjustment", description="Whether if it's an adjustment") - t_ezmaxproduct_help_x: StrictStr = Field(..., alias="tEzmaxproductHelpX", description="The help message of the Ezmaxproduct in the language of the requester") - __properties = ["pkiEzmaxinvoicingsummaryinternaldetailID", "fkiEzmaxinvoicingsummaryinternalID", "fkiEzmaxproductID", "sEzmaxproductDescriptionX", "fkiBillingentityexternalID", "sBillingentityexternalDescription", "dEzmaxinvoicingsummaryinternaldetailCountreal", "dEzmaxinvoicingsummaryinternaldetailSubtotal", "dEzmaxinvoicingsummaryinternaldetailRebate", "dEzmaxinvoicingsummaryinternaldetailTotal", "bEzmaxinvoicingsummaryinternaldetailAdjustment", "tEzmaxproductHelpX"] - - @validator('d_ezmaxinvoicingsummaryinternaldetail_countreal') + A Ezmaxinvoicingsummaryinternaldetail Object + """ # noqa: E501 + pki_ezmaxinvoicingsummaryinternaldetail_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezmaxinvoicingsummaryinternaldetail", alias="pkiEzmaxinvoicingsummaryinternaldetailID") + fki_ezmaxinvoicingsummaryinternal_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezmaxinvoicingsummaryinternal", alias="fkiEzmaxinvoicingsummaryinternalID") + fki_ezmaxproduct_id: Annotated[int, Field(strict=True, ge=1)] = Field(description="The unique ID of the Ezmaxproduct", alias="fkiEzmaxproductID") + s_ezmaxproduct_description_x: StrictStr = Field(description="The description of the Ezmaxproduct in the language of the requester", alias="sEzmaxproductDescriptionX") + fki_billingentityexternal_id: Annotated[int, Field(strict=True, ge=1)] = Field(description="The unique ID of the Billingentityexternal", alias="fkiBillingentityexternalID") + s_billingentityexternal_description: StrictStr = Field(description="The description of the Billingentityexternal", alias="sBillingentityexternalDescription") + d_ezmaxinvoicingsummaryinternaldetail_countreal: Annotated[str, Field(strict=True)] = Field(description="The count item invoiced for the product", alias="dEzmaxinvoicingsummaryinternaldetailCountreal") + d_ezmaxinvoicingsummaryinternaldetail_subtotal: Annotated[str, Field(strict=True)] = Field(description="The subtotal invoiced for the product", alias="dEzmaxinvoicingsummaryinternaldetailSubtotal") + d_ezmaxinvoicingsummaryinternaldetail_rebate: Annotated[str, Field(strict=True)] = Field(description="The rebate for the product", alias="dEzmaxinvoicingsummaryinternaldetailRebate") + d_ezmaxinvoicingsummaryinternaldetail_total: Annotated[str, Field(strict=True)] = Field(description="The total invoiced for the product", alias="dEzmaxinvoicingsummaryinternaldetailTotal") + b_ezmaxinvoicingsummaryinternaldetail_adjustment: StrictBool = Field(description="Whether if it's an adjustment", alias="bEzmaxinvoicingsummaryinternaldetailAdjustment") + t_ezmaxproduct_help_x: StrictStr = Field(description="The help message of the Ezmaxproduct in the language of the requester", alias="tEzmaxproductHelpX") + __properties: ClassVar[List[str]] = ["pkiEzmaxinvoicingsummaryinternaldetailID", "fkiEzmaxinvoicingsummaryinternalID", "fkiEzmaxproductID", "sEzmaxproductDescriptionX", "fkiBillingentityexternalID", "sBillingentityexternalDescription", "dEzmaxinvoicingsummaryinternaldetailCountreal", "dEzmaxinvoicingsummaryinternaldetailSubtotal", "dEzmaxinvoicingsummaryinternaldetailRebate", "dEzmaxinvoicingsummaryinternaldetailTotal", "bEzmaxinvoicingsummaryinternaldetailAdjustment", "tEzmaxproductHelpX"] + + @field_validator('d_ezmaxinvoicingsummaryinternaldetail_countreal') def d_ezmaxinvoicingsummaryinternaldetail_countreal_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^-{0,1}[\d]{1,6}?\.[\d]{2}$", value): raise ValueError(r"must validate the regular expression /^-{0,1}[\d]{1,6}?\.[\d]{2}$/") return value - @validator('d_ezmaxinvoicingsummaryinternaldetail_subtotal') + @field_validator('d_ezmaxinvoicingsummaryinternaldetail_subtotal') def d_ezmaxinvoicingsummaryinternaldetail_subtotal_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^-{0,1}[\d]{1,9}?\.[\d]{2}$", value): raise ValueError(r"must validate the regular expression /^-{0,1}[\d]{1,9}?\.[\d]{2}$/") return value - @validator('d_ezmaxinvoicingsummaryinternaldetail_rebate') + @field_validator('d_ezmaxinvoicingsummaryinternaldetail_rebate') def d_ezmaxinvoicingsummaryinternaldetail_rebate_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^-{0,1}[\d]{1,9}?\.[\d]{2}$", value): raise ValueError(r"must validate the regular expression /^-{0,1}[\d]{1,9}?\.[\d]{2}$/") return value - @validator('d_ezmaxinvoicingsummaryinternaldetail_total') + @field_validator('d_ezmaxinvoicingsummaryinternaldetail_total') def d_ezmaxinvoicingsummaryinternaldetail_total_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^-{0,1}[\d]{1,9}?\.[\d]{2}$", value): raise ValueError(r"must validate the regular expression /^-{0,1}[\d]{1,9}?\.[\d]{2}$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzmaxinvoicingsummaryinternaldetailResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzmaxinvoicingsummaryinternaldetailResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzmaxinvoicingsummaryinternaldetailResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzmaxinvoicingsummaryinternaldetailResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzmaxinvoicingsummaryinternaldetailResponse.parse_obj(obj) - - _obj = EzmaxinvoicingsummaryinternaldetailResponse.parse_obj({ - "pki_ezmaxinvoicingsummaryinternaldetail_id": obj.get("pkiEzmaxinvoicingsummaryinternaldetailID"), - "fki_ezmaxinvoicingsummaryinternal_id": obj.get("fkiEzmaxinvoicingsummaryinternalID"), - "fki_ezmaxproduct_id": obj.get("fkiEzmaxproductID"), - "s_ezmaxproduct_description_x": obj.get("sEzmaxproductDescriptionX"), - "fki_billingentityexternal_id": obj.get("fkiBillingentityexternalID"), - "s_billingentityexternal_description": obj.get("sBillingentityexternalDescription"), - "d_ezmaxinvoicingsummaryinternaldetail_countreal": obj.get("dEzmaxinvoicingsummaryinternaldetailCountreal"), - "d_ezmaxinvoicingsummaryinternaldetail_subtotal": obj.get("dEzmaxinvoicingsummaryinternaldetailSubtotal"), - "d_ezmaxinvoicingsummaryinternaldetail_rebate": obj.get("dEzmaxinvoicingsummaryinternaldetailRebate"), - "d_ezmaxinvoicingsummaryinternaldetail_total": obj.get("dEzmaxinvoicingsummaryinternaldetailTotal"), - "b_ezmaxinvoicingsummaryinternaldetail_adjustment": obj.get("bEzmaxinvoicingsummaryinternaldetailAdjustment"), - "t_ezmaxproduct_help_x": obj.get("tEzmaxproductHelpX") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzmaxinvoicingsummaryinternaldetailID": obj.get("pkiEzmaxinvoicingsummaryinternaldetailID"), + "fkiEzmaxinvoicingsummaryinternalID": obj.get("fkiEzmaxinvoicingsummaryinternalID"), + "fkiEzmaxproductID": obj.get("fkiEzmaxproductID"), + "sEzmaxproductDescriptionX": obj.get("sEzmaxproductDescriptionX"), + "fkiBillingentityexternalID": obj.get("fkiBillingentityexternalID"), + "sBillingentityexternalDescription": obj.get("sBillingentityexternalDescription"), + "dEzmaxinvoicingsummaryinternaldetailCountreal": obj.get("dEzmaxinvoicingsummaryinternaldetailCountreal"), + "dEzmaxinvoicingsummaryinternaldetailSubtotal": obj.get("dEzmaxinvoicingsummaryinternaldetailSubtotal"), + "dEzmaxinvoicingsummaryinternaldetailRebate": obj.get("dEzmaxinvoicingsummaryinternaldetailRebate"), + "dEzmaxinvoicingsummaryinternaldetailTotal": obj.get("dEzmaxinvoicingsummaryinternaldetailTotal"), + "bEzmaxinvoicingsummaryinternaldetailAdjustment": obj.get("bEzmaxinvoicingsummaryinternaldetailAdjustment"), + "tEzmaxproductHelpX": obj.get("tEzmaxproductHelpX") }) return _obj diff --git a/eZmaxApi/models/ezmaxinvoicingsummaryinternaldetail_response_compound.py b/eZmaxApi/models/ezmaxinvoicingsummaryinternaldetail_response_compound.py index 5eb8f2cd5..e3e256e75 100644 --- a/eZmaxApi/models/ezmaxinvoicingsummaryinternaldetail_response_compound.py +++ b/eZmaxApi/models/ezmaxinvoicingsummaryinternaldetail_response_compound.py @@ -19,103 +19,122 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint, constr, validator +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, StrictStr, field_validator +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzmaxinvoicingsummaryinternaldetailResponseCompound(BaseModel): """ - A Ezmaxinvoicingsummaryinternaldetail Object # noqa: E501 - """ - pki_ezmaxinvoicingsummaryinternaldetail_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="pkiEzmaxinvoicingsummaryinternaldetailID", description="The unique ID of the Ezmaxinvoicingsummaryinternaldetail") - fki_ezmaxinvoicingsummaryinternal_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiEzmaxinvoicingsummaryinternalID", description="The unique ID of the Ezmaxinvoicingsummaryinternal") - fki_ezmaxproduct_id: conint(strict=True, ge=1) = Field(..., alias="fkiEzmaxproductID", description="The unique ID of the Ezmaxproduct") - s_ezmaxproduct_description_x: StrictStr = Field(..., alias="sEzmaxproductDescriptionX", description="The description of the Ezmaxproduct in the language of the requester") - fki_billingentityexternal_id: conint(strict=True, ge=1) = Field(..., alias="fkiBillingentityexternalID", description="The unique ID of the Billingentityexternal") - s_billingentityexternal_description: StrictStr = Field(..., alias="sBillingentityexternalDescription", description="The description of the Billingentityexternal") - d_ezmaxinvoicingsummaryinternaldetail_countreal: constr(strict=True) = Field(..., alias="dEzmaxinvoicingsummaryinternaldetailCountreal", description="The count item invoiced for the product") - d_ezmaxinvoicingsummaryinternaldetail_subtotal: constr(strict=True) = Field(..., alias="dEzmaxinvoicingsummaryinternaldetailSubtotal", description="The subtotal invoiced for the product") - d_ezmaxinvoicingsummaryinternaldetail_rebate: constr(strict=True) = Field(..., alias="dEzmaxinvoicingsummaryinternaldetailRebate", description="The rebate for the product") - d_ezmaxinvoicingsummaryinternaldetail_total: constr(strict=True) = Field(..., alias="dEzmaxinvoicingsummaryinternaldetailTotal", description="The total invoiced for the product") - b_ezmaxinvoicingsummaryinternaldetail_adjustment: StrictBool = Field(..., alias="bEzmaxinvoicingsummaryinternaldetailAdjustment", description="Whether if it's an adjustment") - t_ezmaxproduct_help_x: StrictStr = Field(..., alias="tEzmaxproductHelpX", description="The help message of the Ezmaxproduct in the language of the requester") - __properties = ["pkiEzmaxinvoicingsummaryinternaldetailID", "fkiEzmaxinvoicingsummaryinternalID", "fkiEzmaxproductID", "sEzmaxproductDescriptionX", "fkiBillingentityexternalID", "sBillingentityexternalDescription", "dEzmaxinvoicingsummaryinternaldetailCountreal", "dEzmaxinvoicingsummaryinternaldetailSubtotal", "dEzmaxinvoicingsummaryinternaldetailRebate", "dEzmaxinvoicingsummaryinternaldetailTotal", "bEzmaxinvoicingsummaryinternaldetailAdjustment", "tEzmaxproductHelpX"] - - @validator('d_ezmaxinvoicingsummaryinternaldetail_countreal') + A Ezmaxinvoicingsummaryinternaldetail Object + """ # noqa: E501 + pki_ezmaxinvoicingsummaryinternaldetail_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezmaxinvoicingsummaryinternaldetail", alias="pkiEzmaxinvoicingsummaryinternaldetailID") + fki_ezmaxinvoicingsummaryinternal_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezmaxinvoicingsummaryinternal", alias="fkiEzmaxinvoicingsummaryinternalID") + fki_ezmaxproduct_id: Annotated[int, Field(strict=True, ge=1)] = Field(description="The unique ID of the Ezmaxproduct", alias="fkiEzmaxproductID") + s_ezmaxproduct_description_x: StrictStr = Field(description="The description of the Ezmaxproduct in the language of the requester", alias="sEzmaxproductDescriptionX") + fki_billingentityexternal_id: Annotated[int, Field(strict=True, ge=1)] = Field(description="The unique ID of the Billingentityexternal", alias="fkiBillingentityexternalID") + s_billingentityexternal_description: StrictStr = Field(description="The description of the Billingentityexternal", alias="sBillingentityexternalDescription") + d_ezmaxinvoicingsummaryinternaldetail_countreal: Annotated[str, Field(strict=True)] = Field(description="The count item invoiced for the product", alias="dEzmaxinvoicingsummaryinternaldetailCountreal") + d_ezmaxinvoicingsummaryinternaldetail_subtotal: Annotated[str, Field(strict=True)] = Field(description="The subtotal invoiced for the product", alias="dEzmaxinvoicingsummaryinternaldetailSubtotal") + d_ezmaxinvoicingsummaryinternaldetail_rebate: Annotated[str, Field(strict=True)] = Field(description="The rebate for the product", alias="dEzmaxinvoicingsummaryinternaldetailRebate") + d_ezmaxinvoicingsummaryinternaldetail_total: Annotated[str, Field(strict=True)] = Field(description="The total invoiced for the product", alias="dEzmaxinvoicingsummaryinternaldetailTotal") + b_ezmaxinvoicingsummaryinternaldetail_adjustment: StrictBool = Field(description="Whether if it's an adjustment", alias="bEzmaxinvoicingsummaryinternaldetailAdjustment") + t_ezmaxproduct_help_x: StrictStr = Field(description="The help message of the Ezmaxproduct in the language of the requester", alias="tEzmaxproductHelpX") + __properties: ClassVar[List[str]] = ["pkiEzmaxinvoicingsummaryinternaldetailID", "fkiEzmaxinvoicingsummaryinternalID", "fkiEzmaxproductID", "sEzmaxproductDescriptionX", "fkiBillingentityexternalID", "sBillingentityexternalDescription", "dEzmaxinvoicingsummaryinternaldetailCountreal", "dEzmaxinvoicingsummaryinternaldetailSubtotal", "dEzmaxinvoicingsummaryinternaldetailRebate", "dEzmaxinvoicingsummaryinternaldetailTotal", "bEzmaxinvoicingsummaryinternaldetailAdjustment", "tEzmaxproductHelpX"] + + @field_validator('d_ezmaxinvoicingsummaryinternaldetail_countreal') def d_ezmaxinvoicingsummaryinternaldetail_countreal_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^-{0,1}[\d]{1,6}?\.[\d]{2}$", value): raise ValueError(r"must validate the regular expression /^-{0,1}[\d]{1,6}?\.[\d]{2}$/") return value - @validator('d_ezmaxinvoicingsummaryinternaldetail_subtotal') + @field_validator('d_ezmaxinvoicingsummaryinternaldetail_subtotal') def d_ezmaxinvoicingsummaryinternaldetail_subtotal_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^-{0,1}[\d]{1,9}?\.[\d]{2}$", value): raise ValueError(r"must validate the regular expression /^-{0,1}[\d]{1,9}?\.[\d]{2}$/") return value - @validator('d_ezmaxinvoicingsummaryinternaldetail_rebate') + @field_validator('d_ezmaxinvoicingsummaryinternaldetail_rebate') def d_ezmaxinvoicingsummaryinternaldetail_rebate_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^-{0,1}[\d]{1,9}?\.[\d]{2}$", value): raise ValueError(r"must validate the regular expression /^-{0,1}[\d]{1,9}?\.[\d]{2}$/") return value - @validator('d_ezmaxinvoicingsummaryinternaldetail_total') + @field_validator('d_ezmaxinvoicingsummaryinternaldetail_total') def d_ezmaxinvoicingsummaryinternaldetail_total_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^-{0,1}[\d]{1,9}?\.[\d]{2}$", value): raise ValueError(r"must validate the regular expression /^-{0,1}[\d]{1,9}?\.[\d]{2}$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzmaxinvoicingsummaryinternaldetailResponseCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzmaxinvoicingsummaryinternaldetailResponseCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzmaxinvoicingsummaryinternaldetailResponseCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzmaxinvoicingsummaryinternaldetailResponseCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzmaxinvoicingsummaryinternaldetailResponseCompound.parse_obj(obj) - - _obj = EzmaxinvoicingsummaryinternaldetailResponseCompound.parse_obj({ - "pki_ezmaxinvoicingsummaryinternaldetail_id": obj.get("pkiEzmaxinvoicingsummaryinternaldetailID"), - "fki_ezmaxinvoicingsummaryinternal_id": obj.get("fkiEzmaxinvoicingsummaryinternalID"), - "fki_ezmaxproduct_id": obj.get("fkiEzmaxproductID"), - "s_ezmaxproduct_description_x": obj.get("sEzmaxproductDescriptionX"), - "fki_billingentityexternal_id": obj.get("fkiBillingentityexternalID"), - "s_billingentityexternal_description": obj.get("sBillingentityexternalDescription"), - "d_ezmaxinvoicingsummaryinternaldetail_countreal": obj.get("dEzmaxinvoicingsummaryinternaldetailCountreal"), - "d_ezmaxinvoicingsummaryinternaldetail_subtotal": obj.get("dEzmaxinvoicingsummaryinternaldetailSubtotal"), - "d_ezmaxinvoicingsummaryinternaldetail_rebate": obj.get("dEzmaxinvoicingsummaryinternaldetailRebate"), - "d_ezmaxinvoicingsummaryinternaldetail_total": obj.get("dEzmaxinvoicingsummaryinternaldetailTotal"), - "b_ezmaxinvoicingsummaryinternaldetail_adjustment": obj.get("bEzmaxinvoicingsummaryinternaldetailAdjustment"), - "t_ezmaxproduct_help_x": obj.get("tEzmaxproductHelpX") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzmaxinvoicingsummaryinternaldetailID": obj.get("pkiEzmaxinvoicingsummaryinternaldetailID"), + "fkiEzmaxinvoicingsummaryinternalID": obj.get("fkiEzmaxinvoicingsummaryinternalID"), + "fkiEzmaxproductID": obj.get("fkiEzmaxproductID"), + "sEzmaxproductDescriptionX": obj.get("sEzmaxproductDescriptionX"), + "fkiBillingentityexternalID": obj.get("fkiBillingentityexternalID"), + "sBillingentityexternalDescription": obj.get("sBillingentityexternalDescription"), + "dEzmaxinvoicingsummaryinternaldetailCountreal": obj.get("dEzmaxinvoicingsummaryinternaldetailCountreal"), + "dEzmaxinvoicingsummaryinternaldetailSubtotal": obj.get("dEzmaxinvoicingsummaryinternaldetailSubtotal"), + "dEzmaxinvoicingsummaryinternaldetailRebate": obj.get("dEzmaxinvoicingsummaryinternaldetailRebate"), + "dEzmaxinvoicingsummaryinternaldetailTotal": obj.get("dEzmaxinvoicingsummaryinternaldetailTotal"), + "bEzmaxinvoicingsummaryinternaldetailAdjustment": obj.get("bEzmaxinvoicingsummaryinternaldetailAdjustment"), + "tEzmaxproductHelpX": obj.get("tEzmaxproductHelpX") }) return _obj diff --git a/eZmaxApi/models/ezmaxinvoicinguser_response.py b/eZmaxApi/models/ezmaxinvoicinguser_response.py index 644da9218..5b7301541 100644 --- a/eZmaxApi/models/ezmaxinvoicinguser_response.py +++ b/eZmaxApi/models/ezmaxinvoicinguser_response.py @@ -19,70 +19,89 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, StrictStr +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.field_e_ezmaxinvoicinguser_variationezsign import FieldEEzmaxinvoicinguserVariationezsign +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzmaxinvoicinguserResponse(BaseModel): """ - A Ezmaxinvoicinguser Object # noqa: E501 - """ - pki_ezmaxinvoicinguser_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="pkiEzmaxinvoicinguserID", description="The unique ID of the Ezmaxinvoicinguser") - fki_ezmaxinvoicing_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiEzmaxinvoicingID", description="The unique ID of the Ezmaxinvoicing") - fki_billingentityinternal_id: conint(strict=True, ge=0) = Field(..., alias="fkiBillingentityinternalID", description="The unique ID of the Billingentityinternal.") - s_billingentityinternal_description_x: StrictStr = Field(..., alias="sBillingentityinternalDescriptionX", description="The description of the Billingentityinternal in the language of the requester") - fki_user_id: conint(strict=True, ge=0) = Field(..., alias="fkiUserID", description="The unique ID of the User") - i_ezmaxinvoicinguser_ezsigndocument: conint(strict=True, ge=0) = Field(..., alias="iEzmaxinvoicinguserEzsigndocument", description="The number of ezsign documents") - b_ezmaxinvoicinguser_ezsignaccount: StrictBool = Field(..., alias="bEzmaxinvoicinguserEzsignaccount", description="Whether there is an eZsign account") - b_ezmaxinvoicinguser_billableezsign: StrictBool = Field(..., alias="bEzmaxinvoicinguserBillableezsign", description="Whether it is billable for eZsign") - e_ezmaxinvoicinguser_variationezsign: FieldEEzmaxinvoicinguserVariationezsign = Field(..., alias="eEzmaxinvoicinguserVariationezsign") - __properties = ["pkiEzmaxinvoicinguserID", "fkiEzmaxinvoicingID", "fkiBillingentityinternalID", "sBillingentityinternalDescriptionX", "fkiUserID", "iEzmaxinvoicinguserEzsigndocument", "bEzmaxinvoicinguserEzsignaccount", "bEzmaxinvoicinguserBillableezsign", "eEzmaxinvoicinguserVariationezsign"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + A Ezmaxinvoicinguser Object + """ # noqa: E501 + pki_ezmaxinvoicinguser_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezmaxinvoicinguser", alias="pkiEzmaxinvoicinguserID") + fki_ezmaxinvoicing_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezmaxinvoicing", alias="fkiEzmaxinvoicingID") + fki_billingentityinternal_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Billingentityinternal.", alias="fkiBillingentityinternalID") + s_billingentityinternal_description_x: StrictStr = Field(description="The description of the Billingentityinternal in the language of the requester", alias="sBillingentityinternalDescriptionX") + fki_user_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the User", alias="fkiUserID") + i_ezmaxinvoicinguser_ezsigndocument: Annotated[int, Field(strict=True, ge=0)] = Field(description="The number of ezsign documents", alias="iEzmaxinvoicinguserEzsigndocument") + b_ezmaxinvoicinguser_ezsignaccount: StrictBool = Field(description="Whether there is an eZsign account", alias="bEzmaxinvoicinguserEzsignaccount") + b_ezmaxinvoicinguser_billableezsign: StrictBool = Field(description="Whether it is billable for eZsign", alias="bEzmaxinvoicinguserBillableezsign") + e_ezmaxinvoicinguser_variationezsign: FieldEEzmaxinvoicinguserVariationezsign = Field(alias="eEzmaxinvoicinguserVariationezsign") + __properties: ClassVar[List[str]] = ["pkiEzmaxinvoicinguserID", "fkiEzmaxinvoicingID", "fkiBillingentityinternalID", "sBillingentityinternalDescriptionX", "fkiUserID", "iEzmaxinvoicinguserEzsigndocument", "bEzmaxinvoicinguserEzsignaccount", "bEzmaxinvoicinguserBillableezsign", "eEzmaxinvoicinguserVariationezsign"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzmaxinvoicinguserResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzmaxinvoicinguserResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzmaxinvoicinguserResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzmaxinvoicinguserResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzmaxinvoicinguserResponse.parse_obj(obj) - - _obj = EzmaxinvoicinguserResponse.parse_obj({ - "pki_ezmaxinvoicinguser_id": obj.get("pkiEzmaxinvoicinguserID"), - "fki_ezmaxinvoicing_id": obj.get("fkiEzmaxinvoicingID"), - "fki_billingentityinternal_id": obj.get("fkiBillingentityinternalID"), - "s_billingentityinternal_description_x": obj.get("sBillingentityinternalDescriptionX"), - "fki_user_id": obj.get("fkiUserID"), - "i_ezmaxinvoicinguser_ezsigndocument": obj.get("iEzmaxinvoicinguserEzsigndocument"), - "b_ezmaxinvoicinguser_ezsignaccount": obj.get("bEzmaxinvoicinguserEzsignaccount"), - "b_ezmaxinvoicinguser_billableezsign": obj.get("bEzmaxinvoicinguserBillableezsign"), - "e_ezmaxinvoicinguser_variationezsign": obj.get("eEzmaxinvoicinguserVariationezsign") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzmaxinvoicinguserID": obj.get("pkiEzmaxinvoicinguserID"), + "fkiEzmaxinvoicingID": obj.get("fkiEzmaxinvoicingID"), + "fkiBillingentityinternalID": obj.get("fkiBillingentityinternalID"), + "sBillingentityinternalDescriptionX": obj.get("sBillingentityinternalDescriptionX"), + "fkiUserID": obj.get("fkiUserID"), + "iEzmaxinvoicinguserEzsigndocument": obj.get("iEzmaxinvoicinguserEzsigndocument"), + "bEzmaxinvoicinguserEzsignaccount": obj.get("bEzmaxinvoicinguserEzsignaccount"), + "bEzmaxinvoicinguserBillableezsign": obj.get("bEzmaxinvoicinguserBillableezsign"), + "eEzmaxinvoicinguserVariationezsign": obj.get("eEzmaxinvoicinguserVariationezsign") }) return _obj diff --git a/eZmaxApi/models/ezmaxinvoicinguser_response_compound.py b/eZmaxApi/models/ezmaxinvoicinguser_response_compound.py index ccc4751c3..b103a12cf 100644 --- a/eZmaxApi/models/ezmaxinvoicinguser_response_compound.py +++ b/eZmaxApi/models/ezmaxinvoicinguser_response_compound.py @@ -19,76 +19,95 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, StrictStr +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.custom_contact_name_response import CustomContactNameResponse from eZmaxApi.models.field_e_ezmaxinvoicinguser_variationezsign import FieldEEzmaxinvoicinguserVariationezsign +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzmaxinvoicinguserResponseCompound(BaseModel): """ - A Ezmaxinvoicinguser Object # noqa: E501 - """ - pki_ezmaxinvoicinguser_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="pkiEzmaxinvoicinguserID", description="The unique ID of the Ezmaxinvoicinguser") - fki_ezmaxinvoicing_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiEzmaxinvoicingID", description="The unique ID of the Ezmaxinvoicing") - fki_billingentityinternal_id: conint(strict=True, ge=0) = Field(..., alias="fkiBillingentityinternalID", description="The unique ID of the Billingentityinternal.") - s_billingentityinternal_description_x: StrictStr = Field(..., alias="sBillingentityinternalDescriptionX", description="The description of the Billingentityinternal in the language of the requester") - fki_user_id: conint(strict=True, ge=0) = Field(..., alias="fkiUserID", description="The unique ID of the User") - i_ezmaxinvoicinguser_ezsigndocument: conint(strict=True, ge=0) = Field(..., alias="iEzmaxinvoicinguserEzsigndocument", description="The number of ezsign documents") - b_ezmaxinvoicinguser_ezsignaccount: StrictBool = Field(..., alias="bEzmaxinvoicinguserEzsignaccount", description="Whether there is an eZsign account") - b_ezmaxinvoicinguser_billableezsign: StrictBool = Field(..., alias="bEzmaxinvoicinguserBillableezsign", description="Whether it is billable for eZsign") - e_ezmaxinvoicinguser_variationezsign: FieldEEzmaxinvoicinguserVariationezsign = Field(..., alias="eEzmaxinvoicinguserVariationezsign") - obj_contact_name: CustomContactNameResponse = Field(..., alias="objContactName") - __properties = ["pkiEzmaxinvoicinguserID", "fkiEzmaxinvoicingID", "fkiBillingentityinternalID", "sBillingentityinternalDescriptionX", "fkiUserID", "iEzmaxinvoicinguserEzsigndocument", "bEzmaxinvoicinguserEzsignaccount", "bEzmaxinvoicinguserBillableezsign", "eEzmaxinvoicinguserVariationezsign", "objContactName"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + A Ezmaxinvoicinguser Object + """ # noqa: E501 + pki_ezmaxinvoicinguser_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezmaxinvoicinguser", alias="pkiEzmaxinvoicinguserID") + fki_ezmaxinvoicing_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezmaxinvoicing", alias="fkiEzmaxinvoicingID") + fki_billingentityinternal_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Billingentityinternal.", alias="fkiBillingentityinternalID") + s_billingentityinternal_description_x: StrictStr = Field(description="The description of the Billingentityinternal in the language of the requester", alias="sBillingentityinternalDescriptionX") + fki_user_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the User", alias="fkiUserID") + i_ezmaxinvoicinguser_ezsigndocument: Annotated[int, Field(strict=True, ge=0)] = Field(description="The number of ezsign documents", alias="iEzmaxinvoicinguserEzsigndocument") + b_ezmaxinvoicinguser_ezsignaccount: StrictBool = Field(description="Whether there is an eZsign account", alias="bEzmaxinvoicinguserEzsignaccount") + b_ezmaxinvoicinguser_billableezsign: StrictBool = Field(description="Whether it is billable for eZsign", alias="bEzmaxinvoicinguserBillableezsign") + e_ezmaxinvoicinguser_variationezsign: FieldEEzmaxinvoicinguserVariationezsign = Field(alias="eEzmaxinvoicinguserVariationezsign") + obj_contact_name: CustomContactNameResponse = Field(alias="objContactName") + __properties: ClassVar[List[str]] = ["pkiEzmaxinvoicinguserID", "fkiEzmaxinvoicingID", "fkiBillingentityinternalID", "sBillingentityinternalDescriptionX", "fkiUserID", "iEzmaxinvoicinguserEzsigndocument", "bEzmaxinvoicinguserEzsignaccount", "bEzmaxinvoicinguserBillableezsign", "eEzmaxinvoicinguserVariationezsign", "objContactName"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzmaxinvoicinguserResponseCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzmaxinvoicinguserResponseCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_contact_name if self.obj_contact_name: _dict['objContactName'] = self.obj_contact_name.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> EzmaxinvoicinguserResponseCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzmaxinvoicinguserResponseCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzmaxinvoicinguserResponseCompound.parse_obj(obj) - - _obj = EzmaxinvoicinguserResponseCompound.parse_obj({ - "pki_ezmaxinvoicinguser_id": obj.get("pkiEzmaxinvoicinguserID"), - "fki_ezmaxinvoicing_id": obj.get("fkiEzmaxinvoicingID"), - "fki_billingentityinternal_id": obj.get("fkiBillingentityinternalID"), - "s_billingentityinternal_description_x": obj.get("sBillingentityinternalDescriptionX"), - "fki_user_id": obj.get("fkiUserID"), - "i_ezmaxinvoicinguser_ezsigndocument": obj.get("iEzmaxinvoicinguserEzsigndocument"), - "b_ezmaxinvoicinguser_ezsignaccount": obj.get("bEzmaxinvoicinguserEzsignaccount"), - "b_ezmaxinvoicinguser_billableezsign": obj.get("bEzmaxinvoicinguserBillableezsign"), - "e_ezmaxinvoicinguser_variationezsign": obj.get("eEzmaxinvoicinguserVariationezsign"), - "obj_contact_name": CustomContactNameResponse.from_dict(obj.get("objContactName")) if obj.get("objContactName") is not None else None + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzmaxinvoicinguserID": obj.get("pkiEzmaxinvoicinguserID"), + "fkiEzmaxinvoicingID": obj.get("fkiEzmaxinvoicingID"), + "fkiBillingentityinternalID": obj.get("fkiBillingentityinternalID"), + "sBillingentityinternalDescriptionX": obj.get("sBillingentityinternalDescriptionX"), + "fkiUserID": obj.get("fkiUserID"), + "iEzmaxinvoicinguserEzsigndocument": obj.get("iEzmaxinvoicinguserEzsigndocument"), + "bEzmaxinvoicinguserEzsignaccount": obj.get("bEzmaxinvoicinguserEzsignaccount"), + "bEzmaxinvoicinguserBillableezsign": obj.get("bEzmaxinvoicinguserBillableezsign"), + "eEzmaxinvoicinguserVariationezsign": obj.get("eEzmaxinvoicinguserVariationezsign"), + "objContactName": CustomContactNameResponse.from_dict(obj.get("objContactName")) if obj.get("objContactName") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezmaxproduct_autocomplete_element_response.py b/eZmaxApi/models/ezmaxproduct_autocomplete_element_response.py index c0f4b1c21..bf8a79e04 100644 --- a/eZmaxApi/models/ezmaxproduct_autocomplete_element_response.py +++ b/eZmaxApi/models/ezmaxproduct_autocomplete_element_response.py @@ -19,57 +19,76 @@ import json - -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictBool, StrictStr +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzmaxproductAutocompleteElementResponse(BaseModel): """ - A Ezmaxproduct AutocompleteElement Response # noqa: E501 - """ - pki_ezmaxproduct_id: conint(strict=True, ge=1) = Field(..., alias="pkiEzmaxproductID", description="The unique ID of the Ezmaxproduct") - s_ezmaxproduct_description_x: StrictStr = Field(..., alias="sEzmaxproductDescriptionX", description="The description of the Ezmaxproduct in the language of the requester") - b_ezmaxproduct_isactive: StrictBool = Field(..., alias="bEzmaxproductIsactive", description="Whether the Ezmaxproduct is active or not") - __properties = ["pkiEzmaxproductID", "sEzmaxproductDescriptionX", "bEzmaxproductIsactive"] + A Ezmaxproduct AutocompleteElement Response + """ # noqa: E501 + pki_ezmaxproduct_id: Annotated[int, Field(strict=True, ge=1)] = Field(description="The unique ID of the Ezmaxproduct", alias="pkiEzmaxproductID") + s_ezmaxproduct_description_x: StrictStr = Field(description="The description of the Ezmaxproduct in the language of the requester", alias="sEzmaxproductDescriptionX") + b_ezmaxproduct_isactive: StrictBool = Field(description="Whether the Ezmaxproduct is active or not", alias="bEzmaxproductIsactive") + __properties: ClassVar[List[str]] = ["pkiEzmaxproductID", "sEzmaxproductDescriptionX", "bEzmaxproductIsactive"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzmaxproductAutocompleteElementResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzmaxproductAutocompleteElementResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzmaxproductAutocompleteElementResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzmaxproductAutocompleteElementResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzmaxproductAutocompleteElementResponse.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzmaxproductAutocompleteElementResponse.parse_obj({ - "pki_ezmaxproduct_id": obj.get("pkiEzmaxproductID"), - "s_ezmaxproduct_description_x": obj.get("sEzmaxproductDescriptionX"), - "b_ezmaxproduct_isactive": obj.get("bEzmaxproductIsactive") + _obj = cls.model_validate({ + "pkiEzmaxproductID": obj.get("pkiEzmaxproductID"), + "sEzmaxproductDescriptionX": obj.get("sEzmaxproductDescriptionX"), + "bEzmaxproductIsactive": obj.get("bEzmaxproductIsactive") }) return _obj diff --git a/eZmaxApi/models/ezmaxproduct_get_autocomplete_v2_response.py b/eZmaxApi/models/ezmaxproduct_get_autocomplete_v2_response.py index 754120ec1..d2912024f 100644 --- a/eZmaxApi/models/ezmaxproduct_get_autocomplete_v2_response.py +++ b/eZmaxApi/models/ezmaxproduct_get_autocomplete_v2_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.ezmaxproduct_get_autocomplete_v2_response_m_payload import EzmaxproductGetAutocompleteV2ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzmaxproductGetAutocompleteV2Response(BaseModel): """ - Response for GET /2/object/ezmaxproduct/getAutocomplete # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzmaxproductGetAutocompleteV2ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /2/object/ezmaxproduct/getAutocomplete + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzmaxproductGetAutocompleteV2ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzmaxproductGetAutocompleteV2Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzmaxproductGetAutocompleteV2Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzmaxproductGetAutocompleteV2Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzmaxproductGetAutocompleteV2Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzmaxproductGetAutocompleteV2Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzmaxproductGetAutocompleteV2Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzmaxproductGetAutocompleteV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzmaxproductGetAutocompleteV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezmaxproduct_get_autocomplete_v2_response_m_payload.py b/eZmaxApi/models/ezmaxproduct_get_autocomplete_v2_response_m_payload.py index 165331bf2..54b95c191 100644 --- a/eZmaxApi/models/ezmaxproduct_get_autocomplete_v2_response_m_payload.py +++ b/eZmaxApi/models/ezmaxproduct_get_autocomplete_v2_response_m_payload.py @@ -19,41 +19,59 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.ezmaxproduct_autocomplete_element_response import EzmaxproductAutocompleteElementResponse +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzmaxproductGetAutocompleteV2ResponseMPayload(BaseModel): """ - Payload for POST /2/object/ezmaxproduct/getAutocomplete # noqa: E501 - """ - a_obj_ezmaxproduct: conlist(EzmaxproductAutocompleteElementResponse) = Field(..., alias="a_objEzmaxproduct", description="An array of Ezmaxproduct autocomplete element response.") - __properties = ["a_objEzmaxproduct"] + Payload for POST /2/object/ezmaxproduct/getAutocomplete + """ # noqa: E501 + a_obj_ezmaxproduct: List[EzmaxproductAutocompleteElementResponse] = Field(description="An array of Ezmaxproduct autocomplete element response.", alias="a_objEzmaxproduct") + __properties: ClassVar[List[str]] = ["a_objEzmaxproduct"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzmaxproductGetAutocompleteV2ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzmaxproductGetAutocompleteV2ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_ezmaxproduct (list) _items = [] if self.a_obj_ezmaxproduct: @@ -64,16 +82,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzmaxproductGetAutocompleteV2ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzmaxproductGetAutocompleteV2ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzmaxproductGetAutocompleteV2ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzmaxproductGetAutocompleteV2ResponseMPayload.parse_obj({ - "a_obj_ezmaxproduct": [EzmaxproductAutocompleteElementResponse.from_dict(_item) for _item in obj.get("a_objEzmaxproduct")] if obj.get("a_objEzmaxproduct") is not None else None + _obj = cls.model_validate({ + "a_objEzmaxproduct": [EzmaxproductAutocompleteElementResponse.from_dict(_item) for _item in obj.get("a_objEzmaxproduct")] if obj.get("a_objEzmaxproduct") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsign_suggest_signers_v1_response.py b/eZmaxApi/models/ezsign_suggest_signers_v1_response.py index 715247446..1035714c7 100644 --- a/eZmaxApi/models/ezsign_suggest_signers_v1_response.py +++ b/eZmaxApi/models/ezsign_suggest_signers_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.ezsign_suggest_signers_v1_response_m_payload import EzsignSuggestSignersV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignSuggestSignersV1Response(BaseModel): """ - Response for GET /1/module/ezsign/suggestSigners # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzsignSuggestSignersV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /1/module/ezsign/suggestSigners + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsignSuggestSignersV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignSuggestSignersV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignSuggestSignersV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignSuggestSignersV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignSuggestSignersV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignSuggestSignersV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignSuggestSignersV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzsignSuggestSignersV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsignSuggestSignersV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsign_suggest_signers_v1_response_m_payload.py b/eZmaxApi/models/ezsign_suggest_signers_v1_response_m_payload.py index 1260445cc..bed718e49 100644 --- a/eZmaxApi/models/ezsign_suggest_signers_v1_response_m_payload.py +++ b/eZmaxApi/models/ezsign_suggest_signers_v1_response_m_payload.py @@ -19,44 +19,62 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.custom_user_response import CustomUserResponse from eZmaxApi.models.ezsignfoldersignerassociation_response_compound import EzsignfoldersignerassociationResponseCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignSuggestSignersV1ResponseMPayload(BaseModel): """ - Payload for GET /1/module/ezsign/suggestSigners # noqa: E501 - """ - a_obj_ezsignfoldersignerassociation: conlist(EzsignfoldersignerassociationResponseCompound) = Field(..., alias="a_objEzsignfoldersignerassociation") - a_obj_user_team: conlist(CustomUserResponse) = Field(..., alias="a_objUserTeam") - a_obj_user: conlist(CustomUserResponse) = Field(..., alias="a_objUser") - __properties = ["a_objEzsignfoldersignerassociation", "a_objUserTeam", "a_objUser"] + Payload for GET /1/module/ezsign/suggestSigners + """ # noqa: E501 + a_obj_ezsignfoldersignerassociation: List[EzsignfoldersignerassociationResponseCompound] = Field(alias="a_objEzsignfoldersignerassociation") + a_obj_user_team: List[CustomUserResponse] = Field(alias="a_objUserTeam") + a_obj_user: List[CustomUserResponse] = Field(alias="a_objUser") + __properties: ClassVar[List[str]] = ["a_objEzsignfoldersignerassociation", "a_objUserTeam", "a_objUser"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignSuggestSignersV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignSuggestSignersV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_ezsignfoldersignerassociation (list) _items = [] if self.a_obj_ezsignfoldersignerassociation: @@ -81,18 +99,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignSuggestSignersV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignSuggestSignersV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignSuggestSignersV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignSuggestSignersV1ResponseMPayload.parse_obj({ - "a_obj_ezsignfoldersignerassociation": [EzsignfoldersignerassociationResponseCompound.from_dict(_item) for _item in obj.get("a_objEzsignfoldersignerassociation")] if obj.get("a_objEzsignfoldersignerassociation") is not None else None, - "a_obj_user_team": [CustomUserResponse.from_dict(_item) for _item in obj.get("a_objUserTeam")] if obj.get("a_objUserTeam") is not None else None, - "a_obj_user": [CustomUserResponse.from_dict(_item) for _item in obj.get("a_objUser")] if obj.get("a_objUser") is not None else None + _obj = cls.model_validate({ + "a_objEzsignfoldersignerassociation": [EzsignfoldersignerassociationResponseCompound.from_dict(_item) for _item in obj.get("a_objEzsignfoldersignerassociation")] if obj.get("a_objEzsignfoldersignerassociation") is not None else None, + "a_objUserTeam": [CustomUserResponse.from_dict(_item) for _item in obj.get("a_objUserTeam")] if obj.get("a_objUserTeam") is not None else None, + "a_objUser": [CustomUserResponse.from_dict(_item) for _item in obj.get("a_objUser")] if obj.get("a_objUser") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsign_suggest_templates_v1_response.py b/eZmaxApi/models/ezsign_suggest_templates_v1_response.py index f26652338..e09c151da 100644 --- a/eZmaxApi/models/ezsign_suggest_templates_v1_response.py +++ b/eZmaxApi/models/ezsign_suggest_templates_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.ezsign_suggest_templates_v1_response_m_payload import EzsignSuggestTemplatesV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignSuggestTemplatesV1Response(BaseModel): """ - Response for GET /1/module/ezsign/suggestTemplates # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzsignSuggestTemplatesV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /1/module/ezsign/suggestTemplates + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsignSuggestTemplatesV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignSuggestTemplatesV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignSuggestTemplatesV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignSuggestTemplatesV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignSuggestTemplatesV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignSuggestTemplatesV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignSuggestTemplatesV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzsignSuggestTemplatesV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsignSuggestTemplatesV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsign_suggest_templates_v1_response_m_payload.py b/eZmaxApi/models/ezsign_suggest_templates_v1_response_m_payload.py index 641b16d3e..10ae9d10c 100644 --- a/eZmaxApi/models/ezsign_suggest_templates_v1_response_m_payload.py +++ b/eZmaxApi/models/ezsign_suggest_templates_v1_response_m_payload.py @@ -19,43 +19,61 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.ezsigntemplate_response_compound import EzsigntemplateResponseCompound from eZmaxApi.models.ezsigntemplatepackage_response_compound import EzsigntemplatepackageResponseCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignSuggestTemplatesV1ResponseMPayload(BaseModel): """ - Payload for GET /1/module/ezsign/suggestTemplates # noqa: E501 - """ - a_obj_ezsigntemplate: conlist(EzsigntemplateResponseCompound) = Field(..., alias="a_objEzsigntemplate") - a_obj_ezsigntemplatepackage: conlist(EzsigntemplatepackageResponseCompound) = Field(..., alias="a_objEzsigntemplatepackage") - __properties = ["a_objEzsigntemplate", "a_objEzsigntemplatepackage"] + Payload for GET /1/module/ezsign/suggestTemplates + """ # noqa: E501 + a_obj_ezsigntemplate: List[EzsigntemplateResponseCompound] = Field(alias="a_objEzsigntemplate") + a_obj_ezsigntemplatepackage: List[EzsigntemplatepackageResponseCompound] = Field(alias="a_objEzsigntemplatepackage") + __properties: ClassVar[List[str]] = ["a_objEzsigntemplate", "a_objEzsigntemplatepackage"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignSuggestTemplatesV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignSuggestTemplatesV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_ezsigntemplate (list) _items = [] if self.a_obj_ezsigntemplate: @@ -73,17 +91,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignSuggestTemplatesV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignSuggestTemplatesV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignSuggestTemplatesV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignSuggestTemplatesV1ResponseMPayload.parse_obj({ - "a_obj_ezsigntemplate": [EzsigntemplateResponseCompound.from_dict(_item) for _item in obj.get("a_objEzsigntemplate")] if obj.get("a_objEzsigntemplate") is not None else None, - "a_obj_ezsigntemplatepackage": [EzsigntemplatepackageResponseCompound.from_dict(_item) for _item in obj.get("a_objEzsigntemplatepackage")] if obj.get("a_objEzsigntemplatepackage") is not None else None + _obj = cls.model_validate({ + "a_objEzsigntemplate": [EzsigntemplateResponseCompound.from_dict(_item) for _item in obj.get("a_objEzsigntemplate")] if obj.get("a_objEzsigntemplate") is not None else None, + "a_objEzsigntemplatepackage": [EzsigntemplatepackageResponseCompound.from_dict(_item) for _item in obj.get("a_objEzsigntemplatepackage")] if obj.get("a_objEzsigntemplatepackage") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignannotation_response.py b/eZmaxApi/models/ezsignannotation_response.py index f14b4ebde..7aec02aa1 100644 --- a/eZmaxApi/models/ezsignannotation_response.py +++ b/eZmaxApi/models/ezsignannotation_response.py @@ -19,76 +19,95 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictInt, StrictStr, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictInt, StrictStr +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.enum_horizontalalignment import EnumHorizontalalignment from eZmaxApi.models.enum_verticalalignment import EnumVerticalalignment from eZmaxApi.models.field_e_ezsignannotation_type import FieldEEzsignannotationType +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignannotationResponse(BaseModel): """ - A Ezsignannotation Object # noqa: E501 - """ - pki_ezsignannotation_id: StrictInt = Field(..., alias="pkiEzsignannotationID", description="The unique ID of the Ezsignannotation") - fki_ezsigndocument_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsigndocumentID", description="The unique ID of the Ezsigndocument") - e_ezsignannotation_horizontalalignment: Optional[EnumHorizontalalignment] = Field(None, alias="eEzsignannotationHorizontalalignment") - e_ezsignannotation_verticalalignment: Optional[EnumVerticalalignment] = Field(None, alias="eEzsignannotationVerticalalignment") - e_ezsignannotation_type: FieldEEzsignannotationType = Field(..., alias="eEzsignannotationType") - i_ezsignannotation_x: conint(strict=True, ge=0) = Field(..., alias="iEzsignannotationX", description="The X coordinate (Horizontal) where to put the Ezsignannotation on the page. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsignannotation 2 inches from the left border of the page, you would use \"200\" for the X coordinate.") - i_ezsignannotation_y: conint(strict=True, ge=0) = Field(..., alias="iEzsignannotationY", description="The Y coordinate (Vertical) where to put the Ezsignannotation on the page. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsignannotation 3 inches from the top border of the page, you would use \"300\" for the Y coordinate.") - i_ezsignannotation_width: Optional[conint(strict=True, ge=0)] = Field(None, alias="iEzsignannotationWidth", description="The Width of the Ezsignannotation. Width is calculated at 100dpi (dot per inch). So for example, if you want to have the width of the Ezsignannotation to be 3 inches, you would use \"300\" for the Width.") - i_ezsignannotation_height: Optional[conint(strict=True, ge=0)] = Field(None, alias="iEzsignannotationHeight", description="The Height of the Ezsignannotation. Height is calculated at 100dpi (dot per inch). So for example, if you want to have the height of the Ezsignannotation to be 2 inches, you would use \"200\" for the Height. This can only be set if eEzsignannotationType is **StrikethroughBlock** or **Text**") - s_ezsignannotation_text: Optional[StrictStr] = Field(None, alias="sEzsignannotationText", description="The Text of the Ezsignannotation") - i_ezsignpage_pagenumber: conint(strict=True, ge=1) = Field(..., alias="iEzsignpagePagenumber", description="The page number in the Ezsigndocument") - __properties = ["pkiEzsignannotationID", "fkiEzsigndocumentID", "eEzsignannotationHorizontalalignment", "eEzsignannotationVerticalalignment", "eEzsignannotationType", "iEzsignannotationX", "iEzsignannotationY", "iEzsignannotationWidth", "iEzsignannotationHeight", "sEzsignannotationText", "iEzsignpagePagenumber"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + A Ezsignannotation Object + """ # noqa: E501 + pki_ezsignannotation_id: StrictInt = Field(description="The unique ID of the Ezsignannotation", alias="pkiEzsignannotationID") + fki_ezsigndocument_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsigndocument", alias="fkiEzsigndocumentID") + e_ezsignannotation_horizontalalignment: Optional[EnumHorizontalalignment] = Field(default=None, alias="eEzsignannotationHorizontalalignment") + e_ezsignannotation_verticalalignment: Optional[EnumVerticalalignment] = Field(default=None, alias="eEzsignannotationVerticalalignment") + e_ezsignannotation_type: FieldEEzsignannotationType = Field(alias="eEzsignannotationType") + i_ezsignannotation_x: Annotated[int, Field(strict=True, ge=0)] = Field(description="The X coordinate (Horizontal) where to put the Ezsignannotation on the page. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsignannotation 2 inches from the left border of the page, you would use \"200\" for the X coordinate.", alias="iEzsignannotationX") + i_ezsignannotation_y: Annotated[int, Field(strict=True, ge=0)] = Field(description="The Y coordinate (Vertical) where to put the Ezsignannotation on the page. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsignannotation 3 inches from the top border of the page, you would use \"300\" for the Y coordinate.", alias="iEzsignannotationY") + i_ezsignannotation_width: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The Width of the Ezsignannotation. Width is calculated at 100dpi (dot per inch). So for example, if you want to have the width of the Ezsignannotation to be 3 inches, you would use \"300\" for the Width.", alias="iEzsignannotationWidth") + i_ezsignannotation_height: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The Height of the Ezsignannotation. Height is calculated at 100dpi (dot per inch). So for example, if you want to have the height of the Ezsignannotation to be 2 inches, you would use \"200\" for the Height. This can only be set if eEzsignannotationType is **StrikethroughBlock** or **Text**", alias="iEzsignannotationHeight") + s_ezsignannotation_text: Optional[StrictStr] = Field(default=None, description="The Text of the Ezsignannotation", alias="sEzsignannotationText") + i_ezsignpage_pagenumber: Annotated[int, Field(strict=True, ge=1)] = Field(description="The page number in the Ezsigndocument", alias="iEzsignpagePagenumber") + __properties: ClassVar[List[str]] = ["pkiEzsignannotationID", "fkiEzsigndocumentID", "eEzsignannotationHorizontalalignment", "eEzsignannotationVerticalalignment", "eEzsignannotationType", "iEzsignannotationX", "iEzsignannotationY", "iEzsignannotationWidth", "iEzsignannotationHeight", "sEzsignannotationText", "iEzsignpagePagenumber"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignannotationResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignannotationResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignannotationResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignannotationResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignannotationResponse.parse_obj(obj) - - _obj = EzsignannotationResponse.parse_obj({ - "pki_ezsignannotation_id": obj.get("pkiEzsignannotationID"), - "fki_ezsigndocument_id": obj.get("fkiEzsigndocumentID"), - "e_ezsignannotation_horizontalalignment": obj.get("eEzsignannotationHorizontalalignment"), - "e_ezsignannotation_verticalalignment": obj.get("eEzsignannotationVerticalalignment"), - "e_ezsignannotation_type": obj.get("eEzsignannotationType"), - "i_ezsignannotation_x": obj.get("iEzsignannotationX"), - "i_ezsignannotation_y": obj.get("iEzsignannotationY"), - "i_ezsignannotation_width": obj.get("iEzsignannotationWidth"), - "i_ezsignannotation_height": obj.get("iEzsignannotationHeight"), - "s_ezsignannotation_text": obj.get("sEzsignannotationText"), - "i_ezsignpage_pagenumber": obj.get("iEzsignpagePagenumber") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsignannotationID": obj.get("pkiEzsignannotationID"), + "fkiEzsigndocumentID": obj.get("fkiEzsigndocumentID"), + "eEzsignannotationHorizontalalignment": obj.get("eEzsignannotationHorizontalalignment"), + "eEzsignannotationVerticalalignment": obj.get("eEzsignannotationVerticalalignment"), + "eEzsignannotationType": obj.get("eEzsignannotationType"), + "iEzsignannotationX": obj.get("iEzsignannotationX"), + "iEzsignannotationY": obj.get("iEzsignannotationY"), + "iEzsignannotationWidth": obj.get("iEzsignannotationWidth"), + "iEzsignannotationHeight": obj.get("iEzsignannotationHeight"), + "sEzsignannotationText": obj.get("sEzsignannotationText"), + "iEzsignpagePagenumber": obj.get("iEzsignpagePagenumber") }) return _obj diff --git a/eZmaxApi/models/ezsignannotation_response_compound.py b/eZmaxApi/models/ezsignannotation_response_compound.py index bb93c6bd4..36831ed13 100644 --- a/eZmaxApi/models/ezsignannotation_response_compound.py +++ b/eZmaxApi/models/ezsignannotation_response_compound.py @@ -19,82 +19,101 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictInt, StrictStr, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictInt, StrictStr +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.enum_horizontalalignment import EnumHorizontalalignment from eZmaxApi.models.enum_verticalalignment import EnumVerticalalignment from eZmaxApi.models.field_e_ezsignannotation_type import FieldEEzsignannotationType from eZmaxApi.models.textstylestatic_response_compound import TextstylestaticResponseCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignannotationResponseCompound(BaseModel): """ - A Ezsignannotation Object # noqa: E501 - """ - pki_ezsignannotation_id: StrictInt = Field(..., alias="pkiEzsignannotationID", description="The unique ID of the Ezsignannotation") - fki_ezsigndocument_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsigndocumentID", description="The unique ID of the Ezsigndocument") - e_ezsignannotation_horizontalalignment: Optional[EnumHorizontalalignment] = Field(None, alias="eEzsignannotationHorizontalalignment") - e_ezsignannotation_verticalalignment: Optional[EnumVerticalalignment] = Field(None, alias="eEzsignannotationVerticalalignment") - e_ezsignannotation_type: FieldEEzsignannotationType = Field(..., alias="eEzsignannotationType") - i_ezsignannotation_x: conint(strict=True, ge=0) = Field(..., alias="iEzsignannotationX", description="The X coordinate (Horizontal) where to put the Ezsignannotation on the page. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsignannotation 2 inches from the left border of the page, you would use \"200\" for the X coordinate.") - i_ezsignannotation_y: conint(strict=True, ge=0) = Field(..., alias="iEzsignannotationY", description="The Y coordinate (Vertical) where to put the Ezsignannotation on the page. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsignannotation 3 inches from the top border of the page, you would use \"300\" for the Y coordinate.") - i_ezsignannotation_width: Optional[conint(strict=True, ge=0)] = Field(None, alias="iEzsignannotationWidth", description="The Width of the Ezsignannotation. Width is calculated at 100dpi (dot per inch). So for example, if you want to have the width of the Ezsignannotation to be 3 inches, you would use \"300\" for the Width.") - i_ezsignannotation_height: Optional[conint(strict=True, ge=0)] = Field(None, alias="iEzsignannotationHeight", description="The Height of the Ezsignannotation. Height is calculated at 100dpi (dot per inch). So for example, if you want to have the height of the Ezsignannotation to be 2 inches, you would use \"200\" for the Height. This can only be set if eEzsignannotationType is **StrikethroughBlock** or **Text**") - s_ezsignannotation_text: Optional[StrictStr] = Field(None, alias="sEzsignannotationText", description="The Text of the Ezsignannotation") - i_ezsignpage_pagenumber: conint(strict=True, ge=1) = Field(..., alias="iEzsignpagePagenumber", description="The page number in the Ezsigndocument") - obj_textstylestatic: Optional[TextstylestaticResponseCompound] = Field(None, alias="objTextstylestatic") - __properties = ["pkiEzsignannotationID", "fkiEzsigndocumentID", "eEzsignannotationHorizontalalignment", "eEzsignannotationVerticalalignment", "eEzsignannotationType", "iEzsignannotationX", "iEzsignannotationY", "iEzsignannotationWidth", "iEzsignannotationHeight", "sEzsignannotationText", "iEzsignpagePagenumber", "objTextstylestatic"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + A Ezsignannotation Object + """ # noqa: E501 + pki_ezsignannotation_id: StrictInt = Field(description="The unique ID of the Ezsignannotation", alias="pkiEzsignannotationID") + fki_ezsigndocument_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsigndocument", alias="fkiEzsigndocumentID") + e_ezsignannotation_horizontalalignment: Optional[EnumHorizontalalignment] = Field(default=None, alias="eEzsignannotationHorizontalalignment") + e_ezsignannotation_verticalalignment: Optional[EnumVerticalalignment] = Field(default=None, alias="eEzsignannotationVerticalalignment") + e_ezsignannotation_type: FieldEEzsignannotationType = Field(alias="eEzsignannotationType") + i_ezsignannotation_x: Annotated[int, Field(strict=True, ge=0)] = Field(description="The X coordinate (Horizontal) where to put the Ezsignannotation on the page. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsignannotation 2 inches from the left border of the page, you would use \"200\" for the X coordinate.", alias="iEzsignannotationX") + i_ezsignannotation_y: Annotated[int, Field(strict=True, ge=0)] = Field(description="The Y coordinate (Vertical) where to put the Ezsignannotation on the page. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsignannotation 3 inches from the top border of the page, you would use \"300\" for the Y coordinate.", alias="iEzsignannotationY") + i_ezsignannotation_width: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The Width of the Ezsignannotation. Width is calculated at 100dpi (dot per inch). So for example, if you want to have the width of the Ezsignannotation to be 3 inches, you would use \"300\" for the Width.", alias="iEzsignannotationWidth") + i_ezsignannotation_height: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The Height of the Ezsignannotation. Height is calculated at 100dpi (dot per inch). So for example, if you want to have the height of the Ezsignannotation to be 2 inches, you would use \"200\" for the Height. This can only be set if eEzsignannotationType is **StrikethroughBlock** or **Text**", alias="iEzsignannotationHeight") + s_ezsignannotation_text: Optional[StrictStr] = Field(default=None, description="The Text of the Ezsignannotation", alias="sEzsignannotationText") + i_ezsignpage_pagenumber: Annotated[int, Field(strict=True, ge=1)] = Field(description="The page number in the Ezsigndocument", alias="iEzsignpagePagenumber") + obj_textstylestatic: Optional[TextstylestaticResponseCompound] = Field(default=None, alias="objTextstylestatic") + __properties: ClassVar[List[str]] = ["pkiEzsignannotationID", "fkiEzsigndocumentID", "eEzsignannotationHorizontalalignment", "eEzsignannotationVerticalalignment", "eEzsignannotationType", "iEzsignannotationX", "iEzsignannotationY", "iEzsignannotationWidth", "iEzsignannotationHeight", "sEzsignannotationText", "iEzsignpagePagenumber", "objTextstylestatic"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignannotationResponseCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignannotationResponseCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_textstylestatic if self.obj_textstylestatic: _dict['objTextstylestatic'] = self.obj_textstylestatic.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignannotationResponseCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignannotationResponseCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignannotationResponseCompound.parse_obj(obj) - - _obj = EzsignannotationResponseCompound.parse_obj({ - "pki_ezsignannotation_id": obj.get("pkiEzsignannotationID"), - "fki_ezsigndocument_id": obj.get("fkiEzsigndocumentID"), - "e_ezsignannotation_horizontalalignment": obj.get("eEzsignannotationHorizontalalignment"), - "e_ezsignannotation_verticalalignment": obj.get("eEzsignannotationVerticalalignment"), - "e_ezsignannotation_type": obj.get("eEzsignannotationType"), - "i_ezsignannotation_x": obj.get("iEzsignannotationX"), - "i_ezsignannotation_y": obj.get("iEzsignannotationY"), - "i_ezsignannotation_width": obj.get("iEzsignannotationWidth"), - "i_ezsignannotation_height": obj.get("iEzsignannotationHeight"), - "s_ezsignannotation_text": obj.get("sEzsignannotationText"), - "i_ezsignpage_pagenumber": obj.get("iEzsignpagePagenumber"), - "obj_textstylestatic": TextstylestaticResponseCompound.from_dict(obj.get("objTextstylestatic")) if obj.get("objTextstylestatic") is not None else None + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsignannotationID": obj.get("pkiEzsignannotationID"), + "fkiEzsigndocumentID": obj.get("fkiEzsigndocumentID"), + "eEzsignannotationHorizontalalignment": obj.get("eEzsignannotationHorizontalalignment"), + "eEzsignannotationVerticalalignment": obj.get("eEzsignannotationVerticalalignment"), + "eEzsignannotationType": obj.get("eEzsignannotationType"), + "iEzsignannotationX": obj.get("iEzsignannotationX"), + "iEzsignannotationY": obj.get("iEzsignannotationY"), + "iEzsignannotationWidth": obj.get("iEzsignannotationWidth"), + "iEzsignannotationHeight": obj.get("iEzsignannotationHeight"), + "sEzsignannotationText": obj.get("sEzsignannotationText"), + "iEzsignpagePagenumber": obj.get("iEzsignpagePagenumber"), + "objTextstylestatic": TextstylestaticResponseCompound.from_dict(obj.get("objTextstylestatic")) if obj.get("objTextstylestatic") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignbulksend_create_ezsignbulksendtransmission_v1_request.py b/eZmaxApi/models/ezsignbulksend_create_ezsignbulksendtransmission_v1_request.py index 9d290a004..d002f256d 100644 --- a/eZmaxApi/models/ezsignbulksend_create_ezsignbulksendtransmission_v1_request.py +++ b/eZmaxApi/models/ezsignbulksend_create_ezsignbulksendtransmission_v1_request.py @@ -19,66 +19,85 @@ import json -from typing import Optional, Union -from pydantic import BaseModel, Field, StrictBytes, StrictStr, conint +from typing import Any, ClassVar, Dict, List, Optional, Union +from pydantic import BaseModel, StrictBytes, StrictStr +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.field_e_ezsignfolder_sendreminderfrequency import FieldEEzsignfolderSendreminderfrequency +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignbulksendCreateEzsignbulksendtransmissionV1Request(BaseModel): """ - Request for POST /1/object/ezsignbulksend/{pkiEzsignbulksendID}/createEzsignbulksendtransmission # noqa: E501 - """ - fki_userlogintype_id: conint(strict=True, ge=0) = Field(..., alias="fkiUserlogintypeID", description="The unique ID of the Userlogintype Valid values: |Value|Description|Detail| |-|-|-| |1|**Email Only**|The Ezsignsigner will receive a secure link by email| |2|**Email and phone or SMS**|The Ezsignsigner will receive a secure link by email and will need to authenticate using SMS or Phone call. **Additional fee applies**| |3|**Email and secret question**|The Ezsignsigner will receive a secure link by email and will need to authenticate using a predefined question and answer| |4|**In person only**|The Ezsignsigner will only be able to sign \"In-Person\" and there won't be any authentication. No email will be sent for invitation to sign. Make sure you evaluate the risk of signature denial and at minimum, we recommend you use a handwritten signature type| |5|**In person with phone or SMS**|The Ezsignsigner will only be able to sign \"In-Person\" and will need to authenticate using SMS or Phone call. No email will be sent for invitation to sign. **Additional fee applies**|") - fki_ezsigntsarequirement_id: Optional[conint(strict=True, le=3, ge=1)] = Field(None, alias="fkiEzsigntsarequirementID", description="The unique ID of the Ezsigntsarequirement. Determine if a Time Stamping Authority should add a timestamp on each of the signature. Valid values: |Value|Description| |-|-| |1|No. TSA Timestamping will requested. This will make all signatures a lot faster since no round-trip to the TSA server will be required. Timestamping will be made using eZsign server's time.| |2|Best effort. Timestamping from a Time Stamping Authority will be requested but is not mandatory. In the very improbable case it cannot be completed, the timestamping will be made using eZsign server's time. **Additional fee applies**| |3|Mandatory. Timestamping from a Time Stamping Authority will be requested and is mandatory. In the very improbable case it cannot be completed, the signature will fail and the user will be asked to retry. **Additional fee applies**|") - s_ezsignbulksendtransmission_description: StrictStr = Field(..., alias="sEzsignbulksendtransmissionDescription", description="The description of the Ezsignbulksendtransmission") - dt_ezsigndocument_duedate: StrictStr = Field(..., alias="dtEzsigndocumentDuedate", description="The maximum date and time at which the Ezsigndocument can be signed.") - e_ezsignfolder_sendreminderfrequency: FieldEEzsignfolderSendreminderfrequency = Field(..., alias="eEzsignfolderSendreminderfrequency") - t_extra_message: StrictStr = Field(..., alias="tExtraMessage", description="A custom text message that will be added to the email sent.") - s_csv_base64: Union[StrictBytes, StrictStr] = Field(..., alias="sCsvBase64", description="The Base64 encoded binary content of the CSV file.") - __properties = ["fkiUserlogintypeID", "fkiEzsigntsarequirementID", "sEzsignbulksendtransmissionDescription", "dtEzsigndocumentDuedate", "eEzsignfolderSendreminderfrequency", "tExtraMessage", "sCsvBase64"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + Request for POST /1/object/ezsignbulksend/{pkiEzsignbulksendID}/createEzsignbulksendtransmission + """ # noqa: E501 + fki_userlogintype_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Userlogintype Valid values: |Value|Description|Detail| |-|-|-| |1|**Email Only**|The Ezsignsigner will receive a secure link by email| |2|**Email and phone or SMS**|The Ezsignsigner will receive a secure link by email and will need to authenticate using SMS or Phone call. **Additional fee applies**| |3|**Email and secret question**|The Ezsignsigner will receive a secure link by email and will need to authenticate using a predefined question and answer| |4|**In person only**|The Ezsignsigner will only be able to sign \"In-Person\" and there won't be any authentication. No email will be sent for invitation to sign. Make sure you evaluate the risk of signature denial and at minimum, we recommend you use a handwritten signature type| |5|**In person with phone or SMS**|The Ezsignsigner will only be able to sign \"In-Person\" and will need to authenticate using SMS or Phone call. No email will be sent for invitation to sign. **Additional fee applies**|", alias="fkiUserlogintypeID") + fki_ezsigntsarequirement_id: Optional[Annotated[int, Field(le=3, strict=True, ge=1)]] = Field(default=None, description="The unique ID of the Ezsigntsarequirement. Determine if a Time Stamping Authority should add a timestamp on each of the signature. Valid values: |Value|Description| |-|-| |1|No. TSA Timestamping will requested. This will make all signatures a lot faster since no round-trip to the TSA server will be required. Timestamping will be made using eZsign server's time.| |2|Best effort. Timestamping from a Time Stamping Authority will be requested but is not mandatory. In the very improbable case it cannot be completed, the timestamping will be made using eZsign server's time. **Additional fee applies**| |3|Mandatory. Timestamping from a Time Stamping Authority will be requested and is mandatory. In the very improbable case it cannot be completed, the signature will fail and the user will be asked to retry. **Additional fee applies**|", alias="fkiEzsigntsarequirementID") + s_ezsignbulksendtransmission_description: StrictStr = Field(description="The description of the Ezsignbulksendtransmission", alias="sEzsignbulksendtransmissionDescription") + dt_ezsigndocument_duedate: StrictStr = Field(description="The maximum date and time at which the Ezsigndocument can be signed.", alias="dtEzsigndocumentDuedate") + e_ezsignfolder_sendreminderfrequency: FieldEEzsignfolderSendreminderfrequency = Field(alias="eEzsignfolderSendreminderfrequency") + t_extra_message: StrictStr = Field(description="A custom text message that will be added to the email sent.", alias="tExtraMessage") + s_csv_base64: Union[StrictBytes, StrictStr] = Field(description="The Base64 encoded binary content of the CSV file.", alias="sCsvBase64") + __properties: ClassVar[List[str]] = ["fkiUserlogintypeID", "fkiEzsigntsarequirementID", "sEzsignbulksendtransmissionDescription", "dtEzsigndocumentDuedate", "eEzsignfolderSendreminderfrequency", "tExtraMessage", "sCsvBase64"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignbulksendCreateEzsignbulksendtransmissionV1Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignbulksendCreateEzsignbulksendtransmissionV1Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignbulksendCreateEzsignbulksendtransmissionV1Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignbulksendCreateEzsignbulksendtransmissionV1Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignbulksendCreateEzsignbulksendtransmissionV1Request.parse_obj(obj) - - _obj = EzsignbulksendCreateEzsignbulksendtransmissionV1Request.parse_obj({ - "fki_userlogintype_id": obj.get("fkiUserlogintypeID"), - "fki_ezsigntsarequirement_id": obj.get("fkiEzsigntsarequirementID"), - "s_ezsignbulksendtransmission_description": obj.get("sEzsignbulksendtransmissionDescription"), - "dt_ezsigndocument_duedate": obj.get("dtEzsigndocumentDuedate"), - "e_ezsignfolder_sendreminderfrequency": obj.get("eEzsignfolderSendreminderfrequency"), - "t_extra_message": obj.get("tExtraMessage"), - "s_csv_base64": obj.get("sCsvBase64") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "fkiUserlogintypeID": obj.get("fkiUserlogintypeID"), + "fkiEzsigntsarequirementID": obj.get("fkiEzsigntsarequirementID"), + "sEzsignbulksendtransmissionDescription": obj.get("sEzsignbulksendtransmissionDescription"), + "dtEzsigndocumentDuedate": obj.get("dtEzsigndocumentDuedate"), + "eEzsignfolderSendreminderfrequency": obj.get("eEzsignfolderSendreminderfrequency"), + "tExtraMessage": obj.get("tExtraMessage"), + "sCsvBase64": obj.get("sCsvBase64") }) return _obj diff --git a/eZmaxApi/models/ezsignbulksend_create_ezsignbulksendtransmission_v1_response.py b/eZmaxApi/models/ezsignbulksend_create_ezsignbulksendtransmission_v1_response.py index bd7ace160..984e424eb 100644 --- a/eZmaxApi/models/ezsignbulksend_create_ezsignbulksendtransmission_v1_response.py +++ b/eZmaxApi/models/ezsignbulksend_create_ezsignbulksendtransmission_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.ezsignbulksend_create_ezsignbulksendtransmission_v1_response_m_payload import EzsignbulksendCreateEzsignbulksendtransmissionV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignbulksendCreateEzsignbulksendtransmissionV1Response(BaseModel): """ - Response for POST /1/object/ezsignbulksend/{pkiEzsignbulksendID}/createEzsignbulksendtransmission # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzsignbulksendCreateEzsignbulksendtransmissionV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for POST /1/object/ezsignbulksend/{pkiEzsignbulksendID}/createEzsignbulksendtransmission + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsignbulksendCreateEzsignbulksendtransmissionV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignbulksendCreateEzsignbulksendtransmissionV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignbulksendCreateEzsignbulksendtransmissionV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignbulksendCreateEzsignbulksendtransmissionV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignbulksendCreateEzsignbulksendtransmissionV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignbulksendCreateEzsignbulksendtransmissionV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignbulksendCreateEzsignbulksendtransmissionV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzsignbulksendCreateEzsignbulksendtransmissionV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsignbulksendCreateEzsignbulksendtransmissionV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignbulksend_create_ezsignbulksendtransmission_v1_response_m_payload.py b/eZmaxApi/models/ezsignbulksend_create_ezsignbulksendtransmission_v1_response_m_payload.py index 615eb7245..9846912ec 100644 --- a/eZmaxApi/models/ezsignbulksend_create_ezsignbulksendtransmission_v1_response_m_payload.py +++ b/eZmaxApi/models/ezsignbulksend_create_ezsignbulksendtransmission_v1_response_m_payload.py @@ -19,57 +19,75 @@ import json - -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.ezsignbulksendtransmission_response import EzsignbulksendtransmissionResponse +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignbulksendCreateEzsignbulksendtransmissionV1ResponseMPayload(BaseModel): """ - Payload for POST /1/object/ezsignbulksend/{pkiEzsignbulksendID}/createEzsignbulksendtransmission # noqa: E501 - """ - obj_ezsignbulksendtransmission: EzsignbulksendtransmissionResponse = Field(..., alias="objEzsignbulksendtransmission") - __properties = ["objEzsignbulksendtransmission"] + Payload for POST /1/object/ezsignbulksend/{pkiEzsignbulksendID}/createEzsignbulksendtransmission + """ # noqa: E501 + obj_ezsignbulksendtransmission: EzsignbulksendtransmissionResponse = Field(alias="objEzsignbulksendtransmission") + __properties: ClassVar[List[str]] = ["objEzsignbulksendtransmission"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignbulksendCreateEzsignbulksendtransmissionV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignbulksendCreateEzsignbulksendtransmissionV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_ezsignbulksendtransmission if self.obj_ezsignbulksendtransmission: _dict['objEzsignbulksendtransmission'] = self.obj_ezsignbulksendtransmission.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignbulksendCreateEzsignbulksendtransmissionV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignbulksendCreateEzsignbulksendtransmissionV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignbulksendCreateEzsignbulksendtransmissionV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignbulksendCreateEzsignbulksendtransmissionV1ResponseMPayload.parse_obj({ - "obj_ezsignbulksendtransmission": EzsignbulksendtransmissionResponse.from_dict(obj.get("objEzsignbulksendtransmission")) if obj.get("objEzsignbulksendtransmission") is not None else None + _obj = cls.model_validate({ + "objEzsignbulksendtransmission": EzsignbulksendtransmissionResponse.from_dict(obj.get("objEzsignbulksendtransmission")) if obj.get("objEzsignbulksendtransmission") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignbulksend_create_object_v1_request.py b/eZmaxApi/models/ezsignbulksend_create_object_v1_request.py index 54c3f6581..84be8636c 100644 --- a/eZmaxApi/models/ezsignbulksend_create_object_v1_request.py +++ b/eZmaxApi/models/ezsignbulksend_create_object_v1_request.py @@ -19,41 +19,60 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.ezsignbulksend_request_compound import EzsignbulksendRequestCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignbulksendCreateObjectV1Request(BaseModel): """ - Request for POST /1/object/ezsignbulksend # noqa: E501 - """ - a_obj_ezsignbulksend: conlist(EzsignbulksendRequestCompound, min_items=1) = Field(..., alias="a_objEzsignbulksend") - __properties = ["a_objEzsignbulksend"] + Request for POST /1/object/ezsignbulksend + """ # noqa: E501 + a_obj_ezsignbulksend: Annotated[List[EzsignbulksendRequestCompound], Field(min_length=1)] = Field(alias="a_objEzsignbulksend") + __properties: ClassVar[List[str]] = ["a_objEzsignbulksend"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignbulksendCreateObjectV1Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignbulksendCreateObjectV1Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_ezsignbulksend (list) _items = [] if self.a_obj_ezsignbulksend: @@ -64,16 +83,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignbulksendCreateObjectV1Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignbulksendCreateObjectV1Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignbulksendCreateObjectV1Request.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignbulksendCreateObjectV1Request.parse_obj({ - "a_obj_ezsignbulksend": [EzsignbulksendRequestCompound.from_dict(_item) for _item in obj.get("a_objEzsignbulksend")] if obj.get("a_objEzsignbulksend") is not None else None + _obj = cls.model_validate({ + "a_objEzsignbulksend": [EzsignbulksendRequestCompound.from_dict(_item) for _item in obj.get("a_objEzsignbulksend")] if obj.get("a_objEzsignbulksend") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignbulksend_create_object_v1_response.py b/eZmaxApi/models/ezsignbulksend_create_object_v1_response.py index e1e39245b..12d4647f2 100644 --- a/eZmaxApi/models/ezsignbulksend_create_object_v1_response.py +++ b/eZmaxApi/models/ezsignbulksend_create_object_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.ezsignbulksend_create_object_v1_response_m_payload import EzsignbulksendCreateObjectV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignbulksendCreateObjectV1Response(BaseModel): """ - Response for POST /1/object/ezsignbulksend # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzsignbulksendCreateObjectV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for POST /1/object/ezsignbulksend + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsignbulksendCreateObjectV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignbulksendCreateObjectV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignbulksendCreateObjectV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignbulksendCreateObjectV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignbulksendCreateObjectV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignbulksendCreateObjectV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignbulksendCreateObjectV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzsignbulksendCreateObjectV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsignbulksendCreateObjectV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignbulksend_create_object_v1_response_m_payload.py b/eZmaxApi/models/ezsignbulksend_create_object_v1_response_m_payload.py index 1d33d924f..47c5ab8b9 100644 --- a/eZmaxApi/models/ezsignbulksend_create_object_v1_response_m_payload.py +++ b/eZmaxApi/models/ezsignbulksend_create_object_v1_response_m_payload.py @@ -19,53 +19,72 @@ import json -from typing import List -from pydantic import BaseModel, Field, conint, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignbulksendCreateObjectV1ResponseMPayload(BaseModel): """ - Payload for POST /1/object/ezsignbulksend # noqa: E501 - """ - a_pki_ezsignbulksend_id: conlist(conint(strict=True, ge=0), min_items=1) = Field(..., alias="a_pkiEzsignbulksendID", description="An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request.") - __properties = ["a_pkiEzsignbulksendID"] + Payload for POST /1/object/ezsignbulksend + """ # noqa: E501 + a_pki_ezsignbulksend_id: Annotated[List[Annotated[int, Field(strict=True, ge=0)]], Field(min_length=1)] = Field(description="An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request.", alias="a_pkiEzsignbulksendID") + __properties: ClassVar[List[str]] = ["a_pkiEzsignbulksendID"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignbulksendCreateObjectV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignbulksendCreateObjectV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignbulksendCreateObjectV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignbulksendCreateObjectV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignbulksendCreateObjectV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignbulksendCreateObjectV1ResponseMPayload.parse_obj({ - "a_pki_ezsignbulksend_id": obj.get("a_pkiEzsignbulksendID") + _obj = cls.model_validate({ + "a_pkiEzsignbulksendID": obj.get("a_pkiEzsignbulksendID") }) return _obj diff --git a/eZmaxApi/models/ezsignbulksend_delete_object_v1_response.py b/eZmaxApi/models/ezsignbulksend_delete_object_v1_response.py index 43225be96..5118ac45f 100644 --- a/eZmaxApi/models/ezsignbulksend_delete_object_v1_response.py +++ b/eZmaxApi/models/ezsignbulksend_delete_object_v1_response.py @@ -19,43 +19,61 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignbulksendDeleteObjectV1Response(BaseModel): """ - Response for DELETE /1/object/ezsignbulksend/{pkiEzsignbulksendID} # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - __properties = ["objDebugPayload", "objDebug"] + Response for DELETE /1/object/ezsignbulksend/{pkiEzsignbulksendID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignbulksendDeleteObjectV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignbulksendDeleteObjectV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -65,17 +83,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignbulksendDeleteObjectV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignbulksendDeleteObjectV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignbulksendDeleteObjectV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignbulksendDeleteObjectV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignbulksend_edit_object_v1_request.py b/eZmaxApi/models/ezsignbulksend_edit_object_v1_request.py index b7e452fdf..679658bfc 100644 --- a/eZmaxApi/models/ezsignbulksend_edit_object_v1_request.py +++ b/eZmaxApi/models/ezsignbulksend_edit_object_v1_request.py @@ -19,57 +19,75 @@ import json - -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.ezsignbulksend_request_compound import EzsignbulksendRequestCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignbulksendEditObjectV1Request(BaseModel): """ - Request for PUT /1/object/ezsignbulksend/{pkiEzsignbulksendID} # noqa: E501 - """ - obj_ezsignbulksend: EzsignbulksendRequestCompound = Field(..., alias="objEzsignbulksend") - __properties = ["objEzsignbulksend"] + Request for PUT /1/object/ezsignbulksend/{pkiEzsignbulksendID} + """ # noqa: E501 + obj_ezsignbulksend: EzsignbulksendRequestCompound = Field(alias="objEzsignbulksend") + __properties: ClassVar[List[str]] = ["objEzsignbulksend"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignbulksendEditObjectV1Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignbulksendEditObjectV1Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_ezsignbulksend if self.obj_ezsignbulksend: _dict['objEzsignbulksend'] = self.obj_ezsignbulksend.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignbulksendEditObjectV1Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignbulksendEditObjectV1Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignbulksendEditObjectV1Request.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignbulksendEditObjectV1Request.parse_obj({ - "obj_ezsignbulksend": EzsignbulksendRequestCompound.from_dict(obj.get("objEzsignbulksend")) if obj.get("objEzsignbulksend") is not None else None + _obj = cls.model_validate({ + "objEzsignbulksend": EzsignbulksendRequestCompound.from_dict(obj.get("objEzsignbulksend")) if obj.get("objEzsignbulksend") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignbulksend_edit_object_v1_response.py b/eZmaxApi/models/ezsignbulksend_edit_object_v1_response.py index 38ae026ad..f09891909 100644 --- a/eZmaxApi/models/ezsignbulksend_edit_object_v1_response.py +++ b/eZmaxApi/models/ezsignbulksend_edit_object_v1_response.py @@ -19,43 +19,61 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignbulksendEditObjectV1Response(BaseModel): """ - Response for PUT /1/object/ezsignbulksend/{pkiEzsignbulksendID} # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - __properties = ["objDebugPayload", "objDebug"] + Response for PUT /1/object/ezsignbulksend/{pkiEzsignbulksendID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignbulksendEditObjectV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignbulksendEditObjectV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -65,17 +83,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignbulksendEditObjectV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignbulksendEditObjectV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignbulksendEditObjectV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignbulksendEditObjectV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignbulksend_get_ezsignbulksendtransmissions_v1_response.py b/eZmaxApi/models/ezsignbulksend_get_ezsignbulksendtransmissions_v1_response.py index 0d02a1129..43843bda5 100644 --- a/eZmaxApi/models/ezsignbulksend_get_ezsignbulksendtransmissions_v1_response.py +++ b/eZmaxApi/models/ezsignbulksend_get_ezsignbulksendtransmissions_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.ezsignbulksend_get_ezsignbulksendtransmissions_v1_response_m_payload import EzsignbulksendGetEzsignbulksendtransmissionsV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignbulksendGetEzsignbulksendtransmissionsV1Response(BaseModel): """ - Response for GET /1/object/ezsignbulksend/{pkiEzsignbulksend}/getEzsignbulksendtransmissions # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzsignbulksendGetEzsignbulksendtransmissionsV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /1/object/ezsignbulksend/{pkiEzsignbulksend}/getEzsignbulksendtransmissions + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsignbulksendGetEzsignbulksendtransmissionsV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignbulksendGetEzsignbulksendtransmissionsV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignbulksendGetEzsignbulksendtransmissionsV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignbulksendGetEzsignbulksendtransmissionsV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignbulksendGetEzsignbulksendtransmissionsV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignbulksendGetEzsignbulksendtransmissionsV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignbulksendGetEzsignbulksendtransmissionsV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzsignbulksendGetEzsignbulksendtransmissionsV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsignbulksendGetEzsignbulksendtransmissionsV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignbulksend_get_ezsignbulksendtransmissions_v1_response_m_payload.py b/eZmaxApi/models/ezsignbulksend_get_ezsignbulksendtransmissions_v1_response_m_payload.py index 10c740d32..04cd92546 100644 --- a/eZmaxApi/models/ezsignbulksend_get_ezsignbulksendtransmissions_v1_response_m_payload.py +++ b/eZmaxApi/models/ezsignbulksend_get_ezsignbulksendtransmissions_v1_response_m_payload.py @@ -19,41 +19,59 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.ezsignbulksendtransmission_response_compound import EzsignbulksendtransmissionResponseCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignbulksendGetEzsignbulksendtransmissionsV1ResponseMPayload(BaseModel): """ - Payload for GET /1/object/ezsignbulksend/{pkiEzsignbulksend}/getEzsignbulksendtransmissions # noqa: E501 - """ - a_obj_ezsignbulksendtransmission: conlist(EzsignbulksendtransmissionResponseCompound) = Field(..., alias="a_objEzsignbulksendtransmission") - __properties = ["a_objEzsignbulksendtransmission"] + Payload for GET /1/object/ezsignbulksend/{pkiEzsignbulksend}/getEzsignbulksendtransmissions + """ # noqa: E501 + a_obj_ezsignbulksendtransmission: List[EzsignbulksendtransmissionResponseCompound] = Field(alias="a_objEzsignbulksendtransmission") + __properties: ClassVar[List[str]] = ["a_objEzsignbulksendtransmission"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignbulksendGetEzsignbulksendtransmissionsV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignbulksendGetEzsignbulksendtransmissionsV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_ezsignbulksendtransmission (list) _items = [] if self.a_obj_ezsignbulksendtransmission: @@ -64,16 +82,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignbulksendGetEzsignbulksendtransmissionsV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignbulksendGetEzsignbulksendtransmissionsV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignbulksendGetEzsignbulksendtransmissionsV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignbulksendGetEzsignbulksendtransmissionsV1ResponseMPayload.parse_obj({ - "a_obj_ezsignbulksendtransmission": [EzsignbulksendtransmissionResponseCompound.from_dict(_item) for _item in obj.get("a_objEzsignbulksendtransmission")] if obj.get("a_objEzsignbulksendtransmission") is not None else None + _obj = cls.model_validate({ + "a_objEzsignbulksendtransmission": [EzsignbulksendtransmissionResponseCompound.from_dict(_item) for _item in obj.get("a_objEzsignbulksendtransmission")] if obj.get("a_objEzsignbulksendtransmission") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignbulksend_get_ezsignsignatures_automatic_v1_response.py b/eZmaxApi/models/ezsignbulksend_get_ezsignsignatures_automatic_v1_response.py index e33ea624b..066de3661 100644 --- a/eZmaxApi/models/ezsignbulksend_get_ezsignsignatures_automatic_v1_response.py +++ b/eZmaxApi/models/ezsignbulksend_get_ezsignsignatures_automatic_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.ezsignbulksend_get_ezsignsignatures_automatic_v1_response_m_payload import EzsignbulksendGetEzsignsignaturesAutomaticV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignbulksendGetEzsignsignaturesAutomaticV1Response(BaseModel): """ - Response for GET /1/object/ezsignbulksend/{pkiEzsignbulksendID}/getEzsignsignaturesAutomatic # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzsignbulksendGetEzsignsignaturesAutomaticV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /1/object/ezsignbulksend/{pkiEzsignbulksendID}/getEzsignsignaturesAutomatic + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsignbulksendGetEzsignsignaturesAutomaticV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignbulksendGetEzsignsignaturesAutomaticV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignbulksendGetEzsignsignaturesAutomaticV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignbulksendGetEzsignsignaturesAutomaticV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignbulksendGetEzsignsignaturesAutomaticV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignbulksendGetEzsignsignaturesAutomaticV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignbulksendGetEzsignsignaturesAutomaticV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzsignbulksendGetEzsignsignaturesAutomaticV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsignbulksendGetEzsignsignaturesAutomaticV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignbulksend_get_ezsignsignatures_automatic_v1_response_m_payload.py b/eZmaxApi/models/ezsignbulksend_get_ezsignsignatures_automatic_v1_response_m_payload.py index cb1b1c132..f31e9f4e9 100644 --- a/eZmaxApi/models/ezsignbulksend_get_ezsignsignatures_automatic_v1_response_m_payload.py +++ b/eZmaxApi/models/ezsignbulksend_get_ezsignsignatures_automatic_v1_response_m_payload.py @@ -19,43 +19,61 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.custom_ezsignfolder_ezsignsignatures_automatic_response import CustomEzsignfolderEzsignsignaturesAutomaticResponse from eZmaxApi.models.field_e_ezsignsignature_type import FieldEEzsignsignatureType +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignbulksendGetEzsignsignaturesAutomaticV1ResponseMPayload(BaseModel): """ - Payload for GET /1/object/ezsignbulksend/{pkiEzsignbulksendID}/getEzsignsignaturesAutomatic # noqa: E501 - """ - a_e_ezsignsignature_type: conlist(FieldEEzsignsignatureType, unique_items=True) = Field(..., alias="a_eEzsignsignatureType", description="All eEzsignsignatureType contained in the response") - a_obj_ezsignfolder: conlist(CustomEzsignfolderEzsignsignaturesAutomaticResponse) = Field(..., alias="a_objEzsignfolder") - __properties = ["a_eEzsignsignatureType", "a_objEzsignfolder"] + Payload for GET /1/object/ezsignbulksend/{pkiEzsignbulksendID}/getEzsignsignaturesAutomatic + """ # noqa: E501 + a_e_ezsignsignature_type: List[FieldEEzsignsignatureType] = Field(description="All eEzsignsignatureType contained in the response", alias="a_eEzsignsignatureType") + a_obj_ezsignfolder: List[CustomEzsignfolderEzsignsignaturesAutomaticResponse] = Field(alias="a_objEzsignfolder") + __properties: ClassVar[List[str]] = ["a_eEzsignsignatureType", "a_objEzsignfolder"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignbulksendGetEzsignsignaturesAutomaticV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignbulksendGetEzsignsignaturesAutomaticV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_ezsignfolder (list) _items = [] if self.a_obj_ezsignfolder: @@ -66,17 +84,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignbulksendGetEzsignsignaturesAutomaticV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignbulksendGetEzsignsignaturesAutomaticV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignbulksendGetEzsignsignaturesAutomaticV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignbulksendGetEzsignsignaturesAutomaticV1ResponseMPayload.parse_obj({ - "a_e_ezsignsignature_type": obj.get("a_eEzsignsignatureType"), - "a_obj_ezsignfolder": [CustomEzsignfolderEzsignsignaturesAutomaticResponse.from_dict(_item) for _item in obj.get("a_objEzsignfolder")] if obj.get("a_objEzsignfolder") is not None else None + _obj = cls.model_validate({ + "a_eEzsignsignatureType": obj.get("a_eEzsignsignatureType"), + "a_objEzsignfolder": [CustomEzsignfolderEzsignsignaturesAutomaticResponse.from_dict(_item) for _item in obj.get("a_objEzsignfolder")] if obj.get("a_objEzsignfolder") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignbulksend_get_forms_data_v1_response.py b/eZmaxApi/models/ezsignbulksend_get_forms_data_v1_response.py index e50edbfd4..06d64ddc3 100644 --- a/eZmaxApi/models/ezsignbulksend_get_forms_data_v1_response.py +++ b/eZmaxApi/models/ezsignbulksend_get_forms_data_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.ezsignbulksend_get_forms_data_v1_response_m_payload import EzsignbulksendGetFormsDataV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignbulksendGetFormsDataV1Response(BaseModel): """ - Response for GET /1/object/ezsignbulksend/{pkiEzsignbulksendID}/getFormsData # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzsignbulksendGetFormsDataV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /1/object/ezsignbulksend/{pkiEzsignbulksendID}/getFormsData + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsignbulksendGetFormsDataV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignbulksendGetFormsDataV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignbulksendGetFormsDataV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignbulksendGetFormsDataV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignbulksendGetFormsDataV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignbulksendGetFormsDataV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignbulksendGetFormsDataV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzsignbulksendGetFormsDataV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsignbulksendGetFormsDataV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignbulksend_get_forms_data_v1_response_m_payload.py b/eZmaxApi/models/ezsignbulksend_get_forms_data_v1_response_m_payload.py index 9ba5d038c..d0aa5e7cc 100644 --- a/eZmaxApi/models/ezsignbulksend_get_forms_data_v1_response_m_payload.py +++ b/eZmaxApi/models/ezsignbulksend_get_forms_data_v1_response_m_payload.py @@ -19,41 +19,59 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.custom_forms_data_folder_response import CustomFormsDataFolderResponse +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignbulksendGetFormsDataV1ResponseMPayload(BaseModel): """ - Payload for GET/1/object/ezsignbulksend/{pkiEzsignbulksendID}/getFormsData # noqa: E501 - """ - a_obj_forms_data_folder: conlist(CustomFormsDataFolderResponse) = Field(..., alias="a_objFormsDataFolder") - __properties = ["a_objFormsDataFolder"] + Payload for GET/1/object/ezsignbulksend/{pkiEzsignbulksendID}/getFormsData + """ # noqa: E501 + a_obj_forms_data_folder: List[CustomFormsDataFolderResponse] = Field(alias="a_objFormsDataFolder") + __properties: ClassVar[List[str]] = ["a_objFormsDataFolder"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignbulksendGetFormsDataV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignbulksendGetFormsDataV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_forms_data_folder (list) _items = [] if self.a_obj_forms_data_folder: @@ -64,16 +82,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignbulksendGetFormsDataV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignbulksendGetFormsDataV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignbulksendGetFormsDataV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignbulksendGetFormsDataV1ResponseMPayload.parse_obj({ - "a_obj_forms_data_folder": [CustomFormsDataFolderResponse.from_dict(_item) for _item in obj.get("a_objFormsDataFolder")] if obj.get("a_objFormsDataFolder") is not None else None + _obj = cls.model_validate({ + "a_objFormsDataFolder": [CustomFormsDataFolderResponse.from_dict(_item) for _item in obj.get("a_objFormsDataFolder")] if obj.get("a_objFormsDataFolder") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignbulksend_get_list_v1_response.py b/eZmaxApi/models/ezsignbulksend_get_list_v1_response.py index 9e2d6f356..e1cf99a7a 100644 --- a/eZmaxApi/models/ezsignbulksend_get_list_v1_response.py +++ b/eZmaxApi/models/ezsignbulksend_get_list_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload_get_list import CommonResponseObjDebugPayloadGetList from eZmaxApi.models.ezsignbulksend_get_list_v1_response_m_payload import EzsignbulksendGetListV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignbulksendGetListV1Response(BaseModel): """ - Response for GET /1/object/ezsignbulksend/getList # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayloadGetList = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzsignbulksendGetListV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /1/object/ezsignbulksend/getList + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayloadGetList = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsignbulksendGetListV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignbulksendGetListV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignbulksendGetListV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignbulksendGetListV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignbulksendGetListV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignbulksendGetListV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignbulksendGetListV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayloadGetList.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzsignbulksendGetListV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayloadGetList.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsignbulksendGetListV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignbulksend_get_list_v1_response_m_payload.py b/eZmaxApi/models/ezsignbulksend_get_list_v1_response_m_payload.py index 520ff7522..d1895321a 100644 --- a/eZmaxApi/models/ezsignbulksend_get_list_v1_response_m_payload.py +++ b/eZmaxApi/models/ezsignbulksend_get_list_v1_response_m_payload.py @@ -19,43 +19,61 @@ import json -from typing import List -from pydantic import BaseModel, Field, StrictInt, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictInt +from pydantic import Field from eZmaxApi.models.ezsignbulksend_list_element import EzsignbulksendListElement +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignbulksendGetListV1ResponseMPayload(BaseModel): """ - Payload for GET /1/object/ezsignbulksend/getList # noqa: E501 - """ - i_row_returned: StrictInt = Field(..., alias="iRowReturned", description="The number of rows returned") - i_row_filtered: StrictInt = Field(..., alias="iRowFiltered", description="The number of rows matching your filters (if any) or the total number of rows") - a_obj_ezsignbulksend: conlist(EzsignbulksendListElement) = Field(..., alias="a_objEzsignbulksend") - __properties = ["iRowReturned", "iRowFiltered", "a_objEzsignbulksend"] + Payload for GET /1/object/ezsignbulksend/getList + """ # noqa: E501 + i_row_returned: StrictInt = Field(description="The number of rows returned", alias="iRowReturned") + i_row_filtered: StrictInt = Field(description="The number of rows matching your filters (if any) or the total number of rows", alias="iRowFiltered") + a_obj_ezsignbulksend: List[EzsignbulksendListElement] = Field(alias="a_objEzsignbulksend") + __properties: ClassVar[List[str]] = ["iRowReturned", "iRowFiltered", "a_objEzsignbulksend"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignbulksendGetListV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignbulksendGetListV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_ezsignbulksend (list) _items = [] if self.a_obj_ezsignbulksend: @@ -66,18 +84,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignbulksendGetListV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignbulksendGetListV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignbulksendGetListV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignbulksendGetListV1ResponseMPayload.parse_obj({ - "i_row_returned": obj.get("iRowReturned"), - "i_row_filtered": obj.get("iRowFiltered"), - "a_obj_ezsignbulksend": [EzsignbulksendListElement.from_dict(_item) for _item in obj.get("a_objEzsignbulksend")] if obj.get("a_objEzsignbulksend") is not None else None + _obj = cls.model_validate({ + "iRowReturned": obj.get("iRowReturned"), + "iRowFiltered": obj.get("iRowFiltered"), + "a_objEzsignbulksend": [EzsignbulksendListElement.from_dict(_item) for _item in obj.get("a_objEzsignbulksend")] if obj.get("a_objEzsignbulksend") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignbulksend_get_object_v2_response.py b/eZmaxApi/models/ezsignbulksend_get_object_v2_response.py index 3129e38fa..5b90c71e4 100644 --- a/eZmaxApi/models/ezsignbulksend_get_object_v2_response.py +++ b/eZmaxApi/models/ezsignbulksend_get_object_v2_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.ezsignbulksend_get_object_v2_response_m_payload import EzsignbulksendGetObjectV2ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignbulksendGetObjectV2Response(BaseModel): """ - Response for GET /2/object/ezsignbulksend/{pkiEzsignbulksendID} # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzsignbulksendGetObjectV2ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /2/object/ezsignbulksend/{pkiEzsignbulksendID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsignbulksendGetObjectV2ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignbulksendGetObjectV2Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignbulksendGetObjectV2Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignbulksendGetObjectV2Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignbulksendGetObjectV2Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignbulksendGetObjectV2Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignbulksendGetObjectV2Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzsignbulksendGetObjectV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsignbulksendGetObjectV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignbulksend_get_object_v2_response_m_payload.py b/eZmaxApi/models/ezsignbulksend_get_object_v2_response_m_payload.py index 5618b350a..e207ed377 100644 --- a/eZmaxApi/models/ezsignbulksend_get_object_v2_response_m_payload.py +++ b/eZmaxApi/models/ezsignbulksend_get_object_v2_response_m_payload.py @@ -19,57 +19,75 @@ import json - -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.ezsignbulksend_response_compound import EzsignbulksendResponseCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignbulksendGetObjectV2ResponseMPayload(BaseModel): """ - Payload for GET /2/object/ezsignbulksend/{pkiEzsignbulksendID} # noqa: E501 - """ - obj_ezsignbulksend: EzsignbulksendResponseCompound = Field(..., alias="objEzsignbulksend") - __properties = ["objEzsignbulksend"] + Payload for GET /2/object/ezsignbulksend/{pkiEzsignbulksendID} + """ # noqa: E501 + obj_ezsignbulksend: EzsignbulksendResponseCompound = Field(alias="objEzsignbulksend") + __properties: ClassVar[List[str]] = ["objEzsignbulksend"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignbulksendGetObjectV2ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignbulksendGetObjectV2ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_ezsignbulksend if self.obj_ezsignbulksend: _dict['objEzsignbulksend'] = self.obj_ezsignbulksend.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignbulksendGetObjectV2ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignbulksendGetObjectV2ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignbulksendGetObjectV2ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignbulksendGetObjectV2ResponseMPayload.parse_obj({ - "obj_ezsignbulksend": EzsignbulksendResponseCompound.from_dict(obj.get("objEzsignbulksend")) if obj.get("objEzsignbulksend") is not None else None + _obj = cls.model_validate({ + "objEzsignbulksend": EzsignbulksendResponseCompound.from_dict(obj.get("objEzsignbulksend")) if obj.get("objEzsignbulksend") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignbulksend_list_element.py b/eZmaxApi/models/ezsignbulksend_list_element.py index 7da7e617c..eb7daf559 100644 --- a/eZmaxApi/models/ezsignbulksend_list_element.py +++ b/eZmaxApi/models/ezsignbulksend_list_element.py @@ -19,73 +19,92 @@ import json - -from pydantic import BaseModel, Field, StrictBool, StrictInt, StrictStr, conint +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictBool, StrictInt, StrictStr +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignbulksendListElement(BaseModel): """ - An Ezsignbulksend List Element # noqa: E501 - """ - pki_ezsignbulksend_id: conint(strict=True, ge=0) = Field(..., alias="pkiEzsignbulksendID", description="The unique ID of the Ezsignbulksend") - fki_ezsignfoldertype_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsignfoldertypeID", description="The unique ID of the Ezsignfoldertype.") - s_ezsignbulksend_description: StrictStr = Field(..., alias="sEzsignbulksendDescription", description="The description of the Ezsignbulksend") - s_ezsignfoldertype_name_x: StrictStr = Field(..., alias="sEzsignfoldertypeNameX", description="The name of the Ezsignfoldertype in the language of the requester") - b_ezsignbulksend_needvalidation: StrictBool = Field(..., alias="bEzsignbulksendNeedvalidation", description="Whether the Ezsigntemplatepackage was automatically modified and needs a manual validation") - i_ezsignbulksendtransmission: StrictInt = Field(..., alias="iEzsignbulksendtransmission", description="The total number of Ezsignbulksendtransmissions in the Ezsignbulksend") - i_ezsignfolder: StrictInt = Field(..., alias="iEzsignfolder", description="The total number of Ezsignfolders in the Ezsignbulksend") - i_ezsigndocument: StrictInt = Field(..., alias="iEzsigndocument", description="The total number of Ezsigndocuments in the Ezsignbulksend") - i_ezsignsignature: StrictInt = Field(..., alias="iEzsignsignature", description="The total number of Ezsignsignature in the Ezsignbulksend") - i_ezsignsignature_signed: StrictInt = Field(..., alias="iEzsignsignatureSigned", description="The total number of already signed Ezsignsignature blocks in the Ezsignbulksend") - b_ezsignbulksend_isactive: StrictBool = Field(..., alias="bEzsignbulksendIsactive", description="Whether the Ezsignbulksend is active or not") - __properties = ["pkiEzsignbulksendID", "fkiEzsignfoldertypeID", "sEzsignbulksendDescription", "sEzsignfoldertypeNameX", "bEzsignbulksendNeedvalidation", "iEzsignbulksendtransmission", "iEzsignfolder", "iEzsigndocument", "iEzsignsignature", "iEzsignsignatureSigned", "bEzsignbulksendIsactive"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + An Ezsignbulksend List Element + """ # noqa: E501 + pki_ezsignbulksend_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsignbulksend", alias="pkiEzsignbulksendID") + fki_ezsignfoldertype_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsignfoldertype.", alias="fkiEzsignfoldertypeID") + s_ezsignbulksend_description: StrictStr = Field(description="The description of the Ezsignbulksend", alias="sEzsignbulksendDescription") + s_ezsignfoldertype_name_x: StrictStr = Field(description="The name of the Ezsignfoldertype in the language of the requester", alias="sEzsignfoldertypeNameX") + b_ezsignbulksend_needvalidation: StrictBool = Field(description="Whether the Ezsigntemplatepackage was automatically modified and needs a manual validation", alias="bEzsignbulksendNeedvalidation") + i_ezsignbulksendtransmission: StrictInt = Field(description="The total number of Ezsignbulksendtransmissions in the Ezsignbulksend", alias="iEzsignbulksendtransmission") + i_ezsignfolder: StrictInt = Field(description="The total number of Ezsignfolders in the Ezsignbulksend", alias="iEzsignfolder") + i_ezsigndocument: StrictInt = Field(description="The total number of Ezsigndocuments in the Ezsignbulksend", alias="iEzsigndocument") + i_ezsignsignature: StrictInt = Field(description="The total number of Ezsignsignature in the Ezsignbulksend", alias="iEzsignsignature") + i_ezsignsignature_signed: StrictInt = Field(description="The total number of already signed Ezsignsignature blocks in the Ezsignbulksend", alias="iEzsignsignatureSigned") + b_ezsignbulksend_isactive: StrictBool = Field(description="Whether the Ezsignbulksend is active or not", alias="bEzsignbulksendIsactive") + __properties: ClassVar[List[str]] = ["pkiEzsignbulksendID", "fkiEzsignfoldertypeID", "sEzsignbulksendDescription", "sEzsignfoldertypeNameX", "bEzsignbulksendNeedvalidation", "iEzsignbulksendtransmission", "iEzsignfolder", "iEzsigndocument", "iEzsignsignature", "iEzsignsignatureSigned", "bEzsignbulksendIsactive"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignbulksendListElement: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignbulksendListElement from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignbulksendListElement: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignbulksendListElement from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignbulksendListElement.parse_obj(obj) - - _obj = EzsignbulksendListElement.parse_obj({ - "pki_ezsignbulksend_id": obj.get("pkiEzsignbulksendID"), - "fki_ezsignfoldertype_id": obj.get("fkiEzsignfoldertypeID"), - "s_ezsignbulksend_description": obj.get("sEzsignbulksendDescription"), - "s_ezsignfoldertype_name_x": obj.get("sEzsignfoldertypeNameX"), - "b_ezsignbulksend_needvalidation": obj.get("bEzsignbulksendNeedvalidation"), - "i_ezsignbulksendtransmission": obj.get("iEzsignbulksendtransmission"), - "i_ezsignfolder": obj.get("iEzsignfolder"), - "i_ezsigndocument": obj.get("iEzsigndocument"), - "i_ezsignsignature": obj.get("iEzsignsignature"), - "i_ezsignsignature_signed": obj.get("iEzsignsignatureSigned"), - "b_ezsignbulksend_isactive": obj.get("bEzsignbulksendIsactive") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsignbulksendID": obj.get("pkiEzsignbulksendID"), + "fkiEzsignfoldertypeID": obj.get("fkiEzsignfoldertypeID"), + "sEzsignbulksendDescription": obj.get("sEzsignbulksendDescription"), + "sEzsignfoldertypeNameX": obj.get("sEzsignfoldertypeNameX"), + "bEzsignbulksendNeedvalidation": obj.get("bEzsignbulksendNeedvalidation"), + "iEzsignbulksendtransmission": obj.get("iEzsignbulksendtransmission"), + "iEzsignfolder": obj.get("iEzsignfolder"), + "iEzsigndocument": obj.get("iEzsigndocument"), + "iEzsignsignature": obj.get("iEzsignsignature"), + "iEzsignsignatureSigned": obj.get("iEzsignsignatureSigned"), + "bEzsignbulksendIsactive": obj.get("bEzsignbulksendIsactive") }) return _obj diff --git a/eZmaxApi/models/ezsignbulksend_reorder_v1_request.py b/eZmaxApi/models/ezsignbulksend_reorder_v1_request.py index b48cdfae9..083aa1592 100644 --- a/eZmaxApi/models/ezsignbulksend_reorder_v1_request.py +++ b/eZmaxApi/models/ezsignbulksend_reorder_v1_request.py @@ -19,53 +19,72 @@ import json -from typing import List -from pydantic import BaseModel, Field, conint, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignbulksendReorderV1Request(BaseModel): """ - Request for POST /1/object/ezsignbulksend/{pkiEzsignbulksendID}/reorder # noqa: E501 - """ - a_pki_ezsignbulksenddocumentmapping_id: conlist(conint(strict=True, ge=0)) = Field(..., alias="a_pkiEzsignbulksenddocumentmappingID") - __properties = ["a_pkiEzsignbulksenddocumentmappingID"] + Request for POST /1/object/ezsignbulksend/{pkiEzsignbulksendID}/reorder + """ # noqa: E501 + a_pki_ezsignbulksenddocumentmapping_id: List[Annotated[int, Field(strict=True, ge=0)]] = Field(alias="a_pkiEzsignbulksenddocumentmappingID") + __properties: ClassVar[List[str]] = ["a_pkiEzsignbulksenddocumentmappingID"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignbulksendReorderV1Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignbulksendReorderV1Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignbulksendReorderV1Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignbulksendReorderV1Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignbulksendReorderV1Request.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignbulksendReorderV1Request.parse_obj({ - "a_pki_ezsignbulksenddocumentmapping_id": obj.get("a_pkiEzsignbulksenddocumentmappingID") + _obj = cls.model_validate({ + "a_pkiEzsignbulksenddocumentmappingID": obj.get("a_pkiEzsignbulksenddocumentmappingID") }) return _obj diff --git a/eZmaxApi/models/ezsignbulksend_reorder_v1_response.py b/eZmaxApi/models/ezsignbulksend_reorder_v1_response.py index 8ff7c9e18..202903711 100644 --- a/eZmaxApi/models/ezsignbulksend_reorder_v1_response.py +++ b/eZmaxApi/models/ezsignbulksend_reorder_v1_response.py @@ -19,43 +19,61 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignbulksendReorderV1Response(BaseModel): """ - Response for POST /1/object/ezsignbulksend/{pkiEzsignbulksendID}/reorder # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - __properties = ["objDebugPayload", "objDebug"] + Response for POST /1/object/ezsignbulksend/{pkiEzsignbulksendID}/reorder + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignbulksendReorderV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignbulksendReorderV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -65,17 +83,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignbulksendReorderV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignbulksendReorderV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignbulksendReorderV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignbulksendReorderV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignbulksend_request.py b/eZmaxApi/models/ezsignbulksend_request.py index 759fe5519..9c20831f7 100644 --- a/eZmaxApi/models/ezsignbulksend_request.py +++ b/eZmaxApi/models/ezsignbulksend_request.py @@ -19,65 +19,84 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, StrictStr +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignbulksendRequest(BaseModel): """ - A Ezsignbulksend Object # noqa: E501 - """ - pki_ezsignbulksend_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="pkiEzsignbulksendID", description="The unique ID of the Ezsignbulksend") - fki_ezsignfoldertype_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsignfoldertypeID", description="The unique ID of the Ezsignfoldertype.") - fki_language_id: conint(strict=True, le=2, ge=1) = Field(..., alias="fkiLanguageID", description="The unique ID of the Language. Valid values: |Value|Description| |-|-| |1|French| |2|English|") - s_ezsignbulksend_description: StrictStr = Field(..., alias="sEzsignbulksendDescription", description="The description of the Ezsignbulksend") - t_ezsignbulksend_note: StrictStr = Field(..., alias="tEzsignbulksendNote", description="Note about the Ezsignbulksend") - b_ezsignbulksend_needvalidation: StrictBool = Field(..., alias="bEzsignbulksendNeedvalidation", description="Whether the Ezsigntemplatepackage was automatically modified and needs a manual validation") - b_ezsignbulksend_isactive: StrictBool = Field(..., alias="bEzsignbulksendIsactive", description="Whether the Ezsignbulksend is active or not") - __properties = ["pkiEzsignbulksendID", "fkiEzsignfoldertypeID", "fkiLanguageID", "sEzsignbulksendDescription", "tEzsignbulksendNote", "bEzsignbulksendNeedvalidation", "bEzsignbulksendIsactive"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + A Ezsignbulksend Object + """ # noqa: E501 + pki_ezsignbulksend_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsignbulksend", alias="pkiEzsignbulksendID") + fki_ezsignfoldertype_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsignfoldertype.", alias="fkiEzsignfoldertypeID") + fki_language_id: Annotated[int, Field(le=2, strict=True, ge=1)] = Field(description="The unique ID of the Language. Valid values: |Value|Description| |-|-| |1|French| |2|English|", alias="fkiLanguageID") + s_ezsignbulksend_description: StrictStr = Field(description="The description of the Ezsignbulksend", alias="sEzsignbulksendDescription") + t_ezsignbulksend_note: StrictStr = Field(description="Note about the Ezsignbulksend", alias="tEzsignbulksendNote") + b_ezsignbulksend_needvalidation: StrictBool = Field(description="Whether the Ezsigntemplatepackage was automatically modified and needs a manual validation", alias="bEzsignbulksendNeedvalidation") + b_ezsignbulksend_isactive: StrictBool = Field(description="Whether the Ezsignbulksend is active or not", alias="bEzsignbulksendIsactive") + __properties: ClassVar[List[str]] = ["pkiEzsignbulksendID", "fkiEzsignfoldertypeID", "fkiLanguageID", "sEzsignbulksendDescription", "tEzsignbulksendNote", "bEzsignbulksendNeedvalidation", "bEzsignbulksendIsactive"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignbulksendRequest: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignbulksendRequest from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignbulksendRequest: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignbulksendRequest from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignbulksendRequest.parse_obj(obj) - - _obj = EzsignbulksendRequest.parse_obj({ - "pki_ezsignbulksend_id": obj.get("pkiEzsignbulksendID"), - "fki_ezsignfoldertype_id": obj.get("fkiEzsignfoldertypeID"), - "fki_language_id": obj.get("fkiLanguageID"), - "s_ezsignbulksend_description": obj.get("sEzsignbulksendDescription"), - "t_ezsignbulksend_note": obj.get("tEzsignbulksendNote"), - "b_ezsignbulksend_needvalidation": obj.get("bEzsignbulksendNeedvalidation"), - "b_ezsignbulksend_isactive": obj.get("bEzsignbulksendIsactive") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsignbulksendID": obj.get("pkiEzsignbulksendID"), + "fkiEzsignfoldertypeID": obj.get("fkiEzsignfoldertypeID"), + "fkiLanguageID": obj.get("fkiLanguageID"), + "sEzsignbulksendDescription": obj.get("sEzsignbulksendDescription"), + "tEzsignbulksendNote": obj.get("tEzsignbulksendNote"), + "bEzsignbulksendNeedvalidation": obj.get("bEzsignbulksendNeedvalidation"), + "bEzsignbulksendIsactive": obj.get("bEzsignbulksendIsactive") }) return _obj diff --git a/eZmaxApi/models/ezsignbulksend_request_compound.py b/eZmaxApi/models/ezsignbulksend_request_compound.py index 7b4cd5da1..69ac61f7e 100644 --- a/eZmaxApi/models/ezsignbulksend_request_compound.py +++ b/eZmaxApi/models/ezsignbulksend_request_compound.py @@ -19,65 +19,84 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, StrictStr +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignbulksendRequestCompound(BaseModel): """ - A Ezsignbulksend Object and children # noqa: E501 - """ - pki_ezsignbulksend_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="pkiEzsignbulksendID", description="The unique ID of the Ezsignbulksend") - fki_ezsignfoldertype_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsignfoldertypeID", description="The unique ID of the Ezsignfoldertype.") - fki_language_id: conint(strict=True, le=2, ge=1) = Field(..., alias="fkiLanguageID", description="The unique ID of the Language. Valid values: |Value|Description| |-|-| |1|French| |2|English|") - s_ezsignbulksend_description: StrictStr = Field(..., alias="sEzsignbulksendDescription", description="The description of the Ezsignbulksend") - t_ezsignbulksend_note: StrictStr = Field(..., alias="tEzsignbulksendNote", description="Note about the Ezsignbulksend") - b_ezsignbulksend_needvalidation: StrictBool = Field(..., alias="bEzsignbulksendNeedvalidation", description="Whether the Ezsigntemplatepackage was automatically modified and needs a manual validation") - b_ezsignbulksend_isactive: StrictBool = Field(..., alias="bEzsignbulksendIsactive", description="Whether the Ezsignbulksend is active or not") - __properties = ["pkiEzsignbulksendID", "fkiEzsignfoldertypeID", "fkiLanguageID", "sEzsignbulksendDescription", "tEzsignbulksendNote", "bEzsignbulksendNeedvalidation", "bEzsignbulksendIsactive"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + A Ezsignbulksend Object and children + """ # noqa: E501 + pki_ezsignbulksend_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsignbulksend", alias="pkiEzsignbulksendID") + fki_ezsignfoldertype_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsignfoldertype.", alias="fkiEzsignfoldertypeID") + fki_language_id: Annotated[int, Field(le=2, strict=True, ge=1)] = Field(description="The unique ID of the Language. Valid values: |Value|Description| |-|-| |1|French| |2|English|", alias="fkiLanguageID") + s_ezsignbulksend_description: StrictStr = Field(description="The description of the Ezsignbulksend", alias="sEzsignbulksendDescription") + t_ezsignbulksend_note: StrictStr = Field(description="Note about the Ezsignbulksend", alias="tEzsignbulksendNote") + b_ezsignbulksend_needvalidation: StrictBool = Field(description="Whether the Ezsigntemplatepackage was automatically modified and needs a manual validation", alias="bEzsignbulksendNeedvalidation") + b_ezsignbulksend_isactive: StrictBool = Field(description="Whether the Ezsignbulksend is active or not", alias="bEzsignbulksendIsactive") + __properties: ClassVar[List[str]] = ["pkiEzsignbulksendID", "fkiEzsignfoldertypeID", "fkiLanguageID", "sEzsignbulksendDescription", "tEzsignbulksendNote", "bEzsignbulksendNeedvalidation", "bEzsignbulksendIsactive"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignbulksendRequestCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignbulksendRequestCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignbulksendRequestCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignbulksendRequestCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignbulksendRequestCompound.parse_obj(obj) - - _obj = EzsignbulksendRequestCompound.parse_obj({ - "pki_ezsignbulksend_id": obj.get("pkiEzsignbulksendID"), - "fki_ezsignfoldertype_id": obj.get("fkiEzsignfoldertypeID"), - "fki_language_id": obj.get("fkiLanguageID"), - "s_ezsignbulksend_description": obj.get("sEzsignbulksendDescription"), - "t_ezsignbulksend_note": obj.get("tEzsignbulksendNote"), - "b_ezsignbulksend_needvalidation": obj.get("bEzsignbulksendNeedvalidation"), - "b_ezsignbulksend_isactive": obj.get("bEzsignbulksendIsactive") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsignbulksendID": obj.get("pkiEzsignbulksendID"), + "fkiEzsignfoldertypeID": obj.get("fkiEzsignfoldertypeID"), + "fkiLanguageID": obj.get("fkiLanguageID"), + "sEzsignbulksendDescription": obj.get("sEzsignbulksendDescription"), + "tEzsignbulksendNote": obj.get("tEzsignbulksendNote"), + "bEzsignbulksendNeedvalidation": obj.get("bEzsignbulksendNeedvalidation"), + "bEzsignbulksendIsactive": obj.get("bEzsignbulksendIsactive") }) return _obj diff --git a/eZmaxApi/models/ezsignbulksend_response.py b/eZmaxApi/models/ezsignbulksend_response.py index b91f227da..8f9086739 100644 --- a/eZmaxApi/models/ezsignbulksend_response.py +++ b/eZmaxApi/models/ezsignbulksend_response.py @@ -19,78 +19,97 @@ import json - -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictBool, StrictStr +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.common_audit import CommonAudit from eZmaxApi.models.field_e_ezsignfoldertype_privacylevel import FieldEEzsignfoldertypePrivacylevel +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignbulksendResponse(BaseModel): """ - An Ezsignbulksend Object # noqa: E501 - """ - pki_ezsignbulksend_id: conint(strict=True, ge=0) = Field(..., alias="pkiEzsignbulksendID", description="The unique ID of the Ezsignbulksend") - fki_ezsignfoldertype_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsignfoldertypeID", description="The unique ID of the Ezsignfoldertype.") - fki_language_id: conint(strict=True, le=2, ge=1) = Field(..., alias="fkiLanguageID", description="The unique ID of the Language. Valid values: |Value|Description| |-|-| |1|French| |2|English|") - s_language_name_x: StrictStr = Field(..., alias="sLanguageNameX", description="The Name of the Language in the language of the requester") - e_ezsignfoldertype_privacylevel: FieldEEzsignfoldertypePrivacylevel = Field(..., alias="eEzsignfoldertypePrivacylevel") - s_ezsignfoldertype_name_x: StrictStr = Field(..., alias="sEzsignfoldertypeNameX", description="The name of the Ezsignfoldertype in the language of the requester") - s_ezsignbulksend_description: StrictStr = Field(..., alias="sEzsignbulksendDescription", description="The description of the Ezsignbulksend") - t_ezsignbulksend_note: StrictStr = Field(..., alias="tEzsignbulksendNote", description="Note about the Ezsignbulksend") - b_ezsignbulksend_needvalidation: StrictBool = Field(..., alias="bEzsignbulksendNeedvalidation", description="Whether the Ezsigntemplatepackage was automatically modified and needs a manual validation") - b_ezsignbulksend_isactive: StrictBool = Field(..., alias="bEzsignbulksendIsactive", description="Whether the Ezsignbulksend is active or not") - obj_audit: CommonAudit = Field(..., alias="objAudit") - __properties = ["pkiEzsignbulksendID", "fkiEzsignfoldertypeID", "fkiLanguageID", "sLanguageNameX", "eEzsignfoldertypePrivacylevel", "sEzsignfoldertypeNameX", "sEzsignbulksendDescription", "tEzsignbulksendNote", "bEzsignbulksendNeedvalidation", "bEzsignbulksendIsactive", "objAudit"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + An Ezsignbulksend Object + """ # noqa: E501 + pki_ezsignbulksend_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsignbulksend", alias="pkiEzsignbulksendID") + fki_ezsignfoldertype_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsignfoldertype.", alias="fkiEzsignfoldertypeID") + fki_language_id: Annotated[int, Field(le=2, strict=True, ge=1)] = Field(description="The unique ID of the Language. Valid values: |Value|Description| |-|-| |1|French| |2|English|", alias="fkiLanguageID") + s_language_name_x: StrictStr = Field(description="The Name of the Language in the language of the requester", alias="sLanguageNameX") + e_ezsignfoldertype_privacylevel: FieldEEzsignfoldertypePrivacylevel = Field(alias="eEzsignfoldertypePrivacylevel") + s_ezsignfoldertype_name_x: StrictStr = Field(description="The name of the Ezsignfoldertype in the language of the requester", alias="sEzsignfoldertypeNameX") + s_ezsignbulksend_description: StrictStr = Field(description="The description of the Ezsignbulksend", alias="sEzsignbulksendDescription") + t_ezsignbulksend_note: StrictStr = Field(description="Note about the Ezsignbulksend", alias="tEzsignbulksendNote") + b_ezsignbulksend_needvalidation: StrictBool = Field(description="Whether the Ezsigntemplatepackage was automatically modified and needs a manual validation", alias="bEzsignbulksendNeedvalidation") + b_ezsignbulksend_isactive: StrictBool = Field(description="Whether the Ezsignbulksend is active or not", alias="bEzsignbulksendIsactive") + obj_audit: CommonAudit = Field(alias="objAudit") + __properties: ClassVar[List[str]] = ["pkiEzsignbulksendID", "fkiEzsignfoldertypeID", "fkiLanguageID", "sLanguageNameX", "eEzsignfoldertypePrivacylevel", "sEzsignfoldertypeNameX", "sEzsignbulksendDescription", "tEzsignbulksendNote", "bEzsignbulksendNeedvalidation", "bEzsignbulksendIsactive", "objAudit"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignbulksendResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignbulksendResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_audit if self.obj_audit: _dict['objAudit'] = self.obj_audit.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignbulksendResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignbulksendResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignbulksendResponse.parse_obj(obj) - - _obj = EzsignbulksendResponse.parse_obj({ - "pki_ezsignbulksend_id": obj.get("pkiEzsignbulksendID"), - "fki_ezsignfoldertype_id": obj.get("fkiEzsignfoldertypeID"), - "fki_language_id": obj.get("fkiLanguageID"), - "s_language_name_x": obj.get("sLanguageNameX"), - "e_ezsignfoldertype_privacylevel": obj.get("eEzsignfoldertypePrivacylevel"), - "s_ezsignfoldertype_name_x": obj.get("sEzsignfoldertypeNameX"), - "s_ezsignbulksend_description": obj.get("sEzsignbulksendDescription"), - "t_ezsignbulksend_note": obj.get("tEzsignbulksendNote"), - "b_ezsignbulksend_needvalidation": obj.get("bEzsignbulksendNeedvalidation"), - "b_ezsignbulksend_isactive": obj.get("bEzsignbulksendIsactive"), - "obj_audit": CommonAudit.from_dict(obj.get("objAudit")) if obj.get("objAudit") is not None else None + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsignbulksendID": obj.get("pkiEzsignbulksendID"), + "fkiEzsignfoldertypeID": obj.get("fkiEzsignfoldertypeID"), + "fkiLanguageID": obj.get("fkiLanguageID"), + "sLanguageNameX": obj.get("sLanguageNameX"), + "eEzsignfoldertypePrivacylevel": obj.get("eEzsignfoldertypePrivacylevel"), + "sEzsignfoldertypeNameX": obj.get("sEzsignfoldertypeNameX"), + "sEzsignbulksendDescription": obj.get("sEzsignbulksendDescription"), + "tEzsignbulksendNote": obj.get("tEzsignbulksendNote"), + "bEzsignbulksendNeedvalidation": obj.get("bEzsignbulksendNeedvalidation"), + "bEzsignbulksendIsactive": obj.get("bEzsignbulksendIsactive"), + "objAudit": CommonAudit.from_dict(obj.get("objAudit")) if obj.get("objAudit") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignbulksend_response_compound.py b/eZmaxApi/models/ezsignbulksend_response_compound.py index a1c12f9f9..eab1cc331 100644 --- a/eZmaxApi/models/ezsignbulksend_response_compound.py +++ b/eZmaxApi/models/ezsignbulksend_response_compound.py @@ -19,56 +19,75 @@ import json -from typing import List -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictBool, StrictStr +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.common_audit import CommonAudit from eZmaxApi.models.ezsignbulksenddocumentmapping_response_compound import EzsignbulksenddocumentmappingResponseCompound from eZmaxApi.models.ezsignbulksendsignermapping_response import EzsignbulksendsignermappingResponse from eZmaxApi.models.field_e_ezsignfoldertype_privacylevel import FieldEEzsignfoldertypePrivacylevel +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignbulksendResponseCompound(BaseModel): """ - An Ezsignbulksend Object and children to create a complete structure # noqa: E501 - """ - pki_ezsignbulksend_id: conint(strict=True, ge=0) = Field(..., alias="pkiEzsignbulksendID", description="The unique ID of the Ezsignbulksend") - fki_ezsignfoldertype_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsignfoldertypeID", description="The unique ID of the Ezsignfoldertype.") - fki_language_id: conint(strict=True, le=2, ge=1) = Field(..., alias="fkiLanguageID", description="The unique ID of the Language. Valid values: |Value|Description| |-|-| |1|French| |2|English|") - s_language_name_x: StrictStr = Field(..., alias="sLanguageNameX", description="The Name of the Language in the language of the requester") - e_ezsignfoldertype_privacylevel: FieldEEzsignfoldertypePrivacylevel = Field(..., alias="eEzsignfoldertypePrivacylevel") - s_ezsignfoldertype_name_x: StrictStr = Field(..., alias="sEzsignfoldertypeNameX", description="The name of the Ezsignfoldertype in the language of the requester") - s_ezsignbulksend_description: StrictStr = Field(..., alias="sEzsignbulksendDescription", description="The description of the Ezsignbulksend") - t_ezsignbulksend_note: StrictStr = Field(..., alias="tEzsignbulksendNote", description="Note about the Ezsignbulksend") - b_ezsignbulksend_needvalidation: StrictBool = Field(..., alias="bEzsignbulksendNeedvalidation", description="Whether the Ezsigntemplatepackage was automatically modified and needs a manual validation") - b_ezsignbulksend_isactive: StrictBool = Field(..., alias="bEzsignbulksendIsactive", description="Whether the Ezsignbulksend is active or not") - obj_audit: CommonAudit = Field(..., alias="objAudit") - a_obj_ezsignbulksenddocumentmapping: conlist(EzsignbulksenddocumentmappingResponseCompound) = Field(..., alias="a_objEzsignbulksenddocumentmapping") - a_obj_ezsignbulksendsignermapping: conlist(EzsignbulksendsignermappingResponse) = Field(..., alias="a_objEzsignbulksendsignermapping") - __properties = ["pkiEzsignbulksendID", "fkiEzsignfoldertypeID", "fkiLanguageID", "sLanguageNameX", "eEzsignfoldertypePrivacylevel", "sEzsignfoldertypeNameX", "sEzsignbulksendDescription", "tEzsignbulksendNote", "bEzsignbulksendNeedvalidation", "bEzsignbulksendIsactive", "objAudit", "a_objEzsignbulksenddocumentmapping", "a_objEzsignbulksendsignermapping"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + An Ezsignbulksend Object and children to create a complete structure + """ # noqa: E501 + pki_ezsignbulksend_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsignbulksend", alias="pkiEzsignbulksendID") + fki_ezsignfoldertype_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsignfoldertype.", alias="fkiEzsignfoldertypeID") + fki_language_id: Annotated[int, Field(le=2, strict=True, ge=1)] = Field(description="The unique ID of the Language. Valid values: |Value|Description| |-|-| |1|French| |2|English|", alias="fkiLanguageID") + s_language_name_x: StrictStr = Field(description="The Name of the Language in the language of the requester", alias="sLanguageNameX") + e_ezsignfoldertype_privacylevel: FieldEEzsignfoldertypePrivacylevel = Field(alias="eEzsignfoldertypePrivacylevel") + s_ezsignfoldertype_name_x: StrictStr = Field(description="The name of the Ezsignfoldertype in the language of the requester", alias="sEzsignfoldertypeNameX") + s_ezsignbulksend_description: StrictStr = Field(description="The description of the Ezsignbulksend", alias="sEzsignbulksendDescription") + t_ezsignbulksend_note: StrictStr = Field(description="Note about the Ezsignbulksend", alias="tEzsignbulksendNote") + b_ezsignbulksend_needvalidation: StrictBool = Field(description="Whether the Ezsigntemplatepackage was automatically modified and needs a manual validation", alias="bEzsignbulksendNeedvalidation") + b_ezsignbulksend_isactive: StrictBool = Field(description="Whether the Ezsignbulksend is active or not", alias="bEzsignbulksendIsactive") + obj_audit: CommonAudit = Field(alias="objAudit") + a_obj_ezsignbulksenddocumentmapping: List[EzsignbulksenddocumentmappingResponseCompound] = Field(alias="a_objEzsignbulksenddocumentmapping") + a_obj_ezsignbulksendsignermapping: List[EzsignbulksendsignermappingResponse] = Field(alias="a_objEzsignbulksendsignermapping") + __properties: ClassVar[List[str]] = ["pkiEzsignbulksendID", "fkiEzsignfoldertypeID", "fkiLanguageID", "sLanguageNameX", "eEzsignfoldertypePrivacylevel", "sEzsignfoldertypeNameX", "sEzsignbulksendDescription", "tEzsignbulksendNote", "bEzsignbulksendNeedvalidation", "bEzsignbulksendIsactive", "objAudit", "a_objEzsignbulksenddocumentmapping", "a_objEzsignbulksendsignermapping"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignbulksendResponseCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignbulksendResponseCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_audit if self.obj_audit: _dict['objAudit'] = self.obj_audit.to_dict() @@ -89,28 +108,28 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignbulksendResponseCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignbulksendResponseCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignbulksendResponseCompound.parse_obj(obj) - - _obj = EzsignbulksendResponseCompound.parse_obj({ - "pki_ezsignbulksend_id": obj.get("pkiEzsignbulksendID"), - "fki_ezsignfoldertype_id": obj.get("fkiEzsignfoldertypeID"), - "fki_language_id": obj.get("fkiLanguageID"), - "s_language_name_x": obj.get("sLanguageNameX"), - "e_ezsignfoldertype_privacylevel": obj.get("eEzsignfoldertypePrivacylevel"), - "s_ezsignfoldertype_name_x": obj.get("sEzsignfoldertypeNameX"), - "s_ezsignbulksend_description": obj.get("sEzsignbulksendDescription"), - "t_ezsignbulksend_note": obj.get("tEzsignbulksendNote"), - "b_ezsignbulksend_needvalidation": obj.get("bEzsignbulksendNeedvalidation"), - "b_ezsignbulksend_isactive": obj.get("bEzsignbulksendIsactive"), - "obj_audit": CommonAudit.from_dict(obj.get("objAudit")) if obj.get("objAudit") is not None else None, - "a_obj_ezsignbulksenddocumentmapping": [EzsignbulksenddocumentmappingResponseCompound.from_dict(_item) for _item in obj.get("a_objEzsignbulksenddocumentmapping")] if obj.get("a_objEzsignbulksenddocumentmapping") is not None else None, - "a_obj_ezsignbulksendsignermapping": [EzsignbulksendsignermappingResponse.from_dict(_item) for _item in obj.get("a_objEzsignbulksendsignermapping")] if obj.get("a_objEzsignbulksendsignermapping") is not None else None + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsignbulksendID": obj.get("pkiEzsignbulksendID"), + "fkiEzsignfoldertypeID": obj.get("fkiEzsignfoldertypeID"), + "fkiLanguageID": obj.get("fkiLanguageID"), + "sLanguageNameX": obj.get("sLanguageNameX"), + "eEzsignfoldertypePrivacylevel": obj.get("eEzsignfoldertypePrivacylevel"), + "sEzsignfoldertypeNameX": obj.get("sEzsignfoldertypeNameX"), + "sEzsignbulksendDescription": obj.get("sEzsignbulksendDescription"), + "tEzsignbulksendNote": obj.get("tEzsignbulksendNote"), + "bEzsignbulksendNeedvalidation": obj.get("bEzsignbulksendNeedvalidation"), + "bEzsignbulksendIsactive": obj.get("bEzsignbulksendIsactive"), + "objAudit": CommonAudit.from_dict(obj.get("objAudit")) if obj.get("objAudit") is not None else None, + "a_objEzsignbulksenddocumentmapping": [EzsignbulksenddocumentmappingResponseCompound.from_dict(_item) for _item in obj.get("a_objEzsignbulksenddocumentmapping")] if obj.get("a_objEzsignbulksenddocumentmapping") is not None else None, + "a_objEzsignbulksendsignermapping": [EzsignbulksendsignermappingResponse.from_dict(_item) for _item in obj.get("a_objEzsignbulksendsignermapping")] if obj.get("a_objEzsignbulksendsignermapping") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignbulksenddocumentmapping_create_object_v1_request.py b/eZmaxApi/models/ezsignbulksenddocumentmapping_create_object_v1_request.py index 1d7b2ef16..fb92c52e2 100644 --- a/eZmaxApi/models/ezsignbulksenddocumentmapping_create_object_v1_request.py +++ b/eZmaxApi/models/ezsignbulksenddocumentmapping_create_object_v1_request.py @@ -19,41 +19,60 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.ezsignbulksenddocumentmapping_request_compound import EzsignbulksenddocumentmappingRequestCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignbulksenddocumentmappingCreateObjectV1Request(BaseModel): """ - Request for POST /1/object/ezsignbulksenddocumentmapping # noqa: E501 - """ - a_obj_ezsignbulksenddocumentmapping: conlist(EzsignbulksenddocumentmappingRequestCompound, min_items=1) = Field(..., alias="a_objEzsignbulksenddocumentmapping") - __properties = ["a_objEzsignbulksenddocumentmapping"] + Request for POST /1/object/ezsignbulksenddocumentmapping + """ # noqa: E501 + a_obj_ezsignbulksenddocumentmapping: Annotated[List[EzsignbulksenddocumentmappingRequestCompound], Field(min_length=1)] = Field(alias="a_objEzsignbulksenddocumentmapping") + __properties: ClassVar[List[str]] = ["a_objEzsignbulksenddocumentmapping"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignbulksenddocumentmappingCreateObjectV1Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignbulksenddocumentmappingCreateObjectV1Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_ezsignbulksenddocumentmapping (list) _items = [] if self.a_obj_ezsignbulksenddocumentmapping: @@ -64,16 +83,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignbulksenddocumentmappingCreateObjectV1Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignbulksenddocumentmappingCreateObjectV1Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignbulksenddocumentmappingCreateObjectV1Request.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignbulksenddocumentmappingCreateObjectV1Request.parse_obj({ - "a_obj_ezsignbulksenddocumentmapping": [EzsignbulksenddocumentmappingRequestCompound.from_dict(_item) for _item in obj.get("a_objEzsignbulksenddocumentmapping")] if obj.get("a_objEzsignbulksenddocumentmapping") is not None else None + _obj = cls.model_validate({ + "a_objEzsignbulksenddocumentmapping": [EzsignbulksenddocumentmappingRequestCompound.from_dict(_item) for _item in obj.get("a_objEzsignbulksenddocumentmapping")] if obj.get("a_objEzsignbulksenddocumentmapping") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignbulksenddocumentmapping_create_object_v1_response.py b/eZmaxApi/models/ezsignbulksenddocumentmapping_create_object_v1_response.py index b828d9720..e436e5564 100644 --- a/eZmaxApi/models/ezsignbulksenddocumentmapping_create_object_v1_response.py +++ b/eZmaxApi/models/ezsignbulksenddocumentmapping_create_object_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.ezsignbulksenddocumentmapping_create_object_v1_response_m_payload import EzsignbulksenddocumentmappingCreateObjectV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignbulksenddocumentmappingCreateObjectV1Response(BaseModel): """ - Response for POST /1/object/ezsignbulksenddocumentmapping # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzsignbulksenddocumentmappingCreateObjectV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for POST /1/object/ezsignbulksenddocumentmapping + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsignbulksenddocumentmappingCreateObjectV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignbulksenddocumentmappingCreateObjectV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignbulksenddocumentmappingCreateObjectV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignbulksenddocumentmappingCreateObjectV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignbulksenddocumentmappingCreateObjectV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignbulksenddocumentmappingCreateObjectV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignbulksenddocumentmappingCreateObjectV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzsignbulksenddocumentmappingCreateObjectV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsignbulksenddocumentmappingCreateObjectV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignbulksenddocumentmapping_create_object_v1_response_m_payload.py b/eZmaxApi/models/ezsignbulksenddocumentmapping_create_object_v1_response_m_payload.py index a7f011683..ff9155397 100644 --- a/eZmaxApi/models/ezsignbulksenddocumentmapping_create_object_v1_response_m_payload.py +++ b/eZmaxApi/models/ezsignbulksenddocumentmapping_create_object_v1_response_m_payload.py @@ -19,53 +19,72 @@ import json -from typing import List -from pydantic import BaseModel, Field, conint, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignbulksenddocumentmappingCreateObjectV1ResponseMPayload(BaseModel): """ - Payload for POST /1/object/ezsignbulksenddocumentmapping # noqa: E501 - """ - a_pki_ezsignbulksenddocumentmapping_id: conlist(conint(strict=True, ge=0), min_items=1) = Field(..., alias="a_pkiEzsignbulksenddocumentmappingID", description="An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request.") - __properties = ["a_pkiEzsignbulksenddocumentmappingID"] + Payload for POST /1/object/ezsignbulksenddocumentmapping + """ # noqa: E501 + a_pki_ezsignbulksenddocumentmapping_id: Annotated[List[Annotated[int, Field(strict=True, ge=0)]], Field(min_length=1)] = Field(description="An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request.", alias="a_pkiEzsignbulksenddocumentmappingID") + __properties: ClassVar[List[str]] = ["a_pkiEzsignbulksenddocumentmappingID"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignbulksenddocumentmappingCreateObjectV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignbulksenddocumentmappingCreateObjectV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignbulksenddocumentmappingCreateObjectV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignbulksenddocumentmappingCreateObjectV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignbulksenddocumentmappingCreateObjectV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignbulksenddocumentmappingCreateObjectV1ResponseMPayload.parse_obj({ - "a_pki_ezsignbulksenddocumentmapping_id": obj.get("a_pkiEzsignbulksenddocumentmappingID") + _obj = cls.model_validate({ + "a_pkiEzsignbulksenddocumentmappingID": obj.get("a_pkiEzsignbulksenddocumentmappingID") }) return _obj diff --git a/eZmaxApi/models/ezsignbulksenddocumentmapping_delete_object_v1_response.py b/eZmaxApi/models/ezsignbulksenddocumentmapping_delete_object_v1_response.py index 30da284b2..a9e4b3cd8 100644 --- a/eZmaxApi/models/ezsignbulksenddocumentmapping_delete_object_v1_response.py +++ b/eZmaxApi/models/ezsignbulksenddocumentmapping_delete_object_v1_response.py @@ -19,43 +19,61 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignbulksenddocumentmappingDeleteObjectV1Response(BaseModel): """ - Response for DELETE /1/object/ezsignbulksenddocumentmapping/{pkiEzsignbulksenddocumentmappingID} # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - __properties = ["objDebugPayload", "objDebug"] + Response for DELETE /1/object/ezsignbulksenddocumentmapping/{pkiEzsignbulksenddocumentmappingID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignbulksenddocumentmappingDeleteObjectV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignbulksenddocumentmappingDeleteObjectV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -65,17 +83,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignbulksenddocumentmappingDeleteObjectV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignbulksenddocumentmappingDeleteObjectV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignbulksenddocumentmappingDeleteObjectV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignbulksenddocumentmappingDeleteObjectV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignbulksenddocumentmapping_get_object_v2_response.py b/eZmaxApi/models/ezsignbulksenddocumentmapping_get_object_v2_response.py index a7495fe8f..6146513e3 100644 --- a/eZmaxApi/models/ezsignbulksenddocumentmapping_get_object_v2_response.py +++ b/eZmaxApi/models/ezsignbulksenddocumentmapping_get_object_v2_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.ezsignbulksenddocumentmapping_get_object_v2_response_m_payload import EzsignbulksenddocumentmappingGetObjectV2ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignbulksenddocumentmappingGetObjectV2Response(BaseModel): """ - Response for GET /2/object/ezsignbulksenddocumentmapping/{pkiEzsignbulksenddocumentmappingID} # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzsignbulksenddocumentmappingGetObjectV2ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /2/object/ezsignbulksenddocumentmapping/{pkiEzsignbulksenddocumentmappingID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsignbulksenddocumentmappingGetObjectV2ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignbulksenddocumentmappingGetObjectV2Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignbulksenddocumentmappingGetObjectV2Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignbulksenddocumentmappingGetObjectV2Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignbulksenddocumentmappingGetObjectV2Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignbulksenddocumentmappingGetObjectV2Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignbulksenddocumentmappingGetObjectV2Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzsignbulksenddocumentmappingGetObjectV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsignbulksenddocumentmappingGetObjectV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignbulksenddocumentmapping_get_object_v2_response_m_payload.py b/eZmaxApi/models/ezsignbulksenddocumentmapping_get_object_v2_response_m_payload.py index d6db6bc53..36a9e242c 100644 --- a/eZmaxApi/models/ezsignbulksenddocumentmapping_get_object_v2_response_m_payload.py +++ b/eZmaxApi/models/ezsignbulksenddocumentmapping_get_object_v2_response_m_payload.py @@ -19,57 +19,75 @@ import json - -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.ezsignbulksenddocumentmapping_response_compound import EzsignbulksenddocumentmappingResponseCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignbulksenddocumentmappingGetObjectV2ResponseMPayload(BaseModel): """ - Payload for GET /2/object/ezsignbulksenddocumentmapping/{pkiEzsignbulksenddocumentmappingID} # noqa: E501 - """ - obj_ezsignbulksenddocumentmapping: EzsignbulksenddocumentmappingResponseCompound = Field(..., alias="objEzsignbulksenddocumentmapping") - __properties = ["objEzsignbulksenddocumentmapping"] + Payload for GET /2/object/ezsignbulksenddocumentmapping/{pkiEzsignbulksenddocumentmappingID} + """ # noqa: E501 + obj_ezsignbulksenddocumentmapping: EzsignbulksenddocumentmappingResponseCompound = Field(alias="objEzsignbulksenddocumentmapping") + __properties: ClassVar[List[str]] = ["objEzsignbulksenddocumentmapping"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignbulksenddocumentmappingGetObjectV2ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignbulksenddocumentmappingGetObjectV2ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_ezsignbulksenddocumentmapping if self.obj_ezsignbulksenddocumentmapping: _dict['objEzsignbulksenddocumentmapping'] = self.obj_ezsignbulksenddocumentmapping.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignbulksenddocumentmappingGetObjectV2ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignbulksenddocumentmappingGetObjectV2ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignbulksenddocumentmappingGetObjectV2ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignbulksenddocumentmappingGetObjectV2ResponseMPayload.parse_obj({ - "obj_ezsignbulksenddocumentmapping": EzsignbulksenddocumentmappingResponseCompound.from_dict(obj.get("objEzsignbulksenddocumentmapping")) if obj.get("objEzsignbulksenddocumentmapping") is not None else None + _obj = cls.model_validate({ + "objEzsignbulksenddocumentmapping": EzsignbulksenddocumentmappingResponseCompound.from_dict(obj.get("objEzsignbulksenddocumentmapping")) if obj.get("objEzsignbulksenddocumentmapping") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignbulksenddocumentmapping_request.py b/eZmaxApi/models/ezsignbulksenddocumentmapping_request.py index da6565adb..9fdc345d8 100644 --- a/eZmaxApi/models/ezsignbulksenddocumentmapping_request.py +++ b/eZmaxApi/models/ezsignbulksenddocumentmapping_request.py @@ -19,59 +19,78 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignbulksenddocumentmappingRequest(BaseModel): """ - A Ezsignbulksenddocumentmapping Object # noqa: E501 - """ - pki_ezsignbulksenddocumentmapping_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="pkiEzsignbulksenddocumentmappingID", description="The unique ID of the Ezsignbulksenddocumentmapping.") - fki_ezsignbulksend_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsignbulksendID", description="The unique ID of the Ezsignbulksend") - fki_ezsigntemplatepackage_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiEzsigntemplatepackageID", description="The unique ID of the Ezsigntemplatepackage") - fki_ezsigntemplate_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiEzsigntemplateID", description="The unique ID of the Ezsigntemplate") - __properties = ["pkiEzsignbulksenddocumentmappingID", "fkiEzsignbulksendID", "fkiEzsigntemplatepackageID", "fkiEzsigntemplateID"] + A Ezsignbulksenddocumentmapping Object + """ # noqa: E501 + pki_ezsignbulksenddocumentmapping_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsignbulksenddocumentmapping.", alias="pkiEzsignbulksenddocumentmappingID") + fki_ezsignbulksend_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsignbulksend", alias="fkiEzsignbulksendID") + fki_ezsigntemplatepackage_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsigntemplatepackage", alias="fkiEzsigntemplatepackageID") + fki_ezsigntemplate_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsigntemplate", alias="fkiEzsigntemplateID") + __properties: ClassVar[List[str]] = ["pkiEzsignbulksenddocumentmappingID", "fkiEzsignbulksendID", "fkiEzsigntemplatepackageID", "fkiEzsigntemplateID"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignbulksenddocumentmappingRequest: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignbulksenddocumentmappingRequest from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignbulksenddocumentmappingRequest: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignbulksenddocumentmappingRequest from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignbulksenddocumentmappingRequest.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignbulksenddocumentmappingRequest.parse_obj({ - "pki_ezsignbulksenddocumentmapping_id": obj.get("pkiEzsignbulksenddocumentmappingID"), - "fki_ezsignbulksend_id": obj.get("fkiEzsignbulksendID"), - "fki_ezsigntemplatepackage_id": obj.get("fkiEzsigntemplatepackageID"), - "fki_ezsigntemplate_id": obj.get("fkiEzsigntemplateID") + _obj = cls.model_validate({ + "pkiEzsignbulksenddocumentmappingID": obj.get("pkiEzsignbulksenddocumentmappingID"), + "fkiEzsignbulksendID": obj.get("fkiEzsignbulksendID"), + "fkiEzsigntemplatepackageID": obj.get("fkiEzsigntemplatepackageID"), + "fkiEzsigntemplateID": obj.get("fkiEzsigntemplateID") }) return _obj diff --git a/eZmaxApi/models/ezsignbulksenddocumentmapping_request_compound.py b/eZmaxApi/models/ezsignbulksenddocumentmapping_request_compound.py index 724954839..c45eef1f2 100644 --- a/eZmaxApi/models/ezsignbulksenddocumentmapping_request_compound.py +++ b/eZmaxApi/models/ezsignbulksenddocumentmapping_request_compound.py @@ -19,59 +19,78 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignbulksenddocumentmappingRequestCompound(BaseModel): """ - A Ezsignbulksenddocumentmapping Object and children # noqa: E501 - """ - pki_ezsignbulksenddocumentmapping_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="pkiEzsignbulksenddocumentmappingID", description="The unique ID of the Ezsignbulksenddocumentmapping.") - fki_ezsignbulksend_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsignbulksendID", description="The unique ID of the Ezsignbulksend") - fki_ezsigntemplatepackage_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiEzsigntemplatepackageID", description="The unique ID of the Ezsigntemplatepackage") - fki_ezsigntemplate_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiEzsigntemplateID", description="The unique ID of the Ezsigntemplate") - __properties = ["pkiEzsignbulksenddocumentmappingID", "fkiEzsignbulksendID", "fkiEzsigntemplatepackageID", "fkiEzsigntemplateID"] + A Ezsignbulksenddocumentmapping Object and children + """ # noqa: E501 + pki_ezsignbulksenddocumentmapping_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsignbulksenddocumentmapping.", alias="pkiEzsignbulksenddocumentmappingID") + fki_ezsignbulksend_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsignbulksend", alias="fkiEzsignbulksendID") + fki_ezsigntemplatepackage_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsigntemplatepackage", alias="fkiEzsigntemplatepackageID") + fki_ezsigntemplate_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsigntemplate", alias="fkiEzsigntemplateID") + __properties: ClassVar[List[str]] = ["pkiEzsignbulksenddocumentmappingID", "fkiEzsignbulksendID", "fkiEzsigntemplatepackageID", "fkiEzsigntemplateID"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignbulksenddocumentmappingRequestCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignbulksenddocumentmappingRequestCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignbulksenddocumentmappingRequestCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignbulksenddocumentmappingRequestCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignbulksenddocumentmappingRequestCompound.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignbulksenddocumentmappingRequestCompound.parse_obj({ - "pki_ezsignbulksenddocumentmapping_id": obj.get("pkiEzsignbulksenddocumentmappingID"), - "fki_ezsignbulksend_id": obj.get("fkiEzsignbulksendID"), - "fki_ezsigntemplatepackage_id": obj.get("fkiEzsigntemplatepackageID"), - "fki_ezsigntemplate_id": obj.get("fkiEzsigntemplateID") + _obj = cls.model_validate({ + "pkiEzsignbulksenddocumentmappingID": obj.get("pkiEzsignbulksenddocumentmappingID"), + "fkiEzsignbulksendID": obj.get("fkiEzsignbulksendID"), + "fkiEzsigntemplatepackageID": obj.get("fkiEzsigntemplatepackageID"), + "fkiEzsigntemplateID": obj.get("fkiEzsigntemplateID") }) return _obj diff --git a/eZmaxApi/models/ezsignbulksenddocumentmapping_response.py b/eZmaxApi/models/ezsignbulksenddocumentmapping_response.py index 7ea9323f7..f1f8b202d 100644 --- a/eZmaxApi/models/ezsignbulksenddocumentmapping_response.py +++ b/eZmaxApi/models/ezsignbulksenddocumentmapping_response.py @@ -19,61 +19,80 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignbulksenddocumentmappingResponse(BaseModel): """ - A Ezsignbulksenddocumentmapping Object # noqa: E501 - """ - pki_ezsignbulksenddocumentmapping_id: conint(strict=True, ge=0) = Field(..., alias="pkiEzsignbulksenddocumentmappingID", description="The unique ID of the Ezsignbulksenddocumentmapping.") - fki_ezsignbulksend_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsignbulksendID", description="The unique ID of the Ezsignbulksend") - fki_ezsigntemplatepackage_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiEzsigntemplatepackageID", description="The unique ID of the Ezsigntemplatepackage") - fki_ezsigntemplate_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiEzsigntemplateID", description="The unique ID of the Ezsigntemplate") - i_ezsignbulksenddocumentmapping_order: conint(strict=True, ge=0) = Field(..., alias="iEzsignbulksenddocumentmappingOrder", description="The order in which the Ezsigntemplate or Ezsigntemplatepackage will be presented to the signatory in the Ezsignfolder.") - __properties = ["pkiEzsignbulksenddocumentmappingID", "fkiEzsignbulksendID", "fkiEzsigntemplatepackageID", "fkiEzsigntemplateID", "iEzsignbulksenddocumentmappingOrder"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + A Ezsignbulksenddocumentmapping Object + """ # noqa: E501 + pki_ezsignbulksenddocumentmapping_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsignbulksenddocumentmapping.", alias="pkiEzsignbulksenddocumentmappingID") + fki_ezsignbulksend_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsignbulksend", alias="fkiEzsignbulksendID") + fki_ezsigntemplatepackage_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsigntemplatepackage", alias="fkiEzsigntemplatepackageID") + fki_ezsigntemplate_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsigntemplate", alias="fkiEzsigntemplateID") + i_ezsignbulksenddocumentmapping_order: Annotated[int, Field(strict=True, ge=0)] = Field(description="The order in which the Ezsigntemplate or Ezsigntemplatepackage will be presented to the signatory in the Ezsignfolder.", alias="iEzsignbulksenddocumentmappingOrder") + __properties: ClassVar[List[str]] = ["pkiEzsignbulksenddocumentmappingID", "fkiEzsignbulksendID", "fkiEzsigntemplatepackageID", "fkiEzsigntemplateID", "iEzsignbulksenddocumentmappingOrder"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignbulksenddocumentmappingResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignbulksenddocumentmappingResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignbulksenddocumentmappingResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignbulksenddocumentmappingResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignbulksenddocumentmappingResponse.parse_obj(obj) - - _obj = EzsignbulksenddocumentmappingResponse.parse_obj({ - "pki_ezsignbulksenddocumentmapping_id": obj.get("pkiEzsignbulksenddocumentmappingID"), - "fki_ezsignbulksend_id": obj.get("fkiEzsignbulksendID"), - "fki_ezsigntemplatepackage_id": obj.get("fkiEzsigntemplatepackageID"), - "fki_ezsigntemplate_id": obj.get("fkiEzsigntemplateID"), - "i_ezsignbulksenddocumentmapping_order": obj.get("iEzsignbulksenddocumentmappingOrder") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsignbulksenddocumentmappingID": obj.get("pkiEzsignbulksenddocumentmappingID"), + "fkiEzsignbulksendID": obj.get("fkiEzsignbulksendID"), + "fkiEzsigntemplatepackageID": obj.get("fkiEzsigntemplatepackageID"), + "fkiEzsigntemplateID": obj.get("fkiEzsigntemplateID"), + "iEzsignbulksenddocumentmappingOrder": obj.get("iEzsignbulksenddocumentmappingOrder") }) return _obj diff --git a/eZmaxApi/models/ezsignbulksenddocumentmapping_response_compound.py b/eZmaxApi/models/ezsignbulksenddocumentmapping_response_compound.py index 5ef5a4f3d..8181eb30e 100644 --- a/eZmaxApi/models/ezsignbulksenddocumentmapping_response_compound.py +++ b/eZmaxApi/models/ezsignbulksenddocumentmapping_response_compound.py @@ -19,48 +19,67 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.ezsigntemplate_response_compound import EzsigntemplateResponseCompound from eZmaxApi.models.ezsigntemplatepackage_response_compound import EzsigntemplatepackageResponseCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignbulksenddocumentmappingResponseCompound(BaseModel): """ - A Ezsignbulksenddocumentmapping Object # noqa: E501 - """ - pki_ezsignbulksenddocumentmapping_id: conint(strict=True, ge=0) = Field(..., alias="pkiEzsignbulksenddocumentmappingID", description="The unique ID of the Ezsignbulksenddocumentmapping.") - fki_ezsignbulksend_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsignbulksendID", description="The unique ID of the Ezsignbulksend") - fki_ezsigntemplatepackage_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiEzsigntemplatepackageID", description="The unique ID of the Ezsigntemplatepackage") - fki_ezsigntemplate_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiEzsigntemplateID", description="The unique ID of the Ezsigntemplate") - i_ezsignbulksenddocumentmapping_order: conint(strict=True, ge=0) = Field(..., alias="iEzsignbulksenddocumentmappingOrder", description="The order in which the Ezsigntemplate or Ezsigntemplatepackage will be presented to the signatory in the Ezsignfolder.") - obj_ezsigntemplate: Optional[EzsigntemplateResponseCompound] = Field(None, alias="objEzsigntemplate") - obj_ezsigntemplatepackage: Optional[EzsigntemplatepackageResponseCompound] = Field(None, alias="objEzsigntemplatepackage") - __properties = ["pkiEzsignbulksenddocumentmappingID", "fkiEzsignbulksendID", "fkiEzsigntemplatepackageID", "fkiEzsigntemplateID", "iEzsignbulksenddocumentmappingOrder", "objEzsigntemplate", "objEzsigntemplatepackage"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + A Ezsignbulksenddocumentmapping Object + """ # noqa: E501 + pki_ezsignbulksenddocumentmapping_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsignbulksenddocumentmapping.", alias="pkiEzsignbulksenddocumentmappingID") + fki_ezsignbulksend_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsignbulksend", alias="fkiEzsignbulksendID") + fki_ezsigntemplatepackage_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsigntemplatepackage", alias="fkiEzsigntemplatepackageID") + fki_ezsigntemplate_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsigntemplate", alias="fkiEzsigntemplateID") + i_ezsignbulksenddocumentmapping_order: Annotated[int, Field(strict=True, ge=0)] = Field(description="The order in which the Ezsigntemplate or Ezsigntemplatepackage will be presented to the signatory in the Ezsignfolder.", alias="iEzsignbulksenddocumentmappingOrder") + obj_ezsigntemplate: Optional[EzsigntemplateResponseCompound] = Field(default=None, alias="objEzsigntemplate") + obj_ezsigntemplatepackage: Optional[EzsigntemplatepackageResponseCompound] = Field(default=None, alias="objEzsigntemplatepackage") + __properties: ClassVar[List[str]] = ["pkiEzsignbulksenddocumentmappingID", "fkiEzsignbulksendID", "fkiEzsigntemplatepackageID", "fkiEzsigntemplateID", "iEzsignbulksenddocumentmappingOrder", "objEzsigntemplate", "objEzsigntemplatepackage"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignbulksenddocumentmappingResponseCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignbulksenddocumentmappingResponseCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_ezsigntemplate if self.obj_ezsigntemplate: _dict['objEzsigntemplate'] = self.obj_ezsigntemplate.to_dict() @@ -70,22 +89,22 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignbulksenddocumentmappingResponseCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignbulksenddocumentmappingResponseCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignbulksenddocumentmappingResponseCompound.parse_obj(obj) - - _obj = EzsignbulksenddocumentmappingResponseCompound.parse_obj({ - "pki_ezsignbulksenddocumentmapping_id": obj.get("pkiEzsignbulksenddocumentmappingID"), - "fki_ezsignbulksend_id": obj.get("fkiEzsignbulksendID"), - "fki_ezsigntemplatepackage_id": obj.get("fkiEzsigntemplatepackageID"), - "fki_ezsigntemplate_id": obj.get("fkiEzsigntemplateID"), - "i_ezsignbulksenddocumentmapping_order": obj.get("iEzsignbulksenddocumentmappingOrder"), - "obj_ezsigntemplate": EzsigntemplateResponseCompound.from_dict(obj.get("objEzsigntemplate")) if obj.get("objEzsigntemplate") is not None else None, - "obj_ezsigntemplatepackage": EzsigntemplatepackageResponseCompound.from_dict(obj.get("objEzsigntemplatepackage")) if obj.get("objEzsigntemplatepackage") is not None else None + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsignbulksenddocumentmappingID": obj.get("pkiEzsignbulksenddocumentmappingID"), + "fkiEzsignbulksendID": obj.get("fkiEzsignbulksendID"), + "fkiEzsigntemplatepackageID": obj.get("fkiEzsigntemplatepackageID"), + "fkiEzsigntemplateID": obj.get("fkiEzsigntemplateID"), + "iEzsignbulksenddocumentmappingOrder": obj.get("iEzsignbulksenddocumentmappingOrder"), + "objEzsigntemplate": EzsigntemplateResponseCompound.from_dict(obj.get("objEzsigntemplate")) if obj.get("objEzsigntemplate") is not None else None, + "objEzsigntemplatepackage": EzsigntemplatepackageResponseCompound.from_dict(obj.get("objEzsigntemplatepackage")) if obj.get("objEzsigntemplatepackage") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignbulksendsignermapping_create_object_v1_request.py b/eZmaxApi/models/ezsignbulksendsignermapping_create_object_v1_request.py index 0d277fd7a..fa433d5c6 100644 --- a/eZmaxApi/models/ezsignbulksendsignermapping_create_object_v1_request.py +++ b/eZmaxApi/models/ezsignbulksendsignermapping_create_object_v1_request.py @@ -19,41 +19,60 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.ezsignbulksendsignermapping_request_compound import EzsignbulksendsignermappingRequestCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignbulksendsignermappingCreateObjectV1Request(BaseModel): """ - Request for POST /1/object/ezsignbulksendsignermapping # noqa: E501 - """ - a_obj_ezsignbulksendsignermapping: conlist(EzsignbulksendsignermappingRequestCompound, min_items=1) = Field(..., alias="a_objEzsignbulksendsignermapping") - __properties = ["a_objEzsignbulksendsignermapping"] + Request for POST /1/object/ezsignbulksendsignermapping + """ # noqa: E501 + a_obj_ezsignbulksendsignermapping: Annotated[List[EzsignbulksendsignermappingRequestCompound], Field(min_length=1)] = Field(alias="a_objEzsignbulksendsignermapping") + __properties: ClassVar[List[str]] = ["a_objEzsignbulksendsignermapping"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignbulksendsignermappingCreateObjectV1Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignbulksendsignermappingCreateObjectV1Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_ezsignbulksendsignermapping (list) _items = [] if self.a_obj_ezsignbulksendsignermapping: @@ -64,16 +83,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignbulksendsignermappingCreateObjectV1Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignbulksendsignermappingCreateObjectV1Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignbulksendsignermappingCreateObjectV1Request.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignbulksendsignermappingCreateObjectV1Request.parse_obj({ - "a_obj_ezsignbulksendsignermapping": [EzsignbulksendsignermappingRequestCompound.from_dict(_item) for _item in obj.get("a_objEzsignbulksendsignermapping")] if obj.get("a_objEzsignbulksendsignermapping") is not None else None + _obj = cls.model_validate({ + "a_objEzsignbulksendsignermapping": [EzsignbulksendsignermappingRequestCompound.from_dict(_item) for _item in obj.get("a_objEzsignbulksendsignermapping")] if obj.get("a_objEzsignbulksendsignermapping") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignbulksendsignermapping_create_object_v1_response.py b/eZmaxApi/models/ezsignbulksendsignermapping_create_object_v1_response.py index 18cd97322..f3fe0a086 100644 --- a/eZmaxApi/models/ezsignbulksendsignermapping_create_object_v1_response.py +++ b/eZmaxApi/models/ezsignbulksendsignermapping_create_object_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.ezsignbulksendsignermapping_create_object_v1_response_m_payload import EzsignbulksendsignermappingCreateObjectV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignbulksendsignermappingCreateObjectV1Response(BaseModel): """ - Response for POST /1/object/ezsignbulksendsignermapping # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzsignbulksendsignermappingCreateObjectV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for POST /1/object/ezsignbulksendsignermapping + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsignbulksendsignermappingCreateObjectV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignbulksendsignermappingCreateObjectV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignbulksendsignermappingCreateObjectV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignbulksendsignermappingCreateObjectV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignbulksendsignermappingCreateObjectV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignbulksendsignermappingCreateObjectV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignbulksendsignermappingCreateObjectV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzsignbulksendsignermappingCreateObjectV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsignbulksendsignermappingCreateObjectV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignbulksendsignermapping_create_object_v1_response_m_payload.py b/eZmaxApi/models/ezsignbulksendsignermapping_create_object_v1_response_m_payload.py index 211a6514a..90d9a2c33 100644 --- a/eZmaxApi/models/ezsignbulksendsignermapping_create_object_v1_response_m_payload.py +++ b/eZmaxApi/models/ezsignbulksendsignermapping_create_object_v1_response_m_payload.py @@ -19,53 +19,72 @@ import json -from typing import List -from pydantic import BaseModel, Field, conint, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignbulksendsignermappingCreateObjectV1ResponseMPayload(BaseModel): """ - Payload for POST /1/object/ezsignbulksendsignermapping # noqa: E501 - """ - a_pki_ezsignbulksendsignermapping_id: conlist(conint(strict=True, ge=0), min_items=1) = Field(..., alias="a_pkiEzsignbulksendsignermappingID", description="An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request.") - __properties = ["a_pkiEzsignbulksendsignermappingID"] + Payload for POST /1/object/ezsignbulksendsignermapping + """ # noqa: E501 + a_pki_ezsignbulksendsignermapping_id: Annotated[List[Annotated[int, Field(strict=True, ge=0)]], Field(min_length=1)] = Field(description="An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request.", alias="a_pkiEzsignbulksendsignermappingID") + __properties: ClassVar[List[str]] = ["a_pkiEzsignbulksendsignermappingID"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignbulksendsignermappingCreateObjectV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignbulksendsignermappingCreateObjectV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignbulksendsignermappingCreateObjectV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignbulksendsignermappingCreateObjectV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignbulksendsignermappingCreateObjectV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignbulksendsignermappingCreateObjectV1ResponseMPayload.parse_obj({ - "a_pki_ezsignbulksendsignermapping_id": obj.get("a_pkiEzsignbulksendsignermappingID") + _obj = cls.model_validate({ + "a_pkiEzsignbulksendsignermappingID": obj.get("a_pkiEzsignbulksendsignermappingID") }) return _obj diff --git a/eZmaxApi/models/ezsignbulksendsignermapping_delete_object_v1_response.py b/eZmaxApi/models/ezsignbulksendsignermapping_delete_object_v1_response.py index f259a179c..3a8a056ef 100644 --- a/eZmaxApi/models/ezsignbulksendsignermapping_delete_object_v1_response.py +++ b/eZmaxApi/models/ezsignbulksendsignermapping_delete_object_v1_response.py @@ -19,43 +19,61 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignbulksendsignermappingDeleteObjectV1Response(BaseModel): """ - Response for DELETE /1/object/ezsignbulksendsignermapping/{pkiEzsignbulksendsignermappingID} # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - __properties = ["objDebugPayload", "objDebug"] + Response for DELETE /1/object/ezsignbulksendsignermapping/{pkiEzsignbulksendsignermappingID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignbulksendsignermappingDeleteObjectV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignbulksendsignermappingDeleteObjectV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -65,17 +83,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignbulksendsignermappingDeleteObjectV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignbulksendsignermappingDeleteObjectV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignbulksendsignermappingDeleteObjectV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignbulksendsignermappingDeleteObjectV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignbulksendsignermapping_get_object_v2_response.py b/eZmaxApi/models/ezsignbulksendsignermapping_get_object_v2_response.py index b3c1e2664..6013822d7 100644 --- a/eZmaxApi/models/ezsignbulksendsignermapping_get_object_v2_response.py +++ b/eZmaxApi/models/ezsignbulksendsignermapping_get_object_v2_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.ezsignbulksendsignermapping_get_object_v2_response_m_payload import EzsignbulksendsignermappingGetObjectV2ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignbulksendsignermappingGetObjectV2Response(BaseModel): """ - Response for GET /2/object/ezsignbulksendsignermapping/{pkiEzsignbulksendsignermappingID} # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzsignbulksendsignermappingGetObjectV2ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /2/object/ezsignbulksendsignermapping/{pkiEzsignbulksendsignermappingID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsignbulksendsignermappingGetObjectV2ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignbulksendsignermappingGetObjectV2Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignbulksendsignermappingGetObjectV2Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignbulksendsignermappingGetObjectV2Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignbulksendsignermappingGetObjectV2Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignbulksendsignermappingGetObjectV2Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignbulksendsignermappingGetObjectV2Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzsignbulksendsignermappingGetObjectV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsignbulksendsignermappingGetObjectV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignbulksendsignermapping_get_object_v2_response_m_payload.py b/eZmaxApi/models/ezsignbulksendsignermapping_get_object_v2_response_m_payload.py index 734874428..0cf776b9e 100644 --- a/eZmaxApi/models/ezsignbulksendsignermapping_get_object_v2_response_m_payload.py +++ b/eZmaxApi/models/ezsignbulksendsignermapping_get_object_v2_response_m_payload.py @@ -19,57 +19,75 @@ import json - -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.ezsignbulksendsignermapping_response_compound import EzsignbulksendsignermappingResponseCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignbulksendsignermappingGetObjectV2ResponseMPayload(BaseModel): """ - Payload for GET /2/object/ezsignbulksendsignermapping/{pkiEzsignbulksendsignermappingID} # noqa: E501 - """ - obj_ezsignbulksendsignermapping: EzsignbulksendsignermappingResponseCompound = Field(..., alias="objEzsignbulksendsignermapping") - __properties = ["objEzsignbulksendsignermapping"] + Payload for GET /2/object/ezsignbulksendsignermapping/{pkiEzsignbulksendsignermappingID} + """ # noqa: E501 + obj_ezsignbulksendsignermapping: EzsignbulksendsignermappingResponseCompound = Field(alias="objEzsignbulksendsignermapping") + __properties: ClassVar[List[str]] = ["objEzsignbulksendsignermapping"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignbulksendsignermappingGetObjectV2ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignbulksendsignermappingGetObjectV2ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_ezsignbulksendsignermapping if self.obj_ezsignbulksendsignermapping: _dict['objEzsignbulksendsignermapping'] = self.obj_ezsignbulksendsignermapping.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignbulksendsignermappingGetObjectV2ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignbulksendsignermappingGetObjectV2ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignbulksendsignermappingGetObjectV2ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignbulksendsignermappingGetObjectV2ResponseMPayload.parse_obj({ - "obj_ezsignbulksendsignermapping": EzsignbulksendsignermappingResponseCompound.from_dict(obj.get("objEzsignbulksendsignermapping")) if obj.get("objEzsignbulksendsignermapping") is not None else None + _obj = cls.model_validate({ + "objEzsignbulksendsignermapping": EzsignbulksendsignermappingResponseCompound.from_dict(obj.get("objEzsignbulksendsignermapping")) if obj.get("objEzsignbulksendsignermapping") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignbulksendsignermapping_request.py b/eZmaxApi/models/ezsignbulksendsignermapping_request.py index 0270e3de0..cb8fe31f1 100644 --- a/eZmaxApi/models/ezsignbulksendsignermapping_request.py +++ b/eZmaxApi/models/ezsignbulksendsignermapping_request.py @@ -19,59 +19,78 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictStr, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictStr +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignbulksendsignermappingRequest(BaseModel): """ - A Ezsignbulksendsignermapping Object # noqa: E501 - """ - pki_ezsignbulksendsignermapping_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="pkiEzsignbulksendsignermappingID", description="The unique ID of the Ezsignbulksendsignermapping") - fki_ezsignbulksend_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsignbulksendID", description="The unique ID of the Ezsignbulksend") - fki_user_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiUserID", description="The unique ID of the User") - s_ezsignbulksendsignermapping_description: StrictStr = Field(..., alias="sEzsignbulksendsignermappingDescription", description="The description of the Ezsignbulksendsignermapping") - __properties = ["pkiEzsignbulksendsignermappingID", "fkiEzsignbulksendID", "fkiUserID", "sEzsignbulksendsignermappingDescription"] + A Ezsignbulksendsignermapping Object + """ # noqa: E501 + pki_ezsignbulksendsignermapping_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsignbulksendsignermapping", alias="pkiEzsignbulksendsignermappingID") + fki_ezsignbulksend_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsignbulksend", alias="fkiEzsignbulksendID") + fki_user_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the User", alias="fkiUserID") + s_ezsignbulksendsignermapping_description: StrictStr = Field(description="The description of the Ezsignbulksendsignermapping", alias="sEzsignbulksendsignermappingDescription") + __properties: ClassVar[List[str]] = ["pkiEzsignbulksendsignermappingID", "fkiEzsignbulksendID", "fkiUserID", "sEzsignbulksendsignermappingDescription"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignbulksendsignermappingRequest: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignbulksendsignermappingRequest from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignbulksendsignermappingRequest: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignbulksendsignermappingRequest from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignbulksendsignermappingRequest.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignbulksendsignermappingRequest.parse_obj({ - "pki_ezsignbulksendsignermapping_id": obj.get("pkiEzsignbulksendsignermappingID"), - "fki_ezsignbulksend_id": obj.get("fkiEzsignbulksendID"), - "fki_user_id": obj.get("fkiUserID"), - "s_ezsignbulksendsignermapping_description": obj.get("sEzsignbulksendsignermappingDescription") + _obj = cls.model_validate({ + "pkiEzsignbulksendsignermappingID": obj.get("pkiEzsignbulksendsignermappingID"), + "fkiEzsignbulksendID": obj.get("fkiEzsignbulksendID"), + "fkiUserID": obj.get("fkiUserID"), + "sEzsignbulksendsignermappingDescription": obj.get("sEzsignbulksendsignermappingDescription") }) return _obj diff --git a/eZmaxApi/models/ezsignbulksendsignermapping_request_compound.py b/eZmaxApi/models/ezsignbulksendsignermapping_request_compound.py index d9d59f504..19f1851ba 100644 --- a/eZmaxApi/models/ezsignbulksendsignermapping_request_compound.py +++ b/eZmaxApi/models/ezsignbulksendsignermapping_request_compound.py @@ -19,59 +19,78 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictStr, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictStr +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignbulksendsignermappingRequestCompound(BaseModel): """ - A Ezsignbulksendsignermapping Object and children # noqa: E501 - """ - pki_ezsignbulksendsignermapping_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="pkiEzsignbulksendsignermappingID", description="The unique ID of the Ezsignbulksendsignermapping") - fki_ezsignbulksend_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsignbulksendID", description="The unique ID of the Ezsignbulksend") - fki_user_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiUserID", description="The unique ID of the User") - s_ezsignbulksendsignermapping_description: StrictStr = Field(..., alias="sEzsignbulksendsignermappingDescription", description="The description of the Ezsignbulksendsignermapping") - __properties = ["pkiEzsignbulksendsignermappingID", "fkiEzsignbulksendID", "fkiUserID", "sEzsignbulksendsignermappingDescription"] + A Ezsignbulksendsignermapping Object and children + """ # noqa: E501 + pki_ezsignbulksendsignermapping_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsignbulksendsignermapping", alias="pkiEzsignbulksendsignermappingID") + fki_ezsignbulksend_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsignbulksend", alias="fkiEzsignbulksendID") + fki_user_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the User", alias="fkiUserID") + s_ezsignbulksendsignermapping_description: StrictStr = Field(description="The description of the Ezsignbulksendsignermapping", alias="sEzsignbulksendsignermappingDescription") + __properties: ClassVar[List[str]] = ["pkiEzsignbulksendsignermappingID", "fkiEzsignbulksendID", "fkiUserID", "sEzsignbulksendsignermappingDescription"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignbulksendsignermappingRequestCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignbulksendsignermappingRequestCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignbulksendsignermappingRequestCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignbulksendsignermappingRequestCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignbulksendsignermappingRequestCompound.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignbulksendsignermappingRequestCompound.parse_obj({ - "pki_ezsignbulksendsignermapping_id": obj.get("pkiEzsignbulksendsignermappingID"), - "fki_ezsignbulksend_id": obj.get("fkiEzsignbulksendID"), - "fki_user_id": obj.get("fkiUserID"), - "s_ezsignbulksendsignermapping_description": obj.get("sEzsignbulksendsignermappingDescription") + _obj = cls.model_validate({ + "pkiEzsignbulksendsignermappingID": obj.get("pkiEzsignbulksendsignermappingID"), + "fkiEzsignbulksendID": obj.get("fkiEzsignbulksendID"), + "fkiUserID": obj.get("fkiUserID"), + "sEzsignbulksendsignermappingDescription": obj.get("sEzsignbulksendsignermappingDescription") }) return _obj diff --git a/eZmaxApi/models/ezsignbulksendsignermapping_response.py b/eZmaxApi/models/ezsignbulksendsignermapping_response.py index 0d8cd89fc..4a11e0178 100644 --- a/eZmaxApi/models/ezsignbulksendsignermapping_response.py +++ b/eZmaxApi/models/ezsignbulksendsignermapping_response.py @@ -19,59 +19,78 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictStr, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictStr +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignbulksendsignermappingResponse(BaseModel): """ - A Ezsignbulksendsignermapping Object # noqa: E501 - """ - pki_ezsignbulksendsignermapping_id: conint(strict=True, ge=0) = Field(..., alias="pkiEzsignbulksendsignermappingID", description="The unique ID of the Ezsignbulksendsignermapping") - fki_ezsignbulksend_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsignbulksendID", description="The unique ID of the Ezsignbulksend") - fki_user_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiUserID", description="The unique ID of the User") - s_ezsignbulksendsignermapping_description: StrictStr = Field(..., alias="sEzsignbulksendsignermappingDescription", description="The description of the Ezsignbulksendsignermapping") - __properties = ["pkiEzsignbulksendsignermappingID", "fkiEzsignbulksendID", "fkiUserID", "sEzsignbulksendsignermappingDescription"] + A Ezsignbulksendsignermapping Object + """ # noqa: E501 + pki_ezsignbulksendsignermapping_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsignbulksendsignermapping", alias="pkiEzsignbulksendsignermappingID") + fki_ezsignbulksend_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsignbulksend", alias="fkiEzsignbulksendID") + fki_user_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the User", alias="fkiUserID") + s_ezsignbulksendsignermapping_description: StrictStr = Field(description="The description of the Ezsignbulksendsignermapping", alias="sEzsignbulksendsignermappingDescription") + __properties: ClassVar[List[str]] = ["pkiEzsignbulksendsignermappingID", "fkiEzsignbulksendID", "fkiUserID", "sEzsignbulksendsignermappingDescription"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignbulksendsignermappingResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignbulksendsignermappingResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignbulksendsignermappingResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignbulksendsignermappingResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignbulksendsignermappingResponse.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignbulksendsignermappingResponse.parse_obj({ - "pki_ezsignbulksendsignermapping_id": obj.get("pkiEzsignbulksendsignermappingID"), - "fki_ezsignbulksend_id": obj.get("fkiEzsignbulksendID"), - "fki_user_id": obj.get("fkiUserID"), - "s_ezsignbulksendsignermapping_description": obj.get("sEzsignbulksendsignermappingDescription") + _obj = cls.model_validate({ + "pkiEzsignbulksendsignermappingID": obj.get("pkiEzsignbulksendsignermappingID"), + "fkiEzsignbulksendID": obj.get("fkiEzsignbulksendID"), + "fkiUserID": obj.get("fkiUserID"), + "sEzsignbulksendsignermappingDescription": obj.get("sEzsignbulksendsignermappingDescription") }) return _obj diff --git a/eZmaxApi/models/ezsignbulksendsignermapping_response_compound.py b/eZmaxApi/models/ezsignbulksendsignermapping_response_compound.py index cb92a8e1d..be4a256a0 100644 --- a/eZmaxApi/models/ezsignbulksendsignermapping_response_compound.py +++ b/eZmaxApi/models/ezsignbulksendsignermapping_response_compound.py @@ -19,59 +19,78 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictStr, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictStr +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignbulksendsignermappingResponseCompound(BaseModel): """ - A Ezsignbulksendsignermapping Object # noqa: E501 - """ - pki_ezsignbulksendsignermapping_id: conint(strict=True, ge=0) = Field(..., alias="pkiEzsignbulksendsignermappingID", description="The unique ID of the Ezsignbulksendsignermapping") - fki_ezsignbulksend_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsignbulksendID", description="The unique ID of the Ezsignbulksend") - fki_user_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiUserID", description="The unique ID of the User") - s_ezsignbulksendsignermapping_description: StrictStr = Field(..., alias="sEzsignbulksendsignermappingDescription", description="The description of the Ezsignbulksendsignermapping") - __properties = ["pkiEzsignbulksendsignermappingID", "fkiEzsignbulksendID", "fkiUserID", "sEzsignbulksendsignermappingDescription"] + A Ezsignbulksendsignermapping Object + """ # noqa: E501 + pki_ezsignbulksendsignermapping_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsignbulksendsignermapping", alias="pkiEzsignbulksendsignermappingID") + fki_ezsignbulksend_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsignbulksend", alias="fkiEzsignbulksendID") + fki_user_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the User", alias="fkiUserID") + s_ezsignbulksendsignermapping_description: StrictStr = Field(description="The description of the Ezsignbulksendsignermapping", alias="sEzsignbulksendsignermappingDescription") + __properties: ClassVar[List[str]] = ["pkiEzsignbulksendsignermappingID", "fkiEzsignbulksendID", "fkiUserID", "sEzsignbulksendsignermappingDescription"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignbulksendsignermappingResponseCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignbulksendsignermappingResponseCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignbulksendsignermappingResponseCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignbulksendsignermappingResponseCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignbulksendsignermappingResponseCompound.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignbulksendsignermappingResponseCompound.parse_obj({ - "pki_ezsignbulksendsignermapping_id": obj.get("pkiEzsignbulksendsignermappingID"), - "fki_ezsignbulksend_id": obj.get("fkiEzsignbulksendID"), - "fki_user_id": obj.get("fkiUserID"), - "s_ezsignbulksendsignermapping_description": obj.get("sEzsignbulksendsignermappingDescription") + _obj = cls.model_validate({ + "pkiEzsignbulksendsignermappingID": obj.get("pkiEzsignbulksendsignermappingID"), + "fkiEzsignbulksendID": obj.get("fkiEzsignbulksendID"), + "fkiUserID": obj.get("fkiUserID"), + "sEzsignbulksendsignermappingDescription": obj.get("sEzsignbulksendsignermappingDescription") }) return _obj diff --git a/eZmaxApi/models/ezsignbulksendtransmission_get_ezsignsignatures_automatic_v1_response.py b/eZmaxApi/models/ezsignbulksendtransmission_get_ezsignsignatures_automatic_v1_response.py index 70f5cd9d7..9d11d3b51 100644 --- a/eZmaxApi/models/ezsignbulksendtransmission_get_ezsignsignatures_automatic_v1_response.py +++ b/eZmaxApi/models/ezsignbulksendtransmission_get_ezsignsignatures_automatic_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.ezsignbulksendtransmission_get_ezsignsignatures_automatic_v1_response_m_payload import EzsignbulksendtransmissionGetEzsignsignaturesAutomaticV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignbulksendtransmissionGetEzsignsignaturesAutomaticV1Response(BaseModel): """ - Response for GET /1/object/ezsignbulksendtransmission/{pkiEzsignbulksendtransmissionID}/getEzsignsignaturesAutomatic # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzsignbulksendtransmissionGetEzsignsignaturesAutomaticV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /1/object/ezsignbulksendtransmission/{pkiEzsignbulksendtransmissionID}/getEzsignsignaturesAutomatic + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsignbulksendtransmissionGetEzsignsignaturesAutomaticV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignbulksendtransmissionGetEzsignsignaturesAutomaticV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignbulksendtransmissionGetEzsignsignaturesAutomaticV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignbulksendtransmissionGetEzsignsignaturesAutomaticV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignbulksendtransmissionGetEzsignsignaturesAutomaticV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignbulksendtransmissionGetEzsignsignaturesAutomaticV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignbulksendtransmissionGetEzsignsignaturesAutomaticV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzsignbulksendtransmissionGetEzsignsignaturesAutomaticV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsignbulksendtransmissionGetEzsignsignaturesAutomaticV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignbulksendtransmission_get_ezsignsignatures_automatic_v1_response_m_payload.py b/eZmaxApi/models/ezsignbulksendtransmission_get_ezsignsignatures_automatic_v1_response_m_payload.py index 7a75bbbb5..27ba65ca8 100644 --- a/eZmaxApi/models/ezsignbulksendtransmission_get_ezsignsignatures_automatic_v1_response_m_payload.py +++ b/eZmaxApi/models/ezsignbulksendtransmission_get_ezsignsignatures_automatic_v1_response_m_payload.py @@ -19,43 +19,61 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.custom_ezsignfolder_ezsignsignatures_automatic_response import CustomEzsignfolderEzsignsignaturesAutomaticResponse from eZmaxApi.models.field_e_ezsignsignature_type import FieldEEzsignsignatureType +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignbulksendtransmissionGetEzsignsignaturesAutomaticV1ResponseMPayload(BaseModel): """ - Payload for GET /1/object/ezsignbulksendtransmission/{pkiEzsignbulksendtransmissionID}/getEzsignsignaturesAutomatic # noqa: E501 - """ - a_e_ezsignsignature_type: conlist(FieldEEzsignsignatureType, unique_items=True) = Field(..., alias="a_eEzsignsignatureType", description="All eEzsignsignatureType contained in the response") - a_obj_ezsignfolder: conlist(CustomEzsignfolderEzsignsignaturesAutomaticResponse) = Field(..., alias="a_objEzsignfolder") - __properties = ["a_eEzsignsignatureType", "a_objEzsignfolder"] + Payload for GET /1/object/ezsignbulksendtransmission/{pkiEzsignbulksendtransmissionID}/getEzsignsignaturesAutomatic + """ # noqa: E501 + a_e_ezsignsignature_type: List[FieldEEzsignsignatureType] = Field(description="All eEzsignsignatureType contained in the response", alias="a_eEzsignsignatureType") + a_obj_ezsignfolder: List[CustomEzsignfolderEzsignsignaturesAutomaticResponse] = Field(alias="a_objEzsignfolder") + __properties: ClassVar[List[str]] = ["a_eEzsignsignatureType", "a_objEzsignfolder"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignbulksendtransmissionGetEzsignsignaturesAutomaticV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignbulksendtransmissionGetEzsignsignaturesAutomaticV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_ezsignfolder (list) _items = [] if self.a_obj_ezsignfolder: @@ -66,17 +84,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignbulksendtransmissionGetEzsignsignaturesAutomaticV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignbulksendtransmissionGetEzsignsignaturesAutomaticV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignbulksendtransmissionGetEzsignsignaturesAutomaticV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignbulksendtransmissionGetEzsignsignaturesAutomaticV1ResponseMPayload.parse_obj({ - "a_e_ezsignsignature_type": obj.get("a_eEzsignsignatureType"), - "a_obj_ezsignfolder": [CustomEzsignfolderEzsignsignaturesAutomaticResponse.from_dict(_item) for _item in obj.get("a_objEzsignfolder")] if obj.get("a_objEzsignfolder") is not None else None + _obj = cls.model_validate({ + "a_eEzsignsignatureType": obj.get("a_eEzsignsignatureType"), + "a_objEzsignfolder": [CustomEzsignfolderEzsignsignaturesAutomaticResponse.from_dict(_item) for _item in obj.get("a_objEzsignfolder")] if obj.get("a_objEzsignfolder") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignbulksendtransmission_get_forms_data_v1_response.py b/eZmaxApi/models/ezsignbulksendtransmission_get_forms_data_v1_response.py index c20bc9d09..bc7c7c983 100644 --- a/eZmaxApi/models/ezsignbulksendtransmission_get_forms_data_v1_response.py +++ b/eZmaxApi/models/ezsignbulksendtransmission_get_forms_data_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.ezsignbulksendtransmission_get_forms_data_v1_response_m_payload import EzsignbulksendtransmissionGetFormsDataV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignbulksendtransmissionGetFormsDataV1Response(BaseModel): """ - Response for GET /1/object/ezsignbulksendtransmission/{pkiEzsignbulksendtransmissionID}/getFormsData # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzsignbulksendtransmissionGetFormsDataV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /1/object/ezsignbulksendtransmission/{pkiEzsignbulksendtransmissionID}/getFormsData + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsignbulksendtransmissionGetFormsDataV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignbulksendtransmissionGetFormsDataV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignbulksendtransmissionGetFormsDataV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignbulksendtransmissionGetFormsDataV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignbulksendtransmissionGetFormsDataV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignbulksendtransmissionGetFormsDataV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignbulksendtransmissionGetFormsDataV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzsignbulksendtransmissionGetFormsDataV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsignbulksendtransmissionGetFormsDataV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignbulksendtransmission_get_forms_data_v1_response_m_payload.py b/eZmaxApi/models/ezsignbulksendtransmission_get_forms_data_v1_response_m_payload.py index 176db8cec..e41ea47a0 100644 --- a/eZmaxApi/models/ezsignbulksendtransmission_get_forms_data_v1_response_m_payload.py +++ b/eZmaxApi/models/ezsignbulksendtransmission_get_forms_data_v1_response_m_payload.py @@ -19,41 +19,59 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.custom_forms_data_folder_response import CustomFormsDataFolderResponse +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignbulksendtransmissionGetFormsDataV1ResponseMPayload(BaseModel): """ - Payload for GET /1/object/ezsignbulksendtransmission/{pkiEzsignbulksendtransmissionID}/getFormsData # noqa: E501 - """ - a_obj_forms_data_folder: conlist(CustomFormsDataFolderResponse) = Field(..., alias="a_objFormsDataFolder") - __properties = ["a_objFormsDataFolder"] + Payload for GET /1/object/ezsignbulksendtransmission/{pkiEzsignbulksendtransmissionID}/getFormsData + """ # noqa: E501 + a_obj_forms_data_folder: List[CustomFormsDataFolderResponse] = Field(alias="a_objFormsDataFolder") + __properties: ClassVar[List[str]] = ["a_objFormsDataFolder"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignbulksendtransmissionGetFormsDataV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignbulksendtransmissionGetFormsDataV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_forms_data_folder (list) _items = [] if self.a_obj_forms_data_folder: @@ -64,16 +82,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignbulksendtransmissionGetFormsDataV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignbulksendtransmissionGetFormsDataV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignbulksendtransmissionGetFormsDataV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignbulksendtransmissionGetFormsDataV1ResponseMPayload.parse_obj({ - "a_obj_forms_data_folder": [CustomFormsDataFolderResponse.from_dict(_item) for _item in obj.get("a_objFormsDataFolder")] if obj.get("a_objFormsDataFolder") is not None else None + _obj = cls.model_validate({ + "a_objFormsDataFolder": [CustomFormsDataFolderResponse.from_dict(_item) for _item in obj.get("a_objFormsDataFolder")] if obj.get("a_objFormsDataFolder") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignbulksendtransmission_get_object_v2_response.py b/eZmaxApi/models/ezsignbulksendtransmission_get_object_v2_response.py index d7a12a30e..39fa7a186 100644 --- a/eZmaxApi/models/ezsignbulksendtransmission_get_object_v2_response.py +++ b/eZmaxApi/models/ezsignbulksendtransmission_get_object_v2_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.ezsignbulksendtransmission_get_object_v2_response_m_payload import EzsignbulksendtransmissionGetObjectV2ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignbulksendtransmissionGetObjectV2Response(BaseModel): """ - Response for GET /2/object/ezsignbulksendtransmission/{pkiEzsignbulksendtransmissionID} # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzsignbulksendtransmissionGetObjectV2ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /2/object/ezsignbulksendtransmission/{pkiEzsignbulksendtransmissionID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsignbulksendtransmissionGetObjectV2ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignbulksendtransmissionGetObjectV2Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignbulksendtransmissionGetObjectV2Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignbulksendtransmissionGetObjectV2Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignbulksendtransmissionGetObjectV2Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignbulksendtransmissionGetObjectV2Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignbulksendtransmissionGetObjectV2Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzsignbulksendtransmissionGetObjectV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsignbulksendtransmissionGetObjectV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignbulksendtransmission_get_object_v2_response_m_payload.py b/eZmaxApi/models/ezsignbulksendtransmission_get_object_v2_response_m_payload.py index 1956b131e..abb8454a7 100644 --- a/eZmaxApi/models/ezsignbulksendtransmission_get_object_v2_response_m_payload.py +++ b/eZmaxApi/models/ezsignbulksendtransmission_get_object_v2_response_m_payload.py @@ -19,57 +19,75 @@ import json - -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.ezsignbulksendtransmission_response_compound import EzsignbulksendtransmissionResponseCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignbulksendtransmissionGetObjectV2ResponseMPayload(BaseModel): """ - Payload for GET /2/object/ezsignbulksendtransmission/{pkiEzsignbulksendtransmissionID} # noqa: E501 - """ - obj_ezsignbulksendtransmission: EzsignbulksendtransmissionResponseCompound = Field(..., alias="objEzsignbulksendtransmission") - __properties = ["objEzsignbulksendtransmission"] + Payload for GET /2/object/ezsignbulksendtransmission/{pkiEzsignbulksendtransmissionID} + """ # noqa: E501 + obj_ezsignbulksendtransmission: EzsignbulksendtransmissionResponseCompound = Field(alias="objEzsignbulksendtransmission") + __properties: ClassVar[List[str]] = ["objEzsignbulksendtransmission"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignbulksendtransmissionGetObjectV2ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignbulksendtransmissionGetObjectV2ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_ezsignbulksendtransmission if self.obj_ezsignbulksendtransmission: _dict['objEzsignbulksendtransmission'] = self.obj_ezsignbulksendtransmission.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignbulksendtransmissionGetObjectV2ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignbulksendtransmissionGetObjectV2ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignbulksendtransmissionGetObjectV2ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignbulksendtransmissionGetObjectV2ResponseMPayload.parse_obj({ - "obj_ezsignbulksendtransmission": EzsignbulksendtransmissionResponseCompound.from_dict(obj.get("objEzsignbulksendtransmission")) if obj.get("objEzsignbulksendtransmission") is not None else None + _obj = cls.model_validate({ + "objEzsignbulksendtransmission": EzsignbulksendtransmissionResponseCompound.from_dict(obj.get("objEzsignbulksendtransmission")) if obj.get("objEzsignbulksendtransmission") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignbulksendtransmission_response.py b/eZmaxApi/models/ezsignbulksendtransmission_response.py index ad745b1cf..532cd4e56 100644 --- a/eZmaxApi/models/ezsignbulksendtransmission_response.py +++ b/eZmaxApi/models/ezsignbulksendtransmission_response.py @@ -19,65 +19,84 @@ import json - -from pydantic import BaseModel, Field, StrictStr, conint +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictStr +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.common_audit import CommonAudit +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignbulksendtransmissionResponse(BaseModel): """ - An Ezsignbulksendtransmission Object # noqa: E501 - """ - pki_ezsignbulksendtransmission_id: conint(strict=True, ge=0) = Field(..., alias="pkiEzsignbulksendtransmissionID", description="The unique ID of the Ezsignbulksendtransmission") - fki_ezsignbulksend_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsignbulksendID", description="The unique ID of the Ezsignbulksend") - s_ezsignbulksendtransmission_description: StrictStr = Field(..., alias="sEzsignbulksendtransmissionDescription", description="The description of the Ezsignbulksendtransmission") - i_ezsignbulksendtransmission_errors: conint(strict=True, ge=0) = Field(..., alias="iEzsignbulksendtransmissionErrors", description="The number of errors during the Ezsignbulksendtransmission") - obj_audit: CommonAudit = Field(..., alias="objAudit") - __properties = ["pkiEzsignbulksendtransmissionID", "fkiEzsignbulksendID", "sEzsignbulksendtransmissionDescription", "iEzsignbulksendtransmissionErrors", "objAudit"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + An Ezsignbulksendtransmission Object + """ # noqa: E501 + pki_ezsignbulksendtransmission_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsignbulksendtransmission", alias="pkiEzsignbulksendtransmissionID") + fki_ezsignbulksend_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsignbulksend", alias="fkiEzsignbulksendID") + s_ezsignbulksendtransmission_description: StrictStr = Field(description="The description of the Ezsignbulksendtransmission", alias="sEzsignbulksendtransmissionDescription") + i_ezsignbulksendtransmission_errors: Annotated[int, Field(strict=True, ge=0)] = Field(description="The number of errors during the Ezsignbulksendtransmission", alias="iEzsignbulksendtransmissionErrors") + obj_audit: CommonAudit = Field(alias="objAudit") + __properties: ClassVar[List[str]] = ["pkiEzsignbulksendtransmissionID", "fkiEzsignbulksendID", "sEzsignbulksendtransmissionDescription", "iEzsignbulksendtransmissionErrors", "objAudit"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignbulksendtransmissionResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignbulksendtransmissionResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_audit if self.obj_audit: _dict['objAudit'] = self.obj_audit.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignbulksendtransmissionResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignbulksendtransmissionResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignbulksendtransmissionResponse.parse_obj(obj) - - _obj = EzsignbulksendtransmissionResponse.parse_obj({ - "pki_ezsignbulksendtransmission_id": obj.get("pkiEzsignbulksendtransmissionID"), - "fki_ezsignbulksend_id": obj.get("fkiEzsignbulksendID"), - "s_ezsignbulksendtransmission_description": obj.get("sEzsignbulksendtransmissionDescription"), - "i_ezsignbulksendtransmission_errors": obj.get("iEzsignbulksendtransmissionErrors"), - "obj_audit": CommonAudit.from_dict(obj.get("objAudit")) if obj.get("objAudit") is not None else None + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsignbulksendtransmissionID": obj.get("pkiEzsignbulksendtransmissionID"), + "fkiEzsignbulksendID": obj.get("fkiEzsignbulksendID"), + "sEzsignbulksendtransmissionDescription": obj.get("sEzsignbulksendtransmissionDescription"), + "iEzsignbulksendtransmissionErrors": obj.get("iEzsignbulksendtransmissionErrors"), + "objAudit": CommonAudit.from_dict(obj.get("objAudit")) if obj.get("objAudit") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignbulksendtransmission_response_compound.py b/eZmaxApi/models/ezsignbulksendtransmission_response_compound.py index 7067c3aab..0e36d4c04 100644 --- a/eZmaxApi/models/ezsignbulksendtransmission_response_compound.py +++ b/eZmaxApi/models/ezsignbulksendtransmission_response_compound.py @@ -19,47 +19,66 @@ import json -from typing import List -from pydantic import BaseModel, Field, StrictStr, conint, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictStr +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.common_audit import CommonAudit from eZmaxApi.models.custom_ezsignfoldertransmission_response import CustomEzsignfoldertransmissionResponse +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignbulksendtransmissionResponseCompound(BaseModel): """ - An Ezsignbulksendtransmission Object and children to create a complete structure # noqa: E501 - """ - pki_ezsignbulksendtransmission_id: conint(strict=True, ge=0) = Field(..., alias="pkiEzsignbulksendtransmissionID", description="The unique ID of the Ezsignbulksendtransmission") - fki_ezsignbulksend_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsignbulksendID", description="The unique ID of the Ezsignbulksend") - s_ezsignbulksendtransmission_description: StrictStr = Field(..., alias="sEzsignbulksendtransmissionDescription", description="The description of the Ezsignbulksendtransmission") - i_ezsignbulksendtransmission_errors: conint(strict=True, ge=0) = Field(..., alias="iEzsignbulksendtransmissionErrors", description="The number of errors during the Ezsignbulksendtransmission") - obj_audit: CommonAudit = Field(..., alias="objAudit") - a_obj_ezsignfoldertransmission: conlist(CustomEzsignfoldertransmissionResponse) = Field(..., alias="a_objEzsignfoldertransmission") - __properties = ["pkiEzsignbulksendtransmissionID", "fkiEzsignbulksendID", "sEzsignbulksendtransmissionDescription", "iEzsignbulksendtransmissionErrors", "objAudit", "a_objEzsignfoldertransmission"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + An Ezsignbulksendtransmission Object and children to create a complete structure + """ # noqa: E501 + pki_ezsignbulksendtransmission_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsignbulksendtransmission", alias="pkiEzsignbulksendtransmissionID") + fki_ezsignbulksend_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsignbulksend", alias="fkiEzsignbulksendID") + s_ezsignbulksendtransmission_description: StrictStr = Field(description="The description of the Ezsignbulksendtransmission", alias="sEzsignbulksendtransmissionDescription") + i_ezsignbulksendtransmission_errors: Annotated[int, Field(strict=True, ge=0)] = Field(description="The number of errors during the Ezsignbulksendtransmission", alias="iEzsignbulksendtransmissionErrors") + obj_audit: CommonAudit = Field(alias="objAudit") + a_obj_ezsignfoldertransmission: List[CustomEzsignfoldertransmissionResponse] = Field(alias="a_objEzsignfoldertransmission") + __properties: ClassVar[List[str]] = ["pkiEzsignbulksendtransmissionID", "fkiEzsignbulksendID", "sEzsignbulksendtransmissionDescription", "iEzsignbulksendtransmissionErrors", "objAudit", "a_objEzsignfoldertransmission"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignbulksendtransmissionResponseCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignbulksendtransmissionResponseCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_audit if self.obj_audit: _dict['objAudit'] = self.obj_audit.to_dict() @@ -73,21 +92,21 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignbulksendtransmissionResponseCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignbulksendtransmissionResponseCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignbulksendtransmissionResponseCompound.parse_obj(obj) - - _obj = EzsignbulksendtransmissionResponseCompound.parse_obj({ - "pki_ezsignbulksendtransmission_id": obj.get("pkiEzsignbulksendtransmissionID"), - "fki_ezsignbulksend_id": obj.get("fkiEzsignbulksendID"), - "s_ezsignbulksendtransmission_description": obj.get("sEzsignbulksendtransmissionDescription"), - "i_ezsignbulksendtransmission_errors": obj.get("iEzsignbulksendtransmissionErrors"), - "obj_audit": CommonAudit.from_dict(obj.get("objAudit")) if obj.get("objAudit") is not None else None, - "a_obj_ezsignfoldertransmission": [CustomEzsignfoldertransmissionResponse.from_dict(_item) for _item in obj.get("a_objEzsignfoldertransmission")] if obj.get("a_objEzsignfoldertransmission") is not None else None + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsignbulksendtransmissionID": obj.get("pkiEzsignbulksendtransmissionID"), + "fkiEzsignbulksendID": obj.get("fkiEzsignbulksendID"), + "sEzsignbulksendtransmissionDescription": obj.get("sEzsignbulksendtransmissionDescription"), + "iEzsignbulksendtransmissionErrors": obj.get("iEzsignbulksendtransmissionErrors"), + "objAudit": CommonAudit.from_dict(obj.get("objAudit")) if obj.get("objAudit") is not None else None, + "a_objEzsignfoldertransmission": [CustomEzsignfoldertransmissionResponse.from_dict(_item) for _item in obj.get("a_objEzsignfoldertransmission")] if obj.get("a_objEzsignfoldertransmission") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigndocument_apply_ezsigntemplate_v1_request.py b/eZmaxApi/models/ezsigndocument_apply_ezsigntemplate_v1_request.py index d0ed5475e..232dc8551 100644 --- a/eZmaxApi/models/ezsigndocument_apply_ezsigntemplate_v1_request.py +++ b/eZmaxApi/models/ezsigndocument_apply_ezsigntemplate_v1_request.py @@ -19,57 +19,76 @@ import json -from typing import List -from pydantic import BaseModel, Field, StrictStr, conint, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictStr +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigndocumentApplyEzsigntemplateV1Request(BaseModel): """ - Request for POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/applyezsigntemplate # noqa: E501 - """ - fki_ezsigntemplate_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsigntemplateID", description="The unique ID of the Ezsigntemplate") - a_s_ezsigntemplatesigner: conlist(StrictStr, min_items=1) = Field(..., alias="a_sEzsigntemplatesigner") - a_pki_ezsignfoldersignerassociation_id: conlist(conint(strict=True, ge=0), min_items=1) = Field(..., alias="a_pkiEzsignfoldersignerassociationID") - __properties = ["fkiEzsigntemplateID", "a_sEzsigntemplatesigner", "a_pkiEzsignfoldersignerassociationID"] + Request for POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/applyezsigntemplate + """ # noqa: E501 + fki_ezsigntemplate_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsigntemplate", alias="fkiEzsigntemplateID") + a_s_ezsigntemplatesigner: Annotated[List[StrictStr], Field(min_length=1)] = Field(alias="a_sEzsigntemplatesigner") + a_pki_ezsignfoldersignerassociation_id: Annotated[List[Annotated[int, Field(strict=True, ge=0)]], Field(min_length=1)] = Field(alias="a_pkiEzsignfoldersignerassociationID") + __properties: ClassVar[List[str]] = ["fkiEzsigntemplateID", "a_sEzsigntemplatesigner", "a_pkiEzsignfoldersignerassociationID"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigndocumentApplyEzsigntemplateV1Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigndocumentApplyEzsigntemplateV1Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigndocumentApplyEzsigntemplateV1Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigndocumentApplyEzsigntemplateV1Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigndocumentApplyEzsigntemplateV1Request.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigndocumentApplyEzsigntemplateV1Request.parse_obj({ - "fki_ezsigntemplate_id": obj.get("fkiEzsigntemplateID"), - "a_s_ezsigntemplatesigner": obj.get("a_sEzsigntemplatesigner"), - "a_pki_ezsignfoldersignerassociation_id": obj.get("a_pkiEzsignfoldersignerassociationID") + _obj = cls.model_validate({ + "fkiEzsigntemplateID": obj.get("fkiEzsigntemplateID"), + "a_sEzsigntemplatesigner": obj.get("a_sEzsigntemplatesigner"), + "a_pkiEzsignfoldersignerassociationID": obj.get("a_pkiEzsignfoldersignerassociationID") }) return _obj diff --git a/eZmaxApi/models/ezsigndocument_apply_ezsigntemplate_v1_response.py b/eZmaxApi/models/ezsigndocument_apply_ezsigntemplate_v1_response.py index 2a882932a..bc091df1f 100644 --- a/eZmaxApi/models/ezsigndocument_apply_ezsigntemplate_v1_response.py +++ b/eZmaxApi/models/ezsigndocument_apply_ezsigntemplate_v1_response.py @@ -19,43 +19,61 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigndocumentApplyEzsigntemplateV1Response(BaseModel): """ - Response for POST /1/object/ezsigndocument/{pkiEzsigndocument}/applyEzsigntemplate # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - __properties = ["objDebugPayload", "objDebug"] + Response for POST /1/object/ezsigndocument/{pkiEzsigndocument}/applyEzsigntemplate + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigndocumentApplyEzsigntemplateV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigndocumentApplyEzsigntemplateV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -65,17 +83,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigndocumentApplyEzsigntemplateV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigndocumentApplyEzsigntemplateV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigndocumentApplyEzsigntemplateV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigndocumentApplyEzsigntemplateV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigndocument_apply_ezsigntemplate_v2_request.py b/eZmaxApi/models/ezsigndocument_apply_ezsigntemplate_v2_request.py index a95636e44..a51a9e06d 100644 --- a/eZmaxApi/models/ezsigndocument_apply_ezsigntemplate_v2_request.py +++ b/eZmaxApi/models/ezsigndocument_apply_ezsigntemplate_v2_request.py @@ -19,57 +19,76 @@ import json -from typing import List -from pydantic import BaseModel, Field, StrictStr, conint, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictStr +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigndocumentApplyEzsigntemplateV2Request(BaseModel): """ - Request for POST /2/object/ezsigndocument/{pkiEzsigndocumentID}/applyezsigntemplate # noqa: E501 - """ - fki_ezsigntemplate_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsigntemplateID", description="The unique ID of the Ezsigntemplate") - a_s_ezsigntemplatesigner: conlist(StrictStr, min_items=1) = Field(..., alias="a_sEzsigntemplatesigner") - a_pki_ezsignfoldersignerassociation_id: conlist(conint(strict=True, ge=0), min_items=1) = Field(..., alias="a_pkiEzsignfoldersignerassociationID") - __properties = ["fkiEzsigntemplateID", "a_sEzsigntemplatesigner", "a_pkiEzsignfoldersignerassociationID"] + Request for POST /2/object/ezsigndocument/{pkiEzsigndocumentID}/applyezsigntemplate + """ # noqa: E501 + fki_ezsigntemplate_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsigntemplate", alias="fkiEzsigntemplateID") + a_s_ezsigntemplatesigner: Annotated[List[StrictStr], Field(min_length=1)] = Field(alias="a_sEzsigntemplatesigner") + a_pki_ezsignfoldersignerassociation_id: Annotated[List[Annotated[int, Field(strict=True, ge=0)]], Field(min_length=1)] = Field(alias="a_pkiEzsignfoldersignerassociationID") + __properties: ClassVar[List[str]] = ["fkiEzsigntemplateID", "a_sEzsigntemplatesigner", "a_pkiEzsignfoldersignerassociationID"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigndocumentApplyEzsigntemplateV2Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigndocumentApplyEzsigntemplateV2Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigndocumentApplyEzsigntemplateV2Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigndocumentApplyEzsigntemplateV2Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigndocumentApplyEzsigntemplateV2Request.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigndocumentApplyEzsigntemplateV2Request.parse_obj({ - "fki_ezsigntemplate_id": obj.get("fkiEzsigntemplateID"), - "a_s_ezsigntemplatesigner": obj.get("a_sEzsigntemplatesigner"), - "a_pki_ezsignfoldersignerassociation_id": obj.get("a_pkiEzsignfoldersignerassociationID") + _obj = cls.model_validate({ + "fkiEzsigntemplateID": obj.get("fkiEzsigntemplateID"), + "a_sEzsigntemplatesigner": obj.get("a_sEzsigntemplatesigner"), + "a_pkiEzsignfoldersignerassociationID": obj.get("a_pkiEzsignfoldersignerassociationID") }) return _obj diff --git a/eZmaxApi/models/ezsigndocument_apply_ezsigntemplate_v2_response.py b/eZmaxApi/models/ezsigndocument_apply_ezsigntemplate_v2_response.py index 1f488597f..183048bbd 100644 --- a/eZmaxApi/models/ezsigndocument_apply_ezsigntemplate_v2_response.py +++ b/eZmaxApi/models/ezsigndocument_apply_ezsigntemplate_v2_response.py @@ -19,43 +19,61 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigndocumentApplyEzsigntemplateV2Response(BaseModel): """ - Response for POST /2/object/ezsigndocument/{pkiEzsigndocument}/applyEzsigntemplate # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - __properties = ["objDebugPayload", "objDebug"] + Response for POST /2/object/ezsigndocument/{pkiEzsigndocument}/applyEzsigntemplate + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigndocumentApplyEzsigntemplateV2Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigndocumentApplyEzsigntemplateV2Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -65,17 +83,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigndocumentApplyEzsigntemplateV2Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigndocumentApplyEzsigntemplateV2Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigndocumentApplyEzsigntemplateV2Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigndocumentApplyEzsigntemplateV2Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigndocument_create_object_v1_request.py b/eZmaxApi/models/ezsigndocument_create_object_v1_request.py index efc3b6970..3877f9587 100644 --- a/eZmaxApi/models/ezsigndocument_create_object_v1_request.py +++ b/eZmaxApi/models/ezsigndocument_create_object_v1_request.py @@ -19,43 +19,61 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.ezsigndocument_request import EzsigndocumentRequest from eZmaxApi.models.ezsigndocument_request_compound import EzsigndocumentRequestCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigndocumentCreateObjectV1Request(BaseModel): """ - Request for POST /1/object/ezsigndocument # noqa: E501 - """ - obj_ezsigndocument: Optional[EzsigndocumentRequest] = Field(None, alias="objEzsigndocument") - obj_ezsigndocument_compound: Optional[EzsigndocumentRequestCompound] = Field(None, alias="objEzsigndocumentCompound") - __properties = ["objEzsigndocument", "objEzsigndocumentCompound"] + Request for POST /1/object/ezsigndocument + """ # noqa: E501 + obj_ezsigndocument: Optional[EzsigndocumentRequest] = Field(default=None, alias="objEzsigndocument") + obj_ezsigndocument_compound: Optional[EzsigndocumentRequestCompound] = Field(default=None, alias="objEzsigndocumentCompound") + __properties: ClassVar[List[str]] = ["objEzsigndocument", "objEzsigndocumentCompound"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigndocumentCreateObjectV1Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigndocumentCreateObjectV1Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_ezsigndocument if self.obj_ezsigndocument: _dict['objEzsigndocument'] = self.obj_ezsigndocument.to_dict() @@ -65,17 +83,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigndocumentCreateObjectV1Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigndocumentCreateObjectV1Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigndocumentCreateObjectV1Request.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigndocumentCreateObjectV1Request.parse_obj({ - "obj_ezsigndocument": EzsigndocumentRequest.from_dict(obj.get("objEzsigndocument")) if obj.get("objEzsigndocument") is not None else None, - "obj_ezsigndocument_compound": EzsigndocumentRequestCompound.from_dict(obj.get("objEzsigndocumentCompound")) if obj.get("objEzsigndocumentCompound") is not None else None + _obj = cls.model_validate({ + "objEzsigndocument": EzsigndocumentRequest.from_dict(obj.get("objEzsigndocument")) if obj.get("objEzsigndocument") is not None else None, + "objEzsigndocumentCompound": EzsigndocumentRequestCompound.from_dict(obj.get("objEzsigndocumentCompound")) if obj.get("objEzsigndocumentCompound") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigndocument_create_object_v1_response.py b/eZmaxApi/models/ezsigndocument_create_object_v1_response.py index d99626983..5864b2a0d 100644 --- a/eZmaxApi/models/ezsigndocument_create_object_v1_response.py +++ b/eZmaxApi/models/ezsigndocument_create_object_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.ezsigndocument_create_object_v1_response_m_payload import EzsigndocumentCreateObjectV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigndocumentCreateObjectV1Response(BaseModel): """ - Response for POST /1/object/ezsigndocument # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzsigndocumentCreateObjectV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for POST /1/object/ezsigndocument + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsigndocumentCreateObjectV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigndocumentCreateObjectV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigndocumentCreateObjectV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigndocumentCreateObjectV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigndocumentCreateObjectV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigndocumentCreateObjectV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigndocumentCreateObjectV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzsigndocumentCreateObjectV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsigndocumentCreateObjectV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigndocument_create_object_v1_response_m_payload.py b/eZmaxApi/models/ezsigndocument_create_object_v1_response_m_payload.py index b8b2de8d8..f35a22474 100644 --- a/eZmaxApi/models/ezsigndocument_create_object_v1_response_m_payload.py +++ b/eZmaxApi/models/ezsigndocument_create_object_v1_response_m_payload.py @@ -19,53 +19,72 @@ import json -from typing import List -from pydantic import BaseModel, Field, conint, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigndocumentCreateObjectV1ResponseMPayload(BaseModel): """ - Payload for POST /1/object/ezsigndocument # noqa: E501 - """ - a_pki_ezsigndocument_id: conlist(conint(strict=True, ge=0), min_items=1) = Field(..., alias="a_pkiEzsigndocumentID", description="An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request.") - __properties = ["a_pkiEzsigndocumentID"] + Payload for POST /1/object/ezsigndocument + """ # noqa: E501 + a_pki_ezsigndocument_id: Annotated[List[Annotated[int, Field(strict=True, ge=0)]], Field(min_length=1)] = Field(description="An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request.", alias="a_pkiEzsigndocumentID") + __properties: ClassVar[List[str]] = ["a_pkiEzsigndocumentID"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigndocumentCreateObjectV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigndocumentCreateObjectV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigndocumentCreateObjectV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigndocumentCreateObjectV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigndocumentCreateObjectV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigndocumentCreateObjectV1ResponseMPayload.parse_obj({ - "a_pki_ezsigndocument_id": obj.get("a_pkiEzsigndocumentID") + _obj = cls.model_validate({ + "a_pkiEzsigndocumentID": obj.get("a_pkiEzsigndocumentID") }) return _obj diff --git a/eZmaxApi/models/ezsigndocument_create_object_v2_request.py b/eZmaxApi/models/ezsigndocument_create_object_v2_request.py index 0705cf24c..92a43e68b 100644 --- a/eZmaxApi/models/ezsigndocument_create_object_v2_request.py +++ b/eZmaxApi/models/ezsigndocument_create_object_v2_request.py @@ -19,41 +19,60 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.ezsigndocument_request_compound import EzsigndocumentRequestCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigndocumentCreateObjectV2Request(BaseModel): """ - Request for POST /2/object/ezsigndocument # noqa: E501 - """ - a_obj_ezsigndocument: conlist(EzsigndocumentRequestCompound, min_items=1) = Field(..., alias="a_objEzsigndocument") - __properties = ["a_objEzsigndocument"] + Request for POST /2/object/ezsigndocument + """ # noqa: E501 + a_obj_ezsigndocument: Annotated[List[EzsigndocumentRequestCompound], Field(min_length=1)] = Field(alias="a_objEzsigndocument") + __properties: ClassVar[List[str]] = ["a_objEzsigndocument"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigndocumentCreateObjectV2Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigndocumentCreateObjectV2Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_ezsigndocument (list) _items = [] if self.a_obj_ezsigndocument: @@ -64,16 +83,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigndocumentCreateObjectV2Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigndocumentCreateObjectV2Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigndocumentCreateObjectV2Request.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigndocumentCreateObjectV2Request.parse_obj({ - "a_obj_ezsigndocument": [EzsigndocumentRequestCompound.from_dict(_item) for _item in obj.get("a_objEzsigndocument")] if obj.get("a_objEzsigndocument") is not None else None + _obj = cls.model_validate({ + "a_objEzsigndocument": [EzsigndocumentRequestCompound.from_dict(_item) for _item in obj.get("a_objEzsigndocument")] if obj.get("a_objEzsigndocument") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigndocument_create_object_v2_response.py b/eZmaxApi/models/ezsigndocument_create_object_v2_response.py index 576c91ccd..4ac595f57 100644 --- a/eZmaxApi/models/ezsigndocument_create_object_v2_response.py +++ b/eZmaxApi/models/ezsigndocument_create_object_v2_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.ezsigndocument_create_object_v2_response_m_payload import EzsigndocumentCreateObjectV2ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigndocumentCreateObjectV2Response(BaseModel): """ - Response for POST /2/object/ezsigndocument # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzsigndocumentCreateObjectV2ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for POST /2/object/ezsigndocument + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsigndocumentCreateObjectV2ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigndocumentCreateObjectV2Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigndocumentCreateObjectV2Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigndocumentCreateObjectV2Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigndocumentCreateObjectV2Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigndocumentCreateObjectV2Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigndocumentCreateObjectV2Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzsigndocumentCreateObjectV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsigndocumentCreateObjectV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigndocument_create_object_v2_response_m_payload.py b/eZmaxApi/models/ezsigndocument_create_object_v2_response_m_payload.py index 0dc536d32..d0b4019f3 100644 --- a/eZmaxApi/models/ezsigndocument_create_object_v2_response_m_payload.py +++ b/eZmaxApi/models/ezsigndocument_create_object_v2_response_m_payload.py @@ -19,53 +19,72 @@ import json -from typing import List -from pydantic import BaseModel, Field, conint, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigndocumentCreateObjectV2ResponseMPayload(BaseModel): """ - Payload for POST /2/object/ezsigndocument # noqa: E501 - """ - a_pki_ezsigndocument_id: conlist(conint(strict=True, ge=0), min_items=1) = Field(..., alias="a_pkiEzsigndocumentID", description="An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request.") - __properties = ["a_pkiEzsigndocumentID"] + Payload for POST /2/object/ezsigndocument + """ # noqa: E501 + a_pki_ezsigndocument_id: Annotated[List[Annotated[int, Field(strict=True, ge=0)]], Field(min_length=1)] = Field(description="An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request.", alias="a_pkiEzsigndocumentID") + __properties: ClassVar[List[str]] = ["a_pkiEzsigndocumentID"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigndocumentCreateObjectV2ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigndocumentCreateObjectV2ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigndocumentCreateObjectV2ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigndocumentCreateObjectV2ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigndocumentCreateObjectV2ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigndocumentCreateObjectV2ResponseMPayload.parse_obj({ - "a_pki_ezsigndocument_id": obj.get("a_pkiEzsigndocumentID") + _obj = cls.model_validate({ + "a_pkiEzsigndocumentID": obj.get("a_pkiEzsigndocumentID") }) return _obj diff --git a/eZmaxApi/models/ezsigndocument_decline_to_sign_v1_request.py b/eZmaxApi/models/ezsigndocument_decline_to_sign_v1_request.py index 0fe2d9e2f..3a53819c3 100644 --- a/eZmaxApi/models/ezsigndocument_decline_to_sign_v1_request.py +++ b/eZmaxApi/models/ezsigndocument_decline_to_sign_v1_request.py @@ -19,60 +19,79 @@ import json - -from pydantic import BaseModel, Field, constr, validator +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, field_validator +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigndocumentDeclineToSignV1Request(BaseModel): """ - Request for POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/declineToSign # noqa: E501 - """ - s_reason: constr(strict=True) = Field(..., alias="sReason", description="Reason for refusal") - __properties = ["sReason"] + Request for POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/declineToSign + """ # noqa: E501 + s_reason: Annotated[str, Field(strict=True)] = Field(description="Reason for refusal", alias="sReason") + __properties: ClassVar[List[str]] = ["sReason"] - @validator('s_reason') + @field_validator('s_reason') def s_reason_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^.{0,65535}$", value): raise ValueError(r"must validate the regular expression /^.{0,65535}$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigndocumentDeclineToSignV1Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigndocumentDeclineToSignV1Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigndocumentDeclineToSignV1Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigndocumentDeclineToSignV1Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigndocumentDeclineToSignV1Request.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigndocumentDeclineToSignV1Request.parse_obj({ - "s_reason": obj.get("sReason") + _obj = cls.model_validate({ + "sReason": obj.get("sReason") }) return _obj diff --git a/eZmaxApi/models/ezsigndocument_decline_to_sign_v1_response.py b/eZmaxApi/models/ezsigndocument_decline_to_sign_v1_response.py index 270998392..7f692e7c4 100644 --- a/eZmaxApi/models/ezsigndocument_decline_to_sign_v1_response.py +++ b/eZmaxApi/models/ezsigndocument_decline_to_sign_v1_response.py @@ -19,43 +19,61 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigndocumentDeclineToSignV1Response(BaseModel): """ - Response for POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/declineToSign # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - __properties = ["objDebugPayload", "objDebug"] + Response for POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/declineToSign + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigndocumentDeclineToSignV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigndocumentDeclineToSignV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -65,17 +83,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigndocumentDeclineToSignV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigndocumentDeclineToSignV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigndocumentDeclineToSignV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigndocumentDeclineToSignV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigndocument_delete_object_v1_response.py b/eZmaxApi/models/ezsigndocument_delete_object_v1_response.py index 55404c91c..a5da480b0 100644 --- a/eZmaxApi/models/ezsigndocument_delete_object_v1_response.py +++ b/eZmaxApi/models/ezsigndocument_delete_object_v1_response.py @@ -19,43 +19,61 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigndocumentDeleteObjectV1Response(BaseModel): """ - Response for DELETE /1/object/ezsigndocument/{pkiEzsigndocumentID} # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - __properties = ["objDebugPayload", "objDebug"] + Response for DELETE /1/object/ezsigndocument/{pkiEzsigndocumentID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigndocumentDeleteObjectV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigndocumentDeleteObjectV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -65,17 +83,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigndocumentDeleteObjectV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigndocumentDeleteObjectV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigndocumentDeleteObjectV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigndocumentDeleteObjectV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigndocument_edit_ezsignformfieldgroups_v1_request.py b/eZmaxApi/models/ezsigndocument_edit_ezsignformfieldgroups_v1_request.py index 78f4fde55..2d72321bd 100644 --- a/eZmaxApi/models/ezsigndocument_edit_ezsignformfieldgroups_v1_request.py +++ b/eZmaxApi/models/ezsigndocument_edit_ezsignformfieldgroups_v1_request.py @@ -19,41 +19,59 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.ezsignformfieldgroup_request_compound import EzsignformfieldgroupRequestCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigndocumentEditEzsignformfieldgroupsV1Request(BaseModel): """ - Request for PUT /1/object/ezsigndocument/{pkiEzsigndocumentID}/editEzsignformfieldgroups # noqa: E501 - """ - a_obj_ezsignformfieldgroup: conlist(EzsignformfieldgroupRequestCompound) = Field(..., alias="a_objEzsignformfieldgroup") - __properties = ["a_objEzsignformfieldgroup"] + Request for PUT /1/object/ezsigndocument/{pkiEzsigndocumentID}/editEzsignformfieldgroups + """ # noqa: E501 + a_obj_ezsignformfieldgroup: List[EzsignformfieldgroupRequestCompound] = Field(alias="a_objEzsignformfieldgroup") + __properties: ClassVar[List[str]] = ["a_objEzsignformfieldgroup"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigndocumentEditEzsignformfieldgroupsV1Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigndocumentEditEzsignformfieldgroupsV1Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_ezsignformfieldgroup (list) _items = [] if self.a_obj_ezsignformfieldgroup: @@ -64,16 +82,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigndocumentEditEzsignformfieldgroupsV1Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigndocumentEditEzsignformfieldgroupsV1Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigndocumentEditEzsignformfieldgroupsV1Request.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigndocumentEditEzsignformfieldgroupsV1Request.parse_obj({ - "a_obj_ezsignformfieldgroup": [EzsignformfieldgroupRequestCompound.from_dict(_item) for _item in obj.get("a_objEzsignformfieldgroup")] if obj.get("a_objEzsignformfieldgroup") is not None else None + _obj = cls.model_validate({ + "a_objEzsignformfieldgroup": [EzsignformfieldgroupRequestCompound.from_dict(_item) for _item in obj.get("a_objEzsignformfieldgroup")] if obj.get("a_objEzsignformfieldgroup") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigndocument_edit_ezsignformfieldgroups_v1_response.py b/eZmaxApi/models/ezsigndocument_edit_ezsignformfieldgroups_v1_response.py index ba0ac514e..a32015b28 100644 --- a/eZmaxApi/models/ezsigndocument_edit_ezsignformfieldgroups_v1_response.py +++ b/eZmaxApi/models/ezsigndocument_edit_ezsignformfieldgroups_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.ezsigndocument_edit_ezsignformfieldgroups_v1_response_m_payload import EzsigndocumentEditEzsignformfieldgroupsV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigndocumentEditEzsignformfieldgroupsV1Response(BaseModel): """ - Response for PUT /1/object/ezsigndocument/{pkiEzsigndocumentID}/editEzsignformfieldgroups # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzsigndocumentEditEzsignformfieldgroupsV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for PUT /1/object/ezsigndocument/{pkiEzsigndocumentID}/editEzsignformfieldgroups + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsigndocumentEditEzsignformfieldgroupsV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigndocumentEditEzsignformfieldgroupsV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigndocumentEditEzsignformfieldgroupsV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigndocumentEditEzsignformfieldgroupsV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigndocumentEditEzsignformfieldgroupsV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigndocumentEditEzsignformfieldgroupsV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigndocumentEditEzsignformfieldgroupsV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzsigndocumentEditEzsignformfieldgroupsV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsigndocumentEditEzsignformfieldgroupsV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigndocument_edit_ezsignformfieldgroups_v1_response_m_payload.py b/eZmaxApi/models/ezsigndocument_edit_ezsignformfieldgroups_v1_response_m_payload.py index 9c0e040e1..fa6324a1d 100644 --- a/eZmaxApi/models/ezsigndocument_edit_ezsignformfieldgroups_v1_response_m_payload.py +++ b/eZmaxApi/models/ezsigndocument_edit_ezsignformfieldgroups_v1_response_m_payload.py @@ -19,53 +19,72 @@ import json -from typing import List -from pydantic import BaseModel, Field, conint, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigndocumentEditEzsignformfieldgroupsV1ResponseMPayload(BaseModel): """ - Payload for PUT /1/object/ezsigndocument/{pkiEzsigndocumentID}/editEzsignformfieldgroups # noqa: E501 - """ - a_pki_ezsignformfieldgroup_id: conlist(conint(strict=True, ge=0)) = Field(..., alias="a_pkiEzsignformfieldgroupID") - __properties = ["a_pkiEzsignformfieldgroupID"] + Payload for PUT /1/object/ezsigndocument/{pkiEzsigndocumentID}/editEzsignformfieldgroups + """ # noqa: E501 + a_pki_ezsignformfieldgroup_id: List[Annotated[int, Field(strict=True, ge=0)]] = Field(alias="a_pkiEzsignformfieldgroupID") + __properties: ClassVar[List[str]] = ["a_pkiEzsignformfieldgroupID"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigndocumentEditEzsignformfieldgroupsV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigndocumentEditEzsignformfieldgroupsV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigndocumentEditEzsignformfieldgroupsV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigndocumentEditEzsignformfieldgroupsV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigndocumentEditEzsignformfieldgroupsV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigndocumentEditEzsignformfieldgroupsV1ResponseMPayload.parse_obj({ - "a_pki_ezsignformfieldgroup_id": obj.get("a_pkiEzsignformfieldgroupID") + _obj = cls.model_validate({ + "a_pkiEzsignformfieldgroupID": obj.get("a_pkiEzsignformfieldgroupID") }) return _obj diff --git a/eZmaxApi/models/ezsigndocument_edit_ezsignsignatures_v1_request.py b/eZmaxApi/models/ezsigndocument_edit_ezsignsignatures_v1_request.py index 394c3b621..6ec062bee 100644 --- a/eZmaxApi/models/ezsigndocument_edit_ezsignsignatures_v1_request.py +++ b/eZmaxApi/models/ezsigndocument_edit_ezsignsignatures_v1_request.py @@ -19,41 +19,59 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.ezsignsignature_request_compound import EzsignsignatureRequestCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigndocumentEditEzsignsignaturesV1Request(BaseModel): """ - Request for PUT /1/object/ezsigndocument/{pkiEzsigndocumentID}/editEzsignsignatures # noqa: E501 - """ - a_obj_ezsignsignature: conlist(EzsignsignatureRequestCompound) = Field(..., alias="a_objEzsignsignature") - __properties = ["a_objEzsignsignature"] + Request for PUT /1/object/ezsigndocument/{pkiEzsigndocumentID}/editEzsignsignatures + """ # noqa: E501 + a_obj_ezsignsignature: List[EzsignsignatureRequestCompound] = Field(alias="a_objEzsignsignature") + __properties: ClassVar[List[str]] = ["a_objEzsignsignature"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigndocumentEditEzsignsignaturesV1Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigndocumentEditEzsignsignaturesV1Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_ezsignsignature (list) _items = [] if self.a_obj_ezsignsignature: @@ -64,16 +82,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigndocumentEditEzsignsignaturesV1Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigndocumentEditEzsignsignaturesV1Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigndocumentEditEzsignsignaturesV1Request.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigndocumentEditEzsignsignaturesV1Request.parse_obj({ - "a_obj_ezsignsignature": [EzsignsignatureRequestCompound.from_dict(_item) for _item in obj.get("a_objEzsignsignature")] if obj.get("a_objEzsignsignature") is not None else None + _obj = cls.model_validate({ + "a_objEzsignsignature": [EzsignsignatureRequestCompound.from_dict(_item) for _item in obj.get("a_objEzsignsignature")] if obj.get("a_objEzsignsignature") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigndocument_edit_ezsignsignatures_v1_response.py b/eZmaxApi/models/ezsigndocument_edit_ezsignsignatures_v1_response.py index 020fca122..dbd677c57 100644 --- a/eZmaxApi/models/ezsigndocument_edit_ezsignsignatures_v1_response.py +++ b/eZmaxApi/models/ezsigndocument_edit_ezsignsignatures_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.ezsigndocument_edit_ezsignsignatures_v1_response_m_payload import EzsigndocumentEditEzsignsignaturesV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigndocumentEditEzsignsignaturesV1Response(BaseModel): """ - Response for PUT /1/object/ezsigndocument/{pkiEzsigndocumentID}/editEzsignsignatures # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzsigndocumentEditEzsignsignaturesV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for PUT /1/object/ezsigndocument/{pkiEzsigndocumentID}/editEzsignsignatures + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsigndocumentEditEzsignsignaturesV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigndocumentEditEzsignsignaturesV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigndocumentEditEzsignsignaturesV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigndocumentEditEzsignsignaturesV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigndocumentEditEzsignsignaturesV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigndocumentEditEzsignsignaturesV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigndocumentEditEzsignsignaturesV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzsigndocumentEditEzsignsignaturesV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsigndocumentEditEzsignsignaturesV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigndocument_edit_ezsignsignatures_v1_response_m_payload.py b/eZmaxApi/models/ezsigndocument_edit_ezsignsignatures_v1_response_m_payload.py index 31927460a..5c7e247b0 100644 --- a/eZmaxApi/models/ezsigndocument_edit_ezsignsignatures_v1_response_m_payload.py +++ b/eZmaxApi/models/ezsigndocument_edit_ezsignsignatures_v1_response_m_payload.py @@ -19,53 +19,72 @@ import json -from typing import List -from pydantic import BaseModel, Field, conint, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigndocumentEditEzsignsignaturesV1ResponseMPayload(BaseModel): """ - Payload for PUT /1/object/ezsigndocument/{pkiEzsigndocumentID}/editEzsignsignatures # noqa: E501 - """ - a_pki_ezsignsignature_id: conlist(conint(strict=True, ge=0)) = Field(..., alias="a_pkiEzsignsignatureID") - __properties = ["a_pkiEzsignsignatureID"] + Payload for PUT /1/object/ezsigndocument/{pkiEzsigndocumentID}/editEzsignsignatures + """ # noqa: E501 + a_pki_ezsignsignature_id: List[Annotated[int, Field(strict=True, ge=0)]] = Field(alias="a_pkiEzsignsignatureID") + __properties: ClassVar[List[str]] = ["a_pkiEzsignsignatureID"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigndocumentEditEzsignsignaturesV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigndocumentEditEzsignsignaturesV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigndocumentEditEzsignsignaturesV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigndocumentEditEzsignsignaturesV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigndocumentEditEzsignsignaturesV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigndocumentEditEzsignsignaturesV1ResponseMPayload.parse_obj({ - "a_pki_ezsignsignature_id": obj.get("a_pkiEzsignsignatureID") + _obj = cls.model_validate({ + "a_pkiEzsignsignatureID": obj.get("a_pkiEzsignsignatureID") }) return _obj diff --git a/eZmaxApi/models/ezsigndocument_end_prematurely_v1_response.py b/eZmaxApi/models/ezsigndocument_end_prematurely_v1_response.py index b3384d1ce..f870abb9c 100644 --- a/eZmaxApi/models/ezsigndocument_end_prematurely_v1_response.py +++ b/eZmaxApi/models/ezsigndocument_end_prematurely_v1_response.py @@ -19,43 +19,61 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigndocumentEndPrematurelyV1Response(BaseModel): """ - Response for POST /1/object/ezsigndocument/{pkiEzsigndocument}/endPrematurely # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - __properties = ["objDebugPayload", "objDebug"] + Response for POST /1/object/ezsigndocument/{pkiEzsigndocument}/endPrematurely + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigndocumentEndPrematurelyV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigndocumentEndPrematurelyV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -65,17 +83,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigndocumentEndPrematurelyV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigndocumentEndPrematurelyV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigndocumentEndPrematurelyV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigndocumentEndPrematurelyV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigndocument_flatten_v1_response.py b/eZmaxApi/models/ezsigndocument_flatten_v1_response.py index eee1dafc9..ee29c3f5c 100644 --- a/eZmaxApi/models/ezsigndocument_flatten_v1_response.py +++ b/eZmaxApi/models/ezsigndocument_flatten_v1_response.py @@ -19,43 +19,61 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigndocumentFlattenV1Response(BaseModel): """ - Response for POST /1/object/ezsigndocument/{pkiEzsigndocument}/flatten # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - __properties = ["objDebugPayload", "objDebug"] + Response for POST /1/object/ezsigndocument/{pkiEzsigndocument}/flatten + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigndocumentFlattenV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigndocumentFlattenV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -65,17 +83,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigndocumentFlattenV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigndocumentFlattenV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigndocumentFlattenV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigndocumentFlattenV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigndocument_get_actionable_elements_v1_response.py b/eZmaxApi/models/ezsigndocument_get_actionable_elements_v1_response.py index c5b8c24ea..8547d6f49 100644 --- a/eZmaxApi/models/ezsigndocument_get_actionable_elements_v1_response.py +++ b/eZmaxApi/models/ezsigndocument_get_actionable_elements_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.ezsigndocument_get_actionable_elements_v1_response_m_payload import EzsigndocumentGetActionableElementsV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigndocumentGetActionableElementsV1Response(BaseModel): """ - Response for GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getActionableElements # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzsigndocumentGetActionableElementsV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getActionableElements + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsigndocumentGetActionableElementsV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigndocumentGetActionableElementsV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigndocumentGetActionableElementsV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigndocumentGetActionableElementsV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigndocumentGetActionableElementsV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigndocumentGetActionableElementsV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigndocumentGetActionableElementsV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzsigndocumentGetActionableElementsV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsigndocumentGetActionableElementsV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigndocument_get_actionable_elements_v1_response_m_payload.py b/eZmaxApi/models/ezsigndocument_get_actionable_elements_v1_response_m_payload.py index cc239b1fd..b87bf1b7f 100644 --- a/eZmaxApi/models/ezsigndocument_get_actionable_elements_v1_response_m_payload.py +++ b/eZmaxApi/models/ezsigndocument_get_actionable_elements_v1_response_m_payload.py @@ -19,43 +19,61 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.ezsignformfieldgroup_response_compound import EzsignformfieldgroupResponseCompound from eZmaxApi.models.ezsignsignature_response_compound import EzsignsignatureResponseCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigndocumentGetActionableElementsV1ResponseMPayload(BaseModel): """ - Payload for GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getActionableElements # noqa: E501 - """ - a_obj_ezsignsignature: conlist(EzsignsignatureResponseCompound) = Field(..., alias="a_objEzsignsignature") - a_obj_ezsignformfieldgroup: conlist(EzsignformfieldgroupResponseCompound) = Field(..., alias="a_objEzsignformfieldgroup") - __properties = ["a_objEzsignsignature", "a_objEzsignformfieldgroup"] + Payload for GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getActionableElements + """ # noqa: E501 + a_obj_ezsignsignature: List[EzsignsignatureResponseCompound] = Field(alias="a_objEzsignsignature") + a_obj_ezsignformfieldgroup: List[EzsignformfieldgroupResponseCompound] = Field(alias="a_objEzsignformfieldgroup") + __properties: ClassVar[List[str]] = ["a_objEzsignsignature", "a_objEzsignformfieldgroup"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigndocumentGetActionableElementsV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigndocumentGetActionableElementsV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_ezsignsignature (list) _items = [] if self.a_obj_ezsignsignature: @@ -73,17 +91,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigndocumentGetActionableElementsV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigndocumentGetActionableElementsV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigndocumentGetActionableElementsV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigndocumentGetActionableElementsV1ResponseMPayload.parse_obj({ - "a_obj_ezsignsignature": [EzsignsignatureResponseCompound.from_dict(_item) for _item in obj.get("a_objEzsignsignature")] if obj.get("a_objEzsignsignature") is not None else None, - "a_obj_ezsignformfieldgroup": [EzsignformfieldgroupResponseCompound.from_dict(_item) for _item in obj.get("a_objEzsignformfieldgroup")] if obj.get("a_objEzsignformfieldgroup") is not None else None + _obj = cls.model_validate({ + "a_objEzsignsignature": [EzsignsignatureResponseCompound.from_dict(_item) for _item in obj.get("a_objEzsignsignature")] if obj.get("a_objEzsignsignature") is not None else None, + "a_objEzsignformfieldgroup": [EzsignformfieldgroupResponseCompound.from_dict(_item) for _item in obj.get("a_objEzsignformfieldgroup")] if obj.get("a_objEzsignformfieldgroup") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigndocument_get_attachments_v1_response.py b/eZmaxApi/models/ezsigndocument_get_attachments_v1_response.py new file mode 100644 index 000000000..04f9bde89 --- /dev/null +++ b/eZmaxApi/models/ezsigndocument_get_attachments_v1_response.py @@ -0,0 +1,106 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field +from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug +from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +from eZmaxApi.models.ezsigndocument_get_attachments_v1_response_m_payload import EzsigndocumentGetAttachmentsV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self + +class EzsigndocumentGetAttachmentsV1Response(BaseModel): + """ + Response for GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getAttachments + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsigndocumentGetAttachmentsV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of EzsigndocumentGetAttachmentsV1Response from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of obj_debug_payload + if self.obj_debug_payload: + _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() + # override the default output from pydantic by calling `to_dict()` of obj_debug + if self.obj_debug: + _dict['objDebug'] = self.obj_debug.to_dict() + # override the default output from pydantic by calling `to_dict()` of m_payload + if self.m_payload: + _dict['mPayload'] = self.m_payload.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Dict) -> Self: + """Create an instance of EzsigndocumentGetAttachmentsV1Response from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsigndocumentGetAttachmentsV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + }) + return _obj + + diff --git a/eZmaxApi/models/ezsigndocument_get_attachments_v1_response_m_payload.py b/eZmaxApi/models/ezsigndocument_get_attachments_v1_response_m_payload.py new file mode 100644 index 000000000..352f6b1ce --- /dev/null +++ b/eZmaxApi/models/ezsigndocument_get_attachments_v1_response_m_payload.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from eZmaxApi.models.custom_attachmentdocumenttype_response import CustomAttachmentdocumenttypeResponse +try: + from typing import Self +except ImportError: + from typing_extensions import Self + +class EzsigndocumentGetAttachmentsV1ResponseMPayload(BaseModel): + """ + Response for GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getAttachments + """ # noqa: E501 + a_obj_attachmentdocumenttype: List[CustomAttachmentdocumenttypeResponse] = Field(alias="a_objAttachmentdocumenttype") + __properties: ClassVar[List[str]] = ["a_objAttachmentdocumenttype"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of EzsigndocumentGetAttachmentsV1ResponseMPayload from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in a_obj_attachmentdocumenttype (list) + _items = [] + if self.a_obj_attachmentdocumenttype: + for _item in self.a_obj_attachmentdocumenttype: + if _item: + _items.append(_item.to_dict()) + _dict['a_objAttachmentdocumenttype'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Dict) -> Self: + """Create an instance of EzsigndocumentGetAttachmentsV1ResponseMPayload from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "a_objAttachmentdocumenttype": [CustomAttachmentdocumenttypeResponse.from_dict(_item) for _item in obj.get("a_objAttachmentdocumenttype")] if obj.get("a_objAttachmentdocumenttype") is not None else None + }) + return _obj + + diff --git a/eZmaxApi/models/ezsigndocument_get_completed_elements_v1_response.py b/eZmaxApi/models/ezsigndocument_get_completed_elements_v1_response.py index 69b993400..e29150244 100644 --- a/eZmaxApi/models/ezsigndocument_get_completed_elements_v1_response.py +++ b/eZmaxApi/models/ezsigndocument_get_completed_elements_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.ezsigndocument_get_completed_elements_v1_response_m_payload import EzsigndocumentGetCompletedElementsV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigndocumentGetCompletedElementsV1Response(BaseModel): """ - Response for GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getCompletedElements # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzsigndocumentGetCompletedElementsV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getCompletedElements + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsigndocumentGetCompletedElementsV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigndocumentGetCompletedElementsV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigndocumentGetCompletedElementsV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigndocumentGetCompletedElementsV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigndocumentGetCompletedElementsV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigndocumentGetCompletedElementsV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigndocumentGetCompletedElementsV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzsigndocumentGetCompletedElementsV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsigndocumentGetCompletedElementsV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigndocument_get_completed_elements_v1_response_m_payload.py b/eZmaxApi/models/ezsigndocument_get_completed_elements_v1_response_m_payload.py index 490809099..0f5d0634f 100644 --- a/eZmaxApi/models/ezsigndocument_get_completed_elements_v1_response_m_payload.py +++ b/eZmaxApi/models/ezsigndocument_get_completed_elements_v1_response_m_payload.py @@ -19,43 +19,61 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.ezsignformfieldgroup_response_compound import EzsignformfieldgroupResponseCompound from eZmaxApi.models.ezsignsignature_response_compound import EzsignsignatureResponseCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigndocumentGetCompletedElementsV1ResponseMPayload(BaseModel): """ - Payload for GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getCompletedElements # noqa: E501 - """ - a_obj_ezsignsignature: conlist(EzsignsignatureResponseCompound) = Field(..., alias="a_objEzsignsignature") - a_obj_ezsignformfieldgroup: conlist(EzsignformfieldgroupResponseCompound) = Field(..., alias="a_objEzsignformfieldgroup") - __properties = ["a_objEzsignsignature", "a_objEzsignformfieldgroup"] + Payload for GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getCompletedElements + """ # noqa: E501 + a_obj_ezsignsignature: List[EzsignsignatureResponseCompound] = Field(alias="a_objEzsignsignature") + a_obj_ezsignformfieldgroup: List[EzsignformfieldgroupResponseCompound] = Field(alias="a_objEzsignformfieldgroup") + __properties: ClassVar[List[str]] = ["a_objEzsignsignature", "a_objEzsignformfieldgroup"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigndocumentGetCompletedElementsV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigndocumentGetCompletedElementsV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_ezsignsignature (list) _items = [] if self.a_obj_ezsignsignature: @@ -73,17 +91,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigndocumentGetCompletedElementsV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigndocumentGetCompletedElementsV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigndocumentGetCompletedElementsV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigndocumentGetCompletedElementsV1ResponseMPayload.parse_obj({ - "a_obj_ezsignsignature": [EzsignsignatureResponseCompound.from_dict(_item) for _item in obj.get("a_objEzsignsignature")] if obj.get("a_objEzsignsignature") is not None else None, - "a_obj_ezsignformfieldgroup": [EzsignformfieldgroupResponseCompound.from_dict(_item) for _item in obj.get("a_objEzsignformfieldgroup")] if obj.get("a_objEzsignformfieldgroup") is not None else None + _obj = cls.model_validate({ + "a_objEzsignsignature": [EzsignsignatureResponseCompound.from_dict(_item) for _item in obj.get("a_objEzsignsignature")] if obj.get("a_objEzsignsignature") is not None else None, + "a_objEzsignformfieldgroup": [EzsignformfieldgroupResponseCompound.from_dict(_item) for _item in obj.get("a_objEzsignformfieldgroup")] if obj.get("a_objEzsignformfieldgroup") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigndocument_get_download_url_v1_response.py b/eZmaxApi/models/ezsigndocument_get_download_url_v1_response.py index 60a7b0144..a8d555160 100644 --- a/eZmaxApi/models/ezsigndocument_get_download_url_v1_response.py +++ b/eZmaxApi/models/ezsigndocument_get_download_url_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.ezsigndocument_get_download_url_v1_response_m_payload import EzsigndocumentGetDownloadUrlV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigndocumentGetDownloadUrlV1Response(BaseModel): """ - Response for GET /1/object/ezsigndocument/{pkiEzsigndocument}/getDownloadUrl # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzsigndocumentGetDownloadUrlV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /1/object/ezsigndocument/{pkiEzsigndocument}/getDownloadUrl + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsigndocumentGetDownloadUrlV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigndocumentGetDownloadUrlV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigndocumentGetDownloadUrlV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigndocumentGetDownloadUrlV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigndocumentGetDownloadUrlV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigndocumentGetDownloadUrlV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigndocumentGetDownloadUrlV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzsigndocumentGetDownloadUrlV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsigndocumentGetDownloadUrlV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigndocument_get_download_url_v1_response_m_payload.py b/eZmaxApi/models/ezsigndocument_get_download_url_v1_response_m_payload.py index 075a35ad6..00f9e1176 100644 --- a/eZmaxApi/models/ezsigndocument_get_download_url_v1_response_m_payload.py +++ b/eZmaxApi/models/ezsigndocument_get_download_url_v1_response_m_payload.py @@ -19,53 +19,71 @@ import json - -from pydantic import BaseModel, Field, StrictStr +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictStr +from pydantic import Field +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigndocumentGetDownloadUrlV1ResponseMPayload(BaseModel): """ - Payload for GET /1/object/ezsigndocument/{pkiEzsigndocument}/getDownloadUrl # noqa: E501 - """ - s_download_url: StrictStr = Field(..., alias="sDownloadUrl", description="The Url to the requested document. Url will expire after 5 minutes.") - __properties = ["sDownloadUrl"] + Payload for GET /1/object/ezsigndocument/{pkiEzsigndocument}/getDownloadUrl + """ # noqa: E501 + s_download_url: StrictStr = Field(description="The Url to the requested document. Url will expire after 5 minutes.", alias="sDownloadUrl") + __properties: ClassVar[List[str]] = ["sDownloadUrl"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigndocumentGetDownloadUrlV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigndocumentGetDownloadUrlV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigndocumentGetDownloadUrlV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigndocumentGetDownloadUrlV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigndocumentGetDownloadUrlV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigndocumentGetDownloadUrlV1ResponseMPayload.parse_obj({ - "s_download_url": obj.get("sDownloadUrl") + _obj = cls.model_validate({ + "sDownloadUrl": obj.get("sDownloadUrl") }) return _obj diff --git a/eZmaxApi/models/ezsigndocument_get_ezsignannotations_v1_response.py b/eZmaxApi/models/ezsigndocument_get_ezsignannotations_v1_response.py index 540df8cef..d792b59db 100644 --- a/eZmaxApi/models/ezsigndocument_get_ezsignannotations_v1_response.py +++ b/eZmaxApi/models/ezsigndocument_get_ezsignannotations_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.ezsigndocument_get_ezsignannotations_v1_response_m_payload import EzsigndocumentGetEzsignannotationsV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigndocumentGetEzsignannotationsV1Response(BaseModel): """ - Response for GET /1/object/ezsigndocument/{pkiEzsigndocument}/getEzsignannotations # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzsigndocumentGetEzsignannotationsV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /1/object/ezsigndocument/{pkiEzsigndocument}/getEzsignannotations + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsigndocumentGetEzsignannotationsV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigndocumentGetEzsignannotationsV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigndocumentGetEzsignannotationsV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigndocumentGetEzsignannotationsV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigndocumentGetEzsignannotationsV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigndocumentGetEzsignannotationsV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigndocumentGetEzsignannotationsV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzsigndocumentGetEzsignannotationsV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsigndocumentGetEzsignannotationsV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigndocument_get_ezsignannotations_v1_response_m_payload.py b/eZmaxApi/models/ezsigndocument_get_ezsignannotations_v1_response_m_payload.py index 30a24aec9..f13677b97 100644 --- a/eZmaxApi/models/ezsigndocument_get_ezsignannotations_v1_response_m_payload.py +++ b/eZmaxApi/models/ezsigndocument_get_ezsignannotations_v1_response_m_payload.py @@ -19,41 +19,59 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.ezsignannotation_response_compound import EzsignannotationResponseCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigndocumentGetEzsignannotationsV1ResponseMPayload(BaseModel): """ - Payload for GET /1/object/ezsigndocument/{pkiEzsigndocument}/getEzsignannotations # noqa: E501 - """ - a_obj_ezsignannotation: conlist(EzsignannotationResponseCompound) = Field(..., alias="a_objEzsignannotation") - __properties = ["a_objEzsignannotation"] + Payload for GET /1/object/ezsigndocument/{pkiEzsigndocument}/getEzsignannotations + """ # noqa: E501 + a_obj_ezsignannotation: List[EzsignannotationResponseCompound] = Field(alias="a_objEzsignannotation") + __properties: ClassVar[List[str]] = ["a_objEzsignannotation"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigndocumentGetEzsignannotationsV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigndocumentGetEzsignannotationsV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_ezsignannotation (list) _items = [] if self.a_obj_ezsignannotation: @@ -64,16 +82,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigndocumentGetEzsignannotationsV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigndocumentGetEzsignannotationsV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigndocumentGetEzsignannotationsV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigndocumentGetEzsignannotationsV1ResponseMPayload.parse_obj({ - "a_obj_ezsignannotation": [EzsignannotationResponseCompound.from_dict(_item) for _item in obj.get("a_objEzsignannotation")] if obj.get("a_objEzsignannotation") is not None else None + _obj = cls.model_validate({ + "a_objEzsignannotation": [EzsignannotationResponseCompound.from_dict(_item) for _item in obj.get("a_objEzsignannotation")] if obj.get("a_objEzsignannotation") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigndocument_get_ezsignformfieldgroups_v1_response.py b/eZmaxApi/models/ezsigndocument_get_ezsignformfieldgroups_v1_response.py index 228c3498d..6be7693e3 100644 --- a/eZmaxApi/models/ezsigndocument_get_ezsignformfieldgroups_v1_response.py +++ b/eZmaxApi/models/ezsigndocument_get_ezsignformfieldgroups_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.ezsigndocument_get_ezsignformfieldgroups_v1_response_m_payload import EzsigndocumentGetEzsignformfieldgroupsV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigndocumentGetEzsignformfieldgroupsV1Response(BaseModel): """ - Response for GET /1/object/ezsigndocument/{pkiEzsigndocument}/getEzsignformfieldgroups # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzsigndocumentGetEzsignformfieldgroupsV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /1/object/ezsigndocument/{pkiEzsigndocument}/getEzsignformfieldgroups + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsigndocumentGetEzsignformfieldgroupsV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigndocumentGetEzsignformfieldgroupsV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigndocumentGetEzsignformfieldgroupsV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigndocumentGetEzsignformfieldgroupsV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigndocumentGetEzsignformfieldgroupsV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigndocumentGetEzsignformfieldgroupsV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigndocumentGetEzsignformfieldgroupsV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzsigndocumentGetEzsignformfieldgroupsV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsigndocumentGetEzsignformfieldgroupsV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigndocument_get_ezsignformfieldgroups_v1_response_m_payload.py b/eZmaxApi/models/ezsigndocument_get_ezsignformfieldgroups_v1_response_m_payload.py index 26af6bad9..da73644b3 100644 --- a/eZmaxApi/models/ezsigndocument_get_ezsignformfieldgroups_v1_response_m_payload.py +++ b/eZmaxApi/models/ezsigndocument_get_ezsignformfieldgroups_v1_response_m_payload.py @@ -19,41 +19,59 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.ezsignformfieldgroup_response_compound import EzsignformfieldgroupResponseCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigndocumentGetEzsignformfieldgroupsV1ResponseMPayload(BaseModel): """ - Payload for GET /1/object/ezsigndocument/{pkiEzsigndocument}/getEzsignformfieldgroups # noqa: E501 - """ - a_obj_ezsignformfieldgroup: conlist(EzsignformfieldgroupResponseCompound) = Field(..., alias="a_objEzsignformfieldgroup") - __properties = ["a_objEzsignformfieldgroup"] + Payload for GET /1/object/ezsigndocument/{pkiEzsigndocument}/getEzsignformfieldgroups + """ # noqa: E501 + a_obj_ezsignformfieldgroup: List[EzsignformfieldgroupResponseCompound] = Field(alias="a_objEzsignformfieldgroup") + __properties: ClassVar[List[str]] = ["a_objEzsignformfieldgroup"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigndocumentGetEzsignformfieldgroupsV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigndocumentGetEzsignformfieldgroupsV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_ezsignformfieldgroup (list) _items = [] if self.a_obj_ezsignformfieldgroup: @@ -64,16 +82,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigndocumentGetEzsignformfieldgroupsV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigndocumentGetEzsignformfieldgroupsV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigndocumentGetEzsignformfieldgroupsV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigndocumentGetEzsignformfieldgroupsV1ResponseMPayload.parse_obj({ - "a_obj_ezsignformfieldgroup": [EzsignformfieldgroupResponseCompound.from_dict(_item) for _item in obj.get("a_objEzsignformfieldgroup")] if obj.get("a_objEzsignformfieldgroup") is not None else None + _obj = cls.model_validate({ + "a_objEzsignformfieldgroup": [EzsignformfieldgroupResponseCompound.from_dict(_item) for _item in obj.get("a_objEzsignformfieldgroup")] if obj.get("a_objEzsignformfieldgroup") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigndocument_get_ezsignpages_v1_response.py b/eZmaxApi/models/ezsigndocument_get_ezsignpages_v1_response.py index 85fdec28f..0f30b9720 100644 --- a/eZmaxApi/models/ezsigndocument_get_ezsignpages_v1_response.py +++ b/eZmaxApi/models/ezsigndocument_get_ezsignpages_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.ezsigndocument_get_ezsignpages_v1_response_m_payload import EzsigndocumentGetEzsignpagesV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigndocumentGetEzsignpagesV1Response(BaseModel): """ - Response for GET /1/object/ezsigndocument/{pkiEzsigndocument}/getEzsignpages # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzsigndocumentGetEzsignpagesV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /1/object/ezsigndocument/{pkiEzsigndocument}/getEzsignpages + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsigndocumentGetEzsignpagesV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigndocumentGetEzsignpagesV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigndocumentGetEzsignpagesV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigndocumentGetEzsignpagesV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigndocumentGetEzsignpagesV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigndocumentGetEzsignpagesV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigndocumentGetEzsignpagesV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzsigndocumentGetEzsignpagesV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsigndocumentGetEzsignpagesV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigndocument_get_ezsignpages_v1_response_m_payload.py b/eZmaxApi/models/ezsigndocument_get_ezsignpages_v1_response_m_payload.py index bf22d0314..343024852 100644 --- a/eZmaxApi/models/ezsigndocument_get_ezsignpages_v1_response_m_payload.py +++ b/eZmaxApi/models/ezsigndocument_get_ezsignpages_v1_response_m_payload.py @@ -19,41 +19,59 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.ezsignpage_response_compound import EzsignpageResponseCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigndocumentGetEzsignpagesV1ResponseMPayload(BaseModel): """ - Payload for GET /1/object/ezsigndocument/{pkiEzsigndocument}/getEzsignpages # noqa: E501 - """ - a_obj_ezsignpage: conlist(EzsignpageResponseCompound) = Field(..., alias="a_objEzsignpage") - __properties = ["a_objEzsignpage"] + Payload for GET /1/object/ezsigndocument/{pkiEzsigndocument}/getEzsignpages + """ # noqa: E501 + a_obj_ezsignpage: List[EzsignpageResponseCompound] = Field(alias="a_objEzsignpage") + __properties: ClassVar[List[str]] = ["a_objEzsignpage"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigndocumentGetEzsignpagesV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigndocumentGetEzsignpagesV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_ezsignpage (list) _items = [] if self.a_obj_ezsignpage: @@ -64,16 +82,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigndocumentGetEzsignpagesV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigndocumentGetEzsignpagesV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigndocumentGetEzsignpagesV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigndocumentGetEzsignpagesV1ResponseMPayload.parse_obj({ - "a_obj_ezsignpage": [EzsignpageResponseCompound.from_dict(_item) for _item in obj.get("a_objEzsignpage")] if obj.get("a_objEzsignpage") is not None else None + _obj = cls.model_validate({ + "a_objEzsignpage": [EzsignpageResponseCompound.from_dict(_item) for _item in obj.get("a_objEzsignpage")] if obj.get("a_objEzsignpage") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigndocument_get_ezsignsignatures_automatic_v1_response.py b/eZmaxApi/models/ezsigndocument_get_ezsignsignatures_automatic_v1_response.py index bdc5c0f1a..191a6e008 100644 --- a/eZmaxApi/models/ezsigndocument_get_ezsignsignatures_automatic_v1_response.py +++ b/eZmaxApi/models/ezsigndocument_get_ezsignsignatures_automatic_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.ezsigndocument_get_ezsignsignatures_automatic_v1_response_m_payload import EzsigndocumentGetEzsignsignaturesAutomaticV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigndocumentGetEzsignsignaturesAutomaticV1Response(BaseModel): """ - Response for GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getEzsignsignaturesAutomatic # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzsigndocumentGetEzsignsignaturesAutomaticV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getEzsignsignaturesAutomatic + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsigndocumentGetEzsignsignaturesAutomaticV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigndocumentGetEzsignsignaturesAutomaticV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigndocumentGetEzsignsignaturesAutomaticV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigndocumentGetEzsignsignaturesAutomaticV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigndocumentGetEzsignsignaturesAutomaticV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigndocumentGetEzsignsignaturesAutomaticV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigndocumentGetEzsignsignaturesAutomaticV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzsigndocumentGetEzsignsignaturesAutomaticV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsigndocumentGetEzsignsignaturesAutomaticV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigndocument_get_ezsignsignatures_automatic_v1_response_m_payload.py b/eZmaxApi/models/ezsigndocument_get_ezsignsignatures_automatic_v1_response_m_payload.py index 39bafeb59..d4ac05237 100644 --- a/eZmaxApi/models/ezsigndocument_get_ezsignsignatures_automatic_v1_response_m_payload.py +++ b/eZmaxApi/models/ezsigndocument_get_ezsignsignatures_automatic_v1_response_m_payload.py @@ -19,43 +19,61 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.custom_ezsignfolder_ezsignsignatures_automatic_response import CustomEzsignfolderEzsignsignaturesAutomaticResponse from eZmaxApi.models.field_e_ezsignsignature_type import FieldEEzsignsignatureType +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigndocumentGetEzsignsignaturesAutomaticV1ResponseMPayload(BaseModel): """ - Payload for GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getEzsignsignaturesAutomatic # noqa: E501 - """ - a_e_ezsignsignature_type: conlist(FieldEEzsignsignatureType, unique_items=True) = Field(..., alias="a_eEzsignsignatureType", description="All eEzsignsignatureType contained in the response") - a_obj_ezsignfolder: conlist(CustomEzsignfolderEzsignsignaturesAutomaticResponse) = Field(..., alias="a_objEzsignfolder") - __properties = ["a_eEzsignsignatureType", "a_objEzsignfolder"] + Payload for GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getEzsignsignaturesAutomatic + """ # noqa: E501 + a_e_ezsignsignature_type: List[FieldEEzsignsignatureType] = Field(description="All eEzsignsignatureType contained in the response", alias="a_eEzsignsignatureType") + a_obj_ezsignfolder: List[CustomEzsignfolderEzsignsignaturesAutomaticResponse] = Field(alias="a_objEzsignfolder") + __properties: ClassVar[List[str]] = ["a_eEzsignsignatureType", "a_objEzsignfolder"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigndocumentGetEzsignsignaturesAutomaticV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigndocumentGetEzsignsignaturesAutomaticV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_ezsignfolder (list) _items = [] if self.a_obj_ezsignfolder: @@ -66,17 +84,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigndocumentGetEzsignsignaturesAutomaticV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigndocumentGetEzsignsignaturesAutomaticV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigndocumentGetEzsignsignaturesAutomaticV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigndocumentGetEzsignsignaturesAutomaticV1ResponseMPayload.parse_obj({ - "a_e_ezsignsignature_type": obj.get("a_eEzsignsignatureType"), - "a_obj_ezsignfolder": [CustomEzsignfolderEzsignsignaturesAutomaticResponse.from_dict(_item) for _item in obj.get("a_objEzsignfolder")] if obj.get("a_objEzsignfolder") is not None else None + _obj = cls.model_validate({ + "a_eEzsignsignatureType": obj.get("a_eEzsignsignatureType"), + "a_objEzsignfolder": [CustomEzsignfolderEzsignsignaturesAutomaticResponse.from_dict(_item) for _item in obj.get("a_objEzsignfolder")] if obj.get("a_objEzsignfolder") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigndocument_get_ezsignsignatures_v1_response.py b/eZmaxApi/models/ezsigndocument_get_ezsignsignatures_v1_response.py index 202c3008d..909e1217c 100644 --- a/eZmaxApi/models/ezsigndocument_get_ezsignsignatures_v1_response.py +++ b/eZmaxApi/models/ezsigndocument_get_ezsignsignatures_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.ezsigndocument_get_ezsignsignatures_v1_response_m_payload import EzsigndocumentGetEzsignsignaturesV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigndocumentGetEzsignsignaturesV1Response(BaseModel): """ - Response for GET /1/object/ezsigndocument/{pkiEzsigndocument}/getEzsignsignatures # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzsigndocumentGetEzsignsignaturesV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /1/object/ezsigndocument/{pkiEzsigndocument}/getEzsignsignatures + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsigndocumentGetEzsignsignaturesV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigndocumentGetEzsignsignaturesV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigndocumentGetEzsignsignaturesV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigndocumentGetEzsignsignaturesV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigndocumentGetEzsignsignaturesV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigndocumentGetEzsignsignaturesV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigndocumentGetEzsignsignaturesV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzsigndocumentGetEzsignsignaturesV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsigndocumentGetEzsignsignaturesV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigndocument_get_ezsignsignatures_v1_response_m_payload.py b/eZmaxApi/models/ezsigndocument_get_ezsignsignatures_v1_response_m_payload.py index 195394c01..57bc8940f 100644 --- a/eZmaxApi/models/ezsigndocument_get_ezsignsignatures_v1_response_m_payload.py +++ b/eZmaxApi/models/ezsigndocument_get_ezsignsignatures_v1_response_m_payload.py @@ -19,41 +19,59 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.ezsignsignature_response_compound import EzsignsignatureResponseCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigndocumentGetEzsignsignaturesV1ResponseMPayload(BaseModel): """ - Payload for GET /1/object/ezsigndocument/{pkiEzsigndocument}/getEzsignsignatures # noqa: E501 - """ - a_obj_ezsignsignature: conlist(EzsignsignatureResponseCompound) = Field(..., alias="a_objEzsignsignature") - __properties = ["a_objEzsignsignature"] + Payload for GET /1/object/ezsigndocument/{pkiEzsigndocument}/getEzsignsignatures + """ # noqa: E501 + a_obj_ezsignsignature: List[EzsignsignatureResponseCompound] = Field(alias="a_objEzsignsignature") + __properties: ClassVar[List[str]] = ["a_objEzsignsignature"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigndocumentGetEzsignsignaturesV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigndocumentGetEzsignsignaturesV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_ezsignsignature (list) _items = [] if self.a_obj_ezsignsignature: @@ -64,16 +82,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigndocumentGetEzsignsignaturesV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigndocumentGetEzsignsignaturesV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigndocumentGetEzsignsignaturesV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigndocumentGetEzsignsignaturesV1ResponseMPayload.parse_obj({ - "a_obj_ezsignsignature": [EzsignsignatureResponseCompound.from_dict(_item) for _item in obj.get("a_objEzsignsignature")] if obj.get("a_objEzsignsignature") is not None else None + _obj = cls.model_validate({ + "a_objEzsignsignature": [EzsignsignatureResponseCompound.from_dict(_item) for _item in obj.get("a_objEzsignsignature")] if obj.get("a_objEzsignsignature") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigndocument_get_form_data_v1_response.py b/eZmaxApi/models/ezsigndocument_get_form_data_v1_response.py index 3810d63e7..ade210d1f 100644 --- a/eZmaxApi/models/ezsigndocument_get_form_data_v1_response.py +++ b/eZmaxApi/models/ezsigndocument_get_form_data_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.ezsigndocument_get_form_data_v1_response_m_payload import EzsigndocumentGetFormDataV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigndocumentGetFormDataV1Response(BaseModel): """ - Response for GET /1/object/ezsigndocument/{pkiEzsigndocument}/getFormData # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzsigndocumentGetFormDataV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /1/object/ezsigndocument/{pkiEzsigndocument}/getFormData + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsigndocumentGetFormDataV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigndocumentGetFormDataV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigndocumentGetFormDataV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigndocumentGetFormDataV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigndocumentGetFormDataV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigndocumentGetFormDataV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigndocumentGetFormDataV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzsigndocumentGetFormDataV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsigndocumentGetFormDataV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigndocument_get_form_data_v1_response_m_payload.py b/eZmaxApi/models/ezsigndocument_get_form_data_v1_response_m_payload.py index 54ee26ccd..cf801b2d0 100644 --- a/eZmaxApi/models/ezsigndocument_get_form_data_v1_response_m_payload.py +++ b/eZmaxApi/models/ezsigndocument_get_form_data_v1_response_m_payload.py @@ -19,57 +19,75 @@ import json - -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.custom_form_data_document_response import CustomFormDataDocumentResponse +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigndocumentGetFormDataV1ResponseMPayload(BaseModel): """ - Payload for GET /1/object/ezsigndocument/{pkiEzsigndocument}/getFormData # noqa: E501 - """ - obj_form_data_document: CustomFormDataDocumentResponse = Field(..., alias="objFormDataDocument") - __properties = ["objFormDataDocument"] + Payload for GET /1/object/ezsigndocument/{pkiEzsigndocument}/getFormData + """ # noqa: E501 + obj_form_data_document: CustomFormDataDocumentResponse = Field(alias="objFormDataDocument") + __properties: ClassVar[List[str]] = ["objFormDataDocument"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigndocumentGetFormDataV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigndocumentGetFormDataV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_form_data_document if self.obj_form_data_document: _dict['objFormDataDocument'] = self.obj_form_data_document.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigndocumentGetFormDataV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigndocumentGetFormDataV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigndocumentGetFormDataV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigndocumentGetFormDataV1ResponseMPayload.parse_obj({ - "obj_form_data_document": CustomFormDataDocumentResponse.from_dict(obj.get("objFormDataDocument")) if obj.get("objFormDataDocument") is not None else None + _obj = cls.model_validate({ + "objFormDataDocument": CustomFormDataDocumentResponse.from_dict(obj.get("objFormDataDocument")) if obj.get("objFormDataDocument") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigndocument_get_object_v1_response.py b/eZmaxApi/models/ezsigndocument_get_object_v1_response.py index f3776a4e5..edf599714 100644 --- a/eZmaxApi/models/ezsigndocument_get_object_v1_response.py +++ b/eZmaxApi/models/ezsigndocument_get_object_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.ezsigndocument_get_object_v1_response_m_payload import EzsigndocumentGetObjectV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigndocumentGetObjectV1Response(BaseModel): """ - Response for GET /1/object/ezsigndocument/{pkiEzsigndocumentID} # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzsigndocumentGetObjectV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /1/object/ezsigndocument/{pkiEzsigndocumentID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsigndocumentGetObjectV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigndocumentGetObjectV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigndocumentGetObjectV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigndocumentGetObjectV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigndocumentGetObjectV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigndocumentGetObjectV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigndocumentGetObjectV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzsigndocumentGetObjectV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsigndocumentGetObjectV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigndocument_get_object_v1_response_m_payload.py b/eZmaxApi/models/ezsigndocument_get_object_v1_response_m_payload.py index 0e9ee57d1..d407c478a 100644 --- a/eZmaxApi/models/ezsigndocument_get_object_v1_response_m_payload.py +++ b/eZmaxApi/models/ezsigndocument_get_object_v1_response_m_payload.py @@ -19,47 +19,54 @@ import json -from typing import List, Optional -from pydantic import BaseModel, Field, StrictBool, StrictInt, StrictStr, conint, conlist, constr, validator +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, StrictInt, StrictStr, field_validator +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.common_audit import CommonAudit from eZmaxApi.models.computed_e_ezsigndocument_steptype import ComputedEEzsigndocumentSteptype from eZmaxApi.models.custom_ezsignfoldersignerassociationstatus_response import CustomEzsignfoldersignerassociationstatusResponse from eZmaxApi.models.field_e_ezsigndocument_step import FieldEEzsigndocumentStep +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigndocumentGetObjectV1ResponseMPayload(BaseModel): """ - Payload for GET /1/object/ezsigndocument/{pkiEzsigndocumentID} # noqa: E501 - """ - pki_ezsigndocument_id: conint(strict=True, ge=0) = Field(..., alias="pkiEzsigndocumentID", description="The unique ID of the Ezsigndocument") - fki_ezsignfolder_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsignfolderID", description="The unique ID of the Ezsignfolder") - fki_ezsignfoldersignerassociation_id_declinedtosign: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiEzsignfoldersignerassociationIDDeclinedtosign", description="The unique ID of the Ezsignfoldersignerassociation") - dt_ezsigndocument_duedate: StrictStr = Field(..., alias="dtEzsigndocumentDuedate", description="The maximum date and time at which the Ezsigndocument can be signed.") - dt_ezsignform_completed: Optional[StrictStr] = Field(None, alias="dtEzsignformCompleted", description="The date and time at which the Ezsignform has been completed.") - fki_language_id: Optional[conint(strict=True, le=2, ge=1)] = Field(None, alias="fkiLanguageID", description="The unique ID of the Language. Valid values: |Value|Description| |-|-| |1|French| |2|English|") - s_ezsigndocument_name: StrictStr = Field(..., alias="sEzsigndocumentName", description="The name of the document that will be presented to Ezsignfoldersignerassociations") - e_ezsigndocument_step: FieldEEzsigndocumentStep = Field(..., alias="eEzsigndocumentStep") - dt_ezsigndocument_firstsend: Optional[StrictStr] = Field(None, alias="dtEzsigndocumentFirstsend", description="The date and time when the Ezsigndocument was first sent.") - dt_ezsigndocument_lastsend: Optional[StrictStr] = Field(None, alias="dtEzsigndocumentLastsend", description="The date and time when the Ezsigndocument was sent the last time.") - i_ezsigndocument_order: conint(strict=True, ge=1) = Field(..., alias="iEzsigndocumentOrder", description="The order in which the Ezsigndocument will be presented to the signatory in the Ezsignfolder.") - i_ezsigndocument_pagetotal: conint(strict=True, ge=1) = Field(..., alias="iEzsigndocumentPagetotal", description="The number of pages in the Ezsigndocument.") - i_ezsigndocument_signaturesigned: conint(strict=True, ge=0) = Field(..., alias="iEzsigndocumentSignaturesigned", description="The number of signatures that were signed in the document.") - i_ezsigndocument_signaturetotal: conint(strict=True, ge=0) = Field(..., alias="iEzsigndocumentSignaturetotal", description="The number of total signatures that were requested in the Ezsigndocument.") - s_ezsigndocument_md5initial: Optional[StrictStr] = Field(None, alias="sEzsigndocumentMD5initial", description="MD5 Hash of the initial PDF Document before signatures were applied to it.") - t_ezsigndocument_declinedtosignreason: Optional[StrictStr] = Field(None, alias="tEzsigndocumentDeclinedtosignreason", description="A custom text message that will contain the refusal message if the Ezsigndocument is declined to sign") - s_ezsigndocument_md5signed: Optional[StrictStr] = Field(None, alias="sEzsigndocumentMD5signed", description="MD5 Hash of the final PDF Document after all signatures were applied to it.") - b_ezsigndocument_ezsignform: Optional[StrictBool] = Field(None, alias="bEzsigndocumentEzsignform", description="If the Ezsigndocument contains an Ezsignform or not") - b_ezsigndocument_hassignedsignatures: Optional[StrictBool] = Field(None, alias="bEzsigndocumentHassignedsignatures", description="If the Ezsigndocument contains signed signatures (From internal or external sources)") - obj_audit: Optional[CommonAudit] = Field(None, alias="objAudit") - s_ezsigndocument_externalid: Optional[constr(strict=True)] = Field(None, alias="sEzsigndocumentExternalid", description="This field can be used to store an External ID from the client's system. Anything can be stored in this field, it will never be evaluated by the eZmax system and will be returned AS-IS. To store multiple values, consider using a JSON formatted structure, a URL encoded string, a CSV or any other custom format. ") - e_ezsigndocument_steptype: ComputedEEzsigndocumentSteptype = Field(..., alias="eEzsigndocumentSteptype") - i_ezsigndocument_stepformtotal: StrictInt = Field(..., alias="iEzsigndocumentStepformtotal", description="The total number of steps in the form filling phase") - i_ezsigndocument_stepformcurrent: StrictInt = Field(..., alias="iEzsigndocumentStepformcurrent", description="The current step in the form filling phase") - i_ezsigndocument_stepsignaturetotal: StrictInt = Field(..., alias="iEzsigndocumentStepsignaturetotal", description="The total number of steps in the signature filling phase") - i_ezsigndocument_stepsignature_current: StrictInt = Field(..., alias="iEzsigndocumentStepsignatureCurrent", description="The current step in the signature phase") - a_obj_ezsignfoldersignerassociationstatus: conlist(CustomEzsignfoldersignerassociationstatusResponse) = Field(..., alias="a_objEzsignfoldersignerassociationstatus") - __properties = ["pkiEzsigndocumentID", "fkiEzsignfolderID", "fkiEzsignfoldersignerassociationIDDeclinedtosign", "dtEzsigndocumentDuedate", "dtEzsignformCompleted", "fkiLanguageID", "sEzsigndocumentName", "eEzsigndocumentStep", "dtEzsigndocumentFirstsend", "dtEzsigndocumentLastsend", "iEzsigndocumentOrder", "iEzsigndocumentPagetotal", "iEzsigndocumentSignaturesigned", "iEzsigndocumentSignaturetotal", "sEzsigndocumentMD5initial", "tEzsigndocumentDeclinedtosignreason", "sEzsigndocumentMD5signed", "bEzsigndocumentEzsignform", "bEzsigndocumentHassignedsignatures", "objAudit", "sEzsigndocumentExternalid", "eEzsigndocumentSteptype", "iEzsigndocumentStepformtotal", "iEzsigndocumentStepformcurrent", "iEzsigndocumentStepsignaturetotal", "iEzsigndocumentStepsignatureCurrent", "a_objEzsignfoldersignerassociationstatus"] - - @validator('s_ezsigndocument_externalid') + Payload for GET /1/object/ezsigndocument/{pkiEzsigndocumentID} + """ # noqa: E501 + pki_ezsigndocument_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsigndocument", alias="pkiEzsigndocumentID") + fki_ezsignfolder_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsignfolder", alias="fkiEzsignfolderID") + fki_ezsignfoldersignerassociation_id_declinedtosign: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsignfoldersignerassociation", alias="fkiEzsignfoldersignerassociationIDDeclinedtosign") + dt_ezsigndocument_duedate: StrictStr = Field(description="The maximum date and time at which the Ezsigndocument can be signed.", alias="dtEzsigndocumentDuedate") + dt_ezsignform_completed: Optional[StrictStr] = Field(default=None, description="The date and time at which the Ezsignform has been completed.", alias="dtEzsignformCompleted") + fki_language_id: Optional[Annotated[int, Field(le=2, strict=True, ge=1)]] = Field(default=None, description="The unique ID of the Language. Valid values: |Value|Description| |-|-| |1|French| |2|English|", alias="fkiLanguageID") + s_ezsigndocument_name: StrictStr = Field(description="The name of the document that will be presented to Ezsignfoldersignerassociations", alias="sEzsigndocumentName") + e_ezsigndocument_step: FieldEEzsigndocumentStep = Field(alias="eEzsigndocumentStep") + dt_ezsigndocument_firstsend: Optional[StrictStr] = Field(default=None, description="The date and time when the Ezsigndocument was first sent.", alias="dtEzsigndocumentFirstsend") + dt_ezsigndocument_lastsend: Optional[StrictStr] = Field(default=None, description="The date and time when the Ezsigndocument was sent the last time.", alias="dtEzsigndocumentLastsend") + i_ezsigndocument_order: Annotated[int, Field(strict=True, ge=1)] = Field(description="The order in which the Ezsigndocument will be presented to the signatory in the Ezsignfolder.", alias="iEzsigndocumentOrder") + i_ezsigndocument_pagetotal: Annotated[int, Field(strict=True, ge=1)] = Field(description="The number of pages in the Ezsigndocument.", alias="iEzsigndocumentPagetotal") + i_ezsigndocument_signaturesigned: Annotated[int, Field(strict=True, ge=0)] = Field(description="The number of signatures that were signed in the document.", alias="iEzsigndocumentSignaturesigned") + i_ezsigndocument_signaturetotal: Annotated[int, Field(strict=True, ge=0)] = Field(description="The number of total signatures that were requested in the Ezsigndocument.", alias="iEzsigndocumentSignaturetotal") + s_ezsigndocument_md5initial: Optional[StrictStr] = Field(default=None, description="MD5 Hash of the initial PDF Document before signatures were applied to it.", alias="sEzsigndocumentMD5initial") + t_ezsigndocument_declinedtosignreason: Optional[StrictStr] = Field(default=None, description="A custom text message that will contain the refusal message if the Ezsigndocument is declined to sign", alias="tEzsigndocumentDeclinedtosignreason") + s_ezsigndocument_md5signed: Optional[StrictStr] = Field(default=None, description="MD5 Hash of the final PDF Document after all signatures were applied to it.", alias="sEzsigndocumentMD5signed") + b_ezsigndocument_ezsignform: Optional[StrictBool] = Field(default=None, description="If the Ezsigndocument contains an Ezsignform or not", alias="bEzsigndocumentEzsignform") + b_ezsigndocument_hassignedsignatures: Optional[StrictBool] = Field(default=None, description="If the Ezsigndocument contains signed signatures (From internal or external sources)", alias="bEzsigndocumentHassignedsignatures") + obj_audit: Optional[CommonAudit] = Field(default=None, alias="objAudit") + s_ezsigndocument_externalid: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="This field can be used to store an External ID from the client's system. Anything can be stored in this field, it will never be evaluated by the eZmax system and will be returned AS-IS. To store multiple values, consider using a JSON formatted structure, a URL encoded string, a CSV or any other custom format. ", alias="sEzsigndocumentExternalid") + i_ezsigndocument_ezsignsignatureattachmenttotal: Annotated[int, Field(strict=True, ge=0)] = Field(description="The number of Ezsigndocumentattachment total", alias="iEzsigndocumentEzsignsignatureattachmenttotal") + e_ezsigndocument_steptype: ComputedEEzsigndocumentSteptype = Field(alias="eEzsigndocumentSteptype") + i_ezsigndocument_stepformtotal: StrictInt = Field(description="The total number of steps in the form filling phase", alias="iEzsigndocumentStepformtotal") + i_ezsigndocument_stepformcurrent: StrictInt = Field(description="The current step in the form filling phase", alias="iEzsigndocumentStepformcurrent") + i_ezsigndocument_stepsignaturetotal: StrictInt = Field(description="The total number of steps in the signature filling phase", alias="iEzsigndocumentStepsignaturetotal") + i_ezsigndocument_stepsignature_current: StrictInt = Field(description="The current step in the signature phase", alias="iEzsigndocumentStepsignatureCurrent") + a_obj_ezsignfoldersignerassociationstatus: List[CustomEzsignfoldersignerassociationstatusResponse] = Field(alias="a_objEzsignfoldersignerassociationstatus") + __properties: ClassVar[List[str]] = ["pkiEzsigndocumentID", "fkiEzsignfolderID", "fkiEzsignfoldersignerassociationIDDeclinedtosign", "dtEzsigndocumentDuedate", "dtEzsignformCompleted", "fkiLanguageID", "sEzsigndocumentName", "eEzsigndocumentStep", "dtEzsigndocumentFirstsend", "dtEzsigndocumentLastsend", "iEzsigndocumentOrder", "iEzsigndocumentPagetotal", "iEzsigndocumentSignaturesigned", "iEzsigndocumentSignaturetotal", "sEzsigndocumentMD5initial", "tEzsigndocumentDeclinedtosignreason", "sEzsigndocumentMD5signed", "bEzsigndocumentEzsignform", "bEzsigndocumentHassignedsignatures", "objAudit", "sEzsigndocumentExternalid", "iEzsigndocumentEzsignsignatureattachmenttotal", "eEzsigndocumentSteptype", "iEzsigndocumentStepformtotal", "iEzsigndocumentStepformcurrent", "iEzsigndocumentStepsignaturetotal", "iEzsigndocumentStepsignatureCurrent", "a_objEzsignfoldersignerassociationstatus"] + + @field_validator('s_ezsigndocument_externalid') def s_ezsigndocument_externalid_validate_regular_expression(cls, value): """Validates the regular expression""" if value is None: @@ -69,30 +76,43 @@ def s_ezsigndocument_externalid_validate_regular_expression(cls, value): raise ValueError(r"must validate the regular expression /^.{0,64}$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigndocumentGetObjectV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigndocumentGetObjectV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_audit if self.obj_audit: _dict['objAudit'] = self.obj_audit.to_dict() @@ -106,42 +126,43 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigndocumentGetObjectV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigndocumentGetObjectV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigndocumentGetObjectV1ResponseMPayload.parse_obj(obj) - - _obj = EzsigndocumentGetObjectV1ResponseMPayload.parse_obj({ - "pki_ezsigndocument_id": obj.get("pkiEzsigndocumentID"), - "fki_ezsignfolder_id": obj.get("fkiEzsignfolderID"), - "fki_ezsignfoldersignerassociation_id_declinedtosign": obj.get("fkiEzsignfoldersignerassociationIDDeclinedtosign"), - "dt_ezsigndocument_duedate": obj.get("dtEzsigndocumentDuedate"), - "dt_ezsignform_completed": obj.get("dtEzsignformCompleted"), - "fki_language_id": obj.get("fkiLanguageID"), - "s_ezsigndocument_name": obj.get("sEzsigndocumentName"), - "e_ezsigndocument_step": obj.get("eEzsigndocumentStep"), - "dt_ezsigndocument_firstsend": obj.get("dtEzsigndocumentFirstsend"), - "dt_ezsigndocument_lastsend": obj.get("dtEzsigndocumentLastsend"), - "i_ezsigndocument_order": obj.get("iEzsigndocumentOrder"), - "i_ezsigndocument_pagetotal": obj.get("iEzsigndocumentPagetotal"), - "i_ezsigndocument_signaturesigned": obj.get("iEzsigndocumentSignaturesigned"), - "i_ezsigndocument_signaturetotal": obj.get("iEzsigndocumentSignaturetotal"), - "s_ezsigndocument_md5initial": obj.get("sEzsigndocumentMD5initial"), - "t_ezsigndocument_declinedtosignreason": obj.get("tEzsigndocumentDeclinedtosignreason"), - "s_ezsigndocument_md5signed": obj.get("sEzsigndocumentMD5signed"), - "b_ezsigndocument_ezsignform": obj.get("bEzsigndocumentEzsignform"), - "b_ezsigndocument_hassignedsignatures": obj.get("bEzsigndocumentHassignedsignatures"), - "obj_audit": CommonAudit.from_dict(obj.get("objAudit")) if obj.get("objAudit") is not None else None, - "s_ezsigndocument_externalid": obj.get("sEzsigndocumentExternalid"), - "e_ezsigndocument_steptype": obj.get("eEzsigndocumentSteptype"), - "i_ezsigndocument_stepformtotal": obj.get("iEzsigndocumentStepformtotal"), - "i_ezsigndocument_stepformcurrent": obj.get("iEzsigndocumentStepformcurrent"), - "i_ezsigndocument_stepsignaturetotal": obj.get("iEzsigndocumentStepsignaturetotal"), - "i_ezsigndocument_stepsignature_current": obj.get("iEzsigndocumentStepsignatureCurrent"), - "a_obj_ezsignfoldersignerassociationstatus": [CustomEzsignfoldersignerassociationstatusResponse.from_dict(_item) for _item in obj.get("a_objEzsignfoldersignerassociationstatus")] if obj.get("a_objEzsignfoldersignerassociationstatus") is not None else None + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsigndocumentID": obj.get("pkiEzsigndocumentID"), + "fkiEzsignfolderID": obj.get("fkiEzsignfolderID"), + "fkiEzsignfoldersignerassociationIDDeclinedtosign": obj.get("fkiEzsignfoldersignerassociationIDDeclinedtosign"), + "dtEzsigndocumentDuedate": obj.get("dtEzsigndocumentDuedate"), + "dtEzsignformCompleted": obj.get("dtEzsignformCompleted"), + "fkiLanguageID": obj.get("fkiLanguageID"), + "sEzsigndocumentName": obj.get("sEzsigndocumentName"), + "eEzsigndocumentStep": obj.get("eEzsigndocumentStep"), + "dtEzsigndocumentFirstsend": obj.get("dtEzsigndocumentFirstsend"), + "dtEzsigndocumentLastsend": obj.get("dtEzsigndocumentLastsend"), + "iEzsigndocumentOrder": obj.get("iEzsigndocumentOrder"), + "iEzsigndocumentPagetotal": obj.get("iEzsigndocumentPagetotal"), + "iEzsigndocumentSignaturesigned": obj.get("iEzsigndocumentSignaturesigned"), + "iEzsigndocumentSignaturetotal": obj.get("iEzsigndocumentSignaturetotal"), + "sEzsigndocumentMD5initial": obj.get("sEzsigndocumentMD5initial"), + "tEzsigndocumentDeclinedtosignreason": obj.get("tEzsigndocumentDeclinedtosignreason"), + "sEzsigndocumentMD5signed": obj.get("sEzsigndocumentMD5signed"), + "bEzsigndocumentEzsignform": obj.get("bEzsigndocumentEzsignform"), + "bEzsigndocumentHassignedsignatures": obj.get("bEzsigndocumentHassignedsignatures"), + "objAudit": CommonAudit.from_dict(obj.get("objAudit")) if obj.get("objAudit") is not None else None, + "sEzsigndocumentExternalid": obj.get("sEzsigndocumentExternalid"), + "iEzsigndocumentEzsignsignatureattachmenttotal": obj.get("iEzsigndocumentEzsignsignatureattachmenttotal"), + "eEzsigndocumentSteptype": obj.get("eEzsigndocumentSteptype"), + "iEzsigndocumentStepformtotal": obj.get("iEzsigndocumentStepformtotal"), + "iEzsigndocumentStepformcurrent": obj.get("iEzsigndocumentStepformcurrent"), + "iEzsigndocumentStepsignaturetotal": obj.get("iEzsigndocumentStepsignaturetotal"), + "iEzsigndocumentStepsignatureCurrent": obj.get("iEzsigndocumentStepsignatureCurrent"), + "a_objEzsignfoldersignerassociationstatus": [CustomEzsignfoldersignerassociationstatusResponse.from_dict(_item) for _item in obj.get("a_objEzsignfoldersignerassociationstatus")] if obj.get("a_objEzsignfoldersignerassociationstatus") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigndocument_get_object_v2_response.py b/eZmaxApi/models/ezsigndocument_get_object_v2_response.py index cc51b4303..0a09a2e1d 100644 --- a/eZmaxApi/models/ezsigndocument_get_object_v2_response.py +++ b/eZmaxApi/models/ezsigndocument_get_object_v2_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.ezsigndocument_get_object_v2_response_m_payload import EzsigndocumentGetObjectV2ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigndocumentGetObjectV2Response(BaseModel): """ - Response for GET /2/object/ezsigndocument/{pkiEzsigndocumentID} # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzsigndocumentGetObjectV2ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /2/object/ezsigndocument/{pkiEzsigndocumentID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsigndocumentGetObjectV2ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigndocumentGetObjectV2Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigndocumentGetObjectV2Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigndocumentGetObjectV2Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigndocumentGetObjectV2Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigndocumentGetObjectV2Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigndocumentGetObjectV2Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzsigndocumentGetObjectV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsigndocumentGetObjectV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigndocument_get_object_v2_response_m_payload.py b/eZmaxApi/models/ezsigndocument_get_object_v2_response_m_payload.py index da702f522..3c3bee948 100644 --- a/eZmaxApi/models/ezsigndocument_get_object_v2_response_m_payload.py +++ b/eZmaxApi/models/ezsigndocument_get_object_v2_response_m_payload.py @@ -19,57 +19,75 @@ import json - -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.ezsigndocument_response_compound import EzsigndocumentResponseCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigndocumentGetObjectV2ResponseMPayload(BaseModel): """ - Payload for GET /2/object/ezsigndocument/{pkiEzsigndocumentID} # noqa: E501 - """ - obj_ezsigndocument: EzsigndocumentResponseCompound = Field(..., alias="objEzsigndocument") - __properties = ["objEzsigndocument"] + Payload for GET /2/object/ezsigndocument/{pkiEzsigndocumentID} + """ # noqa: E501 + obj_ezsigndocument: EzsigndocumentResponseCompound = Field(alias="objEzsigndocument") + __properties: ClassVar[List[str]] = ["objEzsigndocument"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigndocumentGetObjectV2ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigndocumentGetObjectV2ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_ezsigndocument if self.obj_ezsigndocument: _dict['objEzsigndocument'] = self.obj_ezsigndocument.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigndocumentGetObjectV2ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigndocumentGetObjectV2ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigndocumentGetObjectV2ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigndocumentGetObjectV2ResponseMPayload.parse_obj({ - "obj_ezsigndocument": EzsigndocumentResponseCompound.from_dict(obj.get("objEzsigndocument")) if obj.get("objEzsigndocument") is not None else None + _obj = cls.model_validate({ + "objEzsigndocument": EzsigndocumentResponseCompound.from_dict(obj.get("objEzsigndocument")) if obj.get("objEzsigndocument") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigndocument_get_temporary_proof_v1_response.py b/eZmaxApi/models/ezsigndocument_get_temporary_proof_v1_response.py index 2c52686dc..4ec097212 100644 --- a/eZmaxApi/models/ezsigndocument_get_temporary_proof_v1_response.py +++ b/eZmaxApi/models/ezsigndocument_get_temporary_proof_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.ezsigndocument_get_temporary_proof_v1_response_m_payload import EzsigndocumentGetTemporaryProofV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigndocumentGetTemporaryProofV1Response(BaseModel): """ - Response for GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getTemporaryProof # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzsigndocumentGetTemporaryProofV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getTemporaryProof + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsigndocumentGetTemporaryProofV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigndocumentGetTemporaryProofV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigndocumentGetTemporaryProofV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigndocumentGetTemporaryProofV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigndocumentGetTemporaryProofV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigndocumentGetTemporaryProofV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigndocumentGetTemporaryProofV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzsigndocumentGetTemporaryProofV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsigndocumentGetTemporaryProofV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigndocument_get_temporary_proof_v1_response_m_payload.py b/eZmaxApi/models/ezsigndocument_get_temporary_proof_v1_response_m_payload.py index 2b8d908f7..c81138397 100644 --- a/eZmaxApi/models/ezsigndocument_get_temporary_proof_v1_response_m_payload.py +++ b/eZmaxApi/models/ezsigndocument_get_temporary_proof_v1_response_m_payload.py @@ -19,41 +19,59 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.ezsigndocumentlog_response_compound import EzsigndocumentlogResponseCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigndocumentGetTemporaryProofV1ResponseMPayload(BaseModel): """ - Payload for GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getTemporaryProof # noqa: E501 - """ - a_obj_ezsigndocumentlog: conlist(EzsigndocumentlogResponseCompound) = Field(..., alias="a_objEzsigndocumentlog") - __properties = ["a_objEzsigndocumentlog"] + Payload for GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getTemporaryProof + """ # noqa: E501 + a_obj_ezsigndocumentlog: List[EzsigndocumentlogResponseCompound] = Field(alias="a_objEzsigndocumentlog") + __properties: ClassVar[List[str]] = ["a_objEzsigndocumentlog"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigndocumentGetTemporaryProofV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigndocumentGetTemporaryProofV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_ezsigndocumentlog (list) _items = [] if self.a_obj_ezsigndocumentlog: @@ -64,16 +82,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigndocumentGetTemporaryProofV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigndocumentGetTemporaryProofV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigndocumentGetTemporaryProofV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigndocumentGetTemporaryProofV1ResponseMPayload.parse_obj({ - "a_obj_ezsigndocumentlog": [EzsigndocumentlogResponseCompound.from_dict(_item) for _item in obj.get("a_objEzsigndocumentlog")] if obj.get("a_objEzsigndocumentlog") is not None else None + _obj = cls.model_validate({ + "a_objEzsigndocumentlog": [EzsigndocumentlogResponseCompound.from_dict(_item) for _item in obj.get("a_objEzsigndocumentlog")] if obj.get("a_objEzsigndocumentlog") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigndocument_get_words_positions_v1_request.py b/eZmaxApi/models/ezsigndocument_get_words_positions_v1_request.py index 655d1f6d1..8572394b1 100644 --- a/eZmaxApi/models/ezsigndocument_get_words_positions_v1_request.py +++ b/eZmaxApi/models/ezsigndocument_get_words_positions_v1_request.py @@ -19,64 +19,82 @@ import json -from typing import List, Optional -from pydantic import BaseModel, Field, StrictBool, StrictStr, conlist, validator +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, StrictStr, field_validator +from pydantic import Field +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigndocumentGetWordsPositionsV1Request(BaseModel): """ - Request for POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/getWordsPositions # noqa: E501 - """ - e_get: StrictStr = Field(..., alias="eGet", description="Specify if you want to retrieve *All* words or specific *Words* from the document. If you specify *Words*, you must send the list of words to search for in *a_sWord*.") - b_word_case_sensitive: StrictBool = Field(..., alias="bWordCaseSensitive", description="IF *true*, words will be searched case-sensitive and results will be returned case-sensitive. IF *false*, words will be searched case-insensitive and results will be returned case-insensitive.") - a_s_word: Optional[conlist(StrictStr)] = Field(None, alias="a_sWord", description="Array of words to find in the document") - __properties = ["eGet", "bWordCaseSensitive", "a_sWord"] - - @validator('e_get') + Request for POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/getWordsPositions + """ # noqa: E501 + e_get: StrictStr = Field(description="Specify if you want to retrieve *All* words or specific *Words* from the document. If you specify *Words*, you must send the list of words to search for in *a_sWord*.", alias="eGet") + b_word_case_sensitive: StrictBool = Field(description="IF *true*, words will be searched case-sensitive and results will be returned case-sensitive. IF *false*, words will be searched case-insensitive and results will be returned case-insensitive.", alias="bWordCaseSensitive") + a_s_word: Optional[List[StrictStr]] = Field(default=None, description="Array of words to find in the document", alias="a_sWord") + __properties: ClassVar[List[str]] = ["eGet", "bWordCaseSensitive", "a_sWord"] + + @field_validator('e_get') def e_get_validate_enum(cls, value): """Validates the enum""" if value not in ('All', 'Words'): raise ValueError("must be one of enum values ('All', 'Words')") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigndocumentGetWordsPositionsV1Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigndocumentGetWordsPositionsV1Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigndocumentGetWordsPositionsV1Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigndocumentGetWordsPositionsV1Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigndocumentGetWordsPositionsV1Request.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigndocumentGetWordsPositionsV1Request.parse_obj({ - "e_get": obj.get("eGet"), - "b_word_case_sensitive": obj.get("bWordCaseSensitive"), - "a_s_word": obj.get("a_sWord") + _obj = cls.model_validate({ + "eGet": obj.get("eGet"), + "bWordCaseSensitive": obj.get("bWordCaseSensitive"), + "a_sWord": obj.get("a_sWord") }) return _obj diff --git a/eZmaxApi/models/ezsigndocument_get_words_positions_v1_response.py b/eZmaxApi/models/ezsigndocument_get_words_positions_v1_response.py index 5c4fb1d21..7791e8d32 100644 --- a/eZmaxApi/models/ezsigndocument_get_words_positions_v1_response.py +++ b/eZmaxApi/models/ezsigndocument_get_words_positions_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import List, Optional -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.custom_word_position_word_response import CustomWordPositionWordResponse +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigndocumentGetWordsPositionsV1Response(BaseModel): """ - Response for POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/getWordsPositions # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: conlist(CustomWordPositionWordResponse) = Field(..., alias="mPayload", description="Payload for POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/getWordsPositions") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/getWordsPositions + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: List[CustomWordPositionWordResponse] = Field(description="Payload for POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/getWordsPositions", alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigndocumentGetWordsPositionsV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigndocumentGetWordsPositionsV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -74,18 +92,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigndocumentGetWordsPositionsV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigndocumentGetWordsPositionsV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigndocumentGetWordsPositionsV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigndocumentGetWordsPositionsV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": [CustomWordPositionWordResponse.from_dict(_item) for _item in obj.get("mPayload")] if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": [CustomWordPositionWordResponse.from_dict(_item) for _item in obj.get("mPayload")] if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigndocument_patch_object_v1_request.py b/eZmaxApi/models/ezsigndocument_patch_object_v1_request.py index 592006bf8..73f1e3431 100644 --- a/eZmaxApi/models/ezsigndocument_patch_object_v1_request.py +++ b/eZmaxApi/models/ezsigndocument_patch_object_v1_request.py @@ -19,57 +19,75 @@ import json - -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.ezsigndocument_request_patch import EzsigndocumentRequestPatch +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigndocumentPatchObjectV1Request(BaseModel): """ - Request for PATCH /1/object/ezsigndocument/{pkiEzsigndocumentID} # noqa: E501 - """ - obj_ezsigndocument: EzsigndocumentRequestPatch = Field(..., alias="objEzsigndocument") - __properties = ["objEzsigndocument"] + Request for PATCH /1/object/ezsigndocument/{pkiEzsigndocumentID} + """ # noqa: E501 + obj_ezsigndocument: EzsigndocumentRequestPatch = Field(alias="objEzsigndocument") + __properties: ClassVar[List[str]] = ["objEzsigndocument"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigndocumentPatchObjectV1Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigndocumentPatchObjectV1Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_ezsigndocument if self.obj_ezsigndocument: _dict['objEzsigndocument'] = self.obj_ezsigndocument.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigndocumentPatchObjectV1Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigndocumentPatchObjectV1Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigndocumentPatchObjectV1Request.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigndocumentPatchObjectV1Request.parse_obj({ - "obj_ezsigndocument": EzsigndocumentRequestPatch.from_dict(obj.get("objEzsigndocument")) if obj.get("objEzsigndocument") is not None else None + _obj = cls.model_validate({ + "objEzsigndocument": EzsigndocumentRequestPatch.from_dict(obj.get("objEzsigndocument")) if obj.get("objEzsigndocument") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigndocument_patch_object_v1_response.py b/eZmaxApi/models/ezsigndocument_patch_object_v1_response.py index cecf1e523..0699ffcb6 100644 --- a/eZmaxApi/models/ezsigndocument_patch_object_v1_response.py +++ b/eZmaxApi/models/ezsigndocument_patch_object_v1_response.py @@ -19,43 +19,61 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigndocumentPatchObjectV1Response(BaseModel): """ - Response for PATCH /1/object/ezsigndocument/{pkiEzsigndocumentID} # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - __properties = ["objDebugPayload", "objDebug"] + Response for PATCH /1/object/ezsigndocument/{pkiEzsigndocumentID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigndocumentPatchObjectV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigndocumentPatchObjectV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -65,17 +83,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigndocumentPatchObjectV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigndocumentPatchObjectV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigndocumentPatchObjectV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigndocumentPatchObjectV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigndocument_request.py b/eZmaxApi/models/ezsigndocument_request.py index 6908def6b..e7d915d2b 100644 --- a/eZmaxApi/models/ezsigndocument_request.py +++ b/eZmaxApi/models/ezsigndocument_request.py @@ -19,38 +19,44 @@ import json -from typing import Optional, Union -from pydantic import BaseModel, Field, StrictBool, StrictBytes, StrictStr, conint, constr, validator +from typing import Any, ClassVar, Dict, List, Optional, Union +from pydantic import BaseModel, StrictBool, StrictBytes, StrictStr, field_validator +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigndocumentRequest(BaseModel): """ - An Ezsigndocument Object # noqa: E501 - """ - pki_ezsigndocument_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="pkiEzsigndocumentID", description="The unique ID of the Ezsigndocument") - fki_ezsignfolder_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsignfolderID", description="The unique ID of the Ezsignfolder") - fki_ezsigntemplate_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiEzsigntemplateID", description="The unique ID of the Ezsigntemplate") - fki_ezsignfoldersignerassociation_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiEzsignfoldersignerassociationID", description="The unique ID of the Ezsignfoldersignerassociation") - fki_language_id: conint(strict=True, le=2, ge=1) = Field(..., alias="fkiLanguageID", description="The unique ID of the Language. Valid values: |Value|Description| |-|-| |1|French| |2|English|") - e_ezsigndocument_source: StrictStr = Field(..., alias="eEzsigndocumentSource", description="Indicates where to look for the document binary content.") - e_ezsigndocument_format: Optional[StrictStr] = Field(None, alias="eEzsigndocumentFormat", description="Indicates the format of the document.") - s_ezsigndocument_base64: Optional[Union[StrictBytes, StrictStr]] = Field(None, alias="sEzsigndocumentBase64", description="The Base64 encoded binary content of the document. This field is Required when eEzsigndocumentSource = Base64.") - s_ezsigndocument_url: Optional[StrictStr] = Field(None, alias="sEzsigndocumentUrl", description="The url where the document content resides. This field is Required when eEzsigndocumentSource = Url.") - b_ezsigndocument_forcerepair: Optional[StrictBool] = Field(True, alias="bEzsigndocumentForcerepair", description="Try to repair the document or flatten it if it cannot be used for electronic signature. ") - s_ezsigndocument_password: Optional[StrictStr] = Field(None, alias="sEzsigndocumentPassword", description="If the source document is password protected, the password to open/modify it.") - e_ezsigndocument_form: Optional[StrictStr] = Field(None, alias="eEzsigndocumentForm", description="If the document contains an existing PDF form this property must be set. **Keep** leaves the form as-is in the document. **Convert** removes the form and convert all the existing fields to Ezsignformfieldgroups and assign them to the specified **fkiEzsignfoldersignerassociationID**") - dt_ezsigndocument_duedate: StrictStr = Field(..., alias="dtEzsigndocumentDuedate", description="The maximum date and time at which the Ezsigndocument can be signed.") - s_ezsigndocument_name: StrictStr = Field(..., alias="sEzsigndocumentName", description="The name of the document that will be presented to Ezsignfoldersignerassociations") - s_ezsigndocument_externalid: Optional[constr(strict=True)] = Field(None, alias="sEzsigndocumentExternalid", description="This field can be used to store an External ID from the client's system. Anything can be stored in this field, it will never be evaluated by the eZmax system and will be returned AS-IS. To store multiple values, consider using a JSON formatted structure, a URL encoded string, a CSV or any other custom format. ") - __properties = ["pkiEzsigndocumentID", "fkiEzsignfolderID", "fkiEzsigntemplateID", "fkiEzsignfoldersignerassociationID", "fkiLanguageID", "eEzsigndocumentSource", "eEzsigndocumentFormat", "sEzsigndocumentBase64", "sEzsigndocumentUrl", "bEzsigndocumentForcerepair", "sEzsigndocumentPassword", "eEzsigndocumentForm", "dtEzsigndocumentDuedate", "sEzsigndocumentName", "sEzsigndocumentExternalid"] - - @validator('e_ezsigndocument_source') + An Ezsigndocument Object + """ # noqa: E501 + pki_ezsigndocument_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsigndocument", alias="pkiEzsigndocumentID") + fki_ezsignfolder_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsignfolder", alias="fkiEzsignfolderID") + fki_ezsigntemplate_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsigntemplate", alias="fkiEzsigntemplateID") + fki_ezsignfoldersignerassociation_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsignfoldersignerassociation", alias="fkiEzsignfoldersignerassociationID") + fki_language_id: Annotated[int, Field(le=2, strict=True, ge=1)] = Field(description="The unique ID of the Language. Valid values: |Value|Description| |-|-| |1|French| |2|English|", alias="fkiLanguageID") + e_ezsigndocument_source: StrictStr = Field(description="Indicates where to look for the document binary content.", alias="eEzsigndocumentSource") + e_ezsigndocument_format: Optional[StrictStr] = Field(default=None, description="Indicates the format of the document.", alias="eEzsigndocumentFormat") + s_ezsigndocument_base64: Optional[Union[StrictBytes, StrictStr]] = Field(default=None, description="The Base64 encoded binary content of the document. This field is Required when eEzsigndocumentSource = Base64.", alias="sEzsigndocumentBase64") + s_ezsigndocument_url: Optional[StrictStr] = Field(default=None, description="The url where the document content resides. This field is Required when eEzsigndocumentSource = Url.", alias="sEzsigndocumentUrl") + b_ezsigndocument_forcerepair: Optional[StrictBool] = Field(default=True, description="Try to repair the document or flatten it if it cannot be used for electronic signature. ", alias="bEzsigndocumentForcerepair") + s_ezsigndocument_password: Optional[StrictStr] = Field(default=None, description="If the source document is password protected, the password to open/modify it.", alias="sEzsigndocumentPassword") + e_ezsigndocument_form: Optional[StrictStr] = Field(default=None, description="If the document contains an existing PDF form this property must be set. **Keep** leaves the form as-is in the document. **Convert** removes the form and convert all the existing fields to Ezsignformfieldgroups and assign them to the specified **fkiEzsignfoldersignerassociationID**", alias="eEzsigndocumentForm") + dt_ezsigndocument_duedate: StrictStr = Field(description="The maximum date and time at which the Ezsigndocument can be signed.", alias="dtEzsigndocumentDuedate") + s_ezsigndocument_name: StrictStr = Field(description="The name of the document that will be presented to Ezsignfoldersignerassociations", alias="sEzsigndocumentName") + s_ezsigndocument_externalid: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="This field can be used to store an External ID from the client's system. Anything can be stored in this field, it will never be evaluated by the eZmax system and will be returned AS-IS. To store multiple values, consider using a JSON formatted structure, a URL encoded string, a CSV or any other custom format. ", alias="sEzsigndocumentExternalid") + __properties: ClassVar[List[str]] = ["pkiEzsigndocumentID", "fkiEzsignfolderID", "fkiEzsigntemplateID", "fkiEzsignfoldersignerassociationID", "fkiLanguageID", "eEzsigndocumentSource", "eEzsigndocumentFormat", "sEzsigndocumentBase64", "sEzsigndocumentUrl", "bEzsigndocumentForcerepair", "sEzsigndocumentPassword", "eEzsigndocumentForm", "dtEzsigndocumentDuedate", "sEzsigndocumentName", "sEzsigndocumentExternalid"] + + @field_validator('e_ezsigndocument_source') def e_ezsigndocument_source_validate_enum(cls, value): """Validates the enum""" if value not in ('Base64', 'Ezsigntemplate', 'Url'): raise ValueError("must be one of enum values ('Base64', 'Ezsigntemplate', 'Url')") return value - @validator('e_ezsigndocument_format') + @field_validator('e_ezsigndocument_format') def e_ezsigndocument_format_validate_enum(cls, value): """Validates the enum""" if value is None: @@ -60,7 +66,7 @@ def e_ezsigndocument_format_validate_enum(cls, value): raise ValueError("must be one of enum values ('Pdf', 'Doc', 'Docx', 'Xls', 'Xlsx', 'Ppt', 'Pptx')") return value - @validator('e_ezsigndocument_form') + @field_validator('e_ezsigndocument_form') def e_ezsigndocument_form_validate_enum(cls, value): """Validates the enum""" if value is None: @@ -70,7 +76,7 @@ def e_ezsigndocument_form_validate_enum(cls, value): raise ValueError("must be one of enum values ('Keep', 'Convert')") return value - @validator('s_ezsigndocument_externalid') + @field_validator('s_ezsigndocument_externalid') def s_ezsigndocument_externalid_validate_regular_expression(cls, value): """Validates the regular expression""" if value is None: @@ -80,57 +86,70 @@ def s_ezsigndocument_externalid_validate_regular_expression(cls, value): raise ValueError(r"must validate the regular expression /^.{0,64}$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigndocumentRequest: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigndocumentRequest from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigndocumentRequest: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigndocumentRequest from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigndocumentRequest.parse_obj(obj) - - _obj = EzsigndocumentRequest.parse_obj({ - "pki_ezsigndocument_id": obj.get("pkiEzsigndocumentID"), - "fki_ezsignfolder_id": obj.get("fkiEzsignfolderID"), - "fki_ezsigntemplate_id": obj.get("fkiEzsigntemplateID"), - "fki_ezsignfoldersignerassociation_id": obj.get("fkiEzsignfoldersignerassociationID"), - "fki_language_id": obj.get("fkiLanguageID"), - "e_ezsigndocument_source": obj.get("eEzsigndocumentSource"), - "e_ezsigndocument_format": obj.get("eEzsigndocumentFormat"), - "s_ezsigndocument_base64": obj.get("sEzsigndocumentBase64"), - "s_ezsigndocument_url": obj.get("sEzsigndocumentUrl"), - "b_ezsigndocument_forcerepair": obj.get("bEzsigndocumentForcerepair") if obj.get("bEzsigndocumentForcerepair") is not None else True, - "s_ezsigndocument_password": obj.get("sEzsigndocumentPassword"), - "e_ezsigndocument_form": obj.get("eEzsigndocumentForm"), - "dt_ezsigndocument_duedate": obj.get("dtEzsigndocumentDuedate"), - "s_ezsigndocument_name": obj.get("sEzsigndocumentName"), - "s_ezsigndocument_externalid": obj.get("sEzsigndocumentExternalid") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsigndocumentID": obj.get("pkiEzsigndocumentID"), + "fkiEzsignfolderID": obj.get("fkiEzsignfolderID"), + "fkiEzsigntemplateID": obj.get("fkiEzsigntemplateID"), + "fkiEzsignfoldersignerassociationID": obj.get("fkiEzsignfoldersignerassociationID"), + "fkiLanguageID": obj.get("fkiLanguageID"), + "eEzsigndocumentSource": obj.get("eEzsigndocumentSource"), + "eEzsigndocumentFormat": obj.get("eEzsigndocumentFormat"), + "sEzsigndocumentBase64": obj.get("sEzsigndocumentBase64"), + "sEzsigndocumentUrl": obj.get("sEzsigndocumentUrl"), + "bEzsigndocumentForcerepair": obj.get("bEzsigndocumentForcerepair") if obj.get("bEzsigndocumentForcerepair") is not None else True, + "sEzsigndocumentPassword": obj.get("sEzsigndocumentPassword"), + "eEzsigndocumentForm": obj.get("eEzsigndocumentForm"), + "dtEzsigndocumentDuedate": obj.get("dtEzsigndocumentDuedate"), + "sEzsigndocumentName": obj.get("sEzsigndocumentName"), + "sEzsigndocumentExternalid": obj.get("sEzsigndocumentExternalid") }) return _obj diff --git a/eZmaxApi/models/ezsigndocument_request_compound.py b/eZmaxApi/models/ezsigndocument_request_compound.py index 4a47ad54d..9164b908e 100644 --- a/eZmaxApi/models/ezsigndocument_request_compound.py +++ b/eZmaxApi/models/ezsigndocument_request_compound.py @@ -19,38 +19,44 @@ import json -from typing import Optional, Union -from pydantic import BaseModel, Field, StrictBool, StrictBytes, StrictStr, conint, constr, validator +from typing import Any, ClassVar, Dict, List, Optional, Union +from pydantic import BaseModel, StrictBool, StrictBytes, StrictStr, field_validator +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigndocumentRequestCompound(BaseModel): """ - An Ezsigndocument Object and children to create a complete structure # noqa: E501 - """ - pki_ezsigndocument_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="pkiEzsigndocumentID", description="The unique ID of the Ezsigndocument") - fki_ezsignfolder_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsignfolderID", description="The unique ID of the Ezsignfolder") - fki_ezsigntemplate_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiEzsigntemplateID", description="The unique ID of the Ezsigntemplate") - fki_ezsignfoldersignerassociation_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiEzsignfoldersignerassociationID", description="The unique ID of the Ezsignfoldersignerassociation") - fki_language_id: conint(strict=True, le=2, ge=1) = Field(..., alias="fkiLanguageID", description="The unique ID of the Language. Valid values: |Value|Description| |-|-| |1|French| |2|English|") - e_ezsigndocument_source: StrictStr = Field(..., alias="eEzsigndocumentSource", description="Indicates where to look for the document binary content.") - e_ezsigndocument_format: Optional[StrictStr] = Field(None, alias="eEzsigndocumentFormat", description="Indicates the format of the document.") - s_ezsigndocument_base64: Optional[Union[StrictBytes, StrictStr]] = Field(None, alias="sEzsigndocumentBase64", description="The Base64 encoded binary content of the document. This field is Required when eEzsigndocumentSource = Base64.") - s_ezsigndocument_url: Optional[StrictStr] = Field(None, alias="sEzsigndocumentUrl", description="The url where the document content resides. This field is Required when eEzsigndocumentSource = Url.") - b_ezsigndocument_forcerepair: Optional[StrictBool] = Field(True, alias="bEzsigndocumentForcerepair", description="Try to repair the document or flatten it if it cannot be used for electronic signature. ") - s_ezsigndocument_password: Optional[StrictStr] = Field(None, alias="sEzsigndocumentPassword", description="If the source document is password protected, the password to open/modify it.") - e_ezsigndocument_form: Optional[StrictStr] = Field(None, alias="eEzsigndocumentForm", description="If the document contains an existing PDF form this property must be set. **Keep** leaves the form as-is in the document. **Convert** removes the form and convert all the existing fields to Ezsignformfieldgroups and assign them to the specified **fkiEzsignfoldersignerassociationID**") - dt_ezsigndocument_duedate: StrictStr = Field(..., alias="dtEzsigndocumentDuedate", description="The maximum date and time at which the Ezsigndocument can be signed.") - s_ezsigndocument_name: StrictStr = Field(..., alias="sEzsigndocumentName", description="The name of the document that will be presented to Ezsignfoldersignerassociations") - s_ezsigndocument_externalid: Optional[constr(strict=True)] = Field(None, alias="sEzsigndocumentExternalid", description="This field can be used to store an External ID from the client's system. Anything can be stored in this field, it will never be evaluated by the eZmax system and will be returned AS-IS. To store multiple values, consider using a JSON formatted structure, a URL encoded string, a CSV or any other custom format. ") - __properties = ["pkiEzsigndocumentID", "fkiEzsignfolderID", "fkiEzsigntemplateID", "fkiEzsignfoldersignerassociationID", "fkiLanguageID", "eEzsigndocumentSource", "eEzsigndocumentFormat", "sEzsigndocumentBase64", "sEzsigndocumentUrl", "bEzsigndocumentForcerepair", "sEzsigndocumentPassword", "eEzsigndocumentForm", "dtEzsigndocumentDuedate", "sEzsigndocumentName", "sEzsigndocumentExternalid"] - - @validator('e_ezsigndocument_source') + An Ezsigndocument Object and children to create a complete structure + """ # noqa: E501 + pki_ezsigndocument_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsigndocument", alias="pkiEzsigndocumentID") + fki_ezsignfolder_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsignfolder", alias="fkiEzsignfolderID") + fki_ezsigntemplate_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsigntemplate", alias="fkiEzsigntemplateID") + fki_ezsignfoldersignerassociation_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsignfoldersignerassociation", alias="fkiEzsignfoldersignerassociationID") + fki_language_id: Annotated[int, Field(le=2, strict=True, ge=1)] = Field(description="The unique ID of the Language. Valid values: |Value|Description| |-|-| |1|French| |2|English|", alias="fkiLanguageID") + e_ezsigndocument_source: StrictStr = Field(description="Indicates where to look for the document binary content.", alias="eEzsigndocumentSource") + e_ezsigndocument_format: Optional[StrictStr] = Field(default=None, description="Indicates the format of the document.", alias="eEzsigndocumentFormat") + s_ezsigndocument_base64: Optional[Union[StrictBytes, StrictStr]] = Field(default=None, description="The Base64 encoded binary content of the document. This field is Required when eEzsigndocumentSource = Base64.", alias="sEzsigndocumentBase64") + s_ezsigndocument_url: Optional[StrictStr] = Field(default=None, description="The url where the document content resides. This field is Required when eEzsigndocumentSource = Url.", alias="sEzsigndocumentUrl") + b_ezsigndocument_forcerepair: Optional[StrictBool] = Field(default=True, description="Try to repair the document or flatten it if it cannot be used for electronic signature. ", alias="bEzsigndocumentForcerepair") + s_ezsigndocument_password: Optional[StrictStr] = Field(default=None, description="If the source document is password protected, the password to open/modify it.", alias="sEzsigndocumentPassword") + e_ezsigndocument_form: Optional[StrictStr] = Field(default=None, description="If the document contains an existing PDF form this property must be set. **Keep** leaves the form as-is in the document. **Convert** removes the form and convert all the existing fields to Ezsignformfieldgroups and assign them to the specified **fkiEzsignfoldersignerassociationID**", alias="eEzsigndocumentForm") + dt_ezsigndocument_duedate: StrictStr = Field(description="The maximum date and time at which the Ezsigndocument can be signed.", alias="dtEzsigndocumentDuedate") + s_ezsigndocument_name: StrictStr = Field(description="The name of the document that will be presented to Ezsignfoldersignerassociations", alias="sEzsigndocumentName") + s_ezsigndocument_externalid: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="This field can be used to store an External ID from the client's system. Anything can be stored in this field, it will never be evaluated by the eZmax system and will be returned AS-IS. To store multiple values, consider using a JSON formatted structure, a URL encoded string, a CSV or any other custom format. ", alias="sEzsigndocumentExternalid") + __properties: ClassVar[List[str]] = ["pkiEzsigndocumentID", "fkiEzsignfolderID", "fkiEzsigntemplateID", "fkiEzsignfoldersignerassociationID", "fkiLanguageID", "eEzsigndocumentSource", "eEzsigndocumentFormat", "sEzsigndocumentBase64", "sEzsigndocumentUrl", "bEzsigndocumentForcerepair", "sEzsigndocumentPassword", "eEzsigndocumentForm", "dtEzsigndocumentDuedate", "sEzsigndocumentName", "sEzsigndocumentExternalid"] + + @field_validator('e_ezsigndocument_source') def e_ezsigndocument_source_validate_enum(cls, value): """Validates the enum""" if value not in ('Base64', 'Ezsigntemplate', 'Url'): raise ValueError("must be one of enum values ('Base64', 'Ezsigntemplate', 'Url')") return value - @validator('e_ezsigndocument_format') + @field_validator('e_ezsigndocument_format') def e_ezsigndocument_format_validate_enum(cls, value): """Validates the enum""" if value is None: @@ -60,7 +66,7 @@ def e_ezsigndocument_format_validate_enum(cls, value): raise ValueError("must be one of enum values ('Pdf', 'Doc', 'Docx', 'Xls', 'Xlsx', 'Ppt', 'Pptx')") return value - @validator('e_ezsigndocument_form') + @field_validator('e_ezsigndocument_form') def e_ezsigndocument_form_validate_enum(cls, value): """Validates the enum""" if value is None: @@ -70,7 +76,7 @@ def e_ezsigndocument_form_validate_enum(cls, value): raise ValueError("must be one of enum values ('Keep', 'Convert')") return value - @validator('s_ezsigndocument_externalid') + @field_validator('s_ezsigndocument_externalid') def s_ezsigndocument_externalid_validate_regular_expression(cls, value): """Validates the regular expression""" if value is None: @@ -80,57 +86,70 @@ def s_ezsigndocument_externalid_validate_regular_expression(cls, value): raise ValueError(r"must validate the regular expression /^.{0,64}$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigndocumentRequestCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigndocumentRequestCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigndocumentRequestCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigndocumentRequestCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigndocumentRequestCompound.parse_obj(obj) - - _obj = EzsigndocumentRequestCompound.parse_obj({ - "pki_ezsigndocument_id": obj.get("pkiEzsigndocumentID"), - "fki_ezsignfolder_id": obj.get("fkiEzsignfolderID"), - "fki_ezsigntemplate_id": obj.get("fkiEzsigntemplateID"), - "fki_ezsignfoldersignerassociation_id": obj.get("fkiEzsignfoldersignerassociationID"), - "fki_language_id": obj.get("fkiLanguageID"), - "e_ezsigndocument_source": obj.get("eEzsigndocumentSource"), - "e_ezsigndocument_format": obj.get("eEzsigndocumentFormat"), - "s_ezsigndocument_base64": obj.get("sEzsigndocumentBase64"), - "s_ezsigndocument_url": obj.get("sEzsigndocumentUrl"), - "b_ezsigndocument_forcerepair": obj.get("bEzsigndocumentForcerepair") if obj.get("bEzsigndocumentForcerepair") is not None else True, - "s_ezsigndocument_password": obj.get("sEzsigndocumentPassword"), - "e_ezsigndocument_form": obj.get("eEzsigndocumentForm"), - "dt_ezsigndocument_duedate": obj.get("dtEzsigndocumentDuedate"), - "s_ezsigndocument_name": obj.get("sEzsigndocumentName"), - "s_ezsigndocument_externalid": obj.get("sEzsigndocumentExternalid") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsigndocumentID": obj.get("pkiEzsigndocumentID"), + "fkiEzsignfolderID": obj.get("fkiEzsignfolderID"), + "fkiEzsigntemplateID": obj.get("fkiEzsigntemplateID"), + "fkiEzsignfoldersignerassociationID": obj.get("fkiEzsignfoldersignerassociationID"), + "fkiLanguageID": obj.get("fkiLanguageID"), + "eEzsigndocumentSource": obj.get("eEzsigndocumentSource"), + "eEzsigndocumentFormat": obj.get("eEzsigndocumentFormat"), + "sEzsigndocumentBase64": obj.get("sEzsigndocumentBase64"), + "sEzsigndocumentUrl": obj.get("sEzsigndocumentUrl"), + "bEzsigndocumentForcerepair": obj.get("bEzsigndocumentForcerepair") if obj.get("bEzsigndocumentForcerepair") is not None else True, + "sEzsigndocumentPassword": obj.get("sEzsigndocumentPassword"), + "eEzsigndocumentForm": obj.get("eEzsigndocumentForm"), + "dtEzsigndocumentDuedate": obj.get("dtEzsigndocumentDuedate"), + "sEzsigndocumentName": obj.get("sEzsigndocumentName"), + "sEzsigndocumentExternalid": obj.get("sEzsigndocumentExternalid") }) return _obj diff --git a/eZmaxApi/models/ezsigndocument_request_patch.py b/eZmaxApi/models/ezsigndocument_request_patch.py index 5f3850589..1447f6205 100644 --- a/eZmaxApi/models/ezsigndocument_request_patch.py +++ b/eZmaxApi/models/ezsigndocument_request_patch.py @@ -19,55 +19,73 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictStr +from pydantic import Field +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigndocumentRequestPatch(BaseModel): """ - An Ezsigndocument Object # noqa: E501 - """ - dt_ezsigndocument_duedate: Optional[StrictStr] = Field(None, alias="dtEzsigndocumentDuedate", description="The maximum date and time at which the Ezsigndocument can be signed.") - s_ezsigndocument_name: Optional[StrictStr] = Field(None, alias="sEzsigndocumentName", description="The name of the document that will be presented to Ezsignfoldersignerassociations") - __properties = ["dtEzsigndocumentDuedate", "sEzsigndocumentName"] + An Ezsigndocument Object + """ # noqa: E501 + dt_ezsigndocument_duedate: Optional[StrictStr] = Field(default=None, description="The maximum date and time at which the Ezsigndocument can be signed.", alias="dtEzsigndocumentDuedate") + s_ezsigndocument_name: Optional[StrictStr] = Field(default=None, description="The name of the document that will be presented to Ezsignfoldersignerassociations", alias="sEzsigndocumentName") + __properties: ClassVar[List[str]] = ["dtEzsigndocumentDuedate", "sEzsigndocumentName"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigndocumentRequestPatch: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigndocumentRequestPatch from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigndocumentRequestPatch: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigndocumentRequestPatch from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigndocumentRequestPatch.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigndocumentRequestPatch.parse_obj({ - "dt_ezsigndocument_duedate": obj.get("dtEzsigndocumentDuedate"), - "s_ezsigndocument_name": obj.get("sEzsigndocumentName") + _obj = cls.model_validate({ + "dtEzsigndocumentDuedate": obj.get("dtEzsigndocumentDuedate"), + "sEzsigndocumentName": obj.get("sEzsigndocumentName") }) return _obj diff --git a/eZmaxApi/models/ezsigndocument_response.py b/eZmaxApi/models/ezsigndocument_response.py index ba488eed8..4770ce05d 100644 --- a/eZmaxApi/models/ezsigndocument_response.py +++ b/eZmaxApi/models/ezsigndocument_response.py @@ -19,39 +19,46 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint, constr, validator +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, StrictStr, field_validator +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.common_audit import CommonAudit from eZmaxApi.models.field_e_ezsigndocument_step import FieldEEzsigndocumentStep +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigndocumentResponse(BaseModel): """ - An Ezsigndocument Object # noqa: E501 - """ - pki_ezsigndocument_id: conint(strict=True, ge=0) = Field(..., alias="pkiEzsigndocumentID", description="The unique ID of the Ezsigndocument") - fki_ezsignfolder_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsignfolderID", description="The unique ID of the Ezsignfolder") - fki_ezsignfoldersignerassociation_id_declinedtosign: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiEzsignfoldersignerassociationIDDeclinedtosign", description="The unique ID of the Ezsignfoldersignerassociation") - dt_ezsigndocument_duedate: StrictStr = Field(..., alias="dtEzsigndocumentDuedate", description="The maximum date and time at which the Ezsigndocument can be signed.") - dt_ezsignform_completed: Optional[StrictStr] = Field(None, alias="dtEzsignformCompleted", description="The date and time at which the Ezsignform has been completed.") - fki_language_id: Optional[conint(strict=True, le=2, ge=1)] = Field(None, alias="fkiLanguageID", description="The unique ID of the Language. Valid values: |Value|Description| |-|-| |1|French| |2|English|") - s_ezsigndocument_name: StrictStr = Field(..., alias="sEzsigndocumentName", description="The name of the document that will be presented to Ezsignfoldersignerassociations") - e_ezsigndocument_step: FieldEEzsigndocumentStep = Field(..., alias="eEzsigndocumentStep") - dt_ezsigndocument_firstsend: Optional[StrictStr] = Field(None, alias="dtEzsigndocumentFirstsend", description="The date and time when the Ezsigndocument was first sent.") - dt_ezsigndocument_lastsend: Optional[StrictStr] = Field(None, alias="dtEzsigndocumentLastsend", description="The date and time when the Ezsigndocument was sent the last time.") - i_ezsigndocument_order: conint(strict=True, ge=1) = Field(..., alias="iEzsigndocumentOrder", description="The order in which the Ezsigndocument will be presented to the signatory in the Ezsignfolder.") - i_ezsigndocument_pagetotal: conint(strict=True, ge=1) = Field(..., alias="iEzsigndocumentPagetotal", description="The number of pages in the Ezsigndocument.") - i_ezsigndocument_signaturesigned: conint(strict=True, ge=0) = Field(..., alias="iEzsigndocumentSignaturesigned", description="The number of signatures that were signed in the document.") - i_ezsigndocument_signaturetotal: conint(strict=True, ge=0) = Field(..., alias="iEzsigndocumentSignaturetotal", description="The number of total signatures that were requested in the Ezsigndocument.") - s_ezsigndocument_md5initial: Optional[StrictStr] = Field(None, alias="sEzsigndocumentMD5initial", description="MD5 Hash of the initial PDF Document before signatures were applied to it.") - t_ezsigndocument_declinedtosignreason: Optional[StrictStr] = Field(None, alias="tEzsigndocumentDeclinedtosignreason", description="A custom text message that will contain the refusal message if the Ezsigndocument is declined to sign") - s_ezsigndocument_md5signed: Optional[StrictStr] = Field(None, alias="sEzsigndocumentMD5signed", description="MD5 Hash of the final PDF Document after all signatures were applied to it.") - b_ezsigndocument_ezsignform: Optional[StrictBool] = Field(None, alias="bEzsigndocumentEzsignform", description="If the Ezsigndocument contains an Ezsignform or not") - b_ezsigndocument_hassignedsignatures: Optional[StrictBool] = Field(None, alias="bEzsigndocumentHassignedsignatures", description="If the Ezsigndocument contains signed signatures (From internal or external sources)") - obj_audit: Optional[CommonAudit] = Field(None, alias="objAudit") - s_ezsigndocument_externalid: Optional[constr(strict=True)] = Field(None, alias="sEzsigndocumentExternalid", description="This field can be used to store an External ID from the client's system. Anything can be stored in this field, it will never be evaluated by the eZmax system and will be returned AS-IS. To store multiple values, consider using a JSON formatted structure, a URL encoded string, a CSV or any other custom format. ") - __properties = ["pkiEzsigndocumentID", "fkiEzsignfolderID", "fkiEzsignfoldersignerassociationIDDeclinedtosign", "dtEzsigndocumentDuedate", "dtEzsignformCompleted", "fkiLanguageID", "sEzsigndocumentName", "eEzsigndocumentStep", "dtEzsigndocumentFirstsend", "dtEzsigndocumentLastsend", "iEzsigndocumentOrder", "iEzsigndocumentPagetotal", "iEzsigndocumentSignaturesigned", "iEzsigndocumentSignaturetotal", "sEzsigndocumentMD5initial", "tEzsigndocumentDeclinedtosignreason", "sEzsigndocumentMD5signed", "bEzsigndocumentEzsignform", "bEzsigndocumentHassignedsignatures", "objAudit", "sEzsigndocumentExternalid"] - - @validator('s_ezsigndocument_externalid') + An Ezsigndocument Object + """ # noqa: E501 + pki_ezsigndocument_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsigndocument", alias="pkiEzsigndocumentID") + fki_ezsignfolder_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsignfolder", alias="fkiEzsignfolderID") + fki_ezsignfoldersignerassociation_id_declinedtosign: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsignfoldersignerassociation", alias="fkiEzsignfoldersignerassociationIDDeclinedtosign") + dt_ezsigndocument_duedate: StrictStr = Field(description="The maximum date and time at which the Ezsigndocument can be signed.", alias="dtEzsigndocumentDuedate") + dt_ezsignform_completed: Optional[StrictStr] = Field(default=None, description="The date and time at which the Ezsignform has been completed.", alias="dtEzsignformCompleted") + fki_language_id: Optional[Annotated[int, Field(le=2, strict=True, ge=1)]] = Field(default=None, description="The unique ID of the Language. Valid values: |Value|Description| |-|-| |1|French| |2|English|", alias="fkiLanguageID") + s_ezsigndocument_name: StrictStr = Field(description="The name of the document that will be presented to Ezsignfoldersignerassociations", alias="sEzsigndocumentName") + e_ezsigndocument_step: FieldEEzsigndocumentStep = Field(alias="eEzsigndocumentStep") + dt_ezsigndocument_firstsend: Optional[StrictStr] = Field(default=None, description="The date and time when the Ezsigndocument was first sent.", alias="dtEzsigndocumentFirstsend") + dt_ezsigndocument_lastsend: Optional[StrictStr] = Field(default=None, description="The date and time when the Ezsigndocument was sent the last time.", alias="dtEzsigndocumentLastsend") + i_ezsigndocument_order: Annotated[int, Field(strict=True, ge=1)] = Field(description="The order in which the Ezsigndocument will be presented to the signatory in the Ezsignfolder.", alias="iEzsigndocumentOrder") + i_ezsigndocument_pagetotal: Annotated[int, Field(strict=True, ge=1)] = Field(description="The number of pages in the Ezsigndocument.", alias="iEzsigndocumentPagetotal") + i_ezsigndocument_signaturesigned: Annotated[int, Field(strict=True, ge=0)] = Field(description="The number of signatures that were signed in the document.", alias="iEzsigndocumentSignaturesigned") + i_ezsigndocument_signaturetotal: Annotated[int, Field(strict=True, ge=0)] = Field(description="The number of total signatures that were requested in the Ezsigndocument.", alias="iEzsigndocumentSignaturetotal") + s_ezsigndocument_md5initial: Optional[StrictStr] = Field(default=None, description="MD5 Hash of the initial PDF Document before signatures were applied to it.", alias="sEzsigndocumentMD5initial") + t_ezsigndocument_declinedtosignreason: Optional[StrictStr] = Field(default=None, description="A custom text message that will contain the refusal message if the Ezsigndocument is declined to sign", alias="tEzsigndocumentDeclinedtosignreason") + s_ezsigndocument_md5signed: Optional[StrictStr] = Field(default=None, description="MD5 Hash of the final PDF Document after all signatures were applied to it.", alias="sEzsigndocumentMD5signed") + b_ezsigndocument_ezsignform: Optional[StrictBool] = Field(default=None, description="If the Ezsigndocument contains an Ezsignform or not", alias="bEzsigndocumentEzsignform") + b_ezsigndocument_hassignedsignatures: Optional[StrictBool] = Field(default=None, description="If the Ezsigndocument contains signed signatures (From internal or external sources)", alias="bEzsigndocumentHassignedsignatures") + obj_audit: Optional[CommonAudit] = Field(default=None, alias="objAudit") + s_ezsigndocument_externalid: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="This field can be used to store an External ID from the client's system. Anything can be stored in this field, it will never be evaluated by the eZmax system and will be returned AS-IS. To store multiple values, consider using a JSON formatted structure, a URL encoded string, a CSV or any other custom format. ", alias="sEzsigndocumentExternalid") + i_ezsigndocument_ezsignsignatureattachmenttotal: Annotated[int, Field(strict=True, ge=0)] = Field(description="The number of Ezsigndocumentattachment total", alias="iEzsigndocumentEzsignsignatureattachmenttotal") + __properties: ClassVar[List[str]] = ["pkiEzsigndocumentID", "fkiEzsignfolderID", "fkiEzsignfoldersignerassociationIDDeclinedtosign", "dtEzsigndocumentDuedate", "dtEzsignformCompleted", "fkiLanguageID", "sEzsigndocumentName", "eEzsigndocumentStep", "dtEzsigndocumentFirstsend", "dtEzsigndocumentLastsend", "iEzsigndocumentOrder", "iEzsigndocumentPagetotal", "iEzsigndocumentSignaturesigned", "iEzsigndocumentSignaturetotal", "sEzsigndocumentMD5initial", "tEzsigndocumentDeclinedtosignreason", "sEzsigndocumentMD5signed", "bEzsigndocumentEzsignform", "bEzsigndocumentHassignedsignatures", "objAudit", "sEzsigndocumentExternalid", "iEzsigndocumentEzsignsignatureattachmenttotal"] + + @field_validator('s_ezsigndocument_externalid') def s_ezsigndocument_externalid_validate_regular_expression(cls, value): """Validates the regular expression""" if value is None: @@ -61,66 +68,80 @@ def s_ezsigndocument_externalid_validate_regular_expression(cls, value): raise ValueError(r"must validate the regular expression /^.{0,64}$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigndocumentResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigndocumentResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_audit if self.obj_audit: _dict['objAudit'] = self.obj_audit.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigndocumentResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigndocumentResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigndocumentResponse.parse_obj(obj) - - _obj = EzsigndocumentResponse.parse_obj({ - "pki_ezsigndocument_id": obj.get("pkiEzsigndocumentID"), - "fki_ezsignfolder_id": obj.get("fkiEzsignfolderID"), - "fki_ezsignfoldersignerassociation_id_declinedtosign": obj.get("fkiEzsignfoldersignerassociationIDDeclinedtosign"), - "dt_ezsigndocument_duedate": obj.get("dtEzsigndocumentDuedate"), - "dt_ezsignform_completed": obj.get("dtEzsignformCompleted"), - "fki_language_id": obj.get("fkiLanguageID"), - "s_ezsigndocument_name": obj.get("sEzsigndocumentName"), - "e_ezsigndocument_step": obj.get("eEzsigndocumentStep"), - "dt_ezsigndocument_firstsend": obj.get("dtEzsigndocumentFirstsend"), - "dt_ezsigndocument_lastsend": obj.get("dtEzsigndocumentLastsend"), - "i_ezsigndocument_order": obj.get("iEzsigndocumentOrder"), - "i_ezsigndocument_pagetotal": obj.get("iEzsigndocumentPagetotal"), - "i_ezsigndocument_signaturesigned": obj.get("iEzsigndocumentSignaturesigned"), - "i_ezsigndocument_signaturetotal": obj.get("iEzsigndocumentSignaturetotal"), - "s_ezsigndocument_md5initial": obj.get("sEzsigndocumentMD5initial"), - "t_ezsigndocument_declinedtosignreason": obj.get("tEzsigndocumentDeclinedtosignreason"), - "s_ezsigndocument_md5signed": obj.get("sEzsigndocumentMD5signed"), - "b_ezsigndocument_ezsignform": obj.get("bEzsigndocumentEzsignform"), - "b_ezsigndocument_hassignedsignatures": obj.get("bEzsigndocumentHassignedsignatures"), - "obj_audit": CommonAudit.from_dict(obj.get("objAudit")) if obj.get("objAudit") is not None else None, - "s_ezsigndocument_externalid": obj.get("sEzsigndocumentExternalid") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsigndocumentID": obj.get("pkiEzsigndocumentID"), + "fkiEzsignfolderID": obj.get("fkiEzsignfolderID"), + "fkiEzsignfoldersignerassociationIDDeclinedtosign": obj.get("fkiEzsignfoldersignerassociationIDDeclinedtosign"), + "dtEzsigndocumentDuedate": obj.get("dtEzsigndocumentDuedate"), + "dtEzsignformCompleted": obj.get("dtEzsignformCompleted"), + "fkiLanguageID": obj.get("fkiLanguageID"), + "sEzsigndocumentName": obj.get("sEzsigndocumentName"), + "eEzsigndocumentStep": obj.get("eEzsigndocumentStep"), + "dtEzsigndocumentFirstsend": obj.get("dtEzsigndocumentFirstsend"), + "dtEzsigndocumentLastsend": obj.get("dtEzsigndocumentLastsend"), + "iEzsigndocumentOrder": obj.get("iEzsigndocumentOrder"), + "iEzsigndocumentPagetotal": obj.get("iEzsigndocumentPagetotal"), + "iEzsigndocumentSignaturesigned": obj.get("iEzsigndocumentSignaturesigned"), + "iEzsigndocumentSignaturetotal": obj.get("iEzsigndocumentSignaturetotal"), + "sEzsigndocumentMD5initial": obj.get("sEzsigndocumentMD5initial"), + "tEzsigndocumentDeclinedtosignreason": obj.get("tEzsigndocumentDeclinedtosignreason"), + "sEzsigndocumentMD5signed": obj.get("sEzsigndocumentMD5signed"), + "bEzsigndocumentEzsignform": obj.get("bEzsigndocumentEzsignform"), + "bEzsigndocumentHassignedsignatures": obj.get("bEzsigndocumentHassignedsignatures"), + "objAudit": CommonAudit.from_dict(obj.get("objAudit")) if obj.get("objAudit") is not None else None, + "sEzsigndocumentExternalid": obj.get("sEzsigndocumentExternalid"), + "iEzsigndocumentEzsignsignatureattachmenttotal": obj.get("iEzsigndocumentEzsignsignatureattachmenttotal") }) return _obj diff --git a/eZmaxApi/models/ezsigndocument_response_compound.py b/eZmaxApi/models/ezsigndocument_response_compound.py index 65a4cfb08..aebee9e54 100644 --- a/eZmaxApi/models/ezsigndocument_response_compound.py +++ b/eZmaxApi/models/ezsigndocument_response_compound.py @@ -19,47 +19,54 @@ import json -from typing import List, Optional -from pydantic import BaseModel, Field, StrictBool, StrictInt, StrictStr, conint, conlist, constr, validator +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, StrictInt, StrictStr, field_validator +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.common_audit import CommonAudit from eZmaxApi.models.computed_e_ezsigndocument_steptype import ComputedEEzsigndocumentSteptype from eZmaxApi.models.custom_ezsignfoldersignerassociationstatus_response import CustomEzsignfoldersignerassociationstatusResponse from eZmaxApi.models.field_e_ezsigndocument_step import FieldEEzsigndocumentStep +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigndocumentResponseCompound(BaseModel): """ - An Ezsigndocument Object and children to create a complete structure # noqa: E501 - """ - pki_ezsigndocument_id: conint(strict=True, ge=0) = Field(..., alias="pkiEzsigndocumentID", description="The unique ID of the Ezsigndocument") - fki_ezsignfolder_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsignfolderID", description="The unique ID of the Ezsignfolder") - fki_ezsignfoldersignerassociation_id_declinedtosign: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiEzsignfoldersignerassociationIDDeclinedtosign", description="The unique ID of the Ezsignfoldersignerassociation") - dt_ezsigndocument_duedate: StrictStr = Field(..., alias="dtEzsigndocumentDuedate", description="The maximum date and time at which the Ezsigndocument can be signed.") - dt_ezsignform_completed: Optional[StrictStr] = Field(None, alias="dtEzsignformCompleted", description="The date and time at which the Ezsignform has been completed.") - fki_language_id: Optional[conint(strict=True, le=2, ge=1)] = Field(None, alias="fkiLanguageID", description="The unique ID of the Language. Valid values: |Value|Description| |-|-| |1|French| |2|English|") - s_ezsigndocument_name: StrictStr = Field(..., alias="sEzsigndocumentName", description="The name of the document that will be presented to Ezsignfoldersignerassociations") - e_ezsigndocument_step: FieldEEzsigndocumentStep = Field(..., alias="eEzsigndocumentStep") - dt_ezsigndocument_firstsend: Optional[StrictStr] = Field(None, alias="dtEzsigndocumentFirstsend", description="The date and time when the Ezsigndocument was first sent.") - dt_ezsigndocument_lastsend: Optional[StrictStr] = Field(None, alias="dtEzsigndocumentLastsend", description="The date and time when the Ezsigndocument was sent the last time.") - i_ezsigndocument_order: conint(strict=True, ge=1) = Field(..., alias="iEzsigndocumentOrder", description="The order in which the Ezsigndocument will be presented to the signatory in the Ezsignfolder.") - i_ezsigndocument_pagetotal: conint(strict=True, ge=1) = Field(..., alias="iEzsigndocumentPagetotal", description="The number of pages in the Ezsigndocument.") - i_ezsigndocument_signaturesigned: conint(strict=True, ge=0) = Field(..., alias="iEzsigndocumentSignaturesigned", description="The number of signatures that were signed in the document.") - i_ezsigndocument_signaturetotal: conint(strict=True, ge=0) = Field(..., alias="iEzsigndocumentSignaturetotal", description="The number of total signatures that were requested in the Ezsigndocument.") - s_ezsigndocument_md5initial: Optional[StrictStr] = Field(None, alias="sEzsigndocumentMD5initial", description="MD5 Hash of the initial PDF Document before signatures were applied to it.") - t_ezsigndocument_declinedtosignreason: Optional[StrictStr] = Field(None, alias="tEzsigndocumentDeclinedtosignreason", description="A custom text message that will contain the refusal message if the Ezsigndocument is declined to sign") - s_ezsigndocument_md5signed: Optional[StrictStr] = Field(None, alias="sEzsigndocumentMD5signed", description="MD5 Hash of the final PDF Document after all signatures were applied to it.") - b_ezsigndocument_ezsignform: Optional[StrictBool] = Field(None, alias="bEzsigndocumentEzsignform", description="If the Ezsigndocument contains an Ezsignform or not") - b_ezsigndocument_hassignedsignatures: Optional[StrictBool] = Field(None, alias="bEzsigndocumentHassignedsignatures", description="If the Ezsigndocument contains signed signatures (From internal or external sources)") - obj_audit: Optional[CommonAudit] = Field(None, alias="objAudit") - s_ezsigndocument_externalid: Optional[constr(strict=True)] = Field(None, alias="sEzsigndocumentExternalid", description="This field can be used to store an External ID from the client's system. Anything can be stored in this field, it will never be evaluated by the eZmax system and will be returned AS-IS. To store multiple values, consider using a JSON formatted structure, a URL encoded string, a CSV or any other custom format. ") - e_ezsigndocument_steptype: ComputedEEzsigndocumentSteptype = Field(..., alias="eEzsigndocumentSteptype") - i_ezsigndocument_stepformtotal: StrictInt = Field(..., alias="iEzsigndocumentStepformtotal", description="The total number of steps in the form filling phase") - i_ezsigndocument_stepformcurrent: StrictInt = Field(..., alias="iEzsigndocumentStepformcurrent", description="The current step in the form filling phase") - i_ezsigndocument_stepsignaturetotal: StrictInt = Field(..., alias="iEzsigndocumentStepsignaturetotal", description="The total number of steps in the signature filling phase") - i_ezsigndocument_stepsignature_current: StrictInt = Field(..., alias="iEzsigndocumentStepsignatureCurrent", description="The current step in the signature phase") - a_obj_ezsignfoldersignerassociationstatus: conlist(CustomEzsignfoldersignerassociationstatusResponse) = Field(..., alias="a_objEzsignfoldersignerassociationstatus") - __properties = ["pkiEzsigndocumentID", "fkiEzsignfolderID", "fkiEzsignfoldersignerassociationIDDeclinedtosign", "dtEzsigndocumentDuedate", "dtEzsignformCompleted", "fkiLanguageID", "sEzsigndocumentName", "eEzsigndocumentStep", "dtEzsigndocumentFirstsend", "dtEzsigndocumentLastsend", "iEzsigndocumentOrder", "iEzsigndocumentPagetotal", "iEzsigndocumentSignaturesigned", "iEzsigndocumentSignaturetotal", "sEzsigndocumentMD5initial", "tEzsigndocumentDeclinedtosignreason", "sEzsigndocumentMD5signed", "bEzsigndocumentEzsignform", "bEzsigndocumentHassignedsignatures", "objAudit", "sEzsigndocumentExternalid", "eEzsigndocumentSteptype", "iEzsigndocumentStepformtotal", "iEzsigndocumentStepformcurrent", "iEzsigndocumentStepsignaturetotal", "iEzsigndocumentStepsignatureCurrent", "a_objEzsignfoldersignerassociationstatus"] - - @validator('s_ezsigndocument_externalid') + An Ezsigndocument Object and children to create a complete structure + """ # noqa: E501 + pki_ezsigndocument_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsigndocument", alias="pkiEzsigndocumentID") + fki_ezsignfolder_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsignfolder", alias="fkiEzsignfolderID") + fki_ezsignfoldersignerassociation_id_declinedtosign: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsignfoldersignerassociation", alias="fkiEzsignfoldersignerassociationIDDeclinedtosign") + dt_ezsigndocument_duedate: StrictStr = Field(description="The maximum date and time at which the Ezsigndocument can be signed.", alias="dtEzsigndocumentDuedate") + dt_ezsignform_completed: Optional[StrictStr] = Field(default=None, description="The date and time at which the Ezsignform has been completed.", alias="dtEzsignformCompleted") + fki_language_id: Optional[Annotated[int, Field(le=2, strict=True, ge=1)]] = Field(default=None, description="The unique ID of the Language. Valid values: |Value|Description| |-|-| |1|French| |2|English|", alias="fkiLanguageID") + s_ezsigndocument_name: StrictStr = Field(description="The name of the document that will be presented to Ezsignfoldersignerassociations", alias="sEzsigndocumentName") + e_ezsigndocument_step: FieldEEzsigndocumentStep = Field(alias="eEzsigndocumentStep") + dt_ezsigndocument_firstsend: Optional[StrictStr] = Field(default=None, description="The date and time when the Ezsigndocument was first sent.", alias="dtEzsigndocumentFirstsend") + dt_ezsigndocument_lastsend: Optional[StrictStr] = Field(default=None, description="The date and time when the Ezsigndocument was sent the last time.", alias="dtEzsigndocumentLastsend") + i_ezsigndocument_order: Annotated[int, Field(strict=True, ge=1)] = Field(description="The order in which the Ezsigndocument will be presented to the signatory in the Ezsignfolder.", alias="iEzsigndocumentOrder") + i_ezsigndocument_pagetotal: Annotated[int, Field(strict=True, ge=1)] = Field(description="The number of pages in the Ezsigndocument.", alias="iEzsigndocumentPagetotal") + i_ezsigndocument_signaturesigned: Annotated[int, Field(strict=True, ge=0)] = Field(description="The number of signatures that were signed in the document.", alias="iEzsigndocumentSignaturesigned") + i_ezsigndocument_signaturetotal: Annotated[int, Field(strict=True, ge=0)] = Field(description="The number of total signatures that were requested in the Ezsigndocument.", alias="iEzsigndocumentSignaturetotal") + s_ezsigndocument_md5initial: Optional[StrictStr] = Field(default=None, description="MD5 Hash of the initial PDF Document before signatures were applied to it.", alias="sEzsigndocumentMD5initial") + t_ezsigndocument_declinedtosignreason: Optional[StrictStr] = Field(default=None, description="A custom text message that will contain the refusal message if the Ezsigndocument is declined to sign", alias="tEzsigndocumentDeclinedtosignreason") + s_ezsigndocument_md5signed: Optional[StrictStr] = Field(default=None, description="MD5 Hash of the final PDF Document after all signatures were applied to it.", alias="sEzsigndocumentMD5signed") + b_ezsigndocument_ezsignform: Optional[StrictBool] = Field(default=None, description="If the Ezsigndocument contains an Ezsignform or not", alias="bEzsigndocumentEzsignform") + b_ezsigndocument_hassignedsignatures: Optional[StrictBool] = Field(default=None, description="If the Ezsigndocument contains signed signatures (From internal or external sources)", alias="bEzsigndocumentHassignedsignatures") + obj_audit: Optional[CommonAudit] = Field(default=None, alias="objAudit") + s_ezsigndocument_externalid: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="This field can be used to store an External ID from the client's system. Anything can be stored in this field, it will never be evaluated by the eZmax system and will be returned AS-IS. To store multiple values, consider using a JSON formatted structure, a URL encoded string, a CSV or any other custom format. ", alias="sEzsigndocumentExternalid") + i_ezsigndocument_ezsignsignatureattachmenttotal: Annotated[int, Field(strict=True, ge=0)] = Field(description="The number of Ezsigndocumentattachment total", alias="iEzsigndocumentEzsignsignatureattachmenttotal") + e_ezsigndocument_steptype: ComputedEEzsigndocumentSteptype = Field(alias="eEzsigndocumentSteptype") + i_ezsigndocument_stepformtotal: StrictInt = Field(description="The total number of steps in the form filling phase", alias="iEzsigndocumentStepformtotal") + i_ezsigndocument_stepformcurrent: StrictInt = Field(description="The current step in the form filling phase", alias="iEzsigndocumentStepformcurrent") + i_ezsigndocument_stepsignaturetotal: StrictInt = Field(description="The total number of steps in the signature filling phase", alias="iEzsigndocumentStepsignaturetotal") + i_ezsigndocument_stepsignature_current: StrictInt = Field(description="The current step in the signature phase", alias="iEzsigndocumentStepsignatureCurrent") + a_obj_ezsignfoldersignerassociationstatus: List[CustomEzsignfoldersignerassociationstatusResponse] = Field(alias="a_objEzsignfoldersignerassociationstatus") + __properties: ClassVar[List[str]] = ["pkiEzsigndocumentID", "fkiEzsignfolderID", "fkiEzsignfoldersignerassociationIDDeclinedtosign", "dtEzsigndocumentDuedate", "dtEzsignformCompleted", "fkiLanguageID", "sEzsigndocumentName", "eEzsigndocumentStep", "dtEzsigndocumentFirstsend", "dtEzsigndocumentLastsend", "iEzsigndocumentOrder", "iEzsigndocumentPagetotal", "iEzsigndocumentSignaturesigned", "iEzsigndocumentSignaturetotal", "sEzsigndocumentMD5initial", "tEzsigndocumentDeclinedtosignreason", "sEzsigndocumentMD5signed", "bEzsigndocumentEzsignform", "bEzsigndocumentHassignedsignatures", "objAudit", "sEzsigndocumentExternalid", "iEzsigndocumentEzsignsignatureattachmenttotal", "eEzsigndocumentSteptype", "iEzsigndocumentStepformtotal", "iEzsigndocumentStepformcurrent", "iEzsigndocumentStepsignaturetotal", "iEzsigndocumentStepsignatureCurrent", "a_objEzsignfoldersignerassociationstatus"] + + @field_validator('s_ezsigndocument_externalid') def s_ezsigndocument_externalid_validate_regular_expression(cls, value): """Validates the regular expression""" if value is None: @@ -69,30 +76,43 @@ def s_ezsigndocument_externalid_validate_regular_expression(cls, value): raise ValueError(r"must validate the regular expression /^.{0,64}$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigndocumentResponseCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigndocumentResponseCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_audit if self.obj_audit: _dict['objAudit'] = self.obj_audit.to_dict() @@ -106,42 +126,43 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigndocumentResponseCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigndocumentResponseCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigndocumentResponseCompound.parse_obj(obj) - - _obj = EzsigndocumentResponseCompound.parse_obj({ - "pki_ezsigndocument_id": obj.get("pkiEzsigndocumentID"), - "fki_ezsignfolder_id": obj.get("fkiEzsignfolderID"), - "fki_ezsignfoldersignerassociation_id_declinedtosign": obj.get("fkiEzsignfoldersignerassociationIDDeclinedtosign"), - "dt_ezsigndocument_duedate": obj.get("dtEzsigndocumentDuedate"), - "dt_ezsignform_completed": obj.get("dtEzsignformCompleted"), - "fki_language_id": obj.get("fkiLanguageID"), - "s_ezsigndocument_name": obj.get("sEzsigndocumentName"), - "e_ezsigndocument_step": obj.get("eEzsigndocumentStep"), - "dt_ezsigndocument_firstsend": obj.get("dtEzsigndocumentFirstsend"), - "dt_ezsigndocument_lastsend": obj.get("dtEzsigndocumentLastsend"), - "i_ezsigndocument_order": obj.get("iEzsigndocumentOrder"), - "i_ezsigndocument_pagetotal": obj.get("iEzsigndocumentPagetotal"), - "i_ezsigndocument_signaturesigned": obj.get("iEzsigndocumentSignaturesigned"), - "i_ezsigndocument_signaturetotal": obj.get("iEzsigndocumentSignaturetotal"), - "s_ezsigndocument_md5initial": obj.get("sEzsigndocumentMD5initial"), - "t_ezsigndocument_declinedtosignreason": obj.get("tEzsigndocumentDeclinedtosignreason"), - "s_ezsigndocument_md5signed": obj.get("sEzsigndocumentMD5signed"), - "b_ezsigndocument_ezsignform": obj.get("bEzsigndocumentEzsignform"), - "b_ezsigndocument_hassignedsignatures": obj.get("bEzsigndocumentHassignedsignatures"), - "obj_audit": CommonAudit.from_dict(obj.get("objAudit")) if obj.get("objAudit") is not None else None, - "s_ezsigndocument_externalid": obj.get("sEzsigndocumentExternalid"), - "e_ezsigndocument_steptype": obj.get("eEzsigndocumentSteptype"), - "i_ezsigndocument_stepformtotal": obj.get("iEzsigndocumentStepformtotal"), - "i_ezsigndocument_stepformcurrent": obj.get("iEzsigndocumentStepformcurrent"), - "i_ezsigndocument_stepsignaturetotal": obj.get("iEzsigndocumentStepsignaturetotal"), - "i_ezsigndocument_stepsignature_current": obj.get("iEzsigndocumentStepsignatureCurrent"), - "a_obj_ezsignfoldersignerassociationstatus": [CustomEzsignfoldersignerassociationstatusResponse.from_dict(_item) for _item in obj.get("a_objEzsignfoldersignerassociationstatus")] if obj.get("a_objEzsignfoldersignerassociationstatus") is not None else None + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsigndocumentID": obj.get("pkiEzsigndocumentID"), + "fkiEzsignfolderID": obj.get("fkiEzsignfolderID"), + "fkiEzsignfoldersignerassociationIDDeclinedtosign": obj.get("fkiEzsignfoldersignerassociationIDDeclinedtosign"), + "dtEzsigndocumentDuedate": obj.get("dtEzsigndocumentDuedate"), + "dtEzsignformCompleted": obj.get("dtEzsignformCompleted"), + "fkiLanguageID": obj.get("fkiLanguageID"), + "sEzsigndocumentName": obj.get("sEzsigndocumentName"), + "eEzsigndocumentStep": obj.get("eEzsigndocumentStep"), + "dtEzsigndocumentFirstsend": obj.get("dtEzsigndocumentFirstsend"), + "dtEzsigndocumentLastsend": obj.get("dtEzsigndocumentLastsend"), + "iEzsigndocumentOrder": obj.get("iEzsigndocumentOrder"), + "iEzsigndocumentPagetotal": obj.get("iEzsigndocumentPagetotal"), + "iEzsigndocumentSignaturesigned": obj.get("iEzsigndocumentSignaturesigned"), + "iEzsigndocumentSignaturetotal": obj.get("iEzsigndocumentSignaturetotal"), + "sEzsigndocumentMD5initial": obj.get("sEzsigndocumentMD5initial"), + "tEzsigndocumentDeclinedtosignreason": obj.get("tEzsigndocumentDeclinedtosignreason"), + "sEzsigndocumentMD5signed": obj.get("sEzsigndocumentMD5signed"), + "bEzsigndocumentEzsignform": obj.get("bEzsigndocumentEzsignform"), + "bEzsigndocumentHassignedsignatures": obj.get("bEzsigndocumentHassignedsignatures"), + "objAudit": CommonAudit.from_dict(obj.get("objAudit")) if obj.get("objAudit") is not None else None, + "sEzsigndocumentExternalid": obj.get("sEzsigndocumentExternalid"), + "iEzsigndocumentEzsignsignatureattachmenttotal": obj.get("iEzsigndocumentEzsignsignatureattachmenttotal"), + "eEzsigndocumentSteptype": obj.get("eEzsigndocumentSteptype"), + "iEzsigndocumentStepformtotal": obj.get("iEzsigndocumentStepformtotal"), + "iEzsigndocumentStepformcurrent": obj.get("iEzsigndocumentStepformcurrent"), + "iEzsigndocumentStepsignaturetotal": obj.get("iEzsigndocumentStepsignaturetotal"), + "iEzsigndocumentStepsignatureCurrent": obj.get("iEzsigndocumentStepsignatureCurrent"), + "a_objEzsignfoldersignerassociationstatus": [CustomEzsignfoldersignerassociationstatusResponse.from_dict(_item) for _item in obj.get("a_objEzsignfoldersignerassociationstatus")] if obj.get("a_objEzsignfoldersignerassociationstatus") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigndocument_submit_ezsignform_v1_request.py b/eZmaxApi/models/ezsigndocument_submit_ezsignform_v1_request.py index 9cf3ff0f2..dd9a52e2e 100644 --- a/eZmaxApi/models/ezsigndocument_submit_ezsignform_v1_request.py +++ b/eZmaxApi/models/ezsigndocument_submit_ezsignform_v1_request.py @@ -19,42 +19,61 @@ import json -from typing import List -from pydantic import BaseModel, Field, StrictBool, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictBool +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.custom_ezsignformfieldgroup_request import CustomEzsignformfieldgroupRequest +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigndocumentSubmitEzsignformV1Request(BaseModel): """ - Request for POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/submitEzsignform # noqa: E501 - """ - b_ezsignform_isdraft: StrictBool = Field(..., alias="bEzsignformIsdraft", description="Whether the Ezsignform submitted is a draft or not.") - a_obj_ezsignformfieldgroup: conlist(CustomEzsignformfieldgroupRequest, min_items=1) = Field(..., alias="a_objEzsignformfieldgroup") - __properties = ["bEzsignformIsdraft", "a_objEzsignformfieldgroup"] + Request for POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/submitEzsignform + """ # noqa: E501 + b_ezsignform_isdraft: StrictBool = Field(description="Whether the Ezsignform submitted is a draft or not.", alias="bEzsignformIsdraft") + a_obj_ezsignformfieldgroup: Annotated[List[CustomEzsignformfieldgroupRequest], Field(min_length=1)] = Field(alias="a_objEzsignformfieldgroup") + __properties: ClassVar[List[str]] = ["bEzsignformIsdraft", "a_objEzsignformfieldgroup"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigndocumentSubmitEzsignformV1Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigndocumentSubmitEzsignformV1Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_ezsignformfieldgroup (list) _items = [] if self.a_obj_ezsignformfieldgroup: @@ -65,17 +84,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigndocumentSubmitEzsignformV1Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigndocumentSubmitEzsignformV1Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigndocumentSubmitEzsignformV1Request.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigndocumentSubmitEzsignformV1Request.parse_obj({ - "b_ezsignform_isdraft": obj.get("bEzsignformIsdraft"), - "a_obj_ezsignformfieldgroup": [CustomEzsignformfieldgroupRequest.from_dict(_item) for _item in obj.get("a_objEzsignformfieldgroup")] if obj.get("a_objEzsignformfieldgroup") is not None else None + _obj = cls.model_validate({ + "bEzsignformIsdraft": obj.get("bEzsignformIsdraft"), + "a_objEzsignformfieldgroup": [CustomEzsignformfieldgroupRequest.from_dict(_item) for _item in obj.get("a_objEzsignformfieldgroup")] if obj.get("a_objEzsignformfieldgroup") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigndocument_submit_ezsignform_v1_response.py b/eZmaxApi/models/ezsigndocument_submit_ezsignform_v1_response.py index 478b6eec7..7600d6b99 100644 --- a/eZmaxApi/models/ezsigndocument_submit_ezsignform_v1_response.py +++ b/eZmaxApi/models/ezsigndocument_submit_ezsignform_v1_response.py @@ -19,43 +19,61 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigndocumentSubmitEzsignformV1Response(BaseModel): """ - Response for POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/submitEzsignform # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - __properties = ["objDebugPayload", "objDebug"] + Response for POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/submitEzsignform + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigndocumentSubmitEzsignformV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigndocumentSubmitEzsignformV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -65,17 +83,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigndocumentSubmitEzsignformV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigndocumentSubmitEzsignformV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigndocumentSubmitEzsignformV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigndocumentSubmitEzsignformV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigndocument_unsend_v1_response.py b/eZmaxApi/models/ezsigndocument_unsend_v1_response.py index 4f64fb15b..35eea88c3 100644 --- a/eZmaxApi/models/ezsigndocument_unsend_v1_response.py +++ b/eZmaxApi/models/ezsigndocument_unsend_v1_response.py @@ -19,43 +19,61 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigndocumentUnsendV1Response(BaseModel): """ - Response for POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/unsend # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - __properties = ["objDebugPayload", "objDebug"] + Response for POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/unsend + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigndocumentUnsendV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigndocumentUnsendV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -65,17 +83,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigndocumentUnsendV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigndocumentUnsendV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigndocumentUnsendV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigndocumentUnsendV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigndocumentlog_response.py b/eZmaxApi/models/ezsigndocumentlog_response.py index 80ce4b718..81255c482 100644 --- a/eZmaxApi/models/ezsigndocumentlog_response.py +++ b/eZmaxApi/models/ezsigndocumentlog_response.py @@ -19,68 +19,87 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictStr, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictStr +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.field_e_ezsigndocumentlog_type import FieldEEzsigndocumentlogType +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigndocumentlogResponse(BaseModel): """ - An Ezsigndocumentlog Object # noqa: E501 - """ - fki_user_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiUserID", description="The unique ID of the User") - fki_ezsignsigner_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiEzsignsignerID", description="The unique ID of the Ezsignsigner") - dt_ezsigndocumentlog_datetime: StrictStr = Field(..., alias="dtEzsigndocumentlogDatetime", description="The date and time at which the event was logged") - e_ezsigndocumentlog_type: FieldEEzsigndocumentlogType = Field(..., alias="eEzsigndocumentlogType") - s_ezsigndocumentlog_detail: StrictStr = Field(..., alias="sEzsigndocumentlogDetail", description="The detail of the Ezsigndocumentlog") - s_ezsigndocumentlog_lastname: StrictStr = Field(..., alias="sEzsigndocumentlogLastname", description="The last name of the User or Ezsignsigner") - s_ezsigndocumentlog_firstname: StrictStr = Field(..., alias="sEzsigndocumentlogFirstname", description="The first name of the User or Ezsignsigner") - s_ezsigndocumentlog_ip: StrictStr = Field(..., alias="sEzsigndocumentlogIP", description="Represent an IP address.") - __properties = ["fkiUserID", "fkiEzsignsignerID", "dtEzsigndocumentlogDatetime", "eEzsigndocumentlogType", "sEzsigndocumentlogDetail", "sEzsigndocumentlogLastname", "sEzsigndocumentlogFirstname", "sEzsigndocumentlogIP"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + An Ezsigndocumentlog Object + """ # noqa: E501 + fki_user_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the User", alias="fkiUserID") + fki_ezsignsigner_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsignsigner", alias="fkiEzsignsignerID") + dt_ezsigndocumentlog_datetime: StrictStr = Field(description="The date and time at which the event was logged", alias="dtEzsigndocumentlogDatetime") + e_ezsigndocumentlog_type: FieldEEzsigndocumentlogType = Field(alias="eEzsigndocumentlogType") + s_ezsigndocumentlog_detail: StrictStr = Field(description="The detail of the Ezsigndocumentlog", alias="sEzsigndocumentlogDetail") + s_ezsigndocumentlog_lastname: StrictStr = Field(description="The last name of the User or Ezsignsigner", alias="sEzsigndocumentlogLastname") + s_ezsigndocumentlog_firstname: StrictStr = Field(description="The first name of the User or Ezsignsigner", alias="sEzsigndocumentlogFirstname") + s_ezsigndocumentlog_ip: StrictStr = Field(description="Represent an IP address.", alias="sEzsigndocumentlogIP") + __properties: ClassVar[List[str]] = ["fkiUserID", "fkiEzsignsignerID", "dtEzsigndocumentlogDatetime", "eEzsigndocumentlogType", "sEzsigndocumentlogDetail", "sEzsigndocumentlogLastname", "sEzsigndocumentlogFirstname", "sEzsigndocumentlogIP"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigndocumentlogResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigndocumentlogResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigndocumentlogResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigndocumentlogResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigndocumentlogResponse.parse_obj(obj) - - _obj = EzsigndocumentlogResponse.parse_obj({ - "fki_user_id": obj.get("fkiUserID"), - "fki_ezsignsigner_id": obj.get("fkiEzsignsignerID"), - "dt_ezsigndocumentlog_datetime": obj.get("dtEzsigndocumentlogDatetime"), - "e_ezsigndocumentlog_type": obj.get("eEzsigndocumentlogType"), - "s_ezsigndocumentlog_detail": obj.get("sEzsigndocumentlogDetail"), - "s_ezsigndocumentlog_lastname": obj.get("sEzsigndocumentlogLastname"), - "s_ezsigndocumentlog_firstname": obj.get("sEzsigndocumentlogFirstname"), - "s_ezsigndocumentlog_ip": obj.get("sEzsigndocumentlogIP") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "fkiUserID": obj.get("fkiUserID"), + "fkiEzsignsignerID": obj.get("fkiEzsignsignerID"), + "dtEzsigndocumentlogDatetime": obj.get("dtEzsigndocumentlogDatetime"), + "eEzsigndocumentlogType": obj.get("eEzsigndocumentlogType"), + "sEzsigndocumentlogDetail": obj.get("sEzsigndocumentlogDetail"), + "sEzsigndocumentlogLastname": obj.get("sEzsigndocumentlogLastname"), + "sEzsigndocumentlogFirstname": obj.get("sEzsigndocumentlogFirstname"), + "sEzsigndocumentlogIP": obj.get("sEzsigndocumentlogIP") }) return _obj diff --git a/eZmaxApi/models/ezsigndocumentlog_response_compound.py b/eZmaxApi/models/ezsigndocumentlog_response_compound.py index c0887f55e..395f214c3 100644 --- a/eZmaxApi/models/ezsigndocumentlog_response_compound.py +++ b/eZmaxApi/models/ezsigndocumentlog_response_compound.py @@ -19,68 +19,87 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictStr, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictStr +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.field_e_ezsigndocumentlog_type import FieldEEzsigndocumentlogType +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigndocumentlogResponseCompound(BaseModel): """ - An Ezsigndocumentlog Object and children to create a complete structure # noqa: E501 - """ - fki_user_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiUserID", description="The unique ID of the User") - fki_ezsignsigner_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiEzsignsignerID", description="The unique ID of the Ezsignsigner") - dt_ezsigndocumentlog_datetime: StrictStr = Field(..., alias="dtEzsigndocumentlogDatetime", description="The date and time at which the event was logged") - e_ezsigndocumentlog_type: FieldEEzsigndocumentlogType = Field(..., alias="eEzsigndocumentlogType") - s_ezsigndocumentlog_detail: StrictStr = Field(..., alias="sEzsigndocumentlogDetail", description="The detail of the Ezsigndocumentlog") - s_ezsigndocumentlog_lastname: StrictStr = Field(..., alias="sEzsigndocumentlogLastname", description="The last name of the User or Ezsignsigner") - s_ezsigndocumentlog_firstname: StrictStr = Field(..., alias="sEzsigndocumentlogFirstname", description="The first name of the User or Ezsignsigner") - s_ezsigndocumentlog_ip: StrictStr = Field(..., alias="sEzsigndocumentlogIP", description="Represent an IP address.") - __properties = ["fkiUserID", "fkiEzsignsignerID", "dtEzsigndocumentlogDatetime", "eEzsigndocumentlogType", "sEzsigndocumentlogDetail", "sEzsigndocumentlogLastname", "sEzsigndocumentlogFirstname", "sEzsigndocumentlogIP"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + An Ezsigndocumentlog Object and children to create a complete structure + """ # noqa: E501 + fki_user_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the User", alias="fkiUserID") + fki_ezsignsigner_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsignsigner", alias="fkiEzsignsignerID") + dt_ezsigndocumentlog_datetime: StrictStr = Field(description="The date and time at which the event was logged", alias="dtEzsigndocumentlogDatetime") + e_ezsigndocumentlog_type: FieldEEzsigndocumentlogType = Field(alias="eEzsigndocumentlogType") + s_ezsigndocumentlog_detail: StrictStr = Field(description="The detail of the Ezsigndocumentlog", alias="sEzsigndocumentlogDetail") + s_ezsigndocumentlog_lastname: StrictStr = Field(description="The last name of the User or Ezsignsigner", alias="sEzsigndocumentlogLastname") + s_ezsigndocumentlog_firstname: StrictStr = Field(description="The first name of the User or Ezsignsigner", alias="sEzsigndocumentlogFirstname") + s_ezsigndocumentlog_ip: StrictStr = Field(description="Represent an IP address.", alias="sEzsigndocumentlogIP") + __properties: ClassVar[List[str]] = ["fkiUserID", "fkiEzsignsignerID", "dtEzsigndocumentlogDatetime", "eEzsigndocumentlogType", "sEzsigndocumentlogDetail", "sEzsigndocumentlogLastname", "sEzsigndocumentlogFirstname", "sEzsigndocumentlogIP"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigndocumentlogResponseCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigndocumentlogResponseCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigndocumentlogResponseCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigndocumentlogResponseCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigndocumentlogResponseCompound.parse_obj(obj) - - _obj = EzsigndocumentlogResponseCompound.parse_obj({ - "fki_user_id": obj.get("fkiUserID"), - "fki_ezsignsigner_id": obj.get("fkiEzsignsignerID"), - "dt_ezsigndocumentlog_datetime": obj.get("dtEzsigndocumentlogDatetime"), - "e_ezsigndocumentlog_type": obj.get("eEzsigndocumentlogType"), - "s_ezsigndocumentlog_detail": obj.get("sEzsigndocumentlogDetail"), - "s_ezsigndocumentlog_lastname": obj.get("sEzsigndocumentlogLastname"), - "s_ezsigndocumentlog_firstname": obj.get("sEzsigndocumentlogFirstname"), - "s_ezsigndocumentlog_ip": obj.get("sEzsigndocumentlogIP") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "fkiUserID": obj.get("fkiUserID"), + "fkiEzsignsignerID": obj.get("fkiEzsignsignerID"), + "dtEzsigndocumentlogDatetime": obj.get("dtEzsigndocumentlogDatetime"), + "eEzsigndocumentlogType": obj.get("eEzsigndocumentlogType"), + "sEzsigndocumentlogDetail": obj.get("sEzsigndocumentlogDetail"), + "sEzsigndocumentlogLastname": obj.get("sEzsigndocumentlogLastname"), + "sEzsigndocumentlogFirstname": obj.get("sEzsigndocumentlogFirstname"), + "sEzsigndocumentlogIP": obj.get("sEzsigndocumentlogIP") }) return _obj diff --git a/eZmaxApi/models/ezsignelementdependency_request.py b/eZmaxApi/models/ezsignelementdependency_request.py index f1aa71267..c12a5b680 100644 --- a/eZmaxApi/models/ezsignelementdependency_request.py +++ b/eZmaxApi/models/ezsignelementdependency_request.py @@ -19,27 +19,33 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint, constr, validator +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, StrictStr, field_validator +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.field_e_ezsignelementdependency_operator import FieldEEzsignelementdependencyOperator from eZmaxApi.models.field_e_ezsignelementdependency_validation import FieldEEzsignelementdependencyValidation +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignelementdependencyRequest(BaseModel): """ - An Ezsignelementdependency Object # noqa: E501 - """ - pki_ezsignelementdependency_id: Optional[conint(strict=True, le=65535, ge=0)] = Field(None, alias="pkiEzsignelementdependencyID", description="The unique ID of the Ezsignelementdependency") - fki_ezsignformfield_id_validation: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiEzsignformfieldIDValidation", description="The unique ID of the Ezsignformfield") - fki_ezsignformfieldgroup_id_validation: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiEzsignformfieldgroupIDValidation", description="The unique ID of the Ezsignformfieldgroup") - s_ezsignelementdependency_ezsignformfieldgrouplabel: Optional[constr(strict=True, max_length=50, min_length=1)] = Field(None, alias="sEzsignelementdependencyEzsignformfieldgrouplabel", description="The Label for the Ezsignformfieldgroup") - s_ezsignelementdependency_ezsignformfieldlabel: Optional[StrictStr] = Field(None, alias="sEzsignelementdependencyEzsignformfieldlabel", description="The Label for the Ezsignformfield") - e_ezsignelementdependency_validation: FieldEEzsignelementdependencyValidation = Field(..., alias="eEzsignelementdependencyValidation") - b_ezsignelementdependency_selected: Optional[StrictBool] = Field(None, alias="bEzsignelementdependencySelected", description="Whether if it's selected or not when using eEzsignelementdependencyValidation = Selected") - e_ezsignelementdependency_operator: Optional[FieldEEzsignelementdependencyOperator] = Field(None, alias="eEzsignelementdependencyOperator") - s_ezsignelementdependency_value: Optional[constr(strict=True)] = Field(None, alias="sEzsignelementdependencyValue", description="The value of the Ezsignelementdependency") - __properties = ["pkiEzsignelementdependencyID", "fkiEzsignformfieldIDValidation", "fkiEzsignformfieldgroupIDValidation", "sEzsignelementdependencyEzsignformfieldgrouplabel", "sEzsignelementdependencyEzsignformfieldlabel", "eEzsignelementdependencyValidation", "bEzsignelementdependencySelected", "eEzsignelementdependencyOperator", "sEzsignelementdependencyValue"] - - @validator('s_ezsignelementdependency_value') + An Ezsignelementdependency Object + """ # noqa: E501 + pki_ezsignelementdependency_id: Optional[Annotated[int, Field(le=65535, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsignelementdependency", alias="pkiEzsignelementdependencyID") + fki_ezsignformfield_id_validation: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsignformfield", alias="fkiEzsignformfieldIDValidation") + fki_ezsignformfieldgroup_id_validation: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsignformfieldgroup", alias="fkiEzsignformfieldgroupIDValidation") + s_ezsignelementdependency_ezsignformfieldgrouplabel: Optional[Annotated[str, Field(min_length=1, strict=True, max_length=50)]] = Field(default=None, description="The Label for the Ezsignformfieldgroup", alias="sEzsignelementdependencyEzsignformfieldgrouplabel") + s_ezsignelementdependency_ezsignformfieldlabel: Optional[StrictStr] = Field(default=None, description="The Label for the Ezsignformfield", alias="sEzsignelementdependencyEzsignformfieldlabel") + e_ezsignelementdependency_validation: FieldEEzsignelementdependencyValidation = Field(alias="eEzsignelementdependencyValidation") + b_ezsignelementdependency_selected: Optional[StrictBool] = Field(default=None, description="Whether if it's selected or not when using eEzsignelementdependencyValidation = Selected", alias="bEzsignelementdependencySelected") + e_ezsignelementdependency_operator: Optional[FieldEEzsignelementdependencyOperator] = Field(default=None, alias="eEzsignelementdependencyOperator") + s_ezsignelementdependency_value: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="The value of the Ezsignelementdependency", alias="sEzsignelementdependencyValue") + __properties: ClassVar[List[str]] = ["pkiEzsignelementdependencyID", "fkiEzsignformfieldIDValidation", "fkiEzsignformfieldgroupIDValidation", "sEzsignelementdependencyEzsignformfieldgrouplabel", "sEzsignelementdependencyEzsignformfieldlabel", "eEzsignelementdependencyValidation", "bEzsignelementdependencySelected", "eEzsignelementdependencyOperator", "sEzsignelementdependencyValue"] + + @field_validator('s_ezsignelementdependency_value') def s_ezsignelementdependency_value_validate_regular_expression(cls, value): """Validates the regular expression""" if value is None: @@ -49,51 +55,64 @@ def s_ezsignelementdependency_value_validate_regular_expression(cls, value): raise ValueError(r"must validate the regular expression /^.{0,50}$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignelementdependencyRequest: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignelementdependencyRequest from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignelementdependencyRequest: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignelementdependencyRequest from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignelementdependencyRequest.parse_obj(obj) - - _obj = EzsignelementdependencyRequest.parse_obj({ - "pki_ezsignelementdependency_id": obj.get("pkiEzsignelementdependencyID"), - "fki_ezsignformfield_id_validation": obj.get("fkiEzsignformfieldIDValidation"), - "fki_ezsignformfieldgroup_id_validation": obj.get("fkiEzsignformfieldgroupIDValidation"), - "s_ezsignelementdependency_ezsignformfieldgrouplabel": obj.get("sEzsignelementdependencyEzsignformfieldgrouplabel"), - "s_ezsignelementdependency_ezsignformfieldlabel": obj.get("sEzsignelementdependencyEzsignformfieldlabel"), - "e_ezsignelementdependency_validation": obj.get("eEzsignelementdependencyValidation"), - "b_ezsignelementdependency_selected": obj.get("bEzsignelementdependencySelected"), - "e_ezsignelementdependency_operator": obj.get("eEzsignelementdependencyOperator"), - "s_ezsignelementdependency_value": obj.get("sEzsignelementdependencyValue") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsignelementdependencyID": obj.get("pkiEzsignelementdependencyID"), + "fkiEzsignformfieldIDValidation": obj.get("fkiEzsignformfieldIDValidation"), + "fkiEzsignformfieldgroupIDValidation": obj.get("fkiEzsignformfieldgroupIDValidation"), + "sEzsignelementdependencyEzsignformfieldgrouplabel": obj.get("sEzsignelementdependencyEzsignformfieldgrouplabel"), + "sEzsignelementdependencyEzsignformfieldlabel": obj.get("sEzsignelementdependencyEzsignformfieldlabel"), + "eEzsignelementdependencyValidation": obj.get("eEzsignelementdependencyValidation"), + "bEzsignelementdependencySelected": obj.get("bEzsignelementdependencySelected"), + "eEzsignelementdependencyOperator": obj.get("eEzsignelementdependencyOperator"), + "sEzsignelementdependencyValue": obj.get("sEzsignelementdependencyValue") }) return _obj diff --git a/eZmaxApi/models/ezsignelementdependency_request_compound.py b/eZmaxApi/models/ezsignelementdependency_request_compound.py index f568edc6e..3a7c27442 100644 --- a/eZmaxApi/models/ezsignelementdependency_request_compound.py +++ b/eZmaxApi/models/ezsignelementdependency_request_compound.py @@ -19,27 +19,33 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint, constr, validator +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, StrictStr, field_validator +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.field_e_ezsignelementdependency_operator import FieldEEzsignelementdependencyOperator from eZmaxApi.models.field_e_ezsignelementdependency_validation import FieldEEzsignelementdependencyValidation +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignelementdependencyRequestCompound(BaseModel): """ - An Ezsignelementdependency Object and children to create a complete structure # noqa: E501 - """ - pki_ezsignelementdependency_id: Optional[conint(strict=True, le=65535, ge=0)] = Field(None, alias="pkiEzsignelementdependencyID", description="The unique ID of the Ezsignelementdependency") - fki_ezsignformfield_id_validation: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiEzsignformfieldIDValidation", description="The unique ID of the Ezsignformfield") - fki_ezsignformfieldgroup_id_validation: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiEzsignformfieldgroupIDValidation", description="The unique ID of the Ezsignformfieldgroup") - s_ezsignelementdependency_ezsignformfieldgrouplabel: Optional[constr(strict=True, max_length=50, min_length=1)] = Field(None, alias="sEzsignelementdependencyEzsignformfieldgrouplabel", description="The Label for the Ezsignformfieldgroup") - s_ezsignelementdependency_ezsignformfieldlabel: Optional[StrictStr] = Field(None, alias="sEzsignelementdependencyEzsignformfieldlabel", description="The Label for the Ezsignformfield") - e_ezsignelementdependency_validation: FieldEEzsignelementdependencyValidation = Field(..., alias="eEzsignelementdependencyValidation") - b_ezsignelementdependency_selected: Optional[StrictBool] = Field(None, alias="bEzsignelementdependencySelected", description="Whether if it's selected or not when using eEzsignelementdependencyValidation = Selected") - e_ezsignelementdependency_operator: Optional[FieldEEzsignelementdependencyOperator] = Field(None, alias="eEzsignelementdependencyOperator") - s_ezsignelementdependency_value: Optional[constr(strict=True)] = Field(None, alias="sEzsignelementdependencyValue", description="The value of the Ezsignelementdependency") - __properties = ["pkiEzsignelementdependencyID", "fkiEzsignformfieldIDValidation", "fkiEzsignformfieldgroupIDValidation", "sEzsignelementdependencyEzsignformfieldgrouplabel", "sEzsignelementdependencyEzsignformfieldlabel", "eEzsignelementdependencyValidation", "bEzsignelementdependencySelected", "eEzsignelementdependencyOperator", "sEzsignelementdependencyValue"] - - @validator('s_ezsignelementdependency_value') + An Ezsignelementdependency Object and children to create a complete structure + """ # noqa: E501 + pki_ezsignelementdependency_id: Optional[Annotated[int, Field(le=65535, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsignelementdependency", alias="pkiEzsignelementdependencyID") + fki_ezsignformfield_id_validation: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsignformfield", alias="fkiEzsignformfieldIDValidation") + fki_ezsignformfieldgroup_id_validation: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsignformfieldgroup", alias="fkiEzsignformfieldgroupIDValidation") + s_ezsignelementdependency_ezsignformfieldgrouplabel: Optional[Annotated[str, Field(min_length=1, strict=True, max_length=50)]] = Field(default=None, description="The Label for the Ezsignformfieldgroup", alias="sEzsignelementdependencyEzsignformfieldgrouplabel") + s_ezsignelementdependency_ezsignformfieldlabel: Optional[StrictStr] = Field(default=None, description="The Label for the Ezsignformfield", alias="sEzsignelementdependencyEzsignformfieldlabel") + e_ezsignelementdependency_validation: FieldEEzsignelementdependencyValidation = Field(alias="eEzsignelementdependencyValidation") + b_ezsignelementdependency_selected: Optional[StrictBool] = Field(default=None, description="Whether if it's selected or not when using eEzsignelementdependencyValidation = Selected", alias="bEzsignelementdependencySelected") + e_ezsignelementdependency_operator: Optional[FieldEEzsignelementdependencyOperator] = Field(default=None, alias="eEzsignelementdependencyOperator") + s_ezsignelementdependency_value: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="The value of the Ezsignelementdependency", alias="sEzsignelementdependencyValue") + __properties: ClassVar[List[str]] = ["pkiEzsignelementdependencyID", "fkiEzsignformfieldIDValidation", "fkiEzsignformfieldgroupIDValidation", "sEzsignelementdependencyEzsignformfieldgrouplabel", "sEzsignelementdependencyEzsignformfieldlabel", "eEzsignelementdependencyValidation", "bEzsignelementdependencySelected", "eEzsignelementdependencyOperator", "sEzsignelementdependencyValue"] + + @field_validator('s_ezsignelementdependency_value') def s_ezsignelementdependency_value_validate_regular_expression(cls, value): """Validates the regular expression""" if value is None: @@ -49,51 +55,64 @@ def s_ezsignelementdependency_value_validate_regular_expression(cls, value): raise ValueError(r"must validate the regular expression /^.{0,50}$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignelementdependencyRequestCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignelementdependencyRequestCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignelementdependencyRequestCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignelementdependencyRequestCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignelementdependencyRequestCompound.parse_obj(obj) - - _obj = EzsignelementdependencyRequestCompound.parse_obj({ - "pki_ezsignelementdependency_id": obj.get("pkiEzsignelementdependencyID"), - "fki_ezsignformfield_id_validation": obj.get("fkiEzsignformfieldIDValidation"), - "fki_ezsignformfieldgroup_id_validation": obj.get("fkiEzsignformfieldgroupIDValidation"), - "s_ezsignelementdependency_ezsignformfieldgrouplabel": obj.get("sEzsignelementdependencyEzsignformfieldgrouplabel"), - "s_ezsignelementdependency_ezsignformfieldlabel": obj.get("sEzsignelementdependencyEzsignformfieldlabel"), - "e_ezsignelementdependency_validation": obj.get("eEzsignelementdependencyValidation"), - "b_ezsignelementdependency_selected": obj.get("bEzsignelementdependencySelected"), - "e_ezsignelementdependency_operator": obj.get("eEzsignelementdependencyOperator"), - "s_ezsignelementdependency_value": obj.get("sEzsignelementdependencyValue") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsignelementdependencyID": obj.get("pkiEzsignelementdependencyID"), + "fkiEzsignformfieldIDValidation": obj.get("fkiEzsignformfieldIDValidation"), + "fkiEzsignformfieldgroupIDValidation": obj.get("fkiEzsignformfieldgroupIDValidation"), + "sEzsignelementdependencyEzsignformfieldgrouplabel": obj.get("sEzsignelementdependencyEzsignformfieldgrouplabel"), + "sEzsignelementdependencyEzsignformfieldlabel": obj.get("sEzsignelementdependencyEzsignformfieldlabel"), + "eEzsignelementdependencyValidation": obj.get("eEzsignelementdependencyValidation"), + "bEzsignelementdependencySelected": obj.get("bEzsignelementdependencySelected"), + "eEzsignelementdependencyOperator": obj.get("eEzsignelementdependencyOperator"), + "sEzsignelementdependencyValue": obj.get("sEzsignelementdependencyValue") }) return _obj diff --git a/eZmaxApi/models/ezsignelementdependency_response.py b/eZmaxApi/models/ezsignelementdependency_response.py index aa6885da7..9cff7e46d 100644 --- a/eZmaxApi/models/ezsignelementdependency_response.py +++ b/eZmaxApi/models/ezsignelementdependency_response.py @@ -19,27 +19,33 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictBool, conint, constr, validator +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, field_validator +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.field_e_ezsignelementdependency_operator import FieldEEzsignelementdependencyOperator from eZmaxApi.models.field_e_ezsignelementdependency_validation import FieldEEzsignelementdependencyValidation +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignelementdependencyResponse(BaseModel): """ - An Ezsignelementdependency Object # noqa: E501 - """ - pki_ezsignelementdependency_id: conint(strict=True, le=65535, ge=0) = Field(..., alias="pkiEzsignelementdependencyID", description="The unique ID of the Ezsignelementdependency") - fki_ezsignformfield_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiEzsignformfieldID", description="The unique ID of the Ezsignformfield") - fki_ezsignsignature_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiEzsignsignatureID", description="The unique ID of the Ezsignsignature") - fki_ezsignformfield_id_validation: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiEzsignformfieldIDValidation", description="The unique ID of the Ezsignformfield") - fki_ezsignformfieldgroup_id_validation: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiEzsignformfieldgroupIDValidation", description="The unique ID of the Ezsignformfieldgroup") - e_ezsignelementdependency_validation: FieldEEzsignelementdependencyValidation = Field(..., alias="eEzsignelementdependencyValidation") - b_ezsignelementdependency_selected: Optional[StrictBool] = Field(None, alias="bEzsignelementdependencySelected", description="Whether if it's selected or not when using eEzsignelementdependencyValidation = Selected") - e_ezsignelementdependency_operator: Optional[FieldEEzsignelementdependencyOperator] = Field(None, alias="eEzsignelementdependencyOperator") - s_ezsignelementdependency_value: Optional[constr(strict=True)] = Field(None, alias="sEzsignelementdependencyValue", description="The value of the Ezsignelementdependency") - __properties = ["pkiEzsignelementdependencyID", "fkiEzsignformfieldID", "fkiEzsignsignatureID", "fkiEzsignformfieldIDValidation", "fkiEzsignformfieldgroupIDValidation", "eEzsignelementdependencyValidation", "bEzsignelementdependencySelected", "eEzsignelementdependencyOperator", "sEzsignelementdependencyValue"] - - @validator('s_ezsignelementdependency_value') + An Ezsignelementdependency Object + """ # noqa: E501 + pki_ezsignelementdependency_id: Annotated[int, Field(le=65535, strict=True, ge=0)] = Field(description="The unique ID of the Ezsignelementdependency", alias="pkiEzsignelementdependencyID") + fki_ezsignformfield_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsignformfield", alias="fkiEzsignformfieldID") + fki_ezsignsignature_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsignsignature", alias="fkiEzsignsignatureID") + fki_ezsignformfield_id_validation: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsignformfield", alias="fkiEzsignformfieldIDValidation") + fki_ezsignformfieldgroup_id_validation: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsignformfieldgroup", alias="fkiEzsignformfieldgroupIDValidation") + e_ezsignelementdependency_validation: FieldEEzsignelementdependencyValidation = Field(alias="eEzsignelementdependencyValidation") + b_ezsignelementdependency_selected: Optional[StrictBool] = Field(default=None, description="Whether if it's selected or not when using eEzsignelementdependencyValidation = Selected", alias="bEzsignelementdependencySelected") + e_ezsignelementdependency_operator: Optional[FieldEEzsignelementdependencyOperator] = Field(default=None, alias="eEzsignelementdependencyOperator") + s_ezsignelementdependency_value: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="The value of the Ezsignelementdependency", alias="sEzsignelementdependencyValue") + __properties: ClassVar[List[str]] = ["pkiEzsignelementdependencyID", "fkiEzsignformfieldID", "fkiEzsignsignatureID", "fkiEzsignformfieldIDValidation", "fkiEzsignformfieldgroupIDValidation", "eEzsignelementdependencyValidation", "bEzsignelementdependencySelected", "eEzsignelementdependencyOperator", "sEzsignelementdependencyValue"] + + @field_validator('s_ezsignelementdependency_value') def s_ezsignelementdependency_value_validate_regular_expression(cls, value): """Validates the regular expression""" if value is None: @@ -49,51 +55,64 @@ def s_ezsignelementdependency_value_validate_regular_expression(cls, value): raise ValueError(r"must validate the regular expression /^.{0,50}$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignelementdependencyResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignelementdependencyResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignelementdependencyResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignelementdependencyResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignelementdependencyResponse.parse_obj(obj) - - _obj = EzsignelementdependencyResponse.parse_obj({ - "pki_ezsignelementdependency_id": obj.get("pkiEzsignelementdependencyID"), - "fki_ezsignformfield_id": obj.get("fkiEzsignformfieldID"), - "fki_ezsignsignature_id": obj.get("fkiEzsignsignatureID"), - "fki_ezsignformfield_id_validation": obj.get("fkiEzsignformfieldIDValidation"), - "fki_ezsignformfieldgroup_id_validation": obj.get("fkiEzsignformfieldgroupIDValidation"), - "e_ezsignelementdependency_validation": obj.get("eEzsignelementdependencyValidation"), - "b_ezsignelementdependency_selected": obj.get("bEzsignelementdependencySelected"), - "e_ezsignelementdependency_operator": obj.get("eEzsignelementdependencyOperator"), - "s_ezsignelementdependency_value": obj.get("sEzsignelementdependencyValue") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsignelementdependencyID": obj.get("pkiEzsignelementdependencyID"), + "fkiEzsignformfieldID": obj.get("fkiEzsignformfieldID"), + "fkiEzsignsignatureID": obj.get("fkiEzsignsignatureID"), + "fkiEzsignformfieldIDValidation": obj.get("fkiEzsignformfieldIDValidation"), + "fkiEzsignformfieldgroupIDValidation": obj.get("fkiEzsignformfieldgroupIDValidation"), + "eEzsignelementdependencyValidation": obj.get("eEzsignelementdependencyValidation"), + "bEzsignelementdependencySelected": obj.get("bEzsignelementdependencySelected"), + "eEzsignelementdependencyOperator": obj.get("eEzsignelementdependencyOperator"), + "sEzsignelementdependencyValue": obj.get("sEzsignelementdependencyValue") }) return _obj diff --git a/eZmaxApi/models/ezsignelementdependency_response_compound.py b/eZmaxApi/models/ezsignelementdependency_response_compound.py index b7e60eb93..a65297a26 100644 --- a/eZmaxApi/models/ezsignelementdependency_response_compound.py +++ b/eZmaxApi/models/ezsignelementdependency_response_compound.py @@ -19,27 +19,33 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictBool, conint, constr, validator +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, field_validator +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.field_e_ezsignelementdependency_operator import FieldEEzsignelementdependencyOperator from eZmaxApi.models.field_e_ezsignelementdependency_validation import FieldEEzsignelementdependencyValidation +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignelementdependencyResponseCompound(BaseModel): """ - An Ezsignelementdependency Object and children to create a complete structure # noqa: E501 - """ - pki_ezsignelementdependency_id: conint(strict=True, le=65535, ge=0) = Field(..., alias="pkiEzsignelementdependencyID", description="The unique ID of the Ezsignelementdependency") - fki_ezsignformfield_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiEzsignformfieldID", description="The unique ID of the Ezsignformfield") - fki_ezsignsignature_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiEzsignsignatureID", description="The unique ID of the Ezsignsignature") - fki_ezsignformfield_id_validation: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiEzsignformfieldIDValidation", description="The unique ID of the Ezsignformfield") - fki_ezsignformfieldgroup_id_validation: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiEzsignformfieldgroupIDValidation", description="The unique ID of the Ezsignformfieldgroup") - e_ezsignelementdependency_validation: FieldEEzsignelementdependencyValidation = Field(..., alias="eEzsignelementdependencyValidation") - b_ezsignelementdependency_selected: Optional[StrictBool] = Field(None, alias="bEzsignelementdependencySelected", description="Whether if it's selected or not when using eEzsignelementdependencyValidation = Selected") - e_ezsignelementdependency_operator: Optional[FieldEEzsignelementdependencyOperator] = Field(None, alias="eEzsignelementdependencyOperator") - s_ezsignelementdependency_value: Optional[constr(strict=True)] = Field(None, alias="sEzsignelementdependencyValue", description="The value of the Ezsignelementdependency") - __properties = ["pkiEzsignelementdependencyID", "fkiEzsignformfieldID", "fkiEzsignsignatureID", "fkiEzsignformfieldIDValidation", "fkiEzsignformfieldgroupIDValidation", "eEzsignelementdependencyValidation", "bEzsignelementdependencySelected", "eEzsignelementdependencyOperator", "sEzsignelementdependencyValue"] - - @validator('s_ezsignelementdependency_value') + An Ezsignelementdependency Object and children to create a complete structure + """ # noqa: E501 + pki_ezsignelementdependency_id: Annotated[int, Field(le=65535, strict=True, ge=0)] = Field(description="The unique ID of the Ezsignelementdependency", alias="pkiEzsignelementdependencyID") + fki_ezsignformfield_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsignformfield", alias="fkiEzsignformfieldID") + fki_ezsignsignature_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsignsignature", alias="fkiEzsignsignatureID") + fki_ezsignformfield_id_validation: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsignformfield", alias="fkiEzsignformfieldIDValidation") + fki_ezsignformfieldgroup_id_validation: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsignformfieldgroup", alias="fkiEzsignformfieldgroupIDValidation") + e_ezsignelementdependency_validation: FieldEEzsignelementdependencyValidation = Field(alias="eEzsignelementdependencyValidation") + b_ezsignelementdependency_selected: Optional[StrictBool] = Field(default=None, description="Whether if it's selected or not when using eEzsignelementdependencyValidation = Selected", alias="bEzsignelementdependencySelected") + e_ezsignelementdependency_operator: Optional[FieldEEzsignelementdependencyOperator] = Field(default=None, alias="eEzsignelementdependencyOperator") + s_ezsignelementdependency_value: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="The value of the Ezsignelementdependency", alias="sEzsignelementdependencyValue") + __properties: ClassVar[List[str]] = ["pkiEzsignelementdependencyID", "fkiEzsignformfieldID", "fkiEzsignsignatureID", "fkiEzsignformfieldIDValidation", "fkiEzsignformfieldgroupIDValidation", "eEzsignelementdependencyValidation", "bEzsignelementdependencySelected", "eEzsignelementdependencyOperator", "sEzsignelementdependencyValue"] + + @field_validator('s_ezsignelementdependency_value') def s_ezsignelementdependency_value_validate_regular_expression(cls, value): """Validates the regular expression""" if value is None: @@ -49,51 +55,64 @@ def s_ezsignelementdependency_value_validate_regular_expression(cls, value): raise ValueError(r"must validate the regular expression /^.{0,50}$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignelementdependencyResponseCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignelementdependencyResponseCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignelementdependencyResponseCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignelementdependencyResponseCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignelementdependencyResponseCompound.parse_obj(obj) - - _obj = EzsignelementdependencyResponseCompound.parse_obj({ - "pki_ezsignelementdependency_id": obj.get("pkiEzsignelementdependencyID"), - "fki_ezsignformfield_id": obj.get("fkiEzsignformfieldID"), - "fki_ezsignsignature_id": obj.get("fkiEzsignsignatureID"), - "fki_ezsignformfield_id_validation": obj.get("fkiEzsignformfieldIDValidation"), - "fki_ezsignformfieldgroup_id_validation": obj.get("fkiEzsignformfieldgroupIDValidation"), - "e_ezsignelementdependency_validation": obj.get("eEzsignelementdependencyValidation"), - "b_ezsignelementdependency_selected": obj.get("bEzsignelementdependencySelected"), - "e_ezsignelementdependency_operator": obj.get("eEzsignelementdependencyOperator"), - "s_ezsignelementdependency_value": obj.get("sEzsignelementdependencyValue") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsignelementdependencyID": obj.get("pkiEzsignelementdependencyID"), + "fkiEzsignformfieldID": obj.get("fkiEzsignformfieldID"), + "fkiEzsignsignatureID": obj.get("fkiEzsignsignatureID"), + "fkiEzsignformfieldIDValidation": obj.get("fkiEzsignformfieldIDValidation"), + "fkiEzsignformfieldgroupIDValidation": obj.get("fkiEzsignformfieldgroupIDValidation"), + "eEzsignelementdependencyValidation": obj.get("eEzsignelementdependencyValidation"), + "bEzsignelementdependencySelected": obj.get("bEzsignelementdependencySelected"), + "eEzsignelementdependencyOperator": obj.get("eEzsignelementdependencyOperator"), + "sEzsignelementdependencyValue": obj.get("sEzsignelementdependencyValue") }) return _obj diff --git a/eZmaxApi/models/ezsignfolder_archive_v1_response.py b/eZmaxApi/models/ezsignfolder_archive_v1_response.py index b5e54119f..51533f6b1 100644 --- a/eZmaxApi/models/ezsignfolder_archive_v1_response.py +++ b/eZmaxApi/models/ezsignfolder_archive_v1_response.py @@ -19,43 +19,61 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignfolderArchiveV1Response(BaseModel): """ - Response for POST /1/object/ezsignfolder/{pkiEzsignfolderID}/archive # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - __properties = ["objDebugPayload", "objDebug"] + Response for POST /1/object/ezsignfolder/{pkiEzsignfolderID}/archive + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignfolderArchiveV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignfolderArchiveV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -65,17 +83,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignfolderArchiveV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignfolderArchiveV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignfolderArchiveV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignfolderArchiveV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignfolder_batch_download_v1_request.py b/eZmaxApi/models/ezsignfolder_batch_download_v1_request.py index 5d606768d..6f327ff98 100644 --- a/eZmaxApi/models/ezsignfolder_batch_download_v1_request.py +++ b/eZmaxApi/models/ezsignfolder_batch_download_v1_request.py @@ -19,18 +19,24 @@ import json -from typing import List -from pydantic import BaseModel, Field, StrictStr, conint, conlist, validator +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictStr, field_validator +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignfolderBatchDownloadV1Request(BaseModel): """ - Request for POST /1/object/ezsignfolder/{pkiEzsignfolderID}/batchDownload # noqa: E501 - """ - a_pki_ezsigndocument_id: conlist(conint(strict=True, ge=0), min_items=1) = Field(..., alias="a_pkiEzsigndocumentID") - a_e_document_type: conlist(StrictStr) = Field(..., alias="a_eDocumentType", description="The type of document to retrieve. 1. **Signed** Is the final document once all signatures were applied. 2. **Proofdocument** Is the evidence report. 3. **Proof** Is the complete evidence archive including all of the above and more.") - __properties = ["a_pkiEzsigndocumentID", "a_eDocumentType"] + Request for POST /1/object/ezsignfolder/{pkiEzsignfolderID}/batchDownload + """ # noqa: E501 + a_pki_ezsigndocument_id: Annotated[List[Annotated[int, Field(strict=True, ge=0)]], Field(min_length=1)] = Field(alias="a_pkiEzsigndocumentID") + a_e_document_type: List[StrictStr] = Field(description="The type of document to retrieve. 1. **Signed** Is the final document once all signatures were applied. 2. **Proofdocument** Is the evidence report. 3. **Proof** Is the complete evidence archive including all of the above and more.", alias="a_eDocumentType") + __properties: ClassVar[List[str]] = ["a_pkiEzsigndocumentID", "a_eDocumentType"] - @validator('a_e_document_type') + @field_validator('a_e_document_type') def a_e_document_type_validate_enum(cls, value): """Validates the enum""" for i in value: @@ -38,44 +44,57 @@ def a_e_document_type_validate_enum(cls, value): raise ValueError("each list item must be one of ('Signed', 'Proof', 'Proofdocument')") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignfolderBatchDownloadV1Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignfolderBatchDownloadV1Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignfolderBatchDownloadV1Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignfolderBatchDownloadV1Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignfolderBatchDownloadV1Request.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignfolderBatchDownloadV1Request.parse_obj({ - "a_pki_ezsigndocument_id": obj.get("a_pkiEzsigndocumentID"), - "a_e_document_type": obj.get("a_eDocumentType") + _obj = cls.model_validate({ + "a_pkiEzsigndocumentID": obj.get("a_pkiEzsigndocumentID"), + "a_eDocumentType": obj.get("a_eDocumentType") }) return _obj diff --git a/eZmaxApi/models/ezsignfolder_create_object_v1_request.py b/eZmaxApi/models/ezsignfolder_create_object_v1_request.py index 27d744024..858cf3c1c 100644 --- a/eZmaxApi/models/ezsignfolder_create_object_v1_request.py +++ b/eZmaxApi/models/ezsignfolder_create_object_v1_request.py @@ -19,43 +19,61 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.ezsignfolder_request import EzsignfolderRequest from eZmaxApi.models.ezsignfolder_request_compound import EzsignfolderRequestCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignfolderCreateObjectV1Request(BaseModel): """ - Request for POST /1/object/ezsignfolder # noqa: E501 - """ - obj_ezsignfolder: Optional[EzsignfolderRequest] = Field(None, alias="objEzsignfolder") - obj_ezsignfolder_compound: Optional[EzsignfolderRequestCompound] = Field(None, alias="objEzsignfolderCompound") - __properties = ["objEzsignfolder", "objEzsignfolderCompound"] + Request for POST /1/object/ezsignfolder + """ # noqa: E501 + obj_ezsignfolder: Optional[EzsignfolderRequest] = Field(default=None, alias="objEzsignfolder") + obj_ezsignfolder_compound: Optional[EzsignfolderRequestCompound] = Field(default=None, alias="objEzsignfolderCompound") + __properties: ClassVar[List[str]] = ["objEzsignfolder", "objEzsignfolderCompound"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignfolderCreateObjectV1Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignfolderCreateObjectV1Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_ezsignfolder if self.obj_ezsignfolder: _dict['objEzsignfolder'] = self.obj_ezsignfolder.to_dict() @@ -65,17 +83,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignfolderCreateObjectV1Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignfolderCreateObjectV1Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignfolderCreateObjectV1Request.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignfolderCreateObjectV1Request.parse_obj({ - "obj_ezsignfolder": EzsignfolderRequest.from_dict(obj.get("objEzsignfolder")) if obj.get("objEzsignfolder") is not None else None, - "obj_ezsignfolder_compound": EzsignfolderRequestCompound.from_dict(obj.get("objEzsignfolderCompound")) if obj.get("objEzsignfolderCompound") is not None else None + _obj = cls.model_validate({ + "objEzsignfolder": EzsignfolderRequest.from_dict(obj.get("objEzsignfolder")) if obj.get("objEzsignfolder") is not None else None, + "objEzsignfolderCompound": EzsignfolderRequestCompound.from_dict(obj.get("objEzsignfolderCompound")) if obj.get("objEzsignfolderCompound") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignfolder_create_object_v1_response.py b/eZmaxApi/models/ezsignfolder_create_object_v1_response.py index b9ed8e7ef..8e829d3e1 100644 --- a/eZmaxApi/models/ezsignfolder_create_object_v1_response.py +++ b/eZmaxApi/models/ezsignfolder_create_object_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.ezsignfolder_create_object_v1_response_m_payload import EzsignfolderCreateObjectV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignfolderCreateObjectV1Response(BaseModel): """ - Response for POST /1/object/ezsignfolder # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzsignfolderCreateObjectV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for POST /1/object/ezsignfolder + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsignfolderCreateObjectV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignfolderCreateObjectV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignfolderCreateObjectV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignfolderCreateObjectV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignfolderCreateObjectV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignfolderCreateObjectV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignfolderCreateObjectV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzsignfolderCreateObjectV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsignfolderCreateObjectV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignfolder_create_object_v1_response_m_payload.py b/eZmaxApi/models/ezsignfolder_create_object_v1_response_m_payload.py index fe7e922df..d83bc3936 100644 --- a/eZmaxApi/models/ezsignfolder_create_object_v1_response_m_payload.py +++ b/eZmaxApi/models/ezsignfolder_create_object_v1_response_m_payload.py @@ -19,53 +19,72 @@ import json -from typing import List -from pydantic import BaseModel, Field, conint, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignfolderCreateObjectV1ResponseMPayload(BaseModel): """ - Payload for POST /1/object/ezsignfolder # noqa: E501 - """ - a_pki_ezsignfolder_id: conlist(conint(strict=True, ge=0), min_items=1) = Field(..., alias="a_pkiEzsignfolderID", description="An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request.") - __properties = ["a_pkiEzsignfolderID"] + Payload for POST /1/object/ezsignfolder + """ # noqa: E501 + a_pki_ezsignfolder_id: Annotated[List[Annotated[int, Field(strict=True, ge=0)]], Field(min_length=1)] = Field(description="An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request.", alias="a_pkiEzsignfolderID") + __properties: ClassVar[List[str]] = ["a_pkiEzsignfolderID"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignfolderCreateObjectV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignfolderCreateObjectV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignfolderCreateObjectV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignfolderCreateObjectV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignfolderCreateObjectV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignfolderCreateObjectV1ResponseMPayload.parse_obj({ - "a_pki_ezsignfolder_id": obj.get("a_pkiEzsignfolderID") + _obj = cls.model_validate({ + "a_pkiEzsignfolderID": obj.get("a_pkiEzsignfolderID") }) return _obj diff --git a/eZmaxApi/models/ezsignfolder_create_object_v2_request.py b/eZmaxApi/models/ezsignfolder_create_object_v2_request.py index 2c855c105..3b97e224a 100644 --- a/eZmaxApi/models/ezsignfolder_create_object_v2_request.py +++ b/eZmaxApi/models/ezsignfolder_create_object_v2_request.py @@ -19,41 +19,60 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.ezsignfolder_request_compound import EzsignfolderRequestCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignfolderCreateObjectV2Request(BaseModel): """ - Request for POST /2/object/ezsignfolder # noqa: E501 - """ - a_obj_ezsignfolder: conlist(EzsignfolderRequestCompound, min_items=1) = Field(..., alias="a_objEzsignfolder") - __properties = ["a_objEzsignfolder"] + Request for POST /2/object/ezsignfolder + """ # noqa: E501 + a_obj_ezsignfolder: Annotated[List[EzsignfolderRequestCompound], Field(min_length=1)] = Field(alias="a_objEzsignfolder") + __properties: ClassVar[List[str]] = ["a_objEzsignfolder"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignfolderCreateObjectV2Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignfolderCreateObjectV2Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_ezsignfolder (list) _items = [] if self.a_obj_ezsignfolder: @@ -64,16 +83,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignfolderCreateObjectV2Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignfolderCreateObjectV2Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignfolderCreateObjectV2Request.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignfolderCreateObjectV2Request.parse_obj({ - "a_obj_ezsignfolder": [EzsignfolderRequestCompound.from_dict(_item) for _item in obj.get("a_objEzsignfolder")] if obj.get("a_objEzsignfolder") is not None else None + _obj = cls.model_validate({ + "a_objEzsignfolder": [EzsignfolderRequestCompound.from_dict(_item) for _item in obj.get("a_objEzsignfolder")] if obj.get("a_objEzsignfolder") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignfolder_create_object_v2_response.py b/eZmaxApi/models/ezsignfolder_create_object_v2_response.py index 555c5de46..cb7cfe593 100644 --- a/eZmaxApi/models/ezsignfolder_create_object_v2_response.py +++ b/eZmaxApi/models/ezsignfolder_create_object_v2_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.ezsignfolder_create_object_v2_response_m_payload import EzsignfolderCreateObjectV2ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignfolderCreateObjectV2Response(BaseModel): """ - Response for POST /2/object/ezsignfolder # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzsignfolderCreateObjectV2ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for POST /2/object/ezsignfolder + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsignfolderCreateObjectV2ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignfolderCreateObjectV2Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignfolderCreateObjectV2Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignfolderCreateObjectV2Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignfolderCreateObjectV2Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignfolderCreateObjectV2Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignfolderCreateObjectV2Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzsignfolderCreateObjectV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsignfolderCreateObjectV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignfolder_create_object_v2_response_m_payload.py b/eZmaxApi/models/ezsignfolder_create_object_v2_response_m_payload.py index 02ba0178b..6885a5c2f 100644 --- a/eZmaxApi/models/ezsignfolder_create_object_v2_response_m_payload.py +++ b/eZmaxApi/models/ezsignfolder_create_object_v2_response_m_payload.py @@ -19,53 +19,72 @@ import json -from typing import List -from pydantic import BaseModel, Field, conint, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignfolderCreateObjectV2ResponseMPayload(BaseModel): """ - Payload for POST /2/object/ezsignfolder # noqa: E501 - """ - a_pki_ezsignfolder_id: conlist(conint(strict=True, ge=0), min_items=1) = Field(..., alias="a_pkiEzsignfolderID", description="An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request.") - __properties = ["a_pkiEzsignfolderID"] + Payload for POST /2/object/ezsignfolder + """ # noqa: E501 + a_pki_ezsignfolder_id: Annotated[List[Annotated[int, Field(strict=True, ge=0)]], Field(min_length=1)] = Field(description="An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request.", alias="a_pkiEzsignfolderID") + __properties: ClassVar[List[str]] = ["a_pkiEzsignfolderID"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignfolderCreateObjectV2ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignfolderCreateObjectV2ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignfolderCreateObjectV2ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignfolderCreateObjectV2ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignfolderCreateObjectV2ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignfolderCreateObjectV2ResponseMPayload.parse_obj({ - "a_pki_ezsignfolder_id": obj.get("a_pkiEzsignfolderID") + _obj = cls.model_validate({ + "a_pkiEzsignfolderID": obj.get("a_pkiEzsignfolderID") }) return _obj diff --git a/eZmaxApi/models/ezsignfolder_delete_object_v1_response.py b/eZmaxApi/models/ezsignfolder_delete_object_v1_response.py index 2b6052a42..410d69363 100644 --- a/eZmaxApi/models/ezsignfolder_delete_object_v1_response.py +++ b/eZmaxApi/models/ezsignfolder_delete_object_v1_response.py @@ -19,43 +19,61 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignfolderDeleteObjectV1Response(BaseModel): """ - Response for DELETE /1/object/ezsignfolder/{pkiEzsignfolderID} # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - __properties = ["objDebugPayload", "objDebug"] + Response for DELETE /1/object/ezsignfolder/{pkiEzsignfolderID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignfolderDeleteObjectV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignfolderDeleteObjectV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -65,17 +83,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignfolderDeleteObjectV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignfolderDeleteObjectV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignfolderDeleteObjectV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignfolderDeleteObjectV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignfolder_dispose_ezsignfolders_v1_request.py b/eZmaxApi/models/ezsignfolder_dispose_ezsignfolders_v1_request.py index b7445bcb0..4145098f1 100644 --- a/eZmaxApi/models/ezsignfolder_dispose_ezsignfolders_v1_request.py +++ b/eZmaxApi/models/ezsignfolder_dispose_ezsignfolders_v1_request.py @@ -19,53 +19,72 @@ import json -from typing import List -from pydantic import BaseModel, Field, conint, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignfolderDisposeEzsignfoldersV1Request(BaseModel): """ - Request for POST /1/object/ezsignfolder/disposeEzsignfolders # noqa: E501 - """ - a_pki_ezsignfolder_id: conlist(conint(strict=True, ge=0), max_items=500, min_items=1) = Field(..., alias="a_pkiEzsignfolderID") - __properties = ["a_pkiEzsignfolderID"] + Request for POST /1/object/ezsignfolder/disposeEzsignfolders + """ # noqa: E501 + a_pki_ezsignfolder_id: Annotated[List[Annotated[int, Field(strict=True, ge=0)]], Field(min_length=1, max_length=500)] = Field(alias="a_pkiEzsignfolderID") + __properties: ClassVar[List[str]] = ["a_pkiEzsignfolderID"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignfolderDisposeEzsignfoldersV1Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignfolderDisposeEzsignfoldersV1Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignfolderDisposeEzsignfoldersV1Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignfolderDisposeEzsignfoldersV1Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignfolderDisposeEzsignfoldersV1Request.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignfolderDisposeEzsignfoldersV1Request.parse_obj({ - "a_pki_ezsignfolder_id": obj.get("a_pkiEzsignfolderID") + _obj = cls.model_validate({ + "a_pkiEzsignfolderID": obj.get("a_pkiEzsignfolderID") }) return _obj diff --git a/eZmaxApi/models/ezsignfolder_dispose_ezsignfolders_v1_response.py b/eZmaxApi/models/ezsignfolder_dispose_ezsignfolders_v1_response.py index 6e18efa73..6203ba895 100644 --- a/eZmaxApi/models/ezsignfolder_dispose_ezsignfolders_v1_response.py +++ b/eZmaxApi/models/ezsignfolder_dispose_ezsignfolders_v1_response.py @@ -19,43 +19,61 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignfolderDisposeEzsignfoldersV1Response(BaseModel): """ - Response for POST /1/object/ezsignfolder/disposeEzsignfolders # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - __properties = ["objDebugPayload", "objDebug"] + Response for POST /1/object/ezsignfolder/disposeEzsignfolders + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignfolderDisposeEzsignfoldersV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignfolderDisposeEzsignfoldersV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -65,17 +83,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignfolderDisposeEzsignfoldersV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignfolderDisposeEzsignfoldersV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignfolderDisposeEzsignfoldersV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignfolderDisposeEzsignfoldersV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignfolder_dispose_v1_response.py b/eZmaxApi/models/ezsignfolder_dispose_v1_response.py index 179874311..cc07c78d6 100644 --- a/eZmaxApi/models/ezsignfolder_dispose_v1_response.py +++ b/eZmaxApi/models/ezsignfolder_dispose_v1_response.py @@ -19,43 +19,61 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignfolderDisposeV1Response(BaseModel): """ - Response for POST /1/object/ezsignfolder/{pkiEzsignfolderID}/dispose # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - __properties = ["objDebugPayload", "objDebug"] + Response for POST /1/object/ezsignfolder/{pkiEzsignfolderID}/dispose + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignfolderDisposeV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignfolderDisposeV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -65,17 +83,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignfolderDisposeV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignfolderDisposeV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignfolderDisposeV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignfolderDisposeV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignfolder_edit_object_v1_request.py b/eZmaxApi/models/ezsignfolder_edit_object_v1_request.py index cf42a124d..101a131fa 100644 --- a/eZmaxApi/models/ezsignfolder_edit_object_v1_request.py +++ b/eZmaxApi/models/ezsignfolder_edit_object_v1_request.py @@ -19,57 +19,75 @@ import json - -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.ezsignfolder_request_compound import EzsignfolderRequestCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignfolderEditObjectV1Request(BaseModel): """ - Request for PUT /1/object/ezsignfolder/{pkiEzsignfolderID} # noqa: E501 - """ - obj_ezsignfolder: EzsignfolderRequestCompound = Field(..., alias="objEzsignfolder") - __properties = ["objEzsignfolder"] + Request for PUT /1/object/ezsignfolder/{pkiEzsignfolderID} + """ # noqa: E501 + obj_ezsignfolder: EzsignfolderRequestCompound = Field(alias="objEzsignfolder") + __properties: ClassVar[List[str]] = ["objEzsignfolder"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignfolderEditObjectV1Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignfolderEditObjectV1Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_ezsignfolder if self.obj_ezsignfolder: _dict['objEzsignfolder'] = self.obj_ezsignfolder.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignfolderEditObjectV1Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignfolderEditObjectV1Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignfolderEditObjectV1Request.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignfolderEditObjectV1Request.parse_obj({ - "obj_ezsignfolder": EzsignfolderRequestCompound.from_dict(obj.get("objEzsignfolder")) if obj.get("objEzsignfolder") is not None else None + _obj = cls.model_validate({ + "objEzsignfolder": EzsignfolderRequestCompound.from_dict(obj.get("objEzsignfolder")) if obj.get("objEzsignfolder") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignfolder_edit_object_v1_response.py b/eZmaxApi/models/ezsignfolder_edit_object_v1_response.py index 077c29fa6..57e26562f 100644 --- a/eZmaxApi/models/ezsignfolder_edit_object_v1_response.py +++ b/eZmaxApi/models/ezsignfolder_edit_object_v1_response.py @@ -19,43 +19,61 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignfolderEditObjectV1Response(BaseModel): """ - Response for PUT /1/object/ezsignfolder/{pkiEzsignfolderID} # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - __properties = ["objDebugPayload", "objDebug"] + Response for PUT /1/object/ezsignfolder/{pkiEzsignfolderID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignfolderEditObjectV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignfolderEditObjectV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -65,17 +83,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignfolderEditObjectV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignfolderEditObjectV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignfolderEditObjectV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignfolderEditObjectV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignfolder_get_actionable_elements_v1_response.py b/eZmaxApi/models/ezsignfolder_get_actionable_elements_v1_response.py index 93fdc4be2..dcfc57df4 100644 --- a/eZmaxApi/models/ezsignfolder_get_actionable_elements_v1_response.py +++ b/eZmaxApi/models/ezsignfolder_get_actionable_elements_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.ezsignfolder_get_actionable_elements_v1_response_m_payload import EzsignfolderGetActionableElementsV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignfolderGetActionableElementsV1Response(BaseModel): """ - Response for GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getActionableElements # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzsignfolderGetActionableElementsV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getActionableElements + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsignfolderGetActionableElementsV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignfolderGetActionableElementsV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignfolderGetActionableElementsV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignfolderGetActionableElementsV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignfolderGetActionableElementsV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignfolderGetActionableElementsV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignfolderGetActionableElementsV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzsignfolderGetActionableElementsV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsignfolderGetActionableElementsV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignfolder_get_actionable_elements_v1_response_m_payload.py b/eZmaxApi/models/ezsignfolder_get_actionable_elements_v1_response_m_payload.py index 816a23579..6e825cecb 100644 --- a/eZmaxApi/models/ezsignfolder_get_actionable_elements_v1_response_m_payload.py +++ b/eZmaxApi/models/ezsignfolder_get_actionable_elements_v1_response_m_payload.py @@ -19,43 +19,61 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.ezsignformfieldgroup_response_compound import EzsignformfieldgroupResponseCompound from eZmaxApi.models.ezsignsignature_response_compound import EzsignsignatureResponseCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignfolderGetActionableElementsV1ResponseMPayload(BaseModel): """ - Payload for GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getActionableElements # noqa: E501 - """ - a_obj_ezsignsignature: conlist(EzsignsignatureResponseCompound) = Field(..., alias="a_objEzsignsignature") - a_obj_ezsignformfieldgroup: conlist(EzsignformfieldgroupResponseCompound) = Field(..., alias="a_objEzsignformfieldgroup") - __properties = ["a_objEzsignsignature", "a_objEzsignformfieldgroup"] + Payload for GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getActionableElements + """ # noqa: E501 + a_obj_ezsignsignature: List[EzsignsignatureResponseCompound] = Field(alias="a_objEzsignsignature") + a_obj_ezsignformfieldgroup: List[EzsignformfieldgroupResponseCompound] = Field(alias="a_objEzsignformfieldgroup") + __properties: ClassVar[List[str]] = ["a_objEzsignsignature", "a_objEzsignformfieldgroup"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignfolderGetActionableElementsV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignfolderGetActionableElementsV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_ezsignsignature (list) _items = [] if self.a_obj_ezsignsignature: @@ -73,17 +91,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignfolderGetActionableElementsV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignfolderGetActionableElementsV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignfolderGetActionableElementsV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignfolderGetActionableElementsV1ResponseMPayload.parse_obj({ - "a_obj_ezsignsignature": [EzsignsignatureResponseCompound.from_dict(_item) for _item in obj.get("a_objEzsignsignature")] if obj.get("a_objEzsignsignature") is not None else None, - "a_obj_ezsignformfieldgroup": [EzsignformfieldgroupResponseCompound.from_dict(_item) for _item in obj.get("a_objEzsignformfieldgroup")] if obj.get("a_objEzsignformfieldgroup") is not None else None + _obj = cls.model_validate({ + "a_objEzsignsignature": [EzsignsignatureResponseCompound.from_dict(_item) for _item in obj.get("a_objEzsignsignature")] if obj.get("a_objEzsignsignature") is not None else None, + "a_objEzsignformfieldgroup": [EzsignformfieldgroupResponseCompound.from_dict(_item) for _item in obj.get("a_objEzsignformfieldgroup")] if obj.get("a_objEzsignformfieldgroup") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignfolder_get_attachment_count_v1_response.py b/eZmaxApi/models/ezsignfolder_get_attachment_count_v1_response.py new file mode 100644 index 000000000..7fa2fed73 --- /dev/null +++ b/eZmaxApi/models/ezsignfolder_get_attachment_count_v1_response.py @@ -0,0 +1,106 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field +from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug +from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +from eZmaxApi.models.ezsignfolder_get_attachment_count_v1_response_m_payload import EzsignfolderGetAttachmentCountV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self + +class EzsignfolderGetAttachmentCountV1Response(BaseModel): + """ + Response for GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getAttachmentCount + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsignfolderGetAttachmentCountV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of EzsignfolderGetAttachmentCountV1Response from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of obj_debug_payload + if self.obj_debug_payload: + _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() + # override the default output from pydantic by calling `to_dict()` of obj_debug + if self.obj_debug: + _dict['objDebug'] = self.obj_debug.to_dict() + # override the default output from pydantic by calling `to_dict()` of m_payload + if self.m_payload: + _dict['mPayload'] = self.m_payload.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Dict) -> Self: + """Create an instance of EzsignfolderGetAttachmentCountV1Response from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsignfolderGetAttachmentCountV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + }) + return _obj + + diff --git a/eZmaxApi/models/ezsignfolder_get_attachment_count_v1_response_m_payload.py b/eZmaxApi/models/ezsignfolder_get_attachment_count_v1_response_m_payload.py new file mode 100644 index 000000000..5c3ab9b23 --- /dev/null +++ b/eZmaxApi/models/ezsignfolder_get_attachment_count_v1_response_m_payload.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictInt +from pydantic import Field +try: + from typing import Self +except ImportError: + from typing_extensions import Self + +class EzsignfolderGetAttachmentCountV1ResponseMPayload(BaseModel): + """ + Response for GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getAttachmentCount + """ # noqa: E501 + i_attachment_count: StrictInt = Field(description="The count of Attachment.", alias="iAttachmentCount") + __properties: ClassVar[List[str]] = ["iAttachmentCount"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of EzsignfolderGetAttachmentCountV1ResponseMPayload from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Dict) -> Self: + """Create an instance of EzsignfolderGetAttachmentCountV1ResponseMPayload from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "iAttachmentCount": obj.get("iAttachmentCount") + }) + return _obj + + diff --git a/eZmaxApi/models/ezsignfolder_get_attachments_v1_response.py b/eZmaxApi/models/ezsignfolder_get_attachments_v1_response.py new file mode 100644 index 000000000..3c5e6ce5d --- /dev/null +++ b/eZmaxApi/models/ezsignfolder_get_attachments_v1_response.py @@ -0,0 +1,106 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field +from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug +from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +from eZmaxApi.models.ezsignfolder_get_attachments_v1_response_m_payload import EzsignfolderGetAttachmentsV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self + +class EzsignfolderGetAttachmentsV1Response(BaseModel): + """ + Response for GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getAttachments + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsignfolderGetAttachmentsV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of EzsignfolderGetAttachmentsV1Response from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of obj_debug_payload + if self.obj_debug_payload: + _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() + # override the default output from pydantic by calling `to_dict()` of obj_debug + if self.obj_debug: + _dict['objDebug'] = self.obj_debug.to_dict() + # override the default output from pydantic by calling `to_dict()` of m_payload + if self.m_payload: + _dict['mPayload'] = self.m_payload.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Dict) -> Self: + """Create an instance of EzsignfolderGetAttachmentsV1Response from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsignfolderGetAttachmentsV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + }) + return _obj + + diff --git a/eZmaxApi/models/ezsignfolder_get_attachments_v1_response_m_payload.py b/eZmaxApi/models/ezsignfolder_get_attachments_v1_response_m_payload.py new file mode 100644 index 000000000..3796934e0 --- /dev/null +++ b/eZmaxApi/models/ezsignfolder_get_attachments_v1_response_m_payload.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from eZmaxApi.models.custom_attachmentdocumenttype_response import CustomAttachmentdocumenttypeResponse +try: + from typing import Self +except ImportError: + from typing_extensions import Self + +class EzsignfolderGetAttachmentsV1ResponseMPayload(BaseModel): + """ + Response for GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getAttachments + """ # noqa: E501 + a_obj_attachmentdocumenttype: List[CustomAttachmentdocumenttypeResponse] = Field(alias="a_objAttachmentdocumenttype") + __properties: ClassVar[List[str]] = ["a_objAttachmentdocumenttype"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of EzsignfolderGetAttachmentsV1ResponseMPayload from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in a_obj_attachmentdocumenttype (list) + _items = [] + if self.a_obj_attachmentdocumenttype: + for _item in self.a_obj_attachmentdocumenttype: + if _item: + _items.append(_item.to_dict()) + _dict['a_objAttachmentdocumenttype'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Dict) -> Self: + """Create an instance of EzsignfolderGetAttachmentsV1ResponseMPayload from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "a_objAttachmentdocumenttype": [CustomAttachmentdocumenttypeResponse.from_dict(_item) for _item in obj.get("a_objAttachmentdocumenttype")] if obj.get("a_objAttachmentdocumenttype") is not None else None + }) + return _obj + + diff --git a/eZmaxApi/models/ezsignfolder_get_communication_count_v1_response.py b/eZmaxApi/models/ezsignfolder_get_communication_count_v1_response.py index 062b92ae5..ec7ba7b27 100644 --- a/eZmaxApi/models/ezsignfolder_get_communication_count_v1_response.py +++ b/eZmaxApi/models/ezsignfolder_get_communication_count_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.ezsignfolder_get_communication_count_v1_response_m_payload import EzsignfolderGetCommunicationCountV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignfolderGetCommunicationCountV1Response(BaseModel): """ - Response for GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getCommunicationCount # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzsignfolderGetCommunicationCountV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getCommunicationCount + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsignfolderGetCommunicationCountV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignfolderGetCommunicationCountV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignfolderGetCommunicationCountV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignfolderGetCommunicationCountV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignfolderGetCommunicationCountV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignfolderGetCommunicationCountV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignfolderGetCommunicationCountV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzsignfolderGetCommunicationCountV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsignfolderGetCommunicationCountV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignfolder_get_communication_count_v1_response_m_payload.py b/eZmaxApi/models/ezsignfolder_get_communication_count_v1_response_m_payload.py index 6f03bd914..a9a2a65d0 100644 --- a/eZmaxApi/models/ezsignfolder_get_communication_count_v1_response_m_payload.py +++ b/eZmaxApi/models/ezsignfolder_get_communication_count_v1_response_m_payload.py @@ -19,53 +19,71 @@ import json - -from pydantic import BaseModel, Field, StrictInt +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictInt +from pydantic import Field +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignfolderGetCommunicationCountV1ResponseMPayload(BaseModel): """ - Response for GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getCommunicationCount # noqa: E501 - """ - i_communication_count: StrictInt = Field(..., alias="iCommunicationCount", description="The count of Communication.") - __properties = ["iCommunicationCount"] + Response for GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getCommunicationCount + """ # noqa: E501 + i_communication_count: StrictInt = Field(description="The count of Communication.", alias="iCommunicationCount") + __properties: ClassVar[List[str]] = ["iCommunicationCount"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignfolderGetCommunicationCountV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignfolderGetCommunicationCountV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignfolderGetCommunicationCountV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignfolderGetCommunicationCountV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignfolderGetCommunicationCountV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignfolderGetCommunicationCountV1ResponseMPayload.parse_obj({ - "i_communication_count": obj.get("iCommunicationCount") + _obj = cls.model_validate({ + "iCommunicationCount": obj.get("iCommunicationCount") }) return _obj diff --git a/eZmaxApi/models/ezsignfolder_get_communication_list_v1_response.py b/eZmaxApi/models/ezsignfolder_get_communication_list_v1_response.py index 68615338c..fb2e94a21 100644 --- a/eZmaxApi/models/ezsignfolder_get_communication_list_v1_response.py +++ b/eZmaxApi/models/ezsignfolder_get_communication_list_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload_get_list import CommonResponseObjDebugPayloadGetList from eZmaxApi.models.ezsignfolder_get_communication_list_v1_response_m_payload import EzsignfolderGetCommunicationListV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignfolderGetCommunicationListV1Response(BaseModel): """ - Response for GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getCommunicationList # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayloadGetList = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzsignfolderGetCommunicationListV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getCommunicationList + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayloadGetList = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsignfolderGetCommunicationListV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignfolderGetCommunicationListV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignfolderGetCommunicationListV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignfolderGetCommunicationListV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignfolderGetCommunicationListV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignfolderGetCommunicationListV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignfolderGetCommunicationListV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayloadGetList.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzsignfolderGetCommunicationListV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayloadGetList.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsignfolderGetCommunicationListV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignfolder_get_communication_list_v1_response_m_payload.py b/eZmaxApi/models/ezsignfolder_get_communication_list_v1_response_m_payload.py index 02cedb79c..1cf42a757 100644 --- a/eZmaxApi/models/ezsignfolder_get_communication_list_v1_response_m_payload.py +++ b/eZmaxApi/models/ezsignfolder_get_communication_list_v1_response_m_payload.py @@ -19,41 +19,59 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.custom_communication_list_element_response import CustomCommunicationListElementResponse +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignfolderGetCommunicationListV1ResponseMPayload(BaseModel): """ - Response for GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getCommunicationList # noqa: E501 - """ - a_obj_communication: conlist(CustomCommunicationListElementResponse) = Field(..., alias="a_objCommunication") - __properties = ["a_objCommunication"] + Response for GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getCommunicationList + """ # noqa: E501 + a_obj_communication: List[CustomCommunicationListElementResponse] = Field(alias="a_objCommunication") + __properties: ClassVar[List[str]] = ["a_objCommunication"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignfolderGetCommunicationListV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignfolderGetCommunicationListV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_communication (list) _items = [] if self.a_obj_communication: @@ -64,16 +82,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignfolderGetCommunicationListV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignfolderGetCommunicationListV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignfolderGetCommunicationListV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignfolderGetCommunicationListV1ResponseMPayload.parse_obj({ - "a_obj_communication": [CustomCommunicationListElementResponse.from_dict(_item) for _item in obj.get("a_objCommunication")] if obj.get("a_objCommunication") is not None else None + _obj = cls.model_validate({ + "a_objCommunication": [CustomCommunicationListElementResponse.from_dict(_item) for _item in obj.get("a_objCommunication")] if obj.get("a_objCommunication") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignfolder_get_communicationrecipients_v1_response.py b/eZmaxApi/models/ezsignfolder_get_communicationrecipients_v1_response.py index ad211968f..78a1b222b 100644 --- a/eZmaxApi/models/ezsignfolder_get_communicationrecipients_v1_response.py +++ b/eZmaxApi/models/ezsignfolder_get_communicationrecipients_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.ezsignfolder_get_communicationrecipients_v1_response_m_payload import EzsignfolderGetCommunicationrecipientsV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignfolderGetCommunicationrecipientsV1Response(BaseModel): """ - Response for GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getCommunicationrecipients # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzsignfolderGetCommunicationrecipientsV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getCommunicationrecipients + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsignfolderGetCommunicationrecipientsV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignfolderGetCommunicationrecipientsV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignfolderGetCommunicationrecipientsV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignfolderGetCommunicationrecipientsV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignfolderGetCommunicationrecipientsV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignfolderGetCommunicationrecipientsV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignfolderGetCommunicationrecipientsV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzsignfolderGetCommunicationrecipientsV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsignfolderGetCommunicationrecipientsV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignfolder_get_communicationrecipients_v1_response_m_payload.py b/eZmaxApi/models/ezsignfolder_get_communicationrecipients_v1_response_m_payload.py index e9beec4c5..ea7be99f7 100644 --- a/eZmaxApi/models/ezsignfolder_get_communicationrecipients_v1_response_m_payload.py +++ b/eZmaxApi/models/ezsignfolder_get_communicationrecipients_v1_response_m_payload.py @@ -19,41 +19,59 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.custom_communicationrecipientsgroup_response import CustomCommunicationrecipientsgroupResponse +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignfolderGetCommunicationrecipientsV1ResponseMPayload(BaseModel): """ - Response for GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getCommunicationrecipients # noqa: E501 - """ - a_obj_communicationrecipientsgroup: conlist(CustomCommunicationrecipientsgroupResponse) = Field(..., alias="a_objCommunicationrecipientsgroup") - __properties = ["a_objCommunicationrecipientsgroup"] + Response for GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getCommunicationrecipients + """ # noqa: E501 + a_obj_communicationrecipientsgroup: List[CustomCommunicationrecipientsgroupResponse] = Field(alias="a_objCommunicationrecipientsgroup") + __properties: ClassVar[List[str]] = ["a_objCommunicationrecipientsgroup"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignfolderGetCommunicationrecipientsV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignfolderGetCommunicationrecipientsV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_communicationrecipientsgroup (list) _items = [] if self.a_obj_communicationrecipientsgroup: @@ -64,16 +82,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignfolderGetCommunicationrecipientsV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignfolderGetCommunicationrecipientsV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignfolderGetCommunicationrecipientsV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignfolderGetCommunicationrecipientsV1ResponseMPayload.parse_obj({ - "a_obj_communicationrecipientsgroup": [CustomCommunicationrecipientsgroupResponse.from_dict(_item) for _item in obj.get("a_objCommunicationrecipientsgroup")] if obj.get("a_objCommunicationrecipientsgroup") is not None else None + _obj = cls.model_validate({ + "a_objCommunicationrecipientsgroup": [CustomCommunicationrecipientsgroupResponse.from_dict(_item) for _item in obj.get("a_objCommunicationrecipientsgroup")] if obj.get("a_objCommunicationrecipientsgroup") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignfolder_get_communicationsenders_v1_response.py b/eZmaxApi/models/ezsignfolder_get_communicationsenders_v1_response.py index caa2aa0a2..48140b8a6 100644 --- a/eZmaxApi/models/ezsignfolder_get_communicationsenders_v1_response.py +++ b/eZmaxApi/models/ezsignfolder_get_communicationsenders_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.ezsignfolder_get_communicationsenders_v1_response_m_payload import EzsignfolderGetCommunicationsendersV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignfolderGetCommunicationsendersV1Response(BaseModel): """ - Response for GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getCommunicationrecipients # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzsignfolderGetCommunicationsendersV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getCommunicationrecipients + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsignfolderGetCommunicationsendersV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignfolderGetCommunicationsendersV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignfolderGetCommunicationsendersV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignfolderGetCommunicationsendersV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignfolderGetCommunicationsendersV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignfolderGetCommunicationsendersV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignfolderGetCommunicationsendersV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzsignfolderGetCommunicationsendersV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsignfolderGetCommunicationsendersV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignfolder_get_communicationsenders_v1_response_m_payload.py b/eZmaxApi/models/ezsignfolder_get_communicationsenders_v1_response_m_payload.py index 1fc29c625..9d22a79c2 100644 --- a/eZmaxApi/models/ezsignfolder_get_communicationsenders_v1_response_m_payload.py +++ b/eZmaxApi/models/ezsignfolder_get_communicationsenders_v1_response_m_payload.py @@ -19,41 +19,59 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.custom_communicationsender_response import CustomCommunicationsenderResponse +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignfolderGetCommunicationsendersV1ResponseMPayload(BaseModel): """ - Response for GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getCommunicationsenders # noqa: E501 - """ - a_obj_communicationsenders: conlist(CustomCommunicationsenderResponse) = Field(..., alias="a_objCommunicationsenders") - __properties = ["a_objCommunicationsenders"] + Response for GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getCommunicationsenders + """ # noqa: E501 + a_obj_communicationsenders: List[CustomCommunicationsenderResponse] = Field(alias="a_objCommunicationsenders") + __properties: ClassVar[List[str]] = ["a_objCommunicationsenders"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignfolderGetCommunicationsendersV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignfolderGetCommunicationsendersV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_communicationsenders (list) _items = [] if self.a_obj_communicationsenders: @@ -64,16 +82,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignfolderGetCommunicationsendersV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignfolderGetCommunicationsendersV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignfolderGetCommunicationsendersV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignfolderGetCommunicationsendersV1ResponseMPayload.parse_obj({ - "a_obj_communicationsenders": [CustomCommunicationsenderResponse.from_dict(_item) for _item in obj.get("a_objCommunicationsenders")] if obj.get("a_objCommunicationsenders") is not None else None + _obj = cls.model_validate({ + "a_objCommunicationsenders": [CustomCommunicationsenderResponse.from_dict(_item) for _item in obj.get("a_objCommunicationsenders")] if obj.get("a_objCommunicationsenders") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignfolder_get_ezsigndocuments_v1_response.py b/eZmaxApi/models/ezsignfolder_get_ezsigndocuments_v1_response.py index fc42484ad..84ab53f9a 100644 --- a/eZmaxApi/models/ezsignfolder_get_ezsigndocuments_v1_response.py +++ b/eZmaxApi/models/ezsignfolder_get_ezsigndocuments_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.ezsignfolder_get_ezsigndocuments_v1_response_m_payload import EzsignfolderGetEzsigndocumentsV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignfolderGetEzsigndocumentsV1Response(BaseModel): """ - Response for GET /1/object/ezsignfolder/{pkiEzsignfolder}/getEzsigndocuments # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzsignfolderGetEzsigndocumentsV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /1/object/ezsignfolder/{pkiEzsignfolder}/getEzsigndocuments + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsignfolderGetEzsigndocumentsV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignfolderGetEzsigndocumentsV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignfolderGetEzsigndocumentsV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignfolderGetEzsigndocumentsV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignfolderGetEzsigndocumentsV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignfolderGetEzsigndocumentsV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignfolderGetEzsigndocumentsV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzsignfolderGetEzsigndocumentsV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsignfolderGetEzsigndocumentsV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignfolder_get_ezsigndocuments_v1_response_m_payload.py b/eZmaxApi/models/ezsignfolder_get_ezsigndocuments_v1_response_m_payload.py index 4c49b0784..6c515f634 100644 --- a/eZmaxApi/models/ezsignfolder_get_ezsigndocuments_v1_response_m_payload.py +++ b/eZmaxApi/models/ezsignfolder_get_ezsigndocuments_v1_response_m_payload.py @@ -19,41 +19,59 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.ezsigndocument_response_compound import EzsigndocumentResponseCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignfolderGetEzsigndocumentsV1ResponseMPayload(BaseModel): """ - Payload for GET /1/object/ezsignfolder/{pkiEzsignfolder}/getEzsigndocuments # noqa: E501 - """ - a_obj_ezsigndocument: conlist(EzsigndocumentResponseCompound) = Field(..., alias="a_objEzsigndocument") - __properties = ["a_objEzsigndocument"] + Payload for GET /1/object/ezsignfolder/{pkiEzsignfolder}/getEzsigndocuments + """ # noqa: E501 + a_obj_ezsigndocument: List[EzsigndocumentResponseCompound] = Field(alias="a_objEzsigndocument") + __properties: ClassVar[List[str]] = ["a_objEzsigndocument"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignfolderGetEzsigndocumentsV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignfolderGetEzsigndocumentsV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_ezsigndocument (list) _items = [] if self.a_obj_ezsigndocument: @@ -64,16 +82,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignfolderGetEzsigndocumentsV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignfolderGetEzsigndocumentsV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignfolderGetEzsigndocumentsV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignfolderGetEzsigndocumentsV1ResponseMPayload.parse_obj({ - "a_obj_ezsigndocument": [EzsigndocumentResponseCompound.from_dict(_item) for _item in obj.get("a_objEzsigndocument")] if obj.get("a_objEzsigndocument") is not None else None + _obj = cls.model_validate({ + "a_objEzsigndocument": [EzsigndocumentResponseCompound.from_dict(_item) for _item in obj.get("a_objEzsigndocument")] if obj.get("a_objEzsigndocument") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignfolder_get_ezsignfoldersignerassociations_v1_response.py b/eZmaxApi/models/ezsignfolder_get_ezsignfoldersignerassociations_v1_response.py index a04395d0f..837aec0b9 100644 --- a/eZmaxApi/models/ezsignfolder_get_ezsignfoldersignerassociations_v1_response.py +++ b/eZmaxApi/models/ezsignfolder_get_ezsignfoldersignerassociations_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.ezsignfolder_get_ezsignfoldersignerassociations_v1_response_m_payload import EzsignfolderGetEzsignfoldersignerassociationsV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignfolderGetEzsignfoldersignerassociationsV1Response(BaseModel): """ - Response for GET /1/object/ezsignfolder/{pkiEzsignfolder}/getEzsignfoldersignerassociations # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzsignfolderGetEzsignfoldersignerassociationsV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /1/object/ezsignfolder/{pkiEzsignfolder}/getEzsignfoldersignerassociations + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsignfolderGetEzsignfoldersignerassociationsV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignfolderGetEzsignfoldersignerassociationsV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignfolderGetEzsignfoldersignerassociationsV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignfolderGetEzsignfoldersignerassociationsV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignfolderGetEzsignfoldersignerassociationsV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignfolderGetEzsignfoldersignerassociationsV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignfolderGetEzsignfoldersignerassociationsV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzsignfolderGetEzsignfoldersignerassociationsV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsignfolderGetEzsignfoldersignerassociationsV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignfolder_get_ezsignfoldersignerassociations_v1_response_m_payload.py b/eZmaxApi/models/ezsignfolder_get_ezsignfoldersignerassociations_v1_response_m_payload.py index 55aaef2f5..7da799e49 100644 --- a/eZmaxApi/models/ezsignfolder_get_ezsignfoldersignerassociations_v1_response_m_payload.py +++ b/eZmaxApi/models/ezsignfolder_get_ezsignfoldersignerassociations_v1_response_m_payload.py @@ -19,41 +19,59 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.custom_ezsignfoldersignerassociation_actionable_element_response import CustomEzsignfoldersignerassociationActionableElementResponse +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignfolderGetEzsignfoldersignerassociationsV1ResponseMPayload(BaseModel): """ - Payload for GET /1/object/ezsignfolder/{pkiEzsignfolder}/getEzsignfoldersignerassociations # noqa: E501 - """ - a_obj_ezsignfoldersignerassociation: conlist(CustomEzsignfoldersignerassociationActionableElementResponse) = Field(..., alias="a_objEzsignfoldersignerassociation") - __properties = ["a_objEzsignfoldersignerassociation"] + Payload for GET /1/object/ezsignfolder/{pkiEzsignfolder}/getEzsignfoldersignerassociations + """ # noqa: E501 + a_obj_ezsignfoldersignerassociation: List[CustomEzsignfoldersignerassociationActionableElementResponse] = Field(alias="a_objEzsignfoldersignerassociation") + __properties: ClassVar[List[str]] = ["a_objEzsignfoldersignerassociation"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignfolderGetEzsignfoldersignerassociationsV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignfolderGetEzsignfoldersignerassociationsV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_ezsignfoldersignerassociation (list) _items = [] if self.a_obj_ezsignfoldersignerassociation: @@ -64,16 +82,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignfolderGetEzsignfoldersignerassociationsV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignfolderGetEzsignfoldersignerassociationsV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignfolderGetEzsignfoldersignerassociationsV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignfolderGetEzsignfoldersignerassociationsV1ResponseMPayload.parse_obj({ - "a_obj_ezsignfoldersignerassociation": [CustomEzsignfoldersignerassociationActionableElementResponse.from_dict(_item) for _item in obj.get("a_objEzsignfoldersignerassociation")] if obj.get("a_objEzsignfoldersignerassociation") is not None else None + _obj = cls.model_validate({ + "a_objEzsignfoldersignerassociation": [CustomEzsignfoldersignerassociationActionableElementResponse.from_dict(_item) for _item in obj.get("a_objEzsignfoldersignerassociation")] if obj.get("a_objEzsignfoldersignerassociation") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignfolder_get_ezsignsignatures_automatic_v1_response.py b/eZmaxApi/models/ezsignfolder_get_ezsignsignatures_automatic_v1_response.py index 203066ea4..e3086de1b 100644 --- a/eZmaxApi/models/ezsignfolder_get_ezsignsignatures_automatic_v1_response.py +++ b/eZmaxApi/models/ezsignfolder_get_ezsignsignatures_automatic_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.ezsignfolder_get_ezsignsignatures_automatic_v1_response_m_payload import EzsignfolderGetEzsignsignaturesAutomaticV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignfolderGetEzsignsignaturesAutomaticV1Response(BaseModel): """ - Response for GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getEzsignsignaturesAutomatic # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzsignfolderGetEzsignsignaturesAutomaticV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getEzsignsignaturesAutomatic + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsignfolderGetEzsignsignaturesAutomaticV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignfolderGetEzsignsignaturesAutomaticV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignfolderGetEzsignsignaturesAutomaticV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignfolderGetEzsignsignaturesAutomaticV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignfolderGetEzsignsignaturesAutomaticV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignfolderGetEzsignsignaturesAutomaticV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignfolderGetEzsignsignaturesAutomaticV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzsignfolderGetEzsignsignaturesAutomaticV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsignfolderGetEzsignsignaturesAutomaticV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignfolder_get_ezsignsignatures_automatic_v1_response_m_payload.py b/eZmaxApi/models/ezsignfolder_get_ezsignsignatures_automatic_v1_response_m_payload.py index c5d33b307..5be2d77a5 100644 --- a/eZmaxApi/models/ezsignfolder_get_ezsignsignatures_automatic_v1_response_m_payload.py +++ b/eZmaxApi/models/ezsignfolder_get_ezsignsignatures_automatic_v1_response_m_payload.py @@ -19,43 +19,61 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.custom_ezsignfolder_ezsignsignatures_automatic_response import CustomEzsignfolderEzsignsignaturesAutomaticResponse from eZmaxApi.models.field_e_ezsignsignature_type import FieldEEzsignsignatureType +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignfolderGetEzsignsignaturesAutomaticV1ResponseMPayload(BaseModel): """ - Payload for GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getEzsignsignaturesAutomatic # noqa: E501 - """ - a_e_ezsignsignature_type: conlist(FieldEEzsignsignatureType, unique_items=True) = Field(..., alias="a_eEzsignsignatureType", description="All eEzsignsignatureType contained in the response") - a_obj_ezsignfolder: conlist(CustomEzsignfolderEzsignsignaturesAutomaticResponse) = Field(..., alias="a_objEzsignfolder") - __properties = ["a_eEzsignsignatureType", "a_objEzsignfolder"] + Payload for GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getEzsignsignaturesAutomatic + """ # noqa: E501 + a_e_ezsignsignature_type: List[FieldEEzsignsignatureType] = Field(description="All eEzsignsignatureType contained in the response", alias="a_eEzsignsignatureType") + a_obj_ezsignfolder: List[CustomEzsignfolderEzsignsignaturesAutomaticResponse] = Field(alias="a_objEzsignfolder") + __properties: ClassVar[List[str]] = ["a_eEzsignsignatureType", "a_objEzsignfolder"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignfolderGetEzsignsignaturesAutomaticV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignfolderGetEzsignsignaturesAutomaticV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_ezsignfolder (list) _items = [] if self.a_obj_ezsignfolder: @@ -66,17 +84,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignfolderGetEzsignsignaturesAutomaticV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignfolderGetEzsignsignaturesAutomaticV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignfolderGetEzsignsignaturesAutomaticV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignfolderGetEzsignsignaturesAutomaticV1ResponseMPayload.parse_obj({ - "a_e_ezsignsignature_type": obj.get("a_eEzsignsignatureType"), - "a_obj_ezsignfolder": [CustomEzsignfolderEzsignsignaturesAutomaticResponse.from_dict(_item) for _item in obj.get("a_objEzsignfolder")] if obj.get("a_objEzsignfolder") is not None else None + _obj = cls.model_validate({ + "a_eEzsignsignatureType": obj.get("a_eEzsignsignatureType"), + "a_objEzsignfolder": [CustomEzsignfolderEzsignsignaturesAutomaticResponse.from_dict(_item) for _item in obj.get("a_objEzsignfolder")] if obj.get("a_objEzsignfolder") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignfolder_get_forms_data_v1_response.py b/eZmaxApi/models/ezsignfolder_get_forms_data_v1_response.py index 8fb67372d..46750a96d 100644 --- a/eZmaxApi/models/ezsignfolder_get_forms_data_v1_response.py +++ b/eZmaxApi/models/ezsignfolder_get_forms_data_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.ezsignfolder_get_forms_data_v1_response_m_payload import EzsignfolderGetFormsDataV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignfolderGetFormsDataV1Response(BaseModel): """ - Response for GET /1/object/ezsignfolder/{pkiEzsignfolder}/getFormsData # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzsignfolderGetFormsDataV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /1/object/ezsignfolder/{pkiEzsignfolder}/getFormsData + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsignfolderGetFormsDataV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignfolderGetFormsDataV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignfolderGetFormsDataV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignfolderGetFormsDataV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignfolderGetFormsDataV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignfolderGetFormsDataV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignfolderGetFormsDataV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzsignfolderGetFormsDataV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsignfolderGetFormsDataV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignfolder_get_forms_data_v1_response_m_payload.py b/eZmaxApi/models/ezsignfolder_get_forms_data_v1_response_m_payload.py index f4a337fcc..63913b140 100644 --- a/eZmaxApi/models/ezsignfolder_get_forms_data_v1_response_m_payload.py +++ b/eZmaxApi/models/ezsignfolder_get_forms_data_v1_response_m_payload.py @@ -19,57 +19,75 @@ import json - -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.custom_forms_data_folder_response import CustomFormsDataFolderResponse +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignfolderGetFormsDataV1ResponseMPayload(BaseModel): """ - Payload for GET /1/object/ezsignfolder/{pkiEzsigndocument}/getFormsData # noqa: E501 - """ - obj_forms_data_folder: CustomFormsDataFolderResponse = Field(..., alias="objFormsDataFolder") - __properties = ["objFormsDataFolder"] + Payload for GET /1/object/ezsignfolder/{pkiEzsigndocument}/getFormsData + """ # noqa: E501 + obj_forms_data_folder: CustomFormsDataFolderResponse = Field(alias="objFormsDataFolder") + __properties: ClassVar[List[str]] = ["objFormsDataFolder"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignfolderGetFormsDataV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignfolderGetFormsDataV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_forms_data_folder if self.obj_forms_data_folder: _dict['objFormsDataFolder'] = self.obj_forms_data_folder.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignfolderGetFormsDataV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignfolderGetFormsDataV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignfolderGetFormsDataV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignfolderGetFormsDataV1ResponseMPayload.parse_obj({ - "obj_forms_data_folder": CustomFormsDataFolderResponse.from_dict(obj.get("objFormsDataFolder")) if obj.get("objFormsDataFolder") is not None else None + _obj = cls.model_validate({ + "objFormsDataFolder": CustomFormsDataFolderResponse.from_dict(obj.get("objFormsDataFolder")) if obj.get("objFormsDataFolder") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignfolder_get_list_v1_response.py b/eZmaxApi/models/ezsignfolder_get_list_v1_response.py index b5a4c2596..9b7f3a320 100644 --- a/eZmaxApi/models/ezsignfolder_get_list_v1_response.py +++ b/eZmaxApi/models/ezsignfolder_get_list_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload_get_list import CommonResponseObjDebugPayloadGetList from eZmaxApi.models.ezsignfolder_get_list_v1_response_m_payload import EzsignfolderGetListV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignfolderGetListV1Response(BaseModel): """ - Response for GET /1/object/ezsignfolder/getList # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayloadGetList = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzsignfolderGetListV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /1/object/ezsignfolder/getList + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayloadGetList = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsignfolderGetListV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignfolderGetListV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignfolderGetListV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignfolderGetListV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignfolderGetListV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignfolderGetListV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignfolderGetListV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayloadGetList.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzsignfolderGetListV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayloadGetList.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsignfolderGetListV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignfolder_get_list_v1_response_m_payload.py b/eZmaxApi/models/ezsignfolder_get_list_v1_response_m_payload.py index ff699cfb8..472b35350 100644 --- a/eZmaxApi/models/ezsignfolder_get_list_v1_response_m_payload.py +++ b/eZmaxApi/models/ezsignfolder_get_list_v1_response_m_payload.py @@ -19,43 +19,61 @@ import json -from typing import List -from pydantic import BaseModel, Field, StrictInt, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictInt +from pydantic import Field from eZmaxApi.models.ezsignfolder_list_element import EzsignfolderListElement +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignfolderGetListV1ResponseMPayload(BaseModel): """ - Payload for GET /1/object/ezsignfolder/getList # noqa: E501 - """ - i_row_returned: StrictInt = Field(..., alias="iRowReturned", description="The number of rows returned") - i_row_filtered: StrictInt = Field(..., alias="iRowFiltered", description="The number of rows matching your filters (if any) or the total number of rows") - a_obj_ezsignfolder: conlist(EzsignfolderListElement) = Field(..., alias="a_objEzsignfolder") - __properties = ["iRowReturned", "iRowFiltered", "a_objEzsignfolder"] + Payload for GET /1/object/ezsignfolder/getList + """ # noqa: E501 + i_row_returned: StrictInt = Field(description="The number of rows returned", alias="iRowReturned") + i_row_filtered: StrictInt = Field(description="The number of rows matching your filters (if any) or the total number of rows", alias="iRowFiltered") + a_obj_ezsignfolder: List[EzsignfolderListElement] = Field(alias="a_objEzsignfolder") + __properties: ClassVar[List[str]] = ["iRowReturned", "iRowFiltered", "a_objEzsignfolder"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignfolderGetListV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignfolderGetListV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_ezsignfolder (list) _items = [] if self.a_obj_ezsignfolder: @@ -66,18 +84,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignfolderGetListV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignfolderGetListV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignfolderGetListV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignfolderGetListV1ResponseMPayload.parse_obj({ - "i_row_returned": obj.get("iRowReturned"), - "i_row_filtered": obj.get("iRowFiltered"), - "a_obj_ezsignfolder": [EzsignfolderListElement.from_dict(_item) for _item in obj.get("a_objEzsignfolder")] if obj.get("a_objEzsignfolder") is not None else None + _obj = cls.model_validate({ + "iRowReturned": obj.get("iRowReturned"), + "iRowFiltered": obj.get("iRowFiltered"), + "a_objEzsignfolder": [EzsignfolderListElement.from_dict(_item) for _item in obj.get("a_objEzsignfolder")] if obj.get("a_objEzsignfolder") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignfolder_get_object_v1_response.py b/eZmaxApi/models/ezsignfolder_get_object_v1_response.py index 95af4bcc5..5a4c638ff 100644 --- a/eZmaxApi/models/ezsignfolder_get_object_v1_response.py +++ b/eZmaxApi/models/ezsignfolder_get_object_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.ezsignfolder_get_object_v1_response_m_payload import EzsignfolderGetObjectV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignfolderGetObjectV1Response(BaseModel): """ - Response for GET /1/object/ezsignfolder/{pkiEzsignfolderID} # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzsignfolderGetObjectV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /1/object/ezsignfolder/{pkiEzsignfolderID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsignfolderGetObjectV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignfolderGetObjectV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignfolderGetObjectV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignfolderGetObjectV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignfolderGetObjectV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignfolderGetObjectV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignfolderGetObjectV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzsignfolderGetObjectV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsignfolderGetObjectV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignfolder_get_object_v1_response_m_payload.py b/eZmaxApi/models/ezsignfolder_get_object_v1_response_m_payload.py index f0d20ecb8..c54a8ed47 100644 --- a/eZmaxApi/models/ezsignfolder_get_object_v1_response_m_payload.py +++ b/eZmaxApi/models/ezsignfolder_get_object_v1_response_m_payload.py @@ -19,42 +19,48 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint, constr, validator +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, StrictStr, field_validator +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.common_audit import CommonAudit from eZmaxApi.models.custom_ezsignfoldertype_response import CustomEzsignfoldertypeResponse from eZmaxApi.models.field_e_ezsignfolder_sendreminderfrequency import FieldEEzsignfolderSendreminderfrequency from eZmaxApi.models.field_e_ezsignfolder_step import FieldEEzsignfolderStep +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignfolderGetObjectV1ResponseMPayload(BaseModel): """ - Payload for GET /1/object/ezsignfolder/{pkiEzsignfolderID} # noqa: E501 - """ - pki_ezsignfolder_id: conint(strict=True, ge=0) = Field(..., alias="pkiEzsignfolderID", description="The unique ID of the Ezsignfolder") - fki_ezsignfoldertype_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiEzsignfoldertypeID", description="The unique ID of the Ezsignfoldertype.") - obj_ezsignfoldertype: Optional[CustomEzsignfoldertypeResponse] = Field(None, alias="objEzsignfoldertype") - s_ezsignfoldertype_name_x: Optional[StrictStr] = Field(None, alias="sEzsignfoldertypeNameX") - fki_billingentityinternal_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiBillingentityinternalID", description="The unique ID of the Billingentityinternal.") - s_billingentityinternal_description_x: Optional[StrictStr] = Field(None, alias="sBillingentityinternalDescriptionX", description="The description of the Billingentityinternal in the language of the requester") - fki_ezsigntsarequirement_id: Optional[conint(strict=True, le=3, ge=1)] = Field(None, alias="fkiEzsigntsarequirementID", description="The unique ID of the Ezsigntsarequirement. Determine if a Time Stamping Authority should add a timestamp on each of the signature. Valid values: |Value|Description| |-|-| |1|No. TSA Timestamping will requested. This will make all signatures a lot faster since no round-trip to the TSA server will be required. Timestamping will be made using eZsign server's time.| |2|Best effort. Timestamping from a Time Stamping Authority will be requested but is not mandatory. In the very improbable case it cannot be completed, the timestamping will be made using eZsign server's time. **Additional fee applies**| |3|Mandatory. Timestamping from a Time Stamping Authority will be requested and is mandatory. In the very improbable case it cannot be completed, the signature will fail and the user will be asked to retry. **Additional fee applies**|") - s_ezsigntsarequirement_description_x: Optional[StrictStr] = Field(None, alias="sEzsigntsarequirementDescriptionX", description="The description of the Ezsigntsarequirement in the language of the requester") - s_ezsignfolder_description: StrictStr = Field(..., alias="sEzsignfolderDescription", description="The description of the Ezsignfolder") - t_ezsignfolder_note: Optional[StrictStr] = Field(None, alias="tEzsignfolderNote", description="Note about the Ezsignfolder") - b_ezsignfolder_isdisposable: Optional[StrictBool] = Field(None, alias="bEzsignfolderIsdisposable", description="If the Ezsigndocument can be disposed") - e_ezsignfolder_sendreminderfrequency: Optional[FieldEEzsignfolderSendreminderfrequency] = Field(None, alias="eEzsignfolderSendreminderfrequency") - dt_ezsignfolder_delayedsenddate: Optional[StrictStr] = Field(None, alias="dtEzsignfolderDelayedsenddate", description="The date and time at which the Ezsignfolder will be sent in the future.") - dt_ezsignfolder_duedate: Optional[StrictStr] = Field(None, alias="dtEzsignfolderDuedate", description="The maximum date and time at which the Ezsignfolder can be signed.") - dt_ezsignfolder_sentdate: Optional[StrictStr] = Field(None, alias="dtEzsignfolderSentdate", description="The date and time at which the Ezsignfolder was sent the last time.") - dt_ezsignfolder_scheduledarchive: Optional[StrictStr] = Field(None, alias="dtEzsignfolderScheduledarchive", description="The scheduled date and time at which the Ezsignfolder should be archived.") - dt_ezsignfolder_scheduleddispose: Optional[StrictStr] = Field(None, alias="dtEzsignfolderScheduleddispose", description="The scheduled date at which the Ezsignfolder should be Disposed.") - e_ezsignfolder_step: Optional[FieldEEzsignfolderStep] = Field(None, alias="eEzsignfolderStep") - dt_ezsignfolder_close: Optional[StrictStr] = Field(None, alias="dtEzsignfolderClose", description="The date and time at which the Ezsignfolder was closed. Either by applying the last signature or by completing it prematurely.") - t_ezsignfolder_message: Optional[StrictStr] = Field(None, alias="tEzsignfolderMessage", description="A custom text message that will be added to the email sent.") - obj_audit: Optional[CommonAudit] = Field(None, alias="objAudit") - s_ezsignfolder_externalid: Optional[constr(strict=True)] = Field(None, alias="sEzsignfolderExternalid", description="This field can be used to store an External ID from the client's system. Anything can be stored in this field, it will never be evaluated by the eZmax system and will be returned AS-IS. To store multiple values, consider using a JSON formatted structure, a URL encoded string, a CSV or any other custom format. ") - __properties = ["pkiEzsignfolderID", "fkiEzsignfoldertypeID", "objEzsignfoldertype", "sEzsignfoldertypeNameX", "fkiBillingentityinternalID", "sBillingentityinternalDescriptionX", "fkiEzsigntsarequirementID", "sEzsigntsarequirementDescriptionX", "sEzsignfolderDescription", "tEzsignfolderNote", "bEzsignfolderIsdisposable", "eEzsignfolderSendreminderfrequency", "dtEzsignfolderDelayedsenddate", "dtEzsignfolderDuedate", "dtEzsignfolderSentdate", "dtEzsignfolderScheduledarchive", "dtEzsignfolderScheduleddispose", "eEzsignfolderStep", "dtEzsignfolderClose", "tEzsignfolderMessage", "objAudit", "sEzsignfolderExternalid"] - - @validator('s_ezsignfolder_externalid') + Payload for GET /1/object/ezsignfolder/{pkiEzsignfolderID} + """ # noqa: E501 + pki_ezsignfolder_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsignfolder", alias="pkiEzsignfolderID") + fki_ezsignfoldertype_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsignfoldertype.", alias="fkiEzsignfoldertypeID") + obj_ezsignfoldertype: Optional[CustomEzsignfoldertypeResponse] = Field(default=None, alias="objEzsignfoldertype") + s_ezsignfoldertype_name_x: Optional[StrictStr] = Field(default=None, alias="sEzsignfoldertypeNameX") + fki_billingentityinternal_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Billingentityinternal.", alias="fkiBillingentityinternalID") + s_billingentityinternal_description_x: Optional[StrictStr] = Field(default=None, description="The description of the Billingentityinternal in the language of the requester", alias="sBillingentityinternalDescriptionX") + fki_ezsigntsarequirement_id: Optional[Annotated[int, Field(le=3, strict=True, ge=1)]] = Field(default=None, description="The unique ID of the Ezsigntsarequirement. Determine if a Time Stamping Authority should add a timestamp on each of the signature. Valid values: |Value|Description| |-|-| |1|No. TSA Timestamping will requested. This will make all signatures a lot faster since no round-trip to the TSA server will be required. Timestamping will be made using eZsign server's time.| |2|Best effort. Timestamping from a Time Stamping Authority will be requested but is not mandatory. In the very improbable case it cannot be completed, the timestamping will be made using eZsign server's time. **Additional fee applies**| |3|Mandatory. Timestamping from a Time Stamping Authority will be requested and is mandatory. In the very improbable case it cannot be completed, the signature will fail and the user will be asked to retry. **Additional fee applies**|", alias="fkiEzsigntsarequirementID") + s_ezsigntsarequirement_description_x: Optional[StrictStr] = Field(default=None, description="The description of the Ezsigntsarequirement in the language of the requester", alias="sEzsigntsarequirementDescriptionX") + s_ezsignfolder_description: StrictStr = Field(description="The description of the Ezsignfolder", alias="sEzsignfolderDescription") + t_ezsignfolder_note: Optional[StrictStr] = Field(default=None, description="Note about the Ezsignfolder", alias="tEzsignfolderNote") + b_ezsignfolder_isdisposable: Optional[StrictBool] = Field(default=None, description="If the Ezsigndocument can be disposed", alias="bEzsignfolderIsdisposable") + e_ezsignfolder_sendreminderfrequency: Optional[FieldEEzsignfolderSendreminderfrequency] = Field(default=None, alias="eEzsignfolderSendreminderfrequency") + dt_ezsignfolder_delayedsenddate: Optional[StrictStr] = Field(default=None, description="The date and time at which the Ezsignfolder will be sent in the future.", alias="dtEzsignfolderDelayedsenddate") + dt_ezsignfolder_duedate: Optional[StrictStr] = Field(default=None, description="The maximum date and time at which the Ezsignfolder can be signed.", alias="dtEzsignfolderDuedate") + dt_ezsignfolder_sentdate: Optional[StrictStr] = Field(default=None, description="The date and time at which the Ezsignfolder was sent the last time.", alias="dtEzsignfolderSentdate") + dt_ezsignfolder_scheduledarchive: Optional[StrictStr] = Field(default=None, description="The scheduled date and time at which the Ezsignfolder should be archived.", alias="dtEzsignfolderScheduledarchive") + dt_ezsignfolder_scheduleddispose: Optional[StrictStr] = Field(default=None, description="The scheduled date at which the Ezsignfolder should be Disposed.", alias="dtEzsignfolderScheduleddispose") + e_ezsignfolder_step: Optional[FieldEEzsignfolderStep] = Field(default=None, alias="eEzsignfolderStep") + dt_ezsignfolder_close: Optional[StrictStr] = Field(default=None, description="The date and time at which the Ezsignfolder was closed. Either by applying the last signature or by completing it prematurely.", alias="dtEzsignfolderClose") + t_ezsignfolder_message: Optional[StrictStr] = Field(default=None, description="A custom text message that will be added to the email sent.", alias="tEzsignfolderMessage") + obj_audit: Optional[CommonAudit] = Field(default=None, alias="objAudit") + s_ezsignfolder_externalid: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="This field can be used to store an External ID from the client's system. Anything can be stored in this field, it will never be evaluated by the eZmax system and will be returned AS-IS. To store multiple values, consider using a JSON formatted structure, a URL encoded string, a CSV or any other custom format. ", alias="sEzsignfolderExternalid") + __properties: ClassVar[List[str]] = ["pkiEzsignfolderID", "fkiEzsignfoldertypeID", "objEzsignfoldertype", "sEzsignfoldertypeNameX", "fkiBillingentityinternalID", "sBillingentityinternalDescriptionX", "fkiEzsigntsarequirementID", "sEzsigntsarequirementDescriptionX", "sEzsignfolderDescription", "tEzsignfolderNote", "bEzsignfolderIsdisposable", "eEzsignfolderSendreminderfrequency", "dtEzsignfolderDelayedsenddate", "dtEzsignfolderDuedate", "dtEzsignfolderSentdate", "dtEzsignfolderScheduledarchive", "dtEzsignfolderScheduleddispose", "eEzsignfolderStep", "dtEzsignfolderClose", "tEzsignfolderMessage", "objAudit", "sEzsignfolderExternalid"] + + @field_validator('s_ezsignfolder_externalid') def s_ezsignfolder_externalid_validate_regular_expression(cls, value): """Validates the regular expression""" if value is None: @@ -64,30 +70,43 @@ def s_ezsignfolder_externalid_validate_regular_expression(cls, value): raise ValueError(r"must validate the regular expression /^.{0,64}$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignfolderGetObjectV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignfolderGetObjectV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_ezsignfoldertype if self.obj_ezsignfoldertype: _dict['objEzsignfoldertype'] = self.obj_ezsignfoldertype.to_dict() @@ -97,37 +116,37 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignfolderGetObjectV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignfolderGetObjectV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignfolderGetObjectV1ResponseMPayload.parse_obj(obj) - - _obj = EzsignfolderGetObjectV1ResponseMPayload.parse_obj({ - "pki_ezsignfolder_id": obj.get("pkiEzsignfolderID"), - "fki_ezsignfoldertype_id": obj.get("fkiEzsignfoldertypeID"), - "obj_ezsignfoldertype": CustomEzsignfoldertypeResponse.from_dict(obj.get("objEzsignfoldertype")) if obj.get("objEzsignfoldertype") is not None else None, - "s_ezsignfoldertype_name_x": obj.get("sEzsignfoldertypeNameX"), - "fki_billingentityinternal_id": obj.get("fkiBillingentityinternalID"), - "s_billingentityinternal_description_x": obj.get("sBillingentityinternalDescriptionX"), - "fki_ezsigntsarequirement_id": obj.get("fkiEzsigntsarequirementID"), - "s_ezsigntsarequirement_description_x": obj.get("sEzsigntsarequirementDescriptionX"), - "s_ezsignfolder_description": obj.get("sEzsignfolderDescription"), - "t_ezsignfolder_note": obj.get("tEzsignfolderNote"), - "b_ezsignfolder_isdisposable": obj.get("bEzsignfolderIsdisposable"), - "e_ezsignfolder_sendreminderfrequency": obj.get("eEzsignfolderSendreminderfrequency"), - "dt_ezsignfolder_delayedsenddate": obj.get("dtEzsignfolderDelayedsenddate"), - "dt_ezsignfolder_duedate": obj.get("dtEzsignfolderDuedate"), - "dt_ezsignfolder_sentdate": obj.get("dtEzsignfolderSentdate"), - "dt_ezsignfolder_scheduledarchive": obj.get("dtEzsignfolderScheduledarchive"), - "dt_ezsignfolder_scheduleddispose": obj.get("dtEzsignfolderScheduleddispose"), - "e_ezsignfolder_step": obj.get("eEzsignfolderStep"), - "dt_ezsignfolder_close": obj.get("dtEzsignfolderClose"), - "t_ezsignfolder_message": obj.get("tEzsignfolderMessage"), - "obj_audit": CommonAudit.from_dict(obj.get("objAudit")) if obj.get("objAudit") is not None else None, - "s_ezsignfolder_externalid": obj.get("sEzsignfolderExternalid") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsignfolderID": obj.get("pkiEzsignfolderID"), + "fkiEzsignfoldertypeID": obj.get("fkiEzsignfoldertypeID"), + "objEzsignfoldertype": CustomEzsignfoldertypeResponse.from_dict(obj.get("objEzsignfoldertype")) if obj.get("objEzsignfoldertype") is not None else None, + "sEzsignfoldertypeNameX": obj.get("sEzsignfoldertypeNameX"), + "fkiBillingentityinternalID": obj.get("fkiBillingentityinternalID"), + "sBillingentityinternalDescriptionX": obj.get("sBillingentityinternalDescriptionX"), + "fkiEzsigntsarequirementID": obj.get("fkiEzsigntsarequirementID"), + "sEzsigntsarequirementDescriptionX": obj.get("sEzsigntsarequirementDescriptionX"), + "sEzsignfolderDescription": obj.get("sEzsignfolderDescription"), + "tEzsignfolderNote": obj.get("tEzsignfolderNote"), + "bEzsignfolderIsdisposable": obj.get("bEzsignfolderIsdisposable"), + "eEzsignfolderSendreminderfrequency": obj.get("eEzsignfolderSendreminderfrequency"), + "dtEzsignfolderDelayedsenddate": obj.get("dtEzsignfolderDelayedsenddate"), + "dtEzsignfolderDuedate": obj.get("dtEzsignfolderDuedate"), + "dtEzsignfolderSentdate": obj.get("dtEzsignfolderSentdate"), + "dtEzsignfolderScheduledarchive": obj.get("dtEzsignfolderScheduledarchive"), + "dtEzsignfolderScheduleddispose": obj.get("dtEzsignfolderScheduleddispose"), + "eEzsignfolderStep": obj.get("eEzsignfolderStep"), + "dtEzsignfolderClose": obj.get("dtEzsignfolderClose"), + "tEzsignfolderMessage": obj.get("tEzsignfolderMessage"), + "objAudit": CommonAudit.from_dict(obj.get("objAudit")) if obj.get("objAudit") is not None else None, + "sEzsignfolderExternalid": obj.get("sEzsignfolderExternalid") }) return _obj diff --git a/eZmaxApi/models/ezsignfolder_get_object_v2_response.py b/eZmaxApi/models/ezsignfolder_get_object_v2_response.py index 5622e8248..1d2a3b3ab 100644 --- a/eZmaxApi/models/ezsignfolder_get_object_v2_response.py +++ b/eZmaxApi/models/ezsignfolder_get_object_v2_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.ezsignfolder_get_object_v2_response_m_payload import EzsignfolderGetObjectV2ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignfolderGetObjectV2Response(BaseModel): """ - Response for GET /2/object/ezsignfolder/{pkiEzsignfolderID} # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzsignfolderGetObjectV2ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /2/object/ezsignfolder/{pkiEzsignfolderID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsignfolderGetObjectV2ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignfolderGetObjectV2Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignfolderGetObjectV2Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignfolderGetObjectV2Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignfolderGetObjectV2Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignfolderGetObjectV2Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignfolderGetObjectV2Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzsignfolderGetObjectV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsignfolderGetObjectV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignfolder_get_object_v2_response_m_payload.py b/eZmaxApi/models/ezsignfolder_get_object_v2_response_m_payload.py index 451a63e64..daae54ed8 100644 --- a/eZmaxApi/models/ezsignfolder_get_object_v2_response_m_payload.py +++ b/eZmaxApi/models/ezsignfolder_get_object_v2_response_m_payload.py @@ -19,57 +19,75 @@ import json - -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.ezsignfolder_response_compound import EzsignfolderResponseCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignfolderGetObjectV2ResponseMPayload(BaseModel): """ - Payload for GET /2/object/ezsignfolder/{pkiEzsignfolderID} # noqa: E501 - """ - obj_ezsignfolder: EzsignfolderResponseCompound = Field(..., alias="objEzsignfolder") - __properties = ["objEzsignfolder"] + Payload for GET /2/object/ezsignfolder/{pkiEzsignfolderID} + """ # noqa: E501 + obj_ezsignfolder: EzsignfolderResponseCompound = Field(alias="objEzsignfolder") + __properties: ClassVar[List[str]] = ["objEzsignfolder"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignfolderGetObjectV2ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignfolderGetObjectV2ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_ezsignfolder if self.obj_ezsignfolder: _dict['objEzsignfolder'] = self.obj_ezsignfolder.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignfolderGetObjectV2ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignfolderGetObjectV2ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignfolderGetObjectV2ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignfolderGetObjectV2ResponseMPayload.parse_obj({ - "obj_ezsignfolder": EzsignfolderResponseCompound.from_dict(obj.get("objEzsignfolder")) if obj.get("objEzsignfolder") is not None else None + _obj = cls.model_validate({ + "objEzsignfolder": EzsignfolderResponseCompound.from_dict(obj.get("objEzsignfolder")) if obj.get("objEzsignfolder") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignfolder_import_ezsignfoldersignerassociations_v1_request.py b/eZmaxApi/models/ezsignfolder_import_ezsignfoldersignerassociations_v1_request.py index 4a9d15b74..a106ab76b 100644 --- a/eZmaxApi/models/ezsignfolder_import_ezsignfoldersignerassociations_v1_request.py +++ b/eZmaxApi/models/ezsignfolder_import_ezsignfoldersignerassociations_v1_request.py @@ -19,53 +19,72 @@ import json -from typing import List -from pydantic import BaseModel, Field, conint, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignfolderImportEzsignfoldersignerassociationsV1Request(BaseModel): """ - Request for POST /1/object/ezsignfolder/{pkiEzsignfolderID}/importEzsignfoldersignerassociations # noqa: E501 - """ - a_fki_ezsignfoldersignerassociation_id: conlist(conint(strict=True, ge=0), min_items=1, unique_items=True) = Field(..., alias="a_fkiEzsignfoldersignerassociationID") - __properties = ["a_fkiEzsignfoldersignerassociationID"] + Request for POST /1/object/ezsignfolder/{pkiEzsignfolderID}/importEzsignfoldersignerassociations + """ # noqa: E501 + a_fki_ezsignfoldersignerassociation_id: Annotated[List[Annotated[int, Field(strict=True, ge=0)]], Field(min_length=1)] = Field(alias="a_fkiEzsignfoldersignerassociationID") + __properties: ClassVar[List[str]] = ["a_fkiEzsignfoldersignerassociationID"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignfolderImportEzsignfoldersignerassociationsV1Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignfolderImportEzsignfoldersignerassociationsV1Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignfolderImportEzsignfoldersignerassociationsV1Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignfolderImportEzsignfoldersignerassociationsV1Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignfolderImportEzsignfoldersignerassociationsV1Request.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignfolderImportEzsignfoldersignerassociationsV1Request.parse_obj({ - "a_fki_ezsignfoldersignerassociation_id": obj.get("a_fkiEzsignfoldersignerassociationID") + _obj = cls.model_validate({ + "a_fkiEzsignfoldersignerassociationID": obj.get("a_fkiEzsignfoldersignerassociationID") }) return _obj diff --git a/eZmaxApi/models/ezsignfolder_import_ezsignfoldersignerassociations_v1_response.py b/eZmaxApi/models/ezsignfolder_import_ezsignfoldersignerassociations_v1_response.py index 21135fad4..461802151 100644 --- a/eZmaxApi/models/ezsignfolder_import_ezsignfoldersignerassociations_v1_response.py +++ b/eZmaxApi/models/ezsignfolder_import_ezsignfoldersignerassociations_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.ezsignfolder_import_ezsignfoldersignerassociations_v1_response_m_payload import EzsignfolderImportEzsignfoldersignerassociationsV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignfolderImportEzsignfoldersignerassociationsV1Response(BaseModel): """ - Response for POST /1/object/ezsignfolder/{pkiEzsignfolder}/importEzsignfoldersignerassociations # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzsignfolderImportEzsignfoldersignerassociationsV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for POST /1/object/ezsignfolder/{pkiEzsignfolder}/importEzsignfoldersignerassociations + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsignfolderImportEzsignfoldersignerassociationsV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignfolderImportEzsignfoldersignerassociationsV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignfolderImportEzsignfoldersignerassociationsV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignfolderImportEzsignfoldersignerassociationsV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignfolderImportEzsignfoldersignerassociationsV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignfolderImportEzsignfoldersignerassociationsV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignfolderImportEzsignfoldersignerassociationsV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzsignfolderImportEzsignfoldersignerassociationsV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsignfolderImportEzsignfoldersignerassociationsV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignfolder_import_ezsignfoldersignerassociations_v1_response_m_payload.py b/eZmaxApi/models/ezsignfolder_import_ezsignfoldersignerassociations_v1_response_m_payload.py index 8d0fcce9d..a80cfe253 100644 --- a/eZmaxApi/models/ezsignfolder_import_ezsignfoldersignerassociations_v1_response_m_payload.py +++ b/eZmaxApi/models/ezsignfolder_import_ezsignfoldersignerassociations_v1_response_m_payload.py @@ -19,53 +19,72 @@ import json -from typing import List -from pydantic import BaseModel, Field, conint, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignfolderImportEzsignfoldersignerassociationsV1ResponseMPayload(BaseModel): """ - Payload for POST /1/object/ezsignfolder/{pkiEzsignfolder}/importEzsignfoldersignerassociations # noqa: E501 - """ - a_pki_ezsignfoldersignerassociation_id: conlist(conint(strict=True, ge=0)) = Field(..., alias="a_pkiEzsignfoldersignerassociationID") - __properties = ["a_pkiEzsignfoldersignerassociationID"] + Payload for POST /1/object/ezsignfolder/{pkiEzsignfolder}/importEzsignfoldersignerassociations + """ # noqa: E501 + a_pki_ezsignfoldersignerassociation_id: List[Annotated[int, Field(strict=True, ge=0)]] = Field(alias="a_pkiEzsignfoldersignerassociationID") + __properties: ClassVar[List[str]] = ["a_pkiEzsignfoldersignerassociationID"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignfolderImportEzsignfoldersignerassociationsV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignfolderImportEzsignfoldersignerassociationsV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignfolderImportEzsignfoldersignerassociationsV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignfolderImportEzsignfoldersignerassociationsV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignfolderImportEzsignfoldersignerassociationsV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignfolderImportEzsignfoldersignerassociationsV1ResponseMPayload.parse_obj({ - "a_pki_ezsignfoldersignerassociation_id": obj.get("a_pkiEzsignfoldersignerassociationID") + _obj = cls.model_validate({ + "a_pkiEzsignfoldersignerassociationID": obj.get("a_pkiEzsignfoldersignerassociationID") }) return _obj diff --git a/eZmaxApi/models/ezsignfolder_import_ezsigntemplatepackage_v1_request.py b/eZmaxApi/models/ezsignfolder_import_ezsigntemplatepackage_v1_request.py index 488c25447..4e8c230d6 100644 --- a/eZmaxApi/models/ezsignfolder_import_ezsigntemplatepackage_v1_request.py +++ b/eZmaxApi/models/ezsignfolder_import_ezsigntemplatepackage_v1_request.py @@ -19,43 +19,62 @@ import json -from typing import List -from pydantic import BaseModel, Field, StrictStr, conint, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictStr +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.custom_import_ezsigntemplatepackage_relation_request import CustomImportEzsigntemplatepackageRelationRequest +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignfolderImportEzsigntemplatepackageV1Request(BaseModel): """ - Request for POST /1/object/ezsignfolder/{pkiEzsignfolderID}/importEzsigntemplatepackage # noqa: E501 - """ - fki_ezsigntemplatepackage_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsigntemplatepackageID", description="The unique ID of the Ezsigntemplatepackage") - dt_ezsigndocument_duedate: StrictStr = Field(..., alias="dtEzsigndocumentDuedate", description="The maximum date and time at which the Ezsigndocument can be signed.") - a_obj_import_ezsigntemplatepackage_relation: conlist(CustomImportEzsigntemplatepackageRelationRequest) = Field(..., alias="a_objImportEzsigntemplatepackageRelation") - __properties = ["fkiEzsigntemplatepackageID", "dtEzsigndocumentDuedate", "a_objImportEzsigntemplatepackageRelation"] + Request for POST /1/object/ezsignfolder/{pkiEzsignfolderID}/importEzsigntemplatepackage + """ # noqa: E501 + fki_ezsigntemplatepackage_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsigntemplatepackage", alias="fkiEzsigntemplatepackageID") + dt_ezsigndocument_duedate: StrictStr = Field(description="The maximum date and time at which the Ezsigndocument can be signed.", alias="dtEzsigndocumentDuedate") + a_obj_import_ezsigntemplatepackage_relation: List[CustomImportEzsigntemplatepackageRelationRequest] = Field(alias="a_objImportEzsigntemplatepackageRelation") + __properties: ClassVar[List[str]] = ["fkiEzsigntemplatepackageID", "dtEzsigndocumentDuedate", "a_objImportEzsigntemplatepackageRelation"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignfolderImportEzsigntemplatepackageV1Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignfolderImportEzsigntemplatepackageV1Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_import_ezsigntemplatepackage_relation (list) _items = [] if self.a_obj_import_ezsigntemplatepackage_relation: @@ -66,18 +85,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignfolderImportEzsigntemplatepackageV1Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignfolderImportEzsigntemplatepackageV1Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignfolderImportEzsigntemplatepackageV1Request.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignfolderImportEzsigntemplatepackageV1Request.parse_obj({ - "fki_ezsigntemplatepackage_id": obj.get("fkiEzsigntemplatepackageID"), - "dt_ezsigndocument_duedate": obj.get("dtEzsigndocumentDuedate"), - "a_obj_import_ezsigntemplatepackage_relation": [CustomImportEzsigntemplatepackageRelationRequest.from_dict(_item) for _item in obj.get("a_objImportEzsigntemplatepackageRelation")] if obj.get("a_objImportEzsigntemplatepackageRelation") is not None else None + _obj = cls.model_validate({ + "fkiEzsigntemplatepackageID": obj.get("fkiEzsigntemplatepackageID"), + "dtEzsigndocumentDuedate": obj.get("dtEzsigndocumentDuedate"), + "a_objImportEzsigntemplatepackageRelation": [CustomImportEzsigntemplatepackageRelationRequest.from_dict(_item) for _item in obj.get("a_objImportEzsigntemplatepackageRelation")] if obj.get("a_objImportEzsigntemplatepackageRelation") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignfolder_import_ezsigntemplatepackage_v1_response.py b/eZmaxApi/models/ezsignfolder_import_ezsigntemplatepackage_v1_response.py index 6d54b0fa8..a23185fbc 100644 --- a/eZmaxApi/models/ezsignfolder_import_ezsigntemplatepackage_v1_response.py +++ b/eZmaxApi/models/ezsignfolder_import_ezsigntemplatepackage_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.ezsignfolder_import_ezsigntemplatepackage_v1_response_m_payload import EzsignfolderImportEzsigntemplatepackageV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignfolderImportEzsigntemplatepackageV1Response(BaseModel): """ - Response for POST/1/object/ezsignfolder/{pkiEzsignfolderID}/importEzsigntemplatepackage # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzsignfolderImportEzsigntemplatepackageV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for POST/1/object/ezsignfolder/{pkiEzsignfolderID}/importEzsigntemplatepackage + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsignfolderImportEzsigntemplatepackageV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignfolderImportEzsigntemplatepackageV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignfolderImportEzsigntemplatepackageV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignfolderImportEzsigntemplatepackageV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignfolderImportEzsigntemplatepackageV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignfolderImportEzsigntemplatepackageV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignfolderImportEzsigntemplatepackageV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzsignfolderImportEzsigntemplatepackageV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsignfolderImportEzsigntemplatepackageV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignfolder_import_ezsigntemplatepackage_v1_response_m_payload.py b/eZmaxApi/models/ezsignfolder_import_ezsigntemplatepackage_v1_response_m_payload.py index 7f3a3ad93..cc58d3890 100644 --- a/eZmaxApi/models/ezsignfolder_import_ezsigntemplatepackage_v1_response_m_payload.py +++ b/eZmaxApi/models/ezsignfolder_import_ezsigntemplatepackage_v1_response_m_payload.py @@ -19,41 +19,59 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.ezsigndocument_response_compound import EzsigndocumentResponseCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignfolderImportEzsigntemplatepackageV1ResponseMPayload(BaseModel): """ - Payload for POST /1/object/ezsignfolder/{pkiEzsignfolderID}/importEzsigntemplatepackage # noqa: E501 - """ - a_obj_ezsigndocument: conlist(EzsigndocumentResponseCompound) = Field(..., alias="a_objEzsigndocument") - __properties = ["a_objEzsigndocument"] + Payload for POST /1/object/ezsignfolder/{pkiEzsignfolderID}/importEzsigntemplatepackage + """ # noqa: E501 + a_obj_ezsigndocument: List[EzsigndocumentResponseCompound] = Field(alias="a_objEzsigndocument") + __properties: ClassVar[List[str]] = ["a_objEzsigndocument"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignfolderImportEzsigntemplatepackageV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignfolderImportEzsigntemplatepackageV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_ezsigndocument (list) _items = [] if self.a_obj_ezsigndocument: @@ -64,16 +82,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignfolderImportEzsigntemplatepackageV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignfolderImportEzsigntemplatepackageV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignfolderImportEzsigntemplatepackageV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignfolderImportEzsigntemplatepackageV1ResponseMPayload.parse_obj({ - "a_obj_ezsigndocument": [EzsigndocumentResponseCompound.from_dict(_item) for _item in obj.get("a_objEzsigndocument")] if obj.get("a_objEzsigndocument") is not None else None + _obj = cls.model_validate({ + "a_objEzsigndocument": [EzsigndocumentResponseCompound.from_dict(_item) for _item in obj.get("a_objEzsigndocument")] if obj.get("a_objEzsigndocument") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignfolder_list_element.py b/eZmaxApi/models/ezsignfolder_list_element.py index da3e1a9c5..612586d12 100644 --- a/eZmaxApi/models/ezsignfolder_list_element.py +++ b/eZmaxApi/models/ezsignfolder_list_element.py @@ -19,79 +19,98 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictInt, StrictStr, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictInt, StrictStr +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.field_e_ezsignfolder_step import FieldEEzsignfolderStep from eZmaxApi.models.field_e_ezsignfoldertype_privacylevel import FieldEEzsignfoldertypePrivacylevel +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignfolderListElement(BaseModel): """ - An Ezsignfolder List Element # noqa: E501 - """ - pki_ezsignfolder_id: conint(strict=True, ge=0) = Field(..., alias="pkiEzsignfolderID", description="The unique ID of the Ezsignfolder") - fki_ezsignfoldertype_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsignfoldertypeID", description="The unique ID of the Ezsignfoldertype.") - e_ezsignfoldertype_privacylevel: FieldEEzsignfoldertypePrivacylevel = Field(..., alias="eEzsignfoldertypePrivacylevel") - s_ezsignfoldertype_name_x: StrictStr = Field(..., alias="sEzsignfoldertypeNameX", description="The name of the Ezsignfoldertype in the language of the requester") - s_ezsignfolder_description: StrictStr = Field(..., alias="sEzsignfolderDescription", description="The description of the Ezsignfolder") - e_ezsignfolder_step: FieldEEzsignfolderStep = Field(..., alias="eEzsignfolderStep") - dt_created_date: StrictStr = Field(..., alias="dtCreatedDate", description="The date and time at which the object was created") - dt_ezsignfolder_sentdate: Optional[StrictStr] = Field(None, alias="dtEzsignfolderSentdate", description="The date and time at which the Ezsignfolder was sent the last time.") - dt_ezsignfolder_duedate: Optional[StrictStr] = Field(None, alias="dtEzsignfolderDuedate", description="The maximum date and time at which the Ezsignfolder can be signed.") - i_ezsigndocument: StrictInt = Field(..., alias="iEzsigndocument", description="The total number of Ezsigndocument in the folder") - i_ezsigndocument_edm: StrictInt = Field(..., alias="iEzsigndocumentEdm", description="The total number of Ezsigndocument in the folder that were saved in the edm system") - i_ezsignsignature: StrictInt = Field(..., alias="iEzsignsignature", description="The total number of signature blocks in all Ezsigndocuments in the folder") - i_ezsignsignature_signed: StrictInt = Field(..., alias="iEzsignsignatureSigned", description="The total number of already signed signature blocks in all Ezsigndocuments in the folder") - __properties = ["pkiEzsignfolderID", "fkiEzsignfoldertypeID", "eEzsignfoldertypePrivacylevel", "sEzsignfoldertypeNameX", "sEzsignfolderDescription", "eEzsignfolderStep", "dtCreatedDate", "dtEzsignfolderSentdate", "dtEzsignfolderDuedate", "iEzsigndocument", "iEzsigndocumentEdm", "iEzsignsignature", "iEzsignsignatureSigned"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + An Ezsignfolder List Element + """ # noqa: E501 + pki_ezsignfolder_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsignfolder", alias="pkiEzsignfolderID") + fki_ezsignfoldertype_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsignfoldertype.", alias="fkiEzsignfoldertypeID") + e_ezsignfoldertype_privacylevel: FieldEEzsignfoldertypePrivacylevel = Field(alias="eEzsignfoldertypePrivacylevel") + s_ezsignfoldertype_name_x: StrictStr = Field(description="The name of the Ezsignfoldertype in the language of the requester", alias="sEzsignfoldertypeNameX") + s_ezsignfolder_description: StrictStr = Field(description="The description of the Ezsignfolder", alias="sEzsignfolderDescription") + e_ezsignfolder_step: FieldEEzsignfolderStep = Field(alias="eEzsignfolderStep") + dt_created_date: StrictStr = Field(description="The date and time at which the object was created", alias="dtCreatedDate") + dt_ezsignfolder_sentdate: Optional[StrictStr] = Field(default=None, description="The date and time at which the Ezsignfolder was sent the last time.", alias="dtEzsignfolderSentdate") + dt_ezsignfolder_duedate: Optional[StrictStr] = Field(default=None, description="The maximum date and time at which the Ezsignfolder can be signed.", alias="dtEzsignfolderDuedate") + i_ezsigndocument: StrictInt = Field(description="The total number of Ezsigndocument in the folder", alias="iEzsigndocument") + i_ezsigndocument_edm: StrictInt = Field(description="The total number of Ezsigndocument in the folder that were saved in the edm system", alias="iEzsigndocumentEdm") + i_ezsignsignature: StrictInt = Field(description="The total number of signature blocks in all Ezsigndocuments in the folder", alias="iEzsignsignature") + i_ezsignsignature_signed: StrictInt = Field(description="The total number of already signed signature blocks in all Ezsigndocuments in the folder", alias="iEzsignsignatureSigned") + __properties: ClassVar[List[str]] = ["pkiEzsignfolderID", "fkiEzsignfoldertypeID", "eEzsignfoldertypePrivacylevel", "sEzsignfoldertypeNameX", "sEzsignfolderDescription", "eEzsignfolderStep", "dtCreatedDate", "dtEzsignfolderSentdate", "dtEzsignfolderDuedate", "iEzsigndocument", "iEzsigndocumentEdm", "iEzsignsignature", "iEzsignsignatureSigned"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignfolderListElement: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignfolderListElement from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignfolderListElement: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignfolderListElement from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignfolderListElement.parse_obj(obj) - - _obj = EzsignfolderListElement.parse_obj({ - "pki_ezsignfolder_id": obj.get("pkiEzsignfolderID"), - "fki_ezsignfoldertype_id": obj.get("fkiEzsignfoldertypeID"), - "e_ezsignfoldertype_privacylevel": obj.get("eEzsignfoldertypePrivacylevel"), - "s_ezsignfoldertype_name_x": obj.get("sEzsignfoldertypeNameX"), - "s_ezsignfolder_description": obj.get("sEzsignfolderDescription"), - "e_ezsignfolder_step": obj.get("eEzsignfolderStep"), - "dt_created_date": obj.get("dtCreatedDate"), - "dt_ezsignfolder_sentdate": obj.get("dtEzsignfolderSentdate"), - "dt_ezsignfolder_duedate": obj.get("dtEzsignfolderDuedate"), - "i_ezsigndocument": obj.get("iEzsigndocument"), - "i_ezsigndocument_edm": obj.get("iEzsigndocumentEdm"), - "i_ezsignsignature": obj.get("iEzsignsignature"), - "i_ezsignsignature_signed": obj.get("iEzsignsignatureSigned") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsignfolderID": obj.get("pkiEzsignfolderID"), + "fkiEzsignfoldertypeID": obj.get("fkiEzsignfoldertypeID"), + "eEzsignfoldertypePrivacylevel": obj.get("eEzsignfoldertypePrivacylevel"), + "sEzsignfoldertypeNameX": obj.get("sEzsignfoldertypeNameX"), + "sEzsignfolderDescription": obj.get("sEzsignfolderDescription"), + "eEzsignfolderStep": obj.get("eEzsignfolderStep"), + "dtCreatedDate": obj.get("dtCreatedDate"), + "dtEzsignfolderSentdate": obj.get("dtEzsignfolderSentdate"), + "dtEzsignfolderDuedate": obj.get("dtEzsignfolderDuedate"), + "iEzsigndocument": obj.get("iEzsigndocument"), + "iEzsigndocumentEdm": obj.get("iEzsigndocumentEdm"), + "iEzsignsignature": obj.get("iEzsignsignature"), + "iEzsignsignatureSigned": obj.get("iEzsignsignatureSigned") }) return _obj diff --git a/eZmaxApi/models/ezsignfolder_reorder_v1_request.py b/eZmaxApi/models/ezsignfolder_reorder_v1_request.py index 0696310b5..f05c803d8 100644 --- a/eZmaxApi/models/ezsignfolder_reorder_v1_request.py +++ b/eZmaxApi/models/ezsignfolder_reorder_v1_request.py @@ -19,53 +19,72 @@ import json -from typing import List -from pydantic import BaseModel, Field, conint, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignfolderReorderV1Request(BaseModel): """ - Request for POST /1/object/ezsignfolder/{pkiEzsignfolderID}/reorder # noqa: E501 - """ - a_pki_ezsigndocument_id: conlist(conint(strict=True, ge=0), min_items=1) = Field(..., alias="a_pkiEzsigndocumentID") - __properties = ["a_pkiEzsigndocumentID"] + Request for POST /1/object/ezsignfolder/{pkiEzsignfolderID}/reorder + """ # noqa: E501 + a_pki_ezsigndocument_id: Annotated[List[Annotated[int, Field(strict=True, ge=0)]], Field(min_length=1)] = Field(alias="a_pkiEzsigndocumentID") + __properties: ClassVar[List[str]] = ["a_pkiEzsigndocumentID"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignfolderReorderV1Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignfolderReorderV1Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignfolderReorderV1Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignfolderReorderV1Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignfolderReorderV1Request.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignfolderReorderV1Request.parse_obj({ - "a_pki_ezsigndocument_id": obj.get("a_pkiEzsigndocumentID") + _obj = cls.model_validate({ + "a_pkiEzsigndocumentID": obj.get("a_pkiEzsigndocumentID") }) return _obj diff --git a/eZmaxApi/models/ezsignfolder_reorder_v1_response.py b/eZmaxApi/models/ezsignfolder_reorder_v1_response.py index cc793ae66..b51294bdb 100644 --- a/eZmaxApi/models/ezsignfolder_reorder_v1_response.py +++ b/eZmaxApi/models/ezsignfolder_reorder_v1_response.py @@ -19,43 +19,61 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignfolderReorderV1Response(BaseModel): """ - Response for POST /1/object/ezsignfolder/{pkiEzsignfolderID}/reorder # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - __properties = ["objDebugPayload", "objDebug"] + Response for POST /1/object/ezsignfolder/{pkiEzsignfolderID}/reorder + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignfolderReorderV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignfolderReorderV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -65,17 +83,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignfolderReorderV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignfolderReorderV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignfolderReorderV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignfolderReorderV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignfolder_request.py b/eZmaxApi/models/ezsignfolder_request.py index 0adb8a895..6c8d7c30d 100644 --- a/eZmaxApi/models/ezsignfolder_request.py +++ b/eZmaxApi/models/ezsignfolder_request.py @@ -19,24 +19,30 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictStr, conint, constr, validator +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictStr, field_validator +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.field_e_ezsignfolder_sendreminderfrequency import FieldEEzsignfolderSendreminderfrequency +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignfolderRequest(BaseModel): """ - An Ezsignfolder Object # noqa: E501 - """ - pki_ezsignfolder_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="pkiEzsignfolderID", description="The unique ID of the Ezsignfolder") - fki_ezsignfoldertype_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsignfoldertypeID", description="The unique ID of the Ezsignfoldertype.") - fki_ezsigntsarequirement_id: Optional[conint(strict=True, le=3, ge=1)] = Field(None, alias="fkiEzsigntsarequirementID", description="The unique ID of the Ezsigntsarequirement. Determine if a Time Stamping Authority should add a timestamp on each of the signature. Valid values: |Value|Description| |-|-| |1|No. TSA Timestamping will requested. This will make all signatures a lot faster since no round-trip to the TSA server will be required. Timestamping will be made using eZsign server's time.| |2|Best effort. Timestamping from a Time Stamping Authority will be requested but is not mandatory. In the very improbable case it cannot be completed, the timestamping will be made using eZsign server's time. **Additional fee applies**| |3|Mandatory. Timestamping from a Time Stamping Authority will be requested and is mandatory. In the very improbable case it cannot be completed, the signature will fail and the user will be asked to retry. **Additional fee applies**|") - s_ezsignfolder_description: StrictStr = Field(..., alias="sEzsignfolderDescription", description="The description of the Ezsignfolder") - t_ezsignfolder_note: Optional[StrictStr] = Field(None, alias="tEzsignfolderNote", description="Note about the Ezsignfolder") - e_ezsignfolder_sendreminderfrequency: FieldEEzsignfolderSendreminderfrequency = Field(..., alias="eEzsignfolderSendreminderfrequency") - s_ezsignfolder_externalid: Optional[constr(strict=True)] = Field(None, alias="sEzsignfolderExternalid", description="This field can be used to store an External ID from the client's system. Anything can be stored in this field, it will never be evaluated by the eZmax system and will be returned AS-IS. To store multiple values, consider using a JSON formatted structure, a URL encoded string, a CSV or any other custom format. ") - __properties = ["pkiEzsignfolderID", "fkiEzsignfoldertypeID", "fkiEzsigntsarequirementID", "sEzsignfolderDescription", "tEzsignfolderNote", "eEzsignfolderSendreminderfrequency", "sEzsignfolderExternalid"] - - @validator('s_ezsignfolder_externalid') + An Ezsignfolder Object + """ # noqa: E501 + pki_ezsignfolder_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsignfolder", alias="pkiEzsignfolderID") + fki_ezsignfoldertype_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsignfoldertype.", alias="fkiEzsignfoldertypeID") + fki_ezsigntsarequirement_id: Optional[Annotated[int, Field(le=3, strict=True, ge=1)]] = Field(default=None, description="The unique ID of the Ezsigntsarequirement. Determine if a Time Stamping Authority should add a timestamp on each of the signature. Valid values: |Value|Description| |-|-| |1|No. TSA Timestamping will requested. This will make all signatures a lot faster since no round-trip to the TSA server will be required. Timestamping will be made using eZsign server's time.| |2|Best effort. Timestamping from a Time Stamping Authority will be requested but is not mandatory. In the very improbable case it cannot be completed, the timestamping will be made using eZsign server's time. **Additional fee applies**| |3|Mandatory. Timestamping from a Time Stamping Authority will be requested and is mandatory. In the very improbable case it cannot be completed, the signature will fail and the user will be asked to retry. **Additional fee applies**|", alias="fkiEzsigntsarequirementID") + s_ezsignfolder_description: StrictStr = Field(description="The description of the Ezsignfolder", alias="sEzsignfolderDescription") + t_ezsignfolder_note: Optional[StrictStr] = Field(default=None, description="Note about the Ezsignfolder", alias="tEzsignfolderNote") + e_ezsignfolder_sendreminderfrequency: FieldEEzsignfolderSendreminderfrequency = Field(alias="eEzsignfolderSendreminderfrequency") + s_ezsignfolder_externalid: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="This field can be used to store an External ID from the client's system. Anything can be stored in this field, it will never be evaluated by the eZmax system and will be returned AS-IS. To store multiple values, consider using a JSON formatted structure, a URL encoded string, a CSV or any other custom format. ", alias="sEzsignfolderExternalid") + __properties: ClassVar[List[str]] = ["pkiEzsignfolderID", "fkiEzsignfoldertypeID", "fkiEzsigntsarequirementID", "sEzsignfolderDescription", "tEzsignfolderNote", "eEzsignfolderSendreminderfrequency", "sEzsignfolderExternalid"] + + @field_validator('s_ezsignfolder_externalid') def s_ezsignfolder_externalid_validate_regular_expression(cls, value): """Validates the regular expression""" if value is None: @@ -46,49 +52,62 @@ def s_ezsignfolder_externalid_validate_regular_expression(cls, value): raise ValueError(r"must validate the regular expression /^.{0,64}$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignfolderRequest: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignfolderRequest from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignfolderRequest: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignfolderRequest from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignfolderRequest.parse_obj(obj) - - _obj = EzsignfolderRequest.parse_obj({ - "pki_ezsignfolder_id": obj.get("pkiEzsignfolderID"), - "fki_ezsignfoldertype_id": obj.get("fkiEzsignfoldertypeID"), - "fki_ezsigntsarequirement_id": obj.get("fkiEzsigntsarequirementID"), - "s_ezsignfolder_description": obj.get("sEzsignfolderDescription"), - "t_ezsignfolder_note": obj.get("tEzsignfolderNote"), - "e_ezsignfolder_sendreminderfrequency": obj.get("eEzsignfolderSendreminderfrequency"), - "s_ezsignfolder_externalid": obj.get("sEzsignfolderExternalid") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsignfolderID": obj.get("pkiEzsignfolderID"), + "fkiEzsignfoldertypeID": obj.get("fkiEzsignfoldertypeID"), + "fkiEzsigntsarequirementID": obj.get("fkiEzsigntsarequirementID"), + "sEzsignfolderDescription": obj.get("sEzsignfolderDescription"), + "tEzsignfolderNote": obj.get("tEzsignfolderNote"), + "eEzsignfolderSendreminderfrequency": obj.get("eEzsignfolderSendreminderfrequency"), + "sEzsignfolderExternalid": obj.get("sEzsignfolderExternalid") }) return _obj diff --git a/eZmaxApi/models/ezsignfolder_request_compound.py b/eZmaxApi/models/ezsignfolder_request_compound.py index c3856b4e3..f3ecb744f 100644 --- a/eZmaxApi/models/ezsignfolder_request_compound.py +++ b/eZmaxApi/models/ezsignfolder_request_compound.py @@ -19,24 +19,30 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictStr, conint, constr, validator +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictStr, field_validator +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.field_e_ezsignfolder_sendreminderfrequency import FieldEEzsignfolderSendreminderfrequency +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignfolderRequestCompound(BaseModel): """ - An Ezsignfolder Object and children to create a complete structure # noqa: E501 - """ - pki_ezsignfolder_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="pkiEzsignfolderID", description="The unique ID of the Ezsignfolder") - fki_ezsignfoldertype_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsignfoldertypeID", description="The unique ID of the Ezsignfoldertype.") - fki_ezsigntsarequirement_id: Optional[conint(strict=True, le=3, ge=1)] = Field(None, alias="fkiEzsigntsarequirementID", description="The unique ID of the Ezsigntsarequirement. Determine if a Time Stamping Authority should add a timestamp on each of the signature. Valid values: |Value|Description| |-|-| |1|No. TSA Timestamping will requested. This will make all signatures a lot faster since no round-trip to the TSA server will be required. Timestamping will be made using eZsign server's time.| |2|Best effort. Timestamping from a Time Stamping Authority will be requested but is not mandatory. In the very improbable case it cannot be completed, the timestamping will be made using eZsign server's time. **Additional fee applies**| |3|Mandatory. Timestamping from a Time Stamping Authority will be requested and is mandatory. In the very improbable case it cannot be completed, the signature will fail and the user will be asked to retry. **Additional fee applies**|") - s_ezsignfolder_description: StrictStr = Field(..., alias="sEzsignfolderDescription", description="The description of the Ezsignfolder") - t_ezsignfolder_note: Optional[StrictStr] = Field(None, alias="tEzsignfolderNote", description="Note about the Ezsignfolder") - e_ezsignfolder_sendreminderfrequency: FieldEEzsignfolderSendreminderfrequency = Field(..., alias="eEzsignfolderSendreminderfrequency") - s_ezsignfolder_externalid: Optional[constr(strict=True)] = Field(None, alias="sEzsignfolderExternalid", description="This field can be used to store an External ID from the client's system. Anything can be stored in this field, it will never be evaluated by the eZmax system and will be returned AS-IS. To store multiple values, consider using a JSON formatted structure, a URL encoded string, a CSV or any other custom format. ") - __properties = ["pkiEzsignfolderID", "fkiEzsignfoldertypeID", "fkiEzsigntsarequirementID", "sEzsignfolderDescription", "tEzsignfolderNote", "eEzsignfolderSendreminderfrequency", "sEzsignfolderExternalid"] - - @validator('s_ezsignfolder_externalid') + An Ezsignfolder Object and children to create a complete structure + """ # noqa: E501 + pki_ezsignfolder_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsignfolder", alias="pkiEzsignfolderID") + fki_ezsignfoldertype_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsignfoldertype.", alias="fkiEzsignfoldertypeID") + fki_ezsigntsarequirement_id: Optional[Annotated[int, Field(le=3, strict=True, ge=1)]] = Field(default=None, description="The unique ID of the Ezsigntsarequirement. Determine if a Time Stamping Authority should add a timestamp on each of the signature. Valid values: |Value|Description| |-|-| |1|No. TSA Timestamping will requested. This will make all signatures a lot faster since no round-trip to the TSA server will be required. Timestamping will be made using eZsign server's time.| |2|Best effort. Timestamping from a Time Stamping Authority will be requested but is not mandatory. In the very improbable case it cannot be completed, the timestamping will be made using eZsign server's time. **Additional fee applies**| |3|Mandatory. Timestamping from a Time Stamping Authority will be requested and is mandatory. In the very improbable case it cannot be completed, the signature will fail and the user will be asked to retry. **Additional fee applies**|", alias="fkiEzsigntsarequirementID") + s_ezsignfolder_description: StrictStr = Field(description="The description of the Ezsignfolder", alias="sEzsignfolderDescription") + t_ezsignfolder_note: Optional[StrictStr] = Field(default=None, description="Note about the Ezsignfolder", alias="tEzsignfolderNote") + e_ezsignfolder_sendreminderfrequency: FieldEEzsignfolderSendreminderfrequency = Field(alias="eEzsignfolderSendreminderfrequency") + s_ezsignfolder_externalid: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="This field can be used to store an External ID from the client's system. Anything can be stored in this field, it will never be evaluated by the eZmax system and will be returned AS-IS. To store multiple values, consider using a JSON formatted structure, a URL encoded string, a CSV or any other custom format. ", alias="sEzsignfolderExternalid") + __properties: ClassVar[List[str]] = ["pkiEzsignfolderID", "fkiEzsignfoldertypeID", "fkiEzsigntsarequirementID", "sEzsignfolderDescription", "tEzsignfolderNote", "eEzsignfolderSendreminderfrequency", "sEzsignfolderExternalid"] + + @field_validator('s_ezsignfolder_externalid') def s_ezsignfolder_externalid_validate_regular_expression(cls, value): """Validates the regular expression""" if value is None: @@ -46,49 +52,62 @@ def s_ezsignfolder_externalid_validate_regular_expression(cls, value): raise ValueError(r"must validate the regular expression /^.{0,64}$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignfolderRequestCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignfolderRequestCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignfolderRequestCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignfolderRequestCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignfolderRequestCompound.parse_obj(obj) - - _obj = EzsignfolderRequestCompound.parse_obj({ - "pki_ezsignfolder_id": obj.get("pkiEzsignfolderID"), - "fki_ezsignfoldertype_id": obj.get("fkiEzsignfoldertypeID"), - "fki_ezsigntsarequirement_id": obj.get("fkiEzsigntsarequirementID"), - "s_ezsignfolder_description": obj.get("sEzsignfolderDescription"), - "t_ezsignfolder_note": obj.get("tEzsignfolderNote"), - "e_ezsignfolder_sendreminderfrequency": obj.get("eEzsignfolderSendreminderfrequency"), - "s_ezsignfolder_externalid": obj.get("sEzsignfolderExternalid") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsignfolderID": obj.get("pkiEzsignfolderID"), + "fkiEzsignfoldertypeID": obj.get("fkiEzsignfoldertypeID"), + "fkiEzsigntsarequirementID": obj.get("fkiEzsigntsarequirementID"), + "sEzsignfolderDescription": obj.get("sEzsignfolderDescription"), + "tEzsignfolderNote": obj.get("tEzsignfolderNote"), + "eEzsignfolderSendreminderfrequency": obj.get("eEzsignfolderSendreminderfrequency"), + "sEzsignfolderExternalid": obj.get("sEzsignfolderExternalid") }) return _obj diff --git a/eZmaxApi/models/ezsignfolder_response.py b/eZmaxApi/models/ezsignfolder_response.py index 504609f16..81177f3ed 100644 --- a/eZmaxApi/models/ezsignfolder_response.py +++ b/eZmaxApi/models/ezsignfolder_response.py @@ -19,42 +19,48 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint, constr, validator +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, StrictStr, field_validator +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.common_audit import CommonAudit from eZmaxApi.models.custom_ezsignfoldertype_response import CustomEzsignfoldertypeResponse from eZmaxApi.models.field_e_ezsignfolder_sendreminderfrequency import FieldEEzsignfolderSendreminderfrequency from eZmaxApi.models.field_e_ezsignfolder_step import FieldEEzsignfolderStep +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignfolderResponse(BaseModel): """ - An Ezsignfolder Object # noqa: E501 - """ - pki_ezsignfolder_id: conint(strict=True, ge=0) = Field(..., alias="pkiEzsignfolderID", description="The unique ID of the Ezsignfolder") - fki_ezsignfoldertype_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiEzsignfoldertypeID", description="The unique ID of the Ezsignfoldertype.") - obj_ezsignfoldertype: Optional[CustomEzsignfoldertypeResponse] = Field(None, alias="objEzsignfoldertype") - s_ezsignfoldertype_name_x: Optional[StrictStr] = Field(None, alias="sEzsignfoldertypeNameX") - fki_billingentityinternal_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiBillingentityinternalID", description="The unique ID of the Billingentityinternal.") - s_billingentityinternal_description_x: Optional[StrictStr] = Field(None, alias="sBillingentityinternalDescriptionX", description="The description of the Billingentityinternal in the language of the requester") - fki_ezsigntsarequirement_id: Optional[conint(strict=True, le=3, ge=1)] = Field(None, alias="fkiEzsigntsarequirementID", description="The unique ID of the Ezsigntsarequirement. Determine if a Time Stamping Authority should add a timestamp on each of the signature. Valid values: |Value|Description| |-|-| |1|No. TSA Timestamping will requested. This will make all signatures a lot faster since no round-trip to the TSA server will be required. Timestamping will be made using eZsign server's time.| |2|Best effort. Timestamping from a Time Stamping Authority will be requested but is not mandatory. In the very improbable case it cannot be completed, the timestamping will be made using eZsign server's time. **Additional fee applies**| |3|Mandatory. Timestamping from a Time Stamping Authority will be requested and is mandatory. In the very improbable case it cannot be completed, the signature will fail and the user will be asked to retry. **Additional fee applies**|") - s_ezsigntsarequirement_description_x: Optional[StrictStr] = Field(None, alias="sEzsigntsarequirementDescriptionX", description="The description of the Ezsigntsarequirement in the language of the requester") - s_ezsignfolder_description: StrictStr = Field(..., alias="sEzsignfolderDescription", description="The description of the Ezsignfolder") - t_ezsignfolder_note: Optional[StrictStr] = Field(None, alias="tEzsignfolderNote", description="Note about the Ezsignfolder") - b_ezsignfolder_isdisposable: Optional[StrictBool] = Field(None, alias="bEzsignfolderIsdisposable", description="If the Ezsigndocument can be disposed") - e_ezsignfolder_sendreminderfrequency: Optional[FieldEEzsignfolderSendreminderfrequency] = Field(None, alias="eEzsignfolderSendreminderfrequency") - dt_ezsignfolder_delayedsenddate: Optional[StrictStr] = Field(None, alias="dtEzsignfolderDelayedsenddate", description="The date and time at which the Ezsignfolder will be sent in the future.") - dt_ezsignfolder_duedate: Optional[StrictStr] = Field(None, alias="dtEzsignfolderDuedate", description="The maximum date and time at which the Ezsignfolder can be signed.") - dt_ezsignfolder_sentdate: Optional[StrictStr] = Field(None, alias="dtEzsignfolderSentdate", description="The date and time at which the Ezsignfolder was sent the last time.") - dt_ezsignfolder_scheduledarchive: Optional[StrictStr] = Field(None, alias="dtEzsignfolderScheduledarchive", description="The scheduled date and time at which the Ezsignfolder should be archived.") - dt_ezsignfolder_scheduleddispose: Optional[StrictStr] = Field(None, alias="dtEzsignfolderScheduleddispose", description="The scheduled date at which the Ezsignfolder should be Disposed.") - e_ezsignfolder_step: Optional[FieldEEzsignfolderStep] = Field(None, alias="eEzsignfolderStep") - dt_ezsignfolder_close: Optional[StrictStr] = Field(None, alias="dtEzsignfolderClose", description="The date and time at which the Ezsignfolder was closed. Either by applying the last signature or by completing it prematurely.") - t_ezsignfolder_message: Optional[StrictStr] = Field(None, alias="tEzsignfolderMessage", description="A custom text message that will be added to the email sent.") - obj_audit: Optional[CommonAudit] = Field(None, alias="objAudit") - s_ezsignfolder_externalid: Optional[constr(strict=True)] = Field(None, alias="sEzsignfolderExternalid", description="This field can be used to store an External ID from the client's system. Anything can be stored in this field, it will never be evaluated by the eZmax system and will be returned AS-IS. To store multiple values, consider using a JSON formatted structure, a URL encoded string, a CSV or any other custom format. ") - __properties = ["pkiEzsignfolderID", "fkiEzsignfoldertypeID", "objEzsignfoldertype", "sEzsignfoldertypeNameX", "fkiBillingentityinternalID", "sBillingentityinternalDescriptionX", "fkiEzsigntsarequirementID", "sEzsigntsarequirementDescriptionX", "sEzsignfolderDescription", "tEzsignfolderNote", "bEzsignfolderIsdisposable", "eEzsignfolderSendreminderfrequency", "dtEzsignfolderDelayedsenddate", "dtEzsignfolderDuedate", "dtEzsignfolderSentdate", "dtEzsignfolderScheduledarchive", "dtEzsignfolderScheduleddispose", "eEzsignfolderStep", "dtEzsignfolderClose", "tEzsignfolderMessage", "objAudit", "sEzsignfolderExternalid"] - - @validator('s_ezsignfolder_externalid') + An Ezsignfolder Object + """ # noqa: E501 + pki_ezsignfolder_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsignfolder", alias="pkiEzsignfolderID") + fki_ezsignfoldertype_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsignfoldertype.", alias="fkiEzsignfoldertypeID") + obj_ezsignfoldertype: Optional[CustomEzsignfoldertypeResponse] = Field(default=None, alias="objEzsignfoldertype") + s_ezsignfoldertype_name_x: Optional[StrictStr] = Field(default=None, alias="sEzsignfoldertypeNameX") + fki_billingentityinternal_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Billingentityinternal.", alias="fkiBillingentityinternalID") + s_billingentityinternal_description_x: Optional[StrictStr] = Field(default=None, description="The description of the Billingentityinternal in the language of the requester", alias="sBillingentityinternalDescriptionX") + fki_ezsigntsarequirement_id: Optional[Annotated[int, Field(le=3, strict=True, ge=1)]] = Field(default=None, description="The unique ID of the Ezsigntsarequirement. Determine if a Time Stamping Authority should add a timestamp on each of the signature. Valid values: |Value|Description| |-|-| |1|No. TSA Timestamping will requested. This will make all signatures a lot faster since no round-trip to the TSA server will be required. Timestamping will be made using eZsign server's time.| |2|Best effort. Timestamping from a Time Stamping Authority will be requested but is not mandatory. In the very improbable case it cannot be completed, the timestamping will be made using eZsign server's time. **Additional fee applies**| |3|Mandatory. Timestamping from a Time Stamping Authority will be requested and is mandatory. In the very improbable case it cannot be completed, the signature will fail and the user will be asked to retry. **Additional fee applies**|", alias="fkiEzsigntsarequirementID") + s_ezsigntsarequirement_description_x: Optional[StrictStr] = Field(default=None, description="The description of the Ezsigntsarequirement in the language of the requester", alias="sEzsigntsarequirementDescriptionX") + s_ezsignfolder_description: StrictStr = Field(description="The description of the Ezsignfolder", alias="sEzsignfolderDescription") + t_ezsignfolder_note: Optional[StrictStr] = Field(default=None, description="Note about the Ezsignfolder", alias="tEzsignfolderNote") + b_ezsignfolder_isdisposable: Optional[StrictBool] = Field(default=None, description="If the Ezsigndocument can be disposed", alias="bEzsignfolderIsdisposable") + e_ezsignfolder_sendreminderfrequency: Optional[FieldEEzsignfolderSendreminderfrequency] = Field(default=None, alias="eEzsignfolderSendreminderfrequency") + dt_ezsignfolder_delayedsenddate: Optional[StrictStr] = Field(default=None, description="The date and time at which the Ezsignfolder will be sent in the future.", alias="dtEzsignfolderDelayedsenddate") + dt_ezsignfolder_duedate: Optional[StrictStr] = Field(default=None, description="The maximum date and time at which the Ezsignfolder can be signed.", alias="dtEzsignfolderDuedate") + dt_ezsignfolder_sentdate: Optional[StrictStr] = Field(default=None, description="The date and time at which the Ezsignfolder was sent the last time.", alias="dtEzsignfolderSentdate") + dt_ezsignfolder_scheduledarchive: Optional[StrictStr] = Field(default=None, description="The scheduled date and time at which the Ezsignfolder should be archived.", alias="dtEzsignfolderScheduledarchive") + dt_ezsignfolder_scheduleddispose: Optional[StrictStr] = Field(default=None, description="The scheduled date at which the Ezsignfolder should be Disposed.", alias="dtEzsignfolderScheduleddispose") + e_ezsignfolder_step: Optional[FieldEEzsignfolderStep] = Field(default=None, alias="eEzsignfolderStep") + dt_ezsignfolder_close: Optional[StrictStr] = Field(default=None, description="The date and time at which the Ezsignfolder was closed. Either by applying the last signature or by completing it prematurely.", alias="dtEzsignfolderClose") + t_ezsignfolder_message: Optional[StrictStr] = Field(default=None, description="A custom text message that will be added to the email sent.", alias="tEzsignfolderMessage") + obj_audit: Optional[CommonAudit] = Field(default=None, alias="objAudit") + s_ezsignfolder_externalid: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="This field can be used to store an External ID from the client's system. Anything can be stored in this field, it will never be evaluated by the eZmax system and will be returned AS-IS. To store multiple values, consider using a JSON formatted structure, a URL encoded string, a CSV or any other custom format. ", alias="sEzsignfolderExternalid") + __properties: ClassVar[List[str]] = ["pkiEzsignfolderID", "fkiEzsignfoldertypeID", "objEzsignfoldertype", "sEzsignfoldertypeNameX", "fkiBillingentityinternalID", "sBillingentityinternalDescriptionX", "fkiEzsigntsarequirementID", "sEzsigntsarequirementDescriptionX", "sEzsignfolderDescription", "tEzsignfolderNote", "bEzsignfolderIsdisposable", "eEzsignfolderSendreminderfrequency", "dtEzsignfolderDelayedsenddate", "dtEzsignfolderDuedate", "dtEzsignfolderSentdate", "dtEzsignfolderScheduledarchive", "dtEzsignfolderScheduleddispose", "eEzsignfolderStep", "dtEzsignfolderClose", "tEzsignfolderMessage", "objAudit", "sEzsignfolderExternalid"] + + @field_validator('s_ezsignfolder_externalid') def s_ezsignfolder_externalid_validate_regular_expression(cls, value): """Validates the regular expression""" if value is None: @@ -64,30 +70,43 @@ def s_ezsignfolder_externalid_validate_regular_expression(cls, value): raise ValueError(r"must validate the regular expression /^.{0,64}$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignfolderResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignfolderResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_ezsignfoldertype if self.obj_ezsignfoldertype: _dict['objEzsignfoldertype'] = self.obj_ezsignfoldertype.to_dict() @@ -97,37 +116,37 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignfolderResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignfolderResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignfolderResponse.parse_obj(obj) - - _obj = EzsignfolderResponse.parse_obj({ - "pki_ezsignfolder_id": obj.get("pkiEzsignfolderID"), - "fki_ezsignfoldertype_id": obj.get("fkiEzsignfoldertypeID"), - "obj_ezsignfoldertype": CustomEzsignfoldertypeResponse.from_dict(obj.get("objEzsignfoldertype")) if obj.get("objEzsignfoldertype") is not None else None, - "s_ezsignfoldertype_name_x": obj.get("sEzsignfoldertypeNameX"), - "fki_billingentityinternal_id": obj.get("fkiBillingentityinternalID"), - "s_billingentityinternal_description_x": obj.get("sBillingentityinternalDescriptionX"), - "fki_ezsigntsarequirement_id": obj.get("fkiEzsigntsarequirementID"), - "s_ezsigntsarequirement_description_x": obj.get("sEzsigntsarequirementDescriptionX"), - "s_ezsignfolder_description": obj.get("sEzsignfolderDescription"), - "t_ezsignfolder_note": obj.get("tEzsignfolderNote"), - "b_ezsignfolder_isdisposable": obj.get("bEzsignfolderIsdisposable"), - "e_ezsignfolder_sendreminderfrequency": obj.get("eEzsignfolderSendreminderfrequency"), - "dt_ezsignfolder_delayedsenddate": obj.get("dtEzsignfolderDelayedsenddate"), - "dt_ezsignfolder_duedate": obj.get("dtEzsignfolderDuedate"), - "dt_ezsignfolder_sentdate": obj.get("dtEzsignfolderSentdate"), - "dt_ezsignfolder_scheduledarchive": obj.get("dtEzsignfolderScheduledarchive"), - "dt_ezsignfolder_scheduleddispose": obj.get("dtEzsignfolderScheduleddispose"), - "e_ezsignfolder_step": obj.get("eEzsignfolderStep"), - "dt_ezsignfolder_close": obj.get("dtEzsignfolderClose"), - "t_ezsignfolder_message": obj.get("tEzsignfolderMessage"), - "obj_audit": CommonAudit.from_dict(obj.get("objAudit")) if obj.get("objAudit") is not None else None, - "s_ezsignfolder_externalid": obj.get("sEzsignfolderExternalid") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsignfolderID": obj.get("pkiEzsignfolderID"), + "fkiEzsignfoldertypeID": obj.get("fkiEzsignfoldertypeID"), + "objEzsignfoldertype": CustomEzsignfoldertypeResponse.from_dict(obj.get("objEzsignfoldertype")) if obj.get("objEzsignfoldertype") is not None else None, + "sEzsignfoldertypeNameX": obj.get("sEzsignfoldertypeNameX"), + "fkiBillingentityinternalID": obj.get("fkiBillingentityinternalID"), + "sBillingentityinternalDescriptionX": obj.get("sBillingentityinternalDescriptionX"), + "fkiEzsigntsarequirementID": obj.get("fkiEzsigntsarequirementID"), + "sEzsigntsarequirementDescriptionX": obj.get("sEzsigntsarequirementDescriptionX"), + "sEzsignfolderDescription": obj.get("sEzsignfolderDescription"), + "tEzsignfolderNote": obj.get("tEzsignfolderNote"), + "bEzsignfolderIsdisposable": obj.get("bEzsignfolderIsdisposable"), + "eEzsignfolderSendreminderfrequency": obj.get("eEzsignfolderSendreminderfrequency"), + "dtEzsignfolderDelayedsenddate": obj.get("dtEzsignfolderDelayedsenddate"), + "dtEzsignfolderDuedate": obj.get("dtEzsignfolderDuedate"), + "dtEzsignfolderSentdate": obj.get("dtEzsignfolderSentdate"), + "dtEzsignfolderScheduledarchive": obj.get("dtEzsignfolderScheduledarchive"), + "dtEzsignfolderScheduleddispose": obj.get("dtEzsignfolderScheduleddispose"), + "eEzsignfolderStep": obj.get("eEzsignfolderStep"), + "dtEzsignfolderClose": obj.get("dtEzsignfolderClose"), + "tEzsignfolderMessage": obj.get("tEzsignfolderMessage"), + "objAudit": CommonAudit.from_dict(obj.get("objAudit")) if obj.get("objAudit") is not None else None, + "sEzsignfolderExternalid": obj.get("sEzsignfolderExternalid") }) return _obj diff --git a/eZmaxApi/models/ezsignfolder_response_compound.py b/eZmaxApi/models/ezsignfolder_response_compound.py index f2e7b912a..dd79930fc 100644 --- a/eZmaxApi/models/ezsignfolder_response_compound.py +++ b/eZmaxApi/models/ezsignfolder_response_compound.py @@ -19,42 +19,48 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint, constr, validator +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, StrictStr, field_validator +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.common_audit import CommonAudit from eZmaxApi.models.custom_ezsignfoldertype_response import CustomEzsignfoldertypeResponse from eZmaxApi.models.field_e_ezsignfolder_sendreminderfrequency import FieldEEzsignfolderSendreminderfrequency from eZmaxApi.models.field_e_ezsignfolder_step import FieldEEzsignfolderStep +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignfolderResponseCompound(BaseModel): """ - An Ezsignfolder Object and children to create a complete structure # noqa: E501 - """ - pki_ezsignfolder_id: conint(strict=True, ge=0) = Field(..., alias="pkiEzsignfolderID", description="The unique ID of the Ezsignfolder") - fki_ezsignfoldertype_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiEzsignfoldertypeID", description="The unique ID of the Ezsignfoldertype.") - obj_ezsignfoldertype: Optional[CustomEzsignfoldertypeResponse] = Field(None, alias="objEzsignfoldertype") - s_ezsignfoldertype_name_x: Optional[StrictStr] = Field(None, alias="sEzsignfoldertypeNameX") - fki_billingentityinternal_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiBillingentityinternalID", description="The unique ID of the Billingentityinternal.") - s_billingentityinternal_description_x: Optional[StrictStr] = Field(None, alias="sBillingentityinternalDescriptionX", description="The description of the Billingentityinternal in the language of the requester") - fki_ezsigntsarequirement_id: Optional[conint(strict=True, le=3, ge=1)] = Field(None, alias="fkiEzsigntsarequirementID", description="The unique ID of the Ezsigntsarequirement. Determine if a Time Stamping Authority should add a timestamp on each of the signature. Valid values: |Value|Description| |-|-| |1|No. TSA Timestamping will requested. This will make all signatures a lot faster since no round-trip to the TSA server will be required. Timestamping will be made using eZsign server's time.| |2|Best effort. Timestamping from a Time Stamping Authority will be requested but is not mandatory. In the very improbable case it cannot be completed, the timestamping will be made using eZsign server's time. **Additional fee applies**| |3|Mandatory. Timestamping from a Time Stamping Authority will be requested and is mandatory. In the very improbable case it cannot be completed, the signature will fail and the user will be asked to retry. **Additional fee applies**|") - s_ezsigntsarequirement_description_x: Optional[StrictStr] = Field(None, alias="sEzsigntsarequirementDescriptionX", description="The description of the Ezsigntsarequirement in the language of the requester") - s_ezsignfolder_description: StrictStr = Field(..., alias="sEzsignfolderDescription", description="The description of the Ezsignfolder") - t_ezsignfolder_note: Optional[StrictStr] = Field(None, alias="tEzsignfolderNote", description="Note about the Ezsignfolder") - b_ezsignfolder_isdisposable: Optional[StrictBool] = Field(None, alias="bEzsignfolderIsdisposable", description="If the Ezsigndocument can be disposed") - e_ezsignfolder_sendreminderfrequency: Optional[FieldEEzsignfolderSendreminderfrequency] = Field(None, alias="eEzsignfolderSendreminderfrequency") - dt_ezsignfolder_delayedsenddate: Optional[StrictStr] = Field(None, alias="dtEzsignfolderDelayedsenddate", description="The date and time at which the Ezsignfolder will be sent in the future.") - dt_ezsignfolder_duedate: Optional[StrictStr] = Field(None, alias="dtEzsignfolderDuedate", description="The maximum date and time at which the Ezsignfolder can be signed.") - dt_ezsignfolder_sentdate: Optional[StrictStr] = Field(None, alias="dtEzsignfolderSentdate", description="The date and time at which the Ezsignfolder was sent the last time.") - dt_ezsignfolder_scheduledarchive: Optional[StrictStr] = Field(None, alias="dtEzsignfolderScheduledarchive", description="The scheduled date and time at which the Ezsignfolder should be archived.") - dt_ezsignfolder_scheduleddispose: Optional[StrictStr] = Field(None, alias="dtEzsignfolderScheduleddispose", description="The scheduled date at which the Ezsignfolder should be Disposed.") - e_ezsignfolder_step: Optional[FieldEEzsignfolderStep] = Field(None, alias="eEzsignfolderStep") - dt_ezsignfolder_close: Optional[StrictStr] = Field(None, alias="dtEzsignfolderClose", description="The date and time at which the Ezsignfolder was closed. Either by applying the last signature or by completing it prematurely.") - t_ezsignfolder_message: Optional[StrictStr] = Field(None, alias="tEzsignfolderMessage", description="A custom text message that will be added to the email sent.") - obj_audit: Optional[CommonAudit] = Field(None, alias="objAudit") - s_ezsignfolder_externalid: Optional[constr(strict=True)] = Field(None, alias="sEzsignfolderExternalid", description="This field can be used to store an External ID from the client's system. Anything can be stored in this field, it will never be evaluated by the eZmax system and will be returned AS-IS. To store multiple values, consider using a JSON formatted structure, a URL encoded string, a CSV or any other custom format. ") - __properties = ["pkiEzsignfolderID", "fkiEzsignfoldertypeID", "objEzsignfoldertype", "sEzsignfoldertypeNameX", "fkiBillingentityinternalID", "sBillingentityinternalDescriptionX", "fkiEzsigntsarequirementID", "sEzsigntsarequirementDescriptionX", "sEzsignfolderDescription", "tEzsignfolderNote", "bEzsignfolderIsdisposable", "eEzsignfolderSendreminderfrequency", "dtEzsignfolderDelayedsenddate", "dtEzsignfolderDuedate", "dtEzsignfolderSentdate", "dtEzsignfolderScheduledarchive", "dtEzsignfolderScheduleddispose", "eEzsignfolderStep", "dtEzsignfolderClose", "tEzsignfolderMessage", "objAudit", "sEzsignfolderExternalid"] - - @validator('s_ezsignfolder_externalid') + An Ezsignfolder Object and children to create a complete structure + """ # noqa: E501 + pki_ezsignfolder_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsignfolder", alias="pkiEzsignfolderID") + fki_ezsignfoldertype_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsignfoldertype.", alias="fkiEzsignfoldertypeID") + obj_ezsignfoldertype: Optional[CustomEzsignfoldertypeResponse] = Field(default=None, alias="objEzsignfoldertype") + s_ezsignfoldertype_name_x: Optional[StrictStr] = Field(default=None, alias="sEzsignfoldertypeNameX") + fki_billingentityinternal_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Billingentityinternal.", alias="fkiBillingentityinternalID") + s_billingentityinternal_description_x: Optional[StrictStr] = Field(default=None, description="The description of the Billingentityinternal in the language of the requester", alias="sBillingentityinternalDescriptionX") + fki_ezsigntsarequirement_id: Optional[Annotated[int, Field(le=3, strict=True, ge=1)]] = Field(default=None, description="The unique ID of the Ezsigntsarequirement. Determine if a Time Stamping Authority should add a timestamp on each of the signature. Valid values: |Value|Description| |-|-| |1|No. TSA Timestamping will requested. This will make all signatures a lot faster since no round-trip to the TSA server will be required. Timestamping will be made using eZsign server's time.| |2|Best effort. Timestamping from a Time Stamping Authority will be requested but is not mandatory. In the very improbable case it cannot be completed, the timestamping will be made using eZsign server's time. **Additional fee applies**| |3|Mandatory. Timestamping from a Time Stamping Authority will be requested and is mandatory. In the very improbable case it cannot be completed, the signature will fail and the user will be asked to retry. **Additional fee applies**|", alias="fkiEzsigntsarequirementID") + s_ezsigntsarequirement_description_x: Optional[StrictStr] = Field(default=None, description="The description of the Ezsigntsarequirement in the language of the requester", alias="sEzsigntsarequirementDescriptionX") + s_ezsignfolder_description: StrictStr = Field(description="The description of the Ezsignfolder", alias="sEzsignfolderDescription") + t_ezsignfolder_note: Optional[StrictStr] = Field(default=None, description="Note about the Ezsignfolder", alias="tEzsignfolderNote") + b_ezsignfolder_isdisposable: Optional[StrictBool] = Field(default=None, description="If the Ezsigndocument can be disposed", alias="bEzsignfolderIsdisposable") + e_ezsignfolder_sendreminderfrequency: Optional[FieldEEzsignfolderSendreminderfrequency] = Field(default=None, alias="eEzsignfolderSendreminderfrequency") + dt_ezsignfolder_delayedsenddate: Optional[StrictStr] = Field(default=None, description="The date and time at which the Ezsignfolder will be sent in the future.", alias="dtEzsignfolderDelayedsenddate") + dt_ezsignfolder_duedate: Optional[StrictStr] = Field(default=None, description="The maximum date and time at which the Ezsignfolder can be signed.", alias="dtEzsignfolderDuedate") + dt_ezsignfolder_sentdate: Optional[StrictStr] = Field(default=None, description="The date and time at which the Ezsignfolder was sent the last time.", alias="dtEzsignfolderSentdate") + dt_ezsignfolder_scheduledarchive: Optional[StrictStr] = Field(default=None, description="The scheduled date and time at which the Ezsignfolder should be archived.", alias="dtEzsignfolderScheduledarchive") + dt_ezsignfolder_scheduleddispose: Optional[StrictStr] = Field(default=None, description="The scheduled date at which the Ezsignfolder should be Disposed.", alias="dtEzsignfolderScheduleddispose") + e_ezsignfolder_step: Optional[FieldEEzsignfolderStep] = Field(default=None, alias="eEzsignfolderStep") + dt_ezsignfolder_close: Optional[StrictStr] = Field(default=None, description="The date and time at which the Ezsignfolder was closed. Either by applying the last signature or by completing it prematurely.", alias="dtEzsignfolderClose") + t_ezsignfolder_message: Optional[StrictStr] = Field(default=None, description="A custom text message that will be added to the email sent.", alias="tEzsignfolderMessage") + obj_audit: Optional[CommonAudit] = Field(default=None, alias="objAudit") + s_ezsignfolder_externalid: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="This field can be used to store an External ID from the client's system. Anything can be stored in this field, it will never be evaluated by the eZmax system and will be returned AS-IS. To store multiple values, consider using a JSON formatted structure, a URL encoded string, a CSV or any other custom format. ", alias="sEzsignfolderExternalid") + __properties: ClassVar[List[str]] = ["pkiEzsignfolderID", "fkiEzsignfoldertypeID", "objEzsignfoldertype", "sEzsignfoldertypeNameX", "fkiBillingentityinternalID", "sBillingentityinternalDescriptionX", "fkiEzsigntsarequirementID", "sEzsigntsarequirementDescriptionX", "sEzsignfolderDescription", "tEzsignfolderNote", "bEzsignfolderIsdisposable", "eEzsignfolderSendreminderfrequency", "dtEzsignfolderDelayedsenddate", "dtEzsignfolderDuedate", "dtEzsignfolderSentdate", "dtEzsignfolderScheduledarchive", "dtEzsignfolderScheduleddispose", "eEzsignfolderStep", "dtEzsignfolderClose", "tEzsignfolderMessage", "objAudit", "sEzsignfolderExternalid"] + + @field_validator('s_ezsignfolder_externalid') def s_ezsignfolder_externalid_validate_regular_expression(cls, value): """Validates the regular expression""" if value is None: @@ -64,30 +70,43 @@ def s_ezsignfolder_externalid_validate_regular_expression(cls, value): raise ValueError(r"must validate the regular expression /^.{0,64}$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignfolderResponseCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignfolderResponseCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_ezsignfoldertype if self.obj_ezsignfoldertype: _dict['objEzsignfoldertype'] = self.obj_ezsignfoldertype.to_dict() @@ -97,37 +116,37 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignfolderResponseCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignfolderResponseCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignfolderResponseCompound.parse_obj(obj) - - _obj = EzsignfolderResponseCompound.parse_obj({ - "pki_ezsignfolder_id": obj.get("pkiEzsignfolderID"), - "fki_ezsignfoldertype_id": obj.get("fkiEzsignfoldertypeID"), - "obj_ezsignfoldertype": CustomEzsignfoldertypeResponse.from_dict(obj.get("objEzsignfoldertype")) if obj.get("objEzsignfoldertype") is not None else None, - "s_ezsignfoldertype_name_x": obj.get("sEzsignfoldertypeNameX"), - "fki_billingentityinternal_id": obj.get("fkiBillingentityinternalID"), - "s_billingentityinternal_description_x": obj.get("sBillingentityinternalDescriptionX"), - "fki_ezsigntsarequirement_id": obj.get("fkiEzsigntsarequirementID"), - "s_ezsigntsarequirement_description_x": obj.get("sEzsigntsarequirementDescriptionX"), - "s_ezsignfolder_description": obj.get("sEzsignfolderDescription"), - "t_ezsignfolder_note": obj.get("tEzsignfolderNote"), - "b_ezsignfolder_isdisposable": obj.get("bEzsignfolderIsdisposable"), - "e_ezsignfolder_sendreminderfrequency": obj.get("eEzsignfolderSendreminderfrequency"), - "dt_ezsignfolder_delayedsenddate": obj.get("dtEzsignfolderDelayedsenddate"), - "dt_ezsignfolder_duedate": obj.get("dtEzsignfolderDuedate"), - "dt_ezsignfolder_sentdate": obj.get("dtEzsignfolderSentdate"), - "dt_ezsignfolder_scheduledarchive": obj.get("dtEzsignfolderScheduledarchive"), - "dt_ezsignfolder_scheduleddispose": obj.get("dtEzsignfolderScheduleddispose"), - "e_ezsignfolder_step": obj.get("eEzsignfolderStep"), - "dt_ezsignfolder_close": obj.get("dtEzsignfolderClose"), - "t_ezsignfolder_message": obj.get("tEzsignfolderMessage"), - "obj_audit": CommonAudit.from_dict(obj.get("objAudit")) if obj.get("objAudit") is not None else None, - "s_ezsignfolder_externalid": obj.get("sEzsignfolderExternalid") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsignfolderID": obj.get("pkiEzsignfolderID"), + "fkiEzsignfoldertypeID": obj.get("fkiEzsignfoldertypeID"), + "objEzsignfoldertype": CustomEzsignfoldertypeResponse.from_dict(obj.get("objEzsignfoldertype")) if obj.get("objEzsignfoldertype") is not None else None, + "sEzsignfoldertypeNameX": obj.get("sEzsignfoldertypeNameX"), + "fkiBillingentityinternalID": obj.get("fkiBillingentityinternalID"), + "sBillingentityinternalDescriptionX": obj.get("sBillingentityinternalDescriptionX"), + "fkiEzsigntsarequirementID": obj.get("fkiEzsigntsarequirementID"), + "sEzsigntsarequirementDescriptionX": obj.get("sEzsigntsarequirementDescriptionX"), + "sEzsignfolderDescription": obj.get("sEzsignfolderDescription"), + "tEzsignfolderNote": obj.get("tEzsignfolderNote"), + "bEzsignfolderIsdisposable": obj.get("bEzsignfolderIsdisposable"), + "eEzsignfolderSendreminderfrequency": obj.get("eEzsignfolderSendreminderfrequency"), + "dtEzsignfolderDelayedsenddate": obj.get("dtEzsignfolderDelayedsenddate"), + "dtEzsignfolderDuedate": obj.get("dtEzsignfolderDuedate"), + "dtEzsignfolderSentdate": obj.get("dtEzsignfolderSentdate"), + "dtEzsignfolderScheduledarchive": obj.get("dtEzsignfolderScheduledarchive"), + "dtEzsignfolderScheduleddispose": obj.get("dtEzsignfolderScheduleddispose"), + "eEzsignfolderStep": obj.get("eEzsignfolderStep"), + "dtEzsignfolderClose": obj.get("dtEzsignfolderClose"), + "tEzsignfolderMessage": obj.get("tEzsignfolderMessage"), + "objAudit": CommonAudit.from_dict(obj.get("objAudit")) if obj.get("objAudit") is not None else None, + "sEzsignfolderExternalid": obj.get("sEzsignfolderExternalid") }) return _obj diff --git a/eZmaxApi/models/ezsignfolder_send_v1_request.py b/eZmaxApi/models/ezsignfolder_send_v1_request.py index 2aa1a357e..d2e61e5db 100644 --- a/eZmaxApi/models/ezsignfolder_send_v1_request.py +++ b/eZmaxApi/models/ezsignfolder_send_v1_request.py @@ -19,53 +19,71 @@ import json - -from pydantic import BaseModel, Field, StrictStr +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictStr +from pydantic import Field +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignfolderSendV1Request(BaseModel): """ - Request for POST /1/object/ezsignfolder/{pkiEzsignfolderID}/send # noqa: E501 - """ - t_extra_message: StrictStr = Field(..., alias="tExtraMessage", description="A custom text message that will be added to the email sent.") - __properties = ["tExtraMessage"] + Request for POST /1/object/ezsignfolder/{pkiEzsignfolderID}/send + """ # noqa: E501 + t_extra_message: StrictStr = Field(description="A custom text message that will be added to the email sent.", alias="tExtraMessage") + __properties: ClassVar[List[str]] = ["tExtraMessage"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignfolderSendV1Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignfolderSendV1Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignfolderSendV1Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignfolderSendV1Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignfolderSendV1Request.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignfolderSendV1Request.parse_obj({ - "t_extra_message": obj.get("tExtraMessage") + _obj = cls.model_validate({ + "tExtraMessage": obj.get("tExtraMessage") }) return _obj diff --git a/eZmaxApi/models/ezsignfolder_send_v1_response.py b/eZmaxApi/models/ezsignfolder_send_v1_response.py index 03dae0fac..f43e0da29 100644 --- a/eZmaxApi/models/ezsignfolder_send_v1_response.py +++ b/eZmaxApi/models/ezsignfolder_send_v1_response.py @@ -19,43 +19,61 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignfolderSendV1Response(BaseModel): """ - Response for GET /1/object/attachment/{pkiAttachmentID}/download # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - __properties = ["objDebugPayload", "objDebug"] + Response for GET /1/object/attachment/{pkiAttachmentID}/download + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignfolderSendV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignfolderSendV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -65,17 +83,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignfolderSendV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignfolderSendV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignfolderSendV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignfolderSendV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignfolder_send_v2_request.py b/eZmaxApi/models/ezsignfolder_send_v2_request.py index d8b54a600..d322bff31 100644 --- a/eZmaxApi/models/ezsignfolder_send_v2_request.py +++ b/eZmaxApi/models/ezsignfolder_send_v2_request.py @@ -19,43 +19,62 @@ import json -from typing import List -from pydantic import BaseModel, Field, StrictStr, conint, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictStr +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.custom_ezsignfoldersignerassociationmessage_request import CustomEzsignfoldersignerassociationmessageRequest +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignfolderSendV2Request(BaseModel): """ - Request for POST /2/object/ezsignfolder/{pkiEzsignfolderID}/send # noqa: E501 - """ - t_ezsignfolder_message: StrictStr = Field(..., alias="tEzsignfolderMessage", description="A custom text message that will be added to the email sent.") - a_fki_ezsignfoldersignerassociation_id: conlist(conint(strict=True, ge=0)) = Field(..., alias="a_fkiEzsignfoldersignerassociationID") - a_obj_ezsignfoldersignerassociationmessage: conlist(CustomEzsignfoldersignerassociationmessageRequest) = Field(..., alias="a_objEzsignfoldersignerassociationmessage") - __properties = ["tEzsignfolderMessage", "a_fkiEzsignfoldersignerassociationID", "a_objEzsignfoldersignerassociationmessage"] + Request for POST /2/object/ezsignfolder/{pkiEzsignfolderID}/send + """ # noqa: E501 + t_ezsignfolder_message: StrictStr = Field(description="A custom text message that will be added to the email sent.", alias="tEzsignfolderMessage") + a_fki_ezsignfoldersignerassociation_id: List[Annotated[int, Field(strict=True, ge=0)]] = Field(alias="a_fkiEzsignfoldersignerassociationID") + a_obj_ezsignfoldersignerassociationmessage: List[CustomEzsignfoldersignerassociationmessageRequest] = Field(alias="a_objEzsignfoldersignerassociationmessage") + __properties: ClassVar[List[str]] = ["tEzsignfolderMessage", "a_fkiEzsignfoldersignerassociationID", "a_objEzsignfoldersignerassociationmessage"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignfolderSendV2Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignfolderSendV2Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_ezsignfoldersignerassociationmessage (list) _items = [] if self.a_obj_ezsignfoldersignerassociationmessage: @@ -66,18 +85,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignfolderSendV2Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignfolderSendV2Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignfolderSendV2Request.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignfolderSendV2Request.parse_obj({ - "t_ezsignfolder_message": obj.get("tEzsignfolderMessage"), - "a_fki_ezsignfoldersignerassociation_id": obj.get("a_fkiEzsignfoldersignerassociationID"), - "a_obj_ezsignfoldersignerassociationmessage": [CustomEzsignfoldersignerassociationmessageRequest.from_dict(_item) for _item in obj.get("a_objEzsignfoldersignerassociationmessage")] if obj.get("a_objEzsignfoldersignerassociationmessage") is not None else None + _obj = cls.model_validate({ + "tEzsignfolderMessage": obj.get("tEzsignfolderMessage"), + "a_fkiEzsignfoldersignerassociationID": obj.get("a_fkiEzsignfoldersignerassociationID"), + "a_objEzsignfoldersignerassociationmessage": [CustomEzsignfoldersignerassociationmessageRequest.from_dict(_item) for _item in obj.get("a_objEzsignfoldersignerassociationmessage")] if obj.get("a_objEzsignfoldersignerassociationmessage") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignfolder_send_v2_response.py b/eZmaxApi/models/ezsignfolder_send_v2_response.py index 5868c4eb8..546533743 100644 --- a/eZmaxApi/models/ezsignfolder_send_v2_response.py +++ b/eZmaxApi/models/ezsignfolder_send_v2_response.py @@ -19,43 +19,61 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignfolderSendV2Response(BaseModel): """ - Response for POST /2/object/ezsignfolder/{pkiEzsignfolderID}/send # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - __properties = ["objDebugPayload", "objDebug"] + Response for POST /2/object/ezsignfolder/{pkiEzsignfolderID}/send + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignfolderSendV2Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignfolderSendV2Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -65,17 +83,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignfolderSendV2Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignfolderSendV2Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignfolderSendV2Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignfolderSendV2Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignfolder_send_v3_request.py b/eZmaxApi/models/ezsignfolder_send_v3_request.py index 0309ddba1..b470f7e61 100644 --- a/eZmaxApi/models/ezsignfolder_send_v3_request.py +++ b/eZmaxApi/models/ezsignfolder_send_v3_request.py @@ -19,57 +19,76 @@ import json -from typing import List, Optional -from pydantic import BaseModel, Field, StrictStr, conint, conlist +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictStr +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignfolderSendV3Request(BaseModel): """ - Request for POST /3/object/ezsignfolder/{pkiEzsignfolderID}/send # noqa: E501 - """ - t_ezsignfolder_message: Optional[StrictStr] = Field(None, alias="tEzsignfolderMessage", description="A custom text message that will be added to the email sent.") - dt_ezsignfolder_delayedsenddate: Optional[StrictStr] = Field(None, alias="dtEzsignfolderDelayedsenddate", description="The date and time at which the Ezsignfolder will be sent in the future.") - a_fki_ezsignfoldersignerassociation_id: conlist(conint(strict=True, ge=0)) = Field(..., alias="a_fkiEzsignfoldersignerassociationID") - __properties = ["tEzsignfolderMessage", "dtEzsignfolderDelayedsenddate", "a_fkiEzsignfoldersignerassociationID"] + Request for POST /3/object/ezsignfolder/{pkiEzsignfolderID}/send + """ # noqa: E501 + t_ezsignfolder_message: Optional[StrictStr] = Field(default=None, description="A custom text message that will be added to the email sent.", alias="tEzsignfolderMessage") + dt_ezsignfolder_delayedsenddate: Optional[StrictStr] = Field(default=None, description="The date and time at which the Ezsignfolder will be sent in the future.", alias="dtEzsignfolderDelayedsenddate") + a_fki_ezsignfoldersignerassociation_id: List[Annotated[int, Field(strict=True, ge=0)]] = Field(alias="a_fkiEzsignfoldersignerassociationID") + __properties: ClassVar[List[str]] = ["tEzsignfolderMessage", "dtEzsignfolderDelayedsenddate", "a_fkiEzsignfoldersignerassociationID"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignfolderSendV3Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignfolderSendV3Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignfolderSendV3Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignfolderSendV3Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignfolderSendV3Request.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignfolderSendV3Request.parse_obj({ - "t_ezsignfolder_message": obj.get("tEzsignfolderMessage"), - "dt_ezsignfolder_delayedsenddate": obj.get("dtEzsignfolderDelayedsenddate"), - "a_fki_ezsignfoldersignerassociation_id": obj.get("a_fkiEzsignfoldersignerassociationID") + _obj = cls.model_validate({ + "tEzsignfolderMessage": obj.get("tEzsignfolderMessage"), + "dtEzsignfolderDelayedsenddate": obj.get("dtEzsignfolderDelayedsenddate"), + "a_fkiEzsignfoldersignerassociationID": obj.get("a_fkiEzsignfoldersignerassociationID") }) return _obj diff --git a/eZmaxApi/models/ezsignfolder_send_v3_response.py b/eZmaxApi/models/ezsignfolder_send_v3_response.py index c10a734c3..36a0fc686 100644 --- a/eZmaxApi/models/ezsignfolder_send_v3_response.py +++ b/eZmaxApi/models/ezsignfolder_send_v3_response.py @@ -19,43 +19,61 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignfolderSendV3Response(BaseModel): """ - Response for POST /3/object/ezsignfolder/{pkiEzsignfolderID}/send # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - __properties = ["objDebugPayload", "objDebug"] + Response for POST /3/object/ezsignfolder/{pkiEzsignfolderID}/send + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignfolderSendV3Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignfolderSendV3Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -65,17 +83,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignfolderSendV3Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignfolderSendV3Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignfolderSendV3Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignfolderSendV3Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignfolder_unsend_v1_response.py b/eZmaxApi/models/ezsignfolder_unsend_v1_response.py index 5e7ec9fcc..678f993ee 100644 --- a/eZmaxApi/models/ezsignfolder_unsend_v1_response.py +++ b/eZmaxApi/models/ezsignfolder_unsend_v1_response.py @@ -19,43 +19,61 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignfolderUnsendV1Response(BaseModel): """ - Response for POST /1/object/ezsignfolder/{pkiEzsignfolderID}/unsend # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - __properties = ["objDebugPayload", "objDebug"] + Response for POST /1/object/ezsignfolder/{pkiEzsignfolderID}/unsend + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignfolderUnsendV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignfolderUnsendV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -65,17 +83,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignfolderUnsendV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignfolderUnsendV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignfolderUnsendV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignfolderUnsendV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignfoldersignerassociation_create_object_v1_request.py b/eZmaxApi/models/ezsignfoldersignerassociation_create_object_v1_request.py index 56a5e6cd7..d9141017c 100644 --- a/eZmaxApi/models/ezsignfoldersignerassociation_create_object_v1_request.py +++ b/eZmaxApi/models/ezsignfoldersignerassociation_create_object_v1_request.py @@ -19,43 +19,61 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.ezsignfoldersignerassociation_request import EzsignfoldersignerassociationRequest from eZmaxApi.models.ezsignfoldersignerassociation_request_compound import EzsignfoldersignerassociationRequestCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignfoldersignerassociationCreateObjectV1Request(BaseModel): """ - Request for POST /1/object/ezsignfoldersignerassociation # noqa: E501 - """ - obj_ezsignfoldersignerassociation: Optional[EzsignfoldersignerassociationRequest] = Field(None, alias="objEzsignfoldersignerassociation") - obj_ezsignfoldersignerassociation_compound: Optional[EzsignfoldersignerassociationRequestCompound] = Field(None, alias="objEzsignfoldersignerassociationCompound") - __properties = ["objEzsignfoldersignerassociation", "objEzsignfoldersignerassociationCompound"] + Request for POST /1/object/ezsignfoldersignerassociation + """ # noqa: E501 + obj_ezsignfoldersignerassociation: Optional[EzsignfoldersignerassociationRequest] = Field(default=None, alias="objEzsignfoldersignerassociation") + obj_ezsignfoldersignerassociation_compound: Optional[EzsignfoldersignerassociationRequestCompound] = Field(default=None, alias="objEzsignfoldersignerassociationCompound") + __properties: ClassVar[List[str]] = ["objEzsignfoldersignerassociation", "objEzsignfoldersignerassociationCompound"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignfoldersignerassociationCreateObjectV1Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignfoldersignerassociationCreateObjectV1Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_ezsignfoldersignerassociation if self.obj_ezsignfoldersignerassociation: _dict['objEzsignfoldersignerassociation'] = self.obj_ezsignfoldersignerassociation.to_dict() @@ -65,17 +83,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignfoldersignerassociationCreateObjectV1Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignfoldersignerassociationCreateObjectV1Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignfoldersignerassociationCreateObjectV1Request.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignfoldersignerassociationCreateObjectV1Request.parse_obj({ - "obj_ezsignfoldersignerassociation": EzsignfoldersignerassociationRequest.from_dict(obj.get("objEzsignfoldersignerassociation")) if obj.get("objEzsignfoldersignerassociation") is not None else None, - "obj_ezsignfoldersignerassociation_compound": EzsignfoldersignerassociationRequestCompound.from_dict(obj.get("objEzsignfoldersignerassociationCompound")) if obj.get("objEzsignfoldersignerassociationCompound") is not None else None + _obj = cls.model_validate({ + "objEzsignfoldersignerassociation": EzsignfoldersignerassociationRequest.from_dict(obj.get("objEzsignfoldersignerassociation")) if obj.get("objEzsignfoldersignerassociation") is not None else None, + "objEzsignfoldersignerassociationCompound": EzsignfoldersignerassociationRequestCompound.from_dict(obj.get("objEzsignfoldersignerassociationCompound")) if obj.get("objEzsignfoldersignerassociationCompound") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignfoldersignerassociation_create_object_v1_response.py b/eZmaxApi/models/ezsignfoldersignerassociation_create_object_v1_response.py index e52c8822f..e1a4029f4 100644 --- a/eZmaxApi/models/ezsignfoldersignerassociation_create_object_v1_response.py +++ b/eZmaxApi/models/ezsignfoldersignerassociation_create_object_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.ezsignfoldersignerassociation_create_object_v1_response_m_payload import EzsignfoldersignerassociationCreateObjectV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignfoldersignerassociationCreateObjectV1Response(BaseModel): """ - Response for POST /1/object/ezsignfoldersignerassociation # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzsignfoldersignerassociationCreateObjectV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for POST /1/object/ezsignfoldersignerassociation + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsignfoldersignerassociationCreateObjectV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignfoldersignerassociationCreateObjectV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignfoldersignerassociationCreateObjectV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignfoldersignerassociationCreateObjectV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignfoldersignerassociationCreateObjectV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignfoldersignerassociationCreateObjectV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignfoldersignerassociationCreateObjectV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzsignfoldersignerassociationCreateObjectV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsignfoldersignerassociationCreateObjectV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignfoldersignerassociation_create_object_v1_response_m_payload.py b/eZmaxApi/models/ezsignfoldersignerassociation_create_object_v1_response_m_payload.py index db2935d6a..88c035194 100644 --- a/eZmaxApi/models/ezsignfoldersignerassociation_create_object_v1_response_m_payload.py +++ b/eZmaxApi/models/ezsignfoldersignerassociation_create_object_v1_response_m_payload.py @@ -19,53 +19,72 @@ import json -from typing import List -from pydantic import BaseModel, Field, conint, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignfoldersignerassociationCreateObjectV1ResponseMPayload(BaseModel): """ - Payload for POST /1/object/ezsignfoldersignerassociation # noqa: E501 - """ - a_pki_ezsignfoldersignerassociation_id: conlist(conint(strict=True, ge=0), min_items=1) = Field(..., alias="a_pkiEzsignfoldersignerassociationID", description="An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request.") - __properties = ["a_pkiEzsignfoldersignerassociationID"] + Payload for POST /1/object/ezsignfoldersignerassociation + """ # noqa: E501 + a_pki_ezsignfoldersignerassociation_id: Annotated[List[Annotated[int, Field(strict=True, ge=0)]], Field(min_length=1)] = Field(description="An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request.", alias="a_pkiEzsignfoldersignerassociationID") + __properties: ClassVar[List[str]] = ["a_pkiEzsignfoldersignerassociationID"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignfoldersignerassociationCreateObjectV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignfoldersignerassociationCreateObjectV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignfoldersignerassociationCreateObjectV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignfoldersignerassociationCreateObjectV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignfoldersignerassociationCreateObjectV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignfoldersignerassociationCreateObjectV1ResponseMPayload.parse_obj({ - "a_pki_ezsignfoldersignerassociation_id": obj.get("a_pkiEzsignfoldersignerassociationID") + _obj = cls.model_validate({ + "a_pkiEzsignfoldersignerassociationID": obj.get("a_pkiEzsignfoldersignerassociationID") }) return _obj diff --git a/eZmaxApi/models/ezsignfoldersignerassociation_create_object_v2_request.py b/eZmaxApi/models/ezsignfoldersignerassociation_create_object_v2_request.py index cb77968ab..700f5a424 100644 --- a/eZmaxApi/models/ezsignfoldersignerassociation_create_object_v2_request.py +++ b/eZmaxApi/models/ezsignfoldersignerassociation_create_object_v2_request.py @@ -19,41 +19,60 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.ezsignfoldersignerassociation_request_compound import EzsignfoldersignerassociationRequestCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignfoldersignerassociationCreateObjectV2Request(BaseModel): """ - Request for POST /2/object/ezsignfoldersignerassociation # noqa: E501 - """ - a_obj_ezsignfoldersignerassociation: conlist(EzsignfoldersignerassociationRequestCompound, min_items=1) = Field(..., alias="a_objEzsignfoldersignerassociation") - __properties = ["a_objEzsignfoldersignerassociation"] + Request for POST /2/object/ezsignfoldersignerassociation + """ # noqa: E501 + a_obj_ezsignfoldersignerassociation: Annotated[List[EzsignfoldersignerassociationRequestCompound], Field(min_length=1)] = Field(alias="a_objEzsignfoldersignerassociation") + __properties: ClassVar[List[str]] = ["a_objEzsignfoldersignerassociation"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignfoldersignerassociationCreateObjectV2Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignfoldersignerassociationCreateObjectV2Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_ezsignfoldersignerassociation (list) _items = [] if self.a_obj_ezsignfoldersignerassociation: @@ -64,16 +83,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignfoldersignerassociationCreateObjectV2Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignfoldersignerassociationCreateObjectV2Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignfoldersignerassociationCreateObjectV2Request.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignfoldersignerassociationCreateObjectV2Request.parse_obj({ - "a_obj_ezsignfoldersignerassociation": [EzsignfoldersignerassociationRequestCompound.from_dict(_item) for _item in obj.get("a_objEzsignfoldersignerassociation")] if obj.get("a_objEzsignfoldersignerassociation") is not None else None + _obj = cls.model_validate({ + "a_objEzsignfoldersignerassociation": [EzsignfoldersignerassociationRequestCompound.from_dict(_item) for _item in obj.get("a_objEzsignfoldersignerassociation")] if obj.get("a_objEzsignfoldersignerassociation") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignfoldersignerassociation_create_object_v2_response.py b/eZmaxApi/models/ezsignfoldersignerassociation_create_object_v2_response.py index 33e013753..fc5d00cfb 100644 --- a/eZmaxApi/models/ezsignfoldersignerassociation_create_object_v2_response.py +++ b/eZmaxApi/models/ezsignfoldersignerassociation_create_object_v2_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.ezsignfoldersignerassociation_create_object_v2_response_m_payload import EzsignfoldersignerassociationCreateObjectV2ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignfoldersignerassociationCreateObjectV2Response(BaseModel): """ - Response for POST /2/object/ezsignfoldersignerassociation # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzsignfoldersignerassociationCreateObjectV2ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for POST /2/object/ezsignfoldersignerassociation + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsignfoldersignerassociationCreateObjectV2ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignfoldersignerassociationCreateObjectV2Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignfoldersignerassociationCreateObjectV2Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignfoldersignerassociationCreateObjectV2Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignfoldersignerassociationCreateObjectV2Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignfoldersignerassociationCreateObjectV2Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignfoldersignerassociationCreateObjectV2Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzsignfoldersignerassociationCreateObjectV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsignfoldersignerassociationCreateObjectV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignfoldersignerassociation_create_object_v2_response_m_payload.py b/eZmaxApi/models/ezsignfoldersignerassociation_create_object_v2_response_m_payload.py index 9b1407996..e611bbf3c 100644 --- a/eZmaxApi/models/ezsignfoldersignerassociation_create_object_v2_response_m_payload.py +++ b/eZmaxApi/models/ezsignfoldersignerassociation_create_object_v2_response_m_payload.py @@ -19,53 +19,72 @@ import json -from typing import List -from pydantic import BaseModel, Field, conint, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignfoldersignerassociationCreateObjectV2ResponseMPayload(BaseModel): """ - Payload for POST /2/object/ezsignfoldersignerassociation # noqa: E501 - """ - a_pki_ezsignfoldersignerassociation_id: conlist(conint(strict=True, ge=0), min_items=1) = Field(..., alias="a_pkiEzsignfoldersignerassociationID", description="An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request.") - __properties = ["a_pkiEzsignfoldersignerassociationID"] + Payload for POST /2/object/ezsignfoldersignerassociation + """ # noqa: E501 + a_pki_ezsignfoldersignerassociation_id: Annotated[List[Annotated[int, Field(strict=True, ge=0)]], Field(min_length=1)] = Field(description="An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request.", alias="a_pkiEzsignfoldersignerassociationID") + __properties: ClassVar[List[str]] = ["a_pkiEzsignfoldersignerassociationID"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignfoldersignerassociationCreateObjectV2ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignfoldersignerassociationCreateObjectV2ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignfoldersignerassociationCreateObjectV2ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignfoldersignerassociationCreateObjectV2ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignfoldersignerassociationCreateObjectV2ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignfoldersignerassociationCreateObjectV2ResponseMPayload.parse_obj({ - "a_pki_ezsignfoldersignerassociation_id": obj.get("a_pkiEzsignfoldersignerassociationID") + _obj = cls.model_validate({ + "a_pkiEzsignfoldersignerassociationID": obj.get("a_pkiEzsignfoldersignerassociationID") }) return _obj diff --git a/eZmaxApi/models/ezsignfoldersignerassociation_delete_object_v1_response.py b/eZmaxApi/models/ezsignfoldersignerassociation_delete_object_v1_response.py index 230688148..85e70ab6d 100644 --- a/eZmaxApi/models/ezsignfoldersignerassociation_delete_object_v1_response.py +++ b/eZmaxApi/models/ezsignfoldersignerassociation_delete_object_v1_response.py @@ -19,43 +19,61 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignfoldersignerassociationDeleteObjectV1Response(BaseModel): """ - Response for DELETE /1/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociationID} # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - __properties = ["objDebugPayload", "objDebug"] + Response for DELETE /1/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociationID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignfoldersignerassociationDeleteObjectV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignfoldersignerassociationDeleteObjectV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -65,17 +83,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignfoldersignerassociationDeleteObjectV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignfoldersignerassociationDeleteObjectV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignfoldersignerassociationDeleteObjectV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignfoldersignerassociationDeleteObjectV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignfoldersignerassociation_edit_object_v1_request.py b/eZmaxApi/models/ezsignfoldersignerassociation_edit_object_v1_request.py index 29a042ac4..6ca95c640 100644 --- a/eZmaxApi/models/ezsignfoldersignerassociation_edit_object_v1_request.py +++ b/eZmaxApi/models/ezsignfoldersignerassociation_edit_object_v1_request.py @@ -19,57 +19,75 @@ import json - -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.ezsignfoldersignerassociation_request_compound import EzsignfoldersignerassociationRequestCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignfoldersignerassociationEditObjectV1Request(BaseModel): """ - Request for PUT /1/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociationID} # noqa: E501 - """ - obj_ezsignfoldersignerassociation: EzsignfoldersignerassociationRequestCompound = Field(..., alias="objEzsignfoldersignerassociation") - __properties = ["objEzsignfoldersignerassociation"] + Request for PUT /1/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociationID} + """ # noqa: E501 + obj_ezsignfoldersignerassociation: EzsignfoldersignerassociationRequestCompound = Field(alias="objEzsignfoldersignerassociation") + __properties: ClassVar[List[str]] = ["objEzsignfoldersignerassociation"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignfoldersignerassociationEditObjectV1Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignfoldersignerassociationEditObjectV1Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_ezsignfoldersignerassociation if self.obj_ezsignfoldersignerassociation: _dict['objEzsignfoldersignerassociation'] = self.obj_ezsignfoldersignerassociation.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignfoldersignerassociationEditObjectV1Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignfoldersignerassociationEditObjectV1Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignfoldersignerassociationEditObjectV1Request.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignfoldersignerassociationEditObjectV1Request.parse_obj({ - "obj_ezsignfoldersignerassociation": EzsignfoldersignerassociationRequestCompound.from_dict(obj.get("objEzsignfoldersignerassociation")) if obj.get("objEzsignfoldersignerassociation") is not None else None + _obj = cls.model_validate({ + "objEzsignfoldersignerassociation": EzsignfoldersignerassociationRequestCompound.from_dict(obj.get("objEzsignfoldersignerassociation")) if obj.get("objEzsignfoldersignerassociation") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignfoldersignerassociation_edit_object_v1_response.py b/eZmaxApi/models/ezsignfoldersignerassociation_edit_object_v1_response.py index 1aa50d6b3..c4e9e5a5b 100644 --- a/eZmaxApi/models/ezsignfoldersignerassociation_edit_object_v1_response.py +++ b/eZmaxApi/models/ezsignfoldersignerassociation_edit_object_v1_response.py @@ -19,43 +19,61 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignfoldersignerassociationEditObjectV1Response(BaseModel): """ - Response for PUT /1/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociationID} # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - __properties = ["objDebugPayload", "objDebug"] + Response for PUT /1/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociationID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignfoldersignerassociationEditObjectV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignfoldersignerassociationEditObjectV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -65,17 +83,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignfoldersignerassociationEditObjectV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignfoldersignerassociationEditObjectV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignfoldersignerassociationEditObjectV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignfoldersignerassociationEditObjectV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignfoldersignerassociation_force_disconnect_v1_response.py b/eZmaxApi/models/ezsignfoldersignerassociation_force_disconnect_v1_response.py index 7da31503c..b39b001ad 100644 --- a/eZmaxApi/models/ezsignfoldersignerassociation_force_disconnect_v1_response.py +++ b/eZmaxApi/models/ezsignfoldersignerassociation_force_disconnect_v1_response.py @@ -19,43 +19,61 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignfoldersignerassociationForceDisconnectV1Response(BaseModel): """ - Response for POST /1/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociation}/forceDisconnect # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - __properties = ["objDebugPayload", "objDebug"] + Response for POST /1/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociation}/forceDisconnect + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignfoldersignerassociationForceDisconnectV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignfoldersignerassociationForceDisconnectV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -65,17 +83,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignfoldersignerassociationForceDisconnectV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignfoldersignerassociationForceDisconnectV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignfoldersignerassociationForceDisconnectV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignfoldersignerassociationForceDisconnectV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignfoldersignerassociation_get_in_person_login_url_v1_response.py b/eZmaxApi/models/ezsignfoldersignerassociation_get_in_person_login_url_v1_response.py index 17740d8c6..457fede79 100644 --- a/eZmaxApi/models/ezsignfoldersignerassociation_get_in_person_login_url_v1_response.py +++ b/eZmaxApi/models/ezsignfoldersignerassociation_get_in_person_login_url_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.ezsignfoldersignerassociation_get_in_person_login_url_v1_response_m_payload import EzsignfoldersignerassociationGetInPersonLoginUrlV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignfoldersignerassociationGetInPersonLoginUrlV1Response(BaseModel): """ - Response for GET /1/object/ezsignfoldersignerassociation/getInPersonLoginUrl # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzsignfoldersignerassociationGetInPersonLoginUrlV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /1/object/ezsignfoldersignerassociation/getInPersonLoginUrl + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsignfoldersignerassociationGetInPersonLoginUrlV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignfoldersignerassociationGetInPersonLoginUrlV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignfoldersignerassociationGetInPersonLoginUrlV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignfoldersignerassociationGetInPersonLoginUrlV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignfoldersignerassociationGetInPersonLoginUrlV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignfoldersignerassociationGetInPersonLoginUrlV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignfoldersignerassociationGetInPersonLoginUrlV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzsignfoldersignerassociationGetInPersonLoginUrlV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsignfoldersignerassociationGetInPersonLoginUrlV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignfoldersignerassociation_get_in_person_login_url_v1_response_m_payload.py b/eZmaxApi/models/ezsignfoldersignerassociation_get_in_person_login_url_v1_response_m_payload.py index fdca9d813..c0aee5f15 100644 --- a/eZmaxApi/models/ezsignfoldersignerassociation_get_in_person_login_url_v1_response_m_payload.py +++ b/eZmaxApi/models/ezsignfoldersignerassociation_get_in_person_login_url_v1_response_m_payload.py @@ -19,53 +19,71 @@ import json - -from pydantic import BaseModel, Field, StrictStr +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictStr +from pydantic import Field +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignfoldersignerassociationGetInPersonLoginUrlV1ResponseMPayload(BaseModel): """ - Payload for GET /1/object/ezsignfoldersignerassociation/getInPersonLoginUrl # noqa: E501 - """ - s_login_url: StrictStr = Field(..., alias="sLoginUrl", description="The Url to login to the signing application. Url will expire after 30 minutes. ") - __properties = ["sLoginUrl"] + Payload for GET /1/object/ezsignfoldersignerassociation/getInPersonLoginUrl + """ # noqa: E501 + s_login_url: StrictStr = Field(description="The Url to login to the signing application. Url will expire after 30 minutes. ", alias="sLoginUrl") + __properties: ClassVar[List[str]] = ["sLoginUrl"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignfoldersignerassociationGetInPersonLoginUrlV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignfoldersignerassociationGetInPersonLoginUrlV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignfoldersignerassociationGetInPersonLoginUrlV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignfoldersignerassociationGetInPersonLoginUrlV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignfoldersignerassociationGetInPersonLoginUrlV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignfoldersignerassociationGetInPersonLoginUrlV1ResponseMPayload.parse_obj({ - "s_login_url": obj.get("sLoginUrl") + _obj = cls.model_validate({ + "sLoginUrl": obj.get("sLoginUrl") }) return _obj diff --git a/eZmaxApi/models/ezsignfoldersignerassociation_get_object_v1_response.py b/eZmaxApi/models/ezsignfoldersignerassociation_get_object_v1_response.py index a1f9d490c..467506cad 100644 --- a/eZmaxApi/models/ezsignfoldersignerassociation_get_object_v1_response.py +++ b/eZmaxApi/models/ezsignfoldersignerassociation_get_object_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.ezsignfoldersignerassociation_get_object_v1_response_m_payload import EzsignfoldersignerassociationGetObjectV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignfoldersignerassociationGetObjectV1Response(BaseModel): """ - Response for GET /1/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociationID} # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzsignfoldersignerassociationGetObjectV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /1/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociationID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsignfoldersignerassociationGetObjectV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignfoldersignerassociationGetObjectV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignfoldersignerassociationGetObjectV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignfoldersignerassociationGetObjectV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignfoldersignerassociationGetObjectV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignfoldersignerassociationGetObjectV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignfoldersignerassociationGetObjectV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzsignfoldersignerassociationGetObjectV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsignfoldersignerassociationGetObjectV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignfoldersignerassociation_get_object_v1_response_m_payload.py b/eZmaxApi/models/ezsignfoldersignerassociation_get_object_v1_response_m_payload.py index 9f65ab876..c2dc86cd6 100644 --- a/eZmaxApi/models/ezsignfoldersignerassociation_get_object_v1_response_m_payload.py +++ b/eZmaxApi/models/ezsignfoldersignerassociation_get_object_v1_response_m_payload.py @@ -19,50 +19,69 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, StrictStr +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.ezsignfoldersignerassociation_response_compound_user import EzsignfoldersignerassociationResponseCompoundUser from eZmaxApi.models.ezsignsigner_response_compound import EzsignsignerResponseCompound from eZmaxApi.models.ezsignsignergroup_response_compound import EzsignsignergroupResponseCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignfoldersignerassociationGetObjectV1ResponseMPayload(BaseModel): """ - Payload for GET /1/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociationID} # noqa: E501 - """ - pki_ezsignfoldersignerassociation_id: conint(strict=True, ge=0) = Field(..., alias="pkiEzsignfoldersignerassociationID", description="The unique ID of the Ezsignfoldersignerassociation") - fki_ezsignfolder_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsignfolderID", description="The unique ID of the Ezsignfolder") - b_ezsignfoldersignerassociation_delayedsend: StrictBool = Field(..., alias="bEzsignfoldersignerassociationDelayedsend", description="If this flag is true the signatory is part of a delayed send.") - b_ezsignfoldersignerassociation_receivecopy: StrictBool = Field(..., alias="bEzsignfoldersignerassociationReceivecopy", description="If this flag is true. The signatory will receive a copy of every signed Ezsigndocument even if it ain't required to sign the document.") - t_ezsignfoldersignerassociation_message: StrictStr = Field(..., alias="tEzsignfoldersignerassociationMessage", description="A custom text message that will be added to the email sent.") - obj_ezsignsignergroup: Optional[EzsignsignergroupResponseCompound] = Field(None, alias="objEzsignsignergroup") - obj_user: Optional[EzsignfoldersignerassociationResponseCompoundUser] = Field(None, alias="objUser") - obj_ezsignsigner: Optional[EzsignsignerResponseCompound] = Field(None, alias="objEzsignsigner") - __properties = ["pkiEzsignfoldersignerassociationID", "fkiEzsignfolderID", "bEzsignfoldersignerassociationDelayedsend", "bEzsignfoldersignerassociationReceivecopy", "tEzsignfoldersignerassociationMessage", "objEzsignsignergroup", "objUser", "objEzsignsigner"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + Payload for GET /1/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociationID} + """ # noqa: E501 + pki_ezsignfoldersignerassociation_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsignfoldersignerassociation", alias="pkiEzsignfoldersignerassociationID") + fki_ezsignfolder_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsignfolder", alias="fkiEzsignfolderID") + b_ezsignfoldersignerassociation_delayedsend: StrictBool = Field(description="If this flag is true the signatory is part of a delayed send.", alias="bEzsignfoldersignerassociationDelayedsend") + b_ezsignfoldersignerassociation_receivecopy: StrictBool = Field(description="If this flag is true. The signatory will receive a copy of every signed Ezsigndocument even if it ain't required to sign the document.", alias="bEzsignfoldersignerassociationReceivecopy") + t_ezsignfoldersignerassociation_message: StrictStr = Field(description="A custom text message that will be added to the email sent.", alias="tEzsignfoldersignerassociationMessage") + obj_ezsignsignergroup: Optional[EzsignsignergroupResponseCompound] = Field(default=None, alias="objEzsignsignergroup") + obj_user: Optional[EzsignfoldersignerassociationResponseCompoundUser] = Field(default=None, alias="objUser") + obj_ezsignsigner: Optional[EzsignsignerResponseCompound] = Field(default=None, alias="objEzsignsigner") + __properties: ClassVar[List[str]] = ["pkiEzsignfoldersignerassociationID", "fkiEzsignfolderID", "bEzsignfoldersignerassociationDelayedsend", "bEzsignfoldersignerassociationReceivecopy", "tEzsignfoldersignerassociationMessage", "objEzsignsignergroup", "objUser", "objEzsignsigner"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignfoldersignerassociationGetObjectV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignfoldersignerassociationGetObjectV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_ezsignsignergroup if self.obj_ezsignsignergroup: _dict['objEzsignsignergroup'] = self.obj_ezsignsignergroup.to_dict() @@ -75,23 +94,23 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignfoldersignerassociationGetObjectV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignfoldersignerassociationGetObjectV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignfoldersignerassociationGetObjectV1ResponseMPayload.parse_obj(obj) - - _obj = EzsignfoldersignerassociationGetObjectV1ResponseMPayload.parse_obj({ - "pki_ezsignfoldersignerassociation_id": obj.get("pkiEzsignfoldersignerassociationID"), - "fki_ezsignfolder_id": obj.get("fkiEzsignfolderID"), - "b_ezsignfoldersignerassociation_delayedsend": obj.get("bEzsignfoldersignerassociationDelayedsend"), - "b_ezsignfoldersignerassociation_receivecopy": obj.get("bEzsignfoldersignerassociationReceivecopy"), - "t_ezsignfoldersignerassociation_message": obj.get("tEzsignfoldersignerassociationMessage"), - "obj_ezsignsignergroup": EzsignsignergroupResponseCompound.from_dict(obj.get("objEzsignsignergroup")) if obj.get("objEzsignsignergroup") is not None else None, - "obj_user": EzsignfoldersignerassociationResponseCompoundUser.from_dict(obj.get("objUser")) if obj.get("objUser") is not None else None, - "obj_ezsignsigner": EzsignsignerResponseCompound.from_dict(obj.get("objEzsignsigner")) if obj.get("objEzsignsigner") is not None else None + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsignfoldersignerassociationID": obj.get("pkiEzsignfoldersignerassociationID"), + "fkiEzsignfolderID": obj.get("fkiEzsignfolderID"), + "bEzsignfoldersignerassociationDelayedsend": obj.get("bEzsignfoldersignerassociationDelayedsend"), + "bEzsignfoldersignerassociationReceivecopy": obj.get("bEzsignfoldersignerassociationReceivecopy"), + "tEzsignfoldersignerassociationMessage": obj.get("tEzsignfoldersignerassociationMessage"), + "objEzsignsignergroup": EzsignsignergroupResponseCompound.from_dict(obj.get("objEzsignsignergroup")) if obj.get("objEzsignsignergroup") is not None else None, + "objUser": EzsignfoldersignerassociationResponseCompoundUser.from_dict(obj.get("objUser")) if obj.get("objUser") is not None else None, + "objEzsignsigner": EzsignsignerResponseCompound.from_dict(obj.get("objEzsignsigner")) if obj.get("objEzsignsigner") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignfoldersignerassociation_get_object_v2_response.py b/eZmaxApi/models/ezsignfoldersignerassociation_get_object_v2_response.py index c24a4c9b7..6ec626718 100644 --- a/eZmaxApi/models/ezsignfoldersignerassociation_get_object_v2_response.py +++ b/eZmaxApi/models/ezsignfoldersignerassociation_get_object_v2_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.ezsignfoldersignerassociation_get_object_v2_response_m_payload import EzsignfoldersignerassociationGetObjectV2ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignfoldersignerassociationGetObjectV2Response(BaseModel): """ - Response for GET /2/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociationID} # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzsignfoldersignerassociationGetObjectV2ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /2/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociationID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsignfoldersignerassociationGetObjectV2ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignfoldersignerassociationGetObjectV2Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignfoldersignerassociationGetObjectV2Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignfoldersignerassociationGetObjectV2Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignfoldersignerassociationGetObjectV2Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignfoldersignerassociationGetObjectV2Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignfoldersignerassociationGetObjectV2Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzsignfoldersignerassociationGetObjectV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsignfoldersignerassociationGetObjectV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignfoldersignerassociation_get_object_v2_response_m_payload.py b/eZmaxApi/models/ezsignfoldersignerassociation_get_object_v2_response_m_payload.py index 2972279c1..cfcd7df96 100644 --- a/eZmaxApi/models/ezsignfoldersignerassociation_get_object_v2_response_m_payload.py +++ b/eZmaxApi/models/ezsignfoldersignerassociation_get_object_v2_response_m_payload.py @@ -19,57 +19,75 @@ import json - -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.ezsignfoldersignerassociation_response_compound import EzsignfoldersignerassociationResponseCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignfoldersignerassociationGetObjectV2ResponseMPayload(BaseModel): """ - Payload for GET /2/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociationID} # noqa: E501 - """ - obj_ezsignfoldersignerassociation: EzsignfoldersignerassociationResponseCompound = Field(..., alias="objEzsignfoldersignerassociation") - __properties = ["objEzsignfoldersignerassociation"] + Payload for GET /2/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociationID} + """ # noqa: E501 + obj_ezsignfoldersignerassociation: EzsignfoldersignerassociationResponseCompound = Field(alias="objEzsignfoldersignerassociation") + __properties: ClassVar[List[str]] = ["objEzsignfoldersignerassociation"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignfoldersignerassociationGetObjectV2ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignfoldersignerassociationGetObjectV2ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_ezsignfoldersignerassociation if self.obj_ezsignfoldersignerassociation: _dict['objEzsignfoldersignerassociation'] = self.obj_ezsignfoldersignerassociation.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignfoldersignerassociationGetObjectV2ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignfoldersignerassociationGetObjectV2ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignfoldersignerassociationGetObjectV2ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignfoldersignerassociationGetObjectV2ResponseMPayload.parse_obj({ - "obj_ezsignfoldersignerassociation": EzsignfoldersignerassociationResponseCompound.from_dict(obj.get("objEzsignfoldersignerassociation")) if obj.get("objEzsignfoldersignerassociation") is not None else None + _obj = cls.model_validate({ + "objEzsignfoldersignerassociation": EzsignfoldersignerassociationResponseCompound.from_dict(obj.get("objEzsignfoldersignerassociation")) if obj.get("objEzsignfoldersignerassociation") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignfoldersignerassociation_patch_object_v1_request.py b/eZmaxApi/models/ezsignfoldersignerassociation_patch_object_v1_request.py index a2cbbb0e5..339e89d1a 100644 --- a/eZmaxApi/models/ezsignfoldersignerassociation_patch_object_v1_request.py +++ b/eZmaxApi/models/ezsignfoldersignerassociation_patch_object_v1_request.py @@ -19,57 +19,75 @@ import json - -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.ezsignfoldersignerassociation_request_patch import EzsignfoldersignerassociationRequestPatch +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignfoldersignerassociationPatchObjectV1Request(BaseModel): """ - Request for PATCH /1/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociationID} # noqa: E501 - """ - obj_ezsignfoldersignerassociation: EzsignfoldersignerassociationRequestPatch = Field(..., alias="objEzsignfoldersignerassociation") - __properties = ["objEzsignfoldersignerassociation"] + Request for PATCH /1/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociationID} + """ # noqa: E501 + obj_ezsignfoldersignerassociation: EzsignfoldersignerassociationRequestPatch = Field(alias="objEzsignfoldersignerassociation") + __properties: ClassVar[List[str]] = ["objEzsignfoldersignerassociation"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignfoldersignerassociationPatchObjectV1Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignfoldersignerassociationPatchObjectV1Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_ezsignfoldersignerassociation if self.obj_ezsignfoldersignerassociation: _dict['objEzsignfoldersignerassociation'] = self.obj_ezsignfoldersignerassociation.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignfoldersignerassociationPatchObjectV1Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignfoldersignerassociationPatchObjectV1Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignfoldersignerassociationPatchObjectV1Request.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignfoldersignerassociationPatchObjectV1Request.parse_obj({ - "obj_ezsignfoldersignerassociation": EzsignfoldersignerassociationRequestPatch.from_dict(obj.get("objEzsignfoldersignerassociation")) if obj.get("objEzsignfoldersignerassociation") is not None else None + _obj = cls.model_validate({ + "objEzsignfoldersignerassociation": EzsignfoldersignerassociationRequestPatch.from_dict(obj.get("objEzsignfoldersignerassociation")) if obj.get("objEzsignfoldersignerassociation") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignfoldersignerassociation_patch_object_v1_response.py b/eZmaxApi/models/ezsignfoldersignerassociation_patch_object_v1_response.py index 856deabf2..3091d5cc9 100644 --- a/eZmaxApi/models/ezsignfoldersignerassociation_patch_object_v1_response.py +++ b/eZmaxApi/models/ezsignfoldersignerassociation_patch_object_v1_response.py @@ -19,43 +19,61 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignfoldersignerassociationPatchObjectV1Response(BaseModel): """ - Response for PATCH /1/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociationID} # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - __properties = ["objDebugPayload", "objDebug"] + Response for PATCH /1/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociationID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignfoldersignerassociationPatchObjectV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignfoldersignerassociationPatchObjectV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -65,17 +83,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignfoldersignerassociationPatchObjectV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignfoldersignerassociationPatchObjectV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignfoldersignerassociationPatchObjectV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignfoldersignerassociationPatchObjectV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignfoldersignerassociation_request.py b/eZmaxApi/models/ezsignfoldersignerassociation_request.py index b4cd7cf0b..3b045351c 100644 --- a/eZmaxApi/models/ezsignfoldersignerassociation_request.py +++ b/eZmaxApi/models/ezsignfoldersignerassociation_request.py @@ -19,63 +19,82 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, StrictStr +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignfoldersignerassociationRequest(BaseModel): """ - An Ezsignfoldersignerassociation Object # noqa: E501 - """ - pki_ezsignfoldersignerassociation_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="pkiEzsignfoldersignerassociationID", description="The unique ID of the Ezsignfoldersignerassociation") - fki_user_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiUserID", description="The unique ID of the User") - fki_ezsignsignergroup_id: Optional[conint(strict=True, le=65535, ge=0)] = Field(None, alias="fkiEzsignsignergroupID", description="The unique ID of the Ezsignsignergroup") - fki_ezsignfolder_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsignfolderID", description="The unique ID of the Ezsignfolder") - b_ezsignfoldersignerassociation_receivecopy: Optional[StrictBool] = Field(None, alias="bEzsignfoldersignerassociationReceivecopy", description="If this flag is true. The signatory will receive a copy of every signed Ezsigndocument even if it ain't required to sign the document.") - t_ezsignfoldersignerassociation_message: Optional[StrictStr] = Field(None, alias="tEzsignfoldersignerassociationMessage", description="A custom text message that will be added to the email sent.") - __properties = ["pkiEzsignfoldersignerassociationID", "fkiUserID", "fkiEzsignsignergroupID", "fkiEzsignfolderID", "bEzsignfoldersignerassociationReceivecopy", "tEzsignfoldersignerassociationMessage"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + An Ezsignfoldersignerassociation Object + """ # noqa: E501 + pki_ezsignfoldersignerassociation_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsignfoldersignerassociation", alias="pkiEzsignfoldersignerassociationID") + fki_user_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the User", alias="fkiUserID") + fki_ezsignsignergroup_id: Optional[Annotated[int, Field(le=65535, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsignsignergroup", alias="fkiEzsignsignergroupID") + fki_ezsignfolder_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsignfolder", alias="fkiEzsignfolderID") + b_ezsignfoldersignerassociation_receivecopy: Optional[StrictBool] = Field(default=None, description="If this flag is true. The signatory will receive a copy of every signed Ezsigndocument even if it ain't required to sign the document.", alias="bEzsignfoldersignerassociationReceivecopy") + t_ezsignfoldersignerassociation_message: Optional[StrictStr] = Field(default=None, description="A custom text message that will be added to the email sent.", alias="tEzsignfoldersignerassociationMessage") + __properties: ClassVar[List[str]] = ["pkiEzsignfoldersignerassociationID", "fkiUserID", "fkiEzsignsignergroupID", "fkiEzsignfolderID", "bEzsignfoldersignerassociationReceivecopy", "tEzsignfoldersignerassociationMessage"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignfoldersignerassociationRequest: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignfoldersignerassociationRequest from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignfoldersignerassociationRequest: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignfoldersignerassociationRequest from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignfoldersignerassociationRequest.parse_obj(obj) - - _obj = EzsignfoldersignerassociationRequest.parse_obj({ - "pki_ezsignfoldersignerassociation_id": obj.get("pkiEzsignfoldersignerassociationID"), - "fki_user_id": obj.get("fkiUserID"), - "fki_ezsignsignergroup_id": obj.get("fkiEzsignsignergroupID"), - "fki_ezsignfolder_id": obj.get("fkiEzsignfolderID"), - "b_ezsignfoldersignerassociation_receivecopy": obj.get("bEzsignfoldersignerassociationReceivecopy"), - "t_ezsignfoldersignerassociation_message": obj.get("tEzsignfoldersignerassociationMessage") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsignfoldersignerassociationID": obj.get("pkiEzsignfoldersignerassociationID"), + "fkiUserID": obj.get("fkiUserID"), + "fkiEzsignsignergroupID": obj.get("fkiEzsignsignergroupID"), + "fkiEzsignfolderID": obj.get("fkiEzsignfolderID"), + "bEzsignfoldersignerassociationReceivecopy": obj.get("bEzsignfoldersignerassociationReceivecopy"), + "tEzsignfoldersignerassociationMessage": obj.get("tEzsignfoldersignerassociationMessage") }) return _obj diff --git a/eZmaxApi/models/ezsignfoldersignerassociation_request_compound.py b/eZmaxApi/models/ezsignfoldersignerassociation_request_compound.py index 6991a91e9..3235c0b6f 100644 --- a/eZmaxApi/models/ezsignfoldersignerassociation_request_compound.py +++ b/eZmaxApi/models/ezsignfoldersignerassociation_request_compound.py @@ -19,69 +19,88 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, StrictStr +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.ezsignsigner_request_compound import EzsignsignerRequestCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignfoldersignerassociationRequestCompound(BaseModel): """ - An Ezsignfoldersignerassociation Object and children to create a complete structure # noqa: E501 - """ - pki_ezsignfoldersignerassociation_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="pkiEzsignfoldersignerassociationID", description="The unique ID of the Ezsignfoldersignerassociation") - fki_user_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiUserID", description="The unique ID of the User") - fki_ezsignsignergroup_id: Optional[conint(strict=True, le=65535, ge=0)] = Field(None, alias="fkiEzsignsignergroupID", description="The unique ID of the Ezsignsignergroup") - fki_ezsignfolder_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsignfolderID", description="The unique ID of the Ezsignfolder") - b_ezsignfoldersignerassociation_receivecopy: Optional[StrictBool] = Field(None, alias="bEzsignfoldersignerassociationReceivecopy", description="If this flag is true. The signatory will receive a copy of every signed Ezsigndocument even if it ain't required to sign the document.") - t_ezsignfoldersignerassociation_message: Optional[StrictStr] = Field(None, alias="tEzsignfoldersignerassociationMessage", description="A custom text message that will be added to the email sent.") - obj_ezsignsigner: Optional[EzsignsignerRequestCompound] = Field(None, alias="objEzsignsigner") - __properties = ["pkiEzsignfoldersignerassociationID", "fkiUserID", "fkiEzsignsignergroupID", "fkiEzsignfolderID", "bEzsignfoldersignerassociationReceivecopy", "tEzsignfoldersignerassociationMessage", "objEzsignsigner"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + An Ezsignfoldersignerassociation Object and children to create a complete structure + """ # noqa: E501 + pki_ezsignfoldersignerassociation_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsignfoldersignerassociation", alias="pkiEzsignfoldersignerassociationID") + fki_user_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the User", alias="fkiUserID") + fki_ezsignsignergroup_id: Optional[Annotated[int, Field(le=65535, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsignsignergroup", alias="fkiEzsignsignergroupID") + fki_ezsignfolder_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsignfolder", alias="fkiEzsignfolderID") + b_ezsignfoldersignerassociation_receivecopy: Optional[StrictBool] = Field(default=None, description="If this flag is true. The signatory will receive a copy of every signed Ezsigndocument even if it ain't required to sign the document.", alias="bEzsignfoldersignerassociationReceivecopy") + t_ezsignfoldersignerassociation_message: Optional[StrictStr] = Field(default=None, description="A custom text message that will be added to the email sent.", alias="tEzsignfoldersignerassociationMessage") + obj_ezsignsigner: Optional[EzsignsignerRequestCompound] = Field(default=None, alias="objEzsignsigner") + __properties: ClassVar[List[str]] = ["pkiEzsignfoldersignerassociationID", "fkiUserID", "fkiEzsignsignergroupID", "fkiEzsignfolderID", "bEzsignfoldersignerassociationReceivecopy", "tEzsignfoldersignerassociationMessage", "objEzsignsigner"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignfoldersignerassociationRequestCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignfoldersignerassociationRequestCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_ezsignsigner if self.obj_ezsignsigner: _dict['objEzsignsigner'] = self.obj_ezsignsigner.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignfoldersignerassociationRequestCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignfoldersignerassociationRequestCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignfoldersignerassociationRequestCompound.parse_obj(obj) - - _obj = EzsignfoldersignerassociationRequestCompound.parse_obj({ - "pki_ezsignfoldersignerassociation_id": obj.get("pkiEzsignfoldersignerassociationID"), - "fki_user_id": obj.get("fkiUserID"), - "fki_ezsignsignergroup_id": obj.get("fkiEzsignsignergroupID"), - "fki_ezsignfolder_id": obj.get("fkiEzsignfolderID"), - "b_ezsignfoldersignerassociation_receivecopy": obj.get("bEzsignfoldersignerassociationReceivecopy"), - "t_ezsignfoldersignerassociation_message": obj.get("tEzsignfoldersignerassociationMessage"), - "obj_ezsignsigner": EzsignsignerRequestCompound.from_dict(obj.get("objEzsignsigner")) if obj.get("objEzsignsigner") is not None else None + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsignfoldersignerassociationID": obj.get("pkiEzsignfoldersignerassociationID"), + "fkiUserID": obj.get("fkiUserID"), + "fkiEzsignsignergroupID": obj.get("fkiEzsignsignergroupID"), + "fkiEzsignfolderID": obj.get("fkiEzsignfolderID"), + "bEzsignfoldersignerassociationReceivecopy": obj.get("bEzsignfoldersignerassociationReceivecopy"), + "tEzsignfoldersignerassociationMessage": obj.get("tEzsignfoldersignerassociationMessage"), + "objEzsignsigner": EzsignsignerRequestCompound.from_dict(obj.get("objEzsignsigner")) if obj.get("objEzsignsigner") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignfoldersignerassociation_request_patch.py b/eZmaxApi/models/ezsignfoldersignerassociation_request_patch.py index 2872d36ff..c20b4299b 100644 --- a/eZmaxApi/models/ezsignfoldersignerassociation_request_patch.py +++ b/eZmaxApi/models/ezsignfoldersignerassociation_request_patch.py @@ -19,53 +19,71 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictStr +from pydantic import Field +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignfoldersignerassociationRequestPatch(BaseModel): """ - An Ezsignfoldersignerassociation Object # noqa: E501 - """ - t_ezsignfoldersignerassociation_message: Optional[StrictStr] = Field(None, alias="tEzsignfoldersignerassociationMessage", description="A custom text message that will be added to the email sent.") - __properties = ["tEzsignfoldersignerassociationMessage"] + An Ezsignfoldersignerassociation Object + """ # noqa: E501 + t_ezsignfoldersignerassociation_message: Optional[StrictStr] = Field(default=None, description="A custom text message that will be added to the email sent.", alias="tEzsignfoldersignerassociationMessage") + __properties: ClassVar[List[str]] = ["tEzsignfoldersignerassociationMessage"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignfoldersignerassociationRequestPatch: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignfoldersignerassociationRequestPatch from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignfoldersignerassociationRequestPatch: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignfoldersignerassociationRequestPatch from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignfoldersignerassociationRequestPatch.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignfoldersignerassociationRequestPatch.parse_obj({ - "t_ezsignfoldersignerassociation_message": obj.get("tEzsignfoldersignerassociationMessage") + _obj = cls.model_validate({ + "tEzsignfoldersignerassociationMessage": obj.get("tEzsignfoldersignerassociationMessage") }) return _obj diff --git a/eZmaxApi/models/ezsignfoldersignerassociation_response.py b/eZmaxApi/models/ezsignfoldersignerassociation_response.py index 42734cb98..bce8f096b 100644 --- a/eZmaxApi/models/ezsignfoldersignerassociation_response.py +++ b/eZmaxApi/models/ezsignfoldersignerassociation_response.py @@ -19,61 +19,80 @@ import json - -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictBool, StrictStr +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignfoldersignerassociationResponse(BaseModel): """ - An Ezsignfoldersignerassociation Object # noqa: E501 - """ - pki_ezsignfoldersignerassociation_id: conint(strict=True, ge=0) = Field(..., alias="pkiEzsignfoldersignerassociationID", description="The unique ID of the Ezsignfoldersignerassociation") - fki_ezsignfolder_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsignfolderID", description="The unique ID of the Ezsignfolder") - b_ezsignfoldersignerassociation_delayedsend: StrictBool = Field(..., alias="bEzsignfoldersignerassociationDelayedsend", description="If this flag is true the signatory is part of a delayed send.") - b_ezsignfoldersignerassociation_receivecopy: StrictBool = Field(..., alias="bEzsignfoldersignerassociationReceivecopy", description="If this flag is true. The signatory will receive a copy of every signed Ezsigndocument even if it ain't required to sign the document.") - t_ezsignfoldersignerassociation_message: StrictStr = Field(..., alias="tEzsignfoldersignerassociationMessage", description="A custom text message that will be added to the email sent.") - __properties = ["pkiEzsignfoldersignerassociationID", "fkiEzsignfolderID", "bEzsignfoldersignerassociationDelayedsend", "bEzsignfoldersignerassociationReceivecopy", "tEzsignfoldersignerassociationMessage"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + An Ezsignfoldersignerassociation Object + """ # noqa: E501 + pki_ezsignfoldersignerassociation_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsignfoldersignerassociation", alias="pkiEzsignfoldersignerassociationID") + fki_ezsignfolder_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsignfolder", alias="fkiEzsignfolderID") + b_ezsignfoldersignerassociation_delayedsend: StrictBool = Field(description="If this flag is true the signatory is part of a delayed send.", alias="bEzsignfoldersignerassociationDelayedsend") + b_ezsignfoldersignerassociation_receivecopy: StrictBool = Field(description="If this flag is true. The signatory will receive a copy of every signed Ezsigndocument even if it ain't required to sign the document.", alias="bEzsignfoldersignerassociationReceivecopy") + t_ezsignfoldersignerassociation_message: StrictStr = Field(description="A custom text message that will be added to the email sent.", alias="tEzsignfoldersignerassociationMessage") + __properties: ClassVar[List[str]] = ["pkiEzsignfoldersignerassociationID", "fkiEzsignfolderID", "bEzsignfoldersignerassociationDelayedsend", "bEzsignfoldersignerassociationReceivecopy", "tEzsignfoldersignerassociationMessage"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignfoldersignerassociationResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignfoldersignerassociationResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignfoldersignerassociationResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignfoldersignerassociationResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignfoldersignerassociationResponse.parse_obj(obj) - - _obj = EzsignfoldersignerassociationResponse.parse_obj({ - "pki_ezsignfoldersignerassociation_id": obj.get("pkiEzsignfoldersignerassociationID"), - "fki_ezsignfolder_id": obj.get("fkiEzsignfolderID"), - "b_ezsignfoldersignerassociation_delayedsend": obj.get("bEzsignfoldersignerassociationDelayedsend"), - "b_ezsignfoldersignerassociation_receivecopy": obj.get("bEzsignfoldersignerassociationReceivecopy"), - "t_ezsignfoldersignerassociation_message": obj.get("tEzsignfoldersignerassociationMessage") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsignfoldersignerassociationID": obj.get("pkiEzsignfoldersignerassociationID"), + "fkiEzsignfolderID": obj.get("fkiEzsignfolderID"), + "bEzsignfoldersignerassociationDelayedsend": obj.get("bEzsignfoldersignerassociationDelayedsend"), + "bEzsignfoldersignerassociationReceivecopy": obj.get("bEzsignfoldersignerassociationReceivecopy"), + "tEzsignfoldersignerassociationMessage": obj.get("tEzsignfoldersignerassociationMessage") }) return _obj diff --git a/eZmaxApi/models/ezsignfoldersignerassociation_response_compound.py b/eZmaxApi/models/ezsignfoldersignerassociation_response_compound.py index bcebab763..e068c23d7 100644 --- a/eZmaxApi/models/ezsignfoldersignerassociation_response_compound.py +++ b/eZmaxApi/models/ezsignfoldersignerassociation_response_compound.py @@ -19,50 +19,69 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, StrictStr +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.ezsignfoldersignerassociation_response_compound_user import EzsignfoldersignerassociationResponseCompoundUser from eZmaxApi.models.ezsignsigner_response_compound import EzsignsignerResponseCompound from eZmaxApi.models.ezsignsignergroup_response_compound import EzsignsignergroupResponseCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignfoldersignerassociationResponseCompound(BaseModel): """ - An Ezsignfoldersignerassociation Object # noqa: E501 - """ - pki_ezsignfoldersignerassociation_id: conint(strict=True, ge=0) = Field(..., alias="pkiEzsignfoldersignerassociationID", description="The unique ID of the Ezsignfoldersignerassociation") - fki_ezsignfolder_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsignfolderID", description="The unique ID of the Ezsignfolder") - b_ezsignfoldersignerassociation_delayedsend: StrictBool = Field(..., alias="bEzsignfoldersignerassociationDelayedsend", description="If this flag is true the signatory is part of a delayed send.") - b_ezsignfoldersignerassociation_receivecopy: StrictBool = Field(..., alias="bEzsignfoldersignerassociationReceivecopy", description="If this flag is true. The signatory will receive a copy of every signed Ezsigndocument even if it ain't required to sign the document.") - t_ezsignfoldersignerassociation_message: StrictStr = Field(..., alias="tEzsignfoldersignerassociationMessage", description="A custom text message that will be added to the email sent.") - obj_ezsignsignergroup: Optional[EzsignsignergroupResponseCompound] = Field(None, alias="objEzsignsignergroup") - obj_user: Optional[EzsignfoldersignerassociationResponseCompoundUser] = Field(None, alias="objUser") - obj_ezsignsigner: Optional[EzsignsignerResponseCompound] = Field(None, alias="objEzsignsigner") - __properties = ["pkiEzsignfoldersignerassociationID", "fkiEzsignfolderID", "bEzsignfoldersignerassociationDelayedsend", "bEzsignfoldersignerassociationReceivecopy", "tEzsignfoldersignerassociationMessage", "objEzsignsignergroup", "objUser", "objEzsignsigner"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + An Ezsignfoldersignerassociation Object + """ # noqa: E501 + pki_ezsignfoldersignerassociation_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsignfoldersignerassociation", alias="pkiEzsignfoldersignerassociationID") + fki_ezsignfolder_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsignfolder", alias="fkiEzsignfolderID") + b_ezsignfoldersignerassociation_delayedsend: StrictBool = Field(description="If this flag is true the signatory is part of a delayed send.", alias="bEzsignfoldersignerassociationDelayedsend") + b_ezsignfoldersignerassociation_receivecopy: StrictBool = Field(description="If this flag is true. The signatory will receive a copy of every signed Ezsigndocument even if it ain't required to sign the document.", alias="bEzsignfoldersignerassociationReceivecopy") + t_ezsignfoldersignerassociation_message: StrictStr = Field(description="A custom text message that will be added to the email sent.", alias="tEzsignfoldersignerassociationMessage") + obj_ezsignsignergroup: Optional[EzsignsignergroupResponseCompound] = Field(default=None, alias="objEzsignsignergroup") + obj_user: Optional[EzsignfoldersignerassociationResponseCompoundUser] = Field(default=None, alias="objUser") + obj_ezsignsigner: Optional[EzsignsignerResponseCompound] = Field(default=None, alias="objEzsignsigner") + __properties: ClassVar[List[str]] = ["pkiEzsignfoldersignerassociationID", "fkiEzsignfolderID", "bEzsignfoldersignerassociationDelayedsend", "bEzsignfoldersignerassociationReceivecopy", "tEzsignfoldersignerassociationMessage", "objEzsignsignergroup", "objUser", "objEzsignsigner"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignfoldersignerassociationResponseCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignfoldersignerassociationResponseCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_ezsignsignergroup if self.obj_ezsignsignergroup: _dict['objEzsignsignergroup'] = self.obj_ezsignsignergroup.to_dict() @@ -75,23 +94,23 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignfoldersignerassociationResponseCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignfoldersignerassociationResponseCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignfoldersignerassociationResponseCompound.parse_obj(obj) - - _obj = EzsignfoldersignerassociationResponseCompound.parse_obj({ - "pki_ezsignfoldersignerassociation_id": obj.get("pkiEzsignfoldersignerassociationID"), - "fki_ezsignfolder_id": obj.get("fkiEzsignfolderID"), - "b_ezsignfoldersignerassociation_delayedsend": obj.get("bEzsignfoldersignerassociationDelayedsend"), - "b_ezsignfoldersignerassociation_receivecopy": obj.get("bEzsignfoldersignerassociationReceivecopy"), - "t_ezsignfoldersignerassociation_message": obj.get("tEzsignfoldersignerassociationMessage"), - "obj_ezsignsignergroup": EzsignsignergroupResponseCompound.from_dict(obj.get("objEzsignsignergroup")) if obj.get("objEzsignsignergroup") is not None else None, - "obj_user": EzsignfoldersignerassociationResponseCompoundUser.from_dict(obj.get("objUser")) if obj.get("objUser") is not None else None, - "obj_ezsignsigner": EzsignsignerResponseCompound.from_dict(obj.get("objEzsignsigner")) if obj.get("objEzsignsigner") is not None else None + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsignfoldersignerassociationID": obj.get("pkiEzsignfoldersignerassociationID"), + "fkiEzsignfolderID": obj.get("fkiEzsignfolderID"), + "bEzsignfoldersignerassociationDelayedsend": obj.get("bEzsignfoldersignerassociationDelayedsend"), + "bEzsignfoldersignerassociationReceivecopy": obj.get("bEzsignfoldersignerassociationReceivecopy"), + "tEzsignfoldersignerassociationMessage": obj.get("tEzsignfoldersignerassociationMessage"), + "objEzsignsignergroup": EzsignsignergroupResponseCompound.from_dict(obj.get("objEzsignsignergroup")) if obj.get("objEzsignsignergroup") is not None else None, + "objUser": EzsignfoldersignerassociationResponseCompoundUser.from_dict(obj.get("objUser")) if obj.get("objUser") is not None else None, + "objEzsignsigner": EzsignsignerResponseCompound.from_dict(obj.get("objEzsignsigner")) if obj.get("objEzsignsigner") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignfoldersignerassociation_response_compound_user.py b/eZmaxApi/models/ezsignfoldersignerassociation_response_compound_user.py index df668bdae..c70190e5b 100644 --- a/eZmaxApi/models/ezsignfoldersignerassociation_response_compound_user.py +++ b/eZmaxApi/models/ezsignfoldersignerassociation_response_compound_user.py @@ -19,61 +19,80 @@ import json - -from pydantic import BaseModel, Field, StrictStr, conint +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictStr +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignfoldersignerassociationResponseCompoundUser(BaseModel): """ - A Ezsignfoldersignerassociation->User Object and children to create a complete structure # noqa: E501 - """ - pki_user_id: conint(strict=True, ge=0) = Field(..., alias="pkiUserID", description="The unique ID of the User") - fki_language_id: conint(strict=True, le=2, ge=1) = Field(..., alias="fkiLanguageID", description="The unique ID of the Language. Valid values: |Value|Description| |-|-| |1|French| |2|English|") - s_user_firstname: StrictStr = Field(..., alias="sUserFirstname", description="The first name of the user") - s_user_lastname: StrictStr = Field(..., alias="sUserLastname", description="The last name of the user") - s_email_address: StrictStr = Field(..., alias="sEmailAddress", description="The email address.") - __properties = ["pkiUserID", "fkiLanguageID", "sUserFirstname", "sUserLastname", "sEmailAddress"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + A Ezsignfoldersignerassociation->User Object and children to create a complete structure + """ # noqa: E501 + pki_user_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the User", alias="pkiUserID") + fki_language_id: Annotated[int, Field(le=2, strict=True, ge=1)] = Field(description="The unique ID of the Language. Valid values: |Value|Description| |-|-| |1|French| |2|English|", alias="fkiLanguageID") + s_user_firstname: StrictStr = Field(description="The first name of the user", alias="sUserFirstname") + s_user_lastname: StrictStr = Field(description="The last name of the user", alias="sUserLastname") + s_email_address: StrictStr = Field(description="The email address.", alias="sEmailAddress") + __properties: ClassVar[List[str]] = ["pkiUserID", "fkiLanguageID", "sUserFirstname", "sUserLastname", "sEmailAddress"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignfoldersignerassociationResponseCompoundUser: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignfoldersignerassociationResponseCompoundUser from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignfoldersignerassociationResponseCompoundUser: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignfoldersignerassociationResponseCompoundUser from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignfoldersignerassociationResponseCompoundUser.parse_obj(obj) - - _obj = EzsignfoldersignerassociationResponseCompoundUser.parse_obj({ - "pki_user_id": obj.get("pkiUserID"), - "fki_language_id": obj.get("fkiLanguageID"), - "s_user_firstname": obj.get("sUserFirstname"), - "s_user_lastname": obj.get("sUserLastname"), - "s_email_address": obj.get("sEmailAddress") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiUserID": obj.get("pkiUserID"), + "fkiLanguageID": obj.get("fkiLanguageID"), + "sUserFirstname": obj.get("sUserFirstname"), + "sUserLastname": obj.get("sUserLastname"), + "sEmailAddress": obj.get("sEmailAddress") }) return _obj diff --git a/eZmaxApi/models/ezsignfoldertype_autocomplete_element_response.py b/eZmaxApi/models/ezsignfoldertype_autocomplete_element_response.py index 130ad8494..3f394ab12 100644 --- a/eZmaxApi/models/ezsignfoldertype_autocomplete_element_response.py +++ b/eZmaxApi/models/ezsignfoldertype_autocomplete_element_response.py @@ -19,60 +19,79 @@ import json - -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictBool, StrictStr +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.field_e_ezsignfoldertype_privacylevel import FieldEEzsignfoldertypePrivacylevel +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignfoldertypeAutocompleteElementResponse(BaseModel): """ - A Ezsignfoldertype AutocompleteElement Response # noqa: E501 - """ - e_ezsignfoldertype_privacylevel: FieldEEzsignfoldertypePrivacylevel = Field(..., alias="eEzsignfoldertypePrivacylevel") - s_ezsignfoldertype_name_x: StrictStr = Field(..., alias="sEzsignfoldertypeNameX", description="The name of the Ezsignfoldertype in the language of the requester") - pki_ezsignfoldertype_id: conint(strict=True, ge=0) = Field(..., alias="pkiEzsignfoldertypeID", description="The unique ID of the Ezsignfoldertype.") - b_ezsignfoldertype_isactive: StrictBool = Field(..., alias="bEzsignfoldertypeIsactive", description="Whether the Ezsignfoldertype is active or not") - __properties = ["eEzsignfoldertypePrivacylevel", "sEzsignfoldertypeNameX", "pkiEzsignfoldertypeID", "bEzsignfoldertypeIsactive"] + A Ezsignfoldertype AutocompleteElement Response + """ # noqa: E501 + e_ezsignfoldertype_privacylevel: FieldEEzsignfoldertypePrivacylevel = Field(alias="eEzsignfoldertypePrivacylevel") + s_ezsignfoldertype_name_x: StrictStr = Field(description="The name of the Ezsignfoldertype in the language of the requester", alias="sEzsignfoldertypeNameX") + pki_ezsignfoldertype_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsignfoldertype.", alias="pkiEzsignfoldertypeID") + b_ezsignfoldertype_isactive: StrictBool = Field(description="Whether the Ezsignfoldertype is active or not", alias="bEzsignfoldertypeIsactive") + __properties: ClassVar[List[str]] = ["eEzsignfoldertypePrivacylevel", "sEzsignfoldertypeNameX", "pkiEzsignfoldertypeID", "bEzsignfoldertypeIsactive"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignfoldertypeAutocompleteElementResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignfoldertypeAutocompleteElementResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignfoldertypeAutocompleteElementResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignfoldertypeAutocompleteElementResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignfoldertypeAutocompleteElementResponse.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignfoldertypeAutocompleteElementResponse.parse_obj({ - "e_ezsignfoldertype_privacylevel": obj.get("eEzsignfoldertypePrivacylevel"), - "s_ezsignfoldertype_name_x": obj.get("sEzsignfoldertypeNameX"), - "pki_ezsignfoldertype_id": obj.get("pkiEzsignfoldertypeID"), - "b_ezsignfoldertype_isactive": obj.get("bEzsignfoldertypeIsactive") + _obj = cls.model_validate({ + "eEzsignfoldertypePrivacylevel": obj.get("eEzsignfoldertypePrivacylevel"), + "sEzsignfoldertypeNameX": obj.get("sEzsignfoldertypeNameX"), + "pkiEzsignfoldertypeID": obj.get("pkiEzsignfoldertypeID"), + "bEzsignfoldertypeIsactive": obj.get("bEzsignfoldertypeIsactive") }) return _obj diff --git a/eZmaxApi/models/ezsignfoldertype_create_object_v1_request.py b/eZmaxApi/models/ezsignfoldertype_create_object_v1_request.py index 3390d232b..ef41159c0 100644 --- a/eZmaxApi/models/ezsignfoldertype_create_object_v1_request.py +++ b/eZmaxApi/models/ezsignfoldertype_create_object_v1_request.py @@ -19,41 +19,60 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.ezsignfoldertype_request_compound import EzsignfoldertypeRequestCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignfoldertypeCreateObjectV1Request(BaseModel): """ - Request for POST /1/object/ezsignfoldertype # noqa: E501 - """ - a_obj_ezsignfoldertype: conlist(EzsignfoldertypeRequestCompound, min_items=1) = Field(..., alias="a_objEzsignfoldertype") - __properties = ["a_objEzsignfoldertype"] + Request for POST /1/object/ezsignfoldertype + """ # noqa: E501 + a_obj_ezsignfoldertype: Annotated[List[EzsignfoldertypeRequestCompound], Field(min_length=1)] = Field(alias="a_objEzsignfoldertype") + __properties: ClassVar[List[str]] = ["a_objEzsignfoldertype"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignfoldertypeCreateObjectV1Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignfoldertypeCreateObjectV1Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_ezsignfoldertype (list) _items = [] if self.a_obj_ezsignfoldertype: @@ -64,16 +83,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignfoldertypeCreateObjectV1Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignfoldertypeCreateObjectV1Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignfoldertypeCreateObjectV1Request.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignfoldertypeCreateObjectV1Request.parse_obj({ - "a_obj_ezsignfoldertype": [EzsignfoldertypeRequestCompound.from_dict(_item) for _item in obj.get("a_objEzsignfoldertype")] if obj.get("a_objEzsignfoldertype") is not None else None + _obj = cls.model_validate({ + "a_objEzsignfoldertype": [EzsignfoldertypeRequestCompound.from_dict(_item) for _item in obj.get("a_objEzsignfoldertype")] if obj.get("a_objEzsignfoldertype") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignfoldertype_create_object_v1_response.py b/eZmaxApi/models/ezsignfoldertype_create_object_v1_response.py index aed3bf37f..b17049c61 100644 --- a/eZmaxApi/models/ezsignfoldertype_create_object_v1_response.py +++ b/eZmaxApi/models/ezsignfoldertype_create_object_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.ezsignfoldertype_create_object_v1_response_m_payload import EzsignfoldertypeCreateObjectV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignfoldertypeCreateObjectV1Response(BaseModel): """ - Response for POST /1/object/ezsignfoldertype # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzsignfoldertypeCreateObjectV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for POST /1/object/ezsignfoldertype + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsignfoldertypeCreateObjectV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignfoldertypeCreateObjectV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignfoldertypeCreateObjectV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignfoldertypeCreateObjectV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignfoldertypeCreateObjectV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignfoldertypeCreateObjectV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignfoldertypeCreateObjectV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzsignfoldertypeCreateObjectV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsignfoldertypeCreateObjectV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignfoldertype_create_object_v1_response_m_payload.py b/eZmaxApi/models/ezsignfoldertype_create_object_v1_response_m_payload.py index 4afbf83db..6a8b69acc 100644 --- a/eZmaxApi/models/ezsignfoldertype_create_object_v1_response_m_payload.py +++ b/eZmaxApi/models/ezsignfoldertype_create_object_v1_response_m_payload.py @@ -19,53 +19,72 @@ import json -from typing import List -from pydantic import BaseModel, Field, conint, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignfoldertypeCreateObjectV1ResponseMPayload(BaseModel): """ - Payload for POST /1/object/ezsignfoldertype # noqa: E501 - """ - a_pki_ezsignfoldertype_id: conlist(conint(strict=True, ge=0), min_items=1) = Field(..., alias="a_pkiEzsignfoldertypeID", description="An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request.") - __properties = ["a_pkiEzsignfoldertypeID"] + Payload for POST /1/object/ezsignfoldertype + """ # noqa: E501 + a_pki_ezsignfoldertype_id: Annotated[List[Annotated[int, Field(strict=True, ge=0)]], Field(min_length=1)] = Field(description="An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request.", alias="a_pkiEzsignfoldertypeID") + __properties: ClassVar[List[str]] = ["a_pkiEzsignfoldertypeID"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignfoldertypeCreateObjectV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignfoldertypeCreateObjectV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignfoldertypeCreateObjectV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignfoldertypeCreateObjectV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignfoldertypeCreateObjectV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignfoldertypeCreateObjectV1ResponseMPayload.parse_obj({ - "a_pki_ezsignfoldertype_id": obj.get("a_pkiEzsignfoldertypeID") + _obj = cls.model_validate({ + "a_pkiEzsignfoldertypeID": obj.get("a_pkiEzsignfoldertypeID") }) return _obj diff --git a/eZmaxApi/models/ezsignfoldertype_edit_object_v1_request.py b/eZmaxApi/models/ezsignfoldertype_edit_object_v1_request.py index 9c6c053d0..2020bbf19 100644 --- a/eZmaxApi/models/ezsignfoldertype_edit_object_v1_request.py +++ b/eZmaxApi/models/ezsignfoldertype_edit_object_v1_request.py @@ -19,57 +19,75 @@ import json - -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.ezsignfoldertype_request_compound import EzsignfoldertypeRequestCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignfoldertypeEditObjectV1Request(BaseModel): """ - Request for PUT /1/object/ezsignfoldertype/{pkiEzsignfoldertypeID} # noqa: E501 - """ - obj_ezsignfoldertype: EzsignfoldertypeRequestCompound = Field(..., alias="objEzsignfoldertype") - __properties = ["objEzsignfoldertype"] + Request for PUT /1/object/ezsignfoldertype/{pkiEzsignfoldertypeID} + """ # noqa: E501 + obj_ezsignfoldertype: EzsignfoldertypeRequestCompound = Field(alias="objEzsignfoldertype") + __properties: ClassVar[List[str]] = ["objEzsignfoldertype"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignfoldertypeEditObjectV1Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignfoldertypeEditObjectV1Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_ezsignfoldertype if self.obj_ezsignfoldertype: _dict['objEzsignfoldertype'] = self.obj_ezsignfoldertype.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignfoldertypeEditObjectV1Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignfoldertypeEditObjectV1Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignfoldertypeEditObjectV1Request.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignfoldertypeEditObjectV1Request.parse_obj({ - "obj_ezsignfoldertype": EzsignfoldertypeRequestCompound.from_dict(obj.get("objEzsignfoldertype")) if obj.get("objEzsignfoldertype") is not None else None + _obj = cls.model_validate({ + "objEzsignfoldertype": EzsignfoldertypeRequestCompound.from_dict(obj.get("objEzsignfoldertype")) if obj.get("objEzsignfoldertype") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignfoldertype_edit_object_v1_response.py b/eZmaxApi/models/ezsignfoldertype_edit_object_v1_response.py index 53f6087ba..0c58b08dd 100644 --- a/eZmaxApi/models/ezsignfoldertype_edit_object_v1_response.py +++ b/eZmaxApi/models/ezsignfoldertype_edit_object_v1_response.py @@ -19,43 +19,61 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignfoldertypeEditObjectV1Response(BaseModel): """ - Response for PUT /1/object/ezsignfoldertype/{pkiEzsignfoldertypeID} # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - __properties = ["objDebugPayload", "objDebug"] + Response for PUT /1/object/ezsignfoldertype/{pkiEzsignfoldertypeID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignfoldertypeEditObjectV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignfoldertypeEditObjectV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -65,17 +83,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignfoldertypeEditObjectV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignfoldertypeEditObjectV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignfoldertypeEditObjectV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignfoldertypeEditObjectV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignfoldertype_get_autocomplete_v2_response.py b/eZmaxApi/models/ezsignfoldertype_get_autocomplete_v2_response.py index 7de51dbd9..3bd44e99d 100644 --- a/eZmaxApi/models/ezsignfoldertype_get_autocomplete_v2_response.py +++ b/eZmaxApi/models/ezsignfoldertype_get_autocomplete_v2_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.ezsignfoldertype_get_autocomplete_v2_response_m_payload import EzsignfoldertypeGetAutocompleteV2ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignfoldertypeGetAutocompleteV2Response(BaseModel): """ - Response for GET /2/object/ezsignfoldertype/getAutocomplete # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzsignfoldertypeGetAutocompleteV2ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /2/object/ezsignfoldertype/getAutocomplete + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsignfoldertypeGetAutocompleteV2ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignfoldertypeGetAutocompleteV2Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignfoldertypeGetAutocompleteV2Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignfoldertypeGetAutocompleteV2Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignfoldertypeGetAutocompleteV2Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignfoldertypeGetAutocompleteV2Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignfoldertypeGetAutocompleteV2Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzsignfoldertypeGetAutocompleteV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsignfoldertypeGetAutocompleteV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignfoldertype_get_autocomplete_v2_response_m_payload.py b/eZmaxApi/models/ezsignfoldertype_get_autocomplete_v2_response_m_payload.py index b7a91fce9..935cda13c 100644 --- a/eZmaxApi/models/ezsignfoldertype_get_autocomplete_v2_response_m_payload.py +++ b/eZmaxApi/models/ezsignfoldertype_get_autocomplete_v2_response_m_payload.py @@ -19,41 +19,59 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.ezsignfoldertype_autocomplete_element_response import EzsignfoldertypeAutocompleteElementResponse +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignfoldertypeGetAutocompleteV2ResponseMPayload(BaseModel): """ - Payload for POST /2/object/ezsignfoldertype/getAutocomplete # noqa: E501 - """ - a_obj_ezsignfoldertype: conlist(EzsignfoldertypeAutocompleteElementResponse) = Field(..., alias="a_objEzsignfoldertype", description="An array of Ezsignfoldertype autocomplete element response.") - __properties = ["a_objEzsignfoldertype"] + Payload for POST /2/object/ezsignfoldertype/getAutocomplete + """ # noqa: E501 + a_obj_ezsignfoldertype: List[EzsignfoldertypeAutocompleteElementResponse] = Field(description="An array of Ezsignfoldertype autocomplete element response.", alias="a_objEzsignfoldertype") + __properties: ClassVar[List[str]] = ["a_objEzsignfoldertype"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignfoldertypeGetAutocompleteV2ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignfoldertypeGetAutocompleteV2ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_ezsignfoldertype (list) _items = [] if self.a_obj_ezsignfoldertype: @@ -64,16 +82,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignfoldertypeGetAutocompleteV2ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignfoldertypeGetAutocompleteV2ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignfoldertypeGetAutocompleteV2ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignfoldertypeGetAutocompleteV2ResponseMPayload.parse_obj({ - "a_obj_ezsignfoldertype": [EzsignfoldertypeAutocompleteElementResponse.from_dict(_item) for _item in obj.get("a_objEzsignfoldertype")] if obj.get("a_objEzsignfoldertype") is not None else None + _obj = cls.model_validate({ + "a_objEzsignfoldertype": [EzsignfoldertypeAutocompleteElementResponse.from_dict(_item) for _item in obj.get("a_objEzsignfoldertype")] if obj.get("a_objEzsignfoldertype") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignfoldertype_get_list_v1_response.py b/eZmaxApi/models/ezsignfoldertype_get_list_v1_response.py index 55bd629fd..2996271eb 100644 --- a/eZmaxApi/models/ezsignfoldertype_get_list_v1_response.py +++ b/eZmaxApi/models/ezsignfoldertype_get_list_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload_get_list import CommonResponseObjDebugPayloadGetList from eZmaxApi.models.ezsignfoldertype_get_list_v1_response_m_payload import EzsignfoldertypeGetListV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignfoldertypeGetListV1Response(BaseModel): """ - Response for GET /1/object/ezsignfoldertype/getList # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayloadGetList = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzsignfoldertypeGetListV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /1/object/ezsignfoldertype/getList + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayloadGetList = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsignfoldertypeGetListV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignfoldertypeGetListV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignfoldertypeGetListV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignfoldertypeGetListV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignfoldertypeGetListV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignfoldertypeGetListV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignfoldertypeGetListV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayloadGetList.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzsignfoldertypeGetListV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayloadGetList.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsignfoldertypeGetListV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignfoldertype_get_list_v1_response_m_payload.py b/eZmaxApi/models/ezsignfoldertype_get_list_v1_response_m_payload.py index 924e02e4a..e3a94d368 100644 --- a/eZmaxApi/models/ezsignfoldertype_get_list_v1_response_m_payload.py +++ b/eZmaxApi/models/ezsignfoldertype_get_list_v1_response_m_payload.py @@ -19,43 +19,61 @@ import json -from typing import List -from pydantic import BaseModel, Field, StrictInt, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictInt +from pydantic import Field from eZmaxApi.models.ezsignfoldertype_list_element import EzsignfoldertypeListElement +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignfoldertypeGetListV1ResponseMPayload(BaseModel): """ - Payload for GET /1/object/ezsignfoldertype/getList # noqa: E501 - """ - i_row_returned: StrictInt = Field(..., alias="iRowReturned", description="The number of rows returned") - i_row_filtered: StrictInt = Field(..., alias="iRowFiltered", description="The number of rows matching your filters (if any) or the total number of rows") - a_obj_ezsignfoldertype: conlist(EzsignfoldertypeListElement) = Field(..., alias="a_objEzsignfoldertype") - __properties = ["iRowReturned", "iRowFiltered", "a_objEzsignfoldertype"] + Payload for GET /1/object/ezsignfoldertype/getList + """ # noqa: E501 + i_row_returned: StrictInt = Field(description="The number of rows returned", alias="iRowReturned") + i_row_filtered: StrictInt = Field(description="The number of rows matching your filters (if any) or the total number of rows", alias="iRowFiltered") + a_obj_ezsignfoldertype: List[EzsignfoldertypeListElement] = Field(alias="a_objEzsignfoldertype") + __properties: ClassVar[List[str]] = ["iRowReturned", "iRowFiltered", "a_objEzsignfoldertype"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignfoldertypeGetListV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignfoldertypeGetListV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_ezsignfoldertype (list) _items = [] if self.a_obj_ezsignfoldertype: @@ -66,18 +84,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignfoldertypeGetListV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignfoldertypeGetListV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignfoldertypeGetListV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignfoldertypeGetListV1ResponseMPayload.parse_obj({ - "i_row_returned": obj.get("iRowReturned"), - "i_row_filtered": obj.get("iRowFiltered"), - "a_obj_ezsignfoldertype": [EzsignfoldertypeListElement.from_dict(_item) for _item in obj.get("a_objEzsignfoldertype")] if obj.get("a_objEzsignfoldertype") is not None else None + _obj = cls.model_validate({ + "iRowReturned": obj.get("iRowReturned"), + "iRowFiltered": obj.get("iRowFiltered"), + "a_objEzsignfoldertype": [EzsignfoldertypeListElement.from_dict(_item) for _item in obj.get("a_objEzsignfoldertype")] if obj.get("a_objEzsignfoldertype") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignfoldertype_get_object_v2_response.py b/eZmaxApi/models/ezsignfoldertype_get_object_v2_response.py index 2346eb64e..e7abee2f3 100644 --- a/eZmaxApi/models/ezsignfoldertype_get_object_v2_response.py +++ b/eZmaxApi/models/ezsignfoldertype_get_object_v2_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.ezsignfoldertype_get_object_v2_response_m_payload import EzsignfoldertypeGetObjectV2ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignfoldertypeGetObjectV2Response(BaseModel): """ - Response for GET /2/object/ezsignfoldertype/{pkiEzsignfoldertypeID} # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzsignfoldertypeGetObjectV2ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /2/object/ezsignfoldertype/{pkiEzsignfoldertypeID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsignfoldertypeGetObjectV2ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignfoldertypeGetObjectV2Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignfoldertypeGetObjectV2Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignfoldertypeGetObjectV2Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignfoldertypeGetObjectV2Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignfoldertypeGetObjectV2Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignfoldertypeGetObjectV2Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzsignfoldertypeGetObjectV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsignfoldertypeGetObjectV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignfoldertype_get_object_v2_response_m_payload.py b/eZmaxApi/models/ezsignfoldertype_get_object_v2_response_m_payload.py index 0833f07b4..f9c056f84 100644 --- a/eZmaxApi/models/ezsignfoldertype_get_object_v2_response_m_payload.py +++ b/eZmaxApi/models/ezsignfoldertype_get_object_v2_response_m_payload.py @@ -19,57 +19,75 @@ import json - -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.ezsignfoldertype_response_compound import EzsignfoldertypeResponseCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignfoldertypeGetObjectV2ResponseMPayload(BaseModel): """ - Payload for GET /2/object/ezsignfoldertype/{pkiEzsignfoldertypeID} # noqa: E501 - """ - obj_ezsignfoldertype: EzsignfoldertypeResponseCompound = Field(..., alias="objEzsignfoldertype") - __properties = ["objEzsignfoldertype"] + Payload for GET /2/object/ezsignfoldertype/{pkiEzsignfoldertypeID} + """ # noqa: E501 + obj_ezsignfoldertype: EzsignfoldertypeResponseCompound = Field(alias="objEzsignfoldertype") + __properties: ClassVar[List[str]] = ["objEzsignfoldertype"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignfoldertypeGetObjectV2ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignfoldertypeGetObjectV2ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_ezsignfoldertype if self.obj_ezsignfoldertype: _dict['objEzsignfoldertype'] = self.obj_ezsignfoldertype.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignfoldertypeGetObjectV2ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignfoldertypeGetObjectV2ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignfoldertypeGetObjectV2ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignfoldertypeGetObjectV2ResponseMPayload.parse_obj({ - "obj_ezsignfoldertype": EzsignfoldertypeResponseCompound.from_dict(obj.get("objEzsignfoldertype")) if obj.get("objEzsignfoldertype") is not None else None + _obj = cls.model_validate({ + "objEzsignfoldertype": EzsignfoldertypeResponseCompound.from_dict(obj.get("objEzsignfoldertype")) if obj.get("objEzsignfoldertype") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignfoldertype_list_element.py b/eZmaxApi/models/ezsignfoldertype_list_element.py index 0bcf15045..ab3dcc68b 100644 --- a/eZmaxApi/models/ezsignfoldertype_list_element.py +++ b/eZmaxApi/models/ezsignfoldertype_list_element.py @@ -19,60 +19,79 @@ import json - -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictBool, StrictStr +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.field_e_ezsignfoldertype_privacylevel import FieldEEzsignfoldertypePrivacylevel +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignfoldertypeListElement(BaseModel): """ - An Ezsignfoldertype List Element # noqa: E501 - """ - pki_ezsignfoldertype_id: conint(strict=True, ge=0) = Field(..., alias="pkiEzsignfoldertypeID", description="The unique ID of the Ezsignfoldertype.") - e_ezsignfoldertype_privacylevel: FieldEEzsignfoldertypePrivacylevel = Field(..., alias="eEzsignfoldertypePrivacylevel") - s_ezsignfoldertype_name_x: StrictStr = Field(..., alias="sEzsignfoldertypeNameX", description="The name of the Ezsignfoldertype in the language of the requester") - b_ezsignfoldertype_isactive: StrictBool = Field(..., alias="bEzsignfoldertypeIsactive", description="Whether the Ezsignfoldertype is active or not") - __properties = ["pkiEzsignfoldertypeID", "eEzsignfoldertypePrivacylevel", "sEzsignfoldertypeNameX", "bEzsignfoldertypeIsactive"] + An Ezsignfoldertype List Element + """ # noqa: E501 + pki_ezsignfoldertype_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsignfoldertype.", alias="pkiEzsignfoldertypeID") + e_ezsignfoldertype_privacylevel: FieldEEzsignfoldertypePrivacylevel = Field(alias="eEzsignfoldertypePrivacylevel") + s_ezsignfoldertype_name_x: StrictStr = Field(description="The name of the Ezsignfoldertype in the language of the requester", alias="sEzsignfoldertypeNameX") + b_ezsignfoldertype_isactive: StrictBool = Field(description="Whether the Ezsignfoldertype is active or not", alias="bEzsignfoldertypeIsactive") + __properties: ClassVar[List[str]] = ["pkiEzsignfoldertypeID", "eEzsignfoldertypePrivacylevel", "sEzsignfoldertypeNameX", "bEzsignfoldertypeIsactive"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignfoldertypeListElement: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignfoldertypeListElement from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignfoldertypeListElement: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignfoldertypeListElement from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignfoldertypeListElement.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignfoldertypeListElement.parse_obj({ - "pki_ezsignfoldertype_id": obj.get("pkiEzsignfoldertypeID"), - "e_ezsignfoldertype_privacylevel": obj.get("eEzsignfoldertypePrivacylevel"), - "s_ezsignfoldertype_name_x": obj.get("sEzsignfoldertypeNameX"), - "b_ezsignfoldertype_isactive": obj.get("bEzsignfoldertypeIsactive") + _obj = cls.model_validate({ + "pkiEzsignfoldertypeID": obj.get("pkiEzsignfoldertypeID"), + "eEzsignfoldertypePrivacylevel": obj.get("eEzsignfoldertypePrivacylevel"), + "sEzsignfoldertypeNameX": obj.get("sEzsignfoldertypeNameX"), + "bEzsignfoldertypeIsactive": obj.get("bEzsignfoldertypeIsactive") }) return _obj diff --git a/eZmaxApi/models/ezsignfoldertype_request.py b/eZmaxApi/models/ezsignfoldertype_request.py index 24abcfa23..012d048e1 100644 --- a/eZmaxApi/models/ezsignfoldertype_request.py +++ b/eZmaxApi/models/ezsignfoldertype_request.py @@ -19,120 +19,159 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, StrictStr +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.field_e_ezsignfoldertype_disposal import FieldEEzsignfoldertypeDisposal from eZmaxApi.models.field_e_ezsignfoldertype_privacylevel import FieldEEzsignfoldertypePrivacylevel from eZmaxApi.models.field_e_ezsignfoldertype_sendreminderfrequency import FieldEEzsignfoldertypeSendreminderfrequency from eZmaxApi.models.multilingual_ezsignfoldertype_name import MultilingualEzsignfoldertypeName +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignfoldertypeRequest(BaseModel): """ - A Ezsignfoldertype Object # noqa: E501 - """ - pki_ezsignfoldertype_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="pkiEzsignfoldertypeID", description="The unique ID of the Ezsignfoldertype.") - obj_ezsignfoldertype_name: MultilingualEzsignfoldertypeName = Field(..., alias="objEzsignfoldertypeName") - fki_branding_id: conint(strict=True, ge=0) = Field(..., alias="fkiBrandingID", description="The unique ID of the Branding") - fki_billingentityinternal_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiBillingentityinternalID", description="The unique ID of the Billingentityinternal.") - fki_usergroup_id: Optional[conint(strict=True, le=255, ge=0)] = Field(None, alias="fkiUsergroupID", description="The unique ID of the Usergroup") - fki_usergroup_id_restricted: Optional[conint(strict=True, le=255, ge=0)] = Field(None, alias="fkiUsergroupIDRestricted", description="The unique ID of the Usergroup") - fki_ezsigntsarequirement_id: Optional[conint(strict=True, le=3, ge=1)] = Field(None, alias="fkiEzsigntsarequirementID", description="The unique ID of the Ezsigntsarequirement. Determine if a Time Stamping Authority should add a timestamp on each of the signature. Valid values: |Value|Description| |-|-| |1|No. TSA Timestamping will requested. This will make all signatures a lot faster since no round-trip to the TSA server will be required. Timestamping will be made using eZsign server's time.| |2|Best effort. Timestamping from a Time Stamping Authority will be requested but is not mandatory. In the very improbable case it cannot be completed, the timestamping will be made using eZsign server's time. **Additional fee applies**| |3|Mandatory. Timestamping from a Time Stamping Authority will be requested and is mandatory. In the very improbable case it cannot be completed, the signature will fail and the user will be asked to retry. **Additional fee applies**|") - s_email_address_signed: Optional[StrictStr] = Field(None, alias="sEmailAddressSigned", description="The email address.") - s_email_address_summary: Optional[StrictStr] = Field(None, alias="sEmailAddressSummary", description="The email address.") - e_ezsignfoldertype_privacylevel: FieldEEzsignfoldertypePrivacylevel = Field(..., alias="eEzsignfoldertypePrivacylevel") - e_ezsignfoldertype_sendreminderfrequency: Optional[FieldEEzsignfoldertypeSendreminderfrequency] = Field(None, alias="eEzsignfoldertypeSendreminderfrequency") - i_ezsignfoldertype_archivaldays: conint(strict=True, le=180, ge=0) = Field(..., alias="iEzsignfoldertypeArchivaldays", description="The number of days before the archival of Ezsignfolders created using this Ezsignfoldertype") - e_ezsignfoldertype_disposal: FieldEEzsignfoldertypeDisposal = Field(..., alias="eEzsignfoldertypeDisposal") - i_ezsignfoldertype_disposaldays: Optional[conint(strict=True, le=9999, ge=0)] = Field(None, alias="iEzsignfoldertypeDisposaldays", description="The number of days after the archival before the disposal of the Ezsignfolder") - i_ezsignfoldertype_deadlinedays: conint(strict=True, le=60, ge=1) = Field(..., alias="iEzsignfoldertypeDeadlinedays", description="The number of days to get all Ezsignsignatures") - b_ezsignfoldertype_delegate: Optional[StrictBool] = Field(None, alias="bEzsignfoldertypeDelegate", description="Wheter if delegation of signature is allowed to another user or not") - b_ezsignfoldertype_reassign: Optional[StrictBool] = Field(None, alias="bEzsignfoldertypeReassign", description="Wheter if Reassignment of signature is allowed to another signatory or not") - b_ezsignfoldertype_sendattatchmentsigner: StrictBool = Field(..., alias="bEzsignfoldertypeSendattatchmentsigner", description="Whether we send the Ezsigndocument and the proof as attachment in the email") - b_ezsignfoldertype_sendsignedtodocumentowner: StrictBool = Field(..., alias="bEzsignfoldertypeSendsignedtodocumentowner", description="Whether we send the signed Ezsigndocument to the Ezsigndocument's owner") - b_ezsignfoldertype_sendsignedtofolderowner: StrictBool = Field(..., alias="bEzsignfoldertypeSendsignedtofolderowner", description="Whether we send the signed Ezsigndocument to the Ezsignfolder's owner") - b_ezsignfoldertype_sendsignedtofullgroup: Optional[StrictBool] = Field(None, alias="bEzsignfoldertypeSendsignedtofullgroup", description="Whether we send the signed Ezsigndocument to the Usergroup that has acces to all Ezsignfolders") - b_ezsignfoldertype_sendsignedtolimitedgroup: Optional[StrictBool] = Field(None, alias="bEzsignfoldertypeSendsignedtolimitedgroup", description="Whether we send the signed Ezsigndocument to the Usergroup that has acces to only their own Ezsignfolders") - b_ezsignfoldertype_sendsignedtocolleague: StrictBool = Field(..., alias="bEzsignfoldertypeSendsignedtocolleague", description="Whether we send the signed Ezsigndocument to the colleagues") - b_ezsignfoldertype_sendsummarytodocumentowner: StrictBool = Field(..., alias="bEzsignfoldertypeSendsummarytodocumentowner", description="Whether we send the summary to the Ezsigndocument's owner") - b_ezsignfoldertype_sendsummarytofolderowner: StrictBool = Field(..., alias="bEzsignfoldertypeSendsummarytofolderowner", description="Whether we send the summary to the Ezsignfolder's owner") - b_ezsignfoldertype_sendsummarytofullgroup: Optional[StrictBool] = Field(None, alias="bEzsignfoldertypeSendsummarytofullgroup", description="Whether we send the summary to the Usergroup that has acces to all Ezsignfolders") - b_ezsignfoldertype_sendsummarytolimitedgroup: Optional[StrictBool] = Field(None, alias="bEzsignfoldertypeSendsummarytolimitedgroup", description="Whether we send the summary to the Usergroup that has acces to only their own Ezsignfolders") - b_ezsignfoldertype_sendsummarytocolleague: StrictBool = Field(..., alias="bEzsignfoldertypeSendsummarytocolleague", description="Whether we send the summary to the colleagues") - b_ezsignfoldertype_includeproofsigner: StrictBool = Field(..., alias="bEzsignfoldertypeIncludeproofsigner", description="Whether we include the proof with the signed Ezsigndocument for Ezsignsigners") - b_ezsignfoldertype_includeproofuser: StrictBool = Field(..., alias="bEzsignfoldertypeIncludeproofuser", description="Whether we include the proof with the signed Ezsigndocument for users") - b_ezsignfoldertype_isactive: StrictBool = Field(..., alias="bEzsignfoldertypeIsactive", description="Whether the Ezsignfoldertype is active or not") - __properties = ["pkiEzsignfoldertypeID", "objEzsignfoldertypeName", "fkiBrandingID", "fkiBillingentityinternalID", "fkiUsergroupID", "fkiUsergroupIDRestricted", "fkiEzsigntsarequirementID", "sEmailAddressSigned", "sEmailAddressSummary", "eEzsignfoldertypePrivacylevel", "eEzsignfoldertypeSendreminderfrequency", "iEzsignfoldertypeArchivaldays", "eEzsignfoldertypeDisposal", "iEzsignfoldertypeDisposaldays", "iEzsignfoldertypeDeadlinedays", "bEzsignfoldertypeDelegate", "bEzsignfoldertypeReassign", "bEzsignfoldertypeSendattatchmentsigner", "bEzsignfoldertypeSendsignedtodocumentowner", "bEzsignfoldertypeSendsignedtofolderowner", "bEzsignfoldertypeSendsignedtofullgroup", "bEzsignfoldertypeSendsignedtolimitedgroup", "bEzsignfoldertypeSendsignedtocolleague", "bEzsignfoldertypeSendsummarytodocumentowner", "bEzsignfoldertypeSendsummarytofolderowner", "bEzsignfoldertypeSendsummarytofullgroup", "bEzsignfoldertypeSendsummarytolimitedgroup", "bEzsignfoldertypeSendsummarytocolleague", "bEzsignfoldertypeIncludeproofsigner", "bEzsignfoldertypeIncludeproofuser", "bEzsignfoldertypeIsactive"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + A Ezsignfoldertype Object + """ # noqa: E501 + pki_ezsignfoldertype_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsignfoldertype.", alias="pkiEzsignfoldertypeID") + obj_ezsignfoldertype_name: MultilingualEzsignfoldertypeName = Field(alias="objEzsignfoldertypeName") + fki_branding_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Branding", alias="fkiBrandingID") + fki_billingentityinternal_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Billingentityinternal.", alias="fkiBillingentityinternalID") + fki_usergroup_id: Optional[Annotated[int, Field(le=255, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Usergroup", alias="fkiUsergroupID") + fki_usergroup_id_restricted: Optional[Annotated[int, Field(le=255, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Usergroup", alias="fkiUsergroupIDRestricted") + fki_ezsigntsarequirement_id: Optional[Annotated[int, Field(le=3, strict=True, ge=1)]] = Field(default=None, description="The unique ID of the Ezsigntsarequirement. Determine if a Time Stamping Authority should add a timestamp on each of the signature. Valid values: |Value|Description| |-|-| |1|No. TSA Timestamping will requested. This will make all signatures a lot faster since no round-trip to the TSA server will be required. Timestamping will be made using eZsign server's time.| |2|Best effort. Timestamping from a Time Stamping Authority will be requested but is not mandatory. In the very improbable case it cannot be completed, the timestamping will be made using eZsign server's time. **Additional fee applies**| |3|Mandatory. Timestamping from a Time Stamping Authority will be requested and is mandatory. In the very improbable case it cannot be completed, the signature will fail and the user will be asked to retry. **Additional fee applies**|", alias="fkiEzsigntsarequirementID") + s_email_address_signed: Optional[StrictStr] = Field(default=None, description="The email address.", alias="sEmailAddressSigned") + s_email_address_summary: Optional[StrictStr] = Field(default=None, description="The email address.", alias="sEmailAddressSummary") + e_ezsignfoldertype_privacylevel: FieldEEzsignfoldertypePrivacylevel = Field(alias="eEzsignfoldertypePrivacylevel") + e_ezsignfoldertype_sendreminderfrequency: Optional[FieldEEzsignfoldertypeSendreminderfrequency] = Field(default=None, alias="eEzsignfoldertypeSendreminderfrequency") + i_ezsignfoldertype_archivaldays: Annotated[int, Field(le=180, strict=True, ge=0)] = Field(description="The number of days before the archival of Ezsignfolders created using this Ezsignfoldertype", alias="iEzsignfoldertypeArchivaldays") + e_ezsignfoldertype_disposal: FieldEEzsignfoldertypeDisposal = Field(alias="eEzsignfoldertypeDisposal") + i_ezsignfoldertype_disposaldays: Optional[Annotated[int, Field(le=9999, strict=True, ge=0)]] = Field(default=None, description="The number of days after the archival before the disposal of the Ezsignfolder", alias="iEzsignfoldertypeDisposaldays") + i_ezsignfoldertype_deadlinedays: Annotated[int, Field(le=60, strict=True, ge=1)] = Field(description="The number of days to get all Ezsignsignatures", alias="iEzsignfoldertypeDeadlinedays") + b_ezsignfoldertype_delegate: Optional[StrictBool] = Field(default=None, description="Wheter if delegation of signature is allowed to another user or not", alias="bEzsignfoldertypeDelegate") + b_ezsignfoldertype_reassign: Optional[StrictBool] = Field(default=None, description="Wheter if Reassignment of signature is allowed to another signatory or not", alias="bEzsignfoldertypeReassign") + b_ezsignfoldertype_sendattatchmentsigner: Optional[StrictBool] = Field(default=None, description="THIS FIELD WILL BE DELETED. Whether we send the Ezsigndocument and the proof as attachment in the email", alias="bEzsignfoldertypeSendattatchmentsigner") + b_ezsignfoldertype_sendsignedtoezsignsigner: Optional[StrictBool] = Field(default=None, description="Whether we send an email to Ezsignsigner when document is completed", alias="bEzsignfoldertypeSendsignedtoezsignsigner") + b_ezsignfoldertype_sendsignedtouser: Optional[StrictBool] = Field(default=None, description="Whether we send an email to User who signed when document is completed", alias="bEzsignfoldertypeSendsignedtouser") + b_ezsignfoldertype_sendattachmentezsignsigner: Optional[StrictBool] = Field(default=None, description="Whether we send the Ezsigndocument in the email to Ezsignsigner", alias="bEzsignfoldertypeSendattachmentezsignsigner") + b_ezsignfoldertype_sendproofezsignsigner: Optional[StrictBool] = Field(default=None, description="Whether we send the proof in the email to Ezsignsigner", alias="bEzsignfoldertypeSendproofezsignsigner") + b_ezsignfoldertype_sendattachmentuser: Optional[StrictBool] = Field(default=None, description="Whether we send the Ezsigndocument in the email to User", alias="bEzsignfoldertypeSendattachmentuser") + b_ezsignfoldertype_sendproofuser: Optional[StrictBool] = Field(default=None, description="Whether we send the proof in the email to User", alias="bEzsignfoldertypeSendproofuser") + b_ezsignfoldertype_sendproofemail: Optional[StrictBool] = Field(default=None, description="Whether we send the proof in the email to external recipient", alias="bEzsignfoldertypeSendproofemail") + b_ezsignfoldertype_allowdownloadattachmentezsignsigner: Optional[StrictBool] = Field(default=None, description="Whether we allow the Ezsigndocument to be downloaded by an Ezsignsigner", alias="bEzsignfoldertypeAllowdownloadattachmentezsignsigner") + b_ezsignfoldertype_allowdownloadproofezsignsigner: Optional[StrictBool] = Field(default=None, description="Whether we allow the proof to be downloaded by an Ezsignsigner", alias="bEzsignfoldertypeAllowdownloadproofezsignsigner") + b_ezsignfoldertype_sendproofreceivealldocument: Optional[StrictBool] = Field(default=None, description="Whether we send the proof to user and Ezsignsigner who receive all documents.", alias="bEzsignfoldertypeSendproofreceivealldocument") + b_ezsignfoldertype_sendsignedtodocumentowner: StrictBool = Field(description="Whether we send the signed Ezsigndocument to the Ezsigndocument's owner", alias="bEzsignfoldertypeSendsignedtodocumentowner") + b_ezsignfoldertype_sendsignedtofolderowner: StrictBool = Field(description="Whether we send the signed Ezsigndocument to the Ezsignfolder's owner", alias="bEzsignfoldertypeSendsignedtofolderowner") + b_ezsignfoldertype_sendsignedtofullgroup: Optional[StrictBool] = Field(default=None, description="Whether we send the signed Ezsigndocument to the Usergroup that has acces to all Ezsignfolders", alias="bEzsignfoldertypeSendsignedtofullgroup") + b_ezsignfoldertype_sendsignedtolimitedgroup: Optional[StrictBool] = Field(default=None, description="THIS FIELD WILL BE DELETED. Whether we send the signed Ezsigndocument to the Usergroup that has acces to only their own Ezsignfolders", alias="bEzsignfoldertypeSendsignedtolimitedgroup") + b_ezsignfoldertype_sendsignedtocolleague: StrictBool = Field(description="Whether we send the signed Ezsigndocument to the colleagues", alias="bEzsignfoldertypeSendsignedtocolleague") + b_ezsignfoldertype_sendsummarytodocumentowner: StrictBool = Field(description="Whether we send the summary to the Ezsigndocument's owner", alias="bEzsignfoldertypeSendsummarytodocumentowner") + b_ezsignfoldertype_sendsummarytofolderowner: StrictBool = Field(description="Whether we send the summary to the Ezsignfolder's owner", alias="bEzsignfoldertypeSendsummarytofolderowner") + b_ezsignfoldertype_sendsummarytofullgroup: Optional[StrictBool] = Field(default=None, description="Whether we send the summary to the Usergroup that has acces to all Ezsignfolders", alias="bEzsignfoldertypeSendsummarytofullgroup") + b_ezsignfoldertype_sendsummarytolimitedgroup: Optional[StrictBool] = Field(default=None, description="Whether we send the summary to the Usergroup that has acces to only their own Ezsignfolders", alias="bEzsignfoldertypeSendsummarytolimitedgroup") + b_ezsignfoldertype_sendsummarytocolleague: StrictBool = Field(description="Whether we send the summary to the colleagues", alias="bEzsignfoldertypeSendsummarytocolleague") + b_ezsignfoldertype_includeproofsigner: Optional[StrictBool] = Field(default=None, description="THIS FIELD WILL BE DELETED. Whether we include the proof with the signed Ezsigndocument for Ezsignsigners", alias="bEzsignfoldertypeIncludeproofsigner") + b_ezsignfoldertype_includeproofuser: StrictBool = Field(description="Whether we include the proof with the signed Ezsigndocument for users", alias="bEzsignfoldertypeIncludeproofuser") + b_ezsignfoldertype_isactive: StrictBool = Field(description="Whether the Ezsignfoldertype is active or not", alias="bEzsignfoldertypeIsactive") + __properties: ClassVar[List[str]] = ["pkiEzsignfoldertypeID", "objEzsignfoldertypeName", "fkiBrandingID", "fkiBillingentityinternalID", "fkiUsergroupID", "fkiUsergroupIDRestricted", "fkiEzsigntsarequirementID", "sEmailAddressSigned", "sEmailAddressSummary", "eEzsignfoldertypePrivacylevel", "eEzsignfoldertypeSendreminderfrequency", "iEzsignfoldertypeArchivaldays", "eEzsignfoldertypeDisposal", "iEzsignfoldertypeDisposaldays", "iEzsignfoldertypeDeadlinedays", "bEzsignfoldertypeDelegate", "bEzsignfoldertypeReassign", "bEzsignfoldertypeSendattatchmentsigner", "bEzsignfoldertypeSendsignedtoezsignsigner", "bEzsignfoldertypeSendsignedtouser", "bEzsignfoldertypeSendattachmentezsignsigner", "bEzsignfoldertypeSendproofezsignsigner", "bEzsignfoldertypeSendattachmentuser", "bEzsignfoldertypeSendproofuser", "bEzsignfoldertypeSendproofemail", "bEzsignfoldertypeAllowdownloadattachmentezsignsigner", "bEzsignfoldertypeAllowdownloadproofezsignsigner", "bEzsignfoldertypeSendproofreceivealldocument", "bEzsignfoldertypeSendsignedtodocumentowner", "bEzsignfoldertypeSendsignedtofolderowner", "bEzsignfoldertypeSendsignedtofullgroup", "bEzsignfoldertypeSendsignedtolimitedgroup", "bEzsignfoldertypeSendsignedtocolleague", "bEzsignfoldertypeSendsummarytodocumentowner", "bEzsignfoldertypeSendsummarytofolderowner", "bEzsignfoldertypeSendsummarytofullgroup", "bEzsignfoldertypeSendsummarytolimitedgroup", "bEzsignfoldertypeSendsummarytocolleague", "bEzsignfoldertypeIncludeproofsigner", "bEzsignfoldertypeIncludeproofuser", "bEzsignfoldertypeIsactive"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignfoldertypeRequest: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignfoldertypeRequest from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_ezsignfoldertype_name if self.obj_ezsignfoldertype_name: _dict['objEzsignfoldertypeName'] = self.obj_ezsignfoldertype_name.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignfoldertypeRequest: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignfoldertypeRequest from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignfoldertypeRequest.parse_obj(obj) - - _obj = EzsignfoldertypeRequest.parse_obj({ - "pki_ezsignfoldertype_id": obj.get("pkiEzsignfoldertypeID"), - "obj_ezsignfoldertype_name": MultilingualEzsignfoldertypeName.from_dict(obj.get("objEzsignfoldertypeName")) if obj.get("objEzsignfoldertypeName") is not None else None, - "fki_branding_id": obj.get("fkiBrandingID"), - "fki_billingentityinternal_id": obj.get("fkiBillingentityinternalID"), - "fki_usergroup_id": obj.get("fkiUsergroupID"), - "fki_usergroup_id_restricted": obj.get("fkiUsergroupIDRestricted"), - "fki_ezsigntsarequirement_id": obj.get("fkiEzsigntsarequirementID"), - "s_email_address_signed": obj.get("sEmailAddressSigned"), - "s_email_address_summary": obj.get("sEmailAddressSummary"), - "e_ezsignfoldertype_privacylevel": obj.get("eEzsignfoldertypePrivacylevel"), - "e_ezsignfoldertype_sendreminderfrequency": obj.get("eEzsignfoldertypeSendreminderfrequency"), - "i_ezsignfoldertype_archivaldays": obj.get("iEzsignfoldertypeArchivaldays"), - "e_ezsignfoldertype_disposal": obj.get("eEzsignfoldertypeDisposal"), - "i_ezsignfoldertype_disposaldays": obj.get("iEzsignfoldertypeDisposaldays"), - "i_ezsignfoldertype_deadlinedays": obj.get("iEzsignfoldertypeDeadlinedays"), - "b_ezsignfoldertype_delegate": obj.get("bEzsignfoldertypeDelegate"), - "b_ezsignfoldertype_reassign": obj.get("bEzsignfoldertypeReassign"), - "b_ezsignfoldertype_sendattatchmentsigner": obj.get("bEzsignfoldertypeSendattatchmentsigner"), - "b_ezsignfoldertype_sendsignedtodocumentowner": obj.get("bEzsignfoldertypeSendsignedtodocumentowner"), - "b_ezsignfoldertype_sendsignedtofolderowner": obj.get("bEzsignfoldertypeSendsignedtofolderowner"), - "b_ezsignfoldertype_sendsignedtofullgroup": obj.get("bEzsignfoldertypeSendsignedtofullgroup"), - "b_ezsignfoldertype_sendsignedtolimitedgroup": obj.get("bEzsignfoldertypeSendsignedtolimitedgroup"), - "b_ezsignfoldertype_sendsignedtocolleague": obj.get("bEzsignfoldertypeSendsignedtocolleague"), - "b_ezsignfoldertype_sendsummarytodocumentowner": obj.get("bEzsignfoldertypeSendsummarytodocumentowner"), - "b_ezsignfoldertype_sendsummarytofolderowner": obj.get("bEzsignfoldertypeSendsummarytofolderowner"), - "b_ezsignfoldertype_sendsummarytofullgroup": obj.get("bEzsignfoldertypeSendsummarytofullgroup"), - "b_ezsignfoldertype_sendsummarytolimitedgroup": obj.get("bEzsignfoldertypeSendsummarytolimitedgroup"), - "b_ezsignfoldertype_sendsummarytocolleague": obj.get("bEzsignfoldertypeSendsummarytocolleague"), - "b_ezsignfoldertype_includeproofsigner": obj.get("bEzsignfoldertypeIncludeproofsigner"), - "b_ezsignfoldertype_includeproofuser": obj.get("bEzsignfoldertypeIncludeproofuser"), - "b_ezsignfoldertype_isactive": obj.get("bEzsignfoldertypeIsactive") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsignfoldertypeID": obj.get("pkiEzsignfoldertypeID"), + "objEzsignfoldertypeName": MultilingualEzsignfoldertypeName.from_dict(obj.get("objEzsignfoldertypeName")) if obj.get("objEzsignfoldertypeName") is not None else None, + "fkiBrandingID": obj.get("fkiBrandingID"), + "fkiBillingentityinternalID": obj.get("fkiBillingentityinternalID"), + "fkiUsergroupID": obj.get("fkiUsergroupID"), + "fkiUsergroupIDRestricted": obj.get("fkiUsergroupIDRestricted"), + "fkiEzsigntsarequirementID": obj.get("fkiEzsigntsarequirementID"), + "sEmailAddressSigned": obj.get("sEmailAddressSigned"), + "sEmailAddressSummary": obj.get("sEmailAddressSummary"), + "eEzsignfoldertypePrivacylevel": obj.get("eEzsignfoldertypePrivacylevel"), + "eEzsignfoldertypeSendreminderfrequency": obj.get("eEzsignfoldertypeSendreminderfrequency"), + "iEzsignfoldertypeArchivaldays": obj.get("iEzsignfoldertypeArchivaldays"), + "eEzsignfoldertypeDisposal": obj.get("eEzsignfoldertypeDisposal"), + "iEzsignfoldertypeDisposaldays": obj.get("iEzsignfoldertypeDisposaldays"), + "iEzsignfoldertypeDeadlinedays": obj.get("iEzsignfoldertypeDeadlinedays"), + "bEzsignfoldertypeDelegate": obj.get("bEzsignfoldertypeDelegate"), + "bEzsignfoldertypeReassign": obj.get("bEzsignfoldertypeReassign"), + "bEzsignfoldertypeSendattatchmentsigner": obj.get("bEzsignfoldertypeSendattatchmentsigner"), + "bEzsignfoldertypeSendsignedtoezsignsigner": obj.get("bEzsignfoldertypeSendsignedtoezsignsigner"), + "bEzsignfoldertypeSendsignedtouser": obj.get("bEzsignfoldertypeSendsignedtouser"), + "bEzsignfoldertypeSendattachmentezsignsigner": obj.get("bEzsignfoldertypeSendattachmentezsignsigner"), + "bEzsignfoldertypeSendproofezsignsigner": obj.get("bEzsignfoldertypeSendproofezsignsigner"), + "bEzsignfoldertypeSendattachmentuser": obj.get("bEzsignfoldertypeSendattachmentuser"), + "bEzsignfoldertypeSendproofuser": obj.get("bEzsignfoldertypeSendproofuser"), + "bEzsignfoldertypeSendproofemail": obj.get("bEzsignfoldertypeSendproofemail"), + "bEzsignfoldertypeAllowdownloadattachmentezsignsigner": obj.get("bEzsignfoldertypeAllowdownloadattachmentezsignsigner"), + "bEzsignfoldertypeAllowdownloadproofezsignsigner": obj.get("bEzsignfoldertypeAllowdownloadproofezsignsigner"), + "bEzsignfoldertypeSendproofreceivealldocument": obj.get("bEzsignfoldertypeSendproofreceivealldocument"), + "bEzsignfoldertypeSendsignedtodocumentowner": obj.get("bEzsignfoldertypeSendsignedtodocumentowner"), + "bEzsignfoldertypeSendsignedtofolderowner": obj.get("bEzsignfoldertypeSendsignedtofolderowner"), + "bEzsignfoldertypeSendsignedtofullgroup": obj.get("bEzsignfoldertypeSendsignedtofullgroup"), + "bEzsignfoldertypeSendsignedtolimitedgroup": obj.get("bEzsignfoldertypeSendsignedtolimitedgroup"), + "bEzsignfoldertypeSendsignedtocolleague": obj.get("bEzsignfoldertypeSendsignedtocolleague"), + "bEzsignfoldertypeSendsummarytodocumentowner": obj.get("bEzsignfoldertypeSendsummarytodocumentowner"), + "bEzsignfoldertypeSendsummarytofolderowner": obj.get("bEzsignfoldertypeSendsummarytofolderowner"), + "bEzsignfoldertypeSendsummarytofullgroup": obj.get("bEzsignfoldertypeSendsummarytofullgroup"), + "bEzsignfoldertypeSendsummarytolimitedgroup": obj.get("bEzsignfoldertypeSendsummarytolimitedgroup"), + "bEzsignfoldertypeSendsummarytocolleague": obj.get("bEzsignfoldertypeSendsummarytocolleague"), + "bEzsignfoldertypeIncludeproofsigner": obj.get("bEzsignfoldertypeIncludeproofsigner"), + "bEzsignfoldertypeIncludeproofuser": obj.get("bEzsignfoldertypeIncludeproofuser"), + "bEzsignfoldertypeIsactive": obj.get("bEzsignfoldertypeIsactive") }) return _obj diff --git a/eZmaxApi/models/ezsignfoldertype_request_compound.py b/eZmaxApi/models/ezsignfoldertype_request_compound.py index 2b99abd04..fd074b6b5 100644 --- a/eZmaxApi/models/ezsignfoldertype_request_compound.py +++ b/eZmaxApi/models/ezsignfoldertype_request_compound.py @@ -19,124 +19,163 @@ import json -from typing import List, Optional -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint, conlist +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, StrictStr +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.field_e_ezsignfoldertype_disposal import FieldEEzsignfoldertypeDisposal from eZmaxApi.models.field_e_ezsignfoldertype_privacylevel import FieldEEzsignfoldertypePrivacylevel from eZmaxApi.models.field_e_ezsignfoldertype_sendreminderfrequency import FieldEEzsignfoldertypeSendreminderfrequency from eZmaxApi.models.multilingual_ezsignfoldertype_name import MultilingualEzsignfoldertypeName +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignfoldertypeRequestCompound(BaseModel): """ - A Ezsignfoldertype Object and children # noqa: E501 - """ - pki_ezsignfoldertype_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="pkiEzsignfoldertypeID", description="The unique ID of the Ezsignfoldertype.") - obj_ezsignfoldertype_name: MultilingualEzsignfoldertypeName = Field(..., alias="objEzsignfoldertypeName") - fki_branding_id: conint(strict=True, ge=0) = Field(..., alias="fkiBrandingID", description="The unique ID of the Branding") - fki_billingentityinternal_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiBillingentityinternalID", description="The unique ID of the Billingentityinternal.") - fki_usergroup_id: Optional[conint(strict=True, le=255, ge=0)] = Field(None, alias="fkiUsergroupID", description="The unique ID of the Usergroup") - fki_usergroup_id_restricted: Optional[conint(strict=True, le=255, ge=0)] = Field(None, alias="fkiUsergroupIDRestricted", description="The unique ID of the Usergroup") - fki_ezsigntsarequirement_id: Optional[conint(strict=True, le=3, ge=1)] = Field(None, alias="fkiEzsigntsarequirementID", description="The unique ID of the Ezsigntsarequirement. Determine if a Time Stamping Authority should add a timestamp on each of the signature. Valid values: |Value|Description| |-|-| |1|No. TSA Timestamping will requested. This will make all signatures a lot faster since no round-trip to the TSA server will be required. Timestamping will be made using eZsign server's time.| |2|Best effort. Timestamping from a Time Stamping Authority will be requested but is not mandatory. In the very improbable case it cannot be completed, the timestamping will be made using eZsign server's time. **Additional fee applies**| |3|Mandatory. Timestamping from a Time Stamping Authority will be requested and is mandatory. In the very improbable case it cannot be completed, the signature will fail and the user will be asked to retry. **Additional fee applies**|") - s_email_address_signed: Optional[StrictStr] = Field(None, alias="sEmailAddressSigned", description="The email address.") - s_email_address_summary: Optional[StrictStr] = Field(None, alias="sEmailAddressSummary", description="The email address.") - e_ezsignfoldertype_privacylevel: FieldEEzsignfoldertypePrivacylevel = Field(..., alias="eEzsignfoldertypePrivacylevel") - e_ezsignfoldertype_sendreminderfrequency: Optional[FieldEEzsignfoldertypeSendreminderfrequency] = Field(None, alias="eEzsignfoldertypeSendreminderfrequency") - i_ezsignfoldertype_archivaldays: conint(strict=True, le=180, ge=0) = Field(..., alias="iEzsignfoldertypeArchivaldays", description="The number of days before the archival of Ezsignfolders created using this Ezsignfoldertype") - e_ezsignfoldertype_disposal: FieldEEzsignfoldertypeDisposal = Field(..., alias="eEzsignfoldertypeDisposal") - i_ezsignfoldertype_disposaldays: Optional[conint(strict=True, le=9999, ge=0)] = Field(None, alias="iEzsignfoldertypeDisposaldays", description="The number of days after the archival before the disposal of the Ezsignfolder") - i_ezsignfoldertype_deadlinedays: conint(strict=True, le=60, ge=1) = Field(..., alias="iEzsignfoldertypeDeadlinedays", description="The number of days to get all Ezsignsignatures") - b_ezsignfoldertype_delegate: Optional[StrictBool] = Field(None, alias="bEzsignfoldertypeDelegate", description="Wheter if delegation of signature is allowed to another user or not") - b_ezsignfoldertype_reassign: Optional[StrictBool] = Field(None, alias="bEzsignfoldertypeReassign", description="Wheter if Reassignment of signature is allowed to another signatory or not") - b_ezsignfoldertype_sendattatchmentsigner: StrictBool = Field(..., alias="bEzsignfoldertypeSendattatchmentsigner", description="Whether we send the Ezsigndocument and the proof as attachment in the email") - b_ezsignfoldertype_sendsignedtodocumentowner: StrictBool = Field(..., alias="bEzsignfoldertypeSendsignedtodocumentowner", description="Whether we send the signed Ezsigndocument to the Ezsigndocument's owner") - b_ezsignfoldertype_sendsignedtofolderowner: StrictBool = Field(..., alias="bEzsignfoldertypeSendsignedtofolderowner", description="Whether we send the signed Ezsigndocument to the Ezsignfolder's owner") - b_ezsignfoldertype_sendsignedtofullgroup: Optional[StrictBool] = Field(None, alias="bEzsignfoldertypeSendsignedtofullgroup", description="Whether we send the signed Ezsigndocument to the Usergroup that has acces to all Ezsignfolders") - b_ezsignfoldertype_sendsignedtolimitedgroup: Optional[StrictBool] = Field(None, alias="bEzsignfoldertypeSendsignedtolimitedgroup", description="Whether we send the signed Ezsigndocument to the Usergroup that has acces to only their own Ezsignfolders") - b_ezsignfoldertype_sendsignedtocolleague: StrictBool = Field(..., alias="bEzsignfoldertypeSendsignedtocolleague", description="Whether we send the signed Ezsigndocument to the colleagues") - b_ezsignfoldertype_sendsummarytodocumentowner: StrictBool = Field(..., alias="bEzsignfoldertypeSendsummarytodocumentowner", description="Whether we send the summary to the Ezsigndocument's owner") - b_ezsignfoldertype_sendsummarytofolderowner: StrictBool = Field(..., alias="bEzsignfoldertypeSendsummarytofolderowner", description="Whether we send the summary to the Ezsignfolder's owner") - b_ezsignfoldertype_sendsummarytofullgroup: Optional[StrictBool] = Field(None, alias="bEzsignfoldertypeSendsummarytofullgroup", description="Whether we send the summary to the Usergroup that has acces to all Ezsignfolders") - b_ezsignfoldertype_sendsummarytolimitedgroup: Optional[StrictBool] = Field(None, alias="bEzsignfoldertypeSendsummarytolimitedgroup", description="Whether we send the summary to the Usergroup that has acces to only their own Ezsignfolders") - b_ezsignfoldertype_sendsummarytocolleague: StrictBool = Field(..., alias="bEzsignfoldertypeSendsummarytocolleague", description="Whether we send the summary to the colleagues") - b_ezsignfoldertype_includeproofsigner: StrictBool = Field(..., alias="bEzsignfoldertypeIncludeproofsigner", description="Whether we include the proof with the signed Ezsigndocument for Ezsignsigners") - b_ezsignfoldertype_includeproofuser: StrictBool = Field(..., alias="bEzsignfoldertypeIncludeproofuser", description="Whether we include the proof with the signed Ezsigndocument for users") - b_ezsignfoldertype_isactive: StrictBool = Field(..., alias="bEzsignfoldertypeIsactive", description="Whether the Ezsignfoldertype is active or not") - a_fki_user_id_signed: Optional[conlist(conint(strict=True, ge=0))] = Field(None, alias="a_fkiUserIDSigned") - a_fki_user_id_summary: Optional[conlist(conint(strict=True, ge=0))] = Field(None, alias="a_fkiUserIDSummary") - __properties = ["pkiEzsignfoldertypeID", "objEzsignfoldertypeName", "fkiBrandingID", "fkiBillingentityinternalID", "fkiUsergroupID", "fkiUsergroupIDRestricted", "fkiEzsigntsarequirementID", "sEmailAddressSigned", "sEmailAddressSummary", "eEzsignfoldertypePrivacylevel", "eEzsignfoldertypeSendreminderfrequency", "iEzsignfoldertypeArchivaldays", "eEzsignfoldertypeDisposal", "iEzsignfoldertypeDisposaldays", "iEzsignfoldertypeDeadlinedays", "bEzsignfoldertypeDelegate", "bEzsignfoldertypeReassign", "bEzsignfoldertypeSendattatchmentsigner", "bEzsignfoldertypeSendsignedtodocumentowner", "bEzsignfoldertypeSendsignedtofolderowner", "bEzsignfoldertypeSendsignedtofullgroup", "bEzsignfoldertypeSendsignedtolimitedgroup", "bEzsignfoldertypeSendsignedtocolleague", "bEzsignfoldertypeSendsummarytodocumentowner", "bEzsignfoldertypeSendsummarytofolderowner", "bEzsignfoldertypeSendsummarytofullgroup", "bEzsignfoldertypeSendsummarytolimitedgroup", "bEzsignfoldertypeSendsummarytocolleague", "bEzsignfoldertypeIncludeproofsigner", "bEzsignfoldertypeIncludeproofuser", "bEzsignfoldertypeIsactive", "a_fkiUserIDSigned", "a_fkiUserIDSummary"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + A Ezsignfoldertype Object and children + """ # noqa: E501 + pki_ezsignfoldertype_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsignfoldertype.", alias="pkiEzsignfoldertypeID") + obj_ezsignfoldertype_name: MultilingualEzsignfoldertypeName = Field(alias="objEzsignfoldertypeName") + fki_branding_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Branding", alias="fkiBrandingID") + fki_billingentityinternal_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Billingentityinternal.", alias="fkiBillingentityinternalID") + fki_usergroup_id: Optional[Annotated[int, Field(le=255, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Usergroup", alias="fkiUsergroupID") + fki_usergroup_id_restricted: Optional[Annotated[int, Field(le=255, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Usergroup", alias="fkiUsergroupIDRestricted") + fki_ezsigntsarequirement_id: Optional[Annotated[int, Field(le=3, strict=True, ge=1)]] = Field(default=None, description="The unique ID of the Ezsigntsarequirement. Determine if a Time Stamping Authority should add a timestamp on each of the signature. Valid values: |Value|Description| |-|-| |1|No. TSA Timestamping will requested. This will make all signatures a lot faster since no round-trip to the TSA server will be required. Timestamping will be made using eZsign server's time.| |2|Best effort. Timestamping from a Time Stamping Authority will be requested but is not mandatory. In the very improbable case it cannot be completed, the timestamping will be made using eZsign server's time. **Additional fee applies**| |3|Mandatory. Timestamping from a Time Stamping Authority will be requested and is mandatory. In the very improbable case it cannot be completed, the signature will fail and the user will be asked to retry. **Additional fee applies**|", alias="fkiEzsigntsarequirementID") + s_email_address_signed: Optional[StrictStr] = Field(default=None, description="The email address.", alias="sEmailAddressSigned") + s_email_address_summary: Optional[StrictStr] = Field(default=None, description="The email address.", alias="sEmailAddressSummary") + e_ezsignfoldertype_privacylevel: FieldEEzsignfoldertypePrivacylevel = Field(alias="eEzsignfoldertypePrivacylevel") + e_ezsignfoldertype_sendreminderfrequency: Optional[FieldEEzsignfoldertypeSendreminderfrequency] = Field(default=None, alias="eEzsignfoldertypeSendreminderfrequency") + i_ezsignfoldertype_archivaldays: Annotated[int, Field(le=180, strict=True, ge=0)] = Field(description="The number of days before the archival of Ezsignfolders created using this Ezsignfoldertype", alias="iEzsignfoldertypeArchivaldays") + e_ezsignfoldertype_disposal: FieldEEzsignfoldertypeDisposal = Field(alias="eEzsignfoldertypeDisposal") + i_ezsignfoldertype_disposaldays: Optional[Annotated[int, Field(le=9999, strict=True, ge=0)]] = Field(default=None, description="The number of days after the archival before the disposal of the Ezsignfolder", alias="iEzsignfoldertypeDisposaldays") + i_ezsignfoldertype_deadlinedays: Annotated[int, Field(le=60, strict=True, ge=1)] = Field(description="The number of days to get all Ezsignsignatures", alias="iEzsignfoldertypeDeadlinedays") + b_ezsignfoldertype_delegate: Optional[StrictBool] = Field(default=None, description="Wheter if delegation of signature is allowed to another user or not", alias="bEzsignfoldertypeDelegate") + b_ezsignfoldertype_reassign: Optional[StrictBool] = Field(default=None, description="Wheter if Reassignment of signature is allowed to another signatory or not", alias="bEzsignfoldertypeReassign") + b_ezsignfoldertype_sendattatchmentsigner: Optional[StrictBool] = Field(default=None, description="THIS FIELD WILL BE DELETED. Whether we send the Ezsigndocument and the proof as attachment in the email", alias="bEzsignfoldertypeSendattatchmentsigner") + b_ezsignfoldertype_sendsignedtoezsignsigner: Optional[StrictBool] = Field(default=None, description="Whether we send an email to Ezsignsigner when document is completed", alias="bEzsignfoldertypeSendsignedtoezsignsigner") + b_ezsignfoldertype_sendsignedtouser: Optional[StrictBool] = Field(default=None, description="Whether we send an email to User who signed when document is completed", alias="bEzsignfoldertypeSendsignedtouser") + b_ezsignfoldertype_sendattachmentezsignsigner: Optional[StrictBool] = Field(default=None, description="Whether we send the Ezsigndocument in the email to Ezsignsigner", alias="bEzsignfoldertypeSendattachmentezsignsigner") + b_ezsignfoldertype_sendproofezsignsigner: Optional[StrictBool] = Field(default=None, description="Whether we send the proof in the email to Ezsignsigner", alias="bEzsignfoldertypeSendproofezsignsigner") + b_ezsignfoldertype_sendattachmentuser: Optional[StrictBool] = Field(default=None, description="Whether we send the Ezsigndocument in the email to User", alias="bEzsignfoldertypeSendattachmentuser") + b_ezsignfoldertype_sendproofuser: Optional[StrictBool] = Field(default=None, description="Whether we send the proof in the email to User", alias="bEzsignfoldertypeSendproofuser") + b_ezsignfoldertype_sendproofemail: Optional[StrictBool] = Field(default=None, description="Whether we send the proof in the email to external recipient", alias="bEzsignfoldertypeSendproofemail") + b_ezsignfoldertype_allowdownloadattachmentezsignsigner: Optional[StrictBool] = Field(default=None, description="Whether we allow the Ezsigndocument to be downloaded by an Ezsignsigner", alias="bEzsignfoldertypeAllowdownloadattachmentezsignsigner") + b_ezsignfoldertype_allowdownloadproofezsignsigner: Optional[StrictBool] = Field(default=None, description="Whether we allow the proof to be downloaded by an Ezsignsigner", alias="bEzsignfoldertypeAllowdownloadproofezsignsigner") + b_ezsignfoldertype_sendproofreceivealldocument: Optional[StrictBool] = Field(default=None, description="Whether we send the proof to user and Ezsignsigner who receive all documents.", alias="bEzsignfoldertypeSendproofreceivealldocument") + b_ezsignfoldertype_sendsignedtodocumentowner: StrictBool = Field(description="Whether we send the signed Ezsigndocument to the Ezsigndocument's owner", alias="bEzsignfoldertypeSendsignedtodocumentowner") + b_ezsignfoldertype_sendsignedtofolderowner: StrictBool = Field(description="Whether we send the signed Ezsigndocument to the Ezsignfolder's owner", alias="bEzsignfoldertypeSendsignedtofolderowner") + b_ezsignfoldertype_sendsignedtofullgroup: Optional[StrictBool] = Field(default=None, description="Whether we send the signed Ezsigndocument to the Usergroup that has acces to all Ezsignfolders", alias="bEzsignfoldertypeSendsignedtofullgroup") + b_ezsignfoldertype_sendsignedtolimitedgroup: Optional[StrictBool] = Field(default=None, description="THIS FIELD WILL BE DELETED. Whether we send the signed Ezsigndocument to the Usergroup that has acces to only their own Ezsignfolders", alias="bEzsignfoldertypeSendsignedtolimitedgroup") + b_ezsignfoldertype_sendsignedtocolleague: StrictBool = Field(description="Whether we send the signed Ezsigndocument to the colleagues", alias="bEzsignfoldertypeSendsignedtocolleague") + b_ezsignfoldertype_sendsummarytodocumentowner: StrictBool = Field(description="Whether we send the summary to the Ezsigndocument's owner", alias="bEzsignfoldertypeSendsummarytodocumentowner") + b_ezsignfoldertype_sendsummarytofolderowner: StrictBool = Field(description="Whether we send the summary to the Ezsignfolder's owner", alias="bEzsignfoldertypeSendsummarytofolderowner") + b_ezsignfoldertype_sendsummarytofullgroup: Optional[StrictBool] = Field(default=None, description="Whether we send the summary to the Usergroup that has acces to all Ezsignfolders", alias="bEzsignfoldertypeSendsummarytofullgroup") + b_ezsignfoldertype_sendsummarytolimitedgroup: Optional[StrictBool] = Field(default=None, description="Whether we send the summary to the Usergroup that has acces to only their own Ezsignfolders", alias="bEzsignfoldertypeSendsummarytolimitedgroup") + b_ezsignfoldertype_sendsummarytocolleague: StrictBool = Field(description="Whether we send the summary to the colleagues", alias="bEzsignfoldertypeSendsummarytocolleague") + b_ezsignfoldertype_includeproofsigner: Optional[StrictBool] = Field(default=None, description="THIS FIELD WILL BE DELETED. Whether we include the proof with the signed Ezsigndocument for Ezsignsigners", alias="bEzsignfoldertypeIncludeproofsigner") + b_ezsignfoldertype_includeproofuser: StrictBool = Field(description="Whether we include the proof with the signed Ezsigndocument for users", alias="bEzsignfoldertypeIncludeproofuser") + b_ezsignfoldertype_isactive: StrictBool = Field(description="Whether the Ezsignfoldertype is active or not", alias="bEzsignfoldertypeIsactive") + a_fki_user_id_signed: Optional[List[Annotated[int, Field(strict=True, ge=0)]]] = Field(default=None, alias="a_fkiUserIDSigned") + a_fki_user_id_summary: Optional[List[Annotated[int, Field(strict=True, ge=0)]]] = Field(default=None, alias="a_fkiUserIDSummary") + __properties: ClassVar[List[str]] = ["pkiEzsignfoldertypeID", "objEzsignfoldertypeName", "fkiBrandingID", "fkiBillingentityinternalID", "fkiUsergroupID", "fkiUsergroupIDRestricted", "fkiEzsigntsarequirementID", "sEmailAddressSigned", "sEmailAddressSummary", "eEzsignfoldertypePrivacylevel", "eEzsignfoldertypeSendreminderfrequency", "iEzsignfoldertypeArchivaldays", "eEzsignfoldertypeDisposal", "iEzsignfoldertypeDisposaldays", "iEzsignfoldertypeDeadlinedays", "bEzsignfoldertypeDelegate", "bEzsignfoldertypeReassign", "bEzsignfoldertypeSendattatchmentsigner", "bEzsignfoldertypeSendsignedtoezsignsigner", "bEzsignfoldertypeSendsignedtouser", "bEzsignfoldertypeSendattachmentezsignsigner", "bEzsignfoldertypeSendproofezsignsigner", "bEzsignfoldertypeSendattachmentuser", "bEzsignfoldertypeSendproofuser", "bEzsignfoldertypeSendproofemail", "bEzsignfoldertypeAllowdownloadattachmentezsignsigner", "bEzsignfoldertypeAllowdownloadproofezsignsigner", "bEzsignfoldertypeSendproofreceivealldocument", "bEzsignfoldertypeSendsignedtodocumentowner", "bEzsignfoldertypeSendsignedtofolderowner", "bEzsignfoldertypeSendsignedtofullgroup", "bEzsignfoldertypeSendsignedtolimitedgroup", "bEzsignfoldertypeSendsignedtocolleague", "bEzsignfoldertypeSendsummarytodocumentowner", "bEzsignfoldertypeSendsummarytofolderowner", "bEzsignfoldertypeSendsummarytofullgroup", "bEzsignfoldertypeSendsummarytolimitedgroup", "bEzsignfoldertypeSendsummarytocolleague", "bEzsignfoldertypeIncludeproofsigner", "bEzsignfoldertypeIncludeproofuser", "bEzsignfoldertypeIsactive", "a_fkiUserIDSigned", "a_fkiUserIDSummary"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignfoldertypeRequestCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignfoldertypeRequestCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_ezsignfoldertype_name if self.obj_ezsignfoldertype_name: _dict['objEzsignfoldertypeName'] = self.obj_ezsignfoldertype_name.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignfoldertypeRequestCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignfoldertypeRequestCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignfoldertypeRequestCompound.parse_obj(obj) - - _obj = EzsignfoldertypeRequestCompound.parse_obj({ - "pki_ezsignfoldertype_id": obj.get("pkiEzsignfoldertypeID"), - "obj_ezsignfoldertype_name": MultilingualEzsignfoldertypeName.from_dict(obj.get("objEzsignfoldertypeName")) if obj.get("objEzsignfoldertypeName") is not None else None, - "fki_branding_id": obj.get("fkiBrandingID"), - "fki_billingentityinternal_id": obj.get("fkiBillingentityinternalID"), - "fki_usergroup_id": obj.get("fkiUsergroupID"), - "fki_usergroup_id_restricted": obj.get("fkiUsergroupIDRestricted"), - "fki_ezsigntsarequirement_id": obj.get("fkiEzsigntsarequirementID"), - "s_email_address_signed": obj.get("sEmailAddressSigned"), - "s_email_address_summary": obj.get("sEmailAddressSummary"), - "e_ezsignfoldertype_privacylevel": obj.get("eEzsignfoldertypePrivacylevel"), - "e_ezsignfoldertype_sendreminderfrequency": obj.get("eEzsignfoldertypeSendreminderfrequency"), - "i_ezsignfoldertype_archivaldays": obj.get("iEzsignfoldertypeArchivaldays"), - "e_ezsignfoldertype_disposal": obj.get("eEzsignfoldertypeDisposal"), - "i_ezsignfoldertype_disposaldays": obj.get("iEzsignfoldertypeDisposaldays"), - "i_ezsignfoldertype_deadlinedays": obj.get("iEzsignfoldertypeDeadlinedays"), - "b_ezsignfoldertype_delegate": obj.get("bEzsignfoldertypeDelegate"), - "b_ezsignfoldertype_reassign": obj.get("bEzsignfoldertypeReassign"), - "b_ezsignfoldertype_sendattatchmentsigner": obj.get("bEzsignfoldertypeSendattatchmentsigner"), - "b_ezsignfoldertype_sendsignedtodocumentowner": obj.get("bEzsignfoldertypeSendsignedtodocumentowner"), - "b_ezsignfoldertype_sendsignedtofolderowner": obj.get("bEzsignfoldertypeSendsignedtofolderowner"), - "b_ezsignfoldertype_sendsignedtofullgroup": obj.get("bEzsignfoldertypeSendsignedtofullgroup"), - "b_ezsignfoldertype_sendsignedtolimitedgroup": obj.get("bEzsignfoldertypeSendsignedtolimitedgroup"), - "b_ezsignfoldertype_sendsignedtocolleague": obj.get("bEzsignfoldertypeSendsignedtocolleague"), - "b_ezsignfoldertype_sendsummarytodocumentowner": obj.get("bEzsignfoldertypeSendsummarytodocumentowner"), - "b_ezsignfoldertype_sendsummarytofolderowner": obj.get("bEzsignfoldertypeSendsummarytofolderowner"), - "b_ezsignfoldertype_sendsummarytofullgroup": obj.get("bEzsignfoldertypeSendsummarytofullgroup"), - "b_ezsignfoldertype_sendsummarytolimitedgroup": obj.get("bEzsignfoldertypeSendsummarytolimitedgroup"), - "b_ezsignfoldertype_sendsummarytocolleague": obj.get("bEzsignfoldertypeSendsummarytocolleague"), - "b_ezsignfoldertype_includeproofsigner": obj.get("bEzsignfoldertypeIncludeproofsigner"), - "b_ezsignfoldertype_includeproofuser": obj.get("bEzsignfoldertypeIncludeproofuser"), - "b_ezsignfoldertype_isactive": obj.get("bEzsignfoldertypeIsactive"), - "a_fki_user_id_signed": obj.get("a_fkiUserIDSigned"), - "a_fki_user_id_summary": obj.get("a_fkiUserIDSummary") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsignfoldertypeID": obj.get("pkiEzsignfoldertypeID"), + "objEzsignfoldertypeName": MultilingualEzsignfoldertypeName.from_dict(obj.get("objEzsignfoldertypeName")) if obj.get("objEzsignfoldertypeName") is not None else None, + "fkiBrandingID": obj.get("fkiBrandingID"), + "fkiBillingentityinternalID": obj.get("fkiBillingentityinternalID"), + "fkiUsergroupID": obj.get("fkiUsergroupID"), + "fkiUsergroupIDRestricted": obj.get("fkiUsergroupIDRestricted"), + "fkiEzsigntsarequirementID": obj.get("fkiEzsigntsarequirementID"), + "sEmailAddressSigned": obj.get("sEmailAddressSigned"), + "sEmailAddressSummary": obj.get("sEmailAddressSummary"), + "eEzsignfoldertypePrivacylevel": obj.get("eEzsignfoldertypePrivacylevel"), + "eEzsignfoldertypeSendreminderfrequency": obj.get("eEzsignfoldertypeSendreminderfrequency"), + "iEzsignfoldertypeArchivaldays": obj.get("iEzsignfoldertypeArchivaldays"), + "eEzsignfoldertypeDisposal": obj.get("eEzsignfoldertypeDisposal"), + "iEzsignfoldertypeDisposaldays": obj.get("iEzsignfoldertypeDisposaldays"), + "iEzsignfoldertypeDeadlinedays": obj.get("iEzsignfoldertypeDeadlinedays"), + "bEzsignfoldertypeDelegate": obj.get("bEzsignfoldertypeDelegate"), + "bEzsignfoldertypeReassign": obj.get("bEzsignfoldertypeReassign"), + "bEzsignfoldertypeSendattatchmentsigner": obj.get("bEzsignfoldertypeSendattatchmentsigner"), + "bEzsignfoldertypeSendsignedtoezsignsigner": obj.get("bEzsignfoldertypeSendsignedtoezsignsigner"), + "bEzsignfoldertypeSendsignedtouser": obj.get("bEzsignfoldertypeSendsignedtouser"), + "bEzsignfoldertypeSendattachmentezsignsigner": obj.get("bEzsignfoldertypeSendattachmentezsignsigner"), + "bEzsignfoldertypeSendproofezsignsigner": obj.get("bEzsignfoldertypeSendproofezsignsigner"), + "bEzsignfoldertypeSendattachmentuser": obj.get("bEzsignfoldertypeSendattachmentuser"), + "bEzsignfoldertypeSendproofuser": obj.get("bEzsignfoldertypeSendproofuser"), + "bEzsignfoldertypeSendproofemail": obj.get("bEzsignfoldertypeSendproofemail"), + "bEzsignfoldertypeAllowdownloadattachmentezsignsigner": obj.get("bEzsignfoldertypeAllowdownloadattachmentezsignsigner"), + "bEzsignfoldertypeAllowdownloadproofezsignsigner": obj.get("bEzsignfoldertypeAllowdownloadproofezsignsigner"), + "bEzsignfoldertypeSendproofreceivealldocument": obj.get("bEzsignfoldertypeSendproofreceivealldocument"), + "bEzsignfoldertypeSendsignedtodocumentowner": obj.get("bEzsignfoldertypeSendsignedtodocumentowner"), + "bEzsignfoldertypeSendsignedtofolderowner": obj.get("bEzsignfoldertypeSendsignedtofolderowner"), + "bEzsignfoldertypeSendsignedtofullgroup": obj.get("bEzsignfoldertypeSendsignedtofullgroup"), + "bEzsignfoldertypeSendsignedtolimitedgroup": obj.get("bEzsignfoldertypeSendsignedtolimitedgroup"), + "bEzsignfoldertypeSendsignedtocolleague": obj.get("bEzsignfoldertypeSendsignedtocolleague"), + "bEzsignfoldertypeSendsummarytodocumentowner": obj.get("bEzsignfoldertypeSendsummarytodocumentowner"), + "bEzsignfoldertypeSendsummarytofolderowner": obj.get("bEzsignfoldertypeSendsummarytofolderowner"), + "bEzsignfoldertypeSendsummarytofullgroup": obj.get("bEzsignfoldertypeSendsummarytofullgroup"), + "bEzsignfoldertypeSendsummarytolimitedgroup": obj.get("bEzsignfoldertypeSendsummarytolimitedgroup"), + "bEzsignfoldertypeSendsummarytocolleague": obj.get("bEzsignfoldertypeSendsummarytocolleague"), + "bEzsignfoldertypeIncludeproofsigner": obj.get("bEzsignfoldertypeIncludeproofsigner"), + "bEzsignfoldertypeIncludeproofuser": obj.get("bEzsignfoldertypeIncludeproofuser"), + "bEzsignfoldertypeIsactive": obj.get("bEzsignfoldertypeIsactive"), + "a_fkiUserIDSigned": obj.get("a_fkiUserIDSigned"), + "a_fkiUserIDSummary": obj.get("a_fkiUserIDSummary") }) return _obj diff --git a/eZmaxApi/models/ezsignfoldertype_response.py b/eZmaxApi/models/ezsignfoldertype_response.py index 5081d31f0..2259c0989 100644 --- a/eZmaxApi/models/ezsignfoldertype_response.py +++ b/eZmaxApi/models/ezsignfoldertype_response.py @@ -19,56 +19,72 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint, constr, validator +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, StrictStr, field_validator +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.field_e_ezsignfoldertype_disposal import FieldEEzsignfoldertypeDisposal from eZmaxApi.models.field_e_ezsignfoldertype_privacylevel import FieldEEzsignfoldertypePrivacylevel from eZmaxApi.models.field_e_ezsignfoldertype_sendreminderfrequency import FieldEEzsignfoldertypeSendreminderfrequency from eZmaxApi.models.multilingual_ezsignfoldertype_name import MultilingualEzsignfoldertypeName +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignfoldertypeResponse(BaseModel): """ - A Ezsignfoldertype Object # noqa: E501 - """ - pki_ezsignfoldertype_id: conint(strict=True, ge=0) = Field(..., alias="pkiEzsignfoldertypeID", description="The unique ID of the Ezsignfoldertype.") - obj_ezsignfoldertype_name: MultilingualEzsignfoldertypeName = Field(..., alias="objEzsignfoldertypeName") - fki_branding_id: conint(strict=True, ge=0) = Field(..., alias="fkiBrandingID", description="The unique ID of the Branding") - fki_billingentityinternal_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiBillingentityinternalID", description="The unique ID of the Billingentityinternal.") - fki_usergroup_id: Optional[conint(strict=True, le=255, ge=0)] = Field(None, alias="fkiUsergroupID", description="The unique ID of the Usergroup") - fki_usergroup_id_restricted: Optional[conint(strict=True, le=255, ge=0)] = Field(None, alias="fkiUsergroupIDRestricted", description="The unique ID of the Usergroup") - fki_ezsigntsarequirement_id: Optional[conint(strict=True, le=3, ge=1)] = Field(None, alias="fkiEzsigntsarequirementID", description="The unique ID of the Ezsigntsarequirement. Determine if a Time Stamping Authority should add a timestamp on each of the signature. Valid values: |Value|Description| |-|-| |1|No. TSA Timestamping will requested. This will make all signatures a lot faster since no round-trip to the TSA server will be required. Timestamping will be made using eZsign server's time.| |2|Best effort. Timestamping from a Time Stamping Authority will be requested but is not mandatory. In the very improbable case it cannot be completed, the timestamping will be made using eZsign server's time. **Additional fee applies**| |3|Mandatory. Timestamping from a Time Stamping Authority will be requested and is mandatory. In the very improbable case it cannot be completed, the signature will fail and the user will be asked to retry. **Additional fee applies**|") - s_branding_description_x: StrictStr = Field(..., alias="sBrandingDescriptionX", description="The Description of the Branding in the language of the requester") - s_billingentityinternal_description_x: Optional[StrictStr] = Field(None, alias="sBillingentityinternalDescriptionX", description="The description of the Billingentityinternal in the language of the requester") - s_ezsigntsarequirement_description_x: Optional[StrictStr] = Field(None, alias="sEzsigntsarequirementDescriptionX", description="The description of the Ezsigntsarequirement in the language of the requester") - s_email_address_signed: Optional[StrictStr] = Field(None, alias="sEmailAddressSigned", description="The email address.") - s_email_address_summary: Optional[StrictStr] = Field(None, alias="sEmailAddressSummary", description="The email address.") - s_usergroup_name_x: Optional[constr(strict=True)] = Field(None, alias="sUsergroupNameX", description="The Name of the Usergroup in the language of the requester") - s_usergroup_name_x_restricted: Optional[constr(strict=True)] = Field(None, alias="sUsergroupNameXRestricted", description="The Name of the Usergroup in the language of the requester") - e_ezsignfoldertype_privacylevel: FieldEEzsignfoldertypePrivacylevel = Field(..., alias="eEzsignfoldertypePrivacylevel") - e_ezsignfoldertype_sendreminderfrequency: Optional[FieldEEzsignfoldertypeSendreminderfrequency] = Field(None, alias="eEzsignfoldertypeSendreminderfrequency") - i_ezsignfoldertype_archivaldays: conint(strict=True, le=180, ge=0) = Field(..., alias="iEzsignfoldertypeArchivaldays", description="The number of days before the archival of Ezsignfolders created using this Ezsignfoldertype") - e_ezsignfoldertype_disposal: FieldEEzsignfoldertypeDisposal = Field(..., alias="eEzsignfoldertypeDisposal") - i_ezsignfoldertype_disposaldays: Optional[conint(strict=True, le=9999, ge=0)] = Field(None, alias="iEzsignfoldertypeDisposaldays", description="The number of days after the archival before the disposal of the Ezsignfolder") - i_ezsignfoldertype_deadlinedays: conint(strict=True, le=60, ge=1) = Field(..., alias="iEzsignfoldertypeDeadlinedays", description="The number of days to get all Ezsignsignatures") - b_ezsignfoldertype_delegate: Optional[StrictBool] = Field(None, alias="bEzsignfoldertypeDelegate", description="Wheter if delegation of signature is allowed to another user or not") - b_ezsignfoldertype_reassign: Optional[StrictBool] = Field(None, alias="bEzsignfoldertypeReassign", description="Wheter if Reassignment of signature is allowed to another signatory or not") - b_ezsignfoldertype_sendattatchmentsigner: StrictBool = Field(..., alias="bEzsignfoldertypeSendattatchmentsigner", description="Whether we send the Ezsigndocument and the proof as attachment in the email") - b_ezsignfoldertype_sendsignedtodocumentowner: StrictBool = Field(..., alias="bEzsignfoldertypeSendsignedtodocumentowner", description="Whether we send the signed Ezsigndocument to the Ezsigndocument's owner") - b_ezsignfoldertype_sendsignedtofolderowner: StrictBool = Field(..., alias="bEzsignfoldertypeSendsignedtofolderowner", description="Whether we send the signed Ezsigndocument to the Ezsignfolder's owner") - b_ezsignfoldertype_sendsignedtofullgroup: Optional[StrictBool] = Field(None, alias="bEzsignfoldertypeSendsignedtofullgroup", description="Whether we send the signed Ezsigndocument to the Usergroup that has acces to all Ezsignfolders") - b_ezsignfoldertype_sendsignedtolimitedgroup: Optional[StrictBool] = Field(None, alias="bEzsignfoldertypeSendsignedtolimitedgroup", description="Whether we send the signed Ezsigndocument to the Usergroup that has acces to only their own Ezsignfolders") - b_ezsignfoldertype_sendsignedtocolleague: StrictBool = Field(..., alias="bEzsignfoldertypeSendsignedtocolleague", description="Whether we send the signed Ezsigndocument to the colleagues") - b_ezsignfoldertype_sendsummarytodocumentowner: StrictBool = Field(..., alias="bEzsignfoldertypeSendsummarytodocumentowner", description="Whether we send the summary to the Ezsigndocument's owner") - b_ezsignfoldertype_sendsummarytofolderowner: StrictBool = Field(..., alias="bEzsignfoldertypeSendsummarytofolderowner", description="Whether we send the summary to the Ezsignfolder's owner") - b_ezsignfoldertype_sendsummarytofullgroup: Optional[StrictBool] = Field(None, alias="bEzsignfoldertypeSendsummarytofullgroup", description="Whether we send the summary to the Usergroup that has acces to all Ezsignfolders") - b_ezsignfoldertype_sendsummarytolimitedgroup: Optional[StrictBool] = Field(None, alias="bEzsignfoldertypeSendsummarytolimitedgroup", description="Whether we send the summary to the Usergroup that has acces to only their own Ezsignfolders") - b_ezsignfoldertype_sendsummarytocolleague: StrictBool = Field(..., alias="bEzsignfoldertypeSendsummarytocolleague", description="Whether we send the summary to the colleagues") - b_ezsignfoldertype_includeproofsigner: StrictBool = Field(..., alias="bEzsignfoldertypeIncludeproofsigner", description="Whether we include the proof with the signed Ezsigndocument for Ezsignsigners") - b_ezsignfoldertype_includeproofuser: StrictBool = Field(..., alias="bEzsignfoldertypeIncludeproofuser", description="Whether we include the proof with the signed Ezsigndocument for users") - b_ezsignfoldertype_isactive: StrictBool = Field(..., alias="bEzsignfoldertypeIsactive", description="Whether the Ezsignfoldertype is active or not") - __properties = ["pkiEzsignfoldertypeID", "objEzsignfoldertypeName", "fkiBrandingID", "fkiBillingentityinternalID", "fkiUsergroupID", "fkiUsergroupIDRestricted", "fkiEzsigntsarequirementID", "sBrandingDescriptionX", "sBillingentityinternalDescriptionX", "sEzsigntsarequirementDescriptionX", "sEmailAddressSigned", "sEmailAddressSummary", "sUsergroupNameX", "sUsergroupNameXRestricted", "eEzsignfoldertypePrivacylevel", "eEzsignfoldertypeSendreminderfrequency", "iEzsignfoldertypeArchivaldays", "eEzsignfoldertypeDisposal", "iEzsignfoldertypeDisposaldays", "iEzsignfoldertypeDeadlinedays", "bEzsignfoldertypeDelegate", "bEzsignfoldertypeReassign", "bEzsignfoldertypeSendattatchmentsigner", "bEzsignfoldertypeSendsignedtodocumentowner", "bEzsignfoldertypeSendsignedtofolderowner", "bEzsignfoldertypeSendsignedtofullgroup", "bEzsignfoldertypeSendsignedtolimitedgroup", "bEzsignfoldertypeSendsignedtocolleague", "bEzsignfoldertypeSendsummarytodocumentowner", "bEzsignfoldertypeSendsummarytofolderowner", "bEzsignfoldertypeSendsummarytofullgroup", "bEzsignfoldertypeSendsummarytolimitedgroup", "bEzsignfoldertypeSendsummarytocolleague", "bEzsignfoldertypeIncludeproofsigner", "bEzsignfoldertypeIncludeproofuser", "bEzsignfoldertypeIsactive"] - - @validator('s_usergroup_name_x') + A Ezsignfoldertype Object + """ # noqa: E501 + pki_ezsignfoldertype_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsignfoldertype.", alias="pkiEzsignfoldertypeID") + obj_ezsignfoldertype_name: MultilingualEzsignfoldertypeName = Field(alias="objEzsignfoldertypeName") + fki_branding_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Branding", alias="fkiBrandingID") + fki_billingentityinternal_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Billingentityinternal.", alias="fkiBillingentityinternalID") + fki_usergroup_id: Optional[Annotated[int, Field(le=255, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Usergroup", alias="fkiUsergroupID") + fki_usergroup_id_restricted: Optional[Annotated[int, Field(le=255, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Usergroup", alias="fkiUsergroupIDRestricted") + fki_ezsigntsarequirement_id: Optional[Annotated[int, Field(le=3, strict=True, ge=1)]] = Field(default=None, description="The unique ID of the Ezsigntsarequirement. Determine if a Time Stamping Authority should add a timestamp on each of the signature. Valid values: |Value|Description| |-|-| |1|No. TSA Timestamping will requested. This will make all signatures a lot faster since no round-trip to the TSA server will be required. Timestamping will be made using eZsign server's time.| |2|Best effort. Timestamping from a Time Stamping Authority will be requested but is not mandatory. In the very improbable case it cannot be completed, the timestamping will be made using eZsign server's time. **Additional fee applies**| |3|Mandatory. Timestamping from a Time Stamping Authority will be requested and is mandatory. In the very improbable case it cannot be completed, the signature will fail and the user will be asked to retry. **Additional fee applies**|", alias="fkiEzsigntsarequirementID") + s_branding_description_x: StrictStr = Field(description="The Description of the Branding in the language of the requester", alias="sBrandingDescriptionX") + s_billingentityinternal_description_x: Optional[StrictStr] = Field(default=None, description="The description of the Billingentityinternal in the language of the requester", alias="sBillingentityinternalDescriptionX") + s_ezsigntsarequirement_description_x: Optional[StrictStr] = Field(default=None, description="The description of the Ezsigntsarequirement in the language of the requester", alias="sEzsigntsarequirementDescriptionX") + s_email_address_signed: Optional[StrictStr] = Field(default=None, description="The email address.", alias="sEmailAddressSigned") + s_email_address_summary: Optional[StrictStr] = Field(default=None, description="The email address.", alias="sEmailAddressSummary") + s_usergroup_name_x: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="The Name of the Usergroup in the language of the requester", alias="sUsergroupNameX") + s_usergroup_name_x_restricted: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="The Name of the Usergroup in the language of the requester", alias="sUsergroupNameXRestricted") + e_ezsignfoldertype_privacylevel: FieldEEzsignfoldertypePrivacylevel = Field(alias="eEzsignfoldertypePrivacylevel") + e_ezsignfoldertype_sendreminderfrequency: Optional[FieldEEzsignfoldertypeSendreminderfrequency] = Field(default=None, alias="eEzsignfoldertypeSendreminderfrequency") + i_ezsignfoldertype_archivaldays: Annotated[int, Field(le=180, strict=True, ge=0)] = Field(description="The number of days before the archival of Ezsignfolders created using this Ezsignfoldertype", alias="iEzsignfoldertypeArchivaldays") + e_ezsignfoldertype_disposal: FieldEEzsignfoldertypeDisposal = Field(alias="eEzsignfoldertypeDisposal") + i_ezsignfoldertype_disposaldays: Optional[Annotated[int, Field(le=9999, strict=True, ge=0)]] = Field(default=None, description="The number of days after the archival before the disposal of the Ezsignfolder", alias="iEzsignfoldertypeDisposaldays") + i_ezsignfoldertype_deadlinedays: Annotated[int, Field(le=60, strict=True, ge=1)] = Field(description="The number of days to get all Ezsignsignatures", alias="iEzsignfoldertypeDeadlinedays") + b_ezsignfoldertype_delegate: Optional[StrictBool] = Field(default=None, description="Wheter if delegation of signature is allowed to another user or not", alias="bEzsignfoldertypeDelegate") + b_ezsignfoldertype_reassign: Optional[StrictBool] = Field(default=None, description="Wheter if Reassignment of signature is allowed to another signatory or not", alias="bEzsignfoldertypeReassign") + b_ezsignfoldertype_sendattatchmentsigner: Optional[StrictBool] = Field(default=None, description="THIS FIELD WILL BE DELETED. Whether we send the Ezsigndocument and the proof as attachment in the email", alias="bEzsignfoldertypeSendattatchmentsigner") + b_ezsignfoldertype_sendsignedtoezsignsigner: Optional[StrictBool] = Field(default=None, description="Whether we send an email to Ezsignsigner when document is completed", alias="bEzsignfoldertypeSendsignedtoezsignsigner") + b_ezsignfoldertype_sendsignedtouser: Optional[StrictBool] = Field(default=None, description="Whether we send an email to User who signed when document is completed", alias="bEzsignfoldertypeSendsignedtouser") + b_ezsignfoldertype_sendattachmentezsignsigner: Optional[StrictBool] = Field(default=None, description="Whether we send the Ezsigndocument in the email to Ezsignsigner", alias="bEzsignfoldertypeSendattachmentezsignsigner") + b_ezsignfoldertype_sendproofezsignsigner: Optional[StrictBool] = Field(default=None, description="Whether we send the proof in the email to Ezsignsigner", alias="bEzsignfoldertypeSendproofezsignsigner") + b_ezsignfoldertype_sendattachmentuser: Optional[StrictBool] = Field(default=None, description="Whether we send the Ezsigndocument in the email to User", alias="bEzsignfoldertypeSendattachmentuser") + b_ezsignfoldertype_sendproofuser: Optional[StrictBool] = Field(default=None, description="Whether we send the proof in the email to User", alias="bEzsignfoldertypeSendproofuser") + b_ezsignfoldertype_sendproofemail: Optional[StrictBool] = Field(default=None, description="Whether we send the proof in the email to external recipient", alias="bEzsignfoldertypeSendproofemail") + b_ezsignfoldertype_allowdownloadattachmentezsignsigner: Optional[StrictBool] = Field(default=None, description="Whether we allow the Ezsigndocument to be downloaded by an Ezsignsigner", alias="bEzsignfoldertypeAllowdownloadattachmentezsignsigner") + b_ezsignfoldertype_allowdownloadproofezsignsigner: Optional[StrictBool] = Field(default=None, description="Whether we allow the proof to be downloaded by an Ezsignsigner", alias="bEzsignfoldertypeAllowdownloadproofezsignsigner") + b_ezsignfoldertype_sendproofreceivealldocument: Optional[StrictBool] = Field(default=None, description="Whether we send the proof to user and Ezsignsigner who receive all documents.", alias="bEzsignfoldertypeSendproofreceivealldocument") + b_ezsignfoldertype_sendsignedtodocumentowner: StrictBool = Field(description="Whether we send the signed Ezsigndocument to the Ezsigndocument's owner", alias="bEzsignfoldertypeSendsignedtodocumentowner") + b_ezsignfoldertype_sendsignedtofolderowner: StrictBool = Field(description="Whether we send the signed Ezsigndocument to the Ezsignfolder's owner", alias="bEzsignfoldertypeSendsignedtofolderowner") + b_ezsignfoldertype_sendsignedtofullgroup: Optional[StrictBool] = Field(default=None, description="Whether we send the signed Ezsigndocument to the Usergroup that has acces to all Ezsignfolders", alias="bEzsignfoldertypeSendsignedtofullgroup") + b_ezsignfoldertype_sendsignedtolimitedgroup: Optional[StrictBool] = Field(default=None, description="THIS FIELD WILL BE DELETED. Whether we send the signed Ezsigndocument to the Usergroup that has acces to only their own Ezsignfolders", alias="bEzsignfoldertypeSendsignedtolimitedgroup") + b_ezsignfoldertype_sendsignedtocolleague: StrictBool = Field(description="Whether we send the signed Ezsigndocument to the colleagues", alias="bEzsignfoldertypeSendsignedtocolleague") + b_ezsignfoldertype_sendsummarytodocumentowner: StrictBool = Field(description="Whether we send the summary to the Ezsigndocument's owner", alias="bEzsignfoldertypeSendsummarytodocumentowner") + b_ezsignfoldertype_sendsummarytofolderowner: StrictBool = Field(description="Whether we send the summary to the Ezsignfolder's owner", alias="bEzsignfoldertypeSendsummarytofolderowner") + b_ezsignfoldertype_sendsummarytofullgroup: Optional[StrictBool] = Field(default=None, description="Whether we send the summary to the Usergroup that has acces to all Ezsignfolders", alias="bEzsignfoldertypeSendsummarytofullgroup") + b_ezsignfoldertype_sendsummarytolimitedgroup: Optional[StrictBool] = Field(default=None, description="Whether we send the summary to the Usergroup that has acces to only their own Ezsignfolders", alias="bEzsignfoldertypeSendsummarytolimitedgroup") + b_ezsignfoldertype_sendsummarytocolleague: StrictBool = Field(description="Whether we send the summary to the colleagues", alias="bEzsignfoldertypeSendsummarytocolleague") + b_ezsignfoldertype_includeproofsigner: Optional[StrictBool] = Field(default=None, description="THIS FIELD WILL BE DELETED. Whether we include the proof with the signed Ezsigndocument for Ezsignsigners", alias="bEzsignfoldertypeIncludeproofsigner") + b_ezsignfoldertype_includeproofuser: StrictBool = Field(description="Whether we include the proof with the signed Ezsigndocument for users", alias="bEzsignfoldertypeIncludeproofuser") + b_ezsignfoldertype_isactive: StrictBool = Field(description="Whether the Ezsignfoldertype is active or not", alias="bEzsignfoldertypeIsactive") + __properties: ClassVar[List[str]] = ["pkiEzsignfoldertypeID", "objEzsignfoldertypeName", "fkiBrandingID", "fkiBillingentityinternalID", "fkiUsergroupID", "fkiUsergroupIDRestricted", "fkiEzsigntsarequirementID", "sBrandingDescriptionX", "sBillingentityinternalDescriptionX", "sEzsigntsarequirementDescriptionX", "sEmailAddressSigned", "sEmailAddressSummary", "sUsergroupNameX", "sUsergroupNameXRestricted", "eEzsignfoldertypePrivacylevel", "eEzsignfoldertypeSendreminderfrequency", "iEzsignfoldertypeArchivaldays", "eEzsignfoldertypeDisposal", "iEzsignfoldertypeDisposaldays", "iEzsignfoldertypeDeadlinedays", "bEzsignfoldertypeDelegate", "bEzsignfoldertypeReassign", "bEzsignfoldertypeSendattatchmentsigner", "bEzsignfoldertypeSendsignedtoezsignsigner", "bEzsignfoldertypeSendsignedtouser", "bEzsignfoldertypeSendattachmentezsignsigner", "bEzsignfoldertypeSendproofezsignsigner", "bEzsignfoldertypeSendattachmentuser", "bEzsignfoldertypeSendproofuser", "bEzsignfoldertypeSendproofemail", "bEzsignfoldertypeAllowdownloadattachmentezsignsigner", "bEzsignfoldertypeAllowdownloadproofezsignsigner", "bEzsignfoldertypeSendproofreceivealldocument", "bEzsignfoldertypeSendsignedtodocumentowner", "bEzsignfoldertypeSendsignedtofolderowner", "bEzsignfoldertypeSendsignedtofullgroup", "bEzsignfoldertypeSendsignedtolimitedgroup", "bEzsignfoldertypeSendsignedtocolleague", "bEzsignfoldertypeSendsummarytodocumentowner", "bEzsignfoldertypeSendsummarytofolderowner", "bEzsignfoldertypeSendsummarytofullgroup", "bEzsignfoldertypeSendsummarytolimitedgroup", "bEzsignfoldertypeSendsummarytocolleague", "bEzsignfoldertypeIncludeproofsigner", "bEzsignfoldertypeIncludeproofuser", "bEzsignfoldertypeIsactive"] + + @field_validator('s_usergroup_name_x') def s_usergroup_name_x_validate_regular_expression(cls, value): """Validates the regular expression""" if value is None: @@ -78,7 +94,7 @@ def s_usergroup_name_x_validate_regular_expression(cls, value): raise ValueError(r"must validate the regular expression /^.{0,50}$/") return value - @validator('s_usergroup_name_x_restricted') + @field_validator('s_usergroup_name_x_restricted') def s_usergroup_name_x_restricted_validate_regular_expression(cls, value): """Validates the regular expression""" if value is None: @@ -88,81 +104,104 @@ def s_usergroup_name_x_restricted_validate_regular_expression(cls, value): raise ValueError(r"must validate the regular expression /^.{0,50}$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignfoldertypeResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignfoldertypeResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_ezsignfoldertype_name if self.obj_ezsignfoldertype_name: _dict['objEzsignfoldertypeName'] = self.obj_ezsignfoldertype_name.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignfoldertypeResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignfoldertypeResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignfoldertypeResponse.parse_obj(obj) - - _obj = EzsignfoldertypeResponse.parse_obj({ - "pki_ezsignfoldertype_id": obj.get("pkiEzsignfoldertypeID"), - "obj_ezsignfoldertype_name": MultilingualEzsignfoldertypeName.from_dict(obj.get("objEzsignfoldertypeName")) if obj.get("objEzsignfoldertypeName") is not None else None, - "fki_branding_id": obj.get("fkiBrandingID"), - "fki_billingentityinternal_id": obj.get("fkiBillingentityinternalID"), - "fki_usergroup_id": obj.get("fkiUsergroupID"), - "fki_usergroup_id_restricted": obj.get("fkiUsergroupIDRestricted"), - "fki_ezsigntsarequirement_id": obj.get("fkiEzsigntsarequirementID"), - "s_branding_description_x": obj.get("sBrandingDescriptionX"), - "s_billingentityinternal_description_x": obj.get("sBillingentityinternalDescriptionX"), - "s_ezsigntsarequirement_description_x": obj.get("sEzsigntsarequirementDescriptionX"), - "s_email_address_signed": obj.get("sEmailAddressSigned"), - "s_email_address_summary": obj.get("sEmailAddressSummary"), - "s_usergroup_name_x": obj.get("sUsergroupNameX"), - "s_usergroup_name_x_restricted": obj.get("sUsergroupNameXRestricted"), - "e_ezsignfoldertype_privacylevel": obj.get("eEzsignfoldertypePrivacylevel"), - "e_ezsignfoldertype_sendreminderfrequency": obj.get("eEzsignfoldertypeSendreminderfrequency"), - "i_ezsignfoldertype_archivaldays": obj.get("iEzsignfoldertypeArchivaldays"), - "e_ezsignfoldertype_disposal": obj.get("eEzsignfoldertypeDisposal"), - "i_ezsignfoldertype_disposaldays": obj.get("iEzsignfoldertypeDisposaldays"), - "i_ezsignfoldertype_deadlinedays": obj.get("iEzsignfoldertypeDeadlinedays"), - "b_ezsignfoldertype_delegate": obj.get("bEzsignfoldertypeDelegate"), - "b_ezsignfoldertype_reassign": obj.get("bEzsignfoldertypeReassign"), - "b_ezsignfoldertype_sendattatchmentsigner": obj.get("bEzsignfoldertypeSendattatchmentsigner"), - "b_ezsignfoldertype_sendsignedtodocumentowner": obj.get("bEzsignfoldertypeSendsignedtodocumentowner"), - "b_ezsignfoldertype_sendsignedtofolderowner": obj.get("bEzsignfoldertypeSendsignedtofolderowner"), - "b_ezsignfoldertype_sendsignedtofullgroup": obj.get("bEzsignfoldertypeSendsignedtofullgroup"), - "b_ezsignfoldertype_sendsignedtolimitedgroup": obj.get("bEzsignfoldertypeSendsignedtolimitedgroup"), - "b_ezsignfoldertype_sendsignedtocolleague": obj.get("bEzsignfoldertypeSendsignedtocolleague"), - "b_ezsignfoldertype_sendsummarytodocumentowner": obj.get("bEzsignfoldertypeSendsummarytodocumentowner"), - "b_ezsignfoldertype_sendsummarytofolderowner": obj.get("bEzsignfoldertypeSendsummarytofolderowner"), - "b_ezsignfoldertype_sendsummarytofullgroup": obj.get("bEzsignfoldertypeSendsummarytofullgroup"), - "b_ezsignfoldertype_sendsummarytolimitedgroup": obj.get("bEzsignfoldertypeSendsummarytolimitedgroup"), - "b_ezsignfoldertype_sendsummarytocolleague": obj.get("bEzsignfoldertypeSendsummarytocolleague"), - "b_ezsignfoldertype_includeproofsigner": obj.get("bEzsignfoldertypeIncludeproofsigner"), - "b_ezsignfoldertype_includeproofuser": obj.get("bEzsignfoldertypeIncludeproofuser"), - "b_ezsignfoldertype_isactive": obj.get("bEzsignfoldertypeIsactive") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsignfoldertypeID": obj.get("pkiEzsignfoldertypeID"), + "objEzsignfoldertypeName": MultilingualEzsignfoldertypeName.from_dict(obj.get("objEzsignfoldertypeName")) if obj.get("objEzsignfoldertypeName") is not None else None, + "fkiBrandingID": obj.get("fkiBrandingID"), + "fkiBillingentityinternalID": obj.get("fkiBillingentityinternalID"), + "fkiUsergroupID": obj.get("fkiUsergroupID"), + "fkiUsergroupIDRestricted": obj.get("fkiUsergroupIDRestricted"), + "fkiEzsigntsarequirementID": obj.get("fkiEzsigntsarequirementID"), + "sBrandingDescriptionX": obj.get("sBrandingDescriptionX"), + "sBillingentityinternalDescriptionX": obj.get("sBillingentityinternalDescriptionX"), + "sEzsigntsarequirementDescriptionX": obj.get("sEzsigntsarequirementDescriptionX"), + "sEmailAddressSigned": obj.get("sEmailAddressSigned"), + "sEmailAddressSummary": obj.get("sEmailAddressSummary"), + "sUsergroupNameX": obj.get("sUsergroupNameX"), + "sUsergroupNameXRestricted": obj.get("sUsergroupNameXRestricted"), + "eEzsignfoldertypePrivacylevel": obj.get("eEzsignfoldertypePrivacylevel"), + "eEzsignfoldertypeSendreminderfrequency": obj.get("eEzsignfoldertypeSendreminderfrequency"), + "iEzsignfoldertypeArchivaldays": obj.get("iEzsignfoldertypeArchivaldays"), + "eEzsignfoldertypeDisposal": obj.get("eEzsignfoldertypeDisposal"), + "iEzsignfoldertypeDisposaldays": obj.get("iEzsignfoldertypeDisposaldays"), + "iEzsignfoldertypeDeadlinedays": obj.get("iEzsignfoldertypeDeadlinedays"), + "bEzsignfoldertypeDelegate": obj.get("bEzsignfoldertypeDelegate"), + "bEzsignfoldertypeReassign": obj.get("bEzsignfoldertypeReassign"), + "bEzsignfoldertypeSendattatchmentsigner": obj.get("bEzsignfoldertypeSendattatchmentsigner"), + "bEzsignfoldertypeSendsignedtoezsignsigner": obj.get("bEzsignfoldertypeSendsignedtoezsignsigner"), + "bEzsignfoldertypeSendsignedtouser": obj.get("bEzsignfoldertypeSendsignedtouser"), + "bEzsignfoldertypeSendattachmentezsignsigner": obj.get("bEzsignfoldertypeSendattachmentezsignsigner"), + "bEzsignfoldertypeSendproofezsignsigner": obj.get("bEzsignfoldertypeSendproofezsignsigner"), + "bEzsignfoldertypeSendattachmentuser": obj.get("bEzsignfoldertypeSendattachmentuser"), + "bEzsignfoldertypeSendproofuser": obj.get("bEzsignfoldertypeSendproofuser"), + "bEzsignfoldertypeSendproofemail": obj.get("bEzsignfoldertypeSendproofemail"), + "bEzsignfoldertypeAllowdownloadattachmentezsignsigner": obj.get("bEzsignfoldertypeAllowdownloadattachmentezsignsigner"), + "bEzsignfoldertypeAllowdownloadproofezsignsigner": obj.get("bEzsignfoldertypeAllowdownloadproofezsignsigner"), + "bEzsignfoldertypeSendproofreceivealldocument": obj.get("bEzsignfoldertypeSendproofreceivealldocument"), + "bEzsignfoldertypeSendsignedtodocumentowner": obj.get("bEzsignfoldertypeSendsignedtodocumentowner"), + "bEzsignfoldertypeSendsignedtofolderowner": obj.get("bEzsignfoldertypeSendsignedtofolderowner"), + "bEzsignfoldertypeSendsignedtofullgroup": obj.get("bEzsignfoldertypeSendsignedtofullgroup"), + "bEzsignfoldertypeSendsignedtolimitedgroup": obj.get("bEzsignfoldertypeSendsignedtolimitedgroup"), + "bEzsignfoldertypeSendsignedtocolleague": obj.get("bEzsignfoldertypeSendsignedtocolleague"), + "bEzsignfoldertypeSendsummarytodocumentowner": obj.get("bEzsignfoldertypeSendsummarytodocumentowner"), + "bEzsignfoldertypeSendsummarytofolderowner": obj.get("bEzsignfoldertypeSendsummarytofolderowner"), + "bEzsignfoldertypeSendsummarytofullgroup": obj.get("bEzsignfoldertypeSendsummarytofullgroup"), + "bEzsignfoldertypeSendsummarytolimitedgroup": obj.get("bEzsignfoldertypeSendsummarytolimitedgroup"), + "bEzsignfoldertypeSendsummarytocolleague": obj.get("bEzsignfoldertypeSendsummarytocolleague"), + "bEzsignfoldertypeIncludeproofsigner": obj.get("bEzsignfoldertypeIncludeproofsigner"), + "bEzsignfoldertypeIncludeproofuser": obj.get("bEzsignfoldertypeIncludeproofuser"), + "bEzsignfoldertypeIsactive": obj.get("bEzsignfoldertypeIsactive") }) return _obj diff --git a/eZmaxApi/models/ezsignfoldertype_response_compound.py b/eZmaxApi/models/ezsignfoldertype_response_compound.py index 511cacc5e..43c4671c2 100644 --- a/eZmaxApi/models/ezsignfoldertype_response_compound.py +++ b/eZmaxApi/models/ezsignfoldertype_response_compound.py @@ -19,58 +19,74 @@ import json -from typing import List, Optional -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint, conlist, constr, validator +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, StrictStr, field_validator +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.field_e_ezsignfoldertype_disposal import FieldEEzsignfoldertypeDisposal from eZmaxApi.models.field_e_ezsignfoldertype_privacylevel import FieldEEzsignfoldertypePrivacylevel from eZmaxApi.models.field_e_ezsignfoldertype_sendreminderfrequency import FieldEEzsignfoldertypeSendreminderfrequency from eZmaxApi.models.multilingual_ezsignfoldertype_name import MultilingualEzsignfoldertypeName +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignfoldertypeResponseCompound(BaseModel): """ - A Ezsignfoldertype Object # noqa: E501 - """ - pki_ezsignfoldertype_id: conint(strict=True, ge=0) = Field(..., alias="pkiEzsignfoldertypeID", description="The unique ID of the Ezsignfoldertype.") - obj_ezsignfoldertype_name: MultilingualEzsignfoldertypeName = Field(..., alias="objEzsignfoldertypeName") - fki_branding_id: conint(strict=True, ge=0) = Field(..., alias="fkiBrandingID", description="The unique ID of the Branding") - fki_billingentityinternal_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiBillingentityinternalID", description="The unique ID of the Billingentityinternal.") - fki_usergroup_id: Optional[conint(strict=True, le=255, ge=0)] = Field(None, alias="fkiUsergroupID", description="The unique ID of the Usergroup") - fki_usergroup_id_restricted: Optional[conint(strict=True, le=255, ge=0)] = Field(None, alias="fkiUsergroupIDRestricted", description="The unique ID of the Usergroup") - fki_ezsigntsarequirement_id: Optional[conint(strict=True, le=3, ge=1)] = Field(None, alias="fkiEzsigntsarequirementID", description="The unique ID of the Ezsigntsarequirement. Determine if a Time Stamping Authority should add a timestamp on each of the signature. Valid values: |Value|Description| |-|-| |1|No. TSA Timestamping will requested. This will make all signatures a lot faster since no round-trip to the TSA server will be required. Timestamping will be made using eZsign server's time.| |2|Best effort. Timestamping from a Time Stamping Authority will be requested but is not mandatory. In the very improbable case it cannot be completed, the timestamping will be made using eZsign server's time. **Additional fee applies**| |3|Mandatory. Timestamping from a Time Stamping Authority will be requested and is mandatory. In the very improbable case it cannot be completed, the signature will fail and the user will be asked to retry. **Additional fee applies**|") - s_branding_description_x: StrictStr = Field(..., alias="sBrandingDescriptionX", description="The Description of the Branding in the language of the requester") - s_billingentityinternal_description_x: Optional[StrictStr] = Field(None, alias="sBillingentityinternalDescriptionX", description="The description of the Billingentityinternal in the language of the requester") - s_ezsigntsarequirement_description_x: Optional[StrictStr] = Field(None, alias="sEzsigntsarequirementDescriptionX", description="The description of the Ezsigntsarequirement in the language of the requester") - s_email_address_signed: Optional[StrictStr] = Field(None, alias="sEmailAddressSigned", description="The email address.") - s_email_address_summary: Optional[StrictStr] = Field(None, alias="sEmailAddressSummary", description="The email address.") - s_usergroup_name_x: Optional[constr(strict=True)] = Field(None, alias="sUsergroupNameX", description="The Name of the Usergroup in the language of the requester") - s_usergroup_name_x_restricted: Optional[constr(strict=True)] = Field(None, alias="sUsergroupNameXRestricted", description="The Name of the Usergroup in the language of the requester") - e_ezsignfoldertype_privacylevel: FieldEEzsignfoldertypePrivacylevel = Field(..., alias="eEzsignfoldertypePrivacylevel") - e_ezsignfoldertype_sendreminderfrequency: Optional[FieldEEzsignfoldertypeSendreminderfrequency] = Field(None, alias="eEzsignfoldertypeSendreminderfrequency") - i_ezsignfoldertype_archivaldays: conint(strict=True, le=180, ge=0) = Field(..., alias="iEzsignfoldertypeArchivaldays", description="The number of days before the archival of Ezsignfolders created using this Ezsignfoldertype") - e_ezsignfoldertype_disposal: FieldEEzsignfoldertypeDisposal = Field(..., alias="eEzsignfoldertypeDisposal") - i_ezsignfoldertype_disposaldays: Optional[conint(strict=True, le=9999, ge=0)] = Field(None, alias="iEzsignfoldertypeDisposaldays", description="The number of days after the archival before the disposal of the Ezsignfolder") - i_ezsignfoldertype_deadlinedays: conint(strict=True, le=60, ge=1) = Field(..., alias="iEzsignfoldertypeDeadlinedays", description="The number of days to get all Ezsignsignatures") - b_ezsignfoldertype_delegate: Optional[StrictBool] = Field(None, alias="bEzsignfoldertypeDelegate", description="Wheter if delegation of signature is allowed to another user or not") - b_ezsignfoldertype_reassign: Optional[StrictBool] = Field(None, alias="bEzsignfoldertypeReassign", description="Wheter if Reassignment of signature is allowed to another signatory or not") - b_ezsignfoldertype_sendattatchmentsigner: StrictBool = Field(..., alias="bEzsignfoldertypeSendattatchmentsigner", description="Whether we send the Ezsigndocument and the proof as attachment in the email") - b_ezsignfoldertype_sendsignedtodocumentowner: StrictBool = Field(..., alias="bEzsignfoldertypeSendsignedtodocumentowner", description="Whether we send the signed Ezsigndocument to the Ezsigndocument's owner") - b_ezsignfoldertype_sendsignedtofolderowner: StrictBool = Field(..., alias="bEzsignfoldertypeSendsignedtofolderowner", description="Whether we send the signed Ezsigndocument to the Ezsignfolder's owner") - b_ezsignfoldertype_sendsignedtofullgroup: Optional[StrictBool] = Field(None, alias="bEzsignfoldertypeSendsignedtofullgroup", description="Whether we send the signed Ezsigndocument to the Usergroup that has acces to all Ezsignfolders") - b_ezsignfoldertype_sendsignedtolimitedgroup: Optional[StrictBool] = Field(None, alias="bEzsignfoldertypeSendsignedtolimitedgroup", description="Whether we send the signed Ezsigndocument to the Usergroup that has acces to only their own Ezsignfolders") - b_ezsignfoldertype_sendsignedtocolleague: StrictBool = Field(..., alias="bEzsignfoldertypeSendsignedtocolleague", description="Whether we send the signed Ezsigndocument to the colleagues") - b_ezsignfoldertype_sendsummarytodocumentowner: StrictBool = Field(..., alias="bEzsignfoldertypeSendsummarytodocumentowner", description="Whether we send the summary to the Ezsigndocument's owner") - b_ezsignfoldertype_sendsummarytofolderowner: StrictBool = Field(..., alias="bEzsignfoldertypeSendsummarytofolderowner", description="Whether we send the summary to the Ezsignfolder's owner") - b_ezsignfoldertype_sendsummarytofullgroup: Optional[StrictBool] = Field(None, alias="bEzsignfoldertypeSendsummarytofullgroup", description="Whether we send the summary to the Usergroup that has acces to all Ezsignfolders") - b_ezsignfoldertype_sendsummarytolimitedgroup: Optional[StrictBool] = Field(None, alias="bEzsignfoldertypeSendsummarytolimitedgroup", description="Whether we send the summary to the Usergroup that has acces to only their own Ezsignfolders") - b_ezsignfoldertype_sendsummarytocolleague: StrictBool = Field(..., alias="bEzsignfoldertypeSendsummarytocolleague", description="Whether we send the summary to the colleagues") - b_ezsignfoldertype_includeproofsigner: StrictBool = Field(..., alias="bEzsignfoldertypeIncludeproofsigner", description="Whether we include the proof with the signed Ezsigndocument for Ezsignsigners") - b_ezsignfoldertype_includeproofuser: StrictBool = Field(..., alias="bEzsignfoldertypeIncludeproofuser", description="Whether we include the proof with the signed Ezsigndocument for users") - b_ezsignfoldertype_isactive: StrictBool = Field(..., alias="bEzsignfoldertypeIsactive", description="Whether the Ezsignfoldertype is active or not") - a_fki_user_id_signed: Optional[conlist(conint(strict=True, ge=0))] = Field(None, alias="a_fkiUserIDSigned") - a_fki_user_id_summary: Optional[conlist(conint(strict=True, ge=0))] = Field(None, alias="a_fkiUserIDSummary") - __properties = ["pkiEzsignfoldertypeID", "objEzsignfoldertypeName", "fkiBrandingID", "fkiBillingentityinternalID", "fkiUsergroupID", "fkiUsergroupIDRestricted", "fkiEzsigntsarequirementID", "sBrandingDescriptionX", "sBillingentityinternalDescriptionX", "sEzsigntsarequirementDescriptionX", "sEmailAddressSigned", "sEmailAddressSummary", "sUsergroupNameX", "sUsergroupNameXRestricted", "eEzsignfoldertypePrivacylevel", "eEzsignfoldertypeSendreminderfrequency", "iEzsignfoldertypeArchivaldays", "eEzsignfoldertypeDisposal", "iEzsignfoldertypeDisposaldays", "iEzsignfoldertypeDeadlinedays", "bEzsignfoldertypeDelegate", "bEzsignfoldertypeReassign", "bEzsignfoldertypeSendattatchmentsigner", "bEzsignfoldertypeSendsignedtodocumentowner", "bEzsignfoldertypeSendsignedtofolderowner", "bEzsignfoldertypeSendsignedtofullgroup", "bEzsignfoldertypeSendsignedtolimitedgroup", "bEzsignfoldertypeSendsignedtocolleague", "bEzsignfoldertypeSendsummarytodocumentowner", "bEzsignfoldertypeSendsummarytofolderowner", "bEzsignfoldertypeSendsummarytofullgroup", "bEzsignfoldertypeSendsummarytolimitedgroup", "bEzsignfoldertypeSendsummarytocolleague", "bEzsignfoldertypeIncludeproofsigner", "bEzsignfoldertypeIncludeproofuser", "bEzsignfoldertypeIsactive", "a_fkiUserIDSigned", "a_fkiUserIDSummary"] - - @validator('s_usergroup_name_x') + A Ezsignfoldertype Object + """ # noqa: E501 + pki_ezsignfoldertype_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsignfoldertype.", alias="pkiEzsignfoldertypeID") + obj_ezsignfoldertype_name: MultilingualEzsignfoldertypeName = Field(alias="objEzsignfoldertypeName") + fki_branding_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Branding", alias="fkiBrandingID") + fki_billingentityinternal_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Billingentityinternal.", alias="fkiBillingentityinternalID") + fki_usergroup_id: Optional[Annotated[int, Field(le=255, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Usergroup", alias="fkiUsergroupID") + fki_usergroup_id_restricted: Optional[Annotated[int, Field(le=255, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Usergroup", alias="fkiUsergroupIDRestricted") + fki_ezsigntsarequirement_id: Optional[Annotated[int, Field(le=3, strict=True, ge=1)]] = Field(default=None, description="The unique ID of the Ezsigntsarequirement. Determine if a Time Stamping Authority should add a timestamp on each of the signature. Valid values: |Value|Description| |-|-| |1|No. TSA Timestamping will requested. This will make all signatures a lot faster since no round-trip to the TSA server will be required. Timestamping will be made using eZsign server's time.| |2|Best effort. Timestamping from a Time Stamping Authority will be requested but is not mandatory. In the very improbable case it cannot be completed, the timestamping will be made using eZsign server's time. **Additional fee applies**| |3|Mandatory. Timestamping from a Time Stamping Authority will be requested and is mandatory. In the very improbable case it cannot be completed, the signature will fail and the user will be asked to retry. **Additional fee applies**|", alias="fkiEzsigntsarequirementID") + s_branding_description_x: StrictStr = Field(description="The Description of the Branding in the language of the requester", alias="sBrandingDescriptionX") + s_billingentityinternal_description_x: Optional[StrictStr] = Field(default=None, description="The description of the Billingentityinternal in the language of the requester", alias="sBillingentityinternalDescriptionX") + s_ezsigntsarequirement_description_x: Optional[StrictStr] = Field(default=None, description="The description of the Ezsigntsarequirement in the language of the requester", alias="sEzsigntsarequirementDescriptionX") + s_email_address_signed: Optional[StrictStr] = Field(default=None, description="The email address.", alias="sEmailAddressSigned") + s_email_address_summary: Optional[StrictStr] = Field(default=None, description="The email address.", alias="sEmailAddressSummary") + s_usergroup_name_x: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="The Name of the Usergroup in the language of the requester", alias="sUsergroupNameX") + s_usergroup_name_x_restricted: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="The Name of the Usergroup in the language of the requester", alias="sUsergroupNameXRestricted") + e_ezsignfoldertype_privacylevel: FieldEEzsignfoldertypePrivacylevel = Field(alias="eEzsignfoldertypePrivacylevel") + e_ezsignfoldertype_sendreminderfrequency: Optional[FieldEEzsignfoldertypeSendreminderfrequency] = Field(default=None, alias="eEzsignfoldertypeSendreminderfrequency") + i_ezsignfoldertype_archivaldays: Annotated[int, Field(le=180, strict=True, ge=0)] = Field(description="The number of days before the archival of Ezsignfolders created using this Ezsignfoldertype", alias="iEzsignfoldertypeArchivaldays") + e_ezsignfoldertype_disposal: FieldEEzsignfoldertypeDisposal = Field(alias="eEzsignfoldertypeDisposal") + i_ezsignfoldertype_disposaldays: Optional[Annotated[int, Field(le=9999, strict=True, ge=0)]] = Field(default=None, description="The number of days after the archival before the disposal of the Ezsignfolder", alias="iEzsignfoldertypeDisposaldays") + i_ezsignfoldertype_deadlinedays: Annotated[int, Field(le=60, strict=True, ge=1)] = Field(description="The number of days to get all Ezsignsignatures", alias="iEzsignfoldertypeDeadlinedays") + b_ezsignfoldertype_delegate: Optional[StrictBool] = Field(default=None, description="Wheter if delegation of signature is allowed to another user or not", alias="bEzsignfoldertypeDelegate") + b_ezsignfoldertype_reassign: Optional[StrictBool] = Field(default=None, description="Wheter if Reassignment of signature is allowed to another signatory or not", alias="bEzsignfoldertypeReassign") + b_ezsignfoldertype_sendattatchmentsigner: Optional[StrictBool] = Field(default=None, description="THIS FIELD WILL BE DELETED. Whether we send the Ezsigndocument and the proof as attachment in the email", alias="bEzsignfoldertypeSendattatchmentsigner") + b_ezsignfoldertype_sendsignedtoezsignsigner: Optional[StrictBool] = Field(default=None, description="Whether we send an email to Ezsignsigner when document is completed", alias="bEzsignfoldertypeSendsignedtoezsignsigner") + b_ezsignfoldertype_sendsignedtouser: Optional[StrictBool] = Field(default=None, description="Whether we send an email to User who signed when document is completed", alias="bEzsignfoldertypeSendsignedtouser") + b_ezsignfoldertype_sendattachmentezsignsigner: Optional[StrictBool] = Field(default=None, description="Whether we send the Ezsigndocument in the email to Ezsignsigner", alias="bEzsignfoldertypeSendattachmentezsignsigner") + b_ezsignfoldertype_sendproofezsignsigner: Optional[StrictBool] = Field(default=None, description="Whether we send the proof in the email to Ezsignsigner", alias="bEzsignfoldertypeSendproofezsignsigner") + b_ezsignfoldertype_sendattachmentuser: Optional[StrictBool] = Field(default=None, description="Whether we send the Ezsigndocument in the email to User", alias="bEzsignfoldertypeSendattachmentuser") + b_ezsignfoldertype_sendproofuser: Optional[StrictBool] = Field(default=None, description="Whether we send the proof in the email to User", alias="bEzsignfoldertypeSendproofuser") + b_ezsignfoldertype_sendproofemail: Optional[StrictBool] = Field(default=None, description="Whether we send the proof in the email to external recipient", alias="bEzsignfoldertypeSendproofemail") + b_ezsignfoldertype_allowdownloadattachmentezsignsigner: Optional[StrictBool] = Field(default=None, description="Whether we allow the Ezsigndocument to be downloaded by an Ezsignsigner", alias="bEzsignfoldertypeAllowdownloadattachmentezsignsigner") + b_ezsignfoldertype_allowdownloadproofezsignsigner: Optional[StrictBool] = Field(default=None, description="Whether we allow the proof to be downloaded by an Ezsignsigner", alias="bEzsignfoldertypeAllowdownloadproofezsignsigner") + b_ezsignfoldertype_sendproofreceivealldocument: Optional[StrictBool] = Field(default=None, description="Whether we send the proof to user and Ezsignsigner who receive all documents.", alias="bEzsignfoldertypeSendproofreceivealldocument") + b_ezsignfoldertype_sendsignedtodocumentowner: StrictBool = Field(description="Whether we send the signed Ezsigndocument to the Ezsigndocument's owner", alias="bEzsignfoldertypeSendsignedtodocumentowner") + b_ezsignfoldertype_sendsignedtofolderowner: StrictBool = Field(description="Whether we send the signed Ezsigndocument to the Ezsignfolder's owner", alias="bEzsignfoldertypeSendsignedtofolderowner") + b_ezsignfoldertype_sendsignedtofullgroup: Optional[StrictBool] = Field(default=None, description="Whether we send the signed Ezsigndocument to the Usergroup that has acces to all Ezsignfolders", alias="bEzsignfoldertypeSendsignedtofullgroup") + b_ezsignfoldertype_sendsignedtolimitedgroup: Optional[StrictBool] = Field(default=None, description="THIS FIELD WILL BE DELETED. Whether we send the signed Ezsigndocument to the Usergroup that has acces to only their own Ezsignfolders", alias="bEzsignfoldertypeSendsignedtolimitedgroup") + b_ezsignfoldertype_sendsignedtocolleague: StrictBool = Field(description="Whether we send the signed Ezsigndocument to the colleagues", alias="bEzsignfoldertypeSendsignedtocolleague") + b_ezsignfoldertype_sendsummarytodocumentowner: StrictBool = Field(description="Whether we send the summary to the Ezsigndocument's owner", alias="bEzsignfoldertypeSendsummarytodocumentowner") + b_ezsignfoldertype_sendsummarytofolderowner: StrictBool = Field(description="Whether we send the summary to the Ezsignfolder's owner", alias="bEzsignfoldertypeSendsummarytofolderowner") + b_ezsignfoldertype_sendsummarytofullgroup: Optional[StrictBool] = Field(default=None, description="Whether we send the summary to the Usergroup that has acces to all Ezsignfolders", alias="bEzsignfoldertypeSendsummarytofullgroup") + b_ezsignfoldertype_sendsummarytolimitedgroup: Optional[StrictBool] = Field(default=None, description="Whether we send the summary to the Usergroup that has acces to only their own Ezsignfolders", alias="bEzsignfoldertypeSendsummarytolimitedgroup") + b_ezsignfoldertype_sendsummarytocolleague: StrictBool = Field(description="Whether we send the summary to the colleagues", alias="bEzsignfoldertypeSendsummarytocolleague") + b_ezsignfoldertype_includeproofsigner: Optional[StrictBool] = Field(default=None, description="THIS FIELD WILL BE DELETED. Whether we include the proof with the signed Ezsigndocument for Ezsignsigners", alias="bEzsignfoldertypeIncludeproofsigner") + b_ezsignfoldertype_includeproofuser: StrictBool = Field(description="Whether we include the proof with the signed Ezsigndocument for users", alias="bEzsignfoldertypeIncludeproofuser") + b_ezsignfoldertype_isactive: StrictBool = Field(description="Whether the Ezsignfoldertype is active or not", alias="bEzsignfoldertypeIsactive") + a_fki_user_id_signed: Optional[List[Annotated[int, Field(strict=True, ge=0)]]] = Field(default=None, alias="a_fkiUserIDSigned") + a_fki_user_id_summary: Optional[List[Annotated[int, Field(strict=True, ge=0)]]] = Field(default=None, alias="a_fkiUserIDSummary") + __properties: ClassVar[List[str]] = ["pkiEzsignfoldertypeID", "objEzsignfoldertypeName", "fkiBrandingID", "fkiBillingentityinternalID", "fkiUsergroupID", "fkiUsergroupIDRestricted", "fkiEzsigntsarequirementID", "sBrandingDescriptionX", "sBillingentityinternalDescriptionX", "sEzsigntsarequirementDescriptionX", "sEmailAddressSigned", "sEmailAddressSummary", "sUsergroupNameX", "sUsergroupNameXRestricted", "eEzsignfoldertypePrivacylevel", "eEzsignfoldertypeSendreminderfrequency", "iEzsignfoldertypeArchivaldays", "eEzsignfoldertypeDisposal", "iEzsignfoldertypeDisposaldays", "iEzsignfoldertypeDeadlinedays", "bEzsignfoldertypeDelegate", "bEzsignfoldertypeReassign", "bEzsignfoldertypeSendattatchmentsigner", "bEzsignfoldertypeSendsignedtoezsignsigner", "bEzsignfoldertypeSendsignedtouser", "bEzsignfoldertypeSendattachmentezsignsigner", "bEzsignfoldertypeSendproofezsignsigner", "bEzsignfoldertypeSendattachmentuser", "bEzsignfoldertypeSendproofuser", "bEzsignfoldertypeSendproofemail", "bEzsignfoldertypeAllowdownloadattachmentezsignsigner", "bEzsignfoldertypeAllowdownloadproofezsignsigner", "bEzsignfoldertypeSendproofreceivealldocument", "bEzsignfoldertypeSendsignedtodocumentowner", "bEzsignfoldertypeSendsignedtofolderowner", "bEzsignfoldertypeSendsignedtofullgroup", "bEzsignfoldertypeSendsignedtolimitedgroup", "bEzsignfoldertypeSendsignedtocolleague", "bEzsignfoldertypeSendsummarytodocumentowner", "bEzsignfoldertypeSendsummarytofolderowner", "bEzsignfoldertypeSendsummarytofullgroup", "bEzsignfoldertypeSendsummarytolimitedgroup", "bEzsignfoldertypeSendsummarytocolleague", "bEzsignfoldertypeIncludeproofsigner", "bEzsignfoldertypeIncludeproofuser", "bEzsignfoldertypeIsactive", "a_fkiUserIDSigned", "a_fkiUserIDSummary"] + + @field_validator('s_usergroup_name_x') def s_usergroup_name_x_validate_regular_expression(cls, value): """Validates the regular expression""" if value is None: @@ -80,7 +96,7 @@ def s_usergroup_name_x_validate_regular_expression(cls, value): raise ValueError(r"must validate the regular expression /^.{0,50}$/") return value - @validator('s_usergroup_name_x_restricted') + @field_validator('s_usergroup_name_x_restricted') def s_usergroup_name_x_restricted_validate_regular_expression(cls, value): """Validates the regular expression""" if value is None: @@ -90,83 +106,106 @@ def s_usergroup_name_x_restricted_validate_regular_expression(cls, value): raise ValueError(r"must validate the regular expression /^.{0,50}$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignfoldertypeResponseCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignfoldertypeResponseCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_ezsignfoldertype_name if self.obj_ezsignfoldertype_name: _dict['objEzsignfoldertypeName'] = self.obj_ezsignfoldertype_name.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignfoldertypeResponseCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignfoldertypeResponseCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignfoldertypeResponseCompound.parse_obj(obj) - - _obj = EzsignfoldertypeResponseCompound.parse_obj({ - "pki_ezsignfoldertype_id": obj.get("pkiEzsignfoldertypeID"), - "obj_ezsignfoldertype_name": MultilingualEzsignfoldertypeName.from_dict(obj.get("objEzsignfoldertypeName")) if obj.get("objEzsignfoldertypeName") is not None else None, - "fki_branding_id": obj.get("fkiBrandingID"), - "fki_billingentityinternal_id": obj.get("fkiBillingentityinternalID"), - "fki_usergroup_id": obj.get("fkiUsergroupID"), - "fki_usergroup_id_restricted": obj.get("fkiUsergroupIDRestricted"), - "fki_ezsigntsarequirement_id": obj.get("fkiEzsigntsarequirementID"), - "s_branding_description_x": obj.get("sBrandingDescriptionX"), - "s_billingentityinternal_description_x": obj.get("sBillingentityinternalDescriptionX"), - "s_ezsigntsarequirement_description_x": obj.get("sEzsigntsarequirementDescriptionX"), - "s_email_address_signed": obj.get("sEmailAddressSigned"), - "s_email_address_summary": obj.get("sEmailAddressSummary"), - "s_usergroup_name_x": obj.get("sUsergroupNameX"), - "s_usergroup_name_x_restricted": obj.get("sUsergroupNameXRestricted"), - "e_ezsignfoldertype_privacylevel": obj.get("eEzsignfoldertypePrivacylevel"), - "e_ezsignfoldertype_sendreminderfrequency": obj.get("eEzsignfoldertypeSendreminderfrequency"), - "i_ezsignfoldertype_archivaldays": obj.get("iEzsignfoldertypeArchivaldays"), - "e_ezsignfoldertype_disposal": obj.get("eEzsignfoldertypeDisposal"), - "i_ezsignfoldertype_disposaldays": obj.get("iEzsignfoldertypeDisposaldays"), - "i_ezsignfoldertype_deadlinedays": obj.get("iEzsignfoldertypeDeadlinedays"), - "b_ezsignfoldertype_delegate": obj.get("bEzsignfoldertypeDelegate"), - "b_ezsignfoldertype_reassign": obj.get("bEzsignfoldertypeReassign"), - "b_ezsignfoldertype_sendattatchmentsigner": obj.get("bEzsignfoldertypeSendattatchmentsigner"), - "b_ezsignfoldertype_sendsignedtodocumentowner": obj.get("bEzsignfoldertypeSendsignedtodocumentowner"), - "b_ezsignfoldertype_sendsignedtofolderowner": obj.get("bEzsignfoldertypeSendsignedtofolderowner"), - "b_ezsignfoldertype_sendsignedtofullgroup": obj.get("bEzsignfoldertypeSendsignedtofullgroup"), - "b_ezsignfoldertype_sendsignedtolimitedgroup": obj.get("bEzsignfoldertypeSendsignedtolimitedgroup"), - "b_ezsignfoldertype_sendsignedtocolleague": obj.get("bEzsignfoldertypeSendsignedtocolleague"), - "b_ezsignfoldertype_sendsummarytodocumentowner": obj.get("bEzsignfoldertypeSendsummarytodocumentowner"), - "b_ezsignfoldertype_sendsummarytofolderowner": obj.get("bEzsignfoldertypeSendsummarytofolderowner"), - "b_ezsignfoldertype_sendsummarytofullgroup": obj.get("bEzsignfoldertypeSendsummarytofullgroup"), - "b_ezsignfoldertype_sendsummarytolimitedgroup": obj.get("bEzsignfoldertypeSendsummarytolimitedgroup"), - "b_ezsignfoldertype_sendsummarytocolleague": obj.get("bEzsignfoldertypeSendsummarytocolleague"), - "b_ezsignfoldertype_includeproofsigner": obj.get("bEzsignfoldertypeIncludeproofsigner"), - "b_ezsignfoldertype_includeproofuser": obj.get("bEzsignfoldertypeIncludeproofuser"), - "b_ezsignfoldertype_isactive": obj.get("bEzsignfoldertypeIsactive"), - "a_fki_user_id_signed": obj.get("a_fkiUserIDSigned"), - "a_fki_user_id_summary": obj.get("a_fkiUserIDSummary") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsignfoldertypeID": obj.get("pkiEzsignfoldertypeID"), + "objEzsignfoldertypeName": MultilingualEzsignfoldertypeName.from_dict(obj.get("objEzsignfoldertypeName")) if obj.get("objEzsignfoldertypeName") is not None else None, + "fkiBrandingID": obj.get("fkiBrandingID"), + "fkiBillingentityinternalID": obj.get("fkiBillingentityinternalID"), + "fkiUsergroupID": obj.get("fkiUsergroupID"), + "fkiUsergroupIDRestricted": obj.get("fkiUsergroupIDRestricted"), + "fkiEzsigntsarequirementID": obj.get("fkiEzsigntsarequirementID"), + "sBrandingDescriptionX": obj.get("sBrandingDescriptionX"), + "sBillingentityinternalDescriptionX": obj.get("sBillingentityinternalDescriptionX"), + "sEzsigntsarequirementDescriptionX": obj.get("sEzsigntsarequirementDescriptionX"), + "sEmailAddressSigned": obj.get("sEmailAddressSigned"), + "sEmailAddressSummary": obj.get("sEmailAddressSummary"), + "sUsergroupNameX": obj.get("sUsergroupNameX"), + "sUsergroupNameXRestricted": obj.get("sUsergroupNameXRestricted"), + "eEzsignfoldertypePrivacylevel": obj.get("eEzsignfoldertypePrivacylevel"), + "eEzsignfoldertypeSendreminderfrequency": obj.get("eEzsignfoldertypeSendreminderfrequency"), + "iEzsignfoldertypeArchivaldays": obj.get("iEzsignfoldertypeArchivaldays"), + "eEzsignfoldertypeDisposal": obj.get("eEzsignfoldertypeDisposal"), + "iEzsignfoldertypeDisposaldays": obj.get("iEzsignfoldertypeDisposaldays"), + "iEzsignfoldertypeDeadlinedays": obj.get("iEzsignfoldertypeDeadlinedays"), + "bEzsignfoldertypeDelegate": obj.get("bEzsignfoldertypeDelegate"), + "bEzsignfoldertypeReassign": obj.get("bEzsignfoldertypeReassign"), + "bEzsignfoldertypeSendattatchmentsigner": obj.get("bEzsignfoldertypeSendattatchmentsigner"), + "bEzsignfoldertypeSendsignedtoezsignsigner": obj.get("bEzsignfoldertypeSendsignedtoezsignsigner"), + "bEzsignfoldertypeSendsignedtouser": obj.get("bEzsignfoldertypeSendsignedtouser"), + "bEzsignfoldertypeSendattachmentezsignsigner": obj.get("bEzsignfoldertypeSendattachmentezsignsigner"), + "bEzsignfoldertypeSendproofezsignsigner": obj.get("bEzsignfoldertypeSendproofezsignsigner"), + "bEzsignfoldertypeSendattachmentuser": obj.get("bEzsignfoldertypeSendattachmentuser"), + "bEzsignfoldertypeSendproofuser": obj.get("bEzsignfoldertypeSendproofuser"), + "bEzsignfoldertypeSendproofemail": obj.get("bEzsignfoldertypeSendproofemail"), + "bEzsignfoldertypeAllowdownloadattachmentezsignsigner": obj.get("bEzsignfoldertypeAllowdownloadattachmentezsignsigner"), + "bEzsignfoldertypeAllowdownloadproofezsignsigner": obj.get("bEzsignfoldertypeAllowdownloadproofezsignsigner"), + "bEzsignfoldertypeSendproofreceivealldocument": obj.get("bEzsignfoldertypeSendproofreceivealldocument"), + "bEzsignfoldertypeSendsignedtodocumentowner": obj.get("bEzsignfoldertypeSendsignedtodocumentowner"), + "bEzsignfoldertypeSendsignedtofolderowner": obj.get("bEzsignfoldertypeSendsignedtofolderowner"), + "bEzsignfoldertypeSendsignedtofullgroup": obj.get("bEzsignfoldertypeSendsignedtofullgroup"), + "bEzsignfoldertypeSendsignedtolimitedgroup": obj.get("bEzsignfoldertypeSendsignedtolimitedgroup"), + "bEzsignfoldertypeSendsignedtocolleague": obj.get("bEzsignfoldertypeSendsignedtocolleague"), + "bEzsignfoldertypeSendsummarytodocumentowner": obj.get("bEzsignfoldertypeSendsummarytodocumentowner"), + "bEzsignfoldertypeSendsummarytofolderowner": obj.get("bEzsignfoldertypeSendsummarytofolderowner"), + "bEzsignfoldertypeSendsummarytofullgroup": obj.get("bEzsignfoldertypeSendsummarytofullgroup"), + "bEzsignfoldertypeSendsummarytolimitedgroup": obj.get("bEzsignfoldertypeSendsummarytolimitedgroup"), + "bEzsignfoldertypeSendsummarytocolleague": obj.get("bEzsignfoldertypeSendsummarytocolleague"), + "bEzsignfoldertypeIncludeproofsigner": obj.get("bEzsignfoldertypeIncludeproofsigner"), + "bEzsignfoldertypeIncludeproofuser": obj.get("bEzsignfoldertypeIncludeproofuser"), + "bEzsignfoldertypeIsactive": obj.get("bEzsignfoldertypeIsactive"), + "a_fkiUserIDSigned": obj.get("a_fkiUserIDSigned"), + "a_fkiUserIDSummary": obj.get("a_fkiUserIDSummary") }) return _obj diff --git a/eZmaxApi/models/ezsignformfield_request.py b/eZmaxApi/models/ezsignformfield_request.py index 61ed066d2..f0e0b568b 100644 --- a/eZmaxApi/models/ezsignformfield_request.py +++ b/eZmaxApi/models/ezsignformfield_request.py @@ -19,76 +19,95 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, StrictStr +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.field_e_ezsignformfield_dependencyrequirement import FieldEEzsignformfieldDependencyrequirement +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignformfieldRequest(BaseModel): """ - A Ezsignformfield Object # noqa: E501 - """ - pki_ezsignformfield_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="pkiEzsignformfieldID", description="The unique ID of the Ezsignformfield") - i_ezsignpage_pagenumber: conint(strict=True, ge=1) = Field(..., alias="iEzsignpagePagenumber", description="The page number in the Ezsigndocument") - s_ezsignformfield_label: StrictStr = Field(..., alias="sEzsignformfieldLabel", description="The Label for the Ezsignformfield") - s_ezsignformfield_value: Optional[StrictStr] = Field(None, alias="sEzsignformfieldValue", description="The value for the Ezsignformfield This can only be set if eEzsignformfieldgroupType is Checkbox or Radio") - i_ezsignformfield_x: conint(strict=True, ge=0) = Field(..., alias="iEzsignformfieldX", description="The X coordinate (Horizontal) where to put the Ezsignformfield on the Ezsignpage. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsignformfield 2 inches from the left border of the page, you would use \"200\" for the X coordinate.") - i_ezsignformfield_y: conint(strict=True, ge=0) = Field(..., alias="iEzsignformfieldY", description="The Y coordinate (Vertical) where to put the Ezsignformfield on the Ezsignpage. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsignformfield 3 inches from the top border of the page, you would use \"300\" for the Y coordinate.") - i_ezsignformfield_width: conint(strict=True, ge=0) = Field(..., alias="iEzsignformfieldWidth", description="The Width of the Ezsignformfield in pixels calculated at 100 DPI The allowed values are varying based on the eEzsignformfieldgroupType. | eEzsignformfieldgroupType | Valid values | | ------------------------- | ------------ | | Checkbox | 22 | | Dropdown | 22-65535 | | Radio | 22 | | Text | 22-65535 | | Textarea | 22-65535 |") - i_ezsignformfield_height: conint(strict=True, ge=0) = Field(..., alias="iEzsignformfieldHeight", description="The Height of the Ezsignformfield in pixels calculated at 100 DPI The allowed values are varying based on the eEzsignformfieldgroupType. | eEzsignformfieldgroupType | Valid values | | ------------------------- | ------------ | | Checkbox | 22 | | Dropdown | 22 | | Radio | 22 | | Text | 22 | | Textarea | 22-65535 | ") - b_ezsignformfield_autocomplete: Optional[StrictBool] = Field(None, alias="bEzsignformfieldAutocomplete", description="Whether the Ezsignformfield allows the use of the autocomplete of the browser. This can only be set if eEzsignformfieldgroupType is **Text**") - b_ezsignformfield_selected: Optional[StrictBool] = Field(None, alias="bEzsignformfieldSelected", description="Whether the Ezsignformfield is selected or not by default. This can only be set if eEzsignformfieldgroupType is **Checkbox** or **Radio**") - s_ezsignformfield_enteredvalue: Optional[StrictStr] = Field(None, alias="sEzsignformfieldEnteredvalue", description="This is the value enterred for the Ezsignformfield This can only be set if eEzsignformfieldgroupType is **Dropdown**, **Text** or **Textarea**") - e_ezsignformfield_dependencyrequirement: Optional[FieldEEzsignformfieldDependencyrequirement] = Field(None, alias="eEzsignformfieldDependencyrequirement") - __properties = ["pkiEzsignformfieldID", "iEzsignpagePagenumber", "sEzsignformfieldLabel", "sEzsignformfieldValue", "iEzsignformfieldX", "iEzsignformfieldY", "iEzsignformfieldWidth", "iEzsignformfieldHeight", "bEzsignformfieldAutocomplete", "bEzsignformfieldSelected", "sEzsignformfieldEnteredvalue", "eEzsignformfieldDependencyrequirement"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + A Ezsignformfield Object + """ # noqa: E501 + pki_ezsignformfield_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsignformfield", alias="pkiEzsignformfieldID") + i_ezsignpage_pagenumber: Annotated[int, Field(strict=True, ge=1)] = Field(description="The page number in the Ezsigndocument", alias="iEzsignpagePagenumber") + s_ezsignformfield_label: StrictStr = Field(description="The Label for the Ezsignformfield", alias="sEzsignformfieldLabel") + s_ezsignformfield_value: Optional[StrictStr] = Field(default=None, description="The value for the Ezsignformfield This can only be set if eEzsignformfieldgroupType is Checkbox or Radio", alias="sEzsignformfieldValue") + i_ezsignformfield_x: Annotated[int, Field(strict=True, ge=0)] = Field(description="The X coordinate (Horizontal) where to put the Ezsignformfield on the Ezsignpage. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsignformfield 2 inches from the left border of the page, you would use \"200\" for the X coordinate.", alias="iEzsignformfieldX") + i_ezsignformfield_y: Annotated[int, Field(strict=True, ge=0)] = Field(description="The Y coordinate (Vertical) where to put the Ezsignformfield on the Ezsignpage. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsignformfield 3 inches from the top border of the page, you would use \"300\" for the Y coordinate.", alias="iEzsignformfieldY") + i_ezsignformfield_width: Annotated[int, Field(strict=True, ge=0)] = Field(description="The Width of the Ezsignformfield in pixels calculated at 100 DPI The allowed values are varying based on the eEzsignformfieldgroupType. | eEzsignformfieldgroupType | Valid values | | ------------------------- | ------------ | | Checkbox | 22 | | Dropdown | 22-65535 | | Radio | 22 | | Text | 22-65535 | | Textarea | 22-65535 |", alias="iEzsignformfieldWidth") + i_ezsignformfield_height: Annotated[int, Field(strict=True, ge=0)] = Field(description="The Height of the Ezsignformfield in pixels calculated at 100 DPI The allowed values are varying based on the eEzsignformfieldgroupType. | eEzsignformfieldgroupType | Valid values | | ------------------------- | ------------ | | Checkbox | 22 | | Dropdown | 22 | | Radio | 22 | | Text | 22 | | Textarea | 22-65535 | ", alias="iEzsignformfieldHeight") + b_ezsignformfield_autocomplete: Optional[StrictBool] = Field(default=None, description="Whether the Ezsignformfield allows the use of the autocomplete of the browser. This can only be set if eEzsignformfieldgroupType is **Text**", alias="bEzsignformfieldAutocomplete") + b_ezsignformfield_selected: Optional[StrictBool] = Field(default=None, description="Whether the Ezsignformfield is selected or not by default. This can only be set if eEzsignformfieldgroupType is **Checkbox** or **Radio**", alias="bEzsignformfieldSelected") + s_ezsignformfield_enteredvalue: Optional[StrictStr] = Field(default=None, description="This is the value enterred for the Ezsignformfield This can only be set if eEzsignformfieldgroupType is **Dropdown**, **Text** or **Textarea**", alias="sEzsignformfieldEnteredvalue") + e_ezsignformfield_dependencyrequirement: Optional[FieldEEzsignformfieldDependencyrequirement] = Field(default=None, alias="eEzsignformfieldDependencyrequirement") + __properties: ClassVar[List[str]] = ["pkiEzsignformfieldID", "iEzsignpagePagenumber", "sEzsignformfieldLabel", "sEzsignformfieldValue", "iEzsignformfieldX", "iEzsignformfieldY", "iEzsignformfieldWidth", "iEzsignformfieldHeight", "bEzsignformfieldAutocomplete", "bEzsignformfieldSelected", "sEzsignformfieldEnteredvalue", "eEzsignformfieldDependencyrequirement"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignformfieldRequest: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignformfieldRequest from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignformfieldRequest: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignformfieldRequest from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignformfieldRequest.parse_obj(obj) - - _obj = EzsignformfieldRequest.parse_obj({ - "pki_ezsignformfield_id": obj.get("pkiEzsignformfieldID"), - "i_ezsignpage_pagenumber": obj.get("iEzsignpagePagenumber"), - "s_ezsignformfield_label": obj.get("sEzsignformfieldLabel"), - "s_ezsignformfield_value": obj.get("sEzsignformfieldValue"), - "i_ezsignformfield_x": obj.get("iEzsignformfieldX"), - "i_ezsignformfield_y": obj.get("iEzsignformfieldY"), - "i_ezsignformfield_width": obj.get("iEzsignformfieldWidth"), - "i_ezsignformfield_height": obj.get("iEzsignformfieldHeight"), - "b_ezsignformfield_autocomplete": obj.get("bEzsignformfieldAutocomplete"), - "b_ezsignformfield_selected": obj.get("bEzsignformfieldSelected"), - "s_ezsignformfield_enteredvalue": obj.get("sEzsignformfieldEnteredvalue"), - "e_ezsignformfield_dependencyrequirement": obj.get("eEzsignformfieldDependencyrequirement") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsignformfieldID": obj.get("pkiEzsignformfieldID"), + "iEzsignpagePagenumber": obj.get("iEzsignpagePagenumber"), + "sEzsignformfieldLabel": obj.get("sEzsignformfieldLabel"), + "sEzsignformfieldValue": obj.get("sEzsignformfieldValue"), + "iEzsignformfieldX": obj.get("iEzsignformfieldX"), + "iEzsignformfieldY": obj.get("iEzsignformfieldY"), + "iEzsignformfieldWidth": obj.get("iEzsignformfieldWidth"), + "iEzsignformfieldHeight": obj.get("iEzsignformfieldHeight"), + "bEzsignformfieldAutocomplete": obj.get("bEzsignformfieldAutocomplete"), + "bEzsignformfieldSelected": obj.get("bEzsignformfieldSelected"), + "sEzsignformfieldEnteredvalue": obj.get("sEzsignformfieldEnteredvalue"), + "eEzsignformfieldDependencyrequirement": obj.get("eEzsignformfieldDependencyrequirement") }) return _obj diff --git a/eZmaxApi/models/ezsignformfield_request_compound.py b/eZmaxApi/models/ezsignformfield_request_compound.py index 7498f86ce..e2ee26c93 100644 --- a/eZmaxApi/models/ezsignformfield_request_compound.py +++ b/eZmaxApi/models/ezsignformfield_request_compound.py @@ -19,54 +19,73 @@ import json -from typing import List, Optional -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint, conlist +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, StrictStr +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.ezsignelementdependency_request_compound import EzsignelementdependencyRequestCompound from eZmaxApi.models.field_e_ezsignformfield_dependencyrequirement import FieldEEzsignformfieldDependencyrequirement +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignformfieldRequestCompound(BaseModel): """ - An Ezsignformfield Object and children to create a complete structure # noqa: E501 - """ - pki_ezsignformfield_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="pkiEzsignformfieldID", description="The unique ID of the Ezsignformfield") - i_ezsignpage_pagenumber: conint(strict=True, ge=1) = Field(..., alias="iEzsignpagePagenumber", description="The page number in the Ezsigndocument") - s_ezsignformfield_label: StrictStr = Field(..., alias="sEzsignformfieldLabel", description="The Label for the Ezsignformfield") - s_ezsignformfield_value: Optional[StrictStr] = Field(None, alias="sEzsignformfieldValue", description="The value for the Ezsignformfield This can only be set if eEzsignformfieldgroupType is Checkbox or Radio") - i_ezsignformfield_x: conint(strict=True, ge=0) = Field(..., alias="iEzsignformfieldX", description="The X coordinate (Horizontal) where to put the Ezsignformfield on the Ezsignpage. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsignformfield 2 inches from the left border of the page, you would use \"200\" for the X coordinate.") - i_ezsignformfield_y: conint(strict=True, ge=0) = Field(..., alias="iEzsignformfieldY", description="The Y coordinate (Vertical) where to put the Ezsignformfield on the Ezsignpage. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsignformfield 3 inches from the top border of the page, you would use \"300\" for the Y coordinate.") - i_ezsignformfield_width: conint(strict=True, ge=0) = Field(..., alias="iEzsignformfieldWidth", description="The Width of the Ezsignformfield in pixels calculated at 100 DPI The allowed values are varying based on the eEzsignformfieldgroupType. | eEzsignformfieldgroupType | Valid values | | ------------------------- | ------------ | | Checkbox | 22 | | Dropdown | 22-65535 | | Radio | 22 | | Text | 22-65535 | | Textarea | 22-65535 |") - i_ezsignformfield_height: conint(strict=True, ge=0) = Field(..., alias="iEzsignformfieldHeight", description="The Height of the Ezsignformfield in pixels calculated at 100 DPI The allowed values are varying based on the eEzsignformfieldgroupType. | eEzsignformfieldgroupType | Valid values | | ------------------------- | ------------ | | Checkbox | 22 | | Dropdown | 22 | | Radio | 22 | | Text | 22 | | Textarea | 22-65535 | ") - b_ezsignformfield_autocomplete: Optional[StrictBool] = Field(None, alias="bEzsignformfieldAutocomplete", description="Whether the Ezsignformfield allows the use of the autocomplete of the browser. This can only be set if eEzsignformfieldgroupType is **Text**") - b_ezsignformfield_selected: Optional[StrictBool] = Field(None, alias="bEzsignformfieldSelected", description="Whether the Ezsignformfield is selected or not by default. This can only be set if eEzsignformfieldgroupType is **Checkbox** or **Radio**") - s_ezsignformfield_enteredvalue: Optional[StrictStr] = Field(None, alias="sEzsignformfieldEnteredvalue", description="This is the value enterred for the Ezsignformfield This can only be set if eEzsignformfieldgroupType is **Dropdown**, **Text** or **Textarea**") - e_ezsignformfield_dependencyrequirement: Optional[FieldEEzsignformfieldDependencyrequirement] = Field(None, alias="eEzsignformfieldDependencyrequirement") - a_obj_ezsignelementdependency: Optional[conlist(EzsignelementdependencyRequestCompound)] = Field(None, alias="a_objEzsignelementdependency") - __properties = ["pkiEzsignformfieldID", "iEzsignpagePagenumber", "sEzsignformfieldLabel", "sEzsignformfieldValue", "iEzsignformfieldX", "iEzsignformfieldY", "iEzsignformfieldWidth", "iEzsignformfieldHeight", "bEzsignformfieldAutocomplete", "bEzsignformfieldSelected", "sEzsignformfieldEnteredvalue", "eEzsignformfieldDependencyrequirement", "a_objEzsignelementdependency"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + An Ezsignformfield Object and children to create a complete structure + """ # noqa: E501 + pki_ezsignformfield_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsignformfield", alias="pkiEzsignformfieldID") + i_ezsignpage_pagenumber: Annotated[int, Field(strict=True, ge=1)] = Field(description="The page number in the Ezsigndocument", alias="iEzsignpagePagenumber") + s_ezsignformfield_label: StrictStr = Field(description="The Label for the Ezsignformfield", alias="sEzsignformfieldLabel") + s_ezsignformfield_value: Optional[StrictStr] = Field(default=None, description="The value for the Ezsignformfield This can only be set if eEzsignformfieldgroupType is Checkbox or Radio", alias="sEzsignformfieldValue") + i_ezsignformfield_x: Annotated[int, Field(strict=True, ge=0)] = Field(description="The X coordinate (Horizontal) where to put the Ezsignformfield on the Ezsignpage. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsignformfield 2 inches from the left border of the page, you would use \"200\" for the X coordinate.", alias="iEzsignformfieldX") + i_ezsignformfield_y: Annotated[int, Field(strict=True, ge=0)] = Field(description="The Y coordinate (Vertical) where to put the Ezsignformfield on the Ezsignpage. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsignformfield 3 inches from the top border of the page, you would use \"300\" for the Y coordinate.", alias="iEzsignformfieldY") + i_ezsignformfield_width: Annotated[int, Field(strict=True, ge=0)] = Field(description="The Width of the Ezsignformfield in pixels calculated at 100 DPI The allowed values are varying based on the eEzsignformfieldgroupType. | eEzsignformfieldgroupType | Valid values | | ------------------------- | ------------ | | Checkbox | 22 | | Dropdown | 22-65535 | | Radio | 22 | | Text | 22-65535 | | Textarea | 22-65535 |", alias="iEzsignformfieldWidth") + i_ezsignformfield_height: Annotated[int, Field(strict=True, ge=0)] = Field(description="The Height of the Ezsignformfield in pixels calculated at 100 DPI The allowed values are varying based on the eEzsignformfieldgroupType. | eEzsignformfieldgroupType | Valid values | | ------------------------- | ------------ | | Checkbox | 22 | | Dropdown | 22 | | Radio | 22 | | Text | 22 | | Textarea | 22-65535 | ", alias="iEzsignformfieldHeight") + b_ezsignformfield_autocomplete: Optional[StrictBool] = Field(default=None, description="Whether the Ezsignformfield allows the use of the autocomplete of the browser. This can only be set if eEzsignformfieldgroupType is **Text**", alias="bEzsignformfieldAutocomplete") + b_ezsignformfield_selected: Optional[StrictBool] = Field(default=None, description="Whether the Ezsignformfield is selected or not by default. This can only be set if eEzsignformfieldgroupType is **Checkbox** or **Radio**", alias="bEzsignformfieldSelected") + s_ezsignformfield_enteredvalue: Optional[StrictStr] = Field(default=None, description="This is the value enterred for the Ezsignformfield This can only be set if eEzsignformfieldgroupType is **Dropdown**, **Text** or **Textarea**", alias="sEzsignformfieldEnteredvalue") + e_ezsignformfield_dependencyrequirement: Optional[FieldEEzsignformfieldDependencyrequirement] = Field(default=None, alias="eEzsignformfieldDependencyrequirement") + a_obj_ezsignelementdependency: Optional[List[EzsignelementdependencyRequestCompound]] = Field(default=None, alias="a_objEzsignelementdependency") + __properties: ClassVar[List[str]] = ["pkiEzsignformfieldID", "iEzsignpagePagenumber", "sEzsignformfieldLabel", "sEzsignformfieldValue", "iEzsignformfieldX", "iEzsignformfieldY", "iEzsignformfieldWidth", "iEzsignformfieldHeight", "bEzsignformfieldAutocomplete", "bEzsignformfieldSelected", "sEzsignformfieldEnteredvalue", "eEzsignformfieldDependencyrequirement", "a_objEzsignelementdependency"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignformfieldRequestCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignformfieldRequestCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_ezsignelementdependency (list) _items = [] if self.a_obj_ezsignelementdependency: @@ -77,28 +96,28 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignformfieldRequestCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignformfieldRequestCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignformfieldRequestCompound.parse_obj(obj) - - _obj = EzsignformfieldRequestCompound.parse_obj({ - "pki_ezsignformfield_id": obj.get("pkiEzsignformfieldID"), - "i_ezsignpage_pagenumber": obj.get("iEzsignpagePagenumber"), - "s_ezsignformfield_label": obj.get("sEzsignformfieldLabel"), - "s_ezsignformfield_value": obj.get("sEzsignformfieldValue"), - "i_ezsignformfield_x": obj.get("iEzsignformfieldX"), - "i_ezsignformfield_y": obj.get("iEzsignformfieldY"), - "i_ezsignformfield_width": obj.get("iEzsignformfieldWidth"), - "i_ezsignformfield_height": obj.get("iEzsignformfieldHeight"), - "b_ezsignformfield_autocomplete": obj.get("bEzsignformfieldAutocomplete"), - "b_ezsignformfield_selected": obj.get("bEzsignformfieldSelected"), - "s_ezsignformfield_enteredvalue": obj.get("sEzsignformfieldEnteredvalue"), - "e_ezsignformfield_dependencyrequirement": obj.get("eEzsignformfieldDependencyrequirement"), - "a_obj_ezsignelementdependency": [EzsignelementdependencyRequestCompound.from_dict(_item) for _item in obj.get("a_objEzsignelementdependency")] if obj.get("a_objEzsignelementdependency") is not None else None + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsignformfieldID": obj.get("pkiEzsignformfieldID"), + "iEzsignpagePagenumber": obj.get("iEzsignpagePagenumber"), + "sEzsignformfieldLabel": obj.get("sEzsignformfieldLabel"), + "sEzsignformfieldValue": obj.get("sEzsignformfieldValue"), + "iEzsignformfieldX": obj.get("iEzsignformfieldX"), + "iEzsignformfieldY": obj.get("iEzsignformfieldY"), + "iEzsignformfieldWidth": obj.get("iEzsignformfieldWidth"), + "iEzsignformfieldHeight": obj.get("iEzsignformfieldHeight"), + "bEzsignformfieldAutocomplete": obj.get("bEzsignformfieldAutocomplete"), + "bEzsignformfieldSelected": obj.get("bEzsignformfieldSelected"), + "sEzsignformfieldEnteredvalue": obj.get("sEzsignformfieldEnteredvalue"), + "eEzsignformfieldDependencyrequirement": obj.get("eEzsignformfieldDependencyrequirement"), + "a_objEzsignelementdependency": [EzsignelementdependencyRequestCompound.from_dict(_item) for _item in obj.get("a_objEzsignelementdependency")] if obj.get("a_objEzsignelementdependency") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignformfield_response.py b/eZmaxApi/models/ezsignformfield_response.py index 9df73f574..461ea684d 100644 --- a/eZmaxApi/models/ezsignformfield_response.py +++ b/eZmaxApi/models/ezsignformfield_response.py @@ -19,76 +19,95 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, StrictStr +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.field_e_ezsignformfield_dependencyrequirement import FieldEEzsignformfieldDependencyrequirement +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignformfieldResponse(BaseModel): """ - An Ezsignformfield Object # noqa: E501 - """ - pki_ezsignformfield_id: conint(strict=True, ge=0) = Field(..., alias="pkiEzsignformfieldID", description="The unique ID of the Ezsignformfield") - i_ezsignpage_pagenumber: conint(strict=True, ge=1) = Field(..., alias="iEzsignpagePagenumber", description="The page number in the Ezsigndocument") - s_ezsignformfield_label: StrictStr = Field(..., alias="sEzsignformfieldLabel", description="The Label for the Ezsignformfield") - s_ezsignformfield_value: Optional[StrictStr] = Field(None, alias="sEzsignformfieldValue", description="The value for the Ezsignformfield This can only be set if eEzsignformfieldgroupType is Checkbox or Radio") - i_ezsignformfield_x: conint(strict=True, ge=0) = Field(..., alias="iEzsignformfieldX", description="The X coordinate (Horizontal) where to put the Ezsignformfield on the Ezsignpage. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsignformfield 2 inches from the left border of the page, you would use \"200\" for the X coordinate.") - i_ezsignformfield_y: conint(strict=True, ge=0) = Field(..., alias="iEzsignformfieldY", description="The Y coordinate (Vertical) where to put the Ezsignformfield on the Ezsignpage. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsignformfield 3 inches from the top border of the page, you would use \"300\" for the Y coordinate.") - i_ezsignformfield_width: conint(strict=True, ge=0) = Field(..., alias="iEzsignformfieldWidth", description="The Width of the Ezsignformfield in pixels calculated at 100 DPI The allowed values are varying based on the eEzsignformfieldgroupType. | eEzsignformfieldgroupType | Valid values | | ------------------------- | ------------ | | Checkbox | 22 | | Dropdown | 22-65535 | | Radio | 22 | | Text | 22-65535 | | Textarea | 22-65535 |") - i_ezsignformfield_height: conint(strict=True, ge=0) = Field(..., alias="iEzsignformfieldHeight", description="The Height of the Ezsignformfield in pixels calculated at 100 DPI The allowed values are varying based on the eEzsignformfieldgroupType. | eEzsignformfieldgroupType | Valid values | | ------------------------- | ------------ | | Checkbox | 22 | | Dropdown | 22 | | Radio | 22 | | Text | 22 | | Textarea | 22-65535 | ") - b_ezsignformfield_autocomplete: Optional[StrictBool] = Field(None, alias="bEzsignformfieldAutocomplete", description="Whether the Ezsignformfield allows the use of the autocomplete of the browser. This can only be set if eEzsignformfieldgroupType is **Text**") - b_ezsignformfield_selected: Optional[StrictBool] = Field(None, alias="bEzsignformfieldSelected", description="Whether the Ezsignformfield is selected or not by default. This can only be set if eEzsignformfieldgroupType is **Checkbox** or **Radio**") - s_ezsignformfield_enteredvalue: Optional[StrictStr] = Field(None, alias="sEzsignformfieldEnteredvalue", description="This is the value enterred for the Ezsignformfield This can only be set if eEzsignformfieldgroupType is **Dropdown**, **Text** or **Textarea**") - e_ezsignformfield_dependencyrequirement: Optional[FieldEEzsignformfieldDependencyrequirement] = Field(None, alias="eEzsignformfieldDependencyrequirement") - __properties = ["pkiEzsignformfieldID", "iEzsignpagePagenumber", "sEzsignformfieldLabel", "sEzsignformfieldValue", "iEzsignformfieldX", "iEzsignformfieldY", "iEzsignformfieldWidth", "iEzsignformfieldHeight", "bEzsignformfieldAutocomplete", "bEzsignformfieldSelected", "sEzsignformfieldEnteredvalue", "eEzsignformfieldDependencyrequirement"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + An Ezsignformfield Object + """ # noqa: E501 + pki_ezsignformfield_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsignformfield", alias="pkiEzsignformfieldID") + i_ezsignpage_pagenumber: Annotated[int, Field(strict=True, ge=1)] = Field(description="The page number in the Ezsigndocument", alias="iEzsignpagePagenumber") + s_ezsignformfield_label: StrictStr = Field(description="The Label for the Ezsignformfield", alias="sEzsignformfieldLabel") + s_ezsignformfield_value: Optional[StrictStr] = Field(default=None, description="The value for the Ezsignformfield This can only be set if eEzsignformfieldgroupType is Checkbox or Radio", alias="sEzsignformfieldValue") + i_ezsignformfield_x: Annotated[int, Field(strict=True, ge=0)] = Field(description="The X coordinate (Horizontal) where to put the Ezsignformfield on the Ezsignpage. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsignformfield 2 inches from the left border of the page, you would use \"200\" for the X coordinate.", alias="iEzsignformfieldX") + i_ezsignformfield_y: Annotated[int, Field(strict=True, ge=0)] = Field(description="The Y coordinate (Vertical) where to put the Ezsignformfield on the Ezsignpage. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsignformfield 3 inches from the top border of the page, you would use \"300\" for the Y coordinate.", alias="iEzsignformfieldY") + i_ezsignformfield_width: Annotated[int, Field(strict=True, ge=0)] = Field(description="The Width of the Ezsignformfield in pixels calculated at 100 DPI The allowed values are varying based on the eEzsignformfieldgroupType. | eEzsignformfieldgroupType | Valid values | | ------------------------- | ------------ | | Checkbox | 22 | | Dropdown | 22-65535 | | Radio | 22 | | Text | 22-65535 | | Textarea | 22-65535 |", alias="iEzsignformfieldWidth") + i_ezsignformfield_height: Annotated[int, Field(strict=True, ge=0)] = Field(description="The Height of the Ezsignformfield in pixels calculated at 100 DPI The allowed values are varying based on the eEzsignformfieldgroupType. | eEzsignformfieldgroupType | Valid values | | ------------------------- | ------------ | | Checkbox | 22 | | Dropdown | 22 | | Radio | 22 | | Text | 22 | | Textarea | 22-65535 | ", alias="iEzsignformfieldHeight") + b_ezsignformfield_autocomplete: Optional[StrictBool] = Field(default=None, description="Whether the Ezsignformfield allows the use of the autocomplete of the browser. This can only be set if eEzsignformfieldgroupType is **Text**", alias="bEzsignformfieldAutocomplete") + b_ezsignformfield_selected: Optional[StrictBool] = Field(default=None, description="Whether the Ezsignformfield is selected or not by default. This can only be set if eEzsignformfieldgroupType is **Checkbox** or **Radio**", alias="bEzsignformfieldSelected") + s_ezsignformfield_enteredvalue: Optional[StrictStr] = Field(default=None, description="This is the value enterred for the Ezsignformfield This can only be set if eEzsignformfieldgroupType is **Dropdown**, **Text** or **Textarea**", alias="sEzsignformfieldEnteredvalue") + e_ezsignformfield_dependencyrequirement: Optional[FieldEEzsignformfieldDependencyrequirement] = Field(default=None, alias="eEzsignformfieldDependencyrequirement") + __properties: ClassVar[List[str]] = ["pkiEzsignformfieldID", "iEzsignpagePagenumber", "sEzsignformfieldLabel", "sEzsignformfieldValue", "iEzsignformfieldX", "iEzsignformfieldY", "iEzsignformfieldWidth", "iEzsignformfieldHeight", "bEzsignformfieldAutocomplete", "bEzsignformfieldSelected", "sEzsignformfieldEnteredvalue", "eEzsignformfieldDependencyrequirement"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignformfieldResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignformfieldResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignformfieldResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignformfieldResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignformfieldResponse.parse_obj(obj) - - _obj = EzsignformfieldResponse.parse_obj({ - "pki_ezsignformfield_id": obj.get("pkiEzsignformfieldID"), - "i_ezsignpage_pagenumber": obj.get("iEzsignpagePagenumber"), - "s_ezsignformfield_label": obj.get("sEzsignformfieldLabel"), - "s_ezsignformfield_value": obj.get("sEzsignformfieldValue"), - "i_ezsignformfield_x": obj.get("iEzsignformfieldX"), - "i_ezsignformfield_y": obj.get("iEzsignformfieldY"), - "i_ezsignformfield_width": obj.get("iEzsignformfieldWidth"), - "i_ezsignformfield_height": obj.get("iEzsignformfieldHeight"), - "b_ezsignformfield_autocomplete": obj.get("bEzsignformfieldAutocomplete"), - "b_ezsignformfield_selected": obj.get("bEzsignformfieldSelected"), - "s_ezsignformfield_enteredvalue": obj.get("sEzsignformfieldEnteredvalue"), - "e_ezsignformfield_dependencyrequirement": obj.get("eEzsignformfieldDependencyrequirement") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsignformfieldID": obj.get("pkiEzsignformfieldID"), + "iEzsignpagePagenumber": obj.get("iEzsignpagePagenumber"), + "sEzsignformfieldLabel": obj.get("sEzsignformfieldLabel"), + "sEzsignformfieldValue": obj.get("sEzsignformfieldValue"), + "iEzsignformfieldX": obj.get("iEzsignformfieldX"), + "iEzsignformfieldY": obj.get("iEzsignformfieldY"), + "iEzsignformfieldWidth": obj.get("iEzsignformfieldWidth"), + "iEzsignformfieldHeight": obj.get("iEzsignformfieldHeight"), + "bEzsignformfieldAutocomplete": obj.get("bEzsignformfieldAutocomplete"), + "bEzsignformfieldSelected": obj.get("bEzsignformfieldSelected"), + "sEzsignformfieldEnteredvalue": obj.get("sEzsignformfieldEnteredvalue"), + "eEzsignformfieldDependencyrequirement": obj.get("eEzsignformfieldDependencyrequirement") }) return _obj diff --git a/eZmaxApi/models/ezsignformfield_response_compound.py b/eZmaxApi/models/ezsignformfield_response_compound.py index 4d40f3eaf..45ac8f6d8 100644 --- a/eZmaxApi/models/ezsignformfield_response_compound.py +++ b/eZmaxApi/models/ezsignformfield_response_compound.py @@ -19,54 +19,73 @@ import json -from typing import List, Optional -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint, conlist +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, StrictStr +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.ezsignelementdependency_response_compound import EzsignelementdependencyResponseCompound from eZmaxApi.models.field_e_ezsignformfield_dependencyrequirement import FieldEEzsignformfieldDependencyrequirement +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignformfieldResponseCompound(BaseModel): """ - An Ezsignformfield Object and children to create a complete structure # noqa: E501 - """ - pki_ezsignformfield_id: conint(strict=True, ge=0) = Field(..., alias="pkiEzsignformfieldID", description="The unique ID of the Ezsignformfield") - i_ezsignpage_pagenumber: conint(strict=True, ge=1) = Field(..., alias="iEzsignpagePagenumber", description="The page number in the Ezsigndocument") - s_ezsignformfield_label: StrictStr = Field(..., alias="sEzsignformfieldLabel", description="The Label for the Ezsignformfield") - s_ezsignformfield_value: Optional[StrictStr] = Field(None, alias="sEzsignformfieldValue", description="The value for the Ezsignformfield This can only be set if eEzsignformfieldgroupType is Checkbox or Radio") - i_ezsignformfield_x: conint(strict=True, ge=0) = Field(..., alias="iEzsignformfieldX", description="The X coordinate (Horizontal) where to put the Ezsignformfield on the Ezsignpage. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsignformfield 2 inches from the left border of the page, you would use \"200\" for the X coordinate.") - i_ezsignformfield_y: conint(strict=True, ge=0) = Field(..., alias="iEzsignformfieldY", description="The Y coordinate (Vertical) where to put the Ezsignformfield on the Ezsignpage. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsignformfield 3 inches from the top border of the page, you would use \"300\" for the Y coordinate.") - i_ezsignformfield_width: conint(strict=True, ge=0) = Field(..., alias="iEzsignformfieldWidth", description="The Width of the Ezsignformfield in pixels calculated at 100 DPI The allowed values are varying based on the eEzsignformfieldgroupType. | eEzsignformfieldgroupType | Valid values | | ------------------------- | ------------ | | Checkbox | 22 | | Dropdown | 22-65535 | | Radio | 22 | | Text | 22-65535 | | Textarea | 22-65535 |") - i_ezsignformfield_height: conint(strict=True, ge=0) = Field(..., alias="iEzsignformfieldHeight", description="The Height of the Ezsignformfield in pixels calculated at 100 DPI The allowed values are varying based on the eEzsignformfieldgroupType. | eEzsignformfieldgroupType | Valid values | | ------------------------- | ------------ | | Checkbox | 22 | | Dropdown | 22 | | Radio | 22 | | Text | 22 | | Textarea | 22-65535 | ") - b_ezsignformfield_autocomplete: Optional[StrictBool] = Field(None, alias="bEzsignformfieldAutocomplete", description="Whether the Ezsignformfield allows the use of the autocomplete of the browser. This can only be set if eEzsignformfieldgroupType is **Text**") - b_ezsignformfield_selected: Optional[StrictBool] = Field(None, alias="bEzsignformfieldSelected", description="Whether the Ezsignformfield is selected or not by default. This can only be set if eEzsignformfieldgroupType is **Checkbox** or **Radio**") - s_ezsignformfield_enteredvalue: Optional[StrictStr] = Field(None, alias="sEzsignformfieldEnteredvalue", description="This is the value enterred for the Ezsignformfield This can only be set if eEzsignformfieldgroupType is **Dropdown**, **Text** or **Textarea**") - e_ezsignformfield_dependencyrequirement: Optional[FieldEEzsignformfieldDependencyrequirement] = Field(None, alias="eEzsignformfieldDependencyrequirement") - a_obj_ezsignelementdependency: Optional[conlist(EzsignelementdependencyResponseCompound)] = Field(None, alias="a_objEzsignelementdependency") - __properties = ["pkiEzsignformfieldID", "iEzsignpagePagenumber", "sEzsignformfieldLabel", "sEzsignformfieldValue", "iEzsignformfieldX", "iEzsignformfieldY", "iEzsignformfieldWidth", "iEzsignformfieldHeight", "bEzsignformfieldAutocomplete", "bEzsignformfieldSelected", "sEzsignformfieldEnteredvalue", "eEzsignformfieldDependencyrequirement", "a_objEzsignelementdependency"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + An Ezsignformfield Object and children to create a complete structure + """ # noqa: E501 + pki_ezsignformfield_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsignformfield", alias="pkiEzsignformfieldID") + i_ezsignpage_pagenumber: Annotated[int, Field(strict=True, ge=1)] = Field(description="The page number in the Ezsigndocument", alias="iEzsignpagePagenumber") + s_ezsignformfield_label: StrictStr = Field(description="The Label for the Ezsignformfield", alias="sEzsignformfieldLabel") + s_ezsignformfield_value: Optional[StrictStr] = Field(default=None, description="The value for the Ezsignformfield This can only be set if eEzsignformfieldgroupType is Checkbox or Radio", alias="sEzsignformfieldValue") + i_ezsignformfield_x: Annotated[int, Field(strict=True, ge=0)] = Field(description="The X coordinate (Horizontal) where to put the Ezsignformfield on the Ezsignpage. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsignformfield 2 inches from the left border of the page, you would use \"200\" for the X coordinate.", alias="iEzsignformfieldX") + i_ezsignformfield_y: Annotated[int, Field(strict=True, ge=0)] = Field(description="The Y coordinate (Vertical) where to put the Ezsignformfield on the Ezsignpage. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsignformfield 3 inches from the top border of the page, you would use \"300\" for the Y coordinate.", alias="iEzsignformfieldY") + i_ezsignformfield_width: Annotated[int, Field(strict=True, ge=0)] = Field(description="The Width of the Ezsignformfield in pixels calculated at 100 DPI The allowed values are varying based on the eEzsignformfieldgroupType. | eEzsignformfieldgroupType | Valid values | | ------------------------- | ------------ | | Checkbox | 22 | | Dropdown | 22-65535 | | Radio | 22 | | Text | 22-65535 | | Textarea | 22-65535 |", alias="iEzsignformfieldWidth") + i_ezsignformfield_height: Annotated[int, Field(strict=True, ge=0)] = Field(description="The Height of the Ezsignformfield in pixels calculated at 100 DPI The allowed values are varying based on the eEzsignformfieldgroupType. | eEzsignformfieldgroupType | Valid values | | ------------------------- | ------------ | | Checkbox | 22 | | Dropdown | 22 | | Radio | 22 | | Text | 22 | | Textarea | 22-65535 | ", alias="iEzsignformfieldHeight") + b_ezsignformfield_autocomplete: Optional[StrictBool] = Field(default=None, description="Whether the Ezsignformfield allows the use of the autocomplete of the browser. This can only be set if eEzsignformfieldgroupType is **Text**", alias="bEzsignformfieldAutocomplete") + b_ezsignformfield_selected: Optional[StrictBool] = Field(default=None, description="Whether the Ezsignformfield is selected or not by default. This can only be set if eEzsignformfieldgroupType is **Checkbox** or **Radio**", alias="bEzsignformfieldSelected") + s_ezsignformfield_enteredvalue: Optional[StrictStr] = Field(default=None, description="This is the value enterred for the Ezsignformfield This can only be set if eEzsignformfieldgroupType is **Dropdown**, **Text** or **Textarea**", alias="sEzsignformfieldEnteredvalue") + e_ezsignformfield_dependencyrequirement: Optional[FieldEEzsignformfieldDependencyrequirement] = Field(default=None, alias="eEzsignformfieldDependencyrequirement") + a_obj_ezsignelementdependency: Optional[List[EzsignelementdependencyResponseCompound]] = Field(default=None, alias="a_objEzsignelementdependency") + __properties: ClassVar[List[str]] = ["pkiEzsignformfieldID", "iEzsignpagePagenumber", "sEzsignformfieldLabel", "sEzsignformfieldValue", "iEzsignformfieldX", "iEzsignformfieldY", "iEzsignformfieldWidth", "iEzsignformfieldHeight", "bEzsignformfieldAutocomplete", "bEzsignformfieldSelected", "sEzsignformfieldEnteredvalue", "eEzsignformfieldDependencyrequirement", "a_objEzsignelementdependency"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignformfieldResponseCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignformfieldResponseCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_ezsignelementdependency (list) _items = [] if self.a_obj_ezsignelementdependency: @@ -77,28 +96,28 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignformfieldResponseCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignformfieldResponseCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignformfieldResponseCompound.parse_obj(obj) - - _obj = EzsignformfieldResponseCompound.parse_obj({ - "pki_ezsignformfield_id": obj.get("pkiEzsignformfieldID"), - "i_ezsignpage_pagenumber": obj.get("iEzsignpagePagenumber"), - "s_ezsignformfield_label": obj.get("sEzsignformfieldLabel"), - "s_ezsignformfield_value": obj.get("sEzsignformfieldValue"), - "i_ezsignformfield_x": obj.get("iEzsignformfieldX"), - "i_ezsignformfield_y": obj.get("iEzsignformfieldY"), - "i_ezsignformfield_width": obj.get("iEzsignformfieldWidth"), - "i_ezsignformfield_height": obj.get("iEzsignformfieldHeight"), - "b_ezsignformfield_autocomplete": obj.get("bEzsignformfieldAutocomplete"), - "b_ezsignformfield_selected": obj.get("bEzsignformfieldSelected"), - "s_ezsignformfield_enteredvalue": obj.get("sEzsignformfieldEnteredvalue"), - "e_ezsignformfield_dependencyrequirement": obj.get("eEzsignformfieldDependencyrequirement"), - "a_obj_ezsignelementdependency": [EzsignelementdependencyResponseCompound.from_dict(_item) for _item in obj.get("a_objEzsignelementdependency")] if obj.get("a_objEzsignelementdependency") is not None else None + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsignformfieldID": obj.get("pkiEzsignformfieldID"), + "iEzsignpagePagenumber": obj.get("iEzsignpagePagenumber"), + "sEzsignformfieldLabel": obj.get("sEzsignformfieldLabel"), + "sEzsignformfieldValue": obj.get("sEzsignformfieldValue"), + "iEzsignformfieldX": obj.get("iEzsignformfieldX"), + "iEzsignformfieldY": obj.get("iEzsignformfieldY"), + "iEzsignformfieldWidth": obj.get("iEzsignformfieldWidth"), + "iEzsignformfieldHeight": obj.get("iEzsignformfieldHeight"), + "bEzsignformfieldAutocomplete": obj.get("bEzsignformfieldAutocomplete"), + "bEzsignformfieldSelected": obj.get("bEzsignformfieldSelected"), + "sEzsignformfieldEnteredvalue": obj.get("sEzsignformfieldEnteredvalue"), + "eEzsignformfieldDependencyrequirement": obj.get("eEzsignformfieldDependencyrequirement"), + "a_objEzsignelementdependency": [EzsignelementdependencyResponseCompound.from_dict(_item) for _item in obj.get("a_objEzsignelementdependency")] if obj.get("a_objEzsignelementdependency") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignformfieldgroup_create_object_v1_request.py b/eZmaxApi/models/ezsignformfieldgroup_create_object_v1_request.py index b84dd43f0..524362b70 100644 --- a/eZmaxApi/models/ezsignformfieldgroup_create_object_v1_request.py +++ b/eZmaxApi/models/ezsignformfieldgroup_create_object_v1_request.py @@ -19,41 +19,60 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.ezsignformfieldgroup_request_compound import EzsignformfieldgroupRequestCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignformfieldgroupCreateObjectV1Request(BaseModel): """ - Request for POST /1/object/ezsignformfieldgroup # noqa: E501 - """ - a_obj_ezsignformfieldgroup: conlist(EzsignformfieldgroupRequestCompound, min_items=1) = Field(..., alias="a_objEzsignformfieldgroup") - __properties = ["a_objEzsignformfieldgroup"] + Request for POST /1/object/ezsignformfieldgroup + """ # noqa: E501 + a_obj_ezsignformfieldgroup: Annotated[List[EzsignformfieldgroupRequestCompound], Field(min_length=1)] = Field(alias="a_objEzsignformfieldgroup") + __properties: ClassVar[List[str]] = ["a_objEzsignformfieldgroup"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignformfieldgroupCreateObjectV1Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignformfieldgroupCreateObjectV1Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_ezsignformfieldgroup (list) _items = [] if self.a_obj_ezsignformfieldgroup: @@ -64,16 +83,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignformfieldgroupCreateObjectV1Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignformfieldgroupCreateObjectV1Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignformfieldgroupCreateObjectV1Request.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignformfieldgroupCreateObjectV1Request.parse_obj({ - "a_obj_ezsignformfieldgroup": [EzsignformfieldgroupRequestCompound.from_dict(_item) for _item in obj.get("a_objEzsignformfieldgroup")] if obj.get("a_objEzsignformfieldgroup") is not None else None + _obj = cls.model_validate({ + "a_objEzsignformfieldgroup": [EzsignformfieldgroupRequestCompound.from_dict(_item) for _item in obj.get("a_objEzsignformfieldgroup")] if obj.get("a_objEzsignformfieldgroup") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignformfieldgroup_create_object_v1_response.py b/eZmaxApi/models/ezsignformfieldgroup_create_object_v1_response.py index e40a8491e..15a60f879 100644 --- a/eZmaxApi/models/ezsignformfieldgroup_create_object_v1_response.py +++ b/eZmaxApi/models/ezsignformfieldgroup_create_object_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.ezsignformfieldgroup_create_object_v1_response_m_payload import EzsignformfieldgroupCreateObjectV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignformfieldgroupCreateObjectV1Response(BaseModel): """ - Response for POST /1/object/ezsignformfieldgroup # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzsignformfieldgroupCreateObjectV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for POST /1/object/ezsignformfieldgroup + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsignformfieldgroupCreateObjectV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignformfieldgroupCreateObjectV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignformfieldgroupCreateObjectV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignformfieldgroupCreateObjectV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignformfieldgroupCreateObjectV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignformfieldgroupCreateObjectV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignformfieldgroupCreateObjectV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzsignformfieldgroupCreateObjectV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsignformfieldgroupCreateObjectV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignformfieldgroup_create_object_v1_response_m_payload.py b/eZmaxApi/models/ezsignformfieldgroup_create_object_v1_response_m_payload.py index 3e350f94d..805ca7610 100644 --- a/eZmaxApi/models/ezsignformfieldgroup_create_object_v1_response_m_payload.py +++ b/eZmaxApi/models/ezsignformfieldgroup_create_object_v1_response_m_payload.py @@ -19,53 +19,72 @@ import json -from typing import List -from pydantic import BaseModel, Field, conint, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignformfieldgroupCreateObjectV1ResponseMPayload(BaseModel): """ - Payload for POST /1/object/ezsignformfieldgroup # noqa: E501 - """ - a_pki_ezsignformfieldgroup_id: conlist(conint(strict=True, ge=0), min_items=1) = Field(..., alias="a_pkiEzsignformfieldgroupID", description="An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request.") - __properties = ["a_pkiEzsignformfieldgroupID"] + Payload for POST /1/object/ezsignformfieldgroup + """ # noqa: E501 + a_pki_ezsignformfieldgroup_id: Annotated[List[Annotated[int, Field(strict=True, ge=0)]], Field(min_length=1)] = Field(description="An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request.", alias="a_pkiEzsignformfieldgroupID") + __properties: ClassVar[List[str]] = ["a_pkiEzsignformfieldgroupID"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignformfieldgroupCreateObjectV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignformfieldgroupCreateObjectV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignformfieldgroupCreateObjectV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignformfieldgroupCreateObjectV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignformfieldgroupCreateObjectV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignformfieldgroupCreateObjectV1ResponseMPayload.parse_obj({ - "a_pki_ezsignformfieldgroup_id": obj.get("a_pkiEzsignformfieldgroupID") + _obj = cls.model_validate({ + "a_pkiEzsignformfieldgroupID": obj.get("a_pkiEzsignformfieldgroupID") }) return _obj diff --git a/eZmaxApi/models/ezsignformfieldgroup_delete_object_v1_response.py b/eZmaxApi/models/ezsignformfieldgroup_delete_object_v1_response.py index 27d4818f9..f0807d924 100644 --- a/eZmaxApi/models/ezsignformfieldgroup_delete_object_v1_response.py +++ b/eZmaxApi/models/ezsignformfieldgroup_delete_object_v1_response.py @@ -19,43 +19,61 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignformfieldgroupDeleteObjectV1Response(BaseModel): """ - Response for DELETE /1/object/ezsignformfieldgroup/{pkiEzsignformfieldgroupID} # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - __properties = ["objDebugPayload", "objDebug"] + Response for DELETE /1/object/ezsignformfieldgroup/{pkiEzsignformfieldgroupID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignformfieldgroupDeleteObjectV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignformfieldgroupDeleteObjectV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -65,17 +83,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignformfieldgroupDeleteObjectV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignformfieldgroupDeleteObjectV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignformfieldgroupDeleteObjectV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignformfieldgroupDeleteObjectV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignformfieldgroup_edit_object_v1_request.py b/eZmaxApi/models/ezsignformfieldgroup_edit_object_v1_request.py index eb4c7521e..9af304e6f 100644 --- a/eZmaxApi/models/ezsignformfieldgroup_edit_object_v1_request.py +++ b/eZmaxApi/models/ezsignformfieldgroup_edit_object_v1_request.py @@ -19,57 +19,75 @@ import json - -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.ezsignformfieldgroup_request_compound import EzsignformfieldgroupRequestCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignformfieldgroupEditObjectV1Request(BaseModel): """ - Request for PUT /1/object/ezsignformfieldgroup/{pkiEzsignfoldersignerassociationID} # noqa: E501 - """ - obj_ezsignformfieldgroup: EzsignformfieldgroupRequestCompound = Field(..., alias="objEzsignformfieldgroup") - __properties = ["objEzsignformfieldgroup"] + Request for PUT /1/object/ezsignformfieldgroup/{pkiEzsignfoldersignerassociationID} + """ # noqa: E501 + obj_ezsignformfieldgroup: EzsignformfieldgroupRequestCompound = Field(alias="objEzsignformfieldgroup") + __properties: ClassVar[List[str]] = ["objEzsignformfieldgroup"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignformfieldgroupEditObjectV1Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignformfieldgroupEditObjectV1Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_ezsignformfieldgroup if self.obj_ezsignformfieldgroup: _dict['objEzsignformfieldgroup'] = self.obj_ezsignformfieldgroup.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignformfieldgroupEditObjectV1Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignformfieldgroupEditObjectV1Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignformfieldgroupEditObjectV1Request.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignformfieldgroupEditObjectV1Request.parse_obj({ - "obj_ezsignformfieldgroup": EzsignformfieldgroupRequestCompound.from_dict(obj.get("objEzsignformfieldgroup")) if obj.get("objEzsignformfieldgroup") is not None else None + _obj = cls.model_validate({ + "objEzsignformfieldgroup": EzsignformfieldgroupRequestCompound.from_dict(obj.get("objEzsignformfieldgroup")) if obj.get("objEzsignformfieldgroup") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignformfieldgroup_edit_object_v1_response.py b/eZmaxApi/models/ezsignformfieldgroup_edit_object_v1_response.py index 98c211113..1c683064a 100644 --- a/eZmaxApi/models/ezsignformfieldgroup_edit_object_v1_response.py +++ b/eZmaxApi/models/ezsignformfieldgroup_edit_object_v1_response.py @@ -19,43 +19,61 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignformfieldgroupEditObjectV1Response(BaseModel): """ - Response for PUT /1/object/ezsignformfieldgroup/{pkiEzsignfoldersignerassociationID} # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - __properties = ["objDebugPayload", "objDebug"] + Response for PUT /1/object/ezsignformfieldgroup/{pkiEzsignfoldersignerassociationID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignformfieldgroupEditObjectV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignformfieldgroupEditObjectV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -65,17 +83,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignformfieldgroupEditObjectV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignformfieldgroupEditObjectV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignformfieldgroupEditObjectV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignformfieldgroupEditObjectV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignformfieldgroup_get_object_v2_response.py b/eZmaxApi/models/ezsignformfieldgroup_get_object_v2_response.py index 421ee87d8..842136f35 100644 --- a/eZmaxApi/models/ezsignformfieldgroup_get_object_v2_response.py +++ b/eZmaxApi/models/ezsignformfieldgroup_get_object_v2_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.ezsignformfieldgroup_get_object_v2_response_m_payload import EzsignformfieldgroupGetObjectV2ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignformfieldgroupGetObjectV2Response(BaseModel): """ - Response for GET /2/object/ezsignformfieldgroup/{pkiEzsignformfieldgroupID} # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzsignformfieldgroupGetObjectV2ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /2/object/ezsignformfieldgroup/{pkiEzsignformfieldgroupID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsignformfieldgroupGetObjectV2ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignformfieldgroupGetObjectV2Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignformfieldgroupGetObjectV2Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignformfieldgroupGetObjectV2Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignformfieldgroupGetObjectV2Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignformfieldgroupGetObjectV2Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignformfieldgroupGetObjectV2Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzsignformfieldgroupGetObjectV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsignformfieldgroupGetObjectV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignformfieldgroup_get_object_v2_response_m_payload.py b/eZmaxApi/models/ezsignformfieldgroup_get_object_v2_response_m_payload.py index 5519bffa7..5c99d728c 100644 --- a/eZmaxApi/models/ezsignformfieldgroup_get_object_v2_response_m_payload.py +++ b/eZmaxApi/models/ezsignformfieldgroup_get_object_v2_response_m_payload.py @@ -19,57 +19,75 @@ import json - -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.ezsignformfieldgroup_response_compound import EzsignformfieldgroupResponseCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignformfieldgroupGetObjectV2ResponseMPayload(BaseModel): """ - Payload for GET /2/object/ezsignformfieldgroup/{pkiEzsignformfieldgroupID} # noqa: E501 - """ - obj_ezsignformfieldgroup: EzsignformfieldgroupResponseCompound = Field(..., alias="objEzsignformfieldgroup") - __properties = ["objEzsignformfieldgroup"] + Payload for GET /2/object/ezsignformfieldgroup/{pkiEzsignformfieldgroupID} + """ # noqa: E501 + obj_ezsignformfieldgroup: EzsignformfieldgroupResponseCompound = Field(alias="objEzsignformfieldgroup") + __properties: ClassVar[List[str]] = ["objEzsignformfieldgroup"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignformfieldgroupGetObjectV2ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignformfieldgroupGetObjectV2ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_ezsignformfieldgroup if self.obj_ezsignformfieldgroup: _dict['objEzsignformfieldgroup'] = self.obj_ezsignformfieldgroup.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignformfieldgroupGetObjectV2ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignformfieldgroupGetObjectV2ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignformfieldgroupGetObjectV2ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignformfieldgroupGetObjectV2ResponseMPayload.parse_obj({ - "obj_ezsignformfieldgroup": EzsignformfieldgroupResponseCompound.from_dict(obj.get("objEzsignformfieldgroup")) if obj.get("objEzsignformfieldgroup") is not None else None + _obj = cls.model_validate({ + "objEzsignformfieldgroup": EzsignformfieldgroupResponseCompound.from_dict(obj.get("objEzsignformfieldgroup")) if obj.get("objEzsignformfieldgroup") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignformfieldgroup_request.py b/eZmaxApi/models/ezsignformfieldgroup_request.py index 758b21642..9890f1b70 100644 --- a/eZmaxApi/models/ezsignformfieldgroup_request.py +++ b/eZmaxApi/models/ezsignformfieldgroup_request.py @@ -19,36 +19,42 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint, constr, validator +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, StrictStr, field_validator +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.enum_textvalidation import EnumTextvalidation from eZmaxApi.models.field_e_ezsignformfieldgroup_signerrequirement import FieldEEzsignformfieldgroupSignerrequirement from eZmaxApi.models.field_e_ezsignformfieldgroup_tooltipposition import FieldEEzsignformfieldgroupTooltipposition from eZmaxApi.models.field_e_ezsignformfieldgroup_type import FieldEEzsignformfieldgroupType +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignformfieldgroupRequest(BaseModel): """ - An Ezsignformfieldgroup Object # noqa: E501 - """ - pki_ezsignformfieldgroup_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="pkiEzsignformfieldgroupID", description="The unique ID of the Ezsignformfieldgroup") - fki_ezsigndocument_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsigndocumentID", description="The unique ID of the Ezsigndocument") - e_ezsignformfieldgroup_type: FieldEEzsignformfieldgroupType = Field(..., alias="eEzsignformfieldgroupType") - e_ezsignformfieldgroup_signerrequirement: FieldEEzsignformfieldgroupSignerrequirement = Field(..., alias="eEzsignformfieldgroupSignerrequirement") - s_ezsignformfieldgroup_label: constr(strict=True, max_length=50, min_length=1) = Field(..., alias="sEzsignformfieldgroupLabel", description="The Label for the Ezsignformfieldgroup") - i_ezsignformfieldgroup_step: conint(strict=True, ge=1) = Field(..., alias="iEzsignformfieldgroupStep", description="The step when the Ezsignsigner will be invited to fill the form fields") - s_ezsignformfieldgroup_defaultvalue: Optional[StrictStr] = Field(None, alias="sEzsignformfieldgroupDefaultvalue", description="The default value for the Ezsignformfieldgroup") - i_ezsignformfieldgroup_filledmin: conint(strict=True, ge=0) = Field(..., alias="iEzsignformfieldgroupFilledmin", description="The minimum number of Ezsignformfield that must be filled in the Ezsignformfieldgroup") - i_ezsignformfieldgroup_filledmax: conint(strict=True, ge=0) = Field(..., alias="iEzsignformfieldgroupFilledmax", description="The maximum number of Ezsignformfield that must be filled in the Ezsignformfieldgroup") - b_ezsignformfieldgroup_readonly: StrictBool = Field(..., alias="bEzsignformfieldgroupReadonly", description="Whether the Ezsignformfieldgroup is read only or not.") - i_ezsignformfieldgroup_maxlength: Optional[conint(strict=True, le=65535, ge=0)] = Field(None, alias="iEzsignformfieldgroupMaxlength", description="The maximum length for the value in the Ezsignformfieldgroup This can only be set if eEzsignformfieldgroupType is **Text** or **Textarea**") - b_ezsignformfieldgroup_encrypted: Optional[StrictBool] = Field(None, alias="bEzsignformfieldgroupEncrypted", description="Whether the Ezsignformfieldgroup is encrypted in the database or not. Encrypted values are not displayed on the Ezsigndocument. This can only be set if eEzsignformfieldgroupType is **Text** or **Textarea**") - s_ezsignformfieldgroup_regexp: Optional[constr(strict=True)] = Field(None, alias="sEzsignformfieldgroupRegexp", description="A regular expression to indicate what values are acceptable for the Ezsignformfieldgroup. This can only be set if eEzsignformfieldgroupType is **Text** or **Textarea**") - t_ezsignformfieldgroup_tooltip: Optional[StrictStr] = Field(None, alias="tEzsignformfieldgroupTooltip", description="A tooltip that will be presented to Ezsignsigner about the Ezsignformfieldgroup") - e_ezsignformfieldgroup_tooltipposition: Optional[FieldEEzsignformfieldgroupTooltipposition] = Field(None, alias="eEzsignformfieldgroupTooltipposition") - e_ezsignformfieldgroup_textvalidation: Optional[EnumTextvalidation] = Field(None, alias="eEzsignformfieldgroupTextvalidation") - __properties = ["pkiEzsignformfieldgroupID", "fkiEzsigndocumentID", "eEzsignformfieldgroupType", "eEzsignformfieldgroupSignerrequirement", "sEzsignformfieldgroupLabel", "iEzsignformfieldgroupStep", "sEzsignformfieldgroupDefaultvalue", "iEzsignformfieldgroupFilledmin", "iEzsignformfieldgroupFilledmax", "bEzsignformfieldgroupReadonly", "iEzsignformfieldgroupMaxlength", "bEzsignformfieldgroupEncrypted", "sEzsignformfieldgroupRegexp", "tEzsignformfieldgroupTooltip", "eEzsignformfieldgroupTooltipposition", "eEzsignformfieldgroupTextvalidation"] - - @validator('s_ezsignformfieldgroup_regexp') + An Ezsignformfieldgroup Object + """ # noqa: E501 + pki_ezsignformfieldgroup_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsignformfieldgroup", alias="pkiEzsignformfieldgroupID") + fki_ezsigndocument_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsigndocument", alias="fkiEzsigndocumentID") + e_ezsignformfieldgroup_type: FieldEEzsignformfieldgroupType = Field(alias="eEzsignformfieldgroupType") + e_ezsignformfieldgroup_signerrequirement: FieldEEzsignformfieldgroupSignerrequirement = Field(alias="eEzsignformfieldgroupSignerrequirement") + s_ezsignformfieldgroup_label: Annotated[str, Field(min_length=1, strict=True, max_length=50)] = Field(description="The Label for the Ezsignformfieldgroup", alias="sEzsignformfieldgroupLabel") + i_ezsignformfieldgroup_step: Annotated[int, Field(strict=True, ge=1)] = Field(description="The step when the Ezsignsigner will be invited to fill the form fields", alias="iEzsignformfieldgroupStep") + s_ezsignformfieldgroup_defaultvalue: Optional[StrictStr] = Field(default=None, description="The default value for the Ezsignformfieldgroup", alias="sEzsignformfieldgroupDefaultvalue") + i_ezsignformfieldgroup_filledmin: Annotated[int, Field(strict=True, ge=0)] = Field(description="The minimum number of Ezsignformfield that must be filled in the Ezsignformfieldgroup", alias="iEzsignformfieldgroupFilledmin") + i_ezsignformfieldgroup_filledmax: Annotated[int, Field(strict=True, ge=0)] = Field(description="The maximum number of Ezsignformfield that must be filled in the Ezsignformfieldgroup", alias="iEzsignformfieldgroupFilledmax") + b_ezsignformfieldgroup_readonly: StrictBool = Field(description="Whether the Ezsignformfieldgroup is read only or not.", alias="bEzsignformfieldgroupReadonly") + i_ezsignformfieldgroup_maxlength: Optional[Annotated[int, Field(le=65535, strict=True, ge=0)]] = Field(default=None, description="The maximum length for the value in the Ezsignformfieldgroup This can only be set if eEzsignformfieldgroupType is **Text** or **Textarea**", alias="iEzsignformfieldgroupMaxlength") + b_ezsignformfieldgroup_encrypted: Optional[StrictBool] = Field(default=None, description="Whether the Ezsignformfieldgroup is encrypted in the database or not. Encrypted values are not displayed on the Ezsigndocument. This can only be set if eEzsignformfieldgroupType is **Text** or **Textarea**", alias="bEzsignformfieldgroupEncrypted") + s_ezsignformfieldgroup_regexp: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="A regular expression to indicate what values are acceptable for the Ezsignformfieldgroup. This can only be set if eEzsignformfieldgroupType is **Text** or **Textarea**", alias="sEzsignformfieldgroupRegexp") + t_ezsignformfieldgroup_tooltip: Optional[StrictStr] = Field(default=None, description="A tooltip that will be presented to Ezsignsigner about the Ezsignformfieldgroup", alias="tEzsignformfieldgroupTooltip") + e_ezsignformfieldgroup_tooltipposition: Optional[FieldEEzsignformfieldgroupTooltipposition] = Field(default=None, alias="eEzsignformfieldgroupTooltipposition") + e_ezsignformfieldgroup_textvalidation: Optional[EnumTextvalidation] = Field(default=None, alias="eEzsignformfieldgroupTextvalidation") + __properties: ClassVar[List[str]] = ["pkiEzsignformfieldgroupID", "fkiEzsigndocumentID", "eEzsignformfieldgroupType", "eEzsignformfieldgroupSignerrequirement", "sEzsignformfieldgroupLabel", "iEzsignformfieldgroupStep", "sEzsignformfieldgroupDefaultvalue", "iEzsignformfieldgroupFilledmin", "iEzsignformfieldgroupFilledmax", "bEzsignformfieldgroupReadonly", "iEzsignformfieldgroupMaxlength", "bEzsignformfieldgroupEncrypted", "sEzsignformfieldgroupRegexp", "tEzsignformfieldgroupTooltip", "eEzsignformfieldgroupTooltipposition", "eEzsignformfieldgroupTextvalidation"] + + @field_validator('s_ezsignformfieldgroup_regexp') def s_ezsignformfieldgroup_regexp_validate_regular_expression(cls, value): """Validates the regular expression""" if value is None: @@ -58,58 +64,71 @@ def s_ezsignformfieldgroup_regexp_validate_regular_expression(cls, value): raise ValueError(r"must validate the regular expression /^\^.*\$$|^$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignformfieldgroupRequest: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignformfieldgroupRequest from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignformfieldgroupRequest: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignformfieldgroupRequest from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignformfieldgroupRequest.parse_obj(obj) - - _obj = EzsignformfieldgroupRequest.parse_obj({ - "pki_ezsignformfieldgroup_id": obj.get("pkiEzsignformfieldgroupID"), - "fki_ezsigndocument_id": obj.get("fkiEzsigndocumentID"), - "e_ezsignformfieldgroup_type": obj.get("eEzsignformfieldgroupType"), - "e_ezsignformfieldgroup_signerrequirement": obj.get("eEzsignformfieldgroupSignerrequirement"), - "s_ezsignformfieldgroup_label": obj.get("sEzsignformfieldgroupLabel"), - "i_ezsignformfieldgroup_step": obj.get("iEzsignformfieldgroupStep"), - "s_ezsignformfieldgroup_defaultvalue": obj.get("sEzsignformfieldgroupDefaultvalue"), - "i_ezsignformfieldgroup_filledmin": obj.get("iEzsignformfieldgroupFilledmin"), - "i_ezsignformfieldgroup_filledmax": obj.get("iEzsignformfieldgroupFilledmax"), - "b_ezsignformfieldgroup_readonly": obj.get("bEzsignformfieldgroupReadonly"), - "i_ezsignformfieldgroup_maxlength": obj.get("iEzsignformfieldgroupMaxlength"), - "b_ezsignformfieldgroup_encrypted": obj.get("bEzsignformfieldgroupEncrypted"), - "s_ezsignformfieldgroup_regexp": obj.get("sEzsignformfieldgroupRegexp"), - "t_ezsignformfieldgroup_tooltip": obj.get("tEzsignformfieldgroupTooltip"), - "e_ezsignformfieldgroup_tooltipposition": obj.get("eEzsignformfieldgroupTooltipposition"), - "e_ezsignformfieldgroup_textvalidation": obj.get("eEzsignformfieldgroupTextvalidation") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsignformfieldgroupID": obj.get("pkiEzsignformfieldgroupID"), + "fkiEzsigndocumentID": obj.get("fkiEzsigndocumentID"), + "eEzsignformfieldgroupType": obj.get("eEzsignformfieldgroupType"), + "eEzsignformfieldgroupSignerrequirement": obj.get("eEzsignformfieldgroupSignerrequirement"), + "sEzsignformfieldgroupLabel": obj.get("sEzsignformfieldgroupLabel"), + "iEzsignformfieldgroupStep": obj.get("iEzsignformfieldgroupStep"), + "sEzsignformfieldgroupDefaultvalue": obj.get("sEzsignformfieldgroupDefaultvalue"), + "iEzsignformfieldgroupFilledmin": obj.get("iEzsignformfieldgroupFilledmin"), + "iEzsignformfieldgroupFilledmax": obj.get("iEzsignformfieldgroupFilledmax"), + "bEzsignformfieldgroupReadonly": obj.get("bEzsignformfieldgroupReadonly"), + "iEzsignformfieldgroupMaxlength": obj.get("iEzsignformfieldgroupMaxlength"), + "bEzsignformfieldgroupEncrypted": obj.get("bEzsignformfieldgroupEncrypted"), + "sEzsignformfieldgroupRegexp": obj.get("sEzsignformfieldgroupRegexp"), + "tEzsignformfieldgroupTooltip": obj.get("tEzsignformfieldgroupTooltip"), + "eEzsignformfieldgroupTooltipposition": obj.get("eEzsignformfieldgroupTooltipposition"), + "eEzsignformfieldgroupTextvalidation": obj.get("eEzsignformfieldgroupTextvalidation") }) return _obj diff --git a/eZmaxApi/models/ezsignformfieldgroup_request_compound.py b/eZmaxApi/models/ezsignformfieldgroup_request_compound.py index 521286866..a6a3550cb 100644 --- a/eZmaxApi/models/ezsignformfieldgroup_request_compound.py +++ b/eZmaxApi/models/ezsignformfieldgroup_request_compound.py @@ -19,8 +19,10 @@ import json -from typing import List, Optional -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint, conlist, constr, validator +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, StrictStr, field_validator +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.custom_dropdown_element_request_compound import CustomDropdownElementRequestCompound from eZmaxApi.models.enum_textvalidation import EnumTextvalidation from eZmaxApi.models.ezsignformfield_request_compound import EzsignformfieldRequestCompound @@ -28,33 +30,37 @@ from eZmaxApi.models.field_e_ezsignformfieldgroup_signerrequirement import FieldEEzsignformfieldgroupSignerrequirement from eZmaxApi.models.field_e_ezsignformfieldgroup_tooltipposition import FieldEEzsignformfieldgroupTooltipposition from eZmaxApi.models.field_e_ezsignformfieldgroup_type import FieldEEzsignformfieldgroupType +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignformfieldgroupRequestCompound(BaseModel): """ - An Ezsignformfieldgroup Object and children to create a complete structure # noqa: E501 - """ - pki_ezsignformfieldgroup_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="pkiEzsignformfieldgroupID", description="The unique ID of the Ezsignformfieldgroup") - fki_ezsigndocument_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsigndocumentID", description="The unique ID of the Ezsigndocument") - e_ezsignformfieldgroup_type: FieldEEzsignformfieldgroupType = Field(..., alias="eEzsignformfieldgroupType") - e_ezsignformfieldgroup_signerrequirement: FieldEEzsignformfieldgroupSignerrequirement = Field(..., alias="eEzsignformfieldgroupSignerrequirement") - s_ezsignformfieldgroup_label: constr(strict=True, max_length=50, min_length=1) = Field(..., alias="sEzsignformfieldgroupLabel", description="The Label for the Ezsignformfieldgroup") - i_ezsignformfieldgroup_step: conint(strict=True, ge=1) = Field(..., alias="iEzsignformfieldgroupStep", description="The step when the Ezsignsigner will be invited to fill the form fields") - s_ezsignformfieldgroup_defaultvalue: Optional[StrictStr] = Field(None, alias="sEzsignformfieldgroupDefaultvalue", description="The default value for the Ezsignformfieldgroup") - i_ezsignformfieldgroup_filledmin: conint(strict=True, ge=0) = Field(..., alias="iEzsignformfieldgroupFilledmin", description="The minimum number of Ezsignformfield that must be filled in the Ezsignformfieldgroup") - i_ezsignformfieldgroup_filledmax: conint(strict=True, ge=0) = Field(..., alias="iEzsignformfieldgroupFilledmax", description="The maximum number of Ezsignformfield that must be filled in the Ezsignformfieldgroup") - b_ezsignformfieldgroup_readonly: StrictBool = Field(..., alias="bEzsignformfieldgroupReadonly", description="Whether the Ezsignformfieldgroup is read only or not.") - i_ezsignformfieldgroup_maxlength: Optional[conint(strict=True, le=65535, ge=0)] = Field(None, alias="iEzsignformfieldgroupMaxlength", description="The maximum length for the value in the Ezsignformfieldgroup This can only be set if eEzsignformfieldgroupType is **Text** or **Textarea**") - b_ezsignformfieldgroup_encrypted: Optional[StrictBool] = Field(None, alias="bEzsignformfieldgroupEncrypted", description="Whether the Ezsignformfieldgroup is encrypted in the database or not. Encrypted values are not displayed on the Ezsigndocument. This can only be set if eEzsignformfieldgroupType is **Text** or **Textarea**") - s_ezsignformfieldgroup_regexp: Optional[constr(strict=True)] = Field(None, alias="sEzsignformfieldgroupRegexp", description="A regular expression to indicate what values are acceptable for the Ezsignformfieldgroup. This can only be set if eEzsignformfieldgroupType is **Text** or **Textarea**") - t_ezsignformfieldgroup_tooltip: Optional[StrictStr] = Field(None, alias="tEzsignformfieldgroupTooltip", description="A tooltip that will be presented to Ezsignsigner about the Ezsignformfieldgroup") - e_ezsignformfieldgroup_tooltipposition: Optional[FieldEEzsignformfieldgroupTooltipposition] = Field(None, alias="eEzsignformfieldgroupTooltipposition") - e_ezsignformfieldgroup_textvalidation: Optional[EnumTextvalidation] = Field(None, alias="eEzsignformfieldgroupTextvalidation") - a_obj_ezsignformfieldgroupsigner: conlist(EzsignformfieldgroupsignerRequestCompound) = Field(..., alias="a_objEzsignformfieldgroupsigner") - a_obj_dropdown_element: Optional[conlist(CustomDropdownElementRequestCompound)] = Field(None, alias="a_objDropdownElement") - a_obj_ezsignformfield: conlist(EzsignformfieldRequestCompound) = Field(..., alias="a_objEzsignformfield") - __properties = ["pkiEzsignformfieldgroupID", "fkiEzsigndocumentID", "eEzsignformfieldgroupType", "eEzsignformfieldgroupSignerrequirement", "sEzsignformfieldgroupLabel", "iEzsignformfieldgroupStep", "sEzsignformfieldgroupDefaultvalue", "iEzsignformfieldgroupFilledmin", "iEzsignformfieldgroupFilledmax", "bEzsignformfieldgroupReadonly", "iEzsignformfieldgroupMaxlength", "bEzsignformfieldgroupEncrypted", "sEzsignformfieldgroupRegexp", "tEzsignformfieldgroupTooltip", "eEzsignformfieldgroupTooltipposition", "eEzsignformfieldgroupTextvalidation", "a_objEzsignformfieldgroupsigner", "a_objDropdownElement", "a_objEzsignformfield"] - - @validator('s_ezsignformfieldgroup_regexp') + An Ezsignformfieldgroup Object and children to create a complete structure + """ # noqa: E501 + pki_ezsignformfieldgroup_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsignformfieldgroup", alias="pkiEzsignformfieldgroupID") + fki_ezsigndocument_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsigndocument", alias="fkiEzsigndocumentID") + e_ezsignformfieldgroup_type: FieldEEzsignformfieldgroupType = Field(alias="eEzsignformfieldgroupType") + e_ezsignformfieldgroup_signerrequirement: FieldEEzsignformfieldgroupSignerrequirement = Field(alias="eEzsignformfieldgroupSignerrequirement") + s_ezsignformfieldgroup_label: Annotated[str, Field(min_length=1, strict=True, max_length=50)] = Field(description="The Label for the Ezsignformfieldgroup", alias="sEzsignformfieldgroupLabel") + i_ezsignformfieldgroup_step: Annotated[int, Field(strict=True, ge=1)] = Field(description="The step when the Ezsignsigner will be invited to fill the form fields", alias="iEzsignformfieldgroupStep") + s_ezsignformfieldgroup_defaultvalue: Optional[StrictStr] = Field(default=None, description="The default value for the Ezsignformfieldgroup", alias="sEzsignformfieldgroupDefaultvalue") + i_ezsignformfieldgroup_filledmin: Annotated[int, Field(strict=True, ge=0)] = Field(description="The minimum number of Ezsignformfield that must be filled in the Ezsignformfieldgroup", alias="iEzsignformfieldgroupFilledmin") + i_ezsignformfieldgroup_filledmax: Annotated[int, Field(strict=True, ge=0)] = Field(description="The maximum number of Ezsignformfield that must be filled in the Ezsignformfieldgroup", alias="iEzsignformfieldgroupFilledmax") + b_ezsignformfieldgroup_readonly: StrictBool = Field(description="Whether the Ezsignformfieldgroup is read only or not.", alias="bEzsignformfieldgroupReadonly") + i_ezsignformfieldgroup_maxlength: Optional[Annotated[int, Field(le=65535, strict=True, ge=0)]] = Field(default=None, description="The maximum length for the value in the Ezsignformfieldgroup This can only be set if eEzsignformfieldgroupType is **Text** or **Textarea**", alias="iEzsignformfieldgroupMaxlength") + b_ezsignformfieldgroup_encrypted: Optional[StrictBool] = Field(default=None, description="Whether the Ezsignformfieldgroup is encrypted in the database or not. Encrypted values are not displayed on the Ezsigndocument. This can only be set if eEzsignformfieldgroupType is **Text** or **Textarea**", alias="bEzsignformfieldgroupEncrypted") + s_ezsignformfieldgroup_regexp: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="A regular expression to indicate what values are acceptable for the Ezsignformfieldgroup. This can only be set if eEzsignformfieldgroupType is **Text** or **Textarea**", alias="sEzsignformfieldgroupRegexp") + t_ezsignformfieldgroup_tooltip: Optional[StrictStr] = Field(default=None, description="A tooltip that will be presented to Ezsignsigner about the Ezsignformfieldgroup", alias="tEzsignformfieldgroupTooltip") + e_ezsignformfieldgroup_tooltipposition: Optional[FieldEEzsignformfieldgroupTooltipposition] = Field(default=None, alias="eEzsignformfieldgroupTooltipposition") + e_ezsignformfieldgroup_textvalidation: Optional[EnumTextvalidation] = Field(default=None, alias="eEzsignformfieldgroupTextvalidation") + a_obj_ezsignformfieldgroupsigner: List[EzsignformfieldgroupsignerRequestCompound] = Field(alias="a_objEzsignformfieldgroupsigner") + a_obj_dropdown_element: Optional[List[CustomDropdownElementRequestCompound]] = Field(default=None, alias="a_objDropdownElement") + a_obj_ezsignformfield: List[EzsignformfieldRequestCompound] = Field(alias="a_objEzsignformfield") + __properties: ClassVar[List[str]] = ["pkiEzsignformfieldgroupID", "fkiEzsigndocumentID", "eEzsignformfieldgroupType", "eEzsignformfieldgroupSignerrequirement", "sEzsignformfieldgroupLabel", "iEzsignformfieldgroupStep", "sEzsignformfieldgroupDefaultvalue", "iEzsignformfieldgroupFilledmin", "iEzsignformfieldgroupFilledmax", "bEzsignformfieldgroupReadonly", "iEzsignformfieldgroupMaxlength", "bEzsignformfieldgroupEncrypted", "sEzsignformfieldgroupRegexp", "tEzsignformfieldgroupTooltip", "eEzsignformfieldgroupTooltipposition", "eEzsignformfieldgroupTextvalidation", "a_objEzsignformfieldgroupsigner", "a_objDropdownElement", "a_objEzsignformfield"] + + @field_validator('s_ezsignformfieldgroup_regexp') def s_ezsignformfieldgroup_regexp_validate_regular_expression(cls, value): """Validates the regular expression""" if value is None: @@ -64,30 +70,43 @@ def s_ezsignformfieldgroup_regexp_validate_regular_expression(cls, value): raise ValueError(r"must validate the regular expression /^\^.*\$$|^$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignformfieldgroupRequestCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignformfieldgroupRequestCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_ezsignformfieldgroupsigner (list) _items = [] if self.a_obj_ezsignformfieldgroupsigner: @@ -112,34 +131,34 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignformfieldgroupRequestCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignformfieldgroupRequestCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignformfieldgroupRequestCompound.parse_obj(obj) - - _obj = EzsignformfieldgroupRequestCompound.parse_obj({ - "pki_ezsignformfieldgroup_id": obj.get("pkiEzsignformfieldgroupID"), - "fki_ezsigndocument_id": obj.get("fkiEzsigndocumentID"), - "e_ezsignformfieldgroup_type": obj.get("eEzsignformfieldgroupType"), - "e_ezsignformfieldgroup_signerrequirement": obj.get("eEzsignformfieldgroupSignerrequirement"), - "s_ezsignformfieldgroup_label": obj.get("sEzsignformfieldgroupLabel"), - "i_ezsignformfieldgroup_step": obj.get("iEzsignformfieldgroupStep"), - "s_ezsignformfieldgroup_defaultvalue": obj.get("sEzsignformfieldgroupDefaultvalue"), - "i_ezsignformfieldgroup_filledmin": obj.get("iEzsignformfieldgroupFilledmin"), - "i_ezsignformfieldgroup_filledmax": obj.get("iEzsignformfieldgroupFilledmax"), - "b_ezsignformfieldgroup_readonly": obj.get("bEzsignformfieldgroupReadonly"), - "i_ezsignformfieldgroup_maxlength": obj.get("iEzsignformfieldgroupMaxlength"), - "b_ezsignformfieldgroup_encrypted": obj.get("bEzsignformfieldgroupEncrypted"), - "s_ezsignformfieldgroup_regexp": obj.get("sEzsignformfieldgroupRegexp"), - "t_ezsignformfieldgroup_tooltip": obj.get("tEzsignformfieldgroupTooltip"), - "e_ezsignformfieldgroup_tooltipposition": obj.get("eEzsignformfieldgroupTooltipposition"), - "e_ezsignformfieldgroup_textvalidation": obj.get("eEzsignformfieldgroupTextvalidation"), - "a_obj_ezsignformfieldgroupsigner": [EzsignformfieldgroupsignerRequestCompound.from_dict(_item) for _item in obj.get("a_objEzsignformfieldgroupsigner")] if obj.get("a_objEzsignformfieldgroupsigner") is not None else None, - "a_obj_dropdown_element": [CustomDropdownElementRequestCompound.from_dict(_item) for _item in obj.get("a_objDropdownElement")] if obj.get("a_objDropdownElement") is not None else None, - "a_obj_ezsignformfield": [EzsignformfieldRequestCompound.from_dict(_item) for _item in obj.get("a_objEzsignformfield")] if obj.get("a_objEzsignformfield") is not None else None + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsignformfieldgroupID": obj.get("pkiEzsignformfieldgroupID"), + "fkiEzsigndocumentID": obj.get("fkiEzsigndocumentID"), + "eEzsignformfieldgroupType": obj.get("eEzsignformfieldgroupType"), + "eEzsignformfieldgroupSignerrequirement": obj.get("eEzsignformfieldgroupSignerrequirement"), + "sEzsignformfieldgroupLabel": obj.get("sEzsignformfieldgroupLabel"), + "iEzsignformfieldgroupStep": obj.get("iEzsignformfieldgroupStep"), + "sEzsignformfieldgroupDefaultvalue": obj.get("sEzsignformfieldgroupDefaultvalue"), + "iEzsignformfieldgroupFilledmin": obj.get("iEzsignformfieldgroupFilledmin"), + "iEzsignformfieldgroupFilledmax": obj.get("iEzsignformfieldgroupFilledmax"), + "bEzsignformfieldgroupReadonly": obj.get("bEzsignformfieldgroupReadonly"), + "iEzsignformfieldgroupMaxlength": obj.get("iEzsignformfieldgroupMaxlength"), + "bEzsignformfieldgroupEncrypted": obj.get("bEzsignformfieldgroupEncrypted"), + "sEzsignformfieldgroupRegexp": obj.get("sEzsignformfieldgroupRegexp"), + "tEzsignformfieldgroupTooltip": obj.get("tEzsignformfieldgroupTooltip"), + "eEzsignformfieldgroupTooltipposition": obj.get("eEzsignformfieldgroupTooltipposition"), + "eEzsignformfieldgroupTextvalidation": obj.get("eEzsignformfieldgroupTextvalidation"), + "a_objEzsignformfieldgroupsigner": [EzsignformfieldgroupsignerRequestCompound.from_dict(_item) for _item in obj.get("a_objEzsignformfieldgroupsigner")] if obj.get("a_objEzsignformfieldgroupsigner") is not None else None, + "a_objDropdownElement": [CustomDropdownElementRequestCompound.from_dict(_item) for _item in obj.get("a_objDropdownElement")] if obj.get("a_objDropdownElement") is not None else None, + "a_objEzsignformfield": [EzsignformfieldRequestCompound.from_dict(_item) for _item in obj.get("a_objEzsignformfield")] if obj.get("a_objEzsignformfield") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignformfieldgroup_response.py b/eZmaxApi/models/ezsignformfieldgroup_response.py index 53e159958..4b4dc4878 100644 --- a/eZmaxApi/models/ezsignformfieldgroup_response.py +++ b/eZmaxApi/models/ezsignformfieldgroup_response.py @@ -19,36 +19,42 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint, constr, validator +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, StrictStr, field_validator +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.enum_textvalidation import EnumTextvalidation from eZmaxApi.models.field_e_ezsignformfieldgroup_signerrequirement import FieldEEzsignformfieldgroupSignerrequirement from eZmaxApi.models.field_e_ezsignformfieldgroup_tooltipposition import FieldEEzsignformfieldgroupTooltipposition from eZmaxApi.models.field_e_ezsignformfieldgroup_type import FieldEEzsignformfieldgroupType +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignformfieldgroupResponse(BaseModel): """ - An Ezsignformfieldgroup Object # noqa: E501 - """ - pki_ezsignformfieldgroup_id: conint(strict=True, ge=0) = Field(..., alias="pkiEzsignformfieldgroupID", description="The unique ID of the Ezsignformfieldgroup") - fki_ezsigndocument_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsigndocumentID", description="The unique ID of the Ezsigndocument") - e_ezsignformfieldgroup_type: FieldEEzsignformfieldgroupType = Field(..., alias="eEzsignformfieldgroupType") - e_ezsignformfieldgroup_signerrequirement: FieldEEzsignformfieldgroupSignerrequirement = Field(..., alias="eEzsignformfieldgroupSignerrequirement") - s_ezsignformfieldgroup_label: constr(strict=True, max_length=50, min_length=1) = Field(..., alias="sEzsignformfieldgroupLabel", description="The Label for the Ezsignformfieldgroup") - i_ezsignformfieldgroup_step: conint(strict=True, ge=1) = Field(..., alias="iEzsignformfieldgroupStep", description="The step when the Ezsignsigner will be invited to fill the form fields") - s_ezsignformfieldgroup_defaultvalue: Optional[StrictStr] = Field(None, alias="sEzsignformfieldgroupDefaultvalue", description="The default value for the Ezsignformfieldgroup") - i_ezsignformfieldgroup_filledmin: conint(strict=True, ge=0) = Field(..., alias="iEzsignformfieldgroupFilledmin", description="The minimum number of Ezsignformfield that must be filled in the Ezsignformfieldgroup") - i_ezsignformfieldgroup_filledmax: conint(strict=True, ge=0) = Field(..., alias="iEzsignformfieldgroupFilledmax", description="The maximum number of Ezsignformfield that must be filled in the Ezsignformfieldgroup") - b_ezsignformfieldgroup_readonly: StrictBool = Field(..., alias="bEzsignformfieldgroupReadonly", description="Whether the Ezsignformfieldgroup is read only or not.") - i_ezsignformfieldgroup_maxlength: Optional[conint(strict=True, le=65535, ge=0)] = Field(None, alias="iEzsignformfieldgroupMaxlength", description="The maximum length for the value in the Ezsignformfieldgroup This can only be set if eEzsignformfieldgroupType is **Text** or **Textarea**") - b_ezsignformfieldgroup_encrypted: Optional[StrictBool] = Field(None, alias="bEzsignformfieldgroupEncrypted", description="Whether the Ezsignformfieldgroup is encrypted in the database or not. Encrypted values are not displayed on the Ezsigndocument. This can only be set if eEzsignformfieldgroupType is **Text** or **Textarea**") - e_ezsignformfieldgroup_textvalidation: Optional[EnumTextvalidation] = Field(None, alias="eEzsignformfieldgroupTextvalidation") - s_ezsignformfieldgroup_regexp: Optional[constr(strict=True)] = Field(None, alias="sEzsignformfieldgroupRegexp", description="A regular expression to indicate what values are acceptable for the Ezsignformfieldgroup. This can only be set if eEzsignformfieldgroupType is **Text** or **Textarea**") - t_ezsignformfieldgroup_tooltip: Optional[StrictStr] = Field(None, alias="tEzsignformfieldgroupTooltip", description="A tooltip that will be presented to Ezsignsigner about the Ezsignformfieldgroup") - e_ezsignformfieldgroup_tooltipposition: Optional[FieldEEzsignformfieldgroupTooltipposition] = Field(None, alias="eEzsignformfieldgroupTooltipposition") - __properties = ["pkiEzsignformfieldgroupID", "fkiEzsigndocumentID", "eEzsignformfieldgroupType", "eEzsignformfieldgroupSignerrequirement", "sEzsignformfieldgroupLabel", "iEzsignformfieldgroupStep", "sEzsignformfieldgroupDefaultvalue", "iEzsignformfieldgroupFilledmin", "iEzsignformfieldgroupFilledmax", "bEzsignformfieldgroupReadonly", "iEzsignformfieldgroupMaxlength", "bEzsignformfieldgroupEncrypted", "eEzsignformfieldgroupTextvalidation", "sEzsignformfieldgroupRegexp", "tEzsignformfieldgroupTooltip", "eEzsignformfieldgroupTooltipposition"] - - @validator('s_ezsignformfieldgroup_regexp') + An Ezsignformfieldgroup Object + """ # noqa: E501 + pki_ezsignformfieldgroup_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsignformfieldgroup", alias="pkiEzsignformfieldgroupID") + fki_ezsigndocument_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsigndocument", alias="fkiEzsigndocumentID") + e_ezsignformfieldgroup_type: FieldEEzsignformfieldgroupType = Field(alias="eEzsignformfieldgroupType") + e_ezsignformfieldgroup_signerrequirement: FieldEEzsignformfieldgroupSignerrequirement = Field(alias="eEzsignformfieldgroupSignerrequirement") + s_ezsignformfieldgroup_label: Annotated[str, Field(min_length=1, strict=True, max_length=50)] = Field(description="The Label for the Ezsignformfieldgroup", alias="sEzsignformfieldgroupLabel") + i_ezsignformfieldgroup_step: Annotated[int, Field(strict=True, ge=1)] = Field(description="The step when the Ezsignsigner will be invited to fill the form fields", alias="iEzsignformfieldgroupStep") + s_ezsignformfieldgroup_defaultvalue: Optional[StrictStr] = Field(default=None, description="The default value for the Ezsignformfieldgroup", alias="sEzsignformfieldgroupDefaultvalue") + i_ezsignformfieldgroup_filledmin: Annotated[int, Field(strict=True, ge=0)] = Field(description="The minimum number of Ezsignformfield that must be filled in the Ezsignformfieldgroup", alias="iEzsignformfieldgroupFilledmin") + i_ezsignformfieldgroup_filledmax: Annotated[int, Field(strict=True, ge=0)] = Field(description="The maximum number of Ezsignformfield that must be filled in the Ezsignformfieldgroup", alias="iEzsignformfieldgroupFilledmax") + b_ezsignformfieldgroup_readonly: StrictBool = Field(description="Whether the Ezsignformfieldgroup is read only or not.", alias="bEzsignformfieldgroupReadonly") + i_ezsignformfieldgroup_maxlength: Optional[Annotated[int, Field(le=65535, strict=True, ge=0)]] = Field(default=None, description="The maximum length for the value in the Ezsignformfieldgroup This can only be set if eEzsignformfieldgroupType is **Text** or **Textarea**", alias="iEzsignformfieldgroupMaxlength") + b_ezsignformfieldgroup_encrypted: Optional[StrictBool] = Field(default=None, description="Whether the Ezsignformfieldgroup is encrypted in the database or not. Encrypted values are not displayed on the Ezsigndocument. This can only be set if eEzsignformfieldgroupType is **Text** or **Textarea**", alias="bEzsignformfieldgroupEncrypted") + e_ezsignformfieldgroup_textvalidation: Optional[EnumTextvalidation] = Field(default=None, alias="eEzsignformfieldgroupTextvalidation") + s_ezsignformfieldgroup_regexp: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="A regular expression to indicate what values are acceptable for the Ezsignformfieldgroup. This can only be set if eEzsignformfieldgroupType is **Text** or **Textarea**", alias="sEzsignformfieldgroupRegexp") + t_ezsignformfieldgroup_tooltip: Optional[StrictStr] = Field(default=None, description="A tooltip that will be presented to Ezsignsigner about the Ezsignformfieldgroup", alias="tEzsignformfieldgroupTooltip") + e_ezsignformfieldgroup_tooltipposition: Optional[FieldEEzsignformfieldgroupTooltipposition] = Field(default=None, alias="eEzsignformfieldgroupTooltipposition") + __properties: ClassVar[List[str]] = ["pkiEzsignformfieldgroupID", "fkiEzsigndocumentID", "eEzsignformfieldgroupType", "eEzsignformfieldgroupSignerrequirement", "sEzsignformfieldgroupLabel", "iEzsignformfieldgroupStep", "sEzsignformfieldgroupDefaultvalue", "iEzsignformfieldgroupFilledmin", "iEzsignformfieldgroupFilledmax", "bEzsignformfieldgroupReadonly", "iEzsignformfieldgroupMaxlength", "bEzsignformfieldgroupEncrypted", "eEzsignformfieldgroupTextvalidation", "sEzsignformfieldgroupRegexp", "tEzsignformfieldgroupTooltip", "eEzsignformfieldgroupTooltipposition"] + + @field_validator('s_ezsignformfieldgroup_regexp') def s_ezsignformfieldgroup_regexp_validate_regular_expression(cls, value): """Validates the regular expression""" if value is None: @@ -58,58 +64,71 @@ def s_ezsignformfieldgroup_regexp_validate_regular_expression(cls, value): raise ValueError(r"must validate the regular expression /^\^.*\$$|^$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignformfieldgroupResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignformfieldgroupResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignformfieldgroupResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignformfieldgroupResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignformfieldgroupResponse.parse_obj(obj) - - _obj = EzsignformfieldgroupResponse.parse_obj({ - "pki_ezsignformfieldgroup_id": obj.get("pkiEzsignformfieldgroupID"), - "fki_ezsigndocument_id": obj.get("fkiEzsigndocumentID"), - "e_ezsignformfieldgroup_type": obj.get("eEzsignformfieldgroupType"), - "e_ezsignformfieldgroup_signerrequirement": obj.get("eEzsignformfieldgroupSignerrequirement"), - "s_ezsignformfieldgroup_label": obj.get("sEzsignformfieldgroupLabel"), - "i_ezsignformfieldgroup_step": obj.get("iEzsignformfieldgroupStep"), - "s_ezsignformfieldgroup_defaultvalue": obj.get("sEzsignformfieldgroupDefaultvalue"), - "i_ezsignformfieldgroup_filledmin": obj.get("iEzsignformfieldgroupFilledmin"), - "i_ezsignformfieldgroup_filledmax": obj.get("iEzsignformfieldgroupFilledmax"), - "b_ezsignformfieldgroup_readonly": obj.get("bEzsignformfieldgroupReadonly"), - "i_ezsignformfieldgroup_maxlength": obj.get("iEzsignformfieldgroupMaxlength"), - "b_ezsignformfieldgroup_encrypted": obj.get("bEzsignformfieldgroupEncrypted"), - "e_ezsignformfieldgroup_textvalidation": obj.get("eEzsignformfieldgroupTextvalidation"), - "s_ezsignformfieldgroup_regexp": obj.get("sEzsignformfieldgroupRegexp"), - "t_ezsignformfieldgroup_tooltip": obj.get("tEzsignformfieldgroupTooltip"), - "e_ezsignformfieldgroup_tooltipposition": obj.get("eEzsignformfieldgroupTooltipposition") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsignformfieldgroupID": obj.get("pkiEzsignformfieldgroupID"), + "fkiEzsigndocumentID": obj.get("fkiEzsigndocumentID"), + "eEzsignformfieldgroupType": obj.get("eEzsignformfieldgroupType"), + "eEzsignformfieldgroupSignerrequirement": obj.get("eEzsignformfieldgroupSignerrequirement"), + "sEzsignformfieldgroupLabel": obj.get("sEzsignformfieldgroupLabel"), + "iEzsignformfieldgroupStep": obj.get("iEzsignformfieldgroupStep"), + "sEzsignformfieldgroupDefaultvalue": obj.get("sEzsignformfieldgroupDefaultvalue"), + "iEzsignformfieldgroupFilledmin": obj.get("iEzsignformfieldgroupFilledmin"), + "iEzsignformfieldgroupFilledmax": obj.get("iEzsignformfieldgroupFilledmax"), + "bEzsignformfieldgroupReadonly": obj.get("bEzsignformfieldgroupReadonly"), + "iEzsignformfieldgroupMaxlength": obj.get("iEzsignformfieldgroupMaxlength"), + "bEzsignformfieldgroupEncrypted": obj.get("bEzsignformfieldgroupEncrypted"), + "eEzsignformfieldgroupTextvalidation": obj.get("eEzsignformfieldgroupTextvalidation"), + "sEzsignformfieldgroupRegexp": obj.get("sEzsignformfieldgroupRegexp"), + "tEzsignformfieldgroupTooltip": obj.get("tEzsignformfieldgroupTooltip"), + "eEzsignformfieldgroupTooltipposition": obj.get("eEzsignformfieldgroupTooltipposition") }) return _obj diff --git a/eZmaxApi/models/ezsignformfieldgroup_response_compound.py b/eZmaxApi/models/ezsignformfieldgroup_response_compound.py index 5e4a1ed15..4e46feab7 100644 --- a/eZmaxApi/models/ezsignformfieldgroup_response_compound.py +++ b/eZmaxApi/models/ezsignformfieldgroup_response_compound.py @@ -19,8 +19,10 @@ import json -from typing import List, Optional -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint, conlist, constr, validator +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, StrictStr, field_validator +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.custom_dropdown_element_response_compound import CustomDropdownElementResponseCompound from eZmaxApi.models.enum_textvalidation import EnumTextvalidation from eZmaxApi.models.ezsignformfield_response_compound import EzsignformfieldResponseCompound @@ -28,33 +30,37 @@ from eZmaxApi.models.field_e_ezsignformfieldgroup_signerrequirement import FieldEEzsignformfieldgroupSignerrequirement from eZmaxApi.models.field_e_ezsignformfieldgroup_tooltipposition import FieldEEzsignformfieldgroupTooltipposition from eZmaxApi.models.field_e_ezsignformfieldgroup_type import FieldEEzsignformfieldgroupType +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignformfieldgroupResponseCompound(BaseModel): """ - An Ezsignformfieldgroup Object and children to create a complete structure # noqa: E501 - """ - pki_ezsignformfieldgroup_id: conint(strict=True, ge=0) = Field(..., alias="pkiEzsignformfieldgroupID", description="The unique ID of the Ezsignformfieldgroup") - fki_ezsigndocument_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsigndocumentID", description="The unique ID of the Ezsigndocument") - e_ezsignformfieldgroup_type: FieldEEzsignformfieldgroupType = Field(..., alias="eEzsignformfieldgroupType") - e_ezsignformfieldgroup_signerrequirement: FieldEEzsignformfieldgroupSignerrequirement = Field(..., alias="eEzsignformfieldgroupSignerrequirement") - s_ezsignformfieldgroup_label: constr(strict=True, max_length=50, min_length=1) = Field(..., alias="sEzsignformfieldgroupLabel", description="The Label for the Ezsignformfieldgroup") - i_ezsignformfieldgroup_step: conint(strict=True, ge=1) = Field(..., alias="iEzsignformfieldgroupStep", description="The step when the Ezsignsigner will be invited to fill the form fields") - s_ezsignformfieldgroup_defaultvalue: Optional[StrictStr] = Field(None, alias="sEzsignformfieldgroupDefaultvalue", description="The default value for the Ezsignformfieldgroup") - i_ezsignformfieldgroup_filledmin: conint(strict=True, ge=0) = Field(..., alias="iEzsignformfieldgroupFilledmin", description="The minimum number of Ezsignformfield that must be filled in the Ezsignformfieldgroup") - i_ezsignformfieldgroup_filledmax: conint(strict=True, ge=0) = Field(..., alias="iEzsignformfieldgroupFilledmax", description="The maximum number of Ezsignformfield that must be filled in the Ezsignformfieldgroup") - b_ezsignformfieldgroup_readonly: StrictBool = Field(..., alias="bEzsignformfieldgroupReadonly", description="Whether the Ezsignformfieldgroup is read only or not.") - i_ezsignformfieldgroup_maxlength: Optional[conint(strict=True, le=65535, ge=0)] = Field(None, alias="iEzsignformfieldgroupMaxlength", description="The maximum length for the value in the Ezsignformfieldgroup This can only be set if eEzsignformfieldgroupType is **Text** or **Textarea**") - b_ezsignformfieldgroup_encrypted: Optional[StrictBool] = Field(None, alias="bEzsignformfieldgroupEncrypted", description="Whether the Ezsignformfieldgroup is encrypted in the database or not. Encrypted values are not displayed on the Ezsigndocument. This can only be set if eEzsignformfieldgroupType is **Text** or **Textarea**") - e_ezsignformfieldgroup_textvalidation: Optional[EnumTextvalidation] = Field(None, alias="eEzsignformfieldgroupTextvalidation") - s_ezsignformfieldgroup_regexp: Optional[constr(strict=True)] = Field(None, alias="sEzsignformfieldgroupRegexp", description="A regular expression to indicate what values are acceptable for the Ezsignformfieldgroup. This can only be set if eEzsignformfieldgroupType is **Text** or **Textarea**") - t_ezsignformfieldgroup_tooltip: Optional[StrictStr] = Field(None, alias="tEzsignformfieldgroupTooltip", description="A tooltip that will be presented to Ezsignsigner about the Ezsignformfieldgroup") - e_ezsignformfieldgroup_tooltipposition: Optional[FieldEEzsignformfieldgroupTooltipposition] = Field(None, alias="eEzsignformfieldgroupTooltipposition") - a_obj_ezsignformfield: conlist(EzsignformfieldResponseCompound) = Field(..., alias="a_objEzsignformfield") - a_obj_dropdown_element: Optional[conlist(CustomDropdownElementResponseCompound)] = Field(None, alias="a_objDropdownElement") - a_obj_ezsignformfieldgroupsigner: conlist(EzsignformfieldgroupsignerResponseCompound) = Field(..., alias="a_objEzsignformfieldgroupsigner") - __properties = ["pkiEzsignformfieldgroupID", "fkiEzsigndocumentID", "eEzsignformfieldgroupType", "eEzsignformfieldgroupSignerrequirement", "sEzsignformfieldgroupLabel", "iEzsignformfieldgroupStep", "sEzsignformfieldgroupDefaultvalue", "iEzsignformfieldgroupFilledmin", "iEzsignformfieldgroupFilledmax", "bEzsignformfieldgroupReadonly", "iEzsignformfieldgroupMaxlength", "bEzsignformfieldgroupEncrypted", "eEzsignformfieldgroupTextvalidation", "sEzsignformfieldgroupRegexp", "tEzsignformfieldgroupTooltip", "eEzsignformfieldgroupTooltipposition", "a_objEzsignformfield", "a_objDropdownElement", "a_objEzsignformfieldgroupsigner"] - - @validator('s_ezsignformfieldgroup_regexp') + An Ezsignformfieldgroup Object and children to create a complete structure + """ # noqa: E501 + pki_ezsignformfieldgroup_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsignformfieldgroup", alias="pkiEzsignformfieldgroupID") + fki_ezsigndocument_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsigndocument", alias="fkiEzsigndocumentID") + e_ezsignformfieldgroup_type: FieldEEzsignformfieldgroupType = Field(alias="eEzsignformfieldgroupType") + e_ezsignformfieldgroup_signerrequirement: FieldEEzsignformfieldgroupSignerrequirement = Field(alias="eEzsignformfieldgroupSignerrequirement") + s_ezsignformfieldgroup_label: Annotated[str, Field(min_length=1, strict=True, max_length=50)] = Field(description="The Label for the Ezsignformfieldgroup", alias="sEzsignformfieldgroupLabel") + i_ezsignformfieldgroup_step: Annotated[int, Field(strict=True, ge=1)] = Field(description="The step when the Ezsignsigner will be invited to fill the form fields", alias="iEzsignformfieldgroupStep") + s_ezsignformfieldgroup_defaultvalue: Optional[StrictStr] = Field(default=None, description="The default value for the Ezsignformfieldgroup", alias="sEzsignformfieldgroupDefaultvalue") + i_ezsignformfieldgroup_filledmin: Annotated[int, Field(strict=True, ge=0)] = Field(description="The minimum number of Ezsignformfield that must be filled in the Ezsignformfieldgroup", alias="iEzsignformfieldgroupFilledmin") + i_ezsignformfieldgroup_filledmax: Annotated[int, Field(strict=True, ge=0)] = Field(description="The maximum number of Ezsignformfield that must be filled in the Ezsignformfieldgroup", alias="iEzsignformfieldgroupFilledmax") + b_ezsignformfieldgroup_readonly: StrictBool = Field(description="Whether the Ezsignformfieldgroup is read only or not.", alias="bEzsignformfieldgroupReadonly") + i_ezsignformfieldgroup_maxlength: Optional[Annotated[int, Field(le=65535, strict=True, ge=0)]] = Field(default=None, description="The maximum length for the value in the Ezsignformfieldgroup This can only be set if eEzsignformfieldgroupType is **Text** or **Textarea**", alias="iEzsignformfieldgroupMaxlength") + b_ezsignformfieldgroup_encrypted: Optional[StrictBool] = Field(default=None, description="Whether the Ezsignformfieldgroup is encrypted in the database or not. Encrypted values are not displayed on the Ezsigndocument. This can only be set if eEzsignformfieldgroupType is **Text** or **Textarea**", alias="bEzsignformfieldgroupEncrypted") + e_ezsignformfieldgroup_textvalidation: Optional[EnumTextvalidation] = Field(default=None, alias="eEzsignformfieldgroupTextvalidation") + s_ezsignformfieldgroup_regexp: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="A regular expression to indicate what values are acceptable for the Ezsignformfieldgroup. This can only be set if eEzsignformfieldgroupType is **Text** or **Textarea**", alias="sEzsignformfieldgroupRegexp") + t_ezsignformfieldgroup_tooltip: Optional[StrictStr] = Field(default=None, description="A tooltip that will be presented to Ezsignsigner about the Ezsignformfieldgroup", alias="tEzsignformfieldgroupTooltip") + e_ezsignformfieldgroup_tooltipposition: Optional[FieldEEzsignformfieldgroupTooltipposition] = Field(default=None, alias="eEzsignformfieldgroupTooltipposition") + a_obj_ezsignformfield: List[EzsignformfieldResponseCompound] = Field(alias="a_objEzsignformfield") + a_obj_dropdown_element: Optional[List[CustomDropdownElementResponseCompound]] = Field(default=None, alias="a_objDropdownElement") + a_obj_ezsignformfieldgroupsigner: List[EzsignformfieldgroupsignerResponseCompound] = Field(alias="a_objEzsignformfieldgroupsigner") + __properties: ClassVar[List[str]] = ["pkiEzsignformfieldgroupID", "fkiEzsigndocumentID", "eEzsignformfieldgroupType", "eEzsignformfieldgroupSignerrequirement", "sEzsignformfieldgroupLabel", "iEzsignformfieldgroupStep", "sEzsignformfieldgroupDefaultvalue", "iEzsignformfieldgroupFilledmin", "iEzsignformfieldgroupFilledmax", "bEzsignformfieldgroupReadonly", "iEzsignformfieldgroupMaxlength", "bEzsignformfieldgroupEncrypted", "eEzsignformfieldgroupTextvalidation", "sEzsignformfieldgroupRegexp", "tEzsignformfieldgroupTooltip", "eEzsignformfieldgroupTooltipposition", "a_objEzsignformfield", "a_objDropdownElement", "a_objEzsignformfieldgroupsigner"] + + @field_validator('s_ezsignformfieldgroup_regexp') def s_ezsignformfieldgroup_regexp_validate_regular_expression(cls, value): """Validates the regular expression""" if value is None: @@ -64,30 +70,43 @@ def s_ezsignformfieldgroup_regexp_validate_regular_expression(cls, value): raise ValueError(r"must validate the regular expression /^\^.*\$$|^$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignformfieldgroupResponseCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignformfieldgroupResponseCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_ezsignformfield (list) _items = [] if self.a_obj_ezsignformfield: @@ -112,34 +131,34 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignformfieldgroupResponseCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignformfieldgroupResponseCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignformfieldgroupResponseCompound.parse_obj(obj) - - _obj = EzsignformfieldgroupResponseCompound.parse_obj({ - "pki_ezsignformfieldgroup_id": obj.get("pkiEzsignformfieldgroupID"), - "fki_ezsigndocument_id": obj.get("fkiEzsigndocumentID"), - "e_ezsignformfieldgroup_type": obj.get("eEzsignformfieldgroupType"), - "e_ezsignformfieldgroup_signerrequirement": obj.get("eEzsignformfieldgroupSignerrequirement"), - "s_ezsignformfieldgroup_label": obj.get("sEzsignformfieldgroupLabel"), - "i_ezsignformfieldgroup_step": obj.get("iEzsignformfieldgroupStep"), - "s_ezsignformfieldgroup_defaultvalue": obj.get("sEzsignformfieldgroupDefaultvalue"), - "i_ezsignformfieldgroup_filledmin": obj.get("iEzsignformfieldgroupFilledmin"), - "i_ezsignformfieldgroup_filledmax": obj.get("iEzsignformfieldgroupFilledmax"), - "b_ezsignformfieldgroup_readonly": obj.get("bEzsignformfieldgroupReadonly"), - "i_ezsignformfieldgroup_maxlength": obj.get("iEzsignformfieldgroupMaxlength"), - "b_ezsignformfieldgroup_encrypted": obj.get("bEzsignformfieldgroupEncrypted"), - "e_ezsignformfieldgroup_textvalidation": obj.get("eEzsignformfieldgroupTextvalidation"), - "s_ezsignformfieldgroup_regexp": obj.get("sEzsignformfieldgroupRegexp"), - "t_ezsignformfieldgroup_tooltip": obj.get("tEzsignformfieldgroupTooltip"), - "e_ezsignformfieldgroup_tooltipposition": obj.get("eEzsignformfieldgroupTooltipposition"), - "a_obj_ezsignformfield": [EzsignformfieldResponseCompound.from_dict(_item) for _item in obj.get("a_objEzsignformfield")] if obj.get("a_objEzsignformfield") is not None else None, - "a_obj_dropdown_element": [CustomDropdownElementResponseCompound.from_dict(_item) for _item in obj.get("a_objDropdownElement")] if obj.get("a_objDropdownElement") is not None else None, - "a_obj_ezsignformfieldgroupsigner": [EzsignformfieldgroupsignerResponseCompound.from_dict(_item) for _item in obj.get("a_objEzsignformfieldgroupsigner")] if obj.get("a_objEzsignformfieldgroupsigner") is not None else None + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsignformfieldgroupID": obj.get("pkiEzsignformfieldgroupID"), + "fkiEzsigndocumentID": obj.get("fkiEzsigndocumentID"), + "eEzsignformfieldgroupType": obj.get("eEzsignformfieldgroupType"), + "eEzsignformfieldgroupSignerrequirement": obj.get("eEzsignformfieldgroupSignerrequirement"), + "sEzsignformfieldgroupLabel": obj.get("sEzsignformfieldgroupLabel"), + "iEzsignformfieldgroupStep": obj.get("iEzsignformfieldgroupStep"), + "sEzsignformfieldgroupDefaultvalue": obj.get("sEzsignformfieldgroupDefaultvalue"), + "iEzsignformfieldgroupFilledmin": obj.get("iEzsignformfieldgroupFilledmin"), + "iEzsignformfieldgroupFilledmax": obj.get("iEzsignformfieldgroupFilledmax"), + "bEzsignformfieldgroupReadonly": obj.get("bEzsignformfieldgroupReadonly"), + "iEzsignformfieldgroupMaxlength": obj.get("iEzsignformfieldgroupMaxlength"), + "bEzsignformfieldgroupEncrypted": obj.get("bEzsignformfieldgroupEncrypted"), + "eEzsignformfieldgroupTextvalidation": obj.get("eEzsignformfieldgroupTextvalidation"), + "sEzsignformfieldgroupRegexp": obj.get("sEzsignformfieldgroupRegexp"), + "tEzsignformfieldgroupTooltip": obj.get("tEzsignformfieldgroupTooltip"), + "eEzsignformfieldgroupTooltipposition": obj.get("eEzsignformfieldgroupTooltipposition"), + "a_objEzsignformfield": [EzsignformfieldResponseCompound.from_dict(_item) for _item in obj.get("a_objEzsignformfield")] if obj.get("a_objEzsignformfield") is not None else None, + "a_objDropdownElement": [CustomDropdownElementResponseCompound.from_dict(_item) for _item in obj.get("a_objDropdownElement")] if obj.get("a_objDropdownElement") is not None else None, + "a_objEzsignformfieldgroupsigner": [EzsignformfieldgroupsignerResponseCompound.from_dict(_item) for _item in obj.get("a_objEzsignformfieldgroupsigner")] if obj.get("a_objEzsignformfieldgroupsigner") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignformfieldgroupsigner_request.py b/eZmaxApi/models/ezsignformfieldgroupsigner_request.py index c5b029ed8..80746f582 100644 --- a/eZmaxApi/models/ezsignformfieldgroupsigner_request.py +++ b/eZmaxApi/models/ezsignformfieldgroupsigner_request.py @@ -19,55 +19,74 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignformfieldgroupsignerRequest(BaseModel): """ - A Ezsignformfieldgroupsigner Object # noqa: E501 - """ - pki_ezsignformfieldgroupsigner_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="pkiEzsignformfieldgroupsignerID", description="The unique ID of the Ezsignformfieldgroupsigner") - fki_ezsignfoldersignerassociation_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsignfoldersignerassociationID", description="The unique ID of the Ezsignfoldersignerassociation") - __properties = ["pkiEzsignformfieldgroupsignerID", "fkiEzsignfoldersignerassociationID"] + A Ezsignformfieldgroupsigner Object + """ # noqa: E501 + pki_ezsignformfieldgroupsigner_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsignformfieldgroupsigner", alias="pkiEzsignformfieldgroupsignerID") + fki_ezsignfoldersignerassociation_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsignfoldersignerassociation", alias="fkiEzsignfoldersignerassociationID") + __properties: ClassVar[List[str]] = ["pkiEzsignformfieldgroupsignerID", "fkiEzsignfoldersignerassociationID"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignformfieldgroupsignerRequest: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignformfieldgroupsignerRequest from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignformfieldgroupsignerRequest: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignformfieldgroupsignerRequest from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignformfieldgroupsignerRequest.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignformfieldgroupsignerRequest.parse_obj({ - "pki_ezsignformfieldgroupsigner_id": obj.get("pkiEzsignformfieldgroupsignerID"), - "fki_ezsignfoldersignerassociation_id": obj.get("fkiEzsignfoldersignerassociationID") + _obj = cls.model_validate({ + "pkiEzsignformfieldgroupsignerID": obj.get("pkiEzsignformfieldgroupsignerID"), + "fkiEzsignfoldersignerassociationID": obj.get("fkiEzsignfoldersignerassociationID") }) return _obj diff --git a/eZmaxApi/models/ezsignformfieldgroupsigner_request_compound.py b/eZmaxApi/models/ezsignformfieldgroupsigner_request_compound.py index f963317f4..75d13d7b6 100644 --- a/eZmaxApi/models/ezsignformfieldgroupsigner_request_compound.py +++ b/eZmaxApi/models/ezsignformfieldgroupsigner_request_compound.py @@ -19,55 +19,74 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignformfieldgroupsignerRequestCompound(BaseModel): """ - An Ezsignformfieldgroupsigner Object and children to create a complete structure # noqa: E501 - """ - pki_ezsignformfieldgroupsigner_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="pkiEzsignformfieldgroupsignerID", description="The unique ID of the Ezsignformfieldgroupsigner") - fki_ezsignfoldersignerassociation_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsignfoldersignerassociationID", description="The unique ID of the Ezsignfoldersignerassociation") - __properties = ["pkiEzsignformfieldgroupsignerID", "fkiEzsignfoldersignerassociationID"] + An Ezsignformfieldgroupsigner Object and children to create a complete structure + """ # noqa: E501 + pki_ezsignformfieldgroupsigner_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsignformfieldgroupsigner", alias="pkiEzsignformfieldgroupsignerID") + fki_ezsignfoldersignerassociation_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsignfoldersignerassociation", alias="fkiEzsignfoldersignerassociationID") + __properties: ClassVar[List[str]] = ["pkiEzsignformfieldgroupsignerID", "fkiEzsignfoldersignerassociationID"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignformfieldgroupsignerRequestCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignformfieldgroupsignerRequestCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignformfieldgroupsignerRequestCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignformfieldgroupsignerRequestCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignformfieldgroupsignerRequestCompound.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignformfieldgroupsignerRequestCompound.parse_obj({ - "pki_ezsignformfieldgroupsigner_id": obj.get("pkiEzsignformfieldgroupsignerID"), - "fki_ezsignfoldersignerassociation_id": obj.get("fkiEzsignfoldersignerassociationID") + _obj = cls.model_validate({ + "pkiEzsignformfieldgroupsignerID": obj.get("pkiEzsignformfieldgroupsignerID"), + "fkiEzsignfoldersignerassociationID": obj.get("fkiEzsignfoldersignerassociationID") }) return _obj diff --git a/eZmaxApi/models/ezsignformfieldgroupsigner_response.py b/eZmaxApi/models/ezsignformfieldgroupsigner_response.py index afdc5c96b..b2e5c17d0 100644 --- a/eZmaxApi/models/ezsignformfieldgroupsigner_response.py +++ b/eZmaxApi/models/ezsignformfieldgroupsigner_response.py @@ -19,55 +19,74 @@ import json - -from pydantic import BaseModel, Field, conint +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignformfieldgroupsignerResponse(BaseModel): """ - A Ezsignformfieldgroupsigner Object # noqa: E501 - """ - pki_ezsignformfieldgroupsigner_id: conint(strict=True, ge=0) = Field(..., alias="pkiEzsignformfieldgroupsignerID", description="The unique ID of the Ezsignformfieldgroupsigner") - fki_ezsignfoldersignerassociation_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsignfoldersignerassociationID", description="The unique ID of the Ezsignfoldersignerassociation") - __properties = ["pkiEzsignformfieldgroupsignerID", "fkiEzsignfoldersignerassociationID"] + A Ezsignformfieldgroupsigner Object + """ # noqa: E501 + pki_ezsignformfieldgroupsigner_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsignformfieldgroupsigner", alias="pkiEzsignformfieldgroupsignerID") + fki_ezsignfoldersignerassociation_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsignfoldersignerassociation", alias="fkiEzsignfoldersignerassociationID") + __properties: ClassVar[List[str]] = ["pkiEzsignformfieldgroupsignerID", "fkiEzsignfoldersignerassociationID"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignformfieldgroupsignerResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignformfieldgroupsignerResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignformfieldgroupsignerResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignformfieldgroupsignerResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignformfieldgroupsignerResponse.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignformfieldgroupsignerResponse.parse_obj({ - "pki_ezsignformfieldgroupsigner_id": obj.get("pkiEzsignformfieldgroupsignerID"), - "fki_ezsignfoldersignerassociation_id": obj.get("fkiEzsignfoldersignerassociationID") + _obj = cls.model_validate({ + "pkiEzsignformfieldgroupsignerID": obj.get("pkiEzsignformfieldgroupsignerID"), + "fkiEzsignfoldersignerassociationID": obj.get("fkiEzsignfoldersignerassociationID") }) return _obj diff --git a/eZmaxApi/models/ezsignformfieldgroupsigner_response_compound.py b/eZmaxApi/models/ezsignformfieldgroupsigner_response_compound.py index 5ce023288..c8834db15 100644 --- a/eZmaxApi/models/ezsignformfieldgroupsigner_response_compound.py +++ b/eZmaxApi/models/ezsignformfieldgroupsigner_response_compound.py @@ -19,55 +19,74 @@ import json - -from pydantic import BaseModel, Field, conint +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignformfieldgroupsignerResponseCompound(BaseModel): """ - An Ezsignformfieldgroupsigner Object and children to create a complete structure # noqa: E501 - """ - pki_ezsignformfieldgroupsigner_id: conint(strict=True, ge=0) = Field(..., alias="pkiEzsignformfieldgroupsignerID", description="The unique ID of the Ezsignformfieldgroupsigner") - fki_ezsignfoldersignerassociation_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsignfoldersignerassociationID", description="The unique ID of the Ezsignfoldersignerassociation") - __properties = ["pkiEzsignformfieldgroupsignerID", "fkiEzsignfoldersignerassociationID"] + An Ezsignformfieldgroupsigner Object and children to create a complete structure + """ # noqa: E501 + pki_ezsignformfieldgroupsigner_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsignformfieldgroupsigner", alias="pkiEzsignformfieldgroupsignerID") + fki_ezsignfoldersignerassociation_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsignfoldersignerassociation", alias="fkiEzsignfoldersignerassociationID") + __properties: ClassVar[List[str]] = ["pkiEzsignformfieldgroupsignerID", "fkiEzsignfoldersignerassociationID"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignformfieldgroupsignerResponseCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignformfieldgroupsignerResponseCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignformfieldgroupsignerResponseCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignformfieldgroupsignerResponseCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignformfieldgroupsignerResponseCompound.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignformfieldgroupsignerResponseCompound.parse_obj({ - "pki_ezsignformfieldgroupsigner_id": obj.get("pkiEzsignformfieldgroupsignerID"), - "fki_ezsignfoldersignerassociation_id": obj.get("fkiEzsignfoldersignerassociationID") + _obj = cls.model_validate({ + "pkiEzsignformfieldgroupsignerID": obj.get("pkiEzsignformfieldgroupsignerID"), + "fkiEzsignfoldersignerassociationID": obj.get("fkiEzsignfoldersignerassociationID") }) return _obj diff --git a/eZmaxApi/models/ezsignpage_consult_v1_response.py b/eZmaxApi/models/ezsignpage_consult_v1_response.py index d386bb109..a8b172887 100644 --- a/eZmaxApi/models/ezsignpage_consult_v1_response.py +++ b/eZmaxApi/models/ezsignpage_consult_v1_response.py @@ -19,43 +19,61 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignpageConsultV1Response(BaseModel): """ - Response for POST /1/object/ezsignpage/{pkiEzsignpageID}/consult # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - __properties = ["objDebugPayload", "objDebug"] + Response for POST /1/object/ezsignpage/{pkiEzsignpageID}/consult + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignpageConsultV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignpageConsultV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -65,17 +83,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignpageConsultV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignpageConsultV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignpageConsultV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignpageConsultV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignpage_response.py b/eZmaxApi/models/ezsignpage_response.py index 6f492a899..4027cc41c 100644 --- a/eZmaxApi/models/ezsignpage_response.py +++ b/eZmaxApi/models/ezsignpage_response.py @@ -19,65 +19,84 @@ import json - -from pydantic import BaseModel, Field, StrictStr, conint +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictStr +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignpageResponse(BaseModel): """ - An Ezsignpage Object # noqa: E501 - """ - pki_ezsignpage_id: conint(strict=True, ge=0) = Field(..., alias="pkiEzsignpageID", description="The unique ID of the Ezsignpage") - i_ezsignpage_widthimage: conint(strict=True, ge=0) = Field(..., alias="iEzsignpageWidthimage", description="The Width of the page's image in pixels calculated at 100 DPI") - i_ezsignpage_heightimage: conint(strict=True, ge=0) = Field(..., alias="iEzsignpageHeightimage", description="The Height of the page's image in pixels calculated at 100 DPI") - i_ezsignpage_widthpdf: conint(strict=True, ge=0) = Field(..., alias="iEzsignpageWidthpdf", description="The Width of the page in points calculated at 72 DPI") - i_ezsignpage_heightpdf: conint(strict=True, ge=0) = Field(..., alias="iEzsignpageHeightpdf", description="The Height of the page in points calculated at 72 DPI") - i_ezsignpage_pagenumber: conint(strict=True, ge=1) = Field(..., alias="iEzsignpagePagenumber", description="The page number in the Ezsigndocument") - s_computed_imageurl: StrictStr = Field(..., alias="sComputedImageurl", description="The Url to the Ezsignpage's rasterized image. Url will expire after 5 minutes.") - __properties = ["pkiEzsignpageID", "iEzsignpageWidthimage", "iEzsignpageHeightimage", "iEzsignpageWidthpdf", "iEzsignpageHeightpdf", "iEzsignpagePagenumber", "sComputedImageurl"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + An Ezsignpage Object + """ # noqa: E501 + pki_ezsignpage_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsignpage", alias="pkiEzsignpageID") + i_ezsignpage_widthimage: Annotated[int, Field(strict=True, ge=0)] = Field(description="The Width of the page's image in pixels calculated at 100 DPI", alias="iEzsignpageWidthimage") + i_ezsignpage_heightimage: Annotated[int, Field(strict=True, ge=0)] = Field(description="The Height of the page's image in pixels calculated at 100 DPI", alias="iEzsignpageHeightimage") + i_ezsignpage_widthpdf: Annotated[int, Field(strict=True, ge=0)] = Field(description="The Width of the page in points calculated at 72 DPI", alias="iEzsignpageWidthpdf") + i_ezsignpage_heightpdf: Annotated[int, Field(strict=True, ge=0)] = Field(description="The Height of the page in points calculated at 72 DPI", alias="iEzsignpageHeightpdf") + i_ezsignpage_pagenumber: Annotated[int, Field(strict=True, ge=1)] = Field(description="The page number in the Ezsigndocument", alias="iEzsignpagePagenumber") + s_computed_imageurl: StrictStr = Field(description="The Url to the Ezsignpage's rasterized image. Url will expire after 5 minutes.", alias="sComputedImageurl") + __properties: ClassVar[List[str]] = ["pkiEzsignpageID", "iEzsignpageWidthimage", "iEzsignpageHeightimage", "iEzsignpageWidthpdf", "iEzsignpageHeightpdf", "iEzsignpagePagenumber", "sComputedImageurl"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignpageResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignpageResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignpageResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignpageResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignpageResponse.parse_obj(obj) - - _obj = EzsignpageResponse.parse_obj({ - "pki_ezsignpage_id": obj.get("pkiEzsignpageID"), - "i_ezsignpage_widthimage": obj.get("iEzsignpageWidthimage"), - "i_ezsignpage_heightimage": obj.get("iEzsignpageHeightimage"), - "i_ezsignpage_widthpdf": obj.get("iEzsignpageWidthpdf"), - "i_ezsignpage_heightpdf": obj.get("iEzsignpageHeightpdf"), - "i_ezsignpage_pagenumber": obj.get("iEzsignpagePagenumber"), - "s_computed_imageurl": obj.get("sComputedImageurl") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsignpageID": obj.get("pkiEzsignpageID"), + "iEzsignpageWidthimage": obj.get("iEzsignpageWidthimage"), + "iEzsignpageHeightimage": obj.get("iEzsignpageHeightimage"), + "iEzsignpageWidthpdf": obj.get("iEzsignpageWidthpdf"), + "iEzsignpageHeightpdf": obj.get("iEzsignpageHeightpdf"), + "iEzsignpagePagenumber": obj.get("iEzsignpagePagenumber"), + "sComputedImageurl": obj.get("sComputedImageurl") }) return _obj diff --git a/eZmaxApi/models/ezsignpage_response_compound.py b/eZmaxApi/models/ezsignpage_response_compound.py index f81815588..2957a9da5 100644 --- a/eZmaxApi/models/ezsignpage_response_compound.py +++ b/eZmaxApi/models/ezsignpage_response_compound.py @@ -19,65 +19,84 @@ import json - -from pydantic import BaseModel, Field, StrictStr, conint +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictStr +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignpageResponseCompound(BaseModel): """ - An Ezsignpage Object and children to create a complete structure # noqa: E501 - """ - pki_ezsignpage_id: conint(strict=True, ge=0) = Field(..., alias="pkiEzsignpageID", description="The unique ID of the Ezsignpage") - i_ezsignpage_widthimage: conint(strict=True, ge=0) = Field(..., alias="iEzsignpageWidthimage", description="The Width of the page's image in pixels calculated at 100 DPI") - i_ezsignpage_heightimage: conint(strict=True, ge=0) = Field(..., alias="iEzsignpageHeightimage", description="The Height of the page's image in pixels calculated at 100 DPI") - i_ezsignpage_widthpdf: conint(strict=True, ge=0) = Field(..., alias="iEzsignpageWidthpdf", description="The Width of the page in points calculated at 72 DPI") - i_ezsignpage_heightpdf: conint(strict=True, ge=0) = Field(..., alias="iEzsignpageHeightpdf", description="The Height of the page in points calculated at 72 DPI") - i_ezsignpage_pagenumber: conint(strict=True, ge=1) = Field(..., alias="iEzsignpagePagenumber", description="The page number in the Ezsigndocument") - s_computed_imageurl: StrictStr = Field(..., alias="sComputedImageurl", description="The Url to the Ezsignpage's rasterized image. Url will expire after 5 minutes.") - __properties = ["pkiEzsignpageID", "iEzsignpageWidthimage", "iEzsignpageHeightimage", "iEzsignpageWidthpdf", "iEzsignpageHeightpdf", "iEzsignpagePagenumber", "sComputedImageurl"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + An Ezsignpage Object and children to create a complete structure + """ # noqa: E501 + pki_ezsignpage_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsignpage", alias="pkiEzsignpageID") + i_ezsignpage_widthimage: Annotated[int, Field(strict=True, ge=0)] = Field(description="The Width of the page's image in pixels calculated at 100 DPI", alias="iEzsignpageWidthimage") + i_ezsignpage_heightimage: Annotated[int, Field(strict=True, ge=0)] = Field(description="The Height of the page's image in pixels calculated at 100 DPI", alias="iEzsignpageHeightimage") + i_ezsignpage_widthpdf: Annotated[int, Field(strict=True, ge=0)] = Field(description="The Width of the page in points calculated at 72 DPI", alias="iEzsignpageWidthpdf") + i_ezsignpage_heightpdf: Annotated[int, Field(strict=True, ge=0)] = Field(description="The Height of the page in points calculated at 72 DPI", alias="iEzsignpageHeightpdf") + i_ezsignpage_pagenumber: Annotated[int, Field(strict=True, ge=1)] = Field(description="The page number in the Ezsigndocument", alias="iEzsignpagePagenumber") + s_computed_imageurl: StrictStr = Field(description="The Url to the Ezsignpage's rasterized image. Url will expire after 5 minutes.", alias="sComputedImageurl") + __properties: ClassVar[List[str]] = ["pkiEzsignpageID", "iEzsignpageWidthimage", "iEzsignpageHeightimage", "iEzsignpageWidthpdf", "iEzsignpageHeightpdf", "iEzsignpagePagenumber", "sComputedImageurl"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignpageResponseCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignpageResponseCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignpageResponseCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignpageResponseCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignpageResponseCompound.parse_obj(obj) - - _obj = EzsignpageResponseCompound.parse_obj({ - "pki_ezsignpage_id": obj.get("pkiEzsignpageID"), - "i_ezsignpage_widthimage": obj.get("iEzsignpageWidthimage"), - "i_ezsignpage_heightimage": obj.get("iEzsignpageHeightimage"), - "i_ezsignpage_widthpdf": obj.get("iEzsignpageWidthpdf"), - "i_ezsignpage_heightpdf": obj.get("iEzsignpageHeightpdf"), - "i_ezsignpage_pagenumber": obj.get("iEzsignpagePagenumber"), - "s_computed_imageurl": obj.get("sComputedImageurl") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsignpageID": obj.get("pkiEzsignpageID"), + "iEzsignpageWidthimage": obj.get("iEzsignpageWidthimage"), + "iEzsignpageHeightimage": obj.get("iEzsignpageHeightimage"), + "iEzsignpageWidthpdf": obj.get("iEzsignpageWidthpdf"), + "iEzsignpageHeightpdf": obj.get("iEzsignpageHeightpdf"), + "iEzsignpagePagenumber": obj.get("iEzsignpagePagenumber"), + "sComputedImageurl": obj.get("sComputedImageurl") }) return _obj diff --git a/eZmaxApi/models/ezsignsignature_create_object_v1_request.py b/eZmaxApi/models/ezsignsignature_create_object_v1_request.py index d5f7fa584..58b796d3b 100644 --- a/eZmaxApi/models/ezsignsignature_create_object_v1_request.py +++ b/eZmaxApi/models/ezsignsignature_create_object_v1_request.py @@ -19,43 +19,61 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.ezsignsignature_request import EzsignsignatureRequest from eZmaxApi.models.ezsignsignature_request_compound import EzsignsignatureRequestCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignsignatureCreateObjectV1Request(BaseModel): """ - Request for POST /1/object/ezsignsignature # noqa: E501 - """ - obj_ezsignsignature: Optional[EzsignsignatureRequest] = Field(None, alias="objEzsignsignature") - obj_ezsignsignature_compound: Optional[EzsignsignatureRequestCompound] = Field(None, alias="objEzsignsignatureCompound") - __properties = ["objEzsignsignature", "objEzsignsignatureCompound"] + Request for POST /1/object/ezsignsignature + """ # noqa: E501 + obj_ezsignsignature: Optional[EzsignsignatureRequest] = Field(default=None, alias="objEzsignsignature") + obj_ezsignsignature_compound: Optional[EzsignsignatureRequestCompound] = Field(default=None, alias="objEzsignsignatureCompound") + __properties: ClassVar[List[str]] = ["objEzsignsignature", "objEzsignsignatureCompound"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignsignatureCreateObjectV1Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignsignatureCreateObjectV1Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_ezsignsignature if self.obj_ezsignsignature: _dict['objEzsignsignature'] = self.obj_ezsignsignature.to_dict() @@ -65,17 +83,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignsignatureCreateObjectV1Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignsignatureCreateObjectV1Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignsignatureCreateObjectV1Request.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignsignatureCreateObjectV1Request.parse_obj({ - "obj_ezsignsignature": EzsignsignatureRequest.from_dict(obj.get("objEzsignsignature")) if obj.get("objEzsignsignature") is not None else None, - "obj_ezsignsignature_compound": EzsignsignatureRequestCompound.from_dict(obj.get("objEzsignsignatureCompound")) if obj.get("objEzsignsignatureCompound") is not None else None + _obj = cls.model_validate({ + "objEzsignsignature": EzsignsignatureRequest.from_dict(obj.get("objEzsignsignature")) if obj.get("objEzsignsignature") is not None else None, + "objEzsignsignatureCompound": EzsignsignatureRequestCompound.from_dict(obj.get("objEzsignsignatureCompound")) if obj.get("objEzsignsignatureCompound") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignsignature_create_object_v1_response.py b/eZmaxApi/models/ezsignsignature_create_object_v1_response.py index 066b19708..499c29169 100644 --- a/eZmaxApi/models/ezsignsignature_create_object_v1_response.py +++ b/eZmaxApi/models/ezsignsignature_create_object_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.ezsignsignature_create_object_v1_response_m_payload import EzsignsignatureCreateObjectV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignsignatureCreateObjectV1Response(BaseModel): """ - Response for POST /1/object/ezsignsignature # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzsignsignatureCreateObjectV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for POST /1/object/ezsignsignature + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsignsignatureCreateObjectV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignsignatureCreateObjectV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignsignatureCreateObjectV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignsignatureCreateObjectV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignsignatureCreateObjectV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignsignatureCreateObjectV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignsignatureCreateObjectV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzsignsignatureCreateObjectV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsignsignatureCreateObjectV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignsignature_create_object_v1_response_m_payload.py b/eZmaxApi/models/ezsignsignature_create_object_v1_response_m_payload.py index 9d4eb99f6..5d73c96b0 100644 --- a/eZmaxApi/models/ezsignsignature_create_object_v1_response_m_payload.py +++ b/eZmaxApi/models/ezsignsignature_create_object_v1_response_m_payload.py @@ -19,53 +19,72 @@ import json -from typing import List -from pydantic import BaseModel, Field, conint, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignsignatureCreateObjectV1ResponseMPayload(BaseModel): """ - Payload for POST /1/object/ezsignsignature # noqa: E501 - """ - a_pki_ezsignsignature_id: conlist(conint(strict=True, ge=0), min_items=1) = Field(..., alias="a_pkiEzsignsignatureID", description="An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request.") - __properties = ["a_pkiEzsignsignatureID"] + Payload for POST /1/object/ezsignsignature + """ # noqa: E501 + a_pki_ezsignsignature_id: Annotated[List[Annotated[int, Field(strict=True, ge=0)]], Field(min_length=1)] = Field(description="An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request.", alias="a_pkiEzsignsignatureID") + __properties: ClassVar[List[str]] = ["a_pkiEzsignsignatureID"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignsignatureCreateObjectV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignsignatureCreateObjectV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignsignatureCreateObjectV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignsignatureCreateObjectV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignsignatureCreateObjectV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignsignatureCreateObjectV1ResponseMPayload.parse_obj({ - "a_pki_ezsignsignature_id": obj.get("a_pkiEzsignsignatureID") + _obj = cls.model_validate({ + "a_pkiEzsignsignatureID": obj.get("a_pkiEzsignsignatureID") }) return _obj diff --git a/eZmaxApi/models/ezsignsignature_create_object_v2_request.py b/eZmaxApi/models/ezsignsignature_create_object_v2_request.py index 590d86756..73ab5c69d 100644 --- a/eZmaxApi/models/ezsignsignature_create_object_v2_request.py +++ b/eZmaxApi/models/ezsignsignature_create_object_v2_request.py @@ -19,41 +19,60 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.ezsignsignature_request_compound import EzsignsignatureRequestCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignsignatureCreateObjectV2Request(BaseModel): """ - Request for POST /2/object/ezsignsignature # noqa: E501 - """ - a_obj_ezsignsignature: conlist(EzsignsignatureRequestCompound, min_items=1) = Field(..., alias="a_objEzsignsignature") - __properties = ["a_objEzsignsignature"] + Request for POST /2/object/ezsignsignature + """ # noqa: E501 + a_obj_ezsignsignature: Annotated[List[EzsignsignatureRequestCompound], Field(min_length=1)] = Field(alias="a_objEzsignsignature") + __properties: ClassVar[List[str]] = ["a_objEzsignsignature"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignsignatureCreateObjectV2Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignsignatureCreateObjectV2Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_ezsignsignature (list) _items = [] if self.a_obj_ezsignsignature: @@ -64,16 +83,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignsignatureCreateObjectV2Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignsignatureCreateObjectV2Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignsignatureCreateObjectV2Request.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignsignatureCreateObjectV2Request.parse_obj({ - "a_obj_ezsignsignature": [EzsignsignatureRequestCompound.from_dict(_item) for _item in obj.get("a_objEzsignsignature")] if obj.get("a_objEzsignsignature") is not None else None + _obj = cls.model_validate({ + "a_objEzsignsignature": [EzsignsignatureRequestCompound.from_dict(_item) for _item in obj.get("a_objEzsignsignature")] if obj.get("a_objEzsignsignature") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignsignature_create_object_v2_response.py b/eZmaxApi/models/ezsignsignature_create_object_v2_response.py index d230f7d32..6453d8907 100644 --- a/eZmaxApi/models/ezsignsignature_create_object_v2_response.py +++ b/eZmaxApi/models/ezsignsignature_create_object_v2_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.ezsignsignature_create_object_v2_response_m_payload import EzsignsignatureCreateObjectV2ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignsignatureCreateObjectV2Response(BaseModel): """ - Response for POST /2/object/ezsignsignature # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzsignsignatureCreateObjectV2ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for POST /2/object/ezsignsignature + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsignsignatureCreateObjectV2ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignsignatureCreateObjectV2Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignsignatureCreateObjectV2Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignsignatureCreateObjectV2Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignsignatureCreateObjectV2Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignsignatureCreateObjectV2Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignsignatureCreateObjectV2Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzsignsignatureCreateObjectV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsignsignatureCreateObjectV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignsignature_create_object_v2_response_m_payload.py b/eZmaxApi/models/ezsignsignature_create_object_v2_response_m_payload.py index 7369918a0..21d5f1756 100644 --- a/eZmaxApi/models/ezsignsignature_create_object_v2_response_m_payload.py +++ b/eZmaxApi/models/ezsignsignature_create_object_v2_response_m_payload.py @@ -19,53 +19,72 @@ import json -from typing import List -from pydantic import BaseModel, Field, conint, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignsignatureCreateObjectV2ResponseMPayload(BaseModel): """ - Payload for POST /2/object/ezsignsignature # noqa: E501 - """ - a_pki_ezsignsignature_id: conlist(conint(strict=True, ge=0), min_items=1) = Field(..., alias="a_pkiEzsignsignatureID", description="An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request.") - __properties = ["a_pkiEzsignsignatureID"] + Payload for POST /2/object/ezsignsignature + """ # noqa: E501 + a_pki_ezsignsignature_id: Annotated[List[Annotated[int, Field(strict=True, ge=0)]], Field(min_length=1)] = Field(description="An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request.", alias="a_pkiEzsignsignatureID") + __properties: ClassVar[List[str]] = ["a_pkiEzsignsignatureID"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignsignatureCreateObjectV2ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignsignatureCreateObjectV2ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignsignatureCreateObjectV2ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignsignatureCreateObjectV2ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignsignatureCreateObjectV2ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignsignatureCreateObjectV2ResponseMPayload.parse_obj({ - "a_pki_ezsignsignature_id": obj.get("a_pkiEzsignsignatureID") + _obj = cls.model_validate({ + "a_pkiEzsignsignatureID": obj.get("a_pkiEzsignsignatureID") }) return _obj diff --git a/eZmaxApi/models/ezsignsignature_delete_object_v1_response.py b/eZmaxApi/models/ezsignsignature_delete_object_v1_response.py index a62176279..07b17b3da 100644 --- a/eZmaxApi/models/ezsignsignature_delete_object_v1_response.py +++ b/eZmaxApi/models/ezsignsignature_delete_object_v1_response.py @@ -19,43 +19,61 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignsignatureDeleteObjectV1Response(BaseModel): """ - Response for DELETE /1/object/ezsignsignature/{pkiEzsignsignatureID} # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - __properties = ["objDebugPayload", "objDebug"] + Response for DELETE /1/object/ezsignsignature/{pkiEzsignsignatureID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignsignatureDeleteObjectV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignsignatureDeleteObjectV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -65,17 +83,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignsignatureDeleteObjectV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignsignatureDeleteObjectV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignsignatureDeleteObjectV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignsignatureDeleteObjectV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignsignature_edit_object_v1_request.py b/eZmaxApi/models/ezsignsignature_edit_object_v1_request.py index 9db54947f..85bb72a51 100644 --- a/eZmaxApi/models/ezsignsignature_edit_object_v1_request.py +++ b/eZmaxApi/models/ezsignsignature_edit_object_v1_request.py @@ -19,57 +19,75 @@ import json - -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.ezsignsignature_request_compound import EzsignsignatureRequestCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignsignatureEditObjectV1Request(BaseModel): """ - Request for PUT /1/object/ezsignsignature/{pkiEzsignsignatureID} # noqa: E501 - """ - obj_ezsignsignature: EzsignsignatureRequestCompound = Field(..., alias="objEzsignsignature") - __properties = ["objEzsignsignature"] + Request for PUT /1/object/ezsignsignature/{pkiEzsignsignatureID} + """ # noqa: E501 + obj_ezsignsignature: EzsignsignatureRequestCompound = Field(alias="objEzsignsignature") + __properties: ClassVar[List[str]] = ["objEzsignsignature"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignsignatureEditObjectV1Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignsignatureEditObjectV1Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_ezsignsignature if self.obj_ezsignsignature: _dict['objEzsignsignature'] = self.obj_ezsignsignature.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignsignatureEditObjectV1Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignsignatureEditObjectV1Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignsignatureEditObjectV1Request.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignsignatureEditObjectV1Request.parse_obj({ - "obj_ezsignsignature": EzsignsignatureRequestCompound.from_dict(obj.get("objEzsignsignature")) if obj.get("objEzsignsignature") is not None else None + _obj = cls.model_validate({ + "objEzsignsignature": EzsignsignatureRequestCompound.from_dict(obj.get("objEzsignsignature")) if obj.get("objEzsignsignature") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignsignature_edit_object_v1_response.py b/eZmaxApi/models/ezsignsignature_edit_object_v1_response.py index c15656058..3162ce9d9 100644 --- a/eZmaxApi/models/ezsignsignature_edit_object_v1_response.py +++ b/eZmaxApi/models/ezsignsignature_edit_object_v1_response.py @@ -19,43 +19,61 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignsignatureEditObjectV1Response(BaseModel): """ - Response for PUT /1/object/ezsignsignature/{pkiEzsignsignatureID} # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - __properties = ["objDebugPayload", "objDebug"] + Response for PUT /1/object/ezsignsignature/{pkiEzsignsignatureID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignsignatureEditObjectV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignsignatureEditObjectV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -65,17 +83,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignsignatureEditObjectV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignsignatureEditObjectV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignsignatureEditObjectV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignsignatureEditObjectV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignsignature_get_ezsignsignatureattachment_v1_response.py b/eZmaxApi/models/ezsignsignature_get_ezsignsignatureattachment_v1_response.py index 0d267bd36..d3a5d30e1 100644 --- a/eZmaxApi/models/ezsignsignature_get_ezsignsignatureattachment_v1_response.py +++ b/eZmaxApi/models/ezsignsignature_get_ezsignsignatureattachment_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.ezsignsignature_get_ezsignsignatureattachment_v1_response_m_payload import EzsignsignatureGetEzsignsignatureattachmentV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignsignatureGetEzsignsignatureattachmentV1Response(BaseModel): """ - Response for GET /1/object/ezsignsignature/{pkiEzsignsignatureID}/getEzsignsignatureattachment # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzsignsignatureGetEzsignsignatureattachmentV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /1/object/ezsignsignature/{pkiEzsignsignatureID}/getEzsignsignatureattachment + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsignsignatureGetEzsignsignatureattachmentV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignsignatureGetEzsignsignatureattachmentV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignsignatureGetEzsignsignatureattachmentV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignsignatureGetEzsignsignatureattachmentV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignsignatureGetEzsignsignatureattachmentV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignsignatureGetEzsignsignatureattachmentV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignsignatureGetEzsignsignatureattachmentV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzsignsignatureGetEzsignsignatureattachmentV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsignsignatureGetEzsignsignatureattachmentV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignsignature_get_ezsignsignatureattachment_v1_response_m_payload.py b/eZmaxApi/models/ezsignsignature_get_ezsignsignatureattachment_v1_response_m_payload.py index 79c84b98a..9986e87aa 100644 --- a/eZmaxApi/models/ezsignsignature_get_ezsignsignatureattachment_v1_response_m_payload.py +++ b/eZmaxApi/models/ezsignsignature_get_ezsignsignatureattachment_v1_response_m_payload.py @@ -19,41 +19,59 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.ezsignsignatureattachment_response import EzsignsignatureattachmentResponse +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignsignatureGetEzsignsignatureattachmentV1ResponseMPayload(BaseModel): """ - Response for GET /1/object/ezsignsignature/{pkiEzsignsignatureID}/getEzsignsignatureattachment # noqa: E501 - """ - a_obj_ezsignsignatureattachment: conlist(EzsignsignatureattachmentResponse) = Field(..., alias="a_objEzsignsignatureattachment") - __properties = ["a_objEzsignsignatureattachment"] + Response for GET /1/object/ezsignsignature/{pkiEzsignsignatureID}/getEzsignsignatureattachment + """ # noqa: E501 + a_obj_ezsignsignatureattachment: List[EzsignsignatureattachmentResponse] = Field(alias="a_objEzsignsignatureattachment") + __properties: ClassVar[List[str]] = ["a_objEzsignsignatureattachment"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignsignatureGetEzsignsignatureattachmentV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignsignatureGetEzsignsignatureattachmentV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_ezsignsignatureattachment (list) _items = [] if self.a_obj_ezsignsignatureattachment: @@ -64,16 +82,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignsignatureGetEzsignsignatureattachmentV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignsignatureGetEzsignsignatureattachmentV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignsignatureGetEzsignsignatureattachmentV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignsignatureGetEzsignsignatureattachmentV1ResponseMPayload.parse_obj({ - "a_obj_ezsignsignatureattachment": [EzsignsignatureattachmentResponse.from_dict(_item) for _item in obj.get("a_objEzsignsignatureattachment")] if obj.get("a_objEzsignsignatureattachment") is not None else None + _obj = cls.model_validate({ + "a_objEzsignsignatureattachment": [EzsignsignatureattachmentResponse.from_dict(_item) for _item in obj.get("a_objEzsignsignatureattachment")] if obj.get("a_objEzsignsignatureattachment") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignsignature_get_ezsignsignatures_automatic_v1_response.py b/eZmaxApi/models/ezsignsignature_get_ezsignsignatures_automatic_v1_response.py index ab3bf6426..e518cddae 100644 --- a/eZmaxApi/models/ezsignsignature_get_ezsignsignatures_automatic_v1_response.py +++ b/eZmaxApi/models/ezsignsignature_get_ezsignsignatures_automatic_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.ezsignsignature_get_ezsignsignatures_automatic_v1_response_m_payload import EzsignsignatureGetEzsignsignaturesAutomaticV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignsignatureGetEzsignsignaturesAutomaticV1Response(BaseModel): """ - Response for GET /1/object/ezsignsignature/getEzsignsignaturesAutomatic # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzsignsignatureGetEzsignsignaturesAutomaticV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /1/object/ezsignsignature/getEzsignsignaturesAutomatic + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsignsignatureGetEzsignsignaturesAutomaticV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignsignatureGetEzsignsignaturesAutomaticV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignsignatureGetEzsignsignaturesAutomaticV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignsignatureGetEzsignsignaturesAutomaticV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignsignatureGetEzsignsignaturesAutomaticV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignsignatureGetEzsignsignaturesAutomaticV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignsignatureGetEzsignsignaturesAutomaticV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzsignsignatureGetEzsignsignaturesAutomaticV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsignsignatureGetEzsignsignaturesAutomaticV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignsignature_get_ezsignsignatures_automatic_v1_response_m_payload.py b/eZmaxApi/models/ezsignsignature_get_ezsignsignatures_automatic_v1_response_m_payload.py index e4a10ad46..2077b19a3 100644 --- a/eZmaxApi/models/ezsignsignature_get_ezsignsignatures_automatic_v1_response_m_payload.py +++ b/eZmaxApi/models/ezsignsignature_get_ezsignsignatures_automatic_v1_response_m_payload.py @@ -19,43 +19,61 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.custom_ezsignfolder_ezsignsignatures_automatic_response import CustomEzsignfolderEzsignsignaturesAutomaticResponse from eZmaxApi.models.field_e_ezsignsignature_type import FieldEEzsignsignatureType +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignsignatureGetEzsignsignaturesAutomaticV1ResponseMPayload(BaseModel): """ - Payload for GET /1/object/ezsigsignature/getEzsignsignaturesAutomatic # noqa: E501 - """ - a_e_ezsignsignature_type: conlist(FieldEEzsignsignatureType, unique_items=True) = Field(..., alias="a_eEzsignsignatureType", description="All eEzsignsignatureType contained in the response") - a_obj_ezsignfolder: conlist(CustomEzsignfolderEzsignsignaturesAutomaticResponse) = Field(..., alias="a_objEzsignfolder") - __properties = ["a_eEzsignsignatureType", "a_objEzsignfolder"] + Payload for GET /1/object/ezsigsignature/getEzsignsignaturesAutomatic + """ # noqa: E501 + a_e_ezsignsignature_type: List[FieldEEzsignsignatureType] = Field(description="All eEzsignsignatureType contained in the response", alias="a_eEzsignsignatureType") + a_obj_ezsignfolder: List[CustomEzsignfolderEzsignsignaturesAutomaticResponse] = Field(alias="a_objEzsignfolder") + __properties: ClassVar[List[str]] = ["a_eEzsignsignatureType", "a_objEzsignfolder"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignsignatureGetEzsignsignaturesAutomaticV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignsignatureGetEzsignsignaturesAutomaticV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_ezsignfolder (list) _items = [] if self.a_obj_ezsignfolder: @@ -66,17 +84,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignsignatureGetEzsignsignaturesAutomaticV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignsignatureGetEzsignsignaturesAutomaticV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignsignatureGetEzsignsignaturesAutomaticV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignsignatureGetEzsignsignaturesAutomaticV1ResponseMPayload.parse_obj({ - "a_e_ezsignsignature_type": obj.get("a_eEzsignsignatureType"), - "a_obj_ezsignfolder": [CustomEzsignfolderEzsignsignaturesAutomaticResponse.from_dict(_item) for _item in obj.get("a_objEzsignfolder")] if obj.get("a_objEzsignfolder") is not None else None + _obj = cls.model_validate({ + "a_eEzsignsignatureType": obj.get("a_eEzsignsignatureType"), + "a_objEzsignfolder": [CustomEzsignfolderEzsignsignaturesAutomaticResponse.from_dict(_item) for _item in obj.get("a_objEzsignfolder")] if obj.get("a_objEzsignfolder") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignsignature_get_object_v2_response.py b/eZmaxApi/models/ezsignsignature_get_object_v2_response.py index e923d90ab..1d94d0514 100644 --- a/eZmaxApi/models/ezsignsignature_get_object_v2_response.py +++ b/eZmaxApi/models/ezsignsignature_get_object_v2_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.ezsignsignature_get_object_v2_response_m_payload import EzsignsignatureGetObjectV2ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignsignatureGetObjectV2Response(BaseModel): """ - Response for GET /2/object/ezsignsignature/{pkiEzsignsignatureID} # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzsignsignatureGetObjectV2ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /2/object/ezsignsignature/{pkiEzsignsignatureID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsignsignatureGetObjectV2ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignsignatureGetObjectV2Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignsignatureGetObjectV2Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignsignatureGetObjectV2Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignsignatureGetObjectV2Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignsignatureGetObjectV2Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignsignatureGetObjectV2Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzsignsignatureGetObjectV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsignsignatureGetObjectV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignsignature_get_object_v2_response_m_payload.py b/eZmaxApi/models/ezsignsignature_get_object_v2_response_m_payload.py index 82a1b074c..ca360dc92 100644 --- a/eZmaxApi/models/ezsignsignature_get_object_v2_response_m_payload.py +++ b/eZmaxApi/models/ezsignsignature_get_object_v2_response_m_payload.py @@ -19,57 +19,75 @@ import json - -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.ezsignsignature_response_compound import EzsignsignatureResponseCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignsignatureGetObjectV2ResponseMPayload(BaseModel): """ - Payload for GET /2/object/ezsignsignature/{pkiEzsignsignatureID} # noqa: E501 - """ - obj_ezsignsignature: EzsignsignatureResponseCompound = Field(..., alias="objEzsignsignature") - __properties = ["objEzsignsignature"] + Payload for GET /2/object/ezsignsignature/{pkiEzsignsignatureID} + """ # noqa: E501 + obj_ezsignsignature: EzsignsignatureResponseCompound = Field(alias="objEzsignsignature") + __properties: ClassVar[List[str]] = ["objEzsignsignature"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignsignatureGetObjectV2ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignsignatureGetObjectV2ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_ezsignsignature if self.obj_ezsignsignature: _dict['objEzsignsignature'] = self.obj_ezsignsignature.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignsignatureGetObjectV2ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignsignatureGetObjectV2ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignsignatureGetObjectV2ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignsignatureGetObjectV2ResponseMPayload.parse_obj({ - "obj_ezsignsignature": EzsignsignatureResponseCompound.from_dict(obj.get("objEzsignsignature")) if obj.get("objEzsignsignature") is not None else None + _obj = cls.model_validate({ + "objEzsignsignature": EzsignsignatureResponseCompound.from_dict(obj.get("objEzsignsignature")) if obj.get("objEzsignsignature") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignsignature_request.py b/eZmaxApi/models/ezsignsignature_request.py index 72c69e49a..c0f384db0 100644 --- a/eZmaxApi/models/ezsignsignature_request.py +++ b/eZmaxApi/models/ezsignsignature_request.py @@ -19,44 +19,50 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictBool, StrictInt, StrictStr, conint, constr, validator +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, StrictInt, StrictStr, field_validator +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.enum_textvalidation import EnumTextvalidation from eZmaxApi.models.field_e_ezsignsignature_attachmentnamesource import FieldEEzsignsignatureAttachmentnamesource from eZmaxApi.models.field_e_ezsignsignature_dependencyrequirement import FieldEEzsignsignatureDependencyrequirement from eZmaxApi.models.field_e_ezsignsignature_font import FieldEEzsignsignatureFont from eZmaxApi.models.field_e_ezsignsignature_tooltipposition import FieldEEzsignsignatureTooltipposition from eZmaxApi.models.field_e_ezsignsignature_type import FieldEEzsignsignatureType +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignsignatureRequest(BaseModel): """ - An Ezsignsignature Object # noqa: E501 - """ - pki_ezsignsignature_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="pkiEzsignsignatureID", description="The unique ID of the Ezsignsignature") - fki_ezsignfoldersignerassociation_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsignfoldersignerassociationID", description="The unique ID of the Ezsignfoldersignerassociation") - i_ezsignpage_pagenumber: conint(strict=True, ge=1) = Field(..., alias="iEzsignpagePagenumber", description="The page number in the Ezsigndocument") - i_ezsignsignature_x: conint(strict=True, ge=0) = Field(..., alias="iEzsignsignatureX", description="The X coordinate (Horizontal) where to put the Ezsignsignature on the page. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsignsignature 2 inches from the left border of the page, you would use \"200\" for the X coordinate.") - i_ezsignsignature_y: conint(strict=True, ge=0) = Field(..., alias="iEzsignsignatureY", description="The Y coordinate (Vertical) where to put the Ezsignsignature on the page. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsignsignature 3 inches from the top border of the page, you would use \"300\" for the Y coordinate.") - i_ezsignsignature_width: Optional[conint(strict=True, ge=0)] = Field(None, alias="iEzsignsignatureWidth", description="The width of the Ezsignsignature. Size is calculated at 100dpi (dot per inch). So for example, if you want the Ezsignsignature to have a width of 2 inches, you would use \"200\" for the iEzsignsignatureWidth.") - i_ezsignsignature_height: Optional[conint(strict=True, ge=0)] = Field(None, alias="iEzsignsignatureHeight", description="The height of the Ezsignsignature. Size is calculated at 100dpi (dot per inch). So for example, if you want the Ezsignsignature to have an height of 2 inches, you would use \"200\" for the iEzsignsignatureHeight.") - i_ezsignsignature_step: StrictInt = Field(..., alias="iEzsignsignatureStep", description="The step when the Ezsignsigner will be invited to sign") - e_ezsignsignature_type: FieldEEzsignsignatureType = Field(..., alias="eEzsignsignatureType") - fki_ezsigndocument_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsigndocumentID", description="The unique ID of the Ezsigndocument") - t_ezsignsignature_tooltip: Optional[StrictStr] = Field(None, alias="tEzsignsignatureTooltip", description="A tooltip that will be presented to Ezsignsigner about the Ezsignsignature") - e_ezsignsignature_tooltipposition: Optional[FieldEEzsignsignatureTooltipposition] = Field(None, alias="eEzsignsignatureTooltipposition") - e_ezsignsignature_font: Optional[FieldEEzsignsignatureFont] = Field(None, alias="eEzsignsignatureFont") - fki_ezsignfoldersignerassociation_id_validation: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiEzsignfoldersignerassociationIDValidation", description="The unique ID of the Ezsignfoldersignerassociation") - b_ezsignsignature_required: Optional[StrictBool] = Field(None, alias="bEzsignsignatureRequired", description="Whether the Ezsignsignature is required or not. This field is relevant only with Ezsignsignature with eEzsignsignatureType = Attachments.") - e_ezsignsignature_attachmentnamesource: Optional[FieldEEzsignsignatureAttachmentnamesource] = Field(None, alias="eEzsignsignatureAttachmentnamesource") - s_ezsignsignature_attachmentdescription: Optional[StrictStr] = Field(None, alias="sEzsignsignatureAttachmentdescription", description="The description attached to the attachment name added in Ezsignsignature of eEzsignsignatureType Attachments") - i_ezsignsignature_validationstep: Optional[StrictInt] = Field(None, alias="iEzsignsignatureValidationstep", description="The step when the Ezsignsigner will be invited to validate the Ezsignsignature of eEzsignsignatureType Attachments") - i_ezsignsignature_maxlength: Optional[conint(strict=True, le=65535, ge=0)] = Field(None, alias="iEzsignsignatureMaxlength", description="The maximum length for the value in the Ezsignsignature This can only be set if eEzsignsignatureType is **FieldText** or **FieldTextarea**") - e_ezsignsignature_textvalidation: Optional[EnumTextvalidation] = Field(None, alias="eEzsignsignatureTextvalidation") - s_ezsignsignature_regexp: Optional[constr(strict=True)] = Field(None, alias="sEzsignsignatureRegexp", description="A regular expression to indicate what values are acceptable for the Ezsignsignature. This can only be set if eEzsignsignatureType is **FieldText** or **FieldTextarea** and eEzsignsignatureTextvalidation is **Custom**") - e_ezsignsignature_dependencyrequirement: Optional[FieldEEzsignsignatureDependencyrequirement] = Field(None, alias="eEzsignsignatureDependencyrequirement") - __properties = ["pkiEzsignsignatureID", "fkiEzsignfoldersignerassociationID", "iEzsignpagePagenumber", "iEzsignsignatureX", "iEzsignsignatureY", "iEzsignsignatureWidth", "iEzsignsignatureHeight", "iEzsignsignatureStep", "eEzsignsignatureType", "fkiEzsigndocumentID", "tEzsignsignatureTooltip", "eEzsignsignatureTooltipposition", "eEzsignsignatureFont", "fkiEzsignfoldersignerassociationIDValidation", "bEzsignsignatureRequired", "eEzsignsignatureAttachmentnamesource", "sEzsignsignatureAttachmentdescription", "iEzsignsignatureValidationstep", "iEzsignsignatureMaxlength", "eEzsignsignatureTextvalidation", "sEzsignsignatureRegexp", "eEzsignsignatureDependencyrequirement"] - - @validator('s_ezsignsignature_regexp') + An Ezsignsignature Object + """ # noqa: E501 + pki_ezsignsignature_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsignsignature", alias="pkiEzsignsignatureID") + fki_ezsignfoldersignerassociation_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsignfoldersignerassociation", alias="fkiEzsignfoldersignerassociationID") + i_ezsignpage_pagenumber: Annotated[int, Field(strict=True, ge=1)] = Field(description="The page number in the Ezsigndocument", alias="iEzsignpagePagenumber") + i_ezsignsignature_x: Annotated[int, Field(strict=True, ge=0)] = Field(description="The X coordinate (Horizontal) where to put the Ezsignsignature on the page. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsignsignature 2 inches from the left border of the page, you would use \"200\" for the X coordinate.", alias="iEzsignsignatureX") + i_ezsignsignature_y: Annotated[int, Field(strict=True, ge=0)] = Field(description="The Y coordinate (Vertical) where to put the Ezsignsignature on the page. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsignsignature 3 inches from the top border of the page, you would use \"300\" for the Y coordinate.", alias="iEzsignsignatureY") + i_ezsignsignature_width: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The width of the Ezsignsignature. Size is calculated at 100dpi (dot per inch). So for example, if you want the Ezsignsignature to have a width of 2 inches, you would use \"200\" for the iEzsignsignatureWidth.", alias="iEzsignsignatureWidth") + i_ezsignsignature_height: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The height of the Ezsignsignature. Size is calculated at 100dpi (dot per inch). So for example, if you want the Ezsignsignature to have an height of 2 inches, you would use \"200\" for the iEzsignsignatureHeight.", alias="iEzsignsignatureHeight") + i_ezsignsignature_step: StrictInt = Field(description="The step when the Ezsignsigner will be invited to sign", alias="iEzsignsignatureStep") + e_ezsignsignature_type: FieldEEzsignsignatureType = Field(alias="eEzsignsignatureType") + fki_ezsigndocument_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsigndocument", alias="fkiEzsigndocumentID") + t_ezsignsignature_tooltip: Optional[StrictStr] = Field(default=None, description="A tooltip that will be presented to Ezsignsigner about the Ezsignsignature", alias="tEzsignsignatureTooltip") + e_ezsignsignature_tooltipposition: Optional[FieldEEzsignsignatureTooltipposition] = Field(default=None, alias="eEzsignsignatureTooltipposition") + e_ezsignsignature_font: Optional[FieldEEzsignsignatureFont] = Field(default=None, alias="eEzsignsignatureFont") + fki_ezsignfoldersignerassociation_id_validation: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsignfoldersignerassociation", alias="fkiEzsignfoldersignerassociationIDValidation") + b_ezsignsignature_required: Optional[StrictBool] = Field(default=None, description="Whether the Ezsignsignature is required or not. This field is relevant only with Ezsignsignature with eEzsignsignatureType = Attachments.", alias="bEzsignsignatureRequired") + e_ezsignsignature_attachmentnamesource: Optional[FieldEEzsignsignatureAttachmentnamesource] = Field(default=None, alias="eEzsignsignatureAttachmentnamesource") + s_ezsignsignature_attachmentdescription: Optional[StrictStr] = Field(default=None, description="The description attached to the attachment name added in Ezsignsignature of eEzsignsignatureType Attachments", alias="sEzsignsignatureAttachmentdescription") + i_ezsignsignature_validationstep: Optional[StrictInt] = Field(default=None, description="The step when the Ezsignsigner will be invited to validate the Ezsignsignature of eEzsignsignatureType Attachments", alias="iEzsignsignatureValidationstep") + i_ezsignsignature_maxlength: Optional[Annotated[int, Field(le=65535, strict=True, ge=0)]] = Field(default=None, description="The maximum length for the value in the Ezsignsignature This can only be set if eEzsignsignatureType is **FieldText** or **FieldTextarea**", alias="iEzsignsignatureMaxlength") + e_ezsignsignature_textvalidation: Optional[EnumTextvalidation] = Field(default=None, alias="eEzsignsignatureTextvalidation") + s_ezsignsignature_regexp: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="A regular expression to indicate what values are acceptable for the Ezsignsignature. This can only be set if eEzsignsignatureType is **FieldText** or **FieldTextarea** and eEzsignsignatureTextvalidation is **Custom**", alias="sEzsignsignatureRegexp") + e_ezsignsignature_dependencyrequirement: Optional[FieldEEzsignsignatureDependencyrequirement] = Field(default=None, alias="eEzsignsignatureDependencyrequirement") + __properties: ClassVar[List[str]] = ["pkiEzsignsignatureID", "fkiEzsignfoldersignerassociationID", "iEzsignpagePagenumber", "iEzsignsignatureX", "iEzsignsignatureY", "iEzsignsignatureWidth", "iEzsignsignatureHeight", "iEzsignsignatureStep", "eEzsignsignatureType", "fkiEzsigndocumentID", "tEzsignsignatureTooltip", "eEzsignsignatureTooltipposition", "eEzsignsignatureFont", "fkiEzsignfoldersignerassociationIDValidation", "bEzsignsignatureRequired", "eEzsignsignatureAttachmentnamesource", "sEzsignsignatureAttachmentdescription", "iEzsignsignatureValidationstep", "iEzsignsignatureMaxlength", "eEzsignsignatureTextvalidation", "sEzsignsignatureRegexp", "eEzsignsignatureDependencyrequirement"] + + @field_validator('s_ezsignsignature_regexp') def s_ezsignsignature_regexp_validate_regular_expression(cls, value): """Validates the regular expression""" if value is None: @@ -66,64 +72,77 @@ def s_ezsignsignature_regexp_validate_regular_expression(cls, value): raise ValueError(r"must validate the regular expression /^\^.*\$$|^$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignsignatureRequest: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignsignatureRequest from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignsignatureRequest: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignsignatureRequest from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignsignatureRequest.parse_obj(obj) - - _obj = EzsignsignatureRequest.parse_obj({ - "pki_ezsignsignature_id": obj.get("pkiEzsignsignatureID"), - "fki_ezsignfoldersignerassociation_id": obj.get("fkiEzsignfoldersignerassociationID"), - "i_ezsignpage_pagenumber": obj.get("iEzsignpagePagenumber"), - "i_ezsignsignature_x": obj.get("iEzsignsignatureX"), - "i_ezsignsignature_y": obj.get("iEzsignsignatureY"), - "i_ezsignsignature_width": obj.get("iEzsignsignatureWidth"), - "i_ezsignsignature_height": obj.get("iEzsignsignatureHeight"), - "i_ezsignsignature_step": obj.get("iEzsignsignatureStep"), - "e_ezsignsignature_type": obj.get("eEzsignsignatureType"), - "fki_ezsigndocument_id": obj.get("fkiEzsigndocumentID"), - "t_ezsignsignature_tooltip": obj.get("tEzsignsignatureTooltip"), - "e_ezsignsignature_tooltipposition": obj.get("eEzsignsignatureTooltipposition"), - "e_ezsignsignature_font": obj.get("eEzsignsignatureFont"), - "fki_ezsignfoldersignerassociation_id_validation": obj.get("fkiEzsignfoldersignerassociationIDValidation"), - "b_ezsignsignature_required": obj.get("bEzsignsignatureRequired"), - "e_ezsignsignature_attachmentnamesource": obj.get("eEzsignsignatureAttachmentnamesource"), - "s_ezsignsignature_attachmentdescription": obj.get("sEzsignsignatureAttachmentdescription"), - "i_ezsignsignature_validationstep": obj.get("iEzsignsignatureValidationstep"), - "i_ezsignsignature_maxlength": obj.get("iEzsignsignatureMaxlength"), - "e_ezsignsignature_textvalidation": obj.get("eEzsignsignatureTextvalidation"), - "s_ezsignsignature_regexp": obj.get("sEzsignsignatureRegexp"), - "e_ezsignsignature_dependencyrequirement": obj.get("eEzsignsignatureDependencyrequirement") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsignsignatureID": obj.get("pkiEzsignsignatureID"), + "fkiEzsignfoldersignerassociationID": obj.get("fkiEzsignfoldersignerassociationID"), + "iEzsignpagePagenumber": obj.get("iEzsignpagePagenumber"), + "iEzsignsignatureX": obj.get("iEzsignsignatureX"), + "iEzsignsignatureY": obj.get("iEzsignsignatureY"), + "iEzsignsignatureWidth": obj.get("iEzsignsignatureWidth"), + "iEzsignsignatureHeight": obj.get("iEzsignsignatureHeight"), + "iEzsignsignatureStep": obj.get("iEzsignsignatureStep"), + "eEzsignsignatureType": obj.get("eEzsignsignatureType"), + "fkiEzsigndocumentID": obj.get("fkiEzsigndocumentID"), + "tEzsignsignatureTooltip": obj.get("tEzsignsignatureTooltip"), + "eEzsignsignatureTooltipposition": obj.get("eEzsignsignatureTooltipposition"), + "eEzsignsignatureFont": obj.get("eEzsignsignatureFont"), + "fkiEzsignfoldersignerassociationIDValidation": obj.get("fkiEzsignfoldersignerassociationIDValidation"), + "bEzsignsignatureRequired": obj.get("bEzsignsignatureRequired"), + "eEzsignsignatureAttachmentnamesource": obj.get("eEzsignsignatureAttachmentnamesource"), + "sEzsignsignatureAttachmentdescription": obj.get("sEzsignsignatureAttachmentdescription"), + "iEzsignsignatureValidationstep": obj.get("iEzsignsignatureValidationstep"), + "iEzsignsignatureMaxlength": obj.get("iEzsignsignatureMaxlength"), + "eEzsignsignatureTextvalidation": obj.get("eEzsignsignatureTextvalidation"), + "sEzsignsignatureRegexp": obj.get("sEzsignsignatureRegexp"), + "eEzsignsignatureDependencyrequirement": obj.get("eEzsignsignatureDependencyrequirement") }) return _obj diff --git a/eZmaxApi/models/ezsignsignature_request_compound.py b/eZmaxApi/models/ezsignsignature_request_compound.py index b991a24d8..a21ed91a9 100644 --- a/eZmaxApi/models/ezsignsignature_request_compound.py +++ b/eZmaxApi/models/ezsignsignature_request_compound.py @@ -19,8 +19,10 @@ import json -from typing import List, Optional -from pydantic import BaseModel, Field, StrictBool, StrictInt, StrictStr, conint, conlist, constr, validator +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, StrictInt, StrictStr, field_validator +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.enum_textvalidation import EnumTextvalidation from eZmaxApi.models.ezsignelementdependency_request_compound import EzsignelementdependencyRequestCompound from eZmaxApi.models.ezsignsignaturecustomdate_request_compound import EzsignsignaturecustomdateRequestCompound @@ -29,39 +31,43 @@ from eZmaxApi.models.field_e_ezsignsignature_font import FieldEEzsignsignatureFont from eZmaxApi.models.field_e_ezsignsignature_tooltipposition import FieldEEzsignsignatureTooltipposition from eZmaxApi.models.field_e_ezsignsignature_type import FieldEEzsignsignatureType +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignsignatureRequestCompound(BaseModel): """ - An Ezsignsignature Object and children to create a complete structure # noqa: E501 - """ - pki_ezsignsignature_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="pkiEzsignsignatureID", description="The unique ID of the Ezsignsignature") - fki_ezsignfoldersignerassociation_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsignfoldersignerassociationID", description="The unique ID of the Ezsignfoldersignerassociation") - i_ezsignpage_pagenumber: conint(strict=True, ge=1) = Field(..., alias="iEzsignpagePagenumber", description="The page number in the Ezsigndocument") - i_ezsignsignature_x: conint(strict=True, ge=0) = Field(..., alias="iEzsignsignatureX", description="The X coordinate (Horizontal) where to put the Ezsignsignature on the page. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsignsignature 2 inches from the left border of the page, you would use \"200\" for the X coordinate.") - i_ezsignsignature_y: conint(strict=True, ge=0) = Field(..., alias="iEzsignsignatureY", description="The Y coordinate (Vertical) where to put the Ezsignsignature on the page. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsignsignature 3 inches from the top border of the page, you would use \"300\" for the Y coordinate.") - i_ezsignsignature_width: Optional[conint(strict=True, ge=0)] = Field(None, alias="iEzsignsignatureWidth", description="The width of the Ezsignsignature. Size is calculated at 100dpi (dot per inch). So for example, if you want the Ezsignsignature to have a width of 2 inches, you would use \"200\" for the iEzsignsignatureWidth.") - i_ezsignsignature_height: Optional[conint(strict=True, ge=0)] = Field(None, alias="iEzsignsignatureHeight", description="The height of the Ezsignsignature. Size is calculated at 100dpi (dot per inch). So for example, if you want the Ezsignsignature to have an height of 2 inches, you would use \"200\" for the iEzsignsignatureHeight.") - i_ezsignsignature_step: StrictInt = Field(..., alias="iEzsignsignatureStep", description="The step when the Ezsignsigner will be invited to sign") - e_ezsignsignature_type: FieldEEzsignsignatureType = Field(..., alias="eEzsignsignatureType") - fki_ezsigndocument_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsigndocumentID", description="The unique ID of the Ezsigndocument") - t_ezsignsignature_tooltip: Optional[StrictStr] = Field(None, alias="tEzsignsignatureTooltip", description="A tooltip that will be presented to Ezsignsigner about the Ezsignsignature") - e_ezsignsignature_tooltipposition: Optional[FieldEEzsignsignatureTooltipposition] = Field(None, alias="eEzsignsignatureTooltipposition") - e_ezsignsignature_font: Optional[FieldEEzsignsignatureFont] = Field(None, alias="eEzsignsignatureFont") - fki_ezsignfoldersignerassociation_id_validation: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiEzsignfoldersignerassociationIDValidation", description="The unique ID of the Ezsignfoldersignerassociation") - b_ezsignsignature_required: Optional[StrictBool] = Field(None, alias="bEzsignsignatureRequired", description="Whether the Ezsignsignature is required or not. This field is relevant only with Ezsignsignature with eEzsignsignatureType = Attachments.") - e_ezsignsignature_attachmentnamesource: Optional[FieldEEzsignsignatureAttachmentnamesource] = Field(None, alias="eEzsignsignatureAttachmentnamesource") - s_ezsignsignature_attachmentdescription: Optional[StrictStr] = Field(None, alias="sEzsignsignatureAttachmentdescription", description="The description attached to the attachment name added in Ezsignsignature of eEzsignsignatureType Attachments") - i_ezsignsignature_validationstep: Optional[StrictInt] = Field(None, alias="iEzsignsignatureValidationstep", description="The step when the Ezsignsigner will be invited to validate the Ezsignsignature of eEzsignsignatureType Attachments") - i_ezsignsignature_maxlength: Optional[conint(strict=True, le=65535, ge=0)] = Field(None, alias="iEzsignsignatureMaxlength", description="The maximum length for the value in the Ezsignsignature This can only be set if eEzsignsignatureType is **FieldText** or **FieldTextarea**") - e_ezsignsignature_textvalidation: Optional[EnumTextvalidation] = Field(None, alias="eEzsignsignatureTextvalidation") - s_ezsignsignature_regexp: Optional[constr(strict=True)] = Field(None, alias="sEzsignsignatureRegexp", description="A regular expression to indicate what values are acceptable for the Ezsignsignature. This can only be set if eEzsignsignatureType is **FieldText** or **FieldTextarea** and eEzsignsignatureTextvalidation is **Custom**") - e_ezsignsignature_dependencyrequirement: Optional[FieldEEzsignsignatureDependencyrequirement] = Field(None, alias="eEzsignsignatureDependencyrequirement") - b_ezsignsignature_customdate: Optional[StrictBool] = Field(None, alias="bEzsignsignatureCustomdate", description="Whether the Ezsignsignature has a custom date format or not. (Only possible when eEzsignsignatureType is **Name** or **Handwritten**)") - a_obj_ezsignsignaturecustomdate: Optional[conlist(EzsignsignaturecustomdateRequestCompound)] = Field(None, alias="a_objEzsignsignaturecustomdate", description="An array of custom date blocks that will be filled at the time of signature. Can only be used if bEzsignsignatureCustomdate is true. Use an empty array if you don't want to have a date at all.") - a_obj_ezsignelementdependency: Optional[conlist(EzsignelementdependencyRequestCompound)] = Field(None, alias="a_objEzsignelementdependency") - __properties = ["pkiEzsignsignatureID", "fkiEzsignfoldersignerassociationID", "iEzsignpagePagenumber", "iEzsignsignatureX", "iEzsignsignatureY", "iEzsignsignatureWidth", "iEzsignsignatureHeight", "iEzsignsignatureStep", "eEzsignsignatureType", "fkiEzsigndocumentID", "tEzsignsignatureTooltip", "eEzsignsignatureTooltipposition", "eEzsignsignatureFont", "fkiEzsignfoldersignerassociationIDValidation", "bEzsignsignatureRequired", "eEzsignsignatureAttachmentnamesource", "sEzsignsignatureAttachmentdescription", "iEzsignsignatureValidationstep", "iEzsignsignatureMaxlength", "eEzsignsignatureTextvalidation", "sEzsignsignatureRegexp", "eEzsignsignatureDependencyrequirement", "bEzsignsignatureCustomdate", "a_objEzsignsignaturecustomdate", "a_objEzsignelementdependency"] - - @validator('s_ezsignsignature_regexp') + An Ezsignsignature Object and children to create a complete structure + """ # noqa: E501 + pki_ezsignsignature_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsignsignature", alias="pkiEzsignsignatureID") + fki_ezsignfoldersignerassociation_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsignfoldersignerassociation", alias="fkiEzsignfoldersignerassociationID") + i_ezsignpage_pagenumber: Annotated[int, Field(strict=True, ge=1)] = Field(description="The page number in the Ezsigndocument", alias="iEzsignpagePagenumber") + i_ezsignsignature_x: Annotated[int, Field(strict=True, ge=0)] = Field(description="The X coordinate (Horizontal) where to put the Ezsignsignature on the page. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsignsignature 2 inches from the left border of the page, you would use \"200\" for the X coordinate.", alias="iEzsignsignatureX") + i_ezsignsignature_y: Annotated[int, Field(strict=True, ge=0)] = Field(description="The Y coordinate (Vertical) where to put the Ezsignsignature on the page. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsignsignature 3 inches from the top border of the page, you would use \"300\" for the Y coordinate.", alias="iEzsignsignatureY") + i_ezsignsignature_width: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The width of the Ezsignsignature. Size is calculated at 100dpi (dot per inch). So for example, if you want the Ezsignsignature to have a width of 2 inches, you would use \"200\" for the iEzsignsignatureWidth.", alias="iEzsignsignatureWidth") + i_ezsignsignature_height: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The height of the Ezsignsignature. Size is calculated at 100dpi (dot per inch). So for example, if you want the Ezsignsignature to have an height of 2 inches, you would use \"200\" for the iEzsignsignatureHeight.", alias="iEzsignsignatureHeight") + i_ezsignsignature_step: StrictInt = Field(description="The step when the Ezsignsigner will be invited to sign", alias="iEzsignsignatureStep") + e_ezsignsignature_type: FieldEEzsignsignatureType = Field(alias="eEzsignsignatureType") + fki_ezsigndocument_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsigndocument", alias="fkiEzsigndocumentID") + t_ezsignsignature_tooltip: Optional[StrictStr] = Field(default=None, description="A tooltip that will be presented to Ezsignsigner about the Ezsignsignature", alias="tEzsignsignatureTooltip") + e_ezsignsignature_tooltipposition: Optional[FieldEEzsignsignatureTooltipposition] = Field(default=None, alias="eEzsignsignatureTooltipposition") + e_ezsignsignature_font: Optional[FieldEEzsignsignatureFont] = Field(default=None, alias="eEzsignsignatureFont") + fki_ezsignfoldersignerassociation_id_validation: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsignfoldersignerassociation", alias="fkiEzsignfoldersignerassociationIDValidation") + b_ezsignsignature_required: Optional[StrictBool] = Field(default=None, description="Whether the Ezsignsignature is required or not. This field is relevant only with Ezsignsignature with eEzsignsignatureType = Attachments.", alias="bEzsignsignatureRequired") + e_ezsignsignature_attachmentnamesource: Optional[FieldEEzsignsignatureAttachmentnamesource] = Field(default=None, alias="eEzsignsignatureAttachmentnamesource") + s_ezsignsignature_attachmentdescription: Optional[StrictStr] = Field(default=None, description="The description attached to the attachment name added in Ezsignsignature of eEzsignsignatureType Attachments", alias="sEzsignsignatureAttachmentdescription") + i_ezsignsignature_validationstep: Optional[StrictInt] = Field(default=None, description="The step when the Ezsignsigner will be invited to validate the Ezsignsignature of eEzsignsignatureType Attachments", alias="iEzsignsignatureValidationstep") + i_ezsignsignature_maxlength: Optional[Annotated[int, Field(le=65535, strict=True, ge=0)]] = Field(default=None, description="The maximum length for the value in the Ezsignsignature This can only be set if eEzsignsignatureType is **FieldText** or **FieldTextarea**", alias="iEzsignsignatureMaxlength") + e_ezsignsignature_textvalidation: Optional[EnumTextvalidation] = Field(default=None, alias="eEzsignsignatureTextvalidation") + s_ezsignsignature_regexp: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="A regular expression to indicate what values are acceptable for the Ezsignsignature. This can only be set if eEzsignsignatureType is **FieldText** or **FieldTextarea** and eEzsignsignatureTextvalidation is **Custom**", alias="sEzsignsignatureRegexp") + e_ezsignsignature_dependencyrequirement: Optional[FieldEEzsignsignatureDependencyrequirement] = Field(default=None, alias="eEzsignsignatureDependencyrequirement") + b_ezsignsignature_customdate: Optional[StrictBool] = Field(default=None, description="Whether the Ezsignsignature has a custom date format or not. (Only possible when eEzsignsignatureType is **Name** or **Handwritten**)", alias="bEzsignsignatureCustomdate") + a_obj_ezsignsignaturecustomdate: Optional[List[EzsignsignaturecustomdateRequestCompound]] = Field(default=None, description="An array of custom date blocks that will be filled at the time of signature. Can only be used if bEzsignsignatureCustomdate is true. Use an empty array if you don't want to have a date at all.", alias="a_objEzsignsignaturecustomdate") + a_obj_ezsignelementdependency: Optional[List[EzsignelementdependencyRequestCompound]] = Field(default=None, alias="a_objEzsignelementdependency") + __properties: ClassVar[List[str]] = ["pkiEzsignsignatureID", "fkiEzsignfoldersignerassociationID", "iEzsignpagePagenumber", "iEzsignsignatureX", "iEzsignsignatureY", "iEzsignsignatureWidth", "iEzsignsignatureHeight", "iEzsignsignatureStep", "eEzsignsignatureType", "fkiEzsigndocumentID", "tEzsignsignatureTooltip", "eEzsignsignatureTooltipposition", "eEzsignsignatureFont", "fkiEzsignfoldersignerassociationIDValidation", "bEzsignsignatureRequired", "eEzsignsignatureAttachmentnamesource", "sEzsignsignatureAttachmentdescription", "iEzsignsignatureValidationstep", "iEzsignsignatureMaxlength", "eEzsignsignatureTextvalidation", "sEzsignsignatureRegexp", "eEzsignsignatureDependencyrequirement", "bEzsignsignatureCustomdate", "a_objEzsignsignaturecustomdate", "a_objEzsignelementdependency"] + + @field_validator('s_ezsignsignature_regexp') def s_ezsignsignature_regexp_validate_regular_expression(cls, value): """Validates the regular expression""" if value is None: @@ -71,30 +77,43 @@ def s_ezsignsignature_regexp_validate_regular_expression(cls, value): raise ValueError(r"must validate the regular expression /^\^.*\$$|^$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignsignatureRequestCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignsignatureRequestCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_ezsignsignaturecustomdate (list) _items = [] if self.a_obj_ezsignsignaturecustomdate: @@ -112,40 +131,40 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignsignatureRequestCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignsignatureRequestCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignsignatureRequestCompound.parse_obj(obj) - - _obj = EzsignsignatureRequestCompound.parse_obj({ - "pki_ezsignsignature_id": obj.get("pkiEzsignsignatureID"), - "fki_ezsignfoldersignerassociation_id": obj.get("fkiEzsignfoldersignerassociationID"), - "i_ezsignpage_pagenumber": obj.get("iEzsignpagePagenumber"), - "i_ezsignsignature_x": obj.get("iEzsignsignatureX"), - "i_ezsignsignature_y": obj.get("iEzsignsignatureY"), - "i_ezsignsignature_width": obj.get("iEzsignsignatureWidth"), - "i_ezsignsignature_height": obj.get("iEzsignsignatureHeight"), - "i_ezsignsignature_step": obj.get("iEzsignsignatureStep"), - "e_ezsignsignature_type": obj.get("eEzsignsignatureType"), - "fki_ezsigndocument_id": obj.get("fkiEzsigndocumentID"), - "t_ezsignsignature_tooltip": obj.get("tEzsignsignatureTooltip"), - "e_ezsignsignature_tooltipposition": obj.get("eEzsignsignatureTooltipposition"), - "e_ezsignsignature_font": obj.get("eEzsignsignatureFont"), - "fki_ezsignfoldersignerassociation_id_validation": obj.get("fkiEzsignfoldersignerassociationIDValidation"), - "b_ezsignsignature_required": obj.get("bEzsignsignatureRequired"), - "e_ezsignsignature_attachmentnamesource": obj.get("eEzsignsignatureAttachmentnamesource"), - "s_ezsignsignature_attachmentdescription": obj.get("sEzsignsignatureAttachmentdescription"), - "i_ezsignsignature_validationstep": obj.get("iEzsignsignatureValidationstep"), - "i_ezsignsignature_maxlength": obj.get("iEzsignsignatureMaxlength"), - "e_ezsignsignature_textvalidation": obj.get("eEzsignsignatureTextvalidation"), - "s_ezsignsignature_regexp": obj.get("sEzsignsignatureRegexp"), - "e_ezsignsignature_dependencyrequirement": obj.get("eEzsignsignatureDependencyrequirement"), - "b_ezsignsignature_customdate": obj.get("bEzsignsignatureCustomdate"), - "a_obj_ezsignsignaturecustomdate": [EzsignsignaturecustomdateRequestCompound.from_dict(_item) for _item in obj.get("a_objEzsignsignaturecustomdate")] if obj.get("a_objEzsignsignaturecustomdate") is not None else None, - "a_obj_ezsignelementdependency": [EzsignelementdependencyRequestCompound.from_dict(_item) for _item in obj.get("a_objEzsignelementdependency")] if obj.get("a_objEzsignelementdependency") is not None else None + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsignsignatureID": obj.get("pkiEzsignsignatureID"), + "fkiEzsignfoldersignerassociationID": obj.get("fkiEzsignfoldersignerassociationID"), + "iEzsignpagePagenumber": obj.get("iEzsignpagePagenumber"), + "iEzsignsignatureX": obj.get("iEzsignsignatureX"), + "iEzsignsignatureY": obj.get("iEzsignsignatureY"), + "iEzsignsignatureWidth": obj.get("iEzsignsignatureWidth"), + "iEzsignsignatureHeight": obj.get("iEzsignsignatureHeight"), + "iEzsignsignatureStep": obj.get("iEzsignsignatureStep"), + "eEzsignsignatureType": obj.get("eEzsignsignatureType"), + "fkiEzsigndocumentID": obj.get("fkiEzsigndocumentID"), + "tEzsignsignatureTooltip": obj.get("tEzsignsignatureTooltip"), + "eEzsignsignatureTooltipposition": obj.get("eEzsignsignatureTooltipposition"), + "eEzsignsignatureFont": obj.get("eEzsignsignatureFont"), + "fkiEzsignfoldersignerassociationIDValidation": obj.get("fkiEzsignfoldersignerassociationIDValidation"), + "bEzsignsignatureRequired": obj.get("bEzsignsignatureRequired"), + "eEzsignsignatureAttachmentnamesource": obj.get("eEzsignsignatureAttachmentnamesource"), + "sEzsignsignatureAttachmentdescription": obj.get("sEzsignsignatureAttachmentdescription"), + "iEzsignsignatureValidationstep": obj.get("iEzsignsignatureValidationstep"), + "iEzsignsignatureMaxlength": obj.get("iEzsignsignatureMaxlength"), + "eEzsignsignatureTextvalidation": obj.get("eEzsignsignatureTextvalidation"), + "sEzsignsignatureRegexp": obj.get("sEzsignsignatureRegexp"), + "eEzsignsignatureDependencyrequirement": obj.get("eEzsignsignatureDependencyrequirement"), + "bEzsignsignatureCustomdate": obj.get("bEzsignsignatureCustomdate"), + "a_objEzsignsignaturecustomdate": [EzsignsignaturecustomdateRequestCompound.from_dict(_item) for _item in obj.get("a_objEzsignsignaturecustomdate")] if obj.get("a_objEzsignsignaturecustomdate") is not None else None, + "a_objEzsignelementdependency": [EzsignelementdependencyRequestCompound.from_dict(_item) for _item in obj.get("a_objEzsignelementdependency")] if obj.get("a_objEzsignelementdependency") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignsignature_response.py b/eZmaxApi/models/ezsignsignature_response.py index d8682006e..25d4cbf79 100644 --- a/eZmaxApi/models/ezsignsignature_response.py +++ b/eZmaxApi/models/ezsignsignature_response.py @@ -19,8 +19,10 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictBool, StrictInt, StrictStr, conint, constr, validator +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, StrictInt, StrictStr, field_validator +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.custom_contact_name_response import CustomContactNameResponse from eZmaxApi.models.enum_textvalidation import EnumTextvalidation from eZmaxApi.models.field_e_ezsignsignature_attachmentnamesource import FieldEEzsignsignatureAttachmentnamesource @@ -29,42 +31,58 @@ from eZmaxApi.models.field_e_ezsignsignature_tooltipposition import FieldEEzsignsignatureTooltipposition from eZmaxApi.models.field_e_ezsignsignature_type import FieldEEzsignsignatureType from eZmaxApi.models.signature_response_compound import SignatureResponseCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignsignatureResponse(BaseModel): """ - An Ezsignsignature Object # noqa: E501 - """ - pki_ezsignsignature_id: conint(strict=True, ge=0) = Field(..., alias="pkiEzsignsignatureID", description="The unique ID of the Ezsignsignature") - fki_ezsigndocument_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsigndocumentID", description="The unique ID of the Ezsigndocument") - fki_ezsignfoldersignerassociation_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsignfoldersignerassociationID", description="The unique ID of the Ezsignfoldersignerassociation") - i_ezsignpage_pagenumber: conint(strict=True, ge=1) = Field(..., alias="iEzsignpagePagenumber", description="The page number in the Ezsigndocument") - i_ezsignsignature_x: conint(strict=True, ge=0) = Field(..., alias="iEzsignsignatureX", description="The X coordinate (Horizontal) where to put the Ezsignsignature on the page. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsignsignature 2 inches from the left border of the page, you would use \"200\" for the X coordinate.") - i_ezsignsignature_y: conint(strict=True, ge=0) = Field(..., alias="iEzsignsignatureY", description="The Y coordinate (Vertical) where to put the Ezsignsignature on the page. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsignsignature 3 inches from the top border of the page, you would use \"300\" for the Y coordinate.") - i_ezsignsignature_height: Optional[conint(strict=True, ge=0)] = Field(None, alias="iEzsignsignatureHeight", description="The height of the Ezsignsignature. Size is calculated at 100dpi (dot per inch). So for example, if you want the Ezsignsignature to have an height of 2 inches, you would use \"200\" for the iEzsignsignatureHeight.") - i_ezsignsignature_width: Optional[conint(strict=True, ge=0)] = Field(None, alias="iEzsignsignatureWidth", description="The width of the Ezsignsignature. Size is calculated at 100dpi (dot per inch). So for example, if you want the Ezsignsignature to have a width of 2 inches, you would use \"200\" for the iEzsignsignatureWidth.") - i_ezsignsignature_step: StrictInt = Field(..., alias="iEzsignsignatureStep", description="The step when the Ezsignsigner will be invited to sign") - e_ezsignsignature_type: FieldEEzsignsignatureType = Field(..., alias="eEzsignsignatureType") - t_ezsignsignature_tooltip: Optional[StrictStr] = Field(None, alias="tEzsignsignatureTooltip", description="A tooltip that will be presented to Ezsignsigner about the Ezsignsignature") - e_ezsignsignature_tooltipposition: Optional[FieldEEzsignsignatureTooltipposition] = Field(None, alias="eEzsignsignatureTooltipposition") - e_ezsignsignature_font: Optional[FieldEEzsignsignatureFont] = Field(None, alias="eEzsignsignatureFont") - i_ezsignsignature_validationstep: Optional[StrictInt] = Field(None, alias="iEzsignsignatureValidationstep", description="The step when the Ezsignsigner will be invited to validate the Ezsignsignature of eEzsignsignatureType Attachments") - s_ezsignsignature_attachmentdescription: Optional[StrictStr] = Field(None, alias="sEzsignsignatureAttachmentdescription", description="The description attached to the attachment name added in Ezsignsignature of eEzsignsignatureType Attachments") - e_ezsignsignature_attachmentnamesource: Optional[FieldEEzsignsignatureAttachmentnamesource] = Field(None, alias="eEzsignsignatureAttachmentnamesource") - b_ezsignsignature_required: Optional[StrictBool] = Field(None, alias="bEzsignsignatureRequired", description="Whether the Ezsignsignature is required or not. This field is relevant only with Ezsignsignature with eEzsignsignatureType = Attachments.") - fki_ezsignfoldersignerassociation_id_validation: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiEzsignfoldersignerassociationIDValidation", description="The unique ID of the Ezsignfoldersignerassociation") - dt_ezsignsignature_date: Optional[constr(strict=True)] = Field(None, alias="dtEzsignsignatureDate", description="The date the Ezsignsignature was signed") - i_ezsignsignatureattachment_count: Optional[StrictInt] = Field(None, alias="iEzsignsignatureattachmentCount", description="The count of Ezsignsignatureattachment") - s_ezsignsignature_description: Optional[StrictStr] = Field(None, alias="sEzsignsignatureDescription", description="The value entered while signing Ezsignsignature of eEzsignsignatureType **City**, **FieldText** and **FieldTextarea**") - i_ezsignsignature_maxlength: Optional[conint(strict=True, le=65535, ge=0)] = Field(None, alias="iEzsignsignatureMaxlength", description="The maximum length for the value in the Ezsignsignature This can only be set if eEzsignsignatureType is **FieldText** or **FieldTextarea**") - e_ezsignsignature_textvalidation: Optional[EnumTextvalidation] = Field(None, alias="eEzsignsignatureTextvalidation") - e_ezsignsignature_dependencyrequirement: Optional[FieldEEzsignsignatureDependencyrequirement] = Field(None, alias="eEzsignsignatureDependencyrequirement") - s_ezsignsignature_regexp: Optional[constr(strict=True)] = Field(None, alias="sEzsignsignatureRegexp", description="A regular expression to indicate what values are acceptable for the Ezsignsignature. This can only be set if eEzsignsignatureType is **FieldText** or **FieldTextarea** and eEzsignsignatureTextvalidation is **Custom**") - obj_contact_name: CustomContactNameResponse = Field(..., alias="objContactName") - obj_contact_name_delegation: Optional[CustomContactNameResponse] = Field(None, alias="objContactNameDelegation") - obj_signature: Optional[SignatureResponseCompound] = Field(None, alias="objSignature") - __properties = ["pkiEzsignsignatureID", "fkiEzsigndocumentID", "fkiEzsignfoldersignerassociationID", "iEzsignpagePagenumber", "iEzsignsignatureX", "iEzsignsignatureY", "iEzsignsignatureHeight", "iEzsignsignatureWidth", "iEzsignsignatureStep", "eEzsignsignatureType", "tEzsignsignatureTooltip", "eEzsignsignatureTooltipposition", "eEzsignsignatureFont", "iEzsignsignatureValidationstep", "sEzsignsignatureAttachmentdescription", "eEzsignsignatureAttachmentnamesource", "bEzsignsignatureRequired", "fkiEzsignfoldersignerassociationIDValidation", "dtEzsignsignatureDate", "iEzsignsignatureattachmentCount", "sEzsignsignatureDescription", "iEzsignsignatureMaxlength", "eEzsignsignatureTextvalidation", "eEzsignsignatureDependencyrequirement", "sEzsignsignatureRegexp", "objContactName", "objContactNameDelegation", "objSignature"] - - @validator('dt_ezsignsignature_date') + An Ezsignsignature Object + """ # noqa: E501 + pki_ezsignsignature_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsignsignature", alias="pkiEzsignsignatureID") + fki_ezsigndocument_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsigndocument", alias="fkiEzsigndocumentID") + fki_ezsignfoldersignerassociation_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsignfoldersignerassociation", alias="fkiEzsignfoldersignerassociationID") + fki_ezsignsigningreason_id: Optional[Annotated[int, Field(le=255, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsignsigningreason", alias="fkiEzsignsigningreasonID") + s_ezsignsigningreason_description_x: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="The description of the Ezsignsigningreason in the language of the requester", alias="sEzsignsigningreasonDescriptionX") + i_ezsignpage_pagenumber: Annotated[int, Field(strict=True, ge=1)] = Field(description="The page number in the Ezsigndocument", alias="iEzsignpagePagenumber") + i_ezsignsignature_x: Annotated[int, Field(strict=True, ge=0)] = Field(description="The X coordinate (Horizontal) where to put the Ezsignsignature on the page. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsignsignature 2 inches from the left border of the page, you would use \"200\" for the X coordinate.", alias="iEzsignsignatureX") + i_ezsignsignature_y: Annotated[int, Field(strict=True, ge=0)] = Field(description="The Y coordinate (Vertical) where to put the Ezsignsignature on the page. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsignsignature 3 inches from the top border of the page, you would use \"300\" for the Y coordinate.", alias="iEzsignsignatureY") + i_ezsignsignature_height: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The height of the Ezsignsignature. Size is calculated at 100dpi (dot per inch). So for example, if you want the Ezsignsignature to have an height of 2 inches, you would use \"200\" for the iEzsignsignatureHeight.", alias="iEzsignsignatureHeight") + i_ezsignsignature_width: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The width of the Ezsignsignature. Size is calculated at 100dpi (dot per inch). So for example, if you want the Ezsignsignature to have a width of 2 inches, you would use \"200\" for the iEzsignsignatureWidth.", alias="iEzsignsignatureWidth") + i_ezsignsignature_step: StrictInt = Field(description="The step when the Ezsignsigner will be invited to sign", alias="iEzsignsignatureStep") + e_ezsignsignature_type: FieldEEzsignsignatureType = Field(alias="eEzsignsignatureType") + t_ezsignsignature_tooltip: Optional[StrictStr] = Field(default=None, description="A tooltip that will be presented to Ezsignsigner about the Ezsignsignature", alias="tEzsignsignatureTooltip") + e_ezsignsignature_tooltipposition: Optional[FieldEEzsignsignatureTooltipposition] = Field(default=None, alias="eEzsignsignatureTooltipposition") + e_ezsignsignature_font: Optional[FieldEEzsignsignatureFont] = Field(default=None, alias="eEzsignsignatureFont") + i_ezsignsignature_validationstep: Optional[StrictInt] = Field(default=None, description="The step when the Ezsignsigner will be invited to validate the Ezsignsignature of eEzsignsignatureType Attachments", alias="iEzsignsignatureValidationstep") + s_ezsignsignature_attachmentdescription: Optional[StrictStr] = Field(default=None, description="The description attached to the attachment name added in Ezsignsignature of eEzsignsignatureType Attachments", alias="sEzsignsignatureAttachmentdescription") + e_ezsignsignature_attachmentnamesource: Optional[FieldEEzsignsignatureAttachmentnamesource] = Field(default=None, alias="eEzsignsignatureAttachmentnamesource") + b_ezsignsignature_required: Optional[StrictBool] = Field(default=None, description="Whether the Ezsignsignature is required or not. This field is relevant only with Ezsignsignature with eEzsignsignatureType = Attachments.", alias="bEzsignsignatureRequired") + fki_ezsignfoldersignerassociation_id_validation: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsignfoldersignerassociation", alias="fkiEzsignfoldersignerassociationIDValidation") + dt_ezsignsignature_date: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="The date the Ezsignsignature was signed", alias="dtEzsignsignatureDate") + i_ezsignsignatureattachment_count: Optional[StrictInt] = Field(default=None, description="The count of Ezsignsignatureattachment", alias="iEzsignsignatureattachmentCount") + s_ezsignsignature_description: Optional[StrictStr] = Field(default=None, description="The value entered while signing Ezsignsignature of eEzsignsignatureType **City**, **FieldText** and **FieldTextarea**", alias="sEzsignsignatureDescription") + i_ezsignsignature_maxlength: Optional[Annotated[int, Field(le=65535, strict=True, ge=0)]] = Field(default=None, description="The maximum length for the value in the Ezsignsignature This can only be set if eEzsignsignatureType is **FieldText** or **FieldTextarea**", alias="iEzsignsignatureMaxlength") + e_ezsignsignature_textvalidation: Optional[EnumTextvalidation] = Field(default=None, alias="eEzsignsignatureTextvalidation") + e_ezsignsignature_dependencyrequirement: Optional[FieldEEzsignsignatureDependencyrequirement] = Field(default=None, alias="eEzsignsignatureDependencyrequirement") + s_ezsignsignature_regexp: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="A regular expression to indicate what values are acceptable for the Ezsignsignature. This can only be set if eEzsignsignatureType is **FieldText** or **FieldTextarea** and eEzsignsignatureTextvalidation is **Custom**", alias="sEzsignsignatureRegexp") + obj_contact_name: CustomContactNameResponse = Field(alias="objContactName") + obj_contact_name_delegation: Optional[CustomContactNameResponse] = Field(default=None, alias="objContactNameDelegation") + obj_signature: Optional[SignatureResponseCompound] = Field(default=None, alias="objSignature") + __properties: ClassVar[List[str]] = ["pkiEzsignsignatureID", "fkiEzsigndocumentID", "fkiEzsignfoldersignerassociationID", "fkiEzsignsigningreasonID", "sEzsignsigningreasonDescriptionX", "iEzsignpagePagenumber", "iEzsignsignatureX", "iEzsignsignatureY", "iEzsignsignatureHeight", "iEzsignsignatureWidth", "iEzsignsignatureStep", "eEzsignsignatureType", "tEzsignsignatureTooltip", "eEzsignsignatureTooltipposition", "eEzsignsignatureFont", "iEzsignsignatureValidationstep", "sEzsignsignatureAttachmentdescription", "eEzsignsignatureAttachmentnamesource", "bEzsignsignatureRequired", "fkiEzsignfoldersignerassociationIDValidation", "dtEzsignsignatureDate", "iEzsignsignatureattachmentCount", "sEzsignsignatureDescription", "iEzsignsignatureMaxlength", "eEzsignsignatureTextvalidation", "eEzsignsignatureDependencyrequirement", "sEzsignsignatureRegexp", "objContactName", "objContactNameDelegation", "objSignature"] + + @field_validator('s_ezsignsigningreason_description_x') + def s_ezsignsigningreason_description_x_validate_regular_expression(cls, value): + """Validates the regular expression""" + if value is None: + return value + + if not re.match(r"^.{0,50}$", value): + raise ValueError(r"must validate the regular expression /^.{0,50}$/") + return value + + @field_validator('dt_ezsignsignature_date') def dt_ezsignsignature_date_validate_regular_expression(cls, value): """Validates the regular expression""" if value is None: @@ -74,7 +92,7 @@ def dt_ezsignsignature_date_validate_regular_expression(cls, value): raise ValueError(r"must validate the regular expression /^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1]) ([01]?[0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9])$/") return value - @validator('s_ezsignsignature_regexp') + @field_validator('s_ezsignsignature_regexp') def s_ezsignsignature_regexp_validate_regular_expression(cls, value): """Validates the regular expression""" if value is None: @@ -84,30 +102,43 @@ def s_ezsignsignature_regexp_validate_regular_expression(cls, value): raise ValueError(r"must validate the regular expression /^\^.*\$$|^$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignsignatureResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignsignatureResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_contact_name if self.obj_contact_name: _dict['objContactName'] = self.obj_contact_name.to_dict() @@ -120,43 +151,45 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignsignatureResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignsignatureResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignsignatureResponse.parse_obj(obj) - - _obj = EzsignsignatureResponse.parse_obj({ - "pki_ezsignsignature_id": obj.get("pkiEzsignsignatureID"), - "fki_ezsigndocument_id": obj.get("fkiEzsigndocumentID"), - "fki_ezsignfoldersignerassociation_id": obj.get("fkiEzsignfoldersignerassociationID"), - "i_ezsignpage_pagenumber": obj.get("iEzsignpagePagenumber"), - "i_ezsignsignature_x": obj.get("iEzsignsignatureX"), - "i_ezsignsignature_y": obj.get("iEzsignsignatureY"), - "i_ezsignsignature_height": obj.get("iEzsignsignatureHeight"), - "i_ezsignsignature_width": obj.get("iEzsignsignatureWidth"), - "i_ezsignsignature_step": obj.get("iEzsignsignatureStep"), - "e_ezsignsignature_type": obj.get("eEzsignsignatureType"), - "t_ezsignsignature_tooltip": obj.get("tEzsignsignatureTooltip"), - "e_ezsignsignature_tooltipposition": obj.get("eEzsignsignatureTooltipposition"), - "e_ezsignsignature_font": obj.get("eEzsignsignatureFont"), - "i_ezsignsignature_validationstep": obj.get("iEzsignsignatureValidationstep"), - "s_ezsignsignature_attachmentdescription": obj.get("sEzsignsignatureAttachmentdescription"), - "e_ezsignsignature_attachmentnamesource": obj.get("eEzsignsignatureAttachmentnamesource"), - "b_ezsignsignature_required": obj.get("bEzsignsignatureRequired"), - "fki_ezsignfoldersignerassociation_id_validation": obj.get("fkiEzsignfoldersignerassociationIDValidation"), - "dt_ezsignsignature_date": obj.get("dtEzsignsignatureDate"), - "i_ezsignsignatureattachment_count": obj.get("iEzsignsignatureattachmentCount"), - "s_ezsignsignature_description": obj.get("sEzsignsignatureDescription"), - "i_ezsignsignature_maxlength": obj.get("iEzsignsignatureMaxlength"), - "e_ezsignsignature_textvalidation": obj.get("eEzsignsignatureTextvalidation"), - "e_ezsignsignature_dependencyrequirement": obj.get("eEzsignsignatureDependencyrequirement"), - "s_ezsignsignature_regexp": obj.get("sEzsignsignatureRegexp"), - "obj_contact_name": CustomContactNameResponse.from_dict(obj.get("objContactName")) if obj.get("objContactName") is not None else None, - "obj_contact_name_delegation": CustomContactNameResponse.from_dict(obj.get("objContactNameDelegation")) if obj.get("objContactNameDelegation") is not None else None, - "obj_signature": SignatureResponseCompound.from_dict(obj.get("objSignature")) if obj.get("objSignature") is not None else None + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsignsignatureID": obj.get("pkiEzsignsignatureID"), + "fkiEzsigndocumentID": obj.get("fkiEzsigndocumentID"), + "fkiEzsignfoldersignerassociationID": obj.get("fkiEzsignfoldersignerassociationID"), + "fkiEzsignsigningreasonID": obj.get("fkiEzsignsigningreasonID"), + "sEzsignsigningreasonDescriptionX": obj.get("sEzsignsigningreasonDescriptionX"), + "iEzsignpagePagenumber": obj.get("iEzsignpagePagenumber"), + "iEzsignsignatureX": obj.get("iEzsignsignatureX"), + "iEzsignsignatureY": obj.get("iEzsignsignatureY"), + "iEzsignsignatureHeight": obj.get("iEzsignsignatureHeight"), + "iEzsignsignatureWidth": obj.get("iEzsignsignatureWidth"), + "iEzsignsignatureStep": obj.get("iEzsignsignatureStep"), + "eEzsignsignatureType": obj.get("eEzsignsignatureType"), + "tEzsignsignatureTooltip": obj.get("tEzsignsignatureTooltip"), + "eEzsignsignatureTooltipposition": obj.get("eEzsignsignatureTooltipposition"), + "eEzsignsignatureFont": obj.get("eEzsignsignatureFont"), + "iEzsignsignatureValidationstep": obj.get("iEzsignsignatureValidationstep"), + "sEzsignsignatureAttachmentdescription": obj.get("sEzsignsignatureAttachmentdescription"), + "eEzsignsignatureAttachmentnamesource": obj.get("eEzsignsignatureAttachmentnamesource"), + "bEzsignsignatureRequired": obj.get("bEzsignsignatureRequired"), + "fkiEzsignfoldersignerassociationIDValidation": obj.get("fkiEzsignfoldersignerassociationIDValidation"), + "dtEzsignsignatureDate": obj.get("dtEzsignsignatureDate"), + "iEzsignsignatureattachmentCount": obj.get("iEzsignsignatureattachmentCount"), + "sEzsignsignatureDescription": obj.get("sEzsignsignatureDescription"), + "iEzsignsignatureMaxlength": obj.get("iEzsignsignatureMaxlength"), + "eEzsignsignatureTextvalidation": obj.get("eEzsignsignatureTextvalidation"), + "eEzsignsignatureDependencyrequirement": obj.get("eEzsignsignatureDependencyrequirement"), + "sEzsignsignatureRegexp": obj.get("sEzsignsignatureRegexp"), + "objContactName": CustomContactNameResponse.from_dict(obj.get("objContactName")) if obj.get("objContactName") is not None else None, + "objContactNameDelegation": CustomContactNameResponse.from_dict(obj.get("objContactNameDelegation")) if obj.get("objContactNameDelegation") is not None else None, + "objSignature": SignatureResponseCompound.from_dict(obj.get("objSignature")) if obj.get("objSignature") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignsignature_response_compound.py b/eZmaxApi/models/ezsignsignature_response_compound.py index c134ce8ea..7d3724572 100644 --- a/eZmaxApi/models/ezsignsignature_response_compound.py +++ b/eZmaxApi/models/ezsignsignature_response_compound.py @@ -19,8 +19,10 @@ import json -from typing import List, Optional -from pydantic import BaseModel, Field, StrictBool, StrictInt, StrictStr, conint, conlist, constr, validator +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, StrictInt, StrictStr, field_validator +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.custom_contact_name_response import CustomContactNameResponse from eZmaxApi.models.custom_creditcardtransaction_response import CustomCreditcardtransactionResponse from eZmaxApi.models.enum_textvalidation import EnumTextvalidation @@ -32,46 +34,62 @@ from eZmaxApi.models.field_e_ezsignsignature_tooltipposition import FieldEEzsignsignatureTooltipposition from eZmaxApi.models.field_e_ezsignsignature_type import FieldEEzsignsignatureType from eZmaxApi.models.signature_response_compound import SignatureResponseCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignsignatureResponseCompound(BaseModel): """ - An Ezsignsignature Object and children to create a complete structure # noqa: E501 - """ - pki_ezsignsignature_id: conint(strict=True, ge=0) = Field(..., alias="pkiEzsignsignatureID", description="The unique ID of the Ezsignsignature") - fki_ezsigndocument_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsigndocumentID", description="The unique ID of the Ezsigndocument") - fki_ezsignfoldersignerassociation_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsignfoldersignerassociationID", description="The unique ID of the Ezsignfoldersignerassociation") - i_ezsignpage_pagenumber: conint(strict=True, ge=1) = Field(..., alias="iEzsignpagePagenumber", description="The page number in the Ezsigndocument") - i_ezsignsignature_x: conint(strict=True, ge=0) = Field(..., alias="iEzsignsignatureX", description="The X coordinate (Horizontal) where to put the Ezsignsignature on the page. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsignsignature 2 inches from the left border of the page, you would use \"200\" for the X coordinate.") - i_ezsignsignature_y: conint(strict=True, ge=0) = Field(..., alias="iEzsignsignatureY", description="The Y coordinate (Vertical) where to put the Ezsignsignature on the page. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsignsignature 3 inches from the top border of the page, you would use \"300\" for the Y coordinate.") - i_ezsignsignature_height: Optional[conint(strict=True, ge=0)] = Field(None, alias="iEzsignsignatureHeight", description="The height of the Ezsignsignature. Size is calculated at 100dpi (dot per inch). So for example, if you want the Ezsignsignature to have an height of 2 inches, you would use \"200\" for the iEzsignsignatureHeight.") - i_ezsignsignature_width: Optional[conint(strict=True, ge=0)] = Field(None, alias="iEzsignsignatureWidth", description="The width of the Ezsignsignature. Size is calculated at 100dpi (dot per inch). So for example, if you want the Ezsignsignature to have a width of 2 inches, you would use \"200\" for the iEzsignsignatureWidth.") - i_ezsignsignature_step: StrictInt = Field(..., alias="iEzsignsignatureStep", description="The step when the Ezsignsigner will be invited to sign") - e_ezsignsignature_type: FieldEEzsignsignatureType = Field(..., alias="eEzsignsignatureType") - t_ezsignsignature_tooltip: Optional[StrictStr] = Field(None, alias="tEzsignsignatureTooltip", description="A tooltip that will be presented to Ezsignsigner about the Ezsignsignature") - e_ezsignsignature_tooltipposition: Optional[FieldEEzsignsignatureTooltipposition] = Field(None, alias="eEzsignsignatureTooltipposition") - e_ezsignsignature_font: Optional[FieldEEzsignsignatureFont] = Field(None, alias="eEzsignsignatureFont") - i_ezsignsignature_validationstep: Optional[StrictInt] = Field(None, alias="iEzsignsignatureValidationstep", description="The step when the Ezsignsigner will be invited to validate the Ezsignsignature of eEzsignsignatureType Attachments") - s_ezsignsignature_attachmentdescription: Optional[StrictStr] = Field(None, alias="sEzsignsignatureAttachmentdescription", description="The description attached to the attachment name added in Ezsignsignature of eEzsignsignatureType Attachments") - e_ezsignsignature_attachmentnamesource: Optional[FieldEEzsignsignatureAttachmentnamesource] = Field(None, alias="eEzsignsignatureAttachmentnamesource") - b_ezsignsignature_required: Optional[StrictBool] = Field(None, alias="bEzsignsignatureRequired", description="Whether the Ezsignsignature is required or not. This field is relevant only with Ezsignsignature with eEzsignsignatureType = Attachments.") - fki_ezsignfoldersignerassociation_id_validation: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiEzsignfoldersignerassociationIDValidation", description="The unique ID of the Ezsignfoldersignerassociation") - dt_ezsignsignature_date: Optional[constr(strict=True)] = Field(None, alias="dtEzsignsignatureDate", description="The date the Ezsignsignature was signed") - i_ezsignsignatureattachment_count: Optional[StrictInt] = Field(None, alias="iEzsignsignatureattachmentCount", description="The count of Ezsignsignatureattachment") - s_ezsignsignature_description: Optional[StrictStr] = Field(None, alias="sEzsignsignatureDescription", description="The value entered while signing Ezsignsignature of eEzsignsignatureType **City**, **FieldText** and **FieldTextarea**") - i_ezsignsignature_maxlength: Optional[conint(strict=True, le=65535, ge=0)] = Field(None, alias="iEzsignsignatureMaxlength", description="The maximum length for the value in the Ezsignsignature This can only be set if eEzsignsignatureType is **FieldText** or **FieldTextarea**") - e_ezsignsignature_textvalidation: Optional[EnumTextvalidation] = Field(None, alias="eEzsignsignatureTextvalidation") - e_ezsignsignature_dependencyrequirement: Optional[FieldEEzsignsignatureDependencyrequirement] = Field(None, alias="eEzsignsignatureDependencyrequirement") - s_ezsignsignature_regexp: Optional[constr(strict=True)] = Field(None, alias="sEzsignsignatureRegexp", description="A regular expression to indicate what values are acceptable for the Ezsignsignature. This can only be set if eEzsignsignatureType is **FieldText** or **FieldTextarea** and eEzsignsignatureTextvalidation is **Custom**") - obj_contact_name: CustomContactNameResponse = Field(..., alias="objContactName") - obj_contact_name_delegation: Optional[CustomContactNameResponse] = Field(None, alias="objContactNameDelegation") - obj_signature: Optional[SignatureResponseCompound] = Field(None, alias="objSignature") - b_ezsignsignature_customdate: Optional[StrictBool] = Field(None, alias="bEzsignsignatureCustomdate", description="Whether the Ezsignsignature has a custom date format or not. (Only possible when eEzsignsignatureType is **Name** or **Handwritten**)") - a_obj_ezsignsignaturecustomdate: Optional[conlist(EzsignsignaturecustomdateResponseCompound)] = Field(None, alias="a_objEzsignsignaturecustomdate", description="An array of custom date blocks that will be filled at the time of signature. Can only be used if bEzsignsignatureCustomdate is true. Use an empty array if you don't want to have a date at all.") - obj_creditcardtransaction: Optional[CustomCreditcardtransactionResponse] = Field(None, alias="objCreditcardtransaction") - a_obj_ezsignelementdependency: Optional[conlist(EzsignelementdependencyResponseCompound)] = Field(None, alias="a_objEzsignelementdependency") - __properties = ["pkiEzsignsignatureID", "fkiEzsigndocumentID", "fkiEzsignfoldersignerassociationID", "iEzsignpagePagenumber", "iEzsignsignatureX", "iEzsignsignatureY", "iEzsignsignatureHeight", "iEzsignsignatureWidth", "iEzsignsignatureStep", "eEzsignsignatureType", "tEzsignsignatureTooltip", "eEzsignsignatureTooltipposition", "eEzsignsignatureFont", "iEzsignsignatureValidationstep", "sEzsignsignatureAttachmentdescription", "eEzsignsignatureAttachmentnamesource", "bEzsignsignatureRequired", "fkiEzsignfoldersignerassociationIDValidation", "dtEzsignsignatureDate", "iEzsignsignatureattachmentCount", "sEzsignsignatureDescription", "iEzsignsignatureMaxlength", "eEzsignsignatureTextvalidation", "eEzsignsignatureDependencyrequirement", "sEzsignsignatureRegexp", "objContactName", "objContactNameDelegation", "objSignature", "bEzsignsignatureCustomdate", "a_objEzsignsignaturecustomdate", "objCreditcardtransaction", "a_objEzsignelementdependency"] - - @validator('dt_ezsignsignature_date') + An Ezsignsignature Object and children to create a complete structure + """ # noqa: E501 + pki_ezsignsignature_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsignsignature", alias="pkiEzsignsignatureID") + fki_ezsigndocument_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsigndocument", alias="fkiEzsigndocumentID") + fki_ezsignfoldersignerassociation_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsignfoldersignerassociation", alias="fkiEzsignfoldersignerassociationID") + fki_ezsignsigningreason_id: Optional[Annotated[int, Field(le=255, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsignsigningreason", alias="fkiEzsignsigningreasonID") + s_ezsignsigningreason_description_x: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="The description of the Ezsignsigningreason in the language of the requester", alias="sEzsignsigningreasonDescriptionX") + i_ezsignpage_pagenumber: Annotated[int, Field(strict=True, ge=1)] = Field(description="The page number in the Ezsigndocument", alias="iEzsignpagePagenumber") + i_ezsignsignature_x: Annotated[int, Field(strict=True, ge=0)] = Field(description="The X coordinate (Horizontal) where to put the Ezsignsignature on the page. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsignsignature 2 inches from the left border of the page, you would use \"200\" for the X coordinate.", alias="iEzsignsignatureX") + i_ezsignsignature_y: Annotated[int, Field(strict=True, ge=0)] = Field(description="The Y coordinate (Vertical) where to put the Ezsignsignature on the page. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsignsignature 3 inches from the top border of the page, you would use \"300\" for the Y coordinate.", alias="iEzsignsignatureY") + i_ezsignsignature_height: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The height of the Ezsignsignature. Size is calculated at 100dpi (dot per inch). So for example, if you want the Ezsignsignature to have an height of 2 inches, you would use \"200\" for the iEzsignsignatureHeight.", alias="iEzsignsignatureHeight") + i_ezsignsignature_width: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The width of the Ezsignsignature. Size is calculated at 100dpi (dot per inch). So for example, if you want the Ezsignsignature to have a width of 2 inches, you would use \"200\" for the iEzsignsignatureWidth.", alias="iEzsignsignatureWidth") + i_ezsignsignature_step: StrictInt = Field(description="The step when the Ezsignsigner will be invited to sign", alias="iEzsignsignatureStep") + e_ezsignsignature_type: FieldEEzsignsignatureType = Field(alias="eEzsignsignatureType") + t_ezsignsignature_tooltip: Optional[StrictStr] = Field(default=None, description="A tooltip that will be presented to Ezsignsigner about the Ezsignsignature", alias="tEzsignsignatureTooltip") + e_ezsignsignature_tooltipposition: Optional[FieldEEzsignsignatureTooltipposition] = Field(default=None, alias="eEzsignsignatureTooltipposition") + e_ezsignsignature_font: Optional[FieldEEzsignsignatureFont] = Field(default=None, alias="eEzsignsignatureFont") + i_ezsignsignature_validationstep: Optional[StrictInt] = Field(default=None, description="The step when the Ezsignsigner will be invited to validate the Ezsignsignature of eEzsignsignatureType Attachments", alias="iEzsignsignatureValidationstep") + s_ezsignsignature_attachmentdescription: Optional[StrictStr] = Field(default=None, description="The description attached to the attachment name added in Ezsignsignature of eEzsignsignatureType Attachments", alias="sEzsignsignatureAttachmentdescription") + e_ezsignsignature_attachmentnamesource: Optional[FieldEEzsignsignatureAttachmentnamesource] = Field(default=None, alias="eEzsignsignatureAttachmentnamesource") + b_ezsignsignature_required: Optional[StrictBool] = Field(default=None, description="Whether the Ezsignsignature is required or not. This field is relevant only with Ezsignsignature with eEzsignsignatureType = Attachments.", alias="bEzsignsignatureRequired") + fki_ezsignfoldersignerassociation_id_validation: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsignfoldersignerassociation", alias="fkiEzsignfoldersignerassociationIDValidation") + dt_ezsignsignature_date: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="The date the Ezsignsignature was signed", alias="dtEzsignsignatureDate") + i_ezsignsignatureattachment_count: Optional[StrictInt] = Field(default=None, description="The count of Ezsignsignatureattachment", alias="iEzsignsignatureattachmentCount") + s_ezsignsignature_description: Optional[StrictStr] = Field(default=None, description="The value entered while signing Ezsignsignature of eEzsignsignatureType **City**, **FieldText** and **FieldTextarea**", alias="sEzsignsignatureDescription") + i_ezsignsignature_maxlength: Optional[Annotated[int, Field(le=65535, strict=True, ge=0)]] = Field(default=None, description="The maximum length for the value in the Ezsignsignature This can only be set if eEzsignsignatureType is **FieldText** or **FieldTextarea**", alias="iEzsignsignatureMaxlength") + e_ezsignsignature_textvalidation: Optional[EnumTextvalidation] = Field(default=None, alias="eEzsignsignatureTextvalidation") + e_ezsignsignature_dependencyrequirement: Optional[FieldEEzsignsignatureDependencyrequirement] = Field(default=None, alias="eEzsignsignatureDependencyrequirement") + s_ezsignsignature_regexp: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="A regular expression to indicate what values are acceptable for the Ezsignsignature. This can only be set if eEzsignsignatureType is **FieldText** or **FieldTextarea** and eEzsignsignatureTextvalidation is **Custom**", alias="sEzsignsignatureRegexp") + obj_contact_name: CustomContactNameResponse = Field(alias="objContactName") + obj_contact_name_delegation: Optional[CustomContactNameResponse] = Field(default=None, alias="objContactNameDelegation") + obj_signature: Optional[SignatureResponseCompound] = Field(default=None, alias="objSignature") + b_ezsignsignature_customdate: Optional[StrictBool] = Field(default=None, description="Whether the Ezsignsignature has a custom date format or not. (Only possible when eEzsignsignatureType is **Name** or **Handwritten**)", alias="bEzsignsignatureCustomdate") + a_obj_ezsignsignaturecustomdate: Optional[List[EzsignsignaturecustomdateResponseCompound]] = Field(default=None, description="An array of custom date blocks that will be filled at the time of signature. Can only be used if bEzsignsignatureCustomdate is true. Use an empty array if you don't want to have a date at all.", alias="a_objEzsignsignaturecustomdate") + obj_creditcardtransaction: Optional[CustomCreditcardtransactionResponse] = Field(default=None, alias="objCreditcardtransaction") + a_obj_ezsignelementdependency: Optional[List[EzsignelementdependencyResponseCompound]] = Field(default=None, alias="a_objEzsignelementdependency") + __properties: ClassVar[List[str]] = ["pkiEzsignsignatureID", "fkiEzsigndocumentID", "fkiEzsignfoldersignerassociationID", "fkiEzsignsigningreasonID", "sEzsignsigningreasonDescriptionX", "iEzsignpagePagenumber", "iEzsignsignatureX", "iEzsignsignatureY", "iEzsignsignatureHeight", "iEzsignsignatureWidth", "iEzsignsignatureStep", "eEzsignsignatureType", "tEzsignsignatureTooltip", "eEzsignsignatureTooltipposition", "eEzsignsignatureFont", "iEzsignsignatureValidationstep", "sEzsignsignatureAttachmentdescription", "eEzsignsignatureAttachmentnamesource", "bEzsignsignatureRequired", "fkiEzsignfoldersignerassociationIDValidation", "dtEzsignsignatureDate", "iEzsignsignatureattachmentCount", "sEzsignsignatureDescription", "iEzsignsignatureMaxlength", "eEzsignsignatureTextvalidation", "eEzsignsignatureDependencyrequirement", "sEzsignsignatureRegexp", "objContactName", "objContactNameDelegation", "objSignature", "bEzsignsignatureCustomdate", "a_objEzsignsignaturecustomdate", "objCreditcardtransaction", "a_objEzsignelementdependency"] + + @field_validator('s_ezsignsigningreason_description_x') + def s_ezsignsigningreason_description_x_validate_regular_expression(cls, value): + """Validates the regular expression""" + if value is None: + return value + + if not re.match(r"^.{0,50}$", value): + raise ValueError(r"must validate the regular expression /^.{0,50}$/") + return value + + @field_validator('dt_ezsignsignature_date') def dt_ezsignsignature_date_validate_regular_expression(cls, value): """Validates the regular expression""" if value is None: @@ -81,7 +99,7 @@ def dt_ezsignsignature_date_validate_regular_expression(cls, value): raise ValueError(r"must validate the regular expression /^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1]) ([01]?[0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9])$/") return value - @validator('s_ezsignsignature_regexp') + @field_validator('s_ezsignsignature_regexp') def s_ezsignsignature_regexp_validate_regular_expression(cls, value): """Validates the regular expression""" if value is None: @@ -91,30 +109,43 @@ def s_ezsignsignature_regexp_validate_regular_expression(cls, value): raise ValueError(r"must validate the regular expression /^\^.*\$$|^$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignsignatureResponseCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignsignatureResponseCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_contact_name if self.obj_contact_name: _dict['objContactName'] = self.obj_contact_name.to_dict() @@ -144,47 +175,49 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignsignatureResponseCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignsignatureResponseCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignsignatureResponseCompound.parse_obj(obj) - - _obj = EzsignsignatureResponseCompound.parse_obj({ - "pki_ezsignsignature_id": obj.get("pkiEzsignsignatureID"), - "fki_ezsigndocument_id": obj.get("fkiEzsigndocumentID"), - "fki_ezsignfoldersignerassociation_id": obj.get("fkiEzsignfoldersignerassociationID"), - "i_ezsignpage_pagenumber": obj.get("iEzsignpagePagenumber"), - "i_ezsignsignature_x": obj.get("iEzsignsignatureX"), - "i_ezsignsignature_y": obj.get("iEzsignsignatureY"), - "i_ezsignsignature_height": obj.get("iEzsignsignatureHeight"), - "i_ezsignsignature_width": obj.get("iEzsignsignatureWidth"), - "i_ezsignsignature_step": obj.get("iEzsignsignatureStep"), - "e_ezsignsignature_type": obj.get("eEzsignsignatureType"), - "t_ezsignsignature_tooltip": obj.get("tEzsignsignatureTooltip"), - "e_ezsignsignature_tooltipposition": obj.get("eEzsignsignatureTooltipposition"), - "e_ezsignsignature_font": obj.get("eEzsignsignatureFont"), - "i_ezsignsignature_validationstep": obj.get("iEzsignsignatureValidationstep"), - "s_ezsignsignature_attachmentdescription": obj.get("sEzsignsignatureAttachmentdescription"), - "e_ezsignsignature_attachmentnamesource": obj.get("eEzsignsignatureAttachmentnamesource"), - "b_ezsignsignature_required": obj.get("bEzsignsignatureRequired"), - "fki_ezsignfoldersignerassociation_id_validation": obj.get("fkiEzsignfoldersignerassociationIDValidation"), - "dt_ezsignsignature_date": obj.get("dtEzsignsignatureDate"), - "i_ezsignsignatureattachment_count": obj.get("iEzsignsignatureattachmentCount"), - "s_ezsignsignature_description": obj.get("sEzsignsignatureDescription"), - "i_ezsignsignature_maxlength": obj.get("iEzsignsignatureMaxlength"), - "e_ezsignsignature_textvalidation": obj.get("eEzsignsignatureTextvalidation"), - "e_ezsignsignature_dependencyrequirement": obj.get("eEzsignsignatureDependencyrequirement"), - "s_ezsignsignature_regexp": obj.get("sEzsignsignatureRegexp"), - "obj_contact_name": CustomContactNameResponse.from_dict(obj.get("objContactName")) if obj.get("objContactName") is not None else None, - "obj_contact_name_delegation": CustomContactNameResponse.from_dict(obj.get("objContactNameDelegation")) if obj.get("objContactNameDelegation") is not None else None, - "obj_signature": SignatureResponseCompound.from_dict(obj.get("objSignature")) if obj.get("objSignature") is not None else None, - "b_ezsignsignature_customdate": obj.get("bEzsignsignatureCustomdate"), - "a_obj_ezsignsignaturecustomdate": [EzsignsignaturecustomdateResponseCompound.from_dict(_item) for _item in obj.get("a_objEzsignsignaturecustomdate")] if obj.get("a_objEzsignsignaturecustomdate") is not None else None, - "obj_creditcardtransaction": CustomCreditcardtransactionResponse.from_dict(obj.get("objCreditcardtransaction")) if obj.get("objCreditcardtransaction") is not None else None, - "a_obj_ezsignelementdependency": [EzsignelementdependencyResponseCompound.from_dict(_item) for _item in obj.get("a_objEzsignelementdependency")] if obj.get("a_objEzsignelementdependency") is not None else None + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsignsignatureID": obj.get("pkiEzsignsignatureID"), + "fkiEzsigndocumentID": obj.get("fkiEzsigndocumentID"), + "fkiEzsignfoldersignerassociationID": obj.get("fkiEzsignfoldersignerassociationID"), + "fkiEzsignsigningreasonID": obj.get("fkiEzsignsigningreasonID"), + "sEzsignsigningreasonDescriptionX": obj.get("sEzsignsigningreasonDescriptionX"), + "iEzsignpagePagenumber": obj.get("iEzsignpagePagenumber"), + "iEzsignsignatureX": obj.get("iEzsignsignatureX"), + "iEzsignsignatureY": obj.get("iEzsignsignatureY"), + "iEzsignsignatureHeight": obj.get("iEzsignsignatureHeight"), + "iEzsignsignatureWidth": obj.get("iEzsignsignatureWidth"), + "iEzsignsignatureStep": obj.get("iEzsignsignatureStep"), + "eEzsignsignatureType": obj.get("eEzsignsignatureType"), + "tEzsignsignatureTooltip": obj.get("tEzsignsignatureTooltip"), + "eEzsignsignatureTooltipposition": obj.get("eEzsignsignatureTooltipposition"), + "eEzsignsignatureFont": obj.get("eEzsignsignatureFont"), + "iEzsignsignatureValidationstep": obj.get("iEzsignsignatureValidationstep"), + "sEzsignsignatureAttachmentdescription": obj.get("sEzsignsignatureAttachmentdescription"), + "eEzsignsignatureAttachmentnamesource": obj.get("eEzsignsignatureAttachmentnamesource"), + "bEzsignsignatureRequired": obj.get("bEzsignsignatureRequired"), + "fkiEzsignfoldersignerassociationIDValidation": obj.get("fkiEzsignfoldersignerassociationIDValidation"), + "dtEzsignsignatureDate": obj.get("dtEzsignsignatureDate"), + "iEzsignsignatureattachmentCount": obj.get("iEzsignsignatureattachmentCount"), + "sEzsignsignatureDescription": obj.get("sEzsignsignatureDescription"), + "iEzsignsignatureMaxlength": obj.get("iEzsignsignatureMaxlength"), + "eEzsignsignatureTextvalidation": obj.get("eEzsignsignatureTextvalidation"), + "eEzsignsignatureDependencyrequirement": obj.get("eEzsignsignatureDependencyrequirement"), + "sEzsignsignatureRegexp": obj.get("sEzsignsignatureRegexp"), + "objContactName": CustomContactNameResponse.from_dict(obj.get("objContactName")) if obj.get("objContactName") is not None else None, + "objContactNameDelegation": CustomContactNameResponse.from_dict(obj.get("objContactNameDelegation")) if obj.get("objContactNameDelegation") is not None else None, + "objSignature": SignatureResponseCompound.from_dict(obj.get("objSignature")) if obj.get("objSignature") is not None else None, + "bEzsignsignatureCustomdate": obj.get("bEzsignsignatureCustomdate"), + "a_objEzsignsignaturecustomdate": [EzsignsignaturecustomdateResponseCompound.from_dict(_item) for _item in obj.get("a_objEzsignsignaturecustomdate")] if obj.get("a_objEzsignsignaturecustomdate") is not None else None, + "objCreditcardtransaction": CustomCreditcardtransactionResponse.from_dict(obj.get("objCreditcardtransaction")) if obj.get("objCreditcardtransaction") is not None else None, + "a_objEzsignelementdependency": [EzsignelementdependencyResponseCompound.from_dict(_item) for _item in obj.get("a_objEzsignelementdependency")] if obj.get("a_objEzsignelementdependency") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignsignature_sign_v1_request.py b/eZmaxApi/models/ezsignsignature_sign_v1_request.py index 19b56a7ff..7d29cc1a0 100644 --- a/eZmaxApi/models/ezsignsignature_sign_v1_request.py +++ b/eZmaxApi/models/ezsignsignature_sign_v1_request.py @@ -19,23 +19,30 @@ import json -from typing import List, Optional -from pydantic import BaseModel, Field, StrictBool, StrictStr, conlist, constr, validator +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, StrictStr, field_validator +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.common_file import CommonFile +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignsignatureSignV1Request(BaseModel): """ - Request for POST /1/object/ezsignsignature/{pkiEzsignsignatureID}/sign # noqa: E501 - """ - s_value: Optional[StrictStr] = Field(None, alias="sValue", description="The value required for the Ezsignsignature. This can only be set if eEzsignsignatureType is **City**, **FieldText** or **FieldTextarea**") - e_attachments_confirmation_decision: Optional[StrictStr] = Field(None, alias="eAttachmentsConfirmationDecision", description="Whether the attachment are accepted or refused. This can only be set if eEzsignsignatureType is **AttachmentsConfirmation**") - s_attachments_refusal_reason: Optional[StrictStr] = Field(None, alias="sAttachmentsRefusalReason", description="The reason of refused. This can only be set if eEzsignsignatureType is **AttachmentsConfirmation**") - s_svg: Optional[constr(strict=True)] = Field(None, alias="sSvg", description="The SVG of the handwritten signature. This can only be set if eEzsignsignatureType is **Handwritten** and **bIsAutomatic** is false") - a_obj_file: Optional[conlist(CommonFile)] = Field(None, alias="a_objFile") - b_is_automatic: StrictBool = Field(..., alias="bIsAutomatic", description="Indicates if the Ezsignsignature was part of an automatic process or not. This can only be true if eEzsignsignatureType is **Acknowledgement**, **City**, **Handwritten**, **Initials**, **Name** or **Stamp**. ") - __properties = ["sValue", "eAttachmentsConfirmationDecision", "sAttachmentsRefusalReason", "sSvg", "a_objFile", "bIsAutomatic"] - - @validator('e_attachments_confirmation_decision') + Request for POST /1/object/ezsignsignature/{pkiEzsignsignatureID}/sign + """ # noqa: E501 + fki_ezsignsigningreason_id: Optional[Annotated[int, Field(le=255, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsignsigningreason", alias="fkiEzsignsigningreasonID") + s_value: Optional[StrictStr] = Field(default=None, description="The value required for the Ezsignsignature. This can only be set if eEzsignsignatureType is **City**, **FieldText** or **FieldTextarea**", alias="sValue") + e_attachments_confirmation_decision: Optional[StrictStr] = Field(default=None, description="Whether the attachment are accepted or refused. This can only be set if eEzsignsignatureType is **AttachmentsConfirmation**", alias="eAttachmentsConfirmationDecision") + s_attachments_refusal_reason: Optional[StrictStr] = Field(default=None, description="The reason of refused. This can only be set if eEzsignsignatureType is **AttachmentsConfirmation**", alias="sAttachmentsRefusalReason") + s_svg: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="The SVG of the handwritten signature. This can only be set if eEzsignsignatureType is **Handwritten** and **bIsAutomatic** is false", alias="sSvg") + a_obj_file: Optional[List[CommonFile]] = Field(default=None, alias="a_objFile") + b_is_automatic: StrictBool = Field(description="Indicates if the Ezsignsignature was part of an automatic process or not. This can only be true if eEzsignsignatureType is **Acknowledgement**, **City**, **Handwritten**, **Initials**, **Name** or **Stamp**. ", alias="bIsAutomatic") + __properties: ClassVar[List[str]] = ["fkiEzsignsigningreasonID", "sValue", "eAttachmentsConfirmationDecision", "sAttachmentsRefusalReason", "sSvg", "a_objFile", "bIsAutomatic"] + + @field_validator('e_attachments_confirmation_decision') def e_attachments_confirmation_decision_validate_enum(cls, value): """Validates the enum""" if value is None: @@ -45,40 +52,53 @@ def e_attachments_confirmation_decision_validate_enum(cls, value): raise ValueError("must be one of enum values ('Accepted', 'Refused')") return value - @validator('s_svg') + @field_validator('s_svg') def s_svg_validate_regular_expression(cls, value): """Validates the regular expression""" if value is None: return value - if not re.match(r"^.{0,32767}$", value): - raise ValueError(r"must validate the regular expression /^.{0,32767}$/") + if not re.match(r"^.{0,65535}$", value): + raise ValueError(r"must validate the regular expression /^.{0,65535}$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignsignatureSignV1Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignsignatureSignV1Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_file (list) _items = [] if self.a_obj_file: @@ -89,21 +109,22 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignsignatureSignV1Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignsignatureSignV1Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignsignatureSignV1Request.parse_obj(obj) - - _obj = EzsignsignatureSignV1Request.parse_obj({ - "s_value": obj.get("sValue"), - "e_attachments_confirmation_decision": obj.get("eAttachmentsConfirmationDecision"), - "s_attachments_refusal_reason": obj.get("sAttachmentsRefusalReason"), - "s_svg": obj.get("sSvg"), - "a_obj_file": [CommonFile.from_dict(_item) for _item in obj.get("a_objFile")] if obj.get("a_objFile") is not None else None, - "b_is_automatic": obj.get("bIsAutomatic") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "fkiEzsignsigningreasonID": obj.get("fkiEzsignsigningreasonID"), + "sValue": obj.get("sValue"), + "eAttachmentsConfirmationDecision": obj.get("eAttachmentsConfirmationDecision"), + "sAttachmentsRefusalReason": obj.get("sAttachmentsRefusalReason"), + "sSvg": obj.get("sSvg"), + "a_objFile": [CommonFile.from_dict(_item) for _item in obj.get("a_objFile")] if obj.get("a_objFile") is not None else None, + "bIsAutomatic": obj.get("bIsAutomatic") }) return _obj diff --git a/eZmaxApi/models/ezsignsignature_sign_v1_response.py b/eZmaxApi/models/ezsignsignature_sign_v1_response.py index aaff3bb54..add10b815 100644 --- a/eZmaxApi/models/ezsignsignature_sign_v1_response.py +++ b/eZmaxApi/models/ezsignsignature_sign_v1_response.py @@ -19,43 +19,61 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignsignatureSignV1Response(BaseModel): """ - Response for POST /1/object/ezsignsignature/{pkiEzsignsignatureID}/sign # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - __properties = ["objDebugPayload", "objDebug"] + Response for POST /1/object/ezsignsignature/{pkiEzsignsignatureID}/sign + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignsignatureSignV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignsignatureSignV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -65,17 +83,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignsignatureSignV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignsignatureSignV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignsignatureSignV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignsignatureSignV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignsignatureattachment_response.py b/eZmaxApi/models/ezsignsignatureattachment_response.py index efe68d6af..b34f28892 100644 --- a/eZmaxApi/models/ezsignsignatureattachment_response.py +++ b/eZmaxApi/models/ezsignsignatureattachment_response.py @@ -19,68 +19,87 @@ import json - -from pydantic import BaseModel, Field, StrictStr, conint, constr, validator +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictStr, field_validator +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignsignatureattachmentResponse(BaseModel): """ - An Ezsignsignatureattachment Object # noqa: E501 - """ - pki_ezsignsignatureattachment_id: conint(strict=True, le=16777215, ge=1) = Field(..., alias="pkiEzsignsignatureattachmentID", description="The unique ID of the Ezsignsignatureattachment") - fki_ezsignsignature_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsignsignatureID", description="The unique ID of the Ezsignsignature") - bin_ezsignsignatureattachment_md5: StrictStr = Field(..., alias="binEzsignsignatureattachmentMD5", description="The md5 of the Ezsignsignatureattachment") - s_ezsignsignatureattachment_name: constr(strict=True) = Field(..., alias="sEzsignsignatureattachmentName", description="The name of the Ezsignsignatureattachment") - s_download_url: StrictStr = Field(..., alias="sDownloadUrl", description="The Url to the requested document. Url will expire after 3 hours.") - __properties = ["pkiEzsignsignatureattachmentID", "fkiEzsignsignatureID", "binEzsignsignatureattachmentMD5", "sEzsignsignatureattachmentName", "sDownloadUrl"] - - @validator('s_ezsignsignatureattachment_name') + An Ezsignsignatureattachment Object + """ # noqa: E501 + pki_ezsignsignatureattachment_id: Annotated[int, Field(le=16777215, strict=True, ge=1)] = Field(description="The unique ID of the Ezsignsignatureattachment", alias="pkiEzsignsignatureattachmentID") + fki_ezsignsignature_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsignsignature", alias="fkiEzsignsignatureID") + bin_ezsignsignatureattachment_md5: StrictStr = Field(description="The md5 of the Ezsignsignatureattachment", alias="binEzsignsignatureattachmentMD5") + s_ezsignsignatureattachment_name: Annotated[str, Field(strict=True)] = Field(description="The name of the Ezsignsignatureattachment", alias="sEzsignsignatureattachmentName") + s_download_url: StrictStr = Field(description="The Url to the requested document. Url will expire after 3 hours.", alias="sDownloadUrl") + __properties: ClassVar[List[str]] = ["pkiEzsignsignatureattachmentID", "fkiEzsignsignatureID", "binEzsignsignatureattachmentMD5", "sEzsignsignatureattachmentName", "sDownloadUrl"] + + @field_validator('s_ezsignsignatureattachment_name') def s_ezsignsignatureattachment_name_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^.{0,75}$", value): raise ValueError(r"must validate the regular expression /^.{0,75}$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignsignatureattachmentResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignsignatureattachmentResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignsignatureattachmentResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignsignatureattachmentResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignsignatureattachmentResponse.parse_obj(obj) - - _obj = EzsignsignatureattachmentResponse.parse_obj({ - "pki_ezsignsignatureattachment_id": obj.get("pkiEzsignsignatureattachmentID"), - "fki_ezsignsignature_id": obj.get("fkiEzsignsignatureID"), - "bin_ezsignsignatureattachment_md5": obj.get("binEzsignsignatureattachmentMD5"), - "s_ezsignsignatureattachment_name": obj.get("sEzsignsignatureattachmentName"), - "s_download_url": obj.get("sDownloadUrl") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsignsignatureattachmentID": obj.get("pkiEzsignsignatureattachmentID"), + "fkiEzsignsignatureID": obj.get("fkiEzsignsignatureID"), + "binEzsignsignatureattachmentMD5": obj.get("binEzsignsignatureattachmentMD5"), + "sEzsignsignatureattachmentName": obj.get("sEzsignsignatureattachmentName"), + "sDownloadUrl": obj.get("sDownloadUrl") }) return _obj diff --git a/eZmaxApi/models/ezsignsignaturecustomdate_request.py b/eZmaxApi/models/ezsignsignaturecustomdate_request.py index 87dadae4e..d3e4ddaad 100644 --- a/eZmaxApi/models/ezsignsignaturecustomdate_request.py +++ b/eZmaxApi/models/ezsignsignaturecustomdate_request.py @@ -19,59 +19,78 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictStr, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictStr +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignsignaturecustomdateRequest(BaseModel): """ - An Ezsignsignaturecustomdate Object # noqa: E501 - """ - pki_ezsignsignaturecustomdate_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="pkiEzsignsignaturecustomdateID", description="The unique ID of the Ezsignsignaturecustomdate") - i_ezsignsignaturecustomdate_x: conint(strict=True, ge=0) = Field(..., alias="iEzsignsignaturecustomdateX", description="The X coordinate (Horizontal) where to put the Ezsignsignaturecustomdate on the page. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsignsignaturecustomdate block 2 inches from the left border of the page, you would use \"200\" for the X coordinate.") - i_ezsignsignaturecustomdate_y: conint(strict=True, ge=0) = Field(..., alias="iEzsignsignaturecustomdateY", description="The Y coordinate (Vertical) where to put the Ezsignsignaturecustomdate on the page. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsignsignaturecustomdate block 3 inches from the top border of the page, you would use \"300\" for the Y coordinate.") - s_ezsignsignaturecustomdate_format: StrictStr = Field(..., alias="sEzsignsignaturecustomdateFormat", description="The custom date format to use You can use the codes below and they will be replaced at signature time. Text values like month and day names will be rendered in the proper language. Other text will be left as-is. The codes examples below are based on the following datetime: Thursday, January 6, 2022 at 08:07:09 EST For example, the format \"Signature date: {MM}/{DD}/{YYYY} {hh}:{mm}\" would become \"Signature date: 01/06/2022 08:07\" **Year** | Code | Example | | - | - | | {YYYY} | 2022 | | {YY} | 22 | **Month** | Code | Example | | - | - | | {MonthCapitalize} | Janvier | | {Month} | janvier | | {MM} | 01 | | {M} | 1 | **Day** | Code | Example | | - | - | | {DayCapitalize} | Jeudi | | {Day} | jeudi | | {DD} | 06 | | {D} | 6 | **Hour** | Code | Example | | - | - | | {hh} | 08 | **Minute** | Code | Example | | - | - | | {mm} | 07 | **Second** | Code | Example | | - | - | | {ss} | 09 | **Timezone** | Code | Example | | - | - | | {Z} | EST | **Time** | Code | Example | | - | - | | {Time} | 08:07:09 | | {TimeZ} | 08:07:09 EST | **Date** | Code | Example | | - | - | | {Date} | 2022-01-06 | | {DateText} | 1er Janvier 2022 | **Full** | Code | Example | | - | - | | {DateTime} | 2022-01-06 08:07:09 | | {DateTimeZ} | 2022-01-06 08:07:09 EST | ") - __properties = ["pkiEzsignsignaturecustomdateID", "iEzsignsignaturecustomdateX", "iEzsignsignaturecustomdateY", "sEzsignsignaturecustomdateFormat"] + An Ezsignsignaturecustomdate Object + """ # noqa: E501 + pki_ezsignsignaturecustomdate_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsignsignaturecustomdate", alias="pkiEzsignsignaturecustomdateID") + i_ezsignsignaturecustomdate_x: Annotated[int, Field(strict=True, ge=0)] = Field(description="The X coordinate (Horizontal) where to put the Ezsignsignaturecustomdate on the page. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsignsignaturecustomdate block 2 inches from the left border of the page, you would use \"200\" for the X coordinate.", alias="iEzsignsignaturecustomdateX") + i_ezsignsignaturecustomdate_y: Annotated[int, Field(strict=True, ge=0)] = Field(description="The Y coordinate (Vertical) where to put the Ezsignsignaturecustomdate on the page. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsignsignaturecustomdate block 3 inches from the top border of the page, you would use \"300\" for the Y coordinate.", alias="iEzsignsignaturecustomdateY") + s_ezsignsignaturecustomdate_format: StrictStr = Field(description="The custom date format to use You can use the codes below and they will be replaced at signature time. Text values like month and day names will be rendered in the proper language. Other text will be left as-is. The codes examples below are based on the following datetime: Thursday, January 6, 2022 at 08:07:09 EST For example, the format \"Signature date: {MM}/{DD}/{YYYY} {hh}:{mm}\" would become \"Signature date: 01/06/2022 08:07\" **Year** | Code | Example | | - | - | | {YYYY} | 2022 | | {YY} | 22 | **Month** | Code | Example | | - | - | | {MonthCapitalize} | Janvier | | {Month} | janvier | | {MM} | 01 | | {M} | 1 | **Day** | Code | Example | | - | - | | {DayCapitalize} | Jeudi | | {Day} | jeudi | | {DD} | 06 | | {D} | 6 | **Hour** | Code | Example | | - | - | | {hh} | 08 | **Minute** | Code | Example | | - | - | | {mm} | 07 | **Second** | Code | Example | | - | - | | {ss} | 09 | **Timezone** | Code | Example | | - | - | | {Z} | EST | **Time** | Code | Example | | - | - | | {Time} | 08:07:09 | | {TimeZ} | 08:07:09 EST | **Date** | Code | Example | | - | - | | {Date} | 2022-01-06 | | {DateText} | 1er Janvier 2022 | **Full** | Code | Example | | - | - | | {DateTime} | 2022-01-06 08:07:09 | | {DateTimeZ} | 2022-01-06 08:07:09 EST | ", alias="sEzsignsignaturecustomdateFormat") + __properties: ClassVar[List[str]] = ["pkiEzsignsignaturecustomdateID", "iEzsignsignaturecustomdateX", "iEzsignsignaturecustomdateY", "sEzsignsignaturecustomdateFormat"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignsignaturecustomdateRequest: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignsignaturecustomdateRequest from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignsignaturecustomdateRequest: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignsignaturecustomdateRequest from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignsignaturecustomdateRequest.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignsignaturecustomdateRequest.parse_obj({ - "pki_ezsignsignaturecustomdate_id": obj.get("pkiEzsignsignaturecustomdateID"), - "i_ezsignsignaturecustomdate_x": obj.get("iEzsignsignaturecustomdateX"), - "i_ezsignsignaturecustomdate_y": obj.get("iEzsignsignaturecustomdateY"), - "s_ezsignsignaturecustomdate_format": obj.get("sEzsignsignaturecustomdateFormat") + _obj = cls.model_validate({ + "pkiEzsignsignaturecustomdateID": obj.get("pkiEzsignsignaturecustomdateID"), + "iEzsignsignaturecustomdateX": obj.get("iEzsignsignaturecustomdateX"), + "iEzsignsignaturecustomdateY": obj.get("iEzsignsignaturecustomdateY"), + "sEzsignsignaturecustomdateFormat": obj.get("sEzsignsignaturecustomdateFormat") }) return _obj diff --git a/eZmaxApi/models/ezsignsignaturecustomdate_request_compound.py b/eZmaxApi/models/ezsignsignaturecustomdate_request_compound.py index 6d5c7ec7a..0d318c53c 100644 --- a/eZmaxApi/models/ezsignsignaturecustomdate_request_compound.py +++ b/eZmaxApi/models/ezsignsignaturecustomdate_request_compound.py @@ -19,59 +19,78 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictStr, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictStr +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignsignaturecustomdateRequestCompound(BaseModel): """ - An Ezsignsignaturecustomdate Object and children to create a complete structure # noqa: E501 - """ - pki_ezsignsignaturecustomdate_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="pkiEzsignsignaturecustomdateID", description="The unique ID of the Ezsignsignaturecustomdate") - i_ezsignsignaturecustomdate_x: conint(strict=True, ge=0) = Field(..., alias="iEzsignsignaturecustomdateX", description="The X coordinate (Horizontal) where to put the Ezsignsignaturecustomdate on the page. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsignsignaturecustomdate block 2 inches from the left border of the page, you would use \"200\" for the X coordinate.") - i_ezsignsignaturecustomdate_y: conint(strict=True, ge=0) = Field(..., alias="iEzsignsignaturecustomdateY", description="The Y coordinate (Vertical) where to put the Ezsignsignaturecustomdate on the page. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsignsignaturecustomdate block 3 inches from the top border of the page, you would use \"300\" for the Y coordinate.") - s_ezsignsignaturecustomdate_format: StrictStr = Field(..., alias="sEzsignsignaturecustomdateFormat", description="The custom date format to use You can use the codes below and they will be replaced at signature time. Text values like month and day names will be rendered in the proper language. Other text will be left as-is. The codes examples below are based on the following datetime: Thursday, January 6, 2022 at 08:07:09 EST For example, the format \"Signature date: {MM}/{DD}/{YYYY} {hh}:{mm}\" would become \"Signature date: 01/06/2022 08:07\" **Year** | Code | Example | | - | - | | {YYYY} | 2022 | | {YY} | 22 | **Month** | Code | Example | | - | - | | {MonthCapitalize} | Janvier | | {Month} | janvier | | {MM} | 01 | | {M} | 1 | **Day** | Code | Example | | - | - | | {DayCapitalize} | Jeudi | | {Day} | jeudi | | {DD} | 06 | | {D} | 6 | **Hour** | Code | Example | | - | - | | {hh} | 08 | **Minute** | Code | Example | | - | - | | {mm} | 07 | **Second** | Code | Example | | - | - | | {ss} | 09 | **Timezone** | Code | Example | | - | - | | {Z} | EST | **Time** | Code | Example | | - | - | | {Time} | 08:07:09 | | {TimeZ} | 08:07:09 EST | **Date** | Code | Example | | - | - | | {Date} | 2022-01-06 | | {DateText} | 1er Janvier 2022 | **Full** | Code | Example | | - | - | | {DateTime} | 2022-01-06 08:07:09 | | {DateTimeZ} | 2022-01-06 08:07:09 EST | ") - __properties = ["pkiEzsignsignaturecustomdateID", "iEzsignsignaturecustomdateX", "iEzsignsignaturecustomdateY", "sEzsignsignaturecustomdateFormat"] + An Ezsignsignaturecustomdate Object and children to create a complete structure + """ # noqa: E501 + pki_ezsignsignaturecustomdate_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsignsignaturecustomdate", alias="pkiEzsignsignaturecustomdateID") + i_ezsignsignaturecustomdate_x: Annotated[int, Field(strict=True, ge=0)] = Field(description="The X coordinate (Horizontal) where to put the Ezsignsignaturecustomdate on the page. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsignsignaturecustomdate block 2 inches from the left border of the page, you would use \"200\" for the X coordinate.", alias="iEzsignsignaturecustomdateX") + i_ezsignsignaturecustomdate_y: Annotated[int, Field(strict=True, ge=0)] = Field(description="The Y coordinate (Vertical) where to put the Ezsignsignaturecustomdate on the page. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsignsignaturecustomdate block 3 inches from the top border of the page, you would use \"300\" for the Y coordinate.", alias="iEzsignsignaturecustomdateY") + s_ezsignsignaturecustomdate_format: StrictStr = Field(description="The custom date format to use You can use the codes below and they will be replaced at signature time. Text values like month and day names will be rendered in the proper language. Other text will be left as-is. The codes examples below are based on the following datetime: Thursday, January 6, 2022 at 08:07:09 EST For example, the format \"Signature date: {MM}/{DD}/{YYYY} {hh}:{mm}\" would become \"Signature date: 01/06/2022 08:07\" **Year** | Code | Example | | - | - | | {YYYY} | 2022 | | {YY} | 22 | **Month** | Code | Example | | - | - | | {MonthCapitalize} | Janvier | | {Month} | janvier | | {MM} | 01 | | {M} | 1 | **Day** | Code | Example | | - | - | | {DayCapitalize} | Jeudi | | {Day} | jeudi | | {DD} | 06 | | {D} | 6 | **Hour** | Code | Example | | - | - | | {hh} | 08 | **Minute** | Code | Example | | - | - | | {mm} | 07 | **Second** | Code | Example | | - | - | | {ss} | 09 | **Timezone** | Code | Example | | - | - | | {Z} | EST | **Time** | Code | Example | | - | - | | {Time} | 08:07:09 | | {TimeZ} | 08:07:09 EST | **Date** | Code | Example | | - | - | | {Date} | 2022-01-06 | | {DateText} | 1er Janvier 2022 | **Full** | Code | Example | | - | - | | {DateTime} | 2022-01-06 08:07:09 | | {DateTimeZ} | 2022-01-06 08:07:09 EST | ", alias="sEzsignsignaturecustomdateFormat") + __properties: ClassVar[List[str]] = ["pkiEzsignsignaturecustomdateID", "iEzsignsignaturecustomdateX", "iEzsignsignaturecustomdateY", "sEzsignsignaturecustomdateFormat"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignsignaturecustomdateRequestCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignsignaturecustomdateRequestCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignsignaturecustomdateRequestCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignsignaturecustomdateRequestCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignsignaturecustomdateRequestCompound.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignsignaturecustomdateRequestCompound.parse_obj({ - "pki_ezsignsignaturecustomdate_id": obj.get("pkiEzsignsignaturecustomdateID"), - "i_ezsignsignaturecustomdate_x": obj.get("iEzsignsignaturecustomdateX"), - "i_ezsignsignaturecustomdate_y": obj.get("iEzsignsignaturecustomdateY"), - "s_ezsignsignaturecustomdate_format": obj.get("sEzsignsignaturecustomdateFormat") + _obj = cls.model_validate({ + "pkiEzsignsignaturecustomdateID": obj.get("pkiEzsignsignaturecustomdateID"), + "iEzsignsignaturecustomdateX": obj.get("iEzsignsignaturecustomdateX"), + "iEzsignsignaturecustomdateY": obj.get("iEzsignsignaturecustomdateY"), + "sEzsignsignaturecustomdateFormat": obj.get("sEzsignsignaturecustomdateFormat") }) return _obj diff --git a/eZmaxApi/models/ezsignsignaturecustomdate_response.py b/eZmaxApi/models/ezsignsignaturecustomdate_response.py index d5b7805cc..ebc051ff4 100644 --- a/eZmaxApi/models/ezsignsignaturecustomdate_response.py +++ b/eZmaxApi/models/ezsignsignaturecustomdate_response.py @@ -19,59 +19,78 @@ import json - -from pydantic import BaseModel, Field, StrictStr, conint +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictStr +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignsignaturecustomdateResponse(BaseModel): """ - An Ezsignsignaturecustomdate Object # noqa: E501 - """ - pki_ezsignsignaturecustomdate_id: conint(strict=True, ge=0) = Field(..., alias="pkiEzsignsignaturecustomdateID", description="The unique ID of the Ezsignsignaturecustomdate") - i_ezsignsignaturecustomdate_x: conint(strict=True, ge=0) = Field(..., alias="iEzsignsignaturecustomdateX", description="The X coordinate (Horizontal) where to put the Ezsignsignaturecustomdate on the page. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsignsignaturecustomdate block 2 inches from the left border of the page, you would use \"200\" for the X coordinate.") - i_ezsignsignaturecustomdate_y: conint(strict=True, ge=0) = Field(..., alias="iEzsignsignaturecustomdateY", description="The Y coordinate (Vertical) where to put the Ezsignsignaturecustomdate on the page. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsignsignaturecustomdate block 3 inches from the top border of the page, you would use \"300\" for the Y coordinate.") - s_ezsignsignaturecustomdate_format: StrictStr = Field(..., alias="sEzsignsignaturecustomdateFormat", description="The custom date format to use You can use the codes below and they will be replaced at signature time. Text values like month and day names will be rendered in the proper language. Other text will be left as-is. The codes examples below are based on the following datetime: Thursday, January 6, 2022 at 08:07:09 EST For example, the format \"Signature date: {MM}/{DD}/{YYYY} {hh}:{mm}\" would become \"Signature date: 01/06/2022 08:07\" **Year** | Code | Example | | - | - | | {YYYY} | 2022 | | {YY} | 22 | **Month** | Code | Example | | - | - | | {MonthCapitalize} | Janvier | | {Month} | janvier | | {MM} | 01 | | {M} | 1 | **Day** | Code | Example | | - | - | | {DayCapitalize} | Jeudi | | {Day} | jeudi | | {DD} | 06 | | {D} | 6 | **Hour** | Code | Example | | - | - | | {hh} | 08 | **Minute** | Code | Example | | - | - | | {mm} | 07 | **Second** | Code | Example | | - | - | | {ss} | 09 | **Timezone** | Code | Example | | - | - | | {Z} | EST | **Time** | Code | Example | | - | - | | {Time} | 08:07:09 | | {TimeZ} | 08:07:09 EST | **Date** | Code | Example | | - | - | | {Date} | 2022-01-06 | | {DateText} | 1er Janvier 2022 | **Full** | Code | Example | | - | - | | {DateTime} | 2022-01-06 08:07:09 | | {DateTimeZ} | 2022-01-06 08:07:09 EST | ") - __properties = ["pkiEzsignsignaturecustomdateID", "iEzsignsignaturecustomdateX", "iEzsignsignaturecustomdateY", "sEzsignsignaturecustomdateFormat"] + An Ezsignsignaturecustomdate Object + """ # noqa: E501 + pki_ezsignsignaturecustomdate_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsignsignaturecustomdate", alias="pkiEzsignsignaturecustomdateID") + i_ezsignsignaturecustomdate_x: Annotated[int, Field(strict=True, ge=0)] = Field(description="The X coordinate (Horizontal) where to put the Ezsignsignaturecustomdate on the page. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsignsignaturecustomdate block 2 inches from the left border of the page, you would use \"200\" for the X coordinate.", alias="iEzsignsignaturecustomdateX") + i_ezsignsignaturecustomdate_y: Annotated[int, Field(strict=True, ge=0)] = Field(description="The Y coordinate (Vertical) where to put the Ezsignsignaturecustomdate on the page. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsignsignaturecustomdate block 3 inches from the top border of the page, you would use \"300\" for the Y coordinate.", alias="iEzsignsignaturecustomdateY") + s_ezsignsignaturecustomdate_format: StrictStr = Field(description="The custom date format to use You can use the codes below and they will be replaced at signature time. Text values like month and day names will be rendered in the proper language. Other text will be left as-is. The codes examples below are based on the following datetime: Thursday, January 6, 2022 at 08:07:09 EST For example, the format \"Signature date: {MM}/{DD}/{YYYY} {hh}:{mm}\" would become \"Signature date: 01/06/2022 08:07\" **Year** | Code | Example | | - | - | | {YYYY} | 2022 | | {YY} | 22 | **Month** | Code | Example | | - | - | | {MonthCapitalize} | Janvier | | {Month} | janvier | | {MM} | 01 | | {M} | 1 | **Day** | Code | Example | | - | - | | {DayCapitalize} | Jeudi | | {Day} | jeudi | | {DD} | 06 | | {D} | 6 | **Hour** | Code | Example | | - | - | | {hh} | 08 | **Minute** | Code | Example | | - | - | | {mm} | 07 | **Second** | Code | Example | | - | - | | {ss} | 09 | **Timezone** | Code | Example | | - | - | | {Z} | EST | **Time** | Code | Example | | - | - | | {Time} | 08:07:09 | | {TimeZ} | 08:07:09 EST | **Date** | Code | Example | | - | - | | {Date} | 2022-01-06 | | {DateText} | 1er Janvier 2022 | **Full** | Code | Example | | - | - | | {DateTime} | 2022-01-06 08:07:09 | | {DateTimeZ} | 2022-01-06 08:07:09 EST | ", alias="sEzsignsignaturecustomdateFormat") + __properties: ClassVar[List[str]] = ["pkiEzsignsignaturecustomdateID", "iEzsignsignaturecustomdateX", "iEzsignsignaturecustomdateY", "sEzsignsignaturecustomdateFormat"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignsignaturecustomdateResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignsignaturecustomdateResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignsignaturecustomdateResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignsignaturecustomdateResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignsignaturecustomdateResponse.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignsignaturecustomdateResponse.parse_obj({ - "pki_ezsignsignaturecustomdate_id": obj.get("pkiEzsignsignaturecustomdateID"), - "i_ezsignsignaturecustomdate_x": obj.get("iEzsignsignaturecustomdateX"), - "i_ezsignsignaturecustomdate_y": obj.get("iEzsignsignaturecustomdateY"), - "s_ezsignsignaturecustomdate_format": obj.get("sEzsignsignaturecustomdateFormat") + _obj = cls.model_validate({ + "pkiEzsignsignaturecustomdateID": obj.get("pkiEzsignsignaturecustomdateID"), + "iEzsignsignaturecustomdateX": obj.get("iEzsignsignaturecustomdateX"), + "iEzsignsignaturecustomdateY": obj.get("iEzsignsignaturecustomdateY"), + "sEzsignsignaturecustomdateFormat": obj.get("sEzsignsignaturecustomdateFormat") }) return _obj diff --git a/eZmaxApi/models/ezsignsignaturecustomdate_response_compound.py b/eZmaxApi/models/ezsignsignaturecustomdate_response_compound.py index f77dbf46b..e6f0526ae 100644 --- a/eZmaxApi/models/ezsignsignaturecustomdate_response_compound.py +++ b/eZmaxApi/models/ezsignsignaturecustomdate_response_compound.py @@ -19,59 +19,78 @@ import json - -from pydantic import BaseModel, Field, StrictStr, conint +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictStr +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignsignaturecustomdateResponseCompound(BaseModel): """ - An Ezsignsignaturecustomdate Object and children to create a complete structure # noqa: E501 - """ - pki_ezsignsignaturecustomdate_id: conint(strict=True, ge=0) = Field(..., alias="pkiEzsignsignaturecustomdateID", description="The unique ID of the Ezsignsignaturecustomdate") - i_ezsignsignaturecustomdate_x: conint(strict=True, ge=0) = Field(..., alias="iEzsignsignaturecustomdateX", description="The X coordinate (Horizontal) where to put the Ezsignsignaturecustomdate on the page. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsignsignaturecustomdate block 2 inches from the left border of the page, you would use \"200\" for the X coordinate.") - i_ezsignsignaturecustomdate_y: conint(strict=True, ge=0) = Field(..., alias="iEzsignsignaturecustomdateY", description="The Y coordinate (Vertical) where to put the Ezsignsignaturecustomdate on the page. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsignsignaturecustomdate block 3 inches from the top border of the page, you would use \"300\" for the Y coordinate.") - s_ezsignsignaturecustomdate_format: StrictStr = Field(..., alias="sEzsignsignaturecustomdateFormat", description="The custom date format to use You can use the codes below and they will be replaced at signature time. Text values like month and day names will be rendered in the proper language. Other text will be left as-is. The codes examples below are based on the following datetime: Thursday, January 6, 2022 at 08:07:09 EST For example, the format \"Signature date: {MM}/{DD}/{YYYY} {hh}:{mm}\" would become \"Signature date: 01/06/2022 08:07\" **Year** | Code | Example | | - | - | | {YYYY} | 2022 | | {YY} | 22 | **Month** | Code | Example | | - | - | | {MonthCapitalize} | Janvier | | {Month} | janvier | | {MM} | 01 | | {M} | 1 | **Day** | Code | Example | | - | - | | {DayCapitalize} | Jeudi | | {Day} | jeudi | | {DD} | 06 | | {D} | 6 | **Hour** | Code | Example | | - | - | | {hh} | 08 | **Minute** | Code | Example | | - | - | | {mm} | 07 | **Second** | Code | Example | | - | - | | {ss} | 09 | **Timezone** | Code | Example | | - | - | | {Z} | EST | **Time** | Code | Example | | - | - | | {Time} | 08:07:09 | | {TimeZ} | 08:07:09 EST | **Date** | Code | Example | | - | - | | {Date} | 2022-01-06 | | {DateText} | 1er Janvier 2022 | **Full** | Code | Example | | - | - | | {DateTime} | 2022-01-06 08:07:09 | | {DateTimeZ} | 2022-01-06 08:07:09 EST | ") - __properties = ["pkiEzsignsignaturecustomdateID", "iEzsignsignaturecustomdateX", "iEzsignsignaturecustomdateY", "sEzsignsignaturecustomdateFormat"] + An Ezsignsignaturecustomdate Object and children to create a complete structure + """ # noqa: E501 + pki_ezsignsignaturecustomdate_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsignsignaturecustomdate", alias="pkiEzsignsignaturecustomdateID") + i_ezsignsignaturecustomdate_x: Annotated[int, Field(strict=True, ge=0)] = Field(description="The X coordinate (Horizontal) where to put the Ezsignsignaturecustomdate on the page. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsignsignaturecustomdate block 2 inches from the left border of the page, you would use \"200\" for the X coordinate.", alias="iEzsignsignaturecustomdateX") + i_ezsignsignaturecustomdate_y: Annotated[int, Field(strict=True, ge=0)] = Field(description="The Y coordinate (Vertical) where to put the Ezsignsignaturecustomdate on the page. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsignsignaturecustomdate block 3 inches from the top border of the page, you would use \"300\" for the Y coordinate.", alias="iEzsignsignaturecustomdateY") + s_ezsignsignaturecustomdate_format: StrictStr = Field(description="The custom date format to use You can use the codes below and they will be replaced at signature time. Text values like month and day names will be rendered in the proper language. Other text will be left as-is. The codes examples below are based on the following datetime: Thursday, January 6, 2022 at 08:07:09 EST For example, the format \"Signature date: {MM}/{DD}/{YYYY} {hh}:{mm}\" would become \"Signature date: 01/06/2022 08:07\" **Year** | Code | Example | | - | - | | {YYYY} | 2022 | | {YY} | 22 | **Month** | Code | Example | | - | - | | {MonthCapitalize} | Janvier | | {Month} | janvier | | {MM} | 01 | | {M} | 1 | **Day** | Code | Example | | - | - | | {DayCapitalize} | Jeudi | | {Day} | jeudi | | {DD} | 06 | | {D} | 6 | **Hour** | Code | Example | | - | - | | {hh} | 08 | **Minute** | Code | Example | | - | - | | {mm} | 07 | **Second** | Code | Example | | - | - | | {ss} | 09 | **Timezone** | Code | Example | | - | - | | {Z} | EST | **Time** | Code | Example | | - | - | | {Time} | 08:07:09 | | {TimeZ} | 08:07:09 EST | **Date** | Code | Example | | - | - | | {Date} | 2022-01-06 | | {DateText} | 1er Janvier 2022 | **Full** | Code | Example | | - | - | | {DateTime} | 2022-01-06 08:07:09 | | {DateTimeZ} | 2022-01-06 08:07:09 EST | ", alias="sEzsignsignaturecustomdateFormat") + __properties: ClassVar[List[str]] = ["pkiEzsignsignaturecustomdateID", "iEzsignsignaturecustomdateX", "iEzsignsignaturecustomdateY", "sEzsignsignaturecustomdateFormat"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignsignaturecustomdateResponseCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignsignaturecustomdateResponseCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignsignaturecustomdateResponseCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignsignaturecustomdateResponseCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignsignaturecustomdateResponseCompound.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignsignaturecustomdateResponseCompound.parse_obj({ - "pki_ezsignsignaturecustomdate_id": obj.get("pkiEzsignsignaturecustomdateID"), - "i_ezsignsignaturecustomdate_x": obj.get("iEzsignsignaturecustomdateX"), - "i_ezsignsignaturecustomdate_y": obj.get("iEzsignsignaturecustomdateY"), - "s_ezsignsignaturecustomdate_format": obj.get("sEzsignsignaturecustomdateFormat") + _obj = cls.model_validate({ + "pkiEzsignsignaturecustomdateID": obj.get("pkiEzsignsignaturecustomdateID"), + "iEzsignsignaturecustomdateX": obj.get("iEzsignsignaturecustomdateX"), + "iEzsignsignaturecustomdateY": obj.get("iEzsignsignaturecustomdateY"), + "sEzsignsignaturecustomdateFormat": obj.get("sEzsignsignaturecustomdateFormat") }) return _obj diff --git a/eZmaxApi/models/ezsignsigner_request.py b/eZmaxApi/models/ezsignsigner_request.py index 022ca7848..dbb0d3d99 100644 --- a/eZmaxApi/models/ezsignsigner_request.py +++ b/eZmaxApi/models/ezsignsigner_request.py @@ -19,21 +19,27 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictStr, conint, validator +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictStr, field_validator +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignsignerRequest(BaseModel): """ - An Ezsignsigner Object # noqa: E501 - """ - fki_userlogintype_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiUserlogintypeID", description="The unique ID of the Userlogintype Valid values: |Value|Description|Detail| |-|-|-| |1|**Email Only**|The Ezsignsigner will receive a secure link by email| |2|**Email and phone or SMS**|The Ezsignsigner will receive a secure link by email and will need to authenticate using SMS or Phone call. **Additional fee applies**| |3|**Email and secret question**|The Ezsignsigner will receive a secure link by email and will need to authenticate using a predefined question and answer| |4|**In person only**|The Ezsignsigner will only be able to sign \"In-Person\" and there won't be any authentication. No email will be sent for invitation to sign. Make sure you evaluate the risk of signature denial and at minimum, we recommend you use a handwritten signature type| |5|**In person with phone or SMS**|The Ezsignsigner will only be able to sign \"In-Person\" and will need to authenticate using SMS or Phone call. No email will be sent for invitation to sign. **Additional fee applies**|") - fki_taxassignment_id: conint(strict=True, le=15, ge=0) = Field(..., alias="fkiTaxassignmentID", description="The unique ID of the Taxassignment. Valid values: |Value|Description| |-|-| |1|No tax| |2|GST| |3|HST (ON)| |4|HST (NB)| |5|HST (NS)| |6|HST (NL)| |7|HST (PE)| |8|GST + QST (QC)| |9|GST + QST (QC) Non-Recoverable| |10|GST + PST (BC)| |11|GST + PST (SK)| |12|GST + RST (MB)| |13|GST + PST (BC) Non-Recoverable| |14|GST + PST (SK) Non-Recoverable| |15|GST + RST (MB) Non-Recoverable|") - fki_secretquestion_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiSecretquestionID", description="The unique ID of the Secretquestion. Valid values: |Value|Description| |-|-| |1|The name of the hospital in which you were born| |2|The name of your grade school| |3|The last name of your favorite teacher| |4|Your favorite sports team| |5|Your favorite TV show| |6|Your favorite movie| |7|The name of the street on which you grew up| |8|The name of your first employer| |9|Your first car| |10|Your favorite food| |11|The name of your first pet| |12|Favorite musician/band| |13|What instrument you play| |14|Your father's middle name| |15|Your mother's maiden name| |16|Name of your eldest child| |17|Your spouse's middle name| |18|Favorite restaurant| |19|Childhood nickname| |20|Favorite vacation destination| |21|Your boat's name| |22|Date of Birth (YYYY-MM-DD)| |22|Secret Code| |22|Your reference code|") - e_ezsignsigner_logintype: Optional[StrictStr] = Field(None, alias="eEzsignsignerLogintype", description="The method the Ezsignsigner will authenticate to the signing platform. 1. **Password** means the Ezsignsigner will receive a secure link by email. 2. **PasswordPhone** means the Ezsignsigner will receive a secure link by email and will need to authenticate using SMS or Phone call. **Additional fee applies**. 3. **PasswordQuestion** means the Ezsignsigner will receive a secure link by email and will need to authenticate using a predefined question and answer. 4. **InPersonPhone** means the Ezsignsigner will only be able to sign \"In-Person\" and will need to authenticate using SMS or Phone call. No email will be sent for invitation to sign. **Additional fee applies**. 5. **InPerson** means the Ezsignsigner will only be able to sign \"In-Person\" and there won't be any authentication. No email will be sent for invitation to sign. Make sure you evaluate the risk of signature denial and at minimum, we recommend you use a handwritten signature type.") - s_ezsignsigner_secretanswer: Optional[StrictStr] = Field(None, alias="sEzsignsignerSecretanswer", description="The predefined answer to the secret question the Ezsignsigner will need to provide to successfully authenticate.") - __properties = ["fkiUserlogintypeID", "fkiTaxassignmentID", "fkiSecretquestionID", "eEzsignsignerLogintype", "sEzsignsignerSecretanswer"] - - @validator('e_ezsignsigner_logintype') + An Ezsignsigner Object + """ # noqa: E501 + fki_userlogintype_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Userlogintype Valid values: |Value|Description|Detail| |-|-|-| |1|**Email Only**|The Ezsignsigner will receive a secure link by email| |2|**Email and phone or SMS**|The Ezsignsigner will receive a secure link by email and will need to authenticate using SMS or Phone call. **Additional fee applies**| |3|**Email and secret question**|The Ezsignsigner will receive a secure link by email and will need to authenticate using a predefined question and answer| |4|**In person only**|The Ezsignsigner will only be able to sign \"In-Person\" and there won't be any authentication. No email will be sent for invitation to sign. Make sure you evaluate the risk of signature denial and at minimum, we recommend you use a handwritten signature type| |5|**In person with phone or SMS**|The Ezsignsigner will only be able to sign \"In-Person\" and will need to authenticate using SMS or Phone call. No email will be sent for invitation to sign. **Additional fee applies**|", alias="fkiUserlogintypeID") + fki_taxassignment_id: Annotated[int, Field(le=15, strict=True, ge=0)] = Field(description="The unique ID of the Taxassignment. Valid values: |Value|Description| |-|-| |1|No tax| |2|GST| |3|HST (ON)| |4|HST (NB)| |5|HST (NS)| |6|HST (NL)| |7|HST (PE)| |8|GST + QST (QC)| |9|GST + QST (QC) Non-Recoverable| |10|GST + PST (BC)| |11|GST + PST (SK)| |12|GST + RST (MB)| |13|GST + PST (BC) Non-Recoverable| |14|GST + PST (SK) Non-Recoverable| |15|GST + RST (MB) Non-Recoverable|", alias="fkiTaxassignmentID") + fki_secretquestion_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Secretquestion. Valid values: |Value|Description| |-|-| |1|The name of the hospital in which you were born| |2|The name of your grade school| |3|The last name of your favorite teacher| |4|Your favorite sports team| |5|Your favorite TV show| |6|Your favorite movie| |7|The name of the street on which you grew up| |8|The name of your first employer| |9|Your first car| |10|Your favorite food| |11|The name of your first pet| |12|Favorite musician/band| |13|What instrument you play| |14|Your father's middle name| |15|Your mother's maiden name| |16|Name of your eldest child| |17|Your spouse's middle name| |18|Favorite restaurant| |19|Childhood nickname| |20|Favorite vacation destination| |21|Your boat's name| |22|Date of Birth (YYYY-MM-DD)| |22|Secret Code| |22|Your reference code|", alias="fkiSecretquestionID") + e_ezsignsigner_logintype: Optional[StrictStr] = Field(default=None, description="The method the Ezsignsigner will authenticate to the signing platform. 1. **Password** means the Ezsignsigner will receive a secure link by email. 2. **PasswordPhone** means the Ezsignsigner will receive a secure link by email and will need to authenticate using SMS or Phone call. **Additional fee applies**. 3. **PasswordQuestion** means the Ezsignsigner will receive a secure link by email and will need to authenticate using a predefined question and answer. 4. **InPersonPhone** means the Ezsignsigner will only be able to sign \"In-Person\" and will need to authenticate using SMS or Phone call. No email will be sent for invitation to sign. **Additional fee applies**. 5. **InPerson** means the Ezsignsigner will only be able to sign \"In-Person\" and there won't be any authentication. No email will be sent for invitation to sign. Make sure you evaluate the risk of signature denial and at minimum, we recommend you use a handwritten signature type.", alias="eEzsignsignerLogintype") + s_ezsignsigner_secretanswer: Optional[StrictStr] = Field(default=None, description="The predefined answer to the secret question the Ezsignsigner will need to provide to successfully authenticate.", alias="sEzsignsignerSecretanswer") + __properties: ClassVar[List[str]] = ["fkiUserlogintypeID", "fkiTaxassignmentID", "fkiSecretquestionID", "eEzsignsignerLogintype", "sEzsignsignerSecretanswer"] + + @field_validator('e_ezsignsigner_logintype') def e_ezsignsigner_logintype_validate_enum(cls, value): """Validates the enum""" if value is None: @@ -43,47 +49,60 @@ def e_ezsignsigner_logintype_validate_enum(cls, value): raise ValueError("must be one of enum values ('Password', 'PasswordPhone', 'PasswordQuestion', 'InPersonPhone', 'InPerson')") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignsignerRequest: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignsignerRequest from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignsignerRequest: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignsignerRequest from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignsignerRequest.parse_obj(obj) - - _obj = EzsignsignerRequest.parse_obj({ - "fki_userlogintype_id": obj.get("fkiUserlogintypeID"), - "fki_taxassignment_id": obj.get("fkiTaxassignmentID"), - "fki_secretquestion_id": obj.get("fkiSecretquestionID"), - "e_ezsignsigner_logintype": obj.get("eEzsignsignerLogintype"), - "s_ezsignsigner_secretanswer": obj.get("sEzsignsignerSecretanswer") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "fkiUserlogintypeID": obj.get("fkiUserlogintypeID"), + "fkiTaxassignmentID": obj.get("fkiTaxassignmentID"), + "fkiSecretquestionID": obj.get("fkiSecretquestionID"), + "eEzsignsignerLogintype": obj.get("eEzsignsignerLogintype"), + "sEzsignsignerSecretanswer": obj.get("sEzsignsignerSecretanswer") }) return _obj diff --git a/eZmaxApi/models/ezsignsigner_request_compound.py b/eZmaxApi/models/ezsignsigner_request_compound.py index 03f6b56a3..4c37a956c 100644 --- a/eZmaxApi/models/ezsignsigner_request_compound.py +++ b/eZmaxApi/models/ezsignsigner_request_compound.py @@ -19,23 +19,29 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictStr, conint, validator +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictStr, field_validator +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.ezsignsigner_request_compound_contact import EzsignsignerRequestCompoundContact +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignsignerRequestCompound(BaseModel): """ - An Ezsignsigner Object and children to create a complete structure # noqa: E501 - """ - fki_userlogintype_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiUserlogintypeID", description="The unique ID of the Userlogintype Valid values: |Value|Description|Detail| |-|-|-| |1|**Email Only**|The Ezsignsigner will receive a secure link by email| |2|**Email and phone or SMS**|The Ezsignsigner will receive a secure link by email and will need to authenticate using SMS or Phone call. **Additional fee applies**| |3|**Email and secret question**|The Ezsignsigner will receive a secure link by email and will need to authenticate using a predefined question and answer| |4|**In person only**|The Ezsignsigner will only be able to sign \"In-Person\" and there won't be any authentication. No email will be sent for invitation to sign. Make sure you evaluate the risk of signature denial and at minimum, we recommend you use a handwritten signature type| |5|**In person with phone or SMS**|The Ezsignsigner will only be able to sign \"In-Person\" and will need to authenticate using SMS or Phone call. No email will be sent for invitation to sign. **Additional fee applies**|") - fki_taxassignment_id: conint(strict=True, le=15, ge=0) = Field(..., alias="fkiTaxassignmentID", description="The unique ID of the Taxassignment. Valid values: |Value|Description| |-|-| |1|No tax| |2|GST| |3|HST (ON)| |4|HST (NB)| |5|HST (NS)| |6|HST (NL)| |7|HST (PE)| |8|GST + QST (QC)| |9|GST + QST (QC) Non-Recoverable| |10|GST + PST (BC)| |11|GST + PST (SK)| |12|GST + RST (MB)| |13|GST + PST (BC) Non-Recoverable| |14|GST + PST (SK) Non-Recoverable| |15|GST + RST (MB) Non-Recoverable|") - fki_secretquestion_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiSecretquestionID", description="The unique ID of the Secretquestion. Valid values: |Value|Description| |-|-| |1|The name of the hospital in which you were born| |2|The name of your grade school| |3|The last name of your favorite teacher| |4|Your favorite sports team| |5|Your favorite TV show| |6|Your favorite movie| |7|The name of the street on which you grew up| |8|The name of your first employer| |9|Your first car| |10|Your favorite food| |11|The name of your first pet| |12|Favorite musician/band| |13|What instrument you play| |14|Your father's middle name| |15|Your mother's maiden name| |16|Name of your eldest child| |17|Your spouse's middle name| |18|Favorite restaurant| |19|Childhood nickname| |20|Favorite vacation destination| |21|Your boat's name| |22|Date of Birth (YYYY-MM-DD)| |22|Secret Code| |22|Your reference code|") - e_ezsignsigner_logintype: Optional[StrictStr] = Field(None, alias="eEzsignsignerLogintype", description="The method the Ezsignsigner will authenticate to the signing platform. 1. **Password** means the Ezsignsigner will receive a secure link by email. 2. **PasswordPhone** means the Ezsignsigner will receive a secure link by email and will need to authenticate using SMS or Phone call. **Additional fee applies**. 3. **PasswordQuestion** means the Ezsignsigner will receive a secure link by email and will need to authenticate using a predefined question and answer. 4. **InPersonPhone** means the Ezsignsigner will only be able to sign \"In-Person\" and will need to authenticate using SMS or Phone call. No email will be sent for invitation to sign. **Additional fee applies**. 5. **InPerson** means the Ezsignsigner will only be able to sign \"In-Person\" and there won't be any authentication. No email will be sent for invitation to sign. Make sure you evaluate the risk of signature denial and at minimum, we recommend you use a handwritten signature type.") - s_ezsignsigner_secretanswer: Optional[StrictStr] = Field(None, alias="sEzsignsignerSecretanswer", description="The predefined answer to the secret question the Ezsignsigner will need to provide to successfully authenticate.") - obj_contact: EzsignsignerRequestCompoundContact = Field(..., alias="objContact") - __properties = ["fkiUserlogintypeID", "fkiTaxassignmentID", "fkiSecretquestionID", "eEzsignsignerLogintype", "sEzsignsignerSecretanswer", "objContact"] - - @validator('e_ezsignsigner_logintype') + An Ezsignsigner Object and children to create a complete structure + """ # noqa: E501 + fki_userlogintype_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Userlogintype Valid values: |Value|Description|Detail| |-|-|-| |1|**Email Only**|The Ezsignsigner will receive a secure link by email| |2|**Email and phone or SMS**|The Ezsignsigner will receive a secure link by email and will need to authenticate using SMS or Phone call. **Additional fee applies**| |3|**Email and secret question**|The Ezsignsigner will receive a secure link by email and will need to authenticate using a predefined question and answer| |4|**In person only**|The Ezsignsigner will only be able to sign \"In-Person\" and there won't be any authentication. No email will be sent for invitation to sign. Make sure you evaluate the risk of signature denial and at minimum, we recommend you use a handwritten signature type| |5|**In person with phone or SMS**|The Ezsignsigner will only be able to sign \"In-Person\" and will need to authenticate using SMS or Phone call. No email will be sent for invitation to sign. **Additional fee applies**|", alias="fkiUserlogintypeID") + fki_taxassignment_id: Annotated[int, Field(le=15, strict=True, ge=0)] = Field(description="The unique ID of the Taxassignment. Valid values: |Value|Description| |-|-| |1|No tax| |2|GST| |3|HST (ON)| |4|HST (NB)| |5|HST (NS)| |6|HST (NL)| |7|HST (PE)| |8|GST + QST (QC)| |9|GST + QST (QC) Non-Recoverable| |10|GST + PST (BC)| |11|GST + PST (SK)| |12|GST + RST (MB)| |13|GST + PST (BC) Non-Recoverable| |14|GST + PST (SK) Non-Recoverable| |15|GST + RST (MB) Non-Recoverable|", alias="fkiTaxassignmentID") + fki_secretquestion_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Secretquestion. Valid values: |Value|Description| |-|-| |1|The name of the hospital in which you were born| |2|The name of your grade school| |3|The last name of your favorite teacher| |4|Your favorite sports team| |5|Your favorite TV show| |6|Your favorite movie| |7|The name of the street on which you grew up| |8|The name of your first employer| |9|Your first car| |10|Your favorite food| |11|The name of your first pet| |12|Favorite musician/band| |13|What instrument you play| |14|Your father's middle name| |15|Your mother's maiden name| |16|Name of your eldest child| |17|Your spouse's middle name| |18|Favorite restaurant| |19|Childhood nickname| |20|Favorite vacation destination| |21|Your boat's name| |22|Date of Birth (YYYY-MM-DD)| |22|Secret Code| |22|Your reference code|", alias="fkiSecretquestionID") + e_ezsignsigner_logintype: Optional[StrictStr] = Field(default=None, description="The method the Ezsignsigner will authenticate to the signing platform. 1. **Password** means the Ezsignsigner will receive a secure link by email. 2. **PasswordPhone** means the Ezsignsigner will receive a secure link by email and will need to authenticate using SMS or Phone call. **Additional fee applies**. 3. **PasswordQuestion** means the Ezsignsigner will receive a secure link by email and will need to authenticate using a predefined question and answer. 4. **InPersonPhone** means the Ezsignsigner will only be able to sign \"In-Person\" and will need to authenticate using SMS or Phone call. No email will be sent for invitation to sign. **Additional fee applies**. 5. **InPerson** means the Ezsignsigner will only be able to sign \"In-Person\" and there won't be any authentication. No email will be sent for invitation to sign. Make sure you evaluate the risk of signature denial and at minimum, we recommend you use a handwritten signature type.", alias="eEzsignsignerLogintype") + s_ezsignsigner_secretanswer: Optional[StrictStr] = Field(default=None, description="The predefined answer to the secret question the Ezsignsigner will need to provide to successfully authenticate.", alias="sEzsignsignerSecretanswer") + obj_contact: EzsignsignerRequestCompoundContact = Field(alias="objContact") + __properties: ClassVar[List[str]] = ["fkiUserlogintypeID", "fkiTaxassignmentID", "fkiSecretquestionID", "eEzsignsignerLogintype", "sEzsignsignerSecretanswer", "objContact"] + + @field_validator('e_ezsignsigner_logintype') def e_ezsignsigner_logintype_validate_enum(cls, value): """Validates the enum""" if value is None: @@ -45,51 +51,64 @@ def e_ezsignsigner_logintype_validate_enum(cls, value): raise ValueError("must be one of enum values ('Password', 'PasswordPhone', 'PasswordQuestion', 'InPersonPhone', 'InPerson')") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignsignerRequestCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignsignerRequestCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_contact if self.obj_contact: _dict['objContact'] = self.obj_contact.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignsignerRequestCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignsignerRequestCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignsignerRequestCompound.parse_obj(obj) - - _obj = EzsignsignerRequestCompound.parse_obj({ - "fki_userlogintype_id": obj.get("fkiUserlogintypeID"), - "fki_taxassignment_id": obj.get("fkiTaxassignmentID"), - "fki_secretquestion_id": obj.get("fkiSecretquestionID"), - "e_ezsignsigner_logintype": obj.get("eEzsignsignerLogintype"), - "s_ezsignsigner_secretanswer": obj.get("sEzsignsignerSecretanswer"), - "obj_contact": EzsignsignerRequestCompoundContact.from_dict(obj.get("objContact")) if obj.get("objContact") is not None else None + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "fkiUserlogintypeID": obj.get("fkiUserlogintypeID"), + "fkiTaxassignmentID": obj.get("fkiTaxassignmentID"), + "fkiSecretquestionID": obj.get("fkiSecretquestionID"), + "eEzsignsignerLogintype": obj.get("eEzsignsignerLogintype"), + "sEzsignsignerSecretanswer": obj.get("sEzsignsignerSecretanswer"), + "objContact": EzsignsignerRequestCompoundContact.from_dict(obj.get("objContact")) if obj.get("objContact") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignsigner_request_compound_contact.py b/eZmaxApi/models/ezsignsigner_request_compound_contact.py index a032d4eed..566cac4d2 100644 --- a/eZmaxApi/models/ezsignsigner_request_compound_contact.py +++ b/eZmaxApi/models/ezsignsigner_request_compound_contact.py @@ -19,25 +19,31 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictStr, conint, constr, validator +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictStr, field_validator +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignsignerRequestCompoundContact(BaseModel): """ - A Ezsignsigner->Contact Object and children to create a complete structure # noqa: E501 - """ - s_contact_firstname: StrictStr = Field(..., alias="sContactFirstname", description="The First name of the contact") - s_contact_lastname: StrictStr = Field(..., alias="sContactLastname", description="The Last name of the contact") - fki_language_id: conint(strict=True, le=2, ge=1) = Field(..., alias="fkiLanguageID", description="The unique ID of the Language. Valid values: |Value|Description| |-|-| |1|French| |2|English|") - s_email_address: Optional[StrictStr] = Field(None, alias="sEmailAddress", description="The email address.") - s_phone_e164: Optional[constr(strict=True)] = Field(None, alias="sPhoneE164", description="A phone number in E.164 Format") - s_phone_extension: Optional[StrictStr] = Field(None, alias="sPhoneExtension", description="The extension of the phone number. The extension is the \"123\" section in this sample phone number: (514) 990-1516 x123. It can also be used with international phone numbers") - s_phone_e164_cell: Optional[constr(strict=True)] = Field(None, alias="sPhoneE164Cell", description="A phone number in E.164 Format") - s_phone_number: Optional[StrictStr] = Field(None, alias="sPhoneNumber") - s_phone_number_cell: Optional[StrictStr] = Field(None, alias="sPhoneNumberCell") - __properties = ["sContactFirstname", "sContactLastname", "fkiLanguageID", "sEmailAddress", "sPhoneE164", "sPhoneExtension", "sPhoneE164Cell", "sPhoneNumber", "sPhoneNumberCell"] - - @validator('s_phone_e164') + A Ezsignsigner->Contact Object and children to create a complete structure + """ # noqa: E501 + s_contact_firstname: StrictStr = Field(description="The First name of the contact", alias="sContactFirstname") + s_contact_lastname: StrictStr = Field(description="The Last name of the contact", alias="sContactLastname") + fki_language_id: Annotated[int, Field(le=2, strict=True, ge=1)] = Field(description="The unique ID of the Language. Valid values: |Value|Description| |-|-| |1|French| |2|English|", alias="fkiLanguageID") + s_email_address: Optional[StrictStr] = Field(default=None, description="The email address.", alias="sEmailAddress") + s_phone_e164: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="A phone number in E.164 Format", alias="sPhoneE164") + s_phone_extension: Optional[StrictStr] = Field(default=None, description="The extension of the phone number. The extension is the \"123\" section in this sample phone number: (514) 990-1516 x123. It can also be used with international phone numbers", alias="sPhoneExtension") + s_phone_e164_cell: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="A phone number in E.164 Format", alias="sPhoneE164Cell") + s_phone_number: Optional[StrictStr] = Field(default=None, alias="sPhoneNumber") + s_phone_number_cell: Optional[StrictStr] = Field(default=None, alias="sPhoneNumberCell") + __properties: ClassVar[List[str]] = ["sContactFirstname", "sContactLastname", "fkiLanguageID", "sEmailAddress", "sPhoneE164", "sPhoneExtension", "sPhoneE164Cell", "sPhoneNumber", "sPhoneNumberCell"] + + @field_validator('s_phone_e164') def s_phone_e164_validate_regular_expression(cls, value): """Validates the regular expression""" if value is None: @@ -47,7 +53,7 @@ def s_phone_e164_validate_regular_expression(cls, value): raise ValueError(r"must validate the regular expression /^\+[1-9]\d{1,14}$/") return value - @validator('s_phone_e164_cell') + @field_validator('s_phone_e164_cell') def s_phone_e164_cell_validate_regular_expression(cls, value): """Validates the regular expression""" if value is None: @@ -57,51 +63,64 @@ def s_phone_e164_cell_validate_regular_expression(cls, value): raise ValueError(r"must validate the regular expression /^\+[1-9]\d{1,14}$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignsignerRequestCompoundContact: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignsignerRequestCompoundContact from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignsignerRequestCompoundContact: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignsignerRequestCompoundContact from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignsignerRequestCompoundContact.parse_obj(obj) - - _obj = EzsignsignerRequestCompoundContact.parse_obj({ - "s_contact_firstname": obj.get("sContactFirstname"), - "s_contact_lastname": obj.get("sContactLastname"), - "fki_language_id": obj.get("fkiLanguageID"), - "s_email_address": obj.get("sEmailAddress"), - "s_phone_e164": obj.get("sPhoneE164"), - "s_phone_extension": obj.get("sPhoneExtension"), - "s_phone_e164_cell": obj.get("sPhoneE164Cell"), - "s_phone_number": obj.get("sPhoneNumber"), - "s_phone_number_cell": obj.get("sPhoneNumberCell") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "sContactFirstname": obj.get("sContactFirstname"), + "sContactLastname": obj.get("sContactLastname"), + "fkiLanguageID": obj.get("fkiLanguageID"), + "sEmailAddress": obj.get("sEmailAddress"), + "sPhoneE164": obj.get("sPhoneE164"), + "sPhoneExtension": obj.get("sPhoneExtension"), + "sPhoneE164Cell": obj.get("sPhoneE164Cell"), + "sPhoneNumber": obj.get("sPhoneNumber"), + "sPhoneNumberCell": obj.get("sPhoneNumberCell") }) return _obj diff --git a/eZmaxApi/models/ezsignsigner_response.py b/eZmaxApi/models/ezsignsigner_response.py index 51bf0b31d..b0171e1e4 100644 --- a/eZmaxApi/models/ezsignsigner_response.py +++ b/eZmaxApi/models/ezsignsigner_response.py @@ -19,61 +19,80 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictStr, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictStr +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignsignerResponse(BaseModel): """ - An Ezsignsigner Object # noqa: E501 - """ - pki_ezsignsigner_id: conint(strict=True, ge=0) = Field(..., alias="pkiEzsignsignerID", description="The unique ID of the Ezsignsigner") - fki_taxassignment_id: conint(strict=True, le=15, ge=0) = Field(..., alias="fkiTaxassignmentID", description="The unique ID of the Taxassignment. Valid values: |Value|Description| |-|-| |1|No tax| |2|GST| |3|HST (ON)| |4|HST (NB)| |5|HST (NS)| |6|HST (NL)| |7|HST (PE)| |8|GST + QST (QC)| |9|GST + QST (QC) Non-Recoverable| |10|GST + PST (BC)| |11|GST + PST (SK)| |12|GST + RST (MB)| |13|GST + PST (BC) Non-Recoverable| |14|GST + PST (SK) Non-Recoverable| |15|GST + RST (MB) Non-Recoverable|") - fki_secretquestion_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiSecretquestionID", description="The unique ID of the Secretquestion. Valid values: |Value|Description| |-|-| |1|The name of the hospital in which you were born| |2|The name of your grade school| |3|The last name of your favorite teacher| |4|Your favorite sports team| |5|Your favorite TV show| |6|Your favorite movie| |7|The name of the street on which you grew up| |8|The name of your first employer| |9|Your first car| |10|Your favorite food| |11|The name of your first pet| |12|Favorite musician/band| |13|What instrument you play| |14|Your father's middle name| |15|Your mother's maiden name| |16|Name of your eldest child| |17|Your spouse's middle name| |18|Favorite restaurant| |19|Childhood nickname| |20|Favorite vacation destination| |21|Your boat's name| |22|Date of Birth (YYYY-MM-DD)| |22|Secret Code| |22|Your reference code|") - fki_userlogintype_id: conint(strict=True, ge=0) = Field(..., alias="fkiUserlogintypeID", description="The unique ID of the Userlogintype Valid values: |Value|Description|Detail| |-|-|-| |1|**Email Only**|The Ezsignsigner will receive a secure link by email| |2|**Email and phone or SMS**|The Ezsignsigner will receive a secure link by email and will need to authenticate using SMS or Phone call. **Additional fee applies**| |3|**Email and secret question**|The Ezsignsigner will receive a secure link by email and will need to authenticate using a predefined question and answer| |4|**In person only**|The Ezsignsigner will only be able to sign \"In-Person\" and there won't be any authentication. No email will be sent for invitation to sign. Make sure you evaluate the risk of signature denial and at minimum, we recommend you use a handwritten signature type| |5|**In person with phone or SMS**|The Ezsignsigner will only be able to sign \"In-Person\" and will need to authenticate using SMS or Phone call. No email will be sent for invitation to sign. **Additional fee applies**|") - s_userlogintype_description_x: StrictStr = Field(..., alias="sUserlogintypeDescriptionX", description="The description of the Userlogintype in the language of the requester") - __properties = ["pkiEzsignsignerID", "fkiTaxassignmentID", "fkiSecretquestionID", "fkiUserlogintypeID", "sUserlogintypeDescriptionX"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + An Ezsignsigner Object + """ # noqa: E501 + pki_ezsignsigner_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsignsigner", alias="pkiEzsignsignerID") + fki_taxassignment_id: Annotated[int, Field(le=15, strict=True, ge=0)] = Field(description="The unique ID of the Taxassignment. Valid values: |Value|Description| |-|-| |1|No tax| |2|GST| |3|HST (ON)| |4|HST (NB)| |5|HST (NS)| |6|HST (NL)| |7|HST (PE)| |8|GST + QST (QC)| |9|GST + QST (QC) Non-Recoverable| |10|GST + PST (BC)| |11|GST + PST (SK)| |12|GST + RST (MB)| |13|GST + PST (BC) Non-Recoverable| |14|GST + PST (SK) Non-Recoverable| |15|GST + RST (MB) Non-Recoverable|", alias="fkiTaxassignmentID") + fki_secretquestion_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Secretquestion. Valid values: |Value|Description| |-|-| |1|The name of the hospital in which you were born| |2|The name of your grade school| |3|The last name of your favorite teacher| |4|Your favorite sports team| |5|Your favorite TV show| |6|Your favorite movie| |7|The name of the street on which you grew up| |8|The name of your first employer| |9|Your first car| |10|Your favorite food| |11|The name of your first pet| |12|Favorite musician/band| |13|What instrument you play| |14|Your father's middle name| |15|Your mother's maiden name| |16|Name of your eldest child| |17|Your spouse's middle name| |18|Favorite restaurant| |19|Childhood nickname| |20|Favorite vacation destination| |21|Your boat's name| |22|Date of Birth (YYYY-MM-DD)| |22|Secret Code| |22|Your reference code|", alias="fkiSecretquestionID") + fki_userlogintype_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Userlogintype Valid values: |Value|Description|Detail| |-|-|-| |1|**Email Only**|The Ezsignsigner will receive a secure link by email| |2|**Email and phone or SMS**|The Ezsignsigner will receive a secure link by email and will need to authenticate using SMS or Phone call. **Additional fee applies**| |3|**Email and secret question**|The Ezsignsigner will receive a secure link by email and will need to authenticate using a predefined question and answer| |4|**In person only**|The Ezsignsigner will only be able to sign \"In-Person\" and there won't be any authentication. No email will be sent for invitation to sign. Make sure you evaluate the risk of signature denial and at minimum, we recommend you use a handwritten signature type| |5|**In person with phone or SMS**|The Ezsignsigner will only be able to sign \"In-Person\" and will need to authenticate using SMS or Phone call. No email will be sent for invitation to sign. **Additional fee applies**|", alias="fkiUserlogintypeID") + s_userlogintype_description_x: StrictStr = Field(description="The description of the Userlogintype in the language of the requester", alias="sUserlogintypeDescriptionX") + __properties: ClassVar[List[str]] = ["pkiEzsignsignerID", "fkiTaxassignmentID", "fkiSecretquestionID", "fkiUserlogintypeID", "sUserlogintypeDescriptionX"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignsignerResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignsignerResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignsignerResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignsignerResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignsignerResponse.parse_obj(obj) - - _obj = EzsignsignerResponse.parse_obj({ - "pki_ezsignsigner_id": obj.get("pkiEzsignsignerID"), - "fki_taxassignment_id": obj.get("fkiTaxassignmentID"), - "fki_secretquestion_id": obj.get("fkiSecretquestionID"), - "fki_userlogintype_id": obj.get("fkiUserlogintypeID"), - "s_userlogintype_description_x": obj.get("sUserlogintypeDescriptionX") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsignsignerID": obj.get("pkiEzsignsignerID"), + "fkiTaxassignmentID": obj.get("fkiTaxassignmentID"), + "fkiSecretquestionID": obj.get("fkiSecretquestionID"), + "fkiUserlogintypeID": obj.get("fkiUserlogintypeID"), + "sUserlogintypeDescriptionX": obj.get("sUserlogintypeDescriptionX") }) return _obj diff --git a/eZmaxApi/models/ezsignsigner_response_compound.py b/eZmaxApi/models/ezsignsigner_response_compound.py index f5ea4606a..8f50a8d14 100644 --- a/eZmaxApi/models/ezsignsigner_response_compound.py +++ b/eZmaxApi/models/ezsignsigner_response_compound.py @@ -19,67 +19,86 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictStr, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictStr +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.ezsignsigner_response_compound_contact import EzsignsignerResponseCompoundContact +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignsignerResponseCompound(BaseModel): """ - An Ezsignsigner Object and children to create a complete structure # noqa: E501 - """ - pki_ezsignsigner_id: conint(strict=True, ge=0) = Field(..., alias="pkiEzsignsignerID", description="The unique ID of the Ezsignsigner") - fki_taxassignment_id: conint(strict=True, le=15, ge=0) = Field(..., alias="fkiTaxassignmentID", description="The unique ID of the Taxassignment. Valid values: |Value|Description| |-|-| |1|No tax| |2|GST| |3|HST (ON)| |4|HST (NB)| |5|HST (NS)| |6|HST (NL)| |7|HST (PE)| |8|GST + QST (QC)| |9|GST + QST (QC) Non-Recoverable| |10|GST + PST (BC)| |11|GST + PST (SK)| |12|GST + RST (MB)| |13|GST + PST (BC) Non-Recoverable| |14|GST + PST (SK) Non-Recoverable| |15|GST + RST (MB) Non-Recoverable|") - fki_secretquestion_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiSecretquestionID", description="The unique ID of the Secretquestion. Valid values: |Value|Description| |-|-| |1|The name of the hospital in which you were born| |2|The name of your grade school| |3|The last name of your favorite teacher| |4|Your favorite sports team| |5|Your favorite TV show| |6|Your favorite movie| |7|The name of the street on which you grew up| |8|The name of your first employer| |9|Your first car| |10|Your favorite food| |11|The name of your first pet| |12|Favorite musician/band| |13|What instrument you play| |14|Your father's middle name| |15|Your mother's maiden name| |16|Name of your eldest child| |17|Your spouse's middle name| |18|Favorite restaurant| |19|Childhood nickname| |20|Favorite vacation destination| |21|Your boat's name| |22|Date of Birth (YYYY-MM-DD)| |22|Secret Code| |22|Your reference code|") - fki_userlogintype_id: conint(strict=True, ge=0) = Field(..., alias="fkiUserlogintypeID", description="The unique ID of the Userlogintype Valid values: |Value|Description|Detail| |-|-|-| |1|**Email Only**|The Ezsignsigner will receive a secure link by email| |2|**Email and phone or SMS**|The Ezsignsigner will receive a secure link by email and will need to authenticate using SMS or Phone call. **Additional fee applies**| |3|**Email and secret question**|The Ezsignsigner will receive a secure link by email and will need to authenticate using a predefined question and answer| |4|**In person only**|The Ezsignsigner will only be able to sign \"In-Person\" and there won't be any authentication. No email will be sent for invitation to sign. Make sure you evaluate the risk of signature denial and at minimum, we recommend you use a handwritten signature type| |5|**In person with phone or SMS**|The Ezsignsigner will only be able to sign \"In-Person\" and will need to authenticate using SMS or Phone call. No email will be sent for invitation to sign. **Additional fee applies**|") - s_userlogintype_description_x: StrictStr = Field(..., alias="sUserlogintypeDescriptionX", description="The description of the Userlogintype in the language of the requester") - obj_contact: EzsignsignerResponseCompoundContact = Field(..., alias="objContact") - __properties = ["pkiEzsignsignerID", "fkiTaxassignmentID", "fkiSecretquestionID", "fkiUserlogintypeID", "sUserlogintypeDescriptionX", "objContact"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + An Ezsignsigner Object and children to create a complete structure + """ # noqa: E501 + pki_ezsignsigner_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsignsigner", alias="pkiEzsignsignerID") + fki_taxassignment_id: Annotated[int, Field(le=15, strict=True, ge=0)] = Field(description="The unique ID of the Taxassignment. Valid values: |Value|Description| |-|-| |1|No tax| |2|GST| |3|HST (ON)| |4|HST (NB)| |5|HST (NS)| |6|HST (NL)| |7|HST (PE)| |8|GST + QST (QC)| |9|GST + QST (QC) Non-Recoverable| |10|GST + PST (BC)| |11|GST + PST (SK)| |12|GST + RST (MB)| |13|GST + PST (BC) Non-Recoverable| |14|GST + PST (SK) Non-Recoverable| |15|GST + RST (MB) Non-Recoverable|", alias="fkiTaxassignmentID") + fki_secretquestion_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Secretquestion. Valid values: |Value|Description| |-|-| |1|The name of the hospital in which you were born| |2|The name of your grade school| |3|The last name of your favorite teacher| |4|Your favorite sports team| |5|Your favorite TV show| |6|Your favorite movie| |7|The name of the street on which you grew up| |8|The name of your first employer| |9|Your first car| |10|Your favorite food| |11|The name of your first pet| |12|Favorite musician/band| |13|What instrument you play| |14|Your father's middle name| |15|Your mother's maiden name| |16|Name of your eldest child| |17|Your spouse's middle name| |18|Favorite restaurant| |19|Childhood nickname| |20|Favorite vacation destination| |21|Your boat's name| |22|Date of Birth (YYYY-MM-DD)| |22|Secret Code| |22|Your reference code|", alias="fkiSecretquestionID") + fki_userlogintype_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Userlogintype Valid values: |Value|Description|Detail| |-|-|-| |1|**Email Only**|The Ezsignsigner will receive a secure link by email| |2|**Email and phone or SMS**|The Ezsignsigner will receive a secure link by email and will need to authenticate using SMS or Phone call. **Additional fee applies**| |3|**Email and secret question**|The Ezsignsigner will receive a secure link by email and will need to authenticate using a predefined question and answer| |4|**In person only**|The Ezsignsigner will only be able to sign \"In-Person\" and there won't be any authentication. No email will be sent for invitation to sign. Make sure you evaluate the risk of signature denial and at minimum, we recommend you use a handwritten signature type| |5|**In person with phone or SMS**|The Ezsignsigner will only be able to sign \"In-Person\" and will need to authenticate using SMS or Phone call. No email will be sent for invitation to sign. **Additional fee applies**|", alias="fkiUserlogintypeID") + s_userlogintype_description_x: StrictStr = Field(description="The description of the Userlogintype in the language of the requester", alias="sUserlogintypeDescriptionX") + obj_contact: EzsignsignerResponseCompoundContact = Field(alias="objContact") + __properties: ClassVar[List[str]] = ["pkiEzsignsignerID", "fkiTaxassignmentID", "fkiSecretquestionID", "fkiUserlogintypeID", "sUserlogintypeDescriptionX", "objContact"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignsignerResponseCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignsignerResponseCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_contact if self.obj_contact: _dict['objContact'] = self.obj_contact.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignsignerResponseCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignsignerResponseCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignsignerResponseCompound.parse_obj(obj) - - _obj = EzsignsignerResponseCompound.parse_obj({ - "pki_ezsignsigner_id": obj.get("pkiEzsignsignerID"), - "fki_taxassignment_id": obj.get("fkiTaxassignmentID"), - "fki_secretquestion_id": obj.get("fkiSecretquestionID"), - "fki_userlogintype_id": obj.get("fkiUserlogintypeID"), - "s_userlogintype_description_x": obj.get("sUserlogintypeDescriptionX"), - "obj_contact": EzsignsignerResponseCompoundContact.from_dict(obj.get("objContact")) if obj.get("objContact") is not None else None + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsignsignerID": obj.get("pkiEzsignsignerID"), + "fkiTaxassignmentID": obj.get("fkiTaxassignmentID"), + "fkiSecretquestionID": obj.get("fkiSecretquestionID"), + "fkiUserlogintypeID": obj.get("fkiUserlogintypeID"), + "sUserlogintypeDescriptionX": obj.get("sUserlogintypeDescriptionX"), + "objContact": EzsignsignerResponseCompoundContact.from_dict(obj.get("objContact")) if obj.get("objContact") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignsigner_response_compound_contact.py b/eZmaxApi/models/ezsignsigner_response_compound_contact.py index ff6042dd3..9078b01de 100644 --- a/eZmaxApi/models/ezsignsigner_response_compound_contact.py +++ b/eZmaxApi/models/ezsignsigner_response_compound_contact.py @@ -19,24 +19,30 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictStr, conint, constr, validator +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictStr, field_validator +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignsignerResponseCompoundContact(BaseModel): """ - A Ezsignsigner->Contact Object and children to create a complete structure # noqa: E501 - """ - pki_contact_id: conint(strict=True, ge=0) = Field(..., alias="pkiContactID", description="The unique ID of the Contact") - s_contact_firstname: StrictStr = Field(..., alias="sContactFirstname", description="The First name of the contact") - s_contact_lastname: StrictStr = Field(..., alias="sContactLastname", description="The Last name of the contact") - fki_language_id: conint(strict=True, le=2, ge=1) = Field(..., alias="fkiLanguageID", description="The unique ID of the Language. Valid values: |Value|Description| |-|-| |1|French| |2|English|") - s_email_address: Optional[StrictStr] = Field(None, alias="sEmailAddress", description="The email address.") - s_phone_e164: Optional[constr(strict=True)] = Field(None, alias="sPhoneE164", description="A phone number in E.164 Format") - s_phone_extension: Optional[StrictStr] = Field(None, alias="sPhoneExtension", description="The extension of the phone number. The extension is the \"123\" section in this sample phone number: (514) 990-1516 x123. It can also be used with international phone numbers") - s_phone_e164_cell: Optional[constr(strict=True)] = Field(None, alias="sPhoneE164Cell", description="A phone number in E.164 Format") - __properties = ["pkiContactID", "sContactFirstname", "sContactLastname", "fkiLanguageID", "sEmailAddress", "sPhoneE164", "sPhoneExtension", "sPhoneE164Cell"] - - @validator('s_phone_e164') + A Ezsignsigner->Contact Object and children to create a complete structure + """ # noqa: E501 + pki_contact_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Contact", alias="pkiContactID") + s_contact_firstname: StrictStr = Field(description="The First name of the contact", alias="sContactFirstname") + s_contact_lastname: StrictStr = Field(description="The Last name of the contact", alias="sContactLastname") + fki_language_id: Annotated[int, Field(le=2, strict=True, ge=1)] = Field(description="The unique ID of the Language. Valid values: |Value|Description| |-|-| |1|French| |2|English|", alias="fkiLanguageID") + s_email_address: Optional[StrictStr] = Field(default=None, description="The email address.", alias="sEmailAddress") + s_phone_e164: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="A phone number in E.164 Format", alias="sPhoneE164") + s_phone_extension: Optional[StrictStr] = Field(default=None, description="The extension of the phone number. The extension is the \"123\" section in this sample phone number: (514) 990-1516 x123. It can also be used with international phone numbers", alias="sPhoneExtension") + s_phone_e164_cell: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="A phone number in E.164 Format", alias="sPhoneE164Cell") + __properties: ClassVar[List[str]] = ["pkiContactID", "sContactFirstname", "sContactLastname", "fkiLanguageID", "sEmailAddress", "sPhoneE164", "sPhoneExtension", "sPhoneE164Cell"] + + @field_validator('s_phone_e164') def s_phone_e164_validate_regular_expression(cls, value): """Validates the regular expression""" if value is None: @@ -46,7 +52,7 @@ def s_phone_e164_validate_regular_expression(cls, value): raise ValueError(r"must validate the regular expression /^\+[1-9]\d{1,14}$/") return value - @validator('s_phone_e164_cell') + @field_validator('s_phone_e164_cell') def s_phone_e164_cell_validate_regular_expression(cls, value): """Validates the regular expression""" if value is None: @@ -56,50 +62,63 @@ def s_phone_e164_cell_validate_regular_expression(cls, value): raise ValueError(r"must validate the regular expression /^\+[1-9]\d{1,14}$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignsignerResponseCompoundContact: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignsignerResponseCompoundContact from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignsignerResponseCompoundContact: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignsignerResponseCompoundContact from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignsignerResponseCompoundContact.parse_obj(obj) - - _obj = EzsignsignerResponseCompoundContact.parse_obj({ - "pki_contact_id": obj.get("pkiContactID"), - "s_contact_firstname": obj.get("sContactFirstname"), - "s_contact_lastname": obj.get("sContactLastname"), - "fki_language_id": obj.get("fkiLanguageID"), - "s_email_address": obj.get("sEmailAddress"), - "s_phone_e164": obj.get("sPhoneE164"), - "s_phone_extension": obj.get("sPhoneExtension"), - "s_phone_e164_cell": obj.get("sPhoneE164Cell") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiContactID": obj.get("pkiContactID"), + "sContactFirstname": obj.get("sContactFirstname"), + "sContactLastname": obj.get("sContactLastname"), + "fkiLanguageID": obj.get("fkiLanguageID"), + "sEmailAddress": obj.get("sEmailAddress"), + "sPhoneE164": obj.get("sPhoneE164"), + "sPhoneExtension": obj.get("sPhoneExtension"), + "sPhoneE164Cell": obj.get("sPhoneE164Cell") }) return _obj diff --git a/eZmaxApi/models/ezsignsignergroup_create_object_v1_request.py b/eZmaxApi/models/ezsignsignergroup_create_object_v1_request.py index 6bbf892b9..e4208dfbf 100644 --- a/eZmaxApi/models/ezsignsignergroup_create_object_v1_request.py +++ b/eZmaxApi/models/ezsignsignergroup_create_object_v1_request.py @@ -19,41 +19,60 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.ezsignsignergroup_request_compound import EzsignsignergroupRequestCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignsignergroupCreateObjectV1Request(BaseModel): """ - Request for POST /1/object/ezsignsignergroup # noqa: E501 - """ - a_obj_ezsignsignergroup: conlist(EzsignsignergroupRequestCompound, min_items=1) = Field(..., alias="a_objEzsignsignergroup") - __properties = ["a_objEzsignsignergroup"] + Request for POST /1/object/ezsignsignergroup + """ # noqa: E501 + a_obj_ezsignsignergroup: Annotated[List[EzsignsignergroupRequestCompound], Field(min_length=1)] = Field(alias="a_objEzsignsignergroup") + __properties: ClassVar[List[str]] = ["a_objEzsignsignergroup"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignsignergroupCreateObjectV1Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignsignergroupCreateObjectV1Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_ezsignsignergroup (list) _items = [] if self.a_obj_ezsignsignergroup: @@ -64,16 +83,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignsignergroupCreateObjectV1Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignsignergroupCreateObjectV1Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignsignergroupCreateObjectV1Request.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignsignergroupCreateObjectV1Request.parse_obj({ - "a_obj_ezsignsignergroup": [EzsignsignergroupRequestCompound.from_dict(_item) for _item in obj.get("a_objEzsignsignergroup")] if obj.get("a_objEzsignsignergroup") is not None else None + _obj = cls.model_validate({ + "a_objEzsignsignergroup": [EzsignsignergroupRequestCompound.from_dict(_item) for _item in obj.get("a_objEzsignsignergroup")] if obj.get("a_objEzsignsignergroup") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignsignergroup_create_object_v1_response.py b/eZmaxApi/models/ezsignsignergroup_create_object_v1_response.py index c9d52c7d4..639ee6886 100644 --- a/eZmaxApi/models/ezsignsignergroup_create_object_v1_response.py +++ b/eZmaxApi/models/ezsignsignergroup_create_object_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.ezsignsignergroup_create_object_v1_response_m_payload import EzsignsignergroupCreateObjectV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignsignergroupCreateObjectV1Response(BaseModel): """ - Response for POST /1/object/ezsignsignergroup # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzsignsignergroupCreateObjectV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for POST /1/object/ezsignsignergroup + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsignsignergroupCreateObjectV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignsignergroupCreateObjectV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignsignergroupCreateObjectV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignsignergroupCreateObjectV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignsignergroupCreateObjectV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignsignergroupCreateObjectV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignsignergroupCreateObjectV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzsignsignergroupCreateObjectV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsignsignergroupCreateObjectV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignsignergroup_create_object_v1_response_m_payload.py b/eZmaxApi/models/ezsignsignergroup_create_object_v1_response_m_payload.py index b080a9f91..9e13510c1 100644 --- a/eZmaxApi/models/ezsignsignergroup_create_object_v1_response_m_payload.py +++ b/eZmaxApi/models/ezsignsignergroup_create_object_v1_response_m_payload.py @@ -19,53 +19,72 @@ import json -from typing import List -from pydantic import BaseModel, Field, conint, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignsignergroupCreateObjectV1ResponseMPayload(BaseModel): """ - Payload for POST /1/object/ezsignsignergroup # noqa: E501 - """ - a_pki_ezsignsignergroup_id: conlist(conint(strict=True, le=65535, ge=0)) = Field(..., alias="a_pkiEzsignsignergroupID", description="An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request.") - __properties = ["a_pkiEzsignsignergroupID"] + Payload for POST /1/object/ezsignsignergroup + """ # noqa: E501 + a_pki_ezsignsignergroup_id: List[Annotated[int, Field(le=65535, strict=True, ge=0)]] = Field(description="An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request.", alias="a_pkiEzsignsignergroupID") + __properties: ClassVar[List[str]] = ["a_pkiEzsignsignergroupID"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignsignergroupCreateObjectV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignsignergroupCreateObjectV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignsignergroupCreateObjectV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignsignergroupCreateObjectV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignsignergroupCreateObjectV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignsignergroupCreateObjectV1ResponseMPayload.parse_obj({ - "a_pki_ezsignsignergroup_id": obj.get("a_pkiEzsignsignergroupID") + _obj = cls.model_validate({ + "a_pkiEzsignsignergroupID": obj.get("a_pkiEzsignsignergroupID") }) return _obj diff --git a/eZmaxApi/models/ezsignsignergroup_delete_object_v1_response.py b/eZmaxApi/models/ezsignsignergroup_delete_object_v1_response.py index ec7598e0b..a1451b29c 100644 --- a/eZmaxApi/models/ezsignsignergroup_delete_object_v1_response.py +++ b/eZmaxApi/models/ezsignsignergroup_delete_object_v1_response.py @@ -19,43 +19,61 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignsignergroupDeleteObjectV1Response(BaseModel): """ - Response for DELETE /1/object/ezsignsignergroup/{pkiEzsignsignergroupID} # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - __properties = ["objDebugPayload", "objDebug"] + Response for DELETE /1/object/ezsignsignergroup/{pkiEzsignsignergroupID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignsignergroupDeleteObjectV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignsignergroupDeleteObjectV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -65,17 +83,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignsignergroupDeleteObjectV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignsignergroupDeleteObjectV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignsignergroupDeleteObjectV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignsignergroupDeleteObjectV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignsignergroup_edit_ezsignsignergroupmemberships_v1_request.py b/eZmaxApi/models/ezsignsignergroup_edit_ezsignsignergroupmemberships_v1_request.py index 4e7ced3f9..3ac591bba 100644 --- a/eZmaxApi/models/ezsignsignergroup_edit_ezsignsignergroupmemberships_v1_request.py +++ b/eZmaxApi/models/ezsignsignergroup_edit_ezsignsignergroupmemberships_v1_request.py @@ -19,41 +19,59 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.ezsignsignergroupmembership_request_compound import EzsignsignergroupmembershipRequestCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignsignergroupEditEzsignsignergroupmembershipsV1Request(BaseModel): """ - Request for PUT /1/object/ezsignsignergroup/{pkiEzsignsignergroupID}/editEzsignsignergroupmemberships # noqa: E501 - """ - a_obj_ezsignsignergroupmembership: conlist(EzsignsignergroupmembershipRequestCompound) = Field(..., alias="a_objEzsignsignergroupmembership") - __properties = ["a_objEzsignsignergroupmembership"] + Request for PUT /1/object/ezsignsignergroup/{pkiEzsignsignergroupID}/editEzsignsignergroupmemberships + """ # noqa: E501 + a_obj_ezsignsignergroupmembership: List[EzsignsignergroupmembershipRequestCompound] = Field(alias="a_objEzsignsignergroupmembership") + __properties: ClassVar[List[str]] = ["a_objEzsignsignergroupmembership"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignsignergroupEditEzsignsignergroupmembershipsV1Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignsignergroupEditEzsignsignergroupmembershipsV1Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_ezsignsignergroupmembership (list) _items = [] if self.a_obj_ezsignsignergroupmembership: @@ -64,16 +82,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignsignergroupEditEzsignsignergroupmembershipsV1Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignsignergroupEditEzsignsignergroupmembershipsV1Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignsignergroupEditEzsignsignergroupmembershipsV1Request.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignsignergroupEditEzsignsignergroupmembershipsV1Request.parse_obj({ - "a_obj_ezsignsignergroupmembership": [EzsignsignergroupmembershipRequestCompound.from_dict(_item) for _item in obj.get("a_objEzsignsignergroupmembership")] if obj.get("a_objEzsignsignergroupmembership") is not None else None + _obj = cls.model_validate({ + "a_objEzsignsignergroupmembership": [EzsignsignergroupmembershipRequestCompound.from_dict(_item) for _item in obj.get("a_objEzsignsignergroupmembership")] if obj.get("a_objEzsignsignergroupmembership") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignsignergroup_edit_ezsignsignergroupmemberships_v1_response.py b/eZmaxApi/models/ezsignsignergroup_edit_ezsignsignergroupmemberships_v1_response.py index 2f7c18aae..d0bd4886a 100644 --- a/eZmaxApi/models/ezsignsignergroup_edit_ezsignsignergroupmemberships_v1_response.py +++ b/eZmaxApi/models/ezsignsignergroup_edit_ezsignsignergroupmemberships_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.ezsignsignergroup_edit_ezsignsignergroupmemberships_v1_response_m_payload import EzsignsignergroupEditEzsignsignergroupmembershipsV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignsignergroupEditEzsignsignergroupmembershipsV1Response(BaseModel): """ - Response for PUT /1/object/ezsignsignergroup/{pkiEzsignsignergroupID}/editEzsignsignergroupmemberships # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzsignsignergroupEditEzsignsignergroupmembershipsV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for PUT /1/object/ezsignsignergroup/{pkiEzsignsignergroupID}/editEzsignsignergroupmemberships + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsignsignergroupEditEzsignsignergroupmembershipsV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignsignergroupEditEzsignsignergroupmembershipsV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignsignergroupEditEzsignsignergroupmembershipsV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignsignergroupEditEzsignsignergroupmembershipsV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignsignergroupEditEzsignsignergroupmembershipsV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignsignergroupEditEzsignsignergroupmembershipsV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignsignergroupEditEzsignsignergroupmembershipsV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzsignsignergroupEditEzsignsignergroupmembershipsV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsignsignergroupEditEzsignsignergroupmembershipsV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignsignergroup_edit_ezsignsignergroupmemberships_v1_response_m_payload.py b/eZmaxApi/models/ezsignsignergroup_edit_ezsignsignergroupmemberships_v1_response_m_payload.py index 1f1e6c697..4d9125ab1 100644 --- a/eZmaxApi/models/ezsignsignergroup_edit_ezsignsignergroupmemberships_v1_response_m_payload.py +++ b/eZmaxApi/models/ezsignsignergroup_edit_ezsignsignergroupmemberships_v1_response_m_payload.py @@ -19,53 +19,72 @@ import json -from typing import List -from pydantic import BaseModel, Field, conint, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignsignergroupEditEzsignsignergroupmembershipsV1ResponseMPayload(BaseModel): """ - Response for PUT /1/object/ezsignsignergroup/{pkiEzsignsignergroupID}/editEzsignsignergroupmemberships # noqa: E501 - """ - a_pki_ezsignsignergroupmembership_id: conlist(conint(strict=True, le=16777215, ge=0)) = Field(..., alias="a_pkiEzsignsignergroupmembershipID") - __properties = ["a_pkiEzsignsignergroupmembershipID"] + Response for PUT /1/object/ezsignsignergroup/{pkiEzsignsignergroupID}/editEzsignsignergroupmemberships + """ # noqa: E501 + a_pki_ezsignsignergroupmembership_id: List[Annotated[int, Field(le=16777215, strict=True, ge=0)]] = Field(alias="a_pkiEzsignsignergroupmembershipID") + __properties: ClassVar[List[str]] = ["a_pkiEzsignsignergroupmembershipID"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignsignergroupEditEzsignsignergroupmembershipsV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignsignergroupEditEzsignsignergroupmembershipsV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignsignergroupEditEzsignsignergroupmembershipsV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignsignergroupEditEzsignsignergroupmembershipsV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignsignergroupEditEzsignsignergroupmembershipsV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignsignergroupEditEzsignsignergroupmembershipsV1ResponseMPayload.parse_obj({ - "a_pki_ezsignsignergroupmembership_id": obj.get("a_pkiEzsignsignergroupmembershipID") + _obj = cls.model_validate({ + "a_pkiEzsignsignergroupmembershipID": obj.get("a_pkiEzsignsignergroupmembershipID") }) return _obj diff --git a/eZmaxApi/models/ezsignsignergroup_edit_object_v1_request.py b/eZmaxApi/models/ezsignsignergroup_edit_object_v1_request.py index fc3d86eae..3a7eb0c8b 100644 --- a/eZmaxApi/models/ezsignsignergroup_edit_object_v1_request.py +++ b/eZmaxApi/models/ezsignsignergroup_edit_object_v1_request.py @@ -19,57 +19,75 @@ import json - -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.ezsignsignergroup_request_compound import EzsignsignergroupRequestCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignsignergroupEditObjectV1Request(BaseModel): """ - Request for PUT /1/object/ezsignsignergroup/{pkiEzsignsignergroupID} # noqa: E501 - """ - obj_ezsignsignergroup: EzsignsignergroupRequestCompound = Field(..., alias="objEzsignsignergroup") - __properties = ["objEzsignsignergroup"] + Request for PUT /1/object/ezsignsignergroup/{pkiEzsignsignergroupID} + """ # noqa: E501 + obj_ezsignsignergroup: EzsignsignergroupRequestCompound = Field(alias="objEzsignsignergroup") + __properties: ClassVar[List[str]] = ["objEzsignsignergroup"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignsignergroupEditObjectV1Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignsignergroupEditObjectV1Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_ezsignsignergroup if self.obj_ezsignsignergroup: _dict['objEzsignsignergroup'] = self.obj_ezsignsignergroup.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignsignergroupEditObjectV1Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignsignergroupEditObjectV1Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignsignergroupEditObjectV1Request.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignsignergroupEditObjectV1Request.parse_obj({ - "obj_ezsignsignergroup": EzsignsignergroupRequestCompound.from_dict(obj.get("objEzsignsignergroup")) if obj.get("objEzsignsignergroup") is not None else None + _obj = cls.model_validate({ + "objEzsignsignergroup": EzsignsignergroupRequestCompound.from_dict(obj.get("objEzsignsignergroup")) if obj.get("objEzsignsignergroup") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignsignergroup_edit_object_v1_response.py b/eZmaxApi/models/ezsignsignergroup_edit_object_v1_response.py index 54657fe73..c4bda9465 100644 --- a/eZmaxApi/models/ezsignsignergroup_edit_object_v1_response.py +++ b/eZmaxApi/models/ezsignsignergroup_edit_object_v1_response.py @@ -19,43 +19,61 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignsignergroupEditObjectV1Response(BaseModel): """ - Response for PUT /1/object/ezsignsignergroup/{pkiEzsignsignergroupID} # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - __properties = ["objDebugPayload", "objDebug"] + Response for PUT /1/object/ezsignsignergroup/{pkiEzsignsignergroupID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignsignergroupEditObjectV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignsignergroupEditObjectV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -65,17 +83,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignsignergroupEditObjectV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignsignergroupEditObjectV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignsignergroupEditObjectV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignsignergroupEditObjectV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignsignergroup_get_ezsignsignergroupmemberships_v1_response.py b/eZmaxApi/models/ezsignsignergroup_get_ezsignsignergroupmemberships_v1_response.py index a69cbd7b8..85dc34c2d 100644 --- a/eZmaxApi/models/ezsignsignergroup_get_ezsignsignergroupmemberships_v1_response.py +++ b/eZmaxApi/models/ezsignsignergroup_get_ezsignsignergroupmemberships_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.ezsignsignergroup_get_ezsignsignergroupmemberships_v1_response_m_payload import EzsignsignergroupGetEzsignsignergroupmembershipsV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignsignergroupGetEzsignsignergroupmembershipsV1Response(BaseModel): """ - Response for GET /1/object/ezsignsignergroup/{pkiEzsignsignergroupID}/getEzsignsignergroupmemberships # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzsignsignergroupGetEzsignsignergroupmembershipsV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /1/object/ezsignsignergroup/{pkiEzsignsignergroupID}/getEzsignsignergroupmemberships + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsignsignergroupGetEzsignsignergroupmembershipsV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignsignergroupGetEzsignsignergroupmembershipsV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignsignergroupGetEzsignsignergroupmembershipsV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignsignergroupGetEzsignsignergroupmembershipsV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignsignergroupGetEzsignsignergroupmembershipsV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignsignergroupGetEzsignsignergroupmembershipsV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignsignergroupGetEzsignsignergroupmembershipsV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzsignsignergroupGetEzsignsignergroupmembershipsV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsignsignergroupGetEzsignsignergroupmembershipsV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignsignergroup_get_ezsignsignergroupmemberships_v1_response_m_payload.py b/eZmaxApi/models/ezsignsignergroup_get_ezsignsignergroupmemberships_v1_response_m_payload.py index e40da7e4e..26a7ce409 100644 --- a/eZmaxApi/models/ezsignsignergroup_get_ezsignsignergroupmemberships_v1_response_m_payload.py +++ b/eZmaxApi/models/ezsignsignergroup_get_ezsignsignergroupmemberships_v1_response_m_payload.py @@ -19,41 +19,59 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.ezsignsignergroupmembership_response_compound import EzsignsignergroupmembershipResponseCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignsignergroupGetEzsignsignergroupmembershipsV1ResponseMPayload(BaseModel): """ - Response for GET /1/object/ezsignsignergroup/{pkiEzsignsignergroupID}/getEzsignsignergroupmemberships # noqa: E501 - """ - a_obj_ezsignsignergroupmembership: conlist(EzsignsignergroupmembershipResponseCompound) = Field(..., alias="a_objEzsignsignergroupmembership") - __properties = ["a_objEzsignsignergroupmembership"] + Response for GET /1/object/ezsignsignergroup/{pkiEzsignsignergroupID}/getEzsignsignergroupmemberships + """ # noqa: E501 + a_obj_ezsignsignergroupmembership: List[EzsignsignergroupmembershipResponseCompound] = Field(alias="a_objEzsignsignergroupmembership") + __properties: ClassVar[List[str]] = ["a_objEzsignsignergroupmembership"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignsignergroupGetEzsignsignergroupmembershipsV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignsignergroupGetEzsignsignergroupmembershipsV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_ezsignsignergroupmembership (list) _items = [] if self.a_obj_ezsignsignergroupmembership: @@ -64,16 +82,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignsignergroupGetEzsignsignergroupmembershipsV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignsignergroupGetEzsignsignergroupmembershipsV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignsignergroupGetEzsignsignergroupmembershipsV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignsignergroupGetEzsignsignergroupmembershipsV1ResponseMPayload.parse_obj({ - "a_obj_ezsignsignergroupmembership": [EzsignsignergroupmembershipResponseCompound.from_dict(_item) for _item in obj.get("a_objEzsignsignergroupmembership")] if obj.get("a_objEzsignsignergroupmembership") is not None else None + _obj = cls.model_validate({ + "a_objEzsignsignergroupmembership": [EzsignsignergroupmembershipResponseCompound.from_dict(_item) for _item in obj.get("a_objEzsignsignergroupmembership")] if obj.get("a_objEzsignsignergroupmembership") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignsignergroup_get_object_v2_response.py b/eZmaxApi/models/ezsignsignergroup_get_object_v2_response.py index 40e43dd68..62fb30724 100644 --- a/eZmaxApi/models/ezsignsignergroup_get_object_v2_response.py +++ b/eZmaxApi/models/ezsignsignergroup_get_object_v2_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.ezsignsignergroup_get_object_v2_response_m_payload import EzsignsignergroupGetObjectV2ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignsignergroupGetObjectV2Response(BaseModel): """ - Response for GET /2/object/ezsignsignergroup/{pkiEzsignsignergroupID} # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzsignsignergroupGetObjectV2ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /2/object/ezsignsignergroup/{pkiEzsignsignergroupID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsignsignergroupGetObjectV2ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignsignergroupGetObjectV2Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignsignergroupGetObjectV2Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignsignergroupGetObjectV2Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignsignergroupGetObjectV2Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignsignergroupGetObjectV2Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignsignergroupGetObjectV2Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzsignsignergroupGetObjectV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsignsignergroupGetObjectV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignsignergroup_get_object_v2_response_m_payload.py b/eZmaxApi/models/ezsignsignergroup_get_object_v2_response_m_payload.py index f87f1bbcd..c4174a7b0 100644 --- a/eZmaxApi/models/ezsignsignergroup_get_object_v2_response_m_payload.py +++ b/eZmaxApi/models/ezsignsignergroup_get_object_v2_response_m_payload.py @@ -19,57 +19,75 @@ import json - -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.ezsignsignergroup_response_compound import EzsignsignergroupResponseCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignsignergroupGetObjectV2ResponseMPayload(BaseModel): """ - Payload for GET /2/object/ezsignsignergroup/{pkiEzsignsignergroupID} # noqa: E501 - """ - obj_ezsignsignergroup: EzsignsignergroupResponseCompound = Field(..., alias="objEzsignsignergroup") - __properties = ["objEzsignsignergroup"] + Payload for GET /2/object/ezsignsignergroup/{pkiEzsignsignergroupID} + """ # noqa: E501 + obj_ezsignsignergroup: EzsignsignergroupResponseCompound = Field(alias="objEzsignsignergroup") + __properties: ClassVar[List[str]] = ["objEzsignsignergroup"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignsignergroupGetObjectV2ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignsignergroupGetObjectV2ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_ezsignsignergroup if self.obj_ezsignsignergroup: _dict['objEzsignsignergroup'] = self.obj_ezsignsignergroup.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignsignergroupGetObjectV2ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignsignergroupGetObjectV2ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignsignergroupGetObjectV2ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignsignergroupGetObjectV2ResponseMPayload.parse_obj({ - "obj_ezsignsignergroup": EzsignsignergroupResponseCompound.from_dict(obj.get("objEzsignsignergroup")) if obj.get("objEzsignsignergroup") is not None else None + _obj = cls.model_validate({ + "objEzsignsignergroup": EzsignsignergroupResponseCompound.from_dict(obj.get("objEzsignsignergroup")) if obj.get("objEzsignsignergroup") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignsignergroup_request.py b/eZmaxApi/models/ezsignsignergroup_request.py index b621fb478..626a34590 100644 --- a/eZmaxApi/models/ezsignsignergroup_request.py +++ b/eZmaxApi/models/ezsignsignergroup_request.py @@ -19,61 +19,80 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.multilingual_ezsignsignergroup_description import MultilingualEzsignsignergroupDescription +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignsignergroupRequest(BaseModel): """ - A Ezsignsignergroup Object # noqa: E501 - """ - pki_ezsignsignergroup_id: Optional[conint(strict=True, le=65535, ge=0)] = Field(None, alias="pkiEzsignsignergroupID", description="The unique ID of the Ezsignsignergroup") - fki_ezsignfolder_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsignfolderID", description="The unique ID of the Ezsignfolder") - obj_ezsignsignergroup_description: MultilingualEzsignsignergroupDescription = Field(..., alias="objEzsignsignergroupDescription") - __properties = ["pkiEzsignsignergroupID", "fkiEzsignfolderID", "objEzsignsignergroupDescription"] + A Ezsignsignergroup Object + """ # noqa: E501 + pki_ezsignsignergroup_id: Optional[Annotated[int, Field(le=65535, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsignsignergroup", alias="pkiEzsignsignergroupID") + fki_ezsignfolder_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsignfolder", alias="fkiEzsignfolderID") + obj_ezsignsignergroup_description: MultilingualEzsignsignergroupDescription = Field(alias="objEzsignsignergroupDescription") + __properties: ClassVar[List[str]] = ["pkiEzsignsignergroupID", "fkiEzsignfolderID", "objEzsignsignergroupDescription"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignsignergroupRequest: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignsignergroupRequest from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_ezsignsignergroup_description if self.obj_ezsignsignergroup_description: _dict['objEzsignsignergroupDescription'] = self.obj_ezsignsignergroup_description.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignsignergroupRequest: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignsignergroupRequest from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignsignergroupRequest.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignsignergroupRequest.parse_obj({ - "pki_ezsignsignergroup_id": obj.get("pkiEzsignsignergroupID"), - "fki_ezsignfolder_id": obj.get("fkiEzsignfolderID"), - "obj_ezsignsignergroup_description": MultilingualEzsignsignergroupDescription.from_dict(obj.get("objEzsignsignergroupDescription")) if obj.get("objEzsignsignergroupDescription") is not None else None + _obj = cls.model_validate({ + "pkiEzsignsignergroupID": obj.get("pkiEzsignsignergroupID"), + "fkiEzsignfolderID": obj.get("fkiEzsignfolderID"), + "objEzsignsignergroupDescription": MultilingualEzsignsignergroupDescription.from_dict(obj.get("objEzsignsignergroupDescription")) if obj.get("objEzsignsignergroupDescription") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignsignergroup_request_compound.py b/eZmaxApi/models/ezsignsignergroup_request_compound.py index cab84ee55..f9d1f8803 100644 --- a/eZmaxApi/models/ezsignsignergroup_request_compound.py +++ b/eZmaxApi/models/ezsignsignergroup_request_compound.py @@ -19,61 +19,80 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.multilingual_ezsignsignergroup_description import MultilingualEzsignsignergroupDescription +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignsignergroupRequestCompound(BaseModel): """ - A Ezsignsignergroup Object and children # noqa: E501 - """ - pki_ezsignsignergroup_id: Optional[conint(strict=True, le=65535, ge=0)] = Field(None, alias="pkiEzsignsignergroupID", description="The unique ID of the Ezsignsignergroup") - fki_ezsignfolder_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsignfolderID", description="The unique ID of the Ezsignfolder") - obj_ezsignsignergroup_description: MultilingualEzsignsignergroupDescription = Field(..., alias="objEzsignsignergroupDescription") - __properties = ["pkiEzsignsignergroupID", "fkiEzsignfolderID", "objEzsignsignergroupDescription"] + A Ezsignsignergroup Object and children + """ # noqa: E501 + pki_ezsignsignergroup_id: Optional[Annotated[int, Field(le=65535, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsignsignergroup", alias="pkiEzsignsignergroupID") + fki_ezsignfolder_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsignfolder", alias="fkiEzsignfolderID") + obj_ezsignsignergroup_description: MultilingualEzsignsignergroupDescription = Field(alias="objEzsignsignergroupDescription") + __properties: ClassVar[List[str]] = ["pkiEzsignsignergroupID", "fkiEzsignfolderID", "objEzsignsignergroupDescription"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignsignergroupRequestCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignsignergroupRequestCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_ezsignsignergroup_description if self.obj_ezsignsignergroup_description: _dict['objEzsignsignergroupDescription'] = self.obj_ezsignsignergroup_description.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignsignergroupRequestCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignsignergroupRequestCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignsignergroupRequestCompound.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignsignergroupRequestCompound.parse_obj({ - "pki_ezsignsignergroup_id": obj.get("pkiEzsignsignergroupID"), - "fki_ezsignfolder_id": obj.get("fkiEzsignfolderID"), - "obj_ezsignsignergroup_description": MultilingualEzsignsignergroupDescription.from_dict(obj.get("objEzsignsignergroupDescription")) if obj.get("objEzsignsignergroupDescription") is not None else None + _obj = cls.model_validate({ + "pkiEzsignsignergroupID": obj.get("pkiEzsignsignergroupID"), + "fkiEzsignfolderID": obj.get("fkiEzsignfolderID"), + "objEzsignsignergroupDescription": MultilingualEzsignsignergroupDescription.from_dict(obj.get("objEzsignsignergroupDescription")) if obj.get("objEzsignsignergroupDescription") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignsignergroup_response.py b/eZmaxApi/models/ezsignsignergroup_response.py index f8ad65100..bcd7af4d7 100644 --- a/eZmaxApi/models/ezsignsignergroup_response.py +++ b/eZmaxApi/models/ezsignsignergroup_response.py @@ -19,61 +19,80 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictStr, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictStr +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.multilingual_ezsignsignergroup_description import MultilingualEzsignsignergroupDescription +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignsignergroupResponse(BaseModel): """ - An Ezsignsignergroup Object # noqa: E501 - """ - pki_ezsignsignergroup_id: conint(strict=True, le=65535, ge=0) = Field(..., alias="pkiEzsignsignergroupID", description="The unique ID of the Ezsignsignergroup") - obj_ezsignsignergroup_description: MultilingualEzsignsignergroupDescription = Field(..., alias="objEzsignsignergroupDescription") - s_ezsignsignergroup_description_x: Optional[StrictStr] = Field(None, alias="sEzsignsignergroupDescriptionX", description="The Description of the Ezsignsignergroup in the language of the requester") - __properties = ["pkiEzsignsignergroupID", "objEzsignsignergroupDescription", "sEzsignsignergroupDescriptionX"] + An Ezsignsignergroup Object + """ # noqa: E501 + pki_ezsignsignergroup_id: Annotated[int, Field(le=65535, strict=True, ge=0)] = Field(description="The unique ID of the Ezsignsignergroup", alias="pkiEzsignsignergroupID") + obj_ezsignsignergroup_description: MultilingualEzsignsignergroupDescription = Field(alias="objEzsignsignergroupDescription") + s_ezsignsignergroup_description_x: Optional[StrictStr] = Field(default=None, description="The Description of the Ezsignsignergroup in the language of the requester", alias="sEzsignsignergroupDescriptionX") + __properties: ClassVar[List[str]] = ["pkiEzsignsignergroupID", "objEzsignsignergroupDescription", "sEzsignsignergroupDescriptionX"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignsignergroupResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignsignergroupResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_ezsignsignergroup_description if self.obj_ezsignsignergroup_description: _dict['objEzsignsignergroupDescription'] = self.obj_ezsignsignergroup_description.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignsignergroupResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignsignergroupResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignsignergroupResponse.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignsignergroupResponse.parse_obj({ - "pki_ezsignsignergroup_id": obj.get("pkiEzsignsignergroupID"), - "obj_ezsignsignergroup_description": MultilingualEzsignsignergroupDescription.from_dict(obj.get("objEzsignsignergroupDescription")) if obj.get("objEzsignsignergroupDescription") is not None else None, - "s_ezsignsignergroup_description_x": obj.get("sEzsignsignergroupDescriptionX") + _obj = cls.model_validate({ + "pkiEzsignsignergroupID": obj.get("pkiEzsignsignergroupID"), + "objEzsignsignergroupDescription": MultilingualEzsignsignergroupDescription.from_dict(obj.get("objEzsignsignergroupDescription")) if obj.get("objEzsignsignergroupDescription") is not None else None, + "sEzsignsignergroupDescriptionX": obj.get("sEzsignsignergroupDescriptionX") }) return _obj diff --git a/eZmaxApi/models/ezsignsignergroup_response_compound.py b/eZmaxApi/models/ezsignsignergroup_response_compound.py index 8e4c6d14d..8d7afa84b 100644 --- a/eZmaxApi/models/ezsignsignergroup_response_compound.py +++ b/eZmaxApi/models/ezsignsignergroup_response_compound.py @@ -19,61 +19,80 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictStr, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictStr +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.multilingual_ezsignsignergroup_description import MultilingualEzsignsignergroupDescription +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignsignergroupResponseCompound(BaseModel): """ - An Ezsignsignergroup Object # noqa: E501 - """ - pki_ezsignsignergroup_id: conint(strict=True, le=65535, ge=0) = Field(..., alias="pkiEzsignsignergroupID", description="The unique ID of the Ezsignsignergroup") - obj_ezsignsignergroup_description: MultilingualEzsignsignergroupDescription = Field(..., alias="objEzsignsignergroupDescription") - s_ezsignsignergroup_description_x: Optional[StrictStr] = Field(None, alias="sEzsignsignergroupDescriptionX", description="The Description of the Ezsignsignergroup in the language of the requester") - __properties = ["pkiEzsignsignergroupID", "objEzsignsignergroupDescription", "sEzsignsignergroupDescriptionX"] + An Ezsignsignergroup Object + """ # noqa: E501 + pki_ezsignsignergroup_id: Annotated[int, Field(le=65535, strict=True, ge=0)] = Field(description="The unique ID of the Ezsignsignergroup", alias="pkiEzsignsignergroupID") + obj_ezsignsignergroup_description: MultilingualEzsignsignergroupDescription = Field(alias="objEzsignsignergroupDescription") + s_ezsignsignergroup_description_x: Optional[StrictStr] = Field(default=None, description="The Description of the Ezsignsignergroup in the language of the requester", alias="sEzsignsignergroupDescriptionX") + __properties: ClassVar[List[str]] = ["pkiEzsignsignergroupID", "objEzsignsignergroupDescription", "sEzsignsignergroupDescriptionX"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignsignergroupResponseCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignsignergroupResponseCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_ezsignsignergroup_description if self.obj_ezsignsignergroup_description: _dict['objEzsignsignergroupDescription'] = self.obj_ezsignsignergroup_description.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignsignergroupResponseCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignsignergroupResponseCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignsignergroupResponseCompound.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignsignergroupResponseCompound.parse_obj({ - "pki_ezsignsignergroup_id": obj.get("pkiEzsignsignergroupID"), - "obj_ezsignsignergroup_description": MultilingualEzsignsignergroupDescription.from_dict(obj.get("objEzsignsignergroupDescription")) if obj.get("objEzsignsignergroupDescription") is not None else None, - "s_ezsignsignergroup_description_x": obj.get("sEzsignsignergroupDescriptionX") + _obj = cls.model_validate({ + "pkiEzsignsignergroupID": obj.get("pkiEzsignsignergroupID"), + "objEzsignsignergroupDescription": MultilingualEzsignsignergroupDescription.from_dict(obj.get("objEzsignsignergroupDescription")) if obj.get("objEzsignsignergroupDescription") is not None else None, + "sEzsignsignergroupDescriptionX": obj.get("sEzsignsignergroupDescriptionX") }) return _obj diff --git a/eZmaxApi/models/ezsignsignergroupmembership_create_object_v1_request.py b/eZmaxApi/models/ezsignsignergroupmembership_create_object_v1_request.py index 7c2c931dc..c150e1cf7 100644 --- a/eZmaxApi/models/ezsignsignergroupmembership_create_object_v1_request.py +++ b/eZmaxApi/models/ezsignsignergroupmembership_create_object_v1_request.py @@ -19,41 +19,60 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.ezsignsignergroupmembership_request_compound import EzsignsignergroupmembershipRequestCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignsignergroupmembershipCreateObjectV1Request(BaseModel): """ - Request for POST /1/object/ezsignsignergroupmembership # noqa: E501 - """ - a_obj_ezsignsignergroupmembership: conlist(EzsignsignergroupmembershipRequestCompound, min_items=1) = Field(..., alias="a_objEzsignsignergroupmembership") - __properties = ["a_objEzsignsignergroupmembership"] + Request for POST /1/object/ezsignsignergroupmembership + """ # noqa: E501 + a_obj_ezsignsignergroupmembership: Annotated[List[EzsignsignergroupmembershipRequestCompound], Field(min_length=1)] = Field(alias="a_objEzsignsignergroupmembership") + __properties: ClassVar[List[str]] = ["a_objEzsignsignergroupmembership"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignsignergroupmembershipCreateObjectV1Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignsignergroupmembershipCreateObjectV1Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_ezsignsignergroupmembership (list) _items = [] if self.a_obj_ezsignsignergroupmembership: @@ -64,16 +83,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignsignergroupmembershipCreateObjectV1Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignsignergroupmembershipCreateObjectV1Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignsignergroupmembershipCreateObjectV1Request.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignsignergroupmembershipCreateObjectV1Request.parse_obj({ - "a_obj_ezsignsignergroupmembership": [EzsignsignergroupmembershipRequestCompound.from_dict(_item) for _item in obj.get("a_objEzsignsignergroupmembership")] if obj.get("a_objEzsignsignergroupmembership") is not None else None + _obj = cls.model_validate({ + "a_objEzsignsignergroupmembership": [EzsignsignergroupmembershipRequestCompound.from_dict(_item) for _item in obj.get("a_objEzsignsignergroupmembership")] if obj.get("a_objEzsignsignergroupmembership") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignsignergroupmembership_create_object_v1_response.py b/eZmaxApi/models/ezsignsignergroupmembership_create_object_v1_response.py index b8124052e..f212f6963 100644 --- a/eZmaxApi/models/ezsignsignergroupmembership_create_object_v1_response.py +++ b/eZmaxApi/models/ezsignsignergroupmembership_create_object_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.ezsignsignergroupmembership_create_object_v1_response_m_payload import EzsignsignergroupmembershipCreateObjectV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignsignergroupmembershipCreateObjectV1Response(BaseModel): """ - Response for POST /1/object/ezsignsignergroupmembership # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzsignsignergroupmembershipCreateObjectV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for POST /1/object/ezsignsignergroupmembership + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsignsignergroupmembershipCreateObjectV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignsignergroupmembershipCreateObjectV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignsignergroupmembershipCreateObjectV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignsignergroupmembershipCreateObjectV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignsignergroupmembershipCreateObjectV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignsignergroupmembershipCreateObjectV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignsignergroupmembershipCreateObjectV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzsignsignergroupmembershipCreateObjectV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsignsignergroupmembershipCreateObjectV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignsignergroupmembership_create_object_v1_response_m_payload.py b/eZmaxApi/models/ezsignsignergroupmembership_create_object_v1_response_m_payload.py index f701bd360..eade16043 100644 --- a/eZmaxApi/models/ezsignsignergroupmembership_create_object_v1_response_m_payload.py +++ b/eZmaxApi/models/ezsignsignergroupmembership_create_object_v1_response_m_payload.py @@ -19,53 +19,72 @@ import json -from typing import List -from pydantic import BaseModel, Field, conint, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignsignergroupmembershipCreateObjectV1ResponseMPayload(BaseModel): """ - Payload for POST /1/object/ezsignsignergroupmembership # noqa: E501 - """ - a_pki_ezsignsignergroupmembership_id: conlist(conint(strict=True, le=16777215, ge=0)) = Field(..., alias="a_pkiEzsignsignergroupmembershipID", description="An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request.") - __properties = ["a_pkiEzsignsignergroupmembershipID"] + Payload for POST /1/object/ezsignsignergroupmembership + """ # noqa: E501 + a_pki_ezsignsignergroupmembership_id: List[Annotated[int, Field(le=16777215, strict=True, ge=0)]] = Field(description="An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request.", alias="a_pkiEzsignsignergroupmembershipID") + __properties: ClassVar[List[str]] = ["a_pkiEzsignsignergroupmembershipID"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignsignergroupmembershipCreateObjectV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignsignergroupmembershipCreateObjectV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignsignergroupmembershipCreateObjectV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignsignergroupmembershipCreateObjectV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignsignergroupmembershipCreateObjectV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignsignergroupmembershipCreateObjectV1ResponseMPayload.parse_obj({ - "a_pki_ezsignsignergroupmembership_id": obj.get("a_pkiEzsignsignergroupmembershipID") + _obj = cls.model_validate({ + "a_pkiEzsignsignergroupmembershipID": obj.get("a_pkiEzsignsignergroupmembershipID") }) return _obj diff --git a/eZmaxApi/models/ezsignsignergroupmembership_delete_object_v1_response.py b/eZmaxApi/models/ezsignsignergroupmembership_delete_object_v1_response.py index 63631afe5..817d71f07 100644 --- a/eZmaxApi/models/ezsignsignergroupmembership_delete_object_v1_response.py +++ b/eZmaxApi/models/ezsignsignergroupmembership_delete_object_v1_response.py @@ -19,43 +19,61 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignsignergroupmembershipDeleteObjectV1Response(BaseModel): """ - Response for DELETE /1/object/ezsignsignergroupmembership/{pkiEzsignsignergroupmembershipID} # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - __properties = ["objDebugPayload", "objDebug"] + Response for DELETE /1/object/ezsignsignergroupmembership/{pkiEzsignsignergroupmembershipID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignsignergroupmembershipDeleteObjectV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignsignergroupmembershipDeleteObjectV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -65,17 +83,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignsignergroupmembershipDeleteObjectV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignsignergroupmembershipDeleteObjectV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignsignergroupmembershipDeleteObjectV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignsignergroupmembershipDeleteObjectV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignsignergroupmembership_get_object_v2_response.py b/eZmaxApi/models/ezsignsignergroupmembership_get_object_v2_response.py index fb909460e..37908ad91 100644 --- a/eZmaxApi/models/ezsignsignergroupmembership_get_object_v2_response.py +++ b/eZmaxApi/models/ezsignsignergroupmembership_get_object_v2_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.ezsignsignergroupmembership_get_object_v2_response_m_payload import EzsignsignergroupmembershipGetObjectV2ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignsignergroupmembershipGetObjectV2Response(BaseModel): """ - Response for GET /2/object/ezsignsignergroupmembership/{pkiEzsignsignergroupmembershipID} # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzsignsignergroupmembershipGetObjectV2ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /2/object/ezsignsignergroupmembership/{pkiEzsignsignergroupmembershipID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsignsignergroupmembershipGetObjectV2ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignsignergroupmembershipGetObjectV2Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignsignergroupmembershipGetObjectV2Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignsignergroupmembershipGetObjectV2Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignsignergroupmembershipGetObjectV2Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignsignergroupmembershipGetObjectV2Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignsignergroupmembershipGetObjectV2Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzsignsignergroupmembershipGetObjectV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsignsignergroupmembershipGetObjectV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignsignergroupmembership_get_object_v2_response_m_payload.py b/eZmaxApi/models/ezsignsignergroupmembership_get_object_v2_response_m_payload.py index 2ec1fd621..a83ac98f8 100644 --- a/eZmaxApi/models/ezsignsignergroupmembership_get_object_v2_response_m_payload.py +++ b/eZmaxApi/models/ezsignsignergroupmembership_get_object_v2_response_m_payload.py @@ -19,57 +19,75 @@ import json - -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.ezsignsignergroupmembership_response_compound import EzsignsignergroupmembershipResponseCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignsignergroupmembershipGetObjectV2ResponseMPayload(BaseModel): """ - Payload for GET /2/object/ezsignsignergroupmembership/{pkiEzsignsignergroupmembershipID} # noqa: E501 - """ - obj_ezsignsignergroupmembership: EzsignsignergroupmembershipResponseCompound = Field(..., alias="objEzsignsignergroupmembership") - __properties = ["objEzsignsignergroupmembership"] + Payload for GET /2/object/ezsignsignergroupmembership/{pkiEzsignsignergroupmembershipID} + """ # noqa: E501 + obj_ezsignsignergroupmembership: EzsignsignergroupmembershipResponseCompound = Field(alias="objEzsignsignergroupmembership") + __properties: ClassVar[List[str]] = ["objEzsignsignergroupmembership"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignsignergroupmembershipGetObjectV2ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignsignergroupmembershipGetObjectV2ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_ezsignsignergroupmembership if self.obj_ezsignsignergroupmembership: _dict['objEzsignsignergroupmembership'] = self.obj_ezsignsignergroupmembership.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignsignergroupmembershipGetObjectV2ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignsignergroupmembershipGetObjectV2ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignsignergroupmembershipGetObjectV2ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsignsignergroupmembershipGetObjectV2ResponseMPayload.parse_obj({ - "obj_ezsignsignergroupmembership": EzsignsignergroupmembershipResponseCompound.from_dict(obj.get("objEzsignsignergroupmembership")) if obj.get("objEzsignsignergroupmembership") is not None else None + _obj = cls.model_validate({ + "objEzsignsignergroupmembership": EzsignsignergroupmembershipResponseCompound.from_dict(obj.get("objEzsignsignergroupmembership")) if obj.get("objEzsignsignergroupmembership") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsignsignergroupmembership_request.py b/eZmaxApi/models/ezsignsignergroupmembership_request.py index 43de4e816..33c2bd582 100644 --- a/eZmaxApi/models/ezsignsignergroupmembership_request.py +++ b/eZmaxApi/models/ezsignsignergroupmembership_request.py @@ -19,61 +19,80 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignsignergroupmembershipRequest(BaseModel): """ - A Ezsignsignergroupmembership Object # noqa: E501 - """ - pki_ezsignsignergroupmembership_id: Optional[conint(strict=True, le=16777215, ge=0)] = Field(None, alias="pkiEzsignsignergroupmembershipID", description="The unique ID of the Ezsignsignergroupmembership") - fki_ezsignsignergroup_id: conint(strict=True, le=65535, ge=0) = Field(..., alias="fkiEzsignsignergroupID", description="The unique ID of the Ezsignsignergroup") - fki_ezsignsigner_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiEzsignsignerID", description="The unique ID of the Ezsignsigner") - fki_user_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiUserID", description="The unique ID of the User") - fki_usergroup_id: Optional[conint(strict=True, le=255, ge=0)] = Field(None, alias="fkiUsergroupID", description="The unique ID of the Usergroup") - __properties = ["pkiEzsignsignergroupmembershipID", "fkiEzsignsignergroupID", "fkiEzsignsignerID", "fkiUserID", "fkiUsergroupID"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + A Ezsignsignergroupmembership Object + """ # noqa: E501 + pki_ezsignsignergroupmembership_id: Optional[Annotated[int, Field(le=16777215, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsignsignergroupmembership", alias="pkiEzsignsignergroupmembershipID") + fki_ezsignsignergroup_id: Annotated[int, Field(le=65535, strict=True, ge=0)] = Field(description="The unique ID of the Ezsignsignergroup", alias="fkiEzsignsignergroupID") + fki_ezsignsigner_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsignsigner", alias="fkiEzsignsignerID") + fki_user_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the User", alias="fkiUserID") + fki_usergroup_id: Optional[Annotated[int, Field(le=255, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Usergroup", alias="fkiUsergroupID") + __properties: ClassVar[List[str]] = ["pkiEzsignsignergroupmembershipID", "fkiEzsignsignergroupID", "fkiEzsignsignerID", "fkiUserID", "fkiUsergroupID"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignsignergroupmembershipRequest: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignsignergroupmembershipRequest from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignsignergroupmembershipRequest: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignsignergroupmembershipRequest from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignsignergroupmembershipRequest.parse_obj(obj) - - _obj = EzsignsignergroupmembershipRequest.parse_obj({ - "pki_ezsignsignergroupmembership_id": obj.get("pkiEzsignsignergroupmembershipID"), - "fki_ezsignsignergroup_id": obj.get("fkiEzsignsignergroupID"), - "fki_ezsignsigner_id": obj.get("fkiEzsignsignerID"), - "fki_user_id": obj.get("fkiUserID"), - "fki_usergroup_id": obj.get("fkiUsergroupID") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsignsignergroupmembershipID": obj.get("pkiEzsignsignergroupmembershipID"), + "fkiEzsignsignergroupID": obj.get("fkiEzsignsignergroupID"), + "fkiEzsignsignerID": obj.get("fkiEzsignsignerID"), + "fkiUserID": obj.get("fkiUserID"), + "fkiUsergroupID": obj.get("fkiUsergroupID") }) return _obj diff --git a/eZmaxApi/models/ezsignsignergroupmembership_request_compound.py b/eZmaxApi/models/ezsignsignergroupmembership_request_compound.py index 87b686168..9a472f2a9 100644 --- a/eZmaxApi/models/ezsignsignergroupmembership_request_compound.py +++ b/eZmaxApi/models/ezsignsignergroupmembership_request_compound.py @@ -19,61 +19,80 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignsignergroupmembershipRequestCompound(BaseModel): """ - A Ezsignsignergroupmembership Object and children # noqa: E501 - """ - pki_ezsignsignergroupmembership_id: Optional[conint(strict=True, le=16777215, ge=0)] = Field(None, alias="pkiEzsignsignergroupmembershipID", description="The unique ID of the Ezsignsignergroupmembership") - fki_ezsignsignergroup_id: conint(strict=True, le=65535, ge=0) = Field(..., alias="fkiEzsignsignergroupID", description="The unique ID of the Ezsignsignergroup") - fki_ezsignsigner_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiEzsignsignerID", description="The unique ID of the Ezsignsigner") - fki_user_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiUserID", description="The unique ID of the User") - fki_usergroup_id: Optional[conint(strict=True, le=255, ge=0)] = Field(None, alias="fkiUsergroupID", description="The unique ID of the Usergroup") - __properties = ["pkiEzsignsignergroupmembershipID", "fkiEzsignsignergroupID", "fkiEzsignsignerID", "fkiUserID", "fkiUsergroupID"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + A Ezsignsignergroupmembership Object and children + """ # noqa: E501 + pki_ezsignsignergroupmembership_id: Optional[Annotated[int, Field(le=16777215, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsignsignergroupmembership", alias="pkiEzsignsignergroupmembershipID") + fki_ezsignsignergroup_id: Annotated[int, Field(le=65535, strict=True, ge=0)] = Field(description="The unique ID of the Ezsignsignergroup", alias="fkiEzsignsignergroupID") + fki_ezsignsigner_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsignsigner", alias="fkiEzsignsignerID") + fki_user_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the User", alias="fkiUserID") + fki_usergroup_id: Optional[Annotated[int, Field(le=255, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Usergroup", alias="fkiUsergroupID") + __properties: ClassVar[List[str]] = ["pkiEzsignsignergroupmembershipID", "fkiEzsignsignergroupID", "fkiEzsignsignerID", "fkiUserID", "fkiUsergroupID"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignsignergroupmembershipRequestCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignsignergroupmembershipRequestCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignsignergroupmembershipRequestCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignsignergroupmembershipRequestCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignsignergroupmembershipRequestCompound.parse_obj(obj) - - _obj = EzsignsignergroupmembershipRequestCompound.parse_obj({ - "pki_ezsignsignergroupmembership_id": obj.get("pkiEzsignsignergroupmembershipID"), - "fki_ezsignsignergroup_id": obj.get("fkiEzsignsignergroupID"), - "fki_ezsignsigner_id": obj.get("fkiEzsignsignerID"), - "fki_user_id": obj.get("fkiUserID"), - "fki_usergroup_id": obj.get("fkiUsergroupID") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsignsignergroupmembershipID": obj.get("pkiEzsignsignergroupmembershipID"), + "fkiEzsignsignergroupID": obj.get("fkiEzsignsignergroupID"), + "fkiEzsignsignerID": obj.get("fkiEzsignsignerID"), + "fkiUserID": obj.get("fkiUserID"), + "fkiUsergroupID": obj.get("fkiUsergroupID") }) return _obj diff --git a/eZmaxApi/models/ezsignsignergroupmembership_response.py b/eZmaxApi/models/ezsignsignergroupmembership_response.py index 968a264f8..54b5ab2c8 100644 --- a/eZmaxApi/models/ezsignsignergroupmembership_response.py +++ b/eZmaxApi/models/ezsignsignergroupmembership_response.py @@ -19,61 +19,80 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignsignergroupmembershipResponse(BaseModel): """ - A Ezsignsignergroupmembership Object # noqa: E501 - """ - pki_ezsignsignergroupmembership_id: conint(strict=True, le=16777215, ge=0) = Field(..., alias="pkiEzsignsignergroupmembershipID", description="The unique ID of the Ezsignsignergroupmembership") - fki_ezsignsignergroup_id: conint(strict=True, le=65535, ge=0) = Field(..., alias="fkiEzsignsignergroupID", description="The unique ID of the Ezsignsignergroup") - fki_ezsignsigner_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiEzsignsignerID", description="The unique ID of the Ezsignsigner") - fki_user_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiUserID", description="The unique ID of the User") - fki_usergroup_id: Optional[conint(strict=True, le=255, ge=0)] = Field(None, alias="fkiUsergroupID", description="The unique ID of the Usergroup") - __properties = ["pkiEzsignsignergroupmembershipID", "fkiEzsignsignergroupID", "fkiEzsignsignerID", "fkiUserID", "fkiUsergroupID"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + A Ezsignsignergroupmembership Object + """ # noqa: E501 + pki_ezsignsignergroupmembership_id: Annotated[int, Field(le=16777215, strict=True, ge=0)] = Field(description="The unique ID of the Ezsignsignergroupmembership", alias="pkiEzsignsignergroupmembershipID") + fki_ezsignsignergroup_id: Annotated[int, Field(le=65535, strict=True, ge=0)] = Field(description="The unique ID of the Ezsignsignergroup", alias="fkiEzsignsignergroupID") + fki_ezsignsigner_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsignsigner", alias="fkiEzsignsignerID") + fki_user_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the User", alias="fkiUserID") + fki_usergroup_id: Optional[Annotated[int, Field(le=255, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Usergroup", alias="fkiUsergroupID") + __properties: ClassVar[List[str]] = ["pkiEzsignsignergroupmembershipID", "fkiEzsignsignergroupID", "fkiEzsignsignerID", "fkiUserID", "fkiUsergroupID"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignsignergroupmembershipResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignsignergroupmembershipResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignsignergroupmembershipResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignsignergroupmembershipResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignsignergroupmembershipResponse.parse_obj(obj) - - _obj = EzsignsignergroupmembershipResponse.parse_obj({ - "pki_ezsignsignergroupmembership_id": obj.get("pkiEzsignsignergroupmembershipID"), - "fki_ezsignsignergroup_id": obj.get("fkiEzsignsignergroupID"), - "fki_ezsignsigner_id": obj.get("fkiEzsignsignerID"), - "fki_user_id": obj.get("fkiUserID"), - "fki_usergroup_id": obj.get("fkiUsergroupID") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsignsignergroupmembershipID": obj.get("pkiEzsignsignergroupmembershipID"), + "fkiEzsignsignergroupID": obj.get("fkiEzsignsignergroupID"), + "fkiEzsignsignerID": obj.get("fkiEzsignsignerID"), + "fkiUserID": obj.get("fkiUserID"), + "fkiUsergroupID": obj.get("fkiUsergroupID") }) return _obj diff --git a/eZmaxApi/models/ezsignsignergroupmembership_response_compound.py b/eZmaxApi/models/ezsignsignergroupmembership_response_compound.py index 9fed8cad0..eddd2a4a4 100644 --- a/eZmaxApi/models/ezsignsignergroupmembership_response_compound.py +++ b/eZmaxApi/models/ezsignsignergroupmembership_response_compound.py @@ -19,61 +19,80 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsignsignergroupmembershipResponseCompound(BaseModel): """ - A Ezsignsignergroupmembership Object # noqa: E501 - """ - pki_ezsignsignergroupmembership_id: conint(strict=True, le=16777215, ge=0) = Field(..., alias="pkiEzsignsignergroupmembershipID", description="The unique ID of the Ezsignsignergroupmembership") - fki_ezsignsignergroup_id: conint(strict=True, le=65535, ge=0) = Field(..., alias="fkiEzsignsignergroupID", description="The unique ID of the Ezsignsignergroup") - fki_ezsignsigner_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiEzsignsignerID", description="The unique ID of the Ezsignsigner") - fki_user_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiUserID", description="The unique ID of the User") - fki_usergroup_id: Optional[conint(strict=True, le=255, ge=0)] = Field(None, alias="fkiUsergroupID", description="The unique ID of the Usergroup") - __properties = ["pkiEzsignsignergroupmembershipID", "fkiEzsignsignergroupID", "fkiEzsignsignerID", "fkiUserID", "fkiUsergroupID"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + A Ezsignsignergroupmembership Object + """ # noqa: E501 + pki_ezsignsignergroupmembership_id: Annotated[int, Field(le=16777215, strict=True, ge=0)] = Field(description="The unique ID of the Ezsignsignergroupmembership", alias="pkiEzsignsignergroupmembershipID") + fki_ezsignsignergroup_id: Annotated[int, Field(le=65535, strict=True, ge=0)] = Field(description="The unique ID of the Ezsignsignergroup", alias="fkiEzsignsignergroupID") + fki_ezsignsigner_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsignsigner", alias="fkiEzsignsignerID") + fki_user_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the User", alias="fkiUserID") + fki_usergroup_id: Optional[Annotated[int, Field(le=255, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Usergroup", alias="fkiUsergroupID") + __properties: ClassVar[List[str]] = ["pkiEzsignsignergroupmembershipID", "fkiEzsignsignergroupID", "fkiEzsignsignerID", "fkiUserID", "fkiUsergroupID"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsignsignergroupmembershipResponseCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsignsignergroupmembershipResponseCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsignsignergroupmembershipResponseCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsignsignergroupmembershipResponseCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsignsignergroupmembershipResponseCompound.parse_obj(obj) - - _obj = EzsignsignergroupmembershipResponseCompound.parse_obj({ - "pki_ezsignsignergroupmembership_id": obj.get("pkiEzsignsignergroupmembershipID"), - "fki_ezsignsignergroup_id": obj.get("fkiEzsignsignergroupID"), - "fki_ezsignsigner_id": obj.get("fkiEzsignsignerID"), - "fki_user_id": obj.get("fkiUserID"), - "fki_usergroup_id": obj.get("fkiUsergroupID") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsignsignergroupmembershipID": obj.get("pkiEzsignsignergroupmembershipID"), + "fkiEzsignsignergroupID": obj.get("fkiEzsignsignergroupID"), + "fkiEzsignsignerID": obj.get("fkiEzsignsignerID"), + "fkiUserID": obj.get("fkiUserID"), + "fkiUsergroupID": obj.get("fkiUsergroupID") }) return _obj diff --git a/eZmaxApi/models/ezsignsigningreason_autocomplete_element_response.py b/eZmaxApi/models/ezsignsigningreason_autocomplete_element_response.py new file mode 100644 index 000000000..f10af7798 --- /dev/null +++ b/eZmaxApi/models/ezsignsigningreason_autocomplete_element_response.py @@ -0,0 +1,102 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictBool, field_validator +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self + +class EzsignsigningreasonAutocompleteElementResponse(BaseModel): + """ + A Ezsignsigningreason AutocompleteElement Response + """ # noqa: E501 + pki_ezsignsigningreason_id: Annotated[int, Field(le=255, strict=True, ge=0)] = Field(description="The unique ID of the Ezsignsigningreason", alias="pkiEzsignsigningreasonID") + s_ezsignsigningreason_description_x: Annotated[str, Field(strict=True)] = Field(description="The description of the Ezsignsigningreason in the language of the requester", alias="sEzsignsigningreasonDescriptionX") + b_ezsignsigningreason_isactive: StrictBool = Field(description="Whether the ezsignsigningreason is active or not", alias="bEzsignsigningreasonIsactive") + __properties: ClassVar[List[str]] = ["pkiEzsignsigningreasonID", "sEzsignsigningreasonDescriptionX", "bEzsignsigningreasonIsactive"] + + @field_validator('s_ezsignsigningreason_description_x') + def s_ezsignsigningreason_description_x_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^.{0,50}$", value): + raise ValueError(r"must validate the regular expression /^.{0,50}$/") + return value + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of EzsignsigningreasonAutocompleteElementResponse from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Dict) -> Self: + """Create an instance of EzsignsigningreasonAutocompleteElementResponse from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsignsigningreasonID": obj.get("pkiEzsignsigningreasonID"), + "sEzsignsigningreasonDescriptionX": obj.get("sEzsignsigningreasonDescriptionX"), + "bEzsignsigningreasonIsactive": obj.get("bEzsignsigningreasonIsactive") + }) + return _obj + + diff --git a/eZmaxApi/models/ezsignsigningreason_create_object_v1_request.py b/eZmaxApi/models/ezsignsigningreason_create_object_v1_request.py new file mode 100644 index 000000000..07c918d49 --- /dev/null +++ b/eZmaxApi/models/ezsignsigningreason_create_object_v1_request.py @@ -0,0 +1,99 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +from eZmaxApi.models.ezsignsigningreason_request_compound import EzsignsigningreasonRequestCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self + +class EzsignsigningreasonCreateObjectV1Request(BaseModel): + """ + Request for POST /1/object/ezsignsigningreason + """ # noqa: E501 + a_obj_ezsignsigningreason: Annotated[List[EzsignsigningreasonRequestCompound], Field(min_length=1)] = Field(alias="a_objEzsignsigningreason") + __properties: ClassVar[List[str]] = ["a_objEzsignsigningreason"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of EzsignsigningreasonCreateObjectV1Request from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in a_obj_ezsignsigningreason (list) + _items = [] + if self.a_obj_ezsignsigningreason: + for _item in self.a_obj_ezsignsigningreason: + if _item: + _items.append(_item.to_dict()) + _dict['a_objEzsignsigningreason'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Dict) -> Self: + """Create an instance of EzsignsigningreasonCreateObjectV1Request from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "a_objEzsignsigningreason": [EzsignsigningreasonRequestCompound.from_dict(_item) for _item in obj.get("a_objEzsignsigningreason")] if obj.get("a_objEzsignsigningreason") is not None else None + }) + return _obj + + diff --git a/eZmaxApi/models/ezsignsigningreason_create_object_v1_response.py b/eZmaxApi/models/ezsignsigningreason_create_object_v1_response.py new file mode 100644 index 000000000..6eb89d158 --- /dev/null +++ b/eZmaxApi/models/ezsignsigningreason_create_object_v1_response.py @@ -0,0 +1,106 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field +from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug +from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +from eZmaxApi.models.ezsignsigningreason_create_object_v1_response_m_payload import EzsignsigningreasonCreateObjectV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self + +class EzsignsigningreasonCreateObjectV1Response(BaseModel): + """ + Response for POST /1/object/ezsignsigningreason + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsignsigningreasonCreateObjectV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of EzsignsigningreasonCreateObjectV1Response from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of obj_debug_payload + if self.obj_debug_payload: + _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() + # override the default output from pydantic by calling `to_dict()` of obj_debug + if self.obj_debug: + _dict['objDebug'] = self.obj_debug.to_dict() + # override the default output from pydantic by calling `to_dict()` of m_payload + if self.m_payload: + _dict['mPayload'] = self.m_payload.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Dict) -> Self: + """Create an instance of EzsignsigningreasonCreateObjectV1Response from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsignsigningreasonCreateObjectV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + }) + return _obj + + diff --git a/eZmaxApi/models/ezsignsigningreason_create_object_v1_response_m_payload.py b/eZmaxApi/models/ezsignsigningreason_create_object_v1_response_m_payload.py new file mode 100644 index 000000000..c9c620fa9 --- /dev/null +++ b/eZmaxApi/models/ezsignsigningreason_create_object_v1_response_m_payload.py @@ -0,0 +1,91 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self + +class EzsignsigningreasonCreateObjectV1ResponseMPayload(BaseModel): + """ + Payload for POST /1/object/ezsignsigningreason + """ # noqa: E501 + a_pki_ezsignsigningreason_id: List[Annotated[int, Field(le=255, strict=True, ge=0)]] = Field(description="An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request.", alias="a_pkiEzsignsigningreasonID") + __properties: ClassVar[List[str]] = ["a_pkiEzsignsigningreasonID"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of EzsignsigningreasonCreateObjectV1ResponseMPayload from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Dict) -> Self: + """Create an instance of EzsignsigningreasonCreateObjectV1ResponseMPayload from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "a_pkiEzsignsigningreasonID": obj.get("a_pkiEzsignsigningreasonID") + }) + return _obj + + diff --git a/eZmaxApi/models/ezsignsigningreason_edit_object_v1_request.py b/eZmaxApi/models/ezsignsigningreason_edit_object_v1_request.py new file mode 100644 index 000000000..8c97bbdfd --- /dev/null +++ b/eZmaxApi/models/ezsignsigningreason_edit_object_v1_request.py @@ -0,0 +1,94 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from eZmaxApi.models.ezsignsigningreason_request_compound import EzsignsigningreasonRequestCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self + +class EzsignsigningreasonEditObjectV1Request(BaseModel): + """ + Request for PUT /1/object/ezsignsigningreason/{pkiEzsignsigningreasonID} + """ # noqa: E501 + obj_ezsignsigningreason: EzsignsigningreasonRequestCompound = Field(alias="objEzsignsigningreason") + __properties: ClassVar[List[str]] = ["objEzsignsigningreason"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of EzsignsigningreasonEditObjectV1Request from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of obj_ezsignsigningreason + if self.obj_ezsignsigningreason: + _dict['objEzsignsigningreason'] = self.obj_ezsignsigningreason.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Dict) -> Self: + """Create an instance of EzsignsigningreasonEditObjectV1Request from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "objEzsignsigningreason": EzsignsigningreasonRequestCompound.from_dict(obj.get("objEzsignsigningreason")) if obj.get("objEzsignsigningreason") is not None else None + }) + return _obj + + diff --git a/eZmaxApi/models/ezsignsigningreason_edit_object_v1_response.py b/eZmaxApi/models/ezsignsigningreason_edit_object_v1_response.py new file mode 100644 index 000000000..d3006e9d2 --- /dev/null +++ b/eZmaxApi/models/ezsignsigningreason_edit_object_v1_response.py @@ -0,0 +1,100 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field +from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug +from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self + +class EzsignsigningreasonEditObjectV1Response(BaseModel): + """ + Response for PUT /1/object/ezsignsigningreason/{pkiEzsignsigningreasonID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of EzsignsigningreasonEditObjectV1Response from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of obj_debug_payload + if self.obj_debug_payload: + _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() + # override the default output from pydantic by calling `to_dict()` of obj_debug + if self.obj_debug: + _dict['objDebug'] = self.obj_debug.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Dict) -> Self: + """Create an instance of EzsignsigningreasonEditObjectV1Response from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None + }) + return _obj + + diff --git a/eZmaxApi/models/ezsignsigningreason_get_autocomplete_v2_response.py b/eZmaxApi/models/ezsignsigningreason_get_autocomplete_v2_response.py new file mode 100644 index 000000000..a9a443966 --- /dev/null +++ b/eZmaxApi/models/ezsignsigningreason_get_autocomplete_v2_response.py @@ -0,0 +1,106 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field +from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug +from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +from eZmaxApi.models.ezsignsigningreason_get_autocomplete_v2_response_m_payload import EzsignsigningreasonGetAutocompleteV2ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self + +class EzsignsigningreasonGetAutocompleteV2Response(BaseModel): + """ + Response for GET /2/object/ezsignsigningreason/getAutocomplete + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsignsigningreasonGetAutocompleteV2ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of EzsignsigningreasonGetAutocompleteV2Response from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of obj_debug_payload + if self.obj_debug_payload: + _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() + # override the default output from pydantic by calling `to_dict()` of obj_debug + if self.obj_debug: + _dict['objDebug'] = self.obj_debug.to_dict() + # override the default output from pydantic by calling `to_dict()` of m_payload + if self.m_payload: + _dict['mPayload'] = self.m_payload.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Dict) -> Self: + """Create an instance of EzsignsigningreasonGetAutocompleteV2Response from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsignsigningreasonGetAutocompleteV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + }) + return _obj + + diff --git a/eZmaxApi/models/ezsignsigningreason_get_autocomplete_v2_response_m_payload.py b/eZmaxApi/models/ezsignsigningreason_get_autocomplete_v2_response_m_payload.py new file mode 100644 index 000000000..b07f0adb2 --- /dev/null +++ b/eZmaxApi/models/ezsignsigningreason_get_autocomplete_v2_response_m_payload.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from eZmaxApi.models.ezsignsigningreason_autocomplete_element_response import EzsignsigningreasonAutocompleteElementResponse +try: + from typing import Self +except ImportError: + from typing_extensions import Self + +class EzsignsigningreasonGetAutocompleteV2ResponseMPayload(BaseModel): + """ + Payload for POST /2/object/ezsignsigningreason/getAutocomplete + """ # noqa: E501 + a_obj_ezsignsigningreason: List[EzsignsigningreasonAutocompleteElementResponse] = Field(description="An array of Ezsignsigningreason autocomplete element response.", alias="a_objEzsignsigningreason") + __properties: ClassVar[List[str]] = ["a_objEzsignsigningreason"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of EzsignsigningreasonGetAutocompleteV2ResponseMPayload from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in a_obj_ezsignsigningreason (list) + _items = [] + if self.a_obj_ezsignsigningreason: + for _item in self.a_obj_ezsignsigningreason: + if _item: + _items.append(_item.to_dict()) + _dict['a_objEzsignsigningreason'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Dict) -> Self: + """Create an instance of EzsignsigningreasonGetAutocompleteV2ResponseMPayload from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "a_objEzsignsigningreason": [EzsignsigningreasonAutocompleteElementResponse.from_dict(_item) for _item in obj.get("a_objEzsignsigningreason")] if obj.get("a_objEzsignsigningreason") is not None else None + }) + return _obj + + diff --git a/eZmaxApi/models/ezsignsigningreason_get_list_v1_response.py b/eZmaxApi/models/ezsignsigningreason_get_list_v1_response.py new file mode 100644 index 000000000..f8aeb6c5f --- /dev/null +++ b/eZmaxApi/models/ezsignsigningreason_get_list_v1_response.py @@ -0,0 +1,106 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field +from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug +from eZmaxApi.models.common_response_obj_debug_payload_get_list import CommonResponseObjDebugPayloadGetList +from eZmaxApi.models.ezsignsigningreason_get_list_v1_response_m_payload import EzsignsigningreasonGetListV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self + +class EzsignsigningreasonGetListV1Response(BaseModel): + """ + Response for GET /1/object/ezsignsigningreason/getList + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayloadGetList = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsignsigningreasonGetListV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of EzsignsigningreasonGetListV1Response from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of obj_debug_payload + if self.obj_debug_payload: + _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() + # override the default output from pydantic by calling `to_dict()` of obj_debug + if self.obj_debug: + _dict['objDebug'] = self.obj_debug.to_dict() + # override the default output from pydantic by calling `to_dict()` of m_payload + if self.m_payload: + _dict['mPayload'] = self.m_payload.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Dict) -> Self: + """Create an instance of EzsignsigningreasonGetListV1Response from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayloadGetList.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsignsigningreasonGetListV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + }) + return _obj + + diff --git a/eZmaxApi/models/ezsignsigningreason_get_list_v1_response_m_payload.py b/eZmaxApi/models/ezsignsigningreason_get_list_v1_response_m_payload.py new file mode 100644 index 000000000..8e5dae226 --- /dev/null +++ b/eZmaxApi/models/ezsignsigningreason_get_list_v1_response_m_payload.py @@ -0,0 +1,102 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictInt +from pydantic import Field +from eZmaxApi.models.ezsignsigningreason_list_element import EzsignsigningreasonListElement +try: + from typing import Self +except ImportError: + from typing_extensions import Self + +class EzsignsigningreasonGetListV1ResponseMPayload(BaseModel): + """ + Payload for GET /1/object/ezsignsigningreason/getList + """ # noqa: E501 + i_row_returned: StrictInt = Field(description="The number of rows returned", alias="iRowReturned") + i_row_filtered: StrictInt = Field(description="The number of rows matching your filters (if any) or the total number of rows", alias="iRowFiltered") + a_obj_ezsignsigningreason: List[EzsignsigningreasonListElement] = Field(alias="a_objEzsignsigningreason") + __properties: ClassVar[List[str]] = ["iRowReturned", "iRowFiltered", "a_objEzsignsigningreason"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of EzsignsigningreasonGetListV1ResponseMPayload from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in a_obj_ezsignsigningreason (list) + _items = [] + if self.a_obj_ezsignsigningreason: + for _item in self.a_obj_ezsignsigningreason: + if _item: + _items.append(_item.to_dict()) + _dict['a_objEzsignsigningreason'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Dict) -> Self: + """Create an instance of EzsignsigningreasonGetListV1ResponseMPayload from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "iRowReturned": obj.get("iRowReturned"), + "iRowFiltered": obj.get("iRowFiltered"), + "a_objEzsignsigningreason": [EzsignsigningreasonListElement.from_dict(_item) for _item in obj.get("a_objEzsignsigningreason")] if obj.get("a_objEzsignsigningreason") is not None else None + }) + return _obj + + diff --git a/eZmaxApi/models/ezsignsigningreason_get_object_v2_response.py b/eZmaxApi/models/ezsignsigningreason_get_object_v2_response.py new file mode 100644 index 000000000..5bff9d5a8 --- /dev/null +++ b/eZmaxApi/models/ezsignsigningreason_get_object_v2_response.py @@ -0,0 +1,106 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field +from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug +from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +from eZmaxApi.models.ezsignsigningreason_get_object_v2_response_m_payload import EzsignsigningreasonGetObjectV2ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self + +class EzsignsigningreasonGetObjectV2Response(BaseModel): + """ + Response for GET /2/object/ezsignsigningreason/{pkiEzsignsigningreasonID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsignsigningreasonGetObjectV2ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of EzsignsigningreasonGetObjectV2Response from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of obj_debug_payload + if self.obj_debug_payload: + _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() + # override the default output from pydantic by calling `to_dict()` of obj_debug + if self.obj_debug: + _dict['objDebug'] = self.obj_debug.to_dict() + # override the default output from pydantic by calling `to_dict()` of m_payload + if self.m_payload: + _dict['mPayload'] = self.m_payload.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Dict) -> Self: + """Create an instance of EzsignsigningreasonGetObjectV2Response from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsignsigningreasonGetObjectV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + }) + return _obj + + diff --git a/eZmaxApi/models/ezsignsigningreason_get_object_v2_response_m_payload.py b/eZmaxApi/models/ezsignsigningreason_get_object_v2_response_m_payload.py new file mode 100644 index 000000000..68b126682 --- /dev/null +++ b/eZmaxApi/models/ezsignsigningreason_get_object_v2_response_m_payload.py @@ -0,0 +1,94 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from eZmaxApi.models.ezsignsigningreason_response_compound import EzsignsigningreasonResponseCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self + +class EzsignsigningreasonGetObjectV2ResponseMPayload(BaseModel): + """ + Payload for GET /2/object/ezsignsigningreason/{pkiEzsignsigningreasonID} + """ # noqa: E501 + obj_ezsignsigningreason: EzsignsigningreasonResponseCompound = Field(alias="objEzsignsigningreason") + __properties: ClassVar[List[str]] = ["objEzsignsigningreason"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of EzsignsigningreasonGetObjectV2ResponseMPayload from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of obj_ezsignsigningreason + if self.obj_ezsignsigningreason: + _dict['objEzsignsigningreason'] = self.obj_ezsignsigningreason.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Dict) -> Self: + """Create an instance of EzsignsigningreasonGetObjectV2ResponseMPayload from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "objEzsignsigningreason": EzsignsigningreasonResponseCompound.from_dict(obj.get("objEzsignsigningreason")) if obj.get("objEzsignsigningreason") is not None else None + }) + return _obj + + diff --git a/eZmaxApi/models/ezsignsigningreason_list_element.py b/eZmaxApi/models/ezsignsigningreason_list_element.py new file mode 100644 index 000000000..1aab71b0d --- /dev/null +++ b/eZmaxApi/models/ezsignsigningreason_list_element.py @@ -0,0 +1,102 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictBool, field_validator +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self + +class EzsignsigningreasonListElement(BaseModel): + """ + A Ezsignsigningreason List Element + """ # noqa: E501 + pki_ezsignsigningreason_id: Annotated[int, Field(le=255, strict=True, ge=0)] = Field(description="The unique ID of the Ezsignsigningreason", alias="pkiEzsignsigningreasonID") + s_ezsignsigningreason_description_x: Annotated[str, Field(strict=True)] = Field(description="The description of the Ezsignsigningreason in the language of the requester", alias="sEzsignsigningreasonDescriptionX") + b_ezsignsigningreason_isactive: StrictBool = Field(description="Whether the ezsignsigningreason is active or not", alias="bEzsignsigningreasonIsactive") + __properties: ClassVar[List[str]] = ["pkiEzsignsigningreasonID", "sEzsignsigningreasonDescriptionX", "bEzsignsigningreasonIsactive"] + + @field_validator('s_ezsignsigningreason_description_x') + def s_ezsignsigningreason_description_x_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^.{0,50}$", value): + raise ValueError(r"must validate the regular expression /^.{0,50}$/") + return value + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of EzsignsigningreasonListElement from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Dict) -> Self: + """Create an instance of EzsignsigningreasonListElement from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsignsigningreasonID": obj.get("pkiEzsignsigningreasonID"), + "sEzsignsigningreasonDescriptionX": obj.get("sEzsignsigningreasonDescriptionX"), + "bEzsignsigningreasonIsactive": obj.get("bEzsignsigningreasonIsactive") + }) + return _obj + + diff --git a/eZmaxApi/models/ezsignsigningreason_request.py b/eZmaxApi/models/ezsignsigningreason_request.py new file mode 100644 index 000000000..ba223a2f3 --- /dev/null +++ b/eZmaxApi/models/ezsignsigningreason_request.py @@ -0,0 +1,99 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool +from pydantic import Field +from typing_extensions import Annotated +from eZmaxApi.models.multilingual_ezsignsigningreason_description import MultilingualEzsignsigningreasonDescription +try: + from typing import Self +except ImportError: + from typing_extensions import Self + +class EzsignsigningreasonRequest(BaseModel): + """ + A Ezsignsigningreason Object + """ # noqa: E501 + pki_ezsignsigningreason_id: Optional[Annotated[int, Field(le=255, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsignsigningreason", alias="pkiEzsignsigningreasonID") + obj_ezsignsigningreason_description: MultilingualEzsignsigningreasonDescription = Field(alias="objEzsignsigningreasonDescription") + b_ezsignsigningreason_isactive: StrictBool = Field(description="Whether the ezsignsigningreason is active or not", alias="bEzsignsigningreasonIsactive") + __properties: ClassVar[List[str]] = ["pkiEzsignsigningreasonID", "objEzsignsigningreasonDescription", "bEzsignsigningreasonIsactive"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of EzsignsigningreasonRequest from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of obj_ezsignsigningreason_description + if self.obj_ezsignsigningreason_description: + _dict['objEzsignsigningreasonDescription'] = self.obj_ezsignsigningreason_description.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Dict) -> Self: + """Create an instance of EzsignsigningreasonRequest from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsignsigningreasonID": obj.get("pkiEzsignsigningreasonID"), + "objEzsignsigningreasonDescription": MultilingualEzsignsigningreasonDescription.from_dict(obj.get("objEzsignsigningreasonDescription")) if obj.get("objEzsignsigningreasonDescription") is not None else None, + "bEzsignsigningreasonIsactive": obj.get("bEzsignsigningreasonIsactive") + }) + return _obj + + diff --git a/eZmaxApi/models/ezsignsigningreason_request_compound.py b/eZmaxApi/models/ezsignsigningreason_request_compound.py new file mode 100644 index 000000000..0299bda43 --- /dev/null +++ b/eZmaxApi/models/ezsignsigningreason_request_compound.py @@ -0,0 +1,99 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool +from pydantic import Field +from typing_extensions import Annotated +from eZmaxApi.models.multilingual_ezsignsigningreason_description import MultilingualEzsignsigningreasonDescription +try: + from typing import Self +except ImportError: + from typing_extensions import Self + +class EzsignsigningreasonRequestCompound(BaseModel): + """ + A Ezsignsigningreason Object and children + """ # noqa: E501 + pki_ezsignsigningreason_id: Optional[Annotated[int, Field(le=255, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsignsigningreason", alias="pkiEzsignsigningreasonID") + obj_ezsignsigningreason_description: MultilingualEzsignsigningreasonDescription = Field(alias="objEzsignsigningreasonDescription") + b_ezsignsigningreason_isactive: StrictBool = Field(description="Whether the ezsignsigningreason is active or not", alias="bEzsignsigningreasonIsactive") + __properties: ClassVar[List[str]] = ["pkiEzsignsigningreasonID", "objEzsignsigningreasonDescription", "bEzsignsigningreasonIsactive"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of EzsignsigningreasonRequestCompound from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of obj_ezsignsigningreason_description + if self.obj_ezsignsigningreason_description: + _dict['objEzsignsigningreasonDescription'] = self.obj_ezsignsigningreason_description.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Dict) -> Self: + """Create an instance of EzsignsigningreasonRequestCompound from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsignsigningreasonID": obj.get("pkiEzsignsigningreasonID"), + "objEzsignsigningreasonDescription": MultilingualEzsignsigningreasonDescription.from_dict(obj.get("objEzsignsigningreasonDescription")) if obj.get("objEzsignsigningreasonDescription") is not None else None, + "bEzsignsigningreasonIsactive": obj.get("bEzsignsigningreasonIsactive") + }) + return _obj + + diff --git a/eZmaxApi/models/ezsignsigningreason_response.py b/eZmaxApi/models/ezsignsigningreason_response.py new file mode 100644 index 000000000..a3764941f --- /dev/null +++ b/eZmaxApi/models/ezsignsigningreason_response.py @@ -0,0 +1,99 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictBool +from pydantic import Field +from typing_extensions import Annotated +from eZmaxApi.models.multilingual_ezsignsigningreason_description import MultilingualEzsignsigningreasonDescription +try: + from typing import Self +except ImportError: + from typing_extensions import Self + +class EzsignsigningreasonResponse(BaseModel): + """ + A Ezsignsigningreason Object + """ # noqa: E501 + pki_ezsignsigningreason_id: Annotated[int, Field(le=255, strict=True, ge=0)] = Field(description="The unique ID of the Ezsignsigningreason", alias="pkiEzsignsigningreasonID") + obj_ezsignsigningreason_description: MultilingualEzsignsigningreasonDescription = Field(alias="objEzsignsigningreasonDescription") + b_ezsignsigningreason_isactive: StrictBool = Field(description="Whether the ezsignsigningreason is active or not", alias="bEzsignsigningreasonIsactive") + __properties: ClassVar[List[str]] = ["pkiEzsignsigningreasonID", "objEzsignsigningreasonDescription", "bEzsignsigningreasonIsactive"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of EzsignsigningreasonResponse from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of obj_ezsignsigningreason_description + if self.obj_ezsignsigningreason_description: + _dict['objEzsignsigningreasonDescription'] = self.obj_ezsignsigningreason_description.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Dict) -> Self: + """Create an instance of EzsignsigningreasonResponse from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsignsigningreasonID": obj.get("pkiEzsignsigningreasonID"), + "objEzsignsigningreasonDescription": MultilingualEzsignsigningreasonDescription.from_dict(obj.get("objEzsignsigningreasonDescription")) if obj.get("objEzsignsigningreasonDescription") is not None else None, + "bEzsignsigningreasonIsactive": obj.get("bEzsignsigningreasonIsactive") + }) + return _obj + + diff --git a/eZmaxApi/models/ezsignsigningreason_response_compound.py b/eZmaxApi/models/ezsignsigningreason_response_compound.py new file mode 100644 index 000000000..bc213545c --- /dev/null +++ b/eZmaxApi/models/ezsignsigningreason_response_compound.py @@ -0,0 +1,99 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictBool +from pydantic import Field +from typing_extensions import Annotated +from eZmaxApi.models.multilingual_ezsignsigningreason_description import MultilingualEzsignsigningreasonDescription +try: + from typing import Self +except ImportError: + from typing_extensions import Self + +class EzsignsigningreasonResponseCompound(BaseModel): + """ + A Ezsignsigningreason Object + """ # noqa: E501 + pki_ezsignsigningreason_id: Annotated[int, Field(le=255, strict=True, ge=0)] = Field(description="The unique ID of the Ezsignsigningreason", alias="pkiEzsignsigningreasonID") + obj_ezsignsigningreason_description: MultilingualEzsignsigningreasonDescription = Field(alias="objEzsignsigningreasonDescription") + b_ezsignsigningreason_isactive: StrictBool = Field(description="Whether the ezsignsigningreason is active or not", alias="bEzsignsigningreasonIsactive") + __properties: ClassVar[List[str]] = ["pkiEzsignsigningreasonID", "objEzsignsigningreasonDescription", "bEzsignsigningreasonIsactive"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of EzsignsigningreasonResponseCompound from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of obj_ezsignsigningreason_description + if self.obj_ezsignsigningreason_description: + _dict['objEzsignsigningreasonDescription'] = self.obj_ezsignsigningreason_description.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Dict) -> Self: + """Create an instance of EzsignsigningreasonResponseCompound from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsignsigningreasonID": obj.get("pkiEzsignsigningreasonID"), + "objEzsignsigningreasonDescription": MultilingualEzsignsigningreasonDescription.from_dict(obj.get("objEzsignsigningreasonDescription")) if obj.get("objEzsignsigningreasonDescription") is not None else None, + "bEzsignsigningreasonIsactive": obj.get("bEzsignsigningreasonIsactive") + }) + return _obj + + diff --git a/eZmaxApi/models/ezsigntemplate_autocomplete_element_response.py b/eZmaxApi/models/ezsigntemplate_autocomplete_element_response.py index d6a4268df..554d6a816 100644 --- a/eZmaxApi/models/ezsigntemplate_autocomplete_element_response.py +++ b/eZmaxApi/models/ezsigntemplate_autocomplete_element_response.py @@ -19,60 +19,79 @@ import json - -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictBool, StrictStr +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.field_e_ezsignfoldertype_privacylevel import FieldEEzsignfoldertypePrivacylevel +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplateAutocompleteElementResponse(BaseModel): """ - A Ezsigntemplate AutocompleteElement Response # noqa: E501 - """ - e_ezsignfoldertype_privacylevel: FieldEEzsignfoldertypePrivacylevel = Field(..., alias="eEzsignfoldertypePrivacylevel") - s_ezsigntemplate_description: StrictStr = Field(..., alias="sEzsigntemplateDescription", description="The description of the Ezsigntemplate") - pki_ezsigntemplate_id: conint(strict=True, ge=0) = Field(..., alias="pkiEzsigntemplateID", description="The unique ID of the Ezsigntemplate") - b_ezsigntemplate_isactive: StrictBool = Field(..., alias="bEzsigntemplateIsactive", description="Whether the Ezsigntemplate is active or not") - __properties = ["eEzsignfoldertypePrivacylevel", "sEzsigntemplateDescription", "pkiEzsigntemplateID", "bEzsigntemplateIsactive"] + A Ezsigntemplate AutocompleteElement Response + """ # noqa: E501 + e_ezsignfoldertype_privacylevel: FieldEEzsignfoldertypePrivacylevel = Field(alias="eEzsignfoldertypePrivacylevel") + s_ezsigntemplate_description: StrictStr = Field(description="The description of the Ezsigntemplate", alias="sEzsigntemplateDescription") + pki_ezsigntemplate_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsigntemplate", alias="pkiEzsigntemplateID") + b_ezsigntemplate_isactive: StrictBool = Field(description="Whether the Ezsigntemplate is active or not", alias="bEzsigntemplateIsactive") + __properties: ClassVar[List[str]] = ["eEzsignfoldertypePrivacylevel", "sEzsigntemplateDescription", "pkiEzsigntemplateID", "bEzsigntemplateIsactive"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplateAutocompleteElementResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplateAutocompleteElementResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplateAutocompleteElementResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplateAutocompleteElementResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplateAutocompleteElementResponse.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplateAutocompleteElementResponse.parse_obj({ - "e_ezsignfoldertype_privacylevel": obj.get("eEzsignfoldertypePrivacylevel"), - "s_ezsigntemplate_description": obj.get("sEzsigntemplateDescription"), - "pki_ezsigntemplate_id": obj.get("pkiEzsigntemplateID"), - "b_ezsigntemplate_isactive": obj.get("bEzsigntemplateIsactive") + _obj = cls.model_validate({ + "eEzsignfoldertypePrivacylevel": obj.get("eEzsignfoldertypePrivacylevel"), + "sEzsigntemplateDescription": obj.get("sEzsigntemplateDescription"), + "pkiEzsigntemplateID": obj.get("pkiEzsigntemplateID"), + "bEzsigntemplateIsactive": obj.get("bEzsigntemplateIsactive") }) return _obj diff --git a/eZmaxApi/models/ezsigntemplate_copy_v1_request.py b/eZmaxApi/models/ezsigntemplate_copy_v1_request.py index e756e8b20..8113e78d4 100644 --- a/eZmaxApi/models/ezsigntemplate_copy_v1_request.py +++ b/eZmaxApi/models/ezsigntemplate_copy_v1_request.py @@ -19,53 +19,72 @@ import json -from typing import List -from pydantic import BaseModel, Field, conint, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplateCopyV1Request(BaseModel): """ - Request for POST /1/object/ezsigntemplate/{pkiEzsigntemplateID}/copy # noqa: E501 - """ - a_fki_ezsignfoldertype_id: conlist(conint(strict=True, ge=0), min_items=1) = Field(..., alias="a_fkiEzsignfoldertypeID") - __properties = ["a_fkiEzsignfoldertypeID"] + Request for POST /1/object/ezsigntemplate/{pkiEzsigntemplateID}/copy + """ # noqa: E501 + a_fki_ezsignfoldertype_id: Annotated[List[Annotated[int, Field(strict=True, ge=0)]], Field(min_length=1)] = Field(alias="a_fkiEzsignfoldertypeID") + __properties: ClassVar[List[str]] = ["a_fkiEzsignfoldertypeID"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplateCopyV1Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplateCopyV1Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplateCopyV1Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplateCopyV1Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplateCopyV1Request.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplateCopyV1Request.parse_obj({ - "a_fki_ezsignfoldertype_id": obj.get("a_fkiEzsignfoldertypeID") + _obj = cls.model_validate({ + "a_fkiEzsignfoldertypeID": obj.get("a_fkiEzsignfoldertypeID") }) return _obj diff --git a/eZmaxApi/models/ezsigntemplate_copy_v1_response.py b/eZmaxApi/models/ezsigntemplate_copy_v1_response.py index 2def981fc..29d938a76 100644 --- a/eZmaxApi/models/ezsigntemplate_copy_v1_response.py +++ b/eZmaxApi/models/ezsigntemplate_copy_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.ezsigntemplate_copy_v1_response_m_payload import EzsigntemplateCopyV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplateCopyV1Response(BaseModel): """ - Response for POST /1/object/ezsigntemplate/{pkiEzsigntemplateID}/copy # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzsigntemplateCopyV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for POST /1/object/ezsigntemplate/{pkiEzsigntemplateID}/copy + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsigntemplateCopyV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplateCopyV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplateCopyV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplateCopyV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplateCopyV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplateCopyV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplateCopyV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzsigntemplateCopyV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsigntemplateCopyV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigntemplate_copy_v1_response_m_payload.py b/eZmaxApi/models/ezsigntemplate_copy_v1_response_m_payload.py index 812460e5d..73b9fd711 100644 --- a/eZmaxApi/models/ezsigntemplate_copy_v1_response_m_payload.py +++ b/eZmaxApi/models/ezsigntemplate_copy_v1_response_m_payload.py @@ -19,53 +19,72 @@ import json -from typing import List -from pydantic import BaseModel, Field, conint, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplateCopyV1ResponseMPayload(BaseModel): """ - Payload for POST /1/object/ezsigntemplate/{pkiEzsigntemplateID}/copy # noqa: E501 - """ - a_pki_ezsigntemplate_id: conlist(conint(strict=True, ge=0)) = Field(..., alias="a_pkiEzsigntemplateID", description="An array of unique IDs representing the object that were requested to be copied. They are returned in the same order as the array containing the objects to be created that was sent in the request.") - __properties = ["a_pkiEzsigntemplateID"] + Payload for POST /1/object/ezsigntemplate/{pkiEzsigntemplateID}/copy + """ # noqa: E501 + a_pki_ezsigntemplate_id: List[Annotated[int, Field(strict=True, ge=0)]] = Field(description="An array of unique IDs representing the object that were requested to be copied. They are returned in the same order as the array containing the objects to be created that was sent in the request.", alias="a_pkiEzsigntemplateID") + __properties: ClassVar[List[str]] = ["a_pkiEzsigntemplateID"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplateCopyV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplateCopyV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplateCopyV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplateCopyV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplateCopyV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplateCopyV1ResponseMPayload.parse_obj({ - "a_pki_ezsigntemplate_id": obj.get("a_pkiEzsigntemplateID") + _obj = cls.model_validate({ + "a_pkiEzsigntemplateID": obj.get("a_pkiEzsigntemplateID") }) return _obj diff --git a/eZmaxApi/models/ezsigntemplate_create_object_v1_request.py b/eZmaxApi/models/ezsigntemplate_create_object_v1_request.py index 4f8e2b16f..3661a2b1b 100644 --- a/eZmaxApi/models/ezsigntemplate_create_object_v1_request.py +++ b/eZmaxApi/models/ezsigntemplate_create_object_v1_request.py @@ -19,41 +19,60 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.ezsigntemplate_request_compound import EzsigntemplateRequestCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplateCreateObjectV1Request(BaseModel): """ - Request for POST /1/object/ezsigntemplate # noqa: E501 - """ - a_obj_ezsigntemplate: conlist(EzsigntemplateRequestCompound, min_items=1) = Field(..., alias="a_objEzsigntemplate") - __properties = ["a_objEzsigntemplate"] + Request for POST /1/object/ezsigntemplate + """ # noqa: E501 + a_obj_ezsigntemplate: Annotated[List[EzsigntemplateRequestCompound], Field(min_length=1)] = Field(alias="a_objEzsigntemplate") + __properties: ClassVar[List[str]] = ["a_objEzsigntemplate"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplateCreateObjectV1Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplateCreateObjectV1Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_ezsigntemplate (list) _items = [] if self.a_obj_ezsigntemplate: @@ -64,16 +83,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplateCreateObjectV1Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplateCreateObjectV1Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplateCreateObjectV1Request.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplateCreateObjectV1Request.parse_obj({ - "a_obj_ezsigntemplate": [EzsigntemplateRequestCompound.from_dict(_item) for _item in obj.get("a_objEzsigntemplate")] if obj.get("a_objEzsigntemplate") is not None else None + _obj = cls.model_validate({ + "a_objEzsigntemplate": [EzsigntemplateRequestCompound.from_dict(_item) for _item in obj.get("a_objEzsigntemplate")] if obj.get("a_objEzsigntemplate") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigntemplate_create_object_v1_response.py b/eZmaxApi/models/ezsigntemplate_create_object_v1_response.py index fd3114f51..c8b9625d0 100644 --- a/eZmaxApi/models/ezsigntemplate_create_object_v1_response.py +++ b/eZmaxApi/models/ezsigntemplate_create_object_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.ezsigntemplate_create_object_v1_response_m_payload import EzsigntemplateCreateObjectV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplateCreateObjectV1Response(BaseModel): """ - Response for POST /1/object/ezsigntemplate # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzsigntemplateCreateObjectV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for POST /1/object/ezsigntemplate + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsigntemplateCreateObjectV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplateCreateObjectV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplateCreateObjectV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplateCreateObjectV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplateCreateObjectV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplateCreateObjectV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplateCreateObjectV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzsigntemplateCreateObjectV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsigntemplateCreateObjectV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigntemplate_create_object_v1_response_m_payload.py b/eZmaxApi/models/ezsigntemplate_create_object_v1_response_m_payload.py index 0d8ba4ba5..9ad3681a2 100644 --- a/eZmaxApi/models/ezsigntemplate_create_object_v1_response_m_payload.py +++ b/eZmaxApi/models/ezsigntemplate_create_object_v1_response_m_payload.py @@ -19,53 +19,72 @@ import json -from typing import List -from pydantic import BaseModel, Field, conint, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplateCreateObjectV1ResponseMPayload(BaseModel): """ - Payload for POST /1/object/ezsigntemplate # noqa: E501 - """ - a_pki_ezsigntemplate_id: conlist(conint(strict=True, ge=0), min_items=1) = Field(..., alias="a_pkiEzsigntemplateID", description="An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request.") - __properties = ["a_pkiEzsigntemplateID"] + Payload for POST /1/object/ezsigntemplate + """ # noqa: E501 + a_pki_ezsigntemplate_id: Annotated[List[Annotated[int, Field(strict=True, ge=0)]], Field(min_length=1)] = Field(description="An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request.", alias="a_pkiEzsigntemplateID") + __properties: ClassVar[List[str]] = ["a_pkiEzsigntemplateID"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplateCreateObjectV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplateCreateObjectV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplateCreateObjectV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplateCreateObjectV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplateCreateObjectV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplateCreateObjectV1ResponseMPayload.parse_obj({ - "a_pki_ezsigntemplate_id": obj.get("a_pkiEzsigntemplateID") + _obj = cls.model_validate({ + "a_pkiEzsigntemplateID": obj.get("a_pkiEzsigntemplateID") }) return _obj diff --git a/eZmaxApi/models/ezsigntemplate_delete_object_v1_response.py b/eZmaxApi/models/ezsigntemplate_delete_object_v1_response.py index e96094c8f..8a1322a48 100644 --- a/eZmaxApi/models/ezsigntemplate_delete_object_v1_response.py +++ b/eZmaxApi/models/ezsigntemplate_delete_object_v1_response.py @@ -19,43 +19,61 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplateDeleteObjectV1Response(BaseModel): """ - Response for DELETE /1/object/ezsigntemplate/{pkiEzsigntemplateID} # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - __properties = ["objDebugPayload", "objDebug"] + Response for DELETE /1/object/ezsigntemplate/{pkiEzsigntemplateID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplateDeleteObjectV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplateDeleteObjectV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -65,17 +83,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplateDeleteObjectV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplateDeleteObjectV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplateDeleteObjectV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplateDeleteObjectV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigntemplate_edit_object_v1_request.py b/eZmaxApi/models/ezsigntemplate_edit_object_v1_request.py index 4c5bacd5e..6fb73a3e9 100644 --- a/eZmaxApi/models/ezsigntemplate_edit_object_v1_request.py +++ b/eZmaxApi/models/ezsigntemplate_edit_object_v1_request.py @@ -19,57 +19,75 @@ import json - -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.ezsigntemplate_request_compound import EzsigntemplateRequestCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplateEditObjectV1Request(BaseModel): """ - Request for PUT /1/object/ezsigntemplate/{pkiEzsigntemplateID} # noqa: E501 - """ - obj_ezsigntemplate: EzsigntemplateRequestCompound = Field(..., alias="objEzsigntemplate") - __properties = ["objEzsigntemplate"] + Request for PUT /1/object/ezsigntemplate/{pkiEzsigntemplateID} + """ # noqa: E501 + obj_ezsigntemplate: EzsigntemplateRequestCompound = Field(alias="objEzsigntemplate") + __properties: ClassVar[List[str]] = ["objEzsigntemplate"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplateEditObjectV1Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplateEditObjectV1Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_ezsigntemplate if self.obj_ezsigntemplate: _dict['objEzsigntemplate'] = self.obj_ezsigntemplate.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplateEditObjectV1Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplateEditObjectV1Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplateEditObjectV1Request.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplateEditObjectV1Request.parse_obj({ - "obj_ezsigntemplate": EzsigntemplateRequestCompound.from_dict(obj.get("objEzsigntemplate")) if obj.get("objEzsigntemplate") is not None else None + _obj = cls.model_validate({ + "objEzsigntemplate": EzsigntemplateRequestCompound.from_dict(obj.get("objEzsigntemplate")) if obj.get("objEzsigntemplate") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigntemplate_edit_object_v1_response.py b/eZmaxApi/models/ezsigntemplate_edit_object_v1_response.py index 88a9f29ac..10f3ddbb3 100644 --- a/eZmaxApi/models/ezsigntemplate_edit_object_v1_response.py +++ b/eZmaxApi/models/ezsigntemplate_edit_object_v1_response.py @@ -19,43 +19,61 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplateEditObjectV1Response(BaseModel): """ - Response for PUT /1/object/ezsigntemplate/{pkiEzsigntemplateID} # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - __properties = ["objDebugPayload", "objDebug"] + Response for PUT /1/object/ezsigntemplate/{pkiEzsigntemplateID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplateEditObjectV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplateEditObjectV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -65,17 +83,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplateEditObjectV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplateEditObjectV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplateEditObjectV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplateEditObjectV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigntemplate_get_autocomplete_v2_response.py b/eZmaxApi/models/ezsigntemplate_get_autocomplete_v2_response.py index 9941dbf40..f7c3de03a 100644 --- a/eZmaxApi/models/ezsigntemplate_get_autocomplete_v2_response.py +++ b/eZmaxApi/models/ezsigntemplate_get_autocomplete_v2_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.ezsigntemplate_get_autocomplete_v2_response_m_payload import EzsigntemplateGetAutocompleteV2ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplateGetAutocompleteV2Response(BaseModel): """ - Response for GET /2/object/ezsigntemplate/getAutocomplete # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzsigntemplateGetAutocompleteV2ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /2/object/ezsigntemplate/getAutocomplete + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsigntemplateGetAutocompleteV2ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplateGetAutocompleteV2Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplateGetAutocompleteV2Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplateGetAutocompleteV2Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplateGetAutocompleteV2Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplateGetAutocompleteV2Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplateGetAutocompleteV2Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzsigntemplateGetAutocompleteV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsigntemplateGetAutocompleteV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigntemplate_get_autocomplete_v2_response_m_payload.py b/eZmaxApi/models/ezsigntemplate_get_autocomplete_v2_response_m_payload.py index 17f8916ff..405c28b32 100644 --- a/eZmaxApi/models/ezsigntemplate_get_autocomplete_v2_response_m_payload.py +++ b/eZmaxApi/models/ezsigntemplate_get_autocomplete_v2_response_m_payload.py @@ -19,41 +19,59 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.ezsigntemplate_autocomplete_element_response import EzsigntemplateAutocompleteElementResponse +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplateGetAutocompleteV2ResponseMPayload(BaseModel): """ - Payload for POST /2/object/ezsigntemplate/getAutocomplete # noqa: E501 - """ - a_obj_ezsigntemplate: conlist(EzsigntemplateAutocompleteElementResponse) = Field(..., alias="a_objEzsigntemplate", description="An array of Ezsigntemplate autocomplete element response.") - __properties = ["a_objEzsigntemplate"] + Payload for POST /2/object/ezsigntemplate/getAutocomplete + """ # noqa: E501 + a_obj_ezsigntemplate: List[EzsigntemplateAutocompleteElementResponse] = Field(description="An array of Ezsigntemplate autocomplete element response.", alias="a_objEzsigntemplate") + __properties: ClassVar[List[str]] = ["a_objEzsigntemplate"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplateGetAutocompleteV2ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplateGetAutocompleteV2ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_ezsigntemplate (list) _items = [] if self.a_obj_ezsigntemplate: @@ -64,16 +82,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplateGetAutocompleteV2ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplateGetAutocompleteV2ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplateGetAutocompleteV2ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplateGetAutocompleteV2ResponseMPayload.parse_obj({ - "a_obj_ezsigntemplate": [EzsigntemplateAutocompleteElementResponse.from_dict(_item) for _item in obj.get("a_objEzsigntemplate")] if obj.get("a_objEzsigntemplate") is not None else None + _obj = cls.model_validate({ + "a_objEzsigntemplate": [EzsigntemplateAutocompleteElementResponse.from_dict(_item) for _item in obj.get("a_objEzsigntemplate")] if obj.get("a_objEzsigntemplate") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigntemplate_get_list_v1_response.py b/eZmaxApi/models/ezsigntemplate_get_list_v1_response.py index 2793e83ff..b201c3369 100644 --- a/eZmaxApi/models/ezsigntemplate_get_list_v1_response.py +++ b/eZmaxApi/models/ezsigntemplate_get_list_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload_get_list import CommonResponseObjDebugPayloadGetList from eZmaxApi.models.ezsigntemplate_get_list_v1_response_m_payload import EzsigntemplateGetListV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplateGetListV1Response(BaseModel): """ - Response for GET /1/object/ezsigntemplate/getList # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayloadGetList = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzsigntemplateGetListV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /1/object/ezsigntemplate/getList + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayloadGetList = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsigntemplateGetListV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplateGetListV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplateGetListV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplateGetListV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplateGetListV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplateGetListV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplateGetListV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayloadGetList.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzsigntemplateGetListV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayloadGetList.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsigntemplateGetListV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigntemplate_get_list_v1_response_m_payload.py b/eZmaxApi/models/ezsigntemplate_get_list_v1_response_m_payload.py index 1ee7a6bd0..5757c4a59 100644 --- a/eZmaxApi/models/ezsigntemplate_get_list_v1_response_m_payload.py +++ b/eZmaxApi/models/ezsigntemplate_get_list_v1_response_m_payload.py @@ -19,43 +19,61 @@ import json -from typing import List -from pydantic import BaseModel, Field, StrictInt, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictInt +from pydantic import Field from eZmaxApi.models.ezsigntemplate_list_element import EzsigntemplateListElement +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplateGetListV1ResponseMPayload(BaseModel): """ - Payload for GET /1/object/ezsigntemplate/getList # noqa: E501 - """ - i_row_returned: StrictInt = Field(..., alias="iRowReturned", description="The number of rows returned") - i_row_filtered: StrictInt = Field(..., alias="iRowFiltered", description="The number of rows matching your filters (if any) or the total number of rows") - a_obj_ezsigntemplate: conlist(EzsigntemplateListElement) = Field(..., alias="a_objEzsigntemplate") - __properties = ["iRowReturned", "iRowFiltered", "a_objEzsigntemplate"] + Payload for GET /1/object/ezsigntemplate/getList + """ # noqa: E501 + i_row_returned: StrictInt = Field(description="The number of rows returned", alias="iRowReturned") + i_row_filtered: StrictInt = Field(description="The number of rows matching your filters (if any) or the total number of rows", alias="iRowFiltered") + a_obj_ezsigntemplate: List[EzsigntemplateListElement] = Field(alias="a_objEzsigntemplate") + __properties: ClassVar[List[str]] = ["iRowReturned", "iRowFiltered", "a_objEzsigntemplate"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplateGetListV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplateGetListV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_ezsigntemplate (list) _items = [] if self.a_obj_ezsigntemplate: @@ -66,18 +84,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplateGetListV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplateGetListV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplateGetListV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplateGetListV1ResponseMPayload.parse_obj({ - "i_row_returned": obj.get("iRowReturned"), - "i_row_filtered": obj.get("iRowFiltered"), - "a_obj_ezsigntemplate": [EzsigntemplateListElement.from_dict(_item) for _item in obj.get("a_objEzsigntemplate")] if obj.get("a_objEzsigntemplate") is not None else None + _obj = cls.model_validate({ + "iRowReturned": obj.get("iRowReturned"), + "iRowFiltered": obj.get("iRowFiltered"), + "a_objEzsigntemplate": [EzsigntemplateListElement.from_dict(_item) for _item in obj.get("a_objEzsigntemplate")] if obj.get("a_objEzsigntemplate") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigntemplate_get_object_v1_response.py b/eZmaxApi/models/ezsigntemplate_get_object_v1_response.py index 01b08439c..fc4ac7837 100644 --- a/eZmaxApi/models/ezsigntemplate_get_object_v1_response.py +++ b/eZmaxApi/models/ezsigntemplate_get_object_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.ezsigntemplate_get_object_v1_response_m_payload import EzsigntemplateGetObjectV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplateGetObjectV1Response(BaseModel): """ - Response for GET /1/object/ezsigntemplate/{pkiEzsigntemplateID} # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzsigntemplateGetObjectV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /1/object/ezsigntemplate/{pkiEzsigntemplateID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsigntemplateGetObjectV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplateGetObjectV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplateGetObjectV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplateGetObjectV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplateGetObjectV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplateGetObjectV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplateGetObjectV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzsigntemplateGetObjectV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsigntemplateGetObjectV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigntemplate_get_object_v1_response_m_payload.py b/eZmaxApi/models/ezsigntemplate_get_object_v1_response_m_payload.py index ee673f26d..46e391a94 100644 --- a/eZmaxApi/models/ezsigntemplate_get_object_v1_response_m_payload.py +++ b/eZmaxApi/models/ezsigntemplate_get_object_v1_response_m_payload.py @@ -19,53 +19,72 @@ import json -from typing import List, Optional -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint, conlist +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, StrictStr +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.common_audit import CommonAudit from eZmaxApi.models.ezsigntemplatedocument_response import EzsigntemplatedocumentResponse from eZmaxApi.models.ezsigntemplatesigner_response_compound import EzsigntemplatesignerResponseCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplateGetObjectV1ResponseMPayload(BaseModel): """ - Payload for GET /1/object/ezsigntemplate/{pkiEzsigntemplateID} # noqa: E501 - """ - pki_ezsigntemplate_id: conint(strict=True, ge=0) = Field(..., alias="pkiEzsigntemplateID", description="The unique ID of the Ezsigntemplate") - fki_ezsigntemplatedocument_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiEzsigntemplatedocumentID", description="The unique ID of the Ezsigntemplatedocument") - fki_ezsignfoldertype_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsignfoldertypeID", description="The unique ID of the Ezsignfoldertype.") - fki_language_id: conint(strict=True, le=2, ge=1) = Field(..., alias="fkiLanguageID", description="The unique ID of the Language. Valid values: |Value|Description| |-|-| |1|French| |2|English|") - s_language_name_x: StrictStr = Field(..., alias="sLanguageNameX", description="The Name of the Language in the language of the requester") - s_ezsigntemplate_description: StrictStr = Field(..., alias="sEzsigntemplateDescription", description="The description of the Ezsigntemplate") - b_ezsigntemplate_adminonly: StrictBool = Field(..., alias="bEzsigntemplateAdminonly", description="Whether the Ezsigntemplate can be accessed by admin users only (eUserType=Normal)") - s_ezsignfoldertype_name_x: StrictStr = Field(..., alias="sEzsignfoldertypeNameX", description="The name of the Ezsignfoldertype in the language of the requester") - obj_audit: CommonAudit = Field(..., alias="objAudit") - obj_ezsigntemplatedocument: Optional[EzsigntemplatedocumentResponse] = Field(None, alias="objEzsigntemplatedocument") - a_obj_ezsigntemplatesigner: conlist(EzsigntemplatesignerResponseCompound) = Field(..., alias="a_objEzsigntemplatesigner") - __properties = ["pkiEzsigntemplateID", "fkiEzsigntemplatedocumentID", "fkiEzsignfoldertypeID", "fkiLanguageID", "sLanguageNameX", "sEzsigntemplateDescription", "bEzsigntemplateAdminonly", "sEzsignfoldertypeNameX", "objAudit", "objEzsigntemplatedocument", "a_objEzsigntemplatesigner"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + Payload for GET /1/object/ezsigntemplate/{pkiEzsigntemplateID} + """ # noqa: E501 + pki_ezsigntemplate_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsigntemplate", alias="pkiEzsigntemplateID") + fki_ezsigntemplatedocument_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsigntemplatedocument", alias="fkiEzsigntemplatedocumentID") + fki_ezsignfoldertype_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsignfoldertype.", alias="fkiEzsignfoldertypeID") + fki_language_id: Annotated[int, Field(le=2, strict=True, ge=1)] = Field(description="The unique ID of the Language. Valid values: |Value|Description| |-|-| |1|French| |2|English|", alias="fkiLanguageID") + s_language_name_x: StrictStr = Field(description="The Name of the Language in the language of the requester", alias="sLanguageNameX") + s_ezsigntemplate_description: StrictStr = Field(description="The description of the Ezsigntemplate", alias="sEzsigntemplateDescription") + b_ezsigntemplate_adminonly: StrictBool = Field(description="Whether the Ezsigntemplate can be accessed by admin users only (eUserType=Normal)", alias="bEzsigntemplateAdminonly") + s_ezsignfoldertype_name_x: StrictStr = Field(description="The name of the Ezsignfoldertype in the language of the requester", alias="sEzsignfoldertypeNameX") + obj_audit: CommonAudit = Field(alias="objAudit") + obj_ezsigntemplatedocument: Optional[EzsigntemplatedocumentResponse] = Field(default=None, alias="objEzsigntemplatedocument") + a_obj_ezsigntemplatesigner: List[EzsigntemplatesignerResponseCompound] = Field(alias="a_objEzsigntemplatesigner") + __properties: ClassVar[List[str]] = ["pkiEzsigntemplateID", "fkiEzsigntemplatedocumentID", "fkiEzsignfoldertypeID", "fkiLanguageID", "sLanguageNameX", "sEzsigntemplateDescription", "bEzsigntemplateAdminonly", "sEzsignfoldertypeNameX", "objAudit", "objEzsigntemplatedocument", "a_objEzsigntemplatesigner"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplateGetObjectV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplateGetObjectV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_audit if self.obj_audit: _dict['objAudit'] = self.obj_audit.to_dict() @@ -82,26 +101,26 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplateGetObjectV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplateGetObjectV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplateGetObjectV1ResponseMPayload.parse_obj(obj) - - _obj = EzsigntemplateGetObjectV1ResponseMPayload.parse_obj({ - "pki_ezsigntemplate_id": obj.get("pkiEzsigntemplateID"), - "fki_ezsigntemplatedocument_id": obj.get("fkiEzsigntemplatedocumentID"), - "fki_ezsignfoldertype_id": obj.get("fkiEzsignfoldertypeID"), - "fki_language_id": obj.get("fkiLanguageID"), - "s_language_name_x": obj.get("sLanguageNameX"), - "s_ezsigntemplate_description": obj.get("sEzsigntemplateDescription"), - "b_ezsigntemplate_adminonly": obj.get("bEzsigntemplateAdminonly"), - "s_ezsignfoldertype_name_x": obj.get("sEzsignfoldertypeNameX"), - "obj_audit": CommonAudit.from_dict(obj.get("objAudit")) if obj.get("objAudit") is not None else None, - "obj_ezsigntemplatedocument": EzsigntemplatedocumentResponse.from_dict(obj.get("objEzsigntemplatedocument")) if obj.get("objEzsigntemplatedocument") is not None else None, - "a_obj_ezsigntemplatesigner": [EzsigntemplatesignerResponseCompound.from_dict(_item) for _item in obj.get("a_objEzsigntemplatesigner")] if obj.get("a_objEzsigntemplatesigner") is not None else None + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsigntemplateID": obj.get("pkiEzsigntemplateID"), + "fkiEzsigntemplatedocumentID": obj.get("fkiEzsigntemplatedocumentID"), + "fkiEzsignfoldertypeID": obj.get("fkiEzsignfoldertypeID"), + "fkiLanguageID": obj.get("fkiLanguageID"), + "sLanguageNameX": obj.get("sLanguageNameX"), + "sEzsigntemplateDescription": obj.get("sEzsigntemplateDescription"), + "bEzsigntemplateAdminonly": obj.get("bEzsigntemplateAdminonly"), + "sEzsignfoldertypeNameX": obj.get("sEzsignfoldertypeNameX"), + "objAudit": CommonAudit.from_dict(obj.get("objAudit")) if obj.get("objAudit") is not None else None, + "objEzsigntemplatedocument": EzsigntemplatedocumentResponse.from_dict(obj.get("objEzsigntemplatedocument")) if obj.get("objEzsigntemplatedocument") is not None else None, + "a_objEzsigntemplatesigner": [EzsigntemplatesignerResponseCompound.from_dict(_item) for _item in obj.get("a_objEzsigntemplatesigner")] if obj.get("a_objEzsigntemplatesigner") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigntemplate_get_object_v2_response.py b/eZmaxApi/models/ezsigntemplate_get_object_v2_response.py index 01588f7b1..a516f1fc1 100644 --- a/eZmaxApi/models/ezsigntemplate_get_object_v2_response.py +++ b/eZmaxApi/models/ezsigntemplate_get_object_v2_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.ezsigntemplate_get_object_v2_response_m_payload import EzsigntemplateGetObjectV2ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplateGetObjectV2Response(BaseModel): """ - Response for GET /2/object/ezsigntemplate/{pkiEzsigntemplateID} # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzsigntemplateGetObjectV2ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /2/object/ezsigntemplate/{pkiEzsigntemplateID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsigntemplateGetObjectV2ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplateGetObjectV2Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplateGetObjectV2Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplateGetObjectV2Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplateGetObjectV2Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplateGetObjectV2Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplateGetObjectV2Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzsigntemplateGetObjectV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsigntemplateGetObjectV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigntemplate_get_object_v2_response_m_payload.py b/eZmaxApi/models/ezsigntemplate_get_object_v2_response_m_payload.py index 6924f4411..82811a85c 100644 --- a/eZmaxApi/models/ezsigntemplate_get_object_v2_response_m_payload.py +++ b/eZmaxApi/models/ezsigntemplate_get_object_v2_response_m_payload.py @@ -19,57 +19,75 @@ import json - -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.ezsigntemplate_response_compound import EzsigntemplateResponseCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplateGetObjectV2ResponseMPayload(BaseModel): """ - Payload for GET /2/object/ezsigntemplate/{pkiEzsigntemplateID} # noqa: E501 - """ - obj_ezsigntemplate: EzsigntemplateResponseCompound = Field(..., alias="objEzsigntemplate") - __properties = ["objEzsigntemplate"] + Payload for GET /2/object/ezsigntemplate/{pkiEzsigntemplateID} + """ # noqa: E501 + obj_ezsigntemplate: EzsigntemplateResponseCompound = Field(alias="objEzsigntemplate") + __properties: ClassVar[List[str]] = ["objEzsigntemplate"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplateGetObjectV2ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplateGetObjectV2ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_ezsigntemplate if self.obj_ezsigntemplate: _dict['objEzsigntemplate'] = self.obj_ezsigntemplate.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplateGetObjectV2ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplateGetObjectV2ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplateGetObjectV2ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplateGetObjectV2ResponseMPayload.parse_obj({ - "obj_ezsigntemplate": EzsigntemplateResponseCompound.from_dict(obj.get("objEzsigntemplate")) if obj.get("objEzsigntemplate") is not None else None + _obj = cls.model_validate({ + "objEzsigntemplate": EzsigntemplateResponseCompound.from_dict(obj.get("objEzsigntemplate")) if obj.get("objEzsigntemplate") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigntemplate_list_element.py b/eZmaxApi/models/ezsigntemplate_list_element.py index 1e571f887..f9ea73660 100644 --- a/eZmaxApi/models/ezsigntemplate_list_element.py +++ b/eZmaxApi/models/ezsigntemplate_list_element.py @@ -19,69 +19,88 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictBool, StrictInt, StrictStr, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, StrictInt, StrictStr +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplateListElement(BaseModel): """ - A Ezsigntemplate List Element # noqa: E501 - """ - pki_ezsigntemplate_id: conint(strict=True, ge=0) = Field(..., alias="pkiEzsigntemplateID", description="The unique ID of the Ezsigntemplate") - fki_ezsignfoldertype_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsignfoldertypeID", description="The unique ID of the Ezsignfoldertype.") - fki_language_id: conint(strict=True, le=2, ge=1) = Field(..., alias="fkiLanguageID", description="The unique ID of the Language. Valid values: |Value|Description| |-|-| |1|French| |2|English|") - s_ezsigntemplate_description: StrictStr = Field(..., alias="sEzsigntemplateDescription", description="The description of the Ezsigntemplate") - i_ezsigntemplatedocument_pagetotal: Optional[conint(strict=True, ge=1)] = Field(None, alias="iEzsigntemplatedocumentPagetotal", description="The number of pages in the Ezsigntemplatedocument.") - i_ezsigntemplate_signaturetotal: Optional[StrictInt] = Field(None, alias="iEzsigntemplateSignaturetotal", description="The number of total signatures in the Ezsigntemplate.") - i_ezsigntemplate_formfieldtotal: Optional[StrictInt] = Field(None, alias="iEzsigntemplateFormfieldtotal", description="The number of total form fields in the Ezsigntemplate.") - b_ezsigntemplate_incomplete: StrictBool = Field(..., alias="bEzsigntemplateIncomplete", description="Indicate the Ezsigntemplate is incomplete and cannot be used") - s_ezsignfoldertype_name_x: StrictStr = Field(..., alias="sEzsignfoldertypeNameX", description="The name of the Ezsignfoldertype in the language of the requester") - __properties = ["pkiEzsigntemplateID", "fkiEzsignfoldertypeID", "fkiLanguageID", "sEzsigntemplateDescription", "iEzsigntemplatedocumentPagetotal", "iEzsigntemplateSignaturetotal", "iEzsigntemplateFormfieldtotal", "bEzsigntemplateIncomplete", "sEzsignfoldertypeNameX"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + A Ezsigntemplate List Element + """ # noqa: E501 + pki_ezsigntemplate_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsigntemplate", alias="pkiEzsigntemplateID") + fki_ezsignfoldertype_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsignfoldertype.", alias="fkiEzsignfoldertypeID") + fki_language_id: Annotated[int, Field(le=2, strict=True, ge=1)] = Field(description="The unique ID of the Language. Valid values: |Value|Description| |-|-| |1|French| |2|English|", alias="fkiLanguageID") + s_ezsigntemplate_description: StrictStr = Field(description="The description of the Ezsigntemplate", alias="sEzsigntemplateDescription") + i_ezsigntemplatedocument_pagetotal: Optional[Annotated[int, Field(strict=True, ge=1)]] = Field(default=None, description="The number of pages in the Ezsigntemplatedocument.", alias="iEzsigntemplatedocumentPagetotal") + i_ezsigntemplate_signaturetotal: Optional[StrictInt] = Field(default=None, description="The number of total signatures in the Ezsigntemplate.", alias="iEzsigntemplateSignaturetotal") + i_ezsigntemplate_formfieldtotal: Optional[StrictInt] = Field(default=None, description="The number of total form fields in the Ezsigntemplate.", alias="iEzsigntemplateFormfieldtotal") + b_ezsigntemplate_incomplete: StrictBool = Field(description="Indicate the Ezsigntemplate is incomplete and cannot be used", alias="bEzsigntemplateIncomplete") + s_ezsignfoldertype_name_x: StrictStr = Field(description="The name of the Ezsignfoldertype in the language of the requester", alias="sEzsignfoldertypeNameX") + __properties: ClassVar[List[str]] = ["pkiEzsigntemplateID", "fkiEzsignfoldertypeID", "fkiLanguageID", "sEzsigntemplateDescription", "iEzsigntemplatedocumentPagetotal", "iEzsigntemplateSignaturetotal", "iEzsigntemplateFormfieldtotal", "bEzsigntemplateIncomplete", "sEzsignfoldertypeNameX"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplateListElement: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplateListElement from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplateListElement: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplateListElement from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplateListElement.parse_obj(obj) - - _obj = EzsigntemplateListElement.parse_obj({ - "pki_ezsigntemplate_id": obj.get("pkiEzsigntemplateID"), - "fki_ezsignfoldertype_id": obj.get("fkiEzsignfoldertypeID"), - "fki_language_id": obj.get("fkiLanguageID"), - "s_ezsigntemplate_description": obj.get("sEzsigntemplateDescription"), - "i_ezsigntemplatedocument_pagetotal": obj.get("iEzsigntemplatedocumentPagetotal"), - "i_ezsigntemplate_signaturetotal": obj.get("iEzsigntemplateSignaturetotal"), - "i_ezsigntemplate_formfieldtotal": obj.get("iEzsigntemplateFormfieldtotal"), - "b_ezsigntemplate_incomplete": obj.get("bEzsigntemplateIncomplete"), - "s_ezsignfoldertype_name_x": obj.get("sEzsignfoldertypeNameX") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsigntemplateID": obj.get("pkiEzsigntemplateID"), + "fkiEzsignfoldertypeID": obj.get("fkiEzsignfoldertypeID"), + "fkiLanguageID": obj.get("fkiLanguageID"), + "sEzsigntemplateDescription": obj.get("sEzsigntemplateDescription"), + "iEzsigntemplatedocumentPagetotal": obj.get("iEzsigntemplatedocumentPagetotal"), + "iEzsigntemplateSignaturetotal": obj.get("iEzsigntemplateSignaturetotal"), + "iEzsigntemplateFormfieldtotal": obj.get("iEzsigntemplateFormfieldtotal"), + "bEzsigntemplateIncomplete": obj.get("bEzsigntemplateIncomplete"), + "sEzsignfoldertypeNameX": obj.get("sEzsignfoldertypeNameX") }) return _obj diff --git a/eZmaxApi/models/ezsigntemplate_request.py b/eZmaxApi/models/ezsigntemplate_request.py index bedc6d60a..9137e26b8 100644 --- a/eZmaxApi/models/ezsigntemplate_request.py +++ b/eZmaxApi/models/ezsigntemplate_request.py @@ -19,61 +19,80 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, StrictStr +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplateRequest(BaseModel): """ - A Ezsigntemplate Object # noqa: E501 - """ - pki_ezsigntemplate_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="pkiEzsigntemplateID", description="The unique ID of the Ezsigntemplate") - fki_ezsignfoldertype_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsignfoldertypeID", description="The unique ID of the Ezsignfoldertype.") - fki_language_id: conint(strict=True, le=2, ge=1) = Field(..., alias="fkiLanguageID", description="The unique ID of the Language. Valid values: |Value|Description| |-|-| |1|French| |2|English|") - s_ezsigntemplate_description: StrictStr = Field(..., alias="sEzsigntemplateDescription", description="The description of the Ezsigntemplate") - b_ezsigntemplate_adminonly: StrictBool = Field(..., alias="bEzsigntemplateAdminonly", description="Whether the Ezsigntemplate can be accessed by admin users only (eUserType=Normal)") - __properties = ["pkiEzsigntemplateID", "fkiEzsignfoldertypeID", "fkiLanguageID", "sEzsigntemplateDescription", "bEzsigntemplateAdminonly"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + A Ezsigntemplate Object + """ # noqa: E501 + pki_ezsigntemplate_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsigntemplate", alias="pkiEzsigntemplateID") + fki_ezsignfoldertype_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsignfoldertype.", alias="fkiEzsignfoldertypeID") + fki_language_id: Annotated[int, Field(le=2, strict=True, ge=1)] = Field(description="The unique ID of the Language. Valid values: |Value|Description| |-|-| |1|French| |2|English|", alias="fkiLanguageID") + s_ezsigntemplate_description: StrictStr = Field(description="The description of the Ezsigntemplate", alias="sEzsigntemplateDescription") + b_ezsigntemplate_adminonly: StrictBool = Field(description="Whether the Ezsigntemplate can be accessed by admin users only (eUserType=Normal)", alias="bEzsigntemplateAdminonly") + __properties: ClassVar[List[str]] = ["pkiEzsigntemplateID", "fkiEzsignfoldertypeID", "fkiLanguageID", "sEzsigntemplateDescription", "bEzsigntemplateAdminonly"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplateRequest: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplateRequest from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplateRequest: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplateRequest from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplateRequest.parse_obj(obj) - - _obj = EzsigntemplateRequest.parse_obj({ - "pki_ezsigntemplate_id": obj.get("pkiEzsigntemplateID"), - "fki_ezsignfoldertype_id": obj.get("fkiEzsignfoldertypeID"), - "fki_language_id": obj.get("fkiLanguageID"), - "s_ezsigntemplate_description": obj.get("sEzsigntemplateDescription"), - "b_ezsigntemplate_adminonly": obj.get("bEzsigntemplateAdminonly") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsigntemplateID": obj.get("pkiEzsigntemplateID"), + "fkiEzsignfoldertypeID": obj.get("fkiEzsignfoldertypeID"), + "fkiLanguageID": obj.get("fkiLanguageID"), + "sEzsigntemplateDescription": obj.get("sEzsigntemplateDescription"), + "bEzsigntemplateAdminonly": obj.get("bEzsigntemplateAdminonly") }) return _obj diff --git a/eZmaxApi/models/ezsigntemplate_request_compound.py b/eZmaxApi/models/ezsigntemplate_request_compound.py index 0574688da..894250f9a 100644 --- a/eZmaxApi/models/ezsigntemplate_request_compound.py +++ b/eZmaxApi/models/ezsigntemplate_request_compound.py @@ -19,61 +19,80 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, StrictStr +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplateRequestCompound(BaseModel): """ - A Ezsigntemplate Object and children # noqa: E501 - """ - pki_ezsigntemplate_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="pkiEzsigntemplateID", description="The unique ID of the Ezsigntemplate") - fki_ezsignfoldertype_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsignfoldertypeID", description="The unique ID of the Ezsignfoldertype.") - fki_language_id: conint(strict=True, le=2, ge=1) = Field(..., alias="fkiLanguageID", description="The unique ID of the Language. Valid values: |Value|Description| |-|-| |1|French| |2|English|") - s_ezsigntemplate_description: StrictStr = Field(..., alias="sEzsigntemplateDescription", description="The description of the Ezsigntemplate") - b_ezsigntemplate_adminonly: StrictBool = Field(..., alias="bEzsigntemplateAdminonly", description="Whether the Ezsigntemplate can be accessed by admin users only (eUserType=Normal)") - __properties = ["pkiEzsigntemplateID", "fkiEzsignfoldertypeID", "fkiLanguageID", "sEzsigntemplateDescription", "bEzsigntemplateAdminonly"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + A Ezsigntemplate Object and children + """ # noqa: E501 + pki_ezsigntemplate_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsigntemplate", alias="pkiEzsigntemplateID") + fki_ezsignfoldertype_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsignfoldertype.", alias="fkiEzsignfoldertypeID") + fki_language_id: Annotated[int, Field(le=2, strict=True, ge=1)] = Field(description="The unique ID of the Language. Valid values: |Value|Description| |-|-| |1|French| |2|English|", alias="fkiLanguageID") + s_ezsigntemplate_description: StrictStr = Field(description="The description of the Ezsigntemplate", alias="sEzsigntemplateDescription") + b_ezsigntemplate_adminonly: StrictBool = Field(description="Whether the Ezsigntemplate can be accessed by admin users only (eUserType=Normal)", alias="bEzsigntemplateAdminonly") + __properties: ClassVar[List[str]] = ["pkiEzsigntemplateID", "fkiEzsignfoldertypeID", "fkiLanguageID", "sEzsigntemplateDescription", "bEzsigntemplateAdminonly"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplateRequestCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplateRequestCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplateRequestCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplateRequestCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplateRequestCompound.parse_obj(obj) - - _obj = EzsigntemplateRequestCompound.parse_obj({ - "pki_ezsigntemplate_id": obj.get("pkiEzsigntemplateID"), - "fki_ezsignfoldertype_id": obj.get("fkiEzsignfoldertypeID"), - "fki_language_id": obj.get("fkiLanguageID"), - "s_ezsigntemplate_description": obj.get("sEzsigntemplateDescription"), - "b_ezsigntemplate_adminonly": obj.get("bEzsigntemplateAdminonly") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsigntemplateID": obj.get("pkiEzsigntemplateID"), + "fkiEzsignfoldertypeID": obj.get("fkiEzsignfoldertypeID"), + "fkiLanguageID": obj.get("fkiLanguageID"), + "sEzsigntemplateDescription": obj.get("sEzsigntemplateDescription"), + "bEzsigntemplateAdminonly": obj.get("bEzsigntemplateAdminonly") }) return _obj diff --git a/eZmaxApi/models/ezsigntemplate_response.py b/eZmaxApi/models/ezsigntemplate_response.py index 45c66e5d8..b4b1b06fd 100644 --- a/eZmaxApi/models/ezsigntemplate_response.py +++ b/eZmaxApi/models/ezsigntemplate_response.py @@ -19,73 +19,92 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, StrictStr +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.common_audit import CommonAudit +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplateResponse(BaseModel): """ - A Ezsigntemplate Object # noqa: E501 - """ - pki_ezsigntemplate_id: conint(strict=True, ge=0) = Field(..., alias="pkiEzsigntemplateID", description="The unique ID of the Ezsigntemplate") - fki_ezsigntemplatedocument_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiEzsigntemplatedocumentID", description="The unique ID of the Ezsigntemplatedocument") - fki_ezsignfoldertype_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsignfoldertypeID", description="The unique ID of the Ezsignfoldertype.") - fki_language_id: conint(strict=True, le=2, ge=1) = Field(..., alias="fkiLanguageID", description="The unique ID of the Language. Valid values: |Value|Description| |-|-| |1|French| |2|English|") - s_language_name_x: StrictStr = Field(..., alias="sLanguageNameX", description="The Name of the Language in the language of the requester") - s_ezsigntemplate_description: StrictStr = Field(..., alias="sEzsigntemplateDescription", description="The description of the Ezsigntemplate") - b_ezsigntemplate_adminonly: StrictBool = Field(..., alias="bEzsigntemplateAdminonly", description="Whether the Ezsigntemplate can be accessed by admin users only (eUserType=Normal)") - s_ezsignfoldertype_name_x: StrictStr = Field(..., alias="sEzsignfoldertypeNameX", description="The name of the Ezsignfoldertype in the language of the requester") - obj_audit: CommonAudit = Field(..., alias="objAudit") - __properties = ["pkiEzsigntemplateID", "fkiEzsigntemplatedocumentID", "fkiEzsignfoldertypeID", "fkiLanguageID", "sLanguageNameX", "sEzsigntemplateDescription", "bEzsigntemplateAdminonly", "sEzsignfoldertypeNameX", "objAudit"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + A Ezsigntemplate Object + """ # noqa: E501 + pki_ezsigntemplate_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsigntemplate", alias="pkiEzsigntemplateID") + fki_ezsigntemplatedocument_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsigntemplatedocument", alias="fkiEzsigntemplatedocumentID") + fki_ezsignfoldertype_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsignfoldertype.", alias="fkiEzsignfoldertypeID") + fki_language_id: Annotated[int, Field(le=2, strict=True, ge=1)] = Field(description="The unique ID of the Language. Valid values: |Value|Description| |-|-| |1|French| |2|English|", alias="fkiLanguageID") + s_language_name_x: StrictStr = Field(description="The Name of the Language in the language of the requester", alias="sLanguageNameX") + s_ezsigntemplate_description: StrictStr = Field(description="The description of the Ezsigntemplate", alias="sEzsigntemplateDescription") + b_ezsigntemplate_adminonly: StrictBool = Field(description="Whether the Ezsigntemplate can be accessed by admin users only (eUserType=Normal)", alias="bEzsigntemplateAdminonly") + s_ezsignfoldertype_name_x: StrictStr = Field(description="The name of the Ezsignfoldertype in the language of the requester", alias="sEzsignfoldertypeNameX") + obj_audit: CommonAudit = Field(alias="objAudit") + __properties: ClassVar[List[str]] = ["pkiEzsigntemplateID", "fkiEzsigntemplatedocumentID", "fkiEzsignfoldertypeID", "fkiLanguageID", "sLanguageNameX", "sEzsigntemplateDescription", "bEzsigntemplateAdminonly", "sEzsignfoldertypeNameX", "objAudit"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplateResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplateResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_audit if self.obj_audit: _dict['objAudit'] = self.obj_audit.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplateResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplateResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplateResponse.parse_obj(obj) - - _obj = EzsigntemplateResponse.parse_obj({ - "pki_ezsigntemplate_id": obj.get("pkiEzsigntemplateID"), - "fki_ezsigntemplatedocument_id": obj.get("fkiEzsigntemplatedocumentID"), - "fki_ezsignfoldertype_id": obj.get("fkiEzsignfoldertypeID"), - "fki_language_id": obj.get("fkiLanguageID"), - "s_language_name_x": obj.get("sLanguageNameX"), - "s_ezsigntemplate_description": obj.get("sEzsigntemplateDescription"), - "b_ezsigntemplate_adminonly": obj.get("bEzsigntemplateAdminonly"), - "s_ezsignfoldertype_name_x": obj.get("sEzsignfoldertypeNameX"), - "obj_audit": CommonAudit.from_dict(obj.get("objAudit")) if obj.get("objAudit") is not None else None + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsigntemplateID": obj.get("pkiEzsigntemplateID"), + "fkiEzsigntemplatedocumentID": obj.get("fkiEzsigntemplatedocumentID"), + "fkiEzsignfoldertypeID": obj.get("fkiEzsignfoldertypeID"), + "fkiLanguageID": obj.get("fkiLanguageID"), + "sLanguageNameX": obj.get("sLanguageNameX"), + "sEzsigntemplateDescription": obj.get("sEzsigntemplateDescription"), + "bEzsigntemplateAdminonly": obj.get("bEzsigntemplateAdminonly"), + "sEzsignfoldertypeNameX": obj.get("sEzsignfoldertypeNameX"), + "objAudit": CommonAudit.from_dict(obj.get("objAudit")) if obj.get("objAudit") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigntemplate_response_compound.py b/eZmaxApi/models/ezsigntemplate_response_compound.py index f44922e39..cd8cd66ca 100644 --- a/eZmaxApi/models/ezsigntemplate_response_compound.py +++ b/eZmaxApi/models/ezsigntemplate_response_compound.py @@ -19,53 +19,72 @@ import json -from typing import List, Optional -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint, conlist +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, StrictStr +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.common_audit import CommonAudit from eZmaxApi.models.ezsigntemplatedocument_response import EzsigntemplatedocumentResponse from eZmaxApi.models.ezsigntemplatesigner_response_compound import EzsigntemplatesignerResponseCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplateResponseCompound(BaseModel): """ - A Ezsigntemplate Object # noqa: E501 - """ - pki_ezsigntemplate_id: conint(strict=True, ge=0) = Field(..., alias="pkiEzsigntemplateID", description="The unique ID of the Ezsigntemplate") - fki_ezsigntemplatedocument_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiEzsigntemplatedocumentID", description="The unique ID of the Ezsigntemplatedocument") - fki_ezsignfoldertype_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsignfoldertypeID", description="The unique ID of the Ezsignfoldertype.") - fki_language_id: conint(strict=True, le=2, ge=1) = Field(..., alias="fkiLanguageID", description="The unique ID of the Language. Valid values: |Value|Description| |-|-| |1|French| |2|English|") - s_language_name_x: StrictStr = Field(..., alias="sLanguageNameX", description="The Name of the Language in the language of the requester") - s_ezsigntemplate_description: StrictStr = Field(..., alias="sEzsigntemplateDescription", description="The description of the Ezsigntemplate") - b_ezsigntemplate_adminonly: StrictBool = Field(..., alias="bEzsigntemplateAdminonly", description="Whether the Ezsigntemplate can be accessed by admin users only (eUserType=Normal)") - s_ezsignfoldertype_name_x: StrictStr = Field(..., alias="sEzsignfoldertypeNameX", description="The name of the Ezsignfoldertype in the language of the requester") - obj_audit: CommonAudit = Field(..., alias="objAudit") - obj_ezsigntemplatedocument: Optional[EzsigntemplatedocumentResponse] = Field(None, alias="objEzsigntemplatedocument") - a_obj_ezsigntemplatesigner: conlist(EzsigntemplatesignerResponseCompound) = Field(..., alias="a_objEzsigntemplatesigner") - __properties = ["pkiEzsigntemplateID", "fkiEzsigntemplatedocumentID", "fkiEzsignfoldertypeID", "fkiLanguageID", "sLanguageNameX", "sEzsigntemplateDescription", "bEzsigntemplateAdminonly", "sEzsignfoldertypeNameX", "objAudit", "objEzsigntemplatedocument", "a_objEzsigntemplatesigner"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + A Ezsigntemplate Object + """ # noqa: E501 + pki_ezsigntemplate_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsigntemplate", alias="pkiEzsigntemplateID") + fki_ezsigntemplatedocument_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsigntemplatedocument", alias="fkiEzsigntemplatedocumentID") + fki_ezsignfoldertype_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsignfoldertype.", alias="fkiEzsignfoldertypeID") + fki_language_id: Annotated[int, Field(le=2, strict=True, ge=1)] = Field(description="The unique ID of the Language. Valid values: |Value|Description| |-|-| |1|French| |2|English|", alias="fkiLanguageID") + s_language_name_x: StrictStr = Field(description="The Name of the Language in the language of the requester", alias="sLanguageNameX") + s_ezsigntemplate_description: StrictStr = Field(description="The description of the Ezsigntemplate", alias="sEzsigntemplateDescription") + b_ezsigntemplate_adminonly: StrictBool = Field(description="Whether the Ezsigntemplate can be accessed by admin users only (eUserType=Normal)", alias="bEzsigntemplateAdminonly") + s_ezsignfoldertype_name_x: StrictStr = Field(description="The name of the Ezsignfoldertype in the language of the requester", alias="sEzsignfoldertypeNameX") + obj_audit: CommonAudit = Field(alias="objAudit") + obj_ezsigntemplatedocument: Optional[EzsigntemplatedocumentResponse] = Field(default=None, alias="objEzsigntemplatedocument") + a_obj_ezsigntemplatesigner: List[EzsigntemplatesignerResponseCompound] = Field(alias="a_objEzsigntemplatesigner") + __properties: ClassVar[List[str]] = ["pkiEzsigntemplateID", "fkiEzsigntemplatedocumentID", "fkiEzsignfoldertypeID", "fkiLanguageID", "sLanguageNameX", "sEzsigntemplateDescription", "bEzsigntemplateAdminonly", "sEzsignfoldertypeNameX", "objAudit", "objEzsigntemplatedocument", "a_objEzsigntemplatesigner"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplateResponseCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplateResponseCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_audit if self.obj_audit: _dict['objAudit'] = self.obj_audit.to_dict() @@ -82,26 +101,26 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplateResponseCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplateResponseCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplateResponseCompound.parse_obj(obj) - - _obj = EzsigntemplateResponseCompound.parse_obj({ - "pki_ezsigntemplate_id": obj.get("pkiEzsigntemplateID"), - "fki_ezsigntemplatedocument_id": obj.get("fkiEzsigntemplatedocumentID"), - "fki_ezsignfoldertype_id": obj.get("fkiEzsignfoldertypeID"), - "fki_language_id": obj.get("fkiLanguageID"), - "s_language_name_x": obj.get("sLanguageNameX"), - "s_ezsigntemplate_description": obj.get("sEzsigntemplateDescription"), - "b_ezsigntemplate_adminonly": obj.get("bEzsigntemplateAdminonly"), - "s_ezsignfoldertype_name_x": obj.get("sEzsignfoldertypeNameX"), - "obj_audit": CommonAudit.from_dict(obj.get("objAudit")) if obj.get("objAudit") is not None else None, - "obj_ezsigntemplatedocument": EzsigntemplatedocumentResponse.from_dict(obj.get("objEzsigntemplatedocument")) if obj.get("objEzsigntemplatedocument") is not None else None, - "a_obj_ezsigntemplatesigner": [EzsigntemplatesignerResponseCompound.from_dict(_item) for _item in obj.get("a_objEzsigntemplatesigner")] if obj.get("a_objEzsigntemplatesigner") is not None else None + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsigntemplateID": obj.get("pkiEzsigntemplateID"), + "fkiEzsigntemplatedocumentID": obj.get("fkiEzsigntemplatedocumentID"), + "fkiEzsignfoldertypeID": obj.get("fkiEzsignfoldertypeID"), + "fkiLanguageID": obj.get("fkiLanguageID"), + "sLanguageNameX": obj.get("sLanguageNameX"), + "sEzsigntemplateDescription": obj.get("sEzsigntemplateDescription"), + "bEzsigntemplateAdminonly": obj.get("bEzsigntemplateAdminonly"), + "sEzsignfoldertypeNameX": obj.get("sEzsignfoldertypeNameX"), + "objAudit": CommonAudit.from_dict(obj.get("objAudit")) if obj.get("objAudit") is not None else None, + "objEzsigntemplatedocument": EzsigntemplatedocumentResponse.from_dict(obj.get("objEzsigntemplatedocument")) if obj.get("objEzsigntemplatedocument") is not None else None, + "a_objEzsigntemplatesigner": [EzsigntemplatesignerResponseCompound.from_dict(_item) for _item in obj.get("a_objEzsigntemplatesigner")] if obj.get("a_objEzsigntemplatesigner") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatedocument_create_object_v1_request.py b/eZmaxApi/models/ezsigntemplatedocument_create_object_v1_request.py index 875969806..3d0debe24 100644 --- a/eZmaxApi/models/ezsigntemplatedocument_create_object_v1_request.py +++ b/eZmaxApi/models/ezsigntemplatedocument_create_object_v1_request.py @@ -19,41 +19,60 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.ezsigntemplatedocument_request_compound import EzsigntemplatedocumentRequestCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatedocumentCreateObjectV1Request(BaseModel): """ - Request for POST /1/object/ezsigntemplatedocument # noqa: E501 - """ - a_obj_ezsigntemplatedocument: conlist(EzsigntemplatedocumentRequestCompound, min_items=1) = Field(..., alias="a_objEzsigntemplatedocument") - __properties = ["a_objEzsigntemplatedocument"] + Request for POST /1/object/ezsigntemplatedocument + """ # noqa: E501 + a_obj_ezsigntemplatedocument: Annotated[List[EzsigntemplatedocumentRequestCompound], Field(min_length=1)] = Field(alias="a_objEzsigntemplatedocument") + __properties: ClassVar[List[str]] = ["a_objEzsigntemplatedocument"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatedocumentCreateObjectV1Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatedocumentCreateObjectV1Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_ezsigntemplatedocument (list) _items = [] if self.a_obj_ezsigntemplatedocument: @@ -64,16 +83,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatedocumentCreateObjectV1Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatedocumentCreateObjectV1Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatedocumentCreateObjectV1Request.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplatedocumentCreateObjectV1Request.parse_obj({ - "a_obj_ezsigntemplatedocument": [EzsigntemplatedocumentRequestCompound.from_dict(_item) for _item in obj.get("a_objEzsigntemplatedocument")] if obj.get("a_objEzsigntemplatedocument") is not None else None + _obj = cls.model_validate({ + "a_objEzsigntemplatedocument": [EzsigntemplatedocumentRequestCompound.from_dict(_item) for _item in obj.get("a_objEzsigntemplatedocument")] if obj.get("a_objEzsigntemplatedocument") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatedocument_create_object_v1_response.py b/eZmaxApi/models/ezsigntemplatedocument_create_object_v1_response.py index 2ec6acd17..50248fcbf 100644 --- a/eZmaxApi/models/ezsigntemplatedocument_create_object_v1_response.py +++ b/eZmaxApi/models/ezsigntemplatedocument_create_object_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.ezsigntemplatedocument_create_object_v1_response_m_payload import EzsigntemplatedocumentCreateObjectV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatedocumentCreateObjectV1Response(BaseModel): """ - Response for POST /1/object/ezsigntemplatedocument # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzsigntemplatedocumentCreateObjectV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for POST /1/object/ezsigntemplatedocument + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsigntemplatedocumentCreateObjectV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatedocumentCreateObjectV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatedocumentCreateObjectV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatedocumentCreateObjectV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatedocumentCreateObjectV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatedocumentCreateObjectV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplatedocumentCreateObjectV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzsigntemplatedocumentCreateObjectV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsigntemplatedocumentCreateObjectV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatedocument_create_object_v1_response_m_payload.py b/eZmaxApi/models/ezsigntemplatedocument_create_object_v1_response_m_payload.py index 235e9de9a..a2073422c 100644 --- a/eZmaxApi/models/ezsigntemplatedocument_create_object_v1_response_m_payload.py +++ b/eZmaxApi/models/ezsigntemplatedocument_create_object_v1_response_m_payload.py @@ -19,53 +19,72 @@ import json -from typing import List -from pydantic import BaseModel, Field, conint, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatedocumentCreateObjectV1ResponseMPayload(BaseModel): """ - Payload for POST /1/object/ezsigntemplatedocument # noqa: E501 - """ - a_pki_ezsigntemplatedocument_id: conlist(conint(strict=True, ge=0), min_items=1) = Field(..., alias="a_pkiEzsigntemplatedocumentID", description="An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request.") - __properties = ["a_pkiEzsigntemplatedocumentID"] + Payload for POST /1/object/ezsigntemplatedocument + """ # noqa: E501 + a_pki_ezsigntemplatedocument_id: Annotated[List[Annotated[int, Field(strict=True, ge=0)]], Field(min_length=1)] = Field(description="An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request.", alias="a_pkiEzsigntemplatedocumentID") + __properties: ClassVar[List[str]] = ["a_pkiEzsigntemplatedocumentID"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatedocumentCreateObjectV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatedocumentCreateObjectV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatedocumentCreateObjectV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatedocumentCreateObjectV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatedocumentCreateObjectV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplatedocumentCreateObjectV1ResponseMPayload.parse_obj({ - "a_pki_ezsigntemplatedocument_id": obj.get("a_pkiEzsigntemplatedocumentID") + _obj = cls.model_validate({ + "a_pkiEzsigntemplatedocumentID": obj.get("a_pkiEzsigntemplatedocumentID") }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatedocument_edit_ezsigntemplateformfieldgroups_v1_request.py b/eZmaxApi/models/ezsigntemplatedocument_edit_ezsigntemplateformfieldgroups_v1_request.py index 6b5967883..cd905729b 100644 --- a/eZmaxApi/models/ezsigntemplatedocument_edit_ezsigntemplateformfieldgroups_v1_request.py +++ b/eZmaxApi/models/ezsigntemplatedocument_edit_ezsigntemplateformfieldgroups_v1_request.py @@ -19,41 +19,59 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.ezsigntemplateformfieldgroup_request_compound import EzsigntemplateformfieldgroupRequestCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1Request(BaseModel): """ - Request for PUT /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/editEzsigntemplateformfieldgroups # noqa: E501 - """ - a_obj_ezsigntemplateformfieldgroup: conlist(EzsigntemplateformfieldgroupRequestCompound) = Field(..., alias="a_objEzsigntemplateformfieldgroup") - __properties = ["a_objEzsigntemplateformfieldgroup"] + Request for PUT /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/editEzsigntemplateformfieldgroups + """ # noqa: E501 + a_obj_ezsigntemplateformfieldgroup: List[EzsigntemplateformfieldgroupRequestCompound] = Field(alias="a_objEzsigntemplateformfieldgroup") + __properties: ClassVar[List[str]] = ["a_objEzsigntemplateformfieldgroup"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_ezsigntemplateformfieldgroup (list) _items = [] if self.a_obj_ezsigntemplateformfieldgroup: @@ -64,16 +82,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1Request.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1Request.parse_obj({ - "a_obj_ezsigntemplateformfieldgroup": [EzsigntemplateformfieldgroupRequestCompound.from_dict(_item) for _item in obj.get("a_objEzsigntemplateformfieldgroup")] if obj.get("a_objEzsigntemplateformfieldgroup") is not None else None + _obj = cls.model_validate({ + "a_objEzsigntemplateformfieldgroup": [EzsigntemplateformfieldgroupRequestCompound.from_dict(_item) for _item in obj.get("a_objEzsigntemplateformfieldgroup")] if obj.get("a_objEzsigntemplateformfieldgroup") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatedocument_edit_ezsigntemplateformfieldgroups_v1_response.py b/eZmaxApi/models/ezsigntemplatedocument_edit_ezsigntemplateformfieldgroups_v1_response.py index c43081340..290ad30cc 100644 --- a/eZmaxApi/models/ezsigntemplatedocument_edit_ezsigntemplateformfieldgroups_v1_response.py +++ b/eZmaxApi/models/ezsigntemplatedocument_edit_ezsigntemplateformfieldgroups_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.ezsigntemplatedocument_edit_ezsigntemplateformfieldgroups_v1_response_m_payload import EzsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1Response(BaseModel): """ - Response for PUT /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/editEzsigntemplateformfieldgroups # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for PUT /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/editEzsigntemplateformfieldgroups + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatedocument_edit_ezsigntemplateformfieldgroups_v1_response_m_payload.py b/eZmaxApi/models/ezsigntemplatedocument_edit_ezsigntemplateformfieldgroups_v1_response_m_payload.py index eee5246ab..7981331fb 100644 --- a/eZmaxApi/models/ezsigntemplatedocument_edit_ezsigntemplateformfieldgroups_v1_response_m_payload.py +++ b/eZmaxApi/models/ezsigntemplatedocument_edit_ezsigntemplateformfieldgroups_v1_response_m_payload.py @@ -19,53 +19,72 @@ import json -from typing import List -from pydantic import BaseModel, Field, conint, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1ResponseMPayload(BaseModel): """ - Payload for PUT /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/editEzsigntemplateformfieldgroups # noqa: E501 - """ - a_pki_ezsigntemplateformfieldgroup_id: conlist(conint(strict=True, ge=0)) = Field(..., alias="a_pkiEzsigntemplateformfieldgroupID") - __properties = ["a_pkiEzsigntemplateformfieldgroupID"] + Payload for PUT /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/editEzsigntemplateformfieldgroups + """ # noqa: E501 + a_pki_ezsigntemplateformfieldgroup_id: List[Annotated[int, Field(strict=True, ge=0)]] = Field(alias="a_pkiEzsigntemplateformfieldgroupID") + __properties: ClassVar[List[str]] = ["a_pkiEzsigntemplateformfieldgroupID"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1ResponseMPayload.parse_obj({ - "a_pki_ezsigntemplateformfieldgroup_id": obj.get("a_pkiEzsigntemplateformfieldgroupID") + _obj = cls.model_validate({ + "a_pkiEzsigntemplateformfieldgroupID": obj.get("a_pkiEzsigntemplateformfieldgroupID") }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatedocument_edit_ezsigntemplatesignatures_v1_request.py b/eZmaxApi/models/ezsigntemplatedocument_edit_ezsigntemplatesignatures_v1_request.py index 6c6bfafda..45f8213d8 100644 --- a/eZmaxApi/models/ezsigntemplatedocument_edit_ezsigntemplatesignatures_v1_request.py +++ b/eZmaxApi/models/ezsigntemplatedocument_edit_ezsigntemplatesignatures_v1_request.py @@ -19,41 +19,59 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.ezsigntemplatesignature_request_compound import EzsigntemplatesignatureRequestCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatedocumentEditEzsigntemplatesignaturesV1Request(BaseModel): """ - Request for PUT /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/editEzsigntemplatesignatures # noqa: E501 - """ - a_obj_ezsigntemplatesignature: conlist(EzsigntemplatesignatureRequestCompound) = Field(..., alias="a_objEzsigntemplatesignature") - __properties = ["a_objEzsigntemplatesignature"] + Request for PUT /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/editEzsigntemplatesignatures + """ # noqa: E501 + a_obj_ezsigntemplatesignature: List[EzsigntemplatesignatureRequestCompound] = Field(alias="a_objEzsigntemplatesignature") + __properties: ClassVar[List[str]] = ["a_objEzsigntemplatesignature"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatedocumentEditEzsigntemplatesignaturesV1Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatedocumentEditEzsigntemplatesignaturesV1Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_ezsigntemplatesignature (list) _items = [] if self.a_obj_ezsigntemplatesignature: @@ -64,16 +82,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatedocumentEditEzsigntemplatesignaturesV1Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatedocumentEditEzsigntemplatesignaturesV1Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatedocumentEditEzsigntemplatesignaturesV1Request.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplatedocumentEditEzsigntemplatesignaturesV1Request.parse_obj({ - "a_obj_ezsigntemplatesignature": [EzsigntemplatesignatureRequestCompound.from_dict(_item) for _item in obj.get("a_objEzsigntemplatesignature")] if obj.get("a_objEzsigntemplatesignature") is not None else None + _obj = cls.model_validate({ + "a_objEzsigntemplatesignature": [EzsigntemplatesignatureRequestCompound.from_dict(_item) for _item in obj.get("a_objEzsigntemplatesignature")] if obj.get("a_objEzsigntemplatesignature") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatedocument_edit_ezsigntemplatesignatures_v1_response.py b/eZmaxApi/models/ezsigntemplatedocument_edit_ezsigntemplatesignatures_v1_response.py index 94c398fb7..6eab018ef 100644 --- a/eZmaxApi/models/ezsigntemplatedocument_edit_ezsigntemplatesignatures_v1_response.py +++ b/eZmaxApi/models/ezsigntemplatedocument_edit_ezsigntemplatesignatures_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.ezsigntemplatedocument_edit_ezsigntemplatesignatures_v1_response_m_payload import EzsigntemplatedocumentEditEzsigntemplatesignaturesV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatedocumentEditEzsigntemplatesignaturesV1Response(BaseModel): """ - Response for PUT /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/editEzsigntemplatesignatures # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzsigntemplatedocumentEditEzsigntemplatesignaturesV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for PUT /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/editEzsigntemplatesignatures + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsigntemplatedocumentEditEzsigntemplatesignaturesV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatedocumentEditEzsigntemplatesignaturesV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatedocumentEditEzsigntemplatesignaturesV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatedocumentEditEzsigntemplatesignaturesV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatedocumentEditEzsigntemplatesignaturesV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatedocumentEditEzsigntemplatesignaturesV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplatedocumentEditEzsigntemplatesignaturesV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzsigntemplatedocumentEditEzsigntemplatesignaturesV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsigntemplatedocumentEditEzsigntemplatesignaturesV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatedocument_edit_ezsigntemplatesignatures_v1_response_m_payload.py b/eZmaxApi/models/ezsigntemplatedocument_edit_ezsigntemplatesignatures_v1_response_m_payload.py index 43502c4de..1dc1f68b9 100644 --- a/eZmaxApi/models/ezsigntemplatedocument_edit_ezsigntemplatesignatures_v1_response_m_payload.py +++ b/eZmaxApi/models/ezsigntemplatedocument_edit_ezsigntemplatesignatures_v1_response_m_payload.py @@ -19,53 +19,72 @@ import json -from typing import List -from pydantic import BaseModel, Field, conint, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatedocumentEditEzsigntemplatesignaturesV1ResponseMPayload(BaseModel): """ - Payload for PUT /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/editEzsigntemplatesignatures # noqa: E501 - """ - a_pki_ezsigntemplatesignature_id: conlist(conint(strict=True, ge=0)) = Field(..., alias="a_pkiEzsigntemplatesignatureID") - __properties = ["a_pkiEzsigntemplatesignatureID"] + Payload for PUT /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/editEzsigntemplatesignatures + """ # noqa: E501 + a_pki_ezsigntemplatesignature_id: List[Annotated[int, Field(strict=True, ge=0)]] = Field(alias="a_pkiEzsigntemplatesignatureID") + __properties: ClassVar[List[str]] = ["a_pkiEzsigntemplatesignatureID"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatedocumentEditEzsigntemplatesignaturesV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatedocumentEditEzsigntemplatesignaturesV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatedocumentEditEzsigntemplatesignaturesV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatedocumentEditEzsigntemplatesignaturesV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatedocumentEditEzsigntemplatesignaturesV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplatedocumentEditEzsigntemplatesignaturesV1ResponseMPayload.parse_obj({ - "a_pki_ezsigntemplatesignature_id": obj.get("a_pkiEzsigntemplatesignatureID") + _obj = cls.model_validate({ + "a_pkiEzsigntemplatesignatureID": obj.get("a_pkiEzsigntemplatesignatureID") }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatedocument_edit_object_v1_request.py b/eZmaxApi/models/ezsigntemplatedocument_edit_object_v1_request.py index 22092dc90..9c61f80f6 100644 --- a/eZmaxApi/models/ezsigntemplatedocument_edit_object_v1_request.py +++ b/eZmaxApi/models/ezsigntemplatedocument_edit_object_v1_request.py @@ -19,57 +19,75 @@ import json - -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.ezsigntemplatedocument_request_compound import EzsigntemplatedocumentRequestCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatedocumentEditObjectV1Request(BaseModel): """ - Request for PUT /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID} # noqa: E501 - """ - obj_ezsigntemplatedocument: EzsigntemplatedocumentRequestCompound = Field(..., alias="objEzsigntemplatedocument") - __properties = ["objEzsigntemplatedocument"] + Request for PUT /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID} + """ # noqa: E501 + obj_ezsigntemplatedocument: EzsigntemplatedocumentRequestCompound = Field(alias="objEzsigntemplatedocument") + __properties: ClassVar[List[str]] = ["objEzsigntemplatedocument"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatedocumentEditObjectV1Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatedocumentEditObjectV1Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_ezsigntemplatedocument if self.obj_ezsigntemplatedocument: _dict['objEzsigntemplatedocument'] = self.obj_ezsigntemplatedocument.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatedocumentEditObjectV1Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatedocumentEditObjectV1Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatedocumentEditObjectV1Request.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplatedocumentEditObjectV1Request.parse_obj({ - "obj_ezsigntemplatedocument": EzsigntemplatedocumentRequestCompound.from_dict(obj.get("objEzsigntemplatedocument")) if obj.get("objEzsigntemplatedocument") is not None else None + _obj = cls.model_validate({ + "objEzsigntemplatedocument": EzsigntemplatedocumentRequestCompound.from_dict(obj.get("objEzsigntemplatedocument")) if obj.get("objEzsigntemplatedocument") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatedocument_edit_object_v1_response.py b/eZmaxApi/models/ezsigntemplatedocument_edit_object_v1_response.py index 3aba7c926..e8a9ffd3a 100644 --- a/eZmaxApi/models/ezsigntemplatedocument_edit_object_v1_response.py +++ b/eZmaxApi/models/ezsigntemplatedocument_edit_object_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import List, Optional -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.common_response_warning import CommonResponseWarning +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatedocumentEditObjectV1Response(BaseModel): """ - Response for PUT /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID} # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - a_obj_warning: Optional[conlist(CommonResponseWarning)] = Field(None, alias="a_objWarning") - __properties = ["objDebugPayload", "objDebug", "a_objWarning"] + Response for PUT /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + a_obj_warning: Optional[List[CommonResponseWarning]] = Field(default=None, alias="a_objWarning") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "a_objWarning"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatedocumentEditObjectV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatedocumentEditObjectV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -74,18 +92,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatedocumentEditObjectV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatedocumentEditObjectV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatedocumentEditObjectV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplatedocumentEditObjectV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "a_obj_warning": [CommonResponseWarning.from_dict(_item) for _item in obj.get("a_objWarning")] if obj.get("a_objWarning") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "a_objWarning": [CommonResponseWarning.from_dict(_item) for _item in obj.get("a_objWarning")] if obj.get("a_objWarning") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatedocument_flatten_v1_response.py b/eZmaxApi/models/ezsigntemplatedocument_flatten_v1_response.py index eef00f47e..685253297 100644 --- a/eZmaxApi/models/ezsigntemplatedocument_flatten_v1_response.py +++ b/eZmaxApi/models/ezsigntemplatedocument_flatten_v1_response.py @@ -19,43 +19,61 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatedocumentFlattenV1Response(BaseModel): """ - Response for POST /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocument}/flatten # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - __properties = ["objDebugPayload", "objDebug"] + Response for POST /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocument}/flatten + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatedocumentFlattenV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatedocumentFlattenV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -65,17 +83,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatedocumentFlattenV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatedocumentFlattenV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatedocumentFlattenV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplatedocumentFlattenV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatedocument_get_ezsigntemplatedocumentpages_v1_response.py b/eZmaxApi/models/ezsigntemplatedocument_get_ezsigntemplatedocumentpages_v1_response.py index c90fa33f4..8a160b9c3 100644 --- a/eZmaxApi/models/ezsigntemplatedocument_get_ezsigntemplatedocumentpages_v1_response.py +++ b/eZmaxApi/models/ezsigntemplatedocument_get_ezsigntemplatedocumentpages_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.ezsigntemplatedocument_get_ezsigntemplatedocumentpages_v1_response_m_payload import EzsigntemplatedocumentGetEzsigntemplatedocumentpagesV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatedocumentGetEzsigntemplatedocumentpagesV1Response(BaseModel): """ - Response for GET /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/getEzsigntemplatedocumentpages # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzsigntemplatedocumentGetEzsigntemplatedocumentpagesV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/getEzsigntemplatedocumentpages + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsigntemplatedocumentGetEzsigntemplatedocumentpagesV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatedocumentGetEzsigntemplatedocumentpagesV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatedocumentGetEzsigntemplatedocumentpagesV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatedocumentGetEzsigntemplatedocumentpagesV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatedocumentGetEzsigntemplatedocumentpagesV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatedocumentGetEzsigntemplatedocumentpagesV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplatedocumentGetEzsigntemplatedocumentpagesV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzsigntemplatedocumentGetEzsigntemplatedocumentpagesV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsigntemplatedocumentGetEzsigntemplatedocumentpagesV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatedocument_get_ezsigntemplatedocumentpages_v1_response_m_payload.py b/eZmaxApi/models/ezsigntemplatedocument_get_ezsigntemplatedocumentpages_v1_response_m_payload.py index 731d6377d..14323298d 100644 --- a/eZmaxApi/models/ezsigntemplatedocument_get_ezsigntemplatedocumentpages_v1_response_m_payload.py +++ b/eZmaxApi/models/ezsigntemplatedocument_get_ezsigntemplatedocumentpages_v1_response_m_payload.py @@ -19,41 +19,59 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.ezsigntemplatedocumentpage_response_compound import EzsigntemplatedocumentpageResponseCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatedocumentGetEzsigntemplatedocumentpagesV1ResponseMPayload(BaseModel): """ - Payload for GET /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/getEzsigntemplatedocumentpages # noqa: E501 - """ - a_obj_ezsigntemplatedocumentpage: conlist(EzsigntemplatedocumentpageResponseCompound) = Field(..., alias="a_objEzsigntemplatedocumentpage") - __properties = ["a_objEzsigntemplatedocumentpage"] + Payload for GET /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/getEzsigntemplatedocumentpages + """ # noqa: E501 + a_obj_ezsigntemplatedocumentpage: List[EzsigntemplatedocumentpageResponseCompound] = Field(alias="a_objEzsigntemplatedocumentpage") + __properties: ClassVar[List[str]] = ["a_objEzsigntemplatedocumentpage"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatedocumentGetEzsigntemplatedocumentpagesV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatedocumentGetEzsigntemplatedocumentpagesV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_ezsigntemplatedocumentpage (list) _items = [] if self.a_obj_ezsigntemplatedocumentpage: @@ -64,16 +82,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatedocumentGetEzsigntemplatedocumentpagesV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatedocumentGetEzsigntemplatedocumentpagesV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatedocumentGetEzsigntemplatedocumentpagesV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplatedocumentGetEzsigntemplatedocumentpagesV1ResponseMPayload.parse_obj({ - "a_obj_ezsigntemplatedocumentpage": [EzsigntemplatedocumentpageResponseCompound.from_dict(_item) for _item in obj.get("a_objEzsigntemplatedocumentpage")] if obj.get("a_objEzsigntemplatedocumentpage") is not None else None + _obj = cls.model_validate({ + "a_objEzsigntemplatedocumentpage": [EzsigntemplatedocumentpageResponseCompound.from_dict(_item) for _item in obj.get("a_objEzsigntemplatedocumentpage")] if obj.get("a_objEzsigntemplatedocumentpage") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatedocument_get_ezsigntemplateformfieldgroups_v1_response.py b/eZmaxApi/models/ezsigntemplatedocument_get_ezsigntemplateformfieldgroups_v1_response.py index 5c395081a..1bb3f60e9 100644 --- a/eZmaxApi/models/ezsigntemplatedocument_get_ezsigntemplateformfieldgroups_v1_response.py +++ b/eZmaxApi/models/ezsigntemplatedocument_get_ezsigntemplateformfieldgroups_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.ezsigntemplatedocument_get_ezsigntemplateformfieldgroups_v1_response_m_payload import EzsigntemplatedocumentGetEzsigntemplateformfieldgroupsV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatedocumentGetEzsigntemplateformfieldgroupsV1Response(BaseModel): """ - Response for GET /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocument}/getEzsigntemplateformfieldgroups # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzsigntemplatedocumentGetEzsigntemplateformfieldgroupsV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocument}/getEzsigntemplateformfieldgroups + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsigntemplatedocumentGetEzsigntemplateformfieldgroupsV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatedocumentGetEzsigntemplateformfieldgroupsV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatedocumentGetEzsigntemplateformfieldgroupsV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatedocumentGetEzsigntemplateformfieldgroupsV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatedocumentGetEzsigntemplateformfieldgroupsV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatedocumentGetEzsigntemplateformfieldgroupsV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplatedocumentGetEzsigntemplateformfieldgroupsV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzsigntemplatedocumentGetEzsigntemplateformfieldgroupsV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsigntemplatedocumentGetEzsigntemplateformfieldgroupsV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatedocument_get_ezsigntemplateformfieldgroups_v1_response_m_payload.py b/eZmaxApi/models/ezsigntemplatedocument_get_ezsigntemplateformfieldgroups_v1_response_m_payload.py index 7ba528d07..c28a9685c 100644 --- a/eZmaxApi/models/ezsigntemplatedocument_get_ezsigntemplateformfieldgroups_v1_response_m_payload.py +++ b/eZmaxApi/models/ezsigntemplatedocument_get_ezsigntemplateformfieldgroups_v1_response_m_payload.py @@ -19,41 +19,59 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.ezsigntemplateformfieldgroup_response_compound import EzsigntemplateformfieldgroupResponseCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatedocumentGetEzsigntemplateformfieldgroupsV1ResponseMPayload(BaseModel): """ - Payload for GET /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocument}/getEzsigntemplateformfieldgroups # noqa: E501 - """ - a_obj_ezsigntemplateformfieldgroup: conlist(EzsigntemplateformfieldgroupResponseCompound) = Field(..., alias="a_objEzsigntemplateformfieldgroup") - __properties = ["a_objEzsigntemplateformfieldgroup"] + Payload for GET /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocument}/getEzsigntemplateformfieldgroups + """ # noqa: E501 + a_obj_ezsigntemplateformfieldgroup: List[EzsigntemplateformfieldgroupResponseCompound] = Field(alias="a_objEzsigntemplateformfieldgroup") + __properties: ClassVar[List[str]] = ["a_objEzsigntemplateformfieldgroup"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatedocumentGetEzsigntemplateformfieldgroupsV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatedocumentGetEzsigntemplateformfieldgroupsV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_ezsigntemplateformfieldgroup (list) _items = [] if self.a_obj_ezsigntemplateformfieldgroup: @@ -64,16 +82,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatedocumentGetEzsigntemplateformfieldgroupsV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatedocumentGetEzsigntemplateformfieldgroupsV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatedocumentGetEzsigntemplateformfieldgroupsV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplatedocumentGetEzsigntemplateformfieldgroupsV1ResponseMPayload.parse_obj({ - "a_obj_ezsigntemplateformfieldgroup": [EzsigntemplateformfieldgroupResponseCompound.from_dict(_item) for _item in obj.get("a_objEzsigntemplateformfieldgroup")] if obj.get("a_objEzsigntemplateformfieldgroup") is not None else None + _obj = cls.model_validate({ + "a_objEzsigntemplateformfieldgroup": [EzsigntemplateformfieldgroupResponseCompound.from_dict(_item) for _item in obj.get("a_objEzsigntemplateformfieldgroup")] if obj.get("a_objEzsigntemplateformfieldgroup") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatedocument_get_ezsigntemplatesignatures_v1_response.py b/eZmaxApi/models/ezsigntemplatedocument_get_ezsigntemplatesignatures_v1_response.py index cb3516950..34e865afc 100644 --- a/eZmaxApi/models/ezsigntemplatedocument_get_ezsigntemplatesignatures_v1_response.py +++ b/eZmaxApi/models/ezsigntemplatedocument_get_ezsigntemplatesignatures_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.ezsigntemplatedocument_get_ezsigntemplatesignatures_v1_response_m_payload import EzsigntemplatedocumentGetEzsigntemplatesignaturesV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatedocumentGetEzsigntemplatesignaturesV1Response(BaseModel): """ - Response for GET /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocument}/getEzsigntemplatesignatures # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzsigntemplatedocumentGetEzsigntemplatesignaturesV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocument}/getEzsigntemplatesignatures + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsigntemplatedocumentGetEzsigntemplatesignaturesV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatedocumentGetEzsigntemplatesignaturesV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatedocumentGetEzsigntemplatesignaturesV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatedocumentGetEzsigntemplatesignaturesV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatedocumentGetEzsigntemplatesignaturesV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatedocumentGetEzsigntemplatesignaturesV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplatedocumentGetEzsigntemplatesignaturesV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzsigntemplatedocumentGetEzsigntemplatesignaturesV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsigntemplatedocumentGetEzsigntemplatesignaturesV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatedocument_get_ezsigntemplatesignatures_v1_response_m_payload.py b/eZmaxApi/models/ezsigntemplatedocument_get_ezsigntemplatesignatures_v1_response_m_payload.py index c4c5402ff..9374d00a0 100644 --- a/eZmaxApi/models/ezsigntemplatedocument_get_ezsigntemplatesignatures_v1_response_m_payload.py +++ b/eZmaxApi/models/ezsigntemplatedocument_get_ezsigntemplatesignatures_v1_response_m_payload.py @@ -19,41 +19,59 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.ezsigntemplatesignature_response_compound import EzsigntemplatesignatureResponseCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatedocumentGetEzsigntemplatesignaturesV1ResponseMPayload(BaseModel): """ - Payload for GET /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocument}/getEzsigntemplatesignatures # noqa: E501 - """ - a_obj_ezsigntemplatesignature: conlist(EzsigntemplatesignatureResponseCompound) = Field(..., alias="a_objEzsigntemplatesignature") - __properties = ["a_objEzsigntemplatesignature"] + Payload for GET /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocument}/getEzsigntemplatesignatures + """ # noqa: E501 + a_obj_ezsigntemplatesignature: List[EzsigntemplatesignatureResponseCompound] = Field(alias="a_objEzsigntemplatesignature") + __properties: ClassVar[List[str]] = ["a_objEzsigntemplatesignature"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatedocumentGetEzsigntemplatesignaturesV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatedocumentGetEzsigntemplatesignaturesV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_ezsigntemplatesignature (list) _items = [] if self.a_obj_ezsigntemplatesignature: @@ -64,16 +82,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatedocumentGetEzsigntemplatesignaturesV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatedocumentGetEzsigntemplatesignaturesV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatedocumentGetEzsigntemplatesignaturesV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplatedocumentGetEzsigntemplatesignaturesV1ResponseMPayload.parse_obj({ - "a_obj_ezsigntemplatesignature": [EzsigntemplatesignatureResponseCompound.from_dict(_item) for _item in obj.get("a_objEzsigntemplatesignature")] if obj.get("a_objEzsigntemplatesignature") is not None else None + _obj = cls.model_validate({ + "a_objEzsigntemplatesignature": [EzsigntemplatesignatureResponseCompound.from_dict(_item) for _item in obj.get("a_objEzsigntemplatesignature")] if obj.get("a_objEzsigntemplatesignature") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatedocument_get_object_v2_response.py b/eZmaxApi/models/ezsigntemplatedocument_get_object_v2_response.py index c9da56ca7..d003ab85a 100644 --- a/eZmaxApi/models/ezsigntemplatedocument_get_object_v2_response.py +++ b/eZmaxApi/models/ezsigntemplatedocument_get_object_v2_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.ezsigntemplatedocument_get_object_v2_response_m_payload import EzsigntemplatedocumentGetObjectV2ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatedocumentGetObjectV2Response(BaseModel): """ - Response for GET /2/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID} # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzsigntemplatedocumentGetObjectV2ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /2/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsigntemplatedocumentGetObjectV2ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatedocumentGetObjectV2Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatedocumentGetObjectV2Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatedocumentGetObjectV2Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatedocumentGetObjectV2Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatedocumentGetObjectV2Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplatedocumentGetObjectV2Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzsigntemplatedocumentGetObjectV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsigntemplatedocumentGetObjectV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatedocument_get_object_v2_response_m_payload.py b/eZmaxApi/models/ezsigntemplatedocument_get_object_v2_response_m_payload.py index 1a03ca480..1cfd6174c 100644 --- a/eZmaxApi/models/ezsigntemplatedocument_get_object_v2_response_m_payload.py +++ b/eZmaxApi/models/ezsigntemplatedocument_get_object_v2_response_m_payload.py @@ -19,57 +19,75 @@ import json - -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.ezsigntemplatedocument_response_compound import EzsigntemplatedocumentResponseCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatedocumentGetObjectV2ResponseMPayload(BaseModel): """ - Payload for GET /2/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID} # noqa: E501 - """ - obj_ezsigntemplatedocument: EzsigntemplatedocumentResponseCompound = Field(..., alias="objEzsigntemplatedocument") - __properties = ["objEzsigntemplatedocument"] + Payload for GET /2/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID} + """ # noqa: E501 + obj_ezsigntemplatedocument: EzsigntemplatedocumentResponseCompound = Field(alias="objEzsigntemplatedocument") + __properties: ClassVar[List[str]] = ["objEzsigntemplatedocument"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatedocumentGetObjectV2ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatedocumentGetObjectV2ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_ezsigntemplatedocument if self.obj_ezsigntemplatedocument: _dict['objEzsigntemplatedocument'] = self.obj_ezsigntemplatedocument.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatedocumentGetObjectV2ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatedocumentGetObjectV2ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatedocumentGetObjectV2ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplatedocumentGetObjectV2ResponseMPayload.parse_obj({ - "obj_ezsigntemplatedocument": EzsigntemplatedocumentResponseCompound.from_dict(obj.get("objEzsigntemplatedocument")) if obj.get("objEzsigntemplatedocument") is not None else None + _obj = cls.model_validate({ + "objEzsigntemplatedocument": EzsigntemplatedocumentResponseCompound.from_dict(obj.get("objEzsigntemplatedocument")) if obj.get("objEzsigntemplatedocument") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatedocument_get_words_positions_v1_request.py b/eZmaxApi/models/ezsigntemplatedocument_get_words_positions_v1_request.py index 7de4f17ee..287419192 100644 --- a/eZmaxApi/models/ezsigntemplatedocument_get_words_positions_v1_request.py +++ b/eZmaxApi/models/ezsigntemplatedocument_get_words_positions_v1_request.py @@ -19,64 +19,82 @@ import json -from typing import List, Optional -from pydantic import BaseModel, Field, StrictBool, StrictStr, conlist, validator +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, StrictStr, field_validator +from pydantic import Field +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatedocumentGetWordsPositionsV1Request(BaseModel): """ - Request for POST /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/getWordsPositions # noqa: E501 - """ - e_get: StrictStr = Field(..., alias="eGet", description="Specify if you want to retrieve *All* words or specific *Words* from the document. If you specify *Words*, you must send the list of words to search for in *a_sWord*.") - b_word_case_sensitive: StrictBool = Field(..., alias="bWordCaseSensitive", description="IF *true*, words will be searched case-sensitive and results will be returned case-sensitive. IF *false*, words will be searched case-insensitive and results will be returned case-insensitive.") - a_s_word: Optional[conlist(StrictStr)] = Field(None, alias="a_sWord", description="Array of words to find in the document") - __properties = ["eGet", "bWordCaseSensitive", "a_sWord"] - - @validator('e_get') + Request for POST /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/getWordsPositions + """ # noqa: E501 + e_get: StrictStr = Field(description="Specify if you want to retrieve *All* words or specific *Words* from the document. If you specify *Words*, you must send the list of words to search for in *a_sWord*.", alias="eGet") + b_word_case_sensitive: StrictBool = Field(description="IF *true*, words will be searched case-sensitive and results will be returned case-sensitive. IF *false*, words will be searched case-insensitive and results will be returned case-insensitive.", alias="bWordCaseSensitive") + a_s_word: Optional[List[StrictStr]] = Field(default=None, description="Array of words to find in the document", alias="a_sWord") + __properties: ClassVar[List[str]] = ["eGet", "bWordCaseSensitive", "a_sWord"] + + @field_validator('e_get') def e_get_validate_enum(cls, value): """Validates the enum""" if value not in ('All', 'Words'): raise ValueError("must be one of enum values ('All', 'Words')") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatedocumentGetWordsPositionsV1Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatedocumentGetWordsPositionsV1Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatedocumentGetWordsPositionsV1Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatedocumentGetWordsPositionsV1Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatedocumentGetWordsPositionsV1Request.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplatedocumentGetWordsPositionsV1Request.parse_obj({ - "e_get": obj.get("eGet"), - "b_word_case_sensitive": obj.get("bWordCaseSensitive"), - "a_s_word": obj.get("a_sWord") + _obj = cls.model_validate({ + "eGet": obj.get("eGet"), + "bWordCaseSensitive": obj.get("bWordCaseSensitive"), + "a_sWord": obj.get("a_sWord") }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatedocument_get_words_positions_v1_response.py b/eZmaxApi/models/ezsigntemplatedocument_get_words_positions_v1_response.py index 76020992f..65c3f4e86 100644 --- a/eZmaxApi/models/ezsigntemplatedocument_get_words_positions_v1_response.py +++ b/eZmaxApi/models/ezsigntemplatedocument_get_words_positions_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import List, Optional -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.custom_word_position_word_response import CustomWordPositionWordResponse +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatedocumentGetWordsPositionsV1Response(BaseModel): """ - Response for POST /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/getWordsPositions # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: conlist(CustomWordPositionWordResponse) = Field(..., alias="mPayload", description="Payload for POST /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/getWordsPositions") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for POST /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/getWordsPositions + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: List[CustomWordPositionWordResponse] = Field(description="Payload for POST /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/getWordsPositions", alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatedocumentGetWordsPositionsV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatedocumentGetWordsPositionsV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -74,18 +92,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatedocumentGetWordsPositionsV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatedocumentGetWordsPositionsV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatedocumentGetWordsPositionsV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplatedocumentGetWordsPositionsV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": [CustomWordPositionWordResponse.from_dict(_item) for _item in obj.get("mPayload")] if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": [CustomWordPositionWordResponse.from_dict(_item) for _item in obj.get("mPayload")] if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatedocument_patch_object_v1_request.py b/eZmaxApi/models/ezsigntemplatedocument_patch_object_v1_request.py index 83023ef7f..5df7fa9d0 100644 --- a/eZmaxApi/models/ezsigntemplatedocument_patch_object_v1_request.py +++ b/eZmaxApi/models/ezsigntemplatedocument_patch_object_v1_request.py @@ -19,57 +19,75 @@ import json - -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.ezsigntemplatedocument_request_patch import EzsigntemplatedocumentRequestPatch +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatedocumentPatchObjectV1Request(BaseModel): """ - Request for PATCH /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID} # noqa: E501 - """ - obj_ezsigntemplatedocument: EzsigntemplatedocumentRequestPatch = Field(..., alias="objEzsigntemplatedocument") - __properties = ["objEzsigntemplatedocument"] + Request for PATCH /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID} + """ # noqa: E501 + obj_ezsigntemplatedocument: EzsigntemplatedocumentRequestPatch = Field(alias="objEzsigntemplatedocument") + __properties: ClassVar[List[str]] = ["objEzsigntemplatedocument"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatedocumentPatchObjectV1Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatedocumentPatchObjectV1Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_ezsigntemplatedocument if self.obj_ezsigntemplatedocument: _dict['objEzsigntemplatedocument'] = self.obj_ezsigntemplatedocument.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatedocumentPatchObjectV1Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatedocumentPatchObjectV1Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatedocumentPatchObjectV1Request.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplatedocumentPatchObjectV1Request.parse_obj({ - "obj_ezsigntemplatedocument": EzsigntemplatedocumentRequestPatch.from_dict(obj.get("objEzsigntemplatedocument")) if obj.get("objEzsigntemplatedocument") is not None else None + _obj = cls.model_validate({ + "objEzsigntemplatedocument": EzsigntemplatedocumentRequestPatch.from_dict(obj.get("objEzsigntemplatedocument")) if obj.get("objEzsigntemplatedocument") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatedocument_patch_object_v1_response.py b/eZmaxApi/models/ezsigntemplatedocument_patch_object_v1_response.py index 120478c2e..3d68d7fb2 100644 --- a/eZmaxApi/models/ezsigntemplatedocument_patch_object_v1_response.py +++ b/eZmaxApi/models/ezsigntemplatedocument_patch_object_v1_response.py @@ -19,43 +19,61 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatedocumentPatchObjectV1Response(BaseModel): """ - Response for PATCH /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID} # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - __properties = ["objDebugPayload", "objDebug"] + Response for PATCH /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatedocumentPatchObjectV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatedocumentPatchObjectV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -65,17 +83,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatedocumentPatchObjectV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatedocumentPatchObjectV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatedocumentPatchObjectV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplatedocumentPatchObjectV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatedocument_request.py b/eZmaxApi/models/ezsigntemplatedocument_request.py index 319d2d900..e983c8100 100644 --- a/eZmaxApi/models/ezsigntemplatedocument_request.py +++ b/eZmaxApi/models/ezsigntemplatedocument_request.py @@ -19,35 +19,41 @@ import json -from typing import Optional, Union -from pydantic import BaseModel, Field, StrictBool, StrictBytes, StrictStr, conint, validator +from typing import Any, ClassVar, Dict, List, Optional, Union +from pydantic import BaseModel, StrictBool, StrictBytes, StrictStr, field_validator +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatedocumentRequest(BaseModel): """ - A Ezsigntemplatedocument Object # noqa: E501 - """ - pki_ezsigntemplatedocument_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="pkiEzsigntemplatedocumentID", description="The unique ID of the Ezsigntemplatedocument") - fki_ezsigntemplate_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsigntemplateID", description="The unique ID of the Ezsigntemplate") - fki_ezsigndocument_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiEzsigndocumentID", description="The unique ID of the Ezsigndocument") - fki_ezsigntemplatesigner_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiEzsigntemplatesignerID", description="The unique ID of the Ezsigntemplatesigner") - s_ezsigntemplatedocument_name: StrictStr = Field(..., alias="sEzsigntemplatedocumentName", description="The name of the Ezsigntemplatedocument.") - e_ezsigntemplatedocument_source: StrictStr = Field(..., alias="eEzsigntemplatedocumentSource", description="Indicates where to look for the document binary content.") - e_ezsigntemplatedocument_format: Optional[StrictStr] = Field(None, alias="eEzsigntemplatedocumentFormat", description="Indicates the format of the template.") - s_ezsigntemplatedocument_base64: Optional[Union[StrictBytes, StrictStr]] = Field(None, alias="sEzsigntemplatedocumentBase64", description="The Base64 encoded binary content of the document. This field is Required when eEzsigntemplatedocumentSource = Base64.") - s_ezsigntemplatedocument_url: Optional[StrictStr] = Field(None, alias="sEzsigntemplatedocumentUrl", description="The url where the document content resides. This field is Required when eEzsigntemplatedocumentSource = Url.") - b_ezsigntemplatedocument_forcerepair: Optional[StrictBool] = Field(None, alias="bEzsigntemplatedocumentForcerepair", description="Try to repair the document or flatten it if it cannot be used for electronic signature.") - e_ezsigntemplatedocument_form: Optional[StrictStr] = Field(None, alias="eEzsigntemplatedocumentForm", description="If the document contains an existing PDF form this property must be set. **Keep** leaves the form as-is in the document. **Convert** removes the form and convert all the existing fields to Ezsigntemplateformfieldgroups and assign them to the specified **fkiEzsigntemplatesignerID**") - s_ezsigntemplatedocument_password: Optional[StrictStr] = Field('', alias="sEzsigntemplatedocumentPassword", description="If the source template is password protected, the password to open/modify it.") - __properties = ["pkiEzsigntemplatedocumentID", "fkiEzsigntemplateID", "fkiEzsigndocumentID", "fkiEzsigntemplatesignerID", "sEzsigntemplatedocumentName", "eEzsigntemplatedocumentSource", "eEzsigntemplatedocumentFormat", "sEzsigntemplatedocumentBase64", "sEzsigntemplatedocumentUrl", "bEzsigntemplatedocumentForcerepair", "eEzsigntemplatedocumentForm", "sEzsigntemplatedocumentPassword"] - - @validator('e_ezsigntemplatedocument_source') + A Ezsigntemplatedocument Object + """ # noqa: E501 + pki_ezsigntemplatedocument_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsigntemplatedocument", alias="pkiEzsigntemplatedocumentID") + fki_ezsigntemplate_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsigntemplate", alias="fkiEzsigntemplateID") + fki_ezsigndocument_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsigndocument", alias="fkiEzsigndocumentID") + fki_ezsigntemplatesigner_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsigntemplatesigner", alias="fkiEzsigntemplatesignerID") + s_ezsigntemplatedocument_name: StrictStr = Field(description="The name of the Ezsigntemplatedocument.", alias="sEzsigntemplatedocumentName") + e_ezsigntemplatedocument_source: StrictStr = Field(description="Indicates where to look for the document binary content.", alias="eEzsigntemplatedocumentSource") + e_ezsigntemplatedocument_format: Optional[StrictStr] = Field(default=None, description="Indicates the format of the template.", alias="eEzsigntemplatedocumentFormat") + s_ezsigntemplatedocument_base64: Optional[Union[StrictBytes, StrictStr]] = Field(default=None, description="The Base64 encoded binary content of the document. This field is Required when eEzsigntemplatedocumentSource = Base64.", alias="sEzsigntemplatedocumentBase64") + s_ezsigntemplatedocument_url: Optional[StrictStr] = Field(default=None, description="The url where the document content resides. This field is Required when eEzsigntemplatedocumentSource = Url.", alias="sEzsigntemplatedocumentUrl") + b_ezsigntemplatedocument_forcerepair: Optional[StrictBool] = Field(default=None, description="Try to repair the document or flatten it if it cannot be used for electronic signature.", alias="bEzsigntemplatedocumentForcerepair") + e_ezsigntemplatedocument_form: Optional[StrictStr] = Field(default=None, description="If the document contains an existing PDF form this property must be set. **Keep** leaves the form as-is in the document. **Convert** removes the form and convert all the existing fields to Ezsigntemplateformfieldgroups and assign them to the specified **fkiEzsigntemplatesignerID**", alias="eEzsigntemplatedocumentForm") + s_ezsigntemplatedocument_password: Optional[StrictStr] = Field(default='', description="If the source template is password protected, the password to open/modify it.", alias="sEzsigntemplatedocumentPassword") + __properties: ClassVar[List[str]] = ["pkiEzsigntemplatedocumentID", "fkiEzsigntemplateID", "fkiEzsigndocumentID", "fkiEzsigntemplatesignerID", "sEzsigntemplatedocumentName", "eEzsigntemplatedocumentSource", "eEzsigntemplatedocumentFormat", "sEzsigntemplatedocumentBase64", "sEzsigntemplatedocumentUrl", "bEzsigntemplatedocumentForcerepair", "eEzsigntemplatedocumentForm", "sEzsigntemplatedocumentPassword"] + + @field_validator('e_ezsigntemplatedocument_source') def e_ezsigntemplatedocument_source_validate_enum(cls, value): """Validates the enum""" if value not in ('Base64', 'Url', 'Ezsigndocument'): raise ValueError("must be one of enum values ('Base64', 'Url', 'Ezsigndocument')") return value - @validator('e_ezsigntemplatedocument_format') + @field_validator('e_ezsigntemplatedocument_format') def e_ezsigntemplatedocument_format_validate_enum(cls, value): """Validates the enum""" if value is None: @@ -57,7 +63,7 @@ def e_ezsigntemplatedocument_format_validate_enum(cls, value): raise ValueError("must be one of enum values ('Pdf', 'Doc', 'Docx', 'Xls', 'Xlsx', 'Ppt', 'Pptx')") return value - @validator('e_ezsigntemplatedocument_form') + @field_validator('e_ezsigntemplatedocument_form') def e_ezsigntemplatedocument_form_validate_enum(cls, value): """Validates the enum""" if value is None: @@ -67,54 +73,67 @@ def e_ezsigntemplatedocument_form_validate_enum(cls, value): raise ValueError("must be one of enum values ('Keep', 'Convert')") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatedocumentRequest: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatedocumentRequest from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatedocumentRequest: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatedocumentRequest from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatedocumentRequest.parse_obj(obj) - - _obj = EzsigntemplatedocumentRequest.parse_obj({ - "pki_ezsigntemplatedocument_id": obj.get("pkiEzsigntemplatedocumentID"), - "fki_ezsigntemplate_id": obj.get("fkiEzsigntemplateID"), - "fki_ezsigndocument_id": obj.get("fkiEzsigndocumentID"), - "fki_ezsigntemplatesigner_id": obj.get("fkiEzsigntemplatesignerID"), - "s_ezsigntemplatedocument_name": obj.get("sEzsigntemplatedocumentName"), - "e_ezsigntemplatedocument_source": obj.get("eEzsigntemplatedocumentSource"), - "e_ezsigntemplatedocument_format": obj.get("eEzsigntemplatedocumentFormat"), - "s_ezsigntemplatedocument_base64": obj.get("sEzsigntemplatedocumentBase64"), - "s_ezsigntemplatedocument_url": obj.get("sEzsigntemplatedocumentUrl"), - "b_ezsigntemplatedocument_forcerepair": obj.get("bEzsigntemplatedocumentForcerepair"), - "e_ezsigntemplatedocument_form": obj.get("eEzsigntemplatedocumentForm"), - "s_ezsigntemplatedocument_password": obj.get("sEzsigntemplatedocumentPassword") if obj.get("sEzsigntemplatedocumentPassword") is not None else '' + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsigntemplatedocumentID": obj.get("pkiEzsigntemplatedocumentID"), + "fkiEzsigntemplateID": obj.get("fkiEzsigntemplateID"), + "fkiEzsigndocumentID": obj.get("fkiEzsigndocumentID"), + "fkiEzsigntemplatesignerID": obj.get("fkiEzsigntemplatesignerID"), + "sEzsigntemplatedocumentName": obj.get("sEzsigntemplatedocumentName"), + "eEzsigntemplatedocumentSource": obj.get("eEzsigntemplatedocumentSource"), + "eEzsigntemplatedocumentFormat": obj.get("eEzsigntemplatedocumentFormat"), + "sEzsigntemplatedocumentBase64": obj.get("sEzsigntemplatedocumentBase64"), + "sEzsigntemplatedocumentUrl": obj.get("sEzsigntemplatedocumentUrl"), + "bEzsigntemplatedocumentForcerepair": obj.get("bEzsigntemplatedocumentForcerepair"), + "eEzsigntemplatedocumentForm": obj.get("eEzsigntemplatedocumentForm"), + "sEzsigntemplatedocumentPassword": obj.get("sEzsigntemplatedocumentPassword") if obj.get("sEzsigntemplatedocumentPassword") is not None else '' }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatedocument_request_compound.py b/eZmaxApi/models/ezsigntemplatedocument_request_compound.py index 5bc421d5d..f8b83c598 100644 --- a/eZmaxApi/models/ezsigntemplatedocument_request_compound.py +++ b/eZmaxApi/models/ezsigntemplatedocument_request_compound.py @@ -19,35 +19,41 @@ import json -from typing import Optional, Union -from pydantic import BaseModel, Field, StrictBool, StrictBytes, StrictStr, conint, validator +from typing import Any, ClassVar, Dict, List, Optional, Union +from pydantic import BaseModel, StrictBool, StrictBytes, StrictStr, field_validator +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatedocumentRequestCompound(BaseModel): """ - A Ezsigntemplatedocument Object and children # noqa: E501 - """ - pki_ezsigntemplatedocument_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="pkiEzsigntemplatedocumentID", description="The unique ID of the Ezsigntemplatedocument") - fki_ezsigntemplate_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsigntemplateID", description="The unique ID of the Ezsigntemplate") - fki_ezsigndocument_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiEzsigndocumentID", description="The unique ID of the Ezsigndocument") - fki_ezsigntemplatesigner_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiEzsigntemplatesignerID", description="The unique ID of the Ezsigntemplatesigner") - s_ezsigntemplatedocument_name: StrictStr = Field(..., alias="sEzsigntemplatedocumentName", description="The name of the Ezsigntemplatedocument.") - e_ezsigntemplatedocument_source: StrictStr = Field(..., alias="eEzsigntemplatedocumentSource", description="Indicates where to look for the document binary content.") - e_ezsigntemplatedocument_format: Optional[StrictStr] = Field(None, alias="eEzsigntemplatedocumentFormat", description="Indicates the format of the template.") - s_ezsigntemplatedocument_base64: Optional[Union[StrictBytes, StrictStr]] = Field(None, alias="sEzsigntemplatedocumentBase64", description="The Base64 encoded binary content of the document. This field is Required when eEzsigntemplatedocumentSource = Base64.") - s_ezsigntemplatedocument_url: Optional[StrictStr] = Field(None, alias="sEzsigntemplatedocumentUrl", description="The url where the document content resides. This field is Required when eEzsigntemplatedocumentSource = Url.") - b_ezsigntemplatedocument_forcerepair: Optional[StrictBool] = Field(None, alias="bEzsigntemplatedocumentForcerepair", description="Try to repair the document or flatten it if it cannot be used for electronic signature.") - e_ezsigntemplatedocument_form: Optional[StrictStr] = Field(None, alias="eEzsigntemplatedocumentForm", description="If the document contains an existing PDF form this property must be set. **Keep** leaves the form as-is in the document. **Convert** removes the form and convert all the existing fields to Ezsigntemplateformfieldgroups and assign them to the specified **fkiEzsigntemplatesignerID**") - s_ezsigntemplatedocument_password: Optional[StrictStr] = Field('', alias="sEzsigntemplatedocumentPassword", description="If the source template is password protected, the password to open/modify it.") - __properties = ["pkiEzsigntemplatedocumentID", "fkiEzsigntemplateID", "fkiEzsigndocumentID", "fkiEzsigntemplatesignerID", "sEzsigntemplatedocumentName", "eEzsigntemplatedocumentSource", "eEzsigntemplatedocumentFormat", "sEzsigntemplatedocumentBase64", "sEzsigntemplatedocumentUrl", "bEzsigntemplatedocumentForcerepair", "eEzsigntemplatedocumentForm", "sEzsigntemplatedocumentPassword"] - - @validator('e_ezsigntemplatedocument_source') + A Ezsigntemplatedocument Object and children + """ # noqa: E501 + pki_ezsigntemplatedocument_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsigntemplatedocument", alias="pkiEzsigntemplatedocumentID") + fki_ezsigntemplate_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsigntemplate", alias="fkiEzsigntemplateID") + fki_ezsigndocument_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsigndocument", alias="fkiEzsigndocumentID") + fki_ezsigntemplatesigner_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsigntemplatesigner", alias="fkiEzsigntemplatesignerID") + s_ezsigntemplatedocument_name: StrictStr = Field(description="The name of the Ezsigntemplatedocument.", alias="sEzsigntemplatedocumentName") + e_ezsigntemplatedocument_source: StrictStr = Field(description="Indicates where to look for the document binary content.", alias="eEzsigntemplatedocumentSource") + e_ezsigntemplatedocument_format: Optional[StrictStr] = Field(default=None, description="Indicates the format of the template.", alias="eEzsigntemplatedocumentFormat") + s_ezsigntemplatedocument_base64: Optional[Union[StrictBytes, StrictStr]] = Field(default=None, description="The Base64 encoded binary content of the document. This field is Required when eEzsigntemplatedocumentSource = Base64.", alias="sEzsigntemplatedocumentBase64") + s_ezsigntemplatedocument_url: Optional[StrictStr] = Field(default=None, description="The url where the document content resides. This field is Required when eEzsigntemplatedocumentSource = Url.", alias="sEzsigntemplatedocumentUrl") + b_ezsigntemplatedocument_forcerepair: Optional[StrictBool] = Field(default=None, description="Try to repair the document or flatten it if it cannot be used for electronic signature.", alias="bEzsigntemplatedocumentForcerepair") + e_ezsigntemplatedocument_form: Optional[StrictStr] = Field(default=None, description="If the document contains an existing PDF form this property must be set. **Keep** leaves the form as-is in the document. **Convert** removes the form and convert all the existing fields to Ezsigntemplateformfieldgroups and assign them to the specified **fkiEzsigntemplatesignerID**", alias="eEzsigntemplatedocumentForm") + s_ezsigntemplatedocument_password: Optional[StrictStr] = Field(default='', description="If the source template is password protected, the password to open/modify it.", alias="sEzsigntemplatedocumentPassword") + __properties: ClassVar[List[str]] = ["pkiEzsigntemplatedocumentID", "fkiEzsigntemplateID", "fkiEzsigndocumentID", "fkiEzsigntemplatesignerID", "sEzsigntemplatedocumentName", "eEzsigntemplatedocumentSource", "eEzsigntemplatedocumentFormat", "sEzsigntemplatedocumentBase64", "sEzsigntemplatedocumentUrl", "bEzsigntemplatedocumentForcerepair", "eEzsigntemplatedocumentForm", "sEzsigntemplatedocumentPassword"] + + @field_validator('e_ezsigntemplatedocument_source') def e_ezsigntemplatedocument_source_validate_enum(cls, value): """Validates the enum""" if value not in ('Base64', 'Url', 'Ezsigndocument'): raise ValueError("must be one of enum values ('Base64', 'Url', 'Ezsigndocument')") return value - @validator('e_ezsigntemplatedocument_format') + @field_validator('e_ezsigntemplatedocument_format') def e_ezsigntemplatedocument_format_validate_enum(cls, value): """Validates the enum""" if value is None: @@ -57,7 +63,7 @@ def e_ezsigntemplatedocument_format_validate_enum(cls, value): raise ValueError("must be one of enum values ('Pdf', 'Doc', 'Docx', 'Xls', 'Xlsx', 'Ppt', 'Pptx')") return value - @validator('e_ezsigntemplatedocument_form') + @field_validator('e_ezsigntemplatedocument_form') def e_ezsigntemplatedocument_form_validate_enum(cls, value): """Validates the enum""" if value is None: @@ -67,54 +73,67 @@ def e_ezsigntemplatedocument_form_validate_enum(cls, value): raise ValueError("must be one of enum values ('Keep', 'Convert')") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatedocumentRequestCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatedocumentRequestCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatedocumentRequestCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatedocumentRequestCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatedocumentRequestCompound.parse_obj(obj) - - _obj = EzsigntemplatedocumentRequestCompound.parse_obj({ - "pki_ezsigntemplatedocument_id": obj.get("pkiEzsigntemplatedocumentID"), - "fki_ezsigntemplate_id": obj.get("fkiEzsigntemplateID"), - "fki_ezsigndocument_id": obj.get("fkiEzsigndocumentID"), - "fki_ezsigntemplatesigner_id": obj.get("fkiEzsigntemplatesignerID"), - "s_ezsigntemplatedocument_name": obj.get("sEzsigntemplatedocumentName"), - "e_ezsigntemplatedocument_source": obj.get("eEzsigntemplatedocumentSource"), - "e_ezsigntemplatedocument_format": obj.get("eEzsigntemplatedocumentFormat"), - "s_ezsigntemplatedocument_base64": obj.get("sEzsigntemplatedocumentBase64"), - "s_ezsigntemplatedocument_url": obj.get("sEzsigntemplatedocumentUrl"), - "b_ezsigntemplatedocument_forcerepair": obj.get("bEzsigntemplatedocumentForcerepair"), - "e_ezsigntemplatedocument_form": obj.get("eEzsigntemplatedocumentForm"), - "s_ezsigntemplatedocument_password": obj.get("sEzsigntemplatedocumentPassword") if obj.get("sEzsigntemplatedocumentPassword") is not None else '' + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsigntemplatedocumentID": obj.get("pkiEzsigntemplatedocumentID"), + "fkiEzsigntemplateID": obj.get("fkiEzsigntemplateID"), + "fkiEzsigndocumentID": obj.get("fkiEzsigndocumentID"), + "fkiEzsigntemplatesignerID": obj.get("fkiEzsigntemplatesignerID"), + "sEzsigntemplatedocumentName": obj.get("sEzsigntemplatedocumentName"), + "eEzsigntemplatedocumentSource": obj.get("eEzsigntemplatedocumentSource"), + "eEzsigntemplatedocumentFormat": obj.get("eEzsigntemplatedocumentFormat"), + "sEzsigntemplatedocumentBase64": obj.get("sEzsigntemplatedocumentBase64"), + "sEzsigntemplatedocumentUrl": obj.get("sEzsigntemplatedocumentUrl"), + "bEzsigntemplatedocumentForcerepair": obj.get("bEzsigntemplatedocumentForcerepair"), + "eEzsigntemplatedocumentForm": obj.get("eEzsigntemplatedocumentForm"), + "sEzsigntemplatedocumentPassword": obj.get("sEzsigntemplatedocumentPassword") if obj.get("sEzsigntemplatedocumentPassword") is not None else '' }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatedocument_request_patch.py b/eZmaxApi/models/ezsigntemplatedocument_request_patch.py index a8837a7b3..772e3181a 100644 --- a/eZmaxApi/models/ezsigntemplatedocument_request_patch.py +++ b/eZmaxApi/models/ezsigntemplatedocument_request_patch.py @@ -19,53 +19,71 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictStr +from pydantic import Field +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatedocumentRequestPatch(BaseModel): """ - An Ezsigntemplatedocument Object # noqa: E501 - """ - s_ezsigntemplatedocument_name: Optional[StrictStr] = Field(None, alias="sEzsigntemplatedocumentName", description="The name of the Ezsigntemplatedocument.") - __properties = ["sEzsigntemplatedocumentName"] + An Ezsigntemplatedocument Object + """ # noqa: E501 + s_ezsigntemplatedocument_name: Optional[StrictStr] = Field(default=None, description="The name of the Ezsigntemplatedocument.", alias="sEzsigntemplatedocumentName") + __properties: ClassVar[List[str]] = ["sEzsigntemplatedocumentName"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatedocumentRequestPatch: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatedocumentRequestPatch from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatedocumentRequestPatch: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatedocumentRequestPatch from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatedocumentRequestPatch.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplatedocumentRequestPatch.parse_obj({ - "s_ezsigntemplatedocument_name": obj.get("sEzsigntemplatedocumentName") + _obj = cls.model_validate({ + "sEzsigntemplatedocumentName": obj.get("sEzsigntemplatedocumentName") }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatedocument_response.py b/eZmaxApi/models/ezsigntemplatedocument_response.py index 7d93105f4..d296f6bcd 100644 --- a/eZmaxApi/models/ezsigntemplatedocument_response.py +++ b/eZmaxApi/models/ezsigntemplatedocument_response.py @@ -19,63 +19,82 @@ import json - -from pydantic import BaseModel, Field, StrictBool, StrictInt, StrictStr, conint +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictBool, StrictInt, StrictStr +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatedocumentResponse(BaseModel): """ - A Ezsigntemplatedocument Object # noqa: E501 - """ - pki_ezsigntemplatedocument_id: conint(strict=True, ge=0) = Field(..., alias="pkiEzsigntemplatedocumentID", description="The unique ID of the Ezsigntemplatedocument") - fki_ezsigntemplate_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsigntemplateID", description="The unique ID of the Ezsigntemplate") - s_ezsigntemplatedocument_name: StrictStr = Field(..., alias="sEzsigntemplatedocumentName", description="The name of the Ezsigntemplatedocument.") - i_ezsigntemplatedocument_pagetotal: conint(strict=True, ge=1) = Field(..., alias="iEzsigntemplatedocumentPagetotal", description="The number of pages in the Ezsigntemplatedocument.") - i_ezsigntemplatedocument_signaturetotal: StrictInt = Field(..., alias="iEzsigntemplatedocumentSignaturetotal", description="The number of total signatures in the Ezsigntemplate.") - b_ezsigntemplatedocument_hassignedsignatures: StrictBool = Field(..., alias="bEzsigntemplatedocumentHassignedsignatures", description="If the Ezsigntemplatedocument contains signed signatures (From internal or external sources)") - __properties = ["pkiEzsigntemplatedocumentID", "fkiEzsigntemplateID", "sEzsigntemplatedocumentName", "iEzsigntemplatedocumentPagetotal", "iEzsigntemplatedocumentSignaturetotal", "bEzsigntemplatedocumentHassignedsignatures"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + A Ezsigntemplatedocument Object + """ # noqa: E501 + pki_ezsigntemplatedocument_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsigntemplatedocument", alias="pkiEzsigntemplatedocumentID") + fki_ezsigntemplate_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsigntemplate", alias="fkiEzsigntemplateID") + s_ezsigntemplatedocument_name: StrictStr = Field(description="The name of the Ezsigntemplatedocument.", alias="sEzsigntemplatedocumentName") + i_ezsigntemplatedocument_pagetotal: Annotated[int, Field(strict=True, ge=1)] = Field(description="The number of pages in the Ezsigntemplatedocument.", alias="iEzsigntemplatedocumentPagetotal") + i_ezsigntemplatedocument_signaturetotal: StrictInt = Field(description="The number of total signatures in the Ezsigntemplate.", alias="iEzsigntemplatedocumentSignaturetotal") + b_ezsigntemplatedocument_hassignedsignatures: StrictBool = Field(description="If the Ezsigntemplatedocument contains signed signatures (From internal or external sources)", alias="bEzsigntemplatedocumentHassignedsignatures") + __properties: ClassVar[List[str]] = ["pkiEzsigntemplatedocumentID", "fkiEzsigntemplateID", "sEzsigntemplatedocumentName", "iEzsigntemplatedocumentPagetotal", "iEzsigntemplatedocumentSignaturetotal", "bEzsigntemplatedocumentHassignedsignatures"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatedocumentResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatedocumentResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatedocumentResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatedocumentResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatedocumentResponse.parse_obj(obj) - - _obj = EzsigntemplatedocumentResponse.parse_obj({ - "pki_ezsigntemplatedocument_id": obj.get("pkiEzsigntemplatedocumentID"), - "fki_ezsigntemplate_id": obj.get("fkiEzsigntemplateID"), - "s_ezsigntemplatedocument_name": obj.get("sEzsigntemplatedocumentName"), - "i_ezsigntemplatedocument_pagetotal": obj.get("iEzsigntemplatedocumentPagetotal"), - "i_ezsigntemplatedocument_signaturetotal": obj.get("iEzsigntemplatedocumentSignaturetotal"), - "b_ezsigntemplatedocument_hassignedsignatures": obj.get("bEzsigntemplatedocumentHassignedsignatures") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsigntemplatedocumentID": obj.get("pkiEzsigntemplatedocumentID"), + "fkiEzsigntemplateID": obj.get("fkiEzsigntemplateID"), + "sEzsigntemplatedocumentName": obj.get("sEzsigntemplatedocumentName"), + "iEzsigntemplatedocumentPagetotal": obj.get("iEzsigntemplatedocumentPagetotal"), + "iEzsigntemplatedocumentSignaturetotal": obj.get("iEzsigntemplatedocumentSignaturetotal"), + "bEzsigntemplatedocumentHassignedsignatures": obj.get("bEzsigntemplatedocumentHassignedsignatures") }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatedocument_response_compound.py b/eZmaxApi/models/ezsigntemplatedocument_response_compound.py index 25acbb9ce..57537ebc4 100644 --- a/eZmaxApi/models/ezsigntemplatedocument_response_compound.py +++ b/eZmaxApi/models/ezsigntemplatedocument_response_compound.py @@ -19,63 +19,82 @@ import json - -from pydantic import BaseModel, Field, StrictBool, StrictInt, StrictStr, conint +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictBool, StrictInt, StrictStr +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatedocumentResponseCompound(BaseModel): """ - A Ezsigntemplatedocument Object # noqa: E501 - """ - pki_ezsigntemplatedocument_id: conint(strict=True, ge=0) = Field(..., alias="pkiEzsigntemplatedocumentID", description="The unique ID of the Ezsigntemplatedocument") - fki_ezsigntemplate_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsigntemplateID", description="The unique ID of the Ezsigntemplate") - s_ezsigntemplatedocument_name: StrictStr = Field(..., alias="sEzsigntemplatedocumentName", description="The name of the Ezsigntemplatedocument.") - i_ezsigntemplatedocument_pagetotal: conint(strict=True, ge=1) = Field(..., alias="iEzsigntemplatedocumentPagetotal", description="The number of pages in the Ezsigntemplatedocument.") - i_ezsigntemplatedocument_signaturetotal: StrictInt = Field(..., alias="iEzsigntemplatedocumentSignaturetotal", description="The number of total signatures in the Ezsigntemplate.") - b_ezsigntemplatedocument_hassignedsignatures: StrictBool = Field(..., alias="bEzsigntemplatedocumentHassignedsignatures", description="If the Ezsigntemplatedocument contains signed signatures (From internal or external sources)") - __properties = ["pkiEzsigntemplatedocumentID", "fkiEzsigntemplateID", "sEzsigntemplatedocumentName", "iEzsigntemplatedocumentPagetotal", "iEzsigntemplatedocumentSignaturetotal", "bEzsigntemplatedocumentHassignedsignatures"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + A Ezsigntemplatedocument Object + """ # noqa: E501 + pki_ezsigntemplatedocument_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsigntemplatedocument", alias="pkiEzsigntemplatedocumentID") + fki_ezsigntemplate_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsigntemplate", alias="fkiEzsigntemplateID") + s_ezsigntemplatedocument_name: StrictStr = Field(description="The name of the Ezsigntemplatedocument.", alias="sEzsigntemplatedocumentName") + i_ezsigntemplatedocument_pagetotal: Annotated[int, Field(strict=True, ge=1)] = Field(description="The number of pages in the Ezsigntemplatedocument.", alias="iEzsigntemplatedocumentPagetotal") + i_ezsigntemplatedocument_signaturetotal: StrictInt = Field(description="The number of total signatures in the Ezsigntemplate.", alias="iEzsigntemplatedocumentSignaturetotal") + b_ezsigntemplatedocument_hassignedsignatures: StrictBool = Field(description="If the Ezsigntemplatedocument contains signed signatures (From internal or external sources)", alias="bEzsigntemplatedocumentHassignedsignatures") + __properties: ClassVar[List[str]] = ["pkiEzsigntemplatedocumentID", "fkiEzsigntemplateID", "sEzsigntemplatedocumentName", "iEzsigntemplatedocumentPagetotal", "iEzsigntemplatedocumentSignaturetotal", "bEzsigntemplatedocumentHassignedsignatures"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatedocumentResponseCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatedocumentResponseCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatedocumentResponseCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatedocumentResponseCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatedocumentResponseCompound.parse_obj(obj) - - _obj = EzsigntemplatedocumentResponseCompound.parse_obj({ - "pki_ezsigntemplatedocument_id": obj.get("pkiEzsigntemplatedocumentID"), - "fki_ezsigntemplate_id": obj.get("fkiEzsigntemplateID"), - "s_ezsigntemplatedocument_name": obj.get("sEzsigntemplatedocumentName"), - "i_ezsigntemplatedocument_pagetotal": obj.get("iEzsigntemplatedocumentPagetotal"), - "i_ezsigntemplatedocument_signaturetotal": obj.get("iEzsigntemplatedocumentSignaturetotal"), - "b_ezsigntemplatedocument_hassignedsignatures": obj.get("bEzsigntemplatedocumentHassignedsignatures") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsigntemplatedocumentID": obj.get("pkiEzsigntemplatedocumentID"), + "fkiEzsigntemplateID": obj.get("fkiEzsigntemplateID"), + "sEzsigntemplatedocumentName": obj.get("sEzsigntemplatedocumentName"), + "iEzsigntemplatedocumentPagetotal": obj.get("iEzsigntemplatedocumentPagetotal"), + "iEzsigntemplatedocumentSignaturetotal": obj.get("iEzsigntemplatedocumentSignaturetotal"), + "bEzsigntemplatedocumentHassignedsignatures": obj.get("bEzsigntemplatedocumentHassignedsignatures") }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatedocumentpage_response.py b/eZmaxApi/models/ezsigntemplatedocumentpage_response.py index 4629ab67d..83a44e9a4 100644 --- a/eZmaxApi/models/ezsigntemplatedocumentpage_response.py +++ b/eZmaxApi/models/ezsigntemplatedocumentpage_response.py @@ -19,65 +19,84 @@ import json - -from pydantic import BaseModel, Field, StrictStr, conint +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictStr +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatedocumentpageResponse(BaseModel): """ - An Ezsigntemplatedocumentpage Object # noqa: E501 - """ - pki_ezsigntemplatedocumentpage_id: conint(strict=True, ge=0) = Field(..., alias="pkiEzsigntemplatedocumentpageID", description="The unique ID of the Ezsigntemplatedocumentpage") - i_ezsigntemplatedocumentpage_widthimage: conint(strict=True, ge=0) = Field(..., alias="iEzsigntemplatedocumentpageWidthimage", description="The Width of the page's image in pixels calculated at 100 DPI") - i_ezsigntemplatedocumentpage_heightimage: conint(strict=True, ge=0) = Field(..., alias="iEzsigntemplatedocumentpageHeightimage", description="The Height of the page's image in pixels calculated at 100 DPI") - i_ezsigntemplatedocumentpage_widthpdf: conint(strict=True, ge=0) = Field(..., alias="iEzsigntemplatedocumentpageWidthpdf", description="The Width of the page in points calculated at 72 DPI") - i_ezsigntemplatedocumentpage_heightpdf: conint(strict=True, ge=0) = Field(..., alias="iEzsigntemplatedocumentpageHeightpdf", description="The Height of the page in points calculated at 72 DPI") - i_ezsigntemplatedocumentpage_pagenumber: conint(strict=True, ge=1) = Field(..., alias="iEzsigntemplatedocumentpagePagenumber", description="The page number in the Ezsigntemplatedocument") - s_computed_imageurl: StrictStr = Field(..., alias="sComputedImageurl", description="The Url to the Ezsigntemplatedocumentpage's rasterized image. Url will expire after 5 minutes.") - __properties = ["pkiEzsigntemplatedocumentpageID", "iEzsigntemplatedocumentpageWidthimage", "iEzsigntemplatedocumentpageHeightimage", "iEzsigntemplatedocumentpageWidthpdf", "iEzsigntemplatedocumentpageHeightpdf", "iEzsigntemplatedocumentpagePagenumber", "sComputedImageurl"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + An Ezsigntemplatedocumentpage Object + """ # noqa: E501 + pki_ezsigntemplatedocumentpage_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsigntemplatedocumentpage", alias="pkiEzsigntemplatedocumentpageID") + i_ezsigntemplatedocumentpage_widthimage: Annotated[int, Field(strict=True, ge=0)] = Field(description="The Width of the page's image in pixels calculated at 100 DPI", alias="iEzsigntemplatedocumentpageWidthimage") + i_ezsigntemplatedocumentpage_heightimage: Annotated[int, Field(strict=True, ge=0)] = Field(description="The Height of the page's image in pixels calculated at 100 DPI", alias="iEzsigntemplatedocumentpageHeightimage") + i_ezsigntemplatedocumentpage_widthpdf: Annotated[int, Field(strict=True, ge=0)] = Field(description="The Width of the page in points calculated at 72 DPI", alias="iEzsigntemplatedocumentpageWidthpdf") + i_ezsigntemplatedocumentpage_heightpdf: Annotated[int, Field(strict=True, ge=0)] = Field(description="The Height of the page in points calculated at 72 DPI", alias="iEzsigntemplatedocumentpageHeightpdf") + i_ezsigntemplatedocumentpage_pagenumber: Annotated[int, Field(strict=True, ge=1)] = Field(description="The page number in the Ezsigntemplatedocument", alias="iEzsigntemplatedocumentpagePagenumber") + s_computed_imageurl: StrictStr = Field(description="The Url to the Ezsigntemplatedocumentpage's rasterized image. Url will expire after 5 minutes.", alias="sComputedImageurl") + __properties: ClassVar[List[str]] = ["pkiEzsigntemplatedocumentpageID", "iEzsigntemplatedocumentpageWidthimage", "iEzsigntemplatedocumentpageHeightimage", "iEzsigntemplatedocumentpageWidthpdf", "iEzsigntemplatedocumentpageHeightpdf", "iEzsigntemplatedocumentpagePagenumber", "sComputedImageurl"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatedocumentpageResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatedocumentpageResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatedocumentpageResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatedocumentpageResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatedocumentpageResponse.parse_obj(obj) - - _obj = EzsigntemplatedocumentpageResponse.parse_obj({ - "pki_ezsigntemplatedocumentpage_id": obj.get("pkiEzsigntemplatedocumentpageID"), - "i_ezsigntemplatedocumentpage_widthimage": obj.get("iEzsigntemplatedocumentpageWidthimage"), - "i_ezsigntemplatedocumentpage_heightimage": obj.get("iEzsigntemplatedocumentpageHeightimage"), - "i_ezsigntemplatedocumentpage_widthpdf": obj.get("iEzsigntemplatedocumentpageWidthpdf"), - "i_ezsigntemplatedocumentpage_heightpdf": obj.get("iEzsigntemplatedocumentpageHeightpdf"), - "i_ezsigntemplatedocumentpage_pagenumber": obj.get("iEzsigntemplatedocumentpagePagenumber"), - "s_computed_imageurl": obj.get("sComputedImageurl") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsigntemplatedocumentpageID": obj.get("pkiEzsigntemplatedocumentpageID"), + "iEzsigntemplatedocumentpageWidthimage": obj.get("iEzsigntemplatedocumentpageWidthimage"), + "iEzsigntemplatedocumentpageHeightimage": obj.get("iEzsigntemplatedocumentpageHeightimage"), + "iEzsigntemplatedocumentpageWidthpdf": obj.get("iEzsigntemplatedocumentpageWidthpdf"), + "iEzsigntemplatedocumentpageHeightpdf": obj.get("iEzsigntemplatedocumentpageHeightpdf"), + "iEzsigntemplatedocumentpagePagenumber": obj.get("iEzsigntemplatedocumentpagePagenumber"), + "sComputedImageurl": obj.get("sComputedImageurl") }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatedocumentpage_response_compound.py b/eZmaxApi/models/ezsigntemplatedocumentpage_response_compound.py index cd1eba510..081e48733 100644 --- a/eZmaxApi/models/ezsigntemplatedocumentpage_response_compound.py +++ b/eZmaxApi/models/ezsigntemplatedocumentpage_response_compound.py @@ -19,65 +19,84 @@ import json - -from pydantic import BaseModel, Field, StrictStr, conint +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictStr +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatedocumentpageResponseCompound(BaseModel): """ - An Ezsigntemplatedocumentpage Object and children to create a complete structure # noqa: E501 - """ - pki_ezsigntemplatedocumentpage_id: conint(strict=True, ge=0) = Field(..., alias="pkiEzsigntemplatedocumentpageID", description="The unique ID of the Ezsigntemplatedocumentpage") - i_ezsigntemplatedocumentpage_widthimage: conint(strict=True, ge=0) = Field(..., alias="iEzsigntemplatedocumentpageWidthimage", description="The Width of the page's image in pixels calculated at 100 DPI") - i_ezsigntemplatedocumentpage_heightimage: conint(strict=True, ge=0) = Field(..., alias="iEzsigntemplatedocumentpageHeightimage", description="The Height of the page's image in pixels calculated at 100 DPI") - i_ezsigntemplatedocumentpage_widthpdf: conint(strict=True, ge=0) = Field(..., alias="iEzsigntemplatedocumentpageWidthpdf", description="The Width of the page in points calculated at 72 DPI") - i_ezsigntemplatedocumentpage_heightpdf: conint(strict=True, ge=0) = Field(..., alias="iEzsigntemplatedocumentpageHeightpdf", description="The Height of the page in points calculated at 72 DPI") - i_ezsigntemplatedocumentpage_pagenumber: conint(strict=True, ge=1) = Field(..., alias="iEzsigntemplatedocumentpagePagenumber", description="The page number in the Ezsigntemplatedocument") - s_computed_imageurl: StrictStr = Field(..., alias="sComputedImageurl", description="The Url to the Ezsigntemplatedocumentpage's rasterized image. Url will expire after 5 minutes.") - __properties = ["pkiEzsigntemplatedocumentpageID", "iEzsigntemplatedocumentpageWidthimage", "iEzsigntemplatedocumentpageHeightimage", "iEzsigntemplatedocumentpageWidthpdf", "iEzsigntemplatedocumentpageHeightpdf", "iEzsigntemplatedocumentpagePagenumber", "sComputedImageurl"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + An Ezsigntemplatedocumentpage Object and children to create a complete structure + """ # noqa: E501 + pki_ezsigntemplatedocumentpage_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsigntemplatedocumentpage", alias="pkiEzsigntemplatedocumentpageID") + i_ezsigntemplatedocumentpage_widthimage: Annotated[int, Field(strict=True, ge=0)] = Field(description="The Width of the page's image in pixels calculated at 100 DPI", alias="iEzsigntemplatedocumentpageWidthimage") + i_ezsigntemplatedocumentpage_heightimage: Annotated[int, Field(strict=True, ge=0)] = Field(description="The Height of the page's image in pixels calculated at 100 DPI", alias="iEzsigntemplatedocumentpageHeightimage") + i_ezsigntemplatedocumentpage_widthpdf: Annotated[int, Field(strict=True, ge=0)] = Field(description="The Width of the page in points calculated at 72 DPI", alias="iEzsigntemplatedocumentpageWidthpdf") + i_ezsigntemplatedocumentpage_heightpdf: Annotated[int, Field(strict=True, ge=0)] = Field(description="The Height of the page in points calculated at 72 DPI", alias="iEzsigntemplatedocumentpageHeightpdf") + i_ezsigntemplatedocumentpage_pagenumber: Annotated[int, Field(strict=True, ge=1)] = Field(description="The page number in the Ezsigntemplatedocument", alias="iEzsigntemplatedocumentpagePagenumber") + s_computed_imageurl: StrictStr = Field(description="The Url to the Ezsigntemplatedocumentpage's rasterized image. Url will expire after 5 minutes.", alias="sComputedImageurl") + __properties: ClassVar[List[str]] = ["pkiEzsigntemplatedocumentpageID", "iEzsigntemplatedocumentpageWidthimage", "iEzsigntemplatedocumentpageHeightimage", "iEzsigntemplatedocumentpageWidthpdf", "iEzsigntemplatedocumentpageHeightpdf", "iEzsigntemplatedocumentpagePagenumber", "sComputedImageurl"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatedocumentpageResponseCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatedocumentpageResponseCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatedocumentpageResponseCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatedocumentpageResponseCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatedocumentpageResponseCompound.parse_obj(obj) - - _obj = EzsigntemplatedocumentpageResponseCompound.parse_obj({ - "pki_ezsigntemplatedocumentpage_id": obj.get("pkiEzsigntemplatedocumentpageID"), - "i_ezsigntemplatedocumentpage_widthimage": obj.get("iEzsigntemplatedocumentpageWidthimage"), - "i_ezsigntemplatedocumentpage_heightimage": obj.get("iEzsigntemplatedocumentpageHeightimage"), - "i_ezsigntemplatedocumentpage_widthpdf": obj.get("iEzsigntemplatedocumentpageWidthpdf"), - "i_ezsigntemplatedocumentpage_heightpdf": obj.get("iEzsigntemplatedocumentpageHeightpdf"), - "i_ezsigntemplatedocumentpage_pagenumber": obj.get("iEzsigntemplatedocumentpagePagenumber"), - "s_computed_imageurl": obj.get("sComputedImageurl") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsigntemplatedocumentpageID": obj.get("pkiEzsigntemplatedocumentpageID"), + "iEzsigntemplatedocumentpageWidthimage": obj.get("iEzsigntemplatedocumentpageWidthimage"), + "iEzsigntemplatedocumentpageHeightimage": obj.get("iEzsigntemplatedocumentpageHeightimage"), + "iEzsigntemplatedocumentpageWidthpdf": obj.get("iEzsigntemplatedocumentpageWidthpdf"), + "iEzsigntemplatedocumentpageHeightpdf": obj.get("iEzsigntemplatedocumentpageHeightpdf"), + "iEzsigntemplatedocumentpagePagenumber": obj.get("iEzsigntemplatedocumentpagePagenumber"), + "sComputedImageurl": obj.get("sComputedImageurl") }) return _obj diff --git a/eZmaxApi/models/ezsigntemplateelementdependency_request.py b/eZmaxApi/models/ezsigntemplateelementdependency_request.py index 5fb7049df..2729d7dac 100644 --- a/eZmaxApi/models/ezsigntemplateelementdependency_request.py +++ b/eZmaxApi/models/ezsigntemplateelementdependency_request.py @@ -19,27 +19,33 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint, constr, validator +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, StrictStr, field_validator +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.field_e_ezsigntemplateelementdependency_operator import FieldEEzsigntemplateelementdependencyOperator from eZmaxApi.models.field_e_ezsigntemplateelementdependency_validation import FieldEEzsigntemplateelementdependencyValidation +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplateelementdependencyRequest(BaseModel): """ - An Ezsigntemplateelementdependency Object # noqa: E501 - """ - pki_ezsigntemplateelementdependency_id: Optional[conint(strict=True, le=65535, ge=0)] = Field(None, alias="pkiEzsigntemplateelementdependencyID", description="The unique ID of the Ezsigntemplateelementdependency") - fki_ezsigntemplateformfield_id_validation: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiEzsigntemplateformfieldIDValidation", description="The unique ID of the Ezsigntemplateformfield") - fki_ezsigntemplateformfieldgroup_id_validation: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiEzsigntemplateformfieldgroupIDValidation", description="The unique ID of the Ezsigntemplateformfieldgroup") - s_ezsigntemplateelementdependency_ezsigntemplateformfieldgrouplabel: Optional[constr(strict=True, max_length=50, min_length=1)] = Field(None, alias="sEzsigntemplateelementdependencyEzsigntemplateformfieldgrouplabel", description="The Label for the Ezsigntemplateformfieldgroup") - s_ezsigntemplateelementdependency_ezsigntemplateformfieldlabel: Optional[StrictStr] = Field(None, alias="sEzsigntemplateelementdependencyEzsigntemplateformfieldlabel", description="The Label for the Ezsigntemplateformfield") - e_ezsigntemplateelementdependency_validation: FieldEEzsigntemplateelementdependencyValidation = Field(..., alias="eEzsigntemplateelementdependencyValidation") - b_ezsigntemplateelementdependency_selected: Optional[StrictBool] = Field(None, alias="bEzsigntemplateelementdependencySelected", description="Whether if it's selected or not when using eEzsigntemplateelementdependencyValidation = Selected") - e_ezsigntemplateelementdependency_operator: Optional[FieldEEzsigntemplateelementdependencyOperator] = Field(None, alias="eEzsigntemplateelementdependencyOperator") - s_ezsigntemplateelementdependency_value: Optional[constr(strict=True)] = Field(None, alias="sEzsigntemplateelementdependencyValue", description="The value of the Ezsignelementdependency") - __properties = ["pkiEzsigntemplateelementdependencyID", "fkiEzsigntemplateformfieldIDValidation", "fkiEzsigntemplateformfieldgroupIDValidation", "sEzsigntemplateelementdependencyEzsigntemplateformfieldgrouplabel", "sEzsigntemplateelementdependencyEzsigntemplateformfieldlabel", "eEzsigntemplateelementdependencyValidation", "bEzsigntemplateelementdependencySelected", "eEzsigntemplateelementdependencyOperator", "sEzsigntemplateelementdependencyValue"] - - @validator('s_ezsigntemplateelementdependency_value') + An Ezsigntemplateelementdependency Object + """ # noqa: E501 + pki_ezsigntemplateelementdependency_id: Optional[Annotated[int, Field(le=65535, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsigntemplateelementdependency", alias="pkiEzsigntemplateelementdependencyID") + fki_ezsigntemplateformfield_id_validation: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsigntemplateformfield", alias="fkiEzsigntemplateformfieldIDValidation") + fki_ezsigntemplateformfieldgroup_id_validation: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsigntemplateformfieldgroup", alias="fkiEzsigntemplateformfieldgroupIDValidation") + s_ezsigntemplateelementdependency_ezsigntemplateformfieldgrouplabel: Optional[Annotated[str, Field(min_length=1, strict=True, max_length=50)]] = Field(default=None, description="The Label for the Ezsigntemplateformfieldgroup", alias="sEzsigntemplateelementdependencyEzsigntemplateformfieldgrouplabel") + s_ezsigntemplateelementdependency_ezsigntemplateformfieldlabel: Optional[StrictStr] = Field(default=None, description="The Label for the Ezsigntemplateformfield", alias="sEzsigntemplateelementdependencyEzsigntemplateformfieldlabel") + e_ezsigntemplateelementdependency_validation: FieldEEzsigntemplateelementdependencyValidation = Field(alias="eEzsigntemplateelementdependencyValidation") + b_ezsigntemplateelementdependency_selected: Optional[StrictBool] = Field(default=None, description="Whether if it's selected or not when using eEzsigntemplateelementdependencyValidation = Selected", alias="bEzsigntemplateelementdependencySelected") + e_ezsigntemplateelementdependency_operator: Optional[FieldEEzsigntemplateelementdependencyOperator] = Field(default=None, alias="eEzsigntemplateelementdependencyOperator") + s_ezsigntemplateelementdependency_value: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="The value of the Ezsignelementdependency", alias="sEzsigntemplateelementdependencyValue") + __properties: ClassVar[List[str]] = ["pkiEzsigntemplateelementdependencyID", "fkiEzsigntemplateformfieldIDValidation", "fkiEzsigntemplateformfieldgroupIDValidation", "sEzsigntemplateelementdependencyEzsigntemplateformfieldgrouplabel", "sEzsigntemplateelementdependencyEzsigntemplateformfieldlabel", "eEzsigntemplateelementdependencyValidation", "bEzsigntemplateelementdependencySelected", "eEzsigntemplateelementdependencyOperator", "sEzsigntemplateelementdependencyValue"] + + @field_validator('s_ezsigntemplateelementdependency_value') def s_ezsigntemplateelementdependency_value_validate_regular_expression(cls, value): """Validates the regular expression""" if value is None: @@ -49,51 +55,64 @@ def s_ezsigntemplateelementdependency_value_validate_regular_expression(cls, val raise ValueError(r"must validate the regular expression /^.{0,50}$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplateelementdependencyRequest: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplateelementdependencyRequest from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplateelementdependencyRequest: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplateelementdependencyRequest from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplateelementdependencyRequest.parse_obj(obj) - - _obj = EzsigntemplateelementdependencyRequest.parse_obj({ - "pki_ezsigntemplateelementdependency_id": obj.get("pkiEzsigntemplateelementdependencyID"), - "fki_ezsigntemplateformfield_id_validation": obj.get("fkiEzsigntemplateformfieldIDValidation"), - "fki_ezsigntemplateformfieldgroup_id_validation": obj.get("fkiEzsigntemplateformfieldgroupIDValidation"), - "s_ezsigntemplateelementdependency_ezsigntemplateformfieldgrouplabel": obj.get("sEzsigntemplateelementdependencyEzsigntemplateformfieldgrouplabel"), - "s_ezsigntemplateelementdependency_ezsigntemplateformfieldlabel": obj.get("sEzsigntemplateelementdependencyEzsigntemplateformfieldlabel"), - "e_ezsigntemplateelementdependency_validation": obj.get("eEzsigntemplateelementdependencyValidation"), - "b_ezsigntemplateelementdependency_selected": obj.get("bEzsigntemplateelementdependencySelected"), - "e_ezsigntemplateelementdependency_operator": obj.get("eEzsigntemplateelementdependencyOperator"), - "s_ezsigntemplateelementdependency_value": obj.get("sEzsigntemplateelementdependencyValue") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsigntemplateelementdependencyID": obj.get("pkiEzsigntemplateelementdependencyID"), + "fkiEzsigntemplateformfieldIDValidation": obj.get("fkiEzsigntemplateformfieldIDValidation"), + "fkiEzsigntemplateformfieldgroupIDValidation": obj.get("fkiEzsigntemplateformfieldgroupIDValidation"), + "sEzsigntemplateelementdependencyEzsigntemplateformfieldgrouplabel": obj.get("sEzsigntemplateelementdependencyEzsigntemplateformfieldgrouplabel"), + "sEzsigntemplateelementdependencyEzsigntemplateformfieldlabel": obj.get("sEzsigntemplateelementdependencyEzsigntemplateformfieldlabel"), + "eEzsigntemplateelementdependencyValidation": obj.get("eEzsigntemplateelementdependencyValidation"), + "bEzsigntemplateelementdependencySelected": obj.get("bEzsigntemplateelementdependencySelected"), + "eEzsigntemplateelementdependencyOperator": obj.get("eEzsigntemplateelementdependencyOperator"), + "sEzsigntemplateelementdependencyValue": obj.get("sEzsigntemplateelementdependencyValue") }) return _obj diff --git a/eZmaxApi/models/ezsigntemplateelementdependency_request_compound.py b/eZmaxApi/models/ezsigntemplateelementdependency_request_compound.py index 2a484adca..c1cd3a70b 100644 --- a/eZmaxApi/models/ezsigntemplateelementdependency_request_compound.py +++ b/eZmaxApi/models/ezsigntemplateelementdependency_request_compound.py @@ -19,27 +19,33 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint, constr, validator +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, StrictStr, field_validator +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.field_e_ezsigntemplateelementdependency_operator import FieldEEzsigntemplateelementdependencyOperator from eZmaxApi.models.field_e_ezsigntemplateelementdependency_validation import FieldEEzsigntemplateelementdependencyValidation +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplateelementdependencyRequestCompound(BaseModel): """ - An Ezsigntemplateelementdependency Object and children to create a complete structure # noqa: E501 - """ - pki_ezsigntemplateelementdependency_id: Optional[conint(strict=True, le=65535, ge=0)] = Field(None, alias="pkiEzsigntemplateelementdependencyID", description="The unique ID of the Ezsigntemplateelementdependency") - fki_ezsigntemplateformfield_id_validation: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiEzsigntemplateformfieldIDValidation", description="The unique ID of the Ezsigntemplateformfield") - fki_ezsigntemplateformfieldgroup_id_validation: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiEzsigntemplateformfieldgroupIDValidation", description="The unique ID of the Ezsigntemplateformfieldgroup") - s_ezsigntemplateelementdependency_ezsigntemplateformfieldgrouplabel: Optional[constr(strict=True, max_length=50, min_length=1)] = Field(None, alias="sEzsigntemplateelementdependencyEzsigntemplateformfieldgrouplabel", description="The Label for the Ezsigntemplateformfieldgroup") - s_ezsigntemplateelementdependency_ezsigntemplateformfieldlabel: Optional[StrictStr] = Field(None, alias="sEzsigntemplateelementdependencyEzsigntemplateformfieldlabel", description="The Label for the Ezsigntemplateformfield") - e_ezsigntemplateelementdependency_validation: FieldEEzsigntemplateelementdependencyValidation = Field(..., alias="eEzsigntemplateelementdependencyValidation") - b_ezsigntemplateelementdependency_selected: Optional[StrictBool] = Field(None, alias="bEzsigntemplateelementdependencySelected", description="Whether if it's selected or not when using eEzsigntemplateelementdependencyValidation = Selected") - e_ezsigntemplateelementdependency_operator: Optional[FieldEEzsigntemplateelementdependencyOperator] = Field(None, alias="eEzsigntemplateelementdependencyOperator") - s_ezsigntemplateelementdependency_value: Optional[constr(strict=True)] = Field(None, alias="sEzsigntemplateelementdependencyValue", description="The value of the Ezsignelementdependency") - __properties = ["pkiEzsigntemplateelementdependencyID", "fkiEzsigntemplateformfieldIDValidation", "fkiEzsigntemplateformfieldgroupIDValidation", "sEzsigntemplateelementdependencyEzsigntemplateformfieldgrouplabel", "sEzsigntemplateelementdependencyEzsigntemplateformfieldlabel", "eEzsigntemplateelementdependencyValidation", "bEzsigntemplateelementdependencySelected", "eEzsigntemplateelementdependencyOperator", "sEzsigntemplateelementdependencyValue"] - - @validator('s_ezsigntemplateelementdependency_value') + An Ezsigntemplateelementdependency Object and children to create a complete structure + """ # noqa: E501 + pki_ezsigntemplateelementdependency_id: Optional[Annotated[int, Field(le=65535, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsigntemplateelementdependency", alias="pkiEzsigntemplateelementdependencyID") + fki_ezsigntemplateformfield_id_validation: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsigntemplateformfield", alias="fkiEzsigntemplateformfieldIDValidation") + fki_ezsigntemplateformfieldgroup_id_validation: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsigntemplateformfieldgroup", alias="fkiEzsigntemplateformfieldgroupIDValidation") + s_ezsigntemplateelementdependency_ezsigntemplateformfieldgrouplabel: Optional[Annotated[str, Field(min_length=1, strict=True, max_length=50)]] = Field(default=None, description="The Label for the Ezsigntemplateformfieldgroup", alias="sEzsigntemplateelementdependencyEzsigntemplateformfieldgrouplabel") + s_ezsigntemplateelementdependency_ezsigntemplateformfieldlabel: Optional[StrictStr] = Field(default=None, description="The Label for the Ezsigntemplateformfield", alias="sEzsigntemplateelementdependencyEzsigntemplateformfieldlabel") + e_ezsigntemplateelementdependency_validation: FieldEEzsigntemplateelementdependencyValidation = Field(alias="eEzsigntemplateelementdependencyValidation") + b_ezsigntemplateelementdependency_selected: Optional[StrictBool] = Field(default=None, description="Whether if it's selected or not when using eEzsigntemplateelementdependencyValidation = Selected", alias="bEzsigntemplateelementdependencySelected") + e_ezsigntemplateelementdependency_operator: Optional[FieldEEzsigntemplateelementdependencyOperator] = Field(default=None, alias="eEzsigntemplateelementdependencyOperator") + s_ezsigntemplateelementdependency_value: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="The value of the Ezsignelementdependency", alias="sEzsigntemplateelementdependencyValue") + __properties: ClassVar[List[str]] = ["pkiEzsigntemplateelementdependencyID", "fkiEzsigntemplateformfieldIDValidation", "fkiEzsigntemplateformfieldgroupIDValidation", "sEzsigntemplateelementdependencyEzsigntemplateformfieldgrouplabel", "sEzsigntemplateelementdependencyEzsigntemplateformfieldlabel", "eEzsigntemplateelementdependencyValidation", "bEzsigntemplateelementdependencySelected", "eEzsigntemplateelementdependencyOperator", "sEzsigntemplateelementdependencyValue"] + + @field_validator('s_ezsigntemplateelementdependency_value') def s_ezsigntemplateelementdependency_value_validate_regular_expression(cls, value): """Validates the regular expression""" if value is None: @@ -49,51 +55,64 @@ def s_ezsigntemplateelementdependency_value_validate_regular_expression(cls, val raise ValueError(r"must validate the regular expression /^.{0,50}$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplateelementdependencyRequestCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplateelementdependencyRequestCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplateelementdependencyRequestCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplateelementdependencyRequestCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplateelementdependencyRequestCompound.parse_obj(obj) - - _obj = EzsigntemplateelementdependencyRequestCompound.parse_obj({ - "pki_ezsigntemplateelementdependency_id": obj.get("pkiEzsigntemplateelementdependencyID"), - "fki_ezsigntemplateformfield_id_validation": obj.get("fkiEzsigntemplateformfieldIDValidation"), - "fki_ezsigntemplateformfieldgroup_id_validation": obj.get("fkiEzsigntemplateformfieldgroupIDValidation"), - "s_ezsigntemplateelementdependency_ezsigntemplateformfieldgrouplabel": obj.get("sEzsigntemplateelementdependencyEzsigntemplateformfieldgrouplabel"), - "s_ezsigntemplateelementdependency_ezsigntemplateformfieldlabel": obj.get("sEzsigntemplateelementdependencyEzsigntemplateformfieldlabel"), - "e_ezsigntemplateelementdependency_validation": obj.get("eEzsigntemplateelementdependencyValidation"), - "b_ezsigntemplateelementdependency_selected": obj.get("bEzsigntemplateelementdependencySelected"), - "e_ezsigntemplateelementdependency_operator": obj.get("eEzsigntemplateelementdependencyOperator"), - "s_ezsigntemplateelementdependency_value": obj.get("sEzsigntemplateelementdependencyValue") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsigntemplateelementdependencyID": obj.get("pkiEzsigntemplateelementdependencyID"), + "fkiEzsigntemplateformfieldIDValidation": obj.get("fkiEzsigntemplateformfieldIDValidation"), + "fkiEzsigntemplateformfieldgroupIDValidation": obj.get("fkiEzsigntemplateformfieldgroupIDValidation"), + "sEzsigntemplateelementdependencyEzsigntemplateformfieldgrouplabel": obj.get("sEzsigntemplateelementdependencyEzsigntemplateformfieldgrouplabel"), + "sEzsigntemplateelementdependencyEzsigntemplateformfieldlabel": obj.get("sEzsigntemplateelementdependencyEzsigntemplateformfieldlabel"), + "eEzsigntemplateelementdependencyValidation": obj.get("eEzsigntemplateelementdependencyValidation"), + "bEzsigntemplateelementdependencySelected": obj.get("bEzsigntemplateelementdependencySelected"), + "eEzsigntemplateelementdependencyOperator": obj.get("eEzsigntemplateelementdependencyOperator"), + "sEzsigntemplateelementdependencyValue": obj.get("sEzsigntemplateelementdependencyValue") }) return _obj diff --git a/eZmaxApi/models/ezsigntemplateelementdependency_response.py b/eZmaxApi/models/ezsigntemplateelementdependency_response.py index 8a7ebd342..e153e70dc 100644 --- a/eZmaxApi/models/ezsigntemplateelementdependency_response.py +++ b/eZmaxApi/models/ezsigntemplateelementdependency_response.py @@ -19,27 +19,33 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictBool, conint, constr, validator +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, field_validator +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.field_e_ezsigntemplateelementdependency_operator import FieldEEzsigntemplateelementdependencyOperator from eZmaxApi.models.field_e_ezsigntemplateelementdependency_validation import FieldEEzsigntemplateelementdependencyValidation +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplateelementdependencyResponse(BaseModel): """ - An Ezsigntemplateelementdependency Object # noqa: E501 - """ - pki_ezsigntemplateelementdependency_id: conint(strict=True, le=65535, ge=0) = Field(..., alias="pkiEzsigntemplateelementdependencyID", description="The unique ID of the Ezsigntemplateelementdependency") - fki_ezsigntemplateformfield_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiEzsigntemplateformfieldID", description="The unique ID of the Ezsigntemplateformfield") - fki_ezsigntemplatesignature_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiEzsigntemplatesignatureID", description="The unique ID of the Ezsigntemplatesignature") - fki_ezsigntemplateformfield_id_validation: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiEzsigntemplateformfieldIDValidation", description="The unique ID of the Ezsigntemplateformfield") - fki_ezsigntemplateformfieldgroup_id_validation: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiEzsigntemplateformfieldgroupIDValidation", description="The unique ID of the Ezsigntemplateformfieldgroup") - e_ezsigntemplateelementdependency_validation: FieldEEzsigntemplateelementdependencyValidation = Field(..., alias="eEzsigntemplateelementdependencyValidation") - b_ezsigntemplateelementdependency_selected: Optional[StrictBool] = Field(None, alias="bEzsigntemplateelementdependencySelected", description="Whether if it's selected or not when using eEzsigntemplateelementdependencyValidation = Selected") - e_ezsigntemplateelementdependency_operator: Optional[FieldEEzsigntemplateelementdependencyOperator] = Field(None, alias="eEzsigntemplateelementdependencyOperator") - s_ezsigntemplateelementdependency_value: Optional[constr(strict=True)] = Field(None, alias="sEzsigntemplateelementdependencyValue", description="The value of the Ezsignelementdependency") - __properties = ["pkiEzsigntemplateelementdependencyID", "fkiEzsigntemplateformfieldID", "fkiEzsigntemplatesignatureID", "fkiEzsigntemplateformfieldIDValidation", "fkiEzsigntemplateformfieldgroupIDValidation", "eEzsigntemplateelementdependencyValidation", "bEzsigntemplateelementdependencySelected", "eEzsigntemplateelementdependencyOperator", "sEzsigntemplateelementdependencyValue"] - - @validator('s_ezsigntemplateelementdependency_value') + An Ezsigntemplateelementdependency Object + """ # noqa: E501 + pki_ezsigntemplateelementdependency_id: Annotated[int, Field(le=65535, strict=True, ge=0)] = Field(description="The unique ID of the Ezsigntemplateelementdependency", alias="pkiEzsigntemplateelementdependencyID") + fki_ezsigntemplateformfield_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsigntemplateformfield", alias="fkiEzsigntemplateformfieldID") + fki_ezsigntemplatesignature_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsigntemplatesignature", alias="fkiEzsigntemplatesignatureID") + fki_ezsigntemplateformfield_id_validation: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsigntemplateformfield", alias="fkiEzsigntemplateformfieldIDValidation") + fki_ezsigntemplateformfieldgroup_id_validation: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsigntemplateformfieldgroup", alias="fkiEzsigntemplateformfieldgroupIDValidation") + e_ezsigntemplateelementdependency_validation: FieldEEzsigntemplateelementdependencyValidation = Field(alias="eEzsigntemplateelementdependencyValidation") + b_ezsigntemplateelementdependency_selected: Optional[StrictBool] = Field(default=None, description="Whether if it's selected or not when using eEzsigntemplateelementdependencyValidation = Selected", alias="bEzsigntemplateelementdependencySelected") + e_ezsigntemplateelementdependency_operator: Optional[FieldEEzsigntemplateelementdependencyOperator] = Field(default=None, alias="eEzsigntemplateelementdependencyOperator") + s_ezsigntemplateelementdependency_value: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="The value of the Ezsignelementdependency", alias="sEzsigntemplateelementdependencyValue") + __properties: ClassVar[List[str]] = ["pkiEzsigntemplateelementdependencyID", "fkiEzsigntemplateformfieldID", "fkiEzsigntemplatesignatureID", "fkiEzsigntemplateformfieldIDValidation", "fkiEzsigntemplateformfieldgroupIDValidation", "eEzsigntemplateelementdependencyValidation", "bEzsigntemplateelementdependencySelected", "eEzsigntemplateelementdependencyOperator", "sEzsigntemplateelementdependencyValue"] + + @field_validator('s_ezsigntemplateelementdependency_value') def s_ezsigntemplateelementdependency_value_validate_regular_expression(cls, value): """Validates the regular expression""" if value is None: @@ -49,51 +55,64 @@ def s_ezsigntemplateelementdependency_value_validate_regular_expression(cls, val raise ValueError(r"must validate the regular expression /^.{0,50}$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplateelementdependencyResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplateelementdependencyResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplateelementdependencyResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplateelementdependencyResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplateelementdependencyResponse.parse_obj(obj) - - _obj = EzsigntemplateelementdependencyResponse.parse_obj({ - "pki_ezsigntemplateelementdependency_id": obj.get("pkiEzsigntemplateelementdependencyID"), - "fki_ezsigntemplateformfield_id": obj.get("fkiEzsigntemplateformfieldID"), - "fki_ezsigntemplatesignature_id": obj.get("fkiEzsigntemplatesignatureID"), - "fki_ezsigntemplateformfield_id_validation": obj.get("fkiEzsigntemplateformfieldIDValidation"), - "fki_ezsigntemplateformfieldgroup_id_validation": obj.get("fkiEzsigntemplateformfieldgroupIDValidation"), - "e_ezsigntemplateelementdependency_validation": obj.get("eEzsigntemplateelementdependencyValidation"), - "b_ezsigntemplateelementdependency_selected": obj.get("bEzsigntemplateelementdependencySelected"), - "e_ezsigntemplateelementdependency_operator": obj.get("eEzsigntemplateelementdependencyOperator"), - "s_ezsigntemplateelementdependency_value": obj.get("sEzsigntemplateelementdependencyValue") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsigntemplateelementdependencyID": obj.get("pkiEzsigntemplateelementdependencyID"), + "fkiEzsigntemplateformfieldID": obj.get("fkiEzsigntemplateformfieldID"), + "fkiEzsigntemplatesignatureID": obj.get("fkiEzsigntemplatesignatureID"), + "fkiEzsigntemplateformfieldIDValidation": obj.get("fkiEzsigntemplateformfieldIDValidation"), + "fkiEzsigntemplateformfieldgroupIDValidation": obj.get("fkiEzsigntemplateformfieldgroupIDValidation"), + "eEzsigntemplateelementdependencyValidation": obj.get("eEzsigntemplateelementdependencyValidation"), + "bEzsigntemplateelementdependencySelected": obj.get("bEzsigntemplateelementdependencySelected"), + "eEzsigntemplateelementdependencyOperator": obj.get("eEzsigntemplateelementdependencyOperator"), + "sEzsigntemplateelementdependencyValue": obj.get("sEzsigntemplateelementdependencyValue") }) return _obj diff --git a/eZmaxApi/models/ezsigntemplateelementdependency_response_compound.py b/eZmaxApi/models/ezsigntemplateelementdependency_response_compound.py index 67863e535..36e34b9ae 100644 --- a/eZmaxApi/models/ezsigntemplateelementdependency_response_compound.py +++ b/eZmaxApi/models/ezsigntemplateelementdependency_response_compound.py @@ -19,27 +19,33 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictBool, conint, constr, validator +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, field_validator +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.field_e_ezsigntemplateelementdependency_operator import FieldEEzsigntemplateelementdependencyOperator from eZmaxApi.models.field_e_ezsigntemplateelementdependency_validation import FieldEEzsigntemplateelementdependencyValidation +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplateelementdependencyResponseCompound(BaseModel): """ - An Ezsigntemplateelementdependency Object and children to create a complete structure # noqa: E501 - """ - pki_ezsigntemplateelementdependency_id: conint(strict=True, le=65535, ge=0) = Field(..., alias="pkiEzsigntemplateelementdependencyID", description="The unique ID of the Ezsigntemplateelementdependency") - fki_ezsigntemplateformfield_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiEzsigntemplateformfieldID", description="The unique ID of the Ezsigntemplateformfield") - fki_ezsigntemplatesignature_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiEzsigntemplatesignatureID", description="The unique ID of the Ezsigntemplatesignature") - fki_ezsigntemplateformfield_id_validation: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiEzsigntemplateformfieldIDValidation", description="The unique ID of the Ezsigntemplateformfield") - fki_ezsigntemplateformfieldgroup_id_validation: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiEzsigntemplateformfieldgroupIDValidation", description="The unique ID of the Ezsigntemplateformfieldgroup") - e_ezsigntemplateelementdependency_validation: FieldEEzsigntemplateelementdependencyValidation = Field(..., alias="eEzsigntemplateelementdependencyValidation") - b_ezsigntemplateelementdependency_selected: Optional[StrictBool] = Field(None, alias="bEzsigntemplateelementdependencySelected", description="Whether if it's selected or not when using eEzsigntemplateelementdependencyValidation = Selected") - e_ezsigntemplateelementdependency_operator: Optional[FieldEEzsigntemplateelementdependencyOperator] = Field(None, alias="eEzsigntemplateelementdependencyOperator") - s_ezsigntemplateelementdependency_value: Optional[constr(strict=True)] = Field(None, alias="sEzsigntemplateelementdependencyValue", description="The value of the Ezsignelementdependency") - __properties = ["pkiEzsigntemplateelementdependencyID", "fkiEzsigntemplateformfieldID", "fkiEzsigntemplatesignatureID", "fkiEzsigntemplateformfieldIDValidation", "fkiEzsigntemplateformfieldgroupIDValidation", "eEzsigntemplateelementdependencyValidation", "bEzsigntemplateelementdependencySelected", "eEzsigntemplateelementdependencyOperator", "sEzsigntemplateelementdependencyValue"] - - @validator('s_ezsigntemplateelementdependency_value') + An Ezsigntemplateelementdependency Object and children to create a complete structure + """ # noqa: E501 + pki_ezsigntemplateelementdependency_id: Annotated[int, Field(le=65535, strict=True, ge=0)] = Field(description="The unique ID of the Ezsigntemplateelementdependency", alias="pkiEzsigntemplateelementdependencyID") + fki_ezsigntemplateformfield_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsigntemplateformfield", alias="fkiEzsigntemplateformfieldID") + fki_ezsigntemplatesignature_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsigntemplatesignature", alias="fkiEzsigntemplatesignatureID") + fki_ezsigntemplateformfield_id_validation: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsigntemplateformfield", alias="fkiEzsigntemplateformfieldIDValidation") + fki_ezsigntemplateformfieldgroup_id_validation: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsigntemplateformfieldgroup", alias="fkiEzsigntemplateformfieldgroupIDValidation") + e_ezsigntemplateelementdependency_validation: FieldEEzsigntemplateelementdependencyValidation = Field(alias="eEzsigntemplateelementdependencyValidation") + b_ezsigntemplateelementdependency_selected: Optional[StrictBool] = Field(default=None, description="Whether if it's selected or not when using eEzsigntemplateelementdependencyValidation = Selected", alias="bEzsigntemplateelementdependencySelected") + e_ezsigntemplateelementdependency_operator: Optional[FieldEEzsigntemplateelementdependencyOperator] = Field(default=None, alias="eEzsigntemplateelementdependencyOperator") + s_ezsigntemplateelementdependency_value: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="The value of the Ezsignelementdependency", alias="sEzsigntemplateelementdependencyValue") + __properties: ClassVar[List[str]] = ["pkiEzsigntemplateelementdependencyID", "fkiEzsigntemplateformfieldID", "fkiEzsigntemplatesignatureID", "fkiEzsigntemplateformfieldIDValidation", "fkiEzsigntemplateformfieldgroupIDValidation", "eEzsigntemplateelementdependencyValidation", "bEzsigntemplateelementdependencySelected", "eEzsigntemplateelementdependencyOperator", "sEzsigntemplateelementdependencyValue"] + + @field_validator('s_ezsigntemplateelementdependency_value') def s_ezsigntemplateelementdependency_value_validate_regular_expression(cls, value): """Validates the regular expression""" if value is None: @@ -49,51 +55,64 @@ def s_ezsigntemplateelementdependency_value_validate_regular_expression(cls, val raise ValueError(r"must validate the regular expression /^.{0,50}$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplateelementdependencyResponseCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplateelementdependencyResponseCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplateelementdependencyResponseCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplateelementdependencyResponseCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplateelementdependencyResponseCompound.parse_obj(obj) - - _obj = EzsigntemplateelementdependencyResponseCompound.parse_obj({ - "pki_ezsigntemplateelementdependency_id": obj.get("pkiEzsigntemplateelementdependencyID"), - "fki_ezsigntemplateformfield_id": obj.get("fkiEzsigntemplateformfieldID"), - "fki_ezsigntemplatesignature_id": obj.get("fkiEzsigntemplatesignatureID"), - "fki_ezsigntemplateformfield_id_validation": obj.get("fkiEzsigntemplateformfieldIDValidation"), - "fki_ezsigntemplateformfieldgroup_id_validation": obj.get("fkiEzsigntemplateformfieldgroupIDValidation"), - "e_ezsigntemplateelementdependency_validation": obj.get("eEzsigntemplateelementdependencyValidation"), - "b_ezsigntemplateelementdependency_selected": obj.get("bEzsigntemplateelementdependencySelected"), - "e_ezsigntemplateelementdependency_operator": obj.get("eEzsigntemplateelementdependencyOperator"), - "s_ezsigntemplateelementdependency_value": obj.get("sEzsigntemplateelementdependencyValue") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsigntemplateelementdependencyID": obj.get("pkiEzsigntemplateelementdependencyID"), + "fkiEzsigntemplateformfieldID": obj.get("fkiEzsigntemplateformfieldID"), + "fkiEzsigntemplatesignatureID": obj.get("fkiEzsigntemplatesignatureID"), + "fkiEzsigntemplateformfieldIDValidation": obj.get("fkiEzsigntemplateformfieldIDValidation"), + "fkiEzsigntemplateformfieldgroupIDValidation": obj.get("fkiEzsigntemplateformfieldgroupIDValidation"), + "eEzsigntemplateelementdependencyValidation": obj.get("eEzsigntemplateelementdependencyValidation"), + "bEzsigntemplateelementdependencySelected": obj.get("bEzsigntemplateelementdependencySelected"), + "eEzsigntemplateelementdependencyOperator": obj.get("eEzsigntemplateelementdependencyOperator"), + "sEzsigntemplateelementdependencyValue": obj.get("sEzsigntemplateelementdependencyValue") }) return _obj diff --git a/eZmaxApi/models/ezsigntemplateformfield_request.py b/eZmaxApi/models/ezsigntemplateformfield_request.py index 2900a84c4..dfdac1f11 100644 --- a/eZmaxApi/models/ezsigntemplateformfield_request.py +++ b/eZmaxApi/models/ezsigntemplateformfield_request.py @@ -19,74 +19,93 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, StrictStr +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.field_e_ezsigntemplateformfield_dependencyrequirement import FieldEEzsigntemplateformfieldDependencyrequirement +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplateformfieldRequest(BaseModel): """ - A Ezsigntemplateformfield Object # noqa: E501 - """ - pki_ezsigntemplateformfield_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="pkiEzsigntemplateformfieldID", description="The unique ID of the Ezsigntemplateformfield") - i_ezsigntemplatedocumentpage_pagenumber: conint(strict=True, ge=1) = Field(..., alias="iEzsigntemplatedocumentpagePagenumber", description="The page number in the Ezsigntemplatedocument") - s_ezsigntemplateformfield_label: StrictStr = Field(..., alias="sEzsigntemplateformfieldLabel", description="The Label for the Ezsigntemplateformfield") - s_ezsigntemplateformfield_value: Optional[StrictStr] = Field(None, alias="sEzsigntemplateformfieldValue", description="The value for the Ezsigntemplateformfield") - i_ezsigntemplateformfield_x: conint(strict=True, ge=0) = Field(..., alias="iEzsigntemplateformfieldX", description="The X coordinate (Horizontal) where to put the Ezsigntemplateformfield on the Ezsigntemplatepage. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsigntemplateformfield 2 inches from the left border of the page, you would use \"200\" for the X coordinate.") - i_ezsigntemplateformfield_y: conint(strict=True, ge=0) = Field(..., alias="iEzsigntemplateformfieldY", description="The Y coordinate (Vertical) where to put the Ezsigntemplateformfield on the Ezsigntemplatepage. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsigntemplateformfield 3 inches from the top border of the page, you would use \"300\" for the Y coordinate.") - i_ezsigntemplateformfield_width: conint(strict=True, ge=0) = Field(..., alias="iEzsigntemplateformfieldWidth", description="The Width of the Ezsigntemplateformfield in pixels calculated at 100 DPI The allowed values are varying based on the eEzsigntemplateformfieldgroupType. | eEzsigntemplateformfieldgroupType | Valid values | | ------------------------- | ------------ | | Checkbox | 22 | | Dropdown | 22-65535 | | Radio | 22 | | Text | 22-65535 | | Textarea | 22-65535 |") - i_ezsigntemplateformfield_height: conint(strict=True, ge=0) = Field(..., alias="iEzsigntemplateformfieldHeight", description="The Height of the Ezsigntemplateformfield in pixels calculated at 100 DPI The allowed values are varying based on the eEzsigntemplateformfieldgroupType. | eEzsigntemplateformfieldgroupType | Valid values | | ------------------------- | ------------ | | Checkbox | 22 | | Dropdown | 22 | | Radio | 22 | | Text | 22 | | Textarea | 22-65535 | ") - b_ezsigntemplateformfield_autocomplete: Optional[StrictBool] = Field(None, alias="bEzsigntemplateformfieldAutocomplete", description="Whether the Ezsigntemplateformfield allows the use of the autocomplete of the browser. This can only be set if eEzsigntemplateformfieldgroupType is **Text**") - b_ezsigntemplateformfield_selected: Optional[StrictBool] = Field(None, alias="bEzsigntemplateformfieldSelected", description="Whether the Ezsigntemplateformfield is selected or not by default. This can only be set if eEzsigntemplateformfieldgroupType is **Checkbox** or **Radio**") - e_ezsigntemplateformfield_dependencyrequirement: Optional[FieldEEzsigntemplateformfieldDependencyrequirement] = Field(None, alias="eEzsigntemplateformfieldDependencyrequirement") - __properties = ["pkiEzsigntemplateformfieldID", "iEzsigntemplatedocumentpagePagenumber", "sEzsigntemplateformfieldLabel", "sEzsigntemplateformfieldValue", "iEzsigntemplateformfieldX", "iEzsigntemplateformfieldY", "iEzsigntemplateformfieldWidth", "iEzsigntemplateformfieldHeight", "bEzsigntemplateformfieldAutocomplete", "bEzsigntemplateformfieldSelected", "eEzsigntemplateformfieldDependencyrequirement"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + A Ezsigntemplateformfield Object + """ # noqa: E501 + pki_ezsigntemplateformfield_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsigntemplateformfield", alias="pkiEzsigntemplateformfieldID") + i_ezsigntemplatedocumentpage_pagenumber: Annotated[int, Field(strict=True, ge=1)] = Field(description="The page number in the Ezsigntemplatedocument", alias="iEzsigntemplatedocumentpagePagenumber") + s_ezsigntemplateformfield_label: StrictStr = Field(description="The Label for the Ezsigntemplateformfield", alias="sEzsigntemplateformfieldLabel") + s_ezsigntemplateformfield_value: Optional[StrictStr] = Field(default=None, description="The value for the Ezsigntemplateformfield", alias="sEzsigntemplateformfieldValue") + i_ezsigntemplateformfield_x: Annotated[int, Field(strict=True, ge=0)] = Field(description="The X coordinate (Horizontal) where to put the Ezsigntemplateformfield on the Ezsigntemplatepage. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsigntemplateformfield 2 inches from the left border of the page, you would use \"200\" for the X coordinate.", alias="iEzsigntemplateformfieldX") + i_ezsigntemplateformfield_y: Annotated[int, Field(strict=True, ge=0)] = Field(description="The Y coordinate (Vertical) where to put the Ezsigntemplateformfield on the Ezsigntemplatepage. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsigntemplateformfield 3 inches from the top border of the page, you would use \"300\" for the Y coordinate.", alias="iEzsigntemplateformfieldY") + i_ezsigntemplateformfield_width: Annotated[int, Field(strict=True, ge=0)] = Field(description="The Width of the Ezsigntemplateformfield in pixels calculated at 100 DPI The allowed values are varying based on the eEzsigntemplateformfieldgroupType. | eEzsigntemplateformfieldgroupType | Valid values | | ------------------------- | ------------ | | Checkbox | 22 | | Dropdown | 22-65535 | | Radio | 22 | | Text | 22-65535 | | Textarea | 22-65535 |", alias="iEzsigntemplateformfieldWidth") + i_ezsigntemplateformfield_height: Annotated[int, Field(strict=True, ge=0)] = Field(description="The Height of the Ezsigntemplateformfield in pixels calculated at 100 DPI The allowed values are varying based on the eEzsigntemplateformfieldgroupType. | eEzsigntemplateformfieldgroupType | Valid values | | ------------------------- | ------------ | | Checkbox | 22 | | Dropdown | 22 | | Radio | 22 | | Text | 22 | | Textarea | 22-65535 | ", alias="iEzsigntemplateformfieldHeight") + b_ezsigntemplateformfield_autocomplete: Optional[StrictBool] = Field(default=None, description="Whether the Ezsigntemplateformfield allows the use of the autocomplete of the browser. This can only be set if eEzsigntemplateformfieldgroupType is **Text**", alias="bEzsigntemplateformfieldAutocomplete") + b_ezsigntemplateformfield_selected: Optional[StrictBool] = Field(default=None, description="Whether the Ezsigntemplateformfield is selected or not by default. This can only be set if eEzsigntemplateformfieldgroupType is **Checkbox** or **Radio**", alias="bEzsigntemplateformfieldSelected") + e_ezsigntemplateformfield_dependencyrequirement: Optional[FieldEEzsigntemplateformfieldDependencyrequirement] = Field(default=None, alias="eEzsigntemplateformfieldDependencyrequirement") + __properties: ClassVar[List[str]] = ["pkiEzsigntemplateformfieldID", "iEzsigntemplatedocumentpagePagenumber", "sEzsigntemplateformfieldLabel", "sEzsigntemplateformfieldValue", "iEzsigntemplateformfieldX", "iEzsigntemplateformfieldY", "iEzsigntemplateformfieldWidth", "iEzsigntemplateformfieldHeight", "bEzsigntemplateformfieldAutocomplete", "bEzsigntemplateformfieldSelected", "eEzsigntemplateformfieldDependencyrequirement"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplateformfieldRequest: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplateformfieldRequest from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplateformfieldRequest: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplateformfieldRequest from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplateformfieldRequest.parse_obj(obj) - - _obj = EzsigntemplateformfieldRequest.parse_obj({ - "pki_ezsigntemplateformfield_id": obj.get("pkiEzsigntemplateformfieldID"), - "i_ezsigntemplatedocumentpage_pagenumber": obj.get("iEzsigntemplatedocumentpagePagenumber"), - "s_ezsigntemplateformfield_label": obj.get("sEzsigntemplateformfieldLabel"), - "s_ezsigntemplateformfield_value": obj.get("sEzsigntemplateformfieldValue"), - "i_ezsigntemplateformfield_x": obj.get("iEzsigntemplateformfieldX"), - "i_ezsigntemplateformfield_y": obj.get("iEzsigntemplateformfieldY"), - "i_ezsigntemplateformfield_width": obj.get("iEzsigntemplateformfieldWidth"), - "i_ezsigntemplateformfield_height": obj.get("iEzsigntemplateformfieldHeight"), - "b_ezsigntemplateformfield_autocomplete": obj.get("bEzsigntemplateformfieldAutocomplete"), - "b_ezsigntemplateformfield_selected": obj.get("bEzsigntemplateformfieldSelected"), - "e_ezsigntemplateformfield_dependencyrequirement": obj.get("eEzsigntemplateformfieldDependencyrequirement") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsigntemplateformfieldID": obj.get("pkiEzsigntemplateformfieldID"), + "iEzsigntemplatedocumentpagePagenumber": obj.get("iEzsigntemplatedocumentpagePagenumber"), + "sEzsigntemplateformfieldLabel": obj.get("sEzsigntemplateformfieldLabel"), + "sEzsigntemplateformfieldValue": obj.get("sEzsigntemplateformfieldValue"), + "iEzsigntemplateformfieldX": obj.get("iEzsigntemplateformfieldX"), + "iEzsigntemplateformfieldY": obj.get("iEzsigntemplateformfieldY"), + "iEzsigntemplateformfieldWidth": obj.get("iEzsigntemplateformfieldWidth"), + "iEzsigntemplateformfieldHeight": obj.get("iEzsigntemplateformfieldHeight"), + "bEzsigntemplateformfieldAutocomplete": obj.get("bEzsigntemplateformfieldAutocomplete"), + "bEzsigntemplateformfieldSelected": obj.get("bEzsigntemplateformfieldSelected"), + "eEzsigntemplateformfieldDependencyrequirement": obj.get("eEzsigntemplateformfieldDependencyrequirement") }) return _obj diff --git a/eZmaxApi/models/ezsigntemplateformfield_request_compound.py b/eZmaxApi/models/ezsigntemplateformfield_request_compound.py index 9fdcbba04..28c344b89 100644 --- a/eZmaxApi/models/ezsigntemplateformfield_request_compound.py +++ b/eZmaxApi/models/ezsigntemplateformfield_request_compound.py @@ -19,53 +19,72 @@ import json -from typing import List, Optional -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint, conlist +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, StrictStr +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.ezsigntemplateelementdependency_request_compound import EzsigntemplateelementdependencyRequestCompound from eZmaxApi.models.field_e_ezsigntemplateformfield_dependencyrequirement import FieldEEzsigntemplateformfieldDependencyrequirement +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplateformfieldRequestCompound(BaseModel): """ - An Ezsigntemplateformfield Object and children to create a complete structure # noqa: E501 - """ - pki_ezsigntemplateformfield_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="pkiEzsigntemplateformfieldID", description="The unique ID of the Ezsigntemplateformfield") - i_ezsigntemplatedocumentpage_pagenumber: conint(strict=True, ge=1) = Field(..., alias="iEzsigntemplatedocumentpagePagenumber", description="The page number in the Ezsigntemplatedocument") - s_ezsigntemplateformfield_label: StrictStr = Field(..., alias="sEzsigntemplateformfieldLabel", description="The Label for the Ezsigntemplateformfield") - s_ezsigntemplateformfield_value: Optional[StrictStr] = Field(None, alias="sEzsigntemplateformfieldValue", description="The value for the Ezsigntemplateformfield") - i_ezsigntemplateformfield_x: conint(strict=True, ge=0) = Field(..., alias="iEzsigntemplateformfieldX", description="The X coordinate (Horizontal) where to put the Ezsigntemplateformfield on the Ezsigntemplatepage. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsigntemplateformfield 2 inches from the left border of the page, you would use \"200\" for the X coordinate.") - i_ezsigntemplateformfield_y: conint(strict=True, ge=0) = Field(..., alias="iEzsigntemplateformfieldY", description="The Y coordinate (Vertical) where to put the Ezsigntemplateformfield on the Ezsigntemplatepage. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsigntemplateformfield 3 inches from the top border of the page, you would use \"300\" for the Y coordinate.") - i_ezsigntemplateformfield_width: conint(strict=True, ge=0) = Field(..., alias="iEzsigntemplateformfieldWidth", description="The Width of the Ezsigntemplateformfield in pixels calculated at 100 DPI The allowed values are varying based on the eEzsigntemplateformfieldgroupType. | eEzsigntemplateformfieldgroupType | Valid values | | ------------------------- | ------------ | | Checkbox | 22 | | Dropdown | 22-65535 | | Radio | 22 | | Text | 22-65535 | | Textarea | 22-65535 |") - i_ezsigntemplateformfield_height: conint(strict=True, ge=0) = Field(..., alias="iEzsigntemplateformfieldHeight", description="The Height of the Ezsigntemplateformfield in pixels calculated at 100 DPI The allowed values are varying based on the eEzsigntemplateformfieldgroupType. | eEzsigntemplateformfieldgroupType | Valid values | | ------------------------- | ------------ | | Checkbox | 22 | | Dropdown | 22 | | Radio | 22 | | Text | 22 | | Textarea | 22-65535 | ") - b_ezsigntemplateformfield_autocomplete: Optional[StrictBool] = Field(None, alias="bEzsigntemplateformfieldAutocomplete", description="Whether the Ezsigntemplateformfield allows the use of the autocomplete of the browser. This can only be set if eEzsigntemplateformfieldgroupType is **Text**") - b_ezsigntemplateformfield_selected: Optional[StrictBool] = Field(None, alias="bEzsigntemplateformfieldSelected", description="Whether the Ezsigntemplateformfield is selected or not by default. This can only be set if eEzsigntemplateformfieldgroupType is **Checkbox** or **Radio**") - e_ezsigntemplateformfield_dependencyrequirement: Optional[FieldEEzsigntemplateformfieldDependencyrequirement] = Field(None, alias="eEzsigntemplateformfieldDependencyrequirement") - a_obj_ezsigntemplateelementdependency: Optional[conlist(EzsigntemplateelementdependencyRequestCompound)] = Field(None, alias="a_objEzsigntemplateelementdependency") - __properties = ["pkiEzsigntemplateformfieldID", "iEzsigntemplatedocumentpagePagenumber", "sEzsigntemplateformfieldLabel", "sEzsigntemplateformfieldValue", "iEzsigntemplateformfieldX", "iEzsigntemplateformfieldY", "iEzsigntemplateformfieldWidth", "iEzsigntemplateformfieldHeight", "bEzsigntemplateformfieldAutocomplete", "bEzsigntemplateformfieldSelected", "eEzsigntemplateformfieldDependencyrequirement", "a_objEzsigntemplateelementdependency"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + An Ezsigntemplateformfield Object and children to create a complete structure + """ # noqa: E501 + pki_ezsigntemplateformfield_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsigntemplateformfield", alias="pkiEzsigntemplateformfieldID") + i_ezsigntemplatedocumentpage_pagenumber: Annotated[int, Field(strict=True, ge=1)] = Field(description="The page number in the Ezsigntemplatedocument", alias="iEzsigntemplatedocumentpagePagenumber") + s_ezsigntemplateformfield_label: StrictStr = Field(description="The Label for the Ezsigntemplateformfield", alias="sEzsigntemplateformfieldLabel") + s_ezsigntemplateformfield_value: Optional[StrictStr] = Field(default=None, description="The value for the Ezsigntemplateformfield", alias="sEzsigntemplateformfieldValue") + i_ezsigntemplateformfield_x: Annotated[int, Field(strict=True, ge=0)] = Field(description="The X coordinate (Horizontal) where to put the Ezsigntemplateformfield on the Ezsigntemplatepage. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsigntemplateformfield 2 inches from the left border of the page, you would use \"200\" for the X coordinate.", alias="iEzsigntemplateformfieldX") + i_ezsigntemplateformfield_y: Annotated[int, Field(strict=True, ge=0)] = Field(description="The Y coordinate (Vertical) where to put the Ezsigntemplateformfield on the Ezsigntemplatepage. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsigntemplateformfield 3 inches from the top border of the page, you would use \"300\" for the Y coordinate.", alias="iEzsigntemplateformfieldY") + i_ezsigntemplateformfield_width: Annotated[int, Field(strict=True, ge=0)] = Field(description="The Width of the Ezsigntemplateformfield in pixels calculated at 100 DPI The allowed values are varying based on the eEzsigntemplateformfieldgroupType. | eEzsigntemplateformfieldgroupType | Valid values | | ------------------------- | ------------ | | Checkbox | 22 | | Dropdown | 22-65535 | | Radio | 22 | | Text | 22-65535 | | Textarea | 22-65535 |", alias="iEzsigntemplateformfieldWidth") + i_ezsigntemplateformfield_height: Annotated[int, Field(strict=True, ge=0)] = Field(description="The Height of the Ezsigntemplateformfield in pixels calculated at 100 DPI The allowed values are varying based on the eEzsigntemplateformfieldgroupType. | eEzsigntemplateformfieldgroupType | Valid values | | ------------------------- | ------------ | | Checkbox | 22 | | Dropdown | 22 | | Radio | 22 | | Text | 22 | | Textarea | 22-65535 | ", alias="iEzsigntemplateformfieldHeight") + b_ezsigntemplateformfield_autocomplete: Optional[StrictBool] = Field(default=None, description="Whether the Ezsigntemplateformfield allows the use of the autocomplete of the browser. This can only be set if eEzsigntemplateformfieldgroupType is **Text**", alias="bEzsigntemplateformfieldAutocomplete") + b_ezsigntemplateformfield_selected: Optional[StrictBool] = Field(default=None, description="Whether the Ezsigntemplateformfield is selected or not by default. This can only be set if eEzsigntemplateformfieldgroupType is **Checkbox** or **Radio**", alias="bEzsigntemplateformfieldSelected") + e_ezsigntemplateformfield_dependencyrequirement: Optional[FieldEEzsigntemplateformfieldDependencyrequirement] = Field(default=None, alias="eEzsigntemplateformfieldDependencyrequirement") + a_obj_ezsigntemplateelementdependency: Optional[List[EzsigntemplateelementdependencyRequestCompound]] = Field(default=None, alias="a_objEzsigntemplateelementdependency") + __properties: ClassVar[List[str]] = ["pkiEzsigntemplateformfieldID", "iEzsigntemplatedocumentpagePagenumber", "sEzsigntemplateformfieldLabel", "sEzsigntemplateformfieldValue", "iEzsigntemplateformfieldX", "iEzsigntemplateformfieldY", "iEzsigntemplateformfieldWidth", "iEzsigntemplateformfieldHeight", "bEzsigntemplateformfieldAutocomplete", "bEzsigntemplateformfieldSelected", "eEzsigntemplateformfieldDependencyrequirement", "a_objEzsigntemplateelementdependency"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplateformfieldRequestCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplateformfieldRequestCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_ezsigntemplateelementdependency (list) _items = [] if self.a_obj_ezsigntemplateelementdependency: @@ -76,27 +95,27 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplateformfieldRequestCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplateformfieldRequestCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplateformfieldRequestCompound.parse_obj(obj) - - _obj = EzsigntemplateformfieldRequestCompound.parse_obj({ - "pki_ezsigntemplateformfield_id": obj.get("pkiEzsigntemplateformfieldID"), - "i_ezsigntemplatedocumentpage_pagenumber": obj.get("iEzsigntemplatedocumentpagePagenumber"), - "s_ezsigntemplateformfield_label": obj.get("sEzsigntemplateformfieldLabel"), - "s_ezsigntemplateformfield_value": obj.get("sEzsigntemplateformfieldValue"), - "i_ezsigntemplateformfield_x": obj.get("iEzsigntemplateformfieldX"), - "i_ezsigntemplateformfield_y": obj.get("iEzsigntemplateformfieldY"), - "i_ezsigntemplateformfield_width": obj.get("iEzsigntemplateformfieldWidth"), - "i_ezsigntemplateformfield_height": obj.get("iEzsigntemplateformfieldHeight"), - "b_ezsigntemplateformfield_autocomplete": obj.get("bEzsigntemplateformfieldAutocomplete"), - "b_ezsigntemplateformfield_selected": obj.get("bEzsigntemplateformfieldSelected"), - "e_ezsigntemplateformfield_dependencyrequirement": obj.get("eEzsigntemplateformfieldDependencyrequirement"), - "a_obj_ezsigntemplateelementdependency": [EzsigntemplateelementdependencyRequestCompound.from_dict(_item) for _item in obj.get("a_objEzsigntemplateelementdependency")] if obj.get("a_objEzsigntemplateelementdependency") is not None else None + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsigntemplateformfieldID": obj.get("pkiEzsigntemplateformfieldID"), + "iEzsigntemplatedocumentpagePagenumber": obj.get("iEzsigntemplatedocumentpagePagenumber"), + "sEzsigntemplateformfieldLabel": obj.get("sEzsigntemplateformfieldLabel"), + "sEzsigntemplateformfieldValue": obj.get("sEzsigntemplateformfieldValue"), + "iEzsigntemplateformfieldX": obj.get("iEzsigntemplateformfieldX"), + "iEzsigntemplateformfieldY": obj.get("iEzsigntemplateformfieldY"), + "iEzsigntemplateformfieldWidth": obj.get("iEzsigntemplateformfieldWidth"), + "iEzsigntemplateformfieldHeight": obj.get("iEzsigntemplateformfieldHeight"), + "bEzsigntemplateformfieldAutocomplete": obj.get("bEzsigntemplateformfieldAutocomplete"), + "bEzsigntemplateformfieldSelected": obj.get("bEzsigntemplateformfieldSelected"), + "eEzsigntemplateformfieldDependencyrequirement": obj.get("eEzsigntemplateformfieldDependencyrequirement"), + "a_objEzsigntemplateelementdependency": [EzsigntemplateelementdependencyRequestCompound.from_dict(_item) for _item in obj.get("a_objEzsigntemplateelementdependency")] if obj.get("a_objEzsigntemplateelementdependency") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigntemplateformfield_response.py b/eZmaxApi/models/ezsigntemplateformfield_response.py index c89bdeca5..4f51a04d7 100644 --- a/eZmaxApi/models/ezsigntemplateformfield_response.py +++ b/eZmaxApi/models/ezsigntemplateformfield_response.py @@ -19,74 +19,93 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, StrictStr +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.field_e_ezsigntemplateformfield_dependencyrequirement import FieldEEzsigntemplateformfieldDependencyrequirement +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplateformfieldResponse(BaseModel): """ - An Ezsigntemplateformfield Object # noqa: E501 - """ - pki_ezsigntemplateformfield_id: conint(strict=True, ge=0) = Field(..., alias="pkiEzsigntemplateformfieldID", description="The unique ID of the Ezsigntemplateformfield") - i_ezsigntemplatedocumentpage_pagenumber: conint(strict=True, ge=1) = Field(..., alias="iEzsigntemplatedocumentpagePagenumber", description="The page number in the Ezsigntemplatedocument") - s_ezsigntemplateformfield_label: StrictStr = Field(..., alias="sEzsigntemplateformfieldLabel", description="The Label for the Ezsigntemplateformfield") - s_ezsigntemplateformfield_value: Optional[StrictStr] = Field(None, alias="sEzsigntemplateformfieldValue", description="The value for the Ezsigntemplateformfield") - i_ezsigntemplateformfield_x: conint(strict=True, ge=0) = Field(..., alias="iEzsigntemplateformfieldX", description="The X coordinate (Horizontal) where to put the Ezsigntemplateformfield on the Ezsigntemplatepage. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsigntemplateformfield 2 inches from the left border of the page, you would use \"200\" for the X coordinate.") - i_ezsigntemplateformfield_y: conint(strict=True, ge=0) = Field(..., alias="iEzsigntemplateformfieldY", description="The Y coordinate (Vertical) where to put the Ezsigntemplateformfield on the Ezsigntemplatepage. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsigntemplateformfield 3 inches from the top border of the page, you would use \"300\" for the Y coordinate.") - i_ezsigntemplateformfield_width: conint(strict=True, ge=0) = Field(..., alias="iEzsigntemplateformfieldWidth", description="The Width of the Ezsigntemplateformfield in pixels calculated at 100 DPI The allowed values are varying based on the eEzsigntemplateformfieldgroupType. | eEzsigntemplateformfieldgroupType | Valid values | | ------------------------- | ------------ | | Checkbox | 22 | | Dropdown | 22-65535 | | Radio | 22 | | Text | 22-65535 | | Textarea | 22-65535 |") - i_ezsigntemplateformfield_height: conint(strict=True, ge=0) = Field(..., alias="iEzsigntemplateformfieldHeight", description="The Height of the Ezsigntemplateformfield in pixels calculated at 100 DPI The allowed values are varying based on the eEzsigntemplateformfieldgroupType. | eEzsigntemplateformfieldgroupType | Valid values | | ------------------------- | ------------ | | Checkbox | 22 | | Dropdown | 22 | | Radio | 22 | | Text | 22 | | Textarea | 22-65535 | ") - b_ezsigntemplateformfield_autocomplete: Optional[StrictBool] = Field(None, alias="bEzsigntemplateformfieldAutocomplete", description="Whether the Ezsigntemplateformfield allows the use of the autocomplete of the browser. This can only be set if eEzsigntemplateformfieldgroupType is **Text**") - b_ezsigntemplateformfield_selected: Optional[StrictBool] = Field(None, alias="bEzsigntemplateformfieldSelected", description="Whether the Ezsigntemplateformfield is selected or not by default. This can only be set if eEzsigntemplateformfieldgroupType is **Checkbox** or **Radio**") - e_ezsigntemplateformfield_dependencyrequirement: Optional[FieldEEzsigntemplateformfieldDependencyrequirement] = Field(None, alias="eEzsigntemplateformfieldDependencyrequirement") - __properties = ["pkiEzsigntemplateformfieldID", "iEzsigntemplatedocumentpagePagenumber", "sEzsigntemplateformfieldLabel", "sEzsigntemplateformfieldValue", "iEzsigntemplateformfieldX", "iEzsigntemplateformfieldY", "iEzsigntemplateformfieldWidth", "iEzsigntemplateformfieldHeight", "bEzsigntemplateformfieldAutocomplete", "bEzsigntemplateformfieldSelected", "eEzsigntemplateformfieldDependencyrequirement"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + An Ezsigntemplateformfield Object + """ # noqa: E501 + pki_ezsigntemplateformfield_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsigntemplateformfield", alias="pkiEzsigntemplateformfieldID") + i_ezsigntemplatedocumentpage_pagenumber: Annotated[int, Field(strict=True, ge=1)] = Field(description="The page number in the Ezsigntemplatedocument", alias="iEzsigntemplatedocumentpagePagenumber") + s_ezsigntemplateformfield_label: StrictStr = Field(description="The Label for the Ezsigntemplateformfield", alias="sEzsigntemplateformfieldLabel") + s_ezsigntemplateformfield_value: Optional[StrictStr] = Field(default=None, description="The value for the Ezsigntemplateformfield", alias="sEzsigntemplateformfieldValue") + i_ezsigntemplateformfield_x: Annotated[int, Field(strict=True, ge=0)] = Field(description="The X coordinate (Horizontal) where to put the Ezsigntemplateformfield on the Ezsigntemplatepage. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsigntemplateformfield 2 inches from the left border of the page, you would use \"200\" for the X coordinate.", alias="iEzsigntemplateformfieldX") + i_ezsigntemplateformfield_y: Annotated[int, Field(strict=True, ge=0)] = Field(description="The Y coordinate (Vertical) where to put the Ezsigntemplateformfield on the Ezsigntemplatepage. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsigntemplateformfield 3 inches from the top border of the page, you would use \"300\" for the Y coordinate.", alias="iEzsigntemplateformfieldY") + i_ezsigntemplateformfield_width: Annotated[int, Field(strict=True, ge=0)] = Field(description="The Width of the Ezsigntemplateformfield in pixels calculated at 100 DPI The allowed values are varying based on the eEzsigntemplateformfieldgroupType. | eEzsigntemplateformfieldgroupType | Valid values | | ------------------------- | ------------ | | Checkbox | 22 | | Dropdown | 22-65535 | | Radio | 22 | | Text | 22-65535 | | Textarea | 22-65535 |", alias="iEzsigntemplateformfieldWidth") + i_ezsigntemplateformfield_height: Annotated[int, Field(strict=True, ge=0)] = Field(description="The Height of the Ezsigntemplateformfield in pixels calculated at 100 DPI The allowed values are varying based on the eEzsigntemplateformfieldgroupType. | eEzsigntemplateformfieldgroupType | Valid values | | ------------------------- | ------------ | | Checkbox | 22 | | Dropdown | 22 | | Radio | 22 | | Text | 22 | | Textarea | 22-65535 | ", alias="iEzsigntemplateformfieldHeight") + b_ezsigntemplateformfield_autocomplete: Optional[StrictBool] = Field(default=None, description="Whether the Ezsigntemplateformfield allows the use of the autocomplete of the browser. This can only be set if eEzsigntemplateformfieldgroupType is **Text**", alias="bEzsigntemplateformfieldAutocomplete") + b_ezsigntemplateformfield_selected: Optional[StrictBool] = Field(default=None, description="Whether the Ezsigntemplateformfield is selected or not by default. This can only be set if eEzsigntemplateformfieldgroupType is **Checkbox** or **Radio**", alias="bEzsigntemplateformfieldSelected") + e_ezsigntemplateformfield_dependencyrequirement: Optional[FieldEEzsigntemplateformfieldDependencyrequirement] = Field(default=None, alias="eEzsigntemplateformfieldDependencyrequirement") + __properties: ClassVar[List[str]] = ["pkiEzsigntemplateformfieldID", "iEzsigntemplatedocumentpagePagenumber", "sEzsigntemplateformfieldLabel", "sEzsigntemplateformfieldValue", "iEzsigntemplateformfieldX", "iEzsigntemplateformfieldY", "iEzsigntemplateformfieldWidth", "iEzsigntemplateformfieldHeight", "bEzsigntemplateformfieldAutocomplete", "bEzsigntemplateformfieldSelected", "eEzsigntemplateformfieldDependencyrequirement"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplateformfieldResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplateformfieldResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplateformfieldResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplateformfieldResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplateformfieldResponse.parse_obj(obj) - - _obj = EzsigntemplateformfieldResponse.parse_obj({ - "pki_ezsigntemplateformfield_id": obj.get("pkiEzsigntemplateformfieldID"), - "i_ezsigntemplatedocumentpage_pagenumber": obj.get("iEzsigntemplatedocumentpagePagenumber"), - "s_ezsigntemplateformfield_label": obj.get("sEzsigntemplateformfieldLabel"), - "s_ezsigntemplateformfield_value": obj.get("sEzsigntemplateformfieldValue"), - "i_ezsigntemplateformfield_x": obj.get("iEzsigntemplateformfieldX"), - "i_ezsigntemplateformfield_y": obj.get("iEzsigntemplateformfieldY"), - "i_ezsigntemplateformfield_width": obj.get("iEzsigntemplateformfieldWidth"), - "i_ezsigntemplateformfield_height": obj.get("iEzsigntemplateformfieldHeight"), - "b_ezsigntemplateformfield_autocomplete": obj.get("bEzsigntemplateformfieldAutocomplete"), - "b_ezsigntemplateformfield_selected": obj.get("bEzsigntemplateformfieldSelected"), - "e_ezsigntemplateformfield_dependencyrequirement": obj.get("eEzsigntemplateformfieldDependencyrequirement") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsigntemplateformfieldID": obj.get("pkiEzsigntemplateformfieldID"), + "iEzsigntemplatedocumentpagePagenumber": obj.get("iEzsigntemplatedocumentpagePagenumber"), + "sEzsigntemplateformfieldLabel": obj.get("sEzsigntemplateformfieldLabel"), + "sEzsigntemplateformfieldValue": obj.get("sEzsigntemplateformfieldValue"), + "iEzsigntemplateformfieldX": obj.get("iEzsigntemplateformfieldX"), + "iEzsigntemplateformfieldY": obj.get("iEzsigntemplateformfieldY"), + "iEzsigntemplateformfieldWidth": obj.get("iEzsigntemplateformfieldWidth"), + "iEzsigntemplateformfieldHeight": obj.get("iEzsigntemplateformfieldHeight"), + "bEzsigntemplateformfieldAutocomplete": obj.get("bEzsigntemplateformfieldAutocomplete"), + "bEzsigntemplateformfieldSelected": obj.get("bEzsigntemplateformfieldSelected"), + "eEzsigntemplateformfieldDependencyrequirement": obj.get("eEzsigntemplateformfieldDependencyrequirement") }) return _obj diff --git a/eZmaxApi/models/ezsigntemplateformfield_response_compound.py b/eZmaxApi/models/ezsigntemplateformfield_response_compound.py index 1a16201a9..29e0041b3 100644 --- a/eZmaxApi/models/ezsigntemplateformfield_response_compound.py +++ b/eZmaxApi/models/ezsigntemplateformfield_response_compound.py @@ -19,53 +19,72 @@ import json -from typing import List, Optional -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint, conlist +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, StrictStr +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.ezsigntemplateelementdependency_response_compound import EzsigntemplateelementdependencyResponseCompound from eZmaxApi.models.field_e_ezsigntemplateformfield_dependencyrequirement import FieldEEzsigntemplateformfieldDependencyrequirement +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplateformfieldResponseCompound(BaseModel): """ - An Ezsigntemplateformfield Object and children # noqa: E501 - """ - pki_ezsigntemplateformfield_id: conint(strict=True, ge=0) = Field(..., alias="pkiEzsigntemplateformfieldID", description="The unique ID of the Ezsigntemplateformfield") - i_ezsigntemplatedocumentpage_pagenumber: conint(strict=True, ge=1) = Field(..., alias="iEzsigntemplatedocumentpagePagenumber", description="The page number in the Ezsigntemplatedocument") - s_ezsigntemplateformfield_label: StrictStr = Field(..., alias="sEzsigntemplateformfieldLabel", description="The Label for the Ezsigntemplateformfield") - s_ezsigntemplateformfield_value: Optional[StrictStr] = Field(None, alias="sEzsigntemplateformfieldValue", description="The value for the Ezsigntemplateformfield") - i_ezsigntemplateformfield_x: conint(strict=True, ge=0) = Field(..., alias="iEzsigntemplateformfieldX", description="The X coordinate (Horizontal) where to put the Ezsigntemplateformfield on the Ezsigntemplatepage. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsigntemplateformfield 2 inches from the left border of the page, you would use \"200\" for the X coordinate.") - i_ezsigntemplateformfield_y: conint(strict=True, ge=0) = Field(..., alias="iEzsigntemplateformfieldY", description="The Y coordinate (Vertical) where to put the Ezsigntemplateformfield on the Ezsigntemplatepage. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsigntemplateformfield 3 inches from the top border of the page, you would use \"300\" for the Y coordinate.") - i_ezsigntemplateformfield_width: conint(strict=True, ge=0) = Field(..., alias="iEzsigntemplateformfieldWidth", description="The Width of the Ezsigntemplateformfield in pixels calculated at 100 DPI The allowed values are varying based on the eEzsigntemplateformfieldgroupType. | eEzsigntemplateformfieldgroupType | Valid values | | ------------------------- | ------------ | | Checkbox | 22 | | Dropdown | 22-65535 | | Radio | 22 | | Text | 22-65535 | | Textarea | 22-65535 |") - i_ezsigntemplateformfield_height: conint(strict=True, ge=0) = Field(..., alias="iEzsigntemplateformfieldHeight", description="The Height of the Ezsigntemplateformfield in pixels calculated at 100 DPI The allowed values are varying based on the eEzsigntemplateformfieldgroupType. | eEzsigntemplateformfieldgroupType | Valid values | | ------------------------- | ------------ | | Checkbox | 22 | | Dropdown | 22 | | Radio | 22 | | Text | 22 | | Textarea | 22-65535 | ") - b_ezsigntemplateformfield_autocomplete: Optional[StrictBool] = Field(None, alias="bEzsigntemplateformfieldAutocomplete", description="Whether the Ezsigntemplateformfield allows the use of the autocomplete of the browser. This can only be set if eEzsigntemplateformfieldgroupType is **Text**") - b_ezsigntemplateformfield_selected: Optional[StrictBool] = Field(None, alias="bEzsigntemplateformfieldSelected", description="Whether the Ezsigntemplateformfield is selected or not by default. This can only be set if eEzsigntemplateformfieldgroupType is **Checkbox** or **Radio**") - e_ezsigntemplateformfield_dependencyrequirement: Optional[FieldEEzsigntemplateformfieldDependencyrequirement] = Field(None, alias="eEzsigntemplateformfieldDependencyrequirement") - a_obj_ezsigntemplateelementdependency: Optional[conlist(EzsigntemplateelementdependencyResponseCompound)] = Field(None, alias="a_objEzsigntemplateelementdependency") - __properties = ["pkiEzsigntemplateformfieldID", "iEzsigntemplatedocumentpagePagenumber", "sEzsigntemplateformfieldLabel", "sEzsigntemplateformfieldValue", "iEzsigntemplateformfieldX", "iEzsigntemplateformfieldY", "iEzsigntemplateformfieldWidth", "iEzsigntemplateformfieldHeight", "bEzsigntemplateformfieldAutocomplete", "bEzsigntemplateformfieldSelected", "eEzsigntemplateformfieldDependencyrequirement", "a_objEzsigntemplateelementdependency"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + An Ezsigntemplateformfield Object and children + """ # noqa: E501 + pki_ezsigntemplateformfield_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsigntemplateformfield", alias="pkiEzsigntemplateformfieldID") + i_ezsigntemplatedocumentpage_pagenumber: Annotated[int, Field(strict=True, ge=1)] = Field(description="The page number in the Ezsigntemplatedocument", alias="iEzsigntemplatedocumentpagePagenumber") + s_ezsigntemplateformfield_label: StrictStr = Field(description="The Label for the Ezsigntemplateformfield", alias="sEzsigntemplateformfieldLabel") + s_ezsigntemplateformfield_value: Optional[StrictStr] = Field(default=None, description="The value for the Ezsigntemplateformfield", alias="sEzsigntemplateformfieldValue") + i_ezsigntemplateformfield_x: Annotated[int, Field(strict=True, ge=0)] = Field(description="The X coordinate (Horizontal) where to put the Ezsigntemplateformfield on the Ezsigntemplatepage. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsigntemplateformfield 2 inches from the left border of the page, you would use \"200\" for the X coordinate.", alias="iEzsigntemplateformfieldX") + i_ezsigntemplateformfield_y: Annotated[int, Field(strict=True, ge=0)] = Field(description="The Y coordinate (Vertical) where to put the Ezsigntemplateformfield on the Ezsigntemplatepage. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsigntemplateformfield 3 inches from the top border of the page, you would use \"300\" for the Y coordinate.", alias="iEzsigntemplateformfieldY") + i_ezsigntemplateformfield_width: Annotated[int, Field(strict=True, ge=0)] = Field(description="The Width of the Ezsigntemplateformfield in pixels calculated at 100 DPI The allowed values are varying based on the eEzsigntemplateformfieldgroupType. | eEzsigntemplateformfieldgroupType | Valid values | | ------------------------- | ------------ | | Checkbox | 22 | | Dropdown | 22-65535 | | Radio | 22 | | Text | 22-65535 | | Textarea | 22-65535 |", alias="iEzsigntemplateformfieldWidth") + i_ezsigntemplateformfield_height: Annotated[int, Field(strict=True, ge=0)] = Field(description="The Height of the Ezsigntemplateformfield in pixels calculated at 100 DPI The allowed values are varying based on the eEzsigntemplateformfieldgroupType. | eEzsigntemplateformfieldgroupType | Valid values | | ------------------------- | ------------ | | Checkbox | 22 | | Dropdown | 22 | | Radio | 22 | | Text | 22 | | Textarea | 22-65535 | ", alias="iEzsigntemplateformfieldHeight") + b_ezsigntemplateformfield_autocomplete: Optional[StrictBool] = Field(default=None, description="Whether the Ezsigntemplateformfield allows the use of the autocomplete of the browser. This can only be set if eEzsigntemplateformfieldgroupType is **Text**", alias="bEzsigntemplateformfieldAutocomplete") + b_ezsigntemplateformfield_selected: Optional[StrictBool] = Field(default=None, description="Whether the Ezsigntemplateformfield is selected or not by default. This can only be set if eEzsigntemplateformfieldgroupType is **Checkbox** or **Radio**", alias="bEzsigntemplateformfieldSelected") + e_ezsigntemplateformfield_dependencyrequirement: Optional[FieldEEzsigntemplateformfieldDependencyrequirement] = Field(default=None, alias="eEzsigntemplateformfieldDependencyrequirement") + a_obj_ezsigntemplateelementdependency: Optional[List[EzsigntemplateelementdependencyResponseCompound]] = Field(default=None, alias="a_objEzsigntemplateelementdependency") + __properties: ClassVar[List[str]] = ["pkiEzsigntemplateformfieldID", "iEzsigntemplatedocumentpagePagenumber", "sEzsigntemplateformfieldLabel", "sEzsigntemplateformfieldValue", "iEzsigntemplateformfieldX", "iEzsigntemplateformfieldY", "iEzsigntemplateformfieldWidth", "iEzsigntemplateformfieldHeight", "bEzsigntemplateformfieldAutocomplete", "bEzsigntemplateformfieldSelected", "eEzsigntemplateformfieldDependencyrequirement", "a_objEzsigntemplateelementdependency"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplateformfieldResponseCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplateformfieldResponseCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_ezsigntemplateelementdependency (list) _items = [] if self.a_obj_ezsigntemplateelementdependency: @@ -76,27 +95,27 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplateformfieldResponseCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplateformfieldResponseCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplateformfieldResponseCompound.parse_obj(obj) - - _obj = EzsigntemplateformfieldResponseCompound.parse_obj({ - "pki_ezsigntemplateformfield_id": obj.get("pkiEzsigntemplateformfieldID"), - "i_ezsigntemplatedocumentpage_pagenumber": obj.get("iEzsigntemplatedocumentpagePagenumber"), - "s_ezsigntemplateformfield_label": obj.get("sEzsigntemplateformfieldLabel"), - "s_ezsigntemplateformfield_value": obj.get("sEzsigntemplateformfieldValue"), - "i_ezsigntemplateformfield_x": obj.get("iEzsigntemplateformfieldX"), - "i_ezsigntemplateformfield_y": obj.get("iEzsigntemplateformfieldY"), - "i_ezsigntemplateformfield_width": obj.get("iEzsigntemplateformfieldWidth"), - "i_ezsigntemplateformfield_height": obj.get("iEzsigntemplateformfieldHeight"), - "b_ezsigntemplateformfield_autocomplete": obj.get("bEzsigntemplateformfieldAutocomplete"), - "b_ezsigntemplateformfield_selected": obj.get("bEzsigntemplateformfieldSelected"), - "e_ezsigntemplateformfield_dependencyrequirement": obj.get("eEzsigntemplateformfieldDependencyrequirement"), - "a_obj_ezsigntemplateelementdependency": [EzsigntemplateelementdependencyResponseCompound.from_dict(_item) for _item in obj.get("a_objEzsigntemplateelementdependency")] if obj.get("a_objEzsigntemplateelementdependency") is not None else None + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsigntemplateformfieldID": obj.get("pkiEzsigntemplateformfieldID"), + "iEzsigntemplatedocumentpagePagenumber": obj.get("iEzsigntemplatedocumentpagePagenumber"), + "sEzsigntemplateformfieldLabel": obj.get("sEzsigntemplateformfieldLabel"), + "sEzsigntemplateformfieldValue": obj.get("sEzsigntemplateformfieldValue"), + "iEzsigntemplateformfieldX": obj.get("iEzsigntemplateformfieldX"), + "iEzsigntemplateformfieldY": obj.get("iEzsigntemplateformfieldY"), + "iEzsigntemplateformfieldWidth": obj.get("iEzsigntemplateformfieldWidth"), + "iEzsigntemplateformfieldHeight": obj.get("iEzsigntemplateformfieldHeight"), + "bEzsigntemplateformfieldAutocomplete": obj.get("bEzsigntemplateformfieldAutocomplete"), + "bEzsigntemplateformfieldSelected": obj.get("bEzsigntemplateformfieldSelected"), + "eEzsigntemplateformfieldDependencyrequirement": obj.get("eEzsigntemplateformfieldDependencyrequirement"), + "a_objEzsigntemplateelementdependency": [EzsigntemplateelementdependencyResponseCompound.from_dict(_item) for _item in obj.get("a_objEzsigntemplateelementdependency")] if obj.get("a_objEzsigntemplateelementdependency") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigntemplateformfieldgroup_create_object_v1_request.py b/eZmaxApi/models/ezsigntemplateformfieldgroup_create_object_v1_request.py index c4ba4e9a1..37ade0d64 100644 --- a/eZmaxApi/models/ezsigntemplateformfieldgroup_create_object_v1_request.py +++ b/eZmaxApi/models/ezsigntemplateformfieldgroup_create_object_v1_request.py @@ -19,41 +19,60 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.ezsigntemplateformfieldgroup_request_compound import EzsigntemplateformfieldgroupRequestCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplateformfieldgroupCreateObjectV1Request(BaseModel): """ - Request for POST /1/object/ezsigntemplateformfieldgroup # noqa: E501 - """ - a_obj_ezsigntemplateformfieldgroup: conlist(EzsigntemplateformfieldgroupRequestCompound, min_items=1) = Field(..., alias="a_objEzsigntemplateformfieldgroup") - __properties = ["a_objEzsigntemplateformfieldgroup"] + Request for POST /1/object/ezsigntemplateformfieldgroup + """ # noqa: E501 + a_obj_ezsigntemplateformfieldgroup: Annotated[List[EzsigntemplateformfieldgroupRequestCompound], Field(min_length=1)] = Field(alias="a_objEzsigntemplateformfieldgroup") + __properties: ClassVar[List[str]] = ["a_objEzsigntemplateformfieldgroup"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplateformfieldgroupCreateObjectV1Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplateformfieldgroupCreateObjectV1Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_ezsigntemplateformfieldgroup (list) _items = [] if self.a_obj_ezsigntemplateformfieldgroup: @@ -64,16 +83,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplateformfieldgroupCreateObjectV1Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplateformfieldgroupCreateObjectV1Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplateformfieldgroupCreateObjectV1Request.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplateformfieldgroupCreateObjectV1Request.parse_obj({ - "a_obj_ezsigntemplateformfieldgroup": [EzsigntemplateformfieldgroupRequestCompound.from_dict(_item) for _item in obj.get("a_objEzsigntemplateformfieldgroup")] if obj.get("a_objEzsigntemplateformfieldgroup") is not None else None + _obj = cls.model_validate({ + "a_objEzsigntemplateformfieldgroup": [EzsigntemplateformfieldgroupRequestCompound.from_dict(_item) for _item in obj.get("a_objEzsigntemplateformfieldgroup")] if obj.get("a_objEzsigntemplateformfieldgroup") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigntemplateformfieldgroup_create_object_v1_response.py b/eZmaxApi/models/ezsigntemplateformfieldgroup_create_object_v1_response.py index 705ba5f4c..1ffdc11f6 100644 --- a/eZmaxApi/models/ezsigntemplateformfieldgroup_create_object_v1_response.py +++ b/eZmaxApi/models/ezsigntemplateformfieldgroup_create_object_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.ezsigntemplateformfieldgroup_create_object_v1_response_m_payload import EzsigntemplateformfieldgroupCreateObjectV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplateformfieldgroupCreateObjectV1Response(BaseModel): """ - Response for POST /1/object/ezsigntemplateformfieldgroup # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzsigntemplateformfieldgroupCreateObjectV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for POST /1/object/ezsigntemplateformfieldgroup + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsigntemplateformfieldgroupCreateObjectV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplateformfieldgroupCreateObjectV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplateformfieldgroupCreateObjectV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplateformfieldgroupCreateObjectV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplateformfieldgroupCreateObjectV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplateformfieldgroupCreateObjectV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplateformfieldgroupCreateObjectV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzsigntemplateformfieldgroupCreateObjectV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsigntemplateformfieldgroupCreateObjectV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigntemplateformfieldgroup_create_object_v1_response_m_payload.py b/eZmaxApi/models/ezsigntemplateformfieldgroup_create_object_v1_response_m_payload.py index 2963d817e..d82b99699 100644 --- a/eZmaxApi/models/ezsigntemplateformfieldgroup_create_object_v1_response_m_payload.py +++ b/eZmaxApi/models/ezsigntemplateformfieldgroup_create_object_v1_response_m_payload.py @@ -19,53 +19,72 @@ import json -from typing import List -from pydantic import BaseModel, Field, conint, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplateformfieldgroupCreateObjectV1ResponseMPayload(BaseModel): """ - Payload for POST /1/object/ezsigntemplateformfieldgroup # noqa: E501 - """ - a_pki_ezsigntemplateformfieldgroup_id: conlist(conint(strict=True, ge=0), min_items=1) = Field(..., alias="a_pkiEzsigntemplateformfieldgroupID", description="An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request.") - __properties = ["a_pkiEzsigntemplateformfieldgroupID"] + Payload for POST /1/object/ezsigntemplateformfieldgroup + """ # noqa: E501 + a_pki_ezsigntemplateformfieldgroup_id: Annotated[List[Annotated[int, Field(strict=True, ge=0)]], Field(min_length=1)] = Field(description="An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request.", alias="a_pkiEzsigntemplateformfieldgroupID") + __properties: ClassVar[List[str]] = ["a_pkiEzsigntemplateformfieldgroupID"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplateformfieldgroupCreateObjectV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplateformfieldgroupCreateObjectV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplateformfieldgroupCreateObjectV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplateformfieldgroupCreateObjectV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplateformfieldgroupCreateObjectV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplateformfieldgroupCreateObjectV1ResponseMPayload.parse_obj({ - "a_pki_ezsigntemplateformfieldgroup_id": obj.get("a_pkiEzsigntemplateformfieldgroupID") + _obj = cls.model_validate({ + "a_pkiEzsigntemplateformfieldgroupID": obj.get("a_pkiEzsigntemplateformfieldgroupID") }) return _obj diff --git a/eZmaxApi/models/ezsigntemplateformfieldgroup_delete_object_v1_response.py b/eZmaxApi/models/ezsigntemplateformfieldgroup_delete_object_v1_response.py index c3021f5a6..442bed2c2 100644 --- a/eZmaxApi/models/ezsigntemplateformfieldgroup_delete_object_v1_response.py +++ b/eZmaxApi/models/ezsigntemplateformfieldgroup_delete_object_v1_response.py @@ -19,43 +19,61 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplateformfieldgroupDeleteObjectV1Response(BaseModel): """ - Response for DELETE /1/object/ezsigntemplateformfieldgroup/{pkiEzsigntemplateformfieldgroupID} # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - __properties = ["objDebugPayload", "objDebug"] + Response for DELETE /1/object/ezsigntemplateformfieldgroup/{pkiEzsigntemplateformfieldgroupID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplateformfieldgroupDeleteObjectV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplateformfieldgroupDeleteObjectV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -65,17 +83,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplateformfieldgroupDeleteObjectV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplateformfieldgroupDeleteObjectV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplateformfieldgroupDeleteObjectV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplateformfieldgroupDeleteObjectV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigntemplateformfieldgroup_edit_object_v1_request.py b/eZmaxApi/models/ezsigntemplateformfieldgroup_edit_object_v1_request.py index 152f58fbf..f2012893a 100644 --- a/eZmaxApi/models/ezsigntemplateformfieldgroup_edit_object_v1_request.py +++ b/eZmaxApi/models/ezsigntemplateformfieldgroup_edit_object_v1_request.py @@ -19,57 +19,75 @@ import json - -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.ezsigntemplateformfieldgroup_request_compound import EzsigntemplateformfieldgroupRequestCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplateformfieldgroupEditObjectV1Request(BaseModel): """ - Request for PUT /1/object/ezsigntemplateformfieldgroup/{pkiEzsigntemplateformfieldgroupID} # noqa: E501 - """ - obj_ezsigntemplateformfieldgroup: EzsigntemplateformfieldgroupRequestCompound = Field(..., alias="objEzsigntemplateformfieldgroup") - __properties = ["objEzsigntemplateformfieldgroup"] + Request for PUT /1/object/ezsigntemplateformfieldgroup/{pkiEzsigntemplateformfieldgroupID} + """ # noqa: E501 + obj_ezsigntemplateformfieldgroup: EzsigntemplateformfieldgroupRequestCompound = Field(alias="objEzsigntemplateformfieldgroup") + __properties: ClassVar[List[str]] = ["objEzsigntemplateformfieldgroup"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplateformfieldgroupEditObjectV1Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplateformfieldgroupEditObjectV1Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_ezsigntemplateformfieldgroup if self.obj_ezsigntemplateformfieldgroup: _dict['objEzsigntemplateformfieldgroup'] = self.obj_ezsigntemplateformfieldgroup.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplateformfieldgroupEditObjectV1Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplateformfieldgroupEditObjectV1Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplateformfieldgroupEditObjectV1Request.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplateformfieldgroupEditObjectV1Request.parse_obj({ - "obj_ezsigntemplateformfieldgroup": EzsigntemplateformfieldgroupRequestCompound.from_dict(obj.get("objEzsigntemplateformfieldgroup")) if obj.get("objEzsigntemplateformfieldgroup") is not None else None + _obj = cls.model_validate({ + "objEzsigntemplateformfieldgroup": EzsigntemplateformfieldgroupRequestCompound.from_dict(obj.get("objEzsigntemplateformfieldgroup")) if obj.get("objEzsigntemplateformfieldgroup") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigntemplateformfieldgroup_edit_object_v1_response.py b/eZmaxApi/models/ezsigntemplateformfieldgroup_edit_object_v1_response.py index 4785cbc60..3bf7ff711 100644 --- a/eZmaxApi/models/ezsigntemplateformfieldgroup_edit_object_v1_response.py +++ b/eZmaxApi/models/ezsigntemplateformfieldgroup_edit_object_v1_response.py @@ -19,43 +19,61 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplateformfieldgroupEditObjectV1Response(BaseModel): """ - Response for PUT /1/object/ezsigntemplateformfieldgroup/{pkiEzsigntemplateformfieldgroupID} # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - __properties = ["objDebugPayload", "objDebug"] + Response for PUT /1/object/ezsigntemplateformfieldgroup/{pkiEzsigntemplateformfieldgroupID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplateformfieldgroupEditObjectV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplateformfieldgroupEditObjectV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -65,17 +83,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplateformfieldgroupEditObjectV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplateformfieldgroupEditObjectV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplateformfieldgroupEditObjectV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplateformfieldgroupEditObjectV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigntemplateformfieldgroup_get_object_v2_response.py b/eZmaxApi/models/ezsigntemplateformfieldgroup_get_object_v2_response.py index ef9f6cbcf..7ea1d14af 100644 --- a/eZmaxApi/models/ezsigntemplateformfieldgroup_get_object_v2_response.py +++ b/eZmaxApi/models/ezsigntemplateformfieldgroup_get_object_v2_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.ezsigntemplateformfieldgroup_get_object_v2_response_m_payload import EzsigntemplateformfieldgroupGetObjectV2ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplateformfieldgroupGetObjectV2Response(BaseModel): """ - Response for GET /2/object/ezsigntemplateformfieldgroup/{pkiEzsigntemplateformfieldgroupID} # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzsigntemplateformfieldgroupGetObjectV2ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /2/object/ezsigntemplateformfieldgroup/{pkiEzsigntemplateformfieldgroupID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsigntemplateformfieldgroupGetObjectV2ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplateformfieldgroupGetObjectV2Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplateformfieldgroupGetObjectV2Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplateformfieldgroupGetObjectV2Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplateformfieldgroupGetObjectV2Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplateformfieldgroupGetObjectV2Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplateformfieldgroupGetObjectV2Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzsigntemplateformfieldgroupGetObjectV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsigntemplateformfieldgroupGetObjectV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigntemplateformfieldgroup_get_object_v2_response_m_payload.py b/eZmaxApi/models/ezsigntemplateformfieldgroup_get_object_v2_response_m_payload.py index 532e3ff4e..9fb823324 100644 --- a/eZmaxApi/models/ezsigntemplateformfieldgroup_get_object_v2_response_m_payload.py +++ b/eZmaxApi/models/ezsigntemplateformfieldgroup_get_object_v2_response_m_payload.py @@ -19,57 +19,75 @@ import json - -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.ezsigntemplateformfieldgroup_response_compound import EzsigntemplateformfieldgroupResponseCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplateformfieldgroupGetObjectV2ResponseMPayload(BaseModel): """ - Payload for GET /2/object/ezsigntemplateformfieldgroup/{pkiEzsigntemplateformfieldgroupID} # noqa: E501 - """ - obj_ezsigntemplateformfieldgroup: EzsigntemplateformfieldgroupResponseCompound = Field(..., alias="objEzsigntemplateformfieldgroup") - __properties = ["objEzsigntemplateformfieldgroup"] + Payload for GET /2/object/ezsigntemplateformfieldgroup/{pkiEzsigntemplateformfieldgroupID} + """ # noqa: E501 + obj_ezsigntemplateformfieldgroup: EzsigntemplateformfieldgroupResponseCompound = Field(alias="objEzsigntemplateformfieldgroup") + __properties: ClassVar[List[str]] = ["objEzsigntemplateformfieldgroup"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplateformfieldgroupGetObjectV2ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplateformfieldgroupGetObjectV2ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_ezsigntemplateformfieldgroup if self.obj_ezsigntemplateformfieldgroup: _dict['objEzsigntemplateformfieldgroup'] = self.obj_ezsigntemplateformfieldgroup.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplateformfieldgroupGetObjectV2ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplateformfieldgroupGetObjectV2ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplateformfieldgroupGetObjectV2ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplateformfieldgroupGetObjectV2ResponseMPayload.parse_obj({ - "obj_ezsigntemplateformfieldgroup": EzsigntemplateformfieldgroupResponseCompound.from_dict(obj.get("objEzsigntemplateformfieldgroup")) if obj.get("objEzsigntemplateformfieldgroup") is not None else None + _obj = cls.model_validate({ + "objEzsigntemplateformfieldgroup": EzsigntemplateformfieldgroupResponseCompound.from_dict(obj.get("objEzsigntemplateformfieldgroup")) if obj.get("objEzsigntemplateformfieldgroup") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigntemplateformfieldgroup_request.py b/eZmaxApi/models/ezsigntemplateformfieldgroup_request.py index c77e92518..b2f1005de 100644 --- a/eZmaxApi/models/ezsigntemplateformfieldgroup_request.py +++ b/eZmaxApi/models/ezsigntemplateformfieldgroup_request.py @@ -19,36 +19,42 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint, constr, validator +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, StrictStr, field_validator +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.enum_textvalidation import EnumTextvalidation from eZmaxApi.models.field_e_ezsigntemplateformfieldgroup_signerrequirement import FieldEEzsigntemplateformfieldgroupSignerrequirement from eZmaxApi.models.field_e_ezsigntemplateformfieldgroup_tooltipposition import FieldEEzsigntemplateformfieldgroupTooltipposition from eZmaxApi.models.field_e_ezsigntemplateformfieldgroup_type import FieldEEzsigntemplateformfieldgroupType +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplateformfieldgroupRequest(BaseModel): """ - A Ezsigntemplateformfieldgroup Object # noqa: E501 - """ - pki_ezsigntemplateformfieldgroup_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="pkiEzsigntemplateformfieldgroupID", description="The unique ID of the Ezsigntemplateformfieldgroup") - fki_ezsigntemplatedocument_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsigntemplatedocumentID", description="The unique ID of the Ezsigntemplatedocument") - e_ezsigntemplateformfieldgroup_type: FieldEEzsigntemplateformfieldgroupType = Field(..., alias="eEzsigntemplateformfieldgroupType") - e_ezsigntemplateformfieldgroup_signerrequirement: FieldEEzsigntemplateformfieldgroupSignerrequirement = Field(..., alias="eEzsigntemplateformfieldgroupSignerrequirement") - s_ezsigntemplateformfieldgroup_label: constr(strict=True, max_length=50, min_length=1) = Field(..., alias="sEzsigntemplateformfieldgroupLabel", description="The Label for the Ezsigntemplateformfieldgroup") - i_ezsigntemplateformfieldgroup_step: conint(strict=True, ge=1) = Field(..., alias="iEzsigntemplateformfieldgroupStep", description="The step when the Ezsigntemplatesigner will be invited to fill the form fields") - s_ezsigntemplateformfieldgroup_defaultvalue: StrictStr = Field(..., alias="sEzsigntemplateformfieldgroupDefaultvalue", description="The default value for the Ezsigntemplateformfieldgroup") - i_ezsigntemplateformfieldgroup_filledmin: conint(strict=True, ge=0) = Field(..., alias="iEzsigntemplateformfieldgroupFilledmin", description="The minimum number of Ezsigntemplateformfield that must be filled in the Ezsigntemplateformfieldgroup") - i_ezsigntemplateformfieldgroup_filledmax: conint(strict=True, ge=0) = Field(..., alias="iEzsigntemplateformfieldgroupFilledmax", description="The maximum number of Ezsigntemplateformfield that must be filled in the Ezsigntemplateformfieldgroup") - b_ezsigntemplateformfieldgroup_readonly: StrictBool = Field(..., alias="bEzsigntemplateformfieldgroupReadonly", description="Whether the Ezsigntemplateformfieldgroup is read only or not.") - i_ezsigntemplateformfieldgroup_maxlength: Optional[conint(strict=True, le=65535, ge=0)] = Field(None, alias="iEzsigntemplateformfieldgroupMaxlength", description="The maximum length for the value in the Ezsigntemplateformfieldgroup This can only be set if eEzsigntemplateformfieldgroupType is **Text** or **Textarea**") - b_ezsigntemplateformfieldgroup_encrypted: Optional[StrictBool] = Field(None, alias="bEzsigntemplateformfieldgroupEncrypted", description="Whether the Ezsigntemplateformfieldgroup is encrypted in the database or not. Encrypted values are not displayed on the Ezsigndocument. This can only be set if eEzsigntemplateformfieldgroupType is **Text** or **Textarea**") - s_ezsigntemplateformfieldgroup_regexp: Optional[constr(strict=True)] = Field(None, alias="sEzsigntemplateformfieldgroupRegexp", description="A regular expression to indicate what values are acceptable for the Ezsigntemplateformfieldgroup. This can only be set if eEzsigntemplateformfieldgroupType is **Text** or **Textarea**") - e_ezsigntemplateformfieldgroup_textvalidation: Optional[EnumTextvalidation] = Field(None, alias="eEzsigntemplateformfieldgroupTextvalidation") - t_ezsigntemplateformfieldgroup_tooltip: Optional[StrictStr] = Field(None, alias="tEzsigntemplateformfieldgroupTooltip", description="A tooltip that will be presented to Ezsigntemplatesigner about the Ezsigntemplateformfieldgroup") - e_ezsigntemplateformfieldgroup_tooltipposition: Optional[FieldEEzsigntemplateformfieldgroupTooltipposition] = Field(None, alias="eEzsigntemplateformfieldgroupTooltipposition") - __properties = ["pkiEzsigntemplateformfieldgroupID", "fkiEzsigntemplatedocumentID", "eEzsigntemplateformfieldgroupType", "eEzsigntemplateformfieldgroupSignerrequirement", "sEzsigntemplateformfieldgroupLabel", "iEzsigntemplateformfieldgroupStep", "sEzsigntemplateformfieldgroupDefaultvalue", "iEzsigntemplateformfieldgroupFilledmin", "iEzsigntemplateformfieldgroupFilledmax", "bEzsigntemplateformfieldgroupReadonly", "iEzsigntemplateformfieldgroupMaxlength", "bEzsigntemplateformfieldgroupEncrypted", "sEzsigntemplateformfieldgroupRegexp", "eEzsigntemplateformfieldgroupTextvalidation", "tEzsigntemplateformfieldgroupTooltip", "eEzsigntemplateformfieldgroupTooltipposition"] - - @validator('s_ezsigntemplateformfieldgroup_regexp') + A Ezsigntemplateformfieldgroup Object + """ # noqa: E501 + pki_ezsigntemplateformfieldgroup_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsigntemplateformfieldgroup", alias="pkiEzsigntemplateformfieldgroupID") + fki_ezsigntemplatedocument_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsigntemplatedocument", alias="fkiEzsigntemplatedocumentID") + e_ezsigntemplateformfieldgroup_type: FieldEEzsigntemplateformfieldgroupType = Field(alias="eEzsigntemplateformfieldgroupType") + e_ezsigntemplateformfieldgroup_signerrequirement: FieldEEzsigntemplateformfieldgroupSignerrequirement = Field(alias="eEzsigntemplateformfieldgroupSignerrequirement") + s_ezsigntemplateformfieldgroup_label: Annotated[str, Field(min_length=1, strict=True, max_length=50)] = Field(description="The Label for the Ezsigntemplateformfieldgroup", alias="sEzsigntemplateformfieldgroupLabel") + i_ezsigntemplateformfieldgroup_step: Annotated[int, Field(strict=True, ge=1)] = Field(description="The step when the Ezsigntemplatesigner will be invited to fill the form fields", alias="iEzsigntemplateformfieldgroupStep") + s_ezsigntemplateformfieldgroup_defaultvalue: StrictStr = Field(description="The default value for the Ezsigntemplateformfieldgroup", alias="sEzsigntemplateformfieldgroupDefaultvalue") + i_ezsigntemplateformfieldgroup_filledmin: Annotated[int, Field(strict=True, ge=0)] = Field(description="The minimum number of Ezsigntemplateformfield that must be filled in the Ezsigntemplateformfieldgroup", alias="iEzsigntemplateformfieldgroupFilledmin") + i_ezsigntemplateformfieldgroup_filledmax: Annotated[int, Field(strict=True, ge=0)] = Field(description="The maximum number of Ezsigntemplateformfield that must be filled in the Ezsigntemplateformfieldgroup", alias="iEzsigntemplateformfieldgroupFilledmax") + b_ezsigntemplateformfieldgroup_readonly: StrictBool = Field(description="Whether the Ezsigntemplateformfieldgroup is read only or not.", alias="bEzsigntemplateformfieldgroupReadonly") + i_ezsigntemplateformfieldgroup_maxlength: Optional[Annotated[int, Field(le=65535, strict=True, ge=0)]] = Field(default=None, description="The maximum length for the value in the Ezsigntemplateformfieldgroup This can only be set if eEzsigntemplateformfieldgroupType is **Text** or **Textarea**", alias="iEzsigntemplateformfieldgroupMaxlength") + b_ezsigntemplateformfieldgroup_encrypted: Optional[StrictBool] = Field(default=None, description="Whether the Ezsigntemplateformfieldgroup is encrypted in the database or not. Encrypted values are not displayed on the Ezsigndocument. This can only be set if eEzsigntemplateformfieldgroupType is **Text** or **Textarea**", alias="bEzsigntemplateformfieldgroupEncrypted") + s_ezsigntemplateformfieldgroup_regexp: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="A regular expression to indicate what values are acceptable for the Ezsigntemplateformfieldgroup. This can only be set if eEzsigntemplateformfieldgroupType is **Text** or **Textarea**", alias="sEzsigntemplateformfieldgroupRegexp") + e_ezsigntemplateformfieldgroup_textvalidation: Optional[EnumTextvalidation] = Field(default=None, alias="eEzsigntemplateformfieldgroupTextvalidation") + t_ezsigntemplateformfieldgroup_tooltip: Optional[StrictStr] = Field(default=None, description="A tooltip that will be presented to Ezsigntemplatesigner about the Ezsigntemplateformfieldgroup", alias="tEzsigntemplateformfieldgroupTooltip") + e_ezsigntemplateformfieldgroup_tooltipposition: Optional[FieldEEzsigntemplateformfieldgroupTooltipposition] = Field(default=None, alias="eEzsigntemplateformfieldgroupTooltipposition") + __properties: ClassVar[List[str]] = ["pkiEzsigntemplateformfieldgroupID", "fkiEzsigntemplatedocumentID", "eEzsigntemplateformfieldgroupType", "eEzsigntemplateformfieldgroupSignerrequirement", "sEzsigntemplateformfieldgroupLabel", "iEzsigntemplateformfieldgroupStep", "sEzsigntemplateformfieldgroupDefaultvalue", "iEzsigntemplateformfieldgroupFilledmin", "iEzsigntemplateformfieldgroupFilledmax", "bEzsigntemplateformfieldgroupReadonly", "iEzsigntemplateformfieldgroupMaxlength", "bEzsigntemplateformfieldgroupEncrypted", "sEzsigntemplateformfieldgroupRegexp", "eEzsigntemplateformfieldgroupTextvalidation", "tEzsigntemplateformfieldgroupTooltip", "eEzsigntemplateformfieldgroupTooltipposition"] + + @field_validator('s_ezsigntemplateformfieldgroup_regexp') def s_ezsigntemplateformfieldgroup_regexp_validate_regular_expression(cls, value): """Validates the regular expression""" if value is None: @@ -58,58 +64,71 @@ def s_ezsigntemplateformfieldgroup_regexp_validate_regular_expression(cls, value raise ValueError(r"must validate the regular expression /^\^.*\$$|^$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplateformfieldgroupRequest: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplateformfieldgroupRequest from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplateformfieldgroupRequest: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplateformfieldgroupRequest from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplateformfieldgroupRequest.parse_obj(obj) - - _obj = EzsigntemplateformfieldgroupRequest.parse_obj({ - "pki_ezsigntemplateformfieldgroup_id": obj.get("pkiEzsigntemplateformfieldgroupID"), - "fki_ezsigntemplatedocument_id": obj.get("fkiEzsigntemplatedocumentID"), - "e_ezsigntemplateformfieldgroup_type": obj.get("eEzsigntemplateformfieldgroupType"), - "e_ezsigntemplateformfieldgroup_signerrequirement": obj.get("eEzsigntemplateformfieldgroupSignerrequirement"), - "s_ezsigntemplateformfieldgroup_label": obj.get("sEzsigntemplateformfieldgroupLabel"), - "i_ezsigntemplateformfieldgroup_step": obj.get("iEzsigntemplateformfieldgroupStep"), - "s_ezsigntemplateformfieldgroup_defaultvalue": obj.get("sEzsigntemplateformfieldgroupDefaultvalue"), - "i_ezsigntemplateformfieldgroup_filledmin": obj.get("iEzsigntemplateformfieldgroupFilledmin"), - "i_ezsigntemplateformfieldgroup_filledmax": obj.get("iEzsigntemplateformfieldgroupFilledmax"), - "b_ezsigntemplateformfieldgroup_readonly": obj.get("bEzsigntemplateformfieldgroupReadonly"), - "i_ezsigntemplateformfieldgroup_maxlength": obj.get("iEzsigntemplateformfieldgroupMaxlength"), - "b_ezsigntemplateformfieldgroup_encrypted": obj.get("bEzsigntemplateformfieldgroupEncrypted"), - "s_ezsigntemplateformfieldgroup_regexp": obj.get("sEzsigntemplateformfieldgroupRegexp"), - "e_ezsigntemplateformfieldgroup_textvalidation": obj.get("eEzsigntemplateformfieldgroupTextvalidation"), - "t_ezsigntemplateformfieldgroup_tooltip": obj.get("tEzsigntemplateformfieldgroupTooltip"), - "e_ezsigntemplateformfieldgroup_tooltipposition": obj.get("eEzsigntemplateformfieldgroupTooltipposition") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsigntemplateformfieldgroupID": obj.get("pkiEzsigntemplateformfieldgroupID"), + "fkiEzsigntemplatedocumentID": obj.get("fkiEzsigntemplatedocumentID"), + "eEzsigntemplateformfieldgroupType": obj.get("eEzsigntemplateformfieldgroupType"), + "eEzsigntemplateformfieldgroupSignerrequirement": obj.get("eEzsigntemplateformfieldgroupSignerrequirement"), + "sEzsigntemplateformfieldgroupLabel": obj.get("sEzsigntemplateformfieldgroupLabel"), + "iEzsigntemplateformfieldgroupStep": obj.get("iEzsigntemplateformfieldgroupStep"), + "sEzsigntemplateformfieldgroupDefaultvalue": obj.get("sEzsigntemplateformfieldgroupDefaultvalue"), + "iEzsigntemplateformfieldgroupFilledmin": obj.get("iEzsigntemplateformfieldgroupFilledmin"), + "iEzsigntemplateformfieldgroupFilledmax": obj.get("iEzsigntemplateformfieldgroupFilledmax"), + "bEzsigntemplateformfieldgroupReadonly": obj.get("bEzsigntemplateformfieldgroupReadonly"), + "iEzsigntemplateformfieldgroupMaxlength": obj.get("iEzsigntemplateformfieldgroupMaxlength"), + "bEzsigntemplateformfieldgroupEncrypted": obj.get("bEzsigntemplateformfieldgroupEncrypted"), + "sEzsigntemplateformfieldgroupRegexp": obj.get("sEzsigntemplateformfieldgroupRegexp"), + "eEzsigntemplateformfieldgroupTextvalidation": obj.get("eEzsigntemplateformfieldgroupTextvalidation"), + "tEzsigntemplateformfieldgroupTooltip": obj.get("tEzsigntemplateformfieldgroupTooltip"), + "eEzsigntemplateformfieldgroupTooltipposition": obj.get("eEzsigntemplateformfieldgroupTooltipposition") }) return _obj diff --git a/eZmaxApi/models/ezsigntemplateformfieldgroup_request_compound.py b/eZmaxApi/models/ezsigntemplateformfieldgroup_request_compound.py index 6086e612e..d5f5a066c 100644 --- a/eZmaxApi/models/ezsigntemplateformfieldgroup_request_compound.py +++ b/eZmaxApi/models/ezsigntemplateformfieldgroup_request_compound.py @@ -19,8 +19,10 @@ import json -from typing import List, Optional -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint, conlist, constr, validator +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, StrictStr, field_validator +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.custom_dropdown_element_request_compound import CustomDropdownElementRequestCompound from eZmaxApi.models.enum_textvalidation import EnumTextvalidation from eZmaxApi.models.ezsigntemplateformfield_request_compound import EzsigntemplateformfieldRequestCompound @@ -28,33 +30,37 @@ from eZmaxApi.models.field_e_ezsigntemplateformfieldgroup_signerrequirement import FieldEEzsigntemplateformfieldgroupSignerrequirement from eZmaxApi.models.field_e_ezsigntemplateformfieldgroup_tooltipposition import FieldEEzsigntemplateformfieldgroupTooltipposition from eZmaxApi.models.field_e_ezsigntemplateformfieldgroup_type import FieldEEzsigntemplateformfieldgroupType +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplateformfieldgroupRequestCompound(BaseModel): """ - A Ezsigntemplateformfieldgroup Object and children # noqa: E501 - """ - pki_ezsigntemplateformfieldgroup_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="pkiEzsigntemplateformfieldgroupID", description="The unique ID of the Ezsigntemplateformfieldgroup") - fki_ezsigntemplatedocument_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsigntemplatedocumentID", description="The unique ID of the Ezsigntemplatedocument") - e_ezsigntemplateformfieldgroup_type: FieldEEzsigntemplateformfieldgroupType = Field(..., alias="eEzsigntemplateformfieldgroupType") - e_ezsigntemplateformfieldgroup_signerrequirement: FieldEEzsigntemplateformfieldgroupSignerrequirement = Field(..., alias="eEzsigntemplateformfieldgroupSignerrequirement") - s_ezsigntemplateformfieldgroup_label: constr(strict=True, max_length=50, min_length=1) = Field(..., alias="sEzsigntemplateformfieldgroupLabel", description="The Label for the Ezsigntemplateformfieldgroup") - i_ezsigntemplateformfieldgroup_step: conint(strict=True, ge=1) = Field(..., alias="iEzsigntemplateformfieldgroupStep", description="The step when the Ezsigntemplatesigner will be invited to fill the form fields") - s_ezsigntemplateformfieldgroup_defaultvalue: StrictStr = Field(..., alias="sEzsigntemplateformfieldgroupDefaultvalue", description="The default value for the Ezsigntemplateformfieldgroup") - i_ezsigntemplateformfieldgroup_filledmin: conint(strict=True, ge=0) = Field(..., alias="iEzsigntemplateformfieldgroupFilledmin", description="The minimum number of Ezsigntemplateformfield that must be filled in the Ezsigntemplateformfieldgroup") - i_ezsigntemplateformfieldgroup_filledmax: conint(strict=True, ge=0) = Field(..., alias="iEzsigntemplateformfieldgroupFilledmax", description="The maximum number of Ezsigntemplateformfield that must be filled in the Ezsigntemplateformfieldgroup") - b_ezsigntemplateformfieldgroup_readonly: StrictBool = Field(..., alias="bEzsigntemplateformfieldgroupReadonly", description="Whether the Ezsigntemplateformfieldgroup is read only or not.") - i_ezsigntemplateformfieldgroup_maxlength: Optional[conint(strict=True, le=65535, ge=0)] = Field(None, alias="iEzsigntemplateformfieldgroupMaxlength", description="The maximum length for the value in the Ezsigntemplateformfieldgroup This can only be set if eEzsigntemplateformfieldgroupType is **Text** or **Textarea**") - b_ezsigntemplateformfieldgroup_encrypted: Optional[StrictBool] = Field(None, alias="bEzsigntemplateformfieldgroupEncrypted", description="Whether the Ezsigntemplateformfieldgroup is encrypted in the database or not. Encrypted values are not displayed on the Ezsigndocument. This can only be set if eEzsigntemplateformfieldgroupType is **Text** or **Textarea**") - s_ezsigntemplateformfieldgroup_regexp: Optional[constr(strict=True)] = Field(None, alias="sEzsigntemplateformfieldgroupRegexp", description="A regular expression to indicate what values are acceptable for the Ezsigntemplateformfieldgroup. This can only be set if eEzsigntemplateformfieldgroupType is **Text** or **Textarea**") - e_ezsigntemplateformfieldgroup_textvalidation: Optional[EnumTextvalidation] = Field(None, alias="eEzsigntemplateformfieldgroupTextvalidation") - t_ezsigntemplateformfieldgroup_tooltip: Optional[StrictStr] = Field(None, alias="tEzsigntemplateformfieldgroupTooltip", description="A tooltip that will be presented to Ezsigntemplatesigner about the Ezsigntemplateformfieldgroup") - e_ezsigntemplateformfieldgroup_tooltipposition: Optional[FieldEEzsigntemplateformfieldgroupTooltipposition] = Field(None, alias="eEzsigntemplateformfieldgroupTooltipposition") - a_obj_ezsigntemplateformfieldgroupsigner: conlist(EzsigntemplateformfieldgroupsignerRequestCompound) = Field(..., alias="a_objEzsigntemplateformfieldgroupsigner") - a_obj_dropdown_element: Optional[conlist(CustomDropdownElementRequestCompound)] = Field(None, alias="a_objDropdownElement") - a_obj_ezsigntemplateformfield: conlist(EzsigntemplateformfieldRequestCompound) = Field(..., alias="a_objEzsigntemplateformfield") - __properties = ["pkiEzsigntemplateformfieldgroupID", "fkiEzsigntemplatedocumentID", "eEzsigntemplateformfieldgroupType", "eEzsigntemplateformfieldgroupSignerrequirement", "sEzsigntemplateformfieldgroupLabel", "iEzsigntemplateformfieldgroupStep", "sEzsigntemplateformfieldgroupDefaultvalue", "iEzsigntemplateformfieldgroupFilledmin", "iEzsigntemplateformfieldgroupFilledmax", "bEzsigntemplateformfieldgroupReadonly", "iEzsigntemplateformfieldgroupMaxlength", "bEzsigntemplateformfieldgroupEncrypted", "sEzsigntemplateformfieldgroupRegexp", "eEzsigntemplateformfieldgroupTextvalidation", "tEzsigntemplateformfieldgroupTooltip", "eEzsigntemplateformfieldgroupTooltipposition", "a_objEzsigntemplateformfieldgroupsigner", "a_objDropdownElement", "a_objEzsigntemplateformfield"] - - @validator('s_ezsigntemplateformfieldgroup_regexp') + A Ezsigntemplateformfieldgroup Object and children + """ # noqa: E501 + pki_ezsigntemplateformfieldgroup_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsigntemplateformfieldgroup", alias="pkiEzsigntemplateformfieldgroupID") + fki_ezsigntemplatedocument_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsigntemplatedocument", alias="fkiEzsigntemplatedocumentID") + e_ezsigntemplateformfieldgroup_type: FieldEEzsigntemplateformfieldgroupType = Field(alias="eEzsigntemplateformfieldgroupType") + e_ezsigntemplateformfieldgroup_signerrequirement: FieldEEzsigntemplateformfieldgroupSignerrequirement = Field(alias="eEzsigntemplateformfieldgroupSignerrequirement") + s_ezsigntemplateformfieldgroup_label: Annotated[str, Field(min_length=1, strict=True, max_length=50)] = Field(description="The Label for the Ezsigntemplateformfieldgroup", alias="sEzsigntemplateformfieldgroupLabel") + i_ezsigntemplateformfieldgroup_step: Annotated[int, Field(strict=True, ge=1)] = Field(description="The step when the Ezsigntemplatesigner will be invited to fill the form fields", alias="iEzsigntemplateformfieldgroupStep") + s_ezsigntemplateformfieldgroup_defaultvalue: StrictStr = Field(description="The default value for the Ezsigntemplateformfieldgroup", alias="sEzsigntemplateformfieldgroupDefaultvalue") + i_ezsigntemplateformfieldgroup_filledmin: Annotated[int, Field(strict=True, ge=0)] = Field(description="The minimum number of Ezsigntemplateformfield that must be filled in the Ezsigntemplateformfieldgroup", alias="iEzsigntemplateformfieldgroupFilledmin") + i_ezsigntemplateformfieldgroup_filledmax: Annotated[int, Field(strict=True, ge=0)] = Field(description="The maximum number of Ezsigntemplateformfield that must be filled in the Ezsigntemplateformfieldgroup", alias="iEzsigntemplateformfieldgroupFilledmax") + b_ezsigntemplateformfieldgroup_readonly: StrictBool = Field(description="Whether the Ezsigntemplateformfieldgroup is read only or not.", alias="bEzsigntemplateformfieldgroupReadonly") + i_ezsigntemplateformfieldgroup_maxlength: Optional[Annotated[int, Field(le=65535, strict=True, ge=0)]] = Field(default=None, description="The maximum length for the value in the Ezsigntemplateformfieldgroup This can only be set if eEzsigntemplateformfieldgroupType is **Text** or **Textarea**", alias="iEzsigntemplateformfieldgroupMaxlength") + b_ezsigntemplateformfieldgroup_encrypted: Optional[StrictBool] = Field(default=None, description="Whether the Ezsigntemplateformfieldgroup is encrypted in the database or not. Encrypted values are not displayed on the Ezsigndocument. This can only be set if eEzsigntemplateformfieldgroupType is **Text** or **Textarea**", alias="bEzsigntemplateformfieldgroupEncrypted") + s_ezsigntemplateformfieldgroup_regexp: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="A regular expression to indicate what values are acceptable for the Ezsigntemplateformfieldgroup. This can only be set if eEzsigntemplateformfieldgroupType is **Text** or **Textarea**", alias="sEzsigntemplateformfieldgroupRegexp") + e_ezsigntemplateformfieldgroup_textvalidation: Optional[EnumTextvalidation] = Field(default=None, alias="eEzsigntemplateformfieldgroupTextvalidation") + t_ezsigntemplateformfieldgroup_tooltip: Optional[StrictStr] = Field(default=None, description="A tooltip that will be presented to Ezsigntemplatesigner about the Ezsigntemplateformfieldgroup", alias="tEzsigntemplateformfieldgroupTooltip") + e_ezsigntemplateformfieldgroup_tooltipposition: Optional[FieldEEzsigntemplateformfieldgroupTooltipposition] = Field(default=None, alias="eEzsigntemplateformfieldgroupTooltipposition") + a_obj_ezsigntemplateformfieldgroupsigner: List[EzsigntemplateformfieldgroupsignerRequestCompound] = Field(alias="a_objEzsigntemplateformfieldgroupsigner") + a_obj_dropdown_element: Optional[List[CustomDropdownElementRequestCompound]] = Field(default=None, alias="a_objDropdownElement") + a_obj_ezsigntemplateformfield: List[EzsigntemplateformfieldRequestCompound] = Field(alias="a_objEzsigntemplateformfield") + __properties: ClassVar[List[str]] = ["pkiEzsigntemplateformfieldgroupID", "fkiEzsigntemplatedocumentID", "eEzsigntemplateformfieldgroupType", "eEzsigntemplateformfieldgroupSignerrequirement", "sEzsigntemplateformfieldgroupLabel", "iEzsigntemplateformfieldgroupStep", "sEzsigntemplateformfieldgroupDefaultvalue", "iEzsigntemplateformfieldgroupFilledmin", "iEzsigntemplateformfieldgroupFilledmax", "bEzsigntemplateformfieldgroupReadonly", "iEzsigntemplateformfieldgroupMaxlength", "bEzsigntemplateformfieldgroupEncrypted", "sEzsigntemplateformfieldgroupRegexp", "eEzsigntemplateformfieldgroupTextvalidation", "tEzsigntemplateformfieldgroupTooltip", "eEzsigntemplateformfieldgroupTooltipposition", "a_objEzsigntemplateformfieldgroupsigner", "a_objDropdownElement", "a_objEzsigntemplateformfield"] + + @field_validator('s_ezsigntemplateformfieldgroup_regexp') def s_ezsigntemplateformfieldgroup_regexp_validate_regular_expression(cls, value): """Validates the regular expression""" if value is None: @@ -64,30 +70,43 @@ def s_ezsigntemplateformfieldgroup_regexp_validate_regular_expression(cls, value raise ValueError(r"must validate the regular expression /^\^.*\$$|^$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplateformfieldgroupRequestCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplateformfieldgroupRequestCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_ezsigntemplateformfieldgroupsigner (list) _items = [] if self.a_obj_ezsigntemplateformfieldgroupsigner: @@ -112,34 +131,34 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplateformfieldgroupRequestCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplateformfieldgroupRequestCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplateformfieldgroupRequestCompound.parse_obj(obj) - - _obj = EzsigntemplateformfieldgroupRequestCompound.parse_obj({ - "pki_ezsigntemplateformfieldgroup_id": obj.get("pkiEzsigntemplateformfieldgroupID"), - "fki_ezsigntemplatedocument_id": obj.get("fkiEzsigntemplatedocumentID"), - "e_ezsigntemplateformfieldgroup_type": obj.get("eEzsigntemplateformfieldgroupType"), - "e_ezsigntemplateformfieldgroup_signerrequirement": obj.get("eEzsigntemplateformfieldgroupSignerrequirement"), - "s_ezsigntemplateformfieldgroup_label": obj.get("sEzsigntemplateformfieldgroupLabel"), - "i_ezsigntemplateformfieldgroup_step": obj.get("iEzsigntemplateformfieldgroupStep"), - "s_ezsigntemplateformfieldgroup_defaultvalue": obj.get("sEzsigntemplateformfieldgroupDefaultvalue"), - "i_ezsigntemplateformfieldgroup_filledmin": obj.get("iEzsigntemplateformfieldgroupFilledmin"), - "i_ezsigntemplateformfieldgroup_filledmax": obj.get("iEzsigntemplateformfieldgroupFilledmax"), - "b_ezsigntemplateformfieldgroup_readonly": obj.get("bEzsigntemplateformfieldgroupReadonly"), - "i_ezsigntemplateformfieldgroup_maxlength": obj.get("iEzsigntemplateformfieldgroupMaxlength"), - "b_ezsigntemplateformfieldgroup_encrypted": obj.get("bEzsigntemplateformfieldgroupEncrypted"), - "s_ezsigntemplateformfieldgroup_regexp": obj.get("sEzsigntemplateformfieldgroupRegexp"), - "e_ezsigntemplateformfieldgroup_textvalidation": obj.get("eEzsigntemplateformfieldgroupTextvalidation"), - "t_ezsigntemplateformfieldgroup_tooltip": obj.get("tEzsigntemplateformfieldgroupTooltip"), - "e_ezsigntemplateformfieldgroup_tooltipposition": obj.get("eEzsigntemplateformfieldgroupTooltipposition"), - "a_obj_ezsigntemplateformfieldgroupsigner": [EzsigntemplateformfieldgroupsignerRequestCompound.from_dict(_item) for _item in obj.get("a_objEzsigntemplateformfieldgroupsigner")] if obj.get("a_objEzsigntemplateformfieldgroupsigner") is not None else None, - "a_obj_dropdown_element": [CustomDropdownElementRequestCompound.from_dict(_item) for _item in obj.get("a_objDropdownElement")] if obj.get("a_objDropdownElement") is not None else None, - "a_obj_ezsigntemplateformfield": [EzsigntemplateformfieldRequestCompound.from_dict(_item) for _item in obj.get("a_objEzsigntemplateformfield")] if obj.get("a_objEzsigntemplateformfield") is not None else None + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsigntemplateformfieldgroupID": obj.get("pkiEzsigntemplateformfieldgroupID"), + "fkiEzsigntemplatedocumentID": obj.get("fkiEzsigntemplatedocumentID"), + "eEzsigntemplateformfieldgroupType": obj.get("eEzsigntemplateformfieldgroupType"), + "eEzsigntemplateformfieldgroupSignerrequirement": obj.get("eEzsigntemplateformfieldgroupSignerrequirement"), + "sEzsigntemplateformfieldgroupLabel": obj.get("sEzsigntemplateformfieldgroupLabel"), + "iEzsigntemplateformfieldgroupStep": obj.get("iEzsigntemplateformfieldgroupStep"), + "sEzsigntemplateformfieldgroupDefaultvalue": obj.get("sEzsigntemplateformfieldgroupDefaultvalue"), + "iEzsigntemplateformfieldgroupFilledmin": obj.get("iEzsigntemplateformfieldgroupFilledmin"), + "iEzsigntemplateformfieldgroupFilledmax": obj.get("iEzsigntemplateformfieldgroupFilledmax"), + "bEzsigntemplateformfieldgroupReadonly": obj.get("bEzsigntemplateformfieldgroupReadonly"), + "iEzsigntemplateformfieldgroupMaxlength": obj.get("iEzsigntemplateformfieldgroupMaxlength"), + "bEzsigntemplateformfieldgroupEncrypted": obj.get("bEzsigntemplateformfieldgroupEncrypted"), + "sEzsigntemplateformfieldgroupRegexp": obj.get("sEzsigntemplateformfieldgroupRegexp"), + "eEzsigntemplateformfieldgroupTextvalidation": obj.get("eEzsigntemplateformfieldgroupTextvalidation"), + "tEzsigntemplateformfieldgroupTooltip": obj.get("tEzsigntemplateformfieldgroupTooltip"), + "eEzsigntemplateformfieldgroupTooltipposition": obj.get("eEzsigntemplateformfieldgroupTooltipposition"), + "a_objEzsigntemplateformfieldgroupsigner": [EzsigntemplateformfieldgroupsignerRequestCompound.from_dict(_item) for _item in obj.get("a_objEzsigntemplateformfieldgroupsigner")] if obj.get("a_objEzsigntemplateformfieldgroupsigner") is not None else None, + "a_objDropdownElement": [CustomDropdownElementRequestCompound.from_dict(_item) for _item in obj.get("a_objDropdownElement")] if obj.get("a_objDropdownElement") is not None else None, + "a_objEzsigntemplateformfield": [EzsigntemplateformfieldRequestCompound.from_dict(_item) for _item in obj.get("a_objEzsigntemplateformfield")] if obj.get("a_objEzsigntemplateformfield") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigntemplateformfieldgroup_response.py b/eZmaxApi/models/ezsigntemplateformfieldgroup_response.py index 70d458b01..36bd3cee0 100644 --- a/eZmaxApi/models/ezsigntemplateformfieldgroup_response.py +++ b/eZmaxApi/models/ezsigntemplateformfieldgroup_response.py @@ -19,36 +19,42 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint, constr, validator +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, StrictStr, field_validator +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.enum_textvalidation import EnumTextvalidation from eZmaxApi.models.field_e_ezsigntemplateformfieldgroup_signerrequirement import FieldEEzsigntemplateformfieldgroupSignerrequirement from eZmaxApi.models.field_e_ezsigntemplateformfieldgroup_tooltipposition import FieldEEzsigntemplateformfieldgroupTooltipposition from eZmaxApi.models.field_e_ezsigntemplateformfieldgroup_type import FieldEEzsigntemplateformfieldgroupType +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplateformfieldgroupResponse(BaseModel): """ - A Ezsigntemplateformfieldgroup Object # noqa: E501 - """ - pki_ezsigntemplateformfieldgroup_id: conint(strict=True, ge=0) = Field(..., alias="pkiEzsigntemplateformfieldgroupID", description="The unique ID of the Ezsigntemplateformfieldgroup") - fki_ezsigntemplatedocument_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsigntemplatedocumentID", description="The unique ID of the Ezsigntemplatedocument") - e_ezsigntemplateformfieldgroup_type: FieldEEzsigntemplateformfieldgroupType = Field(..., alias="eEzsigntemplateformfieldgroupType") - e_ezsigntemplateformfieldgroup_signerrequirement: FieldEEzsigntemplateformfieldgroupSignerrequirement = Field(..., alias="eEzsigntemplateformfieldgroupSignerrequirement") - s_ezsigntemplateformfieldgroup_label: constr(strict=True, max_length=50, min_length=1) = Field(..., alias="sEzsigntemplateformfieldgroupLabel", description="The Label for the Ezsigntemplateformfieldgroup") - i_ezsigntemplateformfieldgroup_step: conint(strict=True, ge=1) = Field(..., alias="iEzsigntemplateformfieldgroupStep", description="The step when the Ezsigntemplatesigner will be invited to fill the form fields") - s_ezsigntemplateformfieldgroup_defaultvalue: Optional[StrictStr] = Field(None, alias="sEzsigntemplateformfieldgroupDefaultvalue", description="The default value for the Ezsigntemplateformfieldgroup") - i_ezsigntemplateformfieldgroup_filledmin: conint(strict=True, ge=0) = Field(..., alias="iEzsigntemplateformfieldgroupFilledmin", description="The minimum number of Ezsigntemplateformfield that must be filled in the Ezsigntemplateformfieldgroup") - i_ezsigntemplateformfieldgroup_filledmax: conint(strict=True, ge=0) = Field(..., alias="iEzsigntemplateformfieldgroupFilledmax", description="The maximum number of Ezsigntemplateformfield that must be filled in the Ezsigntemplateformfieldgroup") - b_ezsigntemplateformfieldgroup_readonly: StrictBool = Field(..., alias="bEzsigntemplateformfieldgroupReadonly", description="Whether the Ezsigntemplateformfieldgroup is read only or not.") - i_ezsigntemplateformfieldgroup_maxlength: Optional[conint(strict=True, le=65535, ge=0)] = Field(None, alias="iEzsigntemplateformfieldgroupMaxlength", description="The maximum length for the value in the Ezsigntemplateformfieldgroup This can only be set if eEzsigntemplateformfieldgroupType is **Text** or **Textarea**") - b_ezsigntemplateformfieldgroup_encrypted: Optional[StrictBool] = Field(None, alias="bEzsigntemplateformfieldgroupEncrypted", description="Whether the Ezsigntemplateformfieldgroup is encrypted in the database or not. Encrypted values are not displayed on the Ezsigndocument. This can only be set if eEzsigntemplateformfieldgroupType is **Text** or **Textarea**") - s_ezsigntemplateformfieldgroup_regexp: Optional[constr(strict=True)] = Field(None, alias="sEzsigntemplateformfieldgroupRegexp", description="A regular expression to indicate what values are acceptable for the Ezsigntemplateformfieldgroup. This can only be set if eEzsigntemplateformfieldgroupType is **Text** or **Textarea**") - e_ezsigntemplateformfieldgroup_textvalidation: Optional[EnumTextvalidation] = Field(None, alias="eEzsigntemplateformfieldgroupTextvalidation") - t_ezsigntemplateformfieldgroup_tooltip: Optional[StrictStr] = Field(None, alias="tEzsigntemplateformfieldgroupTooltip", description="A tooltip that will be presented to Ezsigntemplatesigner about the Ezsigntemplateformfieldgroup") - e_ezsigntemplateformfieldgroup_tooltipposition: Optional[FieldEEzsigntemplateformfieldgroupTooltipposition] = Field(None, alias="eEzsigntemplateformfieldgroupTooltipposition") - __properties = ["pkiEzsigntemplateformfieldgroupID", "fkiEzsigntemplatedocumentID", "eEzsigntemplateformfieldgroupType", "eEzsigntemplateformfieldgroupSignerrequirement", "sEzsigntemplateformfieldgroupLabel", "iEzsigntemplateformfieldgroupStep", "sEzsigntemplateformfieldgroupDefaultvalue", "iEzsigntemplateformfieldgroupFilledmin", "iEzsigntemplateformfieldgroupFilledmax", "bEzsigntemplateformfieldgroupReadonly", "iEzsigntemplateformfieldgroupMaxlength", "bEzsigntemplateformfieldgroupEncrypted", "sEzsigntemplateformfieldgroupRegexp", "eEzsigntemplateformfieldgroupTextvalidation", "tEzsigntemplateformfieldgroupTooltip", "eEzsigntemplateformfieldgroupTooltipposition"] - - @validator('s_ezsigntemplateformfieldgroup_regexp') + A Ezsigntemplateformfieldgroup Object + """ # noqa: E501 + pki_ezsigntemplateformfieldgroup_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsigntemplateformfieldgroup", alias="pkiEzsigntemplateformfieldgroupID") + fki_ezsigntemplatedocument_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsigntemplatedocument", alias="fkiEzsigntemplatedocumentID") + e_ezsigntemplateformfieldgroup_type: FieldEEzsigntemplateformfieldgroupType = Field(alias="eEzsigntemplateformfieldgroupType") + e_ezsigntemplateformfieldgroup_signerrequirement: FieldEEzsigntemplateformfieldgroupSignerrequirement = Field(alias="eEzsigntemplateformfieldgroupSignerrequirement") + s_ezsigntemplateformfieldgroup_label: Annotated[str, Field(min_length=1, strict=True, max_length=50)] = Field(description="The Label for the Ezsigntemplateformfieldgroup", alias="sEzsigntemplateformfieldgroupLabel") + i_ezsigntemplateformfieldgroup_step: Annotated[int, Field(strict=True, ge=1)] = Field(description="The step when the Ezsigntemplatesigner will be invited to fill the form fields", alias="iEzsigntemplateformfieldgroupStep") + s_ezsigntemplateformfieldgroup_defaultvalue: Optional[StrictStr] = Field(default=None, description="The default value for the Ezsigntemplateformfieldgroup", alias="sEzsigntemplateformfieldgroupDefaultvalue") + i_ezsigntemplateformfieldgroup_filledmin: Annotated[int, Field(strict=True, ge=0)] = Field(description="The minimum number of Ezsigntemplateformfield that must be filled in the Ezsigntemplateformfieldgroup", alias="iEzsigntemplateformfieldgroupFilledmin") + i_ezsigntemplateformfieldgroup_filledmax: Annotated[int, Field(strict=True, ge=0)] = Field(description="The maximum number of Ezsigntemplateformfield that must be filled in the Ezsigntemplateformfieldgroup", alias="iEzsigntemplateformfieldgroupFilledmax") + b_ezsigntemplateformfieldgroup_readonly: StrictBool = Field(description="Whether the Ezsigntemplateformfieldgroup is read only or not.", alias="bEzsigntemplateformfieldgroupReadonly") + i_ezsigntemplateformfieldgroup_maxlength: Optional[Annotated[int, Field(le=65535, strict=True, ge=0)]] = Field(default=None, description="The maximum length for the value in the Ezsigntemplateformfieldgroup This can only be set if eEzsigntemplateformfieldgroupType is **Text** or **Textarea**", alias="iEzsigntemplateformfieldgroupMaxlength") + b_ezsigntemplateformfieldgroup_encrypted: Optional[StrictBool] = Field(default=None, description="Whether the Ezsigntemplateformfieldgroup is encrypted in the database or not. Encrypted values are not displayed on the Ezsigndocument. This can only be set if eEzsigntemplateformfieldgroupType is **Text** or **Textarea**", alias="bEzsigntemplateformfieldgroupEncrypted") + s_ezsigntemplateformfieldgroup_regexp: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="A regular expression to indicate what values are acceptable for the Ezsigntemplateformfieldgroup. This can only be set if eEzsigntemplateformfieldgroupType is **Text** or **Textarea**", alias="sEzsigntemplateformfieldgroupRegexp") + e_ezsigntemplateformfieldgroup_textvalidation: Optional[EnumTextvalidation] = Field(default=None, alias="eEzsigntemplateformfieldgroupTextvalidation") + t_ezsigntemplateformfieldgroup_tooltip: Optional[StrictStr] = Field(default=None, description="A tooltip that will be presented to Ezsigntemplatesigner about the Ezsigntemplateformfieldgroup", alias="tEzsigntemplateformfieldgroupTooltip") + e_ezsigntemplateformfieldgroup_tooltipposition: Optional[FieldEEzsigntemplateformfieldgroupTooltipposition] = Field(default=None, alias="eEzsigntemplateformfieldgroupTooltipposition") + __properties: ClassVar[List[str]] = ["pkiEzsigntemplateformfieldgroupID", "fkiEzsigntemplatedocumentID", "eEzsigntemplateformfieldgroupType", "eEzsigntemplateformfieldgroupSignerrequirement", "sEzsigntemplateformfieldgroupLabel", "iEzsigntemplateformfieldgroupStep", "sEzsigntemplateformfieldgroupDefaultvalue", "iEzsigntemplateformfieldgroupFilledmin", "iEzsigntemplateformfieldgroupFilledmax", "bEzsigntemplateformfieldgroupReadonly", "iEzsigntemplateformfieldgroupMaxlength", "bEzsigntemplateformfieldgroupEncrypted", "sEzsigntemplateformfieldgroupRegexp", "eEzsigntemplateformfieldgroupTextvalidation", "tEzsigntemplateformfieldgroupTooltip", "eEzsigntemplateformfieldgroupTooltipposition"] + + @field_validator('s_ezsigntemplateformfieldgroup_regexp') def s_ezsigntemplateformfieldgroup_regexp_validate_regular_expression(cls, value): """Validates the regular expression""" if value is None: @@ -58,58 +64,71 @@ def s_ezsigntemplateformfieldgroup_regexp_validate_regular_expression(cls, value raise ValueError(r"must validate the regular expression /^\^.*\$$|^$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplateformfieldgroupResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplateformfieldgroupResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplateformfieldgroupResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplateformfieldgroupResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplateformfieldgroupResponse.parse_obj(obj) - - _obj = EzsigntemplateformfieldgroupResponse.parse_obj({ - "pki_ezsigntemplateformfieldgroup_id": obj.get("pkiEzsigntemplateformfieldgroupID"), - "fki_ezsigntemplatedocument_id": obj.get("fkiEzsigntemplatedocumentID"), - "e_ezsigntemplateformfieldgroup_type": obj.get("eEzsigntemplateformfieldgroupType"), - "e_ezsigntemplateformfieldgroup_signerrequirement": obj.get("eEzsigntemplateformfieldgroupSignerrequirement"), - "s_ezsigntemplateformfieldgroup_label": obj.get("sEzsigntemplateformfieldgroupLabel"), - "i_ezsigntemplateformfieldgroup_step": obj.get("iEzsigntemplateformfieldgroupStep"), - "s_ezsigntemplateformfieldgroup_defaultvalue": obj.get("sEzsigntemplateformfieldgroupDefaultvalue"), - "i_ezsigntemplateformfieldgroup_filledmin": obj.get("iEzsigntemplateformfieldgroupFilledmin"), - "i_ezsigntemplateformfieldgroup_filledmax": obj.get("iEzsigntemplateformfieldgroupFilledmax"), - "b_ezsigntemplateformfieldgroup_readonly": obj.get("bEzsigntemplateformfieldgroupReadonly"), - "i_ezsigntemplateformfieldgroup_maxlength": obj.get("iEzsigntemplateformfieldgroupMaxlength"), - "b_ezsigntemplateformfieldgroup_encrypted": obj.get("bEzsigntemplateformfieldgroupEncrypted"), - "s_ezsigntemplateformfieldgroup_regexp": obj.get("sEzsigntemplateformfieldgroupRegexp"), - "e_ezsigntemplateformfieldgroup_textvalidation": obj.get("eEzsigntemplateformfieldgroupTextvalidation"), - "t_ezsigntemplateformfieldgroup_tooltip": obj.get("tEzsigntemplateformfieldgroupTooltip"), - "e_ezsigntemplateformfieldgroup_tooltipposition": obj.get("eEzsigntemplateformfieldgroupTooltipposition") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsigntemplateformfieldgroupID": obj.get("pkiEzsigntemplateformfieldgroupID"), + "fkiEzsigntemplatedocumentID": obj.get("fkiEzsigntemplatedocumentID"), + "eEzsigntemplateformfieldgroupType": obj.get("eEzsigntemplateformfieldgroupType"), + "eEzsigntemplateformfieldgroupSignerrequirement": obj.get("eEzsigntemplateformfieldgroupSignerrequirement"), + "sEzsigntemplateformfieldgroupLabel": obj.get("sEzsigntemplateformfieldgroupLabel"), + "iEzsigntemplateformfieldgroupStep": obj.get("iEzsigntemplateformfieldgroupStep"), + "sEzsigntemplateformfieldgroupDefaultvalue": obj.get("sEzsigntemplateformfieldgroupDefaultvalue"), + "iEzsigntemplateformfieldgroupFilledmin": obj.get("iEzsigntemplateformfieldgroupFilledmin"), + "iEzsigntemplateformfieldgroupFilledmax": obj.get("iEzsigntemplateformfieldgroupFilledmax"), + "bEzsigntemplateformfieldgroupReadonly": obj.get("bEzsigntemplateformfieldgroupReadonly"), + "iEzsigntemplateformfieldgroupMaxlength": obj.get("iEzsigntemplateformfieldgroupMaxlength"), + "bEzsigntemplateformfieldgroupEncrypted": obj.get("bEzsigntemplateformfieldgroupEncrypted"), + "sEzsigntemplateformfieldgroupRegexp": obj.get("sEzsigntemplateformfieldgroupRegexp"), + "eEzsigntemplateformfieldgroupTextvalidation": obj.get("eEzsigntemplateformfieldgroupTextvalidation"), + "tEzsigntemplateformfieldgroupTooltip": obj.get("tEzsigntemplateformfieldgroupTooltip"), + "eEzsigntemplateformfieldgroupTooltipposition": obj.get("eEzsigntemplateformfieldgroupTooltipposition") }) return _obj diff --git a/eZmaxApi/models/ezsigntemplateformfieldgroup_response_compound.py b/eZmaxApi/models/ezsigntemplateformfieldgroup_response_compound.py index 15a09764a..82f513ac3 100644 --- a/eZmaxApi/models/ezsigntemplateformfieldgroup_response_compound.py +++ b/eZmaxApi/models/ezsigntemplateformfieldgroup_response_compound.py @@ -19,8 +19,10 @@ import json -from typing import List, Optional -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint, conlist, constr, validator +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, StrictStr, field_validator +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.custom_dropdown_element_response_compound import CustomDropdownElementResponseCompound from eZmaxApi.models.enum_textvalidation import EnumTextvalidation from eZmaxApi.models.ezsigntemplateformfield_response_compound import EzsigntemplateformfieldResponseCompound @@ -28,33 +30,37 @@ from eZmaxApi.models.field_e_ezsigntemplateformfieldgroup_signerrequirement import FieldEEzsigntemplateformfieldgroupSignerrequirement from eZmaxApi.models.field_e_ezsigntemplateformfieldgroup_tooltipposition import FieldEEzsigntemplateformfieldgroupTooltipposition from eZmaxApi.models.field_e_ezsigntemplateformfieldgroup_type import FieldEEzsigntemplateformfieldgroupType +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplateformfieldgroupResponseCompound(BaseModel): """ - A Ezsigntemplateformfieldgroup Object and children # noqa: E501 - """ - pki_ezsigntemplateformfieldgroup_id: conint(strict=True, ge=0) = Field(..., alias="pkiEzsigntemplateformfieldgroupID", description="The unique ID of the Ezsigntemplateformfieldgroup") - fki_ezsigntemplatedocument_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsigntemplatedocumentID", description="The unique ID of the Ezsigntemplatedocument") - e_ezsigntemplateformfieldgroup_type: FieldEEzsigntemplateformfieldgroupType = Field(..., alias="eEzsigntemplateformfieldgroupType") - e_ezsigntemplateformfieldgroup_signerrequirement: FieldEEzsigntemplateformfieldgroupSignerrequirement = Field(..., alias="eEzsigntemplateformfieldgroupSignerrequirement") - s_ezsigntemplateformfieldgroup_label: constr(strict=True, max_length=50, min_length=1) = Field(..., alias="sEzsigntemplateformfieldgroupLabel", description="The Label for the Ezsigntemplateformfieldgroup") - i_ezsigntemplateformfieldgroup_step: conint(strict=True, ge=1) = Field(..., alias="iEzsigntemplateformfieldgroupStep", description="The step when the Ezsigntemplatesigner will be invited to fill the form fields") - s_ezsigntemplateformfieldgroup_defaultvalue: Optional[StrictStr] = Field(None, alias="sEzsigntemplateformfieldgroupDefaultvalue", description="The default value for the Ezsigntemplateformfieldgroup") - i_ezsigntemplateformfieldgroup_filledmin: conint(strict=True, ge=0) = Field(..., alias="iEzsigntemplateformfieldgroupFilledmin", description="The minimum number of Ezsigntemplateformfield that must be filled in the Ezsigntemplateformfieldgroup") - i_ezsigntemplateformfieldgroup_filledmax: conint(strict=True, ge=0) = Field(..., alias="iEzsigntemplateformfieldgroupFilledmax", description="The maximum number of Ezsigntemplateformfield that must be filled in the Ezsigntemplateformfieldgroup") - b_ezsigntemplateformfieldgroup_readonly: StrictBool = Field(..., alias="bEzsigntemplateformfieldgroupReadonly", description="Whether the Ezsigntemplateformfieldgroup is read only or not.") - i_ezsigntemplateformfieldgroup_maxlength: Optional[conint(strict=True, le=65535, ge=0)] = Field(None, alias="iEzsigntemplateformfieldgroupMaxlength", description="The maximum length for the value in the Ezsigntemplateformfieldgroup This can only be set if eEzsigntemplateformfieldgroupType is **Text** or **Textarea**") - b_ezsigntemplateformfieldgroup_encrypted: Optional[StrictBool] = Field(None, alias="bEzsigntemplateformfieldgroupEncrypted", description="Whether the Ezsigntemplateformfieldgroup is encrypted in the database or not. Encrypted values are not displayed on the Ezsigndocument. This can only be set if eEzsigntemplateformfieldgroupType is **Text** or **Textarea**") - s_ezsigntemplateformfieldgroup_regexp: Optional[constr(strict=True)] = Field(None, alias="sEzsigntemplateformfieldgroupRegexp", description="A regular expression to indicate what values are acceptable for the Ezsigntemplateformfieldgroup. This can only be set if eEzsigntemplateformfieldgroupType is **Text** or **Textarea**") - e_ezsigntemplateformfieldgroup_textvalidation: Optional[EnumTextvalidation] = Field(None, alias="eEzsigntemplateformfieldgroupTextvalidation") - t_ezsigntemplateformfieldgroup_tooltip: Optional[StrictStr] = Field(None, alias="tEzsigntemplateformfieldgroupTooltip", description="A tooltip that will be presented to Ezsigntemplatesigner about the Ezsigntemplateformfieldgroup") - e_ezsigntemplateformfieldgroup_tooltipposition: Optional[FieldEEzsigntemplateformfieldgroupTooltipposition] = Field(None, alias="eEzsigntemplateformfieldgroupTooltipposition") - a_obj_ezsigntemplateformfieldgroupsigner: conlist(EzsigntemplateformfieldgroupsignerResponseCompound) = Field(..., alias="a_objEzsigntemplateformfieldgroupsigner") - a_obj_dropdown_element: Optional[conlist(CustomDropdownElementResponseCompound)] = Field(None, alias="a_objDropdownElement") - a_obj_ezsigntemplateformfield: conlist(EzsigntemplateformfieldResponseCompound) = Field(..., alias="a_objEzsigntemplateformfield") - __properties = ["pkiEzsigntemplateformfieldgroupID", "fkiEzsigntemplatedocumentID", "eEzsigntemplateformfieldgroupType", "eEzsigntemplateformfieldgroupSignerrequirement", "sEzsigntemplateformfieldgroupLabel", "iEzsigntemplateformfieldgroupStep", "sEzsigntemplateformfieldgroupDefaultvalue", "iEzsigntemplateformfieldgroupFilledmin", "iEzsigntemplateformfieldgroupFilledmax", "bEzsigntemplateformfieldgroupReadonly", "iEzsigntemplateformfieldgroupMaxlength", "bEzsigntemplateformfieldgroupEncrypted", "sEzsigntemplateformfieldgroupRegexp", "eEzsigntemplateformfieldgroupTextvalidation", "tEzsigntemplateformfieldgroupTooltip", "eEzsigntemplateformfieldgroupTooltipposition", "a_objEzsigntemplateformfieldgroupsigner", "a_objDropdownElement", "a_objEzsigntemplateformfield"] - - @validator('s_ezsigntemplateformfieldgroup_regexp') + A Ezsigntemplateformfieldgroup Object and children + """ # noqa: E501 + pki_ezsigntemplateformfieldgroup_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsigntemplateformfieldgroup", alias="pkiEzsigntemplateformfieldgroupID") + fki_ezsigntemplatedocument_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsigntemplatedocument", alias="fkiEzsigntemplatedocumentID") + e_ezsigntemplateformfieldgroup_type: FieldEEzsigntemplateformfieldgroupType = Field(alias="eEzsigntemplateformfieldgroupType") + e_ezsigntemplateformfieldgroup_signerrequirement: FieldEEzsigntemplateformfieldgroupSignerrequirement = Field(alias="eEzsigntemplateformfieldgroupSignerrequirement") + s_ezsigntemplateformfieldgroup_label: Annotated[str, Field(min_length=1, strict=True, max_length=50)] = Field(description="The Label for the Ezsigntemplateformfieldgroup", alias="sEzsigntemplateformfieldgroupLabel") + i_ezsigntemplateformfieldgroup_step: Annotated[int, Field(strict=True, ge=1)] = Field(description="The step when the Ezsigntemplatesigner will be invited to fill the form fields", alias="iEzsigntemplateformfieldgroupStep") + s_ezsigntemplateformfieldgroup_defaultvalue: Optional[StrictStr] = Field(default=None, description="The default value for the Ezsigntemplateformfieldgroup", alias="sEzsigntemplateformfieldgroupDefaultvalue") + i_ezsigntemplateformfieldgroup_filledmin: Annotated[int, Field(strict=True, ge=0)] = Field(description="The minimum number of Ezsigntemplateformfield that must be filled in the Ezsigntemplateformfieldgroup", alias="iEzsigntemplateformfieldgroupFilledmin") + i_ezsigntemplateformfieldgroup_filledmax: Annotated[int, Field(strict=True, ge=0)] = Field(description="The maximum number of Ezsigntemplateformfield that must be filled in the Ezsigntemplateformfieldgroup", alias="iEzsigntemplateformfieldgroupFilledmax") + b_ezsigntemplateformfieldgroup_readonly: StrictBool = Field(description="Whether the Ezsigntemplateformfieldgroup is read only or not.", alias="bEzsigntemplateformfieldgroupReadonly") + i_ezsigntemplateformfieldgroup_maxlength: Optional[Annotated[int, Field(le=65535, strict=True, ge=0)]] = Field(default=None, description="The maximum length for the value in the Ezsigntemplateformfieldgroup This can only be set if eEzsigntemplateformfieldgroupType is **Text** or **Textarea**", alias="iEzsigntemplateformfieldgroupMaxlength") + b_ezsigntemplateformfieldgroup_encrypted: Optional[StrictBool] = Field(default=None, description="Whether the Ezsigntemplateformfieldgroup is encrypted in the database or not. Encrypted values are not displayed on the Ezsigndocument. This can only be set if eEzsigntemplateformfieldgroupType is **Text** or **Textarea**", alias="bEzsigntemplateformfieldgroupEncrypted") + s_ezsigntemplateformfieldgroup_regexp: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="A regular expression to indicate what values are acceptable for the Ezsigntemplateformfieldgroup. This can only be set if eEzsigntemplateformfieldgroupType is **Text** or **Textarea**", alias="sEzsigntemplateformfieldgroupRegexp") + e_ezsigntemplateformfieldgroup_textvalidation: Optional[EnumTextvalidation] = Field(default=None, alias="eEzsigntemplateformfieldgroupTextvalidation") + t_ezsigntemplateformfieldgroup_tooltip: Optional[StrictStr] = Field(default=None, description="A tooltip that will be presented to Ezsigntemplatesigner about the Ezsigntemplateformfieldgroup", alias="tEzsigntemplateformfieldgroupTooltip") + e_ezsigntemplateformfieldgroup_tooltipposition: Optional[FieldEEzsigntemplateformfieldgroupTooltipposition] = Field(default=None, alias="eEzsigntemplateformfieldgroupTooltipposition") + a_obj_ezsigntemplateformfieldgroupsigner: List[EzsigntemplateformfieldgroupsignerResponseCompound] = Field(alias="a_objEzsigntemplateformfieldgroupsigner") + a_obj_dropdown_element: Optional[List[CustomDropdownElementResponseCompound]] = Field(default=None, alias="a_objDropdownElement") + a_obj_ezsigntemplateformfield: List[EzsigntemplateformfieldResponseCompound] = Field(alias="a_objEzsigntemplateformfield") + __properties: ClassVar[List[str]] = ["pkiEzsigntemplateformfieldgroupID", "fkiEzsigntemplatedocumentID", "eEzsigntemplateformfieldgroupType", "eEzsigntemplateformfieldgroupSignerrequirement", "sEzsigntemplateformfieldgroupLabel", "iEzsigntemplateformfieldgroupStep", "sEzsigntemplateformfieldgroupDefaultvalue", "iEzsigntemplateformfieldgroupFilledmin", "iEzsigntemplateformfieldgroupFilledmax", "bEzsigntemplateformfieldgroupReadonly", "iEzsigntemplateformfieldgroupMaxlength", "bEzsigntemplateformfieldgroupEncrypted", "sEzsigntemplateformfieldgroupRegexp", "eEzsigntemplateformfieldgroupTextvalidation", "tEzsigntemplateformfieldgroupTooltip", "eEzsigntemplateformfieldgroupTooltipposition", "a_objEzsigntemplateformfieldgroupsigner", "a_objDropdownElement", "a_objEzsigntemplateformfield"] + + @field_validator('s_ezsigntemplateformfieldgroup_regexp') def s_ezsigntemplateformfieldgroup_regexp_validate_regular_expression(cls, value): """Validates the regular expression""" if value is None: @@ -64,30 +70,43 @@ def s_ezsigntemplateformfieldgroup_regexp_validate_regular_expression(cls, value raise ValueError(r"must validate the regular expression /^\^.*\$$|^$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplateformfieldgroupResponseCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplateformfieldgroupResponseCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_ezsigntemplateformfieldgroupsigner (list) _items = [] if self.a_obj_ezsigntemplateformfieldgroupsigner: @@ -112,34 +131,34 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplateformfieldgroupResponseCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplateformfieldgroupResponseCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplateformfieldgroupResponseCompound.parse_obj(obj) - - _obj = EzsigntemplateformfieldgroupResponseCompound.parse_obj({ - "pki_ezsigntemplateformfieldgroup_id": obj.get("pkiEzsigntemplateformfieldgroupID"), - "fki_ezsigntemplatedocument_id": obj.get("fkiEzsigntemplatedocumentID"), - "e_ezsigntemplateformfieldgroup_type": obj.get("eEzsigntemplateformfieldgroupType"), - "e_ezsigntemplateformfieldgroup_signerrequirement": obj.get("eEzsigntemplateformfieldgroupSignerrequirement"), - "s_ezsigntemplateformfieldgroup_label": obj.get("sEzsigntemplateformfieldgroupLabel"), - "i_ezsigntemplateformfieldgroup_step": obj.get("iEzsigntemplateformfieldgroupStep"), - "s_ezsigntemplateformfieldgroup_defaultvalue": obj.get("sEzsigntemplateformfieldgroupDefaultvalue"), - "i_ezsigntemplateformfieldgroup_filledmin": obj.get("iEzsigntemplateformfieldgroupFilledmin"), - "i_ezsigntemplateformfieldgroup_filledmax": obj.get("iEzsigntemplateformfieldgroupFilledmax"), - "b_ezsigntemplateformfieldgroup_readonly": obj.get("bEzsigntemplateformfieldgroupReadonly"), - "i_ezsigntemplateformfieldgroup_maxlength": obj.get("iEzsigntemplateformfieldgroupMaxlength"), - "b_ezsigntemplateformfieldgroup_encrypted": obj.get("bEzsigntemplateformfieldgroupEncrypted"), - "s_ezsigntemplateformfieldgroup_regexp": obj.get("sEzsigntemplateformfieldgroupRegexp"), - "e_ezsigntemplateformfieldgroup_textvalidation": obj.get("eEzsigntemplateformfieldgroupTextvalidation"), - "t_ezsigntemplateformfieldgroup_tooltip": obj.get("tEzsigntemplateformfieldgroupTooltip"), - "e_ezsigntemplateformfieldgroup_tooltipposition": obj.get("eEzsigntemplateformfieldgroupTooltipposition"), - "a_obj_ezsigntemplateformfieldgroupsigner": [EzsigntemplateformfieldgroupsignerResponseCompound.from_dict(_item) for _item in obj.get("a_objEzsigntemplateformfieldgroupsigner")] if obj.get("a_objEzsigntemplateformfieldgroupsigner") is not None else None, - "a_obj_dropdown_element": [CustomDropdownElementResponseCompound.from_dict(_item) for _item in obj.get("a_objDropdownElement")] if obj.get("a_objDropdownElement") is not None else None, - "a_obj_ezsigntemplateformfield": [EzsigntemplateformfieldResponseCompound.from_dict(_item) for _item in obj.get("a_objEzsigntemplateformfield")] if obj.get("a_objEzsigntemplateformfield") is not None else None + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsigntemplateformfieldgroupID": obj.get("pkiEzsigntemplateformfieldgroupID"), + "fkiEzsigntemplatedocumentID": obj.get("fkiEzsigntemplatedocumentID"), + "eEzsigntemplateformfieldgroupType": obj.get("eEzsigntemplateformfieldgroupType"), + "eEzsigntemplateformfieldgroupSignerrequirement": obj.get("eEzsigntemplateformfieldgroupSignerrequirement"), + "sEzsigntemplateformfieldgroupLabel": obj.get("sEzsigntemplateformfieldgroupLabel"), + "iEzsigntemplateformfieldgroupStep": obj.get("iEzsigntemplateformfieldgroupStep"), + "sEzsigntemplateformfieldgroupDefaultvalue": obj.get("sEzsigntemplateformfieldgroupDefaultvalue"), + "iEzsigntemplateformfieldgroupFilledmin": obj.get("iEzsigntemplateformfieldgroupFilledmin"), + "iEzsigntemplateformfieldgroupFilledmax": obj.get("iEzsigntemplateformfieldgroupFilledmax"), + "bEzsigntemplateformfieldgroupReadonly": obj.get("bEzsigntemplateformfieldgroupReadonly"), + "iEzsigntemplateformfieldgroupMaxlength": obj.get("iEzsigntemplateformfieldgroupMaxlength"), + "bEzsigntemplateformfieldgroupEncrypted": obj.get("bEzsigntemplateformfieldgroupEncrypted"), + "sEzsigntemplateformfieldgroupRegexp": obj.get("sEzsigntemplateformfieldgroupRegexp"), + "eEzsigntemplateformfieldgroupTextvalidation": obj.get("eEzsigntemplateformfieldgroupTextvalidation"), + "tEzsigntemplateformfieldgroupTooltip": obj.get("tEzsigntemplateformfieldgroupTooltip"), + "eEzsigntemplateformfieldgroupTooltipposition": obj.get("eEzsigntemplateformfieldgroupTooltipposition"), + "a_objEzsigntemplateformfieldgroupsigner": [EzsigntemplateformfieldgroupsignerResponseCompound.from_dict(_item) for _item in obj.get("a_objEzsigntemplateformfieldgroupsigner")] if obj.get("a_objEzsigntemplateformfieldgroupsigner") is not None else None, + "a_objDropdownElement": [CustomDropdownElementResponseCompound.from_dict(_item) for _item in obj.get("a_objDropdownElement")] if obj.get("a_objDropdownElement") is not None else None, + "a_objEzsigntemplateformfield": [EzsigntemplateformfieldResponseCompound.from_dict(_item) for _item in obj.get("a_objEzsigntemplateformfield")] if obj.get("a_objEzsigntemplateformfield") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigntemplateformfieldgroupsigner_request.py b/eZmaxApi/models/ezsigntemplateformfieldgroupsigner_request.py index 4e92d0e49..ae21fccca 100644 --- a/eZmaxApi/models/ezsigntemplateformfieldgroupsigner_request.py +++ b/eZmaxApi/models/ezsigntemplateformfieldgroupsigner_request.py @@ -19,55 +19,74 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplateformfieldgroupsignerRequest(BaseModel): """ - A Ezsigntemplateformfieldgroupsigner Object # noqa: E501 - """ - pki_ezsigntemplateformfieldgroupsigner_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="pkiEzsigntemplateformfieldgroupsignerID", description="The unique ID of the Ezsigntemplateformfieldgroupsigner") - fki_ezsigntemplatesigner_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsigntemplatesignerID", description="The unique ID of the Ezsigntemplatesigner") - __properties = ["pkiEzsigntemplateformfieldgroupsignerID", "fkiEzsigntemplatesignerID"] + A Ezsigntemplateformfieldgroupsigner Object + """ # noqa: E501 + pki_ezsigntemplateformfieldgroupsigner_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsigntemplateformfieldgroupsigner", alias="pkiEzsigntemplateformfieldgroupsignerID") + fki_ezsigntemplatesigner_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsigntemplatesigner", alias="fkiEzsigntemplatesignerID") + __properties: ClassVar[List[str]] = ["pkiEzsigntemplateformfieldgroupsignerID", "fkiEzsigntemplatesignerID"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplateformfieldgroupsignerRequest: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplateformfieldgroupsignerRequest from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplateformfieldgroupsignerRequest: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplateformfieldgroupsignerRequest from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplateformfieldgroupsignerRequest.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplateformfieldgroupsignerRequest.parse_obj({ - "pki_ezsigntemplateformfieldgroupsigner_id": obj.get("pkiEzsigntemplateformfieldgroupsignerID"), - "fki_ezsigntemplatesigner_id": obj.get("fkiEzsigntemplatesignerID") + _obj = cls.model_validate({ + "pkiEzsigntemplateformfieldgroupsignerID": obj.get("pkiEzsigntemplateformfieldgroupsignerID"), + "fkiEzsigntemplatesignerID": obj.get("fkiEzsigntemplatesignerID") }) return _obj diff --git a/eZmaxApi/models/ezsigntemplateformfieldgroupsigner_request_compound.py b/eZmaxApi/models/ezsigntemplateformfieldgroupsigner_request_compound.py index a959905ba..a4c78d8c5 100644 --- a/eZmaxApi/models/ezsigntemplateformfieldgroupsigner_request_compound.py +++ b/eZmaxApi/models/ezsigntemplateformfieldgroupsigner_request_compound.py @@ -19,55 +19,74 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplateformfieldgroupsignerRequestCompound(BaseModel): """ - An Ezsigntemplateformfieldgroupsigner Object and children to create a complete structure # noqa: E501 - """ - pki_ezsigntemplateformfieldgroupsigner_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="pkiEzsigntemplateformfieldgroupsignerID", description="The unique ID of the Ezsigntemplateformfieldgroupsigner") - fki_ezsigntemplatesigner_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsigntemplatesignerID", description="The unique ID of the Ezsigntemplatesigner") - __properties = ["pkiEzsigntemplateformfieldgroupsignerID", "fkiEzsigntemplatesignerID"] + An Ezsigntemplateformfieldgroupsigner Object and children to create a complete structure + """ # noqa: E501 + pki_ezsigntemplateformfieldgroupsigner_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsigntemplateformfieldgroupsigner", alias="pkiEzsigntemplateformfieldgroupsignerID") + fki_ezsigntemplatesigner_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsigntemplatesigner", alias="fkiEzsigntemplatesignerID") + __properties: ClassVar[List[str]] = ["pkiEzsigntemplateformfieldgroupsignerID", "fkiEzsigntemplatesignerID"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplateformfieldgroupsignerRequestCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplateformfieldgroupsignerRequestCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplateformfieldgroupsignerRequestCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplateformfieldgroupsignerRequestCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplateformfieldgroupsignerRequestCompound.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplateformfieldgroupsignerRequestCompound.parse_obj({ - "pki_ezsigntemplateformfieldgroupsigner_id": obj.get("pkiEzsigntemplateformfieldgroupsignerID"), - "fki_ezsigntemplatesigner_id": obj.get("fkiEzsigntemplatesignerID") + _obj = cls.model_validate({ + "pkiEzsigntemplateformfieldgroupsignerID": obj.get("pkiEzsigntemplateformfieldgroupsignerID"), + "fkiEzsigntemplatesignerID": obj.get("fkiEzsigntemplatesignerID") }) return _obj diff --git a/eZmaxApi/models/ezsigntemplateformfieldgroupsigner_response.py b/eZmaxApi/models/ezsigntemplateformfieldgroupsigner_response.py index 45cde0d43..ac61a9c24 100644 --- a/eZmaxApi/models/ezsigntemplateformfieldgroupsigner_response.py +++ b/eZmaxApi/models/ezsigntemplateformfieldgroupsigner_response.py @@ -19,55 +19,74 @@ import json - -from pydantic import BaseModel, Field, conint +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplateformfieldgroupsignerResponse(BaseModel): """ - A Ezsigntemplateformfieldgroupsigner Object # noqa: E501 - """ - pki_ezsigntemplateformfieldgroupsigner_id: conint(strict=True, ge=0) = Field(..., alias="pkiEzsigntemplateformfieldgroupsignerID", description="The unique ID of the Ezsigntemplateformfieldgroupsigner") - fki_ezsigntemplatesigner_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsigntemplatesignerID", description="The unique ID of the Ezsigntemplatesigner") - __properties = ["pkiEzsigntemplateformfieldgroupsignerID", "fkiEzsigntemplatesignerID"] + A Ezsigntemplateformfieldgroupsigner Object + """ # noqa: E501 + pki_ezsigntemplateformfieldgroupsigner_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsigntemplateformfieldgroupsigner", alias="pkiEzsigntemplateformfieldgroupsignerID") + fki_ezsigntemplatesigner_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsigntemplatesigner", alias="fkiEzsigntemplatesignerID") + __properties: ClassVar[List[str]] = ["pkiEzsigntemplateformfieldgroupsignerID", "fkiEzsigntemplatesignerID"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplateformfieldgroupsignerResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplateformfieldgroupsignerResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplateformfieldgroupsignerResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplateformfieldgroupsignerResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplateformfieldgroupsignerResponse.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplateformfieldgroupsignerResponse.parse_obj({ - "pki_ezsigntemplateformfieldgroupsigner_id": obj.get("pkiEzsigntemplateformfieldgroupsignerID"), - "fki_ezsigntemplatesigner_id": obj.get("fkiEzsigntemplatesignerID") + _obj = cls.model_validate({ + "pkiEzsigntemplateformfieldgroupsignerID": obj.get("pkiEzsigntemplateformfieldgroupsignerID"), + "fkiEzsigntemplatesignerID": obj.get("fkiEzsigntemplatesignerID") }) return _obj diff --git a/eZmaxApi/models/ezsigntemplateformfieldgroupsigner_response_compound.py b/eZmaxApi/models/ezsigntemplateformfieldgroupsigner_response_compound.py index 610586de4..1ac606b7d 100644 --- a/eZmaxApi/models/ezsigntemplateformfieldgroupsigner_response_compound.py +++ b/eZmaxApi/models/ezsigntemplateformfieldgroupsigner_response_compound.py @@ -19,55 +19,74 @@ import json - -from pydantic import BaseModel, Field, conint +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplateformfieldgroupsignerResponseCompound(BaseModel): """ - An Ezsigntemplateformfieldgroupsigner Object and children # noqa: E501 - """ - pki_ezsigntemplateformfieldgroupsigner_id: conint(strict=True, ge=0) = Field(..., alias="pkiEzsigntemplateformfieldgroupsignerID", description="The unique ID of the Ezsigntemplateformfieldgroupsigner") - fki_ezsigntemplatesigner_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsigntemplatesignerID", description="The unique ID of the Ezsigntemplatesigner") - __properties = ["pkiEzsigntemplateformfieldgroupsignerID", "fkiEzsigntemplatesignerID"] + An Ezsigntemplateformfieldgroupsigner Object and children + """ # noqa: E501 + pki_ezsigntemplateformfieldgroupsigner_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsigntemplateformfieldgroupsigner", alias="pkiEzsigntemplateformfieldgroupsignerID") + fki_ezsigntemplatesigner_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsigntemplatesigner", alias="fkiEzsigntemplatesignerID") + __properties: ClassVar[List[str]] = ["pkiEzsigntemplateformfieldgroupsignerID", "fkiEzsigntemplatesignerID"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplateformfieldgroupsignerResponseCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplateformfieldgroupsignerResponseCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplateformfieldgroupsignerResponseCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplateformfieldgroupsignerResponseCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplateformfieldgroupsignerResponseCompound.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplateformfieldgroupsignerResponseCompound.parse_obj({ - "pki_ezsigntemplateformfieldgroupsigner_id": obj.get("pkiEzsigntemplateformfieldgroupsignerID"), - "fki_ezsigntemplatesigner_id": obj.get("fkiEzsigntemplatesignerID") + _obj = cls.model_validate({ + "pkiEzsigntemplateformfieldgroupsignerID": obj.get("pkiEzsigntemplateformfieldgroupsignerID"), + "fkiEzsigntemplatesignerID": obj.get("fkiEzsigntemplatesignerID") }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatepackage_autocomplete_element_response.py b/eZmaxApi/models/ezsigntemplatepackage_autocomplete_element_response.py index caf2169fa..5148b51c7 100644 --- a/eZmaxApi/models/ezsigntemplatepackage_autocomplete_element_response.py +++ b/eZmaxApi/models/ezsigntemplatepackage_autocomplete_element_response.py @@ -19,62 +19,81 @@ import json - -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictBool, StrictStr +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.field_e_ezsignfoldertype_privacylevel import FieldEEzsignfoldertypePrivacylevel +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatepackageAutocompleteElementResponse(BaseModel): """ - A Ezsigntemplatepackage AutocompleteElement Response # noqa: E501 - """ - e_ezsignfoldertype_privacylevel: FieldEEzsignfoldertypePrivacylevel = Field(..., alias="eEzsignfoldertypePrivacylevel") - s_ezsigntemplatepackage_description: StrictStr = Field(..., alias="sEzsigntemplatepackageDescription", description="The description of the Ezsigntemplatepackage") - pki_ezsigntemplatepackage_id: conint(strict=True, ge=0) = Field(..., alias="pkiEzsigntemplatepackageID", description="The unique ID of the Ezsigntemplatepackage") - b_ezsigntemplatepackage_isactive: StrictBool = Field(..., alias="bEzsigntemplatepackageIsactive", description="Whether the Ezsigntemplatepackage is active or not") - b_disabled: StrictBool = Field(..., alias="bDisabled", description="Indicates if the element is disabled in the context") - __properties = ["eEzsignfoldertypePrivacylevel", "sEzsigntemplatepackageDescription", "pkiEzsigntemplatepackageID", "bEzsigntemplatepackageIsactive", "bDisabled"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + A Ezsigntemplatepackage AutocompleteElement Response + """ # noqa: E501 + e_ezsignfoldertype_privacylevel: FieldEEzsignfoldertypePrivacylevel = Field(alias="eEzsignfoldertypePrivacylevel") + s_ezsigntemplatepackage_description: StrictStr = Field(description="The description of the Ezsigntemplatepackage", alias="sEzsigntemplatepackageDescription") + pki_ezsigntemplatepackage_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsigntemplatepackage", alias="pkiEzsigntemplatepackageID") + b_ezsigntemplatepackage_isactive: StrictBool = Field(description="Whether the Ezsigntemplatepackage is active or not", alias="bEzsigntemplatepackageIsactive") + b_disabled: StrictBool = Field(description="Indicates if the element is disabled in the context", alias="bDisabled") + __properties: ClassVar[List[str]] = ["eEzsignfoldertypePrivacylevel", "sEzsigntemplatepackageDescription", "pkiEzsigntemplatepackageID", "bEzsigntemplatepackageIsactive", "bDisabled"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatepackageAutocompleteElementResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatepackageAutocompleteElementResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatepackageAutocompleteElementResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatepackageAutocompleteElementResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatepackageAutocompleteElementResponse.parse_obj(obj) - - _obj = EzsigntemplatepackageAutocompleteElementResponse.parse_obj({ - "e_ezsignfoldertype_privacylevel": obj.get("eEzsignfoldertypePrivacylevel"), - "s_ezsigntemplatepackage_description": obj.get("sEzsigntemplatepackageDescription"), - "pki_ezsigntemplatepackage_id": obj.get("pkiEzsigntemplatepackageID"), - "b_ezsigntemplatepackage_isactive": obj.get("bEzsigntemplatepackageIsactive"), - "b_disabled": obj.get("bDisabled") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "eEzsignfoldertypePrivacylevel": obj.get("eEzsignfoldertypePrivacylevel"), + "sEzsigntemplatepackageDescription": obj.get("sEzsigntemplatepackageDescription"), + "pkiEzsigntemplatepackageID": obj.get("pkiEzsigntemplatepackageID"), + "bEzsigntemplatepackageIsactive": obj.get("bEzsigntemplatepackageIsactive"), + "bDisabled": obj.get("bDisabled") }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatepackage_create_object_v1_request.py b/eZmaxApi/models/ezsigntemplatepackage_create_object_v1_request.py index c1b5be8d6..124684d67 100644 --- a/eZmaxApi/models/ezsigntemplatepackage_create_object_v1_request.py +++ b/eZmaxApi/models/ezsigntemplatepackage_create_object_v1_request.py @@ -19,41 +19,60 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.ezsigntemplatepackage_request_compound import EzsigntemplatepackageRequestCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatepackageCreateObjectV1Request(BaseModel): """ - Request for POST /1/object/ezsigntemplatepackage # noqa: E501 - """ - a_obj_ezsigntemplatepackage: conlist(EzsigntemplatepackageRequestCompound, min_items=1) = Field(..., alias="a_objEzsigntemplatepackage") - __properties = ["a_objEzsigntemplatepackage"] + Request for POST /1/object/ezsigntemplatepackage + """ # noqa: E501 + a_obj_ezsigntemplatepackage: Annotated[List[EzsigntemplatepackageRequestCompound], Field(min_length=1)] = Field(alias="a_objEzsigntemplatepackage") + __properties: ClassVar[List[str]] = ["a_objEzsigntemplatepackage"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatepackageCreateObjectV1Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatepackageCreateObjectV1Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_ezsigntemplatepackage (list) _items = [] if self.a_obj_ezsigntemplatepackage: @@ -64,16 +83,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatepackageCreateObjectV1Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatepackageCreateObjectV1Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatepackageCreateObjectV1Request.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplatepackageCreateObjectV1Request.parse_obj({ - "a_obj_ezsigntemplatepackage": [EzsigntemplatepackageRequestCompound.from_dict(_item) for _item in obj.get("a_objEzsigntemplatepackage")] if obj.get("a_objEzsigntemplatepackage") is not None else None + _obj = cls.model_validate({ + "a_objEzsigntemplatepackage": [EzsigntemplatepackageRequestCompound.from_dict(_item) for _item in obj.get("a_objEzsigntemplatepackage")] if obj.get("a_objEzsigntemplatepackage") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatepackage_create_object_v1_response.py b/eZmaxApi/models/ezsigntemplatepackage_create_object_v1_response.py index d5fb70329..84b25ed5f 100644 --- a/eZmaxApi/models/ezsigntemplatepackage_create_object_v1_response.py +++ b/eZmaxApi/models/ezsigntemplatepackage_create_object_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.ezsigntemplatepackage_create_object_v1_response_m_payload import EzsigntemplatepackageCreateObjectV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatepackageCreateObjectV1Response(BaseModel): """ - Response for POST /1/object/ezsigntemplatepackage # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzsigntemplatepackageCreateObjectV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for POST /1/object/ezsigntemplatepackage + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsigntemplatepackageCreateObjectV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatepackageCreateObjectV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatepackageCreateObjectV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatepackageCreateObjectV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatepackageCreateObjectV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatepackageCreateObjectV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplatepackageCreateObjectV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzsigntemplatepackageCreateObjectV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsigntemplatepackageCreateObjectV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatepackage_create_object_v1_response_m_payload.py b/eZmaxApi/models/ezsigntemplatepackage_create_object_v1_response_m_payload.py index c03cfcd4b..06d8ff1f6 100644 --- a/eZmaxApi/models/ezsigntemplatepackage_create_object_v1_response_m_payload.py +++ b/eZmaxApi/models/ezsigntemplatepackage_create_object_v1_response_m_payload.py @@ -19,53 +19,72 @@ import json -from typing import List -from pydantic import BaseModel, Field, conint, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatepackageCreateObjectV1ResponseMPayload(BaseModel): """ - Payload for POST /1/object/ezsigntemplatepackage # noqa: E501 - """ - a_pki_ezsigntemplatepackage_id: conlist(conint(strict=True, ge=0), min_items=1) = Field(..., alias="a_pkiEzsigntemplatepackageID", description="An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request.") - __properties = ["a_pkiEzsigntemplatepackageID"] + Payload for POST /1/object/ezsigntemplatepackage + """ # noqa: E501 + a_pki_ezsigntemplatepackage_id: Annotated[List[Annotated[int, Field(strict=True, ge=0)]], Field(min_length=1)] = Field(description="An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request.", alias="a_pkiEzsigntemplatepackageID") + __properties: ClassVar[List[str]] = ["a_pkiEzsigntemplatepackageID"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatepackageCreateObjectV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatepackageCreateObjectV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatepackageCreateObjectV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatepackageCreateObjectV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatepackageCreateObjectV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplatepackageCreateObjectV1ResponseMPayload.parse_obj({ - "a_pki_ezsigntemplatepackage_id": obj.get("a_pkiEzsigntemplatepackageID") + _obj = cls.model_validate({ + "a_pkiEzsigntemplatepackageID": obj.get("a_pkiEzsigntemplatepackageID") }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatepackage_delete_object_v1_response.py b/eZmaxApi/models/ezsigntemplatepackage_delete_object_v1_response.py index b38c1b5b8..7a4cae23d 100644 --- a/eZmaxApi/models/ezsigntemplatepackage_delete_object_v1_response.py +++ b/eZmaxApi/models/ezsigntemplatepackage_delete_object_v1_response.py @@ -19,43 +19,61 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatepackageDeleteObjectV1Response(BaseModel): """ - Response for DELETE /1/object/ezsigntemplatepackage/{pkiEzsigntemplatepackageID} # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - __properties = ["objDebugPayload", "objDebug"] + Response for DELETE /1/object/ezsigntemplatepackage/{pkiEzsigntemplatepackageID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatepackageDeleteObjectV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatepackageDeleteObjectV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -65,17 +83,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatepackageDeleteObjectV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatepackageDeleteObjectV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatepackageDeleteObjectV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplatepackageDeleteObjectV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatepackage_edit_ezsigntemplatepackagesigners_v1_request.py b/eZmaxApi/models/ezsigntemplatepackage_edit_ezsigntemplatepackagesigners_v1_request.py index 7730d4d15..b1c56f1c4 100644 --- a/eZmaxApi/models/ezsigntemplatepackage_edit_ezsigntemplatepackagesigners_v1_request.py +++ b/eZmaxApi/models/ezsigntemplatepackage_edit_ezsigntemplatepackagesigners_v1_request.py @@ -19,41 +19,59 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.ezsigntemplatepackagesigner_request_compound import EzsigntemplatepackagesignerRequestCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatepackageEditEzsigntemplatepackagesignersV1Request(BaseModel): """ - Request for PUT /1/object/ezsigntemplatepackage/{pkiEzsigntemplatepackageID}/editEzsigntemplatepackagesigners # noqa: E501 - """ - a_obj_ezsigntemplatepackagesigner: conlist(EzsigntemplatepackagesignerRequestCompound) = Field(..., alias="a_objEzsigntemplatepackagesigner") - __properties = ["a_objEzsigntemplatepackagesigner"] + Request for PUT /1/object/ezsigntemplatepackage/{pkiEzsigntemplatepackageID}/editEzsigntemplatepackagesigners + """ # noqa: E501 + a_obj_ezsigntemplatepackagesigner: List[EzsigntemplatepackagesignerRequestCompound] = Field(alias="a_objEzsigntemplatepackagesigner") + __properties: ClassVar[List[str]] = ["a_objEzsigntemplatepackagesigner"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatepackageEditEzsigntemplatepackagesignersV1Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatepackageEditEzsigntemplatepackagesignersV1Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_ezsigntemplatepackagesigner (list) _items = [] if self.a_obj_ezsigntemplatepackagesigner: @@ -64,16 +82,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatepackageEditEzsigntemplatepackagesignersV1Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatepackageEditEzsigntemplatepackagesignersV1Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatepackageEditEzsigntemplatepackagesignersV1Request.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplatepackageEditEzsigntemplatepackagesignersV1Request.parse_obj({ - "a_obj_ezsigntemplatepackagesigner": [EzsigntemplatepackagesignerRequestCompound.from_dict(_item) for _item in obj.get("a_objEzsigntemplatepackagesigner")] if obj.get("a_objEzsigntemplatepackagesigner") is not None else None + _obj = cls.model_validate({ + "a_objEzsigntemplatepackagesigner": [EzsigntemplatepackagesignerRequestCompound.from_dict(_item) for _item in obj.get("a_objEzsigntemplatepackagesigner")] if obj.get("a_objEzsigntemplatepackagesigner") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatepackage_edit_ezsigntemplatepackagesigners_v1_response.py b/eZmaxApi/models/ezsigntemplatepackage_edit_ezsigntemplatepackagesigners_v1_response.py index ee9e2547d..56954dde2 100644 --- a/eZmaxApi/models/ezsigntemplatepackage_edit_ezsigntemplatepackagesigners_v1_response.py +++ b/eZmaxApi/models/ezsigntemplatepackage_edit_ezsigntemplatepackagesigners_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.ezsigntemplatepackage_edit_ezsigntemplatepackagesigners_v1_response_m_payload import EzsigntemplatepackageEditEzsigntemplatepackagesignersV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatepackageEditEzsigntemplatepackagesignersV1Response(BaseModel): """ - Response for PUT /1/object/ezsigntemplatepackage/{pkiEzsigntemplatepackageID}/editEzsigntemplatepackagesigners # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzsigntemplatepackageEditEzsigntemplatepackagesignersV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for PUT /1/object/ezsigntemplatepackage/{pkiEzsigntemplatepackageID}/editEzsigntemplatepackagesigners + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsigntemplatepackageEditEzsigntemplatepackagesignersV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatepackageEditEzsigntemplatepackagesignersV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatepackageEditEzsigntemplatepackagesignersV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatepackageEditEzsigntemplatepackagesignersV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatepackageEditEzsigntemplatepackagesignersV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatepackageEditEzsigntemplatepackagesignersV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplatepackageEditEzsigntemplatepackagesignersV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzsigntemplatepackageEditEzsigntemplatepackagesignersV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsigntemplatepackageEditEzsigntemplatepackagesignersV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatepackage_edit_ezsigntemplatepackagesigners_v1_response_m_payload.py b/eZmaxApi/models/ezsigntemplatepackage_edit_ezsigntemplatepackagesigners_v1_response_m_payload.py index 4d1888ce6..3d07d0f12 100644 --- a/eZmaxApi/models/ezsigntemplatepackage_edit_ezsigntemplatepackagesigners_v1_response_m_payload.py +++ b/eZmaxApi/models/ezsigntemplatepackage_edit_ezsigntemplatepackagesigners_v1_response_m_payload.py @@ -19,53 +19,72 @@ import json -from typing import List -from pydantic import BaseModel, Field, conint, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatepackageEditEzsigntemplatepackagesignersV1ResponseMPayload(BaseModel): """ - Payload for PUT /1/object/ezsigntemplatepackage/{pkiEzsigntemplatepackageID}/editEzsigntemplatepackagesigners # noqa: E501 - """ - a_pki_ezsigntemplatepackagesigner_id: conlist(conint(strict=True, ge=0)) = Field(..., alias="a_pkiEzsigntemplatepackagesignerID") - __properties = ["a_pkiEzsigntemplatepackagesignerID"] + Payload for PUT /1/object/ezsigntemplatepackage/{pkiEzsigntemplatepackageID}/editEzsigntemplatepackagesigners + """ # noqa: E501 + a_pki_ezsigntemplatepackagesigner_id: List[Annotated[int, Field(strict=True, ge=0)]] = Field(alias="a_pkiEzsigntemplatepackagesignerID") + __properties: ClassVar[List[str]] = ["a_pkiEzsigntemplatepackagesignerID"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatepackageEditEzsigntemplatepackagesignersV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatepackageEditEzsigntemplatepackagesignersV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatepackageEditEzsigntemplatepackagesignersV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatepackageEditEzsigntemplatepackagesignersV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatepackageEditEzsigntemplatepackagesignersV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplatepackageEditEzsigntemplatepackagesignersV1ResponseMPayload.parse_obj({ - "a_pki_ezsigntemplatepackagesigner_id": obj.get("a_pkiEzsigntemplatepackagesignerID") + _obj = cls.model_validate({ + "a_pkiEzsigntemplatepackagesignerID": obj.get("a_pkiEzsigntemplatepackagesignerID") }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatepackage_edit_object_v1_request.py b/eZmaxApi/models/ezsigntemplatepackage_edit_object_v1_request.py index db99b1cbf..14b06ddfc 100644 --- a/eZmaxApi/models/ezsigntemplatepackage_edit_object_v1_request.py +++ b/eZmaxApi/models/ezsigntemplatepackage_edit_object_v1_request.py @@ -19,57 +19,75 @@ import json - -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.ezsigntemplatepackage_request_compound import EzsigntemplatepackageRequestCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatepackageEditObjectV1Request(BaseModel): """ - Request for PUT /1/object/ezsigntemplatepackage/{pkiEzsigntemplatepackageID} # noqa: E501 - """ - obj_ezsigntemplatepackage: EzsigntemplatepackageRequestCompound = Field(..., alias="objEzsigntemplatepackage") - __properties = ["objEzsigntemplatepackage"] + Request for PUT /1/object/ezsigntemplatepackage/{pkiEzsigntemplatepackageID} + """ # noqa: E501 + obj_ezsigntemplatepackage: EzsigntemplatepackageRequestCompound = Field(alias="objEzsigntemplatepackage") + __properties: ClassVar[List[str]] = ["objEzsigntemplatepackage"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatepackageEditObjectV1Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatepackageEditObjectV1Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_ezsigntemplatepackage if self.obj_ezsigntemplatepackage: _dict['objEzsigntemplatepackage'] = self.obj_ezsigntemplatepackage.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatepackageEditObjectV1Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatepackageEditObjectV1Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatepackageEditObjectV1Request.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplatepackageEditObjectV1Request.parse_obj({ - "obj_ezsigntemplatepackage": EzsigntemplatepackageRequestCompound.from_dict(obj.get("objEzsigntemplatepackage")) if obj.get("objEzsigntemplatepackage") is not None else None + _obj = cls.model_validate({ + "objEzsigntemplatepackage": EzsigntemplatepackageRequestCompound.from_dict(obj.get("objEzsigntemplatepackage")) if obj.get("objEzsigntemplatepackage") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatepackage_edit_object_v1_response.py b/eZmaxApi/models/ezsigntemplatepackage_edit_object_v1_response.py index a045614c6..49dd830be 100644 --- a/eZmaxApi/models/ezsigntemplatepackage_edit_object_v1_response.py +++ b/eZmaxApi/models/ezsigntemplatepackage_edit_object_v1_response.py @@ -19,43 +19,61 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatepackageEditObjectV1Response(BaseModel): """ - Response for PUT /1/object/ezsigntemplatepackage/{pkiEzsigntemplatepackageID} # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - __properties = ["objDebugPayload", "objDebug"] + Response for PUT /1/object/ezsigntemplatepackage/{pkiEzsigntemplatepackageID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatepackageEditObjectV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatepackageEditObjectV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -65,17 +83,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatepackageEditObjectV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatepackageEditObjectV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatepackageEditObjectV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplatepackageEditObjectV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatepackage_get_autocomplete_v2_response.py b/eZmaxApi/models/ezsigntemplatepackage_get_autocomplete_v2_response.py index 2d7497a1a..6e40a5f98 100644 --- a/eZmaxApi/models/ezsigntemplatepackage_get_autocomplete_v2_response.py +++ b/eZmaxApi/models/ezsigntemplatepackage_get_autocomplete_v2_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.ezsigntemplatepackage_get_autocomplete_v2_response_m_payload import EzsigntemplatepackageGetAutocompleteV2ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatepackageGetAutocompleteV2Response(BaseModel): """ - Response for GET /2/object/ezsigntemplatepackage/getAutocomplete # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzsigntemplatepackageGetAutocompleteV2ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /2/object/ezsigntemplatepackage/getAutocomplete + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsigntemplatepackageGetAutocompleteV2ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatepackageGetAutocompleteV2Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatepackageGetAutocompleteV2Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatepackageGetAutocompleteV2Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatepackageGetAutocompleteV2Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatepackageGetAutocompleteV2Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplatepackageGetAutocompleteV2Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzsigntemplatepackageGetAutocompleteV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsigntemplatepackageGetAutocompleteV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatepackage_get_autocomplete_v2_response_m_payload.py b/eZmaxApi/models/ezsigntemplatepackage_get_autocomplete_v2_response_m_payload.py index 3e2c6c5bf..2de6d29de 100644 --- a/eZmaxApi/models/ezsigntemplatepackage_get_autocomplete_v2_response_m_payload.py +++ b/eZmaxApi/models/ezsigntemplatepackage_get_autocomplete_v2_response_m_payload.py @@ -19,41 +19,59 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.ezsigntemplatepackage_autocomplete_element_response import EzsigntemplatepackageAutocompleteElementResponse +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatepackageGetAutocompleteV2ResponseMPayload(BaseModel): """ - Payload for POST /2/object/ezsigntemplatepackage/getAutocomplete # noqa: E501 - """ - a_obj_ezsigntemplatepackage: conlist(EzsigntemplatepackageAutocompleteElementResponse) = Field(..., alias="a_objEzsigntemplatepackage", description="An array of Ezsigntemplatepackage autocomplete element response.") - __properties = ["a_objEzsigntemplatepackage"] + Payload for POST /2/object/ezsigntemplatepackage/getAutocomplete + """ # noqa: E501 + a_obj_ezsigntemplatepackage: List[EzsigntemplatepackageAutocompleteElementResponse] = Field(description="An array of Ezsigntemplatepackage autocomplete element response.", alias="a_objEzsigntemplatepackage") + __properties: ClassVar[List[str]] = ["a_objEzsigntemplatepackage"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatepackageGetAutocompleteV2ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatepackageGetAutocompleteV2ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_ezsigntemplatepackage (list) _items = [] if self.a_obj_ezsigntemplatepackage: @@ -64,16 +82,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatepackageGetAutocompleteV2ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatepackageGetAutocompleteV2ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatepackageGetAutocompleteV2ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplatepackageGetAutocompleteV2ResponseMPayload.parse_obj({ - "a_obj_ezsigntemplatepackage": [EzsigntemplatepackageAutocompleteElementResponse.from_dict(_item) for _item in obj.get("a_objEzsigntemplatepackage")] if obj.get("a_objEzsigntemplatepackage") is not None else None + _obj = cls.model_validate({ + "a_objEzsigntemplatepackage": [EzsigntemplatepackageAutocompleteElementResponse.from_dict(_item) for _item in obj.get("a_objEzsigntemplatepackage")] if obj.get("a_objEzsigntemplatepackage") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatepackage_get_list_v1_response.py b/eZmaxApi/models/ezsigntemplatepackage_get_list_v1_response.py index 790838c53..60ebfd761 100644 --- a/eZmaxApi/models/ezsigntemplatepackage_get_list_v1_response.py +++ b/eZmaxApi/models/ezsigntemplatepackage_get_list_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload_get_list import CommonResponseObjDebugPayloadGetList from eZmaxApi.models.ezsigntemplatepackage_get_list_v1_response_m_payload import EzsigntemplatepackageGetListV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatepackageGetListV1Response(BaseModel): """ - Response for GET /1/object/ezsigntemplatepackage/getList # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayloadGetList = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzsigntemplatepackageGetListV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /1/object/ezsigntemplatepackage/getList + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayloadGetList = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsigntemplatepackageGetListV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatepackageGetListV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatepackageGetListV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatepackageGetListV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatepackageGetListV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatepackageGetListV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplatepackageGetListV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayloadGetList.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzsigntemplatepackageGetListV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayloadGetList.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsigntemplatepackageGetListV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatepackage_get_list_v1_response_m_payload.py b/eZmaxApi/models/ezsigntemplatepackage_get_list_v1_response_m_payload.py index 22523fb16..48e6a7eb5 100644 --- a/eZmaxApi/models/ezsigntemplatepackage_get_list_v1_response_m_payload.py +++ b/eZmaxApi/models/ezsigntemplatepackage_get_list_v1_response_m_payload.py @@ -19,43 +19,61 @@ import json -from typing import List -from pydantic import BaseModel, Field, StrictInt, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictInt +from pydantic import Field from eZmaxApi.models.ezsigntemplatepackage_list_element import EzsigntemplatepackageListElement +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatepackageGetListV1ResponseMPayload(BaseModel): """ - Payload for GET /1/object/ezsigntemplatepackage/getList # noqa: E501 - """ - i_row_returned: StrictInt = Field(..., alias="iRowReturned", description="The number of rows returned") - i_row_filtered: StrictInt = Field(..., alias="iRowFiltered", description="The number of rows matching your filters (if any) or the total number of rows") - a_obj_ezsigntemplatepackage: conlist(EzsigntemplatepackageListElement) = Field(..., alias="a_objEzsigntemplatepackage") - __properties = ["iRowReturned", "iRowFiltered", "a_objEzsigntemplatepackage"] + Payload for GET /1/object/ezsigntemplatepackage/getList + """ # noqa: E501 + i_row_returned: StrictInt = Field(description="The number of rows returned", alias="iRowReturned") + i_row_filtered: StrictInt = Field(description="The number of rows matching your filters (if any) or the total number of rows", alias="iRowFiltered") + a_obj_ezsigntemplatepackage: List[EzsigntemplatepackageListElement] = Field(alias="a_objEzsigntemplatepackage") + __properties: ClassVar[List[str]] = ["iRowReturned", "iRowFiltered", "a_objEzsigntemplatepackage"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatepackageGetListV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatepackageGetListV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_ezsigntemplatepackage (list) _items = [] if self.a_obj_ezsigntemplatepackage: @@ -66,18 +84,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatepackageGetListV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatepackageGetListV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatepackageGetListV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplatepackageGetListV1ResponseMPayload.parse_obj({ - "i_row_returned": obj.get("iRowReturned"), - "i_row_filtered": obj.get("iRowFiltered"), - "a_obj_ezsigntemplatepackage": [EzsigntemplatepackageListElement.from_dict(_item) for _item in obj.get("a_objEzsigntemplatepackage")] if obj.get("a_objEzsigntemplatepackage") is not None else None + _obj = cls.model_validate({ + "iRowReturned": obj.get("iRowReturned"), + "iRowFiltered": obj.get("iRowFiltered"), + "a_objEzsigntemplatepackage": [EzsigntemplatepackageListElement.from_dict(_item) for _item in obj.get("a_objEzsigntemplatepackage")] if obj.get("a_objEzsigntemplatepackage") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatepackage_get_object_v2_response.py b/eZmaxApi/models/ezsigntemplatepackage_get_object_v2_response.py index deb09728d..5eface1bd 100644 --- a/eZmaxApi/models/ezsigntemplatepackage_get_object_v2_response.py +++ b/eZmaxApi/models/ezsigntemplatepackage_get_object_v2_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.ezsigntemplatepackage_get_object_v2_response_m_payload import EzsigntemplatepackageGetObjectV2ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatepackageGetObjectV2Response(BaseModel): """ - Response for GET /2/object/ezsigntemplatepackage/{pkiEzsigntemplatepackageID} # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzsigntemplatepackageGetObjectV2ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /2/object/ezsigntemplatepackage/{pkiEzsigntemplatepackageID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsigntemplatepackageGetObjectV2ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatepackageGetObjectV2Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatepackageGetObjectV2Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatepackageGetObjectV2Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatepackageGetObjectV2Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatepackageGetObjectV2Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplatepackageGetObjectV2Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzsigntemplatepackageGetObjectV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsigntemplatepackageGetObjectV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatepackage_get_object_v2_response_m_payload.py b/eZmaxApi/models/ezsigntemplatepackage_get_object_v2_response_m_payload.py index f42f15209..94dcbaa1d 100644 --- a/eZmaxApi/models/ezsigntemplatepackage_get_object_v2_response_m_payload.py +++ b/eZmaxApi/models/ezsigntemplatepackage_get_object_v2_response_m_payload.py @@ -19,57 +19,75 @@ import json - -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.ezsigntemplatepackage_response_compound import EzsigntemplatepackageResponseCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatepackageGetObjectV2ResponseMPayload(BaseModel): """ - Payload for GET /2/object/ezsigntemplatepackage/{pkiEzsigntemplatepackageID} # noqa: E501 - """ - obj_ezsigntemplatepackage: EzsigntemplatepackageResponseCompound = Field(..., alias="objEzsigntemplatepackage") - __properties = ["objEzsigntemplatepackage"] + Payload for GET /2/object/ezsigntemplatepackage/{pkiEzsigntemplatepackageID} + """ # noqa: E501 + obj_ezsigntemplatepackage: EzsigntemplatepackageResponseCompound = Field(alias="objEzsigntemplatepackage") + __properties: ClassVar[List[str]] = ["objEzsigntemplatepackage"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatepackageGetObjectV2ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatepackageGetObjectV2ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_ezsigntemplatepackage if self.obj_ezsigntemplatepackage: _dict['objEzsigntemplatepackage'] = self.obj_ezsigntemplatepackage.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatepackageGetObjectV2ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatepackageGetObjectV2ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatepackageGetObjectV2ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplatepackageGetObjectV2ResponseMPayload.parse_obj({ - "obj_ezsigntemplatepackage": EzsigntemplatepackageResponseCompound.from_dict(obj.get("objEzsigntemplatepackage")) if obj.get("objEzsigntemplatepackage") is not None else None + _obj = cls.model_validate({ + "objEzsigntemplatepackage": EzsigntemplatepackageResponseCompound.from_dict(obj.get("objEzsigntemplatepackage")) if obj.get("objEzsigntemplatepackage") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatepackage_list_element.py b/eZmaxApi/models/ezsigntemplatepackage_list_element.py index 238253efd..3b3628f57 100644 --- a/eZmaxApi/models/ezsigntemplatepackage_list_element.py +++ b/eZmaxApi/models/ezsigntemplatepackage_list_element.py @@ -19,67 +19,86 @@ import json - -from pydantic import BaseModel, Field, StrictBool, StrictInt, StrictStr, conint +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictBool, StrictInt, StrictStr +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatepackageListElement(BaseModel): """ - An Ezsigntemplatepackage List Element # noqa: E501 - """ - pki_ezsigntemplatepackage_id: conint(strict=True, ge=0) = Field(..., alias="pkiEzsigntemplatepackageID", description="The unique ID of the Ezsigntemplatepackage") - fki_ezsignfoldertype_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsignfoldertypeID", description="The unique ID of the Ezsignfoldertype.") - fki_language_id: conint(strict=True, le=2, ge=1) = Field(..., alias="fkiLanguageID", description="The unique ID of the Language. Valid values: |Value|Description| |-|-| |1|French| |2|English|") - s_ezsigntemplatepackage_description: StrictStr = Field(..., alias="sEzsigntemplatepackageDescription", description="The description of the Ezsigntemplatepackage") - b_ezsigntemplatepackage_needvalidation: StrictBool = Field(..., alias="bEzsigntemplatepackageNeedvalidation", description="Whether the Ezsignbulksend was automatically modified and needs a manual validation") - i_ezsigntemplatepackagemembership: StrictInt = Field(..., alias="iEzsigntemplatepackagemembership", description="The total number of Ezsigntemplatepackagemembership in the Ezsigntemplatepackage") - s_ezsignfoldertype_name_x: StrictStr = Field(..., alias="sEzsignfoldertypeNameX", description="The name of the Ezsignfoldertype in the language of the requester") - b_ezsigntemplatepackage_isactive: StrictBool = Field(..., alias="bEzsigntemplatepackageIsactive", description="Whether the Ezsigntemplatepackage is active or not") - __properties = ["pkiEzsigntemplatepackageID", "fkiEzsignfoldertypeID", "fkiLanguageID", "sEzsigntemplatepackageDescription", "bEzsigntemplatepackageNeedvalidation", "iEzsigntemplatepackagemembership", "sEzsignfoldertypeNameX", "bEzsigntemplatepackageIsactive"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + An Ezsigntemplatepackage List Element + """ # noqa: E501 + pki_ezsigntemplatepackage_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsigntemplatepackage", alias="pkiEzsigntemplatepackageID") + fki_ezsignfoldertype_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsignfoldertype.", alias="fkiEzsignfoldertypeID") + fki_language_id: Annotated[int, Field(le=2, strict=True, ge=1)] = Field(description="The unique ID of the Language. Valid values: |Value|Description| |-|-| |1|French| |2|English|", alias="fkiLanguageID") + s_ezsigntemplatepackage_description: StrictStr = Field(description="The description of the Ezsigntemplatepackage", alias="sEzsigntemplatepackageDescription") + b_ezsigntemplatepackage_needvalidation: StrictBool = Field(description="Whether the Ezsignbulksend was automatically modified and needs a manual validation", alias="bEzsigntemplatepackageNeedvalidation") + i_ezsigntemplatepackagemembership: StrictInt = Field(description="The total number of Ezsigntemplatepackagemembership in the Ezsigntemplatepackage", alias="iEzsigntemplatepackagemembership") + s_ezsignfoldertype_name_x: StrictStr = Field(description="The name of the Ezsignfoldertype in the language of the requester", alias="sEzsignfoldertypeNameX") + b_ezsigntemplatepackage_isactive: StrictBool = Field(description="Whether the Ezsigntemplatepackage is active or not", alias="bEzsigntemplatepackageIsactive") + __properties: ClassVar[List[str]] = ["pkiEzsigntemplatepackageID", "fkiEzsignfoldertypeID", "fkiLanguageID", "sEzsigntemplatepackageDescription", "bEzsigntemplatepackageNeedvalidation", "iEzsigntemplatepackagemembership", "sEzsignfoldertypeNameX", "bEzsigntemplatepackageIsactive"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatepackageListElement: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatepackageListElement from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatepackageListElement: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatepackageListElement from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatepackageListElement.parse_obj(obj) - - _obj = EzsigntemplatepackageListElement.parse_obj({ - "pki_ezsigntemplatepackage_id": obj.get("pkiEzsigntemplatepackageID"), - "fki_ezsignfoldertype_id": obj.get("fkiEzsignfoldertypeID"), - "fki_language_id": obj.get("fkiLanguageID"), - "s_ezsigntemplatepackage_description": obj.get("sEzsigntemplatepackageDescription"), - "b_ezsigntemplatepackage_needvalidation": obj.get("bEzsigntemplatepackageNeedvalidation"), - "i_ezsigntemplatepackagemembership": obj.get("iEzsigntemplatepackagemembership"), - "s_ezsignfoldertype_name_x": obj.get("sEzsignfoldertypeNameX"), - "b_ezsigntemplatepackage_isactive": obj.get("bEzsigntemplatepackageIsactive") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsigntemplatepackageID": obj.get("pkiEzsigntemplatepackageID"), + "fkiEzsignfoldertypeID": obj.get("fkiEzsignfoldertypeID"), + "fkiLanguageID": obj.get("fkiLanguageID"), + "sEzsigntemplatepackageDescription": obj.get("sEzsigntemplatepackageDescription"), + "bEzsigntemplatepackageNeedvalidation": obj.get("bEzsigntemplatepackageNeedvalidation"), + "iEzsigntemplatepackagemembership": obj.get("iEzsigntemplatepackagemembership"), + "sEzsignfoldertypeNameX": obj.get("sEzsignfoldertypeNameX"), + "bEzsigntemplatepackageIsactive": obj.get("bEzsigntemplatepackageIsactive") }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatepackage_request.py b/eZmaxApi/models/ezsigntemplatepackage_request.py index 44314d945..677725ba3 100644 --- a/eZmaxApi/models/ezsigntemplatepackage_request.py +++ b/eZmaxApi/models/ezsigntemplatepackage_request.py @@ -19,63 +19,82 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, StrictStr +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatepackageRequest(BaseModel): """ - A Ezsigntemplatepackage Object # noqa: E501 - """ - pki_ezsigntemplatepackage_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="pkiEzsigntemplatepackageID", description="The unique ID of the Ezsigntemplatepackage") - fki_ezsignfoldertype_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsignfoldertypeID", description="The unique ID of the Ezsignfoldertype.") - fki_language_id: conint(strict=True, le=2, ge=1) = Field(..., alias="fkiLanguageID", description="The unique ID of the Language. Valid values: |Value|Description| |-|-| |1|French| |2|English|") - s_ezsigntemplatepackage_description: StrictStr = Field(..., alias="sEzsigntemplatepackageDescription", description="The description of the Ezsigntemplatepackage") - b_ezsigntemplatepackage_adminonly: StrictBool = Field(..., alias="bEzsigntemplatepackageAdminonly", description="Whether the Ezsigntemplatepackage can be accessed by admin users only (eUserType=Normal)") - b_ezsigntemplatepackage_isactive: StrictBool = Field(..., alias="bEzsigntemplatepackageIsactive", description="Whether the Ezsigntemplatepackage is active or not") - __properties = ["pkiEzsigntemplatepackageID", "fkiEzsignfoldertypeID", "fkiLanguageID", "sEzsigntemplatepackageDescription", "bEzsigntemplatepackageAdminonly", "bEzsigntemplatepackageIsactive"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + A Ezsigntemplatepackage Object + """ # noqa: E501 + pki_ezsigntemplatepackage_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsigntemplatepackage", alias="pkiEzsigntemplatepackageID") + fki_ezsignfoldertype_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsignfoldertype.", alias="fkiEzsignfoldertypeID") + fki_language_id: Annotated[int, Field(le=2, strict=True, ge=1)] = Field(description="The unique ID of the Language. Valid values: |Value|Description| |-|-| |1|French| |2|English|", alias="fkiLanguageID") + s_ezsigntemplatepackage_description: StrictStr = Field(description="The description of the Ezsigntemplatepackage", alias="sEzsigntemplatepackageDescription") + b_ezsigntemplatepackage_adminonly: StrictBool = Field(description="Whether the Ezsigntemplatepackage can be accessed by admin users only (eUserType=Normal)", alias="bEzsigntemplatepackageAdminonly") + b_ezsigntemplatepackage_isactive: StrictBool = Field(description="Whether the Ezsigntemplatepackage is active or not", alias="bEzsigntemplatepackageIsactive") + __properties: ClassVar[List[str]] = ["pkiEzsigntemplatepackageID", "fkiEzsignfoldertypeID", "fkiLanguageID", "sEzsigntemplatepackageDescription", "bEzsigntemplatepackageAdminonly", "bEzsigntemplatepackageIsactive"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatepackageRequest: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatepackageRequest from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatepackageRequest: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatepackageRequest from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatepackageRequest.parse_obj(obj) - - _obj = EzsigntemplatepackageRequest.parse_obj({ - "pki_ezsigntemplatepackage_id": obj.get("pkiEzsigntemplatepackageID"), - "fki_ezsignfoldertype_id": obj.get("fkiEzsignfoldertypeID"), - "fki_language_id": obj.get("fkiLanguageID"), - "s_ezsigntemplatepackage_description": obj.get("sEzsigntemplatepackageDescription"), - "b_ezsigntemplatepackage_adminonly": obj.get("bEzsigntemplatepackageAdminonly"), - "b_ezsigntemplatepackage_isactive": obj.get("bEzsigntemplatepackageIsactive") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsigntemplatepackageID": obj.get("pkiEzsigntemplatepackageID"), + "fkiEzsignfoldertypeID": obj.get("fkiEzsignfoldertypeID"), + "fkiLanguageID": obj.get("fkiLanguageID"), + "sEzsigntemplatepackageDescription": obj.get("sEzsigntemplatepackageDescription"), + "bEzsigntemplatepackageAdminonly": obj.get("bEzsigntemplatepackageAdminonly"), + "bEzsigntemplatepackageIsactive": obj.get("bEzsigntemplatepackageIsactive") }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatepackage_request_compound.py b/eZmaxApi/models/ezsigntemplatepackage_request_compound.py index 18529f1d6..e4f097edd 100644 --- a/eZmaxApi/models/ezsigntemplatepackage_request_compound.py +++ b/eZmaxApi/models/ezsigntemplatepackage_request_compound.py @@ -19,63 +19,82 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, StrictStr +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatepackageRequestCompound(BaseModel): """ - A Ezsigntemplatepackage Object and children # noqa: E501 - """ - pki_ezsigntemplatepackage_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="pkiEzsigntemplatepackageID", description="The unique ID of the Ezsigntemplatepackage") - fki_ezsignfoldertype_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsignfoldertypeID", description="The unique ID of the Ezsignfoldertype.") - fki_language_id: conint(strict=True, le=2, ge=1) = Field(..., alias="fkiLanguageID", description="The unique ID of the Language. Valid values: |Value|Description| |-|-| |1|French| |2|English|") - s_ezsigntemplatepackage_description: StrictStr = Field(..., alias="sEzsigntemplatepackageDescription", description="The description of the Ezsigntemplatepackage") - b_ezsigntemplatepackage_adminonly: StrictBool = Field(..., alias="bEzsigntemplatepackageAdminonly", description="Whether the Ezsigntemplatepackage can be accessed by admin users only (eUserType=Normal)") - b_ezsigntemplatepackage_isactive: StrictBool = Field(..., alias="bEzsigntemplatepackageIsactive", description="Whether the Ezsigntemplatepackage is active or not") - __properties = ["pkiEzsigntemplatepackageID", "fkiEzsignfoldertypeID", "fkiLanguageID", "sEzsigntemplatepackageDescription", "bEzsigntemplatepackageAdminonly", "bEzsigntemplatepackageIsactive"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + A Ezsigntemplatepackage Object and children + """ # noqa: E501 + pki_ezsigntemplatepackage_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsigntemplatepackage", alias="pkiEzsigntemplatepackageID") + fki_ezsignfoldertype_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsignfoldertype.", alias="fkiEzsignfoldertypeID") + fki_language_id: Annotated[int, Field(le=2, strict=True, ge=1)] = Field(description="The unique ID of the Language. Valid values: |Value|Description| |-|-| |1|French| |2|English|", alias="fkiLanguageID") + s_ezsigntemplatepackage_description: StrictStr = Field(description="The description of the Ezsigntemplatepackage", alias="sEzsigntemplatepackageDescription") + b_ezsigntemplatepackage_adminonly: StrictBool = Field(description="Whether the Ezsigntemplatepackage can be accessed by admin users only (eUserType=Normal)", alias="bEzsigntemplatepackageAdminonly") + b_ezsigntemplatepackage_isactive: StrictBool = Field(description="Whether the Ezsigntemplatepackage is active or not", alias="bEzsigntemplatepackageIsactive") + __properties: ClassVar[List[str]] = ["pkiEzsigntemplatepackageID", "fkiEzsignfoldertypeID", "fkiLanguageID", "sEzsigntemplatepackageDescription", "bEzsigntemplatepackageAdminonly", "bEzsigntemplatepackageIsactive"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatepackageRequestCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatepackageRequestCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatepackageRequestCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatepackageRequestCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatepackageRequestCompound.parse_obj(obj) - - _obj = EzsigntemplatepackageRequestCompound.parse_obj({ - "pki_ezsigntemplatepackage_id": obj.get("pkiEzsigntemplatepackageID"), - "fki_ezsignfoldertype_id": obj.get("fkiEzsignfoldertypeID"), - "fki_language_id": obj.get("fkiLanguageID"), - "s_ezsigntemplatepackage_description": obj.get("sEzsigntemplatepackageDescription"), - "b_ezsigntemplatepackage_adminonly": obj.get("bEzsigntemplatepackageAdminonly"), - "b_ezsigntemplatepackage_isactive": obj.get("bEzsigntemplatepackageIsactive") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsigntemplatepackageID": obj.get("pkiEzsigntemplatepackageID"), + "fkiEzsignfoldertypeID": obj.get("fkiEzsignfoldertypeID"), + "fkiLanguageID": obj.get("fkiLanguageID"), + "sEzsigntemplatepackageDescription": obj.get("sEzsigntemplatepackageDescription"), + "bEzsigntemplatepackageAdminonly": obj.get("bEzsigntemplatepackageAdminonly"), + "bEzsigntemplatepackageIsactive": obj.get("bEzsigntemplatepackageIsactive") }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatepackage_response.py b/eZmaxApi/models/ezsigntemplatepackage_response.py index 58e64e6f8..8dd6d1290 100644 --- a/eZmaxApi/models/ezsigntemplatepackage_response.py +++ b/eZmaxApi/models/ezsigntemplatepackage_response.py @@ -19,69 +19,88 @@ import json - -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictBool, StrictStr +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatepackageResponse(BaseModel): """ - A Ezsigntemplatepackage Object # noqa: E501 - """ - pki_ezsigntemplatepackage_id: conint(strict=True, ge=0) = Field(..., alias="pkiEzsigntemplatepackageID", description="The unique ID of the Ezsigntemplatepackage") - fki_ezsignfoldertype_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsignfoldertypeID", description="The unique ID of the Ezsignfoldertype.") - fki_language_id: conint(strict=True, le=2, ge=1) = Field(..., alias="fkiLanguageID", description="The unique ID of the Language. Valid values: |Value|Description| |-|-| |1|French| |2|English|") - s_language_name_x: StrictStr = Field(..., alias="sLanguageNameX", description="The Name of the Language in the language of the requester") - s_ezsigntemplatepackage_description: StrictStr = Field(..., alias="sEzsigntemplatepackageDescription", description="The description of the Ezsigntemplatepackage") - b_ezsigntemplatepackage_adminonly: StrictBool = Field(..., alias="bEzsigntemplatepackageAdminonly", description="Whether the Ezsigntemplatepackage can be accessed by admin users only (eUserType=Normal)") - b_ezsigntemplatepackage_needvalidation: StrictBool = Field(..., alias="bEzsigntemplatepackageNeedvalidation", description="Whether the Ezsignbulksend was automatically modified and needs a manual validation") - b_ezsigntemplatepackage_isactive: StrictBool = Field(..., alias="bEzsigntemplatepackageIsactive", description="Whether the Ezsigntemplatepackage is active or not") - s_ezsignfoldertype_name_x: StrictStr = Field(..., alias="sEzsignfoldertypeNameX", description="The name of the Ezsignfoldertype in the language of the requester") - __properties = ["pkiEzsigntemplatepackageID", "fkiEzsignfoldertypeID", "fkiLanguageID", "sLanguageNameX", "sEzsigntemplatepackageDescription", "bEzsigntemplatepackageAdminonly", "bEzsigntemplatepackageNeedvalidation", "bEzsigntemplatepackageIsactive", "sEzsignfoldertypeNameX"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + A Ezsigntemplatepackage Object + """ # noqa: E501 + pki_ezsigntemplatepackage_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsigntemplatepackage", alias="pkiEzsigntemplatepackageID") + fki_ezsignfoldertype_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsignfoldertype.", alias="fkiEzsignfoldertypeID") + fki_language_id: Annotated[int, Field(le=2, strict=True, ge=1)] = Field(description="The unique ID of the Language. Valid values: |Value|Description| |-|-| |1|French| |2|English|", alias="fkiLanguageID") + s_language_name_x: StrictStr = Field(description="The Name of the Language in the language of the requester", alias="sLanguageNameX") + s_ezsigntemplatepackage_description: StrictStr = Field(description="The description of the Ezsigntemplatepackage", alias="sEzsigntemplatepackageDescription") + b_ezsigntemplatepackage_adminonly: StrictBool = Field(description="Whether the Ezsigntemplatepackage can be accessed by admin users only (eUserType=Normal)", alias="bEzsigntemplatepackageAdminonly") + b_ezsigntemplatepackage_needvalidation: StrictBool = Field(description="Whether the Ezsignbulksend was automatically modified and needs a manual validation", alias="bEzsigntemplatepackageNeedvalidation") + b_ezsigntemplatepackage_isactive: StrictBool = Field(description="Whether the Ezsigntemplatepackage is active or not", alias="bEzsigntemplatepackageIsactive") + s_ezsignfoldertype_name_x: StrictStr = Field(description="The name of the Ezsignfoldertype in the language of the requester", alias="sEzsignfoldertypeNameX") + __properties: ClassVar[List[str]] = ["pkiEzsigntemplatepackageID", "fkiEzsignfoldertypeID", "fkiLanguageID", "sLanguageNameX", "sEzsigntemplatepackageDescription", "bEzsigntemplatepackageAdminonly", "bEzsigntemplatepackageNeedvalidation", "bEzsigntemplatepackageIsactive", "sEzsignfoldertypeNameX"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatepackageResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatepackageResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatepackageResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatepackageResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatepackageResponse.parse_obj(obj) - - _obj = EzsigntemplatepackageResponse.parse_obj({ - "pki_ezsigntemplatepackage_id": obj.get("pkiEzsigntemplatepackageID"), - "fki_ezsignfoldertype_id": obj.get("fkiEzsignfoldertypeID"), - "fki_language_id": obj.get("fkiLanguageID"), - "s_language_name_x": obj.get("sLanguageNameX"), - "s_ezsigntemplatepackage_description": obj.get("sEzsigntemplatepackageDescription"), - "b_ezsigntemplatepackage_adminonly": obj.get("bEzsigntemplatepackageAdminonly"), - "b_ezsigntemplatepackage_needvalidation": obj.get("bEzsigntemplatepackageNeedvalidation"), - "b_ezsigntemplatepackage_isactive": obj.get("bEzsigntemplatepackageIsactive"), - "s_ezsignfoldertype_name_x": obj.get("sEzsignfoldertypeNameX") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsigntemplatepackageID": obj.get("pkiEzsigntemplatepackageID"), + "fkiEzsignfoldertypeID": obj.get("fkiEzsignfoldertypeID"), + "fkiLanguageID": obj.get("fkiLanguageID"), + "sLanguageNameX": obj.get("sLanguageNameX"), + "sEzsigntemplatepackageDescription": obj.get("sEzsigntemplatepackageDescription"), + "bEzsigntemplatepackageAdminonly": obj.get("bEzsigntemplatepackageAdminonly"), + "bEzsigntemplatepackageNeedvalidation": obj.get("bEzsigntemplatepackageNeedvalidation"), + "bEzsigntemplatepackageIsactive": obj.get("bEzsigntemplatepackageIsactive"), + "sEzsignfoldertypeNameX": obj.get("sEzsignfoldertypeNameX") }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatepackage_response_compound.py b/eZmaxApi/models/ezsigntemplatepackage_response_compound.py index ad4748872..6c84fa9ee 100644 --- a/eZmaxApi/models/ezsigntemplatepackage_response_compound.py +++ b/eZmaxApi/models/ezsigntemplatepackage_response_compound.py @@ -19,52 +19,71 @@ import json -from typing import List -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictBool, StrictStr +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.ezsigntemplatepackagemembership_response_compound import EzsigntemplatepackagemembershipResponseCompound from eZmaxApi.models.ezsigntemplatepackagesigner_response_compound import EzsigntemplatepackagesignerResponseCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatepackageResponseCompound(BaseModel): """ - A Ezsigntemplatepackage Object # noqa: E501 - """ - pki_ezsigntemplatepackage_id: conint(strict=True, ge=0) = Field(..., alias="pkiEzsigntemplatepackageID", description="The unique ID of the Ezsigntemplatepackage") - fki_ezsignfoldertype_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsignfoldertypeID", description="The unique ID of the Ezsignfoldertype.") - fki_language_id: conint(strict=True, le=2, ge=1) = Field(..., alias="fkiLanguageID", description="The unique ID of the Language. Valid values: |Value|Description| |-|-| |1|French| |2|English|") - s_language_name_x: StrictStr = Field(..., alias="sLanguageNameX", description="The Name of the Language in the language of the requester") - s_ezsigntemplatepackage_description: StrictStr = Field(..., alias="sEzsigntemplatepackageDescription", description="The description of the Ezsigntemplatepackage") - b_ezsigntemplatepackage_adminonly: StrictBool = Field(..., alias="bEzsigntemplatepackageAdminonly", description="Whether the Ezsigntemplatepackage can be accessed by admin users only (eUserType=Normal)") - b_ezsigntemplatepackage_needvalidation: StrictBool = Field(..., alias="bEzsigntemplatepackageNeedvalidation", description="Whether the Ezsignbulksend was automatically modified and needs a manual validation") - b_ezsigntemplatepackage_isactive: StrictBool = Field(..., alias="bEzsigntemplatepackageIsactive", description="Whether the Ezsigntemplatepackage is active or not") - s_ezsignfoldertype_name_x: StrictStr = Field(..., alias="sEzsignfoldertypeNameX", description="The name of the Ezsignfoldertype in the language of the requester") - a_obj_ezsigntemplatepackagesigner: conlist(EzsigntemplatepackagesignerResponseCompound) = Field(..., alias="a_objEzsigntemplatepackagesigner") - a_obj_ezsigntemplatepackagemembership: conlist(EzsigntemplatepackagemembershipResponseCompound) = Field(..., alias="a_objEzsigntemplatepackagemembership") - __properties = ["pkiEzsigntemplatepackageID", "fkiEzsignfoldertypeID", "fkiLanguageID", "sLanguageNameX", "sEzsigntemplatepackageDescription", "bEzsigntemplatepackageAdminonly", "bEzsigntemplatepackageNeedvalidation", "bEzsigntemplatepackageIsactive", "sEzsignfoldertypeNameX", "a_objEzsigntemplatepackagesigner", "a_objEzsigntemplatepackagemembership"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + A Ezsigntemplatepackage Object + """ # noqa: E501 + pki_ezsigntemplatepackage_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsigntemplatepackage", alias="pkiEzsigntemplatepackageID") + fki_ezsignfoldertype_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsignfoldertype.", alias="fkiEzsignfoldertypeID") + fki_language_id: Annotated[int, Field(le=2, strict=True, ge=1)] = Field(description="The unique ID of the Language. Valid values: |Value|Description| |-|-| |1|French| |2|English|", alias="fkiLanguageID") + s_language_name_x: StrictStr = Field(description="The Name of the Language in the language of the requester", alias="sLanguageNameX") + s_ezsigntemplatepackage_description: StrictStr = Field(description="The description of the Ezsigntemplatepackage", alias="sEzsigntemplatepackageDescription") + b_ezsigntemplatepackage_adminonly: StrictBool = Field(description="Whether the Ezsigntemplatepackage can be accessed by admin users only (eUserType=Normal)", alias="bEzsigntemplatepackageAdminonly") + b_ezsigntemplatepackage_needvalidation: StrictBool = Field(description="Whether the Ezsignbulksend was automatically modified and needs a manual validation", alias="bEzsigntemplatepackageNeedvalidation") + b_ezsigntemplatepackage_isactive: StrictBool = Field(description="Whether the Ezsigntemplatepackage is active or not", alias="bEzsigntemplatepackageIsactive") + s_ezsignfoldertype_name_x: StrictStr = Field(description="The name of the Ezsignfoldertype in the language of the requester", alias="sEzsignfoldertypeNameX") + a_obj_ezsigntemplatepackagesigner: List[EzsigntemplatepackagesignerResponseCompound] = Field(alias="a_objEzsigntemplatepackagesigner") + a_obj_ezsigntemplatepackagemembership: List[EzsigntemplatepackagemembershipResponseCompound] = Field(alias="a_objEzsigntemplatepackagemembership") + __properties: ClassVar[List[str]] = ["pkiEzsigntemplatepackageID", "fkiEzsignfoldertypeID", "fkiLanguageID", "sLanguageNameX", "sEzsigntemplatepackageDescription", "bEzsigntemplatepackageAdminonly", "bEzsigntemplatepackageNeedvalidation", "bEzsigntemplatepackageIsactive", "sEzsignfoldertypeNameX", "a_objEzsigntemplatepackagesigner", "a_objEzsigntemplatepackagemembership"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatepackageResponseCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatepackageResponseCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_ezsigntemplatepackagesigner (list) _items = [] if self.a_obj_ezsigntemplatepackagesigner: @@ -82,26 +101,26 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatepackageResponseCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatepackageResponseCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatepackageResponseCompound.parse_obj(obj) - - _obj = EzsigntemplatepackageResponseCompound.parse_obj({ - "pki_ezsigntemplatepackage_id": obj.get("pkiEzsigntemplatepackageID"), - "fki_ezsignfoldertype_id": obj.get("fkiEzsignfoldertypeID"), - "fki_language_id": obj.get("fkiLanguageID"), - "s_language_name_x": obj.get("sLanguageNameX"), - "s_ezsigntemplatepackage_description": obj.get("sEzsigntemplatepackageDescription"), - "b_ezsigntemplatepackage_adminonly": obj.get("bEzsigntemplatepackageAdminonly"), - "b_ezsigntemplatepackage_needvalidation": obj.get("bEzsigntemplatepackageNeedvalidation"), - "b_ezsigntemplatepackage_isactive": obj.get("bEzsigntemplatepackageIsactive"), - "s_ezsignfoldertype_name_x": obj.get("sEzsignfoldertypeNameX"), - "a_obj_ezsigntemplatepackagesigner": [EzsigntemplatepackagesignerResponseCompound.from_dict(_item) for _item in obj.get("a_objEzsigntemplatepackagesigner")] if obj.get("a_objEzsigntemplatepackagesigner") is not None else None, - "a_obj_ezsigntemplatepackagemembership": [EzsigntemplatepackagemembershipResponseCompound.from_dict(_item) for _item in obj.get("a_objEzsigntemplatepackagemembership")] if obj.get("a_objEzsigntemplatepackagemembership") is not None else None + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsigntemplatepackageID": obj.get("pkiEzsigntemplatepackageID"), + "fkiEzsignfoldertypeID": obj.get("fkiEzsignfoldertypeID"), + "fkiLanguageID": obj.get("fkiLanguageID"), + "sLanguageNameX": obj.get("sLanguageNameX"), + "sEzsigntemplatepackageDescription": obj.get("sEzsigntemplatepackageDescription"), + "bEzsigntemplatepackageAdminonly": obj.get("bEzsigntemplatepackageAdminonly"), + "bEzsigntemplatepackageNeedvalidation": obj.get("bEzsigntemplatepackageNeedvalidation"), + "bEzsigntemplatepackageIsactive": obj.get("bEzsigntemplatepackageIsactive"), + "sEzsignfoldertypeNameX": obj.get("sEzsignfoldertypeNameX"), + "a_objEzsigntemplatepackagesigner": [EzsigntemplatepackagesignerResponseCompound.from_dict(_item) for _item in obj.get("a_objEzsigntemplatepackagesigner")] if obj.get("a_objEzsigntemplatepackagesigner") is not None else None, + "a_objEzsigntemplatepackagemembership": [EzsigntemplatepackagemembershipResponseCompound.from_dict(_item) for _item in obj.get("a_objEzsigntemplatepackagemembership")] if obj.get("a_objEzsigntemplatepackagemembership") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatepackagemembership_create_object_v1_request.py b/eZmaxApi/models/ezsigntemplatepackagemembership_create_object_v1_request.py index 77b68b663..bc8c57521 100644 --- a/eZmaxApi/models/ezsigntemplatepackagemembership_create_object_v1_request.py +++ b/eZmaxApi/models/ezsigntemplatepackagemembership_create_object_v1_request.py @@ -19,41 +19,60 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.ezsigntemplatepackagemembership_request_compound import EzsigntemplatepackagemembershipRequestCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatepackagemembershipCreateObjectV1Request(BaseModel): """ - Request for POST /1/object/ezsigntemplatepackagemembership # noqa: E501 - """ - a_obj_ezsigntemplatepackagemembership: conlist(EzsigntemplatepackagemembershipRequestCompound, min_items=1) = Field(..., alias="a_objEzsigntemplatepackagemembership") - __properties = ["a_objEzsigntemplatepackagemembership"] + Request for POST /1/object/ezsigntemplatepackagemembership + """ # noqa: E501 + a_obj_ezsigntemplatepackagemembership: Annotated[List[EzsigntemplatepackagemembershipRequestCompound], Field(min_length=1)] = Field(alias="a_objEzsigntemplatepackagemembership") + __properties: ClassVar[List[str]] = ["a_objEzsigntemplatepackagemembership"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatepackagemembershipCreateObjectV1Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatepackagemembershipCreateObjectV1Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_ezsigntemplatepackagemembership (list) _items = [] if self.a_obj_ezsigntemplatepackagemembership: @@ -64,16 +83,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatepackagemembershipCreateObjectV1Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatepackagemembershipCreateObjectV1Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatepackagemembershipCreateObjectV1Request.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplatepackagemembershipCreateObjectV1Request.parse_obj({ - "a_obj_ezsigntemplatepackagemembership": [EzsigntemplatepackagemembershipRequestCompound.from_dict(_item) for _item in obj.get("a_objEzsigntemplatepackagemembership")] if obj.get("a_objEzsigntemplatepackagemembership") is not None else None + _obj = cls.model_validate({ + "a_objEzsigntemplatepackagemembership": [EzsigntemplatepackagemembershipRequestCompound.from_dict(_item) for _item in obj.get("a_objEzsigntemplatepackagemembership")] if obj.get("a_objEzsigntemplatepackagemembership") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatepackagemembership_create_object_v1_response.py b/eZmaxApi/models/ezsigntemplatepackagemembership_create_object_v1_response.py index 38a68c314..84561b0ca 100644 --- a/eZmaxApi/models/ezsigntemplatepackagemembership_create_object_v1_response.py +++ b/eZmaxApi/models/ezsigntemplatepackagemembership_create_object_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.ezsigntemplatepackagemembership_create_object_v1_response_m_payload import EzsigntemplatepackagemembershipCreateObjectV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatepackagemembershipCreateObjectV1Response(BaseModel): """ - Response for POST /1/object/ezsigntemplatepackagemembership # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzsigntemplatepackagemembershipCreateObjectV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for POST /1/object/ezsigntemplatepackagemembership + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsigntemplatepackagemembershipCreateObjectV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatepackagemembershipCreateObjectV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatepackagemembershipCreateObjectV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatepackagemembershipCreateObjectV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatepackagemembershipCreateObjectV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatepackagemembershipCreateObjectV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplatepackagemembershipCreateObjectV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzsigntemplatepackagemembershipCreateObjectV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsigntemplatepackagemembershipCreateObjectV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatepackagemembership_create_object_v1_response_m_payload.py b/eZmaxApi/models/ezsigntemplatepackagemembership_create_object_v1_response_m_payload.py index f1e296e6e..cd04d8302 100644 --- a/eZmaxApi/models/ezsigntemplatepackagemembership_create_object_v1_response_m_payload.py +++ b/eZmaxApi/models/ezsigntemplatepackagemembership_create_object_v1_response_m_payload.py @@ -19,57 +19,76 @@ import json -from typing import List -from pydantic import BaseModel, Field, StrictBool, conint, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictBool +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatepackagemembershipCreateObjectV1ResponseMPayload(BaseModel): """ - Payload for POST /1/object/ezsigntemplatepackagemembership # noqa: E501 - """ - a_pki_ezsigntemplatepackagemembership_id: conlist(conint(strict=True, ge=0)) = Field(..., alias="a_pkiEzsigntemplatepackagemembershipID", description="An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request.") - b_ezsigntemplatepackage_needvalidation: StrictBool = Field(..., alias="bEzsigntemplatepackageNeedvalidation", description="Whether the Ezsignbulksend was automatically modified and needs a manual validation") - b_ezsignbulksend_needvalidation: StrictBool = Field(..., alias="bEzsignbulksendNeedvalidation", description="Whether the Ezsigntemplatepackage was automatically modified and needs a manual validation") - __properties = ["a_pkiEzsigntemplatepackagemembershipID", "bEzsigntemplatepackageNeedvalidation", "bEzsignbulksendNeedvalidation"] + Payload for POST /1/object/ezsigntemplatepackagemembership + """ # noqa: E501 + a_pki_ezsigntemplatepackagemembership_id: List[Annotated[int, Field(strict=True, ge=0)]] = Field(description="An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request.", alias="a_pkiEzsigntemplatepackagemembershipID") + b_ezsigntemplatepackage_needvalidation: StrictBool = Field(description="Whether the Ezsignbulksend was automatically modified and needs a manual validation", alias="bEzsigntemplatepackageNeedvalidation") + b_ezsignbulksend_needvalidation: StrictBool = Field(description="Whether the Ezsigntemplatepackage was automatically modified and needs a manual validation", alias="bEzsignbulksendNeedvalidation") + __properties: ClassVar[List[str]] = ["a_pkiEzsigntemplatepackagemembershipID", "bEzsigntemplatepackageNeedvalidation", "bEzsignbulksendNeedvalidation"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatepackagemembershipCreateObjectV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatepackagemembershipCreateObjectV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatepackagemembershipCreateObjectV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatepackagemembershipCreateObjectV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatepackagemembershipCreateObjectV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplatepackagemembershipCreateObjectV1ResponseMPayload.parse_obj({ - "a_pki_ezsigntemplatepackagemembership_id": obj.get("a_pkiEzsigntemplatepackagemembershipID"), - "b_ezsigntemplatepackage_needvalidation": obj.get("bEzsigntemplatepackageNeedvalidation"), - "b_ezsignbulksend_needvalidation": obj.get("bEzsignbulksendNeedvalidation") + _obj = cls.model_validate({ + "a_pkiEzsigntemplatepackagemembershipID": obj.get("a_pkiEzsigntemplatepackagemembershipID"), + "bEzsigntemplatepackageNeedvalidation": obj.get("bEzsigntemplatepackageNeedvalidation"), + "bEzsignbulksendNeedvalidation": obj.get("bEzsignbulksendNeedvalidation") }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatepackagemembership_delete_object_v1_response.py b/eZmaxApi/models/ezsigntemplatepackagemembership_delete_object_v1_response.py index a1d8d9556..d36ec1496 100644 --- a/eZmaxApi/models/ezsigntemplatepackagemembership_delete_object_v1_response.py +++ b/eZmaxApi/models/ezsigntemplatepackagemembership_delete_object_v1_response.py @@ -19,43 +19,61 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatepackagemembershipDeleteObjectV1Response(BaseModel): """ - Response for DELETE /1/object/ezsigntemplatepackagemembership/{pkiEzsigntemplatepackagemembershipID} # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - __properties = ["objDebugPayload", "objDebug"] + Response for DELETE /1/object/ezsigntemplatepackagemembership/{pkiEzsigntemplatepackagemembershipID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatepackagemembershipDeleteObjectV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatepackagemembershipDeleteObjectV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -65,17 +83,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatepackagemembershipDeleteObjectV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatepackagemembershipDeleteObjectV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatepackagemembershipDeleteObjectV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplatepackagemembershipDeleteObjectV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatepackagemembership_get_object_v2_response.py b/eZmaxApi/models/ezsigntemplatepackagemembership_get_object_v2_response.py index e3f05aa86..e84a5e108 100644 --- a/eZmaxApi/models/ezsigntemplatepackagemembership_get_object_v2_response.py +++ b/eZmaxApi/models/ezsigntemplatepackagemembership_get_object_v2_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.ezsigntemplatepackagemembership_get_object_v2_response_m_payload import EzsigntemplatepackagemembershipGetObjectV2ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatepackagemembershipGetObjectV2Response(BaseModel): """ - Response for GET /2/object/ezsigntemplatepackagemembership/{pkiEzsigntemplatepackagemembershipID} # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzsigntemplatepackagemembershipGetObjectV2ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /2/object/ezsigntemplatepackagemembership/{pkiEzsigntemplatepackagemembershipID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsigntemplatepackagemembershipGetObjectV2ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatepackagemembershipGetObjectV2Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatepackagemembershipGetObjectV2Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatepackagemembershipGetObjectV2Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatepackagemembershipGetObjectV2Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatepackagemembershipGetObjectV2Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplatepackagemembershipGetObjectV2Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzsigntemplatepackagemembershipGetObjectV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsigntemplatepackagemembershipGetObjectV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatepackagemembership_get_object_v2_response_m_payload.py b/eZmaxApi/models/ezsigntemplatepackagemembership_get_object_v2_response_m_payload.py index ee5b74d9f..c1a77dab9 100644 --- a/eZmaxApi/models/ezsigntemplatepackagemembership_get_object_v2_response_m_payload.py +++ b/eZmaxApi/models/ezsigntemplatepackagemembership_get_object_v2_response_m_payload.py @@ -19,57 +19,75 @@ import json - -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.ezsigntemplatepackagemembership_response_compound import EzsigntemplatepackagemembershipResponseCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatepackagemembershipGetObjectV2ResponseMPayload(BaseModel): """ - Payload for GET /2/object/ezsigntemplatepackagemembership/{pkiEzsigntemplatepackagemembershipID} # noqa: E501 - """ - obj_ezsigntemplatepackagemembership: EzsigntemplatepackagemembershipResponseCompound = Field(..., alias="objEzsigntemplatepackagemembership") - __properties = ["objEzsigntemplatepackagemembership"] + Payload for GET /2/object/ezsigntemplatepackagemembership/{pkiEzsigntemplatepackagemembershipID} + """ # noqa: E501 + obj_ezsigntemplatepackagemembership: EzsigntemplatepackagemembershipResponseCompound = Field(alias="objEzsigntemplatepackagemembership") + __properties: ClassVar[List[str]] = ["objEzsigntemplatepackagemembership"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatepackagemembershipGetObjectV2ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatepackagemembershipGetObjectV2ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_ezsigntemplatepackagemembership if self.obj_ezsigntemplatepackagemembership: _dict['objEzsigntemplatepackagemembership'] = self.obj_ezsigntemplatepackagemembership.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatepackagemembershipGetObjectV2ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatepackagemembershipGetObjectV2ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatepackagemembershipGetObjectV2ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplatepackagemembershipGetObjectV2ResponseMPayload.parse_obj({ - "obj_ezsigntemplatepackagemembership": EzsigntemplatepackagemembershipResponseCompound.from_dict(obj.get("objEzsigntemplatepackagemembership")) if obj.get("objEzsigntemplatepackagemembership") is not None else None + _obj = cls.model_validate({ + "objEzsigntemplatepackagemembership": EzsigntemplatepackagemembershipResponseCompound.from_dict(obj.get("objEzsigntemplatepackagemembership")) if obj.get("objEzsigntemplatepackagemembership") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatepackagemembership_request.py b/eZmaxApi/models/ezsigntemplatepackagemembership_request.py index 64fc72481..6cf0c4e66 100644 --- a/eZmaxApi/models/ezsigntemplatepackagemembership_request.py +++ b/eZmaxApi/models/ezsigntemplatepackagemembership_request.py @@ -19,57 +19,76 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatepackagemembershipRequest(BaseModel): """ - A Ezsigntemplatepackagemembership Object # noqa: E501 - """ - pki_ezsigntemplatepackagemembership_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="pkiEzsigntemplatepackagemembershipID", description="The unique ID of the Ezsigntemplatepackagemembership") - fki_ezsigntemplatepackage_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsigntemplatepackageID", description="The unique ID of the Ezsigntemplatepackage") - fki_ezsigntemplate_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsigntemplateID", description="The unique ID of the Ezsigntemplate") - __properties = ["pkiEzsigntemplatepackagemembershipID", "fkiEzsigntemplatepackageID", "fkiEzsigntemplateID"] + A Ezsigntemplatepackagemembership Object + """ # noqa: E501 + pki_ezsigntemplatepackagemembership_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsigntemplatepackagemembership", alias="pkiEzsigntemplatepackagemembershipID") + fki_ezsigntemplatepackage_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsigntemplatepackage", alias="fkiEzsigntemplatepackageID") + fki_ezsigntemplate_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsigntemplate", alias="fkiEzsigntemplateID") + __properties: ClassVar[List[str]] = ["pkiEzsigntemplatepackagemembershipID", "fkiEzsigntemplatepackageID", "fkiEzsigntemplateID"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatepackagemembershipRequest: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatepackagemembershipRequest from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatepackagemembershipRequest: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatepackagemembershipRequest from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatepackagemembershipRequest.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplatepackagemembershipRequest.parse_obj({ - "pki_ezsigntemplatepackagemembership_id": obj.get("pkiEzsigntemplatepackagemembershipID"), - "fki_ezsigntemplatepackage_id": obj.get("fkiEzsigntemplatepackageID"), - "fki_ezsigntemplate_id": obj.get("fkiEzsigntemplateID") + _obj = cls.model_validate({ + "pkiEzsigntemplatepackagemembershipID": obj.get("pkiEzsigntemplatepackagemembershipID"), + "fkiEzsigntemplatepackageID": obj.get("fkiEzsigntemplatepackageID"), + "fkiEzsigntemplateID": obj.get("fkiEzsigntemplateID") }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatepackagemembership_request_compound.py b/eZmaxApi/models/ezsigntemplatepackagemembership_request_compound.py index 5bf5031c5..82ad00bbc 100644 --- a/eZmaxApi/models/ezsigntemplatepackagemembership_request_compound.py +++ b/eZmaxApi/models/ezsigntemplatepackagemembership_request_compound.py @@ -19,57 +19,76 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatepackagemembershipRequestCompound(BaseModel): """ - A Ezsigntemplatepackagemembership Object and children # noqa: E501 - """ - pki_ezsigntemplatepackagemembership_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="pkiEzsigntemplatepackagemembershipID", description="The unique ID of the Ezsigntemplatepackagemembership") - fki_ezsigntemplatepackage_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsigntemplatepackageID", description="The unique ID of the Ezsigntemplatepackage") - fki_ezsigntemplate_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsigntemplateID", description="The unique ID of the Ezsigntemplate") - __properties = ["pkiEzsigntemplatepackagemembershipID", "fkiEzsigntemplatepackageID", "fkiEzsigntemplateID"] + A Ezsigntemplatepackagemembership Object and children + """ # noqa: E501 + pki_ezsigntemplatepackagemembership_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsigntemplatepackagemembership", alias="pkiEzsigntemplatepackagemembershipID") + fki_ezsigntemplatepackage_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsigntemplatepackage", alias="fkiEzsigntemplatepackageID") + fki_ezsigntemplate_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsigntemplate", alias="fkiEzsigntemplateID") + __properties: ClassVar[List[str]] = ["pkiEzsigntemplatepackagemembershipID", "fkiEzsigntemplatepackageID", "fkiEzsigntemplateID"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatepackagemembershipRequestCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatepackagemembershipRequestCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatepackagemembershipRequestCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatepackagemembershipRequestCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatepackagemembershipRequestCompound.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplatepackagemembershipRequestCompound.parse_obj({ - "pki_ezsigntemplatepackagemembership_id": obj.get("pkiEzsigntemplatepackagemembershipID"), - "fki_ezsigntemplatepackage_id": obj.get("fkiEzsigntemplatepackageID"), - "fki_ezsigntemplate_id": obj.get("fkiEzsigntemplateID") + _obj = cls.model_validate({ + "pkiEzsigntemplatepackagemembershipID": obj.get("pkiEzsigntemplatepackagemembershipID"), + "fkiEzsigntemplatepackageID": obj.get("fkiEzsigntemplatepackageID"), + "fkiEzsigntemplateID": obj.get("fkiEzsigntemplateID") }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatepackagemembership_response.py b/eZmaxApi/models/ezsigntemplatepackagemembership_response.py index a2fc34bb7..52cc20fd9 100644 --- a/eZmaxApi/models/ezsigntemplatepackagemembership_response.py +++ b/eZmaxApi/models/ezsigntemplatepackagemembership_response.py @@ -19,59 +19,78 @@ import json - -from pydantic import BaseModel, Field, conint +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatepackagemembershipResponse(BaseModel): """ - A Ezsigntemplatepackagemembership Object # noqa: E501 - """ - pki_ezsigntemplatepackagemembership_id: conint(strict=True, ge=0) = Field(..., alias="pkiEzsigntemplatepackagemembershipID", description="The unique ID of the Ezsigntemplatepackagemembership") - fki_ezsigntemplatepackage_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsigntemplatepackageID", description="The unique ID of the Ezsigntemplatepackage") - fki_ezsigntemplate_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsigntemplateID", description="The unique ID of the Ezsigntemplate") - i_ezsigntemplatepackagemembership_order: conint(strict=True, ge=1) = Field(..., alias="iEzsigntemplatepackagemembershipOrder", description="The order in which the Ezsigntemplate will be imported when using an Ezsigntemplatepackage.") - __properties = ["pkiEzsigntemplatepackagemembershipID", "fkiEzsigntemplatepackageID", "fkiEzsigntemplateID", "iEzsigntemplatepackagemembershipOrder"] + A Ezsigntemplatepackagemembership Object + """ # noqa: E501 + pki_ezsigntemplatepackagemembership_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsigntemplatepackagemembership", alias="pkiEzsigntemplatepackagemembershipID") + fki_ezsigntemplatepackage_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsigntemplatepackage", alias="fkiEzsigntemplatepackageID") + fki_ezsigntemplate_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsigntemplate", alias="fkiEzsigntemplateID") + i_ezsigntemplatepackagemembership_order: Annotated[int, Field(strict=True, ge=1)] = Field(description="The order in which the Ezsigntemplate will be imported when using an Ezsigntemplatepackage.", alias="iEzsigntemplatepackagemembershipOrder") + __properties: ClassVar[List[str]] = ["pkiEzsigntemplatepackagemembershipID", "fkiEzsigntemplatepackageID", "fkiEzsigntemplateID", "iEzsigntemplatepackagemembershipOrder"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatepackagemembershipResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatepackagemembershipResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatepackagemembershipResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatepackagemembershipResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatepackagemembershipResponse.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplatepackagemembershipResponse.parse_obj({ - "pki_ezsigntemplatepackagemembership_id": obj.get("pkiEzsigntemplatepackagemembershipID"), - "fki_ezsigntemplatepackage_id": obj.get("fkiEzsigntemplatepackageID"), - "fki_ezsigntemplate_id": obj.get("fkiEzsigntemplateID"), - "i_ezsigntemplatepackagemembership_order": obj.get("iEzsigntemplatepackagemembershipOrder") + _obj = cls.model_validate({ + "pkiEzsigntemplatepackagemembershipID": obj.get("pkiEzsigntemplatepackagemembershipID"), + "fkiEzsigntemplatepackageID": obj.get("fkiEzsigntemplatepackageID"), + "fkiEzsigntemplateID": obj.get("fkiEzsigntemplateID"), + "iEzsigntemplatepackagemembershipOrder": obj.get("iEzsigntemplatepackagemembershipOrder") }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatepackagemembership_response_compound.py b/eZmaxApi/models/ezsigntemplatepackagemembership_response_compound.py index 614152038..5e17b6e9f 100644 --- a/eZmaxApi/models/ezsigntemplatepackagemembership_response_compound.py +++ b/eZmaxApi/models/ezsigntemplatepackagemembership_response_compound.py @@ -19,47 +19,66 @@ import json -from typing import List -from pydantic import BaseModel, Field, conint, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.ezsigntemplate_response_compound import EzsigntemplateResponseCompound from eZmaxApi.models.ezsigntemplatepackagesignermembership_response_compound import EzsigntemplatepackagesignermembershipResponseCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatepackagemembershipResponseCompound(BaseModel): """ - A Ezsigntemplatepackagemembership Object # noqa: E501 - """ - pki_ezsigntemplatepackagemembership_id: conint(strict=True, ge=0) = Field(..., alias="pkiEzsigntemplatepackagemembershipID", description="The unique ID of the Ezsigntemplatepackagemembership") - fki_ezsigntemplatepackage_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsigntemplatepackageID", description="The unique ID of the Ezsigntemplatepackage") - fki_ezsigntemplate_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsigntemplateID", description="The unique ID of the Ezsigntemplate") - i_ezsigntemplatepackagemembership_order: conint(strict=True, ge=1) = Field(..., alias="iEzsigntemplatepackagemembershipOrder", description="The order in which the Ezsigntemplate will be imported when using an Ezsigntemplatepackage.") - obj_ezsigntemplate: EzsigntemplateResponseCompound = Field(..., alias="objEzsigntemplate") - a_obj_ezsigntemplatepackagesignermembership: conlist(EzsigntemplatepackagesignermembershipResponseCompound) = Field(..., alias="a_objEzsigntemplatepackagesignermembership") - __properties = ["pkiEzsigntemplatepackagemembershipID", "fkiEzsigntemplatepackageID", "fkiEzsigntemplateID", "iEzsigntemplatepackagemembershipOrder", "objEzsigntemplate", "a_objEzsigntemplatepackagesignermembership"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + A Ezsigntemplatepackagemembership Object + """ # noqa: E501 + pki_ezsigntemplatepackagemembership_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsigntemplatepackagemembership", alias="pkiEzsigntemplatepackagemembershipID") + fki_ezsigntemplatepackage_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsigntemplatepackage", alias="fkiEzsigntemplatepackageID") + fki_ezsigntemplate_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsigntemplate", alias="fkiEzsigntemplateID") + i_ezsigntemplatepackagemembership_order: Annotated[int, Field(strict=True, ge=1)] = Field(description="The order in which the Ezsigntemplate will be imported when using an Ezsigntemplatepackage.", alias="iEzsigntemplatepackagemembershipOrder") + obj_ezsigntemplate: EzsigntemplateResponseCompound = Field(alias="objEzsigntemplate") + a_obj_ezsigntemplatepackagesignermembership: List[EzsigntemplatepackagesignermembershipResponseCompound] = Field(alias="a_objEzsigntemplatepackagesignermembership") + __properties: ClassVar[List[str]] = ["pkiEzsigntemplatepackagemembershipID", "fkiEzsigntemplatepackageID", "fkiEzsigntemplateID", "iEzsigntemplatepackagemembershipOrder", "objEzsigntemplate", "a_objEzsigntemplatepackagesignermembership"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatepackagemembershipResponseCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatepackagemembershipResponseCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_ezsigntemplate if self.obj_ezsigntemplate: _dict['objEzsigntemplate'] = self.obj_ezsigntemplate.to_dict() @@ -73,21 +92,21 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatepackagemembershipResponseCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatepackagemembershipResponseCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatepackagemembershipResponseCompound.parse_obj(obj) - - _obj = EzsigntemplatepackagemembershipResponseCompound.parse_obj({ - "pki_ezsigntemplatepackagemembership_id": obj.get("pkiEzsigntemplatepackagemembershipID"), - "fki_ezsigntemplatepackage_id": obj.get("fkiEzsigntemplatepackageID"), - "fki_ezsigntemplate_id": obj.get("fkiEzsigntemplateID"), - "i_ezsigntemplatepackagemembership_order": obj.get("iEzsigntemplatepackagemembershipOrder"), - "obj_ezsigntemplate": EzsigntemplateResponseCompound.from_dict(obj.get("objEzsigntemplate")) if obj.get("objEzsigntemplate") is not None else None, - "a_obj_ezsigntemplatepackagesignermembership": [EzsigntemplatepackagesignermembershipResponseCompound.from_dict(_item) for _item in obj.get("a_objEzsigntemplatepackagesignermembership")] if obj.get("a_objEzsigntemplatepackagesignermembership") is not None else None + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsigntemplatepackagemembershipID": obj.get("pkiEzsigntemplatepackagemembershipID"), + "fkiEzsigntemplatepackageID": obj.get("fkiEzsigntemplatepackageID"), + "fkiEzsigntemplateID": obj.get("fkiEzsigntemplateID"), + "iEzsigntemplatepackagemembershipOrder": obj.get("iEzsigntemplatepackagemembershipOrder"), + "objEzsigntemplate": EzsigntemplateResponseCompound.from_dict(obj.get("objEzsigntemplate")) if obj.get("objEzsigntemplate") is not None else None, + "a_objEzsigntemplatepackagesignermembership": [EzsigntemplatepackagesignermembershipResponseCompound.from_dict(_item) for _item in obj.get("a_objEzsigntemplatepackagesignermembership")] if obj.get("a_objEzsigntemplatepackagesignermembership") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatepackagesigner_create_object_v1_request.py b/eZmaxApi/models/ezsigntemplatepackagesigner_create_object_v1_request.py index c3255be86..0409c5380 100644 --- a/eZmaxApi/models/ezsigntemplatepackagesigner_create_object_v1_request.py +++ b/eZmaxApi/models/ezsigntemplatepackagesigner_create_object_v1_request.py @@ -19,41 +19,60 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.ezsigntemplatepackagesigner_request_compound import EzsigntemplatepackagesignerRequestCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatepackagesignerCreateObjectV1Request(BaseModel): """ - Request for POST /1/object/ezsigntemplatepackagesigner # noqa: E501 - """ - a_obj_ezsigntemplatepackagesigner: conlist(EzsigntemplatepackagesignerRequestCompound, min_items=1) = Field(..., alias="a_objEzsigntemplatepackagesigner") - __properties = ["a_objEzsigntemplatepackagesigner"] + Request for POST /1/object/ezsigntemplatepackagesigner + """ # noqa: E501 + a_obj_ezsigntemplatepackagesigner: Annotated[List[EzsigntemplatepackagesignerRequestCompound], Field(min_length=1)] = Field(alias="a_objEzsigntemplatepackagesigner") + __properties: ClassVar[List[str]] = ["a_objEzsigntemplatepackagesigner"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatepackagesignerCreateObjectV1Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatepackagesignerCreateObjectV1Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_ezsigntemplatepackagesigner (list) _items = [] if self.a_obj_ezsigntemplatepackagesigner: @@ -64,16 +83,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatepackagesignerCreateObjectV1Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatepackagesignerCreateObjectV1Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatepackagesignerCreateObjectV1Request.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplatepackagesignerCreateObjectV1Request.parse_obj({ - "a_obj_ezsigntemplatepackagesigner": [EzsigntemplatepackagesignerRequestCompound.from_dict(_item) for _item in obj.get("a_objEzsigntemplatepackagesigner")] if obj.get("a_objEzsigntemplatepackagesigner") is not None else None + _obj = cls.model_validate({ + "a_objEzsigntemplatepackagesigner": [EzsigntemplatepackagesignerRequestCompound.from_dict(_item) for _item in obj.get("a_objEzsigntemplatepackagesigner")] if obj.get("a_objEzsigntemplatepackagesigner") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatepackagesigner_create_object_v1_response.py b/eZmaxApi/models/ezsigntemplatepackagesigner_create_object_v1_response.py index 2a57271b7..98eace298 100644 --- a/eZmaxApi/models/ezsigntemplatepackagesigner_create_object_v1_response.py +++ b/eZmaxApi/models/ezsigntemplatepackagesigner_create_object_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.ezsigntemplatepackagesigner_create_object_v1_response_m_payload import EzsigntemplatepackagesignerCreateObjectV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatepackagesignerCreateObjectV1Response(BaseModel): """ - Response for POST /1/object/ezsigntemplatepackagesigner # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzsigntemplatepackagesignerCreateObjectV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for POST /1/object/ezsigntemplatepackagesigner + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsigntemplatepackagesignerCreateObjectV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatepackagesignerCreateObjectV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatepackagesignerCreateObjectV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatepackagesignerCreateObjectV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatepackagesignerCreateObjectV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatepackagesignerCreateObjectV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplatepackagesignerCreateObjectV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzsigntemplatepackagesignerCreateObjectV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsigntemplatepackagesignerCreateObjectV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatepackagesigner_create_object_v1_response_m_payload.py b/eZmaxApi/models/ezsigntemplatepackagesigner_create_object_v1_response_m_payload.py index be68b28b3..e8f356cda 100644 --- a/eZmaxApi/models/ezsigntemplatepackagesigner_create_object_v1_response_m_payload.py +++ b/eZmaxApi/models/ezsigntemplatepackagesigner_create_object_v1_response_m_payload.py @@ -19,53 +19,72 @@ import json -from typing import List -from pydantic import BaseModel, Field, conint, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatepackagesignerCreateObjectV1ResponseMPayload(BaseModel): """ - Payload for POST /1/object/ezsigntemplatepackagesigner # noqa: E501 - """ - a_pki_ezsigntemplatepackagesigner_id: conlist(conint(strict=True, ge=0), min_items=1) = Field(..., alias="a_pkiEzsigntemplatepackagesignerID", description="An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request.") - __properties = ["a_pkiEzsigntemplatepackagesignerID"] + Payload for POST /1/object/ezsigntemplatepackagesigner + """ # noqa: E501 + a_pki_ezsigntemplatepackagesigner_id: Annotated[List[Annotated[int, Field(strict=True, ge=0)]], Field(min_length=1)] = Field(description="An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request.", alias="a_pkiEzsigntemplatepackagesignerID") + __properties: ClassVar[List[str]] = ["a_pkiEzsigntemplatepackagesignerID"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatepackagesignerCreateObjectV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatepackagesignerCreateObjectV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatepackagesignerCreateObjectV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatepackagesignerCreateObjectV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatepackagesignerCreateObjectV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplatepackagesignerCreateObjectV1ResponseMPayload.parse_obj({ - "a_pki_ezsigntemplatepackagesigner_id": obj.get("a_pkiEzsigntemplatepackagesignerID") + _obj = cls.model_validate({ + "a_pkiEzsigntemplatepackagesignerID": obj.get("a_pkiEzsigntemplatepackagesignerID") }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatepackagesigner_delete_object_v1_response.py b/eZmaxApi/models/ezsigntemplatepackagesigner_delete_object_v1_response.py index 1c6583408..8851be3a2 100644 --- a/eZmaxApi/models/ezsigntemplatepackagesigner_delete_object_v1_response.py +++ b/eZmaxApi/models/ezsigntemplatepackagesigner_delete_object_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.ezsigntemplatepackagesigner_delete_object_v1_response_m_payload import EzsigntemplatepackagesignerDeleteObjectV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatepackagesignerDeleteObjectV1Response(BaseModel): """ - Response for DELETE /1/object/ezsigntemplatepackagesigner/{pkiEzsigntemplatepackagesignerID} # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzsigntemplatepackagesignerDeleteObjectV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for DELETE /1/object/ezsigntemplatepackagesigner/{pkiEzsigntemplatepackagesignerID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsigntemplatepackagesignerDeleteObjectV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatepackagesignerDeleteObjectV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatepackagesignerDeleteObjectV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatepackagesignerDeleteObjectV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatepackagesignerDeleteObjectV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatepackagesignerDeleteObjectV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplatepackagesignerDeleteObjectV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzsigntemplatepackagesignerDeleteObjectV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsigntemplatepackagesignerDeleteObjectV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatepackagesigner_delete_object_v1_response_m_payload.py b/eZmaxApi/models/ezsigntemplatepackagesigner_delete_object_v1_response_m_payload.py index 3dfd3e3bb..46935fa3d 100644 --- a/eZmaxApi/models/ezsigntemplatepackagesigner_delete_object_v1_response_m_payload.py +++ b/eZmaxApi/models/ezsigntemplatepackagesigner_delete_object_v1_response_m_payload.py @@ -19,55 +19,73 @@ import json - -from pydantic import BaseModel, Field, StrictBool +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictBool +from pydantic import Field +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatepackagesignerDeleteObjectV1ResponseMPayload(BaseModel): """ - Payload for DELETE /1/object/ezsigntemplatepackagesigner/{pkiEzsigntemplatepackagesignerID} # noqa: E501 - """ - b_ezsigntemplatepackage_needvalidation: StrictBool = Field(..., alias="bEzsigntemplatepackageNeedvalidation", description="Whether the Ezsignbulksend was automatically modified and needs a manual validation") - b_ezsignbulksend_needvalidation: StrictBool = Field(..., alias="bEzsignbulksendNeedvalidation", description="Whether the Ezsigntemplatepackage was automatically modified and needs a manual validation") - __properties = ["bEzsigntemplatepackageNeedvalidation", "bEzsignbulksendNeedvalidation"] + Payload for DELETE /1/object/ezsigntemplatepackagesigner/{pkiEzsigntemplatepackagesignerID} + """ # noqa: E501 + b_ezsigntemplatepackage_needvalidation: StrictBool = Field(description="Whether the Ezsignbulksend was automatically modified and needs a manual validation", alias="bEzsigntemplatepackageNeedvalidation") + b_ezsignbulksend_needvalidation: StrictBool = Field(description="Whether the Ezsigntemplatepackage was automatically modified and needs a manual validation", alias="bEzsignbulksendNeedvalidation") + __properties: ClassVar[List[str]] = ["bEzsigntemplatepackageNeedvalidation", "bEzsignbulksendNeedvalidation"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatepackagesignerDeleteObjectV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatepackagesignerDeleteObjectV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatepackagesignerDeleteObjectV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatepackagesignerDeleteObjectV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatepackagesignerDeleteObjectV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplatepackagesignerDeleteObjectV1ResponseMPayload.parse_obj({ - "b_ezsigntemplatepackage_needvalidation": obj.get("bEzsigntemplatepackageNeedvalidation"), - "b_ezsignbulksend_needvalidation": obj.get("bEzsignbulksendNeedvalidation") + _obj = cls.model_validate({ + "bEzsigntemplatepackageNeedvalidation": obj.get("bEzsigntemplatepackageNeedvalidation"), + "bEzsignbulksendNeedvalidation": obj.get("bEzsignbulksendNeedvalidation") }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatepackagesigner_edit_object_v1_request.py b/eZmaxApi/models/ezsigntemplatepackagesigner_edit_object_v1_request.py index d41491c23..62e773ff9 100644 --- a/eZmaxApi/models/ezsigntemplatepackagesigner_edit_object_v1_request.py +++ b/eZmaxApi/models/ezsigntemplatepackagesigner_edit_object_v1_request.py @@ -19,57 +19,75 @@ import json - -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.ezsigntemplatepackagesigner_request_compound import EzsigntemplatepackagesignerRequestCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatepackagesignerEditObjectV1Request(BaseModel): """ - Request for PUT /1/object/ezsigntemplatepackagesigner/{pkiEzsigntemplatepackagesignerID} # noqa: E501 - """ - obj_ezsigntemplatepackagesigner: EzsigntemplatepackagesignerRequestCompound = Field(..., alias="objEzsigntemplatepackagesigner") - __properties = ["objEzsigntemplatepackagesigner"] + Request for PUT /1/object/ezsigntemplatepackagesigner/{pkiEzsigntemplatepackagesignerID} + """ # noqa: E501 + obj_ezsigntemplatepackagesigner: EzsigntemplatepackagesignerRequestCompound = Field(alias="objEzsigntemplatepackagesigner") + __properties: ClassVar[List[str]] = ["objEzsigntemplatepackagesigner"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatepackagesignerEditObjectV1Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatepackagesignerEditObjectV1Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_ezsigntemplatepackagesigner if self.obj_ezsigntemplatepackagesigner: _dict['objEzsigntemplatepackagesigner'] = self.obj_ezsigntemplatepackagesigner.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatepackagesignerEditObjectV1Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatepackagesignerEditObjectV1Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatepackagesignerEditObjectV1Request.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplatepackagesignerEditObjectV1Request.parse_obj({ - "obj_ezsigntemplatepackagesigner": EzsigntemplatepackagesignerRequestCompound.from_dict(obj.get("objEzsigntemplatepackagesigner")) if obj.get("objEzsigntemplatepackagesigner") is not None else None + _obj = cls.model_validate({ + "objEzsigntemplatepackagesigner": EzsigntemplatepackagesignerRequestCompound.from_dict(obj.get("objEzsigntemplatepackagesigner")) if obj.get("objEzsigntemplatepackagesigner") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatepackagesigner_edit_object_v1_response.py b/eZmaxApi/models/ezsigntemplatepackagesigner_edit_object_v1_response.py index 253b87a5b..6d811be10 100644 --- a/eZmaxApi/models/ezsigntemplatepackagesigner_edit_object_v1_response.py +++ b/eZmaxApi/models/ezsigntemplatepackagesigner_edit_object_v1_response.py @@ -19,43 +19,61 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatepackagesignerEditObjectV1Response(BaseModel): """ - Response for PUT /1/object/ezsigntemplatepackagesigner/{pkiEzsigntemplatepackagesignerID} # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - __properties = ["objDebugPayload", "objDebug"] + Response for PUT /1/object/ezsigntemplatepackagesigner/{pkiEzsigntemplatepackagesignerID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatepackagesignerEditObjectV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatepackagesignerEditObjectV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -65,17 +83,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatepackagesignerEditObjectV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatepackagesignerEditObjectV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatepackagesignerEditObjectV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplatepackagesignerEditObjectV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatepackagesigner_get_object_v2_response.py b/eZmaxApi/models/ezsigntemplatepackagesigner_get_object_v2_response.py index e7ccbb55d..0b8733d35 100644 --- a/eZmaxApi/models/ezsigntemplatepackagesigner_get_object_v2_response.py +++ b/eZmaxApi/models/ezsigntemplatepackagesigner_get_object_v2_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.ezsigntemplatepackagesigner_get_object_v2_response_m_payload import EzsigntemplatepackagesignerGetObjectV2ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatepackagesignerGetObjectV2Response(BaseModel): """ - Response for GET /2/object/ezsigntemplatepackagesigner/{pkiEzsigntemplatepackagesignerID} # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzsigntemplatepackagesignerGetObjectV2ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /2/object/ezsigntemplatepackagesigner/{pkiEzsigntemplatepackagesignerID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsigntemplatepackagesignerGetObjectV2ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatepackagesignerGetObjectV2Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatepackagesignerGetObjectV2Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatepackagesignerGetObjectV2Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatepackagesignerGetObjectV2Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatepackagesignerGetObjectV2Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplatepackagesignerGetObjectV2Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzsigntemplatepackagesignerGetObjectV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsigntemplatepackagesignerGetObjectV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatepackagesigner_get_object_v2_response_m_payload.py b/eZmaxApi/models/ezsigntemplatepackagesigner_get_object_v2_response_m_payload.py index 1b9bfb6f8..8648afa4b 100644 --- a/eZmaxApi/models/ezsigntemplatepackagesigner_get_object_v2_response_m_payload.py +++ b/eZmaxApi/models/ezsigntemplatepackagesigner_get_object_v2_response_m_payload.py @@ -19,57 +19,75 @@ import json - -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.ezsigntemplatepackagesigner_response_compound import EzsigntemplatepackagesignerResponseCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatepackagesignerGetObjectV2ResponseMPayload(BaseModel): """ - Payload for GET /2/object/ezsigntemplatepackagesigner/{pkiEzsigntemplatepackagesignerID} # noqa: E501 - """ - obj_ezsigntemplatepackagesigner: EzsigntemplatepackagesignerResponseCompound = Field(..., alias="objEzsigntemplatepackagesigner") - __properties = ["objEzsigntemplatepackagesigner"] + Payload for GET /2/object/ezsigntemplatepackagesigner/{pkiEzsigntemplatepackagesignerID} + """ # noqa: E501 + obj_ezsigntemplatepackagesigner: EzsigntemplatepackagesignerResponseCompound = Field(alias="objEzsigntemplatepackagesigner") + __properties: ClassVar[List[str]] = ["objEzsigntemplatepackagesigner"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatepackagesignerGetObjectV2ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatepackagesignerGetObjectV2ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_ezsigntemplatepackagesigner if self.obj_ezsigntemplatepackagesigner: _dict['objEzsigntemplatepackagesigner'] = self.obj_ezsigntemplatepackagesigner.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatepackagesignerGetObjectV2ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatepackagesignerGetObjectV2ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatepackagesignerGetObjectV2ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplatepackagesignerGetObjectV2ResponseMPayload.parse_obj({ - "obj_ezsigntemplatepackagesigner": EzsigntemplatepackagesignerResponseCompound.from_dict(obj.get("objEzsigntemplatepackagesigner")) if obj.get("objEzsigntemplatepackagesigner") is not None else None + _obj = cls.model_validate({ + "objEzsigntemplatepackagesigner": EzsigntemplatepackagesignerResponseCompound.from_dict(obj.get("objEzsigntemplatepackagesigner")) if obj.get("objEzsigntemplatepackagesigner") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatepackagesigner_request.py b/eZmaxApi/models/ezsigntemplatepackagesigner_request.py index 941053e6a..1a7caceb0 100644 --- a/eZmaxApi/models/ezsigntemplatepackagesigner_request.py +++ b/eZmaxApi/models/ezsigntemplatepackagesigner_request.py @@ -19,57 +19,76 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictStr, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictStr +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatepackagesignerRequest(BaseModel): """ - A Ezsigntemplatepackagesigner Object # noqa: E501 - """ - pki_ezsigntemplatepackagesigner_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="pkiEzsigntemplatepackagesignerID", description="The unique ID of the Ezsigntemplatepackagesigner") - fki_ezsigntemplatepackage_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsigntemplatepackageID", description="The unique ID of the Ezsigntemplatepackage") - s_ezsigntemplatepackagesigner_description: StrictStr = Field(..., alias="sEzsigntemplatepackagesignerDescription", description="The description of the Ezsigntemplatepackagesigner") - __properties = ["pkiEzsigntemplatepackagesignerID", "fkiEzsigntemplatepackageID", "sEzsigntemplatepackagesignerDescription"] + A Ezsigntemplatepackagesigner Object + """ # noqa: E501 + pki_ezsigntemplatepackagesigner_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsigntemplatepackagesigner", alias="pkiEzsigntemplatepackagesignerID") + fki_ezsigntemplatepackage_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsigntemplatepackage", alias="fkiEzsigntemplatepackageID") + s_ezsigntemplatepackagesigner_description: StrictStr = Field(description="The description of the Ezsigntemplatepackagesigner", alias="sEzsigntemplatepackagesignerDescription") + __properties: ClassVar[List[str]] = ["pkiEzsigntemplatepackagesignerID", "fkiEzsigntemplatepackageID", "sEzsigntemplatepackagesignerDescription"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatepackagesignerRequest: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatepackagesignerRequest from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatepackagesignerRequest: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatepackagesignerRequest from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatepackagesignerRequest.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplatepackagesignerRequest.parse_obj({ - "pki_ezsigntemplatepackagesigner_id": obj.get("pkiEzsigntemplatepackagesignerID"), - "fki_ezsigntemplatepackage_id": obj.get("fkiEzsigntemplatepackageID"), - "s_ezsigntemplatepackagesigner_description": obj.get("sEzsigntemplatepackagesignerDescription") + _obj = cls.model_validate({ + "pkiEzsigntemplatepackagesignerID": obj.get("pkiEzsigntemplatepackagesignerID"), + "fkiEzsigntemplatepackageID": obj.get("fkiEzsigntemplatepackageID"), + "sEzsigntemplatepackagesignerDescription": obj.get("sEzsigntemplatepackagesignerDescription") }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatepackagesigner_request_compound.py b/eZmaxApi/models/ezsigntemplatepackagesigner_request_compound.py index 74a1c36c3..cdfa2de81 100644 --- a/eZmaxApi/models/ezsigntemplatepackagesigner_request_compound.py +++ b/eZmaxApi/models/ezsigntemplatepackagesigner_request_compound.py @@ -19,57 +19,76 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictStr, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictStr +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatepackagesignerRequestCompound(BaseModel): """ - A Ezsigntemplatepackagesigner Object and children # noqa: E501 - """ - pki_ezsigntemplatepackagesigner_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="pkiEzsigntemplatepackagesignerID", description="The unique ID of the Ezsigntemplatepackagesigner") - fki_ezsigntemplatepackage_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsigntemplatepackageID", description="The unique ID of the Ezsigntemplatepackage") - s_ezsigntemplatepackagesigner_description: StrictStr = Field(..., alias="sEzsigntemplatepackagesignerDescription", description="The description of the Ezsigntemplatepackagesigner") - __properties = ["pkiEzsigntemplatepackagesignerID", "fkiEzsigntemplatepackageID", "sEzsigntemplatepackagesignerDescription"] + A Ezsigntemplatepackagesigner Object and children + """ # noqa: E501 + pki_ezsigntemplatepackagesigner_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsigntemplatepackagesigner", alias="pkiEzsigntemplatepackagesignerID") + fki_ezsigntemplatepackage_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsigntemplatepackage", alias="fkiEzsigntemplatepackageID") + s_ezsigntemplatepackagesigner_description: StrictStr = Field(description="The description of the Ezsigntemplatepackagesigner", alias="sEzsigntemplatepackagesignerDescription") + __properties: ClassVar[List[str]] = ["pkiEzsigntemplatepackagesignerID", "fkiEzsigntemplatepackageID", "sEzsigntemplatepackagesignerDescription"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatepackagesignerRequestCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatepackagesignerRequestCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatepackagesignerRequestCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatepackagesignerRequestCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatepackagesignerRequestCompound.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplatepackagesignerRequestCompound.parse_obj({ - "pki_ezsigntemplatepackagesigner_id": obj.get("pkiEzsigntemplatepackagesignerID"), - "fki_ezsigntemplatepackage_id": obj.get("fkiEzsigntemplatepackageID"), - "s_ezsigntemplatepackagesigner_description": obj.get("sEzsigntemplatepackagesignerDescription") + _obj = cls.model_validate({ + "pkiEzsigntemplatepackagesignerID": obj.get("pkiEzsigntemplatepackagesignerID"), + "fkiEzsigntemplatepackageID": obj.get("fkiEzsigntemplatepackageID"), + "sEzsigntemplatepackagesignerDescription": obj.get("sEzsigntemplatepackagesignerDescription") }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatepackagesigner_response.py b/eZmaxApi/models/ezsigntemplatepackagesigner_response.py index 3926c9434..e2fd39605 100644 --- a/eZmaxApi/models/ezsigntemplatepackagesigner_response.py +++ b/eZmaxApi/models/ezsigntemplatepackagesigner_response.py @@ -19,57 +19,76 @@ import json - -from pydantic import BaseModel, Field, StrictStr, conint +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictStr +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatepackagesignerResponse(BaseModel): """ - A Ezsigntemplatepackagesigner Object # noqa: E501 - """ - pki_ezsigntemplatepackagesigner_id: conint(strict=True, ge=0) = Field(..., alias="pkiEzsigntemplatepackagesignerID", description="The unique ID of the Ezsigntemplatepackagesigner") - fki_ezsigntemplatepackage_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsigntemplatepackageID", description="The unique ID of the Ezsigntemplatepackage") - s_ezsigntemplatepackagesigner_description: StrictStr = Field(..., alias="sEzsigntemplatepackagesignerDescription", description="The description of the Ezsigntemplatepackagesigner") - __properties = ["pkiEzsigntemplatepackagesignerID", "fkiEzsigntemplatepackageID", "sEzsigntemplatepackagesignerDescription"] + A Ezsigntemplatepackagesigner Object + """ # noqa: E501 + pki_ezsigntemplatepackagesigner_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsigntemplatepackagesigner", alias="pkiEzsigntemplatepackagesignerID") + fki_ezsigntemplatepackage_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsigntemplatepackage", alias="fkiEzsigntemplatepackageID") + s_ezsigntemplatepackagesigner_description: StrictStr = Field(description="The description of the Ezsigntemplatepackagesigner", alias="sEzsigntemplatepackagesignerDescription") + __properties: ClassVar[List[str]] = ["pkiEzsigntemplatepackagesignerID", "fkiEzsigntemplatepackageID", "sEzsigntemplatepackagesignerDescription"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatepackagesignerResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatepackagesignerResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatepackagesignerResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatepackagesignerResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatepackagesignerResponse.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplatepackagesignerResponse.parse_obj({ - "pki_ezsigntemplatepackagesigner_id": obj.get("pkiEzsigntemplatepackagesignerID"), - "fki_ezsigntemplatepackage_id": obj.get("fkiEzsigntemplatepackageID"), - "s_ezsigntemplatepackagesigner_description": obj.get("sEzsigntemplatepackagesignerDescription") + _obj = cls.model_validate({ + "pkiEzsigntemplatepackagesignerID": obj.get("pkiEzsigntemplatepackagesignerID"), + "fkiEzsigntemplatepackageID": obj.get("fkiEzsigntemplatepackageID"), + "sEzsigntemplatepackagesignerDescription": obj.get("sEzsigntemplatepackagesignerDescription") }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatepackagesigner_response_compound.py b/eZmaxApi/models/ezsigntemplatepackagesigner_response_compound.py index a9dbaafdb..18c0387d3 100644 --- a/eZmaxApi/models/ezsigntemplatepackagesigner_response_compound.py +++ b/eZmaxApi/models/ezsigntemplatepackagesigner_response_compound.py @@ -19,57 +19,76 @@ import json - -from pydantic import BaseModel, Field, StrictStr, conint +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictStr +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatepackagesignerResponseCompound(BaseModel): """ - A Ezsigntemplatepackagesigner Object # noqa: E501 - """ - pki_ezsigntemplatepackagesigner_id: conint(strict=True, ge=0) = Field(..., alias="pkiEzsigntemplatepackagesignerID", description="The unique ID of the Ezsigntemplatepackagesigner") - fki_ezsigntemplatepackage_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsigntemplatepackageID", description="The unique ID of the Ezsigntemplatepackage") - s_ezsigntemplatepackagesigner_description: StrictStr = Field(..., alias="sEzsigntemplatepackagesignerDescription", description="The description of the Ezsigntemplatepackagesigner") - __properties = ["pkiEzsigntemplatepackagesignerID", "fkiEzsigntemplatepackageID", "sEzsigntemplatepackagesignerDescription"] + A Ezsigntemplatepackagesigner Object + """ # noqa: E501 + pki_ezsigntemplatepackagesigner_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsigntemplatepackagesigner", alias="pkiEzsigntemplatepackagesignerID") + fki_ezsigntemplatepackage_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsigntemplatepackage", alias="fkiEzsigntemplatepackageID") + s_ezsigntemplatepackagesigner_description: StrictStr = Field(description="The description of the Ezsigntemplatepackagesigner", alias="sEzsigntemplatepackagesignerDescription") + __properties: ClassVar[List[str]] = ["pkiEzsigntemplatepackagesignerID", "fkiEzsigntemplatepackageID", "sEzsigntemplatepackagesignerDescription"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatepackagesignerResponseCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatepackagesignerResponseCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatepackagesignerResponseCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatepackagesignerResponseCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatepackagesignerResponseCompound.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplatepackagesignerResponseCompound.parse_obj({ - "pki_ezsigntemplatepackagesigner_id": obj.get("pkiEzsigntemplatepackagesignerID"), - "fki_ezsigntemplatepackage_id": obj.get("fkiEzsigntemplatepackageID"), - "s_ezsigntemplatepackagesigner_description": obj.get("sEzsigntemplatepackagesignerDescription") + _obj = cls.model_validate({ + "pkiEzsigntemplatepackagesignerID": obj.get("pkiEzsigntemplatepackagesignerID"), + "fkiEzsigntemplatepackageID": obj.get("fkiEzsigntemplatepackageID"), + "sEzsigntemplatepackagesignerDescription": obj.get("sEzsigntemplatepackagesignerDescription") }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatepackagesignermembership_create_object_v1_request.py b/eZmaxApi/models/ezsigntemplatepackagesignermembership_create_object_v1_request.py index 2cd591b26..9e9dfd1b8 100644 --- a/eZmaxApi/models/ezsigntemplatepackagesignermembership_create_object_v1_request.py +++ b/eZmaxApi/models/ezsigntemplatepackagesignermembership_create_object_v1_request.py @@ -19,41 +19,60 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.ezsigntemplatepackagesignermembership_request_compound import EzsigntemplatepackagesignermembershipRequestCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatepackagesignermembershipCreateObjectV1Request(BaseModel): """ - Request for POST /1/object/ezsigntemplatepackagesignermembership # noqa: E501 - """ - a_obj_ezsigntemplatepackagesignermembership: conlist(EzsigntemplatepackagesignermembershipRequestCompound, min_items=1) = Field(..., alias="a_objEzsigntemplatepackagesignermembership") - __properties = ["a_objEzsigntemplatepackagesignermembership"] + Request for POST /1/object/ezsigntemplatepackagesignermembership + """ # noqa: E501 + a_obj_ezsigntemplatepackagesignermembership: Annotated[List[EzsigntemplatepackagesignermembershipRequestCompound], Field(min_length=1)] = Field(alias="a_objEzsigntemplatepackagesignermembership") + __properties: ClassVar[List[str]] = ["a_objEzsigntemplatepackagesignermembership"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatepackagesignermembershipCreateObjectV1Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatepackagesignermembershipCreateObjectV1Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_ezsigntemplatepackagesignermembership (list) _items = [] if self.a_obj_ezsigntemplatepackagesignermembership: @@ -64,16 +83,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatepackagesignermembershipCreateObjectV1Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatepackagesignermembershipCreateObjectV1Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatepackagesignermembershipCreateObjectV1Request.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplatepackagesignermembershipCreateObjectV1Request.parse_obj({ - "a_obj_ezsigntemplatepackagesignermembership": [EzsigntemplatepackagesignermembershipRequestCompound.from_dict(_item) for _item in obj.get("a_objEzsigntemplatepackagesignermembership")] if obj.get("a_objEzsigntemplatepackagesignermembership") is not None else None + _obj = cls.model_validate({ + "a_objEzsigntemplatepackagesignermembership": [EzsigntemplatepackagesignermembershipRequestCompound.from_dict(_item) for _item in obj.get("a_objEzsigntemplatepackagesignermembership")] if obj.get("a_objEzsigntemplatepackagesignermembership") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatepackagesignermembership_create_object_v1_response.py b/eZmaxApi/models/ezsigntemplatepackagesignermembership_create_object_v1_response.py index 5af1f9739..950892849 100644 --- a/eZmaxApi/models/ezsigntemplatepackagesignermembership_create_object_v1_response.py +++ b/eZmaxApi/models/ezsigntemplatepackagesignermembership_create_object_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.ezsigntemplatepackagesignermembership_create_object_v1_response_m_payload import EzsigntemplatepackagesignermembershipCreateObjectV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatepackagesignermembershipCreateObjectV1Response(BaseModel): """ - Response for POST /1/object/ezsigntemplatepackagesignermembership # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzsigntemplatepackagesignermembershipCreateObjectV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for POST /1/object/ezsigntemplatepackagesignermembership + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsigntemplatepackagesignermembershipCreateObjectV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatepackagesignermembershipCreateObjectV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatepackagesignermembershipCreateObjectV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatepackagesignermembershipCreateObjectV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatepackagesignermembershipCreateObjectV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatepackagesignermembershipCreateObjectV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplatepackagesignermembershipCreateObjectV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzsigntemplatepackagesignermembershipCreateObjectV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsigntemplatepackagesignermembershipCreateObjectV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatepackagesignermembership_create_object_v1_response_m_payload.py b/eZmaxApi/models/ezsigntemplatepackagesignermembership_create_object_v1_response_m_payload.py index bbdfb9296..02bbbdc03 100644 --- a/eZmaxApi/models/ezsigntemplatepackagesignermembership_create_object_v1_response_m_payload.py +++ b/eZmaxApi/models/ezsigntemplatepackagesignermembership_create_object_v1_response_m_payload.py @@ -19,53 +19,72 @@ import json -from typing import List -from pydantic import BaseModel, Field, conint, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatepackagesignermembershipCreateObjectV1ResponseMPayload(BaseModel): """ - Payload for POST /1/object/ezsigntemplatepackagesignermembership # noqa: E501 - """ - a_pki_ezsigntemplatepackagesignermembership_id: conlist(conint(strict=True, ge=0), min_items=1) = Field(..., alias="a_pkiEzsigntemplatepackagesignermembershipID", description="An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request.") - __properties = ["a_pkiEzsigntemplatepackagesignermembershipID"] + Payload for POST /1/object/ezsigntemplatepackagesignermembership + """ # noqa: E501 + a_pki_ezsigntemplatepackagesignermembership_id: Annotated[List[Annotated[int, Field(strict=True, ge=0)]], Field(min_length=1)] = Field(description="An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request.", alias="a_pkiEzsigntemplatepackagesignermembershipID") + __properties: ClassVar[List[str]] = ["a_pkiEzsigntemplatepackagesignermembershipID"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatepackagesignermembershipCreateObjectV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatepackagesignermembershipCreateObjectV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatepackagesignermembershipCreateObjectV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatepackagesignermembershipCreateObjectV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatepackagesignermembershipCreateObjectV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplatepackagesignermembershipCreateObjectV1ResponseMPayload.parse_obj({ - "a_pki_ezsigntemplatepackagesignermembership_id": obj.get("a_pkiEzsigntemplatepackagesignermembershipID") + _obj = cls.model_validate({ + "a_pkiEzsigntemplatepackagesignermembershipID": obj.get("a_pkiEzsigntemplatepackagesignermembershipID") }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatepackagesignermembership_delete_object_v1_response.py b/eZmaxApi/models/ezsigntemplatepackagesignermembership_delete_object_v1_response.py index 25c562eb9..0a40ed2d3 100644 --- a/eZmaxApi/models/ezsigntemplatepackagesignermembership_delete_object_v1_response.py +++ b/eZmaxApi/models/ezsigntemplatepackagesignermembership_delete_object_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.ezsigntemplatepackagesignermembership_delete_object_v1_response_m_payload import EzsigntemplatepackagesignermembershipDeleteObjectV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatepackagesignermembershipDeleteObjectV1Response(BaseModel): """ - Response for DELETE /1/object/ezsigntemplatepackagesignermembership/{pkiEzsigntemplatepackagesignermembershipID} # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzsigntemplatepackagesignermembershipDeleteObjectV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for DELETE /1/object/ezsigntemplatepackagesignermembership/{pkiEzsigntemplatepackagesignermembershipID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsigntemplatepackagesignermembershipDeleteObjectV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatepackagesignermembershipDeleteObjectV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatepackagesignermembershipDeleteObjectV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatepackagesignermembershipDeleteObjectV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatepackagesignermembershipDeleteObjectV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatepackagesignermembershipDeleteObjectV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplatepackagesignermembershipDeleteObjectV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzsigntemplatepackagesignermembershipDeleteObjectV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsigntemplatepackagesignermembershipDeleteObjectV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatepackagesignermembership_delete_object_v1_response_m_payload.py b/eZmaxApi/models/ezsigntemplatepackagesignermembership_delete_object_v1_response_m_payload.py index 0513542dc..4482fbc49 100644 --- a/eZmaxApi/models/ezsigntemplatepackagesignermembership_delete_object_v1_response_m_payload.py +++ b/eZmaxApi/models/ezsigntemplatepackagesignermembership_delete_object_v1_response_m_payload.py @@ -19,55 +19,73 @@ import json - -from pydantic import BaseModel, Field, StrictBool +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictBool +from pydantic import Field +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatepackagesignermembershipDeleteObjectV1ResponseMPayload(BaseModel): """ - Payload for DELETE /1/object/ezsigntemplatepackagesignermembership/{pkiEzsigntemplatepackagesignermembershipID} # noqa: E501 - """ - b_ezsigntemplatepackage_needvalidation: StrictBool = Field(..., alias="bEzsigntemplatepackageNeedvalidation", description="Whether the Ezsignbulksend was automatically modified and needs a manual validation") - b_ezsignbulksend_needvalidation: StrictBool = Field(..., alias="bEzsignbulksendNeedvalidation", description="Whether the Ezsigntemplatepackage was automatically modified and needs a manual validation") - __properties = ["bEzsigntemplatepackageNeedvalidation", "bEzsignbulksendNeedvalidation"] + Payload for DELETE /1/object/ezsigntemplatepackagesignermembership/{pkiEzsigntemplatepackagesignermembershipID} + """ # noqa: E501 + b_ezsigntemplatepackage_needvalidation: StrictBool = Field(description="Whether the Ezsignbulksend was automatically modified and needs a manual validation", alias="bEzsigntemplatepackageNeedvalidation") + b_ezsignbulksend_needvalidation: StrictBool = Field(description="Whether the Ezsigntemplatepackage was automatically modified and needs a manual validation", alias="bEzsignbulksendNeedvalidation") + __properties: ClassVar[List[str]] = ["bEzsigntemplatepackageNeedvalidation", "bEzsignbulksendNeedvalidation"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatepackagesignermembershipDeleteObjectV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatepackagesignermembershipDeleteObjectV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatepackagesignermembershipDeleteObjectV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatepackagesignermembershipDeleteObjectV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatepackagesignermembershipDeleteObjectV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplatepackagesignermembershipDeleteObjectV1ResponseMPayload.parse_obj({ - "b_ezsigntemplatepackage_needvalidation": obj.get("bEzsigntemplatepackageNeedvalidation"), - "b_ezsignbulksend_needvalidation": obj.get("bEzsignbulksendNeedvalidation") + _obj = cls.model_validate({ + "bEzsigntemplatepackageNeedvalidation": obj.get("bEzsigntemplatepackageNeedvalidation"), + "bEzsignbulksendNeedvalidation": obj.get("bEzsignbulksendNeedvalidation") }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatepackagesignermembership_get_object_v2_response.py b/eZmaxApi/models/ezsigntemplatepackagesignermembership_get_object_v2_response.py index c91151a6c..067d6696d 100644 --- a/eZmaxApi/models/ezsigntemplatepackagesignermembership_get_object_v2_response.py +++ b/eZmaxApi/models/ezsigntemplatepackagesignermembership_get_object_v2_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.ezsigntemplatepackagesignermembership_get_object_v2_response_m_payload import EzsigntemplatepackagesignermembershipGetObjectV2ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatepackagesignermembershipGetObjectV2Response(BaseModel): """ - Response for GET /2/object/ezsigntemplatepackagesignermembership/{pkiEzsigntemplatepackagesignermembershipID} # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzsigntemplatepackagesignermembershipGetObjectV2ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /2/object/ezsigntemplatepackagesignermembership/{pkiEzsigntemplatepackagesignermembershipID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsigntemplatepackagesignermembershipGetObjectV2ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatepackagesignermembershipGetObjectV2Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatepackagesignermembershipGetObjectV2Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatepackagesignermembershipGetObjectV2Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatepackagesignermembershipGetObjectV2Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatepackagesignermembershipGetObjectV2Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplatepackagesignermembershipGetObjectV2Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzsigntemplatepackagesignermembershipGetObjectV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsigntemplatepackagesignermembershipGetObjectV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatepackagesignermembership_get_object_v2_response_m_payload.py b/eZmaxApi/models/ezsigntemplatepackagesignermembership_get_object_v2_response_m_payload.py index ccba811e6..6cd4f0b5a 100644 --- a/eZmaxApi/models/ezsigntemplatepackagesignermembership_get_object_v2_response_m_payload.py +++ b/eZmaxApi/models/ezsigntemplatepackagesignermembership_get_object_v2_response_m_payload.py @@ -19,57 +19,75 @@ import json - -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.ezsigntemplatepackagesignermembership_response_compound import EzsigntemplatepackagesignermembershipResponseCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatepackagesignermembershipGetObjectV2ResponseMPayload(BaseModel): """ - Payload for GET /2/object/ezsigntemplatepackagesignermembership/{pkiEzsigntemplatepackagesignermembershipID} # noqa: E501 - """ - obj_ezsigntemplatepackagesignermembership: EzsigntemplatepackagesignermembershipResponseCompound = Field(..., alias="objEzsigntemplatepackagesignermembership") - __properties = ["objEzsigntemplatepackagesignermembership"] + Payload for GET /2/object/ezsigntemplatepackagesignermembership/{pkiEzsigntemplatepackagesignermembershipID} + """ # noqa: E501 + obj_ezsigntemplatepackagesignermembership: EzsigntemplatepackagesignermembershipResponseCompound = Field(alias="objEzsigntemplatepackagesignermembership") + __properties: ClassVar[List[str]] = ["objEzsigntemplatepackagesignermembership"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatepackagesignermembershipGetObjectV2ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatepackagesignermembershipGetObjectV2ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_ezsigntemplatepackagesignermembership if self.obj_ezsigntemplatepackagesignermembership: _dict['objEzsigntemplatepackagesignermembership'] = self.obj_ezsigntemplatepackagesignermembership.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatepackagesignermembershipGetObjectV2ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatepackagesignermembershipGetObjectV2ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatepackagesignermembershipGetObjectV2ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplatepackagesignermembershipGetObjectV2ResponseMPayload.parse_obj({ - "obj_ezsigntemplatepackagesignermembership": EzsigntemplatepackagesignermembershipResponseCompound.from_dict(obj.get("objEzsigntemplatepackagesignermembership")) if obj.get("objEzsigntemplatepackagesignermembership") is not None else None + _obj = cls.model_validate({ + "objEzsigntemplatepackagesignermembership": EzsigntemplatepackagesignermembershipResponseCompound.from_dict(obj.get("objEzsigntemplatepackagesignermembership")) if obj.get("objEzsigntemplatepackagesignermembership") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatepackagesignermembership_request.py b/eZmaxApi/models/ezsigntemplatepackagesignermembership_request.py index bc8ed2123..99e424ee1 100644 --- a/eZmaxApi/models/ezsigntemplatepackagesignermembership_request.py +++ b/eZmaxApi/models/ezsigntemplatepackagesignermembership_request.py @@ -19,61 +19,80 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatepackagesignermembershipRequest(BaseModel): """ - A Ezsigntemplatepackagesignermembership Object # noqa: E501 - """ - pki_ezsigntemplatepackagesignermembership_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="pkiEzsigntemplatepackagesignermembershipID", description="The unique ID of the Ezsigntemplatepackagesignermembership") - fki_ezsigntemplatepackagemembership_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsigntemplatepackagemembershipID", description="The unique ID of the Ezsigntemplatepackagemembership") - fki_ezsigntemplatepackagesigner_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsigntemplatepackagesignerID", description="The unique ID of the Ezsigntemplatepackagesigner") - fki_ezsigntemplatesigner_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsigntemplatesignerID", description="The unique ID of the Ezsigntemplatesigner") - i_ezsigntemplatepackagesignermembership_copy: Optional[conint(strict=True, ge=1)] = Field(None, alias="iEzsigntemplatepackagesignermembershipCopy", description="The Copy number in case of multiple copies.") - __properties = ["pkiEzsigntemplatepackagesignermembershipID", "fkiEzsigntemplatepackagemembershipID", "fkiEzsigntemplatepackagesignerID", "fkiEzsigntemplatesignerID", "iEzsigntemplatepackagesignermembershipCopy"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + A Ezsigntemplatepackagesignermembership Object + """ # noqa: E501 + pki_ezsigntemplatepackagesignermembership_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsigntemplatepackagesignermembership", alias="pkiEzsigntemplatepackagesignermembershipID") + fki_ezsigntemplatepackagemembership_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsigntemplatepackagemembership", alias="fkiEzsigntemplatepackagemembershipID") + fki_ezsigntemplatepackagesigner_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsigntemplatepackagesigner", alias="fkiEzsigntemplatepackagesignerID") + fki_ezsigntemplatesigner_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsigntemplatesigner", alias="fkiEzsigntemplatesignerID") + i_ezsigntemplatepackagesignermembership_copy: Optional[Annotated[int, Field(strict=True, ge=1)]] = Field(default=None, description="The Copy number in case of multiple copies.", alias="iEzsigntemplatepackagesignermembershipCopy") + __properties: ClassVar[List[str]] = ["pkiEzsigntemplatepackagesignermembershipID", "fkiEzsigntemplatepackagemembershipID", "fkiEzsigntemplatepackagesignerID", "fkiEzsigntemplatesignerID", "iEzsigntemplatepackagesignermembershipCopy"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatepackagesignermembershipRequest: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatepackagesignermembershipRequest from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatepackagesignermembershipRequest: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatepackagesignermembershipRequest from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatepackagesignermembershipRequest.parse_obj(obj) - - _obj = EzsigntemplatepackagesignermembershipRequest.parse_obj({ - "pki_ezsigntemplatepackagesignermembership_id": obj.get("pkiEzsigntemplatepackagesignermembershipID"), - "fki_ezsigntemplatepackagemembership_id": obj.get("fkiEzsigntemplatepackagemembershipID"), - "fki_ezsigntemplatepackagesigner_id": obj.get("fkiEzsigntemplatepackagesignerID"), - "fki_ezsigntemplatesigner_id": obj.get("fkiEzsigntemplatesignerID"), - "i_ezsigntemplatepackagesignermembership_copy": obj.get("iEzsigntemplatepackagesignermembershipCopy") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsigntemplatepackagesignermembershipID": obj.get("pkiEzsigntemplatepackagesignermembershipID"), + "fkiEzsigntemplatepackagemembershipID": obj.get("fkiEzsigntemplatepackagemembershipID"), + "fkiEzsigntemplatepackagesignerID": obj.get("fkiEzsigntemplatepackagesignerID"), + "fkiEzsigntemplatesignerID": obj.get("fkiEzsigntemplatesignerID"), + "iEzsigntemplatepackagesignermembershipCopy": obj.get("iEzsigntemplatepackagesignermembershipCopy") }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatepackagesignermembership_request_compound.py b/eZmaxApi/models/ezsigntemplatepackagesignermembership_request_compound.py index e86d16b97..f3c5affae 100644 --- a/eZmaxApi/models/ezsigntemplatepackagesignermembership_request_compound.py +++ b/eZmaxApi/models/ezsigntemplatepackagesignermembership_request_compound.py @@ -19,61 +19,80 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatepackagesignermembershipRequestCompound(BaseModel): """ - A Ezsigntemplatepackagesignermembership Object and children # noqa: E501 - """ - pki_ezsigntemplatepackagesignermembership_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="pkiEzsigntemplatepackagesignermembershipID", description="The unique ID of the Ezsigntemplatepackagesignermembership") - fki_ezsigntemplatepackagemembership_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsigntemplatepackagemembershipID", description="The unique ID of the Ezsigntemplatepackagemembership") - fki_ezsigntemplatepackagesigner_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsigntemplatepackagesignerID", description="The unique ID of the Ezsigntemplatepackagesigner") - fki_ezsigntemplatesigner_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsigntemplatesignerID", description="The unique ID of the Ezsigntemplatesigner") - i_ezsigntemplatepackagesignermembership_copy: Optional[conint(strict=True, ge=1)] = Field(None, alias="iEzsigntemplatepackagesignermembershipCopy", description="The Copy number in case of multiple copies.") - __properties = ["pkiEzsigntemplatepackagesignermembershipID", "fkiEzsigntemplatepackagemembershipID", "fkiEzsigntemplatepackagesignerID", "fkiEzsigntemplatesignerID", "iEzsigntemplatepackagesignermembershipCopy"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + A Ezsigntemplatepackagesignermembership Object and children + """ # noqa: E501 + pki_ezsigntemplatepackagesignermembership_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsigntemplatepackagesignermembership", alias="pkiEzsigntemplatepackagesignermembershipID") + fki_ezsigntemplatepackagemembership_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsigntemplatepackagemembership", alias="fkiEzsigntemplatepackagemembershipID") + fki_ezsigntemplatepackagesigner_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsigntemplatepackagesigner", alias="fkiEzsigntemplatepackagesignerID") + fki_ezsigntemplatesigner_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsigntemplatesigner", alias="fkiEzsigntemplatesignerID") + i_ezsigntemplatepackagesignermembership_copy: Optional[Annotated[int, Field(strict=True, ge=1)]] = Field(default=None, description="The Copy number in case of multiple copies.", alias="iEzsigntemplatepackagesignermembershipCopy") + __properties: ClassVar[List[str]] = ["pkiEzsigntemplatepackagesignermembershipID", "fkiEzsigntemplatepackagemembershipID", "fkiEzsigntemplatepackagesignerID", "fkiEzsigntemplatesignerID", "iEzsigntemplatepackagesignermembershipCopy"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatepackagesignermembershipRequestCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatepackagesignermembershipRequestCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatepackagesignermembershipRequestCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatepackagesignermembershipRequestCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatepackagesignermembershipRequestCompound.parse_obj(obj) - - _obj = EzsigntemplatepackagesignermembershipRequestCompound.parse_obj({ - "pki_ezsigntemplatepackagesignermembership_id": obj.get("pkiEzsigntemplatepackagesignermembershipID"), - "fki_ezsigntemplatepackagemembership_id": obj.get("fkiEzsigntemplatepackagemembershipID"), - "fki_ezsigntemplatepackagesigner_id": obj.get("fkiEzsigntemplatepackagesignerID"), - "fki_ezsigntemplatesigner_id": obj.get("fkiEzsigntemplatesignerID"), - "i_ezsigntemplatepackagesignermembership_copy": obj.get("iEzsigntemplatepackagesignermembershipCopy") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsigntemplatepackagesignermembershipID": obj.get("pkiEzsigntemplatepackagesignermembershipID"), + "fkiEzsigntemplatepackagemembershipID": obj.get("fkiEzsigntemplatepackagemembershipID"), + "fkiEzsigntemplatepackagesignerID": obj.get("fkiEzsigntemplatepackagesignerID"), + "fkiEzsigntemplatesignerID": obj.get("fkiEzsigntemplatesignerID"), + "iEzsigntemplatepackagesignermembershipCopy": obj.get("iEzsigntemplatepackagesignermembershipCopy") }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatepackagesignermembership_response.py b/eZmaxApi/models/ezsigntemplatepackagesignermembership_response.py index fd43922f8..914d38d54 100644 --- a/eZmaxApi/models/ezsigntemplatepackagesignermembership_response.py +++ b/eZmaxApi/models/ezsigntemplatepackagesignermembership_response.py @@ -19,61 +19,80 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatepackagesignermembershipResponse(BaseModel): """ - A Ezsigntemplatepackagesignermembership Object # noqa: E501 - """ - pki_ezsigntemplatepackagesignermembership_id: conint(strict=True, ge=0) = Field(..., alias="pkiEzsigntemplatepackagesignermembershipID", description="The unique ID of the Ezsigntemplatepackagesignermembership") - fki_ezsigntemplatepackagemembership_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsigntemplatepackagemembershipID", description="The unique ID of the Ezsigntemplatepackagemembership") - fki_ezsigntemplatepackagesigner_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsigntemplatepackagesignerID", description="The unique ID of the Ezsigntemplatepackagesigner") - fki_ezsigntemplatesigner_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsigntemplatesignerID", description="The unique ID of the Ezsigntemplatesigner") - i_ezsigntemplatepackagesignermembership_copy: Optional[conint(strict=True, ge=1)] = Field(None, alias="iEzsigntemplatepackagesignermembershipCopy", description="The Copy number in case of multiple copies.") - __properties = ["pkiEzsigntemplatepackagesignermembershipID", "fkiEzsigntemplatepackagemembershipID", "fkiEzsigntemplatepackagesignerID", "fkiEzsigntemplatesignerID", "iEzsigntemplatepackagesignermembershipCopy"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + A Ezsigntemplatepackagesignermembership Object + """ # noqa: E501 + pki_ezsigntemplatepackagesignermembership_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsigntemplatepackagesignermembership", alias="pkiEzsigntemplatepackagesignermembershipID") + fki_ezsigntemplatepackagemembership_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsigntemplatepackagemembership", alias="fkiEzsigntemplatepackagemembershipID") + fki_ezsigntemplatepackagesigner_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsigntemplatepackagesigner", alias="fkiEzsigntemplatepackagesignerID") + fki_ezsigntemplatesigner_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsigntemplatesigner", alias="fkiEzsigntemplatesignerID") + i_ezsigntemplatepackagesignermembership_copy: Optional[Annotated[int, Field(strict=True, ge=1)]] = Field(default=None, description="The Copy number in case of multiple copies.", alias="iEzsigntemplatepackagesignermembershipCopy") + __properties: ClassVar[List[str]] = ["pkiEzsigntemplatepackagesignermembershipID", "fkiEzsigntemplatepackagemembershipID", "fkiEzsigntemplatepackagesignerID", "fkiEzsigntemplatesignerID", "iEzsigntemplatepackagesignermembershipCopy"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatepackagesignermembershipResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatepackagesignermembershipResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatepackagesignermembershipResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatepackagesignermembershipResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatepackagesignermembershipResponse.parse_obj(obj) - - _obj = EzsigntemplatepackagesignermembershipResponse.parse_obj({ - "pki_ezsigntemplatepackagesignermembership_id": obj.get("pkiEzsigntemplatepackagesignermembershipID"), - "fki_ezsigntemplatepackagemembership_id": obj.get("fkiEzsigntemplatepackagemembershipID"), - "fki_ezsigntemplatepackagesigner_id": obj.get("fkiEzsigntemplatepackagesignerID"), - "fki_ezsigntemplatesigner_id": obj.get("fkiEzsigntemplatesignerID"), - "i_ezsigntemplatepackagesignermembership_copy": obj.get("iEzsigntemplatepackagesignermembershipCopy") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsigntemplatepackagesignermembershipID": obj.get("pkiEzsigntemplatepackagesignermembershipID"), + "fkiEzsigntemplatepackagemembershipID": obj.get("fkiEzsigntemplatepackagemembershipID"), + "fkiEzsigntemplatepackagesignerID": obj.get("fkiEzsigntemplatepackagesignerID"), + "fkiEzsigntemplatesignerID": obj.get("fkiEzsigntemplatesignerID"), + "iEzsigntemplatepackagesignermembershipCopy": obj.get("iEzsigntemplatepackagesignermembershipCopy") }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatepackagesignermembership_response_compound.py b/eZmaxApi/models/ezsigntemplatepackagesignermembership_response_compound.py index ec38a9489..8306abf94 100644 --- a/eZmaxApi/models/ezsigntemplatepackagesignermembership_response_compound.py +++ b/eZmaxApi/models/ezsigntemplatepackagesignermembership_response_compound.py @@ -19,61 +19,80 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatepackagesignermembershipResponseCompound(BaseModel): """ - A Ezsigntemplatepackagesignermembership Object # noqa: E501 - """ - pki_ezsigntemplatepackagesignermembership_id: conint(strict=True, ge=0) = Field(..., alias="pkiEzsigntemplatepackagesignermembershipID", description="The unique ID of the Ezsigntemplatepackagesignermembership") - fki_ezsigntemplatepackagemembership_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsigntemplatepackagemembershipID", description="The unique ID of the Ezsigntemplatepackagemembership") - fki_ezsigntemplatepackagesigner_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsigntemplatepackagesignerID", description="The unique ID of the Ezsigntemplatepackagesigner") - fki_ezsigntemplatesigner_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsigntemplatesignerID", description="The unique ID of the Ezsigntemplatesigner") - i_ezsigntemplatepackagesignermembership_copy: Optional[conint(strict=True, ge=1)] = Field(None, alias="iEzsigntemplatepackagesignermembershipCopy", description="The Copy number in case of multiple copies.") - __properties = ["pkiEzsigntemplatepackagesignermembershipID", "fkiEzsigntemplatepackagemembershipID", "fkiEzsigntemplatepackagesignerID", "fkiEzsigntemplatesignerID", "iEzsigntemplatepackagesignermembershipCopy"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + A Ezsigntemplatepackagesignermembership Object + """ # noqa: E501 + pki_ezsigntemplatepackagesignermembership_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsigntemplatepackagesignermembership", alias="pkiEzsigntemplatepackagesignermembershipID") + fki_ezsigntemplatepackagemembership_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsigntemplatepackagemembership", alias="fkiEzsigntemplatepackagemembershipID") + fki_ezsigntemplatepackagesigner_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsigntemplatepackagesigner", alias="fkiEzsigntemplatepackagesignerID") + fki_ezsigntemplatesigner_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsigntemplatesigner", alias="fkiEzsigntemplatesignerID") + i_ezsigntemplatepackagesignermembership_copy: Optional[Annotated[int, Field(strict=True, ge=1)]] = Field(default=None, description="The Copy number in case of multiple copies.", alias="iEzsigntemplatepackagesignermembershipCopy") + __properties: ClassVar[List[str]] = ["pkiEzsigntemplatepackagesignermembershipID", "fkiEzsigntemplatepackagemembershipID", "fkiEzsigntemplatepackagesignerID", "fkiEzsigntemplatesignerID", "iEzsigntemplatepackagesignermembershipCopy"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatepackagesignermembershipResponseCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatepackagesignermembershipResponseCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatepackagesignermembershipResponseCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatepackagesignermembershipResponseCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatepackagesignermembershipResponseCompound.parse_obj(obj) - - _obj = EzsigntemplatepackagesignermembershipResponseCompound.parse_obj({ - "pki_ezsigntemplatepackagesignermembership_id": obj.get("pkiEzsigntemplatepackagesignermembershipID"), - "fki_ezsigntemplatepackagemembership_id": obj.get("fkiEzsigntemplatepackagemembershipID"), - "fki_ezsigntemplatepackagesigner_id": obj.get("fkiEzsigntemplatepackagesignerID"), - "fki_ezsigntemplatesigner_id": obj.get("fkiEzsigntemplatesignerID"), - "i_ezsigntemplatepackagesignermembership_copy": obj.get("iEzsigntemplatepackagesignermembershipCopy") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsigntemplatepackagesignermembershipID": obj.get("pkiEzsigntemplatepackagesignermembershipID"), + "fkiEzsigntemplatepackagemembershipID": obj.get("fkiEzsigntemplatepackagemembershipID"), + "fkiEzsigntemplatepackagesignerID": obj.get("fkiEzsigntemplatepackagesignerID"), + "fkiEzsigntemplatesignerID": obj.get("fkiEzsigntemplatesignerID"), + "iEzsigntemplatepackagesignermembershipCopy": obj.get("iEzsigntemplatepackagesignermembershipCopy") }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatesignature_create_object_v1_request.py b/eZmaxApi/models/ezsigntemplatesignature_create_object_v1_request.py index c13be70d2..2be1d6608 100644 --- a/eZmaxApi/models/ezsigntemplatesignature_create_object_v1_request.py +++ b/eZmaxApi/models/ezsigntemplatesignature_create_object_v1_request.py @@ -19,41 +19,60 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.ezsigntemplatesignature_request_compound import EzsigntemplatesignatureRequestCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatesignatureCreateObjectV1Request(BaseModel): """ - Request for POST /1/object/ezsigntemplatesignature # noqa: E501 - """ - a_obj_ezsigntemplatesignature: conlist(EzsigntemplatesignatureRequestCompound, min_items=1) = Field(..., alias="a_objEzsigntemplatesignature") - __properties = ["a_objEzsigntemplatesignature"] + Request for POST /1/object/ezsigntemplatesignature + """ # noqa: E501 + a_obj_ezsigntemplatesignature: Annotated[List[EzsigntemplatesignatureRequestCompound], Field(min_length=1)] = Field(alias="a_objEzsigntemplatesignature") + __properties: ClassVar[List[str]] = ["a_objEzsigntemplatesignature"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatesignatureCreateObjectV1Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatesignatureCreateObjectV1Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_ezsigntemplatesignature (list) _items = [] if self.a_obj_ezsigntemplatesignature: @@ -64,16 +83,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatesignatureCreateObjectV1Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatesignatureCreateObjectV1Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatesignatureCreateObjectV1Request.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplatesignatureCreateObjectV1Request.parse_obj({ - "a_obj_ezsigntemplatesignature": [EzsigntemplatesignatureRequestCompound.from_dict(_item) for _item in obj.get("a_objEzsigntemplatesignature")] if obj.get("a_objEzsigntemplatesignature") is not None else None + _obj = cls.model_validate({ + "a_objEzsigntemplatesignature": [EzsigntemplatesignatureRequestCompound.from_dict(_item) for _item in obj.get("a_objEzsigntemplatesignature")] if obj.get("a_objEzsigntemplatesignature") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatesignature_create_object_v1_response.py b/eZmaxApi/models/ezsigntemplatesignature_create_object_v1_response.py index eec1d48cd..ee11d3678 100644 --- a/eZmaxApi/models/ezsigntemplatesignature_create_object_v1_response.py +++ b/eZmaxApi/models/ezsigntemplatesignature_create_object_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.ezsigntemplatesignature_create_object_v1_response_m_payload import EzsigntemplatesignatureCreateObjectV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatesignatureCreateObjectV1Response(BaseModel): """ - Response for POST /1/object/ezsigntemplatesignature # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzsigntemplatesignatureCreateObjectV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for POST /1/object/ezsigntemplatesignature + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsigntemplatesignatureCreateObjectV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatesignatureCreateObjectV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatesignatureCreateObjectV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatesignatureCreateObjectV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatesignatureCreateObjectV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatesignatureCreateObjectV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplatesignatureCreateObjectV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzsigntemplatesignatureCreateObjectV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsigntemplatesignatureCreateObjectV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatesignature_create_object_v1_response_m_payload.py b/eZmaxApi/models/ezsigntemplatesignature_create_object_v1_response_m_payload.py index 0df2a7f2b..58c532296 100644 --- a/eZmaxApi/models/ezsigntemplatesignature_create_object_v1_response_m_payload.py +++ b/eZmaxApi/models/ezsigntemplatesignature_create_object_v1_response_m_payload.py @@ -19,53 +19,72 @@ import json -from typing import List -from pydantic import BaseModel, Field, conint, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatesignatureCreateObjectV1ResponseMPayload(BaseModel): """ - Payload for POST /1/object/ezsigntemplatesignature # noqa: E501 - """ - a_pki_ezsigntemplatesignature_id: conlist(conint(strict=True, ge=0), min_items=1) = Field(..., alias="a_pkiEzsigntemplatesignatureID", description="An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request.") - __properties = ["a_pkiEzsigntemplatesignatureID"] + Payload for POST /1/object/ezsigntemplatesignature + """ # noqa: E501 + a_pki_ezsigntemplatesignature_id: Annotated[List[Annotated[int, Field(strict=True, ge=0)]], Field(min_length=1)] = Field(description="An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request.", alias="a_pkiEzsigntemplatesignatureID") + __properties: ClassVar[List[str]] = ["a_pkiEzsigntemplatesignatureID"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatesignatureCreateObjectV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatesignatureCreateObjectV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatesignatureCreateObjectV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatesignatureCreateObjectV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatesignatureCreateObjectV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplatesignatureCreateObjectV1ResponseMPayload.parse_obj({ - "a_pki_ezsigntemplatesignature_id": obj.get("a_pkiEzsigntemplatesignatureID") + _obj = cls.model_validate({ + "a_pkiEzsigntemplatesignatureID": obj.get("a_pkiEzsigntemplatesignatureID") }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatesignature_delete_object_v1_response.py b/eZmaxApi/models/ezsigntemplatesignature_delete_object_v1_response.py index f421ed437..58eb1de52 100644 --- a/eZmaxApi/models/ezsigntemplatesignature_delete_object_v1_response.py +++ b/eZmaxApi/models/ezsigntemplatesignature_delete_object_v1_response.py @@ -19,43 +19,61 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatesignatureDeleteObjectV1Response(BaseModel): """ - Response for DELETE /1/object/ezsigntemplatesignature/{pkiEzsigntemplatesignatureID} # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - __properties = ["objDebugPayload", "objDebug"] + Response for DELETE /1/object/ezsigntemplatesignature/{pkiEzsigntemplatesignatureID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatesignatureDeleteObjectV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatesignatureDeleteObjectV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -65,17 +83,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatesignatureDeleteObjectV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatesignatureDeleteObjectV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatesignatureDeleteObjectV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplatesignatureDeleteObjectV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatesignature_edit_object_v1_request.py b/eZmaxApi/models/ezsigntemplatesignature_edit_object_v1_request.py index a62651cbe..0ec6922d9 100644 --- a/eZmaxApi/models/ezsigntemplatesignature_edit_object_v1_request.py +++ b/eZmaxApi/models/ezsigntemplatesignature_edit_object_v1_request.py @@ -19,57 +19,75 @@ import json - -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.ezsigntemplatesignature_request_compound import EzsigntemplatesignatureRequestCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatesignatureEditObjectV1Request(BaseModel): """ - Request for PUT /1/object/ezsigntemplatesignature/{pkiEzsigntemplatesignatureID} # noqa: E501 - """ - obj_ezsigntemplatesignature: EzsigntemplatesignatureRequestCompound = Field(..., alias="objEzsigntemplatesignature") - __properties = ["objEzsigntemplatesignature"] + Request for PUT /1/object/ezsigntemplatesignature/{pkiEzsigntemplatesignatureID} + """ # noqa: E501 + obj_ezsigntemplatesignature: EzsigntemplatesignatureRequestCompound = Field(alias="objEzsigntemplatesignature") + __properties: ClassVar[List[str]] = ["objEzsigntemplatesignature"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatesignatureEditObjectV1Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatesignatureEditObjectV1Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_ezsigntemplatesignature if self.obj_ezsigntemplatesignature: _dict['objEzsigntemplatesignature'] = self.obj_ezsigntemplatesignature.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatesignatureEditObjectV1Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatesignatureEditObjectV1Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatesignatureEditObjectV1Request.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplatesignatureEditObjectV1Request.parse_obj({ - "obj_ezsigntemplatesignature": EzsigntemplatesignatureRequestCompound.from_dict(obj.get("objEzsigntemplatesignature")) if obj.get("objEzsigntemplatesignature") is not None else None + _obj = cls.model_validate({ + "objEzsigntemplatesignature": EzsigntemplatesignatureRequestCompound.from_dict(obj.get("objEzsigntemplatesignature")) if obj.get("objEzsigntemplatesignature") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatesignature_edit_object_v1_response.py b/eZmaxApi/models/ezsigntemplatesignature_edit_object_v1_response.py index e8a367e5c..bb8249bd4 100644 --- a/eZmaxApi/models/ezsigntemplatesignature_edit_object_v1_response.py +++ b/eZmaxApi/models/ezsigntemplatesignature_edit_object_v1_response.py @@ -19,43 +19,61 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatesignatureEditObjectV1Response(BaseModel): """ - Response for PUT /1/object/ezsigntemplatesignature/{pkiEzsigntemplatesignatureID} # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - __properties = ["objDebugPayload", "objDebug"] + Response for PUT /1/object/ezsigntemplatesignature/{pkiEzsigntemplatesignatureID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatesignatureEditObjectV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatesignatureEditObjectV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -65,17 +83,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatesignatureEditObjectV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatesignatureEditObjectV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatesignatureEditObjectV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplatesignatureEditObjectV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatesignature_get_object_v2_response.py b/eZmaxApi/models/ezsigntemplatesignature_get_object_v2_response.py index cc591e0fd..1299b7fe7 100644 --- a/eZmaxApi/models/ezsigntemplatesignature_get_object_v2_response.py +++ b/eZmaxApi/models/ezsigntemplatesignature_get_object_v2_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.ezsigntemplatesignature_get_object_v2_response_m_payload import EzsigntemplatesignatureGetObjectV2ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatesignatureGetObjectV2Response(BaseModel): """ - Response for GET /2/object/ezsigntemplatesignature/{pkiEzsigntemplatesignatureID} # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzsigntemplatesignatureGetObjectV2ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /2/object/ezsigntemplatesignature/{pkiEzsigntemplatesignatureID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsigntemplatesignatureGetObjectV2ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatesignatureGetObjectV2Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatesignatureGetObjectV2Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatesignatureGetObjectV2Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatesignatureGetObjectV2Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatesignatureGetObjectV2Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplatesignatureGetObjectV2Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzsigntemplatesignatureGetObjectV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsigntemplatesignatureGetObjectV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatesignature_get_object_v2_response_m_payload.py b/eZmaxApi/models/ezsigntemplatesignature_get_object_v2_response_m_payload.py index a663a134c..f5f749408 100644 --- a/eZmaxApi/models/ezsigntemplatesignature_get_object_v2_response_m_payload.py +++ b/eZmaxApi/models/ezsigntemplatesignature_get_object_v2_response_m_payload.py @@ -19,57 +19,75 @@ import json - -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.ezsigntemplatesignature_response_compound import EzsigntemplatesignatureResponseCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatesignatureGetObjectV2ResponseMPayload(BaseModel): """ - Payload for GET /2/object/ezsigntemplatesignature/{pkiEzsigntemplatesignatureID} # noqa: E501 - """ - obj_ezsigntemplatesignature: EzsigntemplatesignatureResponseCompound = Field(..., alias="objEzsigntemplatesignature") - __properties = ["objEzsigntemplatesignature"] + Payload for GET /2/object/ezsigntemplatesignature/{pkiEzsigntemplatesignatureID} + """ # noqa: E501 + obj_ezsigntemplatesignature: EzsigntemplatesignatureResponseCompound = Field(alias="objEzsigntemplatesignature") + __properties: ClassVar[List[str]] = ["objEzsigntemplatesignature"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatesignatureGetObjectV2ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatesignatureGetObjectV2ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_ezsigntemplatesignature if self.obj_ezsigntemplatesignature: _dict['objEzsigntemplatesignature'] = self.obj_ezsigntemplatesignature.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatesignatureGetObjectV2ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatesignatureGetObjectV2ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatesignatureGetObjectV2ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplatesignatureGetObjectV2ResponseMPayload.parse_obj({ - "obj_ezsigntemplatesignature": EzsigntemplatesignatureResponseCompound.from_dict(obj.get("objEzsigntemplatesignature")) if obj.get("objEzsigntemplatesignature") is not None else None + _obj = cls.model_validate({ + "objEzsigntemplatesignature": EzsigntemplatesignatureResponseCompound.from_dict(obj.get("objEzsigntemplatesignature")) if obj.get("objEzsigntemplatesignature") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatesignature_request.py b/eZmaxApi/models/ezsigntemplatesignature_request.py index 06755fb4a..0cea6f11a 100644 --- a/eZmaxApi/models/ezsigntemplatesignature_request.py +++ b/eZmaxApi/models/ezsigntemplatesignature_request.py @@ -19,44 +19,50 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictBool, StrictInt, StrictStr, conint, constr, validator +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, StrictInt, StrictStr, field_validator +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.enum_textvalidation import EnumTextvalidation from eZmaxApi.models.field_e_ezsigntemplatesignature_attachmentnamesource import FieldEEzsigntemplatesignatureAttachmentnamesource from eZmaxApi.models.field_e_ezsigntemplatesignature_dependencyrequirement import FieldEEzsigntemplatesignatureDependencyrequirement from eZmaxApi.models.field_e_ezsigntemplatesignature_font import FieldEEzsigntemplatesignatureFont from eZmaxApi.models.field_e_ezsigntemplatesignature_tooltipposition import FieldEEzsigntemplatesignatureTooltipposition from eZmaxApi.models.field_e_ezsigntemplatesignature_type import FieldEEzsigntemplatesignatureType +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatesignatureRequest(BaseModel): """ - A Ezsigntemplatesignature Object # noqa: E501 - """ - pki_ezsigntemplatesignature_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="pkiEzsigntemplatesignatureID", description="The unique ID of the Ezsigntemplatesignature") - fki_ezsigntemplatedocument_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsigntemplatedocumentID", description="The unique ID of the Ezsigntemplatedocument") - fki_ezsigntemplatesigner_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsigntemplatesignerID", description="The unique ID of the Ezsigntemplatesigner") - fki_ezsigntemplatesigner_id_validation: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiEzsigntemplatesignerIDValidation", description="The unique ID of the Ezsigntemplatesigner") - i_ezsigntemplatedocumentpage_pagenumber: conint(strict=True, ge=1) = Field(..., alias="iEzsigntemplatedocumentpagePagenumber", description="The page number in the Ezsigntemplatedocument") - i_ezsigntemplatesignature_x: conint(strict=True, ge=0) = Field(..., alias="iEzsigntemplatesignatureX", description="The X coordinate (Horizontal) where to put the Ezsigntemplatesignature on the page. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsigntemplatesignature 2 inches from the left border of the page, you would use \"200\" for the X coordinate.") - i_ezsigntemplatesignature_y: conint(strict=True, ge=0) = Field(..., alias="iEzsigntemplatesignatureY", description="The Y coordinate (Vertical) where to put the Ezsigntemplatesignature on the page. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsigntemplatesignature 3 inches from the top border of the page, you would use \"300\" for the Y coordinate.") - i_ezsigntemplatesignature_width: Optional[conint(strict=True, ge=0)] = Field(None, alias="iEzsigntemplatesignatureWidth", description="The width of the Ezsigntemplatesignature. Size is calculated at 100dpi (dot per inch). So for example, if you want the Ezsigntemplatesignature to have a width of 2 inches, you would use \"200\" for the iEzsigntemplatesignatureWidth.") - i_ezsigntemplatesignature_height: Optional[conint(strict=True, ge=0)] = Field(None, alias="iEzsigntemplatesignatureHeight", description="The height of the Ezsigntemplatesignature. Size is calculated at 100dpi (dot per inch). So for example, if you want the Ezsigntemplatesignature to have an height of 2 inches, you would use \"200\" for the iEzsigntemplatesignatureHeight.") - i_ezsigntemplatesignature_step: conint(strict=True, ge=1) = Field(..., alias="iEzsigntemplatesignatureStep", description="The step when the Ezsigntemplatesigner will be invited to sign") - e_ezsigntemplatesignature_type: FieldEEzsigntemplatesignatureType = Field(..., alias="eEzsigntemplatesignatureType") - t_ezsigntemplatesignature_tooltip: Optional[StrictStr] = Field(None, alias="tEzsigntemplatesignatureTooltip", description="A tooltip that will be presented to Ezsigntemplatesigner about the Ezsigntemplatesignature") - e_ezsigntemplatesignature_tooltipposition: Optional[FieldEEzsigntemplatesignatureTooltipposition] = Field(None, alias="eEzsigntemplatesignatureTooltipposition") - e_ezsigntemplatesignature_font: Optional[FieldEEzsigntemplatesignatureFont] = Field(None, alias="eEzsigntemplatesignatureFont") - b_ezsigntemplatesignature_required: Optional[StrictBool] = Field(None, alias="bEzsigntemplatesignatureRequired", description="Whether the Ezsigntemplatesignature is required or not. This field is relevant only with Ezsigntemplatesignature with eEzsigntemplatesignatureType = Attachments.") - e_ezsigntemplatesignature_attachmentnamesource: Optional[FieldEEzsigntemplatesignatureAttachmentnamesource] = Field(None, alias="eEzsigntemplatesignatureAttachmentnamesource") - s_ezsigntemplatesignature_attachmentdescription: Optional[StrictStr] = Field(None, alias="sEzsigntemplatesignatureAttachmentdescription", description="The description attached to the attachment name added in Ezsigntemplatesignature of eEzsigntemplatesignatureType Attachments") - i_ezsigntemplatesignature_validationstep: Optional[StrictInt] = Field(None, alias="iEzsigntemplatesignatureValidationstep", description="The step when the Ezsigntemplatesigner will be invited to validate the Ezsigntemplatesignature of eEzsigntemplatesignatureType Attachments") - i_ezsigntemplatesignature_maxlength: Optional[conint(strict=True, le=65535, ge=0)] = Field(None, alias="iEzsigntemplatesignatureMaxlength", description="The maximum length for the value in the Ezsigntemplatesignature This can only be set if eEzsigntemplatesignatureType is **FieldText** or **FieldTextarea**") - s_ezsigntemplatesignature_regexp: Optional[constr(strict=True)] = Field(None, alias="sEzsigntemplatesignatureRegexp", description="A regular expression to indicate what values are acceptable for the Ezsigntemplatesignature. This can only be set if eEzsigntemplatesignatureType is **Text** or **Textarea**") - e_ezsigntemplatesignature_textvalidation: Optional[EnumTextvalidation] = Field(None, alias="eEzsigntemplatesignatureTextvalidation") - e_ezsigntemplatesignature_dependencyrequirement: Optional[FieldEEzsigntemplatesignatureDependencyrequirement] = Field(None, alias="eEzsigntemplatesignatureDependencyrequirement") - __properties = ["pkiEzsigntemplatesignatureID", "fkiEzsigntemplatedocumentID", "fkiEzsigntemplatesignerID", "fkiEzsigntemplatesignerIDValidation", "iEzsigntemplatedocumentpagePagenumber", "iEzsigntemplatesignatureX", "iEzsigntemplatesignatureY", "iEzsigntemplatesignatureWidth", "iEzsigntemplatesignatureHeight", "iEzsigntemplatesignatureStep", "eEzsigntemplatesignatureType", "tEzsigntemplatesignatureTooltip", "eEzsigntemplatesignatureTooltipposition", "eEzsigntemplatesignatureFont", "bEzsigntemplatesignatureRequired", "eEzsigntemplatesignatureAttachmentnamesource", "sEzsigntemplatesignatureAttachmentdescription", "iEzsigntemplatesignatureValidationstep", "iEzsigntemplatesignatureMaxlength", "sEzsigntemplatesignatureRegexp", "eEzsigntemplatesignatureTextvalidation", "eEzsigntemplatesignatureDependencyrequirement"] - - @validator('s_ezsigntemplatesignature_regexp') + A Ezsigntemplatesignature Object + """ # noqa: E501 + pki_ezsigntemplatesignature_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsigntemplatesignature", alias="pkiEzsigntemplatesignatureID") + fki_ezsigntemplatedocument_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsigntemplatedocument", alias="fkiEzsigntemplatedocumentID") + fki_ezsigntemplatesigner_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsigntemplatesigner", alias="fkiEzsigntemplatesignerID") + fki_ezsigntemplatesigner_id_validation: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsigntemplatesigner", alias="fkiEzsigntemplatesignerIDValidation") + i_ezsigntemplatedocumentpage_pagenumber: Annotated[int, Field(strict=True, ge=1)] = Field(description="The page number in the Ezsigntemplatedocument", alias="iEzsigntemplatedocumentpagePagenumber") + i_ezsigntemplatesignature_x: Annotated[int, Field(strict=True, ge=0)] = Field(description="The X coordinate (Horizontal) where to put the Ezsigntemplatesignature on the page. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsigntemplatesignature 2 inches from the left border of the page, you would use \"200\" for the X coordinate.", alias="iEzsigntemplatesignatureX") + i_ezsigntemplatesignature_y: Annotated[int, Field(strict=True, ge=0)] = Field(description="The Y coordinate (Vertical) where to put the Ezsigntemplatesignature on the page. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsigntemplatesignature 3 inches from the top border of the page, you would use \"300\" for the Y coordinate.", alias="iEzsigntemplatesignatureY") + i_ezsigntemplatesignature_width: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The width of the Ezsigntemplatesignature. Size is calculated at 100dpi (dot per inch). So for example, if you want the Ezsigntemplatesignature to have a width of 2 inches, you would use \"200\" for the iEzsigntemplatesignatureWidth.", alias="iEzsigntemplatesignatureWidth") + i_ezsigntemplatesignature_height: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The height of the Ezsigntemplatesignature. Size is calculated at 100dpi (dot per inch). So for example, if you want the Ezsigntemplatesignature to have an height of 2 inches, you would use \"200\" for the iEzsigntemplatesignatureHeight.", alias="iEzsigntemplatesignatureHeight") + i_ezsigntemplatesignature_step: Annotated[int, Field(strict=True, ge=1)] = Field(description="The step when the Ezsigntemplatesigner will be invited to sign", alias="iEzsigntemplatesignatureStep") + e_ezsigntemplatesignature_type: FieldEEzsigntemplatesignatureType = Field(alias="eEzsigntemplatesignatureType") + t_ezsigntemplatesignature_tooltip: Optional[StrictStr] = Field(default=None, description="A tooltip that will be presented to Ezsigntemplatesigner about the Ezsigntemplatesignature", alias="tEzsigntemplatesignatureTooltip") + e_ezsigntemplatesignature_tooltipposition: Optional[FieldEEzsigntemplatesignatureTooltipposition] = Field(default=None, alias="eEzsigntemplatesignatureTooltipposition") + e_ezsigntemplatesignature_font: Optional[FieldEEzsigntemplatesignatureFont] = Field(default=None, alias="eEzsigntemplatesignatureFont") + b_ezsigntemplatesignature_required: Optional[StrictBool] = Field(default=None, description="Whether the Ezsigntemplatesignature is required or not. This field is relevant only with Ezsigntemplatesignature with eEzsigntemplatesignatureType = Attachments.", alias="bEzsigntemplatesignatureRequired") + e_ezsigntemplatesignature_attachmentnamesource: Optional[FieldEEzsigntemplatesignatureAttachmentnamesource] = Field(default=None, alias="eEzsigntemplatesignatureAttachmentnamesource") + s_ezsigntemplatesignature_attachmentdescription: Optional[StrictStr] = Field(default=None, description="The description attached to the attachment name added in Ezsigntemplatesignature of eEzsigntemplatesignatureType Attachments", alias="sEzsigntemplatesignatureAttachmentdescription") + i_ezsigntemplatesignature_validationstep: Optional[StrictInt] = Field(default=None, description="The step when the Ezsigntemplatesigner will be invited to validate the Ezsigntemplatesignature of eEzsigntemplatesignatureType Attachments", alias="iEzsigntemplatesignatureValidationstep") + i_ezsigntemplatesignature_maxlength: Optional[Annotated[int, Field(le=65535, strict=True, ge=0)]] = Field(default=None, description="The maximum length for the value in the Ezsigntemplatesignature This can only be set if eEzsigntemplatesignatureType is **FieldText** or **FieldTextarea**", alias="iEzsigntemplatesignatureMaxlength") + s_ezsigntemplatesignature_regexp: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="A regular expression to indicate what values are acceptable for the Ezsigntemplatesignature. This can only be set if eEzsigntemplatesignatureType is **Text** or **Textarea**", alias="sEzsigntemplatesignatureRegexp") + e_ezsigntemplatesignature_textvalidation: Optional[EnumTextvalidation] = Field(default=None, alias="eEzsigntemplatesignatureTextvalidation") + e_ezsigntemplatesignature_dependencyrequirement: Optional[FieldEEzsigntemplatesignatureDependencyrequirement] = Field(default=None, alias="eEzsigntemplatesignatureDependencyrequirement") + __properties: ClassVar[List[str]] = ["pkiEzsigntemplatesignatureID", "fkiEzsigntemplatedocumentID", "fkiEzsigntemplatesignerID", "fkiEzsigntemplatesignerIDValidation", "iEzsigntemplatedocumentpagePagenumber", "iEzsigntemplatesignatureX", "iEzsigntemplatesignatureY", "iEzsigntemplatesignatureWidth", "iEzsigntemplatesignatureHeight", "iEzsigntemplatesignatureStep", "eEzsigntemplatesignatureType", "tEzsigntemplatesignatureTooltip", "eEzsigntemplatesignatureTooltipposition", "eEzsigntemplatesignatureFont", "bEzsigntemplatesignatureRequired", "eEzsigntemplatesignatureAttachmentnamesource", "sEzsigntemplatesignatureAttachmentdescription", "iEzsigntemplatesignatureValidationstep", "iEzsigntemplatesignatureMaxlength", "sEzsigntemplatesignatureRegexp", "eEzsigntemplatesignatureTextvalidation", "eEzsigntemplatesignatureDependencyrequirement"] + + @field_validator('s_ezsigntemplatesignature_regexp') def s_ezsigntemplatesignature_regexp_validate_regular_expression(cls, value): """Validates the regular expression""" if value is None: @@ -66,64 +72,77 @@ def s_ezsigntemplatesignature_regexp_validate_regular_expression(cls, value): raise ValueError(r"must validate the regular expression /^\^.*\$$|^$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatesignatureRequest: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatesignatureRequest from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatesignatureRequest: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatesignatureRequest from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatesignatureRequest.parse_obj(obj) - - _obj = EzsigntemplatesignatureRequest.parse_obj({ - "pki_ezsigntemplatesignature_id": obj.get("pkiEzsigntemplatesignatureID"), - "fki_ezsigntemplatedocument_id": obj.get("fkiEzsigntemplatedocumentID"), - "fki_ezsigntemplatesigner_id": obj.get("fkiEzsigntemplatesignerID"), - "fki_ezsigntemplatesigner_id_validation": obj.get("fkiEzsigntemplatesignerIDValidation"), - "i_ezsigntemplatedocumentpage_pagenumber": obj.get("iEzsigntemplatedocumentpagePagenumber"), - "i_ezsigntemplatesignature_x": obj.get("iEzsigntemplatesignatureX"), - "i_ezsigntemplatesignature_y": obj.get("iEzsigntemplatesignatureY"), - "i_ezsigntemplatesignature_width": obj.get("iEzsigntemplatesignatureWidth"), - "i_ezsigntemplatesignature_height": obj.get("iEzsigntemplatesignatureHeight"), - "i_ezsigntemplatesignature_step": obj.get("iEzsigntemplatesignatureStep"), - "e_ezsigntemplatesignature_type": obj.get("eEzsigntemplatesignatureType"), - "t_ezsigntemplatesignature_tooltip": obj.get("tEzsigntemplatesignatureTooltip"), - "e_ezsigntemplatesignature_tooltipposition": obj.get("eEzsigntemplatesignatureTooltipposition"), - "e_ezsigntemplatesignature_font": obj.get("eEzsigntemplatesignatureFont"), - "b_ezsigntemplatesignature_required": obj.get("bEzsigntemplatesignatureRequired"), - "e_ezsigntemplatesignature_attachmentnamesource": obj.get("eEzsigntemplatesignatureAttachmentnamesource"), - "s_ezsigntemplatesignature_attachmentdescription": obj.get("sEzsigntemplatesignatureAttachmentdescription"), - "i_ezsigntemplatesignature_validationstep": obj.get("iEzsigntemplatesignatureValidationstep"), - "i_ezsigntemplatesignature_maxlength": obj.get("iEzsigntemplatesignatureMaxlength"), - "s_ezsigntemplatesignature_regexp": obj.get("sEzsigntemplatesignatureRegexp"), - "e_ezsigntemplatesignature_textvalidation": obj.get("eEzsigntemplatesignatureTextvalidation"), - "e_ezsigntemplatesignature_dependencyrequirement": obj.get("eEzsigntemplatesignatureDependencyrequirement") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsigntemplatesignatureID": obj.get("pkiEzsigntemplatesignatureID"), + "fkiEzsigntemplatedocumentID": obj.get("fkiEzsigntemplatedocumentID"), + "fkiEzsigntemplatesignerID": obj.get("fkiEzsigntemplatesignerID"), + "fkiEzsigntemplatesignerIDValidation": obj.get("fkiEzsigntemplatesignerIDValidation"), + "iEzsigntemplatedocumentpagePagenumber": obj.get("iEzsigntemplatedocumentpagePagenumber"), + "iEzsigntemplatesignatureX": obj.get("iEzsigntemplatesignatureX"), + "iEzsigntemplatesignatureY": obj.get("iEzsigntemplatesignatureY"), + "iEzsigntemplatesignatureWidth": obj.get("iEzsigntemplatesignatureWidth"), + "iEzsigntemplatesignatureHeight": obj.get("iEzsigntemplatesignatureHeight"), + "iEzsigntemplatesignatureStep": obj.get("iEzsigntemplatesignatureStep"), + "eEzsigntemplatesignatureType": obj.get("eEzsigntemplatesignatureType"), + "tEzsigntemplatesignatureTooltip": obj.get("tEzsigntemplatesignatureTooltip"), + "eEzsigntemplatesignatureTooltipposition": obj.get("eEzsigntemplatesignatureTooltipposition"), + "eEzsigntemplatesignatureFont": obj.get("eEzsigntemplatesignatureFont"), + "bEzsigntemplatesignatureRequired": obj.get("bEzsigntemplatesignatureRequired"), + "eEzsigntemplatesignatureAttachmentnamesource": obj.get("eEzsigntemplatesignatureAttachmentnamesource"), + "sEzsigntemplatesignatureAttachmentdescription": obj.get("sEzsigntemplatesignatureAttachmentdescription"), + "iEzsigntemplatesignatureValidationstep": obj.get("iEzsigntemplatesignatureValidationstep"), + "iEzsigntemplatesignatureMaxlength": obj.get("iEzsigntemplatesignatureMaxlength"), + "sEzsigntemplatesignatureRegexp": obj.get("sEzsigntemplatesignatureRegexp"), + "eEzsigntemplatesignatureTextvalidation": obj.get("eEzsigntemplatesignatureTextvalidation"), + "eEzsigntemplatesignatureDependencyrequirement": obj.get("eEzsigntemplatesignatureDependencyrequirement") }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatesignature_request_compound.py b/eZmaxApi/models/ezsigntemplatesignature_request_compound.py index 716d28a8e..09fd19068 100644 --- a/eZmaxApi/models/ezsigntemplatesignature_request_compound.py +++ b/eZmaxApi/models/ezsigntemplatesignature_request_compound.py @@ -19,8 +19,10 @@ import json -from typing import List, Optional -from pydantic import BaseModel, Field, StrictBool, StrictInt, StrictStr, conint, conlist, constr, validator +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, StrictInt, StrictStr, field_validator +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.enum_textvalidation import EnumTextvalidation from eZmaxApi.models.ezsigntemplateelementdependency_request_compound import EzsigntemplateelementdependencyRequestCompound from eZmaxApi.models.ezsigntemplatesignaturecustomdate_request_compound import EzsigntemplatesignaturecustomdateRequestCompound @@ -29,39 +31,43 @@ from eZmaxApi.models.field_e_ezsigntemplatesignature_font import FieldEEzsigntemplatesignatureFont from eZmaxApi.models.field_e_ezsigntemplatesignature_tooltipposition import FieldEEzsigntemplatesignatureTooltipposition from eZmaxApi.models.field_e_ezsigntemplatesignature_type import FieldEEzsigntemplatesignatureType +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatesignatureRequestCompound(BaseModel): """ - A Ezsigntemplatesignature Object and children # noqa: E501 - """ - pki_ezsigntemplatesignature_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="pkiEzsigntemplatesignatureID", description="The unique ID of the Ezsigntemplatesignature") - fki_ezsigntemplatedocument_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsigntemplatedocumentID", description="The unique ID of the Ezsigntemplatedocument") - fki_ezsigntemplatesigner_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsigntemplatesignerID", description="The unique ID of the Ezsigntemplatesigner") - fki_ezsigntemplatesigner_id_validation: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiEzsigntemplatesignerIDValidation", description="The unique ID of the Ezsigntemplatesigner") - i_ezsigntemplatedocumentpage_pagenumber: conint(strict=True, ge=1) = Field(..., alias="iEzsigntemplatedocumentpagePagenumber", description="The page number in the Ezsigntemplatedocument") - i_ezsigntemplatesignature_x: conint(strict=True, ge=0) = Field(..., alias="iEzsigntemplatesignatureX", description="The X coordinate (Horizontal) where to put the Ezsigntemplatesignature on the page. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsigntemplatesignature 2 inches from the left border of the page, you would use \"200\" for the X coordinate.") - i_ezsigntemplatesignature_y: conint(strict=True, ge=0) = Field(..., alias="iEzsigntemplatesignatureY", description="The Y coordinate (Vertical) where to put the Ezsigntemplatesignature on the page. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsigntemplatesignature 3 inches from the top border of the page, you would use \"300\" for the Y coordinate.") - i_ezsigntemplatesignature_width: Optional[conint(strict=True, ge=0)] = Field(None, alias="iEzsigntemplatesignatureWidth", description="The width of the Ezsigntemplatesignature. Size is calculated at 100dpi (dot per inch). So for example, if you want the Ezsigntemplatesignature to have a width of 2 inches, you would use \"200\" for the iEzsigntemplatesignatureWidth.") - i_ezsigntemplatesignature_height: Optional[conint(strict=True, ge=0)] = Field(None, alias="iEzsigntemplatesignatureHeight", description="The height of the Ezsigntemplatesignature. Size is calculated at 100dpi (dot per inch). So for example, if you want the Ezsigntemplatesignature to have an height of 2 inches, you would use \"200\" for the iEzsigntemplatesignatureHeight.") - i_ezsigntemplatesignature_step: conint(strict=True, ge=1) = Field(..., alias="iEzsigntemplatesignatureStep", description="The step when the Ezsigntemplatesigner will be invited to sign") - e_ezsigntemplatesignature_type: FieldEEzsigntemplatesignatureType = Field(..., alias="eEzsigntemplatesignatureType") - t_ezsigntemplatesignature_tooltip: Optional[StrictStr] = Field(None, alias="tEzsigntemplatesignatureTooltip", description="A tooltip that will be presented to Ezsigntemplatesigner about the Ezsigntemplatesignature") - e_ezsigntemplatesignature_tooltipposition: Optional[FieldEEzsigntemplatesignatureTooltipposition] = Field(None, alias="eEzsigntemplatesignatureTooltipposition") - e_ezsigntemplatesignature_font: Optional[FieldEEzsigntemplatesignatureFont] = Field(None, alias="eEzsigntemplatesignatureFont") - b_ezsigntemplatesignature_required: Optional[StrictBool] = Field(None, alias="bEzsigntemplatesignatureRequired", description="Whether the Ezsigntemplatesignature is required or not. This field is relevant only with Ezsigntemplatesignature with eEzsigntemplatesignatureType = Attachments.") - e_ezsigntemplatesignature_attachmentnamesource: Optional[FieldEEzsigntemplatesignatureAttachmentnamesource] = Field(None, alias="eEzsigntemplatesignatureAttachmentnamesource") - s_ezsigntemplatesignature_attachmentdescription: Optional[StrictStr] = Field(None, alias="sEzsigntemplatesignatureAttachmentdescription", description="The description attached to the attachment name added in Ezsigntemplatesignature of eEzsigntemplatesignatureType Attachments") - i_ezsigntemplatesignature_validationstep: Optional[StrictInt] = Field(None, alias="iEzsigntemplatesignatureValidationstep", description="The step when the Ezsigntemplatesigner will be invited to validate the Ezsigntemplatesignature of eEzsigntemplatesignatureType Attachments") - i_ezsigntemplatesignature_maxlength: Optional[conint(strict=True, le=65535, ge=0)] = Field(None, alias="iEzsigntemplatesignatureMaxlength", description="The maximum length for the value in the Ezsigntemplatesignature This can only be set if eEzsigntemplatesignatureType is **FieldText** or **FieldTextarea**") - s_ezsigntemplatesignature_regexp: Optional[constr(strict=True)] = Field(None, alias="sEzsigntemplatesignatureRegexp", description="A regular expression to indicate what values are acceptable for the Ezsigntemplatesignature. This can only be set if eEzsigntemplatesignatureType is **Text** or **Textarea**") - e_ezsigntemplatesignature_textvalidation: Optional[EnumTextvalidation] = Field(None, alias="eEzsigntemplatesignatureTextvalidation") - e_ezsigntemplatesignature_dependencyrequirement: Optional[FieldEEzsigntemplatesignatureDependencyrequirement] = Field(None, alias="eEzsigntemplatesignatureDependencyrequirement") - b_ezsigntemplatesignature_customdate: Optional[StrictBool] = Field(None, alias="bEzsigntemplatesignatureCustomdate", description="Whether the Ezsigntemplatesignature has a custom date format or not. (Only possible when eEzsigntemplatesignatureType is **Name** or **Handwritten**)") - a_obj_ezsigntemplatesignaturecustomdate: Optional[conlist(EzsigntemplatesignaturecustomdateRequestCompound)] = Field(None, alias="a_objEzsigntemplatesignaturecustomdate", description="An array of custom date blocks that will be filled at the time of signature. Can only be used if bEzsigntemplatesignatureCustomdate is true. Use an empty array if you don't want to have a date at all.") - a_obj_ezsigntemplateelementdependency: Optional[conlist(EzsigntemplateelementdependencyRequestCompound)] = Field(None, alias="a_objEzsigntemplateelementdependency") - __properties = ["pkiEzsigntemplatesignatureID", "fkiEzsigntemplatedocumentID", "fkiEzsigntemplatesignerID", "fkiEzsigntemplatesignerIDValidation", "iEzsigntemplatedocumentpagePagenumber", "iEzsigntemplatesignatureX", "iEzsigntemplatesignatureY", "iEzsigntemplatesignatureWidth", "iEzsigntemplatesignatureHeight", "iEzsigntemplatesignatureStep", "eEzsigntemplatesignatureType", "tEzsigntemplatesignatureTooltip", "eEzsigntemplatesignatureTooltipposition", "eEzsigntemplatesignatureFont", "bEzsigntemplatesignatureRequired", "eEzsigntemplatesignatureAttachmentnamesource", "sEzsigntemplatesignatureAttachmentdescription", "iEzsigntemplatesignatureValidationstep", "iEzsigntemplatesignatureMaxlength", "sEzsigntemplatesignatureRegexp", "eEzsigntemplatesignatureTextvalidation", "eEzsigntemplatesignatureDependencyrequirement", "bEzsigntemplatesignatureCustomdate", "a_objEzsigntemplatesignaturecustomdate", "a_objEzsigntemplateelementdependency"] - - @validator('s_ezsigntemplatesignature_regexp') + A Ezsigntemplatesignature Object and children + """ # noqa: E501 + pki_ezsigntemplatesignature_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsigntemplatesignature", alias="pkiEzsigntemplatesignatureID") + fki_ezsigntemplatedocument_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsigntemplatedocument", alias="fkiEzsigntemplatedocumentID") + fki_ezsigntemplatesigner_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsigntemplatesigner", alias="fkiEzsigntemplatesignerID") + fki_ezsigntemplatesigner_id_validation: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsigntemplatesigner", alias="fkiEzsigntemplatesignerIDValidation") + i_ezsigntemplatedocumentpage_pagenumber: Annotated[int, Field(strict=True, ge=1)] = Field(description="The page number in the Ezsigntemplatedocument", alias="iEzsigntemplatedocumentpagePagenumber") + i_ezsigntemplatesignature_x: Annotated[int, Field(strict=True, ge=0)] = Field(description="The X coordinate (Horizontal) where to put the Ezsigntemplatesignature on the page. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsigntemplatesignature 2 inches from the left border of the page, you would use \"200\" for the X coordinate.", alias="iEzsigntemplatesignatureX") + i_ezsigntemplatesignature_y: Annotated[int, Field(strict=True, ge=0)] = Field(description="The Y coordinate (Vertical) where to put the Ezsigntemplatesignature on the page. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsigntemplatesignature 3 inches from the top border of the page, you would use \"300\" for the Y coordinate.", alias="iEzsigntemplatesignatureY") + i_ezsigntemplatesignature_width: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The width of the Ezsigntemplatesignature. Size is calculated at 100dpi (dot per inch). So for example, if you want the Ezsigntemplatesignature to have a width of 2 inches, you would use \"200\" for the iEzsigntemplatesignatureWidth.", alias="iEzsigntemplatesignatureWidth") + i_ezsigntemplatesignature_height: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The height of the Ezsigntemplatesignature. Size is calculated at 100dpi (dot per inch). So for example, if you want the Ezsigntemplatesignature to have an height of 2 inches, you would use \"200\" for the iEzsigntemplatesignatureHeight.", alias="iEzsigntemplatesignatureHeight") + i_ezsigntemplatesignature_step: Annotated[int, Field(strict=True, ge=1)] = Field(description="The step when the Ezsigntemplatesigner will be invited to sign", alias="iEzsigntemplatesignatureStep") + e_ezsigntemplatesignature_type: FieldEEzsigntemplatesignatureType = Field(alias="eEzsigntemplatesignatureType") + t_ezsigntemplatesignature_tooltip: Optional[StrictStr] = Field(default=None, description="A tooltip that will be presented to Ezsigntemplatesigner about the Ezsigntemplatesignature", alias="tEzsigntemplatesignatureTooltip") + e_ezsigntemplatesignature_tooltipposition: Optional[FieldEEzsigntemplatesignatureTooltipposition] = Field(default=None, alias="eEzsigntemplatesignatureTooltipposition") + e_ezsigntemplatesignature_font: Optional[FieldEEzsigntemplatesignatureFont] = Field(default=None, alias="eEzsigntemplatesignatureFont") + b_ezsigntemplatesignature_required: Optional[StrictBool] = Field(default=None, description="Whether the Ezsigntemplatesignature is required or not. This field is relevant only with Ezsigntemplatesignature with eEzsigntemplatesignatureType = Attachments.", alias="bEzsigntemplatesignatureRequired") + e_ezsigntemplatesignature_attachmentnamesource: Optional[FieldEEzsigntemplatesignatureAttachmentnamesource] = Field(default=None, alias="eEzsigntemplatesignatureAttachmentnamesource") + s_ezsigntemplatesignature_attachmentdescription: Optional[StrictStr] = Field(default=None, description="The description attached to the attachment name added in Ezsigntemplatesignature of eEzsigntemplatesignatureType Attachments", alias="sEzsigntemplatesignatureAttachmentdescription") + i_ezsigntemplatesignature_validationstep: Optional[StrictInt] = Field(default=None, description="The step when the Ezsigntemplatesigner will be invited to validate the Ezsigntemplatesignature of eEzsigntemplatesignatureType Attachments", alias="iEzsigntemplatesignatureValidationstep") + i_ezsigntemplatesignature_maxlength: Optional[Annotated[int, Field(le=65535, strict=True, ge=0)]] = Field(default=None, description="The maximum length for the value in the Ezsigntemplatesignature This can only be set if eEzsigntemplatesignatureType is **FieldText** or **FieldTextarea**", alias="iEzsigntemplatesignatureMaxlength") + s_ezsigntemplatesignature_regexp: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="A regular expression to indicate what values are acceptable for the Ezsigntemplatesignature. This can only be set if eEzsigntemplatesignatureType is **Text** or **Textarea**", alias="sEzsigntemplatesignatureRegexp") + e_ezsigntemplatesignature_textvalidation: Optional[EnumTextvalidation] = Field(default=None, alias="eEzsigntemplatesignatureTextvalidation") + e_ezsigntemplatesignature_dependencyrequirement: Optional[FieldEEzsigntemplatesignatureDependencyrequirement] = Field(default=None, alias="eEzsigntemplatesignatureDependencyrequirement") + b_ezsigntemplatesignature_customdate: Optional[StrictBool] = Field(default=None, description="Whether the Ezsigntemplatesignature has a custom date format or not. (Only possible when eEzsigntemplatesignatureType is **Name** or **Handwritten**)", alias="bEzsigntemplatesignatureCustomdate") + a_obj_ezsigntemplatesignaturecustomdate: Optional[List[EzsigntemplatesignaturecustomdateRequestCompound]] = Field(default=None, description="An array of custom date blocks that will be filled at the time of signature. Can only be used if bEzsigntemplatesignatureCustomdate is true. Use an empty array if you don't want to have a date at all.", alias="a_objEzsigntemplatesignaturecustomdate") + a_obj_ezsigntemplateelementdependency: Optional[List[EzsigntemplateelementdependencyRequestCompound]] = Field(default=None, alias="a_objEzsigntemplateelementdependency") + __properties: ClassVar[List[str]] = ["pkiEzsigntemplatesignatureID", "fkiEzsigntemplatedocumentID", "fkiEzsigntemplatesignerID", "fkiEzsigntemplatesignerIDValidation", "iEzsigntemplatedocumentpagePagenumber", "iEzsigntemplatesignatureX", "iEzsigntemplatesignatureY", "iEzsigntemplatesignatureWidth", "iEzsigntemplatesignatureHeight", "iEzsigntemplatesignatureStep", "eEzsigntemplatesignatureType", "tEzsigntemplatesignatureTooltip", "eEzsigntemplatesignatureTooltipposition", "eEzsigntemplatesignatureFont", "bEzsigntemplatesignatureRequired", "eEzsigntemplatesignatureAttachmentnamesource", "sEzsigntemplatesignatureAttachmentdescription", "iEzsigntemplatesignatureValidationstep", "iEzsigntemplatesignatureMaxlength", "sEzsigntemplatesignatureRegexp", "eEzsigntemplatesignatureTextvalidation", "eEzsigntemplatesignatureDependencyrequirement", "bEzsigntemplatesignatureCustomdate", "a_objEzsigntemplatesignaturecustomdate", "a_objEzsigntemplateelementdependency"] + + @field_validator('s_ezsigntemplatesignature_regexp') def s_ezsigntemplatesignature_regexp_validate_regular_expression(cls, value): """Validates the regular expression""" if value is None: @@ -71,30 +77,43 @@ def s_ezsigntemplatesignature_regexp_validate_regular_expression(cls, value): raise ValueError(r"must validate the regular expression /^\^.*\$$|^$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatesignatureRequestCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatesignatureRequestCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_ezsigntemplatesignaturecustomdate (list) _items = [] if self.a_obj_ezsigntemplatesignaturecustomdate: @@ -112,40 +131,40 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatesignatureRequestCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatesignatureRequestCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatesignatureRequestCompound.parse_obj(obj) - - _obj = EzsigntemplatesignatureRequestCompound.parse_obj({ - "pki_ezsigntemplatesignature_id": obj.get("pkiEzsigntemplatesignatureID"), - "fki_ezsigntemplatedocument_id": obj.get("fkiEzsigntemplatedocumentID"), - "fki_ezsigntemplatesigner_id": obj.get("fkiEzsigntemplatesignerID"), - "fki_ezsigntemplatesigner_id_validation": obj.get("fkiEzsigntemplatesignerIDValidation"), - "i_ezsigntemplatedocumentpage_pagenumber": obj.get("iEzsigntemplatedocumentpagePagenumber"), - "i_ezsigntemplatesignature_x": obj.get("iEzsigntemplatesignatureX"), - "i_ezsigntemplatesignature_y": obj.get("iEzsigntemplatesignatureY"), - "i_ezsigntemplatesignature_width": obj.get("iEzsigntemplatesignatureWidth"), - "i_ezsigntemplatesignature_height": obj.get("iEzsigntemplatesignatureHeight"), - "i_ezsigntemplatesignature_step": obj.get("iEzsigntemplatesignatureStep"), - "e_ezsigntemplatesignature_type": obj.get("eEzsigntemplatesignatureType"), - "t_ezsigntemplatesignature_tooltip": obj.get("tEzsigntemplatesignatureTooltip"), - "e_ezsigntemplatesignature_tooltipposition": obj.get("eEzsigntemplatesignatureTooltipposition"), - "e_ezsigntemplatesignature_font": obj.get("eEzsigntemplatesignatureFont"), - "b_ezsigntemplatesignature_required": obj.get("bEzsigntemplatesignatureRequired"), - "e_ezsigntemplatesignature_attachmentnamesource": obj.get("eEzsigntemplatesignatureAttachmentnamesource"), - "s_ezsigntemplatesignature_attachmentdescription": obj.get("sEzsigntemplatesignatureAttachmentdescription"), - "i_ezsigntemplatesignature_validationstep": obj.get("iEzsigntemplatesignatureValidationstep"), - "i_ezsigntemplatesignature_maxlength": obj.get("iEzsigntemplatesignatureMaxlength"), - "s_ezsigntemplatesignature_regexp": obj.get("sEzsigntemplatesignatureRegexp"), - "e_ezsigntemplatesignature_textvalidation": obj.get("eEzsigntemplatesignatureTextvalidation"), - "e_ezsigntemplatesignature_dependencyrequirement": obj.get("eEzsigntemplatesignatureDependencyrequirement"), - "b_ezsigntemplatesignature_customdate": obj.get("bEzsigntemplatesignatureCustomdate"), - "a_obj_ezsigntemplatesignaturecustomdate": [EzsigntemplatesignaturecustomdateRequestCompound.from_dict(_item) for _item in obj.get("a_objEzsigntemplatesignaturecustomdate")] if obj.get("a_objEzsigntemplatesignaturecustomdate") is not None else None, - "a_obj_ezsigntemplateelementdependency": [EzsigntemplateelementdependencyRequestCompound.from_dict(_item) for _item in obj.get("a_objEzsigntemplateelementdependency")] if obj.get("a_objEzsigntemplateelementdependency") is not None else None + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsigntemplatesignatureID": obj.get("pkiEzsigntemplatesignatureID"), + "fkiEzsigntemplatedocumentID": obj.get("fkiEzsigntemplatedocumentID"), + "fkiEzsigntemplatesignerID": obj.get("fkiEzsigntemplatesignerID"), + "fkiEzsigntemplatesignerIDValidation": obj.get("fkiEzsigntemplatesignerIDValidation"), + "iEzsigntemplatedocumentpagePagenumber": obj.get("iEzsigntemplatedocumentpagePagenumber"), + "iEzsigntemplatesignatureX": obj.get("iEzsigntemplatesignatureX"), + "iEzsigntemplatesignatureY": obj.get("iEzsigntemplatesignatureY"), + "iEzsigntemplatesignatureWidth": obj.get("iEzsigntemplatesignatureWidth"), + "iEzsigntemplatesignatureHeight": obj.get("iEzsigntemplatesignatureHeight"), + "iEzsigntemplatesignatureStep": obj.get("iEzsigntemplatesignatureStep"), + "eEzsigntemplatesignatureType": obj.get("eEzsigntemplatesignatureType"), + "tEzsigntemplatesignatureTooltip": obj.get("tEzsigntemplatesignatureTooltip"), + "eEzsigntemplatesignatureTooltipposition": obj.get("eEzsigntemplatesignatureTooltipposition"), + "eEzsigntemplatesignatureFont": obj.get("eEzsigntemplatesignatureFont"), + "bEzsigntemplatesignatureRequired": obj.get("bEzsigntemplatesignatureRequired"), + "eEzsigntemplatesignatureAttachmentnamesource": obj.get("eEzsigntemplatesignatureAttachmentnamesource"), + "sEzsigntemplatesignatureAttachmentdescription": obj.get("sEzsigntemplatesignatureAttachmentdescription"), + "iEzsigntemplatesignatureValidationstep": obj.get("iEzsigntemplatesignatureValidationstep"), + "iEzsigntemplatesignatureMaxlength": obj.get("iEzsigntemplatesignatureMaxlength"), + "sEzsigntemplatesignatureRegexp": obj.get("sEzsigntemplatesignatureRegexp"), + "eEzsigntemplatesignatureTextvalidation": obj.get("eEzsigntemplatesignatureTextvalidation"), + "eEzsigntemplatesignatureDependencyrequirement": obj.get("eEzsigntemplatesignatureDependencyrequirement"), + "bEzsigntemplatesignatureCustomdate": obj.get("bEzsigntemplatesignatureCustomdate"), + "a_objEzsigntemplatesignaturecustomdate": [EzsigntemplatesignaturecustomdateRequestCompound.from_dict(_item) for _item in obj.get("a_objEzsigntemplatesignaturecustomdate")] if obj.get("a_objEzsigntemplatesignaturecustomdate") is not None else None, + "a_objEzsigntemplateelementdependency": [EzsigntemplateelementdependencyRequestCompound.from_dict(_item) for _item in obj.get("a_objEzsigntemplateelementdependency")] if obj.get("a_objEzsigntemplateelementdependency") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatesignature_response.py b/eZmaxApi/models/ezsigntemplatesignature_response.py index f2c9e137b..a23aaf98b 100644 --- a/eZmaxApi/models/ezsigntemplatesignature_response.py +++ b/eZmaxApi/models/ezsigntemplatesignature_response.py @@ -19,44 +19,50 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictBool, StrictInt, StrictStr, conint, constr, validator +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, StrictInt, StrictStr, field_validator +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.enum_textvalidation import EnumTextvalidation from eZmaxApi.models.field_e_ezsigntemplatesignature_attachmentnamesource import FieldEEzsigntemplatesignatureAttachmentnamesource from eZmaxApi.models.field_e_ezsigntemplatesignature_dependencyrequirement import FieldEEzsigntemplatesignatureDependencyrequirement from eZmaxApi.models.field_e_ezsigntemplatesignature_font import FieldEEzsigntemplatesignatureFont from eZmaxApi.models.field_e_ezsigntemplatesignature_tooltipposition import FieldEEzsigntemplatesignatureTooltipposition from eZmaxApi.models.field_e_ezsigntemplatesignature_type import FieldEEzsigntemplatesignatureType +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatesignatureResponse(BaseModel): """ - A Ezsigntemplatesignature Object # noqa: E501 - """ - pki_ezsigntemplatesignature_id: conint(strict=True, ge=0) = Field(..., alias="pkiEzsigntemplatesignatureID", description="The unique ID of the Ezsigntemplatesignature") - fki_ezsigntemplatedocument_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsigntemplatedocumentID", description="The unique ID of the Ezsigntemplatedocument") - fki_ezsigntemplatesigner_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsigntemplatesignerID", description="The unique ID of the Ezsigntemplatesigner") - fki_ezsigntemplatesigner_id_validation: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiEzsigntemplatesignerIDValidation", description="The unique ID of the Ezsigntemplatesigner") - i_ezsigntemplatedocumentpage_pagenumber: conint(strict=True, ge=1) = Field(..., alias="iEzsigntemplatedocumentpagePagenumber", description="The page number in the Ezsigntemplatedocument") - i_ezsigntemplatesignature_x: conint(strict=True, ge=0) = Field(..., alias="iEzsigntemplatesignatureX", description="The X coordinate (Horizontal) where to put the Ezsigntemplatesignature on the page. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsigntemplatesignature 2 inches from the left border of the page, you would use \"200\" for the X coordinate.") - i_ezsigntemplatesignature_y: conint(strict=True, ge=0) = Field(..., alias="iEzsigntemplatesignatureY", description="The Y coordinate (Vertical) where to put the Ezsigntemplatesignature on the page. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsigntemplatesignature 3 inches from the top border of the page, you would use \"300\" for the Y coordinate.") - i_ezsigntemplatesignature_width: Optional[conint(strict=True, ge=0)] = Field(None, alias="iEzsigntemplatesignatureWidth", description="The width of the Ezsigntemplatesignature. Size is calculated at 100dpi (dot per inch). So for example, if you want the Ezsigntemplatesignature to have a width of 2 inches, you would use \"200\" for the iEzsigntemplatesignatureWidth.") - i_ezsigntemplatesignature_height: Optional[conint(strict=True, ge=0)] = Field(None, alias="iEzsigntemplatesignatureHeight", description="The height of the Ezsigntemplatesignature. Size is calculated at 100dpi (dot per inch). So for example, if you want the Ezsigntemplatesignature to have an height of 2 inches, you would use \"200\" for the iEzsigntemplatesignatureHeight.") - i_ezsigntemplatesignature_step: conint(strict=True, ge=1) = Field(..., alias="iEzsigntemplatesignatureStep", description="The step when the Ezsigntemplatesigner will be invited to sign") - e_ezsigntemplatesignature_type: FieldEEzsigntemplatesignatureType = Field(..., alias="eEzsigntemplatesignatureType") - t_ezsigntemplatesignature_tooltip: Optional[StrictStr] = Field(None, alias="tEzsigntemplatesignatureTooltip", description="A tooltip that will be presented to Ezsigntemplatesigner about the Ezsigntemplatesignature") - e_ezsigntemplatesignature_tooltipposition: Optional[FieldEEzsigntemplatesignatureTooltipposition] = Field(None, alias="eEzsigntemplatesignatureTooltipposition") - e_ezsigntemplatesignature_font: Optional[FieldEEzsigntemplatesignatureFont] = Field(None, alias="eEzsigntemplatesignatureFont") - i_ezsigntemplatesignature_validationstep: Optional[StrictInt] = Field(None, alias="iEzsigntemplatesignatureValidationstep", description="The step when the Ezsigntemplatesigner will be invited to validate the Ezsigntemplatesignature of eEzsigntemplatesignatureType Attachments") - s_ezsigntemplatesignature_attachmentdescription: Optional[StrictStr] = Field(None, alias="sEzsigntemplatesignatureAttachmentdescription", description="The description attached to the attachment name added in Ezsigntemplatesignature of eEzsigntemplatesignatureType Attachments") - e_ezsigntemplatesignature_attachmentnamesource: Optional[FieldEEzsigntemplatesignatureAttachmentnamesource] = Field(None, alias="eEzsigntemplatesignatureAttachmentnamesource") - b_ezsigntemplatesignature_required: Optional[StrictBool] = Field(None, alias="bEzsigntemplatesignatureRequired", description="Whether the Ezsigntemplatesignature is required or not. This field is relevant only with Ezsigntemplatesignature with eEzsigntemplatesignatureType = Attachments.") - i_ezsigntemplatesignature_maxlength: Optional[conint(strict=True, le=65535, ge=0)] = Field(None, alias="iEzsigntemplatesignatureMaxlength", description="The maximum length for the value in the Ezsigntemplatesignature This can only be set if eEzsigntemplatesignatureType is **FieldText** or **FieldTextarea**") - s_ezsigntemplatesignature_regexp: Optional[constr(strict=True)] = Field(None, alias="sEzsigntemplatesignatureRegexp", description="A regular expression to indicate what values are acceptable for the Ezsigntemplatesignature. This can only be set if eEzsigntemplatesignatureType is **Text** or **Textarea**") - e_ezsigntemplatesignature_textvalidation: Optional[EnumTextvalidation] = Field(None, alias="eEzsigntemplatesignatureTextvalidation") - e_ezsigntemplatesignature_dependencyrequirement: Optional[FieldEEzsigntemplatesignatureDependencyrequirement] = Field(None, alias="eEzsigntemplatesignatureDependencyrequirement") - __properties = ["pkiEzsigntemplatesignatureID", "fkiEzsigntemplatedocumentID", "fkiEzsigntemplatesignerID", "fkiEzsigntemplatesignerIDValidation", "iEzsigntemplatedocumentpagePagenumber", "iEzsigntemplatesignatureX", "iEzsigntemplatesignatureY", "iEzsigntemplatesignatureWidth", "iEzsigntemplatesignatureHeight", "iEzsigntemplatesignatureStep", "eEzsigntemplatesignatureType", "tEzsigntemplatesignatureTooltip", "eEzsigntemplatesignatureTooltipposition", "eEzsigntemplatesignatureFont", "iEzsigntemplatesignatureValidationstep", "sEzsigntemplatesignatureAttachmentdescription", "eEzsigntemplatesignatureAttachmentnamesource", "bEzsigntemplatesignatureRequired", "iEzsigntemplatesignatureMaxlength", "sEzsigntemplatesignatureRegexp", "eEzsigntemplatesignatureTextvalidation", "eEzsigntemplatesignatureDependencyrequirement"] - - @validator('s_ezsigntemplatesignature_regexp') + A Ezsigntemplatesignature Object + """ # noqa: E501 + pki_ezsigntemplatesignature_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsigntemplatesignature", alias="pkiEzsigntemplatesignatureID") + fki_ezsigntemplatedocument_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsigntemplatedocument", alias="fkiEzsigntemplatedocumentID") + fki_ezsigntemplatesigner_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsigntemplatesigner", alias="fkiEzsigntemplatesignerID") + fki_ezsigntemplatesigner_id_validation: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsigntemplatesigner", alias="fkiEzsigntemplatesignerIDValidation") + i_ezsigntemplatedocumentpage_pagenumber: Annotated[int, Field(strict=True, ge=1)] = Field(description="The page number in the Ezsigntemplatedocument", alias="iEzsigntemplatedocumentpagePagenumber") + i_ezsigntemplatesignature_x: Annotated[int, Field(strict=True, ge=0)] = Field(description="The X coordinate (Horizontal) where to put the Ezsigntemplatesignature on the page. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsigntemplatesignature 2 inches from the left border of the page, you would use \"200\" for the X coordinate.", alias="iEzsigntemplatesignatureX") + i_ezsigntemplatesignature_y: Annotated[int, Field(strict=True, ge=0)] = Field(description="The Y coordinate (Vertical) where to put the Ezsigntemplatesignature on the page. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsigntemplatesignature 3 inches from the top border of the page, you would use \"300\" for the Y coordinate.", alias="iEzsigntemplatesignatureY") + i_ezsigntemplatesignature_width: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The width of the Ezsigntemplatesignature. Size is calculated at 100dpi (dot per inch). So for example, if you want the Ezsigntemplatesignature to have a width of 2 inches, you would use \"200\" for the iEzsigntemplatesignatureWidth.", alias="iEzsigntemplatesignatureWidth") + i_ezsigntemplatesignature_height: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The height of the Ezsigntemplatesignature. Size is calculated at 100dpi (dot per inch). So for example, if you want the Ezsigntemplatesignature to have an height of 2 inches, you would use \"200\" for the iEzsigntemplatesignatureHeight.", alias="iEzsigntemplatesignatureHeight") + i_ezsigntemplatesignature_step: Annotated[int, Field(strict=True, ge=1)] = Field(description="The step when the Ezsigntemplatesigner will be invited to sign", alias="iEzsigntemplatesignatureStep") + e_ezsigntemplatesignature_type: FieldEEzsigntemplatesignatureType = Field(alias="eEzsigntemplatesignatureType") + t_ezsigntemplatesignature_tooltip: Optional[StrictStr] = Field(default=None, description="A tooltip that will be presented to Ezsigntemplatesigner about the Ezsigntemplatesignature", alias="tEzsigntemplatesignatureTooltip") + e_ezsigntemplatesignature_tooltipposition: Optional[FieldEEzsigntemplatesignatureTooltipposition] = Field(default=None, alias="eEzsigntemplatesignatureTooltipposition") + e_ezsigntemplatesignature_font: Optional[FieldEEzsigntemplatesignatureFont] = Field(default=None, alias="eEzsigntemplatesignatureFont") + i_ezsigntemplatesignature_validationstep: Optional[StrictInt] = Field(default=None, description="The step when the Ezsigntemplatesigner will be invited to validate the Ezsigntemplatesignature of eEzsigntemplatesignatureType Attachments", alias="iEzsigntemplatesignatureValidationstep") + s_ezsigntemplatesignature_attachmentdescription: Optional[StrictStr] = Field(default=None, description="The description attached to the attachment name added in Ezsigntemplatesignature of eEzsigntemplatesignatureType Attachments", alias="sEzsigntemplatesignatureAttachmentdescription") + e_ezsigntemplatesignature_attachmentnamesource: Optional[FieldEEzsigntemplatesignatureAttachmentnamesource] = Field(default=None, alias="eEzsigntemplatesignatureAttachmentnamesource") + b_ezsigntemplatesignature_required: Optional[StrictBool] = Field(default=None, description="Whether the Ezsigntemplatesignature is required or not. This field is relevant only with Ezsigntemplatesignature with eEzsigntemplatesignatureType = Attachments.", alias="bEzsigntemplatesignatureRequired") + i_ezsigntemplatesignature_maxlength: Optional[Annotated[int, Field(le=65535, strict=True, ge=0)]] = Field(default=None, description="The maximum length for the value in the Ezsigntemplatesignature This can only be set if eEzsigntemplatesignatureType is **FieldText** or **FieldTextarea**", alias="iEzsigntemplatesignatureMaxlength") + s_ezsigntemplatesignature_regexp: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="A regular expression to indicate what values are acceptable for the Ezsigntemplatesignature. This can only be set if eEzsigntemplatesignatureType is **Text** or **Textarea**", alias="sEzsigntemplatesignatureRegexp") + e_ezsigntemplatesignature_textvalidation: Optional[EnumTextvalidation] = Field(default=None, alias="eEzsigntemplatesignatureTextvalidation") + e_ezsigntemplatesignature_dependencyrequirement: Optional[FieldEEzsigntemplatesignatureDependencyrequirement] = Field(default=None, alias="eEzsigntemplatesignatureDependencyrequirement") + __properties: ClassVar[List[str]] = ["pkiEzsigntemplatesignatureID", "fkiEzsigntemplatedocumentID", "fkiEzsigntemplatesignerID", "fkiEzsigntemplatesignerIDValidation", "iEzsigntemplatedocumentpagePagenumber", "iEzsigntemplatesignatureX", "iEzsigntemplatesignatureY", "iEzsigntemplatesignatureWidth", "iEzsigntemplatesignatureHeight", "iEzsigntemplatesignatureStep", "eEzsigntemplatesignatureType", "tEzsigntemplatesignatureTooltip", "eEzsigntemplatesignatureTooltipposition", "eEzsigntemplatesignatureFont", "iEzsigntemplatesignatureValidationstep", "sEzsigntemplatesignatureAttachmentdescription", "eEzsigntemplatesignatureAttachmentnamesource", "bEzsigntemplatesignatureRequired", "iEzsigntemplatesignatureMaxlength", "sEzsigntemplatesignatureRegexp", "eEzsigntemplatesignatureTextvalidation", "eEzsigntemplatesignatureDependencyrequirement"] + + @field_validator('s_ezsigntemplatesignature_regexp') def s_ezsigntemplatesignature_regexp_validate_regular_expression(cls, value): """Validates the regular expression""" if value is None: @@ -66,64 +72,77 @@ def s_ezsigntemplatesignature_regexp_validate_regular_expression(cls, value): raise ValueError(r"must validate the regular expression /^\^.*\$$|^$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatesignatureResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatesignatureResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatesignatureResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatesignatureResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatesignatureResponse.parse_obj(obj) - - _obj = EzsigntemplatesignatureResponse.parse_obj({ - "pki_ezsigntemplatesignature_id": obj.get("pkiEzsigntemplatesignatureID"), - "fki_ezsigntemplatedocument_id": obj.get("fkiEzsigntemplatedocumentID"), - "fki_ezsigntemplatesigner_id": obj.get("fkiEzsigntemplatesignerID"), - "fki_ezsigntemplatesigner_id_validation": obj.get("fkiEzsigntemplatesignerIDValidation"), - "i_ezsigntemplatedocumentpage_pagenumber": obj.get("iEzsigntemplatedocumentpagePagenumber"), - "i_ezsigntemplatesignature_x": obj.get("iEzsigntemplatesignatureX"), - "i_ezsigntemplatesignature_y": obj.get("iEzsigntemplatesignatureY"), - "i_ezsigntemplatesignature_width": obj.get("iEzsigntemplatesignatureWidth"), - "i_ezsigntemplatesignature_height": obj.get("iEzsigntemplatesignatureHeight"), - "i_ezsigntemplatesignature_step": obj.get("iEzsigntemplatesignatureStep"), - "e_ezsigntemplatesignature_type": obj.get("eEzsigntemplatesignatureType"), - "t_ezsigntemplatesignature_tooltip": obj.get("tEzsigntemplatesignatureTooltip"), - "e_ezsigntemplatesignature_tooltipposition": obj.get("eEzsigntemplatesignatureTooltipposition"), - "e_ezsigntemplatesignature_font": obj.get("eEzsigntemplatesignatureFont"), - "i_ezsigntemplatesignature_validationstep": obj.get("iEzsigntemplatesignatureValidationstep"), - "s_ezsigntemplatesignature_attachmentdescription": obj.get("sEzsigntemplatesignatureAttachmentdescription"), - "e_ezsigntemplatesignature_attachmentnamesource": obj.get("eEzsigntemplatesignatureAttachmentnamesource"), - "b_ezsigntemplatesignature_required": obj.get("bEzsigntemplatesignatureRequired"), - "i_ezsigntemplatesignature_maxlength": obj.get("iEzsigntemplatesignatureMaxlength"), - "s_ezsigntemplatesignature_regexp": obj.get("sEzsigntemplatesignatureRegexp"), - "e_ezsigntemplatesignature_textvalidation": obj.get("eEzsigntemplatesignatureTextvalidation"), - "e_ezsigntemplatesignature_dependencyrequirement": obj.get("eEzsigntemplatesignatureDependencyrequirement") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsigntemplatesignatureID": obj.get("pkiEzsigntemplatesignatureID"), + "fkiEzsigntemplatedocumentID": obj.get("fkiEzsigntemplatedocumentID"), + "fkiEzsigntemplatesignerID": obj.get("fkiEzsigntemplatesignerID"), + "fkiEzsigntemplatesignerIDValidation": obj.get("fkiEzsigntemplatesignerIDValidation"), + "iEzsigntemplatedocumentpagePagenumber": obj.get("iEzsigntemplatedocumentpagePagenumber"), + "iEzsigntemplatesignatureX": obj.get("iEzsigntemplatesignatureX"), + "iEzsigntemplatesignatureY": obj.get("iEzsigntemplatesignatureY"), + "iEzsigntemplatesignatureWidth": obj.get("iEzsigntemplatesignatureWidth"), + "iEzsigntemplatesignatureHeight": obj.get("iEzsigntemplatesignatureHeight"), + "iEzsigntemplatesignatureStep": obj.get("iEzsigntemplatesignatureStep"), + "eEzsigntemplatesignatureType": obj.get("eEzsigntemplatesignatureType"), + "tEzsigntemplatesignatureTooltip": obj.get("tEzsigntemplatesignatureTooltip"), + "eEzsigntemplatesignatureTooltipposition": obj.get("eEzsigntemplatesignatureTooltipposition"), + "eEzsigntemplatesignatureFont": obj.get("eEzsigntemplatesignatureFont"), + "iEzsigntemplatesignatureValidationstep": obj.get("iEzsigntemplatesignatureValidationstep"), + "sEzsigntemplatesignatureAttachmentdescription": obj.get("sEzsigntemplatesignatureAttachmentdescription"), + "eEzsigntemplatesignatureAttachmentnamesource": obj.get("eEzsigntemplatesignatureAttachmentnamesource"), + "bEzsigntemplatesignatureRequired": obj.get("bEzsigntemplatesignatureRequired"), + "iEzsigntemplatesignatureMaxlength": obj.get("iEzsigntemplatesignatureMaxlength"), + "sEzsigntemplatesignatureRegexp": obj.get("sEzsigntemplatesignatureRegexp"), + "eEzsigntemplatesignatureTextvalidation": obj.get("eEzsigntemplatesignatureTextvalidation"), + "eEzsigntemplatesignatureDependencyrequirement": obj.get("eEzsigntemplatesignatureDependencyrequirement") }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatesignature_response_compound.py b/eZmaxApi/models/ezsigntemplatesignature_response_compound.py index e5363641c..323ee5a99 100644 --- a/eZmaxApi/models/ezsigntemplatesignature_response_compound.py +++ b/eZmaxApi/models/ezsigntemplatesignature_response_compound.py @@ -19,8 +19,10 @@ import json -from typing import List, Optional -from pydantic import BaseModel, Field, StrictBool, StrictInt, StrictStr, conint, conlist, constr, validator +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, StrictInt, StrictStr, field_validator +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.enum_textvalidation import EnumTextvalidation from eZmaxApi.models.ezsigntemplateelementdependency_response_compound import EzsigntemplateelementdependencyResponseCompound from eZmaxApi.models.ezsigntemplatesignaturecustomdate_response_compound import EzsigntemplatesignaturecustomdateResponseCompound @@ -29,39 +31,43 @@ from eZmaxApi.models.field_e_ezsigntemplatesignature_font import FieldEEzsigntemplatesignatureFont from eZmaxApi.models.field_e_ezsigntemplatesignature_tooltipposition import FieldEEzsigntemplatesignatureTooltipposition from eZmaxApi.models.field_e_ezsigntemplatesignature_type import FieldEEzsigntemplatesignatureType +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatesignatureResponseCompound(BaseModel): """ - A Ezsigntemplatesignature Object # noqa: E501 - """ - pki_ezsigntemplatesignature_id: conint(strict=True, ge=0) = Field(..., alias="pkiEzsigntemplatesignatureID", description="The unique ID of the Ezsigntemplatesignature") - fki_ezsigntemplatedocument_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsigntemplatedocumentID", description="The unique ID of the Ezsigntemplatedocument") - fki_ezsigntemplatesigner_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsigntemplatesignerID", description="The unique ID of the Ezsigntemplatesigner") - fki_ezsigntemplatesigner_id_validation: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiEzsigntemplatesignerIDValidation", description="The unique ID of the Ezsigntemplatesigner") - i_ezsigntemplatedocumentpage_pagenumber: conint(strict=True, ge=1) = Field(..., alias="iEzsigntemplatedocumentpagePagenumber", description="The page number in the Ezsigntemplatedocument") - i_ezsigntemplatesignature_x: conint(strict=True, ge=0) = Field(..., alias="iEzsigntemplatesignatureX", description="The X coordinate (Horizontal) where to put the Ezsigntemplatesignature on the page. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsigntemplatesignature 2 inches from the left border of the page, you would use \"200\" for the X coordinate.") - i_ezsigntemplatesignature_y: conint(strict=True, ge=0) = Field(..., alias="iEzsigntemplatesignatureY", description="The Y coordinate (Vertical) where to put the Ezsigntemplatesignature on the page. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsigntemplatesignature 3 inches from the top border of the page, you would use \"300\" for the Y coordinate.") - i_ezsigntemplatesignature_width: Optional[conint(strict=True, ge=0)] = Field(None, alias="iEzsigntemplatesignatureWidth", description="The width of the Ezsigntemplatesignature. Size is calculated at 100dpi (dot per inch). So for example, if you want the Ezsigntemplatesignature to have a width of 2 inches, you would use \"200\" for the iEzsigntemplatesignatureWidth.") - i_ezsigntemplatesignature_height: Optional[conint(strict=True, ge=0)] = Field(None, alias="iEzsigntemplatesignatureHeight", description="The height of the Ezsigntemplatesignature. Size is calculated at 100dpi (dot per inch). So for example, if you want the Ezsigntemplatesignature to have an height of 2 inches, you would use \"200\" for the iEzsigntemplatesignatureHeight.") - i_ezsigntemplatesignature_step: conint(strict=True, ge=1) = Field(..., alias="iEzsigntemplatesignatureStep", description="The step when the Ezsigntemplatesigner will be invited to sign") - e_ezsigntemplatesignature_type: FieldEEzsigntemplatesignatureType = Field(..., alias="eEzsigntemplatesignatureType") - t_ezsigntemplatesignature_tooltip: Optional[StrictStr] = Field(None, alias="tEzsigntemplatesignatureTooltip", description="A tooltip that will be presented to Ezsigntemplatesigner about the Ezsigntemplatesignature") - e_ezsigntemplatesignature_tooltipposition: Optional[FieldEEzsigntemplatesignatureTooltipposition] = Field(None, alias="eEzsigntemplatesignatureTooltipposition") - e_ezsigntemplatesignature_font: Optional[FieldEEzsigntemplatesignatureFont] = Field(None, alias="eEzsigntemplatesignatureFont") - i_ezsigntemplatesignature_validationstep: Optional[StrictInt] = Field(None, alias="iEzsigntemplatesignatureValidationstep", description="The step when the Ezsigntemplatesigner will be invited to validate the Ezsigntemplatesignature of eEzsigntemplatesignatureType Attachments") - s_ezsigntemplatesignature_attachmentdescription: Optional[StrictStr] = Field(None, alias="sEzsigntemplatesignatureAttachmentdescription", description="The description attached to the attachment name added in Ezsigntemplatesignature of eEzsigntemplatesignatureType Attachments") - e_ezsigntemplatesignature_attachmentnamesource: Optional[FieldEEzsigntemplatesignatureAttachmentnamesource] = Field(None, alias="eEzsigntemplatesignatureAttachmentnamesource") - b_ezsigntemplatesignature_required: Optional[StrictBool] = Field(None, alias="bEzsigntemplatesignatureRequired", description="Whether the Ezsigntemplatesignature is required or not. This field is relevant only with Ezsigntemplatesignature with eEzsigntemplatesignatureType = Attachments.") - i_ezsigntemplatesignature_maxlength: Optional[conint(strict=True, le=65535, ge=0)] = Field(None, alias="iEzsigntemplatesignatureMaxlength", description="The maximum length for the value in the Ezsigntemplatesignature This can only be set if eEzsigntemplatesignatureType is **FieldText** or **FieldTextarea**") - s_ezsigntemplatesignature_regexp: Optional[constr(strict=True)] = Field(None, alias="sEzsigntemplatesignatureRegexp", description="A regular expression to indicate what values are acceptable for the Ezsigntemplatesignature. This can only be set if eEzsigntemplatesignatureType is **Text** or **Textarea**") - e_ezsigntemplatesignature_textvalidation: Optional[EnumTextvalidation] = Field(None, alias="eEzsigntemplatesignatureTextvalidation") - e_ezsigntemplatesignature_dependencyrequirement: Optional[FieldEEzsigntemplatesignatureDependencyrequirement] = Field(None, alias="eEzsigntemplatesignatureDependencyrequirement") - b_ezsigntemplatesignature_customdate: Optional[StrictBool] = Field(None, alias="bEzsigntemplatesignatureCustomdate", description="Whether the Ezsigntemplatesignature has a custom date format or not. (Only possible when eEzsigntemplatesignatureType is **Name** or **Handwritten**)") - a_obj_ezsigntemplatesignaturecustomdate: Optional[conlist(EzsigntemplatesignaturecustomdateResponseCompound)] = Field(None, alias="a_objEzsigntemplatesignaturecustomdate", description="An array of custom date blocks that will be filled at the time of signature. Can only be used if bEzsigntemplatesignatureCustomdate is true. Use an empty array if you don't want to have a date at all.") - a_obj_ezsigntemplateelementdependency: Optional[conlist(EzsigntemplateelementdependencyResponseCompound)] = Field(None, alias="a_objEzsigntemplateelementdependency") - __properties = ["pkiEzsigntemplatesignatureID", "fkiEzsigntemplatedocumentID", "fkiEzsigntemplatesignerID", "fkiEzsigntemplatesignerIDValidation", "iEzsigntemplatedocumentpagePagenumber", "iEzsigntemplatesignatureX", "iEzsigntemplatesignatureY", "iEzsigntemplatesignatureWidth", "iEzsigntemplatesignatureHeight", "iEzsigntemplatesignatureStep", "eEzsigntemplatesignatureType", "tEzsigntemplatesignatureTooltip", "eEzsigntemplatesignatureTooltipposition", "eEzsigntemplatesignatureFont", "iEzsigntemplatesignatureValidationstep", "sEzsigntemplatesignatureAttachmentdescription", "eEzsigntemplatesignatureAttachmentnamesource", "bEzsigntemplatesignatureRequired", "iEzsigntemplatesignatureMaxlength", "sEzsigntemplatesignatureRegexp", "eEzsigntemplatesignatureTextvalidation", "eEzsigntemplatesignatureDependencyrequirement", "bEzsigntemplatesignatureCustomdate", "a_objEzsigntemplatesignaturecustomdate", "a_objEzsigntemplateelementdependency"] - - @validator('s_ezsigntemplatesignature_regexp') + A Ezsigntemplatesignature Object + """ # noqa: E501 + pki_ezsigntemplatesignature_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsigntemplatesignature", alias="pkiEzsigntemplatesignatureID") + fki_ezsigntemplatedocument_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsigntemplatedocument", alias="fkiEzsigntemplatedocumentID") + fki_ezsigntemplatesigner_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsigntemplatesigner", alias="fkiEzsigntemplatesignerID") + fki_ezsigntemplatesigner_id_validation: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsigntemplatesigner", alias="fkiEzsigntemplatesignerIDValidation") + i_ezsigntemplatedocumentpage_pagenumber: Annotated[int, Field(strict=True, ge=1)] = Field(description="The page number in the Ezsigntemplatedocument", alias="iEzsigntemplatedocumentpagePagenumber") + i_ezsigntemplatesignature_x: Annotated[int, Field(strict=True, ge=0)] = Field(description="The X coordinate (Horizontal) where to put the Ezsigntemplatesignature on the page. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsigntemplatesignature 2 inches from the left border of the page, you would use \"200\" for the X coordinate.", alias="iEzsigntemplatesignatureX") + i_ezsigntemplatesignature_y: Annotated[int, Field(strict=True, ge=0)] = Field(description="The Y coordinate (Vertical) where to put the Ezsigntemplatesignature on the page. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsigntemplatesignature 3 inches from the top border of the page, you would use \"300\" for the Y coordinate.", alias="iEzsigntemplatesignatureY") + i_ezsigntemplatesignature_width: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The width of the Ezsigntemplatesignature. Size is calculated at 100dpi (dot per inch). So for example, if you want the Ezsigntemplatesignature to have a width of 2 inches, you would use \"200\" for the iEzsigntemplatesignatureWidth.", alias="iEzsigntemplatesignatureWidth") + i_ezsigntemplatesignature_height: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The height of the Ezsigntemplatesignature. Size is calculated at 100dpi (dot per inch). So for example, if you want the Ezsigntemplatesignature to have an height of 2 inches, you would use \"200\" for the iEzsigntemplatesignatureHeight.", alias="iEzsigntemplatesignatureHeight") + i_ezsigntemplatesignature_step: Annotated[int, Field(strict=True, ge=1)] = Field(description="The step when the Ezsigntemplatesigner will be invited to sign", alias="iEzsigntemplatesignatureStep") + e_ezsigntemplatesignature_type: FieldEEzsigntemplatesignatureType = Field(alias="eEzsigntemplatesignatureType") + t_ezsigntemplatesignature_tooltip: Optional[StrictStr] = Field(default=None, description="A tooltip that will be presented to Ezsigntemplatesigner about the Ezsigntemplatesignature", alias="tEzsigntemplatesignatureTooltip") + e_ezsigntemplatesignature_tooltipposition: Optional[FieldEEzsigntemplatesignatureTooltipposition] = Field(default=None, alias="eEzsigntemplatesignatureTooltipposition") + e_ezsigntemplatesignature_font: Optional[FieldEEzsigntemplatesignatureFont] = Field(default=None, alias="eEzsigntemplatesignatureFont") + i_ezsigntemplatesignature_validationstep: Optional[StrictInt] = Field(default=None, description="The step when the Ezsigntemplatesigner will be invited to validate the Ezsigntemplatesignature of eEzsigntemplatesignatureType Attachments", alias="iEzsigntemplatesignatureValidationstep") + s_ezsigntemplatesignature_attachmentdescription: Optional[StrictStr] = Field(default=None, description="The description attached to the attachment name added in Ezsigntemplatesignature of eEzsigntemplatesignatureType Attachments", alias="sEzsigntemplatesignatureAttachmentdescription") + e_ezsigntemplatesignature_attachmentnamesource: Optional[FieldEEzsigntemplatesignatureAttachmentnamesource] = Field(default=None, alias="eEzsigntemplatesignatureAttachmentnamesource") + b_ezsigntemplatesignature_required: Optional[StrictBool] = Field(default=None, description="Whether the Ezsigntemplatesignature is required or not. This field is relevant only with Ezsigntemplatesignature with eEzsigntemplatesignatureType = Attachments.", alias="bEzsigntemplatesignatureRequired") + i_ezsigntemplatesignature_maxlength: Optional[Annotated[int, Field(le=65535, strict=True, ge=0)]] = Field(default=None, description="The maximum length for the value in the Ezsigntemplatesignature This can only be set if eEzsigntemplatesignatureType is **FieldText** or **FieldTextarea**", alias="iEzsigntemplatesignatureMaxlength") + s_ezsigntemplatesignature_regexp: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="A regular expression to indicate what values are acceptable for the Ezsigntemplatesignature. This can only be set if eEzsigntemplatesignatureType is **Text** or **Textarea**", alias="sEzsigntemplatesignatureRegexp") + e_ezsigntemplatesignature_textvalidation: Optional[EnumTextvalidation] = Field(default=None, alias="eEzsigntemplatesignatureTextvalidation") + e_ezsigntemplatesignature_dependencyrequirement: Optional[FieldEEzsigntemplatesignatureDependencyrequirement] = Field(default=None, alias="eEzsigntemplatesignatureDependencyrequirement") + b_ezsigntemplatesignature_customdate: Optional[StrictBool] = Field(default=None, description="Whether the Ezsigntemplatesignature has a custom date format or not. (Only possible when eEzsigntemplatesignatureType is **Name** or **Handwritten**)", alias="bEzsigntemplatesignatureCustomdate") + a_obj_ezsigntemplatesignaturecustomdate: Optional[List[EzsigntemplatesignaturecustomdateResponseCompound]] = Field(default=None, description="An array of custom date blocks that will be filled at the time of signature. Can only be used if bEzsigntemplatesignatureCustomdate is true. Use an empty array if you don't want to have a date at all.", alias="a_objEzsigntemplatesignaturecustomdate") + a_obj_ezsigntemplateelementdependency: Optional[List[EzsigntemplateelementdependencyResponseCompound]] = Field(default=None, alias="a_objEzsigntemplateelementdependency") + __properties: ClassVar[List[str]] = ["pkiEzsigntemplatesignatureID", "fkiEzsigntemplatedocumentID", "fkiEzsigntemplatesignerID", "fkiEzsigntemplatesignerIDValidation", "iEzsigntemplatedocumentpagePagenumber", "iEzsigntemplatesignatureX", "iEzsigntemplatesignatureY", "iEzsigntemplatesignatureWidth", "iEzsigntemplatesignatureHeight", "iEzsigntemplatesignatureStep", "eEzsigntemplatesignatureType", "tEzsigntemplatesignatureTooltip", "eEzsigntemplatesignatureTooltipposition", "eEzsigntemplatesignatureFont", "iEzsigntemplatesignatureValidationstep", "sEzsigntemplatesignatureAttachmentdescription", "eEzsigntemplatesignatureAttachmentnamesource", "bEzsigntemplatesignatureRequired", "iEzsigntemplatesignatureMaxlength", "sEzsigntemplatesignatureRegexp", "eEzsigntemplatesignatureTextvalidation", "eEzsigntemplatesignatureDependencyrequirement", "bEzsigntemplatesignatureCustomdate", "a_objEzsigntemplatesignaturecustomdate", "a_objEzsigntemplateelementdependency"] + + @field_validator('s_ezsigntemplatesignature_regexp') def s_ezsigntemplatesignature_regexp_validate_regular_expression(cls, value): """Validates the regular expression""" if value is None: @@ -71,30 +77,43 @@ def s_ezsigntemplatesignature_regexp_validate_regular_expression(cls, value): raise ValueError(r"must validate the regular expression /^\^.*\$$|^$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatesignatureResponseCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatesignatureResponseCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_ezsigntemplatesignaturecustomdate (list) _items = [] if self.a_obj_ezsigntemplatesignaturecustomdate: @@ -112,40 +131,40 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatesignatureResponseCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatesignatureResponseCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatesignatureResponseCompound.parse_obj(obj) - - _obj = EzsigntemplatesignatureResponseCompound.parse_obj({ - "pki_ezsigntemplatesignature_id": obj.get("pkiEzsigntemplatesignatureID"), - "fki_ezsigntemplatedocument_id": obj.get("fkiEzsigntemplatedocumentID"), - "fki_ezsigntemplatesigner_id": obj.get("fkiEzsigntemplatesignerID"), - "fki_ezsigntemplatesigner_id_validation": obj.get("fkiEzsigntemplatesignerIDValidation"), - "i_ezsigntemplatedocumentpage_pagenumber": obj.get("iEzsigntemplatedocumentpagePagenumber"), - "i_ezsigntemplatesignature_x": obj.get("iEzsigntemplatesignatureX"), - "i_ezsigntemplatesignature_y": obj.get("iEzsigntemplatesignatureY"), - "i_ezsigntemplatesignature_width": obj.get("iEzsigntemplatesignatureWidth"), - "i_ezsigntemplatesignature_height": obj.get("iEzsigntemplatesignatureHeight"), - "i_ezsigntemplatesignature_step": obj.get("iEzsigntemplatesignatureStep"), - "e_ezsigntemplatesignature_type": obj.get("eEzsigntemplatesignatureType"), - "t_ezsigntemplatesignature_tooltip": obj.get("tEzsigntemplatesignatureTooltip"), - "e_ezsigntemplatesignature_tooltipposition": obj.get("eEzsigntemplatesignatureTooltipposition"), - "e_ezsigntemplatesignature_font": obj.get("eEzsigntemplatesignatureFont"), - "i_ezsigntemplatesignature_validationstep": obj.get("iEzsigntemplatesignatureValidationstep"), - "s_ezsigntemplatesignature_attachmentdescription": obj.get("sEzsigntemplatesignatureAttachmentdescription"), - "e_ezsigntemplatesignature_attachmentnamesource": obj.get("eEzsigntemplatesignatureAttachmentnamesource"), - "b_ezsigntemplatesignature_required": obj.get("bEzsigntemplatesignatureRequired"), - "i_ezsigntemplatesignature_maxlength": obj.get("iEzsigntemplatesignatureMaxlength"), - "s_ezsigntemplatesignature_regexp": obj.get("sEzsigntemplatesignatureRegexp"), - "e_ezsigntemplatesignature_textvalidation": obj.get("eEzsigntemplatesignatureTextvalidation"), - "e_ezsigntemplatesignature_dependencyrequirement": obj.get("eEzsigntemplatesignatureDependencyrequirement"), - "b_ezsigntemplatesignature_customdate": obj.get("bEzsigntemplatesignatureCustomdate"), - "a_obj_ezsigntemplatesignaturecustomdate": [EzsigntemplatesignaturecustomdateResponseCompound.from_dict(_item) for _item in obj.get("a_objEzsigntemplatesignaturecustomdate")] if obj.get("a_objEzsigntemplatesignaturecustomdate") is not None else None, - "a_obj_ezsigntemplateelementdependency": [EzsigntemplateelementdependencyResponseCompound.from_dict(_item) for _item in obj.get("a_objEzsigntemplateelementdependency")] if obj.get("a_objEzsigntemplateelementdependency") is not None else None + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsigntemplatesignatureID": obj.get("pkiEzsigntemplatesignatureID"), + "fkiEzsigntemplatedocumentID": obj.get("fkiEzsigntemplatedocumentID"), + "fkiEzsigntemplatesignerID": obj.get("fkiEzsigntemplatesignerID"), + "fkiEzsigntemplatesignerIDValidation": obj.get("fkiEzsigntemplatesignerIDValidation"), + "iEzsigntemplatedocumentpagePagenumber": obj.get("iEzsigntemplatedocumentpagePagenumber"), + "iEzsigntemplatesignatureX": obj.get("iEzsigntemplatesignatureX"), + "iEzsigntemplatesignatureY": obj.get("iEzsigntemplatesignatureY"), + "iEzsigntemplatesignatureWidth": obj.get("iEzsigntemplatesignatureWidth"), + "iEzsigntemplatesignatureHeight": obj.get("iEzsigntemplatesignatureHeight"), + "iEzsigntemplatesignatureStep": obj.get("iEzsigntemplatesignatureStep"), + "eEzsigntemplatesignatureType": obj.get("eEzsigntemplatesignatureType"), + "tEzsigntemplatesignatureTooltip": obj.get("tEzsigntemplatesignatureTooltip"), + "eEzsigntemplatesignatureTooltipposition": obj.get("eEzsigntemplatesignatureTooltipposition"), + "eEzsigntemplatesignatureFont": obj.get("eEzsigntemplatesignatureFont"), + "iEzsigntemplatesignatureValidationstep": obj.get("iEzsigntemplatesignatureValidationstep"), + "sEzsigntemplatesignatureAttachmentdescription": obj.get("sEzsigntemplatesignatureAttachmentdescription"), + "eEzsigntemplatesignatureAttachmentnamesource": obj.get("eEzsigntemplatesignatureAttachmentnamesource"), + "bEzsigntemplatesignatureRequired": obj.get("bEzsigntemplatesignatureRequired"), + "iEzsigntemplatesignatureMaxlength": obj.get("iEzsigntemplatesignatureMaxlength"), + "sEzsigntemplatesignatureRegexp": obj.get("sEzsigntemplatesignatureRegexp"), + "eEzsigntemplatesignatureTextvalidation": obj.get("eEzsigntemplatesignatureTextvalidation"), + "eEzsigntemplatesignatureDependencyrequirement": obj.get("eEzsigntemplatesignatureDependencyrequirement"), + "bEzsigntemplatesignatureCustomdate": obj.get("bEzsigntemplatesignatureCustomdate"), + "a_objEzsigntemplatesignaturecustomdate": [EzsigntemplatesignaturecustomdateResponseCompound.from_dict(_item) for _item in obj.get("a_objEzsigntemplatesignaturecustomdate")] if obj.get("a_objEzsigntemplatesignaturecustomdate") is not None else None, + "a_objEzsigntemplateelementdependency": [EzsigntemplateelementdependencyResponseCompound.from_dict(_item) for _item in obj.get("a_objEzsigntemplateelementdependency")] if obj.get("a_objEzsigntemplateelementdependency") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatesignaturecustomdate_request.py b/eZmaxApi/models/ezsigntemplatesignaturecustomdate_request.py index df4c2a441..f87e23181 100644 --- a/eZmaxApi/models/ezsigntemplatesignaturecustomdate_request.py +++ b/eZmaxApi/models/ezsigntemplatesignaturecustomdate_request.py @@ -19,59 +19,78 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictStr, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictStr +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatesignaturecustomdateRequest(BaseModel): """ - An Ezsigntemplatesignaturecustomdate Object # noqa: E501 - """ - pki_ezsigntemplatesignaturecustomdate_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="pkiEzsigntemplatesignaturecustomdateID", description="The unique ID of the Ezsigntemplatesignaturecustomdate") - i_ezsigntemplatesignaturecustomdate_x: conint(strict=True, ge=0) = Field(..., alias="iEzsigntemplatesignaturecustomdateX", description="The X coordinate (Horizontal) where to put the Ezsigntemplatesignaturecustomdate on the page. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsigntemplatesignaturecustomdate 2 inches from the left border of the page, you would use \"200\" for the X coordinate.") - i_ezsigntemplatesignaturecustomdate_y: conint(strict=True, ge=0) = Field(..., alias="iEzsigntemplatesignaturecustomdateY", description="The Y coordinate (Vertical) where to put the Ezsigntemplatesignaturecustomdate on the page. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsigntemplatesignaturecustomdate 3 inches from the top border of the page, you would use \"300\" for the Y coordinate.") - s_ezsigntemplatesignaturecustomdate_format: StrictStr = Field(..., alias="sEzsigntemplatesignaturecustomdateFormat", description="The custom date format to use You can use the codes below and they will be replaced at signature time. Text values like month and day names will be rendered in the proper language. Other text will be left as-is. The codes examples below are based on the following datetime: Thursday, January 6, 2022 at 08:07:09 EST For example, the format \"Signature date: {MM}/{DD}/{YYYY} {hh}:{mm}\" would become \"Signature date: 01/06/2022 08:07\" **Year** | Code | Example | | - | - | | {YYYY} | 2022 | | {YY} | 22 | **Month** | Code | Example | | - | - | | {MonthCapitalize} | Janvier | | {Month} | janvier | | {MM} | 01 | | {M} | 1 | **Day** | Code | Example | | - | - | | {DayCapitalize} | Jeudi | | {Day} | jeudi | | {DD} | 06 | | {D} | 6 | **Hour** | Code | Example | | - | - | | {hh} | 08 | **Minute** | Code | Example | | - | - | | {mm} | 07 | **Second** | Code | Example | | - | - | | {ss} | 09 | **Timezone** | Code | Example | | - | - | | {Z} | EST | **Time** | Code | Example | | - | - | | {Time} | 08:07:09 | | {TimeZ} | 08:07:09 EST | **Date** | Code | Example | | - | - | | {Date} | 2022-01-06 | | {DateText} | 1er Janvier 2022 | **Full** | Code | Example | | - | - | | {DateTime} | 2022-01-06 08:07:09 | | {DateTimeZ} | 2022-01-06 08:07:09 EST | ") - __properties = ["pkiEzsigntemplatesignaturecustomdateID", "iEzsigntemplatesignaturecustomdateX", "iEzsigntemplatesignaturecustomdateY", "sEzsigntemplatesignaturecustomdateFormat"] + An Ezsigntemplatesignaturecustomdate Object + """ # noqa: E501 + pki_ezsigntemplatesignaturecustomdate_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsigntemplatesignaturecustomdate", alias="pkiEzsigntemplatesignaturecustomdateID") + i_ezsigntemplatesignaturecustomdate_x: Annotated[int, Field(strict=True, ge=0)] = Field(description="The X coordinate (Horizontal) where to put the Ezsigntemplatesignaturecustomdate on the page. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsigntemplatesignaturecustomdate 2 inches from the left border of the page, you would use \"200\" for the X coordinate.", alias="iEzsigntemplatesignaturecustomdateX") + i_ezsigntemplatesignaturecustomdate_y: Annotated[int, Field(strict=True, ge=0)] = Field(description="The Y coordinate (Vertical) where to put the Ezsigntemplatesignaturecustomdate on the page. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsigntemplatesignaturecustomdate 3 inches from the top border of the page, you would use \"300\" for the Y coordinate.", alias="iEzsigntemplatesignaturecustomdateY") + s_ezsigntemplatesignaturecustomdate_format: StrictStr = Field(description="The custom date format to use You can use the codes below and they will be replaced at signature time. Text values like month and day names will be rendered in the proper language. Other text will be left as-is. The codes examples below are based on the following datetime: Thursday, January 6, 2022 at 08:07:09 EST For example, the format \"Signature date: {MM}/{DD}/{YYYY} {hh}:{mm}\" would become \"Signature date: 01/06/2022 08:07\" **Year** | Code | Example | | - | - | | {YYYY} | 2022 | | {YY} | 22 | **Month** | Code | Example | | - | - | | {MonthCapitalize} | Janvier | | {Month} | janvier | | {MM} | 01 | | {M} | 1 | **Day** | Code | Example | | - | - | | {DayCapitalize} | Jeudi | | {Day} | jeudi | | {DD} | 06 | | {D} | 6 | **Hour** | Code | Example | | - | - | | {hh} | 08 | **Minute** | Code | Example | | - | - | | {mm} | 07 | **Second** | Code | Example | | - | - | | {ss} | 09 | **Timezone** | Code | Example | | - | - | | {Z} | EST | **Time** | Code | Example | | - | - | | {Time} | 08:07:09 | | {TimeZ} | 08:07:09 EST | **Date** | Code | Example | | - | - | | {Date} | 2022-01-06 | | {DateText} | 1er Janvier 2022 | **Full** | Code | Example | | - | - | | {DateTime} | 2022-01-06 08:07:09 | | {DateTimeZ} | 2022-01-06 08:07:09 EST | ", alias="sEzsigntemplatesignaturecustomdateFormat") + __properties: ClassVar[List[str]] = ["pkiEzsigntemplatesignaturecustomdateID", "iEzsigntemplatesignaturecustomdateX", "iEzsigntemplatesignaturecustomdateY", "sEzsigntemplatesignaturecustomdateFormat"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatesignaturecustomdateRequest: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatesignaturecustomdateRequest from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatesignaturecustomdateRequest: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatesignaturecustomdateRequest from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatesignaturecustomdateRequest.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplatesignaturecustomdateRequest.parse_obj({ - "pki_ezsigntemplatesignaturecustomdate_id": obj.get("pkiEzsigntemplatesignaturecustomdateID"), - "i_ezsigntemplatesignaturecustomdate_x": obj.get("iEzsigntemplatesignaturecustomdateX"), - "i_ezsigntemplatesignaturecustomdate_y": obj.get("iEzsigntemplatesignaturecustomdateY"), - "s_ezsigntemplatesignaturecustomdate_format": obj.get("sEzsigntemplatesignaturecustomdateFormat") + _obj = cls.model_validate({ + "pkiEzsigntemplatesignaturecustomdateID": obj.get("pkiEzsigntemplatesignaturecustomdateID"), + "iEzsigntemplatesignaturecustomdateX": obj.get("iEzsigntemplatesignaturecustomdateX"), + "iEzsigntemplatesignaturecustomdateY": obj.get("iEzsigntemplatesignaturecustomdateY"), + "sEzsigntemplatesignaturecustomdateFormat": obj.get("sEzsigntemplatesignaturecustomdateFormat") }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatesignaturecustomdate_request_compound.py b/eZmaxApi/models/ezsigntemplatesignaturecustomdate_request_compound.py index 18bb41a93..8c5b4851f 100644 --- a/eZmaxApi/models/ezsigntemplatesignaturecustomdate_request_compound.py +++ b/eZmaxApi/models/ezsigntemplatesignaturecustomdate_request_compound.py @@ -19,59 +19,78 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictStr, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictStr +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatesignaturecustomdateRequestCompound(BaseModel): """ - An Ezsigntemplatesignaturecustomdate Object and children to create a complete structure # noqa: E501 - """ - pki_ezsigntemplatesignaturecustomdate_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="pkiEzsigntemplatesignaturecustomdateID", description="The unique ID of the Ezsigntemplatesignaturecustomdate") - i_ezsigntemplatesignaturecustomdate_x: conint(strict=True, ge=0) = Field(..., alias="iEzsigntemplatesignaturecustomdateX", description="The X coordinate (Horizontal) where to put the Ezsigntemplatesignaturecustomdate on the page. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsigntemplatesignaturecustomdate 2 inches from the left border of the page, you would use \"200\" for the X coordinate.") - i_ezsigntemplatesignaturecustomdate_y: conint(strict=True, ge=0) = Field(..., alias="iEzsigntemplatesignaturecustomdateY", description="The Y coordinate (Vertical) where to put the Ezsigntemplatesignaturecustomdate on the page. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsigntemplatesignaturecustomdate 3 inches from the top border of the page, you would use \"300\" for the Y coordinate.") - s_ezsigntemplatesignaturecustomdate_format: StrictStr = Field(..., alias="sEzsigntemplatesignaturecustomdateFormat", description="The custom date format to use You can use the codes below and they will be replaced at signature time. Text values like month and day names will be rendered in the proper language. Other text will be left as-is. The codes examples below are based on the following datetime: Thursday, January 6, 2022 at 08:07:09 EST For example, the format \"Signature date: {MM}/{DD}/{YYYY} {hh}:{mm}\" would become \"Signature date: 01/06/2022 08:07\" **Year** | Code | Example | | - | - | | {YYYY} | 2022 | | {YY} | 22 | **Month** | Code | Example | | - | - | | {MonthCapitalize} | Janvier | | {Month} | janvier | | {MM} | 01 | | {M} | 1 | **Day** | Code | Example | | - | - | | {DayCapitalize} | Jeudi | | {Day} | jeudi | | {DD} | 06 | | {D} | 6 | **Hour** | Code | Example | | - | - | | {hh} | 08 | **Minute** | Code | Example | | - | - | | {mm} | 07 | **Second** | Code | Example | | - | - | | {ss} | 09 | **Timezone** | Code | Example | | - | - | | {Z} | EST | **Time** | Code | Example | | - | - | | {Time} | 08:07:09 | | {TimeZ} | 08:07:09 EST | **Date** | Code | Example | | - | - | | {Date} | 2022-01-06 | | {DateText} | 1er Janvier 2022 | **Full** | Code | Example | | - | - | | {DateTime} | 2022-01-06 08:07:09 | | {DateTimeZ} | 2022-01-06 08:07:09 EST | ") - __properties = ["pkiEzsigntemplatesignaturecustomdateID", "iEzsigntemplatesignaturecustomdateX", "iEzsigntemplatesignaturecustomdateY", "sEzsigntemplatesignaturecustomdateFormat"] + An Ezsigntemplatesignaturecustomdate Object and children to create a complete structure + """ # noqa: E501 + pki_ezsigntemplatesignaturecustomdate_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsigntemplatesignaturecustomdate", alias="pkiEzsigntemplatesignaturecustomdateID") + i_ezsigntemplatesignaturecustomdate_x: Annotated[int, Field(strict=True, ge=0)] = Field(description="The X coordinate (Horizontal) where to put the Ezsigntemplatesignaturecustomdate on the page. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsigntemplatesignaturecustomdate 2 inches from the left border of the page, you would use \"200\" for the X coordinate.", alias="iEzsigntemplatesignaturecustomdateX") + i_ezsigntemplatesignaturecustomdate_y: Annotated[int, Field(strict=True, ge=0)] = Field(description="The Y coordinate (Vertical) where to put the Ezsigntemplatesignaturecustomdate on the page. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsigntemplatesignaturecustomdate 3 inches from the top border of the page, you would use \"300\" for the Y coordinate.", alias="iEzsigntemplatesignaturecustomdateY") + s_ezsigntemplatesignaturecustomdate_format: StrictStr = Field(description="The custom date format to use You can use the codes below and they will be replaced at signature time. Text values like month and day names will be rendered in the proper language. Other text will be left as-is. The codes examples below are based on the following datetime: Thursday, January 6, 2022 at 08:07:09 EST For example, the format \"Signature date: {MM}/{DD}/{YYYY} {hh}:{mm}\" would become \"Signature date: 01/06/2022 08:07\" **Year** | Code | Example | | - | - | | {YYYY} | 2022 | | {YY} | 22 | **Month** | Code | Example | | - | - | | {MonthCapitalize} | Janvier | | {Month} | janvier | | {MM} | 01 | | {M} | 1 | **Day** | Code | Example | | - | - | | {DayCapitalize} | Jeudi | | {Day} | jeudi | | {DD} | 06 | | {D} | 6 | **Hour** | Code | Example | | - | - | | {hh} | 08 | **Minute** | Code | Example | | - | - | | {mm} | 07 | **Second** | Code | Example | | - | - | | {ss} | 09 | **Timezone** | Code | Example | | - | - | | {Z} | EST | **Time** | Code | Example | | - | - | | {Time} | 08:07:09 | | {TimeZ} | 08:07:09 EST | **Date** | Code | Example | | - | - | | {Date} | 2022-01-06 | | {DateText} | 1er Janvier 2022 | **Full** | Code | Example | | - | - | | {DateTime} | 2022-01-06 08:07:09 | | {DateTimeZ} | 2022-01-06 08:07:09 EST | ", alias="sEzsigntemplatesignaturecustomdateFormat") + __properties: ClassVar[List[str]] = ["pkiEzsigntemplatesignaturecustomdateID", "iEzsigntemplatesignaturecustomdateX", "iEzsigntemplatesignaturecustomdateY", "sEzsigntemplatesignaturecustomdateFormat"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatesignaturecustomdateRequestCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatesignaturecustomdateRequestCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatesignaturecustomdateRequestCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatesignaturecustomdateRequestCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatesignaturecustomdateRequestCompound.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplatesignaturecustomdateRequestCompound.parse_obj({ - "pki_ezsigntemplatesignaturecustomdate_id": obj.get("pkiEzsigntemplatesignaturecustomdateID"), - "i_ezsigntemplatesignaturecustomdate_x": obj.get("iEzsigntemplatesignaturecustomdateX"), - "i_ezsigntemplatesignaturecustomdate_y": obj.get("iEzsigntemplatesignaturecustomdateY"), - "s_ezsigntemplatesignaturecustomdate_format": obj.get("sEzsigntemplatesignaturecustomdateFormat") + _obj = cls.model_validate({ + "pkiEzsigntemplatesignaturecustomdateID": obj.get("pkiEzsigntemplatesignaturecustomdateID"), + "iEzsigntemplatesignaturecustomdateX": obj.get("iEzsigntemplatesignaturecustomdateX"), + "iEzsigntemplatesignaturecustomdateY": obj.get("iEzsigntemplatesignaturecustomdateY"), + "sEzsigntemplatesignaturecustomdateFormat": obj.get("sEzsigntemplatesignaturecustomdateFormat") }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatesignaturecustomdate_response.py b/eZmaxApi/models/ezsigntemplatesignaturecustomdate_response.py index 2cd648c7a..ad9633f4a 100644 --- a/eZmaxApi/models/ezsigntemplatesignaturecustomdate_response.py +++ b/eZmaxApi/models/ezsigntemplatesignaturecustomdate_response.py @@ -19,59 +19,78 @@ import json - -from pydantic import BaseModel, Field, StrictStr, conint +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictStr +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatesignaturecustomdateResponse(BaseModel): """ - An Ezsigntemplatesignaturecustomdate Object # noqa: E501 - """ - pki_ezsigntemplatesignaturecustomdate_id: conint(strict=True, ge=0) = Field(..., alias="pkiEzsigntemplatesignaturecustomdateID", description="The unique ID of the Ezsigntemplatesignaturecustomdate") - i_ezsigntemplatesignaturecustomdate_x: conint(strict=True, ge=0) = Field(..., alias="iEzsigntemplatesignaturecustomdateX", description="The X coordinate (Horizontal) where to put the Ezsigntemplatesignaturecustomdate on the page. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsigntemplatesignaturecustomdate 2 inches from the left border of the page, you would use \"200\" for the X coordinate.") - i_ezsigntemplatesignaturecustomdate_y: conint(strict=True, ge=0) = Field(..., alias="iEzsigntemplatesignaturecustomdateY", description="The Y coordinate (Vertical) where to put the Ezsigntemplatesignaturecustomdate on the page. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsigntemplatesignaturecustomdate 3 inches from the top border of the page, you would use \"300\" for the Y coordinate.") - s_ezsigntemplatesignaturecustomdate_format: StrictStr = Field(..., alias="sEzsigntemplatesignaturecustomdateFormat", description="The custom date format to use You can use the codes below and they will be replaced at signature time. Text values like month and day names will be rendered in the proper language. Other text will be left as-is. The codes examples below are based on the following datetime: Thursday, January 6, 2022 at 08:07:09 EST For example, the format \"Signature date: {MM}/{DD}/{YYYY} {hh}:{mm}\" would become \"Signature date: 01/06/2022 08:07\" **Year** | Code | Example | | - | - | | {YYYY} | 2022 | | {YY} | 22 | **Month** | Code | Example | | - | - | | {MonthCapitalize} | Janvier | | {Month} | janvier | | {MM} | 01 | | {M} | 1 | **Day** | Code | Example | | - | - | | {DayCapitalize} | Jeudi | | {Day} | jeudi | | {DD} | 06 | | {D} | 6 | **Hour** | Code | Example | | - | - | | {hh} | 08 | **Minute** | Code | Example | | - | - | | {mm} | 07 | **Second** | Code | Example | | - | - | | {ss} | 09 | **Timezone** | Code | Example | | - | - | | {Z} | EST | **Time** | Code | Example | | - | - | | {Time} | 08:07:09 | | {TimeZ} | 08:07:09 EST | **Date** | Code | Example | | - | - | | {Date} | 2022-01-06 | | {DateText} | 1er Janvier 2022 | **Full** | Code | Example | | - | - | | {DateTime} | 2022-01-06 08:07:09 | | {DateTimeZ} | 2022-01-06 08:07:09 EST | ") - __properties = ["pkiEzsigntemplatesignaturecustomdateID", "iEzsigntemplatesignaturecustomdateX", "iEzsigntemplatesignaturecustomdateY", "sEzsigntemplatesignaturecustomdateFormat"] + An Ezsigntemplatesignaturecustomdate Object + """ # noqa: E501 + pki_ezsigntemplatesignaturecustomdate_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsigntemplatesignaturecustomdate", alias="pkiEzsigntemplatesignaturecustomdateID") + i_ezsigntemplatesignaturecustomdate_x: Annotated[int, Field(strict=True, ge=0)] = Field(description="The X coordinate (Horizontal) where to put the Ezsigntemplatesignaturecustomdate on the page. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsigntemplatesignaturecustomdate 2 inches from the left border of the page, you would use \"200\" for the X coordinate.", alias="iEzsigntemplatesignaturecustomdateX") + i_ezsigntemplatesignaturecustomdate_y: Annotated[int, Field(strict=True, ge=0)] = Field(description="The Y coordinate (Vertical) where to put the Ezsigntemplatesignaturecustomdate on the page. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsigntemplatesignaturecustomdate 3 inches from the top border of the page, you would use \"300\" for the Y coordinate.", alias="iEzsigntemplatesignaturecustomdateY") + s_ezsigntemplatesignaturecustomdate_format: StrictStr = Field(description="The custom date format to use You can use the codes below and they will be replaced at signature time. Text values like month and day names will be rendered in the proper language. Other text will be left as-is. The codes examples below are based on the following datetime: Thursday, January 6, 2022 at 08:07:09 EST For example, the format \"Signature date: {MM}/{DD}/{YYYY} {hh}:{mm}\" would become \"Signature date: 01/06/2022 08:07\" **Year** | Code | Example | | - | - | | {YYYY} | 2022 | | {YY} | 22 | **Month** | Code | Example | | - | - | | {MonthCapitalize} | Janvier | | {Month} | janvier | | {MM} | 01 | | {M} | 1 | **Day** | Code | Example | | - | - | | {DayCapitalize} | Jeudi | | {Day} | jeudi | | {DD} | 06 | | {D} | 6 | **Hour** | Code | Example | | - | - | | {hh} | 08 | **Minute** | Code | Example | | - | - | | {mm} | 07 | **Second** | Code | Example | | - | - | | {ss} | 09 | **Timezone** | Code | Example | | - | - | | {Z} | EST | **Time** | Code | Example | | - | - | | {Time} | 08:07:09 | | {TimeZ} | 08:07:09 EST | **Date** | Code | Example | | - | - | | {Date} | 2022-01-06 | | {DateText} | 1er Janvier 2022 | **Full** | Code | Example | | - | - | | {DateTime} | 2022-01-06 08:07:09 | | {DateTimeZ} | 2022-01-06 08:07:09 EST | ", alias="sEzsigntemplatesignaturecustomdateFormat") + __properties: ClassVar[List[str]] = ["pkiEzsigntemplatesignaturecustomdateID", "iEzsigntemplatesignaturecustomdateX", "iEzsigntemplatesignaturecustomdateY", "sEzsigntemplatesignaturecustomdateFormat"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatesignaturecustomdateResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatesignaturecustomdateResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatesignaturecustomdateResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatesignaturecustomdateResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatesignaturecustomdateResponse.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplatesignaturecustomdateResponse.parse_obj({ - "pki_ezsigntemplatesignaturecustomdate_id": obj.get("pkiEzsigntemplatesignaturecustomdateID"), - "i_ezsigntemplatesignaturecustomdate_x": obj.get("iEzsigntemplatesignaturecustomdateX"), - "i_ezsigntemplatesignaturecustomdate_y": obj.get("iEzsigntemplatesignaturecustomdateY"), - "s_ezsigntemplatesignaturecustomdate_format": obj.get("sEzsigntemplatesignaturecustomdateFormat") + _obj = cls.model_validate({ + "pkiEzsigntemplatesignaturecustomdateID": obj.get("pkiEzsigntemplatesignaturecustomdateID"), + "iEzsigntemplatesignaturecustomdateX": obj.get("iEzsigntemplatesignaturecustomdateX"), + "iEzsigntemplatesignaturecustomdateY": obj.get("iEzsigntemplatesignaturecustomdateY"), + "sEzsigntemplatesignaturecustomdateFormat": obj.get("sEzsigntemplatesignaturecustomdateFormat") }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatesignaturecustomdate_response_compound.py b/eZmaxApi/models/ezsigntemplatesignaturecustomdate_response_compound.py index 700987c38..6eb24edac 100644 --- a/eZmaxApi/models/ezsigntemplatesignaturecustomdate_response_compound.py +++ b/eZmaxApi/models/ezsigntemplatesignaturecustomdate_response_compound.py @@ -19,59 +19,78 @@ import json - -from pydantic import BaseModel, Field, StrictStr, conint +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictStr +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatesignaturecustomdateResponseCompound(BaseModel): """ - An Ezsigntemplatesignaturecustomdate Object and children to create a complete structure # noqa: E501 - """ - pki_ezsigntemplatesignaturecustomdate_id: conint(strict=True, ge=0) = Field(..., alias="pkiEzsigntemplatesignaturecustomdateID", description="The unique ID of the Ezsigntemplatesignaturecustomdate") - i_ezsigntemplatesignaturecustomdate_x: conint(strict=True, ge=0) = Field(..., alias="iEzsigntemplatesignaturecustomdateX", description="The X coordinate (Horizontal) where to put the Ezsigntemplatesignaturecustomdate on the page. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsigntemplatesignaturecustomdate 2 inches from the left border of the page, you would use \"200\" for the X coordinate.") - i_ezsigntemplatesignaturecustomdate_y: conint(strict=True, ge=0) = Field(..., alias="iEzsigntemplatesignaturecustomdateY", description="The Y coordinate (Vertical) where to put the Ezsigntemplatesignaturecustomdate on the page. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsigntemplatesignaturecustomdate 3 inches from the top border of the page, you would use \"300\" for the Y coordinate.") - s_ezsigntemplatesignaturecustomdate_format: StrictStr = Field(..., alias="sEzsigntemplatesignaturecustomdateFormat", description="The custom date format to use You can use the codes below and they will be replaced at signature time. Text values like month and day names will be rendered in the proper language. Other text will be left as-is. The codes examples below are based on the following datetime: Thursday, January 6, 2022 at 08:07:09 EST For example, the format \"Signature date: {MM}/{DD}/{YYYY} {hh}:{mm}\" would become \"Signature date: 01/06/2022 08:07\" **Year** | Code | Example | | - | - | | {YYYY} | 2022 | | {YY} | 22 | **Month** | Code | Example | | - | - | | {MonthCapitalize} | Janvier | | {Month} | janvier | | {MM} | 01 | | {M} | 1 | **Day** | Code | Example | | - | - | | {DayCapitalize} | Jeudi | | {Day} | jeudi | | {DD} | 06 | | {D} | 6 | **Hour** | Code | Example | | - | - | | {hh} | 08 | **Minute** | Code | Example | | - | - | | {mm} | 07 | **Second** | Code | Example | | - | - | | {ss} | 09 | **Timezone** | Code | Example | | - | - | | {Z} | EST | **Time** | Code | Example | | - | - | | {Time} | 08:07:09 | | {TimeZ} | 08:07:09 EST | **Date** | Code | Example | | - | - | | {Date} | 2022-01-06 | | {DateText} | 1er Janvier 2022 | **Full** | Code | Example | | - | - | | {DateTime} | 2022-01-06 08:07:09 | | {DateTimeZ} | 2022-01-06 08:07:09 EST | ") - __properties = ["pkiEzsigntemplatesignaturecustomdateID", "iEzsigntemplatesignaturecustomdateX", "iEzsigntemplatesignaturecustomdateY", "sEzsigntemplatesignaturecustomdateFormat"] + An Ezsigntemplatesignaturecustomdate Object and children to create a complete structure + """ # noqa: E501 + pki_ezsigntemplatesignaturecustomdate_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsigntemplatesignaturecustomdate", alias="pkiEzsigntemplatesignaturecustomdateID") + i_ezsigntemplatesignaturecustomdate_x: Annotated[int, Field(strict=True, ge=0)] = Field(description="The X coordinate (Horizontal) where to put the Ezsigntemplatesignaturecustomdate on the page. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsigntemplatesignaturecustomdate 2 inches from the left border of the page, you would use \"200\" for the X coordinate.", alias="iEzsigntemplatesignaturecustomdateX") + i_ezsigntemplatesignaturecustomdate_y: Annotated[int, Field(strict=True, ge=0)] = Field(description="The Y coordinate (Vertical) where to put the Ezsigntemplatesignaturecustomdate on the page. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsigntemplatesignaturecustomdate 3 inches from the top border of the page, you would use \"300\" for the Y coordinate.", alias="iEzsigntemplatesignaturecustomdateY") + s_ezsigntemplatesignaturecustomdate_format: StrictStr = Field(description="The custom date format to use You can use the codes below and they will be replaced at signature time. Text values like month and day names will be rendered in the proper language. Other text will be left as-is. The codes examples below are based on the following datetime: Thursday, January 6, 2022 at 08:07:09 EST For example, the format \"Signature date: {MM}/{DD}/{YYYY} {hh}:{mm}\" would become \"Signature date: 01/06/2022 08:07\" **Year** | Code | Example | | - | - | | {YYYY} | 2022 | | {YY} | 22 | **Month** | Code | Example | | - | - | | {MonthCapitalize} | Janvier | | {Month} | janvier | | {MM} | 01 | | {M} | 1 | **Day** | Code | Example | | - | - | | {DayCapitalize} | Jeudi | | {Day} | jeudi | | {DD} | 06 | | {D} | 6 | **Hour** | Code | Example | | - | - | | {hh} | 08 | **Minute** | Code | Example | | - | - | | {mm} | 07 | **Second** | Code | Example | | - | - | | {ss} | 09 | **Timezone** | Code | Example | | - | - | | {Z} | EST | **Time** | Code | Example | | - | - | | {Time} | 08:07:09 | | {TimeZ} | 08:07:09 EST | **Date** | Code | Example | | - | - | | {Date} | 2022-01-06 | | {DateText} | 1er Janvier 2022 | **Full** | Code | Example | | - | - | | {DateTime} | 2022-01-06 08:07:09 | | {DateTimeZ} | 2022-01-06 08:07:09 EST | ", alias="sEzsigntemplatesignaturecustomdateFormat") + __properties: ClassVar[List[str]] = ["pkiEzsigntemplatesignaturecustomdateID", "iEzsigntemplatesignaturecustomdateX", "iEzsigntemplatesignaturecustomdateY", "sEzsigntemplatesignaturecustomdateFormat"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatesignaturecustomdateResponseCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatesignaturecustomdateResponseCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatesignaturecustomdateResponseCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatesignaturecustomdateResponseCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatesignaturecustomdateResponseCompound.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplatesignaturecustomdateResponseCompound.parse_obj({ - "pki_ezsigntemplatesignaturecustomdate_id": obj.get("pkiEzsigntemplatesignaturecustomdateID"), - "i_ezsigntemplatesignaturecustomdate_x": obj.get("iEzsigntemplatesignaturecustomdateX"), - "i_ezsigntemplatesignaturecustomdate_y": obj.get("iEzsigntemplatesignaturecustomdateY"), - "s_ezsigntemplatesignaturecustomdate_format": obj.get("sEzsigntemplatesignaturecustomdateFormat") + _obj = cls.model_validate({ + "pkiEzsigntemplatesignaturecustomdateID": obj.get("pkiEzsigntemplatesignaturecustomdateID"), + "iEzsigntemplatesignaturecustomdateX": obj.get("iEzsigntemplatesignaturecustomdateX"), + "iEzsigntemplatesignaturecustomdateY": obj.get("iEzsigntemplatesignaturecustomdateY"), + "sEzsigntemplatesignaturecustomdateFormat": obj.get("sEzsigntemplatesignaturecustomdateFormat") }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatesigner_create_object_v1_request.py b/eZmaxApi/models/ezsigntemplatesigner_create_object_v1_request.py index 8edcb1760..a83ac2499 100644 --- a/eZmaxApi/models/ezsigntemplatesigner_create_object_v1_request.py +++ b/eZmaxApi/models/ezsigntemplatesigner_create_object_v1_request.py @@ -19,41 +19,60 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.ezsigntemplatesigner_request_compound import EzsigntemplatesignerRequestCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatesignerCreateObjectV1Request(BaseModel): """ - Request for POST /1/object/ezsigntemplatesigner # noqa: E501 - """ - a_obj_ezsigntemplatesigner: conlist(EzsigntemplatesignerRequestCompound, min_items=1) = Field(..., alias="a_objEzsigntemplatesigner") - __properties = ["a_objEzsigntemplatesigner"] + Request for POST /1/object/ezsigntemplatesigner + """ # noqa: E501 + a_obj_ezsigntemplatesigner: Annotated[List[EzsigntemplatesignerRequestCompound], Field(min_length=1)] = Field(alias="a_objEzsigntemplatesigner") + __properties: ClassVar[List[str]] = ["a_objEzsigntemplatesigner"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatesignerCreateObjectV1Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatesignerCreateObjectV1Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_ezsigntemplatesigner (list) _items = [] if self.a_obj_ezsigntemplatesigner: @@ -64,16 +83,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatesignerCreateObjectV1Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatesignerCreateObjectV1Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatesignerCreateObjectV1Request.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplatesignerCreateObjectV1Request.parse_obj({ - "a_obj_ezsigntemplatesigner": [EzsigntemplatesignerRequestCompound.from_dict(_item) for _item in obj.get("a_objEzsigntemplatesigner")] if obj.get("a_objEzsigntemplatesigner") is not None else None + _obj = cls.model_validate({ + "a_objEzsigntemplatesigner": [EzsigntemplatesignerRequestCompound.from_dict(_item) for _item in obj.get("a_objEzsigntemplatesigner")] if obj.get("a_objEzsigntemplatesigner") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatesigner_create_object_v1_response.py b/eZmaxApi/models/ezsigntemplatesigner_create_object_v1_response.py index 8f62291ad..883a37fd0 100644 --- a/eZmaxApi/models/ezsigntemplatesigner_create_object_v1_response.py +++ b/eZmaxApi/models/ezsigntemplatesigner_create_object_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.ezsigntemplatesigner_create_object_v1_response_m_payload import EzsigntemplatesignerCreateObjectV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatesignerCreateObjectV1Response(BaseModel): """ - Response for POST /1/object/ezsigntemplatesigner # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzsigntemplatesignerCreateObjectV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for POST /1/object/ezsigntemplatesigner + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsigntemplatesignerCreateObjectV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatesignerCreateObjectV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatesignerCreateObjectV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatesignerCreateObjectV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatesignerCreateObjectV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatesignerCreateObjectV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplatesignerCreateObjectV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzsigntemplatesignerCreateObjectV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsigntemplatesignerCreateObjectV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatesigner_create_object_v1_response_m_payload.py b/eZmaxApi/models/ezsigntemplatesigner_create_object_v1_response_m_payload.py index 22668dc81..56b091ae7 100644 --- a/eZmaxApi/models/ezsigntemplatesigner_create_object_v1_response_m_payload.py +++ b/eZmaxApi/models/ezsigntemplatesigner_create_object_v1_response_m_payload.py @@ -19,57 +19,76 @@ import json -from typing import List -from pydantic import BaseModel, Field, StrictBool, conint, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictBool +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatesignerCreateObjectV1ResponseMPayload(BaseModel): """ - Payload for POST /1/object/ezsigntemplatesigner # noqa: E501 - """ - a_pki_ezsigntemplatesigner_id: conlist(conint(strict=True, ge=0)) = Field(..., alias="a_pkiEzsigntemplatesignerID", description="An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request.") - b_ezsigntemplatepackage_needvalidation: StrictBool = Field(..., alias="bEzsigntemplatepackageNeedvalidation", description="Whether the Ezsignbulksend was automatically modified and needs a manual validation") - b_ezsignbulksend_needvalidation: StrictBool = Field(..., alias="bEzsignbulksendNeedvalidation", description="Whether the Ezsigntemplatepackage was automatically modified and needs a manual validation") - __properties = ["a_pkiEzsigntemplatesignerID", "bEzsigntemplatepackageNeedvalidation", "bEzsignbulksendNeedvalidation"] + Payload for POST /1/object/ezsigntemplatesigner + """ # noqa: E501 + a_pki_ezsigntemplatesigner_id: List[Annotated[int, Field(strict=True, ge=0)]] = Field(description="An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request.", alias="a_pkiEzsigntemplatesignerID") + b_ezsigntemplatepackage_needvalidation: StrictBool = Field(description="Whether the Ezsignbulksend was automatically modified and needs a manual validation", alias="bEzsigntemplatepackageNeedvalidation") + b_ezsignbulksend_needvalidation: StrictBool = Field(description="Whether the Ezsigntemplatepackage was automatically modified and needs a manual validation", alias="bEzsignbulksendNeedvalidation") + __properties: ClassVar[List[str]] = ["a_pkiEzsigntemplatesignerID", "bEzsigntemplatepackageNeedvalidation", "bEzsignbulksendNeedvalidation"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatesignerCreateObjectV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatesignerCreateObjectV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatesignerCreateObjectV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatesignerCreateObjectV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatesignerCreateObjectV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplatesignerCreateObjectV1ResponseMPayload.parse_obj({ - "a_pki_ezsigntemplatesigner_id": obj.get("a_pkiEzsigntemplatesignerID"), - "b_ezsigntemplatepackage_needvalidation": obj.get("bEzsigntemplatepackageNeedvalidation"), - "b_ezsignbulksend_needvalidation": obj.get("bEzsignbulksendNeedvalidation") + _obj = cls.model_validate({ + "a_pkiEzsigntemplatesignerID": obj.get("a_pkiEzsigntemplatesignerID"), + "bEzsigntemplatepackageNeedvalidation": obj.get("bEzsigntemplatepackageNeedvalidation"), + "bEzsignbulksendNeedvalidation": obj.get("bEzsignbulksendNeedvalidation") }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatesigner_delete_object_v1_response.py b/eZmaxApi/models/ezsigntemplatesigner_delete_object_v1_response.py index 906c0f756..b0ba11cbe 100644 --- a/eZmaxApi/models/ezsigntemplatesigner_delete_object_v1_response.py +++ b/eZmaxApi/models/ezsigntemplatesigner_delete_object_v1_response.py @@ -19,43 +19,61 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatesignerDeleteObjectV1Response(BaseModel): """ - Response for DELETE /1/object/ezsigntemplatesigner/{pkiEzsigntemplatesignerID} # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - __properties = ["objDebugPayload", "objDebug"] + Response for DELETE /1/object/ezsigntemplatesigner/{pkiEzsigntemplatesignerID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatesignerDeleteObjectV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatesignerDeleteObjectV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -65,17 +83,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatesignerDeleteObjectV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatesignerDeleteObjectV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatesignerDeleteObjectV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplatesignerDeleteObjectV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatesigner_edit_object_v1_request.py b/eZmaxApi/models/ezsigntemplatesigner_edit_object_v1_request.py index f02088e60..71f3dfe09 100644 --- a/eZmaxApi/models/ezsigntemplatesigner_edit_object_v1_request.py +++ b/eZmaxApi/models/ezsigntemplatesigner_edit_object_v1_request.py @@ -19,57 +19,75 @@ import json - -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.ezsigntemplatesigner_request_compound import EzsigntemplatesignerRequestCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatesignerEditObjectV1Request(BaseModel): """ - Request for PUT /1/object/ezsigntemplatesigner/{pkiEzsigntemplatesignerID} # noqa: E501 - """ - obj_ezsigntemplatesigner: EzsigntemplatesignerRequestCompound = Field(..., alias="objEzsigntemplatesigner") - __properties = ["objEzsigntemplatesigner"] + Request for PUT /1/object/ezsigntemplatesigner/{pkiEzsigntemplatesignerID} + """ # noqa: E501 + obj_ezsigntemplatesigner: EzsigntemplatesignerRequestCompound = Field(alias="objEzsigntemplatesigner") + __properties: ClassVar[List[str]] = ["objEzsigntemplatesigner"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatesignerEditObjectV1Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatesignerEditObjectV1Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_ezsigntemplatesigner if self.obj_ezsigntemplatesigner: _dict['objEzsigntemplatesigner'] = self.obj_ezsigntemplatesigner.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatesignerEditObjectV1Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatesignerEditObjectV1Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatesignerEditObjectV1Request.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplatesignerEditObjectV1Request.parse_obj({ - "obj_ezsigntemplatesigner": EzsigntemplatesignerRequestCompound.from_dict(obj.get("objEzsigntemplatesigner")) if obj.get("objEzsigntemplatesigner") is not None else None + _obj = cls.model_validate({ + "objEzsigntemplatesigner": EzsigntemplatesignerRequestCompound.from_dict(obj.get("objEzsigntemplatesigner")) if obj.get("objEzsigntemplatesigner") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatesigner_edit_object_v1_response.py b/eZmaxApi/models/ezsigntemplatesigner_edit_object_v1_response.py index fda8c1966..737a93751 100644 --- a/eZmaxApi/models/ezsigntemplatesigner_edit_object_v1_response.py +++ b/eZmaxApi/models/ezsigntemplatesigner_edit_object_v1_response.py @@ -19,43 +19,61 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatesignerEditObjectV1Response(BaseModel): """ - Response for PUT /1/object/ezsigntemplatesigner/{pkiEzsigntemplatesignerID} # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - __properties = ["objDebugPayload", "objDebug"] + Response for PUT /1/object/ezsigntemplatesigner/{pkiEzsigntemplatesignerID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatesignerEditObjectV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatesignerEditObjectV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -65,17 +83,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatesignerEditObjectV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatesignerEditObjectV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatesignerEditObjectV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplatesignerEditObjectV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatesigner_get_object_v2_response.py b/eZmaxApi/models/ezsigntemplatesigner_get_object_v2_response.py index e52002215..c65a01223 100644 --- a/eZmaxApi/models/ezsigntemplatesigner_get_object_v2_response.py +++ b/eZmaxApi/models/ezsigntemplatesigner_get_object_v2_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.ezsigntemplatesigner_get_object_v2_response_m_payload import EzsigntemplatesignerGetObjectV2ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatesignerGetObjectV2Response(BaseModel): """ - Response for GET /2/object/ezsigntemplatesigner/{pkiEzsigntemplatesignerID} # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzsigntemplatesignerGetObjectV2ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /2/object/ezsigntemplatesigner/{pkiEzsigntemplatesignerID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsigntemplatesignerGetObjectV2ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatesignerGetObjectV2Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatesignerGetObjectV2Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatesignerGetObjectV2Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatesignerGetObjectV2Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatesignerGetObjectV2Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplatesignerGetObjectV2Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzsigntemplatesignerGetObjectV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsigntemplatesignerGetObjectV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatesigner_get_object_v2_response_m_payload.py b/eZmaxApi/models/ezsigntemplatesigner_get_object_v2_response_m_payload.py index a3e1c37d3..1eedb20a3 100644 --- a/eZmaxApi/models/ezsigntemplatesigner_get_object_v2_response_m_payload.py +++ b/eZmaxApi/models/ezsigntemplatesigner_get_object_v2_response_m_payload.py @@ -19,57 +19,75 @@ import json - -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.ezsigntemplatesigner_response_compound import EzsigntemplatesignerResponseCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatesignerGetObjectV2ResponseMPayload(BaseModel): """ - Payload for GET /2/object/ezsigntemplatesigner/{pkiEzsigntemplatesignerID} # noqa: E501 - """ - obj_ezsigntemplatesigner: EzsigntemplatesignerResponseCompound = Field(..., alias="objEzsigntemplatesigner") - __properties = ["objEzsigntemplatesigner"] + Payload for GET /2/object/ezsigntemplatesigner/{pkiEzsigntemplatesignerID} + """ # noqa: E501 + obj_ezsigntemplatesigner: EzsigntemplatesignerResponseCompound = Field(alias="objEzsigntemplatesigner") + __properties: ClassVar[List[str]] = ["objEzsigntemplatesigner"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatesignerGetObjectV2ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatesignerGetObjectV2ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_ezsigntemplatesigner if self.obj_ezsigntemplatesigner: _dict['objEzsigntemplatesigner'] = self.obj_ezsigntemplatesigner.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatesignerGetObjectV2ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatesignerGetObjectV2ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatesignerGetObjectV2ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplatesignerGetObjectV2ResponseMPayload.parse_obj({ - "obj_ezsigntemplatesigner": EzsigntemplatesignerResponseCompound.from_dict(obj.get("objEzsigntemplatesigner")) if obj.get("objEzsigntemplatesigner") is not None else None + _obj = cls.model_validate({ + "objEzsigntemplatesigner": EzsigntemplatesignerResponseCompound.from_dict(obj.get("objEzsigntemplatesigner")) if obj.get("objEzsigntemplatesigner") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatesigner_request.py b/eZmaxApi/models/ezsigntemplatesigner_request.py index 4d1ee25fa..de866a930 100644 --- a/eZmaxApi/models/ezsigntemplatesigner_request.py +++ b/eZmaxApi/models/ezsigntemplatesigner_request.py @@ -19,57 +19,76 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictStr, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictStr +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatesignerRequest(BaseModel): """ - A Ezsigntemplatesigner Object # noqa: E501 - """ - pki_ezsigntemplatesigner_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="pkiEzsigntemplatesignerID", description="The unique ID of the Ezsigntemplatesigner") - fki_ezsigntemplate_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsigntemplateID", description="The unique ID of the Ezsigntemplate") - s_ezsigntemplatesigner_description: StrictStr = Field(..., alias="sEzsigntemplatesignerDescription", description="The description of the Ezsigntemplatesigner") - __properties = ["pkiEzsigntemplatesignerID", "fkiEzsigntemplateID", "sEzsigntemplatesignerDescription"] + A Ezsigntemplatesigner Object + """ # noqa: E501 + pki_ezsigntemplatesigner_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsigntemplatesigner", alias="pkiEzsigntemplatesignerID") + fki_ezsigntemplate_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsigntemplate", alias="fkiEzsigntemplateID") + s_ezsigntemplatesigner_description: StrictStr = Field(description="The description of the Ezsigntemplatesigner", alias="sEzsigntemplatesignerDescription") + __properties: ClassVar[List[str]] = ["pkiEzsigntemplatesignerID", "fkiEzsigntemplateID", "sEzsigntemplatesignerDescription"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatesignerRequest: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatesignerRequest from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatesignerRequest: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatesignerRequest from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatesignerRequest.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplatesignerRequest.parse_obj({ - "pki_ezsigntemplatesigner_id": obj.get("pkiEzsigntemplatesignerID"), - "fki_ezsigntemplate_id": obj.get("fkiEzsigntemplateID"), - "s_ezsigntemplatesigner_description": obj.get("sEzsigntemplatesignerDescription") + _obj = cls.model_validate({ + "pkiEzsigntemplatesignerID": obj.get("pkiEzsigntemplatesignerID"), + "fkiEzsigntemplateID": obj.get("fkiEzsigntemplateID"), + "sEzsigntemplatesignerDescription": obj.get("sEzsigntemplatesignerDescription") }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatesigner_request_compound.py b/eZmaxApi/models/ezsigntemplatesigner_request_compound.py index 4bd22d123..885f0689c 100644 --- a/eZmaxApi/models/ezsigntemplatesigner_request_compound.py +++ b/eZmaxApi/models/ezsigntemplatesigner_request_compound.py @@ -19,57 +19,76 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictStr, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictStr +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatesignerRequestCompound(BaseModel): """ - A Ezsigntemplatesigner Object and children # noqa: E501 - """ - pki_ezsigntemplatesigner_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="pkiEzsigntemplatesignerID", description="The unique ID of the Ezsigntemplatesigner") - fki_ezsigntemplate_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsigntemplateID", description="The unique ID of the Ezsigntemplate") - s_ezsigntemplatesigner_description: StrictStr = Field(..., alias="sEzsigntemplatesignerDescription", description="The description of the Ezsigntemplatesigner") - __properties = ["pkiEzsigntemplatesignerID", "fkiEzsigntemplateID", "sEzsigntemplatesignerDescription"] + A Ezsigntemplatesigner Object and children + """ # noqa: E501 + pki_ezsigntemplatesigner_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsigntemplatesigner", alias="pkiEzsigntemplatesignerID") + fki_ezsigntemplate_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsigntemplate", alias="fkiEzsigntemplateID") + s_ezsigntemplatesigner_description: StrictStr = Field(description="The description of the Ezsigntemplatesigner", alias="sEzsigntemplatesignerDescription") + __properties: ClassVar[List[str]] = ["pkiEzsigntemplatesignerID", "fkiEzsigntemplateID", "sEzsigntemplatesignerDescription"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatesignerRequestCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatesignerRequestCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatesignerRequestCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatesignerRequestCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatesignerRequestCompound.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplatesignerRequestCompound.parse_obj({ - "pki_ezsigntemplatesigner_id": obj.get("pkiEzsigntemplatesignerID"), - "fki_ezsigntemplate_id": obj.get("fkiEzsigntemplateID"), - "s_ezsigntemplatesigner_description": obj.get("sEzsigntemplatesignerDescription") + _obj = cls.model_validate({ + "pkiEzsigntemplatesignerID": obj.get("pkiEzsigntemplatesignerID"), + "fkiEzsigntemplateID": obj.get("fkiEzsigntemplateID"), + "sEzsigntemplatesignerDescription": obj.get("sEzsigntemplatesignerDescription") }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatesigner_response.py b/eZmaxApi/models/ezsigntemplatesigner_response.py index d16124e22..f8ca14e02 100644 --- a/eZmaxApi/models/ezsigntemplatesigner_response.py +++ b/eZmaxApi/models/ezsigntemplatesigner_response.py @@ -19,57 +19,76 @@ import json - -from pydantic import BaseModel, Field, StrictStr, conint +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictStr +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatesignerResponse(BaseModel): """ - A Ezsigntemplatesigner Object # noqa: E501 - """ - pki_ezsigntemplatesigner_id: conint(strict=True, ge=0) = Field(..., alias="pkiEzsigntemplatesignerID", description="The unique ID of the Ezsigntemplatesigner") - fki_ezsigntemplate_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsigntemplateID", description="The unique ID of the Ezsigntemplate") - s_ezsigntemplatesigner_description: StrictStr = Field(..., alias="sEzsigntemplatesignerDescription", description="The description of the Ezsigntemplatesigner") - __properties = ["pkiEzsigntemplatesignerID", "fkiEzsigntemplateID", "sEzsigntemplatesignerDescription"] + A Ezsigntemplatesigner Object + """ # noqa: E501 + pki_ezsigntemplatesigner_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsigntemplatesigner", alias="pkiEzsigntemplatesignerID") + fki_ezsigntemplate_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsigntemplate", alias="fkiEzsigntemplateID") + s_ezsigntemplatesigner_description: StrictStr = Field(description="The description of the Ezsigntemplatesigner", alias="sEzsigntemplatesignerDescription") + __properties: ClassVar[List[str]] = ["pkiEzsigntemplatesignerID", "fkiEzsigntemplateID", "sEzsigntemplatesignerDescription"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatesignerResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatesignerResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatesignerResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatesignerResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatesignerResponse.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplatesignerResponse.parse_obj({ - "pki_ezsigntemplatesigner_id": obj.get("pkiEzsigntemplatesignerID"), - "fki_ezsigntemplate_id": obj.get("fkiEzsigntemplateID"), - "s_ezsigntemplatesigner_description": obj.get("sEzsigntemplatesignerDescription") + _obj = cls.model_validate({ + "pkiEzsigntemplatesignerID": obj.get("pkiEzsigntemplatesignerID"), + "fkiEzsigntemplateID": obj.get("fkiEzsigntemplateID"), + "sEzsigntemplatesignerDescription": obj.get("sEzsigntemplatesignerDescription") }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatesigner_response_compound.py b/eZmaxApi/models/ezsigntemplatesigner_response_compound.py index ba2655bc5..adee1f1e2 100644 --- a/eZmaxApi/models/ezsigntemplatesigner_response_compound.py +++ b/eZmaxApi/models/ezsigntemplatesigner_response_compound.py @@ -19,57 +19,76 @@ import json - -from pydantic import BaseModel, Field, StrictStr, conint +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictStr +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntemplatesignerResponseCompound(BaseModel): """ - A Ezsigntemplatesigner Object # noqa: E501 - """ - pki_ezsigntemplatesigner_id: conint(strict=True, ge=0) = Field(..., alias="pkiEzsigntemplatesignerID", description="The unique ID of the Ezsigntemplatesigner") - fki_ezsigntemplate_id: conint(strict=True, ge=0) = Field(..., alias="fkiEzsigntemplateID", description="The unique ID of the Ezsigntemplate") - s_ezsigntemplatesigner_description: StrictStr = Field(..., alias="sEzsigntemplatesignerDescription", description="The description of the Ezsigntemplatesigner") - __properties = ["pkiEzsigntemplatesignerID", "fkiEzsigntemplateID", "sEzsigntemplatesignerDescription"] + A Ezsigntemplatesigner Object + """ # noqa: E501 + pki_ezsigntemplatesigner_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsigntemplatesigner", alias="pkiEzsigntemplatesignerID") + fki_ezsigntemplate_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsigntemplate", alias="fkiEzsigntemplateID") + s_ezsigntemplatesigner_description: StrictStr = Field(description="The description of the Ezsigntemplatesigner", alias="sEzsigntemplatesignerDescription") + __properties: ClassVar[List[str]] = ["pkiEzsigntemplatesignerID", "fkiEzsigntemplateID", "sEzsigntemplatesignerDescription"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntemplatesignerResponseCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntemplatesignerResponseCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntemplatesignerResponseCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntemplatesignerResponseCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntemplatesignerResponseCompound.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntemplatesignerResponseCompound.parse_obj({ - "pki_ezsigntemplatesigner_id": obj.get("pkiEzsigntemplatesignerID"), - "fki_ezsigntemplate_id": obj.get("fkiEzsigntemplateID"), - "s_ezsigntemplatesigner_description": obj.get("sEzsigntemplatesignerDescription") + _obj = cls.model_validate({ + "pkiEzsigntemplatesignerID": obj.get("pkiEzsigntemplatesignerID"), + "fkiEzsigntemplateID": obj.get("fkiEzsigntemplateID"), + "sEzsigntemplatesignerDescription": obj.get("sEzsigntemplatesignerDescription") }) return _obj diff --git a/eZmaxApi/models/ezsigntsarequirement_autocomplete_element_response.py b/eZmaxApi/models/ezsigntsarequirement_autocomplete_element_response.py index a0c7a5b5d..33ce0a080 100644 --- a/eZmaxApi/models/ezsigntsarequirement_autocomplete_element_response.py +++ b/eZmaxApi/models/ezsigntsarequirement_autocomplete_element_response.py @@ -19,59 +19,78 @@ import json - -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictBool, StrictStr +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntsarequirementAutocompleteElementResponse(BaseModel): """ - A Ezsigntsarequirement AutocompleteElement Response # noqa: E501 - """ - s_ezsigntsarequirement_description_x: StrictStr = Field(..., alias="sEzsigntsarequirementDescriptionX", description="The description of the Ezsigntsarequirement in the language of the requester") - pki_ezsigntsarequirement_id: conint(strict=True, le=3, ge=1) = Field(..., alias="pkiEzsigntsarequirementID", description="The unique ID of the Ezsigntsarequirement. Determine if a Time Stamping Authority should add a timestamp on each of the signature. Valid values: |Value|Description| |-|-| |1|No. TSA Timestamping will requested. This will make all signatures a lot faster since no round-trip to the TSA server will be required. Timestamping will be made using eZsign server's time.| |2|Best effort. Timestamping from a Time Stamping Authority will be requested but is not mandatory. In the very improbable case it cannot be completed, the timestamping will be made using eZsign server's time. **Additional fee applies**| |3|Mandatory. Timestamping from a Time Stamping Authority will be requested and is mandatory. In the very improbable case it cannot be completed, the signature will fail and the user will be asked to retry. **Additional fee applies**|") - b_ezsigntsarequirement_isactive: StrictBool = Field(..., alias="bEzsigntsarequirementIsactive", description="Whether the Ezsigntsarequirement is active or not") - b_disabled: StrictBool = Field(..., alias="bDisabled", description="Indicates if the element is disabled in the context") - __properties = ["sEzsigntsarequirementDescriptionX", "pkiEzsigntsarequirementID", "bEzsigntsarequirementIsactive", "bDisabled"] + A Ezsigntsarequirement AutocompleteElement Response + """ # noqa: E501 + s_ezsigntsarequirement_description_x: StrictStr = Field(description="The description of the Ezsigntsarequirement in the language of the requester", alias="sEzsigntsarequirementDescriptionX") + pki_ezsigntsarequirement_id: Annotated[int, Field(le=3, strict=True, ge=1)] = Field(description="The unique ID of the Ezsigntsarequirement. Determine if a Time Stamping Authority should add a timestamp on each of the signature. Valid values: |Value|Description| |-|-| |1|No. TSA Timestamping will requested. This will make all signatures a lot faster since no round-trip to the TSA server will be required. Timestamping will be made using eZsign server's time.| |2|Best effort. Timestamping from a Time Stamping Authority will be requested but is not mandatory. In the very improbable case it cannot be completed, the timestamping will be made using eZsign server's time. **Additional fee applies**| |3|Mandatory. Timestamping from a Time Stamping Authority will be requested and is mandatory. In the very improbable case it cannot be completed, the signature will fail and the user will be asked to retry. **Additional fee applies**|", alias="pkiEzsigntsarequirementID") + b_ezsigntsarequirement_isactive: StrictBool = Field(description="Whether the Ezsigntsarequirement is active or not", alias="bEzsigntsarequirementIsactive") + b_disabled: StrictBool = Field(description="Indicates if the element is disabled in the context", alias="bDisabled") + __properties: ClassVar[List[str]] = ["sEzsigntsarequirementDescriptionX", "pkiEzsigntsarequirementID", "bEzsigntsarequirementIsactive", "bDisabled"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntsarequirementAutocompleteElementResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntsarequirementAutocompleteElementResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntsarequirementAutocompleteElementResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntsarequirementAutocompleteElementResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntsarequirementAutocompleteElementResponse.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntsarequirementAutocompleteElementResponse.parse_obj({ - "s_ezsigntsarequirement_description_x": obj.get("sEzsigntsarequirementDescriptionX"), - "pki_ezsigntsarequirement_id": obj.get("pkiEzsigntsarequirementID"), - "b_ezsigntsarequirement_isactive": obj.get("bEzsigntsarequirementIsactive"), - "b_disabled": obj.get("bDisabled") + _obj = cls.model_validate({ + "sEzsigntsarequirementDescriptionX": obj.get("sEzsigntsarequirementDescriptionX"), + "pkiEzsigntsarequirementID": obj.get("pkiEzsigntsarequirementID"), + "bEzsigntsarequirementIsactive": obj.get("bEzsigntsarequirementIsactive"), + "bDisabled": obj.get("bDisabled") }) return _obj diff --git a/eZmaxApi/models/ezsigntsarequirement_get_autocomplete_v2_response.py b/eZmaxApi/models/ezsigntsarequirement_get_autocomplete_v2_response.py index fd36e531f..59a7904ef 100644 --- a/eZmaxApi/models/ezsigntsarequirement_get_autocomplete_v2_response.py +++ b/eZmaxApi/models/ezsigntsarequirement_get_autocomplete_v2_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.ezsigntsarequirement_get_autocomplete_v2_response_m_payload import EzsigntsarequirementGetAutocompleteV2ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntsarequirementGetAutocompleteV2Response(BaseModel): """ - Response for GET /2/object/ezsigntsarequirement/getAutocomplete # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: EzsigntsarequirementGetAutocompleteV2ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /2/object/ezsigntsarequirement/getAutocomplete + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsigntsarequirementGetAutocompleteV2ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntsarequirementGetAutocompleteV2Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntsarequirementGetAutocompleteV2Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntsarequirementGetAutocompleteV2Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntsarequirementGetAutocompleteV2Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntsarequirementGetAutocompleteV2Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntsarequirementGetAutocompleteV2Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": EzsigntsarequirementGetAutocompleteV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": EzsigntsarequirementGetAutocompleteV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/ezsigntsarequirement_get_autocomplete_v2_response_m_payload.py b/eZmaxApi/models/ezsigntsarequirement_get_autocomplete_v2_response_m_payload.py index a8e77ed5d..ab30e367d 100644 --- a/eZmaxApi/models/ezsigntsarequirement_get_autocomplete_v2_response_m_payload.py +++ b/eZmaxApi/models/ezsigntsarequirement_get_autocomplete_v2_response_m_payload.py @@ -19,41 +19,59 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.ezsigntsarequirement_autocomplete_element_response import EzsigntsarequirementAutocompleteElementResponse +try: + from typing import Self +except ImportError: + from typing_extensions import Self class EzsigntsarequirementGetAutocompleteV2ResponseMPayload(BaseModel): """ - Payload for POST /2/object/ezsigntsarequirement/getAutocomplete # noqa: E501 - """ - a_obj_ezsigntsarequirement: conlist(EzsigntsarequirementAutocompleteElementResponse) = Field(..., alias="a_objEzsigntsarequirement", description="An array of Ezsigntsarequirement autocomplete element response.") - __properties = ["a_objEzsigntsarequirement"] + Payload for POST /2/object/ezsigntsarequirement/getAutocomplete + """ # noqa: E501 + a_obj_ezsigntsarequirement: List[EzsigntsarequirementAutocompleteElementResponse] = Field(description="An array of Ezsigntsarequirement autocomplete element response.", alias="a_objEzsigntsarequirement") + __properties: ClassVar[List[str]] = ["a_objEzsigntsarequirement"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> EzsigntsarequirementGetAutocompleteV2ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of EzsigntsarequirementGetAutocompleteV2ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_ezsigntsarequirement (list) _items = [] if self.a_obj_ezsigntsarequirement: @@ -64,16 +82,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> EzsigntsarequirementGetAutocompleteV2ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of EzsigntsarequirementGetAutocompleteV2ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return EzsigntsarequirementGetAutocompleteV2ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = EzsigntsarequirementGetAutocompleteV2ResponseMPayload.parse_obj({ - "a_obj_ezsigntsarequirement": [EzsigntsarequirementAutocompleteElementResponse.from_dict(_item) for _item in obj.get("a_objEzsigntsarequirement")] if obj.get("a_objEzsigntsarequirement") is not None else None + _obj = cls.model_validate({ + "a_objEzsigntsarequirement": [EzsigntsarequirementAutocompleteElementResponse.from_dict(_item) for _item in obj.get("a_objEzsigntsarequirement")] if obj.get("a_objEzsigntsarequirement") is not None else None }) return _obj diff --git a/eZmaxApi/models/field_e_activesession_origin.py b/eZmaxApi/models/field_e_activesession_origin.py index 1606c7e27..33383441f 100644 --- a/eZmaxApi/models/field_e_activesession_origin.py +++ b/eZmaxApi/models/field_e_activesession_origin.py @@ -13,13 +13,18 @@ """ # noqa: E501 +from __future__ import annotations import json import pprint import re # noqa: F401 -from aenum import Enum, no_arg +from enum import Enum +try: + from typing import Self +except ImportError: + from typing_extensions import Self class FieldEActivesessionOrigin(str, Enum): @@ -34,8 +39,8 @@ class FieldEActivesessionOrigin(str, Enum): EXTERNAL = 'External' @classmethod - def from_json(cls, json_str: str) -> FieldEActivesessionOrigin: + def from_json(cls, json_str: str) -> Self: """Create an instance of FieldEActivesessionOrigin from a JSON string""" - return FieldEActivesessionOrigin(json.loads(json_str)) + return cls(json.loads(json_str)) diff --git a/eZmaxApi/models/field_e_activesession_usertype.py b/eZmaxApi/models/field_e_activesession_usertype.py index e9b95bd50..f85e52911 100644 --- a/eZmaxApi/models/field_e_activesession_usertype.py +++ b/eZmaxApi/models/field_e_activesession_usertype.py @@ -13,13 +13,18 @@ """ # noqa: E501 +from __future__ import annotations import json import pprint import re # noqa: F401 -from aenum import Enum, no_arg +from enum import Enum +try: + from typing import Self +except ImportError: + from typing_extensions import Self class FieldEActivesessionUsertype(str, Enum): @@ -37,8 +42,8 @@ class FieldEActivesessionUsertype(str, Enum): NORMAL = 'Normal' @classmethod - def from_json(cls, json_str: str) -> FieldEActivesessionUsertype: + def from_json(cls, json_str: str) -> Self: """Create an instance of FieldEActivesessionUsertype from a JSON string""" - return FieldEActivesessionUsertype(json.loads(json_str)) + return cls(json.loads(json_str)) diff --git a/eZmaxApi/models/field_e_activesession_weekdaystart.py b/eZmaxApi/models/field_e_activesession_weekdaystart.py index 09ca30f95..2b3c74eed 100644 --- a/eZmaxApi/models/field_e_activesession_weekdaystart.py +++ b/eZmaxApi/models/field_e_activesession_weekdaystart.py @@ -13,13 +13,18 @@ """ # noqa: E501 +from __future__ import annotations import json import pprint import re # noqa: F401 -from aenum import Enum, no_arg +from enum import Enum +try: + from typing import Self +except ImportError: + from typing_extensions import Self class FieldEActivesessionWeekdaystart(str, Enum): @@ -39,8 +44,8 @@ class FieldEActivesessionWeekdaystart(str, Enum): SATURDAY = 'Saturday' @classmethod - def from_json(cls, json_str: str) -> FieldEActivesessionWeekdaystart: + def from_json(cls, json_str: str) -> Self: """Create an instance of FieldEActivesessionWeekdaystart from a JSON string""" - return FieldEActivesessionWeekdaystart(json.loads(json_str)) + return cls(json.loads(json_str)) diff --git a/eZmaxApi/models/field_e_attachment_documenttype.py b/eZmaxApi/models/field_e_attachment_documenttype.py new file mode 100644 index 000000000..cdcd208da --- /dev/null +++ b/eZmaxApi/models/field_e_attachment_documenttype.py @@ -0,0 +1,93 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +import pprint +import re # noqa: F401 +from enum import Enum + + + +try: + from typing import Self +except ImportError: + from typing_extensions import Self + + +class FieldEAttachmentDocumenttype(str, Enum): + """ + The documenttype of the Attachment + """ + + """ + allowed enum values + """ + ADJUSTMENT = 'Adjustment' + AGENT = 'Agent' + BANKACCOUNT = 'Bankaccount' + BROKER = 'Broker' + BUYERCONTRACT = 'Buyercontract' + COMMISSIONADVANCE = 'Commissionadvance' + COMMUNICATION = 'Communication' + CUSTOMER = 'Customer' + CUSTOMERTEMPLATE = 'Customertemplate' + DEPOSIT = 'Deposit' + DEPOSITTRANSITCHEQUE = 'Deposittransitcheque' + DISCLOSURE = 'Disclosure' + ELECTRONICFUNDSTRANSFER = 'Electronicfundstransfer' + EMPLOYEE = 'Employee' + EXTERNALBROKER = 'Externalbroker' + EZCOMADVANCESERVER = 'Ezcomadvanceserver' + EZCOMCOMPANY = 'Ezcomcompany' + EZSIGNDOCUMENT = 'Ezsigndocument' + EZSIGNDOCUMENTPROOF = 'EzsigndocumentProof' + EZSIGNDOCUMENTPROOFDOCUMENT = 'EzsigndocumentProofdocument' + EZSIGNDOCUMENTGROUP = 'Ezsigndocumentgroup' + EZSIGNDOCUMENTGROUPPROOF = 'EzsigndocumentgroupProof' + EZSIGNDOCUMENTGROUPPROOFDOCUMENT = 'EzsigndocumentgroupProofdocument' + EZSIGNDOCUMENTATTACHMENT = 'EzsigndocumentAttachment' + FOLDER = 'Folder' + FRANCHISEAGENCE = 'Franchiseagence' + FRANCHISEBROKER = 'Franchisebroker' + FRANCHISECOMPLAINT = 'Franchisecomplaint' + FRANCHISEFRANCHISE = 'Franchisefranchise' + FRANCHISEOFFICE = 'Franchiseoffice' + GHACQCONTRACT = 'Ghacqcontract' + INSCRIPTION = 'Inscription' + INSCRIPTIONNOTAUTHENTICATED = 'Inscriptionnotauthenticated' + INSCRIPTIONTEMP = 'Inscriptiontemp' + INVOICE = 'Invoice' + LEAD = 'Lead' + MARKETINGFOLLOW = 'Marketingfollow' + MARKETINGPROGRAM = 'Marketingprogram' + NOTARY = 'Notary' + OFFICETAXREPORT = 'Officetaxreport' + OTHERINCOME = 'Otherincome' + PAYMENTPREPARATION = 'Paymentpreparation' + PURCHASE = 'Purchase' + RECONCILIATION = 'Reconciliation' + REJECTEDOFFERTOPURCHASE = 'Rejectedoffertopurchase' + SALARY = 'Salary' + SUPPLIER = 'Supplier' + TEMPLATE = 'Template' + TRANQCONTRACT = 'Tranqcontract' + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of FieldEAttachmentDocumenttype from a JSON string""" + return cls(json.loads(json_str)) + + diff --git a/eZmaxApi/models/field_e_attachment_privacy.py b/eZmaxApi/models/field_e_attachment_privacy.py new file mode 100644 index 000000000..6951d43ec --- /dev/null +++ b/eZmaxApi/models/field_e_attachment_privacy.py @@ -0,0 +1,50 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +import pprint +import re # noqa: F401 +from enum import Enum + + + +try: + from typing import Self +except ImportError: + from typing_extensions import Self + + +class FieldEAttachmentPrivacy(str, Enum): + """ + The privacy of the Attachment + """ + + """ + allowed enum values + """ + ALL = 'All' + INSCRIPTOR = 'Inscriptor' + SELLER = 'Seller' + ADMINISTRATION = 'Administration' + CREATOR = 'Creator' + SPECIFICUSER = 'Specificuser' + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of FieldEAttachmentPrivacy from a JSON string""" + return cls(json.loads(json_str)) + + diff --git a/eZmaxApi/models/field_e_attachment_type.py b/eZmaxApi/models/field_e_attachment_type.py new file mode 100644 index 000000000..adc128f2e --- /dev/null +++ b/eZmaxApi/models/field_e_attachment_type.py @@ -0,0 +1,49 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +import pprint +import re # noqa: F401 +from enum import Enum + + + +try: + from typing import Self +except ImportError: + from typing_extensions import Self + + +class FieldEAttachmentType(str, Enum): + """ + The type of the Attachment + """ + + """ + allowed enum values + """ + OTHER = 'Other' + PDF = 'Pdf' + PDFGENERATED = 'PdfGenerated' + PDFSCANNED = 'PdfScanned' + EZSIGN = 'Ezsign' + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of FieldEAttachmentType from a JSON string""" + return cls(json.loads(json_str)) + + diff --git a/eZmaxApi/models/field_e_attachment_verified.py b/eZmaxApi/models/field_e_attachment_verified.py new file mode 100644 index 000000000..f597377dc --- /dev/null +++ b/eZmaxApi/models/field_e_attachment_verified.py @@ -0,0 +1,47 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +import pprint +import re # noqa: F401 +from enum import Enum + + + +try: + from typing import Self +except ImportError: + from typing_extensions import Self + + +class FieldEAttachmentVerified(str, Enum): + """ + The verified of the Attachment + """ + + """ + allowed enum values + """ + NO = 'No' + YES = 'Yes' + REJECTED = 'Rejected' + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of FieldEAttachmentVerified from a JSON string""" + return cls(json.loads(json_str)) + + diff --git a/eZmaxApi/models/field_e_attachmentlog_type.py b/eZmaxApi/models/field_e_attachmentlog_type.py new file mode 100644 index 000000000..c404a1e89 --- /dev/null +++ b/eZmaxApi/models/field_e_attachmentlog_type.py @@ -0,0 +1,73 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +import pprint +import re # noqa: F401 +from enum import Enum + + + +try: + from typing import Self +except ImportError: + from typing_extensions import Self + + +class FieldEAttachmentlogType(str, Enum): + """ + The Type for the Attachmentlog + """ + + """ + allowed enum values + """ + AUTOVALIDATION = 'AutoValidation' + COPYFROM = 'CopyFrom' + COPYTO = 'CopyTo' + COPYTOEZSIGN = 'CopyToEzsign' + CREATEBYEZSIGN = 'CreateByEzsign' + DOWNLOAD = 'Download' + DELETED = 'Deleted' + DESTROYED = 'Destroyed' + EMAIL = 'Email' + EMAILCC = 'EmailCC' + EMAILCCI = 'EmailCCI' + FAX = 'Fax' + IMPORTEDFROMEXTERNALSYSTEM = 'ImportedFromExternalSystem' + IMPORTEDFROMEZA = 'ImportedFromEZA' + IMPORTEDFROMFALTOUR = 'ImportedFromFaltour' + IMPORTEDFROMLONEWOLF = 'ImportedFromLonewolf' + IMPORTEDFROMPROSPECTS = 'ImportedFromProspects' + MOVE = 'Move' + OPENFROMEMAIL = 'OpenFromEmail' + PURGED = 'Purged' + REJECT = 'Reject' + RENAME = 'Rename' + RESTORE = 'Restore' + SCANNED = 'Scanned' + SENDTOGED = 'SendToGED' + UNVALIDATEDBY = 'UnvalidatedBy' + UPLOAD = 'Upload' + VALIDATEDBY = 'ValidatedBy' + VETINFOUPLOAD = 'VetinfoUpload' + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of FieldEAttachmentlogType from a JSON string""" + return cls(json.loads(json_str)) + + diff --git a/eZmaxApi/models/field_e_branding_logo.py b/eZmaxApi/models/field_e_branding_logo.py index ec0153bcf..c2fff90ce 100644 --- a/eZmaxApi/models/field_e_branding_logo.py +++ b/eZmaxApi/models/field_e_branding_logo.py @@ -13,13 +13,18 @@ """ # noqa: E501 +from __future__ import annotations import json import pprint import re # noqa: F401 -from aenum import Enum, no_arg +from enum import Enum +try: + from typing import Self +except ImportError: + from typing_extensions import Self class FieldEBrandingLogo(str, Enum): @@ -35,8 +40,8 @@ class FieldEBrandingLogo(str, Enum): PNG = 'PNG' @classmethod - def from_json(cls, json_str: str) -> FieldEBrandingLogo: + def from_json(cls, json_str: str) -> Self: """Create an instance of FieldEBrandingLogo from a JSON string""" - return FieldEBrandingLogo(json.loads(json_str)) + return cls(json.loads(json_str)) diff --git a/eZmaxApi/models/field_e_communication_importance.py b/eZmaxApi/models/field_e_communication_importance.py index ae97e2bb6..f76c668ea 100644 --- a/eZmaxApi/models/field_e_communication_importance.py +++ b/eZmaxApi/models/field_e_communication_importance.py @@ -13,13 +13,18 @@ """ # noqa: E501 +from __future__ import annotations import json import pprint import re # noqa: F401 -from aenum import Enum, no_arg +from enum import Enum +try: + from typing import Self +except ImportError: + from typing_extensions import Self class FieldECommunicationImportance(str, Enum): @@ -35,8 +40,8 @@ class FieldECommunicationImportance(str, Enum): LOW = 'Low' @classmethod - def from_json(cls, json_str: str) -> FieldECommunicationImportance: + def from_json(cls, json_str: str) -> Self: """Create an instance of FieldECommunicationImportance from a JSON string""" - return FieldECommunicationImportance(json.loads(json_str)) + return cls(json.loads(json_str)) diff --git a/eZmaxApi/models/field_e_communication_type.py b/eZmaxApi/models/field_e_communication_type.py index 3c2e6ec19..646e300ce 100644 --- a/eZmaxApi/models/field_e_communication_type.py +++ b/eZmaxApi/models/field_e_communication_type.py @@ -13,13 +13,18 @@ """ # noqa: E501 +from __future__ import annotations import json import pprint import re # noqa: F401 -from aenum import Enum, no_arg +from enum import Enum +try: + from typing import Self +except ImportError: + from typing_extensions import Self class FieldECommunicationType(str, Enum): @@ -35,8 +40,8 @@ class FieldECommunicationType(str, Enum): SMS = 'Sms' @classmethod - def from_json(cls, json_str: str) -> FieldECommunicationType: + def from_json(cls, json_str: str) -> Self: """Create an instance of FieldECommunicationType from a JSON string""" - return FieldECommunicationType(json.loads(json_str)) + return cls(json.loads(json_str)) diff --git a/eZmaxApi/models/field_e_communicationexternalrecipient_type.py b/eZmaxApi/models/field_e_communicationexternalrecipient_type.py index eab925c05..a61baa387 100644 --- a/eZmaxApi/models/field_e_communicationexternalrecipient_type.py +++ b/eZmaxApi/models/field_e_communicationexternalrecipient_type.py @@ -13,13 +13,18 @@ """ # noqa: E501 +from __future__ import annotations import json import pprint import re # noqa: F401 -from aenum import Enum, no_arg +from enum import Enum +try: + from typing import Self +except ImportError: + from typing_extensions import Self class FieldECommunicationexternalrecipientType(str, Enum): @@ -35,8 +40,8 @@ class FieldECommunicationexternalrecipientType(str, Enum): BCC = 'Bcc' @classmethod - def from_json(cls, json_str: str) -> FieldECommunicationexternalrecipientType: + def from_json(cls, json_str: str) -> Self: """Create an instance of FieldECommunicationexternalrecipientType from a JSON string""" - return FieldECommunicationexternalrecipientType(json.loads(json_str)) + return cls(json.loads(json_str)) diff --git a/eZmaxApi/models/field_e_communicationrecipient_type.py b/eZmaxApi/models/field_e_communicationrecipient_type.py index 7269fa98d..ea18de132 100644 --- a/eZmaxApi/models/field_e_communicationrecipient_type.py +++ b/eZmaxApi/models/field_e_communicationrecipient_type.py @@ -13,13 +13,18 @@ """ # noqa: E501 +from __future__ import annotations import json import pprint import re # noqa: F401 -from aenum import Enum, no_arg +from enum import Enum +try: + from typing import Self +except ImportError: + from typing_extensions import Self class FieldECommunicationrecipientType(str, Enum): @@ -35,8 +40,8 @@ class FieldECommunicationrecipientType(str, Enum): BCC = 'Bcc' @classmethod - def from_json(cls, json_str: str) -> FieldECommunicationrecipientType: + def from_json(cls, json_str: str) -> Self: """Create an instance of FieldECommunicationrecipientType from a JSON string""" - return FieldECommunicationrecipientType(json.loads(json_str)) + return cls(json.loads(json_str)) diff --git a/eZmaxApi/models/field_e_creditcardtype_codename.py b/eZmaxApi/models/field_e_creditcardtype_codename.py index ec1ec8b40..32624297d 100644 --- a/eZmaxApi/models/field_e_creditcardtype_codename.py +++ b/eZmaxApi/models/field_e_creditcardtype_codename.py @@ -13,13 +13,18 @@ """ # noqa: E501 +from __future__ import annotations import json import pprint import re # noqa: F401 -from aenum import Enum, no_arg +from enum import Enum +try: + from typing import Self +except ImportError: + from typing_extensions import Self class FieldECreditcardtypeCodename(str, Enum): @@ -35,8 +40,8 @@ class FieldECreditcardtypeCodename(str, Enum): VISA = 'Visa' @classmethod - def from_json(cls, json_str: str) -> FieldECreditcardtypeCodename: + def from_json(cls, json_str: str) -> Self: """Create an instance of FieldECreditcardtypeCodename from a JSON string""" - return FieldECreditcardtypeCodename(json.loads(json_str)) + return cls(json.loads(json_str)) diff --git a/eZmaxApi/models/field_e_error_code.py b/eZmaxApi/models/field_e_error_code.py index 35af7a7e7..63e1acc2d 100644 --- a/eZmaxApi/models/field_e_error_code.py +++ b/eZmaxApi/models/field_e_error_code.py @@ -13,13 +13,18 @@ """ # noqa: E501 +from __future__ import annotations import json import pprint import re # noqa: F401 -from aenum import Enum, no_arg +from enum import Enum +try: + from typing import Self +except ImportError: + from typing_extensions import Self class FieldEErrorCode(str, Enum): @@ -82,8 +87,8 @@ class FieldEErrorCode(str, Enum): ERROR_NOTIMPLEMENTED = 'ERROR_NOTIMPLEMENTED' @classmethod - def from_json(cls, json_str: str) -> FieldEErrorCode: + def from_json(cls, json_str: str) -> Self: """Create an instance of FieldEErrorCode from a JSON string""" - return FieldEErrorCode(json.loads(json_str)) + return cls(json.loads(json_str)) diff --git a/eZmaxApi/models/field_e_ezmaxinvoicing_paymenttype.py b/eZmaxApi/models/field_e_ezmaxinvoicing_paymenttype.py index 0cbcf520b..da524bbce 100644 --- a/eZmaxApi/models/field_e_ezmaxinvoicing_paymenttype.py +++ b/eZmaxApi/models/field_e_ezmaxinvoicing_paymenttype.py @@ -13,13 +13,18 @@ """ # noqa: E501 +from __future__ import annotations import json import pprint import re # noqa: F401 -from aenum import Enum, no_arg +from enum import Enum +try: + from typing import Self +except ImportError: + from typing_extensions import Self class FieldEEzmaxinvoicingPaymenttype(str, Enum): @@ -35,8 +40,8 @@ class FieldEEzmaxinvoicingPaymenttype(str, Enum): DIRECTDEBIT = 'DirectDebit' @classmethod - def from_json(cls, json_str: str) -> FieldEEzmaxinvoicingPaymenttype: + def from_json(cls, json_str: str) -> Self: """Create an instance of FieldEEzmaxinvoicingPaymenttype from a JSON string""" - return FieldEEzmaxinvoicingPaymenttype(json.loads(json_str)) + return cls(json.loads(json_str)) diff --git a/eZmaxApi/models/field_e_ezmaxinvoicingagent_variationezmax.py b/eZmaxApi/models/field_e_ezmaxinvoicingagent_variationezmax.py index bcbef20ac..974c44f69 100644 --- a/eZmaxApi/models/field_e_ezmaxinvoicingagent_variationezmax.py +++ b/eZmaxApi/models/field_e_ezmaxinvoicingagent_variationezmax.py @@ -13,13 +13,18 @@ """ # noqa: E501 +from __future__ import annotations import json import pprint import re # noqa: F401 -from aenum import Enum, no_arg +from enum import Enum +try: + from typing import Self +except ImportError: + from typing_extensions import Self class FieldEEzmaxinvoicingagentVariationezmax(str, Enum): @@ -35,8 +40,8 @@ class FieldEEzmaxinvoicingagentVariationezmax(str, Enum): SAME = 'Same' @classmethod - def from_json(cls, json_str: str) -> FieldEEzmaxinvoicingagentVariationezmax: + def from_json(cls, json_str: str) -> Self: """Create an instance of FieldEEzmaxinvoicingagentVariationezmax from a JSON string""" - return FieldEEzmaxinvoicingagentVariationezmax(json.loads(json_str)) + return cls(json.loads(json_str)) diff --git a/eZmaxApi/models/field_e_ezmaxinvoicingagent_variationezsign.py b/eZmaxApi/models/field_e_ezmaxinvoicingagent_variationezsign.py index 8b87d0e52..ddfca5e30 100644 --- a/eZmaxApi/models/field_e_ezmaxinvoicingagent_variationezsign.py +++ b/eZmaxApi/models/field_e_ezmaxinvoicingagent_variationezsign.py @@ -13,13 +13,18 @@ """ # noqa: E501 +from __future__ import annotations import json import pprint import re # noqa: F401 -from aenum import Enum, no_arg +from enum import Enum +try: + from typing import Self +except ImportError: + from typing_extensions import Self class FieldEEzmaxinvoicingagentVariationezsign(str, Enum): @@ -35,8 +40,8 @@ class FieldEEzmaxinvoicingagentVariationezsign(str, Enum): SAME = 'Same' @classmethod - def from_json(cls, json_str: str) -> FieldEEzmaxinvoicingagentVariationezsign: + def from_json(cls, json_str: str) -> Self: """Create an instance of FieldEEzmaxinvoicingagentVariationezsign from a JSON string""" - return FieldEEzmaxinvoicingagentVariationezsign(json.loads(json_str)) + return cls(json.loads(json_str)) diff --git a/eZmaxApi/models/field_e_ezmaxinvoicingcontract_paymenttype.py b/eZmaxApi/models/field_e_ezmaxinvoicingcontract_paymenttype.py index 818cc02ca..904a0a09e 100644 --- a/eZmaxApi/models/field_e_ezmaxinvoicingcontract_paymenttype.py +++ b/eZmaxApi/models/field_e_ezmaxinvoicingcontract_paymenttype.py @@ -13,13 +13,18 @@ """ # noqa: E501 +from __future__ import annotations import json import pprint import re # noqa: F401 -from aenum import Enum, no_arg +from enum import Enum +try: + from typing import Self +except ImportError: + from typing_extensions import Self class FieldEEzmaxinvoicingcontractPaymenttype(str, Enum): @@ -35,8 +40,8 @@ class FieldEEzmaxinvoicingcontractPaymenttype(str, Enum): DIRECTDEBIT = 'DirectDebit' @classmethod - def from_json(cls, json_str: str) -> FieldEEzmaxinvoicingcontractPaymenttype: + def from_json(cls, json_str: str) -> Self: """Create an instance of FieldEEzmaxinvoicingcontractPaymenttype from a JSON string""" - return FieldEEzmaxinvoicingcontractPaymenttype(json.loads(json_str)) + return cls(json.loads(json_str)) diff --git a/eZmaxApi/models/field_e_ezmaxinvoicinguser_variationezsign.py b/eZmaxApi/models/field_e_ezmaxinvoicinguser_variationezsign.py index ed0e5a9ee..cd73635ff 100644 --- a/eZmaxApi/models/field_e_ezmaxinvoicinguser_variationezsign.py +++ b/eZmaxApi/models/field_e_ezmaxinvoicinguser_variationezsign.py @@ -13,13 +13,18 @@ """ # noqa: E501 +from __future__ import annotations import json import pprint import re # noqa: F401 -from aenum import Enum, no_arg +from enum import Enum +try: + from typing import Self +except ImportError: + from typing_extensions import Self class FieldEEzmaxinvoicinguserVariationezsign(str, Enum): @@ -35,8 +40,8 @@ class FieldEEzmaxinvoicinguserVariationezsign(str, Enum): SAME = 'Same' @classmethod - def from_json(cls, json_str: str) -> FieldEEzmaxinvoicinguserVariationezsign: + def from_json(cls, json_str: str) -> Self: """Create an instance of FieldEEzmaxinvoicinguserVariationezsign from a JSON string""" - return FieldEEzmaxinvoicinguserVariationezsign(json.loads(json_str)) + return cls(json.loads(json_str)) diff --git a/eZmaxApi/models/field_e_ezsignannotation_type.py b/eZmaxApi/models/field_e_ezsignannotation_type.py index a4407ea67..6228387e8 100644 --- a/eZmaxApi/models/field_e_ezsignannotation_type.py +++ b/eZmaxApi/models/field_e_ezsignannotation_type.py @@ -13,13 +13,18 @@ """ # noqa: E501 +from __future__ import annotations import json import pprint import re # noqa: F401 -from aenum import Enum, no_arg +from enum import Enum +try: + from typing import Self +except ImportError: + from typing_extensions import Self class FieldEEzsignannotationType(str, Enum): @@ -35,8 +40,8 @@ class FieldEEzsignannotationType(str, Enum): TEXT = 'Text' @classmethod - def from_json(cls, json_str: str) -> FieldEEzsignannotationType: + def from_json(cls, json_str: str) -> Self: """Create an instance of FieldEEzsignannotationType from a JSON string""" - return FieldEEzsignannotationType(json.loads(json_str)) + return cls(json.loads(json_str)) diff --git a/eZmaxApi/models/field_e_ezsigndocument_step.py b/eZmaxApi/models/field_e_ezsigndocument_step.py index bef318770..f768c1155 100644 --- a/eZmaxApi/models/field_e_ezsigndocument_step.py +++ b/eZmaxApi/models/field_e_ezsigndocument_step.py @@ -13,13 +13,18 @@ """ # noqa: E501 +from __future__ import annotations import json import pprint import re # noqa: F401 -from aenum import Enum, no_arg +from enum import Enum +try: + from typing import Self +except ImportError: + from typing_extensions import Self class FieldEEzsigndocumentStep(str, Enum): @@ -39,8 +44,8 @@ class FieldEEzsigndocumentStep(str, Enum): DISPOSED = 'Disposed' @classmethod - def from_json(cls, json_str: str) -> FieldEEzsigndocumentStep: + def from_json(cls, json_str: str) -> Self: """Create an instance of FieldEEzsigndocumentStep from a JSON string""" - return FieldEEzsigndocumentStep(json.loads(json_str)) + return cls(json.loads(json_str)) diff --git a/eZmaxApi/models/field_e_ezsigndocumentlog_type.py b/eZmaxApi/models/field_e_ezsigndocumentlog_type.py index 3ce689b69..793997e28 100644 --- a/eZmaxApi/models/field_e_ezsigndocumentlog_type.py +++ b/eZmaxApi/models/field_e_ezsigndocumentlog_type.py @@ -13,13 +13,18 @@ """ # noqa: E501 +from __future__ import annotations import json import pprint import re # noqa: F401 -from aenum import Enum, no_arg +from enum import Enum +try: + from typing import Self +except ImportError: + from typing_extensions import Self class FieldEEzsigndocumentlogType(str, Enum): @@ -63,8 +68,8 @@ class FieldEEzsigndocumentlogType(str, Enum): REASSIGN = 'Reassign' @classmethod - def from_json(cls, json_str: str) -> FieldEEzsigndocumentlogType: + def from_json(cls, json_str: str) -> Self: """Create an instance of FieldEEzsigndocumentlogType from a JSON string""" - return FieldEEzsigndocumentlogType(json.loads(json_str)) + return cls(json.loads(json_str)) diff --git a/eZmaxApi/models/field_e_ezsignelementdependency_operator.py b/eZmaxApi/models/field_e_ezsignelementdependency_operator.py index 526e531ad..fd59fc4b8 100644 --- a/eZmaxApi/models/field_e_ezsignelementdependency_operator.py +++ b/eZmaxApi/models/field_e_ezsignelementdependency_operator.py @@ -13,13 +13,18 @@ """ # noqa: E501 +from __future__ import annotations import json import pprint import re # noqa: F401 -from aenum import Enum, no_arg +from enum import Enum +try: + from typing import Self +except ImportError: + from typing_extensions import Self class FieldEEzsignelementdependencyOperator(str, Enum): @@ -43,8 +48,8 @@ class FieldEEzsignelementdependencyOperator(str, Enum): BETWEEN = 'between' @classmethod - def from_json(cls, json_str: str) -> FieldEEzsignelementdependencyOperator: + def from_json(cls, json_str: str) -> Self: """Create an instance of FieldEEzsignelementdependencyOperator from a JSON string""" - return FieldEEzsignelementdependencyOperator(json.loads(json_str)) + return cls(json.loads(json_str)) diff --git a/eZmaxApi/models/field_e_ezsignelementdependency_validation.py b/eZmaxApi/models/field_e_ezsignelementdependency_validation.py index 6d5c251e8..ecbf3025e 100644 --- a/eZmaxApi/models/field_e_ezsignelementdependency_validation.py +++ b/eZmaxApi/models/field_e_ezsignelementdependency_validation.py @@ -13,13 +13,18 @@ """ # noqa: E501 +from __future__ import annotations import json import pprint import re # noqa: F401 -from aenum import Enum, no_arg +from enum import Enum +try: + from typing import Self +except ImportError: + from typing_extensions import Self class FieldEEzsignelementdependencyValidation(str, Enum): @@ -35,8 +40,8 @@ class FieldEEzsignelementdependencyValidation(str, Enum): FILLED = 'Filled' @classmethod - def from_json(cls, json_str: str) -> FieldEEzsignelementdependencyValidation: + def from_json(cls, json_str: str) -> Self: """Create an instance of FieldEEzsignelementdependencyValidation from a JSON string""" - return FieldEEzsignelementdependencyValidation(json.loads(json_str)) + return cls(json.loads(json_str)) diff --git a/eZmaxApi/models/field_e_ezsignfolder_sendreminderfrequency.py b/eZmaxApi/models/field_e_ezsignfolder_sendreminderfrequency.py index 74c409881..8fb37a9ff 100644 --- a/eZmaxApi/models/field_e_ezsignfolder_sendreminderfrequency.py +++ b/eZmaxApi/models/field_e_ezsignfolder_sendreminderfrequency.py @@ -13,13 +13,18 @@ """ # noqa: E501 +from __future__ import annotations import json import pprint import re # noqa: F401 -from aenum import Enum, no_arg +from enum import Enum +try: + from typing import Self +except ImportError: + from typing_extensions import Self class FieldEEzsignfolderSendreminderfrequency(str, Enum): @@ -35,8 +40,8 @@ class FieldEEzsignfolderSendreminderfrequency(str, Enum): WEEKLY = 'Weekly' @classmethod - def from_json(cls, json_str: str) -> FieldEEzsignfolderSendreminderfrequency: + def from_json(cls, json_str: str) -> Self: """Create an instance of FieldEEzsignfolderSendreminderfrequency from a JSON string""" - return FieldEEzsignfolderSendreminderfrequency(json.loads(json_str)) + return cls(json.loads(json_str)) diff --git a/eZmaxApi/models/field_e_ezsignfolder_step.py b/eZmaxApi/models/field_e_ezsignfolder_step.py index f77c9cb0f..6c7278044 100644 --- a/eZmaxApi/models/field_e_ezsignfolder_step.py +++ b/eZmaxApi/models/field_e_ezsignfolder_step.py @@ -13,13 +13,18 @@ """ # noqa: E501 +from __future__ import annotations import json import pprint import re # noqa: F401 -from aenum import Enum, no_arg +from enum import Enum +try: + from typing import Self +except ImportError: + from typing_extensions import Self class FieldEEzsignfolderStep(str, Enum): @@ -40,8 +45,8 @@ class FieldEEzsignfolderStep(str, Enum): DISPOSED = 'Disposed' @classmethod - def from_json(cls, json_str: str) -> FieldEEzsignfolderStep: + def from_json(cls, json_str: str) -> Self: """Create an instance of FieldEEzsignfolderStep from a JSON string""" - return FieldEEzsignfolderStep(json.loads(json_str)) + return cls(json.loads(json_str)) diff --git a/eZmaxApi/models/field_e_ezsignfoldertype_disposal.py b/eZmaxApi/models/field_e_ezsignfoldertype_disposal.py index 4c93a8f5a..d4da5bf2b 100644 --- a/eZmaxApi/models/field_e_ezsignfoldertype_disposal.py +++ b/eZmaxApi/models/field_e_ezsignfoldertype_disposal.py @@ -13,13 +13,18 @@ """ # noqa: E501 +from __future__ import annotations import json import pprint import re # noqa: F401 -from aenum import Enum, no_arg +from enum import Enum +try: + from typing import Self +except ImportError: + from typing_extensions import Self class FieldEEzsignfoldertypeDisposal(str, Enum): @@ -35,8 +40,8 @@ class FieldEEzsignfoldertypeDisposal(str, Enum): AUTOMATIC = 'Automatic' @classmethod - def from_json(cls, json_str: str) -> FieldEEzsignfoldertypeDisposal: + def from_json(cls, json_str: str) -> Self: """Create an instance of FieldEEzsignfoldertypeDisposal from a JSON string""" - return FieldEEzsignfoldertypeDisposal(json.loads(json_str)) + return cls(json.loads(json_str)) diff --git a/eZmaxApi/models/field_e_ezsignfoldertype_privacylevel.py b/eZmaxApi/models/field_e_ezsignfoldertype_privacylevel.py index eedb06851..0206cdf53 100644 --- a/eZmaxApi/models/field_e_ezsignfoldertype_privacylevel.py +++ b/eZmaxApi/models/field_e_ezsignfoldertype_privacylevel.py @@ -13,13 +13,18 @@ """ # noqa: E501 +from __future__ import annotations import json import pprint import re # noqa: F401 -from aenum import Enum, no_arg +from enum import Enum +try: + from typing import Self +except ImportError: + from typing_extensions import Self class FieldEEzsignfoldertypePrivacylevel(str, Enum): @@ -34,8 +39,8 @@ class FieldEEzsignfoldertypePrivacylevel(str, Enum): USERGROUP = 'Usergroup' @classmethod - def from_json(cls, json_str: str) -> FieldEEzsignfoldertypePrivacylevel: + def from_json(cls, json_str: str) -> Self: """Create an instance of FieldEEzsignfoldertypePrivacylevel from a JSON string""" - return FieldEEzsignfoldertypePrivacylevel(json.loads(json_str)) + return cls(json.loads(json_str)) diff --git a/eZmaxApi/models/field_e_ezsignfoldertype_sendreminderfrequency.py b/eZmaxApi/models/field_e_ezsignfoldertype_sendreminderfrequency.py index 727030909..6ccd56a39 100644 --- a/eZmaxApi/models/field_e_ezsignfoldertype_sendreminderfrequency.py +++ b/eZmaxApi/models/field_e_ezsignfoldertype_sendreminderfrequency.py @@ -13,13 +13,18 @@ """ # noqa: E501 +from __future__ import annotations import json import pprint import re # noqa: F401 -from aenum import Enum, no_arg +from enum import Enum +try: + from typing import Self +except ImportError: + from typing_extensions import Self class FieldEEzsignfoldertypeSendreminderfrequency(str, Enum): @@ -35,8 +40,8 @@ class FieldEEzsignfoldertypeSendreminderfrequency(str, Enum): WEEKLY = 'Weekly' @classmethod - def from_json(cls, json_str: str) -> FieldEEzsignfoldertypeSendreminderfrequency: + def from_json(cls, json_str: str) -> Self: """Create an instance of FieldEEzsignfoldertypeSendreminderfrequency from a JSON string""" - return FieldEEzsignfoldertypeSendreminderfrequency(json.loads(json_str)) + return cls(json.loads(json_str)) diff --git a/eZmaxApi/models/field_e_ezsignformfield_dependencyrequirement.py b/eZmaxApi/models/field_e_ezsignformfield_dependencyrequirement.py index c0fa61125..6c5837000 100644 --- a/eZmaxApi/models/field_e_ezsignformfield_dependencyrequirement.py +++ b/eZmaxApi/models/field_e_ezsignformfield_dependencyrequirement.py @@ -13,13 +13,18 @@ """ # noqa: E501 +from __future__ import annotations import json import pprint import re # noqa: F401 -from aenum import Enum, no_arg +from enum import Enum +try: + from typing import Self +except ImportError: + from typing_extensions import Self class FieldEEzsignformfieldDependencyrequirement(str, Enum): @@ -34,8 +39,8 @@ class FieldEEzsignformfieldDependencyrequirement(str, Enum): ANYOF = 'AnyOf' @classmethod - def from_json(cls, json_str: str) -> FieldEEzsignformfieldDependencyrequirement: + def from_json(cls, json_str: str) -> Self: """Create an instance of FieldEEzsignformfieldDependencyrequirement from a JSON string""" - return FieldEEzsignformfieldDependencyrequirement(json.loads(json_str)) + return cls(json.loads(json_str)) diff --git a/eZmaxApi/models/field_e_ezsignformfieldgroup_signerrequirement.py b/eZmaxApi/models/field_e_ezsignformfieldgroup_signerrequirement.py index c89562038..1261b8b17 100644 --- a/eZmaxApi/models/field_e_ezsignformfieldgroup_signerrequirement.py +++ b/eZmaxApi/models/field_e_ezsignformfieldgroup_signerrequirement.py @@ -13,13 +13,18 @@ """ # noqa: E501 +from __future__ import annotations import json import pprint import re # noqa: F401 -from aenum import Enum, no_arg +from enum import Enum +try: + from typing import Self +except ImportError: + from typing_extensions import Self class FieldEEzsignformfieldgroupSignerrequirement(str, Enum): @@ -34,8 +39,8 @@ class FieldEEzsignformfieldgroupSignerrequirement(str, Enum): ONE = 'One' @classmethod - def from_json(cls, json_str: str) -> FieldEEzsignformfieldgroupSignerrequirement: + def from_json(cls, json_str: str) -> Self: """Create an instance of FieldEEzsignformfieldgroupSignerrequirement from a JSON string""" - return FieldEEzsignformfieldgroupSignerrequirement(json.loads(json_str)) + return cls(json.loads(json_str)) diff --git a/eZmaxApi/models/field_e_ezsignformfieldgroup_tooltipposition.py b/eZmaxApi/models/field_e_ezsignformfieldgroup_tooltipposition.py index dd084a06a..38409813e 100644 --- a/eZmaxApi/models/field_e_ezsignformfieldgroup_tooltipposition.py +++ b/eZmaxApi/models/field_e_ezsignformfieldgroup_tooltipposition.py @@ -13,13 +13,18 @@ """ # noqa: E501 +from __future__ import annotations import json import pprint import re # noqa: F401 -from aenum import Enum, no_arg +from enum import Enum +try: + from typing import Self +except ImportError: + from typing_extensions import Self class FieldEEzsignformfieldgroupTooltipposition(str, Enum): @@ -40,8 +45,8 @@ class FieldEEzsignformfieldgroupTooltipposition(str, Enum): BOTTOMRIGHT = 'BottomRight' @classmethod - def from_json(cls, json_str: str) -> FieldEEzsignformfieldgroupTooltipposition: + def from_json(cls, json_str: str) -> Self: """Create an instance of FieldEEzsignformfieldgroupTooltipposition from a JSON string""" - return FieldEEzsignformfieldgroupTooltipposition(json.loads(json_str)) + return cls(json.loads(json_str)) diff --git a/eZmaxApi/models/field_e_ezsignformfieldgroup_type.py b/eZmaxApi/models/field_e_ezsignformfieldgroup_type.py index f2e1b3e98..15a955087 100644 --- a/eZmaxApi/models/field_e_ezsignformfieldgroup_type.py +++ b/eZmaxApi/models/field_e_ezsignformfieldgroup_type.py @@ -13,13 +13,18 @@ """ # noqa: E501 +from __future__ import annotations import json import pprint import re # noqa: F401 -from aenum import Enum, no_arg +from enum import Enum +try: + from typing import Self +except ImportError: + from typing_extensions import Self class FieldEEzsignformfieldgroupType(str, Enum): @@ -35,10 +40,12 @@ class FieldEEzsignformfieldgroupType(str, Enum): DROPDOWN = 'Dropdown' RADIO = 'Radio' CHECKBOX = 'Checkbox' + NUMBER = 'Number' + DATE = 'Date' @classmethod - def from_json(cls, json_str: str) -> FieldEEzsignformfieldgroupType: + def from_json(cls, json_str: str) -> Self: """Create an instance of FieldEEzsignformfieldgroupType from a JSON string""" - return FieldEEzsignformfieldgroupType(json.loads(json_str)) + return cls(json.loads(json_str)) diff --git a/eZmaxApi/models/field_e_ezsignsignature_attachmentnamesource.py b/eZmaxApi/models/field_e_ezsignsignature_attachmentnamesource.py index c48395288..7842af490 100644 --- a/eZmaxApi/models/field_e_ezsignsignature_attachmentnamesource.py +++ b/eZmaxApi/models/field_e_ezsignsignature_attachmentnamesource.py @@ -13,13 +13,18 @@ """ # noqa: E501 +from __future__ import annotations import json import pprint import re # noqa: F401 -from aenum import Enum, no_arg +from enum import Enum +try: + from typing import Self +except ImportError: + from typing_extensions import Self class FieldEEzsignsignatureAttachmentnamesource(str, Enum): @@ -35,8 +40,8 @@ class FieldEEzsignsignatureAttachmentnamesource(str, Enum): DESCRIPTIONCUSTOMER = 'DescriptionCustomer' @classmethod - def from_json(cls, json_str: str) -> FieldEEzsignsignatureAttachmentnamesource: + def from_json(cls, json_str: str) -> Self: """Create an instance of FieldEEzsignsignatureAttachmentnamesource from a JSON string""" - return FieldEEzsignsignatureAttachmentnamesource(json.loads(json_str)) + return cls(json.loads(json_str)) diff --git a/eZmaxApi/models/field_e_ezsignsignature_dependencyrequirement.py b/eZmaxApi/models/field_e_ezsignsignature_dependencyrequirement.py index df680239e..29c317a8a 100644 --- a/eZmaxApi/models/field_e_ezsignsignature_dependencyrequirement.py +++ b/eZmaxApi/models/field_e_ezsignsignature_dependencyrequirement.py @@ -13,13 +13,18 @@ """ # noqa: E501 +from __future__ import annotations import json import pprint import re # noqa: F401 -from aenum import Enum, no_arg +from enum import Enum +try: + from typing import Self +except ImportError: + from typing_extensions import Self class FieldEEzsignsignatureDependencyrequirement(str, Enum): @@ -34,8 +39,8 @@ class FieldEEzsignsignatureDependencyrequirement(str, Enum): ANYOF = 'AnyOf' @classmethod - def from_json(cls, json_str: str) -> FieldEEzsignsignatureDependencyrequirement: + def from_json(cls, json_str: str) -> Self: """Create an instance of FieldEEzsignsignatureDependencyrequirement from a JSON string""" - return FieldEEzsignsignatureDependencyrequirement(json.loads(json_str)) + return cls(json.loads(json_str)) diff --git a/eZmaxApi/models/field_e_ezsignsignature_font.py b/eZmaxApi/models/field_e_ezsignsignature_font.py index fc3c2d04f..505928a25 100644 --- a/eZmaxApi/models/field_e_ezsignsignature_font.py +++ b/eZmaxApi/models/field_e_ezsignsignature_font.py @@ -13,13 +13,18 @@ """ # noqa: E501 +from __future__ import annotations import json import pprint import re # noqa: F401 -from aenum import Enum, no_arg +from enum import Enum +try: + from typing import Self +except ImportError: + from typing_extensions import Self class FieldEEzsignsignatureFont(str, Enum): @@ -34,8 +39,8 @@ class FieldEEzsignsignatureFont(str, Enum): CURSIVE = 'Cursive' @classmethod - def from_json(cls, json_str: str) -> FieldEEzsignsignatureFont: + def from_json(cls, json_str: str) -> Self: """Create an instance of FieldEEzsignsignatureFont from a JSON string""" - return FieldEEzsignsignatureFont(json.loads(json_str)) + return cls(json.loads(json_str)) diff --git a/eZmaxApi/models/field_e_ezsignsignature_tooltipposition.py b/eZmaxApi/models/field_e_ezsignsignature_tooltipposition.py index 8a660df8b..9137039e8 100644 --- a/eZmaxApi/models/field_e_ezsignsignature_tooltipposition.py +++ b/eZmaxApi/models/field_e_ezsignsignature_tooltipposition.py @@ -13,13 +13,18 @@ """ # noqa: E501 +from __future__ import annotations import json import pprint import re # noqa: F401 -from aenum import Enum, no_arg +from enum import Enum +try: + from typing import Self +except ImportError: + from typing_extensions import Self class FieldEEzsignsignatureTooltipposition(str, Enum): @@ -40,8 +45,8 @@ class FieldEEzsignsignatureTooltipposition(str, Enum): BOTTOMRIGHT = 'BottomRight' @classmethod - def from_json(cls, json_str: str) -> FieldEEzsignsignatureTooltipposition: + def from_json(cls, json_str: str) -> Self: """Create an instance of FieldEEzsignsignatureTooltipposition from a JSON string""" - return FieldEEzsignsignatureTooltipposition(json.loads(json_str)) + return cls(json.loads(json_str)) diff --git a/eZmaxApi/models/field_e_ezsignsignature_type.py b/eZmaxApi/models/field_e_ezsignsignature_type.py index 8367ebae9..7c74239bd 100644 --- a/eZmaxApi/models/field_e_ezsignsignature_type.py +++ b/eZmaxApi/models/field_e_ezsignsignature_type.py @@ -13,18 +13,23 @@ """ # noqa: E501 +from __future__ import annotations import json import pprint import re # noqa: F401 -from aenum import Enum, no_arg +from enum import Enum +try: + from typing import Self +except ImportError: + from typing_extensions import Self class FieldEEzsignsignatureType(str, Enum): """ - The type of signature. 1. **Acknowledgement** is for an acknowledgment of receipt. 2. **City** is to request the city where the document is signed. 3. **Handwritten** is for a handwritten kind of signature where users needs to \"draw\" their signature on screen. 4. **Initials** is a simple \"click to add initials\" block. 5. **Name** is a simple \"Click to sign\" block. This is the most common block of signature. 6. **Attachments** is to ask for files as attachment that may be validate in another step. 7. **FieldText** is to ask for a short text. 8. **Fieldtextarea** is to ask for a text + The type of signature. 1. **Acknowledgement** is for an acknowledgment of receipt. 2. **City** is to request the city where the document is signed. 3. **Handwritten** is for a handwritten kind of signature where users needs to \"draw\" their signature on screen. 4. **Initials** is a simple \"click to add initials\" block. 5. **Name** is a simple \"Click to sign\" block. This is the most common block of signature. 6. **NameReason** is to ask for a signing reason. 7. **Attachments** is to ask for files as attachment that may be validate in another step. 8. **FieldText** is to ask for a short text. 9. **Fieldtextarea** is to ask for a text """ """ @@ -35,14 +40,15 @@ class FieldEEzsignsignatureType(str, Enum): HANDWRITTEN = 'Handwritten' INITIALS = 'Initials' NAME = 'Name' + NAMEREASON = 'NameReason' ATTACHMENTS = 'Attachments' ATTACHMENTSCONFIRMATION = 'AttachmentsConfirmation' FIELDTEXT = 'FieldText' FIELDTEXTAREA = 'FieldTextarea' @classmethod - def from_json(cls, json_str: str) -> FieldEEzsignsignatureType: + def from_json(cls, json_str: str) -> Self: """Create an instance of FieldEEzsignsignatureType from a JSON string""" - return FieldEEzsignsignatureType(json.loads(json_str)) + return cls(json.loads(json_str)) diff --git a/eZmaxApi/models/field_e_ezsigntemplateelementdependency_operator.py b/eZmaxApi/models/field_e_ezsigntemplateelementdependency_operator.py index a0531b8a6..7fd89c83a 100644 --- a/eZmaxApi/models/field_e_ezsigntemplateelementdependency_operator.py +++ b/eZmaxApi/models/field_e_ezsigntemplateelementdependency_operator.py @@ -13,13 +13,18 @@ """ # noqa: E501 +from __future__ import annotations import json import pprint import re # noqa: F401 -from aenum import Enum, no_arg +from enum import Enum +try: + from typing import Self +except ImportError: + from typing_extensions import Self class FieldEEzsigntemplateelementdependencyOperator(str, Enum): @@ -43,8 +48,8 @@ class FieldEEzsigntemplateelementdependencyOperator(str, Enum): BETWEEN = 'between' @classmethod - def from_json(cls, json_str: str) -> FieldEEzsigntemplateelementdependencyOperator: + def from_json(cls, json_str: str) -> Self: """Create an instance of FieldEEzsigntemplateelementdependencyOperator from a JSON string""" - return FieldEEzsigntemplateelementdependencyOperator(json.loads(json_str)) + return cls(json.loads(json_str)) diff --git a/eZmaxApi/models/field_e_ezsigntemplateelementdependency_validation.py b/eZmaxApi/models/field_e_ezsigntemplateelementdependency_validation.py index fc78017f9..4a7e48133 100644 --- a/eZmaxApi/models/field_e_ezsigntemplateelementdependency_validation.py +++ b/eZmaxApi/models/field_e_ezsigntemplateelementdependency_validation.py @@ -13,13 +13,18 @@ """ # noqa: E501 +from __future__ import annotations import json import pprint import re # noqa: F401 -from aenum import Enum, no_arg +from enum import Enum +try: + from typing import Self +except ImportError: + from typing_extensions import Self class FieldEEzsigntemplateelementdependencyValidation(str, Enum): @@ -35,8 +40,8 @@ class FieldEEzsigntemplateelementdependencyValidation(str, Enum): FILLED = 'Filled' @classmethod - def from_json(cls, json_str: str) -> FieldEEzsigntemplateelementdependencyValidation: + def from_json(cls, json_str: str) -> Self: """Create an instance of FieldEEzsigntemplateelementdependencyValidation from a JSON string""" - return FieldEEzsigntemplateelementdependencyValidation(json.loads(json_str)) + return cls(json.loads(json_str)) diff --git a/eZmaxApi/models/field_e_ezsigntemplateformfield_dependencyrequirement.py b/eZmaxApi/models/field_e_ezsigntemplateformfield_dependencyrequirement.py index 44dc259b7..cf59fbd54 100644 --- a/eZmaxApi/models/field_e_ezsigntemplateformfield_dependencyrequirement.py +++ b/eZmaxApi/models/field_e_ezsigntemplateformfield_dependencyrequirement.py @@ -13,13 +13,18 @@ """ # noqa: E501 +from __future__ import annotations import json import pprint import re # noqa: F401 -from aenum import Enum, no_arg +from enum import Enum +try: + from typing import Self +except ImportError: + from typing_extensions import Self class FieldEEzsigntemplateformfieldDependencyrequirement(str, Enum): @@ -34,8 +39,8 @@ class FieldEEzsigntemplateformfieldDependencyrequirement(str, Enum): ANYOF = 'AnyOf' @classmethod - def from_json(cls, json_str: str) -> FieldEEzsigntemplateformfieldDependencyrequirement: + def from_json(cls, json_str: str) -> Self: """Create an instance of FieldEEzsigntemplateformfieldDependencyrequirement from a JSON string""" - return FieldEEzsigntemplateformfieldDependencyrequirement(json.loads(json_str)) + return cls(json.loads(json_str)) diff --git a/eZmaxApi/models/field_e_ezsigntemplateformfieldgroup_signerrequirement.py b/eZmaxApi/models/field_e_ezsigntemplateformfieldgroup_signerrequirement.py index 4642c00ed..bd14c2ce0 100644 --- a/eZmaxApi/models/field_e_ezsigntemplateformfieldgroup_signerrequirement.py +++ b/eZmaxApi/models/field_e_ezsigntemplateformfieldgroup_signerrequirement.py @@ -13,13 +13,18 @@ """ # noqa: E501 +from __future__ import annotations import json import pprint import re # noqa: F401 -from aenum import Enum, no_arg +from enum import Enum +try: + from typing import Self +except ImportError: + from typing_extensions import Self class FieldEEzsigntemplateformfieldgroupSignerrequirement(str, Enum): @@ -34,8 +39,8 @@ class FieldEEzsigntemplateformfieldgroupSignerrequirement(str, Enum): ONE = 'One' @classmethod - def from_json(cls, json_str: str) -> FieldEEzsigntemplateformfieldgroupSignerrequirement: + def from_json(cls, json_str: str) -> Self: """Create an instance of FieldEEzsigntemplateformfieldgroupSignerrequirement from a JSON string""" - return FieldEEzsigntemplateformfieldgroupSignerrequirement(json.loads(json_str)) + return cls(json.loads(json_str)) diff --git a/eZmaxApi/models/field_e_ezsigntemplateformfieldgroup_tooltipposition.py b/eZmaxApi/models/field_e_ezsigntemplateformfieldgroup_tooltipposition.py index 5310c41b1..4e387dae7 100644 --- a/eZmaxApi/models/field_e_ezsigntemplateformfieldgroup_tooltipposition.py +++ b/eZmaxApi/models/field_e_ezsigntemplateformfieldgroup_tooltipposition.py @@ -13,13 +13,18 @@ """ # noqa: E501 +from __future__ import annotations import json import pprint import re # noqa: F401 -from aenum import Enum, no_arg +from enum import Enum +try: + from typing import Self +except ImportError: + from typing_extensions import Self class FieldEEzsigntemplateformfieldgroupTooltipposition(str, Enum): @@ -40,8 +45,8 @@ class FieldEEzsigntemplateformfieldgroupTooltipposition(str, Enum): BOTTOMRIGHT = 'BottomRight' @classmethod - def from_json(cls, json_str: str) -> FieldEEzsigntemplateformfieldgroupTooltipposition: + def from_json(cls, json_str: str) -> Self: """Create an instance of FieldEEzsigntemplateformfieldgroupTooltipposition from a JSON string""" - return FieldEEzsigntemplateformfieldgroupTooltipposition(json.loads(json_str)) + return cls(json.loads(json_str)) diff --git a/eZmaxApi/models/field_e_ezsigntemplateformfieldgroup_type.py b/eZmaxApi/models/field_e_ezsigntemplateformfieldgroup_type.py index 0c2477890..ec510a13e 100644 --- a/eZmaxApi/models/field_e_ezsigntemplateformfieldgroup_type.py +++ b/eZmaxApi/models/field_e_ezsigntemplateformfieldgroup_type.py @@ -13,13 +13,18 @@ """ # noqa: E501 +from __future__ import annotations import json import pprint import re # noqa: F401 -from aenum import Enum, no_arg +from enum import Enum +try: + from typing import Self +except ImportError: + from typing_extensions import Self class FieldEEzsigntemplateformfieldgroupType(str, Enum): @@ -35,10 +40,12 @@ class FieldEEzsigntemplateformfieldgroupType(str, Enum): DROPDOWN = 'Dropdown' RADIO = 'Radio' CHECKBOX = 'Checkbox' + NUMBER = 'Number' + DATE = 'Date' @classmethod - def from_json(cls, json_str: str) -> FieldEEzsigntemplateformfieldgroupType: + def from_json(cls, json_str: str) -> Self: """Create an instance of FieldEEzsigntemplateformfieldgroupType from a JSON string""" - return FieldEEzsigntemplateformfieldgroupType(json.loads(json_str)) + return cls(json.loads(json_str)) diff --git a/eZmaxApi/models/field_e_ezsigntemplatesignature_attachmentnamesource.py b/eZmaxApi/models/field_e_ezsigntemplatesignature_attachmentnamesource.py index 247903df0..1a37bdf0c 100644 --- a/eZmaxApi/models/field_e_ezsigntemplatesignature_attachmentnamesource.py +++ b/eZmaxApi/models/field_e_ezsigntemplatesignature_attachmentnamesource.py @@ -13,13 +13,18 @@ """ # noqa: E501 +from __future__ import annotations import json import pprint import re # noqa: F401 -from aenum import Enum, no_arg +from enum import Enum +try: + from typing import Self +except ImportError: + from typing_extensions import Self class FieldEEzsigntemplatesignatureAttachmentnamesource(str, Enum): @@ -35,8 +40,8 @@ class FieldEEzsigntemplatesignatureAttachmentnamesource(str, Enum): DESCRIPTIONCUSTOMER = 'DescriptionCustomer' @classmethod - def from_json(cls, json_str: str) -> FieldEEzsigntemplatesignatureAttachmentnamesource: + def from_json(cls, json_str: str) -> Self: """Create an instance of FieldEEzsigntemplatesignatureAttachmentnamesource from a JSON string""" - return FieldEEzsigntemplatesignatureAttachmentnamesource(json.loads(json_str)) + return cls(json.loads(json_str)) diff --git a/eZmaxApi/models/field_e_ezsigntemplatesignature_dependencyrequirement.py b/eZmaxApi/models/field_e_ezsigntemplatesignature_dependencyrequirement.py index bdfe6269e..dabfa0382 100644 --- a/eZmaxApi/models/field_e_ezsigntemplatesignature_dependencyrequirement.py +++ b/eZmaxApi/models/field_e_ezsigntemplatesignature_dependencyrequirement.py @@ -13,13 +13,18 @@ """ # noqa: E501 +from __future__ import annotations import json import pprint import re # noqa: F401 -from aenum import Enum, no_arg +from enum import Enum +try: + from typing import Self +except ImportError: + from typing_extensions import Self class FieldEEzsigntemplatesignatureDependencyrequirement(str, Enum): @@ -34,8 +39,8 @@ class FieldEEzsigntemplatesignatureDependencyrequirement(str, Enum): ANYOF = 'AnyOf' @classmethod - def from_json(cls, json_str: str) -> FieldEEzsigntemplatesignatureDependencyrequirement: + def from_json(cls, json_str: str) -> Self: """Create an instance of FieldEEzsigntemplatesignatureDependencyrequirement from a JSON string""" - return FieldEEzsigntemplatesignatureDependencyrequirement(json.loads(json_str)) + return cls(json.loads(json_str)) diff --git a/eZmaxApi/models/field_e_ezsigntemplatesignature_font.py b/eZmaxApi/models/field_e_ezsigntemplatesignature_font.py index 94e00e5f7..4207f1bc6 100644 --- a/eZmaxApi/models/field_e_ezsigntemplatesignature_font.py +++ b/eZmaxApi/models/field_e_ezsigntemplatesignature_font.py @@ -13,13 +13,18 @@ """ # noqa: E501 +from __future__ import annotations import json import pprint import re # noqa: F401 -from aenum import Enum, no_arg +from enum import Enum +try: + from typing import Self +except ImportError: + from typing_extensions import Self class FieldEEzsigntemplatesignatureFont(str, Enum): @@ -34,8 +39,8 @@ class FieldEEzsigntemplatesignatureFont(str, Enum): CURSIVE = 'Cursive' @classmethod - def from_json(cls, json_str: str) -> FieldEEzsigntemplatesignatureFont: + def from_json(cls, json_str: str) -> Self: """Create an instance of FieldEEzsigntemplatesignatureFont from a JSON string""" - return FieldEEzsigntemplatesignatureFont(json.loads(json_str)) + return cls(json.loads(json_str)) diff --git a/eZmaxApi/models/field_e_ezsigntemplatesignature_tooltipposition.py b/eZmaxApi/models/field_e_ezsigntemplatesignature_tooltipposition.py index ee92fe4f8..68ea7a638 100644 --- a/eZmaxApi/models/field_e_ezsigntemplatesignature_tooltipposition.py +++ b/eZmaxApi/models/field_e_ezsigntemplatesignature_tooltipposition.py @@ -13,13 +13,18 @@ """ # noqa: E501 +from __future__ import annotations import json import pprint import re # noqa: F401 -from aenum import Enum, no_arg +from enum import Enum +try: + from typing import Self +except ImportError: + from typing_extensions import Self class FieldEEzsigntemplatesignatureTooltipposition(str, Enum): @@ -40,8 +45,8 @@ class FieldEEzsigntemplatesignatureTooltipposition(str, Enum): BOTTOMRIGHT = 'BottomRight' @classmethod - def from_json(cls, json_str: str) -> FieldEEzsigntemplatesignatureTooltipposition: + def from_json(cls, json_str: str) -> Self: """Create an instance of FieldEEzsigntemplatesignatureTooltipposition from a JSON string""" - return FieldEEzsigntemplatesignatureTooltipposition(json.loads(json_str)) + return cls(json.loads(json_str)) diff --git a/eZmaxApi/models/field_e_ezsigntemplatesignature_type.py b/eZmaxApi/models/field_e_ezsigntemplatesignature_type.py index 4d4ca0ca6..35bf6fe26 100644 --- a/eZmaxApi/models/field_e_ezsigntemplatesignature_type.py +++ b/eZmaxApi/models/field_e_ezsigntemplatesignature_type.py @@ -13,18 +13,23 @@ """ # noqa: E501 +from __future__ import annotations import json import pprint import re # noqa: F401 -from aenum import Enum, no_arg +from enum import Enum +try: + from typing import Self +except ImportError: + from typing_extensions import Self class FieldEEzsigntemplatesignatureType(str, Enum): """ - The type of signature. 1. **Acknowledgement** is for an acknowledgment of receipt. 2. **City** is to request the city where the document is signed. 3. **Handwritten** is for a handwritten kind of signature where users needs to \"draw\" their signature on screen. 4. **Initials** is a simple \"click to add initials\" block. 5. **Name** is a simple \"Click to sign\" block. This is the most common block of signature. 6. **Attachments** is to ask for files as attachment that may be validate in another step. + The type of signature. 1. **Acknowledgement** is for an acknowledgment of receipt. 2. **City** is to request the city where the document is signed. 3. **Handwritten** is for a handwritten kind of signature where users needs to \"draw\" their signature on screen. 4. **Initials** is a simple \"click to add initials\" block. 5. **Name** is a simple \"Click to sign\" block. This is the most common block of signature. 6. **NameReason** is to ask for a signing reason. 7. **Attachments** is to ask for files as attachment that may be validate in another step. """ """ @@ -35,13 +40,14 @@ class FieldEEzsigntemplatesignatureType(str, Enum): HANDWRITTEN = 'Handwritten' INITIALS = 'Initials' NAME = 'Name' + NAMEREASON = 'NameReason' ATTACHMENTS = 'Attachments' FIELDTEXT = 'FieldText' FIELDTEXTAREA = 'FieldTextarea' @classmethod - def from_json(cls, json_str: str) -> FieldEEzsigntemplatesignatureType: + def from_json(cls, json_str: str) -> Self: """Create an instance of FieldEEzsigntemplatesignatureType from a JSON string""" - return FieldEEzsigntemplatesignatureType(json.loads(json_str)) + return cls(json.loads(json_str)) diff --git a/eZmaxApi/models/field_e_notificationpreference_status.py b/eZmaxApi/models/field_e_notificationpreference_status.py index 60b7fa4fd..9036164b0 100644 --- a/eZmaxApi/models/field_e_notificationpreference_status.py +++ b/eZmaxApi/models/field_e_notificationpreference_status.py @@ -13,13 +13,18 @@ """ # noqa: E501 +from __future__ import annotations import json import pprint import re # noqa: F401 -from aenum import Enum, no_arg +from enum import Enum +try: + from typing import Self +except ImportError: + from typing_extensions import Self class FieldENotificationpreferenceStatus(str, Enum): @@ -35,8 +40,8 @@ class FieldENotificationpreferenceStatus(str, Enum): PIN = 'Pin' @classmethod - def from_json(cls, json_str: str) -> FieldENotificationpreferenceStatus: + def from_json(cls, json_str: str) -> Self: """Create an instance of FieldENotificationpreferenceStatus from a JSON string""" - return FieldENotificationpreferenceStatus(json.loads(json_str)) + return cls(json.loads(json_str)) diff --git a/eZmaxApi/models/field_e_paymentterm_type.py b/eZmaxApi/models/field_e_paymentterm_type.py index 94723fb54..cc7e325fd 100644 --- a/eZmaxApi/models/field_e_paymentterm_type.py +++ b/eZmaxApi/models/field_e_paymentterm_type.py @@ -13,13 +13,18 @@ """ # noqa: E501 +from __future__ import annotations import json import pprint import re # noqa: F401 -from aenum import Enum, no_arg +from enum import Enum +try: + from typing import Self +except ImportError: + from typing_extensions import Self class FieldEPaymenttermType(str, Enum): @@ -34,8 +39,8 @@ class FieldEPaymenttermType(str, Enum): DAYOFTHEMONTH = 'Dayofthemonth' @classmethod - def from_json(cls, json_str: str) -> FieldEPaymenttermType: + def from_json(cls, json_str: str) -> Self: """Create an instance of FieldEPaymenttermType from a JSON string""" - return FieldEPaymenttermType(json.loads(json_str)) + return cls(json.loads(json_str)) diff --git a/eZmaxApi/models/field_e_phone_type.py b/eZmaxApi/models/field_e_phone_type.py index 3313e570d..17638f1da 100644 --- a/eZmaxApi/models/field_e_phone_type.py +++ b/eZmaxApi/models/field_e_phone_type.py @@ -13,13 +13,18 @@ """ # noqa: E501 +from __future__ import annotations import json import pprint import re # noqa: F401 -from aenum import Enum, no_arg +from enum import Enum +try: + from typing import Self +except ImportError: + from typing_extensions import Self class FieldEPhoneType(str, Enum): @@ -34,8 +39,8 @@ class FieldEPhoneType(str, Enum): INTERNATIONAL = 'International' @classmethod - def from_json(cls, json_str: str) -> FieldEPhoneType: + def from_json(cls, json_str: str) -> Self: """Create an instance of FieldEPhoneType from a JSON string""" - return FieldEPhoneType(json.loads(json_str)) + return cls(json.loads(json_str)) diff --git a/eZmaxApi/models/field_e_sessionhistory_endby.py b/eZmaxApi/models/field_e_sessionhistory_endby.py index fb5322d24..c366a399c 100644 --- a/eZmaxApi/models/field_e_sessionhistory_endby.py +++ b/eZmaxApi/models/field_e_sessionhistory_endby.py @@ -13,13 +13,18 @@ """ # noqa: E501 +from __future__ import annotations import json import pprint import re # noqa: F401 -from aenum import Enum, no_arg +from enum import Enum +try: + from typing import Self +except ImportError: + from typing_extensions import Self class FieldESessionhistoryEndby(str, Enum): @@ -46,8 +51,8 @@ class FieldESessionhistoryEndby(str, Enum): FORCEDLOGOFF = 'ForcedLogoff' @classmethod - def from_json(cls, json_str: str) -> FieldESessionhistoryEndby: + def from_json(cls, json_str: str) -> Self: """Create an instance of FieldESessionhistoryEndby from a JSON string""" - return FieldESessionhistoryEndby(json.loads(json_str)) + return cls(json.loads(json_str)) diff --git a/eZmaxApi/models/field_e_systemconfiguration_ezsign.py b/eZmaxApi/models/field_e_systemconfiguration_ezsign.py index aa680c684..aa346b984 100644 --- a/eZmaxApi/models/field_e_systemconfiguration_ezsign.py +++ b/eZmaxApi/models/field_e_systemconfiguration_ezsign.py @@ -13,13 +13,18 @@ """ # noqa: E501 +from __future__ import annotations import json import pprint import re # noqa: F401 -from aenum import Enum, no_arg +from enum import Enum +try: + from typing import Self +except ImportError: + from typing_extensions import Self class FieldESystemconfigurationEzsign(str, Enum): @@ -34,8 +39,8 @@ class FieldESystemconfigurationEzsign(str, Enum): YES = 'Yes' @classmethod - def from_json(cls, json_str: str) -> FieldESystemconfigurationEzsign: + def from_json(cls, json_str: str) -> Self: """Create an instance of FieldESystemconfigurationEzsign from a JSON string""" - return FieldESystemconfigurationEzsign(json.loads(json_str)) + return cls(json.loads(json_str)) diff --git a/eZmaxApi/models/field_e_systemconfiguration_language1.py b/eZmaxApi/models/field_e_systemconfiguration_language1.py index 41e64cd0a..0ddd571ac 100644 --- a/eZmaxApi/models/field_e_systemconfiguration_language1.py +++ b/eZmaxApi/models/field_e_systemconfiguration_language1.py @@ -13,13 +13,18 @@ """ # noqa: E501 +from __future__ import annotations import json import pprint import re # noqa: F401 -from aenum import Enum, no_arg +from enum import Enum +try: + from typing import Self +except ImportError: + from typing_extensions import Self class FieldESystemconfigurationLanguage1(str, Enum): @@ -33,8 +38,8 @@ class FieldESystemconfigurationLanguage1(str, Enum): FR_QC = 'fr_QC' @classmethod - def from_json(cls, json_str: str) -> FieldESystemconfigurationLanguage1: + def from_json(cls, json_str: str) -> Self: """Create an instance of FieldESystemconfigurationLanguage1 from a JSON string""" - return FieldESystemconfigurationLanguage1(json.loads(json_str)) + return cls(json.loads(json_str)) diff --git a/eZmaxApi/models/field_e_systemconfiguration_language2.py b/eZmaxApi/models/field_e_systemconfiguration_language2.py index bf9ed56a1..5204cc40f 100644 --- a/eZmaxApi/models/field_e_systemconfiguration_language2.py +++ b/eZmaxApi/models/field_e_systemconfiguration_language2.py @@ -13,13 +13,18 @@ """ # noqa: E501 +from __future__ import annotations import json import pprint import re # noqa: F401 -from aenum import Enum, no_arg +from enum import Enum +try: + from typing import Self +except ImportError: + from typing_extensions import Self class FieldESystemconfigurationLanguage2(str, Enum): @@ -35,8 +40,8 @@ class FieldESystemconfigurationLanguage2(str, Enum): EN_US = 'en_US' @classmethod - def from_json(cls, json_str: str) -> FieldESystemconfigurationLanguage2: + def from_json(cls, json_str: str) -> Self: """Create an instance of FieldESystemconfigurationLanguage2 from a JSON string""" - return FieldESystemconfigurationLanguage2(json.loads(json_str)) + return cls(json.loads(json_str)) diff --git a/eZmaxApi/models/field_e_systemconfiguration_newexternaluseraction.py b/eZmaxApi/models/field_e_systemconfiguration_newexternaluseraction.py index ff550912a..d51a29821 100644 --- a/eZmaxApi/models/field_e_systemconfiguration_newexternaluseraction.py +++ b/eZmaxApi/models/field_e_systemconfiguration_newexternaluseraction.py @@ -13,13 +13,18 @@ """ # noqa: E501 +from __future__ import annotations import json import pprint import re # noqa: F401 -from aenum import Enum, no_arg +from enum import Enum +try: + from typing import Self +except ImportError: + from typing_extensions import Self class FieldESystemconfigurationNewexternaluseraction(str, Enum): @@ -34,8 +39,8 @@ class FieldESystemconfigurationNewexternaluseraction(str, Enum): AUTOCREATE = 'AutoCreate' @classmethod - def from_json(cls, json_str: str) -> FieldESystemconfigurationNewexternaluseraction: + def from_json(cls, json_str: str) -> Self: """Create an instance of FieldESystemconfigurationNewexternaluseraction from a JSON string""" - return FieldESystemconfigurationNewexternaluseraction(json.loads(json_str)) + return cls(json.loads(json_str)) diff --git a/eZmaxApi/models/field_e_user_ezsignaccess.py b/eZmaxApi/models/field_e_user_ezsignaccess.py index 90ed964f7..4a6ad8332 100644 --- a/eZmaxApi/models/field_e_user_ezsignaccess.py +++ b/eZmaxApi/models/field_e_user_ezsignaccess.py @@ -13,18 +13,23 @@ """ # noqa: E501 +from __future__ import annotations import json import pprint import re # noqa: F401 -from aenum import Enum, no_arg +from enum import Enum +try: + from typing import Self +except ImportError: + from typing_extensions import Self class FieldEUserEzsignaccess(str, Enum): """ - The type or eZsign access the User has + The type of eZsign access the User has """ """ @@ -36,8 +41,8 @@ class FieldEUserEzsignaccess(str, Enum): PREPAID = 'Prepaid' @classmethod - def from_json(cls, json_str: str) -> FieldEUserEzsignaccess: + def from_json(cls, json_str: str) -> Self: """Create an instance of FieldEUserEzsignaccess from a JSON string""" - return FieldEUserEzsignaccess(json.loads(json_str)) + return cls(json.loads(json_str)) diff --git a/eZmaxApi/models/field_e_user_ezsignprepaid.py b/eZmaxApi/models/field_e_user_ezsignprepaid.py new file mode 100644 index 000000000..b8ce0acad --- /dev/null +++ b/eZmaxApi/models/field_e_user_ezsignprepaid.py @@ -0,0 +1,47 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +import pprint +import re # noqa: F401 +from enum import Enum + + + +try: + from typing import Self +except ImportError: + from typing_extensions import Self + + +class FieldEUserEzsignprepaid(str, Enum): + """ + Subscription level when a user has a Prepaid subscription. + """ + + """ + allowed enum values + """ + BASIC = 'Basic' + UNLIMITED = 'Unlimited' + PRO = 'Pro' + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of FieldEUserEzsignprepaid from a JSON string""" + return cls(json.loads(json_str)) + + diff --git a/eZmaxApi/models/field_e_user_ezsignsendreminderfrequency.py b/eZmaxApi/models/field_e_user_ezsignsendreminderfrequency.py index 56a41b9fe..3e0e8ca10 100644 --- a/eZmaxApi/models/field_e_user_ezsignsendreminderfrequency.py +++ b/eZmaxApi/models/field_e_user_ezsignsendreminderfrequency.py @@ -13,13 +13,18 @@ """ # noqa: E501 +from __future__ import annotations import json import pprint import re # noqa: F401 -from aenum import Enum, no_arg +from enum import Enum +try: + from typing import Self +except ImportError: + from typing_extensions import Self class FieldEUserEzsignsendreminderfrequency(str, Enum): @@ -35,8 +40,8 @@ class FieldEUserEzsignsendreminderfrequency(str, Enum): WEEKLY = 'Weekly' @classmethod - def from_json(cls, json_str: str) -> FieldEUserEzsignsendreminderfrequency: + def from_json(cls, json_str: str) -> Self: """Create an instance of FieldEUserEzsignsendreminderfrequency from a JSON string""" - return FieldEUserEzsignsendreminderfrequency(json.loads(json_str)) + return cls(json.loads(json_str)) diff --git a/eZmaxApi/models/field_e_user_logintype.py b/eZmaxApi/models/field_e_user_logintype.py index 6df1ee91e..769e9c011 100644 --- a/eZmaxApi/models/field_e_user_logintype.py +++ b/eZmaxApi/models/field_e_user_logintype.py @@ -13,13 +13,18 @@ """ # noqa: E501 +from __future__ import annotations import json import pprint import re # noqa: F401 -from aenum import Enum, no_arg +from enum import Enum +try: + from typing import Self +except ImportError: + from typing_extensions import Self class FieldEUserLogintype(str, Enum): @@ -35,8 +40,8 @@ class FieldEUserLogintype(str, Enum): PASSWORDQUESTION = 'PasswordQuestion' @classmethod - def from_json(cls, json_str: str) -> FieldEUserLogintype: + def from_json(cls, json_str: str) -> Self: """Create an instance of FieldEUserLogintype from a JSON string""" - return FieldEUserLogintype(json.loads(json_str)) + return cls(json.loads(json_str)) diff --git a/eZmaxApi/models/field_e_user_origin.py b/eZmaxApi/models/field_e_user_origin.py index ba3c4e0ed..503ea63b2 100644 --- a/eZmaxApi/models/field_e_user_origin.py +++ b/eZmaxApi/models/field_e_user_origin.py @@ -13,13 +13,18 @@ """ # noqa: E501 +from __future__ import annotations import json import pprint import re # noqa: F401 -from aenum import Enum, no_arg +from enum import Enum +try: + from typing import Self +except ImportError: + from typing_extensions import Self class FieldEUserOrigin(str, Enum): @@ -34,8 +39,8 @@ class FieldEUserOrigin(str, Enum): EXTERNAL = 'External' @classmethod - def from_json(cls, json_str: str) -> FieldEUserOrigin: + def from_json(cls, json_str: str) -> Self: """Create an instance of FieldEUserOrigin from a JSON string""" - return FieldEUserOrigin(json.loads(json_str)) + return cls(json.loads(json_str)) diff --git a/eZmaxApi/models/field_e_user_type.py b/eZmaxApi/models/field_e_user_type.py index 600ec8ff8..c21d1528c 100644 --- a/eZmaxApi/models/field_e_user_type.py +++ b/eZmaxApi/models/field_e_user_type.py @@ -13,13 +13,18 @@ """ # noqa: E501 +from __future__ import annotations import json import pprint import re # noqa: F401 -from aenum import Enum, no_arg +from enum import Enum +try: + from typing import Self +except ImportError: + from typing_extensions import Self class FieldEUserType(str, Enum): @@ -37,8 +42,8 @@ class FieldEUserType(str, Enum): NORMAL = 'Normal' @classmethod - def from_json(cls, json_str: str) -> FieldEUserType: + def from_json(cls, json_str: str) -> Self: """Create an instance of FieldEUserType from a JSON string""" - return FieldEUserType(json.loads(json_str)) + return cls(json.loads(json_str)) diff --git a/eZmaxApi/models/field_e_variableexpense_taxable.py b/eZmaxApi/models/field_e_variableexpense_taxable.py index 20839d5b8..7cbc4ff77 100644 --- a/eZmaxApi/models/field_e_variableexpense_taxable.py +++ b/eZmaxApi/models/field_e_variableexpense_taxable.py @@ -13,13 +13,18 @@ """ # noqa: E501 +from __future__ import annotations import json import pprint import re # noqa: F401 -from aenum import Enum, no_arg +from enum import Enum +try: + from typing import Self +except ImportError: + from typing_extensions import Self class FieldEVariableexpenseTaxable(str, Enum): @@ -35,8 +40,8 @@ class FieldEVariableexpenseTaxable(str, Enum): INCLUDED = 'Included' @classmethod - def from_json(cls, json_str: str) -> FieldEVariableexpenseTaxable: + def from_json(cls, json_str: str) -> Self: """Create an instance of FieldEVariableexpenseTaxable from a JSON string""" - return FieldEVariableexpenseTaxable(json.loads(json_str)) + return cls(json.loads(json_str)) diff --git a/eZmaxApi/models/field_e_versionhistory_type.py b/eZmaxApi/models/field_e_versionhistory_type.py index b1d5ac4b1..90494a411 100644 --- a/eZmaxApi/models/field_e_versionhistory_type.py +++ b/eZmaxApi/models/field_e_versionhistory_type.py @@ -13,13 +13,18 @@ """ # noqa: E501 +from __future__ import annotations import json import pprint import re # noqa: F401 -from aenum import Enum, no_arg +from enum import Enum +try: + from typing import Self +except ImportError: + from typing_extensions import Self class FieldEVersionhistoryType(str, Enum): @@ -37,8 +42,8 @@ class FieldEVersionhistoryType(str, Enum): IMPORTANTMESSAGE = 'ImportantMessage' @classmethod - def from_json(cls, json_str: str) -> FieldEVersionhistoryType: + def from_json(cls, json_str: str) -> Self: """Create an instance of FieldEVersionhistoryType from a JSON string""" - return FieldEVersionhistoryType(json.loads(json_str)) + return cls(json.loads(json_str)) diff --git a/eZmaxApi/models/field_e_versionhistory_usertype.py b/eZmaxApi/models/field_e_versionhistory_usertype.py index 36365bda2..8615470e0 100644 --- a/eZmaxApi/models/field_e_versionhistory_usertype.py +++ b/eZmaxApi/models/field_e_versionhistory_usertype.py @@ -13,13 +13,18 @@ """ # noqa: E501 +from __future__ import annotations import json import pprint import re # noqa: F401 -from aenum import Enum, no_arg +from enum import Enum +try: + from typing import Self +except ImportError: + from typing_extensions import Self class FieldEVersionhistoryUsertype(str, Enum): @@ -36,8 +41,8 @@ class FieldEVersionhistoryUsertype(str, Enum): NORMAL = 'Normal' @classmethod - def from_json(cls, json_str: str) -> FieldEVersionhistoryUsertype: + def from_json(cls, json_str: str) -> Self: """Create an instance of FieldEVersionhistoryUsertype from a JSON string""" - return FieldEVersionhistoryUsertype(json.loads(json_str)) + return cls(json.loads(json_str)) diff --git a/eZmaxApi/models/field_e_webhook_ezsignevent.py b/eZmaxApi/models/field_e_webhook_ezsignevent.py index 37d6a6671..f92bdb070 100644 --- a/eZmaxApi/models/field_e_webhook_ezsignevent.py +++ b/eZmaxApi/models/field_e_webhook_ezsignevent.py @@ -13,13 +13,18 @@ """ # noqa: E501 +from __future__ import annotations import json import pprint import re # noqa: F401 -from aenum import Enum, no_arg +from enum import Enum +try: + from typing import Self +except ImportError: + from typing_extensions import Self class FieldEWebhookEzsignevent(str, Enum): @@ -36,8 +41,8 @@ class FieldEWebhookEzsignevent(str, Enum): FOLDERCOMPLETED = 'FolderCompleted' @classmethod - def from_json(cls, json_str: str) -> FieldEWebhookEzsignevent: + def from_json(cls, json_str: str) -> Self: """Create an instance of FieldEWebhookEzsignevent from a JSON string""" - return FieldEWebhookEzsignevent(json.loads(json_str)) + return cls(json.loads(json_str)) diff --git a/eZmaxApi/models/field_e_webhook_managementevent.py b/eZmaxApi/models/field_e_webhook_managementevent.py index 93453737f..a8d8a0e18 100644 --- a/eZmaxApi/models/field_e_webhook_managementevent.py +++ b/eZmaxApi/models/field_e_webhook_managementevent.py @@ -13,13 +13,18 @@ """ # noqa: E501 +from __future__ import annotations import json import pprint import re # noqa: F401 -from aenum import Enum, no_arg +from enum import Enum +try: + from typing import Self +except ImportError: + from typing_extensions import Self class FieldEWebhookManagementevent(str, Enum): @@ -34,8 +39,8 @@ class FieldEWebhookManagementevent(str, Enum): USERSTAGEDCREATED = 'UserstagedCreated' @classmethod - def from_json(cls, json_str: str) -> FieldEWebhookManagementevent: + def from_json(cls, json_str: str) -> Self: """Create an instance of FieldEWebhookManagementevent from a JSON string""" - return FieldEWebhookManagementevent(json.loads(json_str)) + return cls(json.loads(json_str)) diff --git a/eZmaxApi/models/field_e_webhook_module.py b/eZmaxApi/models/field_e_webhook_module.py index 0460347f0..186730ad9 100644 --- a/eZmaxApi/models/field_e_webhook_module.py +++ b/eZmaxApi/models/field_e_webhook_module.py @@ -13,13 +13,18 @@ """ # noqa: E501 +from __future__ import annotations import json import pprint import re # noqa: F401 -from aenum import Enum, no_arg +from enum import Enum +try: + from typing import Self +except ImportError: + from typing_extensions import Self class FieldEWebhookModule(str, Enum): @@ -34,8 +39,8 @@ class FieldEWebhookModule(str, Enum): MANAGEMENT = 'Management' @classmethod - def from_json(cls, json_str: str) -> FieldEWebhookModule: + def from_json(cls, json_str: str) -> Self: """Create an instance of FieldEWebhookModule from a JSON string""" - return FieldEWebhookModule(json.loads(json_str)) + return cls(json.loads(json_str)) diff --git a/eZmaxApi/models/field_pks_ezmaxclient_os.py b/eZmaxApi/models/field_pks_ezmaxclient_os.py index 358646d23..601f436f8 100644 --- a/eZmaxApi/models/field_pks_ezmaxclient_os.py +++ b/eZmaxApi/models/field_pks_ezmaxclient_os.py @@ -13,13 +13,18 @@ """ # noqa: E501 +from __future__ import annotations import json import pprint import re # noqa: F401 -from aenum import Enum, no_arg +from enum import Enum +try: + from typing import Self +except ImportError: + from typing_extensions import Self class FieldPksEzmaxclientOs(str, Enum): @@ -31,12 +36,13 @@ class FieldPksEzmaxclientOs(str, Enum): allowed enum values """ IOS = 'iOS' + IPADOS = 'iPadOS' MACOS = 'macOS' WINDOWS = 'Windows' @classmethod - def from_json(cls, json_str: str) -> FieldPksEzmaxclientOs: + def from_json(cls, json_str: str) -> Self: """Create an instance of FieldPksEzmaxclientOs from a JSON string""" - return FieldPksEzmaxclientOs(json.loads(json_str)) + return cls(json.loads(json_str)) diff --git a/eZmaxApi/models/font_autocomplete_element_response.py b/eZmaxApi/models/font_autocomplete_element_response.py index a4f6a19ba..0f6348425 100644 --- a/eZmaxApi/models/font_autocomplete_element_response.py +++ b/eZmaxApi/models/font_autocomplete_element_response.py @@ -19,64 +19,83 @@ import json - -from pydantic import BaseModel, Field, StrictBool, conint, constr, validator +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictBool, field_validator +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class FontAutocompleteElementResponse(BaseModel): """ - A Font AutocompleteElement Response # noqa: E501 - """ - s_font_name: constr(strict=True) = Field(..., alias="sFontName", description="The name of the Font") - pki_font_id: conint(strict=True, ge=0) = Field(..., alias="pkiFontID", description="The unique ID of the Font") - b_font_isactive: StrictBool = Field(..., alias="bFontIsactive", description="Whether the Font is active or not") - __properties = ["sFontName", "pkiFontID", "bFontIsactive"] - - @validator('s_font_name') + A Font AutocompleteElement Response + """ # noqa: E501 + s_font_name: Annotated[str, Field(strict=True)] = Field(description="The name of the Font", alias="sFontName") + pki_font_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Font", alias="pkiFontID") + b_font_isactive: StrictBool = Field(description="Whether the Font is active or not", alias="bFontIsactive") + __properties: ClassVar[List[str]] = ["sFontName", "pkiFontID", "bFontIsactive"] + + @field_validator('s_font_name') def s_font_name_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^.{0,50}$", value): raise ValueError(r"must validate the regular expression /^.{0,50}$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> FontAutocompleteElementResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of FontAutocompleteElementResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> FontAutocompleteElementResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of FontAutocompleteElementResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return FontAutocompleteElementResponse.parse_obj(obj) + return cls.model_validate(obj) - _obj = FontAutocompleteElementResponse.parse_obj({ - "s_font_name": obj.get("sFontName"), - "pki_font_id": obj.get("pkiFontID"), - "b_font_isactive": obj.get("bFontIsactive") + _obj = cls.model_validate({ + "sFontName": obj.get("sFontName"), + "pkiFontID": obj.get("pkiFontID"), + "bFontIsactive": obj.get("bFontIsactive") }) return _obj diff --git a/eZmaxApi/models/font_get_autocomplete_v2_response.py b/eZmaxApi/models/font_get_autocomplete_v2_response.py index 8fe54eff6..d49366c25 100644 --- a/eZmaxApi/models/font_get_autocomplete_v2_response.py +++ b/eZmaxApi/models/font_get_autocomplete_v2_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.font_get_autocomplete_v2_response_m_payload import FontGetAutocompleteV2ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class FontGetAutocompleteV2Response(BaseModel): """ - Response for GET /2/object/font/getAutocomplete # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: FontGetAutocompleteV2ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /2/object/font/getAutocomplete + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: FontGetAutocompleteV2ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> FontGetAutocompleteV2Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of FontGetAutocompleteV2Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> FontGetAutocompleteV2Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of FontGetAutocompleteV2Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return FontGetAutocompleteV2Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = FontGetAutocompleteV2Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": FontGetAutocompleteV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": FontGetAutocompleteV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/font_get_autocomplete_v2_response_m_payload.py b/eZmaxApi/models/font_get_autocomplete_v2_response_m_payload.py index 82bdf59a3..da8c21714 100644 --- a/eZmaxApi/models/font_get_autocomplete_v2_response_m_payload.py +++ b/eZmaxApi/models/font_get_autocomplete_v2_response_m_payload.py @@ -19,41 +19,59 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.font_autocomplete_element_response import FontAutocompleteElementResponse +try: + from typing import Self +except ImportError: + from typing_extensions import Self class FontGetAutocompleteV2ResponseMPayload(BaseModel): """ - Payload for POST /2/object/font/getAutocomplete # noqa: E501 - """ - a_obj_font: conlist(FontAutocompleteElementResponse) = Field(..., alias="a_objFont", description="An array of Font autocomplete element response.") - __properties = ["a_objFont"] + Payload for POST /2/object/font/getAutocomplete + """ # noqa: E501 + a_obj_font: List[FontAutocompleteElementResponse] = Field(description="An array of Font autocomplete element response.", alias="a_objFont") + __properties: ClassVar[List[str]] = ["a_objFont"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> FontGetAutocompleteV2ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of FontGetAutocompleteV2ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_font (list) _items = [] if self.a_obj_font: @@ -64,16 +82,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> FontGetAutocompleteV2ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of FontGetAutocompleteV2ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return FontGetAutocompleteV2ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = FontGetAutocompleteV2ResponseMPayload.parse_obj({ - "a_obj_font": [FontAutocompleteElementResponse.from_dict(_item) for _item in obj.get("a_objFont")] if obj.get("a_objFont") is not None else None + _obj = cls.model_validate({ + "a_objFont": [FontAutocompleteElementResponse.from_dict(_item) for _item in obj.get("a_objFont")] if obj.get("a_objFont") is not None else None }) return _obj diff --git a/eZmaxApi/models/franchisebroker_autocomplete_element_response.py b/eZmaxApi/models/franchisebroker_autocomplete_element_response.py index f51cf00da..8096324eb 100644 --- a/eZmaxApi/models/franchisebroker_autocomplete_element_response.py +++ b/eZmaxApi/models/franchisebroker_autocomplete_element_response.py @@ -19,57 +19,76 @@ import json - -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictBool, StrictStr +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class FranchisebrokerAutocompleteElementResponse(BaseModel): """ - A Franchisebroker AutocompleteElement Response # noqa: E501 - """ - s_franchisebroker_name: StrictStr = Field(..., alias="sFranchisebrokerName", description="The name of the Franchisebroker in the language of the requester") - pki_franchisebroker_id: conint(strict=True, ge=0) = Field(..., alias="pkiFranchisebrokerID", description="The unique ID of the Franchisebroker") - b_franchisebroker_isactive: StrictBool = Field(..., alias="bFranchisebrokerIsactive", description="Whether the Franchisebroker is active or not") - __properties = ["sFranchisebrokerName", "pkiFranchisebrokerID", "bFranchisebrokerIsactive"] + A Franchisebroker AutocompleteElement Response + """ # noqa: E501 + s_franchisebroker_name: StrictStr = Field(description="The name of the Franchisebroker in the language of the requester", alias="sFranchisebrokerName") + pki_franchisebroker_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Franchisebroker", alias="pkiFranchisebrokerID") + b_franchisebroker_isactive: StrictBool = Field(description="Whether the Franchisebroker is active or not", alias="bFranchisebrokerIsactive") + __properties: ClassVar[List[str]] = ["sFranchisebrokerName", "pkiFranchisebrokerID", "bFranchisebrokerIsactive"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> FranchisebrokerAutocompleteElementResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of FranchisebrokerAutocompleteElementResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> FranchisebrokerAutocompleteElementResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of FranchisebrokerAutocompleteElementResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return FranchisebrokerAutocompleteElementResponse.parse_obj(obj) + return cls.model_validate(obj) - _obj = FranchisebrokerAutocompleteElementResponse.parse_obj({ - "s_franchisebroker_name": obj.get("sFranchisebrokerName"), - "pki_franchisebroker_id": obj.get("pkiFranchisebrokerID"), - "b_franchisebroker_isactive": obj.get("bFranchisebrokerIsactive") + _obj = cls.model_validate({ + "sFranchisebrokerName": obj.get("sFranchisebrokerName"), + "pkiFranchisebrokerID": obj.get("pkiFranchisebrokerID"), + "bFranchisebrokerIsactive": obj.get("bFranchisebrokerIsactive") }) return _obj diff --git a/eZmaxApi/models/franchisebroker_get_autocomplete_v2_response.py b/eZmaxApi/models/franchisebroker_get_autocomplete_v2_response.py index 6852d7d14..2c8d089d7 100644 --- a/eZmaxApi/models/franchisebroker_get_autocomplete_v2_response.py +++ b/eZmaxApi/models/franchisebroker_get_autocomplete_v2_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.franchisebroker_get_autocomplete_v2_response_m_payload import FranchisebrokerGetAutocompleteV2ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class FranchisebrokerGetAutocompleteV2Response(BaseModel): """ - Response for GET /2/object/franchisebroker/getAutocomplete # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: FranchisebrokerGetAutocompleteV2ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /2/object/franchisebroker/getAutocomplete + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: FranchisebrokerGetAutocompleteV2ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> FranchisebrokerGetAutocompleteV2Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of FranchisebrokerGetAutocompleteV2Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> FranchisebrokerGetAutocompleteV2Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of FranchisebrokerGetAutocompleteV2Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return FranchisebrokerGetAutocompleteV2Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = FranchisebrokerGetAutocompleteV2Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": FranchisebrokerGetAutocompleteV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": FranchisebrokerGetAutocompleteV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/franchisebroker_get_autocomplete_v2_response_m_payload.py b/eZmaxApi/models/franchisebroker_get_autocomplete_v2_response_m_payload.py index 6e0ebf725..f771135b6 100644 --- a/eZmaxApi/models/franchisebroker_get_autocomplete_v2_response_m_payload.py +++ b/eZmaxApi/models/franchisebroker_get_autocomplete_v2_response_m_payload.py @@ -19,41 +19,59 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.franchisebroker_autocomplete_element_response import FranchisebrokerAutocompleteElementResponse +try: + from typing import Self +except ImportError: + from typing_extensions import Self class FranchisebrokerGetAutocompleteV2ResponseMPayload(BaseModel): """ - Payload for POST /2/object/franchisebroker/getAutocomplete # noqa: E501 - """ - a_obj_franchisebroker: conlist(FranchisebrokerAutocompleteElementResponse) = Field(..., alias="a_objFranchisebroker", description="An array of Franchisebroker autocomplete element response.") - __properties = ["a_objFranchisebroker"] + Payload for POST /2/object/franchisebroker/getAutocomplete + """ # noqa: E501 + a_obj_franchisebroker: List[FranchisebrokerAutocompleteElementResponse] = Field(description="An array of Franchisebroker autocomplete element response.", alias="a_objFranchisebroker") + __properties: ClassVar[List[str]] = ["a_objFranchisebroker"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> FranchisebrokerGetAutocompleteV2ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of FranchisebrokerGetAutocompleteV2ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_franchisebroker (list) _items = [] if self.a_obj_franchisebroker: @@ -64,16 +82,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> FranchisebrokerGetAutocompleteV2ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of FranchisebrokerGetAutocompleteV2ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return FranchisebrokerGetAutocompleteV2ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = FranchisebrokerGetAutocompleteV2ResponseMPayload.parse_obj({ - "a_obj_franchisebroker": [FranchisebrokerAutocompleteElementResponse.from_dict(_item) for _item in obj.get("a_objFranchisebroker")] if obj.get("a_objFranchisebroker") is not None else None + _obj = cls.model_validate({ + "a_objFranchisebroker": [FranchisebrokerAutocompleteElementResponse.from_dict(_item) for _item in obj.get("a_objFranchisebroker")] if obj.get("a_objFranchisebroker") is not None else None }) return _obj diff --git a/eZmaxApi/models/franchiseoffice_autocomplete_element_response.py b/eZmaxApi/models/franchiseoffice_autocomplete_element_response.py index 64355118b..17a66aa53 100644 --- a/eZmaxApi/models/franchiseoffice_autocomplete_element_response.py +++ b/eZmaxApi/models/franchiseoffice_autocomplete_element_response.py @@ -19,57 +19,76 @@ import json - -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictBool, StrictStr +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class FranchiseofficeAutocompleteElementResponse(BaseModel): """ - A Franchiseoffice AutocompleteElement Response # noqa: E501 - """ - s_franchiseoffice_description: StrictStr = Field(..., alias="sFranchiseofficeDescription", description="The description of the Franchiseoffice in the language of the requester") - pki_franchiseoffice_id: conint(strict=True, ge=0) = Field(..., alias="pkiFranchiseofficeID", description="The unique ID of the Franchisereoffice") - b_franchiseoffice_isactive: StrictBool = Field(..., alias="bFranchiseofficeIsactive", description="Whether the Franchiseoffice is active or not") - __properties = ["sFranchiseofficeDescription", "pkiFranchiseofficeID", "bFranchiseofficeIsactive"] + A Franchiseoffice AutocompleteElement Response + """ # noqa: E501 + s_franchiseoffice_description: StrictStr = Field(description="The description of the Franchiseoffice in the language of the requester", alias="sFranchiseofficeDescription") + pki_franchiseoffice_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Franchisereoffice", alias="pkiFranchiseofficeID") + b_franchiseoffice_isactive: StrictBool = Field(description="Whether the Franchiseoffice is active or not", alias="bFranchiseofficeIsactive") + __properties: ClassVar[List[str]] = ["sFranchiseofficeDescription", "pkiFranchiseofficeID", "bFranchiseofficeIsactive"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> FranchiseofficeAutocompleteElementResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of FranchiseofficeAutocompleteElementResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> FranchiseofficeAutocompleteElementResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of FranchiseofficeAutocompleteElementResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return FranchiseofficeAutocompleteElementResponse.parse_obj(obj) + return cls.model_validate(obj) - _obj = FranchiseofficeAutocompleteElementResponse.parse_obj({ - "s_franchiseoffice_description": obj.get("sFranchiseofficeDescription"), - "pki_franchiseoffice_id": obj.get("pkiFranchiseofficeID"), - "b_franchiseoffice_isactive": obj.get("bFranchiseofficeIsactive") + _obj = cls.model_validate({ + "sFranchiseofficeDescription": obj.get("sFranchiseofficeDescription"), + "pkiFranchiseofficeID": obj.get("pkiFranchiseofficeID"), + "bFranchiseofficeIsactive": obj.get("bFranchiseofficeIsactive") }) return _obj diff --git a/eZmaxApi/models/franchiseoffice_get_autocomplete_v2_response.py b/eZmaxApi/models/franchiseoffice_get_autocomplete_v2_response.py index ba5d228ec..3a89b4c24 100644 --- a/eZmaxApi/models/franchiseoffice_get_autocomplete_v2_response.py +++ b/eZmaxApi/models/franchiseoffice_get_autocomplete_v2_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.franchiseoffice_get_autocomplete_v2_response_m_payload import FranchiseofficeGetAutocompleteV2ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class FranchiseofficeGetAutocompleteV2Response(BaseModel): """ - Response for GET /2/object/franchiseoffice/getAutocomplete # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: FranchiseofficeGetAutocompleteV2ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /2/object/franchiseoffice/getAutocomplete + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: FranchiseofficeGetAutocompleteV2ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> FranchiseofficeGetAutocompleteV2Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of FranchiseofficeGetAutocompleteV2Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> FranchiseofficeGetAutocompleteV2Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of FranchiseofficeGetAutocompleteV2Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return FranchiseofficeGetAutocompleteV2Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = FranchiseofficeGetAutocompleteV2Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": FranchiseofficeGetAutocompleteV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": FranchiseofficeGetAutocompleteV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/franchiseoffice_get_autocomplete_v2_response_m_payload.py b/eZmaxApi/models/franchiseoffice_get_autocomplete_v2_response_m_payload.py index 410dab404..50cf2c2ee 100644 --- a/eZmaxApi/models/franchiseoffice_get_autocomplete_v2_response_m_payload.py +++ b/eZmaxApi/models/franchiseoffice_get_autocomplete_v2_response_m_payload.py @@ -19,41 +19,59 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.franchiseoffice_autocomplete_element_response import FranchiseofficeAutocompleteElementResponse +try: + from typing import Self +except ImportError: + from typing_extensions import Self class FranchiseofficeGetAutocompleteV2ResponseMPayload(BaseModel): """ - Payload for POST /2/object/franchiseoffice/getAutocomplete # noqa: E501 - """ - a_obj_franchiseoffice: conlist(FranchiseofficeAutocompleteElementResponse) = Field(..., alias="a_objFranchiseoffice", description="An array of Franchiseoffice autocomplete element response.") - __properties = ["a_objFranchiseoffice"] + Payload for POST /2/object/franchiseoffice/getAutocomplete + """ # noqa: E501 + a_obj_franchiseoffice: List[FranchiseofficeAutocompleteElementResponse] = Field(description="An array of Franchiseoffice autocomplete element response.", alias="a_objFranchiseoffice") + __properties: ClassVar[List[str]] = ["a_objFranchiseoffice"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> FranchiseofficeGetAutocompleteV2ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of FranchiseofficeGetAutocompleteV2ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_franchiseoffice (list) _items = [] if self.a_obj_franchiseoffice: @@ -64,16 +82,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> FranchiseofficeGetAutocompleteV2ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of FranchiseofficeGetAutocompleteV2ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return FranchiseofficeGetAutocompleteV2ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = FranchiseofficeGetAutocompleteV2ResponseMPayload.parse_obj({ - "a_obj_franchiseoffice": [FranchiseofficeAutocompleteElementResponse.from_dict(_item) for _item in obj.get("a_objFranchiseoffice")] if obj.get("a_objFranchiseoffice") is not None else None + _obj = cls.model_validate({ + "a_objFranchiseoffice": [FranchiseofficeAutocompleteElementResponse.from_dict(_item) for _item in obj.get("a_objFranchiseoffice")] if obj.get("a_objFranchiseoffice") is not None else None }) return _obj diff --git a/eZmaxApi/models/franchisereferalincome_create_object_v1_request.py b/eZmaxApi/models/franchisereferalincome_create_object_v1_request.py index 38baa8971..16aca01fa 100644 --- a/eZmaxApi/models/franchisereferalincome_create_object_v1_request.py +++ b/eZmaxApi/models/franchisereferalincome_create_object_v1_request.py @@ -19,43 +19,61 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.franchisereferalincome_request import FranchisereferalincomeRequest from eZmaxApi.models.franchisereferalincome_request_compound import FranchisereferalincomeRequestCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class FranchisereferalincomeCreateObjectV1Request(BaseModel): """ - Request for POST /1/object/franchisereferalincome # noqa: E501 - """ - obj_franchisereferalincome: Optional[FranchisereferalincomeRequest] = Field(None, alias="objFranchisereferalincome") - obj_franchisereferalincome_compound: Optional[FranchisereferalincomeRequestCompound] = Field(None, alias="objFranchisereferalincomeCompound") - __properties = ["objFranchisereferalincome", "objFranchisereferalincomeCompound"] + Request for POST /1/object/franchisereferalincome + """ # noqa: E501 + obj_franchisereferalincome: Optional[FranchisereferalincomeRequest] = Field(default=None, alias="objFranchisereferalincome") + obj_franchisereferalincome_compound: Optional[FranchisereferalincomeRequestCompound] = Field(default=None, alias="objFranchisereferalincomeCompound") + __properties: ClassVar[List[str]] = ["objFranchisereferalincome", "objFranchisereferalincomeCompound"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> FranchisereferalincomeCreateObjectV1Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of FranchisereferalincomeCreateObjectV1Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_franchisereferalincome if self.obj_franchisereferalincome: _dict['objFranchisereferalincome'] = self.obj_franchisereferalincome.to_dict() @@ -65,17 +83,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> FranchisereferalincomeCreateObjectV1Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of FranchisereferalincomeCreateObjectV1Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return FranchisereferalincomeCreateObjectV1Request.parse_obj(obj) + return cls.model_validate(obj) - _obj = FranchisereferalincomeCreateObjectV1Request.parse_obj({ - "obj_franchisereferalincome": FranchisereferalincomeRequest.from_dict(obj.get("objFranchisereferalincome")) if obj.get("objFranchisereferalincome") is not None else None, - "obj_franchisereferalincome_compound": FranchisereferalincomeRequestCompound.from_dict(obj.get("objFranchisereferalincomeCompound")) if obj.get("objFranchisereferalincomeCompound") is not None else None + _obj = cls.model_validate({ + "objFranchisereferalincome": FranchisereferalincomeRequest.from_dict(obj.get("objFranchisereferalincome")) if obj.get("objFranchisereferalincome") is not None else None, + "objFranchisereferalincomeCompound": FranchisereferalincomeRequestCompound.from_dict(obj.get("objFranchisereferalincomeCompound")) if obj.get("objFranchisereferalincomeCompound") is not None else None }) return _obj diff --git a/eZmaxApi/models/franchisereferalincome_create_object_v1_response.py b/eZmaxApi/models/franchisereferalincome_create_object_v1_response.py index 982b7fe4a..aa22237c5 100644 --- a/eZmaxApi/models/franchisereferalincome_create_object_v1_response.py +++ b/eZmaxApi/models/franchisereferalincome_create_object_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.franchisereferalincome_create_object_v1_response_m_payload import FranchisereferalincomeCreateObjectV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class FranchisereferalincomeCreateObjectV1Response(BaseModel): """ - Response for POST /1/object/franchisereferalincome # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: FranchisereferalincomeCreateObjectV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for POST /1/object/franchisereferalincome + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: FranchisereferalincomeCreateObjectV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> FranchisereferalincomeCreateObjectV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of FranchisereferalincomeCreateObjectV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> FranchisereferalincomeCreateObjectV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of FranchisereferalincomeCreateObjectV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return FranchisereferalincomeCreateObjectV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = FranchisereferalincomeCreateObjectV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": FranchisereferalincomeCreateObjectV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": FranchisereferalincomeCreateObjectV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/franchisereferalincome_create_object_v1_response_m_payload.py b/eZmaxApi/models/franchisereferalincome_create_object_v1_response_m_payload.py index 31a89a1df..45f35cfa2 100644 --- a/eZmaxApi/models/franchisereferalincome_create_object_v1_response_m_payload.py +++ b/eZmaxApi/models/franchisereferalincome_create_object_v1_response_m_payload.py @@ -19,53 +19,72 @@ import json -from typing import List -from pydantic import BaseModel, Field, conint, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class FranchisereferalincomeCreateObjectV1ResponseMPayload(BaseModel): """ - Payload for POST /1/object/franchisereferalincome # noqa: E501 - """ - a_pki_franchisereferalincome_id: conlist(conint(strict=True, ge=0), min_items=1) = Field(..., alias="a_pkiFranchisereferalincomeID", description="An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request.") - __properties = ["a_pkiFranchisereferalincomeID"] + Payload for POST /1/object/franchisereferalincome + """ # noqa: E501 + a_pki_franchisereferalincome_id: Annotated[List[Annotated[int, Field(strict=True, ge=0)]], Field(min_length=1)] = Field(description="An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request.", alias="a_pkiFranchisereferalincomeID") + __properties: ClassVar[List[str]] = ["a_pkiFranchisereferalincomeID"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> FranchisereferalincomeCreateObjectV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of FranchisereferalincomeCreateObjectV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> FranchisereferalincomeCreateObjectV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of FranchisereferalincomeCreateObjectV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return FranchisereferalincomeCreateObjectV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = FranchisereferalincomeCreateObjectV1ResponseMPayload.parse_obj({ - "a_pki_franchisereferalincome_id": obj.get("a_pkiFranchisereferalincomeID") + _obj = cls.model_validate({ + "a_pkiFranchisereferalincomeID": obj.get("a_pkiFranchisereferalincomeID") }) return _obj diff --git a/eZmaxApi/models/franchisereferalincome_create_object_v2_request.py b/eZmaxApi/models/franchisereferalincome_create_object_v2_request.py index 655a5de75..c5df785bd 100644 --- a/eZmaxApi/models/franchisereferalincome_create_object_v2_request.py +++ b/eZmaxApi/models/franchisereferalincome_create_object_v2_request.py @@ -19,41 +19,60 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.franchisereferalincome_request_compound import FranchisereferalincomeRequestCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class FranchisereferalincomeCreateObjectV2Request(BaseModel): """ - Request for POST /2/object/franchisereferalincome # noqa: E501 - """ - a_obj_franchisereferalincome: conlist(FranchisereferalincomeRequestCompound, min_items=1) = Field(..., alias="a_objFranchisereferalincome") - __properties = ["a_objFranchisereferalincome"] + Request for POST /2/object/franchisereferalincome + """ # noqa: E501 + a_obj_franchisereferalincome: Annotated[List[FranchisereferalincomeRequestCompound], Field(min_length=1)] = Field(alias="a_objFranchisereferalincome") + __properties: ClassVar[List[str]] = ["a_objFranchisereferalincome"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> FranchisereferalincomeCreateObjectV2Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of FranchisereferalincomeCreateObjectV2Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_franchisereferalincome (list) _items = [] if self.a_obj_franchisereferalincome: @@ -64,16 +83,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> FranchisereferalincomeCreateObjectV2Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of FranchisereferalincomeCreateObjectV2Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return FranchisereferalincomeCreateObjectV2Request.parse_obj(obj) + return cls.model_validate(obj) - _obj = FranchisereferalincomeCreateObjectV2Request.parse_obj({ - "a_obj_franchisereferalincome": [FranchisereferalincomeRequestCompound.from_dict(_item) for _item in obj.get("a_objFranchisereferalincome")] if obj.get("a_objFranchisereferalincome") is not None else None + _obj = cls.model_validate({ + "a_objFranchisereferalincome": [FranchisereferalincomeRequestCompound.from_dict(_item) for _item in obj.get("a_objFranchisereferalincome")] if obj.get("a_objFranchisereferalincome") is not None else None }) return _obj diff --git a/eZmaxApi/models/franchisereferalincome_create_object_v2_response.py b/eZmaxApi/models/franchisereferalincome_create_object_v2_response.py index 6dfb65c23..de3d53783 100644 --- a/eZmaxApi/models/franchisereferalincome_create_object_v2_response.py +++ b/eZmaxApi/models/franchisereferalincome_create_object_v2_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.franchisereferalincome_create_object_v2_response_m_payload import FranchisereferalincomeCreateObjectV2ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class FranchisereferalincomeCreateObjectV2Response(BaseModel): """ - Response for POST /2/object/franchisereferalincome # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: FranchisereferalincomeCreateObjectV2ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for POST /2/object/franchisereferalincome + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: FranchisereferalincomeCreateObjectV2ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> FranchisereferalincomeCreateObjectV2Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of FranchisereferalincomeCreateObjectV2Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> FranchisereferalincomeCreateObjectV2Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of FranchisereferalincomeCreateObjectV2Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return FranchisereferalincomeCreateObjectV2Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = FranchisereferalincomeCreateObjectV2Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": FranchisereferalincomeCreateObjectV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": FranchisereferalincomeCreateObjectV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/franchisereferalincome_create_object_v2_response_m_payload.py b/eZmaxApi/models/franchisereferalincome_create_object_v2_response_m_payload.py index eab98f357..a300ce576 100644 --- a/eZmaxApi/models/franchisereferalincome_create_object_v2_response_m_payload.py +++ b/eZmaxApi/models/franchisereferalincome_create_object_v2_response_m_payload.py @@ -19,53 +19,72 @@ import json -from typing import List -from pydantic import BaseModel, Field, conint, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class FranchisereferalincomeCreateObjectV2ResponseMPayload(BaseModel): """ - Payload for POST /2/object/franchisereferalincome # noqa: E501 - """ - a_pki_franchisereferalincome_id: conlist(conint(strict=True, ge=0), min_items=1) = Field(..., alias="a_pkiFranchisereferalincomeID", description="An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request.") - __properties = ["a_pkiFranchisereferalincomeID"] + Payload for POST /2/object/franchisereferalincome + """ # noqa: E501 + a_pki_franchisereferalincome_id: Annotated[List[Annotated[int, Field(strict=True, ge=0)]], Field(min_length=1)] = Field(description="An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request.", alias="a_pkiFranchisereferalincomeID") + __properties: ClassVar[List[str]] = ["a_pkiFranchisereferalincomeID"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> FranchisereferalincomeCreateObjectV2ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of FranchisereferalincomeCreateObjectV2ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> FranchisereferalincomeCreateObjectV2ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of FranchisereferalincomeCreateObjectV2ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return FranchisereferalincomeCreateObjectV2ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = FranchisereferalincomeCreateObjectV2ResponseMPayload.parse_obj({ - "a_pki_franchisereferalincome_id": obj.get("a_pkiFranchisereferalincomeID") + _obj = cls.model_validate({ + "a_pkiFranchisereferalincomeID": obj.get("a_pkiFranchisereferalincomeID") }) return _obj diff --git a/eZmaxApi/models/franchisereferalincome_request.py b/eZmaxApi/models/franchisereferalincome_request.py index 69013bfbe..79904b691 100644 --- a/eZmaxApi/models/franchisereferalincome_request.py +++ b/eZmaxApi/models/franchisereferalincome_request.py @@ -19,75 +19,94 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictStr, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictStr +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class FranchisereferalincomeRequest(BaseModel): """ - An Franchisereferalincome Object # noqa: E501 - """ - pki_franchisereferalincome_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="pkiFranchisereferalincomeID", description="The unique ID of the Franchisereferalincome") - fki_franchisebroker_id: conint(strict=True, ge=0) = Field(..., alias="fkiFranchisebrokerID", description="The unique ID of the Franchisebroker") - fki_franchisereferalincomeprogram_id: conint(strict=True, ge=0) = Field(..., alias="fkiFranchisereferalincomeprogramID", description="The unique ID of the Franchisereferalincomeprogram") - fki_period_id: conint(strict=True, ge=0) = Field(..., alias="fkiPeriodID", description="The unique ID of the Period") - d_franchisereferalincome_loan: StrictStr = Field(..., alias="dFranchisereferalincomeLoan", description="The loan amount") - d_franchisereferalincome_franchiseamount: StrictStr = Field(..., alias="dFranchisereferalincomeFranchiseamount", description="The amount that will be given to the franchise") - d_franchisereferalincome_franchisoramount: StrictStr = Field(..., alias="dFranchisereferalincomeFranchisoramount", description="The amount that will be kept by the franchisor") - d_franchisereferalincome_agentamount: StrictStr = Field(..., alias="dFranchisereferalincomeAgentamount", description="The amount that will be given to the agent") - dt_franchisereferalincome_disbursed: StrictStr = Field(..., alias="dtFranchisereferalincomeDisbursed", description="The date the amounts were disbursed") - t_franchisereferalincome_comment: StrictStr = Field(..., alias="tFranchisereferalincomeComment", description="Comment about the transaction") - fki_franchiseoffice_id: conint(strict=True, ge=0) = Field(..., alias="fkiFranchiseofficeID", description="The unique ID of the Franchisereoffice") - s_franchisereferalincome_remoteid: StrictStr = Field(..., alias="sFranchisereferalincomeRemoteid") - __properties = ["pkiFranchisereferalincomeID", "fkiFranchisebrokerID", "fkiFranchisereferalincomeprogramID", "fkiPeriodID", "dFranchisereferalincomeLoan", "dFranchisereferalincomeFranchiseamount", "dFranchisereferalincomeFranchisoramount", "dFranchisereferalincomeAgentamount", "dtFranchisereferalincomeDisbursed", "tFranchisereferalincomeComment", "fkiFranchiseofficeID", "sFranchisereferalincomeRemoteid"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + An Franchisereferalincome Object + """ # noqa: E501 + pki_franchisereferalincome_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Franchisereferalincome", alias="pkiFranchisereferalincomeID") + fki_franchisebroker_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Franchisebroker", alias="fkiFranchisebrokerID") + fki_franchisereferalincomeprogram_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Franchisereferalincomeprogram", alias="fkiFranchisereferalincomeprogramID") + fki_period_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Period", alias="fkiPeriodID") + d_franchisereferalincome_loan: StrictStr = Field(description="The loan amount", alias="dFranchisereferalincomeLoan") + d_franchisereferalincome_franchiseamount: StrictStr = Field(description="The amount that will be given to the franchise", alias="dFranchisereferalincomeFranchiseamount") + d_franchisereferalincome_franchisoramount: StrictStr = Field(description="The amount that will be kept by the franchisor", alias="dFranchisereferalincomeFranchisoramount") + d_franchisereferalincome_agentamount: StrictStr = Field(description="The amount that will be given to the agent", alias="dFranchisereferalincomeAgentamount") + dt_franchisereferalincome_disbursed: StrictStr = Field(description="The date the amounts were disbursed", alias="dtFranchisereferalincomeDisbursed") + t_franchisereferalincome_comment: StrictStr = Field(description="Comment about the transaction", alias="tFranchisereferalincomeComment") + fki_franchiseoffice_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Franchisereoffice", alias="fkiFranchiseofficeID") + s_franchisereferalincome_remoteid: StrictStr = Field(alias="sFranchisereferalincomeRemoteid") + __properties: ClassVar[List[str]] = ["pkiFranchisereferalincomeID", "fkiFranchisebrokerID", "fkiFranchisereferalincomeprogramID", "fkiPeriodID", "dFranchisereferalincomeLoan", "dFranchisereferalincomeFranchiseamount", "dFranchisereferalincomeFranchisoramount", "dFranchisereferalincomeAgentamount", "dtFranchisereferalincomeDisbursed", "tFranchisereferalincomeComment", "fkiFranchiseofficeID", "sFranchisereferalincomeRemoteid"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> FranchisereferalincomeRequest: + def from_json(cls, json_str: str) -> Self: """Create an instance of FranchisereferalincomeRequest from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> FranchisereferalincomeRequest: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of FranchisereferalincomeRequest from a dict""" if obj is None: return None if not isinstance(obj, dict): - return FranchisereferalincomeRequest.parse_obj(obj) - - _obj = FranchisereferalincomeRequest.parse_obj({ - "pki_franchisereferalincome_id": obj.get("pkiFranchisereferalincomeID"), - "fki_franchisebroker_id": obj.get("fkiFranchisebrokerID"), - "fki_franchisereferalincomeprogram_id": obj.get("fkiFranchisereferalincomeprogramID"), - "fki_period_id": obj.get("fkiPeriodID"), - "d_franchisereferalincome_loan": obj.get("dFranchisereferalincomeLoan"), - "d_franchisereferalincome_franchiseamount": obj.get("dFranchisereferalincomeFranchiseamount"), - "d_franchisereferalincome_franchisoramount": obj.get("dFranchisereferalincomeFranchisoramount"), - "d_franchisereferalincome_agentamount": obj.get("dFranchisereferalincomeAgentamount"), - "dt_franchisereferalincome_disbursed": obj.get("dtFranchisereferalincomeDisbursed"), - "t_franchisereferalincome_comment": obj.get("tFranchisereferalincomeComment"), - "fki_franchiseoffice_id": obj.get("fkiFranchiseofficeID"), - "s_franchisereferalincome_remoteid": obj.get("sFranchisereferalincomeRemoteid") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiFranchisereferalincomeID": obj.get("pkiFranchisereferalincomeID"), + "fkiFranchisebrokerID": obj.get("fkiFranchisebrokerID"), + "fkiFranchisereferalincomeprogramID": obj.get("fkiFranchisereferalincomeprogramID"), + "fkiPeriodID": obj.get("fkiPeriodID"), + "dFranchisereferalincomeLoan": obj.get("dFranchisereferalincomeLoan"), + "dFranchisereferalincomeFranchiseamount": obj.get("dFranchisereferalincomeFranchiseamount"), + "dFranchisereferalincomeFranchisoramount": obj.get("dFranchisereferalincomeFranchisoramount"), + "dFranchisereferalincomeAgentamount": obj.get("dFranchisereferalincomeAgentamount"), + "dtFranchisereferalincomeDisbursed": obj.get("dtFranchisereferalincomeDisbursed"), + "tFranchisereferalincomeComment": obj.get("tFranchisereferalincomeComment"), + "fkiFranchiseofficeID": obj.get("fkiFranchiseofficeID"), + "sFranchisereferalincomeRemoteid": obj.get("sFranchisereferalincomeRemoteid") }) return _obj diff --git a/eZmaxApi/models/franchisereferalincome_request_compound.py b/eZmaxApi/models/franchisereferalincome_request_compound.py index 45c19e861..a73ffa358 100644 --- a/eZmaxApi/models/franchisereferalincome_request_compound.py +++ b/eZmaxApi/models/franchisereferalincome_request_compound.py @@ -19,55 +19,74 @@ import json -from typing import List, Optional -from pydantic import BaseModel, Field, StrictStr, conint, conlist +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictStr +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.address_request import AddressRequest from eZmaxApi.models.contact_request_compound import ContactRequestCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class FranchisereferalincomeRequestCompound(BaseModel): """ - A Franchisereferalincome Object and children to create a complete structure # noqa: E501 - """ - pki_franchisereferalincome_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="pkiFranchisereferalincomeID", description="The unique ID of the Franchisereferalincome") - fki_franchisebroker_id: conint(strict=True, ge=0) = Field(..., alias="fkiFranchisebrokerID", description="The unique ID of the Franchisebroker") - fki_franchisereferalincomeprogram_id: conint(strict=True, ge=0) = Field(..., alias="fkiFranchisereferalincomeprogramID", description="The unique ID of the Franchisereferalincomeprogram") - fki_period_id: conint(strict=True, ge=0) = Field(..., alias="fkiPeriodID", description="The unique ID of the Period") - d_franchisereferalincome_loan: StrictStr = Field(..., alias="dFranchisereferalincomeLoan", description="The loan amount") - d_franchisereferalincome_franchiseamount: StrictStr = Field(..., alias="dFranchisereferalincomeFranchiseamount", description="The amount that will be given to the franchise") - d_franchisereferalincome_franchisoramount: StrictStr = Field(..., alias="dFranchisereferalincomeFranchisoramount", description="The amount that will be kept by the franchisor") - d_franchisereferalincome_agentamount: StrictStr = Field(..., alias="dFranchisereferalincomeAgentamount", description="The amount that will be given to the agent") - dt_franchisereferalincome_disbursed: StrictStr = Field(..., alias="dtFranchisereferalincomeDisbursed", description="The date the amounts were disbursed") - t_franchisereferalincome_comment: StrictStr = Field(..., alias="tFranchisereferalincomeComment", description="Comment about the transaction") - fki_franchiseoffice_id: conint(strict=True, ge=0) = Field(..., alias="fkiFranchiseofficeID", description="The unique ID of the Franchisereoffice") - s_franchisereferalincome_remoteid: StrictStr = Field(..., alias="sFranchisereferalincomeRemoteid") - obj_address: Optional[AddressRequest] = Field(None, alias="objAddress") - a_obj_contact: conlist(ContactRequestCompound) = Field(..., alias="a_objContact") - __properties = ["pkiFranchisereferalincomeID", "fkiFranchisebrokerID", "fkiFranchisereferalincomeprogramID", "fkiPeriodID", "dFranchisereferalincomeLoan", "dFranchisereferalincomeFranchiseamount", "dFranchisereferalincomeFranchisoramount", "dFranchisereferalincomeAgentamount", "dtFranchisereferalincomeDisbursed", "tFranchisereferalincomeComment", "fkiFranchiseofficeID", "sFranchisereferalincomeRemoteid", "objAddress", "a_objContact"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + A Franchisereferalincome Object and children to create a complete structure + """ # noqa: E501 + pki_franchisereferalincome_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Franchisereferalincome", alias="pkiFranchisereferalincomeID") + fki_franchisebroker_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Franchisebroker", alias="fkiFranchisebrokerID") + fki_franchisereferalincomeprogram_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Franchisereferalincomeprogram", alias="fkiFranchisereferalincomeprogramID") + fki_period_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Period", alias="fkiPeriodID") + d_franchisereferalincome_loan: StrictStr = Field(description="The loan amount", alias="dFranchisereferalincomeLoan") + d_franchisereferalincome_franchiseamount: StrictStr = Field(description="The amount that will be given to the franchise", alias="dFranchisereferalincomeFranchiseamount") + d_franchisereferalincome_franchisoramount: StrictStr = Field(description="The amount that will be kept by the franchisor", alias="dFranchisereferalincomeFranchisoramount") + d_franchisereferalincome_agentamount: StrictStr = Field(description="The amount that will be given to the agent", alias="dFranchisereferalincomeAgentamount") + dt_franchisereferalincome_disbursed: StrictStr = Field(description="The date the amounts were disbursed", alias="dtFranchisereferalincomeDisbursed") + t_franchisereferalincome_comment: StrictStr = Field(description="Comment about the transaction", alias="tFranchisereferalincomeComment") + fki_franchiseoffice_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Franchisereoffice", alias="fkiFranchiseofficeID") + s_franchisereferalincome_remoteid: StrictStr = Field(alias="sFranchisereferalincomeRemoteid") + obj_address: Optional[AddressRequest] = Field(default=None, alias="objAddress") + a_obj_contact: List[ContactRequestCompound] = Field(alias="a_objContact") + __properties: ClassVar[List[str]] = ["pkiFranchisereferalincomeID", "fkiFranchisebrokerID", "fkiFranchisereferalincomeprogramID", "fkiPeriodID", "dFranchisereferalincomeLoan", "dFranchisereferalincomeFranchiseamount", "dFranchisereferalincomeFranchisoramount", "dFranchisereferalincomeAgentamount", "dtFranchisereferalincomeDisbursed", "tFranchisereferalincomeComment", "fkiFranchiseofficeID", "sFranchisereferalincomeRemoteid", "objAddress", "a_objContact"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> FranchisereferalincomeRequestCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of FranchisereferalincomeRequestCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_address if self.obj_address: _dict['objAddress'] = self.obj_address.to_dict() @@ -81,29 +100,29 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> FranchisereferalincomeRequestCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of FranchisereferalincomeRequestCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return FranchisereferalincomeRequestCompound.parse_obj(obj) - - _obj = FranchisereferalincomeRequestCompound.parse_obj({ - "pki_franchisereferalincome_id": obj.get("pkiFranchisereferalincomeID"), - "fki_franchisebroker_id": obj.get("fkiFranchisebrokerID"), - "fki_franchisereferalincomeprogram_id": obj.get("fkiFranchisereferalincomeprogramID"), - "fki_period_id": obj.get("fkiPeriodID"), - "d_franchisereferalincome_loan": obj.get("dFranchisereferalincomeLoan"), - "d_franchisereferalincome_franchiseamount": obj.get("dFranchisereferalincomeFranchiseamount"), - "d_franchisereferalincome_franchisoramount": obj.get("dFranchisereferalincomeFranchisoramount"), - "d_franchisereferalincome_agentamount": obj.get("dFranchisereferalincomeAgentamount"), - "dt_franchisereferalincome_disbursed": obj.get("dtFranchisereferalincomeDisbursed"), - "t_franchisereferalincome_comment": obj.get("tFranchisereferalincomeComment"), - "fki_franchiseoffice_id": obj.get("fkiFranchiseofficeID"), - "s_franchisereferalincome_remoteid": obj.get("sFranchisereferalincomeRemoteid"), - "obj_address": AddressRequest.from_dict(obj.get("objAddress")) if obj.get("objAddress") is not None else None, - "a_obj_contact": [ContactRequestCompound.from_dict(_item) for _item in obj.get("a_objContact")] if obj.get("a_objContact") is not None else None + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiFranchisereferalincomeID": obj.get("pkiFranchisereferalincomeID"), + "fkiFranchisebrokerID": obj.get("fkiFranchisebrokerID"), + "fkiFranchisereferalincomeprogramID": obj.get("fkiFranchisereferalincomeprogramID"), + "fkiPeriodID": obj.get("fkiPeriodID"), + "dFranchisereferalincomeLoan": obj.get("dFranchisereferalincomeLoan"), + "dFranchisereferalincomeFranchiseamount": obj.get("dFranchisereferalincomeFranchiseamount"), + "dFranchisereferalincomeFranchisoramount": obj.get("dFranchisereferalincomeFranchisoramount"), + "dFranchisereferalincomeAgentamount": obj.get("dFranchisereferalincomeAgentamount"), + "dtFranchisereferalincomeDisbursed": obj.get("dtFranchisereferalincomeDisbursed"), + "tFranchisereferalincomeComment": obj.get("tFranchisereferalincomeComment"), + "fkiFranchiseofficeID": obj.get("fkiFranchiseofficeID"), + "sFranchisereferalincomeRemoteid": obj.get("sFranchisereferalincomeRemoteid"), + "objAddress": AddressRequest.from_dict(obj.get("objAddress")) if obj.get("objAddress") is not None else None, + "a_objContact": [ContactRequestCompound.from_dict(_item) for _item in obj.get("a_objContact")] if obj.get("a_objContact") is not None else None }) return _obj diff --git a/eZmaxApi/models/global_customer_get_endpoint_v1_response.py b/eZmaxApi/models/global_customer_get_endpoint_v1_response.py index f759546cf..2f733ab17 100644 --- a/eZmaxApi/models/global_customer_get_endpoint_v1_response.py +++ b/eZmaxApi/models/global_customer_get_endpoint_v1_response.py @@ -19,53 +19,71 @@ import json - -from pydantic import BaseModel, Field, StrictStr +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictStr +from pydantic import Field +try: + from typing import Self +except ImportError: + from typing_extensions import Self class GlobalCustomerGetEndpointV1Response(BaseModel): """ - Response for GET /1/customer/{pksCustomerCode}/endpoint # noqa: E501 - """ - s_endpoint_url: StrictStr = Field(..., alias="sEndpointURL", description="The endpoint's URL") - __properties = ["sEndpointURL"] + Response for GET /1/customer/{pksCustomerCode}/endpoint + """ # noqa: E501 + s_endpoint_url: StrictStr = Field(description="The endpoint's URL", alias="sEndpointURL") + __properties: ClassVar[List[str]] = ["sEndpointURL"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> GlobalCustomerGetEndpointV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of GlobalCustomerGetEndpointV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> GlobalCustomerGetEndpointV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of GlobalCustomerGetEndpointV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return GlobalCustomerGetEndpointV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = GlobalCustomerGetEndpointV1Response.parse_obj({ - "s_endpoint_url": obj.get("sEndpointURL") + _obj = cls.model_validate({ + "sEndpointURL": obj.get("sEndpointURL") }) return _obj diff --git a/eZmaxApi/models/global_ezmaxclient_version_v1_response.py b/eZmaxApi/models/global_ezmaxclient_version_v1_response.py index b01199793..9f578e720 100644 --- a/eZmaxApi/models/global_ezmaxclient_version_v1_response.py +++ b/eZmaxApi/models/global_ezmaxclient_version_v1_response.py @@ -19,53 +19,73 @@ import json - -from pydantic import BaseModel, Field, StrictStr +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictStr +from pydantic import Field +try: + from typing import Self +except ImportError: + from typing_extensions import Self class GlobalEzmaxclientVersionV1Response(BaseModel): """ - Response for GET /1/ezmaxclient/{pksEzmaxclientOs}/version # noqa: E501 - """ - s_ezmaxclient_version: StrictStr = Field(..., alias="sEzmaxclientVersion", description="The version on the store") - __properties = ["sEzmaxclientVersion"] + Response for GET /1/ezmaxclient/{pksEzmaxclientOs}/version + """ # noqa: E501 + s_ezmaxclient_version: StrictStr = Field(description="The version on the store", alias="sEzmaxclientVersion") + s_ezmaxclient_oslatestversion: StrictStr = Field(description="The latest OS version of the system running the application at the time of release", alias="sEzmaxclientOslatestversion") + __properties: ClassVar[List[str]] = ["sEzmaxclientVersion", "sEzmaxclientOslatestversion"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> GlobalEzmaxclientVersionV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of GlobalEzmaxclientVersionV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> GlobalEzmaxclientVersionV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of GlobalEzmaxclientVersionV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return GlobalEzmaxclientVersionV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = GlobalEzmaxclientVersionV1Response.parse_obj({ - "s_ezmaxclient_version": obj.get("sEzmaxclientVersion") + _obj = cls.model_validate({ + "sEzmaxclientVersion": obj.get("sEzmaxclientVersion"), + "sEzmaxclientOslatestversion": obj.get("sEzmaxclientOslatestversion") if obj.get("sEzmaxclientOslatestversion") is not None else '11' }) return _obj diff --git a/eZmaxApi/models/global_ezmaxcustomer_get_configuration_v1_response.py b/eZmaxApi/models/global_ezmaxcustomer_get_configuration_v1_response.py index e8601a7f6..2add02356 100644 --- a/eZmaxApi/models/global_ezmaxcustomer_get_configuration_v1_response.py +++ b/eZmaxApi/models/global_ezmaxcustomer_get_configuration_v1_response.py @@ -19,61 +19,79 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictStr +from pydantic import Field +try: + from typing import Self +except ImportError: + from typing_extensions import Self class GlobalEzmaxcustomerGetConfigurationV1Response(BaseModel): """ - Response for GET /1/ezmaxcustomer/{pksEzmaxcustomerCode}/getConfiguration # noqa: E501 - """ - s_infrastructureregion_code: StrictStr = Field(..., alias="sInfrastructureregionCode", description="The region code") - s_infrastructureregion_code_web: StrictStr = Field(..., alias="sInfrastructureregionCodeWeb", description="The region code") - s_infrastructureenvironmenttype_description: StrictStr = Field(..., alias="sInfrastructureenvironmenttypeDescription", description="The environment type Description") - s_cognito_client_id_external: Optional[StrictStr] = Field(None, alias="sCognitoClientIDExternal", description="The ID of the client in Cognito") - s_cognito_client_id_ezmaxpublic: StrictStr = Field(..., alias="sCognitoClientIDEzmaxpublic", description="The ID of the client in Cognito") - __properties = ["sInfrastructureregionCode", "sInfrastructureregionCodeWeb", "sInfrastructureenvironmenttypeDescription", "sCognitoClientIDExternal", "sCognitoClientIDEzmaxpublic"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + Response for GET /1/ezmaxcustomer/{pksEzmaxcustomerCode}/getConfiguration + """ # noqa: E501 + s_infrastructureregion_code: StrictStr = Field(description="The region code", alias="sInfrastructureregionCode") + s_infrastructureregion_code_web: StrictStr = Field(description="The region code", alias="sInfrastructureregionCodeWeb") + s_infrastructureenvironmenttype_description: StrictStr = Field(description="The environment type Description", alias="sInfrastructureenvironmenttypeDescription") + s_cognito_client_id_external: Optional[StrictStr] = Field(default=None, description="The ID of the client in Cognito", alias="sCognitoClientIDExternal") + s_cognito_client_id_ezmaxpublic: StrictStr = Field(description="The ID of the client in Cognito", alias="sCognitoClientIDEzmaxpublic") + __properties: ClassVar[List[str]] = ["sInfrastructureregionCode", "sInfrastructureregionCodeWeb", "sInfrastructureenvironmenttypeDescription", "sCognitoClientIDExternal", "sCognitoClientIDEzmaxpublic"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> GlobalEzmaxcustomerGetConfigurationV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of GlobalEzmaxcustomerGetConfigurationV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> GlobalEzmaxcustomerGetConfigurationV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of GlobalEzmaxcustomerGetConfigurationV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return GlobalEzmaxcustomerGetConfigurationV1Response.parse_obj(obj) - - _obj = GlobalEzmaxcustomerGetConfigurationV1Response.parse_obj({ - "s_infrastructureregion_code": obj.get("sInfrastructureregionCode"), - "s_infrastructureregion_code_web": obj.get("sInfrastructureregionCodeWeb"), - "s_infrastructureenvironmenttype_description": obj.get("sInfrastructureenvironmenttypeDescription"), - "s_cognito_client_id_external": obj.get("sCognitoClientIDExternal"), - "s_cognito_client_id_ezmaxpublic": obj.get("sCognitoClientIDEzmaxpublic") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "sInfrastructureregionCode": obj.get("sInfrastructureregionCode"), + "sInfrastructureregionCodeWeb": obj.get("sInfrastructureregionCodeWeb"), + "sInfrastructureenvironmenttypeDescription": obj.get("sInfrastructureenvironmenttypeDescription"), + "sCognitoClientIDExternal": obj.get("sCognitoClientIDExternal"), + "sCognitoClientIDEzmaxpublic": obj.get("sCognitoClientIDEzmaxpublic") }) return _obj diff --git a/eZmaxApi/models/header_accept_language.py b/eZmaxApi/models/header_accept_language.py index 7e164103e..8e6b670cd 100644 --- a/eZmaxApi/models/header_accept_language.py +++ b/eZmaxApi/models/header_accept_language.py @@ -13,13 +13,18 @@ """ # noqa: E501 +from __future__ import annotations import json import pprint import re # noqa: F401 -from aenum import Enum, no_arg +from enum import Enum +try: + from typing import Self +except ImportError: + from typing_extensions import Self class HeaderAcceptLanguage(str, Enum): @@ -35,8 +40,8 @@ class HeaderAcceptLanguage(str, Enum): FR = 'fr' @classmethod - def from_json(cls, json_str: str) -> HeaderAcceptLanguage: + def from_json(cls, json_str: str) -> Self: """Create an instance of HeaderAcceptLanguage from a JSON string""" - return HeaderAcceptLanguage(json.loads(json_str)) + return cls(json.loads(json_str)) diff --git a/eZmaxApi/models/inscription_get_attachments_v1_response.py b/eZmaxApi/models/inscription_get_attachments_v1_response.py new file mode 100644 index 000000000..dffce22f0 --- /dev/null +++ b/eZmaxApi/models/inscription_get_attachments_v1_response.py @@ -0,0 +1,106 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field +from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug +from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +from eZmaxApi.models.inscription_get_attachments_v1_response_m_payload import InscriptionGetAttachmentsV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self + +class InscriptionGetAttachmentsV1Response(BaseModel): + """ + Response for GET /1/object/inscription/{pkiInscriptionID}/getAttachments + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: InscriptionGetAttachmentsV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of InscriptionGetAttachmentsV1Response from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of obj_debug_payload + if self.obj_debug_payload: + _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() + # override the default output from pydantic by calling `to_dict()` of obj_debug + if self.obj_debug: + _dict['objDebug'] = self.obj_debug.to_dict() + # override the default output from pydantic by calling `to_dict()` of m_payload + if self.m_payload: + _dict['mPayload'] = self.m_payload.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Dict) -> Self: + """Create an instance of InscriptionGetAttachmentsV1Response from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": InscriptionGetAttachmentsV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + }) + return _obj + + diff --git a/eZmaxApi/models/inscription_get_attachments_v1_response_m_payload.py b/eZmaxApi/models/inscription_get_attachments_v1_response_m_payload.py new file mode 100644 index 000000000..2d4da25e9 --- /dev/null +++ b/eZmaxApi/models/inscription_get_attachments_v1_response_m_payload.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from eZmaxApi.models.custom_attachmentdocumenttype_response import CustomAttachmentdocumenttypeResponse +try: + from typing import Self +except ImportError: + from typing_extensions import Self + +class InscriptionGetAttachmentsV1ResponseMPayload(BaseModel): + """ + Response for GET /1/object/inscription/{pkiInscriptionID}/getAttachments + """ # noqa: E501 + a_obj_attachmentdocumenttype: List[CustomAttachmentdocumenttypeResponse] = Field(alias="a_objAttachmentdocumenttype") + __properties: ClassVar[List[str]] = ["a_objAttachmentdocumenttype"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of InscriptionGetAttachmentsV1ResponseMPayload from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in a_obj_attachmentdocumenttype (list) + _items = [] + if self.a_obj_attachmentdocumenttype: + for _item in self.a_obj_attachmentdocumenttype: + if _item: + _items.append(_item.to_dict()) + _dict['a_objAttachmentdocumenttype'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Dict) -> Self: + """Create an instance of InscriptionGetAttachmentsV1ResponseMPayload from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "a_objAttachmentdocumenttype": [CustomAttachmentdocumenttypeResponse.from_dict(_item) for _item in obj.get("a_objAttachmentdocumenttype")] if obj.get("a_objAttachmentdocumenttype") is not None else None + }) + return _obj + + diff --git a/eZmaxApi/models/inscription_get_communication_list_v1_response.py b/eZmaxApi/models/inscription_get_communication_list_v1_response.py index 654ce79ab..ddc8e8d33 100644 --- a/eZmaxApi/models/inscription_get_communication_list_v1_response.py +++ b/eZmaxApi/models/inscription_get_communication_list_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload_get_list import CommonResponseObjDebugPayloadGetList from eZmaxApi.models.inscription_get_communication_list_v1_response_m_payload import InscriptionGetCommunicationListV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class InscriptionGetCommunicationListV1Response(BaseModel): """ - Response for GET /1/object/inscription/{pkiInscriptionID}/getCommunicationList # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayloadGetList = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: InscriptionGetCommunicationListV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /1/object/inscription/{pkiInscriptionID}/getCommunicationList + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayloadGetList = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: InscriptionGetCommunicationListV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> InscriptionGetCommunicationListV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of InscriptionGetCommunicationListV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> InscriptionGetCommunicationListV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of InscriptionGetCommunicationListV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return InscriptionGetCommunicationListV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = InscriptionGetCommunicationListV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayloadGetList.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": InscriptionGetCommunicationListV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayloadGetList.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": InscriptionGetCommunicationListV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/inscription_get_communication_list_v1_response_m_payload.py b/eZmaxApi/models/inscription_get_communication_list_v1_response_m_payload.py index d7f0a9254..f86f4d14e 100644 --- a/eZmaxApi/models/inscription_get_communication_list_v1_response_m_payload.py +++ b/eZmaxApi/models/inscription_get_communication_list_v1_response_m_payload.py @@ -19,41 +19,59 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.custom_communication_list_element_response import CustomCommunicationListElementResponse +try: + from typing import Self +except ImportError: + from typing_extensions import Self class InscriptionGetCommunicationListV1ResponseMPayload(BaseModel): """ - Response for GET /1/object/inscription/{pkiInscriptionID}/getCommunicationList # noqa: E501 - """ - a_obj_communication: conlist(CustomCommunicationListElementResponse) = Field(..., alias="a_objCommunication") - __properties = ["a_objCommunication"] + Response for GET /1/object/inscription/{pkiInscriptionID}/getCommunicationList + """ # noqa: E501 + a_obj_communication: List[CustomCommunicationListElementResponse] = Field(alias="a_objCommunication") + __properties: ClassVar[List[str]] = ["a_objCommunication"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> InscriptionGetCommunicationListV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of InscriptionGetCommunicationListV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_communication (list) _items = [] if self.a_obj_communication: @@ -64,16 +82,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> InscriptionGetCommunicationListV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of InscriptionGetCommunicationListV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return InscriptionGetCommunicationListV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = InscriptionGetCommunicationListV1ResponseMPayload.parse_obj({ - "a_obj_communication": [CustomCommunicationListElementResponse.from_dict(_item) for _item in obj.get("a_objCommunication")] if obj.get("a_objCommunication") is not None else None + _obj = cls.model_validate({ + "a_objCommunication": [CustomCommunicationListElementResponse.from_dict(_item) for _item in obj.get("a_objCommunication")] if obj.get("a_objCommunication") is not None else None }) return _obj diff --git a/eZmaxApi/models/inscription_get_communicationsenders_v1_response.py b/eZmaxApi/models/inscription_get_communicationsenders_v1_response.py new file mode 100644 index 000000000..e288173d1 --- /dev/null +++ b/eZmaxApi/models/inscription_get_communicationsenders_v1_response.py @@ -0,0 +1,106 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field +from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug +from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +from eZmaxApi.models.inscription_get_communicationsenders_v1_response_m_payload import InscriptionGetCommunicationsendersV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self + +class InscriptionGetCommunicationsendersV1Response(BaseModel): + """ + Response for GET /1/object/inscription/{pkiInscriptionID}/getCommunicationrecipients + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: InscriptionGetCommunicationsendersV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of InscriptionGetCommunicationsendersV1Response from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of obj_debug_payload + if self.obj_debug_payload: + _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() + # override the default output from pydantic by calling `to_dict()` of obj_debug + if self.obj_debug: + _dict['objDebug'] = self.obj_debug.to_dict() + # override the default output from pydantic by calling `to_dict()` of m_payload + if self.m_payload: + _dict['mPayload'] = self.m_payload.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Dict) -> Self: + """Create an instance of InscriptionGetCommunicationsendersV1Response from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": InscriptionGetCommunicationsendersV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + }) + return _obj + + diff --git a/eZmaxApi/models/inscription_get_communicationsenders_v1_response_m_payload.py b/eZmaxApi/models/inscription_get_communicationsenders_v1_response_m_payload.py new file mode 100644 index 000000000..279b0e9d6 --- /dev/null +++ b/eZmaxApi/models/inscription_get_communicationsenders_v1_response_m_payload.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from eZmaxApi.models.custom_communicationsender_response import CustomCommunicationsenderResponse +try: + from typing import Self +except ImportError: + from typing_extensions import Self + +class InscriptionGetCommunicationsendersV1ResponseMPayload(BaseModel): + """ + Response for GET /1/object/inscription/{pkiInscriptionID}/getCommunicationsenders + """ # noqa: E501 + a_obj_communicationsenders: List[CustomCommunicationsenderResponse] = Field(alias="a_objCommunicationsenders") + __properties: ClassVar[List[str]] = ["a_objCommunicationsenders"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of InscriptionGetCommunicationsendersV1ResponseMPayload from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in a_obj_communicationsenders (list) + _items = [] + if self.a_obj_communicationsenders: + for _item in self.a_obj_communicationsenders: + if _item: + _items.append(_item.to_dict()) + _dict['a_objCommunicationsenders'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Dict) -> Self: + """Create an instance of InscriptionGetCommunicationsendersV1ResponseMPayload from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "a_objCommunicationsenders": [CustomCommunicationsenderResponse.from_dict(_item) for _item in obj.get("a_objCommunicationsenders")] if obj.get("a_objCommunicationsenders") is not None else None + }) + return _obj + + diff --git a/eZmaxApi/models/inscriptionnotauthenticated_get_communication_list_v1_response.py b/eZmaxApi/models/inscriptionnotauthenticated_get_communication_list_v1_response.py index abac7890d..36130dc8f 100644 --- a/eZmaxApi/models/inscriptionnotauthenticated_get_communication_list_v1_response.py +++ b/eZmaxApi/models/inscriptionnotauthenticated_get_communication_list_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload_get_list import CommonResponseObjDebugPayloadGetList from eZmaxApi.models.inscriptionnotauthenticated_get_communication_list_v1_response_m_payload import InscriptionnotauthenticatedGetCommunicationListV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class InscriptionnotauthenticatedGetCommunicationListV1Response(BaseModel): """ - Response for GET /1/object/inscriptionnotauthenticated/{pkiInscriptionnotauthenticatedID}/getCommunicationList # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayloadGetList = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: InscriptionnotauthenticatedGetCommunicationListV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /1/object/inscriptionnotauthenticated/{pkiInscriptionnotauthenticatedID}/getCommunicationList + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayloadGetList = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: InscriptionnotauthenticatedGetCommunicationListV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> InscriptionnotauthenticatedGetCommunicationListV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of InscriptionnotauthenticatedGetCommunicationListV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> InscriptionnotauthenticatedGetCommunicationListV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of InscriptionnotauthenticatedGetCommunicationListV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return InscriptionnotauthenticatedGetCommunicationListV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = InscriptionnotauthenticatedGetCommunicationListV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayloadGetList.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": InscriptionnotauthenticatedGetCommunicationListV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayloadGetList.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": InscriptionnotauthenticatedGetCommunicationListV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/inscriptionnotauthenticated_get_communication_list_v1_response_m_payload.py b/eZmaxApi/models/inscriptionnotauthenticated_get_communication_list_v1_response_m_payload.py index dba459668..8df4cbb85 100644 --- a/eZmaxApi/models/inscriptionnotauthenticated_get_communication_list_v1_response_m_payload.py +++ b/eZmaxApi/models/inscriptionnotauthenticated_get_communication_list_v1_response_m_payload.py @@ -19,41 +19,59 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.custom_communication_list_element_response import CustomCommunicationListElementResponse +try: + from typing import Self +except ImportError: + from typing_extensions import Self class InscriptionnotauthenticatedGetCommunicationListV1ResponseMPayload(BaseModel): """ - Response for GET /1/object/inscriptionnotauthenticated/{pkiInscriptionnotauthenticatedID}/getCommunicationList # noqa: E501 - """ - a_obj_communication: conlist(CustomCommunicationListElementResponse) = Field(..., alias="a_objCommunication") - __properties = ["a_objCommunication"] + Response for GET /1/object/inscriptionnotauthenticated/{pkiInscriptionnotauthenticatedID}/getCommunicationList + """ # noqa: E501 + a_obj_communication: List[CustomCommunicationListElementResponse] = Field(alias="a_objCommunication") + __properties: ClassVar[List[str]] = ["a_objCommunication"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> InscriptionnotauthenticatedGetCommunicationListV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of InscriptionnotauthenticatedGetCommunicationListV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_communication (list) _items = [] if self.a_obj_communication: @@ -64,16 +82,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> InscriptionnotauthenticatedGetCommunicationListV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of InscriptionnotauthenticatedGetCommunicationListV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return InscriptionnotauthenticatedGetCommunicationListV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = InscriptionnotauthenticatedGetCommunicationListV1ResponseMPayload.parse_obj({ - "a_obj_communication": [CustomCommunicationListElementResponse.from_dict(_item) for _item in obj.get("a_objCommunication")] if obj.get("a_objCommunication") is not None else None + _obj = cls.model_validate({ + "a_objCommunication": [CustomCommunicationListElementResponse.from_dict(_item) for _item in obj.get("a_objCommunication")] if obj.get("a_objCommunication") is not None else None }) return _obj diff --git a/eZmaxApi/models/inscriptiontemp_get_communication_list_v1_response.py b/eZmaxApi/models/inscriptiontemp_get_communication_list_v1_response.py index 09773d284..2a87e8530 100644 --- a/eZmaxApi/models/inscriptiontemp_get_communication_list_v1_response.py +++ b/eZmaxApi/models/inscriptiontemp_get_communication_list_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload_get_list import CommonResponseObjDebugPayloadGetList from eZmaxApi.models.inscriptiontemp_get_communication_list_v1_response_m_payload import InscriptiontempGetCommunicationListV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class InscriptiontempGetCommunicationListV1Response(BaseModel): """ - Response for GET /1/object/inscriptiontemp/{pkiInscriptiontempID}/getCommunicationList # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayloadGetList = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: InscriptiontempGetCommunicationListV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /1/object/inscriptiontemp/{pkiInscriptiontempID}/getCommunicationList + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayloadGetList = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: InscriptiontempGetCommunicationListV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> InscriptiontempGetCommunicationListV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of InscriptiontempGetCommunicationListV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> InscriptiontempGetCommunicationListV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of InscriptiontempGetCommunicationListV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return InscriptiontempGetCommunicationListV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = InscriptiontempGetCommunicationListV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayloadGetList.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": InscriptiontempGetCommunicationListV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayloadGetList.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": InscriptiontempGetCommunicationListV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/inscriptiontemp_get_communication_list_v1_response_m_payload.py b/eZmaxApi/models/inscriptiontemp_get_communication_list_v1_response_m_payload.py index f8a3a5a40..d0f62d52f 100644 --- a/eZmaxApi/models/inscriptiontemp_get_communication_list_v1_response_m_payload.py +++ b/eZmaxApi/models/inscriptiontemp_get_communication_list_v1_response_m_payload.py @@ -19,41 +19,59 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.custom_communication_list_element_response import CustomCommunicationListElementResponse +try: + from typing import Self +except ImportError: + from typing_extensions import Self class InscriptiontempGetCommunicationListV1ResponseMPayload(BaseModel): """ - Response for GET /1/object/inscriptiontemp/{pkiInscriptiontempID}/getCommunicationList # noqa: E501 - """ - a_obj_communication: conlist(CustomCommunicationListElementResponse) = Field(..., alias="a_objCommunication") - __properties = ["a_objCommunication"] + Response for GET /1/object/inscriptiontemp/{pkiInscriptiontempID}/getCommunicationList + """ # noqa: E501 + a_obj_communication: List[CustomCommunicationListElementResponse] = Field(alias="a_objCommunication") + __properties: ClassVar[List[str]] = ["a_objCommunication"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> InscriptiontempGetCommunicationListV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of InscriptiontempGetCommunicationListV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_communication (list) _items = [] if self.a_obj_communication: @@ -64,16 +82,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> InscriptiontempGetCommunicationListV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of InscriptiontempGetCommunicationListV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return InscriptiontempGetCommunicationListV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = InscriptiontempGetCommunicationListV1ResponseMPayload.parse_obj({ - "a_obj_communication": [CustomCommunicationListElementResponse.from_dict(_item) for _item in obj.get("a_objCommunication")] if obj.get("a_objCommunication") is not None else None + _obj = cls.model_validate({ + "a_objCommunication": [CustomCommunicationListElementResponse.from_dict(_item) for _item in obj.get("a_objCommunication")] if obj.get("a_objCommunication") is not None else None }) return _obj diff --git a/eZmaxApi/models/invoice_get_attachments_v1_response.py b/eZmaxApi/models/invoice_get_attachments_v1_response.py new file mode 100644 index 000000000..0c94a957e --- /dev/null +++ b/eZmaxApi/models/invoice_get_attachments_v1_response.py @@ -0,0 +1,106 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field +from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug +from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +from eZmaxApi.models.invoice_get_attachments_v1_response_m_payload import InvoiceGetAttachmentsV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self + +class InvoiceGetAttachmentsV1Response(BaseModel): + """ + Response for GET /1/object/invoice/{pkiInvoiceID}/getAttachments + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: InvoiceGetAttachmentsV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of InvoiceGetAttachmentsV1Response from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of obj_debug_payload + if self.obj_debug_payload: + _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() + # override the default output from pydantic by calling `to_dict()` of obj_debug + if self.obj_debug: + _dict['objDebug'] = self.obj_debug.to_dict() + # override the default output from pydantic by calling `to_dict()` of m_payload + if self.m_payload: + _dict['mPayload'] = self.m_payload.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Dict) -> Self: + """Create an instance of InvoiceGetAttachmentsV1Response from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": InvoiceGetAttachmentsV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + }) + return _obj + + diff --git a/eZmaxApi/models/invoice_get_attachments_v1_response_m_payload.py b/eZmaxApi/models/invoice_get_attachments_v1_response_m_payload.py new file mode 100644 index 000000000..ad3a9ab08 --- /dev/null +++ b/eZmaxApi/models/invoice_get_attachments_v1_response_m_payload.py @@ -0,0 +1,98 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from eZmaxApi.models.custom_attachmentdocumenttype_response import CustomAttachmentdocumenttypeResponse +try: + from typing import Self +except ImportError: + from typing_extensions import Self + +class InvoiceGetAttachmentsV1ResponseMPayload(BaseModel): + """ + Response for GET /1/object/invoice/{pkiInvoiceID}/getAttachments + """ # noqa: E501 + a_obj_attachmentdocumenttype: List[CustomAttachmentdocumenttypeResponse] = Field(alias="a_objAttachmentdocumenttype") + __properties: ClassVar[List[str]] = ["a_objAttachmentdocumenttype"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of InvoiceGetAttachmentsV1ResponseMPayload from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in a_obj_attachmentdocumenttype (list) + _items = [] + if self.a_obj_attachmentdocumenttype: + for _item in self.a_obj_attachmentdocumenttype: + if _item: + _items.append(_item.to_dict()) + _dict['a_objAttachmentdocumenttype'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Dict) -> Self: + """Create an instance of InvoiceGetAttachmentsV1ResponseMPayload from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "a_objAttachmentdocumenttype": [CustomAttachmentdocumenttypeResponse.from_dict(_item) for _item in obj.get("a_objAttachmentdocumenttype")] if obj.get("a_objAttachmentdocumenttype") is not None else None + }) + return _obj + + diff --git a/eZmaxApi/models/invoice_get_communication_list_v1_response.py b/eZmaxApi/models/invoice_get_communication_list_v1_response.py index 0ebb0b483..6d34a914c 100644 --- a/eZmaxApi/models/invoice_get_communication_list_v1_response.py +++ b/eZmaxApi/models/invoice_get_communication_list_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload_get_list import CommonResponseObjDebugPayloadGetList from eZmaxApi.models.invoice_get_communication_list_v1_response_m_payload import InvoiceGetCommunicationListV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class InvoiceGetCommunicationListV1Response(BaseModel): """ - Response for GET /1/object/invoice/{pkiInvoiceID}/getCommunicationList # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayloadGetList = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: InvoiceGetCommunicationListV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /1/object/invoice/{pkiInvoiceID}/getCommunicationList + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayloadGetList = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: InvoiceGetCommunicationListV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> InvoiceGetCommunicationListV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of InvoiceGetCommunicationListV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> InvoiceGetCommunicationListV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of InvoiceGetCommunicationListV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return InvoiceGetCommunicationListV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = InvoiceGetCommunicationListV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayloadGetList.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": InvoiceGetCommunicationListV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayloadGetList.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": InvoiceGetCommunicationListV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/invoice_get_communication_list_v1_response_m_payload.py b/eZmaxApi/models/invoice_get_communication_list_v1_response_m_payload.py index c31364d78..42e45dc5b 100644 --- a/eZmaxApi/models/invoice_get_communication_list_v1_response_m_payload.py +++ b/eZmaxApi/models/invoice_get_communication_list_v1_response_m_payload.py @@ -19,41 +19,59 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.custom_communication_list_element_response import CustomCommunicationListElementResponse +try: + from typing import Self +except ImportError: + from typing_extensions import Self class InvoiceGetCommunicationListV1ResponseMPayload(BaseModel): """ - Response for GET /1/object/invoice/{pkiInvoiceID}/getCommunicationList # noqa: E501 - """ - a_obj_communication: conlist(CustomCommunicationListElementResponse) = Field(..., alias="a_objCommunication") - __properties = ["a_objCommunication"] + Response for GET /1/object/invoice/{pkiInvoiceID}/getCommunicationList + """ # noqa: E501 + a_obj_communication: List[CustomCommunicationListElementResponse] = Field(alias="a_objCommunication") + __properties: ClassVar[List[str]] = ["a_objCommunication"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> InvoiceGetCommunicationListV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of InvoiceGetCommunicationListV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_communication (list) _items = [] if self.a_obj_communication: @@ -64,16 +82,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> InvoiceGetCommunicationListV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of InvoiceGetCommunicationListV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return InvoiceGetCommunicationListV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = InvoiceGetCommunicationListV1ResponseMPayload.parse_obj({ - "a_obj_communication": [CustomCommunicationListElementResponse.from_dict(_item) for _item in obj.get("a_objCommunication")] if obj.get("a_objCommunication") is not None else None + _obj = cls.model_validate({ + "a_objCommunication": [CustomCommunicationListElementResponse.from_dict(_item) for _item in obj.get("a_objCommunication")] if obj.get("a_objCommunication") is not None else None }) return _obj diff --git a/eZmaxApi/models/language_autocomplete_element_response.py b/eZmaxApi/models/language_autocomplete_element_response.py index b515012f1..5900a60b4 100644 --- a/eZmaxApi/models/language_autocomplete_element_response.py +++ b/eZmaxApi/models/language_autocomplete_element_response.py @@ -19,57 +19,76 @@ import json - -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictBool, StrictStr +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class LanguageAutocompleteElementResponse(BaseModel): """ - A Language AutocompleteElement Response # noqa: E501 - """ - pki_language_id: conint(strict=True, le=2, ge=1) = Field(..., alias="pkiLanguageID", description="The unique ID of the Language. Valid values: |Value|Description| |-|-| |1|French| |2|English|") - s_language_name_x: StrictStr = Field(..., alias="sLanguageNameX", description="The Name of the Language in the language of the requester") - b_language_isactive: StrictBool = Field(..., alias="bLanguageIsactive", description="Whether the Language is active or not") - __properties = ["pkiLanguageID", "sLanguageNameX", "bLanguageIsactive"] + A Language AutocompleteElement Response + """ # noqa: E501 + pki_language_id: Annotated[int, Field(le=2, strict=True, ge=1)] = Field(description="The unique ID of the Language. Valid values: |Value|Description| |-|-| |1|French| |2|English|", alias="pkiLanguageID") + s_language_name_x: StrictStr = Field(description="The Name of the Language in the language of the requester", alias="sLanguageNameX") + b_language_isactive: StrictBool = Field(description="Whether the Language is active or not", alias="bLanguageIsactive") + __properties: ClassVar[List[str]] = ["pkiLanguageID", "sLanguageNameX", "bLanguageIsactive"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> LanguageAutocompleteElementResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of LanguageAutocompleteElementResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> LanguageAutocompleteElementResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of LanguageAutocompleteElementResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return LanguageAutocompleteElementResponse.parse_obj(obj) + return cls.model_validate(obj) - _obj = LanguageAutocompleteElementResponse.parse_obj({ - "pki_language_id": obj.get("pkiLanguageID"), - "s_language_name_x": obj.get("sLanguageNameX"), - "b_language_isactive": obj.get("bLanguageIsactive") + _obj = cls.model_validate({ + "pkiLanguageID": obj.get("pkiLanguageID"), + "sLanguageNameX": obj.get("sLanguageNameX"), + "bLanguageIsactive": obj.get("bLanguageIsactive") }) return _obj diff --git a/eZmaxApi/models/language_get_autocomplete_v2_response.py b/eZmaxApi/models/language_get_autocomplete_v2_response.py index a888e8bd4..8b39e2c74 100644 --- a/eZmaxApi/models/language_get_autocomplete_v2_response.py +++ b/eZmaxApi/models/language_get_autocomplete_v2_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.language_get_autocomplete_v2_response_m_payload import LanguageGetAutocompleteV2ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class LanguageGetAutocompleteV2Response(BaseModel): """ - Response for GET /2/object/language/getAutocomplete # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: LanguageGetAutocompleteV2ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /2/object/language/getAutocomplete + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: LanguageGetAutocompleteV2ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> LanguageGetAutocompleteV2Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of LanguageGetAutocompleteV2Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> LanguageGetAutocompleteV2Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of LanguageGetAutocompleteV2Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return LanguageGetAutocompleteV2Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = LanguageGetAutocompleteV2Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": LanguageGetAutocompleteV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": LanguageGetAutocompleteV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/language_get_autocomplete_v2_response_m_payload.py b/eZmaxApi/models/language_get_autocomplete_v2_response_m_payload.py index 841cc697c..914f11da6 100644 --- a/eZmaxApi/models/language_get_autocomplete_v2_response_m_payload.py +++ b/eZmaxApi/models/language_get_autocomplete_v2_response_m_payload.py @@ -19,41 +19,59 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.language_autocomplete_element_response import LanguageAutocompleteElementResponse +try: + from typing import Self +except ImportError: + from typing_extensions import Self class LanguageGetAutocompleteV2ResponseMPayload(BaseModel): """ - Payload for POST /2/object/language/getAutocomplete # noqa: E501 - """ - a_obj_language: conlist(LanguageAutocompleteElementResponse) = Field(..., alias="a_objLanguage", description="An array of Language autocomplete element response.") - __properties = ["a_objLanguage"] + Payload for POST /2/object/language/getAutocomplete + """ # noqa: E501 + a_obj_language: List[LanguageAutocompleteElementResponse] = Field(description="An array of Language autocomplete element response.", alias="a_objLanguage") + __properties: ClassVar[List[str]] = ["a_objLanguage"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> LanguageGetAutocompleteV2ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of LanguageGetAutocompleteV2ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_language (list) _items = [] if self.a_obj_language: @@ -64,16 +82,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> LanguageGetAutocompleteV2ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of LanguageGetAutocompleteV2ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return LanguageGetAutocompleteV2ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = LanguageGetAutocompleteV2ResponseMPayload.parse_obj({ - "a_obj_language": [LanguageAutocompleteElementResponse.from_dict(_item) for _item in obj.get("a_objLanguage")] if obj.get("a_objLanguage") is not None else None + _obj = cls.model_validate({ + "a_objLanguage": [LanguageAutocompleteElementResponse.from_dict(_item) for _item in obj.get("a_objLanguage")] if obj.get("a_objLanguage") is not None else None }) return _obj diff --git a/eZmaxApi/models/module_response.py b/eZmaxApi/models/module_response.py index a21e376a4..ce928b83b 100644 --- a/eZmaxApi/models/module_response.py +++ b/eZmaxApi/models/module_response.py @@ -19,63 +19,82 @@ import json - -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictBool, StrictStr +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class ModuleResponse(BaseModel): """ - A Module Object # noqa: E501 - """ - pki_module_id: conint(strict=True, ge=0) = Field(..., alias="pkiModuleID", description="The unique ID of the Module") - fki_modulegroup_id: conint(strict=True, le=255, ge=1) = Field(..., alias="fkiModulegroupID", description="The unique ID of the Modulegroup") - e_module_internalname: StrictStr = Field(..., alias="eModuleInternalname", description="The Internal name of the Module. This is theoretically an enum field but there are so many possibles values we decided not to list them all.") - s_module_name_x: StrictStr = Field(..., alias="sModuleNameX", description="The Name of the Module in the language of the requester") - b_module_registered: StrictBool = Field(..., alias="bModuleRegistered", description="Whether the Module is registered or not") - b_module_registeredapi: StrictBool = Field(..., alias="bModuleRegisteredapi", description="Whether the Module is registered or not for api use") - __properties = ["pkiModuleID", "fkiModulegroupID", "eModuleInternalname", "sModuleNameX", "bModuleRegistered", "bModuleRegisteredapi"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + A Module Object + """ # noqa: E501 + pki_module_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Module", alias="pkiModuleID") + fki_modulegroup_id: Annotated[int, Field(le=255, strict=True, ge=1)] = Field(description="The unique ID of the Modulegroup", alias="fkiModulegroupID") + e_module_internalname: StrictStr = Field(description="The Internal name of the Module. This is theoretically an enum field but there are so many possibles values we decided not to list them all.", alias="eModuleInternalname") + s_module_name_x: StrictStr = Field(description="The Name of the Module in the language of the requester", alias="sModuleNameX") + b_module_registered: StrictBool = Field(description="Whether the Module is registered or not", alias="bModuleRegistered") + b_module_registeredapi: StrictBool = Field(description="Whether the Module is registered or not for api use", alias="bModuleRegisteredapi") + __properties: ClassVar[List[str]] = ["pkiModuleID", "fkiModulegroupID", "eModuleInternalname", "sModuleNameX", "bModuleRegistered", "bModuleRegisteredapi"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> ModuleResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of ModuleResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> ModuleResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of ModuleResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return ModuleResponse.parse_obj(obj) - - _obj = ModuleResponse.parse_obj({ - "pki_module_id": obj.get("pkiModuleID"), - "fki_modulegroup_id": obj.get("fkiModulegroupID"), - "e_module_internalname": obj.get("eModuleInternalname"), - "s_module_name_x": obj.get("sModuleNameX"), - "b_module_registered": obj.get("bModuleRegistered"), - "b_module_registeredapi": obj.get("bModuleRegisteredapi") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiModuleID": obj.get("pkiModuleID"), + "fkiModulegroupID": obj.get("fkiModulegroupID"), + "eModuleInternalname": obj.get("eModuleInternalname"), + "sModuleNameX": obj.get("sModuleNameX"), + "bModuleRegistered": obj.get("bModuleRegistered"), + "bModuleRegisteredapi": obj.get("bModuleRegisteredapi") }) return _obj diff --git a/eZmaxApi/models/module_response_compound.py b/eZmaxApi/models/module_response_compound.py index 08d5f1be7..ac5b675b2 100644 --- a/eZmaxApi/models/module_response_compound.py +++ b/eZmaxApi/models/module_response_compound.py @@ -19,47 +19,66 @@ import json -from typing import List, Optional -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint, conlist +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, StrictStr +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.modulesection_response_compound import ModulesectionResponseCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class ModuleResponseCompound(BaseModel): """ - A Module Object # noqa: E501 - """ - pki_module_id: conint(strict=True, ge=0) = Field(..., alias="pkiModuleID", description="The unique ID of the Module") - fki_modulegroup_id: conint(strict=True, le=255, ge=1) = Field(..., alias="fkiModulegroupID", description="The unique ID of the Modulegroup") - e_module_internalname: StrictStr = Field(..., alias="eModuleInternalname", description="The Internal name of the Module. This is theoretically an enum field but there are so many possibles values we decided not to list them all.") - s_module_name_x: StrictStr = Field(..., alias="sModuleNameX", description="The Name of the Module in the language of the requester") - b_module_registered: StrictBool = Field(..., alias="bModuleRegistered", description="Whether the Module is registered or not") - b_module_registeredapi: StrictBool = Field(..., alias="bModuleRegisteredapi", description="Whether the Module is registered or not for api use") - a_obj_modulesection: Optional[conlist(ModulesectionResponseCompound)] = Field(None, alias="a_objModulesection") - __properties = ["pkiModuleID", "fkiModulegroupID", "eModuleInternalname", "sModuleNameX", "bModuleRegistered", "bModuleRegisteredapi", "a_objModulesection"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + A Module Object + """ # noqa: E501 + pki_module_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Module", alias="pkiModuleID") + fki_modulegroup_id: Annotated[int, Field(le=255, strict=True, ge=1)] = Field(description="The unique ID of the Modulegroup", alias="fkiModulegroupID") + e_module_internalname: StrictStr = Field(description="The Internal name of the Module. This is theoretically an enum field but there are so many possibles values we decided not to list them all.", alias="eModuleInternalname") + s_module_name_x: StrictStr = Field(description="The Name of the Module in the language of the requester", alias="sModuleNameX") + b_module_registered: StrictBool = Field(description="Whether the Module is registered or not", alias="bModuleRegistered") + b_module_registeredapi: StrictBool = Field(description="Whether the Module is registered or not for api use", alias="bModuleRegisteredapi") + a_obj_modulesection: Optional[List[ModulesectionResponseCompound]] = Field(default=None, alias="a_objModulesection") + __properties: ClassVar[List[str]] = ["pkiModuleID", "fkiModulegroupID", "eModuleInternalname", "sModuleNameX", "bModuleRegistered", "bModuleRegisteredapi", "a_objModulesection"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> ModuleResponseCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of ModuleResponseCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_modulesection (list) _items = [] if self.a_obj_modulesection: @@ -70,22 +89,22 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> ModuleResponseCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of ModuleResponseCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return ModuleResponseCompound.parse_obj(obj) - - _obj = ModuleResponseCompound.parse_obj({ - "pki_module_id": obj.get("pkiModuleID"), - "fki_modulegroup_id": obj.get("fkiModulegroupID"), - "e_module_internalname": obj.get("eModuleInternalname"), - "s_module_name_x": obj.get("sModuleNameX"), - "b_module_registered": obj.get("bModuleRegistered"), - "b_module_registeredapi": obj.get("bModuleRegisteredapi"), - "a_obj_modulesection": [ModulesectionResponseCompound.from_dict(_item) for _item in obj.get("a_objModulesection")] if obj.get("a_objModulesection") is not None else None + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiModuleID": obj.get("pkiModuleID"), + "fkiModulegroupID": obj.get("fkiModulegroupID"), + "eModuleInternalname": obj.get("eModuleInternalname"), + "sModuleNameX": obj.get("sModuleNameX"), + "bModuleRegistered": obj.get("bModuleRegistered"), + "bModuleRegisteredapi": obj.get("bModuleRegisteredapi"), + "a_objModulesection": [ModulesectionResponseCompound.from_dict(_item) for _item in obj.get("a_objModulesection")] if obj.get("a_objModulesection") is not None else None }) return _obj diff --git a/eZmaxApi/models/modulegroup_get_all_v1_response.py b/eZmaxApi/models/modulegroup_get_all_v1_response.py index 777b0c00b..38aab161a 100644 --- a/eZmaxApi/models/modulegroup_get_all_v1_response.py +++ b/eZmaxApi/models/modulegroup_get_all_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.modulegroup_get_all_v1_response_m_payload import ModulegroupGetAllV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class ModulegroupGetAllV1Response(BaseModel): """ - Response for GET /1/object/modulegroup/getAll # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: ModulegroupGetAllV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /1/object/modulegroup/getAll + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: ModulegroupGetAllV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> ModulegroupGetAllV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of ModulegroupGetAllV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> ModulegroupGetAllV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of ModulegroupGetAllV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return ModulegroupGetAllV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = ModulegroupGetAllV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": ModulegroupGetAllV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": ModulegroupGetAllV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/modulegroup_get_all_v1_response_m_payload.py b/eZmaxApi/models/modulegroup_get_all_v1_response_m_payload.py index 269d3d514..a301b3aed 100644 --- a/eZmaxApi/models/modulegroup_get_all_v1_response_m_payload.py +++ b/eZmaxApi/models/modulegroup_get_all_v1_response_m_payload.py @@ -19,41 +19,59 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.modulegroup_response_compound import ModulegroupResponseCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class ModulegroupGetAllV1ResponseMPayload(BaseModel): """ - Response for GET /1/object/modulegroup/getAll # noqa: E501 - """ - a_obj_modulegroup: conlist(ModulegroupResponseCompound) = Field(..., alias="a_objModulegroup") - __properties = ["a_objModulegroup"] + Response for GET /1/object/modulegroup/getAll + """ # noqa: E501 + a_obj_modulegroup: List[ModulegroupResponseCompound] = Field(alias="a_objModulegroup") + __properties: ClassVar[List[str]] = ["a_objModulegroup"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> ModulegroupGetAllV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of ModulegroupGetAllV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_modulegroup (list) _items = [] if self.a_obj_modulegroup: @@ -64,16 +82,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> ModulegroupGetAllV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of ModulegroupGetAllV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return ModulegroupGetAllV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = ModulegroupGetAllV1ResponseMPayload.parse_obj({ - "a_obj_modulegroup": [ModulegroupResponseCompound.from_dict(_item) for _item in obj.get("a_objModulegroup")] if obj.get("a_objModulegroup") is not None else None + _obj = cls.model_validate({ + "a_objModulegroup": [ModulegroupResponseCompound.from_dict(_item) for _item in obj.get("a_objModulegroup")] if obj.get("a_objModulegroup") is not None else None }) return _obj diff --git a/eZmaxApi/models/modulegroup_response.py b/eZmaxApi/models/modulegroup_response.py index b23b9df12..96897071b 100644 --- a/eZmaxApi/models/modulegroup_response.py +++ b/eZmaxApi/models/modulegroup_response.py @@ -19,62 +19,81 @@ import json - -from pydantic import BaseModel, Field, conint, constr, validator +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, field_validator +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class ModulegroupResponse(BaseModel): """ - A Modulegroup Object # noqa: E501 - """ - pki_modulegroup_id: conint(strict=True, le=255, ge=1) = Field(..., alias="pkiModulegroupID", description="The unique ID of the Modulegroup") - s_modulegroup_name_x: constr(strict=True) = Field(..., alias="sModulegroupNameX", description="The name of the Modulegroup in the language of the requester") - __properties = ["pkiModulegroupID", "sModulegroupNameX"] + A Modulegroup Object + """ # noqa: E501 + pki_modulegroup_id: Annotated[int, Field(le=255, strict=True, ge=1)] = Field(description="The unique ID of the Modulegroup", alias="pkiModulegroupID") + s_modulegroup_name_x: Annotated[str, Field(strict=True)] = Field(description="The name of the Modulegroup in the language of the requester", alias="sModulegroupNameX") + __properties: ClassVar[List[str]] = ["pkiModulegroupID", "sModulegroupNameX"] - @validator('s_modulegroup_name_x') + @field_validator('s_modulegroup_name_x') def s_modulegroup_name_x_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^.{0,25}$", value): raise ValueError(r"must validate the regular expression /^.{0,25}$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> ModulegroupResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of ModulegroupResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> ModulegroupResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of ModulegroupResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return ModulegroupResponse.parse_obj(obj) + return cls.model_validate(obj) - _obj = ModulegroupResponse.parse_obj({ - "pki_modulegroup_id": obj.get("pkiModulegroupID"), - "s_modulegroup_name_x": obj.get("sModulegroupNameX") + _obj = cls.model_validate({ + "pkiModulegroupID": obj.get("pkiModulegroupID"), + "sModulegroupNameX": obj.get("sModulegroupNameX") }) return _obj diff --git a/eZmaxApi/models/modulegroup_response_compound.py b/eZmaxApi/models/modulegroup_response_compound.py index 573ad2aa5..0e1f06420 100644 --- a/eZmaxApi/models/modulegroup_response_compound.py +++ b/eZmaxApi/models/modulegroup_response_compound.py @@ -19,50 +19,69 @@ import json -from typing import List, Optional -from pydantic import BaseModel, Field, conint, conlist, constr, validator +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, field_validator +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.module_response_compound import ModuleResponseCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class ModulegroupResponseCompound(BaseModel): """ - A Modulegroup Object # noqa: E501 - """ - pki_modulegroup_id: conint(strict=True, le=255, ge=1) = Field(..., alias="pkiModulegroupID", description="The unique ID of the Modulegroup") - s_modulegroup_name_x: constr(strict=True) = Field(..., alias="sModulegroupNameX", description="The name of the Modulegroup in the language of the requester") - a_obj_module: Optional[conlist(ModuleResponseCompound)] = Field(None, alias="a_objModule") - __properties = ["pkiModulegroupID", "sModulegroupNameX", "a_objModule"] - - @validator('s_modulegroup_name_x') + A Modulegroup Object + """ # noqa: E501 + pki_modulegroup_id: Annotated[int, Field(le=255, strict=True, ge=1)] = Field(description="The unique ID of the Modulegroup", alias="pkiModulegroupID") + s_modulegroup_name_x: Annotated[str, Field(strict=True)] = Field(description="The name of the Modulegroup in the language of the requester", alias="sModulegroupNameX") + a_obj_module: Optional[List[ModuleResponseCompound]] = Field(default=None, alias="a_objModule") + __properties: ClassVar[List[str]] = ["pkiModulegroupID", "sModulegroupNameX", "a_objModule"] + + @field_validator('s_modulegroup_name_x') def s_modulegroup_name_x_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^.{0,25}$", value): raise ValueError(r"must validate the regular expression /^.{0,25}$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> ModulegroupResponseCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of ModulegroupResponseCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_module (list) _items = [] if self.a_obj_module: @@ -73,18 +92,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> ModulegroupResponseCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of ModulegroupResponseCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return ModulegroupResponseCompound.parse_obj(obj) + return cls.model_validate(obj) - _obj = ModulegroupResponseCompound.parse_obj({ - "pki_modulegroup_id": obj.get("pkiModulegroupID"), - "s_modulegroup_name_x": obj.get("sModulegroupNameX"), - "a_obj_module": [ModuleResponseCompound.from_dict(_item) for _item in obj.get("a_objModule")] if obj.get("a_objModule") is not None else None + _obj = cls.model_validate({ + "pkiModulegroupID": obj.get("pkiModulegroupID"), + "sModulegroupNameX": obj.get("sModulegroupNameX"), + "a_objModule": [ModuleResponseCompound.from_dict(_item) for _item in obj.get("a_objModule")] if obj.get("a_objModule") is not None else None }) return _obj diff --git a/eZmaxApi/models/modulesection_response.py b/eZmaxApi/models/modulesection_response.py index 65903c5c9..e84f0667a 100644 --- a/eZmaxApi/models/modulesection_response.py +++ b/eZmaxApi/models/modulesection_response.py @@ -19,59 +19,78 @@ import json - -from pydantic import BaseModel, Field, StrictStr, conint +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictStr +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class ModulesectionResponse(BaseModel): """ - A Modulesection Object # noqa: E501 - """ - pki_modulesection_id: conint(strict=True, ge=0) = Field(..., alias="pkiModulesectionID", description="The unique ID of the Modulesection") - fki_module_id: conint(strict=True, ge=0) = Field(..., alias="fkiModuleID", description="The unique ID of the Module") - s_modulesection_internalname: StrictStr = Field(..., alias="sModulesectionInternalname", description="The Internal name of the Module section.") - s_modulesection_name_x: StrictStr = Field(..., alias="sModulesectionNameX", description="The Name of the Modulesection in the language of the requester") - __properties = ["pkiModulesectionID", "fkiModuleID", "sModulesectionInternalname", "sModulesectionNameX"] + A Modulesection Object + """ # noqa: E501 + pki_modulesection_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Modulesection", alias="pkiModulesectionID") + fki_module_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Module", alias="fkiModuleID") + s_modulesection_internalname: StrictStr = Field(description="The Internal name of the Module section.", alias="sModulesectionInternalname") + s_modulesection_name_x: StrictStr = Field(description="The Name of the Modulesection in the language of the requester", alias="sModulesectionNameX") + __properties: ClassVar[List[str]] = ["pkiModulesectionID", "fkiModuleID", "sModulesectionInternalname", "sModulesectionNameX"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> ModulesectionResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of ModulesectionResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> ModulesectionResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of ModulesectionResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return ModulesectionResponse.parse_obj(obj) + return cls.model_validate(obj) - _obj = ModulesectionResponse.parse_obj({ - "pki_modulesection_id": obj.get("pkiModulesectionID"), - "fki_module_id": obj.get("fkiModuleID"), - "s_modulesection_internalname": obj.get("sModulesectionInternalname"), - "s_modulesection_name_x": obj.get("sModulesectionNameX") + _obj = cls.model_validate({ + "pkiModulesectionID": obj.get("pkiModulesectionID"), + "fkiModuleID": obj.get("fkiModuleID"), + "sModulesectionInternalname": obj.get("sModulesectionInternalname"), + "sModulesectionNameX": obj.get("sModulesectionNameX") }) return _obj diff --git a/eZmaxApi/models/modulesection_response_compound.py b/eZmaxApi/models/modulesection_response_compound.py index 7052b06a3..1c833f1a0 100644 --- a/eZmaxApi/models/modulesection_response_compound.py +++ b/eZmaxApi/models/modulesection_response_compound.py @@ -19,45 +19,64 @@ import json -from typing import List, Optional -from pydantic import BaseModel, Field, StrictStr, conint, conlist +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictStr +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.permission_response_compound import PermissionResponseCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class ModulesectionResponseCompound(BaseModel): """ - A Modulesection Object # noqa: E501 - """ - pki_modulesection_id: conint(strict=True, ge=0) = Field(..., alias="pkiModulesectionID", description="The unique ID of the Modulesection") - fki_module_id: conint(strict=True, ge=0) = Field(..., alias="fkiModuleID", description="The unique ID of the Module") - s_modulesection_internalname: StrictStr = Field(..., alias="sModulesectionInternalname", description="The Internal name of the Module section.") - s_modulesection_name_x: StrictStr = Field(..., alias="sModulesectionNameX", description="The Name of the Modulesection in the language of the requester") - a_obj_permission: Optional[conlist(PermissionResponseCompound)] = Field(None, alias="a_objPermission") - __properties = ["pkiModulesectionID", "fkiModuleID", "sModulesectionInternalname", "sModulesectionNameX", "a_objPermission"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + A Modulesection Object + """ # noqa: E501 + pki_modulesection_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Modulesection", alias="pkiModulesectionID") + fki_module_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Module", alias="fkiModuleID") + s_modulesection_internalname: StrictStr = Field(description="The Internal name of the Module section.", alias="sModulesectionInternalname") + s_modulesection_name_x: StrictStr = Field(description="The Name of the Modulesection in the language of the requester", alias="sModulesectionNameX") + a_obj_permission: Optional[List[PermissionResponseCompound]] = Field(default=None, alias="a_objPermission") + __properties: ClassVar[List[str]] = ["pkiModulesectionID", "fkiModuleID", "sModulesectionInternalname", "sModulesectionNameX", "a_objPermission"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> ModulesectionResponseCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of ModulesectionResponseCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_permission (list) _items = [] if self.a_obj_permission: @@ -68,20 +87,20 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> ModulesectionResponseCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of ModulesectionResponseCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return ModulesectionResponseCompound.parse_obj(obj) - - _obj = ModulesectionResponseCompound.parse_obj({ - "pki_modulesection_id": obj.get("pkiModulesectionID"), - "fki_module_id": obj.get("fkiModuleID"), - "s_modulesection_internalname": obj.get("sModulesectionInternalname"), - "s_modulesection_name_x": obj.get("sModulesectionNameX"), - "a_obj_permission": [PermissionResponseCompound.from_dict(_item) for _item in obj.get("a_objPermission")] if obj.get("a_objPermission") is not None else None + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiModulesectionID": obj.get("pkiModulesectionID"), + "fkiModuleID": obj.get("fkiModuleID"), + "sModulesectionInternalname": obj.get("sModulesectionInternalname"), + "sModulesectionNameX": obj.get("sModulesectionNameX"), + "a_objPermission": [PermissionResponseCompound.from_dict(_item) for _item in obj.get("a_objPermission")] if obj.get("a_objPermission") is not None else None }) return _obj diff --git a/eZmaxApi/models/multilingual_apikey_description.py b/eZmaxApi/models/multilingual_apikey_description.py index 74022d62b..a71e56df4 100644 --- a/eZmaxApi/models/multilingual_apikey_description.py +++ b/eZmaxApi/models/multilingual_apikey_description.py @@ -19,55 +19,73 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictStr +from pydantic import Field +try: + from typing import Self +except ImportError: + from typing_extensions import Self class MultilingualApikeyDescription(BaseModel): """ - Description of the API Key # noqa: E501 - """ - s_apikey_description1: Optional[StrictStr] = Field(None, alias="sApikeyDescription1", description="The description of the Apikey in French") - s_apikey_description2: Optional[StrictStr] = Field(None, alias="sApikeyDescription2", description="The description of the Apikey in English") - __properties = ["sApikeyDescription1", "sApikeyDescription2"] + Description of the API Key + """ # noqa: E501 + s_apikey_description1: Optional[StrictStr] = Field(default=None, description="The description of the Apikey in French", alias="sApikeyDescription1") + s_apikey_description2: Optional[StrictStr] = Field(default=None, description="The description of the Apikey in English", alias="sApikeyDescription2") + __properties: ClassVar[List[str]] = ["sApikeyDescription1", "sApikeyDescription2"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> MultilingualApikeyDescription: + def from_json(cls, json_str: str) -> Self: """Create an instance of MultilingualApikeyDescription from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> MultilingualApikeyDescription: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of MultilingualApikeyDescription from a dict""" if obj is None: return None if not isinstance(obj, dict): - return MultilingualApikeyDescription.parse_obj(obj) + return cls.model_validate(obj) - _obj = MultilingualApikeyDescription.parse_obj({ - "s_apikey_description1": obj.get("sApikeyDescription1"), - "s_apikey_description2": obj.get("sApikeyDescription2") + _obj = cls.model_validate({ + "sApikeyDescription1": obj.get("sApikeyDescription1"), + "sApikeyDescription2": obj.get("sApikeyDescription2") }) return _obj diff --git a/eZmaxApi/models/multilingual_billingentityinternal_description.py b/eZmaxApi/models/multilingual_billingentityinternal_description.py index 5b76fbe7f..67011b8af 100644 --- a/eZmaxApi/models/multilingual_billingentityinternal_description.py +++ b/eZmaxApi/models/multilingual_billingentityinternal_description.py @@ -19,18 +19,24 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, constr, validator +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, field_validator +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class MultilingualBillingentityinternalDescription(BaseModel): """ - The description of the Billingentityinternal # noqa: E501 - """ - s_billingentityinternal_description1: Optional[constr(strict=True)] = Field(None, alias="sBillingentityinternalDescription1", description="The description of the Billingentityinternal in French") - s_billingentityinternal_description2: Optional[constr(strict=True)] = Field(None, alias="sBillingentityinternalDescription2", description="The description of the Billingentityinternal in English") - __properties = ["sBillingentityinternalDescription1", "sBillingentityinternalDescription2"] + The description of the Billingentityinternal + """ # noqa: E501 + s_billingentityinternal_description1: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="The description of the Billingentityinternal in French", alias="sBillingentityinternalDescription1") + s_billingentityinternal_description2: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="The description of the Billingentityinternal in English", alias="sBillingentityinternalDescription2") + __properties: ClassVar[List[str]] = ["sBillingentityinternalDescription1", "sBillingentityinternalDescription2"] - @validator('s_billingentityinternal_description1') + @field_validator('s_billingentityinternal_description1') def s_billingentityinternal_description1_validate_regular_expression(cls, value): """Validates the regular expression""" if value is None: @@ -40,7 +46,7 @@ def s_billingentityinternal_description1_validate_regular_expression(cls, value) raise ValueError(r"must validate the regular expression /^.{0,70}$/") return value - @validator('s_billingentityinternal_description2') + @field_validator('s_billingentityinternal_description2') def s_billingentityinternal_description2_validate_regular_expression(cls, value): """Validates the regular expression""" if value is None: @@ -50,44 +56,57 @@ def s_billingentityinternal_description2_validate_regular_expression(cls, value) raise ValueError(r"must validate the regular expression /^.{0,70}$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> MultilingualBillingentityinternalDescription: + def from_json(cls, json_str: str) -> Self: """Create an instance of MultilingualBillingentityinternalDescription from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> MultilingualBillingentityinternalDescription: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of MultilingualBillingentityinternalDescription from a dict""" if obj is None: return None if not isinstance(obj, dict): - return MultilingualBillingentityinternalDescription.parse_obj(obj) + return cls.model_validate(obj) - _obj = MultilingualBillingentityinternalDescription.parse_obj({ - "s_billingentityinternal_description1": obj.get("sBillingentityinternalDescription1"), - "s_billingentityinternal_description2": obj.get("sBillingentityinternalDescription2") + _obj = cls.model_validate({ + "sBillingentityinternalDescription1": obj.get("sBillingentityinternalDescription1"), + "sBillingentityinternalDescription2": obj.get("sBillingentityinternalDescription2") }) return _obj diff --git a/eZmaxApi/models/multilingual_branding_description.py b/eZmaxApi/models/multilingual_branding_description.py index 389bcc603..ff9293326 100644 --- a/eZmaxApi/models/multilingual_branding_description.py +++ b/eZmaxApi/models/multilingual_branding_description.py @@ -19,55 +19,73 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictStr +from pydantic import Field +try: + from typing import Self +except ImportError: + from typing_extensions import Self class MultilingualBrandingDescription(BaseModel): """ - Description of the Branding # noqa: E501 - """ - s_branding_description1: Optional[StrictStr] = Field(None, alias="sBrandingDescription1", description="The description of the Branding in French") - s_branding_description2: Optional[StrictStr] = Field(None, alias="sBrandingDescription2", description="The description of the Branding in English") - __properties = ["sBrandingDescription1", "sBrandingDescription2"] + Description of the Branding + """ # noqa: E501 + s_branding_description1: Optional[StrictStr] = Field(default=None, description="The description of the Branding in French", alias="sBrandingDescription1") + s_branding_description2: Optional[StrictStr] = Field(default=None, description="The description of the Branding in English", alias="sBrandingDescription2") + __properties: ClassVar[List[str]] = ["sBrandingDescription1", "sBrandingDescription2"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> MultilingualBrandingDescription: + def from_json(cls, json_str: str) -> Self: """Create an instance of MultilingualBrandingDescription from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> MultilingualBrandingDescription: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of MultilingualBrandingDescription from a dict""" if obj is None: return None if not isinstance(obj, dict): - return MultilingualBrandingDescription.parse_obj(obj) + return cls.model_validate(obj) - _obj = MultilingualBrandingDescription.parse_obj({ - "s_branding_description1": obj.get("sBrandingDescription1"), - "s_branding_description2": obj.get("sBrandingDescription2") + _obj = cls.model_validate({ + "sBrandingDescription1": obj.get("sBrandingDescription1"), + "sBrandingDescription2": obj.get("sBrandingDescription2") }) return _obj diff --git a/eZmaxApi/models/multilingual_ezmaxinvoicingsummaryinternal_description.py b/eZmaxApi/models/multilingual_ezmaxinvoicingsummaryinternal_description.py index 1fa45991f..6d5b67bbc 100644 --- a/eZmaxApi/models/multilingual_ezmaxinvoicingsummaryinternal_description.py +++ b/eZmaxApi/models/multilingual_ezmaxinvoicingsummaryinternal_description.py @@ -19,55 +19,74 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, constr +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class MultilingualEzmaxinvoicingsummaryinternalDescription(BaseModel): """ - Description of the Ezmaxinvoicingsummaryinternal # noqa: E501 - """ - s_ezmaxinvoicingsummaryinternal_description1: Optional[constr(strict=True, max_length=70)] = Field(None, alias="sEzmaxinvoicingsummaryinternalDescription1", description="The Ezmaxinvoicingsummaryinternal description in French") - s_ezmaxinvoicingsummaryinternal_description2: Optional[constr(strict=True, max_length=70)] = Field(None, alias="sEzmaxinvoicingsummaryinternalDescription2", description="The Ezmaxinvoicingsummaryinternal description in English") - __properties = ["sEzmaxinvoicingsummaryinternalDescription1", "sEzmaxinvoicingsummaryinternalDescription2"] + Description of the Ezmaxinvoicingsummaryinternal + """ # noqa: E501 + s_ezmaxinvoicingsummaryinternal_description1: Optional[Annotated[str, Field(strict=True, max_length=70)]] = Field(default=None, description="The Ezmaxinvoicingsummaryinternal description in French", alias="sEzmaxinvoicingsummaryinternalDescription1") + s_ezmaxinvoicingsummaryinternal_description2: Optional[Annotated[str, Field(strict=True, max_length=70)]] = Field(default=None, description="The Ezmaxinvoicingsummaryinternal description in English", alias="sEzmaxinvoicingsummaryinternalDescription2") + __properties: ClassVar[List[str]] = ["sEzmaxinvoicingsummaryinternalDescription1", "sEzmaxinvoicingsummaryinternalDescription2"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> MultilingualEzmaxinvoicingsummaryinternalDescription: + def from_json(cls, json_str: str) -> Self: """Create an instance of MultilingualEzmaxinvoicingsummaryinternalDescription from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> MultilingualEzmaxinvoicingsummaryinternalDescription: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of MultilingualEzmaxinvoicingsummaryinternalDescription from a dict""" if obj is None: return None if not isinstance(obj, dict): - return MultilingualEzmaxinvoicingsummaryinternalDescription.parse_obj(obj) + return cls.model_validate(obj) - _obj = MultilingualEzmaxinvoicingsummaryinternalDescription.parse_obj({ - "s_ezmaxinvoicingsummaryinternal_description1": obj.get("sEzmaxinvoicingsummaryinternalDescription1"), - "s_ezmaxinvoicingsummaryinternal_description2": obj.get("sEzmaxinvoicingsummaryinternalDescription2") + _obj = cls.model_validate({ + "sEzmaxinvoicingsummaryinternalDescription1": obj.get("sEzmaxinvoicingsummaryinternalDescription1"), + "sEzmaxinvoicingsummaryinternalDescription2": obj.get("sEzmaxinvoicingsummaryinternalDescription2") }) return _obj diff --git a/eZmaxApi/models/multilingual_ezsignfoldertype_name.py b/eZmaxApi/models/multilingual_ezsignfoldertype_name.py index e316e1e21..8aa172d90 100644 --- a/eZmaxApi/models/multilingual_ezsignfoldertype_name.py +++ b/eZmaxApi/models/multilingual_ezsignfoldertype_name.py @@ -19,55 +19,73 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictStr +from pydantic import Field +try: + from typing import Self +except ImportError: + from typing_extensions import Self class MultilingualEzsignfoldertypeName(BaseModel): """ - Name of the Ezsignfoldertype # noqa: E501 - """ - s_ezsignfoldertype_name1: Optional[StrictStr] = Field(None, alias="sEzsignfoldertypeName1", description="The name of the Ezsignfoldertype in French") - s_ezsignfoldertype_name2: Optional[StrictStr] = Field(None, alias="sEzsignfoldertypeName2", description="The name of the Ezsignfoldertype in English") - __properties = ["sEzsignfoldertypeName1", "sEzsignfoldertypeName2"] + Name of the Ezsignfoldertype + """ # noqa: E501 + s_ezsignfoldertype_name1: Optional[StrictStr] = Field(default=None, description="The name of the Ezsignfoldertype in French", alias="sEzsignfoldertypeName1") + s_ezsignfoldertype_name2: Optional[StrictStr] = Field(default=None, description="The name of the Ezsignfoldertype in English", alias="sEzsignfoldertypeName2") + __properties: ClassVar[List[str]] = ["sEzsignfoldertypeName1", "sEzsignfoldertypeName2"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> MultilingualEzsignfoldertypeName: + def from_json(cls, json_str: str) -> Self: """Create an instance of MultilingualEzsignfoldertypeName from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> MultilingualEzsignfoldertypeName: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of MultilingualEzsignfoldertypeName from a dict""" if obj is None: return None if not isinstance(obj, dict): - return MultilingualEzsignfoldertypeName.parse_obj(obj) + return cls.model_validate(obj) - _obj = MultilingualEzsignfoldertypeName.parse_obj({ - "s_ezsignfoldertype_name1": obj.get("sEzsignfoldertypeName1"), - "s_ezsignfoldertype_name2": obj.get("sEzsignfoldertypeName2") + _obj = cls.model_validate({ + "sEzsignfoldertypeName1": obj.get("sEzsignfoldertypeName1"), + "sEzsignfoldertypeName2": obj.get("sEzsignfoldertypeName2") }) return _obj diff --git a/eZmaxApi/models/multilingual_ezsignsignergroup_description.py b/eZmaxApi/models/multilingual_ezsignsignergroup_description.py index e12971f6d..2915a3ee8 100644 --- a/eZmaxApi/models/multilingual_ezsignsignergroup_description.py +++ b/eZmaxApi/models/multilingual_ezsignsignergroup_description.py @@ -19,55 +19,73 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictStr +from pydantic import Field +try: + from typing import Self +except ImportError: + from typing_extensions import Self class MultilingualEzsignsignergroupDescription(BaseModel): """ - Description of the Ezsignsignergroup # noqa: E501 - """ - s_ezsignsignergroup_description1: Optional[StrictStr] = Field(None, alias="sEzsignsignergroupDescription1", description="The description of the Ezsignsignergroup in French") - s_ezsignsignergroup_description2: Optional[StrictStr] = Field(None, alias="sEzsignsignergroupDescription2", description="The description of the Ezsignsignergroup in English") - __properties = ["sEzsignsignergroupDescription1", "sEzsignsignergroupDescription2"] + Description of the Ezsignsignergroup + """ # noqa: E501 + s_ezsignsignergroup_description1: Optional[StrictStr] = Field(default=None, description="The description of the Ezsignsignergroup in French", alias="sEzsignsignergroupDescription1") + s_ezsignsignergroup_description2: Optional[StrictStr] = Field(default=None, description="The description of the Ezsignsignergroup in English", alias="sEzsignsignergroupDescription2") + __properties: ClassVar[List[str]] = ["sEzsignsignergroupDescription1", "sEzsignsignergroupDescription2"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> MultilingualEzsignsignergroupDescription: + def from_json(cls, json_str: str) -> Self: """Create an instance of MultilingualEzsignsignergroupDescription from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> MultilingualEzsignsignergroupDescription: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of MultilingualEzsignsignergroupDescription from a dict""" if obj is None: return None if not isinstance(obj, dict): - return MultilingualEzsignsignergroupDescription.parse_obj(obj) + return cls.model_validate(obj) - _obj = MultilingualEzsignsignergroupDescription.parse_obj({ - "s_ezsignsignergroup_description1": obj.get("sEzsignsignergroupDescription1"), - "s_ezsignsignergroup_description2": obj.get("sEzsignsignergroupDescription2") + _obj = cls.model_validate({ + "sEzsignsignergroupDescription1": obj.get("sEzsignsignergroupDescription1"), + "sEzsignsignergroupDescription2": obj.get("sEzsignsignergroupDescription2") }) return _obj diff --git a/eZmaxApi/models/multilingual_ezsignsigningreason_description.py b/eZmaxApi/models/multilingual_ezsignsigningreason_description.py new file mode 100644 index 000000000..846f8975d --- /dev/null +++ b/eZmaxApi/models/multilingual_ezsignsigningreason_description.py @@ -0,0 +1,113 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, field_validator +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self + +class MultilingualEzsignsigningreasonDescription(BaseModel): + """ + The description of the Ezsignsigningreason + """ # noqa: E501 + s_ezsignsigningreason_description1: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="The description of the Ezsignsigningreason in French", alias="sEzsignsigningreasonDescription1") + s_ezsignsigningreason_description2: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="The description of the Ezsignsigningreason in English", alias="sEzsignsigningreasonDescription2") + __properties: ClassVar[List[str]] = ["sEzsignsigningreasonDescription1", "sEzsignsigningreasonDescription2"] + + @field_validator('s_ezsignsigningreason_description1') + def s_ezsignsigningreason_description1_validate_regular_expression(cls, value): + """Validates the regular expression""" + if value is None: + return value + + if not re.match(r"^.{0,50}$", value): + raise ValueError(r"must validate the regular expression /^.{0,50}$/") + return value + + @field_validator('s_ezsignsigningreason_description2') + def s_ezsignsigningreason_description2_validate_regular_expression(cls, value): + """Validates the regular expression""" + if value is None: + return value + + if not re.match(r"^.{0,50}$", value): + raise ValueError(r"must validate the regular expression /^.{0,50}$/") + return value + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of MultilingualEzsignsigningreasonDescription from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Dict) -> Self: + """Create an instance of MultilingualEzsignsigningreasonDescription from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "sEzsignsigningreasonDescription1": obj.get("sEzsignsigningreasonDescription1"), + "sEzsignsigningreasonDescription2": obj.get("sEzsignsigningreasonDescription2") + }) + return _obj + + diff --git a/eZmaxApi/models/multilingual_notificationsubsection_name.py b/eZmaxApi/models/multilingual_notificationsubsection_name.py index ecbf4050d..e0b599e2f 100644 --- a/eZmaxApi/models/multilingual_notificationsubsection_name.py +++ b/eZmaxApi/models/multilingual_notificationsubsection_name.py @@ -19,55 +19,73 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictStr +from pydantic import Field +try: + from typing import Self +except ImportError: + from typing_extensions import Self class MultilingualNotificationsubsectionName(BaseModel): """ - Name of the Notificationsubsection # noqa: E501 - """ - s_notificationsubsection_name1: Optional[StrictStr] = Field(None, alias="sNotificationsubsectionName1", description="The name of the Notificationsubsection in French") - s_notificationsubsection_name2: Optional[StrictStr] = Field(None, alias="sNotificationsubsectionName2", description="The name of the Notificationsubsection in English") - __properties = ["sNotificationsubsectionName1", "sNotificationsubsectionName2"] + Name of the Notificationsubsection + """ # noqa: E501 + s_notificationsubsection_name1: Optional[StrictStr] = Field(default=None, description="The name of the Notificationsubsection in French", alias="sNotificationsubsectionName1") + s_notificationsubsection_name2: Optional[StrictStr] = Field(default=None, description="The name of the Notificationsubsection in English", alias="sNotificationsubsectionName2") + __properties: ClassVar[List[str]] = ["sNotificationsubsectionName1", "sNotificationsubsectionName2"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> MultilingualNotificationsubsectionName: + def from_json(cls, json_str: str) -> Self: """Create an instance of MultilingualNotificationsubsectionName from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> MultilingualNotificationsubsectionName: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of MultilingualNotificationsubsectionName from a dict""" if obj is None: return None if not isinstance(obj, dict): - return MultilingualNotificationsubsectionName.parse_obj(obj) + return cls.model_validate(obj) - _obj = MultilingualNotificationsubsectionName.parse_obj({ - "s_notificationsubsection_name1": obj.get("sNotificationsubsectionName1"), - "s_notificationsubsection_name2": obj.get("sNotificationsubsectionName2") + _obj = cls.model_validate({ + "sNotificationsubsectionName1": obj.get("sNotificationsubsectionName1"), + "sNotificationsubsectionName2": obj.get("sNotificationsubsectionName2") }) return _obj diff --git a/eZmaxApi/models/multilingual_notificationtest_name.py b/eZmaxApi/models/multilingual_notificationtest_name.py index 050699e79..f5fd7a8a8 100644 --- a/eZmaxApi/models/multilingual_notificationtest_name.py +++ b/eZmaxApi/models/multilingual_notificationtest_name.py @@ -19,55 +19,73 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictStr +from pydantic import Field +try: + from typing import Self +except ImportError: + from typing_extensions import Self class MultilingualNotificationtestName(BaseModel): """ - Name of the Notificationtest # noqa: E501 - """ - s_notificationtest_name1: Optional[StrictStr] = Field(None, alias="sNotificationtestName1", description="The name of the Notificationtest in French") - s_notificationtest_name2: Optional[StrictStr] = Field(None, alias="sNotificationtestName2", description="The name of the Notificationtest in English") - __properties = ["sNotificationtestName1", "sNotificationtestName2"] + Name of the Notificationtest + """ # noqa: E501 + s_notificationtest_name1: Optional[StrictStr] = Field(default=None, description="The name of the Notificationtest in French", alias="sNotificationtestName1") + s_notificationtest_name2: Optional[StrictStr] = Field(default=None, description="The name of the Notificationtest in English", alias="sNotificationtestName2") + __properties: ClassVar[List[str]] = ["sNotificationtestName1", "sNotificationtestName2"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> MultilingualNotificationtestName: + def from_json(cls, json_str: str) -> Self: """Create an instance of MultilingualNotificationtestName from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> MultilingualNotificationtestName: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of MultilingualNotificationtestName from a dict""" if obj is None: return None if not isinstance(obj, dict): - return MultilingualNotificationtestName.parse_obj(obj) + return cls.model_validate(obj) - _obj = MultilingualNotificationtestName.parse_obj({ - "s_notificationtest_name1": obj.get("sNotificationtestName1"), - "s_notificationtest_name2": obj.get("sNotificationtestName2") + _obj = cls.model_validate({ + "sNotificationtestName1": obj.get("sNotificationtestName1"), + "sNotificationtestName2": obj.get("sNotificationtestName2") }) return _obj diff --git a/eZmaxApi/models/multilingual_paymentterm_description.py b/eZmaxApi/models/multilingual_paymentterm_description.py index d2c1f8c38..79b59734e 100644 --- a/eZmaxApi/models/multilingual_paymentterm_description.py +++ b/eZmaxApi/models/multilingual_paymentterm_description.py @@ -19,18 +19,24 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, constr, validator +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, field_validator +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class MultilingualPaymenttermDescription(BaseModel): """ - Description of the Paymentterm # noqa: E501 - """ - s_paymentterm_description1: Optional[constr(strict=True)] = Field(None, alias="sPaymenttermDescription1", description="The description of the Paymentterm in French") - s_paymentterm_description2: Optional[constr(strict=True)] = Field(None, alias="sPaymenttermDescription2", description="The description of the Paymentterm in English") - __properties = ["sPaymenttermDescription1", "sPaymenttermDescription2"] + Description of the Paymentterm + """ # noqa: E501 + s_paymentterm_description1: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="The description of the Paymentterm in French", alias="sPaymenttermDescription1") + s_paymentterm_description2: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="The description of the Paymentterm in English", alias="sPaymenttermDescription2") + __properties: ClassVar[List[str]] = ["sPaymenttermDescription1", "sPaymenttermDescription2"] - @validator('s_paymentterm_description1') + @field_validator('s_paymentterm_description1') def s_paymentterm_description1_validate_regular_expression(cls, value): """Validates the regular expression""" if value is None: @@ -40,7 +46,7 @@ def s_paymentterm_description1_validate_regular_expression(cls, value): raise ValueError(r"must validate the regular expression /^.{1,40}$/") return value - @validator('s_paymentterm_description2') + @field_validator('s_paymentterm_description2') def s_paymentterm_description2_validate_regular_expression(cls, value): """Validates the regular expression""" if value is None: @@ -50,44 +56,57 @@ def s_paymentterm_description2_validate_regular_expression(cls, value): raise ValueError(r"must validate the regular expression /^.{1,40}$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> MultilingualPaymenttermDescription: + def from_json(cls, json_str: str) -> Self: """Create an instance of MultilingualPaymenttermDescription from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> MultilingualPaymenttermDescription: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of MultilingualPaymenttermDescription from a dict""" if obj is None: return None if not isinstance(obj, dict): - return MultilingualPaymenttermDescription.parse_obj(obj) + return cls.model_validate(obj) - _obj = MultilingualPaymenttermDescription.parse_obj({ - "s_paymentterm_description1": obj.get("sPaymenttermDescription1"), - "s_paymentterm_description2": obj.get("sPaymenttermDescription2") + _obj = cls.model_validate({ + "sPaymenttermDescription1": obj.get("sPaymenttermDescription1"), + "sPaymenttermDescription2": obj.get("sPaymenttermDescription2") }) return _obj diff --git a/eZmaxApi/models/multilingual_subnet_description.py b/eZmaxApi/models/multilingual_subnet_description.py index 23ff2c1f2..e98f849ba 100644 --- a/eZmaxApi/models/multilingual_subnet_description.py +++ b/eZmaxApi/models/multilingual_subnet_description.py @@ -19,18 +19,24 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, constr, validator +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, field_validator +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class MultilingualSubnetDescription(BaseModel): """ - The description of the Subnet # noqa: E501 - """ - s_subnet_description1: Optional[constr(strict=True)] = Field(None, alias="sSubnetDescription1", description="The description of the Subnet in French") - s_subnet_description2: Optional[constr(strict=True)] = Field(None, alias="sSubnetDescription2", description="The description of the Subnet in English") - __properties = ["sSubnetDescription1", "sSubnetDescription2"] + The description of the Subnet + """ # noqa: E501 + s_subnet_description1: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="The description of the Subnet in French", alias="sSubnetDescription1") + s_subnet_description2: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="The description of the Subnet in English", alias="sSubnetDescription2") + __properties: ClassVar[List[str]] = ["sSubnetDescription1", "sSubnetDescription2"] - @validator('s_subnet_description1') + @field_validator('s_subnet_description1') def s_subnet_description1_validate_regular_expression(cls, value): """Validates the regular expression""" if value is None: @@ -40,7 +46,7 @@ def s_subnet_description1_validate_regular_expression(cls, value): raise ValueError(r"must validate the regular expression /^.{0,50}$/") return value - @validator('s_subnet_description2') + @field_validator('s_subnet_description2') def s_subnet_description2_validate_regular_expression(cls, value): """Validates the regular expression""" if value is None: @@ -50,44 +56,57 @@ def s_subnet_description2_validate_regular_expression(cls, value): raise ValueError(r"must validate the regular expression /^.{0,50}$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> MultilingualSubnetDescription: + def from_json(cls, json_str: str) -> Self: """Create an instance of MultilingualSubnetDescription from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> MultilingualSubnetDescription: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of MultilingualSubnetDescription from a dict""" if obj is None: return None if not isinstance(obj, dict): - return MultilingualSubnetDescription.parse_obj(obj) + return cls.model_validate(obj) - _obj = MultilingualSubnetDescription.parse_obj({ - "s_subnet_description1": obj.get("sSubnetDescription1"), - "s_subnet_description2": obj.get("sSubnetDescription2") + _obj = cls.model_validate({ + "sSubnetDescription1": obj.get("sSubnetDescription1"), + "sSubnetDescription2": obj.get("sSubnetDescription2") }) return _obj diff --git a/eZmaxApi/models/multilingual_usergroup_name.py b/eZmaxApi/models/multilingual_usergroup_name.py index 9f4d82137..6417d9ae5 100644 --- a/eZmaxApi/models/multilingual_usergroup_name.py +++ b/eZmaxApi/models/multilingual_usergroup_name.py @@ -19,18 +19,24 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, constr, validator +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, field_validator +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class MultilingualUsergroupName(BaseModel): """ - The name of the Usergroup # noqa: E501 - """ - s_usergroup_name1: Optional[constr(strict=True)] = Field(None, alias="sUsergroupName1", description="The name of the Usergroup in French") - s_usergroup_name2: Optional[constr(strict=True)] = Field(None, alias="sUsergroupName2", description="The name of the Usergroup in English") - __properties = ["sUsergroupName1", "sUsergroupName2"] + The name of the Usergroup + """ # noqa: E501 + s_usergroup_name1: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="The name of the Usergroup in French", alias="sUsergroupName1") + s_usergroup_name2: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="The name of the Usergroup in English", alias="sUsergroupName2") + __properties: ClassVar[List[str]] = ["sUsergroupName1", "sUsergroupName2"] - @validator('s_usergroup_name1') + @field_validator('s_usergroup_name1') def s_usergroup_name1_validate_regular_expression(cls, value): """Validates the regular expression""" if value is None: @@ -40,7 +46,7 @@ def s_usergroup_name1_validate_regular_expression(cls, value): raise ValueError(r"must validate the regular expression /^.{0,50}$/") return value - @validator('s_usergroup_name2') + @field_validator('s_usergroup_name2') def s_usergroup_name2_validate_regular_expression(cls, value): """Validates the regular expression""" if value is None: @@ -50,44 +56,57 @@ def s_usergroup_name2_validate_regular_expression(cls, value): raise ValueError(r"must validate the regular expression /^.{0,50}$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> MultilingualUsergroupName: + def from_json(cls, json_str: str) -> Self: """Create an instance of MultilingualUsergroupName from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> MultilingualUsergroupName: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of MultilingualUsergroupName from a dict""" if obj is None: return None if not isinstance(obj, dict): - return MultilingualUsergroupName.parse_obj(obj) + return cls.model_validate(obj) - _obj = MultilingualUsergroupName.parse_obj({ - "s_usergroup_name1": obj.get("sUsergroupName1"), - "s_usergroup_name2": obj.get("sUsergroupName2") + _obj = cls.model_validate({ + "sUsergroupName1": obj.get("sUsergroupName1"), + "sUsergroupName2": obj.get("sUsergroupName2") }) return _obj diff --git a/eZmaxApi/models/multilingual_variableexpense_description.py b/eZmaxApi/models/multilingual_variableexpense_description.py index f044cd78d..1dada4c43 100644 --- a/eZmaxApi/models/multilingual_variableexpense_description.py +++ b/eZmaxApi/models/multilingual_variableexpense_description.py @@ -19,18 +19,24 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, constr, validator +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, field_validator +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class MultilingualVariableexpenseDescription(BaseModel): """ - The description of the Variableexpense # noqa: E501 - """ - s_variableexpense_description1: Optional[constr(strict=True)] = Field(None, alias="sVariableexpenseDescription1", description="The description of the Variableexpense in French") - s_variableexpense_description2: Optional[constr(strict=True)] = Field(None, alias="sVariableexpenseDescription2", description="The description of the Variableexpense in English") - __properties = ["sVariableexpenseDescription1", "sVariableexpenseDescription2"] + The description of the Variableexpense + """ # noqa: E501 + s_variableexpense_description1: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="The description of the Variableexpense in French", alias="sVariableexpenseDescription1") + s_variableexpense_description2: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="The description of the Variableexpense in English", alias="sVariableexpenseDescription2") + __properties: ClassVar[List[str]] = ["sVariableexpenseDescription1", "sVariableexpenseDescription2"] - @validator('s_variableexpense_description1') + @field_validator('s_variableexpense_description1') def s_variableexpense_description1_validate_regular_expression(cls, value): """Validates the regular expression""" if value is None: @@ -40,7 +46,7 @@ def s_variableexpense_description1_validate_regular_expression(cls, value): raise ValueError(r"must validate the regular expression /^.{0,40}$/") return value - @validator('s_variableexpense_description2') + @field_validator('s_variableexpense_description2') def s_variableexpense_description2_validate_regular_expression(cls, value): """Validates the regular expression""" if value is None: @@ -50,44 +56,57 @@ def s_variableexpense_description2_validate_regular_expression(cls, value): raise ValueError(r"must validate the regular expression /^.{0,40}$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> MultilingualVariableexpenseDescription: + def from_json(cls, json_str: str) -> Self: """Create an instance of MultilingualVariableexpenseDescription from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> MultilingualVariableexpenseDescription: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of MultilingualVariableexpenseDescription from a dict""" if obj is None: return None if not isinstance(obj, dict): - return MultilingualVariableexpenseDescription.parse_obj(obj) + return cls.model_validate(obj) - _obj = MultilingualVariableexpenseDescription.parse_obj({ - "s_variableexpense_description1": obj.get("sVariableexpenseDescription1"), - "s_variableexpense_description2": obj.get("sVariableexpenseDescription2") + _obj = cls.model_validate({ + "sVariableexpenseDescription1": obj.get("sVariableexpenseDescription1"), + "sVariableexpenseDescription2": obj.get("sVariableexpenseDescription2") }) return _obj diff --git a/eZmaxApi/models/multilingual_versionhistory_detail.py b/eZmaxApi/models/multilingual_versionhistory_detail.py index 793d0b680..0ee9a3d8a 100644 --- a/eZmaxApi/models/multilingual_versionhistory_detail.py +++ b/eZmaxApi/models/multilingual_versionhistory_detail.py @@ -19,55 +19,73 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictStr +from pydantic import Field +try: + from typing import Self +except ImportError: + from typing_extensions import Self class MultilingualVersionhistoryDetail(BaseModel): """ - Detail of the Versionhistory # noqa: E501 - """ - t_versionhistory_detail1: Optional[StrictStr] = Field(None, alias="tVersionhistoryDetail1", description="Detail of the Versionhistory in French") - t_versionhistory_detail2: Optional[StrictStr] = Field(None, alias="tVersionhistoryDetail2", description="Detail of the Versionhistory in English") - __properties = ["tVersionhistoryDetail1", "tVersionhistoryDetail2"] + Detail of the Versionhistory + """ # noqa: E501 + t_versionhistory_detail1: Optional[StrictStr] = Field(default=None, description="Detail of the Versionhistory in French", alias="tVersionhistoryDetail1") + t_versionhistory_detail2: Optional[StrictStr] = Field(default=None, description="Detail of the Versionhistory in English", alias="tVersionhistoryDetail2") + __properties: ClassVar[List[str]] = ["tVersionhistoryDetail1", "tVersionhistoryDetail2"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> MultilingualVersionhistoryDetail: + def from_json(cls, json_str: str) -> Self: """Create an instance of MultilingualVersionhistoryDetail from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> MultilingualVersionhistoryDetail: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of MultilingualVersionhistoryDetail from a dict""" if obj is None: return None if not isinstance(obj, dict): - return MultilingualVersionhistoryDetail.parse_obj(obj) + return cls.model_validate(obj) - _obj = MultilingualVersionhistoryDetail.parse_obj({ - "t_versionhistory_detail1": obj.get("tVersionhistoryDetail1"), - "t_versionhistory_detail2": obj.get("tVersionhistoryDetail2") + _obj = cls.model_validate({ + "tVersionhistoryDetail1": obj.get("tVersionhistoryDetail1"), + "tVersionhistoryDetail2": obj.get("tVersionhistoryDetail2") }) return _obj diff --git a/eZmaxApi/models/notificationsection_get_notificationtests_v1_response.py b/eZmaxApi/models/notificationsection_get_notificationtests_v1_response.py index 7587cb828..83ae47763 100644 --- a/eZmaxApi/models/notificationsection_get_notificationtests_v1_response.py +++ b/eZmaxApi/models/notificationsection_get_notificationtests_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.notificationsection_get_notificationtests_v1_response_m_payload import NotificationsectionGetNotificationtestsV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class NotificationsectionGetNotificationtestsV1Response(BaseModel): """ - Response for GET /1/object/notificationsection/{pkiNotificationsectionID}/getNotificationtests # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: NotificationsectionGetNotificationtestsV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /1/object/notificationsection/{pkiNotificationsectionID}/getNotificationtests + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: NotificationsectionGetNotificationtestsV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> NotificationsectionGetNotificationtestsV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of NotificationsectionGetNotificationtestsV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> NotificationsectionGetNotificationtestsV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of NotificationsectionGetNotificationtestsV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return NotificationsectionGetNotificationtestsV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = NotificationsectionGetNotificationtestsV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": NotificationsectionGetNotificationtestsV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": NotificationsectionGetNotificationtestsV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/notificationsection_get_notificationtests_v1_response_m_payload.py b/eZmaxApi/models/notificationsection_get_notificationtests_v1_response_m_payload.py index f788e7029..e48393748 100644 --- a/eZmaxApi/models/notificationsection_get_notificationtests_v1_response_m_payload.py +++ b/eZmaxApi/models/notificationsection_get_notificationtests_v1_response_m_payload.py @@ -19,41 +19,59 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.custom_notificationsubsectiongetnotificationtests_response import CustomNotificationsubsectiongetnotificationtestsResponse +try: + from typing import Self +except ImportError: + from typing_extensions import Self class NotificationsectionGetNotificationtestsV1ResponseMPayload(BaseModel): """ - Payload for GET /1/object/notificationsection/{pkiNotificationsectionID}/getNotificationtests # noqa: E501 - """ - a_obj_notificationsubsection: conlist(CustomNotificationsubsectiongetnotificationtestsResponse) = Field(..., alias="a_objNotificationsubsection") - __properties = ["a_objNotificationsubsection"] + Payload for GET /1/object/notificationsection/{pkiNotificationsectionID}/getNotificationtests + """ # noqa: E501 + a_obj_notificationsubsection: List[CustomNotificationsubsectiongetnotificationtestsResponse] = Field(alias="a_objNotificationsubsection") + __properties: ClassVar[List[str]] = ["a_objNotificationsubsection"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> NotificationsectionGetNotificationtestsV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of NotificationsectionGetNotificationtestsV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_notificationsubsection (list) _items = [] if self.a_obj_notificationsubsection: @@ -64,16 +82,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> NotificationsectionGetNotificationtestsV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of NotificationsectionGetNotificationtestsV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return NotificationsectionGetNotificationtestsV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = NotificationsectionGetNotificationtestsV1ResponseMPayload.parse_obj({ - "a_obj_notificationsubsection": [CustomNotificationsubsectiongetnotificationtestsResponse.from_dict(_item) for _item in obj.get("a_objNotificationsubsection")] if obj.get("a_objNotificationsubsection") is not None else None + _obj = cls.model_validate({ + "a_objNotificationsubsection": [CustomNotificationsubsectiongetnotificationtestsResponse.from_dict(_item) for _item in obj.get("a_objNotificationsubsection")] if obj.get("a_objNotificationsubsection") is not None else None }) return _obj diff --git a/eZmaxApi/models/notificationsubsection_response.py b/eZmaxApi/models/notificationsubsection_response.py index 1f262528d..ef80662c8 100644 --- a/eZmaxApi/models/notificationsubsection_response.py +++ b/eZmaxApi/models/notificationsubsection_response.py @@ -19,65 +19,84 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictStr, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictStr +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.multilingual_notificationsubsection_name import MultilingualNotificationsubsectionName +try: + from typing import Self +except ImportError: + from typing_extensions import Self class NotificationsubsectionResponse(BaseModel): """ - A Notificationsubsection Object # noqa: E501 - """ - pki_notificationsubsection_id: conint(strict=True, ge=0) = Field(..., alias="pkiNotificationsubsectionID", description="The unique ID of the Notificationsubsection") - fki_notificationsection_id: conint(strict=True, ge=0) = Field(..., alias="fkiNotificationsectionID", description="The unique ID of the Notificationsection") - obj_notificationsubsection_name: Optional[MultilingualNotificationsubsectionName] = Field(None, alias="objNotificationsubsectionName") - s_notificationsection_name_x: Optional[StrictStr] = Field(None, alias="sNotificationsectionNameX", description="The name of the Notificationsection in the language of the requester") - s_notificationsubsection_name_x: StrictStr = Field(..., alias="sNotificationsubsectionNameX", description="The name of the Notificationsubsection in the language of the requester") - __properties = ["pkiNotificationsubsectionID", "fkiNotificationsectionID", "objNotificationsubsectionName", "sNotificationsectionNameX", "sNotificationsubsectionNameX"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + A Notificationsubsection Object + """ # noqa: E501 + pki_notificationsubsection_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Notificationsubsection", alias="pkiNotificationsubsectionID") + fki_notificationsection_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Notificationsection", alias="fkiNotificationsectionID") + obj_notificationsubsection_name: Optional[MultilingualNotificationsubsectionName] = Field(default=None, alias="objNotificationsubsectionName") + s_notificationsection_name_x: Optional[StrictStr] = Field(default=None, description="The name of the Notificationsection in the language of the requester", alias="sNotificationsectionNameX") + s_notificationsubsection_name_x: StrictStr = Field(description="The name of the Notificationsubsection in the language of the requester", alias="sNotificationsubsectionNameX") + __properties: ClassVar[List[str]] = ["pkiNotificationsubsectionID", "fkiNotificationsectionID", "objNotificationsubsectionName", "sNotificationsectionNameX", "sNotificationsubsectionNameX"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> NotificationsubsectionResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of NotificationsubsectionResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_notificationsubsection_name if self.obj_notificationsubsection_name: _dict['objNotificationsubsectionName'] = self.obj_notificationsubsection_name.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> NotificationsubsectionResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of NotificationsubsectionResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return NotificationsubsectionResponse.parse_obj(obj) - - _obj = NotificationsubsectionResponse.parse_obj({ - "pki_notificationsubsection_id": obj.get("pkiNotificationsubsectionID"), - "fki_notificationsection_id": obj.get("fkiNotificationsectionID"), - "obj_notificationsubsection_name": MultilingualNotificationsubsectionName.from_dict(obj.get("objNotificationsubsectionName")) if obj.get("objNotificationsubsectionName") is not None else None, - "s_notificationsection_name_x": obj.get("sNotificationsectionNameX"), - "s_notificationsubsection_name_x": obj.get("sNotificationsubsectionNameX") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiNotificationsubsectionID": obj.get("pkiNotificationsubsectionID"), + "fkiNotificationsectionID": obj.get("fkiNotificationsectionID"), + "objNotificationsubsectionName": MultilingualNotificationsubsectionName.from_dict(obj.get("objNotificationsubsectionName")) if obj.get("objNotificationsubsectionName") is not None else None, + "sNotificationsectionNameX": obj.get("sNotificationsectionNameX"), + "sNotificationsubsectionNameX": obj.get("sNotificationsubsectionNameX") }) return _obj diff --git a/eZmaxApi/models/notificationtest_get_elements_v1_response.py b/eZmaxApi/models/notificationtest_get_elements_v1_response.py index 4f4217e70..418e3b227 100644 --- a/eZmaxApi/models/notificationtest_get_elements_v1_response.py +++ b/eZmaxApi/models/notificationtest_get_elements_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.notificationtest_get_elements_v1_response_m_payload import NotificationtestGetElementsV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class NotificationtestGetElementsV1Response(BaseModel): """ - Response for GET /1/object/notificationtest/{pkiNotificationtestID}/getElements # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: NotificationtestGetElementsV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /1/object/notificationtest/{pkiNotificationtestID}/getElements + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: NotificationtestGetElementsV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> NotificationtestGetElementsV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of NotificationtestGetElementsV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> NotificationtestGetElementsV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of NotificationtestGetElementsV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return NotificationtestGetElementsV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = NotificationtestGetElementsV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": NotificationtestGetElementsV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": NotificationtestGetElementsV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/notificationtest_get_elements_v1_response_m_payload.py b/eZmaxApi/models/notificationtest_get_elements_v1_response_m_payload.py index 9f22d87d8..d658c8476 100644 --- a/eZmaxApi/models/notificationtest_get_elements_v1_response_m_payload.py +++ b/eZmaxApi/models/notificationtest_get_elements_v1_response_m_payload.py @@ -19,59 +19,78 @@ import json -from typing import Any, Dict, List -from pydantic import BaseModel, Field, StrictStr, conint, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictStr +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class NotificationtestGetElementsV1ResponseMPayload(BaseModel): """ - Payload for GET /1/object/notificationtest/{pkiNotificationtestID}/getElements # noqa: E501 - """ - pki_notificationtest_id: conint(strict=True, ge=0) = Field(..., alias="pkiNotificationtestID", description="The unique ID of the Notificationtest") - s_notificationtest_function: StrictStr = Field(..., alias="sNotificationtestFunction", description="The function name of the Notificationtest") - a_s_variableobject_property: conlist(StrictStr) = Field(..., alias="a_sVariableobjectProperty") - a_obj_variableobject: conlist(Dict[str, Any]) = Field(..., alias="a_objVariableobject") - __properties = ["pkiNotificationtestID", "sNotificationtestFunction", "a_sVariableobjectProperty", "a_objVariableobject"] + Payload for GET /1/object/notificationtest/{pkiNotificationtestID}/getElements + """ # noqa: E501 + pki_notificationtest_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Notificationtest", alias="pkiNotificationtestID") + s_notificationtest_function: StrictStr = Field(description="The function name of the Notificationtest", alias="sNotificationtestFunction") + a_s_variableobject_property: List[StrictStr] = Field(alias="a_sVariableobjectProperty") + a_obj_variableobject: List[Dict[str, Any]] = Field(alias="a_objVariableobject") + __properties: ClassVar[List[str]] = ["pkiNotificationtestID", "sNotificationtestFunction", "a_sVariableobjectProperty", "a_objVariableobject"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> NotificationtestGetElementsV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of NotificationtestGetElementsV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> NotificationtestGetElementsV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of NotificationtestGetElementsV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return NotificationtestGetElementsV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = NotificationtestGetElementsV1ResponseMPayload.parse_obj({ - "pki_notificationtest_id": obj.get("pkiNotificationtestID"), - "s_notificationtest_function": obj.get("sNotificationtestFunction"), - "a_s_variableobject_property": obj.get("a_sVariableobjectProperty"), - "a_obj_variableobject": obj.get("a_objVariableobject") + _obj = cls.model_validate({ + "pkiNotificationtestID": obj.get("pkiNotificationtestID"), + "sNotificationtestFunction": obj.get("sNotificationtestFunction"), + "a_sVariableobjectProperty": obj.get("a_sVariableobjectProperty"), + "a_objVariableobject": obj.get("a_objVariableobject") }) return _obj diff --git a/eZmaxApi/models/notificationtest_response.py b/eZmaxApi/models/notificationtest_response.py index 677319fe3..5df7da0ad 100644 --- a/eZmaxApi/models/notificationtest_response.py +++ b/eZmaxApi/models/notificationtest_response.py @@ -19,65 +19,84 @@ import json - -from pydantic import BaseModel, Field, StrictStr, conint +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictStr +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.multilingual_notificationtest_name import MultilingualNotificationtestName +try: + from typing import Self +except ImportError: + from typing_extensions import Self class NotificationtestResponse(BaseModel): """ - A Notificationtest Object # noqa: E501 - """ - pki_notificationtest_id: conint(strict=True, ge=0) = Field(..., alias="pkiNotificationtestID", description="The unique ID of the Notificationtest") - obj_notificationtest_name: MultilingualNotificationtestName = Field(..., alias="objNotificationtestName") - fki_notificationsubsection_id: conint(strict=True, ge=0) = Field(..., alias="fkiNotificationsubsectionID", description="The unique ID of the Notificationsubsection") - s_notificationtest_function: StrictStr = Field(..., alias="sNotificationtestFunction", description="The function name of the Notificationtest") - s_notificationtest_name_x: StrictStr = Field(..., alias="sNotificationtestNameX", description="The name of the Notificationtest in the language of the requester") - __properties = ["pkiNotificationtestID", "objNotificationtestName", "fkiNotificationsubsectionID", "sNotificationtestFunction", "sNotificationtestNameX"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + A Notificationtest Object + """ # noqa: E501 + pki_notificationtest_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Notificationtest", alias="pkiNotificationtestID") + obj_notificationtest_name: MultilingualNotificationtestName = Field(alias="objNotificationtestName") + fki_notificationsubsection_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Notificationsubsection", alias="fkiNotificationsubsectionID") + s_notificationtest_function: StrictStr = Field(description="The function name of the Notificationtest", alias="sNotificationtestFunction") + s_notificationtest_name_x: StrictStr = Field(description="The name of the Notificationtest in the language of the requester", alias="sNotificationtestNameX") + __properties: ClassVar[List[str]] = ["pkiNotificationtestID", "objNotificationtestName", "fkiNotificationsubsectionID", "sNotificationtestFunction", "sNotificationtestNameX"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> NotificationtestResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of NotificationtestResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_notificationtest_name if self.obj_notificationtest_name: _dict['objNotificationtestName'] = self.obj_notificationtest_name.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> NotificationtestResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of NotificationtestResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return NotificationtestResponse.parse_obj(obj) - - _obj = NotificationtestResponse.parse_obj({ - "pki_notificationtest_id": obj.get("pkiNotificationtestID"), - "obj_notificationtest_name": MultilingualNotificationtestName.from_dict(obj.get("objNotificationtestName")) if obj.get("objNotificationtestName") is not None else None, - "fki_notificationsubsection_id": obj.get("fkiNotificationsubsectionID"), - "s_notificationtest_function": obj.get("sNotificationtestFunction"), - "s_notificationtest_name_x": obj.get("sNotificationtestNameX") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiNotificationtestID": obj.get("pkiNotificationtestID"), + "objNotificationtestName": MultilingualNotificationtestName.from_dict(obj.get("objNotificationtestName")) if obj.get("objNotificationtestName") is not None else None, + "fkiNotificationsubsectionID": obj.get("fkiNotificationsubsectionID"), + "sNotificationtestFunction": obj.get("sNotificationtestFunction"), + "sNotificationtestNameX": obj.get("sNotificationtestNameX") }) return _obj diff --git a/eZmaxApi/models/otherincome_get_communication_list_v1_response.py b/eZmaxApi/models/otherincome_get_communication_list_v1_response.py index 987a8a43a..cf8bf79bc 100644 --- a/eZmaxApi/models/otherincome_get_communication_list_v1_response.py +++ b/eZmaxApi/models/otherincome_get_communication_list_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload_get_list import CommonResponseObjDebugPayloadGetList from eZmaxApi.models.otherincome_get_communication_list_v1_response_m_payload import OtherincomeGetCommunicationListV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class OtherincomeGetCommunicationListV1Response(BaseModel): """ - Response for GET /1/object/otherincome/{pkiOtherincomeID}/getCommunicationList # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayloadGetList = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: OtherincomeGetCommunicationListV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /1/object/otherincome/{pkiOtherincomeID}/getCommunicationList + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayloadGetList = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: OtherincomeGetCommunicationListV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> OtherincomeGetCommunicationListV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of OtherincomeGetCommunicationListV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> OtherincomeGetCommunicationListV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of OtherincomeGetCommunicationListV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return OtherincomeGetCommunicationListV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = OtherincomeGetCommunicationListV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayloadGetList.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": OtherincomeGetCommunicationListV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayloadGetList.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": OtherincomeGetCommunicationListV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/otherincome_get_communication_list_v1_response_m_payload.py b/eZmaxApi/models/otherincome_get_communication_list_v1_response_m_payload.py index d6e7f3226..ce1040cb9 100644 --- a/eZmaxApi/models/otherincome_get_communication_list_v1_response_m_payload.py +++ b/eZmaxApi/models/otherincome_get_communication_list_v1_response_m_payload.py @@ -19,41 +19,59 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.custom_communication_list_element_response import CustomCommunicationListElementResponse +try: + from typing import Self +except ImportError: + from typing_extensions import Self class OtherincomeGetCommunicationListV1ResponseMPayload(BaseModel): """ - Response for GET /1/object/otherincome/{pkiOtherincomeID}/getCommunicationList # noqa: E501 - """ - a_obj_communication: conlist(CustomCommunicationListElementResponse) = Field(..., alias="a_objCommunication") - __properties = ["a_objCommunication"] + Response for GET /1/object/otherincome/{pkiOtherincomeID}/getCommunicationList + """ # noqa: E501 + a_obj_communication: List[CustomCommunicationListElementResponse] = Field(alias="a_objCommunication") + __properties: ClassVar[List[str]] = ["a_objCommunication"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> OtherincomeGetCommunicationListV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of OtherincomeGetCommunicationListV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_communication (list) _items = [] if self.a_obj_communication: @@ -64,16 +82,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> OtherincomeGetCommunicationListV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of OtherincomeGetCommunicationListV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return OtherincomeGetCommunicationListV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = OtherincomeGetCommunicationListV1ResponseMPayload.parse_obj({ - "a_obj_communication": [CustomCommunicationListElementResponse.from_dict(_item) for _item in obj.get("a_objCommunication")] if obj.get("a_objCommunication") is not None else None + _obj = cls.model_validate({ + "a_objCommunication": [CustomCommunicationListElementResponse.from_dict(_item) for _item in obj.get("a_objCommunication")] if obj.get("a_objCommunication") is not None else None }) return _obj diff --git a/eZmaxApi/models/paymentterm_autocomplete_element_response.py b/eZmaxApi/models/paymentterm_autocomplete_element_response.py index 852156bb1..d53ad95a2 100644 --- a/eZmaxApi/models/paymentterm_autocomplete_element_response.py +++ b/eZmaxApi/models/paymentterm_autocomplete_element_response.py @@ -19,64 +19,83 @@ import json - -from pydantic import BaseModel, Field, StrictBool, StrictInt, constr, validator +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictBool, StrictInt, field_validator +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class PaymenttermAutocompleteElementResponse(BaseModel): """ - A Paymentterm AutocompleteElement Response # noqa: E501 - """ - pki_paymentterm_id: StrictInt = Field(..., alias="pkiPaymenttermID", description="The unique ID of the Paymentterm") - s_paymentterm_description_x: constr(strict=True) = Field(..., alias="sPaymenttermDescriptionX", description="The description of the Paymentterm in the language of the requester") - b_paymentterm_isactive: StrictBool = Field(..., alias="bPaymenttermIsactive", description="Whether the Paymentterm is active or not") - __properties = ["pkiPaymenttermID", "sPaymenttermDescriptionX", "bPaymenttermIsactive"] - - @validator('s_paymentterm_description_x') + A Paymentterm AutocompleteElement Response + """ # noqa: E501 + pki_paymentterm_id: StrictInt = Field(description="The unique ID of the Paymentterm", alias="pkiPaymenttermID") + s_paymentterm_description_x: Annotated[str, Field(strict=True)] = Field(description="The description of the Paymentterm in the language of the requester", alias="sPaymenttermDescriptionX") + b_paymentterm_isactive: StrictBool = Field(description="Whether the Paymentterm is active or not", alias="bPaymenttermIsactive") + __properties: ClassVar[List[str]] = ["pkiPaymenttermID", "sPaymenttermDescriptionX", "bPaymenttermIsactive"] + + @field_validator('s_paymentterm_description_x') def s_paymentterm_description_x_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^.{1,40}$", value): raise ValueError(r"must validate the regular expression /^.{1,40}$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> PaymenttermAutocompleteElementResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of PaymenttermAutocompleteElementResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> PaymenttermAutocompleteElementResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of PaymenttermAutocompleteElementResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return PaymenttermAutocompleteElementResponse.parse_obj(obj) + return cls.model_validate(obj) - _obj = PaymenttermAutocompleteElementResponse.parse_obj({ - "pki_paymentterm_id": obj.get("pkiPaymenttermID"), - "s_paymentterm_description_x": obj.get("sPaymenttermDescriptionX"), - "b_paymentterm_isactive": obj.get("bPaymenttermIsactive") + _obj = cls.model_validate({ + "pkiPaymenttermID": obj.get("pkiPaymenttermID"), + "sPaymenttermDescriptionX": obj.get("sPaymenttermDescriptionX"), + "bPaymenttermIsactive": obj.get("bPaymenttermIsactive") }) return _obj diff --git a/eZmaxApi/models/paymentterm_create_object_v1_request.py b/eZmaxApi/models/paymentterm_create_object_v1_request.py index 782fb3899..11ad9ba4a 100644 --- a/eZmaxApi/models/paymentterm_create_object_v1_request.py +++ b/eZmaxApi/models/paymentterm_create_object_v1_request.py @@ -19,41 +19,60 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.paymentterm_request_compound import PaymenttermRequestCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class PaymenttermCreateObjectV1Request(BaseModel): """ - Request for POST /1/object/paymentterm # noqa: E501 - """ - a_obj_paymentterm: conlist(PaymenttermRequestCompound, min_items=1) = Field(..., alias="a_objPaymentterm") - __properties = ["a_objPaymentterm"] + Request for POST /1/object/paymentterm + """ # noqa: E501 + a_obj_paymentterm: Annotated[List[PaymenttermRequestCompound], Field(min_length=1)] = Field(alias="a_objPaymentterm") + __properties: ClassVar[List[str]] = ["a_objPaymentterm"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> PaymenttermCreateObjectV1Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of PaymenttermCreateObjectV1Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_paymentterm (list) _items = [] if self.a_obj_paymentterm: @@ -64,16 +83,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> PaymenttermCreateObjectV1Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of PaymenttermCreateObjectV1Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return PaymenttermCreateObjectV1Request.parse_obj(obj) + return cls.model_validate(obj) - _obj = PaymenttermCreateObjectV1Request.parse_obj({ - "a_obj_paymentterm": [PaymenttermRequestCompound.from_dict(_item) for _item in obj.get("a_objPaymentterm")] if obj.get("a_objPaymentterm") is not None else None + _obj = cls.model_validate({ + "a_objPaymentterm": [PaymenttermRequestCompound.from_dict(_item) for _item in obj.get("a_objPaymentterm")] if obj.get("a_objPaymentterm") is not None else None }) return _obj diff --git a/eZmaxApi/models/paymentterm_create_object_v1_response.py b/eZmaxApi/models/paymentterm_create_object_v1_response.py index 94040ea1d..186926dd7 100644 --- a/eZmaxApi/models/paymentterm_create_object_v1_response.py +++ b/eZmaxApi/models/paymentterm_create_object_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.paymentterm_create_object_v1_response_m_payload import PaymenttermCreateObjectV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class PaymenttermCreateObjectV1Response(BaseModel): """ - Response for POST /1/object/paymentterm # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: PaymenttermCreateObjectV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for POST /1/object/paymentterm + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: PaymenttermCreateObjectV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> PaymenttermCreateObjectV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of PaymenttermCreateObjectV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> PaymenttermCreateObjectV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of PaymenttermCreateObjectV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return PaymenttermCreateObjectV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = PaymenttermCreateObjectV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": PaymenttermCreateObjectV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": PaymenttermCreateObjectV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/paymentterm_create_object_v1_response_m_payload.py b/eZmaxApi/models/paymentterm_create_object_v1_response_m_payload.py index 215de60b3..5bf3c53f7 100644 --- a/eZmaxApi/models/paymentterm_create_object_v1_response_m_payload.py +++ b/eZmaxApi/models/paymentterm_create_object_v1_response_m_payload.py @@ -19,53 +19,71 @@ import json -from typing import List -from pydantic import BaseModel, Field, StrictInt, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictInt +from pydantic import Field +try: + from typing import Self +except ImportError: + from typing_extensions import Self class PaymenttermCreateObjectV1ResponseMPayload(BaseModel): """ - Payload for POST /1/object/paymentterm # noqa: E501 - """ - a_pki_paymentterm_id: conlist(StrictInt) = Field(..., alias="a_pkiPaymenttermID", description="An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request.") - __properties = ["a_pkiPaymenttermID"] + Payload for POST /1/object/paymentterm + """ # noqa: E501 + a_pki_paymentterm_id: List[StrictInt] = Field(description="An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request.", alias="a_pkiPaymenttermID") + __properties: ClassVar[List[str]] = ["a_pkiPaymenttermID"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> PaymenttermCreateObjectV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of PaymenttermCreateObjectV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> PaymenttermCreateObjectV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of PaymenttermCreateObjectV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return PaymenttermCreateObjectV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = PaymenttermCreateObjectV1ResponseMPayload.parse_obj({ - "a_pki_paymentterm_id": obj.get("a_pkiPaymenttermID") + _obj = cls.model_validate({ + "a_pkiPaymenttermID": obj.get("a_pkiPaymenttermID") }) return _obj diff --git a/eZmaxApi/models/paymentterm_edit_object_v1_request.py b/eZmaxApi/models/paymentterm_edit_object_v1_request.py index 0ef1d51e8..f9aad6bcf 100644 --- a/eZmaxApi/models/paymentterm_edit_object_v1_request.py +++ b/eZmaxApi/models/paymentterm_edit_object_v1_request.py @@ -19,57 +19,75 @@ import json - -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.paymentterm_request_compound import PaymenttermRequestCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class PaymenttermEditObjectV1Request(BaseModel): """ - Request for PUT /1/object/paymentterm/{pkiPaymenttermID} # noqa: E501 - """ - obj_paymentterm: PaymenttermRequestCompound = Field(..., alias="objPaymentterm") - __properties = ["objPaymentterm"] + Request for PUT /1/object/paymentterm/{pkiPaymenttermID} + """ # noqa: E501 + obj_paymentterm: PaymenttermRequestCompound = Field(alias="objPaymentterm") + __properties: ClassVar[List[str]] = ["objPaymentterm"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> PaymenttermEditObjectV1Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of PaymenttermEditObjectV1Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_paymentterm if self.obj_paymentterm: _dict['objPaymentterm'] = self.obj_paymentterm.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> PaymenttermEditObjectV1Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of PaymenttermEditObjectV1Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return PaymenttermEditObjectV1Request.parse_obj(obj) + return cls.model_validate(obj) - _obj = PaymenttermEditObjectV1Request.parse_obj({ - "obj_paymentterm": PaymenttermRequestCompound.from_dict(obj.get("objPaymentterm")) if obj.get("objPaymentterm") is not None else None + _obj = cls.model_validate({ + "objPaymentterm": PaymenttermRequestCompound.from_dict(obj.get("objPaymentterm")) if obj.get("objPaymentterm") is not None else None }) return _obj diff --git a/eZmaxApi/models/paymentterm_edit_object_v1_response.py b/eZmaxApi/models/paymentterm_edit_object_v1_response.py index ac84949d1..be3b8d0d6 100644 --- a/eZmaxApi/models/paymentterm_edit_object_v1_response.py +++ b/eZmaxApi/models/paymentterm_edit_object_v1_response.py @@ -19,43 +19,61 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class PaymenttermEditObjectV1Response(BaseModel): """ - Response for PUT /1/object/paymentterm/{pkiPaymenttermID} # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - __properties = ["objDebugPayload", "objDebug"] + Response for PUT /1/object/paymentterm/{pkiPaymenttermID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> PaymenttermEditObjectV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of PaymenttermEditObjectV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -65,17 +83,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> PaymenttermEditObjectV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of PaymenttermEditObjectV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return PaymenttermEditObjectV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = PaymenttermEditObjectV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None }) return _obj diff --git a/eZmaxApi/models/paymentterm_get_autocomplete_v2_response.py b/eZmaxApi/models/paymentterm_get_autocomplete_v2_response.py index 62a5431ae..68a9f533e 100644 --- a/eZmaxApi/models/paymentterm_get_autocomplete_v2_response.py +++ b/eZmaxApi/models/paymentterm_get_autocomplete_v2_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.paymentterm_get_autocomplete_v2_response_m_payload import PaymenttermGetAutocompleteV2ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class PaymenttermGetAutocompleteV2Response(BaseModel): """ - Response for GET /2/object/paymentterm/getAutocomplete # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: PaymenttermGetAutocompleteV2ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /2/object/paymentterm/getAutocomplete + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: PaymenttermGetAutocompleteV2ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> PaymenttermGetAutocompleteV2Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of PaymenttermGetAutocompleteV2Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> PaymenttermGetAutocompleteV2Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of PaymenttermGetAutocompleteV2Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return PaymenttermGetAutocompleteV2Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = PaymenttermGetAutocompleteV2Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": PaymenttermGetAutocompleteV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": PaymenttermGetAutocompleteV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/paymentterm_get_autocomplete_v2_response_m_payload.py b/eZmaxApi/models/paymentterm_get_autocomplete_v2_response_m_payload.py index 76ae6d79f..e84894808 100644 --- a/eZmaxApi/models/paymentterm_get_autocomplete_v2_response_m_payload.py +++ b/eZmaxApi/models/paymentterm_get_autocomplete_v2_response_m_payload.py @@ -19,41 +19,59 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.paymentterm_autocomplete_element_response import PaymenttermAutocompleteElementResponse +try: + from typing import Self +except ImportError: + from typing_extensions import Self class PaymenttermGetAutocompleteV2ResponseMPayload(BaseModel): """ - Payload for POST /2/object/paymentterm/getAutocomplete # noqa: E501 - """ - a_obj_paymentterm: conlist(PaymenttermAutocompleteElementResponse) = Field(..., alias="a_objPaymentterm", description="An array of Paymentterm autocomplete element response.") - __properties = ["a_objPaymentterm"] + Payload for POST /2/object/paymentterm/getAutocomplete + """ # noqa: E501 + a_obj_paymentterm: List[PaymenttermAutocompleteElementResponse] = Field(description="An array of Paymentterm autocomplete element response.", alias="a_objPaymentterm") + __properties: ClassVar[List[str]] = ["a_objPaymentterm"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> PaymenttermGetAutocompleteV2ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of PaymenttermGetAutocompleteV2ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_paymentterm (list) _items = [] if self.a_obj_paymentterm: @@ -64,16 +82,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> PaymenttermGetAutocompleteV2ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of PaymenttermGetAutocompleteV2ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return PaymenttermGetAutocompleteV2ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = PaymenttermGetAutocompleteV2ResponseMPayload.parse_obj({ - "a_obj_paymentterm": [PaymenttermAutocompleteElementResponse.from_dict(_item) for _item in obj.get("a_objPaymentterm")] if obj.get("a_objPaymentterm") is not None else None + _obj = cls.model_validate({ + "a_objPaymentterm": [PaymenttermAutocompleteElementResponse.from_dict(_item) for _item in obj.get("a_objPaymentterm")] if obj.get("a_objPaymentterm") is not None else None }) return _obj diff --git a/eZmaxApi/models/paymentterm_get_list_v1_response.py b/eZmaxApi/models/paymentterm_get_list_v1_response.py index 622794e63..84740c295 100644 --- a/eZmaxApi/models/paymentterm_get_list_v1_response.py +++ b/eZmaxApi/models/paymentterm_get_list_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload_get_list import CommonResponseObjDebugPayloadGetList from eZmaxApi.models.paymentterm_get_list_v1_response_m_payload import PaymenttermGetListV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class PaymenttermGetListV1Response(BaseModel): """ - Response for GET /1/object/paymentterm/getList # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayloadGetList = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: PaymenttermGetListV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /1/object/paymentterm/getList + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayloadGetList = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: PaymenttermGetListV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> PaymenttermGetListV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of PaymenttermGetListV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> PaymenttermGetListV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of PaymenttermGetListV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return PaymenttermGetListV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = PaymenttermGetListV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayloadGetList.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": PaymenttermGetListV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayloadGetList.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": PaymenttermGetListV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/paymentterm_get_list_v1_response_m_payload.py b/eZmaxApi/models/paymentterm_get_list_v1_response_m_payload.py index 5223848aa..c232c0c7c 100644 --- a/eZmaxApi/models/paymentterm_get_list_v1_response_m_payload.py +++ b/eZmaxApi/models/paymentterm_get_list_v1_response_m_payload.py @@ -19,43 +19,61 @@ import json -from typing import List -from pydantic import BaseModel, Field, StrictInt, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictInt +from pydantic import Field from eZmaxApi.models.paymentterm_list_element import PaymenttermListElement +try: + from typing import Self +except ImportError: + from typing_extensions import Self class PaymenttermGetListV1ResponseMPayload(BaseModel): """ - Payload for GET /1/object/paymentterm/getList # noqa: E501 - """ - i_row_returned: StrictInt = Field(..., alias="iRowReturned", description="The number of rows returned") - i_row_filtered: StrictInt = Field(..., alias="iRowFiltered", description="The number of rows matching your filters (if any) or the total number of rows") - a_obj_paymentterm: conlist(PaymenttermListElement) = Field(..., alias="a_objPaymentterm") - __properties = ["iRowReturned", "iRowFiltered", "a_objPaymentterm"] + Payload for GET /1/object/paymentterm/getList + """ # noqa: E501 + i_row_returned: StrictInt = Field(description="The number of rows returned", alias="iRowReturned") + i_row_filtered: StrictInt = Field(description="The number of rows matching your filters (if any) or the total number of rows", alias="iRowFiltered") + a_obj_paymentterm: List[PaymenttermListElement] = Field(alias="a_objPaymentterm") + __properties: ClassVar[List[str]] = ["iRowReturned", "iRowFiltered", "a_objPaymentterm"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> PaymenttermGetListV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of PaymenttermGetListV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_paymentterm (list) _items = [] if self.a_obj_paymentterm: @@ -66,18 +84,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> PaymenttermGetListV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of PaymenttermGetListV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return PaymenttermGetListV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = PaymenttermGetListV1ResponseMPayload.parse_obj({ - "i_row_returned": obj.get("iRowReturned"), - "i_row_filtered": obj.get("iRowFiltered"), - "a_obj_paymentterm": [PaymenttermListElement.from_dict(_item) for _item in obj.get("a_objPaymentterm")] if obj.get("a_objPaymentterm") is not None else None + _obj = cls.model_validate({ + "iRowReturned": obj.get("iRowReturned"), + "iRowFiltered": obj.get("iRowFiltered"), + "a_objPaymentterm": [PaymenttermListElement.from_dict(_item) for _item in obj.get("a_objPaymentterm")] if obj.get("a_objPaymentterm") is not None else None }) return _obj diff --git a/eZmaxApi/models/paymentterm_get_object_v2_response.py b/eZmaxApi/models/paymentterm_get_object_v2_response.py index ddaf06f34..9847231a3 100644 --- a/eZmaxApi/models/paymentterm_get_object_v2_response.py +++ b/eZmaxApi/models/paymentterm_get_object_v2_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.paymentterm_get_object_v2_response_m_payload import PaymenttermGetObjectV2ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class PaymenttermGetObjectV2Response(BaseModel): """ - Response for GET /2/object/paymentterm/{pkiPaymenttermID} # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: PaymenttermGetObjectV2ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /2/object/paymentterm/{pkiPaymenttermID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: PaymenttermGetObjectV2ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> PaymenttermGetObjectV2Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of PaymenttermGetObjectV2Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> PaymenttermGetObjectV2Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of PaymenttermGetObjectV2Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return PaymenttermGetObjectV2Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = PaymenttermGetObjectV2Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": PaymenttermGetObjectV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": PaymenttermGetObjectV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/paymentterm_get_object_v2_response_m_payload.py b/eZmaxApi/models/paymentterm_get_object_v2_response_m_payload.py index f495454f5..261700e2c 100644 --- a/eZmaxApi/models/paymentterm_get_object_v2_response_m_payload.py +++ b/eZmaxApi/models/paymentterm_get_object_v2_response_m_payload.py @@ -19,57 +19,75 @@ import json - -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.paymentterm_response_compound import PaymenttermResponseCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class PaymenttermGetObjectV2ResponseMPayload(BaseModel): """ - Payload for GET /2/object/paymentterm/{pkiPaymenttermID} # noqa: E501 - """ - obj_paymentterm: PaymenttermResponseCompound = Field(..., alias="objPaymentterm") - __properties = ["objPaymentterm"] + Payload for GET /2/object/paymentterm/{pkiPaymenttermID} + """ # noqa: E501 + obj_paymentterm: PaymenttermResponseCompound = Field(alias="objPaymentterm") + __properties: ClassVar[List[str]] = ["objPaymentterm"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> PaymenttermGetObjectV2ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of PaymenttermGetObjectV2ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_paymentterm if self.obj_paymentterm: _dict['objPaymentterm'] = self.obj_paymentterm.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> PaymenttermGetObjectV2ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of PaymenttermGetObjectV2ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return PaymenttermGetObjectV2ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = PaymenttermGetObjectV2ResponseMPayload.parse_obj({ - "obj_paymentterm": PaymenttermResponseCompound.from_dict(obj.get("objPaymentterm")) if obj.get("objPaymentterm") is not None else None + _obj = cls.model_validate({ + "objPaymentterm": PaymenttermResponseCompound.from_dict(obj.get("objPaymentterm")) if obj.get("objPaymentterm") is not None else None }) return _obj diff --git a/eZmaxApi/models/paymentterm_list_element.py b/eZmaxApi/models/paymentterm_list_element.py index f2238aed4..eca8e9ec2 100644 --- a/eZmaxApi/models/paymentterm_list_element.py +++ b/eZmaxApi/models/paymentterm_list_element.py @@ -19,78 +19,97 @@ import json - -from pydantic import BaseModel, Field, StrictBool, StrictInt, conint, constr, validator +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictBool, StrictInt, field_validator +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.field_e_paymentterm_type import FieldEPaymenttermType +try: + from typing import Self +except ImportError: + from typing_extensions import Self class PaymenttermListElement(BaseModel): """ - A Paymentterm List Element # noqa: E501 - """ - pki_paymentterm_id: StrictInt = Field(..., alias="pkiPaymenttermID", description="The unique ID of the Paymentterm") - s_paymentterm_code: constr(strict=True) = Field(..., alias="sPaymenttermCode", description="The code of the Paymentterm") - e_paymentterm_type: FieldEPaymenttermType = Field(..., alias="ePaymenttermType") - i_paymentterm_day: conint(strict=True, le=255, ge=0) = Field(..., alias="iPaymenttermDay", description="The day of the Paymentterm") - s_paymentterm_description_x: constr(strict=True) = Field(..., alias="sPaymenttermDescriptionX", description="The description of the Paymentterm in the language of the requester") - b_paymentterm_isactive: StrictBool = Field(..., alias="bPaymenttermIsactive", description="Whether the Paymentterm is active or not") - __properties = ["pkiPaymenttermID", "sPaymenttermCode", "ePaymenttermType", "iPaymenttermDay", "sPaymenttermDescriptionX", "bPaymenttermIsactive"] - - @validator('s_paymentterm_code') + A Paymentterm List Element + """ # noqa: E501 + pki_paymentterm_id: StrictInt = Field(description="The unique ID of the Paymentterm", alias="pkiPaymenttermID") + s_paymentterm_code: Annotated[str, Field(strict=True)] = Field(description="The code of the Paymentterm", alias="sPaymenttermCode") + e_paymentterm_type: FieldEPaymenttermType = Field(alias="ePaymenttermType") + i_paymentterm_day: Annotated[int, Field(le=255, strict=True, ge=0)] = Field(description="The day of the Paymentterm", alias="iPaymenttermDay") + s_paymentterm_description_x: Annotated[str, Field(strict=True)] = Field(description="The description of the Paymentterm in the language of the requester", alias="sPaymenttermDescriptionX") + b_paymentterm_isactive: StrictBool = Field(description="Whether the Paymentterm is active or not", alias="bPaymenttermIsactive") + __properties: ClassVar[List[str]] = ["pkiPaymenttermID", "sPaymenttermCode", "ePaymenttermType", "iPaymenttermDay", "sPaymenttermDescriptionX", "bPaymenttermIsactive"] + + @field_validator('s_paymentterm_code') def s_paymentterm_code_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^[A-Z0-9]{1,4}$", value): raise ValueError(r"must validate the regular expression /^[A-Z0-9]{1,4}$/") return value - @validator('s_paymentterm_description_x') + @field_validator('s_paymentterm_description_x') def s_paymentterm_description_x_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^.{1,40}$", value): raise ValueError(r"must validate the regular expression /^.{1,40}$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> PaymenttermListElement: + def from_json(cls, json_str: str) -> Self: """Create an instance of PaymenttermListElement from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> PaymenttermListElement: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of PaymenttermListElement from a dict""" if obj is None: return None if not isinstance(obj, dict): - return PaymenttermListElement.parse_obj(obj) - - _obj = PaymenttermListElement.parse_obj({ - "pki_paymentterm_id": obj.get("pkiPaymenttermID"), - "s_paymentterm_code": obj.get("sPaymenttermCode"), - "e_paymentterm_type": obj.get("ePaymenttermType"), - "i_paymentterm_day": obj.get("iPaymenttermDay"), - "s_paymentterm_description_x": obj.get("sPaymenttermDescriptionX"), - "b_paymentterm_isactive": obj.get("bPaymenttermIsactive") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiPaymenttermID": obj.get("pkiPaymenttermID"), + "sPaymenttermCode": obj.get("sPaymenttermCode"), + "ePaymenttermType": obj.get("ePaymenttermType"), + "iPaymenttermDay": obj.get("iPaymenttermDay"), + "sPaymenttermDescriptionX": obj.get("sPaymenttermDescriptionX"), + "bPaymenttermIsactive": obj.get("bPaymenttermIsactive") }) return _obj diff --git a/eZmaxApi/models/paymentterm_request.py b/eZmaxApi/models/paymentterm_request.py index cd38ca191..2b6061331 100644 --- a/eZmaxApi/models/paymentterm_request.py +++ b/eZmaxApi/models/paymentterm_request.py @@ -19,75 +19,94 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictBool, StrictInt, conint, constr, validator +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, StrictInt, field_validator +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.field_e_paymentterm_type import FieldEPaymenttermType from eZmaxApi.models.multilingual_paymentterm_description import MultilingualPaymenttermDescription +try: + from typing import Self +except ImportError: + from typing_extensions import Self class PaymenttermRequest(BaseModel): """ - A Paymentterm Object # noqa: E501 - """ - pki_paymentterm_id: Optional[StrictInt] = Field(None, alias="pkiPaymenttermID", description="The unique ID of the Paymentterm") - s_paymentterm_code: constr(strict=True) = Field(..., alias="sPaymenttermCode", description="The code of the Paymentterm") - e_paymentterm_type: FieldEPaymenttermType = Field(..., alias="ePaymenttermType") - i_paymentterm_day: conint(strict=True, le=255, ge=0) = Field(..., alias="iPaymenttermDay", description="The day of the Paymentterm") - obj_paymentterm_description: MultilingualPaymenttermDescription = Field(..., alias="objPaymenttermDescription") - b_paymentterm_isactive: StrictBool = Field(..., alias="bPaymenttermIsactive", description="Whether the Paymentterm is active or not") - __properties = ["pkiPaymenttermID", "sPaymenttermCode", "ePaymenttermType", "iPaymenttermDay", "objPaymenttermDescription", "bPaymenttermIsactive"] - - @validator('s_paymentterm_code') + A Paymentterm Object + """ # noqa: E501 + pki_paymentterm_id: Optional[StrictInt] = Field(default=None, description="The unique ID of the Paymentterm", alias="pkiPaymenttermID") + s_paymentterm_code: Annotated[str, Field(strict=True)] = Field(description="The code of the Paymentterm", alias="sPaymenttermCode") + e_paymentterm_type: FieldEPaymenttermType = Field(alias="ePaymenttermType") + i_paymentterm_day: Annotated[int, Field(le=255, strict=True, ge=0)] = Field(description="The day of the Paymentterm", alias="iPaymenttermDay") + obj_paymentterm_description: MultilingualPaymenttermDescription = Field(alias="objPaymenttermDescription") + b_paymentterm_isactive: StrictBool = Field(description="Whether the Paymentterm is active or not", alias="bPaymenttermIsactive") + __properties: ClassVar[List[str]] = ["pkiPaymenttermID", "sPaymenttermCode", "ePaymenttermType", "iPaymenttermDay", "objPaymenttermDescription", "bPaymenttermIsactive"] + + @field_validator('s_paymentterm_code') def s_paymentterm_code_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^[A-Z0-9]{1,4}$", value): raise ValueError(r"must validate the regular expression /^[A-Z0-9]{1,4}$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> PaymenttermRequest: + def from_json(cls, json_str: str) -> Self: """Create an instance of PaymenttermRequest from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_paymentterm_description if self.obj_paymentterm_description: _dict['objPaymenttermDescription'] = self.obj_paymentterm_description.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> PaymenttermRequest: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of PaymenttermRequest from a dict""" if obj is None: return None if not isinstance(obj, dict): - return PaymenttermRequest.parse_obj(obj) - - _obj = PaymenttermRequest.parse_obj({ - "pki_paymentterm_id": obj.get("pkiPaymenttermID"), - "s_paymentterm_code": obj.get("sPaymenttermCode"), - "e_paymentterm_type": obj.get("ePaymenttermType"), - "i_paymentterm_day": obj.get("iPaymenttermDay"), - "obj_paymentterm_description": MultilingualPaymenttermDescription.from_dict(obj.get("objPaymenttermDescription")) if obj.get("objPaymenttermDescription") is not None else None, - "b_paymentterm_isactive": obj.get("bPaymenttermIsactive") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiPaymenttermID": obj.get("pkiPaymenttermID"), + "sPaymenttermCode": obj.get("sPaymenttermCode"), + "ePaymenttermType": obj.get("ePaymenttermType"), + "iPaymenttermDay": obj.get("iPaymenttermDay"), + "objPaymenttermDescription": MultilingualPaymenttermDescription.from_dict(obj.get("objPaymenttermDescription")) if obj.get("objPaymenttermDescription") is not None else None, + "bPaymenttermIsactive": obj.get("bPaymenttermIsactive") }) return _obj diff --git a/eZmaxApi/models/paymentterm_request_compound.py b/eZmaxApi/models/paymentterm_request_compound.py index 1c3e8fd06..6a97a3964 100644 --- a/eZmaxApi/models/paymentterm_request_compound.py +++ b/eZmaxApi/models/paymentterm_request_compound.py @@ -19,75 +19,94 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictBool, StrictInt, conint, constr, validator +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, StrictInt, field_validator +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.field_e_paymentterm_type import FieldEPaymenttermType from eZmaxApi.models.multilingual_paymentterm_description import MultilingualPaymenttermDescription +try: + from typing import Self +except ImportError: + from typing_extensions import Self class PaymenttermRequestCompound(BaseModel): """ - A Paymentterm Object and children # noqa: E501 - """ - pki_paymentterm_id: Optional[StrictInt] = Field(None, alias="pkiPaymenttermID", description="The unique ID of the Paymentterm") - s_paymentterm_code: constr(strict=True) = Field(..., alias="sPaymenttermCode", description="The code of the Paymentterm") - e_paymentterm_type: FieldEPaymenttermType = Field(..., alias="ePaymenttermType") - i_paymentterm_day: conint(strict=True, le=255, ge=0) = Field(..., alias="iPaymenttermDay", description="The day of the Paymentterm") - obj_paymentterm_description: MultilingualPaymenttermDescription = Field(..., alias="objPaymenttermDescription") - b_paymentterm_isactive: StrictBool = Field(..., alias="bPaymenttermIsactive", description="Whether the Paymentterm is active or not") - __properties = ["pkiPaymenttermID", "sPaymenttermCode", "ePaymenttermType", "iPaymenttermDay", "objPaymenttermDescription", "bPaymenttermIsactive"] - - @validator('s_paymentterm_code') + A Paymentterm Object and children + """ # noqa: E501 + pki_paymentterm_id: Optional[StrictInt] = Field(default=None, description="The unique ID of the Paymentterm", alias="pkiPaymenttermID") + s_paymentterm_code: Annotated[str, Field(strict=True)] = Field(description="The code of the Paymentterm", alias="sPaymenttermCode") + e_paymentterm_type: FieldEPaymenttermType = Field(alias="ePaymenttermType") + i_paymentterm_day: Annotated[int, Field(le=255, strict=True, ge=0)] = Field(description="The day of the Paymentterm", alias="iPaymenttermDay") + obj_paymentterm_description: MultilingualPaymenttermDescription = Field(alias="objPaymenttermDescription") + b_paymentterm_isactive: StrictBool = Field(description="Whether the Paymentterm is active or not", alias="bPaymenttermIsactive") + __properties: ClassVar[List[str]] = ["pkiPaymenttermID", "sPaymenttermCode", "ePaymenttermType", "iPaymenttermDay", "objPaymenttermDescription", "bPaymenttermIsactive"] + + @field_validator('s_paymentterm_code') def s_paymentterm_code_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^[A-Z0-9]{1,4}$", value): raise ValueError(r"must validate the regular expression /^[A-Z0-9]{1,4}$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> PaymenttermRequestCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of PaymenttermRequestCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_paymentterm_description if self.obj_paymentterm_description: _dict['objPaymenttermDescription'] = self.obj_paymentterm_description.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> PaymenttermRequestCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of PaymenttermRequestCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return PaymenttermRequestCompound.parse_obj(obj) - - _obj = PaymenttermRequestCompound.parse_obj({ - "pki_paymentterm_id": obj.get("pkiPaymenttermID"), - "s_paymentterm_code": obj.get("sPaymenttermCode"), - "e_paymentterm_type": obj.get("ePaymenttermType"), - "i_paymentterm_day": obj.get("iPaymenttermDay"), - "obj_paymentterm_description": MultilingualPaymenttermDescription.from_dict(obj.get("objPaymenttermDescription")) if obj.get("objPaymenttermDescription") is not None else None, - "b_paymentterm_isactive": obj.get("bPaymenttermIsactive") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiPaymenttermID": obj.get("pkiPaymenttermID"), + "sPaymenttermCode": obj.get("sPaymenttermCode"), + "ePaymenttermType": obj.get("ePaymenttermType"), + "iPaymenttermDay": obj.get("iPaymenttermDay"), + "objPaymenttermDescription": MultilingualPaymenttermDescription.from_dict(obj.get("objPaymenttermDescription")) if obj.get("objPaymenttermDescription") is not None else None, + "bPaymenttermIsactive": obj.get("bPaymenttermIsactive") }) return _obj diff --git a/eZmaxApi/models/paymentterm_response.py b/eZmaxApi/models/paymentterm_response.py index 2e413d60f..d18f6e8cc 100644 --- a/eZmaxApi/models/paymentterm_response.py +++ b/eZmaxApi/models/paymentterm_response.py @@ -19,56 +19,75 @@ import json - -from pydantic import BaseModel, Field, StrictBool, StrictInt, conint, constr, validator +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictBool, StrictInt, field_validator +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.common_audit import CommonAudit from eZmaxApi.models.field_e_paymentterm_type import FieldEPaymenttermType from eZmaxApi.models.multilingual_paymentterm_description import MultilingualPaymenttermDescription +try: + from typing import Self +except ImportError: + from typing_extensions import Self class PaymenttermResponse(BaseModel): """ - A Paymentterm Object # noqa: E501 - """ - pki_paymentterm_id: StrictInt = Field(..., alias="pkiPaymenttermID", description="The unique ID of the Paymentterm") - s_paymentterm_code: constr(strict=True) = Field(..., alias="sPaymenttermCode", description="The code of the Paymentterm") - e_paymentterm_type: FieldEPaymenttermType = Field(..., alias="ePaymenttermType") - i_paymentterm_day: conint(strict=True, le=255, ge=0) = Field(..., alias="iPaymenttermDay", description="The day of the Paymentterm") - obj_paymentterm_description: MultilingualPaymenttermDescription = Field(..., alias="objPaymenttermDescription") - b_paymentterm_isactive: StrictBool = Field(..., alias="bPaymenttermIsactive", description="Whether the Paymentterm is active or not") - obj_audit: CommonAudit = Field(..., alias="objAudit") - __properties = ["pkiPaymenttermID", "sPaymenttermCode", "ePaymenttermType", "iPaymenttermDay", "objPaymenttermDescription", "bPaymenttermIsactive", "objAudit"] - - @validator('s_paymentterm_code') + A Paymentterm Object + """ # noqa: E501 + pki_paymentterm_id: StrictInt = Field(description="The unique ID of the Paymentterm", alias="pkiPaymenttermID") + s_paymentterm_code: Annotated[str, Field(strict=True)] = Field(description="The code of the Paymentterm", alias="sPaymenttermCode") + e_paymentterm_type: FieldEPaymenttermType = Field(alias="ePaymenttermType") + i_paymentterm_day: Annotated[int, Field(le=255, strict=True, ge=0)] = Field(description="The day of the Paymentterm", alias="iPaymenttermDay") + obj_paymentterm_description: MultilingualPaymenttermDescription = Field(alias="objPaymenttermDescription") + b_paymentterm_isactive: StrictBool = Field(description="Whether the Paymentterm is active or not", alias="bPaymenttermIsactive") + obj_audit: CommonAudit = Field(alias="objAudit") + __properties: ClassVar[List[str]] = ["pkiPaymenttermID", "sPaymenttermCode", "ePaymenttermType", "iPaymenttermDay", "objPaymenttermDescription", "bPaymenttermIsactive", "objAudit"] + + @field_validator('s_paymentterm_code') def s_paymentterm_code_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^[A-Z0-9]{1,4}$", value): raise ValueError(r"must validate the regular expression /^[A-Z0-9]{1,4}$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> PaymenttermResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of PaymenttermResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_paymentterm_description if self.obj_paymentterm_description: _dict['objPaymenttermDescription'] = self.obj_paymentterm_description.to_dict() @@ -78,22 +97,22 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> PaymenttermResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of PaymenttermResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return PaymenttermResponse.parse_obj(obj) - - _obj = PaymenttermResponse.parse_obj({ - "pki_paymentterm_id": obj.get("pkiPaymenttermID"), - "s_paymentterm_code": obj.get("sPaymenttermCode"), - "e_paymentterm_type": obj.get("ePaymenttermType"), - "i_paymentterm_day": obj.get("iPaymenttermDay"), - "obj_paymentterm_description": MultilingualPaymenttermDescription.from_dict(obj.get("objPaymenttermDescription")) if obj.get("objPaymenttermDescription") is not None else None, - "b_paymentterm_isactive": obj.get("bPaymenttermIsactive"), - "obj_audit": CommonAudit.from_dict(obj.get("objAudit")) if obj.get("objAudit") is not None else None + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiPaymenttermID": obj.get("pkiPaymenttermID"), + "sPaymenttermCode": obj.get("sPaymenttermCode"), + "ePaymenttermType": obj.get("ePaymenttermType"), + "iPaymenttermDay": obj.get("iPaymenttermDay"), + "objPaymenttermDescription": MultilingualPaymenttermDescription.from_dict(obj.get("objPaymenttermDescription")) if obj.get("objPaymenttermDescription") is not None else None, + "bPaymenttermIsactive": obj.get("bPaymenttermIsactive"), + "objAudit": CommonAudit.from_dict(obj.get("objAudit")) if obj.get("objAudit") is not None else None }) return _obj diff --git a/eZmaxApi/models/paymentterm_response_compound.py b/eZmaxApi/models/paymentterm_response_compound.py index b1ae8cb15..5734f3414 100644 --- a/eZmaxApi/models/paymentterm_response_compound.py +++ b/eZmaxApi/models/paymentterm_response_compound.py @@ -19,56 +19,75 @@ import json - -from pydantic import BaseModel, Field, StrictBool, StrictInt, conint, constr, validator +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictBool, StrictInt, field_validator +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.common_audit import CommonAudit from eZmaxApi.models.field_e_paymentterm_type import FieldEPaymenttermType from eZmaxApi.models.multilingual_paymentterm_description import MultilingualPaymenttermDescription +try: + from typing import Self +except ImportError: + from typing_extensions import Self class PaymenttermResponseCompound(BaseModel): """ - A Paymentterm Object # noqa: E501 - """ - pki_paymentterm_id: StrictInt = Field(..., alias="pkiPaymenttermID", description="The unique ID of the Paymentterm") - s_paymentterm_code: constr(strict=True) = Field(..., alias="sPaymenttermCode", description="The code of the Paymentterm") - e_paymentterm_type: FieldEPaymenttermType = Field(..., alias="ePaymenttermType") - i_paymentterm_day: conint(strict=True, le=255, ge=0) = Field(..., alias="iPaymenttermDay", description="The day of the Paymentterm") - obj_paymentterm_description: MultilingualPaymenttermDescription = Field(..., alias="objPaymenttermDescription") - b_paymentterm_isactive: StrictBool = Field(..., alias="bPaymenttermIsactive", description="Whether the Paymentterm is active or not") - obj_audit: CommonAudit = Field(..., alias="objAudit") - __properties = ["pkiPaymenttermID", "sPaymenttermCode", "ePaymenttermType", "iPaymenttermDay", "objPaymenttermDescription", "bPaymenttermIsactive", "objAudit"] - - @validator('s_paymentterm_code') + A Paymentterm Object + """ # noqa: E501 + pki_paymentterm_id: StrictInt = Field(description="The unique ID of the Paymentterm", alias="pkiPaymenttermID") + s_paymentterm_code: Annotated[str, Field(strict=True)] = Field(description="The code of the Paymentterm", alias="sPaymenttermCode") + e_paymentterm_type: FieldEPaymenttermType = Field(alias="ePaymenttermType") + i_paymentterm_day: Annotated[int, Field(le=255, strict=True, ge=0)] = Field(description="The day of the Paymentterm", alias="iPaymenttermDay") + obj_paymentterm_description: MultilingualPaymenttermDescription = Field(alias="objPaymenttermDescription") + b_paymentterm_isactive: StrictBool = Field(description="Whether the Paymentterm is active or not", alias="bPaymenttermIsactive") + obj_audit: CommonAudit = Field(alias="objAudit") + __properties: ClassVar[List[str]] = ["pkiPaymenttermID", "sPaymenttermCode", "ePaymenttermType", "iPaymenttermDay", "objPaymenttermDescription", "bPaymenttermIsactive", "objAudit"] + + @field_validator('s_paymentterm_code') def s_paymentterm_code_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^[A-Z0-9]{1,4}$", value): raise ValueError(r"must validate the regular expression /^[A-Z0-9]{1,4}$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> PaymenttermResponseCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of PaymenttermResponseCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_paymentterm_description if self.obj_paymentterm_description: _dict['objPaymenttermDescription'] = self.obj_paymentterm_description.to_dict() @@ -78,22 +97,22 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> PaymenttermResponseCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of PaymenttermResponseCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return PaymenttermResponseCompound.parse_obj(obj) - - _obj = PaymenttermResponseCompound.parse_obj({ - "pki_paymentterm_id": obj.get("pkiPaymenttermID"), - "s_paymentterm_code": obj.get("sPaymenttermCode"), - "e_paymentterm_type": obj.get("ePaymenttermType"), - "i_paymentterm_day": obj.get("iPaymenttermDay"), - "obj_paymentterm_description": MultilingualPaymenttermDescription.from_dict(obj.get("objPaymenttermDescription")) if obj.get("objPaymenttermDescription") is not None else None, - "b_paymentterm_isactive": obj.get("bPaymenttermIsactive"), - "obj_audit": CommonAudit.from_dict(obj.get("objAudit")) if obj.get("objAudit") is not None else None + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiPaymenttermID": obj.get("pkiPaymenttermID"), + "sPaymenttermCode": obj.get("sPaymenttermCode"), + "ePaymenttermType": obj.get("ePaymenttermType"), + "iPaymenttermDay": obj.get("iPaymenttermDay"), + "objPaymenttermDescription": MultilingualPaymenttermDescription.from_dict(obj.get("objPaymenttermDescription")) if obj.get("objPaymenttermDescription") is not None else None, + "bPaymenttermIsactive": obj.get("bPaymenttermIsactive"), + "objAudit": CommonAudit.from_dict(obj.get("objAudit")) if obj.get("objAudit") is not None else None }) return _obj diff --git a/eZmaxApi/models/period_autocomplete_element_response.py b/eZmaxApi/models/period_autocomplete_element_response.py index f646e94ba..cce07d77a 100644 --- a/eZmaxApi/models/period_autocomplete_element_response.py +++ b/eZmaxApi/models/period_autocomplete_element_response.py @@ -19,57 +19,76 @@ import json - -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictBool, StrictStr +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class PeriodAutocompleteElementResponse(BaseModel): """ - A Period AutocompleteElement Response # noqa: E501 - """ - s_period_yyyymm: StrictStr = Field(..., alias="sPeriodYYYYMM", description="The YYYYMM of the Period") - pki_period_id: conint(strict=True, ge=0) = Field(..., alias="pkiPeriodID", description="The unique ID of the Period") - b_period_isactive: StrictBool = Field(..., alias="bPeriodIsactive", description="Whether the Period is active or not") - __properties = ["sPeriodYYYYMM", "pkiPeriodID", "bPeriodIsactive"] + A Period AutocompleteElement Response + """ # noqa: E501 + s_period_yyyymm: StrictStr = Field(description="The YYYYMM of the Period", alias="sPeriodYYYYMM") + pki_period_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Period", alias="pkiPeriodID") + b_period_isactive: StrictBool = Field(description="Whether the Period is active or not", alias="bPeriodIsactive") + __properties: ClassVar[List[str]] = ["sPeriodYYYYMM", "pkiPeriodID", "bPeriodIsactive"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> PeriodAutocompleteElementResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of PeriodAutocompleteElementResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> PeriodAutocompleteElementResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of PeriodAutocompleteElementResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return PeriodAutocompleteElementResponse.parse_obj(obj) + return cls.model_validate(obj) - _obj = PeriodAutocompleteElementResponse.parse_obj({ - "s_period_yyyymm": obj.get("sPeriodYYYYMM"), - "pki_period_id": obj.get("pkiPeriodID"), - "b_period_isactive": obj.get("bPeriodIsactive") + _obj = cls.model_validate({ + "sPeriodYYYYMM": obj.get("sPeriodYYYYMM"), + "pkiPeriodID": obj.get("pkiPeriodID"), + "bPeriodIsactive": obj.get("bPeriodIsactive") }) return _obj diff --git a/eZmaxApi/models/period_get_autocomplete_v2_response.py b/eZmaxApi/models/period_get_autocomplete_v2_response.py index c8aa45d88..5d9175e05 100644 --- a/eZmaxApi/models/period_get_autocomplete_v2_response.py +++ b/eZmaxApi/models/period_get_autocomplete_v2_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.period_get_autocomplete_v2_response_m_payload import PeriodGetAutocompleteV2ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class PeriodGetAutocompleteV2Response(BaseModel): """ - Response for GET /2/object/period/getAutocomplete # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: PeriodGetAutocompleteV2ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /2/object/period/getAutocomplete + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: PeriodGetAutocompleteV2ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> PeriodGetAutocompleteV2Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of PeriodGetAutocompleteV2Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> PeriodGetAutocompleteV2Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of PeriodGetAutocompleteV2Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return PeriodGetAutocompleteV2Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = PeriodGetAutocompleteV2Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": PeriodGetAutocompleteV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": PeriodGetAutocompleteV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/period_get_autocomplete_v2_response_m_payload.py b/eZmaxApi/models/period_get_autocomplete_v2_response_m_payload.py index 747306dac..44bdcdd47 100644 --- a/eZmaxApi/models/period_get_autocomplete_v2_response_m_payload.py +++ b/eZmaxApi/models/period_get_autocomplete_v2_response_m_payload.py @@ -19,41 +19,59 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.period_autocomplete_element_response import PeriodAutocompleteElementResponse +try: + from typing import Self +except ImportError: + from typing_extensions import Self class PeriodGetAutocompleteV2ResponseMPayload(BaseModel): """ - Payload for POST /2/object/period/getAutocomplete # noqa: E501 - """ - a_obj_period: conlist(PeriodAutocompleteElementResponse) = Field(..., alias="a_objPeriod", description="An array of Period autocomplete element response.") - __properties = ["a_objPeriod"] + Payload for POST /2/object/period/getAutocomplete + """ # noqa: E501 + a_obj_period: List[PeriodAutocompleteElementResponse] = Field(description="An array of Period autocomplete element response.", alias="a_objPeriod") + __properties: ClassVar[List[str]] = ["a_objPeriod"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> PeriodGetAutocompleteV2ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of PeriodGetAutocompleteV2ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_period (list) _items = [] if self.a_obj_period: @@ -64,16 +82,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> PeriodGetAutocompleteV2ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of PeriodGetAutocompleteV2ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return PeriodGetAutocompleteV2ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = PeriodGetAutocompleteV2ResponseMPayload.parse_obj({ - "a_obj_period": [PeriodAutocompleteElementResponse.from_dict(_item) for _item in obj.get("a_objPeriod")] if obj.get("a_objPeriod") is not None else None + _obj = cls.model_validate({ + "a_objPeriod": [PeriodAutocompleteElementResponse.from_dict(_item) for _item in obj.get("a_objPeriod")] if obj.get("a_objPeriod") is not None else None }) return _obj diff --git a/eZmaxApi/models/permission_create_object_v1_request.py b/eZmaxApi/models/permission_create_object_v1_request.py index de16f05ca..09a7c52cf 100644 --- a/eZmaxApi/models/permission_create_object_v1_request.py +++ b/eZmaxApi/models/permission_create_object_v1_request.py @@ -19,41 +19,60 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.permission_request_compound import PermissionRequestCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class PermissionCreateObjectV1Request(BaseModel): """ - Request for POST /1/object/permission # noqa: E501 - """ - a_obj_permission: conlist(PermissionRequestCompound, min_items=1) = Field(..., alias="a_objPermission") - __properties = ["a_objPermission"] + Request for POST /1/object/permission + """ # noqa: E501 + a_obj_permission: Annotated[List[PermissionRequestCompound], Field(min_length=1)] = Field(alias="a_objPermission") + __properties: ClassVar[List[str]] = ["a_objPermission"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> PermissionCreateObjectV1Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of PermissionCreateObjectV1Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_permission (list) _items = [] if self.a_obj_permission: @@ -64,16 +83,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> PermissionCreateObjectV1Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of PermissionCreateObjectV1Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return PermissionCreateObjectV1Request.parse_obj(obj) + return cls.model_validate(obj) - _obj = PermissionCreateObjectV1Request.parse_obj({ - "a_obj_permission": [PermissionRequestCompound.from_dict(_item) for _item in obj.get("a_objPermission")] if obj.get("a_objPermission") is not None else None + _obj = cls.model_validate({ + "a_objPermission": [PermissionRequestCompound.from_dict(_item) for _item in obj.get("a_objPermission")] if obj.get("a_objPermission") is not None else None }) return _obj diff --git a/eZmaxApi/models/permission_create_object_v1_response.py b/eZmaxApi/models/permission_create_object_v1_response.py index 525d587e6..7cab0b2c1 100644 --- a/eZmaxApi/models/permission_create_object_v1_response.py +++ b/eZmaxApi/models/permission_create_object_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.permission_create_object_v1_response_m_payload import PermissionCreateObjectV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class PermissionCreateObjectV1Response(BaseModel): """ - Response for POST /1/object/permission # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: PermissionCreateObjectV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for POST /1/object/permission + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: PermissionCreateObjectV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> PermissionCreateObjectV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of PermissionCreateObjectV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> PermissionCreateObjectV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of PermissionCreateObjectV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return PermissionCreateObjectV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = PermissionCreateObjectV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": PermissionCreateObjectV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": PermissionCreateObjectV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/permission_create_object_v1_response_m_payload.py b/eZmaxApi/models/permission_create_object_v1_response_m_payload.py index cf55776ac..e686802c6 100644 --- a/eZmaxApi/models/permission_create_object_v1_response_m_payload.py +++ b/eZmaxApi/models/permission_create_object_v1_response_m_payload.py @@ -19,53 +19,72 @@ import json -from typing import List -from pydantic import BaseModel, Field, conint, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class PermissionCreateObjectV1ResponseMPayload(BaseModel): """ - Payload for POST /1/object/permission # noqa: E501 - """ - a_pki_permission_id: conlist(conint(strict=True, le=65535, ge=0)) = Field(..., alias="a_pkiPermissionID", description="An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request.") - __properties = ["a_pkiPermissionID"] + Payload for POST /1/object/permission + """ # noqa: E501 + a_pki_permission_id: List[Annotated[int, Field(le=65535, strict=True, ge=0)]] = Field(description="An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request.", alias="a_pkiPermissionID") + __properties: ClassVar[List[str]] = ["a_pkiPermissionID"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> PermissionCreateObjectV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of PermissionCreateObjectV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> PermissionCreateObjectV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of PermissionCreateObjectV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return PermissionCreateObjectV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = PermissionCreateObjectV1ResponseMPayload.parse_obj({ - "a_pki_permission_id": obj.get("a_pkiPermissionID") + _obj = cls.model_validate({ + "a_pkiPermissionID": obj.get("a_pkiPermissionID") }) return _obj diff --git a/eZmaxApi/models/permission_delete_object_v1_response.py b/eZmaxApi/models/permission_delete_object_v1_response.py index da4a30066..f1f732cb3 100644 --- a/eZmaxApi/models/permission_delete_object_v1_response.py +++ b/eZmaxApi/models/permission_delete_object_v1_response.py @@ -19,43 +19,61 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class PermissionDeleteObjectV1Response(BaseModel): """ - Response for DELETE /1/object/permission/{pkiPermissionID} # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - __properties = ["objDebugPayload", "objDebug"] + Response for DELETE /1/object/permission/{pkiPermissionID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> PermissionDeleteObjectV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of PermissionDeleteObjectV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -65,17 +83,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> PermissionDeleteObjectV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of PermissionDeleteObjectV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return PermissionDeleteObjectV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = PermissionDeleteObjectV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None }) return _obj diff --git a/eZmaxApi/models/permission_edit_object_v1_request.py b/eZmaxApi/models/permission_edit_object_v1_request.py index 208a522b8..d7bc7ddeb 100644 --- a/eZmaxApi/models/permission_edit_object_v1_request.py +++ b/eZmaxApi/models/permission_edit_object_v1_request.py @@ -19,57 +19,75 @@ import json - -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.permission_request_compound import PermissionRequestCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class PermissionEditObjectV1Request(BaseModel): """ - Request for PUT /1/object/permission/{pkiPermissionID} # noqa: E501 - """ - obj_permission: PermissionRequestCompound = Field(..., alias="objPermission") - __properties = ["objPermission"] + Request for PUT /1/object/permission/{pkiPermissionID} + """ # noqa: E501 + obj_permission: PermissionRequestCompound = Field(alias="objPermission") + __properties: ClassVar[List[str]] = ["objPermission"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> PermissionEditObjectV1Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of PermissionEditObjectV1Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_permission if self.obj_permission: _dict['objPermission'] = self.obj_permission.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> PermissionEditObjectV1Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of PermissionEditObjectV1Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return PermissionEditObjectV1Request.parse_obj(obj) + return cls.model_validate(obj) - _obj = PermissionEditObjectV1Request.parse_obj({ - "obj_permission": PermissionRequestCompound.from_dict(obj.get("objPermission")) if obj.get("objPermission") is not None else None + _obj = cls.model_validate({ + "objPermission": PermissionRequestCompound.from_dict(obj.get("objPermission")) if obj.get("objPermission") is not None else None }) return _obj diff --git a/eZmaxApi/models/permission_edit_object_v1_response.py b/eZmaxApi/models/permission_edit_object_v1_response.py index 05a264ccc..8fba6d4fb 100644 --- a/eZmaxApi/models/permission_edit_object_v1_response.py +++ b/eZmaxApi/models/permission_edit_object_v1_response.py @@ -19,43 +19,61 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class PermissionEditObjectV1Response(BaseModel): """ - Response for PUT /1/object/permission/{pkiPermissionID} # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - __properties = ["objDebugPayload", "objDebug"] + Response for PUT /1/object/permission/{pkiPermissionID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> PermissionEditObjectV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of PermissionEditObjectV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -65,17 +83,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> PermissionEditObjectV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of PermissionEditObjectV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return PermissionEditObjectV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = PermissionEditObjectV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None }) return _obj diff --git a/eZmaxApi/models/permission_get_object_v2_response.py b/eZmaxApi/models/permission_get_object_v2_response.py index b757b7e21..706cb1be6 100644 --- a/eZmaxApi/models/permission_get_object_v2_response.py +++ b/eZmaxApi/models/permission_get_object_v2_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.permission_get_object_v2_response_m_payload import PermissionGetObjectV2ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class PermissionGetObjectV2Response(BaseModel): """ - Response for GET /2/object/permission/{pkiPermissionID} # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: PermissionGetObjectV2ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /2/object/permission/{pkiPermissionID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: PermissionGetObjectV2ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> PermissionGetObjectV2Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of PermissionGetObjectV2Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> PermissionGetObjectV2Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of PermissionGetObjectV2Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return PermissionGetObjectV2Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = PermissionGetObjectV2Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": PermissionGetObjectV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": PermissionGetObjectV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/permission_get_object_v2_response_m_payload.py b/eZmaxApi/models/permission_get_object_v2_response_m_payload.py index 2b466e444..f85352087 100644 --- a/eZmaxApi/models/permission_get_object_v2_response_m_payload.py +++ b/eZmaxApi/models/permission_get_object_v2_response_m_payload.py @@ -19,57 +19,75 @@ import json - -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.permission_response_compound import PermissionResponseCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class PermissionGetObjectV2ResponseMPayload(BaseModel): """ - Payload for GET /2/object/permission/{pkiPermissionID} # noqa: E501 - """ - obj_permission: PermissionResponseCompound = Field(..., alias="objPermission") - __properties = ["objPermission"] + Payload for GET /2/object/permission/{pkiPermissionID} + """ # noqa: E501 + obj_permission: PermissionResponseCompound = Field(alias="objPermission") + __properties: ClassVar[List[str]] = ["objPermission"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> PermissionGetObjectV2ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of PermissionGetObjectV2ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_permission if self.obj_permission: _dict['objPermission'] = self.obj_permission.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> PermissionGetObjectV2ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of PermissionGetObjectV2ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return PermissionGetObjectV2ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = PermissionGetObjectV2ResponseMPayload.parse_obj({ - "obj_permission": PermissionResponseCompound.from_dict(obj.get("objPermission")) if obj.get("objPermission") is not None else None + _obj = cls.model_validate({ + "objPermission": PermissionResponseCompound.from_dict(obj.get("objPermission")) if obj.get("objPermission") is not None else None }) return _obj diff --git a/eZmaxApi/models/permission_request.py b/eZmaxApi/models/permission_request.py index a0e9135c8..4f8493746 100644 --- a/eZmaxApi/models/permission_request.py +++ b/eZmaxApi/models/permission_request.py @@ -19,63 +19,82 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class PermissionRequest(BaseModel): """ - A Permission Object # noqa: E501 - """ - pki_permission_id: Optional[conint(strict=True, le=65535, ge=0)] = Field(None, alias="pkiPermissionID", description="The unique ID of the Permission") - fki_user_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiUserID", description="The unique ID of the User") - fki_apikey_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiApikeyID", description="The unique ID of the Apikey") - fki_usergroup_id: Optional[conint(strict=True, le=255, ge=0)] = Field(None, alias="fkiUsergroupID", description="The unique ID of the Usergroup") - fki_company_id: Optional[conint(strict=True, le=255, ge=1)] = Field(None, alias="fkiCompanyID", description="The unique ID of the Company") - fki_modulesection_id: conint(strict=True, ge=0) = Field(..., alias="fkiModulesectionID", description="The unique ID of the Modulesection") - __properties = ["pkiPermissionID", "fkiUserID", "fkiApikeyID", "fkiUsergroupID", "fkiCompanyID", "fkiModulesectionID"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + A Permission Object + """ # noqa: E501 + pki_permission_id: Optional[Annotated[int, Field(le=65535, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Permission", alias="pkiPermissionID") + fki_user_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the User", alias="fkiUserID") + fki_apikey_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Apikey", alias="fkiApikeyID") + fki_usergroup_id: Optional[Annotated[int, Field(le=255, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Usergroup", alias="fkiUsergroupID") + fki_company_id: Optional[Annotated[int, Field(le=255, strict=True, ge=1)]] = Field(default=None, description="The unique ID of the Company", alias="fkiCompanyID") + fki_modulesection_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Modulesection", alias="fkiModulesectionID") + __properties: ClassVar[List[str]] = ["pkiPermissionID", "fkiUserID", "fkiApikeyID", "fkiUsergroupID", "fkiCompanyID", "fkiModulesectionID"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> PermissionRequest: + def from_json(cls, json_str: str) -> Self: """Create an instance of PermissionRequest from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> PermissionRequest: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of PermissionRequest from a dict""" if obj is None: return None if not isinstance(obj, dict): - return PermissionRequest.parse_obj(obj) - - _obj = PermissionRequest.parse_obj({ - "pki_permission_id": obj.get("pkiPermissionID"), - "fki_user_id": obj.get("fkiUserID"), - "fki_apikey_id": obj.get("fkiApikeyID"), - "fki_usergroup_id": obj.get("fkiUsergroupID"), - "fki_company_id": obj.get("fkiCompanyID"), - "fki_modulesection_id": obj.get("fkiModulesectionID") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiPermissionID": obj.get("pkiPermissionID"), + "fkiUserID": obj.get("fkiUserID"), + "fkiApikeyID": obj.get("fkiApikeyID"), + "fkiUsergroupID": obj.get("fkiUsergroupID"), + "fkiCompanyID": obj.get("fkiCompanyID"), + "fkiModulesectionID": obj.get("fkiModulesectionID") }) return _obj diff --git a/eZmaxApi/models/permission_request_compound.py b/eZmaxApi/models/permission_request_compound.py index 621d6bc96..6a38b0fed 100644 --- a/eZmaxApi/models/permission_request_compound.py +++ b/eZmaxApi/models/permission_request_compound.py @@ -19,63 +19,82 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class PermissionRequestCompound(BaseModel): """ - A Permission Object and children to create a complete structure # noqa: E501 - """ - pki_permission_id: Optional[conint(strict=True, le=65535, ge=0)] = Field(None, alias="pkiPermissionID", description="The unique ID of the Permission") - fki_user_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiUserID", description="The unique ID of the User") - fki_apikey_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiApikeyID", description="The unique ID of the Apikey") - fki_usergroup_id: Optional[conint(strict=True, le=255, ge=0)] = Field(None, alias="fkiUsergroupID", description="The unique ID of the Usergroup") - fki_company_id: Optional[conint(strict=True, le=255, ge=1)] = Field(None, alias="fkiCompanyID", description="The unique ID of the Company") - fki_modulesection_id: conint(strict=True, ge=0) = Field(..., alias="fkiModulesectionID", description="The unique ID of the Modulesection") - __properties = ["pkiPermissionID", "fkiUserID", "fkiApikeyID", "fkiUsergroupID", "fkiCompanyID", "fkiModulesectionID"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + A Permission Object and children to create a complete structure + """ # noqa: E501 + pki_permission_id: Optional[Annotated[int, Field(le=65535, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Permission", alias="pkiPermissionID") + fki_user_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the User", alias="fkiUserID") + fki_apikey_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Apikey", alias="fkiApikeyID") + fki_usergroup_id: Optional[Annotated[int, Field(le=255, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Usergroup", alias="fkiUsergroupID") + fki_company_id: Optional[Annotated[int, Field(le=255, strict=True, ge=1)]] = Field(default=None, description="The unique ID of the Company", alias="fkiCompanyID") + fki_modulesection_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Modulesection", alias="fkiModulesectionID") + __properties: ClassVar[List[str]] = ["pkiPermissionID", "fkiUserID", "fkiApikeyID", "fkiUsergroupID", "fkiCompanyID", "fkiModulesectionID"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> PermissionRequestCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of PermissionRequestCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> PermissionRequestCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of PermissionRequestCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return PermissionRequestCompound.parse_obj(obj) - - _obj = PermissionRequestCompound.parse_obj({ - "pki_permission_id": obj.get("pkiPermissionID"), - "fki_user_id": obj.get("fkiUserID"), - "fki_apikey_id": obj.get("fkiApikeyID"), - "fki_usergroup_id": obj.get("fkiUsergroupID"), - "fki_company_id": obj.get("fkiCompanyID"), - "fki_modulesection_id": obj.get("fkiModulesectionID") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiPermissionID": obj.get("pkiPermissionID"), + "fkiUserID": obj.get("fkiUserID"), + "fkiApikeyID": obj.get("fkiApikeyID"), + "fkiUsergroupID": obj.get("fkiUsergroupID"), + "fkiCompanyID": obj.get("fkiCompanyID"), + "fkiModulesectionID": obj.get("fkiModulesectionID") }) return _obj diff --git a/eZmaxApi/models/permission_response.py b/eZmaxApi/models/permission_response.py index 33e897108..602a2f120 100644 --- a/eZmaxApi/models/permission_response.py +++ b/eZmaxApi/models/permission_response.py @@ -19,65 +19,84 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictStr, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictStr +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class PermissionResponse(BaseModel): """ - A Permission Object # noqa: E501 - """ - pki_permission_id: conint(strict=True, le=65535, ge=0) = Field(..., alias="pkiPermissionID", description="The unique ID of the Permission") - fki_user_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiUserID", description="The unique ID of the User") - fki_apikey_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiApikeyID", description="The unique ID of the Apikey") - fki_usergroup_id: Optional[conint(strict=True, le=255, ge=0)] = Field(None, alias="fkiUsergroupID", description="The unique ID of the Usergroup") - fki_company_id: Optional[conint(strict=True, le=255, ge=1)] = Field(None, alias="fkiCompanyID", description="The unique ID of the Company") - fki_modulesection_id: conint(strict=True, ge=0) = Field(..., alias="fkiModulesectionID", description="The unique ID of the Modulesection") - s_company_name_x: Optional[StrictStr] = Field(None, alias="sCompanyNameX", description="The Name of the Company in the language of the requester") - __properties = ["pkiPermissionID", "fkiUserID", "fkiApikeyID", "fkiUsergroupID", "fkiCompanyID", "fkiModulesectionID", "sCompanyNameX"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + A Permission Object + """ # noqa: E501 + pki_permission_id: Annotated[int, Field(le=65535, strict=True, ge=0)] = Field(description="The unique ID of the Permission", alias="pkiPermissionID") + fki_user_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the User", alias="fkiUserID") + fki_apikey_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Apikey", alias="fkiApikeyID") + fki_usergroup_id: Optional[Annotated[int, Field(le=255, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Usergroup", alias="fkiUsergroupID") + fki_company_id: Optional[Annotated[int, Field(le=255, strict=True, ge=1)]] = Field(default=None, description="The unique ID of the Company", alias="fkiCompanyID") + fki_modulesection_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Modulesection", alias="fkiModulesectionID") + s_company_name_x: Optional[StrictStr] = Field(default=None, description="The Name of the Company in the language of the requester", alias="sCompanyNameX") + __properties: ClassVar[List[str]] = ["pkiPermissionID", "fkiUserID", "fkiApikeyID", "fkiUsergroupID", "fkiCompanyID", "fkiModulesectionID", "sCompanyNameX"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> PermissionResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of PermissionResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> PermissionResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of PermissionResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return PermissionResponse.parse_obj(obj) - - _obj = PermissionResponse.parse_obj({ - "pki_permission_id": obj.get("pkiPermissionID"), - "fki_user_id": obj.get("fkiUserID"), - "fki_apikey_id": obj.get("fkiApikeyID"), - "fki_usergroup_id": obj.get("fkiUsergroupID"), - "fki_company_id": obj.get("fkiCompanyID"), - "fki_modulesection_id": obj.get("fkiModulesectionID"), - "s_company_name_x": obj.get("sCompanyNameX") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiPermissionID": obj.get("pkiPermissionID"), + "fkiUserID": obj.get("fkiUserID"), + "fkiApikeyID": obj.get("fkiApikeyID"), + "fkiUsergroupID": obj.get("fkiUsergroupID"), + "fkiCompanyID": obj.get("fkiCompanyID"), + "fkiModulesectionID": obj.get("fkiModulesectionID"), + "sCompanyNameX": obj.get("sCompanyNameX") }) return _obj diff --git a/eZmaxApi/models/permission_response_compound.py b/eZmaxApi/models/permission_response_compound.py index a4d2e3d49..f0127af15 100644 --- a/eZmaxApi/models/permission_response_compound.py +++ b/eZmaxApi/models/permission_response_compound.py @@ -19,65 +19,84 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictStr, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictStr +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class PermissionResponseCompound(BaseModel): """ - A Permission Object and children to create a complete structure # noqa: E501 - """ - pki_permission_id: conint(strict=True, le=65535, ge=0) = Field(..., alias="pkiPermissionID", description="The unique ID of the Permission") - fki_user_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiUserID", description="The unique ID of the User") - fki_apikey_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiApikeyID", description="The unique ID of the Apikey") - fki_usergroup_id: Optional[conint(strict=True, le=255, ge=0)] = Field(None, alias="fkiUsergroupID", description="The unique ID of the Usergroup") - fki_company_id: Optional[conint(strict=True, le=255, ge=1)] = Field(None, alias="fkiCompanyID", description="The unique ID of the Company") - fki_modulesection_id: conint(strict=True, ge=0) = Field(..., alias="fkiModulesectionID", description="The unique ID of the Modulesection") - s_company_name_x: Optional[StrictStr] = Field(None, alias="sCompanyNameX", description="The Name of the Company in the language of the requester") - __properties = ["pkiPermissionID", "fkiUserID", "fkiApikeyID", "fkiUsergroupID", "fkiCompanyID", "fkiModulesectionID", "sCompanyNameX"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + A Permission Object and children to create a complete structure + """ # noqa: E501 + pki_permission_id: Annotated[int, Field(le=65535, strict=True, ge=0)] = Field(description="The unique ID of the Permission", alias="pkiPermissionID") + fki_user_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the User", alias="fkiUserID") + fki_apikey_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Apikey", alias="fkiApikeyID") + fki_usergroup_id: Optional[Annotated[int, Field(le=255, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Usergroup", alias="fkiUsergroupID") + fki_company_id: Optional[Annotated[int, Field(le=255, strict=True, ge=1)]] = Field(default=None, description="The unique ID of the Company", alias="fkiCompanyID") + fki_modulesection_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Modulesection", alias="fkiModulesectionID") + s_company_name_x: Optional[StrictStr] = Field(default=None, description="The Name of the Company in the language of the requester", alias="sCompanyNameX") + __properties: ClassVar[List[str]] = ["pkiPermissionID", "fkiUserID", "fkiApikeyID", "fkiUsergroupID", "fkiCompanyID", "fkiModulesectionID", "sCompanyNameX"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> PermissionResponseCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of PermissionResponseCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> PermissionResponseCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of PermissionResponseCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return PermissionResponseCompound.parse_obj(obj) - - _obj = PermissionResponseCompound.parse_obj({ - "pki_permission_id": obj.get("pkiPermissionID"), - "fki_user_id": obj.get("fkiUserID"), - "fki_apikey_id": obj.get("fkiApikeyID"), - "fki_usergroup_id": obj.get("fkiUsergroupID"), - "fki_company_id": obj.get("fkiCompanyID"), - "fki_modulesection_id": obj.get("fkiModulesectionID"), - "s_company_name_x": obj.get("sCompanyNameX") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiPermissionID": obj.get("pkiPermissionID"), + "fkiUserID": obj.get("fkiUserID"), + "fkiApikeyID": obj.get("fkiApikeyID"), + "fkiUsergroupID": obj.get("fkiUsergroupID"), + "fkiCompanyID": obj.get("fkiCompanyID"), + "fkiModulesectionID": obj.get("fkiModulesectionID"), + "sCompanyNameX": obj.get("sCompanyNameX") }) return _obj diff --git a/eZmaxApi/models/phone_request.py b/eZmaxApi/models/phone_request.py index 9b40317dc..0235c20ce 100644 --- a/eZmaxApi/models/phone_request.py +++ b/eZmaxApi/models/phone_request.py @@ -19,26 +19,32 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictStr, conint, constr, validator +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictStr, field_validator +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.field_e_phone_type import FieldEPhoneType +try: + from typing import Self +except ImportError: + from typing_extensions import Self class PhoneRequest(BaseModel): """ - A Phone Object # noqa: E501 - """ - pki_phone_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="pkiPhoneID", description="The unique ID of the Phone.") - fki_phonetype_id: conint(strict=True, ge=0) = Field(..., alias="fkiPhonetypeID", description="The unique ID of the Phonetype. Valid values: |Value|Description| |-|-| |1|Office| |2|Home| |3|Mobile| |4|Fax| |5|Pager| |6|Toll Free|") - e_phone_type: Optional[FieldEPhoneType] = Field(None, alias="ePhoneType") - s_phone_region: Optional[StrictStr] = Field(None, alias="sPhoneRegion", description="The region of the phone number. (For a North America Number only) The region is the \"514\" section in this sample phone number: (514) 990-1516 x123") - s_phone_exchange: Optional[StrictStr] = Field(None, alias="sPhoneExchange", description="The exchange of the phone number. (For a North America Number only) The exchange is the \"990\" section in this sample phone number: (514) 990-1516 x123") - s_phone_number: Optional[StrictStr] = Field(None, alias="sPhoneNumber", description="The number of the phone number. (For a North America Number only) The number is the \"1516\" section in this sample phone number: (514) 990-1516 x123") - s_phone_international: Optional[StrictStr] = Field(None, alias="sPhoneInternational", description="The international phone number.") - s_phone_extension: Optional[StrictStr] = Field(None, alias="sPhoneExtension", description="The extension of the phone number. The extension is the \"123\" section in this sample phone number: (514) 990-1516 x123. It can also be used with international phone numbers") - s_phone_e164: Optional[constr(strict=True)] = Field(None, alias="sPhoneE164", description="A phone number in E.164 Format") - __properties = ["pkiPhoneID", "fkiPhonetypeID", "ePhoneType", "sPhoneRegion", "sPhoneExchange", "sPhoneNumber", "sPhoneInternational", "sPhoneExtension", "sPhoneE164"] - - @validator('s_phone_e164') + A Phone Object + """ # noqa: E501 + pki_phone_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Phone.", alias="pkiPhoneID") + fki_phonetype_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Phonetype. Valid values: |Value|Description| |-|-| |1|Office| |2|Home| |3|Mobile| |4|Fax| |5|Pager| |6|Toll Free|", alias="fkiPhonetypeID") + e_phone_type: Optional[FieldEPhoneType] = Field(default=None, alias="ePhoneType") + s_phone_region: Optional[StrictStr] = Field(default=None, description="The region of the phone number. (For a North America Number only) The region is the \"514\" section in this sample phone number: (514) 990-1516 x123", alias="sPhoneRegion") + s_phone_exchange: Optional[StrictStr] = Field(default=None, description="The exchange of the phone number. (For a North America Number only) The exchange is the \"990\" section in this sample phone number: (514) 990-1516 x123", alias="sPhoneExchange") + s_phone_number: Optional[StrictStr] = Field(default=None, description="The number of the phone number. (For a North America Number only) The number is the \"1516\" section in this sample phone number: (514) 990-1516 x123", alias="sPhoneNumber") + s_phone_international: Optional[StrictStr] = Field(default=None, description="The international phone number.", alias="sPhoneInternational") + s_phone_extension: Optional[StrictStr] = Field(default=None, description="The extension of the phone number. The extension is the \"123\" section in this sample phone number: (514) 990-1516 x123. It can also be used with international phone numbers", alias="sPhoneExtension") + s_phone_e164: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="A phone number in E.164 Format", alias="sPhoneE164") + __properties: ClassVar[List[str]] = ["pkiPhoneID", "fkiPhonetypeID", "ePhoneType", "sPhoneRegion", "sPhoneExchange", "sPhoneNumber", "sPhoneInternational", "sPhoneExtension", "sPhoneE164"] + + @field_validator('s_phone_e164') def s_phone_e164_validate_regular_expression(cls, value): """Validates the regular expression""" if value is None: @@ -48,51 +54,64 @@ def s_phone_e164_validate_regular_expression(cls, value): raise ValueError(r"must validate the regular expression /^\+[1-9]\d{1,14}$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> PhoneRequest: + def from_json(cls, json_str: str) -> Self: """Create an instance of PhoneRequest from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> PhoneRequest: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of PhoneRequest from a dict""" if obj is None: return None if not isinstance(obj, dict): - return PhoneRequest.parse_obj(obj) - - _obj = PhoneRequest.parse_obj({ - "pki_phone_id": obj.get("pkiPhoneID"), - "fki_phonetype_id": obj.get("fkiPhonetypeID"), - "e_phone_type": obj.get("ePhoneType"), - "s_phone_region": obj.get("sPhoneRegion"), - "s_phone_exchange": obj.get("sPhoneExchange"), - "s_phone_number": obj.get("sPhoneNumber"), - "s_phone_international": obj.get("sPhoneInternational"), - "s_phone_extension": obj.get("sPhoneExtension"), - "s_phone_e164": obj.get("sPhoneE164") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiPhoneID": obj.get("pkiPhoneID"), + "fkiPhonetypeID": obj.get("fkiPhonetypeID"), + "ePhoneType": obj.get("ePhoneType"), + "sPhoneRegion": obj.get("sPhoneRegion"), + "sPhoneExchange": obj.get("sPhoneExchange"), + "sPhoneNumber": obj.get("sPhoneNumber"), + "sPhoneInternational": obj.get("sPhoneInternational"), + "sPhoneExtension": obj.get("sPhoneExtension"), + "sPhoneE164": obj.get("sPhoneE164") }) return _obj diff --git a/eZmaxApi/models/phone_request_compound.py b/eZmaxApi/models/phone_request_compound.py index 4ef287458..33b0bcbac 100644 --- a/eZmaxApi/models/phone_request_compound.py +++ b/eZmaxApi/models/phone_request_compound.py @@ -19,26 +19,32 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictStr, conint, constr, validator +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictStr, field_validator +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.field_e_phone_type import FieldEPhoneType +try: + from typing import Self +except ImportError: + from typing_extensions import Self class PhoneRequestCompound(BaseModel): """ - A Phone Object and children to create a complete structure # noqa: E501 - """ - pki_phone_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="pkiPhoneID", description="The unique ID of the Phone.") - fki_phonetype_id: conint(strict=True, ge=0) = Field(..., alias="fkiPhonetypeID", description="The unique ID of the Phonetype. Valid values: |Value|Description| |-|-| |1|Office| |2|Home| |3|Mobile| |4|Fax| |5|Pager| |6|Toll Free|") - e_phone_type: Optional[FieldEPhoneType] = Field(None, alias="ePhoneType") - s_phone_region: Optional[StrictStr] = Field(None, alias="sPhoneRegion", description="The region of the phone number. (For a North America Number only) The region is the \"514\" section in this sample phone number: (514) 990-1516 x123") - s_phone_exchange: Optional[StrictStr] = Field(None, alias="sPhoneExchange", description="The exchange of the phone number. (For a North America Number only) The exchange is the \"990\" section in this sample phone number: (514) 990-1516 x123") - s_phone_number: Optional[StrictStr] = Field(None, alias="sPhoneNumber", description="The number of the phone number. (For a North America Number only) The number is the \"1516\" section in this sample phone number: (514) 990-1516 x123") - s_phone_international: Optional[StrictStr] = Field(None, alias="sPhoneInternational", description="The international phone number.") - s_phone_extension: Optional[StrictStr] = Field(None, alias="sPhoneExtension", description="The extension of the phone number. The extension is the \"123\" section in this sample phone number: (514) 990-1516 x123. It can also be used with international phone numbers") - s_phone_e164: Optional[constr(strict=True)] = Field(None, alias="sPhoneE164", description="A phone number in E.164 Format") - __properties = ["pkiPhoneID", "fkiPhonetypeID", "ePhoneType", "sPhoneRegion", "sPhoneExchange", "sPhoneNumber", "sPhoneInternational", "sPhoneExtension", "sPhoneE164"] - - @validator('s_phone_e164') + A Phone Object and children to create a complete structure + """ # noqa: E501 + pki_phone_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Phone.", alias="pkiPhoneID") + fki_phonetype_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Phonetype. Valid values: |Value|Description| |-|-| |1|Office| |2|Home| |3|Mobile| |4|Fax| |5|Pager| |6|Toll Free|", alias="fkiPhonetypeID") + e_phone_type: Optional[FieldEPhoneType] = Field(default=None, alias="ePhoneType") + s_phone_region: Optional[StrictStr] = Field(default=None, description="The region of the phone number. (For a North America Number only) The region is the \"514\" section in this sample phone number: (514) 990-1516 x123", alias="sPhoneRegion") + s_phone_exchange: Optional[StrictStr] = Field(default=None, description="The exchange of the phone number. (For a North America Number only) The exchange is the \"990\" section in this sample phone number: (514) 990-1516 x123", alias="sPhoneExchange") + s_phone_number: Optional[StrictStr] = Field(default=None, description="The number of the phone number. (For a North America Number only) The number is the \"1516\" section in this sample phone number: (514) 990-1516 x123", alias="sPhoneNumber") + s_phone_international: Optional[StrictStr] = Field(default=None, description="The international phone number.", alias="sPhoneInternational") + s_phone_extension: Optional[StrictStr] = Field(default=None, description="The extension of the phone number. The extension is the \"123\" section in this sample phone number: (514) 990-1516 x123. It can also be used with international phone numbers", alias="sPhoneExtension") + s_phone_e164: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="A phone number in E.164 Format", alias="sPhoneE164") + __properties: ClassVar[List[str]] = ["pkiPhoneID", "fkiPhonetypeID", "ePhoneType", "sPhoneRegion", "sPhoneExchange", "sPhoneNumber", "sPhoneInternational", "sPhoneExtension", "sPhoneE164"] + + @field_validator('s_phone_e164') def s_phone_e164_validate_regular_expression(cls, value): """Validates the regular expression""" if value is None: @@ -48,51 +54,64 @@ def s_phone_e164_validate_regular_expression(cls, value): raise ValueError(r"must validate the regular expression /^\+[1-9]\d{1,14}$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> PhoneRequestCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of PhoneRequestCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> PhoneRequestCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of PhoneRequestCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return PhoneRequestCompound.parse_obj(obj) - - _obj = PhoneRequestCompound.parse_obj({ - "pki_phone_id": obj.get("pkiPhoneID"), - "fki_phonetype_id": obj.get("fkiPhonetypeID"), - "e_phone_type": obj.get("ePhoneType"), - "s_phone_region": obj.get("sPhoneRegion"), - "s_phone_exchange": obj.get("sPhoneExchange"), - "s_phone_number": obj.get("sPhoneNumber"), - "s_phone_international": obj.get("sPhoneInternational"), - "s_phone_extension": obj.get("sPhoneExtension"), - "s_phone_e164": obj.get("sPhoneE164") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiPhoneID": obj.get("pkiPhoneID"), + "fkiPhonetypeID": obj.get("fkiPhonetypeID"), + "ePhoneType": obj.get("ePhoneType"), + "sPhoneRegion": obj.get("sPhoneRegion"), + "sPhoneExchange": obj.get("sPhoneExchange"), + "sPhoneNumber": obj.get("sPhoneNumber"), + "sPhoneInternational": obj.get("sPhoneInternational"), + "sPhoneExtension": obj.get("sPhoneExtension"), + "sPhoneE164": obj.get("sPhoneE164") }) return _obj diff --git a/eZmaxApi/models/phone_response.py b/eZmaxApi/models/phone_response.py index 020c7ae36..9a0285853 100644 --- a/eZmaxApi/models/phone_response.py +++ b/eZmaxApi/models/phone_response.py @@ -19,22 +19,28 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictStr, conint, constr, validator +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictStr, field_validator +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.field_e_phone_type import FieldEPhoneType +try: + from typing import Self +except ImportError: + from typing_extensions import Self class PhoneResponse(BaseModel): """ - A Phone Object # noqa: E501 - """ - pki_phone_id: conint(strict=True, ge=0) = Field(..., alias="pkiPhoneID", description="The unique ID of the Phone.") - fki_phonetype_id: conint(strict=True, ge=0) = Field(..., alias="fkiPhonetypeID", description="The unique ID of the Phonetype. Valid values: |Value|Description| |-|-| |1|Office| |2|Home| |3|Mobile| |4|Fax| |5|Pager| |6|Toll Free|") - e_phone_type: Optional[FieldEPhoneType] = Field(None, alias="ePhoneType") - s_phone_e164: Optional[constr(strict=True)] = Field(None, alias="sPhoneE164", description="A phone number in E.164 Format") - s_phone_extension: Optional[StrictStr] = Field(None, alias="sPhoneExtension", description="The extension of the phone number. The extension is the \"123\" section in this sample phone number: (514) 990-1516 x123. It can also be used with international phone numbers") - __properties = ["pkiPhoneID", "fkiPhonetypeID", "ePhoneType", "sPhoneE164", "sPhoneExtension"] - - @validator('s_phone_e164') + A Phone Object + """ # noqa: E501 + pki_phone_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Phone.", alias="pkiPhoneID") + fki_phonetype_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Phonetype. Valid values: |Value|Description| |-|-| |1|Office| |2|Home| |3|Mobile| |4|Fax| |5|Pager| |6|Toll Free|", alias="fkiPhonetypeID") + e_phone_type: Optional[FieldEPhoneType] = Field(default=None, alias="ePhoneType") + s_phone_e164: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="A phone number in E.164 Format", alias="sPhoneE164") + s_phone_extension: Optional[StrictStr] = Field(default=None, description="The extension of the phone number. The extension is the \"123\" section in this sample phone number: (514) 990-1516 x123. It can also be used with international phone numbers", alias="sPhoneExtension") + __properties: ClassVar[List[str]] = ["pkiPhoneID", "fkiPhonetypeID", "ePhoneType", "sPhoneE164", "sPhoneExtension"] + + @field_validator('s_phone_e164') def s_phone_e164_validate_regular_expression(cls, value): """Validates the regular expression""" if value is None: @@ -44,47 +50,60 @@ def s_phone_e164_validate_regular_expression(cls, value): raise ValueError(r"must validate the regular expression /^\+[1-9]\d{1,14}$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> PhoneResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of PhoneResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> PhoneResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of PhoneResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return PhoneResponse.parse_obj(obj) - - _obj = PhoneResponse.parse_obj({ - "pki_phone_id": obj.get("pkiPhoneID"), - "fki_phonetype_id": obj.get("fkiPhonetypeID"), - "e_phone_type": obj.get("ePhoneType"), - "s_phone_e164": obj.get("sPhoneE164"), - "s_phone_extension": obj.get("sPhoneExtension") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiPhoneID": obj.get("pkiPhoneID"), + "fkiPhonetypeID": obj.get("fkiPhonetypeID"), + "ePhoneType": obj.get("ePhoneType"), + "sPhoneE164": obj.get("sPhoneE164"), + "sPhoneExtension": obj.get("sPhoneExtension") }) return _obj diff --git a/eZmaxApi/models/phone_response_compound.py b/eZmaxApi/models/phone_response_compound.py index 50ca9feb1..ebf1221be 100644 --- a/eZmaxApi/models/phone_response_compound.py +++ b/eZmaxApi/models/phone_response_compound.py @@ -19,22 +19,29 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictStr, conint, constr, validator +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, StrictStr, field_validator +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.field_e_phone_type import FieldEPhoneType +try: + from typing import Self +except ImportError: + from typing_extensions import Self class PhoneResponseCompound(BaseModel): """ - A Phone Object and children to create a complete structure # noqa: E501 - """ - pki_phone_id: conint(strict=True, ge=0) = Field(..., alias="pkiPhoneID", description="The unique ID of the Phone.") - fki_phonetype_id: conint(strict=True, ge=0) = Field(..., alias="fkiPhonetypeID", description="The unique ID of the Phonetype. Valid values: |Value|Description| |-|-| |1|Office| |2|Home| |3|Mobile| |4|Fax| |5|Pager| |6|Toll Free|") - e_phone_type: Optional[FieldEPhoneType] = Field(None, alias="ePhoneType") - s_phone_e164: Optional[constr(strict=True)] = Field(None, alias="sPhoneE164", description="A phone number in E.164 Format") - s_phone_extension: Optional[StrictStr] = Field(None, alias="sPhoneExtension", description="The extension of the phone number. The extension is the \"123\" section in this sample phone number: (514) 990-1516 x123. It can also be used with international phone numbers") - __properties = ["pkiPhoneID", "fkiPhonetypeID", "ePhoneType", "sPhoneE164", "sPhoneExtension"] - - @validator('s_phone_e164') + A Phone Object and children to create a complete structure + """ # noqa: E501 + pki_phone_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Phone.", alias="pkiPhoneID") + fki_phonetype_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Phonetype. Valid values: |Value|Description| |-|-| |1|Office| |2|Home| |3|Mobile| |4|Fax| |5|Pager| |6|Toll Free|", alias="fkiPhonetypeID") + e_phone_type: Optional[FieldEPhoneType] = Field(default=None, alias="ePhoneType") + s_phone_e164: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="A phone number in E.164 Format", alias="sPhoneE164") + s_phone_extension: Optional[StrictStr] = Field(default=None, description="The extension of the phone number. The extension is the \"123\" section in this sample phone number: (514) 990-1516 x123. It can also be used with international phone numbers", alias="sPhoneExtension") + b_phone_international: Optional[StrictBool] = Field(default=None, description="Indicate the phone number is an international phone number.", alias="bPhoneInternational") + __properties: ClassVar[List[str]] = ["pkiPhoneID", "fkiPhonetypeID", "ePhoneType", "sPhoneE164", "sPhoneExtension", "bPhoneInternational"] + + @field_validator('s_phone_e164') def s_phone_e164_validate_regular_expression(cls, value): """Validates the regular expression""" if value is None: @@ -44,47 +51,61 @@ def s_phone_e164_validate_regular_expression(cls, value): raise ValueError(r"must validate the regular expression /^\+[1-9]\d{1,14}$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> PhoneResponseCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of PhoneResponseCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> PhoneResponseCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of PhoneResponseCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return PhoneResponseCompound.parse_obj(obj) - - _obj = PhoneResponseCompound.parse_obj({ - "pki_phone_id": obj.get("pkiPhoneID"), - "fki_phonetype_id": obj.get("fkiPhonetypeID"), - "e_phone_type": obj.get("ePhoneType"), - "s_phone_e164": obj.get("sPhoneE164"), - "s_phone_extension": obj.get("sPhoneExtension") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiPhoneID": obj.get("pkiPhoneID"), + "fkiPhonetypeID": obj.get("fkiPhonetypeID"), + "ePhoneType": obj.get("ePhoneType"), + "sPhoneE164": obj.get("sPhoneE164"), + "sPhoneExtension": obj.get("sPhoneExtension"), + "bPhoneInternational": obj.get("bPhoneInternational") }) return _obj diff --git a/eZmaxApi/models/phonetype_autocomplete_element_response.py b/eZmaxApi/models/phonetype_autocomplete_element_response.py index 1598a45bd..d740927a9 100644 --- a/eZmaxApi/models/phonetype_autocomplete_element_response.py +++ b/eZmaxApi/models/phonetype_autocomplete_element_response.py @@ -19,64 +19,83 @@ import json - -from pydantic import BaseModel, Field, StrictBool, conint, constr, validator +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictBool, field_validator +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class PhonetypeAutocompleteElementResponse(BaseModel): """ - A Phonetype AutocompleteElement Response # noqa: E501 - """ - pki_phonetype_id: conint(strict=True, ge=0) = Field(..., alias="pkiPhonetypeID", description="The unique ID of the Phonetype. Valid values: |Value|Description| |-|-| |1|Office| |2|Home| |3|Mobile| |4|Fax| |5|Pager| |6|Toll Free|") - s_phonetype_name_x: constr(strict=True) = Field(..., alias="sPhonetypeNameX", description="The name of the Phonetype in the language of the requester") - b_phonetype_isactive: StrictBool = Field(..., alias="bPhonetypeIsactive", description="Whether the Phonetype is active or not") - __properties = ["pkiPhonetypeID", "sPhonetypeNameX", "bPhonetypeIsactive"] - - @validator('s_phonetype_name_x') + A Phonetype AutocompleteElement Response + """ # noqa: E501 + pki_phonetype_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Phonetype. Valid values: |Value|Description| |-|-| |1|Office| |2|Home| |3|Mobile| |4|Fax| |5|Pager| |6|Toll Free|", alias="pkiPhonetypeID") + s_phonetype_name_x: Annotated[str, Field(strict=True)] = Field(description="The name of the Phonetype in the language of the requester", alias="sPhonetypeNameX") + b_phonetype_isactive: StrictBool = Field(description="Whether the Phonetype is active or not", alias="bPhonetypeIsactive") + __properties: ClassVar[List[str]] = ["pkiPhonetypeID", "sPhonetypeNameX", "bPhonetypeIsactive"] + + @field_validator('s_phonetype_name_x') def s_phonetype_name_x_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^.{0,20}$", value): raise ValueError(r"must validate the regular expression /^.{0,20}$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> PhonetypeAutocompleteElementResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of PhonetypeAutocompleteElementResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> PhonetypeAutocompleteElementResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of PhonetypeAutocompleteElementResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return PhonetypeAutocompleteElementResponse.parse_obj(obj) + return cls.model_validate(obj) - _obj = PhonetypeAutocompleteElementResponse.parse_obj({ - "pki_phonetype_id": obj.get("pkiPhonetypeID"), - "s_phonetype_name_x": obj.get("sPhonetypeNameX"), - "b_phonetype_isactive": obj.get("bPhonetypeIsactive") + _obj = cls.model_validate({ + "pkiPhonetypeID": obj.get("pkiPhonetypeID"), + "sPhonetypeNameX": obj.get("sPhonetypeNameX"), + "bPhonetypeIsactive": obj.get("bPhonetypeIsactive") }) return _obj diff --git a/eZmaxApi/models/phonetype_get_autocomplete_v2_response.py b/eZmaxApi/models/phonetype_get_autocomplete_v2_response.py index 113d884c9..31b84e8dc 100644 --- a/eZmaxApi/models/phonetype_get_autocomplete_v2_response.py +++ b/eZmaxApi/models/phonetype_get_autocomplete_v2_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.phonetype_get_autocomplete_v2_response_m_payload import PhonetypeGetAutocompleteV2ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class PhonetypeGetAutocompleteV2Response(BaseModel): """ - Response for GET /2/object/phonetype/getAutocomplete # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: PhonetypeGetAutocompleteV2ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /2/object/phonetype/getAutocomplete + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: PhonetypeGetAutocompleteV2ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> PhonetypeGetAutocompleteV2Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of PhonetypeGetAutocompleteV2Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> PhonetypeGetAutocompleteV2Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of PhonetypeGetAutocompleteV2Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return PhonetypeGetAutocompleteV2Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = PhonetypeGetAutocompleteV2Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": PhonetypeGetAutocompleteV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": PhonetypeGetAutocompleteV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/phonetype_get_autocomplete_v2_response_m_payload.py b/eZmaxApi/models/phonetype_get_autocomplete_v2_response_m_payload.py index 987a4cf04..4a6c10630 100644 --- a/eZmaxApi/models/phonetype_get_autocomplete_v2_response_m_payload.py +++ b/eZmaxApi/models/phonetype_get_autocomplete_v2_response_m_payload.py @@ -19,41 +19,59 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.phonetype_autocomplete_element_response import PhonetypeAutocompleteElementResponse +try: + from typing import Self +except ImportError: + from typing_extensions import Self class PhonetypeGetAutocompleteV2ResponseMPayload(BaseModel): """ - Payload for POST /2/object/phonetype/getAutocomplete # noqa: E501 - """ - a_obj_phonetype: conlist(PhonetypeAutocompleteElementResponse) = Field(..., alias="a_objPhonetype", description="An array of Phonetype autocomplete element response.") - __properties = ["a_objPhonetype"] + Payload for POST /2/object/phonetype/getAutocomplete + """ # noqa: E501 + a_obj_phonetype: List[PhonetypeAutocompleteElementResponse] = Field(description="An array of Phonetype autocomplete element response.", alias="a_objPhonetype") + __properties: ClassVar[List[str]] = ["a_objPhonetype"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> PhonetypeGetAutocompleteV2ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of PhonetypeGetAutocompleteV2ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_phonetype (list) _items = [] if self.a_obj_phonetype: @@ -64,16 +82,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> PhonetypeGetAutocompleteV2ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of PhonetypeGetAutocompleteV2ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return PhonetypeGetAutocompleteV2ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = PhonetypeGetAutocompleteV2ResponseMPayload.parse_obj({ - "a_obj_phonetype": [PhonetypeAutocompleteElementResponse.from_dict(_item) for _item in obj.get("a_objPhonetype")] if obj.get("a_objPhonetype") is not None else None + _obj = cls.model_validate({ + "a_objPhonetype": [PhonetypeAutocompleteElementResponse.from_dict(_item) for _item in obj.get("a_objPhonetype")] if obj.get("a_objPhonetype") is not None else None }) return _obj diff --git a/eZmaxApi/models/rejectedoffertopurchase_get_communication_list_v1_response.py b/eZmaxApi/models/rejectedoffertopurchase_get_communication_list_v1_response.py index 6c2d7a256..ecaf8a77d 100644 --- a/eZmaxApi/models/rejectedoffertopurchase_get_communication_list_v1_response.py +++ b/eZmaxApi/models/rejectedoffertopurchase_get_communication_list_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload_get_list import CommonResponseObjDebugPayloadGetList from eZmaxApi.models.rejectedoffertopurchase_get_communication_list_v1_response_m_payload import RejectedoffertopurchaseGetCommunicationListV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class RejectedoffertopurchaseGetCommunicationListV1Response(BaseModel): """ - Response for GET /1/object/rejectedoffertopurchase/{pkiRejectedoffertopurchaseID}/getCommunicationList # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayloadGetList = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: RejectedoffertopurchaseGetCommunicationListV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /1/object/rejectedoffertopurchase/{pkiRejectedoffertopurchaseID}/getCommunicationList + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayloadGetList = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: RejectedoffertopurchaseGetCommunicationListV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> RejectedoffertopurchaseGetCommunicationListV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of RejectedoffertopurchaseGetCommunicationListV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> RejectedoffertopurchaseGetCommunicationListV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of RejectedoffertopurchaseGetCommunicationListV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return RejectedoffertopurchaseGetCommunicationListV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = RejectedoffertopurchaseGetCommunicationListV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayloadGetList.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": RejectedoffertopurchaseGetCommunicationListV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayloadGetList.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": RejectedoffertopurchaseGetCommunicationListV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/rejectedoffertopurchase_get_communication_list_v1_response_m_payload.py b/eZmaxApi/models/rejectedoffertopurchase_get_communication_list_v1_response_m_payload.py index 46c486897..ac6d96f6d 100644 --- a/eZmaxApi/models/rejectedoffertopurchase_get_communication_list_v1_response_m_payload.py +++ b/eZmaxApi/models/rejectedoffertopurchase_get_communication_list_v1_response_m_payload.py @@ -19,41 +19,59 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.custom_communication_list_element_response import CustomCommunicationListElementResponse +try: + from typing import Self +except ImportError: + from typing_extensions import Self class RejectedoffertopurchaseGetCommunicationListV1ResponseMPayload(BaseModel): """ - Response for GET /1/object/rejectedoffertopurchase/{pkiRejectedoffertopurchaseID}/getCommunicationList # noqa: E501 - """ - a_obj_communication: conlist(CustomCommunicationListElementResponse) = Field(..., alias="a_objCommunication") - __properties = ["a_objCommunication"] + Response for GET /1/object/rejectedoffertopurchase/{pkiRejectedoffertopurchaseID}/getCommunicationList + """ # noqa: E501 + a_obj_communication: List[CustomCommunicationListElementResponse] = Field(alias="a_objCommunication") + __properties: ClassVar[List[str]] = ["a_objCommunication"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> RejectedoffertopurchaseGetCommunicationListV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of RejectedoffertopurchaseGetCommunicationListV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_communication (list) _items = [] if self.a_obj_communication: @@ -64,16 +82,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> RejectedoffertopurchaseGetCommunicationListV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of RejectedoffertopurchaseGetCommunicationListV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return RejectedoffertopurchaseGetCommunicationListV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = RejectedoffertopurchaseGetCommunicationListV1ResponseMPayload.parse_obj({ - "a_obj_communication": [CustomCommunicationListElementResponse.from_dict(_item) for _item in obj.get("a_objCommunication")] if obj.get("a_objCommunication") is not None else None + _obj = cls.model_validate({ + "a_objCommunication": [CustomCommunicationListElementResponse.from_dict(_item) for _item in obj.get("a_objCommunication")] if obj.get("a_objCommunication") is not None else None }) return _obj diff --git a/eZmaxApi/models/scim_authentication_scheme.py b/eZmaxApi/models/scim_authentication_scheme.py index a8f8f93bc..aa56ac8ba 100644 --- a/eZmaxApi/models/scim_authentication_scheme.py +++ b/eZmaxApi/models/scim_authentication_scheme.py @@ -19,61 +19,79 @@ import json - -from pydantic import BaseModel, Field, StrictStr, validator +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictStr, field_validator +from pydantic import Field +try: + from typing import Self +except ImportError: + from typing_extensions import Self class ScimAuthenticationScheme(BaseModel): """ ScimAuthenticationScheme - """ - description: StrictStr = Field(..., description="A description of the authentication scheme.") - name: StrictStr = Field(..., description="The common authentication scheme name") - type: StrictStr = Field(..., description="The authentication scheme.") - __properties = ["description", "name", "type"] + """ # noqa: E501 + description: StrictStr = Field(description="A description of the authentication scheme.") + name: StrictStr = Field(description="The common authentication scheme name") + type: StrictStr = Field(description="The authentication scheme.") + __properties: ClassVar[List[str]] = ["description", "name", "type"] - @validator('type') + @field_validator('type') def type_validate_enum(cls, value): """Validates the enum""" if value not in ('oauth', 'oauth2', 'oauthbearertoken', 'httpbasic', 'httpdigest'): raise ValueError("must be one of enum values ('oauth', 'oauth2', 'oauthbearertoken', 'httpbasic', 'httpdigest')") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> ScimAuthenticationScheme: + def from_json(cls, json_str: str) -> Self: """Create an instance of ScimAuthenticationScheme from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> ScimAuthenticationScheme: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of ScimAuthenticationScheme from a dict""" if obj is None: return None if not isinstance(obj, dict): - return ScimAuthenticationScheme.parse_obj(obj) + return cls.model_validate(obj) - _obj = ScimAuthenticationScheme.parse_obj({ + _obj = cls.model_validate({ "description": obj.get("description"), "name": obj.get("name"), "type": obj.get("type") diff --git a/eZmaxApi/models/scim_email.py b/eZmaxApi/models/scim_email.py index 4a76a874a..8b1d1ce90 100644 --- a/eZmaxApi/models/scim_email.py +++ b/eZmaxApi/models/scim_email.py @@ -19,53 +19,71 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, StrictStr +from pydantic import Field +try: + from typing import Self +except ImportError: + from typing_extensions import Self class ScimEmail(BaseModel): """ ScimEmail - """ - value: Optional[StrictStr] = Field(None, description="The email address.") + """ # noqa: E501 + value: Optional[StrictStr] = Field(default=None, description="The email address.") primary: Optional[StrictBool] = None - __properties = ["value", "primary"] + __properties: ClassVar[List[str]] = ["value", "primary"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> ScimEmail: + def from_json(cls, json_str: str) -> Self: """Create an instance of ScimEmail from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> ScimEmail: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of ScimEmail from a dict""" if obj is None: return None if not isinstance(obj, dict): - return ScimEmail.parse_obj(obj) + return cls.model_validate(obj) - _obj = ScimEmail.parse_obj({ + _obj = cls.model_validate({ "value": obj.get("value"), "primary": obj.get("primary") }) diff --git a/eZmaxApi/models/scim_group.py b/eZmaxApi/models/scim_group.py index e7a938001..797b3c9f4 100644 --- a/eZmaxApi/models/scim_group.py +++ b/eZmaxApi/models/scim_group.py @@ -19,50 +19,69 @@ import json -from typing import List, Optional -from pydantic import BaseModel, Field, StrictStr, conlist, constr, validator +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictStr, field_validator +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.scim_group_member import ScimGroupMember +try: + from typing import Self +except ImportError: + from typing_extensions import Self class ScimGroup(BaseModel): """ ScimGroup - """ + """ # noqa: E501 id: Optional[StrictStr] = None - display_name: constr(strict=True) = Field(..., alias="displayName", description="The Name of the Usergroup in the language of the requester") - members: Optional[conlist(ScimGroupMember)] = None - __properties = ["id", "displayName", "members"] + display_name: Annotated[str, Field(strict=True)] = Field(description="The Name of the Usergroup in the language of the requester", alias="displayName") + members: Optional[List[ScimGroupMember]] = None + __properties: ClassVar[List[str]] = ["id", "displayName", "members"] - @validator('display_name') + @field_validator('display_name') def display_name_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^.{0,50}$", value): raise ValueError(r"must validate the regular expression /^.{0,50}$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> ScimGroup: + def from_json(cls, json_str: str) -> Self: """Create an instance of ScimGroup from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in members (list) _items = [] if self.members: @@ -73,17 +92,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> ScimGroup: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of ScimGroup from a dict""" if obj is None: return None if not isinstance(obj, dict): - return ScimGroup.parse_obj(obj) + return cls.model_validate(obj) - _obj = ScimGroup.parse_obj({ + _obj = cls.model_validate({ "id": obj.get("id"), - "display_name": obj.get("displayName"), + "displayName": obj.get("displayName"), "members": [ScimGroupMember.from_dict(_item) for _item in obj.get("members")] if obj.get("members") is not None else None }) return _obj diff --git a/eZmaxApi/models/scim_group_member.py b/eZmaxApi/models/scim_group_member.py index c48e23bd0..5ed29eba3 100644 --- a/eZmaxApi/models/scim_group_member.py +++ b/eZmaxApi/models/scim_group_member.py @@ -19,59 +19,77 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictStr +from pydantic import Field +try: + from typing import Self +except ImportError: + from typing_extensions import Self class ScimGroupMember(BaseModel): """ ScimGroupMember - """ + """ # noqa: E501 value: Optional[StrictStr] = None display: Optional[StrictStr] = None type: Optional[StrictStr] = None - ref: Optional[StrictStr] = Field(None, alias="$ref") - __properties = ["value", "display", "type", "$ref"] + ref: Optional[StrictStr] = Field(default=None, alias="$ref") + __properties: ClassVar[List[str]] = ["value", "display", "type", "$ref"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> ScimGroupMember: + def from_json(cls, json_str: str) -> Self: """Create an instance of ScimGroupMember from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> ScimGroupMember: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of ScimGroupMember from a dict""" if obj is None: return None if not isinstance(obj, dict): - return ScimGroupMember.parse_obj(obj) + return cls.model_validate(obj) - _obj = ScimGroupMember.parse_obj({ + _obj = cls.model_validate({ "value": obj.get("value"), "display": obj.get("display"), "type": obj.get("type"), - "ref": obj.get("$ref") + "$ref": obj.get("$ref") }) return _obj diff --git a/eZmaxApi/models/scim_service_provider_config.py b/eZmaxApi/models/scim_service_provider_config.py index 1d77966ae..e9855ba4e 100644 --- a/eZmaxApi/models/scim_service_provider_config.py +++ b/eZmaxApi/models/scim_service_provider_config.py @@ -19,8 +19,9 @@ import json -from typing import List -from pydantic import BaseModel, Field, StrictStr, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictStr +from pydantic import Field from eZmaxApi.models.scim_authentication_scheme import ScimAuthenticationScheme from eZmaxApi.models.scim_service_provider_config_bulk import ScimServiceProviderConfigBulk from eZmaxApi.models.scim_service_provider_config_change_password import ScimServiceProviderConfigChangePassword @@ -28,45 +29,62 @@ from eZmaxApi.models.scim_service_provider_config_filter import ScimServiceProviderConfigFilter from eZmaxApi.models.scim_service_provider_config_patch import ScimServiceProviderConfigPatch from eZmaxApi.models.scim_service_provider_config_sort import ScimServiceProviderConfigSort +try: + from typing import Self +except ImportError: + from typing_extensions import Self class ScimServiceProviderConfig(BaseModel): """ ScimServiceProviderConfig - """ - authentication_schemes: conlist(ScimAuthenticationScheme) = Field(..., alias="authenticationSchemes", description="A multi-valued complex type that specifies supported authentication scheme properties.") - bulk: ScimServiceProviderConfigBulk = Field(...) - change_password: ScimServiceProviderConfigChangePassword = Field(..., alias="changePassword") - documentation_uri: StrictStr = Field(..., alias="documentationUri", description="An HTTP-addressable URL pointing to the service provider's human-consumable help documentation") - etag: ScimServiceProviderConfigEtag = Field(...) - filter: ScimServiceProviderConfigFilter = Field(...) - patch: ScimServiceProviderConfigPatch = Field(...) - sort: ScimServiceProviderConfigSort = Field(...) - __properties = ["authenticationSchemes", "bulk", "changePassword", "documentationUri", "etag", "filter", "patch", "sort"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + """ # noqa: E501 + authentication_schemes: List[ScimAuthenticationScheme] = Field(description="A multi-valued complex type that specifies supported authentication scheme properties.", alias="authenticationSchemes") + bulk: ScimServiceProviderConfigBulk + change_password: ScimServiceProviderConfigChangePassword = Field(alias="changePassword") + documentation_uri: StrictStr = Field(description="An HTTP-addressable URL pointing to the service provider's human-consumable help documentation", alias="documentationUri") + etag: ScimServiceProviderConfigEtag + filter: ScimServiceProviderConfigFilter + patch: ScimServiceProviderConfigPatch + sort: ScimServiceProviderConfigSort + __properties: ClassVar[List[str]] = ["authenticationSchemes", "bulk", "changePassword", "documentationUri", "etag", "filter", "patch", "sort"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> ScimServiceProviderConfig: + def from_json(cls, json_str: str) -> Self: """Create an instance of ScimServiceProviderConfig from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in authentication_schemes (list) _items = [] if self.authentication_schemes: @@ -95,19 +113,19 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> ScimServiceProviderConfig: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of ScimServiceProviderConfig from a dict""" if obj is None: return None if not isinstance(obj, dict): - return ScimServiceProviderConfig.parse_obj(obj) + return cls.model_validate(obj) - _obj = ScimServiceProviderConfig.parse_obj({ - "authentication_schemes": [ScimAuthenticationScheme.from_dict(_item) for _item in obj.get("authenticationSchemes")] if obj.get("authenticationSchemes") is not None else None, + _obj = cls.model_validate({ + "authenticationSchemes": [ScimAuthenticationScheme.from_dict(_item) for _item in obj.get("authenticationSchemes")] if obj.get("authenticationSchemes") is not None else None, "bulk": ScimServiceProviderConfigBulk.from_dict(obj.get("bulk")) if obj.get("bulk") is not None else None, - "change_password": ScimServiceProviderConfigChangePassword.from_dict(obj.get("changePassword")) if obj.get("changePassword") is not None else None, - "documentation_uri": obj.get("documentationUri"), + "changePassword": ScimServiceProviderConfigChangePassword.from_dict(obj.get("changePassword")) if obj.get("changePassword") is not None else None, + "documentationUri": obj.get("documentationUri"), "etag": ScimServiceProviderConfigEtag.from_dict(obj.get("etag")) if obj.get("etag") is not None else None, "filter": ScimServiceProviderConfigFilter.from_dict(obj.get("filter")) if obj.get("filter") is not None else None, "patch": ScimServiceProviderConfigPatch.from_dict(obj.get("patch")) if obj.get("patch") is not None else None, diff --git a/eZmaxApi/models/scim_service_provider_config_bulk.py b/eZmaxApi/models/scim_service_provider_config_bulk.py index e47db2d58..8e6c3ed13 100644 --- a/eZmaxApi/models/scim_service_provider_config_bulk.py +++ b/eZmaxApi/models/scim_service_provider_config_bulk.py @@ -19,57 +19,75 @@ import json - -from pydantic import BaseModel, Field, StrictBool, StrictInt +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictBool, StrictInt +from pydantic import Field +try: + from typing import Self +except ImportError: + from typing_extensions import Self class ScimServiceProviderConfigBulk(BaseModel): """ - A complex type that specifies bulk configuration options. # noqa: E501 - """ - supported: StrictBool = Field(..., description="A Boolean value specifying whether or not the operation is supported.") - max_operations: StrictInt = Field(..., alias="maxOperations", description="An integer value specifying the maximum number of operations.") - max_payload_size: StrictInt = Field(..., alias="maxPayloadSize", description="An integer value specifying the maximum payload size in bytes.") - __properties = ["supported", "maxOperations", "maxPayloadSize"] + A complex type that specifies bulk configuration options. + """ # noqa: E501 + supported: StrictBool = Field(description="A Boolean value specifying whether or not the operation is supported.") + max_operations: StrictInt = Field(description="An integer value specifying the maximum number of operations.", alias="maxOperations") + max_payload_size: StrictInt = Field(description="An integer value specifying the maximum payload size in bytes.", alias="maxPayloadSize") + __properties: ClassVar[List[str]] = ["supported", "maxOperations", "maxPayloadSize"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> ScimServiceProviderConfigBulk: + def from_json(cls, json_str: str) -> Self: """Create an instance of ScimServiceProviderConfigBulk from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> ScimServiceProviderConfigBulk: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of ScimServiceProviderConfigBulk from a dict""" if obj is None: return None if not isinstance(obj, dict): - return ScimServiceProviderConfigBulk.parse_obj(obj) + return cls.model_validate(obj) - _obj = ScimServiceProviderConfigBulk.parse_obj({ + _obj = cls.model_validate({ "supported": obj.get("supported"), - "max_operations": obj.get("maxOperations"), - "max_payload_size": obj.get("maxPayloadSize") + "maxOperations": obj.get("maxOperations"), + "maxPayloadSize": obj.get("maxPayloadSize") }) return _obj diff --git a/eZmaxApi/models/scim_service_provider_config_change_password.py b/eZmaxApi/models/scim_service_provider_config_change_password.py index 065e7aee1..1b0472f53 100644 --- a/eZmaxApi/models/scim_service_provider_config_change_password.py +++ b/eZmaxApi/models/scim_service_provider_config_change_password.py @@ -19,52 +19,70 @@ import json - -from pydantic import BaseModel, Field, StrictBool +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictBool +from pydantic import Field +try: + from typing import Self +except ImportError: + from typing_extensions import Self class ScimServiceProviderConfigChangePassword(BaseModel): """ - A complex type that specifies configuration options related to changing a password. # noqa: E501 - """ - supported: StrictBool = Field(..., description="A Boolean value specifying whether or not the operation is supported.") - __properties = ["supported"] + A complex type that specifies configuration options related to changing a password. + """ # noqa: E501 + supported: StrictBool = Field(description="A Boolean value specifying whether or not the operation is supported.") + __properties: ClassVar[List[str]] = ["supported"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> ScimServiceProviderConfigChangePassword: + def from_json(cls, json_str: str) -> Self: """Create an instance of ScimServiceProviderConfigChangePassword from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> ScimServiceProviderConfigChangePassword: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of ScimServiceProviderConfigChangePassword from a dict""" if obj is None: return None if not isinstance(obj, dict): - return ScimServiceProviderConfigChangePassword.parse_obj(obj) + return cls.model_validate(obj) - _obj = ScimServiceProviderConfigChangePassword.parse_obj({ + _obj = cls.model_validate({ "supported": obj.get("supported") }) return _obj diff --git a/eZmaxApi/models/scim_service_provider_config_etag.py b/eZmaxApi/models/scim_service_provider_config_etag.py index c06273d84..9dbd93472 100644 --- a/eZmaxApi/models/scim_service_provider_config_etag.py +++ b/eZmaxApi/models/scim_service_provider_config_etag.py @@ -19,52 +19,70 @@ import json - -from pydantic import BaseModel, Field, StrictBool +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictBool +from pydantic import Field +try: + from typing import Self +except ImportError: + from typing_extensions import Self class ScimServiceProviderConfigEtag(BaseModel): """ - A complex type that specifies ETag configuration options. # noqa: E501 - """ - supported: StrictBool = Field(..., description="A Boolean value specifying whether or not the operation is supported.") - __properties = ["supported"] + A complex type that specifies ETag configuration options. + """ # noqa: E501 + supported: StrictBool = Field(description="A Boolean value specifying whether or not the operation is supported.") + __properties: ClassVar[List[str]] = ["supported"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> ScimServiceProviderConfigEtag: + def from_json(cls, json_str: str) -> Self: """Create an instance of ScimServiceProviderConfigEtag from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> ScimServiceProviderConfigEtag: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of ScimServiceProviderConfigEtag from a dict""" if obj is None: return None if not isinstance(obj, dict): - return ScimServiceProviderConfigEtag.parse_obj(obj) + return cls.model_validate(obj) - _obj = ScimServiceProviderConfigEtag.parse_obj({ + _obj = cls.model_validate({ "supported": obj.get("supported") }) return _obj diff --git a/eZmaxApi/models/scim_service_provider_config_filter.py b/eZmaxApi/models/scim_service_provider_config_filter.py index 3c169090c..56766cd98 100644 --- a/eZmaxApi/models/scim_service_provider_config_filter.py +++ b/eZmaxApi/models/scim_service_provider_config_filter.py @@ -19,55 +19,73 @@ import json - -from pydantic import BaseModel, Field, StrictBool, StrictInt +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictBool, StrictInt +from pydantic import Field +try: + from typing import Self +except ImportError: + from typing_extensions import Self class ScimServiceProviderConfigFilter(BaseModel): """ - A complex type that specifies FILTER options. # noqa: E501 - """ - supported: StrictBool = Field(..., description="A Boolean value specifying whether or not the operation is supported.") - max_results: StrictInt = Field(..., alias="maxResults", description="An integer value specifying the maximum number of resources returned in a response.") - __properties = ["supported", "maxResults"] + A complex type that specifies FILTER options. + """ # noqa: E501 + supported: StrictBool = Field(description="A Boolean value specifying whether or not the operation is supported.") + max_results: StrictInt = Field(description="An integer value specifying the maximum number of resources returned in a response.", alias="maxResults") + __properties: ClassVar[List[str]] = ["supported", "maxResults"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> ScimServiceProviderConfigFilter: + def from_json(cls, json_str: str) -> Self: """Create an instance of ScimServiceProviderConfigFilter from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> ScimServiceProviderConfigFilter: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of ScimServiceProviderConfigFilter from a dict""" if obj is None: return None if not isinstance(obj, dict): - return ScimServiceProviderConfigFilter.parse_obj(obj) + return cls.model_validate(obj) - _obj = ScimServiceProviderConfigFilter.parse_obj({ + _obj = cls.model_validate({ "supported": obj.get("supported"), - "max_results": obj.get("maxResults") + "maxResults": obj.get("maxResults") }) return _obj diff --git a/eZmaxApi/models/scim_service_provider_config_patch.py b/eZmaxApi/models/scim_service_provider_config_patch.py index 8c1952750..d080b5b80 100644 --- a/eZmaxApi/models/scim_service_provider_config_patch.py +++ b/eZmaxApi/models/scim_service_provider_config_patch.py @@ -19,52 +19,70 @@ import json - -from pydantic import BaseModel, Field, StrictBool +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictBool +from pydantic import Field +try: + from typing import Self +except ImportError: + from typing_extensions import Self class ScimServiceProviderConfigPatch(BaseModel): """ - A complex type that specifies PATCH configuration options. # noqa: E501 - """ - supported: StrictBool = Field(..., description="A Boolean value specifying whether or not the operation is supported.") - __properties = ["supported"] + A complex type that specifies PATCH configuration options. + """ # noqa: E501 + supported: StrictBool = Field(description="A Boolean value specifying whether or not the operation is supported.") + __properties: ClassVar[List[str]] = ["supported"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> ScimServiceProviderConfigPatch: + def from_json(cls, json_str: str) -> Self: """Create an instance of ScimServiceProviderConfigPatch from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> ScimServiceProviderConfigPatch: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of ScimServiceProviderConfigPatch from a dict""" if obj is None: return None if not isinstance(obj, dict): - return ScimServiceProviderConfigPatch.parse_obj(obj) + return cls.model_validate(obj) - _obj = ScimServiceProviderConfigPatch.parse_obj({ + _obj = cls.model_validate({ "supported": obj.get("supported") }) return _obj diff --git a/eZmaxApi/models/scim_service_provider_config_sort.py b/eZmaxApi/models/scim_service_provider_config_sort.py index b6f6ec5f1..0d40ac202 100644 --- a/eZmaxApi/models/scim_service_provider_config_sort.py +++ b/eZmaxApi/models/scim_service_provider_config_sort.py @@ -19,52 +19,70 @@ import json - -from pydantic import BaseModel, Field, StrictBool +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictBool +from pydantic import Field +try: + from typing import Self +except ImportError: + from typing_extensions import Self class ScimServiceProviderConfigSort(BaseModel): """ - A complex type that specifies Sort configuration options. # noqa: E501 - """ - supported: StrictBool = Field(..., description="A Boolean value specifying whether or not sorting is supported.") - __properties = ["supported"] + A complex type that specifies Sort configuration options. + """ # noqa: E501 + supported: StrictBool = Field(description="A Boolean value specifying whether or not sorting is supported.") + __properties: ClassVar[List[str]] = ["supported"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> ScimServiceProviderConfigSort: + def from_json(cls, json_str: str) -> Self: """Create an instance of ScimServiceProviderConfigSort from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> ScimServiceProviderConfigSort: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of ScimServiceProviderConfigSort from a dict""" if obj is None: return None if not isinstance(obj, dict): - return ScimServiceProviderConfigSort.parse_obj(obj) + return cls.model_validate(obj) - _obj = ScimServiceProviderConfigSort.parse_obj({ + _obj = cls.model_validate({ "supported": obj.get("supported") }) return _obj diff --git a/eZmaxApi/models/scim_user.py b/eZmaxApi/models/scim_user.py index 280e6eaa6..9d46e2914 100644 --- a/eZmaxApi/models/scim_user.py +++ b/eZmaxApi/models/scim_user.py @@ -19,44 +19,62 @@ import json -from typing import List, Optional -from pydantic import BaseModel, Field, StrictStr, conlist +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictStr +from pydantic import Field from eZmaxApi.models.scim_email import ScimEmail +try: + from typing import Self +except ImportError: + from typing_extensions import Self class ScimUser(BaseModel): """ ScimUser - """ + """ # noqa: E501 id: Optional[StrictStr] = None - user_name: StrictStr = Field(..., alias="userName", description="A service provider's unique identifier for the user, typically used by the user to directly authenticate to the service provider. Often displayed to the user as their unique identifier within the system (as opposed to \"id\" or \"externalId\", which are generally opaque and not user-friendly identifiers). Each User MUST include a non-empty userName value. This identifier MUST be unique across the service provider's entire set of Users. This attribute is REQUIRED and is case insensitive.") - display_name: Optional[StrictStr] = Field(None, alias="displayName") - emails: Optional[conlist(ScimEmail)] = None - __properties = ["id", "userName", "displayName", "emails"] + user_name: StrictStr = Field(description="A service provider's unique identifier for the user, typically used by the user to directly authenticate to the service provider. Often displayed to the user as their unique identifier within the system (as opposed to \"id\" or \"externalId\", which are generally opaque and not user-friendly identifiers). Each User MUST include a non-empty userName value. This identifier MUST be unique across the service provider's entire set of Users. This attribute is REQUIRED and is case insensitive.", alias="userName") + display_name: Optional[StrictStr] = Field(default=None, alias="displayName") + emails: Optional[List[ScimEmail]] = None + __properties: ClassVar[List[str]] = ["id", "userName", "displayName", "emails"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> ScimUser: + def from_json(cls, json_str: str) -> Self: """Create an instance of ScimUser from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in emails (list) _items = [] if self.emails: @@ -67,18 +85,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> ScimUser: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of ScimUser from a dict""" if obj is None: return None if not isinstance(obj, dict): - return ScimUser.parse_obj(obj) + return cls.model_validate(obj) - _obj = ScimUser.parse_obj({ + _obj = cls.model_validate({ "id": obj.get("id"), - "user_name": obj.get("userName"), - "display_name": obj.get("displayName"), + "userName": obj.get("userName"), + "displayName": obj.get("displayName"), "emails": [ScimEmail.from_dict(_item) for _item in obj.get("emails")] if obj.get("emails") is not None else None }) return _obj diff --git a/eZmaxApi/models/scim_user_list.py b/eZmaxApi/models/scim_user_list.py index ee9fbda98..836b1d0da 100644 --- a/eZmaxApi/models/scim_user_list.py +++ b/eZmaxApi/models/scim_user_list.py @@ -19,45 +19,63 @@ import json -from typing import List, Optional -from pydantic import BaseModel, Field, StrictInt, StrictStr, conlist +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictInt, StrictStr +from pydantic import Field from eZmaxApi.models.scim_user import ScimUser +try: + from typing import Self +except ImportError: + from typing_extensions import Self class ScimUserList(BaseModel): """ ScimUserList - """ - total_results: Optional[StrictInt] = Field(None, alias="totalResults") - items_per_page: Optional[StrictInt] = Field(None, alias="itemsPerPage") - start_index: Optional[StrictInt] = Field(None, alias="startIndex") - schemas: Optional[conlist(StrictStr)] = None - resources: Optional[conlist(ScimUser)] = Field(None, alias="Resources") - __properties = ["totalResults", "itemsPerPage", "startIndex", "schemas", "Resources"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + """ # noqa: E501 + total_results: Optional[StrictInt] = Field(default=None, alias="totalResults") + items_per_page: Optional[StrictInt] = Field(default=None, alias="itemsPerPage") + start_index: Optional[StrictInt] = Field(default=None, alias="startIndex") + schemas: Optional[List[StrictStr]] = None + resources: Optional[List[ScimUser]] = Field(default=None, alias="Resources") + __properties: ClassVar[List[str]] = ["totalResults", "itemsPerPage", "startIndex", "schemas", "Resources"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> ScimUserList: + def from_json(cls, json_str: str) -> Self: """Create an instance of ScimUserList from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in resources (list) _items = [] if self.resources: @@ -68,20 +86,20 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> ScimUserList: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of ScimUserList from a dict""" if obj is None: return None if not isinstance(obj, dict): - return ScimUserList.parse_obj(obj) + return cls.model_validate(obj) - _obj = ScimUserList.parse_obj({ - "total_results": obj.get("totalResults"), - "items_per_page": obj.get("itemsPerPage"), - "start_index": obj.get("startIndex"), + _obj = cls.model_validate({ + "totalResults": obj.get("totalResults"), + "itemsPerPage": obj.get("itemsPerPage"), + "startIndex": obj.get("startIndex"), "schemas": obj.get("schemas"), - "resources": [ScimUser.from_dict(_item) for _item in obj.get("Resources")] if obj.get("Resources") is not None else None + "Resources": [ScimUser.from_dict(_item) for _item in obj.get("Resources")] if obj.get("Resources") is not None else None }) return _obj diff --git a/eZmaxApi/models/secretquestion_autocomplete_element_response.py b/eZmaxApi/models/secretquestion_autocomplete_element_response.py index 2d4715854..f3e858bd0 100644 --- a/eZmaxApi/models/secretquestion_autocomplete_element_response.py +++ b/eZmaxApi/models/secretquestion_autocomplete_element_response.py @@ -19,57 +19,76 @@ import json - -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictBool, StrictStr +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class SecretquestionAutocompleteElementResponse(BaseModel): """ - A Secretquestion AutocompleteElement Response # noqa: E501 - """ - s_secretquestion_text_x: StrictStr = Field(..., alias="sSecretquestionTextX", description="The text of the Secretquestion in the language of the requester") - pki_secretquestion_id: conint(strict=True, ge=0) = Field(..., alias="pkiSecretquestionID", description="The unique ID of the Secretquestion. Valid values: |Value|Description| |-|-| |1|The name of the hospital in which you were born| |2|The name of your grade school| |3|The last name of your favorite teacher| |4|Your favorite sports team| |5|Your favorite TV show| |6|Your favorite movie| |7|The name of the street on which you grew up| |8|The name of your first employer| |9|Your first car| |10|Your favorite food| |11|The name of your first pet| |12|Favorite musician/band| |13|What instrument you play| |14|Your father's middle name| |15|Your mother's maiden name| |16|Name of your eldest child| |17|Your spouse's middle name| |18|Favorite restaurant| |19|Childhood nickname| |20|Favorite vacation destination| |21|Your boat's name| |22|Date of Birth (YYYY-MM-DD)| |22|Secret Code| |22|Your reference code|") - b_secretquestion_isactive: StrictBool = Field(..., alias="bSecretquestionIsactive", description="Whether the Secretquestion is active or not") - __properties = ["sSecretquestionTextX", "pkiSecretquestionID", "bSecretquestionIsactive"] + A Secretquestion AutocompleteElement Response + """ # noqa: E501 + s_secretquestion_text_x: StrictStr = Field(description="The text of the Secretquestion in the language of the requester", alias="sSecretquestionTextX") + pki_secretquestion_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Secretquestion. Valid values: |Value|Description| |-|-| |1|The name of the hospital in which you were born| |2|The name of your grade school| |3|The last name of your favorite teacher| |4|Your favorite sports team| |5|Your favorite TV show| |6|Your favorite movie| |7|The name of the street on which you grew up| |8|The name of your first employer| |9|Your first car| |10|Your favorite food| |11|The name of your first pet| |12|Favorite musician/band| |13|What instrument you play| |14|Your father's middle name| |15|Your mother's maiden name| |16|Name of your eldest child| |17|Your spouse's middle name| |18|Favorite restaurant| |19|Childhood nickname| |20|Favorite vacation destination| |21|Your boat's name| |22|Date of Birth (YYYY-MM-DD)| |22|Secret Code| |22|Your reference code|", alias="pkiSecretquestionID") + b_secretquestion_isactive: StrictBool = Field(description="Whether the Secretquestion is active or not", alias="bSecretquestionIsactive") + __properties: ClassVar[List[str]] = ["sSecretquestionTextX", "pkiSecretquestionID", "bSecretquestionIsactive"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> SecretquestionAutocompleteElementResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of SecretquestionAutocompleteElementResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> SecretquestionAutocompleteElementResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of SecretquestionAutocompleteElementResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return SecretquestionAutocompleteElementResponse.parse_obj(obj) + return cls.model_validate(obj) - _obj = SecretquestionAutocompleteElementResponse.parse_obj({ - "s_secretquestion_text_x": obj.get("sSecretquestionTextX"), - "pki_secretquestion_id": obj.get("pkiSecretquestionID"), - "b_secretquestion_isactive": obj.get("bSecretquestionIsactive") + _obj = cls.model_validate({ + "sSecretquestionTextX": obj.get("sSecretquestionTextX"), + "pkiSecretquestionID": obj.get("pkiSecretquestionID"), + "bSecretquestionIsactive": obj.get("bSecretquestionIsactive") }) return _obj diff --git a/eZmaxApi/models/secretquestion_get_autocomplete_v2_response.py b/eZmaxApi/models/secretquestion_get_autocomplete_v2_response.py index 780f9f8f3..93fd06d50 100644 --- a/eZmaxApi/models/secretquestion_get_autocomplete_v2_response.py +++ b/eZmaxApi/models/secretquestion_get_autocomplete_v2_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.secretquestion_get_autocomplete_v2_response_m_payload import SecretquestionGetAutocompleteV2ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class SecretquestionGetAutocompleteV2Response(BaseModel): """ - Response for GET /2/object/secretquestion/getAutocomplete # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: SecretquestionGetAutocompleteV2ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /2/object/secretquestion/getAutocomplete + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: SecretquestionGetAutocompleteV2ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> SecretquestionGetAutocompleteV2Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of SecretquestionGetAutocompleteV2Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> SecretquestionGetAutocompleteV2Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of SecretquestionGetAutocompleteV2Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return SecretquestionGetAutocompleteV2Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = SecretquestionGetAutocompleteV2Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": SecretquestionGetAutocompleteV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": SecretquestionGetAutocompleteV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/secretquestion_get_autocomplete_v2_response_m_payload.py b/eZmaxApi/models/secretquestion_get_autocomplete_v2_response_m_payload.py index 0f8c1f4e8..eeeb0d126 100644 --- a/eZmaxApi/models/secretquestion_get_autocomplete_v2_response_m_payload.py +++ b/eZmaxApi/models/secretquestion_get_autocomplete_v2_response_m_payload.py @@ -19,41 +19,59 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.secretquestion_autocomplete_element_response import SecretquestionAutocompleteElementResponse +try: + from typing import Self +except ImportError: + from typing_extensions import Self class SecretquestionGetAutocompleteV2ResponseMPayload(BaseModel): """ - Payload for POST /2/object/secretquestion/getAutocomplete # noqa: E501 - """ - a_obj_secretquestion: conlist(SecretquestionAutocompleteElementResponse) = Field(..., alias="a_objSecretquestion", description="An array of Secretquestion autocomplete element response.") - __properties = ["a_objSecretquestion"] + Payload for POST /2/object/secretquestion/getAutocomplete + """ # noqa: E501 + a_obj_secretquestion: List[SecretquestionAutocompleteElementResponse] = Field(description="An array of Secretquestion autocomplete element response.", alias="a_objSecretquestion") + __properties: ClassVar[List[str]] = ["a_objSecretquestion"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> SecretquestionGetAutocompleteV2ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of SecretquestionGetAutocompleteV2ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_secretquestion (list) _items = [] if self.a_obj_secretquestion: @@ -64,16 +82,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> SecretquestionGetAutocompleteV2ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of SecretquestionGetAutocompleteV2ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return SecretquestionGetAutocompleteV2ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = SecretquestionGetAutocompleteV2ResponseMPayload.parse_obj({ - "a_obj_secretquestion": [SecretquestionAutocompleteElementResponse.from_dict(_item) for _item in obj.get("a_objSecretquestion")] if obj.get("a_objSecretquestion") is not None else None + _obj = cls.model_validate({ + "a_objSecretquestion": [SecretquestionAutocompleteElementResponse.from_dict(_item) for _item in obj.get("a_objSecretquestion")] if obj.get("a_objSecretquestion") is not None else None }) return _obj diff --git a/eZmaxApi/models/sessionhistory_get_list_v1_response.py b/eZmaxApi/models/sessionhistory_get_list_v1_response.py index f3c480d14..a41d92d29 100644 --- a/eZmaxApi/models/sessionhistory_get_list_v1_response.py +++ b/eZmaxApi/models/sessionhistory_get_list_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload_get_list import CommonResponseObjDebugPayloadGetList from eZmaxApi.models.sessionhistory_get_list_v1_response_m_payload import SessionhistoryGetListV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class SessionhistoryGetListV1Response(BaseModel): """ - Response for GET /1/object/sessionhistory/getList # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayloadGetList = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: SessionhistoryGetListV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /1/object/sessionhistory/getList + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayloadGetList = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: SessionhistoryGetListV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> SessionhistoryGetListV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of SessionhistoryGetListV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> SessionhistoryGetListV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of SessionhistoryGetListV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return SessionhistoryGetListV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = SessionhistoryGetListV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayloadGetList.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": SessionhistoryGetListV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayloadGetList.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": SessionhistoryGetListV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/sessionhistory_get_list_v1_response_m_payload.py b/eZmaxApi/models/sessionhistory_get_list_v1_response_m_payload.py index 3d95c98dd..1fd379faa 100644 --- a/eZmaxApi/models/sessionhistory_get_list_v1_response_m_payload.py +++ b/eZmaxApi/models/sessionhistory_get_list_v1_response_m_payload.py @@ -19,43 +19,61 @@ import json -from typing import List -from pydantic import BaseModel, Field, StrictInt, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictInt +from pydantic import Field from eZmaxApi.models.sessionhistory_list_element import SessionhistoryListElement +try: + from typing import Self +except ImportError: + from typing_extensions import Self class SessionhistoryGetListV1ResponseMPayload(BaseModel): """ - Payload for GET /1/object/sessionhistory/getList # noqa: E501 - """ - i_row_returned: StrictInt = Field(..., alias="iRowReturned", description="The number of rows returned") - i_row_filtered: StrictInt = Field(..., alias="iRowFiltered", description="The number of rows matching your filters (if any) or the total number of rows") - a_obj_sessionhistory: conlist(SessionhistoryListElement) = Field(..., alias="a_objSessionhistory") - __properties = ["iRowReturned", "iRowFiltered", "a_objSessionhistory"] + Payload for GET /1/object/sessionhistory/getList + """ # noqa: E501 + i_row_returned: StrictInt = Field(description="The number of rows returned", alias="iRowReturned") + i_row_filtered: StrictInt = Field(description="The number of rows matching your filters (if any) or the total number of rows", alias="iRowFiltered") + a_obj_sessionhistory: List[SessionhistoryListElement] = Field(alias="a_objSessionhistory") + __properties: ClassVar[List[str]] = ["iRowReturned", "iRowFiltered", "a_objSessionhistory"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> SessionhistoryGetListV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of SessionhistoryGetListV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_sessionhistory (list) _items = [] if self.a_obj_sessionhistory: @@ -66,18 +84,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> SessionhistoryGetListV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of SessionhistoryGetListV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return SessionhistoryGetListV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = SessionhistoryGetListV1ResponseMPayload.parse_obj({ - "i_row_returned": obj.get("iRowReturned"), - "i_row_filtered": obj.get("iRowFiltered"), - "a_obj_sessionhistory": [SessionhistoryListElement.from_dict(_item) for _item in obj.get("a_objSessionhistory")] if obj.get("a_objSessionhistory") is not None else None + _obj = cls.model_validate({ + "iRowReturned": obj.get("iRowReturned"), + "iRowFiltered": obj.get("iRowFiltered"), + "a_objSessionhistory": [SessionhistoryListElement.from_dict(_item) for _item in obj.get("a_objSessionhistory")] if obj.get("a_objSessionhistory") is not None else None }) return _obj diff --git a/eZmaxApi/models/sessionhistory_list_element.py b/eZmaxApi/models/sessionhistory_list_element.py index a46152df2..3b21c027f 100644 --- a/eZmaxApi/models/sessionhistory_list_element.py +++ b/eZmaxApi/models/sessionhistory_list_element.py @@ -19,41 +19,47 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictStr, conint, constr, validator +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictStr, field_validator +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.field_e_sessionhistory_endby import FieldESessionhistoryEndby +try: + from typing import Self +except ImportError: + from typing_extensions import Self class SessionhistoryListElement(BaseModel): """ - A Sessionhistory List Element # noqa: E501 - """ - pki_sessionhistory_id: conint(strict=True, le=2147483647, ge=1) = Field(..., alias="pkiSessionhistoryID", description="The unique ID of the Sessionhistory") - fki_computer_id: Optional[conint(strict=True, le=65535, ge=1)] = Field(None, alias="fkiComputerID", description="The unique ID of the Computer") - fki_user_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiUserID", description="The unique ID of the User") - dt_sessionhistory_firsthit: constr(strict=True) = Field(..., alias="dtSessionhistoryFirsthit", description="The first hit of the Sessionhistory") - dt_sessionhistory_lasthit: constr(strict=True) = Field(..., alias="dtSessionhistoryLasthit", description="The last hit of the Sessionhistory") - e_sessionhistory_endby: FieldESessionhistoryEndby = Field(..., alias="eSessionhistoryEndby") - s_computer_description: Optional[constr(strict=True)] = Field(None, alias="sComputerDescription", description="The description of the Computer") - s_sessionhistory_duration: constr(strict=True) = Field(..., alias="sSessionhistoryDuration", description="The duration of the session") - s_sessionhistory_ip: StrictStr = Field(..., alias="sSessionhistoryIP", description="Represent an IP address.") - s_user_loginname: Optional[constr(strict=True)] = Field(None, alias="sUserLoginname", description="The login name of the User.") - __properties = ["pkiSessionhistoryID", "fkiComputerID", "fkiUserID", "dtSessionhistoryFirsthit", "dtSessionhistoryLasthit", "eSessionhistoryEndby", "sComputerDescription", "sSessionhistoryDuration", "sSessionhistoryIP", "sUserLoginname"] - - @validator('dt_sessionhistory_firsthit') + A Sessionhistory List Element + """ # noqa: E501 + pki_sessionhistory_id: Annotated[int, Field(le=2147483647, strict=True, ge=1)] = Field(description="The unique ID of the Sessionhistory", alias="pkiSessionhistoryID") + fki_computer_id: Optional[Annotated[int, Field(le=65535, strict=True, ge=1)]] = Field(default=None, description="The unique ID of the Computer", alias="fkiComputerID") + fki_user_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the User", alias="fkiUserID") + dt_sessionhistory_firsthit: Annotated[str, Field(strict=True)] = Field(description="The first hit of the Sessionhistory", alias="dtSessionhistoryFirsthit") + dt_sessionhistory_lasthit: Annotated[str, Field(strict=True)] = Field(description="The last hit of the Sessionhistory", alias="dtSessionhistoryLasthit") + e_sessionhistory_endby: FieldESessionhistoryEndby = Field(alias="eSessionhistoryEndby") + s_computer_description: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="The description of the Computer", alias="sComputerDescription") + s_sessionhistory_duration: Annotated[str, Field(strict=True)] = Field(description="The duration of the session", alias="sSessionhistoryDuration") + s_sessionhistory_ip: StrictStr = Field(description="Represent an IP address.", alias="sSessionhistoryIP") + s_user_loginname: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="The login name of the User.", alias="sUserLoginname") + __properties: ClassVar[List[str]] = ["pkiSessionhistoryID", "fkiComputerID", "fkiUserID", "dtSessionhistoryFirsthit", "dtSessionhistoryLasthit", "eSessionhistoryEndby", "sComputerDescription", "sSessionhistoryDuration", "sSessionhistoryIP", "sUserLoginname"] + + @field_validator('dt_sessionhistory_firsthit') def dt_sessionhistory_firsthit_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1]) ([01]?[0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9])$", value): raise ValueError(r"must validate the regular expression /^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1]) ([01]?[0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9])$/") return value - @validator('dt_sessionhistory_lasthit') + @field_validator('dt_sessionhistory_lasthit') def dt_sessionhistory_lasthit_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1]) ([01]?[0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9])$", value): raise ValueError(r"must validate the regular expression /^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1]) ([01]?[0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9])$/") return value - @validator('s_computer_description') + @field_validator('s_computer_description') def s_computer_description_validate_regular_expression(cls, value): """Validates the regular expression""" if value is None: @@ -63,14 +69,14 @@ def s_computer_description_validate_regular_expression(cls, value): raise ValueError(r"must validate the regular expression /^.{0,50}$/") return value - @validator('s_sessionhistory_duration') + @field_validator('s_sessionhistory_duration') def s_sessionhistory_duration_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^(0[0-9]{1}|\d{2,}):([0-5][0-9]):([0-5][0-9])$", value): raise ValueError(r"must validate the regular expression /^(0[0-9]{1}|\d{2,}):([0-5][0-9]):([0-5][0-9])$/") return value - @validator('s_user_loginname') + @field_validator('s_user_loginname') def s_user_loginname_validate_regular_expression(cls, value): """Validates the regular expression""" if value is None: @@ -80,52 +86,65 @@ def s_user_loginname_validate_regular_expression(cls, value): raise ValueError(r"must validate the regular expression /^(?:([\w\.-]+@[\w\.-]+\.\w{2,20})|([a-zA-Z0-9]){1,32})$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> SessionhistoryListElement: + def from_json(cls, json_str: str) -> Self: """Create an instance of SessionhistoryListElement from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> SessionhistoryListElement: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of SessionhistoryListElement from a dict""" if obj is None: return None if not isinstance(obj, dict): - return SessionhistoryListElement.parse_obj(obj) - - _obj = SessionhistoryListElement.parse_obj({ - "pki_sessionhistory_id": obj.get("pkiSessionhistoryID"), - "fki_computer_id": obj.get("fkiComputerID"), - "fki_user_id": obj.get("fkiUserID"), - "dt_sessionhistory_firsthit": obj.get("dtSessionhistoryFirsthit"), - "dt_sessionhistory_lasthit": obj.get("dtSessionhistoryLasthit"), - "e_sessionhistory_endby": obj.get("eSessionhistoryEndby"), - "s_computer_description": obj.get("sComputerDescription"), - "s_sessionhistory_duration": obj.get("sSessionhistoryDuration"), - "s_sessionhistory_ip": obj.get("sSessionhistoryIP"), - "s_user_loginname": obj.get("sUserLoginname") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiSessionhistoryID": obj.get("pkiSessionhistoryID"), + "fkiComputerID": obj.get("fkiComputerID"), + "fkiUserID": obj.get("fkiUserID"), + "dtSessionhistoryFirsthit": obj.get("dtSessionhistoryFirsthit"), + "dtSessionhistoryLasthit": obj.get("dtSessionhistoryLasthit"), + "eSessionhistoryEndby": obj.get("eSessionhistoryEndby"), + "sComputerDescription": obj.get("sComputerDescription"), + "sSessionhistoryDuration": obj.get("sSessionhistoryDuration"), + "sSessionhistoryIP": obj.get("sSessionhistoryIP"), + "sUserLoginname": obj.get("sUserLoginname") }) return _obj diff --git a/eZmaxApi/models/signature_create_object_v1_request.py b/eZmaxApi/models/signature_create_object_v1_request.py index bc0c6f32b..f33ea0d2c 100644 --- a/eZmaxApi/models/signature_create_object_v1_request.py +++ b/eZmaxApi/models/signature_create_object_v1_request.py @@ -19,41 +19,60 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.signature_request_compound import SignatureRequestCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class SignatureCreateObjectV1Request(BaseModel): """ - Request for POST /1/object/signature # noqa: E501 - """ - a_obj_signature: conlist(SignatureRequestCompound, min_items=1) = Field(..., alias="a_objSignature") - __properties = ["a_objSignature"] + Request for POST /1/object/signature + """ # noqa: E501 + a_obj_signature: Annotated[List[SignatureRequestCompound], Field(min_length=1)] = Field(alias="a_objSignature") + __properties: ClassVar[List[str]] = ["a_objSignature"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> SignatureCreateObjectV1Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of SignatureCreateObjectV1Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_signature (list) _items = [] if self.a_obj_signature: @@ -64,16 +83,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> SignatureCreateObjectV1Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of SignatureCreateObjectV1Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return SignatureCreateObjectV1Request.parse_obj(obj) + return cls.model_validate(obj) - _obj = SignatureCreateObjectV1Request.parse_obj({ - "a_obj_signature": [SignatureRequestCompound.from_dict(_item) for _item in obj.get("a_objSignature")] if obj.get("a_objSignature") is not None else None + _obj = cls.model_validate({ + "a_objSignature": [SignatureRequestCompound.from_dict(_item) for _item in obj.get("a_objSignature")] if obj.get("a_objSignature") is not None else None }) return _obj diff --git a/eZmaxApi/models/signature_create_object_v1_response.py b/eZmaxApi/models/signature_create_object_v1_response.py index 76f06bc9e..dd4a24c5e 100644 --- a/eZmaxApi/models/signature_create_object_v1_response.py +++ b/eZmaxApi/models/signature_create_object_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.signature_create_object_v1_response_m_payload import SignatureCreateObjectV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class SignatureCreateObjectV1Response(BaseModel): """ - Response for POST /1/object/signature # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: SignatureCreateObjectV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for POST /1/object/signature + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: SignatureCreateObjectV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> SignatureCreateObjectV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of SignatureCreateObjectV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> SignatureCreateObjectV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of SignatureCreateObjectV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return SignatureCreateObjectV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = SignatureCreateObjectV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": SignatureCreateObjectV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": SignatureCreateObjectV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/signature_create_object_v1_response_m_payload.py b/eZmaxApi/models/signature_create_object_v1_response_m_payload.py index fb4057a57..b2555d2b3 100644 --- a/eZmaxApi/models/signature_create_object_v1_response_m_payload.py +++ b/eZmaxApi/models/signature_create_object_v1_response_m_payload.py @@ -19,53 +19,72 @@ import json -from typing import List -from pydantic import BaseModel, Field, conint, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class SignatureCreateObjectV1ResponseMPayload(BaseModel): """ - Payload for POST /1/object/signature # noqa: E501 - """ - a_pki_signature_id: conlist(conint(strict=True, le=16777215, ge=0)) = Field(..., alias="a_pkiSignatureID", description="An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request.") - __properties = ["a_pkiSignatureID"] + Payload for POST /1/object/signature + """ # noqa: E501 + a_pki_signature_id: List[Annotated[int, Field(le=16777215, strict=True, ge=0)]] = Field(description="An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request.", alias="a_pkiSignatureID") + __properties: ClassVar[List[str]] = ["a_pkiSignatureID"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> SignatureCreateObjectV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of SignatureCreateObjectV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> SignatureCreateObjectV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of SignatureCreateObjectV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return SignatureCreateObjectV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = SignatureCreateObjectV1ResponseMPayload.parse_obj({ - "a_pki_signature_id": obj.get("a_pkiSignatureID") + _obj = cls.model_validate({ + "a_pkiSignatureID": obj.get("a_pkiSignatureID") }) return _obj diff --git a/eZmaxApi/models/signature_delete_object_v1_response.py b/eZmaxApi/models/signature_delete_object_v1_response.py index 9fa7a5c91..789858893 100644 --- a/eZmaxApi/models/signature_delete_object_v1_response.py +++ b/eZmaxApi/models/signature_delete_object_v1_response.py @@ -19,43 +19,61 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class SignatureDeleteObjectV1Response(BaseModel): """ - Response for DELETE /1/object/signature/{pkiSignatureID} # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - __properties = ["objDebugPayload", "objDebug"] + Response for DELETE /1/object/signature/{pkiSignatureID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> SignatureDeleteObjectV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of SignatureDeleteObjectV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -65,17 +83,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> SignatureDeleteObjectV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of SignatureDeleteObjectV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return SignatureDeleteObjectV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = SignatureDeleteObjectV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None }) return _obj diff --git a/eZmaxApi/models/signature_edit_object_v1_request.py b/eZmaxApi/models/signature_edit_object_v1_request.py index 7da01d9f2..e939f112e 100644 --- a/eZmaxApi/models/signature_edit_object_v1_request.py +++ b/eZmaxApi/models/signature_edit_object_v1_request.py @@ -19,57 +19,75 @@ import json - -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.signature_request_compound import SignatureRequestCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class SignatureEditObjectV1Request(BaseModel): """ - Request for PUT /1/object/signature/{pkiSignatureID} # noqa: E501 - """ - obj_signature: SignatureRequestCompound = Field(..., alias="objSignature") - __properties = ["objSignature"] + Request for PUT /1/object/signature/{pkiSignatureID} + """ # noqa: E501 + obj_signature: SignatureRequestCompound = Field(alias="objSignature") + __properties: ClassVar[List[str]] = ["objSignature"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> SignatureEditObjectV1Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of SignatureEditObjectV1Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_signature if self.obj_signature: _dict['objSignature'] = self.obj_signature.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> SignatureEditObjectV1Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of SignatureEditObjectV1Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return SignatureEditObjectV1Request.parse_obj(obj) + return cls.model_validate(obj) - _obj = SignatureEditObjectV1Request.parse_obj({ - "obj_signature": SignatureRequestCompound.from_dict(obj.get("objSignature")) if obj.get("objSignature") is not None else None + _obj = cls.model_validate({ + "objSignature": SignatureRequestCompound.from_dict(obj.get("objSignature")) if obj.get("objSignature") is not None else None }) return _obj diff --git a/eZmaxApi/models/signature_edit_object_v1_response.py b/eZmaxApi/models/signature_edit_object_v1_response.py index cc5adc2e8..d7891a3c9 100644 --- a/eZmaxApi/models/signature_edit_object_v1_response.py +++ b/eZmaxApi/models/signature_edit_object_v1_response.py @@ -19,43 +19,61 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class SignatureEditObjectV1Response(BaseModel): """ - Response for PUT /1/object/signature/{pkiSignatureID} # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - __properties = ["objDebugPayload", "objDebug"] + Response for PUT /1/object/signature/{pkiSignatureID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> SignatureEditObjectV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of SignatureEditObjectV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -65,17 +83,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> SignatureEditObjectV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of SignatureEditObjectV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return SignatureEditObjectV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = SignatureEditObjectV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None }) return _obj diff --git a/eZmaxApi/models/signature_get_object_v2_response.py b/eZmaxApi/models/signature_get_object_v2_response.py index f56b4a9d0..358e26d9c 100644 --- a/eZmaxApi/models/signature_get_object_v2_response.py +++ b/eZmaxApi/models/signature_get_object_v2_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.signature_get_object_v2_response_m_payload import SignatureGetObjectV2ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class SignatureGetObjectV2Response(BaseModel): """ - Response for GET /2/object/signature/{pkiSignatureID} # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: SignatureGetObjectV2ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /2/object/signature/{pkiSignatureID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: SignatureGetObjectV2ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> SignatureGetObjectV2Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of SignatureGetObjectV2Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> SignatureGetObjectV2Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of SignatureGetObjectV2Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return SignatureGetObjectV2Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = SignatureGetObjectV2Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": SignatureGetObjectV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": SignatureGetObjectV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/signature_get_object_v2_response_m_payload.py b/eZmaxApi/models/signature_get_object_v2_response_m_payload.py index 48006603d..1343dbec0 100644 --- a/eZmaxApi/models/signature_get_object_v2_response_m_payload.py +++ b/eZmaxApi/models/signature_get_object_v2_response_m_payload.py @@ -19,57 +19,75 @@ import json - -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.signature_response_compound import SignatureResponseCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class SignatureGetObjectV2ResponseMPayload(BaseModel): """ - Payload for GET /2/object/signature/{pkiSignatureID} # noqa: E501 - """ - obj_signature: SignatureResponseCompound = Field(..., alias="objSignature") - __properties = ["objSignature"] + Payload for GET /2/object/signature/{pkiSignatureID} + """ # noqa: E501 + obj_signature: SignatureResponseCompound = Field(alias="objSignature") + __properties: ClassVar[List[str]] = ["objSignature"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> SignatureGetObjectV2ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of SignatureGetObjectV2ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_signature if self.obj_signature: _dict['objSignature'] = self.obj_signature.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> SignatureGetObjectV2ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of SignatureGetObjectV2ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return SignatureGetObjectV2ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = SignatureGetObjectV2ResponseMPayload.parse_obj({ - "obj_signature": SignatureResponseCompound.from_dict(obj.get("objSignature")) if obj.get("objSignature") is not None else None + _obj = cls.model_validate({ + "objSignature": SignatureResponseCompound.from_dict(obj.get("objSignature")) if obj.get("objSignature") is not None else None }) return _obj diff --git a/eZmaxApi/models/signature_request.py b/eZmaxApi/models/signature_request.py index c655358f5..4b6fa7a67 100644 --- a/eZmaxApi/models/signature_request.py +++ b/eZmaxApi/models/signature_request.py @@ -19,62 +19,81 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, conint, constr, validator +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, field_validator +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class SignatureRequest(BaseModel): """ - A Signature Object # noqa: E501 - """ - pki_signature_id: Optional[conint(strict=True, le=16777215, ge=0)] = Field(None, alias="pkiSignatureID", description="The unique ID of the Signature") - t_signature_svg: constr(strict=True) = Field(..., alias="tSignatureSvg", description="The svg of the Signature") - __properties = ["pkiSignatureID", "tSignatureSvg"] + A Signature Object + """ # noqa: E501 + pki_signature_id: Optional[Annotated[int, Field(le=16777215, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Signature", alias="pkiSignatureID") + t_signature_svg: Annotated[str, Field(strict=True)] = Field(description="The svg of the Signature", alias="tSignatureSvg") + __properties: ClassVar[List[str]] = ["pkiSignatureID", "tSignatureSvg"] - @validator('t_signature_svg') + @field_validator('t_signature_svg') def t_signature_svg_validate_regular_expression(cls, value): """Validates the regular expression""" - if not re.match(r"^.{0,32767}$", value): - raise ValueError(r"must validate the regular expression /^.{0,32767}$/") + if not re.match(r"^.{0,65535}$", value): + raise ValueError(r"must validate the regular expression /^.{0,65535}$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> SignatureRequest: + def from_json(cls, json_str: str) -> Self: """Create an instance of SignatureRequest from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> SignatureRequest: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of SignatureRequest from a dict""" if obj is None: return None if not isinstance(obj, dict): - return SignatureRequest.parse_obj(obj) + return cls.model_validate(obj) - _obj = SignatureRequest.parse_obj({ - "pki_signature_id": obj.get("pkiSignatureID"), - "t_signature_svg": obj.get("tSignatureSvg") + _obj = cls.model_validate({ + "pkiSignatureID": obj.get("pkiSignatureID"), + "tSignatureSvg": obj.get("tSignatureSvg") }) return _obj diff --git a/eZmaxApi/models/signature_request_compound.py b/eZmaxApi/models/signature_request_compound.py index 2d8839372..de639982c 100644 --- a/eZmaxApi/models/signature_request_compound.py +++ b/eZmaxApi/models/signature_request_compound.py @@ -19,62 +19,81 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, conint, constr, validator +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, field_validator +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class SignatureRequestCompound(BaseModel): """ - A Signature Object and children # noqa: E501 - """ - pki_signature_id: Optional[conint(strict=True, le=16777215, ge=0)] = Field(None, alias="pkiSignatureID", description="The unique ID of the Signature") - t_signature_svg: constr(strict=True) = Field(..., alias="tSignatureSvg", description="The svg of the Signature") - __properties = ["pkiSignatureID", "tSignatureSvg"] + A Signature Object and children + """ # noqa: E501 + pki_signature_id: Optional[Annotated[int, Field(le=16777215, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Signature", alias="pkiSignatureID") + t_signature_svg: Annotated[str, Field(strict=True)] = Field(description="The svg of the Signature", alias="tSignatureSvg") + __properties: ClassVar[List[str]] = ["pkiSignatureID", "tSignatureSvg"] - @validator('t_signature_svg') + @field_validator('t_signature_svg') def t_signature_svg_validate_regular_expression(cls, value): """Validates the regular expression""" - if not re.match(r"^.{0,32767}$", value): - raise ValueError(r"must validate the regular expression /^.{0,32767}$/") + if not re.match(r"^.{0,65535}$", value): + raise ValueError(r"must validate the regular expression /^.{0,65535}$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> SignatureRequestCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of SignatureRequestCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> SignatureRequestCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of SignatureRequestCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return SignatureRequestCompound.parse_obj(obj) + return cls.model_validate(obj) - _obj = SignatureRequestCompound.parse_obj({ - "pki_signature_id": obj.get("pkiSignatureID"), - "t_signature_svg": obj.get("tSignatureSvg") + _obj = cls.model_validate({ + "pkiSignatureID": obj.get("pkiSignatureID"), + "tSignatureSvg": obj.get("tSignatureSvg") }) return _obj diff --git a/eZmaxApi/models/signature_response.py b/eZmaxApi/models/signature_response.py index 2c691e273..37151f3a2 100644 --- a/eZmaxApi/models/signature_response.py +++ b/eZmaxApi/models/signature_response.py @@ -19,62 +19,81 @@ import json - -from pydantic import BaseModel, Field, conint, constr, validator +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, field_validator +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class SignatureResponse(BaseModel): """ - A Signature Object # noqa: E501 - """ - pki_signature_id: conint(strict=True, le=16777215, ge=0) = Field(..., alias="pkiSignatureID", description="The unique ID of the Signature") - s_signature_url: constr(strict=True) = Field(..., alias="sSignatureUrl", description="The URL of the SVG file for the Signature") - __properties = ["pkiSignatureID", "sSignatureUrl"] + A Signature Object + """ # noqa: E501 + pki_signature_id: Annotated[int, Field(le=16777215, strict=True, ge=0)] = Field(description="The unique ID of the Signature", alias="pkiSignatureID") + s_signature_url: Annotated[str, Field(strict=True)] = Field(description="The URL of the SVG file for the Signature", alias="sSignatureUrl") + __properties: ClassVar[List[str]] = ["pkiSignatureID", "sSignatureUrl"] - @validator('s_signature_url') + @field_validator('s_signature_url') def s_signature_url_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^.{0,2048}$", value): raise ValueError(r"must validate the regular expression /^.{0,2048}$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> SignatureResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of SignatureResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> SignatureResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of SignatureResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return SignatureResponse.parse_obj(obj) + return cls.model_validate(obj) - _obj = SignatureResponse.parse_obj({ - "pki_signature_id": obj.get("pkiSignatureID"), - "s_signature_url": obj.get("sSignatureUrl") + _obj = cls.model_validate({ + "pkiSignatureID": obj.get("pkiSignatureID"), + "sSignatureUrl": obj.get("sSignatureUrl") }) return _obj diff --git a/eZmaxApi/models/signature_response_compound.py b/eZmaxApi/models/signature_response_compound.py index 7e0a20a93..a6f03fc77 100644 --- a/eZmaxApi/models/signature_response_compound.py +++ b/eZmaxApi/models/signature_response_compound.py @@ -19,62 +19,81 @@ import json - -from pydantic import BaseModel, Field, conint, constr, validator +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, field_validator +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class SignatureResponseCompound(BaseModel): """ - A Signature Object # noqa: E501 - """ - pki_signature_id: conint(strict=True, le=16777215, ge=0) = Field(..., alias="pkiSignatureID", description="The unique ID of the Signature") - s_signature_url: constr(strict=True) = Field(..., alias="sSignatureUrl", description="The URL of the SVG file for the Signature") - __properties = ["pkiSignatureID", "sSignatureUrl"] + A Signature Object + """ # noqa: E501 + pki_signature_id: Annotated[int, Field(le=16777215, strict=True, ge=0)] = Field(description="The unique ID of the Signature", alias="pkiSignatureID") + s_signature_url: Annotated[str, Field(strict=True)] = Field(description="The URL of the SVG file for the Signature", alias="sSignatureUrl") + __properties: ClassVar[List[str]] = ["pkiSignatureID", "sSignatureUrl"] - @validator('s_signature_url') + @field_validator('s_signature_url') def s_signature_url_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^.{0,2048}$", value): raise ValueError(r"must validate the regular expression /^.{0,2048}$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> SignatureResponseCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of SignatureResponseCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> SignatureResponseCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of SignatureResponseCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return SignatureResponseCompound.parse_obj(obj) + return cls.model_validate(obj) - _obj = SignatureResponseCompound.parse_obj({ - "pki_signature_id": obj.get("pkiSignatureID"), - "s_signature_url": obj.get("sSignatureUrl") + _obj = cls.model_validate({ + "pkiSignatureID": obj.get("pkiSignatureID"), + "sSignatureUrl": obj.get("sSignatureUrl") }) return _obj diff --git a/eZmaxApi/models/subnet_create_object_v1_request.py b/eZmaxApi/models/subnet_create_object_v1_request.py index c5444591a..6dc672fcb 100644 --- a/eZmaxApi/models/subnet_create_object_v1_request.py +++ b/eZmaxApi/models/subnet_create_object_v1_request.py @@ -19,41 +19,60 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.subnet_request_compound import SubnetRequestCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class SubnetCreateObjectV1Request(BaseModel): """ - Request for POST /1/object/subnet # noqa: E501 - """ - a_obj_subnet: conlist(SubnetRequestCompound, min_items=1) = Field(..., alias="a_objSubnet") - __properties = ["a_objSubnet"] + Request for POST /1/object/subnet + """ # noqa: E501 + a_obj_subnet: Annotated[List[SubnetRequestCompound], Field(min_length=1)] = Field(alias="a_objSubnet") + __properties: ClassVar[List[str]] = ["a_objSubnet"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> SubnetCreateObjectV1Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of SubnetCreateObjectV1Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_subnet (list) _items = [] if self.a_obj_subnet: @@ -64,16 +83,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> SubnetCreateObjectV1Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of SubnetCreateObjectV1Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return SubnetCreateObjectV1Request.parse_obj(obj) + return cls.model_validate(obj) - _obj = SubnetCreateObjectV1Request.parse_obj({ - "a_obj_subnet": [SubnetRequestCompound.from_dict(_item) for _item in obj.get("a_objSubnet")] if obj.get("a_objSubnet") is not None else None + _obj = cls.model_validate({ + "a_objSubnet": [SubnetRequestCompound.from_dict(_item) for _item in obj.get("a_objSubnet")] if obj.get("a_objSubnet") is not None else None }) return _obj diff --git a/eZmaxApi/models/subnet_create_object_v1_response.py b/eZmaxApi/models/subnet_create_object_v1_response.py index 1c849830f..5d4842438 100644 --- a/eZmaxApi/models/subnet_create_object_v1_response.py +++ b/eZmaxApi/models/subnet_create_object_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.subnet_create_object_v1_response_m_payload import SubnetCreateObjectV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class SubnetCreateObjectV1Response(BaseModel): """ - Response for POST /1/object/subnet # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: SubnetCreateObjectV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for POST /1/object/subnet + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: SubnetCreateObjectV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> SubnetCreateObjectV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of SubnetCreateObjectV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> SubnetCreateObjectV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of SubnetCreateObjectV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return SubnetCreateObjectV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = SubnetCreateObjectV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": SubnetCreateObjectV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": SubnetCreateObjectV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/subnet_create_object_v1_response_m_payload.py b/eZmaxApi/models/subnet_create_object_v1_response_m_payload.py index ee6fe25db..f6837d266 100644 --- a/eZmaxApi/models/subnet_create_object_v1_response_m_payload.py +++ b/eZmaxApi/models/subnet_create_object_v1_response_m_payload.py @@ -19,53 +19,72 @@ import json -from typing import List -from pydantic import BaseModel, Field, conint, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class SubnetCreateObjectV1ResponseMPayload(BaseModel): """ - Payload for POST /1/object/subnet # noqa: E501 - """ - a_pki_subnet_id: conlist(conint(strict=True, le=65535, ge=0)) = Field(..., alias="a_pkiSubnetID", description="An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request.") - __properties = ["a_pkiSubnetID"] + Payload for POST /1/object/subnet + """ # noqa: E501 + a_pki_subnet_id: List[Annotated[int, Field(le=65535, strict=True, ge=0)]] = Field(description="An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request.", alias="a_pkiSubnetID") + __properties: ClassVar[List[str]] = ["a_pkiSubnetID"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> SubnetCreateObjectV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of SubnetCreateObjectV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> SubnetCreateObjectV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of SubnetCreateObjectV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return SubnetCreateObjectV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = SubnetCreateObjectV1ResponseMPayload.parse_obj({ - "a_pki_subnet_id": obj.get("a_pkiSubnetID") + _obj = cls.model_validate({ + "a_pkiSubnetID": obj.get("a_pkiSubnetID") }) return _obj diff --git a/eZmaxApi/models/subnet_delete_object_v1_response.py b/eZmaxApi/models/subnet_delete_object_v1_response.py index 107daaaf6..6134796b7 100644 --- a/eZmaxApi/models/subnet_delete_object_v1_response.py +++ b/eZmaxApi/models/subnet_delete_object_v1_response.py @@ -19,43 +19,61 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class SubnetDeleteObjectV1Response(BaseModel): """ - Response for DELETE /1/object/subnet/{pkiSubnetID} # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - __properties = ["objDebugPayload", "objDebug"] + Response for DELETE /1/object/subnet/{pkiSubnetID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> SubnetDeleteObjectV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of SubnetDeleteObjectV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -65,17 +83,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> SubnetDeleteObjectV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of SubnetDeleteObjectV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return SubnetDeleteObjectV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = SubnetDeleteObjectV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None }) return _obj diff --git a/eZmaxApi/models/subnet_edit_object_v1_request.py b/eZmaxApi/models/subnet_edit_object_v1_request.py index 55c3de63b..82b63fef7 100644 --- a/eZmaxApi/models/subnet_edit_object_v1_request.py +++ b/eZmaxApi/models/subnet_edit_object_v1_request.py @@ -19,57 +19,75 @@ import json - -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.subnet_request_compound import SubnetRequestCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class SubnetEditObjectV1Request(BaseModel): """ - Request for PUT /1/object/subnet/{pkiSubnetID} # noqa: E501 - """ - obj_subnet: SubnetRequestCompound = Field(..., alias="objSubnet") - __properties = ["objSubnet"] + Request for PUT /1/object/subnet/{pkiSubnetID} + """ # noqa: E501 + obj_subnet: SubnetRequestCompound = Field(alias="objSubnet") + __properties: ClassVar[List[str]] = ["objSubnet"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> SubnetEditObjectV1Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of SubnetEditObjectV1Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_subnet if self.obj_subnet: _dict['objSubnet'] = self.obj_subnet.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> SubnetEditObjectV1Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of SubnetEditObjectV1Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return SubnetEditObjectV1Request.parse_obj(obj) + return cls.model_validate(obj) - _obj = SubnetEditObjectV1Request.parse_obj({ - "obj_subnet": SubnetRequestCompound.from_dict(obj.get("objSubnet")) if obj.get("objSubnet") is not None else None + _obj = cls.model_validate({ + "objSubnet": SubnetRequestCompound.from_dict(obj.get("objSubnet")) if obj.get("objSubnet") is not None else None }) return _obj diff --git a/eZmaxApi/models/subnet_edit_object_v1_response.py b/eZmaxApi/models/subnet_edit_object_v1_response.py index 6faf220c9..2c5111e21 100644 --- a/eZmaxApi/models/subnet_edit_object_v1_response.py +++ b/eZmaxApi/models/subnet_edit_object_v1_response.py @@ -19,43 +19,61 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class SubnetEditObjectV1Response(BaseModel): """ - Response for PUT /1/object/subnet/{pkiSubnetID} # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - __properties = ["objDebugPayload", "objDebug"] + Response for PUT /1/object/subnet/{pkiSubnetID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> SubnetEditObjectV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of SubnetEditObjectV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -65,17 +83,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> SubnetEditObjectV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of SubnetEditObjectV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return SubnetEditObjectV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = SubnetEditObjectV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None }) return _obj diff --git a/eZmaxApi/models/subnet_get_object_v2_response.py b/eZmaxApi/models/subnet_get_object_v2_response.py index 0f731b4c9..befb9a61d 100644 --- a/eZmaxApi/models/subnet_get_object_v2_response.py +++ b/eZmaxApi/models/subnet_get_object_v2_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.subnet_get_object_v2_response_m_payload import SubnetGetObjectV2ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class SubnetGetObjectV2Response(BaseModel): """ - Response for GET /2/object/subnet/{pkiSubnetID} # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: SubnetGetObjectV2ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /2/object/subnet/{pkiSubnetID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: SubnetGetObjectV2ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> SubnetGetObjectV2Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of SubnetGetObjectV2Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> SubnetGetObjectV2Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of SubnetGetObjectV2Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return SubnetGetObjectV2Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = SubnetGetObjectV2Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": SubnetGetObjectV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": SubnetGetObjectV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/subnet_get_object_v2_response_m_payload.py b/eZmaxApi/models/subnet_get_object_v2_response_m_payload.py index 802975d87..ab14bd50b 100644 --- a/eZmaxApi/models/subnet_get_object_v2_response_m_payload.py +++ b/eZmaxApi/models/subnet_get_object_v2_response_m_payload.py @@ -19,57 +19,75 @@ import json - -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.subnet_response_compound import SubnetResponseCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class SubnetGetObjectV2ResponseMPayload(BaseModel): """ - Payload for GET /2/object/subnet/{pkiSubnetID} # noqa: E501 - """ - obj_subnet: SubnetResponseCompound = Field(..., alias="objSubnet") - __properties = ["objSubnet"] + Payload for GET /2/object/subnet/{pkiSubnetID} + """ # noqa: E501 + obj_subnet: SubnetResponseCompound = Field(alias="objSubnet") + __properties: ClassVar[List[str]] = ["objSubnet"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> SubnetGetObjectV2ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of SubnetGetObjectV2ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_subnet if self.obj_subnet: _dict['objSubnet'] = self.obj_subnet.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> SubnetGetObjectV2ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of SubnetGetObjectV2ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return SubnetGetObjectV2ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = SubnetGetObjectV2ResponseMPayload.parse_obj({ - "obj_subnet": SubnetResponseCompound.from_dict(obj.get("objSubnet")) if obj.get("objSubnet") is not None else None + _obj = cls.model_validate({ + "objSubnet": SubnetResponseCompound.from_dict(obj.get("objSubnet")) if obj.get("objSubnet") is not None else None }) return _obj diff --git a/eZmaxApi/models/subnet_request.py b/eZmaxApi/models/subnet_request.py index a09303a5a..6b715ba5c 100644 --- a/eZmaxApi/models/subnet_request.py +++ b/eZmaxApi/models/subnet_request.py @@ -19,67 +19,86 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.multilingual_subnet_description import MultilingualSubnetDescription +try: + from typing import Self +except ImportError: + from typing_extensions import Self class SubnetRequest(BaseModel): """ - A Subnet Object # noqa: E501 - """ - pki_subnet_id: Optional[conint(strict=True, le=65535, ge=0)] = Field(None, alias="pkiSubnetID", description="The unique ID of the Subnet") - fki_user_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiUserID", description="The unique ID of the User") - fki_apikey_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiApikeyID", description="The unique ID of the Apikey") - obj_subnet_description: MultilingualSubnetDescription = Field(..., alias="objSubnetDescription") - i_subnet_network: conint(strict=True, le=4294967295, ge=0) = Field(..., alias="iSubnetNetwork", description="The network of the Subnet in integer form. For example 8.8.8.0 would be 134744064") - i_subnet_mask: conint(strict=True, le=4294967295, ge=0) = Field(..., alias="iSubnetMask", description="The mask of the Subnet in integer form. For example 255.255.255.0 would be 4294967040") - __properties = ["pkiSubnetID", "fkiUserID", "fkiApikeyID", "objSubnetDescription", "iSubnetNetwork", "iSubnetMask"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + A Subnet Object + """ # noqa: E501 + pki_subnet_id: Optional[Annotated[int, Field(le=65535, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Subnet", alias="pkiSubnetID") + fki_user_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the User", alias="fkiUserID") + fki_apikey_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Apikey", alias="fkiApikeyID") + obj_subnet_description: MultilingualSubnetDescription = Field(alias="objSubnetDescription") + i_subnet_network: Annotated[int, Field(le=4294967295, strict=True, ge=0)] = Field(description="The network of the Subnet in integer form. For example 8.8.8.0 would be 134744064", alias="iSubnetNetwork") + i_subnet_mask: Annotated[int, Field(le=4294967295, strict=True, ge=0)] = Field(description="The mask of the Subnet in integer form. For example 255.255.255.0 would be 4294967040", alias="iSubnetMask") + __properties: ClassVar[List[str]] = ["pkiSubnetID", "fkiUserID", "fkiApikeyID", "objSubnetDescription", "iSubnetNetwork", "iSubnetMask"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> SubnetRequest: + def from_json(cls, json_str: str) -> Self: """Create an instance of SubnetRequest from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_subnet_description if self.obj_subnet_description: _dict['objSubnetDescription'] = self.obj_subnet_description.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> SubnetRequest: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of SubnetRequest from a dict""" if obj is None: return None if not isinstance(obj, dict): - return SubnetRequest.parse_obj(obj) - - _obj = SubnetRequest.parse_obj({ - "pki_subnet_id": obj.get("pkiSubnetID"), - "fki_user_id": obj.get("fkiUserID"), - "fki_apikey_id": obj.get("fkiApikeyID"), - "obj_subnet_description": MultilingualSubnetDescription.from_dict(obj.get("objSubnetDescription")) if obj.get("objSubnetDescription") is not None else None, - "i_subnet_network": obj.get("iSubnetNetwork"), - "i_subnet_mask": obj.get("iSubnetMask") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiSubnetID": obj.get("pkiSubnetID"), + "fkiUserID": obj.get("fkiUserID"), + "fkiApikeyID": obj.get("fkiApikeyID"), + "objSubnetDescription": MultilingualSubnetDescription.from_dict(obj.get("objSubnetDescription")) if obj.get("objSubnetDescription") is not None else None, + "iSubnetNetwork": obj.get("iSubnetNetwork"), + "iSubnetMask": obj.get("iSubnetMask") }) return _obj diff --git a/eZmaxApi/models/subnet_request_compound.py b/eZmaxApi/models/subnet_request_compound.py index 29f863c6d..85c10a6e1 100644 --- a/eZmaxApi/models/subnet_request_compound.py +++ b/eZmaxApi/models/subnet_request_compound.py @@ -19,67 +19,86 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.multilingual_subnet_description import MultilingualSubnetDescription +try: + from typing import Self +except ImportError: + from typing_extensions import Self class SubnetRequestCompound(BaseModel): """ - A Subnet Object and children # noqa: E501 - """ - pki_subnet_id: Optional[conint(strict=True, le=65535, ge=0)] = Field(None, alias="pkiSubnetID", description="The unique ID of the Subnet") - fki_user_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiUserID", description="The unique ID of the User") - fki_apikey_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiApikeyID", description="The unique ID of the Apikey") - obj_subnet_description: MultilingualSubnetDescription = Field(..., alias="objSubnetDescription") - i_subnet_network: conint(strict=True, le=4294967295, ge=0) = Field(..., alias="iSubnetNetwork", description="The network of the Subnet in integer form. For example 8.8.8.0 would be 134744064") - i_subnet_mask: conint(strict=True, le=4294967295, ge=0) = Field(..., alias="iSubnetMask", description="The mask of the Subnet in integer form. For example 255.255.255.0 would be 4294967040") - __properties = ["pkiSubnetID", "fkiUserID", "fkiApikeyID", "objSubnetDescription", "iSubnetNetwork", "iSubnetMask"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + A Subnet Object and children + """ # noqa: E501 + pki_subnet_id: Optional[Annotated[int, Field(le=65535, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Subnet", alias="pkiSubnetID") + fki_user_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the User", alias="fkiUserID") + fki_apikey_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Apikey", alias="fkiApikeyID") + obj_subnet_description: MultilingualSubnetDescription = Field(alias="objSubnetDescription") + i_subnet_network: Annotated[int, Field(le=4294967295, strict=True, ge=0)] = Field(description="The network of the Subnet in integer form. For example 8.8.8.0 would be 134744064", alias="iSubnetNetwork") + i_subnet_mask: Annotated[int, Field(le=4294967295, strict=True, ge=0)] = Field(description="The mask of the Subnet in integer form. For example 255.255.255.0 would be 4294967040", alias="iSubnetMask") + __properties: ClassVar[List[str]] = ["pkiSubnetID", "fkiUserID", "fkiApikeyID", "objSubnetDescription", "iSubnetNetwork", "iSubnetMask"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> SubnetRequestCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of SubnetRequestCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_subnet_description if self.obj_subnet_description: _dict['objSubnetDescription'] = self.obj_subnet_description.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> SubnetRequestCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of SubnetRequestCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return SubnetRequestCompound.parse_obj(obj) - - _obj = SubnetRequestCompound.parse_obj({ - "pki_subnet_id": obj.get("pkiSubnetID"), - "fki_user_id": obj.get("fkiUserID"), - "fki_apikey_id": obj.get("fkiApikeyID"), - "obj_subnet_description": MultilingualSubnetDescription.from_dict(obj.get("objSubnetDescription")) if obj.get("objSubnetDescription") is not None else None, - "i_subnet_network": obj.get("iSubnetNetwork"), - "i_subnet_mask": obj.get("iSubnetMask") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiSubnetID": obj.get("pkiSubnetID"), + "fkiUserID": obj.get("fkiUserID"), + "fkiApikeyID": obj.get("fkiApikeyID"), + "objSubnetDescription": MultilingualSubnetDescription.from_dict(obj.get("objSubnetDescription")) if obj.get("objSubnetDescription") is not None else None, + "iSubnetNetwork": obj.get("iSubnetNetwork"), + "iSubnetMask": obj.get("iSubnetMask") }) return _obj diff --git a/eZmaxApi/models/subnet_response.py b/eZmaxApi/models/subnet_response.py index 379ee8d5d..1d5cb2c94 100644 --- a/eZmaxApi/models/subnet_response.py +++ b/eZmaxApi/models/subnet_response.py @@ -19,67 +19,86 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.multilingual_subnet_description import MultilingualSubnetDescription +try: + from typing import Self +except ImportError: + from typing_extensions import Self class SubnetResponse(BaseModel): """ - A Subnet Object # noqa: E501 - """ - pki_subnet_id: conint(strict=True, le=65535, ge=0) = Field(..., alias="pkiSubnetID", description="The unique ID of the Subnet") - fki_user_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiUserID", description="The unique ID of the User") - fki_apikey_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiApikeyID", description="The unique ID of the Apikey") - obj_subnet_description: MultilingualSubnetDescription = Field(..., alias="objSubnetDescription") - i_subnet_network: conint(strict=True, le=4294967295, ge=0) = Field(..., alias="iSubnetNetwork", description="The network of the Subnet in integer form. For example 8.8.8.0 would be 134744064") - i_subnet_mask: conint(strict=True, le=4294967295, ge=0) = Field(..., alias="iSubnetMask", description="The mask of the Subnet in integer form. For example 255.255.255.0 would be 4294967040") - __properties = ["pkiSubnetID", "fkiUserID", "fkiApikeyID", "objSubnetDescription", "iSubnetNetwork", "iSubnetMask"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + A Subnet Object + """ # noqa: E501 + pki_subnet_id: Annotated[int, Field(le=65535, strict=True, ge=0)] = Field(description="The unique ID of the Subnet", alias="pkiSubnetID") + fki_user_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the User", alias="fkiUserID") + fki_apikey_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Apikey", alias="fkiApikeyID") + obj_subnet_description: MultilingualSubnetDescription = Field(alias="objSubnetDescription") + i_subnet_network: Annotated[int, Field(le=4294967295, strict=True, ge=0)] = Field(description="The network of the Subnet in integer form. For example 8.8.8.0 would be 134744064", alias="iSubnetNetwork") + i_subnet_mask: Annotated[int, Field(le=4294967295, strict=True, ge=0)] = Field(description="The mask of the Subnet in integer form. For example 255.255.255.0 would be 4294967040", alias="iSubnetMask") + __properties: ClassVar[List[str]] = ["pkiSubnetID", "fkiUserID", "fkiApikeyID", "objSubnetDescription", "iSubnetNetwork", "iSubnetMask"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> SubnetResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of SubnetResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_subnet_description if self.obj_subnet_description: _dict['objSubnetDescription'] = self.obj_subnet_description.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> SubnetResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of SubnetResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return SubnetResponse.parse_obj(obj) - - _obj = SubnetResponse.parse_obj({ - "pki_subnet_id": obj.get("pkiSubnetID"), - "fki_user_id": obj.get("fkiUserID"), - "fki_apikey_id": obj.get("fkiApikeyID"), - "obj_subnet_description": MultilingualSubnetDescription.from_dict(obj.get("objSubnetDescription")) if obj.get("objSubnetDescription") is not None else None, - "i_subnet_network": obj.get("iSubnetNetwork"), - "i_subnet_mask": obj.get("iSubnetMask") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiSubnetID": obj.get("pkiSubnetID"), + "fkiUserID": obj.get("fkiUserID"), + "fkiApikeyID": obj.get("fkiApikeyID"), + "objSubnetDescription": MultilingualSubnetDescription.from_dict(obj.get("objSubnetDescription")) if obj.get("objSubnetDescription") is not None else None, + "iSubnetNetwork": obj.get("iSubnetNetwork"), + "iSubnetMask": obj.get("iSubnetMask") }) return _obj diff --git a/eZmaxApi/models/subnet_response_compound.py b/eZmaxApi/models/subnet_response_compound.py index ac6483100..eec5abd5c 100644 --- a/eZmaxApi/models/subnet_response_compound.py +++ b/eZmaxApi/models/subnet_response_compound.py @@ -19,67 +19,86 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.multilingual_subnet_description import MultilingualSubnetDescription +try: + from typing import Self +except ImportError: + from typing_extensions import Self class SubnetResponseCompound(BaseModel): """ - A Subnet Object # noqa: E501 - """ - pki_subnet_id: conint(strict=True, le=65535, ge=0) = Field(..., alias="pkiSubnetID", description="The unique ID of the Subnet") - fki_user_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiUserID", description="The unique ID of the User") - fki_apikey_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiApikeyID", description="The unique ID of the Apikey") - obj_subnet_description: MultilingualSubnetDescription = Field(..., alias="objSubnetDescription") - i_subnet_network: conint(strict=True, le=4294967295, ge=0) = Field(..., alias="iSubnetNetwork", description="The network of the Subnet in integer form. For example 8.8.8.0 would be 134744064") - i_subnet_mask: conint(strict=True, le=4294967295, ge=0) = Field(..., alias="iSubnetMask", description="The mask of the Subnet in integer form. For example 255.255.255.0 would be 4294967040") - __properties = ["pkiSubnetID", "fkiUserID", "fkiApikeyID", "objSubnetDescription", "iSubnetNetwork", "iSubnetMask"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + A Subnet Object + """ # noqa: E501 + pki_subnet_id: Annotated[int, Field(le=65535, strict=True, ge=0)] = Field(description="The unique ID of the Subnet", alias="pkiSubnetID") + fki_user_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the User", alias="fkiUserID") + fki_apikey_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Apikey", alias="fkiApikeyID") + obj_subnet_description: MultilingualSubnetDescription = Field(alias="objSubnetDescription") + i_subnet_network: Annotated[int, Field(le=4294967295, strict=True, ge=0)] = Field(description="The network of the Subnet in integer form. For example 8.8.8.0 would be 134744064", alias="iSubnetNetwork") + i_subnet_mask: Annotated[int, Field(le=4294967295, strict=True, ge=0)] = Field(description="The mask of the Subnet in integer form. For example 255.255.255.0 would be 4294967040", alias="iSubnetMask") + __properties: ClassVar[List[str]] = ["pkiSubnetID", "fkiUserID", "fkiApikeyID", "objSubnetDescription", "iSubnetNetwork", "iSubnetMask"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> SubnetResponseCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of SubnetResponseCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_subnet_description if self.obj_subnet_description: _dict['objSubnetDescription'] = self.obj_subnet_description.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> SubnetResponseCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of SubnetResponseCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return SubnetResponseCompound.parse_obj(obj) - - _obj = SubnetResponseCompound.parse_obj({ - "pki_subnet_id": obj.get("pkiSubnetID"), - "fki_user_id": obj.get("fkiUserID"), - "fki_apikey_id": obj.get("fkiApikeyID"), - "obj_subnet_description": MultilingualSubnetDescription.from_dict(obj.get("objSubnetDescription")) if obj.get("objSubnetDescription") is not None else None, - "i_subnet_network": obj.get("iSubnetNetwork"), - "i_subnet_mask": obj.get("iSubnetMask") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiSubnetID": obj.get("pkiSubnetID"), + "fkiUserID": obj.get("fkiUserID"), + "fkiApikeyID": obj.get("fkiApikeyID"), + "objSubnetDescription": MultilingualSubnetDescription.from_dict(obj.get("objSubnetDescription")) if obj.get("objSubnetDescription") is not None else None, + "iSubnetNetwork": obj.get("iSubnetNetwork"), + "iSubnetMask": obj.get("iSubnetMask") }) return _obj diff --git a/eZmaxApi/models/systemconfiguration_edit_object_v1_request.py b/eZmaxApi/models/systemconfiguration_edit_object_v1_request.py index 4945839c6..3dea43786 100644 --- a/eZmaxApi/models/systemconfiguration_edit_object_v1_request.py +++ b/eZmaxApi/models/systemconfiguration_edit_object_v1_request.py @@ -19,57 +19,75 @@ import json - -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.systemconfiguration_request_compound import SystemconfigurationRequestCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class SystemconfigurationEditObjectV1Request(BaseModel): """ - Request for PUT /1/object/systemconfiguration/{pkiSystemconfigurationID} # noqa: E501 - """ - obj_systemconfiguration: SystemconfigurationRequestCompound = Field(..., alias="objSystemconfiguration") - __properties = ["objSystemconfiguration"] + Request for PUT /1/object/systemconfiguration/{pkiSystemconfigurationID} + """ # noqa: E501 + obj_systemconfiguration: SystemconfigurationRequestCompound = Field(alias="objSystemconfiguration") + __properties: ClassVar[List[str]] = ["objSystemconfiguration"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> SystemconfigurationEditObjectV1Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of SystemconfigurationEditObjectV1Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_systemconfiguration if self.obj_systemconfiguration: _dict['objSystemconfiguration'] = self.obj_systemconfiguration.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> SystemconfigurationEditObjectV1Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of SystemconfigurationEditObjectV1Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return SystemconfigurationEditObjectV1Request.parse_obj(obj) + return cls.model_validate(obj) - _obj = SystemconfigurationEditObjectV1Request.parse_obj({ - "obj_systemconfiguration": SystemconfigurationRequestCompound.from_dict(obj.get("objSystemconfiguration")) if obj.get("objSystemconfiguration") is not None else None + _obj = cls.model_validate({ + "objSystemconfiguration": SystemconfigurationRequestCompound.from_dict(obj.get("objSystemconfiguration")) if obj.get("objSystemconfiguration") is not None else None }) return _obj diff --git a/eZmaxApi/models/systemconfiguration_edit_object_v1_response.py b/eZmaxApi/models/systemconfiguration_edit_object_v1_response.py index 901e5e8dc..b3cd0bc8f 100644 --- a/eZmaxApi/models/systemconfiguration_edit_object_v1_response.py +++ b/eZmaxApi/models/systemconfiguration_edit_object_v1_response.py @@ -19,43 +19,61 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class SystemconfigurationEditObjectV1Response(BaseModel): """ - Response for PUT /1/object/systemconfiguration/{pkiSystemconfigurationID} # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - __properties = ["objDebugPayload", "objDebug"] + Response for PUT /1/object/systemconfiguration/{pkiSystemconfigurationID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> SystemconfigurationEditObjectV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of SystemconfigurationEditObjectV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -65,17 +83,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> SystemconfigurationEditObjectV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of SystemconfigurationEditObjectV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return SystemconfigurationEditObjectV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = SystemconfigurationEditObjectV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None }) return _obj diff --git a/eZmaxApi/models/systemconfiguration_get_object_v2_response.py b/eZmaxApi/models/systemconfiguration_get_object_v2_response.py index 24bc01afd..fbf1d58cd 100644 --- a/eZmaxApi/models/systemconfiguration_get_object_v2_response.py +++ b/eZmaxApi/models/systemconfiguration_get_object_v2_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.systemconfiguration_get_object_v2_response_m_payload import SystemconfigurationGetObjectV2ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class SystemconfigurationGetObjectV2Response(BaseModel): """ - Response for GET /2/object/systemconfiguration/{pkiSystemconfigurationID} # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: SystemconfigurationGetObjectV2ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /2/object/systemconfiguration/{pkiSystemconfigurationID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: SystemconfigurationGetObjectV2ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> SystemconfigurationGetObjectV2Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of SystemconfigurationGetObjectV2Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> SystemconfigurationGetObjectV2Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of SystemconfigurationGetObjectV2Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return SystemconfigurationGetObjectV2Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = SystemconfigurationGetObjectV2Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": SystemconfigurationGetObjectV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": SystemconfigurationGetObjectV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/systemconfiguration_get_object_v2_response_m_payload.py b/eZmaxApi/models/systemconfiguration_get_object_v2_response_m_payload.py index e2f1e3d21..419c74bfd 100644 --- a/eZmaxApi/models/systemconfiguration_get_object_v2_response_m_payload.py +++ b/eZmaxApi/models/systemconfiguration_get_object_v2_response_m_payload.py @@ -19,57 +19,75 @@ import json - -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.systemconfiguration_response_compound import SystemconfigurationResponseCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class SystemconfigurationGetObjectV2ResponseMPayload(BaseModel): """ - Payload for GET /2/object/systemconfiguration/{pkiSystemconfigurationID} # noqa: E501 - """ - obj_systemconfiguration: SystemconfigurationResponseCompound = Field(..., alias="objSystemconfiguration") - __properties = ["objSystemconfiguration"] + Payload for GET /2/object/systemconfiguration/{pkiSystemconfigurationID} + """ # noqa: E501 + obj_systemconfiguration: SystemconfigurationResponseCompound = Field(alias="objSystemconfiguration") + __properties: ClassVar[List[str]] = ["objSystemconfiguration"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> SystemconfigurationGetObjectV2ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of SystemconfigurationGetObjectV2ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_systemconfiguration if self.obj_systemconfiguration: _dict['objSystemconfiguration'] = self.obj_systemconfiguration.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> SystemconfigurationGetObjectV2ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of SystemconfigurationGetObjectV2ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return SystemconfigurationGetObjectV2ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = SystemconfigurationGetObjectV2ResponseMPayload.parse_obj({ - "obj_systemconfiguration": SystemconfigurationResponseCompound.from_dict(obj.get("objSystemconfiguration")) if obj.get("objSystemconfiguration") is not None else None + _obj = cls.model_validate({ + "objSystemconfiguration": SystemconfigurationResponseCompound.from_dict(obj.get("objSystemconfiguration")) if obj.get("objSystemconfiguration") is not None else None }) return _obj diff --git a/eZmaxApi/models/systemconfiguration_request.py b/eZmaxApi/models/systemconfiguration_request.py index cdf00fda2..c4d9de2fd 100644 --- a/eZmaxApi/models/systemconfiguration_request.py +++ b/eZmaxApi/models/systemconfiguration_request.py @@ -19,29 +19,35 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictBool, conint, constr, validator +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, field_validator +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.field_e_systemconfiguration_ezsign import FieldESystemconfigurationEzsign from eZmaxApi.models.field_e_systemconfiguration_language1 import FieldESystemconfigurationLanguage1 from eZmaxApi.models.field_e_systemconfiguration_language2 import FieldESystemconfigurationLanguage2 from eZmaxApi.models.field_e_systemconfiguration_newexternaluseraction import FieldESystemconfigurationNewexternaluseraction +try: + from typing import Self +except ImportError: + from typing_extensions import Self class SystemconfigurationRequest(BaseModel): """ - A Systemconfiguration Object # noqa: E501 - """ - pki_systemconfiguration_id: Optional[conint(strict=True, le=1, ge=1)] = Field(None, alias="pkiSystemconfigurationID", description="The unique ID of the Systemconfiguration") - e_systemconfiguration_newexternaluseraction: FieldESystemconfigurationNewexternaluseraction = Field(..., alias="eSystemconfigurationNewexternaluseraction") - e_systemconfiguration_language1: FieldESystemconfigurationLanguage1 = Field(..., alias="eSystemconfigurationLanguage1") - e_systemconfiguration_language2: FieldESystemconfigurationLanguage2 = Field(..., alias="eSystemconfigurationLanguage2") - e_systemconfiguration_ezsign: Optional[FieldESystemconfigurationEzsign] = Field(None, alias="eSystemconfigurationEzsign") - b_systemconfiguration_ezsignpersonnal: StrictBool = Field(..., alias="bSystemconfigurationEzsignpersonnal", description="Whether if we allow the creation of personal files in eZsign") - b_systemconfiguration_sspr: StrictBool = Field(..., alias="bSystemconfigurationSspr", description="Whether if we allow SSPR") - dt_systemconfiguration_readonlyexpirationstart: Optional[constr(strict=True)] = Field(None, alias="dtSystemconfigurationReadonlyexpirationstart", description="The start date where the system will be in read only") - dt_systemconfiguration_readonlyexpirationend: Optional[constr(strict=True)] = Field(None, alias="dtSystemconfigurationReadonlyexpirationend", description="The end date where the system will be in read only") - __properties = ["pkiSystemconfigurationID", "eSystemconfigurationNewexternaluseraction", "eSystemconfigurationLanguage1", "eSystemconfigurationLanguage2", "eSystemconfigurationEzsign", "bSystemconfigurationEzsignpersonnal", "bSystemconfigurationSspr", "dtSystemconfigurationReadonlyexpirationstart", "dtSystemconfigurationReadonlyexpirationend"] - - @validator('dt_systemconfiguration_readonlyexpirationstart') + A Systemconfiguration Object + """ # noqa: E501 + pki_systemconfiguration_id: Optional[Annotated[int, Field(le=1, strict=True, ge=1)]] = Field(default=None, description="The unique ID of the Systemconfiguration", alias="pkiSystemconfigurationID") + e_systemconfiguration_newexternaluseraction: FieldESystemconfigurationNewexternaluseraction = Field(alias="eSystemconfigurationNewexternaluseraction") + e_systemconfiguration_language1: FieldESystemconfigurationLanguage1 = Field(alias="eSystemconfigurationLanguage1") + e_systemconfiguration_language2: FieldESystemconfigurationLanguage2 = Field(alias="eSystemconfigurationLanguage2") + e_systemconfiguration_ezsign: Optional[FieldESystemconfigurationEzsign] = Field(default=None, alias="eSystemconfigurationEzsign") + b_systemconfiguration_ezsignpersonnal: StrictBool = Field(description="Whether if we allow the creation of personal files in eZsign", alias="bSystemconfigurationEzsignpersonnal") + b_systemconfiguration_sspr: StrictBool = Field(description="Whether if we allow SSPR", alias="bSystemconfigurationSspr") + dt_systemconfiguration_readonlyexpirationstart: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="The start date where the system will be in read only", alias="dtSystemconfigurationReadonlyexpirationstart") + dt_systemconfiguration_readonlyexpirationend: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="The end date where the system will be in read only", alias="dtSystemconfigurationReadonlyexpirationend") + __properties: ClassVar[List[str]] = ["pkiSystemconfigurationID", "eSystemconfigurationNewexternaluseraction", "eSystemconfigurationLanguage1", "eSystemconfigurationLanguage2", "eSystemconfigurationEzsign", "bSystemconfigurationEzsignpersonnal", "bSystemconfigurationSspr", "dtSystemconfigurationReadonlyexpirationstart", "dtSystemconfigurationReadonlyexpirationend"] + + @field_validator('dt_systemconfiguration_readonlyexpirationstart') def dt_systemconfiguration_readonlyexpirationstart_validate_regular_expression(cls, value): """Validates the regular expression""" if value is None: @@ -51,7 +57,7 @@ def dt_systemconfiguration_readonlyexpirationstart_validate_regular_expression(c raise ValueError(r"must validate the regular expression /^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$/") return value - @validator('dt_systemconfiguration_readonlyexpirationend') + @field_validator('dt_systemconfiguration_readonlyexpirationend') def dt_systemconfiguration_readonlyexpirationend_validate_regular_expression(cls, value): """Validates the regular expression""" if value is None: @@ -61,51 +67,64 @@ def dt_systemconfiguration_readonlyexpirationend_validate_regular_expression(cls raise ValueError(r"must validate the regular expression /^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> SystemconfigurationRequest: + def from_json(cls, json_str: str) -> Self: """Create an instance of SystemconfigurationRequest from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> SystemconfigurationRequest: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of SystemconfigurationRequest from a dict""" if obj is None: return None if not isinstance(obj, dict): - return SystemconfigurationRequest.parse_obj(obj) - - _obj = SystemconfigurationRequest.parse_obj({ - "pki_systemconfiguration_id": obj.get("pkiSystemconfigurationID"), - "e_systemconfiguration_newexternaluseraction": obj.get("eSystemconfigurationNewexternaluseraction"), - "e_systemconfiguration_language1": obj.get("eSystemconfigurationLanguage1"), - "e_systemconfiguration_language2": obj.get("eSystemconfigurationLanguage2"), - "e_systemconfiguration_ezsign": obj.get("eSystemconfigurationEzsign"), - "b_systemconfiguration_ezsignpersonnal": obj.get("bSystemconfigurationEzsignpersonnal"), - "b_systemconfiguration_sspr": obj.get("bSystemconfigurationSspr"), - "dt_systemconfiguration_readonlyexpirationstart": obj.get("dtSystemconfigurationReadonlyexpirationstart"), - "dt_systemconfiguration_readonlyexpirationend": obj.get("dtSystemconfigurationReadonlyexpirationend") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiSystemconfigurationID": obj.get("pkiSystemconfigurationID"), + "eSystemconfigurationNewexternaluseraction": obj.get("eSystemconfigurationNewexternaluseraction"), + "eSystemconfigurationLanguage1": obj.get("eSystemconfigurationLanguage1"), + "eSystemconfigurationLanguage2": obj.get("eSystemconfigurationLanguage2"), + "eSystemconfigurationEzsign": obj.get("eSystemconfigurationEzsign"), + "bSystemconfigurationEzsignpersonnal": obj.get("bSystemconfigurationEzsignpersonnal"), + "bSystemconfigurationSspr": obj.get("bSystemconfigurationSspr"), + "dtSystemconfigurationReadonlyexpirationstart": obj.get("dtSystemconfigurationReadonlyexpirationstart"), + "dtSystemconfigurationReadonlyexpirationend": obj.get("dtSystemconfigurationReadonlyexpirationend") }) return _obj diff --git a/eZmaxApi/models/systemconfiguration_request_compound.py b/eZmaxApi/models/systemconfiguration_request_compound.py index da0666199..2d2eb2279 100644 --- a/eZmaxApi/models/systemconfiguration_request_compound.py +++ b/eZmaxApi/models/systemconfiguration_request_compound.py @@ -19,29 +19,35 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictBool, conint, constr, validator +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, field_validator +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.field_e_systemconfiguration_ezsign import FieldESystemconfigurationEzsign from eZmaxApi.models.field_e_systemconfiguration_language1 import FieldESystemconfigurationLanguage1 from eZmaxApi.models.field_e_systemconfiguration_language2 import FieldESystemconfigurationLanguage2 from eZmaxApi.models.field_e_systemconfiguration_newexternaluseraction import FieldESystemconfigurationNewexternaluseraction +try: + from typing import Self +except ImportError: + from typing_extensions import Self class SystemconfigurationRequestCompound(BaseModel): """ - A Systemconfiguration Object and children # noqa: E501 - """ - pki_systemconfiguration_id: Optional[conint(strict=True, le=1, ge=1)] = Field(None, alias="pkiSystemconfigurationID", description="The unique ID of the Systemconfiguration") - e_systemconfiguration_newexternaluseraction: FieldESystemconfigurationNewexternaluseraction = Field(..., alias="eSystemconfigurationNewexternaluseraction") - e_systemconfiguration_language1: FieldESystemconfigurationLanguage1 = Field(..., alias="eSystemconfigurationLanguage1") - e_systemconfiguration_language2: FieldESystemconfigurationLanguage2 = Field(..., alias="eSystemconfigurationLanguage2") - e_systemconfiguration_ezsign: Optional[FieldESystemconfigurationEzsign] = Field(None, alias="eSystemconfigurationEzsign") - b_systemconfiguration_ezsignpersonnal: StrictBool = Field(..., alias="bSystemconfigurationEzsignpersonnal", description="Whether if we allow the creation of personal files in eZsign") - b_systemconfiguration_sspr: StrictBool = Field(..., alias="bSystemconfigurationSspr", description="Whether if we allow SSPR") - dt_systemconfiguration_readonlyexpirationstart: Optional[constr(strict=True)] = Field(None, alias="dtSystemconfigurationReadonlyexpirationstart", description="The start date where the system will be in read only") - dt_systemconfiguration_readonlyexpirationend: Optional[constr(strict=True)] = Field(None, alias="dtSystemconfigurationReadonlyexpirationend", description="The end date where the system will be in read only") - __properties = ["pkiSystemconfigurationID", "eSystemconfigurationNewexternaluseraction", "eSystemconfigurationLanguage1", "eSystemconfigurationLanguage2", "eSystemconfigurationEzsign", "bSystemconfigurationEzsignpersonnal", "bSystemconfigurationSspr", "dtSystemconfigurationReadonlyexpirationstart", "dtSystemconfigurationReadonlyexpirationend"] - - @validator('dt_systemconfiguration_readonlyexpirationstart') + A Systemconfiguration Object and children + """ # noqa: E501 + pki_systemconfiguration_id: Optional[Annotated[int, Field(le=1, strict=True, ge=1)]] = Field(default=None, description="The unique ID of the Systemconfiguration", alias="pkiSystemconfigurationID") + e_systemconfiguration_newexternaluseraction: FieldESystemconfigurationNewexternaluseraction = Field(alias="eSystemconfigurationNewexternaluseraction") + e_systemconfiguration_language1: FieldESystemconfigurationLanguage1 = Field(alias="eSystemconfigurationLanguage1") + e_systemconfiguration_language2: FieldESystemconfigurationLanguage2 = Field(alias="eSystemconfigurationLanguage2") + e_systemconfiguration_ezsign: Optional[FieldESystemconfigurationEzsign] = Field(default=None, alias="eSystemconfigurationEzsign") + b_systemconfiguration_ezsignpersonnal: StrictBool = Field(description="Whether if we allow the creation of personal files in eZsign", alias="bSystemconfigurationEzsignpersonnal") + b_systemconfiguration_sspr: StrictBool = Field(description="Whether if we allow SSPR", alias="bSystemconfigurationSspr") + dt_systemconfiguration_readonlyexpirationstart: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="The start date where the system will be in read only", alias="dtSystemconfigurationReadonlyexpirationstart") + dt_systemconfiguration_readonlyexpirationend: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="The end date where the system will be in read only", alias="dtSystemconfigurationReadonlyexpirationend") + __properties: ClassVar[List[str]] = ["pkiSystemconfigurationID", "eSystemconfigurationNewexternaluseraction", "eSystemconfigurationLanguage1", "eSystemconfigurationLanguage2", "eSystemconfigurationEzsign", "bSystemconfigurationEzsignpersonnal", "bSystemconfigurationSspr", "dtSystemconfigurationReadonlyexpirationstart", "dtSystemconfigurationReadonlyexpirationend"] + + @field_validator('dt_systemconfiguration_readonlyexpirationstart') def dt_systemconfiguration_readonlyexpirationstart_validate_regular_expression(cls, value): """Validates the regular expression""" if value is None: @@ -51,7 +57,7 @@ def dt_systemconfiguration_readonlyexpirationstart_validate_regular_expression(c raise ValueError(r"must validate the regular expression /^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$/") return value - @validator('dt_systemconfiguration_readonlyexpirationend') + @field_validator('dt_systemconfiguration_readonlyexpirationend') def dt_systemconfiguration_readonlyexpirationend_validate_regular_expression(cls, value): """Validates the regular expression""" if value is None: @@ -61,51 +67,64 @@ def dt_systemconfiguration_readonlyexpirationend_validate_regular_expression(cls raise ValueError(r"must validate the regular expression /^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> SystemconfigurationRequestCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of SystemconfigurationRequestCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> SystemconfigurationRequestCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of SystemconfigurationRequestCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return SystemconfigurationRequestCompound.parse_obj(obj) - - _obj = SystemconfigurationRequestCompound.parse_obj({ - "pki_systemconfiguration_id": obj.get("pkiSystemconfigurationID"), - "e_systemconfiguration_newexternaluseraction": obj.get("eSystemconfigurationNewexternaluseraction"), - "e_systemconfiguration_language1": obj.get("eSystemconfigurationLanguage1"), - "e_systemconfiguration_language2": obj.get("eSystemconfigurationLanguage2"), - "e_systemconfiguration_ezsign": obj.get("eSystemconfigurationEzsign"), - "b_systemconfiguration_ezsignpersonnal": obj.get("bSystemconfigurationEzsignpersonnal"), - "b_systemconfiguration_sspr": obj.get("bSystemconfigurationSspr"), - "dt_systemconfiguration_readonlyexpirationstart": obj.get("dtSystemconfigurationReadonlyexpirationstart"), - "dt_systemconfiguration_readonlyexpirationend": obj.get("dtSystemconfigurationReadonlyexpirationend") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiSystemconfigurationID": obj.get("pkiSystemconfigurationID"), + "eSystemconfigurationNewexternaluseraction": obj.get("eSystemconfigurationNewexternaluseraction"), + "eSystemconfigurationLanguage1": obj.get("eSystemconfigurationLanguage1"), + "eSystemconfigurationLanguage2": obj.get("eSystemconfigurationLanguage2"), + "eSystemconfigurationEzsign": obj.get("eSystemconfigurationEzsign"), + "bSystemconfigurationEzsignpersonnal": obj.get("bSystemconfigurationEzsignpersonnal"), + "bSystemconfigurationSspr": obj.get("bSystemconfigurationSspr"), + "dtSystemconfigurationReadonlyexpirationstart": obj.get("dtSystemconfigurationReadonlyexpirationstart"), + "dtSystemconfigurationReadonlyexpirationend": obj.get("dtSystemconfigurationReadonlyexpirationend") }) return _obj diff --git a/eZmaxApi/models/systemconfiguration_response.py b/eZmaxApi/models/systemconfiguration_response.py index f94c30b3d..5a8c7f11a 100644 --- a/eZmaxApi/models/systemconfiguration_response.py +++ b/eZmaxApi/models/systemconfiguration_response.py @@ -19,31 +19,37 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint, constr, validator +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, StrictStr, field_validator +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.field_e_systemconfiguration_ezsign import FieldESystemconfigurationEzsign from eZmaxApi.models.field_e_systemconfiguration_language1 import FieldESystemconfigurationLanguage1 from eZmaxApi.models.field_e_systemconfiguration_language2 import FieldESystemconfigurationLanguage2 from eZmaxApi.models.field_e_systemconfiguration_newexternaluseraction import FieldESystemconfigurationNewexternaluseraction +try: + from typing import Self +except ImportError: + from typing_extensions import Self class SystemconfigurationResponse(BaseModel): """ - A Systemconfiguration Object # noqa: E501 - """ - pki_systemconfiguration_id: conint(strict=True, le=1, ge=1) = Field(..., alias="pkiSystemconfigurationID", description="The unique ID of the Systemconfiguration") - fki_systemconfigurationtype_id: conint(strict=True, ge=1) = Field(..., alias="fkiSystemconfigurationtypeID", description="The unique ID of the Systemconfigurationtype") - s_systemconfigurationtype_description_x: StrictStr = Field(..., alias="sSystemconfigurationtypeDescriptionX", description="The description of the Systemconfigurationtype in the language of the requester") - e_systemconfiguration_newexternaluseraction: FieldESystemconfigurationNewexternaluseraction = Field(..., alias="eSystemconfigurationNewexternaluseraction") - e_systemconfiguration_language1: FieldESystemconfigurationLanguage1 = Field(..., alias="eSystemconfigurationLanguage1") - e_systemconfiguration_language2: FieldESystemconfigurationLanguage2 = Field(..., alias="eSystemconfigurationLanguage2") - e_systemconfiguration_ezsign: FieldESystemconfigurationEzsign = Field(..., alias="eSystemconfigurationEzsign") - b_systemconfiguration_ezsignpersonnal: StrictBool = Field(..., alias="bSystemconfigurationEzsignpersonnal", description="Whether if we allow the creation of personal files in eZsign") - b_systemconfiguration_sspr: StrictBool = Field(..., alias="bSystemconfigurationSspr", description="Whether if we allow SSPR") - dt_systemconfiguration_readonlyexpirationstart: Optional[constr(strict=True)] = Field(None, alias="dtSystemconfigurationReadonlyexpirationstart", description="The start date where the system will be in read only") - dt_systemconfiguration_readonlyexpirationend: Optional[constr(strict=True)] = Field(None, alias="dtSystemconfigurationReadonlyexpirationend", description="The end date where the system will be in read only") - __properties = ["pkiSystemconfigurationID", "fkiSystemconfigurationtypeID", "sSystemconfigurationtypeDescriptionX", "eSystemconfigurationNewexternaluseraction", "eSystemconfigurationLanguage1", "eSystemconfigurationLanguage2", "eSystemconfigurationEzsign", "bSystemconfigurationEzsignpersonnal", "bSystemconfigurationSspr", "dtSystemconfigurationReadonlyexpirationstart", "dtSystemconfigurationReadonlyexpirationend"] - - @validator('dt_systemconfiguration_readonlyexpirationstart') + A Systemconfiguration Object + """ # noqa: E501 + pki_systemconfiguration_id: Annotated[int, Field(le=1, strict=True, ge=1)] = Field(description="The unique ID of the Systemconfiguration", alias="pkiSystemconfigurationID") + fki_systemconfigurationtype_id: Annotated[int, Field(strict=True, ge=1)] = Field(description="The unique ID of the Systemconfigurationtype", alias="fkiSystemconfigurationtypeID") + s_systemconfigurationtype_description_x: StrictStr = Field(description="The description of the Systemconfigurationtype in the language of the requester", alias="sSystemconfigurationtypeDescriptionX") + e_systemconfiguration_newexternaluseraction: FieldESystemconfigurationNewexternaluseraction = Field(alias="eSystemconfigurationNewexternaluseraction") + e_systemconfiguration_language1: FieldESystemconfigurationLanguage1 = Field(alias="eSystemconfigurationLanguage1") + e_systemconfiguration_language2: FieldESystemconfigurationLanguage2 = Field(alias="eSystemconfigurationLanguage2") + e_systemconfiguration_ezsign: FieldESystemconfigurationEzsign = Field(alias="eSystemconfigurationEzsign") + b_systemconfiguration_ezsignpersonnal: StrictBool = Field(description="Whether if we allow the creation of personal files in eZsign", alias="bSystemconfigurationEzsignpersonnal") + b_systemconfiguration_sspr: StrictBool = Field(description="Whether if we allow SSPR", alias="bSystemconfigurationSspr") + dt_systemconfiguration_readonlyexpirationstart: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="The start date where the system will be in read only", alias="dtSystemconfigurationReadonlyexpirationstart") + dt_systemconfiguration_readonlyexpirationend: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="The end date where the system will be in read only", alias="dtSystemconfigurationReadonlyexpirationend") + __properties: ClassVar[List[str]] = ["pkiSystemconfigurationID", "fkiSystemconfigurationtypeID", "sSystemconfigurationtypeDescriptionX", "eSystemconfigurationNewexternaluseraction", "eSystemconfigurationLanguage1", "eSystemconfigurationLanguage2", "eSystemconfigurationEzsign", "bSystemconfigurationEzsignpersonnal", "bSystemconfigurationSspr", "dtSystemconfigurationReadonlyexpirationstart", "dtSystemconfigurationReadonlyexpirationend"] + + @field_validator('dt_systemconfiguration_readonlyexpirationstart') def dt_systemconfiguration_readonlyexpirationstart_validate_regular_expression(cls, value): """Validates the regular expression""" if value is None: @@ -53,7 +59,7 @@ def dt_systemconfiguration_readonlyexpirationstart_validate_regular_expression(c raise ValueError(r"must validate the regular expression /^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$/") return value - @validator('dt_systemconfiguration_readonlyexpirationend') + @field_validator('dt_systemconfiguration_readonlyexpirationend') def dt_systemconfiguration_readonlyexpirationend_validate_regular_expression(cls, value): """Validates the regular expression""" if value is None: @@ -63,53 +69,66 @@ def dt_systemconfiguration_readonlyexpirationend_validate_regular_expression(cls raise ValueError(r"must validate the regular expression /^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> SystemconfigurationResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of SystemconfigurationResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> SystemconfigurationResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of SystemconfigurationResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return SystemconfigurationResponse.parse_obj(obj) - - _obj = SystemconfigurationResponse.parse_obj({ - "pki_systemconfiguration_id": obj.get("pkiSystemconfigurationID"), - "fki_systemconfigurationtype_id": obj.get("fkiSystemconfigurationtypeID"), - "s_systemconfigurationtype_description_x": obj.get("sSystemconfigurationtypeDescriptionX"), - "e_systemconfiguration_newexternaluseraction": obj.get("eSystemconfigurationNewexternaluseraction"), - "e_systemconfiguration_language1": obj.get("eSystemconfigurationLanguage1"), - "e_systemconfiguration_language2": obj.get("eSystemconfigurationLanguage2"), - "e_systemconfiguration_ezsign": obj.get("eSystemconfigurationEzsign"), - "b_systemconfiguration_ezsignpersonnal": obj.get("bSystemconfigurationEzsignpersonnal"), - "b_systemconfiguration_sspr": obj.get("bSystemconfigurationSspr"), - "dt_systemconfiguration_readonlyexpirationstart": obj.get("dtSystemconfigurationReadonlyexpirationstart"), - "dt_systemconfiguration_readonlyexpirationend": obj.get("dtSystemconfigurationReadonlyexpirationend") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiSystemconfigurationID": obj.get("pkiSystemconfigurationID"), + "fkiSystemconfigurationtypeID": obj.get("fkiSystemconfigurationtypeID"), + "sSystemconfigurationtypeDescriptionX": obj.get("sSystemconfigurationtypeDescriptionX"), + "eSystemconfigurationNewexternaluseraction": obj.get("eSystemconfigurationNewexternaluseraction"), + "eSystemconfigurationLanguage1": obj.get("eSystemconfigurationLanguage1"), + "eSystemconfigurationLanguage2": obj.get("eSystemconfigurationLanguage2"), + "eSystemconfigurationEzsign": obj.get("eSystemconfigurationEzsign"), + "bSystemconfigurationEzsignpersonnal": obj.get("bSystemconfigurationEzsignpersonnal"), + "bSystemconfigurationSspr": obj.get("bSystemconfigurationSspr"), + "dtSystemconfigurationReadonlyexpirationstart": obj.get("dtSystemconfigurationReadonlyexpirationstart"), + "dtSystemconfigurationReadonlyexpirationend": obj.get("dtSystemconfigurationReadonlyexpirationend") }) return _obj diff --git a/eZmaxApi/models/systemconfiguration_response_compound.py b/eZmaxApi/models/systemconfiguration_response_compound.py index dad96d35a..182ad36b9 100644 --- a/eZmaxApi/models/systemconfiguration_response_compound.py +++ b/eZmaxApi/models/systemconfiguration_response_compound.py @@ -19,31 +19,37 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint, constr, validator +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, StrictStr, field_validator +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.field_e_systemconfiguration_ezsign import FieldESystemconfigurationEzsign from eZmaxApi.models.field_e_systemconfiguration_language1 import FieldESystemconfigurationLanguage1 from eZmaxApi.models.field_e_systemconfiguration_language2 import FieldESystemconfigurationLanguage2 from eZmaxApi.models.field_e_systemconfiguration_newexternaluseraction import FieldESystemconfigurationNewexternaluseraction +try: + from typing import Self +except ImportError: + from typing_extensions import Self class SystemconfigurationResponseCompound(BaseModel): """ - A Systemconfiguration Object # noqa: E501 - """ - pki_systemconfiguration_id: conint(strict=True, le=1, ge=1) = Field(..., alias="pkiSystemconfigurationID", description="The unique ID of the Systemconfiguration") - fki_systemconfigurationtype_id: conint(strict=True, ge=1) = Field(..., alias="fkiSystemconfigurationtypeID", description="The unique ID of the Systemconfigurationtype") - s_systemconfigurationtype_description_x: StrictStr = Field(..., alias="sSystemconfigurationtypeDescriptionX", description="The description of the Systemconfigurationtype in the language of the requester") - e_systemconfiguration_newexternaluseraction: FieldESystemconfigurationNewexternaluseraction = Field(..., alias="eSystemconfigurationNewexternaluseraction") - e_systemconfiguration_language1: FieldESystemconfigurationLanguage1 = Field(..., alias="eSystemconfigurationLanguage1") - e_systemconfiguration_language2: FieldESystemconfigurationLanguage2 = Field(..., alias="eSystemconfigurationLanguage2") - e_systemconfiguration_ezsign: FieldESystemconfigurationEzsign = Field(..., alias="eSystemconfigurationEzsign") - b_systemconfiguration_ezsignpersonnal: StrictBool = Field(..., alias="bSystemconfigurationEzsignpersonnal", description="Whether if we allow the creation of personal files in eZsign") - b_systemconfiguration_sspr: StrictBool = Field(..., alias="bSystemconfigurationSspr", description="Whether if we allow SSPR") - dt_systemconfiguration_readonlyexpirationstart: Optional[constr(strict=True)] = Field(None, alias="dtSystemconfigurationReadonlyexpirationstart", description="The start date where the system will be in read only") - dt_systemconfiguration_readonlyexpirationend: Optional[constr(strict=True)] = Field(None, alias="dtSystemconfigurationReadonlyexpirationend", description="The end date where the system will be in read only") - __properties = ["pkiSystemconfigurationID", "fkiSystemconfigurationtypeID", "sSystemconfigurationtypeDescriptionX", "eSystemconfigurationNewexternaluseraction", "eSystemconfigurationLanguage1", "eSystemconfigurationLanguage2", "eSystemconfigurationEzsign", "bSystemconfigurationEzsignpersonnal", "bSystemconfigurationSspr", "dtSystemconfigurationReadonlyexpirationstart", "dtSystemconfigurationReadonlyexpirationend"] - - @validator('dt_systemconfiguration_readonlyexpirationstart') + A Systemconfiguration Object + """ # noqa: E501 + pki_systemconfiguration_id: Annotated[int, Field(le=1, strict=True, ge=1)] = Field(description="The unique ID of the Systemconfiguration", alias="pkiSystemconfigurationID") + fki_systemconfigurationtype_id: Annotated[int, Field(strict=True, ge=1)] = Field(description="The unique ID of the Systemconfigurationtype", alias="fkiSystemconfigurationtypeID") + s_systemconfigurationtype_description_x: StrictStr = Field(description="The description of the Systemconfigurationtype in the language of the requester", alias="sSystemconfigurationtypeDescriptionX") + e_systemconfiguration_newexternaluseraction: FieldESystemconfigurationNewexternaluseraction = Field(alias="eSystemconfigurationNewexternaluseraction") + e_systemconfiguration_language1: FieldESystemconfigurationLanguage1 = Field(alias="eSystemconfigurationLanguage1") + e_systemconfiguration_language2: FieldESystemconfigurationLanguage2 = Field(alias="eSystemconfigurationLanguage2") + e_systemconfiguration_ezsign: FieldESystemconfigurationEzsign = Field(alias="eSystemconfigurationEzsign") + b_systemconfiguration_ezsignpersonnal: StrictBool = Field(description="Whether if we allow the creation of personal files in eZsign", alias="bSystemconfigurationEzsignpersonnal") + b_systemconfiguration_sspr: StrictBool = Field(description="Whether if we allow SSPR", alias="bSystemconfigurationSspr") + dt_systemconfiguration_readonlyexpirationstart: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="The start date where the system will be in read only", alias="dtSystemconfigurationReadonlyexpirationstart") + dt_systemconfiguration_readonlyexpirationend: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="The end date where the system will be in read only", alias="dtSystemconfigurationReadonlyexpirationend") + __properties: ClassVar[List[str]] = ["pkiSystemconfigurationID", "fkiSystemconfigurationtypeID", "sSystemconfigurationtypeDescriptionX", "eSystemconfigurationNewexternaluseraction", "eSystemconfigurationLanguage1", "eSystemconfigurationLanguage2", "eSystemconfigurationEzsign", "bSystemconfigurationEzsignpersonnal", "bSystemconfigurationSspr", "dtSystemconfigurationReadonlyexpirationstart", "dtSystemconfigurationReadonlyexpirationend"] + + @field_validator('dt_systemconfiguration_readonlyexpirationstart') def dt_systemconfiguration_readonlyexpirationstart_validate_regular_expression(cls, value): """Validates the regular expression""" if value is None: @@ -53,7 +59,7 @@ def dt_systemconfiguration_readonlyexpirationstart_validate_regular_expression(c raise ValueError(r"must validate the regular expression /^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$/") return value - @validator('dt_systemconfiguration_readonlyexpirationend') + @field_validator('dt_systemconfiguration_readonlyexpirationend') def dt_systemconfiguration_readonlyexpirationend_validate_regular_expression(cls, value): """Validates the regular expression""" if value is None: @@ -63,53 +69,66 @@ def dt_systemconfiguration_readonlyexpirationend_validate_regular_expression(cls raise ValueError(r"must validate the regular expression /^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> SystemconfigurationResponseCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of SystemconfigurationResponseCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> SystemconfigurationResponseCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of SystemconfigurationResponseCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return SystemconfigurationResponseCompound.parse_obj(obj) - - _obj = SystemconfigurationResponseCompound.parse_obj({ - "pki_systemconfiguration_id": obj.get("pkiSystemconfigurationID"), - "fki_systemconfigurationtype_id": obj.get("fkiSystemconfigurationtypeID"), - "s_systemconfigurationtype_description_x": obj.get("sSystemconfigurationtypeDescriptionX"), - "e_systemconfiguration_newexternaluseraction": obj.get("eSystemconfigurationNewexternaluseraction"), - "e_systemconfiguration_language1": obj.get("eSystemconfigurationLanguage1"), - "e_systemconfiguration_language2": obj.get("eSystemconfigurationLanguage2"), - "e_systemconfiguration_ezsign": obj.get("eSystemconfigurationEzsign"), - "b_systemconfiguration_ezsignpersonnal": obj.get("bSystemconfigurationEzsignpersonnal"), - "b_systemconfiguration_sspr": obj.get("bSystemconfigurationSspr"), - "dt_systemconfiguration_readonlyexpirationstart": obj.get("dtSystemconfigurationReadonlyexpirationstart"), - "dt_systemconfiguration_readonlyexpirationend": obj.get("dtSystemconfigurationReadonlyexpirationend") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiSystemconfigurationID": obj.get("pkiSystemconfigurationID"), + "fkiSystemconfigurationtypeID": obj.get("fkiSystemconfigurationtypeID"), + "sSystemconfigurationtypeDescriptionX": obj.get("sSystemconfigurationtypeDescriptionX"), + "eSystemconfigurationNewexternaluseraction": obj.get("eSystemconfigurationNewexternaluseraction"), + "eSystemconfigurationLanguage1": obj.get("eSystemconfigurationLanguage1"), + "eSystemconfigurationLanguage2": obj.get("eSystemconfigurationLanguage2"), + "eSystemconfigurationEzsign": obj.get("eSystemconfigurationEzsign"), + "bSystemconfigurationEzsignpersonnal": obj.get("bSystemconfigurationEzsignpersonnal"), + "bSystemconfigurationSspr": obj.get("bSystemconfigurationSspr"), + "dtSystemconfigurationReadonlyexpirationstart": obj.get("dtSystemconfigurationReadonlyexpirationstart"), + "dtSystemconfigurationReadonlyexpirationend": obj.get("dtSystemconfigurationReadonlyexpirationend") }) return _obj diff --git a/eZmaxApi/models/taxassignment_autocomplete_element_response.py b/eZmaxApi/models/taxassignment_autocomplete_element_response.py index bcef65698..8e2098d36 100644 --- a/eZmaxApi/models/taxassignment_autocomplete_element_response.py +++ b/eZmaxApi/models/taxassignment_autocomplete_element_response.py @@ -19,57 +19,76 @@ import json - -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictBool, StrictStr +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class TaxassignmentAutocompleteElementResponse(BaseModel): """ - A Taxassignment AutocompleteElement Response # noqa: E501 - """ - s_taxassignment_description_x: StrictStr = Field(..., alias="sTaxassignmentDescriptionX", description="The description of the Taxassignment in the language of the requester") - pki_taxassignment_id: conint(strict=True, le=15, ge=0) = Field(..., alias="pkiTaxassignmentID", description="The unique ID of the Taxassignment. Valid values: |Value|Description| |-|-| |1|No tax| |2|GST| |3|HST (ON)| |4|HST (NB)| |5|HST (NS)| |6|HST (NL)| |7|HST (PE)| |8|GST + QST (QC)| |9|GST + QST (QC) Non-Recoverable| |10|GST + PST (BC)| |11|GST + PST (SK)| |12|GST + RST (MB)| |13|GST + PST (BC) Non-Recoverable| |14|GST + PST (SK) Non-Recoverable| |15|GST + RST (MB) Non-Recoverable|") - b_taxassignment_isactive: StrictBool = Field(..., alias="bTaxassignmentIsactive", description="Whether the Taxassignment is active or not") - __properties = ["sTaxassignmentDescriptionX", "pkiTaxassignmentID", "bTaxassignmentIsactive"] + A Taxassignment AutocompleteElement Response + """ # noqa: E501 + s_taxassignment_description_x: StrictStr = Field(description="The description of the Taxassignment in the language of the requester", alias="sTaxassignmentDescriptionX") + pki_taxassignment_id: Annotated[int, Field(le=15, strict=True, ge=0)] = Field(description="The unique ID of the Taxassignment. Valid values: |Value|Description| |-|-| |1|No tax| |2|GST| |3|HST (ON)| |4|HST (NB)| |5|HST (NS)| |6|HST (NL)| |7|HST (PE)| |8|GST + QST (QC)| |9|GST + QST (QC) Non-Recoverable| |10|GST + PST (BC)| |11|GST + PST (SK)| |12|GST + RST (MB)| |13|GST + PST (BC) Non-Recoverable| |14|GST + PST (SK) Non-Recoverable| |15|GST + RST (MB) Non-Recoverable|", alias="pkiTaxassignmentID") + b_taxassignment_isactive: StrictBool = Field(description="Whether the Taxassignment is active or not", alias="bTaxassignmentIsactive") + __properties: ClassVar[List[str]] = ["sTaxassignmentDescriptionX", "pkiTaxassignmentID", "bTaxassignmentIsactive"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> TaxassignmentAutocompleteElementResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of TaxassignmentAutocompleteElementResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> TaxassignmentAutocompleteElementResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of TaxassignmentAutocompleteElementResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return TaxassignmentAutocompleteElementResponse.parse_obj(obj) + return cls.model_validate(obj) - _obj = TaxassignmentAutocompleteElementResponse.parse_obj({ - "s_taxassignment_description_x": obj.get("sTaxassignmentDescriptionX"), - "pki_taxassignment_id": obj.get("pkiTaxassignmentID"), - "b_taxassignment_isactive": obj.get("bTaxassignmentIsactive") + _obj = cls.model_validate({ + "sTaxassignmentDescriptionX": obj.get("sTaxassignmentDescriptionX"), + "pkiTaxassignmentID": obj.get("pkiTaxassignmentID"), + "bTaxassignmentIsactive": obj.get("bTaxassignmentIsactive") }) return _obj diff --git a/eZmaxApi/models/taxassignment_get_autocomplete_v2_response.py b/eZmaxApi/models/taxassignment_get_autocomplete_v2_response.py index 5882d0d41..10909f4eb 100644 --- a/eZmaxApi/models/taxassignment_get_autocomplete_v2_response.py +++ b/eZmaxApi/models/taxassignment_get_autocomplete_v2_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.taxassignment_get_autocomplete_v2_response_m_payload import TaxassignmentGetAutocompleteV2ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class TaxassignmentGetAutocompleteV2Response(BaseModel): """ - Response for GET /2/object/taxassignment/getAutocomplete # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: TaxassignmentGetAutocompleteV2ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /2/object/taxassignment/getAutocomplete + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: TaxassignmentGetAutocompleteV2ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> TaxassignmentGetAutocompleteV2Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of TaxassignmentGetAutocompleteV2Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> TaxassignmentGetAutocompleteV2Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of TaxassignmentGetAutocompleteV2Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return TaxassignmentGetAutocompleteV2Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = TaxassignmentGetAutocompleteV2Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": TaxassignmentGetAutocompleteV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": TaxassignmentGetAutocompleteV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/taxassignment_get_autocomplete_v2_response_m_payload.py b/eZmaxApi/models/taxassignment_get_autocomplete_v2_response_m_payload.py index 130911b61..320defbc8 100644 --- a/eZmaxApi/models/taxassignment_get_autocomplete_v2_response_m_payload.py +++ b/eZmaxApi/models/taxassignment_get_autocomplete_v2_response_m_payload.py @@ -19,41 +19,59 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.taxassignment_autocomplete_element_response import TaxassignmentAutocompleteElementResponse +try: + from typing import Self +except ImportError: + from typing_extensions import Self class TaxassignmentGetAutocompleteV2ResponseMPayload(BaseModel): """ - Payload for POST /2/object/taxassignment/getAutocomplete # noqa: E501 - """ - a_obj_taxassignment: conlist(TaxassignmentAutocompleteElementResponse) = Field(..., alias="a_objTaxassignment", description="An array of Taxassignment autocomplete element response.") - __properties = ["a_objTaxassignment"] + Payload for POST /2/object/taxassignment/getAutocomplete + """ # noqa: E501 + a_obj_taxassignment: List[TaxassignmentAutocompleteElementResponse] = Field(description="An array of Taxassignment autocomplete element response.", alias="a_objTaxassignment") + __properties: ClassVar[List[str]] = ["a_objTaxassignment"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> TaxassignmentGetAutocompleteV2ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of TaxassignmentGetAutocompleteV2ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_taxassignment (list) _items = [] if self.a_obj_taxassignment: @@ -64,16 +82,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> TaxassignmentGetAutocompleteV2ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of TaxassignmentGetAutocompleteV2ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return TaxassignmentGetAutocompleteV2ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = TaxassignmentGetAutocompleteV2ResponseMPayload.parse_obj({ - "a_obj_taxassignment": [TaxassignmentAutocompleteElementResponse.from_dict(_item) for _item in obj.get("a_objTaxassignment")] if obj.get("a_objTaxassignment") is not None else None + _obj = cls.model_validate({ + "a_objTaxassignment": [TaxassignmentAutocompleteElementResponse.from_dict(_item) for _item in obj.get("a_objTaxassignment")] if obj.get("a_objTaxassignment") is not None else None }) return _obj diff --git a/eZmaxApi/models/textstylestatic_response.py b/eZmaxApi/models/textstylestatic_response.py index be1bf05d2..bbd3a2439 100644 --- a/eZmaxApi/models/textstylestatic_response.py +++ b/eZmaxApi/models/textstylestatic_response.py @@ -19,67 +19,86 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictBool, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class TextstylestaticResponse(BaseModel): """ - A Textstylestatic Object # noqa: E501 - """ - pki_textstylestatic_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="pkiTextstylestaticID", description="The unique ID of the Textstylestatic") - fki_font_id: conint(strict=True, ge=0) = Field(..., alias="fkiFontID", description="The unique ID of the Font") - b_textstylestatic_bold: StrictBool = Field(..., alias="bTextstylestaticBold", description="Whether the Textstylestatic is Bold or not") - b_textstylestatic_underline: StrictBool = Field(..., alias="bTextstylestaticUnderline", description="Whether the Textstylestatic is Underline or not") - b_textstylestatic_italic: StrictBool = Field(..., alias="bTextstylestaticItalic", description="Whether the Textstylestatic is Italic or not") - b_textstylestatic_strikethrough: StrictBool = Field(..., alias="bTextstylestaticStrikethrough", description="Whether the Textstylestatic is Strikethrough or not") - i_textstylestatic_fontcolor: conint(strict=True, le=16777215, ge=0) = Field(..., alias="iTextstylestaticFontcolor", description="The int32 representation of the Fontcolor. For example, RGB color #39435B would be 3752795") - i_textstylestatic_size: conint(strict=True, le=255, ge=1) = Field(..., alias="iTextstylestaticSize", description="The Size for the Font of the Textstylestatic") - __properties = ["pkiTextstylestaticID", "fkiFontID", "bTextstylestaticBold", "bTextstylestaticUnderline", "bTextstylestaticItalic", "bTextstylestaticStrikethrough", "iTextstylestaticFontcolor", "iTextstylestaticSize"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + A Textstylestatic Object + """ # noqa: E501 + pki_textstylestatic_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Textstylestatic", alias="pkiTextstylestaticID") + fki_font_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Font", alias="fkiFontID") + b_textstylestatic_bold: StrictBool = Field(description="Whether the Textstylestatic is Bold or not", alias="bTextstylestaticBold") + b_textstylestatic_underline: StrictBool = Field(description="Whether the Textstylestatic is Underline or not", alias="bTextstylestaticUnderline") + b_textstylestatic_italic: StrictBool = Field(description="Whether the Textstylestatic is Italic or not", alias="bTextstylestaticItalic") + b_textstylestatic_strikethrough: StrictBool = Field(description="Whether the Textstylestatic is Strikethrough or not", alias="bTextstylestaticStrikethrough") + i_textstylestatic_fontcolor: Annotated[int, Field(le=16777215, strict=True, ge=0)] = Field(description="The int32 representation of the Fontcolor. For example, RGB color #39435B would be 3752795", alias="iTextstylestaticFontcolor") + i_textstylestatic_size: Annotated[int, Field(le=255, strict=True, ge=1)] = Field(description="The Size for the Font of the Textstylestatic", alias="iTextstylestaticSize") + __properties: ClassVar[List[str]] = ["pkiTextstylestaticID", "fkiFontID", "bTextstylestaticBold", "bTextstylestaticUnderline", "bTextstylestaticItalic", "bTextstylestaticStrikethrough", "iTextstylestaticFontcolor", "iTextstylestaticSize"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> TextstylestaticResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of TextstylestaticResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> TextstylestaticResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of TextstylestaticResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return TextstylestaticResponse.parse_obj(obj) - - _obj = TextstylestaticResponse.parse_obj({ - "pki_textstylestatic_id": obj.get("pkiTextstylestaticID"), - "fki_font_id": obj.get("fkiFontID"), - "b_textstylestatic_bold": obj.get("bTextstylestaticBold"), - "b_textstylestatic_underline": obj.get("bTextstylestaticUnderline"), - "b_textstylestatic_italic": obj.get("bTextstylestaticItalic"), - "b_textstylestatic_strikethrough": obj.get("bTextstylestaticStrikethrough"), - "i_textstylestatic_fontcolor": obj.get("iTextstylestaticFontcolor"), - "i_textstylestatic_size": obj.get("iTextstylestaticSize") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiTextstylestaticID": obj.get("pkiTextstylestaticID"), + "fkiFontID": obj.get("fkiFontID"), + "bTextstylestaticBold": obj.get("bTextstylestaticBold"), + "bTextstylestaticUnderline": obj.get("bTextstylestaticUnderline"), + "bTextstylestaticItalic": obj.get("bTextstylestaticItalic"), + "bTextstylestaticStrikethrough": obj.get("bTextstylestaticStrikethrough"), + "iTextstylestaticFontcolor": obj.get("iTextstylestaticFontcolor"), + "iTextstylestaticSize": obj.get("iTextstylestaticSize") }) return _obj diff --git a/eZmaxApi/models/textstylestatic_response_compound.py b/eZmaxApi/models/textstylestatic_response_compound.py index 9e0fc3b6c..ec9e204c3 100644 --- a/eZmaxApi/models/textstylestatic_response_compound.py +++ b/eZmaxApi/models/textstylestatic_response_compound.py @@ -19,67 +19,86 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictBool, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class TextstylestaticResponseCompound(BaseModel): """ - A Textstylestatic Object # noqa: E501 - """ - pki_textstylestatic_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="pkiTextstylestaticID", description="The unique ID of the Textstylestatic") - fki_font_id: conint(strict=True, ge=0) = Field(..., alias="fkiFontID", description="The unique ID of the Font") - b_textstylestatic_bold: StrictBool = Field(..., alias="bTextstylestaticBold", description="Whether the Textstylestatic is Bold or not") - b_textstylestatic_underline: StrictBool = Field(..., alias="bTextstylestaticUnderline", description="Whether the Textstylestatic is Underline or not") - b_textstylestatic_italic: StrictBool = Field(..., alias="bTextstylestaticItalic", description="Whether the Textstylestatic is Italic or not") - b_textstylestatic_strikethrough: StrictBool = Field(..., alias="bTextstylestaticStrikethrough", description="Whether the Textstylestatic is Strikethrough or not") - i_textstylestatic_fontcolor: conint(strict=True, le=16777215, ge=0) = Field(..., alias="iTextstylestaticFontcolor", description="The int32 representation of the Fontcolor. For example, RGB color #39435B would be 3752795") - i_textstylestatic_size: conint(strict=True, le=255, ge=1) = Field(..., alias="iTextstylestaticSize", description="The Size for the Font of the Textstylestatic") - __properties = ["pkiTextstylestaticID", "fkiFontID", "bTextstylestaticBold", "bTextstylestaticUnderline", "bTextstylestaticItalic", "bTextstylestaticStrikethrough", "iTextstylestaticFontcolor", "iTextstylestaticSize"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + A Textstylestatic Object + """ # noqa: E501 + pki_textstylestatic_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Textstylestatic", alias="pkiTextstylestaticID") + fki_font_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Font", alias="fkiFontID") + b_textstylestatic_bold: StrictBool = Field(description="Whether the Textstylestatic is Bold or not", alias="bTextstylestaticBold") + b_textstylestatic_underline: StrictBool = Field(description="Whether the Textstylestatic is Underline or not", alias="bTextstylestaticUnderline") + b_textstylestatic_italic: StrictBool = Field(description="Whether the Textstylestatic is Italic or not", alias="bTextstylestaticItalic") + b_textstylestatic_strikethrough: StrictBool = Field(description="Whether the Textstylestatic is Strikethrough or not", alias="bTextstylestaticStrikethrough") + i_textstylestatic_fontcolor: Annotated[int, Field(le=16777215, strict=True, ge=0)] = Field(description="The int32 representation of the Fontcolor. For example, RGB color #39435B would be 3752795", alias="iTextstylestaticFontcolor") + i_textstylestatic_size: Annotated[int, Field(le=255, strict=True, ge=1)] = Field(description="The Size for the Font of the Textstylestatic", alias="iTextstylestaticSize") + __properties: ClassVar[List[str]] = ["pkiTextstylestaticID", "fkiFontID", "bTextstylestaticBold", "bTextstylestaticUnderline", "bTextstylestaticItalic", "bTextstylestaticStrikethrough", "iTextstylestaticFontcolor", "iTextstylestaticSize"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> TextstylestaticResponseCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of TextstylestaticResponseCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> TextstylestaticResponseCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of TextstylestaticResponseCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return TextstylestaticResponseCompound.parse_obj(obj) - - _obj = TextstylestaticResponseCompound.parse_obj({ - "pki_textstylestatic_id": obj.get("pkiTextstylestaticID"), - "fki_font_id": obj.get("fkiFontID"), - "b_textstylestatic_bold": obj.get("bTextstylestaticBold"), - "b_textstylestatic_underline": obj.get("bTextstylestaticUnderline"), - "b_textstylestatic_italic": obj.get("bTextstylestaticItalic"), - "b_textstylestatic_strikethrough": obj.get("bTextstylestaticStrikethrough"), - "i_textstylestatic_fontcolor": obj.get("iTextstylestaticFontcolor"), - "i_textstylestatic_size": obj.get("iTextstylestaticSize") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiTextstylestaticID": obj.get("pkiTextstylestaticID"), + "fkiFontID": obj.get("fkiFontID"), + "bTextstylestaticBold": obj.get("bTextstylestaticBold"), + "bTextstylestaticUnderline": obj.get("bTextstylestaticUnderline"), + "bTextstylestaticItalic": obj.get("bTextstylestaticItalic"), + "bTextstylestaticStrikethrough": obj.get("bTextstylestaticStrikethrough"), + "iTextstylestaticFontcolor": obj.get("iTextstylestaticFontcolor"), + "iTextstylestaticSize": obj.get("iTextstylestaticSize") }) return _obj diff --git a/eZmaxApi/models/timezone_autocomplete_element_response.py b/eZmaxApi/models/timezone_autocomplete_element_response.py index 20a8519b0..904fc5cf8 100644 --- a/eZmaxApi/models/timezone_autocomplete_element_response.py +++ b/eZmaxApi/models/timezone_autocomplete_element_response.py @@ -19,57 +19,76 @@ import json - -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictBool, StrictStr +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class TimezoneAutocompleteElementResponse(BaseModel): """ - A Timezone AutocompleteElement Response # noqa: E501 - """ - s_timezone_name: StrictStr = Field(..., alias="sTimezoneName", description="The description of the Timezone") - pki_timezone_id: conint(strict=True, ge=0) = Field(..., alias="pkiTimezoneID", description="The unique ID of the Timezone") - b_timezone_isactive: StrictBool = Field(..., alias="bTimezoneIsactive", description="Whether the Timezone is active or not") - __properties = ["sTimezoneName", "pkiTimezoneID", "bTimezoneIsactive"] + A Timezone AutocompleteElement Response + """ # noqa: E501 + s_timezone_name: StrictStr = Field(description="The description of the Timezone", alias="sTimezoneName") + pki_timezone_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Timezone", alias="pkiTimezoneID") + b_timezone_isactive: StrictBool = Field(description="Whether the Timezone is active or not", alias="bTimezoneIsactive") + __properties: ClassVar[List[str]] = ["sTimezoneName", "pkiTimezoneID", "bTimezoneIsactive"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> TimezoneAutocompleteElementResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of TimezoneAutocompleteElementResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> TimezoneAutocompleteElementResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of TimezoneAutocompleteElementResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return TimezoneAutocompleteElementResponse.parse_obj(obj) + return cls.model_validate(obj) - _obj = TimezoneAutocompleteElementResponse.parse_obj({ - "s_timezone_name": obj.get("sTimezoneName"), - "pki_timezone_id": obj.get("pkiTimezoneID"), - "b_timezone_isactive": obj.get("bTimezoneIsactive") + _obj = cls.model_validate({ + "sTimezoneName": obj.get("sTimezoneName"), + "pkiTimezoneID": obj.get("pkiTimezoneID"), + "bTimezoneIsactive": obj.get("bTimezoneIsactive") }) return _obj diff --git a/eZmaxApi/models/timezone_get_autocomplete_v2_response.py b/eZmaxApi/models/timezone_get_autocomplete_v2_response.py index dc8dd1ec9..99e228174 100644 --- a/eZmaxApi/models/timezone_get_autocomplete_v2_response.py +++ b/eZmaxApi/models/timezone_get_autocomplete_v2_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.timezone_get_autocomplete_v2_response_m_payload import TimezoneGetAutocompleteV2ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class TimezoneGetAutocompleteV2Response(BaseModel): """ - Response for GET /2/object/timezone/getAutocomplete # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: TimezoneGetAutocompleteV2ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /2/object/timezone/getAutocomplete + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: TimezoneGetAutocompleteV2ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> TimezoneGetAutocompleteV2Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of TimezoneGetAutocompleteV2Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> TimezoneGetAutocompleteV2Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of TimezoneGetAutocompleteV2Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return TimezoneGetAutocompleteV2Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = TimezoneGetAutocompleteV2Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": TimezoneGetAutocompleteV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": TimezoneGetAutocompleteV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/timezone_get_autocomplete_v2_response_m_payload.py b/eZmaxApi/models/timezone_get_autocomplete_v2_response_m_payload.py index 6e996ad0b..aaffe70ff 100644 --- a/eZmaxApi/models/timezone_get_autocomplete_v2_response_m_payload.py +++ b/eZmaxApi/models/timezone_get_autocomplete_v2_response_m_payload.py @@ -19,41 +19,59 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.timezone_autocomplete_element_response import TimezoneAutocompleteElementResponse +try: + from typing import Self +except ImportError: + from typing_extensions import Self class TimezoneGetAutocompleteV2ResponseMPayload(BaseModel): """ - Payload for POST /2/object/timezone/getAutocomplete # noqa: E501 - """ - a_obj_timezone: conlist(TimezoneAutocompleteElementResponse) = Field(..., alias="a_objTimezone", description="An array of Timezone autocomplete element response.") - __properties = ["a_objTimezone"] + Payload for POST /2/object/timezone/getAutocomplete + """ # noqa: E501 + a_obj_timezone: List[TimezoneAutocompleteElementResponse] = Field(description="An array of Timezone autocomplete element response.", alias="a_objTimezone") + __properties: ClassVar[List[str]] = ["a_objTimezone"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> TimezoneGetAutocompleteV2ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of TimezoneGetAutocompleteV2ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_timezone (list) _items = [] if self.a_obj_timezone: @@ -64,16 +82,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> TimezoneGetAutocompleteV2ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of TimezoneGetAutocompleteV2ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return TimezoneGetAutocompleteV2ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = TimezoneGetAutocompleteV2ResponseMPayload.parse_obj({ - "a_obj_timezone": [TimezoneAutocompleteElementResponse.from_dict(_item) for _item in obj.get("a_objTimezone")] if obj.get("a_objTimezone") is not None else None + _obj = cls.model_validate({ + "a_objTimezone": [TimezoneAutocompleteElementResponse.from_dict(_item) for _item in obj.get("a_objTimezone")] if obj.get("a_objTimezone") is not None else None }) return _obj diff --git a/eZmaxApi/models/user_autocomplete_element_response.py b/eZmaxApi/models/user_autocomplete_element_response.py index 3e0db663b..a4c0bfebd 100644 --- a/eZmaxApi/models/user_autocomplete_element_response.py +++ b/eZmaxApi/models/user_autocomplete_element_response.py @@ -19,60 +19,79 @@ import json - -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictBool, StrictStr +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.field_e_user_type import FieldEUserType +try: + from typing import Self +except ImportError: + from typing_extensions import Self class UserAutocompleteElementResponse(BaseModel): """ - A User AutocompleteElement Response # noqa: E501 - """ - e_user_type: FieldEUserType = Field(..., alias="eUserType") - s_user_name: StrictStr = Field(..., alias="sUserName", description="The description of the User in the language of the requester") - pki_user_id: conint(strict=True, ge=0) = Field(..., alias="pkiUserID", description="The unique ID of the User") - b_user_isactive: StrictBool = Field(..., alias="bUserIsactive", description="Whether the User is active or not") - __properties = ["eUserType", "sUserName", "pkiUserID", "bUserIsactive"] + A User AutocompleteElement Response + """ # noqa: E501 + e_user_type: FieldEUserType = Field(alias="eUserType") + s_user_name: StrictStr = Field(description="The description of the User in the language of the requester", alias="sUserName") + pki_user_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the User", alias="pkiUserID") + b_user_isactive: StrictBool = Field(description="Whether the User is active or not", alias="bUserIsactive") + __properties: ClassVar[List[str]] = ["eUserType", "sUserName", "pkiUserID", "bUserIsactive"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> UserAutocompleteElementResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of UserAutocompleteElementResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> UserAutocompleteElementResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of UserAutocompleteElementResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return UserAutocompleteElementResponse.parse_obj(obj) + return cls.model_validate(obj) - _obj = UserAutocompleteElementResponse.parse_obj({ - "e_user_type": obj.get("eUserType"), - "s_user_name": obj.get("sUserName"), - "pki_user_id": obj.get("pkiUserID"), - "b_user_isactive": obj.get("bUserIsactive") + _obj = cls.model_validate({ + "eUserType": obj.get("eUserType"), + "sUserName": obj.get("sUserName"), + "pkiUserID": obj.get("pkiUserID"), + "bUserIsactive": obj.get("bUserIsactive") }) return _obj diff --git a/eZmaxApi/models/user_create_ezsignuser_v1_request.py b/eZmaxApi/models/user_create_ezsignuser_v1_request.py index 7146be37e..43f62d620 100644 --- a/eZmaxApi/models/user_create_ezsignuser_v1_request.py +++ b/eZmaxApi/models/user_create_ezsignuser_v1_request.py @@ -19,67 +19,86 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictStr, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictStr +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class UserCreateEzsignuserV1Request(BaseModel): """ - Request for POST /1/module/user/createEzsignuser # noqa: E501 - """ - fki_language_id: conint(strict=True, le=2, ge=1) = Field(..., alias="fkiLanguageID", description="The unique ID of the Language. Valid values: |Value|Description| |-|-| |1|French| |2|English|") - s_user_firstname: StrictStr = Field(..., alias="sUserFirstname", description="The first name of the user") - s_user_lastname: StrictStr = Field(..., alias="sUserLastname", description="The last name of the user") - s_email_address: StrictStr = Field(..., alias="sEmailAddress", description="The email address.") - s_phone_region: StrictStr = Field(..., alias="sPhoneRegion", description="The region of the phone number. (For a North America Number only) The region is the \"514\" section in this sample phone number: (514) 990-1516 x123") - s_phone_exchange: StrictStr = Field(..., alias="sPhoneExchange", description="The exchange of the phone number. (For a North America Number only) The exchange is the \"990\" section in this sample phone number: (514) 990-1516 x123") - s_phone_number: StrictStr = Field(..., alias="sPhoneNumber", description="The number of the phone number. (For a North America Number only) The number is the \"1516\" section in this sample phone number: (514) 990-1516 x123") - s_phone_extension: Optional[StrictStr] = Field(None, alias="sPhoneExtension", description="The extension of the phone number. The extension is the \"123\" section in this sample phone number: (514) 990-1516 x123. It can also be used with international phone numbers") - __properties = ["fkiLanguageID", "sUserFirstname", "sUserLastname", "sEmailAddress", "sPhoneRegion", "sPhoneExchange", "sPhoneNumber", "sPhoneExtension"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + Request for POST /1/module/user/createEzsignuser + """ # noqa: E501 + fki_language_id: Annotated[int, Field(le=2, strict=True, ge=1)] = Field(description="The unique ID of the Language. Valid values: |Value|Description| |-|-| |1|French| |2|English|", alias="fkiLanguageID") + s_user_firstname: StrictStr = Field(description="The first name of the user", alias="sUserFirstname") + s_user_lastname: StrictStr = Field(description="The last name of the user", alias="sUserLastname") + s_email_address: StrictStr = Field(description="The email address.", alias="sEmailAddress") + s_phone_region: StrictStr = Field(description="The region of the phone number. (For a North America Number only) The region is the \"514\" section in this sample phone number: (514) 990-1516 x123", alias="sPhoneRegion") + s_phone_exchange: StrictStr = Field(description="The exchange of the phone number. (For a North America Number only) The exchange is the \"990\" section in this sample phone number: (514) 990-1516 x123", alias="sPhoneExchange") + s_phone_number: StrictStr = Field(description="The number of the phone number. (For a North America Number only) The number is the \"1516\" section in this sample phone number: (514) 990-1516 x123", alias="sPhoneNumber") + s_phone_extension: Optional[StrictStr] = Field(default=None, description="The extension of the phone number. The extension is the \"123\" section in this sample phone number: (514) 990-1516 x123. It can also be used with international phone numbers", alias="sPhoneExtension") + __properties: ClassVar[List[str]] = ["fkiLanguageID", "sUserFirstname", "sUserLastname", "sEmailAddress", "sPhoneRegion", "sPhoneExchange", "sPhoneNumber", "sPhoneExtension"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> UserCreateEzsignuserV1Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of UserCreateEzsignuserV1Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> UserCreateEzsignuserV1Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of UserCreateEzsignuserV1Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return UserCreateEzsignuserV1Request.parse_obj(obj) - - _obj = UserCreateEzsignuserV1Request.parse_obj({ - "fki_language_id": obj.get("fkiLanguageID"), - "s_user_firstname": obj.get("sUserFirstname"), - "s_user_lastname": obj.get("sUserLastname"), - "s_email_address": obj.get("sEmailAddress"), - "s_phone_region": obj.get("sPhoneRegion"), - "s_phone_exchange": obj.get("sPhoneExchange"), - "s_phone_number": obj.get("sPhoneNumber"), - "s_phone_extension": obj.get("sPhoneExtension") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "fkiLanguageID": obj.get("fkiLanguageID"), + "sUserFirstname": obj.get("sUserFirstname"), + "sUserLastname": obj.get("sUserLastname"), + "sEmailAddress": obj.get("sEmailAddress"), + "sPhoneRegion": obj.get("sPhoneRegion"), + "sPhoneExchange": obj.get("sPhoneExchange"), + "sPhoneNumber": obj.get("sPhoneNumber"), + "sPhoneExtension": obj.get("sPhoneExtension") }) return _obj diff --git a/eZmaxApi/models/user_create_ezsignuser_v1_response.py b/eZmaxApi/models/user_create_ezsignuser_v1_response.py index 654a0b0e7..071d0e9ee 100644 --- a/eZmaxApi/models/user_create_ezsignuser_v1_response.py +++ b/eZmaxApi/models/user_create_ezsignuser_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.user_create_ezsignuser_v1_response_m_payload import UserCreateEzsignuserV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class UserCreateEzsignuserV1Response(BaseModel): """ - Response for POST /1/module/user/createEzsignuser # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: UserCreateEzsignuserV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for POST /1/module/user/createEzsignuser + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: UserCreateEzsignuserV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> UserCreateEzsignuserV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of UserCreateEzsignuserV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> UserCreateEzsignuserV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of UserCreateEzsignuserV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return UserCreateEzsignuserV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = UserCreateEzsignuserV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": UserCreateEzsignuserV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": UserCreateEzsignuserV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/user_create_ezsignuser_v1_response_m_payload.py b/eZmaxApi/models/user_create_ezsignuser_v1_response_m_payload.py index 12c012c0a..f2d2fb65a 100644 --- a/eZmaxApi/models/user_create_ezsignuser_v1_response_m_payload.py +++ b/eZmaxApi/models/user_create_ezsignuser_v1_response_m_payload.py @@ -19,55 +19,73 @@ import json -from typing import List -from pydantic import BaseModel, Field, StrictStr, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictStr +from pydantic import Field +try: + from typing import Self +except ImportError: + from typing_extensions import Self class UserCreateEzsignuserV1ResponseMPayload(BaseModel): """ - Payload for POST /1/module/user/createEzsignuser # noqa: E501 - """ - a_s_email_address_success: conlist(StrictStr) = Field(..., alias="a_sEmailAddressSuccess", description="An array of email addresses that succeeded.") - a_s_email_address_failure: conlist(StrictStr) = Field(..., alias="a_sEmailAddressFailure", description="An array of email addresses that failed.") - __properties = ["a_sEmailAddressSuccess", "a_sEmailAddressFailure"] + Payload for POST /1/module/user/createEzsignuser + """ # noqa: E501 + a_s_email_address_success: List[StrictStr] = Field(description="An array of email addresses that succeeded.", alias="a_sEmailAddressSuccess") + a_s_email_address_failure: List[StrictStr] = Field(description="An array of email addresses that failed.", alias="a_sEmailAddressFailure") + __properties: ClassVar[List[str]] = ["a_sEmailAddressSuccess", "a_sEmailAddressFailure"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> UserCreateEzsignuserV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of UserCreateEzsignuserV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> UserCreateEzsignuserV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of UserCreateEzsignuserV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return UserCreateEzsignuserV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = UserCreateEzsignuserV1ResponseMPayload.parse_obj({ - "a_s_email_address_success": obj.get("a_sEmailAddressSuccess"), - "a_s_email_address_failure": obj.get("a_sEmailAddressFailure") + _obj = cls.model_validate({ + "a_sEmailAddressSuccess": obj.get("a_sEmailAddressSuccess"), + "a_sEmailAddressFailure": obj.get("a_sEmailAddressFailure") }) return _obj diff --git a/eZmaxApi/models/user_create_object_v1_request.py b/eZmaxApi/models/user_create_object_v1_request.py index 0d873f551..aaaf5dd8c 100644 --- a/eZmaxApi/models/user_create_object_v1_request.py +++ b/eZmaxApi/models/user_create_object_v1_request.py @@ -19,41 +19,60 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.user_request_compound import UserRequestCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class UserCreateObjectV1Request(BaseModel): """ - Request for POST /1/object/user # noqa: E501 - """ - a_obj_user: conlist(UserRequestCompound, min_items=1) = Field(..., alias="a_objUser") - __properties = ["a_objUser"] + Request for POST /1/object/user + """ # noqa: E501 + a_obj_user: Annotated[List[UserRequestCompound], Field(min_length=1)] = Field(alias="a_objUser") + __properties: ClassVar[List[str]] = ["a_objUser"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> UserCreateObjectV1Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of UserCreateObjectV1Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_user (list) _items = [] if self.a_obj_user: @@ -64,16 +83,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> UserCreateObjectV1Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of UserCreateObjectV1Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return UserCreateObjectV1Request.parse_obj(obj) + return cls.model_validate(obj) - _obj = UserCreateObjectV1Request.parse_obj({ - "a_obj_user": [UserRequestCompound.from_dict(_item) for _item in obj.get("a_objUser")] if obj.get("a_objUser") is not None else None + _obj = cls.model_validate({ + "a_objUser": [UserRequestCompound.from_dict(_item) for _item in obj.get("a_objUser")] if obj.get("a_objUser") is not None else None }) return _obj diff --git a/eZmaxApi/models/user_create_object_v1_response.py b/eZmaxApi/models/user_create_object_v1_response.py index 8246c92bf..68fc8294f 100644 --- a/eZmaxApi/models/user_create_object_v1_response.py +++ b/eZmaxApi/models/user_create_object_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.user_create_object_v1_response_m_payload import UserCreateObjectV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class UserCreateObjectV1Response(BaseModel): """ - Response for POST /1/object/user # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: UserCreateObjectV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for POST /1/object/user + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: UserCreateObjectV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> UserCreateObjectV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of UserCreateObjectV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> UserCreateObjectV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of UserCreateObjectV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return UserCreateObjectV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = UserCreateObjectV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": UserCreateObjectV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": UserCreateObjectV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/user_create_object_v1_response_m_payload.py b/eZmaxApi/models/user_create_object_v1_response_m_payload.py index f40bce0cc..b081a09a4 100644 --- a/eZmaxApi/models/user_create_object_v1_response_m_payload.py +++ b/eZmaxApi/models/user_create_object_v1_response_m_payload.py @@ -19,53 +19,72 @@ import json -from typing import List -from pydantic import BaseModel, Field, conint, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class UserCreateObjectV1ResponseMPayload(BaseModel): """ - Payload for POST /1/object/user # noqa: E501 - """ - a_pki_user_id: conlist(conint(strict=True, ge=0)) = Field(..., alias="a_pkiUserID", description="An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request.") - __properties = ["a_pkiUserID"] + Payload for POST /1/object/user + """ # noqa: E501 + a_pki_user_id: List[Annotated[int, Field(strict=True, ge=0)]] = Field(description="An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request.", alias="a_pkiUserID") + __properties: ClassVar[List[str]] = ["a_pkiUserID"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> UserCreateObjectV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of UserCreateObjectV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> UserCreateObjectV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of UserCreateObjectV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return UserCreateObjectV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = UserCreateObjectV1ResponseMPayload.parse_obj({ - "a_pki_user_id": obj.get("a_pkiUserID") + _obj = cls.model_validate({ + "a_pkiUserID": obj.get("a_pkiUserID") }) return _obj diff --git a/eZmaxApi/models/user_edit_object_v1_request.py b/eZmaxApi/models/user_edit_object_v1_request.py index 4d685823a..ebd158247 100644 --- a/eZmaxApi/models/user_edit_object_v1_request.py +++ b/eZmaxApi/models/user_edit_object_v1_request.py @@ -19,57 +19,75 @@ import json - -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.user_request_compound import UserRequestCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class UserEditObjectV1Request(BaseModel): """ - Request for PUT /1/object/user/{pkiUserID} # noqa: E501 - """ - obj_user: UserRequestCompound = Field(..., alias="objUser") - __properties = ["objUser"] + Request for PUT /1/object/user/{pkiUserID} + """ # noqa: E501 + obj_user: UserRequestCompound = Field(alias="objUser") + __properties: ClassVar[List[str]] = ["objUser"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> UserEditObjectV1Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of UserEditObjectV1Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_user if self.obj_user: _dict['objUser'] = self.obj_user.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> UserEditObjectV1Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of UserEditObjectV1Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return UserEditObjectV1Request.parse_obj(obj) + return cls.model_validate(obj) - _obj = UserEditObjectV1Request.parse_obj({ - "obj_user": UserRequestCompound.from_dict(obj.get("objUser")) if obj.get("objUser") is not None else None + _obj = cls.model_validate({ + "objUser": UserRequestCompound.from_dict(obj.get("objUser")) if obj.get("objUser") is not None else None }) return _obj diff --git a/eZmaxApi/models/user_edit_object_v1_response.py b/eZmaxApi/models/user_edit_object_v1_response.py index 9c905de16..30e64311c 100644 --- a/eZmaxApi/models/user_edit_object_v1_response.py +++ b/eZmaxApi/models/user_edit_object_v1_response.py @@ -19,43 +19,61 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class UserEditObjectV1Response(BaseModel): """ - Response for PUT /1/object/user/{pkiUserID} # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - __properties = ["objDebugPayload", "objDebug"] + Response for PUT /1/object/user/{pkiUserID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> UserEditObjectV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of UserEditObjectV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -65,17 +83,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> UserEditObjectV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of UserEditObjectV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return UserEditObjectV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = UserEditObjectV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None }) return _obj diff --git a/eZmaxApi/models/user_edit_permissions_v1_request.py b/eZmaxApi/models/user_edit_permissions_v1_request.py index 33c8ad754..ea9fbb0e9 100644 --- a/eZmaxApi/models/user_edit_permissions_v1_request.py +++ b/eZmaxApi/models/user_edit_permissions_v1_request.py @@ -19,41 +19,59 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.permission_request_compound import PermissionRequestCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class UserEditPermissionsV1Request(BaseModel): """ - Request for PUT /1/object/user/{pkiUserID}/editPermissions # noqa: E501 - """ - a_obj_permission: conlist(PermissionRequestCompound) = Field(..., alias="a_objPermission") - __properties = ["a_objPermission"] + Request for PUT /1/object/user/{pkiUserID}/editPermissions + """ # noqa: E501 + a_obj_permission: List[PermissionRequestCompound] = Field(alias="a_objPermission") + __properties: ClassVar[List[str]] = ["a_objPermission"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> UserEditPermissionsV1Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of UserEditPermissionsV1Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_permission (list) _items = [] if self.a_obj_permission: @@ -64,16 +82,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> UserEditPermissionsV1Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of UserEditPermissionsV1Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return UserEditPermissionsV1Request.parse_obj(obj) + return cls.model_validate(obj) - _obj = UserEditPermissionsV1Request.parse_obj({ - "a_obj_permission": [PermissionRequestCompound.from_dict(_item) for _item in obj.get("a_objPermission")] if obj.get("a_objPermission") is not None else None + _obj = cls.model_validate({ + "a_objPermission": [PermissionRequestCompound.from_dict(_item) for _item in obj.get("a_objPermission")] if obj.get("a_objPermission") is not None else None }) return _obj diff --git a/eZmaxApi/models/user_edit_permissions_v1_response.py b/eZmaxApi/models/user_edit_permissions_v1_response.py index 67abf3c0e..dd1554ab5 100644 --- a/eZmaxApi/models/user_edit_permissions_v1_response.py +++ b/eZmaxApi/models/user_edit_permissions_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.user_edit_permissions_v1_response_m_payload import UserEditPermissionsV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class UserEditPermissionsV1Response(BaseModel): """ - Response for PUT /1/object/user/{pkiUserID}/editPermissions # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: UserEditPermissionsV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for PUT /1/object/user/{pkiUserID}/editPermissions + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: UserEditPermissionsV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> UserEditPermissionsV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of UserEditPermissionsV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> UserEditPermissionsV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of UserEditPermissionsV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return UserEditPermissionsV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = UserEditPermissionsV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": UserEditPermissionsV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": UserEditPermissionsV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/user_edit_permissions_v1_response_m_payload.py b/eZmaxApi/models/user_edit_permissions_v1_response_m_payload.py index f6ed4256a..2dbae0c6f 100644 --- a/eZmaxApi/models/user_edit_permissions_v1_response_m_payload.py +++ b/eZmaxApi/models/user_edit_permissions_v1_response_m_payload.py @@ -19,53 +19,72 @@ import json -from typing import List -from pydantic import BaseModel, Field, conint, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class UserEditPermissionsV1ResponseMPayload(BaseModel): """ - Payload for PUT /1/object/user/{pkiUserID}/editPermissions # noqa: E501 - """ - a_pki_permission_id: conlist(conint(strict=True, le=65535, ge=0)) = Field(..., alias="a_pkiPermissionID") - __properties = ["a_pkiPermissionID"] + Payload for PUT /1/object/user/{pkiUserID}/editPermissions + """ # noqa: E501 + a_pki_permission_id: List[Annotated[int, Field(le=65535, strict=True, ge=0)]] = Field(alias="a_pkiPermissionID") + __properties: ClassVar[List[str]] = ["a_pkiPermissionID"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> UserEditPermissionsV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of UserEditPermissionsV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> UserEditPermissionsV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of UserEditPermissionsV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return UserEditPermissionsV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = UserEditPermissionsV1ResponseMPayload.parse_obj({ - "a_pki_permission_id": obj.get("a_pkiPermissionID") + _obj = cls.model_validate({ + "a_pkiPermissionID": obj.get("a_pkiPermissionID") }) return _obj diff --git a/eZmaxApi/models/user_get_apikeys_v1_response.py b/eZmaxApi/models/user_get_apikeys_v1_response.py index c9bb8396c..a6e559cc9 100644 --- a/eZmaxApi/models/user_get_apikeys_v1_response.py +++ b/eZmaxApi/models/user_get_apikeys_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.user_get_apikeys_v1_response_m_payload import UserGetApikeysV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class UserGetApikeysV1Response(BaseModel): """ - Response for GET /1/object/user/{pkiUserID}/getApikeys # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: UserGetApikeysV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /1/object/user/{pkiUserID}/getApikeys + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: UserGetApikeysV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> UserGetApikeysV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of UserGetApikeysV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> UserGetApikeysV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of UserGetApikeysV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return UserGetApikeysV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = UserGetApikeysV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": UserGetApikeysV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": UserGetApikeysV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/user_get_apikeys_v1_response_m_payload.py b/eZmaxApi/models/user_get_apikeys_v1_response_m_payload.py index ec85eac6a..7dab9b07c 100644 --- a/eZmaxApi/models/user_get_apikeys_v1_response_m_payload.py +++ b/eZmaxApi/models/user_get_apikeys_v1_response_m_payload.py @@ -19,41 +19,60 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.apikey_response_compound import ApikeyResponseCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class UserGetApikeysV1ResponseMPayload(BaseModel): """ - Response for GET /1/object/user/{pkiUserID}/getApikeys # noqa: E501 - """ - a_obj_apikey: conlist(ApikeyResponseCompound, min_items=0) = Field(..., alias="a_objApikey") - __properties = ["a_objApikey"] + Response for GET /1/object/user/{pkiUserID}/getApikeys + """ # noqa: E501 + a_obj_apikey: Annotated[List[ApikeyResponseCompound], Field(min_length=0)] = Field(alias="a_objApikey") + __properties: ClassVar[List[str]] = ["a_objApikey"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> UserGetApikeysV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of UserGetApikeysV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_apikey (list) _items = [] if self.a_obj_apikey: @@ -64,16 +83,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> UserGetApikeysV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of UserGetApikeysV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return UserGetApikeysV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = UserGetApikeysV1ResponseMPayload.parse_obj({ - "a_obj_apikey": [ApikeyResponseCompound.from_dict(_item) for _item in obj.get("a_objApikey")] if obj.get("a_objApikey") is not None else None + _obj = cls.model_validate({ + "a_objApikey": [ApikeyResponseCompound.from_dict(_item) for _item in obj.get("a_objApikey")] if obj.get("a_objApikey") is not None else None }) return _obj diff --git a/eZmaxApi/models/user_get_autocomplete_v2_response.py b/eZmaxApi/models/user_get_autocomplete_v2_response.py index 9ef4fcf4f..1084b2791 100644 --- a/eZmaxApi/models/user_get_autocomplete_v2_response.py +++ b/eZmaxApi/models/user_get_autocomplete_v2_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.user_get_autocomplete_v2_response_m_payload import UserGetAutocompleteV2ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class UserGetAutocompleteV2Response(BaseModel): """ - Response for GET /2/object/user/getAutocomplete # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: UserGetAutocompleteV2ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /2/object/user/getAutocomplete + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: UserGetAutocompleteV2ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> UserGetAutocompleteV2Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of UserGetAutocompleteV2Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> UserGetAutocompleteV2Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of UserGetAutocompleteV2Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return UserGetAutocompleteV2Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = UserGetAutocompleteV2Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": UserGetAutocompleteV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": UserGetAutocompleteV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/user_get_autocomplete_v2_response_m_payload.py b/eZmaxApi/models/user_get_autocomplete_v2_response_m_payload.py index f74f35403..d592ac392 100644 --- a/eZmaxApi/models/user_get_autocomplete_v2_response_m_payload.py +++ b/eZmaxApi/models/user_get_autocomplete_v2_response_m_payload.py @@ -19,41 +19,59 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.user_autocomplete_element_response import UserAutocompleteElementResponse +try: + from typing import Self +except ImportError: + from typing_extensions import Self class UserGetAutocompleteV2ResponseMPayload(BaseModel): """ - Payload for POST /2/object/user/getAutocomplete # noqa: E501 - """ - a_obj_user: conlist(UserAutocompleteElementResponse) = Field(..., alias="a_objUser", description="An array of User autocomplete element response.") - __properties = ["a_objUser"] + Payload for POST /2/object/user/getAutocomplete + """ # noqa: E501 + a_obj_user: List[UserAutocompleteElementResponse] = Field(description="An array of User autocomplete element response.", alias="a_objUser") + __properties: ClassVar[List[str]] = ["a_objUser"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> UserGetAutocompleteV2ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of UserGetAutocompleteV2ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_user (list) _items = [] if self.a_obj_user: @@ -64,16 +82,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> UserGetAutocompleteV2ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of UserGetAutocompleteV2ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return UserGetAutocompleteV2ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = UserGetAutocompleteV2ResponseMPayload.parse_obj({ - "a_obj_user": [UserAutocompleteElementResponse.from_dict(_item) for _item in obj.get("a_objUser")] if obj.get("a_objUser") is not None else None + _obj = cls.model_validate({ + "a_objUser": [UserAutocompleteElementResponse.from_dict(_item) for _item in obj.get("a_objUser")] if obj.get("a_objUser") is not None else None }) return _obj diff --git a/eZmaxApi/models/user_get_effective_permissions_v1_response.py b/eZmaxApi/models/user_get_effective_permissions_v1_response.py index 2db4629e2..f71571bc4 100644 --- a/eZmaxApi/models/user_get_effective_permissions_v1_response.py +++ b/eZmaxApi/models/user_get_effective_permissions_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.user_get_effective_permissions_v1_response_m_payload import UserGetEffectivePermissionsV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class UserGetEffectivePermissionsV1Response(BaseModel): """ - Response for GET /1/object/user/{pkiUserID}/getEffectivePermissions # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: UserGetEffectivePermissionsV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /1/object/user/{pkiUserID}/getEffectivePermissions + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: UserGetEffectivePermissionsV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> UserGetEffectivePermissionsV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of UserGetEffectivePermissionsV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> UserGetEffectivePermissionsV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of UserGetEffectivePermissionsV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return UserGetEffectivePermissionsV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = UserGetEffectivePermissionsV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": UserGetEffectivePermissionsV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": UserGetEffectivePermissionsV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/user_get_effective_permissions_v1_response_m_payload.py b/eZmaxApi/models/user_get_effective_permissions_v1_response_m_payload.py index d08ea24b6..55377c504 100644 --- a/eZmaxApi/models/user_get_effective_permissions_v1_response_m_payload.py +++ b/eZmaxApi/models/user_get_effective_permissions_v1_response_m_payload.py @@ -19,41 +19,59 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.modulegroup_response_compound import ModulegroupResponseCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class UserGetEffectivePermissionsV1ResponseMPayload(BaseModel): """ - Response for GET /1/object/user/{pkiUserID}/getEffectivePermissions # noqa: E501 - """ - a_obj_modulegroup: conlist(ModulegroupResponseCompound) = Field(..., alias="a_objModulegroup") - __properties = ["a_objModulegroup"] + Response for GET /1/object/user/{pkiUserID}/getEffectivePermissions + """ # noqa: E501 + a_obj_modulegroup: List[ModulegroupResponseCompound] = Field(alias="a_objModulegroup") + __properties: ClassVar[List[str]] = ["a_objModulegroup"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> UserGetEffectivePermissionsV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of UserGetEffectivePermissionsV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_modulegroup (list) _items = [] if self.a_obj_modulegroup: @@ -64,16 +82,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> UserGetEffectivePermissionsV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of UserGetEffectivePermissionsV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return UserGetEffectivePermissionsV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = UserGetEffectivePermissionsV1ResponseMPayload.parse_obj({ - "a_obj_modulegroup": [ModulegroupResponseCompound.from_dict(_item) for _item in obj.get("a_objModulegroup")] if obj.get("a_objModulegroup") is not None else None + _obj = cls.model_validate({ + "a_objModulegroup": [ModulegroupResponseCompound.from_dict(_item) for _item in obj.get("a_objModulegroup")] if obj.get("a_objModulegroup") is not None else None }) return _obj diff --git a/eZmaxApi/models/user_get_list_v1_response.py b/eZmaxApi/models/user_get_list_v1_response.py index 20f345fd2..416f912a7 100644 --- a/eZmaxApi/models/user_get_list_v1_response.py +++ b/eZmaxApi/models/user_get_list_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload_get_list import CommonResponseObjDebugPayloadGetList from eZmaxApi.models.user_get_list_v1_response_m_payload import UserGetListV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class UserGetListV1Response(BaseModel): """ - Response for GET /1/object/user/getList # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayloadGetList = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: UserGetListV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /1/object/user/getList + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayloadGetList = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: UserGetListV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> UserGetListV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of UserGetListV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> UserGetListV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of UserGetListV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return UserGetListV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = UserGetListV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayloadGetList.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": UserGetListV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayloadGetList.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": UserGetListV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/user_get_list_v1_response_m_payload.py b/eZmaxApi/models/user_get_list_v1_response_m_payload.py index 4b79ff074..cecdba844 100644 --- a/eZmaxApi/models/user_get_list_v1_response_m_payload.py +++ b/eZmaxApi/models/user_get_list_v1_response_m_payload.py @@ -19,43 +19,61 @@ import json -from typing import List -from pydantic import BaseModel, Field, StrictInt, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictInt +from pydantic import Field from eZmaxApi.models.user_list_element import UserListElement +try: + from typing import Self +except ImportError: + from typing_extensions import Self class UserGetListV1ResponseMPayload(BaseModel): """ - Payload for GET /1/object/user/getList # noqa: E501 - """ - i_row_returned: StrictInt = Field(..., alias="iRowReturned", description="The number of rows returned") - i_row_filtered: StrictInt = Field(..., alias="iRowFiltered", description="The number of rows matching your filters (if any) or the total number of rows") - a_obj_user: conlist(UserListElement) = Field(..., alias="a_objUser") - __properties = ["iRowReturned", "iRowFiltered", "a_objUser"] + Payload for GET /1/object/user/getList + """ # noqa: E501 + i_row_returned: StrictInt = Field(description="The number of rows returned", alias="iRowReturned") + i_row_filtered: StrictInt = Field(description="The number of rows matching your filters (if any) or the total number of rows", alias="iRowFiltered") + a_obj_user: List[UserListElement] = Field(alias="a_objUser") + __properties: ClassVar[List[str]] = ["iRowReturned", "iRowFiltered", "a_objUser"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> UserGetListV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of UserGetListV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_user (list) _items = [] if self.a_obj_user: @@ -66,18 +84,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> UserGetListV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of UserGetListV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return UserGetListV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = UserGetListV1ResponseMPayload.parse_obj({ - "i_row_returned": obj.get("iRowReturned"), - "i_row_filtered": obj.get("iRowFiltered"), - "a_obj_user": [UserListElement.from_dict(_item) for _item in obj.get("a_objUser")] if obj.get("a_objUser") is not None else None + _obj = cls.model_validate({ + "iRowReturned": obj.get("iRowReturned"), + "iRowFiltered": obj.get("iRowFiltered"), + "a_objUser": [UserListElement.from_dict(_item) for _item in obj.get("a_objUser")] if obj.get("a_objUser") is not None else None }) return _obj diff --git a/eZmaxApi/models/user_get_object_v2_response.py b/eZmaxApi/models/user_get_object_v2_response.py index 02fede8b9..49f1a6d77 100644 --- a/eZmaxApi/models/user_get_object_v2_response.py +++ b/eZmaxApi/models/user_get_object_v2_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.user_get_object_v2_response_m_payload import UserGetObjectV2ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class UserGetObjectV2Response(BaseModel): """ - Response for GET /2/object/user/{pkiUserID} # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: UserGetObjectV2ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /2/object/user/{pkiUserID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: UserGetObjectV2ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> UserGetObjectV2Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of UserGetObjectV2Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> UserGetObjectV2Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of UserGetObjectV2Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return UserGetObjectV2Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = UserGetObjectV2Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": UserGetObjectV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": UserGetObjectV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/user_get_object_v2_response_m_payload.py b/eZmaxApi/models/user_get_object_v2_response_m_payload.py index 5b197f3a2..0807b55a1 100644 --- a/eZmaxApi/models/user_get_object_v2_response_m_payload.py +++ b/eZmaxApi/models/user_get_object_v2_response_m_payload.py @@ -19,57 +19,75 @@ import json - -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.user_response_compound import UserResponseCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class UserGetObjectV2ResponseMPayload(BaseModel): """ - Payload for GET /2/object/user/{pkiUserID} # noqa: E501 - """ - obj_user: UserResponseCompound = Field(..., alias="objUser") - __properties = ["objUser"] + Payload for GET /2/object/user/{pkiUserID} + """ # noqa: E501 + obj_user: UserResponseCompound = Field(alias="objUser") + __properties: ClassVar[List[str]] = ["objUser"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> UserGetObjectV2ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of UserGetObjectV2ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_user if self.obj_user: _dict['objUser'] = self.obj_user.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> UserGetObjectV2ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of UserGetObjectV2ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return UserGetObjectV2ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = UserGetObjectV2ResponseMPayload.parse_obj({ - "obj_user": UserResponseCompound.from_dict(obj.get("objUser")) if obj.get("objUser") is not None else None + _obj = cls.model_validate({ + "objUser": UserResponseCompound.from_dict(obj.get("objUser")) if obj.get("objUser") is not None else None }) return _obj diff --git a/eZmaxApi/models/user_get_permissions_v1_response.py b/eZmaxApi/models/user_get_permissions_v1_response.py index 8aac29443..74a9e9721 100644 --- a/eZmaxApi/models/user_get_permissions_v1_response.py +++ b/eZmaxApi/models/user_get_permissions_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.user_get_permissions_v1_response_m_payload import UserGetPermissionsV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class UserGetPermissionsV1Response(BaseModel): """ - Response for GET /1/object/user/{pkiUserID}/getPermissions # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: UserGetPermissionsV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /1/object/user/{pkiUserID}/getPermissions + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: UserGetPermissionsV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> UserGetPermissionsV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of UserGetPermissionsV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> UserGetPermissionsV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of UserGetPermissionsV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return UserGetPermissionsV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = UserGetPermissionsV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": UserGetPermissionsV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": UserGetPermissionsV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/user_get_permissions_v1_response_m_payload.py b/eZmaxApi/models/user_get_permissions_v1_response_m_payload.py index 141de2b16..79ca93b5b 100644 --- a/eZmaxApi/models/user_get_permissions_v1_response_m_payload.py +++ b/eZmaxApi/models/user_get_permissions_v1_response_m_payload.py @@ -19,41 +19,59 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.modulegroup_response_compound import ModulegroupResponseCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class UserGetPermissionsV1ResponseMPayload(BaseModel): """ - Response for GET /1/object/user/{pkiUserID}/getPermissions # noqa: E501 - """ - a_obj_modulegroup: conlist(ModulegroupResponseCompound) = Field(..., alias="a_objModulegroup") - __properties = ["a_objModulegroup"] + Response for GET /1/object/user/{pkiUserID}/getPermissions + """ # noqa: E501 + a_obj_modulegroup: List[ModulegroupResponseCompound] = Field(alias="a_objModulegroup") + __properties: ClassVar[List[str]] = ["a_objModulegroup"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> UserGetPermissionsV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of UserGetPermissionsV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_modulegroup (list) _items = [] if self.a_obj_modulegroup: @@ -64,16 +82,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> UserGetPermissionsV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of UserGetPermissionsV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return UserGetPermissionsV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = UserGetPermissionsV1ResponseMPayload.parse_obj({ - "a_obj_modulegroup": [ModulegroupResponseCompound.from_dict(_item) for _item in obj.get("a_objModulegroup")] if obj.get("a_objModulegroup") is not None else None + _obj = cls.model_validate({ + "a_objModulegroup": [ModulegroupResponseCompound.from_dict(_item) for _item in obj.get("a_objModulegroup")] if obj.get("a_objModulegroup") is not None else None }) return _obj diff --git a/eZmaxApi/models/user_get_subnets_v1_response.py b/eZmaxApi/models/user_get_subnets_v1_response.py index 15e296f1f..56a967b97 100644 --- a/eZmaxApi/models/user_get_subnets_v1_response.py +++ b/eZmaxApi/models/user_get_subnets_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.user_get_subnets_v1_response_m_payload import UserGetSubnetsV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class UserGetSubnetsV1Response(BaseModel): """ - Response for GET /1/object/user/{pkiUserID}/getSubnets # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: UserGetSubnetsV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /1/object/user/{pkiUserID}/getSubnets + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: UserGetSubnetsV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> UserGetSubnetsV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of UserGetSubnetsV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> UserGetSubnetsV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of UserGetSubnetsV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return UserGetSubnetsV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = UserGetSubnetsV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": UserGetSubnetsV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": UserGetSubnetsV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/user_get_subnets_v1_response_m_payload.py b/eZmaxApi/models/user_get_subnets_v1_response_m_payload.py index 8a26b29ca..f9722e485 100644 --- a/eZmaxApi/models/user_get_subnets_v1_response_m_payload.py +++ b/eZmaxApi/models/user_get_subnets_v1_response_m_payload.py @@ -19,41 +19,59 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.subnet_response_compound import SubnetResponseCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class UserGetSubnetsV1ResponseMPayload(BaseModel): """ - Response for GET /1/object/user/{pkiUserID}/getSubnets # noqa: E501 - """ - a_obj_subnet: conlist(SubnetResponseCompound) = Field(..., alias="a_objSubnet") - __properties = ["a_objSubnet"] + Response for GET /1/object/user/{pkiUserID}/getSubnets + """ # noqa: E501 + a_obj_subnet: List[SubnetResponseCompound] = Field(alias="a_objSubnet") + __properties: ClassVar[List[str]] = ["a_objSubnet"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> UserGetSubnetsV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of UserGetSubnetsV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_subnet (list) _items = [] if self.a_obj_subnet: @@ -64,16 +82,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> UserGetSubnetsV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of UserGetSubnetsV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return UserGetSubnetsV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = UserGetSubnetsV1ResponseMPayload.parse_obj({ - "a_obj_subnet": [SubnetResponseCompound.from_dict(_item) for _item in obj.get("a_objSubnet")] if obj.get("a_objSubnet") is not None else None + _obj = cls.model_validate({ + "a_objSubnet": [SubnetResponseCompound.from_dict(_item) for _item in obj.get("a_objSubnet")] if obj.get("a_objSubnet") is not None else None }) return _obj diff --git a/eZmaxApi/models/user_list_element.py b/eZmaxApi/models/user_list_element.py index 239db2736..1bfab79dc 100644 --- a/eZmaxApi/models/user_list_element.py +++ b/eZmaxApi/models/user_list_element.py @@ -19,36 +19,42 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint, constr, validator +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, StrictStr, field_validator +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.field_e_user_ezsignaccess import FieldEUserEzsignaccess from eZmaxApi.models.field_e_user_origin import FieldEUserOrigin from eZmaxApi.models.field_e_user_type import FieldEUserType +try: + from typing import Self +except ImportError: + from typing_extensions import Self class UserListElement(BaseModel): """ - A User List Element # noqa: E501 - """ - pki_user_id: conint(strict=True, ge=0) = Field(..., alias="pkiUserID", description="The unique ID of the User") - s_user_firstname: StrictStr = Field(..., alias="sUserFirstname", description="The first name of the user") - s_user_lastname: StrictStr = Field(..., alias="sUserLastname", description="The last name of the user") - s_user_loginname: constr(strict=True) = Field(..., alias="sUserLoginname", description="The login name of the User.") - b_user_isactive: StrictBool = Field(..., alias="bUserIsactive", description="Whether the User is active or not") - e_user_type: FieldEUserType = Field(..., alias="eUserType") - e_user_origin: FieldEUserOrigin = Field(..., alias="eUserOrigin") - e_user_ezsignaccess: FieldEUserEzsignaccess = Field(..., alias="eUserEzsignaccess") - dt_user_ezsignprepaidexpiration: Optional[constr(strict=True)] = Field(None, alias="dtUserEzsignprepaidexpiration", description="The eZsign prepaid expiration date") - s_email_address: StrictStr = Field(..., alias="sEmailAddress", description="The email address.") - __properties = ["pkiUserID", "sUserFirstname", "sUserLastname", "sUserLoginname", "bUserIsactive", "eUserType", "eUserOrigin", "eUserEzsignaccess", "dtUserEzsignprepaidexpiration", "sEmailAddress"] - - @validator('s_user_loginname') + A User List Element + """ # noqa: E501 + pki_user_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the User", alias="pkiUserID") + s_user_firstname: StrictStr = Field(description="The first name of the user", alias="sUserFirstname") + s_user_lastname: StrictStr = Field(description="The last name of the user", alias="sUserLastname") + s_user_loginname: Annotated[str, Field(strict=True)] = Field(description="The login name of the User.", alias="sUserLoginname") + b_user_isactive: StrictBool = Field(description="Whether the User is active or not", alias="bUserIsactive") + e_user_type: FieldEUserType = Field(alias="eUserType") + e_user_origin: FieldEUserOrigin = Field(alias="eUserOrigin") + e_user_ezsignaccess: FieldEUserEzsignaccess = Field(alias="eUserEzsignaccess") + dt_user_ezsignprepaidexpiration: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="The eZsign prepaid expiration date", alias="dtUserEzsignprepaidexpiration") + s_email_address: StrictStr = Field(description="The email address.", alias="sEmailAddress") + __properties: ClassVar[List[str]] = ["pkiUserID", "sUserFirstname", "sUserLastname", "sUserLoginname", "bUserIsactive", "eUserType", "eUserOrigin", "eUserEzsignaccess", "dtUserEzsignprepaidexpiration", "sEmailAddress"] + + @field_validator('s_user_loginname') def s_user_loginname_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^(?:([\w\.-]+@[\w\.-]+\.\w{2,20})|([a-zA-Z0-9]){1,32})$", value): raise ValueError(r"must validate the regular expression /^(?:([\w\.-]+@[\w\.-]+\.\w{2,20})|([a-zA-Z0-9]){1,32})$/") return value - @validator('dt_user_ezsignprepaidexpiration') + @field_validator('dt_user_ezsignprepaidexpiration') def dt_user_ezsignprepaidexpiration_validate_regular_expression(cls, value): """Validates the regular expression""" if value is None: @@ -58,52 +64,65 @@ def dt_user_ezsignprepaidexpiration_validate_regular_expression(cls, value): raise ValueError(r"must validate the regular expression /^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> UserListElement: + def from_json(cls, json_str: str) -> Self: """Create an instance of UserListElement from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> UserListElement: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of UserListElement from a dict""" if obj is None: return None if not isinstance(obj, dict): - return UserListElement.parse_obj(obj) - - _obj = UserListElement.parse_obj({ - "pki_user_id": obj.get("pkiUserID"), - "s_user_firstname": obj.get("sUserFirstname"), - "s_user_lastname": obj.get("sUserLastname"), - "s_user_loginname": obj.get("sUserLoginname"), - "b_user_isactive": obj.get("bUserIsactive"), - "e_user_type": obj.get("eUserType"), - "e_user_origin": obj.get("eUserOrigin"), - "e_user_ezsignaccess": obj.get("eUserEzsignaccess"), - "dt_user_ezsignprepaidexpiration": obj.get("dtUserEzsignprepaidexpiration"), - "s_email_address": obj.get("sEmailAddress") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiUserID": obj.get("pkiUserID"), + "sUserFirstname": obj.get("sUserFirstname"), + "sUserLastname": obj.get("sUserLastname"), + "sUserLoginname": obj.get("sUserLoginname"), + "bUserIsactive": obj.get("bUserIsactive"), + "eUserType": obj.get("eUserType"), + "eUserOrigin": obj.get("eUserOrigin"), + "eUserEzsignaccess": obj.get("eUserEzsignaccess"), + "dtUserEzsignprepaidexpiration": obj.get("dtUserEzsignprepaidexpiration"), + "sEmailAddress": obj.get("sEmailAddress") }) return _obj diff --git a/eZmaxApi/models/user_request.py b/eZmaxApi/models/user_request.py index d4ceda391..d472e8b33 100644 --- a/eZmaxApi/models/user_request.py +++ b/eZmaxApi/models/user_request.py @@ -19,78 +19,97 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint, constr, validator +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, StrictStr, field_validator +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.email_request_compound import EmailRequestCompound from eZmaxApi.models.field_e_user_ezsignaccess import FieldEUserEzsignaccess from eZmaxApi.models.field_e_user_logintype import FieldEUserLogintype from eZmaxApi.models.field_e_user_type import FieldEUserType from eZmaxApi.models.phone_request_compound import PhoneRequestCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class UserRequest(BaseModel): """ - A User Object # noqa: E501 - """ - pki_user_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="pkiUserID", description="The unique ID of the User") - fki_agent_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiAgentID", description="The unique ID of the Agent.") - fki_broker_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiBrokerID", description="The unique ID of the Broker.") - fki_assistant_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiAssistantID", description="The unique ID of the Assistant.") - fki_employee_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiEmployeeID", description="The unique ID of the Employee.") - fki_company_id_default: conint(strict=True, le=255, ge=1) = Field(..., alias="fkiCompanyIDDefault", description="The unique ID of the Company") - fki_department_id_default: conint(strict=True, ge=0) = Field(..., alias="fkiDepartmentIDDefault", description="The unique ID of the Department") - fki_timezone_id: conint(strict=True, ge=0) = Field(..., alias="fkiTimezoneID", description="The unique ID of the Timezone") - fki_language_id: conint(strict=True, le=2, ge=1) = Field(..., alias="fkiLanguageID", description="The unique ID of the Language. Valid values: |Value|Description| |-|-| |1|French| |2|English|") - obj_email: EmailRequestCompound = Field(..., alias="objEmail") - fki_billingentityinternal_id: conint(strict=True, ge=0) = Field(..., alias="fkiBillingentityinternalID", description="The unique ID of the Billingentityinternal.") - obj_phone_home: Optional[PhoneRequestCompound] = Field(None, alias="objPhoneHome") - obj_phone_sms: Optional[PhoneRequestCompound] = Field(None, alias="objPhoneSMS") - fki_secretquestion_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiSecretquestionID", description="The unique ID of the Secretquestion. Valid values: |Value|Description| |-|-| |1|The name of the hospital in which you were born| |2|The name of your grade school| |3|The last name of your favorite teacher| |4|Your favorite sports team| |5|Your favorite TV show| |6|Your favorite movie| |7|The name of the street on which you grew up| |8|The name of your first employer| |9|Your first car| |10|Your favorite food| |11|The name of your first pet| |12|Favorite musician/band| |13|What instrument you play| |14|Your father's middle name| |15|Your mother's maiden name| |16|Name of your eldest child| |17|Your spouse's middle name| |18|Favorite restaurant| |19|Childhood nickname| |20|Favorite vacation destination| |21|Your boat's name| |22|Date of Birth (YYYY-MM-DD)| |22|Secret Code| |22|Your reference code|") - s_user_secretresponse: Optional[StrictStr] = Field(None, alias="sUserSecretresponse", description="The answer to the Secretquestion") - fki_module_id_form: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiModuleIDForm", description="The unique ID of the Module") - e_user_type: FieldEUserType = Field(..., alias="eUserType") - e_user_logintype: FieldEUserLogintype = Field(..., alias="eUserLogintype") - s_user_firstname: StrictStr = Field(..., alias="sUserFirstname", description="The first name of the user") - s_user_lastname: StrictStr = Field(..., alias="sUserLastname", description="The last name of the user") - s_user_loginname: constr(strict=True) = Field(..., alias="sUserLoginname", description="The login name of the User.") - e_user_ezsignaccess: FieldEUserEzsignaccess = Field(..., alias="eUserEzsignaccess") - b_user_isactive: StrictBool = Field(..., alias="bUserIsactive", description="Whether the User is active or not") - b_user_validatebyadministration: Optional[StrictBool] = Field(None, alias="bUserValidatebyadministration", description="Whether if the transactions in which the User is implicated must be validated by administrative personnel or not") - b_user_validatebydirector: Optional[StrictBool] = Field(None, alias="bUserValidatebydirector", description="Whether if the transactions in which the User is implicated must be validated by a director or not") - b_user_attachmentautoverified: Optional[StrictBool] = Field(None, alias="bUserAttachmentautoverified", description="Whether if Attachments uploaded by the User must be validated or not") - b_user_changepassword: Optional[StrictBool] = Field(None, alias="bUserChangepassword", description="Whether if the User is forced to change its password") - __properties = ["pkiUserID", "fkiAgentID", "fkiBrokerID", "fkiAssistantID", "fkiEmployeeID", "fkiCompanyIDDefault", "fkiDepartmentIDDefault", "fkiTimezoneID", "fkiLanguageID", "objEmail", "fkiBillingentityinternalID", "objPhoneHome", "objPhoneSMS", "fkiSecretquestionID", "sUserSecretresponse", "fkiModuleIDForm", "eUserType", "eUserLogintype", "sUserFirstname", "sUserLastname", "sUserLoginname", "eUserEzsignaccess", "bUserIsactive", "bUserValidatebyadministration", "bUserValidatebydirector", "bUserAttachmentautoverified", "bUserChangepassword"] - - @validator('s_user_loginname') + A User Object + """ # noqa: E501 + pki_user_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the User", alias="pkiUserID") + fki_agent_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Agent.", alias="fkiAgentID") + fki_broker_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Broker.", alias="fkiBrokerID") + fki_assistant_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Assistant.", alias="fkiAssistantID") + fki_employee_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Employee.", alias="fkiEmployeeID") + fki_company_id_default: Annotated[int, Field(le=255, strict=True, ge=1)] = Field(description="The unique ID of the Company", alias="fkiCompanyIDDefault") + fki_department_id_default: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Department", alias="fkiDepartmentIDDefault") + fki_timezone_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Timezone", alias="fkiTimezoneID") + fki_language_id: Annotated[int, Field(le=2, strict=True, ge=1)] = Field(description="The unique ID of the Language. Valid values: |Value|Description| |-|-| |1|French| |2|English|", alias="fkiLanguageID") + obj_email: EmailRequestCompound = Field(alias="objEmail") + fki_billingentityinternal_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Billingentityinternal.", alias="fkiBillingentityinternalID") + obj_phone_home: Optional[PhoneRequestCompound] = Field(default=None, alias="objPhoneHome") + obj_phone_sms: Optional[PhoneRequestCompound] = Field(default=None, alias="objPhoneSMS") + fki_secretquestion_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Secretquestion. Valid values: |Value|Description| |-|-| |1|The name of the hospital in which you were born| |2|The name of your grade school| |3|The last name of your favorite teacher| |4|Your favorite sports team| |5|Your favorite TV show| |6|Your favorite movie| |7|The name of the street on which you grew up| |8|The name of your first employer| |9|Your first car| |10|Your favorite food| |11|The name of your first pet| |12|Favorite musician/band| |13|What instrument you play| |14|Your father's middle name| |15|Your mother's maiden name| |16|Name of your eldest child| |17|Your spouse's middle name| |18|Favorite restaurant| |19|Childhood nickname| |20|Favorite vacation destination| |21|Your boat's name| |22|Date of Birth (YYYY-MM-DD)| |22|Secret Code| |22|Your reference code|", alias="fkiSecretquestionID") + s_user_secretresponse: Optional[StrictStr] = Field(default=None, description="The answer to the Secretquestion", alias="sUserSecretresponse") + fki_module_id_form: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Module", alias="fkiModuleIDForm") + e_user_type: FieldEUserType = Field(alias="eUserType") + e_user_logintype: FieldEUserLogintype = Field(alias="eUserLogintype") + s_user_firstname: StrictStr = Field(description="The first name of the user", alias="sUserFirstname") + s_user_lastname: StrictStr = Field(description="The last name of the user", alias="sUserLastname") + s_user_loginname: Annotated[str, Field(strict=True)] = Field(description="The login name of the User.", alias="sUserLoginname") + e_user_ezsignaccess: FieldEUserEzsignaccess = Field(alias="eUserEzsignaccess") + b_user_isactive: StrictBool = Field(description="Whether the User is active or not", alias="bUserIsactive") + b_user_validatebyadministration: Optional[StrictBool] = Field(default=None, description="Whether if the transactions in which the User is implicated must be validated by administrative personnel or not", alias="bUserValidatebyadministration") + b_user_validatebydirector: Optional[StrictBool] = Field(default=None, description="Whether if the transactions in which the User is implicated must be validated by a director or not", alias="bUserValidatebydirector") + b_user_attachmentautoverified: Optional[StrictBool] = Field(default=None, description="Whether if Attachments uploaded by the User must be validated or not", alias="bUserAttachmentautoverified") + b_user_changepassword: Optional[StrictBool] = Field(default=None, description="Whether if the User is forced to change its password", alias="bUserChangepassword") + __properties: ClassVar[List[str]] = ["pkiUserID", "fkiAgentID", "fkiBrokerID", "fkiAssistantID", "fkiEmployeeID", "fkiCompanyIDDefault", "fkiDepartmentIDDefault", "fkiTimezoneID", "fkiLanguageID", "objEmail", "fkiBillingentityinternalID", "objPhoneHome", "objPhoneSMS", "fkiSecretquestionID", "sUserSecretresponse", "fkiModuleIDForm", "eUserType", "eUserLogintype", "sUserFirstname", "sUserLastname", "sUserLoginname", "eUserEzsignaccess", "bUserIsactive", "bUserValidatebyadministration", "bUserValidatebydirector", "bUserAttachmentautoverified", "bUserChangepassword"] + + @field_validator('s_user_loginname') def s_user_loginname_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^(?:([\w\.-]+@[\w\.-]+\.\w{2,20})|([a-zA-Z0-9]){1,32})$", value): raise ValueError(r"must validate the regular expression /^(?:([\w\.-]+@[\w\.-]+\.\w{2,20})|([a-zA-Z0-9]){1,32})$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> UserRequest: + def from_json(cls, json_str: str) -> Self: """Create an instance of UserRequest from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_email if self.obj_email: _dict['objEmail'] = self.obj_email.to_dict() @@ -103,42 +122,42 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> UserRequest: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of UserRequest from a dict""" if obj is None: return None if not isinstance(obj, dict): - return UserRequest.parse_obj(obj) - - _obj = UserRequest.parse_obj({ - "pki_user_id": obj.get("pkiUserID"), - "fki_agent_id": obj.get("fkiAgentID"), - "fki_broker_id": obj.get("fkiBrokerID"), - "fki_assistant_id": obj.get("fkiAssistantID"), - "fki_employee_id": obj.get("fkiEmployeeID"), - "fki_company_id_default": obj.get("fkiCompanyIDDefault"), - "fki_department_id_default": obj.get("fkiDepartmentIDDefault"), - "fki_timezone_id": obj.get("fkiTimezoneID"), - "fki_language_id": obj.get("fkiLanguageID"), - "obj_email": EmailRequestCompound.from_dict(obj.get("objEmail")) if obj.get("objEmail") is not None else None, - "fki_billingentityinternal_id": obj.get("fkiBillingentityinternalID"), - "obj_phone_home": PhoneRequestCompound.from_dict(obj.get("objPhoneHome")) if obj.get("objPhoneHome") is not None else None, - "obj_phone_sms": PhoneRequestCompound.from_dict(obj.get("objPhoneSMS")) if obj.get("objPhoneSMS") is not None else None, - "fki_secretquestion_id": obj.get("fkiSecretquestionID"), - "s_user_secretresponse": obj.get("sUserSecretresponse"), - "fki_module_id_form": obj.get("fkiModuleIDForm"), - "e_user_type": obj.get("eUserType"), - "e_user_logintype": obj.get("eUserLogintype"), - "s_user_firstname": obj.get("sUserFirstname"), - "s_user_lastname": obj.get("sUserLastname"), - "s_user_loginname": obj.get("sUserLoginname"), - "e_user_ezsignaccess": obj.get("eUserEzsignaccess"), - "b_user_isactive": obj.get("bUserIsactive"), - "b_user_validatebyadministration": obj.get("bUserValidatebyadministration"), - "b_user_validatebydirector": obj.get("bUserValidatebydirector"), - "b_user_attachmentautoverified": obj.get("bUserAttachmentautoverified"), - "b_user_changepassword": obj.get("bUserChangepassword") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiUserID": obj.get("pkiUserID"), + "fkiAgentID": obj.get("fkiAgentID"), + "fkiBrokerID": obj.get("fkiBrokerID"), + "fkiAssistantID": obj.get("fkiAssistantID"), + "fkiEmployeeID": obj.get("fkiEmployeeID"), + "fkiCompanyIDDefault": obj.get("fkiCompanyIDDefault"), + "fkiDepartmentIDDefault": obj.get("fkiDepartmentIDDefault"), + "fkiTimezoneID": obj.get("fkiTimezoneID"), + "fkiLanguageID": obj.get("fkiLanguageID"), + "objEmail": EmailRequestCompound.from_dict(obj.get("objEmail")) if obj.get("objEmail") is not None else None, + "fkiBillingentityinternalID": obj.get("fkiBillingentityinternalID"), + "objPhoneHome": PhoneRequestCompound.from_dict(obj.get("objPhoneHome")) if obj.get("objPhoneHome") is not None else None, + "objPhoneSMS": PhoneRequestCompound.from_dict(obj.get("objPhoneSMS")) if obj.get("objPhoneSMS") is not None else None, + "fkiSecretquestionID": obj.get("fkiSecretquestionID"), + "sUserSecretresponse": obj.get("sUserSecretresponse"), + "fkiModuleIDForm": obj.get("fkiModuleIDForm"), + "eUserType": obj.get("eUserType"), + "eUserLogintype": obj.get("eUserLogintype"), + "sUserFirstname": obj.get("sUserFirstname"), + "sUserLastname": obj.get("sUserLastname"), + "sUserLoginname": obj.get("sUserLoginname"), + "eUserEzsignaccess": obj.get("eUserEzsignaccess"), + "bUserIsactive": obj.get("bUserIsactive"), + "bUserValidatebyadministration": obj.get("bUserValidatebyadministration"), + "bUserValidatebydirector": obj.get("bUserValidatebydirector"), + "bUserAttachmentautoverified": obj.get("bUserAttachmentautoverified"), + "bUserChangepassword": obj.get("bUserChangepassword") }) return _obj diff --git a/eZmaxApi/models/user_request_compound.py b/eZmaxApi/models/user_request_compound.py index 6a6b4d57b..74cbdebb1 100644 --- a/eZmaxApi/models/user_request_compound.py +++ b/eZmaxApi/models/user_request_compound.py @@ -19,78 +19,97 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint, constr, validator +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, StrictStr, field_validator +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.email_request_compound import EmailRequestCompound from eZmaxApi.models.field_e_user_ezsignaccess import FieldEUserEzsignaccess from eZmaxApi.models.field_e_user_logintype import FieldEUserLogintype from eZmaxApi.models.field_e_user_type import FieldEUserType from eZmaxApi.models.phone_request_compound import PhoneRequestCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class UserRequestCompound(BaseModel): """ - A User Object and children # noqa: E501 - """ - pki_user_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="pkiUserID", description="The unique ID of the User") - fki_agent_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiAgentID", description="The unique ID of the Agent.") - fki_broker_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiBrokerID", description="The unique ID of the Broker.") - fki_assistant_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiAssistantID", description="The unique ID of the Assistant.") - fki_employee_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiEmployeeID", description="The unique ID of the Employee.") - fki_company_id_default: conint(strict=True, le=255, ge=1) = Field(..., alias="fkiCompanyIDDefault", description="The unique ID of the Company") - fki_department_id_default: conint(strict=True, ge=0) = Field(..., alias="fkiDepartmentIDDefault", description="The unique ID of the Department") - fki_timezone_id: conint(strict=True, ge=0) = Field(..., alias="fkiTimezoneID", description="The unique ID of the Timezone") - fki_language_id: conint(strict=True, le=2, ge=1) = Field(..., alias="fkiLanguageID", description="The unique ID of the Language. Valid values: |Value|Description| |-|-| |1|French| |2|English|") - obj_email: EmailRequestCompound = Field(..., alias="objEmail") - fki_billingentityinternal_id: conint(strict=True, ge=0) = Field(..., alias="fkiBillingentityinternalID", description="The unique ID of the Billingentityinternal.") - obj_phone_home: Optional[PhoneRequestCompound] = Field(None, alias="objPhoneHome") - obj_phone_sms: Optional[PhoneRequestCompound] = Field(None, alias="objPhoneSMS") - fki_secretquestion_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiSecretquestionID", description="The unique ID of the Secretquestion. Valid values: |Value|Description| |-|-| |1|The name of the hospital in which you were born| |2|The name of your grade school| |3|The last name of your favorite teacher| |4|Your favorite sports team| |5|Your favorite TV show| |6|Your favorite movie| |7|The name of the street on which you grew up| |8|The name of your first employer| |9|Your first car| |10|Your favorite food| |11|The name of your first pet| |12|Favorite musician/band| |13|What instrument you play| |14|Your father's middle name| |15|Your mother's maiden name| |16|Name of your eldest child| |17|Your spouse's middle name| |18|Favorite restaurant| |19|Childhood nickname| |20|Favorite vacation destination| |21|Your boat's name| |22|Date of Birth (YYYY-MM-DD)| |22|Secret Code| |22|Your reference code|") - s_user_secretresponse: Optional[StrictStr] = Field(None, alias="sUserSecretresponse", description="The answer to the Secretquestion") - fki_module_id_form: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiModuleIDForm", description="The unique ID of the Module") - e_user_type: FieldEUserType = Field(..., alias="eUserType") - e_user_logintype: FieldEUserLogintype = Field(..., alias="eUserLogintype") - s_user_firstname: StrictStr = Field(..., alias="sUserFirstname", description="The first name of the user") - s_user_lastname: StrictStr = Field(..., alias="sUserLastname", description="The last name of the user") - s_user_loginname: constr(strict=True) = Field(..., alias="sUserLoginname", description="The login name of the User.") - e_user_ezsignaccess: FieldEUserEzsignaccess = Field(..., alias="eUserEzsignaccess") - b_user_isactive: StrictBool = Field(..., alias="bUserIsactive", description="Whether the User is active or not") - b_user_validatebyadministration: Optional[StrictBool] = Field(None, alias="bUserValidatebyadministration", description="Whether if the transactions in which the User is implicated must be validated by administrative personnel or not") - b_user_validatebydirector: Optional[StrictBool] = Field(None, alias="bUserValidatebydirector", description="Whether if the transactions in which the User is implicated must be validated by a director or not") - b_user_attachmentautoverified: Optional[StrictBool] = Field(None, alias="bUserAttachmentautoverified", description="Whether if Attachments uploaded by the User must be validated or not") - b_user_changepassword: Optional[StrictBool] = Field(None, alias="bUserChangepassword", description="Whether if the User is forced to change its password") - __properties = ["pkiUserID", "fkiAgentID", "fkiBrokerID", "fkiAssistantID", "fkiEmployeeID", "fkiCompanyIDDefault", "fkiDepartmentIDDefault", "fkiTimezoneID", "fkiLanguageID", "objEmail", "fkiBillingentityinternalID", "objPhoneHome", "objPhoneSMS", "fkiSecretquestionID", "sUserSecretresponse", "fkiModuleIDForm", "eUserType", "eUserLogintype", "sUserFirstname", "sUserLastname", "sUserLoginname", "eUserEzsignaccess", "bUserIsactive", "bUserValidatebyadministration", "bUserValidatebydirector", "bUserAttachmentautoverified", "bUserChangepassword"] - - @validator('s_user_loginname') + A User Object and children + """ # noqa: E501 + pki_user_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the User", alias="pkiUserID") + fki_agent_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Agent.", alias="fkiAgentID") + fki_broker_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Broker.", alias="fkiBrokerID") + fki_assistant_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Assistant.", alias="fkiAssistantID") + fki_employee_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Employee.", alias="fkiEmployeeID") + fki_company_id_default: Annotated[int, Field(le=255, strict=True, ge=1)] = Field(description="The unique ID of the Company", alias="fkiCompanyIDDefault") + fki_department_id_default: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Department", alias="fkiDepartmentIDDefault") + fki_timezone_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Timezone", alias="fkiTimezoneID") + fki_language_id: Annotated[int, Field(le=2, strict=True, ge=1)] = Field(description="The unique ID of the Language. Valid values: |Value|Description| |-|-| |1|French| |2|English|", alias="fkiLanguageID") + obj_email: EmailRequestCompound = Field(alias="objEmail") + fki_billingentityinternal_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Billingentityinternal.", alias="fkiBillingentityinternalID") + obj_phone_home: Optional[PhoneRequestCompound] = Field(default=None, alias="objPhoneHome") + obj_phone_sms: Optional[PhoneRequestCompound] = Field(default=None, alias="objPhoneSMS") + fki_secretquestion_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Secretquestion. Valid values: |Value|Description| |-|-| |1|The name of the hospital in which you were born| |2|The name of your grade school| |3|The last name of your favorite teacher| |4|Your favorite sports team| |5|Your favorite TV show| |6|Your favorite movie| |7|The name of the street on which you grew up| |8|The name of your first employer| |9|Your first car| |10|Your favorite food| |11|The name of your first pet| |12|Favorite musician/band| |13|What instrument you play| |14|Your father's middle name| |15|Your mother's maiden name| |16|Name of your eldest child| |17|Your spouse's middle name| |18|Favorite restaurant| |19|Childhood nickname| |20|Favorite vacation destination| |21|Your boat's name| |22|Date of Birth (YYYY-MM-DD)| |22|Secret Code| |22|Your reference code|", alias="fkiSecretquestionID") + s_user_secretresponse: Optional[StrictStr] = Field(default=None, description="The answer to the Secretquestion", alias="sUserSecretresponse") + fki_module_id_form: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Module", alias="fkiModuleIDForm") + e_user_type: FieldEUserType = Field(alias="eUserType") + e_user_logintype: FieldEUserLogintype = Field(alias="eUserLogintype") + s_user_firstname: StrictStr = Field(description="The first name of the user", alias="sUserFirstname") + s_user_lastname: StrictStr = Field(description="The last name of the user", alias="sUserLastname") + s_user_loginname: Annotated[str, Field(strict=True)] = Field(description="The login name of the User.", alias="sUserLoginname") + e_user_ezsignaccess: FieldEUserEzsignaccess = Field(alias="eUserEzsignaccess") + b_user_isactive: StrictBool = Field(description="Whether the User is active or not", alias="bUserIsactive") + b_user_validatebyadministration: Optional[StrictBool] = Field(default=None, description="Whether if the transactions in which the User is implicated must be validated by administrative personnel or not", alias="bUserValidatebyadministration") + b_user_validatebydirector: Optional[StrictBool] = Field(default=None, description="Whether if the transactions in which the User is implicated must be validated by a director or not", alias="bUserValidatebydirector") + b_user_attachmentautoverified: Optional[StrictBool] = Field(default=None, description="Whether if Attachments uploaded by the User must be validated or not", alias="bUserAttachmentautoverified") + b_user_changepassword: Optional[StrictBool] = Field(default=None, description="Whether if the User is forced to change its password", alias="bUserChangepassword") + __properties: ClassVar[List[str]] = ["pkiUserID", "fkiAgentID", "fkiBrokerID", "fkiAssistantID", "fkiEmployeeID", "fkiCompanyIDDefault", "fkiDepartmentIDDefault", "fkiTimezoneID", "fkiLanguageID", "objEmail", "fkiBillingentityinternalID", "objPhoneHome", "objPhoneSMS", "fkiSecretquestionID", "sUserSecretresponse", "fkiModuleIDForm", "eUserType", "eUserLogintype", "sUserFirstname", "sUserLastname", "sUserLoginname", "eUserEzsignaccess", "bUserIsactive", "bUserValidatebyadministration", "bUserValidatebydirector", "bUserAttachmentautoverified", "bUserChangepassword"] + + @field_validator('s_user_loginname') def s_user_loginname_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^(?:([\w\.-]+@[\w\.-]+\.\w{2,20})|([a-zA-Z0-9]){1,32})$", value): raise ValueError(r"must validate the regular expression /^(?:([\w\.-]+@[\w\.-]+\.\w{2,20})|([a-zA-Z0-9]){1,32})$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> UserRequestCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of UserRequestCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_email if self.obj_email: _dict['objEmail'] = self.obj_email.to_dict() @@ -103,42 +122,42 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> UserRequestCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of UserRequestCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return UserRequestCompound.parse_obj(obj) - - _obj = UserRequestCompound.parse_obj({ - "pki_user_id": obj.get("pkiUserID"), - "fki_agent_id": obj.get("fkiAgentID"), - "fki_broker_id": obj.get("fkiBrokerID"), - "fki_assistant_id": obj.get("fkiAssistantID"), - "fki_employee_id": obj.get("fkiEmployeeID"), - "fki_company_id_default": obj.get("fkiCompanyIDDefault"), - "fki_department_id_default": obj.get("fkiDepartmentIDDefault"), - "fki_timezone_id": obj.get("fkiTimezoneID"), - "fki_language_id": obj.get("fkiLanguageID"), - "obj_email": EmailRequestCompound.from_dict(obj.get("objEmail")) if obj.get("objEmail") is not None else None, - "fki_billingentityinternal_id": obj.get("fkiBillingentityinternalID"), - "obj_phone_home": PhoneRequestCompound.from_dict(obj.get("objPhoneHome")) if obj.get("objPhoneHome") is not None else None, - "obj_phone_sms": PhoneRequestCompound.from_dict(obj.get("objPhoneSMS")) if obj.get("objPhoneSMS") is not None else None, - "fki_secretquestion_id": obj.get("fkiSecretquestionID"), - "s_user_secretresponse": obj.get("sUserSecretresponse"), - "fki_module_id_form": obj.get("fkiModuleIDForm"), - "e_user_type": obj.get("eUserType"), - "e_user_logintype": obj.get("eUserLogintype"), - "s_user_firstname": obj.get("sUserFirstname"), - "s_user_lastname": obj.get("sUserLastname"), - "s_user_loginname": obj.get("sUserLoginname"), - "e_user_ezsignaccess": obj.get("eUserEzsignaccess"), - "b_user_isactive": obj.get("bUserIsactive"), - "b_user_validatebyadministration": obj.get("bUserValidatebyadministration"), - "b_user_validatebydirector": obj.get("bUserValidatebydirector"), - "b_user_attachmentautoverified": obj.get("bUserAttachmentautoverified"), - "b_user_changepassword": obj.get("bUserChangepassword") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiUserID": obj.get("pkiUserID"), + "fkiAgentID": obj.get("fkiAgentID"), + "fkiBrokerID": obj.get("fkiBrokerID"), + "fkiAssistantID": obj.get("fkiAssistantID"), + "fkiEmployeeID": obj.get("fkiEmployeeID"), + "fkiCompanyIDDefault": obj.get("fkiCompanyIDDefault"), + "fkiDepartmentIDDefault": obj.get("fkiDepartmentIDDefault"), + "fkiTimezoneID": obj.get("fkiTimezoneID"), + "fkiLanguageID": obj.get("fkiLanguageID"), + "objEmail": EmailRequestCompound.from_dict(obj.get("objEmail")) if obj.get("objEmail") is not None else None, + "fkiBillingentityinternalID": obj.get("fkiBillingentityinternalID"), + "objPhoneHome": PhoneRequestCompound.from_dict(obj.get("objPhoneHome")) if obj.get("objPhoneHome") is not None else None, + "objPhoneSMS": PhoneRequestCompound.from_dict(obj.get("objPhoneSMS")) if obj.get("objPhoneSMS") is not None else None, + "fkiSecretquestionID": obj.get("fkiSecretquestionID"), + "sUserSecretresponse": obj.get("sUserSecretresponse"), + "fkiModuleIDForm": obj.get("fkiModuleIDForm"), + "eUserType": obj.get("eUserType"), + "eUserLogintype": obj.get("eUserLogintype"), + "sUserFirstname": obj.get("sUserFirstname"), + "sUserLastname": obj.get("sUserLastname"), + "sUserLoginname": obj.get("sUserLoginname"), + "eUserEzsignaccess": obj.get("eUserEzsignaccess"), + "bUserIsactive": obj.get("bUserIsactive"), + "bUserValidatebyadministration": obj.get("bUserValidatebyadministration"), + "bUserValidatebydirector": obj.get("bUserValidatebydirector"), + "bUserAttachmentautoverified": obj.get("bUserAttachmentautoverified"), + "bUserChangepassword": obj.get("bUserChangepassword") }) return _obj diff --git a/eZmaxApi/models/user_response.py b/eZmaxApi/models/user_response.py index 33f69ab9b..2d4e17495 100644 --- a/eZmaxApi/models/user_response.py +++ b/eZmaxApi/models/user_response.py @@ -19,8 +19,10 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint, constr, validator +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, StrictStr, field_validator +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.common_audit import CommonAudit from eZmaxApi.models.email_response_compound import EmailResponseCompound from eZmaxApi.models.field_e_user_ezsignaccess import FieldEUserEzsignaccess @@ -28,58 +30,62 @@ from eZmaxApi.models.field_e_user_origin import FieldEUserOrigin from eZmaxApi.models.field_e_user_type import FieldEUserType from eZmaxApi.models.phone_response_compound import PhoneResponseCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class UserResponse(BaseModel): """ - A User Object # noqa: E501 - """ - pki_user_id: conint(strict=True, ge=0) = Field(..., alias="pkiUserID", description="The unique ID of the User") - fki_agent_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiAgentID", description="The unique ID of the Agent.") - fki_broker_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiBrokerID", description="The unique ID of the Broker.") - fki_assistant_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiAssistantID", description="The unique ID of the Assistant.") - fki_employee_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiEmployeeID", description="The unique ID of the Employee.") - fki_company_id_default: conint(strict=True, le=255, ge=1) = Field(..., alias="fkiCompanyIDDefault", description="The unique ID of the Company") - s_company_name_x: StrictStr = Field(..., alias="sCompanyNameX", description="The Name of the Company in the language of the requester") - fki_department_id_default: conint(strict=True, ge=0) = Field(..., alias="fkiDepartmentIDDefault", description="The unique ID of the Department") - s_department_name_x: StrictStr = Field(..., alias="sDepartmentNameX", description="The Name of the Department in the language of the requester") - fki_timezone_id: conint(strict=True, ge=0) = Field(..., alias="fkiTimezoneID", description="The unique ID of the Timezone") - s_timezone_name: StrictStr = Field(..., alias="sTimezoneName", description="The description of the Timezone") - fki_language_id: conint(strict=True, le=2, ge=1) = Field(..., alias="fkiLanguageID", description="The unique ID of the Language. Valid values: |Value|Description| |-|-| |1|French| |2|English|") - s_language_name_x: StrictStr = Field(..., alias="sLanguageNameX", description="The Name of the Language in the language of the requester") - obj_email: EmailResponseCompound = Field(..., alias="objEmail") - fki_billingentityinternal_id: conint(strict=True, ge=0) = Field(..., alias="fkiBillingentityinternalID", description="The unique ID of the Billingentityinternal.") - s_billingentityinternal_description_x: StrictStr = Field(..., alias="sBillingentityinternalDescriptionX", description="The description of the Billingentityinternal in the language of the requester") - obj_phone_home: Optional[PhoneResponseCompound] = Field(None, alias="objPhoneHome") - obj_phone_sms: Optional[PhoneResponseCompound] = Field(None, alias="objPhoneSMS") - fki_secretquestion_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiSecretquestionID", description="The unique ID of the Secretquestion. Valid values: |Value|Description| |-|-| |1|The name of the hospital in which you were born| |2|The name of your grade school| |3|The last name of your favorite teacher| |4|Your favorite sports team| |5|Your favorite TV show| |6|Your favorite movie| |7|The name of the street on which you grew up| |8|The name of your first employer| |9|Your first car| |10|Your favorite food| |11|The name of your first pet| |12|Favorite musician/band| |13|What instrument you play| |14|Your father's middle name| |15|Your mother's maiden name| |16|Name of your eldest child| |17|Your spouse's middle name| |18|Favorite restaurant| |19|Childhood nickname| |20|Favorite vacation destination| |21|Your boat's name| |22|Date of Birth (YYYY-MM-DD)| |22|Secret Code| |22|Your reference code|") - fki_module_id_form: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiModuleIDForm", description="The unique ID of the Module") - s_module_name_x: Optional[StrictStr] = Field(None, alias="sModuleNameX", description="The Name of the Module in the language of the requester") - e_user_origin: FieldEUserOrigin = Field(..., alias="eUserOrigin") - e_user_type: FieldEUserType = Field(..., alias="eUserType") - e_user_logintype: FieldEUserLogintype = Field(..., alias="eUserLogintype") - s_user_firstname: StrictStr = Field(..., alias="sUserFirstname", description="The first name of the user") - s_user_lastname: StrictStr = Field(..., alias="sUserLastname", description="The last name of the user") - s_user_loginname: constr(strict=True) = Field(..., alias="sUserLoginname", description="The login name of the User.") - e_user_ezsignaccess: FieldEUserEzsignaccess = Field(..., alias="eUserEzsignaccess") - dt_user_lastlogondate: Optional[constr(strict=True)] = Field(None, alias="dtUserLastlogondate", description="The last logon date of the User") - dt_user_passwordchanged: Optional[constr(strict=True)] = Field(None, alias="dtUserPasswordchanged", description="The date at which the User's password was last changed") - dt_user_ezsignprepaidexpiration: Optional[constr(strict=True)] = Field(None, alias="dtUserEzsignprepaidexpiration", description="The eZsign prepaid expiration date") - b_user_isactive: StrictBool = Field(..., alias="bUserIsactive", description="Whether the User is active or not") - b_user_validatebyadministration: Optional[StrictBool] = Field(None, alias="bUserValidatebyadministration", description="Whether if the transactions in which the User is implicated must be validated by administrative personnel or not") - b_user_validatebydirector: Optional[StrictBool] = Field(None, alias="bUserValidatebydirector", description="Whether if the transactions in which the User is implicated must be validated by a director or not") - b_user_attachmentautoverified: Optional[StrictBool] = Field(None, alias="bUserAttachmentautoverified", description="Whether if Attachments uploaded by the User must be validated or not") - b_user_changepassword: StrictBool = Field(..., alias="bUserChangepassword", description="Whether if the User is forced to change its password") - obj_audit: CommonAudit = Field(..., alias="objAudit") - __properties = ["pkiUserID", "fkiAgentID", "fkiBrokerID", "fkiAssistantID", "fkiEmployeeID", "fkiCompanyIDDefault", "sCompanyNameX", "fkiDepartmentIDDefault", "sDepartmentNameX", "fkiTimezoneID", "sTimezoneName", "fkiLanguageID", "sLanguageNameX", "objEmail", "fkiBillingentityinternalID", "sBillingentityinternalDescriptionX", "objPhoneHome", "objPhoneSMS", "fkiSecretquestionID", "fkiModuleIDForm", "sModuleNameX", "eUserOrigin", "eUserType", "eUserLogintype", "sUserFirstname", "sUserLastname", "sUserLoginname", "eUserEzsignaccess", "dtUserLastlogondate", "dtUserPasswordchanged", "dtUserEzsignprepaidexpiration", "bUserIsactive", "bUserValidatebyadministration", "bUserValidatebydirector", "bUserAttachmentautoverified", "bUserChangepassword", "objAudit"] - - @validator('s_user_loginname') + A User Object + """ # noqa: E501 + pki_user_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the User", alias="pkiUserID") + fki_agent_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Agent.", alias="fkiAgentID") + fki_broker_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Broker.", alias="fkiBrokerID") + fki_assistant_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Assistant.", alias="fkiAssistantID") + fki_employee_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Employee.", alias="fkiEmployeeID") + fki_company_id_default: Annotated[int, Field(le=255, strict=True, ge=1)] = Field(description="The unique ID of the Company", alias="fkiCompanyIDDefault") + s_company_name_x: StrictStr = Field(description="The Name of the Company in the language of the requester", alias="sCompanyNameX") + fki_department_id_default: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Department", alias="fkiDepartmentIDDefault") + s_department_name_x: StrictStr = Field(description="The Name of the Department in the language of the requester", alias="sDepartmentNameX") + fki_timezone_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Timezone", alias="fkiTimezoneID") + s_timezone_name: StrictStr = Field(description="The description of the Timezone", alias="sTimezoneName") + fki_language_id: Annotated[int, Field(le=2, strict=True, ge=1)] = Field(description="The unique ID of the Language. Valid values: |Value|Description| |-|-| |1|French| |2|English|", alias="fkiLanguageID") + s_language_name_x: StrictStr = Field(description="The Name of the Language in the language of the requester", alias="sLanguageNameX") + obj_email: EmailResponseCompound = Field(alias="objEmail") + fki_billingentityinternal_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Billingentityinternal.", alias="fkiBillingentityinternalID") + s_billingentityinternal_description_x: StrictStr = Field(description="The description of the Billingentityinternal in the language of the requester", alias="sBillingentityinternalDescriptionX") + obj_phone_home: Optional[PhoneResponseCompound] = Field(default=None, alias="objPhoneHome") + obj_phone_sms: Optional[PhoneResponseCompound] = Field(default=None, alias="objPhoneSMS") + fki_secretquestion_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Secretquestion. Valid values: |Value|Description| |-|-| |1|The name of the hospital in which you were born| |2|The name of your grade school| |3|The last name of your favorite teacher| |4|Your favorite sports team| |5|Your favorite TV show| |6|Your favorite movie| |7|The name of the street on which you grew up| |8|The name of your first employer| |9|Your first car| |10|Your favorite food| |11|The name of your first pet| |12|Favorite musician/band| |13|What instrument you play| |14|Your father's middle name| |15|Your mother's maiden name| |16|Name of your eldest child| |17|Your spouse's middle name| |18|Favorite restaurant| |19|Childhood nickname| |20|Favorite vacation destination| |21|Your boat's name| |22|Date of Birth (YYYY-MM-DD)| |22|Secret Code| |22|Your reference code|", alias="fkiSecretquestionID") + fki_module_id_form: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Module", alias="fkiModuleIDForm") + s_module_name_x: Optional[StrictStr] = Field(default=None, description="The Name of the Module in the language of the requester", alias="sModuleNameX") + e_user_origin: FieldEUserOrigin = Field(alias="eUserOrigin") + e_user_type: FieldEUserType = Field(alias="eUserType") + e_user_logintype: FieldEUserLogintype = Field(alias="eUserLogintype") + s_user_firstname: StrictStr = Field(description="The first name of the user", alias="sUserFirstname") + s_user_lastname: StrictStr = Field(description="The last name of the user", alias="sUserLastname") + s_user_loginname: Annotated[str, Field(strict=True)] = Field(description="The login name of the User.", alias="sUserLoginname") + e_user_ezsignaccess: FieldEUserEzsignaccess = Field(alias="eUserEzsignaccess") + dt_user_lastlogondate: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="The last logon date of the User", alias="dtUserLastlogondate") + dt_user_passwordchanged: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="The date at which the User's password was last changed", alias="dtUserPasswordchanged") + dt_user_ezsignprepaidexpiration: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="The eZsign prepaid expiration date", alias="dtUserEzsignprepaidexpiration") + b_user_isactive: StrictBool = Field(description="Whether the User is active or not", alias="bUserIsactive") + b_user_validatebyadministration: Optional[StrictBool] = Field(default=None, description="Whether if the transactions in which the User is implicated must be validated by administrative personnel or not", alias="bUserValidatebyadministration") + b_user_validatebydirector: Optional[StrictBool] = Field(default=None, description="Whether if the transactions in which the User is implicated must be validated by a director or not", alias="bUserValidatebydirector") + b_user_attachmentautoverified: Optional[StrictBool] = Field(default=None, description="Whether if Attachments uploaded by the User must be validated or not", alias="bUserAttachmentautoverified") + b_user_changepassword: StrictBool = Field(description="Whether if the User is forced to change its password", alias="bUserChangepassword") + obj_audit: CommonAudit = Field(alias="objAudit") + __properties: ClassVar[List[str]] = ["pkiUserID", "fkiAgentID", "fkiBrokerID", "fkiAssistantID", "fkiEmployeeID", "fkiCompanyIDDefault", "sCompanyNameX", "fkiDepartmentIDDefault", "sDepartmentNameX", "fkiTimezoneID", "sTimezoneName", "fkiLanguageID", "sLanguageNameX", "objEmail", "fkiBillingentityinternalID", "sBillingentityinternalDescriptionX", "objPhoneHome", "objPhoneSMS", "fkiSecretquestionID", "fkiModuleIDForm", "sModuleNameX", "eUserOrigin", "eUserType", "eUserLogintype", "sUserFirstname", "sUserLastname", "sUserLoginname", "eUserEzsignaccess", "dtUserLastlogondate", "dtUserPasswordchanged", "dtUserEzsignprepaidexpiration", "bUserIsactive", "bUserValidatebyadministration", "bUserValidatebydirector", "bUserAttachmentautoverified", "bUserChangepassword", "objAudit"] + + @field_validator('s_user_loginname') def s_user_loginname_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^(?:([\w\.-]+@[\w\.-]+\.\w{2,20})|([a-zA-Z0-9]){1,32})$", value): raise ValueError(r"must validate the regular expression /^(?:([\w\.-]+@[\w\.-]+\.\w{2,20})|([a-zA-Z0-9]){1,32})$/") return value - @validator('dt_user_lastlogondate') + @field_validator('dt_user_lastlogondate') def dt_user_lastlogondate_validate_regular_expression(cls, value): """Validates the regular expression""" if value is None: @@ -89,7 +95,7 @@ def dt_user_lastlogondate_validate_regular_expression(cls, value): raise ValueError(r"must validate the regular expression /^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1]) ([01]?[0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9])$/") return value - @validator('dt_user_passwordchanged') + @field_validator('dt_user_passwordchanged') def dt_user_passwordchanged_validate_regular_expression(cls, value): """Validates the regular expression""" if value is None: @@ -99,7 +105,7 @@ def dt_user_passwordchanged_validate_regular_expression(cls, value): raise ValueError(r"must validate the regular expression /^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1]) ([01]?[0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9])$/") return value - @validator('dt_user_ezsignprepaidexpiration') + @field_validator('dt_user_ezsignprepaidexpiration') def dt_user_ezsignprepaidexpiration_validate_regular_expression(cls, value): """Validates the regular expression""" if value is None: @@ -109,30 +115,43 @@ def dt_user_ezsignprepaidexpiration_validate_regular_expression(cls, value): raise ValueError(r"must validate the regular expression /^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> UserResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of UserResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_email if self.obj_email: _dict['objEmail'] = self.obj_email.to_dict() @@ -148,52 +167,52 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> UserResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of UserResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return UserResponse.parse_obj(obj) - - _obj = UserResponse.parse_obj({ - "pki_user_id": obj.get("pkiUserID"), - "fki_agent_id": obj.get("fkiAgentID"), - "fki_broker_id": obj.get("fkiBrokerID"), - "fki_assistant_id": obj.get("fkiAssistantID"), - "fki_employee_id": obj.get("fkiEmployeeID"), - "fki_company_id_default": obj.get("fkiCompanyIDDefault"), - "s_company_name_x": obj.get("sCompanyNameX"), - "fki_department_id_default": obj.get("fkiDepartmentIDDefault"), - "s_department_name_x": obj.get("sDepartmentNameX"), - "fki_timezone_id": obj.get("fkiTimezoneID"), - "s_timezone_name": obj.get("sTimezoneName"), - "fki_language_id": obj.get("fkiLanguageID"), - "s_language_name_x": obj.get("sLanguageNameX"), - "obj_email": EmailResponseCompound.from_dict(obj.get("objEmail")) if obj.get("objEmail") is not None else None, - "fki_billingentityinternal_id": obj.get("fkiBillingentityinternalID"), - "s_billingentityinternal_description_x": obj.get("sBillingentityinternalDescriptionX"), - "obj_phone_home": PhoneResponseCompound.from_dict(obj.get("objPhoneHome")) if obj.get("objPhoneHome") is not None else None, - "obj_phone_sms": PhoneResponseCompound.from_dict(obj.get("objPhoneSMS")) if obj.get("objPhoneSMS") is not None else None, - "fki_secretquestion_id": obj.get("fkiSecretquestionID"), - "fki_module_id_form": obj.get("fkiModuleIDForm"), - "s_module_name_x": obj.get("sModuleNameX"), - "e_user_origin": obj.get("eUserOrigin"), - "e_user_type": obj.get("eUserType"), - "e_user_logintype": obj.get("eUserLogintype"), - "s_user_firstname": obj.get("sUserFirstname"), - "s_user_lastname": obj.get("sUserLastname"), - "s_user_loginname": obj.get("sUserLoginname"), - "e_user_ezsignaccess": obj.get("eUserEzsignaccess"), - "dt_user_lastlogondate": obj.get("dtUserLastlogondate"), - "dt_user_passwordchanged": obj.get("dtUserPasswordchanged"), - "dt_user_ezsignprepaidexpiration": obj.get("dtUserEzsignprepaidexpiration"), - "b_user_isactive": obj.get("bUserIsactive"), - "b_user_validatebyadministration": obj.get("bUserValidatebyadministration"), - "b_user_validatebydirector": obj.get("bUserValidatebydirector"), - "b_user_attachmentautoverified": obj.get("bUserAttachmentautoverified"), - "b_user_changepassword": obj.get("bUserChangepassword"), - "obj_audit": CommonAudit.from_dict(obj.get("objAudit")) if obj.get("objAudit") is not None else None + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiUserID": obj.get("pkiUserID"), + "fkiAgentID": obj.get("fkiAgentID"), + "fkiBrokerID": obj.get("fkiBrokerID"), + "fkiAssistantID": obj.get("fkiAssistantID"), + "fkiEmployeeID": obj.get("fkiEmployeeID"), + "fkiCompanyIDDefault": obj.get("fkiCompanyIDDefault"), + "sCompanyNameX": obj.get("sCompanyNameX"), + "fkiDepartmentIDDefault": obj.get("fkiDepartmentIDDefault"), + "sDepartmentNameX": obj.get("sDepartmentNameX"), + "fkiTimezoneID": obj.get("fkiTimezoneID"), + "sTimezoneName": obj.get("sTimezoneName"), + "fkiLanguageID": obj.get("fkiLanguageID"), + "sLanguageNameX": obj.get("sLanguageNameX"), + "objEmail": EmailResponseCompound.from_dict(obj.get("objEmail")) if obj.get("objEmail") is not None else None, + "fkiBillingentityinternalID": obj.get("fkiBillingentityinternalID"), + "sBillingentityinternalDescriptionX": obj.get("sBillingentityinternalDescriptionX"), + "objPhoneHome": PhoneResponseCompound.from_dict(obj.get("objPhoneHome")) if obj.get("objPhoneHome") is not None else None, + "objPhoneSMS": PhoneResponseCompound.from_dict(obj.get("objPhoneSMS")) if obj.get("objPhoneSMS") is not None else None, + "fkiSecretquestionID": obj.get("fkiSecretquestionID"), + "fkiModuleIDForm": obj.get("fkiModuleIDForm"), + "sModuleNameX": obj.get("sModuleNameX"), + "eUserOrigin": obj.get("eUserOrigin"), + "eUserType": obj.get("eUserType"), + "eUserLogintype": obj.get("eUserLogintype"), + "sUserFirstname": obj.get("sUserFirstname"), + "sUserLastname": obj.get("sUserLastname"), + "sUserLoginname": obj.get("sUserLoginname"), + "eUserEzsignaccess": obj.get("eUserEzsignaccess"), + "dtUserLastlogondate": obj.get("dtUserLastlogondate"), + "dtUserPasswordchanged": obj.get("dtUserPasswordchanged"), + "dtUserEzsignprepaidexpiration": obj.get("dtUserEzsignprepaidexpiration"), + "bUserIsactive": obj.get("bUserIsactive"), + "bUserValidatebyadministration": obj.get("bUserValidatebyadministration"), + "bUserValidatebydirector": obj.get("bUserValidatebydirector"), + "bUserAttachmentautoverified": obj.get("bUserAttachmentautoverified"), + "bUserChangepassword": obj.get("bUserChangepassword"), + "objAudit": CommonAudit.from_dict(obj.get("objAudit")) if obj.get("objAudit") is not None else None }) return _obj diff --git a/eZmaxApi/models/user_response_compound.py b/eZmaxApi/models/user_response_compound.py index e44e186fb..d79ac29da 100644 --- a/eZmaxApi/models/user_response_compound.py +++ b/eZmaxApi/models/user_response_compound.py @@ -19,8 +19,10 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint, constr, validator +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, StrictStr, field_validator +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.common_audit import CommonAudit from eZmaxApi.models.email_response_compound import EmailResponseCompound from eZmaxApi.models.field_e_user_ezsignaccess import FieldEUserEzsignaccess @@ -28,58 +30,62 @@ from eZmaxApi.models.field_e_user_origin import FieldEUserOrigin from eZmaxApi.models.field_e_user_type import FieldEUserType from eZmaxApi.models.phone_response_compound import PhoneResponseCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class UserResponseCompound(BaseModel): """ - A User Object and children to create a complete structure # noqa: E501 - """ - pki_user_id: conint(strict=True, ge=0) = Field(..., alias="pkiUserID", description="The unique ID of the User") - fki_agent_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiAgentID", description="The unique ID of the Agent.") - fki_broker_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiBrokerID", description="The unique ID of the Broker.") - fki_assistant_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiAssistantID", description="The unique ID of the Assistant.") - fki_employee_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiEmployeeID", description="The unique ID of the Employee.") - fki_company_id_default: conint(strict=True, le=255, ge=1) = Field(..., alias="fkiCompanyIDDefault", description="The unique ID of the Company") - s_company_name_x: StrictStr = Field(..., alias="sCompanyNameX", description="The Name of the Company in the language of the requester") - fki_department_id_default: conint(strict=True, ge=0) = Field(..., alias="fkiDepartmentIDDefault", description="The unique ID of the Department") - s_department_name_x: StrictStr = Field(..., alias="sDepartmentNameX", description="The Name of the Department in the language of the requester") - fki_timezone_id: conint(strict=True, ge=0) = Field(..., alias="fkiTimezoneID", description="The unique ID of the Timezone") - s_timezone_name: StrictStr = Field(..., alias="sTimezoneName", description="The description of the Timezone") - fki_language_id: conint(strict=True, le=2, ge=1) = Field(..., alias="fkiLanguageID", description="The unique ID of the Language. Valid values: |Value|Description| |-|-| |1|French| |2|English|") - s_language_name_x: StrictStr = Field(..., alias="sLanguageNameX", description="The Name of the Language in the language of the requester") - obj_email: EmailResponseCompound = Field(..., alias="objEmail") - fki_billingentityinternal_id: conint(strict=True, ge=0) = Field(..., alias="fkiBillingentityinternalID", description="The unique ID of the Billingentityinternal.") - s_billingentityinternal_description_x: StrictStr = Field(..., alias="sBillingentityinternalDescriptionX", description="The description of the Billingentityinternal in the language of the requester") - obj_phone_home: Optional[PhoneResponseCompound] = Field(None, alias="objPhoneHome") - obj_phone_sms: Optional[PhoneResponseCompound] = Field(None, alias="objPhoneSMS") - fki_secretquestion_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiSecretquestionID", description="The unique ID of the Secretquestion. Valid values: |Value|Description| |-|-| |1|The name of the hospital in which you were born| |2|The name of your grade school| |3|The last name of your favorite teacher| |4|Your favorite sports team| |5|Your favorite TV show| |6|Your favorite movie| |7|The name of the street on which you grew up| |8|The name of your first employer| |9|Your first car| |10|Your favorite food| |11|The name of your first pet| |12|Favorite musician/band| |13|What instrument you play| |14|Your father's middle name| |15|Your mother's maiden name| |16|Name of your eldest child| |17|Your spouse's middle name| |18|Favorite restaurant| |19|Childhood nickname| |20|Favorite vacation destination| |21|Your boat's name| |22|Date of Birth (YYYY-MM-DD)| |22|Secret Code| |22|Your reference code|") - fki_module_id_form: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiModuleIDForm", description="The unique ID of the Module") - s_module_name_x: Optional[StrictStr] = Field(None, alias="sModuleNameX", description="The Name of the Module in the language of the requester") - e_user_origin: FieldEUserOrigin = Field(..., alias="eUserOrigin") - e_user_type: FieldEUserType = Field(..., alias="eUserType") - e_user_logintype: FieldEUserLogintype = Field(..., alias="eUserLogintype") - s_user_firstname: StrictStr = Field(..., alias="sUserFirstname", description="The first name of the user") - s_user_lastname: StrictStr = Field(..., alias="sUserLastname", description="The last name of the user") - s_user_loginname: constr(strict=True) = Field(..., alias="sUserLoginname", description="The login name of the User.") - e_user_ezsignaccess: FieldEUserEzsignaccess = Field(..., alias="eUserEzsignaccess") - dt_user_lastlogondate: Optional[constr(strict=True)] = Field(None, alias="dtUserLastlogondate", description="The last logon date of the User") - dt_user_passwordchanged: Optional[constr(strict=True)] = Field(None, alias="dtUserPasswordchanged", description="The date at which the User's password was last changed") - dt_user_ezsignprepaidexpiration: Optional[constr(strict=True)] = Field(None, alias="dtUserEzsignprepaidexpiration", description="The eZsign prepaid expiration date") - b_user_isactive: StrictBool = Field(..., alias="bUserIsactive", description="Whether the User is active or not") - b_user_validatebyadministration: Optional[StrictBool] = Field(None, alias="bUserValidatebyadministration", description="Whether if the transactions in which the User is implicated must be validated by administrative personnel or not") - b_user_validatebydirector: Optional[StrictBool] = Field(None, alias="bUserValidatebydirector", description="Whether if the transactions in which the User is implicated must be validated by a director or not") - b_user_attachmentautoverified: Optional[StrictBool] = Field(None, alias="bUserAttachmentautoverified", description="Whether if Attachments uploaded by the User must be validated or not") - b_user_changepassword: StrictBool = Field(..., alias="bUserChangepassword", description="Whether if the User is forced to change its password") - obj_audit: CommonAudit = Field(..., alias="objAudit") - __properties = ["pkiUserID", "fkiAgentID", "fkiBrokerID", "fkiAssistantID", "fkiEmployeeID", "fkiCompanyIDDefault", "sCompanyNameX", "fkiDepartmentIDDefault", "sDepartmentNameX", "fkiTimezoneID", "sTimezoneName", "fkiLanguageID", "sLanguageNameX", "objEmail", "fkiBillingentityinternalID", "sBillingentityinternalDescriptionX", "objPhoneHome", "objPhoneSMS", "fkiSecretquestionID", "fkiModuleIDForm", "sModuleNameX", "eUserOrigin", "eUserType", "eUserLogintype", "sUserFirstname", "sUserLastname", "sUserLoginname", "eUserEzsignaccess", "dtUserLastlogondate", "dtUserPasswordchanged", "dtUserEzsignprepaidexpiration", "bUserIsactive", "bUserValidatebyadministration", "bUserValidatebydirector", "bUserAttachmentautoverified", "bUserChangepassword", "objAudit"] - - @validator('s_user_loginname') + A User Object and children to create a complete structure + """ # noqa: E501 + pki_user_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the User", alias="pkiUserID") + fki_agent_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Agent.", alias="fkiAgentID") + fki_broker_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Broker.", alias="fkiBrokerID") + fki_assistant_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Assistant.", alias="fkiAssistantID") + fki_employee_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Employee.", alias="fkiEmployeeID") + fki_company_id_default: Annotated[int, Field(le=255, strict=True, ge=1)] = Field(description="The unique ID of the Company", alias="fkiCompanyIDDefault") + s_company_name_x: StrictStr = Field(description="The Name of the Company in the language of the requester", alias="sCompanyNameX") + fki_department_id_default: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Department", alias="fkiDepartmentIDDefault") + s_department_name_x: StrictStr = Field(description="The Name of the Department in the language of the requester", alias="sDepartmentNameX") + fki_timezone_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Timezone", alias="fkiTimezoneID") + s_timezone_name: StrictStr = Field(description="The description of the Timezone", alias="sTimezoneName") + fki_language_id: Annotated[int, Field(le=2, strict=True, ge=1)] = Field(description="The unique ID of the Language. Valid values: |Value|Description| |-|-| |1|French| |2|English|", alias="fkiLanguageID") + s_language_name_x: StrictStr = Field(description="The Name of the Language in the language of the requester", alias="sLanguageNameX") + obj_email: EmailResponseCompound = Field(alias="objEmail") + fki_billingentityinternal_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Billingentityinternal.", alias="fkiBillingentityinternalID") + s_billingentityinternal_description_x: StrictStr = Field(description="The description of the Billingentityinternal in the language of the requester", alias="sBillingentityinternalDescriptionX") + obj_phone_home: Optional[PhoneResponseCompound] = Field(default=None, alias="objPhoneHome") + obj_phone_sms: Optional[PhoneResponseCompound] = Field(default=None, alias="objPhoneSMS") + fki_secretquestion_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Secretquestion. Valid values: |Value|Description| |-|-| |1|The name of the hospital in which you were born| |2|The name of your grade school| |3|The last name of your favorite teacher| |4|Your favorite sports team| |5|Your favorite TV show| |6|Your favorite movie| |7|The name of the street on which you grew up| |8|The name of your first employer| |9|Your first car| |10|Your favorite food| |11|The name of your first pet| |12|Favorite musician/band| |13|What instrument you play| |14|Your father's middle name| |15|Your mother's maiden name| |16|Name of your eldest child| |17|Your spouse's middle name| |18|Favorite restaurant| |19|Childhood nickname| |20|Favorite vacation destination| |21|Your boat's name| |22|Date of Birth (YYYY-MM-DD)| |22|Secret Code| |22|Your reference code|", alias="fkiSecretquestionID") + fki_module_id_form: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Module", alias="fkiModuleIDForm") + s_module_name_x: Optional[StrictStr] = Field(default=None, description="The Name of the Module in the language of the requester", alias="sModuleNameX") + e_user_origin: FieldEUserOrigin = Field(alias="eUserOrigin") + e_user_type: FieldEUserType = Field(alias="eUserType") + e_user_logintype: FieldEUserLogintype = Field(alias="eUserLogintype") + s_user_firstname: StrictStr = Field(description="The first name of the user", alias="sUserFirstname") + s_user_lastname: StrictStr = Field(description="The last name of the user", alias="sUserLastname") + s_user_loginname: Annotated[str, Field(strict=True)] = Field(description="The login name of the User.", alias="sUserLoginname") + e_user_ezsignaccess: FieldEUserEzsignaccess = Field(alias="eUserEzsignaccess") + dt_user_lastlogondate: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="The last logon date of the User", alias="dtUserLastlogondate") + dt_user_passwordchanged: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="The date at which the User's password was last changed", alias="dtUserPasswordchanged") + dt_user_ezsignprepaidexpiration: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="The eZsign prepaid expiration date", alias="dtUserEzsignprepaidexpiration") + b_user_isactive: StrictBool = Field(description="Whether the User is active or not", alias="bUserIsactive") + b_user_validatebyadministration: Optional[StrictBool] = Field(default=None, description="Whether if the transactions in which the User is implicated must be validated by administrative personnel or not", alias="bUserValidatebyadministration") + b_user_validatebydirector: Optional[StrictBool] = Field(default=None, description="Whether if the transactions in which the User is implicated must be validated by a director or not", alias="bUserValidatebydirector") + b_user_attachmentautoverified: Optional[StrictBool] = Field(default=None, description="Whether if Attachments uploaded by the User must be validated or not", alias="bUserAttachmentautoverified") + b_user_changepassword: StrictBool = Field(description="Whether if the User is forced to change its password", alias="bUserChangepassword") + obj_audit: CommonAudit = Field(alias="objAudit") + __properties: ClassVar[List[str]] = ["pkiUserID", "fkiAgentID", "fkiBrokerID", "fkiAssistantID", "fkiEmployeeID", "fkiCompanyIDDefault", "sCompanyNameX", "fkiDepartmentIDDefault", "sDepartmentNameX", "fkiTimezoneID", "sTimezoneName", "fkiLanguageID", "sLanguageNameX", "objEmail", "fkiBillingentityinternalID", "sBillingentityinternalDescriptionX", "objPhoneHome", "objPhoneSMS", "fkiSecretquestionID", "fkiModuleIDForm", "sModuleNameX", "eUserOrigin", "eUserType", "eUserLogintype", "sUserFirstname", "sUserLastname", "sUserLoginname", "eUserEzsignaccess", "dtUserLastlogondate", "dtUserPasswordchanged", "dtUserEzsignprepaidexpiration", "bUserIsactive", "bUserValidatebyadministration", "bUserValidatebydirector", "bUserAttachmentautoverified", "bUserChangepassword", "objAudit"] + + @field_validator('s_user_loginname') def s_user_loginname_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^(?:([\w\.-]+@[\w\.-]+\.\w{2,20})|([a-zA-Z0-9]){1,32})$", value): raise ValueError(r"must validate the regular expression /^(?:([\w\.-]+@[\w\.-]+\.\w{2,20})|([a-zA-Z0-9]){1,32})$/") return value - @validator('dt_user_lastlogondate') + @field_validator('dt_user_lastlogondate') def dt_user_lastlogondate_validate_regular_expression(cls, value): """Validates the regular expression""" if value is None: @@ -89,7 +95,7 @@ def dt_user_lastlogondate_validate_regular_expression(cls, value): raise ValueError(r"must validate the regular expression /^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1]) ([01]?[0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9])$/") return value - @validator('dt_user_passwordchanged') + @field_validator('dt_user_passwordchanged') def dt_user_passwordchanged_validate_regular_expression(cls, value): """Validates the regular expression""" if value is None: @@ -99,7 +105,7 @@ def dt_user_passwordchanged_validate_regular_expression(cls, value): raise ValueError(r"must validate the regular expression /^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1]) ([01]?[0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9])$/") return value - @validator('dt_user_ezsignprepaidexpiration') + @field_validator('dt_user_ezsignprepaidexpiration') def dt_user_ezsignprepaidexpiration_validate_regular_expression(cls, value): """Validates the regular expression""" if value is None: @@ -109,30 +115,43 @@ def dt_user_ezsignprepaidexpiration_validate_regular_expression(cls, value): raise ValueError(r"must validate the regular expression /^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> UserResponseCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of UserResponseCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_email if self.obj_email: _dict['objEmail'] = self.obj_email.to_dict() @@ -148,52 +167,52 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> UserResponseCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of UserResponseCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return UserResponseCompound.parse_obj(obj) - - _obj = UserResponseCompound.parse_obj({ - "pki_user_id": obj.get("pkiUserID"), - "fki_agent_id": obj.get("fkiAgentID"), - "fki_broker_id": obj.get("fkiBrokerID"), - "fki_assistant_id": obj.get("fkiAssistantID"), - "fki_employee_id": obj.get("fkiEmployeeID"), - "fki_company_id_default": obj.get("fkiCompanyIDDefault"), - "s_company_name_x": obj.get("sCompanyNameX"), - "fki_department_id_default": obj.get("fkiDepartmentIDDefault"), - "s_department_name_x": obj.get("sDepartmentNameX"), - "fki_timezone_id": obj.get("fkiTimezoneID"), - "s_timezone_name": obj.get("sTimezoneName"), - "fki_language_id": obj.get("fkiLanguageID"), - "s_language_name_x": obj.get("sLanguageNameX"), - "obj_email": EmailResponseCompound.from_dict(obj.get("objEmail")) if obj.get("objEmail") is not None else None, - "fki_billingentityinternal_id": obj.get("fkiBillingentityinternalID"), - "s_billingentityinternal_description_x": obj.get("sBillingentityinternalDescriptionX"), - "obj_phone_home": PhoneResponseCompound.from_dict(obj.get("objPhoneHome")) if obj.get("objPhoneHome") is not None else None, - "obj_phone_sms": PhoneResponseCompound.from_dict(obj.get("objPhoneSMS")) if obj.get("objPhoneSMS") is not None else None, - "fki_secretquestion_id": obj.get("fkiSecretquestionID"), - "fki_module_id_form": obj.get("fkiModuleIDForm"), - "s_module_name_x": obj.get("sModuleNameX"), - "e_user_origin": obj.get("eUserOrigin"), - "e_user_type": obj.get("eUserType"), - "e_user_logintype": obj.get("eUserLogintype"), - "s_user_firstname": obj.get("sUserFirstname"), - "s_user_lastname": obj.get("sUserLastname"), - "s_user_loginname": obj.get("sUserLoginname"), - "e_user_ezsignaccess": obj.get("eUserEzsignaccess"), - "dt_user_lastlogondate": obj.get("dtUserLastlogondate"), - "dt_user_passwordchanged": obj.get("dtUserPasswordchanged"), - "dt_user_ezsignprepaidexpiration": obj.get("dtUserEzsignprepaidexpiration"), - "b_user_isactive": obj.get("bUserIsactive"), - "b_user_validatebyadministration": obj.get("bUserValidatebyadministration"), - "b_user_validatebydirector": obj.get("bUserValidatebydirector"), - "b_user_attachmentautoverified": obj.get("bUserAttachmentautoverified"), - "b_user_changepassword": obj.get("bUserChangepassword"), - "obj_audit": CommonAudit.from_dict(obj.get("objAudit")) if obj.get("objAudit") is not None else None + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiUserID": obj.get("pkiUserID"), + "fkiAgentID": obj.get("fkiAgentID"), + "fkiBrokerID": obj.get("fkiBrokerID"), + "fkiAssistantID": obj.get("fkiAssistantID"), + "fkiEmployeeID": obj.get("fkiEmployeeID"), + "fkiCompanyIDDefault": obj.get("fkiCompanyIDDefault"), + "sCompanyNameX": obj.get("sCompanyNameX"), + "fkiDepartmentIDDefault": obj.get("fkiDepartmentIDDefault"), + "sDepartmentNameX": obj.get("sDepartmentNameX"), + "fkiTimezoneID": obj.get("fkiTimezoneID"), + "sTimezoneName": obj.get("sTimezoneName"), + "fkiLanguageID": obj.get("fkiLanguageID"), + "sLanguageNameX": obj.get("sLanguageNameX"), + "objEmail": EmailResponseCompound.from_dict(obj.get("objEmail")) if obj.get("objEmail") is not None else None, + "fkiBillingentityinternalID": obj.get("fkiBillingentityinternalID"), + "sBillingentityinternalDescriptionX": obj.get("sBillingentityinternalDescriptionX"), + "objPhoneHome": PhoneResponseCompound.from_dict(obj.get("objPhoneHome")) if obj.get("objPhoneHome") is not None else None, + "objPhoneSMS": PhoneResponseCompound.from_dict(obj.get("objPhoneSMS")) if obj.get("objPhoneSMS") is not None else None, + "fkiSecretquestionID": obj.get("fkiSecretquestionID"), + "fkiModuleIDForm": obj.get("fkiModuleIDForm"), + "sModuleNameX": obj.get("sModuleNameX"), + "eUserOrigin": obj.get("eUserOrigin"), + "eUserType": obj.get("eUserType"), + "eUserLogintype": obj.get("eUserLogintype"), + "sUserFirstname": obj.get("sUserFirstname"), + "sUserLastname": obj.get("sUserLastname"), + "sUserLoginname": obj.get("sUserLoginname"), + "eUserEzsignaccess": obj.get("eUserEzsignaccess"), + "dtUserLastlogondate": obj.get("dtUserLastlogondate"), + "dtUserPasswordchanged": obj.get("dtUserPasswordchanged"), + "dtUserEzsignprepaidexpiration": obj.get("dtUserEzsignprepaidexpiration"), + "bUserIsactive": obj.get("bUserIsactive"), + "bUserValidatebyadministration": obj.get("bUserValidatebyadministration"), + "bUserValidatebydirector": obj.get("bUserValidatebydirector"), + "bUserAttachmentautoverified": obj.get("bUserAttachmentautoverified"), + "bUserChangepassword": obj.get("bUserChangepassword"), + "objAudit": CommonAudit.from_dict(obj.get("objAudit")) if obj.get("objAudit") is not None else None }) return _obj diff --git a/eZmaxApi/models/user_send_password_reset_v1_response.py b/eZmaxApi/models/user_send_password_reset_v1_response.py index 8731e02e3..520003e1b 100644 --- a/eZmaxApi/models/user_send_password_reset_v1_response.py +++ b/eZmaxApi/models/user_send_password_reset_v1_response.py @@ -19,43 +19,61 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class UserSendPasswordResetV1Response(BaseModel): """ - Response for POST /1/object/user/{pkiUserID}/sendPasswordReset # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - __properties = ["objDebugPayload", "objDebug"] + Response for POST /1/object/user/{pkiUserID}/sendPasswordReset + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> UserSendPasswordResetV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of UserSendPasswordResetV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -65,17 +83,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> UserSendPasswordResetV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of UserSendPasswordResetV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return UserSendPasswordResetV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = UserSendPasswordResetV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None }) return _obj diff --git a/eZmaxApi/models/usergroup_autocomplete_element_response.py b/eZmaxApi/models/usergroup_autocomplete_element_response.py index 397a80d0e..b867eb9b8 100644 --- a/eZmaxApi/models/usergroup_autocomplete_element_response.py +++ b/eZmaxApi/models/usergroup_autocomplete_element_response.py @@ -19,64 +19,83 @@ import json - -from pydantic import BaseModel, Field, StrictBool, conint, constr, validator +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictBool, field_validator +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class UsergroupAutocompleteElementResponse(BaseModel): """ - A Usergroup AutocompleteElement Response # noqa: E501 - """ - s_usergroup_name_x: constr(strict=True) = Field(..., alias="sUsergroupNameX", description="The Name of the Usergroup in the language of the requester") - pki_usergroup_id: conint(strict=True, le=255, ge=0) = Field(..., alias="pkiUsergroupID", description="The unique ID of the Usergroup") - b_usergroup_isactive: StrictBool = Field(..., alias="bUsergroupIsactive", description="Whether the Usergroup is active or not") - __properties = ["sUsergroupNameX", "pkiUsergroupID", "bUsergroupIsactive"] - - @validator('s_usergroup_name_x') + A Usergroup AutocompleteElement Response + """ # noqa: E501 + s_usergroup_name_x: Annotated[str, Field(strict=True)] = Field(description="The Name of the Usergroup in the language of the requester", alias="sUsergroupNameX") + pki_usergroup_id: Annotated[int, Field(le=255, strict=True, ge=0)] = Field(description="The unique ID of the Usergroup", alias="pkiUsergroupID") + b_usergroup_isactive: StrictBool = Field(description="Whether the Usergroup is active or not", alias="bUsergroupIsactive") + __properties: ClassVar[List[str]] = ["sUsergroupNameX", "pkiUsergroupID", "bUsergroupIsactive"] + + @field_validator('s_usergroup_name_x') def s_usergroup_name_x_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^.{0,50}$", value): raise ValueError(r"must validate the regular expression /^.{0,50}$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> UsergroupAutocompleteElementResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of UsergroupAutocompleteElementResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> UsergroupAutocompleteElementResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of UsergroupAutocompleteElementResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return UsergroupAutocompleteElementResponse.parse_obj(obj) + return cls.model_validate(obj) - _obj = UsergroupAutocompleteElementResponse.parse_obj({ - "s_usergroup_name_x": obj.get("sUsergroupNameX"), - "pki_usergroup_id": obj.get("pkiUsergroupID"), - "b_usergroup_isactive": obj.get("bUsergroupIsactive") + _obj = cls.model_validate({ + "sUsergroupNameX": obj.get("sUsergroupNameX"), + "pkiUsergroupID": obj.get("pkiUsergroupID"), + "bUsergroupIsactive": obj.get("bUsergroupIsactive") }) return _obj diff --git a/eZmaxApi/models/usergroup_create_object_v1_request.py b/eZmaxApi/models/usergroup_create_object_v1_request.py index 3d3c70ee9..44e9de630 100644 --- a/eZmaxApi/models/usergroup_create_object_v1_request.py +++ b/eZmaxApi/models/usergroup_create_object_v1_request.py @@ -19,41 +19,60 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.usergroup_request_compound import UsergroupRequestCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class UsergroupCreateObjectV1Request(BaseModel): """ - Request for POST /1/object/usergroup # noqa: E501 - """ - a_obj_usergroup: conlist(UsergroupRequestCompound, min_items=1) = Field(..., alias="a_objUsergroup") - __properties = ["a_objUsergroup"] + Request for POST /1/object/usergroup + """ # noqa: E501 + a_obj_usergroup: Annotated[List[UsergroupRequestCompound], Field(min_length=1)] = Field(alias="a_objUsergroup") + __properties: ClassVar[List[str]] = ["a_objUsergroup"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> UsergroupCreateObjectV1Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of UsergroupCreateObjectV1Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_usergroup (list) _items = [] if self.a_obj_usergroup: @@ -64,16 +83,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> UsergroupCreateObjectV1Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of UsergroupCreateObjectV1Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return UsergroupCreateObjectV1Request.parse_obj(obj) + return cls.model_validate(obj) - _obj = UsergroupCreateObjectV1Request.parse_obj({ - "a_obj_usergroup": [UsergroupRequestCompound.from_dict(_item) for _item in obj.get("a_objUsergroup")] if obj.get("a_objUsergroup") is not None else None + _obj = cls.model_validate({ + "a_objUsergroup": [UsergroupRequestCompound.from_dict(_item) for _item in obj.get("a_objUsergroup")] if obj.get("a_objUsergroup") is not None else None }) return _obj diff --git a/eZmaxApi/models/usergroup_create_object_v1_response.py b/eZmaxApi/models/usergroup_create_object_v1_response.py index e8f9c2b73..2c6e11939 100644 --- a/eZmaxApi/models/usergroup_create_object_v1_response.py +++ b/eZmaxApi/models/usergroup_create_object_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.usergroup_create_object_v1_response_m_payload import UsergroupCreateObjectV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class UsergroupCreateObjectV1Response(BaseModel): """ - Response for POST /1/object/usergroup # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: UsergroupCreateObjectV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for POST /1/object/usergroup + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: UsergroupCreateObjectV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> UsergroupCreateObjectV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of UsergroupCreateObjectV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> UsergroupCreateObjectV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of UsergroupCreateObjectV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return UsergroupCreateObjectV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = UsergroupCreateObjectV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": UsergroupCreateObjectV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": UsergroupCreateObjectV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/usergroup_create_object_v1_response_m_payload.py b/eZmaxApi/models/usergroup_create_object_v1_response_m_payload.py index 10f731e89..bb00f1e8f 100644 --- a/eZmaxApi/models/usergroup_create_object_v1_response_m_payload.py +++ b/eZmaxApi/models/usergroup_create_object_v1_response_m_payload.py @@ -19,53 +19,72 @@ import json -from typing import List -from pydantic import BaseModel, Field, conint, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class UsergroupCreateObjectV1ResponseMPayload(BaseModel): """ - Payload for POST /1/object/usergroup # noqa: E501 - """ - a_pki_usergroup_id: conlist(conint(strict=True, le=255, ge=0)) = Field(..., alias="a_pkiUsergroupID", description="An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request.") - __properties = ["a_pkiUsergroupID"] + Payload for POST /1/object/usergroup + """ # noqa: E501 + a_pki_usergroup_id: List[Annotated[int, Field(le=255, strict=True, ge=0)]] = Field(description="An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request.", alias="a_pkiUsergroupID") + __properties: ClassVar[List[str]] = ["a_pkiUsergroupID"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> UsergroupCreateObjectV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of UsergroupCreateObjectV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> UsergroupCreateObjectV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of UsergroupCreateObjectV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return UsergroupCreateObjectV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = UsergroupCreateObjectV1ResponseMPayload.parse_obj({ - "a_pki_usergroup_id": obj.get("a_pkiUsergroupID") + _obj = cls.model_validate({ + "a_pkiUsergroupID": obj.get("a_pkiUsergroupID") }) return _obj diff --git a/eZmaxApi/models/usergroup_edit_object_v1_request.py b/eZmaxApi/models/usergroup_edit_object_v1_request.py index df7f001a6..9e1318baf 100644 --- a/eZmaxApi/models/usergroup_edit_object_v1_request.py +++ b/eZmaxApi/models/usergroup_edit_object_v1_request.py @@ -19,57 +19,75 @@ import json - -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.usergroup_request_compound import UsergroupRequestCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class UsergroupEditObjectV1Request(BaseModel): """ - Request for PUT /1/object/usergroup/{pkiUsergroupID} # noqa: E501 - """ - obj_usergroup: UsergroupRequestCompound = Field(..., alias="objUsergroup") - __properties = ["objUsergroup"] + Request for PUT /1/object/usergroup/{pkiUsergroupID} + """ # noqa: E501 + obj_usergroup: UsergroupRequestCompound = Field(alias="objUsergroup") + __properties: ClassVar[List[str]] = ["objUsergroup"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> UsergroupEditObjectV1Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of UsergroupEditObjectV1Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_usergroup if self.obj_usergroup: _dict['objUsergroup'] = self.obj_usergroup.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> UsergroupEditObjectV1Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of UsergroupEditObjectV1Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return UsergroupEditObjectV1Request.parse_obj(obj) + return cls.model_validate(obj) - _obj = UsergroupEditObjectV1Request.parse_obj({ - "obj_usergroup": UsergroupRequestCompound.from_dict(obj.get("objUsergroup")) if obj.get("objUsergroup") is not None else None + _obj = cls.model_validate({ + "objUsergroup": UsergroupRequestCompound.from_dict(obj.get("objUsergroup")) if obj.get("objUsergroup") is not None else None }) return _obj diff --git a/eZmaxApi/models/usergroup_edit_object_v1_response.py b/eZmaxApi/models/usergroup_edit_object_v1_response.py index e69401f4b..29327e696 100644 --- a/eZmaxApi/models/usergroup_edit_object_v1_response.py +++ b/eZmaxApi/models/usergroup_edit_object_v1_response.py @@ -19,43 +19,61 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class UsergroupEditObjectV1Response(BaseModel): """ - Response for PUT /1/object/usergroup/{pkiUsergroupID} # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - __properties = ["objDebugPayload", "objDebug"] + Response for PUT /1/object/usergroup/{pkiUsergroupID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> UsergroupEditObjectV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of UsergroupEditObjectV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -65,17 +83,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> UsergroupEditObjectV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of UsergroupEditObjectV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return UsergroupEditObjectV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = UsergroupEditObjectV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None }) return _obj diff --git a/eZmaxApi/models/usergroup_edit_permissions_v1_request.py b/eZmaxApi/models/usergroup_edit_permissions_v1_request.py index eab4a9b65..7f16bd161 100644 --- a/eZmaxApi/models/usergroup_edit_permissions_v1_request.py +++ b/eZmaxApi/models/usergroup_edit_permissions_v1_request.py @@ -19,41 +19,59 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.permission_request_compound import PermissionRequestCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class UsergroupEditPermissionsV1Request(BaseModel): """ - Request for PUT /1/object/usergroup/{pkiUsergroupID}/editPermissions # noqa: E501 - """ - a_obj_permission: conlist(PermissionRequestCompound) = Field(..., alias="a_objPermission") - __properties = ["a_objPermission"] + Request for PUT /1/object/usergroup/{pkiUsergroupID}/editPermissions + """ # noqa: E501 + a_obj_permission: List[PermissionRequestCompound] = Field(alias="a_objPermission") + __properties: ClassVar[List[str]] = ["a_objPermission"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> UsergroupEditPermissionsV1Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of UsergroupEditPermissionsV1Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_permission (list) _items = [] if self.a_obj_permission: @@ -64,16 +82,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> UsergroupEditPermissionsV1Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of UsergroupEditPermissionsV1Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return UsergroupEditPermissionsV1Request.parse_obj(obj) + return cls.model_validate(obj) - _obj = UsergroupEditPermissionsV1Request.parse_obj({ - "a_obj_permission": [PermissionRequestCompound.from_dict(_item) for _item in obj.get("a_objPermission")] if obj.get("a_objPermission") is not None else None + _obj = cls.model_validate({ + "a_objPermission": [PermissionRequestCompound.from_dict(_item) for _item in obj.get("a_objPermission")] if obj.get("a_objPermission") is not None else None }) return _obj diff --git a/eZmaxApi/models/usergroup_edit_permissions_v1_response.py b/eZmaxApi/models/usergroup_edit_permissions_v1_response.py index 43888e853..4104927c0 100644 --- a/eZmaxApi/models/usergroup_edit_permissions_v1_response.py +++ b/eZmaxApi/models/usergroup_edit_permissions_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.usergroup_edit_permissions_v1_response_m_payload import UsergroupEditPermissionsV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class UsergroupEditPermissionsV1Response(BaseModel): """ - Response for PUT /1/object/usergroup/{pkiUsergroupID}/editPermissions # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: UsergroupEditPermissionsV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for PUT /1/object/usergroup/{pkiUsergroupID}/editPermissions + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: UsergroupEditPermissionsV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> UsergroupEditPermissionsV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of UsergroupEditPermissionsV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> UsergroupEditPermissionsV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of UsergroupEditPermissionsV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return UsergroupEditPermissionsV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = UsergroupEditPermissionsV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": UsergroupEditPermissionsV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": UsergroupEditPermissionsV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/usergroup_edit_permissions_v1_response_m_payload.py b/eZmaxApi/models/usergroup_edit_permissions_v1_response_m_payload.py index d94ce1308..c8aa3b461 100644 --- a/eZmaxApi/models/usergroup_edit_permissions_v1_response_m_payload.py +++ b/eZmaxApi/models/usergroup_edit_permissions_v1_response_m_payload.py @@ -19,53 +19,72 @@ import json -from typing import List -from pydantic import BaseModel, Field, conint, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class UsergroupEditPermissionsV1ResponseMPayload(BaseModel): """ - Payload for PUT /1/object/usergroup/{pkiUsergroupID}/editPermissions # noqa: E501 - """ - a_pki_permission_id: conlist(conint(strict=True, le=65535, ge=0)) = Field(..., alias="a_pkiPermissionID") - __properties = ["a_pkiPermissionID"] + Payload for PUT /1/object/usergroup/{pkiUsergroupID}/editPermissions + """ # noqa: E501 + a_pki_permission_id: List[Annotated[int, Field(le=65535, strict=True, ge=0)]] = Field(alias="a_pkiPermissionID") + __properties: ClassVar[List[str]] = ["a_pkiPermissionID"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> UsergroupEditPermissionsV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of UsergroupEditPermissionsV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> UsergroupEditPermissionsV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of UsergroupEditPermissionsV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return UsergroupEditPermissionsV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = UsergroupEditPermissionsV1ResponseMPayload.parse_obj({ - "a_pki_permission_id": obj.get("a_pkiPermissionID") + _obj = cls.model_validate({ + "a_pkiPermissionID": obj.get("a_pkiPermissionID") }) return _obj diff --git a/eZmaxApi/models/usergroup_edit_usergroupdelegations_v1_request.py b/eZmaxApi/models/usergroup_edit_usergroupdelegations_v1_request.py index 48261ca42..a3f032fc2 100644 --- a/eZmaxApi/models/usergroup_edit_usergroupdelegations_v1_request.py +++ b/eZmaxApi/models/usergroup_edit_usergroupdelegations_v1_request.py @@ -19,41 +19,59 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.usergroupdelegation_request_compound import UsergroupdelegationRequestCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class UsergroupEditUsergroupdelegationsV1Request(BaseModel): """ - Request for PUT /1/object/usergroup/{pkiUsergroupID}/editUsergroupdelegations # noqa: E501 - """ - a_obj_usergroupdelegation: conlist(UsergroupdelegationRequestCompound) = Field(..., alias="a_objUsergroupdelegation") - __properties = ["a_objUsergroupdelegation"] + Request for PUT /1/object/usergroup/{pkiUsergroupID}/editUsergroupdelegations + """ # noqa: E501 + a_obj_usergroupdelegation: List[UsergroupdelegationRequestCompound] = Field(alias="a_objUsergroupdelegation") + __properties: ClassVar[List[str]] = ["a_objUsergroupdelegation"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> UsergroupEditUsergroupdelegationsV1Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of UsergroupEditUsergroupdelegationsV1Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_usergroupdelegation (list) _items = [] if self.a_obj_usergroupdelegation: @@ -64,16 +82,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> UsergroupEditUsergroupdelegationsV1Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of UsergroupEditUsergroupdelegationsV1Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return UsergroupEditUsergroupdelegationsV1Request.parse_obj(obj) + return cls.model_validate(obj) - _obj = UsergroupEditUsergroupdelegationsV1Request.parse_obj({ - "a_obj_usergroupdelegation": [UsergroupdelegationRequestCompound.from_dict(_item) for _item in obj.get("a_objUsergroupdelegation")] if obj.get("a_objUsergroupdelegation") is not None else None + _obj = cls.model_validate({ + "a_objUsergroupdelegation": [UsergroupdelegationRequestCompound.from_dict(_item) for _item in obj.get("a_objUsergroupdelegation")] if obj.get("a_objUsergroupdelegation") is not None else None }) return _obj diff --git a/eZmaxApi/models/usergroup_edit_usergroupdelegations_v1_response.py b/eZmaxApi/models/usergroup_edit_usergroupdelegations_v1_response.py index d61502807..539de3fe1 100644 --- a/eZmaxApi/models/usergroup_edit_usergroupdelegations_v1_response.py +++ b/eZmaxApi/models/usergroup_edit_usergroupdelegations_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.usergroup_edit_usergroupdelegations_v1_response_m_payload import UsergroupEditUsergroupdelegationsV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class UsergroupEditUsergroupdelegationsV1Response(BaseModel): """ - Response for PUT /1/object/usergroup/{pkiUsergroupID}/editUsergroupdelegations # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: UsergroupEditUsergroupdelegationsV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for PUT /1/object/usergroup/{pkiUsergroupID}/editUsergroupdelegations + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: UsergroupEditUsergroupdelegationsV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> UsergroupEditUsergroupdelegationsV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of UsergroupEditUsergroupdelegationsV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> UsergroupEditUsergroupdelegationsV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of UsergroupEditUsergroupdelegationsV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return UsergroupEditUsergroupdelegationsV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = UsergroupEditUsergroupdelegationsV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": UsergroupEditUsergroupdelegationsV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": UsergroupEditUsergroupdelegationsV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/usergroup_edit_usergroupdelegations_v1_response_m_payload.py b/eZmaxApi/models/usergroup_edit_usergroupdelegations_v1_response_m_payload.py index 4a9327a8c..0794e5ec4 100644 --- a/eZmaxApi/models/usergroup_edit_usergroupdelegations_v1_response_m_payload.py +++ b/eZmaxApi/models/usergroup_edit_usergroupdelegations_v1_response_m_payload.py @@ -19,53 +19,72 @@ import json -from typing import List -from pydantic import BaseModel, Field, conint, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class UsergroupEditUsergroupdelegationsV1ResponseMPayload(BaseModel): """ - Response for PUT /1/object/usergroup/{pkiUsergroupID}/EditUsergroupdelegations # noqa: E501 - """ - a_pki_usergroupdelegation_id: conlist(conint(strict=True, le=65535, ge=0)) = Field(..., alias="a_pkiUsergroupdelegationID") - __properties = ["a_pkiUsergroupdelegationID"] + Response for PUT /1/object/usergroup/{pkiUsergroupID}/EditUsergroupdelegations + """ # noqa: E501 + a_pki_usergroupdelegation_id: List[Annotated[int, Field(le=65535, strict=True, ge=0)]] = Field(alias="a_pkiUsergroupdelegationID") + __properties: ClassVar[List[str]] = ["a_pkiUsergroupdelegationID"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> UsergroupEditUsergroupdelegationsV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of UsergroupEditUsergroupdelegationsV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> UsergroupEditUsergroupdelegationsV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of UsergroupEditUsergroupdelegationsV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return UsergroupEditUsergroupdelegationsV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = UsergroupEditUsergroupdelegationsV1ResponseMPayload.parse_obj({ - "a_pki_usergroupdelegation_id": obj.get("a_pkiUsergroupdelegationID") + _obj = cls.model_validate({ + "a_pkiUsergroupdelegationID": obj.get("a_pkiUsergroupdelegationID") }) return _obj diff --git a/eZmaxApi/models/usergroup_edit_usergroupmemberships_v1_request.py b/eZmaxApi/models/usergroup_edit_usergroupmemberships_v1_request.py index 185c708ef..6860e36ae 100644 --- a/eZmaxApi/models/usergroup_edit_usergroupmemberships_v1_request.py +++ b/eZmaxApi/models/usergroup_edit_usergroupmemberships_v1_request.py @@ -19,41 +19,59 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.usergroupmembership_request_compound import UsergroupmembershipRequestCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class UsergroupEditUsergroupmembershipsV1Request(BaseModel): """ - Request for PUT /1/object/usergroup/{pkiUsergroupID}/editUsergroupmemberships # noqa: E501 - """ - a_obj_usergroupmembership: conlist(UsergroupmembershipRequestCompound) = Field(..., alias="a_objUsergroupmembership") - __properties = ["a_objUsergroupmembership"] + Request for PUT /1/object/usergroup/{pkiUsergroupID}/editUsergroupmemberships + """ # noqa: E501 + a_obj_usergroupmembership: List[UsergroupmembershipRequestCompound] = Field(alias="a_objUsergroupmembership") + __properties: ClassVar[List[str]] = ["a_objUsergroupmembership"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> UsergroupEditUsergroupmembershipsV1Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of UsergroupEditUsergroupmembershipsV1Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_usergroupmembership (list) _items = [] if self.a_obj_usergroupmembership: @@ -64,16 +82,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> UsergroupEditUsergroupmembershipsV1Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of UsergroupEditUsergroupmembershipsV1Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return UsergroupEditUsergroupmembershipsV1Request.parse_obj(obj) + return cls.model_validate(obj) - _obj = UsergroupEditUsergroupmembershipsV1Request.parse_obj({ - "a_obj_usergroupmembership": [UsergroupmembershipRequestCompound.from_dict(_item) for _item in obj.get("a_objUsergroupmembership")] if obj.get("a_objUsergroupmembership") is not None else None + _obj = cls.model_validate({ + "a_objUsergroupmembership": [UsergroupmembershipRequestCompound.from_dict(_item) for _item in obj.get("a_objUsergroupmembership")] if obj.get("a_objUsergroupmembership") is not None else None }) return _obj diff --git a/eZmaxApi/models/usergroup_edit_usergroupmemberships_v1_response.py b/eZmaxApi/models/usergroup_edit_usergroupmemberships_v1_response.py index 6ad78063c..5c7199e25 100644 --- a/eZmaxApi/models/usergroup_edit_usergroupmemberships_v1_response.py +++ b/eZmaxApi/models/usergroup_edit_usergroupmemberships_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.usergroup_edit_usergroupmemberships_v1_response_m_payload import UsergroupEditUsergroupmembershipsV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class UsergroupEditUsergroupmembershipsV1Response(BaseModel): """ - Response for PUT /1/object/usergroup/{pkiUsergroupID}/editUsergroupmemberships # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: UsergroupEditUsergroupmembershipsV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for PUT /1/object/usergroup/{pkiUsergroupID}/editUsergroupmemberships + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: UsergroupEditUsergroupmembershipsV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> UsergroupEditUsergroupmembershipsV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of UsergroupEditUsergroupmembershipsV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> UsergroupEditUsergroupmembershipsV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of UsergroupEditUsergroupmembershipsV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return UsergroupEditUsergroupmembershipsV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = UsergroupEditUsergroupmembershipsV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": UsergroupEditUsergroupmembershipsV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": UsergroupEditUsergroupmembershipsV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/usergroup_edit_usergroupmemberships_v1_response_m_payload.py b/eZmaxApi/models/usergroup_edit_usergroupmemberships_v1_response_m_payload.py index 7c7eca6fd..2abc55020 100644 --- a/eZmaxApi/models/usergroup_edit_usergroupmemberships_v1_response_m_payload.py +++ b/eZmaxApi/models/usergroup_edit_usergroupmemberships_v1_response_m_payload.py @@ -19,53 +19,72 @@ import json -from typing import List -from pydantic import BaseModel, Field, conint, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class UsergroupEditUsergroupmembershipsV1ResponseMPayload(BaseModel): """ - Response for PUT /1/object/usergroup/{pkiUsergroupID}/editUsergroupmemberships # noqa: E501 - """ - a_pki_usergroupmembership_id: conlist(conint(strict=True, le=65535, ge=0)) = Field(..., alias="a_pkiUsergroupmembershipID") - __properties = ["a_pkiUsergroupmembershipID"] + Response for PUT /1/object/usergroup/{pkiUsergroupID}/editUsergroupmemberships + """ # noqa: E501 + a_pki_usergroupmembership_id: List[Annotated[int, Field(le=65535, strict=True, ge=0)]] = Field(alias="a_pkiUsergroupmembershipID") + __properties: ClassVar[List[str]] = ["a_pkiUsergroupmembershipID"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> UsergroupEditUsergroupmembershipsV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of UsergroupEditUsergroupmembershipsV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> UsergroupEditUsergroupmembershipsV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of UsergroupEditUsergroupmembershipsV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return UsergroupEditUsergroupmembershipsV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = UsergroupEditUsergroupmembershipsV1ResponseMPayload.parse_obj({ - "a_pki_usergroupmembership_id": obj.get("a_pkiUsergroupmembershipID") + _obj = cls.model_validate({ + "a_pkiUsergroupmembershipID": obj.get("a_pkiUsergroupmembershipID") }) return _obj diff --git a/eZmaxApi/models/usergroup_get_autocomplete_v2_response.py b/eZmaxApi/models/usergroup_get_autocomplete_v2_response.py index 1ab39c523..185d4c8f2 100644 --- a/eZmaxApi/models/usergroup_get_autocomplete_v2_response.py +++ b/eZmaxApi/models/usergroup_get_autocomplete_v2_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.usergroup_get_autocomplete_v2_response_m_payload import UsergroupGetAutocompleteV2ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class UsergroupGetAutocompleteV2Response(BaseModel): """ - Response for GET /2/object/usergroup/getAutocomplete # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: UsergroupGetAutocompleteV2ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /2/object/usergroup/getAutocomplete + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: UsergroupGetAutocompleteV2ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> UsergroupGetAutocompleteV2Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of UsergroupGetAutocompleteV2Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> UsergroupGetAutocompleteV2Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of UsergroupGetAutocompleteV2Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return UsergroupGetAutocompleteV2Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = UsergroupGetAutocompleteV2Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": UsergroupGetAutocompleteV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": UsergroupGetAutocompleteV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/usergroup_get_autocomplete_v2_response_m_payload.py b/eZmaxApi/models/usergroup_get_autocomplete_v2_response_m_payload.py index 66a90ae36..01806522d 100644 --- a/eZmaxApi/models/usergroup_get_autocomplete_v2_response_m_payload.py +++ b/eZmaxApi/models/usergroup_get_autocomplete_v2_response_m_payload.py @@ -19,41 +19,59 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.usergroup_autocomplete_element_response import UsergroupAutocompleteElementResponse +try: + from typing import Self +except ImportError: + from typing_extensions import Self class UsergroupGetAutocompleteV2ResponseMPayload(BaseModel): """ - Payload for POST /2/object/usergroup/getAutocomplete # noqa: E501 - """ - a_obj_usergroup: conlist(UsergroupAutocompleteElementResponse) = Field(..., alias="a_objUsergroup", description="An array of Usergroup autocomplete element response.") - __properties = ["a_objUsergroup"] + Payload for POST /2/object/usergroup/getAutocomplete + """ # noqa: E501 + a_obj_usergroup: List[UsergroupAutocompleteElementResponse] = Field(description="An array of Usergroup autocomplete element response.", alias="a_objUsergroup") + __properties: ClassVar[List[str]] = ["a_objUsergroup"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> UsergroupGetAutocompleteV2ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of UsergroupGetAutocompleteV2ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_usergroup (list) _items = [] if self.a_obj_usergroup: @@ -64,16 +82,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> UsergroupGetAutocompleteV2ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of UsergroupGetAutocompleteV2ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return UsergroupGetAutocompleteV2ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = UsergroupGetAutocompleteV2ResponseMPayload.parse_obj({ - "a_obj_usergroup": [UsergroupAutocompleteElementResponse.from_dict(_item) for _item in obj.get("a_objUsergroup")] if obj.get("a_objUsergroup") is not None else None + _obj = cls.model_validate({ + "a_objUsergroup": [UsergroupAutocompleteElementResponse.from_dict(_item) for _item in obj.get("a_objUsergroup")] if obj.get("a_objUsergroup") is not None else None }) return _obj diff --git a/eZmaxApi/models/usergroup_get_list_v1_response.py b/eZmaxApi/models/usergroup_get_list_v1_response.py index a9ff62f5c..1f43163f5 100644 --- a/eZmaxApi/models/usergroup_get_list_v1_response.py +++ b/eZmaxApi/models/usergroup_get_list_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload_get_list import CommonResponseObjDebugPayloadGetList from eZmaxApi.models.usergroup_get_list_v1_response_m_payload import UsergroupGetListV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class UsergroupGetListV1Response(BaseModel): """ - Response for GET /1/object/usergroup/getList # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayloadGetList = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: UsergroupGetListV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /1/object/usergroup/getList + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayloadGetList = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: UsergroupGetListV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> UsergroupGetListV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of UsergroupGetListV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> UsergroupGetListV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of UsergroupGetListV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return UsergroupGetListV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = UsergroupGetListV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayloadGetList.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": UsergroupGetListV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayloadGetList.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": UsergroupGetListV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/usergroup_get_list_v1_response_m_payload.py b/eZmaxApi/models/usergroup_get_list_v1_response_m_payload.py index cff75288a..c959796af 100644 --- a/eZmaxApi/models/usergroup_get_list_v1_response_m_payload.py +++ b/eZmaxApi/models/usergroup_get_list_v1_response_m_payload.py @@ -19,43 +19,61 @@ import json -from typing import List -from pydantic import BaseModel, Field, StrictInt, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictInt +from pydantic import Field from eZmaxApi.models.usergroup_list_element import UsergroupListElement +try: + from typing import Self +except ImportError: + from typing_extensions import Self class UsergroupGetListV1ResponseMPayload(BaseModel): """ - Payload for GET /1/object/usergroup/getList # noqa: E501 - """ - i_row_returned: StrictInt = Field(..., alias="iRowReturned", description="The number of rows returned") - i_row_filtered: StrictInt = Field(..., alias="iRowFiltered", description="The number of rows matching your filters (if any) or the total number of rows") - a_obj_usergroup: conlist(UsergroupListElement) = Field(..., alias="a_objUsergroup") - __properties = ["iRowReturned", "iRowFiltered", "a_objUsergroup"] + Payload for GET /1/object/usergroup/getList + """ # noqa: E501 + i_row_returned: StrictInt = Field(description="The number of rows returned", alias="iRowReturned") + i_row_filtered: StrictInt = Field(description="The number of rows matching your filters (if any) or the total number of rows", alias="iRowFiltered") + a_obj_usergroup: List[UsergroupListElement] = Field(alias="a_objUsergroup") + __properties: ClassVar[List[str]] = ["iRowReturned", "iRowFiltered", "a_objUsergroup"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> UsergroupGetListV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of UsergroupGetListV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_usergroup (list) _items = [] if self.a_obj_usergroup: @@ -66,18 +84,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> UsergroupGetListV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of UsergroupGetListV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return UsergroupGetListV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = UsergroupGetListV1ResponseMPayload.parse_obj({ - "i_row_returned": obj.get("iRowReturned"), - "i_row_filtered": obj.get("iRowFiltered"), - "a_obj_usergroup": [UsergroupListElement.from_dict(_item) for _item in obj.get("a_objUsergroup")] if obj.get("a_objUsergroup") is not None else None + _obj = cls.model_validate({ + "iRowReturned": obj.get("iRowReturned"), + "iRowFiltered": obj.get("iRowFiltered"), + "a_objUsergroup": [UsergroupListElement.from_dict(_item) for _item in obj.get("a_objUsergroup")] if obj.get("a_objUsergroup") is not None else None }) return _obj diff --git a/eZmaxApi/models/usergroup_get_object_v2_response.py b/eZmaxApi/models/usergroup_get_object_v2_response.py index 70f7118d4..1e70a056c 100644 --- a/eZmaxApi/models/usergroup_get_object_v2_response.py +++ b/eZmaxApi/models/usergroup_get_object_v2_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.usergroup_get_object_v2_response_m_payload import UsergroupGetObjectV2ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class UsergroupGetObjectV2Response(BaseModel): """ - Response for GET /2/object/usergroup/{pkiUsergroupID} # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: UsergroupGetObjectV2ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /2/object/usergroup/{pkiUsergroupID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: UsergroupGetObjectV2ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> UsergroupGetObjectV2Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of UsergroupGetObjectV2Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> UsergroupGetObjectV2Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of UsergroupGetObjectV2Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return UsergroupGetObjectV2Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = UsergroupGetObjectV2Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": UsergroupGetObjectV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": UsergroupGetObjectV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/usergroup_get_object_v2_response_m_payload.py b/eZmaxApi/models/usergroup_get_object_v2_response_m_payload.py index 60ca62806..45edbe7fa 100644 --- a/eZmaxApi/models/usergroup_get_object_v2_response_m_payload.py +++ b/eZmaxApi/models/usergroup_get_object_v2_response_m_payload.py @@ -19,57 +19,75 @@ import json - -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.usergroup_response_compound import UsergroupResponseCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class UsergroupGetObjectV2ResponseMPayload(BaseModel): """ - Payload for GET /2/object/usergroup/{pkiUsergroupID} # noqa: E501 - """ - obj_usergroup: UsergroupResponseCompound = Field(..., alias="objUsergroup") - __properties = ["objUsergroup"] + Payload for GET /2/object/usergroup/{pkiUsergroupID} + """ # noqa: E501 + obj_usergroup: UsergroupResponseCompound = Field(alias="objUsergroup") + __properties: ClassVar[List[str]] = ["objUsergroup"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> UsergroupGetObjectV2ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of UsergroupGetObjectV2ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_usergroup if self.obj_usergroup: _dict['objUsergroup'] = self.obj_usergroup.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> UsergroupGetObjectV2ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of UsergroupGetObjectV2ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return UsergroupGetObjectV2ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = UsergroupGetObjectV2ResponseMPayload.parse_obj({ - "obj_usergroup": UsergroupResponseCompound.from_dict(obj.get("objUsergroup")) if obj.get("objUsergroup") is not None else None + _obj = cls.model_validate({ + "objUsergroup": UsergroupResponseCompound.from_dict(obj.get("objUsergroup")) if obj.get("objUsergroup") is not None else None }) return _obj diff --git a/eZmaxApi/models/usergroup_get_permissions_v1_response.py b/eZmaxApi/models/usergroup_get_permissions_v1_response.py index 4289c12ba..9d0219927 100644 --- a/eZmaxApi/models/usergroup_get_permissions_v1_response.py +++ b/eZmaxApi/models/usergroup_get_permissions_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.usergroup_get_permissions_v1_response_m_payload import UsergroupGetPermissionsV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class UsergroupGetPermissionsV1Response(BaseModel): """ - Response for GET /1/object/usergroup/{pkiUsergroupID}/getPermissions # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: UsergroupGetPermissionsV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /1/object/usergroup/{pkiUsergroupID}/getPermissions + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: UsergroupGetPermissionsV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> UsergroupGetPermissionsV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of UsergroupGetPermissionsV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> UsergroupGetPermissionsV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of UsergroupGetPermissionsV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return UsergroupGetPermissionsV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = UsergroupGetPermissionsV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": UsergroupGetPermissionsV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": UsergroupGetPermissionsV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/usergroup_get_permissions_v1_response_m_payload.py b/eZmaxApi/models/usergroup_get_permissions_v1_response_m_payload.py index 91f75a847..4841a2eac 100644 --- a/eZmaxApi/models/usergroup_get_permissions_v1_response_m_payload.py +++ b/eZmaxApi/models/usergroup_get_permissions_v1_response_m_payload.py @@ -19,41 +19,59 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.modulegroup_response_compound import ModulegroupResponseCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class UsergroupGetPermissionsV1ResponseMPayload(BaseModel): """ - Response for GET /1/object/usergroup/{pkiUsergroupID}/getPermissions # noqa: E501 - """ - a_obj_modulegroup: conlist(ModulegroupResponseCompound) = Field(..., alias="a_objModulegroup") - __properties = ["a_objModulegroup"] + Response for GET /1/object/usergroup/{pkiUsergroupID}/getPermissions + """ # noqa: E501 + a_obj_modulegroup: List[ModulegroupResponseCompound] = Field(alias="a_objModulegroup") + __properties: ClassVar[List[str]] = ["a_objModulegroup"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> UsergroupGetPermissionsV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of UsergroupGetPermissionsV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_modulegroup (list) _items = [] if self.a_obj_modulegroup: @@ -64,16 +82,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> UsergroupGetPermissionsV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of UsergroupGetPermissionsV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return UsergroupGetPermissionsV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = UsergroupGetPermissionsV1ResponseMPayload.parse_obj({ - "a_obj_modulegroup": [ModulegroupResponseCompound.from_dict(_item) for _item in obj.get("a_objModulegroup")] if obj.get("a_objModulegroup") is not None else None + _obj = cls.model_validate({ + "a_objModulegroup": [ModulegroupResponseCompound.from_dict(_item) for _item in obj.get("a_objModulegroup")] if obj.get("a_objModulegroup") is not None else None }) return _obj diff --git a/eZmaxApi/models/usergroup_get_usergroupdelegations_v1_response.py b/eZmaxApi/models/usergroup_get_usergroupdelegations_v1_response.py index ed43fb647..587a39b1b 100644 --- a/eZmaxApi/models/usergroup_get_usergroupdelegations_v1_response.py +++ b/eZmaxApi/models/usergroup_get_usergroupdelegations_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.usergroup_get_usergroupdelegations_v1_response_m_payload import UsergroupGetUsergroupdelegationsV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class UsergroupGetUsergroupdelegationsV1Response(BaseModel): """ - Response for GET /1/object/usergroup/{pkiUsergroupID}/getUsergroupdelegations # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: UsergroupGetUsergroupdelegationsV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /1/object/usergroup/{pkiUsergroupID}/getUsergroupdelegations + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: UsergroupGetUsergroupdelegationsV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> UsergroupGetUsergroupdelegationsV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of UsergroupGetUsergroupdelegationsV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> UsergroupGetUsergroupdelegationsV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of UsergroupGetUsergroupdelegationsV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return UsergroupGetUsergroupdelegationsV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = UsergroupGetUsergroupdelegationsV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": UsergroupGetUsergroupdelegationsV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": UsergroupGetUsergroupdelegationsV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/usergroup_get_usergroupdelegations_v1_response_m_payload.py b/eZmaxApi/models/usergroup_get_usergroupdelegations_v1_response_m_payload.py index 9958d0b73..1c27e280e 100644 --- a/eZmaxApi/models/usergroup_get_usergroupdelegations_v1_response_m_payload.py +++ b/eZmaxApi/models/usergroup_get_usergroupdelegations_v1_response_m_payload.py @@ -19,41 +19,59 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.usergroupdelegation_response_compound import UsergroupdelegationResponseCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class UsergroupGetUsergroupdelegationsV1ResponseMPayload(BaseModel): """ - Response for GET /1/object/usergroup/{pkiUsergroupID}/getUsergroupdelegations # noqa: E501 - """ - a_obj_usergroupdelegation: conlist(UsergroupdelegationResponseCompound) = Field(..., alias="a_objUsergroupdelegation") - __properties = ["a_objUsergroupdelegation"] + Response for GET /1/object/usergroup/{pkiUsergroupID}/getUsergroupdelegations + """ # noqa: E501 + a_obj_usergroupdelegation: List[UsergroupdelegationResponseCompound] = Field(alias="a_objUsergroupdelegation") + __properties: ClassVar[List[str]] = ["a_objUsergroupdelegation"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> UsergroupGetUsergroupdelegationsV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of UsergroupGetUsergroupdelegationsV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_usergroupdelegation (list) _items = [] if self.a_obj_usergroupdelegation: @@ -64,16 +82,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> UsergroupGetUsergroupdelegationsV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of UsergroupGetUsergroupdelegationsV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return UsergroupGetUsergroupdelegationsV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = UsergroupGetUsergroupdelegationsV1ResponseMPayload.parse_obj({ - "a_obj_usergroupdelegation": [UsergroupdelegationResponseCompound.from_dict(_item) for _item in obj.get("a_objUsergroupdelegation")] if obj.get("a_objUsergroupdelegation") is not None else None + _obj = cls.model_validate({ + "a_objUsergroupdelegation": [UsergroupdelegationResponseCompound.from_dict(_item) for _item in obj.get("a_objUsergroupdelegation")] if obj.get("a_objUsergroupdelegation") is not None else None }) return _obj diff --git a/eZmaxApi/models/usergroup_get_usergroupmemberships_v1_response.py b/eZmaxApi/models/usergroup_get_usergroupmemberships_v1_response.py index cb8a43bf5..c71dcc086 100644 --- a/eZmaxApi/models/usergroup_get_usergroupmemberships_v1_response.py +++ b/eZmaxApi/models/usergroup_get_usergroupmemberships_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.usergroup_get_usergroupmemberships_v1_response_m_payload import UsergroupGetUsergroupmembershipsV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class UsergroupGetUsergroupmembershipsV1Response(BaseModel): """ - Response for GET /1/object/usergroup/{pkiUsergroupID}/getUsergroupmemberships # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: UsergroupGetUsergroupmembershipsV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /1/object/usergroup/{pkiUsergroupID}/getUsergroupmemberships + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: UsergroupGetUsergroupmembershipsV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> UsergroupGetUsergroupmembershipsV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of UsergroupGetUsergroupmembershipsV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> UsergroupGetUsergroupmembershipsV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of UsergroupGetUsergroupmembershipsV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return UsergroupGetUsergroupmembershipsV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = UsergroupGetUsergroupmembershipsV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": UsergroupGetUsergroupmembershipsV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": UsergroupGetUsergroupmembershipsV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/usergroup_get_usergroupmemberships_v1_response_m_payload.py b/eZmaxApi/models/usergroup_get_usergroupmemberships_v1_response_m_payload.py index c316ca5da..566760125 100644 --- a/eZmaxApi/models/usergroup_get_usergroupmemberships_v1_response_m_payload.py +++ b/eZmaxApi/models/usergroup_get_usergroupmemberships_v1_response_m_payload.py @@ -19,41 +19,59 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.usergroupmembership_response_compound import UsergroupmembershipResponseCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class UsergroupGetUsergroupmembershipsV1ResponseMPayload(BaseModel): """ - Response for GET /1/object/usergroup/{pkiUsergroupID}/getUsergroupmemberships # noqa: E501 - """ - a_obj_usergroupmembership: conlist(UsergroupmembershipResponseCompound) = Field(..., alias="a_objUsergroupmembership") - __properties = ["a_objUsergroupmembership"] + Response for GET /1/object/usergroup/{pkiUsergroupID}/getUsergroupmemberships + """ # noqa: E501 + a_obj_usergroupmembership: List[UsergroupmembershipResponseCompound] = Field(alias="a_objUsergroupmembership") + __properties: ClassVar[List[str]] = ["a_objUsergroupmembership"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> UsergroupGetUsergroupmembershipsV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of UsergroupGetUsergroupmembershipsV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_usergroupmembership (list) _items = [] if self.a_obj_usergroupmembership: @@ -64,16 +82,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> UsergroupGetUsergroupmembershipsV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of UsergroupGetUsergroupmembershipsV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return UsergroupGetUsergroupmembershipsV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = UsergroupGetUsergroupmembershipsV1ResponseMPayload.parse_obj({ - "a_obj_usergroupmembership": [UsergroupmembershipResponseCompound.from_dict(_item) for _item in obj.get("a_objUsergroupmembership")] if obj.get("a_objUsergroupmembership") is not None else None + _obj = cls.model_validate({ + "a_objUsergroupmembership": [UsergroupmembershipResponseCompound.from_dict(_item) for _item in obj.get("a_objUsergroupmembership")] if obj.get("a_objUsergroupmembership") is not None else None }) return _obj diff --git a/eZmaxApi/models/usergroup_list_element.py b/eZmaxApi/models/usergroup_list_element.py index 457ad19ef..82fddcf37 100644 --- a/eZmaxApi/models/usergroup_list_element.py +++ b/eZmaxApi/models/usergroup_list_element.py @@ -19,64 +19,83 @@ import json - -from pydantic import BaseModel, Field, conint, constr, validator +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, field_validator +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class UsergroupListElement(BaseModel): """ - A Usergroup List Element # noqa: E501 - """ - pki_usergroup_id: conint(strict=True, le=255, ge=0) = Field(..., alias="pkiUsergroupID", description="The unique ID of the Usergroup") - s_usergroup_name_x: constr(strict=True) = Field(..., alias="sUsergroupNameX", description="The Name of the Usergroup in the language of the requester") - i_count_user: conint(strict=True, le=16777215, ge=0) = Field(..., alias="iCountUser", description="Number of users in group") - __properties = ["pkiUsergroupID", "sUsergroupNameX", "iCountUser"] - - @validator('s_usergroup_name_x') + A Usergroup List Element + """ # noqa: E501 + pki_usergroup_id: Annotated[int, Field(le=255, strict=True, ge=0)] = Field(description="The unique ID of the Usergroup", alias="pkiUsergroupID") + s_usergroup_name_x: Annotated[str, Field(strict=True)] = Field(description="The Name of the Usergroup in the language of the requester", alias="sUsergroupNameX") + i_count_user: Annotated[int, Field(le=16777215, strict=True, ge=0)] = Field(description="Number of users in group", alias="iCountUser") + __properties: ClassVar[List[str]] = ["pkiUsergroupID", "sUsergroupNameX", "iCountUser"] + + @field_validator('s_usergroup_name_x') def s_usergroup_name_x_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^.{0,50}$", value): raise ValueError(r"must validate the regular expression /^.{0,50}$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> UsergroupListElement: + def from_json(cls, json_str: str) -> Self: """Create an instance of UsergroupListElement from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> UsergroupListElement: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of UsergroupListElement from a dict""" if obj is None: return None if not isinstance(obj, dict): - return UsergroupListElement.parse_obj(obj) + return cls.model_validate(obj) - _obj = UsergroupListElement.parse_obj({ - "pki_usergroup_id": obj.get("pkiUsergroupID"), - "s_usergroup_name_x": obj.get("sUsergroupNameX"), - "i_count_user": obj.get("iCountUser") + _obj = cls.model_validate({ + "pkiUsergroupID": obj.get("pkiUsergroupID"), + "sUsergroupNameX": obj.get("sUsergroupNameX"), + "iCountUser": obj.get("iCountUser") }) return _obj diff --git a/eZmaxApi/models/usergroup_request.py b/eZmaxApi/models/usergroup_request.py index 92dca39b5..ad0a172fb 100644 --- a/eZmaxApi/models/usergroup_request.py +++ b/eZmaxApi/models/usergroup_request.py @@ -19,59 +19,78 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.multilingual_usergroup_name import MultilingualUsergroupName +try: + from typing import Self +except ImportError: + from typing_extensions import Self class UsergroupRequest(BaseModel): """ - A Usergroup Object # noqa: E501 - """ - pki_usergroup_id: Optional[conint(strict=True, le=255, ge=0)] = Field(None, alias="pkiUsergroupID", description="The unique ID of the Usergroup") - obj_usergroup_name: MultilingualUsergroupName = Field(..., alias="objUsergroupName") - __properties = ["pkiUsergroupID", "objUsergroupName"] + A Usergroup Object + """ # noqa: E501 + pki_usergroup_id: Optional[Annotated[int, Field(le=255, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Usergroup", alias="pkiUsergroupID") + obj_usergroup_name: MultilingualUsergroupName = Field(alias="objUsergroupName") + __properties: ClassVar[List[str]] = ["pkiUsergroupID", "objUsergroupName"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> UsergroupRequest: + def from_json(cls, json_str: str) -> Self: """Create an instance of UsergroupRequest from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_usergroup_name if self.obj_usergroup_name: _dict['objUsergroupName'] = self.obj_usergroup_name.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> UsergroupRequest: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of UsergroupRequest from a dict""" if obj is None: return None if not isinstance(obj, dict): - return UsergroupRequest.parse_obj(obj) + return cls.model_validate(obj) - _obj = UsergroupRequest.parse_obj({ - "pki_usergroup_id": obj.get("pkiUsergroupID"), - "obj_usergroup_name": MultilingualUsergroupName.from_dict(obj.get("objUsergroupName")) if obj.get("objUsergroupName") is not None else None + _obj = cls.model_validate({ + "pkiUsergroupID": obj.get("pkiUsergroupID"), + "objUsergroupName": MultilingualUsergroupName.from_dict(obj.get("objUsergroupName")) if obj.get("objUsergroupName") is not None else None }) return _obj diff --git a/eZmaxApi/models/usergroup_request_compound.py b/eZmaxApi/models/usergroup_request_compound.py index 3f58defd4..0ebfa9fcb 100644 --- a/eZmaxApi/models/usergroup_request_compound.py +++ b/eZmaxApi/models/usergroup_request_compound.py @@ -19,59 +19,78 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.multilingual_usergroup_name import MultilingualUsergroupName +try: + from typing import Self +except ImportError: + from typing_extensions import Self class UsergroupRequestCompound(BaseModel): """ - A Usergroup Object and children # noqa: E501 - """ - pki_usergroup_id: Optional[conint(strict=True, le=255, ge=0)] = Field(None, alias="pkiUsergroupID", description="The unique ID of the Usergroup") - obj_usergroup_name: MultilingualUsergroupName = Field(..., alias="objUsergroupName") - __properties = ["pkiUsergroupID", "objUsergroupName"] + A Usergroup Object and children + """ # noqa: E501 + pki_usergroup_id: Optional[Annotated[int, Field(le=255, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Usergroup", alias="pkiUsergroupID") + obj_usergroup_name: MultilingualUsergroupName = Field(alias="objUsergroupName") + __properties: ClassVar[List[str]] = ["pkiUsergroupID", "objUsergroupName"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> UsergroupRequestCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of UsergroupRequestCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_usergroup_name if self.obj_usergroup_name: _dict['objUsergroupName'] = self.obj_usergroup_name.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> UsergroupRequestCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of UsergroupRequestCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return UsergroupRequestCompound.parse_obj(obj) + return cls.model_validate(obj) - _obj = UsergroupRequestCompound.parse_obj({ - "pki_usergroup_id": obj.get("pkiUsergroupID"), - "obj_usergroup_name": MultilingualUsergroupName.from_dict(obj.get("objUsergroupName")) if obj.get("objUsergroupName") is not None else None + _obj = cls.model_validate({ + "pkiUsergroupID": obj.get("pkiUsergroupID"), + "objUsergroupName": MultilingualUsergroupName.from_dict(obj.get("objUsergroupName")) if obj.get("objUsergroupName") is not None else None }) return _obj diff --git a/eZmaxApi/models/usergroup_response.py b/eZmaxApi/models/usergroup_response.py index 92a6426b6..843489c40 100644 --- a/eZmaxApi/models/usergroup_response.py +++ b/eZmaxApi/models/usergroup_response.py @@ -19,59 +19,78 @@ import json - -from pydantic import BaseModel, Field, conint +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.multilingual_usergroup_name import MultilingualUsergroupName +try: + from typing import Self +except ImportError: + from typing_extensions import Self class UsergroupResponse(BaseModel): """ - A Usergroup Object # noqa: E501 - """ - pki_usergroup_id: conint(strict=True, le=255, ge=0) = Field(..., alias="pkiUsergroupID", description="The unique ID of the Usergroup") - obj_usergroup_name: MultilingualUsergroupName = Field(..., alias="objUsergroupName") - __properties = ["pkiUsergroupID", "objUsergroupName"] + A Usergroup Object + """ # noqa: E501 + pki_usergroup_id: Annotated[int, Field(le=255, strict=True, ge=0)] = Field(description="The unique ID of the Usergroup", alias="pkiUsergroupID") + obj_usergroup_name: MultilingualUsergroupName = Field(alias="objUsergroupName") + __properties: ClassVar[List[str]] = ["pkiUsergroupID", "objUsergroupName"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> UsergroupResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of UsergroupResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_usergroup_name if self.obj_usergroup_name: _dict['objUsergroupName'] = self.obj_usergroup_name.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> UsergroupResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of UsergroupResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return UsergroupResponse.parse_obj(obj) + return cls.model_validate(obj) - _obj = UsergroupResponse.parse_obj({ - "pki_usergroup_id": obj.get("pkiUsergroupID"), - "obj_usergroup_name": MultilingualUsergroupName.from_dict(obj.get("objUsergroupName")) if obj.get("objUsergroupName") is not None else None + _obj = cls.model_validate({ + "pkiUsergroupID": obj.get("pkiUsergroupID"), + "objUsergroupName": MultilingualUsergroupName.from_dict(obj.get("objUsergroupName")) if obj.get("objUsergroupName") is not None else None }) return _obj diff --git a/eZmaxApi/models/usergroup_response_compound.py b/eZmaxApi/models/usergroup_response_compound.py index c607adafc..8b47f0088 100644 --- a/eZmaxApi/models/usergroup_response_compound.py +++ b/eZmaxApi/models/usergroup_response_compound.py @@ -19,59 +19,78 @@ import json - -from pydantic import BaseModel, Field, conint +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.multilingual_usergroup_name import MultilingualUsergroupName +try: + from typing import Self +except ImportError: + from typing_extensions import Self class UsergroupResponseCompound(BaseModel): """ - A Usergroup Object # noqa: E501 - """ - pki_usergroup_id: conint(strict=True, le=255, ge=0) = Field(..., alias="pkiUsergroupID", description="The unique ID of the Usergroup") - obj_usergroup_name: MultilingualUsergroupName = Field(..., alias="objUsergroupName") - __properties = ["pkiUsergroupID", "objUsergroupName"] + A Usergroup Object + """ # noqa: E501 + pki_usergroup_id: Annotated[int, Field(le=255, strict=True, ge=0)] = Field(description="The unique ID of the Usergroup", alias="pkiUsergroupID") + obj_usergroup_name: MultilingualUsergroupName = Field(alias="objUsergroupName") + __properties: ClassVar[List[str]] = ["pkiUsergroupID", "objUsergroupName"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> UsergroupResponseCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of UsergroupResponseCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_usergroup_name if self.obj_usergroup_name: _dict['objUsergroupName'] = self.obj_usergroup_name.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> UsergroupResponseCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of UsergroupResponseCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return UsergroupResponseCompound.parse_obj(obj) + return cls.model_validate(obj) - _obj = UsergroupResponseCompound.parse_obj({ - "pki_usergroup_id": obj.get("pkiUsergroupID"), - "obj_usergroup_name": MultilingualUsergroupName.from_dict(obj.get("objUsergroupName")) if obj.get("objUsergroupName") is not None else None + _obj = cls.model_validate({ + "pkiUsergroupID": obj.get("pkiUsergroupID"), + "objUsergroupName": MultilingualUsergroupName.from_dict(obj.get("objUsergroupName")) if obj.get("objUsergroupName") is not None else None }) return _obj diff --git a/eZmaxApi/models/usergroupdelegation_create_object_v1_request.py b/eZmaxApi/models/usergroupdelegation_create_object_v1_request.py index 97bae5ce9..3e2bc4a39 100644 --- a/eZmaxApi/models/usergroupdelegation_create_object_v1_request.py +++ b/eZmaxApi/models/usergroupdelegation_create_object_v1_request.py @@ -19,41 +19,60 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.usergroupdelegation_request_compound import UsergroupdelegationRequestCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class UsergroupdelegationCreateObjectV1Request(BaseModel): """ - Request for POST /1/object/usergroupdelegation # noqa: E501 - """ - a_obj_usergroupdelegation: conlist(UsergroupdelegationRequestCompound, min_items=1) = Field(..., alias="a_objUsergroupdelegation") - __properties = ["a_objUsergroupdelegation"] + Request for POST /1/object/usergroupdelegation + """ # noqa: E501 + a_obj_usergroupdelegation: Annotated[List[UsergroupdelegationRequestCompound], Field(min_length=1)] = Field(alias="a_objUsergroupdelegation") + __properties: ClassVar[List[str]] = ["a_objUsergroupdelegation"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> UsergroupdelegationCreateObjectV1Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of UsergroupdelegationCreateObjectV1Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_usergroupdelegation (list) _items = [] if self.a_obj_usergroupdelegation: @@ -64,16 +83,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> UsergroupdelegationCreateObjectV1Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of UsergroupdelegationCreateObjectV1Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return UsergroupdelegationCreateObjectV1Request.parse_obj(obj) + return cls.model_validate(obj) - _obj = UsergroupdelegationCreateObjectV1Request.parse_obj({ - "a_obj_usergroupdelegation": [UsergroupdelegationRequestCompound.from_dict(_item) for _item in obj.get("a_objUsergroupdelegation")] if obj.get("a_objUsergroupdelegation") is not None else None + _obj = cls.model_validate({ + "a_objUsergroupdelegation": [UsergroupdelegationRequestCompound.from_dict(_item) for _item in obj.get("a_objUsergroupdelegation")] if obj.get("a_objUsergroupdelegation") is not None else None }) return _obj diff --git a/eZmaxApi/models/usergroupdelegation_create_object_v1_response.py b/eZmaxApi/models/usergroupdelegation_create_object_v1_response.py index 341a9421d..62c25c3e9 100644 --- a/eZmaxApi/models/usergroupdelegation_create_object_v1_response.py +++ b/eZmaxApi/models/usergroupdelegation_create_object_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.usergroupdelegation_create_object_v1_response_m_payload import UsergroupdelegationCreateObjectV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class UsergroupdelegationCreateObjectV1Response(BaseModel): """ - Response for POST /1/object/usergroupdelegation # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: UsergroupdelegationCreateObjectV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for POST /1/object/usergroupdelegation + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: UsergroupdelegationCreateObjectV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> UsergroupdelegationCreateObjectV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of UsergroupdelegationCreateObjectV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> UsergroupdelegationCreateObjectV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of UsergroupdelegationCreateObjectV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return UsergroupdelegationCreateObjectV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = UsergroupdelegationCreateObjectV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": UsergroupdelegationCreateObjectV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": UsergroupdelegationCreateObjectV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/usergroupdelegation_create_object_v1_response_m_payload.py b/eZmaxApi/models/usergroupdelegation_create_object_v1_response_m_payload.py index 0a381e0fa..fe0099f0c 100644 --- a/eZmaxApi/models/usergroupdelegation_create_object_v1_response_m_payload.py +++ b/eZmaxApi/models/usergroupdelegation_create_object_v1_response_m_payload.py @@ -19,53 +19,72 @@ import json -from typing import List -from pydantic import BaseModel, Field, conint, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class UsergroupdelegationCreateObjectV1ResponseMPayload(BaseModel): """ - Payload for POST /1/object/usergroupdelegation # noqa: E501 - """ - a_pki_usergroupdelegation_id: conlist(conint(strict=True, le=65535, ge=0)) = Field(..., alias="a_pkiUsergroupdelegationID", description="An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request.") - __properties = ["a_pkiUsergroupdelegationID"] + Payload for POST /1/object/usergroupdelegation + """ # noqa: E501 + a_pki_usergroupdelegation_id: List[Annotated[int, Field(le=65535, strict=True, ge=0)]] = Field(description="An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request.", alias="a_pkiUsergroupdelegationID") + __properties: ClassVar[List[str]] = ["a_pkiUsergroupdelegationID"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> UsergroupdelegationCreateObjectV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of UsergroupdelegationCreateObjectV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> UsergroupdelegationCreateObjectV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of UsergroupdelegationCreateObjectV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return UsergroupdelegationCreateObjectV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = UsergroupdelegationCreateObjectV1ResponseMPayload.parse_obj({ - "a_pki_usergroupdelegation_id": obj.get("a_pkiUsergroupdelegationID") + _obj = cls.model_validate({ + "a_pkiUsergroupdelegationID": obj.get("a_pkiUsergroupdelegationID") }) return _obj diff --git a/eZmaxApi/models/usergroupdelegation_delete_object_v1_response.py b/eZmaxApi/models/usergroupdelegation_delete_object_v1_response.py index 4416a39a8..d60641c9a 100644 --- a/eZmaxApi/models/usergroupdelegation_delete_object_v1_response.py +++ b/eZmaxApi/models/usergroupdelegation_delete_object_v1_response.py @@ -19,43 +19,61 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class UsergroupdelegationDeleteObjectV1Response(BaseModel): """ - Response for DELETE /1/object/usergroupdelegation/{pkiUsergroupdelegationID} # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - __properties = ["objDebugPayload", "objDebug"] + Response for DELETE /1/object/usergroupdelegation/{pkiUsergroupdelegationID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> UsergroupdelegationDeleteObjectV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of UsergroupdelegationDeleteObjectV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -65,17 +83,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> UsergroupdelegationDeleteObjectV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of UsergroupdelegationDeleteObjectV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return UsergroupdelegationDeleteObjectV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = UsergroupdelegationDeleteObjectV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None }) return _obj diff --git a/eZmaxApi/models/usergroupdelegation_edit_object_v1_request.py b/eZmaxApi/models/usergroupdelegation_edit_object_v1_request.py index 3524d6418..08947add3 100644 --- a/eZmaxApi/models/usergroupdelegation_edit_object_v1_request.py +++ b/eZmaxApi/models/usergroupdelegation_edit_object_v1_request.py @@ -19,57 +19,75 @@ import json - -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.usergroupdelegation_request_compound import UsergroupdelegationRequestCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class UsergroupdelegationEditObjectV1Request(BaseModel): """ - Request for PUT /1/object/usergroupdelegation/{pkiUsergroupdelegationID} # noqa: E501 - """ - obj_usergroupdelegation: UsergroupdelegationRequestCompound = Field(..., alias="objUsergroupdelegation") - __properties = ["objUsergroupdelegation"] + Request for PUT /1/object/usergroupdelegation/{pkiUsergroupdelegationID} + """ # noqa: E501 + obj_usergroupdelegation: UsergroupdelegationRequestCompound = Field(alias="objUsergroupdelegation") + __properties: ClassVar[List[str]] = ["objUsergroupdelegation"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> UsergroupdelegationEditObjectV1Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of UsergroupdelegationEditObjectV1Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_usergroupdelegation if self.obj_usergroupdelegation: _dict['objUsergroupdelegation'] = self.obj_usergroupdelegation.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> UsergroupdelegationEditObjectV1Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of UsergroupdelegationEditObjectV1Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return UsergroupdelegationEditObjectV1Request.parse_obj(obj) + return cls.model_validate(obj) - _obj = UsergroupdelegationEditObjectV1Request.parse_obj({ - "obj_usergroupdelegation": UsergroupdelegationRequestCompound.from_dict(obj.get("objUsergroupdelegation")) if obj.get("objUsergroupdelegation") is not None else None + _obj = cls.model_validate({ + "objUsergroupdelegation": UsergroupdelegationRequestCompound.from_dict(obj.get("objUsergroupdelegation")) if obj.get("objUsergroupdelegation") is not None else None }) return _obj diff --git a/eZmaxApi/models/usergroupdelegation_edit_object_v1_response.py b/eZmaxApi/models/usergroupdelegation_edit_object_v1_response.py index a48f6dea7..270b1dd90 100644 --- a/eZmaxApi/models/usergroupdelegation_edit_object_v1_response.py +++ b/eZmaxApi/models/usergroupdelegation_edit_object_v1_response.py @@ -19,43 +19,61 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class UsergroupdelegationEditObjectV1Response(BaseModel): """ - Response for PUT /1/object/usergroupdelegation/{pkiUsergroupdelegationID} # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - __properties = ["objDebugPayload", "objDebug"] + Response for PUT /1/object/usergroupdelegation/{pkiUsergroupdelegationID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> UsergroupdelegationEditObjectV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of UsergroupdelegationEditObjectV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -65,17 +83,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> UsergroupdelegationEditObjectV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of UsergroupdelegationEditObjectV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return UsergroupdelegationEditObjectV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = UsergroupdelegationEditObjectV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None }) return _obj diff --git a/eZmaxApi/models/usergroupdelegation_get_object_v2_response.py b/eZmaxApi/models/usergroupdelegation_get_object_v2_response.py index eec689fe6..ae4a6f93b 100644 --- a/eZmaxApi/models/usergroupdelegation_get_object_v2_response.py +++ b/eZmaxApi/models/usergroupdelegation_get_object_v2_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.usergroupdelegation_get_object_v2_response_m_payload import UsergroupdelegationGetObjectV2ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class UsergroupdelegationGetObjectV2Response(BaseModel): """ - Response for GET /2/object/usergroupdelegation/{pkiUsergroupdelegationID} # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: UsergroupdelegationGetObjectV2ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /2/object/usergroupdelegation/{pkiUsergroupdelegationID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: UsergroupdelegationGetObjectV2ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> UsergroupdelegationGetObjectV2Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of UsergroupdelegationGetObjectV2Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> UsergroupdelegationGetObjectV2Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of UsergroupdelegationGetObjectV2Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return UsergroupdelegationGetObjectV2Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = UsergroupdelegationGetObjectV2Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": UsergroupdelegationGetObjectV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": UsergroupdelegationGetObjectV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/usergroupdelegation_get_object_v2_response_m_payload.py b/eZmaxApi/models/usergroupdelegation_get_object_v2_response_m_payload.py index 5cf618522..1944b3dfd 100644 --- a/eZmaxApi/models/usergroupdelegation_get_object_v2_response_m_payload.py +++ b/eZmaxApi/models/usergroupdelegation_get_object_v2_response_m_payload.py @@ -19,57 +19,75 @@ import json - -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.usergroupdelegation_response_compound import UsergroupdelegationResponseCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class UsergroupdelegationGetObjectV2ResponseMPayload(BaseModel): """ - Payload for GET /2/object/usergroupdelegation/{pkiUsergroupdelegationID} # noqa: E501 - """ - obj_usergroupdelegation: UsergroupdelegationResponseCompound = Field(..., alias="objUsergroupdelegation") - __properties = ["objUsergroupdelegation"] + Payload for GET /2/object/usergroupdelegation/{pkiUsergroupdelegationID} + """ # noqa: E501 + obj_usergroupdelegation: UsergroupdelegationResponseCompound = Field(alias="objUsergroupdelegation") + __properties: ClassVar[List[str]] = ["objUsergroupdelegation"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> UsergroupdelegationGetObjectV2ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of UsergroupdelegationGetObjectV2ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_usergroupdelegation if self.obj_usergroupdelegation: _dict['objUsergroupdelegation'] = self.obj_usergroupdelegation.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> UsergroupdelegationGetObjectV2ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of UsergroupdelegationGetObjectV2ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return UsergroupdelegationGetObjectV2ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = UsergroupdelegationGetObjectV2ResponseMPayload.parse_obj({ - "obj_usergroupdelegation": UsergroupdelegationResponseCompound.from_dict(obj.get("objUsergroupdelegation")) if obj.get("objUsergroupdelegation") is not None else None + _obj = cls.model_validate({ + "objUsergroupdelegation": UsergroupdelegationResponseCompound.from_dict(obj.get("objUsergroupdelegation")) if obj.get("objUsergroupdelegation") is not None else None }) return _obj diff --git a/eZmaxApi/models/usergroupdelegation_request.py b/eZmaxApi/models/usergroupdelegation_request.py index 38924082e..c3000f477 100644 --- a/eZmaxApi/models/usergroupdelegation_request.py +++ b/eZmaxApi/models/usergroupdelegation_request.py @@ -19,57 +19,76 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class UsergroupdelegationRequest(BaseModel): """ - A Usergroupdelegation Object # noqa: E501 - """ - pki_usergroupdelegation_id: Optional[conint(strict=True, le=65535, ge=0)] = Field(None, alias="pkiUsergroupdelegationID", description="The unique ID of the Usergroupdelegation") - fki_usergroup_id: conint(strict=True, le=255, ge=0) = Field(..., alias="fkiUsergroupID", description="The unique ID of the Usergroup") - fki_user_id: conint(strict=True, ge=0) = Field(..., alias="fkiUserID", description="The unique ID of the User") - __properties = ["pkiUsergroupdelegationID", "fkiUsergroupID", "fkiUserID"] + A Usergroupdelegation Object + """ # noqa: E501 + pki_usergroupdelegation_id: Optional[Annotated[int, Field(le=65535, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Usergroupdelegation", alias="pkiUsergroupdelegationID") + fki_usergroup_id: Annotated[int, Field(le=255, strict=True, ge=0)] = Field(description="The unique ID of the Usergroup", alias="fkiUsergroupID") + fki_user_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the User", alias="fkiUserID") + __properties: ClassVar[List[str]] = ["pkiUsergroupdelegationID", "fkiUsergroupID", "fkiUserID"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> UsergroupdelegationRequest: + def from_json(cls, json_str: str) -> Self: """Create an instance of UsergroupdelegationRequest from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> UsergroupdelegationRequest: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of UsergroupdelegationRequest from a dict""" if obj is None: return None if not isinstance(obj, dict): - return UsergroupdelegationRequest.parse_obj(obj) + return cls.model_validate(obj) - _obj = UsergroupdelegationRequest.parse_obj({ - "pki_usergroupdelegation_id": obj.get("pkiUsergroupdelegationID"), - "fki_usergroup_id": obj.get("fkiUsergroupID"), - "fki_user_id": obj.get("fkiUserID") + _obj = cls.model_validate({ + "pkiUsergroupdelegationID": obj.get("pkiUsergroupdelegationID"), + "fkiUsergroupID": obj.get("fkiUsergroupID"), + "fkiUserID": obj.get("fkiUserID") }) return _obj diff --git a/eZmaxApi/models/usergroupdelegation_request_compound.py b/eZmaxApi/models/usergroupdelegation_request_compound.py index abb0bec92..41c36d9fd 100644 --- a/eZmaxApi/models/usergroupdelegation_request_compound.py +++ b/eZmaxApi/models/usergroupdelegation_request_compound.py @@ -19,57 +19,76 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class UsergroupdelegationRequestCompound(BaseModel): """ - A Usergroupdelegation Object and children # noqa: E501 - """ - pki_usergroupdelegation_id: Optional[conint(strict=True, le=65535, ge=0)] = Field(None, alias="pkiUsergroupdelegationID", description="The unique ID of the Usergroupdelegation") - fki_usergroup_id: conint(strict=True, le=255, ge=0) = Field(..., alias="fkiUsergroupID", description="The unique ID of the Usergroup") - fki_user_id: conint(strict=True, ge=0) = Field(..., alias="fkiUserID", description="The unique ID of the User") - __properties = ["pkiUsergroupdelegationID", "fkiUsergroupID", "fkiUserID"] + A Usergroupdelegation Object and children + """ # noqa: E501 + pki_usergroupdelegation_id: Optional[Annotated[int, Field(le=65535, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Usergroupdelegation", alias="pkiUsergroupdelegationID") + fki_usergroup_id: Annotated[int, Field(le=255, strict=True, ge=0)] = Field(description="The unique ID of the Usergroup", alias="fkiUsergroupID") + fki_user_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the User", alias="fkiUserID") + __properties: ClassVar[List[str]] = ["pkiUsergroupdelegationID", "fkiUsergroupID", "fkiUserID"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> UsergroupdelegationRequestCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of UsergroupdelegationRequestCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> UsergroupdelegationRequestCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of UsergroupdelegationRequestCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return UsergroupdelegationRequestCompound.parse_obj(obj) + return cls.model_validate(obj) - _obj = UsergroupdelegationRequestCompound.parse_obj({ - "pki_usergroupdelegation_id": obj.get("pkiUsergroupdelegationID"), - "fki_usergroup_id": obj.get("fkiUsergroupID"), - "fki_user_id": obj.get("fkiUserID") + _obj = cls.model_validate({ + "pkiUsergroupdelegationID": obj.get("pkiUsergroupdelegationID"), + "fkiUsergroupID": obj.get("fkiUsergroupID"), + "fkiUserID": obj.get("fkiUserID") }) return _obj diff --git a/eZmaxApi/models/usergroupdelegation_response.py b/eZmaxApi/models/usergroupdelegation_response.py index 8d0b7687c..5a1b7181a 100644 --- a/eZmaxApi/models/usergroupdelegation_response.py +++ b/eZmaxApi/models/usergroupdelegation_response.py @@ -19,81 +19,100 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictStr, conint, constr, validator +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictStr, field_validator +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class UsergroupdelegationResponse(BaseModel): """ - A Usergroupdelegation Object # noqa: E501 - """ - pki_usergroupdelegation_id: conint(strict=True, le=65535, ge=0) = Field(..., alias="pkiUsergroupdelegationID", description="The unique ID of the Usergroupdelegation") - fki_usergroup_id: conint(strict=True, le=255, ge=0) = Field(..., alias="fkiUsergroupID", description="The unique ID of the Usergroup") - fki_user_id: conint(strict=True, ge=0) = Field(..., alias="fkiUserID", description="The unique ID of the User") - s_user_firstname: StrictStr = Field(..., alias="sUserFirstname", description="The first name of the user") - s_user_lastname: StrictStr = Field(..., alias="sUserLastname", description="The last name of the user") - s_user_loginname: constr(strict=True) = Field(..., alias="sUserLoginname", description="The login name of the User.") - s_email_address: Optional[StrictStr] = Field(None, alias="sEmailAddress", description="The email address.") - s_usergroup_name_x: constr(strict=True) = Field(..., alias="sUsergroupNameX", description="The Name of the Usergroup in the language of the requester") - __properties = ["pkiUsergroupdelegationID", "fkiUsergroupID", "fkiUserID", "sUserFirstname", "sUserLastname", "sUserLoginname", "sEmailAddress", "sUsergroupNameX"] - - @validator('s_user_loginname') + A Usergroupdelegation Object + """ # noqa: E501 + pki_usergroupdelegation_id: Annotated[int, Field(le=65535, strict=True, ge=0)] = Field(description="The unique ID of the Usergroupdelegation", alias="pkiUsergroupdelegationID") + fki_usergroup_id: Annotated[int, Field(le=255, strict=True, ge=0)] = Field(description="The unique ID of the Usergroup", alias="fkiUsergroupID") + fki_user_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the User", alias="fkiUserID") + s_user_firstname: StrictStr = Field(description="The first name of the user", alias="sUserFirstname") + s_user_lastname: StrictStr = Field(description="The last name of the user", alias="sUserLastname") + s_user_loginname: Annotated[str, Field(strict=True)] = Field(description="The login name of the User.", alias="sUserLoginname") + s_email_address: Optional[StrictStr] = Field(default=None, description="The email address.", alias="sEmailAddress") + s_usergroup_name_x: Annotated[str, Field(strict=True)] = Field(description="The Name of the Usergroup in the language of the requester", alias="sUsergroupNameX") + __properties: ClassVar[List[str]] = ["pkiUsergroupdelegationID", "fkiUsergroupID", "fkiUserID", "sUserFirstname", "sUserLastname", "sUserLoginname", "sEmailAddress", "sUsergroupNameX"] + + @field_validator('s_user_loginname') def s_user_loginname_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^(?:([\w\.-]+@[\w\.-]+\.\w{2,20})|([a-zA-Z0-9]){1,32})$", value): raise ValueError(r"must validate the regular expression /^(?:([\w\.-]+@[\w\.-]+\.\w{2,20})|([a-zA-Z0-9]){1,32})$/") return value - @validator('s_usergroup_name_x') + @field_validator('s_usergroup_name_x') def s_usergroup_name_x_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^.{0,50}$", value): raise ValueError(r"must validate the regular expression /^.{0,50}$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> UsergroupdelegationResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of UsergroupdelegationResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> UsergroupdelegationResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of UsergroupdelegationResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return UsergroupdelegationResponse.parse_obj(obj) - - _obj = UsergroupdelegationResponse.parse_obj({ - "pki_usergroupdelegation_id": obj.get("pkiUsergroupdelegationID"), - "fki_usergroup_id": obj.get("fkiUsergroupID"), - "fki_user_id": obj.get("fkiUserID"), - "s_user_firstname": obj.get("sUserFirstname"), - "s_user_lastname": obj.get("sUserLastname"), - "s_user_loginname": obj.get("sUserLoginname"), - "s_email_address": obj.get("sEmailAddress"), - "s_usergroup_name_x": obj.get("sUsergroupNameX") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiUsergroupdelegationID": obj.get("pkiUsergroupdelegationID"), + "fkiUsergroupID": obj.get("fkiUsergroupID"), + "fkiUserID": obj.get("fkiUserID"), + "sUserFirstname": obj.get("sUserFirstname"), + "sUserLastname": obj.get("sUserLastname"), + "sUserLoginname": obj.get("sUserLoginname"), + "sEmailAddress": obj.get("sEmailAddress"), + "sUsergroupNameX": obj.get("sUsergroupNameX") }) return _obj diff --git a/eZmaxApi/models/usergroupdelegation_response_compound.py b/eZmaxApi/models/usergroupdelegation_response_compound.py index f50af72e6..9faa62f63 100644 --- a/eZmaxApi/models/usergroupdelegation_response_compound.py +++ b/eZmaxApi/models/usergroupdelegation_response_compound.py @@ -19,81 +19,100 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictStr, conint, constr, validator +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictStr, field_validator +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class UsergroupdelegationResponseCompound(BaseModel): """ - A Usergroupdelegation Object # noqa: E501 - """ - pki_usergroupdelegation_id: conint(strict=True, le=65535, ge=0) = Field(..., alias="pkiUsergroupdelegationID", description="The unique ID of the Usergroupdelegation") - fki_usergroup_id: conint(strict=True, le=255, ge=0) = Field(..., alias="fkiUsergroupID", description="The unique ID of the Usergroup") - fki_user_id: conint(strict=True, ge=0) = Field(..., alias="fkiUserID", description="The unique ID of the User") - s_user_firstname: StrictStr = Field(..., alias="sUserFirstname", description="The first name of the user") - s_user_lastname: StrictStr = Field(..., alias="sUserLastname", description="The last name of the user") - s_user_loginname: constr(strict=True) = Field(..., alias="sUserLoginname", description="The login name of the User.") - s_email_address: Optional[StrictStr] = Field(None, alias="sEmailAddress", description="The email address.") - s_usergroup_name_x: constr(strict=True) = Field(..., alias="sUsergroupNameX", description="The Name of the Usergroup in the language of the requester") - __properties = ["pkiUsergroupdelegationID", "fkiUsergroupID", "fkiUserID", "sUserFirstname", "sUserLastname", "sUserLoginname", "sEmailAddress", "sUsergroupNameX"] - - @validator('s_user_loginname') + A Usergroupdelegation Object + """ # noqa: E501 + pki_usergroupdelegation_id: Annotated[int, Field(le=65535, strict=True, ge=0)] = Field(description="The unique ID of the Usergroupdelegation", alias="pkiUsergroupdelegationID") + fki_usergroup_id: Annotated[int, Field(le=255, strict=True, ge=0)] = Field(description="The unique ID of the Usergroup", alias="fkiUsergroupID") + fki_user_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the User", alias="fkiUserID") + s_user_firstname: StrictStr = Field(description="The first name of the user", alias="sUserFirstname") + s_user_lastname: StrictStr = Field(description="The last name of the user", alias="sUserLastname") + s_user_loginname: Annotated[str, Field(strict=True)] = Field(description="The login name of the User.", alias="sUserLoginname") + s_email_address: Optional[StrictStr] = Field(default=None, description="The email address.", alias="sEmailAddress") + s_usergroup_name_x: Annotated[str, Field(strict=True)] = Field(description="The Name of the Usergroup in the language of the requester", alias="sUsergroupNameX") + __properties: ClassVar[List[str]] = ["pkiUsergroupdelegationID", "fkiUsergroupID", "fkiUserID", "sUserFirstname", "sUserLastname", "sUserLoginname", "sEmailAddress", "sUsergroupNameX"] + + @field_validator('s_user_loginname') def s_user_loginname_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^(?:([\w\.-]+@[\w\.-]+\.\w{2,20})|([a-zA-Z0-9]){1,32})$", value): raise ValueError(r"must validate the regular expression /^(?:([\w\.-]+@[\w\.-]+\.\w{2,20})|([a-zA-Z0-9]){1,32})$/") return value - @validator('s_usergroup_name_x') + @field_validator('s_usergroup_name_x') def s_usergroup_name_x_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^.{0,50}$", value): raise ValueError(r"must validate the regular expression /^.{0,50}$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> UsergroupdelegationResponseCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of UsergroupdelegationResponseCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> UsergroupdelegationResponseCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of UsergroupdelegationResponseCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return UsergroupdelegationResponseCompound.parse_obj(obj) - - _obj = UsergroupdelegationResponseCompound.parse_obj({ - "pki_usergroupdelegation_id": obj.get("pkiUsergroupdelegationID"), - "fki_usergroup_id": obj.get("fkiUsergroupID"), - "fki_user_id": obj.get("fkiUserID"), - "s_user_firstname": obj.get("sUserFirstname"), - "s_user_lastname": obj.get("sUserLastname"), - "s_user_loginname": obj.get("sUserLoginname"), - "s_email_address": obj.get("sEmailAddress"), - "s_usergroup_name_x": obj.get("sUsergroupNameX") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiUsergroupdelegationID": obj.get("pkiUsergroupdelegationID"), + "fkiUsergroupID": obj.get("fkiUsergroupID"), + "fkiUserID": obj.get("fkiUserID"), + "sUserFirstname": obj.get("sUserFirstname"), + "sUserLastname": obj.get("sUserLastname"), + "sUserLoginname": obj.get("sUserLoginname"), + "sEmailAddress": obj.get("sEmailAddress"), + "sUsergroupNameX": obj.get("sUsergroupNameX") }) return _obj diff --git a/eZmaxApi/models/usergroupmembership_create_object_v1_request.py b/eZmaxApi/models/usergroupmembership_create_object_v1_request.py index 0f9ff1b7b..cefd3c3de 100644 --- a/eZmaxApi/models/usergroupmembership_create_object_v1_request.py +++ b/eZmaxApi/models/usergroupmembership_create_object_v1_request.py @@ -19,41 +19,60 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.usergroupmembership_request_compound import UsergroupmembershipRequestCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class UsergroupmembershipCreateObjectV1Request(BaseModel): """ - Request for POST /1/object/usergroupmembership # noqa: E501 - """ - a_obj_usergroupmembership: conlist(UsergroupmembershipRequestCompound, min_items=1) = Field(..., alias="a_objUsergroupmembership") - __properties = ["a_objUsergroupmembership"] + Request for POST /1/object/usergroupmembership + """ # noqa: E501 + a_obj_usergroupmembership: Annotated[List[UsergroupmembershipRequestCompound], Field(min_length=1)] = Field(alias="a_objUsergroupmembership") + __properties: ClassVar[List[str]] = ["a_objUsergroupmembership"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> UsergroupmembershipCreateObjectV1Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of UsergroupmembershipCreateObjectV1Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_usergroupmembership (list) _items = [] if self.a_obj_usergroupmembership: @@ -64,16 +83,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> UsergroupmembershipCreateObjectV1Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of UsergroupmembershipCreateObjectV1Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return UsergroupmembershipCreateObjectV1Request.parse_obj(obj) + return cls.model_validate(obj) - _obj = UsergroupmembershipCreateObjectV1Request.parse_obj({ - "a_obj_usergroupmembership": [UsergroupmembershipRequestCompound.from_dict(_item) for _item in obj.get("a_objUsergroupmembership")] if obj.get("a_objUsergroupmembership") is not None else None + _obj = cls.model_validate({ + "a_objUsergroupmembership": [UsergroupmembershipRequestCompound.from_dict(_item) for _item in obj.get("a_objUsergroupmembership")] if obj.get("a_objUsergroupmembership") is not None else None }) return _obj diff --git a/eZmaxApi/models/usergroupmembership_create_object_v1_response.py b/eZmaxApi/models/usergroupmembership_create_object_v1_response.py index 3dc819e65..d276bf627 100644 --- a/eZmaxApi/models/usergroupmembership_create_object_v1_response.py +++ b/eZmaxApi/models/usergroupmembership_create_object_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.usergroupmembership_create_object_v1_response_m_payload import UsergroupmembershipCreateObjectV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class UsergroupmembershipCreateObjectV1Response(BaseModel): """ - Response for POST /1/object/usergroupmembership # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: UsergroupmembershipCreateObjectV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for POST /1/object/usergroupmembership + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: UsergroupmembershipCreateObjectV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> UsergroupmembershipCreateObjectV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of UsergroupmembershipCreateObjectV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> UsergroupmembershipCreateObjectV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of UsergroupmembershipCreateObjectV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return UsergroupmembershipCreateObjectV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = UsergroupmembershipCreateObjectV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": UsergroupmembershipCreateObjectV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": UsergroupmembershipCreateObjectV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/usergroupmembership_create_object_v1_response_m_payload.py b/eZmaxApi/models/usergroupmembership_create_object_v1_response_m_payload.py index 2d488456c..c4135c0b2 100644 --- a/eZmaxApi/models/usergroupmembership_create_object_v1_response_m_payload.py +++ b/eZmaxApi/models/usergroupmembership_create_object_v1_response_m_payload.py @@ -19,53 +19,72 @@ import json -from typing import List -from pydantic import BaseModel, Field, conint, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class UsergroupmembershipCreateObjectV1ResponseMPayload(BaseModel): """ - Payload for POST /1/object/usergroupmembership # noqa: E501 - """ - a_pki_usergroupmembership_id: conlist(conint(strict=True, le=65535, ge=0)) = Field(..., alias="a_pkiUsergroupmembershipID", description="An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request.") - __properties = ["a_pkiUsergroupmembershipID"] + Payload for POST /1/object/usergroupmembership + """ # noqa: E501 + a_pki_usergroupmembership_id: List[Annotated[int, Field(le=65535, strict=True, ge=0)]] = Field(description="An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request.", alias="a_pkiUsergroupmembershipID") + __properties: ClassVar[List[str]] = ["a_pkiUsergroupmembershipID"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> UsergroupmembershipCreateObjectV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of UsergroupmembershipCreateObjectV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> UsergroupmembershipCreateObjectV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of UsergroupmembershipCreateObjectV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return UsergroupmembershipCreateObjectV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = UsergroupmembershipCreateObjectV1ResponseMPayload.parse_obj({ - "a_pki_usergroupmembership_id": obj.get("a_pkiUsergroupmembershipID") + _obj = cls.model_validate({ + "a_pkiUsergroupmembershipID": obj.get("a_pkiUsergroupmembershipID") }) return _obj diff --git a/eZmaxApi/models/usergroupmembership_delete_object_v1_response.py b/eZmaxApi/models/usergroupmembership_delete_object_v1_response.py index 6bb493fe8..bf0d65cb1 100644 --- a/eZmaxApi/models/usergroupmembership_delete_object_v1_response.py +++ b/eZmaxApi/models/usergroupmembership_delete_object_v1_response.py @@ -19,43 +19,61 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class UsergroupmembershipDeleteObjectV1Response(BaseModel): """ - Response for DELETE /1/object/usergroupmembership/{pkiUsergroupmembershipID} # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - __properties = ["objDebugPayload", "objDebug"] + Response for DELETE /1/object/usergroupmembership/{pkiUsergroupmembershipID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> UsergroupmembershipDeleteObjectV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of UsergroupmembershipDeleteObjectV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -65,17 +83,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> UsergroupmembershipDeleteObjectV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of UsergroupmembershipDeleteObjectV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return UsergroupmembershipDeleteObjectV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = UsergroupmembershipDeleteObjectV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None }) return _obj diff --git a/eZmaxApi/models/usergroupmembership_edit_object_v1_request.py b/eZmaxApi/models/usergroupmembership_edit_object_v1_request.py index cbe52405b..f2e59cf4c 100644 --- a/eZmaxApi/models/usergroupmembership_edit_object_v1_request.py +++ b/eZmaxApi/models/usergroupmembership_edit_object_v1_request.py @@ -19,57 +19,75 @@ import json - -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.usergroupmembership_request_compound import UsergroupmembershipRequestCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class UsergroupmembershipEditObjectV1Request(BaseModel): """ - Request for PUT /1/object/usergroupmembership/{pkiUsergroupmembershipID} # noqa: E501 - """ - obj_usergroupmembership: UsergroupmembershipRequestCompound = Field(..., alias="objUsergroupmembership") - __properties = ["objUsergroupmembership"] + Request for PUT /1/object/usergroupmembership/{pkiUsergroupmembershipID} + """ # noqa: E501 + obj_usergroupmembership: UsergroupmembershipRequestCompound = Field(alias="objUsergroupmembership") + __properties: ClassVar[List[str]] = ["objUsergroupmembership"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> UsergroupmembershipEditObjectV1Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of UsergroupmembershipEditObjectV1Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_usergroupmembership if self.obj_usergroupmembership: _dict['objUsergroupmembership'] = self.obj_usergroupmembership.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> UsergroupmembershipEditObjectV1Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of UsergroupmembershipEditObjectV1Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return UsergroupmembershipEditObjectV1Request.parse_obj(obj) + return cls.model_validate(obj) - _obj = UsergroupmembershipEditObjectV1Request.parse_obj({ - "obj_usergroupmembership": UsergroupmembershipRequestCompound.from_dict(obj.get("objUsergroupmembership")) if obj.get("objUsergroupmembership") is not None else None + _obj = cls.model_validate({ + "objUsergroupmembership": UsergroupmembershipRequestCompound.from_dict(obj.get("objUsergroupmembership")) if obj.get("objUsergroupmembership") is not None else None }) return _obj diff --git a/eZmaxApi/models/usergroupmembership_edit_object_v1_response.py b/eZmaxApi/models/usergroupmembership_edit_object_v1_response.py index 8af3c1650..f8d142b07 100644 --- a/eZmaxApi/models/usergroupmembership_edit_object_v1_response.py +++ b/eZmaxApi/models/usergroupmembership_edit_object_v1_response.py @@ -19,43 +19,61 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class UsergroupmembershipEditObjectV1Response(BaseModel): """ - Response for PUT /1/object/usergroupmembership/{pkiUsergroupmembershipID} # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - __properties = ["objDebugPayload", "objDebug"] + Response for PUT /1/object/usergroupmembership/{pkiUsergroupmembershipID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> UsergroupmembershipEditObjectV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of UsergroupmembershipEditObjectV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -65,17 +83,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> UsergroupmembershipEditObjectV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of UsergroupmembershipEditObjectV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return UsergroupmembershipEditObjectV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = UsergroupmembershipEditObjectV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None }) return _obj diff --git a/eZmaxApi/models/usergroupmembership_get_object_v2_response.py b/eZmaxApi/models/usergroupmembership_get_object_v2_response.py index 2ed344d1d..6cdea8353 100644 --- a/eZmaxApi/models/usergroupmembership_get_object_v2_response.py +++ b/eZmaxApi/models/usergroupmembership_get_object_v2_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.usergroupmembership_get_object_v2_response_m_payload import UsergroupmembershipGetObjectV2ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class UsergroupmembershipGetObjectV2Response(BaseModel): """ - Response for GET /2/object/usergroupmembership/{pkiUsergroupmembershipID} # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: UsergroupmembershipGetObjectV2ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /2/object/usergroupmembership/{pkiUsergroupmembershipID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: UsergroupmembershipGetObjectV2ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> UsergroupmembershipGetObjectV2Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of UsergroupmembershipGetObjectV2Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> UsergroupmembershipGetObjectV2Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of UsergroupmembershipGetObjectV2Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return UsergroupmembershipGetObjectV2Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = UsergroupmembershipGetObjectV2Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": UsergroupmembershipGetObjectV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": UsergroupmembershipGetObjectV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/usergroupmembership_get_object_v2_response_m_payload.py b/eZmaxApi/models/usergroupmembership_get_object_v2_response_m_payload.py index b9138987e..0d083bb8d 100644 --- a/eZmaxApi/models/usergroupmembership_get_object_v2_response_m_payload.py +++ b/eZmaxApi/models/usergroupmembership_get_object_v2_response_m_payload.py @@ -19,57 +19,75 @@ import json - -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.usergroupmembership_response_compound import UsergroupmembershipResponseCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class UsergroupmembershipGetObjectV2ResponseMPayload(BaseModel): """ - Payload for GET /2/object/usergroupmembership/{pkiUsergroupmembershipID} # noqa: E501 - """ - obj_usergroupmembership: UsergroupmembershipResponseCompound = Field(..., alias="objUsergroupmembership") - __properties = ["objUsergroupmembership"] + Payload for GET /2/object/usergroupmembership/{pkiUsergroupmembershipID} + """ # noqa: E501 + obj_usergroupmembership: UsergroupmembershipResponseCompound = Field(alias="objUsergroupmembership") + __properties: ClassVar[List[str]] = ["objUsergroupmembership"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> UsergroupmembershipGetObjectV2ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of UsergroupmembershipGetObjectV2ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_usergroupmembership if self.obj_usergroupmembership: _dict['objUsergroupmembership'] = self.obj_usergroupmembership.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> UsergroupmembershipGetObjectV2ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of UsergroupmembershipGetObjectV2ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return UsergroupmembershipGetObjectV2ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = UsergroupmembershipGetObjectV2ResponseMPayload.parse_obj({ - "obj_usergroupmembership": UsergroupmembershipResponseCompound.from_dict(obj.get("objUsergroupmembership")) if obj.get("objUsergroupmembership") is not None else None + _obj = cls.model_validate({ + "objUsergroupmembership": UsergroupmembershipResponseCompound.from_dict(obj.get("objUsergroupmembership")) if obj.get("objUsergroupmembership") is not None else None }) return _obj diff --git a/eZmaxApi/models/usergroupmembership_request.py b/eZmaxApi/models/usergroupmembership_request.py index c2be55ae2..6e588e05e 100644 --- a/eZmaxApi/models/usergroupmembership_request.py +++ b/eZmaxApi/models/usergroupmembership_request.py @@ -19,57 +19,76 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class UsergroupmembershipRequest(BaseModel): """ - A Usergroupmembership Object # noqa: E501 - """ - pki_usergroupmembership_id: Optional[conint(strict=True, le=65535, ge=0)] = Field(None, alias="pkiUsergroupmembershipID", description="The unique ID of the Usergroupmembership") - fki_usergroup_id: conint(strict=True, le=255, ge=0) = Field(..., alias="fkiUsergroupID", description="The unique ID of the Usergroup") - fki_user_id: conint(strict=True, ge=0) = Field(..., alias="fkiUserID", description="The unique ID of the User") - __properties = ["pkiUsergroupmembershipID", "fkiUsergroupID", "fkiUserID"] + A Usergroupmembership Object + """ # noqa: E501 + pki_usergroupmembership_id: Optional[Annotated[int, Field(le=65535, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Usergroupmembership", alias="pkiUsergroupmembershipID") + fki_usergroup_id: Annotated[int, Field(le=255, strict=True, ge=0)] = Field(description="The unique ID of the Usergroup", alias="fkiUsergroupID") + fki_user_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the User", alias="fkiUserID") + __properties: ClassVar[List[str]] = ["pkiUsergroupmembershipID", "fkiUsergroupID", "fkiUserID"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> UsergroupmembershipRequest: + def from_json(cls, json_str: str) -> Self: """Create an instance of UsergroupmembershipRequest from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> UsergroupmembershipRequest: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of UsergroupmembershipRequest from a dict""" if obj is None: return None if not isinstance(obj, dict): - return UsergroupmembershipRequest.parse_obj(obj) + return cls.model_validate(obj) - _obj = UsergroupmembershipRequest.parse_obj({ - "pki_usergroupmembership_id": obj.get("pkiUsergroupmembershipID"), - "fki_usergroup_id": obj.get("fkiUsergroupID"), - "fki_user_id": obj.get("fkiUserID") + _obj = cls.model_validate({ + "pkiUsergroupmembershipID": obj.get("pkiUsergroupmembershipID"), + "fkiUsergroupID": obj.get("fkiUsergroupID"), + "fkiUserID": obj.get("fkiUserID") }) return _obj diff --git a/eZmaxApi/models/usergroupmembership_request_compound.py b/eZmaxApi/models/usergroupmembership_request_compound.py index cbfa19fdf..21302546f 100644 --- a/eZmaxApi/models/usergroupmembership_request_compound.py +++ b/eZmaxApi/models/usergroupmembership_request_compound.py @@ -19,57 +19,76 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class UsergroupmembershipRequestCompound(BaseModel): """ - A Usergroupmembership Object and children # noqa: E501 - """ - pki_usergroupmembership_id: Optional[conint(strict=True, le=65535, ge=0)] = Field(None, alias="pkiUsergroupmembershipID", description="The unique ID of the Usergroupmembership") - fki_usergroup_id: conint(strict=True, le=255, ge=0) = Field(..., alias="fkiUsergroupID", description="The unique ID of the Usergroup") - fki_user_id: conint(strict=True, ge=0) = Field(..., alias="fkiUserID", description="The unique ID of the User") - __properties = ["pkiUsergroupmembershipID", "fkiUsergroupID", "fkiUserID"] + A Usergroupmembership Object and children + """ # noqa: E501 + pki_usergroupmembership_id: Optional[Annotated[int, Field(le=65535, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Usergroupmembership", alias="pkiUsergroupmembershipID") + fki_usergroup_id: Annotated[int, Field(le=255, strict=True, ge=0)] = Field(description="The unique ID of the Usergroup", alias="fkiUsergroupID") + fki_user_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the User", alias="fkiUserID") + __properties: ClassVar[List[str]] = ["pkiUsergroupmembershipID", "fkiUsergroupID", "fkiUserID"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> UsergroupmembershipRequestCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of UsergroupmembershipRequestCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> UsergroupmembershipRequestCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of UsergroupmembershipRequestCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return UsergroupmembershipRequestCompound.parse_obj(obj) + return cls.model_validate(obj) - _obj = UsergroupmembershipRequestCompound.parse_obj({ - "pki_usergroupmembership_id": obj.get("pkiUsergroupmembershipID"), - "fki_usergroup_id": obj.get("fkiUsergroupID"), - "fki_user_id": obj.get("fkiUserID") + _obj = cls.model_validate({ + "pkiUsergroupmembershipID": obj.get("pkiUsergroupmembershipID"), + "fkiUsergroupID": obj.get("fkiUsergroupID"), + "fkiUserID": obj.get("fkiUserID") }) return _obj diff --git a/eZmaxApi/models/usergroupmembership_response.py b/eZmaxApi/models/usergroupmembership_response.py index 08968fe63..1f1abdf21 100644 --- a/eZmaxApi/models/usergroupmembership_response.py +++ b/eZmaxApi/models/usergroupmembership_response.py @@ -19,81 +19,100 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictStr, conint, constr, validator +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictStr, field_validator +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class UsergroupmembershipResponse(BaseModel): """ - A Usergroupmembership Object # noqa: E501 - """ - pki_usergroupmembership_id: conint(strict=True, le=65535, ge=0) = Field(..., alias="pkiUsergroupmembershipID", description="The unique ID of the Usergroupmembership") - fki_usergroup_id: conint(strict=True, le=255, ge=0) = Field(..., alias="fkiUsergroupID", description="The unique ID of the Usergroup") - fki_user_id: conint(strict=True, ge=0) = Field(..., alias="fkiUserID", description="The unique ID of the User") - s_user_firstname: StrictStr = Field(..., alias="sUserFirstname", description="The first name of the user") - s_user_lastname: StrictStr = Field(..., alias="sUserLastname", description="The last name of the user") - s_user_loginname: constr(strict=True) = Field(..., alias="sUserLoginname", description="The login name of the User.") - s_email_address: Optional[StrictStr] = Field(None, alias="sEmailAddress", description="The email address.") - s_usergroup_name_x: constr(strict=True) = Field(..., alias="sUsergroupNameX", description="The Name of the Usergroup in the language of the requester") - __properties = ["pkiUsergroupmembershipID", "fkiUsergroupID", "fkiUserID", "sUserFirstname", "sUserLastname", "sUserLoginname", "sEmailAddress", "sUsergroupNameX"] - - @validator('s_user_loginname') + A Usergroupmembership Object + """ # noqa: E501 + pki_usergroupmembership_id: Annotated[int, Field(le=65535, strict=True, ge=0)] = Field(description="The unique ID of the Usergroupmembership", alias="pkiUsergroupmembershipID") + fki_usergroup_id: Annotated[int, Field(le=255, strict=True, ge=0)] = Field(description="The unique ID of the Usergroup", alias="fkiUsergroupID") + fki_user_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the User", alias="fkiUserID") + s_user_firstname: StrictStr = Field(description="The first name of the user", alias="sUserFirstname") + s_user_lastname: StrictStr = Field(description="The last name of the user", alias="sUserLastname") + s_user_loginname: Annotated[str, Field(strict=True)] = Field(description="The login name of the User.", alias="sUserLoginname") + s_email_address: Optional[StrictStr] = Field(default=None, description="The email address.", alias="sEmailAddress") + s_usergroup_name_x: Annotated[str, Field(strict=True)] = Field(description="The Name of the Usergroup in the language of the requester", alias="sUsergroupNameX") + __properties: ClassVar[List[str]] = ["pkiUsergroupmembershipID", "fkiUsergroupID", "fkiUserID", "sUserFirstname", "sUserLastname", "sUserLoginname", "sEmailAddress", "sUsergroupNameX"] + + @field_validator('s_user_loginname') def s_user_loginname_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^(?:([\w\.-]+@[\w\.-]+\.\w{2,20})|([a-zA-Z0-9]){1,32})$", value): raise ValueError(r"must validate the regular expression /^(?:([\w\.-]+@[\w\.-]+\.\w{2,20})|([a-zA-Z0-9]){1,32})$/") return value - @validator('s_usergroup_name_x') + @field_validator('s_usergroup_name_x') def s_usergroup_name_x_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^.{0,50}$", value): raise ValueError(r"must validate the regular expression /^.{0,50}$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> UsergroupmembershipResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of UsergroupmembershipResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> UsergroupmembershipResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of UsergroupmembershipResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return UsergroupmembershipResponse.parse_obj(obj) - - _obj = UsergroupmembershipResponse.parse_obj({ - "pki_usergroupmembership_id": obj.get("pkiUsergroupmembershipID"), - "fki_usergroup_id": obj.get("fkiUsergroupID"), - "fki_user_id": obj.get("fkiUserID"), - "s_user_firstname": obj.get("sUserFirstname"), - "s_user_lastname": obj.get("sUserLastname"), - "s_user_loginname": obj.get("sUserLoginname"), - "s_email_address": obj.get("sEmailAddress"), - "s_usergroup_name_x": obj.get("sUsergroupNameX") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiUsergroupmembershipID": obj.get("pkiUsergroupmembershipID"), + "fkiUsergroupID": obj.get("fkiUsergroupID"), + "fkiUserID": obj.get("fkiUserID"), + "sUserFirstname": obj.get("sUserFirstname"), + "sUserLastname": obj.get("sUserLastname"), + "sUserLoginname": obj.get("sUserLoginname"), + "sEmailAddress": obj.get("sEmailAddress"), + "sUsergroupNameX": obj.get("sUsergroupNameX") }) return _obj diff --git a/eZmaxApi/models/usergroupmembership_response_compound.py b/eZmaxApi/models/usergroupmembership_response_compound.py index 1180f9a91..16450bdd6 100644 --- a/eZmaxApi/models/usergroupmembership_response_compound.py +++ b/eZmaxApi/models/usergroupmembership_response_compound.py @@ -19,81 +19,100 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictStr, conint, constr, validator +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictStr, field_validator +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class UsergroupmembershipResponseCompound(BaseModel): """ - A Usergroupmembership Object # noqa: E501 - """ - pki_usergroupmembership_id: conint(strict=True, le=65535, ge=0) = Field(..., alias="pkiUsergroupmembershipID", description="The unique ID of the Usergroupmembership") - fki_usergroup_id: conint(strict=True, le=255, ge=0) = Field(..., alias="fkiUsergroupID", description="The unique ID of the Usergroup") - fki_user_id: conint(strict=True, ge=0) = Field(..., alias="fkiUserID", description="The unique ID of the User") - s_user_firstname: StrictStr = Field(..., alias="sUserFirstname", description="The first name of the user") - s_user_lastname: StrictStr = Field(..., alias="sUserLastname", description="The last name of the user") - s_user_loginname: constr(strict=True) = Field(..., alias="sUserLoginname", description="The login name of the User.") - s_email_address: Optional[StrictStr] = Field(None, alias="sEmailAddress", description="The email address.") - s_usergroup_name_x: constr(strict=True) = Field(..., alias="sUsergroupNameX", description="The Name of the Usergroup in the language of the requester") - __properties = ["pkiUsergroupmembershipID", "fkiUsergroupID", "fkiUserID", "sUserFirstname", "sUserLastname", "sUserLoginname", "sEmailAddress", "sUsergroupNameX"] - - @validator('s_user_loginname') + A Usergroupmembership Object + """ # noqa: E501 + pki_usergroupmembership_id: Annotated[int, Field(le=65535, strict=True, ge=0)] = Field(description="The unique ID of the Usergroupmembership", alias="pkiUsergroupmembershipID") + fki_usergroup_id: Annotated[int, Field(le=255, strict=True, ge=0)] = Field(description="The unique ID of the Usergroup", alias="fkiUsergroupID") + fki_user_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the User", alias="fkiUserID") + s_user_firstname: StrictStr = Field(description="The first name of the user", alias="sUserFirstname") + s_user_lastname: StrictStr = Field(description="The last name of the user", alias="sUserLastname") + s_user_loginname: Annotated[str, Field(strict=True)] = Field(description="The login name of the User.", alias="sUserLoginname") + s_email_address: Optional[StrictStr] = Field(default=None, description="The email address.", alias="sEmailAddress") + s_usergroup_name_x: Annotated[str, Field(strict=True)] = Field(description="The Name of the Usergroup in the language of the requester", alias="sUsergroupNameX") + __properties: ClassVar[List[str]] = ["pkiUsergroupmembershipID", "fkiUsergroupID", "fkiUserID", "sUserFirstname", "sUserLastname", "sUserLoginname", "sEmailAddress", "sUsergroupNameX"] + + @field_validator('s_user_loginname') def s_user_loginname_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^(?:([\w\.-]+@[\w\.-]+\.\w{2,20})|([a-zA-Z0-9]){1,32})$", value): raise ValueError(r"must validate the regular expression /^(?:([\w\.-]+@[\w\.-]+\.\w{2,20})|([a-zA-Z0-9]){1,32})$/") return value - @validator('s_usergroup_name_x') + @field_validator('s_usergroup_name_x') def s_usergroup_name_x_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^.{0,50}$", value): raise ValueError(r"must validate the regular expression /^.{0,50}$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> UsergroupmembershipResponseCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of UsergroupmembershipResponseCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> UsergroupmembershipResponseCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of UsergroupmembershipResponseCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return UsergroupmembershipResponseCompound.parse_obj(obj) - - _obj = UsergroupmembershipResponseCompound.parse_obj({ - "pki_usergroupmembership_id": obj.get("pkiUsergroupmembershipID"), - "fki_usergroup_id": obj.get("fkiUsergroupID"), - "fki_user_id": obj.get("fkiUserID"), - "s_user_firstname": obj.get("sUserFirstname"), - "s_user_lastname": obj.get("sUserLastname"), - "s_user_loginname": obj.get("sUserLoginname"), - "s_email_address": obj.get("sEmailAddress"), - "s_usergroup_name_x": obj.get("sUsergroupNameX") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiUsergroupmembershipID": obj.get("pkiUsergroupmembershipID"), + "fkiUsergroupID": obj.get("fkiUsergroupID"), + "fkiUserID": obj.get("fkiUserID"), + "sUserFirstname": obj.get("sUserFirstname"), + "sUserLastname": obj.get("sUserLastname"), + "sUserLoginname": obj.get("sUserLoginname"), + "sEmailAddress": obj.get("sEmailAddress"), + "sUsergroupNameX": obj.get("sUsergroupNameX") }) return _obj diff --git a/eZmaxApi/models/userlogintype_autocomplete_element_response.py b/eZmaxApi/models/userlogintype_autocomplete_element_response.py index 1db0fe95f..1d76182fd 100644 --- a/eZmaxApi/models/userlogintype_autocomplete_element_response.py +++ b/eZmaxApi/models/userlogintype_autocomplete_element_response.py @@ -19,57 +19,76 @@ import json - -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictBool, StrictStr +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class UserlogintypeAutocompleteElementResponse(BaseModel): """ - A Userlogintype AutocompleteElement Response # noqa: E501 - """ - pki_userlogintype_id: conint(strict=True, ge=0) = Field(..., alias="pkiUserlogintypeID", description="The unique ID of the Userlogintype Valid values: |Value|Description|Detail| |-|-|-| |1|**Email Only**|The Ezsignsigner will receive a secure link by email| |2|**Email and phone or SMS**|The Ezsignsigner will receive a secure link by email and will need to authenticate using SMS or Phone call. **Additional fee applies**| |3|**Email and secret question**|The Ezsignsigner will receive a secure link by email and will need to authenticate using a predefined question and answer| |4|**In person only**|The Ezsignsigner will only be able to sign \"In-Person\" and there won't be any authentication. No email will be sent for invitation to sign. Make sure you evaluate the risk of signature denial and at minimum, we recommend you use a handwritten signature type| |5|**In person with phone or SMS**|The Ezsignsigner will only be able to sign \"In-Person\" and will need to authenticate using SMS or Phone call. No email will be sent for invitation to sign. **Additional fee applies**|") - s_userlogintype_description_x: StrictStr = Field(..., alias="sUserlogintypeDescriptionX", description="The description of the Userlogintype in the language of the requester") - b_userlogintype_isactive: StrictBool = Field(..., alias="bUserlogintypeIsactive", description="Whether the Userlogintype is active or not") - __properties = ["pkiUserlogintypeID", "sUserlogintypeDescriptionX", "bUserlogintypeIsactive"] + A Userlogintype AutocompleteElement Response + """ # noqa: E501 + pki_userlogintype_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Userlogintype Valid values: |Value|Description|Detail| |-|-|-| |1|**Email Only**|The Ezsignsigner will receive a secure link by email| |2|**Email and phone or SMS**|The Ezsignsigner will receive a secure link by email and will need to authenticate using SMS or Phone call. **Additional fee applies**| |3|**Email and secret question**|The Ezsignsigner will receive a secure link by email and will need to authenticate using a predefined question and answer| |4|**In person only**|The Ezsignsigner will only be able to sign \"In-Person\" and there won't be any authentication. No email will be sent for invitation to sign. Make sure you evaluate the risk of signature denial and at minimum, we recommend you use a handwritten signature type| |5|**In person with phone or SMS**|The Ezsignsigner will only be able to sign \"In-Person\" and will need to authenticate using SMS or Phone call. No email will be sent for invitation to sign. **Additional fee applies**|", alias="pkiUserlogintypeID") + s_userlogintype_description_x: StrictStr = Field(description="The description of the Userlogintype in the language of the requester", alias="sUserlogintypeDescriptionX") + b_userlogintype_isactive: StrictBool = Field(description="Whether the Userlogintype is active or not", alias="bUserlogintypeIsactive") + __properties: ClassVar[List[str]] = ["pkiUserlogintypeID", "sUserlogintypeDescriptionX", "bUserlogintypeIsactive"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> UserlogintypeAutocompleteElementResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of UserlogintypeAutocompleteElementResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> UserlogintypeAutocompleteElementResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of UserlogintypeAutocompleteElementResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return UserlogintypeAutocompleteElementResponse.parse_obj(obj) + return cls.model_validate(obj) - _obj = UserlogintypeAutocompleteElementResponse.parse_obj({ - "pki_userlogintype_id": obj.get("pkiUserlogintypeID"), - "s_userlogintype_description_x": obj.get("sUserlogintypeDescriptionX"), - "b_userlogintype_isactive": obj.get("bUserlogintypeIsactive") + _obj = cls.model_validate({ + "pkiUserlogintypeID": obj.get("pkiUserlogintypeID"), + "sUserlogintypeDescriptionX": obj.get("sUserlogintypeDescriptionX"), + "bUserlogintypeIsactive": obj.get("bUserlogintypeIsactive") }) return _obj diff --git a/eZmaxApi/models/userlogintype_get_autocomplete_v2_response.py b/eZmaxApi/models/userlogintype_get_autocomplete_v2_response.py index 20ec27200..00a77b61d 100644 --- a/eZmaxApi/models/userlogintype_get_autocomplete_v2_response.py +++ b/eZmaxApi/models/userlogintype_get_autocomplete_v2_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.userlogintype_get_autocomplete_v2_response_m_payload import UserlogintypeGetAutocompleteV2ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class UserlogintypeGetAutocompleteV2Response(BaseModel): """ - Response for GET /2/object/userlogintype/getAutocomplete # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: UserlogintypeGetAutocompleteV2ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /2/object/userlogintype/getAutocomplete + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: UserlogintypeGetAutocompleteV2ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> UserlogintypeGetAutocompleteV2Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of UserlogintypeGetAutocompleteV2Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> UserlogintypeGetAutocompleteV2Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of UserlogintypeGetAutocompleteV2Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return UserlogintypeGetAutocompleteV2Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = UserlogintypeGetAutocompleteV2Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": UserlogintypeGetAutocompleteV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": UserlogintypeGetAutocompleteV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/userlogintype_get_autocomplete_v2_response_m_payload.py b/eZmaxApi/models/userlogintype_get_autocomplete_v2_response_m_payload.py index 8f5f816f8..6379b48e1 100644 --- a/eZmaxApi/models/userlogintype_get_autocomplete_v2_response_m_payload.py +++ b/eZmaxApi/models/userlogintype_get_autocomplete_v2_response_m_payload.py @@ -19,41 +19,59 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.userlogintype_autocomplete_element_response import UserlogintypeAutocompleteElementResponse +try: + from typing import Self +except ImportError: + from typing_extensions import Self class UserlogintypeGetAutocompleteV2ResponseMPayload(BaseModel): """ - Payload for POST /2/object/userlogintype/getAutocomplete # noqa: E501 - """ - a_obj_userlogintype: conlist(UserlogintypeAutocompleteElementResponse) = Field(..., alias="a_objUserlogintype", description="An array of Userlogintype autocomplete element response.") - __properties = ["a_objUserlogintype"] + Payload for POST /2/object/userlogintype/getAutocomplete + """ # noqa: E501 + a_obj_userlogintype: List[UserlogintypeAutocompleteElementResponse] = Field(description="An array of Userlogintype autocomplete element response.", alias="a_objUserlogintype") + __properties: ClassVar[List[str]] = ["a_objUserlogintype"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> UserlogintypeGetAutocompleteV2ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of UserlogintypeGetAutocompleteV2ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_userlogintype (list) _items = [] if self.a_obj_userlogintype: @@ -64,16 +82,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> UserlogintypeGetAutocompleteV2ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of UserlogintypeGetAutocompleteV2ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return UserlogintypeGetAutocompleteV2ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = UserlogintypeGetAutocompleteV2ResponseMPayload.parse_obj({ - "a_obj_userlogintype": [UserlogintypeAutocompleteElementResponse.from_dict(_item) for _item in obj.get("a_objUserlogintype")] if obj.get("a_objUserlogintype") is not None else None + _obj = cls.model_validate({ + "a_objUserlogintype": [UserlogintypeAutocompleteElementResponse.from_dict(_item) for _item in obj.get("a_objUserlogintype")] if obj.get("a_objUserlogintype") is not None else None }) return _obj diff --git a/eZmaxApi/models/userstaged_create_user_v1_response.py b/eZmaxApi/models/userstaged_create_user_v1_response.py index 9d03afe6f..d489ffa0e 100644 --- a/eZmaxApi/models/userstaged_create_user_v1_response.py +++ b/eZmaxApi/models/userstaged_create_user_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.userstaged_create_user_v1_response_m_payload import UserstagedCreateUserV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class UserstagedCreateUserV1Response(BaseModel): """ - Response for POST /1/object/userstaged/{pkiUserstagedID}/createUser # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: UserstagedCreateUserV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for POST /1/object/userstaged/{pkiUserstagedID}/createUser + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: UserstagedCreateUserV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> UserstagedCreateUserV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of UserstagedCreateUserV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> UserstagedCreateUserV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of UserstagedCreateUserV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return UserstagedCreateUserV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = UserstagedCreateUserV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": UserstagedCreateUserV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": UserstagedCreateUserV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/userstaged_create_user_v1_response_m_payload.py b/eZmaxApi/models/userstaged_create_user_v1_response_m_payload.py index 4bb8d62b0..747057f17 100644 --- a/eZmaxApi/models/userstaged_create_user_v1_response_m_payload.py +++ b/eZmaxApi/models/userstaged_create_user_v1_response_m_payload.py @@ -19,53 +19,72 @@ import json - -from pydantic import BaseModel, Field, conint +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class UserstagedCreateUserV1ResponseMPayload(BaseModel): """ - Payload for POST /1/object/userstaged/{pkiUserstagedID}/createUser # noqa: E501 - """ - pki_user_id: conint(strict=True, ge=0) = Field(..., alias="pkiUserID", description="The unique ID of the User") - __properties = ["pkiUserID"] + Payload for POST /1/object/userstaged/{pkiUserstagedID}/createUser + """ # noqa: E501 + pki_user_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the User", alias="pkiUserID") + __properties: ClassVar[List[str]] = ["pkiUserID"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> UserstagedCreateUserV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of UserstagedCreateUserV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> UserstagedCreateUserV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of UserstagedCreateUserV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return UserstagedCreateUserV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = UserstagedCreateUserV1ResponseMPayload.parse_obj({ - "pki_user_id": obj.get("pkiUserID") + _obj = cls.model_validate({ + "pkiUserID": obj.get("pkiUserID") }) return _obj diff --git a/eZmaxApi/models/userstaged_delete_object_v1_response.py b/eZmaxApi/models/userstaged_delete_object_v1_response.py index 0fc2d322f..e513710ac 100644 --- a/eZmaxApi/models/userstaged_delete_object_v1_response.py +++ b/eZmaxApi/models/userstaged_delete_object_v1_response.py @@ -19,43 +19,61 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class UserstagedDeleteObjectV1Response(BaseModel): """ - Response for DELETE /1/object/userstaged/{pkiUserstagedID} # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - __properties = ["objDebugPayload", "objDebug"] + Response for DELETE /1/object/userstaged/{pkiUserstagedID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> UserstagedDeleteObjectV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of UserstagedDeleteObjectV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -65,17 +83,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> UserstagedDeleteObjectV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of UserstagedDeleteObjectV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return UserstagedDeleteObjectV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = UserstagedDeleteObjectV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None }) return _obj diff --git a/eZmaxApi/models/userstaged_get_list_v1_response.py b/eZmaxApi/models/userstaged_get_list_v1_response.py index 33be135d0..2318f991c 100644 --- a/eZmaxApi/models/userstaged_get_list_v1_response.py +++ b/eZmaxApi/models/userstaged_get_list_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload_get_list import CommonResponseObjDebugPayloadGetList from eZmaxApi.models.userstaged_get_list_v1_response_m_payload import UserstagedGetListV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class UserstagedGetListV1Response(BaseModel): """ - Response for GET /1/object/userstaged/getList # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayloadGetList = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: UserstagedGetListV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /1/object/userstaged/getList + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayloadGetList = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: UserstagedGetListV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> UserstagedGetListV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of UserstagedGetListV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> UserstagedGetListV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of UserstagedGetListV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return UserstagedGetListV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = UserstagedGetListV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayloadGetList.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": UserstagedGetListV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayloadGetList.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": UserstagedGetListV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/userstaged_get_list_v1_response_m_payload.py b/eZmaxApi/models/userstaged_get_list_v1_response_m_payload.py index 4ccd2537b..62746b3a3 100644 --- a/eZmaxApi/models/userstaged_get_list_v1_response_m_payload.py +++ b/eZmaxApi/models/userstaged_get_list_v1_response_m_payload.py @@ -19,43 +19,61 @@ import json -from typing import List -from pydantic import BaseModel, Field, StrictInt, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictInt +from pydantic import Field from eZmaxApi.models.userstaged_list_element import UserstagedListElement +try: + from typing import Self +except ImportError: + from typing_extensions import Self class UserstagedGetListV1ResponseMPayload(BaseModel): """ - Payload for GET /1/object/userstaged/getList # noqa: E501 - """ - i_row_returned: StrictInt = Field(..., alias="iRowReturned", description="The number of rows returned") - i_row_filtered: StrictInt = Field(..., alias="iRowFiltered", description="The number of rows matching your filters (if any) or the total number of rows") - a_obj_userstaged: conlist(UserstagedListElement) = Field(..., alias="a_objUserstaged") - __properties = ["iRowReturned", "iRowFiltered", "a_objUserstaged"] + Payload for GET /1/object/userstaged/getList + """ # noqa: E501 + i_row_returned: StrictInt = Field(description="The number of rows returned", alias="iRowReturned") + i_row_filtered: StrictInt = Field(description="The number of rows matching your filters (if any) or the total number of rows", alias="iRowFiltered") + a_obj_userstaged: List[UserstagedListElement] = Field(alias="a_objUserstaged") + __properties: ClassVar[List[str]] = ["iRowReturned", "iRowFiltered", "a_objUserstaged"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> UserstagedGetListV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of UserstagedGetListV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_userstaged (list) _items = [] if self.a_obj_userstaged: @@ -66,18 +84,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> UserstagedGetListV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of UserstagedGetListV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return UserstagedGetListV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = UserstagedGetListV1ResponseMPayload.parse_obj({ - "i_row_returned": obj.get("iRowReturned"), - "i_row_filtered": obj.get("iRowFiltered"), - "a_obj_userstaged": [UserstagedListElement.from_dict(_item) for _item in obj.get("a_objUserstaged")] if obj.get("a_objUserstaged") is not None else None + _obj = cls.model_validate({ + "iRowReturned": obj.get("iRowReturned"), + "iRowFiltered": obj.get("iRowFiltered"), + "a_objUserstaged": [UserstagedListElement.from_dict(_item) for _item in obj.get("a_objUserstaged")] if obj.get("a_objUserstaged") is not None else None }) return _obj diff --git a/eZmaxApi/models/userstaged_get_object_v2_response.py b/eZmaxApi/models/userstaged_get_object_v2_response.py index d2109f694..3c36fb4e3 100644 --- a/eZmaxApi/models/userstaged_get_object_v2_response.py +++ b/eZmaxApi/models/userstaged_get_object_v2_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.userstaged_get_object_v2_response_m_payload import UserstagedGetObjectV2ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class UserstagedGetObjectV2Response(BaseModel): """ - Response for GET /2/object/userstaged/{pkiUserstagedID} # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: UserstagedGetObjectV2ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /2/object/userstaged/{pkiUserstagedID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: UserstagedGetObjectV2ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> UserstagedGetObjectV2Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of UserstagedGetObjectV2Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> UserstagedGetObjectV2Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of UserstagedGetObjectV2Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return UserstagedGetObjectV2Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = UserstagedGetObjectV2Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": UserstagedGetObjectV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": UserstagedGetObjectV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/userstaged_get_object_v2_response_m_payload.py b/eZmaxApi/models/userstaged_get_object_v2_response_m_payload.py index 270fca2a9..021fca623 100644 --- a/eZmaxApi/models/userstaged_get_object_v2_response_m_payload.py +++ b/eZmaxApi/models/userstaged_get_object_v2_response_m_payload.py @@ -19,57 +19,75 @@ import json - -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.userstaged_response_compound import UserstagedResponseCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class UserstagedGetObjectV2ResponseMPayload(BaseModel): """ - Payload for GET /2/object/userstaged/{pkiUserstagedID} # noqa: E501 - """ - obj_userstaged: UserstagedResponseCompound = Field(..., alias="objUserstaged") - __properties = ["objUserstaged"] + Payload for GET /2/object/userstaged/{pkiUserstagedID} + """ # noqa: E501 + obj_userstaged: UserstagedResponseCompound = Field(alias="objUserstaged") + __properties: ClassVar[List[str]] = ["objUserstaged"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> UserstagedGetObjectV2ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of UserstagedGetObjectV2ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_userstaged if self.obj_userstaged: _dict['objUserstaged'] = self.obj_userstaged.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> UserstagedGetObjectV2ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of UserstagedGetObjectV2ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return UserstagedGetObjectV2ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = UserstagedGetObjectV2ResponseMPayload.parse_obj({ - "obj_userstaged": UserstagedResponseCompound.from_dict(obj.get("objUserstaged")) if obj.get("objUserstaged") is not None else None + _obj = cls.model_validate({ + "objUserstaged": UserstagedResponseCompound.from_dict(obj.get("objUserstaged")) if obj.get("objUserstaged") is not None else None }) return _obj diff --git a/eZmaxApi/models/userstaged_list_element.py b/eZmaxApi/models/userstaged_list_element.py index 870b2c0e8..df4bf6842 100644 --- a/eZmaxApi/models/userstaged_list_element.py +++ b/eZmaxApi/models/userstaged_list_element.py @@ -19,82 +19,101 @@ import json - -from pydantic import BaseModel, Field, StrictStr, conint, constr, validator +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictStr, field_validator +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class UserstagedListElement(BaseModel): """ - A Userstaged List Element # noqa: E501 - """ - pki_userstaged_id: conint(strict=True, le=65535, ge=1) = Field(..., alias="pkiUserstagedID", description="The unique ID of the Userstaged") - s_email_address: StrictStr = Field(..., alias="sEmailAddress", description="The email address.") - s_userstaged_firstname: constr(strict=True) = Field(..., alias="sUserstagedFirstname", description="The firstname of the Userstaged") - s_userstaged_lastname: constr(strict=True) = Field(..., alias="sUserstagedLastname", description="The lastname of the Userstaged") - s_userstaged_externalid: constr(strict=True) = Field(..., alias="sUserstagedExternalid", description="The externalid of the Userstaged") - __properties = ["pkiUserstagedID", "sEmailAddress", "sUserstagedFirstname", "sUserstagedLastname", "sUserstagedExternalid"] - - @validator('s_userstaged_firstname') + A Userstaged List Element + """ # noqa: E501 + pki_userstaged_id: Annotated[int, Field(le=65535, strict=True, ge=1)] = Field(description="The unique ID of the Userstaged", alias="pkiUserstagedID") + s_email_address: StrictStr = Field(description="The email address.", alias="sEmailAddress") + s_userstaged_firstname: Annotated[str, Field(strict=True)] = Field(description="The firstname of the Userstaged", alias="sUserstagedFirstname") + s_userstaged_lastname: Annotated[str, Field(strict=True)] = Field(description="The lastname of the Userstaged", alias="sUserstagedLastname") + s_userstaged_externalid: Annotated[str, Field(strict=True)] = Field(description="The externalid of the Userstaged", alias="sUserstagedExternalid") + __properties: ClassVar[List[str]] = ["pkiUserstagedID", "sEmailAddress", "sUserstagedFirstname", "sUserstagedLastname", "sUserstagedExternalid"] + + @field_validator('s_userstaged_firstname') def s_userstaged_firstname_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^.{0,20}$", value): raise ValueError(r"must validate the regular expression /^.{0,20}$/") return value - @validator('s_userstaged_lastname') + @field_validator('s_userstaged_lastname') def s_userstaged_lastname_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^.{0,25}$", value): raise ValueError(r"must validate the regular expression /^.{0,25}$/") return value - @validator('s_userstaged_externalid') + @field_validator('s_userstaged_externalid') def s_userstaged_externalid_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^.{1,60}$", value): raise ValueError(r"must validate the regular expression /^.{1,60}$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> UserstagedListElement: + def from_json(cls, json_str: str) -> Self: """Create an instance of UserstagedListElement from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> UserstagedListElement: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of UserstagedListElement from a dict""" if obj is None: return None if not isinstance(obj, dict): - return UserstagedListElement.parse_obj(obj) - - _obj = UserstagedListElement.parse_obj({ - "pki_userstaged_id": obj.get("pkiUserstagedID"), - "s_email_address": obj.get("sEmailAddress"), - "s_userstaged_firstname": obj.get("sUserstagedFirstname"), - "s_userstaged_lastname": obj.get("sUserstagedLastname"), - "s_userstaged_externalid": obj.get("sUserstagedExternalid") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiUserstagedID": obj.get("pkiUserstagedID"), + "sEmailAddress": obj.get("sEmailAddress"), + "sUserstagedFirstname": obj.get("sUserstagedFirstname"), + "sUserstagedLastname": obj.get("sUserstagedLastname"), + "sUserstagedExternalid": obj.get("sUserstagedExternalid") }) return _obj diff --git a/eZmaxApi/models/userstaged_map_v1_request.py b/eZmaxApi/models/userstaged_map_v1_request.py index b943e14c1..100c20309 100644 --- a/eZmaxApi/models/userstaged_map_v1_request.py +++ b/eZmaxApi/models/userstaged_map_v1_request.py @@ -19,53 +19,72 @@ import json - -from pydantic import BaseModel, Field, conint +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class UserstagedMapV1Request(BaseModel): """ - Request for POST /1/object/userstaged/{pkiUserstagedID}/map # noqa: E501 - """ - fki_user_id: conint(strict=True, ge=0) = Field(..., alias="fkiUserID", description="The unique ID of the User") - __properties = ["fkiUserID"] + Request for POST /1/object/userstaged/{pkiUserstagedID}/map + """ # noqa: E501 + fki_user_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the User", alias="fkiUserID") + __properties: ClassVar[List[str]] = ["fkiUserID"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> UserstagedMapV1Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of UserstagedMapV1Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> UserstagedMapV1Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of UserstagedMapV1Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return UserstagedMapV1Request.parse_obj(obj) + return cls.model_validate(obj) - _obj = UserstagedMapV1Request.parse_obj({ - "fki_user_id": obj.get("fkiUserID") + _obj = cls.model_validate({ + "fkiUserID": obj.get("fkiUserID") }) return _obj diff --git a/eZmaxApi/models/userstaged_map_v1_response.py b/eZmaxApi/models/userstaged_map_v1_response.py index 622b3d4ce..59151ca3e 100644 --- a/eZmaxApi/models/userstaged_map_v1_response.py +++ b/eZmaxApi/models/userstaged_map_v1_response.py @@ -19,43 +19,61 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class UserstagedMapV1Response(BaseModel): """ - Response for POST /1/object/userstaged/{pkiUserstagedID}/map # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - __properties = ["objDebugPayload", "objDebug"] + Response for POST /1/object/userstaged/{pkiUserstagedID}/map + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> UserstagedMapV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of UserstagedMapV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -65,17 +83,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> UserstagedMapV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of UserstagedMapV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return UserstagedMapV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = UserstagedMapV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None }) return _obj diff --git a/eZmaxApi/models/userstaged_response.py b/eZmaxApi/models/userstaged_response.py index dd3b0dfd8..3338fda47 100644 --- a/eZmaxApi/models/userstaged_response.py +++ b/eZmaxApi/models/userstaged_response.py @@ -19,84 +19,103 @@ import json - -from pydantic import BaseModel, Field, StrictStr, conint, constr, validator +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictStr, field_validator +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class UserstagedResponse(BaseModel): """ - A Userstaged Object # noqa: E501 - """ - pki_userstaged_id: conint(strict=True, le=65535, ge=1) = Field(..., alias="pkiUserstagedID", description="The unique ID of the Userstaged") - fki_email_id: conint(strict=True, le=16777215, ge=1) = Field(..., alias="fkiEmailID", description="The unique ID of the Email") - s_email_address: StrictStr = Field(..., alias="sEmailAddress", description="The email address.") - s_userstaged_firstname: constr(strict=True) = Field(..., alias="sUserstagedFirstname", description="The firstname of the Userstaged") - s_userstaged_lastname: constr(strict=True) = Field(..., alias="sUserstagedLastname", description="The lastname of the Userstaged") - s_userstaged_externalid: constr(strict=True) = Field(..., alias="sUserstagedExternalid", description="The externalid of the Userstaged") - __properties = ["pkiUserstagedID", "fkiEmailID", "sEmailAddress", "sUserstagedFirstname", "sUserstagedLastname", "sUserstagedExternalid"] - - @validator('s_userstaged_firstname') + A Userstaged Object + """ # noqa: E501 + pki_userstaged_id: Annotated[int, Field(le=65535, strict=True, ge=1)] = Field(description="The unique ID of the Userstaged", alias="pkiUserstagedID") + fki_email_id: Annotated[int, Field(le=16777215, strict=True, ge=1)] = Field(description="The unique ID of the Email", alias="fkiEmailID") + s_email_address: StrictStr = Field(description="The email address.", alias="sEmailAddress") + s_userstaged_firstname: Annotated[str, Field(strict=True)] = Field(description="The firstname of the Userstaged", alias="sUserstagedFirstname") + s_userstaged_lastname: Annotated[str, Field(strict=True)] = Field(description="The lastname of the Userstaged", alias="sUserstagedLastname") + s_userstaged_externalid: Annotated[str, Field(strict=True)] = Field(description="The externalid of the Userstaged", alias="sUserstagedExternalid") + __properties: ClassVar[List[str]] = ["pkiUserstagedID", "fkiEmailID", "sEmailAddress", "sUserstagedFirstname", "sUserstagedLastname", "sUserstagedExternalid"] + + @field_validator('s_userstaged_firstname') def s_userstaged_firstname_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^.{0,20}$", value): raise ValueError(r"must validate the regular expression /^.{0,20}$/") return value - @validator('s_userstaged_lastname') + @field_validator('s_userstaged_lastname') def s_userstaged_lastname_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^.{0,25}$", value): raise ValueError(r"must validate the regular expression /^.{0,25}$/") return value - @validator('s_userstaged_externalid') + @field_validator('s_userstaged_externalid') def s_userstaged_externalid_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^.{1,60}$", value): raise ValueError(r"must validate the regular expression /^.{1,60}$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> UserstagedResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of UserstagedResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> UserstagedResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of UserstagedResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return UserstagedResponse.parse_obj(obj) - - _obj = UserstagedResponse.parse_obj({ - "pki_userstaged_id": obj.get("pkiUserstagedID"), - "fki_email_id": obj.get("fkiEmailID"), - "s_email_address": obj.get("sEmailAddress"), - "s_userstaged_firstname": obj.get("sUserstagedFirstname"), - "s_userstaged_lastname": obj.get("sUserstagedLastname"), - "s_userstaged_externalid": obj.get("sUserstagedExternalid") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiUserstagedID": obj.get("pkiUserstagedID"), + "fkiEmailID": obj.get("fkiEmailID"), + "sEmailAddress": obj.get("sEmailAddress"), + "sUserstagedFirstname": obj.get("sUserstagedFirstname"), + "sUserstagedLastname": obj.get("sUserstagedLastname"), + "sUserstagedExternalid": obj.get("sUserstagedExternalid") }) return _obj diff --git a/eZmaxApi/models/userstaged_response_compound.py b/eZmaxApi/models/userstaged_response_compound.py index 10fec09da..0fbeea2ed 100644 --- a/eZmaxApi/models/userstaged_response_compound.py +++ b/eZmaxApi/models/userstaged_response_compound.py @@ -19,84 +19,103 @@ import json - -from pydantic import BaseModel, Field, StrictStr, conint, constr, validator +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictStr, field_validator +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class UserstagedResponseCompound(BaseModel): """ - A Userstaged Object # noqa: E501 - """ - pki_userstaged_id: conint(strict=True, le=65535, ge=1) = Field(..., alias="pkiUserstagedID", description="The unique ID of the Userstaged") - fki_email_id: conint(strict=True, le=16777215, ge=1) = Field(..., alias="fkiEmailID", description="The unique ID of the Email") - s_email_address: StrictStr = Field(..., alias="sEmailAddress", description="The email address.") - s_userstaged_firstname: constr(strict=True) = Field(..., alias="sUserstagedFirstname", description="The firstname of the Userstaged") - s_userstaged_lastname: constr(strict=True) = Field(..., alias="sUserstagedLastname", description="The lastname of the Userstaged") - s_userstaged_externalid: constr(strict=True) = Field(..., alias="sUserstagedExternalid", description="The externalid of the Userstaged") - __properties = ["pkiUserstagedID", "fkiEmailID", "sEmailAddress", "sUserstagedFirstname", "sUserstagedLastname", "sUserstagedExternalid"] - - @validator('s_userstaged_firstname') + A Userstaged Object + """ # noqa: E501 + pki_userstaged_id: Annotated[int, Field(le=65535, strict=True, ge=1)] = Field(description="The unique ID of the Userstaged", alias="pkiUserstagedID") + fki_email_id: Annotated[int, Field(le=16777215, strict=True, ge=1)] = Field(description="The unique ID of the Email", alias="fkiEmailID") + s_email_address: StrictStr = Field(description="The email address.", alias="sEmailAddress") + s_userstaged_firstname: Annotated[str, Field(strict=True)] = Field(description="The firstname of the Userstaged", alias="sUserstagedFirstname") + s_userstaged_lastname: Annotated[str, Field(strict=True)] = Field(description="The lastname of the Userstaged", alias="sUserstagedLastname") + s_userstaged_externalid: Annotated[str, Field(strict=True)] = Field(description="The externalid of the Userstaged", alias="sUserstagedExternalid") + __properties: ClassVar[List[str]] = ["pkiUserstagedID", "fkiEmailID", "sEmailAddress", "sUserstagedFirstname", "sUserstagedLastname", "sUserstagedExternalid"] + + @field_validator('s_userstaged_firstname') def s_userstaged_firstname_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^.{0,20}$", value): raise ValueError(r"must validate the regular expression /^.{0,20}$/") return value - @validator('s_userstaged_lastname') + @field_validator('s_userstaged_lastname') def s_userstaged_lastname_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^.{0,25}$", value): raise ValueError(r"must validate the regular expression /^.{0,25}$/") return value - @validator('s_userstaged_externalid') + @field_validator('s_userstaged_externalid') def s_userstaged_externalid_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^.{1,60}$", value): raise ValueError(r"must validate the regular expression /^.{1,60}$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> UserstagedResponseCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of UserstagedResponseCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> UserstagedResponseCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of UserstagedResponseCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return UserstagedResponseCompound.parse_obj(obj) - - _obj = UserstagedResponseCompound.parse_obj({ - "pki_userstaged_id": obj.get("pkiUserstagedID"), - "fki_email_id": obj.get("fkiEmailID"), - "s_email_address": obj.get("sEmailAddress"), - "s_userstaged_firstname": obj.get("sUserstagedFirstname"), - "s_userstaged_lastname": obj.get("sUserstagedLastname"), - "s_userstaged_externalid": obj.get("sUserstagedExternalid") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiUserstagedID": obj.get("pkiUserstagedID"), + "fkiEmailID": obj.get("fkiEmailID"), + "sEmailAddress": obj.get("sEmailAddress"), + "sUserstagedFirstname": obj.get("sUserstagedFirstname"), + "sUserstagedLastname": obj.get("sUserstagedLastname"), + "sUserstagedExternalid": obj.get("sUserstagedExternalid") }) return _obj diff --git a/eZmaxApi/models/variableexpense_autocomplete_element_response.py b/eZmaxApi/models/variableexpense_autocomplete_element_response.py index bf6d3ed34..e1e0e15df 100644 --- a/eZmaxApi/models/variableexpense_autocomplete_element_response.py +++ b/eZmaxApi/models/variableexpense_autocomplete_element_response.py @@ -19,64 +19,83 @@ import json - -from pydantic import BaseModel, Field, StrictBool, conint, constr, validator +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictBool, field_validator +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class VariableexpenseAutocompleteElementResponse(BaseModel): """ - A Variableexpense AutocompleteElement Response # noqa: E501 - """ - s_variableexpense_description_x: constr(strict=True) = Field(..., alias="sVariableexpenseDescriptionX", description="The description of the Variableexpense in the language of the requester") - pki_variableexpense_id: conint(strict=True, le=255, ge=1) = Field(..., alias="pkiVariableexpenseID", description="The unique ID of the Variableexpense") - b_variableexpense_isactive: StrictBool = Field(..., alias="bVariableexpenseIsactive", description="Whether the variableexpense is active or not") - __properties = ["sVariableexpenseDescriptionX", "pkiVariableexpenseID", "bVariableexpenseIsactive"] - - @validator('s_variableexpense_description_x') + A Variableexpense AutocompleteElement Response + """ # noqa: E501 + s_variableexpense_description_x: Annotated[str, Field(strict=True)] = Field(description="The description of the Variableexpense in the language of the requester", alias="sVariableexpenseDescriptionX") + pki_variableexpense_id: Annotated[int, Field(le=255, strict=True, ge=1)] = Field(description="The unique ID of the Variableexpense", alias="pkiVariableexpenseID") + b_variableexpense_isactive: StrictBool = Field(description="Whether the variableexpense is active or not", alias="bVariableexpenseIsactive") + __properties: ClassVar[List[str]] = ["sVariableexpenseDescriptionX", "pkiVariableexpenseID", "bVariableexpenseIsactive"] + + @field_validator('s_variableexpense_description_x') def s_variableexpense_description_x_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^.{0,40}$", value): raise ValueError(r"must validate the regular expression /^.{0,40}$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> VariableexpenseAutocompleteElementResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of VariableexpenseAutocompleteElementResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> VariableexpenseAutocompleteElementResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of VariableexpenseAutocompleteElementResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return VariableexpenseAutocompleteElementResponse.parse_obj(obj) + return cls.model_validate(obj) - _obj = VariableexpenseAutocompleteElementResponse.parse_obj({ - "s_variableexpense_description_x": obj.get("sVariableexpenseDescriptionX"), - "pki_variableexpense_id": obj.get("pkiVariableexpenseID"), - "b_variableexpense_isactive": obj.get("bVariableexpenseIsactive") + _obj = cls.model_validate({ + "sVariableexpenseDescriptionX": obj.get("sVariableexpenseDescriptionX"), + "pkiVariableexpenseID": obj.get("pkiVariableexpenseID"), + "bVariableexpenseIsactive": obj.get("bVariableexpenseIsactive") }) return _obj diff --git a/eZmaxApi/models/variableexpense_create_object_v1_request.py b/eZmaxApi/models/variableexpense_create_object_v1_request.py index 518f111ae..7f2f2be52 100644 --- a/eZmaxApi/models/variableexpense_create_object_v1_request.py +++ b/eZmaxApi/models/variableexpense_create_object_v1_request.py @@ -19,41 +19,60 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.variableexpense_request_compound import VariableexpenseRequestCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class VariableexpenseCreateObjectV1Request(BaseModel): """ - Request for POST /1/object/variableexpense # noqa: E501 - """ - a_obj_variableexpense: conlist(VariableexpenseRequestCompound, min_items=1) = Field(..., alias="a_objVariableexpense") - __properties = ["a_objVariableexpense"] + Request for POST /1/object/variableexpense + """ # noqa: E501 + a_obj_variableexpense: Annotated[List[VariableexpenseRequestCompound], Field(min_length=1)] = Field(alias="a_objVariableexpense") + __properties: ClassVar[List[str]] = ["a_objVariableexpense"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> VariableexpenseCreateObjectV1Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of VariableexpenseCreateObjectV1Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_variableexpense (list) _items = [] if self.a_obj_variableexpense: @@ -64,16 +83,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> VariableexpenseCreateObjectV1Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of VariableexpenseCreateObjectV1Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return VariableexpenseCreateObjectV1Request.parse_obj(obj) + return cls.model_validate(obj) - _obj = VariableexpenseCreateObjectV1Request.parse_obj({ - "a_obj_variableexpense": [VariableexpenseRequestCompound.from_dict(_item) for _item in obj.get("a_objVariableexpense")] if obj.get("a_objVariableexpense") is not None else None + _obj = cls.model_validate({ + "a_objVariableexpense": [VariableexpenseRequestCompound.from_dict(_item) for _item in obj.get("a_objVariableexpense")] if obj.get("a_objVariableexpense") is not None else None }) return _obj diff --git a/eZmaxApi/models/variableexpense_create_object_v1_response.py b/eZmaxApi/models/variableexpense_create_object_v1_response.py index c8721a82a..d57147037 100644 --- a/eZmaxApi/models/variableexpense_create_object_v1_response.py +++ b/eZmaxApi/models/variableexpense_create_object_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.variableexpense_create_object_v1_response_m_payload import VariableexpenseCreateObjectV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class VariableexpenseCreateObjectV1Response(BaseModel): """ - Response for POST /1/object/variableexpense # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: VariableexpenseCreateObjectV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for POST /1/object/variableexpense + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: VariableexpenseCreateObjectV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> VariableexpenseCreateObjectV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of VariableexpenseCreateObjectV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> VariableexpenseCreateObjectV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of VariableexpenseCreateObjectV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return VariableexpenseCreateObjectV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = VariableexpenseCreateObjectV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": VariableexpenseCreateObjectV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": VariableexpenseCreateObjectV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/variableexpense_create_object_v1_response_m_payload.py b/eZmaxApi/models/variableexpense_create_object_v1_response_m_payload.py index 899f0d82d..1ef1caa39 100644 --- a/eZmaxApi/models/variableexpense_create_object_v1_response_m_payload.py +++ b/eZmaxApi/models/variableexpense_create_object_v1_response_m_payload.py @@ -19,53 +19,72 @@ import json -from typing import List -from pydantic import BaseModel, Field, conint, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class VariableexpenseCreateObjectV1ResponseMPayload(BaseModel): """ - Payload for POST /1/object/variableexpense # noqa: E501 - """ - a_pki_variableexpense_id: conlist(conint(strict=True, le=255, ge=1)) = Field(..., alias="a_pkiVariableexpenseID", description="An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request.") - __properties = ["a_pkiVariableexpenseID"] + Payload for POST /1/object/variableexpense + """ # noqa: E501 + a_pki_variableexpense_id: List[Annotated[int, Field(le=255, strict=True, ge=1)]] = Field(description="An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request.", alias="a_pkiVariableexpenseID") + __properties: ClassVar[List[str]] = ["a_pkiVariableexpenseID"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> VariableexpenseCreateObjectV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of VariableexpenseCreateObjectV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> VariableexpenseCreateObjectV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of VariableexpenseCreateObjectV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return VariableexpenseCreateObjectV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = VariableexpenseCreateObjectV1ResponseMPayload.parse_obj({ - "a_pki_variableexpense_id": obj.get("a_pkiVariableexpenseID") + _obj = cls.model_validate({ + "a_pkiVariableexpenseID": obj.get("a_pkiVariableexpenseID") }) return _obj diff --git a/eZmaxApi/models/variableexpense_edit_object_v1_request.py b/eZmaxApi/models/variableexpense_edit_object_v1_request.py index 3df09d695..1114cc2dd 100644 --- a/eZmaxApi/models/variableexpense_edit_object_v1_request.py +++ b/eZmaxApi/models/variableexpense_edit_object_v1_request.py @@ -19,57 +19,75 @@ import json - -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.variableexpense_request_compound import VariableexpenseRequestCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class VariableexpenseEditObjectV1Request(BaseModel): """ - Request for PUT /1/object/variableexpense/{pkiVariableexpenseID} # noqa: E501 - """ - obj_variableexpense: VariableexpenseRequestCompound = Field(..., alias="objVariableexpense") - __properties = ["objVariableexpense"] + Request for PUT /1/object/variableexpense/{pkiVariableexpenseID} + """ # noqa: E501 + obj_variableexpense: VariableexpenseRequestCompound = Field(alias="objVariableexpense") + __properties: ClassVar[List[str]] = ["objVariableexpense"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> VariableexpenseEditObjectV1Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of VariableexpenseEditObjectV1Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_variableexpense if self.obj_variableexpense: _dict['objVariableexpense'] = self.obj_variableexpense.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> VariableexpenseEditObjectV1Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of VariableexpenseEditObjectV1Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return VariableexpenseEditObjectV1Request.parse_obj(obj) + return cls.model_validate(obj) - _obj = VariableexpenseEditObjectV1Request.parse_obj({ - "obj_variableexpense": VariableexpenseRequestCompound.from_dict(obj.get("objVariableexpense")) if obj.get("objVariableexpense") is not None else None + _obj = cls.model_validate({ + "objVariableexpense": VariableexpenseRequestCompound.from_dict(obj.get("objVariableexpense")) if obj.get("objVariableexpense") is not None else None }) return _obj diff --git a/eZmaxApi/models/variableexpense_edit_object_v1_response.py b/eZmaxApi/models/variableexpense_edit_object_v1_response.py index 776fa1821..002af4250 100644 --- a/eZmaxApi/models/variableexpense_edit_object_v1_response.py +++ b/eZmaxApi/models/variableexpense_edit_object_v1_response.py @@ -19,43 +19,61 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class VariableexpenseEditObjectV1Response(BaseModel): """ - Response for PUT /1/object/variableexpense/{pkiVariableexpenseID} # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - __properties = ["objDebugPayload", "objDebug"] + Response for PUT /1/object/variableexpense/{pkiVariableexpenseID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> VariableexpenseEditObjectV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of VariableexpenseEditObjectV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -65,17 +83,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> VariableexpenseEditObjectV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of VariableexpenseEditObjectV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return VariableexpenseEditObjectV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = VariableexpenseEditObjectV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None }) return _obj diff --git a/eZmaxApi/models/variableexpense_get_autocomplete_v2_response.py b/eZmaxApi/models/variableexpense_get_autocomplete_v2_response.py index 23b36345c..40f3ac37b 100644 --- a/eZmaxApi/models/variableexpense_get_autocomplete_v2_response.py +++ b/eZmaxApi/models/variableexpense_get_autocomplete_v2_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.variableexpense_get_autocomplete_v2_response_m_payload import VariableexpenseGetAutocompleteV2ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class VariableexpenseGetAutocompleteV2Response(BaseModel): """ - Response for GET /2/object/variableexpense/getAutocomplete # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: VariableexpenseGetAutocompleteV2ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /2/object/variableexpense/getAutocomplete + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: VariableexpenseGetAutocompleteV2ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> VariableexpenseGetAutocompleteV2Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of VariableexpenseGetAutocompleteV2Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> VariableexpenseGetAutocompleteV2Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of VariableexpenseGetAutocompleteV2Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return VariableexpenseGetAutocompleteV2Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = VariableexpenseGetAutocompleteV2Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": VariableexpenseGetAutocompleteV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": VariableexpenseGetAutocompleteV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/variableexpense_get_autocomplete_v2_response_m_payload.py b/eZmaxApi/models/variableexpense_get_autocomplete_v2_response_m_payload.py index c1b2533d2..ddf053dba 100644 --- a/eZmaxApi/models/variableexpense_get_autocomplete_v2_response_m_payload.py +++ b/eZmaxApi/models/variableexpense_get_autocomplete_v2_response_m_payload.py @@ -19,41 +19,59 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.variableexpense_autocomplete_element_response import VariableexpenseAutocompleteElementResponse +try: + from typing import Self +except ImportError: + from typing_extensions import Self class VariableexpenseGetAutocompleteV2ResponseMPayload(BaseModel): """ - Payload for POST /2/object/variableexpense/getAutocomplete # noqa: E501 - """ - a_obj_variableexpense: conlist(VariableexpenseAutocompleteElementResponse) = Field(..., alias="a_objVariableexpense", description="An array of Variableexpense autocomplete element response.") - __properties = ["a_objVariableexpense"] + Payload for POST /2/object/variableexpense/getAutocomplete + """ # noqa: E501 + a_obj_variableexpense: List[VariableexpenseAutocompleteElementResponse] = Field(description="An array of Variableexpense autocomplete element response.", alias="a_objVariableexpense") + __properties: ClassVar[List[str]] = ["a_objVariableexpense"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> VariableexpenseGetAutocompleteV2ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of VariableexpenseGetAutocompleteV2ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_variableexpense (list) _items = [] if self.a_obj_variableexpense: @@ -64,16 +82,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> VariableexpenseGetAutocompleteV2ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of VariableexpenseGetAutocompleteV2ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return VariableexpenseGetAutocompleteV2ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = VariableexpenseGetAutocompleteV2ResponseMPayload.parse_obj({ - "a_obj_variableexpense": [VariableexpenseAutocompleteElementResponse.from_dict(_item) for _item in obj.get("a_objVariableexpense")] if obj.get("a_objVariableexpense") is not None else None + _obj = cls.model_validate({ + "a_objVariableexpense": [VariableexpenseAutocompleteElementResponse.from_dict(_item) for _item in obj.get("a_objVariableexpense")] if obj.get("a_objVariableexpense") is not None else None }) return _obj diff --git a/eZmaxApi/models/variableexpense_get_list_v1_response.py b/eZmaxApi/models/variableexpense_get_list_v1_response.py index 63411e081..b5bed91b3 100644 --- a/eZmaxApi/models/variableexpense_get_list_v1_response.py +++ b/eZmaxApi/models/variableexpense_get_list_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload_get_list import CommonResponseObjDebugPayloadGetList from eZmaxApi.models.variableexpense_get_list_v1_response_m_payload import VariableexpenseGetListV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class VariableexpenseGetListV1Response(BaseModel): """ - Response for GET /1/object/variableexpense/getList # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayloadGetList = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: VariableexpenseGetListV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /1/object/variableexpense/getList + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayloadGetList = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: VariableexpenseGetListV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> VariableexpenseGetListV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of VariableexpenseGetListV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> VariableexpenseGetListV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of VariableexpenseGetListV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return VariableexpenseGetListV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = VariableexpenseGetListV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayloadGetList.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": VariableexpenseGetListV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayloadGetList.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": VariableexpenseGetListV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/variableexpense_get_list_v1_response_m_payload.py b/eZmaxApi/models/variableexpense_get_list_v1_response_m_payload.py index 42b91caf9..7158a9d74 100644 --- a/eZmaxApi/models/variableexpense_get_list_v1_response_m_payload.py +++ b/eZmaxApi/models/variableexpense_get_list_v1_response_m_payload.py @@ -19,43 +19,61 @@ import json -from typing import List -from pydantic import BaseModel, Field, StrictInt, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictInt +from pydantic import Field from eZmaxApi.models.variableexpense_list_element import VariableexpenseListElement +try: + from typing import Self +except ImportError: + from typing_extensions import Self class VariableexpenseGetListV1ResponseMPayload(BaseModel): """ - Payload for GET /1/object/variableexpense/getList # noqa: E501 - """ - i_row_returned: StrictInt = Field(..., alias="iRowReturned", description="The number of rows returned") - i_row_filtered: StrictInt = Field(..., alias="iRowFiltered", description="The number of rows matching your filters (if any) or the total number of rows") - a_obj_variableexpense: conlist(VariableexpenseListElement) = Field(..., alias="a_objVariableexpense") - __properties = ["iRowReturned", "iRowFiltered", "a_objVariableexpense"] + Payload for GET /1/object/variableexpense/getList + """ # noqa: E501 + i_row_returned: StrictInt = Field(description="The number of rows returned", alias="iRowReturned") + i_row_filtered: StrictInt = Field(description="The number of rows matching your filters (if any) or the total number of rows", alias="iRowFiltered") + a_obj_variableexpense: List[VariableexpenseListElement] = Field(alias="a_objVariableexpense") + __properties: ClassVar[List[str]] = ["iRowReturned", "iRowFiltered", "a_objVariableexpense"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> VariableexpenseGetListV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of VariableexpenseGetListV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_variableexpense (list) _items = [] if self.a_obj_variableexpense: @@ -66,18 +84,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> VariableexpenseGetListV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of VariableexpenseGetListV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return VariableexpenseGetListV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = VariableexpenseGetListV1ResponseMPayload.parse_obj({ - "i_row_returned": obj.get("iRowReturned"), - "i_row_filtered": obj.get("iRowFiltered"), - "a_obj_variableexpense": [VariableexpenseListElement.from_dict(_item) for _item in obj.get("a_objVariableexpense")] if obj.get("a_objVariableexpense") is not None else None + _obj = cls.model_validate({ + "iRowReturned": obj.get("iRowReturned"), + "iRowFiltered": obj.get("iRowFiltered"), + "a_objVariableexpense": [VariableexpenseListElement.from_dict(_item) for _item in obj.get("a_objVariableexpense")] if obj.get("a_objVariableexpense") is not None else None }) return _obj diff --git a/eZmaxApi/models/variableexpense_get_object_v2_response.py b/eZmaxApi/models/variableexpense_get_object_v2_response.py index 13612a206..5b75804a3 100644 --- a/eZmaxApi/models/variableexpense_get_object_v2_response.py +++ b/eZmaxApi/models/variableexpense_get_object_v2_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.variableexpense_get_object_v2_response_m_payload import VariableexpenseGetObjectV2ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class VariableexpenseGetObjectV2Response(BaseModel): """ - Response for GET /2/object/variableexpense/{pkiVariableexpenseID} # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: VariableexpenseGetObjectV2ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /2/object/variableexpense/{pkiVariableexpenseID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: VariableexpenseGetObjectV2ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> VariableexpenseGetObjectV2Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of VariableexpenseGetObjectV2Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> VariableexpenseGetObjectV2Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of VariableexpenseGetObjectV2Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return VariableexpenseGetObjectV2Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = VariableexpenseGetObjectV2Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": VariableexpenseGetObjectV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": VariableexpenseGetObjectV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/variableexpense_get_object_v2_response_m_payload.py b/eZmaxApi/models/variableexpense_get_object_v2_response_m_payload.py index a01b2ec1e..c84ada7f7 100644 --- a/eZmaxApi/models/variableexpense_get_object_v2_response_m_payload.py +++ b/eZmaxApi/models/variableexpense_get_object_v2_response_m_payload.py @@ -19,57 +19,75 @@ import json - -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.variableexpense_response_compound import VariableexpenseResponseCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class VariableexpenseGetObjectV2ResponseMPayload(BaseModel): """ - Payload for GET /2/object/variableexpense/{pkiVariableexpenseID} # noqa: E501 - """ - obj_variableexpense: VariableexpenseResponseCompound = Field(..., alias="objVariableexpense") - __properties = ["objVariableexpense"] + Payload for GET /2/object/variableexpense/{pkiVariableexpenseID} + """ # noqa: E501 + obj_variableexpense: VariableexpenseResponseCompound = Field(alias="objVariableexpense") + __properties: ClassVar[List[str]] = ["objVariableexpense"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> VariableexpenseGetObjectV2ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of VariableexpenseGetObjectV2ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_variableexpense if self.obj_variableexpense: _dict['objVariableexpense'] = self.obj_variableexpense.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> VariableexpenseGetObjectV2ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of VariableexpenseGetObjectV2ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return VariableexpenseGetObjectV2ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = VariableexpenseGetObjectV2ResponseMPayload.parse_obj({ - "obj_variableexpense": VariableexpenseResponseCompound.from_dict(obj.get("objVariableexpense")) if obj.get("objVariableexpense") is not None else None + _obj = cls.model_validate({ + "objVariableexpense": VariableexpenseResponseCompound.from_dict(obj.get("objVariableexpense")) if obj.get("objVariableexpense") is not None else None }) return _obj diff --git a/eZmaxApi/models/variableexpense_list_element.py b/eZmaxApi/models/variableexpense_list_element.py index 256b7c97e..fc7fc6cc7 100644 --- a/eZmaxApi/models/variableexpense_list_element.py +++ b/eZmaxApi/models/variableexpense_list_element.py @@ -19,22 +19,28 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictBool, conint, constr, validator +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, field_validator +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.field_e_variableexpense_taxable import FieldEVariableexpenseTaxable +try: + from typing import Self +except ImportError: + from typing_extensions import Self class VariableexpenseListElement(BaseModel): """ - A Variableexpense List Element # noqa: E501 - """ - pki_variableexpense_id: conint(strict=True, le=255, ge=1) = Field(..., alias="pkiVariableexpenseID", description="The unique ID of the Variableexpense") - s_variableexpense_code: Optional[constr(strict=True)] = Field(None, alias="sVariableexpenseCode", description="The code of the Variableexpense") - s_variableexpense_description_x: Optional[constr(strict=True)] = Field(None, alias="sVariableexpenseDescriptionX", description="The description of the Variableexpense in the language of the requester") - e_variableexpense_taxable: Optional[FieldEVariableexpenseTaxable] = Field(None, alias="eVariableexpenseTaxable") - b_variableexpense_isactive: Optional[StrictBool] = Field(None, alias="bVariableexpenseIsactive", description="Whether the variableexpense is active or not") - __properties = ["pkiVariableexpenseID", "sVariableexpenseCode", "sVariableexpenseDescriptionX", "eVariableexpenseTaxable", "bVariableexpenseIsactive"] - - @validator('s_variableexpense_code') + A Variableexpense List Element + """ # noqa: E501 + pki_variableexpense_id: Annotated[int, Field(le=255, strict=True, ge=1)] = Field(description="The unique ID of the Variableexpense", alias="pkiVariableexpenseID") + s_variableexpense_code: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="The code of the Variableexpense", alias="sVariableexpenseCode") + s_variableexpense_description_x: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="The description of the Variableexpense in the language of the requester", alias="sVariableexpenseDescriptionX") + e_variableexpense_taxable: Optional[FieldEVariableexpenseTaxable] = Field(default=None, alias="eVariableexpenseTaxable") + b_variableexpense_isactive: Optional[StrictBool] = Field(default=None, description="Whether the variableexpense is active or not", alias="bVariableexpenseIsactive") + __properties: ClassVar[List[str]] = ["pkiVariableexpenseID", "sVariableexpenseCode", "sVariableexpenseDescriptionX", "eVariableexpenseTaxable", "bVariableexpenseIsactive"] + + @field_validator('s_variableexpense_code') def s_variableexpense_code_validate_regular_expression(cls, value): """Validates the regular expression""" if value is None: @@ -44,7 +50,7 @@ def s_variableexpense_code_validate_regular_expression(cls, value): raise ValueError(r"must validate the regular expression /^.{0,5}$/") return value - @validator('s_variableexpense_description_x') + @field_validator('s_variableexpense_description_x') def s_variableexpense_description_x_validate_regular_expression(cls, value): """Validates the regular expression""" if value is None: @@ -54,47 +60,60 @@ def s_variableexpense_description_x_validate_regular_expression(cls, value): raise ValueError(r"must validate the regular expression /^.{0,40}$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> VariableexpenseListElement: + def from_json(cls, json_str: str) -> Self: """Create an instance of VariableexpenseListElement from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> VariableexpenseListElement: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of VariableexpenseListElement from a dict""" if obj is None: return None if not isinstance(obj, dict): - return VariableexpenseListElement.parse_obj(obj) - - _obj = VariableexpenseListElement.parse_obj({ - "pki_variableexpense_id": obj.get("pkiVariableexpenseID"), - "s_variableexpense_code": obj.get("sVariableexpenseCode"), - "s_variableexpense_description_x": obj.get("sVariableexpenseDescriptionX"), - "e_variableexpense_taxable": obj.get("eVariableexpenseTaxable"), - "b_variableexpense_isactive": obj.get("bVariableexpenseIsactive") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiVariableexpenseID": obj.get("pkiVariableexpenseID"), + "sVariableexpenseCode": obj.get("sVariableexpenseCode"), + "sVariableexpenseDescriptionX": obj.get("sVariableexpenseDescriptionX"), + "eVariableexpenseTaxable": obj.get("eVariableexpenseTaxable"), + "bVariableexpenseIsactive": obj.get("bVariableexpenseIsactive") }) return _obj diff --git a/eZmaxApi/models/variableexpense_request.py b/eZmaxApi/models/variableexpense_request.py index e0d693d79..b8be125ff 100644 --- a/eZmaxApi/models/variableexpense_request.py +++ b/eZmaxApi/models/variableexpense_request.py @@ -19,73 +19,92 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictBool, conint, constr, validator +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, field_validator +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.field_e_variableexpense_taxable import FieldEVariableexpenseTaxable from eZmaxApi.models.multilingual_variableexpense_description import MultilingualVariableexpenseDescription +try: + from typing import Self +except ImportError: + from typing_extensions import Self class VariableexpenseRequest(BaseModel): """ - A Variableexpense Object # noqa: E501 - """ - pki_variableexpense_id: Optional[conint(strict=True, le=255, ge=1)] = Field(None, alias="pkiVariableexpenseID", description="The unique ID of the Variableexpense") - s_variableexpense_code: constr(strict=True) = Field(..., alias="sVariableexpenseCode", description="The code of the Variableexpense") - obj_variableexpense_description: MultilingualVariableexpenseDescription = Field(..., alias="objVariableexpenseDescription") - e_variableexpense_taxable: FieldEVariableexpenseTaxable = Field(..., alias="eVariableexpenseTaxable") - b_variableexpense_isactive: StrictBool = Field(..., alias="bVariableexpenseIsactive", description="Whether the variableexpense is active or not") - __properties = ["pkiVariableexpenseID", "sVariableexpenseCode", "objVariableexpenseDescription", "eVariableexpenseTaxable", "bVariableexpenseIsactive"] - - @validator('s_variableexpense_code') + A Variableexpense Object + """ # noqa: E501 + pki_variableexpense_id: Optional[Annotated[int, Field(le=255, strict=True, ge=1)]] = Field(default=None, description="The unique ID of the Variableexpense", alias="pkiVariableexpenseID") + s_variableexpense_code: Annotated[str, Field(strict=True)] = Field(description="The code of the Variableexpense", alias="sVariableexpenseCode") + obj_variableexpense_description: MultilingualVariableexpenseDescription = Field(alias="objVariableexpenseDescription") + e_variableexpense_taxable: FieldEVariableexpenseTaxable = Field(alias="eVariableexpenseTaxable") + b_variableexpense_isactive: StrictBool = Field(description="Whether the variableexpense is active or not", alias="bVariableexpenseIsactive") + __properties: ClassVar[List[str]] = ["pkiVariableexpenseID", "sVariableexpenseCode", "objVariableexpenseDescription", "eVariableexpenseTaxable", "bVariableexpenseIsactive"] + + @field_validator('s_variableexpense_code') def s_variableexpense_code_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^.{0,5}$", value): raise ValueError(r"must validate the regular expression /^.{0,5}$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> VariableexpenseRequest: + def from_json(cls, json_str: str) -> Self: """Create an instance of VariableexpenseRequest from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_variableexpense_description if self.obj_variableexpense_description: _dict['objVariableexpenseDescription'] = self.obj_variableexpense_description.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> VariableexpenseRequest: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of VariableexpenseRequest from a dict""" if obj is None: return None if not isinstance(obj, dict): - return VariableexpenseRequest.parse_obj(obj) - - _obj = VariableexpenseRequest.parse_obj({ - "pki_variableexpense_id": obj.get("pkiVariableexpenseID"), - "s_variableexpense_code": obj.get("sVariableexpenseCode"), - "obj_variableexpense_description": MultilingualVariableexpenseDescription.from_dict(obj.get("objVariableexpenseDescription")) if obj.get("objVariableexpenseDescription") is not None else None, - "e_variableexpense_taxable": obj.get("eVariableexpenseTaxable"), - "b_variableexpense_isactive": obj.get("bVariableexpenseIsactive") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiVariableexpenseID": obj.get("pkiVariableexpenseID"), + "sVariableexpenseCode": obj.get("sVariableexpenseCode"), + "objVariableexpenseDescription": MultilingualVariableexpenseDescription.from_dict(obj.get("objVariableexpenseDescription")) if obj.get("objVariableexpenseDescription") is not None else None, + "eVariableexpenseTaxable": obj.get("eVariableexpenseTaxable"), + "bVariableexpenseIsactive": obj.get("bVariableexpenseIsactive") }) return _obj diff --git a/eZmaxApi/models/variableexpense_request_compound.py b/eZmaxApi/models/variableexpense_request_compound.py index 213152e46..275aabbb5 100644 --- a/eZmaxApi/models/variableexpense_request_compound.py +++ b/eZmaxApi/models/variableexpense_request_compound.py @@ -19,73 +19,92 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictBool, conint, constr, validator +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, field_validator +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.field_e_variableexpense_taxable import FieldEVariableexpenseTaxable from eZmaxApi.models.multilingual_variableexpense_description import MultilingualVariableexpenseDescription +try: + from typing import Self +except ImportError: + from typing_extensions import Self class VariableexpenseRequestCompound(BaseModel): """ - A Variableexpense Object and children # noqa: E501 - """ - pki_variableexpense_id: Optional[conint(strict=True, le=255, ge=1)] = Field(None, alias="pkiVariableexpenseID", description="The unique ID of the Variableexpense") - s_variableexpense_code: constr(strict=True) = Field(..., alias="sVariableexpenseCode", description="The code of the Variableexpense") - obj_variableexpense_description: MultilingualVariableexpenseDescription = Field(..., alias="objVariableexpenseDescription") - e_variableexpense_taxable: FieldEVariableexpenseTaxable = Field(..., alias="eVariableexpenseTaxable") - b_variableexpense_isactive: StrictBool = Field(..., alias="bVariableexpenseIsactive", description="Whether the variableexpense is active or not") - __properties = ["pkiVariableexpenseID", "sVariableexpenseCode", "objVariableexpenseDescription", "eVariableexpenseTaxable", "bVariableexpenseIsactive"] - - @validator('s_variableexpense_code') + A Variableexpense Object and children + """ # noqa: E501 + pki_variableexpense_id: Optional[Annotated[int, Field(le=255, strict=True, ge=1)]] = Field(default=None, description="The unique ID of the Variableexpense", alias="pkiVariableexpenseID") + s_variableexpense_code: Annotated[str, Field(strict=True)] = Field(description="The code of the Variableexpense", alias="sVariableexpenseCode") + obj_variableexpense_description: MultilingualVariableexpenseDescription = Field(alias="objVariableexpenseDescription") + e_variableexpense_taxable: FieldEVariableexpenseTaxable = Field(alias="eVariableexpenseTaxable") + b_variableexpense_isactive: StrictBool = Field(description="Whether the variableexpense is active or not", alias="bVariableexpenseIsactive") + __properties: ClassVar[List[str]] = ["pkiVariableexpenseID", "sVariableexpenseCode", "objVariableexpenseDescription", "eVariableexpenseTaxable", "bVariableexpenseIsactive"] + + @field_validator('s_variableexpense_code') def s_variableexpense_code_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^.{0,5}$", value): raise ValueError(r"must validate the regular expression /^.{0,5}$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> VariableexpenseRequestCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of VariableexpenseRequestCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_variableexpense_description if self.obj_variableexpense_description: _dict['objVariableexpenseDescription'] = self.obj_variableexpense_description.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> VariableexpenseRequestCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of VariableexpenseRequestCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return VariableexpenseRequestCompound.parse_obj(obj) - - _obj = VariableexpenseRequestCompound.parse_obj({ - "pki_variableexpense_id": obj.get("pkiVariableexpenseID"), - "s_variableexpense_code": obj.get("sVariableexpenseCode"), - "obj_variableexpense_description": MultilingualVariableexpenseDescription.from_dict(obj.get("objVariableexpenseDescription")) if obj.get("objVariableexpenseDescription") is not None else None, - "e_variableexpense_taxable": obj.get("eVariableexpenseTaxable"), - "b_variableexpense_isactive": obj.get("bVariableexpenseIsactive") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiVariableexpenseID": obj.get("pkiVariableexpenseID"), + "sVariableexpenseCode": obj.get("sVariableexpenseCode"), + "objVariableexpenseDescription": MultilingualVariableexpenseDescription.from_dict(obj.get("objVariableexpenseDescription")) if obj.get("objVariableexpenseDescription") is not None else None, + "eVariableexpenseTaxable": obj.get("eVariableexpenseTaxable"), + "bVariableexpenseIsactive": obj.get("bVariableexpenseIsactive") }) return _obj diff --git a/eZmaxApi/models/variableexpense_response.py b/eZmaxApi/models/variableexpense_response.py index 43810720a..685e301c6 100644 --- a/eZmaxApi/models/variableexpense_response.py +++ b/eZmaxApi/models/variableexpense_response.py @@ -19,23 +19,29 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictBool, conint, constr, validator +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, field_validator +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.field_e_variableexpense_taxable import FieldEVariableexpenseTaxable from eZmaxApi.models.multilingual_variableexpense_description import MultilingualVariableexpenseDescription +try: + from typing import Self +except ImportError: + from typing_extensions import Self class VariableexpenseResponse(BaseModel): """ - A Variableexpense Object # noqa: E501 - """ - pki_variableexpense_id: conint(strict=True, le=255, ge=1) = Field(..., alias="pkiVariableexpenseID", description="The unique ID of the Variableexpense") - s_variableexpense_code: Optional[constr(strict=True)] = Field(None, alias="sVariableexpenseCode", description="The code of the Variableexpense") - obj_variableexpense_description: MultilingualVariableexpenseDescription = Field(..., alias="objVariableexpenseDescription") - e_variableexpense_taxable: Optional[FieldEVariableexpenseTaxable] = Field(None, alias="eVariableexpenseTaxable") - b_variableexpense_isactive: Optional[StrictBool] = Field(None, alias="bVariableexpenseIsactive", description="Whether the variableexpense is active or not") - __properties = ["pkiVariableexpenseID", "sVariableexpenseCode", "objVariableexpenseDescription", "eVariableexpenseTaxable", "bVariableexpenseIsactive"] - - @validator('s_variableexpense_code') + A Variableexpense Object + """ # noqa: E501 + pki_variableexpense_id: Annotated[int, Field(le=255, strict=True, ge=1)] = Field(description="The unique ID of the Variableexpense", alias="pkiVariableexpenseID") + s_variableexpense_code: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="The code of the Variableexpense", alias="sVariableexpenseCode") + obj_variableexpense_description: MultilingualVariableexpenseDescription = Field(alias="objVariableexpenseDescription") + e_variableexpense_taxable: Optional[FieldEVariableexpenseTaxable] = Field(default=None, alias="eVariableexpenseTaxable") + b_variableexpense_isactive: Optional[StrictBool] = Field(default=None, description="Whether the variableexpense is active or not", alias="bVariableexpenseIsactive") + __properties: ClassVar[List[str]] = ["pkiVariableexpenseID", "sVariableexpenseCode", "objVariableexpenseDescription", "eVariableexpenseTaxable", "bVariableexpenseIsactive"] + + @field_validator('s_variableexpense_code') def s_variableexpense_code_validate_regular_expression(cls, value): """Validates the regular expression""" if value is None: @@ -45,50 +51,63 @@ def s_variableexpense_code_validate_regular_expression(cls, value): raise ValueError(r"must validate the regular expression /^.{0,5}$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> VariableexpenseResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of VariableexpenseResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_variableexpense_description if self.obj_variableexpense_description: _dict['objVariableexpenseDescription'] = self.obj_variableexpense_description.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> VariableexpenseResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of VariableexpenseResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return VariableexpenseResponse.parse_obj(obj) - - _obj = VariableexpenseResponse.parse_obj({ - "pki_variableexpense_id": obj.get("pkiVariableexpenseID"), - "s_variableexpense_code": obj.get("sVariableexpenseCode"), - "obj_variableexpense_description": MultilingualVariableexpenseDescription.from_dict(obj.get("objVariableexpenseDescription")) if obj.get("objVariableexpenseDescription") is not None else None, - "e_variableexpense_taxable": obj.get("eVariableexpenseTaxable"), - "b_variableexpense_isactive": obj.get("bVariableexpenseIsactive") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiVariableexpenseID": obj.get("pkiVariableexpenseID"), + "sVariableexpenseCode": obj.get("sVariableexpenseCode"), + "objVariableexpenseDescription": MultilingualVariableexpenseDescription.from_dict(obj.get("objVariableexpenseDescription")) if obj.get("objVariableexpenseDescription") is not None else None, + "eVariableexpenseTaxable": obj.get("eVariableexpenseTaxable"), + "bVariableexpenseIsactive": obj.get("bVariableexpenseIsactive") }) return _obj diff --git a/eZmaxApi/models/variableexpense_response_compound.py b/eZmaxApi/models/variableexpense_response_compound.py index 22e2392a4..771b49bff 100644 --- a/eZmaxApi/models/variableexpense_response_compound.py +++ b/eZmaxApi/models/variableexpense_response_compound.py @@ -19,23 +19,29 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictBool, conint, constr, validator +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, field_validator +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.field_e_variableexpense_taxable import FieldEVariableexpenseTaxable from eZmaxApi.models.multilingual_variableexpense_description import MultilingualVariableexpenseDescription +try: + from typing import Self +except ImportError: + from typing_extensions import Self class VariableexpenseResponseCompound(BaseModel): """ - A Variableexpense Object # noqa: E501 - """ - pki_variableexpense_id: conint(strict=True, le=255, ge=1) = Field(..., alias="pkiVariableexpenseID", description="The unique ID of the Variableexpense") - s_variableexpense_code: Optional[constr(strict=True)] = Field(None, alias="sVariableexpenseCode", description="The code of the Variableexpense") - obj_variableexpense_description: MultilingualVariableexpenseDescription = Field(..., alias="objVariableexpenseDescription") - e_variableexpense_taxable: Optional[FieldEVariableexpenseTaxable] = Field(None, alias="eVariableexpenseTaxable") - b_variableexpense_isactive: Optional[StrictBool] = Field(None, alias="bVariableexpenseIsactive", description="Whether the variableexpense is active or not") - __properties = ["pkiVariableexpenseID", "sVariableexpenseCode", "objVariableexpenseDescription", "eVariableexpenseTaxable", "bVariableexpenseIsactive"] - - @validator('s_variableexpense_code') + A Variableexpense Object + """ # noqa: E501 + pki_variableexpense_id: Annotated[int, Field(le=255, strict=True, ge=1)] = Field(description="The unique ID of the Variableexpense", alias="pkiVariableexpenseID") + s_variableexpense_code: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="The code of the Variableexpense", alias="sVariableexpenseCode") + obj_variableexpense_description: MultilingualVariableexpenseDescription = Field(alias="objVariableexpenseDescription") + e_variableexpense_taxable: Optional[FieldEVariableexpenseTaxable] = Field(default=None, alias="eVariableexpenseTaxable") + b_variableexpense_isactive: Optional[StrictBool] = Field(default=None, description="Whether the variableexpense is active or not", alias="bVariableexpenseIsactive") + __properties: ClassVar[List[str]] = ["pkiVariableexpenseID", "sVariableexpenseCode", "objVariableexpenseDescription", "eVariableexpenseTaxable", "bVariableexpenseIsactive"] + + @field_validator('s_variableexpense_code') def s_variableexpense_code_validate_regular_expression(cls, value): """Validates the regular expression""" if value is None: @@ -45,50 +51,63 @@ def s_variableexpense_code_validate_regular_expression(cls, value): raise ValueError(r"must validate the regular expression /^.{0,5}$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> VariableexpenseResponseCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of VariableexpenseResponseCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_variableexpense_description if self.obj_variableexpense_description: _dict['objVariableexpenseDescription'] = self.obj_variableexpense_description.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> VariableexpenseResponseCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of VariableexpenseResponseCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return VariableexpenseResponseCompound.parse_obj(obj) - - _obj = VariableexpenseResponseCompound.parse_obj({ - "pki_variableexpense_id": obj.get("pkiVariableexpenseID"), - "s_variableexpense_code": obj.get("sVariableexpenseCode"), - "obj_variableexpense_description": MultilingualVariableexpenseDescription.from_dict(obj.get("objVariableexpenseDescription")) if obj.get("objVariableexpenseDescription") is not None else None, - "e_variableexpense_taxable": obj.get("eVariableexpenseTaxable"), - "b_variableexpense_isactive": obj.get("bVariableexpenseIsactive") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiVariableexpenseID": obj.get("pkiVariableexpenseID"), + "sVariableexpenseCode": obj.get("sVariableexpenseCode"), + "objVariableexpenseDescription": MultilingualVariableexpenseDescription.from_dict(obj.get("objVariableexpenseDescription")) if obj.get("objVariableexpenseDescription") is not None else None, + "eVariableexpenseTaxable": obj.get("eVariableexpenseTaxable"), + "bVariableexpenseIsactive": obj.get("bVariableexpenseIsactive") }) return _obj diff --git a/eZmaxApi/models/versionhistory_get_object_v2_response.py b/eZmaxApi/models/versionhistory_get_object_v2_response.py index 0b4824d23..eaab42d64 100644 --- a/eZmaxApi/models/versionhistory_get_object_v2_response.py +++ b/eZmaxApi/models/versionhistory_get_object_v2_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.versionhistory_get_object_v2_response_m_payload import VersionhistoryGetObjectV2ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class VersionhistoryGetObjectV2Response(BaseModel): """ - Response for GET /2/object/versionhistory/{pkiVersionhistoryID} # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: VersionhistoryGetObjectV2ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /2/object/versionhistory/{pkiVersionhistoryID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: VersionhistoryGetObjectV2ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> VersionhistoryGetObjectV2Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of VersionhistoryGetObjectV2Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> VersionhistoryGetObjectV2Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of VersionhistoryGetObjectV2Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return VersionhistoryGetObjectV2Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = VersionhistoryGetObjectV2Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": VersionhistoryGetObjectV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": VersionhistoryGetObjectV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/versionhistory_get_object_v2_response_m_payload.py b/eZmaxApi/models/versionhistory_get_object_v2_response_m_payload.py index dc106b38e..fdebb1456 100644 --- a/eZmaxApi/models/versionhistory_get_object_v2_response_m_payload.py +++ b/eZmaxApi/models/versionhistory_get_object_v2_response_m_payload.py @@ -19,57 +19,75 @@ import json - -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.versionhistory_response_compound import VersionhistoryResponseCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class VersionhistoryGetObjectV2ResponseMPayload(BaseModel): """ - Payload for GET /2/object/versionhistory/{pkiVersionhistoryID} # noqa: E501 - """ - obj_versionhistory: VersionhistoryResponseCompound = Field(..., alias="objVersionhistory") - __properties = ["objVersionhistory"] + Payload for GET /2/object/versionhistory/{pkiVersionhistoryID} + """ # noqa: E501 + obj_versionhistory: VersionhistoryResponseCompound = Field(alias="objVersionhistory") + __properties: ClassVar[List[str]] = ["objVersionhistory"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> VersionhistoryGetObjectV2ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of VersionhistoryGetObjectV2ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_versionhistory if self.obj_versionhistory: _dict['objVersionhistory'] = self.obj_versionhistory.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> VersionhistoryGetObjectV2ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of VersionhistoryGetObjectV2ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return VersionhistoryGetObjectV2ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = VersionhistoryGetObjectV2ResponseMPayload.parse_obj({ - "obj_versionhistory": VersionhistoryResponseCompound.from_dict(obj.get("objVersionhistory")) if obj.get("objVersionhistory") is not None else None + _obj = cls.model_validate({ + "objVersionhistory": VersionhistoryResponseCompound.from_dict(obj.get("objVersionhistory")) if obj.get("objVersionhistory") is not None else None }) return _obj diff --git a/eZmaxApi/models/versionhistory_response.py b/eZmaxApi/models/versionhistory_response.py index c8285dc8a..4a3aefaeb 100644 --- a/eZmaxApi/models/versionhistory_response.py +++ b/eZmaxApi/models/versionhistory_response.py @@ -19,79 +19,98 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, StrictStr +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.field_e_versionhistory_type import FieldEVersionhistoryType from eZmaxApi.models.field_e_versionhistory_usertype import FieldEVersionhistoryUsertype from eZmaxApi.models.multilingual_versionhistory_detail import MultilingualVersionhistoryDetail +try: + from typing import Self +except ImportError: + from typing_extensions import Self class VersionhistoryResponse(BaseModel): """ - A Versionhistory Object # noqa: E501 - """ - pki_versionhistory_id: conint(strict=True, ge=0) = Field(..., alias="pkiVersionhistoryID", description="The unique ID of the Versionhistory") - fki_module_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiModuleID", description="The unique ID of the Module") - fki_modulesection_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiModulesectionID", description="The unique ID of the Modulesection") - s_module_name_x: Optional[StrictStr] = Field(None, alias="sModuleNameX", description="The Name of the Module in the language of the requester") - s_modulesection_name_x: Optional[StrictStr] = Field(None, alias="sModulesectionNameX", description="The Name of the Modulesection in the language of the requester") - e_versionhistory_usertype: Optional[FieldEVersionhistoryUsertype] = Field(None, alias="eVersionhistoryUsertype") - obj_versionhistory_detail: MultilingualVersionhistoryDetail = Field(..., alias="objVersionhistoryDetail") - dt_versionhistory_date: StrictStr = Field(..., alias="dtVersionhistoryDate", description="The date at which the Versionhistory was published or should be published") - dt_versionhistory_dateend: Optional[StrictStr] = Field(None, alias="dtVersionhistoryDateend", description="The date at which the Versionhistory will no longer be visible") - e_versionhistory_type: FieldEVersionhistoryType = Field(..., alias="eVersionhistoryType") - b_versionhistory_draft: StrictBool = Field(..., alias="bVersionhistoryDraft", description="Whether the Versionhistory is published or still a draft") - __properties = ["pkiVersionhistoryID", "fkiModuleID", "fkiModulesectionID", "sModuleNameX", "sModulesectionNameX", "eVersionhistoryUsertype", "objVersionhistoryDetail", "dtVersionhistoryDate", "dtVersionhistoryDateend", "eVersionhistoryType", "bVersionhistoryDraft"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + A Versionhistory Object + """ # noqa: E501 + pki_versionhistory_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Versionhistory", alias="pkiVersionhistoryID") + fki_module_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Module", alias="fkiModuleID") + fki_modulesection_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Modulesection", alias="fkiModulesectionID") + s_module_name_x: Optional[StrictStr] = Field(default=None, description="The Name of the Module in the language of the requester", alias="sModuleNameX") + s_modulesection_name_x: Optional[StrictStr] = Field(default=None, description="The Name of the Modulesection in the language of the requester", alias="sModulesectionNameX") + e_versionhistory_usertype: Optional[FieldEVersionhistoryUsertype] = Field(default=None, alias="eVersionhistoryUsertype") + obj_versionhistory_detail: MultilingualVersionhistoryDetail = Field(alias="objVersionhistoryDetail") + dt_versionhistory_date: StrictStr = Field(description="The date at which the Versionhistory was published or should be published", alias="dtVersionhistoryDate") + dt_versionhistory_dateend: Optional[StrictStr] = Field(default=None, description="The date at which the Versionhistory will no longer be visible", alias="dtVersionhistoryDateend") + e_versionhistory_type: FieldEVersionhistoryType = Field(alias="eVersionhistoryType") + b_versionhistory_draft: StrictBool = Field(description="Whether the Versionhistory is published or still a draft", alias="bVersionhistoryDraft") + __properties: ClassVar[List[str]] = ["pkiVersionhistoryID", "fkiModuleID", "fkiModulesectionID", "sModuleNameX", "sModulesectionNameX", "eVersionhistoryUsertype", "objVersionhistoryDetail", "dtVersionhistoryDate", "dtVersionhistoryDateend", "eVersionhistoryType", "bVersionhistoryDraft"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> VersionhistoryResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of VersionhistoryResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_versionhistory_detail if self.obj_versionhistory_detail: _dict['objVersionhistoryDetail'] = self.obj_versionhistory_detail.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> VersionhistoryResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of VersionhistoryResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return VersionhistoryResponse.parse_obj(obj) - - _obj = VersionhistoryResponse.parse_obj({ - "pki_versionhistory_id": obj.get("pkiVersionhistoryID"), - "fki_module_id": obj.get("fkiModuleID"), - "fki_modulesection_id": obj.get("fkiModulesectionID"), - "s_module_name_x": obj.get("sModuleNameX"), - "s_modulesection_name_x": obj.get("sModulesectionNameX"), - "e_versionhistory_usertype": obj.get("eVersionhistoryUsertype"), - "obj_versionhistory_detail": MultilingualVersionhistoryDetail.from_dict(obj.get("objVersionhistoryDetail")) if obj.get("objVersionhistoryDetail") is not None else None, - "dt_versionhistory_date": obj.get("dtVersionhistoryDate"), - "dt_versionhistory_dateend": obj.get("dtVersionhistoryDateend"), - "e_versionhistory_type": obj.get("eVersionhistoryType"), - "b_versionhistory_draft": obj.get("bVersionhistoryDraft") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiVersionhistoryID": obj.get("pkiVersionhistoryID"), + "fkiModuleID": obj.get("fkiModuleID"), + "fkiModulesectionID": obj.get("fkiModulesectionID"), + "sModuleNameX": obj.get("sModuleNameX"), + "sModulesectionNameX": obj.get("sModulesectionNameX"), + "eVersionhistoryUsertype": obj.get("eVersionhistoryUsertype"), + "objVersionhistoryDetail": MultilingualVersionhistoryDetail.from_dict(obj.get("objVersionhistoryDetail")) if obj.get("objVersionhistoryDetail") is not None else None, + "dtVersionhistoryDate": obj.get("dtVersionhistoryDate"), + "dtVersionhistoryDateend": obj.get("dtVersionhistoryDateend"), + "eVersionhistoryType": obj.get("eVersionhistoryType"), + "bVersionhistoryDraft": obj.get("bVersionhistoryDraft") }) return _obj diff --git a/eZmaxApi/models/versionhistory_response_compound.py b/eZmaxApi/models/versionhistory_response_compound.py index 6172eac3c..b9aad9ef9 100644 --- a/eZmaxApi/models/versionhistory_response_compound.py +++ b/eZmaxApi/models/versionhistory_response_compound.py @@ -19,79 +19,98 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictBool, StrictStr, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, StrictStr +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.field_e_versionhistory_type import FieldEVersionhistoryType from eZmaxApi.models.field_e_versionhistory_usertype import FieldEVersionhistoryUsertype from eZmaxApi.models.multilingual_versionhistory_detail import MultilingualVersionhistoryDetail +try: + from typing import Self +except ImportError: + from typing_extensions import Self class VersionhistoryResponseCompound(BaseModel): """ - A Versionhistory Object # noqa: E501 - """ - pki_versionhistory_id: conint(strict=True, ge=0) = Field(..., alias="pkiVersionhistoryID", description="The unique ID of the Versionhistory") - fki_module_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiModuleID", description="The unique ID of the Module") - fki_modulesection_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiModulesectionID", description="The unique ID of the Modulesection") - s_module_name_x: Optional[StrictStr] = Field(None, alias="sModuleNameX", description="The Name of the Module in the language of the requester") - s_modulesection_name_x: Optional[StrictStr] = Field(None, alias="sModulesectionNameX", description="The Name of the Modulesection in the language of the requester") - e_versionhistory_usertype: Optional[FieldEVersionhistoryUsertype] = Field(None, alias="eVersionhistoryUsertype") - obj_versionhistory_detail: MultilingualVersionhistoryDetail = Field(..., alias="objVersionhistoryDetail") - dt_versionhistory_date: StrictStr = Field(..., alias="dtVersionhistoryDate", description="The date at which the Versionhistory was published or should be published") - dt_versionhistory_dateend: Optional[StrictStr] = Field(None, alias="dtVersionhistoryDateend", description="The date at which the Versionhistory will no longer be visible") - e_versionhistory_type: FieldEVersionhistoryType = Field(..., alias="eVersionhistoryType") - b_versionhistory_draft: StrictBool = Field(..., alias="bVersionhistoryDraft", description="Whether the Versionhistory is published or still a draft") - __properties = ["pkiVersionhistoryID", "fkiModuleID", "fkiModulesectionID", "sModuleNameX", "sModulesectionNameX", "eVersionhistoryUsertype", "objVersionhistoryDetail", "dtVersionhistoryDate", "dtVersionhistoryDateend", "eVersionhistoryType", "bVersionhistoryDraft"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + A Versionhistory Object + """ # noqa: E501 + pki_versionhistory_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Versionhistory", alias="pkiVersionhistoryID") + fki_module_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Module", alias="fkiModuleID") + fki_modulesection_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Modulesection", alias="fkiModulesectionID") + s_module_name_x: Optional[StrictStr] = Field(default=None, description="The Name of the Module in the language of the requester", alias="sModuleNameX") + s_modulesection_name_x: Optional[StrictStr] = Field(default=None, description="The Name of the Modulesection in the language of the requester", alias="sModulesectionNameX") + e_versionhistory_usertype: Optional[FieldEVersionhistoryUsertype] = Field(default=None, alias="eVersionhistoryUsertype") + obj_versionhistory_detail: MultilingualVersionhistoryDetail = Field(alias="objVersionhistoryDetail") + dt_versionhistory_date: StrictStr = Field(description="The date at which the Versionhistory was published or should be published", alias="dtVersionhistoryDate") + dt_versionhistory_dateend: Optional[StrictStr] = Field(default=None, description="The date at which the Versionhistory will no longer be visible", alias="dtVersionhistoryDateend") + e_versionhistory_type: FieldEVersionhistoryType = Field(alias="eVersionhistoryType") + b_versionhistory_draft: StrictBool = Field(description="Whether the Versionhistory is published or still a draft", alias="bVersionhistoryDraft") + __properties: ClassVar[List[str]] = ["pkiVersionhistoryID", "fkiModuleID", "fkiModulesectionID", "sModuleNameX", "sModulesectionNameX", "eVersionhistoryUsertype", "objVersionhistoryDetail", "dtVersionhistoryDate", "dtVersionhistoryDateend", "eVersionhistoryType", "bVersionhistoryDraft"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> VersionhistoryResponseCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of VersionhistoryResponseCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_versionhistory_detail if self.obj_versionhistory_detail: _dict['objVersionhistoryDetail'] = self.obj_versionhistory_detail.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> VersionhistoryResponseCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of VersionhistoryResponseCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return VersionhistoryResponseCompound.parse_obj(obj) - - _obj = VersionhistoryResponseCompound.parse_obj({ - "pki_versionhistory_id": obj.get("pkiVersionhistoryID"), - "fki_module_id": obj.get("fkiModuleID"), - "fki_modulesection_id": obj.get("fkiModulesectionID"), - "s_module_name_x": obj.get("sModuleNameX"), - "s_modulesection_name_x": obj.get("sModulesectionNameX"), - "e_versionhistory_usertype": obj.get("eVersionhistoryUsertype"), - "obj_versionhistory_detail": MultilingualVersionhistoryDetail.from_dict(obj.get("objVersionhistoryDetail")) if obj.get("objVersionhistoryDetail") is not None else None, - "dt_versionhistory_date": obj.get("dtVersionhistoryDate"), - "dt_versionhistory_dateend": obj.get("dtVersionhistoryDateend"), - "e_versionhistory_type": obj.get("eVersionhistoryType"), - "b_versionhistory_draft": obj.get("bVersionhistoryDraft") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiVersionhistoryID": obj.get("pkiVersionhistoryID"), + "fkiModuleID": obj.get("fkiModuleID"), + "fkiModulesectionID": obj.get("fkiModulesectionID"), + "sModuleNameX": obj.get("sModuleNameX"), + "sModulesectionNameX": obj.get("sModulesectionNameX"), + "eVersionhistoryUsertype": obj.get("eVersionhistoryUsertype"), + "objVersionhistoryDetail": MultilingualVersionhistoryDetail.from_dict(obj.get("objVersionhistoryDetail")) if obj.get("objVersionhistoryDetail") is not None else None, + "dtVersionhistoryDate": obj.get("dtVersionhistoryDate"), + "dtVersionhistoryDateend": obj.get("dtVersionhistoryDateend"), + "eVersionhistoryType": obj.get("eVersionhistoryType"), + "bVersionhistoryDraft": obj.get("bVersionhistoryDraft") }) return _obj diff --git a/eZmaxApi/models/webhook_create_object_v1_request.py b/eZmaxApi/models/webhook_create_object_v1_request.py index ed4bd6c5f..648f30278 100644 --- a/eZmaxApi/models/webhook_create_object_v1_request.py +++ b/eZmaxApi/models/webhook_create_object_v1_request.py @@ -19,41 +19,60 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.webhook_request_compound import WebhookRequestCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class WebhookCreateObjectV1Request(BaseModel): """ - Request for POST /1/object/webhook # noqa: E501 - """ - a_obj_webhook: conlist(WebhookRequestCompound, min_items=1) = Field(..., alias="a_objWebhook") - __properties = ["a_objWebhook"] + Request for POST /1/object/webhook + """ # noqa: E501 + a_obj_webhook: Annotated[List[WebhookRequestCompound], Field(min_length=1)] = Field(alias="a_objWebhook") + __properties: ClassVar[List[str]] = ["a_objWebhook"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> WebhookCreateObjectV1Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of WebhookCreateObjectV1Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_webhook (list) _items = [] if self.a_obj_webhook: @@ -64,16 +83,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> WebhookCreateObjectV1Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of WebhookCreateObjectV1Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return WebhookCreateObjectV1Request.parse_obj(obj) + return cls.model_validate(obj) - _obj = WebhookCreateObjectV1Request.parse_obj({ - "a_obj_webhook": [WebhookRequestCompound.from_dict(_item) for _item in obj.get("a_objWebhook")] if obj.get("a_objWebhook") is not None else None + _obj = cls.model_validate({ + "a_objWebhook": [WebhookRequestCompound.from_dict(_item) for _item in obj.get("a_objWebhook")] if obj.get("a_objWebhook") is not None else None }) return _obj diff --git a/eZmaxApi/models/webhook_create_object_v1_response.py b/eZmaxApi/models/webhook_create_object_v1_response.py index c0c719316..0dd92851f 100644 --- a/eZmaxApi/models/webhook_create_object_v1_response.py +++ b/eZmaxApi/models/webhook_create_object_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.webhook_create_object_v1_response_m_payload import WebhookCreateObjectV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class WebhookCreateObjectV1Response(BaseModel): """ - Response for POST /1/object/webhook # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: WebhookCreateObjectV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for POST /1/object/webhook + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: WebhookCreateObjectV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> WebhookCreateObjectV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of WebhookCreateObjectV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> WebhookCreateObjectV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of WebhookCreateObjectV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return WebhookCreateObjectV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = WebhookCreateObjectV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": WebhookCreateObjectV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": WebhookCreateObjectV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/webhook_create_object_v1_response_m_payload.py b/eZmaxApi/models/webhook_create_object_v1_response_m_payload.py index cbe8b5958..dc45251bd 100644 --- a/eZmaxApi/models/webhook_create_object_v1_response_m_payload.py +++ b/eZmaxApi/models/webhook_create_object_v1_response_m_payload.py @@ -19,53 +19,72 @@ import json -from typing import List -from pydantic import BaseModel, Field, StrictInt, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictInt +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class WebhookCreateObjectV1ResponseMPayload(BaseModel): """ - Payload for POST /1/object/webhook # noqa: E501 - """ - a_pki_webhook_id: conlist(StrictInt, min_items=1) = Field(..., alias="a_pkiWebhookID", description="An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request.") - __properties = ["a_pkiWebhookID"] + Payload for POST /1/object/webhook + """ # noqa: E501 + a_pki_webhook_id: Annotated[List[StrictInt], Field(min_length=1)] = Field(description="An array of unique IDs representing the object that were requested to be created. They are returned in the same order as the array containing the objects to be created that was sent in the request.", alias="a_pkiWebhookID") + __properties: ClassVar[List[str]] = ["a_pkiWebhookID"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> WebhookCreateObjectV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of WebhookCreateObjectV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> WebhookCreateObjectV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of WebhookCreateObjectV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return WebhookCreateObjectV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = WebhookCreateObjectV1ResponseMPayload.parse_obj({ - "a_pki_webhook_id": obj.get("a_pkiWebhookID") + _obj = cls.model_validate({ + "a_pkiWebhookID": obj.get("a_pkiWebhookID") }) return _obj diff --git a/eZmaxApi/models/webhook_create_object_v2_request.py b/eZmaxApi/models/webhook_create_object_v2_request.py new file mode 100644 index 000000000..feae1caf2 --- /dev/null +++ b/eZmaxApi/models/webhook_create_object_v2_request.py @@ -0,0 +1,99 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +from eZmaxApi.models.webhook_request_compound import WebhookRequestCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self + +class WebhookCreateObjectV2Request(BaseModel): + """ + Request for POST /2/object/webhook + """ # noqa: E501 + a_obj_webhook: Annotated[List[WebhookRequestCompound], Field(min_length=1)] = Field(alias="a_objWebhook") + __properties: ClassVar[List[str]] = ["a_objWebhook"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of WebhookCreateObjectV2Request from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in a_obj_webhook (list) + _items = [] + if self.a_obj_webhook: + for _item in self.a_obj_webhook: + if _item: + _items.append(_item.to_dict()) + _dict['a_objWebhook'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Dict) -> Self: + """Create an instance of WebhookCreateObjectV2Request from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "a_objWebhook": [WebhookRequestCompound.from_dict(_item) for _item in obj.get("a_objWebhook")] if obj.get("a_objWebhook") is not None else None + }) + return _obj + + diff --git a/eZmaxApi/models/webhook_create_object_v2_response.py b/eZmaxApi/models/webhook_create_object_v2_response.py new file mode 100644 index 000000000..48560795a --- /dev/null +++ b/eZmaxApi/models/webhook_create_object_v2_response.py @@ -0,0 +1,106 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field +from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug +from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +from eZmaxApi.models.webhook_create_object_v2_response_m_payload import WebhookCreateObjectV2ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self + +class WebhookCreateObjectV2Response(BaseModel): + """ + Response for POST /2/object/webhook + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: WebhookCreateObjectV2ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of WebhookCreateObjectV2Response from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of obj_debug_payload + if self.obj_debug_payload: + _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() + # override the default output from pydantic by calling `to_dict()` of obj_debug + if self.obj_debug: + _dict['objDebug'] = self.obj_debug.to_dict() + # override the default output from pydantic by calling `to_dict()` of m_payload + if self.m_payload: + _dict['mPayload'] = self.m_payload.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Dict) -> Self: + """Create an instance of WebhookCreateObjectV2Response from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": WebhookCreateObjectV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + }) + return _obj + + diff --git a/eZmaxApi/models/webhook_create_object_v2_response_m_payload.py b/eZmaxApi/models/webhook_create_object_v2_response_m_payload.py new file mode 100644 index 000000000..80060ee66 --- /dev/null +++ b/eZmaxApi/models/webhook_create_object_v2_response_m_payload.py @@ -0,0 +1,99 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated +from eZmaxApi.models.webhook_response_compound import WebhookResponseCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self + +class WebhookCreateObjectV2ResponseMPayload(BaseModel): + """ + Payload for POST /2/object/webhook + """ # noqa: E501 + a_obj_webhook: Annotated[List[WebhookResponseCompound], Field(min_length=1)] = Field(alias="a_objWebhook") + __properties: ClassVar[List[str]] = ["a_objWebhook"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of WebhookCreateObjectV2ResponseMPayload from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in a_obj_webhook (list) + _items = [] + if self.a_obj_webhook: + for _item in self.a_obj_webhook: + if _item: + _items.append(_item.to_dict()) + _dict['a_objWebhook'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Dict) -> Self: + """Create an instance of WebhookCreateObjectV2ResponseMPayload from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "a_objWebhook": [WebhookResponseCompound.from_dict(_item) for _item in obj.get("a_objWebhook")] if obj.get("a_objWebhook") is not None else None + }) + return _obj + + diff --git a/eZmaxApi/models/webhook_delete_object_v1_response.py b/eZmaxApi/models/webhook_delete_object_v1_response.py index 9b9326ab6..956167660 100644 --- a/eZmaxApi/models/webhook_delete_object_v1_response.py +++ b/eZmaxApi/models/webhook_delete_object_v1_response.py @@ -19,43 +19,61 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class WebhookDeleteObjectV1Response(BaseModel): """ - Response for DELETE /1/object/webhook/{pkiWebhookID} # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - __properties = ["objDebugPayload", "objDebug"] + Response for DELETE /1/object/webhook/{pkiWebhookID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> WebhookDeleteObjectV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of WebhookDeleteObjectV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -65,17 +83,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> WebhookDeleteObjectV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of WebhookDeleteObjectV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return WebhookDeleteObjectV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = WebhookDeleteObjectV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None }) return _obj diff --git a/eZmaxApi/models/webhook_edit_object_v1_request.py b/eZmaxApi/models/webhook_edit_object_v1_request.py index bc2faf730..28626e5ef 100644 --- a/eZmaxApi/models/webhook_edit_object_v1_request.py +++ b/eZmaxApi/models/webhook_edit_object_v1_request.py @@ -19,57 +19,75 @@ import json - -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.webhook_request_compound import WebhookRequestCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class WebhookEditObjectV1Request(BaseModel): """ - Request for PUT /1/object/webhook/{pkiWebhookID} # noqa: E501 - """ - obj_webhook: WebhookRequestCompound = Field(..., alias="objWebhook") - __properties = ["objWebhook"] + Request for PUT /1/object/webhook/{pkiWebhookID} + """ # noqa: E501 + obj_webhook: WebhookRequestCompound = Field(alias="objWebhook") + __properties: ClassVar[List[str]] = ["objWebhook"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> WebhookEditObjectV1Request: + def from_json(cls, json_str: str) -> Self: """Create an instance of WebhookEditObjectV1Request from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_webhook if self.obj_webhook: _dict['objWebhook'] = self.obj_webhook.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> WebhookEditObjectV1Request: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of WebhookEditObjectV1Request from a dict""" if obj is None: return None if not isinstance(obj, dict): - return WebhookEditObjectV1Request.parse_obj(obj) + return cls.model_validate(obj) - _obj = WebhookEditObjectV1Request.parse_obj({ - "obj_webhook": WebhookRequestCompound.from_dict(obj.get("objWebhook")) if obj.get("objWebhook") is not None else None + _obj = cls.model_validate({ + "objWebhook": WebhookRequestCompound.from_dict(obj.get("objWebhook")) if obj.get("objWebhook") is not None else None }) return _obj diff --git a/eZmaxApi/models/webhook_edit_object_v1_response.py b/eZmaxApi/models/webhook_edit_object_v1_response.py index 4e27c8411..59589f539 100644 --- a/eZmaxApi/models/webhook_edit_object_v1_response.py +++ b/eZmaxApi/models/webhook_edit_object_v1_response.py @@ -19,43 +19,61 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class WebhookEditObjectV1Response(BaseModel): """ - Response for PUT /1/object/webhook/{pkiWebhookID} # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - __properties = ["objDebugPayload", "objDebug"] + Response for PUT /1/object/webhook/{pkiWebhookID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> WebhookEditObjectV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of WebhookEditObjectV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -65,17 +83,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> WebhookEditObjectV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of WebhookEditObjectV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return WebhookEditObjectV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = WebhookEditObjectV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None }) return _obj diff --git a/eZmaxApi/models/webhook_ezsign_document_completed.py b/eZmaxApi/models/webhook_ezsign_document_completed.py index 2c0222ee4..d5203ef02 100644 --- a/eZmaxApi/models/webhook_ezsign_document_completed.py +++ b/eZmaxApi/models/webhook_ezsign_document_completed.py @@ -19,45 +19,63 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.attempt_response_compound import AttemptResponseCompound from eZmaxApi.models.custom_webhook_response import CustomWebhookResponse from eZmaxApi.models.ezsigndocument_response import EzsigndocumentResponse +try: + from typing import Self +except ImportError: + from typing_extensions import Self class WebhookEzsignDocumentCompleted(BaseModel): """ - This is the base Webhook object # noqa: E501 - """ - obj_webhook: CustomWebhookResponse = Field(..., alias="objWebhook") - a_obj_attempt: conlist(AttemptResponseCompound) = Field(..., alias="a_objAttempt", description="An array containing details of previous attempts that were made to deliver the message. The array is empty if it's the first attempt.") - obj_ezsigndocument: EzsigndocumentResponse = Field(..., alias="objEzsigndocument") - __properties = ["objWebhook", "a_objAttempt", "objEzsigndocument"] + This is the base Webhook object + """ # noqa: E501 + obj_webhook: CustomWebhookResponse = Field(alias="objWebhook") + a_obj_attempt: List[AttemptResponseCompound] = Field(description="An array containing details of previous attempts that were made to deliver the message. The array is empty if it's the first attempt.", alias="a_objAttempt") + obj_ezsigndocument: EzsigndocumentResponse = Field(alias="objEzsigndocument") + __properties: ClassVar[List[str]] = ["objWebhook", "a_objAttempt", "objEzsigndocument"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> WebhookEzsignDocumentCompleted: + def from_json(cls, json_str: str) -> Self: """Create an instance of WebhookEzsignDocumentCompleted from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_webhook if self.obj_webhook: _dict['objWebhook'] = self.obj_webhook.to_dict() @@ -74,18 +92,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> WebhookEzsignDocumentCompleted: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of WebhookEzsignDocumentCompleted from a dict""" if obj is None: return None if not isinstance(obj, dict): - return WebhookEzsignDocumentCompleted.parse_obj(obj) + return cls.model_validate(obj) - _obj = WebhookEzsignDocumentCompleted.parse_obj({ - "obj_webhook": CustomWebhookResponse.from_dict(obj.get("objWebhook")) if obj.get("objWebhook") is not None else None, - "a_obj_attempt": [AttemptResponseCompound.from_dict(_item) for _item in obj.get("a_objAttempt")] if obj.get("a_objAttempt") is not None else None, - "obj_ezsigndocument": EzsigndocumentResponse.from_dict(obj.get("objEzsigndocument")) if obj.get("objEzsigndocument") is not None else None + _obj = cls.model_validate({ + "objWebhook": CustomWebhookResponse.from_dict(obj.get("objWebhook")) if obj.get("objWebhook") is not None else None, + "a_objAttempt": [AttemptResponseCompound.from_dict(_item) for _item in obj.get("a_objAttempt")] if obj.get("a_objAttempt") is not None else None, + "objEzsigndocument": EzsigndocumentResponse.from_dict(obj.get("objEzsigndocument")) if obj.get("objEzsigndocument") is not None else None }) return _obj diff --git a/eZmaxApi/models/webhook_ezsign_ezsignsigner_acceptclause.py b/eZmaxApi/models/webhook_ezsign_ezsignsigner_acceptclause.py index bb404a9c7..2e42fa631 100644 --- a/eZmaxApi/models/webhook_ezsign_ezsignsigner_acceptclause.py +++ b/eZmaxApi/models/webhook_ezsign_ezsignsigner_acceptclause.py @@ -19,47 +19,65 @@ import json -from typing import List, Optional -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.attempt_response_compound import AttemptResponseCompound from eZmaxApi.models.custom_webhook_response import CustomWebhookResponse from eZmaxApi.models.ezsignfolder_response import EzsignfolderResponse from eZmaxApi.models.ezsignfoldersignerassociation_response_compound import EzsignfoldersignerassociationResponseCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class WebhookEzsignEzsignsignerAcceptclause(BaseModel): """ - This is the base Webhook object # noqa: E501 - """ - obj_webhook: CustomWebhookResponse = Field(..., alias="objWebhook") - a_obj_attempt: conlist(AttemptResponseCompound) = Field(..., alias="a_objAttempt", description="An array containing details of previous attempts that were made to deliver the message. The array is empty if it's the first attempt.") - obj_ezsignfolder: Optional[EzsignfolderResponse] = Field(None, alias="objEzsignfolder") - obj_ezsignfoldersignerassociation: EzsignfoldersignerassociationResponseCompound = Field(..., alias="objEzsignfoldersignerassociation") - __properties = ["objWebhook", "a_objAttempt", "objEzsignfolder", "objEzsignfoldersignerassociation"] + This is the base Webhook object + """ # noqa: E501 + obj_webhook: CustomWebhookResponse = Field(alias="objWebhook") + a_obj_attempt: List[AttemptResponseCompound] = Field(description="An array containing details of previous attempts that were made to deliver the message. The array is empty if it's the first attempt.", alias="a_objAttempt") + obj_ezsignfolder: Optional[EzsignfolderResponse] = Field(default=None, alias="objEzsignfolder") + obj_ezsignfoldersignerassociation: EzsignfoldersignerassociationResponseCompound = Field(alias="objEzsignfoldersignerassociation") + __properties: ClassVar[List[str]] = ["objWebhook", "a_objAttempt", "objEzsignfolder", "objEzsignfoldersignerassociation"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> WebhookEzsignEzsignsignerAcceptclause: + def from_json(cls, json_str: str) -> Self: """Create an instance of WebhookEzsignEzsignsignerAcceptclause from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_webhook if self.obj_webhook: _dict['objWebhook'] = self.obj_webhook.to_dict() @@ -79,19 +97,19 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> WebhookEzsignEzsignsignerAcceptclause: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of WebhookEzsignEzsignsignerAcceptclause from a dict""" if obj is None: return None if not isinstance(obj, dict): - return WebhookEzsignEzsignsignerAcceptclause.parse_obj(obj) + return cls.model_validate(obj) - _obj = WebhookEzsignEzsignsignerAcceptclause.parse_obj({ - "obj_webhook": CustomWebhookResponse.from_dict(obj.get("objWebhook")) if obj.get("objWebhook") is not None else None, - "a_obj_attempt": [AttemptResponseCompound.from_dict(_item) for _item in obj.get("a_objAttempt")] if obj.get("a_objAttempt") is not None else None, - "obj_ezsignfolder": EzsignfolderResponse.from_dict(obj.get("objEzsignfolder")) if obj.get("objEzsignfolder") is not None else None, - "obj_ezsignfoldersignerassociation": EzsignfoldersignerassociationResponseCompound.from_dict(obj.get("objEzsignfoldersignerassociation")) if obj.get("objEzsignfoldersignerassociation") is not None else None + _obj = cls.model_validate({ + "objWebhook": CustomWebhookResponse.from_dict(obj.get("objWebhook")) if obj.get("objWebhook") is not None else None, + "a_objAttempt": [AttemptResponseCompound.from_dict(_item) for _item in obj.get("a_objAttempt")] if obj.get("a_objAttempt") is not None else None, + "objEzsignfolder": EzsignfolderResponse.from_dict(obj.get("objEzsignfolder")) if obj.get("objEzsignfolder") is not None else None, + "objEzsignfoldersignerassociation": EzsignfoldersignerassociationResponseCompound.from_dict(obj.get("objEzsignfoldersignerassociation")) if obj.get("objEzsignfoldersignerassociation") is not None else None }) return _obj diff --git a/eZmaxApi/models/webhook_ezsign_ezsignsigner_connect.py b/eZmaxApi/models/webhook_ezsign_ezsignsigner_connect.py index fbeda3773..7445415bf 100644 --- a/eZmaxApi/models/webhook_ezsign_ezsignsigner_connect.py +++ b/eZmaxApi/models/webhook_ezsign_ezsignsigner_connect.py @@ -19,47 +19,65 @@ import json -from typing import List, Optional -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.attempt_response_compound import AttemptResponseCompound from eZmaxApi.models.custom_webhook_response import CustomWebhookResponse from eZmaxApi.models.ezsignfolder_response import EzsignfolderResponse from eZmaxApi.models.ezsignfoldersignerassociation_response_compound import EzsignfoldersignerassociationResponseCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class WebhookEzsignEzsignsignerConnect(BaseModel): """ - This is the base Webhook object # noqa: E501 - """ - obj_webhook: CustomWebhookResponse = Field(..., alias="objWebhook") - a_obj_attempt: conlist(AttemptResponseCompound) = Field(..., alias="a_objAttempt", description="An array containing details of previous attempts that were made to deliver the message. The array is empty if it's the first attempt.") - obj_ezsignfolder: Optional[EzsignfolderResponse] = Field(None, alias="objEzsignfolder") - obj_ezsignfoldersignerassociation: EzsignfoldersignerassociationResponseCompound = Field(..., alias="objEzsignfoldersignerassociation") - __properties = ["objWebhook", "a_objAttempt", "objEzsignfolder", "objEzsignfoldersignerassociation"] + This is the base Webhook object + """ # noqa: E501 + obj_webhook: CustomWebhookResponse = Field(alias="objWebhook") + a_obj_attempt: List[AttemptResponseCompound] = Field(description="An array containing details of previous attempts that were made to deliver the message. The array is empty if it's the first attempt.", alias="a_objAttempt") + obj_ezsignfolder: Optional[EzsignfolderResponse] = Field(default=None, alias="objEzsignfolder") + obj_ezsignfoldersignerassociation: EzsignfoldersignerassociationResponseCompound = Field(alias="objEzsignfoldersignerassociation") + __properties: ClassVar[List[str]] = ["objWebhook", "a_objAttempt", "objEzsignfolder", "objEzsignfoldersignerassociation"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> WebhookEzsignEzsignsignerConnect: + def from_json(cls, json_str: str) -> Self: """Create an instance of WebhookEzsignEzsignsignerConnect from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_webhook if self.obj_webhook: _dict['objWebhook'] = self.obj_webhook.to_dict() @@ -79,19 +97,19 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> WebhookEzsignEzsignsignerConnect: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of WebhookEzsignEzsignsignerConnect from a dict""" if obj is None: return None if not isinstance(obj, dict): - return WebhookEzsignEzsignsignerConnect.parse_obj(obj) + return cls.model_validate(obj) - _obj = WebhookEzsignEzsignsignerConnect.parse_obj({ - "obj_webhook": CustomWebhookResponse.from_dict(obj.get("objWebhook")) if obj.get("objWebhook") is not None else None, - "a_obj_attempt": [AttemptResponseCompound.from_dict(_item) for _item in obj.get("a_objAttempt")] if obj.get("a_objAttempt") is not None else None, - "obj_ezsignfolder": EzsignfolderResponse.from_dict(obj.get("objEzsignfolder")) if obj.get("objEzsignfolder") is not None else None, - "obj_ezsignfoldersignerassociation": EzsignfoldersignerassociationResponseCompound.from_dict(obj.get("objEzsignfoldersignerassociation")) if obj.get("objEzsignfoldersignerassociation") is not None else None + _obj = cls.model_validate({ + "objWebhook": CustomWebhookResponse.from_dict(obj.get("objWebhook")) if obj.get("objWebhook") is not None else None, + "a_objAttempt": [AttemptResponseCompound.from_dict(_item) for _item in obj.get("a_objAttempt")] if obj.get("a_objAttempt") is not None else None, + "objEzsignfolder": EzsignfolderResponse.from_dict(obj.get("objEzsignfolder")) if obj.get("objEzsignfolder") is not None else None, + "objEzsignfoldersignerassociation": EzsignfoldersignerassociationResponseCompound.from_dict(obj.get("objEzsignfoldersignerassociation")) if obj.get("objEzsignfoldersignerassociation") is not None else None }) return _obj diff --git a/eZmaxApi/models/webhook_ezsign_folder_completed.py b/eZmaxApi/models/webhook_ezsign_folder_completed.py index cecda2430..5830ae11e 100644 --- a/eZmaxApi/models/webhook_ezsign_folder_completed.py +++ b/eZmaxApi/models/webhook_ezsign_folder_completed.py @@ -19,45 +19,63 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.attempt_response_compound import AttemptResponseCompound from eZmaxApi.models.custom_webhook_response import CustomWebhookResponse from eZmaxApi.models.ezsignfolder_response import EzsignfolderResponse +try: + from typing import Self +except ImportError: + from typing_extensions import Self class WebhookEzsignFolderCompleted(BaseModel): """ - This is the base Webhook object # noqa: E501 - """ - obj_webhook: CustomWebhookResponse = Field(..., alias="objWebhook") - a_obj_attempt: conlist(AttemptResponseCompound) = Field(..., alias="a_objAttempt", description="An array containing details of previous attempts that were made to deliver the message. The array is empty if it's the first attempt.") - obj_ezsignfolder: EzsignfolderResponse = Field(..., alias="objEzsignfolder") - __properties = ["objWebhook", "a_objAttempt", "objEzsignfolder"] + This is the base Webhook object + """ # noqa: E501 + obj_webhook: CustomWebhookResponse = Field(alias="objWebhook") + a_obj_attempt: List[AttemptResponseCompound] = Field(description="An array containing details of previous attempts that were made to deliver the message. The array is empty if it's the first attempt.", alias="a_objAttempt") + obj_ezsignfolder: EzsignfolderResponse = Field(alias="objEzsignfolder") + __properties: ClassVar[List[str]] = ["objWebhook", "a_objAttempt", "objEzsignfolder"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> WebhookEzsignFolderCompleted: + def from_json(cls, json_str: str) -> Self: """Create an instance of WebhookEzsignFolderCompleted from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_webhook if self.obj_webhook: _dict['objWebhook'] = self.obj_webhook.to_dict() @@ -74,18 +92,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> WebhookEzsignFolderCompleted: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of WebhookEzsignFolderCompleted from a dict""" if obj is None: return None if not isinstance(obj, dict): - return WebhookEzsignFolderCompleted.parse_obj(obj) + return cls.model_validate(obj) - _obj = WebhookEzsignFolderCompleted.parse_obj({ - "obj_webhook": CustomWebhookResponse.from_dict(obj.get("objWebhook")) if obj.get("objWebhook") is not None else None, - "a_obj_attempt": [AttemptResponseCompound.from_dict(_item) for _item in obj.get("a_objAttempt")] if obj.get("a_objAttempt") is not None else None, - "obj_ezsignfolder": EzsignfolderResponse.from_dict(obj.get("objEzsignfolder")) if obj.get("objEzsignfolder") is not None else None + _obj = cls.model_validate({ + "objWebhook": CustomWebhookResponse.from_dict(obj.get("objWebhook")) if obj.get("objWebhook") is not None else None, + "a_objAttempt": [AttemptResponseCompound.from_dict(_item) for _item in obj.get("a_objAttempt")] if obj.get("a_objAttempt") is not None else None, + "objEzsignfolder": EzsignfolderResponse.from_dict(obj.get("objEzsignfolder")) if obj.get("objEzsignfolder") is not None else None }) return _obj diff --git a/eZmaxApi/models/webhook_get_history_v1_response.py b/eZmaxApi/models/webhook_get_history_v1_response.py index 3b3ddf31e..bf8d6542e 100644 --- a/eZmaxApi/models/webhook_get_history_v1_response.py +++ b/eZmaxApi/models/webhook_get_history_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.webhook_get_history_v1_response_m_payload import WebhookGetHistoryV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class WebhookGetHistoryV1Response(BaseModel): """ - Response for GET /1/object/webhook/{pkiWebhookID}/getHistory # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: WebhookGetHistoryV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /1/object/webhook/{pkiWebhookID}/getHistory + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: WebhookGetHistoryV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> WebhookGetHistoryV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of WebhookGetHistoryV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> WebhookGetHistoryV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of WebhookGetHistoryV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return WebhookGetHistoryV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = WebhookGetHistoryV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": WebhookGetHistoryV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": WebhookGetHistoryV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/webhook_get_history_v1_response_m_payload.py b/eZmaxApi/models/webhook_get_history_v1_response_m_payload.py index 80bb10450..a489ecc29 100644 --- a/eZmaxApi/models/webhook_get_history_v1_response_m_payload.py +++ b/eZmaxApi/models/webhook_get_history_v1_response_m_payload.py @@ -19,41 +19,59 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.custom_webhooklog_response import CustomWebhooklogResponse +try: + from typing import Self +except ImportError: + from typing_extensions import Self class WebhookGetHistoryV1ResponseMPayload(BaseModel): """ - Payload for GET /1/object/webhook/{pkiWebhookID}/getHistory # noqa: E501 - """ - a_obj_webhooklog: conlist(CustomWebhooklogResponse) = Field(..., alias="a_objWebhooklog") - __properties = ["a_objWebhooklog"] + Payload for GET /1/object/webhook/{pkiWebhookID}/getHistory + """ # noqa: E501 + a_obj_webhooklog: List[CustomWebhooklogResponse] = Field(alias="a_objWebhooklog") + __properties: ClassVar[List[str]] = ["a_objWebhooklog"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> WebhookGetHistoryV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of WebhookGetHistoryV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_webhooklog (list) _items = [] if self.a_obj_webhooklog: @@ -64,16 +82,16 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> WebhookGetHistoryV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of WebhookGetHistoryV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return WebhookGetHistoryV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = WebhookGetHistoryV1ResponseMPayload.parse_obj({ - "a_obj_webhooklog": [CustomWebhooklogResponse.from_dict(_item) for _item in obj.get("a_objWebhooklog")] if obj.get("a_objWebhooklog") is not None else None + _obj = cls.model_validate({ + "a_objWebhooklog": [CustomWebhooklogResponse.from_dict(_item) for _item in obj.get("a_objWebhooklog")] if obj.get("a_objWebhooklog") is not None else None }) return _obj diff --git a/eZmaxApi/models/webhook_get_list_v1_response.py b/eZmaxApi/models/webhook_get_list_v1_response.py index 0a3eaf45c..be0cc490b 100644 --- a/eZmaxApi/models/webhook_get_list_v1_response.py +++ b/eZmaxApi/models/webhook_get_list_v1_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload_get_list import CommonResponseObjDebugPayloadGetList from eZmaxApi.models.webhook_get_list_v1_response_m_payload import WebhookGetListV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class WebhookGetListV1Response(BaseModel): """ - Response for GET /1/object/webhook/getList # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayloadGetList = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: WebhookGetListV1ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /1/object/webhook/getList + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayloadGetList = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: WebhookGetListV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> WebhookGetListV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of WebhookGetListV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> WebhookGetListV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of WebhookGetListV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return WebhookGetListV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = WebhookGetListV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayloadGetList.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": WebhookGetListV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayloadGetList.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": WebhookGetListV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/webhook_get_list_v1_response_m_payload.py b/eZmaxApi/models/webhook_get_list_v1_response_m_payload.py index c4fc1721a..8d54d709f 100644 --- a/eZmaxApi/models/webhook_get_list_v1_response_m_payload.py +++ b/eZmaxApi/models/webhook_get_list_v1_response_m_payload.py @@ -19,43 +19,61 @@ import json -from typing import List -from pydantic import BaseModel, Field, StrictInt, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictInt +from pydantic import Field from eZmaxApi.models.webhook_list_element import WebhookListElement +try: + from typing import Self +except ImportError: + from typing_extensions import Self class WebhookGetListV1ResponseMPayload(BaseModel): """ - Payload for GET /1/object/webhook/getList # noqa: E501 - """ - i_row_returned: StrictInt = Field(..., alias="iRowReturned", description="The number of rows returned") - i_row_filtered: StrictInt = Field(..., alias="iRowFiltered", description="The number of rows matching your filters (if any) or the total number of rows") - a_obj_webhook: conlist(WebhookListElement) = Field(..., alias="a_objWebhook") - __properties = ["iRowReturned", "iRowFiltered", "a_objWebhook"] + Payload for GET /1/object/webhook/getList + """ # noqa: E501 + i_row_returned: StrictInt = Field(description="The number of rows returned", alias="iRowReturned") + i_row_filtered: StrictInt = Field(description="The number of rows matching your filters (if any) or the total number of rows", alias="iRowFiltered") + a_obj_webhook: List[WebhookListElement] = Field(alias="a_objWebhook") + __properties: ClassVar[List[str]] = ["iRowReturned", "iRowFiltered", "a_objWebhook"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> WebhookGetListV1ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of WebhookGetListV1ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of each item in a_obj_webhook (list) _items = [] if self.a_obj_webhook: @@ -66,18 +84,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> WebhookGetListV1ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of WebhookGetListV1ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return WebhookGetListV1ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = WebhookGetListV1ResponseMPayload.parse_obj({ - "i_row_returned": obj.get("iRowReturned"), - "i_row_filtered": obj.get("iRowFiltered"), - "a_obj_webhook": [WebhookListElement.from_dict(_item) for _item in obj.get("a_objWebhook")] if obj.get("a_objWebhook") is not None else None + _obj = cls.model_validate({ + "iRowReturned": obj.get("iRowReturned"), + "iRowFiltered": obj.get("iRowFiltered"), + "a_objWebhook": [WebhookListElement.from_dict(_item) for _item in obj.get("a_objWebhook")] if obj.get("a_objWebhook") is not None else None }) return _obj diff --git a/eZmaxApi/models/webhook_get_object_v2_response.py b/eZmaxApi/models/webhook_get_object_v2_response.py index ca66c7fef..5113b5566 100644 --- a/eZmaxApi/models/webhook_get_object_v2_response.py +++ b/eZmaxApi/models/webhook_get_object_v2_response.py @@ -19,45 +19,63 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload from eZmaxApi.models.webhook_get_object_v2_response_m_payload import WebhookGetObjectV2ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class WebhookGetObjectV2Response(BaseModel): """ - Response for GET /2/object/webhook/{pkiWebhookID} # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - m_payload: WebhookGetObjectV2ResponseMPayload = Field(..., alias="mPayload") - __properties = ["objDebugPayload", "objDebug", "mPayload"] + Response for GET /2/object/webhook/{pkiWebhookID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: WebhookGetObjectV2ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> WebhookGetObjectV2Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of WebhookGetObjectV2Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -70,18 +88,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> WebhookGetObjectV2Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of WebhookGetObjectV2Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return WebhookGetObjectV2Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = WebhookGetObjectV2Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, - "m_payload": WebhookGetObjectV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": WebhookGetObjectV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/webhook_get_object_v2_response_m_payload.py b/eZmaxApi/models/webhook_get_object_v2_response_m_payload.py index 012ee601f..83042246b 100644 --- a/eZmaxApi/models/webhook_get_object_v2_response_m_payload.py +++ b/eZmaxApi/models/webhook_get_object_v2_response_m_payload.py @@ -19,57 +19,75 @@ import json - -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.webhook_response_compound import WebhookResponseCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class WebhookGetObjectV2ResponseMPayload(BaseModel): """ - Payload for GET /2/object/webhook/{pkiWebhookID} # noqa: E501 - """ - obj_webhook: WebhookResponseCompound = Field(..., alias="objWebhook") - __properties = ["objWebhook"] + Payload for GET /2/object/webhook/{pkiWebhookID} + """ # noqa: E501 + obj_webhook: WebhookResponseCompound = Field(alias="objWebhook") + __properties: ClassVar[List[str]] = ["objWebhook"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> WebhookGetObjectV2ResponseMPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of WebhookGetObjectV2ResponseMPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_webhook if self.obj_webhook: _dict['objWebhook'] = self.obj_webhook.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> WebhookGetObjectV2ResponseMPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of WebhookGetObjectV2ResponseMPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return WebhookGetObjectV2ResponseMPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = WebhookGetObjectV2ResponseMPayload.parse_obj({ - "obj_webhook": WebhookResponseCompound.from_dict(obj.get("objWebhook")) if obj.get("objWebhook") is not None else None + _obj = cls.model_validate({ + "objWebhook": WebhookResponseCompound.from_dict(obj.get("objWebhook")) if obj.get("objWebhook") is not None else None }) return _obj diff --git a/eZmaxApi/models/webhook_list_element.py b/eZmaxApi/models/webhook_list_element.py index 18af03241..ebab6936c 100644 --- a/eZmaxApi/models/webhook_list_element.py +++ b/eZmaxApi/models/webhook_list_element.py @@ -19,72 +19,92 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictBool, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, StrictInt, StrictStr +from pydantic import Field from eZmaxApi.models.field_e_webhook_ezsignevent import FieldEWebhookEzsignevent from eZmaxApi.models.field_e_webhook_managementevent import FieldEWebhookManagementevent from eZmaxApi.models.field_e_webhook_module import FieldEWebhookModule +try: + from typing import Self +except ImportError: + from typing_extensions import Self class WebhookListElement(BaseModel): """ - A Webhook List Element # noqa: E501 - """ - pki_webhook_id: StrictInt = Field(..., alias="pkiWebhookID", description="The unique ID of the Webhook") - s_webhook_description: StrictStr = Field(..., alias="sWebhookDescription", description="The description of the Webhook") - s_webhook_url: StrictStr = Field(..., alias="sWebhookUrl", description="The URL of the Webhook callback") - s_webhook_event: StrictStr = Field(..., alias="sWebhookEvent", description="The concatenated string to describe the Webhook event") - s_webhook_emailfailed: StrictStr = Field(..., alias="sWebhookEmailfailed", description="The email that will receive the Webhook in case all attempts fail") - e_webhook_module: FieldEWebhookModule = Field(..., alias="eWebhookModule") - e_webhook_ezsignevent: Optional[FieldEWebhookEzsignevent] = Field(None, alias="eWebhookEzsignevent") - e_webhook_managementevent: Optional[FieldEWebhookManagementevent] = Field(None, alias="eWebhookManagementevent") - b_webhook_isactive: StrictBool = Field(..., alias="bWebhookIsactive", description="Whether the Webhook is active or not") - __properties = ["pkiWebhookID", "sWebhookDescription", "sWebhookUrl", "sWebhookEvent", "sWebhookEmailfailed", "eWebhookModule", "eWebhookEzsignevent", "eWebhookManagementevent", "bWebhookIsactive"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + A Webhook List Element + """ # noqa: E501 + pki_webhook_id: StrictInt = Field(description="The unique ID of the Webhook", alias="pkiWebhookID") + s_webhook_description: StrictStr = Field(description="The description of the Webhook", alias="sWebhookDescription") + s_webhook_url: StrictStr = Field(description="The URL of the Webhook callback", alias="sWebhookUrl") + s_webhook_event: StrictStr = Field(description="The concatenated string to describe the Webhook event", alias="sWebhookEvent") + s_webhook_emailfailed: StrictStr = Field(description="The email that will receive the Webhook in case all attempts fail", alias="sWebhookEmailfailed") + e_webhook_module: FieldEWebhookModule = Field(alias="eWebhookModule") + e_webhook_ezsignevent: Optional[FieldEWebhookEzsignevent] = Field(default=None, alias="eWebhookEzsignevent") + e_webhook_managementevent: Optional[FieldEWebhookManagementevent] = Field(default=None, alias="eWebhookManagementevent") + b_webhook_isactive: StrictBool = Field(description="Whether the Webhook is active or not", alias="bWebhookIsactive") + b_webhook_issigned: StrictBool = Field(description="Whether the requests will be signed or not", alias="bWebhookIssigned") + __properties: ClassVar[List[str]] = ["pkiWebhookID", "sWebhookDescription", "sWebhookUrl", "sWebhookEvent", "sWebhookEmailfailed", "eWebhookModule", "eWebhookEzsignevent", "eWebhookManagementevent", "bWebhookIsactive", "bWebhookIssigned"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> WebhookListElement: + def from_json(cls, json_str: str) -> Self: """Create an instance of WebhookListElement from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> WebhookListElement: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of WebhookListElement from a dict""" if obj is None: return None if not isinstance(obj, dict): - return WebhookListElement.parse_obj(obj) - - _obj = WebhookListElement.parse_obj({ - "pki_webhook_id": obj.get("pkiWebhookID"), - "s_webhook_description": obj.get("sWebhookDescription"), - "s_webhook_url": obj.get("sWebhookUrl"), - "s_webhook_event": obj.get("sWebhookEvent"), - "s_webhook_emailfailed": obj.get("sWebhookEmailfailed"), - "e_webhook_module": obj.get("eWebhookModule"), - "e_webhook_ezsignevent": obj.get("eWebhookEzsignevent"), - "e_webhook_managementevent": obj.get("eWebhookManagementevent"), - "b_webhook_isactive": obj.get("bWebhookIsactive") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiWebhookID": obj.get("pkiWebhookID"), + "sWebhookDescription": obj.get("sWebhookDescription"), + "sWebhookUrl": obj.get("sWebhookUrl"), + "sWebhookEvent": obj.get("sWebhookEvent"), + "sWebhookEmailfailed": obj.get("sWebhookEmailfailed"), + "eWebhookModule": obj.get("eWebhookModule"), + "eWebhookEzsignevent": obj.get("eWebhookEzsignevent"), + "eWebhookManagementevent": obj.get("eWebhookManagementevent"), + "bWebhookIsactive": obj.get("bWebhookIsactive"), + "bWebhookIssigned": obj.get("bWebhookIssigned") }) return _obj diff --git a/eZmaxApi/models/webhook_regenerate_apikey_v1_request.py b/eZmaxApi/models/webhook_regenerate_apikey_v1_request.py new file mode 100644 index 000000000..a4236854f --- /dev/null +++ b/eZmaxApi/models/webhook_regenerate_apikey_v1_request.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool +from pydantic import Field +try: + from typing import Self +except ImportError: + from typing_extensions import Self + +class WebhookRegenerateApikeyV1Request(BaseModel): + """ + Request for POST /1/object/webhook/{pkiWebhookID}/regenerateApikey + """ # noqa: E501 + b_webhook_issigned: Optional[StrictBool] = Field(default=None, description="Whether the requests will be signed or not", alias="bWebhookIssigned") + __properties: ClassVar[List[str]] = ["bWebhookIssigned"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of WebhookRegenerateApikeyV1Request from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Dict) -> Self: + """Create an instance of WebhookRegenerateApikeyV1Request from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "bWebhookIssigned": obj.get("bWebhookIssigned") + }) + return _obj + + diff --git a/eZmaxApi/models/webhook_regenerate_apikey_v1_response.py b/eZmaxApi/models/webhook_regenerate_apikey_v1_response.py new file mode 100644 index 000000000..317f41473 --- /dev/null +++ b/eZmaxApi/models/webhook_regenerate_apikey_v1_response.py @@ -0,0 +1,106 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field +from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug +from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +from eZmaxApi.models.webhook_regenerate_apikey_v1_response_m_payload import WebhookRegenerateApikeyV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self + +class WebhookRegenerateApikeyV1Response(BaseModel): + """ + Response for POST /1/object/webhook/{pkiWebhookID}/regenerateApikey + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: WebhookRegenerateApikeyV1ResponseMPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug", "mPayload"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of WebhookRegenerateApikeyV1Response from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of obj_debug_payload + if self.obj_debug_payload: + _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() + # override the default output from pydantic by calling `to_dict()` of obj_debug + if self.obj_debug: + _dict['objDebug'] = self.obj_debug.to_dict() + # override the default output from pydantic by calling `to_dict()` of m_payload + if self.m_payload: + _dict['mPayload'] = self.m_payload.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Dict) -> Self: + """Create an instance of WebhookRegenerateApikeyV1Response from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None, + "mPayload": WebhookRegenerateApikeyV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + }) + return _obj + + diff --git a/eZmaxApi/models/webhook_regenerate_apikey_v1_response_m_payload.py b/eZmaxApi/models/webhook_regenerate_apikey_v1_response_m_payload.py new file mode 100644 index 000000000..7b5cd03e0 --- /dev/null +++ b/eZmaxApi/models/webhook_regenerate_apikey_v1_response_m_payload.py @@ -0,0 +1,94 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + + +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field +from eZmaxApi.models.webhook_response_compound import WebhookResponseCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self + +class WebhookRegenerateApikeyV1ResponseMPayload(BaseModel): + """ + Response for POST /1/object/webhook/{pkiWebhookID}/regenerateApikey + """ # noqa: E501 + obj_webhook: WebhookResponseCompound = Field(alias="objWebhook") + __properties: ClassVar[List[str]] = ["objWebhook"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of WebhookRegenerateApikeyV1ResponseMPayload from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of obj_webhook + if self.obj_webhook: + _dict['objWebhook'] = self.obj_webhook.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Dict) -> Self: + """Create an instance of WebhookRegenerateApikeyV1ResponseMPayload from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "objWebhook": WebhookResponseCompound.from_dict(obj.get("objWebhook")) if obj.get("objWebhook") is not None else None + }) + return _obj + + diff --git a/eZmaxApi/models/webhook_request.py b/eZmaxApi/models/webhook_request.py index 796012ba5..800a2e788 100644 --- a/eZmaxApi/models/webhook_request.py +++ b/eZmaxApi/models/webhook_request.py @@ -19,74 +19,95 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictBool, StrictInt, StrictStr, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, StrictInt, StrictStr +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.field_e_webhook_ezsignevent import FieldEWebhookEzsignevent from eZmaxApi.models.field_e_webhook_managementevent import FieldEWebhookManagementevent from eZmaxApi.models.field_e_webhook_module import FieldEWebhookModule +try: + from typing import Self +except ImportError: + from typing_extensions import Self class WebhookRequest(BaseModel): """ - A Webhook Object # noqa: E501 - """ - pki_webhook_id: Optional[StrictInt] = Field(None, alias="pkiWebhookID", description="The unique ID of the Webhook") - fki_ezsignfoldertype_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiEzsignfoldertypeID", description="The unique ID of the Ezsignfoldertype.") - s_webhook_description: StrictStr = Field(..., alias="sWebhookDescription", description="The description of the Webhook") - e_webhook_module: FieldEWebhookModule = Field(..., alias="eWebhookModule") - e_webhook_ezsignevent: Optional[FieldEWebhookEzsignevent] = Field(None, alias="eWebhookEzsignevent") - e_webhook_managementevent: Optional[FieldEWebhookManagementevent] = Field(None, alias="eWebhookManagementevent") - s_webhook_url: StrictStr = Field(..., alias="sWebhookUrl", description="The URL of the Webhook callback") - s_webhook_emailfailed: StrictStr = Field(..., alias="sWebhookEmailfailed", description="The email that will receive the Webhook in case all attempts fail") - b_webhook_isactive: StrictBool = Field(..., alias="bWebhookIsactive", description="Whether the Webhook is active or not") - b_webhook_skipsslvalidation: StrictBool = Field(..., alias="bWebhookSkipsslvalidation", description="Wheter the server's SSL certificate should be validated or not. Not recommended to skip for production use") - __properties = ["pkiWebhookID", "fkiEzsignfoldertypeID", "sWebhookDescription", "eWebhookModule", "eWebhookEzsignevent", "eWebhookManagementevent", "sWebhookUrl", "sWebhookEmailfailed", "bWebhookIsactive", "bWebhookSkipsslvalidation"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + A Webhook Object + """ # noqa: E501 + pki_webhook_id: Optional[StrictInt] = Field(default=None, description="The unique ID of the Webhook", alias="pkiWebhookID") + fki_ezsignfoldertype_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsignfoldertype.", alias="fkiEzsignfoldertypeID") + s_webhook_description: StrictStr = Field(description="The description of the Webhook", alias="sWebhookDescription") + e_webhook_module: FieldEWebhookModule = Field(alias="eWebhookModule") + e_webhook_ezsignevent: Optional[FieldEWebhookEzsignevent] = Field(default=None, alias="eWebhookEzsignevent") + e_webhook_managementevent: Optional[FieldEWebhookManagementevent] = Field(default=None, alias="eWebhookManagementevent") + s_webhook_url: StrictStr = Field(description="The URL of the Webhook callback", alias="sWebhookUrl") + s_webhook_emailfailed: StrictStr = Field(description="The email that will receive the Webhook in case all attempts fail", alias="sWebhookEmailfailed") + b_webhook_isactive: StrictBool = Field(description="Whether the Webhook is active or not", alias="bWebhookIsactive") + b_webhook_issigned: Optional[StrictBool] = Field(default=None, description="Whether the requests will be signed or not", alias="bWebhookIssigned") + b_webhook_skipsslvalidation: StrictBool = Field(description="Wheter the server's SSL certificate should be validated or not. Not recommended to skip for production use", alias="bWebhookSkipsslvalidation") + __properties: ClassVar[List[str]] = ["pkiWebhookID", "fkiEzsignfoldertypeID", "sWebhookDescription", "eWebhookModule", "eWebhookEzsignevent", "eWebhookManagementevent", "sWebhookUrl", "sWebhookEmailfailed", "bWebhookIsactive", "bWebhookIssigned", "bWebhookSkipsslvalidation"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> WebhookRequest: + def from_json(cls, json_str: str) -> Self: """Create an instance of WebhookRequest from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> WebhookRequest: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of WebhookRequest from a dict""" if obj is None: return None if not isinstance(obj, dict): - return WebhookRequest.parse_obj(obj) - - _obj = WebhookRequest.parse_obj({ - "pki_webhook_id": obj.get("pkiWebhookID"), - "fki_ezsignfoldertype_id": obj.get("fkiEzsignfoldertypeID"), - "s_webhook_description": obj.get("sWebhookDescription"), - "e_webhook_module": obj.get("eWebhookModule"), - "e_webhook_ezsignevent": obj.get("eWebhookEzsignevent"), - "e_webhook_managementevent": obj.get("eWebhookManagementevent"), - "s_webhook_url": obj.get("sWebhookUrl"), - "s_webhook_emailfailed": obj.get("sWebhookEmailfailed"), - "b_webhook_isactive": obj.get("bWebhookIsactive"), - "b_webhook_skipsslvalidation": obj.get("bWebhookSkipsslvalidation") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiWebhookID": obj.get("pkiWebhookID"), + "fkiEzsignfoldertypeID": obj.get("fkiEzsignfoldertypeID"), + "sWebhookDescription": obj.get("sWebhookDescription"), + "eWebhookModule": obj.get("eWebhookModule"), + "eWebhookEzsignevent": obj.get("eWebhookEzsignevent"), + "eWebhookManagementevent": obj.get("eWebhookManagementevent"), + "sWebhookUrl": obj.get("sWebhookUrl"), + "sWebhookEmailfailed": obj.get("sWebhookEmailfailed"), + "bWebhookIsactive": obj.get("bWebhookIsactive"), + "bWebhookIssigned": obj.get("bWebhookIssigned"), + "bWebhookSkipsslvalidation": obj.get("bWebhookSkipsslvalidation") }) return _obj diff --git a/eZmaxApi/models/webhook_request_compound.py b/eZmaxApi/models/webhook_request_compound.py index 15e64ae54..58036685d 100644 --- a/eZmaxApi/models/webhook_request_compound.py +++ b/eZmaxApi/models/webhook_request_compound.py @@ -19,74 +19,95 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictBool, StrictInt, StrictStr, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, StrictInt, StrictStr +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.field_e_webhook_ezsignevent import FieldEWebhookEzsignevent from eZmaxApi.models.field_e_webhook_managementevent import FieldEWebhookManagementevent from eZmaxApi.models.field_e_webhook_module import FieldEWebhookModule +try: + from typing import Self +except ImportError: + from typing_extensions import Self class WebhookRequestCompound(BaseModel): """ - A Webhook Object and children # noqa: E501 - """ - pki_webhook_id: Optional[StrictInt] = Field(None, alias="pkiWebhookID", description="The unique ID of the Webhook") - fki_ezsignfoldertype_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiEzsignfoldertypeID", description="The unique ID of the Ezsignfoldertype.") - s_webhook_description: StrictStr = Field(..., alias="sWebhookDescription", description="The description of the Webhook") - e_webhook_module: FieldEWebhookModule = Field(..., alias="eWebhookModule") - e_webhook_ezsignevent: Optional[FieldEWebhookEzsignevent] = Field(None, alias="eWebhookEzsignevent") - e_webhook_managementevent: Optional[FieldEWebhookManagementevent] = Field(None, alias="eWebhookManagementevent") - s_webhook_url: StrictStr = Field(..., alias="sWebhookUrl", description="The URL of the Webhook callback") - s_webhook_emailfailed: StrictStr = Field(..., alias="sWebhookEmailfailed", description="The email that will receive the Webhook in case all attempts fail") - b_webhook_isactive: StrictBool = Field(..., alias="bWebhookIsactive", description="Whether the Webhook is active or not") - b_webhook_skipsslvalidation: StrictBool = Field(..., alias="bWebhookSkipsslvalidation", description="Wheter the server's SSL certificate should be validated or not. Not recommended to skip for production use") - __properties = ["pkiWebhookID", "fkiEzsignfoldertypeID", "sWebhookDescription", "eWebhookModule", "eWebhookEzsignevent", "eWebhookManagementevent", "sWebhookUrl", "sWebhookEmailfailed", "bWebhookIsactive", "bWebhookSkipsslvalidation"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + A Webhook Object and children + """ # noqa: E501 + pki_webhook_id: Optional[StrictInt] = Field(default=None, description="The unique ID of the Webhook", alias="pkiWebhookID") + fki_ezsignfoldertype_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsignfoldertype.", alias="fkiEzsignfoldertypeID") + s_webhook_description: StrictStr = Field(description="The description of the Webhook", alias="sWebhookDescription") + e_webhook_module: FieldEWebhookModule = Field(alias="eWebhookModule") + e_webhook_ezsignevent: Optional[FieldEWebhookEzsignevent] = Field(default=None, alias="eWebhookEzsignevent") + e_webhook_managementevent: Optional[FieldEWebhookManagementevent] = Field(default=None, alias="eWebhookManagementevent") + s_webhook_url: StrictStr = Field(description="The URL of the Webhook callback", alias="sWebhookUrl") + s_webhook_emailfailed: StrictStr = Field(description="The email that will receive the Webhook in case all attempts fail", alias="sWebhookEmailfailed") + b_webhook_isactive: StrictBool = Field(description="Whether the Webhook is active or not", alias="bWebhookIsactive") + b_webhook_issigned: Optional[StrictBool] = Field(default=None, description="Whether the requests will be signed or not", alias="bWebhookIssigned") + b_webhook_skipsslvalidation: StrictBool = Field(description="Wheter the server's SSL certificate should be validated or not. Not recommended to skip for production use", alias="bWebhookSkipsslvalidation") + __properties: ClassVar[List[str]] = ["pkiWebhookID", "fkiEzsignfoldertypeID", "sWebhookDescription", "eWebhookModule", "eWebhookEzsignevent", "eWebhookManagementevent", "sWebhookUrl", "sWebhookEmailfailed", "bWebhookIsactive", "bWebhookIssigned", "bWebhookSkipsslvalidation"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> WebhookRequestCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of WebhookRequestCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> WebhookRequestCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of WebhookRequestCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return WebhookRequestCompound.parse_obj(obj) - - _obj = WebhookRequestCompound.parse_obj({ - "pki_webhook_id": obj.get("pkiWebhookID"), - "fki_ezsignfoldertype_id": obj.get("fkiEzsignfoldertypeID"), - "s_webhook_description": obj.get("sWebhookDescription"), - "e_webhook_module": obj.get("eWebhookModule"), - "e_webhook_ezsignevent": obj.get("eWebhookEzsignevent"), - "e_webhook_managementevent": obj.get("eWebhookManagementevent"), - "s_webhook_url": obj.get("sWebhookUrl"), - "s_webhook_emailfailed": obj.get("sWebhookEmailfailed"), - "b_webhook_isactive": obj.get("bWebhookIsactive"), - "b_webhook_skipsslvalidation": obj.get("bWebhookSkipsslvalidation") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiWebhookID": obj.get("pkiWebhookID"), + "fkiEzsignfoldertypeID": obj.get("fkiEzsignfoldertypeID"), + "sWebhookDescription": obj.get("sWebhookDescription"), + "eWebhookModule": obj.get("eWebhookModule"), + "eWebhookEzsignevent": obj.get("eWebhookEzsignevent"), + "eWebhookManagementevent": obj.get("eWebhookManagementevent"), + "sWebhookUrl": obj.get("sWebhookUrl"), + "sWebhookEmailfailed": obj.get("sWebhookEmailfailed"), + "bWebhookIsactive": obj.get("bWebhookIsactive"), + "bWebhookIssigned": obj.get("bWebhookIssigned"), + "bWebhookSkipsslvalidation": obj.get("bWebhookSkipsslvalidation") }) return _obj diff --git a/eZmaxApi/models/webhook_response.py b/eZmaxApi/models/webhook_response.py index 432bac88d..e937eda43 100644 --- a/eZmaxApi/models/webhook_response.py +++ b/eZmaxApi/models/webhook_response.py @@ -19,76 +19,101 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictBool, StrictInt, StrictStr, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, StrictInt, StrictStr +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.field_e_webhook_ezsignevent import FieldEWebhookEzsignevent from eZmaxApi.models.field_e_webhook_managementevent import FieldEWebhookManagementevent from eZmaxApi.models.field_e_webhook_module import FieldEWebhookModule +try: + from typing import Self +except ImportError: + from typing_extensions import Self class WebhookResponse(BaseModel): """ - A webhook object # noqa: E501 - """ - pki_webhook_id: StrictInt = Field(..., alias="pkiWebhookID", description="The unique ID of the Webhook") - s_webhook_description: StrictStr = Field(..., alias="sWebhookDescription", description="The description of the Webhook") - fki_ezsignfoldertype_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiEzsignfoldertypeID", description="The unique ID of the Ezsignfoldertype.") - s_ezsignfoldertype_name_x: Optional[StrictStr] = Field(None, alias="sEzsignfoldertypeNameX", description="The name of the Ezsignfoldertype in the language of the requester") - e_webhook_module: FieldEWebhookModule = Field(..., alias="eWebhookModule") - e_webhook_ezsignevent: Optional[FieldEWebhookEzsignevent] = Field(None, alias="eWebhookEzsignevent") - e_webhook_managementevent: Optional[FieldEWebhookManagementevent] = Field(None, alias="eWebhookManagementevent") - s_webhook_url: StrictStr = Field(..., alias="sWebhookUrl", description="The URL of the Webhook callback") - s_webhook_emailfailed: StrictStr = Field(..., alias="sWebhookEmailfailed", description="The email that will receive the Webhook in case all attempts fail") - b_webhook_isactive: StrictBool = Field(..., alias="bWebhookIsactive", description="Whether the Webhook is active or not") - b_webhook_skipsslvalidation: StrictBool = Field(..., alias="bWebhookSkipsslvalidation", description="Wheter the server's SSL certificate should be validated or not. Not recommended to skip for production use") - __properties = ["pkiWebhookID", "sWebhookDescription", "fkiEzsignfoldertypeID", "sEzsignfoldertypeNameX", "eWebhookModule", "eWebhookEzsignevent", "eWebhookManagementevent", "sWebhookUrl", "sWebhookEmailfailed", "bWebhookIsactive", "bWebhookSkipsslvalidation"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + A webhook object + """ # noqa: E501 + pki_webhook_id: StrictInt = Field(description="The unique ID of the Webhook", alias="pkiWebhookID") + s_webhook_description: StrictStr = Field(description="The description of the Webhook", alias="sWebhookDescription") + fki_ezsignfoldertype_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsignfoldertype.", alias="fkiEzsignfoldertypeID") + s_ezsignfoldertype_name_x: Optional[StrictStr] = Field(default=None, description="The name of the Ezsignfoldertype in the language of the requester", alias="sEzsignfoldertypeNameX") + e_webhook_module: FieldEWebhookModule = Field(alias="eWebhookModule") + e_webhook_ezsignevent: Optional[FieldEWebhookEzsignevent] = Field(default=None, alias="eWebhookEzsignevent") + e_webhook_managementevent: Optional[FieldEWebhookManagementevent] = Field(default=None, alias="eWebhookManagementevent") + s_webhook_url: StrictStr = Field(description="The URL of the Webhook callback", alias="sWebhookUrl") + s_webhook_emailfailed: StrictStr = Field(description="The email that will receive the Webhook in case all attempts fail", alias="sWebhookEmailfailed") + s_webhook_apikey: Optional[StrictStr] = Field(default=None, description="The Apikey for the Webhook. This will be hidden if we are not creating or regenerating the Apikey.", alias="sWebhookApikey") + s_webhook_secret: Optional[StrictStr] = Field(default=None, description="The Secret for the Webhook. This will be hidden if we are not creating or regenerating the Apikey.", alias="sWebhookSecret") + b_webhook_isactive: StrictBool = Field(description="Whether the Webhook is active or not", alias="bWebhookIsactive") + b_webhook_issigned: StrictBool = Field(description="Whether the requests will be signed or not", alias="bWebhookIssigned") + b_webhook_skipsslvalidation: StrictBool = Field(description="Wheter the server's SSL certificate should be validated or not. Not recommended to skip for production use", alias="bWebhookSkipsslvalidation") + __properties: ClassVar[List[str]] = ["pkiWebhookID", "sWebhookDescription", "fkiEzsignfoldertypeID", "sEzsignfoldertypeNameX", "eWebhookModule", "eWebhookEzsignevent", "eWebhookManagementevent", "sWebhookUrl", "sWebhookEmailfailed", "sWebhookApikey", "sWebhookSecret", "bWebhookIsactive", "bWebhookIssigned", "bWebhookSkipsslvalidation"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> WebhookResponse: + def from_json(cls, json_str: str) -> Self: """Create an instance of WebhookResponse from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> WebhookResponse: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of WebhookResponse from a dict""" if obj is None: return None if not isinstance(obj, dict): - return WebhookResponse.parse_obj(obj) - - _obj = WebhookResponse.parse_obj({ - "pki_webhook_id": obj.get("pkiWebhookID"), - "s_webhook_description": obj.get("sWebhookDescription"), - "fki_ezsignfoldertype_id": obj.get("fkiEzsignfoldertypeID"), - "s_ezsignfoldertype_name_x": obj.get("sEzsignfoldertypeNameX"), - "e_webhook_module": obj.get("eWebhookModule"), - "e_webhook_ezsignevent": obj.get("eWebhookEzsignevent"), - "e_webhook_managementevent": obj.get("eWebhookManagementevent"), - "s_webhook_url": obj.get("sWebhookUrl"), - "s_webhook_emailfailed": obj.get("sWebhookEmailfailed"), - "b_webhook_isactive": obj.get("bWebhookIsactive"), - "b_webhook_skipsslvalidation": obj.get("bWebhookSkipsslvalidation") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiWebhookID": obj.get("pkiWebhookID"), + "sWebhookDescription": obj.get("sWebhookDescription"), + "fkiEzsignfoldertypeID": obj.get("fkiEzsignfoldertypeID"), + "sEzsignfoldertypeNameX": obj.get("sEzsignfoldertypeNameX"), + "eWebhookModule": obj.get("eWebhookModule"), + "eWebhookEzsignevent": obj.get("eWebhookEzsignevent"), + "eWebhookManagementevent": obj.get("eWebhookManagementevent"), + "sWebhookUrl": obj.get("sWebhookUrl"), + "sWebhookEmailfailed": obj.get("sWebhookEmailfailed"), + "sWebhookApikey": obj.get("sWebhookApikey"), + "sWebhookSecret": obj.get("sWebhookSecret"), + "bWebhookIsactive": obj.get("bWebhookIsactive"), + "bWebhookIssigned": obj.get("bWebhookIssigned"), + "bWebhookSkipsslvalidation": obj.get("bWebhookSkipsslvalidation") }) return _obj diff --git a/eZmaxApi/models/webhook_response_compound.py b/eZmaxApi/models/webhook_response_compound.py index a84853405..34f264704 100644 --- a/eZmaxApi/models/webhook_response_compound.py +++ b/eZmaxApi/models/webhook_response_compound.py @@ -19,78 +19,103 @@ import json -from typing import Optional -from pydantic import BaseModel, Field, StrictBool, StrictInt, StrictStr, conint +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel, StrictBool, StrictInt, StrictStr +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.field_e_webhook_ezsignevent import FieldEWebhookEzsignevent from eZmaxApi.models.field_e_webhook_managementevent import FieldEWebhookManagementevent from eZmaxApi.models.field_e_webhook_module import FieldEWebhookModule +try: + from typing import Self +except ImportError: + from typing_extensions import Self class WebhookResponseCompound(BaseModel): """ - A Webhook Object # noqa: E501 - """ - pki_webhook_id: StrictInt = Field(..., alias="pkiWebhookID", description="The unique ID of the Webhook") - s_webhook_description: StrictStr = Field(..., alias="sWebhookDescription", description="The description of the Webhook") - fki_ezsignfoldertype_id: Optional[conint(strict=True, ge=0)] = Field(None, alias="fkiEzsignfoldertypeID", description="The unique ID of the Ezsignfoldertype.") - s_ezsignfoldertype_name_x: Optional[StrictStr] = Field(None, alias="sEzsignfoldertypeNameX", description="The name of the Ezsignfoldertype in the language of the requester") - e_webhook_module: FieldEWebhookModule = Field(..., alias="eWebhookModule") - e_webhook_ezsignevent: Optional[FieldEWebhookEzsignevent] = Field(None, alias="eWebhookEzsignevent") - e_webhook_managementevent: Optional[FieldEWebhookManagementevent] = Field(None, alias="eWebhookManagementevent") - s_webhook_url: StrictStr = Field(..., alias="sWebhookUrl", description="The URL of the Webhook callback") - s_webhook_emailfailed: StrictStr = Field(..., alias="sWebhookEmailfailed", description="The email that will receive the Webhook in case all attempts fail") - b_webhook_isactive: StrictBool = Field(..., alias="bWebhookIsactive", description="Whether the Webhook is active or not") - b_webhook_skipsslvalidation: StrictBool = Field(..., alias="bWebhookSkipsslvalidation", description="Wheter the server's SSL certificate should be validated or not. Not recommended to skip for production use") - s_webhook_event: Optional[StrictStr] = Field(None, alias="sWebhookEvent", description="The concatenated string to describe the Webhook event") - __properties = ["pkiWebhookID", "sWebhookDescription", "fkiEzsignfoldertypeID", "sEzsignfoldertypeNameX", "eWebhookModule", "eWebhookEzsignevent", "eWebhookManagementevent", "sWebhookUrl", "sWebhookEmailfailed", "bWebhookIsactive", "bWebhookSkipsslvalidation", "sWebhookEvent"] - - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + A Webhook Object + """ # noqa: E501 + pki_webhook_id: StrictInt = Field(description="The unique ID of the Webhook", alias="pkiWebhookID") + s_webhook_description: StrictStr = Field(description="The description of the Webhook", alias="sWebhookDescription") + fki_ezsignfoldertype_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsignfoldertype.", alias="fkiEzsignfoldertypeID") + s_ezsignfoldertype_name_x: Optional[StrictStr] = Field(default=None, description="The name of the Ezsignfoldertype in the language of the requester", alias="sEzsignfoldertypeNameX") + e_webhook_module: FieldEWebhookModule = Field(alias="eWebhookModule") + e_webhook_ezsignevent: Optional[FieldEWebhookEzsignevent] = Field(default=None, alias="eWebhookEzsignevent") + e_webhook_managementevent: Optional[FieldEWebhookManagementevent] = Field(default=None, alias="eWebhookManagementevent") + s_webhook_url: StrictStr = Field(description="The URL of the Webhook callback", alias="sWebhookUrl") + s_webhook_emailfailed: StrictStr = Field(description="The email that will receive the Webhook in case all attempts fail", alias="sWebhookEmailfailed") + s_webhook_apikey: Optional[StrictStr] = Field(default=None, description="The Apikey for the Webhook. This will be hidden if we are not creating or regenerating the Apikey.", alias="sWebhookApikey") + s_webhook_secret: Optional[StrictStr] = Field(default=None, description="The Secret for the Webhook. This will be hidden if we are not creating or regenerating the Apikey.", alias="sWebhookSecret") + b_webhook_isactive: StrictBool = Field(description="Whether the Webhook is active or not", alias="bWebhookIsactive") + b_webhook_issigned: StrictBool = Field(description="Whether the requests will be signed or not", alias="bWebhookIssigned") + b_webhook_skipsslvalidation: StrictBool = Field(description="Wheter the server's SSL certificate should be validated or not. Not recommended to skip for production use", alias="bWebhookSkipsslvalidation") + s_webhook_event: Optional[StrictStr] = Field(default=None, description="The concatenated string to describe the Webhook event", alias="sWebhookEvent") + __properties: ClassVar[List[str]] = ["pkiWebhookID", "sWebhookDescription", "fkiEzsignfoldertypeID", "sEzsignfoldertypeNameX", "eWebhookModule", "eWebhookEzsignevent", "eWebhookManagementevent", "sWebhookUrl", "sWebhookEmailfailed", "sWebhookApikey", "sWebhookSecret", "bWebhookIsactive", "bWebhookIssigned", "bWebhookSkipsslvalidation", "sWebhookEvent"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> WebhookResponseCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of WebhookResponseCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> WebhookResponseCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of WebhookResponseCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return WebhookResponseCompound.parse_obj(obj) - - _obj = WebhookResponseCompound.parse_obj({ - "pki_webhook_id": obj.get("pkiWebhookID"), - "s_webhook_description": obj.get("sWebhookDescription"), - "fki_ezsignfoldertype_id": obj.get("fkiEzsignfoldertypeID"), - "s_ezsignfoldertype_name_x": obj.get("sEzsignfoldertypeNameX"), - "e_webhook_module": obj.get("eWebhookModule"), - "e_webhook_ezsignevent": obj.get("eWebhookEzsignevent"), - "e_webhook_managementevent": obj.get("eWebhookManagementevent"), - "s_webhook_url": obj.get("sWebhookUrl"), - "s_webhook_emailfailed": obj.get("sWebhookEmailfailed"), - "b_webhook_isactive": obj.get("bWebhookIsactive"), - "b_webhook_skipsslvalidation": obj.get("bWebhookSkipsslvalidation"), - "s_webhook_event": obj.get("sWebhookEvent") + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiWebhookID": obj.get("pkiWebhookID"), + "sWebhookDescription": obj.get("sWebhookDescription"), + "fkiEzsignfoldertypeID": obj.get("fkiEzsignfoldertypeID"), + "sEzsignfoldertypeNameX": obj.get("sEzsignfoldertypeNameX"), + "eWebhookModule": obj.get("eWebhookModule"), + "eWebhookEzsignevent": obj.get("eWebhookEzsignevent"), + "eWebhookManagementevent": obj.get("eWebhookManagementevent"), + "sWebhookUrl": obj.get("sWebhookUrl"), + "sWebhookEmailfailed": obj.get("sWebhookEmailfailed"), + "sWebhookApikey": obj.get("sWebhookApikey"), + "sWebhookSecret": obj.get("sWebhookSecret"), + "bWebhookIsactive": obj.get("bWebhookIsactive"), + "bWebhookIssigned": obj.get("bWebhookIssigned"), + "bWebhookSkipsslvalidation": obj.get("bWebhookSkipsslvalidation"), + "sWebhookEvent": obj.get("sWebhookEvent") }) return _obj diff --git a/eZmaxApi/models/webhook_test_v1_response.py b/eZmaxApi/models/webhook_test_v1_response.py index 372598e67..fa822f347 100644 --- a/eZmaxApi/models/webhook_test_v1_response.py +++ b/eZmaxApi/models/webhook_test_v1_response.py @@ -19,43 +19,61 @@ import json -from typing import Optional -from pydantic import BaseModel, Field +from typing import Any, ClassVar, Dict, List, Optional +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class WebhookTestV1Response(BaseModel): """ - Response for POST /1/object/webhook/{pkiWebhookID}/test # noqa: E501 - """ - obj_debug_payload: CommonResponseObjDebugPayload = Field(..., alias="objDebugPayload") - obj_debug: Optional[CommonResponseObjDebug] = Field(None, alias="objDebug") - __properties = ["objDebugPayload", "objDebug"] + Response for POST /1/object/webhook/{pkiWebhookID}/test + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + __properties: ClassVar[List[str]] = ["objDebugPayload", "objDebug"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> WebhookTestV1Response: + def from_json(cls, json_str: str) -> Self: """Create an instance of WebhookTestV1Response from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_debug_payload if self.obj_debug_payload: _dict['objDebugPayload'] = self.obj_debug_payload.to_dict() @@ -65,17 +83,17 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> WebhookTestV1Response: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of WebhookTestV1Response from a dict""" if obj is None: return None if not isinstance(obj, dict): - return WebhookTestV1Response.parse_obj(obj) + return cls.model_validate(obj) - _obj = WebhookTestV1Response.parse_obj({ - "obj_debug_payload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "obj_debug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None + _obj = cls.model_validate({ + "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, + "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") is not None else None }) return _obj diff --git a/eZmaxApi/models/webhook_user_user_created.py b/eZmaxApi/models/webhook_user_user_created.py index 79ba7ef13..b4d32ee18 100644 --- a/eZmaxApi/models/webhook_user_user_created.py +++ b/eZmaxApi/models/webhook_user_user_created.py @@ -19,45 +19,63 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.attempt_response_compound import AttemptResponseCompound from eZmaxApi.models.custom_webhook_response import CustomWebhookResponse from eZmaxApi.models.user_response_compound import UserResponseCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class WebhookUserUserCreated(BaseModel): """ - This is the base Webhook object # noqa: E501 - """ - obj_webhook: CustomWebhookResponse = Field(..., alias="objWebhook") - a_obj_attempt: conlist(AttemptResponseCompound) = Field(..., alias="a_objAttempt", description="An array containing details of previous attempts that were made to deliver the message. The array is empty if it's the first attempt.") - obj_user: UserResponseCompound = Field(..., alias="objUser") - __properties = ["objWebhook", "a_objAttempt", "objUser"] + This is the base Webhook object + """ # noqa: E501 + obj_webhook: CustomWebhookResponse = Field(alias="objWebhook") + a_obj_attempt: List[AttemptResponseCompound] = Field(description="An array containing details of previous attempts that were made to deliver the message. The array is empty if it's the first attempt.", alias="a_objAttempt") + obj_user: UserResponseCompound = Field(alias="objUser") + __properties: ClassVar[List[str]] = ["objWebhook", "a_objAttempt", "objUser"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> WebhookUserUserCreated: + def from_json(cls, json_str: str) -> Self: """Create an instance of WebhookUserUserCreated from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_webhook if self.obj_webhook: _dict['objWebhook'] = self.obj_webhook.to_dict() @@ -74,18 +92,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> WebhookUserUserCreated: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of WebhookUserUserCreated from a dict""" if obj is None: return None if not isinstance(obj, dict): - return WebhookUserUserCreated.parse_obj(obj) + return cls.model_validate(obj) - _obj = WebhookUserUserCreated.parse_obj({ - "obj_webhook": CustomWebhookResponse.from_dict(obj.get("objWebhook")) if obj.get("objWebhook") is not None else None, - "a_obj_attempt": [AttemptResponseCompound.from_dict(_item) for _item in obj.get("a_objAttempt")] if obj.get("a_objAttempt") is not None else None, - "obj_user": UserResponseCompound.from_dict(obj.get("objUser")) if obj.get("objUser") is not None else None + _obj = cls.model_validate({ + "objWebhook": CustomWebhookResponse.from_dict(obj.get("objWebhook")) if obj.get("objWebhook") is not None else None, + "a_objAttempt": [AttemptResponseCompound.from_dict(_item) for _item in obj.get("a_objAttempt")] if obj.get("a_objAttempt") is not None else None, + "objUser": UserResponseCompound.from_dict(obj.get("objUser")) if obj.get("objUser") is not None else None }) return _obj diff --git a/eZmaxApi/models/webhook_userstaged_userstaged_created.py b/eZmaxApi/models/webhook_userstaged_userstaged_created.py index 22df36be6..533193fea 100644 --- a/eZmaxApi/models/webhook_userstaged_userstaged_created.py +++ b/eZmaxApi/models/webhook_userstaged_userstaged_created.py @@ -19,45 +19,63 @@ import json -from typing import List -from pydantic import BaseModel, Field, conlist +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel +from pydantic import Field from eZmaxApi.models.attempt_response_compound import AttemptResponseCompound from eZmaxApi.models.custom_webhook_response import CustomWebhookResponse from eZmaxApi.models.userstaged_response_compound import UserstagedResponseCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self class WebhookUserstagedUserstagedCreated(BaseModel): """ - This is the base Webhook object # noqa: E501 - """ - obj_webhook: CustomWebhookResponse = Field(..., alias="objWebhook") - a_obj_attempt: conlist(AttemptResponseCompound) = Field(..., alias="a_objAttempt", description="An array containing details of previous attempts that were made to deliver the message. The array is empty if it's the first attempt.") - obj_userstaged: UserstagedResponseCompound = Field(..., alias="objUserstaged") - __properties = ["objWebhook", "a_objAttempt", "objUserstaged"] + This is the base Webhook object + """ # noqa: E501 + obj_webhook: CustomWebhookResponse = Field(alias="objWebhook") + a_obj_attempt: List[AttemptResponseCompound] = Field(description="An array containing details of previous attempts that were made to deliver the message. The array is empty if it's the first attempt.", alias="a_objAttempt") + obj_userstaged: UserstagedResponseCompound = Field(alias="objUserstaged") + __properties: ClassVar[List[str]] = ["objWebhook", "a_objAttempt", "objUserstaged"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> WebhookUserstagedUserstagedCreated: + def from_json(cls, json_str: str) -> Self: """Create an instance of WebhookUserstagedUserstagedCreated from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of obj_webhook if self.obj_webhook: _dict['objWebhook'] = self.obj_webhook.to_dict() @@ -74,18 +92,18 @@ def to_dict(self): return _dict @classmethod - def from_dict(cls, obj: dict) -> WebhookUserstagedUserstagedCreated: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of WebhookUserstagedUserstagedCreated from a dict""" if obj is None: return None if not isinstance(obj, dict): - return WebhookUserstagedUserstagedCreated.parse_obj(obj) + return cls.model_validate(obj) - _obj = WebhookUserstagedUserstagedCreated.parse_obj({ - "obj_webhook": CustomWebhookResponse.from_dict(obj.get("objWebhook")) if obj.get("objWebhook") is not None else None, - "a_obj_attempt": [AttemptResponseCompound.from_dict(_item) for _item in obj.get("a_objAttempt")] if obj.get("a_objAttempt") is not None else None, - "obj_userstaged": UserstagedResponseCompound.from_dict(obj.get("objUserstaged")) if obj.get("objUserstaged") is not None else None + _obj = cls.model_validate({ + "objWebhook": CustomWebhookResponse.from_dict(obj.get("objWebhook")) if obj.get("objWebhook") is not None else None, + "a_objAttempt": [AttemptResponseCompound.from_dict(_item) for _item in obj.get("a_objAttempt")] if obj.get("a_objAttempt") is not None else None, + "objUserstaged": UserstagedResponseCompound.from_dict(obj.get("objUserstaged")) if obj.get("objUserstaged") is not None else None }) return _obj diff --git a/eZmaxApi/models/website_request.py b/eZmaxApi/models/website_request.py index 304ea33c8..eda087959 100644 --- a/eZmaxApi/models/website_request.py +++ b/eZmaxApi/models/website_request.py @@ -19,55 +19,74 @@ import json - -from pydantic import BaseModel, Field, StrictStr, conint +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictStr +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class WebsiteRequest(BaseModel): """ - A Website Object # noqa: E501 - """ - fki_websitetype_id: conint(strict=True, ge=0) = Field(..., alias="fkiWebsitetypeID", description="The unique ID of the Websitetype. Valid values: |Value|Description| |-|-| |1|Website| |2|Twitter| |3|Facebook| |4|Survey|") - s_website_address: StrictStr = Field(..., alias="sWebsiteAddress", description="The URL of the website.") - __properties = ["fkiWebsitetypeID", "sWebsiteAddress"] + A Website Object + """ # noqa: E501 + fki_websitetype_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Websitetype. Valid values: |Value|Description| |-|-| |1|Website| |2|Twitter| |3|Facebook| |4|Survey|", alias="fkiWebsitetypeID") + s_website_address: StrictStr = Field(description="The URL of the website.", alias="sWebsiteAddress") + __properties: ClassVar[List[str]] = ["fkiWebsitetypeID", "sWebsiteAddress"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> WebsiteRequest: + def from_json(cls, json_str: str) -> Self: """Create an instance of WebsiteRequest from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> WebsiteRequest: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of WebsiteRequest from a dict""" if obj is None: return None if not isinstance(obj, dict): - return WebsiteRequest.parse_obj(obj) + return cls.model_validate(obj) - _obj = WebsiteRequest.parse_obj({ - "fki_websitetype_id": obj.get("fkiWebsitetypeID"), - "s_website_address": obj.get("sWebsiteAddress") + _obj = cls.model_validate({ + "fkiWebsitetypeID": obj.get("fkiWebsitetypeID"), + "sWebsiteAddress": obj.get("sWebsiteAddress") }) return _obj diff --git a/eZmaxApi/models/website_request_compound.py b/eZmaxApi/models/website_request_compound.py index 0108fd2e7..4efa00f2a 100644 --- a/eZmaxApi/models/website_request_compound.py +++ b/eZmaxApi/models/website_request_compound.py @@ -19,55 +19,74 @@ import json - -from pydantic import BaseModel, Field, StrictStr, conint +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictStr +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class WebsiteRequestCompound(BaseModel): """ - A Website Object and children to create a complete structure # noqa: E501 - """ - fki_websitetype_id: conint(strict=True, ge=0) = Field(..., alias="fkiWebsitetypeID", description="The unique ID of the Websitetype. Valid values: |Value|Description| |-|-| |1|Website| |2|Twitter| |3|Facebook| |4|Survey|") - s_website_address: StrictStr = Field(..., alias="sWebsiteAddress", description="The URL of the website.") - __properties = ["fkiWebsitetypeID", "sWebsiteAddress"] + A Website Object and children to create a complete structure + """ # noqa: E501 + fki_websitetype_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Websitetype. Valid values: |Value|Description| |-|-| |1|Website| |2|Twitter| |3|Facebook| |4|Survey|", alias="fkiWebsitetypeID") + s_website_address: StrictStr = Field(description="The URL of the website.", alias="sWebsiteAddress") + __properties: ClassVar[List[str]] = ["fkiWebsitetypeID", "sWebsiteAddress"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> WebsiteRequestCompound: + def from_json(cls, json_str: str) -> Self: """Create an instance of WebsiteRequestCompound from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> WebsiteRequestCompound: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of WebsiteRequestCompound from a dict""" if obj is None: return None if not isinstance(obj, dict): - return WebsiteRequestCompound.parse_obj(obj) + return cls.model_validate(obj) - _obj = WebsiteRequestCompound.parse_obj({ - "fki_websitetype_id": obj.get("fkiWebsitetypeID"), - "s_website_address": obj.get("sWebsiteAddress") + _obj = cls.model_validate({ + "fkiWebsitetypeID": obj.get("fkiWebsitetypeID"), + "sWebsiteAddress": obj.get("sWebsiteAddress") }) return _obj diff --git a/eZmaxApi/models/websocket_request_server_get_websocket_idv1.py b/eZmaxApi/models/websocket_request_server_get_websocket_idv1.py index 8329ee4c5..69b00b9a4 100644 --- a/eZmaxApi/models/websocket_request_server_get_websocket_idv1.py +++ b/eZmaxApi/models/websocket_request_server_get_websocket_idv1.py @@ -19,60 +19,78 @@ import json - -from pydantic import BaseModel, Field, StrictStr, validator +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictStr, field_validator +from pydantic import Field +try: + from typing import Self +except ImportError: + from typing_extensions import Self class WebsocketRequestServerGetWebsocketIDV1(BaseModel): """ - Request for Websocket GetWebsocketID V1 # noqa: E501 - """ - e_websocket_messagetype: StrictStr = Field(..., alias="eWebsocketMessagetype", description="The Type of message") - __properties = ["eWebsocketMessagetype"] + Request for Websocket GetWebsocketID V1 + """ # noqa: E501 + e_websocket_messagetype: StrictStr = Field(description="The Type of message", alias="eWebsocketMessagetype") + __properties: ClassVar[List[str]] = ["eWebsocketMessagetype"] - @validator('e_websocket_messagetype') + @field_validator('e_websocket_messagetype') def e_websocket_messagetype_validate_enum(cls, value): """Validates the enum""" if value not in ('RequestServer-GetWebsocketID-V1'): raise ValueError("must be one of enum values ('RequestServer-GetWebsocketID-V1')") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> WebsocketRequestServerGetWebsocketIDV1: + def from_json(cls, json_str: str) -> Self: """Create an instance of WebsocketRequestServerGetWebsocketIDV1 from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> WebsocketRequestServerGetWebsocketIDV1: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of WebsocketRequestServerGetWebsocketIDV1 from a dict""" if obj is None: return None if not isinstance(obj, dict): - return WebsocketRequestServerGetWebsocketIDV1.parse_obj(obj) + return cls.model_validate(obj) - _obj = WebsocketRequestServerGetWebsocketIDV1.parse_obj({ - "e_websocket_messagetype": obj.get("eWebsocketMessagetype") + _obj = cls.model_validate({ + "eWebsocketMessagetype": obj.get("eWebsocketMessagetype") }) return _obj diff --git a/eZmaxApi/models/websocket_response_error_v1.py b/eZmaxApi/models/websocket_response_error_v1.py index d89566b8b..f6d5176a8 100644 --- a/eZmaxApi/models/websocket_response_error_v1.py +++ b/eZmaxApi/models/websocket_response_error_v1.py @@ -19,66 +19,94 @@ import json - -from pydantic import BaseModel, Field, StrictStr, validator +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictStr, field_validator +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.websocket_response_error_v1_m_payload import WebsocketResponseErrorV1MPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class WebsocketResponseErrorV1(BaseModel): """ - Response for Websocket Error V1 # noqa: E501 - """ - e_websocket_messagetype: StrictStr = Field(..., alias="eWebsocketMessagetype", description="The Type of message") - m_payload: WebsocketResponseErrorV1MPayload = Field(..., alias="mPayload") - __properties = ["eWebsocketMessagetype", "mPayload"] - - @validator('e_websocket_messagetype') + Response for Websocket Error V1 + """ # noqa: E501 + e_websocket_messagetype: StrictStr = Field(description="The Type of message", alias="eWebsocketMessagetype") + s_websocket_channel: Annotated[str, Field(strict=True)] = Field(description="The Channel on which to route the websocket message", alias="sWebsocketChannel") + m_payload: WebsocketResponseErrorV1MPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["eWebsocketMessagetype", "sWebsocketChannel", "mPayload"] + + @field_validator('e_websocket_messagetype') def e_websocket_messagetype_validate_enum(cls, value): """Validates the enum""" if value not in ('Response-Error-V1'): raise ValueError("must be one of enum values ('Response-Error-V1')") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + @field_validator('s_websocket_channel') + def s_websocket_channel_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^[a-zA-Z0-9_@.]{32}$", value): + raise ValueError(r"must validate the regular expression /^[a-zA-Z0-9_@.]{32}$/") + return value + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> WebsocketResponseErrorV1: + def from_json(cls, json_str: str) -> Self: """Create an instance of WebsocketResponseErrorV1 from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of m_payload if self.m_payload: _dict['mPayload'] = self.m_payload.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> WebsocketResponseErrorV1: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of WebsocketResponseErrorV1 from a dict""" if obj is None: return None if not isinstance(obj, dict): - return WebsocketResponseErrorV1.parse_obj(obj) + return cls.model_validate(obj) - _obj = WebsocketResponseErrorV1.parse_obj({ - "e_websocket_messagetype": obj.get("eWebsocketMessagetype"), - "m_payload": WebsocketResponseErrorV1MPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "eWebsocketMessagetype": obj.get("eWebsocketMessagetype"), + "sWebsocketChannel": obj.get("sWebsocketChannel"), + "mPayload": WebsocketResponseErrorV1MPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/websocket_response_error_v1_m_payload.py b/eZmaxApi/models/websocket_response_error_v1_m_payload.py index 23e6f216f..013b0230b 100644 --- a/eZmaxApi/models/websocket_response_error_v1_m_payload.py +++ b/eZmaxApi/models/websocket_response_error_v1_m_payload.py @@ -19,63 +19,82 @@ import json - -from pydantic import BaseModel, Field, constr, validator +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, field_validator +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.field_e_error_code import FieldEErrorCode +try: + from typing import Self +except ImportError: + from typing_extensions import Self class WebsocketResponseErrorV1MPayload(BaseModel): """ - Payload for Websocket Error V1 # noqa: E501 - """ - s_error_message: constr(strict=True) = Field(..., alias="sErrorMessage", description="The message giving details about the error") - e_error_code: FieldEErrorCode = Field(..., alias="eErrorCode") - __properties = ["sErrorMessage", "eErrorCode"] + Payload for Websocket Error V1 + """ # noqa: E501 + s_error_message: Annotated[str, Field(strict=True)] = Field(description="The message giving details about the error", alias="sErrorMessage") + e_error_code: FieldEErrorCode = Field(alias="eErrorCode") + __properties: ClassVar[List[str]] = ["sErrorMessage", "eErrorCode"] - @validator('s_error_message') + @field_validator('s_error_message') def s_error_message_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^.{0,500}$", value): raise ValueError(r"must validate the regular expression /^.{0,500}$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> WebsocketResponseErrorV1MPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of WebsocketResponseErrorV1MPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> WebsocketResponseErrorV1MPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of WebsocketResponseErrorV1MPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return WebsocketResponseErrorV1MPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = WebsocketResponseErrorV1MPayload.parse_obj({ - "s_error_message": obj.get("sErrorMessage"), - "e_error_code": obj.get("eErrorCode") + _obj = cls.model_validate({ + "sErrorMessage": obj.get("sErrorMessage"), + "eErrorCode": obj.get("eErrorCode") }) return _obj diff --git a/eZmaxApi/models/websocket_response_get_websocket_idv1.py b/eZmaxApi/models/websocket_response_get_websocket_idv1.py index 5637ae278..be5f6973c 100644 --- a/eZmaxApi/models/websocket_response_get_websocket_idv1.py +++ b/eZmaxApi/models/websocket_response_get_websocket_idv1.py @@ -19,66 +19,84 @@ import json - -from pydantic import BaseModel, Field, StrictStr, validator +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictStr, field_validator +from pydantic import Field from eZmaxApi.models.websocket_response_get_websocket_idv1_m_payload import WebsocketResponseGetWebsocketIDV1MPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class WebsocketResponseGetWebsocketIDV1(BaseModel): """ - Response for Websocket GetWebsocketID V1 # noqa: E501 - """ - e_websocket_messagetype: StrictStr = Field(..., alias="eWebsocketMessagetype", description="The Type of message") - m_payload: WebsocketResponseGetWebsocketIDV1MPayload = Field(..., alias="mPayload") - __properties = ["eWebsocketMessagetype", "mPayload"] + Response for Websocket GetWebsocketID V1 + """ # noqa: E501 + e_websocket_messagetype: StrictStr = Field(description="The Type of message", alias="eWebsocketMessagetype") + m_payload: WebsocketResponseGetWebsocketIDV1MPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["eWebsocketMessagetype", "mPayload"] - @validator('e_websocket_messagetype') + @field_validator('e_websocket_messagetype') def e_websocket_messagetype_validate_enum(cls, value): """Validates the enum""" if value not in ('Response-GetWebsocketID-V1'): raise ValueError("must be one of enum values ('Response-GetWebsocketID-V1')") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> WebsocketResponseGetWebsocketIDV1: + def from_json(cls, json_str: str) -> Self: """Create an instance of WebsocketResponseGetWebsocketIDV1 from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of m_payload if self.m_payload: _dict['mPayload'] = self.m_payload.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> WebsocketResponseGetWebsocketIDV1: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of WebsocketResponseGetWebsocketIDV1 from a dict""" if obj is None: return None if not isinstance(obj, dict): - return WebsocketResponseGetWebsocketIDV1.parse_obj(obj) + return cls.model_validate(obj) - _obj = WebsocketResponseGetWebsocketIDV1.parse_obj({ - "e_websocket_messagetype": obj.get("eWebsocketMessagetype"), - "m_payload": WebsocketResponseGetWebsocketIDV1MPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "eWebsocketMessagetype": obj.get("eWebsocketMessagetype"), + "mPayload": WebsocketResponseGetWebsocketIDV1MPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/websocket_response_get_websocket_idv1_m_payload.py b/eZmaxApi/models/websocket_response_get_websocket_idv1_m_payload.py index a5b53c1dc..4a5c088ad 100644 --- a/eZmaxApi/models/websocket_response_get_websocket_idv1_m_payload.py +++ b/eZmaxApi/models/websocket_response_get_websocket_idv1_m_payload.py @@ -19,60 +19,79 @@ import json - -from pydantic import BaseModel, Field, constr, validator +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, field_validator +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self class WebsocketResponseGetWebsocketIDV1MPayload(BaseModel): """ - Payload for Websocket GetWebsocketID V1 # noqa: E501 - """ - s_websocket_id: constr(strict=True) = Field(..., alias="sWebsocketID", description="The Unique ID of the Websocket Connection") - __properties = ["sWebsocketID"] + Payload for Websocket GetWebsocketID V1 + """ # noqa: E501 + s_websocket_id: Annotated[str, Field(strict=True)] = Field(description="The Unique ID of the Websocket Connection", alias="sWebsocketID") + __properties: ClassVar[List[str]] = ["sWebsocketID"] - @validator('s_websocket_id') + @field_validator('s_websocket_id') def s_websocket_id_validate_regular_expression(cls, value): """Validates the regular expression""" if not re.match(r"^[a-zA-Z0-9_-]{15}=$", value): raise ValueError(r"must validate the regular expression /^[a-zA-Z0-9_-]{15}=$/") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> WebsocketResponseGetWebsocketIDV1MPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of WebsocketResponseGetWebsocketIDV1MPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> WebsocketResponseGetWebsocketIDV1MPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of WebsocketResponseGetWebsocketIDV1MPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return WebsocketResponseGetWebsocketIDV1MPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = WebsocketResponseGetWebsocketIDV1MPayload.parse_obj({ - "s_websocket_id": obj.get("sWebsocketID") + _obj = cls.model_validate({ + "sWebsocketID": obj.get("sWebsocketID") }) return _obj diff --git a/eZmaxApi/models/websocket_response_information_v1.py b/eZmaxApi/models/websocket_response_information_v1.py index 17d1a61ae..119b52571 100644 --- a/eZmaxApi/models/websocket_response_information_v1.py +++ b/eZmaxApi/models/websocket_response_information_v1.py @@ -19,66 +19,94 @@ import json - -from pydantic import BaseModel, Field, StrictStr, validator +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictStr, field_validator +from pydantic import Field +from typing_extensions import Annotated from eZmaxApi.models.websocket_response_information_v1_m_payload import WebsocketResponseInformationV1MPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self class WebsocketResponseInformationV1(BaseModel): """ - Response for Websocket Information V1 # noqa: E501 - """ - e_websocket_messagetype: StrictStr = Field(..., alias="eWebsocketMessagetype", description="The Type of message") - m_payload: WebsocketResponseInformationV1MPayload = Field(..., alias="mPayload") - __properties = ["eWebsocketMessagetype", "mPayload"] - - @validator('e_websocket_messagetype') + Response for Websocket Information V1 + """ # noqa: E501 + e_websocket_messagetype: StrictStr = Field(description="The Type of message", alias="eWebsocketMessagetype") + s_websocket_channel: Annotated[str, Field(strict=True)] = Field(description="The Channel on which to route the websocket message", alias="sWebsocketChannel") + m_payload: WebsocketResponseInformationV1MPayload = Field(alias="mPayload") + __properties: ClassVar[List[str]] = ["eWebsocketMessagetype", "sWebsocketChannel", "mPayload"] + + @field_validator('e_websocket_messagetype') def e_websocket_messagetype_validate_enum(cls, value): """Validates the enum""" if value not in ('Response-Information-V1'): raise ValueError("must be one of enum values ('Response-Information-V1')") return value - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True + @field_validator('s_websocket_channel') + def s_websocket_channel_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^[a-zA-Z0-9_@.]{32}$", value): + raise ValueError(r"must validate the regular expression /^[a-zA-Z0-9_@.]{32}$/") + return value + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> WebsocketResponseInformationV1: + def from_json(cls, json_str: str) -> Self: """Create an instance of WebsocketResponseInformationV1 from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) # override the default output from pydantic by calling `to_dict()` of m_payload if self.m_payload: _dict['mPayload'] = self.m_payload.to_dict() return _dict @classmethod - def from_dict(cls, obj: dict) -> WebsocketResponseInformationV1: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of WebsocketResponseInformationV1 from a dict""" if obj is None: return None if not isinstance(obj, dict): - return WebsocketResponseInformationV1.parse_obj(obj) + return cls.model_validate(obj) - _obj = WebsocketResponseInformationV1.parse_obj({ - "e_websocket_messagetype": obj.get("eWebsocketMessagetype"), - "m_payload": WebsocketResponseInformationV1MPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + _obj = cls.model_validate({ + "eWebsocketMessagetype": obj.get("eWebsocketMessagetype"), + "sWebsocketChannel": obj.get("sWebsocketChannel"), + "mPayload": WebsocketResponseInformationV1MPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None }) return _obj diff --git a/eZmaxApi/models/websocket_response_information_v1_m_payload.py b/eZmaxApi/models/websocket_response_information_v1_m_payload.py index af86bb1ea..73b291c96 100644 --- a/eZmaxApi/models/websocket_response_information_v1_m_payload.py +++ b/eZmaxApi/models/websocket_response_information_v1_m_payload.py @@ -19,53 +19,71 @@ import json - -from pydantic import BaseModel, Field, StrictStr +from typing import Any, ClassVar, Dict, List +from pydantic import BaseModel, StrictStr +from pydantic import Field +try: + from typing import Self +except ImportError: + from typing_extensions import Self class WebsocketResponseInformationV1MPayload(BaseModel): """ - Payload for Websocket Information V1 # noqa: E501 - """ - s_information_message: StrictStr = Field(..., alias="sInformationMessage", description="Information message") - __properties = ["sInformationMessage"] + Payload for Websocket Information V1 + """ # noqa: E501 + s_information_message: StrictStr = Field(description="Information message", alias="sInformationMessage") + __properties: ClassVar[List[str]] = ["sInformationMessage"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } - class Config: - """Pydantic configuration""" - allow_population_by_field_name = True - validate_assignment = True def to_str(self) -> str: """Returns the string representation of the model using alias""" - return pprint.pformat(self.dict(by_alias=True)) + return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod - def from_json(cls, json_str: str) -> WebsocketResponseInformationV1MPayload: + def from_json(cls, json_str: str) -> Self: """Create an instance of WebsocketResponseInformationV1MPayload from a JSON string""" return cls.from_dict(json.loads(json_str)) - def to_dict(self): - """Returns the dictionary representation of the model using alias""" - _dict = self.dict(by_alias=True, - exclude={ - }, - exclude_none=True) + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + _dict = self.model_dump( + by_alias=True, + exclude={ + }, + exclude_none=True, + ) return _dict @classmethod - def from_dict(cls, obj: dict) -> WebsocketResponseInformationV1MPayload: + def from_dict(cls, obj: Dict) -> Self: """Create an instance of WebsocketResponseInformationV1MPayload from a dict""" if obj is None: return None if not isinstance(obj, dict): - return WebsocketResponseInformationV1MPayload.parse_obj(obj) + return cls.model_validate(obj) - _obj = WebsocketResponseInformationV1MPayload.parse_obj({ - "s_information_message": obj.get("sInformationMessage") + _obj = cls.model_validate({ + "sInformationMessage": obj.get("sInformationMessage") }) return _obj diff --git a/eZmaxApi/rest.py b/eZmaxApi/rest.py index 8a970cbb5..b2e0839fb 100644 --- a/eZmaxApi/rest.py +++ b/eZmaxApi/rest.py @@ -15,43 +15,55 @@ import io import json -import logging import re import ssl -from urllib.parse import urlencode, quote_plus import urllib3 -from eZmaxApi.exceptions import ApiException, UnauthorizedException, ForbiddenException, NotFoundException, ServiceException, ApiValueError, BadRequestException +from eZmaxApi.exceptions import ApiException, ApiValueError +SUPPORTED_SOCKS_PROXIES = {"socks5", "socks5h", "socks4", "socks4a"} +RESTResponseType = urllib3.HTTPResponse -logger = logging.getLogger(__name__) + +def is_socks_proxy_url(url): + if url is None: + return False + split_section = url.split("://") + if len(split_section) < 2: + return False + else: + return split_section[0].lower() in SUPPORTED_SOCKS_PROXIES class RESTResponse(io.IOBase): def __init__(self, resp) -> None: - self.urllib3_response = resp + self.response = resp self.status = resp.status self.reason = resp.reason - self.data = resp.data + self.data = None + + def read(self): + if self.data is None: + self.data = self.response.data + return self.data def getheaders(self): """Returns a dictionary of the response headers.""" - return self.urllib3_response.headers + return self.response.headers def getheader(self, name, default=None): """Returns a given response header.""" - return self.urllib3_response.headers.get(name, default) + return self.response.headers.get(name, default) class RESTClientObject: - def __init__(self, configuration, pools_size=4, maxsize=None) -> None: + def __init__(self, configuration) -> None: # urllib3.PoolManager will pass all kw parameters to connectionpool # https://github.com/shazow/urllib3/blob/f9409436f83aeb79fbaf090181cd81b784f1b8ce/urllib3/poolmanager.py#L75 # noqa: E501 # https://github.com/shazow/urllib3/blob/f9409436f83aeb79fbaf090181cd81b784f1b8ce/urllib3/connectionpool.py#L680 # noqa: E501 - # maxsize is the number of requests to host that are allowed in parallel # noqa: E501 # Custom SSL certificates and client certificates: http://urllib3.readthedocs.io/en/latest/advanced-usage.html # noqa: E501 # cert_reqs @@ -62,7 +74,9 @@ def __init__(self, configuration, pools_size=4, maxsize=None) -> None: addition_pool_args = {} if configuration.assert_hostname is not None: - addition_pool_args['assert_hostname'] = configuration.assert_hostname # noqa: E501 + addition_pool_args['assert_hostname'] = ( + configuration.assert_hostname + ) if configuration.retries is not None: addition_pool_args['retries'] = configuration.retries @@ -74,29 +88,34 @@ def __init__(self, configuration, pools_size=4, maxsize=None) -> None: if configuration.socket_options is not None: addition_pool_args['socket_options'] = configuration.socket_options - if maxsize is None: - if configuration.connection_pool_maxsize is not None: - maxsize = configuration.connection_pool_maxsize - else: - maxsize = 4 + if configuration.connection_pool_maxsize is not None: + addition_pool_args['maxsize'] = configuration.connection_pool_maxsize # https pool manager if configuration.proxy: - self.pool_manager = urllib3.ProxyManager( - num_pools=pools_size, - maxsize=maxsize, - cert_reqs=cert_reqs, - ca_certs=configuration.ssl_ca_cert, - cert_file=configuration.cert_file, - key_file=configuration.key_file, - proxy_url=configuration.proxy, - proxy_headers=configuration.proxy_headers, - **addition_pool_args - ) + if is_socks_proxy_url(configuration.proxy): + from urllib3.contrib.socks import SOCKSProxyManager + self.pool_manager = SOCKSProxyManager( + cert_reqs=cert_reqs, + ca_certs=configuration.ssl_ca_cert, + cert_file=configuration.cert_file, + key_file=configuration.key_file, + proxy_url=configuration.proxy, + headers=configuration.proxy_headers, + **addition_pool_args + ) + else: + self.pool_manager = urllib3.ProxyManager( + cert_reqs=cert_reqs, + ca_certs=configuration.ssl_ca_cert, + cert_file=configuration.cert_file, + key_file=configuration.key_file, + proxy_url=configuration.proxy, + proxy_headers=configuration.proxy_headers, + **addition_pool_args + ) else: self.pool_manager = urllib3.PoolManager( - num_pools=pools_size, - maxsize=maxsize, cert_reqs=cert_reqs, ca_certs=configuration.ssl_ca_cert, cert_file=configuration.cert_file, @@ -104,30 +123,39 @@ def __init__(self, configuration, pools_size=4, maxsize=None) -> None: **addition_pool_args ) - def request(self, method, url, query_params=None, headers=None, - body=None, post_params=None, _preload_content=True, - _request_timeout=None): + def request( + self, + method, + url, + headers=None, + body=None, + post_params=None, + _request_timeout=None + ): """Perform requests. :param method: http request method :param url: http request url - :param query_params: query parameters in the url :param headers: http request headers :param body: request json body, for `application/json` :param post_params: request post parameters, `application/x-www-form-urlencoded` and `multipart/form-data` - :param _preload_content: if False, the urllib3.HTTPResponse object will - be returned without reading/decoding response - data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. """ method = method.upper() - assert method in ['GET', 'HEAD', 'DELETE', 'POST', 'PUT', - 'PATCH', 'OPTIONS'] + assert method in [ + 'GET', + 'HEAD', + 'DELETE', + 'POST', + 'PUT', + 'PATCH', + 'OPTIONS' + ] if post_params and body: raise ApiValueError( @@ -136,63 +164,85 @@ def request(self, method, url, query_params=None, headers=None, post_params = post_params or {} headers = headers or {} - # url already contains the URL query string - # so reset query_params to empty dict - query_params = {} timeout = None if _request_timeout: - if isinstance(_request_timeout, (int,float)): # noqa: E501,F821 + if isinstance(_request_timeout, (int, float)): timeout = urllib3.Timeout(total=_request_timeout) - elif (isinstance(_request_timeout, tuple) and - len(_request_timeout) == 2): + elif ( + isinstance(_request_timeout, tuple) + and len(_request_timeout) == 2 + ): timeout = urllib3.Timeout( - connect=_request_timeout[0], read=_request_timeout[1]) + connect=_request_timeout[0], + read=_request_timeout[1] + ) try: # For `POST`, `PUT`, `PATCH`, `OPTIONS`, `DELETE` if method in ['POST', 'PUT', 'PATCH', 'OPTIONS', 'DELETE']: # no content type provided or payload is json - if not headers.get('Content-Type') or re.search('json', headers['Content-Type'], re.IGNORECASE): + content_type = headers.get('Content-Type') + if ( + not content_type + or re.search('json', content_type, re.IGNORECASE) + ): request_body = None if body is not None: request_body = json.dumps(body) r = self.pool_manager.request( - method, url, + method, + url, body=request_body, - preload_content=_preload_content, timeout=timeout, - headers=headers) - elif headers['Content-Type'] == 'application/x-www-form-urlencoded': # noqa: E501 + headers=headers, + preload_content=False + ) + elif content_type == 'application/x-www-form-urlencoded': r = self.pool_manager.request( - method, url, + method, + url, fields=post_params, encode_multipart=False, - preload_content=_preload_content, timeout=timeout, - headers=headers) - elif headers['Content-Type'] == 'multipart/form-data': + headers=headers, + preload_content=False + ) + elif content_type == 'multipart/form-data': # must del headers['Content-Type'], or the correct # Content-Type which generated by urllib3 will be # overwritten. del headers['Content-Type'] r = self.pool_manager.request( - method, url, + method, + url, fields=post_params, encode_multipart=True, - preload_content=_preload_content, timeout=timeout, - headers=headers) + headers=headers, + preload_content=False + ) # Pass a `string` parameter directly in the body to support # other content types than Json when `body` argument is # provided in serialized form elif isinstance(body, str) or isinstance(body, bytes): request_body = body r = self.pool_manager.request( - method, url, + method, + url, + body=request_body, + timeout=timeout, + headers=headers, + preload_content=False + ) + elif headers['Content-Type'] == 'text/plain' and isinstance(body, bool): + request_body = "true" if body else "false" + r = self.pool_manager.request( + method, + url, body=request_body, - preload_content=_preload_content, + preload_content=False, timeout=timeout, headers=headers) else: @@ -203,102 +253,16 @@ def request(self, method, url, query_params=None, headers=None, raise ApiException(status=0, reason=msg) # For `GET`, `HEAD` else: - r = self.pool_manager.request(method, url, - fields={}, - preload_content=_preload_content, - timeout=timeout, - headers=headers) + r = self.pool_manager.request( + method, + url, + fields={}, + timeout=timeout, + headers=headers, + preload_content=False + ) except urllib3.exceptions.SSLError as e: - msg = "{0}\n{1}".format(type(e).__name__, str(e)) + msg = "\n".join([type(e).__name__, str(e)]) raise ApiException(status=0, reason=msg) - if _preload_content: - r = RESTResponse(r) - - # log response body - logger.debug("response body: %s", r.data) - - if not 200 <= r.status <= 299: - if r.status == 400: - raise BadRequestException(http_resp=r) - - if r.status == 401: - raise UnauthorizedException(http_resp=r) - - if r.status == 403: - raise ForbiddenException(http_resp=r) - - if r.status == 404: - raise NotFoundException(http_resp=r) - - if 500 <= r.status <= 599: - raise ServiceException(http_resp=r) - - raise ApiException(http_resp=r) - - return r - - def get_request(self, url, headers=None, query_params=None, _preload_content=True, - _request_timeout=None): - return self.request("GET", url, - headers=headers, - _preload_content=_preload_content, - _request_timeout=_request_timeout, - query_params=query_params) - - def head_request(self, url, headers=None, query_params=None, _preload_content=True, - _request_timeout=None): - return self.request("HEAD", url, - headers=headers, - _preload_content=_preload_content, - _request_timeout=_request_timeout, - query_params=query_params) - - def options_request(self, url, headers=None, query_params=None, post_params=None, - body=None, _preload_content=True, _request_timeout=None): - return self.request("OPTIONS", url, - headers=headers, - query_params=query_params, - post_params=post_params, - _preload_content=_preload_content, - _request_timeout=_request_timeout, - body=body) - - def delete_request(self, url, headers=None, query_params=None, body=None, - _preload_content=True, _request_timeout=None): - return self.request("DELETE", url, - headers=headers, - query_params=query_params, - _preload_content=_preload_content, - _request_timeout=_request_timeout, - body=body) - - def post_request(self, url, headers=None, query_params=None, post_params=None, - body=None, _preload_content=True, _request_timeout=None): - return self.request("POST", url, - headers=headers, - query_params=query_params, - post_params=post_params, - _preload_content=_preload_content, - _request_timeout=_request_timeout, - body=body) - - def put_request(self, url, headers=None, query_params=None, post_params=None, - body=None, _preload_content=True, _request_timeout=None): - return self.request("PUT", url, - headers=headers, - query_params=query_params, - post_params=post_params, - _preload_content=_preload_content, - _request_timeout=_request_timeout, - body=body) - - def patch_request(self, url, headers=None, query_params=None, post_params=None, - body=None, _preload_content=True, _request_timeout=None): - return self.request("PATCH", url, - headers=headers, - query_params=query_params, - post_params=post_params, - _preload_content=_preload_content, - _request_timeout=_request_timeout, - body=body) + return RESTResponse(r) diff --git a/openapitools.json b/openapitools.json index 4053ae890..e73b97583 100644 --- a/openapitools.json +++ b/openapitools.json @@ -2,6 +2,6 @@ "$schema": "./node_modules/@openapitools/openapi-generator-cli/config.schema.json", "spaces": 2, "generator-cli": { - "version": "7.0.1" + "version": "7.2.0" } } diff --git a/pyproject.toml b/pyproject.toml index a095ed0af..9317ae368 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -14,8 +14,8 @@ python = "^3.7" urllib3 = ">= 1.25.3" python-dateutil = ">=2.8.2" -pydantic = "^1.10.5, <2" -aenum = ">=3.1.11" +pydantic = ">=2" +typing-extensions = ">=4.7.1" [tool.poetry.dev-dependencies] pytest = ">=7.2.1" diff --git a/requirements.txt b/requirements.txt index 258c179c1..cc85509ec 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,5 +1,5 @@ python_dateutil >= 2.5.3 setuptools >= 21.0.0 urllib3 >= 1.25.3, < 2.1.0 -pydantic >= 1.10.5, < 2 -aenum >= 3.1.11 +pydantic >= 2 +typing-extensions >= 4.7.1 diff --git a/setup.py b/setup.py index bf2c028ba..eb782127e 100644 --- a/setup.py +++ b/setup.py @@ -27,8 +27,8 @@ REQUIRES = [ "urllib3 >= 1.25.3, < 2.1.0", "python-dateutil", - "pydantic >= 1.10.5, < 2", - "aenum" + "pydantic >= 2", + "typing-extensions >= 4.7.1", ] setup( diff --git a/test/test_activesession_get_current_v1_response.py b/test/test_activesession_get_current_v1_response.py index e9b7aa392..b95014ec8 100644 --- a/test/test_activesession_get_current_v1_response.py +++ b/test/test_activesession_get_current_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.activesession_get_current_v1_response import ActivesessionGetCurrentV1Response # noqa: E501 +from eZmaxApi.models.activesession_get_current_v1_response import ActivesessionGetCurrentV1Response class TestActivesessionGetCurrentV1Response(unittest.TestCase): """ActivesessionGetCurrentV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> ActivesessionGetCurrentV1Response: optional params are included """ # uncomment below to create an instance of `ActivesessionGetCurrentV1Response` """ - model = ActivesessionGetCurrentV1Response() # noqa: E501 + model = ActivesessionGetCurrentV1Response() if include_optional: return ActivesessionGetCurrentV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_activesession_get_current_v1_response_m_payload.py b/test/test_activesession_get_current_v1_response_m_payload.py index a6b58ddff..86200a598 100644 --- a/test/test_activesession_get_current_v1_response_m_payload.py +++ b/test/test_activesession_get_current_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.activesession_get_current_v1_response_m_payload import ActivesessionGetCurrentV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.activesession_get_current_v1_response_m_payload import ActivesessionGetCurrentV1ResponseMPayload class TestActivesessionGetCurrentV1ResponseMPayload(unittest.TestCase): """ActivesessionGetCurrentV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> ActivesessionGetCurrentV1ResponseMP optional params are included """ # uncomment below to create an instance of `ActivesessionGetCurrentV1ResponseMPayload` """ - model = ActivesessionGetCurrentV1ResponseMPayload() # noqa: E501 + model = ActivesessionGetCurrentV1ResponseMPayload() if include_optional: return ActivesessionGetCurrentV1ResponseMPayload( e_activesession_usertype = 'Normal', @@ -48,6 +48,9 @@ def make_instance(self, include_optional) -> ActivesessionGetCurrentV1ResponseMP pks_customer_code = 'demo', fki_systemconfigurationtype_id = 28, fki_signature_id = 12, + e_user_ezsignaccess = 'PaidByOffice', + e_user_ezsignprepaid = 'Basic', + dt_user_ezsignprepaidexpiration = '2020-12-31', a_pki_permission_id = [ 53 ], @@ -92,6 +95,7 @@ def make_instance(self, include_optional) -> ActivesessionGetCurrentV1ResponseMP b_activesession_issuperadmin = False, pks_customer_code = 'demo', fki_systemconfigurationtype_id = 28, + e_user_ezsignaccess = 'PaidByOffice', a_pki_permission_id = [ 53 ], diff --git a/test/test_activesession_get_list_v1_response.py b/test/test_activesession_get_list_v1_response.py index d46cf312e..9e7602851 100644 --- a/test/test_activesession_get_list_v1_response.py +++ b/test/test_activesession_get_list_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.activesession_get_list_v1_response import ActivesessionGetListV1Response # noqa: E501 +from eZmaxApi.models.activesession_get_list_v1_response import ActivesessionGetListV1Response class TestActivesessionGetListV1Response(unittest.TestCase): """ActivesessionGetListV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> ActivesessionGetListV1Response: optional params are included """ # uncomment below to create an instance of `ActivesessionGetListV1Response` """ - model = ActivesessionGetListV1Response() # noqa: E501 + model = ActivesessionGetListV1Response() if include_optional: return ActivesessionGetListV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload_get_list.Common-Response-objDebugPayload_getList(), diff --git a/test/test_activesession_get_list_v1_response_m_payload.py b/test/test_activesession_get_list_v1_response_m_payload.py index 7804ca637..25a79845f 100644 --- a/test/test_activesession_get_list_v1_response_m_payload.py +++ b/test/test_activesession_get_list_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.activesession_get_list_v1_response_m_payload import ActivesessionGetListV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.activesession_get_list_v1_response_m_payload import ActivesessionGetListV1ResponseMPayload class TestActivesessionGetListV1ResponseMPayload(unittest.TestCase): """ActivesessionGetListV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> ActivesessionGetListV1ResponseMPayl optional params are included """ # uncomment below to create an instance of `ActivesessionGetListV1ResponseMPayload` """ - model = ActivesessionGetListV1ResponseMPayload() # noqa: E501 + model = ActivesessionGetListV1ResponseMPayload() if include_optional: return ActivesessionGetListV1ResponseMPayload( i_row_returned = 100, diff --git a/test/test_activesession_list_element.py b/test/test_activesession_list_element.py index c33b5f745..6262c3090 100644 --- a/test/test_activesession_list_element.py +++ b/test/test_activesession_list_element.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.activesession_list_element import ActivesessionListElement # noqa: E501 +from eZmaxApi.models.activesession_list_element import ActivesessionListElement class TestActivesessionListElement(unittest.TestCase): """ActivesessionListElement unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> ActivesessionListElement: optional params are included """ # uncomment below to create an instance of `ActivesessionListElement` """ - model = ActivesessionListElement() # noqa: E501 + model = ActivesessionListElement() if include_optional: return ActivesessionListElement( pki_activesession_id = 16, diff --git a/test/test_activesession_response.py b/test/test_activesession_response.py index a25eee3da..cf815967d 100644 --- a/test/test_activesession_response.py +++ b/test/test_activesession_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.activesession_response import ActivesessionResponse # noqa: E501 +from eZmaxApi.models.activesession_response import ActivesessionResponse class TestActivesessionResponse(unittest.TestCase): """ActivesessionResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> ActivesessionResponse: optional params are included """ # uncomment below to create an instance of `ActivesessionResponse` """ - model = ActivesessionResponse() # noqa: E501 + model = ActivesessionResponse() if include_optional: return ActivesessionResponse( e_activesession_usertype = 'Normal', diff --git a/test/test_activesession_response_compound.py b/test/test_activesession_response_compound.py index b20c5cba4..ce37b68b3 100644 --- a/test/test_activesession_response_compound.py +++ b/test/test_activesession_response_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.activesession_response_compound import ActivesessionResponseCompound # noqa: E501 +from eZmaxApi.models.activesession_response_compound import ActivesessionResponseCompound class TestActivesessionResponseCompound(unittest.TestCase): """ActivesessionResponseCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> ActivesessionResponseCompound: optional params are included """ # uncomment below to create an instance of `ActivesessionResponseCompound` """ - model = ActivesessionResponseCompound() # noqa: E501 + model = ActivesessionResponseCompound() if include_optional: return ActivesessionResponseCompound( e_activesession_usertype = 'Normal', @@ -48,6 +48,9 @@ def make_instance(self, include_optional) -> ActivesessionResponseCompound: pks_customer_code = 'demo', fki_systemconfigurationtype_id = 28, fki_signature_id = 12, + e_user_ezsignaccess = 'PaidByOffice', + e_user_ezsignprepaid = 'Basic', + dt_user_ezsignprepaidexpiration = '2020-12-31', a_pki_permission_id = [ 53 ], @@ -92,6 +95,7 @@ def make_instance(self, include_optional) -> ActivesessionResponseCompound: b_activesession_issuperadmin = False, pks_customer_code = 'demo', fki_systemconfigurationtype_id = 28, + e_user_ezsignaccess = 'PaidByOffice', a_pki_permission_id = [ 53 ], diff --git a/test/test_activesession_response_compound_apikey.py b/test/test_activesession_response_compound_apikey.py index 47fc2d277..58302cbfc 100644 --- a/test/test_activesession_response_compound_apikey.py +++ b/test/test_activesession_response_compound_apikey.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.activesession_response_compound_apikey import ActivesessionResponseCompoundApikey # noqa: E501 +from eZmaxApi.models.activesession_response_compound_apikey import ActivesessionResponseCompoundApikey class TestActivesessionResponseCompoundApikey(unittest.TestCase): """ActivesessionResponseCompoundApikey unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> ActivesessionResponseCompoundApikey optional params are included """ # uncomment below to create an instance of `ActivesessionResponseCompoundApikey` """ - model = ActivesessionResponseCompoundApikey() # noqa: E501 + model = ActivesessionResponseCompoundApikey() if include_optional: return ActivesessionResponseCompoundApikey( pki_apikey_id = 99, diff --git a/test/test_activesession_response_compound_user.py b/test/test_activesession_response_compound_user.py index c3f2823c4..a19ca6c61 100644 --- a/test/test_activesession_response_compound_user.py +++ b/test/test_activesession_response_compound_user.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.activesession_response_compound_user import ActivesessionResponseCompoundUser # noqa: E501 +from eZmaxApi.models.activesession_response_compound_user import ActivesessionResponseCompoundUser class TestActivesessionResponseCompoundUser(unittest.TestCase): """ActivesessionResponseCompoundUser unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> ActivesessionResponseCompoundUser: optional params are included """ # uncomment below to create an instance of `ActivesessionResponseCompoundUser` """ - model = ActivesessionResponseCompoundUser() # noqa: E501 + model = ActivesessionResponseCompoundUser() if include_optional: return ActivesessionResponseCompoundUser( pki_user_id = 70, diff --git a/test/test_address_request.py b/test/test_address_request.py index c52307aa5..42612aa46 100644 --- a/test/test_address_request.py +++ b/test/test_address_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.address_request import AddressRequest # noqa: E501 +from eZmaxApi.models.address_request import AddressRequest class TestAddressRequest(unittest.TestCase): """AddressRequest unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> AddressRequest: optional params are included """ # uncomment below to create an instance of `AddressRequest` """ - model = AddressRequest() # noqa: E501 + model = AddressRequest() if include_optional: return AddressRequest( fki_addresstype_id = 1, diff --git a/test/test_address_request_compound.py b/test/test_address_request_compound.py index 2cc000d0f..c9d631f72 100644 --- a/test/test_address_request_compound.py +++ b/test/test_address_request_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.address_request_compound import AddressRequestCompound # noqa: E501 +from eZmaxApi.models.address_request_compound import AddressRequestCompound class TestAddressRequestCompound(unittest.TestCase): """AddressRequestCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> AddressRequestCompound: optional params are included """ # uncomment below to create an instance of `AddressRequestCompound` """ - model = AddressRequestCompound() # noqa: E501 + model = AddressRequestCompound() if include_optional: return AddressRequestCompound( fki_addresstype_id = 1, diff --git a/test/test_apikey_create_object_v2_request.py b/test/test_apikey_create_object_v2_request.py index adf80bb40..10eff1c88 100644 --- a/test/test_apikey_create_object_v2_request.py +++ b/test/test_apikey_create_object_v2_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.apikey_create_object_v2_request import ApikeyCreateObjectV2Request # noqa: E501 +from eZmaxApi.models.apikey_create_object_v2_request import ApikeyCreateObjectV2Request class TestApikeyCreateObjectV2Request(unittest.TestCase): """ApikeyCreateObjectV2Request unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> ApikeyCreateObjectV2Request: optional params are included """ # uncomment below to create an instance of `ApikeyCreateObjectV2Request` """ - model = ApikeyCreateObjectV2Request() # noqa: E501 + model = ApikeyCreateObjectV2Request() if include_optional: return ApikeyCreateObjectV2Request( a_obj_apikey = [ diff --git a/test/test_apikey_create_object_v2_response.py b/test/test_apikey_create_object_v2_response.py index 237e8e6b5..a1a4b95e7 100644 --- a/test/test_apikey_create_object_v2_response.py +++ b/test/test_apikey_create_object_v2_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.apikey_create_object_v2_response import ApikeyCreateObjectV2Response # noqa: E501 +from eZmaxApi.models.apikey_create_object_v2_response import ApikeyCreateObjectV2Response class TestApikeyCreateObjectV2Response(unittest.TestCase): """ApikeyCreateObjectV2Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> ApikeyCreateObjectV2Response: optional params are included """ # uncomment below to create an instance of `ApikeyCreateObjectV2Response` """ - model = ApikeyCreateObjectV2Response() # noqa: E501 + model = ApikeyCreateObjectV2Response() if include_optional: return ApikeyCreateObjectV2Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_apikey_create_object_v2_response_m_payload.py b/test/test_apikey_create_object_v2_response_m_payload.py index 38819197e..75aa7c6c7 100644 --- a/test/test_apikey_create_object_v2_response_m_payload.py +++ b/test/test_apikey_create_object_v2_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.apikey_create_object_v2_response_m_payload import ApikeyCreateObjectV2ResponseMPayload # noqa: E501 +from eZmaxApi.models.apikey_create_object_v2_response_m_payload import ApikeyCreateObjectV2ResponseMPayload class TestApikeyCreateObjectV2ResponseMPayload(unittest.TestCase): """ApikeyCreateObjectV2ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> ApikeyCreateObjectV2ResponseMPayloa optional params are included """ # uncomment below to create an instance of `ApikeyCreateObjectV2ResponseMPayload` """ - model = ApikeyCreateObjectV2ResponseMPayload() # noqa: E501 + model = ApikeyCreateObjectV2ResponseMPayload() if include_optional: return ApikeyCreateObjectV2ResponseMPayload( a_obj_apikey = [ diff --git a/test/test_apikey_edit_object_v1_request.py b/test/test_apikey_edit_object_v1_request.py index c422c3eba..2456b13a1 100644 --- a/test/test_apikey_edit_object_v1_request.py +++ b/test/test_apikey_edit_object_v1_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.apikey_edit_object_v1_request import ApikeyEditObjectV1Request # noqa: E501 +from eZmaxApi.models.apikey_edit_object_v1_request import ApikeyEditObjectV1Request class TestApikeyEditObjectV1Request(unittest.TestCase): """ApikeyEditObjectV1Request unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> ApikeyEditObjectV1Request: optional params are included """ # uncomment below to create an instance of `ApikeyEditObjectV1Request` """ - model = ApikeyEditObjectV1Request() # noqa: E501 + model = ApikeyEditObjectV1Request() if include_optional: return ApikeyEditObjectV1Request( obj_apikey = eZmaxApi.models.apikey_request_compound.apikey-RequestCompound() diff --git a/test/test_apikey_edit_object_v1_response.py b/test/test_apikey_edit_object_v1_response.py index f1934bb40..de3ade34c 100644 --- a/test/test_apikey_edit_object_v1_response.py +++ b/test/test_apikey_edit_object_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.apikey_edit_object_v1_response import ApikeyEditObjectV1Response # noqa: E501 +from eZmaxApi.models.apikey_edit_object_v1_response import ApikeyEditObjectV1Response class TestApikeyEditObjectV1Response(unittest.TestCase): """ApikeyEditObjectV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> ApikeyEditObjectV1Response: optional params are included """ # uncomment below to create an instance of `ApikeyEditObjectV1Response` """ - model = ApikeyEditObjectV1Response() # noqa: E501 + model = ApikeyEditObjectV1Response() if include_optional: return ApikeyEditObjectV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_apikey_edit_permissions_v1_request.py b/test/test_apikey_edit_permissions_v1_request.py index 12b49eba9..ac595fffd 100644 --- a/test/test_apikey_edit_permissions_v1_request.py +++ b/test/test_apikey_edit_permissions_v1_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.apikey_edit_permissions_v1_request import ApikeyEditPermissionsV1Request # noqa: E501 +from eZmaxApi.models.apikey_edit_permissions_v1_request import ApikeyEditPermissionsV1Request class TestApikeyEditPermissionsV1Request(unittest.TestCase): """ApikeyEditPermissionsV1Request unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> ApikeyEditPermissionsV1Request: optional params are included """ # uncomment below to create an instance of `ApikeyEditPermissionsV1Request` """ - model = ApikeyEditPermissionsV1Request() # noqa: E501 + model = ApikeyEditPermissionsV1Request() if include_optional: return ApikeyEditPermissionsV1Request( a_obj_permission = [ diff --git a/test/test_apikey_edit_permissions_v1_response.py b/test/test_apikey_edit_permissions_v1_response.py index 2e978a3cf..5a4c81315 100644 --- a/test/test_apikey_edit_permissions_v1_response.py +++ b/test/test_apikey_edit_permissions_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.apikey_edit_permissions_v1_response import ApikeyEditPermissionsV1Response # noqa: E501 +from eZmaxApi.models.apikey_edit_permissions_v1_response import ApikeyEditPermissionsV1Response class TestApikeyEditPermissionsV1Response(unittest.TestCase): """ApikeyEditPermissionsV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> ApikeyEditPermissionsV1Response: optional params are included """ # uncomment below to create an instance of `ApikeyEditPermissionsV1Response` """ - model = ApikeyEditPermissionsV1Response() # noqa: E501 + model = ApikeyEditPermissionsV1Response() if include_optional: return ApikeyEditPermissionsV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_apikey_edit_permissions_v1_response_m_payload.py b/test/test_apikey_edit_permissions_v1_response_m_payload.py index 371691e95..b518d984a 100644 --- a/test/test_apikey_edit_permissions_v1_response_m_payload.py +++ b/test/test_apikey_edit_permissions_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.apikey_edit_permissions_v1_response_m_payload import ApikeyEditPermissionsV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.apikey_edit_permissions_v1_response_m_payload import ApikeyEditPermissionsV1ResponseMPayload class TestApikeyEditPermissionsV1ResponseMPayload(unittest.TestCase): """ApikeyEditPermissionsV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> ApikeyEditPermissionsV1ResponseMPay optional params are included """ # uncomment below to create an instance of `ApikeyEditPermissionsV1ResponseMPayload` """ - model = ApikeyEditPermissionsV1ResponseMPayload() # noqa: E501 + model = ApikeyEditPermissionsV1ResponseMPayload() if include_optional: return ApikeyEditPermissionsV1ResponseMPayload( a_pki_permission_id = [ diff --git a/test/test_apikey_get_cors_v1_response.py b/test/test_apikey_get_cors_v1_response.py index b5d2ad3e9..5436b8c17 100644 --- a/test/test_apikey_get_cors_v1_response.py +++ b/test/test_apikey_get_cors_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.apikey_get_cors_v1_response import ApikeyGetCorsV1Response # noqa: E501 +from eZmaxApi.models.apikey_get_cors_v1_response import ApikeyGetCorsV1Response class TestApikeyGetCorsV1Response(unittest.TestCase): """ApikeyGetCorsV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> ApikeyGetCorsV1Response: optional params are included """ # uncomment below to create an instance of `ApikeyGetCorsV1Response` """ - model = ApikeyGetCorsV1Response() # noqa: E501 + model = ApikeyGetCorsV1Response() if include_optional: return ApikeyGetCorsV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_apikey_get_cors_v1_response_m_payload.py b/test/test_apikey_get_cors_v1_response_m_payload.py index 2911c17a0..d1260673e 100644 --- a/test/test_apikey_get_cors_v1_response_m_payload.py +++ b/test/test_apikey_get_cors_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.apikey_get_cors_v1_response_m_payload import ApikeyGetCorsV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.apikey_get_cors_v1_response_m_payload import ApikeyGetCorsV1ResponseMPayload class TestApikeyGetCorsV1ResponseMPayload(unittest.TestCase): """ApikeyGetCorsV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> ApikeyGetCorsV1ResponseMPayload: optional params are included """ # uncomment below to create an instance of `ApikeyGetCorsV1ResponseMPayload` """ - model = ApikeyGetCorsV1ResponseMPayload() # noqa: E501 + model = ApikeyGetCorsV1ResponseMPayload() if include_optional: return ApikeyGetCorsV1ResponseMPayload( a_obj_cors = [ diff --git a/test/test_apikey_get_list_v1_response.py b/test/test_apikey_get_list_v1_response.py index 1f7b8ecf2..ce94db3b0 100644 --- a/test/test_apikey_get_list_v1_response.py +++ b/test/test_apikey_get_list_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.apikey_get_list_v1_response import ApikeyGetListV1Response # noqa: E501 +from eZmaxApi.models.apikey_get_list_v1_response import ApikeyGetListV1Response class TestApikeyGetListV1Response(unittest.TestCase): """ApikeyGetListV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> ApikeyGetListV1Response: optional params are included """ # uncomment below to create an instance of `ApikeyGetListV1Response` """ - model = ApikeyGetListV1Response() # noqa: E501 + model = ApikeyGetListV1Response() if include_optional: return ApikeyGetListV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload_get_list.Common-Response-objDebugPayload_getList(), diff --git a/test/test_apikey_get_list_v1_response_m_payload.py b/test/test_apikey_get_list_v1_response_m_payload.py index 1ac7d6ca7..5597bd0e9 100644 --- a/test/test_apikey_get_list_v1_response_m_payload.py +++ b/test/test_apikey_get_list_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.apikey_get_list_v1_response_m_payload import ApikeyGetListV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.apikey_get_list_v1_response_m_payload import ApikeyGetListV1ResponseMPayload class TestApikeyGetListV1ResponseMPayload(unittest.TestCase): """ApikeyGetListV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> ApikeyGetListV1ResponseMPayload: optional params are included """ # uncomment below to create an instance of `ApikeyGetListV1ResponseMPayload` """ - model = ApikeyGetListV1ResponseMPayload() # noqa: E501 + model = ApikeyGetListV1ResponseMPayload() if include_optional: return ApikeyGetListV1ResponseMPayload( i_row_returned = 100, diff --git a/test/test_apikey_get_object_v2_response.py b/test/test_apikey_get_object_v2_response.py index d41f5ed0e..0e05c4a37 100644 --- a/test/test_apikey_get_object_v2_response.py +++ b/test/test_apikey_get_object_v2_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.apikey_get_object_v2_response import ApikeyGetObjectV2Response # noqa: E501 +from eZmaxApi.models.apikey_get_object_v2_response import ApikeyGetObjectV2Response class TestApikeyGetObjectV2Response(unittest.TestCase): """ApikeyGetObjectV2Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> ApikeyGetObjectV2Response: optional params are included """ # uncomment below to create an instance of `ApikeyGetObjectV2Response` """ - model = ApikeyGetObjectV2Response() # noqa: E501 + model = ApikeyGetObjectV2Response() if include_optional: return ApikeyGetObjectV2Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_apikey_get_object_v2_response_m_payload.py b/test/test_apikey_get_object_v2_response_m_payload.py index 4221e8afe..d01e59c6b 100644 --- a/test/test_apikey_get_object_v2_response_m_payload.py +++ b/test/test_apikey_get_object_v2_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.apikey_get_object_v2_response_m_payload import ApikeyGetObjectV2ResponseMPayload # noqa: E501 +from eZmaxApi.models.apikey_get_object_v2_response_m_payload import ApikeyGetObjectV2ResponseMPayload class TestApikeyGetObjectV2ResponseMPayload(unittest.TestCase): """ApikeyGetObjectV2ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> ApikeyGetObjectV2ResponseMPayload: optional params are included """ # uncomment below to create an instance of `ApikeyGetObjectV2ResponseMPayload` """ - model = ApikeyGetObjectV2ResponseMPayload() # noqa: E501 + model = ApikeyGetObjectV2ResponseMPayload() if include_optional: return ApikeyGetObjectV2ResponseMPayload( obj_apikey = eZmaxApi.models.apikey_response_compound.apikey-ResponseCompound() diff --git a/test/test_apikey_get_permissions_v1_response.py b/test/test_apikey_get_permissions_v1_response.py index abf95e60d..3c62d4700 100644 --- a/test/test_apikey_get_permissions_v1_response.py +++ b/test/test_apikey_get_permissions_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.apikey_get_permissions_v1_response import ApikeyGetPermissionsV1Response # noqa: E501 +from eZmaxApi.models.apikey_get_permissions_v1_response import ApikeyGetPermissionsV1Response class TestApikeyGetPermissionsV1Response(unittest.TestCase): """ApikeyGetPermissionsV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> ApikeyGetPermissionsV1Response: optional params are included """ # uncomment below to create an instance of `ApikeyGetPermissionsV1Response` """ - model = ApikeyGetPermissionsV1Response() # noqa: E501 + model = ApikeyGetPermissionsV1Response() if include_optional: return ApikeyGetPermissionsV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_apikey_get_permissions_v1_response_m_payload.py b/test/test_apikey_get_permissions_v1_response_m_payload.py index de1ea93a7..bc0dc6698 100644 --- a/test/test_apikey_get_permissions_v1_response_m_payload.py +++ b/test/test_apikey_get_permissions_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.apikey_get_permissions_v1_response_m_payload import ApikeyGetPermissionsV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.apikey_get_permissions_v1_response_m_payload import ApikeyGetPermissionsV1ResponseMPayload class TestApikeyGetPermissionsV1ResponseMPayload(unittest.TestCase): """ApikeyGetPermissionsV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> ApikeyGetPermissionsV1ResponseMPayl optional params are included """ # uncomment below to create an instance of `ApikeyGetPermissionsV1ResponseMPayload` """ - model = ApikeyGetPermissionsV1ResponseMPayload() # noqa: E501 + model = ApikeyGetPermissionsV1ResponseMPayload() if include_optional: return ApikeyGetPermissionsV1ResponseMPayload( a_obj_modulegroup = [ diff --git a/test/test_apikey_get_subnets_v1_response.py b/test/test_apikey_get_subnets_v1_response.py index 1164c7cc0..78384f68b 100644 --- a/test/test_apikey_get_subnets_v1_response.py +++ b/test/test_apikey_get_subnets_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.apikey_get_subnets_v1_response import ApikeyGetSubnetsV1Response # noqa: E501 +from eZmaxApi.models.apikey_get_subnets_v1_response import ApikeyGetSubnetsV1Response class TestApikeyGetSubnetsV1Response(unittest.TestCase): """ApikeyGetSubnetsV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> ApikeyGetSubnetsV1Response: optional params are included """ # uncomment below to create an instance of `ApikeyGetSubnetsV1Response` """ - model = ApikeyGetSubnetsV1Response() # noqa: E501 + model = ApikeyGetSubnetsV1Response() if include_optional: return ApikeyGetSubnetsV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_apikey_get_subnets_v1_response_m_payload.py b/test/test_apikey_get_subnets_v1_response_m_payload.py index b2d735797..7d73e8cf1 100644 --- a/test/test_apikey_get_subnets_v1_response_m_payload.py +++ b/test/test_apikey_get_subnets_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.apikey_get_subnets_v1_response_m_payload import ApikeyGetSubnetsV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.apikey_get_subnets_v1_response_m_payload import ApikeyGetSubnetsV1ResponseMPayload class TestApikeyGetSubnetsV1ResponseMPayload(unittest.TestCase): """ApikeyGetSubnetsV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> ApikeyGetSubnetsV1ResponseMPayload: optional params are included """ # uncomment below to create an instance of `ApikeyGetSubnetsV1ResponseMPayload` """ - model = ApikeyGetSubnetsV1ResponseMPayload() # noqa: E501 + model = ApikeyGetSubnetsV1ResponseMPayload() if include_optional: return ApikeyGetSubnetsV1ResponseMPayload( a_obj_subnet = [ diff --git a/test/test_apikey_list_element.py b/test/test_apikey_list_element.py index d8cfb2c63..cf1ff3643 100644 --- a/test/test_apikey_list_element.py +++ b/test/test_apikey_list_element.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.apikey_list_element import ApikeyListElement # noqa: E501 +from eZmaxApi.models.apikey_list_element import ApikeyListElement class TestApikeyListElement(unittest.TestCase): """ApikeyListElement unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> ApikeyListElement: optional params are included """ # uncomment below to create an instance of `ApikeyListElement` """ - model = ApikeyListElement() # noqa: E501 + model = ApikeyListElement() if include_optional: return ApikeyListElement( pki_apikey_id = 99, diff --git a/test/test_apikey_regenerate_v1_request.py b/test/test_apikey_regenerate_v1_request.py index fcaef9abb..5ca8c8b2e 100644 --- a/test/test_apikey_regenerate_v1_request.py +++ b/test/test_apikey_regenerate_v1_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.apikey_regenerate_v1_request import ApikeyRegenerateV1Request # noqa: E501 +from eZmaxApi.models.apikey_regenerate_v1_request import ApikeyRegenerateV1Request class TestApikeyRegenerateV1Request(unittest.TestCase): """ApikeyRegenerateV1Request unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> ApikeyRegenerateV1Request: optional params are included """ # uncomment below to create an instance of `ApikeyRegenerateV1Request` """ - model = ApikeyRegenerateV1Request() # noqa: E501 + model = ApikeyRegenerateV1Request() if include_optional: return ApikeyRegenerateV1Request( b_apikey_issigned = True diff --git a/test/test_apikey_regenerate_v1_response.py b/test/test_apikey_regenerate_v1_response.py index ba049b8cf..e86af0869 100644 --- a/test/test_apikey_regenerate_v1_response.py +++ b/test/test_apikey_regenerate_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.apikey_regenerate_v1_response import ApikeyRegenerateV1Response # noqa: E501 +from eZmaxApi.models.apikey_regenerate_v1_response import ApikeyRegenerateV1Response class TestApikeyRegenerateV1Response(unittest.TestCase): """ApikeyRegenerateV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> ApikeyRegenerateV1Response: optional params are included """ # uncomment below to create an instance of `ApikeyRegenerateV1Response` """ - model = ApikeyRegenerateV1Response() # noqa: E501 + model = ApikeyRegenerateV1Response() if include_optional: return ApikeyRegenerateV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_apikey_regenerate_v1_response_m_payload.py b/test/test_apikey_regenerate_v1_response_m_payload.py index a01224f7b..ba101850c 100644 --- a/test/test_apikey_regenerate_v1_response_m_payload.py +++ b/test/test_apikey_regenerate_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.apikey_regenerate_v1_response_m_payload import ApikeyRegenerateV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.apikey_regenerate_v1_response_m_payload import ApikeyRegenerateV1ResponseMPayload class TestApikeyRegenerateV1ResponseMPayload(unittest.TestCase): """ApikeyRegenerateV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> ApikeyRegenerateV1ResponseMPayload: optional params are included """ # uncomment below to create an instance of `ApikeyRegenerateV1ResponseMPayload` """ - model = ApikeyRegenerateV1ResponseMPayload() # noqa: E501 + model = ApikeyRegenerateV1ResponseMPayload() if include_optional: return ApikeyRegenerateV1ResponseMPayload( obj_apikey = eZmaxApi.models.apikey_response_compound.apikey-ResponseCompound() diff --git a/test/test_apikey_request.py b/test/test_apikey_request.py index 51cf21494..84a48d2d9 100644 --- a/test/test_apikey_request.py +++ b/test/test_apikey_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.apikey_request import ApikeyRequest # noqa: E501 +from eZmaxApi.models.apikey_request import ApikeyRequest class TestApikeyRequest(unittest.TestCase): """ApikeyRequest unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> ApikeyRequest: optional params are included """ # uncomment below to create an instance of `ApikeyRequest` """ - model = ApikeyRequest() # noqa: E501 + model = ApikeyRequest() if include_optional: return ApikeyRequest( pki_apikey_id = 99, diff --git a/test/test_apikey_request_compound.py b/test/test_apikey_request_compound.py index ee0b98e98..900befa2b 100644 --- a/test/test_apikey_request_compound.py +++ b/test/test_apikey_request_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.apikey_request_compound import ApikeyRequestCompound # noqa: E501 +from eZmaxApi.models.apikey_request_compound import ApikeyRequestCompound class TestApikeyRequestCompound(unittest.TestCase): """ApikeyRequestCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> ApikeyRequestCompound: optional params are included """ # uncomment below to create an instance of `ApikeyRequestCompound` """ - model = ApikeyRequestCompound() # noqa: E501 + model = ApikeyRequestCompound() if include_optional: return ApikeyRequestCompound( pki_apikey_id = 99, diff --git a/test/test_apikey_response.py b/test/test_apikey_response.py index f6bf243bf..b7992d5e9 100644 --- a/test/test_apikey_response.py +++ b/test/test_apikey_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.apikey_response import ApikeyResponse # noqa: E501 +from eZmaxApi.models.apikey_response import ApikeyResponse class TestApikeyResponse(unittest.TestCase): """ApikeyResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> ApikeyResponse: optional params are included """ # uncomment below to create an instance of `ApikeyResponse` """ - model = ApikeyResponse() # noqa: E501 + model = ApikeyResponse() if include_optional: return ApikeyResponse( pki_apikey_id = 99, diff --git a/test/test_apikey_response_compound.py b/test/test_apikey_response_compound.py index 43769fa48..6e0babac0 100644 --- a/test/test_apikey_response_compound.py +++ b/test/test_apikey_response_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.apikey_response_compound import ApikeyResponseCompound # noqa: E501 +from eZmaxApi.models.apikey_response_compound import ApikeyResponseCompound class TestApikeyResponseCompound(unittest.TestCase): """ApikeyResponseCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> ApikeyResponseCompound: optional params are included """ # uncomment below to create an instance of `ApikeyResponseCompound` """ - model = ApikeyResponseCompound() # noqa: E501 + model = ApikeyResponseCompound() if include_optional: return ApikeyResponseCompound( pki_apikey_id = 99, diff --git a/test/test_attachment_get_attachmentlogs_v1_response.py b/test/test_attachment_get_attachmentlogs_v1_response.py new file mode 100644 index 000000000..96f6203bb --- /dev/null +++ b/test/test_attachment_get_attachmentlogs_v1_response.py @@ -0,0 +1,75 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest +import datetime + +from eZmaxApi.models.attachment_get_attachmentlogs_v1_response import AttachmentGetAttachmentlogsV1Response + +class TestAttachmentGetAttachmentlogsV1Response(unittest.TestCase): + """AttachmentGetAttachmentlogsV1Response unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AttachmentGetAttachmentlogsV1Response: + """Test AttachmentGetAttachmentlogsV1Response + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AttachmentGetAttachmentlogsV1Response` + """ + model = AttachmentGetAttachmentlogsV1Response() + if include_optional: + return AttachmentGetAttachmentlogsV1Response( + obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( + i_version_min = 1, + i_version_max = 2, + a_required_permission = [ + 117 + ], + b_version_deprecated = False, ), + obj_debug = {"sMemoryUsage":"11,923MB","sRunTime":"0.6084s","iSQLSelects":3,"iSQLQueries":6,"a_objSQLQuery":[{"sQuery":"SELECT * FROM table","fDuration":1.0E-4},{"sQuery":"SELECT * FROM table","fDuration":1.0E-4}]}, + m_payload = eZmaxApi.models.attachment_get_attachmentlogs_v1_response_m_payload.attachment-getAttachmentlogs-v1-Response-mPayload( + a_obj_attachmentlog = [ + eZmaxApi.models.attachmentlog_response_compound.attachmentlog-ResponseCompound() + ], ) + ) + else: + return AttachmentGetAttachmentlogsV1Response( + obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( + i_version_min = 1, + i_version_max = 2, + a_required_permission = [ + 117 + ], + b_version_deprecated = False, ), + m_payload = eZmaxApi.models.attachment_get_attachmentlogs_v1_response_m_payload.attachment-getAttachmentlogs-v1-Response-mPayload( + a_obj_attachmentlog = [ + eZmaxApi.models.attachmentlog_response_compound.attachmentlog-ResponseCompound() + ], ), + ) + """ + + def testAttachmentGetAttachmentlogsV1Response(self): + """Test AttachmentGetAttachmentlogsV1Response""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_attachment_get_attachmentlogs_v1_response_m_payload.py b/test/test_attachment_get_attachmentlogs_v1_response_m_payload.py new file mode 100644 index 000000000..05a8dbc53 --- /dev/null +++ b/test/test_attachment_get_attachmentlogs_v1_response_m_payload.py @@ -0,0 +1,58 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest +import datetime + +from eZmaxApi.models.attachment_get_attachmentlogs_v1_response_m_payload import AttachmentGetAttachmentlogsV1ResponseMPayload + +class TestAttachmentGetAttachmentlogsV1ResponseMPayload(unittest.TestCase): + """AttachmentGetAttachmentlogsV1ResponseMPayload unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AttachmentGetAttachmentlogsV1ResponseMPayload: + """Test AttachmentGetAttachmentlogsV1ResponseMPayload + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AttachmentGetAttachmentlogsV1ResponseMPayload` + """ + model = AttachmentGetAttachmentlogsV1ResponseMPayload() + if include_optional: + return AttachmentGetAttachmentlogsV1ResponseMPayload( + a_obj_attachmentlog = [ + eZmaxApi.models.attachmentlog_response_compound.attachmentlog-ResponseCompound() + ] + ) + else: + return AttachmentGetAttachmentlogsV1ResponseMPayload( + a_obj_attachmentlog = [ + eZmaxApi.models.attachmentlog_response_compound.attachmentlog-ResponseCompound() + ], + ) + """ + + def testAttachmentGetAttachmentlogsV1ResponseMPayload(self): + """Test AttachmentGetAttachmentlogsV1ResponseMPayload""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_attachment_get_download_url_v1_response.py b/test/test_attachment_get_download_url_v1_response.py new file mode 100644 index 000000000..e660f1132 --- /dev/null +++ b/test/test_attachment_get_download_url_v1_response.py @@ -0,0 +1,69 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest +import datetime + +from eZmaxApi.models.attachment_get_download_url_v1_response import AttachmentGetDownloadUrlV1Response + +class TestAttachmentGetDownloadUrlV1Response(unittest.TestCase): + """AttachmentGetDownloadUrlV1Response unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AttachmentGetDownloadUrlV1Response: + """Test AttachmentGetDownloadUrlV1Response + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AttachmentGetDownloadUrlV1Response` + """ + model = AttachmentGetDownloadUrlV1Response() + if include_optional: + return AttachmentGetDownloadUrlV1Response( + obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( + i_version_min = 1, + i_version_max = 2, + a_required_permission = [ + 117 + ], + b_version_deprecated = False, ), + obj_debug = {"sMemoryUsage":"11,923MB","sRunTime":"0.6084s","iSQLSelects":3,"iSQLQueries":6,"a_objSQLQuery":[{"sQuery":"SELECT * FROM table","fDuration":1.0E-4},{"sQuery":"SELECT * FROM table","fDuration":1.0E-4}]}, + m_payload = {"sDownloadUrl":"http://www.example.com/document.pdf"} + ) + else: + return AttachmentGetDownloadUrlV1Response( + obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( + i_version_min = 1, + i_version_max = 2, + a_required_permission = [ + 117 + ], + b_version_deprecated = False, ), + m_payload = {"sDownloadUrl":"http://www.example.com/document.pdf"}, + ) + """ + + def testAttachmentGetDownloadUrlV1Response(self): + """Test AttachmentGetDownloadUrlV1Response""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_attachment_get_download_url_v1_response_m_payload.py b/test/test_attachment_get_download_url_v1_response_m_payload.py new file mode 100644 index 000000000..cdbb6983f --- /dev/null +++ b/test/test_attachment_get_download_url_v1_response_m_payload.py @@ -0,0 +1,54 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest +import datetime + +from eZmaxApi.models.attachment_get_download_url_v1_response_m_payload import AttachmentGetDownloadUrlV1ResponseMPayload + +class TestAttachmentGetDownloadUrlV1ResponseMPayload(unittest.TestCase): + """AttachmentGetDownloadUrlV1ResponseMPayload unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AttachmentGetDownloadUrlV1ResponseMPayload: + """Test AttachmentGetDownloadUrlV1ResponseMPayload + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AttachmentGetDownloadUrlV1ResponseMPayload` + """ + model = AttachmentGetDownloadUrlV1ResponseMPayload() + if include_optional: + return AttachmentGetDownloadUrlV1ResponseMPayload( + s_download_url = 'http://www.example.com/document.pdf' + ) + else: + return AttachmentGetDownloadUrlV1ResponseMPayload( + s_download_url = 'http://www.example.com/document.pdf', + ) + """ + + def testAttachmentGetDownloadUrlV1ResponseMPayload(self): + """Test AttachmentGetDownloadUrlV1ResponseMPayload""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_attachment_response.py b/test/test_attachment_response.py new file mode 100644 index 000000000..f37b75721 --- /dev/null +++ b/test/test_attachment_response.py @@ -0,0 +1,139 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest +import datetime + +from eZmaxApi.models.attachment_response import AttachmentResponse + +class TestAttachmentResponse(unittest.TestCase): + """AttachmentResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AttachmentResponse: + """Test AttachmentResponse + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AttachmentResponse` + """ + model = AttachmentResponse() + if include_optional: + return AttachmentResponse( + pki_attachment_id = 1, + fki_computer_id = 249, + fki_adjustment_id = 202, + fki_agent_id = 1, + fki_bankaccount_id = 46, + fki_broker_id = 26, + fki_commissionadvance_id = 115, + fki_communication_id = 1, + fki_customer_id = 18, + fki_customertemplate_id = 152, + fki_deposit_id = 54, + fki_deposittransitcheque_id = 251, + fki_electronicfundstransfer_id = 1262, + fki_employee_id = 31, + fki_externalbroker_id = 1, + fki_ezcomadvanceserver_id = 238, + fki_ezcomcompany_id = 170, + fki_ezsigndocument_id = 97, + fki_ghacqcontract_id = 217, + fki_inscription_id = 17, + fki_inscriptiontemp_id = 2445, + fki_inscriptionnotauthenticated_id = 24, + fki_invoice_id = 1, + fki_buyercontract_id = 38, + fki_franchisebroker_id = 61, + fki_franchiseagence_id = 117, + fki_franchiseoffice_id = 50, + fki_franchisefranchise_id = 156, + fki_franchisecomplaint_id = 24, + fki_lead_id = 117, + fki_marketingprogram_id = 178, + fki_marketingfollow_id = 45, + fki_notary_id = 1, + fki_officetaxreport_id = 200, + fki_otherincome_id = 142, + fki_paymentpreparation_id = 124, + fki_purchase_id = 155, + fki_salary_id = 73, + fki_supplier_id = 1, + fki_tranqcontract_id = 39, + fki_template_id = 232, + fki_inscriptionchecklist_id = 191, + fki_folder_id = 81, + fki_rejectedoffertopurchase_id = 532, + fki_disclosure_id = 51, + fki_reconciliation_id = 140, + fki_ezsigndocument_id_reference = 97, + e_attachment_documenttype = 'Adjustment', + s_attachment_name = 'Document.pdf', + e_attachment_privacy = 'All', + fki_user_id_specific = 70, + e_attachment_type = 'Other', + i_attachment_size = 277465200, + i_attachment_ed_mmoduleflag = 65, + s_attachment_md5 = '2cb29026e8a93c930e71598579400db6', + b_attachment_deleted = False, + b_attachment_valid = True, + e_attachment_verified = 'No', + t_attachment_rejectioncomment = 'Unreadable', + fki_user_id_owner = 70, + obj_audit = eZmaxApi.models.common_audit.Common-Audit( + obj_auditdetail_created = eZmaxApi.models.common_auditdetail.Common-Auditdetail( + fki_user_id = 70, + fki_apikey_id = 99, + s_user_loginname = 'JohnDoe', + s_user_lastname = 'Doe', + s_user_firstname = 'John', + s_apikey_description_x = 'Project X', + dt_auditdetail_date = '2020-12-31 23:59:59', ), + obj_auditdetail_modified = eZmaxApi.models.common_auditdetail.Common-Auditdetail( + fki_user_id = 70, + fki_apikey_id = 99, + s_user_loginname = 'JohnDoe', + s_user_lastname = 'Doe', + s_user_firstname = 'John', + s_apikey_description_x = 'Project X', + dt_auditdetail_date = '2020-12-31 23:59:59', ), ) + ) + else: + return AttachmentResponse( + pki_attachment_id = 1, + e_attachment_documenttype = 'Adjustment', + s_attachment_name = 'Document.pdf', + e_attachment_privacy = 'All', + e_attachment_type = 'Other', + i_attachment_size = 277465200, + s_attachment_md5 = '2cb29026e8a93c930e71598579400db6', + b_attachment_deleted = False, + b_attachment_valid = True, + e_attachment_verified = 'No', + ) + """ + + def testAttachmentResponse(self): + """Test AttachmentResponse""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_attachment_response_compound.py b/test/test_attachment_response_compound.py new file mode 100644 index 000000000..f2ca563c3 --- /dev/null +++ b/test/test_attachment_response_compound.py @@ -0,0 +1,139 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest +import datetime + +from eZmaxApi.models.attachment_response_compound import AttachmentResponseCompound + +class TestAttachmentResponseCompound(unittest.TestCase): + """AttachmentResponseCompound unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AttachmentResponseCompound: + """Test AttachmentResponseCompound + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AttachmentResponseCompound` + """ + model = AttachmentResponseCompound() + if include_optional: + return AttachmentResponseCompound( + pki_attachment_id = 1, + fki_computer_id = 249, + fki_adjustment_id = 202, + fki_agent_id = 1, + fki_bankaccount_id = 46, + fki_broker_id = 26, + fki_commissionadvance_id = 115, + fki_communication_id = 1, + fki_customer_id = 18, + fki_customertemplate_id = 152, + fki_deposit_id = 54, + fki_deposittransitcheque_id = 251, + fki_electronicfundstransfer_id = 1262, + fki_employee_id = 31, + fki_externalbroker_id = 1, + fki_ezcomadvanceserver_id = 238, + fki_ezcomcompany_id = 170, + fki_ezsigndocument_id = 97, + fki_ghacqcontract_id = 217, + fki_inscription_id = 17, + fki_inscriptiontemp_id = 2445, + fki_inscriptionnotauthenticated_id = 24, + fki_invoice_id = 1, + fki_buyercontract_id = 38, + fki_franchisebroker_id = 61, + fki_franchiseagence_id = 117, + fki_franchiseoffice_id = 50, + fki_franchisefranchise_id = 156, + fki_franchisecomplaint_id = 24, + fki_lead_id = 117, + fki_marketingprogram_id = 178, + fki_marketingfollow_id = 45, + fki_notary_id = 1, + fki_officetaxreport_id = 200, + fki_otherincome_id = 142, + fki_paymentpreparation_id = 124, + fki_purchase_id = 155, + fki_salary_id = 73, + fki_supplier_id = 1, + fki_tranqcontract_id = 39, + fki_template_id = 232, + fki_inscriptionchecklist_id = 191, + fki_folder_id = 81, + fki_rejectedoffertopurchase_id = 532, + fki_disclosure_id = 51, + fki_reconciliation_id = 140, + fki_ezsigndocument_id_reference = 97, + e_attachment_documenttype = 'Adjustment', + s_attachment_name = 'Document.pdf', + e_attachment_privacy = 'All', + fki_user_id_specific = 70, + e_attachment_type = 'Other', + i_attachment_size = 277465200, + i_attachment_ed_mmoduleflag = 65, + s_attachment_md5 = '2cb29026e8a93c930e71598579400db6', + b_attachment_deleted = False, + b_attachment_valid = True, + e_attachment_verified = 'No', + t_attachment_rejectioncomment = 'Unreadable', + fki_user_id_owner = 70, + obj_audit = eZmaxApi.models.common_audit.Common-Audit( + obj_auditdetail_created = eZmaxApi.models.common_auditdetail.Common-Auditdetail( + fki_user_id = 70, + fki_apikey_id = 99, + s_user_loginname = 'JohnDoe', + s_user_lastname = 'Doe', + s_user_firstname = 'John', + s_apikey_description_x = 'Project X', + dt_auditdetail_date = '2020-12-31 23:59:59', ), + obj_auditdetail_modified = eZmaxApi.models.common_auditdetail.Common-Auditdetail( + fki_user_id = 70, + fki_apikey_id = 99, + s_user_loginname = 'JohnDoe', + s_user_lastname = 'Doe', + s_user_firstname = 'John', + s_apikey_description_x = 'Project X', + dt_auditdetail_date = '2020-12-31 23:59:59', ), ) + ) + else: + return AttachmentResponseCompound( + pki_attachment_id = 1, + e_attachment_documenttype = 'Adjustment', + s_attachment_name = 'Document.pdf', + e_attachment_privacy = 'All', + e_attachment_type = 'Other', + i_attachment_size = 277465200, + s_attachment_md5 = '2cb29026e8a93c930e71598579400db6', + b_attachment_deleted = False, + b_attachment_valid = True, + e_attachment_verified = 'No', + ) + """ + + def testAttachmentResponseCompound(self): + """Test AttachmentResponseCompound""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_attachmentlog_response.py b/test/test_attachmentlog_response.py new file mode 100644 index 000000000..aae45ed9e --- /dev/null +++ b/test/test_attachmentlog_response.py @@ -0,0 +1,61 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest +import datetime + +from eZmaxApi.models.attachmentlog_response import AttachmentlogResponse + +class TestAttachmentlogResponse(unittest.TestCase): + """AttachmentlogResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AttachmentlogResponse: + """Test AttachmentlogResponse + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AttachmentlogResponse` + """ + model = AttachmentlogResponse() + if include_optional: + return AttachmentlogResponse( + fki_attachment_id = 1, + fki_user_id = 70, + dt_attachmentlog_datetime = '2020-12-31 23:59:59', + e_attachmentlog_type = 'AutoValidation', + s_attachmentlog_detail = 'System' + ) + else: + return AttachmentlogResponse( + fki_attachment_id = 1, + fki_user_id = 70, + dt_attachmentlog_datetime = '2020-12-31 23:59:59', + e_attachmentlog_type = 'AutoValidation', + ) + """ + + def testAttachmentlogResponse(self): + """Test AttachmentlogResponse""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_attachmentlog_response_compound.py b/test/test_attachmentlog_response_compound.py new file mode 100644 index 000000000..85140ea63 --- /dev/null +++ b/test/test_attachmentlog_response_compound.py @@ -0,0 +1,61 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest +import datetime + +from eZmaxApi.models.attachmentlog_response_compound import AttachmentlogResponseCompound + +class TestAttachmentlogResponseCompound(unittest.TestCase): + """AttachmentlogResponseCompound unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> AttachmentlogResponseCompound: + """Test AttachmentlogResponseCompound + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `AttachmentlogResponseCompound` + """ + model = AttachmentlogResponseCompound() + if include_optional: + return AttachmentlogResponseCompound( + fki_attachment_id = 1, + fki_user_id = 70, + dt_attachmentlog_datetime = '2020-12-31 23:59:59', + e_attachmentlog_type = 'AutoValidation', + s_attachmentlog_detail = 'System' + ) + else: + return AttachmentlogResponseCompound( + fki_attachment_id = 1, + fki_user_id = 70, + dt_attachmentlog_datetime = '2020-12-31 23:59:59', + e_attachmentlog_type = 'AutoValidation', + ) + """ + + def testAttachmentlogResponseCompound(self): + """Test AttachmentlogResponseCompound""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_attempt_response.py b/test/test_attempt_response.py index 724f903e7..8028ee5f6 100644 --- a/test/test_attempt_response.py +++ b/test/test_attempt_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.attempt_response import AttemptResponse # noqa: E501 +from eZmaxApi.models.attempt_response import AttemptResponse class TestAttemptResponse(unittest.TestCase): """AttemptResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> AttemptResponse: optional params are included """ # uncomment below to create an instance of `AttemptResponse` """ - model = AttemptResponse() # noqa: E501 + model = AttemptResponse() if include_optional: return AttemptResponse( dt_attempt_start = '2020-12-31 23:59:59', diff --git a/test/test_attempt_response_compound.py b/test/test_attempt_response_compound.py index da040950a..b41a057e2 100644 --- a/test/test_attempt_response_compound.py +++ b/test/test_attempt_response_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.attempt_response_compound import AttemptResponseCompound # noqa: E501 +from eZmaxApi.models.attempt_response_compound import AttemptResponseCompound class TestAttemptResponseCompound(unittest.TestCase): """AttemptResponseCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> AttemptResponseCompound: optional params are included """ # uncomment below to create an instance of `AttemptResponseCompound` """ - model = AttemptResponseCompound() # noqa: E501 + model = AttemptResponseCompound() if include_optional: return AttemptResponseCompound( dt_attempt_start = '2020-12-31 23:59:59', diff --git a/test/test_billingentityexternal_autocomplete_element_response.py b/test/test_billingentityexternal_autocomplete_element_response.py index 163b5525e..77e8b1786 100644 --- a/test/test_billingentityexternal_autocomplete_element_response.py +++ b/test/test_billingentityexternal_autocomplete_element_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.billingentityexternal_autocomplete_element_response import BillingentityexternalAutocompleteElementResponse # noqa: E501 +from eZmaxApi.models.billingentityexternal_autocomplete_element_response import BillingentityexternalAutocompleteElementResponse class TestBillingentityexternalAutocompleteElementResponse(unittest.TestCase): """BillingentityexternalAutocompleteElementResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> BillingentityexternalAutocompleteEl optional params are included """ # uncomment below to create an instance of `BillingentityexternalAutocompleteElementResponse` """ - model = BillingentityexternalAutocompleteElementResponse() # noqa: E501 + model = BillingentityexternalAutocompleteElementResponse() if include_optional: return BillingentityexternalAutocompleteElementResponse( pki_billingentityexternal_id = 83, diff --git a/test/test_billingentityexternal_get_autocomplete_v2_response.py b/test/test_billingentityexternal_get_autocomplete_v2_response.py index 15361525a..67f93503e 100644 --- a/test/test_billingentityexternal_get_autocomplete_v2_response.py +++ b/test/test_billingentityexternal_get_autocomplete_v2_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.billingentityexternal_get_autocomplete_v2_response import BillingentityexternalGetAutocompleteV2Response # noqa: E501 +from eZmaxApi.models.billingentityexternal_get_autocomplete_v2_response import BillingentityexternalGetAutocompleteV2Response class TestBillingentityexternalGetAutocompleteV2Response(unittest.TestCase): """BillingentityexternalGetAutocompleteV2Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> BillingentityexternalGetAutocomplet optional params are included """ # uncomment below to create an instance of `BillingentityexternalGetAutocompleteV2Response` """ - model = BillingentityexternalGetAutocompleteV2Response() # noqa: E501 + model = BillingentityexternalGetAutocompleteV2Response() if include_optional: return BillingentityexternalGetAutocompleteV2Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_billingentityexternal_get_autocomplete_v2_response_m_payload.py b/test/test_billingentityexternal_get_autocomplete_v2_response_m_payload.py index 4a413bf7e..6e9f13011 100644 --- a/test/test_billingentityexternal_get_autocomplete_v2_response_m_payload.py +++ b/test/test_billingentityexternal_get_autocomplete_v2_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.billingentityexternal_get_autocomplete_v2_response_m_payload import BillingentityexternalGetAutocompleteV2ResponseMPayload # noqa: E501 +from eZmaxApi.models.billingentityexternal_get_autocomplete_v2_response_m_payload import BillingentityexternalGetAutocompleteV2ResponseMPayload class TestBillingentityexternalGetAutocompleteV2ResponseMPayload(unittest.TestCase): """BillingentityexternalGetAutocompleteV2ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> BillingentityexternalGetAutocomplet optional params are included """ # uncomment below to create an instance of `BillingentityexternalGetAutocompleteV2ResponseMPayload` """ - model = BillingentityexternalGetAutocompleteV2ResponseMPayload() # noqa: E501 + model = BillingentityexternalGetAutocompleteV2ResponseMPayload() if include_optional: return BillingentityexternalGetAutocompleteV2ResponseMPayload( a_obj_billingentityexternal = [ diff --git a/test/test_billingentityinternal_autocomplete_element_response.py b/test/test_billingentityinternal_autocomplete_element_response.py index 837a7f3b6..ad47fad54 100644 --- a/test/test_billingentityinternal_autocomplete_element_response.py +++ b/test/test_billingentityinternal_autocomplete_element_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.billingentityinternal_autocomplete_element_response import BillingentityinternalAutocompleteElementResponse # noqa: E501 +from eZmaxApi.models.billingentityinternal_autocomplete_element_response import BillingentityinternalAutocompleteElementResponse class TestBillingentityinternalAutocompleteElementResponse(unittest.TestCase): """BillingentityinternalAutocompleteElementResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> BillingentityinternalAutocompleteEl optional params are included """ # uncomment below to create an instance of `BillingentityinternalAutocompleteElementResponse` """ - model = BillingentityinternalAutocompleteElementResponse() # noqa: E501 + model = BillingentityinternalAutocompleteElementResponse() if include_optional: return BillingentityinternalAutocompleteElementResponse( pki_billingentityinternal_id = 1, diff --git a/test/test_billingentityinternal_create_object_v1_request.py b/test/test_billingentityinternal_create_object_v1_request.py index 0e6514fce..cc9a98d18 100644 --- a/test/test_billingentityinternal_create_object_v1_request.py +++ b/test/test_billingentityinternal_create_object_v1_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.billingentityinternal_create_object_v1_request import BillingentityinternalCreateObjectV1Request # noqa: E501 +from eZmaxApi.models.billingentityinternal_create_object_v1_request import BillingentityinternalCreateObjectV1Request class TestBillingentityinternalCreateObjectV1Request(unittest.TestCase): """BillingentityinternalCreateObjectV1Request unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> BillingentityinternalCreateObjectV1 optional params are included """ # uncomment below to create an instance of `BillingentityinternalCreateObjectV1Request` """ - model = BillingentityinternalCreateObjectV1Request() # noqa: E501 + model = BillingentityinternalCreateObjectV1Request() if include_optional: return BillingentityinternalCreateObjectV1Request( a_obj_billingentityinternal = [ diff --git a/test/test_billingentityinternal_create_object_v1_response.py b/test/test_billingentityinternal_create_object_v1_response.py index da9606e57..7d6dfd58d 100644 --- a/test/test_billingentityinternal_create_object_v1_response.py +++ b/test/test_billingentityinternal_create_object_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.billingentityinternal_create_object_v1_response import BillingentityinternalCreateObjectV1Response # noqa: E501 +from eZmaxApi.models.billingentityinternal_create_object_v1_response import BillingentityinternalCreateObjectV1Response class TestBillingentityinternalCreateObjectV1Response(unittest.TestCase): """BillingentityinternalCreateObjectV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> BillingentityinternalCreateObjectV1 optional params are included """ # uncomment below to create an instance of `BillingentityinternalCreateObjectV1Response` """ - model = BillingentityinternalCreateObjectV1Response() # noqa: E501 + model = BillingentityinternalCreateObjectV1Response() if include_optional: return BillingentityinternalCreateObjectV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_billingentityinternal_create_object_v1_response_m_payload.py b/test/test_billingentityinternal_create_object_v1_response_m_payload.py index f7aa1c362..b89e3f1e7 100644 --- a/test/test_billingentityinternal_create_object_v1_response_m_payload.py +++ b/test/test_billingentityinternal_create_object_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.billingentityinternal_create_object_v1_response_m_payload import BillingentityinternalCreateObjectV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.billingentityinternal_create_object_v1_response_m_payload import BillingentityinternalCreateObjectV1ResponseMPayload class TestBillingentityinternalCreateObjectV1ResponseMPayload(unittest.TestCase): """BillingentityinternalCreateObjectV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> BillingentityinternalCreateObjectV1 optional params are included """ # uncomment below to create an instance of `BillingentityinternalCreateObjectV1ResponseMPayload` """ - model = BillingentityinternalCreateObjectV1ResponseMPayload() # noqa: E501 + model = BillingentityinternalCreateObjectV1ResponseMPayload() if include_optional: return BillingentityinternalCreateObjectV1ResponseMPayload( a_pki_billingentityinternal_id = [ diff --git a/test/test_billingentityinternal_edit_object_v1_request.py b/test/test_billingentityinternal_edit_object_v1_request.py index c3e98375a..a3af94062 100644 --- a/test/test_billingentityinternal_edit_object_v1_request.py +++ b/test/test_billingentityinternal_edit_object_v1_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.billingentityinternal_edit_object_v1_request import BillingentityinternalEditObjectV1Request # noqa: E501 +from eZmaxApi.models.billingentityinternal_edit_object_v1_request import BillingentityinternalEditObjectV1Request class TestBillingentityinternalEditObjectV1Request(unittest.TestCase): """BillingentityinternalEditObjectV1Request unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> BillingentityinternalEditObjectV1Re optional params are included """ # uncomment below to create an instance of `BillingentityinternalEditObjectV1Request` """ - model = BillingentityinternalEditObjectV1Request() # noqa: E501 + model = BillingentityinternalEditObjectV1Request() if include_optional: return BillingentityinternalEditObjectV1Request( obj_billingentityinternal = eZmaxApi.models.billingentityinternal_request_compound.billingentityinternal-RequestCompound() diff --git a/test/test_billingentityinternal_edit_object_v1_response.py b/test/test_billingentityinternal_edit_object_v1_response.py index c28724db3..a3b8bcd32 100644 --- a/test/test_billingentityinternal_edit_object_v1_response.py +++ b/test/test_billingentityinternal_edit_object_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.billingentityinternal_edit_object_v1_response import BillingentityinternalEditObjectV1Response # noqa: E501 +from eZmaxApi.models.billingentityinternal_edit_object_v1_response import BillingentityinternalEditObjectV1Response class TestBillingentityinternalEditObjectV1Response(unittest.TestCase): """BillingentityinternalEditObjectV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> BillingentityinternalEditObjectV1Re optional params are included """ # uncomment below to create an instance of `BillingentityinternalEditObjectV1Response` """ - model = BillingentityinternalEditObjectV1Response() # noqa: E501 + model = BillingentityinternalEditObjectV1Response() if include_optional: return BillingentityinternalEditObjectV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_billingentityinternal_get_autocomplete_v2_response.py b/test/test_billingentityinternal_get_autocomplete_v2_response.py index a80a18dc8..ff60e032e 100644 --- a/test/test_billingentityinternal_get_autocomplete_v2_response.py +++ b/test/test_billingentityinternal_get_autocomplete_v2_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.billingentityinternal_get_autocomplete_v2_response import BillingentityinternalGetAutocompleteV2Response # noqa: E501 +from eZmaxApi.models.billingentityinternal_get_autocomplete_v2_response import BillingentityinternalGetAutocompleteV2Response class TestBillingentityinternalGetAutocompleteV2Response(unittest.TestCase): """BillingentityinternalGetAutocompleteV2Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> BillingentityinternalGetAutocomplet optional params are included """ # uncomment below to create an instance of `BillingentityinternalGetAutocompleteV2Response` """ - model = BillingentityinternalGetAutocompleteV2Response() # noqa: E501 + model = BillingentityinternalGetAutocompleteV2Response() if include_optional: return BillingentityinternalGetAutocompleteV2Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_billingentityinternal_get_autocomplete_v2_response_m_payload.py b/test/test_billingentityinternal_get_autocomplete_v2_response_m_payload.py index 71e6b30c5..e01578f81 100644 --- a/test/test_billingentityinternal_get_autocomplete_v2_response_m_payload.py +++ b/test/test_billingentityinternal_get_autocomplete_v2_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.billingentityinternal_get_autocomplete_v2_response_m_payload import BillingentityinternalGetAutocompleteV2ResponseMPayload # noqa: E501 +from eZmaxApi.models.billingentityinternal_get_autocomplete_v2_response_m_payload import BillingentityinternalGetAutocompleteV2ResponseMPayload class TestBillingentityinternalGetAutocompleteV2ResponseMPayload(unittest.TestCase): """BillingentityinternalGetAutocompleteV2ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> BillingentityinternalGetAutocomplet optional params are included """ # uncomment below to create an instance of `BillingentityinternalGetAutocompleteV2ResponseMPayload` """ - model = BillingentityinternalGetAutocompleteV2ResponseMPayload() # noqa: E501 + model = BillingentityinternalGetAutocompleteV2ResponseMPayload() if include_optional: return BillingentityinternalGetAutocompleteV2ResponseMPayload( a_obj_billingentityinternal = [ diff --git a/test/test_billingentityinternal_get_list_v1_response.py b/test/test_billingentityinternal_get_list_v1_response.py index 878907128..4feb28d19 100644 --- a/test/test_billingentityinternal_get_list_v1_response.py +++ b/test/test_billingentityinternal_get_list_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.billingentityinternal_get_list_v1_response import BillingentityinternalGetListV1Response # noqa: E501 +from eZmaxApi.models.billingentityinternal_get_list_v1_response import BillingentityinternalGetListV1Response class TestBillingentityinternalGetListV1Response(unittest.TestCase): """BillingentityinternalGetListV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> BillingentityinternalGetListV1Respo optional params are included """ # uncomment below to create an instance of `BillingentityinternalGetListV1Response` """ - model = BillingentityinternalGetListV1Response() # noqa: E501 + model = BillingentityinternalGetListV1Response() if include_optional: return BillingentityinternalGetListV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload_get_list.Common-Response-objDebugPayload_getList(), diff --git a/test/test_billingentityinternal_get_list_v1_response_m_payload.py b/test/test_billingentityinternal_get_list_v1_response_m_payload.py index 62918c1de..031f56a91 100644 --- a/test/test_billingentityinternal_get_list_v1_response_m_payload.py +++ b/test/test_billingentityinternal_get_list_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.billingentityinternal_get_list_v1_response_m_payload import BillingentityinternalGetListV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.billingentityinternal_get_list_v1_response_m_payload import BillingentityinternalGetListV1ResponseMPayload class TestBillingentityinternalGetListV1ResponseMPayload(unittest.TestCase): """BillingentityinternalGetListV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> BillingentityinternalGetListV1Respo optional params are included """ # uncomment below to create an instance of `BillingentityinternalGetListV1ResponseMPayload` """ - model = BillingentityinternalGetListV1ResponseMPayload() # noqa: E501 + model = BillingentityinternalGetListV1ResponseMPayload() if include_optional: return BillingentityinternalGetListV1ResponseMPayload( i_row_returned = 100, diff --git a/test/test_billingentityinternal_get_object_v2_response.py b/test/test_billingentityinternal_get_object_v2_response.py index 2c7d671f9..bbcaf9bce 100644 --- a/test/test_billingentityinternal_get_object_v2_response.py +++ b/test/test_billingentityinternal_get_object_v2_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.billingentityinternal_get_object_v2_response import BillingentityinternalGetObjectV2Response # noqa: E501 +from eZmaxApi.models.billingentityinternal_get_object_v2_response import BillingentityinternalGetObjectV2Response class TestBillingentityinternalGetObjectV2Response(unittest.TestCase): """BillingentityinternalGetObjectV2Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> BillingentityinternalGetObjectV2Res optional params are included """ # uncomment below to create an instance of `BillingentityinternalGetObjectV2Response` """ - model = BillingentityinternalGetObjectV2Response() # noqa: E501 + model = BillingentityinternalGetObjectV2Response() if include_optional: return BillingentityinternalGetObjectV2Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_billingentityinternal_get_object_v2_response_m_payload.py b/test/test_billingentityinternal_get_object_v2_response_m_payload.py index ee1327ffb..a44bf7c7b 100644 --- a/test/test_billingentityinternal_get_object_v2_response_m_payload.py +++ b/test/test_billingentityinternal_get_object_v2_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.billingentityinternal_get_object_v2_response_m_payload import BillingentityinternalGetObjectV2ResponseMPayload # noqa: E501 +from eZmaxApi.models.billingentityinternal_get_object_v2_response_m_payload import BillingentityinternalGetObjectV2ResponseMPayload class TestBillingentityinternalGetObjectV2ResponseMPayload(unittest.TestCase): """BillingentityinternalGetObjectV2ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> BillingentityinternalGetObjectV2Res optional params are included """ # uncomment below to create an instance of `BillingentityinternalGetObjectV2ResponseMPayload` """ - model = BillingentityinternalGetObjectV2ResponseMPayload() # noqa: E501 + model = BillingentityinternalGetObjectV2ResponseMPayload() if include_optional: return BillingentityinternalGetObjectV2ResponseMPayload( obj_billingentityinternal = eZmaxApi.models.billingentityinternal_response_compound.billingentityinternal-ResponseCompound() diff --git a/test/test_billingentityinternal_list_element.py b/test/test_billingentityinternal_list_element.py index 52c726384..4a3bc1f97 100644 --- a/test/test_billingentityinternal_list_element.py +++ b/test/test_billingentityinternal_list_element.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.billingentityinternal_list_element import BillingentityinternalListElement # noqa: E501 +from eZmaxApi.models.billingentityinternal_list_element import BillingentityinternalListElement class TestBillingentityinternalListElement(unittest.TestCase): """BillingentityinternalListElement unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> BillingentityinternalListElement: optional params are included """ # uncomment below to create an instance of `BillingentityinternalListElement` """ - model = BillingentityinternalListElement() # noqa: E501 + model = BillingentityinternalListElement() if include_optional: return BillingentityinternalListElement( pki_billingentityinternal_id = 1, diff --git a/test/test_billingentityinternal_request.py b/test/test_billingentityinternal_request.py index b4951919b..6be5e03e1 100644 --- a/test/test_billingentityinternal_request.py +++ b/test/test_billingentityinternal_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.billingentityinternal_request import BillingentityinternalRequest # noqa: E501 +from eZmaxApi.models.billingentityinternal_request import BillingentityinternalRequest class TestBillingentityinternalRequest(unittest.TestCase): """BillingentityinternalRequest unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> BillingentityinternalRequest: optional params are included """ # uncomment below to create an instance of `BillingentityinternalRequest` """ - model = BillingentityinternalRequest() # noqa: E501 + model = BillingentityinternalRequest() if include_optional: return BillingentityinternalRequest( pki_billingentityinternal_id = 1, diff --git a/test/test_billingentityinternal_request_compound.py b/test/test_billingentityinternal_request_compound.py index c9b051b25..6742eeaf4 100644 --- a/test/test_billingentityinternal_request_compound.py +++ b/test/test_billingentityinternal_request_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.billingentityinternal_request_compound import BillingentityinternalRequestCompound # noqa: E501 +from eZmaxApi.models.billingentityinternal_request_compound import BillingentityinternalRequestCompound class TestBillingentityinternalRequestCompound(unittest.TestCase): """BillingentityinternalRequestCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> BillingentityinternalRequestCompoun optional params are included """ # uncomment below to create an instance of `BillingentityinternalRequestCompound` """ - model = BillingentityinternalRequestCompound() # noqa: E501 + model = BillingentityinternalRequestCompound() if include_optional: return BillingentityinternalRequestCompound( pki_billingentityinternal_id = 1, diff --git a/test/test_billingentityinternal_response.py b/test/test_billingentityinternal_response.py index 3d91b7f23..07d567265 100644 --- a/test/test_billingentityinternal_response.py +++ b/test/test_billingentityinternal_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.billingentityinternal_response import BillingentityinternalResponse # noqa: E501 +from eZmaxApi.models.billingentityinternal_response import BillingentityinternalResponse class TestBillingentityinternalResponse(unittest.TestCase): """BillingentityinternalResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> BillingentityinternalResponse: optional params are included """ # uncomment below to create an instance of `BillingentityinternalResponse` """ - model = BillingentityinternalResponse() # noqa: E501 + model = BillingentityinternalResponse() if include_optional: return BillingentityinternalResponse( pki_billingentityinternal_id = 1, diff --git a/test/test_billingentityinternal_response_compound.py b/test/test_billingentityinternal_response_compound.py index 885eaeb6f..b99318602 100644 --- a/test/test_billingentityinternal_response_compound.py +++ b/test/test_billingentityinternal_response_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.billingentityinternal_response_compound import BillingentityinternalResponseCompound # noqa: E501 +from eZmaxApi.models.billingentityinternal_response_compound import BillingentityinternalResponseCompound class TestBillingentityinternalResponseCompound(unittest.TestCase): """BillingentityinternalResponseCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> BillingentityinternalResponseCompou optional params are included """ # uncomment below to create an instance of `BillingentityinternalResponseCompound` """ - model = BillingentityinternalResponseCompound() # noqa: E501 + model = BillingentityinternalResponseCompound() if include_optional: return BillingentityinternalResponseCompound( pki_billingentityinternal_id = 1, diff --git a/test/test_billingentityinternalproduct_request.py b/test/test_billingentityinternalproduct_request.py index bef19ccf9..7991b9846 100644 --- a/test/test_billingentityinternalproduct_request.py +++ b/test/test_billingentityinternalproduct_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.billingentityinternalproduct_request import BillingentityinternalproductRequest # noqa: E501 +from eZmaxApi.models.billingentityinternalproduct_request import BillingentityinternalproductRequest class TestBillingentityinternalproductRequest(unittest.TestCase): """BillingentityinternalproductRequest unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> BillingentityinternalproductRequest optional params are included """ # uncomment below to create an instance of `BillingentityinternalproductRequest` """ - model = BillingentityinternalproductRequest() # noqa: E501 + model = BillingentityinternalproductRequest() if include_optional: return BillingentityinternalproductRequest( pki_billingentityinternalproduct_id = 254, diff --git a/test/test_billingentityinternalproduct_request_compound.py b/test/test_billingentityinternalproduct_request_compound.py index 16102ad2d..107b4299c 100644 --- a/test/test_billingentityinternalproduct_request_compound.py +++ b/test/test_billingentityinternalproduct_request_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.billingentityinternalproduct_request_compound import BillingentityinternalproductRequestCompound # noqa: E501 +from eZmaxApi.models.billingentityinternalproduct_request_compound import BillingentityinternalproductRequestCompound class TestBillingentityinternalproductRequestCompound(unittest.TestCase): """BillingentityinternalproductRequestCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> BillingentityinternalproductRequest optional params are included """ # uncomment below to create an instance of `BillingentityinternalproductRequestCompound` """ - model = BillingentityinternalproductRequestCompound() # noqa: E501 + model = BillingentityinternalproductRequestCompound() if include_optional: return BillingentityinternalproductRequestCompound( pki_billingentityinternalproduct_id = 254, diff --git a/test/test_billingentityinternalproduct_response.py b/test/test_billingentityinternalproduct_response.py index e6b6542e5..8826d04c2 100644 --- a/test/test_billingentityinternalproduct_response.py +++ b/test/test_billingentityinternalproduct_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.billingentityinternalproduct_response import BillingentityinternalproductResponse # noqa: E501 +from eZmaxApi.models.billingentityinternalproduct_response import BillingentityinternalproductResponse class TestBillingentityinternalproductResponse(unittest.TestCase): """BillingentityinternalproductResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> BillingentityinternalproductRespons optional params are included """ # uncomment below to create an instance of `BillingentityinternalproductResponse` """ - model = BillingentityinternalproductResponse() # noqa: E501 + model = BillingentityinternalproductResponse() if include_optional: return BillingentityinternalproductResponse( pki_billingentityinternalproduct_id = 254, diff --git a/test/test_billingentityinternalproduct_response_compound.py b/test/test_billingentityinternalproduct_response_compound.py index c0a0ad5ec..c5b462176 100644 --- a/test/test_billingentityinternalproduct_response_compound.py +++ b/test/test_billingentityinternalproduct_response_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.billingentityinternalproduct_response_compound import BillingentityinternalproductResponseCompound # noqa: E501 +from eZmaxApi.models.billingentityinternalproduct_response_compound import BillingentityinternalproductResponseCompound class TestBillingentityinternalproductResponseCompound(unittest.TestCase): """BillingentityinternalproductResponseCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> BillingentityinternalproductRespons optional params are included """ # uncomment below to create an instance of `BillingentityinternalproductResponseCompound` """ - model = BillingentityinternalproductResponseCompound() # noqa: E501 + model = BillingentityinternalproductResponseCompound() if include_optional: return BillingentityinternalproductResponseCompound( pki_billingentityinternalproduct_id = 254, diff --git a/test/test_branding_autocomplete_element_response.py b/test/test_branding_autocomplete_element_response.py index 847c42a1b..7cc21e178 100644 --- a/test/test_branding_autocomplete_element_response.py +++ b/test/test_branding_autocomplete_element_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.branding_autocomplete_element_response import BrandingAutocompleteElementResponse # noqa: E501 +from eZmaxApi.models.branding_autocomplete_element_response import BrandingAutocompleteElementResponse class TestBrandingAutocompleteElementResponse(unittest.TestCase): """BrandingAutocompleteElementResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> BrandingAutocompleteElementResponse optional params are included """ # uncomment below to create an instance of `BrandingAutocompleteElementResponse` """ - model = BrandingAutocompleteElementResponse() # noqa: E501 + model = BrandingAutocompleteElementResponse() if include_optional: return BrandingAutocompleteElementResponse( s_branding_description_x = 'Company X', diff --git a/test/test_branding_create_object_v1_request.py b/test/test_branding_create_object_v1_request.py index 8f2993869..1a90bc03e 100644 --- a/test/test_branding_create_object_v1_request.py +++ b/test/test_branding_create_object_v1_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.branding_create_object_v1_request import BrandingCreateObjectV1Request # noqa: E501 +from eZmaxApi.models.branding_create_object_v1_request import BrandingCreateObjectV1Request class TestBrandingCreateObjectV1Request(unittest.TestCase): """BrandingCreateObjectV1Request unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> BrandingCreateObjectV1Request: optional params are included """ # uncomment below to create an instance of `BrandingCreateObjectV1Request` """ - model = BrandingCreateObjectV1Request() # noqa: E501 + model = BrandingCreateObjectV1Request() if include_optional: return BrandingCreateObjectV1Request( a_obj_branding = [ diff --git a/test/test_branding_create_object_v1_response.py b/test/test_branding_create_object_v1_response.py index 54bbd16a6..c2a462323 100644 --- a/test/test_branding_create_object_v1_response.py +++ b/test/test_branding_create_object_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.branding_create_object_v1_response import BrandingCreateObjectV1Response # noqa: E501 +from eZmaxApi.models.branding_create_object_v1_response import BrandingCreateObjectV1Response class TestBrandingCreateObjectV1Response(unittest.TestCase): """BrandingCreateObjectV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> BrandingCreateObjectV1Response: optional params are included """ # uncomment below to create an instance of `BrandingCreateObjectV1Response` """ - model = BrandingCreateObjectV1Response() # noqa: E501 + model = BrandingCreateObjectV1Response() if include_optional: return BrandingCreateObjectV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_branding_create_object_v1_response_m_payload.py b/test/test_branding_create_object_v1_response_m_payload.py index 74f526ba4..4ade8c3ee 100644 --- a/test/test_branding_create_object_v1_response_m_payload.py +++ b/test/test_branding_create_object_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.branding_create_object_v1_response_m_payload import BrandingCreateObjectV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.branding_create_object_v1_response_m_payload import BrandingCreateObjectV1ResponseMPayload class TestBrandingCreateObjectV1ResponseMPayload(unittest.TestCase): """BrandingCreateObjectV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> BrandingCreateObjectV1ResponseMPayl optional params are included """ # uncomment below to create an instance of `BrandingCreateObjectV1ResponseMPayload` """ - model = BrandingCreateObjectV1ResponseMPayload() # noqa: E501 + model = BrandingCreateObjectV1ResponseMPayload() if include_optional: return BrandingCreateObjectV1ResponseMPayload( a_pki_branding_id = [ diff --git a/test/test_branding_edit_object_v1_request.py b/test/test_branding_edit_object_v1_request.py index 27961e72f..93898b07f 100644 --- a/test/test_branding_edit_object_v1_request.py +++ b/test/test_branding_edit_object_v1_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.branding_edit_object_v1_request import BrandingEditObjectV1Request # noqa: E501 +from eZmaxApi.models.branding_edit_object_v1_request import BrandingEditObjectV1Request class TestBrandingEditObjectV1Request(unittest.TestCase): """BrandingEditObjectV1Request unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> BrandingEditObjectV1Request: optional params are included """ # uncomment below to create an instance of `BrandingEditObjectV1Request` """ - model = BrandingEditObjectV1Request() # noqa: E501 + model = BrandingEditObjectV1Request() if include_optional: return BrandingEditObjectV1Request( obj_branding = eZmaxApi.models.branding_request_compound.branding-RequestCompound() diff --git a/test/test_branding_edit_object_v1_response.py b/test/test_branding_edit_object_v1_response.py index e11c4faf0..e3c52f022 100644 --- a/test/test_branding_edit_object_v1_response.py +++ b/test/test_branding_edit_object_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.branding_edit_object_v1_response import BrandingEditObjectV1Response # noqa: E501 +from eZmaxApi.models.branding_edit_object_v1_response import BrandingEditObjectV1Response class TestBrandingEditObjectV1Response(unittest.TestCase): """BrandingEditObjectV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> BrandingEditObjectV1Response: optional params are included """ # uncomment below to create an instance of `BrandingEditObjectV1Response` """ - model = BrandingEditObjectV1Response() # noqa: E501 + model = BrandingEditObjectV1Response() if include_optional: return BrandingEditObjectV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_branding_get_autocomplete_v2_response.py b/test/test_branding_get_autocomplete_v2_response.py index 7f8d3a0b9..9cd21f686 100644 --- a/test/test_branding_get_autocomplete_v2_response.py +++ b/test/test_branding_get_autocomplete_v2_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.branding_get_autocomplete_v2_response import BrandingGetAutocompleteV2Response # noqa: E501 +from eZmaxApi.models.branding_get_autocomplete_v2_response import BrandingGetAutocompleteV2Response class TestBrandingGetAutocompleteV2Response(unittest.TestCase): """BrandingGetAutocompleteV2Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> BrandingGetAutocompleteV2Response: optional params are included """ # uncomment below to create an instance of `BrandingGetAutocompleteV2Response` """ - model = BrandingGetAutocompleteV2Response() # noqa: E501 + model = BrandingGetAutocompleteV2Response() if include_optional: return BrandingGetAutocompleteV2Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_branding_get_autocomplete_v2_response_m_payload.py b/test/test_branding_get_autocomplete_v2_response_m_payload.py index cba290059..43a2e3bb6 100644 --- a/test/test_branding_get_autocomplete_v2_response_m_payload.py +++ b/test/test_branding_get_autocomplete_v2_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.branding_get_autocomplete_v2_response_m_payload import BrandingGetAutocompleteV2ResponseMPayload # noqa: E501 +from eZmaxApi.models.branding_get_autocomplete_v2_response_m_payload import BrandingGetAutocompleteV2ResponseMPayload class TestBrandingGetAutocompleteV2ResponseMPayload(unittest.TestCase): """BrandingGetAutocompleteV2ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> BrandingGetAutocompleteV2ResponseMP optional params are included """ # uncomment below to create an instance of `BrandingGetAutocompleteV2ResponseMPayload` """ - model = BrandingGetAutocompleteV2ResponseMPayload() # noqa: E501 + model = BrandingGetAutocompleteV2ResponseMPayload() if include_optional: return BrandingGetAutocompleteV2ResponseMPayload( a_obj_branding = [ diff --git a/test/test_branding_get_list_v1_response.py b/test/test_branding_get_list_v1_response.py index 6b07ba40f..8828a6ba8 100644 --- a/test/test_branding_get_list_v1_response.py +++ b/test/test_branding_get_list_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.branding_get_list_v1_response import BrandingGetListV1Response # noqa: E501 +from eZmaxApi.models.branding_get_list_v1_response import BrandingGetListV1Response class TestBrandingGetListV1Response(unittest.TestCase): """BrandingGetListV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> BrandingGetListV1Response: optional params are included """ # uncomment below to create an instance of `BrandingGetListV1Response` """ - model = BrandingGetListV1Response() # noqa: E501 + model = BrandingGetListV1Response() if include_optional: return BrandingGetListV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload_get_list.Common-Response-objDebugPayload_getList(), diff --git a/test/test_branding_get_list_v1_response_m_payload.py b/test/test_branding_get_list_v1_response_m_payload.py index bf716c36a..af5297a4f 100644 --- a/test/test_branding_get_list_v1_response_m_payload.py +++ b/test/test_branding_get_list_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.branding_get_list_v1_response_m_payload import BrandingGetListV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.branding_get_list_v1_response_m_payload import BrandingGetListV1ResponseMPayload class TestBrandingGetListV1ResponseMPayload(unittest.TestCase): """BrandingGetListV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> BrandingGetListV1ResponseMPayload: optional params are included """ # uncomment below to create an instance of `BrandingGetListV1ResponseMPayload` """ - model = BrandingGetListV1ResponseMPayload() # noqa: E501 + model = BrandingGetListV1ResponseMPayload() if include_optional: return BrandingGetListV1ResponseMPayload( i_row_returned = 100, diff --git a/test/test_branding_get_object_v2_response.py b/test/test_branding_get_object_v2_response.py index 72e5eba96..d92c8ccb0 100644 --- a/test/test_branding_get_object_v2_response.py +++ b/test/test_branding_get_object_v2_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.branding_get_object_v2_response import BrandingGetObjectV2Response # noqa: E501 +from eZmaxApi.models.branding_get_object_v2_response import BrandingGetObjectV2Response class TestBrandingGetObjectV2Response(unittest.TestCase): """BrandingGetObjectV2Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> BrandingGetObjectV2Response: optional params are included """ # uncomment below to create an instance of `BrandingGetObjectV2Response` """ - model = BrandingGetObjectV2Response() # noqa: E501 + model = BrandingGetObjectV2Response() if include_optional: return BrandingGetObjectV2Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_branding_get_object_v2_response_m_payload.py b/test/test_branding_get_object_v2_response_m_payload.py index 7ff7b21ea..dce85162e 100644 --- a/test/test_branding_get_object_v2_response_m_payload.py +++ b/test/test_branding_get_object_v2_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.branding_get_object_v2_response_m_payload import BrandingGetObjectV2ResponseMPayload # noqa: E501 +from eZmaxApi.models.branding_get_object_v2_response_m_payload import BrandingGetObjectV2ResponseMPayload class TestBrandingGetObjectV2ResponseMPayload(unittest.TestCase): """BrandingGetObjectV2ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> BrandingGetObjectV2ResponseMPayload optional params are included """ # uncomment below to create an instance of `BrandingGetObjectV2ResponseMPayload` """ - model = BrandingGetObjectV2ResponseMPayload() # noqa: E501 + model = BrandingGetObjectV2ResponseMPayload() if include_optional: return BrandingGetObjectV2ResponseMPayload( obj_branding = eZmaxApi.models.branding_response_compound.branding-ResponseCompound() diff --git a/test/test_branding_list_element.py b/test/test_branding_list_element.py index 60d9fa606..cabe5e62a 100644 --- a/test/test_branding_list_element.py +++ b/test/test_branding_list_element.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.branding_list_element import BrandingListElement # noqa: E501 +from eZmaxApi.models.branding_list_element import BrandingListElement class TestBrandingListElement(unittest.TestCase): """BrandingListElement unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> BrandingListElement: optional params are included """ # uncomment below to create an instance of `BrandingListElement` """ - model = BrandingListElement() # noqa: E501 + model = BrandingListElement() if include_optional: return BrandingListElement( pki_branding_id = 78, diff --git a/test/test_branding_request.py b/test/test_branding_request.py index 15dfc6a65..8e456b3a2 100644 --- a/test/test_branding_request.py +++ b/test/test_branding_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.branding_request import BrandingRequest # noqa: E501 +from eZmaxApi.models.branding_request import BrandingRequest class TestBrandingRequest(unittest.TestCase): """BrandingRequest unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> BrandingRequest: optional params are included """ # uncomment below to create an instance of `BrandingRequest` """ - model = BrandingRequest() # noqa: E501 + model = BrandingRequest() if include_optional: return BrandingRequest( pki_branding_id = 78, @@ -42,7 +42,7 @@ def make_instance(self, include_optional) -> BrandingRequest: s_branding_description1 = 'Compagnie X', s_branding_description2 = 'Company X', ), e_branding_logo = 'Default', - s_branding_base64 = '[B@2cf92cc7', + s_branding_base64 = '[B@6ffab045', i_branding_colortext = 3752795, i_branding_colortextlinkbox = 0, i_branding_colortextbutton = 16777215, diff --git a/test/test_branding_request_compound.py b/test/test_branding_request_compound.py index bf340506b..df0d3c513 100644 --- a/test/test_branding_request_compound.py +++ b/test/test_branding_request_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.branding_request_compound import BrandingRequestCompound # noqa: E501 +from eZmaxApi.models.branding_request_compound import BrandingRequestCompound class TestBrandingRequestCompound(unittest.TestCase): """BrandingRequestCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> BrandingRequestCompound: optional params are included """ # uncomment below to create an instance of `BrandingRequestCompound` """ - model = BrandingRequestCompound() # noqa: E501 + model = BrandingRequestCompound() if include_optional: return BrandingRequestCompound( pki_branding_id = 78, @@ -42,7 +42,7 @@ def make_instance(self, include_optional) -> BrandingRequestCompound: s_branding_description1 = 'Compagnie X', s_branding_description2 = 'Company X', ), e_branding_logo = 'Default', - s_branding_base64 = '[B@2cf92cc7', + s_branding_base64 = 'eyIkcmVmIjoiIy9jb21wb25lbnRzL2V4YW1wbGVzL1BuZ0FzQmFzZTY0L3ZhbHVlIn0=', i_branding_colortext = 3752795, i_branding_colortextlinkbox = 0, i_branding_colortextbutton = 16777215, diff --git a/test/test_branding_response.py b/test/test_branding_response.py index b200f04df..61eaf49a9 100644 --- a/test/test_branding_response.py +++ b/test/test_branding_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.branding_response import BrandingResponse # noqa: E501 +from eZmaxApi.models.branding_response import BrandingResponse class TestBrandingResponse(unittest.TestCase): """BrandingResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> BrandingResponse: optional params are included """ # uncomment below to create an instance of `BrandingResponse` """ - model = BrandingResponse() # noqa: E501 + model = BrandingResponse() if include_optional: return BrandingResponse( pki_branding_id = 78, diff --git a/test/test_branding_response_compound.py b/test/test_branding_response_compound.py index c3e2c7bed..0dd215bf3 100644 --- a/test/test_branding_response_compound.py +++ b/test/test_branding_response_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.branding_response_compound import BrandingResponseCompound # noqa: E501 +from eZmaxApi.models.branding_response_compound import BrandingResponseCompound class TestBrandingResponseCompound(unittest.TestCase): """BrandingResponseCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> BrandingResponseCompound: optional params are included """ # uncomment below to create an instance of `BrandingResponseCompound` """ - model = BrandingResponseCompound() # noqa: E501 + model = BrandingResponseCompound() if include_optional: return BrandingResponseCompound( pki_branding_id = 78, diff --git a/test/test_buyercontract_get_communication_list_v1_response.py b/test/test_buyercontract_get_communication_list_v1_response.py index e312708a8..5c21c55ea 100644 --- a/test/test_buyercontract_get_communication_list_v1_response.py +++ b/test/test_buyercontract_get_communication_list_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.buyercontract_get_communication_list_v1_response import BuyercontractGetCommunicationListV1Response # noqa: E501 +from eZmaxApi.models.buyercontract_get_communication_list_v1_response import BuyercontractGetCommunicationListV1Response class TestBuyercontractGetCommunicationListV1Response(unittest.TestCase): """BuyercontractGetCommunicationListV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> BuyercontractGetCommunicationListV1 optional params are included """ # uncomment below to create an instance of `BuyercontractGetCommunicationListV1Response` """ - model = BuyercontractGetCommunicationListV1Response() # noqa: E501 + model = BuyercontractGetCommunicationListV1Response() if include_optional: return BuyercontractGetCommunicationListV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload_get_list.Common-Response-objDebugPayload_getList(), diff --git a/test/test_buyercontract_get_communication_list_v1_response_m_payload.py b/test/test_buyercontract_get_communication_list_v1_response_m_payload.py index 4d5acab20..3a4722031 100644 --- a/test/test_buyercontract_get_communication_list_v1_response_m_payload.py +++ b/test/test_buyercontract_get_communication_list_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.buyercontract_get_communication_list_v1_response_m_payload import BuyercontractGetCommunicationListV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.buyercontract_get_communication_list_v1_response_m_payload import BuyercontractGetCommunicationListV1ResponseMPayload class TestBuyercontractGetCommunicationListV1ResponseMPayload(unittest.TestCase): """BuyercontractGetCommunicationListV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> BuyercontractGetCommunicationListV1 optional params are included """ # uncomment below to create an instance of `BuyercontractGetCommunicationListV1ResponseMPayload` """ - model = BuyercontractGetCommunicationListV1ResponseMPayload() # noqa: E501 + model = BuyercontractGetCommunicationListV1ResponseMPayload() if include_optional: return BuyercontractGetCommunicationListV1ResponseMPayload( a_obj_communication = [ diff --git a/test/test_clonehistory_get_list_v1_response.py b/test/test_clonehistory_get_list_v1_response.py index 9faa15ae6..cbceaea97 100644 --- a/test/test_clonehistory_get_list_v1_response.py +++ b/test/test_clonehistory_get_list_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.clonehistory_get_list_v1_response import ClonehistoryGetListV1Response # noqa: E501 +from eZmaxApi.models.clonehistory_get_list_v1_response import ClonehistoryGetListV1Response class TestClonehistoryGetListV1Response(unittest.TestCase): """ClonehistoryGetListV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> ClonehistoryGetListV1Response: optional params are included """ # uncomment below to create an instance of `ClonehistoryGetListV1Response` """ - model = ClonehistoryGetListV1Response() # noqa: E501 + model = ClonehistoryGetListV1Response() if include_optional: return ClonehistoryGetListV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload_get_list.Common-Response-objDebugPayload_getList(), diff --git a/test/test_clonehistory_get_list_v1_response_m_payload.py b/test/test_clonehistory_get_list_v1_response_m_payload.py index 02b7b2019..ab0603aea 100644 --- a/test/test_clonehistory_get_list_v1_response_m_payload.py +++ b/test/test_clonehistory_get_list_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.clonehistory_get_list_v1_response_m_payload import ClonehistoryGetListV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.clonehistory_get_list_v1_response_m_payload import ClonehistoryGetListV1ResponseMPayload class TestClonehistoryGetListV1ResponseMPayload(unittest.TestCase): """ClonehistoryGetListV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> ClonehistoryGetListV1ResponseMPaylo optional params are included """ # uncomment below to create an instance of `ClonehistoryGetListV1ResponseMPayload` """ - model = ClonehistoryGetListV1ResponseMPayload() # noqa: E501 + model = ClonehistoryGetListV1ResponseMPayload() if include_optional: return ClonehistoryGetListV1ResponseMPayload( i_row_returned = 100, diff --git a/test/test_clonehistory_list_element.py b/test/test_clonehistory_list_element.py index 9427b632f..c4414b7b7 100644 --- a/test/test_clonehistory_list_element.py +++ b/test/test_clonehistory_list_element.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.clonehistory_list_element import ClonehistoryListElement # noqa: E501 +from eZmaxApi.models.clonehistory_list_element import ClonehistoryListElement class TestClonehistoryListElement(unittest.TestCase): """ClonehistoryListElement unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> ClonehistoryListElement: optional params are included """ # uncomment below to create an instance of `ClonehistoryListElement` """ - model = ClonehistoryListElement() # noqa: E501 + model = ClonehistoryListElement() if include_optional: return ClonehistoryListElement( pki_clonehistory_id = 12, diff --git a/test/test_common_audit.py b/test/test_common_audit.py index 4680ab1c9..20dc18226 100644 --- a/test/test_common_audit.py +++ b/test/test_common_audit.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.common_audit import CommonAudit # noqa: E501 +from eZmaxApi.models.common_audit import CommonAudit class TestCommonAudit(unittest.TestCase): """CommonAudit unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> CommonAudit: optional params are included """ # uncomment below to create an instance of `CommonAudit` """ - model = CommonAudit() # noqa: E501 + model = CommonAudit() if include_optional: return CommonAudit( obj_auditdetail_created = eZmaxApi.models.common_auditdetail.Common-Auditdetail( diff --git a/test/test_common_auditdetail.py b/test/test_common_auditdetail.py index 7be1b74c7..ecac66fbd 100644 --- a/test/test_common_auditdetail.py +++ b/test/test_common_auditdetail.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.common_auditdetail import CommonAuditdetail # noqa: E501 +from eZmaxApi.models.common_auditdetail import CommonAuditdetail class TestCommonAuditdetail(unittest.TestCase): """CommonAuditdetail unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> CommonAuditdetail: optional params are included """ # uncomment below to create an instance of `CommonAuditdetail` """ - model = CommonAuditdetail() # noqa: E501 + model = CommonAuditdetail() if include_optional: return CommonAuditdetail( fki_user_id = 70, diff --git a/test/test_common_file.py b/test/test_common_file.py index 1670399f4..50148ae71 100644 --- a/test/test_common_file.py +++ b/test/test_common_file.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.common_file import CommonFile # noqa: E501 +from eZmaxApi.models.common_file import CommonFile class TestCommonFile(unittest.TestCase): """CommonFile unit test stubs""" @@ -34,12 +34,12 @@ def make_instance(self, include_optional) -> CommonFile: optional params are included """ # uncomment below to create an instance of `CommonFile` """ - model = CommonFile() # noqa: E501 + model = CommonFile() if include_optional: return CommonFile( s_file_name = 'example.pdf', s_file_url = '', - s_file_base64 = '[B@64337702', + s_file_base64 = '[B@f9d87b', e_file_source = 'Base64' ) else: diff --git a/test/test_common_get_autocomplete_v1_response.py b/test/test_common_get_autocomplete_v1_response.py index e147fe1b5..3d75c74aa 100644 --- a/test/test_common_get_autocomplete_v1_response.py +++ b/test/test_common_get_autocomplete_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.common_get_autocomplete_v1_response import CommonGetAutocompleteV1Response # noqa: E501 +from eZmaxApi.models.common_get_autocomplete_v1_response import CommonGetAutocompleteV1Response class TestCommonGetAutocompleteV1Response(unittest.TestCase): """CommonGetAutocompleteV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> CommonGetAutocompleteV1Response: optional params are included """ # uncomment below to create an instance of `CommonGetAutocompleteV1Response` """ - model = CommonGetAutocompleteV1Response() # noqa: E501 + model = CommonGetAutocompleteV1Response() if include_optional: return CommonGetAutocompleteV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_common_get_list_v1_response_m_payload.py b/test/test_common_get_list_v1_response_m_payload.py index 18ddc1ae1..83b4610e8 100644 --- a/test/test_common_get_list_v1_response_m_payload.py +++ b/test/test_common_get_list_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.common_get_list_v1_response_m_payload import CommonGetListV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.common_get_list_v1_response_m_payload import CommonGetListV1ResponseMPayload class TestCommonGetListV1ResponseMPayload(unittest.TestCase): """CommonGetListV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> CommonGetListV1ResponseMPayload: optional params are included """ # uncomment below to create an instance of `CommonGetListV1ResponseMPayload` """ - model = CommonGetListV1ResponseMPayload() # noqa: E501 + model = CommonGetListV1ResponseMPayload() if include_optional: return CommonGetListV1ResponseMPayload( i_row_returned = 100, diff --git a/test/test_common_get_report_v1_response.py b/test/test_common_get_report_v1_response.py index a46e949fc..1b599fafd 100644 --- a/test/test_common_get_report_v1_response.py +++ b/test/test_common_get_report_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.common_get_report_v1_response import CommonGetReportV1Response # noqa: E501 +from eZmaxApi.models.common_get_report_v1_response import CommonGetReportV1Response class TestCommonGetReportV1Response(unittest.TestCase): """CommonGetReportV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> CommonGetReportV1Response: optional params are included """ # uncomment below to create an instance of `CommonGetReportV1Response` """ - model = CommonGetReportV1Response() # noqa: E501 + model = CommonGetReportV1Response() if include_optional: return CommonGetReportV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_common_get_report_v1_response_m_payload.py b/test/test_common_get_report_v1_response_m_payload.py index 2e461a17e..409f2effc 100644 --- a/test/test_common_get_report_v1_response_m_payload.py +++ b/test/test_common_get_report_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.common_get_report_v1_response_m_payload import CommonGetReportV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.common_get_report_v1_response_m_payload import CommonGetReportV1ResponseMPayload class TestCommonGetReportV1ResponseMPayload(unittest.TestCase): """CommonGetReportV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> CommonGetReportV1ResponseMPayload: optional params are included """ # uncomment below to create an instance of `CommonGetReportV1ResponseMPayload` """ - model = CommonGetReportV1ResponseMPayload() # noqa: E501 + model = CommonGetReportV1ResponseMPayload() if include_optional: return CommonGetReportV1ResponseMPayload( obj_reportgroup = eZmaxApi.models.common_reportgroup.Common-Reportgroup( diff --git a/test/test_common_report.py b/test/test_common_report.py index b802b6dac..0791ead48 100644 --- a/test/test_common_report.py +++ b/test/test_common_report.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.common_report import CommonReport # noqa: E501 +from eZmaxApi.models.common_report import CommonReport class TestCommonReport(unittest.TestCase): """CommonReport unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> CommonReport: optional params are included """ # uncomment below to create an instance of `CommonReport` """ - model = CommonReport() # noqa: E501 + model = CommonReport() if include_optional: return CommonReport( a_obj_reportsection = [ diff --git a/test/test_common_reportcell.py b/test/test_common_reportcell.py index 27ccef7fd..0b672e53d 100644 --- a/test/test_common_reportcell.py +++ b/test/test_common_reportcell.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.common_reportcell import CommonReportcell # noqa: E501 +from eZmaxApi.models.common_reportcell import CommonReportcell class TestCommonReportcell(unittest.TestCase): """CommonReportcell unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> CommonReportcell: optional params are included """ # uncomment below to create an instance of `CommonReportcell` """ - model = CommonReportcell() # noqa: E501 + model = CommonReportcell() if include_optional: return CommonReportcell( i_reportcell_columnspan = 1, diff --git a/test/test_common_reportcellstyle.py b/test/test_common_reportcellstyle.py index e46d6c749..d1a0d99ca 100644 --- a/test/test_common_reportcellstyle.py +++ b/test/test_common_reportcellstyle.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.common_reportcellstyle import CommonReportcellstyle # noqa: E501 +from eZmaxApi.models.common_reportcellstyle import CommonReportcellstyle class TestCommonReportcellstyle(unittest.TestCase): """CommonReportcellstyle unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> CommonReportcellstyle: optional params are included """ # uncomment below to create an instance of `CommonReportcellstyle` """ - model = CommonReportcellstyle() # noqa: E501 + model = CommonReportcellstyle() if include_optional: return CommonReportcellstyle( b_reportcellstyle_bordertop = True, diff --git a/test/test_common_reportcolumn.py b/test/test_common_reportcolumn.py index bf5c87218..5e46ac143 100644 --- a/test/test_common_reportcolumn.py +++ b/test/test_common_reportcolumn.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.common_reportcolumn import CommonReportcolumn # noqa: E501 +from eZmaxApi.models.common_reportcolumn import CommonReportcolumn class TestCommonReportcolumn(unittest.TestCase): """CommonReportcolumn unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> CommonReportcolumn: optional params are included """ # uncomment below to create an instance of `CommonReportcolumn` """ - model = CommonReportcolumn() # noqa: E501 + model = CommonReportcolumn() if include_optional: return CommonReportcolumn( obj_reportcellstyle_default = eZmaxApi.models.common_reportcellstyle.Common-Reportcellstyle( diff --git a/test/test_common_reportgroup.py b/test/test_common_reportgroup.py index 5584f3b92..f72b9cd98 100644 --- a/test/test_common_reportgroup.py +++ b/test/test_common_reportgroup.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.common_reportgroup import CommonReportgroup # noqa: E501 +from eZmaxApi.models.common_reportgroup import CommonReportgroup class TestCommonReportgroup(unittest.TestCase): """CommonReportgroup unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> CommonReportgroup: optional params are included """ # uncomment below to create an instance of `CommonReportgroup` """ - model = CommonReportgroup() # noqa: E501 + model = CommonReportgroup() if include_optional: return CommonReportgroup( a_obj_report = [ diff --git a/test/test_common_reportrow.py b/test/test_common_reportrow.py index b10b9d92f..83d091378 100644 --- a/test/test_common_reportrow.py +++ b/test/test_common_reportrow.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.common_reportrow import CommonReportrow # noqa: E501 +from eZmaxApi.models.common_reportrow import CommonReportrow class TestCommonReportrow(unittest.TestCase): """CommonReportrow unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> CommonReportrow: optional params are included """ # uncomment below to create an instance of `CommonReportrow` """ - model = CommonReportrow() # noqa: E501 + model = CommonReportrow() if include_optional: return CommonReportrow( a_obj_reportcell = [ diff --git a/test/test_common_reportsection.py b/test/test_common_reportsection.py index 3977a64f8..9b4d15a28 100644 --- a/test/test_common_reportsection.py +++ b/test/test_common_reportsection.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.common_reportsection import CommonReportsection # noqa: E501 +from eZmaxApi.models.common_reportsection import CommonReportsection class TestCommonReportsection(unittest.TestCase): """CommonReportsection unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> CommonReportsection: optional params are included """ # uncomment below to create an instance of `CommonReportsection` """ - model = CommonReportsection() # noqa: E501 + model = CommonReportsection() if include_optional: return CommonReportsection( a_obj_reportsubsection = [ diff --git a/test/test_common_reportsubsection.py b/test/test_common_reportsubsection.py index 34962cfe9..470b55ff7 100644 --- a/test/test_common_reportsubsection.py +++ b/test/test_common_reportsubsection.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.common_reportsubsection import CommonReportsubsection # noqa: E501 +from eZmaxApi.models.common_reportsubsection import CommonReportsubsection class TestCommonReportsubsection(unittest.TestCase): """CommonReportsubsection unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> CommonReportsubsection: optional params are included """ # uncomment below to create an instance of `CommonReportsubsection` """ - model = CommonReportsubsection() # noqa: E501 + model = CommonReportsubsection() if include_optional: return CommonReportsubsection( obj_reportsubsectionpart_header = eZmaxApi.models.common_reportsubsectionpart.Common-Reportsubsectionpart( diff --git a/test/test_common_reportsubsectionpart.py b/test/test_common_reportsubsectionpart.py index 8ce6ecb3a..9f3970d23 100644 --- a/test/test_common_reportsubsectionpart.py +++ b/test/test_common_reportsubsectionpart.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.common_reportsubsectionpart import CommonReportsubsectionpart # noqa: E501 +from eZmaxApi.models.common_reportsubsectionpart import CommonReportsubsectionpart class TestCommonReportsubsectionpart(unittest.TestCase): """CommonReportsubsectionpart unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> CommonReportsubsectionpart: optional params are included """ # uncomment below to create an instance of `CommonReportsubsectionpart` """ - model = CommonReportsubsectionpart() # noqa: E501 + model = CommonReportsubsectionpart() if include_optional: return CommonReportsubsectionpart( e_reportsubsectionpart_type = 'Header', diff --git a/test/test_common_response.py b/test/test_common_response.py index 2b16ed9f2..cac9c1beb 100644 --- a/test/test_common_response.py +++ b/test/test_common_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.common_response import CommonResponse # noqa: E501 +from eZmaxApi.models.common_response import CommonResponse class TestCommonResponse(unittest.TestCase): """CommonResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> CommonResponse: optional params are included """ # uncomment below to create an instance of `CommonResponse` """ - model = CommonResponse() # noqa: E501 + model = CommonResponse() if include_optional: return CommonResponse( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_common_response_error.py b/test/test_common_response_error.py index d804468b4..123e0e25c 100644 --- a/test/test_common_response_error.py +++ b/test/test_common_response_error.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.common_response_error import CommonResponseError # noqa: E501 +from eZmaxApi.models.common_response_error import CommonResponseError class TestCommonResponseError(unittest.TestCase): """CommonResponseError unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> CommonResponseError: optional params are included """ # uncomment below to create an instance of `CommonResponseError` """ - model = CommonResponseError() # noqa: E501 + model = CommonResponseError() if include_optional: return CommonResponseError( s_error_message = 'Invalid Signature Headers', diff --git a/test/test_common_response_error_ezsignform_validation.py b/test/test_common_response_error_ezsignform_validation.py index 66dc34bc9..490092dab 100644 --- a/test/test_common_response_error_ezsignform_validation.py +++ b/test/test_common_response_error_ezsignform_validation.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.common_response_error_ezsignform_validation import CommonResponseErrorEzsignformValidation # noqa: E501 +from eZmaxApi.models.common_response_error_ezsignform_validation import CommonResponseErrorEzsignformValidation class TestCommonResponseErrorEzsignformValidation(unittest.TestCase): """CommonResponseErrorEzsignformValidation unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> CommonResponseErrorEzsignformValida optional params are included """ # uncomment below to create an instance of `CommonResponseErrorEzsignformValidation` """ - model = CommonResponseErrorEzsignformValidation() # noqa: E501 + model = CommonResponseErrorEzsignformValidation() if include_optional: return CommonResponseErrorEzsignformValidation( s_error_message = 'Invalid Signature Headers', diff --git a/test/test_common_response_error_s_temporary_file_url.py b/test/test_common_response_error_s_temporary_file_url.py index 795a2aa42..ea958c697 100644 --- a/test/test_common_response_error_s_temporary_file_url.py +++ b/test/test_common_response_error_s_temporary_file_url.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.common_response_error_s_temporary_file_url import CommonResponseErrorSTemporaryFileUrl # noqa: E501 +from eZmaxApi.models.common_response_error_s_temporary_file_url import CommonResponseErrorSTemporaryFileUrl class TestCommonResponseErrorSTemporaryFileUrl(unittest.TestCase): """CommonResponseErrorSTemporaryFileUrl unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> CommonResponseErrorSTemporaryFileUr optional params are included """ # uncomment below to create an instance of `CommonResponseErrorSTemporaryFileUrl` """ - model = CommonResponseErrorSTemporaryFileUrl() # noqa: E501 + model = CommonResponseErrorSTemporaryFileUrl() if include_optional: return CommonResponseErrorSTemporaryFileUrl( s_error_message = 'Invalid Signature Headers', diff --git a/test/test_common_response_error_too_many_requests.py b/test/test_common_response_error_too_many_requests.py index 359eaf4e7..7822e24ca 100644 --- a/test/test_common_response_error_too_many_requests.py +++ b/test/test_common_response_error_too_many_requests.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.common_response_error_too_many_requests import CommonResponseErrorTooManyRequests # noqa: E501 +from eZmaxApi.models.common_response_error_too_many_requests import CommonResponseErrorTooManyRequests class TestCommonResponseErrorTooManyRequests(unittest.TestCase): """CommonResponseErrorTooManyRequests unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> CommonResponseErrorTooManyRequests: optional params are included """ # uncomment below to create an instance of `CommonResponseErrorTooManyRequests` """ - model = CommonResponseErrorTooManyRequests() # noqa: E501 + model = CommonResponseErrorTooManyRequests() if include_optional: return CommonResponseErrorTooManyRequests( s_error_message = 'Invalid Signature Headers', diff --git a/test/test_common_response_filter.py b/test/test_common_response_filter.py index f85a6dda1..4e52b2dd3 100644 --- a/test/test_common_response_filter.py +++ b/test/test_common_response_filter.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.common_response_filter import CommonResponseFilter # noqa: E501 +from eZmaxApi.models.common_response_filter import CommonResponseFilter class TestCommonResponseFilter(unittest.TestCase): """CommonResponseFilter unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> CommonResponseFilter: optional params are included """ # uncomment below to create an instance of `CommonResponseFilter` """ - model = CommonResponseFilter() # noqa: E501 + model = CommonResponseFilter() if include_optional: return CommonResponseFilter( a_auto_type = { diff --git a/test/test_common_response_get_list.py b/test/test_common_response_get_list.py index 680ca817e..680e16aeb 100644 --- a/test/test_common_response_get_list.py +++ b/test/test_common_response_get_list.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.common_response_get_list import CommonResponseGetList # noqa: E501 +from eZmaxApi.models.common_response_get_list import CommonResponseGetList class TestCommonResponseGetList(unittest.TestCase): """CommonResponseGetList unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> CommonResponseGetList: optional params are included """ # uncomment below to create an instance of `CommonResponseGetList` """ - model = CommonResponseGetList() # noqa: E501 + model = CommonResponseGetList() if include_optional: return CommonResponseGetList( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload_get_list.Common-Response-objDebugPayload_getList(), diff --git a/test/test_common_response_obj_debug.py b/test/test_common_response_obj_debug.py index 1e11db6c5..f45a5ad01 100644 --- a/test/test_common_response_obj_debug.py +++ b/test/test_common_response_obj_debug.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug # noqa: E501 +from eZmaxApi.models.common_response_obj_debug import CommonResponseObjDebug class TestCommonResponseObjDebug(unittest.TestCase): """CommonResponseObjDebug unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> CommonResponseObjDebug: optional params are included """ # uncomment below to create an instance of `CommonResponseObjDebug` """ - model = CommonResponseObjDebug() # noqa: E501 + model = CommonResponseObjDebug() if include_optional: return CommonResponseObjDebug( s_memory_usage = '', diff --git a/test/test_common_response_obj_debug_payload.py b/test/test_common_response_obj_debug_payload.py index a90a89679..796522619 100644 --- a/test/test_common_response_obj_debug_payload.py +++ b/test/test_common_response_obj_debug_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload # noqa: E501 +from eZmaxApi.models.common_response_obj_debug_payload import CommonResponseObjDebugPayload class TestCommonResponseObjDebugPayload(unittest.TestCase): """CommonResponseObjDebugPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> CommonResponseObjDebugPayload: optional params are included """ # uncomment below to create an instance of `CommonResponseObjDebugPayload` """ - model = CommonResponseObjDebugPayload() # noqa: E501 + model = CommonResponseObjDebugPayload() if include_optional: return CommonResponseObjDebugPayload( i_version_min = 1, diff --git a/test/test_common_response_obj_debug_payload_get_list.py b/test/test_common_response_obj_debug_payload_get_list.py index 502b5bd49..0b4bb4950 100644 --- a/test/test_common_response_obj_debug_payload_get_list.py +++ b/test/test_common_response_obj_debug_payload_get_list.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.common_response_obj_debug_payload_get_list import CommonResponseObjDebugPayloadGetList # noqa: E501 +from eZmaxApi.models.common_response_obj_debug_payload_get_list import CommonResponseObjDebugPayloadGetList class TestCommonResponseObjDebugPayloadGetList(unittest.TestCase): """CommonResponseObjDebugPayloadGetList unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> CommonResponseObjDebugPayloadGetLis optional params are included """ # uncomment below to create an instance of `CommonResponseObjDebugPayloadGetList` """ - model = CommonResponseObjDebugPayloadGetList() # noqa: E501 + model = CommonResponseObjDebugPayloadGetList() if include_optional: return CommonResponseObjDebugPayloadGetList( i_version_min = 1, diff --git a/test/test_common_response_obj_sql_query.py b/test/test_common_response_obj_sql_query.py index 78bc5a073..2f4a67123 100644 --- a/test/test_common_response_obj_sql_query.py +++ b/test/test_common_response_obj_sql_query.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.common_response_obj_sql_query import CommonResponseObjSQLQuery # noqa: E501 +from eZmaxApi.models.common_response_obj_sql_query import CommonResponseObjSQLQuery class TestCommonResponseObjSQLQuery(unittest.TestCase): """CommonResponseObjSQLQuery unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> CommonResponseObjSQLQuery: optional params are included """ # uncomment below to create an instance of `CommonResponseObjSQLQuery` """ - model = CommonResponseObjSQLQuery() # noqa: E501 + model = CommonResponseObjSQLQuery() if include_optional: return CommonResponseObjSQLQuery( s_query = '', diff --git a/test/test_common_response_redirect_s_secretquestion_text_x.py b/test/test_common_response_redirect_s_secretquestion_text_x.py index 69218caa9..fc9900097 100644 --- a/test/test_common_response_redirect_s_secretquestion_text_x.py +++ b/test/test_common_response_redirect_s_secretquestion_text_x.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.common_response_redirect_s_secretquestion_text_x import CommonResponseRedirectSSecretquestionTextX # noqa: E501 +from eZmaxApi.models.common_response_redirect_s_secretquestion_text_x import CommonResponseRedirectSSecretquestionTextX class TestCommonResponseRedirectSSecretquestionTextX(unittest.TestCase): """CommonResponseRedirectSSecretquestionTextX unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> CommonResponseRedirectSSecretquesti optional params are included """ # uncomment below to create an instance of `CommonResponseRedirectSSecretquestionTextX` """ - model = CommonResponseRedirectSSecretquestionTextX() # noqa: E501 + model = CommonResponseRedirectSSecretquestionTextX() if include_optional: return CommonResponseRedirectSSecretquestionTextX( s_secretquestion_text_x = 'The name of the hospital in which you were born' diff --git a/test/test_common_response_warning.py b/test/test_common_response_warning.py index e3f3e4935..fdfd4ae88 100644 --- a/test/test_common_response_warning.py +++ b/test/test_common_response_warning.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.common_response_warning import CommonResponseWarning # noqa: E501 +from eZmaxApi.models.common_response_warning import CommonResponseWarning class TestCommonResponseWarning(unittest.TestCase): """CommonResponseWarning unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> CommonResponseWarning: optional params are included """ # uncomment below to create an instance of `CommonResponseWarning` """ - model = CommonResponseWarning() # noqa: E501 + model = CommonResponseWarning() if include_optional: return CommonResponseWarning( s_warning_message = '', diff --git a/test/test_common_webhook.py b/test/test_common_webhook.py index b1d67fd70..3a583e744 100644 --- a/test/test_common_webhook.py +++ b/test/test_common_webhook.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.common_webhook import CommonWebhook # noqa: E501 +from eZmaxApi.models.common_webhook import CommonWebhook class TestCommonWebhook(unittest.TestCase): """CommonWebhook unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> CommonWebhook: optional params are included """ # uncomment below to create an instance of `CommonWebhook` """ - model = CommonWebhook() # noqa: E501 + model = CommonWebhook() if include_optional: return CommonWebhook( obj_webhook = eZmaxApi.models.custom_webhook_response.Custom-Webhook-Response(), diff --git a/test/test_communication_create_object_v1_response_m_payload.py b/test/test_communication_create_object_v1_response_m_payload.py index bc26363a3..061d46da3 100644 --- a/test/test_communication_create_object_v1_response_m_payload.py +++ b/test/test_communication_create_object_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.communication_create_object_v1_response_m_payload import CommunicationCreateObjectV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.communication_create_object_v1_response_m_payload import CommunicationCreateObjectV1ResponseMPayload class TestCommunicationCreateObjectV1ResponseMPayload(unittest.TestCase): """CommunicationCreateObjectV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> CommunicationCreateObjectV1Response optional params are included """ # uncomment below to create an instance of `CommunicationCreateObjectV1ResponseMPayload` """ - model = CommunicationCreateObjectV1ResponseMPayload() # noqa: E501 + model = CommunicationCreateObjectV1ResponseMPayload() if include_optional: return CommunicationCreateObjectV1ResponseMPayload( a_pki_communication_id = [ diff --git a/test/test_communication_request.py b/test/test_communication_request.py index f9ceebc13..ea62ec51e 100644 --- a/test/test_communication_request.py +++ b/test/test_communication_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.communication_request import CommunicationRequest # noqa: E501 +from eZmaxApi.models.communication_request import CommunicationRequest class TestCommunicationRequest(unittest.TestCase): """CommunicationRequest unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> CommunicationRequest: optional params are included """ # uncomment below to create an instance of `CommunicationRequest` """ - model = CommunicationRequest() # noqa: E501 + model = CommunicationRequest() if include_optional: return CommunicationRequest( pki_communication_id = 1, @@ -44,6 +44,7 @@ def make_instance(self, include_optional) -> CommunicationRequest: fki_agent_id = 1, fki_broker_id = 26, fki_mailboxshared_id = 47, + fki_phonelineshared_id = 47, fki_user_id = 70, ), s_communication_subject = 'This is an example of subject', t_communication_body = '', diff --git a/test/test_communication_request_compound.py b/test/test_communication_request_compound.py index a8986adbe..67ffe735a 100644 --- a/test/test_communication_request_compound.py +++ b/test/test_communication_request_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.communication_request_compound import CommunicationRequestCompound # noqa: E501 +from eZmaxApi.models.communication_request_compound import CommunicationRequestCompound class TestCommunicationRequestCompound(unittest.TestCase): """CommunicationRequestCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> CommunicationRequestCompound: optional params are included """ # uncomment below to create an instance of `CommunicationRequestCompound` """ - model = CommunicationRequestCompound() # noqa: E501 + model = CommunicationRequestCompound() if include_optional: return CommunicationRequestCompound( pki_communication_id = 1, @@ -44,6 +44,7 @@ def make_instance(self, include_optional) -> CommunicationRequestCompound: fki_agent_id = 1, fki_broker_id = 26, fki_mailboxshared_id = 47, + fki_phonelineshared_id = 47, fki_user_id = 70, ), s_communication_subject = 'This is an example of subject', t_communication_body = '', @@ -57,7 +58,7 @@ def make_instance(self, include_optional) -> CommunicationRequestCompound: obj_communicationexternalattachment = eZmaxApi.models.common_file.Common-File( s_file_name = 'example.pdf', s_file_url = '', - s_file_base64 = '[B@64337702', + s_file_base64 = '[B@f9d87b', e_file_source = 'Base64', ), ) ], a_obj_communicationrecipient = [ @@ -81,7 +82,7 @@ def make_instance(self, include_optional) -> CommunicationRequestCompound: obj_communicationexternalattachment = eZmaxApi.models.common_file.Common-File( s_file_name = 'example.pdf', s_file_url = '', - s_file_base64 = '[B@64337702', + s_file_base64 = '[B@f9d87b', e_file_source = 'Base64', ), ) ], a_obj_communicationrecipient = [ diff --git a/test/test_communication_send_v1_request.py b/test/test_communication_send_v1_request.py index c1185f93a..602dadd13 100644 --- a/test/test_communication_send_v1_request.py +++ b/test/test_communication_send_v1_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.communication_send_v1_request import CommunicationSendV1Request # noqa: E501 +from eZmaxApi.models.communication_send_v1_request import CommunicationSendV1Request class TestCommunicationSendV1Request(unittest.TestCase): """CommunicationSendV1Request unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> CommunicationSendV1Request: optional params are included """ # uncomment below to create an instance of `CommunicationSendV1Request` """ - model = CommunicationSendV1Request() # noqa: E501 + model = CommunicationSendV1Request() if include_optional: return CommunicationSendV1Request( a_obj_communication = [ diff --git a/test/test_communication_send_v1_response.py b/test/test_communication_send_v1_response.py index cdc0aef4a..320a7f8c1 100644 --- a/test/test_communication_send_v1_response.py +++ b/test/test_communication_send_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.communication_send_v1_response import CommunicationSendV1Response # noqa: E501 +from eZmaxApi.models.communication_send_v1_response import CommunicationSendV1Response class TestCommunicationSendV1Response(unittest.TestCase): """CommunicationSendV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> CommunicationSendV1Response: optional params are included """ # uncomment below to create an instance of `CommunicationSendV1Response` """ - model = CommunicationSendV1Response() # noqa: E501 + model = CommunicationSendV1Response() if include_optional: return CommunicationSendV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_communicationattachment_request.py b/test/test_communicationattachment_request.py index d6b2bfb1a..ec73c3079 100644 --- a/test/test_communicationattachment_request.py +++ b/test/test_communicationattachment_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.communicationattachment_request import CommunicationattachmentRequest # noqa: E501 +from eZmaxApi.models.communicationattachment_request import CommunicationattachmentRequest class TestCommunicationattachmentRequest(unittest.TestCase): """CommunicationattachmentRequest unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> CommunicationattachmentRequest: optional params are included """ # uncomment below to create an instance of `CommunicationattachmentRequest` """ - model = CommunicationattachmentRequest() # noqa: E501 + model = CommunicationattachmentRequest() if include_optional: return CommunicationattachmentRequest( pki_communicationattachment_id = 203, diff --git a/test/test_communicationattachment_request_compound.py b/test/test_communicationattachment_request_compound.py index 9a419df55..7f1eaacf4 100644 --- a/test/test_communicationattachment_request_compound.py +++ b/test/test_communicationattachment_request_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.communicationattachment_request_compound import CommunicationattachmentRequestCompound # noqa: E501 +from eZmaxApi.models.communicationattachment_request_compound import CommunicationattachmentRequestCompound class TestCommunicationattachmentRequestCompound(unittest.TestCase): """CommunicationattachmentRequestCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> CommunicationattachmentRequestCompo optional params are included """ # uncomment below to create an instance of `CommunicationattachmentRequestCompound` """ - model = CommunicationattachmentRequestCompound() # noqa: E501 + model = CommunicationattachmentRequestCompound() if include_optional: return CommunicationattachmentRequestCompound( pki_communicationattachment_id = 203, diff --git a/test/test_communicationexternalrecipient_request.py b/test/test_communicationexternalrecipient_request.py index 0e0f4a23f..2072bf572 100644 --- a/test/test_communicationexternalrecipient_request.py +++ b/test/test_communicationexternalrecipient_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.communicationexternalrecipient_request import CommunicationexternalrecipientRequest # noqa: E501 +from eZmaxApi.models.communicationexternalrecipient_request import CommunicationexternalrecipientRequest class TestCommunicationexternalrecipientRequest(unittest.TestCase): """CommunicationexternalrecipientRequest unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> CommunicationexternalrecipientReque optional params are included """ # uncomment below to create an instance of `CommunicationexternalrecipientRequest` """ - model = CommunicationexternalrecipientRequest() # noqa: E501 + model = CommunicationexternalrecipientRequest() if include_optional: return CommunicationexternalrecipientRequest( pki_communicationexternalrecipient_id = 9, @@ -45,7 +45,6 @@ def make_instance(self, include_optional) -> CommunicationexternalrecipientReque ) else: return CommunicationexternalrecipientRequest( - s_communicationexternalrecipient_name = 'John Doe', ) """ diff --git a/test/test_communicationexternalrecipient_request_compound.py b/test/test_communicationexternalrecipient_request_compound.py index e8ba65ef6..6ace3ce05 100644 --- a/test/test_communicationexternalrecipient_request_compound.py +++ b/test/test_communicationexternalrecipient_request_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.communicationexternalrecipient_request_compound import CommunicationexternalrecipientRequestCompound # noqa: E501 +from eZmaxApi.models.communicationexternalrecipient_request_compound import CommunicationexternalrecipientRequestCompound class TestCommunicationexternalrecipientRequestCompound(unittest.TestCase): """CommunicationexternalrecipientRequestCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> CommunicationexternalrecipientReque optional params are included """ # uncomment below to create an instance of `CommunicationexternalrecipientRequestCompound` """ - model = CommunicationexternalrecipientRequestCompound() # noqa: E501 + model = CommunicationexternalrecipientRequestCompound() if include_optional: return CommunicationexternalrecipientRequestCompound( pki_communicationexternalrecipient_id = 9, @@ -45,7 +45,6 @@ def make_instance(self, include_optional) -> CommunicationexternalrecipientReque ) else: return CommunicationexternalrecipientRequestCompound( - s_communicationexternalrecipient_name = 'John Doe', ) """ diff --git a/test/test_communicationrecipient_request.py b/test/test_communicationrecipient_request.py index e5dce622c..f2a0921fa 100644 --- a/test/test_communicationrecipient_request.py +++ b/test/test_communicationrecipient_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.communicationrecipient_request import CommunicationrecipientRequest # noqa: E501 +from eZmaxApi.models.communicationrecipient_request import CommunicationrecipientRequest class TestCommunicationrecipientRequest(unittest.TestCase): """CommunicationrecipientRequest unit test stubs""" @@ -34,13 +34,13 @@ def make_instance(self, include_optional) -> CommunicationrecipientRequest: optional params are included """ # uncomment below to create an instance of `CommunicationrecipientRequest` """ - model = CommunicationrecipientRequest() # noqa: E501 + model = CommunicationrecipientRequest() if include_optional: return CommunicationrecipientRequest( pki_communicationrecipient_id = 1, fki_agent_id = 1, - fki_agentincorporation_id = 1, fki_broker_id = 26, + fki_contact_id = 21, fki_customer_id = 18, fki_employee_id = 31, fki_assistant_id = 1, @@ -49,6 +49,8 @@ def make_instance(self, include_optional) -> CommunicationrecipientRequest: fki_notary_id = 1, fki_supplier_id = 1, fki_user_id = 70, + fki_mailboxshared_id = 47, + fki_phonelineshared_id = 47, e_communicationrecipient_type = 'To' ) else: diff --git a/test/test_communicationrecipient_request_compound.py b/test/test_communicationrecipient_request_compound.py index cf211fbe8..68000ab35 100644 --- a/test/test_communicationrecipient_request_compound.py +++ b/test/test_communicationrecipient_request_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.communicationrecipient_request_compound import CommunicationrecipientRequestCompound # noqa: E501 +from eZmaxApi.models.communicationrecipient_request_compound import CommunicationrecipientRequestCompound class TestCommunicationrecipientRequestCompound(unittest.TestCase): """CommunicationrecipientRequestCompound unit test stubs""" @@ -34,13 +34,13 @@ def make_instance(self, include_optional) -> CommunicationrecipientRequestCompou optional params are included """ # uncomment below to create an instance of `CommunicationrecipientRequestCompound` """ - model = CommunicationrecipientRequestCompound() # noqa: E501 + model = CommunicationrecipientRequestCompound() if include_optional: return CommunicationrecipientRequestCompound( pki_communicationrecipient_id = 1, fki_agent_id = 1, - fki_agentincorporation_id = 1, fki_broker_id = 26, + fki_contact_id = 21, fki_customer_id = 18, fki_employee_id = 31, fki_assistant_id = 1, @@ -49,6 +49,8 @@ def make_instance(self, include_optional) -> CommunicationrecipientRequestCompou fki_notary_id = 1, fki_supplier_id = 1, fki_user_id = 70, + fki_mailboxshared_id = 47, + fki_phonelineshared_id = 47, e_communicationrecipient_type = 'To' ) else: diff --git a/test/test_communicationreference_request.py b/test/test_communicationreference_request.py index 035dff8dc..82ceb5173 100644 --- a/test/test_communicationreference_request.py +++ b/test/test_communicationreference_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.communicationreference_request import CommunicationreferenceRequest # noqa: E501 +from eZmaxApi.models.communicationreference_request import CommunicationreferenceRequest class TestCommunicationreferenceRequest(unittest.TestCase): """CommunicationreferenceRequest unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> CommunicationreferenceRequest: optional params are included """ # uncomment below to create an instance of `CommunicationreferenceRequest` """ - model = CommunicationreferenceRequest() # noqa: E501 + model = CommunicationreferenceRequest() if include_optional: return CommunicationreferenceRequest( pki_communicationreference_id = 1263, diff --git a/test/test_communicationreference_request_compound.py b/test/test_communicationreference_request_compound.py index bcd87237d..183d9a5a6 100644 --- a/test/test_communicationreference_request_compound.py +++ b/test/test_communicationreference_request_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.communicationreference_request_compound import CommunicationreferenceRequestCompound # noqa: E501 +from eZmaxApi.models.communicationreference_request_compound import CommunicationreferenceRequestCompound class TestCommunicationreferenceRequestCompound(unittest.TestCase): """CommunicationreferenceRequestCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> CommunicationreferenceRequestCompou optional params are included """ # uncomment below to create an instance of `CommunicationreferenceRequestCompound` """ - model = CommunicationreferenceRequestCompound() # noqa: E501 + model = CommunicationreferenceRequestCompound() if include_optional: return CommunicationreferenceRequestCompound( pki_communicationreference_id = 1263, diff --git a/test/test_company_autocomplete_element_response.py b/test/test_company_autocomplete_element_response.py index 071bcd469..c933d416e 100644 --- a/test/test_company_autocomplete_element_response.py +++ b/test/test_company_autocomplete_element_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.company_autocomplete_element_response import CompanyAutocompleteElementResponse # noqa: E501 +from eZmaxApi.models.company_autocomplete_element_response import CompanyAutocompleteElementResponse class TestCompanyAutocompleteElementResponse(unittest.TestCase): """CompanyAutocompleteElementResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> CompanyAutocompleteElementResponse: optional params are included """ # uncomment below to create an instance of `CompanyAutocompleteElementResponse` """ - model = CompanyAutocompleteElementResponse() # noqa: E501 + model = CompanyAutocompleteElementResponse() if include_optional: return CompanyAutocompleteElementResponse( pki_company_id = 1, diff --git a/test/test_company_get_autocomplete_v2_response.py b/test/test_company_get_autocomplete_v2_response.py index 62da0e395..17305fc16 100644 --- a/test/test_company_get_autocomplete_v2_response.py +++ b/test/test_company_get_autocomplete_v2_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.company_get_autocomplete_v2_response import CompanyGetAutocompleteV2Response # noqa: E501 +from eZmaxApi.models.company_get_autocomplete_v2_response import CompanyGetAutocompleteV2Response class TestCompanyGetAutocompleteV2Response(unittest.TestCase): """CompanyGetAutocompleteV2Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> CompanyGetAutocompleteV2Response: optional params are included """ # uncomment below to create an instance of `CompanyGetAutocompleteV2Response` """ - model = CompanyGetAutocompleteV2Response() # noqa: E501 + model = CompanyGetAutocompleteV2Response() if include_optional: return CompanyGetAutocompleteV2Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_company_get_autocomplete_v2_response_m_payload.py b/test/test_company_get_autocomplete_v2_response_m_payload.py index 7528acf9f..76b8fe8aa 100644 --- a/test/test_company_get_autocomplete_v2_response_m_payload.py +++ b/test/test_company_get_autocomplete_v2_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.company_get_autocomplete_v2_response_m_payload import CompanyGetAutocompleteV2ResponseMPayload # noqa: E501 +from eZmaxApi.models.company_get_autocomplete_v2_response_m_payload import CompanyGetAutocompleteV2ResponseMPayload class TestCompanyGetAutocompleteV2ResponseMPayload(unittest.TestCase): """CompanyGetAutocompleteV2ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> CompanyGetAutocompleteV2ResponseMPa optional params are included """ # uncomment below to create an instance of `CompanyGetAutocompleteV2ResponseMPayload` """ - model = CompanyGetAutocompleteV2ResponseMPayload() # noqa: E501 + model = CompanyGetAutocompleteV2ResponseMPayload() if include_optional: return CompanyGetAutocompleteV2ResponseMPayload( a_obj_company = [ diff --git a/test/test_computed_e_communication_direction.py b/test/test_computed_e_communication_direction.py index 4a08dec56..dbe055a44 100644 --- a/test/test_computed_e_communication_direction.py +++ b/test/test_computed_e_communication_direction.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.computed_e_communication_direction import ComputedECommunicationDirection # noqa: E501 +from eZmaxApi.models.computed_e_communication_direction import ComputedECommunicationDirection class TestComputedECommunicationDirection(unittest.TestCase): """ComputedECommunicationDirection unit test stubs""" diff --git a/test/test_computed_e_ezsigndocument_steptype.py b/test/test_computed_e_ezsigndocument_steptype.py index 5ec28c75e..7dea1ccf1 100644 --- a/test/test_computed_e_ezsigndocument_steptype.py +++ b/test/test_computed_e_ezsigndocument_steptype.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.computed_e_ezsigndocument_steptype import ComputedEEzsigndocumentSteptype # noqa: E501 +from eZmaxApi.models.computed_e_ezsigndocument_steptype import ComputedEEzsigndocumentSteptype class TestComputedEEzsigndocumentSteptype(unittest.TestCase): """ComputedEEzsigndocumentSteptype unit test stubs""" diff --git a/test/test_contact_request.py b/test/test_contact_request.py index 1778e30b3..25dbd3a18 100644 --- a/test/test_contact_request.py +++ b/test/test_contact_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.contact_request import ContactRequest # noqa: E501 +from eZmaxApi.models.contact_request import ContactRequest class TestContactRequest(unittest.TestCase): """ContactRequest unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> ContactRequest: optional params are included """ # uncomment below to create an instance of `ContactRequest` """ - model = ContactRequest() # noqa: E501 + model = ContactRequest() if include_optional: return ContactRequest( fki_contacttitle_id = 2, diff --git a/test/test_contact_request_compound.py b/test/test_contact_request_compound.py index 0061cda56..169925d14 100644 --- a/test/test_contact_request_compound.py +++ b/test/test_contact_request_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.contact_request_compound import ContactRequestCompound # noqa: E501 +from eZmaxApi.models.contact_request_compound import ContactRequestCompound class TestContactRequestCompound(unittest.TestCase): """ContactRequestCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> ContactRequestCompound: optional params are included """ # uncomment below to create an instance of `ContactRequestCompound` """ - model = ContactRequestCompound() # noqa: E501 + model = ContactRequestCompound() if include_optional: return ContactRequestCompound( fki_contacttitle_id = 2, diff --git a/test/test_contactinformations_request.py b/test/test_contactinformations_request.py index e475d2901..90ca4a8e6 100644 --- a/test/test_contactinformations_request.py +++ b/test/test_contactinformations_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.contactinformations_request import ContactinformationsRequest # noqa: E501 +from eZmaxApi.models.contactinformations_request import ContactinformationsRequest class TestContactinformationsRequest(unittest.TestCase): """ContactinformationsRequest unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> ContactinformationsRequest: optional params are included """ # uncomment below to create an instance of `ContactinformationsRequest` """ - model = ContactinformationsRequest() # noqa: E501 + model = ContactinformationsRequest() if include_optional: return ContactinformationsRequest( i_address_default = 56, diff --git a/test/test_contactinformations_request_compound.py b/test/test_contactinformations_request_compound.py index 0b73d50d6..256888404 100644 --- a/test/test_contactinformations_request_compound.py +++ b/test/test_contactinformations_request_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.contactinformations_request_compound import ContactinformationsRequestCompound # noqa: E501 +from eZmaxApi.models.contactinformations_request_compound import ContactinformationsRequestCompound class TestContactinformationsRequestCompound(unittest.TestCase): """ContactinformationsRequestCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> ContactinformationsRequestCompound: optional params are included """ # uncomment below to create an instance of `ContactinformationsRequestCompound` """ - model = ContactinformationsRequestCompound() # noqa: E501 + model = ContactinformationsRequestCompound() if include_optional: return ContactinformationsRequestCompound( i_address_default = 56, diff --git a/test/test_cors_create_object_v1_request.py b/test/test_cors_create_object_v1_request.py index 4a9c509ac..5a8fa1fd1 100644 --- a/test/test_cors_create_object_v1_request.py +++ b/test/test_cors_create_object_v1_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.cors_create_object_v1_request import CorsCreateObjectV1Request # noqa: E501 +from eZmaxApi.models.cors_create_object_v1_request import CorsCreateObjectV1Request class TestCorsCreateObjectV1Request(unittest.TestCase): """CorsCreateObjectV1Request unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> CorsCreateObjectV1Request: optional params are included """ # uncomment below to create an instance of `CorsCreateObjectV1Request` """ - model = CorsCreateObjectV1Request() # noqa: E501 + model = CorsCreateObjectV1Request() if include_optional: return CorsCreateObjectV1Request( a_obj_cors = [ diff --git a/test/test_cors_create_object_v1_response.py b/test/test_cors_create_object_v1_response.py index 0872f489b..77d5bbdaf 100644 --- a/test/test_cors_create_object_v1_response.py +++ b/test/test_cors_create_object_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.cors_create_object_v1_response import CorsCreateObjectV1Response # noqa: E501 +from eZmaxApi.models.cors_create_object_v1_response import CorsCreateObjectV1Response class TestCorsCreateObjectV1Response(unittest.TestCase): """CorsCreateObjectV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> CorsCreateObjectV1Response: optional params are included """ # uncomment below to create an instance of `CorsCreateObjectV1Response` """ - model = CorsCreateObjectV1Response() # noqa: E501 + model = CorsCreateObjectV1Response() if include_optional: return CorsCreateObjectV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_cors_create_object_v1_response_m_payload.py b/test/test_cors_create_object_v1_response_m_payload.py index 016a293d5..21fd4e057 100644 --- a/test/test_cors_create_object_v1_response_m_payload.py +++ b/test/test_cors_create_object_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.cors_create_object_v1_response_m_payload import CorsCreateObjectV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.cors_create_object_v1_response_m_payload import CorsCreateObjectV1ResponseMPayload class TestCorsCreateObjectV1ResponseMPayload(unittest.TestCase): """CorsCreateObjectV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> CorsCreateObjectV1ResponseMPayload: optional params are included """ # uncomment below to create an instance of `CorsCreateObjectV1ResponseMPayload` """ - model = CorsCreateObjectV1ResponseMPayload() # noqa: E501 + model = CorsCreateObjectV1ResponseMPayload() if include_optional: return CorsCreateObjectV1ResponseMPayload( a_pki_cors_id = [ diff --git a/test/test_cors_delete_object_v1_response.py b/test/test_cors_delete_object_v1_response.py index 8139b3702..4fb364c86 100644 --- a/test/test_cors_delete_object_v1_response.py +++ b/test/test_cors_delete_object_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.cors_delete_object_v1_response import CorsDeleteObjectV1Response # noqa: E501 +from eZmaxApi.models.cors_delete_object_v1_response import CorsDeleteObjectV1Response class TestCorsDeleteObjectV1Response(unittest.TestCase): """CorsDeleteObjectV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> CorsDeleteObjectV1Response: optional params are included """ # uncomment below to create an instance of `CorsDeleteObjectV1Response` """ - model = CorsDeleteObjectV1Response() # noqa: E501 + model = CorsDeleteObjectV1Response() if include_optional: return CorsDeleteObjectV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_cors_edit_object_v1_request.py b/test/test_cors_edit_object_v1_request.py index 7c3925101..e900db2e0 100644 --- a/test/test_cors_edit_object_v1_request.py +++ b/test/test_cors_edit_object_v1_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.cors_edit_object_v1_request import CorsEditObjectV1Request # noqa: E501 +from eZmaxApi.models.cors_edit_object_v1_request import CorsEditObjectV1Request class TestCorsEditObjectV1Request(unittest.TestCase): """CorsEditObjectV1Request unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> CorsEditObjectV1Request: optional params are included """ # uncomment below to create an instance of `CorsEditObjectV1Request` """ - model = CorsEditObjectV1Request() # noqa: E501 + model = CorsEditObjectV1Request() if include_optional: return CorsEditObjectV1Request( obj_cors = eZmaxApi.models.cors_request_compound.cors-RequestCompound() diff --git a/test/test_cors_edit_object_v1_response.py b/test/test_cors_edit_object_v1_response.py index 24b836bfd..7d4af1b56 100644 --- a/test/test_cors_edit_object_v1_response.py +++ b/test/test_cors_edit_object_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.cors_edit_object_v1_response import CorsEditObjectV1Response # noqa: E501 +from eZmaxApi.models.cors_edit_object_v1_response import CorsEditObjectV1Response class TestCorsEditObjectV1Response(unittest.TestCase): """CorsEditObjectV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> CorsEditObjectV1Response: optional params are included """ # uncomment below to create an instance of `CorsEditObjectV1Response` """ - model = CorsEditObjectV1Response() # noqa: E501 + model = CorsEditObjectV1Response() if include_optional: return CorsEditObjectV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_cors_get_object_v2_response.py b/test/test_cors_get_object_v2_response.py index f6017de45..21ed55a25 100644 --- a/test/test_cors_get_object_v2_response.py +++ b/test/test_cors_get_object_v2_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.cors_get_object_v2_response import CorsGetObjectV2Response # noqa: E501 +from eZmaxApi.models.cors_get_object_v2_response import CorsGetObjectV2Response class TestCorsGetObjectV2Response(unittest.TestCase): """CorsGetObjectV2Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> CorsGetObjectV2Response: optional params are included """ # uncomment below to create an instance of `CorsGetObjectV2Response` """ - model = CorsGetObjectV2Response() # noqa: E501 + model = CorsGetObjectV2Response() if include_optional: return CorsGetObjectV2Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_cors_get_object_v2_response_m_payload.py b/test/test_cors_get_object_v2_response_m_payload.py index 2c5f85f02..a67036426 100644 --- a/test/test_cors_get_object_v2_response_m_payload.py +++ b/test/test_cors_get_object_v2_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.cors_get_object_v2_response_m_payload import CorsGetObjectV2ResponseMPayload # noqa: E501 +from eZmaxApi.models.cors_get_object_v2_response_m_payload import CorsGetObjectV2ResponseMPayload class TestCorsGetObjectV2ResponseMPayload(unittest.TestCase): """CorsGetObjectV2ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> CorsGetObjectV2ResponseMPayload: optional params are included """ # uncomment below to create an instance of `CorsGetObjectV2ResponseMPayload` """ - model = CorsGetObjectV2ResponseMPayload() # noqa: E501 + model = CorsGetObjectV2ResponseMPayload() if include_optional: return CorsGetObjectV2ResponseMPayload( obj_cors = eZmaxApi.models.cors_response_compound.cors-ResponseCompound() diff --git a/test/test_cors_request.py b/test/test_cors_request.py index 4bf884825..1aba24780 100644 --- a/test/test_cors_request.py +++ b/test/test_cors_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.cors_request import CorsRequest # noqa: E501 +from eZmaxApi.models.cors_request import CorsRequest class TestCorsRequest(unittest.TestCase): """CorsRequest unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> CorsRequest: optional params are included """ # uncomment below to create an instance of `CorsRequest` """ - model = CorsRequest() # noqa: E501 + model = CorsRequest() if include_optional: return CorsRequest( pki_cors_id = 228, diff --git a/test/test_cors_request_compound.py b/test/test_cors_request_compound.py index 8565e6cf3..7089ae4aa 100644 --- a/test/test_cors_request_compound.py +++ b/test/test_cors_request_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.cors_request_compound import CorsRequestCompound # noqa: E501 +from eZmaxApi.models.cors_request_compound import CorsRequestCompound class TestCorsRequestCompound(unittest.TestCase): """CorsRequestCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> CorsRequestCompound: optional params are included """ # uncomment below to create an instance of `CorsRequestCompound` """ - model = CorsRequestCompound() # noqa: E501 + model = CorsRequestCompound() if include_optional: return CorsRequestCompound( pki_cors_id = 228, diff --git a/test/test_cors_response.py b/test/test_cors_response.py index 8eaaf0f52..4d9b3146f 100644 --- a/test/test_cors_response.py +++ b/test/test_cors_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.cors_response import CorsResponse # noqa: E501 +from eZmaxApi.models.cors_response import CorsResponse class TestCorsResponse(unittest.TestCase): """CorsResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> CorsResponse: optional params are included """ # uncomment below to create an instance of `CorsResponse` """ - model = CorsResponse() # noqa: E501 + model = CorsResponse() if include_optional: return CorsResponse( pki_cors_id = 228, diff --git a/test/test_cors_response_compound.py b/test/test_cors_response_compound.py index 0e49abf78..8d4b1ef07 100644 --- a/test/test_cors_response_compound.py +++ b/test/test_cors_response_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.cors_response_compound import CorsResponseCompound # noqa: E501 +from eZmaxApi.models.cors_response_compound import CorsResponseCompound class TestCorsResponseCompound(unittest.TestCase): """CorsResponseCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> CorsResponseCompound: optional params are included """ # uncomment below to create an instance of `CorsResponseCompound` """ - model = CorsResponseCompound() # noqa: E501 + model = CorsResponseCompound() if include_optional: return CorsResponseCompound( pki_cors_id = 228, diff --git a/test/test_custom_attachment_response.py b/test/test_custom_attachment_response.py new file mode 100644 index 000000000..a4283777c --- /dev/null +++ b/test/test_custom_attachment_response.py @@ -0,0 +1,147 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest +import datetime + +from eZmaxApi.models.custom_attachment_response import CustomAttachmentResponse + +class TestCustomAttachmentResponse(unittest.TestCase): + """CustomAttachmentResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> CustomAttachmentResponse: + """Test CustomAttachmentResponse + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `CustomAttachmentResponse` + """ + model = CustomAttachmentResponse() + if include_optional: + return CustomAttachmentResponse( + pki_attachment_id = 1, + fki_computer_id = 249, + fki_adjustment_id = 202, + fki_agent_id = 1, + fki_bankaccount_id = 46, + fki_broker_id = 26, + fki_commissionadvance_id = 115, + fki_communication_id = 1, + fki_customer_id = 18, + fki_customertemplate_id = 152, + fki_deposit_id = 54, + fki_deposittransitcheque_id = 251, + fki_electronicfundstransfer_id = 1262, + fki_employee_id = 31, + fki_externalbroker_id = 1, + fki_ezcomadvanceserver_id = 238, + fki_ezcomcompany_id = 170, + fki_ezsigndocument_id = 97, + fki_ghacqcontract_id = 217, + fki_inscription_id = 17, + fki_inscriptiontemp_id = 2445, + fki_inscriptionnotauthenticated_id = 24, + fki_invoice_id = 1, + fki_buyercontract_id = 38, + fki_franchisebroker_id = 61, + fki_franchiseagence_id = 117, + fki_franchiseoffice_id = 50, + fki_franchisefranchise_id = 156, + fki_franchisecomplaint_id = 24, + fki_lead_id = 117, + fki_marketingprogram_id = 178, + fki_marketingfollow_id = 45, + fki_notary_id = 1, + fki_officetaxreport_id = 200, + fki_otherincome_id = 142, + fki_paymentpreparation_id = 124, + fki_purchase_id = 155, + fki_salary_id = 73, + fki_supplier_id = 1, + fki_tranqcontract_id = 39, + fki_template_id = 232, + fki_inscriptionchecklist_id = 191, + fki_folder_id = 81, + fki_rejectedoffertopurchase_id = 532, + fki_disclosure_id = 51, + fki_reconciliation_id = 140, + fki_ezsigndocument_id_reference = 97, + e_attachment_documenttype = 'Adjustment', + s_attachment_name = 'Document.pdf', + e_attachment_privacy = 'All', + fki_user_id_specific = 70, + e_attachment_type = 'Other', + i_attachment_size = 277465200, + i_attachment_ed_mmoduleflag = 65, + s_attachment_md5 = '2cb29026e8a93c930e71598579400db6', + b_attachment_deleted = False, + b_attachment_valid = True, + e_attachment_verified = 'No', + t_attachment_rejectioncomment = 'Unreadable', + fki_user_id_owner = 70, + obj_audit = eZmaxApi.models.common_audit.Common-Audit( + obj_auditdetail_created = eZmaxApi.models.common_auditdetail.Common-Auditdetail( + fki_user_id = 70, + fki_apikey_id = 99, + s_user_loginname = 'JohnDoe', + s_user_lastname = 'Doe', + s_user_firstname = 'John', + s_apikey_description_x = 'Project X', + dt_auditdetail_date = '2020-12-31 23:59:59', ), + obj_auditdetail_modified = eZmaxApi.models.common_auditdetail.Common-Auditdetail( + fki_user_id = 70, + fki_apikey_id = 99, + s_user_loginname = 'JohnDoe', + s_user_lastname = 'Doe', + s_user_firstname = 'John', + s_apikey_description_x = 'Project X', + dt_auditdetail_date = '2020-12-31 23:59:59', ), ), + obj_attachment_proof = eZmaxApi.models.attachment_response_compound.attachment-ResponseCompound(), + obj_attachment_proofdocument = eZmaxApi.models.attachment_response_compound.attachment-ResponseCompound(), + a_obj_attachment_attachment = [ + eZmaxApi.models.attachment_response_compound.attachment-ResponseCompound() + ], + a_obj_attachment_version = [ + eZmaxApi.models.attachment_response_compound.attachment-ResponseCompound() + ] + ) + else: + return CustomAttachmentResponse( + pki_attachment_id = 1, + e_attachment_documenttype = 'Adjustment', + s_attachment_name = 'Document.pdf', + e_attachment_privacy = 'All', + e_attachment_type = 'Other', + i_attachment_size = 277465200, + s_attachment_md5 = '2cb29026e8a93c930e71598579400db6', + b_attachment_deleted = False, + b_attachment_valid = True, + e_attachment_verified = 'No', + ) + """ + + def testCustomAttachmentResponse(self): + """Test CustomAttachmentResponse""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_custom_attachmentdocumenttype_response.py b/test/test_custom_attachmentdocumenttype_response.py new file mode 100644 index 000000000..03e2bdffb --- /dev/null +++ b/test/test_custom_attachmentdocumenttype_response.py @@ -0,0 +1,60 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest +import datetime + +from eZmaxApi.models.custom_attachmentdocumenttype_response import CustomAttachmentdocumenttypeResponse + +class TestCustomAttachmentdocumenttypeResponse(unittest.TestCase): + """CustomAttachmentdocumenttypeResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> CustomAttachmentdocumenttypeResponse: + """Test CustomAttachmentdocumenttypeResponse + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `CustomAttachmentdocumenttypeResponse` + """ + model = CustomAttachmentdocumenttypeResponse() + if include_optional: + return CustomAttachmentdocumenttypeResponse( + e_attachment_documenttype = 'Adjustment', + a_obj_attachment = [ + eZmaxApi.models.custom_attachment_response.Custom-Attachment-Response() + ] + ) + else: + return CustomAttachmentdocumenttypeResponse( + e_attachment_documenttype = 'Adjustment', + a_obj_attachment = [ + eZmaxApi.models.custom_attachment_response.Custom-Attachment-Response() + ], + ) + """ + + def testCustomAttachmentdocumenttypeResponse(self): + """Test CustomAttachmentdocumenttypeResponse""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_custom_autocomplete_element_response.py b/test/test_custom_autocomplete_element_response.py index 8b08a4ab6..0fd8bd339 100644 --- a/test/test_custom_autocomplete_element_response.py +++ b/test/test_custom_autocomplete_element_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.custom_autocomplete_element_response import CustomAutocompleteElementResponse # noqa: E501 +from eZmaxApi.models.custom_autocomplete_element_response import CustomAutocompleteElementResponse class TestCustomAutocompleteElementResponse(unittest.TestCase): """CustomAutocompleteElementResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> CustomAutocompleteElementResponse: optional params are included """ # uncomment below to create an instance of `CustomAutocompleteElementResponse` """ - model = CustomAutocompleteElementResponse() # noqa: E501 + model = CustomAutocompleteElementResponse() if include_optional: return CustomAutocompleteElementResponse( s_category = '', diff --git a/test/test_custom_communication_list_element_response.py b/test/test_custom_communication_list_element_response.py index f74a6e08a..5aaccfaee 100644 --- a/test/test_custom_communication_list_element_response.py +++ b/test/test_custom_communication_list_element_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.custom_communication_list_element_response import CustomCommunicationListElementResponse # noqa: E501 +from eZmaxApi.models.custom_communication_list_element_response import CustomCommunicationListElementResponse class TestCustomCommunicationListElementResponse(unittest.TestCase): """CustomCommunicationListElementResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> CustomCommunicationListElementRespo optional params are included """ # uncomment below to create an instance of `CustomCommunicationListElementResponse` """ - model = CustomCommunicationListElementResponse() # noqa: E501 + model = CustomCommunicationListElementResponse() if include_optional: return CustomCommunicationListElementResponse( pki_communication_id = 1, diff --git a/test/test_custom_communicationattachment_request.py b/test/test_custom_communicationattachment_request.py index a29dfbfaa..ffe35c7af 100644 --- a/test/test_custom_communicationattachment_request.py +++ b/test/test_custom_communicationattachment_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.custom_communicationattachment_request import CustomCommunicationattachmentRequest # noqa: E501 +from eZmaxApi.models.custom_communicationattachment_request import CustomCommunicationattachmentRequest class TestCustomCommunicationattachmentRequest(unittest.TestCase): """CustomCommunicationattachmentRequest unit test stubs""" @@ -34,14 +34,14 @@ def make_instance(self, include_optional) -> CustomCommunicationattachmentReques optional params are included """ # uncomment below to create an instance of `CustomCommunicationattachmentRequest` """ - model = CustomCommunicationattachmentRequest() # noqa: E501 + model = CustomCommunicationattachmentRequest() if include_optional: return CustomCommunicationattachmentRequest( obj_communicationattachment = eZmaxApi.models.communicationattachment_request_compound.communicationattachment-RequestCompound(), obj_communicationexternalattachment = eZmaxApi.models.common_file.Common-File( s_file_name = 'example.pdf', s_file_url = '', - s_file_base64 = '[B@64337702', + s_file_base64 = '[B@f9d87b', e_file_source = 'Base64', ) ) else: diff --git a/test/test_custom_communicationrecipientsgroup_response.py b/test/test_custom_communicationrecipientsgroup_response.py index c8786d655..a5c8f9265 100644 --- a/test/test_custom_communicationrecipientsgroup_response.py +++ b/test/test_custom_communicationrecipientsgroup_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.custom_communicationrecipientsgroup_response import CustomCommunicationrecipientsgroupResponse # noqa: E501 +from eZmaxApi.models.custom_communicationrecipientsgroup_response import CustomCommunicationrecipientsgroupResponse class TestCustomCommunicationrecipientsgroupResponse(unittest.TestCase): """CustomCommunicationrecipientsgroupResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> CustomCommunicationrecipientsgroupR optional params are included """ # uncomment below to create an instance of `CustomCommunicationrecipientsgroupResponse` """ - model = CustomCommunicationrecipientsgroupResponse() # noqa: E501 + model = CustomCommunicationrecipientsgroupResponse() if include_optional: return CustomCommunicationrecipientsgroupResponse( s_communicationrecipientsgroup_label = '', diff --git a/test/test_custom_communicationrecipientsrecipient_response.py b/test/test_custom_communicationrecipientsrecipient_response.py index 23af31b1b..ba1107a01 100644 --- a/test/test_custom_communicationrecipientsrecipient_response.py +++ b/test/test_custom_communicationrecipientsrecipient_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.custom_communicationrecipientsrecipient_response import CustomCommunicationrecipientsrecipientResponse # noqa: E501 +from eZmaxApi.models.custom_communicationrecipientsrecipient_response import CustomCommunicationrecipientsrecipientResponse class TestCustomCommunicationrecipientsrecipientResponse(unittest.TestCase): """CustomCommunicationrecipientsrecipientResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> CustomCommunicationrecipientsrecipi optional params are included """ # uncomment below to create an instance of `CustomCommunicationrecipientsrecipientResponse` """ - model = CustomCommunicationrecipientsrecipientResponse() # noqa: E501 + model = CustomCommunicationrecipientsrecipientResponse() if include_optional: return CustomCommunicationrecipientsrecipientResponse( fki_agent_id = 1, diff --git a/test/test_custom_communicationsender_request.py b/test/test_custom_communicationsender_request.py index b482f6548..9a5c9e5c1 100644 --- a/test/test_custom_communicationsender_request.py +++ b/test/test_custom_communicationsender_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.custom_communicationsender_request import CustomCommunicationsenderRequest # noqa: E501 +from eZmaxApi.models.custom_communicationsender_request import CustomCommunicationsenderRequest class TestCustomCommunicationsenderRequest(unittest.TestCase): """CustomCommunicationsenderRequest unit test stubs""" @@ -34,12 +34,13 @@ def make_instance(self, include_optional) -> CustomCommunicationsenderRequest: optional params are included """ # uncomment below to create an instance of `CustomCommunicationsenderRequest` """ - model = CustomCommunicationsenderRequest() # noqa: E501 + model = CustomCommunicationsenderRequest() if include_optional: return CustomCommunicationsenderRequest( fki_agent_id = 1, fki_broker_id = 26, fki_mailboxshared_id = 47, + fki_phonelineshared_id = 47, fki_user_id = 70 ) else: diff --git a/test/test_custom_communicationsender_response.py b/test/test_custom_communicationsender_response.py index 12f3169c7..1f0e50111 100644 --- a/test/test_custom_communicationsender_response.py +++ b/test/test_custom_communicationsender_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.custom_communicationsender_response import CustomCommunicationsenderResponse # noqa: E501 +from eZmaxApi.models.custom_communicationsender_response import CustomCommunicationsenderResponse class TestCustomCommunicationsenderResponse(unittest.TestCase): """CustomCommunicationsenderResponse unit test stubs""" @@ -34,20 +34,22 @@ def make_instance(self, include_optional) -> CustomCommunicationsenderResponse: optional params are included """ # uncomment below to create an instance of `CustomCommunicationsenderResponse` """ - model = CustomCommunicationsenderResponse() # noqa: E501 + model = CustomCommunicationsenderResponse() if include_optional: return CustomCommunicationsenderResponse( fki_agent_id = 1, fki_broker_id = 26, fki_user_id = 70, fki_mailboxshared_id = 47, + fki_phonelineshared_id = 47, e_communicationsender_objecttype = 'User', obj_contact_name = eZmaxApi.models.custom_contact_name_response.Custom-ContactName-Response( s_contact_firstname = 'John', s_contact_lastname = 'Doe', s_contact_company = 'eZmax Solutions Inc.', ), - s_email_address = 'email@example.com', - s_phone_e164 = '+15149901516' + obj_email = eZmaxApi.models.email_response_compound.email-ResponseCompound(), + obj_phone_fax = eZmaxApi.models.phone_response_compound.phone-ResponseCompound(), + obj_phone_sms = eZmaxApi.models.phone_response_compound.phone-ResponseCompound() ) else: return CustomCommunicationsenderResponse( diff --git a/test/test_custom_contact_name_response.py b/test/test_custom_contact_name_response.py index 76da5a23c..3ea62a748 100644 --- a/test/test_custom_contact_name_response.py +++ b/test/test_custom_contact_name_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.custom_contact_name_response import CustomContactNameResponse # noqa: E501 +from eZmaxApi.models.custom_contact_name_response import CustomContactNameResponse class TestCustomContactNameResponse(unittest.TestCase): """CustomContactNameResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> CustomContactNameResponse: optional params are included """ # uncomment below to create an instance of `CustomContactNameResponse` """ - model = CustomContactNameResponse() # noqa: E501 + model = CustomContactNameResponse() if include_optional: return CustomContactNameResponse( s_contact_firstname = 'John', diff --git a/test/test_custom_creditcardtransaction_response.py b/test/test_custom_creditcardtransaction_response.py index 25624b950..dbf8241a3 100644 --- a/test/test_custom_creditcardtransaction_response.py +++ b/test/test_custom_creditcardtransaction_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.custom_creditcardtransaction_response import CustomCreditcardtransactionResponse # noqa: E501 +from eZmaxApi.models.custom_creditcardtransaction_response import CustomCreditcardtransactionResponse class TestCustomCreditcardtransactionResponse(unittest.TestCase): """CustomCreditcardtransactionResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> CustomCreditcardtransactionResponse optional params are included """ # uncomment below to create an instance of `CustomCreditcardtransactionResponse` """ - model = CustomCreditcardtransactionResponse() # noqa: E501 + model = CustomCreditcardtransactionResponse() if include_optional: return CustomCreditcardtransactionResponse( e_creditcardtype_codename = 'visa', diff --git a/test/test_custom_dropdown_element_request.py b/test/test_custom_dropdown_element_request.py index 86adc7616..da99cd4db 100644 --- a/test/test_custom_dropdown_element_request.py +++ b/test/test_custom_dropdown_element_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.custom_dropdown_element_request import CustomDropdownElementRequest # noqa: E501 +from eZmaxApi.models.custom_dropdown_element_request import CustomDropdownElementRequest class TestCustomDropdownElementRequest(unittest.TestCase): """CustomDropdownElementRequest unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> CustomDropdownElementRequest: optional params are included """ # uncomment below to create an instance of `CustomDropdownElementRequest` """ - model = CustomDropdownElementRequest() # noqa: E501 + model = CustomDropdownElementRequest() if include_optional: return CustomDropdownElementRequest( s_label = '', diff --git a/test/test_custom_dropdown_element_request_compound.py b/test/test_custom_dropdown_element_request_compound.py index 77f8151a6..5385eb0c7 100644 --- a/test/test_custom_dropdown_element_request_compound.py +++ b/test/test_custom_dropdown_element_request_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.custom_dropdown_element_request_compound import CustomDropdownElementRequestCompound # noqa: E501 +from eZmaxApi.models.custom_dropdown_element_request_compound import CustomDropdownElementRequestCompound class TestCustomDropdownElementRequestCompound(unittest.TestCase): """CustomDropdownElementRequestCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> CustomDropdownElementRequestCompoun optional params are included """ # uncomment below to create an instance of `CustomDropdownElementRequestCompound` """ - model = CustomDropdownElementRequestCompound() # noqa: E501 + model = CustomDropdownElementRequestCompound() if include_optional: return CustomDropdownElementRequestCompound( s_label = '', diff --git a/test/test_custom_dropdown_element_response.py b/test/test_custom_dropdown_element_response.py index 63d872213..cd116e384 100644 --- a/test/test_custom_dropdown_element_response.py +++ b/test/test_custom_dropdown_element_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.custom_dropdown_element_response import CustomDropdownElementResponse # noqa: E501 +from eZmaxApi.models.custom_dropdown_element_response import CustomDropdownElementResponse class TestCustomDropdownElementResponse(unittest.TestCase): """CustomDropdownElementResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> CustomDropdownElementResponse: optional params are included """ # uncomment below to create an instance of `CustomDropdownElementResponse` """ - model = CustomDropdownElementResponse() # noqa: E501 + model = CustomDropdownElementResponse() if include_optional: return CustomDropdownElementResponse( s_label = '', diff --git a/test/test_custom_dropdown_element_response_compound.py b/test/test_custom_dropdown_element_response_compound.py index 49f81eb2f..8f4fcaaa9 100644 --- a/test/test_custom_dropdown_element_response_compound.py +++ b/test/test_custom_dropdown_element_response_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.custom_dropdown_element_response_compound import CustomDropdownElementResponseCompound # noqa: E501 +from eZmaxApi.models.custom_dropdown_element_response_compound import CustomDropdownElementResponseCompound class TestCustomDropdownElementResponseCompound(unittest.TestCase): """CustomDropdownElementResponseCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> CustomDropdownElementResponseCompou optional params are included """ # uncomment below to create an instance of `CustomDropdownElementResponseCompound` """ - model = CustomDropdownElementResponseCompound() # noqa: E501 + model = CustomDropdownElementResponseCompound() if include_optional: return CustomDropdownElementResponseCompound( s_label = '', diff --git a/test/test_custom_ezmaxinvoicing_ezsigndocument_response.py b/test/test_custom_ezmaxinvoicing_ezsigndocument_response.py index 31266a499..a86334f71 100644 --- a/test/test_custom_ezmaxinvoicing_ezsigndocument_response.py +++ b/test/test_custom_ezmaxinvoicing_ezsigndocument_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.custom_ezmaxinvoicing_ezsigndocument_response import CustomEzmaxinvoicingEzsigndocumentResponse # noqa: E501 +from eZmaxApi.models.custom_ezmaxinvoicing_ezsigndocument_response import CustomEzmaxinvoicingEzsigndocumentResponse class TestCustomEzmaxinvoicingEzsigndocumentResponse(unittest.TestCase): """CustomEzmaxinvoicingEzsigndocumentResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> CustomEzmaxinvoicingEzsigndocumentR optional params are included """ # uncomment below to create an instance of `CustomEzmaxinvoicingEzsigndocumentResponse` """ - model = CustomEzmaxinvoicingEzsigndocumentResponse() # noqa: E501 + model = CustomEzmaxinvoicingEzsigndocumentResponse() if include_optional: return CustomEzmaxinvoicingEzsigndocumentResponse( fki_ezsignfolder_id = 33, diff --git a/test/test_custom_ezmaxinvoicing_ezsignfolder_response.py b/test/test_custom_ezmaxinvoicing_ezsignfolder_response.py index ba4b27093..77f63bae0 100644 --- a/test/test_custom_ezmaxinvoicing_ezsignfolder_response.py +++ b/test/test_custom_ezmaxinvoicing_ezsignfolder_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.custom_ezmaxinvoicing_ezsignfolder_response import CustomEzmaxinvoicingEzsignfolderResponse # noqa: E501 +from eZmaxApi.models.custom_ezmaxinvoicing_ezsignfolder_response import CustomEzmaxinvoicingEzsignfolderResponse class TestCustomEzmaxinvoicingEzsignfolderResponse(unittest.TestCase): """CustomEzmaxinvoicingEzsignfolderResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> CustomEzmaxinvoicingEzsignfolderRes optional params are included """ # uncomment below to create an instance of `CustomEzmaxinvoicingEzsignfolderResponse` """ - model = CustomEzmaxinvoicingEzsignfolderResponse() # noqa: E501 + model = CustomEzmaxinvoicingEzsignfolderResponse() if include_optional: return CustomEzmaxinvoicingEzsignfolderResponse( fki_ezsignfolder_id = 33, diff --git a/test/test_custom_ezmaxpricing_response.py b/test/test_custom_ezmaxpricing_response.py index 974c13d9c..4ee0af138 100644 --- a/test/test_custom_ezmaxpricing_response.py +++ b/test/test_custom_ezmaxpricing_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.custom_ezmaxpricing_response import CustomEzmaxpricingResponse # noqa: E501 +from eZmaxApi.models.custom_ezmaxpricing_response import CustomEzmaxpricingResponse class TestCustomEzmaxpricingResponse(unittest.TestCase): """CustomEzmaxpricingResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> CustomEzmaxpricingResponse: optional params are included """ # uncomment below to create an instance of `CustomEzmaxpricingResponse` """ - model = CustomEzmaxpricingResponse() # noqa: E501 + model = CustomEzmaxpricingResponse() if include_optional: return CustomEzmaxpricingResponse( pki_ezmaxpricing_id = 28, diff --git a/test/test_custom_ezsigndocument_ezsignsignatures_automatic_response.py b/test/test_custom_ezsigndocument_ezsignsignatures_automatic_response.py index 7125ab125..9ae4eb8ea 100644 --- a/test/test_custom_ezsigndocument_ezsignsignatures_automatic_response.py +++ b/test/test_custom_ezsigndocument_ezsignsignatures_automatic_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.custom_ezsigndocument_ezsignsignatures_automatic_response import CustomEzsigndocumentEzsignsignaturesAutomaticResponse # noqa: E501 +from eZmaxApi.models.custom_ezsigndocument_ezsignsignatures_automatic_response import CustomEzsigndocumentEzsignsignaturesAutomaticResponse class TestCustomEzsigndocumentEzsignsignaturesAutomaticResponse(unittest.TestCase): """CustomEzsigndocumentEzsignsignaturesAutomaticResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> CustomEzsigndocumentEzsignsignature optional params are included """ # uncomment below to create an instance of `CustomEzsigndocumentEzsignsignaturesAutomaticResponse` """ - model = CustomEzsigndocumentEzsignsignaturesAutomaticResponse() # noqa: E501 + model = CustomEzsigndocumentEzsignsignaturesAutomaticResponse() if include_optional: return CustomEzsigndocumentEzsignsignaturesAutomaticResponse( pki_ezsigndocument_id = 97, diff --git a/test/test_custom_ezsignfolder_ezsignsignatures_automatic_response.py b/test/test_custom_ezsignfolder_ezsignsignatures_automatic_response.py index 25a4cd0e3..15f28442d 100644 --- a/test/test_custom_ezsignfolder_ezsignsignatures_automatic_response.py +++ b/test/test_custom_ezsignfolder_ezsignsignatures_automatic_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.custom_ezsignfolder_ezsignsignatures_automatic_response import CustomEzsignfolderEzsignsignaturesAutomaticResponse # noqa: E501 +from eZmaxApi.models.custom_ezsignfolder_ezsignsignatures_automatic_response import CustomEzsignfolderEzsignsignaturesAutomaticResponse class TestCustomEzsignfolderEzsignsignaturesAutomaticResponse(unittest.TestCase): """CustomEzsignfolderEzsignsignaturesAutomaticResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> CustomEzsignfolderEzsignsignaturesA optional params are included """ # uncomment below to create an instance of `CustomEzsignfolderEzsignsignaturesAutomaticResponse` """ - model = CustomEzsignfolderEzsignsignaturesAutomaticResponse() # noqa: E501 + model = CustomEzsignfolderEzsignsignaturesAutomaticResponse() if include_optional: return CustomEzsignfolderEzsignsignaturesAutomaticResponse( pki_ezsignfolder_id = 33, diff --git a/test/test_custom_ezsignfoldersignerassociation_actionable_element_response.py b/test/test_custom_ezsignfoldersignerassociation_actionable_element_response.py index 656cd0cde..aad31dcad 100644 --- a/test/test_custom_ezsignfoldersignerassociation_actionable_element_response.py +++ b/test/test_custom_ezsignfoldersignerassociation_actionable_element_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.custom_ezsignfoldersignerassociation_actionable_element_response import CustomEzsignfoldersignerassociationActionableElementResponse # noqa: E501 +from eZmaxApi.models.custom_ezsignfoldersignerassociation_actionable_element_response import CustomEzsignfoldersignerassociationActionableElementResponse class TestCustomEzsignfoldersignerassociationActionableElementResponse(unittest.TestCase): """CustomEzsignfoldersignerassociationActionableElementResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> CustomEzsignfoldersignerassociation optional params are included """ # uncomment below to create an instance of `CustomEzsignfoldersignerassociationActionableElementResponse` """ - model = CustomEzsignfoldersignerassociationActionableElementResponse() # noqa: E501 + model = CustomEzsignfoldersignerassociationActionableElementResponse() if include_optional: return CustomEzsignfoldersignerassociationActionableElementResponse( pki_ezsignfoldersignerassociation_id = 20, diff --git a/test/test_custom_ezsignfoldersignerassociationmessage_request.py b/test/test_custom_ezsignfoldersignerassociationmessage_request.py index d6ebb3134..983852668 100644 --- a/test/test_custom_ezsignfoldersignerassociationmessage_request.py +++ b/test/test_custom_ezsignfoldersignerassociationmessage_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.custom_ezsignfoldersignerassociationmessage_request import CustomEzsignfoldersignerassociationmessageRequest # noqa: E501 +from eZmaxApi.models.custom_ezsignfoldersignerassociationmessage_request import CustomEzsignfoldersignerassociationmessageRequest class TestCustomEzsignfoldersignerassociationmessageRequest(unittest.TestCase): """CustomEzsignfoldersignerassociationmessageRequest unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> CustomEzsignfoldersignerassociation optional params are included """ # uncomment below to create an instance of `CustomEzsignfoldersignerassociationmessageRequest` """ - model = CustomEzsignfoldersignerassociationmessageRequest() # noqa: E501 + model = CustomEzsignfoldersignerassociationmessageRequest() if include_optional: return CustomEzsignfoldersignerassociationmessageRequest( fki_ezsignfoldersignerassociation_id = 20, diff --git a/test/test_custom_ezsignfoldersignerassociationstatus_response.py b/test/test_custom_ezsignfoldersignerassociationstatus_response.py index a68c4623a..6f77898b0 100644 --- a/test/test_custom_ezsignfoldersignerassociationstatus_response.py +++ b/test/test_custom_ezsignfoldersignerassociationstatus_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.custom_ezsignfoldersignerassociationstatus_response import CustomEzsignfoldersignerassociationstatusResponse # noqa: E501 +from eZmaxApi.models.custom_ezsignfoldersignerassociationstatus_response import CustomEzsignfoldersignerassociationstatusResponse class TestCustomEzsignfoldersignerassociationstatusResponse(unittest.TestCase): """CustomEzsignfoldersignerassociationstatusResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> CustomEzsignfoldersignerassociation optional params are included """ # uncomment below to create an instance of `CustomEzsignfoldersignerassociationstatusResponse` """ - model = CustomEzsignfoldersignerassociationstatusResponse() # noqa: E501 + model = CustomEzsignfoldersignerassociationstatusResponse() if include_optional: return CustomEzsignfoldersignerassociationstatusResponse( fki_ezsignfoldersignerassociation_id = 20, diff --git a/test/test_custom_ezsignfoldertransmission_response.py b/test/test_custom_ezsignfoldertransmission_response.py index 6b4d5b61d..54ba926a8 100644 --- a/test/test_custom_ezsignfoldertransmission_response.py +++ b/test/test_custom_ezsignfoldertransmission_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.custom_ezsignfoldertransmission_response import CustomEzsignfoldertransmissionResponse # noqa: E501 +from eZmaxApi.models.custom_ezsignfoldertransmission_response import CustomEzsignfoldertransmissionResponse class TestCustomEzsignfoldertransmissionResponse(unittest.TestCase): """CustomEzsignfoldertransmissionResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> CustomEzsignfoldertransmissionRespo optional params are included """ # uncomment below to create an instance of `CustomEzsignfoldertransmissionResponse` """ - model = CustomEzsignfoldertransmissionResponse() # noqa: E501 + model = CustomEzsignfoldertransmissionResponse() if include_optional: return CustomEzsignfoldertransmissionResponse( pki_ezsignfolder_id = 33, diff --git a/test/test_custom_ezsignfoldertransmission_signer_response.py b/test/test_custom_ezsignfoldertransmission_signer_response.py index c257bfe5a..8c3b20bc9 100644 --- a/test/test_custom_ezsignfoldertransmission_signer_response.py +++ b/test/test_custom_ezsignfoldertransmission_signer_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.custom_ezsignfoldertransmission_signer_response import CustomEzsignfoldertransmissionSignerResponse # noqa: E501 +from eZmaxApi.models.custom_ezsignfoldertransmission_signer_response import CustomEzsignfoldertransmissionSignerResponse class TestCustomEzsignfoldertransmissionSignerResponse(unittest.TestCase): """CustomEzsignfoldertransmissionSignerResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> CustomEzsignfoldertransmissionSigne optional params are included """ # uncomment below to create an instance of `CustomEzsignfoldertransmissionSignerResponse` """ - model = CustomEzsignfoldertransmissionSignerResponse() # noqa: E501 + model = CustomEzsignfoldertransmissionSignerResponse() if include_optional: return CustomEzsignfoldertransmissionSignerResponse( fki_user_id = 70, diff --git a/test/test_custom_ezsignfoldertype_response.py b/test/test_custom_ezsignfoldertype_response.py index d54aa2a26..b7871fe98 100644 --- a/test/test_custom_ezsignfoldertype_response.py +++ b/test/test_custom_ezsignfoldertype_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.custom_ezsignfoldertype_response import CustomEzsignfoldertypeResponse # noqa: E501 +from eZmaxApi.models.custom_ezsignfoldertype_response import CustomEzsignfoldertypeResponse class TestCustomEzsignfoldertypeResponse(unittest.TestCase): """CustomEzsignfoldertypeResponse unit test stubs""" @@ -34,13 +34,16 @@ def make_instance(self, include_optional) -> CustomEzsignfoldertypeResponse: optional params are included """ # uncomment below to create an instance of `CustomEzsignfoldertypeResponse` """ - model = CustomEzsignfoldertypeResponse() # noqa: E501 + model = CustomEzsignfoldertypeResponse() if include_optional: return CustomEzsignfoldertypeResponse( pki_ezsignfoldertype_id = 5, s_ezsignfoldertype_name_x = 'Default', + b_ezsignfoldertype_sendproofezsignsigner = False, b_ezsignfoldertype_includeproofsigner = True, b_ezsignfoldertype_includeproofuser = True, + b_ezsignfoldertype_allowdownloadattachmentezsignsigner = False, + b_ezsignfoldertype_allowdownloadproofezsignsigner = False, b_ezsignfoldertype_delegate = True, b_ezsignfoldertype_reassign = True ) diff --git a/test/test_custom_ezsignformfield_request.py b/test/test_custom_ezsignformfield_request.py index 4d841be0f..f5e0a98a1 100644 --- a/test/test_custom_ezsignformfield_request.py +++ b/test/test_custom_ezsignformfield_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.custom_ezsignformfield_request import CustomEzsignformfieldRequest # noqa: E501 +from eZmaxApi.models.custom_ezsignformfield_request import CustomEzsignformfieldRequest class TestCustomEzsignformfieldRequest(unittest.TestCase): """CustomEzsignformfieldRequest unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> CustomEzsignformfieldRequest: optional params are included """ # uncomment below to create an instance of `CustomEzsignformfieldRequest` """ - model = CustomEzsignformfieldRequest() # noqa: E501 + model = CustomEzsignformfieldRequest() if include_optional: return CustomEzsignformfieldRequest( pki_ezsignformfield_id = 32, diff --git a/test/test_custom_ezsignformfielderror_response.py b/test/test_custom_ezsignformfielderror_response.py index b68f862bd..14ef7496a 100644 --- a/test/test_custom_ezsignformfielderror_response.py +++ b/test/test_custom_ezsignformfielderror_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.custom_ezsignformfielderror_response import CustomEzsignformfielderrorResponse # noqa: E501 +from eZmaxApi.models.custom_ezsignformfielderror_response import CustomEzsignformfielderrorResponse class TestCustomEzsignformfielderrorResponse(unittest.TestCase): """CustomEzsignformfielderrorResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> CustomEzsignformfielderrorResponse: optional params are included """ # uncomment below to create an instance of `CustomEzsignformfielderrorResponse` """ - model = CustomEzsignformfielderrorResponse() # noqa: E501 + model = CustomEzsignformfielderrorResponse() if include_optional: return CustomEzsignformfielderrorResponse( s_ezsignformfield_label = 'Peanuts', diff --git a/test/test_custom_ezsignformfielderrortest_response.py b/test/test_custom_ezsignformfielderrortest_response.py index 47fdfc43e..4b50f45c7 100644 --- a/test/test_custom_ezsignformfielderrortest_response.py +++ b/test/test_custom_ezsignformfielderrortest_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.custom_ezsignformfielderrortest_response import CustomEzsignformfielderrortestResponse # noqa: E501 +from eZmaxApi.models.custom_ezsignformfielderrortest_response import CustomEzsignformfielderrortestResponse class TestCustomEzsignformfielderrortestResponse(unittest.TestCase): """CustomEzsignformfielderrortestResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> CustomEzsignformfielderrortestRespo optional params are included """ # uncomment below to create an instance of `CustomEzsignformfielderrortestResponse` """ - model = CustomEzsignformfielderrortestResponse() # noqa: E501 + model = CustomEzsignformfielderrortestResponse() if include_optional: return CustomEzsignformfielderrortestResponse( s_ezsignformfielderrortest_name = 'jUR,rZ#UM/?', diff --git a/test/test_custom_ezsignformfieldgroup_request.py b/test/test_custom_ezsignformfieldgroup_request.py index 883664244..01fd1fca9 100644 --- a/test/test_custom_ezsignformfieldgroup_request.py +++ b/test/test_custom_ezsignformfieldgroup_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.custom_ezsignformfieldgroup_request import CustomEzsignformfieldgroupRequest # noqa: E501 +from eZmaxApi.models.custom_ezsignformfieldgroup_request import CustomEzsignformfieldgroupRequest class TestCustomEzsignformfieldgroupRequest(unittest.TestCase): """CustomEzsignformfieldgroupRequest unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> CustomEzsignformfieldgroupRequest: optional params are included """ # uncomment below to create an instance of `CustomEzsignformfieldgroupRequest` """ - model = CustomEzsignformfieldgroupRequest() # noqa: E501 + model = CustomEzsignformfieldgroupRequest() if include_optional: return CustomEzsignformfieldgroupRequest( pki_ezsignformfieldgroup_id = 26, diff --git a/test/test_custom_ezsignsignature_ezsignsignatures_automatic_response.py b/test/test_custom_ezsignsignature_ezsignsignatures_automatic_response.py index 4330dc5c2..60b8205fd 100644 --- a/test/test_custom_ezsignsignature_ezsignsignatures_automatic_response.py +++ b/test/test_custom_ezsignsignature_ezsignsignatures_automatic_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.custom_ezsignsignature_ezsignsignatures_automatic_response import CustomEzsignsignatureEzsignsignaturesAutomaticResponse # noqa: E501 +from eZmaxApi.models.custom_ezsignsignature_ezsignsignatures_automatic_response import CustomEzsignsignatureEzsignsignaturesAutomaticResponse class TestCustomEzsignsignatureEzsignsignaturesAutomaticResponse(unittest.TestCase): """CustomEzsignsignatureEzsignsignaturesAutomaticResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> CustomEzsignsignatureEzsignsignatur optional params are included """ # uncomment below to create an instance of `CustomEzsignsignatureEzsignsignaturesAutomaticResponse` """ - model = CustomEzsignsignatureEzsignsignaturesAutomaticResponse() # noqa: E501 + model = CustomEzsignsignatureEzsignsignaturesAutomaticResponse() if include_optional: return CustomEzsignsignatureEzsignsignaturesAutomaticResponse( pki_ezsignsignature_id = 49, diff --git a/test/test_custom_ezsignsignaturestatus_response.py b/test/test_custom_ezsignsignaturestatus_response.py index c5d6ce4de..b636d91dc 100644 --- a/test/test_custom_ezsignsignaturestatus_response.py +++ b/test/test_custom_ezsignsignaturestatus_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.custom_ezsignsignaturestatus_response import CustomEzsignsignaturestatusResponse # noqa: E501 +from eZmaxApi.models.custom_ezsignsignaturestatus_response import CustomEzsignsignaturestatusResponse class TestCustomEzsignsignaturestatusResponse(unittest.TestCase): """CustomEzsignsignaturestatusResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> CustomEzsignsignaturestatusResponse optional params are included """ # uncomment below to create an instance of `CustomEzsignsignaturestatusResponse` """ - model = CustomEzsignsignaturestatusResponse() # noqa: E501 + model = CustomEzsignsignaturestatusResponse() if include_optional: return CustomEzsignsignaturestatusResponse( e_ezsignsignaturestatus_steptype = 'Form', diff --git a/test/test_custom_form_data_document_response.py b/test/test_custom_form_data_document_response.py index 7648b2c62..3d8855e37 100644 --- a/test/test_custom_form_data_document_response.py +++ b/test/test_custom_form_data_document_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.custom_form_data_document_response import CustomFormDataDocumentResponse # noqa: E501 +from eZmaxApi.models.custom_form_data_document_response import CustomFormDataDocumentResponse class TestCustomFormDataDocumentResponse(unittest.TestCase): """CustomFormDataDocumentResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> CustomFormDataDocumentResponse: optional params are included """ # uncomment below to create an instance of `CustomFormDataDocumentResponse` """ - model = CustomFormDataDocumentResponse() # noqa: E501 + model = CustomFormDataDocumentResponse() if include_optional: return CustomFormDataDocumentResponse( pki_ezsigndocument_id = 97, diff --git a/test/test_custom_form_data_ezsignformfield_response.py b/test/test_custom_form_data_ezsignformfield_response.py index c22a6c221..8b82a6efe 100644 --- a/test/test_custom_form_data_ezsignformfield_response.py +++ b/test/test_custom_form_data_ezsignformfield_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.custom_form_data_ezsignformfield_response import CustomFormDataEzsignformfieldResponse # noqa: E501 +from eZmaxApi.models.custom_form_data_ezsignformfield_response import CustomFormDataEzsignformfieldResponse class TestCustomFormDataEzsignformfieldResponse(unittest.TestCase): """CustomFormDataEzsignformfieldResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> CustomFormDataEzsignformfieldRespon optional params are included """ # uncomment below to create an instance of `CustomFormDataEzsignformfieldResponse` """ - model = CustomFormDataEzsignformfieldResponse() # noqa: E501 + model = CustomFormDataEzsignformfieldResponse() if include_optional: return CustomFormDataEzsignformfieldResponse( s_ezsignformfield_label = 'Peanuts', diff --git a/test/test_custom_form_data_ezsignformfieldgroup_response.py b/test/test_custom_form_data_ezsignformfieldgroup_response.py index 9f4ecc98b..c8b31f78d 100644 --- a/test/test_custom_form_data_ezsignformfieldgroup_response.py +++ b/test/test_custom_form_data_ezsignformfieldgroup_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.custom_form_data_ezsignformfieldgroup_response import CustomFormDataEzsignformfieldgroupResponse # noqa: E501 +from eZmaxApi.models.custom_form_data_ezsignformfieldgroup_response import CustomFormDataEzsignformfieldgroupResponse class TestCustomFormDataEzsignformfieldgroupResponse(unittest.TestCase): """CustomFormDataEzsignformfieldgroupResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> CustomFormDataEzsignformfieldgroupR optional params are included """ # uncomment below to create an instance of `CustomFormDataEzsignformfieldgroupResponse` """ - model = CustomFormDataEzsignformfieldgroupResponse() # noqa: E501 + model = CustomFormDataEzsignformfieldgroupResponse() if include_optional: return CustomFormDataEzsignformfieldgroupResponse( s_ezsignformfieldgroup_label = 'Allergies', diff --git a/test/test_custom_form_data_signer_response.py b/test/test_custom_form_data_signer_response.py index 3811424d4..7601e2205 100644 --- a/test/test_custom_form_data_signer_response.py +++ b/test/test_custom_form_data_signer_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.custom_form_data_signer_response import CustomFormDataSignerResponse # noqa: E501 +from eZmaxApi.models.custom_form_data_signer_response import CustomFormDataSignerResponse class TestCustomFormDataSignerResponse(unittest.TestCase): """CustomFormDataSignerResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> CustomFormDataSignerResponse: optional params are included """ # uncomment below to create an instance of `CustomFormDataSignerResponse` """ - model = CustomFormDataSignerResponse() # noqa: E501 + model = CustomFormDataSignerResponse() if include_optional: return CustomFormDataSignerResponse( fki_ezsignfoldersignerassociation_id = 20, diff --git a/test/test_custom_forms_data_folder_response.py b/test/test_custom_forms_data_folder_response.py index 09963f282..224dca0db 100644 --- a/test/test_custom_forms_data_folder_response.py +++ b/test/test_custom_forms_data_folder_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.custom_forms_data_folder_response import CustomFormsDataFolderResponse # noqa: E501 +from eZmaxApi.models.custom_forms_data_folder_response import CustomFormsDataFolderResponse class TestCustomFormsDataFolderResponse(unittest.TestCase): """CustomFormsDataFolderResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> CustomFormsDataFolderResponse: optional params are included """ # uncomment below to create an instance of `CustomFormsDataFolderResponse` """ - model = CustomFormsDataFolderResponse() # noqa: E501 + model = CustomFormsDataFolderResponse() if include_optional: return CustomFormsDataFolderResponse( pki_ezsignfolder_id = 33, diff --git a/test/test_custom_import_ezsigntemplatepackage_relation_request.py b/test/test_custom_import_ezsigntemplatepackage_relation_request.py index 20af7ce3a..57650e66a 100644 --- a/test/test_custom_import_ezsigntemplatepackage_relation_request.py +++ b/test/test_custom_import_ezsigntemplatepackage_relation_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.custom_import_ezsigntemplatepackage_relation_request import CustomImportEzsigntemplatepackageRelationRequest # noqa: E501 +from eZmaxApi.models.custom_import_ezsigntemplatepackage_relation_request import CustomImportEzsigntemplatepackageRelationRequest class TestCustomImportEzsigntemplatepackageRelationRequest(unittest.TestCase): """CustomImportEzsigntemplatepackageRelationRequest unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> CustomImportEzsigntemplatepackageRe optional params are included """ # uncomment below to create an instance of `CustomImportEzsigntemplatepackageRelationRequest` """ - model = CustomImportEzsigntemplatepackageRelationRequest() # noqa: E501 + model = CustomImportEzsigntemplatepackageRelationRequest() if include_optional: return CustomImportEzsigntemplatepackageRelationRequest( fki_ezsigntemplatepackagesigner_id = 174, diff --git a/test/test_custom_notificationsubsectiongetnotificationtests_response.py b/test/test_custom_notificationsubsectiongetnotificationtests_response.py index 41a961b3c..b976840bc 100644 --- a/test/test_custom_notificationsubsectiongetnotificationtests_response.py +++ b/test/test_custom_notificationsubsectiongetnotificationtests_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.custom_notificationsubsectiongetnotificationtests_response import CustomNotificationsubsectiongetnotificationtestsResponse # noqa: E501 +from eZmaxApi.models.custom_notificationsubsectiongetnotificationtests_response import CustomNotificationsubsectiongetnotificationtestsResponse class TestCustomNotificationsubsectiongetnotificationtestsResponse(unittest.TestCase): """CustomNotificationsubsectiongetnotificationtestsResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> CustomNotificationsubsectiongetnoti optional params are included """ # uncomment below to create an instance of `CustomNotificationsubsectiongetnotificationtestsResponse` """ - model = CustomNotificationsubsectiongetnotificationtestsResponse() # noqa: E501 + model = CustomNotificationsubsectiongetnotificationtestsResponse() if include_optional: return CustomNotificationsubsectiongetnotificationtestsResponse( pki_notificationsubsection_id = 3, diff --git a/test/test_custom_notificationtestgetnotificationtests_response.py b/test/test_custom_notificationtestgetnotificationtests_response.py index dba4a9ff0..effba2e38 100644 --- a/test/test_custom_notificationtestgetnotificationtests_response.py +++ b/test/test_custom_notificationtestgetnotificationtests_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.custom_notificationtestgetnotificationtests_response import CustomNotificationtestgetnotificationtestsResponse # noqa: E501 +from eZmaxApi.models.custom_notificationtestgetnotificationtests_response import CustomNotificationtestgetnotificationtestsResponse class TestCustomNotificationtestgetnotificationtestsResponse(unittest.TestCase): """CustomNotificationtestgetnotificationtestsResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> CustomNotificationtestgetnotificati optional params are included """ # uncomment below to create an instance of `CustomNotificationtestgetnotificationtestsResponse` """ - model = CustomNotificationtestgetnotificationtestsResponse() # noqa: E501 + model = CustomNotificationtestgetnotificationtestsResponse() if include_optional: return CustomNotificationtestgetnotificationtestsResponse( pki_notificationtest_id = 14, diff --git a/test/test_custom_user_response.py b/test/test_custom_user_response.py index 68c309c4c..d368b6296 100644 --- a/test/test_custom_user_response.py +++ b/test/test_custom_user_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.custom_user_response import CustomUserResponse # noqa: E501 +from eZmaxApi.models.custom_user_response import CustomUserResponse class TestCustomUserResponse(unittest.TestCase): """CustomUserResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> CustomUserResponse: optional params are included """ # uncomment below to create an instance of `CustomUserResponse` """ - model = CustomUserResponse() # noqa: E501 + model = CustomUserResponse() if include_optional: return CustomUserResponse( pki_user_id = 70, diff --git a/test/test_custom_webhook_response.py b/test/test_custom_webhook_response.py index 7375b5483..2c6ed56a2 100644 --- a/test/test_custom_webhook_response.py +++ b/test/test_custom_webhook_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.custom_webhook_response import CustomWebhookResponse # noqa: E501 +from eZmaxApi.models.custom_webhook_response import CustomWebhookResponse class TestCustomWebhookResponse(unittest.TestCase): """CustomWebhookResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> CustomWebhookResponse: optional params are included """ # uncomment below to create an instance of `CustomWebhookResponse` """ - model = CustomWebhookResponse() # noqa: E501 + model = CustomWebhookResponse() if include_optional: return CustomWebhookResponse( pki_webhook_id = 77, @@ -46,7 +46,10 @@ def make_instance(self, include_optional) -> CustomWebhookResponse: e_webhook_managementevent = 'UserCreated', s_webhook_url = 'https://www.example.com', s_webhook_emailfailed = 'email@example.com', + s_webhook_apikey = '', + s_webhook_secret = '', b_webhook_isactive = True, + b_webhook_issigned = True, b_webhook_skipsslvalidation = False, pks_customer_code = 'demo', b_webhook_test = True @@ -59,6 +62,7 @@ def make_instance(self, include_optional) -> CustomWebhookResponse: s_webhook_url = 'https://www.example.com', s_webhook_emailfailed = 'email@example.com', b_webhook_isactive = True, + b_webhook_issigned = True, b_webhook_skipsslvalidation = False, pks_customer_code = 'demo', b_webhook_test = True, diff --git a/test/test_custom_webhooklog_response.py b/test/test_custom_webhooklog_response.py index 138d9d3a6..fac403710 100644 --- a/test/test_custom_webhooklog_response.py +++ b/test/test_custom_webhooklog_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.custom_webhooklog_response import CustomWebhooklogResponse # noqa: E501 +from eZmaxApi.models.custom_webhooklog_response import CustomWebhooklogResponse class TestCustomWebhooklogResponse(unittest.TestCase): """CustomWebhooklogResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> CustomWebhooklogResponse: optional params are included """ # uncomment below to create an instance of `CustomWebhooklogResponse` """ - model = CustomWebhooklogResponse() # noqa: E501 + model = CustomWebhooklogResponse() if include_optional: return CustomWebhooklogResponse( dt_webhooklog_date = '2020-12-31 23:59:59', diff --git a/test/test_custom_word_position_occurence_response.py b/test/test_custom_word_position_occurence_response.py index e008657d3..17c3cdfc5 100644 --- a/test/test_custom_word_position_occurence_response.py +++ b/test/test_custom_word_position_occurence_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.custom_word_position_occurence_response import CustomWordPositionOccurenceResponse # noqa: E501 +from eZmaxApi.models.custom_word_position_occurence_response import CustomWordPositionOccurenceResponse class TestCustomWordPositionOccurenceResponse(unittest.TestCase): """CustomWordPositionOccurenceResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> CustomWordPositionOccurenceResponse optional params are included """ # uncomment below to create an instance of `CustomWordPositionOccurenceResponse` """ - model = CustomWordPositionOccurenceResponse() # noqa: E501 + model = CustomWordPositionOccurenceResponse() if include_optional: return CustomWordPositionOccurenceResponse( i_page = 1, diff --git a/test/test_custom_word_position_word_response.py b/test/test_custom_word_position_word_response.py index 7ed70e2e0..327a2faf3 100644 --- a/test/test_custom_word_position_word_response.py +++ b/test/test_custom_word_position_word_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.custom_word_position_word_response import CustomWordPositionWordResponse # noqa: E501 +from eZmaxApi.models.custom_word_position_word_response import CustomWordPositionWordResponse class TestCustomWordPositionWordResponse(unittest.TestCase): """CustomWordPositionWordResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> CustomWordPositionWordResponse: optional params are included """ # uncomment below to create an instance of `CustomWordPositionWordResponse` """ - model = CustomWordPositionWordResponse() # noqa: E501 + model = CustomWordPositionWordResponse() if include_optional: return CustomWordPositionWordResponse( s_word = '', diff --git a/test/test_department_autocomplete_element_response.py b/test/test_department_autocomplete_element_response.py index 822b9cfe7..826ebe958 100644 --- a/test/test_department_autocomplete_element_response.py +++ b/test/test_department_autocomplete_element_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.department_autocomplete_element_response import DepartmentAutocompleteElementResponse # noqa: E501 +from eZmaxApi.models.department_autocomplete_element_response import DepartmentAutocompleteElementResponse class TestDepartmentAutocompleteElementResponse(unittest.TestCase): """DepartmentAutocompleteElementResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> DepartmentAutocompleteElementRespon optional params are included """ # uncomment below to create an instance of `DepartmentAutocompleteElementResponse` """ - model = DepartmentAutocompleteElementResponse() # noqa: E501 + model = DepartmentAutocompleteElementResponse() if include_optional: return DepartmentAutocompleteElementResponse( s_company_name_x = 'Acme inc.', diff --git a/test/test_department_get_autocomplete_v2_response.py b/test/test_department_get_autocomplete_v2_response.py index d5aad1665..49c743fcd 100644 --- a/test/test_department_get_autocomplete_v2_response.py +++ b/test/test_department_get_autocomplete_v2_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.department_get_autocomplete_v2_response import DepartmentGetAutocompleteV2Response # noqa: E501 +from eZmaxApi.models.department_get_autocomplete_v2_response import DepartmentGetAutocompleteV2Response class TestDepartmentGetAutocompleteV2Response(unittest.TestCase): """DepartmentGetAutocompleteV2Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> DepartmentGetAutocompleteV2Response optional params are included """ # uncomment below to create an instance of `DepartmentGetAutocompleteV2Response` """ - model = DepartmentGetAutocompleteV2Response() # noqa: E501 + model = DepartmentGetAutocompleteV2Response() if include_optional: return DepartmentGetAutocompleteV2Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_department_get_autocomplete_v2_response_m_payload.py b/test/test_department_get_autocomplete_v2_response_m_payload.py index 907eb83e2..d63c88a22 100644 --- a/test/test_department_get_autocomplete_v2_response_m_payload.py +++ b/test/test_department_get_autocomplete_v2_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.department_get_autocomplete_v2_response_m_payload import DepartmentGetAutocompleteV2ResponseMPayload # noqa: E501 +from eZmaxApi.models.department_get_autocomplete_v2_response_m_payload import DepartmentGetAutocompleteV2ResponseMPayload class TestDepartmentGetAutocompleteV2ResponseMPayload(unittest.TestCase): """DepartmentGetAutocompleteV2ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> DepartmentGetAutocompleteV2Response optional params are included """ # uncomment below to create an instance of `DepartmentGetAutocompleteV2ResponseMPayload` """ - model = DepartmentGetAutocompleteV2ResponseMPayload() # noqa: E501 + model = DepartmentGetAutocompleteV2ResponseMPayload() if include_optional: return DepartmentGetAutocompleteV2ResponseMPayload( a_obj_department = [ diff --git a/test/test_electronicfundstransfer_get_communication_list_v1_response.py b/test/test_electronicfundstransfer_get_communication_list_v1_response.py index 77a621d77..aa6348a1b 100644 --- a/test/test_electronicfundstransfer_get_communication_list_v1_response.py +++ b/test/test_electronicfundstransfer_get_communication_list_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.electronicfundstransfer_get_communication_list_v1_response import ElectronicfundstransferGetCommunicationListV1Response # noqa: E501 +from eZmaxApi.models.electronicfundstransfer_get_communication_list_v1_response import ElectronicfundstransferGetCommunicationListV1Response class TestElectronicfundstransferGetCommunicationListV1Response(unittest.TestCase): """ElectronicfundstransferGetCommunicationListV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> ElectronicfundstransferGetCommunica optional params are included """ # uncomment below to create an instance of `ElectronicfundstransferGetCommunicationListV1Response` """ - model = ElectronicfundstransferGetCommunicationListV1Response() # noqa: E501 + model = ElectronicfundstransferGetCommunicationListV1Response() if include_optional: return ElectronicfundstransferGetCommunicationListV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload_get_list.Common-Response-objDebugPayload_getList(), diff --git a/test/test_electronicfundstransfer_get_communication_list_v1_response_m_payload.py b/test/test_electronicfundstransfer_get_communication_list_v1_response_m_payload.py index f1a86b3e4..edae22f9d 100644 --- a/test/test_electronicfundstransfer_get_communication_list_v1_response_m_payload.py +++ b/test/test_electronicfundstransfer_get_communication_list_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.electronicfundstransfer_get_communication_list_v1_response_m_payload import ElectronicfundstransferGetCommunicationListV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.electronicfundstransfer_get_communication_list_v1_response_m_payload import ElectronicfundstransferGetCommunicationListV1ResponseMPayload class TestElectronicfundstransferGetCommunicationListV1ResponseMPayload(unittest.TestCase): """ElectronicfundstransferGetCommunicationListV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> ElectronicfundstransferGetCommunica optional params are included """ # uncomment below to create an instance of `ElectronicfundstransferGetCommunicationListV1ResponseMPayload` """ - model = ElectronicfundstransferGetCommunicationListV1ResponseMPayload() # noqa: E501 + model = ElectronicfundstransferGetCommunicationListV1ResponseMPayload() if include_optional: return ElectronicfundstransferGetCommunicationListV1ResponseMPayload( a_obj_communication = [ diff --git a/test/test_email_request.py b/test/test_email_request.py index cb51a3974..e1a14b61e 100644 --- a/test/test_email_request.py +++ b/test/test_email_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.email_request import EmailRequest # noqa: E501 +from eZmaxApi.models.email_request import EmailRequest class TestEmailRequest(unittest.TestCase): """EmailRequest unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EmailRequest: optional params are included """ # uncomment below to create an instance of `EmailRequest` """ - model = EmailRequest() # noqa: E501 + model = EmailRequest() if include_optional: return EmailRequest( pki_email_id = 22, diff --git a/test/test_email_request_compound.py b/test/test_email_request_compound.py index 6fad09bfd..8bbebe2bf 100644 --- a/test/test_email_request_compound.py +++ b/test/test_email_request_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.email_request_compound import EmailRequestCompound # noqa: E501 +from eZmaxApi.models.email_request_compound import EmailRequestCompound class TestEmailRequestCompound(unittest.TestCase): """EmailRequestCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EmailRequestCompound: optional params are included """ # uncomment below to create an instance of `EmailRequestCompound` """ - model = EmailRequestCompound() # noqa: E501 + model = EmailRequestCompound() if include_optional: return EmailRequestCompound( pki_email_id = 22, diff --git a/test/test_email_response.py b/test/test_email_response.py index 9f4b84ef5..6b35f0364 100644 --- a/test/test_email_response.py +++ b/test/test_email_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.email_response import EmailResponse # noqa: E501 +from eZmaxApi.models.email_response import EmailResponse class TestEmailResponse(unittest.TestCase): """EmailResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EmailResponse: optional params are included """ # uncomment below to create an instance of `EmailResponse` """ - model = EmailResponse() # noqa: E501 + model = EmailResponse() if include_optional: return EmailResponse( pki_email_id = 22, diff --git a/test/test_email_response_compound.py b/test/test_email_response_compound.py index d28502d13..ca12507b7 100644 --- a/test/test_email_response_compound.py +++ b/test/test_email_response_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.email_response_compound import EmailResponseCompound # noqa: E501 +from eZmaxApi.models.email_response_compound import EmailResponseCompound class TestEmailResponseCompound(unittest.TestCase): """EmailResponseCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EmailResponseCompound: optional params are included """ # uncomment below to create an instance of `EmailResponseCompound` """ - model = EmailResponseCompound() # noqa: E501 + model = EmailResponseCompound() if include_optional: return EmailResponseCompound( pki_email_id = 22, diff --git a/test/test_emailtype_autocomplete_element_response.py b/test/test_emailtype_autocomplete_element_response.py index fe82634a4..894f2cb57 100644 --- a/test/test_emailtype_autocomplete_element_response.py +++ b/test/test_emailtype_autocomplete_element_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.emailtype_autocomplete_element_response import EmailtypeAutocompleteElementResponse # noqa: E501 +from eZmaxApi.models.emailtype_autocomplete_element_response import EmailtypeAutocompleteElementResponse class TestEmailtypeAutocompleteElementResponse(unittest.TestCase): """EmailtypeAutocompleteElementResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EmailtypeAutocompleteElementRespons optional params are included """ # uncomment below to create an instance of `EmailtypeAutocompleteElementResponse` """ - model = EmailtypeAutocompleteElementResponse() # noqa: E501 + model = EmailtypeAutocompleteElementResponse() if include_optional: return EmailtypeAutocompleteElementResponse( pki_emailtype_id = 1, diff --git a/test/test_emailtype_get_autocomplete_v2_response.py b/test/test_emailtype_get_autocomplete_v2_response.py index a5d6440ff..fbd0f4b5d 100644 --- a/test/test_emailtype_get_autocomplete_v2_response.py +++ b/test/test_emailtype_get_autocomplete_v2_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.emailtype_get_autocomplete_v2_response import EmailtypeGetAutocompleteV2Response # noqa: E501 +from eZmaxApi.models.emailtype_get_autocomplete_v2_response import EmailtypeGetAutocompleteV2Response class TestEmailtypeGetAutocompleteV2Response(unittest.TestCase): """EmailtypeGetAutocompleteV2Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EmailtypeGetAutocompleteV2Response: optional params are included """ # uncomment below to create an instance of `EmailtypeGetAutocompleteV2Response` """ - model = EmailtypeGetAutocompleteV2Response() # noqa: E501 + model = EmailtypeGetAutocompleteV2Response() if include_optional: return EmailtypeGetAutocompleteV2Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_emailtype_get_autocomplete_v2_response_m_payload.py b/test/test_emailtype_get_autocomplete_v2_response_m_payload.py index 878772a51..a9806dc87 100644 --- a/test/test_emailtype_get_autocomplete_v2_response_m_payload.py +++ b/test/test_emailtype_get_autocomplete_v2_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.emailtype_get_autocomplete_v2_response_m_payload import EmailtypeGetAutocompleteV2ResponseMPayload # noqa: E501 +from eZmaxApi.models.emailtype_get_autocomplete_v2_response_m_payload import EmailtypeGetAutocompleteV2ResponseMPayload class TestEmailtypeGetAutocompleteV2ResponseMPayload(unittest.TestCase): """EmailtypeGetAutocompleteV2ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EmailtypeGetAutocompleteV2ResponseM optional params are included """ # uncomment below to create an instance of `EmailtypeGetAutocompleteV2ResponseMPayload` """ - model = EmailtypeGetAutocompleteV2ResponseMPayload() # noqa: E501 + model = EmailtypeGetAutocompleteV2ResponseMPayload() if include_optional: return EmailtypeGetAutocompleteV2ResponseMPayload( a_obj_emailtype = [ diff --git a/test/test_enum_fontunderline.py b/test/test_enum_fontunderline.py index c73314d41..24d9795e2 100644 --- a/test/test_enum_fontunderline.py +++ b/test/test_enum_fontunderline.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.enum_fontunderline import EnumFontunderline # noqa: E501 +from eZmaxApi.models.enum_fontunderline import EnumFontunderline class TestEnumFontunderline(unittest.TestCase): """EnumFontunderline unit test stubs""" diff --git a/test/test_enum_fontweight.py b/test/test_enum_fontweight.py index 120d57612..9c4ddc1a4 100644 --- a/test/test_enum_fontweight.py +++ b/test/test_enum_fontweight.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.enum_fontweight import EnumFontweight # noqa: E501 +from eZmaxApi.models.enum_fontweight import EnumFontweight class TestEnumFontweight(unittest.TestCase): """EnumFontweight unit test stubs""" diff --git a/test/test_enum_horizontalalignment.py b/test/test_enum_horizontalalignment.py index df455a4ec..c6ad38559 100644 --- a/test/test_enum_horizontalalignment.py +++ b/test/test_enum_horizontalalignment.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.enum_horizontalalignment import EnumHorizontalalignment # noqa: E501 +from eZmaxApi.models.enum_horizontalalignment import EnumHorizontalalignment class TestEnumHorizontalalignment(unittest.TestCase): """EnumHorizontalalignment unit test stubs""" diff --git a/test/test_enum_textvalidation.py b/test/test_enum_textvalidation.py index 1ba81979c..cc05fe5c3 100644 --- a/test/test_enum_textvalidation.py +++ b/test/test_enum_textvalidation.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.enum_textvalidation import EnumTextvalidation # noqa: E501 +from eZmaxApi.models.enum_textvalidation import EnumTextvalidation class TestEnumTextvalidation(unittest.TestCase): """EnumTextvalidation unit test stubs""" diff --git a/test/test_enum_verticalalignment.py b/test/test_enum_verticalalignment.py index 8b0cc4283..ca1dcd50f 100644 --- a/test/test_enum_verticalalignment.py +++ b/test/test_enum_verticalalignment.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.enum_verticalalignment import EnumVerticalalignment # noqa: E501 +from eZmaxApi.models.enum_verticalalignment import EnumVerticalalignment class TestEnumVerticalalignment(unittest.TestCase): """EnumVerticalalignment unit test stubs""" diff --git a/test/test_ezmaxinvoicing_autocomplete_element_response.py b/test/test_ezmaxinvoicing_autocomplete_element_response.py index 329933b23..d5fb7fc04 100644 --- a/test/test_ezmaxinvoicing_autocomplete_element_response.py +++ b/test/test_ezmaxinvoicing_autocomplete_element_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezmaxinvoicing_autocomplete_element_response import EzmaxinvoicingAutocompleteElementResponse # noqa: E501 +from eZmaxApi.models.ezmaxinvoicing_autocomplete_element_response import EzmaxinvoicingAutocompleteElementResponse class TestEzmaxinvoicingAutocompleteElementResponse(unittest.TestCase): """EzmaxinvoicingAutocompleteElementResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzmaxinvoicingAutocompleteElementRe optional params are included """ # uncomment below to create an instance of `EzmaxinvoicingAutocompleteElementResponse` """ - model = EzmaxinvoicingAutocompleteElementResponse() # noqa: E501 + model = EzmaxinvoicingAutocompleteElementResponse() if include_optional: return EzmaxinvoicingAutocompleteElementResponse( yyyymm_ezmaxinvoicing = '2022-01', diff --git a/test/test_ezmaxinvoicing_get_autocomplete_v2_response.py b/test/test_ezmaxinvoicing_get_autocomplete_v2_response.py index 0d1eb9a72..9246b11d0 100644 --- a/test/test_ezmaxinvoicing_get_autocomplete_v2_response.py +++ b/test/test_ezmaxinvoicing_get_autocomplete_v2_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezmaxinvoicing_get_autocomplete_v2_response import EzmaxinvoicingGetAutocompleteV2Response # noqa: E501 +from eZmaxApi.models.ezmaxinvoicing_get_autocomplete_v2_response import EzmaxinvoicingGetAutocompleteV2Response class TestEzmaxinvoicingGetAutocompleteV2Response(unittest.TestCase): """EzmaxinvoicingGetAutocompleteV2Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzmaxinvoicingGetAutocompleteV2Resp optional params are included """ # uncomment below to create an instance of `EzmaxinvoicingGetAutocompleteV2Response` """ - model = EzmaxinvoicingGetAutocompleteV2Response() # noqa: E501 + model = EzmaxinvoicingGetAutocompleteV2Response() if include_optional: return EzmaxinvoicingGetAutocompleteV2Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezmaxinvoicing_get_autocomplete_v2_response_m_payload.py b/test/test_ezmaxinvoicing_get_autocomplete_v2_response_m_payload.py index c0c5dd391..4da4c30bd 100644 --- a/test/test_ezmaxinvoicing_get_autocomplete_v2_response_m_payload.py +++ b/test/test_ezmaxinvoicing_get_autocomplete_v2_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezmaxinvoicing_get_autocomplete_v2_response_m_payload import EzmaxinvoicingGetAutocompleteV2ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezmaxinvoicing_get_autocomplete_v2_response_m_payload import EzmaxinvoicingGetAutocompleteV2ResponseMPayload class TestEzmaxinvoicingGetAutocompleteV2ResponseMPayload(unittest.TestCase): """EzmaxinvoicingGetAutocompleteV2ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzmaxinvoicingGetAutocompleteV2Resp optional params are included """ # uncomment below to create an instance of `EzmaxinvoicingGetAutocompleteV2ResponseMPayload` """ - model = EzmaxinvoicingGetAutocompleteV2ResponseMPayload() # noqa: E501 + model = EzmaxinvoicingGetAutocompleteV2ResponseMPayload() if include_optional: return EzmaxinvoicingGetAutocompleteV2ResponseMPayload( a_obj_ezmaxinvoicing = [ diff --git a/test/test_ezmaxinvoicing_get_object_v2_response.py b/test/test_ezmaxinvoicing_get_object_v2_response.py index 8c1f1333b..979474922 100644 --- a/test/test_ezmaxinvoicing_get_object_v2_response.py +++ b/test/test_ezmaxinvoicing_get_object_v2_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezmaxinvoicing_get_object_v2_response import EzmaxinvoicingGetObjectV2Response # noqa: E501 +from eZmaxApi.models.ezmaxinvoicing_get_object_v2_response import EzmaxinvoicingGetObjectV2Response class TestEzmaxinvoicingGetObjectV2Response(unittest.TestCase): """EzmaxinvoicingGetObjectV2Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzmaxinvoicingGetObjectV2Response: optional params are included """ # uncomment below to create an instance of `EzmaxinvoicingGetObjectV2Response` """ - model = EzmaxinvoicingGetObjectV2Response() # noqa: E501 + model = EzmaxinvoicingGetObjectV2Response() if include_optional: return EzmaxinvoicingGetObjectV2Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezmaxinvoicing_get_object_v2_response_m_payload.py b/test/test_ezmaxinvoicing_get_object_v2_response_m_payload.py index 2e53e1abf..0c78334ac 100644 --- a/test/test_ezmaxinvoicing_get_object_v2_response_m_payload.py +++ b/test/test_ezmaxinvoicing_get_object_v2_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezmaxinvoicing_get_object_v2_response_m_payload import EzmaxinvoicingGetObjectV2ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezmaxinvoicing_get_object_v2_response_m_payload import EzmaxinvoicingGetObjectV2ResponseMPayload class TestEzmaxinvoicingGetObjectV2ResponseMPayload(unittest.TestCase): """EzmaxinvoicingGetObjectV2ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzmaxinvoicingGetObjectV2ResponseMP optional params are included """ # uncomment below to create an instance of `EzmaxinvoicingGetObjectV2ResponseMPayload` """ - model = EzmaxinvoicingGetObjectV2ResponseMPayload() # noqa: E501 + model = EzmaxinvoicingGetObjectV2ResponseMPayload() if include_optional: return EzmaxinvoicingGetObjectV2ResponseMPayload( obj_ezmaxinvoicing = eZmaxApi.models.ezmaxinvoicing_response_compound.ezmaxinvoicing-ResponseCompound() diff --git a/test/test_ezmaxinvoicing_get_provisional_v1_response.py b/test/test_ezmaxinvoicing_get_provisional_v1_response.py index 7c94021c4..fc5d8c098 100644 --- a/test/test_ezmaxinvoicing_get_provisional_v1_response.py +++ b/test/test_ezmaxinvoicing_get_provisional_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezmaxinvoicing_get_provisional_v1_response import EzmaxinvoicingGetProvisionalV1Response # noqa: E501 +from eZmaxApi.models.ezmaxinvoicing_get_provisional_v1_response import EzmaxinvoicingGetProvisionalV1Response class TestEzmaxinvoicingGetProvisionalV1Response(unittest.TestCase): """EzmaxinvoicingGetProvisionalV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzmaxinvoicingGetProvisionalV1Respo optional params are included """ # uncomment below to create an instance of `EzmaxinvoicingGetProvisionalV1Response` """ - model = EzmaxinvoicingGetProvisionalV1Response() # noqa: E501 + model = EzmaxinvoicingGetProvisionalV1Response() if include_optional: return EzmaxinvoicingGetProvisionalV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezmaxinvoicing_get_provisional_v1_response_m_payload.py b/test/test_ezmaxinvoicing_get_provisional_v1_response_m_payload.py index 5b1313637..09b8fba74 100644 --- a/test/test_ezmaxinvoicing_get_provisional_v1_response_m_payload.py +++ b/test/test_ezmaxinvoicing_get_provisional_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezmaxinvoicing_get_provisional_v1_response_m_payload import EzmaxinvoicingGetProvisionalV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezmaxinvoicing_get_provisional_v1_response_m_payload import EzmaxinvoicingGetProvisionalV1ResponseMPayload class TestEzmaxinvoicingGetProvisionalV1ResponseMPayload(unittest.TestCase): """EzmaxinvoicingGetProvisionalV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzmaxinvoicingGetProvisionalV1Respo optional params are included """ # uncomment below to create an instance of `EzmaxinvoicingGetProvisionalV1ResponseMPayload` """ - model = EzmaxinvoicingGetProvisionalV1ResponseMPayload() # noqa: E501 + model = EzmaxinvoicingGetProvisionalV1ResponseMPayload() if include_optional: return EzmaxinvoicingGetProvisionalV1ResponseMPayload( pki_ezmaxinvoicing_id = 28, diff --git a/test/test_ezmaxinvoicing_response.py b/test/test_ezmaxinvoicing_response.py index 30b222098..93e3cf49f 100644 --- a/test/test_ezmaxinvoicing_response.py +++ b/test/test_ezmaxinvoicing_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezmaxinvoicing_response import EzmaxinvoicingResponse # noqa: E501 +from eZmaxApi.models.ezmaxinvoicing_response import EzmaxinvoicingResponse class TestEzmaxinvoicingResponse(unittest.TestCase): """EzmaxinvoicingResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzmaxinvoicingResponse: optional params are included """ # uncomment below to create an instance of `EzmaxinvoicingResponse` """ - model = EzmaxinvoicingResponse() # noqa: E501 + model = EzmaxinvoicingResponse() if include_optional: return EzmaxinvoicingResponse( pki_ezmaxinvoicing_id = 28, diff --git a/test/test_ezmaxinvoicing_response_compound.py b/test/test_ezmaxinvoicing_response_compound.py index 9fe589816..acfb514f1 100644 --- a/test/test_ezmaxinvoicing_response_compound.py +++ b/test/test_ezmaxinvoicing_response_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezmaxinvoicing_response_compound import EzmaxinvoicingResponseCompound # noqa: E501 +from eZmaxApi.models.ezmaxinvoicing_response_compound import EzmaxinvoicingResponseCompound class TestEzmaxinvoicingResponseCompound(unittest.TestCase): """EzmaxinvoicingResponseCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzmaxinvoicingResponseCompound: optional params are included """ # uncomment below to create an instance of `EzmaxinvoicingResponseCompound` """ - model = EzmaxinvoicingResponseCompound() # noqa: E501 + model = EzmaxinvoicingResponseCompound() if include_optional: return EzmaxinvoicingResponseCompound( pki_ezmaxinvoicing_id = 28, diff --git a/test/test_ezmaxinvoicingagent_response.py b/test/test_ezmaxinvoicingagent_response.py index c5b0010be..a4eced6a4 100644 --- a/test/test_ezmaxinvoicingagent_response.py +++ b/test/test_ezmaxinvoicingagent_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezmaxinvoicingagent_response import EzmaxinvoicingagentResponse # noqa: E501 +from eZmaxApi.models.ezmaxinvoicingagent_response import EzmaxinvoicingagentResponse class TestEzmaxinvoicingagentResponse(unittest.TestCase): """EzmaxinvoicingagentResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzmaxinvoicingagentResponse: optional params are included """ # uncomment below to create an instance of `EzmaxinvoicingagentResponse` """ - model = EzmaxinvoicingagentResponse() # noqa: E501 + model = EzmaxinvoicingagentResponse() if include_optional: return EzmaxinvoicingagentResponse( pki_ezmaxinvoicingagent_id = 181, diff --git a/test/test_ezmaxinvoicingagent_response_compound.py b/test/test_ezmaxinvoicingagent_response_compound.py index 8dd1c673f..d7e07863e 100644 --- a/test/test_ezmaxinvoicingagent_response_compound.py +++ b/test/test_ezmaxinvoicingagent_response_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezmaxinvoicingagent_response_compound import EzmaxinvoicingagentResponseCompound # noqa: E501 +from eZmaxApi.models.ezmaxinvoicingagent_response_compound import EzmaxinvoicingagentResponseCompound class TestEzmaxinvoicingagentResponseCompound(unittest.TestCase): """EzmaxinvoicingagentResponseCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzmaxinvoicingagentResponseCompound optional params are included """ # uncomment below to create an instance of `EzmaxinvoicingagentResponseCompound` """ - model = EzmaxinvoicingagentResponseCompound() # noqa: E501 + model = EzmaxinvoicingagentResponseCompound() if include_optional: return EzmaxinvoicingagentResponseCompound( pki_ezmaxinvoicingagent_id = 181, diff --git a/test/test_ezmaxinvoicingcommission_response.py b/test/test_ezmaxinvoicingcommission_response.py index b1ea552de..8752cd432 100644 --- a/test/test_ezmaxinvoicingcommission_response.py +++ b/test/test_ezmaxinvoicingcommission_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezmaxinvoicingcommission_response import EzmaxinvoicingcommissionResponse # noqa: E501 +from eZmaxApi.models.ezmaxinvoicingcommission_response import EzmaxinvoicingcommissionResponse class TestEzmaxinvoicingcommissionResponse(unittest.TestCase): """EzmaxinvoicingcommissionResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzmaxinvoicingcommissionResponse: optional params are included """ # uncomment below to create an instance of `EzmaxinvoicingcommissionResponse` """ - model = EzmaxinvoicingcommissionResponse() # noqa: E501 + model = EzmaxinvoicingcommissionResponse() if include_optional: return EzmaxinvoicingcommissionResponse( pki_ezmaxinvoicingcommission_id = 36, diff --git a/test/test_ezmaxinvoicingcommission_response_compound.py b/test/test_ezmaxinvoicingcommission_response_compound.py index ae80c46de..79dd4ba8e 100644 --- a/test/test_ezmaxinvoicingcommission_response_compound.py +++ b/test/test_ezmaxinvoicingcommission_response_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezmaxinvoicingcommission_response_compound import EzmaxinvoicingcommissionResponseCompound # noqa: E501 +from eZmaxApi.models.ezmaxinvoicingcommission_response_compound import EzmaxinvoicingcommissionResponseCompound class TestEzmaxinvoicingcommissionResponseCompound(unittest.TestCase): """EzmaxinvoicingcommissionResponseCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzmaxinvoicingcommissionResponseCom optional params are included """ # uncomment below to create an instance of `EzmaxinvoicingcommissionResponseCompound` """ - model = EzmaxinvoicingcommissionResponseCompound() # noqa: E501 + model = EzmaxinvoicingcommissionResponseCompound() if include_optional: return EzmaxinvoicingcommissionResponseCompound( pki_ezmaxinvoicingcommission_id = 36, diff --git a/test/test_ezmaxinvoicingcontract_response.py b/test/test_ezmaxinvoicingcontract_response.py index fad0a262a..2270c4654 100644 --- a/test/test_ezmaxinvoicingcontract_response.py +++ b/test/test_ezmaxinvoicingcontract_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezmaxinvoicingcontract_response import EzmaxinvoicingcontractResponse # noqa: E501 +from eZmaxApi.models.ezmaxinvoicingcontract_response import EzmaxinvoicingcontractResponse class TestEzmaxinvoicingcontractResponse(unittest.TestCase): """EzmaxinvoicingcontractResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzmaxinvoicingcontractResponse: optional params are included """ # uncomment below to create an instance of `EzmaxinvoicingcontractResponse` """ - model = EzmaxinvoicingcontractResponse() # noqa: E501 + model = EzmaxinvoicingcontractResponse() if include_optional: return EzmaxinvoicingcontractResponse( pki_ezmaxinvoicingcontract_id = 28, diff --git a/test/test_ezmaxinvoicingcontract_response_compound.py b/test/test_ezmaxinvoicingcontract_response_compound.py index c76883bb3..7d2d9c072 100644 --- a/test/test_ezmaxinvoicingcontract_response_compound.py +++ b/test/test_ezmaxinvoicingcontract_response_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezmaxinvoicingcontract_response_compound import EzmaxinvoicingcontractResponseCompound # noqa: E501 +from eZmaxApi.models.ezmaxinvoicingcontract_response_compound import EzmaxinvoicingcontractResponseCompound class TestEzmaxinvoicingcontractResponseCompound(unittest.TestCase): """EzmaxinvoicingcontractResponseCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzmaxinvoicingcontractResponseCompo optional params are included """ # uncomment below to create an instance of `EzmaxinvoicingcontractResponseCompound` """ - model = EzmaxinvoicingcontractResponseCompound() # noqa: E501 + model = EzmaxinvoicingcontractResponseCompound() if include_optional: return EzmaxinvoicingcontractResponseCompound( pki_ezmaxinvoicingcontract_id = 28, diff --git a/test/test_ezmaxinvoicingsummaryexternal_response.py b/test/test_ezmaxinvoicingsummaryexternal_response.py index 695b5f52c..a65f8c38f 100644 --- a/test/test_ezmaxinvoicingsummaryexternal_response.py +++ b/test/test_ezmaxinvoicingsummaryexternal_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezmaxinvoicingsummaryexternal_response import EzmaxinvoicingsummaryexternalResponse # noqa: E501 +from eZmaxApi.models.ezmaxinvoicingsummaryexternal_response import EzmaxinvoicingsummaryexternalResponse class TestEzmaxinvoicingsummaryexternalResponse(unittest.TestCase): """EzmaxinvoicingsummaryexternalResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzmaxinvoicingsummaryexternalRespon optional params are included """ # uncomment below to create an instance of `EzmaxinvoicingsummaryexternalResponse` """ - model = EzmaxinvoicingsummaryexternalResponse() # noqa: E501 + model = EzmaxinvoicingsummaryexternalResponse() if include_optional: return EzmaxinvoicingsummaryexternalResponse( pki_ezmaxinvoicingsummaryexternal_id = 177, diff --git a/test/test_ezmaxinvoicingsummaryexternal_response_compound.py b/test/test_ezmaxinvoicingsummaryexternal_response_compound.py index b9bab4b08..8f40d8be6 100644 --- a/test/test_ezmaxinvoicingsummaryexternal_response_compound.py +++ b/test/test_ezmaxinvoicingsummaryexternal_response_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezmaxinvoicingsummaryexternal_response_compound import EzmaxinvoicingsummaryexternalResponseCompound # noqa: E501 +from eZmaxApi.models.ezmaxinvoicingsummaryexternal_response_compound import EzmaxinvoicingsummaryexternalResponseCompound class TestEzmaxinvoicingsummaryexternalResponseCompound(unittest.TestCase): """EzmaxinvoicingsummaryexternalResponseCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzmaxinvoicingsummaryexternalRespon optional params are included """ # uncomment below to create an instance of `EzmaxinvoicingsummaryexternalResponseCompound` """ - model = EzmaxinvoicingsummaryexternalResponseCompound() # noqa: E501 + model = EzmaxinvoicingsummaryexternalResponseCompound() if include_optional: return EzmaxinvoicingsummaryexternalResponseCompound( pki_ezmaxinvoicingsummaryexternal_id = 177, diff --git a/test/test_ezmaxinvoicingsummaryexternaldetail_response.py b/test/test_ezmaxinvoicingsummaryexternaldetail_response.py index 25d1a0cd7..f6930869f 100644 --- a/test/test_ezmaxinvoicingsummaryexternaldetail_response.py +++ b/test/test_ezmaxinvoicingsummaryexternaldetail_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezmaxinvoicingsummaryexternaldetail_response import EzmaxinvoicingsummaryexternaldetailResponse # noqa: E501 +from eZmaxApi.models.ezmaxinvoicingsummaryexternaldetail_response import EzmaxinvoicingsummaryexternaldetailResponse class TestEzmaxinvoicingsummaryexternaldetailResponse(unittest.TestCase): """EzmaxinvoicingsummaryexternaldetailResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> Ezmaxinvoicingsummaryexternaldetail optional params are included """ # uncomment below to create an instance of `EzmaxinvoicingsummaryexternaldetailResponse` """ - model = EzmaxinvoicingsummaryexternaldetailResponse() # noqa: E501 + model = EzmaxinvoicingsummaryexternaldetailResponse() if include_optional: return EzmaxinvoicingsummaryexternaldetailResponse( pki_ezmaxinvoicingsummaryexternaldetail_id = 163, diff --git a/test/test_ezmaxinvoicingsummaryexternaldetail_response_compound.py b/test/test_ezmaxinvoicingsummaryexternaldetail_response_compound.py index a6717e4a1..4eab7bfd5 100644 --- a/test/test_ezmaxinvoicingsummaryexternaldetail_response_compound.py +++ b/test/test_ezmaxinvoicingsummaryexternaldetail_response_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezmaxinvoicingsummaryexternaldetail_response_compound import EzmaxinvoicingsummaryexternaldetailResponseCompound # noqa: E501 +from eZmaxApi.models.ezmaxinvoicingsummaryexternaldetail_response_compound import EzmaxinvoicingsummaryexternaldetailResponseCompound class TestEzmaxinvoicingsummaryexternaldetailResponseCompound(unittest.TestCase): """EzmaxinvoicingsummaryexternaldetailResponseCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> Ezmaxinvoicingsummaryexternaldetail optional params are included """ # uncomment below to create an instance of `EzmaxinvoicingsummaryexternaldetailResponseCompound` """ - model = EzmaxinvoicingsummaryexternaldetailResponseCompound() # noqa: E501 + model = EzmaxinvoicingsummaryexternaldetailResponseCompound() if include_optional: return EzmaxinvoicingsummaryexternaldetailResponseCompound( pki_ezmaxinvoicingsummaryexternaldetail_id = 163, diff --git a/test/test_ezmaxinvoicingsummaryglobal_response.py b/test/test_ezmaxinvoicingsummaryglobal_response.py index f6826d665..5dc5a3993 100644 --- a/test/test_ezmaxinvoicingsummaryglobal_response.py +++ b/test/test_ezmaxinvoicingsummaryglobal_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezmaxinvoicingsummaryglobal_response import EzmaxinvoicingsummaryglobalResponse # noqa: E501 +from eZmaxApi.models.ezmaxinvoicingsummaryglobal_response import EzmaxinvoicingsummaryglobalResponse class TestEzmaxinvoicingsummaryglobalResponse(unittest.TestCase): """EzmaxinvoicingsummaryglobalResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzmaxinvoicingsummaryglobalResponse optional params are included """ # uncomment below to create an instance of `EzmaxinvoicingsummaryglobalResponse` """ - model = EzmaxinvoicingsummaryglobalResponse() # noqa: E501 + model = EzmaxinvoicingsummaryglobalResponse() if include_optional: return EzmaxinvoicingsummaryglobalResponse( pki_ezmaxinvoicingsummaryglobal_id = 241, diff --git a/test/test_ezmaxinvoicingsummaryglobal_response_compound.py b/test/test_ezmaxinvoicingsummaryglobal_response_compound.py index 40898c312..44428b8eb 100644 --- a/test/test_ezmaxinvoicingsummaryglobal_response_compound.py +++ b/test/test_ezmaxinvoicingsummaryglobal_response_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezmaxinvoicingsummaryglobal_response_compound import EzmaxinvoicingsummaryglobalResponseCompound # noqa: E501 +from eZmaxApi.models.ezmaxinvoicingsummaryglobal_response_compound import EzmaxinvoicingsummaryglobalResponseCompound class TestEzmaxinvoicingsummaryglobalResponseCompound(unittest.TestCase): """EzmaxinvoicingsummaryglobalResponseCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzmaxinvoicingsummaryglobalResponse optional params are included """ # uncomment below to create an instance of `EzmaxinvoicingsummaryglobalResponseCompound` """ - model = EzmaxinvoicingsummaryglobalResponseCompound() # noqa: E501 + model = EzmaxinvoicingsummaryglobalResponseCompound() if include_optional: return EzmaxinvoicingsummaryglobalResponseCompound( pki_ezmaxinvoicingsummaryglobal_id = 241, diff --git a/test/test_ezmaxinvoicingsummaryinternal_response.py b/test/test_ezmaxinvoicingsummaryinternal_response.py index b9cd09380..d4ba1cfd1 100644 --- a/test/test_ezmaxinvoicingsummaryinternal_response.py +++ b/test/test_ezmaxinvoicingsummaryinternal_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezmaxinvoicingsummaryinternal_response import EzmaxinvoicingsummaryinternalResponse # noqa: E501 +from eZmaxApi.models.ezmaxinvoicingsummaryinternal_response import EzmaxinvoicingsummaryinternalResponse class TestEzmaxinvoicingsummaryinternalResponse(unittest.TestCase): """EzmaxinvoicingsummaryinternalResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzmaxinvoicingsummaryinternalRespon optional params are included """ # uncomment below to create an instance of `EzmaxinvoicingsummaryinternalResponse` """ - model = EzmaxinvoicingsummaryinternalResponse() # noqa: E501 + model = EzmaxinvoicingsummaryinternalResponse() if include_optional: return EzmaxinvoicingsummaryinternalResponse( pki_ezmaxinvoicingsummaryinternal_id = 57, diff --git a/test/test_ezmaxinvoicingsummaryinternal_response_compound.py b/test/test_ezmaxinvoicingsummaryinternal_response_compound.py index 1c941736a..7dd9e0e22 100644 --- a/test/test_ezmaxinvoicingsummaryinternal_response_compound.py +++ b/test/test_ezmaxinvoicingsummaryinternal_response_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezmaxinvoicingsummaryinternal_response_compound import EzmaxinvoicingsummaryinternalResponseCompound # noqa: E501 +from eZmaxApi.models.ezmaxinvoicingsummaryinternal_response_compound import EzmaxinvoicingsummaryinternalResponseCompound class TestEzmaxinvoicingsummaryinternalResponseCompound(unittest.TestCase): """EzmaxinvoicingsummaryinternalResponseCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzmaxinvoicingsummaryinternalRespon optional params are included """ # uncomment below to create an instance of `EzmaxinvoicingsummaryinternalResponseCompound` """ - model = EzmaxinvoicingsummaryinternalResponseCompound() # noqa: E501 + model = EzmaxinvoicingsummaryinternalResponseCompound() if include_optional: return EzmaxinvoicingsummaryinternalResponseCompound( pki_ezmaxinvoicingsummaryinternal_id = 57, diff --git a/test/test_ezmaxinvoicingsummaryinternaldetail_response.py b/test/test_ezmaxinvoicingsummaryinternaldetail_response.py index 71850351f..ffd84eed6 100644 --- a/test/test_ezmaxinvoicingsummaryinternaldetail_response.py +++ b/test/test_ezmaxinvoicingsummaryinternaldetail_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezmaxinvoicingsummaryinternaldetail_response import EzmaxinvoicingsummaryinternaldetailResponse # noqa: E501 +from eZmaxApi.models.ezmaxinvoicingsummaryinternaldetail_response import EzmaxinvoicingsummaryinternaldetailResponse class TestEzmaxinvoicingsummaryinternaldetailResponse(unittest.TestCase): """EzmaxinvoicingsummaryinternaldetailResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> Ezmaxinvoicingsummaryinternaldetail optional params are included """ # uncomment below to create an instance of `EzmaxinvoicingsummaryinternaldetailResponse` """ - model = EzmaxinvoicingsummaryinternaldetailResponse() # noqa: E501 + model = EzmaxinvoicingsummaryinternaldetailResponse() if include_optional: return EzmaxinvoicingsummaryinternaldetailResponse( pki_ezmaxinvoicingsummaryinternaldetail_id = 73, diff --git a/test/test_ezmaxinvoicingsummaryinternaldetail_response_compound.py b/test/test_ezmaxinvoicingsummaryinternaldetail_response_compound.py index 2428b9f02..c27b1a66f 100644 --- a/test/test_ezmaxinvoicingsummaryinternaldetail_response_compound.py +++ b/test/test_ezmaxinvoicingsummaryinternaldetail_response_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezmaxinvoicingsummaryinternaldetail_response_compound import EzmaxinvoicingsummaryinternaldetailResponseCompound # noqa: E501 +from eZmaxApi.models.ezmaxinvoicingsummaryinternaldetail_response_compound import EzmaxinvoicingsummaryinternaldetailResponseCompound class TestEzmaxinvoicingsummaryinternaldetailResponseCompound(unittest.TestCase): """EzmaxinvoicingsummaryinternaldetailResponseCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> Ezmaxinvoicingsummaryinternaldetail optional params are included """ # uncomment below to create an instance of `EzmaxinvoicingsummaryinternaldetailResponseCompound` """ - model = EzmaxinvoicingsummaryinternaldetailResponseCompound() # noqa: E501 + model = EzmaxinvoicingsummaryinternaldetailResponseCompound() if include_optional: return EzmaxinvoicingsummaryinternaldetailResponseCompound( pki_ezmaxinvoicingsummaryinternaldetail_id = 73, diff --git a/test/test_ezmaxinvoicinguser_response.py b/test/test_ezmaxinvoicinguser_response.py index 14390673b..eee26636a 100644 --- a/test/test_ezmaxinvoicinguser_response.py +++ b/test/test_ezmaxinvoicinguser_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezmaxinvoicinguser_response import EzmaxinvoicinguserResponse # noqa: E501 +from eZmaxApi.models.ezmaxinvoicinguser_response import EzmaxinvoicinguserResponse class TestEzmaxinvoicinguserResponse(unittest.TestCase): """EzmaxinvoicinguserResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzmaxinvoicinguserResponse: optional params are included """ # uncomment below to create an instance of `EzmaxinvoicinguserResponse` """ - model = EzmaxinvoicinguserResponse() # noqa: E501 + model = EzmaxinvoicinguserResponse() if include_optional: return EzmaxinvoicinguserResponse( pki_ezmaxinvoicinguser_id = 202, diff --git a/test/test_ezmaxinvoicinguser_response_compound.py b/test/test_ezmaxinvoicinguser_response_compound.py index 97d4386c7..1f2c54b89 100644 --- a/test/test_ezmaxinvoicinguser_response_compound.py +++ b/test/test_ezmaxinvoicinguser_response_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezmaxinvoicinguser_response_compound import EzmaxinvoicinguserResponseCompound # noqa: E501 +from eZmaxApi.models.ezmaxinvoicinguser_response_compound import EzmaxinvoicinguserResponseCompound class TestEzmaxinvoicinguserResponseCompound(unittest.TestCase): """EzmaxinvoicinguserResponseCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzmaxinvoicinguserResponseCompound: optional params are included """ # uncomment below to create an instance of `EzmaxinvoicinguserResponseCompound` """ - model = EzmaxinvoicinguserResponseCompound() # noqa: E501 + model = EzmaxinvoicinguserResponseCompound() if include_optional: return EzmaxinvoicinguserResponseCompound( pki_ezmaxinvoicinguser_id = 202, diff --git a/test/test_ezmaxproduct_autocomplete_element_response.py b/test/test_ezmaxproduct_autocomplete_element_response.py index 9641debea..7e8a9b118 100644 --- a/test/test_ezmaxproduct_autocomplete_element_response.py +++ b/test/test_ezmaxproduct_autocomplete_element_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezmaxproduct_autocomplete_element_response import EzmaxproductAutocompleteElementResponse # noqa: E501 +from eZmaxApi.models.ezmaxproduct_autocomplete_element_response import EzmaxproductAutocompleteElementResponse class TestEzmaxproductAutocompleteElementResponse(unittest.TestCase): """EzmaxproductAutocompleteElementResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzmaxproductAutocompleteElementResp optional params are included """ # uncomment below to create an instance of `EzmaxproductAutocompleteElementResponse` """ - model = EzmaxproductAutocompleteElementResponse() # noqa: E501 + model = EzmaxproductAutocompleteElementResponse() if include_optional: return EzmaxproductAutocompleteElementResponse( pki_ezmaxproduct_id = 172, diff --git a/test/test_ezmaxproduct_get_autocomplete_v2_response.py b/test/test_ezmaxproduct_get_autocomplete_v2_response.py index eeccebaa3..b9d5965f0 100644 --- a/test/test_ezmaxproduct_get_autocomplete_v2_response.py +++ b/test/test_ezmaxproduct_get_autocomplete_v2_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezmaxproduct_get_autocomplete_v2_response import EzmaxproductGetAutocompleteV2Response # noqa: E501 +from eZmaxApi.models.ezmaxproduct_get_autocomplete_v2_response import EzmaxproductGetAutocompleteV2Response class TestEzmaxproductGetAutocompleteV2Response(unittest.TestCase): """EzmaxproductGetAutocompleteV2Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzmaxproductGetAutocompleteV2Respon optional params are included """ # uncomment below to create an instance of `EzmaxproductGetAutocompleteV2Response` """ - model = EzmaxproductGetAutocompleteV2Response() # noqa: E501 + model = EzmaxproductGetAutocompleteV2Response() if include_optional: return EzmaxproductGetAutocompleteV2Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezmaxproduct_get_autocomplete_v2_response_m_payload.py b/test/test_ezmaxproduct_get_autocomplete_v2_response_m_payload.py index 8ef5178d0..3d5c9197a 100644 --- a/test/test_ezmaxproduct_get_autocomplete_v2_response_m_payload.py +++ b/test/test_ezmaxproduct_get_autocomplete_v2_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezmaxproduct_get_autocomplete_v2_response_m_payload import EzmaxproductGetAutocompleteV2ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezmaxproduct_get_autocomplete_v2_response_m_payload import EzmaxproductGetAutocompleteV2ResponseMPayload class TestEzmaxproductGetAutocompleteV2ResponseMPayload(unittest.TestCase): """EzmaxproductGetAutocompleteV2ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzmaxproductGetAutocompleteV2Respon optional params are included """ # uncomment below to create an instance of `EzmaxproductGetAutocompleteV2ResponseMPayload` """ - model = EzmaxproductGetAutocompleteV2ResponseMPayload() # noqa: E501 + model = EzmaxproductGetAutocompleteV2ResponseMPayload() if include_optional: return EzmaxproductGetAutocompleteV2ResponseMPayload( a_obj_ezmaxproduct = [ diff --git a/test/test_ezsign_suggest_signers_v1_response.py b/test/test_ezsign_suggest_signers_v1_response.py index 9860e8876..932989bbb 100644 --- a/test/test_ezsign_suggest_signers_v1_response.py +++ b/test/test_ezsign_suggest_signers_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsign_suggest_signers_v1_response import EzsignSuggestSignersV1Response # noqa: E501 +from eZmaxApi.models.ezsign_suggest_signers_v1_response import EzsignSuggestSignersV1Response class TestEzsignSuggestSignersV1Response(unittest.TestCase): """EzsignSuggestSignersV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignSuggestSignersV1Response: optional params are included """ # uncomment below to create an instance of `EzsignSuggestSignersV1Response` """ - model = EzsignSuggestSignersV1Response() # noqa: E501 + model = EzsignSuggestSignersV1Response() if include_optional: return EzsignSuggestSignersV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsign_suggest_signers_v1_response_m_payload.py b/test/test_ezsign_suggest_signers_v1_response_m_payload.py index d7c0129a5..3e99a935d 100644 --- a/test/test_ezsign_suggest_signers_v1_response_m_payload.py +++ b/test/test_ezsign_suggest_signers_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsign_suggest_signers_v1_response_m_payload import EzsignSuggestSignersV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezsign_suggest_signers_v1_response_m_payload import EzsignSuggestSignersV1ResponseMPayload class TestEzsignSuggestSignersV1ResponseMPayload(unittest.TestCase): """EzsignSuggestSignersV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignSuggestSignersV1ResponseMPayl optional params are included """ # uncomment below to create an instance of `EzsignSuggestSignersV1ResponseMPayload` """ - model = EzsignSuggestSignersV1ResponseMPayload() # noqa: E501 + model = EzsignSuggestSignersV1ResponseMPayload() if include_optional: return EzsignSuggestSignersV1ResponseMPayload( a_obj_ezsignfoldersignerassociation = [ diff --git a/test/test_ezsign_suggest_templates_v1_response.py b/test/test_ezsign_suggest_templates_v1_response.py index fbfe32bef..a9e700dcb 100644 --- a/test/test_ezsign_suggest_templates_v1_response.py +++ b/test/test_ezsign_suggest_templates_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsign_suggest_templates_v1_response import EzsignSuggestTemplatesV1Response # noqa: E501 +from eZmaxApi.models.ezsign_suggest_templates_v1_response import EzsignSuggestTemplatesV1Response class TestEzsignSuggestTemplatesV1Response(unittest.TestCase): """EzsignSuggestTemplatesV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignSuggestTemplatesV1Response: optional params are included """ # uncomment below to create an instance of `EzsignSuggestTemplatesV1Response` """ - model = EzsignSuggestTemplatesV1Response() # noqa: E501 + model = EzsignSuggestTemplatesV1Response() if include_optional: return EzsignSuggestTemplatesV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsign_suggest_templates_v1_response_m_payload.py b/test/test_ezsign_suggest_templates_v1_response_m_payload.py index 4966f57ce..d901d9fdf 100644 --- a/test/test_ezsign_suggest_templates_v1_response_m_payload.py +++ b/test/test_ezsign_suggest_templates_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsign_suggest_templates_v1_response_m_payload import EzsignSuggestTemplatesV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezsign_suggest_templates_v1_response_m_payload import EzsignSuggestTemplatesV1ResponseMPayload class TestEzsignSuggestTemplatesV1ResponseMPayload(unittest.TestCase): """EzsignSuggestTemplatesV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignSuggestTemplatesV1ResponseMPa optional params are included """ # uncomment below to create an instance of `EzsignSuggestTemplatesV1ResponseMPayload` """ - model = EzsignSuggestTemplatesV1ResponseMPayload() # noqa: E501 + model = EzsignSuggestTemplatesV1ResponseMPayload() if include_optional: return EzsignSuggestTemplatesV1ResponseMPayload( a_obj_ezsigntemplate = [ diff --git a/test/test_ezsignannotation_response.py b/test/test_ezsignannotation_response.py index 35ead4cf0..6bc7918fe 100644 --- a/test/test_ezsignannotation_response.py +++ b/test/test_ezsignannotation_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignannotation_response import EzsignannotationResponse # noqa: E501 +from eZmaxApi.models.ezsignannotation_response import EzsignannotationResponse class TestEzsignannotationResponse(unittest.TestCase): """EzsignannotationResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignannotationResponse: optional params are included """ # uncomment below to create an instance of `EzsignannotationResponse` """ - model = EzsignannotationResponse() # noqa: E501 + model = EzsignannotationResponse() if include_optional: return EzsignannotationResponse( pki_ezsignannotation_id = 113, diff --git a/test/test_ezsignannotation_response_compound.py b/test/test_ezsignannotation_response_compound.py index 2752a8249..76b9b555f 100644 --- a/test/test_ezsignannotation_response_compound.py +++ b/test/test_ezsignannotation_response_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignannotation_response_compound import EzsignannotationResponseCompound # noqa: E501 +from eZmaxApi.models.ezsignannotation_response_compound import EzsignannotationResponseCompound class TestEzsignannotationResponseCompound(unittest.TestCase): """EzsignannotationResponseCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignannotationResponseCompound: optional params are included """ # uncomment below to create an instance of `EzsignannotationResponseCompound` """ - model = EzsignannotationResponseCompound() # noqa: E501 + model = EzsignannotationResponseCompound() if include_optional: return EzsignannotationResponseCompound( pki_ezsignannotation_id = 113, diff --git a/test/test_ezsignbulksend_create_ezsignbulksendtransmission_v1_request.py b/test/test_ezsignbulksend_create_ezsignbulksendtransmission_v1_request.py index 2567b583d..48c5ac16d 100644 --- a/test/test_ezsignbulksend_create_ezsignbulksendtransmission_v1_request.py +++ b/test/test_ezsignbulksend_create_ezsignbulksendtransmission_v1_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignbulksend_create_ezsignbulksendtransmission_v1_request import EzsignbulksendCreateEzsignbulksendtransmissionV1Request # noqa: E501 +from eZmaxApi.models.ezsignbulksend_create_ezsignbulksendtransmission_v1_request import EzsignbulksendCreateEzsignbulksendtransmissionV1Request class TestEzsignbulksendCreateEzsignbulksendtransmissionV1Request(unittest.TestCase): """EzsignbulksendCreateEzsignbulksendtransmissionV1Request unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignbulksendCreateEzsignbulksendt optional params are included """ # uncomment below to create an instance of `EzsignbulksendCreateEzsignbulksendtransmissionV1Request` """ - model = EzsignbulksendCreateEzsignbulksendtransmissionV1Request() # noqa: E501 + model = EzsignbulksendCreateEzsignbulksendtransmissionV1Request() if include_optional: return EzsignbulksendCreateEzsignbulksendtransmissionV1Request( fki_userlogintype_id = 2, diff --git a/test/test_ezsignbulksend_create_ezsignbulksendtransmission_v1_response.py b/test/test_ezsignbulksend_create_ezsignbulksendtransmission_v1_response.py index b98b9d344..3ad3353ea 100644 --- a/test/test_ezsignbulksend_create_ezsignbulksendtransmission_v1_response.py +++ b/test/test_ezsignbulksend_create_ezsignbulksendtransmission_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignbulksend_create_ezsignbulksendtransmission_v1_response import EzsignbulksendCreateEzsignbulksendtransmissionV1Response # noqa: E501 +from eZmaxApi.models.ezsignbulksend_create_ezsignbulksendtransmission_v1_response import EzsignbulksendCreateEzsignbulksendtransmissionV1Response class TestEzsignbulksendCreateEzsignbulksendtransmissionV1Response(unittest.TestCase): """EzsignbulksendCreateEzsignbulksendtransmissionV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignbulksendCreateEzsignbulksendt optional params are included """ # uncomment below to create an instance of `EzsignbulksendCreateEzsignbulksendtransmissionV1Response` """ - model = EzsignbulksendCreateEzsignbulksendtransmissionV1Response() # noqa: E501 + model = EzsignbulksendCreateEzsignbulksendtransmissionV1Response() if include_optional: return EzsignbulksendCreateEzsignbulksendtransmissionV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsignbulksend_create_ezsignbulksendtransmission_v1_response_m_payload.py b/test/test_ezsignbulksend_create_ezsignbulksendtransmission_v1_response_m_payload.py index eb9bdc30c..8b397e2a8 100644 --- a/test/test_ezsignbulksend_create_ezsignbulksendtransmission_v1_response_m_payload.py +++ b/test/test_ezsignbulksend_create_ezsignbulksendtransmission_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignbulksend_create_ezsignbulksendtransmission_v1_response_m_payload import EzsignbulksendCreateEzsignbulksendtransmissionV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezsignbulksend_create_ezsignbulksendtransmission_v1_response_m_payload import EzsignbulksendCreateEzsignbulksendtransmissionV1ResponseMPayload class TestEzsignbulksendCreateEzsignbulksendtransmissionV1ResponseMPayload(unittest.TestCase): """EzsignbulksendCreateEzsignbulksendtransmissionV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignbulksendCreateEzsignbulksendt optional params are included """ # uncomment below to create an instance of `EzsignbulksendCreateEzsignbulksendtransmissionV1ResponseMPayload` """ - model = EzsignbulksendCreateEzsignbulksendtransmissionV1ResponseMPayload() # noqa: E501 + model = EzsignbulksendCreateEzsignbulksendtransmissionV1ResponseMPayload() if include_optional: return EzsignbulksendCreateEzsignbulksendtransmissionV1ResponseMPayload( obj_ezsignbulksendtransmission = eZmaxApi.models.ezsignbulksendtransmission_response.ezsignbulksendtransmission-Response( diff --git a/test/test_ezsignbulksend_create_object_v1_request.py b/test/test_ezsignbulksend_create_object_v1_request.py index 54978454d..0d9aefde9 100644 --- a/test/test_ezsignbulksend_create_object_v1_request.py +++ b/test/test_ezsignbulksend_create_object_v1_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignbulksend_create_object_v1_request import EzsignbulksendCreateObjectV1Request # noqa: E501 +from eZmaxApi.models.ezsignbulksend_create_object_v1_request import EzsignbulksendCreateObjectV1Request class TestEzsignbulksendCreateObjectV1Request(unittest.TestCase): """EzsignbulksendCreateObjectV1Request unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignbulksendCreateObjectV1Request optional params are included """ # uncomment below to create an instance of `EzsignbulksendCreateObjectV1Request` """ - model = EzsignbulksendCreateObjectV1Request() # noqa: E501 + model = EzsignbulksendCreateObjectV1Request() if include_optional: return EzsignbulksendCreateObjectV1Request( a_obj_ezsignbulksend = [ diff --git a/test/test_ezsignbulksend_create_object_v1_response.py b/test/test_ezsignbulksend_create_object_v1_response.py index 7422a4c68..90bdad1b7 100644 --- a/test/test_ezsignbulksend_create_object_v1_response.py +++ b/test/test_ezsignbulksend_create_object_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignbulksend_create_object_v1_response import EzsignbulksendCreateObjectV1Response # noqa: E501 +from eZmaxApi.models.ezsignbulksend_create_object_v1_response import EzsignbulksendCreateObjectV1Response class TestEzsignbulksendCreateObjectV1Response(unittest.TestCase): """EzsignbulksendCreateObjectV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignbulksendCreateObjectV1Respons optional params are included """ # uncomment below to create an instance of `EzsignbulksendCreateObjectV1Response` """ - model = EzsignbulksendCreateObjectV1Response() # noqa: E501 + model = EzsignbulksendCreateObjectV1Response() if include_optional: return EzsignbulksendCreateObjectV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsignbulksend_create_object_v1_response_m_payload.py b/test/test_ezsignbulksend_create_object_v1_response_m_payload.py index 8dcbe01fd..35ace2b5d 100644 --- a/test/test_ezsignbulksend_create_object_v1_response_m_payload.py +++ b/test/test_ezsignbulksend_create_object_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignbulksend_create_object_v1_response_m_payload import EzsignbulksendCreateObjectV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezsignbulksend_create_object_v1_response_m_payload import EzsignbulksendCreateObjectV1ResponseMPayload class TestEzsignbulksendCreateObjectV1ResponseMPayload(unittest.TestCase): """EzsignbulksendCreateObjectV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignbulksendCreateObjectV1Respons optional params are included """ # uncomment below to create an instance of `EzsignbulksendCreateObjectV1ResponseMPayload` """ - model = EzsignbulksendCreateObjectV1ResponseMPayload() # noqa: E501 + model = EzsignbulksendCreateObjectV1ResponseMPayload() if include_optional: return EzsignbulksendCreateObjectV1ResponseMPayload( a_pki_ezsignbulksend_id = [ diff --git a/test/test_ezsignbulksend_delete_object_v1_response.py b/test/test_ezsignbulksend_delete_object_v1_response.py index cecac2fb1..7889b751b 100644 --- a/test/test_ezsignbulksend_delete_object_v1_response.py +++ b/test/test_ezsignbulksend_delete_object_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignbulksend_delete_object_v1_response import EzsignbulksendDeleteObjectV1Response # noqa: E501 +from eZmaxApi.models.ezsignbulksend_delete_object_v1_response import EzsignbulksendDeleteObjectV1Response class TestEzsignbulksendDeleteObjectV1Response(unittest.TestCase): """EzsignbulksendDeleteObjectV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignbulksendDeleteObjectV1Respons optional params are included """ # uncomment below to create an instance of `EzsignbulksendDeleteObjectV1Response` """ - model = EzsignbulksendDeleteObjectV1Response() # noqa: E501 + model = EzsignbulksendDeleteObjectV1Response() if include_optional: return EzsignbulksendDeleteObjectV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsignbulksend_edit_object_v1_request.py b/test/test_ezsignbulksend_edit_object_v1_request.py index 42d0dace3..27c4e7ad5 100644 --- a/test/test_ezsignbulksend_edit_object_v1_request.py +++ b/test/test_ezsignbulksend_edit_object_v1_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignbulksend_edit_object_v1_request import EzsignbulksendEditObjectV1Request # noqa: E501 +from eZmaxApi.models.ezsignbulksend_edit_object_v1_request import EzsignbulksendEditObjectV1Request class TestEzsignbulksendEditObjectV1Request(unittest.TestCase): """EzsignbulksendEditObjectV1Request unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignbulksendEditObjectV1Request: optional params are included """ # uncomment below to create an instance of `EzsignbulksendEditObjectV1Request` """ - model = EzsignbulksendEditObjectV1Request() # noqa: E501 + model = EzsignbulksendEditObjectV1Request() if include_optional: return EzsignbulksendEditObjectV1Request( obj_ezsignbulksend = eZmaxApi.models.ezsignbulksend_request_compound.ezsignbulksend-RequestCompound() diff --git a/test/test_ezsignbulksend_edit_object_v1_response.py b/test/test_ezsignbulksend_edit_object_v1_response.py index 8ad828809..0357a50e3 100644 --- a/test/test_ezsignbulksend_edit_object_v1_response.py +++ b/test/test_ezsignbulksend_edit_object_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignbulksend_edit_object_v1_response import EzsignbulksendEditObjectV1Response # noqa: E501 +from eZmaxApi.models.ezsignbulksend_edit_object_v1_response import EzsignbulksendEditObjectV1Response class TestEzsignbulksendEditObjectV1Response(unittest.TestCase): """EzsignbulksendEditObjectV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignbulksendEditObjectV1Response: optional params are included """ # uncomment below to create an instance of `EzsignbulksendEditObjectV1Response` """ - model = EzsignbulksendEditObjectV1Response() # noqa: E501 + model = EzsignbulksendEditObjectV1Response() if include_optional: return EzsignbulksendEditObjectV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsignbulksend_get_ezsignbulksendtransmissions_v1_response.py b/test/test_ezsignbulksend_get_ezsignbulksendtransmissions_v1_response.py index 1ba871710..35812f57f 100644 --- a/test/test_ezsignbulksend_get_ezsignbulksendtransmissions_v1_response.py +++ b/test/test_ezsignbulksend_get_ezsignbulksendtransmissions_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignbulksend_get_ezsignbulksendtransmissions_v1_response import EzsignbulksendGetEzsignbulksendtransmissionsV1Response # noqa: E501 +from eZmaxApi.models.ezsignbulksend_get_ezsignbulksendtransmissions_v1_response import EzsignbulksendGetEzsignbulksendtransmissionsV1Response class TestEzsignbulksendGetEzsignbulksendtransmissionsV1Response(unittest.TestCase): """EzsignbulksendGetEzsignbulksendtransmissionsV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignbulksendGetEzsignbulksendtran optional params are included """ # uncomment below to create an instance of `EzsignbulksendGetEzsignbulksendtransmissionsV1Response` """ - model = EzsignbulksendGetEzsignbulksendtransmissionsV1Response() # noqa: E501 + model = EzsignbulksendGetEzsignbulksendtransmissionsV1Response() if include_optional: return EzsignbulksendGetEzsignbulksendtransmissionsV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsignbulksend_get_ezsignbulksendtransmissions_v1_response_m_payload.py b/test/test_ezsignbulksend_get_ezsignbulksendtransmissions_v1_response_m_payload.py index f3c3c06d0..9712ef4cf 100644 --- a/test/test_ezsignbulksend_get_ezsignbulksendtransmissions_v1_response_m_payload.py +++ b/test/test_ezsignbulksend_get_ezsignbulksendtransmissions_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignbulksend_get_ezsignbulksendtransmissions_v1_response_m_payload import EzsignbulksendGetEzsignbulksendtransmissionsV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezsignbulksend_get_ezsignbulksendtransmissions_v1_response_m_payload import EzsignbulksendGetEzsignbulksendtransmissionsV1ResponseMPayload class TestEzsignbulksendGetEzsignbulksendtransmissionsV1ResponseMPayload(unittest.TestCase): """EzsignbulksendGetEzsignbulksendtransmissionsV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignbulksendGetEzsignbulksendtran optional params are included """ # uncomment below to create an instance of `EzsignbulksendGetEzsignbulksendtransmissionsV1ResponseMPayload` """ - model = EzsignbulksendGetEzsignbulksendtransmissionsV1ResponseMPayload() # noqa: E501 + model = EzsignbulksendGetEzsignbulksendtransmissionsV1ResponseMPayload() if include_optional: return EzsignbulksendGetEzsignbulksendtransmissionsV1ResponseMPayload( a_obj_ezsignbulksendtransmission = [ diff --git a/test/test_ezsignbulksend_get_ezsignsignatures_automatic_v1_response.py b/test/test_ezsignbulksend_get_ezsignsignatures_automatic_v1_response.py index 87bd86443..7b6c13dbd 100644 --- a/test/test_ezsignbulksend_get_ezsignsignatures_automatic_v1_response.py +++ b/test/test_ezsignbulksend_get_ezsignsignatures_automatic_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignbulksend_get_ezsignsignatures_automatic_v1_response import EzsignbulksendGetEzsignsignaturesAutomaticV1Response # noqa: E501 +from eZmaxApi.models.ezsignbulksend_get_ezsignsignatures_automatic_v1_response import EzsignbulksendGetEzsignsignaturesAutomaticV1Response class TestEzsignbulksendGetEzsignsignaturesAutomaticV1Response(unittest.TestCase): """EzsignbulksendGetEzsignsignaturesAutomaticV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignbulksendGetEzsignsignaturesAu optional params are included """ # uncomment below to create an instance of `EzsignbulksendGetEzsignsignaturesAutomaticV1Response` """ - model = EzsignbulksendGetEzsignsignaturesAutomaticV1Response() # noqa: E501 + model = EzsignbulksendGetEzsignsignaturesAutomaticV1Response() if include_optional: return EzsignbulksendGetEzsignsignaturesAutomaticV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsignbulksend_get_ezsignsignatures_automatic_v1_response_m_payload.py b/test/test_ezsignbulksend_get_ezsignsignatures_automatic_v1_response_m_payload.py index 876b3d09a..d1ffdd968 100644 --- a/test/test_ezsignbulksend_get_ezsignsignatures_automatic_v1_response_m_payload.py +++ b/test/test_ezsignbulksend_get_ezsignsignatures_automatic_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignbulksend_get_ezsignsignatures_automatic_v1_response_m_payload import EzsignbulksendGetEzsignsignaturesAutomaticV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezsignbulksend_get_ezsignsignatures_automatic_v1_response_m_payload import EzsignbulksendGetEzsignsignaturesAutomaticV1ResponseMPayload class TestEzsignbulksendGetEzsignsignaturesAutomaticV1ResponseMPayload(unittest.TestCase): """EzsignbulksendGetEzsignsignaturesAutomaticV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignbulksendGetEzsignsignaturesAu optional params are included """ # uncomment below to create an instance of `EzsignbulksendGetEzsignsignaturesAutomaticV1ResponseMPayload` """ - model = EzsignbulksendGetEzsignsignaturesAutomaticV1ResponseMPayload() # noqa: E501 + model = EzsignbulksendGetEzsignsignaturesAutomaticV1ResponseMPayload() if include_optional: return EzsignbulksendGetEzsignsignaturesAutomaticV1ResponseMPayload( a_e_ezsignsignature_type = [ diff --git a/test/test_ezsignbulksend_get_forms_data_v1_response.py b/test/test_ezsignbulksend_get_forms_data_v1_response.py index ba448f35d..070af8465 100644 --- a/test/test_ezsignbulksend_get_forms_data_v1_response.py +++ b/test/test_ezsignbulksend_get_forms_data_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignbulksend_get_forms_data_v1_response import EzsignbulksendGetFormsDataV1Response # noqa: E501 +from eZmaxApi.models.ezsignbulksend_get_forms_data_v1_response import EzsignbulksendGetFormsDataV1Response class TestEzsignbulksendGetFormsDataV1Response(unittest.TestCase): """EzsignbulksendGetFormsDataV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignbulksendGetFormsDataV1Respons optional params are included """ # uncomment below to create an instance of `EzsignbulksendGetFormsDataV1Response` """ - model = EzsignbulksendGetFormsDataV1Response() # noqa: E501 + model = EzsignbulksendGetFormsDataV1Response() if include_optional: return EzsignbulksendGetFormsDataV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsignbulksend_get_forms_data_v1_response_m_payload.py b/test/test_ezsignbulksend_get_forms_data_v1_response_m_payload.py index 653125952..2bbaf865a 100644 --- a/test/test_ezsignbulksend_get_forms_data_v1_response_m_payload.py +++ b/test/test_ezsignbulksend_get_forms_data_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignbulksend_get_forms_data_v1_response_m_payload import EzsignbulksendGetFormsDataV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezsignbulksend_get_forms_data_v1_response_m_payload import EzsignbulksendGetFormsDataV1ResponseMPayload class TestEzsignbulksendGetFormsDataV1ResponseMPayload(unittest.TestCase): """EzsignbulksendGetFormsDataV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignbulksendGetFormsDataV1Respons optional params are included """ # uncomment below to create an instance of `EzsignbulksendGetFormsDataV1ResponseMPayload` """ - model = EzsignbulksendGetFormsDataV1ResponseMPayload() # noqa: E501 + model = EzsignbulksendGetFormsDataV1ResponseMPayload() if include_optional: return EzsignbulksendGetFormsDataV1ResponseMPayload( a_obj_forms_data_folder = [ diff --git a/test/test_ezsignbulksend_get_list_v1_response.py b/test/test_ezsignbulksend_get_list_v1_response.py index 48f5e21e8..44d74d0e9 100644 --- a/test/test_ezsignbulksend_get_list_v1_response.py +++ b/test/test_ezsignbulksend_get_list_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignbulksend_get_list_v1_response import EzsignbulksendGetListV1Response # noqa: E501 +from eZmaxApi.models.ezsignbulksend_get_list_v1_response import EzsignbulksendGetListV1Response class TestEzsignbulksendGetListV1Response(unittest.TestCase): """EzsignbulksendGetListV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignbulksendGetListV1Response: optional params are included """ # uncomment below to create an instance of `EzsignbulksendGetListV1Response` """ - model = EzsignbulksendGetListV1Response() # noqa: E501 + model = EzsignbulksendGetListV1Response() if include_optional: return EzsignbulksendGetListV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload_get_list.Common-Response-objDebugPayload_getList(), diff --git a/test/test_ezsignbulksend_get_list_v1_response_m_payload.py b/test/test_ezsignbulksend_get_list_v1_response_m_payload.py index 15f519eed..cee63fd07 100644 --- a/test/test_ezsignbulksend_get_list_v1_response_m_payload.py +++ b/test/test_ezsignbulksend_get_list_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignbulksend_get_list_v1_response_m_payload import EzsignbulksendGetListV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezsignbulksend_get_list_v1_response_m_payload import EzsignbulksendGetListV1ResponseMPayload class TestEzsignbulksendGetListV1ResponseMPayload(unittest.TestCase): """EzsignbulksendGetListV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignbulksendGetListV1ResponseMPay optional params are included """ # uncomment below to create an instance of `EzsignbulksendGetListV1ResponseMPayload` """ - model = EzsignbulksendGetListV1ResponseMPayload() # noqa: E501 + model = EzsignbulksendGetListV1ResponseMPayload() if include_optional: return EzsignbulksendGetListV1ResponseMPayload( i_row_returned = 100, diff --git a/test/test_ezsignbulksend_get_object_v2_response.py b/test/test_ezsignbulksend_get_object_v2_response.py index 8d5fd14b9..d37d6a666 100644 --- a/test/test_ezsignbulksend_get_object_v2_response.py +++ b/test/test_ezsignbulksend_get_object_v2_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignbulksend_get_object_v2_response import EzsignbulksendGetObjectV2Response # noqa: E501 +from eZmaxApi.models.ezsignbulksend_get_object_v2_response import EzsignbulksendGetObjectV2Response class TestEzsignbulksendGetObjectV2Response(unittest.TestCase): """EzsignbulksendGetObjectV2Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignbulksendGetObjectV2Response: optional params are included """ # uncomment below to create an instance of `EzsignbulksendGetObjectV2Response` """ - model = EzsignbulksendGetObjectV2Response() # noqa: E501 + model = EzsignbulksendGetObjectV2Response() if include_optional: return EzsignbulksendGetObjectV2Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsignbulksend_get_object_v2_response_m_payload.py b/test/test_ezsignbulksend_get_object_v2_response_m_payload.py index f646a6ed6..8c29bd904 100644 --- a/test/test_ezsignbulksend_get_object_v2_response_m_payload.py +++ b/test/test_ezsignbulksend_get_object_v2_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignbulksend_get_object_v2_response_m_payload import EzsignbulksendGetObjectV2ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezsignbulksend_get_object_v2_response_m_payload import EzsignbulksendGetObjectV2ResponseMPayload class TestEzsignbulksendGetObjectV2ResponseMPayload(unittest.TestCase): """EzsignbulksendGetObjectV2ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignbulksendGetObjectV2ResponseMP optional params are included """ # uncomment below to create an instance of `EzsignbulksendGetObjectV2ResponseMPayload` """ - model = EzsignbulksendGetObjectV2ResponseMPayload() # noqa: E501 + model = EzsignbulksendGetObjectV2ResponseMPayload() if include_optional: return EzsignbulksendGetObjectV2ResponseMPayload( obj_ezsignbulksend = eZmaxApi.models.ezsignbulksend_response_compound.ezsignbulksend-ResponseCompound() diff --git a/test/test_ezsignbulksend_list_element.py b/test/test_ezsignbulksend_list_element.py index a8c649c34..bf1e70126 100644 --- a/test/test_ezsignbulksend_list_element.py +++ b/test/test_ezsignbulksend_list_element.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignbulksend_list_element import EzsignbulksendListElement # noqa: E501 +from eZmaxApi.models.ezsignbulksend_list_element import EzsignbulksendListElement class TestEzsignbulksendListElement(unittest.TestCase): """EzsignbulksendListElement unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignbulksendListElement: optional params are included """ # uncomment below to create an instance of `EzsignbulksendListElement` """ - model = EzsignbulksendListElement() # noqa: E501 + model = EzsignbulksendListElement() if include_optional: return EzsignbulksendListElement( pki_ezsignbulksend_id = 8, diff --git a/test/test_ezsignbulksend_reorder_v1_request.py b/test/test_ezsignbulksend_reorder_v1_request.py index e17f75ab0..8c7996578 100644 --- a/test/test_ezsignbulksend_reorder_v1_request.py +++ b/test/test_ezsignbulksend_reorder_v1_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignbulksend_reorder_v1_request import EzsignbulksendReorderV1Request # noqa: E501 +from eZmaxApi.models.ezsignbulksend_reorder_v1_request import EzsignbulksendReorderV1Request class TestEzsignbulksendReorderV1Request(unittest.TestCase): """EzsignbulksendReorderV1Request unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignbulksendReorderV1Request: optional params are included """ # uncomment below to create an instance of `EzsignbulksendReorderV1Request` """ - model = EzsignbulksendReorderV1Request() # noqa: E501 + model = EzsignbulksendReorderV1Request() if include_optional: return EzsignbulksendReorderV1Request( a_pki_ezsignbulksenddocumentmapping_id = [ diff --git a/test/test_ezsignbulksend_reorder_v1_response.py b/test/test_ezsignbulksend_reorder_v1_response.py index 594727047..857b6d809 100644 --- a/test/test_ezsignbulksend_reorder_v1_response.py +++ b/test/test_ezsignbulksend_reorder_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignbulksend_reorder_v1_response import EzsignbulksendReorderV1Response # noqa: E501 +from eZmaxApi.models.ezsignbulksend_reorder_v1_response import EzsignbulksendReorderV1Response class TestEzsignbulksendReorderV1Response(unittest.TestCase): """EzsignbulksendReorderV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignbulksendReorderV1Response: optional params are included """ # uncomment below to create an instance of `EzsignbulksendReorderV1Response` """ - model = EzsignbulksendReorderV1Response() # noqa: E501 + model = EzsignbulksendReorderV1Response() if include_optional: return EzsignbulksendReorderV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsignbulksend_request.py b/test/test_ezsignbulksend_request.py index 9273e87f9..16e28e3c8 100644 --- a/test/test_ezsignbulksend_request.py +++ b/test/test_ezsignbulksend_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignbulksend_request import EzsignbulksendRequest # noqa: E501 +from eZmaxApi.models.ezsignbulksend_request import EzsignbulksendRequest class TestEzsignbulksendRequest(unittest.TestCase): """EzsignbulksendRequest unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignbulksendRequest: optional params are included """ # uncomment below to create an instance of `EzsignbulksendRequest` """ - model = EzsignbulksendRequest() # noqa: E501 + model = EzsignbulksendRequest() if include_optional: return EzsignbulksendRequest( pki_ezsignbulksend_id = 8, diff --git a/test/test_ezsignbulksend_request_compound.py b/test/test_ezsignbulksend_request_compound.py index 97008473f..50b0d3cfd 100644 --- a/test/test_ezsignbulksend_request_compound.py +++ b/test/test_ezsignbulksend_request_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignbulksend_request_compound import EzsignbulksendRequestCompound # noqa: E501 +from eZmaxApi.models.ezsignbulksend_request_compound import EzsignbulksendRequestCompound class TestEzsignbulksendRequestCompound(unittest.TestCase): """EzsignbulksendRequestCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignbulksendRequestCompound: optional params are included """ # uncomment below to create an instance of `EzsignbulksendRequestCompound` """ - model = EzsignbulksendRequestCompound() # noqa: E501 + model = EzsignbulksendRequestCompound() if include_optional: return EzsignbulksendRequestCompound( pki_ezsignbulksend_id = 8, diff --git a/test/test_ezsignbulksend_response.py b/test/test_ezsignbulksend_response.py index e23bc8e3c..2760a4b70 100644 --- a/test/test_ezsignbulksend_response.py +++ b/test/test_ezsignbulksend_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignbulksend_response import EzsignbulksendResponse # noqa: E501 +from eZmaxApi.models.ezsignbulksend_response import EzsignbulksendResponse class TestEzsignbulksendResponse(unittest.TestCase): """EzsignbulksendResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignbulksendResponse: optional params are included """ # uncomment below to create an instance of `EzsignbulksendResponse` """ - model = EzsignbulksendResponse() # noqa: E501 + model = EzsignbulksendResponse() if include_optional: return EzsignbulksendResponse( pki_ezsignbulksend_id = 8, diff --git a/test/test_ezsignbulksend_response_compound.py b/test/test_ezsignbulksend_response_compound.py index 5635e7e39..805d71b86 100644 --- a/test/test_ezsignbulksend_response_compound.py +++ b/test/test_ezsignbulksend_response_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignbulksend_response_compound import EzsignbulksendResponseCompound # noqa: E501 +from eZmaxApi.models.ezsignbulksend_response_compound import EzsignbulksendResponseCompound class TestEzsignbulksendResponseCompound(unittest.TestCase): """EzsignbulksendResponseCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignbulksendResponseCompound: optional params are included """ # uncomment below to create an instance of `EzsignbulksendResponseCompound` """ - model = EzsignbulksendResponseCompound() # noqa: E501 + model = EzsignbulksendResponseCompound() if include_optional: return EzsignbulksendResponseCompound( pki_ezsignbulksend_id = 8, diff --git a/test/test_ezsignbulksenddocumentmapping_create_object_v1_request.py b/test/test_ezsignbulksenddocumentmapping_create_object_v1_request.py index fc090fca6..f31fb22a3 100644 --- a/test/test_ezsignbulksenddocumentmapping_create_object_v1_request.py +++ b/test/test_ezsignbulksenddocumentmapping_create_object_v1_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignbulksenddocumentmapping_create_object_v1_request import EzsignbulksenddocumentmappingCreateObjectV1Request # noqa: E501 +from eZmaxApi.models.ezsignbulksenddocumentmapping_create_object_v1_request import EzsignbulksenddocumentmappingCreateObjectV1Request class TestEzsignbulksenddocumentmappingCreateObjectV1Request(unittest.TestCase): """EzsignbulksenddocumentmappingCreateObjectV1Request unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignbulksenddocumentmappingCreate optional params are included """ # uncomment below to create an instance of `EzsignbulksenddocumentmappingCreateObjectV1Request` """ - model = EzsignbulksenddocumentmappingCreateObjectV1Request() # noqa: E501 + model = EzsignbulksenddocumentmappingCreateObjectV1Request() if include_optional: return EzsignbulksenddocumentmappingCreateObjectV1Request( a_obj_ezsignbulksenddocumentmapping = [ diff --git a/test/test_ezsignbulksenddocumentmapping_create_object_v1_response.py b/test/test_ezsignbulksenddocumentmapping_create_object_v1_response.py index 109a2c9f8..f4533201c 100644 --- a/test/test_ezsignbulksenddocumentmapping_create_object_v1_response.py +++ b/test/test_ezsignbulksenddocumentmapping_create_object_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignbulksenddocumentmapping_create_object_v1_response import EzsignbulksenddocumentmappingCreateObjectV1Response # noqa: E501 +from eZmaxApi.models.ezsignbulksenddocumentmapping_create_object_v1_response import EzsignbulksenddocumentmappingCreateObjectV1Response class TestEzsignbulksenddocumentmappingCreateObjectV1Response(unittest.TestCase): """EzsignbulksenddocumentmappingCreateObjectV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignbulksenddocumentmappingCreate optional params are included """ # uncomment below to create an instance of `EzsignbulksenddocumentmappingCreateObjectV1Response` """ - model = EzsignbulksenddocumentmappingCreateObjectV1Response() # noqa: E501 + model = EzsignbulksenddocumentmappingCreateObjectV1Response() if include_optional: return EzsignbulksenddocumentmappingCreateObjectV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsignbulksenddocumentmapping_create_object_v1_response_m_payload.py b/test/test_ezsignbulksenddocumentmapping_create_object_v1_response_m_payload.py index 96fcbcf97..e532d3c6a 100644 --- a/test/test_ezsignbulksenddocumentmapping_create_object_v1_response_m_payload.py +++ b/test/test_ezsignbulksenddocumentmapping_create_object_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignbulksenddocumentmapping_create_object_v1_response_m_payload import EzsignbulksenddocumentmappingCreateObjectV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezsignbulksenddocumentmapping_create_object_v1_response_m_payload import EzsignbulksenddocumentmappingCreateObjectV1ResponseMPayload class TestEzsignbulksenddocumentmappingCreateObjectV1ResponseMPayload(unittest.TestCase): """EzsignbulksenddocumentmappingCreateObjectV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignbulksenddocumentmappingCreate optional params are included """ # uncomment below to create an instance of `EzsignbulksenddocumentmappingCreateObjectV1ResponseMPayload` """ - model = EzsignbulksenddocumentmappingCreateObjectV1ResponseMPayload() # noqa: E501 + model = EzsignbulksenddocumentmappingCreateObjectV1ResponseMPayload() if include_optional: return EzsignbulksenddocumentmappingCreateObjectV1ResponseMPayload( a_pki_ezsignbulksenddocumentmapping_id = [ diff --git a/test/test_ezsignbulksenddocumentmapping_delete_object_v1_response.py b/test/test_ezsignbulksenddocumentmapping_delete_object_v1_response.py index 46cd4af46..35503fe09 100644 --- a/test/test_ezsignbulksenddocumentmapping_delete_object_v1_response.py +++ b/test/test_ezsignbulksenddocumentmapping_delete_object_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignbulksenddocumentmapping_delete_object_v1_response import EzsignbulksenddocumentmappingDeleteObjectV1Response # noqa: E501 +from eZmaxApi.models.ezsignbulksenddocumentmapping_delete_object_v1_response import EzsignbulksenddocumentmappingDeleteObjectV1Response class TestEzsignbulksenddocumentmappingDeleteObjectV1Response(unittest.TestCase): """EzsignbulksenddocumentmappingDeleteObjectV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignbulksenddocumentmappingDelete optional params are included """ # uncomment below to create an instance of `EzsignbulksenddocumentmappingDeleteObjectV1Response` """ - model = EzsignbulksenddocumentmappingDeleteObjectV1Response() # noqa: E501 + model = EzsignbulksenddocumentmappingDeleteObjectV1Response() if include_optional: return EzsignbulksenddocumentmappingDeleteObjectV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsignbulksenddocumentmapping_get_object_v2_response.py b/test/test_ezsignbulksenddocumentmapping_get_object_v2_response.py index cbf0f1bc9..2ed84568f 100644 --- a/test/test_ezsignbulksenddocumentmapping_get_object_v2_response.py +++ b/test/test_ezsignbulksenddocumentmapping_get_object_v2_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignbulksenddocumentmapping_get_object_v2_response import EzsignbulksenddocumentmappingGetObjectV2Response # noqa: E501 +from eZmaxApi.models.ezsignbulksenddocumentmapping_get_object_v2_response import EzsignbulksenddocumentmappingGetObjectV2Response class TestEzsignbulksenddocumentmappingGetObjectV2Response(unittest.TestCase): """EzsignbulksenddocumentmappingGetObjectV2Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignbulksenddocumentmappingGetObj optional params are included """ # uncomment below to create an instance of `EzsignbulksenddocumentmappingGetObjectV2Response` """ - model = EzsignbulksenddocumentmappingGetObjectV2Response() # noqa: E501 + model = EzsignbulksenddocumentmappingGetObjectV2Response() if include_optional: return EzsignbulksenddocumentmappingGetObjectV2Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsignbulksenddocumentmapping_get_object_v2_response_m_payload.py b/test/test_ezsignbulksenddocumentmapping_get_object_v2_response_m_payload.py index 5971f8b89..68c6a38e9 100644 --- a/test/test_ezsignbulksenddocumentmapping_get_object_v2_response_m_payload.py +++ b/test/test_ezsignbulksenddocumentmapping_get_object_v2_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignbulksenddocumentmapping_get_object_v2_response_m_payload import EzsignbulksenddocumentmappingGetObjectV2ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezsignbulksenddocumentmapping_get_object_v2_response_m_payload import EzsignbulksenddocumentmappingGetObjectV2ResponseMPayload class TestEzsignbulksenddocumentmappingGetObjectV2ResponseMPayload(unittest.TestCase): """EzsignbulksenddocumentmappingGetObjectV2ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignbulksenddocumentmappingGetObj optional params are included """ # uncomment below to create an instance of `EzsignbulksenddocumentmappingGetObjectV2ResponseMPayload` """ - model = EzsignbulksenddocumentmappingGetObjectV2ResponseMPayload() # noqa: E501 + model = EzsignbulksenddocumentmappingGetObjectV2ResponseMPayload() if include_optional: return EzsignbulksenddocumentmappingGetObjectV2ResponseMPayload( obj_ezsignbulksenddocumentmapping = eZmaxApi.models.ezsignbulksenddocumentmapping_response_compound.ezsignbulksenddocumentmapping-ResponseCompound() diff --git a/test/test_ezsignbulksenddocumentmapping_request.py b/test/test_ezsignbulksenddocumentmapping_request.py index 7ae0b369b..d38858a87 100644 --- a/test/test_ezsignbulksenddocumentmapping_request.py +++ b/test/test_ezsignbulksenddocumentmapping_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignbulksenddocumentmapping_request import EzsignbulksenddocumentmappingRequest # noqa: E501 +from eZmaxApi.models.ezsignbulksenddocumentmapping_request import EzsignbulksenddocumentmappingRequest class TestEzsignbulksenddocumentmappingRequest(unittest.TestCase): """EzsignbulksenddocumentmappingRequest unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignbulksenddocumentmappingReques optional params are included """ # uncomment below to create an instance of `EzsignbulksenddocumentmappingRequest` """ - model = EzsignbulksenddocumentmappingRequest() # noqa: E501 + model = EzsignbulksenddocumentmappingRequest() if include_optional: return EzsignbulksenddocumentmappingRequest( pki_ezsignbulksenddocumentmapping_id = 48, diff --git a/test/test_ezsignbulksenddocumentmapping_request_compound.py b/test/test_ezsignbulksenddocumentmapping_request_compound.py index e2c8792f2..089a25e47 100644 --- a/test/test_ezsignbulksenddocumentmapping_request_compound.py +++ b/test/test_ezsignbulksenddocumentmapping_request_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignbulksenddocumentmapping_request_compound import EzsignbulksenddocumentmappingRequestCompound # noqa: E501 +from eZmaxApi.models.ezsignbulksenddocumentmapping_request_compound import EzsignbulksenddocumentmappingRequestCompound class TestEzsignbulksenddocumentmappingRequestCompound(unittest.TestCase): """EzsignbulksenddocumentmappingRequestCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignbulksenddocumentmappingReques optional params are included """ # uncomment below to create an instance of `EzsignbulksenddocumentmappingRequestCompound` """ - model = EzsignbulksenddocumentmappingRequestCompound() # noqa: E501 + model = EzsignbulksenddocumentmappingRequestCompound() if include_optional: return EzsignbulksenddocumentmappingRequestCompound( pki_ezsignbulksenddocumentmapping_id = 48, diff --git a/test/test_ezsignbulksenddocumentmapping_response.py b/test/test_ezsignbulksenddocumentmapping_response.py index c7e8582ab..b93493547 100644 --- a/test/test_ezsignbulksenddocumentmapping_response.py +++ b/test/test_ezsignbulksenddocumentmapping_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignbulksenddocumentmapping_response import EzsignbulksenddocumentmappingResponse # noqa: E501 +from eZmaxApi.models.ezsignbulksenddocumentmapping_response import EzsignbulksenddocumentmappingResponse class TestEzsignbulksenddocumentmappingResponse(unittest.TestCase): """EzsignbulksenddocumentmappingResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignbulksenddocumentmappingRespon optional params are included """ # uncomment below to create an instance of `EzsignbulksenddocumentmappingResponse` """ - model = EzsignbulksenddocumentmappingResponse() # noqa: E501 + model = EzsignbulksenddocumentmappingResponse() if include_optional: return EzsignbulksenddocumentmappingResponse( pki_ezsignbulksenddocumentmapping_id = 48, diff --git a/test/test_ezsignbulksenddocumentmapping_response_compound.py b/test/test_ezsignbulksenddocumentmapping_response_compound.py index fc096b9dd..063502f6e 100644 --- a/test/test_ezsignbulksenddocumentmapping_response_compound.py +++ b/test/test_ezsignbulksenddocumentmapping_response_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignbulksenddocumentmapping_response_compound import EzsignbulksenddocumentmappingResponseCompound # noqa: E501 +from eZmaxApi.models.ezsignbulksenddocumentmapping_response_compound import EzsignbulksenddocumentmappingResponseCompound class TestEzsignbulksenddocumentmappingResponseCompound(unittest.TestCase): """EzsignbulksenddocumentmappingResponseCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignbulksenddocumentmappingRespon optional params are included """ # uncomment below to create an instance of `EzsignbulksenddocumentmappingResponseCompound` """ - model = EzsignbulksenddocumentmappingResponseCompound() # noqa: E501 + model = EzsignbulksenddocumentmappingResponseCompound() if include_optional: return EzsignbulksenddocumentmappingResponseCompound( pki_ezsignbulksenddocumentmapping_id = 48, diff --git a/test/test_ezsignbulksendsignermapping_create_object_v1_request.py b/test/test_ezsignbulksendsignermapping_create_object_v1_request.py index 45a6b9057..4e5142380 100644 --- a/test/test_ezsignbulksendsignermapping_create_object_v1_request.py +++ b/test/test_ezsignbulksendsignermapping_create_object_v1_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignbulksendsignermapping_create_object_v1_request import EzsignbulksendsignermappingCreateObjectV1Request # noqa: E501 +from eZmaxApi.models.ezsignbulksendsignermapping_create_object_v1_request import EzsignbulksendsignermappingCreateObjectV1Request class TestEzsignbulksendsignermappingCreateObjectV1Request(unittest.TestCase): """EzsignbulksendsignermappingCreateObjectV1Request unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignbulksendsignermappingCreateOb optional params are included """ # uncomment below to create an instance of `EzsignbulksendsignermappingCreateObjectV1Request` """ - model = EzsignbulksendsignermappingCreateObjectV1Request() # noqa: E501 + model = EzsignbulksendsignermappingCreateObjectV1Request() if include_optional: return EzsignbulksendsignermappingCreateObjectV1Request( a_obj_ezsignbulksendsignermapping = [ diff --git a/test/test_ezsignbulksendsignermapping_create_object_v1_response.py b/test/test_ezsignbulksendsignermapping_create_object_v1_response.py index 3c93c3553..e9565e8f5 100644 --- a/test/test_ezsignbulksendsignermapping_create_object_v1_response.py +++ b/test/test_ezsignbulksendsignermapping_create_object_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignbulksendsignermapping_create_object_v1_response import EzsignbulksendsignermappingCreateObjectV1Response # noqa: E501 +from eZmaxApi.models.ezsignbulksendsignermapping_create_object_v1_response import EzsignbulksendsignermappingCreateObjectV1Response class TestEzsignbulksendsignermappingCreateObjectV1Response(unittest.TestCase): """EzsignbulksendsignermappingCreateObjectV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignbulksendsignermappingCreateOb optional params are included """ # uncomment below to create an instance of `EzsignbulksendsignermappingCreateObjectV1Response` """ - model = EzsignbulksendsignermappingCreateObjectV1Response() # noqa: E501 + model = EzsignbulksendsignermappingCreateObjectV1Response() if include_optional: return EzsignbulksendsignermappingCreateObjectV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsignbulksendsignermapping_create_object_v1_response_m_payload.py b/test/test_ezsignbulksendsignermapping_create_object_v1_response_m_payload.py index f20773680..c918fee65 100644 --- a/test/test_ezsignbulksendsignermapping_create_object_v1_response_m_payload.py +++ b/test/test_ezsignbulksendsignermapping_create_object_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignbulksendsignermapping_create_object_v1_response_m_payload import EzsignbulksendsignermappingCreateObjectV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezsignbulksendsignermapping_create_object_v1_response_m_payload import EzsignbulksendsignermappingCreateObjectV1ResponseMPayload class TestEzsignbulksendsignermappingCreateObjectV1ResponseMPayload(unittest.TestCase): """EzsignbulksendsignermappingCreateObjectV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignbulksendsignermappingCreateOb optional params are included """ # uncomment below to create an instance of `EzsignbulksendsignermappingCreateObjectV1ResponseMPayload` """ - model = EzsignbulksendsignermappingCreateObjectV1ResponseMPayload() # noqa: E501 + model = EzsignbulksendsignermappingCreateObjectV1ResponseMPayload() if include_optional: return EzsignbulksendsignermappingCreateObjectV1ResponseMPayload( a_pki_ezsignbulksendsignermapping_id = [ diff --git a/test/test_ezsignbulksendsignermapping_delete_object_v1_response.py b/test/test_ezsignbulksendsignermapping_delete_object_v1_response.py index d6edfb711..d2dc1bde0 100644 --- a/test/test_ezsignbulksendsignermapping_delete_object_v1_response.py +++ b/test/test_ezsignbulksendsignermapping_delete_object_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignbulksendsignermapping_delete_object_v1_response import EzsignbulksendsignermappingDeleteObjectV1Response # noqa: E501 +from eZmaxApi.models.ezsignbulksendsignermapping_delete_object_v1_response import EzsignbulksendsignermappingDeleteObjectV1Response class TestEzsignbulksendsignermappingDeleteObjectV1Response(unittest.TestCase): """EzsignbulksendsignermappingDeleteObjectV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignbulksendsignermappingDeleteOb optional params are included """ # uncomment below to create an instance of `EzsignbulksendsignermappingDeleteObjectV1Response` """ - model = EzsignbulksendsignermappingDeleteObjectV1Response() # noqa: E501 + model = EzsignbulksendsignermappingDeleteObjectV1Response() if include_optional: return EzsignbulksendsignermappingDeleteObjectV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsignbulksendsignermapping_get_object_v2_response.py b/test/test_ezsignbulksendsignermapping_get_object_v2_response.py index 3fdad75a9..355a34340 100644 --- a/test/test_ezsignbulksendsignermapping_get_object_v2_response.py +++ b/test/test_ezsignbulksendsignermapping_get_object_v2_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignbulksendsignermapping_get_object_v2_response import EzsignbulksendsignermappingGetObjectV2Response # noqa: E501 +from eZmaxApi.models.ezsignbulksendsignermapping_get_object_v2_response import EzsignbulksendsignermappingGetObjectV2Response class TestEzsignbulksendsignermappingGetObjectV2Response(unittest.TestCase): """EzsignbulksendsignermappingGetObjectV2Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignbulksendsignermappingGetObjec optional params are included """ # uncomment below to create an instance of `EzsignbulksendsignermappingGetObjectV2Response` """ - model = EzsignbulksendsignermappingGetObjectV2Response() # noqa: E501 + model = EzsignbulksendsignermappingGetObjectV2Response() if include_optional: return EzsignbulksendsignermappingGetObjectV2Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsignbulksendsignermapping_get_object_v2_response_m_payload.py b/test/test_ezsignbulksendsignermapping_get_object_v2_response_m_payload.py index 67b4d3b8b..9307cf1a4 100644 --- a/test/test_ezsignbulksendsignermapping_get_object_v2_response_m_payload.py +++ b/test/test_ezsignbulksendsignermapping_get_object_v2_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignbulksendsignermapping_get_object_v2_response_m_payload import EzsignbulksendsignermappingGetObjectV2ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezsignbulksendsignermapping_get_object_v2_response_m_payload import EzsignbulksendsignermappingGetObjectV2ResponseMPayload class TestEzsignbulksendsignermappingGetObjectV2ResponseMPayload(unittest.TestCase): """EzsignbulksendsignermappingGetObjectV2ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignbulksendsignermappingGetObjec optional params are included """ # uncomment below to create an instance of `EzsignbulksendsignermappingGetObjectV2ResponseMPayload` """ - model = EzsignbulksendsignermappingGetObjectV2ResponseMPayload() # noqa: E501 + model = EzsignbulksendsignermappingGetObjectV2ResponseMPayload() if include_optional: return EzsignbulksendsignermappingGetObjectV2ResponseMPayload( obj_ezsignbulksendsignermapping = eZmaxApi.models.ezsignbulksendsignermapping_response_compound.ezsignbulksendsignermapping-ResponseCompound() diff --git a/test/test_ezsignbulksendsignermapping_request.py b/test/test_ezsignbulksendsignermapping_request.py index e8e9edbb6..bf8d7e6e9 100644 --- a/test/test_ezsignbulksendsignermapping_request.py +++ b/test/test_ezsignbulksendsignermapping_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignbulksendsignermapping_request import EzsignbulksendsignermappingRequest # noqa: E501 +from eZmaxApi.models.ezsignbulksendsignermapping_request import EzsignbulksendsignermappingRequest class TestEzsignbulksendsignermappingRequest(unittest.TestCase): """EzsignbulksendsignermappingRequest unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignbulksendsignermappingRequest: optional params are included """ # uncomment below to create an instance of `EzsignbulksendsignermappingRequest` """ - model = EzsignbulksendsignermappingRequest() # noqa: E501 + model = EzsignbulksendsignermappingRequest() if include_optional: return EzsignbulksendsignermappingRequest( pki_ezsignbulksendsignermapping_id = 57, diff --git a/test/test_ezsignbulksendsignermapping_request_compound.py b/test/test_ezsignbulksendsignermapping_request_compound.py index c293e9237..8053e25d3 100644 --- a/test/test_ezsignbulksendsignermapping_request_compound.py +++ b/test/test_ezsignbulksendsignermapping_request_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignbulksendsignermapping_request_compound import EzsignbulksendsignermappingRequestCompound # noqa: E501 +from eZmaxApi.models.ezsignbulksendsignermapping_request_compound import EzsignbulksendsignermappingRequestCompound class TestEzsignbulksendsignermappingRequestCompound(unittest.TestCase): """EzsignbulksendsignermappingRequestCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignbulksendsignermappingRequestC optional params are included """ # uncomment below to create an instance of `EzsignbulksendsignermappingRequestCompound` """ - model = EzsignbulksendsignermappingRequestCompound() # noqa: E501 + model = EzsignbulksendsignermappingRequestCompound() if include_optional: return EzsignbulksendsignermappingRequestCompound( pki_ezsignbulksendsignermapping_id = 57, diff --git a/test/test_ezsignbulksendsignermapping_response.py b/test/test_ezsignbulksendsignermapping_response.py index b4d8ce0cc..2836396aa 100644 --- a/test/test_ezsignbulksendsignermapping_response.py +++ b/test/test_ezsignbulksendsignermapping_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignbulksendsignermapping_response import EzsignbulksendsignermappingResponse # noqa: E501 +from eZmaxApi.models.ezsignbulksendsignermapping_response import EzsignbulksendsignermappingResponse class TestEzsignbulksendsignermappingResponse(unittest.TestCase): """EzsignbulksendsignermappingResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignbulksendsignermappingResponse optional params are included """ # uncomment below to create an instance of `EzsignbulksendsignermappingResponse` """ - model = EzsignbulksendsignermappingResponse() # noqa: E501 + model = EzsignbulksendsignermappingResponse() if include_optional: return EzsignbulksendsignermappingResponse( pki_ezsignbulksendsignermapping_id = 57, diff --git a/test/test_ezsignbulksendsignermapping_response_compound.py b/test/test_ezsignbulksendsignermapping_response_compound.py index d32ca7a73..faaa8ddba 100644 --- a/test/test_ezsignbulksendsignermapping_response_compound.py +++ b/test/test_ezsignbulksendsignermapping_response_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignbulksendsignermapping_response_compound import EzsignbulksendsignermappingResponseCompound # noqa: E501 +from eZmaxApi.models.ezsignbulksendsignermapping_response_compound import EzsignbulksendsignermappingResponseCompound class TestEzsignbulksendsignermappingResponseCompound(unittest.TestCase): """EzsignbulksendsignermappingResponseCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignbulksendsignermappingResponse optional params are included """ # uncomment below to create an instance of `EzsignbulksendsignermappingResponseCompound` """ - model = EzsignbulksendsignermappingResponseCompound() # noqa: E501 + model = EzsignbulksendsignermappingResponseCompound() if include_optional: return EzsignbulksendsignermappingResponseCompound( pki_ezsignbulksendsignermapping_id = 57, diff --git a/test/test_ezsignbulksendtransmission_get_ezsignsignatures_automatic_v1_response.py b/test/test_ezsignbulksendtransmission_get_ezsignsignatures_automatic_v1_response.py index a8b6b50a3..062e15d43 100644 --- a/test/test_ezsignbulksendtransmission_get_ezsignsignatures_automatic_v1_response.py +++ b/test/test_ezsignbulksendtransmission_get_ezsignsignatures_automatic_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignbulksendtransmission_get_ezsignsignatures_automatic_v1_response import EzsignbulksendtransmissionGetEzsignsignaturesAutomaticV1Response # noqa: E501 +from eZmaxApi.models.ezsignbulksendtransmission_get_ezsignsignatures_automatic_v1_response import EzsignbulksendtransmissionGetEzsignsignaturesAutomaticV1Response class TestEzsignbulksendtransmissionGetEzsignsignaturesAutomaticV1Response(unittest.TestCase): """EzsignbulksendtransmissionGetEzsignsignaturesAutomaticV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignbulksendtransmissionGetEzsign optional params are included """ # uncomment below to create an instance of `EzsignbulksendtransmissionGetEzsignsignaturesAutomaticV1Response` """ - model = EzsignbulksendtransmissionGetEzsignsignaturesAutomaticV1Response() # noqa: E501 + model = EzsignbulksendtransmissionGetEzsignsignaturesAutomaticV1Response() if include_optional: return EzsignbulksendtransmissionGetEzsignsignaturesAutomaticV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsignbulksendtransmission_get_ezsignsignatures_automatic_v1_response_m_payload.py b/test/test_ezsignbulksendtransmission_get_ezsignsignatures_automatic_v1_response_m_payload.py index a4e749249..bd12867be 100644 --- a/test/test_ezsignbulksendtransmission_get_ezsignsignatures_automatic_v1_response_m_payload.py +++ b/test/test_ezsignbulksendtransmission_get_ezsignsignatures_automatic_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignbulksendtransmission_get_ezsignsignatures_automatic_v1_response_m_payload import EzsignbulksendtransmissionGetEzsignsignaturesAutomaticV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezsignbulksendtransmission_get_ezsignsignatures_automatic_v1_response_m_payload import EzsignbulksendtransmissionGetEzsignsignaturesAutomaticV1ResponseMPayload class TestEzsignbulksendtransmissionGetEzsignsignaturesAutomaticV1ResponseMPayload(unittest.TestCase): """EzsignbulksendtransmissionGetEzsignsignaturesAutomaticV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignbulksendtransmissionGetEzsign optional params are included """ # uncomment below to create an instance of `EzsignbulksendtransmissionGetEzsignsignaturesAutomaticV1ResponseMPayload` """ - model = EzsignbulksendtransmissionGetEzsignsignaturesAutomaticV1ResponseMPayload() # noqa: E501 + model = EzsignbulksendtransmissionGetEzsignsignaturesAutomaticV1ResponseMPayload() if include_optional: return EzsignbulksendtransmissionGetEzsignsignaturesAutomaticV1ResponseMPayload( a_e_ezsignsignature_type = [ diff --git a/test/test_ezsignbulksendtransmission_get_forms_data_v1_response.py b/test/test_ezsignbulksendtransmission_get_forms_data_v1_response.py index f9765f57b..19c3160e9 100644 --- a/test/test_ezsignbulksendtransmission_get_forms_data_v1_response.py +++ b/test/test_ezsignbulksendtransmission_get_forms_data_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignbulksendtransmission_get_forms_data_v1_response import EzsignbulksendtransmissionGetFormsDataV1Response # noqa: E501 +from eZmaxApi.models.ezsignbulksendtransmission_get_forms_data_v1_response import EzsignbulksendtransmissionGetFormsDataV1Response class TestEzsignbulksendtransmissionGetFormsDataV1Response(unittest.TestCase): """EzsignbulksendtransmissionGetFormsDataV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignbulksendtransmissionGetFormsD optional params are included """ # uncomment below to create an instance of `EzsignbulksendtransmissionGetFormsDataV1Response` """ - model = EzsignbulksendtransmissionGetFormsDataV1Response() # noqa: E501 + model = EzsignbulksendtransmissionGetFormsDataV1Response() if include_optional: return EzsignbulksendtransmissionGetFormsDataV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsignbulksendtransmission_get_forms_data_v1_response_m_payload.py b/test/test_ezsignbulksendtransmission_get_forms_data_v1_response_m_payload.py index 3a2d4cb1d..e328689f5 100644 --- a/test/test_ezsignbulksendtransmission_get_forms_data_v1_response_m_payload.py +++ b/test/test_ezsignbulksendtransmission_get_forms_data_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignbulksendtransmission_get_forms_data_v1_response_m_payload import EzsignbulksendtransmissionGetFormsDataV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezsignbulksendtransmission_get_forms_data_v1_response_m_payload import EzsignbulksendtransmissionGetFormsDataV1ResponseMPayload class TestEzsignbulksendtransmissionGetFormsDataV1ResponseMPayload(unittest.TestCase): """EzsignbulksendtransmissionGetFormsDataV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignbulksendtransmissionGetFormsD optional params are included """ # uncomment below to create an instance of `EzsignbulksendtransmissionGetFormsDataV1ResponseMPayload` """ - model = EzsignbulksendtransmissionGetFormsDataV1ResponseMPayload() # noqa: E501 + model = EzsignbulksendtransmissionGetFormsDataV1ResponseMPayload() if include_optional: return EzsignbulksendtransmissionGetFormsDataV1ResponseMPayload( a_obj_forms_data_folder = [ diff --git a/test/test_ezsignbulksendtransmission_get_object_v2_response.py b/test/test_ezsignbulksendtransmission_get_object_v2_response.py index edfba4235..730b67521 100644 --- a/test/test_ezsignbulksendtransmission_get_object_v2_response.py +++ b/test/test_ezsignbulksendtransmission_get_object_v2_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignbulksendtransmission_get_object_v2_response import EzsignbulksendtransmissionGetObjectV2Response # noqa: E501 +from eZmaxApi.models.ezsignbulksendtransmission_get_object_v2_response import EzsignbulksendtransmissionGetObjectV2Response class TestEzsignbulksendtransmissionGetObjectV2Response(unittest.TestCase): """EzsignbulksendtransmissionGetObjectV2Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignbulksendtransmissionGetObject optional params are included """ # uncomment below to create an instance of `EzsignbulksendtransmissionGetObjectV2Response` """ - model = EzsignbulksendtransmissionGetObjectV2Response() # noqa: E501 + model = EzsignbulksendtransmissionGetObjectV2Response() if include_optional: return EzsignbulksendtransmissionGetObjectV2Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsignbulksendtransmission_get_object_v2_response_m_payload.py b/test/test_ezsignbulksendtransmission_get_object_v2_response_m_payload.py index 157db1583..44c4fb834 100644 --- a/test/test_ezsignbulksendtransmission_get_object_v2_response_m_payload.py +++ b/test/test_ezsignbulksendtransmission_get_object_v2_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignbulksendtransmission_get_object_v2_response_m_payload import EzsignbulksendtransmissionGetObjectV2ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezsignbulksendtransmission_get_object_v2_response_m_payload import EzsignbulksendtransmissionGetObjectV2ResponseMPayload class TestEzsignbulksendtransmissionGetObjectV2ResponseMPayload(unittest.TestCase): """EzsignbulksendtransmissionGetObjectV2ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignbulksendtransmissionGetObject optional params are included """ # uncomment below to create an instance of `EzsignbulksendtransmissionGetObjectV2ResponseMPayload` """ - model = EzsignbulksendtransmissionGetObjectV2ResponseMPayload() # noqa: E501 + model = EzsignbulksendtransmissionGetObjectV2ResponseMPayload() if include_optional: return EzsignbulksendtransmissionGetObjectV2ResponseMPayload( obj_ezsignbulksendtransmission = eZmaxApi.models.ezsignbulksendtransmission_response_compound.ezsignbulksendtransmission-ResponseCompound() diff --git a/test/test_ezsignbulksendtransmission_response.py b/test/test_ezsignbulksendtransmission_response.py index 9521282ca..8ebaa22e7 100644 --- a/test/test_ezsignbulksendtransmission_response.py +++ b/test/test_ezsignbulksendtransmission_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignbulksendtransmission_response import EzsignbulksendtransmissionResponse # noqa: E501 +from eZmaxApi.models.ezsignbulksendtransmission_response import EzsignbulksendtransmissionResponse class TestEzsignbulksendtransmissionResponse(unittest.TestCase): """EzsignbulksendtransmissionResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignbulksendtransmissionResponse: optional params are included """ # uncomment below to create an instance of `EzsignbulksendtransmissionResponse` """ - model = EzsignbulksendtransmissionResponse() # noqa: E501 + model = EzsignbulksendtransmissionResponse() if include_optional: return EzsignbulksendtransmissionResponse( pki_ezsignbulksendtransmission_id = 21, diff --git a/test/test_ezsignbulksendtransmission_response_compound.py b/test/test_ezsignbulksendtransmission_response_compound.py index 9aa974e9c..25573f45a 100644 --- a/test/test_ezsignbulksendtransmission_response_compound.py +++ b/test/test_ezsignbulksendtransmission_response_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignbulksendtransmission_response_compound import EzsignbulksendtransmissionResponseCompound # noqa: E501 +from eZmaxApi.models.ezsignbulksendtransmission_response_compound import EzsignbulksendtransmissionResponseCompound class TestEzsignbulksendtransmissionResponseCompound(unittest.TestCase): """EzsignbulksendtransmissionResponseCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignbulksendtransmissionResponseC optional params are included """ # uncomment below to create an instance of `EzsignbulksendtransmissionResponseCompound` """ - model = EzsignbulksendtransmissionResponseCompound() # noqa: E501 + model = EzsignbulksendtransmissionResponseCompound() if include_optional: return EzsignbulksendtransmissionResponseCompound( pki_ezsignbulksendtransmission_id = 21, diff --git a/test/test_ezsigndocument_apply_ezsigntemplate_v1_request.py b/test/test_ezsigndocument_apply_ezsigntemplate_v1_request.py index eb0340ac5..f7c3a9177 100644 --- a/test/test_ezsigndocument_apply_ezsigntemplate_v1_request.py +++ b/test/test_ezsigndocument_apply_ezsigntemplate_v1_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigndocument_apply_ezsigntemplate_v1_request import EzsigndocumentApplyEzsigntemplateV1Request # noqa: E501 +from eZmaxApi.models.ezsigndocument_apply_ezsigntemplate_v1_request import EzsigndocumentApplyEzsigntemplateV1Request class TestEzsigndocumentApplyEzsigntemplateV1Request(unittest.TestCase): """EzsigndocumentApplyEzsigntemplateV1Request unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigndocumentApplyEzsigntemplateV1 optional params are included """ # uncomment below to create an instance of `EzsigndocumentApplyEzsigntemplateV1Request` """ - model = EzsigndocumentApplyEzsigntemplateV1Request() # noqa: E501 + model = EzsigndocumentApplyEzsigntemplateV1Request() if include_optional: return EzsigndocumentApplyEzsigntemplateV1Request( fki_ezsigntemplate_id = 36, diff --git a/test/test_ezsigndocument_apply_ezsigntemplate_v1_response.py b/test/test_ezsigndocument_apply_ezsigntemplate_v1_response.py index 7adbf5a23..0eb12dd52 100644 --- a/test/test_ezsigndocument_apply_ezsigntemplate_v1_response.py +++ b/test/test_ezsigndocument_apply_ezsigntemplate_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigndocument_apply_ezsigntemplate_v1_response import EzsigndocumentApplyEzsigntemplateV1Response # noqa: E501 +from eZmaxApi.models.ezsigndocument_apply_ezsigntemplate_v1_response import EzsigndocumentApplyEzsigntemplateV1Response class TestEzsigndocumentApplyEzsigntemplateV1Response(unittest.TestCase): """EzsigndocumentApplyEzsigntemplateV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigndocumentApplyEzsigntemplateV1 optional params are included """ # uncomment below to create an instance of `EzsigndocumentApplyEzsigntemplateV1Response` """ - model = EzsigndocumentApplyEzsigntemplateV1Response() # noqa: E501 + model = EzsigndocumentApplyEzsigntemplateV1Response() if include_optional: return EzsigndocumentApplyEzsigntemplateV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsigndocument_apply_ezsigntemplate_v2_request.py b/test/test_ezsigndocument_apply_ezsigntemplate_v2_request.py index dc1b2bbf6..acecb2c2e 100644 --- a/test/test_ezsigndocument_apply_ezsigntemplate_v2_request.py +++ b/test/test_ezsigndocument_apply_ezsigntemplate_v2_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigndocument_apply_ezsigntemplate_v2_request import EzsigndocumentApplyEzsigntemplateV2Request # noqa: E501 +from eZmaxApi.models.ezsigndocument_apply_ezsigntemplate_v2_request import EzsigndocumentApplyEzsigntemplateV2Request class TestEzsigndocumentApplyEzsigntemplateV2Request(unittest.TestCase): """EzsigndocumentApplyEzsigntemplateV2Request unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigndocumentApplyEzsigntemplateV2 optional params are included """ # uncomment below to create an instance of `EzsigndocumentApplyEzsigntemplateV2Request` """ - model = EzsigndocumentApplyEzsigntemplateV2Request() # noqa: E501 + model = EzsigndocumentApplyEzsigntemplateV2Request() if include_optional: return EzsigndocumentApplyEzsigntemplateV2Request( fki_ezsigntemplate_id = 36, diff --git a/test/test_ezsigndocument_apply_ezsigntemplate_v2_response.py b/test/test_ezsigndocument_apply_ezsigntemplate_v2_response.py index 07ac121b9..d4a2c89fb 100644 --- a/test/test_ezsigndocument_apply_ezsigntemplate_v2_response.py +++ b/test/test_ezsigndocument_apply_ezsigntemplate_v2_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigndocument_apply_ezsigntemplate_v2_response import EzsigndocumentApplyEzsigntemplateV2Response # noqa: E501 +from eZmaxApi.models.ezsigndocument_apply_ezsigntemplate_v2_response import EzsigndocumentApplyEzsigntemplateV2Response class TestEzsigndocumentApplyEzsigntemplateV2Response(unittest.TestCase): """EzsigndocumentApplyEzsigntemplateV2Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigndocumentApplyEzsigntemplateV2 optional params are included """ # uncomment below to create an instance of `EzsigndocumentApplyEzsigntemplateV2Response` """ - model = EzsigndocumentApplyEzsigntemplateV2Response() # noqa: E501 + model = EzsigndocumentApplyEzsigntemplateV2Response() if include_optional: return EzsigndocumentApplyEzsigntemplateV2Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsigndocument_create_object_v1_request.py b/test/test_ezsigndocument_create_object_v1_request.py index 685a8d2d9..9aceaecb7 100644 --- a/test/test_ezsigndocument_create_object_v1_request.py +++ b/test/test_ezsigndocument_create_object_v1_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigndocument_create_object_v1_request import EzsigndocumentCreateObjectV1Request # noqa: E501 +from eZmaxApi.models.ezsigndocument_create_object_v1_request import EzsigndocumentCreateObjectV1Request class TestEzsigndocumentCreateObjectV1Request(unittest.TestCase): """EzsigndocumentCreateObjectV1Request unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigndocumentCreateObjectV1Request optional params are included """ # uncomment below to create an instance of `EzsigndocumentCreateObjectV1Request` """ - model = EzsigndocumentCreateObjectV1Request() # noqa: E501 + model = EzsigndocumentCreateObjectV1Request() if include_optional: return EzsigndocumentCreateObjectV1Request( obj_ezsigndocument = eZmaxApi.models.ezsigndocument_request.ezsigndocument-Request( @@ -45,7 +45,7 @@ def make_instance(self, include_optional) -> EzsigndocumentCreateObjectV1Request fki_language_id = 2, e_ezsigndocument_source = 'Base64', e_ezsigndocument_format = 'Pdf', - s_ezsigndocument_base64 = '[B@30ea8c23', + s_ezsigndocument_base64 = '[B@26fb628', s_ezsigndocument_url = 'http://www.example.com/document.pdf', b_ezsigndocument_forcerepair = True, s_ezsigndocument_password = 'SecretPassword123', diff --git a/test/test_ezsigndocument_create_object_v1_response.py b/test/test_ezsigndocument_create_object_v1_response.py index cafb8ba64..650c3430b 100644 --- a/test/test_ezsigndocument_create_object_v1_response.py +++ b/test/test_ezsigndocument_create_object_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigndocument_create_object_v1_response import EzsigndocumentCreateObjectV1Response # noqa: E501 +from eZmaxApi.models.ezsigndocument_create_object_v1_response import EzsigndocumentCreateObjectV1Response class TestEzsigndocumentCreateObjectV1Response(unittest.TestCase): """EzsigndocumentCreateObjectV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigndocumentCreateObjectV1Respons optional params are included """ # uncomment below to create an instance of `EzsigndocumentCreateObjectV1Response` """ - model = EzsigndocumentCreateObjectV1Response() # noqa: E501 + model = EzsigndocumentCreateObjectV1Response() if include_optional: return EzsigndocumentCreateObjectV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsigndocument_create_object_v1_response_m_payload.py b/test/test_ezsigndocument_create_object_v1_response_m_payload.py index 32dc9b0ed..24ff2feb9 100644 --- a/test/test_ezsigndocument_create_object_v1_response_m_payload.py +++ b/test/test_ezsigndocument_create_object_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigndocument_create_object_v1_response_m_payload import EzsigndocumentCreateObjectV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezsigndocument_create_object_v1_response_m_payload import EzsigndocumentCreateObjectV1ResponseMPayload class TestEzsigndocumentCreateObjectV1ResponseMPayload(unittest.TestCase): """EzsigndocumentCreateObjectV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigndocumentCreateObjectV1Respons optional params are included """ # uncomment below to create an instance of `EzsigndocumentCreateObjectV1ResponseMPayload` """ - model = EzsigndocumentCreateObjectV1ResponseMPayload() # noqa: E501 + model = EzsigndocumentCreateObjectV1ResponseMPayload() if include_optional: return EzsigndocumentCreateObjectV1ResponseMPayload( a_pki_ezsigndocument_id = [ diff --git a/test/test_ezsigndocument_create_object_v2_request.py b/test/test_ezsigndocument_create_object_v2_request.py index a12ff692f..f5e114a06 100644 --- a/test/test_ezsigndocument_create_object_v2_request.py +++ b/test/test_ezsigndocument_create_object_v2_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigndocument_create_object_v2_request import EzsigndocumentCreateObjectV2Request # noqa: E501 +from eZmaxApi.models.ezsigndocument_create_object_v2_request import EzsigndocumentCreateObjectV2Request class TestEzsigndocumentCreateObjectV2Request(unittest.TestCase): """EzsigndocumentCreateObjectV2Request unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigndocumentCreateObjectV2Request optional params are included """ # uncomment below to create an instance of `EzsigndocumentCreateObjectV2Request` """ - model = EzsigndocumentCreateObjectV2Request() # noqa: E501 + model = EzsigndocumentCreateObjectV2Request() if include_optional: return EzsigndocumentCreateObjectV2Request( a_obj_ezsigndocument = [ diff --git a/test/test_ezsigndocument_create_object_v2_response.py b/test/test_ezsigndocument_create_object_v2_response.py index 371cc4b42..d49b7c41a 100644 --- a/test/test_ezsigndocument_create_object_v2_response.py +++ b/test/test_ezsigndocument_create_object_v2_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigndocument_create_object_v2_response import EzsigndocumentCreateObjectV2Response # noqa: E501 +from eZmaxApi.models.ezsigndocument_create_object_v2_response import EzsigndocumentCreateObjectV2Response class TestEzsigndocumentCreateObjectV2Response(unittest.TestCase): """EzsigndocumentCreateObjectV2Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigndocumentCreateObjectV2Respons optional params are included """ # uncomment below to create an instance of `EzsigndocumentCreateObjectV2Response` """ - model = EzsigndocumentCreateObjectV2Response() # noqa: E501 + model = EzsigndocumentCreateObjectV2Response() if include_optional: return EzsigndocumentCreateObjectV2Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsigndocument_create_object_v2_response_m_payload.py b/test/test_ezsigndocument_create_object_v2_response_m_payload.py index a09627c4a..e538903f4 100644 --- a/test/test_ezsigndocument_create_object_v2_response_m_payload.py +++ b/test/test_ezsigndocument_create_object_v2_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigndocument_create_object_v2_response_m_payload import EzsigndocumentCreateObjectV2ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezsigndocument_create_object_v2_response_m_payload import EzsigndocumentCreateObjectV2ResponseMPayload class TestEzsigndocumentCreateObjectV2ResponseMPayload(unittest.TestCase): """EzsigndocumentCreateObjectV2ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigndocumentCreateObjectV2Respons optional params are included """ # uncomment below to create an instance of `EzsigndocumentCreateObjectV2ResponseMPayload` """ - model = EzsigndocumentCreateObjectV2ResponseMPayload() # noqa: E501 + model = EzsigndocumentCreateObjectV2ResponseMPayload() if include_optional: return EzsigndocumentCreateObjectV2ResponseMPayload( a_pki_ezsigndocument_id = [ diff --git a/test/test_ezsigndocument_decline_to_sign_v1_request.py b/test/test_ezsigndocument_decline_to_sign_v1_request.py index 4b92ca097..a8c5e720b 100644 --- a/test/test_ezsigndocument_decline_to_sign_v1_request.py +++ b/test/test_ezsigndocument_decline_to_sign_v1_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigndocument_decline_to_sign_v1_request import EzsigndocumentDeclineToSignV1Request # noqa: E501 +from eZmaxApi.models.ezsigndocument_decline_to_sign_v1_request import EzsigndocumentDeclineToSignV1Request class TestEzsigndocumentDeclineToSignV1Request(unittest.TestCase): """EzsigndocumentDeclineToSignV1Request unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigndocumentDeclineToSignV1Reques optional params are included """ # uncomment below to create an instance of `EzsigndocumentDeclineToSignV1Request` """ - model = EzsigndocumentDeclineToSignV1Request() # noqa: E501 + model = EzsigndocumentDeclineToSignV1Request() if include_optional: return EzsigndocumentDeclineToSignV1Request( s_reason = 'Wrong document' diff --git a/test/test_ezsigndocument_decline_to_sign_v1_response.py b/test/test_ezsigndocument_decline_to_sign_v1_response.py index a78ced9eb..0a1da3867 100644 --- a/test/test_ezsigndocument_decline_to_sign_v1_response.py +++ b/test/test_ezsigndocument_decline_to_sign_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigndocument_decline_to_sign_v1_response import EzsigndocumentDeclineToSignV1Response # noqa: E501 +from eZmaxApi.models.ezsigndocument_decline_to_sign_v1_response import EzsigndocumentDeclineToSignV1Response class TestEzsigndocumentDeclineToSignV1Response(unittest.TestCase): """EzsigndocumentDeclineToSignV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigndocumentDeclineToSignV1Respon optional params are included """ # uncomment below to create an instance of `EzsigndocumentDeclineToSignV1Response` """ - model = EzsigndocumentDeclineToSignV1Response() # noqa: E501 + model = EzsigndocumentDeclineToSignV1Response() if include_optional: return EzsigndocumentDeclineToSignV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsigndocument_delete_object_v1_response.py b/test/test_ezsigndocument_delete_object_v1_response.py index 0440fcc26..18d5a5bff 100644 --- a/test/test_ezsigndocument_delete_object_v1_response.py +++ b/test/test_ezsigndocument_delete_object_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigndocument_delete_object_v1_response import EzsigndocumentDeleteObjectV1Response # noqa: E501 +from eZmaxApi.models.ezsigndocument_delete_object_v1_response import EzsigndocumentDeleteObjectV1Response class TestEzsigndocumentDeleteObjectV1Response(unittest.TestCase): """EzsigndocumentDeleteObjectV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigndocumentDeleteObjectV1Respons optional params are included """ # uncomment below to create an instance of `EzsigndocumentDeleteObjectV1Response` """ - model = EzsigndocumentDeleteObjectV1Response() # noqa: E501 + model = EzsigndocumentDeleteObjectV1Response() if include_optional: return EzsigndocumentDeleteObjectV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsigndocument_edit_ezsignformfieldgroups_v1_request.py b/test/test_ezsigndocument_edit_ezsignformfieldgroups_v1_request.py index 2dbb256a1..f4f5bf16d 100644 --- a/test/test_ezsigndocument_edit_ezsignformfieldgroups_v1_request.py +++ b/test/test_ezsigndocument_edit_ezsignformfieldgroups_v1_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigndocument_edit_ezsignformfieldgroups_v1_request import EzsigndocumentEditEzsignformfieldgroupsV1Request # noqa: E501 +from eZmaxApi.models.ezsigndocument_edit_ezsignformfieldgroups_v1_request import EzsigndocumentEditEzsignformfieldgroupsV1Request class TestEzsigndocumentEditEzsignformfieldgroupsV1Request(unittest.TestCase): """EzsigndocumentEditEzsignformfieldgroupsV1Request unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigndocumentEditEzsignformfieldgr optional params are included """ # uncomment below to create an instance of `EzsigndocumentEditEzsignformfieldgroupsV1Request` """ - model = EzsigndocumentEditEzsignformfieldgroupsV1Request() # noqa: E501 + model = EzsigndocumentEditEzsignformfieldgroupsV1Request() if include_optional: return EzsigndocumentEditEzsignformfieldgroupsV1Request( a_obj_ezsignformfieldgroup = [ diff --git a/test/test_ezsigndocument_edit_ezsignformfieldgroups_v1_response.py b/test/test_ezsigndocument_edit_ezsignformfieldgroups_v1_response.py index 83bb0a611..f6dbe600a 100644 --- a/test/test_ezsigndocument_edit_ezsignformfieldgroups_v1_response.py +++ b/test/test_ezsigndocument_edit_ezsignformfieldgroups_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigndocument_edit_ezsignformfieldgroups_v1_response import EzsigndocumentEditEzsignformfieldgroupsV1Response # noqa: E501 +from eZmaxApi.models.ezsigndocument_edit_ezsignformfieldgroups_v1_response import EzsigndocumentEditEzsignformfieldgroupsV1Response class TestEzsigndocumentEditEzsignformfieldgroupsV1Response(unittest.TestCase): """EzsigndocumentEditEzsignformfieldgroupsV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigndocumentEditEzsignformfieldgr optional params are included """ # uncomment below to create an instance of `EzsigndocumentEditEzsignformfieldgroupsV1Response` """ - model = EzsigndocumentEditEzsignformfieldgroupsV1Response() # noqa: E501 + model = EzsigndocumentEditEzsignformfieldgroupsV1Response() if include_optional: return EzsigndocumentEditEzsignformfieldgroupsV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsigndocument_edit_ezsignformfieldgroups_v1_response_m_payload.py b/test/test_ezsigndocument_edit_ezsignformfieldgroups_v1_response_m_payload.py index d1f78a4cf..fc82bd5eb 100644 --- a/test/test_ezsigndocument_edit_ezsignformfieldgroups_v1_response_m_payload.py +++ b/test/test_ezsigndocument_edit_ezsignformfieldgroups_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigndocument_edit_ezsignformfieldgroups_v1_response_m_payload import EzsigndocumentEditEzsignformfieldgroupsV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezsigndocument_edit_ezsignformfieldgroups_v1_response_m_payload import EzsigndocumentEditEzsignformfieldgroupsV1ResponseMPayload class TestEzsigndocumentEditEzsignformfieldgroupsV1ResponseMPayload(unittest.TestCase): """EzsigndocumentEditEzsignformfieldgroupsV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigndocumentEditEzsignformfieldgr optional params are included """ # uncomment below to create an instance of `EzsigndocumentEditEzsignformfieldgroupsV1ResponseMPayload` """ - model = EzsigndocumentEditEzsignformfieldgroupsV1ResponseMPayload() # noqa: E501 + model = EzsigndocumentEditEzsignformfieldgroupsV1ResponseMPayload() if include_optional: return EzsigndocumentEditEzsignformfieldgroupsV1ResponseMPayload( a_pki_ezsignformfieldgroup_id = [ diff --git a/test/test_ezsigndocument_edit_ezsignsignatures_v1_request.py b/test/test_ezsigndocument_edit_ezsignsignatures_v1_request.py index f318e9e50..1a774274e 100644 --- a/test/test_ezsigndocument_edit_ezsignsignatures_v1_request.py +++ b/test/test_ezsigndocument_edit_ezsignsignatures_v1_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigndocument_edit_ezsignsignatures_v1_request import EzsigndocumentEditEzsignsignaturesV1Request # noqa: E501 +from eZmaxApi.models.ezsigndocument_edit_ezsignsignatures_v1_request import EzsigndocumentEditEzsignsignaturesV1Request class TestEzsigndocumentEditEzsignsignaturesV1Request(unittest.TestCase): """EzsigndocumentEditEzsignsignaturesV1Request unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigndocumentEditEzsignsignaturesV optional params are included """ # uncomment below to create an instance of `EzsigndocumentEditEzsignsignaturesV1Request` """ - model = EzsigndocumentEditEzsignsignaturesV1Request() # noqa: E501 + model = EzsigndocumentEditEzsignsignaturesV1Request() if include_optional: return EzsigndocumentEditEzsignsignaturesV1Request( a_obj_ezsignsignature = [ diff --git a/test/test_ezsigndocument_edit_ezsignsignatures_v1_response.py b/test/test_ezsigndocument_edit_ezsignsignatures_v1_response.py index b91bf9a0e..48ce19cff 100644 --- a/test/test_ezsigndocument_edit_ezsignsignatures_v1_response.py +++ b/test/test_ezsigndocument_edit_ezsignsignatures_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigndocument_edit_ezsignsignatures_v1_response import EzsigndocumentEditEzsignsignaturesV1Response # noqa: E501 +from eZmaxApi.models.ezsigndocument_edit_ezsignsignatures_v1_response import EzsigndocumentEditEzsignsignaturesV1Response class TestEzsigndocumentEditEzsignsignaturesV1Response(unittest.TestCase): """EzsigndocumentEditEzsignsignaturesV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigndocumentEditEzsignsignaturesV optional params are included """ # uncomment below to create an instance of `EzsigndocumentEditEzsignsignaturesV1Response` """ - model = EzsigndocumentEditEzsignsignaturesV1Response() # noqa: E501 + model = EzsigndocumentEditEzsignsignaturesV1Response() if include_optional: return EzsigndocumentEditEzsignsignaturesV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsigndocument_edit_ezsignsignatures_v1_response_m_payload.py b/test/test_ezsigndocument_edit_ezsignsignatures_v1_response_m_payload.py index a9a4ace6e..f7de7bb2a 100644 --- a/test/test_ezsigndocument_edit_ezsignsignatures_v1_response_m_payload.py +++ b/test/test_ezsigndocument_edit_ezsignsignatures_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigndocument_edit_ezsignsignatures_v1_response_m_payload import EzsigndocumentEditEzsignsignaturesV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezsigndocument_edit_ezsignsignatures_v1_response_m_payload import EzsigndocumentEditEzsignsignaturesV1ResponseMPayload class TestEzsigndocumentEditEzsignsignaturesV1ResponseMPayload(unittest.TestCase): """EzsigndocumentEditEzsignsignaturesV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigndocumentEditEzsignsignaturesV optional params are included """ # uncomment below to create an instance of `EzsigndocumentEditEzsignsignaturesV1ResponseMPayload` """ - model = EzsigndocumentEditEzsignsignaturesV1ResponseMPayload() # noqa: E501 + model = EzsigndocumentEditEzsignsignaturesV1ResponseMPayload() if include_optional: return EzsigndocumentEditEzsignsignaturesV1ResponseMPayload( a_pki_ezsignsignature_id = [ diff --git a/test/test_ezsigndocument_end_prematurely_v1_response.py b/test/test_ezsigndocument_end_prematurely_v1_response.py index 93ded5ee0..5d73dab2a 100644 --- a/test/test_ezsigndocument_end_prematurely_v1_response.py +++ b/test/test_ezsigndocument_end_prematurely_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigndocument_end_prematurely_v1_response import EzsigndocumentEndPrematurelyV1Response # noqa: E501 +from eZmaxApi.models.ezsigndocument_end_prematurely_v1_response import EzsigndocumentEndPrematurelyV1Response class TestEzsigndocumentEndPrematurelyV1Response(unittest.TestCase): """EzsigndocumentEndPrematurelyV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigndocumentEndPrematurelyV1Respo optional params are included """ # uncomment below to create an instance of `EzsigndocumentEndPrematurelyV1Response` """ - model = EzsigndocumentEndPrematurelyV1Response() # noqa: E501 + model = EzsigndocumentEndPrematurelyV1Response() if include_optional: return EzsigndocumentEndPrematurelyV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsigndocument_flatten_v1_response.py b/test/test_ezsigndocument_flatten_v1_response.py index c0095b582..e89c32bea 100644 --- a/test/test_ezsigndocument_flatten_v1_response.py +++ b/test/test_ezsigndocument_flatten_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigndocument_flatten_v1_response import EzsigndocumentFlattenV1Response # noqa: E501 +from eZmaxApi.models.ezsigndocument_flatten_v1_response import EzsigndocumentFlattenV1Response class TestEzsigndocumentFlattenV1Response(unittest.TestCase): """EzsigndocumentFlattenV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigndocumentFlattenV1Response: optional params are included """ # uncomment below to create an instance of `EzsigndocumentFlattenV1Response` """ - model = EzsigndocumentFlattenV1Response() # noqa: E501 + model = EzsigndocumentFlattenV1Response() if include_optional: return EzsigndocumentFlattenV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsigndocument_get_actionable_elements_v1_response.py b/test/test_ezsigndocument_get_actionable_elements_v1_response.py index 04de6b58f..c06eeedab 100644 --- a/test/test_ezsigndocument_get_actionable_elements_v1_response.py +++ b/test/test_ezsigndocument_get_actionable_elements_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigndocument_get_actionable_elements_v1_response import EzsigndocumentGetActionableElementsV1Response # noqa: E501 +from eZmaxApi.models.ezsigndocument_get_actionable_elements_v1_response import EzsigndocumentGetActionableElementsV1Response class TestEzsigndocumentGetActionableElementsV1Response(unittest.TestCase): """EzsigndocumentGetActionableElementsV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigndocumentGetActionableElements optional params are included """ # uncomment below to create an instance of `EzsigndocumentGetActionableElementsV1Response` """ - model = EzsigndocumentGetActionableElementsV1Response() # noqa: E501 + model = EzsigndocumentGetActionableElementsV1Response() if include_optional: return EzsigndocumentGetActionableElementsV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsigndocument_get_actionable_elements_v1_response_m_payload.py b/test/test_ezsigndocument_get_actionable_elements_v1_response_m_payload.py index e74796bd2..7f5cc4f34 100644 --- a/test/test_ezsigndocument_get_actionable_elements_v1_response_m_payload.py +++ b/test/test_ezsigndocument_get_actionable_elements_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigndocument_get_actionable_elements_v1_response_m_payload import EzsigndocumentGetActionableElementsV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezsigndocument_get_actionable_elements_v1_response_m_payload import EzsigndocumentGetActionableElementsV1ResponseMPayload class TestEzsigndocumentGetActionableElementsV1ResponseMPayload(unittest.TestCase): """EzsigndocumentGetActionableElementsV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigndocumentGetActionableElements optional params are included """ # uncomment below to create an instance of `EzsigndocumentGetActionableElementsV1ResponseMPayload` """ - model = EzsigndocumentGetActionableElementsV1ResponseMPayload() # noqa: E501 + model = EzsigndocumentGetActionableElementsV1ResponseMPayload() if include_optional: return EzsigndocumentGetActionableElementsV1ResponseMPayload( a_obj_ezsignsignature = [ diff --git a/test/test_ezsigndocument_get_attachments_v1_response.py b/test/test_ezsigndocument_get_attachments_v1_response.py new file mode 100644 index 000000000..b65cf119a --- /dev/null +++ b/test/test_ezsigndocument_get_attachments_v1_response.py @@ -0,0 +1,83 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest +import datetime + +from eZmaxApi.models.ezsigndocument_get_attachments_v1_response import EzsigndocumentGetAttachmentsV1Response + +class TestEzsigndocumentGetAttachmentsV1Response(unittest.TestCase): + """EzsigndocumentGetAttachmentsV1Response unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> EzsigndocumentGetAttachmentsV1Response: + """Test EzsigndocumentGetAttachmentsV1Response + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `EzsigndocumentGetAttachmentsV1Response` + """ + model = EzsigndocumentGetAttachmentsV1Response() + if include_optional: + return EzsigndocumentGetAttachmentsV1Response( + obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( + i_version_min = 1, + i_version_max = 2, + a_required_permission = [ + 117 + ], + b_version_deprecated = False, ), + obj_debug = {"sMemoryUsage":"11,923MB","sRunTime":"0.6084s","iSQLSelects":3,"iSQLQueries":6,"a_objSQLQuery":[{"sQuery":"SELECT * FROM table","fDuration":1.0E-4},{"sQuery":"SELECT * FROM table","fDuration":1.0E-4}]}, + m_payload = eZmaxApi.models.ezsigndocument_get_attachments_v1_response_m_payload.ezsigndocument-getAttachments-v1-Response-mPayload( + a_obj_attachmentdocumenttype = [ + eZmaxApi.models.custom_attachmentdocumenttype_response.Custom-Attachmentdocumenttype-Response( + e_attachment_documenttype = 'Adjustment', + a_obj_attachment = [ + eZmaxApi.models.custom_attachment_response.Custom-Attachment-Response() + ], ) + ], ) + ) + else: + return EzsigndocumentGetAttachmentsV1Response( + obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( + i_version_min = 1, + i_version_max = 2, + a_required_permission = [ + 117 + ], + b_version_deprecated = False, ), + m_payload = eZmaxApi.models.ezsigndocument_get_attachments_v1_response_m_payload.ezsigndocument-getAttachments-v1-Response-mPayload( + a_obj_attachmentdocumenttype = [ + eZmaxApi.models.custom_attachmentdocumenttype_response.Custom-Attachmentdocumenttype-Response( + e_attachment_documenttype = 'Adjustment', + a_obj_attachment = [ + eZmaxApi.models.custom_attachment_response.Custom-Attachment-Response() + ], ) + ], ), + ) + """ + + def testEzsigndocumentGetAttachmentsV1Response(self): + """Test EzsigndocumentGetAttachmentsV1Response""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_ezsigndocument_get_attachments_v1_response_m_payload.py b/test/test_ezsigndocument_get_attachments_v1_response_m_payload.py new file mode 100644 index 000000000..f6a0593be --- /dev/null +++ b/test/test_ezsigndocument_get_attachments_v1_response_m_payload.py @@ -0,0 +1,66 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest +import datetime + +from eZmaxApi.models.ezsigndocument_get_attachments_v1_response_m_payload import EzsigndocumentGetAttachmentsV1ResponseMPayload + +class TestEzsigndocumentGetAttachmentsV1ResponseMPayload(unittest.TestCase): + """EzsigndocumentGetAttachmentsV1ResponseMPayload unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> EzsigndocumentGetAttachmentsV1ResponseMPayload: + """Test EzsigndocumentGetAttachmentsV1ResponseMPayload + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `EzsigndocumentGetAttachmentsV1ResponseMPayload` + """ + model = EzsigndocumentGetAttachmentsV1ResponseMPayload() + if include_optional: + return EzsigndocumentGetAttachmentsV1ResponseMPayload( + a_obj_attachmentdocumenttype = [ + eZmaxApi.models.custom_attachmentdocumenttype_response.Custom-Attachmentdocumenttype-Response( + e_attachment_documenttype = 'Adjustment', + a_obj_attachment = [ + eZmaxApi.models.custom_attachment_response.Custom-Attachment-Response() + ], ) + ] + ) + else: + return EzsigndocumentGetAttachmentsV1ResponseMPayload( + a_obj_attachmentdocumenttype = [ + eZmaxApi.models.custom_attachmentdocumenttype_response.Custom-Attachmentdocumenttype-Response( + e_attachment_documenttype = 'Adjustment', + a_obj_attachment = [ + eZmaxApi.models.custom_attachment_response.Custom-Attachment-Response() + ], ) + ], + ) + """ + + def testEzsigndocumentGetAttachmentsV1ResponseMPayload(self): + """Test EzsigndocumentGetAttachmentsV1ResponseMPayload""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_ezsigndocument_get_completed_elements_v1_response.py b/test/test_ezsigndocument_get_completed_elements_v1_response.py index dfe9d3bdb..453d9206a 100644 --- a/test/test_ezsigndocument_get_completed_elements_v1_response.py +++ b/test/test_ezsigndocument_get_completed_elements_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigndocument_get_completed_elements_v1_response import EzsigndocumentGetCompletedElementsV1Response # noqa: E501 +from eZmaxApi.models.ezsigndocument_get_completed_elements_v1_response import EzsigndocumentGetCompletedElementsV1Response class TestEzsigndocumentGetCompletedElementsV1Response(unittest.TestCase): """EzsigndocumentGetCompletedElementsV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigndocumentGetCompletedElementsV optional params are included """ # uncomment below to create an instance of `EzsigndocumentGetCompletedElementsV1Response` """ - model = EzsigndocumentGetCompletedElementsV1Response() # noqa: E501 + model = EzsigndocumentGetCompletedElementsV1Response() if include_optional: return EzsigndocumentGetCompletedElementsV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsigndocument_get_completed_elements_v1_response_m_payload.py b/test/test_ezsigndocument_get_completed_elements_v1_response_m_payload.py index f9e6f3c04..8da91bcdd 100644 --- a/test/test_ezsigndocument_get_completed_elements_v1_response_m_payload.py +++ b/test/test_ezsigndocument_get_completed_elements_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigndocument_get_completed_elements_v1_response_m_payload import EzsigndocumentGetCompletedElementsV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezsigndocument_get_completed_elements_v1_response_m_payload import EzsigndocumentGetCompletedElementsV1ResponseMPayload class TestEzsigndocumentGetCompletedElementsV1ResponseMPayload(unittest.TestCase): """EzsigndocumentGetCompletedElementsV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigndocumentGetCompletedElementsV optional params are included """ # uncomment below to create an instance of `EzsigndocumentGetCompletedElementsV1ResponseMPayload` """ - model = EzsigndocumentGetCompletedElementsV1ResponseMPayload() # noqa: E501 + model = EzsigndocumentGetCompletedElementsV1ResponseMPayload() if include_optional: return EzsigndocumentGetCompletedElementsV1ResponseMPayload( a_obj_ezsignsignature = [ diff --git a/test/test_ezsigndocument_get_download_url_v1_response.py b/test/test_ezsigndocument_get_download_url_v1_response.py index 04c20dc3e..ddbe20a15 100644 --- a/test/test_ezsigndocument_get_download_url_v1_response.py +++ b/test/test_ezsigndocument_get_download_url_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigndocument_get_download_url_v1_response import EzsigndocumentGetDownloadUrlV1Response # noqa: E501 +from eZmaxApi.models.ezsigndocument_get_download_url_v1_response import EzsigndocumentGetDownloadUrlV1Response class TestEzsigndocumentGetDownloadUrlV1Response(unittest.TestCase): """EzsigndocumentGetDownloadUrlV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigndocumentGetDownloadUrlV1Respo optional params are included """ # uncomment below to create an instance of `EzsigndocumentGetDownloadUrlV1Response` """ - model = EzsigndocumentGetDownloadUrlV1Response() # noqa: E501 + model = EzsigndocumentGetDownloadUrlV1Response() if include_optional: return EzsigndocumentGetDownloadUrlV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsigndocument_get_download_url_v1_response_m_payload.py b/test/test_ezsigndocument_get_download_url_v1_response_m_payload.py index 755e1c364..90e1e09f9 100644 --- a/test/test_ezsigndocument_get_download_url_v1_response_m_payload.py +++ b/test/test_ezsigndocument_get_download_url_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigndocument_get_download_url_v1_response_m_payload import EzsigndocumentGetDownloadUrlV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezsigndocument_get_download_url_v1_response_m_payload import EzsigndocumentGetDownloadUrlV1ResponseMPayload class TestEzsigndocumentGetDownloadUrlV1ResponseMPayload(unittest.TestCase): """EzsigndocumentGetDownloadUrlV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigndocumentGetDownloadUrlV1Respo optional params are included """ # uncomment below to create an instance of `EzsigndocumentGetDownloadUrlV1ResponseMPayload` """ - model = EzsigndocumentGetDownloadUrlV1ResponseMPayload() # noqa: E501 + model = EzsigndocumentGetDownloadUrlV1ResponseMPayload() if include_optional: return EzsigndocumentGetDownloadUrlV1ResponseMPayload( s_download_url = 'http://www.example.com/document.pdf' diff --git a/test/test_ezsigndocument_get_ezsignannotations_v1_response.py b/test/test_ezsigndocument_get_ezsignannotations_v1_response.py index a5705b8c4..21162c1e8 100644 --- a/test/test_ezsigndocument_get_ezsignannotations_v1_response.py +++ b/test/test_ezsigndocument_get_ezsignannotations_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigndocument_get_ezsignannotations_v1_response import EzsigndocumentGetEzsignannotationsV1Response # noqa: E501 +from eZmaxApi.models.ezsigndocument_get_ezsignannotations_v1_response import EzsigndocumentGetEzsignannotationsV1Response class TestEzsigndocumentGetEzsignannotationsV1Response(unittest.TestCase): """EzsigndocumentGetEzsignannotationsV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigndocumentGetEzsignannotationsV optional params are included """ # uncomment below to create an instance of `EzsigndocumentGetEzsignannotationsV1Response` """ - model = EzsigndocumentGetEzsignannotationsV1Response() # noqa: E501 + model = EzsigndocumentGetEzsignannotationsV1Response() if include_optional: return EzsigndocumentGetEzsignannotationsV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsigndocument_get_ezsignannotations_v1_response_m_payload.py b/test/test_ezsigndocument_get_ezsignannotations_v1_response_m_payload.py index a25a81446..e8daf6cda 100644 --- a/test/test_ezsigndocument_get_ezsignannotations_v1_response_m_payload.py +++ b/test/test_ezsigndocument_get_ezsignannotations_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigndocument_get_ezsignannotations_v1_response_m_payload import EzsigndocumentGetEzsignannotationsV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezsigndocument_get_ezsignannotations_v1_response_m_payload import EzsigndocumentGetEzsignannotationsV1ResponseMPayload class TestEzsigndocumentGetEzsignannotationsV1ResponseMPayload(unittest.TestCase): """EzsigndocumentGetEzsignannotationsV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigndocumentGetEzsignannotationsV optional params are included """ # uncomment below to create an instance of `EzsigndocumentGetEzsignannotationsV1ResponseMPayload` """ - model = EzsigndocumentGetEzsignannotationsV1ResponseMPayload() # noqa: E501 + model = EzsigndocumentGetEzsignannotationsV1ResponseMPayload() if include_optional: return EzsigndocumentGetEzsignannotationsV1ResponseMPayload( a_obj_ezsignannotation = [ diff --git a/test/test_ezsigndocument_get_ezsignformfieldgroups_v1_response.py b/test/test_ezsigndocument_get_ezsignformfieldgroups_v1_response.py index 23b4ddbb8..a4758bfd7 100644 --- a/test/test_ezsigndocument_get_ezsignformfieldgroups_v1_response.py +++ b/test/test_ezsigndocument_get_ezsignformfieldgroups_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigndocument_get_ezsignformfieldgroups_v1_response import EzsigndocumentGetEzsignformfieldgroupsV1Response # noqa: E501 +from eZmaxApi.models.ezsigndocument_get_ezsignformfieldgroups_v1_response import EzsigndocumentGetEzsignformfieldgroupsV1Response class TestEzsigndocumentGetEzsignformfieldgroupsV1Response(unittest.TestCase): """EzsigndocumentGetEzsignformfieldgroupsV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigndocumentGetEzsignformfieldgro optional params are included """ # uncomment below to create an instance of `EzsigndocumentGetEzsignformfieldgroupsV1Response` """ - model = EzsigndocumentGetEzsignformfieldgroupsV1Response() # noqa: E501 + model = EzsigndocumentGetEzsignformfieldgroupsV1Response() if include_optional: return EzsigndocumentGetEzsignformfieldgroupsV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsigndocument_get_ezsignformfieldgroups_v1_response_m_payload.py b/test/test_ezsigndocument_get_ezsignformfieldgroups_v1_response_m_payload.py index 48c444b03..a81328319 100644 --- a/test/test_ezsigndocument_get_ezsignformfieldgroups_v1_response_m_payload.py +++ b/test/test_ezsigndocument_get_ezsignformfieldgroups_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigndocument_get_ezsignformfieldgroups_v1_response_m_payload import EzsigndocumentGetEzsignformfieldgroupsV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezsigndocument_get_ezsignformfieldgroups_v1_response_m_payload import EzsigndocumentGetEzsignformfieldgroupsV1ResponseMPayload class TestEzsigndocumentGetEzsignformfieldgroupsV1ResponseMPayload(unittest.TestCase): """EzsigndocumentGetEzsignformfieldgroupsV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigndocumentGetEzsignformfieldgro optional params are included """ # uncomment below to create an instance of `EzsigndocumentGetEzsignformfieldgroupsV1ResponseMPayload` """ - model = EzsigndocumentGetEzsignformfieldgroupsV1ResponseMPayload() # noqa: E501 + model = EzsigndocumentGetEzsignformfieldgroupsV1ResponseMPayload() if include_optional: return EzsigndocumentGetEzsignformfieldgroupsV1ResponseMPayload( a_obj_ezsignformfieldgroup = [ diff --git a/test/test_ezsigndocument_get_ezsignpages_v1_response.py b/test/test_ezsigndocument_get_ezsignpages_v1_response.py index d51ab9224..fff23ee88 100644 --- a/test/test_ezsigndocument_get_ezsignpages_v1_response.py +++ b/test/test_ezsigndocument_get_ezsignpages_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigndocument_get_ezsignpages_v1_response import EzsigndocumentGetEzsignpagesV1Response # noqa: E501 +from eZmaxApi.models.ezsigndocument_get_ezsignpages_v1_response import EzsigndocumentGetEzsignpagesV1Response class TestEzsigndocumentGetEzsignpagesV1Response(unittest.TestCase): """EzsigndocumentGetEzsignpagesV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigndocumentGetEzsignpagesV1Respo optional params are included """ # uncomment below to create an instance of `EzsigndocumentGetEzsignpagesV1Response` """ - model = EzsigndocumentGetEzsignpagesV1Response() # noqa: E501 + model = EzsigndocumentGetEzsignpagesV1Response() if include_optional: return EzsigndocumentGetEzsignpagesV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsigndocument_get_ezsignpages_v1_response_m_payload.py b/test/test_ezsigndocument_get_ezsignpages_v1_response_m_payload.py index faed151df..a6b12df8b 100644 --- a/test/test_ezsigndocument_get_ezsignpages_v1_response_m_payload.py +++ b/test/test_ezsigndocument_get_ezsignpages_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigndocument_get_ezsignpages_v1_response_m_payload import EzsigndocumentGetEzsignpagesV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezsigndocument_get_ezsignpages_v1_response_m_payload import EzsigndocumentGetEzsignpagesV1ResponseMPayload class TestEzsigndocumentGetEzsignpagesV1ResponseMPayload(unittest.TestCase): """EzsigndocumentGetEzsignpagesV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigndocumentGetEzsignpagesV1Respo optional params are included """ # uncomment below to create an instance of `EzsigndocumentGetEzsignpagesV1ResponseMPayload` """ - model = EzsigndocumentGetEzsignpagesV1ResponseMPayload() # noqa: E501 + model = EzsigndocumentGetEzsignpagesV1ResponseMPayload() if include_optional: return EzsigndocumentGetEzsignpagesV1ResponseMPayload( a_obj_ezsignpage = [ diff --git a/test/test_ezsigndocument_get_ezsignsignatures_automatic_v1_response.py b/test/test_ezsigndocument_get_ezsignsignatures_automatic_v1_response.py index 6561772fe..88382caa5 100644 --- a/test/test_ezsigndocument_get_ezsignsignatures_automatic_v1_response.py +++ b/test/test_ezsigndocument_get_ezsignsignatures_automatic_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigndocument_get_ezsignsignatures_automatic_v1_response import EzsigndocumentGetEzsignsignaturesAutomaticV1Response # noqa: E501 +from eZmaxApi.models.ezsigndocument_get_ezsignsignatures_automatic_v1_response import EzsigndocumentGetEzsignsignaturesAutomaticV1Response class TestEzsigndocumentGetEzsignsignaturesAutomaticV1Response(unittest.TestCase): """EzsigndocumentGetEzsignsignaturesAutomaticV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigndocumentGetEzsignsignaturesAu optional params are included """ # uncomment below to create an instance of `EzsigndocumentGetEzsignsignaturesAutomaticV1Response` """ - model = EzsigndocumentGetEzsignsignaturesAutomaticV1Response() # noqa: E501 + model = EzsigndocumentGetEzsignsignaturesAutomaticV1Response() if include_optional: return EzsigndocumentGetEzsignsignaturesAutomaticV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsigndocument_get_ezsignsignatures_automatic_v1_response_m_payload.py b/test/test_ezsigndocument_get_ezsignsignatures_automatic_v1_response_m_payload.py index 6b3111193..d65f86117 100644 --- a/test/test_ezsigndocument_get_ezsignsignatures_automatic_v1_response_m_payload.py +++ b/test/test_ezsigndocument_get_ezsignsignatures_automatic_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigndocument_get_ezsignsignatures_automatic_v1_response_m_payload import EzsigndocumentGetEzsignsignaturesAutomaticV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezsigndocument_get_ezsignsignatures_automatic_v1_response_m_payload import EzsigndocumentGetEzsignsignaturesAutomaticV1ResponseMPayload class TestEzsigndocumentGetEzsignsignaturesAutomaticV1ResponseMPayload(unittest.TestCase): """EzsigndocumentGetEzsignsignaturesAutomaticV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigndocumentGetEzsignsignaturesAu optional params are included """ # uncomment below to create an instance of `EzsigndocumentGetEzsignsignaturesAutomaticV1ResponseMPayload` """ - model = EzsigndocumentGetEzsignsignaturesAutomaticV1ResponseMPayload() # noqa: E501 + model = EzsigndocumentGetEzsignsignaturesAutomaticV1ResponseMPayload() if include_optional: return EzsigndocumentGetEzsignsignaturesAutomaticV1ResponseMPayload( a_e_ezsignsignature_type = [ diff --git a/test/test_ezsigndocument_get_ezsignsignatures_v1_response.py b/test/test_ezsigndocument_get_ezsignsignatures_v1_response.py index f8761d5ef..c26bd7628 100644 --- a/test/test_ezsigndocument_get_ezsignsignatures_v1_response.py +++ b/test/test_ezsigndocument_get_ezsignsignatures_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigndocument_get_ezsignsignatures_v1_response import EzsigndocumentGetEzsignsignaturesV1Response # noqa: E501 +from eZmaxApi.models.ezsigndocument_get_ezsignsignatures_v1_response import EzsigndocumentGetEzsignsignaturesV1Response class TestEzsigndocumentGetEzsignsignaturesV1Response(unittest.TestCase): """EzsigndocumentGetEzsignsignaturesV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigndocumentGetEzsignsignaturesV1 optional params are included """ # uncomment below to create an instance of `EzsigndocumentGetEzsignsignaturesV1Response` """ - model = EzsigndocumentGetEzsignsignaturesV1Response() # noqa: E501 + model = EzsigndocumentGetEzsignsignaturesV1Response() if include_optional: return EzsigndocumentGetEzsignsignaturesV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsigndocument_get_ezsignsignatures_v1_response_m_payload.py b/test/test_ezsigndocument_get_ezsignsignatures_v1_response_m_payload.py index ff10a0f79..f772f23b1 100644 --- a/test/test_ezsigndocument_get_ezsignsignatures_v1_response_m_payload.py +++ b/test/test_ezsigndocument_get_ezsignsignatures_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigndocument_get_ezsignsignatures_v1_response_m_payload import EzsigndocumentGetEzsignsignaturesV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezsigndocument_get_ezsignsignatures_v1_response_m_payload import EzsigndocumentGetEzsignsignaturesV1ResponseMPayload class TestEzsigndocumentGetEzsignsignaturesV1ResponseMPayload(unittest.TestCase): """EzsigndocumentGetEzsignsignaturesV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigndocumentGetEzsignsignaturesV1 optional params are included """ # uncomment below to create an instance of `EzsigndocumentGetEzsignsignaturesV1ResponseMPayload` """ - model = EzsigndocumentGetEzsignsignaturesV1ResponseMPayload() # noqa: E501 + model = EzsigndocumentGetEzsignsignaturesV1ResponseMPayload() if include_optional: return EzsigndocumentGetEzsignsignaturesV1ResponseMPayload( a_obj_ezsignsignature = [ diff --git a/test/test_ezsigndocument_get_form_data_v1_response.py b/test/test_ezsigndocument_get_form_data_v1_response.py index 5203ba6ce..465617820 100644 --- a/test/test_ezsigndocument_get_form_data_v1_response.py +++ b/test/test_ezsigndocument_get_form_data_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigndocument_get_form_data_v1_response import EzsigndocumentGetFormDataV1Response # noqa: E501 +from eZmaxApi.models.ezsigndocument_get_form_data_v1_response import EzsigndocumentGetFormDataV1Response class TestEzsigndocumentGetFormDataV1Response(unittest.TestCase): """EzsigndocumentGetFormDataV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigndocumentGetFormDataV1Response optional params are included """ # uncomment below to create an instance of `EzsigndocumentGetFormDataV1Response` """ - model = EzsigndocumentGetFormDataV1Response() # noqa: E501 + model = EzsigndocumentGetFormDataV1Response() if include_optional: return EzsigndocumentGetFormDataV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsigndocument_get_form_data_v1_response_m_payload.py b/test/test_ezsigndocument_get_form_data_v1_response_m_payload.py index 7c036c177..3b84935aa 100644 --- a/test/test_ezsigndocument_get_form_data_v1_response_m_payload.py +++ b/test/test_ezsigndocument_get_form_data_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigndocument_get_form_data_v1_response_m_payload import EzsigndocumentGetFormDataV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezsigndocument_get_form_data_v1_response_m_payload import EzsigndocumentGetFormDataV1ResponseMPayload class TestEzsigndocumentGetFormDataV1ResponseMPayload(unittest.TestCase): """EzsigndocumentGetFormDataV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigndocumentGetFormDataV1Response optional params are included """ # uncomment below to create an instance of `EzsigndocumentGetFormDataV1ResponseMPayload` """ - model = EzsigndocumentGetFormDataV1ResponseMPayload() # noqa: E501 + model = EzsigndocumentGetFormDataV1ResponseMPayload() if include_optional: return EzsigndocumentGetFormDataV1ResponseMPayload( obj_form_data_document = eZmaxApi.models.custom_form_data_document_response.Custom-FormDataDocument-Response( diff --git a/test/test_ezsigndocument_get_object_v1_response.py b/test/test_ezsigndocument_get_object_v1_response.py index 490f94fb1..21526ba7f 100644 --- a/test/test_ezsigndocument_get_object_v1_response.py +++ b/test/test_ezsigndocument_get_object_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigndocument_get_object_v1_response import EzsigndocumentGetObjectV1Response # noqa: E501 +from eZmaxApi.models.ezsigndocument_get_object_v1_response import EzsigndocumentGetObjectV1Response class TestEzsigndocumentGetObjectV1Response(unittest.TestCase): """EzsigndocumentGetObjectV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigndocumentGetObjectV1Response: optional params are included """ # uncomment below to create an instance of `EzsigndocumentGetObjectV1Response` """ - model = EzsigndocumentGetObjectV1Response() # noqa: E501 + model = EzsigndocumentGetObjectV1Response() if include_optional: return EzsigndocumentGetObjectV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsigndocument_get_object_v1_response_m_payload.py b/test/test_ezsigndocument_get_object_v1_response_m_payload.py index 53489c60c..874b4ea10 100644 --- a/test/test_ezsigndocument_get_object_v1_response_m_payload.py +++ b/test/test_ezsigndocument_get_object_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigndocument_get_object_v1_response_m_payload import EzsigndocumentGetObjectV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezsigndocument_get_object_v1_response_m_payload import EzsigndocumentGetObjectV1ResponseMPayload class TestEzsigndocumentGetObjectV1ResponseMPayload(unittest.TestCase): """EzsigndocumentGetObjectV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigndocumentGetObjectV1ResponseMP optional params are included """ # uncomment below to create an instance of `EzsigndocumentGetObjectV1ResponseMPayload` """ - model = EzsigndocumentGetObjectV1ResponseMPayload() # noqa: E501 + model = EzsigndocumentGetObjectV1ResponseMPayload() if include_optional: return EzsigndocumentGetObjectV1ResponseMPayload( pki_ezsigndocument_id = 97, @@ -74,6 +74,7 @@ def make_instance(self, include_optional) -> EzsigndocumentGetObjectV1ResponseMP s_apikey_description_x = 'Project X', dt_auditdetail_date = '2020-12-31 23:59:59', ), ), s_ezsigndocument_externalid = '{"ID": 1234, "TAGS": ["tag1", "tag2", "tag3"]}', + i_ezsigndocument_ezsignsignatureattachmenttotal = 3, e_ezsigndocument_steptype = 'Sign', i_ezsigndocument_stepformtotal = 2, i_ezsigndocument_stepformcurrent = 1, @@ -105,6 +106,7 @@ def make_instance(self, include_optional) -> EzsigndocumentGetObjectV1ResponseMP i_ezsigndocument_pagetotal = 4, i_ezsigndocument_signaturesigned = 3, i_ezsigndocument_signaturetotal = 4, + i_ezsigndocument_ezsignsignatureattachmenttotal = 3, e_ezsigndocument_steptype = 'Sign', i_ezsigndocument_stepformtotal = 2, i_ezsigndocument_stepformcurrent = 1, diff --git a/test/test_ezsigndocument_get_object_v2_response.py b/test/test_ezsigndocument_get_object_v2_response.py index 243768f87..f5f0b85c2 100644 --- a/test/test_ezsigndocument_get_object_v2_response.py +++ b/test/test_ezsigndocument_get_object_v2_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigndocument_get_object_v2_response import EzsigndocumentGetObjectV2Response # noqa: E501 +from eZmaxApi.models.ezsigndocument_get_object_v2_response import EzsigndocumentGetObjectV2Response class TestEzsigndocumentGetObjectV2Response(unittest.TestCase): """EzsigndocumentGetObjectV2Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigndocumentGetObjectV2Response: optional params are included """ # uncomment below to create an instance of `EzsigndocumentGetObjectV2Response` """ - model = EzsigndocumentGetObjectV2Response() # noqa: E501 + model = EzsigndocumentGetObjectV2Response() if include_optional: return EzsigndocumentGetObjectV2Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsigndocument_get_object_v2_response_m_payload.py b/test/test_ezsigndocument_get_object_v2_response_m_payload.py index 12b91dada..2171c0e7a 100644 --- a/test/test_ezsigndocument_get_object_v2_response_m_payload.py +++ b/test/test_ezsigndocument_get_object_v2_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigndocument_get_object_v2_response_m_payload import EzsigndocumentGetObjectV2ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezsigndocument_get_object_v2_response_m_payload import EzsigndocumentGetObjectV2ResponseMPayload class TestEzsigndocumentGetObjectV2ResponseMPayload(unittest.TestCase): """EzsigndocumentGetObjectV2ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigndocumentGetObjectV2ResponseMP optional params are included """ # uncomment below to create an instance of `EzsigndocumentGetObjectV2ResponseMPayload` """ - model = EzsigndocumentGetObjectV2ResponseMPayload() # noqa: E501 + model = EzsigndocumentGetObjectV2ResponseMPayload() if include_optional: return EzsigndocumentGetObjectV2ResponseMPayload( obj_ezsigndocument = eZmaxApi.models.ezsigndocument_response_compound.ezsigndocument-ResponseCompound() diff --git a/test/test_ezsigndocument_get_temporary_proof_v1_response.py b/test/test_ezsigndocument_get_temporary_proof_v1_response.py index b21fc2ac5..15f260742 100644 --- a/test/test_ezsigndocument_get_temporary_proof_v1_response.py +++ b/test/test_ezsigndocument_get_temporary_proof_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigndocument_get_temporary_proof_v1_response import EzsigndocumentGetTemporaryProofV1Response # noqa: E501 +from eZmaxApi.models.ezsigndocument_get_temporary_proof_v1_response import EzsigndocumentGetTemporaryProofV1Response class TestEzsigndocumentGetTemporaryProofV1Response(unittest.TestCase): """EzsigndocumentGetTemporaryProofV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigndocumentGetTemporaryProofV1Re optional params are included """ # uncomment below to create an instance of `EzsigndocumentGetTemporaryProofV1Response` """ - model = EzsigndocumentGetTemporaryProofV1Response() # noqa: E501 + model = EzsigndocumentGetTemporaryProofV1Response() if include_optional: return EzsigndocumentGetTemporaryProofV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsigndocument_get_temporary_proof_v1_response_m_payload.py b/test/test_ezsigndocument_get_temporary_proof_v1_response_m_payload.py index 279a57bb1..df9ffca0e 100644 --- a/test/test_ezsigndocument_get_temporary_proof_v1_response_m_payload.py +++ b/test/test_ezsigndocument_get_temporary_proof_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigndocument_get_temporary_proof_v1_response_m_payload import EzsigndocumentGetTemporaryProofV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezsigndocument_get_temporary_proof_v1_response_m_payload import EzsigndocumentGetTemporaryProofV1ResponseMPayload class TestEzsigndocumentGetTemporaryProofV1ResponseMPayload(unittest.TestCase): """EzsigndocumentGetTemporaryProofV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigndocumentGetTemporaryProofV1Re optional params are included """ # uncomment below to create an instance of `EzsigndocumentGetTemporaryProofV1ResponseMPayload` """ - model = EzsigndocumentGetTemporaryProofV1ResponseMPayload() # noqa: E501 + model = EzsigndocumentGetTemporaryProofV1ResponseMPayload() if include_optional: return EzsigndocumentGetTemporaryProofV1ResponseMPayload( a_obj_ezsigndocumentlog = [ diff --git a/test/test_ezsigndocument_get_words_positions_v1_request.py b/test/test_ezsigndocument_get_words_positions_v1_request.py index 4067a9078..58814b983 100644 --- a/test/test_ezsigndocument_get_words_positions_v1_request.py +++ b/test/test_ezsigndocument_get_words_positions_v1_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigndocument_get_words_positions_v1_request import EzsigndocumentGetWordsPositionsV1Request # noqa: E501 +from eZmaxApi.models.ezsigndocument_get_words_positions_v1_request import EzsigndocumentGetWordsPositionsV1Request class TestEzsigndocumentGetWordsPositionsV1Request(unittest.TestCase): """EzsigndocumentGetWordsPositionsV1Request unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigndocumentGetWordsPositionsV1Re optional params are included """ # uncomment below to create an instance of `EzsigndocumentGetWordsPositionsV1Request` """ - model = EzsigndocumentGetWordsPositionsV1Request() # noqa: E501 + model = EzsigndocumentGetWordsPositionsV1Request() if include_optional: return EzsigndocumentGetWordsPositionsV1Request( e_get = 'All', diff --git a/test/test_ezsigndocument_get_words_positions_v1_response.py b/test/test_ezsigndocument_get_words_positions_v1_response.py index 516a3bc28..b304f744d 100644 --- a/test/test_ezsigndocument_get_words_positions_v1_response.py +++ b/test/test_ezsigndocument_get_words_positions_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigndocument_get_words_positions_v1_response import EzsigndocumentGetWordsPositionsV1Response # noqa: E501 +from eZmaxApi.models.ezsigndocument_get_words_positions_v1_response import EzsigndocumentGetWordsPositionsV1Response class TestEzsigndocumentGetWordsPositionsV1Response(unittest.TestCase): """EzsigndocumentGetWordsPositionsV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigndocumentGetWordsPositionsV1Re optional params are included """ # uncomment below to create an instance of `EzsigndocumentGetWordsPositionsV1Response` """ - model = EzsigndocumentGetWordsPositionsV1Response() # noqa: E501 + model = EzsigndocumentGetWordsPositionsV1Response() if include_optional: return EzsigndocumentGetWordsPositionsV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsigndocument_patch_object_v1_request.py b/test/test_ezsigndocument_patch_object_v1_request.py index 8f6f57092..22e111b53 100644 --- a/test/test_ezsigndocument_patch_object_v1_request.py +++ b/test/test_ezsigndocument_patch_object_v1_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigndocument_patch_object_v1_request import EzsigndocumentPatchObjectV1Request # noqa: E501 +from eZmaxApi.models.ezsigndocument_patch_object_v1_request import EzsigndocumentPatchObjectV1Request class TestEzsigndocumentPatchObjectV1Request(unittest.TestCase): """EzsigndocumentPatchObjectV1Request unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigndocumentPatchObjectV1Request: optional params are included """ # uncomment below to create an instance of `EzsigndocumentPatchObjectV1Request` """ - model = EzsigndocumentPatchObjectV1Request() # noqa: E501 + model = EzsigndocumentPatchObjectV1Request() if include_optional: return EzsigndocumentPatchObjectV1Request( obj_ezsigndocument = eZmaxApi.models.ezsigndocument_request_patch.ezsigndocument-RequestPatch( diff --git a/test/test_ezsigndocument_patch_object_v1_response.py b/test/test_ezsigndocument_patch_object_v1_response.py index 9d92d39c6..77d8cb8da 100644 --- a/test/test_ezsigndocument_patch_object_v1_response.py +++ b/test/test_ezsigndocument_patch_object_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigndocument_patch_object_v1_response import EzsigndocumentPatchObjectV1Response # noqa: E501 +from eZmaxApi.models.ezsigndocument_patch_object_v1_response import EzsigndocumentPatchObjectV1Response class TestEzsigndocumentPatchObjectV1Response(unittest.TestCase): """EzsigndocumentPatchObjectV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigndocumentPatchObjectV1Response optional params are included """ # uncomment below to create an instance of `EzsigndocumentPatchObjectV1Response` """ - model = EzsigndocumentPatchObjectV1Response() # noqa: E501 + model = EzsigndocumentPatchObjectV1Response() if include_optional: return EzsigndocumentPatchObjectV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsigndocument_request.py b/test/test_ezsigndocument_request.py index 1b2f55960..7e2f23c4b 100644 --- a/test/test_ezsigndocument_request.py +++ b/test/test_ezsigndocument_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigndocument_request import EzsigndocumentRequest # noqa: E501 +from eZmaxApi.models.ezsigndocument_request import EzsigndocumentRequest class TestEzsigndocumentRequest(unittest.TestCase): """EzsigndocumentRequest unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigndocumentRequest: optional params are included """ # uncomment below to create an instance of `EzsigndocumentRequest` """ - model = EzsigndocumentRequest() # noqa: E501 + model = EzsigndocumentRequest() if include_optional: return EzsigndocumentRequest( pki_ezsigndocument_id = 97, @@ -44,7 +44,7 @@ def make_instance(self, include_optional) -> EzsigndocumentRequest: fki_language_id = 2, e_ezsigndocument_source = 'Base64', e_ezsigndocument_format = 'Pdf', - s_ezsigndocument_base64 = '[B@30ea8c23', + s_ezsigndocument_base64 = '[B@26fb628', s_ezsigndocument_url = 'http://www.example.com/document.pdf', b_ezsigndocument_forcerepair = True, s_ezsigndocument_password = 'SecretPassword123', diff --git a/test/test_ezsigndocument_request_compound.py b/test/test_ezsigndocument_request_compound.py index 8829f66b9..f714e8ff8 100644 --- a/test/test_ezsigndocument_request_compound.py +++ b/test/test_ezsigndocument_request_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigndocument_request_compound import EzsigndocumentRequestCompound # noqa: E501 +from eZmaxApi.models.ezsigndocument_request_compound import EzsigndocumentRequestCompound class TestEzsigndocumentRequestCompound(unittest.TestCase): """EzsigndocumentRequestCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigndocumentRequestCompound: optional params are included """ # uncomment below to create an instance of `EzsigndocumentRequestCompound` """ - model = EzsigndocumentRequestCompound() # noqa: E501 + model = EzsigndocumentRequestCompound() if include_optional: return EzsigndocumentRequestCompound( pki_ezsigndocument_id = 97, @@ -44,7 +44,7 @@ def make_instance(self, include_optional) -> EzsigndocumentRequestCompound: fki_language_id = 2, e_ezsigndocument_source = 'Base64', e_ezsigndocument_format = 'Pdf', - s_ezsigndocument_base64 = '[B@30ea8c23', + s_ezsigndocument_base64 = 'eyIkcmVmIjoiIy9jb21wb25lbnRzL2V4YW1wbGVzL1BkZkFzQmFzZTY0L3ZhbHVlIn0=', s_ezsigndocument_url = 'http://www.example.com/document.pdf', b_ezsigndocument_forcerepair = True, s_ezsigndocument_password = 'SecretPassword123', diff --git a/test/test_ezsigndocument_request_patch.py b/test/test_ezsigndocument_request_patch.py index 7a5e0c598..6bae7675c 100644 --- a/test/test_ezsigndocument_request_patch.py +++ b/test/test_ezsigndocument_request_patch.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigndocument_request_patch import EzsigndocumentRequestPatch # noqa: E501 +from eZmaxApi.models.ezsigndocument_request_patch import EzsigndocumentRequestPatch class TestEzsigndocumentRequestPatch(unittest.TestCase): """EzsigndocumentRequestPatch unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigndocumentRequestPatch: optional params are included """ # uncomment below to create an instance of `EzsigndocumentRequestPatch` """ - model = EzsigndocumentRequestPatch() # noqa: E501 + model = EzsigndocumentRequestPatch() if include_optional: return EzsigndocumentRequestPatch( dt_ezsigndocument_duedate = '2020-12-31 23:59:59', diff --git a/test/test_ezsigndocument_response.py b/test/test_ezsigndocument_response.py index 25dda333b..ebbd1e131 100644 --- a/test/test_ezsigndocument_response.py +++ b/test/test_ezsigndocument_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigndocument_response import EzsigndocumentResponse # noqa: E501 +from eZmaxApi.models.ezsigndocument_response import EzsigndocumentResponse class TestEzsigndocumentResponse(unittest.TestCase): """EzsigndocumentResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigndocumentResponse: optional params are included """ # uncomment below to create an instance of `EzsigndocumentResponse` """ - model = EzsigndocumentResponse() # noqa: E501 + model = EzsigndocumentResponse() if include_optional: return EzsigndocumentResponse( pki_ezsigndocument_id = 97, @@ -73,7 +73,8 @@ def make_instance(self, include_optional) -> EzsigndocumentResponse: s_user_firstname = 'John', s_apikey_description_x = 'Project X', dt_auditdetail_date = '2020-12-31 23:59:59', ), ), - s_ezsigndocument_externalid = '{"ID": 1234, "TAGS": ["tag1", "tag2", "tag3"]}' + s_ezsigndocument_externalid = '{"ID": 1234, "TAGS": ["tag1", "tag2", "tag3"]}', + i_ezsigndocument_ezsignsignatureattachmenttotal = 3 ) else: return EzsigndocumentResponse( @@ -86,6 +87,7 @@ def make_instance(self, include_optional) -> EzsigndocumentResponse: i_ezsigndocument_pagetotal = 4, i_ezsigndocument_signaturesigned = 3, i_ezsigndocument_signaturetotal = 4, + i_ezsigndocument_ezsignsignatureattachmenttotal = 3, ) """ diff --git a/test/test_ezsigndocument_response_compound.py b/test/test_ezsigndocument_response_compound.py index 0ae4eba22..3a6e202f9 100644 --- a/test/test_ezsigndocument_response_compound.py +++ b/test/test_ezsigndocument_response_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigndocument_response_compound import EzsigndocumentResponseCompound # noqa: E501 +from eZmaxApi.models.ezsigndocument_response_compound import EzsigndocumentResponseCompound class TestEzsigndocumentResponseCompound(unittest.TestCase): """EzsigndocumentResponseCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigndocumentResponseCompound: optional params are included """ # uncomment below to create an instance of `EzsigndocumentResponseCompound` """ - model = EzsigndocumentResponseCompound() # noqa: E501 + model = EzsigndocumentResponseCompound() if include_optional: return EzsigndocumentResponseCompound( pki_ezsigndocument_id = 97, @@ -74,6 +74,7 @@ def make_instance(self, include_optional) -> EzsigndocumentResponseCompound: s_apikey_description_x = 'Project X', dt_auditdetail_date = '2020-12-31 23:59:59', ), ), s_ezsigndocument_externalid = '{"ID": 1234, "TAGS": ["tag1", "tag2", "tag3"]}', + i_ezsigndocument_ezsignsignatureattachmenttotal = 3, e_ezsigndocument_steptype = 'Sign', i_ezsigndocument_stepformtotal = 2, i_ezsigndocument_stepformcurrent = 1, @@ -105,6 +106,7 @@ def make_instance(self, include_optional) -> EzsigndocumentResponseCompound: i_ezsigndocument_pagetotal = 4, i_ezsigndocument_signaturesigned = 3, i_ezsigndocument_signaturetotal = 4, + i_ezsigndocument_ezsignsignatureattachmenttotal = 3, e_ezsigndocument_steptype = 'Sign', i_ezsigndocument_stepformtotal = 2, i_ezsigndocument_stepformcurrent = 1, diff --git a/test/test_ezsigndocument_submit_ezsignform_v1_request.py b/test/test_ezsigndocument_submit_ezsignform_v1_request.py index b504161ec..bbc628d45 100644 --- a/test/test_ezsigndocument_submit_ezsignform_v1_request.py +++ b/test/test_ezsigndocument_submit_ezsignform_v1_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigndocument_submit_ezsignform_v1_request import EzsigndocumentSubmitEzsignformV1Request # noqa: E501 +from eZmaxApi.models.ezsigndocument_submit_ezsignform_v1_request import EzsigndocumentSubmitEzsignformV1Request class TestEzsigndocumentSubmitEzsignformV1Request(unittest.TestCase): """EzsigndocumentSubmitEzsignformV1Request unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigndocumentSubmitEzsignformV1Req optional params are included """ # uncomment below to create an instance of `EzsigndocumentSubmitEzsignformV1Request` """ - model = EzsigndocumentSubmitEzsignformV1Request() # noqa: E501 + model = EzsigndocumentSubmitEzsignformV1Request() if include_optional: return EzsigndocumentSubmitEzsignformV1Request( b_ezsignform_isdraft = True, diff --git a/test/test_ezsigndocument_submit_ezsignform_v1_response.py b/test/test_ezsigndocument_submit_ezsignform_v1_response.py index 9d08a720f..fd4082dd2 100644 --- a/test/test_ezsigndocument_submit_ezsignform_v1_response.py +++ b/test/test_ezsigndocument_submit_ezsignform_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigndocument_submit_ezsignform_v1_response import EzsigndocumentSubmitEzsignformV1Response # noqa: E501 +from eZmaxApi.models.ezsigndocument_submit_ezsignform_v1_response import EzsigndocumentSubmitEzsignformV1Response class TestEzsigndocumentSubmitEzsignformV1Response(unittest.TestCase): """EzsigndocumentSubmitEzsignformV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigndocumentSubmitEzsignformV1Res optional params are included """ # uncomment below to create an instance of `EzsigndocumentSubmitEzsignformV1Response` """ - model = EzsigndocumentSubmitEzsignformV1Response() # noqa: E501 + model = EzsigndocumentSubmitEzsignformV1Response() if include_optional: return EzsigndocumentSubmitEzsignformV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsigndocument_unsend_v1_response.py b/test/test_ezsigndocument_unsend_v1_response.py index 1f74d5dfd..6623c133e 100644 --- a/test/test_ezsigndocument_unsend_v1_response.py +++ b/test/test_ezsigndocument_unsend_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigndocument_unsend_v1_response import EzsigndocumentUnsendV1Response # noqa: E501 +from eZmaxApi.models.ezsigndocument_unsend_v1_response import EzsigndocumentUnsendV1Response class TestEzsigndocumentUnsendV1Response(unittest.TestCase): """EzsigndocumentUnsendV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigndocumentUnsendV1Response: optional params are included """ # uncomment below to create an instance of `EzsigndocumentUnsendV1Response` """ - model = EzsigndocumentUnsendV1Response() # noqa: E501 + model = EzsigndocumentUnsendV1Response() if include_optional: return EzsigndocumentUnsendV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsigndocumentlog_response.py b/test/test_ezsigndocumentlog_response.py index d9dc966d4..199f9d8a5 100644 --- a/test/test_ezsigndocumentlog_response.py +++ b/test/test_ezsigndocumentlog_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigndocumentlog_response import EzsigndocumentlogResponse # noqa: E501 +from eZmaxApi.models.ezsigndocumentlog_response import EzsigndocumentlogResponse class TestEzsigndocumentlogResponse(unittest.TestCase): """EzsigndocumentlogResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigndocumentlogResponse: optional params are included """ # uncomment below to create an instance of `EzsigndocumentlogResponse` """ - model = EzsigndocumentlogResponse() # noqa: E501 + model = EzsigndocumentlogResponse() if include_optional: return EzsigndocumentlogResponse( fki_user_id = 70, diff --git a/test/test_ezsigndocumentlog_response_compound.py b/test/test_ezsigndocumentlog_response_compound.py index fa0101358..4a805c845 100644 --- a/test/test_ezsigndocumentlog_response_compound.py +++ b/test/test_ezsigndocumentlog_response_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigndocumentlog_response_compound import EzsigndocumentlogResponseCompound # noqa: E501 +from eZmaxApi.models.ezsigndocumentlog_response_compound import EzsigndocumentlogResponseCompound class TestEzsigndocumentlogResponseCompound(unittest.TestCase): """EzsigndocumentlogResponseCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigndocumentlogResponseCompound: optional params are included """ # uncomment below to create an instance of `EzsigndocumentlogResponseCompound` """ - model = EzsigndocumentlogResponseCompound() # noqa: E501 + model = EzsigndocumentlogResponseCompound() if include_optional: return EzsigndocumentlogResponseCompound( fki_user_id = 70, diff --git a/test/test_ezsignelementdependency_request.py b/test/test_ezsignelementdependency_request.py index 61cc21ffa..cf2a2a9cf 100644 --- a/test/test_ezsignelementdependency_request.py +++ b/test/test_ezsignelementdependency_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignelementdependency_request import EzsignelementdependencyRequest # noqa: E501 +from eZmaxApi.models.ezsignelementdependency_request import EzsignelementdependencyRequest class TestEzsignelementdependencyRequest(unittest.TestCase): """EzsignelementdependencyRequest unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignelementdependencyRequest: optional params are included """ # uncomment below to create an instance of `EzsignelementdependencyRequest` """ - model = EzsignelementdependencyRequest() # noqa: E501 + model = EzsignelementdependencyRequest() if include_optional: return EzsignelementdependencyRequest( pki_ezsignelementdependency_id = 89, diff --git a/test/test_ezsignelementdependency_request_compound.py b/test/test_ezsignelementdependency_request_compound.py index c5321ad1e..1a4320aaf 100644 --- a/test/test_ezsignelementdependency_request_compound.py +++ b/test/test_ezsignelementdependency_request_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignelementdependency_request_compound import EzsignelementdependencyRequestCompound # noqa: E501 +from eZmaxApi.models.ezsignelementdependency_request_compound import EzsignelementdependencyRequestCompound class TestEzsignelementdependencyRequestCompound(unittest.TestCase): """EzsignelementdependencyRequestCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignelementdependencyRequestCompo optional params are included """ # uncomment below to create an instance of `EzsignelementdependencyRequestCompound` """ - model = EzsignelementdependencyRequestCompound() # noqa: E501 + model = EzsignelementdependencyRequestCompound() if include_optional: return EzsignelementdependencyRequestCompound( pki_ezsignelementdependency_id = 89, diff --git a/test/test_ezsignelementdependency_response.py b/test/test_ezsignelementdependency_response.py index a4ef66dfd..1c979207a 100644 --- a/test/test_ezsignelementdependency_response.py +++ b/test/test_ezsignelementdependency_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignelementdependency_response import EzsignelementdependencyResponse # noqa: E501 +from eZmaxApi.models.ezsignelementdependency_response import EzsignelementdependencyResponse class TestEzsignelementdependencyResponse(unittest.TestCase): """EzsignelementdependencyResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignelementdependencyResponse: optional params are included """ # uncomment below to create an instance of `EzsignelementdependencyResponse` """ - model = EzsignelementdependencyResponse() # noqa: E501 + model = EzsignelementdependencyResponse() if include_optional: return EzsignelementdependencyResponse( pki_ezsignelementdependency_id = 89, diff --git a/test/test_ezsignelementdependency_response_compound.py b/test/test_ezsignelementdependency_response_compound.py index 0ef547880..02be49e91 100644 --- a/test/test_ezsignelementdependency_response_compound.py +++ b/test/test_ezsignelementdependency_response_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignelementdependency_response_compound import EzsignelementdependencyResponseCompound # noqa: E501 +from eZmaxApi.models.ezsignelementdependency_response_compound import EzsignelementdependencyResponseCompound class TestEzsignelementdependencyResponseCompound(unittest.TestCase): """EzsignelementdependencyResponseCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignelementdependencyResponseComp optional params are included """ # uncomment below to create an instance of `EzsignelementdependencyResponseCompound` """ - model = EzsignelementdependencyResponseCompound() # noqa: E501 + model = EzsignelementdependencyResponseCompound() if include_optional: return EzsignelementdependencyResponseCompound( pki_ezsignelementdependency_id = 89, diff --git a/test/test_ezsignfolder_archive_v1_response.py b/test/test_ezsignfolder_archive_v1_response.py index 659c45452..e96bbda4a 100644 --- a/test/test_ezsignfolder_archive_v1_response.py +++ b/test/test_ezsignfolder_archive_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignfolder_archive_v1_response import EzsignfolderArchiveV1Response # noqa: E501 +from eZmaxApi.models.ezsignfolder_archive_v1_response import EzsignfolderArchiveV1Response class TestEzsignfolderArchiveV1Response(unittest.TestCase): """EzsignfolderArchiveV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignfolderArchiveV1Response: optional params are included """ # uncomment below to create an instance of `EzsignfolderArchiveV1Response` """ - model = EzsignfolderArchiveV1Response() # noqa: E501 + model = EzsignfolderArchiveV1Response() if include_optional: return EzsignfolderArchiveV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsignfolder_batch_download_v1_request.py b/test/test_ezsignfolder_batch_download_v1_request.py index 346b7ccf6..53ce1f7ef 100644 --- a/test/test_ezsignfolder_batch_download_v1_request.py +++ b/test/test_ezsignfolder_batch_download_v1_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignfolder_batch_download_v1_request import EzsignfolderBatchDownloadV1Request # noqa: E501 +from eZmaxApi.models.ezsignfolder_batch_download_v1_request import EzsignfolderBatchDownloadV1Request class TestEzsignfolderBatchDownloadV1Request(unittest.TestCase): """EzsignfolderBatchDownloadV1Request unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignfolderBatchDownloadV1Request: optional params are included """ # uncomment below to create an instance of `EzsignfolderBatchDownloadV1Request` """ - model = EzsignfolderBatchDownloadV1Request() # noqa: E501 + model = EzsignfolderBatchDownloadV1Request() if include_optional: return EzsignfolderBatchDownloadV1Request( a_pki_ezsigndocument_id = [ diff --git a/test/test_ezsignfolder_create_object_v1_request.py b/test/test_ezsignfolder_create_object_v1_request.py index c85d15ea1..03457fe6d 100644 --- a/test/test_ezsignfolder_create_object_v1_request.py +++ b/test/test_ezsignfolder_create_object_v1_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignfolder_create_object_v1_request import EzsignfolderCreateObjectV1Request # noqa: E501 +from eZmaxApi.models.ezsignfolder_create_object_v1_request import EzsignfolderCreateObjectV1Request class TestEzsignfolderCreateObjectV1Request(unittest.TestCase): """EzsignfolderCreateObjectV1Request unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignfolderCreateObjectV1Request: optional params are included """ # uncomment below to create an instance of `EzsignfolderCreateObjectV1Request` """ - model = EzsignfolderCreateObjectV1Request() # noqa: E501 + model = EzsignfolderCreateObjectV1Request() if include_optional: return EzsignfolderCreateObjectV1Request( obj_ezsignfolder = eZmaxApi.models.ezsignfolder_request.ezsignfolder-Request( diff --git a/test/test_ezsignfolder_create_object_v1_response.py b/test/test_ezsignfolder_create_object_v1_response.py index 434cba58a..86518308f 100644 --- a/test/test_ezsignfolder_create_object_v1_response.py +++ b/test/test_ezsignfolder_create_object_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignfolder_create_object_v1_response import EzsignfolderCreateObjectV1Response # noqa: E501 +from eZmaxApi.models.ezsignfolder_create_object_v1_response import EzsignfolderCreateObjectV1Response class TestEzsignfolderCreateObjectV1Response(unittest.TestCase): """EzsignfolderCreateObjectV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignfolderCreateObjectV1Response: optional params are included """ # uncomment below to create an instance of `EzsignfolderCreateObjectV1Response` """ - model = EzsignfolderCreateObjectV1Response() # noqa: E501 + model = EzsignfolderCreateObjectV1Response() if include_optional: return EzsignfolderCreateObjectV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsignfolder_create_object_v1_response_m_payload.py b/test/test_ezsignfolder_create_object_v1_response_m_payload.py index 1444135f5..4164b6c09 100644 --- a/test/test_ezsignfolder_create_object_v1_response_m_payload.py +++ b/test/test_ezsignfolder_create_object_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignfolder_create_object_v1_response_m_payload import EzsignfolderCreateObjectV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezsignfolder_create_object_v1_response_m_payload import EzsignfolderCreateObjectV1ResponseMPayload class TestEzsignfolderCreateObjectV1ResponseMPayload(unittest.TestCase): """EzsignfolderCreateObjectV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignfolderCreateObjectV1ResponseM optional params are included """ # uncomment below to create an instance of `EzsignfolderCreateObjectV1ResponseMPayload` """ - model = EzsignfolderCreateObjectV1ResponseMPayload() # noqa: E501 + model = EzsignfolderCreateObjectV1ResponseMPayload() if include_optional: return EzsignfolderCreateObjectV1ResponseMPayload( a_pki_ezsignfolder_id = [ diff --git a/test/test_ezsignfolder_create_object_v2_request.py b/test/test_ezsignfolder_create_object_v2_request.py index 020cbc62e..52c58b4bd 100644 --- a/test/test_ezsignfolder_create_object_v2_request.py +++ b/test/test_ezsignfolder_create_object_v2_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignfolder_create_object_v2_request import EzsignfolderCreateObjectV2Request # noqa: E501 +from eZmaxApi.models.ezsignfolder_create_object_v2_request import EzsignfolderCreateObjectV2Request class TestEzsignfolderCreateObjectV2Request(unittest.TestCase): """EzsignfolderCreateObjectV2Request unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignfolderCreateObjectV2Request: optional params are included """ # uncomment below to create an instance of `EzsignfolderCreateObjectV2Request` """ - model = EzsignfolderCreateObjectV2Request() # noqa: E501 + model = EzsignfolderCreateObjectV2Request() if include_optional: return EzsignfolderCreateObjectV2Request( a_obj_ezsignfolder = [ diff --git a/test/test_ezsignfolder_create_object_v2_response.py b/test/test_ezsignfolder_create_object_v2_response.py index 8fc026b02..7d75767c7 100644 --- a/test/test_ezsignfolder_create_object_v2_response.py +++ b/test/test_ezsignfolder_create_object_v2_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignfolder_create_object_v2_response import EzsignfolderCreateObjectV2Response # noqa: E501 +from eZmaxApi.models.ezsignfolder_create_object_v2_response import EzsignfolderCreateObjectV2Response class TestEzsignfolderCreateObjectV2Response(unittest.TestCase): """EzsignfolderCreateObjectV2Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignfolderCreateObjectV2Response: optional params are included """ # uncomment below to create an instance of `EzsignfolderCreateObjectV2Response` """ - model = EzsignfolderCreateObjectV2Response() # noqa: E501 + model = EzsignfolderCreateObjectV2Response() if include_optional: return EzsignfolderCreateObjectV2Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsignfolder_create_object_v2_response_m_payload.py b/test/test_ezsignfolder_create_object_v2_response_m_payload.py index 84e4238b4..cf361abf4 100644 --- a/test/test_ezsignfolder_create_object_v2_response_m_payload.py +++ b/test/test_ezsignfolder_create_object_v2_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignfolder_create_object_v2_response_m_payload import EzsignfolderCreateObjectV2ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezsignfolder_create_object_v2_response_m_payload import EzsignfolderCreateObjectV2ResponseMPayload class TestEzsignfolderCreateObjectV2ResponseMPayload(unittest.TestCase): """EzsignfolderCreateObjectV2ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignfolderCreateObjectV2ResponseM optional params are included """ # uncomment below to create an instance of `EzsignfolderCreateObjectV2ResponseMPayload` """ - model = EzsignfolderCreateObjectV2ResponseMPayload() # noqa: E501 + model = EzsignfolderCreateObjectV2ResponseMPayload() if include_optional: return EzsignfolderCreateObjectV2ResponseMPayload( a_pki_ezsignfolder_id = [ diff --git a/test/test_ezsignfolder_delete_object_v1_response.py b/test/test_ezsignfolder_delete_object_v1_response.py index 91da03d45..d37fee707 100644 --- a/test/test_ezsignfolder_delete_object_v1_response.py +++ b/test/test_ezsignfolder_delete_object_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignfolder_delete_object_v1_response import EzsignfolderDeleteObjectV1Response # noqa: E501 +from eZmaxApi.models.ezsignfolder_delete_object_v1_response import EzsignfolderDeleteObjectV1Response class TestEzsignfolderDeleteObjectV1Response(unittest.TestCase): """EzsignfolderDeleteObjectV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignfolderDeleteObjectV1Response: optional params are included """ # uncomment below to create an instance of `EzsignfolderDeleteObjectV1Response` """ - model = EzsignfolderDeleteObjectV1Response() # noqa: E501 + model = EzsignfolderDeleteObjectV1Response() if include_optional: return EzsignfolderDeleteObjectV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsignfolder_dispose_ezsignfolders_v1_request.py b/test/test_ezsignfolder_dispose_ezsignfolders_v1_request.py index c3c5bac4b..17c82801b 100644 --- a/test/test_ezsignfolder_dispose_ezsignfolders_v1_request.py +++ b/test/test_ezsignfolder_dispose_ezsignfolders_v1_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignfolder_dispose_ezsignfolders_v1_request import EzsignfolderDisposeEzsignfoldersV1Request # noqa: E501 +from eZmaxApi.models.ezsignfolder_dispose_ezsignfolders_v1_request import EzsignfolderDisposeEzsignfoldersV1Request class TestEzsignfolderDisposeEzsignfoldersV1Request(unittest.TestCase): """EzsignfolderDisposeEzsignfoldersV1Request unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignfolderDisposeEzsignfoldersV1R optional params are included """ # uncomment below to create an instance of `EzsignfolderDisposeEzsignfoldersV1Request` """ - model = EzsignfolderDisposeEzsignfoldersV1Request() # noqa: E501 + model = EzsignfolderDisposeEzsignfoldersV1Request() if include_optional: return EzsignfolderDisposeEzsignfoldersV1Request( a_pki_ezsignfolder_id = [ diff --git a/test/test_ezsignfolder_dispose_ezsignfolders_v1_response.py b/test/test_ezsignfolder_dispose_ezsignfolders_v1_response.py index 30789ec0a..b3978bc3f 100644 --- a/test/test_ezsignfolder_dispose_ezsignfolders_v1_response.py +++ b/test/test_ezsignfolder_dispose_ezsignfolders_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignfolder_dispose_ezsignfolders_v1_response import EzsignfolderDisposeEzsignfoldersV1Response # noqa: E501 +from eZmaxApi.models.ezsignfolder_dispose_ezsignfolders_v1_response import EzsignfolderDisposeEzsignfoldersV1Response class TestEzsignfolderDisposeEzsignfoldersV1Response(unittest.TestCase): """EzsignfolderDisposeEzsignfoldersV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignfolderDisposeEzsignfoldersV1R optional params are included """ # uncomment below to create an instance of `EzsignfolderDisposeEzsignfoldersV1Response` """ - model = EzsignfolderDisposeEzsignfoldersV1Response() # noqa: E501 + model = EzsignfolderDisposeEzsignfoldersV1Response() if include_optional: return EzsignfolderDisposeEzsignfoldersV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsignfolder_dispose_v1_response.py b/test/test_ezsignfolder_dispose_v1_response.py index c92e05dd2..07c7fd9b3 100644 --- a/test/test_ezsignfolder_dispose_v1_response.py +++ b/test/test_ezsignfolder_dispose_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignfolder_dispose_v1_response import EzsignfolderDisposeV1Response # noqa: E501 +from eZmaxApi.models.ezsignfolder_dispose_v1_response import EzsignfolderDisposeV1Response class TestEzsignfolderDisposeV1Response(unittest.TestCase): """EzsignfolderDisposeV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignfolderDisposeV1Response: optional params are included """ # uncomment below to create an instance of `EzsignfolderDisposeV1Response` """ - model = EzsignfolderDisposeV1Response() # noqa: E501 + model = EzsignfolderDisposeV1Response() if include_optional: return EzsignfolderDisposeV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsignfolder_edit_object_v1_request.py b/test/test_ezsignfolder_edit_object_v1_request.py index 99e60478a..ac0b685bf 100644 --- a/test/test_ezsignfolder_edit_object_v1_request.py +++ b/test/test_ezsignfolder_edit_object_v1_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignfolder_edit_object_v1_request import EzsignfolderEditObjectV1Request # noqa: E501 +from eZmaxApi.models.ezsignfolder_edit_object_v1_request import EzsignfolderEditObjectV1Request class TestEzsignfolderEditObjectV1Request(unittest.TestCase): """EzsignfolderEditObjectV1Request unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignfolderEditObjectV1Request: optional params are included """ # uncomment below to create an instance of `EzsignfolderEditObjectV1Request` """ - model = EzsignfolderEditObjectV1Request() # noqa: E501 + model = EzsignfolderEditObjectV1Request() if include_optional: return EzsignfolderEditObjectV1Request( obj_ezsignfolder = eZmaxApi.models.ezsignfolder_request_compound.ezsignfolder-RequestCompound() diff --git a/test/test_ezsignfolder_edit_object_v1_response.py b/test/test_ezsignfolder_edit_object_v1_response.py index 5876e258f..1fe93f827 100644 --- a/test/test_ezsignfolder_edit_object_v1_response.py +++ b/test/test_ezsignfolder_edit_object_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignfolder_edit_object_v1_response import EzsignfolderEditObjectV1Response # noqa: E501 +from eZmaxApi.models.ezsignfolder_edit_object_v1_response import EzsignfolderEditObjectV1Response class TestEzsignfolderEditObjectV1Response(unittest.TestCase): """EzsignfolderEditObjectV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignfolderEditObjectV1Response: optional params are included """ # uncomment below to create an instance of `EzsignfolderEditObjectV1Response` """ - model = EzsignfolderEditObjectV1Response() # noqa: E501 + model = EzsignfolderEditObjectV1Response() if include_optional: return EzsignfolderEditObjectV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsignfolder_get_actionable_elements_v1_response.py b/test/test_ezsignfolder_get_actionable_elements_v1_response.py index a632a0351..1b8e32732 100644 --- a/test/test_ezsignfolder_get_actionable_elements_v1_response.py +++ b/test/test_ezsignfolder_get_actionable_elements_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignfolder_get_actionable_elements_v1_response import EzsignfolderGetActionableElementsV1Response # noqa: E501 +from eZmaxApi.models.ezsignfolder_get_actionable_elements_v1_response import EzsignfolderGetActionableElementsV1Response class TestEzsignfolderGetActionableElementsV1Response(unittest.TestCase): """EzsignfolderGetActionableElementsV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignfolderGetActionableElementsV1 optional params are included """ # uncomment below to create an instance of `EzsignfolderGetActionableElementsV1Response` """ - model = EzsignfolderGetActionableElementsV1Response() # noqa: E501 + model = EzsignfolderGetActionableElementsV1Response() if include_optional: return EzsignfolderGetActionableElementsV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsignfolder_get_actionable_elements_v1_response_m_payload.py b/test/test_ezsignfolder_get_actionable_elements_v1_response_m_payload.py index 13f35ca17..036cd43cb 100644 --- a/test/test_ezsignfolder_get_actionable_elements_v1_response_m_payload.py +++ b/test/test_ezsignfolder_get_actionable_elements_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignfolder_get_actionable_elements_v1_response_m_payload import EzsignfolderGetActionableElementsV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezsignfolder_get_actionable_elements_v1_response_m_payload import EzsignfolderGetActionableElementsV1ResponseMPayload class TestEzsignfolderGetActionableElementsV1ResponseMPayload(unittest.TestCase): """EzsignfolderGetActionableElementsV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignfolderGetActionableElementsV1 optional params are included """ # uncomment below to create an instance of `EzsignfolderGetActionableElementsV1ResponseMPayload` """ - model = EzsignfolderGetActionableElementsV1ResponseMPayload() # noqa: E501 + model = EzsignfolderGetActionableElementsV1ResponseMPayload() if include_optional: return EzsignfolderGetActionableElementsV1ResponseMPayload( a_obj_ezsignsignature = [ diff --git a/test/test_ezsignfolder_get_attachment_count_v1_response.py b/test/test_ezsignfolder_get_attachment_count_v1_response.py new file mode 100644 index 000000000..198bfa42f --- /dev/null +++ b/test/test_ezsignfolder_get_attachment_count_v1_response.py @@ -0,0 +1,71 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest +import datetime + +from eZmaxApi.models.ezsignfolder_get_attachment_count_v1_response import EzsignfolderGetAttachmentCountV1Response + +class TestEzsignfolderGetAttachmentCountV1Response(unittest.TestCase): + """EzsignfolderGetAttachmentCountV1Response unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> EzsignfolderGetAttachmentCountV1Response: + """Test EzsignfolderGetAttachmentCountV1Response + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `EzsignfolderGetAttachmentCountV1Response` + """ + model = EzsignfolderGetAttachmentCountV1Response() + if include_optional: + return EzsignfolderGetAttachmentCountV1Response( + obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( + i_version_min = 1, + i_version_max = 2, + a_required_permission = [ + 117 + ], + b_version_deprecated = False, ), + obj_debug = {"sMemoryUsage":"11,923MB","sRunTime":"0.6084s","iSQLSelects":3,"iSQLQueries":6,"a_objSQLQuery":[{"sQuery":"SELECT * FROM table","fDuration":1.0E-4},{"sQuery":"SELECT * FROM table","fDuration":1.0E-4}]}, + m_payload = eZmaxApi.models.ezsignfolder_get_attachment_count_v1_response_m_payload.ezsignfolder-getAttachmentCount-v1-Response-mPayload( + i_attachment_count = 4, ) + ) + else: + return EzsignfolderGetAttachmentCountV1Response( + obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( + i_version_min = 1, + i_version_max = 2, + a_required_permission = [ + 117 + ], + b_version_deprecated = False, ), + m_payload = eZmaxApi.models.ezsignfolder_get_attachment_count_v1_response_m_payload.ezsignfolder-getAttachmentCount-v1-Response-mPayload( + i_attachment_count = 4, ), + ) + """ + + def testEzsignfolderGetAttachmentCountV1Response(self): + """Test EzsignfolderGetAttachmentCountV1Response""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_ezsignfolder_get_attachment_count_v1_response_m_payload.py b/test/test_ezsignfolder_get_attachment_count_v1_response_m_payload.py new file mode 100644 index 000000000..0f79fb543 --- /dev/null +++ b/test/test_ezsignfolder_get_attachment_count_v1_response_m_payload.py @@ -0,0 +1,54 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest +import datetime + +from eZmaxApi.models.ezsignfolder_get_attachment_count_v1_response_m_payload import EzsignfolderGetAttachmentCountV1ResponseMPayload + +class TestEzsignfolderGetAttachmentCountV1ResponseMPayload(unittest.TestCase): + """EzsignfolderGetAttachmentCountV1ResponseMPayload unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> EzsignfolderGetAttachmentCountV1ResponseMPayload: + """Test EzsignfolderGetAttachmentCountV1ResponseMPayload + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `EzsignfolderGetAttachmentCountV1ResponseMPayload` + """ + model = EzsignfolderGetAttachmentCountV1ResponseMPayload() + if include_optional: + return EzsignfolderGetAttachmentCountV1ResponseMPayload( + i_attachment_count = 4 + ) + else: + return EzsignfolderGetAttachmentCountV1ResponseMPayload( + i_attachment_count = 4, + ) + """ + + def testEzsignfolderGetAttachmentCountV1ResponseMPayload(self): + """Test EzsignfolderGetAttachmentCountV1ResponseMPayload""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_ezsignfolder_get_attachments_v1_response.py b/test/test_ezsignfolder_get_attachments_v1_response.py new file mode 100644 index 000000000..d8695f26d --- /dev/null +++ b/test/test_ezsignfolder_get_attachments_v1_response.py @@ -0,0 +1,83 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest +import datetime + +from eZmaxApi.models.ezsignfolder_get_attachments_v1_response import EzsignfolderGetAttachmentsV1Response + +class TestEzsignfolderGetAttachmentsV1Response(unittest.TestCase): + """EzsignfolderGetAttachmentsV1Response unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> EzsignfolderGetAttachmentsV1Response: + """Test EzsignfolderGetAttachmentsV1Response + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `EzsignfolderGetAttachmentsV1Response` + """ + model = EzsignfolderGetAttachmentsV1Response() + if include_optional: + return EzsignfolderGetAttachmentsV1Response( + obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( + i_version_min = 1, + i_version_max = 2, + a_required_permission = [ + 117 + ], + b_version_deprecated = False, ), + obj_debug = {"sMemoryUsage":"11,923MB","sRunTime":"0.6084s","iSQLSelects":3,"iSQLQueries":6,"a_objSQLQuery":[{"sQuery":"SELECT * FROM table","fDuration":1.0E-4},{"sQuery":"SELECT * FROM table","fDuration":1.0E-4}]}, + m_payload = eZmaxApi.models.ezsignfolder_get_attachments_v1_response_m_payload.ezsignfolder-getAttachments-v1-Response-mPayload( + a_obj_attachmentdocumenttype = [ + eZmaxApi.models.custom_attachmentdocumenttype_response.Custom-Attachmentdocumenttype-Response( + e_attachment_documenttype = 'Adjustment', + a_obj_attachment = [ + eZmaxApi.models.custom_attachment_response.Custom-Attachment-Response() + ], ) + ], ) + ) + else: + return EzsignfolderGetAttachmentsV1Response( + obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( + i_version_min = 1, + i_version_max = 2, + a_required_permission = [ + 117 + ], + b_version_deprecated = False, ), + m_payload = eZmaxApi.models.ezsignfolder_get_attachments_v1_response_m_payload.ezsignfolder-getAttachments-v1-Response-mPayload( + a_obj_attachmentdocumenttype = [ + eZmaxApi.models.custom_attachmentdocumenttype_response.Custom-Attachmentdocumenttype-Response( + e_attachment_documenttype = 'Adjustment', + a_obj_attachment = [ + eZmaxApi.models.custom_attachment_response.Custom-Attachment-Response() + ], ) + ], ), + ) + """ + + def testEzsignfolderGetAttachmentsV1Response(self): + """Test EzsignfolderGetAttachmentsV1Response""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_ezsignfolder_get_attachments_v1_response_m_payload.py b/test/test_ezsignfolder_get_attachments_v1_response_m_payload.py new file mode 100644 index 000000000..77eb90d17 --- /dev/null +++ b/test/test_ezsignfolder_get_attachments_v1_response_m_payload.py @@ -0,0 +1,66 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest +import datetime + +from eZmaxApi.models.ezsignfolder_get_attachments_v1_response_m_payload import EzsignfolderGetAttachmentsV1ResponseMPayload + +class TestEzsignfolderGetAttachmentsV1ResponseMPayload(unittest.TestCase): + """EzsignfolderGetAttachmentsV1ResponseMPayload unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> EzsignfolderGetAttachmentsV1ResponseMPayload: + """Test EzsignfolderGetAttachmentsV1ResponseMPayload + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `EzsignfolderGetAttachmentsV1ResponseMPayload` + """ + model = EzsignfolderGetAttachmentsV1ResponseMPayload() + if include_optional: + return EzsignfolderGetAttachmentsV1ResponseMPayload( + a_obj_attachmentdocumenttype = [ + eZmaxApi.models.custom_attachmentdocumenttype_response.Custom-Attachmentdocumenttype-Response( + e_attachment_documenttype = 'Adjustment', + a_obj_attachment = [ + eZmaxApi.models.custom_attachment_response.Custom-Attachment-Response() + ], ) + ] + ) + else: + return EzsignfolderGetAttachmentsV1ResponseMPayload( + a_obj_attachmentdocumenttype = [ + eZmaxApi.models.custom_attachmentdocumenttype_response.Custom-Attachmentdocumenttype-Response( + e_attachment_documenttype = 'Adjustment', + a_obj_attachment = [ + eZmaxApi.models.custom_attachment_response.Custom-Attachment-Response() + ], ) + ], + ) + """ + + def testEzsignfolderGetAttachmentsV1ResponseMPayload(self): + """Test EzsignfolderGetAttachmentsV1ResponseMPayload""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_ezsignfolder_get_communication_count_v1_response.py b/test/test_ezsignfolder_get_communication_count_v1_response.py index c0cfb6624..6466da50a 100644 --- a/test/test_ezsignfolder_get_communication_count_v1_response.py +++ b/test/test_ezsignfolder_get_communication_count_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignfolder_get_communication_count_v1_response import EzsignfolderGetCommunicationCountV1Response # noqa: E501 +from eZmaxApi.models.ezsignfolder_get_communication_count_v1_response import EzsignfolderGetCommunicationCountV1Response class TestEzsignfolderGetCommunicationCountV1Response(unittest.TestCase): """EzsignfolderGetCommunicationCountV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignfolderGetCommunicationCountV1 optional params are included """ # uncomment below to create an instance of `EzsignfolderGetCommunicationCountV1Response` """ - model = EzsignfolderGetCommunicationCountV1Response() # noqa: E501 + model = EzsignfolderGetCommunicationCountV1Response() if include_optional: return EzsignfolderGetCommunicationCountV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsignfolder_get_communication_count_v1_response_m_payload.py b/test/test_ezsignfolder_get_communication_count_v1_response_m_payload.py index df82d10de..dbc4871cd 100644 --- a/test/test_ezsignfolder_get_communication_count_v1_response_m_payload.py +++ b/test/test_ezsignfolder_get_communication_count_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignfolder_get_communication_count_v1_response_m_payload import EzsignfolderGetCommunicationCountV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezsignfolder_get_communication_count_v1_response_m_payload import EzsignfolderGetCommunicationCountV1ResponseMPayload class TestEzsignfolderGetCommunicationCountV1ResponseMPayload(unittest.TestCase): """EzsignfolderGetCommunicationCountV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignfolderGetCommunicationCountV1 optional params are included """ # uncomment below to create an instance of `EzsignfolderGetCommunicationCountV1ResponseMPayload` """ - model = EzsignfolderGetCommunicationCountV1ResponseMPayload() # noqa: E501 + model = EzsignfolderGetCommunicationCountV1ResponseMPayload() if include_optional: return EzsignfolderGetCommunicationCountV1ResponseMPayload( i_communication_count = 8 diff --git a/test/test_ezsignfolder_get_communication_list_v1_response.py b/test/test_ezsignfolder_get_communication_list_v1_response.py index 0d6bd7d55..5db7b9504 100644 --- a/test/test_ezsignfolder_get_communication_list_v1_response.py +++ b/test/test_ezsignfolder_get_communication_list_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignfolder_get_communication_list_v1_response import EzsignfolderGetCommunicationListV1Response # noqa: E501 +from eZmaxApi.models.ezsignfolder_get_communication_list_v1_response import EzsignfolderGetCommunicationListV1Response class TestEzsignfolderGetCommunicationListV1Response(unittest.TestCase): """EzsignfolderGetCommunicationListV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignfolderGetCommunicationListV1R optional params are included """ # uncomment below to create an instance of `EzsignfolderGetCommunicationListV1Response` """ - model = EzsignfolderGetCommunicationListV1Response() # noqa: E501 + model = EzsignfolderGetCommunicationListV1Response() if include_optional: return EzsignfolderGetCommunicationListV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload_get_list.Common-Response-objDebugPayload_getList(), diff --git a/test/test_ezsignfolder_get_communication_list_v1_response_m_payload.py b/test/test_ezsignfolder_get_communication_list_v1_response_m_payload.py index 4e51db366..e90c70abc 100644 --- a/test/test_ezsignfolder_get_communication_list_v1_response_m_payload.py +++ b/test/test_ezsignfolder_get_communication_list_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignfolder_get_communication_list_v1_response_m_payload import EzsignfolderGetCommunicationListV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezsignfolder_get_communication_list_v1_response_m_payload import EzsignfolderGetCommunicationListV1ResponseMPayload class TestEzsignfolderGetCommunicationListV1ResponseMPayload(unittest.TestCase): """EzsignfolderGetCommunicationListV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignfolderGetCommunicationListV1R optional params are included """ # uncomment below to create an instance of `EzsignfolderGetCommunicationListV1ResponseMPayload` """ - model = EzsignfolderGetCommunicationListV1ResponseMPayload() # noqa: E501 + model = EzsignfolderGetCommunicationListV1ResponseMPayload() if include_optional: return EzsignfolderGetCommunicationListV1ResponseMPayload( a_obj_communication = [ diff --git a/test/test_ezsignfolder_get_communicationrecipients_v1_response.py b/test/test_ezsignfolder_get_communicationrecipients_v1_response.py index 8226e5d79..1f0afdb93 100644 --- a/test/test_ezsignfolder_get_communicationrecipients_v1_response.py +++ b/test/test_ezsignfolder_get_communicationrecipients_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignfolder_get_communicationrecipients_v1_response import EzsignfolderGetCommunicationrecipientsV1Response # noqa: E501 +from eZmaxApi.models.ezsignfolder_get_communicationrecipients_v1_response import EzsignfolderGetCommunicationrecipientsV1Response class TestEzsignfolderGetCommunicationrecipientsV1Response(unittest.TestCase): """EzsignfolderGetCommunicationrecipientsV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignfolderGetCommunicationrecipie optional params are included """ # uncomment below to create an instance of `EzsignfolderGetCommunicationrecipientsV1Response` """ - model = EzsignfolderGetCommunicationrecipientsV1Response() # noqa: E501 + model = EzsignfolderGetCommunicationrecipientsV1Response() if include_optional: return EzsignfolderGetCommunicationrecipientsV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsignfolder_get_communicationrecipients_v1_response_m_payload.py b/test/test_ezsignfolder_get_communicationrecipients_v1_response_m_payload.py index d3b333ebc..d2ca8de20 100644 --- a/test/test_ezsignfolder_get_communicationrecipients_v1_response_m_payload.py +++ b/test/test_ezsignfolder_get_communicationrecipients_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignfolder_get_communicationrecipients_v1_response_m_payload import EzsignfolderGetCommunicationrecipientsV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezsignfolder_get_communicationrecipients_v1_response_m_payload import EzsignfolderGetCommunicationrecipientsV1ResponseMPayload class TestEzsignfolderGetCommunicationrecipientsV1ResponseMPayload(unittest.TestCase): """EzsignfolderGetCommunicationrecipientsV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignfolderGetCommunicationrecipie optional params are included """ # uncomment below to create an instance of `EzsignfolderGetCommunicationrecipientsV1ResponseMPayload` """ - model = EzsignfolderGetCommunicationrecipientsV1ResponseMPayload() # noqa: E501 + model = EzsignfolderGetCommunicationrecipientsV1ResponseMPayload() if include_optional: return EzsignfolderGetCommunicationrecipientsV1ResponseMPayload( a_obj_communicationrecipientsgroup = [ diff --git a/test/test_ezsignfolder_get_communicationsenders_v1_response.py b/test/test_ezsignfolder_get_communicationsenders_v1_response.py index a049c8239..b41e25f29 100644 --- a/test/test_ezsignfolder_get_communicationsenders_v1_response.py +++ b/test/test_ezsignfolder_get_communicationsenders_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignfolder_get_communicationsenders_v1_response import EzsignfolderGetCommunicationsendersV1Response # noqa: E501 +from eZmaxApi.models.ezsignfolder_get_communicationsenders_v1_response import EzsignfolderGetCommunicationsendersV1Response class TestEzsignfolderGetCommunicationsendersV1Response(unittest.TestCase): """EzsignfolderGetCommunicationsendersV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignfolderGetCommunicationsenders optional params are included """ # uncomment below to create an instance of `EzsignfolderGetCommunicationsendersV1Response` """ - model = EzsignfolderGetCommunicationsendersV1Response() # noqa: E501 + model = EzsignfolderGetCommunicationsendersV1Response() if include_optional: return EzsignfolderGetCommunicationsendersV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( @@ -52,13 +52,15 @@ def make_instance(self, include_optional) -> EzsignfolderGetCommunicationsenders fki_broker_id = 26, fki_user_id = 70, fki_mailboxshared_id = 47, + fki_phonelineshared_id = 47, e_communicationsender_objecttype = 'User', obj_contact_name = eZmaxApi.models.custom_contact_name_response.Custom-ContactName-Response( s_contact_firstname = 'John', s_contact_lastname = 'Doe', s_contact_company = 'eZmax Solutions Inc.', ), - s_email_address = 'email@example.com', - s_phone_e164 = '+15149901516', ) + obj_email = eZmaxApi.models.email_response_compound.email-ResponseCompound(), + obj_phone_fax = eZmaxApi.models.phone_response_compound.phone-ResponseCompound(), + obj_phone_sms = eZmaxApi.models.phone_response_compound.phone-ResponseCompound(), ) ], ) ) else: @@ -77,13 +79,15 @@ def make_instance(self, include_optional) -> EzsignfolderGetCommunicationsenders fki_broker_id = 26, fki_user_id = 70, fki_mailboxshared_id = 47, + fki_phonelineshared_id = 47, e_communicationsender_objecttype = 'User', obj_contact_name = eZmaxApi.models.custom_contact_name_response.Custom-ContactName-Response( s_contact_firstname = 'John', s_contact_lastname = 'Doe', s_contact_company = 'eZmax Solutions Inc.', ), - s_email_address = 'email@example.com', - s_phone_e164 = '+15149901516', ) + obj_email = eZmaxApi.models.email_response_compound.email-ResponseCompound(), + obj_phone_fax = eZmaxApi.models.phone_response_compound.phone-ResponseCompound(), + obj_phone_sms = eZmaxApi.models.phone_response_compound.phone-ResponseCompound(), ) ], ), ) """ diff --git a/test/test_ezsignfolder_get_communicationsenders_v1_response_m_payload.py b/test/test_ezsignfolder_get_communicationsenders_v1_response_m_payload.py index 0abe6c863..b1e7d4856 100644 --- a/test/test_ezsignfolder_get_communicationsenders_v1_response_m_payload.py +++ b/test/test_ezsignfolder_get_communicationsenders_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignfolder_get_communicationsenders_v1_response_m_payload import EzsignfolderGetCommunicationsendersV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezsignfolder_get_communicationsenders_v1_response_m_payload import EzsignfolderGetCommunicationsendersV1ResponseMPayload class TestEzsignfolderGetCommunicationsendersV1ResponseMPayload(unittest.TestCase): """EzsignfolderGetCommunicationsendersV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignfolderGetCommunicationsenders optional params are included """ # uncomment below to create an instance of `EzsignfolderGetCommunicationsendersV1ResponseMPayload` """ - model = EzsignfolderGetCommunicationsendersV1ResponseMPayload() # noqa: E501 + model = EzsignfolderGetCommunicationsendersV1ResponseMPayload() if include_optional: return EzsignfolderGetCommunicationsendersV1ResponseMPayload( a_obj_communicationsenders = [ @@ -43,13 +43,15 @@ def make_instance(self, include_optional) -> EzsignfolderGetCommunicationsenders fki_broker_id = 26, fki_user_id = 70, fki_mailboxshared_id = 47, + fki_phonelineshared_id = 47, e_communicationsender_objecttype = 'User', obj_contact_name = eZmaxApi.models.custom_contact_name_response.Custom-ContactName-Response( s_contact_firstname = 'John', s_contact_lastname = 'Doe', s_contact_company = 'eZmax Solutions Inc.', ), - s_email_address = 'email@example.com', - s_phone_e164 = '+15149901516', ) + obj_email = eZmaxApi.models.email_response_compound.email-ResponseCompound(), + obj_phone_fax = eZmaxApi.models.phone_response_compound.phone-ResponseCompound(), + obj_phone_sms = eZmaxApi.models.phone_response_compound.phone-ResponseCompound(), ) ] ) else: @@ -60,13 +62,15 @@ def make_instance(self, include_optional) -> EzsignfolderGetCommunicationsenders fki_broker_id = 26, fki_user_id = 70, fki_mailboxshared_id = 47, + fki_phonelineshared_id = 47, e_communicationsender_objecttype = 'User', obj_contact_name = eZmaxApi.models.custom_contact_name_response.Custom-ContactName-Response( s_contact_firstname = 'John', s_contact_lastname = 'Doe', s_contact_company = 'eZmax Solutions Inc.', ), - s_email_address = 'email@example.com', - s_phone_e164 = '+15149901516', ) + obj_email = eZmaxApi.models.email_response_compound.email-ResponseCompound(), + obj_phone_fax = eZmaxApi.models.phone_response_compound.phone-ResponseCompound(), + obj_phone_sms = eZmaxApi.models.phone_response_compound.phone-ResponseCompound(), ) ], ) """ diff --git a/test/test_ezsignfolder_get_ezsigndocuments_v1_response.py b/test/test_ezsignfolder_get_ezsigndocuments_v1_response.py index 87638ca45..df868e984 100644 --- a/test/test_ezsignfolder_get_ezsigndocuments_v1_response.py +++ b/test/test_ezsignfolder_get_ezsigndocuments_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignfolder_get_ezsigndocuments_v1_response import EzsignfolderGetEzsigndocumentsV1Response # noqa: E501 +from eZmaxApi.models.ezsignfolder_get_ezsigndocuments_v1_response import EzsignfolderGetEzsigndocumentsV1Response class TestEzsignfolderGetEzsigndocumentsV1Response(unittest.TestCase): """EzsignfolderGetEzsigndocumentsV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignfolderGetEzsigndocumentsV1Res optional params are included """ # uncomment below to create an instance of `EzsignfolderGetEzsigndocumentsV1Response` """ - model = EzsignfolderGetEzsigndocumentsV1Response() # noqa: E501 + model = EzsignfolderGetEzsigndocumentsV1Response() if include_optional: return EzsignfolderGetEzsigndocumentsV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsignfolder_get_ezsigndocuments_v1_response_m_payload.py b/test/test_ezsignfolder_get_ezsigndocuments_v1_response_m_payload.py index ad56d5af1..f3d95660b 100644 --- a/test/test_ezsignfolder_get_ezsigndocuments_v1_response_m_payload.py +++ b/test/test_ezsignfolder_get_ezsigndocuments_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignfolder_get_ezsigndocuments_v1_response_m_payload import EzsignfolderGetEzsigndocumentsV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezsignfolder_get_ezsigndocuments_v1_response_m_payload import EzsignfolderGetEzsigndocumentsV1ResponseMPayload class TestEzsignfolderGetEzsigndocumentsV1ResponseMPayload(unittest.TestCase): """EzsignfolderGetEzsigndocumentsV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignfolderGetEzsigndocumentsV1Res optional params are included """ # uncomment below to create an instance of `EzsignfolderGetEzsigndocumentsV1ResponseMPayload` """ - model = EzsignfolderGetEzsigndocumentsV1ResponseMPayload() # noqa: E501 + model = EzsignfolderGetEzsigndocumentsV1ResponseMPayload() if include_optional: return EzsignfolderGetEzsigndocumentsV1ResponseMPayload( a_obj_ezsigndocument = [ diff --git a/test/test_ezsignfolder_get_ezsignfoldersignerassociations_v1_response.py b/test/test_ezsignfolder_get_ezsignfoldersignerassociations_v1_response.py index 31dc1448f..01ebe56e3 100644 --- a/test/test_ezsignfolder_get_ezsignfoldersignerassociations_v1_response.py +++ b/test/test_ezsignfolder_get_ezsignfoldersignerassociations_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignfolder_get_ezsignfoldersignerassociations_v1_response import EzsignfolderGetEzsignfoldersignerassociationsV1Response # noqa: E501 +from eZmaxApi.models.ezsignfolder_get_ezsignfoldersignerassociations_v1_response import EzsignfolderGetEzsignfoldersignerassociationsV1Response class TestEzsignfolderGetEzsignfoldersignerassociationsV1Response(unittest.TestCase): """EzsignfolderGetEzsignfoldersignerassociationsV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignfolderGetEzsignfoldersigneras optional params are included """ # uncomment below to create an instance of `EzsignfolderGetEzsignfoldersignerassociationsV1Response` """ - model = EzsignfolderGetEzsignfoldersignerassociationsV1Response() # noqa: E501 + model = EzsignfolderGetEzsignfoldersignerassociationsV1Response() if include_optional: return EzsignfolderGetEzsignfoldersignerassociationsV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsignfolder_get_ezsignfoldersignerassociations_v1_response_m_payload.py b/test/test_ezsignfolder_get_ezsignfoldersignerassociations_v1_response_m_payload.py index a07a420d9..4563fc391 100644 --- a/test/test_ezsignfolder_get_ezsignfoldersignerassociations_v1_response_m_payload.py +++ b/test/test_ezsignfolder_get_ezsignfoldersignerassociations_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignfolder_get_ezsignfoldersignerassociations_v1_response_m_payload import EzsignfolderGetEzsignfoldersignerassociationsV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezsignfolder_get_ezsignfoldersignerassociations_v1_response_m_payload import EzsignfolderGetEzsignfoldersignerassociationsV1ResponseMPayload class TestEzsignfolderGetEzsignfoldersignerassociationsV1ResponseMPayload(unittest.TestCase): """EzsignfolderGetEzsignfoldersignerassociationsV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignfolderGetEzsignfoldersigneras optional params are included """ # uncomment below to create an instance of `EzsignfolderGetEzsignfoldersignerassociationsV1ResponseMPayload` """ - model = EzsignfolderGetEzsignfoldersignerassociationsV1ResponseMPayload() # noqa: E501 + model = EzsignfolderGetEzsignfoldersignerassociationsV1ResponseMPayload() if include_optional: return EzsignfolderGetEzsignfoldersignerassociationsV1ResponseMPayload( a_obj_ezsignfoldersignerassociation = [ diff --git a/test/test_ezsignfolder_get_ezsignsignatures_automatic_v1_response.py b/test/test_ezsignfolder_get_ezsignsignatures_automatic_v1_response.py index 9566d6e85..63c7b3d8f 100644 --- a/test/test_ezsignfolder_get_ezsignsignatures_automatic_v1_response.py +++ b/test/test_ezsignfolder_get_ezsignsignatures_automatic_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignfolder_get_ezsignsignatures_automatic_v1_response import EzsignfolderGetEzsignsignaturesAutomaticV1Response # noqa: E501 +from eZmaxApi.models.ezsignfolder_get_ezsignsignatures_automatic_v1_response import EzsignfolderGetEzsignsignaturesAutomaticV1Response class TestEzsignfolderGetEzsignsignaturesAutomaticV1Response(unittest.TestCase): """EzsignfolderGetEzsignsignaturesAutomaticV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignfolderGetEzsignsignaturesAuto optional params are included """ # uncomment below to create an instance of `EzsignfolderGetEzsignsignaturesAutomaticV1Response` """ - model = EzsignfolderGetEzsignsignaturesAutomaticV1Response() # noqa: E501 + model = EzsignfolderGetEzsignsignaturesAutomaticV1Response() if include_optional: return EzsignfolderGetEzsignsignaturesAutomaticV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsignfolder_get_ezsignsignatures_automatic_v1_response_m_payload.py b/test/test_ezsignfolder_get_ezsignsignatures_automatic_v1_response_m_payload.py index 7ffbf428f..8318bf2d9 100644 --- a/test/test_ezsignfolder_get_ezsignsignatures_automatic_v1_response_m_payload.py +++ b/test/test_ezsignfolder_get_ezsignsignatures_automatic_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignfolder_get_ezsignsignatures_automatic_v1_response_m_payload import EzsignfolderGetEzsignsignaturesAutomaticV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezsignfolder_get_ezsignsignatures_automatic_v1_response_m_payload import EzsignfolderGetEzsignsignaturesAutomaticV1ResponseMPayload class TestEzsignfolderGetEzsignsignaturesAutomaticV1ResponseMPayload(unittest.TestCase): """EzsignfolderGetEzsignsignaturesAutomaticV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignfolderGetEzsignsignaturesAuto optional params are included """ # uncomment below to create an instance of `EzsignfolderGetEzsignsignaturesAutomaticV1ResponseMPayload` """ - model = EzsignfolderGetEzsignsignaturesAutomaticV1ResponseMPayload() # noqa: E501 + model = EzsignfolderGetEzsignsignaturesAutomaticV1ResponseMPayload() if include_optional: return EzsignfolderGetEzsignsignaturesAutomaticV1ResponseMPayload( a_e_ezsignsignature_type = [ diff --git a/test/test_ezsignfolder_get_forms_data_v1_response.py b/test/test_ezsignfolder_get_forms_data_v1_response.py index 91a6556d8..9f92273c8 100644 --- a/test/test_ezsignfolder_get_forms_data_v1_response.py +++ b/test/test_ezsignfolder_get_forms_data_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignfolder_get_forms_data_v1_response import EzsignfolderGetFormsDataV1Response # noqa: E501 +from eZmaxApi.models.ezsignfolder_get_forms_data_v1_response import EzsignfolderGetFormsDataV1Response class TestEzsignfolderGetFormsDataV1Response(unittest.TestCase): """EzsignfolderGetFormsDataV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignfolderGetFormsDataV1Response: optional params are included """ # uncomment below to create an instance of `EzsignfolderGetFormsDataV1Response` """ - model = EzsignfolderGetFormsDataV1Response() # noqa: E501 + model = EzsignfolderGetFormsDataV1Response() if include_optional: return EzsignfolderGetFormsDataV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsignfolder_get_forms_data_v1_response_m_payload.py b/test/test_ezsignfolder_get_forms_data_v1_response_m_payload.py index 9ae6278c3..32596c2c7 100644 --- a/test/test_ezsignfolder_get_forms_data_v1_response_m_payload.py +++ b/test/test_ezsignfolder_get_forms_data_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignfolder_get_forms_data_v1_response_m_payload import EzsignfolderGetFormsDataV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezsignfolder_get_forms_data_v1_response_m_payload import EzsignfolderGetFormsDataV1ResponseMPayload class TestEzsignfolderGetFormsDataV1ResponseMPayload(unittest.TestCase): """EzsignfolderGetFormsDataV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignfolderGetFormsDataV1ResponseM optional params are included """ # uncomment below to create an instance of `EzsignfolderGetFormsDataV1ResponseMPayload` """ - model = EzsignfolderGetFormsDataV1ResponseMPayload() # noqa: E501 + model = EzsignfolderGetFormsDataV1ResponseMPayload() if include_optional: return EzsignfolderGetFormsDataV1ResponseMPayload( obj_forms_data_folder = eZmaxApi.models.custom_forms_data_folder_response.Custom-FormsDataFolder-Response( diff --git a/test/test_ezsignfolder_get_list_v1_response.py b/test/test_ezsignfolder_get_list_v1_response.py index c8545a30c..8c0d7f9de 100644 --- a/test/test_ezsignfolder_get_list_v1_response.py +++ b/test/test_ezsignfolder_get_list_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignfolder_get_list_v1_response import EzsignfolderGetListV1Response # noqa: E501 +from eZmaxApi.models.ezsignfolder_get_list_v1_response import EzsignfolderGetListV1Response class TestEzsignfolderGetListV1Response(unittest.TestCase): """EzsignfolderGetListV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignfolderGetListV1Response: optional params are included """ # uncomment below to create an instance of `EzsignfolderGetListV1Response` """ - model = EzsignfolderGetListV1Response() # noqa: E501 + model = EzsignfolderGetListV1Response() if include_optional: return EzsignfolderGetListV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload_get_list.Common-Response-objDebugPayload_getList(), diff --git a/test/test_ezsignfolder_get_list_v1_response_m_payload.py b/test/test_ezsignfolder_get_list_v1_response_m_payload.py index bf9f134ad..a15a6a235 100644 --- a/test/test_ezsignfolder_get_list_v1_response_m_payload.py +++ b/test/test_ezsignfolder_get_list_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignfolder_get_list_v1_response_m_payload import EzsignfolderGetListV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezsignfolder_get_list_v1_response_m_payload import EzsignfolderGetListV1ResponseMPayload class TestEzsignfolderGetListV1ResponseMPayload(unittest.TestCase): """EzsignfolderGetListV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignfolderGetListV1ResponseMPaylo optional params are included """ # uncomment below to create an instance of `EzsignfolderGetListV1ResponseMPayload` """ - model = EzsignfolderGetListV1ResponseMPayload() # noqa: E501 + model = EzsignfolderGetListV1ResponseMPayload() if include_optional: return EzsignfolderGetListV1ResponseMPayload( i_row_returned = 100, diff --git a/test/test_ezsignfolder_get_object_v1_response.py b/test/test_ezsignfolder_get_object_v1_response.py index 949ec5a5f..cf447594a 100644 --- a/test/test_ezsignfolder_get_object_v1_response.py +++ b/test/test_ezsignfolder_get_object_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignfolder_get_object_v1_response import EzsignfolderGetObjectV1Response # noqa: E501 +from eZmaxApi.models.ezsignfolder_get_object_v1_response import EzsignfolderGetObjectV1Response class TestEzsignfolderGetObjectV1Response(unittest.TestCase): """EzsignfolderGetObjectV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignfolderGetObjectV1Response: optional params are included """ # uncomment below to create an instance of `EzsignfolderGetObjectV1Response` """ - model = EzsignfolderGetObjectV1Response() # noqa: E501 + model = EzsignfolderGetObjectV1Response() if include_optional: return EzsignfolderGetObjectV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsignfolder_get_object_v1_response_m_payload.py b/test/test_ezsignfolder_get_object_v1_response_m_payload.py index 6ee6e9494..26cc13bad 100644 --- a/test/test_ezsignfolder_get_object_v1_response_m_payload.py +++ b/test/test_ezsignfolder_get_object_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignfolder_get_object_v1_response_m_payload import EzsignfolderGetObjectV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezsignfolder_get_object_v1_response_m_payload import EzsignfolderGetObjectV1ResponseMPayload class TestEzsignfolderGetObjectV1ResponseMPayload(unittest.TestCase): """EzsignfolderGetObjectV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignfolderGetObjectV1ResponseMPay optional params are included """ # uncomment below to create an instance of `EzsignfolderGetObjectV1ResponseMPayload` """ - model = EzsignfolderGetObjectV1ResponseMPayload() # noqa: E501 + model = EzsignfolderGetObjectV1ResponseMPayload() if include_optional: return EzsignfolderGetObjectV1ResponseMPayload( pki_ezsignfolder_id = 33, diff --git a/test/test_ezsignfolder_get_object_v2_response.py b/test/test_ezsignfolder_get_object_v2_response.py index dba606aff..1e83e5696 100644 --- a/test/test_ezsignfolder_get_object_v2_response.py +++ b/test/test_ezsignfolder_get_object_v2_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignfolder_get_object_v2_response import EzsignfolderGetObjectV2Response # noqa: E501 +from eZmaxApi.models.ezsignfolder_get_object_v2_response import EzsignfolderGetObjectV2Response class TestEzsignfolderGetObjectV2Response(unittest.TestCase): """EzsignfolderGetObjectV2Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignfolderGetObjectV2Response: optional params are included """ # uncomment below to create an instance of `EzsignfolderGetObjectV2Response` """ - model = EzsignfolderGetObjectV2Response() # noqa: E501 + model = EzsignfolderGetObjectV2Response() if include_optional: return EzsignfolderGetObjectV2Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsignfolder_get_object_v2_response_m_payload.py b/test/test_ezsignfolder_get_object_v2_response_m_payload.py index a954194c4..77859f21b 100644 --- a/test/test_ezsignfolder_get_object_v2_response_m_payload.py +++ b/test/test_ezsignfolder_get_object_v2_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignfolder_get_object_v2_response_m_payload import EzsignfolderGetObjectV2ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezsignfolder_get_object_v2_response_m_payload import EzsignfolderGetObjectV2ResponseMPayload class TestEzsignfolderGetObjectV2ResponseMPayload(unittest.TestCase): """EzsignfolderGetObjectV2ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignfolderGetObjectV2ResponseMPay optional params are included """ # uncomment below to create an instance of `EzsignfolderGetObjectV2ResponseMPayload` """ - model = EzsignfolderGetObjectV2ResponseMPayload() # noqa: E501 + model = EzsignfolderGetObjectV2ResponseMPayload() if include_optional: return EzsignfolderGetObjectV2ResponseMPayload( obj_ezsignfolder = eZmaxApi.models.ezsignfolder_response_compound.ezsignfolder-ResponseCompound() diff --git a/test/test_ezsignfolder_import_ezsignfoldersignerassociations_v1_request.py b/test/test_ezsignfolder_import_ezsignfoldersignerassociations_v1_request.py index c69d5d476..dfff4e508 100644 --- a/test/test_ezsignfolder_import_ezsignfoldersignerassociations_v1_request.py +++ b/test/test_ezsignfolder_import_ezsignfoldersignerassociations_v1_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignfolder_import_ezsignfoldersignerassociations_v1_request import EzsignfolderImportEzsignfoldersignerassociationsV1Request # noqa: E501 +from eZmaxApi.models.ezsignfolder_import_ezsignfoldersignerassociations_v1_request import EzsignfolderImportEzsignfoldersignerassociationsV1Request class TestEzsignfolderImportEzsignfoldersignerassociationsV1Request(unittest.TestCase): """EzsignfolderImportEzsignfoldersignerassociationsV1Request unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignfolderImportEzsignfoldersigne optional params are included """ # uncomment below to create an instance of `EzsignfolderImportEzsignfoldersignerassociationsV1Request` """ - model = EzsignfolderImportEzsignfoldersignerassociationsV1Request() # noqa: E501 + model = EzsignfolderImportEzsignfoldersignerassociationsV1Request() if include_optional: return EzsignfolderImportEzsignfoldersignerassociationsV1Request( a_fki_ezsignfoldersignerassociation_id = [ diff --git a/test/test_ezsignfolder_import_ezsignfoldersignerassociations_v1_response.py b/test/test_ezsignfolder_import_ezsignfoldersignerassociations_v1_response.py index 8d6ad455b..7008aedaf 100644 --- a/test/test_ezsignfolder_import_ezsignfoldersignerassociations_v1_response.py +++ b/test/test_ezsignfolder_import_ezsignfoldersignerassociations_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignfolder_import_ezsignfoldersignerassociations_v1_response import EzsignfolderImportEzsignfoldersignerassociationsV1Response # noqa: E501 +from eZmaxApi.models.ezsignfolder_import_ezsignfoldersignerassociations_v1_response import EzsignfolderImportEzsignfoldersignerassociationsV1Response class TestEzsignfolderImportEzsignfoldersignerassociationsV1Response(unittest.TestCase): """EzsignfolderImportEzsignfoldersignerassociationsV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignfolderImportEzsignfoldersigne optional params are included """ # uncomment below to create an instance of `EzsignfolderImportEzsignfoldersignerassociationsV1Response` """ - model = EzsignfolderImportEzsignfoldersignerassociationsV1Response() # noqa: E501 + model = EzsignfolderImportEzsignfoldersignerassociationsV1Response() if include_optional: return EzsignfolderImportEzsignfoldersignerassociationsV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsignfolder_import_ezsignfoldersignerassociations_v1_response_m_payload.py b/test/test_ezsignfolder_import_ezsignfoldersignerassociations_v1_response_m_payload.py index d9f885b88..a44661c52 100644 --- a/test/test_ezsignfolder_import_ezsignfoldersignerassociations_v1_response_m_payload.py +++ b/test/test_ezsignfolder_import_ezsignfoldersignerassociations_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignfolder_import_ezsignfoldersignerassociations_v1_response_m_payload import EzsignfolderImportEzsignfoldersignerassociationsV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezsignfolder_import_ezsignfoldersignerassociations_v1_response_m_payload import EzsignfolderImportEzsignfoldersignerassociationsV1ResponseMPayload class TestEzsignfolderImportEzsignfoldersignerassociationsV1ResponseMPayload(unittest.TestCase): """EzsignfolderImportEzsignfoldersignerassociationsV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignfolderImportEzsignfoldersigne optional params are included """ # uncomment below to create an instance of `EzsignfolderImportEzsignfoldersignerassociationsV1ResponseMPayload` """ - model = EzsignfolderImportEzsignfoldersignerassociationsV1ResponseMPayload() # noqa: E501 + model = EzsignfolderImportEzsignfoldersignerassociationsV1ResponseMPayload() if include_optional: return EzsignfolderImportEzsignfoldersignerassociationsV1ResponseMPayload( a_pki_ezsignfoldersignerassociation_id = [ diff --git a/test/test_ezsignfolder_import_ezsigntemplatepackage_v1_request.py b/test/test_ezsignfolder_import_ezsigntemplatepackage_v1_request.py index 33118a523..ed909fd74 100644 --- a/test/test_ezsignfolder_import_ezsigntemplatepackage_v1_request.py +++ b/test/test_ezsignfolder_import_ezsigntemplatepackage_v1_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignfolder_import_ezsigntemplatepackage_v1_request import EzsignfolderImportEzsigntemplatepackageV1Request # noqa: E501 +from eZmaxApi.models.ezsignfolder_import_ezsigntemplatepackage_v1_request import EzsignfolderImportEzsigntemplatepackageV1Request class TestEzsignfolderImportEzsigntemplatepackageV1Request(unittest.TestCase): """EzsignfolderImportEzsigntemplatepackageV1Request unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignfolderImportEzsigntemplatepac optional params are included """ # uncomment below to create an instance of `EzsignfolderImportEzsigntemplatepackageV1Request` """ - model = EzsignfolderImportEzsigntemplatepackageV1Request() # noqa: E501 + model = EzsignfolderImportEzsigntemplatepackageV1Request() if include_optional: return EzsignfolderImportEzsigntemplatepackageV1Request( fki_ezsigntemplatepackage_id = 99, diff --git a/test/test_ezsignfolder_import_ezsigntemplatepackage_v1_response.py b/test/test_ezsignfolder_import_ezsigntemplatepackage_v1_response.py index 537f19fec..d16818357 100644 --- a/test/test_ezsignfolder_import_ezsigntemplatepackage_v1_response.py +++ b/test/test_ezsignfolder_import_ezsigntemplatepackage_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignfolder_import_ezsigntemplatepackage_v1_response import EzsignfolderImportEzsigntemplatepackageV1Response # noqa: E501 +from eZmaxApi.models.ezsignfolder_import_ezsigntemplatepackage_v1_response import EzsignfolderImportEzsigntemplatepackageV1Response class TestEzsignfolderImportEzsigntemplatepackageV1Response(unittest.TestCase): """EzsignfolderImportEzsigntemplatepackageV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignfolderImportEzsigntemplatepac optional params are included """ # uncomment below to create an instance of `EzsignfolderImportEzsigntemplatepackageV1Response` """ - model = EzsignfolderImportEzsigntemplatepackageV1Response() # noqa: E501 + model = EzsignfolderImportEzsigntemplatepackageV1Response() if include_optional: return EzsignfolderImportEzsigntemplatepackageV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsignfolder_import_ezsigntemplatepackage_v1_response_m_payload.py b/test/test_ezsignfolder_import_ezsigntemplatepackage_v1_response_m_payload.py index d73e84d8f..7d88f8688 100644 --- a/test/test_ezsignfolder_import_ezsigntemplatepackage_v1_response_m_payload.py +++ b/test/test_ezsignfolder_import_ezsigntemplatepackage_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignfolder_import_ezsigntemplatepackage_v1_response_m_payload import EzsignfolderImportEzsigntemplatepackageV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezsignfolder_import_ezsigntemplatepackage_v1_response_m_payload import EzsignfolderImportEzsigntemplatepackageV1ResponseMPayload class TestEzsignfolderImportEzsigntemplatepackageV1ResponseMPayload(unittest.TestCase): """EzsignfolderImportEzsigntemplatepackageV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignfolderImportEzsigntemplatepac optional params are included """ # uncomment below to create an instance of `EzsignfolderImportEzsigntemplatepackageV1ResponseMPayload` """ - model = EzsignfolderImportEzsigntemplatepackageV1ResponseMPayload() # noqa: E501 + model = EzsignfolderImportEzsigntemplatepackageV1ResponseMPayload() if include_optional: return EzsignfolderImportEzsigntemplatepackageV1ResponseMPayload( a_obj_ezsigndocument = [ diff --git a/test/test_ezsignfolder_list_element.py b/test/test_ezsignfolder_list_element.py index 9091ed744..e2832a53b 100644 --- a/test/test_ezsignfolder_list_element.py +++ b/test/test_ezsignfolder_list_element.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignfolder_list_element import EzsignfolderListElement # noqa: E501 +from eZmaxApi.models.ezsignfolder_list_element import EzsignfolderListElement class TestEzsignfolderListElement(unittest.TestCase): """EzsignfolderListElement unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignfolderListElement: optional params are included """ # uncomment below to create an instance of `EzsignfolderListElement` """ - model = EzsignfolderListElement() # noqa: E501 + model = EzsignfolderListElement() if include_optional: return EzsignfolderListElement( pki_ezsignfolder_id = 33, diff --git a/test/test_ezsignfolder_reorder_v1_request.py b/test/test_ezsignfolder_reorder_v1_request.py index cfd76ccf1..1cd270a0c 100644 --- a/test/test_ezsignfolder_reorder_v1_request.py +++ b/test/test_ezsignfolder_reorder_v1_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignfolder_reorder_v1_request import EzsignfolderReorderV1Request # noqa: E501 +from eZmaxApi.models.ezsignfolder_reorder_v1_request import EzsignfolderReorderV1Request class TestEzsignfolderReorderV1Request(unittest.TestCase): """EzsignfolderReorderV1Request unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignfolderReorderV1Request: optional params are included """ # uncomment below to create an instance of `EzsignfolderReorderV1Request` """ - model = EzsignfolderReorderV1Request() # noqa: E501 + model = EzsignfolderReorderV1Request() if include_optional: return EzsignfolderReorderV1Request( a_pki_ezsigndocument_id = [ diff --git a/test/test_ezsignfolder_reorder_v1_response.py b/test/test_ezsignfolder_reorder_v1_response.py index b076d986f..83988d1ca 100644 --- a/test/test_ezsignfolder_reorder_v1_response.py +++ b/test/test_ezsignfolder_reorder_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignfolder_reorder_v1_response import EzsignfolderReorderV1Response # noqa: E501 +from eZmaxApi.models.ezsignfolder_reorder_v1_response import EzsignfolderReorderV1Response class TestEzsignfolderReorderV1Response(unittest.TestCase): """EzsignfolderReorderV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignfolderReorderV1Response: optional params are included """ # uncomment below to create an instance of `EzsignfolderReorderV1Response` """ - model = EzsignfolderReorderV1Response() # noqa: E501 + model = EzsignfolderReorderV1Response() if include_optional: return EzsignfolderReorderV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsignfolder_request.py b/test/test_ezsignfolder_request.py index 4c68e20e9..3a3a8e05d 100644 --- a/test/test_ezsignfolder_request.py +++ b/test/test_ezsignfolder_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignfolder_request import EzsignfolderRequest # noqa: E501 +from eZmaxApi.models.ezsignfolder_request import EzsignfolderRequest class TestEzsignfolderRequest(unittest.TestCase): """EzsignfolderRequest unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignfolderRequest: optional params are included """ # uncomment below to create an instance of `EzsignfolderRequest` """ - model = EzsignfolderRequest() # noqa: E501 + model = EzsignfolderRequest() if include_optional: return EzsignfolderRequest( pki_ezsignfolder_id = 33, diff --git a/test/test_ezsignfolder_request_compound.py b/test/test_ezsignfolder_request_compound.py index 33ab91f93..421e91d9a 100644 --- a/test/test_ezsignfolder_request_compound.py +++ b/test/test_ezsignfolder_request_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignfolder_request_compound import EzsignfolderRequestCompound # noqa: E501 +from eZmaxApi.models.ezsignfolder_request_compound import EzsignfolderRequestCompound class TestEzsignfolderRequestCompound(unittest.TestCase): """EzsignfolderRequestCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignfolderRequestCompound: optional params are included """ # uncomment below to create an instance of `EzsignfolderRequestCompound` """ - model = EzsignfolderRequestCompound() # noqa: E501 + model = EzsignfolderRequestCompound() if include_optional: return EzsignfolderRequestCompound( pki_ezsignfolder_id = 33, diff --git a/test/test_ezsignfolder_response.py b/test/test_ezsignfolder_response.py index 22f200f15..7afcf842a 100644 --- a/test/test_ezsignfolder_response.py +++ b/test/test_ezsignfolder_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignfolder_response import EzsignfolderResponse # noqa: E501 +from eZmaxApi.models.ezsignfolder_response import EzsignfolderResponse class TestEzsignfolderResponse(unittest.TestCase): """EzsignfolderResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignfolderResponse: optional params are included """ # uncomment below to create an instance of `EzsignfolderResponse` """ - model = EzsignfolderResponse() # noqa: E501 + model = EzsignfolderResponse() if include_optional: return EzsignfolderResponse( pki_ezsignfolder_id = 33, diff --git a/test/test_ezsignfolder_response_compound.py b/test/test_ezsignfolder_response_compound.py index 178ef7fd8..bb03e5611 100644 --- a/test/test_ezsignfolder_response_compound.py +++ b/test/test_ezsignfolder_response_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignfolder_response_compound import EzsignfolderResponseCompound # noqa: E501 +from eZmaxApi.models.ezsignfolder_response_compound import EzsignfolderResponseCompound class TestEzsignfolderResponseCompound(unittest.TestCase): """EzsignfolderResponseCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignfolderResponseCompound: optional params are included """ # uncomment below to create an instance of `EzsignfolderResponseCompound` """ - model = EzsignfolderResponseCompound() # noqa: E501 + model = EzsignfolderResponseCompound() if include_optional: return EzsignfolderResponseCompound( pki_ezsignfolder_id = 33, diff --git a/test/test_ezsignfolder_send_v1_request.py b/test/test_ezsignfolder_send_v1_request.py index dc42c7df7..2480209ba 100644 --- a/test/test_ezsignfolder_send_v1_request.py +++ b/test/test_ezsignfolder_send_v1_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignfolder_send_v1_request import EzsignfolderSendV1Request # noqa: E501 +from eZmaxApi.models.ezsignfolder_send_v1_request import EzsignfolderSendV1Request class TestEzsignfolderSendV1Request(unittest.TestCase): """EzsignfolderSendV1Request unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignfolderSendV1Request: optional params are included """ # uncomment below to create an instance of `EzsignfolderSendV1Request` """ - model = EzsignfolderSendV1Request() # noqa: E501 + model = EzsignfolderSendV1Request() if include_optional: return EzsignfolderSendV1Request( t_extra_message = 'Hi John, diff --git a/test/test_ezsignfolder_send_v1_response.py b/test/test_ezsignfolder_send_v1_response.py index 8e2704190..326a6368a 100644 --- a/test/test_ezsignfolder_send_v1_response.py +++ b/test/test_ezsignfolder_send_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignfolder_send_v1_response import EzsignfolderSendV1Response # noqa: E501 +from eZmaxApi.models.ezsignfolder_send_v1_response import EzsignfolderSendV1Response class TestEzsignfolderSendV1Response(unittest.TestCase): """EzsignfolderSendV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignfolderSendV1Response: optional params are included """ # uncomment below to create an instance of `EzsignfolderSendV1Response` """ - model = EzsignfolderSendV1Response() # noqa: E501 + model = EzsignfolderSendV1Response() if include_optional: return EzsignfolderSendV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsignfolder_send_v2_request.py b/test/test_ezsignfolder_send_v2_request.py index 4643bec9e..0a2ec0ca7 100644 --- a/test/test_ezsignfolder_send_v2_request.py +++ b/test/test_ezsignfolder_send_v2_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignfolder_send_v2_request import EzsignfolderSendV2Request # noqa: E501 +from eZmaxApi.models.ezsignfolder_send_v2_request import EzsignfolderSendV2Request class TestEzsignfolderSendV2Request(unittest.TestCase): """EzsignfolderSendV2Request unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignfolderSendV2Request: optional params are included """ # uncomment below to create an instance of `EzsignfolderSendV2Request` """ - model = EzsignfolderSendV2Request() # noqa: E501 + model = EzsignfolderSendV2Request() if include_optional: return EzsignfolderSendV2Request( t_ezsignfolder_message = 'Hi everyone, diff --git a/test/test_ezsignfolder_send_v2_response.py b/test/test_ezsignfolder_send_v2_response.py index bf6e00c10..d807e465f 100644 --- a/test/test_ezsignfolder_send_v2_response.py +++ b/test/test_ezsignfolder_send_v2_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignfolder_send_v2_response import EzsignfolderSendV2Response # noqa: E501 +from eZmaxApi.models.ezsignfolder_send_v2_response import EzsignfolderSendV2Response class TestEzsignfolderSendV2Response(unittest.TestCase): """EzsignfolderSendV2Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignfolderSendV2Response: optional params are included """ # uncomment below to create an instance of `EzsignfolderSendV2Response` """ - model = EzsignfolderSendV2Response() # noqa: E501 + model = EzsignfolderSendV2Response() if include_optional: return EzsignfolderSendV2Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsignfolder_send_v3_request.py b/test/test_ezsignfolder_send_v3_request.py index 8b04b7d83..e2efb0eca 100644 --- a/test/test_ezsignfolder_send_v3_request.py +++ b/test/test_ezsignfolder_send_v3_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignfolder_send_v3_request import EzsignfolderSendV3Request # noqa: E501 +from eZmaxApi.models.ezsignfolder_send_v3_request import EzsignfolderSendV3Request class TestEzsignfolderSendV3Request(unittest.TestCase): """EzsignfolderSendV3Request unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignfolderSendV3Request: optional params are included """ # uncomment below to create an instance of `EzsignfolderSendV3Request` """ - model = EzsignfolderSendV3Request() # noqa: E501 + model = EzsignfolderSendV3Request() if include_optional: return EzsignfolderSendV3Request( t_ezsignfolder_message = 'Hi everyone, diff --git a/test/test_ezsignfolder_send_v3_response.py b/test/test_ezsignfolder_send_v3_response.py index 4f8d0b4d7..62c2b28df 100644 --- a/test/test_ezsignfolder_send_v3_response.py +++ b/test/test_ezsignfolder_send_v3_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignfolder_send_v3_response import EzsignfolderSendV3Response # noqa: E501 +from eZmaxApi.models.ezsignfolder_send_v3_response import EzsignfolderSendV3Response class TestEzsignfolderSendV3Response(unittest.TestCase): """EzsignfolderSendV3Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignfolderSendV3Response: optional params are included """ # uncomment below to create an instance of `EzsignfolderSendV3Response` """ - model = EzsignfolderSendV3Response() # noqa: E501 + model = EzsignfolderSendV3Response() if include_optional: return EzsignfolderSendV3Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsignfolder_unsend_v1_response.py b/test/test_ezsignfolder_unsend_v1_response.py index 1c54ba4b2..8c1981b10 100644 --- a/test/test_ezsignfolder_unsend_v1_response.py +++ b/test/test_ezsignfolder_unsend_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignfolder_unsend_v1_response import EzsignfolderUnsendV1Response # noqa: E501 +from eZmaxApi.models.ezsignfolder_unsend_v1_response import EzsignfolderUnsendV1Response class TestEzsignfolderUnsendV1Response(unittest.TestCase): """EzsignfolderUnsendV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignfolderUnsendV1Response: optional params are included """ # uncomment below to create an instance of `EzsignfolderUnsendV1Response` """ - model = EzsignfolderUnsendV1Response() # noqa: E501 + model = EzsignfolderUnsendV1Response() if include_optional: return EzsignfolderUnsendV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsignfoldersignerassociation_create_object_v1_request.py b/test/test_ezsignfoldersignerassociation_create_object_v1_request.py index 716d48e11..36d962725 100644 --- a/test/test_ezsignfoldersignerassociation_create_object_v1_request.py +++ b/test/test_ezsignfoldersignerassociation_create_object_v1_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignfoldersignerassociation_create_object_v1_request import EzsignfoldersignerassociationCreateObjectV1Request # noqa: E501 +from eZmaxApi.models.ezsignfoldersignerassociation_create_object_v1_request import EzsignfoldersignerassociationCreateObjectV1Request class TestEzsignfoldersignerassociationCreateObjectV1Request(unittest.TestCase): """EzsignfoldersignerassociationCreateObjectV1Request unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignfoldersignerassociationCreate optional params are included """ # uncomment below to create an instance of `EzsignfoldersignerassociationCreateObjectV1Request` """ - model = EzsignfoldersignerassociationCreateObjectV1Request() # noqa: E501 + model = EzsignfoldersignerassociationCreateObjectV1Request() if include_optional: return EzsignfoldersignerassociationCreateObjectV1Request( obj_ezsignfoldersignerassociation = eZmaxApi.models.ezsignfoldersignerassociation_request.ezsignfoldersignerassociation-Request( diff --git a/test/test_ezsignfoldersignerassociation_create_object_v1_response.py b/test/test_ezsignfoldersignerassociation_create_object_v1_response.py index e2285ab34..3ce80d468 100644 --- a/test/test_ezsignfoldersignerassociation_create_object_v1_response.py +++ b/test/test_ezsignfoldersignerassociation_create_object_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignfoldersignerassociation_create_object_v1_response import EzsignfoldersignerassociationCreateObjectV1Response # noqa: E501 +from eZmaxApi.models.ezsignfoldersignerassociation_create_object_v1_response import EzsignfoldersignerassociationCreateObjectV1Response class TestEzsignfoldersignerassociationCreateObjectV1Response(unittest.TestCase): """EzsignfoldersignerassociationCreateObjectV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignfoldersignerassociationCreate optional params are included """ # uncomment below to create an instance of `EzsignfoldersignerassociationCreateObjectV1Response` """ - model = EzsignfoldersignerassociationCreateObjectV1Response() # noqa: E501 + model = EzsignfoldersignerassociationCreateObjectV1Response() if include_optional: return EzsignfoldersignerassociationCreateObjectV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsignfoldersignerassociation_create_object_v1_response_m_payload.py b/test/test_ezsignfoldersignerassociation_create_object_v1_response_m_payload.py index 57ae3afab..02fd86595 100644 --- a/test/test_ezsignfoldersignerassociation_create_object_v1_response_m_payload.py +++ b/test/test_ezsignfoldersignerassociation_create_object_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignfoldersignerassociation_create_object_v1_response_m_payload import EzsignfoldersignerassociationCreateObjectV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezsignfoldersignerassociation_create_object_v1_response_m_payload import EzsignfoldersignerassociationCreateObjectV1ResponseMPayload class TestEzsignfoldersignerassociationCreateObjectV1ResponseMPayload(unittest.TestCase): """EzsignfoldersignerassociationCreateObjectV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignfoldersignerassociationCreate optional params are included """ # uncomment below to create an instance of `EzsignfoldersignerassociationCreateObjectV1ResponseMPayload` """ - model = EzsignfoldersignerassociationCreateObjectV1ResponseMPayload() # noqa: E501 + model = EzsignfoldersignerassociationCreateObjectV1ResponseMPayload() if include_optional: return EzsignfoldersignerassociationCreateObjectV1ResponseMPayload( a_pki_ezsignfoldersignerassociation_id = [ diff --git a/test/test_ezsignfoldersignerassociation_create_object_v2_request.py b/test/test_ezsignfoldersignerassociation_create_object_v2_request.py index 7a9427491..85aa8df6f 100644 --- a/test/test_ezsignfoldersignerassociation_create_object_v2_request.py +++ b/test/test_ezsignfoldersignerassociation_create_object_v2_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignfoldersignerassociation_create_object_v2_request import EzsignfoldersignerassociationCreateObjectV2Request # noqa: E501 +from eZmaxApi.models.ezsignfoldersignerassociation_create_object_v2_request import EzsignfoldersignerassociationCreateObjectV2Request class TestEzsignfoldersignerassociationCreateObjectV2Request(unittest.TestCase): """EzsignfoldersignerassociationCreateObjectV2Request unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignfoldersignerassociationCreate optional params are included """ # uncomment below to create an instance of `EzsignfoldersignerassociationCreateObjectV2Request` """ - model = EzsignfoldersignerassociationCreateObjectV2Request() # noqa: E501 + model = EzsignfoldersignerassociationCreateObjectV2Request() if include_optional: return EzsignfoldersignerassociationCreateObjectV2Request( a_obj_ezsignfoldersignerassociation = [ diff --git a/test/test_ezsignfoldersignerassociation_create_object_v2_response.py b/test/test_ezsignfoldersignerassociation_create_object_v2_response.py index f1f23dad1..0301631ca 100644 --- a/test/test_ezsignfoldersignerassociation_create_object_v2_response.py +++ b/test/test_ezsignfoldersignerassociation_create_object_v2_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignfoldersignerassociation_create_object_v2_response import EzsignfoldersignerassociationCreateObjectV2Response # noqa: E501 +from eZmaxApi.models.ezsignfoldersignerassociation_create_object_v2_response import EzsignfoldersignerassociationCreateObjectV2Response class TestEzsignfoldersignerassociationCreateObjectV2Response(unittest.TestCase): """EzsignfoldersignerassociationCreateObjectV2Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignfoldersignerassociationCreate optional params are included """ # uncomment below to create an instance of `EzsignfoldersignerassociationCreateObjectV2Response` """ - model = EzsignfoldersignerassociationCreateObjectV2Response() # noqa: E501 + model = EzsignfoldersignerassociationCreateObjectV2Response() if include_optional: return EzsignfoldersignerassociationCreateObjectV2Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsignfoldersignerassociation_create_object_v2_response_m_payload.py b/test/test_ezsignfoldersignerassociation_create_object_v2_response_m_payload.py index f9e5715d9..d363840a2 100644 --- a/test/test_ezsignfoldersignerassociation_create_object_v2_response_m_payload.py +++ b/test/test_ezsignfoldersignerassociation_create_object_v2_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignfoldersignerassociation_create_object_v2_response_m_payload import EzsignfoldersignerassociationCreateObjectV2ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezsignfoldersignerassociation_create_object_v2_response_m_payload import EzsignfoldersignerassociationCreateObjectV2ResponseMPayload class TestEzsignfoldersignerassociationCreateObjectV2ResponseMPayload(unittest.TestCase): """EzsignfoldersignerassociationCreateObjectV2ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignfoldersignerassociationCreate optional params are included """ # uncomment below to create an instance of `EzsignfoldersignerassociationCreateObjectV2ResponseMPayload` """ - model = EzsignfoldersignerassociationCreateObjectV2ResponseMPayload() # noqa: E501 + model = EzsignfoldersignerassociationCreateObjectV2ResponseMPayload() if include_optional: return EzsignfoldersignerassociationCreateObjectV2ResponseMPayload( a_pki_ezsignfoldersignerassociation_id = [ diff --git a/test/test_ezsignfoldersignerassociation_delete_object_v1_response.py b/test/test_ezsignfoldersignerassociation_delete_object_v1_response.py index 188820d1f..3db91f534 100644 --- a/test/test_ezsignfoldersignerassociation_delete_object_v1_response.py +++ b/test/test_ezsignfoldersignerassociation_delete_object_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignfoldersignerassociation_delete_object_v1_response import EzsignfoldersignerassociationDeleteObjectV1Response # noqa: E501 +from eZmaxApi.models.ezsignfoldersignerassociation_delete_object_v1_response import EzsignfoldersignerassociationDeleteObjectV1Response class TestEzsignfoldersignerassociationDeleteObjectV1Response(unittest.TestCase): """EzsignfoldersignerassociationDeleteObjectV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignfoldersignerassociationDelete optional params are included """ # uncomment below to create an instance of `EzsignfoldersignerassociationDeleteObjectV1Response` """ - model = EzsignfoldersignerassociationDeleteObjectV1Response() # noqa: E501 + model = EzsignfoldersignerassociationDeleteObjectV1Response() if include_optional: return EzsignfoldersignerassociationDeleteObjectV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsignfoldersignerassociation_edit_object_v1_request.py b/test/test_ezsignfoldersignerassociation_edit_object_v1_request.py index 4c54874c2..354ab4eb9 100644 --- a/test/test_ezsignfoldersignerassociation_edit_object_v1_request.py +++ b/test/test_ezsignfoldersignerassociation_edit_object_v1_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignfoldersignerassociation_edit_object_v1_request import EzsignfoldersignerassociationEditObjectV1Request # noqa: E501 +from eZmaxApi.models.ezsignfoldersignerassociation_edit_object_v1_request import EzsignfoldersignerassociationEditObjectV1Request class TestEzsignfoldersignerassociationEditObjectV1Request(unittest.TestCase): """EzsignfoldersignerassociationEditObjectV1Request unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignfoldersignerassociationEditOb optional params are included """ # uncomment below to create an instance of `EzsignfoldersignerassociationEditObjectV1Request` """ - model = EzsignfoldersignerassociationEditObjectV1Request() # noqa: E501 + model = EzsignfoldersignerassociationEditObjectV1Request() if include_optional: return EzsignfoldersignerassociationEditObjectV1Request( obj_ezsignfoldersignerassociation = eZmaxApi.models.ezsignfoldersignerassociation_request_compound.ezsignfoldersignerassociation-RequestCompound() diff --git a/test/test_ezsignfoldersignerassociation_edit_object_v1_response.py b/test/test_ezsignfoldersignerassociation_edit_object_v1_response.py index 304d5870b..4193f431a 100644 --- a/test/test_ezsignfoldersignerassociation_edit_object_v1_response.py +++ b/test/test_ezsignfoldersignerassociation_edit_object_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignfoldersignerassociation_edit_object_v1_response import EzsignfoldersignerassociationEditObjectV1Response # noqa: E501 +from eZmaxApi.models.ezsignfoldersignerassociation_edit_object_v1_response import EzsignfoldersignerassociationEditObjectV1Response class TestEzsignfoldersignerassociationEditObjectV1Response(unittest.TestCase): """EzsignfoldersignerassociationEditObjectV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignfoldersignerassociationEditOb optional params are included """ # uncomment below to create an instance of `EzsignfoldersignerassociationEditObjectV1Response` """ - model = EzsignfoldersignerassociationEditObjectV1Response() # noqa: E501 + model = EzsignfoldersignerassociationEditObjectV1Response() if include_optional: return EzsignfoldersignerassociationEditObjectV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsignfoldersignerassociation_force_disconnect_v1_response.py b/test/test_ezsignfoldersignerassociation_force_disconnect_v1_response.py index 2a37b5959..c0e31fab9 100644 --- a/test/test_ezsignfoldersignerassociation_force_disconnect_v1_response.py +++ b/test/test_ezsignfoldersignerassociation_force_disconnect_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignfoldersignerassociation_force_disconnect_v1_response import EzsignfoldersignerassociationForceDisconnectV1Response # noqa: E501 +from eZmaxApi.models.ezsignfoldersignerassociation_force_disconnect_v1_response import EzsignfoldersignerassociationForceDisconnectV1Response class TestEzsignfoldersignerassociationForceDisconnectV1Response(unittest.TestCase): """EzsignfoldersignerassociationForceDisconnectV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignfoldersignerassociationForceD optional params are included """ # uncomment below to create an instance of `EzsignfoldersignerassociationForceDisconnectV1Response` """ - model = EzsignfoldersignerassociationForceDisconnectV1Response() # noqa: E501 + model = EzsignfoldersignerassociationForceDisconnectV1Response() if include_optional: return EzsignfoldersignerassociationForceDisconnectV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsignfoldersignerassociation_get_in_person_login_url_v1_response.py b/test/test_ezsignfoldersignerassociation_get_in_person_login_url_v1_response.py index effc492b0..6eeb5d0ad 100644 --- a/test/test_ezsignfoldersignerassociation_get_in_person_login_url_v1_response.py +++ b/test/test_ezsignfoldersignerassociation_get_in_person_login_url_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignfoldersignerassociation_get_in_person_login_url_v1_response import EzsignfoldersignerassociationGetInPersonLoginUrlV1Response # noqa: E501 +from eZmaxApi.models.ezsignfoldersignerassociation_get_in_person_login_url_v1_response import EzsignfoldersignerassociationGetInPersonLoginUrlV1Response class TestEzsignfoldersignerassociationGetInPersonLoginUrlV1Response(unittest.TestCase): """EzsignfoldersignerassociationGetInPersonLoginUrlV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignfoldersignerassociationGetInP optional params are included """ # uncomment below to create an instance of `EzsignfoldersignerassociationGetInPersonLoginUrlV1Response` """ - model = EzsignfoldersignerassociationGetInPersonLoginUrlV1Response() # noqa: E501 + model = EzsignfoldersignerassociationGetInPersonLoginUrlV1Response() if include_optional: return EzsignfoldersignerassociationGetInPersonLoginUrlV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsignfoldersignerassociation_get_in_person_login_url_v1_response_m_payload.py b/test/test_ezsignfoldersignerassociation_get_in_person_login_url_v1_response_m_payload.py index 420565482..c4a13ec87 100644 --- a/test/test_ezsignfoldersignerassociation_get_in_person_login_url_v1_response_m_payload.py +++ b/test/test_ezsignfoldersignerassociation_get_in_person_login_url_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignfoldersignerassociation_get_in_person_login_url_v1_response_m_payload import EzsignfoldersignerassociationGetInPersonLoginUrlV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezsignfoldersignerassociation_get_in_person_login_url_v1_response_m_payload import EzsignfoldersignerassociationGetInPersonLoginUrlV1ResponseMPayload class TestEzsignfoldersignerassociationGetInPersonLoginUrlV1ResponseMPayload(unittest.TestCase): """EzsignfoldersignerassociationGetInPersonLoginUrlV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignfoldersignerassociationGetInP optional params are included """ # uncomment below to create an instance of `EzsignfoldersignerassociationGetInPersonLoginUrlV1ResponseMPayload` """ - model = EzsignfoldersignerassociationGetInPersonLoginUrlV1ResponseMPayload() # noqa: E501 + model = EzsignfoldersignerassociationGetInPersonLoginUrlV1ResponseMPayload() if include_optional: return EzsignfoldersignerassociationGetInPersonLoginUrlV1ResponseMPayload( s_login_url = '' diff --git a/test/test_ezsignfoldersignerassociation_get_object_v1_response.py b/test/test_ezsignfoldersignerassociation_get_object_v1_response.py index 2dd846a63..d4164f139 100644 --- a/test/test_ezsignfoldersignerassociation_get_object_v1_response.py +++ b/test/test_ezsignfoldersignerassociation_get_object_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignfoldersignerassociation_get_object_v1_response import EzsignfoldersignerassociationGetObjectV1Response # noqa: E501 +from eZmaxApi.models.ezsignfoldersignerassociation_get_object_v1_response import EzsignfoldersignerassociationGetObjectV1Response class TestEzsignfoldersignerassociationGetObjectV1Response(unittest.TestCase): """EzsignfoldersignerassociationGetObjectV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignfoldersignerassociationGetObj optional params are included """ # uncomment below to create an instance of `EzsignfoldersignerassociationGetObjectV1Response` """ - model = EzsignfoldersignerassociationGetObjectV1Response() # noqa: E501 + model = EzsignfoldersignerassociationGetObjectV1Response() if include_optional: return EzsignfoldersignerassociationGetObjectV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsignfoldersignerassociation_get_object_v1_response_m_payload.py b/test/test_ezsignfoldersignerassociation_get_object_v1_response_m_payload.py index edfda3b13..87dbced8e 100644 --- a/test/test_ezsignfoldersignerassociation_get_object_v1_response_m_payload.py +++ b/test/test_ezsignfoldersignerassociation_get_object_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignfoldersignerassociation_get_object_v1_response_m_payload import EzsignfoldersignerassociationGetObjectV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezsignfoldersignerassociation_get_object_v1_response_m_payload import EzsignfoldersignerassociationGetObjectV1ResponseMPayload class TestEzsignfoldersignerassociationGetObjectV1ResponseMPayload(unittest.TestCase): """EzsignfoldersignerassociationGetObjectV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignfoldersignerassociationGetObj optional params are included """ # uncomment below to create an instance of `EzsignfoldersignerassociationGetObjectV1ResponseMPayload` """ - model = EzsignfoldersignerassociationGetObjectV1ResponseMPayload() # noqa: E501 + model = EzsignfoldersignerassociationGetObjectV1ResponseMPayload() if include_optional: return EzsignfoldersignerassociationGetObjectV1ResponseMPayload( pki_ezsignfoldersignerassociation_id = 20, diff --git a/test/test_ezsignfoldersignerassociation_get_object_v2_response.py b/test/test_ezsignfoldersignerassociation_get_object_v2_response.py index 065a45370..5a233d9ce 100644 --- a/test/test_ezsignfoldersignerassociation_get_object_v2_response.py +++ b/test/test_ezsignfoldersignerassociation_get_object_v2_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignfoldersignerassociation_get_object_v2_response import EzsignfoldersignerassociationGetObjectV2Response # noqa: E501 +from eZmaxApi.models.ezsignfoldersignerassociation_get_object_v2_response import EzsignfoldersignerassociationGetObjectV2Response class TestEzsignfoldersignerassociationGetObjectV2Response(unittest.TestCase): """EzsignfoldersignerassociationGetObjectV2Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignfoldersignerassociationGetObj optional params are included """ # uncomment below to create an instance of `EzsignfoldersignerassociationGetObjectV2Response` """ - model = EzsignfoldersignerassociationGetObjectV2Response() # noqa: E501 + model = EzsignfoldersignerassociationGetObjectV2Response() if include_optional: return EzsignfoldersignerassociationGetObjectV2Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsignfoldersignerassociation_get_object_v2_response_m_payload.py b/test/test_ezsignfoldersignerassociation_get_object_v2_response_m_payload.py index 86268a0ad..043979cd7 100644 --- a/test/test_ezsignfoldersignerassociation_get_object_v2_response_m_payload.py +++ b/test/test_ezsignfoldersignerassociation_get_object_v2_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignfoldersignerassociation_get_object_v2_response_m_payload import EzsignfoldersignerassociationGetObjectV2ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezsignfoldersignerassociation_get_object_v2_response_m_payload import EzsignfoldersignerassociationGetObjectV2ResponseMPayload class TestEzsignfoldersignerassociationGetObjectV2ResponseMPayload(unittest.TestCase): """EzsignfoldersignerassociationGetObjectV2ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignfoldersignerassociationGetObj optional params are included """ # uncomment below to create an instance of `EzsignfoldersignerassociationGetObjectV2ResponseMPayload` """ - model = EzsignfoldersignerassociationGetObjectV2ResponseMPayload() # noqa: E501 + model = EzsignfoldersignerassociationGetObjectV2ResponseMPayload() if include_optional: return EzsignfoldersignerassociationGetObjectV2ResponseMPayload( obj_ezsignfoldersignerassociation = eZmaxApi.models.ezsignfoldersignerassociation_response_compound.ezsignfoldersignerassociation-ResponseCompound() diff --git a/test/test_ezsignfoldersignerassociation_patch_object_v1_request.py b/test/test_ezsignfoldersignerassociation_patch_object_v1_request.py index 6e069d5f3..5a0369ab6 100644 --- a/test/test_ezsignfoldersignerassociation_patch_object_v1_request.py +++ b/test/test_ezsignfoldersignerassociation_patch_object_v1_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignfoldersignerassociation_patch_object_v1_request import EzsignfoldersignerassociationPatchObjectV1Request # noqa: E501 +from eZmaxApi.models.ezsignfoldersignerassociation_patch_object_v1_request import EzsignfoldersignerassociationPatchObjectV1Request class TestEzsignfoldersignerassociationPatchObjectV1Request(unittest.TestCase): """EzsignfoldersignerassociationPatchObjectV1Request unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignfoldersignerassociationPatchO optional params are included """ # uncomment below to create an instance of `EzsignfoldersignerassociationPatchObjectV1Request` """ - model = EzsignfoldersignerassociationPatchObjectV1Request() # noqa: E501 + model = EzsignfoldersignerassociationPatchObjectV1Request() if include_optional: return EzsignfoldersignerassociationPatchObjectV1Request( obj_ezsignfoldersignerassociation = eZmaxApi.models.ezsignfoldersignerassociation_request_patch.ezsignfoldersignerassociation-RequestPatch( diff --git a/test/test_ezsignfoldersignerassociation_patch_object_v1_response.py b/test/test_ezsignfoldersignerassociation_patch_object_v1_response.py index f3ecaf43c..6e03a4578 100644 --- a/test/test_ezsignfoldersignerassociation_patch_object_v1_response.py +++ b/test/test_ezsignfoldersignerassociation_patch_object_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignfoldersignerassociation_patch_object_v1_response import EzsignfoldersignerassociationPatchObjectV1Response # noqa: E501 +from eZmaxApi.models.ezsignfoldersignerassociation_patch_object_v1_response import EzsignfoldersignerassociationPatchObjectV1Response class TestEzsignfoldersignerassociationPatchObjectV1Response(unittest.TestCase): """EzsignfoldersignerassociationPatchObjectV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignfoldersignerassociationPatchO optional params are included """ # uncomment below to create an instance of `EzsignfoldersignerassociationPatchObjectV1Response` """ - model = EzsignfoldersignerassociationPatchObjectV1Response() # noqa: E501 + model = EzsignfoldersignerassociationPatchObjectV1Response() if include_optional: return EzsignfoldersignerassociationPatchObjectV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsignfoldersignerassociation_request.py b/test/test_ezsignfoldersignerassociation_request.py index 67fd645ec..a94699292 100644 --- a/test/test_ezsignfoldersignerassociation_request.py +++ b/test/test_ezsignfoldersignerassociation_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignfoldersignerassociation_request import EzsignfoldersignerassociationRequest # noqa: E501 +from eZmaxApi.models.ezsignfoldersignerassociation_request import EzsignfoldersignerassociationRequest class TestEzsignfoldersignerassociationRequest(unittest.TestCase): """EzsignfoldersignerassociationRequest unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignfoldersignerassociationReques optional params are included """ # uncomment below to create an instance of `EzsignfoldersignerassociationRequest` """ - model = EzsignfoldersignerassociationRequest() # noqa: E501 + model = EzsignfoldersignerassociationRequest() if include_optional: return EzsignfoldersignerassociationRequest( pki_ezsignfoldersignerassociation_id = 20, diff --git a/test/test_ezsignfoldersignerassociation_request_compound.py b/test/test_ezsignfoldersignerassociation_request_compound.py index e8477216d..49c88ac7a 100644 --- a/test/test_ezsignfoldersignerassociation_request_compound.py +++ b/test/test_ezsignfoldersignerassociation_request_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignfoldersignerassociation_request_compound import EzsignfoldersignerassociationRequestCompound # noqa: E501 +from eZmaxApi.models.ezsignfoldersignerassociation_request_compound import EzsignfoldersignerassociationRequestCompound class TestEzsignfoldersignerassociationRequestCompound(unittest.TestCase): """EzsignfoldersignerassociationRequestCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignfoldersignerassociationReques optional params are included """ # uncomment below to create an instance of `EzsignfoldersignerassociationRequestCompound` """ - model = EzsignfoldersignerassociationRequestCompound() # noqa: E501 + model = EzsignfoldersignerassociationRequestCompound() if include_optional: return EzsignfoldersignerassociationRequestCompound( pki_ezsignfoldersignerassociation_id = 20, diff --git a/test/test_ezsignfoldersignerassociation_request_patch.py b/test/test_ezsignfoldersignerassociation_request_patch.py index 44d5f3c6a..7d15b40fb 100644 --- a/test/test_ezsignfoldersignerassociation_request_patch.py +++ b/test/test_ezsignfoldersignerassociation_request_patch.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignfoldersignerassociation_request_patch import EzsignfoldersignerassociationRequestPatch # noqa: E501 +from eZmaxApi.models.ezsignfoldersignerassociation_request_patch import EzsignfoldersignerassociationRequestPatch class TestEzsignfoldersignerassociationRequestPatch(unittest.TestCase): """EzsignfoldersignerassociationRequestPatch unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignfoldersignerassociationReques optional params are included """ # uncomment below to create an instance of `EzsignfoldersignerassociationRequestPatch` """ - model = EzsignfoldersignerassociationRequestPatch() # noqa: E501 + model = EzsignfoldersignerassociationRequestPatch() if include_optional: return EzsignfoldersignerassociationRequestPatch( t_ezsignfoldersignerassociation_message = 'Hi John, diff --git a/test/test_ezsignfoldersignerassociation_response.py b/test/test_ezsignfoldersignerassociation_response.py index 1ce011ac1..a13ef1c8f 100644 --- a/test/test_ezsignfoldersignerassociation_response.py +++ b/test/test_ezsignfoldersignerassociation_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignfoldersignerassociation_response import EzsignfoldersignerassociationResponse # noqa: E501 +from eZmaxApi.models.ezsignfoldersignerassociation_response import EzsignfoldersignerassociationResponse class TestEzsignfoldersignerassociationResponse(unittest.TestCase): """EzsignfoldersignerassociationResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignfoldersignerassociationRespon optional params are included """ # uncomment below to create an instance of `EzsignfoldersignerassociationResponse` """ - model = EzsignfoldersignerassociationResponse() # noqa: E501 + model = EzsignfoldersignerassociationResponse() if include_optional: return EzsignfoldersignerassociationResponse( pki_ezsignfoldersignerassociation_id = 20, diff --git a/test/test_ezsignfoldersignerassociation_response_compound.py b/test/test_ezsignfoldersignerassociation_response_compound.py index ea02f5996..674ea363b 100644 --- a/test/test_ezsignfoldersignerassociation_response_compound.py +++ b/test/test_ezsignfoldersignerassociation_response_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignfoldersignerassociation_response_compound import EzsignfoldersignerassociationResponseCompound # noqa: E501 +from eZmaxApi.models.ezsignfoldersignerassociation_response_compound import EzsignfoldersignerassociationResponseCompound class TestEzsignfoldersignerassociationResponseCompound(unittest.TestCase): """EzsignfoldersignerassociationResponseCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignfoldersignerassociationRespon optional params are included """ # uncomment below to create an instance of `EzsignfoldersignerassociationResponseCompound` """ - model = EzsignfoldersignerassociationResponseCompound() # noqa: E501 + model = EzsignfoldersignerassociationResponseCompound() if include_optional: return EzsignfoldersignerassociationResponseCompound( pki_ezsignfoldersignerassociation_id = 20, diff --git a/test/test_ezsignfoldersignerassociation_response_compound_user.py b/test/test_ezsignfoldersignerassociation_response_compound_user.py index 34ba63db1..f0cd6694f 100644 --- a/test/test_ezsignfoldersignerassociation_response_compound_user.py +++ b/test/test_ezsignfoldersignerassociation_response_compound_user.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignfoldersignerassociation_response_compound_user import EzsignfoldersignerassociationResponseCompoundUser # noqa: E501 +from eZmaxApi.models.ezsignfoldersignerassociation_response_compound_user import EzsignfoldersignerassociationResponseCompoundUser class TestEzsignfoldersignerassociationResponseCompoundUser(unittest.TestCase): """EzsignfoldersignerassociationResponseCompoundUser unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignfoldersignerassociationRespon optional params are included """ # uncomment below to create an instance of `EzsignfoldersignerassociationResponseCompoundUser` """ - model = EzsignfoldersignerassociationResponseCompoundUser() # noqa: E501 + model = EzsignfoldersignerassociationResponseCompoundUser() if include_optional: return EzsignfoldersignerassociationResponseCompoundUser( pki_user_id = 70, diff --git a/test/test_ezsignfoldertype_autocomplete_element_response.py b/test/test_ezsignfoldertype_autocomplete_element_response.py index 2d6bb3455..4a7afd46a 100644 --- a/test/test_ezsignfoldertype_autocomplete_element_response.py +++ b/test/test_ezsignfoldertype_autocomplete_element_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignfoldertype_autocomplete_element_response import EzsignfoldertypeAutocompleteElementResponse # noqa: E501 +from eZmaxApi.models.ezsignfoldertype_autocomplete_element_response import EzsignfoldertypeAutocompleteElementResponse class TestEzsignfoldertypeAutocompleteElementResponse(unittest.TestCase): """EzsignfoldertypeAutocompleteElementResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignfoldertypeAutocompleteElement optional params are included """ # uncomment below to create an instance of `EzsignfoldertypeAutocompleteElementResponse` """ - model = EzsignfoldertypeAutocompleteElementResponse() # noqa: E501 + model = EzsignfoldertypeAutocompleteElementResponse() if include_optional: return EzsignfoldertypeAutocompleteElementResponse( e_ezsignfoldertype_privacylevel = 'User', diff --git a/test/test_ezsignfoldertype_create_object_v1_request.py b/test/test_ezsignfoldertype_create_object_v1_request.py index c47b4a721..aa54260ce 100644 --- a/test/test_ezsignfoldertype_create_object_v1_request.py +++ b/test/test_ezsignfoldertype_create_object_v1_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignfoldertype_create_object_v1_request import EzsignfoldertypeCreateObjectV1Request # noqa: E501 +from eZmaxApi.models.ezsignfoldertype_create_object_v1_request import EzsignfoldertypeCreateObjectV1Request class TestEzsignfoldertypeCreateObjectV1Request(unittest.TestCase): """EzsignfoldertypeCreateObjectV1Request unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignfoldertypeCreateObjectV1Reque optional params are included """ # uncomment below to create an instance of `EzsignfoldertypeCreateObjectV1Request` """ - model = EzsignfoldertypeCreateObjectV1Request() # noqa: E501 + model = EzsignfoldertypeCreateObjectV1Request() if include_optional: return EzsignfoldertypeCreateObjectV1Request( a_obj_ezsignfoldertype = [ diff --git a/test/test_ezsignfoldertype_create_object_v1_response.py b/test/test_ezsignfoldertype_create_object_v1_response.py index 1d5c485ec..ed812bba7 100644 --- a/test/test_ezsignfoldertype_create_object_v1_response.py +++ b/test/test_ezsignfoldertype_create_object_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignfoldertype_create_object_v1_response import EzsignfoldertypeCreateObjectV1Response # noqa: E501 +from eZmaxApi.models.ezsignfoldertype_create_object_v1_response import EzsignfoldertypeCreateObjectV1Response class TestEzsignfoldertypeCreateObjectV1Response(unittest.TestCase): """EzsignfoldertypeCreateObjectV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignfoldertypeCreateObjectV1Respo optional params are included """ # uncomment below to create an instance of `EzsignfoldertypeCreateObjectV1Response` """ - model = EzsignfoldertypeCreateObjectV1Response() # noqa: E501 + model = EzsignfoldertypeCreateObjectV1Response() if include_optional: return EzsignfoldertypeCreateObjectV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsignfoldertype_create_object_v1_response_m_payload.py b/test/test_ezsignfoldertype_create_object_v1_response_m_payload.py index d9c84ba75..6cf08dbc4 100644 --- a/test/test_ezsignfoldertype_create_object_v1_response_m_payload.py +++ b/test/test_ezsignfoldertype_create_object_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignfoldertype_create_object_v1_response_m_payload import EzsignfoldertypeCreateObjectV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezsignfoldertype_create_object_v1_response_m_payload import EzsignfoldertypeCreateObjectV1ResponseMPayload class TestEzsignfoldertypeCreateObjectV1ResponseMPayload(unittest.TestCase): """EzsignfoldertypeCreateObjectV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignfoldertypeCreateObjectV1Respo optional params are included """ # uncomment below to create an instance of `EzsignfoldertypeCreateObjectV1ResponseMPayload` """ - model = EzsignfoldertypeCreateObjectV1ResponseMPayload() # noqa: E501 + model = EzsignfoldertypeCreateObjectV1ResponseMPayload() if include_optional: return EzsignfoldertypeCreateObjectV1ResponseMPayload( a_pki_ezsignfoldertype_id = [ diff --git a/test/test_ezsignfoldertype_edit_object_v1_request.py b/test/test_ezsignfoldertype_edit_object_v1_request.py index 5f433e024..ab12216a6 100644 --- a/test/test_ezsignfoldertype_edit_object_v1_request.py +++ b/test/test_ezsignfoldertype_edit_object_v1_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignfoldertype_edit_object_v1_request import EzsignfoldertypeEditObjectV1Request # noqa: E501 +from eZmaxApi.models.ezsignfoldertype_edit_object_v1_request import EzsignfoldertypeEditObjectV1Request class TestEzsignfoldertypeEditObjectV1Request(unittest.TestCase): """EzsignfoldertypeEditObjectV1Request unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignfoldertypeEditObjectV1Request optional params are included """ # uncomment below to create an instance of `EzsignfoldertypeEditObjectV1Request` """ - model = EzsignfoldertypeEditObjectV1Request() # noqa: E501 + model = EzsignfoldertypeEditObjectV1Request() if include_optional: return EzsignfoldertypeEditObjectV1Request( obj_ezsignfoldertype = eZmaxApi.models.ezsignfoldertype_request_compound.ezsignfoldertype-RequestCompound() diff --git a/test/test_ezsignfoldertype_edit_object_v1_response.py b/test/test_ezsignfoldertype_edit_object_v1_response.py index 84f5f4d39..002a7b7d2 100644 --- a/test/test_ezsignfoldertype_edit_object_v1_response.py +++ b/test/test_ezsignfoldertype_edit_object_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignfoldertype_edit_object_v1_response import EzsignfoldertypeEditObjectV1Response # noqa: E501 +from eZmaxApi.models.ezsignfoldertype_edit_object_v1_response import EzsignfoldertypeEditObjectV1Response class TestEzsignfoldertypeEditObjectV1Response(unittest.TestCase): """EzsignfoldertypeEditObjectV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignfoldertypeEditObjectV1Respons optional params are included """ # uncomment below to create an instance of `EzsignfoldertypeEditObjectV1Response` """ - model = EzsignfoldertypeEditObjectV1Response() # noqa: E501 + model = EzsignfoldertypeEditObjectV1Response() if include_optional: return EzsignfoldertypeEditObjectV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsignfoldertype_get_autocomplete_v2_response.py b/test/test_ezsignfoldertype_get_autocomplete_v2_response.py index 9e4ed4aec..57fe3e387 100644 --- a/test/test_ezsignfoldertype_get_autocomplete_v2_response.py +++ b/test/test_ezsignfoldertype_get_autocomplete_v2_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignfoldertype_get_autocomplete_v2_response import EzsignfoldertypeGetAutocompleteV2Response # noqa: E501 +from eZmaxApi.models.ezsignfoldertype_get_autocomplete_v2_response import EzsignfoldertypeGetAutocompleteV2Response class TestEzsignfoldertypeGetAutocompleteV2Response(unittest.TestCase): """EzsignfoldertypeGetAutocompleteV2Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignfoldertypeGetAutocompleteV2Re optional params are included """ # uncomment below to create an instance of `EzsignfoldertypeGetAutocompleteV2Response` """ - model = EzsignfoldertypeGetAutocompleteV2Response() # noqa: E501 + model = EzsignfoldertypeGetAutocompleteV2Response() if include_optional: return EzsignfoldertypeGetAutocompleteV2Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsignfoldertype_get_autocomplete_v2_response_m_payload.py b/test/test_ezsignfoldertype_get_autocomplete_v2_response_m_payload.py index efc573b21..3089e0581 100644 --- a/test/test_ezsignfoldertype_get_autocomplete_v2_response_m_payload.py +++ b/test/test_ezsignfoldertype_get_autocomplete_v2_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignfoldertype_get_autocomplete_v2_response_m_payload import EzsignfoldertypeGetAutocompleteV2ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezsignfoldertype_get_autocomplete_v2_response_m_payload import EzsignfoldertypeGetAutocompleteV2ResponseMPayload class TestEzsignfoldertypeGetAutocompleteV2ResponseMPayload(unittest.TestCase): """EzsignfoldertypeGetAutocompleteV2ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignfoldertypeGetAutocompleteV2Re optional params are included """ # uncomment below to create an instance of `EzsignfoldertypeGetAutocompleteV2ResponseMPayload` """ - model = EzsignfoldertypeGetAutocompleteV2ResponseMPayload() # noqa: E501 + model = EzsignfoldertypeGetAutocompleteV2ResponseMPayload() if include_optional: return EzsignfoldertypeGetAutocompleteV2ResponseMPayload( a_obj_ezsignfoldertype = [ diff --git a/test/test_ezsignfoldertype_get_list_v1_response.py b/test/test_ezsignfoldertype_get_list_v1_response.py index c98d57c0e..b9028f977 100644 --- a/test/test_ezsignfoldertype_get_list_v1_response.py +++ b/test/test_ezsignfoldertype_get_list_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignfoldertype_get_list_v1_response import EzsignfoldertypeGetListV1Response # noqa: E501 +from eZmaxApi.models.ezsignfoldertype_get_list_v1_response import EzsignfoldertypeGetListV1Response class TestEzsignfoldertypeGetListV1Response(unittest.TestCase): """EzsignfoldertypeGetListV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignfoldertypeGetListV1Response: optional params are included """ # uncomment below to create an instance of `EzsignfoldertypeGetListV1Response` """ - model = EzsignfoldertypeGetListV1Response() # noqa: E501 + model = EzsignfoldertypeGetListV1Response() if include_optional: return EzsignfoldertypeGetListV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload_get_list.Common-Response-objDebugPayload_getList(), diff --git a/test/test_ezsignfoldertype_get_list_v1_response_m_payload.py b/test/test_ezsignfoldertype_get_list_v1_response_m_payload.py index f989f93b3..e94f5fcdc 100644 --- a/test/test_ezsignfoldertype_get_list_v1_response_m_payload.py +++ b/test/test_ezsignfoldertype_get_list_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignfoldertype_get_list_v1_response_m_payload import EzsignfoldertypeGetListV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezsignfoldertype_get_list_v1_response_m_payload import EzsignfoldertypeGetListV1ResponseMPayload class TestEzsignfoldertypeGetListV1ResponseMPayload(unittest.TestCase): """EzsignfoldertypeGetListV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignfoldertypeGetListV1ResponseMP optional params are included """ # uncomment below to create an instance of `EzsignfoldertypeGetListV1ResponseMPayload` """ - model = EzsignfoldertypeGetListV1ResponseMPayload() # noqa: E501 + model = EzsignfoldertypeGetListV1ResponseMPayload() if include_optional: return EzsignfoldertypeGetListV1ResponseMPayload( i_row_returned = 100, diff --git a/test/test_ezsignfoldertype_get_object_v2_response.py b/test/test_ezsignfoldertype_get_object_v2_response.py index 9465785cf..3ecaa9453 100644 --- a/test/test_ezsignfoldertype_get_object_v2_response.py +++ b/test/test_ezsignfoldertype_get_object_v2_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignfoldertype_get_object_v2_response import EzsignfoldertypeGetObjectV2Response # noqa: E501 +from eZmaxApi.models.ezsignfoldertype_get_object_v2_response import EzsignfoldertypeGetObjectV2Response class TestEzsignfoldertypeGetObjectV2Response(unittest.TestCase): """EzsignfoldertypeGetObjectV2Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignfoldertypeGetObjectV2Response optional params are included """ # uncomment below to create an instance of `EzsignfoldertypeGetObjectV2Response` """ - model = EzsignfoldertypeGetObjectV2Response() # noqa: E501 + model = EzsignfoldertypeGetObjectV2Response() if include_optional: return EzsignfoldertypeGetObjectV2Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsignfoldertype_get_object_v2_response_m_payload.py b/test/test_ezsignfoldertype_get_object_v2_response_m_payload.py index c7542e832..1c860a432 100644 --- a/test/test_ezsignfoldertype_get_object_v2_response_m_payload.py +++ b/test/test_ezsignfoldertype_get_object_v2_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignfoldertype_get_object_v2_response_m_payload import EzsignfoldertypeGetObjectV2ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezsignfoldertype_get_object_v2_response_m_payload import EzsignfoldertypeGetObjectV2ResponseMPayload class TestEzsignfoldertypeGetObjectV2ResponseMPayload(unittest.TestCase): """EzsignfoldertypeGetObjectV2ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignfoldertypeGetObjectV2Response optional params are included """ # uncomment below to create an instance of `EzsignfoldertypeGetObjectV2ResponseMPayload` """ - model = EzsignfoldertypeGetObjectV2ResponseMPayload() # noqa: E501 + model = EzsignfoldertypeGetObjectV2ResponseMPayload() if include_optional: return EzsignfoldertypeGetObjectV2ResponseMPayload( obj_ezsignfoldertype = eZmaxApi.models.ezsignfoldertype_response_compound.ezsignfoldertype-ResponseCompound() diff --git a/test/test_ezsignfoldertype_list_element.py b/test/test_ezsignfoldertype_list_element.py index 0d2fa45ae..abab4a088 100644 --- a/test/test_ezsignfoldertype_list_element.py +++ b/test/test_ezsignfoldertype_list_element.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignfoldertype_list_element import EzsignfoldertypeListElement # noqa: E501 +from eZmaxApi.models.ezsignfoldertype_list_element import EzsignfoldertypeListElement class TestEzsignfoldertypeListElement(unittest.TestCase): """EzsignfoldertypeListElement unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignfoldertypeListElement: optional params are included """ # uncomment below to create an instance of `EzsignfoldertypeListElement` """ - model = EzsignfoldertypeListElement() # noqa: E501 + model = EzsignfoldertypeListElement() if include_optional: return EzsignfoldertypeListElement( pki_ezsignfoldertype_id = 5, diff --git a/test/test_ezsignfoldertype_request.py b/test/test_ezsignfoldertype_request.py index a4a325092..ce21662bd 100644 --- a/test/test_ezsignfoldertype_request.py +++ b/test/test_ezsignfoldertype_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignfoldertype_request import EzsignfoldertypeRequest # noqa: E501 +from eZmaxApi.models.ezsignfoldertype_request import EzsignfoldertypeRequest class TestEzsignfoldertypeRequest(unittest.TestCase): """EzsignfoldertypeRequest unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignfoldertypeRequest: optional params are included """ # uncomment below to create an instance of `EzsignfoldertypeRequest` """ - model = EzsignfoldertypeRequest() # noqa: E501 + model = EzsignfoldertypeRequest() if include_optional: return EzsignfoldertypeRequest( pki_ezsignfoldertype_id = 5, @@ -57,6 +57,16 @@ def make_instance(self, include_optional) -> EzsignfoldertypeRequest: b_ezsignfoldertype_delegate = True, b_ezsignfoldertype_reassign = True, b_ezsignfoldertype_sendattatchmentsigner = False, + b_ezsignfoldertype_sendsignedtoezsignsigner = False, + b_ezsignfoldertype_sendsignedtouser = False, + b_ezsignfoldertype_sendattachmentezsignsigner = False, + b_ezsignfoldertype_sendproofezsignsigner = False, + b_ezsignfoldertype_sendattachmentuser = False, + b_ezsignfoldertype_sendproofuser = False, + b_ezsignfoldertype_sendproofemail = False, + b_ezsignfoldertype_allowdownloadattachmentezsignsigner = False, + b_ezsignfoldertype_allowdownloadproofezsignsigner = False, + b_ezsignfoldertype_sendproofreceivealldocument = False, b_ezsignfoldertype_sendsignedtodocumentowner = False, b_ezsignfoldertype_sendsignedtofolderowner = False, b_ezsignfoldertype_sendsignedtofullgroup = False, @@ -81,14 +91,12 @@ def make_instance(self, include_optional) -> EzsignfoldertypeRequest: i_ezsignfoldertype_archivaldays = 30, e_ezsignfoldertype_disposal = 'Manual', i_ezsignfoldertype_deadlinedays = 5, - b_ezsignfoldertype_sendattatchmentsigner = False, b_ezsignfoldertype_sendsignedtodocumentowner = False, b_ezsignfoldertype_sendsignedtofolderowner = False, b_ezsignfoldertype_sendsignedtocolleague = False, b_ezsignfoldertype_sendsummarytodocumentowner = False, b_ezsignfoldertype_sendsummarytofolderowner = False, b_ezsignfoldertype_sendsummarytocolleague = False, - b_ezsignfoldertype_includeproofsigner = True, b_ezsignfoldertype_includeproofuser = True, b_ezsignfoldertype_isactive = True, ) diff --git a/test/test_ezsignfoldertype_request_compound.py b/test/test_ezsignfoldertype_request_compound.py index 3f4d06e76..e26993bfd 100644 --- a/test/test_ezsignfoldertype_request_compound.py +++ b/test/test_ezsignfoldertype_request_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignfoldertype_request_compound import EzsignfoldertypeRequestCompound # noqa: E501 +from eZmaxApi.models.ezsignfoldertype_request_compound import EzsignfoldertypeRequestCompound class TestEzsignfoldertypeRequestCompound(unittest.TestCase): """EzsignfoldertypeRequestCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignfoldertypeRequestCompound: optional params are included """ # uncomment below to create an instance of `EzsignfoldertypeRequestCompound` """ - model = EzsignfoldertypeRequestCompound() # noqa: E501 + model = EzsignfoldertypeRequestCompound() if include_optional: return EzsignfoldertypeRequestCompound( pki_ezsignfoldertype_id = 5, @@ -57,6 +57,16 @@ def make_instance(self, include_optional) -> EzsignfoldertypeRequestCompound: b_ezsignfoldertype_delegate = True, b_ezsignfoldertype_reassign = True, b_ezsignfoldertype_sendattatchmentsigner = False, + b_ezsignfoldertype_sendsignedtoezsignsigner = False, + b_ezsignfoldertype_sendsignedtouser = False, + b_ezsignfoldertype_sendattachmentezsignsigner = False, + b_ezsignfoldertype_sendproofezsignsigner = False, + b_ezsignfoldertype_sendattachmentuser = False, + b_ezsignfoldertype_sendproofuser = False, + b_ezsignfoldertype_sendproofemail = False, + b_ezsignfoldertype_allowdownloadattachmentezsignsigner = False, + b_ezsignfoldertype_allowdownloadproofezsignsigner = False, + b_ezsignfoldertype_sendproofreceivealldocument = False, b_ezsignfoldertype_sendsignedtodocumentowner = False, b_ezsignfoldertype_sendsignedtofolderowner = False, b_ezsignfoldertype_sendsignedtofullgroup = False, @@ -87,14 +97,12 @@ def make_instance(self, include_optional) -> EzsignfoldertypeRequestCompound: i_ezsignfoldertype_archivaldays = 30, e_ezsignfoldertype_disposal = 'Manual', i_ezsignfoldertype_deadlinedays = 5, - b_ezsignfoldertype_sendattatchmentsigner = False, b_ezsignfoldertype_sendsignedtodocumentowner = False, b_ezsignfoldertype_sendsignedtofolderowner = False, b_ezsignfoldertype_sendsignedtocolleague = False, b_ezsignfoldertype_sendsummarytodocumentowner = False, b_ezsignfoldertype_sendsummarytofolderowner = False, b_ezsignfoldertype_sendsummarytocolleague = False, - b_ezsignfoldertype_includeproofsigner = True, b_ezsignfoldertype_includeproofuser = True, b_ezsignfoldertype_isactive = True, ) diff --git a/test/test_ezsignfoldertype_response.py b/test/test_ezsignfoldertype_response.py index 8c6b87aa9..7d4a666b2 100644 --- a/test/test_ezsignfoldertype_response.py +++ b/test/test_ezsignfoldertype_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignfoldertype_response import EzsignfoldertypeResponse # noqa: E501 +from eZmaxApi.models.ezsignfoldertype_response import EzsignfoldertypeResponse class TestEzsignfoldertypeResponse(unittest.TestCase): """EzsignfoldertypeResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignfoldertypeResponse: optional params are included """ # uncomment below to create an instance of `EzsignfoldertypeResponse` """ - model = EzsignfoldertypeResponse() # noqa: E501 + model = EzsignfoldertypeResponse() if include_optional: return EzsignfoldertypeResponse( pki_ezsignfoldertype_id = 5, @@ -62,6 +62,16 @@ def make_instance(self, include_optional) -> EzsignfoldertypeResponse: b_ezsignfoldertype_delegate = True, b_ezsignfoldertype_reassign = True, b_ezsignfoldertype_sendattatchmentsigner = False, + b_ezsignfoldertype_sendsignedtoezsignsigner = False, + b_ezsignfoldertype_sendsignedtouser = False, + b_ezsignfoldertype_sendattachmentezsignsigner = False, + b_ezsignfoldertype_sendproofezsignsigner = False, + b_ezsignfoldertype_sendattachmentuser = False, + b_ezsignfoldertype_sendproofuser = False, + b_ezsignfoldertype_sendproofemail = False, + b_ezsignfoldertype_allowdownloadattachmentezsignsigner = False, + b_ezsignfoldertype_allowdownloadproofezsignsigner = False, + b_ezsignfoldertype_sendproofreceivealldocument = False, b_ezsignfoldertype_sendsignedtodocumentowner = False, b_ezsignfoldertype_sendsignedtofolderowner = False, b_ezsignfoldertype_sendsignedtofullgroup = False, @@ -88,14 +98,12 @@ def make_instance(self, include_optional) -> EzsignfoldertypeResponse: i_ezsignfoldertype_archivaldays = 30, e_ezsignfoldertype_disposal = 'Manual', i_ezsignfoldertype_deadlinedays = 5, - b_ezsignfoldertype_sendattatchmentsigner = False, b_ezsignfoldertype_sendsignedtodocumentowner = False, b_ezsignfoldertype_sendsignedtofolderowner = False, b_ezsignfoldertype_sendsignedtocolleague = False, b_ezsignfoldertype_sendsummarytodocumentowner = False, b_ezsignfoldertype_sendsummarytofolderowner = False, b_ezsignfoldertype_sendsummarytocolleague = False, - b_ezsignfoldertype_includeproofsigner = True, b_ezsignfoldertype_includeproofuser = True, b_ezsignfoldertype_isactive = True, ) diff --git a/test/test_ezsignfoldertype_response_compound.py b/test/test_ezsignfoldertype_response_compound.py index a395771cc..f086dd9be 100644 --- a/test/test_ezsignfoldertype_response_compound.py +++ b/test/test_ezsignfoldertype_response_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignfoldertype_response_compound import EzsignfoldertypeResponseCompound # noqa: E501 +from eZmaxApi.models.ezsignfoldertype_response_compound import EzsignfoldertypeResponseCompound class TestEzsignfoldertypeResponseCompound(unittest.TestCase): """EzsignfoldertypeResponseCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignfoldertypeResponseCompound: optional params are included """ # uncomment below to create an instance of `EzsignfoldertypeResponseCompound` """ - model = EzsignfoldertypeResponseCompound() # noqa: E501 + model = EzsignfoldertypeResponseCompound() if include_optional: return EzsignfoldertypeResponseCompound( pki_ezsignfoldertype_id = 5, @@ -62,6 +62,16 @@ def make_instance(self, include_optional) -> EzsignfoldertypeResponseCompound: b_ezsignfoldertype_delegate = True, b_ezsignfoldertype_reassign = True, b_ezsignfoldertype_sendattatchmentsigner = False, + b_ezsignfoldertype_sendsignedtoezsignsigner = False, + b_ezsignfoldertype_sendsignedtouser = False, + b_ezsignfoldertype_sendattachmentezsignsigner = False, + b_ezsignfoldertype_sendproofezsignsigner = False, + b_ezsignfoldertype_sendattachmentuser = False, + b_ezsignfoldertype_sendproofuser = False, + b_ezsignfoldertype_sendproofemail = False, + b_ezsignfoldertype_allowdownloadattachmentezsignsigner = False, + b_ezsignfoldertype_allowdownloadproofezsignsigner = False, + b_ezsignfoldertype_sendproofreceivealldocument = False, b_ezsignfoldertype_sendsignedtodocumentowner = False, b_ezsignfoldertype_sendsignedtofolderowner = False, b_ezsignfoldertype_sendsignedtofullgroup = False, @@ -94,14 +104,12 @@ def make_instance(self, include_optional) -> EzsignfoldertypeResponseCompound: i_ezsignfoldertype_archivaldays = 30, e_ezsignfoldertype_disposal = 'Manual', i_ezsignfoldertype_deadlinedays = 5, - b_ezsignfoldertype_sendattatchmentsigner = False, b_ezsignfoldertype_sendsignedtodocumentowner = False, b_ezsignfoldertype_sendsignedtofolderowner = False, b_ezsignfoldertype_sendsignedtocolleague = False, b_ezsignfoldertype_sendsummarytodocumentowner = False, b_ezsignfoldertype_sendsummarytofolderowner = False, b_ezsignfoldertype_sendsummarytocolleague = False, - b_ezsignfoldertype_includeproofsigner = True, b_ezsignfoldertype_includeproofuser = True, b_ezsignfoldertype_isactive = True, ) diff --git a/test/test_ezsignformfield_request.py b/test/test_ezsignformfield_request.py index da4e5ef76..1bab1627a 100644 --- a/test/test_ezsignformfield_request.py +++ b/test/test_ezsignformfield_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignformfield_request import EzsignformfieldRequest # noqa: E501 +from eZmaxApi.models.ezsignformfield_request import EzsignformfieldRequest class TestEzsignformfieldRequest(unittest.TestCase): """EzsignformfieldRequest unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignformfieldRequest: optional params are included """ # uncomment below to create an instance of `EzsignformfieldRequest` """ - model = EzsignformfieldRequest() # noqa: E501 + model = EzsignformfieldRequest() if include_optional: return EzsignformfieldRequest( pki_ezsignformfield_id = 32, diff --git a/test/test_ezsignformfield_request_compound.py b/test/test_ezsignformfield_request_compound.py index fa550a057..7c0149203 100644 --- a/test/test_ezsignformfield_request_compound.py +++ b/test/test_ezsignformfield_request_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignformfield_request_compound import EzsignformfieldRequestCompound # noqa: E501 +from eZmaxApi.models.ezsignformfield_request_compound import EzsignformfieldRequestCompound class TestEzsignformfieldRequestCompound(unittest.TestCase): """EzsignformfieldRequestCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignformfieldRequestCompound: optional params are included """ # uncomment below to create an instance of `EzsignformfieldRequestCompound` """ - model = EzsignformfieldRequestCompound() # noqa: E501 + model = EzsignformfieldRequestCompound() if include_optional: return EzsignformfieldRequestCompound( pki_ezsignformfield_id = 32, diff --git a/test/test_ezsignformfield_response.py b/test/test_ezsignformfield_response.py index 3df1a3a4c..151cf4a68 100644 --- a/test/test_ezsignformfield_response.py +++ b/test/test_ezsignformfield_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignformfield_response import EzsignformfieldResponse # noqa: E501 +from eZmaxApi.models.ezsignformfield_response import EzsignformfieldResponse class TestEzsignformfieldResponse(unittest.TestCase): """EzsignformfieldResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignformfieldResponse: optional params are included """ # uncomment below to create an instance of `EzsignformfieldResponse` """ - model = EzsignformfieldResponse() # noqa: E501 + model = EzsignformfieldResponse() if include_optional: return EzsignformfieldResponse( pki_ezsignformfield_id = 32, diff --git a/test/test_ezsignformfield_response_compound.py b/test/test_ezsignformfield_response_compound.py index 17831c486..dfd3f719f 100644 --- a/test/test_ezsignformfield_response_compound.py +++ b/test/test_ezsignformfield_response_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignformfield_response_compound import EzsignformfieldResponseCompound # noqa: E501 +from eZmaxApi.models.ezsignformfield_response_compound import EzsignformfieldResponseCompound class TestEzsignformfieldResponseCompound(unittest.TestCase): """EzsignformfieldResponseCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignformfieldResponseCompound: optional params are included """ # uncomment below to create an instance of `EzsignformfieldResponseCompound` """ - model = EzsignformfieldResponseCompound() # noqa: E501 + model = EzsignformfieldResponseCompound() if include_optional: return EzsignformfieldResponseCompound( pki_ezsignformfield_id = 32, diff --git a/test/test_ezsignformfieldgroup_create_object_v1_request.py b/test/test_ezsignformfieldgroup_create_object_v1_request.py index 0fc95d073..56c16f581 100644 --- a/test/test_ezsignformfieldgroup_create_object_v1_request.py +++ b/test/test_ezsignformfieldgroup_create_object_v1_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignformfieldgroup_create_object_v1_request import EzsignformfieldgroupCreateObjectV1Request # noqa: E501 +from eZmaxApi.models.ezsignformfieldgroup_create_object_v1_request import EzsignformfieldgroupCreateObjectV1Request class TestEzsignformfieldgroupCreateObjectV1Request(unittest.TestCase): """EzsignformfieldgroupCreateObjectV1Request unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignformfieldgroupCreateObjectV1R optional params are included """ # uncomment below to create an instance of `EzsignformfieldgroupCreateObjectV1Request` """ - model = EzsignformfieldgroupCreateObjectV1Request() # noqa: E501 + model = EzsignformfieldgroupCreateObjectV1Request() if include_optional: return EzsignformfieldgroupCreateObjectV1Request( a_obj_ezsignformfieldgroup = [ diff --git a/test/test_ezsignformfieldgroup_create_object_v1_response.py b/test/test_ezsignformfieldgroup_create_object_v1_response.py index 4e82cc925..7ebac29ab 100644 --- a/test/test_ezsignformfieldgroup_create_object_v1_response.py +++ b/test/test_ezsignformfieldgroup_create_object_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignformfieldgroup_create_object_v1_response import EzsignformfieldgroupCreateObjectV1Response # noqa: E501 +from eZmaxApi.models.ezsignformfieldgroup_create_object_v1_response import EzsignformfieldgroupCreateObjectV1Response class TestEzsignformfieldgroupCreateObjectV1Response(unittest.TestCase): """EzsignformfieldgroupCreateObjectV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignformfieldgroupCreateObjectV1R optional params are included """ # uncomment below to create an instance of `EzsignformfieldgroupCreateObjectV1Response` """ - model = EzsignformfieldgroupCreateObjectV1Response() # noqa: E501 + model = EzsignformfieldgroupCreateObjectV1Response() if include_optional: return EzsignformfieldgroupCreateObjectV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsignformfieldgroup_create_object_v1_response_m_payload.py b/test/test_ezsignformfieldgroup_create_object_v1_response_m_payload.py index ee1af5bb4..8568b3eb4 100644 --- a/test/test_ezsignformfieldgroup_create_object_v1_response_m_payload.py +++ b/test/test_ezsignformfieldgroup_create_object_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignformfieldgroup_create_object_v1_response_m_payload import EzsignformfieldgroupCreateObjectV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezsignformfieldgroup_create_object_v1_response_m_payload import EzsignformfieldgroupCreateObjectV1ResponseMPayload class TestEzsignformfieldgroupCreateObjectV1ResponseMPayload(unittest.TestCase): """EzsignformfieldgroupCreateObjectV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignformfieldgroupCreateObjectV1R optional params are included """ # uncomment below to create an instance of `EzsignformfieldgroupCreateObjectV1ResponseMPayload` """ - model = EzsignformfieldgroupCreateObjectV1ResponseMPayload() # noqa: E501 + model = EzsignformfieldgroupCreateObjectV1ResponseMPayload() if include_optional: return EzsignformfieldgroupCreateObjectV1ResponseMPayload( a_pki_ezsignformfieldgroup_id = [ diff --git a/test/test_ezsignformfieldgroup_delete_object_v1_response.py b/test/test_ezsignformfieldgroup_delete_object_v1_response.py index 45d3a2e31..99766524a 100644 --- a/test/test_ezsignformfieldgroup_delete_object_v1_response.py +++ b/test/test_ezsignformfieldgroup_delete_object_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignformfieldgroup_delete_object_v1_response import EzsignformfieldgroupDeleteObjectV1Response # noqa: E501 +from eZmaxApi.models.ezsignformfieldgroup_delete_object_v1_response import EzsignformfieldgroupDeleteObjectV1Response class TestEzsignformfieldgroupDeleteObjectV1Response(unittest.TestCase): """EzsignformfieldgroupDeleteObjectV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignformfieldgroupDeleteObjectV1R optional params are included """ # uncomment below to create an instance of `EzsignformfieldgroupDeleteObjectV1Response` """ - model = EzsignformfieldgroupDeleteObjectV1Response() # noqa: E501 + model = EzsignformfieldgroupDeleteObjectV1Response() if include_optional: return EzsignformfieldgroupDeleteObjectV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsignformfieldgroup_edit_object_v1_request.py b/test/test_ezsignformfieldgroup_edit_object_v1_request.py index 202cf6f39..b6d5e33e0 100644 --- a/test/test_ezsignformfieldgroup_edit_object_v1_request.py +++ b/test/test_ezsignformfieldgroup_edit_object_v1_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignformfieldgroup_edit_object_v1_request import EzsignformfieldgroupEditObjectV1Request # noqa: E501 +from eZmaxApi.models.ezsignformfieldgroup_edit_object_v1_request import EzsignformfieldgroupEditObjectV1Request class TestEzsignformfieldgroupEditObjectV1Request(unittest.TestCase): """EzsignformfieldgroupEditObjectV1Request unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignformfieldgroupEditObjectV1Req optional params are included """ # uncomment below to create an instance of `EzsignformfieldgroupEditObjectV1Request` """ - model = EzsignformfieldgroupEditObjectV1Request() # noqa: E501 + model = EzsignformfieldgroupEditObjectV1Request() if include_optional: return EzsignformfieldgroupEditObjectV1Request( obj_ezsignformfieldgroup = eZmaxApi.models.ezsignformfieldgroup_request_compound.ezsignformfieldgroup-RequestCompound() diff --git a/test/test_ezsignformfieldgroup_edit_object_v1_response.py b/test/test_ezsignformfieldgroup_edit_object_v1_response.py index 4925dd035..88b4e9310 100644 --- a/test/test_ezsignformfieldgroup_edit_object_v1_response.py +++ b/test/test_ezsignformfieldgroup_edit_object_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignformfieldgroup_edit_object_v1_response import EzsignformfieldgroupEditObjectV1Response # noqa: E501 +from eZmaxApi.models.ezsignformfieldgroup_edit_object_v1_response import EzsignformfieldgroupEditObjectV1Response class TestEzsignformfieldgroupEditObjectV1Response(unittest.TestCase): """EzsignformfieldgroupEditObjectV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignformfieldgroupEditObjectV1Res optional params are included """ # uncomment below to create an instance of `EzsignformfieldgroupEditObjectV1Response` """ - model = EzsignformfieldgroupEditObjectV1Response() # noqa: E501 + model = EzsignformfieldgroupEditObjectV1Response() if include_optional: return EzsignformfieldgroupEditObjectV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsignformfieldgroup_get_object_v2_response.py b/test/test_ezsignformfieldgroup_get_object_v2_response.py index 0e34da51a..42217e40e 100644 --- a/test/test_ezsignformfieldgroup_get_object_v2_response.py +++ b/test/test_ezsignformfieldgroup_get_object_v2_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignformfieldgroup_get_object_v2_response import EzsignformfieldgroupGetObjectV2Response # noqa: E501 +from eZmaxApi.models.ezsignformfieldgroup_get_object_v2_response import EzsignformfieldgroupGetObjectV2Response class TestEzsignformfieldgroupGetObjectV2Response(unittest.TestCase): """EzsignformfieldgroupGetObjectV2Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignformfieldgroupGetObjectV2Resp optional params are included """ # uncomment below to create an instance of `EzsignformfieldgroupGetObjectV2Response` """ - model = EzsignformfieldgroupGetObjectV2Response() # noqa: E501 + model = EzsignformfieldgroupGetObjectV2Response() if include_optional: return EzsignformfieldgroupGetObjectV2Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsignformfieldgroup_get_object_v2_response_m_payload.py b/test/test_ezsignformfieldgroup_get_object_v2_response_m_payload.py index 557b14268..dee347ad5 100644 --- a/test/test_ezsignformfieldgroup_get_object_v2_response_m_payload.py +++ b/test/test_ezsignformfieldgroup_get_object_v2_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignformfieldgroup_get_object_v2_response_m_payload import EzsignformfieldgroupGetObjectV2ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezsignformfieldgroup_get_object_v2_response_m_payload import EzsignformfieldgroupGetObjectV2ResponseMPayload class TestEzsignformfieldgroupGetObjectV2ResponseMPayload(unittest.TestCase): """EzsignformfieldgroupGetObjectV2ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignformfieldgroupGetObjectV2Resp optional params are included """ # uncomment below to create an instance of `EzsignformfieldgroupGetObjectV2ResponseMPayload` """ - model = EzsignformfieldgroupGetObjectV2ResponseMPayload() # noqa: E501 + model = EzsignformfieldgroupGetObjectV2ResponseMPayload() if include_optional: return EzsignformfieldgroupGetObjectV2ResponseMPayload( obj_ezsignformfieldgroup = eZmaxApi.models.ezsignformfieldgroup_response_compound.ezsignformfieldgroup-ResponseCompound() diff --git a/test/test_ezsignformfieldgroup_request.py b/test/test_ezsignformfieldgroup_request.py index 150a941ff..d0f250996 100644 --- a/test/test_ezsignformfieldgroup_request.py +++ b/test/test_ezsignformfieldgroup_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignformfieldgroup_request import EzsignformfieldgroupRequest # noqa: E501 +from eZmaxApi.models.ezsignformfieldgroup_request import EzsignformfieldgroupRequest class TestEzsignformfieldgroupRequest(unittest.TestCase): """EzsignformfieldgroupRequest unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignformfieldgroupRequest: optional params are included """ # uncomment below to create an instance of `EzsignformfieldgroupRequest` """ - model = EzsignformfieldgroupRequest() # noqa: E501 + model = EzsignformfieldgroupRequest() if include_optional: return EzsignformfieldgroupRequest( pki_ezsignformfieldgroup_id = 26, diff --git a/test/test_ezsignformfieldgroup_request_compound.py b/test/test_ezsignformfieldgroup_request_compound.py index 4419a0ff6..5869648f3 100644 --- a/test/test_ezsignformfieldgroup_request_compound.py +++ b/test/test_ezsignformfieldgroup_request_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignformfieldgroup_request_compound import EzsignformfieldgroupRequestCompound # noqa: E501 +from eZmaxApi.models.ezsignformfieldgroup_request_compound import EzsignformfieldgroupRequestCompound class TestEzsignformfieldgroupRequestCompound(unittest.TestCase): """EzsignformfieldgroupRequestCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignformfieldgroupRequestCompound optional params are included """ # uncomment below to create an instance of `EzsignformfieldgroupRequestCompound` """ - model = EzsignformfieldgroupRequestCompound() # noqa: E501 + model = EzsignformfieldgroupRequestCompound() if include_optional: return EzsignformfieldgroupRequestCompound( pki_ezsignformfieldgroup_id = 26, diff --git a/test/test_ezsignformfieldgroup_response.py b/test/test_ezsignformfieldgroup_response.py index a371f5e2f..88b1a7931 100644 --- a/test/test_ezsignformfieldgroup_response.py +++ b/test/test_ezsignformfieldgroup_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignformfieldgroup_response import EzsignformfieldgroupResponse # noqa: E501 +from eZmaxApi.models.ezsignformfieldgroup_response import EzsignformfieldgroupResponse class TestEzsignformfieldgroupResponse(unittest.TestCase): """EzsignformfieldgroupResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignformfieldgroupResponse: optional params are included """ # uncomment below to create an instance of `EzsignformfieldgroupResponse` """ - model = EzsignformfieldgroupResponse() # noqa: E501 + model = EzsignformfieldgroupResponse() if include_optional: return EzsignformfieldgroupResponse( pki_ezsignformfieldgroup_id = 26, diff --git a/test/test_ezsignformfieldgroup_response_compound.py b/test/test_ezsignformfieldgroup_response_compound.py index 2550f66dc..1fd9051be 100644 --- a/test/test_ezsignformfieldgroup_response_compound.py +++ b/test/test_ezsignformfieldgroup_response_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignformfieldgroup_response_compound import EzsignformfieldgroupResponseCompound # noqa: E501 +from eZmaxApi.models.ezsignformfieldgroup_response_compound import EzsignformfieldgroupResponseCompound class TestEzsignformfieldgroupResponseCompound(unittest.TestCase): """EzsignformfieldgroupResponseCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignformfieldgroupResponseCompoun optional params are included """ # uncomment below to create an instance of `EzsignformfieldgroupResponseCompound` """ - model = EzsignformfieldgroupResponseCompound() # noqa: E501 + model = EzsignformfieldgroupResponseCompound() if include_optional: return EzsignformfieldgroupResponseCompound( pki_ezsignformfieldgroup_id = 26, diff --git a/test/test_ezsignformfieldgroupsigner_request.py b/test/test_ezsignformfieldgroupsigner_request.py index ba5e5f610..dfbfe9c85 100644 --- a/test/test_ezsignformfieldgroupsigner_request.py +++ b/test/test_ezsignformfieldgroupsigner_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignformfieldgroupsigner_request import EzsignformfieldgroupsignerRequest # noqa: E501 +from eZmaxApi.models.ezsignformfieldgroupsigner_request import EzsignformfieldgroupsignerRequest class TestEzsignformfieldgroupsignerRequest(unittest.TestCase): """EzsignformfieldgroupsignerRequest unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignformfieldgroupsignerRequest: optional params are included """ # uncomment below to create an instance of `EzsignformfieldgroupsignerRequest` """ - model = EzsignformfieldgroupsignerRequest() # noqa: E501 + model = EzsignformfieldgroupsignerRequest() if include_optional: return EzsignformfieldgroupsignerRequest( pki_ezsignformfieldgroupsigner_id = 81, diff --git a/test/test_ezsignformfieldgroupsigner_request_compound.py b/test/test_ezsignformfieldgroupsigner_request_compound.py index 4cfc41a57..64e3293f9 100644 --- a/test/test_ezsignformfieldgroupsigner_request_compound.py +++ b/test/test_ezsignformfieldgroupsigner_request_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignformfieldgroupsigner_request_compound import EzsignformfieldgroupsignerRequestCompound # noqa: E501 +from eZmaxApi.models.ezsignformfieldgroupsigner_request_compound import EzsignformfieldgroupsignerRequestCompound class TestEzsignformfieldgroupsignerRequestCompound(unittest.TestCase): """EzsignformfieldgroupsignerRequestCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignformfieldgroupsignerRequestCo optional params are included """ # uncomment below to create an instance of `EzsignformfieldgroupsignerRequestCompound` """ - model = EzsignformfieldgroupsignerRequestCompound() # noqa: E501 + model = EzsignformfieldgroupsignerRequestCompound() if include_optional: return EzsignformfieldgroupsignerRequestCompound( pki_ezsignformfieldgroupsigner_id = 81, diff --git a/test/test_ezsignformfieldgroupsigner_response.py b/test/test_ezsignformfieldgroupsigner_response.py index 5b38e7ad7..f01389c13 100644 --- a/test/test_ezsignformfieldgroupsigner_response.py +++ b/test/test_ezsignformfieldgroupsigner_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignformfieldgroupsigner_response import EzsignformfieldgroupsignerResponse # noqa: E501 +from eZmaxApi.models.ezsignformfieldgroupsigner_response import EzsignformfieldgroupsignerResponse class TestEzsignformfieldgroupsignerResponse(unittest.TestCase): """EzsignformfieldgroupsignerResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignformfieldgroupsignerResponse: optional params are included """ # uncomment below to create an instance of `EzsignformfieldgroupsignerResponse` """ - model = EzsignformfieldgroupsignerResponse() # noqa: E501 + model = EzsignformfieldgroupsignerResponse() if include_optional: return EzsignformfieldgroupsignerResponse( pki_ezsignformfieldgroupsigner_id = 81, diff --git a/test/test_ezsignformfieldgroupsigner_response_compound.py b/test/test_ezsignformfieldgroupsigner_response_compound.py index c10ab0c0b..be5982a76 100644 --- a/test/test_ezsignformfieldgroupsigner_response_compound.py +++ b/test/test_ezsignformfieldgroupsigner_response_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignformfieldgroupsigner_response_compound import EzsignformfieldgroupsignerResponseCompound # noqa: E501 +from eZmaxApi.models.ezsignformfieldgroupsigner_response_compound import EzsignformfieldgroupsignerResponseCompound class TestEzsignformfieldgroupsignerResponseCompound(unittest.TestCase): """EzsignformfieldgroupsignerResponseCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignformfieldgroupsignerResponseC optional params are included """ # uncomment below to create an instance of `EzsignformfieldgroupsignerResponseCompound` """ - model = EzsignformfieldgroupsignerResponseCompound() # noqa: E501 + model = EzsignformfieldgroupsignerResponseCompound() if include_optional: return EzsignformfieldgroupsignerResponseCompound( pki_ezsignformfieldgroupsigner_id = 81, diff --git a/test/test_ezsignpage_consult_v1_response.py b/test/test_ezsignpage_consult_v1_response.py index ed79133db..47124f0a4 100644 --- a/test/test_ezsignpage_consult_v1_response.py +++ b/test/test_ezsignpage_consult_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignpage_consult_v1_response import EzsignpageConsultV1Response # noqa: E501 +from eZmaxApi.models.ezsignpage_consult_v1_response import EzsignpageConsultV1Response class TestEzsignpageConsultV1Response(unittest.TestCase): """EzsignpageConsultV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignpageConsultV1Response: optional params are included """ # uncomment below to create an instance of `EzsignpageConsultV1Response` """ - model = EzsignpageConsultV1Response() # noqa: E501 + model = EzsignpageConsultV1Response() if include_optional: return EzsignpageConsultV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsignpage_response.py b/test/test_ezsignpage_response.py index 9737fe27d..182577cfe 100644 --- a/test/test_ezsignpage_response.py +++ b/test/test_ezsignpage_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignpage_response import EzsignpageResponse # noqa: E501 +from eZmaxApi.models.ezsignpage_response import EzsignpageResponse class TestEzsignpageResponse(unittest.TestCase): """EzsignpageResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignpageResponse: optional params are included """ # uncomment below to create an instance of `EzsignpageResponse` """ - model = EzsignpageResponse() # noqa: E501 + model = EzsignpageResponse() if include_optional: return EzsignpageResponse( pki_ezsignpage_id = 64, diff --git a/test/test_ezsignpage_response_compound.py b/test/test_ezsignpage_response_compound.py index 8fca66cf3..d7bfd5e7e 100644 --- a/test/test_ezsignpage_response_compound.py +++ b/test/test_ezsignpage_response_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignpage_response_compound import EzsignpageResponseCompound # noqa: E501 +from eZmaxApi.models.ezsignpage_response_compound import EzsignpageResponseCompound class TestEzsignpageResponseCompound(unittest.TestCase): """EzsignpageResponseCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignpageResponseCompound: optional params are included """ # uncomment below to create an instance of `EzsignpageResponseCompound` """ - model = EzsignpageResponseCompound() # noqa: E501 + model = EzsignpageResponseCompound() if include_optional: return EzsignpageResponseCompound( pki_ezsignpage_id = 64, diff --git a/test/test_ezsignsignature_create_object_v1_request.py b/test/test_ezsignsignature_create_object_v1_request.py index fe4616eea..fdae3ded3 100644 --- a/test/test_ezsignsignature_create_object_v1_request.py +++ b/test/test_ezsignsignature_create_object_v1_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignsignature_create_object_v1_request import EzsignsignatureCreateObjectV1Request # noqa: E501 +from eZmaxApi.models.ezsignsignature_create_object_v1_request import EzsignsignatureCreateObjectV1Request class TestEzsignsignatureCreateObjectV1Request(unittest.TestCase): """EzsignsignatureCreateObjectV1Request unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignsignatureCreateObjectV1Reques optional params are included """ # uncomment below to create an instance of `EzsignsignatureCreateObjectV1Request` """ - model = EzsignsignatureCreateObjectV1Request() # noqa: E501 + model = EzsignsignatureCreateObjectV1Request() if include_optional: return EzsignsignatureCreateObjectV1Request( obj_ezsignsignature = eZmaxApi.models.ezsignsignature_request.ezsignsignature-Request( diff --git a/test/test_ezsignsignature_create_object_v1_response.py b/test/test_ezsignsignature_create_object_v1_response.py index 5fb5e1713..90166fb70 100644 --- a/test/test_ezsignsignature_create_object_v1_response.py +++ b/test/test_ezsignsignature_create_object_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignsignature_create_object_v1_response import EzsignsignatureCreateObjectV1Response # noqa: E501 +from eZmaxApi.models.ezsignsignature_create_object_v1_response import EzsignsignatureCreateObjectV1Response class TestEzsignsignatureCreateObjectV1Response(unittest.TestCase): """EzsignsignatureCreateObjectV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignsignatureCreateObjectV1Respon optional params are included """ # uncomment below to create an instance of `EzsignsignatureCreateObjectV1Response` """ - model = EzsignsignatureCreateObjectV1Response() # noqa: E501 + model = EzsignsignatureCreateObjectV1Response() if include_optional: return EzsignsignatureCreateObjectV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsignsignature_create_object_v1_response_m_payload.py b/test/test_ezsignsignature_create_object_v1_response_m_payload.py index 2eee2f2e6..90c05b12c 100644 --- a/test/test_ezsignsignature_create_object_v1_response_m_payload.py +++ b/test/test_ezsignsignature_create_object_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignsignature_create_object_v1_response_m_payload import EzsignsignatureCreateObjectV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezsignsignature_create_object_v1_response_m_payload import EzsignsignatureCreateObjectV1ResponseMPayload class TestEzsignsignatureCreateObjectV1ResponseMPayload(unittest.TestCase): """EzsignsignatureCreateObjectV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignsignatureCreateObjectV1Respon optional params are included """ # uncomment below to create an instance of `EzsignsignatureCreateObjectV1ResponseMPayload` """ - model = EzsignsignatureCreateObjectV1ResponseMPayload() # noqa: E501 + model = EzsignsignatureCreateObjectV1ResponseMPayload() if include_optional: return EzsignsignatureCreateObjectV1ResponseMPayload( a_pki_ezsignsignature_id = [ diff --git a/test/test_ezsignsignature_create_object_v2_request.py b/test/test_ezsignsignature_create_object_v2_request.py index aabd1aed0..24885ca0e 100644 --- a/test/test_ezsignsignature_create_object_v2_request.py +++ b/test/test_ezsignsignature_create_object_v2_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignsignature_create_object_v2_request import EzsignsignatureCreateObjectV2Request # noqa: E501 +from eZmaxApi.models.ezsignsignature_create_object_v2_request import EzsignsignatureCreateObjectV2Request class TestEzsignsignatureCreateObjectV2Request(unittest.TestCase): """EzsignsignatureCreateObjectV2Request unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignsignatureCreateObjectV2Reques optional params are included """ # uncomment below to create an instance of `EzsignsignatureCreateObjectV2Request` """ - model = EzsignsignatureCreateObjectV2Request() # noqa: E501 + model = EzsignsignatureCreateObjectV2Request() if include_optional: return EzsignsignatureCreateObjectV2Request( a_obj_ezsignsignature = [ diff --git a/test/test_ezsignsignature_create_object_v2_response.py b/test/test_ezsignsignature_create_object_v2_response.py index 474c7c6ed..1696d6a1f 100644 --- a/test/test_ezsignsignature_create_object_v2_response.py +++ b/test/test_ezsignsignature_create_object_v2_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignsignature_create_object_v2_response import EzsignsignatureCreateObjectV2Response # noqa: E501 +from eZmaxApi.models.ezsignsignature_create_object_v2_response import EzsignsignatureCreateObjectV2Response class TestEzsignsignatureCreateObjectV2Response(unittest.TestCase): """EzsignsignatureCreateObjectV2Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignsignatureCreateObjectV2Respon optional params are included """ # uncomment below to create an instance of `EzsignsignatureCreateObjectV2Response` """ - model = EzsignsignatureCreateObjectV2Response() # noqa: E501 + model = EzsignsignatureCreateObjectV2Response() if include_optional: return EzsignsignatureCreateObjectV2Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsignsignature_create_object_v2_response_m_payload.py b/test/test_ezsignsignature_create_object_v2_response_m_payload.py index a08ee7196..ad0474b70 100644 --- a/test/test_ezsignsignature_create_object_v2_response_m_payload.py +++ b/test/test_ezsignsignature_create_object_v2_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignsignature_create_object_v2_response_m_payload import EzsignsignatureCreateObjectV2ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezsignsignature_create_object_v2_response_m_payload import EzsignsignatureCreateObjectV2ResponseMPayload class TestEzsignsignatureCreateObjectV2ResponseMPayload(unittest.TestCase): """EzsignsignatureCreateObjectV2ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignsignatureCreateObjectV2Respon optional params are included """ # uncomment below to create an instance of `EzsignsignatureCreateObjectV2ResponseMPayload` """ - model = EzsignsignatureCreateObjectV2ResponseMPayload() # noqa: E501 + model = EzsignsignatureCreateObjectV2ResponseMPayload() if include_optional: return EzsignsignatureCreateObjectV2ResponseMPayload( a_pki_ezsignsignature_id = [ diff --git a/test/test_ezsignsignature_delete_object_v1_response.py b/test/test_ezsignsignature_delete_object_v1_response.py index 2bb649dcb..63442dd77 100644 --- a/test/test_ezsignsignature_delete_object_v1_response.py +++ b/test/test_ezsignsignature_delete_object_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignsignature_delete_object_v1_response import EzsignsignatureDeleteObjectV1Response # noqa: E501 +from eZmaxApi.models.ezsignsignature_delete_object_v1_response import EzsignsignatureDeleteObjectV1Response class TestEzsignsignatureDeleteObjectV1Response(unittest.TestCase): """EzsignsignatureDeleteObjectV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignsignatureDeleteObjectV1Respon optional params are included """ # uncomment below to create an instance of `EzsignsignatureDeleteObjectV1Response` """ - model = EzsignsignatureDeleteObjectV1Response() # noqa: E501 + model = EzsignsignatureDeleteObjectV1Response() if include_optional: return EzsignsignatureDeleteObjectV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsignsignature_edit_object_v1_request.py b/test/test_ezsignsignature_edit_object_v1_request.py index a05ce1fed..8f6431e8e 100644 --- a/test/test_ezsignsignature_edit_object_v1_request.py +++ b/test/test_ezsignsignature_edit_object_v1_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignsignature_edit_object_v1_request import EzsignsignatureEditObjectV1Request # noqa: E501 +from eZmaxApi.models.ezsignsignature_edit_object_v1_request import EzsignsignatureEditObjectV1Request class TestEzsignsignatureEditObjectV1Request(unittest.TestCase): """EzsignsignatureEditObjectV1Request unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignsignatureEditObjectV1Request: optional params are included """ # uncomment below to create an instance of `EzsignsignatureEditObjectV1Request` """ - model = EzsignsignatureEditObjectV1Request() # noqa: E501 + model = EzsignsignatureEditObjectV1Request() if include_optional: return EzsignsignatureEditObjectV1Request( obj_ezsignsignature = eZmaxApi.models.ezsignsignature_request_compound.ezsignsignature-RequestCompound() diff --git a/test/test_ezsignsignature_edit_object_v1_response.py b/test/test_ezsignsignature_edit_object_v1_response.py index 096be0a59..f5f9b4a81 100644 --- a/test/test_ezsignsignature_edit_object_v1_response.py +++ b/test/test_ezsignsignature_edit_object_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignsignature_edit_object_v1_response import EzsignsignatureEditObjectV1Response # noqa: E501 +from eZmaxApi.models.ezsignsignature_edit_object_v1_response import EzsignsignatureEditObjectV1Response class TestEzsignsignatureEditObjectV1Response(unittest.TestCase): """EzsignsignatureEditObjectV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignsignatureEditObjectV1Response optional params are included """ # uncomment below to create an instance of `EzsignsignatureEditObjectV1Response` """ - model = EzsignsignatureEditObjectV1Response() # noqa: E501 + model = EzsignsignatureEditObjectV1Response() if include_optional: return EzsignsignatureEditObjectV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsignsignature_get_ezsignsignatureattachment_v1_response.py b/test/test_ezsignsignature_get_ezsignsignatureattachment_v1_response.py index fe635ef20..c94d802d0 100644 --- a/test/test_ezsignsignature_get_ezsignsignatureattachment_v1_response.py +++ b/test/test_ezsignsignature_get_ezsignsignatureattachment_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignsignature_get_ezsignsignatureattachment_v1_response import EzsignsignatureGetEzsignsignatureattachmentV1Response # noqa: E501 +from eZmaxApi.models.ezsignsignature_get_ezsignsignatureattachment_v1_response import EzsignsignatureGetEzsignsignatureattachmentV1Response class TestEzsignsignatureGetEzsignsignatureattachmentV1Response(unittest.TestCase): """EzsignsignatureGetEzsignsignatureattachmentV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignsignatureGetEzsignsignatureat optional params are included """ # uncomment below to create an instance of `EzsignsignatureGetEzsignsignatureattachmentV1Response` """ - model = EzsignsignatureGetEzsignsignatureattachmentV1Response() # noqa: E501 + model = EzsignsignatureGetEzsignsignatureattachmentV1Response() if include_optional: return EzsignsignatureGetEzsignsignatureattachmentV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsignsignature_get_ezsignsignatureattachment_v1_response_m_payload.py b/test/test_ezsignsignature_get_ezsignsignatureattachment_v1_response_m_payload.py index ef9dfb917..a32ce1c53 100644 --- a/test/test_ezsignsignature_get_ezsignsignatureattachment_v1_response_m_payload.py +++ b/test/test_ezsignsignature_get_ezsignsignatureattachment_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignsignature_get_ezsignsignatureattachment_v1_response_m_payload import EzsignsignatureGetEzsignsignatureattachmentV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezsignsignature_get_ezsignsignatureattachment_v1_response_m_payload import EzsignsignatureGetEzsignsignatureattachmentV1ResponseMPayload class TestEzsignsignatureGetEzsignsignatureattachmentV1ResponseMPayload(unittest.TestCase): """EzsignsignatureGetEzsignsignatureattachmentV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignsignatureGetEzsignsignatureat optional params are included """ # uncomment below to create an instance of `EzsignsignatureGetEzsignsignatureattachmentV1ResponseMPayload` """ - model = EzsignsignatureGetEzsignsignatureattachmentV1ResponseMPayload() # noqa: E501 + model = EzsignsignatureGetEzsignsignatureattachmentV1ResponseMPayload() if include_optional: return EzsignsignatureGetEzsignsignatureattachmentV1ResponseMPayload( a_obj_ezsignsignatureattachment = [ diff --git a/test/test_ezsignsignature_get_ezsignsignatures_automatic_v1_response.py b/test/test_ezsignsignature_get_ezsignsignatures_automatic_v1_response.py index 40e87ca3f..799b35478 100644 --- a/test/test_ezsignsignature_get_ezsignsignatures_automatic_v1_response.py +++ b/test/test_ezsignsignature_get_ezsignsignatures_automatic_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignsignature_get_ezsignsignatures_automatic_v1_response import EzsignsignatureGetEzsignsignaturesAutomaticV1Response # noqa: E501 +from eZmaxApi.models.ezsignsignature_get_ezsignsignatures_automatic_v1_response import EzsignsignatureGetEzsignsignaturesAutomaticV1Response class TestEzsignsignatureGetEzsignsignaturesAutomaticV1Response(unittest.TestCase): """EzsignsignatureGetEzsignsignaturesAutomaticV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignsignatureGetEzsignsignaturesA optional params are included """ # uncomment below to create an instance of `EzsignsignatureGetEzsignsignaturesAutomaticV1Response` """ - model = EzsignsignatureGetEzsignsignaturesAutomaticV1Response() # noqa: E501 + model = EzsignsignatureGetEzsignsignaturesAutomaticV1Response() if include_optional: return EzsignsignatureGetEzsignsignaturesAutomaticV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsignsignature_get_ezsignsignatures_automatic_v1_response_m_payload.py b/test/test_ezsignsignature_get_ezsignsignatures_automatic_v1_response_m_payload.py index 60ee16da6..1d1551c5f 100644 --- a/test/test_ezsignsignature_get_ezsignsignatures_automatic_v1_response_m_payload.py +++ b/test/test_ezsignsignature_get_ezsignsignatures_automatic_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignsignature_get_ezsignsignatures_automatic_v1_response_m_payload import EzsignsignatureGetEzsignsignaturesAutomaticV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezsignsignature_get_ezsignsignatures_automatic_v1_response_m_payload import EzsignsignatureGetEzsignsignaturesAutomaticV1ResponseMPayload class TestEzsignsignatureGetEzsignsignaturesAutomaticV1ResponseMPayload(unittest.TestCase): """EzsignsignatureGetEzsignsignaturesAutomaticV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignsignatureGetEzsignsignaturesA optional params are included """ # uncomment below to create an instance of `EzsignsignatureGetEzsignsignaturesAutomaticV1ResponseMPayload` """ - model = EzsignsignatureGetEzsignsignaturesAutomaticV1ResponseMPayload() # noqa: E501 + model = EzsignsignatureGetEzsignsignaturesAutomaticV1ResponseMPayload() if include_optional: return EzsignsignatureGetEzsignsignaturesAutomaticV1ResponseMPayload( a_e_ezsignsignature_type = [ diff --git a/test/test_ezsignsignature_get_object_v2_response.py b/test/test_ezsignsignature_get_object_v2_response.py index aa77501ad..cf279319c 100644 --- a/test/test_ezsignsignature_get_object_v2_response.py +++ b/test/test_ezsignsignature_get_object_v2_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignsignature_get_object_v2_response import EzsignsignatureGetObjectV2Response # noqa: E501 +from eZmaxApi.models.ezsignsignature_get_object_v2_response import EzsignsignatureGetObjectV2Response class TestEzsignsignatureGetObjectV2Response(unittest.TestCase): """EzsignsignatureGetObjectV2Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignsignatureGetObjectV2Response: optional params are included """ # uncomment below to create an instance of `EzsignsignatureGetObjectV2Response` """ - model = EzsignsignatureGetObjectV2Response() # noqa: E501 + model = EzsignsignatureGetObjectV2Response() if include_optional: return EzsignsignatureGetObjectV2Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsignsignature_get_object_v2_response_m_payload.py b/test/test_ezsignsignature_get_object_v2_response_m_payload.py index d00dfb3f5..c0dd9831c 100644 --- a/test/test_ezsignsignature_get_object_v2_response_m_payload.py +++ b/test/test_ezsignsignature_get_object_v2_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignsignature_get_object_v2_response_m_payload import EzsignsignatureGetObjectV2ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezsignsignature_get_object_v2_response_m_payload import EzsignsignatureGetObjectV2ResponseMPayload class TestEzsignsignatureGetObjectV2ResponseMPayload(unittest.TestCase): """EzsignsignatureGetObjectV2ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignsignatureGetObjectV2ResponseM optional params are included """ # uncomment below to create an instance of `EzsignsignatureGetObjectV2ResponseMPayload` """ - model = EzsignsignatureGetObjectV2ResponseMPayload() # noqa: E501 + model = EzsignsignatureGetObjectV2ResponseMPayload() if include_optional: return EzsignsignatureGetObjectV2ResponseMPayload( obj_ezsignsignature = eZmaxApi.models.ezsignsignature_response_compound.ezsignsignature-ResponseCompound() diff --git a/test/test_ezsignsignature_request.py b/test/test_ezsignsignature_request.py index d6ee02a35..8f697fdfc 100644 --- a/test/test_ezsignsignature_request.py +++ b/test/test_ezsignsignature_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignsignature_request import EzsignsignatureRequest # noqa: E501 +from eZmaxApi.models.ezsignsignature_request import EzsignsignatureRequest class TestEzsignsignatureRequest(unittest.TestCase): """EzsignsignatureRequest unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignsignatureRequest: optional params are included """ # uncomment below to create an instance of `EzsignsignatureRequest` """ - model = EzsignsignatureRequest() # noqa: E501 + model = EzsignsignatureRequest() if include_optional: return EzsignsignatureRequest( pki_ezsignsignature_id = 49, diff --git a/test/test_ezsignsignature_request_compound.py b/test/test_ezsignsignature_request_compound.py index e810c7f6b..0bb4a3921 100644 --- a/test/test_ezsignsignature_request_compound.py +++ b/test/test_ezsignsignature_request_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignsignature_request_compound import EzsignsignatureRequestCompound # noqa: E501 +from eZmaxApi.models.ezsignsignature_request_compound import EzsignsignatureRequestCompound class TestEzsignsignatureRequestCompound(unittest.TestCase): """EzsignsignatureRequestCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignsignatureRequestCompound: optional params are included """ # uncomment below to create an instance of `EzsignsignatureRequestCompound` """ - model = EzsignsignatureRequestCompound() # noqa: E501 + model = EzsignsignatureRequestCompound() if include_optional: return EzsignsignatureRequestCompound( pki_ezsignsignature_id = 49, diff --git a/test/test_ezsignsignature_response.py b/test/test_ezsignsignature_response.py index 46fe28c49..b942329c2 100644 --- a/test/test_ezsignsignature_response.py +++ b/test/test_ezsignsignature_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignsignature_response import EzsignsignatureResponse # noqa: E501 +from eZmaxApi.models.ezsignsignature_response import EzsignsignatureResponse class TestEzsignsignatureResponse(unittest.TestCase): """EzsignsignatureResponse unit test stubs""" @@ -34,12 +34,14 @@ def make_instance(self, include_optional) -> EzsignsignatureResponse: optional params are included """ # uncomment below to create an instance of `EzsignsignatureResponse` """ - model = EzsignsignatureResponse() # noqa: E501 + model = EzsignsignatureResponse() if include_optional: return EzsignsignatureResponse( pki_ezsignsignature_id = 49, fki_ezsigndocument_id = 97, fki_ezsignfoldersignerassociation_id = 20, + fki_ezsignsigningreason_id = 194, + s_ezsignsigningreason_description_x = 'I approve this document', i_ezsignpage_pagenumber = 1, i_ezsignsignature_x = 200, i_ezsignsignature_y = 300, diff --git a/test/test_ezsignsignature_response_compound.py b/test/test_ezsignsignature_response_compound.py index e29936719..2cca08742 100644 --- a/test/test_ezsignsignature_response_compound.py +++ b/test/test_ezsignsignature_response_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignsignature_response_compound import EzsignsignatureResponseCompound # noqa: E501 +from eZmaxApi.models.ezsignsignature_response_compound import EzsignsignatureResponseCompound class TestEzsignsignatureResponseCompound(unittest.TestCase): """EzsignsignatureResponseCompound unit test stubs""" @@ -34,12 +34,14 @@ def make_instance(self, include_optional) -> EzsignsignatureResponseCompound: optional params are included """ # uncomment below to create an instance of `EzsignsignatureResponseCompound` """ - model = EzsignsignatureResponseCompound() # noqa: E501 + model = EzsignsignatureResponseCompound() if include_optional: return EzsignsignatureResponseCompound( pki_ezsignsignature_id = 49, fki_ezsigndocument_id = 97, fki_ezsignfoldersignerassociation_id = 20, + fki_ezsignsigningreason_id = 194, + s_ezsignsigningreason_description_x = 'I approve this document', i_ezsignpage_pagenumber = 1, i_ezsignsignature_x = 200, i_ezsignsignature_y = 300, diff --git a/test/test_ezsignsignature_sign_v1_request.py b/test/test_ezsignsignature_sign_v1_request.py index 5d92489e4..669b8a9c6 100644 --- a/test/test_ezsignsignature_sign_v1_request.py +++ b/test/test_ezsignsignature_sign_v1_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignsignature_sign_v1_request import EzsignsignatureSignV1Request # noqa: E501 +from eZmaxApi.models.ezsignsignature_sign_v1_request import EzsignsignatureSignV1Request class TestEzsignsignatureSignV1Request(unittest.TestCase): """EzsignsignatureSignV1Request unit test stubs""" @@ -34,9 +34,10 @@ def make_instance(self, include_optional) -> EzsignsignatureSignV1Request: optional params are included """ # uncomment below to create an instance of `EzsignsignatureSignV1Request` """ - model = EzsignsignatureSignV1Request() # noqa: E501 + model = EzsignsignatureSignV1Request() if include_optional: return EzsignsignatureSignV1Request( + fki_ezsignsigningreason_id = 194, s_value = '', e_attachments_confirmation_decision = 'Accepted', s_attachments_refusal_reason = '', @@ -45,7 +46,7 @@ def make_instance(self, include_optional) -> EzsignsignatureSignV1Request: eZmaxApi.models.common_file.Common-File( s_file_name = 'example.pdf', s_file_url = '', - s_file_base64 = '[B@64337702', + s_file_base64 = '[B@f9d87b', e_file_source = 'Base64', ) ], b_is_automatic = True diff --git a/test/test_ezsignsignature_sign_v1_response.py b/test/test_ezsignsignature_sign_v1_response.py index e5c42ea85..2c00d2d8f 100644 --- a/test/test_ezsignsignature_sign_v1_response.py +++ b/test/test_ezsignsignature_sign_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignsignature_sign_v1_response import EzsignsignatureSignV1Response # noqa: E501 +from eZmaxApi.models.ezsignsignature_sign_v1_response import EzsignsignatureSignV1Response class TestEzsignsignatureSignV1Response(unittest.TestCase): """EzsignsignatureSignV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignsignatureSignV1Response: optional params are included """ # uncomment below to create an instance of `EzsignsignatureSignV1Response` """ - model = EzsignsignatureSignV1Response() # noqa: E501 + model = EzsignsignatureSignV1Response() if include_optional: return EzsignsignatureSignV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsignsignatureattachment_response.py b/test/test_ezsignsignatureattachment_response.py index 609f8aa6e..1d8405575 100644 --- a/test/test_ezsignsignatureattachment_response.py +++ b/test/test_ezsignsignatureattachment_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignsignatureattachment_response import EzsignsignatureattachmentResponse # noqa: E501 +from eZmaxApi.models.ezsignsignatureattachment_response import EzsignsignatureattachmentResponse class TestEzsignsignatureattachmentResponse(unittest.TestCase): """EzsignsignatureattachmentResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignsignatureattachmentResponse: optional params are included """ # uncomment below to create an instance of `EzsignsignatureattachmentResponse` """ - model = EzsignsignatureattachmentResponse() # noqa: E501 + model = EzsignsignatureattachmentResponse() if include_optional: return EzsignsignatureattachmentResponse( pki_ezsignsignatureattachment_id = 177, diff --git a/test/test_ezsignsignaturecustomdate_request.py b/test/test_ezsignsignaturecustomdate_request.py index c23359369..1ab1b52df 100644 --- a/test/test_ezsignsignaturecustomdate_request.py +++ b/test/test_ezsignsignaturecustomdate_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignsignaturecustomdate_request import EzsignsignaturecustomdateRequest # noqa: E501 +from eZmaxApi.models.ezsignsignaturecustomdate_request import EzsignsignaturecustomdateRequest class TestEzsignsignaturecustomdateRequest(unittest.TestCase): """EzsignsignaturecustomdateRequest unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignsignaturecustomdateRequest: optional params are included """ # uncomment below to create an instance of `EzsignsignaturecustomdateRequest` """ - model = EzsignsignaturecustomdateRequest() # noqa: E501 + model = EzsignsignaturecustomdateRequest() if include_optional: return EzsignsignaturecustomdateRequest( pki_ezsignsignaturecustomdate_id = 27, diff --git a/test/test_ezsignsignaturecustomdate_request_compound.py b/test/test_ezsignsignaturecustomdate_request_compound.py index fd6a01207..2943a57e0 100644 --- a/test/test_ezsignsignaturecustomdate_request_compound.py +++ b/test/test_ezsignsignaturecustomdate_request_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignsignaturecustomdate_request_compound import EzsignsignaturecustomdateRequestCompound # noqa: E501 +from eZmaxApi.models.ezsignsignaturecustomdate_request_compound import EzsignsignaturecustomdateRequestCompound class TestEzsignsignaturecustomdateRequestCompound(unittest.TestCase): """EzsignsignaturecustomdateRequestCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignsignaturecustomdateRequestCom optional params are included """ # uncomment below to create an instance of `EzsignsignaturecustomdateRequestCompound` """ - model = EzsignsignaturecustomdateRequestCompound() # noqa: E501 + model = EzsignsignaturecustomdateRequestCompound() if include_optional: return EzsignsignaturecustomdateRequestCompound( pki_ezsignsignaturecustomdate_id = 27, diff --git a/test/test_ezsignsignaturecustomdate_response.py b/test/test_ezsignsignaturecustomdate_response.py index 7bb8b14e7..6d0630165 100644 --- a/test/test_ezsignsignaturecustomdate_response.py +++ b/test/test_ezsignsignaturecustomdate_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignsignaturecustomdate_response import EzsignsignaturecustomdateResponse # noqa: E501 +from eZmaxApi.models.ezsignsignaturecustomdate_response import EzsignsignaturecustomdateResponse class TestEzsignsignaturecustomdateResponse(unittest.TestCase): """EzsignsignaturecustomdateResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignsignaturecustomdateResponse: optional params are included """ # uncomment below to create an instance of `EzsignsignaturecustomdateResponse` """ - model = EzsignsignaturecustomdateResponse() # noqa: E501 + model = EzsignsignaturecustomdateResponse() if include_optional: return EzsignsignaturecustomdateResponse( pki_ezsignsignaturecustomdate_id = 27, diff --git a/test/test_ezsignsignaturecustomdate_response_compound.py b/test/test_ezsignsignaturecustomdate_response_compound.py index b41ae0172..6600d0395 100644 --- a/test/test_ezsignsignaturecustomdate_response_compound.py +++ b/test/test_ezsignsignaturecustomdate_response_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignsignaturecustomdate_response_compound import EzsignsignaturecustomdateResponseCompound # noqa: E501 +from eZmaxApi.models.ezsignsignaturecustomdate_response_compound import EzsignsignaturecustomdateResponseCompound class TestEzsignsignaturecustomdateResponseCompound(unittest.TestCase): """EzsignsignaturecustomdateResponseCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignsignaturecustomdateResponseCo optional params are included """ # uncomment below to create an instance of `EzsignsignaturecustomdateResponseCompound` """ - model = EzsignsignaturecustomdateResponseCompound() # noqa: E501 + model = EzsignsignaturecustomdateResponseCompound() if include_optional: return EzsignsignaturecustomdateResponseCompound( pki_ezsignsignaturecustomdate_id = 27, diff --git a/test/test_ezsignsigner_request.py b/test/test_ezsignsigner_request.py index e929cbb0b..759e16a15 100644 --- a/test/test_ezsignsigner_request.py +++ b/test/test_ezsignsigner_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignsigner_request import EzsignsignerRequest # noqa: E501 +from eZmaxApi.models.ezsignsigner_request import EzsignsignerRequest class TestEzsignsignerRequest(unittest.TestCase): """EzsignsignerRequest unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignsignerRequest: optional params are included """ # uncomment below to create an instance of `EzsignsignerRequest` """ - model = EzsignsignerRequest() # noqa: E501 + model = EzsignsignerRequest() if include_optional: return EzsignsignerRequest( fki_userlogintype_id = 2, diff --git a/test/test_ezsignsigner_request_compound.py b/test/test_ezsignsigner_request_compound.py index 569d4c1b7..f88a35d25 100644 --- a/test/test_ezsignsigner_request_compound.py +++ b/test/test_ezsignsigner_request_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignsigner_request_compound import EzsignsignerRequestCompound # noqa: E501 +from eZmaxApi.models.ezsignsigner_request_compound import EzsignsignerRequestCompound class TestEzsignsignerRequestCompound(unittest.TestCase): """EzsignsignerRequestCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignsignerRequestCompound: optional params are included """ # uncomment below to create an instance of `EzsignsignerRequestCompound` """ - model = EzsignsignerRequestCompound() # noqa: E501 + model = EzsignsignerRequestCompound() if include_optional: return EzsignsignerRequestCompound( fki_userlogintype_id = 2, diff --git a/test/test_ezsignsigner_request_compound_contact.py b/test/test_ezsignsigner_request_compound_contact.py index 0157e7005..f25bee059 100644 --- a/test/test_ezsignsigner_request_compound_contact.py +++ b/test/test_ezsignsigner_request_compound_contact.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignsigner_request_compound_contact import EzsignsignerRequestCompoundContact # noqa: E501 +from eZmaxApi.models.ezsignsigner_request_compound_contact import EzsignsignerRequestCompoundContact class TestEzsignsignerRequestCompoundContact(unittest.TestCase): """EzsignsignerRequestCompoundContact unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignsignerRequestCompoundContact: optional params are included """ # uncomment below to create an instance of `EzsignsignerRequestCompoundContact` """ - model = EzsignsignerRequestCompoundContact() # noqa: E501 + model = EzsignsignerRequestCompoundContact() if include_optional: return EzsignsignerRequestCompoundContact( s_contact_firstname = 'John', diff --git a/test/test_ezsignsigner_response.py b/test/test_ezsignsigner_response.py index 7d741f29b..cf6aed0fa 100644 --- a/test/test_ezsignsigner_response.py +++ b/test/test_ezsignsigner_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignsigner_response import EzsignsignerResponse # noqa: E501 +from eZmaxApi.models.ezsignsigner_response import EzsignsignerResponse class TestEzsignsignerResponse(unittest.TestCase): """EzsignsignerResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignsignerResponse: optional params are included """ # uncomment below to create an instance of `EzsignsignerResponse` """ - model = EzsignsignerResponse() # noqa: E501 + model = EzsignsignerResponse() if include_optional: return EzsignsignerResponse( pki_ezsignsigner_id = 89, diff --git a/test/test_ezsignsigner_response_compound.py b/test/test_ezsignsigner_response_compound.py index 6205a6e5a..1926da5e0 100644 --- a/test/test_ezsignsigner_response_compound.py +++ b/test/test_ezsignsigner_response_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignsigner_response_compound import EzsignsignerResponseCompound # noqa: E501 +from eZmaxApi.models.ezsignsigner_response_compound import EzsignsignerResponseCompound class TestEzsignsignerResponseCompound(unittest.TestCase): """EzsignsignerResponseCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignsignerResponseCompound: optional params are included """ # uncomment below to create an instance of `EzsignsignerResponseCompound` """ - model = EzsignsignerResponseCompound() # noqa: E501 + model = EzsignsignerResponseCompound() if include_optional: return EzsignsignerResponseCompound( pki_ezsignsigner_id = 89, diff --git a/test/test_ezsignsigner_response_compound_contact.py b/test/test_ezsignsigner_response_compound_contact.py index d019c8da8..10013587c 100644 --- a/test/test_ezsignsigner_response_compound_contact.py +++ b/test/test_ezsignsigner_response_compound_contact.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignsigner_response_compound_contact import EzsignsignerResponseCompoundContact # noqa: E501 +from eZmaxApi.models.ezsignsigner_response_compound_contact import EzsignsignerResponseCompoundContact class TestEzsignsignerResponseCompoundContact(unittest.TestCase): """EzsignsignerResponseCompoundContact unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignsignerResponseCompoundContact optional params are included """ # uncomment below to create an instance of `EzsignsignerResponseCompoundContact` """ - model = EzsignsignerResponseCompoundContact() # noqa: E501 + model = EzsignsignerResponseCompoundContact() if include_optional: return EzsignsignerResponseCompoundContact( pki_contact_id = 21, diff --git a/test/test_ezsignsignergroup_create_object_v1_request.py b/test/test_ezsignsignergroup_create_object_v1_request.py index 0ce5b5c54..4540b02a4 100644 --- a/test/test_ezsignsignergroup_create_object_v1_request.py +++ b/test/test_ezsignsignergroup_create_object_v1_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignsignergroup_create_object_v1_request import EzsignsignergroupCreateObjectV1Request # noqa: E501 +from eZmaxApi.models.ezsignsignergroup_create_object_v1_request import EzsignsignergroupCreateObjectV1Request class TestEzsignsignergroupCreateObjectV1Request(unittest.TestCase): """EzsignsignergroupCreateObjectV1Request unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignsignergroupCreateObjectV1Requ optional params are included """ # uncomment below to create an instance of `EzsignsignergroupCreateObjectV1Request` """ - model = EzsignsignergroupCreateObjectV1Request() # noqa: E501 + model = EzsignsignergroupCreateObjectV1Request() if include_optional: return EzsignsignergroupCreateObjectV1Request( a_obj_ezsignsignergroup = [ diff --git a/test/test_ezsignsignergroup_create_object_v1_response.py b/test/test_ezsignsignergroup_create_object_v1_response.py index 997f55e79..d960f2f12 100644 --- a/test/test_ezsignsignergroup_create_object_v1_response.py +++ b/test/test_ezsignsignergroup_create_object_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignsignergroup_create_object_v1_response import EzsignsignergroupCreateObjectV1Response # noqa: E501 +from eZmaxApi.models.ezsignsignergroup_create_object_v1_response import EzsignsignergroupCreateObjectV1Response class TestEzsignsignergroupCreateObjectV1Response(unittest.TestCase): """EzsignsignergroupCreateObjectV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignsignergroupCreateObjectV1Resp optional params are included """ # uncomment below to create an instance of `EzsignsignergroupCreateObjectV1Response` """ - model = EzsignsignergroupCreateObjectV1Response() # noqa: E501 + model = EzsignsignergroupCreateObjectV1Response() if include_optional: return EzsignsignergroupCreateObjectV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsignsignergroup_create_object_v1_response_m_payload.py b/test/test_ezsignsignergroup_create_object_v1_response_m_payload.py index 57887fc4c..e4ba7e407 100644 --- a/test/test_ezsignsignergroup_create_object_v1_response_m_payload.py +++ b/test/test_ezsignsignergroup_create_object_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignsignergroup_create_object_v1_response_m_payload import EzsignsignergroupCreateObjectV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezsignsignergroup_create_object_v1_response_m_payload import EzsignsignergroupCreateObjectV1ResponseMPayload class TestEzsignsignergroupCreateObjectV1ResponseMPayload(unittest.TestCase): """EzsignsignergroupCreateObjectV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignsignergroupCreateObjectV1Resp optional params are included """ # uncomment below to create an instance of `EzsignsignergroupCreateObjectV1ResponseMPayload` """ - model = EzsignsignergroupCreateObjectV1ResponseMPayload() # noqa: E501 + model = EzsignsignergroupCreateObjectV1ResponseMPayload() if include_optional: return EzsignsignergroupCreateObjectV1ResponseMPayload( a_pki_ezsignsignergroup_id = [ diff --git a/test/test_ezsignsignergroup_delete_object_v1_response.py b/test/test_ezsignsignergroup_delete_object_v1_response.py index 46c3bce6f..24a190d4e 100644 --- a/test/test_ezsignsignergroup_delete_object_v1_response.py +++ b/test/test_ezsignsignergroup_delete_object_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignsignergroup_delete_object_v1_response import EzsignsignergroupDeleteObjectV1Response # noqa: E501 +from eZmaxApi.models.ezsignsignergroup_delete_object_v1_response import EzsignsignergroupDeleteObjectV1Response class TestEzsignsignergroupDeleteObjectV1Response(unittest.TestCase): """EzsignsignergroupDeleteObjectV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignsignergroupDeleteObjectV1Resp optional params are included """ # uncomment below to create an instance of `EzsignsignergroupDeleteObjectV1Response` """ - model = EzsignsignergroupDeleteObjectV1Response() # noqa: E501 + model = EzsignsignergroupDeleteObjectV1Response() if include_optional: return EzsignsignergroupDeleteObjectV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsignsignergroup_edit_ezsignsignergroupmemberships_v1_request.py b/test/test_ezsignsignergroup_edit_ezsignsignergroupmemberships_v1_request.py index 738fd812f..d3da28b7c 100644 --- a/test/test_ezsignsignergroup_edit_ezsignsignergroupmemberships_v1_request.py +++ b/test/test_ezsignsignergroup_edit_ezsignsignergroupmemberships_v1_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignsignergroup_edit_ezsignsignergroupmemberships_v1_request import EzsignsignergroupEditEzsignsignergroupmembershipsV1Request # noqa: E501 +from eZmaxApi.models.ezsignsignergroup_edit_ezsignsignergroupmemberships_v1_request import EzsignsignergroupEditEzsignsignergroupmembershipsV1Request class TestEzsignsignergroupEditEzsignsignergroupmembershipsV1Request(unittest.TestCase): """EzsignsignergroupEditEzsignsignergroupmembershipsV1Request unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignsignergroupEditEzsignsignergr optional params are included """ # uncomment below to create an instance of `EzsignsignergroupEditEzsignsignergroupmembershipsV1Request` """ - model = EzsignsignergroupEditEzsignsignergroupmembershipsV1Request() # noqa: E501 + model = EzsignsignergroupEditEzsignsignergroupmembershipsV1Request() if include_optional: return EzsignsignergroupEditEzsignsignergroupmembershipsV1Request( a_obj_ezsignsignergroupmembership = [ diff --git a/test/test_ezsignsignergroup_edit_ezsignsignergroupmemberships_v1_response.py b/test/test_ezsignsignergroup_edit_ezsignsignergroupmemberships_v1_response.py index 62fcb6da7..36c2eb407 100644 --- a/test/test_ezsignsignergroup_edit_ezsignsignergroupmemberships_v1_response.py +++ b/test/test_ezsignsignergroup_edit_ezsignsignergroupmemberships_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignsignergroup_edit_ezsignsignergroupmemberships_v1_response import EzsignsignergroupEditEzsignsignergroupmembershipsV1Response # noqa: E501 +from eZmaxApi.models.ezsignsignergroup_edit_ezsignsignergroupmemberships_v1_response import EzsignsignergroupEditEzsignsignergroupmembershipsV1Response class TestEzsignsignergroupEditEzsignsignergroupmembershipsV1Response(unittest.TestCase): """EzsignsignergroupEditEzsignsignergroupmembershipsV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignsignergroupEditEzsignsignergr optional params are included """ # uncomment below to create an instance of `EzsignsignergroupEditEzsignsignergroupmembershipsV1Response` """ - model = EzsignsignergroupEditEzsignsignergroupmembershipsV1Response() # noqa: E501 + model = EzsignsignergroupEditEzsignsignergroupmembershipsV1Response() if include_optional: return EzsignsignergroupEditEzsignsignergroupmembershipsV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsignsignergroup_edit_ezsignsignergroupmemberships_v1_response_m_payload.py b/test/test_ezsignsignergroup_edit_ezsignsignergroupmemberships_v1_response_m_payload.py index 374f43288..a382b3f38 100644 --- a/test/test_ezsignsignergroup_edit_ezsignsignergroupmemberships_v1_response_m_payload.py +++ b/test/test_ezsignsignergroup_edit_ezsignsignergroupmemberships_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignsignergroup_edit_ezsignsignergroupmemberships_v1_response_m_payload import EzsignsignergroupEditEzsignsignergroupmembershipsV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezsignsignergroup_edit_ezsignsignergroupmemberships_v1_response_m_payload import EzsignsignergroupEditEzsignsignergroupmembershipsV1ResponseMPayload class TestEzsignsignergroupEditEzsignsignergroupmembershipsV1ResponseMPayload(unittest.TestCase): """EzsignsignergroupEditEzsignsignergroupmembershipsV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignsignergroupEditEzsignsignergr optional params are included """ # uncomment below to create an instance of `EzsignsignergroupEditEzsignsignergroupmembershipsV1ResponseMPayload` """ - model = EzsignsignergroupEditEzsignsignergroupmembershipsV1ResponseMPayload() # noqa: E501 + model = EzsignsignergroupEditEzsignsignergroupmembershipsV1ResponseMPayload() if include_optional: return EzsignsignergroupEditEzsignsignergroupmembershipsV1ResponseMPayload( a_pki_ezsignsignergroupmembership_id = [ diff --git a/test/test_ezsignsignergroup_edit_object_v1_request.py b/test/test_ezsignsignergroup_edit_object_v1_request.py index bee9811b2..e3c2b2af7 100644 --- a/test/test_ezsignsignergroup_edit_object_v1_request.py +++ b/test/test_ezsignsignergroup_edit_object_v1_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignsignergroup_edit_object_v1_request import EzsignsignergroupEditObjectV1Request # noqa: E501 +from eZmaxApi.models.ezsignsignergroup_edit_object_v1_request import EzsignsignergroupEditObjectV1Request class TestEzsignsignergroupEditObjectV1Request(unittest.TestCase): """EzsignsignergroupEditObjectV1Request unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignsignergroupEditObjectV1Reques optional params are included """ # uncomment below to create an instance of `EzsignsignergroupEditObjectV1Request` """ - model = EzsignsignergroupEditObjectV1Request() # noqa: E501 + model = EzsignsignergroupEditObjectV1Request() if include_optional: return EzsignsignergroupEditObjectV1Request( obj_ezsignsignergroup = eZmaxApi.models.ezsignsignergroup_request_compound.ezsignsignergroup-RequestCompound() diff --git a/test/test_ezsignsignergroup_edit_object_v1_response.py b/test/test_ezsignsignergroup_edit_object_v1_response.py index 2526cd6f6..cfe969cc9 100644 --- a/test/test_ezsignsignergroup_edit_object_v1_response.py +++ b/test/test_ezsignsignergroup_edit_object_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignsignergroup_edit_object_v1_response import EzsignsignergroupEditObjectV1Response # noqa: E501 +from eZmaxApi.models.ezsignsignergroup_edit_object_v1_response import EzsignsignergroupEditObjectV1Response class TestEzsignsignergroupEditObjectV1Response(unittest.TestCase): """EzsignsignergroupEditObjectV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignsignergroupEditObjectV1Respon optional params are included """ # uncomment below to create an instance of `EzsignsignergroupEditObjectV1Response` """ - model = EzsignsignergroupEditObjectV1Response() # noqa: E501 + model = EzsignsignergroupEditObjectV1Response() if include_optional: return EzsignsignergroupEditObjectV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsignsignergroup_get_ezsignsignergroupmemberships_v1_response.py b/test/test_ezsignsignergroup_get_ezsignsignergroupmemberships_v1_response.py index 35b8cebff..de97b654d 100644 --- a/test/test_ezsignsignergroup_get_ezsignsignergroupmemberships_v1_response.py +++ b/test/test_ezsignsignergroup_get_ezsignsignergroupmemberships_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignsignergroup_get_ezsignsignergroupmemberships_v1_response import EzsignsignergroupGetEzsignsignergroupmembershipsV1Response # noqa: E501 +from eZmaxApi.models.ezsignsignergroup_get_ezsignsignergroupmemberships_v1_response import EzsignsignergroupGetEzsignsignergroupmembershipsV1Response class TestEzsignsignergroupGetEzsignsignergroupmembershipsV1Response(unittest.TestCase): """EzsignsignergroupGetEzsignsignergroupmembershipsV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignsignergroupGetEzsignsignergro optional params are included """ # uncomment below to create an instance of `EzsignsignergroupGetEzsignsignergroupmembershipsV1Response` """ - model = EzsignsignergroupGetEzsignsignergroupmembershipsV1Response() # noqa: E501 + model = EzsignsignergroupGetEzsignsignergroupmembershipsV1Response() if include_optional: return EzsignsignergroupGetEzsignsignergroupmembershipsV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsignsignergroup_get_ezsignsignergroupmemberships_v1_response_m_payload.py b/test/test_ezsignsignergroup_get_ezsignsignergroupmemberships_v1_response_m_payload.py index 42e827283..43a85a0d0 100644 --- a/test/test_ezsignsignergroup_get_ezsignsignergroupmemberships_v1_response_m_payload.py +++ b/test/test_ezsignsignergroup_get_ezsignsignergroupmemberships_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignsignergroup_get_ezsignsignergroupmemberships_v1_response_m_payload import EzsignsignergroupGetEzsignsignergroupmembershipsV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezsignsignergroup_get_ezsignsignergroupmemberships_v1_response_m_payload import EzsignsignergroupGetEzsignsignergroupmembershipsV1ResponseMPayload class TestEzsignsignergroupGetEzsignsignergroupmembershipsV1ResponseMPayload(unittest.TestCase): """EzsignsignergroupGetEzsignsignergroupmembershipsV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignsignergroupGetEzsignsignergro optional params are included """ # uncomment below to create an instance of `EzsignsignergroupGetEzsignsignergroupmembershipsV1ResponseMPayload` """ - model = EzsignsignergroupGetEzsignsignergroupmembershipsV1ResponseMPayload() # noqa: E501 + model = EzsignsignergroupGetEzsignsignergroupmembershipsV1ResponseMPayload() if include_optional: return EzsignsignergroupGetEzsignsignergroupmembershipsV1ResponseMPayload( a_obj_ezsignsignergroupmembership = [ diff --git a/test/test_ezsignsignergroup_get_object_v2_response.py b/test/test_ezsignsignergroup_get_object_v2_response.py index c6c8e2f72..8a0487867 100644 --- a/test/test_ezsignsignergroup_get_object_v2_response.py +++ b/test/test_ezsignsignergroup_get_object_v2_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignsignergroup_get_object_v2_response import EzsignsignergroupGetObjectV2Response # noqa: E501 +from eZmaxApi.models.ezsignsignergroup_get_object_v2_response import EzsignsignergroupGetObjectV2Response class TestEzsignsignergroupGetObjectV2Response(unittest.TestCase): """EzsignsignergroupGetObjectV2Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignsignergroupGetObjectV2Respons optional params are included """ # uncomment below to create an instance of `EzsignsignergroupGetObjectV2Response` """ - model = EzsignsignergroupGetObjectV2Response() # noqa: E501 + model = EzsignsignergroupGetObjectV2Response() if include_optional: return EzsignsignergroupGetObjectV2Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsignsignergroup_get_object_v2_response_m_payload.py b/test/test_ezsignsignergroup_get_object_v2_response_m_payload.py index d6b76455c..c0b06d425 100644 --- a/test/test_ezsignsignergroup_get_object_v2_response_m_payload.py +++ b/test/test_ezsignsignergroup_get_object_v2_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignsignergroup_get_object_v2_response_m_payload import EzsignsignergroupGetObjectV2ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezsignsignergroup_get_object_v2_response_m_payload import EzsignsignergroupGetObjectV2ResponseMPayload class TestEzsignsignergroupGetObjectV2ResponseMPayload(unittest.TestCase): """EzsignsignergroupGetObjectV2ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignsignergroupGetObjectV2Respons optional params are included """ # uncomment below to create an instance of `EzsignsignergroupGetObjectV2ResponseMPayload` """ - model = EzsignsignergroupGetObjectV2ResponseMPayload() # noqa: E501 + model = EzsignsignergroupGetObjectV2ResponseMPayload() if include_optional: return EzsignsignergroupGetObjectV2ResponseMPayload( obj_ezsignsignergroup = eZmaxApi.models.ezsignsignergroup_response_compound.ezsignsignergroup-ResponseCompound() diff --git a/test/test_ezsignsignergroup_request.py b/test/test_ezsignsignergroup_request.py index 80ced2a2d..e7ec6e92c 100644 --- a/test/test_ezsignsignergroup_request.py +++ b/test/test_ezsignsignergroup_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignsignergroup_request import EzsignsignergroupRequest # noqa: E501 +from eZmaxApi.models.ezsignsignergroup_request import EzsignsignergroupRequest class TestEzsignsignergroupRequest(unittest.TestCase): """EzsignsignergroupRequest unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignsignergroupRequest: optional params are included """ # uncomment below to create an instance of `EzsignsignergroupRequest` """ - model = EzsignsignergroupRequest() # noqa: E501 + model = EzsignsignergroupRequest() if include_optional: return EzsignsignergroupRequest( pki_ezsignsignergroup_id = 27, diff --git a/test/test_ezsignsignergroup_request_compound.py b/test/test_ezsignsignergroup_request_compound.py index 8f49817d4..b4a58588f 100644 --- a/test/test_ezsignsignergroup_request_compound.py +++ b/test/test_ezsignsignergroup_request_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignsignergroup_request_compound import EzsignsignergroupRequestCompound # noqa: E501 +from eZmaxApi.models.ezsignsignergroup_request_compound import EzsignsignergroupRequestCompound class TestEzsignsignergroupRequestCompound(unittest.TestCase): """EzsignsignergroupRequestCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignsignergroupRequestCompound: optional params are included """ # uncomment below to create an instance of `EzsignsignergroupRequestCompound` """ - model = EzsignsignergroupRequestCompound() # noqa: E501 + model = EzsignsignergroupRequestCompound() if include_optional: return EzsignsignergroupRequestCompound( pki_ezsignsignergroup_id = 27, diff --git a/test/test_ezsignsignergroup_response.py b/test/test_ezsignsignergroup_response.py index bf734f409..28af50ff0 100644 --- a/test/test_ezsignsignergroup_response.py +++ b/test/test_ezsignsignergroup_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignsignergroup_response import EzsignsignergroupResponse # noqa: E501 +from eZmaxApi.models.ezsignsignergroup_response import EzsignsignergroupResponse class TestEzsignsignergroupResponse(unittest.TestCase): """EzsignsignergroupResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignsignergroupResponse: optional params are included """ # uncomment below to create an instance of `EzsignsignergroupResponse` """ - model = EzsignsignergroupResponse() # noqa: E501 + model = EzsignsignergroupResponse() if include_optional: return EzsignsignergroupResponse( pki_ezsignsignergroup_id = 27, diff --git a/test/test_ezsignsignergroup_response_compound.py b/test/test_ezsignsignergroup_response_compound.py index d11fde019..16f641bc1 100644 --- a/test/test_ezsignsignergroup_response_compound.py +++ b/test/test_ezsignsignergroup_response_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignsignergroup_response_compound import EzsignsignergroupResponseCompound # noqa: E501 +from eZmaxApi.models.ezsignsignergroup_response_compound import EzsignsignergroupResponseCompound class TestEzsignsignergroupResponseCompound(unittest.TestCase): """EzsignsignergroupResponseCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignsignergroupResponseCompound: optional params are included """ # uncomment below to create an instance of `EzsignsignergroupResponseCompound` """ - model = EzsignsignergroupResponseCompound() # noqa: E501 + model = EzsignsignergroupResponseCompound() if include_optional: return EzsignsignergroupResponseCompound( pki_ezsignsignergroup_id = 27, diff --git a/test/test_ezsignsignergroupmembership_create_object_v1_request.py b/test/test_ezsignsignergroupmembership_create_object_v1_request.py index 3f534a356..9869a49fe 100644 --- a/test/test_ezsignsignergroupmembership_create_object_v1_request.py +++ b/test/test_ezsignsignergroupmembership_create_object_v1_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignsignergroupmembership_create_object_v1_request import EzsignsignergroupmembershipCreateObjectV1Request # noqa: E501 +from eZmaxApi.models.ezsignsignergroupmembership_create_object_v1_request import EzsignsignergroupmembershipCreateObjectV1Request class TestEzsignsignergroupmembershipCreateObjectV1Request(unittest.TestCase): """EzsignsignergroupmembershipCreateObjectV1Request unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignsignergroupmembershipCreateOb optional params are included """ # uncomment below to create an instance of `EzsignsignergroupmembershipCreateObjectV1Request` """ - model = EzsignsignergroupmembershipCreateObjectV1Request() # noqa: E501 + model = EzsignsignergroupmembershipCreateObjectV1Request() if include_optional: return EzsignsignergroupmembershipCreateObjectV1Request( a_obj_ezsignsignergroupmembership = [ diff --git a/test/test_ezsignsignergroupmembership_create_object_v1_response.py b/test/test_ezsignsignergroupmembership_create_object_v1_response.py index 1018f0e9c..dc01de580 100644 --- a/test/test_ezsignsignergroupmembership_create_object_v1_response.py +++ b/test/test_ezsignsignergroupmembership_create_object_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignsignergroupmembership_create_object_v1_response import EzsignsignergroupmembershipCreateObjectV1Response # noqa: E501 +from eZmaxApi.models.ezsignsignergroupmembership_create_object_v1_response import EzsignsignergroupmembershipCreateObjectV1Response class TestEzsignsignergroupmembershipCreateObjectV1Response(unittest.TestCase): """EzsignsignergroupmembershipCreateObjectV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignsignergroupmembershipCreateOb optional params are included """ # uncomment below to create an instance of `EzsignsignergroupmembershipCreateObjectV1Response` """ - model = EzsignsignergroupmembershipCreateObjectV1Response() # noqa: E501 + model = EzsignsignergroupmembershipCreateObjectV1Response() if include_optional: return EzsignsignergroupmembershipCreateObjectV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsignsignergroupmembership_create_object_v1_response_m_payload.py b/test/test_ezsignsignergroupmembership_create_object_v1_response_m_payload.py index b7009f2a7..5bc93093b 100644 --- a/test/test_ezsignsignergroupmembership_create_object_v1_response_m_payload.py +++ b/test/test_ezsignsignergroupmembership_create_object_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignsignergroupmembership_create_object_v1_response_m_payload import EzsignsignergroupmembershipCreateObjectV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezsignsignergroupmembership_create_object_v1_response_m_payload import EzsignsignergroupmembershipCreateObjectV1ResponseMPayload class TestEzsignsignergroupmembershipCreateObjectV1ResponseMPayload(unittest.TestCase): """EzsignsignergroupmembershipCreateObjectV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignsignergroupmembershipCreateOb optional params are included """ # uncomment below to create an instance of `EzsignsignergroupmembershipCreateObjectV1ResponseMPayload` """ - model = EzsignsignergroupmembershipCreateObjectV1ResponseMPayload() # noqa: E501 + model = EzsignsignergroupmembershipCreateObjectV1ResponseMPayload() if include_optional: return EzsignsignergroupmembershipCreateObjectV1ResponseMPayload( a_pki_ezsignsignergroupmembership_id = [ diff --git a/test/test_ezsignsignergroupmembership_delete_object_v1_response.py b/test/test_ezsignsignergroupmembership_delete_object_v1_response.py index d5457608a..d570ba0fc 100644 --- a/test/test_ezsignsignergroupmembership_delete_object_v1_response.py +++ b/test/test_ezsignsignergroupmembership_delete_object_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignsignergroupmembership_delete_object_v1_response import EzsignsignergroupmembershipDeleteObjectV1Response # noqa: E501 +from eZmaxApi.models.ezsignsignergroupmembership_delete_object_v1_response import EzsignsignergroupmembershipDeleteObjectV1Response class TestEzsignsignergroupmembershipDeleteObjectV1Response(unittest.TestCase): """EzsignsignergroupmembershipDeleteObjectV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignsignergroupmembershipDeleteOb optional params are included """ # uncomment below to create an instance of `EzsignsignergroupmembershipDeleteObjectV1Response` """ - model = EzsignsignergroupmembershipDeleteObjectV1Response() # noqa: E501 + model = EzsignsignergroupmembershipDeleteObjectV1Response() if include_optional: return EzsignsignergroupmembershipDeleteObjectV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsignsignergroupmembership_get_object_v2_response.py b/test/test_ezsignsignergroupmembership_get_object_v2_response.py index 512dbd913..9a768156f 100644 --- a/test/test_ezsignsignergroupmembership_get_object_v2_response.py +++ b/test/test_ezsignsignergroupmembership_get_object_v2_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignsignergroupmembership_get_object_v2_response import EzsignsignergroupmembershipGetObjectV2Response # noqa: E501 +from eZmaxApi.models.ezsignsignergroupmembership_get_object_v2_response import EzsignsignergroupmembershipGetObjectV2Response class TestEzsignsignergroupmembershipGetObjectV2Response(unittest.TestCase): """EzsignsignergroupmembershipGetObjectV2Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignsignergroupmembershipGetObjec optional params are included """ # uncomment below to create an instance of `EzsignsignergroupmembershipGetObjectV2Response` """ - model = EzsignsignergroupmembershipGetObjectV2Response() # noqa: E501 + model = EzsignsignergroupmembershipGetObjectV2Response() if include_optional: return EzsignsignergroupmembershipGetObjectV2Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsignsignergroupmembership_get_object_v2_response_m_payload.py b/test/test_ezsignsignergroupmembership_get_object_v2_response_m_payload.py index ee8a5567a..72eb64c90 100644 --- a/test/test_ezsignsignergroupmembership_get_object_v2_response_m_payload.py +++ b/test/test_ezsignsignergroupmembership_get_object_v2_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignsignergroupmembership_get_object_v2_response_m_payload import EzsignsignergroupmembershipGetObjectV2ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezsignsignergroupmembership_get_object_v2_response_m_payload import EzsignsignergroupmembershipGetObjectV2ResponseMPayload class TestEzsignsignergroupmembershipGetObjectV2ResponseMPayload(unittest.TestCase): """EzsignsignergroupmembershipGetObjectV2ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignsignergroupmembershipGetObjec optional params are included """ # uncomment below to create an instance of `EzsignsignergroupmembershipGetObjectV2ResponseMPayload` """ - model = EzsignsignergroupmembershipGetObjectV2ResponseMPayload() # noqa: E501 + model = EzsignsignergroupmembershipGetObjectV2ResponseMPayload() if include_optional: return EzsignsignergroupmembershipGetObjectV2ResponseMPayload( obj_ezsignsignergroupmembership = eZmaxApi.models.ezsignsignergroupmembership_response_compound.ezsignsignergroupmembership-ResponseCompound() diff --git a/test/test_ezsignsignergroupmembership_request.py b/test/test_ezsignsignergroupmembership_request.py index 0c35f78f6..4e2a4bc49 100644 --- a/test/test_ezsignsignergroupmembership_request.py +++ b/test/test_ezsignsignergroupmembership_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignsignergroupmembership_request import EzsignsignergroupmembershipRequest # noqa: E501 +from eZmaxApi.models.ezsignsignergroupmembership_request import EzsignsignergroupmembershipRequest class TestEzsignsignergroupmembershipRequest(unittest.TestCase): """EzsignsignergroupmembershipRequest unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignsignergroupmembershipRequest: optional params are included """ # uncomment below to create an instance of `EzsignsignergroupmembershipRequest` """ - model = EzsignsignergroupmembershipRequest() # noqa: E501 + model = EzsignsignergroupmembershipRequest() if include_optional: return EzsignsignergroupmembershipRequest( pki_ezsignsignergroupmembership_id = 153, diff --git a/test/test_ezsignsignergroupmembership_request_compound.py b/test/test_ezsignsignergroupmembership_request_compound.py index eef8fd398..8936c9658 100644 --- a/test/test_ezsignsignergroupmembership_request_compound.py +++ b/test/test_ezsignsignergroupmembership_request_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignsignergroupmembership_request_compound import EzsignsignergroupmembershipRequestCompound # noqa: E501 +from eZmaxApi.models.ezsignsignergroupmembership_request_compound import EzsignsignergroupmembershipRequestCompound class TestEzsignsignergroupmembershipRequestCompound(unittest.TestCase): """EzsignsignergroupmembershipRequestCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignsignergroupmembershipRequestC optional params are included """ # uncomment below to create an instance of `EzsignsignergroupmembershipRequestCompound` """ - model = EzsignsignergroupmembershipRequestCompound() # noqa: E501 + model = EzsignsignergroupmembershipRequestCompound() if include_optional: return EzsignsignergroupmembershipRequestCompound( pki_ezsignsignergroupmembership_id = 153, diff --git a/test/test_ezsignsignergroupmembership_response.py b/test/test_ezsignsignergroupmembership_response.py index 3439666df..716394679 100644 --- a/test/test_ezsignsignergroupmembership_response.py +++ b/test/test_ezsignsignergroupmembership_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignsignergroupmembership_response import EzsignsignergroupmembershipResponse # noqa: E501 +from eZmaxApi.models.ezsignsignergroupmembership_response import EzsignsignergroupmembershipResponse class TestEzsignsignergroupmembershipResponse(unittest.TestCase): """EzsignsignergroupmembershipResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignsignergroupmembershipResponse optional params are included """ # uncomment below to create an instance of `EzsignsignergroupmembershipResponse` """ - model = EzsignsignergroupmembershipResponse() # noqa: E501 + model = EzsignsignergroupmembershipResponse() if include_optional: return EzsignsignergroupmembershipResponse( pki_ezsignsignergroupmembership_id = 153, diff --git a/test/test_ezsignsignergroupmembership_response_compound.py b/test/test_ezsignsignergroupmembership_response_compound.py index db5e65800..8fb55f355 100644 --- a/test/test_ezsignsignergroupmembership_response_compound.py +++ b/test/test_ezsignsignergroupmembership_response_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsignsignergroupmembership_response_compound import EzsignsignergroupmembershipResponseCompound # noqa: E501 +from eZmaxApi.models.ezsignsignergroupmembership_response_compound import EzsignsignergroupmembershipResponseCompound class TestEzsignsignergroupmembershipResponseCompound(unittest.TestCase): """EzsignsignergroupmembershipResponseCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsignsignergroupmembershipResponse optional params are included """ # uncomment below to create an instance of `EzsignsignergroupmembershipResponseCompound` """ - model = EzsignsignergroupmembershipResponseCompound() # noqa: E501 + model = EzsignsignergroupmembershipResponseCompound() if include_optional: return EzsignsignergroupmembershipResponseCompound( pki_ezsignsignergroupmembership_id = 153, diff --git a/test/test_ezsignsigningreason_autocomplete_element_response.py b/test/test_ezsignsigningreason_autocomplete_element_response.py new file mode 100644 index 000000000..cb44dc1ff --- /dev/null +++ b/test/test_ezsignsigningreason_autocomplete_element_response.py @@ -0,0 +1,58 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest +import datetime + +from eZmaxApi.models.ezsignsigningreason_autocomplete_element_response import EzsignsigningreasonAutocompleteElementResponse + +class TestEzsignsigningreasonAutocompleteElementResponse(unittest.TestCase): + """EzsignsigningreasonAutocompleteElementResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> EzsignsigningreasonAutocompleteElementResponse: + """Test EzsignsigningreasonAutocompleteElementResponse + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `EzsignsigningreasonAutocompleteElementResponse` + """ + model = EzsignsigningreasonAutocompleteElementResponse() + if include_optional: + return EzsignsigningreasonAutocompleteElementResponse( + pki_ezsignsigningreason_id = 194, + s_ezsignsigningreason_description_x = 'I approve this document', + b_ezsignsigningreason_isactive = True + ) + else: + return EzsignsigningreasonAutocompleteElementResponse( + pki_ezsignsigningreason_id = 194, + s_ezsignsigningreason_description_x = 'I approve this document', + b_ezsignsigningreason_isactive = True, + ) + """ + + def testEzsignsigningreasonAutocompleteElementResponse(self): + """Test EzsignsigningreasonAutocompleteElementResponse""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_ezsignsigningreason_create_object_v1_request.py b/test/test_ezsignsigningreason_create_object_v1_request.py new file mode 100644 index 000000000..9dbd87e90 --- /dev/null +++ b/test/test_ezsignsigningreason_create_object_v1_request.py @@ -0,0 +1,58 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest +import datetime + +from eZmaxApi.models.ezsignsigningreason_create_object_v1_request import EzsignsigningreasonCreateObjectV1Request + +class TestEzsignsigningreasonCreateObjectV1Request(unittest.TestCase): + """EzsignsigningreasonCreateObjectV1Request unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> EzsignsigningreasonCreateObjectV1Request: + """Test EzsignsigningreasonCreateObjectV1Request + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `EzsignsigningreasonCreateObjectV1Request` + """ + model = EzsignsigningreasonCreateObjectV1Request() + if include_optional: + return EzsignsigningreasonCreateObjectV1Request( + a_obj_ezsignsigningreason = [ + eZmaxApi.models.ezsignsigningreason_request_compound.ezsignsigningreason-RequestCompound() + ] + ) + else: + return EzsignsigningreasonCreateObjectV1Request( + a_obj_ezsignsigningreason = [ + eZmaxApi.models.ezsignsigningreason_request_compound.ezsignsigningreason-RequestCompound() + ], + ) + """ + + def testEzsignsigningreasonCreateObjectV1Request(self): + """Test EzsignsigningreasonCreateObjectV1Request""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_ezsignsigningreason_create_object_v1_response.py b/test/test_ezsignsigningreason_create_object_v1_response.py new file mode 100644 index 000000000..dacc73287 --- /dev/null +++ b/test/test_ezsignsigningreason_create_object_v1_response.py @@ -0,0 +1,75 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest +import datetime + +from eZmaxApi.models.ezsignsigningreason_create_object_v1_response import EzsignsigningreasonCreateObjectV1Response + +class TestEzsignsigningreasonCreateObjectV1Response(unittest.TestCase): + """EzsignsigningreasonCreateObjectV1Response unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> EzsignsigningreasonCreateObjectV1Response: + """Test EzsignsigningreasonCreateObjectV1Response + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `EzsignsigningreasonCreateObjectV1Response` + """ + model = EzsignsigningreasonCreateObjectV1Response() + if include_optional: + return EzsignsigningreasonCreateObjectV1Response( + obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( + i_version_min = 1, + i_version_max = 2, + a_required_permission = [ + 117 + ], + b_version_deprecated = False, ), + obj_debug = {"sMemoryUsage":"11,923MB","sRunTime":"0.6084s","iSQLSelects":3,"iSQLQueries":6,"a_objSQLQuery":[{"sQuery":"SELECT * FROM table","fDuration":1.0E-4},{"sQuery":"SELECT * FROM table","fDuration":1.0E-4}]}, + m_payload = eZmaxApi.models.ezsignsigningreason_create_object_v1_response_m_payload.ezsignsigningreason-createObject-v1-Response-mPayload( + a_pki_ezsignsigningreason_id = [ + 194 + ], ) + ) + else: + return EzsignsigningreasonCreateObjectV1Response( + obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( + i_version_min = 1, + i_version_max = 2, + a_required_permission = [ + 117 + ], + b_version_deprecated = False, ), + m_payload = eZmaxApi.models.ezsignsigningreason_create_object_v1_response_m_payload.ezsignsigningreason-createObject-v1-Response-mPayload( + a_pki_ezsignsigningreason_id = [ + 194 + ], ), + ) + """ + + def testEzsignsigningreasonCreateObjectV1Response(self): + """Test EzsignsigningreasonCreateObjectV1Response""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_ezsignsigningreason_create_object_v1_response_m_payload.py b/test/test_ezsignsigningreason_create_object_v1_response_m_payload.py new file mode 100644 index 000000000..bd472e6be --- /dev/null +++ b/test/test_ezsignsigningreason_create_object_v1_response_m_payload.py @@ -0,0 +1,58 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest +import datetime + +from eZmaxApi.models.ezsignsigningreason_create_object_v1_response_m_payload import EzsignsigningreasonCreateObjectV1ResponseMPayload + +class TestEzsignsigningreasonCreateObjectV1ResponseMPayload(unittest.TestCase): + """EzsignsigningreasonCreateObjectV1ResponseMPayload unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> EzsignsigningreasonCreateObjectV1ResponseMPayload: + """Test EzsignsigningreasonCreateObjectV1ResponseMPayload + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `EzsignsigningreasonCreateObjectV1ResponseMPayload` + """ + model = EzsignsigningreasonCreateObjectV1ResponseMPayload() + if include_optional: + return EzsignsigningreasonCreateObjectV1ResponseMPayload( + a_pki_ezsignsigningreason_id = [ + 194 + ] + ) + else: + return EzsignsigningreasonCreateObjectV1ResponseMPayload( + a_pki_ezsignsigningreason_id = [ + 194 + ], + ) + """ + + def testEzsignsigningreasonCreateObjectV1ResponseMPayload(self): + """Test EzsignsigningreasonCreateObjectV1ResponseMPayload""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_ezsignsigningreason_edit_object_v1_request.py b/test/test_ezsignsigningreason_edit_object_v1_request.py new file mode 100644 index 000000000..64e1ea867 --- /dev/null +++ b/test/test_ezsignsigningreason_edit_object_v1_request.py @@ -0,0 +1,54 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest +import datetime + +from eZmaxApi.models.ezsignsigningreason_edit_object_v1_request import EzsignsigningreasonEditObjectV1Request + +class TestEzsignsigningreasonEditObjectV1Request(unittest.TestCase): + """EzsignsigningreasonEditObjectV1Request unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> EzsignsigningreasonEditObjectV1Request: + """Test EzsignsigningreasonEditObjectV1Request + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `EzsignsigningreasonEditObjectV1Request` + """ + model = EzsignsigningreasonEditObjectV1Request() + if include_optional: + return EzsignsigningreasonEditObjectV1Request( + obj_ezsignsigningreason = eZmaxApi.models.ezsignsigningreason_request_compound.ezsignsigningreason-RequestCompound() + ) + else: + return EzsignsigningreasonEditObjectV1Request( + obj_ezsignsigningreason = eZmaxApi.models.ezsignsigningreason_request_compound.ezsignsigningreason-RequestCompound(), + ) + """ + + def testEzsignsigningreasonEditObjectV1Request(self): + """Test EzsignsigningreasonEditObjectV1Request""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_attachment_download_v1_response.py b/test/test_ezsignsigningreason_edit_object_v1_response.py similarity index 70% rename from test/test_attachment_download_v1_response.py rename to test/test_ezsignsigningreason_edit_object_v1_response.py index 5ff517bec..6baf18bcf 100644 --- a/test/test_attachment_download_v1_response.py +++ b/test/test_ezsignsigningreason_edit_object_v1_response.py @@ -16,10 +16,10 @@ import unittest import datetime -from eZmaxApi.models.attachment_download_v1_response import AttachmentDownloadV1Response # noqa: E501 +from eZmaxApi.models.ezsignsigningreason_edit_object_v1_response import EzsignsigningreasonEditObjectV1Response -class TestAttachmentDownloadV1Response(unittest.TestCase): - """AttachmentDownloadV1Response unit test stubs""" +class TestEzsignsigningreasonEditObjectV1Response(unittest.TestCase): + """EzsignsigningreasonEditObjectV1Response unit test stubs""" def setUp(self): pass @@ -27,16 +27,16 @@ def setUp(self): def tearDown(self): pass - def make_instance(self, include_optional) -> AttachmentDownloadV1Response: - """Test AttachmentDownloadV1Response + def make_instance(self, include_optional) -> EzsignsigningreasonEditObjectV1Response: + """Test EzsignsigningreasonEditObjectV1Response include_option is a boolean, when False only required params are included, when True both required and optional params are included """ - # uncomment below to create an instance of `AttachmentDownloadV1Response` + # uncomment below to create an instance of `EzsignsigningreasonEditObjectV1Response` """ - model = AttachmentDownloadV1Response() # noqa: E501 + model = EzsignsigningreasonEditObjectV1Response() if include_optional: - return AttachmentDownloadV1Response( + return EzsignsigningreasonEditObjectV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( i_version_min = 1, i_version_max = 2, @@ -47,7 +47,7 @@ def make_instance(self, include_optional) -> AttachmentDownloadV1Response: obj_debug = {"sMemoryUsage":"11,923MB","sRunTime":"0.6084s","iSQLSelects":3,"iSQLQueries":6,"a_objSQLQuery":[{"sQuery":"SELECT * FROM table","fDuration":1.0E-4},{"sQuery":"SELECT * FROM table","fDuration":1.0E-4}]} ) else: - return AttachmentDownloadV1Response( + return EzsignsigningreasonEditObjectV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( i_version_min = 1, i_version_max = 2, @@ -58,8 +58,8 @@ def make_instance(self, include_optional) -> AttachmentDownloadV1Response: ) """ - def testAttachmentDownloadV1Response(self): - """Test AttachmentDownloadV1Response""" + def testEzsignsigningreasonEditObjectV1Response(self): + """Test EzsignsigningreasonEditObjectV1Response""" # inst_req_only = self.make_instance(include_optional=False) # inst_req_and_optional = self.make_instance(include_optional=True) diff --git a/test/test_ezsignsigningreason_get_autocomplete_v2_response.py b/test/test_ezsignsigningreason_get_autocomplete_v2_response.py new file mode 100644 index 000000000..b4d2fd2a7 --- /dev/null +++ b/test/test_ezsignsigningreason_get_autocomplete_v2_response.py @@ -0,0 +1,81 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest +import datetime + +from eZmaxApi.models.ezsignsigningreason_get_autocomplete_v2_response import EzsignsigningreasonGetAutocompleteV2Response + +class TestEzsignsigningreasonGetAutocompleteV2Response(unittest.TestCase): + """EzsignsigningreasonGetAutocompleteV2Response unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> EzsignsigningreasonGetAutocompleteV2Response: + """Test EzsignsigningreasonGetAutocompleteV2Response + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `EzsignsigningreasonGetAutocompleteV2Response` + """ + model = EzsignsigningreasonGetAutocompleteV2Response() + if include_optional: + return EzsignsigningreasonGetAutocompleteV2Response( + obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( + i_version_min = 1, + i_version_max = 2, + a_required_permission = [ + 117 + ], + b_version_deprecated = False, ), + obj_debug = {"sMemoryUsage":"11,923MB","sRunTime":"0.6084s","iSQLSelects":3,"iSQLQueries":6,"a_objSQLQuery":[{"sQuery":"SELECT * FROM table","fDuration":1.0E-4},{"sQuery":"SELECT * FROM table","fDuration":1.0E-4}]}, + m_payload = eZmaxApi.models.ezsignsigningreason_get_autocomplete_v2_response_m_payload.ezsignsigningreason-getAutocomplete-v2-Response-mPayload( + a_obj_ezsignsigningreason = [ + eZmaxApi.models.ezsignsigningreason_autocomplete_element_response.ezsignsigningreason-AutocompleteElement-Response( + pki_ezsignsigningreason_id = 194, + s_ezsignsigningreason_description_x = 'I approve this document', + b_ezsignsigningreason_isactive = True, ) + ], ) + ) + else: + return EzsignsigningreasonGetAutocompleteV2Response( + obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( + i_version_min = 1, + i_version_max = 2, + a_required_permission = [ + 117 + ], + b_version_deprecated = False, ), + m_payload = eZmaxApi.models.ezsignsigningreason_get_autocomplete_v2_response_m_payload.ezsignsigningreason-getAutocomplete-v2-Response-mPayload( + a_obj_ezsignsigningreason = [ + eZmaxApi.models.ezsignsigningreason_autocomplete_element_response.ezsignsigningreason-AutocompleteElement-Response( + pki_ezsignsigningreason_id = 194, + s_ezsignsigningreason_description_x = 'I approve this document', + b_ezsignsigningreason_isactive = True, ) + ], ), + ) + """ + + def testEzsignsigningreasonGetAutocompleteV2Response(self): + """Test EzsignsigningreasonGetAutocompleteV2Response""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_ezsignsigningreason_get_autocomplete_v2_response_m_payload.py b/test/test_ezsignsigningreason_get_autocomplete_v2_response_m_payload.py new file mode 100644 index 000000000..90177fdf7 --- /dev/null +++ b/test/test_ezsignsigningreason_get_autocomplete_v2_response_m_payload.py @@ -0,0 +1,64 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest +import datetime + +from eZmaxApi.models.ezsignsigningreason_get_autocomplete_v2_response_m_payload import EzsignsigningreasonGetAutocompleteV2ResponseMPayload + +class TestEzsignsigningreasonGetAutocompleteV2ResponseMPayload(unittest.TestCase): + """EzsignsigningreasonGetAutocompleteV2ResponseMPayload unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> EzsignsigningreasonGetAutocompleteV2ResponseMPayload: + """Test EzsignsigningreasonGetAutocompleteV2ResponseMPayload + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `EzsignsigningreasonGetAutocompleteV2ResponseMPayload` + """ + model = EzsignsigningreasonGetAutocompleteV2ResponseMPayload() + if include_optional: + return EzsignsigningreasonGetAutocompleteV2ResponseMPayload( + a_obj_ezsignsigningreason = [ + eZmaxApi.models.ezsignsigningreason_autocomplete_element_response.ezsignsigningreason-AutocompleteElement-Response( + pki_ezsignsigningreason_id = 194, + s_ezsignsigningreason_description_x = 'I approve this document', + b_ezsignsigningreason_isactive = True, ) + ] + ) + else: + return EzsignsigningreasonGetAutocompleteV2ResponseMPayload( + a_obj_ezsignsigningreason = [ + eZmaxApi.models.ezsignsigningreason_autocomplete_element_response.ezsignsigningreason-AutocompleteElement-Response( + pki_ezsignsigningreason_id = 194, + s_ezsignsigningreason_description_x = 'I approve this document', + b_ezsignsigningreason_isactive = True, ) + ], + ) + """ + + def testEzsignsigningreasonGetAutocompleteV2ResponseMPayload(self): + """Test EzsignsigningreasonGetAutocompleteV2ResponseMPayload""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_ezsignsigningreason_get_list_v1_response.py b/test/test_ezsignsigningreason_get_list_v1_response.py new file mode 100644 index 000000000..9e4e5f16d --- /dev/null +++ b/test/test_ezsignsigningreason_get_list_v1_response.py @@ -0,0 +1,57 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest +import datetime + +from eZmaxApi.models.ezsignsigningreason_get_list_v1_response import EzsignsigningreasonGetListV1Response + +class TestEzsignsigningreasonGetListV1Response(unittest.TestCase): + """EzsignsigningreasonGetListV1Response unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> EzsignsigningreasonGetListV1Response: + """Test EzsignsigningreasonGetListV1Response + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `EzsignsigningreasonGetListV1Response` + """ + model = EzsignsigningreasonGetListV1Response() + if include_optional: + return EzsignsigningreasonGetListV1Response( + obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload_get_list.Common-Response-objDebugPayload_getList(), + obj_debug = {"sMemoryUsage":"11,923MB","sRunTime":"0.6084s","iSQLSelects":3,"iSQLQueries":6,"a_objSQLQuery":[{"sQuery":"SELECT * FROM table","fDuration":1.0E-4},{"sQuery":"SELECT * FROM table","fDuration":1.0E-4}]}, + m_payload = eZmaxApi.models.ezsignsigningreason_get_list_v1_response_m_payload.ezsignsigningreason-getList-v1-Response-mPayload() + ) + else: + return EzsignsigningreasonGetListV1Response( + obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload_get_list.Common-Response-objDebugPayload_getList(), + m_payload = eZmaxApi.models.ezsignsigningreason_get_list_v1_response_m_payload.ezsignsigningreason-getList-v1-Response-mPayload(), + ) + """ + + def testEzsignsigningreasonGetListV1Response(self): + """Test EzsignsigningreasonGetListV1Response""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_ezsignsigningreason_get_list_v1_response_m_payload.py b/test/test_ezsignsigningreason_get_list_v1_response_m_payload.py new file mode 100644 index 000000000..a9b913599 --- /dev/null +++ b/test/test_ezsignsigningreason_get_list_v1_response_m_payload.py @@ -0,0 +1,68 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest +import datetime + +from eZmaxApi.models.ezsignsigningreason_get_list_v1_response_m_payload import EzsignsigningreasonGetListV1ResponseMPayload + +class TestEzsignsigningreasonGetListV1ResponseMPayload(unittest.TestCase): + """EzsignsigningreasonGetListV1ResponseMPayload unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> EzsignsigningreasonGetListV1ResponseMPayload: + """Test EzsignsigningreasonGetListV1ResponseMPayload + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `EzsignsigningreasonGetListV1ResponseMPayload` + """ + model = EzsignsigningreasonGetListV1ResponseMPayload() + if include_optional: + return EzsignsigningreasonGetListV1ResponseMPayload( + i_row_returned = 100, + i_row_filtered = 533, + a_obj_ezsignsigningreason = [ + eZmaxApi.models.ezsignsigningreason_list_element.ezsignsigningreason-ListElement( + pki_ezsignsigningreason_id = 194, + s_ezsignsigningreason_description_x = 'I approve this document', + b_ezsignsigningreason_isactive = True, ) + ] + ) + else: + return EzsignsigningreasonGetListV1ResponseMPayload( + i_row_returned = 100, + i_row_filtered = 533, + a_obj_ezsignsigningreason = [ + eZmaxApi.models.ezsignsigningreason_list_element.ezsignsigningreason-ListElement( + pki_ezsignsigningreason_id = 194, + s_ezsignsigningreason_description_x = 'I approve this document', + b_ezsignsigningreason_isactive = True, ) + ], + ) + """ + + def testEzsignsigningreasonGetListV1ResponseMPayload(self): + """Test EzsignsigningreasonGetListV1ResponseMPayload""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_ezsignsigningreason_get_object_v2_response.py b/test/test_ezsignsigningreason_get_object_v2_response.py new file mode 100644 index 000000000..0740bcbd4 --- /dev/null +++ b/test/test_ezsignsigningreason_get_object_v2_response.py @@ -0,0 +1,71 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest +import datetime + +from eZmaxApi.models.ezsignsigningreason_get_object_v2_response import EzsignsigningreasonGetObjectV2Response + +class TestEzsignsigningreasonGetObjectV2Response(unittest.TestCase): + """EzsignsigningreasonGetObjectV2Response unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> EzsignsigningreasonGetObjectV2Response: + """Test EzsignsigningreasonGetObjectV2Response + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `EzsignsigningreasonGetObjectV2Response` + """ + model = EzsignsigningreasonGetObjectV2Response() + if include_optional: + return EzsignsigningreasonGetObjectV2Response( + obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( + i_version_min = 1, + i_version_max = 2, + a_required_permission = [ + 117 + ], + b_version_deprecated = False, ), + obj_debug = {"sMemoryUsage":"11,923MB","sRunTime":"0.6084s","iSQLSelects":3,"iSQLQueries":6,"a_objSQLQuery":[{"sQuery":"SELECT * FROM table","fDuration":1.0E-4},{"sQuery":"SELECT * FROM table","fDuration":1.0E-4}]}, + m_payload = eZmaxApi.models.ezsignsigningreason_get_object_v2_response_m_payload.ezsignsigningreason-getObject-v2-Response-mPayload( + obj_ezsignsigningreason = eZmaxApi.models.ezsignsigningreason_response_compound.ezsignsigningreason-ResponseCompound(), ) + ) + else: + return EzsignsigningreasonGetObjectV2Response( + obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( + i_version_min = 1, + i_version_max = 2, + a_required_permission = [ + 117 + ], + b_version_deprecated = False, ), + m_payload = eZmaxApi.models.ezsignsigningreason_get_object_v2_response_m_payload.ezsignsigningreason-getObject-v2-Response-mPayload( + obj_ezsignsigningreason = eZmaxApi.models.ezsignsigningreason_response_compound.ezsignsigningreason-ResponseCompound(), ), + ) + """ + + def testEzsignsigningreasonGetObjectV2Response(self): + """Test EzsignsigningreasonGetObjectV2Response""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_ezsignsigningreason_get_object_v2_response_m_payload.py b/test/test_ezsignsigningreason_get_object_v2_response_m_payload.py new file mode 100644 index 000000000..2791dbbab --- /dev/null +++ b/test/test_ezsignsigningreason_get_object_v2_response_m_payload.py @@ -0,0 +1,54 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest +import datetime + +from eZmaxApi.models.ezsignsigningreason_get_object_v2_response_m_payload import EzsignsigningreasonGetObjectV2ResponseMPayload + +class TestEzsignsigningreasonGetObjectV2ResponseMPayload(unittest.TestCase): + """EzsignsigningreasonGetObjectV2ResponseMPayload unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> EzsignsigningreasonGetObjectV2ResponseMPayload: + """Test EzsignsigningreasonGetObjectV2ResponseMPayload + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `EzsignsigningreasonGetObjectV2ResponseMPayload` + """ + model = EzsignsigningreasonGetObjectV2ResponseMPayload() + if include_optional: + return EzsignsigningreasonGetObjectV2ResponseMPayload( + obj_ezsignsigningreason = eZmaxApi.models.ezsignsigningreason_response_compound.ezsignsigningreason-ResponseCompound() + ) + else: + return EzsignsigningreasonGetObjectV2ResponseMPayload( + obj_ezsignsigningreason = eZmaxApi.models.ezsignsigningreason_response_compound.ezsignsigningreason-ResponseCompound(), + ) + """ + + def testEzsignsigningreasonGetObjectV2ResponseMPayload(self): + """Test EzsignsigningreasonGetObjectV2ResponseMPayload""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_ezsignsigningreason_list_element.py b/test/test_ezsignsigningreason_list_element.py new file mode 100644 index 000000000..256e1f44a --- /dev/null +++ b/test/test_ezsignsigningreason_list_element.py @@ -0,0 +1,58 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest +import datetime + +from eZmaxApi.models.ezsignsigningreason_list_element import EzsignsigningreasonListElement + +class TestEzsignsigningreasonListElement(unittest.TestCase): + """EzsignsigningreasonListElement unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> EzsignsigningreasonListElement: + """Test EzsignsigningreasonListElement + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `EzsignsigningreasonListElement` + """ + model = EzsignsigningreasonListElement() + if include_optional: + return EzsignsigningreasonListElement( + pki_ezsignsigningreason_id = 194, + s_ezsignsigningreason_description_x = 'I approve this document', + b_ezsignsigningreason_isactive = True + ) + else: + return EzsignsigningreasonListElement( + pki_ezsignsigningreason_id = 194, + s_ezsignsigningreason_description_x = 'I approve this document', + b_ezsignsigningreason_isactive = True, + ) + """ + + def testEzsignsigningreasonListElement(self): + """Test EzsignsigningreasonListElement""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_ezsignsigningreason_request.py b/test/test_ezsignsigningreason_request.py new file mode 100644 index 000000000..956d57559 --- /dev/null +++ b/test/test_ezsignsigningreason_request.py @@ -0,0 +1,61 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest +import datetime + +from eZmaxApi.models.ezsignsigningreason_request import EzsignsigningreasonRequest + +class TestEzsignsigningreasonRequest(unittest.TestCase): + """EzsignsigningreasonRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> EzsignsigningreasonRequest: + """Test EzsignsigningreasonRequest + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `EzsignsigningreasonRequest` + """ + model = EzsignsigningreasonRequest() + if include_optional: + return EzsignsigningreasonRequest( + pki_ezsignsigningreason_id = 194, + obj_ezsignsigningreason_description = eZmaxApi.models.multilingual_ezsignsigningreason_description.Multilingual-EzsignsigningreasonDescription( + s_ezsignsigningreason_description1 = 'J'approuve ce document', + s_ezsignsigningreason_description2 = 'I approve this document', ), + b_ezsignsigningreason_isactive = True + ) + else: + return EzsignsigningreasonRequest( + obj_ezsignsigningreason_description = eZmaxApi.models.multilingual_ezsignsigningreason_description.Multilingual-EzsignsigningreasonDescription( + s_ezsignsigningreason_description1 = 'J'approuve ce document', + s_ezsignsigningreason_description2 = 'I approve this document', ), + b_ezsignsigningreason_isactive = True, + ) + """ + + def testEzsignsigningreasonRequest(self): + """Test EzsignsigningreasonRequest""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_ezsignsigningreason_request_compound.py b/test/test_ezsignsigningreason_request_compound.py new file mode 100644 index 000000000..82fca0480 --- /dev/null +++ b/test/test_ezsignsigningreason_request_compound.py @@ -0,0 +1,61 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest +import datetime + +from eZmaxApi.models.ezsignsigningreason_request_compound import EzsignsigningreasonRequestCompound + +class TestEzsignsigningreasonRequestCompound(unittest.TestCase): + """EzsignsigningreasonRequestCompound unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> EzsignsigningreasonRequestCompound: + """Test EzsignsigningreasonRequestCompound + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `EzsignsigningreasonRequestCompound` + """ + model = EzsignsigningreasonRequestCompound() + if include_optional: + return EzsignsigningreasonRequestCompound( + pki_ezsignsigningreason_id = 194, + obj_ezsignsigningreason_description = eZmaxApi.models.multilingual_ezsignsigningreason_description.Multilingual-EzsignsigningreasonDescription( + s_ezsignsigningreason_description1 = 'J'approuve ce document', + s_ezsignsigningreason_description2 = 'I approve this document', ), + b_ezsignsigningreason_isactive = True + ) + else: + return EzsignsigningreasonRequestCompound( + obj_ezsignsigningreason_description = eZmaxApi.models.multilingual_ezsignsigningreason_description.Multilingual-EzsignsigningreasonDescription( + s_ezsignsigningreason_description1 = 'J'approuve ce document', + s_ezsignsigningreason_description2 = 'I approve this document', ), + b_ezsignsigningreason_isactive = True, + ) + """ + + def testEzsignsigningreasonRequestCompound(self): + """Test EzsignsigningreasonRequestCompound""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_ezsignsigningreason_response.py b/test/test_ezsignsigningreason_response.py new file mode 100644 index 000000000..7e251ab0e --- /dev/null +++ b/test/test_ezsignsigningreason_response.py @@ -0,0 +1,62 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest +import datetime + +from eZmaxApi.models.ezsignsigningreason_response import EzsignsigningreasonResponse + +class TestEzsignsigningreasonResponse(unittest.TestCase): + """EzsignsigningreasonResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> EzsignsigningreasonResponse: + """Test EzsignsigningreasonResponse + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `EzsignsigningreasonResponse` + """ + model = EzsignsigningreasonResponse() + if include_optional: + return EzsignsigningreasonResponse( + pki_ezsignsigningreason_id = 194, + obj_ezsignsigningreason_description = eZmaxApi.models.multilingual_ezsignsigningreason_description.Multilingual-EzsignsigningreasonDescription( + s_ezsignsigningreason_description1 = 'J'approuve ce document', + s_ezsignsigningreason_description2 = 'I approve this document', ), + b_ezsignsigningreason_isactive = True + ) + else: + return EzsignsigningreasonResponse( + pki_ezsignsigningreason_id = 194, + obj_ezsignsigningreason_description = eZmaxApi.models.multilingual_ezsignsigningreason_description.Multilingual-EzsignsigningreasonDescription( + s_ezsignsigningreason_description1 = 'J'approuve ce document', + s_ezsignsigningreason_description2 = 'I approve this document', ), + b_ezsignsigningreason_isactive = True, + ) + """ + + def testEzsignsigningreasonResponse(self): + """Test EzsignsigningreasonResponse""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_ezsignsigningreason_response_compound.py b/test/test_ezsignsigningreason_response_compound.py new file mode 100644 index 000000000..d95a1b62a --- /dev/null +++ b/test/test_ezsignsigningreason_response_compound.py @@ -0,0 +1,62 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest +import datetime + +from eZmaxApi.models.ezsignsigningreason_response_compound import EzsignsigningreasonResponseCompound + +class TestEzsignsigningreasonResponseCompound(unittest.TestCase): + """EzsignsigningreasonResponseCompound unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> EzsignsigningreasonResponseCompound: + """Test EzsignsigningreasonResponseCompound + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `EzsignsigningreasonResponseCompound` + """ + model = EzsignsigningreasonResponseCompound() + if include_optional: + return EzsignsigningreasonResponseCompound( + pki_ezsignsigningreason_id = 194, + obj_ezsignsigningreason_description = eZmaxApi.models.multilingual_ezsignsigningreason_description.Multilingual-EzsignsigningreasonDescription( + s_ezsignsigningreason_description1 = 'J'approuve ce document', + s_ezsignsigningreason_description2 = 'I approve this document', ), + b_ezsignsigningreason_isactive = True + ) + else: + return EzsignsigningreasonResponseCompound( + pki_ezsignsigningreason_id = 194, + obj_ezsignsigningreason_description = eZmaxApi.models.multilingual_ezsignsigningreason_description.Multilingual-EzsignsigningreasonDescription( + s_ezsignsigningreason_description1 = 'J'approuve ce document', + s_ezsignsigningreason_description2 = 'I approve this document', ), + b_ezsignsigningreason_isactive = True, + ) + """ + + def testEzsignsigningreasonResponseCompound(self): + """Test EzsignsigningreasonResponseCompound""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_ezsigntemplate_autocomplete_element_response.py b/test/test_ezsigntemplate_autocomplete_element_response.py index 11b30c46e..7c7e1388a 100644 --- a/test/test_ezsigntemplate_autocomplete_element_response.py +++ b/test/test_ezsigntemplate_autocomplete_element_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplate_autocomplete_element_response import EzsigntemplateAutocompleteElementResponse # noqa: E501 +from eZmaxApi.models.ezsigntemplate_autocomplete_element_response import EzsigntemplateAutocompleteElementResponse class TestEzsigntemplateAutocompleteElementResponse(unittest.TestCase): """EzsigntemplateAutocompleteElementResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplateAutocompleteElementRe optional params are included """ # uncomment below to create an instance of `EzsigntemplateAutocompleteElementResponse` """ - model = EzsigntemplateAutocompleteElementResponse() # noqa: E501 + model = EzsigntemplateAutocompleteElementResponse() if include_optional: return EzsigntemplateAutocompleteElementResponse( e_ezsignfoldertype_privacylevel = 'User', diff --git a/test/test_ezsigntemplate_copy_v1_request.py b/test/test_ezsigntemplate_copy_v1_request.py index bb0c45219..e2496e7c2 100644 --- a/test/test_ezsigntemplate_copy_v1_request.py +++ b/test/test_ezsigntemplate_copy_v1_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplate_copy_v1_request import EzsigntemplateCopyV1Request # noqa: E501 +from eZmaxApi.models.ezsigntemplate_copy_v1_request import EzsigntemplateCopyV1Request class TestEzsigntemplateCopyV1Request(unittest.TestCase): """EzsigntemplateCopyV1Request unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplateCopyV1Request: optional params are included """ # uncomment below to create an instance of `EzsigntemplateCopyV1Request` """ - model = EzsigntemplateCopyV1Request() # noqa: E501 + model = EzsigntemplateCopyV1Request() if include_optional: return EzsigntemplateCopyV1Request( a_fki_ezsignfoldertype_id = [ diff --git a/test/test_ezsigntemplate_copy_v1_response.py b/test/test_ezsigntemplate_copy_v1_response.py index e9116bffb..4263dd0a7 100644 --- a/test/test_ezsigntemplate_copy_v1_response.py +++ b/test/test_ezsigntemplate_copy_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplate_copy_v1_response import EzsigntemplateCopyV1Response # noqa: E501 +from eZmaxApi.models.ezsigntemplate_copy_v1_response import EzsigntemplateCopyV1Response class TestEzsigntemplateCopyV1Response(unittest.TestCase): """EzsigntemplateCopyV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplateCopyV1Response: optional params are included """ # uncomment below to create an instance of `EzsigntemplateCopyV1Response` """ - model = EzsigntemplateCopyV1Response() # noqa: E501 + model = EzsigntemplateCopyV1Response() if include_optional: return EzsigntemplateCopyV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsigntemplate_copy_v1_response_m_payload.py b/test/test_ezsigntemplate_copy_v1_response_m_payload.py index f80ba8643..cd5c0adc3 100644 --- a/test/test_ezsigntemplate_copy_v1_response_m_payload.py +++ b/test/test_ezsigntemplate_copy_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplate_copy_v1_response_m_payload import EzsigntemplateCopyV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezsigntemplate_copy_v1_response_m_payload import EzsigntemplateCopyV1ResponseMPayload class TestEzsigntemplateCopyV1ResponseMPayload(unittest.TestCase): """EzsigntemplateCopyV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplateCopyV1ResponseMPayloa optional params are included """ # uncomment below to create an instance of `EzsigntemplateCopyV1ResponseMPayload` """ - model = EzsigntemplateCopyV1ResponseMPayload() # noqa: E501 + model = EzsigntemplateCopyV1ResponseMPayload() if include_optional: return EzsigntemplateCopyV1ResponseMPayload( a_pki_ezsigntemplate_id = [ diff --git a/test/test_ezsigntemplate_create_object_v1_request.py b/test/test_ezsigntemplate_create_object_v1_request.py index fa37837d5..a3fab7e33 100644 --- a/test/test_ezsigntemplate_create_object_v1_request.py +++ b/test/test_ezsigntemplate_create_object_v1_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplate_create_object_v1_request import EzsigntemplateCreateObjectV1Request # noqa: E501 +from eZmaxApi.models.ezsigntemplate_create_object_v1_request import EzsigntemplateCreateObjectV1Request class TestEzsigntemplateCreateObjectV1Request(unittest.TestCase): """EzsigntemplateCreateObjectV1Request unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplateCreateObjectV1Request optional params are included """ # uncomment below to create an instance of `EzsigntemplateCreateObjectV1Request` """ - model = EzsigntemplateCreateObjectV1Request() # noqa: E501 + model = EzsigntemplateCreateObjectV1Request() if include_optional: return EzsigntemplateCreateObjectV1Request( a_obj_ezsigntemplate = [ diff --git a/test/test_ezsigntemplate_create_object_v1_response.py b/test/test_ezsigntemplate_create_object_v1_response.py index c8a951524..61764100b 100644 --- a/test/test_ezsigntemplate_create_object_v1_response.py +++ b/test/test_ezsigntemplate_create_object_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplate_create_object_v1_response import EzsigntemplateCreateObjectV1Response # noqa: E501 +from eZmaxApi.models.ezsigntemplate_create_object_v1_response import EzsigntemplateCreateObjectV1Response class TestEzsigntemplateCreateObjectV1Response(unittest.TestCase): """EzsigntemplateCreateObjectV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplateCreateObjectV1Respons optional params are included """ # uncomment below to create an instance of `EzsigntemplateCreateObjectV1Response` """ - model = EzsigntemplateCreateObjectV1Response() # noqa: E501 + model = EzsigntemplateCreateObjectV1Response() if include_optional: return EzsigntemplateCreateObjectV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsigntemplate_create_object_v1_response_m_payload.py b/test/test_ezsigntemplate_create_object_v1_response_m_payload.py index 2a3b68270..000d965be 100644 --- a/test/test_ezsigntemplate_create_object_v1_response_m_payload.py +++ b/test/test_ezsigntemplate_create_object_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplate_create_object_v1_response_m_payload import EzsigntemplateCreateObjectV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezsigntemplate_create_object_v1_response_m_payload import EzsigntemplateCreateObjectV1ResponseMPayload class TestEzsigntemplateCreateObjectV1ResponseMPayload(unittest.TestCase): """EzsigntemplateCreateObjectV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplateCreateObjectV1Respons optional params are included """ # uncomment below to create an instance of `EzsigntemplateCreateObjectV1ResponseMPayload` """ - model = EzsigntemplateCreateObjectV1ResponseMPayload() # noqa: E501 + model = EzsigntemplateCreateObjectV1ResponseMPayload() if include_optional: return EzsigntemplateCreateObjectV1ResponseMPayload( a_pki_ezsigntemplate_id = [ diff --git a/test/test_ezsigntemplate_delete_object_v1_response.py b/test/test_ezsigntemplate_delete_object_v1_response.py index 2d99cd490..cd51434a0 100644 --- a/test/test_ezsigntemplate_delete_object_v1_response.py +++ b/test/test_ezsigntemplate_delete_object_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplate_delete_object_v1_response import EzsigntemplateDeleteObjectV1Response # noqa: E501 +from eZmaxApi.models.ezsigntemplate_delete_object_v1_response import EzsigntemplateDeleteObjectV1Response class TestEzsigntemplateDeleteObjectV1Response(unittest.TestCase): """EzsigntemplateDeleteObjectV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplateDeleteObjectV1Respons optional params are included """ # uncomment below to create an instance of `EzsigntemplateDeleteObjectV1Response` """ - model = EzsigntemplateDeleteObjectV1Response() # noqa: E501 + model = EzsigntemplateDeleteObjectV1Response() if include_optional: return EzsigntemplateDeleteObjectV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsigntemplate_edit_object_v1_request.py b/test/test_ezsigntemplate_edit_object_v1_request.py index 603c0be8c..344cba393 100644 --- a/test/test_ezsigntemplate_edit_object_v1_request.py +++ b/test/test_ezsigntemplate_edit_object_v1_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplate_edit_object_v1_request import EzsigntemplateEditObjectV1Request # noqa: E501 +from eZmaxApi.models.ezsigntemplate_edit_object_v1_request import EzsigntemplateEditObjectV1Request class TestEzsigntemplateEditObjectV1Request(unittest.TestCase): """EzsigntemplateEditObjectV1Request unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplateEditObjectV1Request: optional params are included """ # uncomment below to create an instance of `EzsigntemplateEditObjectV1Request` """ - model = EzsigntemplateEditObjectV1Request() # noqa: E501 + model = EzsigntemplateEditObjectV1Request() if include_optional: return EzsigntemplateEditObjectV1Request( obj_ezsigntemplate = eZmaxApi.models.ezsigntemplate_request_compound.ezsigntemplate-RequestCompound() diff --git a/test/test_ezsigntemplate_edit_object_v1_response.py b/test/test_ezsigntemplate_edit_object_v1_response.py index 809e3ab88..bbbeb19e3 100644 --- a/test/test_ezsigntemplate_edit_object_v1_response.py +++ b/test/test_ezsigntemplate_edit_object_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplate_edit_object_v1_response import EzsigntemplateEditObjectV1Response # noqa: E501 +from eZmaxApi.models.ezsigntemplate_edit_object_v1_response import EzsigntemplateEditObjectV1Response class TestEzsigntemplateEditObjectV1Response(unittest.TestCase): """EzsigntemplateEditObjectV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplateEditObjectV1Response: optional params are included """ # uncomment below to create an instance of `EzsigntemplateEditObjectV1Response` """ - model = EzsigntemplateEditObjectV1Response() # noqa: E501 + model = EzsigntemplateEditObjectV1Response() if include_optional: return EzsigntemplateEditObjectV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsigntemplate_get_autocomplete_v2_response.py b/test/test_ezsigntemplate_get_autocomplete_v2_response.py index bbd8cff98..d8b038f36 100644 --- a/test/test_ezsigntemplate_get_autocomplete_v2_response.py +++ b/test/test_ezsigntemplate_get_autocomplete_v2_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplate_get_autocomplete_v2_response import EzsigntemplateGetAutocompleteV2Response # noqa: E501 +from eZmaxApi.models.ezsigntemplate_get_autocomplete_v2_response import EzsigntemplateGetAutocompleteV2Response class TestEzsigntemplateGetAutocompleteV2Response(unittest.TestCase): """EzsigntemplateGetAutocompleteV2Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplateGetAutocompleteV2Resp optional params are included """ # uncomment below to create an instance of `EzsigntemplateGetAutocompleteV2Response` """ - model = EzsigntemplateGetAutocompleteV2Response() # noqa: E501 + model = EzsigntemplateGetAutocompleteV2Response() if include_optional: return EzsigntemplateGetAutocompleteV2Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsigntemplate_get_autocomplete_v2_response_m_payload.py b/test/test_ezsigntemplate_get_autocomplete_v2_response_m_payload.py index c03667092..1c7987262 100644 --- a/test/test_ezsigntemplate_get_autocomplete_v2_response_m_payload.py +++ b/test/test_ezsigntemplate_get_autocomplete_v2_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplate_get_autocomplete_v2_response_m_payload import EzsigntemplateGetAutocompleteV2ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezsigntemplate_get_autocomplete_v2_response_m_payload import EzsigntemplateGetAutocompleteV2ResponseMPayload class TestEzsigntemplateGetAutocompleteV2ResponseMPayload(unittest.TestCase): """EzsigntemplateGetAutocompleteV2ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplateGetAutocompleteV2Resp optional params are included """ # uncomment below to create an instance of `EzsigntemplateGetAutocompleteV2ResponseMPayload` """ - model = EzsigntemplateGetAutocompleteV2ResponseMPayload() # noqa: E501 + model = EzsigntemplateGetAutocompleteV2ResponseMPayload() if include_optional: return EzsigntemplateGetAutocompleteV2ResponseMPayload( a_obj_ezsigntemplate = [ diff --git a/test/test_ezsigntemplate_get_list_v1_response.py b/test/test_ezsigntemplate_get_list_v1_response.py index a8a5328c4..3ca9a4c9a 100644 --- a/test/test_ezsigntemplate_get_list_v1_response.py +++ b/test/test_ezsigntemplate_get_list_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplate_get_list_v1_response import EzsigntemplateGetListV1Response # noqa: E501 +from eZmaxApi.models.ezsigntemplate_get_list_v1_response import EzsigntemplateGetListV1Response class TestEzsigntemplateGetListV1Response(unittest.TestCase): """EzsigntemplateGetListV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplateGetListV1Response: optional params are included """ # uncomment below to create an instance of `EzsigntemplateGetListV1Response` """ - model = EzsigntemplateGetListV1Response() # noqa: E501 + model = EzsigntemplateGetListV1Response() if include_optional: return EzsigntemplateGetListV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload_get_list.Common-Response-objDebugPayload_getList(), diff --git a/test/test_ezsigntemplate_get_list_v1_response_m_payload.py b/test/test_ezsigntemplate_get_list_v1_response_m_payload.py index 38ab281c2..5ea769418 100644 --- a/test/test_ezsigntemplate_get_list_v1_response_m_payload.py +++ b/test/test_ezsigntemplate_get_list_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplate_get_list_v1_response_m_payload import EzsigntemplateGetListV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezsigntemplate_get_list_v1_response_m_payload import EzsigntemplateGetListV1ResponseMPayload class TestEzsigntemplateGetListV1ResponseMPayload(unittest.TestCase): """EzsigntemplateGetListV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplateGetListV1ResponseMPay optional params are included """ # uncomment below to create an instance of `EzsigntemplateGetListV1ResponseMPayload` """ - model = EzsigntemplateGetListV1ResponseMPayload() # noqa: E501 + model = EzsigntemplateGetListV1ResponseMPayload() if include_optional: return EzsigntemplateGetListV1ResponseMPayload( i_row_returned = 100, diff --git a/test/test_ezsigntemplate_get_object_v1_response.py b/test/test_ezsigntemplate_get_object_v1_response.py index c96855107..4dfc377a0 100644 --- a/test/test_ezsigntemplate_get_object_v1_response.py +++ b/test/test_ezsigntemplate_get_object_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplate_get_object_v1_response import EzsigntemplateGetObjectV1Response # noqa: E501 +from eZmaxApi.models.ezsigntemplate_get_object_v1_response import EzsigntemplateGetObjectV1Response class TestEzsigntemplateGetObjectV1Response(unittest.TestCase): """EzsigntemplateGetObjectV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplateGetObjectV1Response: optional params are included """ # uncomment below to create an instance of `EzsigntemplateGetObjectV1Response` """ - model = EzsigntemplateGetObjectV1Response() # noqa: E501 + model = EzsigntemplateGetObjectV1Response() if include_optional: return EzsigntemplateGetObjectV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsigntemplate_get_object_v1_response_m_payload.py b/test/test_ezsigntemplate_get_object_v1_response_m_payload.py index c862749e2..5eb7fd443 100644 --- a/test/test_ezsigntemplate_get_object_v1_response_m_payload.py +++ b/test/test_ezsigntemplate_get_object_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplate_get_object_v1_response_m_payload import EzsigntemplateGetObjectV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezsigntemplate_get_object_v1_response_m_payload import EzsigntemplateGetObjectV1ResponseMPayload class TestEzsigntemplateGetObjectV1ResponseMPayload(unittest.TestCase): """EzsigntemplateGetObjectV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplateGetObjectV1ResponseMP optional params are included """ # uncomment below to create an instance of `EzsigntemplateGetObjectV1ResponseMPayload` """ - model = EzsigntemplateGetObjectV1ResponseMPayload() # noqa: E501 + model = EzsigntemplateGetObjectV1ResponseMPayload() if include_optional: return EzsigntemplateGetObjectV1ResponseMPayload( pki_ezsigntemplate_id = 36, diff --git a/test/test_ezsigntemplate_get_object_v2_response.py b/test/test_ezsigntemplate_get_object_v2_response.py index 870a0fd1c..ce843f95b 100644 --- a/test/test_ezsigntemplate_get_object_v2_response.py +++ b/test/test_ezsigntemplate_get_object_v2_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplate_get_object_v2_response import EzsigntemplateGetObjectV2Response # noqa: E501 +from eZmaxApi.models.ezsigntemplate_get_object_v2_response import EzsigntemplateGetObjectV2Response class TestEzsigntemplateGetObjectV2Response(unittest.TestCase): """EzsigntemplateGetObjectV2Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplateGetObjectV2Response: optional params are included """ # uncomment below to create an instance of `EzsigntemplateGetObjectV2Response` """ - model = EzsigntemplateGetObjectV2Response() # noqa: E501 + model = EzsigntemplateGetObjectV2Response() if include_optional: return EzsigntemplateGetObjectV2Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsigntemplate_get_object_v2_response_m_payload.py b/test/test_ezsigntemplate_get_object_v2_response_m_payload.py index ca7fa2517..3ad9b532f 100644 --- a/test/test_ezsigntemplate_get_object_v2_response_m_payload.py +++ b/test/test_ezsigntemplate_get_object_v2_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplate_get_object_v2_response_m_payload import EzsigntemplateGetObjectV2ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezsigntemplate_get_object_v2_response_m_payload import EzsigntemplateGetObjectV2ResponseMPayload class TestEzsigntemplateGetObjectV2ResponseMPayload(unittest.TestCase): """EzsigntemplateGetObjectV2ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplateGetObjectV2ResponseMP optional params are included """ # uncomment below to create an instance of `EzsigntemplateGetObjectV2ResponseMPayload` """ - model = EzsigntemplateGetObjectV2ResponseMPayload() # noqa: E501 + model = EzsigntemplateGetObjectV2ResponseMPayload() if include_optional: return EzsigntemplateGetObjectV2ResponseMPayload( obj_ezsigntemplate = eZmaxApi.models.ezsigntemplate_response_compound.ezsigntemplate-ResponseCompound() diff --git a/test/test_ezsigntemplate_list_element.py b/test/test_ezsigntemplate_list_element.py index cffba8315..97f83a3c8 100644 --- a/test/test_ezsigntemplate_list_element.py +++ b/test/test_ezsigntemplate_list_element.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplate_list_element import EzsigntemplateListElement # noqa: E501 +from eZmaxApi.models.ezsigntemplate_list_element import EzsigntemplateListElement class TestEzsigntemplateListElement(unittest.TestCase): """EzsigntemplateListElement unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplateListElement: optional params are included """ # uncomment below to create an instance of `EzsigntemplateListElement` """ - model = EzsigntemplateListElement() # noqa: E501 + model = EzsigntemplateListElement() if include_optional: return EzsigntemplateListElement( pki_ezsigntemplate_id = 36, diff --git a/test/test_ezsigntemplate_request.py b/test/test_ezsigntemplate_request.py index 1ab98e820..5b3ec0487 100644 --- a/test/test_ezsigntemplate_request.py +++ b/test/test_ezsigntemplate_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplate_request import EzsigntemplateRequest # noqa: E501 +from eZmaxApi.models.ezsigntemplate_request import EzsigntemplateRequest class TestEzsigntemplateRequest(unittest.TestCase): """EzsigntemplateRequest unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplateRequest: optional params are included """ # uncomment below to create an instance of `EzsigntemplateRequest` """ - model = EzsigntemplateRequest() # noqa: E501 + model = EzsigntemplateRequest() if include_optional: return EzsigntemplateRequest( pki_ezsigntemplate_id = 36, diff --git a/test/test_ezsigntemplate_request_compound.py b/test/test_ezsigntemplate_request_compound.py index 3512850d4..2338fbcf4 100644 --- a/test/test_ezsigntemplate_request_compound.py +++ b/test/test_ezsigntemplate_request_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplate_request_compound import EzsigntemplateRequestCompound # noqa: E501 +from eZmaxApi.models.ezsigntemplate_request_compound import EzsigntemplateRequestCompound class TestEzsigntemplateRequestCompound(unittest.TestCase): """EzsigntemplateRequestCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplateRequestCompound: optional params are included """ # uncomment below to create an instance of `EzsigntemplateRequestCompound` """ - model = EzsigntemplateRequestCompound() # noqa: E501 + model = EzsigntemplateRequestCompound() if include_optional: return EzsigntemplateRequestCompound( pki_ezsigntemplate_id = 36, diff --git a/test/test_ezsigntemplate_response.py b/test/test_ezsigntemplate_response.py index 6a070b191..99f284fa5 100644 --- a/test/test_ezsigntemplate_response.py +++ b/test/test_ezsigntemplate_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplate_response import EzsigntemplateResponse # noqa: E501 +from eZmaxApi.models.ezsigntemplate_response import EzsigntemplateResponse class TestEzsigntemplateResponse(unittest.TestCase): """EzsigntemplateResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplateResponse: optional params are included """ # uncomment below to create an instance of `EzsigntemplateResponse` """ - model = EzsigntemplateResponse() # noqa: E501 + model = EzsigntemplateResponse() if include_optional: return EzsigntemplateResponse( pki_ezsigntemplate_id = 36, diff --git a/test/test_ezsigntemplate_response_compound.py b/test/test_ezsigntemplate_response_compound.py index a8c24321d..7d6399f20 100644 --- a/test/test_ezsigntemplate_response_compound.py +++ b/test/test_ezsigntemplate_response_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplate_response_compound import EzsigntemplateResponseCompound # noqa: E501 +from eZmaxApi.models.ezsigntemplate_response_compound import EzsigntemplateResponseCompound class TestEzsigntemplateResponseCompound(unittest.TestCase): """EzsigntemplateResponseCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplateResponseCompound: optional params are included """ # uncomment below to create an instance of `EzsigntemplateResponseCompound` """ - model = EzsigntemplateResponseCompound() # noqa: E501 + model = EzsigntemplateResponseCompound() if include_optional: return EzsigntemplateResponseCompound( pki_ezsigntemplate_id = 36, diff --git a/test/test_ezsigntemplatedocument_create_object_v1_request.py b/test/test_ezsigntemplatedocument_create_object_v1_request.py index e8c3119e1..b629b89d9 100644 --- a/test/test_ezsigntemplatedocument_create_object_v1_request.py +++ b/test/test_ezsigntemplatedocument_create_object_v1_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatedocument_create_object_v1_request import EzsigntemplatedocumentCreateObjectV1Request # noqa: E501 +from eZmaxApi.models.ezsigntemplatedocument_create_object_v1_request import EzsigntemplatedocumentCreateObjectV1Request class TestEzsigntemplatedocumentCreateObjectV1Request(unittest.TestCase): """EzsigntemplatedocumentCreateObjectV1Request unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplatedocumentCreateObjectV optional params are included """ # uncomment below to create an instance of `EzsigntemplatedocumentCreateObjectV1Request` """ - model = EzsigntemplatedocumentCreateObjectV1Request() # noqa: E501 + model = EzsigntemplatedocumentCreateObjectV1Request() if include_optional: return EzsigntemplatedocumentCreateObjectV1Request( a_obj_ezsigntemplatedocument = [ diff --git a/test/test_ezsigntemplatedocument_create_object_v1_response.py b/test/test_ezsigntemplatedocument_create_object_v1_response.py index ad419ada4..3f7557f24 100644 --- a/test/test_ezsigntemplatedocument_create_object_v1_response.py +++ b/test/test_ezsigntemplatedocument_create_object_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatedocument_create_object_v1_response import EzsigntemplatedocumentCreateObjectV1Response # noqa: E501 +from eZmaxApi.models.ezsigntemplatedocument_create_object_v1_response import EzsigntemplatedocumentCreateObjectV1Response class TestEzsigntemplatedocumentCreateObjectV1Response(unittest.TestCase): """EzsigntemplatedocumentCreateObjectV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplatedocumentCreateObjectV optional params are included """ # uncomment below to create an instance of `EzsigntemplatedocumentCreateObjectV1Response` """ - model = EzsigntemplatedocumentCreateObjectV1Response() # noqa: E501 + model = EzsigntemplatedocumentCreateObjectV1Response() if include_optional: return EzsigntemplatedocumentCreateObjectV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsigntemplatedocument_create_object_v1_response_m_payload.py b/test/test_ezsigntemplatedocument_create_object_v1_response_m_payload.py index 4c5ad1189..2f089f46b 100644 --- a/test/test_ezsigntemplatedocument_create_object_v1_response_m_payload.py +++ b/test/test_ezsigntemplatedocument_create_object_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatedocument_create_object_v1_response_m_payload import EzsigntemplatedocumentCreateObjectV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezsigntemplatedocument_create_object_v1_response_m_payload import EzsigntemplatedocumentCreateObjectV1ResponseMPayload class TestEzsigntemplatedocumentCreateObjectV1ResponseMPayload(unittest.TestCase): """EzsigntemplatedocumentCreateObjectV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplatedocumentCreateObjectV optional params are included """ # uncomment below to create an instance of `EzsigntemplatedocumentCreateObjectV1ResponseMPayload` """ - model = EzsigntemplatedocumentCreateObjectV1ResponseMPayload() # noqa: E501 + model = EzsigntemplatedocumentCreateObjectV1ResponseMPayload() if include_optional: return EzsigntemplatedocumentCreateObjectV1ResponseMPayload( a_pki_ezsigntemplatedocument_id = [ diff --git a/test/test_ezsigntemplatedocument_edit_ezsigntemplateformfieldgroups_v1_request.py b/test/test_ezsigntemplatedocument_edit_ezsigntemplateformfieldgroups_v1_request.py index aad4302e1..339ce15b9 100644 --- a/test/test_ezsigntemplatedocument_edit_ezsigntemplateformfieldgroups_v1_request.py +++ b/test/test_ezsigntemplatedocument_edit_ezsigntemplateformfieldgroups_v1_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatedocument_edit_ezsigntemplateformfieldgroups_v1_request import EzsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1Request # noqa: E501 +from eZmaxApi.models.ezsigntemplatedocument_edit_ezsigntemplateformfieldgroups_v1_request import EzsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1Request class TestEzsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1Request(unittest.TestCase): """EzsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1Request unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplatedocumentEditEzsigntem optional params are included """ # uncomment below to create an instance of `EzsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1Request` """ - model = EzsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1Request() # noqa: E501 + model = EzsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1Request() if include_optional: return EzsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1Request( a_obj_ezsigntemplateformfieldgroup = [ diff --git a/test/test_ezsigntemplatedocument_edit_ezsigntemplateformfieldgroups_v1_response.py b/test/test_ezsigntemplatedocument_edit_ezsigntemplateformfieldgroups_v1_response.py index 5c59417aa..b62dafa6d 100644 --- a/test/test_ezsigntemplatedocument_edit_ezsigntemplateformfieldgroups_v1_response.py +++ b/test/test_ezsigntemplatedocument_edit_ezsigntemplateformfieldgroups_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatedocument_edit_ezsigntemplateformfieldgroups_v1_response import EzsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1Response # noqa: E501 +from eZmaxApi.models.ezsigntemplatedocument_edit_ezsigntemplateformfieldgroups_v1_response import EzsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1Response class TestEzsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1Response(unittest.TestCase): """EzsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplatedocumentEditEzsigntem optional params are included """ # uncomment below to create an instance of `EzsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1Response` """ - model = EzsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1Response() # noqa: E501 + model = EzsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1Response() if include_optional: return EzsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsigntemplatedocument_edit_ezsigntemplateformfieldgroups_v1_response_m_payload.py b/test/test_ezsigntemplatedocument_edit_ezsigntemplateformfieldgroups_v1_response_m_payload.py index 0cbf978db..aee2288ae 100644 --- a/test/test_ezsigntemplatedocument_edit_ezsigntemplateformfieldgroups_v1_response_m_payload.py +++ b/test/test_ezsigntemplatedocument_edit_ezsigntemplateformfieldgroups_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatedocument_edit_ezsigntemplateformfieldgroups_v1_response_m_payload import EzsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezsigntemplatedocument_edit_ezsigntemplateformfieldgroups_v1_response_m_payload import EzsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1ResponseMPayload class TestEzsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1ResponseMPayload(unittest.TestCase): """EzsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplatedocumentEditEzsigntem optional params are included """ # uncomment below to create an instance of `EzsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1ResponseMPayload` """ - model = EzsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1ResponseMPayload() # noqa: E501 + model = EzsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1ResponseMPayload() if include_optional: return EzsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1ResponseMPayload( a_pki_ezsigntemplateformfieldgroup_id = [ diff --git a/test/test_ezsigntemplatedocument_edit_ezsigntemplatesignatures_v1_request.py b/test/test_ezsigntemplatedocument_edit_ezsigntemplatesignatures_v1_request.py index 05f205e48..49fb0cb19 100644 --- a/test/test_ezsigntemplatedocument_edit_ezsigntemplatesignatures_v1_request.py +++ b/test/test_ezsigntemplatedocument_edit_ezsigntemplatesignatures_v1_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatedocument_edit_ezsigntemplatesignatures_v1_request import EzsigntemplatedocumentEditEzsigntemplatesignaturesV1Request # noqa: E501 +from eZmaxApi.models.ezsigntemplatedocument_edit_ezsigntemplatesignatures_v1_request import EzsigntemplatedocumentEditEzsigntemplatesignaturesV1Request class TestEzsigntemplatedocumentEditEzsigntemplatesignaturesV1Request(unittest.TestCase): """EzsigntemplatedocumentEditEzsigntemplatesignaturesV1Request unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplatedocumentEditEzsigntem optional params are included """ # uncomment below to create an instance of `EzsigntemplatedocumentEditEzsigntemplatesignaturesV1Request` """ - model = EzsigntemplatedocumentEditEzsigntemplatesignaturesV1Request() # noqa: E501 + model = EzsigntemplatedocumentEditEzsigntemplatesignaturesV1Request() if include_optional: return EzsigntemplatedocumentEditEzsigntemplatesignaturesV1Request( a_obj_ezsigntemplatesignature = [ diff --git a/test/test_ezsigntemplatedocument_edit_ezsigntemplatesignatures_v1_response.py b/test/test_ezsigntemplatedocument_edit_ezsigntemplatesignatures_v1_response.py index f770d7d81..0d6f69a2c 100644 --- a/test/test_ezsigntemplatedocument_edit_ezsigntemplatesignatures_v1_response.py +++ b/test/test_ezsigntemplatedocument_edit_ezsigntemplatesignatures_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatedocument_edit_ezsigntemplatesignatures_v1_response import EzsigntemplatedocumentEditEzsigntemplatesignaturesV1Response # noqa: E501 +from eZmaxApi.models.ezsigntemplatedocument_edit_ezsigntemplatesignatures_v1_response import EzsigntemplatedocumentEditEzsigntemplatesignaturesV1Response class TestEzsigntemplatedocumentEditEzsigntemplatesignaturesV1Response(unittest.TestCase): """EzsigntemplatedocumentEditEzsigntemplatesignaturesV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplatedocumentEditEzsigntem optional params are included """ # uncomment below to create an instance of `EzsigntemplatedocumentEditEzsigntemplatesignaturesV1Response` """ - model = EzsigntemplatedocumentEditEzsigntemplatesignaturesV1Response() # noqa: E501 + model = EzsigntemplatedocumentEditEzsigntemplatesignaturesV1Response() if include_optional: return EzsigntemplatedocumentEditEzsigntemplatesignaturesV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsigntemplatedocument_edit_ezsigntemplatesignatures_v1_response_m_payload.py b/test/test_ezsigntemplatedocument_edit_ezsigntemplatesignatures_v1_response_m_payload.py index c0e286acd..45190ef75 100644 --- a/test/test_ezsigntemplatedocument_edit_ezsigntemplatesignatures_v1_response_m_payload.py +++ b/test/test_ezsigntemplatedocument_edit_ezsigntemplatesignatures_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatedocument_edit_ezsigntemplatesignatures_v1_response_m_payload import EzsigntemplatedocumentEditEzsigntemplatesignaturesV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezsigntemplatedocument_edit_ezsigntemplatesignatures_v1_response_m_payload import EzsigntemplatedocumentEditEzsigntemplatesignaturesV1ResponseMPayload class TestEzsigntemplatedocumentEditEzsigntemplatesignaturesV1ResponseMPayload(unittest.TestCase): """EzsigntemplatedocumentEditEzsigntemplatesignaturesV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplatedocumentEditEzsigntem optional params are included """ # uncomment below to create an instance of `EzsigntemplatedocumentEditEzsigntemplatesignaturesV1ResponseMPayload` """ - model = EzsigntemplatedocumentEditEzsigntemplatesignaturesV1ResponseMPayload() # noqa: E501 + model = EzsigntemplatedocumentEditEzsigntemplatesignaturesV1ResponseMPayload() if include_optional: return EzsigntemplatedocumentEditEzsigntemplatesignaturesV1ResponseMPayload( a_pki_ezsigntemplatesignature_id = [ diff --git a/test/test_ezsigntemplatedocument_edit_object_v1_request.py b/test/test_ezsigntemplatedocument_edit_object_v1_request.py index 8594c179a..55ccb2cad 100644 --- a/test/test_ezsigntemplatedocument_edit_object_v1_request.py +++ b/test/test_ezsigntemplatedocument_edit_object_v1_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatedocument_edit_object_v1_request import EzsigntemplatedocumentEditObjectV1Request # noqa: E501 +from eZmaxApi.models.ezsigntemplatedocument_edit_object_v1_request import EzsigntemplatedocumentEditObjectV1Request class TestEzsigntemplatedocumentEditObjectV1Request(unittest.TestCase): """EzsigntemplatedocumentEditObjectV1Request unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplatedocumentEditObjectV1R optional params are included """ # uncomment below to create an instance of `EzsigntemplatedocumentEditObjectV1Request` """ - model = EzsigntemplatedocumentEditObjectV1Request() # noqa: E501 + model = EzsigntemplatedocumentEditObjectV1Request() if include_optional: return EzsigntemplatedocumentEditObjectV1Request( obj_ezsigntemplatedocument = eZmaxApi.models.ezsigntemplatedocument_request_compound.ezsigntemplatedocument-RequestCompound() diff --git a/test/test_ezsigntemplatedocument_edit_object_v1_response.py b/test/test_ezsigntemplatedocument_edit_object_v1_response.py index 602b90942..5a8b4d31c 100644 --- a/test/test_ezsigntemplatedocument_edit_object_v1_response.py +++ b/test/test_ezsigntemplatedocument_edit_object_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatedocument_edit_object_v1_response import EzsigntemplatedocumentEditObjectV1Response # noqa: E501 +from eZmaxApi.models.ezsigntemplatedocument_edit_object_v1_response import EzsigntemplatedocumentEditObjectV1Response class TestEzsigntemplatedocumentEditObjectV1Response(unittest.TestCase): """EzsigntemplatedocumentEditObjectV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplatedocumentEditObjectV1R optional params are included """ # uncomment below to create an instance of `EzsigntemplatedocumentEditObjectV1Response` """ - model = EzsigntemplatedocumentEditObjectV1Response() # noqa: E501 + model = EzsigntemplatedocumentEditObjectV1Response() if include_optional: return EzsigntemplatedocumentEditObjectV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsigntemplatedocument_flatten_v1_response.py b/test/test_ezsigntemplatedocument_flatten_v1_response.py index 7656f41eb..ef8ea564d 100644 --- a/test/test_ezsigntemplatedocument_flatten_v1_response.py +++ b/test/test_ezsigntemplatedocument_flatten_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatedocument_flatten_v1_response import EzsigntemplatedocumentFlattenV1Response # noqa: E501 +from eZmaxApi.models.ezsigntemplatedocument_flatten_v1_response import EzsigntemplatedocumentFlattenV1Response class TestEzsigntemplatedocumentFlattenV1Response(unittest.TestCase): """EzsigntemplatedocumentFlattenV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplatedocumentFlattenV1Resp optional params are included """ # uncomment below to create an instance of `EzsigntemplatedocumentFlattenV1Response` """ - model = EzsigntemplatedocumentFlattenV1Response() # noqa: E501 + model = EzsigntemplatedocumentFlattenV1Response() if include_optional: return EzsigntemplatedocumentFlattenV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsigntemplatedocument_get_ezsigntemplatedocumentpages_v1_response.py b/test/test_ezsigntemplatedocument_get_ezsigntemplatedocumentpages_v1_response.py index 72722e678..c242baf25 100644 --- a/test/test_ezsigntemplatedocument_get_ezsigntemplatedocumentpages_v1_response.py +++ b/test/test_ezsigntemplatedocument_get_ezsigntemplatedocumentpages_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatedocument_get_ezsigntemplatedocumentpages_v1_response import EzsigntemplatedocumentGetEzsigntemplatedocumentpagesV1Response # noqa: E501 +from eZmaxApi.models.ezsigntemplatedocument_get_ezsigntemplatedocumentpages_v1_response import EzsigntemplatedocumentGetEzsigntemplatedocumentpagesV1Response class TestEzsigntemplatedocumentGetEzsigntemplatedocumentpagesV1Response(unittest.TestCase): """EzsigntemplatedocumentGetEzsigntemplatedocumentpagesV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplatedocumentGetEzsigntemp optional params are included """ # uncomment below to create an instance of `EzsigntemplatedocumentGetEzsigntemplatedocumentpagesV1Response` """ - model = EzsigntemplatedocumentGetEzsigntemplatedocumentpagesV1Response() # noqa: E501 + model = EzsigntemplatedocumentGetEzsigntemplatedocumentpagesV1Response() if include_optional: return EzsigntemplatedocumentGetEzsigntemplatedocumentpagesV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsigntemplatedocument_get_ezsigntemplatedocumentpages_v1_response_m_payload.py b/test/test_ezsigntemplatedocument_get_ezsigntemplatedocumentpages_v1_response_m_payload.py index 563223e85..661cc6223 100644 --- a/test/test_ezsigntemplatedocument_get_ezsigntemplatedocumentpages_v1_response_m_payload.py +++ b/test/test_ezsigntemplatedocument_get_ezsigntemplatedocumentpages_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatedocument_get_ezsigntemplatedocumentpages_v1_response_m_payload import EzsigntemplatedocumentGetEzsigntemplatedocumentpagesV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezsigntemplatedocument_get_ezsigntemplatedocumentpages_v1_response_m_payload import EzsigntemplatedocumentGetEzsigntemplatedocumentpagesV1ResponseMPayload class TestEzsigntemplatedocumentGetEzsigntemplatedocumentpagesV1ResponseMPayload(unittest.TestCase): """EzsigntemplatedocumentGetEzsigntemplatedocumentpagesV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplatedocumentGetEzsigntemp optional params are included """ # uncomment below to create an instance of `EzsigntemplatedocumentGetEzsigntemplatedocumentpagesV1ResponseMPayload` """ - model = EzsigntemplatedocumentGetEzsigntemplatedocumentpagesV1ResponseMPayload() # noqa: E501 + model = EzsigntemplatedocumentGetEzsigntemplatedocumentpagesV1ResponseMPayload() if include_optional: return EzsigntemplatedocumentGetEzsigntemplatedocumentpagesV1ResponseMPayload( a_obj_ezsigntemplatedocumentpage = [ diff --git a/test/test_ezsigntemplatedocument_get_ezsigntemplateformfieldgroups_v1_response.py b/test/test_ezsigntemplatedocument_get_ezsigntemplateformfieldgroups_v1_response.py index 3bd11f911..d574c12e5 100644 --- a/test/test_ezsigntemplatedocument_get_ezsigntemplateformfieldgroups_v1_response.py +++ b/test/test_ezsigntemplatedocument_get_ezsigntemplateformfieldgroups_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatedocument_get_ezsigntemplateformfieldgroups_v1_response import EzsigntemplatedocumentGetEzsigntemplateformfieldgroupsV1Response # noqa: E501 +from eZmaxApi.models.ezsigntemplatedocument_get_ezsigntemplateformfieldgroups_v1_response import EzsigntemplatedocumentGetEzsigntemplateformfieldgroupsV1Response class TestEzsigntemplatedocumentGetEzsigntemplateformfieldgroupsV1Response(unittest.TestCase): """EzsigntemplatedocumentGetEzsigntemplateformfieldgroupsV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplatedocumentGetEzsigntemp optional params are included """ # uncomment below to create an instance of `EzsigntemplatedocumentGetEzsigntemplateformfieldgroupsV1Response` """ - model = EzsigntemplatedocumentGetEzsigntemplateformfieldgroupsV1Response() # noqa: E501 + model = EzsigntemplatedocumentGetEzsigntemplateformfieldgroupsV1Response() if include_optional: return EzsigntemplatedocumentGetEzsigntemplateformfieldgroupsV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsigntemplatedocument_get_ezsigntemplateformfieldgroups_v1_response_m_payload.py b/test/test_ezsigntemplatedocument_get_ezsigntemplateformfieldgroups_v1_response_m_payload.py index 52a4899e1..363aa1ce0 100644 --- a/test/test_ezsigntemplatedocument_get_ezsigntemplateformfieldgroups_v1_response_m_payload.py +++ b/test/test_ezsigntemplatedocument_get_ezsigntemplateformfieldgroups_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatedocument_get_ezsigntemplateformfieldgroups_v1_response_m_payload import EzsigntemplatedocumentGetEzsigntemplateformfieldgroupsV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezsigntemplatedocument_get_ezsigntemplateformfieldgroups_v1_response_m_payload import EzsigntemplatedocumentGetEzsigntemplateformfieldgroupsV1ResponseMPayload class TestEzsigntemplatedocumentGetEzsigntemplateformfieldgroupsV1ResponseMPayload(unittest.TestCase): """EzsigntemplatedocumentGetEzsigntemplateformfieldgroupsV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplatedocumentGetEzsigntemp optional params are included """ # uncomment below to create an instance of `EzsigntemplatedocumentGetEzsigntemplateformfieldgroupsV1ResponseMPayload` """ - model = EzsigntemplatedocumentGetEzsigntemplateformfieldgroupsV1ResponseMPayload() # noqa: E501 + model = EzsigntemplatedocumentGetEzsigntemplateformfieldgroupsV1ResponseMPayload() if include_optional: return EzsigntemplatedocumentGetEzsigntemplateformfieldgroupsV1ResponseMPayload( a_obj_ezsigntemplateformfieldgroup = [ diff --git a/test/test_ezsigntemplatedocument_get_ezsigntemplatesignatures_v1_response.py b/test/test_ezsigntemplatedocument_get_ezsigntemplatesignatures_v1_response.py index 78f569369..24c008c1b 100644 --- a/test/test_ezsigntemplatedocument_get_ezsigntemplatesignatures_v1_response.py +++ b/test/test_ezsigntemplatedocument_get_ezsigntemplatesignatures_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatedocument_get_ezsigntemplatesignatures_v1_response import EzsigntemplatedocumentGetEzsigntemplatesignaturesV1Response # noqa: E501 +from eZmaxApi.models.ezsigntemplatedocument_get_ezsigntemplatesignatures_v1_response import EzsigntemplatedocumentGetEzsigntemplatesignaturesV1Response class TestEzsigntemplatedocumentGetEzsigntemplatesignaturesV1Response(unittest.TestCase): """EzsigntemplatedocumentGetEzsigntemplatesignaturesV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplatedocumentGetEzsigntemp optional params are included """ # uncomment below to create an instance of `EzsigntemplatedocumentGetEzsigntemplatesignaturesV1Response` """ - model = EzsigntemplatedocumentGetEzsigntemplatesignaturesV1Response() # noqa: E501 + model = EzsigntemplatedocumentGetEzsigntemplatesignaturesV1Response() if include_optional: return EzsigntemplatedocumentGetEzsigntemplatesignaturesV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsigntemplatedocument_get_ezsigntemplatesignatures_v1_response_m_payload.py b/test/test_ezsigntemplatedocument_get_ezsigntemplatesignatures_v1_response_m_payload.py index 4a0df780b..f1b5a28d0 100644 --- a/test/test_ezsigntemplatedocument_get_ezsigntemplatesignatures_v1_response_m_payload.py +++ b/test/test_ezsigntemplatedocument_get_ezsigntemplatesignatures_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatedocument_get_ezsigntemplatesignatures_v1_response_m_payload import EzsigntemplatedocumentGetEzsigntemplatesignaturesV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezsigntemplatedocument_get_ezsigntemplatesignatures_v1_response_m_payload import EzsigntemplatedocumentGetEzsigntemplatesignaturesV1ResponseMPayload class TestEzsigntemplatedocumentGetEzsigntemplatesignaturesV1ResponseMPayload(unittest.TestCase): """EzsigntemplatedocumentGetEzsigntemplatesignaturesV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplatedocumentGetEzsigntemp optional params are included """ # uncomment below to create an instance of `EzsigntemplatedocumentGetEzsigntemplatesignaturesV1ResponseMPayload` """ - model = EzsigntemplatedocumentGetEzsigntemplatesignaturesV1ResponseMPayload() # noqa: E501 + model = EzsigntemplatedocumentGetEzsigntemplatesignaturesV1ResponseMPayload() if include_optional: return EzsigntemplatedocumentGetEzsigntemplatesignaturesV1ResponseMPayload( a_obj_ezsigntemplatesignature = [ diff --git a/test/test_ezsigntemplatedocument_get_object_v2_response.py b/test/test_ezsigntemplatedocument_get_object_v2_response.py index 8235fb9ee..0a088e14f 100644 --- a/test/test_ezsigntemplatedocument_get_object_v2_response.py +++ b/test/test_ezsigntemplatedocument_get_object_v2_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatedocument_get_object_v2_response import EzsigntemplatedocumentGetObjectV2Response # noqa: E501 +from eZmaxApi.models.ezsigntemplatedocument_get_object_v2_response import EzsigntemplatedocumentGetObjectV2Response class TestEzsigntemplatedocumentGetObjectV2Response(unittest.TestCase): """EzsigntemplatedocumentGetObjectV2Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplatedocumentGetObjectV2Re optional params are included """ # uncomment below to create an instance of `EzsigntemplatedocumentGetObjectV2Response` """ - model = EzsigntemplatedocumentGetObjectV2Response() # noqa: E501 + model = EzsigntemplatedocumentGetObjectV2Response() if include_optional: return EzsigntemplatedocumentGetObjectV2Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsigntemplatedocument_get_object_v2_response_m_payload.py b/test/test_ezsigntemplatedocument_get_object_v2_response_m_payload.py index 89f2462b3..ed8d01b1e 100644 --- a/test/test_ezsigntemplatedocument_get_object_v2_response_m_payload.py +++ b/test/test_ezsigntemplatedocument_get_object_v2_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatedocument_get_object_v2_response_m_payload import EzsigntemplatedocumentGetObjectV2ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezsigntemplatedocument_get_object_v2_response_m_payload import EzsigntemplatedocumentGetObjectV2ResponseMPayload class TestEzsigntemplatedocumentGetObjectV2ResponseMPayload(unittest.TestCase): """EzsigntemplatedocumentGetObjectV2ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplatedocumentGetObjectV2Re optional params are included """ # uncomment below to create an instance of `EzsigntemplatedocumentGetObjectV2ResponseMPayload` """ - model = EzsigntemplatedocumentGetObjectV2ResponseMPayload() # noqa: E501 + model = EzsigntemplatedocumentGetObjectV2ResponseMPayload() if include_optional: return EzsigntemplatedocumentGetObjectV2ResponseMPayload( obj_ezsigntemplatedocument = eZmaxApi.models.ezsigntemplatedocument_response_compound.ezsigntemplatedocument-ResponseCompound() diff --git a/test/test_ezsigntemplatedocument_get_words_positions_v1_request.py b/test/test_ezsigntemplatedocument_get_words_positions_v1_request.py index dd5447050..2dc5051a3 100644 --- a/test/test_ezsigntemplatedocument_get_words_positions_v1_request.py +++ b/test/test_ezsigntemplatedocument_get_words_positions_v1_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatedocument_get_words_positions_v1_request import EzsigntemplatedocumentGetWordsPositionsV1Request # noqa: E501 +from eZmaxApi.models.ezsigntemplatedocument_get_words_positions_v1_request import EzsigntemplatedocumentGetWordsPositionsV1Request class TestEzsigntemplatedocumentGetWordsPositionsV1Request(unittest.TestCase): """EzsigntemplatedocumentGetWordsPositionsV1Request unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplatedocumentGetWordsPosit optional params are included """ # uncomment below to create an instance of `EzsigntemplatedocumentGetWordsPositionsV1Request` """ - model = EzsigntemplatedocumentGetWordsPositionsV1Request() # noqa: E501 + model = EzsigntemplatedocumentGetWordsPositionsV1Request() if include_optional: return EzsigntemplatedocumentGetWordsPositionsV1Request( e_get = 'All', diff --git a/test/test_ezsigntemplatedocument_get_words_positions_v1_response.py b/test/test_ezsigntemplatedocument_get_words_positions_v1_response.py index 878f4939a..a84185a06 100644 --- a/test/test_ezsigntemplatedocument_get_words_positions_v1_response.py +++ b/test/test_ezsigntemplatedocument_get_words_positions_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatedocument_get_words_positions_v1_response import EzsigntemplatedocumentGetWordsPositionsV1Response # noqa: E501 +from eZmaxApi.models.ezsigntemplatedocument_get_words_positions_v1_response import EzsigntemplatedocumentGetWordsPositionsV1Response class TestEzsigntemplatedocumentGetWordsPositionsV1Response(unittest.TestCase): """EzsigntemplatedocumentGetWordsPositionsV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplatedocumentGetWordsPosit optional params are included """ # uncomment below to create an instance of `EzsigntemplatedocumentGetWordsPositionsV1Response` """ - model = EzsigntemplatedocumentGetWordsPositionsV1Response() # noqa: E501 + model = EzsigntemplatedocumentGetWordsPositionsV1Response() if include_optional: return EzsigntemplatedocumentGetWordsPositionsV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsigntemplatedocument_patch_object_v1_request.py b/test/test_ezsigntemplatedocument_patch_object_v1_request.py index 02cb0eca2..e192ede58 100644 --- a/test/test_ezsigntemplatedocument_patch_object_v1_request.py +++ b/test/test_ezsigntemplatedocument_patch_object_v1_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatedocument_patch_object_v1_request import EzsigntemplatedocumentPatchObjectV1Request # noqa: E501 +from eZmaxApi.models.ezsigntemplatedocument_patch_object_v1_request import EzsigntemplatedocumentPatchObjectV1Request class TestEzsigntemplatedocumentPatchObjectV1Request(unittest.TestCase): """EzsigntemplatedocumentPatchObjectV1Request unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplatedocumentPatchObjectV1 optional params are included """ # uncomment below to create an instance of `EzsigntemplatedocumentPatchObjectV1Request` """ - model = EzsigntemplatedocumentPatchObjectV1Request() # noqa: E501 + model = EzsigntemplatedocumentPatchObjectV1Request() if include_optional: return EzsigntemplatedocumentPatchObjectV1Request( obj_ezsigntemplatedocument = eZmaxApi.models.ezsigntemplatedocument_request_patch.ezsigntemplatedocument-RequestPatch( diff --git a/test/test_ezsigntemplatedocument_patch_object_v1_response.py b/test/test_ezsigntemplatedocument_patch_object_v1_response.py index 85196815c..3ad615c9a 100644 --- a/test/test_ezsigntemplatedocument_patch_object_v1_response.py +++ b/test/test_ezsigntemplatedocument_patch_object_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatedocument_patch_object_v1_response import EzsigntemplatedocumentPatchObjectV1Response # noqa: E501 +from eZmaxApi.models.ezsigntemplatedocument_patch_object_v1_response import EzsigntemplatedocumentPatchObjectV1Response class TestEzsigntemplatedocumentPatchObjectV1Response(unittest.TestCase): """EzsigntemplatedocumentPatchObjectV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplatedocumentPatchObjectV1 optional params are included """ # uncomment below to create an instance of `EzsigntemplatedocumentPatchObjectV1Response` """ - model = EzsigntemplatedocumentPatchObjectV1Response() # noqa: E501 + model = EzsigntemplatedocumentPatchObjectV1Response() if include_optional: return EzsigntemplatedocumentPatchObjectV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsigntemplatedocument_request.py b/test/test_ezsigntemplatedocument_request.py index 3ad4d625e..1a130009a 100644 --- a/test/test_ezsigntemplatedocument_request.py +++ b/test/test_ezsigntemplatedocument_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatedocument_request import EzsigntemplatedocumentRequest # noqa: E501 +from eZmaxApi.models.ezsigntemplatedocument_request import EzsigntemplatedocumentRequest class TestEzsigntemplatedocumentRequest(unittest.TestCase): """EzsigntemplatedocumentRequest unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplatedocumentRequest: optional params are included """ # uncomment below to create an instance of `EzsigntemplatedocumentRequest` """ - model = EzsigntemplatedocumentRequest() # noqa: E501 + model = EzsigntemplatedocumentRequest() if include_optional: return EzsigntemplatedocumentRequest( pki_ezsigntemplatedocument_id = 133, @@ -44,7 +44,7 @@ def make_instance(self, include_optional) -> EzsigntemplatedocumentRequest: s_ezsigntemplatedocument_name = 'Standard Contract', e_ezsigntemplatedocument_source = 'Base64', e_ezsigntemplatedocument_format = 'Pdf', - s_ezsigntemplatedocument_base64 = '[B@7b139eab', + s_ezsigntemplatedocument_base64 = '[B@3e2943ab', s_ezsigntemplatedocument_url = 'http://www.example.com/template.pdf', b_ezsigntemplatedocument_forcerepair = True, e_ezsigntemplatedocument_form = 'Keep', diff --git a/test/test_ezsigntemplatedocument_request_compound.py b/test/test_ezsigntemplatedocument_request_compound.py index cfc15c5dc..210bf3515 100644 --- a/test/test_ezsigntemplatedocument_request_compound.py +++ b/test/test_ezsigntemplatedocument_request_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatedocument_request_compound import EzsigntemplatedocumentRequestCompound # noqa: E501 +from eZmaxApi.models.ezsigntemplatedocument_request_compound import EzsigntemplatedocumentRequestCompound class TestEzsigntemplatedocumentRequestCompound(unittest.TestCase): """EzsigntemplatedocumentRequestCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplatedocumentRequestCompou optional params are included """ # uncomment below to create an instance of `EzsigntemplatedocumentRequestCompound` """ - model = EzsigntemplatedocumentRequestCompound() # noqa: E501 + model = EzsigntemplatedocumentRequestCompound() if include_optional: return EzsigntemplatedocumentRequestCompound( pki_ezsigntemplatedocument_id = 133, @@ -44,7 +44,7 @@ def make_instance(self, include_optional) -> EzsigntemplatedocumentRequestCompou s_ezsigntemplatedocument_name = 'Standard Contract', e_ezsigntemplatedocument_source = 'Base64', e_ezsigntemplatedocument_format = 'Pdf', - s_ezsigntemplatedocument_base64 = '[B@7b139eab', + s_ezsigntemplatedocument_base64 = 'eyIkcmVmIjoiIy9jb21wb25lbnRzL2V4YW1wbGVzL1BkZkFzQmFzZTY0L3ZhbHVlIn0=', s_ezsigntemplatedocument_url = 'http://www.example.com/template.pdf', b_ezsigntemplatedocument_forcerepair = True, e_ezsigntemplatedocument_form = 'Keep', diff --git a/test/test_ezsigntemplatedocument_request_patch.py b/test/test_ezsigntemplatedocument_request_patch.py index ddf05ef16..dce0dd860 100644 --- a/test/test_ezsigntemplatedocument_request_patch.py +++ b/test/test_ezsigntemplatedocument_request_patch.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatedocument_request_patch import EzsigntemplatedocumentRequestPatch # noqa: E501 +from eZmaxApi.models.ezsigntemplatedocument_request_patch import EzsigntemplatedocumentRequestPatch class TestEzsigntemplatedocumentRequestPatch(unittest.TestCase): """EzsigntemplatedocumentRequestPatch unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplatedocumentRequestPatch: optional params are included """ # uncomment below to create an instance of `EzsigntemplatedocumentRequestPatch` """ - model = EzsigntemplatedocumentRequestPatch() # noqa: E501 + model = EzsigntemplatedocumentRequestPatch() if include_optional: return EzsigntemplatedocumentRequestPatch( s_ezsigntemplatedocument_name = 'Standard Contract' diff --git a/test/test_ezsigntemplatedocument_response.py b/test/test_ezsigntemplatedocument_response.py index 6c412c702..4832559cd 100644 --- a/test/test_ezsigntemplatedocument_response.py +++ b/test/test_ezsigntemplatedocument_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatedocument_response import EzsigntemplatedocumentResponse # noqa: E501 +from eZmaxApi.models.ezsigntemplatedocument_response import EzsigntemplatedocumentResponse class TestEzsigntemplatedocumentResponse(unittest.TestCase): """EzsigntemplatedocumentResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplatedocumentResponse: optional params are included """ # uncomment below to create an instance of `EzsigntemplatedocumentResponse` """ - model = EzsigntemplatedocumentResponse() # noqa: E501 + model = EzsigntemplatedocumentResponse() if include_optional: return EzsigntemplatedocumentResponse( pki_ezsigntemplatedocument_id = 133, diff --git a/test/test_ezsigntemplatedocument_response_compound.py b/test/test_ezsigntemplatedocument_response_compound.py index fa8534b03..dd676565e 100644 --- a/test/test_ezsigntemplatedocument_response_compound.py +++ b/test/test_ezsigntemplatedocument_response_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatedocument_response_compound import EzsigntemplatedocumentResponseCompound # noqa: E501 +from eZmaxApi.models.ezsigntemplatedocument_response_compound import EzsigntemplatedocumentResponseCompound class TestEzsigntemplatedocumentResponseCompound(unittest.TestCase): """EzsigntemplatedocumentResponseCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplatedocumentResponseCompo optional params are included """ # uncomment below to create an instance of `EzsigntemplatedocumentResponseCompound` """ - model = EzsigntemplatedocumentResponseCompound() # noqa: E501 + model = EzsigntemplatedocumentResponseCompound() if include_optional: return EzsigntemplatedocumentResponseCompound( pki_ezsigntemplatedocument_id = 133, diff --git a/test/test_ezsigntemplatedocumentpage_response.py b/test/test_ezsigntemplatedocumentpage_response.py index 02f89b8e3..bb6742e32 100644 --- a/test/test_ezsigntemplatedocumentpage_response.py +++ b/test/test_ezsigntemplatedocumentpage_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatedocumentpage_response import EzsigntemplatedocumentpageResponse # noqa: E501 +from eZmaxApi.models.ezsigntemplatedocumentpage_response import EzsigntemplatedocumentpageResponse class TestEzsigntemplatedocumentpageResponse(unittest.TestCase): """EzsigntemplatedocumentpageResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplatedocumentpageResponse: optional params are included """ # uncomment below to create an instance of `EzsigntemplatedocumentpageResponse` """ - model = EzsigntemplatedocumentpageResponse() # noqa: E501 + model = EzsigntemplatedocumentpageResponse() if include_optional: return EzsigntemplatedocumentpageResponse( pki_ezsigntemplatedocumentpage_id = 85, diff --git a/test/test_ezsigntemplatedocumentpage_response_compound.py b/test/test_ezsigntemplatedocumentpage_response_compound.py index e17c4f057..0895b3b01 100644 --- a/test/test_ezsigntemplatedocumentpage_response_compound.py +++ b/test/test_ezsigntemplatedocumentpage_response_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatedocumentpage_response_compound import EzsigntemplatedocumentpageResponseCompound # noqa: E501 +from eZmaxApi.models.ezsigntemplatedocumentpage_response_compound import EzsigntemplatedocumentpageResponseCompound class TestEzsigntemplatedocumentpageResponseCompound(unittest.TestCase): """EzsigntemplatedocumentpageResponseCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplatedocumentpageResponseC optional params are included """ # uncomment below to create an instance of `EzsigntemplatedocumentpageResponseCompound` """ - model = EzsigntemplatedocumentpageResponseCompound() # noqa: E501 + model = EzsigntemplatedocumentpageResponseCompound() if include_optional: return EzsigntemplatedocumentpageResponseCompound( pki_ezsigntemplatedocumentpage_id = 85, diff --git a/test/test_ezsigntemplateelementdependency_request.py b/test/test_ezsigntemplateelementdependency_request.py index a6722667d..d1c08782d 100644 --- a/test/test_ezsigntemplateelementdependency_request.py +++ b/test/test_ezsigntemplateelementdependency_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplateelementdependency_request import EzsigntemplateelementdependencyRequest # noqa: E501 +from eZmaxApi.models.ezsigntemplateelementdependency_request import EzsigntemplateelementdependencyRequest class TestEzsigntemplateelementdependencyRequest(unittest.TestCase): """EzsigntemplateelementdependencyRequest unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplateelementdependencyRequ optional params are included """ # uncomment below to create an instance of `EzsigntemplateelementdependencyRequest` """ - model = EzsigntemplateelementdependencyRequest() # noqa: E501 + model = EzsigntemplateelementdependencyRequest() if include_optional: return EzsigntemplateelementdependencyRequest( pki_ezsigntemplateelementdependency_id = 314, diff --git a/test/test_ezsigntemplateelementdependency_request_compound.py b/test/test_ezsigntemplateelementdependency_request_compound.py index f75f16158..df8167e08 100644 --- a/test/test_ezsigntemplateelementdependency_request_compound.py +++ b/test/test_ezsigntemplateelementdependency_request_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplateelementdependency_request_compound import EzsigntemplateelementdependencyRequestCompound # noqa: E501 +from eZmaxApi.models.ezsigntemplateelementdependency_request_compound import EzsigntemplateelementdependencyRequestCompound class TestEzsigntemplateelementdependencyRequestCompound(unittest.TestCase): """EzsigntemplateelementdependencyRequestCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplateelementdependencyRequ optional params are included """ # uncomment below to create an instance of `EzsigntemplateelementdependencyRequestCompound` """ - model = EzsigntemplateelementdependencyRequestCompound() # noqa: E501 + model = EzsigntemplateelementdependencyRequestCompound() if include_optional: return EzsigntemplateelementdependencyRequestCompound( pki_ezsigntemplateelementdependency_id = 314, diff --git a/test/test_ezsigntemplateelementdependency_response.py b/test/test_ezsigntemplateelementdependency_response.py index 235634a5b..51803fb6d 100644 --- a/test/test_ezsigntemplateelementdependency_response.py +++ b/test/test_ezsigntemplateelementdependency_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplateelementdependency_response import EzsigntemplateelementdependencyResponse # noqa: E501 +from eZmaxApi.models.ezsigntemplateelementdependency_response import EzsigntemplateelementdependencyResponse class TestEzsigntemplateelementdependencyResponse(unittest.TestCase): """EzsigntemplateelementdependencyResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplateelementdependencyResp optional params are included """ # uncomment below to create an instance of `EzsigntemplateelementdependencyResponse` """ - model = EzsigntemplateelementdependencyResponse() # noqa: E501 + model = EzsigntemplateelementdependencyResponse() if include_optional: return EzsigntemplateelementdependencyResponse( pki_ezsigntemplateelementdependency_id = 314, diff --git a/test/test_ezsigntemplateelementdependency_response_compound.py b/test/test_ezsigntemplateelementdependency_response_compound.py index a92ce84cf..b82b7603d 100644 --- a/test/test_ezsigntemplateelementdependency_response_compound.py +++ b/test/test_ezsigntemplateelementdependency_response_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplateelementdependency_response_compound import EzsigntemplateelementdependencyResponseCompound # noqa: E501 +from eZmaxApi.models.ezsigntemplateelementdependency_response_compound import EzsigntemplateelementdependencyResponseCompound class TestEzsigntemplateelementdependencyResponseCompound(unittest.TestCase): """EzsigntemplateelementdependencyResponseCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplateelementdependencyResp optional params are included """ # uncomment below to create an instance of `EzsigntemplateelementdependencyResponseCompound` """ - model = EzsigntemplateelementdependencyResponseCompound() # noqa: E501 + model = EzsigntemplateelementdependencyResponseCompound() if include_optional: return EzsigntemplateelementdependencyResponseCompound( pki_ezsigntemplateelementdependency_id = 314, diff --git a/test/test_ezsigntemplateformfield_request.py b/test/test_ezsigntemplateformfield_request.py index ec64368e6..fd9548631 100644 --- a/test/test_ezsigntemplateformfield_request.py +++ b/test/test_ezsigntemplateformfield_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplateformfield_request import EzsigntemplateformfieldRequest # noqa: E501 +from eZmaxApi.models.ezsigntemplateformfield_request import EzsigntemplateformfieldRequest class TestEzsigntemplateformfieldRequest(unittest.TestCase): """EzsigntemplateformfieldRequest unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplateformfieldRequest: optional params are included """ # uncomment below to create an instance of `EzsigntemplateformfieldRequest` """ - model = EzsigntemplateformfieldRequest() # noqa: E501 + model = EzsigntemplateformfieldRequest() if include_optional: return EzsigntemplateformfieldRequest( pki_ezsigntemplateformfield_id = 71, diff --git a/test/test_ezsigntemplateformfield_request_compound.py b/test/test_ezsigntemplateformfield_request_compound.py index 3108d7167..32ecee042 100644 --- a/test/test_ezsigntemplateformfield_request_compound.py +++ b/test/test_ezsigntemplateformfield_request_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplateformfield_request_compound import EzsigntemplateformfieldRequestCompound # noqa: E501 +from eZmaxApi.models.ezsigntemplateformfield_request_compound import EzsigntemplateformfieldRequestCompound class TestEzsigntemplateformfieldRequestCompound(unittest.TestCase): """EzsigntemplateformfieldRequestCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplateformfieldRequestCompo optional params are included """ # uncomment below to create an instance of `EzsigntemplateformfieldRequestCompound` """ - model = EzsigntemplateformfieldRequestCompound() # noqa: E501 + model = EzsigntemplateformfieldRequestCompound() if include_optional: return EzsigntemplateformfieldRequestCompound( pki_ezsigntemplateformfield_id = 71, diff --git a/test/test_ezsigntemplateformfield_response.py b/test/test_ezsigntemplateformfield_response.py index 11ef4752a..fb76100ab 100644 --- a/test/test_ezsigntemplateformfield_response.py +++ b/test/test_ezsigntemplateformfield_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplateformfield_response import EzsigntemplateformfieldResponse # noqa: E501 +from eZmaxApi.models.ezsigntemplateformfield_response import EzsigntemplateformfieldResponse class TestEzsigntemplateformfieldResponse(unittest.TestCase): """EzsigntemplateformfieldResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplateformfieldResponse: optional params are included """ # uncomment below to create an instance of `EzsigntemplateformfieldResponse` """ - model = EzsigntemplateformfieldResponse() # noqa: E501 + model = EzsigntemplateformfieldResponse() if include_optional: return EzsigntemplateformfieldResponse( pki_ezsigntemplateformfield_id = 71, diff --git a/test/test_ezsigntemplateformfield_response_compound.py b/test/test_ezsigntemplateformfield_response_compound.py index b7a1b175b..d4175ccfb 100644 --- a/test/test_ezsigntemplateformfield_response_compound.py +++ b/test/test_ezsigntemplateformfield_response_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplateformfield_response_compound import EzsigntemplateformfieldResponseCompound # noqa: E501 +from eZmaxApi.models.ezsigntemplateformfield_response_compound import EzsigntemplateformfieldResponseCompound class TestEzsigntemplateformfieldResponseCompound(unittest.TestCase): """EzsigntemplateformfieldResponseCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplateformfieldResponseComp optional params are included """ # uncomment below to create an instance of `EzsigntemplateformfieldResponseCompound` """ - model = EzsigntemplateformfieldResponseCompound() # noqa: E501 + model = EzsigntemplateformfieldResponseCompound() if include_optional: return EzsigntemplateformfieldResponseCompound( pki_ezsigntemplateformfield_id = 71, diff --git a/test/test_ezsigntemplateformfieldgroup_create_object_v1_request.py b/test/test_ezsigntemplateformfieldgroup_create_object_v1_request.py index 0ecb5d94b..cf8f09ee3 100644 --- a/test/test_ezsigntemplateformfieldgroup_create_object_v1_request.py +++ b/test/test_ezsigntemplateformfieldgroup_create_object_v1_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplateformfieldgroup_create_object_v1_request import EzsigntemplateformfieldgroupCreateObjectV1Request # noqa: E501 +from eZmaxApi.models.ezsigntemplateformfieldgroup_create_object_v1_request import EzsigntemplateformfieldgroupCreateObjectV1Request class TestEzsigntemplateformfieldgroupCreateObjectV1Request(unittest.TestCase): """EzsigntemplateformfieldgroupCreateObjectV1Request unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplateformfieldgroupCreateO optional params are included """ # uncomment below to create an instance of `EzsigntemplateformfieldgroupCreateObjectV1Request` """ - model = EzsigntemplateformfieldgroupCreateObjectV1Request() # noqa: E501 + model = EzsigntemplateformfieldgroupCreateObjectV1Request() if include_optional: return EzsigntemplateformfieldgroupCreateObjectV1Request( a_obj_ezsigntemplateformfieldgroup = [ diff --git a/test/test_ezsigntemplateformfieldgroup_create_object_v1_response.py b/test/test_ezsigntemplateformfieldgroup_create_object_v1_response.py index 04ef1eb37..f08d77b30 100644 --- a/test/test_ezsigntemplateformfieldgroup_create_object_v1_response.py +++ b/test/test_ezsigntemplateformfieldgroup_create_object_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplateformfieldgroup_create_object_v1_response import EzsigntemplateformfieldgroupCreateObjectV1Response # noqa: E501 +from eZmaxApi.models.ezsigntemplateformfieldgroup_create_object_v1_response import EzsigntemplateformfieldgroupCreateObjectV1Response class TestEzsigntemplateformfieldgroupCreateObjectV1Response(unittest.TestCase): """EzsigntemplateformfieldgroupCreateObjectV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplateformfieldgroupCreateO optional params are included """ # uncomment below to create an instance of `EzsigntemplateformfieldgroupCreateObjectV1Response` """ - model = EzsigntemplateformfieldgroupCreateObjectV1Response() # noqa: E501 + model = EzsigntemplateformfieldgroupCreateObjectV1Response() if include_optional: return EzsigntemplateformfieldgroupCreateObjectV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsigntemplateformfieldgroup_create_object_v1_response_m_payload.py b/test/test_ezsigntemplateformfieldgroup_create_object_v1_response_m_payload.py index b32f60f4c..e5f2409d4 100644 --- a/test/test_ezsigntemplateformfieldgroup_create_object_v1_response_m_payload.py +++ b/test/test_ezsigntemplateformfieldgroup_create_object_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplateformfieldgroup_create_object_v1_response_m_payload import EzsigntemplateformfieldgroupCreateObjectV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezsigntemplateformfieldgroup_create_object_v1_response_m_payload import EzsigntemplateformfieldgroupCreateObjectV1ResponseMPayload class TestEzsigntemplateformfieldgroupCreateObjectV1ResponseMPayload(unittest.TestCase): """EzsigntemplateformfieldgroupCreateObjectV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplateformfieldgroupCreateO optional params are included """ # uncomment below to create an instance of `EzsigntemplateformfieldgroupCreateObjectV1ResponseMPayload` """ - model = EzsigntemplateformfieldgroupCreateObjectV1ResponseMPayload() # noqa: E501 + model = EzsigntemplateformfieldgroupCreateObjectV1ResponseMPayload() if include_optional: return EzsigntemplateformfieldgroupCreateObjectV1ResponseMPayload( a_pki_ezsigntemplateformfieldgroup_id = [ diff --git a/test/test_ezsigntemplateformfieldgroup_delete_object_v1_response.py b/test/test_ezsigntemplateformfieldgroup_delete_object_v1_response.py index 279994fc6..a94f2d2ec 100644 --- a/test/test_ezsigntemplateformfieldgroup_delete_object_v1_response.py +++ b/test/test_ezsigntemplateformfieldgroup_delete_object_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplateformfieldgroup_delete_object_v1_response import EzsigntemplateformfieldgroupDeleteObjectV1Response # noqa: E501 +from eZmaxApi.models.ezsigntemplateformfieldgroup_delete_object_v1_response import EzsigntemplateformfieldgroupDeleteObjectV1Response class TestEzsigntemplateformfieldgroupDeleteObjectV1Response(unittest.TestCase): """EzsigntemplateformfieldgroupDeleteObjectV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplateformfieldgroupDeleteO optional params are included """ # uncomment below to create an instance of `EzsigntemplateformfieldgroupDeleteObjectV1Response` """ - model = EzsigntemplateformfieldgroupDeleteObjectV1Response() # noqa: E501 + model = EzsigntemplateformfieldgroupDeleteObjectV1Response() if include_optional: return EzsigntemplateformfieldgroupDeleteObjectV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsigntemplateformfieldgroup_edit_object_v1_request.py b/test/test_ezsigntemplateformfieldgroup_edit_object_v1_request.py index e78a254a9..3b0a0e6d0 100644 --- a/test/test_ezsigntemplateformfieldgroup_edit_object_v1_request.py +++ b/test/test_ezsigntemplateformfieldgroup_edit_object_v1_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplateformfieldgroup_edit_object_v1_request import EzsigntemplateformfieldgroupEditObjectV1Request # noqa: E501 +from eZmaxApi.models.ezsigntemplateformfieldgroup_edit_object_v1_request import EzsigntemplateformfieldgroupEditObjectV1Request class TestEzsigntemplateformfieldgroupEditObjectV1Request(unittest.TestCase): """EzsigntemplateformfieldgroupEditObjectV1Request unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplateformfieldgroupEditObj optional params are included """ # uncomment below to create an instance of `EzsigntemplateformfieldgroupEditObjectV1Request` """ - model = EzsigntemplateformfieldgroupEditObjectV1Request() # noqa: E501 + model = EzsigntemplateformfieldgroupEditObjectV1Request() if include_optional: return EzsigntemplateformfieldgroupEditObjectV1Request( obj_ezsigntemplateformfieldgroup = eZmaxApi.models.ezsigntemplateformfieldgroup_request_compound.ezsigntemplateformfieldgroup-RequestCompound() diff --git a/test/test_ezsigntemplateformfieldgroup_edit_object_v1_response.py b/test/test_ezsigntemplateformfieldgroup_edit_object_v1_response.py index 1f55f06de..7da29a847 100644 --- a/test/test_ezsigntemplateformfieldgroup_edit_object_v1_response.py +++ b/test/test_ezsigntemplateformfieldgroup_edit_object_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplateformfieldgroup_edit_object_v1_response import EzsigntemplateformfieldgroupEditObjectV1Response # noqa: E501 +from eZmaxApi.models.ezsigntemplateformfieldgroup_edit_object_v1_response import EzsigntemplateformfieldgroupEditObjectV1Response class TestEzsigntemplateformfieldgroupEditObjectV1Response(unittest.TestCase): """EzsigntemplateformfieldgroupEditObjectV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplateformfieldgroupEditObj optional params are included """ # uncomment below to create an instance of `EzsigntemplateformfieldgroupEditObjectV1Response` """ - model = EzsigntemplateformfieldgroupEditObjectV1Response() # noqa: E501 + model = EzsigntemplateformfieldgroupEditObjectV1Response() if include_optional: return EzsigntemplateformfieldgroupEditObjectV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsigntemplateformfieldgroup_get_object_v2_response.py b/test/test_ezsigntemplateformfieldgroup_get_object_v2_response.py index 8b82b0967..10fa70e20 100644 --- a/test/test_ezsigntemplateformfieldgroup_get_object_v2_response.py +++ b/test/test_ezsigntemplateformfieldgroup_get_object_v2_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplateformfieldgroup_get_object_v2_response import EzsigntemplateformfieldgroupGetObjectV2Response # noqa: E501 +from eZmaxApi.models.ezsigntemplateformfieldgroup_get_object_v2_response import EzsigntemplateformfieldgroupGetObjectV2Response class TestEzsigntemplateformfieldgroupGetObjectV2Response(unittest.TestCase): """EzsigntemplateformfieldgroupGetObjectV2Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplateformfieldgroupGetObje optional params are included """ # uncomment below to create an instance of `EzsigntemplateformfieldgroupGetObjectV2Response` """ - model = EzsigntemplateformfieldgroupGetObjectV2Response() # noqa: E501 + model = EzsigntemplateformfieldgroupGetObjectV2Response() if include_optional: return EzsigntemplateformfieldgroupGetObjectV2Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsigntemplateformfieldgroup_get_object_v2_response_m_payload.py b/test/test_ezsigntemplateformfieldgroup_get_object_v2_response_m_payload.py index 2a4310737..ad0e94d72 100644 --- a/test/test_ezsigntemplateformfieldgroup_get_object_v2_response_m_payload.py +++ b/test/test_ezsigntemplateformfieldgroup_get_object_v2_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplateformfieldgroup_get_object_v2_response_m_payload import EzsigntemplateformfieldgroupGetObjectV2ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezsigntemplateformfieldgroup_get_object_v2_response_m_payload import EzsigntemplateformfieldgroupGetObjectV2ResponseMPayload class TestEzsigntemplateformfieldgroupGetObjectV2ResponseMPayload(unittest.TestCase): """EzsigntemplateformfieldgroupGetObjectV2ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplateformfieldgroupGetObje optional params are included """ # uncomment below to create an instance of `EzsigntemplateformfieldgroupGetObjectV2ResponseMPayload` """ - model = EzsigntemplateformfieldgroupGetObjectV2ResponseMPayload() # noqa: E501 + model = EzsigntemplateformfieldgroupGetObjectV2ResponseMPayload() if include_optional: return EzsigntemplateformfieldgroupGetObjectV2ResponseMPayload( obj_ezsigntemplateformfieldgroup = eZmaxApi.models.ezsigntemplateformfieldgroup_response_compound.ezsigntemplateformfieldgroup-ResponseCompound() diff --git a/test/test_ezsigntemplateformfieldgroup_request.py b/test/test_ezsigntemplateformfieldgroup_request.py index c47bd2cac..b46276c98 100644 --- a/test/test_ezsigntemplateformfieldgroup_request.py +++ b/test/test_ezsigntemplateformfieldgroup_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplateformfieldgroup_request import EzsigntemplateformfieldgroupRequest # noqa: E501 +from eZmaxApi.models.ezsigntemplateformfieldgroup_request import EzsigntemplateformfieldgroupRequest class TestEzsigntemplateformfieldgroupRequest(unittest.TestCase): """EzsigntemplateformfieldgroupRequest unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplateformfieldgroupRequest optional params are included """ # uncomment below to create an instance of `EzsigntemplateformfieldgroupRequest` """ - model = EzsigntemplateformfieldgroupRequest() # noqa: E501 + model = EzsigntemplateformfieldgroupRequest() if include_optional: return EzsigntemplateformfieldgroupRequest( pki_ezsigntemplateformfieldgroup_id = 64, diff --git a/test/test_ezsigntemplateformfieldgroup_request_compound.py b/test/test_ezsigntemplateformfieldgroup_request_compound.py index 906ad1d92..7dbc89c0a 100644 --- a/test/test_ezsigntemplateformfieldgroup_request_compound.py +++ b/test/test_ezsigntemplateformfieldgroup_request_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplateformfieldgroup_request_compound import EzsigntemplateformfieldgroupRequestCompound # noqa: E501 +from eZmaxApi.models.ezsigntemplateformfieldgroup_request_compound import EzsigntemplateformfieldgroupRequestCompound class TestEzsigntemplateformfieldgroupRequestCompound(unittest.TestCase): """EzsigntemplateformfieldgroupRequestCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplateformfieldgroupRequest optional params are included """ # uncomment below to create an instance of `EzsigntemplateformfieldgroupRequestCompound` """ - model = EzsigntemplateformfieldgroupRequestCompound() # noqa: E501 + model = EzsigntemplateformfieldgroupRequestCompound() if include_optional: return EzsigntemplateformfieldgroupRequestCompound( pki_ezsigntemplateformfieldgroup_id = 64, diff --git a/test/test_ezsigntemplateformfieldgroup_response.py b/test/test_ezsigntemplateformfieldgroup_response.py index fde213e6e..46a49339a 100644 --- a/test/test_ezsigntemplateformfieldgroup_response.py +++ b/test/test_ezsigntemplateformfieldgroup_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplateformfieldgroup_response import EzsigntemplateformfieldgroupResponse # noqa: E501 +from eZmaxApi.models.ezsigntemplateformfieldgroup_response import EzsigntemplateformfieldgroupResponse class TestEzsigntemplateformfieldgroupResponse(unittest.TestCase): """EzsigntemplateformfieldgroupResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplateformfieldgroupRespons optional params are included """ # uncomment below to create an instance of `EzsigntemplateformfieldgroupResponse` """ - model = EzsigntemplateformfieldgroupResponse() # noqa: E501 + model = EzsigntemplateformfieldgroupResponse() if include_optional: return EzsigntemplateformfieldgroupResponse( pki_ezsigntemplateformfieldgroup_id = 64, diff --git a/test/test_ezsigntemplateformfieldgroup_response_compound.py b/test/test_ezsigntemplateformfieldgroup_response_compound.py index 28d7065be..6bdb3fe55 100644 --- a/test/test_ezsigntemplateformfieldgroup_response_compound.py +++ b/test/test_ezsigntemplateformfieldgroup_response_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplateformfieldgroup_response_compound import EzsigntemplateformfieldgroupResponseCompound # noqa: E501 +from eZmaxApi.models.ezsigntemplateformfieldgroup_response_compound import EzsigntemplateformfieldgroupResponseCompound class TestEzsigntemplateformfieldgroupResponseCompound(unittest.TestCase): """EzsigntemplateformfieldgroupResponseCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplateformfieldgroupRespons optional params are included """ # uncomment below to create an instance of `EzsigntemplateformfieldgroupResponseCompound` """ - model = EzsigntemplateformfieldgroupResponseCompound() # noqa: E501 + model = EzsigntemplateformfieldgroupResponseCompound() if include_optional: return EzsigntemplateformfieldgroupResponseCompound( pki_ezsigntemplateformfieldgroup_id = 64, diff --git a/test/test_ezsigntemplateformfieldgroupsigner_request.py b/test/test_ezsigntemplateformfieldgroupsigner_request.py index 67ae4071a..d09799d87 100644 --- a/test/test_ezsigntemplateformfieldgroupsigner_request.py +++ b/test/test_ezsigntemplateformfieldgroupsigner_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplateformfieldgroupsigner_request import EzsigntemplateformfieldgroupsignerRequest # noqa: E501 +from eZmaxApi.models.ezsigntemplateformfieldgroupsigner_request import EzsigntemplateformfieldgroupsignerRequest class TestEzsigntemplateformfieldgroupsignerRequest(unittest.TestCase): """EzsigntemplateformfieldgroupsignerRequest unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplateformfieldgroupsignerR optional params are included """ # uncomment below to create an instance of `EzsigntemplateformfieldgroupsignerRequest` """ - model = EzsigntemplateformfieldgroupsignerRequest() # noqa: E501 + model = EzsigntemplateformfieldgroupsignerRequest() if include_optional: return EzsigntemplateformfieldgroupsignerRequest( pki_ezsigntemplateformfieldgroupsigner_id = 87, diff --git a/test/test_ezsigntemplateformfieldgroupsigner_request_compound.py b/test/test_ezsigntemplateformfieldgroupsigner_request_compound.py index 69df4155d..f00607247 100644 --- a/test/test_ezsigntemplateformfieldgroupsigner_request_compound.py +++ b/test/test_ezsigntemplateformfieldgroupsigner_request_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplateformfieldgroupsigner_request_compound import EzsigntemplateformfieldgroupsignerRequestCompound # noqa: E501 +from eZmaxApi.models.ezsigntemplateformfieldgroupsigner_request_compound import EzsigntemplateformfieldgroupsignerRequestCompound class TestEzsigntemplateformfieldgroupsignerRequestCompound(unittest.TestCase): """EzsigntemplateformfieldgroupsignerRequestCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplateformfieldgroupsignerR optional params are included """ # uncomment below to create an instance of `EzsigntemplateformfieldgroupsignerRequestCompound` """ - model = EzsigntemplateformfieldgroupsignerRequestCompound() # noqa: E501 + model = EzsigntemplateformfieldgroupsignerRequestCompound() if include_optional: return EzsigntemplateformfieldgroupsignerRequestCompound( pki_ezsigntemplateformfieldgroupsigner_id = 87, diff --git a/test/test_ezsigntemplateformfieldgroupsigner_response.py b/test/test_ezsigntemplateformfieldgroupsigner_response.py index f17611674..db3eb3a75 100644 --- a/test/test_ezsigntemplateformfieldgroupsigner_response.py +++ b/test/test_ezsigntemplateformfieldgroupsigner_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplateformfieldgroupsigner_response import EzsigntemplateformfieldgroupsignerResponse # noqa: E501 +from eZmaxApi.models.ezsigntemplateformfieldgroupsigner_response import EzsigntemplateformfieldgroupsignerResponse class TestEzsigntemplateformfieldgroupsignerResponse(unittest.TestCase): """EzsigntemplateformfieldgroupsignerResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplateformfieldgroupsignerR optional params are included """ # uncomment below to create an instance of `EzsigntemplateformfieldgroupsignerResponse` """ - model = EzsigntemplateformfieldgroupsignerResponse() # noqa: E501 + model = EzsigntemplateformfieldgroupsignerResponse() if include_optional: return EzsigntemplateformfieldgroupsignerResponse( pki_ezsigntemplateformfieldgroupsigner_id = 87, diff --git a/test/test_ezsigntemplateformfieldgroupsigner_response_compound.py b/test/test_ezsigntemplateformfieldgroupsigner_response_compound.py index f2d4c2a58..b13e518cf 100644 --- a/test/test_ezsigntemplateformfieldgroupsigner_response_compound.py +++ b/test/test_ezsigntemplateformfieldgroupsigner_response_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplateformfieldgroupsigner_response_compound import EzsigntemplateformfieldgroupsignerResponseCompound # noqa: E501 +from eZmaxApi.models.ezsigntemplateformfieldgroupsigner_response_compound import EzsigntemplateformfieldgroupsignerResponseCompound class TestEzsigntemplateformfieldgroupsignerResponseCompound(unittest.TestCase): """EzsigntemplateformfieldgroupsignerResponseCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplateformfieldgroupsignerR optional params are included """ # uncomment below to create an instance of `EzsigntemplateformfieldgroupsignerResponseCompound` """ - model = EzsigntemplateformfieldgroupsignerResponseCompound() # noqa: E501 + model = EzsigntemplateformfieldgroupsignerResponseCompound() if include_optional: return EzsigntemplateformfieldgroupsignerResponseCompound( pki_ezsigntemplateformfieldgroupsigner_id = 87, diff --git a/test/test_ezsigntemplatepackage_autocomplete_element_response.py b/test/test_ezsigntemplatepackage_autocomplete_element_response.py index 46036c392..88498996e 100644 --- a/test/test_ezsigntemplatepackage_autocomplete_element_response.py +++ b/test/test_ezsigntemplatepackage_autocomplete_element_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatepackage_autocomplete_element_response import EzsigntemplatepackageAutocompleteElementResponse # noqa: E501 +from eZmaxApi.models.ezsigntemplatepackage_autocomplete_element_response import EzsigntemplatepackageAutocompleteElementResponse class TestEzsigntemplatepackageAutocompleteElementResponse(unittest.TestCase): """EzsigntemplatepackageAutocompleteElementResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplatepackageAutocompleteEl optional params are included """ # uncomment below to create an instance of `EzsigntemplatepackageAutocompleteElementResponse` """ - model = EzsigntemplatepackageAutocompleteElementResponse() # noqa: E501 + model = EzsigntemplatepackageAutocompleteElementResponse() if include_optional: return EzsigntemplatepackageAutocompleteElementResponse( e_ezsignfoldertype_privacylevel = 'User', diff --git a/test/test_ezsigntemplatepackage_create_object_v1_request.py b/test/test_ezsigntemplatepackage_create_object_v1_request.py index bf2922bb3..504434e35 100644 --- a/test/test_ezsigntemplatepackage_create_object_v1_request.py +++ b/test/test_ezsigntemplatepackage_create_object_v1_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatepackage_create_object_v1_request import EzsigntemplatepackageCreateObjectV1Request # noqa: E501 +from eZmaxApi.models.ezsigntemplatepackage_create_object_v1_request import EzsigntemplatepackageCreateObjectV1Request class TestEzsigntemplatepackageCreateObjectV1Request(unittest.TestCase): """EzsigntemplatepackageCreateObjectV1Request unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplatepackageCreateObjectV1 optional params are included """ # uncomment below to create an instance of `EzsigntemplatepackageCreateObjectV1Request` """ - model = EzsigntemplatepackageCreateObjectV1Request() # noqa: E501 + model = EzsigntemplatepackageCreateObjectV1Request() if include_optional: return EzsigntemplatepackageCreateObjectV1Request( a_obj_ezsigntemplatepackage = [ diff --git a/test/test_ezsigntemplatepackage_create_object_v1_response.py b/test/test_ezsigntemplatepackage_create_object_v1_response.py index 78e1ab60e..9db92af59 100644 --- a/test/test_ezsigntemplatepackage_create_object_v1_response.py +++ b/test/test_ezsigntemplatepackage_create_object_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatepackage_create_object_v1_response import EzsigntemplatepackageCreateObjectV1Response # noqa: E501 +from eZmaxApi.models.ezsigntemplatepackage_create_object_v1_response import EzsigntemplatepackageCreateObjectV1Response class TestEzsigntemplatepackageCreateObjectV1Response(unittest.TestCase): """EzsigntemplatepackageCreateObjectV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplatepackageCreateObjectV1 optional params are included """ # uncomment below to create an instance of `EzsigntemplatepackageCreateObjectV1Response` """ - model = EzsigntemplatepackageCreateObjectV1Response() # noqa: E501 + model = EzsigntemplatepackageCreateObjectV1Response() if include_optional: return EzsigntemplatepackageCreateObjectV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsigntemplatepackage_create_object_v1_response_m_payload.py b/test/test_ezsigntemplatepackage_create_object_v1_response_m_payload.py index ec83ea493..c2415bd16 100644 --- a/test/test_ezsigntemplatepackage_create_object_v1_response_m_payload.py +++ b/test/test_ezsigntemplatepackage_create_object_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatepackage_create_object_v1_response_m_payload import EzsigntemplatepackageCreateObjectV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezsigntemplatepackage_create_object_v1_response_m_payload import EzsigntemplatepackageCreateObjectV1ResponseMPayload class TestEzsigntemplatepackageCreateObjectV1ResponseMPayload(unittest.TestCase): """EzsigntemplatepackageCreateObjectV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplatepackageCreateObjectV1 optional params are included """ # uncomment below to create an instance of `EzsigntemplatepackageCreateObjectV1ResponseMPayload` """ - model = EzsigntemplatepackageCreateObjectV1ResponseMPayload() # noqa: E501 + model = EzsigntemplatepackageCreateObjectV1ResponseMPayload() if include_optional: return EzsigntemplatepackageCreateObjectV1ResponseMPayload( a_pki_ezsigntemplatepackage_id = [ diff --git a/test/test_ezsigntemplatepackage_delete_object_v1_response.py b/test/test_ezsigntemplatepackage_delete_object_v1_response.py index 038886c42..5c4c82962 100644 --- a/test/test_ezsigntemplatepackage_delete_object_v1_response.py +++ b/test/test_ezsigntemplatepackage_delete_object_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatepackage_delete_object_v1_response import EzsigntemplatepackageDeleteObjectV1Response # noqa: E501 +from eZmaxApi.models.ezsigntemplatepackage_delete_object_v1_response import EzsigntemplatepackageDeleteObjectV1Response class TestEzsigntemplatepackageDeleteObjectV1Response(unittest.TestCase): """EzsigntemplatepackageDeleteObjectV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplatepackageDeleteObjectV1 optional params are included """ # uncomment below to create an instance of `EzsigntemplatepackageDeleteObjectV1Response` """ - model = EzsigntemplatepackageDeleteObjectV1Response() # noqa: E501 + model = EzsigntemplatepackageDeleteObjectV1Response() if include_optional: return EzsigntemplatepackageDeleteObjectV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsigntemplatepackage_edit_ezsigntemplatepackagesigners_v1_request.py b/test/test_ezsigntemplatepackage_edit_ezsigntemplatepackagesigners_v1_request.py index 6e9c33fdf..e8bc0f7c3 100644 --- a/test/test_ezsigntemplatepackage_edit_ezsigntemplatepackagesigners_v1_request.py +++ b/test/test_ezsigntemplatepackage_edit_ezsigntemplatepackagesigners_v1_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatepackage_edit_ezsigntemplatepackagesigners_v1_request import EzsigntemplatepackageEditEzsigntemplatepackagesignersV1Request # noqa: E501 +from eZmaxApi.models.ezsigntemplatepackage_edit_ezsigntemplatepackagesigners_v1_request import EzsigntemplatepackageEditEzsigntemplatepackagesignersV1Request class TestEzsigntemplatepackageEditEzsigntemplatepackagesignersV1Request(unittest.TestCase): """EzsigntemplatepackageEditEzsigntemplatepackagesignersV1Request unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplatepackageEditEzsigntemp optional params are included """ # uncomment below to create an instance of `EzsigntemplatepackageEditEzsigntemplatepackagesignersV1Request` """ - model = EzsigntemplatepackageEditEzsigntemplatepackagesignersV1Request() # noqa: E501 + model = EzsigntemplatepackageEditEzsigntemplatepackagesignersV1Request() if include_optional: return EzsigntemplatepackageEditEzsigntemplatepackagesignersV1Request( a_obj_ezsigntemplatepackagesigner = [ diff --git a/test/test_ezsigntemplatepackage_edit_ezsigntemplatepackagesigners_v1_response.py b/test/test_ezsigntemplatepackage_edit_ezsigntemplatepackagesigners_v1_response.py index 8ccb4b834..c9e883aa4 100644 --- a/test/test_ezsigntemplatepackage_edit_ezsigntemplatepackagesigners_v1_response.py +++ b/test/test_ezsigntemplatepackage_edit_ezsigntemplatepackagesigners_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatepackage_edit_ezsigntemplatepackagesigners_v1_response import EzsigntemplatepackageEditEzsigntemplatepackagesignersV1Response # noqa: E501 +from eZmaxApi.models.ezsigntemplatepackage_edit_ezsigntemplatepackagesigners_v1_response import EzsigntemplatepackageEditEzsigntemplatepackagesignersV1Response class TestEzsigntemplatepackageEditEzsigntemplatepackagesignersV1Response(unittest.TestCase): """EzsigntemplatepackageEditEzsigntemplatepackagesignersV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplatepackageEditEzsigntemp optional params are included """ # uncomment below to create an instance of `EzsigntemplatepackageEditEzsigntemplatepackagesignersV1Response` """ - model = EzsigntemplatepackageEditEzsigntemplatepackagesignersV1Response() # noqa: E501 + model = EzsigntemplatepackageEditEzsigntemplatepackagesignersV1Response() if include_optional: return EzsigntemplatepackageEditEzsigntemplatepackagesignersV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsigntemplatepackage_edit_ezsigntemplatepackagesigners_v1_response_m_payload.py b/test/test_ezsigntemplatepackage_edit_ezsigntemplatepackagesigners_v1_response_m_payload.py index 9f1f082f3..3fedc551b 100644 --- a/test/test_ezsigntemplatepackage_edit_ezsigntemplatepackagesigners_v1_response_m_payload.py +++ b/test/test_ezsigntemplatepackage_edit_ezsigntemplatepackagesigners_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatepackage_edit_ezsigntemplatepackagesigners_v1_response_m_payload import EzsigntemplatepackageEditEzsigntemplatepackagesignersV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezsigntemplatepackage_edit_ezsigntemplatepackagesigners_v1_response_m_payload import EzsigntemplatepackageEditEzsigntemplatepackagesignersV1ResponseMPayload class TestEzsigntemplatepackageEditEzsigntemplatepackagesignersV1ResponseMPayload(unittest.TestCase): """EzsigntemplatepackageEditEzsigntemplatepackagesignersV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplatepackageEditEzsigntemp optional params are included """ # uncomment below to create an instance of `EzsigntemplatepackageEditEzsigntemplatepackagesignersV1ResponseMPayload` """ - model = EzsigntemplatepackageEditEzsigntemplatepackagesignersV1ResponseMPayload() # noqa: E501 + model = EzsigntemplatepackageEditEzsigntemplatepackagesignersV1ResponseMPayload() if include_optional: return EzsigntemplatepackageEditEzsigntemplatepackagesignersV1ResponseMPayload( a_pki_ezsigntemplatepackagesigner_id = [ diff --git a/test/test_ezsigntemplatepackage_edit_object_v1_request.py b/test/test_ezsigntemplatepackage_edit_object_v1_request.py index f9218c3d0..9e12e3817 100644 --- a/test/test_ezsigntemplatepackage_edit_object_v1_request.py +++ b/test/test_ezsigntemplatepackage_edit_object_v1_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatepackage_edit_object_v1_request import EzsigntemplatepackageEditObjectV1Request # noqa: E501 +from eZmaxApi.models.ezsigntemplatepackage_edit_object_v1_request import EzsigntemplatepackageEditObjectV1Request class TestEzsigntemplatepackageEditObjectV1Request(unittest.TestCase): """EzsigntemplatepackageEditObjectV1Request unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplatepackageEditObjectV1Re optional params are included """ # uncomment below to create an instance of `EzsigntemplatepackageEditObjectV1Request` """ - model = EzsigntemplatepackageEditObjectV1Request() # noqa: E501 + model = EzsigntemplatepackageEditObjectV1Request() if include_optional: return EzsigntemplatepackageEditObjectV1Request( obj_ezsigntemplatepackage = eZmaxApi.models.ezsigntemplatepackage_request_compound.ezsigntemplatepackage-RequestCompound() diff --git a/test/test_ezsigntemplatepackage_edit_object_v1_response.py b/test/test_ezsigntemplatepackage_edit_object_v1_response.py index e7afb5952..8440532e6 100644 --- a/test/test_ezsigntemplatepackage_edit_object_v1_response.py +++ b/test/test_ezsigntemplatepackage_edit_object_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatepackage_edit_object_v1_response import EzsigntemplatepackageEditObjectV1Response # noqa: E501 +from eZmaxApi.models.ezsigntemplatepackage_edit_object_v1_response import EzsigntemplatepackageEditObjectV1Response class TestEzsigntemplatepackageEditObjectV1Response(unittest.TestCase): """EzsigntemplatepackageEditObjectV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplatepackageEditObjectV1Re optional params are included """ # uncomment below to create an instance of `EzsigntemplatepackageEditObjectV1Response` """ - model = EzsigntemplatepackageEditObjectV1Response() # noqa: E501 + model = EzsigntemplatepackageEditObjectV1Response() if include_optional: return EzsigntemplatepackageEditObjectV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsigntemplatepackage_get_autocomplete_v2_response.py b/test/test_ezsigntemplatepackage_get_autocomplete_v2_response.py index b6e88a4f6..e14183e4d 100644 --- a/test/test_ezsigntemplatepackage_get_autocomplete_v2_response.py +++ b/test/test_ezsigntemplatepackage_get_autocomplete_v2_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatepackage_get_autocomplete_v2_response import EzsigntemplatepackageGetAutocompleteV2Response # noqa: E501 +from eZmaxApi.models.ezsigntemplatepackage_get_autocomplete_v2_response import EzsigntemplatepackageGetAutocompleteV2Response class TestEzsigntemplatepackageGetAutocompleteV2Response(unittest.TestCase): """EzsigntemplatepackageGetAutocompleteV2Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplatepackageGetAutocomplet optional params are included """ # uncomment below to create an instance of `EzsigntemplatepackageGetAutocompleteV2Response` """ - model = EzsigntemplatepackageGetAutocompleteV2Response() # noqa: E501 + model = EzsigntemplatepackageGetAutocompleteV2Response() if include_optional: return EzsigntemplatepackageGetAutocompleteV2Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsigntemplatepackage_get_autocomplete_v2_response_m_payload.py b/test/test_ezsigntemplatepackage_get_autocomplete_v2_response_m_payload.py index cf7a2b831..ccee93727 100644 --- a/test/test_ezsigntemplatepackage_get_autocomplete_v2_response_m_payload.py +++ b/test/test_ezsigntemplatepackage_get_autocomplete_v2_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatepackage_get_autocomplete_v2_response_m_payload import EzsigntemplatepackageGetAutocompleteV2ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezsigntemplatepackage_get_autocomplete_v2_response_m_payload import EzsigntemplatepackageGetAutocompleteV2ResponseMPayload class TestEzsigntemplatepackageGetAutocompleteV2ResponseMPayload(unittest.TestCase): """EzsigntemplatepackageGetAutocompleteV2ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplatepackageGetAutocomplet optional params are included """ # uncomment below to create an instance of `EzsigntemplatepackageGetAutocompleteV2ResponseMPayload` """ - model = EzsigntemplatepackageGetAutocompleteV2ResponseMPayload() # noqa: E501 + model = EzsigntemplatepackageGetAutocompleteV2ResponseMPayload() if include_optional: return EzsigntemplatepackageGetAutocompleteV2ResponseMPayload( a_obj_ezsigntemplatepackage = [ diff --git a/test/test_ezsigntemplatepackage_get_list_v1_response.py b/test/test_ezsigntemplatepackage_get_list_v1_response.py index 3de67a558..1f751a122 100644 --- a/test/test_ezsigntemplatepackage_get_list_v1_response.py +++ b/test/test_ezsigntemplatepackage_get_list_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatepackage_get_list_v1_response import EzsigntemplatepackageGetListV1Response # noqa: E501 +from eZmaxApi.models.ezsigntemplatepackage_get_list_v1_response import EzsigntemplatepackageGetListV1Response class TestEzsigntemplatepackageGetListV1Response(unittest.TestCase): """EzsigntemplatepackageGetListV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplatepackageGetListV1Respo optional params are included """ # uncomment below to create an instance of `EzsigntemplatepackageGetListV1Response` """ - model = EzsigntemplatepackageGetListV1Response() # noqa: E501 + model = EzsigntemplatepackageGetListV1Response() if include_optional: return EzsigntemplatepackageGetListV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload_get_list.Common-Response-objDebugPayload_getList(), diff --git a/test/test_ezsigntemplatepackage_get_list_v1_response_m_payload.py b/test/test_ezsigntemplatepackage_get_list_v1_response_m_payload.py index fce6836bd..0f22439b0 100644 --- a/test/test_ezsigntemplatepackage_get_list_v1_response_m_payload.py +++ b/test/test_ezsigntemplatepackage_get_list_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatepackage_get_list_v1_response_m_payload import EzsigntemplatepackageGetListV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezsigntemplatepackage_get_list_v1_response_m_payload import EzsigntemplatepackageGetListV1ResponseMPayload class TestEzsigntemplatepackageGetListV1ResponseMPayload(unittest.TestCase): """EzsigntemplatepackageGetListV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplatepackageGetListV1Respo optional params are included """ # uncomment below to create an instance of `EzsigntemplatepackageGetListV1ResponseMPayload` """ - model = EzsigntemplatepackageGetListV1ResponseMPayload() # noqa: E501 + model = EzsigntemplatepackageGetListV1ResponseMPayload() if include_optional: return EzsigntemplatepackageGetListV1ResponseMPayload( i_row_returned = 100, diff --git a/test/test_ezsigntemplatepackage_get_object_v2_response.py b/test/test_ezsigntemplatepackage_get_object_v2_response.py index cadc906e5..a8d450879 100644 --- a/test/test_ezsigntemplatepackage_get_object_v2_response.py +++ b/test/test_ezsigntemplatepackage_get_object_v2_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatepackage_get_object_v2_response import EzsigntemplatepackageGetObjectV2Response # noqa: E501 +from eZmaxApi.models.ezsigntemplatepackage_get_object_v2_response import EzsigntemplatepackageGetObjectV2Response class TestEzsigntemplatepackageGetObjectV2Response(unittest.TestCase): """EzsigntemplatepackageGetObjectV2Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplatepackageGetObjectV2Res optional params are included """ # uncomment below to create an instance of `EzsigntemplatepackageGetObjectV2Response` """ - model = EzsigntemplatepackageGetObjectV2Response() # noqa: E501 + model = EzsigntemplatepackageGetObjectV2Response() if include_optional: return EzsigntemplatepackageGetObjectV2Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsigntemplatepackage_get_object_v2_response_m_payload.py b/test/test_ezsigntemplatepackage_get_object_v2_response_m_payload.py index a06378ecc..13589139a 100644 --- a/test/test_ezsigntemplatepackage_get_object_v2_response_m_payload.py +++ b/test/test_ezsigntemplatepackage_get_object_v2_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatepackage_get_object_v2_response_m_payload import EzsigntemplatepackageGetObjectV2ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezsigntemplatepackage_get_object_v2_response_m_payload import EzsigntemplatepackageGetObjectV2ResponseMPayload class TestEzsigntemplatepackageGetObjectV2ResponseMPayload(unittest.TestCase): """EzsigntemplatepackageGetObjectV2ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplatepackageGetObjectV2Res optional params are included """ # uncomment below to create an instance of `EzsigntemplatepackageGetObjectV2ResponseMPayload` """ - model = EzsigntemplatepackageGetObjectV2ResponseMPayload() # noqa: E501 + model = EzsigntemplatepackageGetObjectV2ResponseMPayload() if include_optional: return EzsigntemplatepackageGetObjectV2ResponseMPayload( obj_ezsigntemplatepackage = eZmaxApi.models.ezsigntemplatepackage_response_compound.ezsigntemplatepackage-ResponseCompound() diff --git a/test/test_ezsigntemplatepackage_list_element.py b/test/test_ezsigntemplatepackage_list_element.py index e7038336a..6364799cd 100644 --- a/test/test_ezsigntemplatepackage_list_element.py +++ b/test/test_ezsigntemplatepackage_list_element.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatepackage_list_element import EzsigntemplatepackageListElement # noqa: E501 +from eZmaxApi.models.ezsigntemplatepackage_list_element import EzsigntemplatepackageListElement class TestEzsigntemplatepackageListElement(unittest.TestCase): """EzsigntemplatepackageListElement unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplatepackageListElement: optional params are included """ # uncomment below to create an instance of `EzsigntemplatepackageListElement` """ - model = EzsigntemplatepackageListElement() # noqa: E501 + model = EzsigntemplatepackageListElement() if include_optional: return EzsigntemplatepackageListElement( pki_ezsigntemplatepackage_id = 99, diff --git a/test/test_ezsigntemplatepackage_request.py b/test/test_ezsigntemplatepackage_request.py index ee7904fd5..70b1260fd 100644 --- a/test/test_ezsigntemplatepackage_request.py +++ b/test/test_ezsigntemplatepackage_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatepackage_request import EzsigntemplatepackageRequest # noqa: E501 +from eZmaxApi.models.ezsigntemplatepackage_request import EzsigntemplatepackageRequest class TestEzsigntemplatepackageRequest(unittest.TestCase): """EzsigntemplatepackageRequest unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplatepackageRequest: optional params are included """ # uncomment below to create an instance of `EzsigntemplatepackageRequest` """ - model = EzsigntemplatepackageRequest() # noqa: E501 + model = EzsigntemplatepackageRequest() if include_optional: return EzsigntemplatepackageRequest( pki_ezsigntemplatepackage_id = 99, diff --git a/test/test_ezsigntemplatepackage_request_compound.py b/test/test_ezsigntemplatepackage_request_compound.py index 23ed078c2..d411bdb42 100644 --- a/test/test_ezsigntemplatepackage_request_compound.py +++ b/test/test_ezsigntemplatepackage_request_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatepackage_request_compound import EzsigntemplatepackageRequestCompound # noqa: E501 +from eZmaxApi.models.ezsigntemplatepackage_request_compound import EzsigntemplatepackageRequestCompound class TestEzsigntemplatepackageRequestCompound(unittest.TestCase): """EzsigntemplatepackageRequestCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplatepackageRequestCompoun optional params are included """ # uncomment below to create an instance of `EzsigntemplatepackageRequestCompound` """ - model = EzsigntemplatepackageRequestCompound() # noqa: E501 + model = EzsigntemplatepackageRequestCompound() if include_optional: return EzsigntemplatepackageRequestCompound( pki_ezsigntemplatepackage_id = 99, diff --git a/test/test_ezsigntemplatepackage_response.py b/test/test_ezsigntemplatepackage_response.py index 4650fbb6d..e76545e6c 100644 --- a/test/test_ezsigntemplatepackage_response.py +++ b/test/test_ezsigntemplatepackage_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatepackage_response import EzsigntemplatepackageResponse # noqa: E501 +from eZmaxApi.models.ezsigntemplatepackage_response import EzsigntemplatepackageResponse class TestEzsigntemplatepackageResponse(unittest.TestCase): """EzsigntemplatepackageResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplatepackageResponse: optional params are included """ # uncomment below to create an instance of `EzsigntemplatepackageResponse` """ - model = EzsigntemplatepackageResponse() # noqa: E501 + model = EzsigntemplatepackageResponse() if include_optional: return EzsigntemplatepackageResponse( pki_ezsigntemplatepackage_id = 99, diff --git a/test/test_ezsigntemplatepackage_response_compound.py b/test/test_ezsigntemplatepackage_response_compound.py index 74d7d1eef..ca0802b33 100644 --- a/test/test_ezsigntemplatepackage_response_compound.py +++ b/test/test_ezsigntemplatepackage_response_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatepackage_response_compound import EzsigntemplatepackageResponseCompound # noqa: E501 +from eZmaxApi.models.ezsigntemplatepackage_response_compound import EzsigntemplatepackageResponseCompound class TestEzsigntemplatepackageResponseCompound(unittest.TestCase): """EzsigntemplatepackageResponseCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplatepackageResponseCompou optional params are included """ # uncomment below to create an instance of `EzsigntemplatepackageResponseCompound` """ - model = EzsigntemplatepackageResponseCompound() # noqa: E501 + model = EzsigntemplatepackageResponseCompound() if include_optional: return EzsigntemplatepackageResponseCompound( pki_ezsigntemplatepackage_id = 99, diff --git a/test/test_ezsigntemplatepackagemembership_create_object_v1_request.py b/test/test_ezsigntemplatepackagemembership_create_object_v1_request.py index 62bcfe10f..716d83e8f 100644 --- a/test/test_ezsigntemplatepackagemembership_create_object_v1_request.py +++ b/test/test_ezsigntemplatepackagemembership_create_object_v1_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatepackagemembership_create_object_v1_request import EzsigntemplatepackagemembershipCreateObjectV1Request # noqa: E501 +from eZmaxApi.models.ezsigntemplatepackagemembership_create_object_v1_request import EzsigntemplatepackagemembershipCreateObjectV1Request class TestEzsigntemplatepackagemembershipCreateObjectV1Request(unittest.TestCase): """EzsigntemplatepackagemembershipCreateObjectV1Request unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplatepackagemembershipCrea optional params are included """ # uncomment below to create an instance of `EzsigntemplatepackagemembershipCreateObjectV1Request` """ - model = EzsigntemplatepackagemembershipCreateObjectV1Request() # noqa: E501 + model = EzsigntemplatepackagemembershipCreateObjectV1Request() if include_optional: return EzsigntemplatepackagemembershipCreateObjectV1Request( a_obj_ezsigntemplatepackagemembership = [ diff --git a/test/test_ezsigntemplatepackagemembership_create_object_v1_response.py b/test/test_ezsigntemplatepackagemembership_create_object_v1_response.py index a854c66b2..d232d61ec 100644 --- a/test/test_ezsigntemplatepackagemembership_create_object_v1_response.py +++ b/test/test_ezsigntemplatepackagemembership_create_object_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatepackagemembership_create_object_v1_response import EzsigntemplatepackagemembershipCreateObjectV1Response # noqa: E501 +from eZmaxApi.models.ezsigntemplatepackagemembership_create_object_v1_response import EzsigntemplatepackagemembershipCreateObjectV1Response class TestEzsigntemplatepackagemembershipCreateObjectV1Response(unittest.TestCase): """EzsigntemplatepackagemembershipCreateObjectV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplatepackagemembershipCrea optional params are included """ # uncomment below to create an instance of `EzsigntemplatepackagemembershipCreateObjectV1Response` """ - model = EzsigntemplatepackagemembershipCreateObjectV1Response() # noqa: E501 + model = EzsigntemplatepackagemembershipCreateObjectV1Response() if include_optional: return EzsigntemplatepackagemembershipCreateObjectV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsigntemplatepackagemembership_create_object_v1_response_m_payload.py b/test/test_ezsigntemplatepackagemembership_create_object_v1_response_m_payload.py index 7abf721d5..4b7139eeb 100644 --- a/test/test_ezsigntemplatepackagemembership_create_object_v1_response_m_payload.py +++ b/test/test_ezsigntemplatepackagemembership_create_object_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatepackagemembership_create_object_v1_response_m_payload import EzsigntemplatepackagemembershipCreateObjectV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezsigntemplatepackagemembership_create_object_v1_response_m_payload import EzsigntemplatepackagemembershipCreateObjectV1ResponseMPayload class TestEzsigntemplatepackagemembershipCreateObjectV1ResponseMPayload(unittest.TestCase): """EzsigntemplatepackagemembershipCreateObjectV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplatepackagemembershipCrea optional params are included """ # uncomment below to create an instance of `EzsigntemplatepackagemembershipCreateObjectV1ResponseMPayload` """ - model = EzsigntemplatepackagemembershipCreateObjectV1ResponseMPayload() # noqa: E501 + model = EzsigntemplatepackagemembershipCreateObjectV1ResponseMPayload() if include_optional: return EzsigntemplatepackagemembershipCreateObjectV1ResponseMPayload( a_pki_ezsigntemplatepackagemembership_id = [ diff --git a/test/test_ezsigntemplatepackagemembership_delete_object_v1_response.py b/test/test_ezsigntemplatepackagemembership_delete_object_v1_response.py index c10b736aa..2f1151308 100644 --- a/test/test_ezsigntemplatepackagemembership_delete_object_v1_response.py +++ b/test/test_ezsigntemplatepackagemembership_delete_object_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatepackagemembership_delete_object_v1_response import EzsigntemplatepackagemembershipDeleteObjectV1Response # noqa: E501 +from eZmaxApi.models.ezsigntemplatepackagemembership_delete_object_v1_response import EzsigntemplatepackagemembershipDeleteObjectV1Response class TestEzsigntemplatepackagemembershipDeleteObjectV1Response(unittest.TestCase): """EzsigntemplatepackagemembershipDeleteObjectV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplatepackagemembershipDele optional params are included """ # uncomment below to create an instance of `EzsigntemplatepackagemembershipDeleteObjectV1Response` """ - model = EzsigntemplatepackagemembershipDeleteObjectV1Response() # noqa: E501 + model = EzsigntemplatepackagemembershipDeleteObjectV1Response() if include_optional: return EzsigntemplatepackagemembershipDeleteObjectV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsigntemplatepackagemembership_get_object_v2_response.py b/test/test_ezsigntemplatepackagemembership_get_object_v2_response.py index c2a63a172..78bccc769 100644 --- a/test/test_ezsigntemplatepackagemembership_get_object_v2_response.py +++ b/test/test_ezsigntemplatepackagemembership_get_object_v2_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatepackagemembership_get_object_v2_response import EzsigntemplatepackagemembershipGetObjectV2Response # noqa: E501 +from eZmaxApi.models.ezsigntemplatepackagemembership_get_object_v2_response import EzsigntemplatepackagemembershipGetObjectV2Response class TestEzsigntemplatepackagemembershipGetObjectV2Response(unittest.TestCase): """EzsigntemplatepackagemembershipGetObjectV2Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplatepackagemembershipGetO optional params are included """ # uncomment below to create an instance of `EzsigntemplatepackagemembershipGetObjectV2Response` """ - model = EzsigntemplatepackagemembershipGetObjectV2Response() # noqa: E501 + model = EzsigntemplatepackagemembershipGetObjectV2Response() if include_optional: return EzsigntemplatepackagemembershipGetObjectV2Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsigntemplatepackagemembership_get_object_v2_response_m_payload.py b/test/test_ezsigntemplatepackagemembership_get_object_v2_response_m_payload.py index 3917bde7a..14657ed0f 100644 --- a/test/test_ezsigntemplatepackagemembership_get_object_v2_response_m_payload.py +++ b/test/test_ezsigntemplatepackagemembership_get_object_v2_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatepackagemembership_get_object_v2_response_m_payload import EzsigntemplatepackagemembershipGetObjectV2ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezsigntemplatepackagemembership_get_object_v2_response_m_payload import EzsigntemplatepackagemembershipGetObjectV2ResponseMPayload class TestEzsigntemplatepackagemembershipGetObjectV2ResponseMPayload(unittest.TestCase): """EzsigntemplatepackagemembershipGetObjectV2ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplatepackagemembershipGetO optional params are included """ # uncomment below to create an instance of `EzsigntemplatepackagemembershipGetObjectV2ResponseMPayload` """ - model = EzsigntemplatepackagemembershipGetObjectV2ResponseMPayload() # noqa: E501 + model = EzsigntemplatepackagemembershipGetObjectV2ResponseMPayload() if include_optional: return EzsigntemplatepackagemembershipGetObjectV2ResponseMPayload( obj_ezsigntemplatepackagemembership = eZmaxApi.models.ezsigntemplatepackagemembership_response_compound.ezsigntemplatepackagemembership-ResponseCompound() diff --git a/test/test_ezsigntemplatepackagemembership_request.py b/test/test_ezsigntemplatepackagemembership_request.py index 9c49d22b9..813126393 100644 --- a/test/test_ezsigntemplatepackagemembership_request.py +++ b/test/test_ezsigntemplatepackagemembership_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatepackagemembership_request import EzsigntemplatepackagemembershipRequest # noqa: E501 +from eZmaxApi.models.ezsigntemplatepackagemembership_request import EzsigntemplatepackagemembershipRequest class TestEzsigntemplatepackagemembershipRequest(unittest.TestCase): """EzsigntemplatepackagemembershipRequest unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplatepackagemembershipRequ optional params are included """ # uncomment below to create an instance of `EzsigntemplatepackagemembershipRequest` """ - model = EzsigntemplatepackagemembershipRequest() # noqa: E501 + model = EzsigntemplatepackagemembershipRequest() if include_optional: return EzsigntemplatepackagemembershipRequest( pki_ezsigntemplatepackagemembership_id = 194, diff --git a/test/test_ezsigntemplatepackagemembership_request_compound.py b/test/test_ezsigntemplatepackagemembership_request_compound.py index 2de946bf2..ecd774613 100644 --- a/test/test_ezsigntemplatepackagemembership_request_compound.py +++ b/test/test_ezsigntemplatepackagemembership_request_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatepackagemembership_request_compound import EzsigntemplatepackagemembershipRequestCompound # noqa: E501 +from eZmaxApi.models.ezsigntemplatepackagemembership_request_compound import EzsigntemplatepackagemembershipRequestCompound class TestEzsigntemplatepackagemembershipRequestCompound(unittest.TestCase): """EzsigntemplatepackagemembershipRequestCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplatepackagemembershipRequ optional params are included """ # uncomment below to create an instance of `EzsigntemplatepackagemembershipRequestCompound` """ - model = EzsigntemplatepackagemembershipRequestCompound() # noqa: E501 + model = EzsigntemplatepackagemembershipRequestCompound() if include_optional: return EzsigntemplatepackagemembershipRequestCompound( pki_ezsigntemplatepackagemembership_id = 194, diff --git a/test/test_ezsigntemplatepackagemembership_response.py b/test/test_ezsigntemplatepackagemembership_response.py index 6529fbfc9..2e5e53a2e 100644 --- a/test/test_ezsigntemplatepackagemembership_response.py +++ b/test/test_ezsigntemplatepackagemembership_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatepackagemembership_response import EzsigntemplatepackagemembershipResponse # noqa: E501 +from eZmaxApi.models.ezsigntemplatepackagemembership_response import EzsigntemplatepackagemembershipResponse class TestEzsigntemplatepackagemembershipResponse(unittest.TestCase): """EzsigntemplatepackagemembershipResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplatepackagemembershipResp optional params are included """ # uncomment below to create an instance of `EzsigntemplatepackagemembershipResponse` """ - model = EzsigntemplatepackagemembershipResponse() # noqa: E501 + model = EzsigntemplatepackagemembershipResponse() if include_optional: return EzsigntemplatepackagemembershipResponse( pki_ezsigntemplatepackagemembership_id = 194, diff --git a/test/test_ezsigntemplatepackagemembership_response_compound.py b/test/test_ezsigntemplatepackagemembership_response_compound.py index c80812eb4..4c86dc024 100644 --- a/test/test_ezsigntemplatepackagemembership_response_compound.py +++ b/test/test_ezsigntemplatepackagemembership_response_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatepackagemembership_response_compound import EzsigntemplatepackagemembershipResponseCompound # noqa: E501 +from eZmaxApi.models.ezsigntemplatepackagemembership_response_compound import EzsigntemplatepackagemembershipResponseCompound class TestEzsigntemplatepackagemembershipResponseCompound(unittest.TestCase): """EzsigntemplatepackagemembershipResponseCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplatepackagemembershipResp optional params are included """ # uncomment below to create an instance of `EzsigntemplatepackagemembershipResponseCompound` """ - model = EzsigntemplatepackagemembershipResponseCompound() # noqa: E501 + model = EzsigntemplatepackagemembershipResponseCompound() if include_optional: return EzsigntemplatepackagemembershipResponseCompound( pki_ezsigntemplatepackagemembership_id = 194, diff --git a/test/test_ezsigntemplatepackagesigner_create_object_v1_request.py b/test/test_ezsigntemplatepackagesigner_create_object_v1_request.py index 61ee59ee7..5131e86bd 100644 --- a/test/test_ezsigntemplatepackagesigner_create_object_v1_request.py +++ b/test/test_ezsigntemplatepackagesigner_create_object_v1_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatepackagesigner_create_object_v1_request import EzsigntemplatepackagesignerCreateObjectV1Request # noqa: E501 +from eZmaxApi.models.ezsigntemplatepackagesigner_create_object_v1_request import EzsigntemplatepackagesignerCreateObjectV1Request class TestEzsigntemplatepackagesignerCreateObjectV1Request(unittest.TestCase): """EzsigntemplatepackagesignerCreateObjectV1Request unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplatepackagesignerCreateOb optional params are included """ # uncomment below to create an instance of `EzsigntemplatepackagesignerCreateObjectV1Request` """ - model = EzsigntemplatepackagesignerCreateObjectV1Request() # noqa: E501 + model = EzsigntemplatepackagesignerCreateObjectV1Request() if include_optional: return EzsigntemplatepackagesignerCreateObjectV1Request( a_obj_ezsigntemplatepackagesigner = [ diff --git a/test/test_ezsigntemplatepackagesigner_create_object_v1_response.py b/test/test_ezsigntemplatepackagesigner_create_object_v1_response.py index 76d8ca00a..932048b51 100644 --- a/test/test_ezsigntemplatepackagesigner_create_object_v1_response.py +++ b/test/test_ezsigntemplatepackagesigner_create_object_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatepackagesigner_create_object_v1_response import EzsigntemplatepackagesignerCreateObjectV1Response # noqa: E501 +from eZmaxApi.models.ezsigntemplatepackagesigner_create_object_v1_response import EzsigntemplatepackagesignerCreateObjectV1Response class TestEzsigntemplatepackagesignerCreateObjectV1Response(unittest.TestCase): """EzsigntemplatepackagesignerCreateObjectV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplatepackagesignerCreateOb optional params are included """ # uncomment below to create an instance of `EzsigntemplatepackagesignerCreateObjectV1Response` """ - model = EzsigntemplatepackagesignerCreateObjectV1Response() # noqa: E501 + model = EzsigntemplatepackagesignerCreateObjectV1Response() if include_optional: return EzsigntemplatepackagesignerCreateObjectV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsigntemplatepackagesigner_create_object_v1_response_m_payload.py b/test/test_ezsigntemplatepackagesigner_create_object_v1_response_m_payload.py index e7c1342db..0bc77c68c 100644 --- a/test/test_ezsigntemplatepackagesigner_create_object_v1_response_m_payload.py +++ b/test/test_ezsigntemplatepackagesigner_create_object_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatepackagesigner_create_object_v1_response_m_payload import EzsigntemplatepackagesignerCreateObjectV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezsigntemplatepackagesigner_create_object_v1_response_m_payload import EzsigntemplatepackagesignerCreateObjectV1ResponseMPayload class TestEzsigntemplatepackagesignerCreateObjectV1ResponseMPayload(unittest.TestCase): """EzsigntemplatepackagesignerCreateObjectV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplatepackagesignerCreateOb optional params are included """ # uncomment below to create an instance of `EzsigntemplatepackagesignerCreateObjectV1ResponseMPayload` """ - model = EzsigntemplatepackagesignerCreateObjectV1ResponseMPayload() # noqa: E501 + model = EzsigntemplatepackagesignerCreateObjectV1ResponseMPayload() if include_optional: return EzsigntemplatepackagesignerCreateObjectV1ResponseMPayload( a_pki_ezsigntemplatepackagesigner_id = [ diff --git a/test/test_ezsigntemplatepackagesigner_delete_object_v1_response.py b/test/test_ezsigntemplatepackagesigner_delete_object_v1_response.py index 20969597a..4182fc3e3 100644 --- a/test/test_ezsigntemplatepackagesigner_delete_object_v1_response.py +++ b/test/test_ezsigntemplatepackagesigner_delete_object_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatepackagesigner_delete_object_v1_response import EzsigntemplatepackagesignerDeleteObjectV1Response # noqa: E501 +from eZmaxApi.models.ezsigntemplatepackagesigner_delete_object_v1_response import EzsigntemplatepackagesignerDeleteObjectV1Response class TestEzsigntemplatepackagesignerDeleteObjectV1Response(unittest.TestCase): """EzsigntemplatepackagesignerDeleteObjectV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplatepackagesignerDeleteOb optional params are included """ # uncomment below to create an instance of `EzsigntemplatepackagesignerDeleteObjectV1Response` """ - model = EzsigntemplatepackagesignerDeleteObjectV1Response() # noqa: E501 + model = EzsigntemplatepackagesignerDeleteObjectV1Response() if include_optional: return EzsigntemplatepackagesignerDeleteObjectV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsigntemplatepackagesigner_delete_object_v1_response_m_payload.py b/test/test_ezsigntemplatepackagesigner_delete_object_v1_response_m_payload.py index 69dd074b7..a94a93287 100644 --- a/test/test_ezsigntemplatepackagesigner_delete_object_v1_response_m_payload.py +++ b/test/test_ezsigntemplatepackagesigner_delete_object_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatepackagesigner_delete_object_v1_response_m_payload import EzsigntemplatepackagesignerDeleteObjectV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezsigntemplatepackagesigner_delete_object_v1_response_m_payload import EzsigntemplatepackagesignerDeleteObjectV1ResponseMPayload class TestEzsigntemplatepackagesignerDeleteObjectV1ResponseMPayload(unittest.TestCase): """EzsigntemplatepackagesignerDeleteObjectV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplatepackagesignerDeleteOb optional params are included """ # uncomment below to create an instance of `EzsigntemplatepackagesignerDeleteObjectV1ResponseMPayload` """ - model = EzsigntemplatepackagesignerDeleteObjectV1ResponseMPayload() # noqa: E501 + model = EzsigntemplatepackagesignerDeleteObjectV1ResponseMPayload() if include_optional: return EzsigntemplatepackagesignerDeleteObjectV1ResponseMPayload( b_ezsigntemplatepackage_needvalidation = True, diff --git a/test/test_ezsigntemplatepackagesigner_edit_object_v1_request.py b/test/test_ezsigntemplatepackagesigner_edit_object_v1_request.py index 46fad8188..fbf2b41ca 100644 --- a/test/test_ezsigntemplatepackagesigner_edit_object_v1_request.py +++ b/test/test_ezsigntemplatepackagesigner_edit_object_v1_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatepackagesigner_edit_object_v1_request import EzsigntemplatepackagesignerEditObjectV1Request # noqa: E501 +from eZmaxApi.models.ezsigntemplatepackagesigner_edit_object_v1_request import EzsigntemplatepackagesignerEditObjectV1Request class TestEzsigntemplatepackagesignerEditObjectV1Request(unittest.TestCase): """EzsigntemplatepackagesignerEditObjectV1Request unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplatepackagesignerEditObje optional params are included """ # uncomment below to create an instance of `EzsigntemplatepackagesignerEditObjectV1Request` """ - model = EzsigntemplatepackagesignerEditObjectV1Request() # noqa: E501 + model = EzsigntemplatepackagesignerEditObjectV1Request() if include_optional: return EzsigntemplatepackagesignerEditObjectV1Request( obj_ezsigntemplatepackagesigner = eZmaxApi.models.ezsigntemplatepackagesigner_request_compound.ezsigntemplatepackagesigner-RequestCompound() diff --git a/test/test_ezsigntemplatepackagesigner_edit_object_v1_response.py b/test/test_ezsigntemplatepackagesigner_edit_object_v1_response.py index eb6382412..2fd9daa6f 100644 --- a/test/test_ezsigntemplatepackagesigner_edit_object_v1_response.py +++ b/test/test_ezsigntemplatepackagesigner_edit_object_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatepackagesigner_edit_object_v1_response import EzsigntemplatepackagesignerEditObjectV1Response # noqa: E501 +from eZmaxApi.models.ezsigntemplatepackagesigner_edit_object_v1_response import EzsigntemplatepackagesignerEditObjectV1Response class TestEzsigntemplatepackagesignerEditObjectV1Response(unittest.TestCase): """EzsigntemplatepackagesignerEditObjectV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplatepackagesignerEditObje optional params are included """ # uncomment below to create an instance of `EzsigntemplatepackagesignerEditObjectV1Response` """ - model = EzsigntemplatepackagesignerEditObjectV1Response() # noqa: E501 + model = EzsigntemplatepackagesignerEditObjectV1Response() if include_optional: return EzsigntemplatepackagesignerEditObjectV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsigntemplatepackagesigner_get_object_v2_response.py b/test/test_ezsigntemplatepackagesigner_get_object_v2_response.py index 1edaff603..e9e4df2bb 100644 --- a/test/test_ezsigntemplatepackagesigner_get_object_v2_response.py +++ b/test/test_ezsigntemplatepackagesigner_get_object_v2_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatepackagesigner_get_object_v2_response import EzsigntemplatepackagesignerGetObjectV2Response # noqa: E501 +from eZmaxApi.models.ezsigntemplatepackagesigner_get_object_v2_response import EzsigntemplatepackagesignerGetObjectV2Response class TestEzsigntemplatepackagesignerGetObjectV2Response(unittest.TestCase): """EzsigntemplatepackagesignerGetObjectV2Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplatepackagesignerGetObjec optional params are included """ # uncomment below to create an instance of `EzsigntemplatepackagesignerGetObjectV2Response` """ - model = EzsigntemplatepackagesignerGetObjectV2Response() # noqa: E501 + model = EzsigntemplatepackagesignerGetObjectV2Response() if include_optional: return EzsigntemplatepackagesignerGetObjectV2Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsigntemplatepackagesigner_get_object_v2_response_m_payload.py b/test/test_ezsigntemplatepackagesigner_get_object_v2_response_m_payload.py index e77cbd2ee..f35191c8a 100644 --- a/test/test_ezsigntemplatepackagesigner_get_object_v2_response_m_payload.py +++ b/test/test_ezsigntemplatepackagesigner_get_object_v2_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatepackagesigner_get_object_v2_response_m_payload import EzsigntemplatepackagesignerGetObjectV2ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezsigntemplatepackagesigner_get_object_v2_response_m_payload import EzsigntemplatepackagesignerGetObjectV2ResponseMPayload class TestEzsigntemplatepackagesignerGetObjectV2ResponseMPayload(unittest.TestCase): """EzsigntemplatepackagesignerGetObjectV2ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplatepackagesignerGetObjec optional params are included """ # uncomment below to create an instance of `EzsigntemplatepackagesignerGetObjectV2ResponseMPayload` """ - model = EzsigntemplatepackagesignerGetObjectV2ResponseMPayload() # noqa: E501 + model = EzsigntemplatepackagesignerGetObjectV2ResponseMPayload() if include_optional: return EzsigntemplatepackagesignerGetObjectV2ResponseMPayload( obj_ezsigntemplatepackagesigner = eZmaxApi.models.ezsigntemplatepackagesigner_response_compound.ezsigntemplatepackagesigner-ResponseCompound() diff --git a/test/test_ezsigntemplatepackagesigner_request.py b/test/test_ezsigntemplatepackagesigner_request.py index 9228cdb55..122073c13 100644 --- a/test/test_ezsigntemplatepackagesigner_request.py +++ b/test/test_ezsigntemplatepackagesigner_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatepackagesigner_request import EzsigntemplatepackagesignerRequest # noqa: E501 +from eZmaxApi.models.ezsigntemplatepackagesigner_request import EzsigntemplatepackagesignerRequest class TestEzsigntemplatepackagesignerRequest(unittest.TestCase): """EzsigntemplatepackagesignerRequest unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplatepackagesignerRequest: optional params are included """ # uncomment below to create an instance of `EzsigntemplatepackagesignerRequest` """ - model = EzsigntemplatepackagesignerRequest() # noqa: E501 + model = EzsigntemplatepackagesignerRequest() if include_optional: return EzsigntemplatepackagesignerRequest( pki_ezsigntemplatepackagesigner_id = 174, diff --git a/test/test_ezsigntemplatepackagesigner_request_compound.py b/test/test_ezsigntemplatepackagesigner_request_compound.py index b406d6862..01815668e 100644 --- a/test/test_ezsigntemplatepackagesigner_request_compound.py +++ b/test/test_ezsigntemplatepackagesigner_request_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatepackagesigner_request_compound import EzsigntemplatepackagesignerRequestCompound # noqa: E501 +from eZmaxApi.models.ezsigntemplatepackagesigner_request_compound import EzsigntemplatepackagesignerRequestCompound class TestEzsigntemplatepackagesignerRequestCompound(unittest.TestCase): """EzsigntemplatepackagesignerRequestCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplatepackagesignerRequestC optional params are included """ # uncomment below to create an instance of `EzsigntemplatepackagesignerRequestCompound` """ - model = EzsigntemplatepackagesignerRequestCompound() # noqa: E501 + model = EzsigntemplatepackagesignerRequestCompound() if include_optional: return EzsigntemplatepackagesignerRequestCompound( pki_ezsigntemplatepackagesigner_id = 174, diff --git a/test/test_ezsigntemplatepackagesigner_response.py b/test/test_ezsigntemplatepackagesigner_response.py index 475ca280f..a269b6713 100644 --- a/test/test_ezsigntemplatepackagesigner_response.py +++ b/test/test_ezsigntemplatepackagesigner_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatepackagesigner_response import EzsigntemplatepackagesignerResponse # noqa: E501 +from eZmaxApi.models.ezsigntemplatepackagesigner_response import EzsigntemplatepackagesignerResponse class TestEzsigntemplatepackagesignerResponse(unittest.TestCase): """EzsigntemplatepackagesignerResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplatepackagesignerResponse optional params are included """ # uncomment below to create an instance of `EzsigntemplatepackagesignerResponse` """ - model = EzsigntemplatepackagesignerResponse() # noqa: E501 + model = EzsigntemplatepackagesignerResponse() if include_optional: return EzsigntemplatepackagesignerResponse( pki_ezsigntemplatepackagesigner_id = 174, diff --git a/test/test_ezsigntemplatepackagesigner_response_compound.py b/test/test_ezsigntemplatepackagesigner_response_compound.py index 777193306..79defa64d 100644 --- a/test/test_ezsigntemplatepackagesigner_response_compound.py +++ b/test/test_ezsigntemplatepackagesigner_response_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatepackagesigner_response_compound import EzsigntemplatepackagesignerResponseCompound # noqa: E501 +from eZmaxApi.models.ezsigntemplatepackagesigner_response_compound import EzsigntemplatepackagesignerResponseCompound class TestEzsigntemplatepackagesignerResponseCompound(unittest.TestCase): """EzsigntemplatepackagesignerResponseCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplatepackagesignerResponse optional params are included """ # uncomment below to create an instance of `EzsigntemplatepackagesignerResponseCompound` """ - model = EzsigntemplatepackagesignerResponseCompound() # noqa: E501 + model = EzsigntemplatepackagesignerResponseCompound() if include_optional: return EzsigntemplatepackagesignerResponseCompound( pki_ezsigntemplatepackagesigner_id = 174, diff --git a/test/test_ezsigntemplatepackagesignermembership_create_object_v1_request.py b/test/test_ezsigntemplatepackagesignermembership_create_object_v1_request.py index 884ed47c3..6ecf26d03 100644 --- a/test/test_ezsigntemplatepackagesignermembership_create_object_v1_request.py +++ b/test/test_ezsigntemplatepackagesignermembership_create_object_v1_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatepackagesignermembership_create_object_v1_request import EzsigntemplatepackagesignermembershipCreateObjectV1Request # noqa: E501 +from eZmaxApi.models.ezsigntemplatepackagesignermembership_create_object_v1_request import EzsigntemplatepackagesignermembershipCreateObjectV1Request class TestEzsigntemplatepackagesignermembershipCreateObjectV1Request(unittest.TestCase): """EzsigntemplatepackagesignermembershipCreateObjectV1Request unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> Ezsigntemplatepackagesignermembersh optional params are included """ # uncomment below to create an instance of `EzsigntemplatepackagesignermembershipCreateObjectV1Request` """ - model = EzsigntemplatepackagesignermembershipCreateObjectV1Request() # noqa: E501 + model = EzsigntemplatepackagesignermembershipCreateObjectV1Request() if include_optional: return EzsigntemplatepackagesignermembershipCreateObjectV1Request( a_obj_ezsigntemplatepackagesignermembership = [ diff --git a/test/test_ezsigntemplatepackagesignermembership_create_object_v1_response.py b/test/test_ezsigntemplatepackagesignermembership_create_object_v1_response.py index 735367f90..e714f951d 100644 --- a/test/test_ezsigntemplatepackagesignermembership_create_object_v1_response.py +++ b/test/test_ezsigntemplatepackagesignermembership_create_object_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatepackagesignermembership_create_object_v1_response import EzsigntemplatepackagesignermembershipCreateObjectV1Response # noqa: E501 +from eZmaxApi.models.ezsigntemplatepackagesignermembership_create_object_v1_response import EzsigntemplatepackagesignermembershipCreateObjectV1Response class TestEzsigntemplatepackagesignermembershipCreateObjectV1Response(unittest.TestCase): """EzsigntemplatepackagesignermembershipCreateObjectV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> Ezsigntemplatepackagesignermembersh optional params are included """ # uncomment below to create an instance of `EzsigntemplatepackagesignermembershipCreateObjectV1Response` """ - model = EzsigntemplatepackagesignermembershipCreateObjectV1Response() # noqa: E501 + model = EzsigntemplatepackagesignermembershipCreateObjectV1Response() if include_optional: return EzsigntemplatepackagesignermembershipCreateObjectV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsigntemplatepackagesignermembership_create_object_v1_response_m_payload.py b/test/test_ezsigntemplatepackagesignermembership_create_object_v1_response_m_payload.py index 3d5a0430e..70f0147c9 100644 --- a/test/test_ezsigntemplatepackagesignermembership_create_object_v1_response_m_payload.py +++ b/test/test_ezsigntemplatepackagesignermembership_create_object_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatepackagesignermembership_create_object_v1_response_m_payload import EzsigntemplatepackagesignermembershipCreateObjectV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezsigntemplatepackagesignermembership_create_object_v1_response_m_payload import EzsigntemplatepackagesignermembershipCreateObjectV1ResponseMPayload class TestEzsigntemplatepackagesignermembershipCreateObjectV1ResponseMPayload(unittest.TestCase): """EzsigntemplatepackagesignermembershipCreateObjectV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> Ezsigntemplatepackagesignermembersh optional params are included """ # uncomment below to create an instance of `EzsigntemplatepackagesignermembershipCreateObjectV1ResponseMPayload` """ - model = EzsigntemplatepackagesignermembershipCreateObjectV1ResponseMPayload() # noqa: E501 + model = EzsigntemplatepackagesignermembershipCreateObjectV1ResponseMPayload() if include_optional: return EzsigntemplatepackagesignermembershipCreateObjectV1ResponseMPayload( a_pki_ezsigntemplatepackagesignermembership_id = [ diff --git a/test/test_ezsigntemplatepackagesignermembership_delete_object_v1_response.py b/test/test_ezsigntemplatepackagesignermembership_delete_object_v1_response.py index 99b8269b1..261217344 100644 --- a/test/test_ezsigntemplatepackagesignermembership_delete_object_v1_response.py +++ b/test/test_ezsigntemplatepackagesignermembership_delete_object_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatepackagesignermembership_delete_object_v1_response import EzsigntemplatepackagesignermembershipDeleteObjectV1Response # noqa: E501 +from eZmaxApi.models.ezsigntemplatepackagesignermembership_delete_object_v1_response import EzsigntemplatepackagesignermembershipDeleteObjectV1Response class TestEzsigntemplatepackagesignermembershipDeleteObjectV1Response(unittest.TestCase): """EzsigntemplatepackagesignermembershipDeleteObjectV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> Ezsigntemplatepackagesignermembersh optional params are included """ # uncomment below to create an instance of `EzsigntemplatepackagesignermembershipDeleteObjectV1Response` """ - model = EzsigntemplatepackagesignermembershipDeleteObjectV1Response() # noqa: E501 + model = EzsigntemplatepackagesignermembershipDeleteObjectV1Response() if include_optional: return EzsigntemplatepackagesignermembershipDeleteObjectV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsigntemplatepackagesignermembership_delete_object_v1_response_m_payload.py b/test/test_ezsigntemplatepackagesignermembership_delete_object_v1_response_m_payload.py index 8aa983823..6aa915e9c 100644 --- a/test/test_ezsigntemplatepackagesignermembership_delete_object_v1_response_m_payload.py +++ b/test/test_ezsigntemplatepackagesignermembership_delete_object_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatepackagesignermembership_delete_object_v1_response_m_payload import EzsigntemplatepackagesignermembershipDeleteObjectV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezsigntemplatepackagesignermembership_delete_object_v1_response_m_payload import EzsigntemplatepackagesignermembershipDeleteObjectV1ResponseMPayload class TestEzsigntemplatepackagesignermembershipDeleteObjectV1ResponseMPayload(unittest.TestCase): """EzsigntemplatepackagesignermembershipDeleteObjectV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> Ezsigntemplatepackagesignermembersh optional params are included """ # uncomment below to create an instance of `EzsigntemplatepackagesignermembershipDeleteObjectV1ResponseMPayload` """ - model = EzsigntemplatepackagesignermembershipDeleteObjectV1ResponseMPayload() # noqa: E501 + model = EzsigntemplatepackagesignermembershipDeleteObjectV1ResponseMPayload() if include_optional: return EzsigntemplatepackagesignermembershipDeleteObjectV1ResponseMPayload( b_ezsigntemplatepackage_needvalidation = True, diff --git a/test/test_ezsigntemplatepackagesignermembership_get_object_v2_response.py b/test/test_ezsigntemplatepackagesignermembership_get_object_v2_response.py index 9cffc91bd..44f106431 100644 --- a/test/test_ezsigntemplatepackagesignermembership_get_object_v2_response.py +++ b/test/test_ezsigntemplatepackagesignermembership_get_object_v2_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatepackagesignermembership_get_object_v2_response import EzsigntemplatepackagesignermembershipGetObjectV2Response # noqa: E501 +from eZmaxApi.models.ezsigntemplatepackagesignermembership_get_object_v2_response import EzsigntemplatepackagesignermembershipGetObjectV2Response class TestEzsigntemplatepackagesignermembershipGetObjectV2Response(unittest.TestCase): """EzsigntemplatepackagesignermembershipGetObjectV2Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> Ezsigntemplatepackagesignermembersh optional params are included """ # uncomment below to create an instance of `EzsigntemplatepackagesignermembershipGetObjectV2Response` """ - model = EzsigntemplatepackagesignermembershipGetObjectV2Response() # noqa: E501 + model = EzsigntemplatepackagesignermembershipGetObjectV2Response() if include_optional: return EzsigntemplatepackagesignermembershipGetObjectV2Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsigntemplatepackagesignermembership_get_object_v2_response_m_payload.py b/test/test_ezsigntemplatepackagesignermembership_get_object_v2_response_m_payload.py index 6150000f4..4772a2885 100644 --- a/test/test_ezsigntemplatepackagesignermembership_get_object_v2_response_m_payload.py +++ b/test/test_ezsigntemplatepackagesignermembership_get_object_v2_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatepackagesignermembership_get_object_v2_response_m_payload import EzsigntemplatepackagesignermembershipGetObjectV2ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezsigntemplatepackagesignermembership_get_object_v2_response_m_payload import EzsigntemplatepackagesignermembershipGetObjectV2ResponseMPayload class TestEzsigntemplatepackagesignermembershipGetObjectV2ResponseMPayload(unittest.TestCase): """EzsigntemplatepackagesignermembershipGetObjectV2ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> Ezsigntemplatepackagesignermembersh optional params are included """ # uncomment below to create an instance of `EzsigntemplatepackagesignermembershipGetObjectV2ResponseMPayload` """ - model = EzsigntemplatepackagesignermembershipGetObjectV2ResponseMPayload() # noqa: E501 + model = EzsigntemplatepackagesignermembershipGetObjectV2ResponseMPayload() if include_optional: return EzsigntemplatepackagesignermembershipGetObjectV2ResponseMPayload( obj_ezsigntemplatepackagesignermembership = eZmaxApi.models.ezsigntemplatepackagesignermembership_response_compound.ezsigntemplatepackagesignermembership-ResponseCompound() diff --git a/test/test_ezsigntemplatepackagesignermembership_request.py b/test/test_ezsigntemplatepackagesignermembership_request.py index fc4443785..d5873695f 100644 --- a/test/test_ezsigntemplatepackagesignermembership_request.py +++ b/test/test_ezsigntemplatepackagesignermembership_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatepackagesignermembership_request import EzsigntemplatepackagesignermembershipRequest # noqa: E501 +from eZmaxApi.models.ezsigntemplatepackagesignermembership_request import EzsigntemplatepackagesignermembershipRequest class TestEzsigntemplatepackagesignermembershipRequest(unittest.TestCase): """EzsigntemplatepackagesignermembershipRequest unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> Ezsigntemplatepackagesignermembersh optional params are included """ # uncomment below to create an instance of `EzsigntemplatepackagesignermembershipRequest` """ - model = EzsigntemplatepackagesignermembershipRequest() # noqa: E501 + model = EzsigntemplatepackagesignermembershipRequest() if include_optional: return EzsigntemplatepackagesignermembershipRequest( pki_ezsigntemplatepackagesignermembership_id = 237, diff --git a/test/test_ezsigntemplatepackagesignermembership_request_compound.py b/test/test_ezsigntemplatepackagesignermembership_request_compound.py index 63e4e7131..a73828ff2 100644 --- a/test/test_ezsigntemplatepackagesignermembership_request_compound.py +++ b/test/test_ezsigntemplatepackagesignermembership_request_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatepackagesignermembership_request_compound import EzsigntemplatepackagesignermembershipRequestCompound # noqa: E501 +from eZmaxApi.models.ezsigntemplatepackagesignermembership_request_compound import EzsigntemplatepackagesignermembershipRequestCompound class TestEzsigntemplatepackagesignermembershipRequestCompound(unittest.TestCase): """EzsigntemplatepackagesignermembershipRequestCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> Ezsigntemplatepackagesignermembersh optional params are included """ # uncomment below to create an instance of `EzsigntemplatepackagesignermembershipRequestCompound` """ - model = EzsigntemplatepackagesignermembershipRequestCompound() # noqa: E501 + model = EzsigntemplatepackagesignermembershipRequestCompound() if include_optional: return EzsigntemplatepackagesignermembershipRequestCompound( pki_ezsigntemplatepackagesignermembership_id = 237, diff --git a/test/test_ezsigntemplatepackagesignermembership_response.py b/test/test_ezsigntemplatepackagesignermembership_response.py index 4faa496d0..00ed65c37 100644 --- a/test/test_ezsigntemplatepackagesignermembership_response.py +++ b/test/test_ezsigntemplatepackagesignermembership_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatepackagesignermembership_response import EzsigntemplatepackagesignermembershipResponse # noqa: E501 +from eZmaxApi.models.ezsigntemplatepackagesignermembership_response import EzsigntemplatepackagesignermembershipResponse class TestEzsigntemplatepackagesignermembershipResponse(unittest.TestCase): """EzsigntemplatepackagesignermembershipResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> Ezsigntemplatepackagesignermembersh optional params are included """ # uncomment below to create an instance of `EzsigntemplatepackagesignermembershipResponse` """ - model = EzsigntemplatepackagesignermembershipResponse() # noqa: E501 + model = EzsigntemplatepackagesignermembershipResponse() if include_optional: return EzsigntemplatepackagesignermembershipResponse( pki_ezsigntemplatepackagesignermembership_id = 237, diff --git a/test/test_ezsigntemplatepackagesignermembership_response_compound.py b/test/test_ezsigntemplatepackagesignermembership_response_compound.py index 49ec6b747..6854c07b8 100644 --- a/test/test_ezsigntemplatepackagesignermembership_response_compound.py +++ b/test/test_ezsigntemplatepackagesignermembership_response_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatepackagesignermembership_response_compound import EzsigntemplatepackagesignermembershipResponseCompound # noqa: E501 +from eZmaxApi.models.ezsigntemplatepackagesignermembership_response_compound import EzsigntemplatepackagesignermembershipResponseCompound class TestEzsigntemplatepackagesignermembershipResponseCompound(unittest.TestCase): """EzsigntemplatepackagesignermembershipResponseCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> Ezsigntemplatepackagesignermembersh optional params are included """ # uncomment below to create an instance of `EzsigntemplatepackagesignermembershipResponseCompound` """ - model = EzsigntemplatepackagesignermembershipResponseCompound() # noqa: E501 + model = EzsigntemplatepackagesignermembershipResponseCompound() if include_optional: return EzsigntemplatepackagesignermembershipResponseCompound( pki_ezsigntemplatepackagesignermembership_id = 237, diff --git a/test/test_ezsigntemplatesignature_create_object_v1_request.py b/test/test_ezsigntemplatesignature_create_object_v1_request.py index e638c2e51..5191da9bf 100644 --- a/test/test_ezsigntemplatesignature_create_object_v1_request.py +++ b/test/test_ezsigntemplatesignature_create_object_v1_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatesignature_create_object_v1_request import EzsigntemplatesignatureCreateObjectV1Request # noqa: E501 +from eZmaxApi.models.ezsigntemplatesignature_create_object_v1_request import EzsigntemplatesignatureCreateObjectV1Request class TestEzsigntemplatesignatureCreateObjectV1Request(unittest.TestCase): """EzsigntemplatesignatureCreateObjectV1Request unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplatesignatureCreateObject optional params are included """ # uncomment below to create an instance of `EzsigntemplatesignatureCreateObjectV1Request` """ - model = EzsigntemplatesignatureCreateObjectV1Request() # noqa: E501 + model = EzsigntemplatesignatureCreateObjectV1Request() if include_optional: return EzsigntemplatesignatureCreateObjectV1Request( a_obj_ezsigntemplatesignature = [ diff --git a/test/test_ezsigntemplatesignature_create_object_v1_response.py b/test/test_ezsigntemplatesignature_create_object_v1_response.py index a884830b0..3656d3368 100644 --- a/test/test_ezsigntemplatesignature_create_object_v1_response.py +++ b/test/test_ezsigntemplatesignature_create_object_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatesignature_create_object_v1_response import EzsigntemplatesignatureCreateObjectV1Response # noqa: E501 +from eZmaxApi.models.ezsigntemplatesignature_create_object_v1_response import EzsigntemplatesignatureCreateObjectV1Response class TestEzsigntemplatesignatureCreateObjectV1Response(unittest.TestCase): """EzsigntemplatesignatureCreateObjectV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplatesignatureCreateObject optional params are included """ # uncomment below to create an instance of `EzsigntemplatesignatureCreateObjectV1Response` """ - model = EzsigntemplatesignatureCreateObjectV1Response() # noqa: E501 + model = EzsigntemplatesignatureCreateObjectV1Response() if include_optional: return EzsigntemplatesignatureCreateObjectV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsigntemplatesignature_create_object_v1_response_m_payload.py b/test/test_ezsigntemplatesignature_create_object_v1_response_m_payload.py index b0b783b7f..e701c166f 100644 --- a/test/test_ezsigntemplatesignature_create_object_v1_response_m_payload.py +++ b/test/test_ezsigntemplatesignature_create_object_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatesignature_create_object_v1_response_m_payload import EzsigntemplatesignatureCreateObjectV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezsigntemplatesignature_create_object_v1_response_m_payload import EzsigntemplatesignatureCreateObjectV1ResponseMPayload class TestEzsigntemplatesignatureCreateObjectV1ResponseMPayload(unittest.TestCase): """EzsigntemplatesignatureCreateObjectV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplatesignatureCreateObject optional params are included """ # uncomment below to create an instance of `EzsigntemplatesignatureCreateObjectV1ResponseMPayload` """ - model = EzsigntemplatesignatureCreateObjectV1ResponseMPayload() # noqa: E501 + model = EzsigntemplatesignatureCreateObjectV1ResponseMPayload() if include_optional: return EzsigntemplatesignatureCreateObjectV1ResponseMPayload( a_pki_ezsigntemplatesignature_id = [ diff --git a/test/test_ezsigntemplatesignature_delete_object_v1_response.py b/test/test_ezsigntemplatesignature_delete_object_v1_response.py index c58ab6c0e..c9b65a368 100644 --- a/test/test_ezsigntemplatesignature_delete_object_v1_response.py +++ b/test/test_ezsigntemplatesignature_delete_object_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatesignature_delete_object_v1_response import EzsigntemplatesignatureDeleteObjectV1Response # noqa: E501 +from eZmaxApi.models.ezsigntemplatesignature_delete_object_v1_response import EzsigntemplatesignatureDeleteObjectV1Response class TestEzsigntemplatesignatureDeleteObjectV1Response(unittest.TestCase): """EzsigntemplatesignatureDeleteObjectV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplatesignatureDeleteObject optional params are included """ # uncomment below to create an instance of `EzsigntemplatesignatureDeleteObjectV1Response` """ - model = EzsigntemplatesignatureDeleteObjectV1Response() # noqa: E501 + model = EzsigntemplatesignatureDeleteObjectV1Response() if include_optional: return EzsigntemplatesignatureDeleteObjectV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsigntemplatesignature_edit_object_v1_request.py b/test/test_ezsigntemplatesignature_edit_object_v1_request.py index c2ea5fa2f..fe548c68c 100644 --- a/test/test_ezsigntemplatesignature_edit_object_v1_request.py +++ b/test/test_ezsigntemplatesignature_edit_object_v1_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatesignature_edit_object_v1_request import EzsigntemplatesignatureEditObjectV1Request # noqa: E501 +from eZmaxApi.models.ezsigntemplatesignature_edit_object_v1_request import EzsigntemplatesignatureEditObjectV1Request class TestEzsigntemplatesignatureEditObjectV1Request(unittest.TestCase): """EzsigntemplatesignatureEditObjectV1Request unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplatesignatureEditObjectV1 optional params are included """ # uncomment below to create an instance of `EzsigntemplatesignatureEditObjectV1Request` """ - model = EzsigntemplatesignatureEditObjectV1Request() # noqa: E501 + model = EzsigntemplatesignatureEditObjectV1Request() if include_optional: return EzsigntemplatesignatureEditObjectV1Request( obj_ezsigntemplatesignature = eZmaxApi.models.ezsigntemplatesignature_request_compound.ezsigntemplatesignature-RequestCompound() diff --git a/test/test_ezsigntemplatesignature_edit_object_v1_response.py b/test/test_ezsigntemplatesignature_edit_object_v1_response.py index d940bb792..f30fc9cb4 100644 --- a/test/test_ezsigntemplatesignature_edit_object_v1_response.py +++ b/test/test_ezsigntemplatesignature_edit_object_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatesignature_edit_object_v1_response import EzsigntemplatesignatureEditObjectV1Response # noqa: E501 +from eZmaxApi.models.ezsigntemplatesignature_edit_object_v1_response import EzsigntemplatesignatureEditObjectV1Response class TestEzsigntemplatesignatureEditObjectV1Response(unittest.TestCase): """EzsigntemplatesignatureEditObjectV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplatesignatureEditObjectV1 optional params are included """ # uncomment below to create an instance of `EzsigntemplatesignatureEditObjectV1Response` """ - model = EzsigntemplatesignatureEditObjectV1Response() # noqa: E501 + model = EzsigntemplatesignatureEditObjectV1Response() if include_optional: return EzsigntemplatesignatureEditObjectV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsigntemplatesignature_get_object_v2_response.py b/test/test_ezsigntemplatesignature_get_object_v2_response.py index 2a74dbfd7..e7add936b 100644 --- a/test/test_ezsigntemplatesignature_get_object_v2_response.py +++ b/test/test_ezsigntemplatesignature_get_object_v2_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatesignature_get_object_v2_response import EzsigntemplatesignatureGetObjectV2Response # noqa: E501 +from eZmaxApi.models.ezsigntemplatesignature_get_object_v2_response import EzsigntemplatesignatureGetObjectV2Response class TestEzsigntemplatesignatureGetObjectV2Response(unittest.TestCase): """EzsigntemplatesignatureGetObjectV2Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplatesignatureGetObjectV2R optional params are included """ # uncomment below to create an instance of `EzsigntemplatesignatureGetObjectV2Response` """ - model = EzsigntemplatesignatureGetObjectV2Response() # noqa: E501 + model = EzsigntemplatesignatureGetObjectV2Response() if include_optional: return EzsigntemplatesignatureGetObjectV2Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsigntemplatesignature_get_object_v2_response_m_payload.py b/test/test_ezsigntemplatesignature_get_object_v2_response_m_payload.py index cc0a6ae8d..8123d6f58 100644 --- a/test/test_ezsigntemplatesignature_get_object_v2_response_m_payload.py +++ b/test/test_ezsigntemplatesignature_get_object_v2_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatesignature_get_object_v2_response_m_payload import EzsigntemplatesignatureGetObjectV2ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezsigntemplatesignature_get_object_v2_response_m_payload import EzsigntemplatesignatureGetObjectV2ResponseMPayload class TestEzsigntemplatesignatureGetObjectV2ResponseMPayload(unittest.TestCase): """EzsigntemplatesignatureGetObjectV2ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplatesignatureGetObjectV2R optional params are included """ # uncomment below to create an instance of `EzsigntemplatesignatureGetObjectV2ResponseMPayload` """ - model = EzsigntemplatesignatureGetObjectV2ResponseMPayload() # noqa: E501 + model = EzsigntemplatesignatureGetObjectV2ResponseMPayload() if include_optional: return EzsigntemplatesignatureGetObjectV2ResponseMPayload( obj_ezsigntemplatesignature = eZmaxApi.models.ezsigntemplatesignature_response_compound.ezsigntemplatesignature-ResponseCompound() diff --git a/test/test_ezsigntemplatesignature_request.py b/test/test_ezsigntemplatesignature_request.py index 211a3a2e0..bc5454232 100644 --- a/test/test_ezsigntemplatesignature_request.py +++ b/test/test_ezsigntemplatesignature_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatesignature_request import EzsigntemplatesignatureRequest # noqa: E501 +from eZmaxApi.models.ezsigntemplatesignature_request import EzsigntemplatesignatureRequest class TestEzsigntemplatesignatureRequest(unittest.TestCase): """EzsigntemplatesignatureRequest unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplatesignatureRequest: optional params are included """ # uncomment below to create an instance of `EzsigntemplatesignatureRequest` """ - model = EzsigntemplatesignatureRequest() # noqa: E501 + model = EzsigntemplatesignatureRequest() if include_optional: return EzsigntemplatesignatureRequest( pki_ezsigntemplatesignature_id = 99, diff --git a/test/test_ezsigntemplatesignature_request_compound.py b/test/test_ezsigntemplatesignature_request_compound.py index 5b271176d..016320d98 100644 --- a/test/test_ezsigntemplatesignature_request_compound.py +++ b/test/test_ezsigntemplatesignature_request_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatesignature_request_compound import EzsigntemplatesignatureRequestCompound # noqa: E501 +from eZmaxApi.models.ezsigntemplatesignature_request_compound import EzsigntemplatesignatureRequestCompound class TestEzsigntemplatesignatureRequestCompound(unittest.TestCase): """EzsigntemplatesignatureRequestCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplatesignatureRequestCompo optional params are included """ # uncomment below to create an instance of `EzsigntemplatesignatureRequestCompound` """ - model = EzsigntemplatesignatureRequestCompound() # noqa: E501 + model = EzsigntemplatesignatureRequestCompound() if include_optional: return EzsigntemplatesignatureRequestCompound( pki_ezsigntemplatesignature_id = 99, diff --git a/test/test_ezsigntemplatesignature_response.py b/test/test_ezsigntemplatesignature_response.py index e82ff8ffe..e07f41b13 100644 --- a/test/test_ezsigntemplatesignature_response.py +++ b/test/test_ezsigntemplatesignature_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatesignature_response import EzsigntemplatesignatureResponse # noqa: E501 +from eZmaxApi.models.ezsigntemplatesignature_response import EzsigntemplatesignatureResponse class TestEzsigntemplatesignatureResponse(unittest.TestCase): """EzsigntemplatesignatureResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplatesignatureResponse: optional params are included """ # uncomment below to create an instance of `EzsigntemplatesignatureResponse` """ - model = EzsigntemplatesignatureResponse() # noqa: E501 + model = EzsigntemplatesignatureResponse() if include_optional: return EzsigntemplatesignatureResponse( pki_ezsigntemplatesignature_id = 99, diff --git a/test/test_ezsigntemplatesignature_response_compound.py b/test/test_ezsigntemplatesignature_response_compound.py index 2d37c7488..4316f044f 100644 --- a/test/test_ezsigntemplatesignature_response_compound.py +++ b/test/test_ezsigntemplatesignature_response_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatesignature_response_compound import EzsigntemplatesignatureResponseCompound # noqa: E501 +from eZmaxApi.models.ezsigntemplatesignature_response_compound import EzsigntemplatesignatureResponseCompound class TestEzsigntemplatesignatureResponseCompound(unittest.TestCase): """EzsigntemplatesignatureResponseCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplatesignatureResponseComp optional params are included """ # uncomment below to create an instance of `EzsigntemplatesignatureResponseCompound` """ - model = EzsigntemplatesignatureResponseCompound() # noqa: E501 + model = EzsigntemplatesignatureResponseCompound() if include_optional: return EzsigntemplatesignatureResponseCompound( pki_ezsigntemplatesignature_id = 99, diff --git a/test/test_ezsigntemplatesignaturecustomdate_request.py b/test/test_ezsigntemplatesignaturecustomdate_request.py index 9ae567696..dadf782ba 100644 --- a/test/test_ezsigntemplatesignaturecustomdate_request.py +++ b/test/test_ezsigntemplatesignaturecustomdate_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatesignaturecustomdate_request import EzsigntemplatesignaturecustomdateRequest # noqa: E501 +from eZmaxApi.models.ezsigntemplatesignaturecustomdate_request import EzsigntemplatesignaturecustomdateRequest class TestEzsigntemplatesignaturecustomdateRequest(unittest.TestCase): """EzsigntemplatesignaturecustomdateRequest unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplatesignaturecustomdateRe optional params are included """ # uncomment below to create an instance of `EzsigntemplatesignaturecustomdateRequest` """ - model = EzsigntemplatesignaturecustomdateRequest() # noqa: E501 + model = EzsigntemplatesignaturecustomdateRequest() if include_optional: return EzsigntemplatesignaturecustomdateRequest( pki_ezsigntemplatesignaturecustomdate_id = 58, diff --git a/test/test_ezsigntemplatesignaturecustomdate_request_compound.py b/test/test_ezsigntemplatesignaturecustomdate_request_compound.py index a294de239..a25d51f23 100644 --- a/test/test_ezsigntemplatesignaturecustomdate_request_compound.py +++ b/test/test_ezsigntemplatesignaturecustomdate_request_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatesignaturecustomdate_request_compound import EzsigntemplatesignaturecustomdateRequestCompound # noqa: E501 +from eZmaxApi.models.ezsigntemplatesignaturecustomdate_request_compound import EzsigntemplatesignaturecustomdateRequestCompound class TestEzsigntemplatesignaturecustomdateRequestCompound(unittest.TestCase): """EzsigntemplatesignaturecustomdateRequestCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplatesignaturecustomdateRe optional params are included """ # uncomment below to create an instance of `EzsigntemplatesignaturecustomdateRequestCompound` """ - model = EzsigntemplatesignaturecustomdateRequestCompound() # noqa: E501 + model = EzsigntemplatesignaturecustomdateRequestCompound() if include_optional: return EzsigntemplatesignaturecustomdateRequestCompound( pki_ezsigntemplatesignaturecustomdate_id = 58, diff --git a/test/test_ezsigntemplatesignaturecustomdate_response.py b/test/test_ezsigntemplatesignaturecustomdate_response.py index 66d2c18bc..860f831ec 100644 --- a/test/test_ezsigntemplatesignaturecustomdate_response.py +++ b/test/test_ezsigntemplatesignaturecustomdate_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatesignaturecustomdate_response import EzsigntemplatesignaturecustomdateResponse # noqa: E501 +from eZmaxApi.models.ezsigntemplatesignaturecustomdate_response import EzsigntemplatesignaturecustomdateResponse class TestEzsigntemplatesignaturecustomdateResponse(unittest.TestCase): """EzsigntemplatesignaturecustomdateResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplatesignaturecustomdateRe optional params are included """ # uncomment below to create an instance of `EzsigntemplatesignaturecustomdateResponse` """ - model = EzsigntemplatesignaturecustomdateResponse() # noqa: E501 + model = EzsigntemplatesignaturecustomdateResponse() if include_optional: return EzsigntemplatesignaturecustomdateResponse( pki_ezsigntemplatesignaturecustomdate_id = 58, diff --git a/test/test_ezsigntemplatesignaturecustomdate_response_compound.py b/test/test_ezsigntemplatesignaturecustomdate_response_compound.py index ba6eb163e..302c0423a 100644 --- a/test/test_ezsigntemplatesignaturecustomdate_response_compound.py +++ b/test/test_ezsigntemplatesignaturecustomdate_response_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatesignaturecustomdate_response_compound import EzsigntemplatesignaturecustomdateResponseCompound # noqa: E501 +from eZmaxApi.models.ezsigntemplatesignaturecustomdate_response_compound import EzsigntemplatesignaturecustomdateResponseCompound class TestEzsigntemplatesignaturecustomdateResponseCompound(unittest.TestCase): """EzsigntemplatesignaturecustomdateResponseCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplatesignaturecustomdateRe optional params are included """ # uncomment below to create an instance of `EzsigntemplatesignaturecustomdateResponseCompound` """ - model = EzsigntemplatesignaturecustomdateResponseCompound() # noqa: E501 + model = EzsigntemplatesignaturecustomdateResponseCompound() if include_optional: return EzsigntemplatesignaturecustomdateResponseCompound( pki_ezsigntemplatesignaturecustomdate_id = 58, diff --git a/test/test_ezsigntemplatesigner_create_object_v1_request.py b/test/test_ezsigntemplatesigner_create_object_v1_request.py index 5e195e7b4..b91872b57 100644 --- a/test/test_ezsigntemplatesigner_create_object_v1_request.py +++ b/test/test_ezsigntemplatesigner_create_object_v1_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatesigner_create_object_v1_request import EzsigntemplatesignerCreateObjectV1Request # noqa: E501 +from eZmaxApi.models.ezsigntemplatesigner_create_object_v1_request import EzsigntemplatesignerCreateObjectV1Request class TestEzsigntemplatesignerCreateObjectV1Request(unittest.TestCase): """EzsigntemplatesignerCreateObjectV1Request unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplatesignerCreateObjectV1R optional params are included """ # uncomment below to create an instance of `EzsigntemplatesignerCreateObjectV1Request` """ - model = EzsigntemplatesignerCreateObjectV1Request() # noqa: E501 + model = EzsigntemplatesignerCreateObjectV1Request() if include_optional: return EzsigntemplatesignerCreateObjectV1Request( a_obj_ezsigntemplatesigner = [ diff --git a/test/test_ezsigntemplatesigner_create_object_v1_response.py b/test/test_ezsigntemplatesigner_create_object_v1_response.py index 2cf099105..5d40f7ae1 100644 --- a/test/test_ezsigntemplatesigner_create_object_v1_response.py +++ b/test/test_ezsigntemplatesigner_create_object_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatesigner_create_object_v1_response import EzsigntemplatesignerCreateObjectV1Response # noqa: E501 +from eZmaxApi.models.ezsigntemplatesigner_create_object_v1_response import EzsigntemplatesignerCreateObjectV1Response class TestEzsigntemplatesignerCreateObjectV1Response(unittest.TestCase): """EzsigntemplatesignerCreateObjectV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplatesignerCreateObjectV1R optional params are included """ # uncomment below to create an instance of `EzsigntemplatesignerCreateObjectV1Response` """ - model = EzsigntemplatesignerCreateObjectV1Response() # noqa: E501 + model = EzsigntemplatesignerCreateObjectV1Response() if include_optional: return EzsigntemplatesignerCreateObjectV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsigntemplatesigner_create_object_v1_response_m_payload.py b/test/test_ezsigntemplatesigner_create_object_v1_response_m_payload.py index 99e954f60..5e8c17049 100644 --- a/test/test_ezsigntemplatesigner_create_object_v1_response_m_payload.py +++ b/test/test_ezsigntemplatesigner_create_object_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatesigner_create_object_v1_response_m_payload import EzsigntemplatesignerCreateObjectV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezsigntemplatesigner_create_object_v1_response_m_payload import EzsigntemplatesignerCreateObjectV1ResponseMPayload class TestEzsigntemplatesignerCreateObjectV1ResponseMPayload(unittest.TestCase): """EzsigntemplatesignerCreateObjectV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplatesignerCreateObjectV1R optional params are included """ # uncomment below to create an instance of `EzsigntemplatesignerCreateObjectV1ResponseMPayload` """ - model = EzsigntemplatesignerCreateObjectV1ResponseMPayload() # noqa: E501 + model = EzsigntemplatesignerCreateObjectV1ResponseMPayload() if include_optional: return EzsigntemplatesignerCreateObjectV1ResponseMPayload( a_pki_ezsigntemplatesigner_id = [ diff --git a/test/test_ezsigntemplatesigner_delete_object_v1_response.py b/test/test_ezsigntemplatesigner_delete_object_v1_response.py index 1d85c109d..d6685cba1 100644 --- a/test/test_ezsigntemplatesigner_delete_object_v1_response.py +++ b/test/test_ezsigntemplatesigner_delete_object_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatesigner_delete_object_v1_response import EzsigntemplatesignerDeleteObjectV1Response # noqa: E501 +from eZmaxApi.models.ezsigntemplatesigner_delete_object_v1_response import EzsigntemplatesignerDeleteObjectV1Response class TestEzsigntemplatesignerDeleteObjectV1Response(unittest.TestCase): """EzsigntemplatesignerDeleteObjectV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplatesignerDeleteObjectV1R optional params are included """ # uncomment below to create an instance of `EzsigntemplatesignerDeleteObjectV1Response` """ - model = EzsigntemplatesignerDeleteObjectV1Response() # noqa: E501 + model = EzsigntemplatesignerDeleteObjectV1Response() if include_optional: return EzsigntemplatesignerDeleteObjectV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsigntemplatesigner_edit_object_v1_request.py b/test/test_ezsigntemplatesigner_edit_object_v1_request.py index e6dbd83e0..2b7255cf4 100644 --- a/test/test_ezsigntemplatesigner_edit_object_v1_request.py +++ b/test/test_ezsigntemplatesigner_edit_object_v1_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatesigner_edit_object_v1_request import EzsigntemplatesignerEditObjectV1Request # noqa: E501 +from eZmaxApi.models.ezsigntemplatesigner_edit_object_v1_request import EzsigntemplatesignerEditObjectV1Request class TestEzsigntemplatesignerEditObjectV1Request(unittest.TestCase): """EzsigntemplatesignerEditObjectV1Request unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplatesignerEditObjectV1Req optional params are included """ # uncomment below to create an instance of `EzsigntemplatesignerEditObjectV1Request` """ - model = EzsigntemplatesignerEditObjectV1Request() # noqa: E501 + model = EzsigntemplatesignerEditObjectV1Request() if include_optional: return EzsigntemplatesignerEditObjectV1Request( obj_ezsigntemplatesigner = eZmaxApi.models.ezsigntemplatesigner_request_compound.ezsigntemplatesigner-RequestCompound() diff --git a/test/test_ezsigntemplatesigner_edit_object_v1_response.py b/test/test_ezsigntemplatesigner_edit_object_v1_response.py index 8d8d97d85..d53f609d3 100644 --- a/test/test_ezsigntemplatesigner_edit_object_v1_response.py +++ b/test/test_ezsigntemplatesigner_edit_object_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatesigner_edit_object_v1_response import EzsigntemplatesignerEditObjectV1Response # noqa: E501 +from eZmaxApi.models.ezsigntemplatesigner_edit_object_v1_response import EzsigntemplatesignerEditObjectV1Response class TestEzsigntemplatesignerEditObjectV1Response(unittest.TestCase): """EzsigntemplatesignerEditObjectV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplatesignerEditObjectV1Res optional params are included """ # uncomment below to create an instance of `EzsigntemplatesignerEditObjectV1Response` """ - model = EzsigntemplatesignerEditObjectV1Response() # noqa: E501 + model = EzsigntemplatesignerEditObjectV1Response() if include_optional: return EzsigntemplatesignerEditObjectV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsigntemplatesigner_get_object_v2_response.py b/test/test_ezsigntemplatesigner_get_object_v2_response.py index ecc605dc0..49ce32cc7 100644 --- a/test/test_ezsigntemplatesigner_get_object_v2_response.py +++ b/test/test_ezsigntemplatesigner_get_object_v2_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatesigner_get_object_v2_response import EzsigntemplatesignerGetObjectV2Response # noqa: E501 +from eZmaxApi.models.ezsigntemplatesigner_get_object_v2_response import EzsigntemplatesignerGetObjectV2Response class TestEzsigntemplatesignerGetObjectV2Response(unittest.TestCase): """EzsigntemplatesignerGetObjectV2Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplatesignerGetObjectV2Resp optional params are included """ # uncomment below to create an instance of `EzsigntemplatesignerGetObjectV2Response` """ - model = EzsigntemplatesignerGetObjectV2Response() # noqa: E501 + model = EzsigntemplatesignerGetObjectV2Response() if include_optional: return EzsigntemplatesignerGetObjectV2Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsigntemplatesigner_get_object_v2_response_m_payload.py b/test/test_ezsigntemplatesigner_get_object_v2_response_m_payload.py index f9e1b8809..969804a1b 100644 --- a/test/test_ezsigntemplatesigner_get_object_v2_response_m_payload.py +++ b/test/test_ezsigntemplatesigner_get_object_v2_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatesigner_get_object_v2_response_m_payload import EzsigntemplatesignerGetObjectV2ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezsigntemplatesigner_get_object_v2_response_m_payload import EzsigntemplatesignerGetObjectV2ResponseMPayload class TestEzsigntemplatesignerGetObjectV2ResponseMPayload(unittest.TestCase): """EzsigntemplatesignerGetObjectV2ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplatesignerGetObjectV2Resp optional params are included """ # uncomment below to create an instance of `EzsigntemplatesignerGetObjectV2ResponseMPayload` """ - model = EzsigntemplatesignerGetObjectV2ResponseMPayload() # noqa: E501 + model = EzsigntemplatesignerGetObjectV2ResponseMPayload() if include_optional: return EzsigntemplatesignerGetObjectV2ResponseMPayload( obj_ezsigntemplatesigner = eZmaxApi.models.ezsigntemplatesigner_response_compound.ezsigntemplatesigner-ResponseCompound() diff --git a/test/test_ezsigntemplatesigner_request.py b/test/test_ezsigntemplatesigner_request.py index 8f74f2a40..afce43f6c 100644 --- a/test/test_ezsigntemplatesigner_request.py +++ b/test/test_ezsigntemplatesigner_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatesigner_request import EzsigntemplatesignerRequest # noqa: E501 +from eZmaxApi.models.ezsigntemplatesigner_request import EzsigntemplatesignerRequest class TestEzsigntemplatesignerRequest(unittest.TestCase): """EzsigntemplatesignerRequest unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplatesignerRequest: optional params are included """ # uncomment below to create an instance of `EzsigntemplatesignerRequest` """ - model = EzsigntemplatesignerRequest() # noqa: E501 + model = EzsigntemplatesignerRequest() if include_optional: return EzsigntemplatesignerRequest( pki_ezsigntemplatesigner_id = 9, diff --git a/test/test_ezsigntemplatesigner_request_compound.py b/test/test_ezsigntemplatesigner_request_compound.py index 5859f0e64..c8ed35335 100644 --- a/test/test_ezsigntemplatesigner_request_compound.py +++ b/test/test_ezsigntemplatesigner_request_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatesigner_request_compound import EzsigntemplatesignerRequestCompound # noqa: E501 +from eZmaxApi.models.ezsigntemplatesigner_request_compound import EzsigntemplatesignerRequestCompound class TestEzsigntemplatesignerRequestCompound(unittest.TestCase): """EzsigntemplatesignerRequestCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplatesignerRequestCompound optional params are included """ # uncomment below to create an instance of `EzsigntemplatesignerRequestCompound` """ - model = EzsigntemplatesignerRequestCompound() # noqa: E501 + model = EzsigntemplatesignerRequestCompound() if include_optional: return EzsigntemplatesignerRequestCompound( pki_ezsigntemplatesigner_id = 9, diff --git a/test/test_ezsigntemplatesigner_response.py b/test/test_ezsigntemplatesigner_response.py index d0a28bac4..15950d035 100644 --- a/test/test_ezsigntemplatesigner_response.py +++ b/test/test_ezsigntemplatesigner_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatesigner_response import EzsigntemplatesignerResponse # noqa: E501 +from eZmaxApi.models.ezsigntemplatesigner_response import EzsigntemplatesignerResponse class TestEzsigntemplatesignerResponse(unittest.TestCase): """EzsigntemplatesignerResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplatesignerResponse: optional params are included """ # uncomment below to create an instance of `EzsigntemplatesignerResponse` """ - model = EzsigntemplatesignerResponse() # noqa: E501 + model = EzsigntemplatesignerResponse() if include_optional: return EzsigntemplatesignerResponse( pki_ezsigntemplatesigner_id = 9, diff --git a/test/test_ezsigntemplatesigner_response_compound.py b/test/test_ezsigntemplatesigner_response_compound.py index 27b3b205a..73529e856 100644 --- a/test/test_ezsigntemplatesigner_response_compound.py +++ b/test/test_ezsigntemplatesigner_response_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntemplatesigner_response_compound import EzsigntemplatesignerResponseCompound # noqa: E501 +from eZmaxApi.models.ezsigntemplatesigner_response_compound import EzsigntemplatesignerResponseCompound class TestEzsigntemplatesignerResponseCompound(unittest.TestCase): """EzsigntemplatesignerResponseCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntemplatesignerResponseCompoun optional params are included """ # uncomment below to create an instance of `EzsigntemplatesignerResponseCompound` """ - model = EzsigntemplatesignerResponseCompound() # noqa: E501 + model = EzsigntemplatesignerResponseCompound() if include_optional: return EzsigntemplatesignerResponseCompound( pki_ezsigntemplatesigner_id = 9, diff --git a/test/test_ezsigntsarequirement_autocomplete_element_response.py b/test/test_ezsigntsarequirement_autocomplete_element_response.py index 557036cdc..c3d8f5bb1 100644 --- a/test/test_ezsigntsarequirement_autocomplete_element_response.py +++ b/test/test_ezsigntsarequirement_autocomplete_element_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntsarequirement_autocomplete_element_response import EzsigntsarequirementAutocompleteElementResponse # noqa: E501 +from eZmaxApi.models.ezsigntsarequirement_autocomplete_element_response import EzsigntsarequirementAutocompleteElementResponse class TestEzsigntsarequirementAutocompleteElementResponse(unittest.TestCase): """EzsigntsarequirementAutocompleteElementResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntsarequirementAutocompleteEle optional params are included """ # uncomment below to create an instance of `EzsigntsarequirementAutocompleteElementResponse` """ - model = EzsigntsarequirementAutocompleteElementResponse() # noqa: E501 + model = EzsigntsarequirementAutocompleteElementResponse() if include_optional: return EzsigntsarequirementAutocompleteElementResponse( s_ezsigntsarequirement_description_x = 'No', diff --git a/test/test_ezsigntsarequirement_get_autocomplete_v2_response.py b/test/test_ezsigntsarequirement_get_autocomplete_v2_response.py index 805305167..21b4b57d6 100644 --- a/test/test_ezsigntsarequirement_get_autocomplete_v2_response.py +++ b/test/test_ezsigntsarequirement_get_autocomplete_v2_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntsarequirement_get_autocomplete_v2_response import EzsigntsarequirementGetAutocompleteV2Response # noqa: E501 +from eZmaxApi.models.ezsigntsarequirement_get_autocomplete_v2_response import EzsigntsarequirementGetAutocompleteV2Response class TestEzsigntsarequirementGetAutocompleteV2Response(unittest.TestCase): """EzsigntsarequirementGetAutocompleteV2Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntsarequirementGetAutocomplete optional params are included """ # uncomment below to create an instance of `EzsigntsarequirementGetAutocompleteV2Response` """ - model = EzsigntsarequirementGetAutocompleteV2Response() # noqa: E501 + model = EzsigntsarequirementGetAutocompleteV2Response() if include_optional: return EzsigntsarequirementGetAutocompleteV2Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_ezsigntsarequirement_get_autocomplete_v2_response_m_payload.py b/test/test_ezsigntsarequirement_get_autocomplete_v2_response_m_payload.py index d2692ebcb..b4db96201 100644 --- a/test/test_ezsigntsarequirement_get_autocomplete_v2_response_m_payload.py +++ b/test/test_ezsigntsarequirement_get_autocomplete_v2_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.ezsigntsarequirement_get_autocomplete_v2_response_m_payload import EzsigntsarequirementGetAutocompleteV2ResponseMPayload # noqa: E501 +from eZmaxApi.models.ezsigntsarequirement_get_autocomplete_v2_response_m_payload import EzsigntsarequirementGetAutocompleteV2ResponseMPayload class TestEzsigntsarequirementGetAutocompleteV2ResponseMPayload(unittest.TestCase): """EzsigntsarequirementGetAutocompleteV2ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> EzsigntsarequirementGetAutocomplete optional params are included """ # uncomment below to create an instance of `EzsigntsarequirementGetAutocompleteV2ResponseMPayload` """ - model = EzsigntsarequirementGetAutocompleteV2ResponseMPayload() # noqa: E501 + model = EzsigntsarequirementGetAutocompleteV2ResponseMPayload() if include_optional: return EzsigntsarequirementGetAutocompleteV2ResponseMPayload( a_obj_ezsigntsarequirement = [ diff --git a/test/test_field_e_activesession_origin.py b/test/test_field_e_activesession_origin.py index 847898ca8..66e0a8726 100644 --- a/test/test_field_e_activesession_origin.py +++ b/test/test_field_e_activesession_origin.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.field_e_activesession_origin import FieldEActivesessionOrigin # noqa: E501 +from eZmaxApi.models.field_e_activesession_origin import FieldEActivesessionOrigin class TestFieldEActivesessionOrigin(unittest.TestCase): """FieldEActivesessionOrigin unit test stubs""" diff --git a/test/test_field_e_activesession_usertype.py b/test/test_field_e_activesession_usertype.py index d75fb2201..e12b8d936 100644 --- a/test/test_field_e_activesession_usertype.py +++ b/test/test_field_e_activesession_usertype.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.field_e_activesession_usertype import FieldEActivesessionUsertype # noqa: E501 +from eZmaxApi.models.field_e_activesession_usertype import FieldEActivesessionUsertype class TestFieldEActivesessionUsertype(unittest.TestCase): """FieldEActivesessionUsertype unit test stubs""" diff --git a/test/test_field_e_activesession_weekdaystart.py b/test/test_field_e_activesession_weekdaystart.py index 83a0ca750..d0b3b37bb 100644 --- a/test/test_field_e_activesession_weekdaystart.py +++ b/test/test_field_e_activesession_weekdaystart.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.field_e_activesession_weekdaystart import FieldEActivesessionWeekdaystart # noqa: E501 +from eZmaxApi.models.field_e_activesession_weekdaystart import FieldEActivesessionWeekdaystart class TestFieldEActivesessionWeekdaystart(unittest.TestCase): """FieldEActivesessionWeekdaystart unit test stubs""" diff --git a/test/test_field_e_attachment_documenttype.py b/test/test_field_e_attachment_documenttype.py new file mode 100644 index 000000000..11b20f9b5 --- /dev/null +++ b/test/test_field_e_attachment_documenttype.py @@ -0,0 +1,35 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest +import datetime + +from eZmaxApi.models.field_e_attachment_documenttype import FieldEAttachmentDocumenttype + +class TestFieldEAttachmentDocumenttype(unittest.TestCase): + """FieldEAttachmentDocumenttype unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testFieldEAttachmentDocumenttype(self): + """Test FieldEAttachmentDocumenttype""" + # inst = FieldEAttachmentDocumenttype() + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_field_e_attachment_privacy.py b/test/test_field_e_attachment_privacy.py new file mode 100644 index 000000000..bb41b9313 --- /dev/null +++ b/test/test_field_e_attachment_privacy.py @@ -0,0 +1,35 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest +import datetime + +from eZmaxApi.models.field_e_attachment_privacy import FieldEAttachmentPrivacy + +class TestFieldEAttachmentPrivacy(unittest.TestCase): + """FieldEAttachmentPrivacy unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testFieldEAttachmentPrivacy(self): + """Test FieldEAttachmentPrivacy""" + # inst = FieldEAttachmentPrivacy() + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_field_e_attachment_type.py b/test/test_field_e_attachment_type.py new file mode 100644 index 000000000..235892158 --- /dev/null +++ b/test/test_field_e_attachment_type.py @@ -0,0 +1,35 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest +import datetime + +from eZmaxApi.models.field_e_attachment_type import FieldEAttachmentType + +class TestFieldEAttachmentType(unittest.TestCase): + """FieldEAttachmentType unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testFieldEAttachmentType(self): + """Test FieldEAttachmentType""" + # inst = FieldEAttachmentType() + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_field_e_attachment_verified.py b/test/test_field_e_attachment_verified.py new file mode 100644 index 000000000..6b1887912 --- /dev/null +++ b/test/test_field_e_attachment_verified.py @@ -0,0 +1,35 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest +import datetime + +from eZmaxApi.models.field_e_attachment_verified import FieldEAttachmentVerified + +class TestFieldEAttachmentVerified(unittest.TestCase): + """FieldEAttachmentVerified unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testFieldEAttachmentVerified(self): + """Test FieldEAttachmentVerified""" + # inst = FieldEAttachmentVerified() + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_field_e_attachmentlog_type.py b/test/test_field_e_attachmentlog_type.py new file mode 100644 index 000000000..7f2e742b9 --- /dev/null +++ b/test/test_field_e_attachmentlog_type.py @@ -0,0 +1,35 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest +import datetime + +from eZmaxApi.models.field_e_attachmentlog_type import FieldEAttachmentlogType + +class TestFieldEAttachmentlogType(unittest.TestCase): + """FieldEAttachmentlogType unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testFieldEAttachmentlogType(self): + """Test FieldEAttachmentlogType""" + # inst = FieldEAttachmentlogType() + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_field_e_branding_logo.py b/test/test_field_e_branding_logo.py index f0655e2d2..d628f59a2 100644 --- a/test/test_field_e_branding_logo.py +++ b/test/test_field_e_branding_logo.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.field_e_branding_logo import FieldEBrandingLogo # noqa: E501 +from eZmaxApi.models.field_e_branding_logo import FieldEBrandingLogo class TestFieldEBrandingLogo(unittest.TestCase): """FieldEBrandingLogo unit test stubs""" diff --git a/test/test_field_e_communication_importance.py b/test/test_field_e_communication_importance.py index cc7a4a722..c8309f3a1 100644 --- a/test/test_field_e_communication_importance.py +++ b/test/test_field_e_communication_importance.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.field_e_communication_importance import FieldECommunicationImportance # noqa: E501 +from eZmaxApi.models.field_e_communication_importance import FieldECommunicationImportance class TestFieldECommunicationImportance(unittest.TestCase): """FieldECommunicationImportance unit test stubs""" diff --git a/test/test_field_e_communication_type.py b/test/test_field_e_communication_type.py index e7e927870..a59eb08d6 100644 --- a/test/test_field_e_communication_type.py +++ b/test/test_field_e_communication_type.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.field_e_communication_type import FieldECommunicationType # noqa: E501 +from eZmaxApi.models.field_e_communication_type import FieldECommunicationType class TestFieldECommunicationType(unittest.TestCase): """FieldECommunicationType unit test stubs""" diff --git a/test/test_field_e_communicationexternalrecipient_type.py b/test/test_field_e_communicationexternalrecipient_type.py index 47346162b..4b24102a1 100644 --- a/test/test_field_e_communicationexternalrecipient_type.py +++ b/test/test_field_e_communicationexternalrecipient_type.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.field_e_communicationexternalrecipient_type import FieldECommunicationexternalrecipientType # noqa: E501 +from eZmaxApi.models.field_e_communicationexternalrecipient_type import FieldECommunicationexternalrecipientType class TestFieldECommunicationexternalrecipientType(unittest.TestCase): """FieldECommunicationexternalrecipientType unit test stubs""" diff --git a/test/test_field_e_communicationrecipient_type.py b/test/test_field_e_communicationrecipient_type.py index c5bbdaee3..14f9d1469 100644 --- a/test/test_field_e_communicationrecipient_type.py +++ b/test/test_field_e_communicationrecipient_type.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.field_e_communicationrecipient_type import FieldECommunicationrecipientType # noqa: E501 +from eZmaxApi.models.field_e_communicationrecipient_type import FieldECommunicationrecipientType class TestFieldECommunicationrecipientType(unittest.TestCase): """FieldECommunicationrecipientType unit test stubs""" diff --git a/test/test_field_e_creditcardtype_codename.py b/test/test_field_e_creditcardtype_codename.py index fa1175d5f..6541da0b9 100644 --- a/test/test_field_e_creditcardtype_codename.py +++ b/test/test_field_e_creditcardtype_codename.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.field_e_creditcardtype_codename import FieldECreditcardtypeCodename # noqa: E501 +from eZmaxApi.models.field_e_creditcardtype_codename import FieldECreditcardtypeCodename class TestFieldECreditcardtypeCodename(unittest.TestCase): """FieldECreditcardtypeCodename unit test stubs""" diff --git a/test/test_field_e_error_code.py b/test/test_field_e_error_code.py index 4ecba4459..c92ef9525 100644 --- a/test/test_field_e_error_code.py +++ b/test/test_field_e_error_code.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.field_e_error_code import FieldEErrorCode # noqa: E501 +from eZmaxApi.models.field_e_error_code import FieldEErrorCode class TestFieldEErrorCode(unittest.TestCase): """FieldEErrorCode unit test stubs""" diff --git a/test/test_field_e_ezmaxinvoicing_paymenttype.py b/test/test_field_e_ezmaxinvoicing_paymenttype.py index e21876b70..e94113de5 100644 --- a/test/test_field_e_ezmaxinvoicing_paymenttype.py +++ b/test/test_field_e_ezmaxinvoicing_paymenttype.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.field_e_ezmaxinvoicing_paymenttype import FieldEEzmaxinvoicingPaymenttype # noqa: E501 +from eZmaxApi.models.field_e_ezmaxinvoicing_paymenttype import FieldEEzmaxinvoicingPaymenttype class TestFieldEEzmaxinvoicingPaymenttype(unittest.TestCase): """FieldEEzmaxinvoicingPaymenttype unit test stubs""" diff --git a/test/test_field_e_ezmaxinvoicingagent_variationezmax.py b/test/test_field_e_ezmaxinvoicingagent_variationezmax.py index e15a81875..0138b7f53 100644 --- a/test/test_field_e_ezmaxinvoicingagent_variationezmax.py +++ b/test/test_field_e_ezmaxinvoicingagent_variationezmax.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.field_e_ezmaxinvoicingagent_variationezmax import FieldEEzmaxinvoicingagentVariationezmax # noqa: E501 +from eZmaxApi.models.field_e_ezmaxinvoicingagent_variationezmax import FieldEEzmaxinvoicingagentVariationezmax class TestFieldEEzmaxinvoicingagentVariationezmax(unittest.TestCase): """FieldEEzmaxinvoicingagentVariationezmax unit test stubs""" diff --git a/test/test_field_e_ezmaxinvoicingagent_variationezsign.py b/test/test_field_e_ezmaxinvoicingagent_variationezsign.py index 85ba36900..b667e6f48 100644 --- a/test/test_field_e_ezmaxinvoicingagent_variationezsign.py +++ b/test/test_field_e_ezmaxinvoicingagent_variationezsign.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.field_e_ezmaxinvoicingagent_variationezsign import FieldEEzmaxinvoicingagentVariationezsign # noqa: E501 +from eZmaxApi.models.field_e_ezmaxinvoicingagent_variationezsign import FieldEEzmaxinvoicingagentVariationezsign class TestFieldEEzmaxinvoicingagentVariationezsign(unittest.TestCase): """FieldEEzmaxinvoicingagentVariationezsign unit test stubs""" diff --git a/test/test_field_e_ezmaxinvoicingcontract_paymenttype.py b/test/test_field_e_ezmaxinvoicingcontract_paymenttype.py index 56c22c1eb..9b664919f 100644 --- a/test/test_field_e_ezmaxinvoicingcontract_paymenttype.py +++ b/test/test_field_e_ezmaxinvoicingcontract_paymenttype.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.field_e_ezmaxinvoicingcontract_paymenttype import FieldEEzmaxinvoicingcontractPaymenttype # noqa: E501 +from eZmaxApi.models.field_e_ezmaxinvoicingcontract_paymenttype import FieldEEzmaxinvoicingcontractPaymenttype class TestFieldEEzmaxinvoicingcontractPaymenttype(unittest.TestCase): """FieldEEzmaxinvoicingcontractPaymenttype unit test stubs""" diff --git a/test/test_field_e_ezmaxinvoicinguser_variationezsign.py b/test/test_field_e_ezmaxinvoicinguser_variationezsign.py index 1ea802f37..1a8011d66 100644 --- a/test/test_field_e_ezmaxinvoicinguser_variationezsign.py +++ b/test/test_field_e_ezmaxinvoicinguser_variationezsign.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.field_e_ezmaxinvoicinguser_variationezsign import FieldEEzmaxinvoicinguserVariationezsign # noqa: E501 +from eZmaxApi.models.field_e_ezmaxinvoicinguser_variationezsign import FieldEEzmaxinvoicinguserVariationezsign class TestFieldEEzmaxinvoicinguserVariationezsign(unittest.TestCase): """FieldEEzmaxinvoicinguserVariationezsign unit test stubs""" diff --git a/test/test_field_e_ezsignannotation_type.py b/test/test_field_e_ezsignannotation_type.py index abef6e7fb..6664a77ee 100644 --- a/test/test_field_e_ezsignannotation_type.py +++ b/test/test_field_e_ezsignannotation_type.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.field_e_ezsignannotation_type import FieldEEzsignannotationType # noqa: E501 +from eZmaxApi.models.field_e_ezsignannotation_type import FieldEEzsignannotationType class TestFieldEEzsignannotationType(unittest.TestCase): """FieldEEzsignannotationType unit test stubs""" diff --git a/test/test_field_e_ezsigndocument_step.py b/test/test_field_e_ezsigndocument_step.py index a7f878e5d..837608b28 100644 --- a/test/test_field_e_ezsigndocument_step.py +++ b/test/test_field_e_ezsigndocument_step.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.field_e_ezsigndocument_step import FieldEEzsigndocumentStep # noqa: E501 +from eZmaxApi.models.field_e_ezsigndocument_step import FieldEEzsigndocumentStep class TestFieldEEzsigndocumentStep(unittest.TestCase): """FieldEEzsigndocumentStep unit test stubs""" diff --git a/test/test_field_e_ezsigndocumentlog_type.py b/test/test_field_e_ezsigndocumentlog_type.py index 1a3cae47b..db8413037 100644 --- a/test/test_field_e_ezsigndocumentlog_type.py +++ b/test/test_field_e_ezsigndocumentlog_type.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.field_e_ezsigndocumentlog_type import FieldEEzsigndocumentlogType # noqa: E501 +from eZmaxApi.models.field_e_ezsigndocumentlog_type import FieldEEzsigndocumentlogType class TestFieldEEzsigndocumentlogType(unittest.TestCase): """FieldEEzsigndocumentlogType unit test stubs""" diff --git a/test/test_field_e_ezsignelementdependency_operator.py b/test/test_field_e_ezsignelementdependency_operator.py index 9e092b794..137be2783 100644 --- a/test/test_field_e_ezsignelementdependency_operator.py +++ b/test/test_field_e_ezsignelementdependency_operator.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.field_e_ezsignelementdependency_operator import FieldEEzsignelementdependencyOperator # noqa: E501 +from eZmaxApi.models.field_e_ezsignelementdependency_operator import FieldEEzsignelementdependencyOperator class TestFieldEEzsignelementdependencyOperator(unittest.TestCase): """FieldEEzsignelementdependencyOperator unit test stubs""" diff --git a/test/test_field_e_ezsignelementdependency_validation.py b/test/test_field_e_ezsignelementdependency_validation.py index acb735e4e..146332095 100644 --- a/test/test_field_e_ezsignelementdependency_validation.py +++ b/test/test_field_e_ezsignelementdependency_validation.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.field_e_ezsignelementdependency_validation import FieldEEzsignelementdependencyValidation # noqa: E501 +from eZmaxApi.models.field_e_ezsignelementdependency_validation import FieldEEzsignelementdependencyValidation class TestFieldEEzsignelementdependencyValidation(unittest.TestCase): """FieldEEzsignelementdependencyValidation unit test stubs""" diff --git a/test/test_field_e_ezsignfolder_sendreminderfrequency.py b/test/test_field_e_ezsignfolder_sendreminderfrequency.py index cc560253c..e7af9aae8 100644 --- a/test/test_field_e_ezsignfolder_sendreminderfrequency.py +++ b/test/test_field_e_ezsignfolder_sendreminderfrequency.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.field_e_ezsignfolder_sendreminderfrequency import FieldEEzsignfolderSendreminderfrequency # noqa: E501 +from eZmaxApi.models.field_e_ezsignfolder_sendreminderfrequency import FieldEEzsignfolderSendreminderfrequency class TestFieldEEzsignfolderSendreminderfrequency(unittest.TestCase): """FieldEEzsignfolderSendreminderfrequency unit test stubs""" diff --git a/test/test_field_e_ezsignfolder_step.py b/test/test_field_e_ezsignfolder_step.py index 78b0f9312..4d087380f 100644 --- a/test/test_field_e_ezsignfolder_step.py +++ b/test/test_field_e_ezsignfolder_step.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.field_e_ezsignfolder_step import FieldEEzsignfolderStep # noqa: E501 +from eZmaxApi.models.field_e_ezsignfolder_step import FieldEEzsignfolderStep class TestFieldEEzsignfolderStep(unittest.TestCase): """FieldEEzsignfolderStep unit test stubs""" diff --git a/test/test_field_e_ezsignfoldertype_disposal.py b/test/test_field_e_ezsignfoldertype_disposal.py index b42fdd04b..2951ddabd 100644 --- a/test/test_field_e_ezsignfoldertype_disposal.py +++ b/test/test_field_e_ezsignfoldertype_disposal.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.field_e_ezsignfoldertype_disposal import FieldEEzsignfoldertypeDisposal # noqa: E501 +from eZmaxApi.models.field_e_ezsignfoldertype_disposal import FieldEEzsignfoldertypeDisposal class TestFieldEEzsignfoldertypeDisposal(unittest.TestCase): """FieldEEzsignfoldertypeDisposal unit test stubs""" diff --git a/test/test_field_e_ezsignfoldertype_privacylevel.py b/test/test_field_e_ezsignfoldertype_privacylevel.py index 04fcddfe6..4f2c94081 100644 --- a/test/test_field_e_ezsignfoldertype_privacylevel.py +++ b/test/test_field_e_ezsignfoldertype_privacylevel.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.field_e_ezsignfoldertype_privacylevel import FieldEEzsignfoldertypePrivacylevel # noqa: E501 +from eZmaxApi.models.field_e_ezsignfoldertype_privacylevel import FieldEEzsignfoldertypePrivacylevel class TestFieldEEzsignfoldertypePrivacylevel(unittest.TestCase): """FieldEEzsignfoldertypePrivacylevel unit test stubs""" diff --git a/test/test_field_e_ezsignfoldertype_sendreminderfrequency.py b/test/test_field_e_ezsignfoldertype_sendreminderfrequency.py index f9117b310..d7b166fbd 100644 --- a/test/test_field_e_ezsignfoldertype_sendreminderfrequency.py +++ b/test/test_field_e_ezsignfoldertype_sendreminderfrequency.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.field_e_ezsignfoldertype_sendreminderfrequency import FieldEEzsignfoldertypeSendreminderfrequency # noqa: E501 +from eZmaxApi.models.field_e_ezsignfoldertype_sendreminderfrequency import FieldEEzsignfoldertypeSendreminderfrequency class TestFieldEEzsignfoldertypeSendreminderfrequency(unittest.TestCase): """FieldEEzsignfoldertypeSendreminderfrequency unit test stubs""" diff --git a/test/test_field_e_ezsignformfield_dependencyrequirement.py b/test/test_field_e_ezsignformfield_dependencyrequirement.py index 107448b10..983d8d0c3 100644 --- a/test/test_field_e_ezsignformfield_dependencyrequirement.py +++ b/test/test_field_e_ezsignformfield_dependencyrequirement.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.field_e_ezsignformfield_dependencyrequirement import FieldEEzsignformfieldDependencyrequirement # noqa: E501 +from eZmaxApi.models.field_e_ezsignformfield_dependencyrequirement import FieldEEzsignformfieldDependencyrequirement class TestFieldEEzsignformfieldDependencyrequirement(unittest.TestCase): """FieldEEzsignformfieldDependencyrequirement unit test stubs""" diff --git a/test/test_field_e_ezsignformfieldgroup_signerrequirement.py b/test/test_field_e_ezsignformfieldgroup_signerrequirement.py index 3018eef0e..fba831536 100644 --- a/test/test_field_e_ezsignformfieldgroup_signerrequirement.py +++ b/test/test_field_e_ezsignformfieldgroup_signerrequirement.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.field_e_ezsignformfieldgroup_signerrequirement import FieldEEzsignformfieldgroupSignerrequirement # noqa: E501 +from eZmaxApi.models.field_e_ezsignformfieldgroup_signerrequirement import FieldEEzsignformfieldgroupSignerrequirement class TestFieldEEzsignformfieldgroupSignerrequirement(unittest.TestCase): """FieldEEzsignformfieldgroupSignerrequirement unit test stubs""" diff --git a/test/test_field_e_ezsignformfieldgroup_tooltipposition.py b/test/test_field_e_ezsignformfieldgroup_tooltipposition.py index 1159bab99..8068d136b 100644 --- a/test/test_field_e_ezsignformfieldgroup_tooltipposition.py +++ b/test/test_field_e_ezsignformfieldgroup_tooltipposition.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.field_e_ezsignformfieldgroup_tooltipposition import FieldEEzsignformfieldgroupTooltipposition # noqa: E501 +from eZmaxApi.models.field_e_ezsignformfieldgroup_tooltipposition import FieldEEzsignformfieldgroupTooltipposition class TestFieldEEzsignformfieldgroupTooltipposition(unittest.TestCase): """FieldEEzsignformfieldgroupTooltipposition unit test stubs""" diff --git a/test/test_field_e_ezsignformfieldgroup_type.py b/test/test_field_e_ezsignformfieldgroup_type.py index addd6521a..ce29a653b 100644 --- a/test/test_field_e_ezsignformfieldgroup_type.py +++ b/test/test_field_e_ezsignformfieldgroup_type.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.field_e_ezsignformfieldgroup_type import FieldEEzsignformfieldgroupType # noqa: E501 +from eZmaxApi.models.field_e_ezsignformfieldgroup_type import FieldEEzsignformfieldgroupType class TestFieldEEzsignformfieldgroupType(unittest.TestCase): """FieldEEzsignformfieldgroupType unit test stubs""" diff --git a/test/test_field_e_ezsignsignature_attachmentnamesource.py b/test/test_field_e_ezsignsignature_attachmentnamesource.py index fdef4e349..8587a0f28 100644 --- a/test/test_field_e_ezsignsignature_attachmentnamesource.py +++ b/test/test_field_e_ezsignsignature_attachmentnamesource.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.field_e_ezsignsignature_attachmentnamesource import FieldEEzsignsignatureAttachmentnamesource # noqa: E501 +from eZmaxApi.models.field_e_ezsignsignature_attachmentnamesource import FieldEEzsignsignatureAttachmentnamesource class TestFieldEEzsignsignatureAttachmentnamesource(unittest.TestCase): """FieldEEzsignsignatureAttachmentnamesource unit test stubs""" diff --git a/test/test_field_e_ezsignsignature_dependencyrequirement.py b/test/test_field_e_ezsignsignature_dependencyrequirement.py index c2e203245..8ab55a28e 100644 --- a/test/test_field_e_ezsignsignature_dependencyrequirement.py +++ b/test/test_field_e_ezsignsignature_dependencyrequirement.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.field_e_ezsignsignature_dependencyrequirement import FieldEEzsignsignatureDependencyrequirement # noqa: E501 +from eZmaxApi.models.field_e_ezsignsignature_dependencyrequirement import FieldEEzsignsignatureDependencyrequirement class TestFieldEEzsignsignatureDependencyrequirement(unittest.TestCase): """FieldEEzsignsignatureDependencyrequirement unit test stubs""" diff --git a/test/test_field_e_ezsignsignature_font.py b/test/test_field_e_ezsignsignature_font.py index d2242454f..c7b369340 100644 --- a/test/test_field_e_ezsignsignature_font.py +++ b/test/test_field_e_ezsignsignature_font.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.field_e_ezsignsignature_font import FieldEEzsignsignatureFont # noqa: E501 +from eZmaxApi.models.field_e_ezsignsignature_font import FieldEEzsignsignatureFont class TestFieldEEzsignsignatureFont(unittest.TestCase): """FieldEEzsignsignatureFont unit test stubs""" diff --git a/test/test_field_e_ezsignsignature_tooltipposition.py b/test/test_field_e_ezsignsignature_tooltipposition.py index d1658bd89..6dd248e55 100644 --- a/test/test_field_e_ezsignsignature_tooltipposition.py +++ b/test/test_field_e_ezsignsignature_tooltipposition.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.field_e_ezsignsignature_tooltipposition import FieldEEzsignsignatureTooltipposition # noqa: E501 +from eZmaxApi.models.field_e_ezsignsignature_tooltipposition import FieldEEzsignsignatureTooltipposition class TestFieldEEzsignsignatureTooltipposition(unittest.TestCase): """FieldEEzsignsignatureTooltipposition unit test stubs""" diff --git a/test/test_field_e_ezsignsignature_type.py b/test/test_field_e_ezsignsignature_type.py index 478ecf45e..14b5f8400 100644 --- a/test/test_field_e_ezsignsignature_type.py +++ b/test/test_field_e_ezsignsignature_type.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.field_e_ezsignsignature_type import FieldEEzsignsignatureType # noqa: E501 +from eZmaxApi.models.field_e_ezsignsignature_type import FieldEEzsignsignatureType class TestFieldEEzsignsignatureType(unittest.TestCase): """FieldEEzsignsignatureType unit test stubs""" diff --git a/test/test_field_e_ezsigntemplateelementdependency_operator.py b/test/test_field_e_ezsigntemplateelementdependency_operator.py index 8d0023a4a..18e86839d 100644 --- a/test/test_field_e_ezsigntemplateelementdependency_operator.py +++ b/test/test_field_e_ezsigntemplateelementdependency_operator.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.field_e_ezsigntemplateelementdependency_operator import FieldEEzsigntemplateelementdependencyOperator # noqa: E501 +from eZmaxApi.models.field_e_ezsigntemplateelementdependency_operator import FieldEEzsigntemplateelementdependencyOperator class TestFieldEEzsigntemplateelementdependencyOperator(unittest.TestCase): """FieldEEzsigntemplateelementdependencyOperator unit test stubs""" diff --git a/test/test_field_e_ezsigntemplateelementdependency_validation.py b/test/test_field_e_ezsigntemplateelementdependency_validation.py index 9a1046464..470b7ed02 100644 --- a/test/test_field_e_ezsigntemplateelementdependency_validation.py +++ b/test/test_field_e_ezsigntemplateelementdependency_validation.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.field_e_ezsigntemplateelementdependency_validation import FieldEEzsigntemplateelementdependencyValidation # noqa: E501 +from eZmaxApi.models.field_e_ezsigntemplateelementdependency_validation import FieldEEzsigntemplateelementdependencyValidation class TestFieldEEzsigntemplateelementdependencyValidation(unittest.TestCase): """FieldEEzsigntemplateelementdependencyValidation unit test stubs""" diff --git a/test/test_field_e_ezsigntemplateformfield_dependencyrequirement.py b/test/test_field_e_ezsigntemplateformfield_dependencyrequirement.py index 3c7beea2c..160d1abbe 100644 --- a/test/test_field_e_ezsigntemplateformfield_dependencyrequirement.py +++ b/test/test_field_e_ezsigntemplateformfield_dependencyrequirement.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.field_e_ezsigntemplateformfield_dependencyrequirement import FieldEEzsigntemplateformfieldDependencyrequirement # noqa: E501 +from eZmaxApi.models.field_e_ezsigntemplateformfield_dependencyrequirement import FieldEEzsigntemplateformfieldDependencyrequirement class TestFieldEEzsigntemplateformfieldDependencyrequirement(unittest.TestCase): """FieldEEzsigntemplateformfieldDependencyrequirement unit test stubs""" diff --git a/test/test_field_e_ezsigntemplateformfieldgroup_signerrequirement.py b/test/test_field_e_ezsigntemplateformfieldgroup_signerrequirement.py index cf3b483c7..fa75a1757 100644 --- a/test/test_field_e_ezsigntemplateformfieldgroup_signerrequirement.py +++ b/test/test_field_e_ezsigntemplateformfieldgroup_signerrequirement.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.field_e_ezsigntemplateformfieldgroup_signerrequirement import FieldEEzsigntemplateformfieldgroupSignerrequirement # noqa: E501 +from eZmaxApi.models.field_e_ezsigntemplateformfieldgroup_signerrequirement import FieldEEzsigntemplateformfieldgroupSignerrequirement class TestFieldEEzsigntemplateformfieldgroupSignerrequirement(unittest.TestCase): """FieldEEzsigntemplateformfieldgroupSignerrequirement unit test stubs""" diff --git a/test/test_field_e_ezsigntemplateformfieldgroup_tooltipposition.py b/test/test_field_e_ezsigntemplateformfieldgroup_tooltipposition.py index 037c850b3..7ff78bf87 100644 --- a/test/test_field_e_ezsigntemplateformfieldgroup_tooltipposition.py +++ b/test/test_field_e_ezsigntemplateformfieldgroup_tooltipposition.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.field_e_ezsigntemplateformfieldgroup_tooltipposition import FieldEEzsigntemplateformfieldgroupTooltipposition # noqa: E501 +from eZmaxApi.models.field_e_ezsigntemplateformfieldgroup_tooltipposition import FieldEEzsigntemplateformfieldgroupTooltipposition class TestFieldEEzsigntemplateformfieldgroupTooltipposition(unittest.TestCase): """FieldEEzsigntemplateformfieldgroupTooltipposition unit test stubs""" diff --git a/test/test_field_e_ezsigntemplateformfieldgroup_type.py b/test/test_field_e_ezsigntemplateformfieldgroup_type.py index ebd777685..04a959bba 100644 --- a/test/test_field_e_ezsigntemplateformfieldgroup_type.py +++ b/test/test_field_e_ezsigntemplateformfieldgroup_type.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.field_e_ezsigntemplateformfieldgroup_type import FieldEEzsigntemplateformfieldgroupType # noqa: E501 +from eZmaxApi.models.field_e_ezsigntemplateformfieldgroup_type import FieldEEzsigntemplateformfieldgroupType class TestFieldEEzsigntemplateformfieldgroupType(unittest.TestCase): """FieldEEzsigntemplateformfieldgroupType unit test stubs""" diff --git a/test/test_field_e_ezsigntemplatesignature_attachmentnamesource.py b/test/test_field_e_ezsigntemplatesignature_attachmentnamesource.py index ead4ed4ce..b3d95d0ad 100644 --- a/test/test_field_e_ezsigntemplatesignature_attachmentnamesource.py +++ b/test/test_field_e_ezsigntemplatesignature_attachmentnamesource.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.field_e_ezsigntemplatesignature_attachmentnamesource import FieldEEzsigntemplatesignatureAttachmentnamesource # noqa: E501 +from eZmaxApi.models.field_e_ezsigntemplatesignature_attachmentnamesource import FieldEEzsigntemplatesignatureAttachmentnamesource class TestFieldEEzsigntemplatesignatureAttachmentnamesource(unittest.TestCase): """FieldEEzsigntemplatesignatureAttachmentnamesource unit test stubs""" diff --git a/test/test_field_e_ezsigntemplatesignature_dependencyrequirement.py b/test/test_field_e_ezsigntemplatesignature_dependencyrequirement.py index 9fed52139..b29f38bef 100644 --- a/test/test_field_e_ezsigntemplatesignature_dependencyrequirement.py +++ b/test/test_field_e_ezsigntemplatesignature_dependencyrequirement.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.field_e_ezsigntemplatesignature_dependencyrequirement import FieldEEzsigntemplatesignatureDependencyrequirement # noqa: E501 +from eZmaxApi.models.field_e_ezsigntemplatesignature_dependencyrequirement import FieldEEzsigntemplatesignatureDependencyrequirement class TestFieldEEzsigntemplatesignatureDependencyrequirement(unittest.TestCase): """FieldEEzsigntemplatesignatureDependencyrequirement unit test stubs""" diff --git a/test/test_field_e_ezsigntemplatesignature_font.py b/test/test_field_e_ezsigntemplatesignature_font.py index 826d9de3e..ffa45f06e 100644 --- a/test/test_field_e_ezsigntemplatesignature_font.py +++ b/test/test_field_e_ezsigntemplatesignature_font.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.field_e_ezsigntemplatesignature_font import FieldEEzsigntemplatesignatureFont # noqa: E501 +from eZmaxApi.models.field_e_ezsigntemplatesignature_font import FieldEEzsigntemplatesignatureFont class TestFieldEEzsigntemplatesignatureFont(unittest.TestCase): """FieldEEzsigntemplatesignatureFont unit test stubs""" diff --git a/test/test_field_e_ezsigntemplatesignature_tooltipposition.py b/test/test_field_e_ezsigntemplatesignature_tooltipposition.py index ecd972f66..dc9b353ba 100644 --- a/test/test_field_e_ezsigntemplatesignature_tooltipposition.py +++ b/test/test_field_e_ezsigntemplatesignature_tooltipposition.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.field_e_ezsigntemplatesignature_tooltipposition import FieldEEzsigntemplatesignatureTooltipposition # noqa: E501 +from eZmaxApi.models.field_e_ezsigntemplatesignature_tooltipposition import FieldEEzsigntemplatesignatureTooltipposition class TestFieldEEzsigntemplatesignatureTooltipposition(unittest.TestCase): """FieldEEzsigntemplatesignatureTooltipposition unit test stubs""" diff --git a/test/test_field_e_ezsigntemplatesignature_type.py b/test/test_field_e_ezsigntemplatesignature_type.py index c2eb046c0..779b819bc 100644 --- a/test/test_field_e_ezsigntemplatesignature_type.py +++ b/test/test_field_e_ezsigntemplatesignature_type.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.field_e_ezsigntemplatesignature_type import FieldEEzsigntemplatesignatureType # noqa: E501 +from eZmaxApi.models.field_e_ezsigntemplatesignature_type import FieldEEzsigntemplatesignatureType class TestFieldEEzsigntemplatesignatureType(unittest.TestCase): """FieldEEzsigntemplatesignatureType unit test stubs""" diff --git a/test/test_field_e_notificationpreference_status.py b/test/test_field_e_notificationpreference_status.py index 26a3f2488..d2288e63f 100644 --- a/test/test_field_e_notificationpreference_status.py +++ b/test/test_field_e_notificationpreference_status.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.field_e_notificationpreference_status import FieldENotificationpreferenceStatus # noqa: E501 +from eZmaxApi.models.field_e_notificationpreference_status import FieldENotificationpreferenceStatus class TestFieldENotificationpreferenceStatus(unittest.TestCase): """FieldENotificationpreferenceStatus unit test stubs""" diff --git a/test/test_field_e_paymentterm_type.py b/test/test_field_e_paymentterm_type.py index 4818f9f93..fc7c53dc2 100644 --- a/test/test_field_e_paymentterm_type.py +++ b/test/test_field_e_paymentterm_type.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.field_e_paymentterm_type import FieldEPaymenttermType # noqa: E501 +from eZmaxApi.models.field_e_paymentterm_type import FieldEPaymenttermType class TestFieldEPaymenttermType(unittest.TestCase): """FieldEPaymenttermType unit test stubs""" diff --git a/test/test_field_e_phone_type.py b/test/test_field_e_phone_type.py index 228acf869..7908a3c73 100644 --- a/test/test_field_e_phone_type.py +++ b/test/test_field_e_phone_type.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.field_e_phone_type import FieldEPhoneType # noqa: E501 +from eZmaxApi.models.field_e_phone_type import FieldEPhoneType class TestFieldEPhoneType(unittest.TestCase): """FieldEPhoneType unit test stubs""" diff --git a/test/test_field_e_sessionhistory_endby.py b/test/test_field_e_sessionhistory_endby.py index 3dde2b97a..8025e88e5 100644 --- a/test/test_field_e_sessionhistory_endby.py +++ b/test/test_field_e_sessionhistory_endby.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.field_e_sessionhistory_endby import FieldESessionhistoryEndby # noqa: E501 +from eZmaxApi.models.field_e_sessionhistory_endby import FieldESessionhistoryEndby class TestFieldESessionhistoryEndby(unittest.TestCase): """FieldESessionhistoryEndby unit test stubs""" diff --git a/test/test_field_e_systemconfiguration_ezsign.py b/test/test_field_e_systemconfiguration_ezsign.py index f01123cdd..f58140c82 100644 --- a/test/test_field_e_systemconfiguration_ezsign.py +++ b/test/test_field_e_systemconfiguration_ezsign.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.field_e_systemconfiguration_ezsign import FieldESystemconfigurationEzsign # noqa: E501 +from eZmaxApi.models.field_e_systemconfiguration_ezsign import FieldESystemconfigurationEzsign class TestFieldESystemconfigurationEzsign(unittest.TestCase): """FieldESystemconfigurationEzsign unit test stubs""" diff --git a/test/test_field_e_systemconfiguration_language1.py b/test/test_field_e_systemconfiguration_language1.py index c5ec08ce7..80051a2df 100644 --- a/test/test_field_e_systemconfiguration_language1.py +++ b/test/test_field_e_systemconfiguration_language1.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.field_e_systemconfiguration_language1 import FieldESystemconfigurationLanguage1 # noqa: E501 +from eZmaxApi.models.field_e_systemconfiguration_language1 import FieldESystemconfigurationLanguage1 class TestFieldESystemconfigurationLanguage1(unittest.TestCase): """FieldESystemconfigurationLanguage1 unit test stubs""" diff --git a/test/test_field_e_systemconfiguration_language2.py b/test/test_field_e_systemconfiguration_language2.py index 21ed64a7d..c49b60e1b 100644 --- a/test/test_field_e_systemconfiguration_language2.py +++ b/test/test_field_e_systemconfiguration_language2.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.field_e_systemconfiguration_language2 import FieldESystemconfigurationLanguage2 # noqa: E501 +from eZmaxApi.models.field_e_systemconfiguration_language2 import FieldESystemconfigurationLanguage2 class TestFieldESystemconfigurationLanguage2(unittest.TestCase): """FieldESystemconfigurationLanguage2 unit test stubs""" diff --git a/test/test_field_e_systemconfiguration_newexternaluseraction.py b/test/test_field_e_systemconfiguration_newexternaluseraction.py index 64417cf0e..68da8c64e 100644 --- a/test/test_field_e_systemconfiguration_newexternaluseraction.py +++ b/test/test_field_e_systemconfiguration_newexternaluseraction.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.field_e_systemconfiguration_newexternaluseraction import FieldESystemconfigurationNewexternaluseraction # noqa: E501 +from eZmaxApi.models.field_e_systemconfiguration_newexternaluseraction import FieldESystemconfigurationNewexternaluseraction class TestFieldESystemconfigurationNewexternaluseraction(unittest.TestCase): """FieldESystemconfigurationNewexternaluseraction unit test stubs""" diff --git a/test/test_field_e_user_ezsignaccess.py b/test/test_field_e_user_ezsignaccess.py index 254bdba64..09fd047fe 100644 --- a/test/test_field_e_user_ezsignaccess.py +++ b/test/test_field_e_user_ezsignaccess.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.field_e_user_ezsignaccess import FieldEUserEzsignaccess # noqa: E501 +from eZmaxApi.models.field_e_user_ezsignaccess import FieldEUserEzsignaccess class TestFieldEUserEzsignaccess(unittest.TestCase): """FieldEUserEzsignaccess unit test stubs""" diff --git a/test/test_field_e_user_ezsignprepaid.py b/test/test_field_e_user_ezsignprepaid.py new file mode 100644 index 000000000..32c42b2b8 --- /dev/null +++ b/test/test_field_e_user_ezsignprepaid.py @@ -0,0 +1,35 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest +import datetime + +from eZmaxApi.models.field_e_user_ezsignprepaid import FieldEUserEzsignprepaid + +class TestFieldEUserEzsignprepaid(unittest.TestCase): + """FieldEUserEzsignprepaid unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testFieldEUserEzsignprepaid(self): + """Test FieldEUserEzsignprepaid""" + # inst = FieldEUserEzsignprepaid() + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_field_e_user_ezsignsendreminderfrequency.py b/test/test_field_e_user_ezsignsendreminderfrequency.py index b7178d81a..295e11224 100644 --- a/test/test_field_e_user_ezsignsendreminderfrequency.py +++ b/test/test_field_e_user_ezsignsendreminderfrequency.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.field_e_user_ezsignsendreminderfrequency import FieldEUserEzsignsendreminderfrequency # noqa: E501 +from eZmaxApi.models.field_e_user_ezsignsendreminderfrequency import FieldEUserEzsignsendreminderfrequency class TestFieldEUserEzsignsendreminderfrequency(unittest.TestCase): """FieldEUserEzsignsendreminderfrequency unit test stubs""" diff --git a/test/test_field_e_user_logintype.py b/test/test_field_e_user_logintype.py index c1bab753c..7d907fd3f 100644 --- a/test/test_field_e_user_logintype.py +++ b/test/test_field_e_user_logintype.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.field_e_user_logintype import FieldEUserLogintype # noqa: E501 +from eZmaxApi.models.field_e_user_logintype import FieldEUserLogintype class TestFieldEUserLogintype(unittest.TestCase): """FieldEUserLogintype unit test stubs""" diff --git a/test/test_field_e_user_origin.py b/test/test_field_e_user_origin.py index 4b90f14bc..9628aa38b 100644 --- a/test/test_field_e_user_origin.py +++ b/test/test_field_e_user_origin.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.field_e_user_origin import FieldEUserOrigin # noqa: E501 +from eZmaxApi.models.field_e_user_origin import FieldEUserOrigin class TestFieldEUserOrigin(unittest.TestCase): """FieldEUserOrigin unit test stubs""" diff --git a/test/test_field_e_user_type.py b/test/test_field_e_user_type.py index 6ccdabf55..5f9da3a21 100644 --- a/test/test_field_e_user_type.py +++ b/test/test_field_e_user_type.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.field_e_user_type import FieldEUserType # noqa: E501 +from eZmaxApi.models.field_e_user_type import FieldEUserType class TestFieldEUserType(unittest.TestCase): """FieldEUserType unit test stubs""" diff --git a/test/test_field_e_variableexpense_taxable.py b/test/test_field_e_variableexpense_taxable.py index 06af3b855..e5aeeab32 100644 --- a/test/test_field_e_variableexpense_taxable.py +++ b/test/test_field_e_variableexpense_taxable.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.field_e_variableexpense_taxable import FieldEVariableexpenseTaxable # noqa: E501 +from eZmaxApi.models.field_e_variableexpense_taxable import FieldEVariableexpenseTaxable class TestFieldEVariableexpenseTaxable(unittest.TestCase): """FieldEVariableexpenseTaxable unit test stubs""" diff --git a/test/test_field_e_versionhistory_type.py b/test/test_field_e_versionhistory_type.py index 2e8e48171..eb8eb1f1f 100644 --- a/test/test_field_e_versionhistory_type.py +++ b/test/test_field_e_versionhistory_type.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.field_e_versionhistory_type import FieldEVersionhistoryType # noqa: E501 +from eZmaxApi.models.field_e_versionhistory_type import FieldEVersionhistoryType class TestFieldEVersionhistoryType(unittest.TestCase): """FieldEVersionhistoryType unit test stubs""" diff --git a/test/test_field_e_versionhistory_usertype.py b/test/test_field_e_versionhistory_usertype.py index 10707af2a..96a374fcb 100644 --- a/test/test_field_e_versionhistory_usertype.py +++ b/test/test_field_e_versionhistory_usertype.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.field_e_versionhistory_usertype import FieldEVersionhistoryUsertype # noqa: E501 +from eZmaxApi.models.field_e_versionhistory_usertype import FieldEVersionhistoryUsertype class TestFieldEVersionhistoryUsertype(unittest.TestCase): """FieldEVersionhistoryUsertype unit test stubs""" diff --git a/test/test_field_e_webhook_ezsignevent.py b/test/test_field_e_webhook_ezsignevent.py index 511d72cde..3d07d042a 100644 --- a/test/test_field_e_webhook_ezsignevent.py +++ b/test/test_field_e_webhook_ezsignevent.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.field_e_webhook_ezsignevent import FieldEWebhookEzsignevent # noqa: E501 +from eZmaxApi.models.field_e_webhook_ezsignevent import FieldEWebhookEzsignevent class TestFieldEWebhookEzsignevent(unittest.TestCase): """FieldEWebhookEzsignevent unit test stubs""" diff --git a/test/test_field_e_webhook_managementevent.py b/test/test_field_e_webhook_managementevent.py index 294318471..c5577957d 100644 --- a/test/test_field_e_webhook_managementevent.py +++ b/test/test_field_e_webhook_managementevent.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.field_e_webhook_managementevent import FieldEWebhookManagementevent # noqa: E501 +from eZmaxApi.models.field_e_webhook_managementevent import FieldEWebhookManagementevent class TestFieldEWebhookManagementevent(unittest.TestCase): """FieldEWebhookManagementevent unit test stubs""" diff --git a/test/test_field_e_webhook_module.py b/test/test_field_e_webhook_module.py index 4652a72b6..4aa134bf0 100644 --- a/test/test_field_e_webhook_module.py +++ b/test/test_field_e_webhook_module.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.field_e_webhook_module import FieldEWebhookModule # noqa: E501 +from eZmaxApi.models.field_e_webhook_module import FieldEWebhookModule class TestFieldEWebhookModule(unittest.TestCase): """FieldEWebhookModule unit test stubs""" diff --git a/test/test_field_pks_ezmaxclient_os.py b/test/test_field_pks_ezmaxclient_os.py index aeb067467..4a4bf65d5 100644 --- a/test/test_field_pks_ezmaxclient_os.py +++ b/test/test_field_pks_ezmaxclient_os.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.field_pks_ezmaxclient_os import FieldPksEzmaxclientOs # noqa: E501 +from eZmaxApi.models.field_pks_ezmaxclient_os import FieldPksEzmaxclientOs class TestFieldPksEzmaxclientOs(unittest.TestCase): """FieldPksEzmaxclientOs unit test stubs""" diff --git a/test/test_font_autocomplete_element_response.py b/test/test_font_autocomplete_element_response.py index 75e0f3b59..1fe4ae328 100644 --- a/test/test_font_autocomplete_element_response.py +++ b/test/test_font_autocomplete_element_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.font_autocomplete_element_response import FontAutocompleteElementResponse # noqa: E501 +from eZmaxApi.models.font_autocomplete_element_response import FontAutocompleteElementResponse class TestFontAutocompleteElementResponse(unittest.TestCase): """FontAutocompleteElementResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> FontAutocompleteElementResponse: optional params are included """ # uncomment below to create an instance of `FontAutocompleteElementResponse` """ - model = FontAutocompleteElementResponse() # noqa: E501 + model = FontAutocompleteElementResponse() if include_optional: return FontAutocompleteElementResponse( s_font_name = 'Arial', diff --git a/test/test_font_get_autocomplete_v2_response.py b/test/test_font_get_autocomplete_v2_response.py index 7c72c73bd..fcba96d66 100644 --- a/test/test_font_get_autocomplete_v2_response.py +++ b/test/test_font_get_autocomplete_v2_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.font_get_autocomplete_v2_response import FontGetAutocompleteV2Response # noqa: E501 +from eZmaxApi.models.font_get_autocomplete_v2_response import FontGetAutocompleteV2Response class TestFontGetAutocompleteV2Response(unittest.TestCase): """FontGetAutocompleteV2Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> FontGetAutocompleteV2Response: optional params are included """ # uncomment below to create an instance of `FontGetAutocompleteV2Response` """ - model = FontGetAutocompleteV2Response() # noqa: E501 + model = FontGetAutocompleteV2Response() if include_optional: return FontGetAutocompleteV2Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_font_get_autocomplete_v2_response_m_payload.py b/test/test_font_get_autocomplete_v2_response_m_payload.py index 1cbe4b2d6..24e506b00 100644 --- a/test/test_font_get_autocomplete_v2_response_m_payload.py +++ b/test/test_font_get_autocomplete_v2_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.font_get_autocomplete_v2_response_m_payload import FontGetAutocompleteV2ResponseMPayload # noqa: E501 +from eZmaxApi.models.font_get_autocomplete_v2_response_m_payload import FontGetAutocompleteV2ResponseMPayload class TestFontGetAutocompleteV2ResponseMPayload(unittest.TestCase): """FontGetAutocompleteV2ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> FontGetAutocompleteV2ResponseMPaylo optional params are included """ # uncomment below to create an instance of `FontGetAutocompleteV2ResponseMPayload` """ - model = FontGetAutocompleteV2ResponseMPayload() # noqa: E501 + model = FontGetAutocompleteV2ResponseMPayload() if include_optional: return FontGetAutocompleteV2ResponseMPayload( a_obj_font = [ diff --git a/test/test_franchisebroker_autocomplete_element_response.py b/test/test_franchisebroker_autocomplete_element_response.py index 172b3f005..a16f53245 100644 --- a/test/test_franchisebroker_autocomplete_element_response.py +++ b/test/test_franchisebroker_autocomplete_element_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.franchisebroker_autocomplete_element_response import FranchisebrokerAutocompleteElementResponse # noqa: E501 +from eZmaxApi.models.franchisebroker_autocomplete_element_response import FranchisebrokerAutocompleteElementResponse class TestFranchisebrokerAutocompleteElementResponse(unittest.TestCase): """FranchisebrokerAutocompleteElementResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> FranchisebrokerAutocompleteElementR optional params are included """ # uncomment below to create an instance of `FranchisebrokerAutocompleteElementResponse` """ - model = FranchisebrokerAutocompleteElementResponse() # noqa: E501 + model = FranchisebrokerAutocompleteElementResponse() if include_optional: return FranchisebrokerAutocompleteElementResponse( s_franchisebroker_name = 'Default', diff --git a/test/test_franchisebroker_get_autocomplete_v2_response.py b/test/test_franchisebroker_get_autocomplete_v2_response.py index 14a90db02..c088b6d2d 100644 --- a/test/test_franchisebroker_get_autocomplete_v2_response.py +++ b/test/test_franchisebroker_get_autocomplete_v2_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.franchisebroker_get_autocomplete_v2_response import FranchisebrokerGetAutocompleteV2Response # noqa: E501 +from eZmaxApi.models.franchisebroker_get_autocomplete_v2_response import FranchisebrokerGetAutocompleteV2Response class TestFranchisebrokerGetAutocompleteV2Response(unittest.TestCase): """FranchisebrokerGetAutocompleteV2Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> FranchisebrokerGetAutocompleteV2Res optional params are included """ # uncomment below to create an instance of `FranchisebrokerGetAutocompleteV2Response` """ - model = FranchisebrokerGetAutocompleteV2Response() # noqa: E501 + model = FranchisebrokerGetAutocompleteV2Response() if include_optional: return FranchisebrokerGetAutocompleteV2Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_franchisebroker_get_autocomplete_v2_response_m_payload.py b/test/test_franchisebroker_get_autocomplete_v2_response_m_payload.py index 2d21d7993..4234d1999 100644 --- a/test/test_franchisebroker_get_autocomplete_v2_response_m_payload.py +++ b/test/test_franchisebroker_get_autocomplete_v2_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.franchisebroker_get_autocomplete_v2_response_m_payload import FranchisebrokerGetAutocompleteV2ResponseMPayload # noqa: E501 +from eZmaxApi.models.franchisebroker_get_autocomplete_v2_response_m_payload import FranchisebrokerGetAutocompleteV2ResponseMPayload class TestFranchisebrokerGetAutocompleteV2ResponseMPayload(unittest.TestCase): """FranchisebrokerGetAutocompleteV2ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> FranchisebrokerGetAutocompleteV2Res optional params are included """ # uncomment below to create an instance of `FranchisebrokerGetAutocompleteV2ResponseMPayload` """ - model = FranchisebrokerGetAutocompleteV2ResponseMPayload() # noqa: E501 + model = FranchisebrokerGetAutocompleteV2ResponseMPayload() if include_optional: return FranchisebrokerGetAutocompleteV2ResponseMPayload( a_obj_franchisebroker = [ diff --git a/test/test_franchiseoffice_autocomplete_element_response.py b/test/test_franchiseoffice_autocomplete_element_response.py index f82272a42..cd98c4461 100644 --- a/test/test_franchiseoffice_autocomplete_element_response.py +++ b/test/test_franchiseoffice_autocomplete_element_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.franchiseoffice_autocomplete_element_response import FranchiseofficeAutocompleteElementResponse # noqa: E501 +from eZmaxApi.models.franchiseoffice_autocomplete_element_response import FranchiseofficeAutocompleteElementResponse class TestFranchiseofficeAutocompleteElementResponse(unittest.TestCase): """FranchiseofficeAutocompleteElementResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> FranchiseofficeAutocompleteElementR optional params are included """ # uncomment below to create an instance of `FranchiseofficeAutocompleteElementResponse` """ - model = FranchiseofficeAutocompleteElementResponse() # noqa: E501 + model = FranchiseofficeAutocompleteElementResponse() if include_optional: return FranchiseofficeAutocompleteElementResponse( s_franchiseoffice_description = 'Default', diff --git a/test/test_franchiseoffice_get_autocomplete_v2_response.py b/test/test_franchiseoffice_get_autocomplete_v2_response.py index 7487a6629..045831d92 100644 --- a/test/test_franchiseoffice_get_autocomplete_v2_response.py +++ b/test/test_franchiseoffice_get_autocomplete_v2_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.franchiseoffice_get_autocomplete_v2_response import FranchiseofficeGetAutocompleteV2Response # noqa: E501 +from eZmaxApi.models.franchiseoffice_get_autocomplete_v2_response import FranchiseofficeGetAutocompleteV2Response class TestFranchiseofficeGetAutocompleteV2Response(unittest.TestCase): """FranchiseofficeGetAutocompleteV2Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> FranchiseofficeGetAutocompleteV2Res optional params are included """ # uncomment below to create an instance of `FranchiseofficeGetAutocompleteV2Response` """ - model = FranchiseofficeGetAutocompleteV2Response() # noqa: E501 + model = FranchiseofficeGetAutocompleteV2Response() if include_optional: return FranchiseofficeGetAutocompleteV2Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_franchiseoffice_get_autocomplete_v2_response_m_payload.py b/test/test_franchiseoffice_get_autocomplete_v2_response_m_payload.py index 68a1c7965..72b1bd2a0 100644 --- a/test/test_franchiseoffice_get_autocomplete_v2_response_m_payload.py +++ b/test/test_franchiseoffice_get_autocomplete_v2_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.franchiseoffice_get_autocomplete_v2_response_m_payload import FranchiseofficeGetAutocompleteV2ResponseMPayload # noqa: E501 +from eZmaxApi.models.franchiseoffice_get_autocomplete_v2_response_m_payload import FranchiseofficeGetAutocompleteV2ResponseMPayload class TestFranchiseofficeGetAutocompleteV2ResponseMPayload(unittest.TestCase): """FranchiseofficeGetAutocompleteV2ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> FranchiseofficeGetAutocompleteV2Res optional params are included """ # uncomment below to create an instance of `FranchiseofficeGetAutocompleteV2ResponseMPayload` """ - model = FranchiseofficeGetAutocompleteV2ResponseMPayload() # noqa: E501 + model = FranchiseofficeGetAutocompleteV2ResponseMPayload() if include_optional: return FranchiseofficeGetAutocompleteV2ResponseMPayload( a_obj_franchiseoffice = [ diff --git a/test/test_franchisereferalincome_create_object_v1_request.py b/test/test_franchisereferalincome_create_object_v1_request.py index d17b615e2..214725f81 100644 --- a/test/test_franchisereferalincome_create_object_v1_request.py +++ b/test/test_franchisereferalincome_create_object_v1_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.franchisereferalincome_create_object_v1_request import FranchisereferalincomeCreateObjectV1Request # noqa: E501 +from eZmaxApi.models.franchisereferalincome_create_object_v1_request import FranchisereferalincomeCreateObjectV1Request class TestFranchisereferalincomeCreateObjectV1Request(unittest.TestCase): """FranchisereferalincomeCreateObjectV1Request unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> FranchisereferalincomeCreateObjectV optional params are included """ # uncomment below to create an instance of `FranchisereferalincomeCreateObjectV1Request` """ - model = FranchisereferalincomeCreateObjectV1Request() # noqa: E501 + model = FranchisereferalincomeCreateObjectV1Request() if include_optional: return FranchisereferalincomeCreateObjectV1Request( obj_franchisereferalincome = eZmaxApi.models.franchisereferalincome_request.franchisereferalincome-Request( diff --git a/test/test_franchisereferalincome_create_object_v1_response.py b/test/test_franchisereferalincome_create_object_v1_response.py index c2940cdba..8011a2f6f 100644 --- a/test/test_franchisereferalincome_create_object_v1_response.py +++ b/test/test_franchisereferalincome_create_object_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.franchisereferalincome_create_object_v1_response import FranchisereferalincomeCreateObjectV1Response # noqa: E501 +from eZmaxApi.models.franchisereferalincome_create_object_v1_response import FranchisereferalincomeCreateObjectV1Response class TestFranchisereferalincomeCreateObjectV1Response(unittest.TestCase): """FranchisereferalincomeCreateObjectV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> FranchisereferalincomeCreateObjectV optional params are included """ # uncomment below to create an instance of `FranchisereferalincomeCreateObjectV1Response` """ - model = FranchisereferalincomeCreateObjectV1Response() # noqa: E501 + model = FranchisereferalincomeCreateObjectV1Response() if include_optional: return FranchisereferalincomeCreateObjectV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_franchisereferalincome_create_object_v1_response_m_payload.py b/test/test_franchisereferalincome_create_object_v1_response_m_payload.py index f67607d74..2b008ed96 100644 --- a/test/test_franchisereferalincome_create_object_v1_response_m_payload.py +++ b/test/test_franchisereferalincome_create_object_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.franchisereferalincome_create_object_v1_response_m_payload import FranchisereferalincomeCreateObjectV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.franchisereferalincome_create_object_v1_response_m_payload import FranchisereferalincomeCreateObjectV1ResponseMPayload class TestFranchisereferalincomeCreateObjectV1ResponseMPayload(unittest.TestCase): """FranchisereferalincomeCreateObjectV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> FranchisereferalincomeCreateObjectV optional params are included """ # uncomment below to create an instance of `FranchisereferalincomeCreateObjectV1ResponseMPayload` """ - model = FranchisereferalincomeCreateObjectV1ResponseMPayload() # noqa: E501 + model = FranchisereferalincomeCreateObjectV1ResponseMPayload() if include_optional: return FranchisereferalincomeCreateObjectV1ResponseMPayload( a_pki_franchisereferalincome_id = [ diff --git a/test/test_franchisereferalincome_create_object_v2_request.py b/test/test_franchisereferalincome_create_object_v2_request.py index 519380b8a..0af7d8e97 100644 --- a/test/test_franchisereferalincome_create_object_v2_request.py +++ b/test/test_franchisereferalincome_create_object_v2_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.franchisereferalincome_create_object_v2_request import FranchisereferalincomeCreateObjectV2Request # noqa: E501 +from eZmaxApi.models.franchisereferalincome_create_object_v2_request import FranchisereferalincomeCreateObjectV2Request class TestFranchisereferalincomeCreateObjectV2Request(unittest.TestCase): """FranchisereferalincomeCreateObjectV2Request unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> FranchisereferalincomeCreateObjectV optional params are included """ # uncomment below to create an instance of `FranchisereferalincomeCreateObjectV2Request` """ - model = FranchisereferalincomeCreateObjectV2Request() # noqa: E501 + model = FranchisereferalincomeCreateObjectV2Request() if include_optional: return FranchisereferalincomeCreateObjectV2Request( a_obj_franchisereferalincome = [ diff --git a/test/test_franchisereferalincome_create_object_v2_response.py b/test/test_franchisereferalincome_create_object_v2_response.py index 983da9d66..47e23c1b2 100644 --- a/test/test_franchisereferalincome_create_object_v2_response.py +++ b/test/test_franchisereferalincome_create_object_v2_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.franchisereferalincome_create_object_v2_response import FranchisereferalincomeCreateObjectV2Response # noqa: E501 +from eZmaxApi.models.franchisereferalincome_create_object_v2_response import FranchisereferalincomeCreateObjectV2Response class TestFranchisereferalincomeCreateObjectV2Response(unittest.TestCase): """FranchisereferalincomeCreateObjectV2Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> FranchisereferalincomeCreateObjectV optional params are included """ # uncomment below to create an instance of `FranchisereferalincomeCreateObjectV2Response` """ - model = FranchisereferalincomeCreateObjectV2Response() # noqa: E501 + model = FranchisereferalincomeCreateObjectV2Response() if include_optional: return FranchisereferalincomeCreateObjectV2Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_franchisereferalincome_create_object_v2_response_m_payload.py b/test/test_franchisereferalincome_create_object_v2_response_m_payload.py index 35b9aa460..9c6b670b1 100644 --- a/test/test_franchisereferalincome_create_object_v2_response_m_payload.py +++ b/test/test_franchisereferalincome_create_object_v2_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.franchisereferalincome_create_object_v2_response_m_payload import FranchisereferalincomeCreateObjectV2ResponseMPayload # noqa: E501 +from eZmaxApi.models.franchisereferalincome_create_object_v2_response_m_payload import FranchisereferalincomeCreateObjectV2ResponseMPayload class TestFranchisereferalincomeCreateObjectV2ResponseMPayload(unittest.TestCase): """FranchisereferalincomeCreateObjectV2ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> FranchisereferalincomeCreateObjectV optional params are included """ # uncomment below to create an instance of `FranchisereferalincomeCreateObjectV2ResponseMPayload` """ - model = FranchisereferalincomeCreateObjectV2ResponseMPayload() # noqa: E501 + model = FranchisereferalincomeCreateObjectV2ResponseMPayload() if include_optional: return FranchisereferalincomeCreateObjectV2ResponseMPayload( a_pki_franchisereferalincome_id = [ diff --git a/test/test_franchisereferalincome_request.py b/test/test_franchisereferalincome_request.py index 4d0f396b1..9fe2726bb 100644 --- a/test/test_franchisereferalincome_request.py +++ b/test/test_franchisereferalincome_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.franchisereferalincome_request import FranchisereferalincomeRequest # noqa: E501 +from eZmaxApi.models.franchisereferalincome_request import FranchisereferalincomeRequest class TestFranchisereferalincomeRequest(unittest.TestCase): """FranchisereferalincomeRequest unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> FranchisereferalincomeRequest: optional params are included """ # uncomment below to create an instance of `FranchisereferalincomeRequest` """ - model = FranchisereferalincomeRequest() # noqa: E501 + model = FranchisereferalincomeRequest() if include_optional: return FranchisereferalincomeRequest( pki_franchisereferalincome_id = 35, diff --git a/test/test_franchisereferalincome_request_compound.py b/test/test_franchisereferalincome_request_compound.py index 031a3bfbf..50022aee1 100644 --- a/test/test_franchisereferalincome_request_compound.py +++ b/test/test_franchisereferalincome_request_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.franchisereferalincome_request_compound import FranchisereferalincomeRequestCompound # noqa: E501 +from eZmaxApi.models.franchisereferalincome_request_compound import FranchisereferalincomeRequestCompound class TestFranchisereferalincomeRequestCompound(unittest.TestCase): """FranchisereferalincomeRequestCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> FranchisereferalincomeRequestCompou optional params are included """ # uncomment below to create an instance of `FranchisereferalincomeRequestCompound` """ - model = FranchisereferalincomeRequestCompound() # noqa: E501 + model = FranchisereferalincomeRequestCompound() if include_optional: return FranchisereferalincomeRequestCompound( pki_franchisereferalincome_id = 35, diff --git a/test/test_global_customer_api.py b/test/test_global_customer_api.py index fba52d040..db5a759b2 100644 --- a/test/test_global_customer_api.py +++ b/test/test_global_customer_api.py @@ -15,14 +15,14 @@ import unittest -from eZmaxApi.api.global_customer_api import GlobalCustomerApi # noqa: E501 +from eZmaxApi.api.global_customer_api import GlobalCustomerApi class TestGlobalCustomerApi(unittest.TestCase): """GlobalCustomerApi unit test stubs""" def setUp(self) -> None: - self.api = GlobalCustomerApi() # noqa: E501 + self.api = GlobalCustomerApi() def tearDown(self) -> None: pass @@ -30,7 +30,7 @@ def tearDown(self) -> None: def test_global_customer_get_endpoint_v1(self) -> None: """Test case for global_customer_get_endpoint_v1 - Get customer endpoint # noqa: E501 + Get customer endpoint """ pass diff --git a/test/test_global_customer_get_endpoint_v1_response.py b/test/test_global_customer_get_endpoint_v1_response.py index 632412f2e..e861df6ea 100644 --- a/test/test_global_customer_get_endpoint_v1_response.py +++ b/test/test_global_customer_get_endpoint_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.global_customer_get_endpoint_v1_response import GlobalCustomerGetEndpointV1Response # noqa: E501 +from eZmaxApi.models.global_customer_get_endpoint_v1_response import GlobalCustomerGetEndpointV1Response class TestGlobalCustomerGetEndpointV1Response(unittest.TestCase): """GlobalCustomerGetEndpointV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> GlobalCustomerGetEndpointV1Response optional params are included """ # uncomment below to create an instance of `GlobalCustomerGetEndpointV1Response` """ - model = GlobalCustomerGetEndpointV1Response() # noqa: E501 + model = GlobalCustomerGetEndpointV1Response() if include_optional: return GlobalCustomerGetEndpointV1Response( s_endpoint_url = '' diff --git a/test/test_global_ezmaxclient_api.py b/test/test_global_ezmaxclient_api.py index 46bc516dc..0d2b4beb0 100644 --- a/test/test_global_ezmaxclient_api.py +++ b/test/test_global_ezmaxclient_api.py @@ -15,14 +15,14 @@ import unittest -from eZmaxApi.api.global_ezmaxclient_api import GlobalEzmaxclientApi # noqa: E501 +from eZmaxApi.api.global_ezmaxclient_api import GlobalEzmaxclientApi class TestGlobalEzmaxclientApi(unittest.TestCase): """GlobalEzmaxclientApi unit test stubs""" def setUp(self) -> None: - self.api = GlobalEzmaxclientApi() # noqa: E501 + self.api = GlobalEzmaxclientApi() def tearDown(self) -> None: pass @@ -30,7 +30,7 @@ def tearDown(self) -> None: def test_global_ezmaxclient_version_v1(self) -> None: """Test case for global_ezmaxclient_version_v1 - Retrieve the latest version of the Ezmaxclient # noqa: E501 + Retrieve the latest version of the Ezmaxclient """ pass diff --git a/test/test_global_ezmaxclient_version_v1_response.py b/test/test_global_ezmaxclient_version_v1_response.py index 7c7609dc5..b76106c46 100644 --- a/test/test_global_ezmaxclient_version_v1_response.py +++ b/test/test_global_ezmaxclient_version_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.global_ezmaxclient_version_v1_response import GlobalEzmaxclientVersionV1Response # noqa: E501 +from eZmaxApi.models.global_ezmaxclient_version_v1_response import GlobalEzmaxclientVersionV1Response class TestGlobalEzmaxclientVersionV1Response(unittest.TestCase): """GlobalEzmaxclientVersionV1Response unit test stubs""" @@ -34,14 +34,16 @@ def make_instance(self, include_optional) -> GlobalEzmaxclientVersionV1Response: optional params are included """ # uncomment below to create an instance of `GlobalEzmaxclientVersionV1Response` """ - model = GlobalEzmaxclientVersionV1Response() # noqa: E501 + model = GlobalEzmaxclientVersionV1Response() if include_optional: return GlobalEzmaxclientVersionV1Response( - s_ezmaxclient_version = '' + s_ezmaxclient_version = '', + s_ezmaxclient_oslatestversion = '11' ) else: return GlobalEzmaxclientVersionV1Response( s_ezmaxclient_version = '', + s_ezmaxclient_oslatestversion = '11', ) """ diff --git a/test/test_global_ezmaxcustomer_api.py b/test/test_global_ezmaxcustomer_api.py index 98194d82b..b8dbfddb8 100644 --- a/test/test_global_ezmaxcustomer_api.py +++ b/test/test_global_ezmaxcustomer_api.py @@ -15,14 +15,14 @@ import unittest -from eZmaxApi.api.global_ezmaxcustomer_api import GlobalEzmaxcustomerApi # noqa: E501 +from eZmaxApi.api.global_ezmaxcustomer_api import GlobalEzmaxcustomerApi class TestGlobalEzmaxcustomerApi(unittest.TestCase): """GlobalEzmaxcustomerApi unit test stubs""" def setUp(self) -> None: - self.api = GlobalEzmaxcustomerApi() # noqa: E501 + self.api = GlobalEzmaxcustomerApi() def tearDown(self) -> None: pass @@ -30,7 +30,7 @@ def tearDown(self) -> None: def test_global_ezmaxcustomer_get_configuration_v1(self) -> None: """Test case for global_ezmaxcustomer_get_configuration_v1 - Get ezmaxcustomer configuration # noqa: E501 + Get ezmaxcustomer configuration """ pass diff --git a/test/test_global_ezmaxcustomer_get_configuration_v1_response.py b/test/test_global_ezmaxcustomer_get_configuration_v1_response.py index fe918125d..425c625f1 100644 --- a/test/test_global_ezmaxcustomer_get_configuration_v1_response.py +++ b/test/test_global_ezmaxcustomer_get_configuration_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.global_ezmaxcustomer_get_configuration_v1_response import GlobalEzmaxcustomerGetConfigurationV1Response # noqa: E501 +from eZmaxApi.models.global_ezmaxcustomer_get_configuration_v1_response import GlobalEzmaxcustomerGetConfigurationV1Response class TestGlobalEzmaxcustomerGetConfigurationV1Response(unittest.TestCase): """GlobalEzmaxcustomerGetConfigurationV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> GlobalEzmaxcustomerGetConfiguration optional params are included """ # uncomment below to create an instance of `GlobalEzmaxcustomerGetConfigurationV1Response` """ - model = GlobalEzmaxcustomerGetConfigurationV1Response() # noqa: E501 + model = GlobalEzmaxcustomerGetConfigurationV1Response() if include_optional: return GlobalEzmaxcustomerGetConfigurationV1Response( s_infrastructureregion_code = 'ca-central-1', diff --git a/test/test_header_accept_language.py b/test/test_header_accept_language.py index 401442f96..9ce50f425 100644 --- a/test/test_header_accept_language.py +++ b/test/test_header_accept_language.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.header_accept_language import HeaderAcceptLanguage # noqa: E501 +from eZmaxApi.models.header_accept_language import HeaderAcceptLanguage class TestHeaderAcceptLanguage(unittest.TestCase): """HeaderAcceptLanguage unit test stubs""" diff --git a/test/test_inscription_get_attachments_v1_response.py b/test/test_inscription_get_attachments_v1_response.py new file mode 100644 index 000000000..a93d72e0c --- /dev/null +++ b/test/test_inscription_get_attachments_v1_response.py @@ -0,0 +1,83 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest +import datetime + +from eZmaxApi.models.inscription_get_attachments_v1_response import InscriptionGetAttachmentsV1Response + +class TestInscriptionGetAttachmentsV1Response(unittest.TestCase): + """InscriptionGetAttachmentsV1Response unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> InscriptionGetAttachmentsV1Response: + """Test InscriptionGetAttachmentsV1Response + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `InscriptionGetAttachmentsV1Response` + """ + model = InscriptionGetAttachmentsV1Response() + if include_optional: + return InscriptionGetAttachmentsV1Response( + obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( + i_version_min = 1, + i_version_max = 2, + a_required_permission = [ + 117 + ], + b_version_deprecated = False, ), + obj_debug = {"sMemoryUsage":"11,923MB","sRunTime":"0.6084s","iSQLSelects":3,"iSQLQueries":6,"a_objSQLQuery":[{"sQuery":"SELECT * FROM table","fDuration":1.0E-4},{"sQuery":"SELECT * FROM table","fDuration":1.0E-4}]}, + m_payload = eZmaxApi.models.inscription_get_attachments_v1_response_m_payload.inscription-getAttachments-v1-Response-mPayload( + a_obj_attachmentdocumenttype = [ + eZmaxApi.models.custom_attachmentdocumenttype_response.Custom-Attachmentdocumenttype-Response( + e_attachment_documenttype = 'Adjustment', + a_obj_attachment = [ + eZmaxApi.models.custom_attachment_response.Custom-Attachment-Response() + ], ) + ], ) + ) + else: + return InscriptionGetAttachmentsV1Response( + obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( + i_version_min = 1, + i_version_max = 2, + a_required_permission = [ + 117 + ], + b_version_deprecated = False, ), + m_payload = eZmaxApi.models.inscription_get_attachments_v1_response_m_payload.inscription-getAttachments-v1-Response-mPayload( + a_obj_attachmentdocumenttype = [ + eZmaxApi.models.custom_attachmentdocumenttype_response.Custom-Attachmentdocumenttype-Response( + e_attachment_documenttype = 'Adjustment', + a_obj_attachment = [ + eZmaxApi.models.custom_attachment_response.Custom-Attachment-Response() + ], ) + ], ), + ) + """ + + def testInscriptionGetAttachmentsV1Response(self): + """Test InscriptionGetAttachmentsV1Response""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inscription_get_attachments_v1_response_m_payload.py b/test/test_inscription_get_attachments_v1_response_m_payload.py new file mode 100644 index 000000000..92a42ed05 --- /dev/null +++ b/test/test_inscription_get_attachments_v1_response_m_payload.py @@ -0,0 +1,66 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest +import datetime + +from eZmaxApi.models.inscription_get_attachments_v1_response_m_payload import InscriptionGetAttachmentsV1ResponseMPayload + +class TestInscriptionGetAttachmentsV1ResponseMPayload(unittest.TestCase): + """InscriptionGetAttachmentsV1ResponseMPayload unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> InscriptionGetAttachmentsV1ResponseMPayload: + """Test InscriptionGetAttachmentsV1ResponseMPayload + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `InscriptionGetAttachmentsV1ResponseMPayload` + """ + model = InscriptionGetAttachmentsV1ResponseMPayload() + if include_optional: + return InscriptionGetAttachmentsV1ResponseMPayload( + a_obj_attachmentdocumenttype = [ + eZmaxApi.models.custom_attachmentdocumenttype_response.Custom-Attachmentdocumenttype-Response( + e_attachment_documenttype = 'Adjustment', + a_obj_attachment = [ + eZmaxApi.models.custom_attachment_response.Custom-Attachment-Response() + ], ) + ] + ) + else: + return InscriptionGetAttachmentsV1ResponseMPayload( + a_obj_attachmentdocumenttype = [ + eZmaxApi.models.custom_attachmentdocumenttype_response.Custom-Attachmentdocumenttype-Response( + e_attachment_documenttype = 'Adjustment', + a_obj_attachment = [ + eZmaxApi.models.custom_attachment_response.Custom-Attachment-Response() + ], ) + ], + ) + """ + + def testInscriptionGetAttachmentsV1ResponseMPayload(self): + """Test InscriptionGetAttachmentsV1ResponseMPayload""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inscription_get_communication_list_v1_response.py b/test/test_inscription_get_communication_list_v1_response.py index bca85be64..9bc828f8c 100644 --- a/test/test_inscription_get_communication_list_v1_response.py +++ b/test/test_inscription_get_communication_list_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.inscription_get_communication_list_v1_response import InscriptionGetCommunicationListV1Response # noqa: E501 +from eZmaxApi.models.inscription_get_communication_list_v1_response import InscriptionGetCommunicationListV1Response class TestInscriptionGetCommunicationListV1Response(unittest.TestCase): """InscriptionGetCommunicationListV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> InscriptionGetCommunicationListV1Re optional params are included """ # uncomment below to create an instance of `InscriptionGetCommunicationListV1Response` """ - model = InscriptionGetCommunicationListV1Response() # noqa: E501 + model = InscriptionGetCommunicationListV1Response() if include_optional: return InscriptionGetCommunicationListV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload_get_list.Common-Response-objDebugPayload_getList(), diff --git a/test/test_inscription_get_communication_list_v1_response_m_payload.py b/test/test_inscription_get_communication_list_v1_response_m_payload.py index f575f9335..aee8f0bb3 100644 --- a/test/test_inscription_get_communication_list_v1_response_m_payload.py +++ b/test/test_inscription_get_communication_list_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.inscription_get_communication_list_v1_response_m_payload import InscriptionGetCommunicationListV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.inscription_get_communication_list_v1_response_m_payload import InscriptionGetCommunicationListV1ResponseMPayload class TestInscriptionGetCommunicationListV1ResponseMPayload(unittest.TestCase): """InscriptionGetCommunicationListV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> InscriptionGetCommunicationListV1Re optional params are included """ # uncomment below to create an instance of `InscriptionGetCommunicationListV1ResponseMPayload` """ - model = InscriptionGetCommunicationListV1ResponseMPayload() # noqa: E501 + model = InscriptionGetCommunicationListV1ResponseMPayload() if include_optional: return InscriptionGetCommunicationListV1ResponseMPayload( a_obj_communication = [ diff --git a/test/test_inscription_get_communicationsenders_v1_response.py b/test/test_inscription_get_communicationsenders_v1_response.py new file mode 100644 index 000000000..fcf7b8e89 --- /dev/null +++ b/test/test_inscription_get_communicationsenders_v1_response.py @@ -0,0 +1,101 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest +import datetime + +from eZmaxApi.models.inscription_get_communicationsenders_v1_response import InscriptionGetCommunicationsendersV1Response + +class TestInscriptionGetCommunicationsendersV1Response(unittest.TestCase): + """InscriptionGetCommunicationsendersV1Response unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> InscriptionGetCommunicationsendersV1Response: + """Test InscriptionGetCommunicationsendersV1Response + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `InscriptionGetCommunicationsendersV1Response` + """ + model = InscriptionGetCommunicationsendersV1Response() + if include_optional: + return InscriptionGetCommunicationsendersV1Response( + obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( + i_version_min = 1, + i_version_max = 2, + a_required_permission = [ + 117 + ], + b_version_deprecated = False, ), + obj_debug = {"sMemoryUsage":"11,923MB","sRunTime":"0.6084s","iSQLSelects":3,"iSQLQueries":6,"a_objSQLQuery":[{"sQuery":"SELECT * FROM table","fDuration":1.0E-4},{"sQuery":"SELECT * FROM table","fDuration":1.0E-4}]}, + m_payload = eZmaxApi.models.inscription_get_communicationsenders_v1_response_m_payload.inscription-getCommunicationsenders-v1-Response-mPayload( + a_obj_communicationsenders = [ + eZmaxApi.models.custom_communicationsender_response.Custom-Communicationsender-Response( + fki_agent_id = 1, + fki_broker_id = 26, + fki_user_id = 70, + fki_mailboxshared_id = 47, + fki_phonelineshared_id = 47, + e_communicationsender_objecttype = 'User', + obj_contact_name = eZmaxApi.models.custom_contact_name_response.Custom-ContactName-Response( + s_contact_firstname = 'John', + s_contact_lastname = 'Doe', + s_contact_company = 'eZmax Solutions Inc.', ), + obj_email = eZmaxApi.models.email_response_compound.email-ResponseCompound(), + obj_phone_fax = eZmaxApi.models.phone_response_compound.phone-ResponseCompound(), + obj_phone_sms = eZmaxApi.models.phone_response_compound.phone-ResponseCompound(), ) + ], ) + ) + else: + return InscriptionGetCommunicationsendersV1Response( + obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( + i_version_min = 1, + i_version_max = 2, + a_required_permission = [ + 117 + ], + b_version_deprecated = False, ), + m_payload = eZmaxApi.models.inscription_get_communicationsenders_v1_response_m_payload.inscription-getCommunicationsenders-v1-Response-mPayload( + a_obj_communicationsenders = [ + eZmaxApi.models.custom_communicationsender_response.Custom-Communicationsender-Response( + fki_agent_id = 1, + fki_broker_id = 26, + fki_user_id = 70, + fki_mailboxshared_id = 47, + fki_phonelineshared_id = 47, + e_communicationsender_objecttype = 'User', + obj_contact_name = eZmaxApi.models.custom_contact_name_response.Custom-ContactName-Response( + s_contact_firstname = 'John', + s_contact_lastname = 'Doe', + s_contact_company = 'eZmax Solutions Inc.', ), + obj_email = eZmaxApi.models.email_response_compound.email-ResponseCompound(), + obj_phone_fax = eZmaxApi.models.phone_response_compound.phone-ResponseCompound(), + obj_phone_sms = eZmaxApi.models.phone_response_compound.phone-ResponseCompound(), ) + ], ), + ) + """ + + def testInscriptionGetCommunicationsendersV1Response(self): + """Test InscriptionGetCommunicationsendersV1Response""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inscription_get_communicationsenders_v1_response_m_payload.py b/test/test_inscription_get_communicationsenders_v1_response_m_payload.py new file mode 100644 index 000000000..a052be884 --- /dev/null +++ b/test/test_inscription_get_communicationsenders_v1_response_m_payload.py @@ -0,0 +1,84 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest +import datetime + +from eZmaxApi.models.inscription_get_communicationsenders_v1_response_m_payload import InscriptionGetCommunicationsendersV1ResponseMPayload + +class TestInscriptionGetCommunicationsendersV1ResponseMPayload(unittest.TestCase): + """InscriptionGetCommunicationsendersV1ResponseMPayload unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> InscriptionGetCommunicationsendersV1ResponseMPayload: + """Test InscriptionGetCommunicationsendersV1ResponseMPayload + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `InscriptionGetCommunicationsendersV1ResponseMPayload` + """ + model = InscriptionGetCommunicationsendersV1ResponseMPayload() + if include_optional: + return InscriptionGetCommunicationsendersV1ResponseMPayload( + a_obj_communicationsenders = [ + eZmaxApi.models.custom_communicationsender_response.Custom-Communicationsender-Response( + fki_agent_id = 1, + fki_broker_id = 26, + fki_user_id = 70, + fki_mailboxshared_id = 47, + fki_phonelineshared_id = 47, + e_communicationsender_objecttype = 'User', + obj_contact_name = eZmaxApi.models.custom_contact_name_response.Custom-ContactName-Response( + s_contact_firstname = 'John', + s_contact_lastname = 'Doe', + s_contact_company = 'eZmax Solutions Inc.', ), + obj_email = eZmaxApi.models.email_response_compound.email-ResponseCompound(), + obj_phone_fax = eZmaxApi.models.phone_response_compound.phone-ResponseCompound(), + obj_phone_sms = eZmaxApi.models.phone_response_compound.phone-ResponseCompound(), ) + ] + ) + else: + return InscriptionGetCommunicationsendersV1ResponseMPayload( + a_obj_communicationsenders = [ + eZmaxApi.models.custom_communicationsender_response.Custom-Communicationsender-Response( + fki_agent_id = 1, + fki_broker_id = 26, + fki_user_id = 70, + fki_mailboxshared_id = 47, + fki_phonelineshared_id = 47, + e_communicationsender_objecttype = 'User', + obj_contact_name = eZmaxApi.models.custom_contact_name_response.Custom-ContactName-Response( + s_contact_firstname = 'John', + s_contact_lastname = 'Doe', + s_contact_company = 'eZmax Solutions Inc.', ), + obj_email = eZmaxApi.models.email_response_compound.email-ResponseCompound(), + obj_phone_fax = eZmaxApi.models.phone_response_compound.phone-ResponseCompound(), + obj_phone_sms = eZmaxApi.models.phone_response_compound.phone-ResponseCompound(), ) + ], + ) + """ + + def testInscriptionGetCommunicationsendersV1ResponseMPayload(self): + """Test InscriptionGetCommunicationsendersV1ResponseMPayload""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inscriptionnotauthenticated_get_communication_list_v1_response.py b/test/test_inscriptionnotauthenticated_get_communication_list_v1_response.py index 5c4331746..6709dbd6c 100644 --- a/test/test_inscriptionnotauthenticated_get_communication_list_v1_response.py +++ b/test/test_inscriptionnotauthenticated_get_communication_list_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.inscriptionnotauthenticated_get_communication_list_v1_response import InscriptionnotauthenticatedGetCommunicationListV1Response # noqa: E501 +from eZmaxApi.models.inscriptionnotauthenticated_get_communication_list_v1_response import InscriptionnotauthenticatedGetCommunicationListV1Response class TestInscriptionnotauthenticatedGetCommunicationListV1Response(unittest.TestCase): """InscriptionnotauthenticatedGetCommunicationListV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> InscriptionnotauthenticatedGetCommu optional params are included """ # uncomment below to create an instance of `InscriptionnotauthenticatedGetCommunicationListV1Response` """ - model = InscriptionnotauthenticatedGetCommunicationListV1Response() # noqa: E501 + model = InscriptionnotauthenticatedGetCommunicationListV1Response() if include_optional: return InscriptionnotauthenticatedGetCommunicationListV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload_get_list.Common-Response-objDebugPayload_getList(), diff --git a/test/test_inscriptionnotauthenticated_get_communication_list_v1_response_m_payload.py b/test/test_inscriptionnotauthenticated_get_communication_list_v1_response_m_payload.py index 7d44c9b86..4e8111ae1 100644 --- a/test/test_inscriptionnotauthenticated_get_communication_list_v1_response_m_payload.py +++ b/test/test_inscriptionnotauthenticated_get_communication_list_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.inscriptionnotauthenticated_get_communication_list_v1_response_m_payload import InscriptionnotauthenticatedGetCommunicationListV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.inscriptionnotauthenticated_get_communication_list_v1_response_m_payload import InscriptionnotauthenticatedGetCommunicationListV1ResponseMPayload class TestInscriptionnotauthenticatedGetCommunicationListV1ResponseMPayload(unittest.TestCase): """InscriptionnotauthenticatedGetCommunicationListV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> InscriptionnotauthenticatedGetCommu optional params are included """ # uncomment below to create an instance of `InscriptionnotauthenticatedGetCommunicationListV1ResponseMPayload` """ - model = InscriptionnotauthenticatedGetCommunicationListV1ResponseMPayload() # noqa: E501 + model = InscriptionnotauthenticatedGetCommunicationListV1ResponseMPayload() if include_optional: return InscriptionnotauthenticatedGetCommunicationListV1ResponseMPayload( a_obj_communication = [ diff --git a/test/test_inscriptiontemp_get_communication_list_v1_response.py b/test/test_inscriptiontemp_get_communication_list_v1_response.py index 158ca6613..9e54c9534 100644 --- a/test/test_inscriptiontemp_get_communication_list_v1_response.py +++ b/test/test_inscriptiontemp_get_communication_list_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.inscriptiontemp_get_communication_list_v1_response import InscriptiontempGetCommunicationListV1Response # noqa: E501 +from eZmaxApi.models.inscriptiontemp_get_communication_list_v1_response import InscriptiontempGetCommunicationListV1Response class TestInscriptiontempGetCommunicationListV1Response(unittest.TestCase): """InscriptiontempGetCommunicationListV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> InscriptiontempGetCommunicationList optional params are included """ # uncomment below to create an instance of `InscriptiontempGetCommunicationListV1Response` """ - model = InscriptiontempGetCommunicationListV1Response() # noqa: E501 + model = InscriptiontempGetCommunicationListV1Response() if include_optional: return InscriptiontempGetCommunicationListV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload_get_list.Common-Response-objDebugPayload_getList(), diff --git a/test/test_inscriptiontemp_get_communication_list_v1_response_m_payload.py b/test/test_inscriptiontemp_get_communication_list_v1_response_m_payload.py index c94c69783..d04231893 100644 --- a/test/test_inscriptiontemp_get_communication_list_v1_response_m_payload.py +++ b/test/test_inscriptiontemp_get_communication_list_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.inscriptiontemp_get_communication_list_v1_response_m_payload import InscriptiontempGetCommunicationListV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.inscriptiontemp_get_communication_list_v1_response_m_payload import InscriptiontempGetCommunicationListV1ResponseMPayload class TestInscriptiontempGetCommunicationListV1ResponseMPayload(unittest.TestCase): """InscriptiontempGetCommunicationListV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> InscriptiontempGetCommunicationList optional params are included """ # uncomment below to create an instance of `InscriptiontempGetCommunicationListV1ResponseMPayload` """ - model = InscriptiontempGetCommunicationListV1ResponseMPayload() # noqa: E501 + model = InscriptiontempGetCommunicationListV1ResponseMPayload() if include_optional: return InscriptiontempGetCommunicationListV1ResponseMPayload( a_obj_communication = [ diff --git a/test/test_invoice_get_attachments_v1_response.py b/test/test_invoice_get_attachments_v1_response.py new file mode 100644 index 000000000..1acf46513 --- /dev/null +++ b/test/test_invoice_get_attachments_v1_response.py @@ -0,0 +1,83 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest +import datetime + +from eZmaxApi.models.invoice_get_attachments_v1_response import InvoiceGetAttachmentsV1Response + +class TestInvoiceGetAttachmentsV1Response(unittest.TestCase): + """InvoiceGetAttachmentsV1Response unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> InvoiceGetAttachmentsV1Response: + """Test InvoiceGetAttachmentsV1Response + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `InvoiceGetAttachmentsV1Response` + """ + model = InvoiceGetAttachmentsV1Response() + if include_optional: + return InvoiceGetAttachmentsV1Response( + obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( + i_version_min = 1, + i_version_max = 2, + a_required_permission = [ + 117 + ], + b_version_deprecated = False, ), + obj_debug = {"sMemoryUsage":"11,923MB","sRunTime":"0.6084s","iSQLSelects":3,"iSQLQueries":6,"a_objSQLQuery":[{"sQuery":"SELECT * FROM table","fDuration":1.0E-4},{"sQuery":"SELECT * FROM table","fDuration":1.0E-4}]}, + m_payload = eZmaxApi.models.invoice_get_attachments_v1_response_m_payload.invoice-getAttachments-v1-Response-mPayload( + a_obj_attachmentdocumenttype = [ + eZmaxApi.models.custom_attachmentdocumenttype_response.Custom-Attachmentdocumenttype-Response( + e_attachment_documenttype = 'Adjustment', + a_obj_attachment = [ + eZmaxApi.models.custom_attachment_response.Custom-Attachment-Response() + ], ) + ], ) + ) + else: + return InvoiceGetAttachmentsV1Response( + obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( + i_version_min = 1, + i_version_max = 2, + a_required_permission = [ + 117 + ], + b_version_deprecated = False, ), + m_payload = eZmaxApi.models.invoice_get_attachments_v1_response_m_payload.invoice-getAttachments-v1-Response-mPayload( + a_obj_attachmentdocumenttype = [ + eZmaxApi.models.custom_attachmentdocumenttype_response.Custom-Attachmentdocumenttype-Response( + e_attachment_documenttype = 'Adjustment', + a_obj_attachment = [ + eZmaxApi.models.custom_attachment_response.Custom-Attachment-Response() + ], ) + ], ), + ) + """ + + def testInvoiceGetAttachmentsV1Response(self): + """Test InvoiceGetAttachmentsV1Response""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_invoice_get_attachments_v1_response_m_payload.py b/test/test_invoice_get_attachments_v1_response_m_payload.py new file mode 100644 index 000000000..76baa1450 --- /dev/null +++ b/test/test_invoice_get_attachments_v1_response_m_payload.py @@ -0,0 +1,66 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest +import datetime + +from eZmaxApi.models.invoice_get_attachments_v1_response_m_payload import InvoiceGetAttachmentsV1ResponseMPayload + +class TestInvoiceGetAttachmentsV1ResponseMPayload(unittest.TestCase): + """InvoiceGetAttachmentsV1ResponseMPayload unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> InvoiceGetAttachmentsV1ResponseMPayload: + """Test InvoiceGetAttachmentsV1ResponseMPayload + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `InvoiceGetAttachmentsV1ResponseMPayload` + """ + model = InvoiceGetAttachmentsV1ResponseMPayload() + if include_optional: + return InvoiceGetAttachmentsV1ResponseMPayload( + a_obj_attachmentdocumenttype = [ + eZmaxApi.models.custom_attachmentdocumenttype_response.Custom-Attachmentdocumenttype-Response( + e_attachment_documenttype = 'Adjustment', + a_obj_attachment = [ + eZmaxApi.models.custom_attachment_response.Custom-Attachment-Response() + ], ) + ] + ) + else: + return InvoiceGetAttachmentsV1ResponseMPayload( + a_obj_attachmentdocumenttype = [ + eZmaxApi.models.custom_attachmentdocumenttype_response.Custom-Attachmentdocumenttype-Response( + e_attachment_documenttype = 'Adjustment', + a_obj_attachment = [ + eZmaxApi.models.custom_attachment_response.Custom-Attachment-Response() + ], ) + ], + ) + """ + + def testInvoiceGetAttachmentsV1ResponseMPayload(self): + """Test InvoiceGetAttachmentsV1ResponseMPayload""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_invoice_get_communication_list_v1_response.py b/test/test_invoice_get_communication_list_v1_response.py index 805b9d79d..7f449d54b 100644 --- a/test/test_invoice_get_communication_list_v1_response.py +++ b/test/test_invoice_get_communication_list_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.invoice_get_communication_list_v1_response import InvoiceGetCommunicationListV1Response # noqa: E501 +from eZmaxApi.models.invoice_get_communication_list_v1_response import InvoiceGetCommunicationListV1Response class TestInvoiceGetCommunicationListV1Response(unittest.TestCase): """InvoiceGetCommunicationListV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> InvoiceGetCommunicationListV1Respon optional params are included """ # uncomment below to create an instance of `InvoiceGetCommunicationListV1Response` """ - model = InvoiceGetCommunicationListV1Response() # noqa: E501 + model = InvoiceGetCommunicationListV1Response() if include_optional: return InvoiceGetCommunicationListV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload_get_list.Common-Response-objDebugPayload_getList(), diff --git a/test/test_invoice_get_communication_list_v1_response_m_payload.py b/test/test_invoice_get_communication_list_v1_response_m_payload.py index 2c949986d..02230812d 100644 --- a/test/test_invoice_get_communication_list_v1_response_m_payload.py +++ b/test/test_invoice_get_communication_list_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.invoice_get_communication_list_v1_response_m_payload import InvoiceGetCommunicationListV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.invoice_get_communication_list_v1_response_m_payload import InvoiceGetCommunicationListV1ResponseMPayload class TestInvoiceGetCommunicationListV1ResponseMPayload(unittest.TestCase): """InvoiceGetCommunicationListV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> InvoiceGetCommunicationListV1Respon optional params are included """ # uncomment below to create an instance of `InvoiceGetCommunicationListV1ResponseMPayload` """ - model = InvoiceGetCommunicationListV1ResponseMPayload() # noqa: E501 + model = InvoiceGetCommunicationListV1ResponseMPayload() if include_optional: return InvoiceGetCommunicationListV1ResponseMPayload( a_obj_communication = [ diff --git a/test/test_language_autocomplete_element_response.py b/test/test_language_autocomplete_element_response.py index 16098587b..5c9c61bfb 100644 --- a/test/test_language_autocomplete_element_response.py +++ b/test/test_language_autocomplete_element_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.language_autocomplete_element_response import LanguageAutocompleteElementResponse # noqa: E501 +from eZmaxApi.models.language_autocomplete_element_response import LanguageAutocompleteElementResponse class TestLanguageAutocompleteElementResponse(unittest.TestCase): """LanguageAutocompleteElementResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> LanguageAutocompleteElementResponse optional params are included """ # uncomment below to create an instance of `LanguageAutocompleteElementResponse` """ - model = LanguageAutocompleteElementResponse() # noqa: E501 + model = LanguageAutocompleteElementResponse() if include_optional: return LanguageAutocompleteElementResponse( pki_language_id = 2, diff --git a/test/test_language_get_autocomplete_v2_response.py b/test/test_language_get_autocomplete_v2_response.py index 473b6294e..321684617 100644 --- a/test/test_language_get_autocomplete_v2_response.py +++ b/test/test_language_get_autocomplete_v2_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.language_get_autocomplete_v2_response import LanguageGetAutocompleteV2Response # noqa: E501 +from eZmaxApi.models.language_get_autocomplete_v2_response import LanguageGetAutocompleteV2Response class TestLanguageGetAutocompleteV2Response(unittest.TestCase): """LanguageGetAutocompleteV2Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> LanguageGetAutocompleteV2Response: optional params are included """ # uncomment below to create an instance of `LanguageGetAutocompleteV2Response` """ - model = LanguageGetAutocompleteV2Response() # noqa: E501 + model = LanguageGetAutocompleteV2Response() if include_optional: return LanguageGetAutocompleteV2Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_language_get_autocomplete_v2_response_m_payload.py b/test/test_language_get_autocomplete_v2_response_m_payload.py index 2fcd6a016..df0c34e9e 100644 --- a/test/test_language_get_autocomplete_v2_response_m_payload.py +++ b/test/test_language_get_autocomplete_v2_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.language_get_autocomplete_v2_response_m_payload import LanguageGetAutocompleteV2ResponseMPayload # noqa: E501 +from eZmaxApi.models.language_get_autocomplete_v2_response_m_payload import LanguageGetAutocompleteV2ResponseMPayload class TestLanguageGetAutocompleteV2ResponseMPayload(unittest.TestCase): """LanguageGetAutocompleteV2ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> LanguageGetAutocompleteV2ResponseMP optional params are included """ # uncomment below to create an instance of `LanguageGetAutocompleteV2ResponseMPayload` """ - model = LanguageGetAutocompleteV2ResponseMPayload() # noqa: E501 + model = LanguageGetAutocompleteV2ResponseMPayload() if include_optional: return LanguageGetAutocompleteV2ResponseMPayload( a_obj_language = [ diff --git a/test/test_module_ezsign_api.py b/test/test_module_ezsign_api.py index d3bdfbfda..dffb335e1 100644 --- a/test/test_module_ezsign_api.py +++ b/test/test_module_ezsign_api.py @@ -15,14 +15,14 @@ import unittest -from eZmaxApi.api.module_ezsign_api import ModuleEzsignApi # noqa: E501 +from eZmaxApi.api.module_ezsign_api import ModuleEzsignApi class TestModuleEzsignApi(unittest.TestCase): """ModuleEzsignApi unit test stubs""" def setUp(self) -> None: - self.api = ModuleEzsignApi() # noqa: E501 + self.api = ModuleEzsignApi() def tearDown(self) -> None: pass @@ -30,14 +30,14 @@ def tearDown(self) -> None: def test_ezsign_suggest_signers_v1(self) -> None: """Test case for ezsign_suggest_signers_v1 - Suggest signers # noqa: E501 + Suggest signers """ pass def test_ezsign_suggest_templates_v1(self) -> None: """Test case for ezsign_suggest_templates_v1 - Suggest templates # noqa: E501 + Suggest templates """ pass diff --git a/test/test_module_report_api.py b/test/test_module_report_api.py index 5e86d0773..331c3f60e 100644 --- a/test/test_module_report_api.py +++ b/test/test_module_report_api.py @@ -15,14 +15,14 @@ import unittest -from eZmaxApi.api.module_report_api import ModuleReportApi # noqa: E501 +from eZmaxApi.api.module_report_api import ModuleReportApi class TestModuleReportApi(unittest.TestCase): """ModuleReportApi unit test stubs""" def setUp(self) -> None: - self.api = ModuleReportApi() # noqa: E501 + self.api = ModuleReportApi() def tearDown(self) -> None: pass @@ -30,7 +30,7 @@ def tearDown(self) -> None: def test_report_get_report_from_cache_v1(self) -> None: """Test case for report_get_report_from_cache_v1 - Retrieve report from cache # noqa: E501 + Retrieve report from cache """ pass diff --git a/test/test_module_response.py b/test/test_module_response.py index 5fd8c2f53..7567617a4 100644 --- a/test/test_module_response.py +++ b/test/test_module_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.module_response import ModuleResponse # noqa: E501 +from eZmaxApi.models.module_response import ModuleResponse class TestModuleResponse(unittest.TestCase): """ModuleResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> ModuleResponse: optional params are included """ # uncomment below to create an instance of `ModuleResponse` """ - model = ModuleResponse() # noqa: E501 + model = ModuleResponse() if include_optional: return ModuleResponse( pki_module_id = 40, diff --git a/test/test_module_response_compound.py b/test/test_module_response_compound.py index 8ebbc32f0..003c769c0 100644 --- a/test/test_module_response_compound.py +++ b/test/test_module_response_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.module_response_compound import ModuleResponseCompound # noqa: E501 +from eZmaxApi.models.module_response_compound import ModuleResponseCompound class TestModuleResponseCompound(unittest.TestCase): """ModuleResponseCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> ModuleResponseCompound: optional params are included """ # uncomment below to create an instance of `ModuleResponseCompound` """ - model = ModuleResponseCompound() # noqa: E501 + model = ModuleResponseCompound() if include_optional: return ModuleResponseCompound( pki_module_id = 40, diff --git a/test/test_module_user_api.py b/test/test_module_user_api.py index ebcd52678..03b222fd0 100644 --- a/test/test_module_user_api.py +++ b/test/test_module_user_api.py @@ -15,14 +15,14 @@ import unittest -from eZmaxApi.api.module_user_api import ModuleUserApi # noqa: E501 +from eZmaxApi.api.module_user_api import ModuleUserApi class TestModuleUserApi(unittest.TestCase): """ModuleUserApi unit test stubs""" def setUp(self) -> None: - self.api = ModuleUserApi() # noqa: E501 + self.api = ModuleUserApi() def tearDown(self) -> None: pass @@ -30,7 +30,7 @@ def tearDown(self) -> None: def test_user_create_ezsignuser_v1(self) -> None: """Test case for user_create_ezsignuser_v1 - Create a new User of type Ezsignuser # noqa: E501 + Create a new User of type Ezsignuser """ pass diff --git a/test/test_modulegroup_get_all_v1_response.py b/test/test_modulegroup_get_all_v1_response.py index 7f595d95c..e22966053 100644 --- a/test/test_modulegroup_get_all_v1_response.py +++ b/test/test_modulegroup_get_all_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.modulegroup_get_all_v1_response import ModulegroupGetAllV1Response # noqa: E501 +from eZmaxApi.models.modulegroup_get_all_v1_response import ModulegroupGetAllV1Response class TestModulegroupGetAllV1Response(unittest.TestCase): """ModulegroupGetAllV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> ModulegroupGetAllV1Response: optional params are included """ # uncomment below to create an instance of `ModulegroupGetAllV1Response` """ - model = ModulegroupGetAllV1Response() # noqa: E501 + model = ModulegroupGetAllV1Response() if include_optional: return ModulegroupGetAllV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_modulegroup_get_all_v1_response_m_payload.py b/test/test_modulegroup_get_all_v1_response_m_payload.py index e04e0cddc..3c3202607 100644 --- a/test/test_modulegroup_get_all_v1_response_m_payload.py +++ b/test/test_modulegroup_get_all_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.modulegroup_get_all_v1_response_m_payload import ModulegroupGetAllV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.modulegroup_get_all_v1_response_m_payload import ModulegroupGetAllV1ResponseMPayload class TestModulegroupGetAllV1ResponseMPayload(unittest.TestCase): """ModulegroupGetAllV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> ModulegroupGetAllV1ResponseMPayload optional params are included """ # uncomment below to create an instance of `ModulegroupGetAllV1ResponseMPayload` """ - model = ModulegroupGetAllV1ResponseMPayload() # noqa: E501 + model = ModulegroupGetAllV1ResponseMPayload() if include_optional: return ModulegroupGetAllV1ResponseMPayload( a_obj_modulegroup = [ diff --git a/test/test_modulegroup_response.py b/test/test_modulegroup_response.py index 68becc331..f237e9f87 100644 --- a/test/test_modulegroup_response.py +++ b/test/test_modulegroup_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.modulegroup_response import ModulegroupResponse # noqa: E501 +from eZmaxApi.models.modulegroup_response import ModulegroupResponse class TestModulegroupResponse(unittest.TestCase): """ModulegroupResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> ModulegroupResponse: optional params are included """ # uncomment below to create an instance of `ModulegroupResponse` """ - model = ModulegroupResponse() # noqa: E501 + model = ModulegroupResponse() if include_optional: return ModulegroupResponse( pki_modulegroup_id = 46, diff --git a/test/test_modulegroup_response_compound.py b/test/test_modulegroup_response_compound.py index 68c116fde..6744d4beb 100644 --- a/test/test_modulegroup_response_compound.py +++ b/test/test_modulegroup_response_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.modulegroup_response_compound import ModulegroupResponseCompound # noqa: E501 +from eZmaxApi.models.modulegroup_response_compound import ModulegroupResponseCompound class TestModulegroupResponseCompound(unittest.TestCase): """ModulegroupResponseCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> ModulegroupResponseCompound: optional params are included """ # uncomment below to create an instance of `ModulegroupResponseCompound` """ - model = ModulegroupResponseCompound() # noqa: E501 + model = ModulegroupResponseCompound() if include_optional: return ModulegroupResponseCompound( pki_modulegroup_id = 46, diff --git a/test/test_modulesection_response.py b/test/test_modulesection_response.py index 709297491..a79624776 100644 --- a/test/test_modulesection_response.py +++ b/test/test_modulesection_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.modulesection_response import ModulesectionResponse # noqa: E501 +from eZmaxApi.models.modulesection_response import ModulesectionResponse class TestModulesectionResponse(unittest.TestCase): """ModulesectionResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> ModulesectionResponse: optional params are included """ # uncomment below to create an instance of `ModulesectionResponse` """ - model = ModulesectionResponse() # noqa: E501 + model = ModulesectionResponse() if include_optional: return ModulesectionResponse( pki_modulesection_id = 53, diff --git a/test/test_modulesection_response_compound.py b/test/test_modulesection_response_compound.py index 64890fdbc..29d38c3da 100644 --- a/test/test_modulesection_response_compound.py +++ b/test/test_modulesection_response_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.modulesection_response_compound import ModulesectionResponseCompound # noqa: E501 +from eZmaxApi.models.modulesection_response_compound import ModulesectionResponseCompound class TestModulesectionResponseCompound(unittest.TestCase): """ModulesectionResponseCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> ModulesectionResponseCompound: optional params are included """ # uncomment below to create an instance of `ModulesectionResponseCompound` """ - model = ModulesectionResponseCompound() # noqa: E501 + model = ModulesectionResponseCompound() if include_optional: return ModulesectionResponseCompound( pki_modulesection_id = 53, diff --git a/test/test_multilingual_apikey_description.py b/test/test_multilingual_apikey_description.py index 40236e3fe..cc7435f5d 100644 --- a/test/test_multilingual_apikey_description.py +++ b/test/test_multilingual_apikey_description.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.multilingual_apikey_description import MultilingualApikeyDescription # noqa: E501 +from eZmaxApi.models.multilingual_apikey_description import MultilingualApikeyDescription class TestMultilingualApikeyDescription(unittest.TestCase): """MultilingualApikeyDescription unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> MultilingualApikeyDescription: optional params are included """ # uncomment below to create an instance of `MultilingualApikeyDescription` """ - model = MultilingualApikeyDescription() # noqa: E501 + model = MultilingualApikeyDescription() if include_optional: return MultilingualApikeyDescription( s_apikey_description1 = 'Projet X', diff --git a/test/test_multilingual_billingentityinternal_description.py b/test/test_multilingual_billingentityinternal_description.py index dc72ddd04..cd250c4f9 100644 --- a/test/test_multilingual_billingentityinternal_description.py +++ b/test/test_multilingual_billingentityinternal_description.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.multilingual_billingentityinternal_description import MultilingualBillingentityinternalDescription # noqa: E501 +from eZmaxApi.models.multilingual_billingentityinternal_description import MultilingualBillingentityinternalDescription class TestMultilingualBillingentityinternalDescription(unittest.TestCase): """MultilingualBillingentityinternalDescription unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> MultilingualBillingentityinternalDe optional params are included """ # uncomment below to create an instance of `MultilingualBillingentityinternalDescription` """ - model = MultilingualBillingentityinternalDescription() # noqa: E501 + model = MultilingualBillingentityinternalDescription() if include_optional: return MultilingualBillingentityinternalDescription( s_billingentityinternal_description1 = 'Défaut', diff --git a/test/test_multilingual_branding_description.py b/test/test_multilingual_branding_description.py index 8d61432f2..c88af60b9 100644 --- a/test/test_multilingual_branding_description.py +++ b/test/test_multilingual_branding_description.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.multilingual_branding_description import MultilingualBrandingDescription # noqa: E501 +from eZmaxApi.models.multilingual_branding_description import MultilingualBrandingDescription class TestMultilingualBrandingDescription(unittest.TestCase): """MultilingualBrandingDescription unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> MultilingualBrandingDescription: optional params are included """ # uncomment below to create an instance of `MultilingualBrandingDescription` """ - model = MultilingualBrandingDescription() # noqa: E501 + model = MultilingualBrandingDescription() if include_optional: return MultilingualBrandingDescription( s_branding_description1 = 'Compagnie X', diff --git a/test/test_multilingual_ezmaxinvoicingsummaryinternal_description.py b/test/test_multilingual_ezmaxinvoicingsummaryinternal_description.py index 37a4039c3..99d362b37 100644 --- a/test/test_multilingual_ezmaxinvoicingsummaryinternal_description.py +++ b/test/test_multilingual_ezmaxinvoicingsummaryinternal_description.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.multilingual_ezmaxinvoicingsummaryinternal_description import MultilingualEzmaxinvoicingsummaryinternalDescription # noqa: E501 +from eZmaxApi.models.multilingual_ezmaxinvoicingsummaryinternal_description import MultilingualEzmaxinvoicingsummaryinternalDescription class TestMultilingualEzmaxinvoicingsummaryinternalDescription(unittest.TestCase): """MultilingualEzmaxinvoicingsummaryinternalDescription unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> MultilingualEzmaxinvoicingsummaryin optional params are included """ # uncomment below to create an instance of `MultilingualEzmaxinvoicingsummaryinternalDescription` """ - model = MultilingualEzmaxinvoicingsummaryinternalDescription() # noqa: E501 + model = MultilingualEzmaxinvoicingsummaryinternalDescription() if include_optional: return MultilingualEzmaxinvoicingsummaryinternalDescription( s_ezmaxinvoicingsummaryinternal_description1 = 'Défaut', diff --git a/test/test_multilingual_ezsignfoldertype_name.py b/test/test_multilingual_ezsignfoldertype_name.py index ea901c613..aeddef215 100644 --- a/test/test_multilingual_ezsignfoldertype_name.py +++ b/test/test_multilingual_ezsignfoldertype_name.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.multilingual_ezsignfoldertype_name import MultilingualEzsignfoldertypeName # noqa: E501 +from eZmaxApi.models.multilingual_ezsignfoldertype_name import MultilingualEzsignfoldertypeName class TestMultilingualEzsignfoldertypeName(unittest.TestCase): """MultilingualEzsignfoldertypeName unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> MultilingualEzsignfoldertypeName: optional params are included """ # uncomment below to create an instance of `MultilingualEzsignfoldertypeName` """ - model = MultilingualEzsignfoldertypeName() # noqa: E501 + model = MultilingualEzsignfoldertypeName() if include_optional: return MultilingualEzsignfoldertypeName( s_ezsignfoldertype_name1 = 'Embauche', diff --git a/test/test_multilingual_ezsignsignergroup_description.py b/test/test_multilingual_ezsignsignergroup_description.py index 145bb9280..e8129b117 100644 --- a/test/test_multilingual_ezsignsignergroup_description.py +++ b/test/test_multilingual_ezsignsignergroup_description.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.multilingual_ezsignsignergroup_description import MultilingualEzsignsignergroupDescription # noqa: E501 +from eZmaxApi.models.multilingual_ezsignsignergroup_description import MultilingualEzsignsignergroupDescription class TestMultilingualEzsignsignergroupDescription(unittest.TestCase): """MultilingualEzsignsignergroupDescription unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> MultilingualEzsignsignergroupDescri optional params are included """ # uncomment below to create an instance of `MultilingualEzsignsignergroupDescription` """ - model = MultilingualEzsignsignergroupDescription() # noqa: E501 + model = MultilingualEzsignsignergroupDescription() if include_optional: return MultilingualEzsignsignergroupDescription( s_ezsignsignergroup_description1 = 'RH', diff --git a/test/test_multilingual_ezsignsigningreason_description.py b/test/test_multilingual_ezsignsigningreason_description.py new file mode 100644 index 000000000..9fd06892b --- /dev/null +++ b/test/test_multilingual_ezsignsigningreason_description.py @@ -0,0 +1,54 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest +import datetime + +from eZmaxApi.models.multilingual_ezsignsigningreason_description import MultilingualEzsignsigningreasonDescription + +class TestMultilingualEzsignsigningreasonDescription(unittest.TestCase): + """MultilingualEzsignsigningreasonDescription unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> MultilingualEzsignsigningreasonDescription: + """Test MultilingualEzsignsigningreasonDescription + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `MultilingualEzsignsigningreasonDescription` + """ + model = MultilingualEzsignsigningreasonDescription() + if include_optional: + return MultilingualEzsignsigningreasonDescription( + s_ezsignsigningreason_description1 = 'J'approuve ce document', + s_ezsignsigningreason_description2 = 'I approve this document' + ) + else: + return MultilingualEzsignsigningreasonDescription( + ) + """ + + def testMultilingualEzsignsigningreasonDescription(self): + """Test MultilingualEzsignsigningreasonDescription""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_multilingual_notificationsubsection_name.py b/test/test_multilingual_notificationsubsection_name.py index d9ca4e679..4b4b19fd0 100644 --- a/test/test_multilingual_notificationsubsection_name.py +++ b/test/test_multilingual_notificationsubsection_name.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.multilingual_notificationsubsection_name import MultilingualNotificationsubsectionName # noqa: E501 +from eZmaxApi.models.multilingual_notificationsubsection_name import MultilingualNotificationsubsectionName class TestMultilingualNotificationsubsectionName(unittest.TestCase): """MultilingualNotificationsubsectionName unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> MultilingualNotificationsubsectionN optional params are included """ # uncomment below to create an instance of `MultilingualNotificationsubsectionName` """ - model = MultilingualNotificationsubsectionName() # noqa: E501 + model = MultilingualNotificationsubsectionName() if include_optional: return MultilingualNotificationsubsectionName( s_notificationsubsection_name1 = 'Signature électronique', diff --git a/test/test_multilingual_notificationtest_name.py b/test/test_multilingual_notificationtest_name.py index 9d0a8750f..7967e21c3 100644 --- a/test/test_multilingual_notificationtest_name.py +++ b/test/test_multilingual_notificationtest_name.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.multilingual_notificationtest_name import MultilingualNotificationtestName # noqa: E501 +from eZmaxApi.models.multilingual_notificationtest_name import MultilingualNotificationtestName class TestMultilingualNotificationtestName(unittest.TestCase): """MultilingualNotificationtestName unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> MultilingualNotificationtestName: optional params are included """ # uncomment below to create an instance of `MultilingualNotificationtestName` """ - model = MultilingualNotificationtestName() # noqa: E501 + model = MultilingualNotificationtestName() if include_optional: return MultilingualNotificationtestName( s_notificationtest_name1 = 'Default', diff --git a/test/test_multilingual_paymentterm_description.py b/test/test_multilingual_paymentterm_description.py index d523672b7..077d08db3 100644 --- a/test/test_multilingual_paymentterm_description.py +++ b/test/test_multilingual_paymentterm_description.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.multilingual_paymentterm_description import MultilingualPaymenttermDescription # noqa: E501 +from eZmaxApi.models.multilingual_paymentterm_description import MultilingualPaymenttermDescription class TestMultilingualPaymenttermDescription(unittest.TestCase): """MultilingualPaymenttermDescription unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> MultilingualPaymenttermDescription: optional params are included """ # uncomment below to create an instance of `MultilingualPaymenttermDescription` """ - model = MultilingualPaymenttermDescription() # noqa: E501 + model = MultilingualPaymenttermDescription() if include_optional: return MultilingualPaymenttermDescription( s_paymentterm_description1 = 'Net 30 jours', diff --git a/test/test_multilingual_subnet_description.py b/test/test_multilingual_subnet_description.py index 381c162e1..8a54708f2 100644 --- a/test/test_multilingual_subnet_description.py +++ b/test/test_multilingual_subnet_description.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.multilingual_subnet_description import MultilingualSubnetDescription # noqa: E501 +from eZmaxApi.models.multilingual_subnet_description import MultilingualSubnetDescription class TestMultilingualSubnetDescription(unittest.TestCase): """MultilingualSubnetDescription unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> MultilingualSubnetDescription: optional params are included """ # uncomment below to create an instance of `MultilingualSubnetDescription` """ - model = MultilingualSubnetDescription() # noqa: E501 + model = MultilingualSubnetDescription() if include_optional: return MultilingualSubnetDescription( s_subnet_description1 = 'Bureau chef', diff --git a/test/test_multilingual_usergroup_name.py b/test/test_multilingual_usergroup_name.py index beb0da1bd..5b378db63 100644 --- a/test/test_multilingual_usergroup_name.py +++ b/test/test_multilingual_usergroup_name.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.multilingual_usergroup_name import MultilingualUsergroupName # noqa: E501 +from eZmaxApi.models.multilingual_usergroup_name import MultilingualUsergroupName class TestMultilingualUsergroupName(unittest.TestCase): """MultilingualUsergroupName unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> MultilingualUsergroupName: optional params are included """ # uncomment below to create an instance of `MultilingualUsergroupName` """ - model = MultilingualUsergroupName() # noqa: E501 + model = MultilingualUsergroupName() if include_optional: return MultilingualUsergroupName( s_usergroup_name1 = 'Direction', diff --git a/test/test_multilingual_variableexpense_description.py b/test/test_multilingual_variableexpense_description.py index 890a3d656..420551761 100644 --- a/test/test_multilingual_variableexpense_description.py +++ b/test/test_multilingual_variableexpense_description.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.multilingual_variableexpense_description import MultilingualVariableexpenseDescription # noqa: E501 +from eZmaxApi.models.multilingual_variableexpense_description import MultilingualVariableexpenseDescription class TestMultilingualVariableexpenseDescription(unittest.TestCase): """MultilingualVariableexpenseDescription unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> MultilingualVariableexpenseDescript optional params are included """ # uncomment below to create an instance of `MultilingualVariableexpenseDescription` """ - model = MultilingualVariableexpenseDescription() # noqa: E501 + model = MultilingualVariableexpenseDescription() if include_optional: return MultilingualVariableexpenseDescription( s_variableexpense_description1 = 'Équipements de bureau', diff --git a/test/test_multilingual_versionhistory_detail.py b/test/test_multilingual_versionhistory_detail.py index d65807f6e..295168fa4 100644 --- a/test/test_multilingual_versionhistory_detail.py +++ b/test/test_multilingual_versionhistory_detail.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.multilingual_versionhistory_detail import MultilingualVersionhistoryDetail # noqa: E501 +from eZmaxApi.models.multilingual_versionhistory_detail import MultilingualVersionhistoryDetail class TestMultilingualVersionhistoryDetail(unittest.TestCase): """MultilingualVersionhistoryDetail unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> MultilingualVersionhistoryDetail: optional params are included """ # uncomment below to create an instance of `MultilingualVersionhistoryDetail` """ - model = MultilingualVersionhistoryDetail() # noqa: E501 + model = MultilingualVersionhistoryDetail() if include_optional: return MultilingualVersionhistoryDetail( t_versionhistory_detail1 = 'Message important', diff --git a/test/test_notificationsection_get_notificationtests_v1_response.py b/test/test_notificationsection_get_notificationtests_v1_response.py index 6f3a9cd0c..26756a996 100644 --- a/test/test_notificationsection_get_notificationtests_v1_response.py +++ b/test/test_notificationsection_get_notificationtests_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.notificationsection_get_notificationtests_v1_response import NotificationsectionGetNotificationtestsV1Response # noqa: E501 +from eZmaxApi.models.notificationsection_get_notificationtests_v1_response import NotificationsectionGetNotificationtestsV1Response class TestNotificationsectionGetNotificationtestsV1Response(unittest.TestCase): """NotificationsectionGetNotificationtestsV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> NotificationsectionGetNotificationt optional params are included """ # uncomment below to create an instance of `NotificationsectionGetNotificationtestsV1Response` """ - model = NotificationsectionGetNotificationtestsV1Response() # noqa: E501 + model = NotificationsectionGetNotificationtestsV1Response() if include_optional: return NotificationsectionGetNotificationtestsV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_notificationsection_get_notificationtests_v1_response_m_payload.py b/test/test_notificationsection_get_notificationtests_v1_response_m_payload.py index e19e0c690..b06e4fa9b 100644 --- a/test/test_notificationsection_get_notificationtests_v1_response_m_payload.py +++ b/test/test_notificationsection_get_notificationtests_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.notificationsection_get_notificationtests_v1_response_m_payload import NotificationsectionGetNotificationtestsV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.notificationsection_get_notificationtests_v1_response_m_payload import NotificationsectionGetNotificationtestsV1ResponseMPayload class TestNotificationsectionGetNotificationtestsV1ResponseMPayload(unittest.TestCase): """NotificationsectionGetNotificationtestsV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> NotificationsectionGetNotificationt optional params are included """ # uncomment below to create an instance of `NotificationsectionGetNotificationtestsV1ResponseMPayload` """ - model = NotificationsectionGetNotificationtestsV1ResponseMPayload() # noqa: E501 + model = NotificationsectionGetNotificationtestsV1ResponseMPayload() if include_optional: return NotificationsectionGetNotificationtestsV1ResponseMPayload( a_obj_notificationsubsection = [ diff --git a/test/test_notificationsubsection_response.py b/test/test_notificationsubsection_response.py index 913248b08..77d7cecd6 100644 --- a/test/test_notificationsubsection_response.py +++ b/test/test_notificationsubsection_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.notificationsubsection_response import NotificationsubsectionResponse # noqa: E501 +from eZmaxApi.models.notificationsubsection_response import NotificationsubsectionResponse class TestNotificationsubsectionResponse(unittest.TestCase): """NotificationsubsectionResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> NotificationsubsectionResponse: optional params are included """ # uncomment below to create an instance of `NotificationsubsectionResponse` """ - model = NotificationsubsectionResponse() # noqa: E501 + model = NotificationsubsectionResponse() if include_optional: return NotificationsubsectionResponse( pki_notificationsubsection_id = 3, diff --git a/test/test_notificationtest_get_elements_v1_response.py b/test/test_notificationtest_get_elements_v1_response.py index 7390b529a..f01f65066 100644 --- a/test/test_notificationtest_get_elements_v1_response.py +++ b/test/test_notificationtest_get_elements_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.notificationtest_get_elements_v1_response import NotificationtestGetElementsV1Response # noqa: E501 +from eZmaxApi.models.notificationtest_get_elements_v1_response import NotificationtestGetElementsV1Response class TestNotificationtestGetElementsV1Response(unittest.TestCase): """NotificationtestGetElementsV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> NotificationtestGetElementsV1Respon optional params are included """ # uncomment below to create an instance of `NotificationtestGetElementsV1Response` """ - model = NotificationtestGetElementsV1Response() # noqa: E501 + model = NotificationtestGetElementsV1Response() if include_optional: return NotificationtestGetElementsV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_notificationtest_get_elements_v1_response_m_payload.py b/test/test_notificationtest_get_elements_v1_response_m_payload.py index 7285c4e15..9a6d10efe 100644 --- a/test/test_notificationtest_get_elements_v1_response_m_payload.py +++ b/test/test_notificationtest_get_elements_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.notificationtest_get_elements_v1_response_m_payload import NotificationtestGetElementsV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.notificationtest_get_elements_v1_response_m_payload import NotificationtestGetElementsV1ResponseMPayload class TestNotificationtestGetElementsV1ResponseMPayload(unittest.TestCase): """NotificationtestGetElementsV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> NotificationtestGetElementsV1Respon optional params are included """ # uncomment below to create an instance of `NotificationtestGetElementsV1ResponseMPayload` """ - model = NotificationtestGetElementsV1ResponseMPayload() # noqa: E501 + model = NotificationtestGetElementsV1ResponseMPayload() if include_optional: return NotificationtestGetElementsV1ResponseMPayload( pki_notificationtest_id = 14, diff --git a/test/test_notificationtest_response.py b/test/test_notificationtest_response.py index 883b9d4f6..5cd6f9bb8 100644 --- a/test/test_notificationtest_response.py +++ b/test/test_notificationtest_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.notificationtest_response import NotificationtestResponse # noqa: E501 +from eZmaxApi.models.notificationtest_response import NotificationtestResponse class TestNotificationtestResponse(unittest.TestCase): """NotificationtestResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> NotificationtestResponse: optional params are included """ # uncomment below to create an instance of `NotificationtestResponse` """ - model = NotificationtestResponse() # noqa: E501 + model = NotificationtestResponse() if include_optional: return NotificationtestResponse( pki_notificationtest_id = 14, diff --git a/test/test_object_activesession_api.py b/test/test_object_activesession_api.py index 205bf2017..6a6f94a16 100644 --- a/test/test_object_activesession_api.py +++ b/test/test_object_activesession_api.py @@ -15,14 +15,14 @@ import unittest -from eZmaxApi.api.object_activesession_api import ObjectActivesessionApi # noqa: E501 +from eZmaxApi.api.object_activesession_api import ObjectActivesessionApi class TestObjectActivesessionApi(unittest.TestCase): """ObjectActivesessionApi unit test stubs""" def setUp(self) -> None: - self.api = ObjectActivesessionApi() # noqa: E501 + self.api = ObjectActivesessionApi() def tearDown(self) -> None: pass @@ -30,14 +30,14 @@ def tearDown(self) -> None: def test_activesession_get_current_v1(self) -> None: """Test case for activesession_get_current_v1 - Get Current Activesession # noqa: E501 + Get Current Activesession """ pass def test_activesession_get_list_v1(self) -> None: """Test case for activesession_get_list_v1 - Retrieve Activesession list # noqa: E501 + Retrieve Activesession list """ pass diff --git a/test/test_object_apikey_api.py b/test/test_object_apikey_api.py index a01e56df5..523f603bd 100644 --- a/test/test_object_apikey_api.py +++ b/test/test_object_apikey_api.py @@ -15,14 +15,14 @@ import unittest -from eZmaxApi.api.object_apikey_api import ObjectApikeyApi # noqa: E501 +from eZmaxApi.api.object_apikey_api import ObjectApikeyApi class TestObjectApikeyApi(unittest.TestCase): """ObjectApikeyApi unit test stubs""" def setUp(self) -> None: - self.api = ObjectApikeyApi() # noqa: E501 + self.api = ObjectApikeyApi() def tearDown(self) -> None: pass @@ -30,63 +30,63 @@ def tearDown(self) -> None: def test_apikey_create_object_v2(self) -> None: """Test case for apikey_create_object_v2 - Create a new Apikey # noqa: E501 + Create a new Apikey """ pass def test_apikey_edit_object_v1(self) -> None: """Test case for apikey_edit_object_v1 - Edit an existing Apikey # noqa: E501 + Edit an existing Apikey """ pass def test_apikey_edit_permissions_v1(self) -> None: """Test case for apikey_edit_permissions_v1 - Edit multiple Permissions # noqa: E501 + Edit multiple Permissions """ pass def test_apikey_get_cors_v1(self) -> None: """Test case for apikey_get_cors_v1 - Retrieve an existing Apikey's cors # noqa: E501 + Retrieve an existing Apikey's cors """ pass def test_apikey_get_list_v1(self) -> None: """Test case for apikey_get_list_v1 - Retrieve Apikey list # noqa: E501 + Retrieve Apikey list """ pass def test_apikey_get_object_v2(self) -> None: """Test case for apikey_get_object_v2 - Retrieve an existing Apikey # noqa: E501 + Retrieve an existing Apikey """ pass def test_apikey_get_permissions_v1(self) -> None: """Test case for apikey_get_permissions_v1 - Retrieve an existing Apikey's Permissions # noqa: E501 + Retrieve an existing Apikey's Permissions """ pass def test_apikey_get_subnets_v1(self) -> None: """Test case for apikey_get_subnets_v1 - Retrieve an existing Apikey's subnets # noqa: E501 + Retrieve an existing Apikey's subnets """ pass def test_apikey_regenerate_v1(self) -> None: """Test case for apikey_regenerate_v1 - Regenerate the Apikey # noqa: E501 + Regenerate the Apikey """ pass diff --git a/test/test_object_attachment_api.py b/test/test_object_attachment_api.py index 45b6dbcc9..5b7309e68 100644 --- a/test/test_object_attachment_api.py +++ b/test/test_object_attachment_api.py @@ -15,14 +15,14 @@ import unittest -from eZmaxApi.api.object_attachment_api import ObjectAttachmentApi # noqa: E501 +from eZmaxApi.api.object_attachment_api import ObjectAttachmentApi class TestObjectAttachmentApi(unittest.TestCase): """ObjectAttachmentApi unit test stubs""" def setUp(self) -> None: - self.api = ObjectAttachmentApi() # noqa: E501 + self.api = ObjectAttachmentApi() def tearDown(self) -> None: pass @@ -30,7 +30,21 @@ def tearDown(self) -> None: def test_attachment_download_v1(self) -> None: """Test case for attachment_download_v1 - Retrieve the content # noqa: E501 + Retrieve the content + """ + pass + + def test_attachment_get_attachmentlogs_v1(self) -> None: + """Test case for attachment_get_attachmentlogs_v1 + + Retrieve the Attachmentlogs + """ + pass + + def test_attachment_get_download_url_v1(self) -> None: + """Test case for attachment_get_download_url_v1 + + Retrieve a URL to download attachments. """ pass diff --git a/test/test_object_billingentityexternal_api.py b/test/test_object_billingentityexternal_api.py index c7aff0106..c195e4b3d 100644 --- a/test/test_object_billingentityexternal_api.py +++ b/test/test_object_billingentityexternal_api.py @@ -15,14 +15,14 @@ import unittest -from eZmaxApi.api.object_billingentityexternal_api import ObjectBillingentityexternalApi # noqa: E501 +from eZmaxApi.api.object_billingentityexternal_api import ObjectBillingentityexternalApi class TestObjectBillingentityexternalApi(unittest.TestCase): """ObjectBillingentityexternalApi unit test stubs""" def setUp(self) -> None: - self.api = ObjectBillingentityexternalApi() # noqa: E501 + self.api = ObjectBillingentityexternalApi() def tearDown(self) -> None: pass @@ -30,7 +30,7 @@ def tearDown(self) -> None: def test_billingentityexternal_get_autocomplete_v2(self) -> None: """Test case for billingentityexternal_get_autocomplete_v2 - Retrieve Billingentityexternals and IDs # noqa: E501 + Retrieve Billingentityexternals and IDs """ pass diff --git a/test/test_object_billingentityinternal_api.py b/test/test_object_billingentityinternal_api.py index 9312e2f37..b4d7e7d40 100644 --- a/test/test_object_billingentityinternal_api.py +++ b/test/test_object_billingentityinternal_api.py @@ -15,14 +15,14 @@ import unittest -from eZmaxApi.api.object_billingentityinternal_api import ObjectBillingentityinternalApi # noqa: E501 +from eZmaxApi.api.object_billingentityinternal_api import ObjectBillingentityinternalApi class TestObjectBillingentityinternalApi(unittest.TestCase): """ObjectBillingentityinternalApi unit test stubs""" def setUp(self) -> None: - self.api = ObjectBillingentityinternalApi() # noqa: E501 + self.api = ObjectBillingentityinternalApi() def tearDown(self) -> None: pass @@ -30,35 +30,35 @@ def tearDown(self) -> None: def test_billingentityinternal_create_object_v1(self) -> None: """Test case for billingentityinternal_create_object_v1 - Create a new Billingentityinternal # noqa: E501 + Create a new Billingentityinternal """ pass def test_billingentityinternal_edit_object_v1(self) -> None: """Test case for billingentityinternal_edit_object_v1 - Edit an existing Billingentityinternal # noqa: E501 + Edit an existing Billingentityinternal """ pass def test_billingentityinternal_get_autocomplete_v2(self) -> None: """Test case for billingentityinternal_get_autocomplete_v2 - Retrieve Billingentityinternals and IDs # noqa: E501 + Retrieve Billingentityinternals and IDs """ pass def test_billingentityinternal_get_list_v1(self) -> None: """Test case for billingentityinternal_get_list_v1 - Retrieve Billingentityinternal list # noqa: E501 + Retrieve Billingentityinternal list """ pass def test_billingentityinternal_get_object_v2(self) -> None: """Test case for billingentityinternal_get_object_v2 - Retrieve an existing Billingentityinternal # noqa: E501 + Retrieve an existing Billingentityinternal """ pass diff --git a/test/test_object_branding_api.py b/test/test_object_branding_api.py index 2700f51d1..e7180845f 100644 --- a/test/test_object_branding_api.py +++ b/test/test_object_branding_api.py @@ -15,14 +15,14 @@ import unittest -from eZmaxApi.api.object_branding_api import ObjectBrandingApi # noqa: E501 +from eZmaxApi.api.object_branding_api import ObjectBrandingApi class TestObjectBrandingApi(unittest.TestCase): """ObjectBrandingApi unit test stubs""" def setUp(self) -> None: - self.api = ObjectBrandingApi() # noqa: E501 + self.api = ObjectBrandingApi() def tearDown(self) -> None: pass @@ -30,35 +30,35 @@ def tearDown(self) -> None: def test_branding_create_object_v1(self) -> None: """Test case for branding_create_object_v1 - Create a new Branding # noqa: E501 + Create a new Branding """ pass def test_branding_edit_object_v1(self) -> None: """Test case for branding_edit_object_v1 - Edit an existing Branding # noqa: E501 + Edit an existing Branding """ pass def test_branding_get_autocomplete_v2(self) -> None: """Test case for branding_get_autocomplete_v2 - Retrieve Brandings and IDs # noqa: E501 + Retrieve Brandings and IDs """ pass def test_branding_get_list_v1(self) -> None: """Test case for branding_get_list_v1 - Retrieve Branding list # noqa: E501 + Retrieve Branding list """ pass def test_branding_get_object_v2(self) -> None: """Test case for branding_get_object_v2 - Retrieve an existing Branding # noqa: E501 + Retrieve an existing Branding """ pass diff --git a/test/test_object_buyercontract_api.py b/test/test_object_buyercontract_api.py index c5e7a6cc4..3264ea1e4 100644 --- a/test/test_object_buyercontract_api.py +++ b/test/test_object_buyercontract_api.py @@ -15,14 +15,14 @@ import unittest -from eZmaxApi.api.object_buyercontract_api import ObjectBuyercontractApi # noqa: E501 +from eZmaxApi.api.object_buyercontract_api import ObjectBuyercontractApi class TestObjectBuyercontractApi(unittest.TestCase): """ObjectBuyercontractApi unit test stubs""" def setUp(self) -> None: - self.api = ObjectBuyercontractApi() # noqa: E501 + self.api = ObjectBuyercontractApi() def tearDown(self) -> None: pass @@ -30,7 +30,7 @@ def tearDown(self) -> None: def test_buyercontract_get_communication_list_v1(self) -> None: """Test case for buyercontract_get_communication_list_v1 - Retrieve Communication list # noqa: E501 + Retrieve Communication list """ pass diff --git a/test/test_object_clonehistory_api.py b/test/test_object_clonehistory_api.py index 373e1f816..ca50c0aef 100644 --- a/test/test_object_clonehistory_api.py +++ b/test/test_object_clonehistory_api.py @@ -15,14 +15,14 @@ import unittest -from eZmaxApi.api.object_clonehistory_api import ObjectClonehistoryApi # noqa: E501 +from eZmaxApi.api.object_clonehistory_api import ObjectClonehistoryApi class TestObjectClonehistoryApi(unittest.TestCase): """ObjectClonehistoryApi unit test stubs""" def setUp(self) -> None: - self.api = ObjectClonehistoryApi() # noqa: E501 + self.api = ObjectClonehistoryApi() def tearDown(self) -> None: pass @@ -30,7 +30,7 @@ def tearDown(self) -> None: def test_clonehistory_get_list_v1(self) -> None: """Test case for clonehistory_get_list_v1 - Retrieve Clonehistory list # noqa: E501 + Retrieve Clonehistory list """ pass diff --git a/test/test_object_communication_api.py b/test/test_object_communication_api.py index a8190ce2c..cfc5b8464 100644 --- a/test/test_object_communication_api.py +++ b/test/test_object_communication_api.py @@ -15,14 +15,14 @@ import unittest -from eZmaxApi.api.object_communication_api import ObjectCommunicationApi # noqa: E501 +from eZmaxApi.api.object_communication_api import ObjectCommunicationApi class TestObjectCommunicationApi(unittest.TestCase): """ObjectCommunicationApi unit test stubs""" def setUp(self) -> None: - self.api = ObjectCommunicationApi() # noqa: E501 + self.api = ObjectCommunicationApi() def tearDown(self) -> None: pass @@ -30,7 +30,7 @@ def tearDown(self) -> None: def test_communication_send_v1(self) -> None: """Test case for communication_send_v1 - Send a new Communication # noqa: E501 + Send a new Communication """ pass diff --git a/test/test_object_company_api.py b/test/test_object_company_api.py index 7c82a6e34..8bb877443 100644 --- a/test/test_object_company_api.py +++ b/test/test_object_company_api.py @@ -15,14 +15,14 @@ import unittest -from eZmaxApi.api.object_company_api import ObjectCompanyApi # noqa: E501 +from eZmaxApi.api.object_company_api import ObjectCompanyApi class TestObjectCompanyApi(unittest.TestCase): """ObjectCompanyApi unit test stubs""" def setUp(self) -> None: - self.api = ObjectCompanyApi() # noqa: E501 + self.api = ObjectCompanyApi() def tearDown(self) -> None: pass @@ -30,7 +30,7 @@ def tearDown(self) -> None: def test_company_get_autocomplete_v2(self) -> None: """Test case for company_get_autocomplete_v2 - Retrieve Companys and IDs # noqa: E501 + Retrieve Companys and IDs """ pass diff --git a/test/test_object_cors_api.py b/test/test_object_cors_api.py index 7a2fb36e6..03367acd3 100644 --- a/test/test_object_cors_api.py +++ b/test/test_object_cors_api.py @@ -15,14 +15,14 @@ import unittest -from eZmaxApi.api.object_cors_api import ObjectCorsApi # noqa: E501 +from eZmaxApi.api.object_cors_api import ObjectCorsApi class TestObjectCorsApi(unittest.TestCase): """ObjectCorsApi unit test stubs""" def setUp(self) -> None: - self.api = ObjectCorsApi() # noqa: E501 + self.api = ObjectCorsApi() def tearDown(self) -> None: pass @@ -30,28 +30,28 @@ def tearDown(self) -> None: def test_cors_create_object_v1(self) -> None: """Test case for cors_create_object_v1 - Create a new Cors # noqa: E501 + Create a new Cors """ pass def test_cors_delete_object_v1(self) -> None: """Test case for cors_delete_object_v1 - Delete an existing Cors # noqa: E501 + Delete an existing Cors """ pass def test_cors_edit_object_v1(self) -> None: """Test case for cors_edit_object_v1 - Edit an existing Cors # noqa: E501 + Edit an existing Cors """ pass def test_cors_get_object_v2(self) -> None: """Test case for cors_get_object_v2 - Retrieve an existing Cors # noqa: E501 + Retrieve an existing Cors """ pass diff --git a/test/test_object_department_api.py b/test/test_object_department_api.py index d60f11354..8b68857e6 100644 --- a/test/test_object_department_api.py +++ b/test/test_object_department_api.py @@ -15,14 +15,14 @@ import unittest -from eZmaxApi.api.object_department_api import ObjectDepartmentApi # noqa: E501 +from eZmaxApi.api.object_department_api import ObjectDepartmentApi class TestObjectDepartmentApi(unittest.TestCase): """ObjectDepartmentApi unit test stubs""" def setUp(self) -> None: - self.api = ObjectDepartmentApi() # noqa: E501 + self.api = ObjectDepartmentApi() def tearDown(self) -> None: pass @@ -30,7 +30,7 @@ def tearDown(self) -> None: def test_department_get_autocomplete_v2(self) -> None: """Test case for department_get_autocomplete_v2 - Retrieve Departments and IDs # noqa: E501 + Retrieve Departments and IDs """ pass diff --git a/test/test_object_electronicfundstransfer_api.py b/test/test_object_electronicfundstransfer_api.py index 53ac53e28..8c8ca43bd 100644 --- a/test/test_object_electronicfundstransfer_api.py +++ b/test/test_object_electronicfundstransfer_api.py @@ -15,22 +15,22 @@ import unittest -from eZmaxApi.api.object_electronicfundstransfer_api import ObjectElectronicfundstransferApi # noqa: E501 +from eZmaxApi.api.object_electronicfundstransfer_api import ObjectElectronicfundstransferApi class TestObjectElectronicfundstransferApi(unittest.TestCase): """ObjectElectronicfundstransferApi unit test stubs""" def setUp(self) -> None: - self.api = ObjectElectronicfundstransferApi() # noqa: E501 + self.api = ObjectElectronicfundstransferApi() def tearDown(self) -> None: pass - def test_eletronicfundstransfer_get_communication_list_v1(self) -> None: - """Test case for eletronicfundstransfer_get_communication_list_v1 + def test_electronicfundstransfer_get_communication_list_v1(self) -> None: + """Test case for electronicfundstransfer_get_communication_list_v1 - Retrieve Communication list # noqa: E501 + Retrieve Communication list """ pass diff --git a/test/test_object_emailtype_api.py b/test/test_object_emailtype_api.py index db525e8ef..f53233f0b 100644 --- a/test/test_object_emailtype_api.py +++ b/test/test_object_emailtype_api.py @@ -15,14 +15,14 @@ import unittest -from eZmaxApi.api.object_emailtype_api import ObjectEmailtypeApi # noqa: E501 +from eZmaxApi.api.object_emailtype_api import ObjectEmailtypeApi class TestObjectEmailtypeApi(unittest.TestCase): """ObjectEmailtypeApi unit test stubs""" def setUp(self) -> None: - self.api = ObjectEmailtypeApi() # noqa: E501 + self.api = ObjectEmailtypeApi() def tearDown(self) -> None: pass @@ -30,7 +30,7 @@ def tearDown(self) -> None: def test_emailtype_get_autocomplete_v2(self) -> None: """Test case for emailtype_get_autocomplete_v2 - Retrieve Emailtypes and IDs # noqa: E501 + Retrieve Emailtypes and IDs """ pass diff --git a/test/test_object_ezmaxinvoicing_api.py b/test/test_object_ezmaxinvoicing_api.py index 765daa7f8..9ec5106f9 100644 --- a/test/test_object_ezmaxinvoicing_api.py +++ b/test/test_object_ezmaxinvoicing_api.py @@ -15,14 +15,14 @@ import unittest -from eZmaxApi.api.object_ezmaxinvoicing_api import ObjectEzmaxinvoicingApi # noqa: E501 +from eZmaxApi.api.object_ezmaxinvoicing_api import ObjectEzmaxinvoicingApi class TestObjectEzmaxinvoicingApi(unittest.TestCase): """ObjectEzmaxinvoicingApi unit test stubs""" def setUp(self) -> None: - self.api = ObjectEzmaxinvoicingApi() # noqa: E501 + self.api = ObjectEzmaxinvoicingApi() def tearDown(self) -> None: pass @@ -30,28 +30,28 @@ def tearDown(self) -> None: def test_ezmaxinvoicing_get_autocomplete_v1(self) -> None: """Test case for ezmaxinvoicing_get_autocomplete_v1 - Retrieve Ezmaxinvoicings and IDs # noqa: E501 + Retrieve Ezmaxinvoicings and IDs """ pass def test_ezmaxinvoicing_get_autocomplete_v2(self) -> None: """Test case for ezmaxinvoicing_get_autocomplete_v2 - Retrieve Ezmaxinvoicings and IDs # noqa: E501 + Retrieve Ezmaxinvoicings and IDs """ pass def test_ezmaxinvoicing_get_object_v2(self) -> None: """Test case for ezmaxinvoicing_get_object_v2 - Retrieve an existing Ezmaxinvoicing # noqa: E501 + Retrieve an existing Ezmaxinvoicing """ pass def test_ezmaxinvoicing_get_provisional_v1(self) -> None: """Test case for ezmaxinvoicing_get_provisional_v1 - Retrieve provisional Ezmaxinvoicing # noqa: E501 + Retrieve provisional Ezmaxinvoicing """ pass diff --git a/test/test_object_ezmaxproduct_api.py b/test/test_object_ezmaxproduct_api.py index f16496217..154dd85a0 100644 --- a/test/test_object_ezmaxproduct_api.py +++ b/test/test_object_ezmaxproduct_api.py @@ -15,14 +15,14 @@ import unittest -from eZmaxApi.api.object_ezmaxproduct_api import ObjectEzmaxproductApi # noqa: E501 +from eZmaxApi.api.object_ezmaxproduct_api import ObjectEzmaxproductApi class TestObjectEzmaxproductApi(unittest.TestCase): """ObjectEzmaxproductApi unit test stubs""" def setUp(self) -> None: - self.api = ObjectEzmaxproductApi() # noqa: E501 + self.api = ObjectEzmaxproductApi() def tearDown(self) -> None: pass @@ -30,7 +30,7 @@ def tearDown(self) -> None: def test_ezmaxproduct_get_autocomplete_v2(self) -> None: """Test case for ezmaxproduct_get_autocomplete_v2 - Retrieve Ezmaxproducts and IDs # noqa: E501 + Retrieve Ezmaxproducts and IDs """ pass diff --git a/test/test_object_ezsignbulksend_api.py b/test/test_object_ezsignbulksend_api.py index 24aa15d65..dff7fc554 100644 --- a/test/test_object_ezsignbulksend_api.py +++ b/test/test_object_ezsignbulksend_api.py @@ -15,14 +15,14 @@ import unittest -from eZmaxApi.api.object_ezsignbulksend_api import ObjectEzsignbulksendApi # noqa: E501 +from eZmaxApi.api.object_ezsignbulksend_api import ObjectEzsignbulksendApi class TestObjectEzsignbulksendApi(unittest.TestCase): """ObjectEzsignbulksendApi unit test stubs""" def setUp(self) -> None: - self.api = ObjectEzsignbulksendApi() # noqa: E501 + self.api = ObjectEzsignbulksendApi() def tearDown(self) -> None: pass @@ -30,77 +30,77 @@ def tearDown(self) -> None: def test_ezsignbulksend_create_ezsignbulksendtransmission_v1(self) -> None: """Test case for ezsignbulksend_create_ezsignbulksendtransmission_v1 - Create a new Ezsignbulksendtransmission in the Ezsignbulksend # noqa: E501 + Create a new Ezsignbulksendtransmission in the Ezsignbulksend """ pass def test_ezsignbulksend_create_object_v1(self) -> None: """Test case for ezsignbulksend_create_object_v1 - Create a new Ezsignbulksend # noqa: E501 + Create a new Ezsignbulksend """ pass def test_ezsignbulksend_delete_object_v1(self) -> None: """Test case for ezsignbulksend_delete_object_v1 - Delete an existing Ezsignbulksend # noqa: E501 + Delete an existing Ezsignbulksend """ pass def test_ezsignbulksend_edit_object_v1(self) -> None: """Test case for ezsignbulksend_edit_object_v1 - Edit an existing Ezsignbulksend # noqa: E501 + Edit an existing Ezsignbulksend """ pass def test_ezsignbulksend_get_csv_template_v1(self) -> None: """Test case for ezsignbulksend_get_csv_template_v1 - Retrieve an existing Ezsignbulksend's empty Csv template # noqa: E501 + Retrieve an existing Ezsignbulksend's empty Csv template """ pass def test_ezsignbulksend_get_ezsignbulksendtransmissions_v1(self) -> None: """Test case for ezsignbulksend_get_ezsignbulksendtransmissions_v1 - Retrieve an existing Ezsignbulksend's Ezsignbulksendtransmissions # noqa: E501 + Retrieve an existing Ezsignbulksend's Ezsignbulksendtransmissions """ pass def test_ezsignbulksend_get_ezsignsignatures_automatic_v1(self) -> None: """Test case for ezsignbulksend_get_ezsignsignatures_automatic_v1 - Retrieve an existing Ezsignbulksend's automatic Ezsignsignatures # noqa: E501 + Retrieve an existing Ezsignbulksend's automatic Ezsignsignatures """ pass def test_ezsignbulksend_get_forms_data_v1(self) -> None: """Test case for ezsignbulksend_get_forms_data_v1 - Retrieve an existing Ezsignbulksend's forms data # noqa: E501 + Retrieve an existing Ezsignbulksend's forms data """ pass def test_ezsignbulksend_get_list_v1(self) -> None: """Test case for ezsignbulksend_get_list_v1 - Retrieve Ezsignbulksend list # noqa: E501 + Retrieve Ezsignbulksend list """ pass def test_ezsignbulksend_get_object_v2(self) -> None: """Test case for ezsignbulksend_get_object_v2 - Retrieve an existing Ezsignbulksend # noqa: E501 + Retrieve an existing Ezsignbulksend """ pass def test_ezsignbulksend_reorder_v1(self) -> None: """Test case for ezsignbulksend_reorder_v1 - Reorder Ezsignbulksenddocumentmappings in the Ezsignbulksend # noqa: E501 + Reorder Ezsignbulksenddocumentmappings in the Ezsignbulksend """ pass diff --git a/test/test_object_ezsignbulksenddocumentmapping_api.py b/test/test_object_ezsignbulksenddocumentmapping_api.py index 192b94195..16a8e8872 100644 --- a/test/test_object_ezsignbulksenddocumentmapping_api.py +++ b/test/test_object_ezsignbulksenddocumentmapping_api.py @@ -15,14 +15,14 @@ import unittest -from eZmaxApi.api.object_ezsignbulksenddocumentmapping_api import ObjectEzsignbulksenddocumentmappingApi # noqa: E501 +from eZmaxApi.api.object_ezsignbulksenddocumentmapping_api import ObjectEzsignbulksenddocumentmappingApi class TestObjectEzsignbulksenddocumentmappingApi(unittest.TestCase): """ObjectEzsignbulksenddocumentmappingApi unit test stubs""" def setUp(self) -> None: - self.api = ObjectEzsignbulksenddocumentmappingApi() # noqa: E501 + self.api = ObjectEzsignbulksenddocumentmappingApi() def tearDown(self) -> None: pass @@ -30,21 +30,21 @@ def tearDown(self) -> None: def test_ezsignbulksenddocumentmapping_create_object_v1(self) -> None: """Test case for ezsignbulksenddocumentmapping_create_object_v1 - Create a new Ezsignbulksenddocumentmapping # noqa: E501 + Create a new Ezsignbulksenddocumentmapping """ pass def test_ezsignbulksenddocumentmapping_delete_object_v1(self) -> None: """Test case for ezsignbulksenddocumentmapping_delete_object_v1 - Delete an existing Ezsignbulksenddocumentmapping # noqa: E501 + Delete an existing Ezsignbulksenddocumentmapping """ pass def test_ezsignbulksenddocumentmapping_get_object_v2(self) -> None: """Test case for ezsignbulksenddocumentmapping_get_object_v2 - Retrieve an existing Ezsignbulksenddocumentmapping # noqa: E501 + Retrieve an existing Ezsignbulksenddocumentmapping """ pass diff --git a/test/test_object_ezsignbulksendsignermapping_api.py b/test/test_object_ezsignbulksendsignermapping_api.py index 887c0298a..7d8346ce3 100644 --- a/test/test_object_ezsignbulksendsignermapping_api.py +++ b/test/test_object_ezsignbulksendsignermapping_api.py @@ -15,14 +15,14 @@ import unittest -from eZmaxApi.api.object_ezsignbulksendsignermapping_api import ObjectEzsignbulksendsignermappingApi # noqa: E501 +from eZmaxApi.api.object_ezsignbulksendsignermapping_api import ObjectEzsignbulksendsignermappingApi class TestObjectEzsignbulksendsignermappingApi(unittest.TestCase): """ObjectEzsignbulksendsignermappingApi unit test stubs""" def setUp(self) -> None: - self.api = ObjectEzsignbulksendsignermappingApi() # noqa: E501 + self.api = ObjectEzsignbulksendsignermappingApi() def tearDown(self) -> None: pass @@ -30,21 +30,21 @@ def tearDown(self) -> None: def test_ezsignbulksendsignermapping_create_object_v1(self) -> None: """Test case for ezsignbulksendsignermapping_create_object_v1 - Create a new Ezsignbulksendsignermapping # noqa: E501 + Create a new Ezsignbulksendsignermapping """ pass def test_ezsignbulksendsignermapping_delete_object_v1(self) -> None: """Test case for ezsignbulksendsignermapping_delete_object_v1 - Delete an existing Ezsignbulksendsignermapping # noqa: E501 + Delete an existing Ezsignbulksendsignermapping """ pass def test_ezsignbulksendsignermapping_get_object_v2(self) -> None: """Test case for ezsignbulksendsignermapping_get_object_v2 - Retrieve an existing Ezsignbulksendsignermapping # noqa: E501 + Retrieve an existing Ezsignbulksendsignermapping """ pass diff --git a/test/test_object_ezsignbulksendtransmission_api.py b/test/test_object_ezsignbulksendtransmission_api.py index ede33ead6..f225f918e 100644 --- a/test/test_object_ezsignbulksendtransmission_api.py +++ b/test/test_object_ezsignbulksendtransmission_api.py @@ -15,14 +15,14 @@ import unittest -from eZmaxApi.api.object_ezsignbulksendtransmission_api import ObjectEzsignbulksendtransmissionApi # noqa: E501 +from eZmaxApi.api.object_ezsignbulksendtransmission_api import ObjectEzsignbulksendtransmissionApi class TestObjectEzsignbulksendtransmissionApi(unittest.TestCase): """ObjectEzsignbulksendtransmissionApi unit test stubs""" def setUp(self) -> None: - self.api = ObjectEzsignbulksendtransmissionApi() # noqa: E501 + self.api = ObjectEzsignbulksendtransmissionApi() def tearDown(self) -> None: pass @@ -30,28 +30,28 @@ def tearDown(self) -> None: def test_ezsignbulksendtransmission_get_csv_errors_v1(self) -> None: """Test case for ezsignbulksendtransmission_get_csv_errors_v1 - Retrieve an existing Ezsignbulksendtransmission's Csv containing errors # noqa: E501 + Retrieve an existing Ezsignbulksendtransmission's Csv containing errors """ pass def test_ezsignbulksendtransmission_get_ezsignsignatures_automatic_v1(self) -> None: """Test case for ezsignbulksendtransmission_get_ezsignsignatures_automatic_v1 - Retrieve an existing Ezsignbulksendtransmission's automatic Ezsignsignatures # noqa: E501 + Retrieve an existing Ezsignbulksendtransmission's automatic Ezsignsignatures """ pass def test_ezsignbulksendtransmission_get_forms_data_v1(self) -> None: """Test case for ezsignbulksendtransmission_get_forms_data_v1 - Retrieve an existing Ezsignbulksendtransmission's forms data # noqa: E501 + Retrieve an existing Ezsignbulksendtransmission's forms data """ pass def test_ezsignbulksendtransmission_get_object_v2(self) -> None: """Test case for ezsignbulksendtransmission_get_object_v2 - Retrieve an existing Ezsignbulksendtransmission # noqa: E501 + Retrieve an existing Ezsignbulksendtransmission """ pass diff --git a/test/test_object_ezsigndocument_api.py b/test/test_object_ezsigndocument_api.py index e82878970..80f77702c 100644 --- a/test/test_object_ezsigndocument_api.py +++ b/test/test_object_ezsigndocument_api.py @@ -15,14 +15,14 @@ import unittest -from eZmaxApi.api.object_ezsigndocument_api import ObjectEzsigndocumentApi # noqa: E501 +from eZmaxApi.api.object_ezsigndocument_api import ObjectEzsigndocumentApi class TestObjectEzsigndocumentApi(unittest.TestCase): """ObjectEzsigndocumentApi unit test stubs""" def setUp(self) -> None: - self.api = ObjectEzsigndocumentApi() # noqa: E501 + self.api = ObjectEzsigndocumentApi() def tearDown(self) -> None: pass @@ -30,182 +30,189 @@ def tearDown(self) -> None: def test_ezsigndocument_apply_ezsigntemplate_v1(self) -> None: """Test case for ezsigndocument_apply_ezsigntemplate_v1 - Apply an Ezsigntemplate to the Ezsigndocument. # noqa: E501 + Apply an Ezsigntemplate to the Ezsigndocument. """ pass def test_ezsigndocument_apply_ezsigntemplate_v2(self) -> None: """Test case for ezsigndocument_apply_ezsigntemplate_v2 - Apply an Ezsigntemplate to the Ezsigndocument. # noqa: E501 + Apply an Ezsigntemplate to the Ezsigndocument. """ pass def test_ezsigndocument_create_object_v1(self) -> None: """Test case for ezsigndocument_create_object_v1 - Create a new Ezsigndocument # noqa: E501 + Create a new Ezsigndocument """ pass def test_ezsigndocument_create_object_v2(self) -> None: """Test case for ezsigndocument_create_object_v2 - Create a new Ezsigndocument # noqa: E501 + Create a new Ezsigndocument """ pass def test_ezsigndocument_decline_to_sign_v1(self) -> None: """Test case for ezsigndocument_decline_to_sign_v1 - Decline to sign # noqa: E501 + Decline to sign """ pass def test_ezsigndocument_delete_object_v1(self) -> None: """Test case for ezsigndocument_delete_object_v1 - Delete an existing Ezsigndocument # noqa: E501 + Delete an existing Ezsigndocument """ pass def test_ezsigndocument_edit_ezsignformfieldgroups_v1(self) -> None: """Test case for ezsigndocument_edit_ezsignformfieldgroups_v1 - Edit multiple Ezsignformfieldgroups # noqa: E501 + Edit multiple Ezsignformfieldgroups """ pass def test_ezsigndocument_edit_ezsignsignatures_v1(self) -> None: """Test case for ezsigndocument_edit_ezsignsignatures_v1 - Edit multiple Ezsignsignatures # noqa: E501 + Edit multiple Ezsignsignatures """ pass def test_ezsigndocument_end_prematurely_v1(self) -> None: """Test case for ezsigndocument_end_prematurely_v1 - End prematurely # noqa: E501 + End prematurely """ pass def test_ezsigndocument_flatten_v1(self) -> None: """Test case for ezsigndocument_flatten_v1 - Flatten # noqa: E501 + Flatten """ pass def test_ezsigndocument_get_actionable_elements_v1(self) -> None: """Test case for ezsigndocument_get_actionable_elements_v1 - Retrieve actionable elements for the Ezsigndocument # noqa: E501 + Retrieve actionable elements for the Ezsigndocument + """ + pass + + def test_ezsigndocument_get_attachments_v1(self) -> None: + """Test case for ezsigndocument_get_attachments_v1 + + Retrieve Ezsigndocument's Attachments """ pass def test_ezsigndocument_get_completed_elements_v1(self) -> None: """Test case for ezsigndocument_get_completed_elements_v1 - Retrieve completed elements for the Ezsigndocument # noqa: E501 + Retrieve completed elements for the Ezsigndocument """ pass def test_ezsigndocument_get_download_url_v1(self) -> None: """Test case for ezsigndocument_get_download_url_v1 - Retrieve a URL to download documents. # noqa: E501 + Retrieve a URL to download documents. """ pass def test_ezsigndocument_get_ezsignannotations_v1(self) -> None: """Test case for ezsigndocument_get_ezsignannotations_v1 - Retrieve an existing Ezsigndocument's Ezsignannotations # noqa: E501 + Retrieve an existing Ezsigndocument's Ezsignannotations """ pass def test_ezsigndocument_get_ezsignformfieldgroups_v1(self) -> None: """Test case for ezsigndocument_get_ezsignformfieldgroups_v1 - Retrieve an existing Ezsigndocument's Ezsignformfieldgroups # noqa: E501 + Retrieve an existing Ezsigndocument's Ezsignformfieldgroups """ pass def test_ezsigndocument_get_ezsignpages_v1(self) -> None: """Test case for ezsigndocument_get_ezsignpages_v1 - Retrieve an existing Ezsigndocument's Ezsignpages # noqa: E501 + Retrieve an existing Ezsigndocument's Ezsignpages """ pass def test_ezsigndocument_get_ezsignsignatures_automatic_v1(self) -> None: """Test case for ezsigndocument_get_ezsignsignatures_automatic_v1 - Retrieve an existing Ezsigndocument's automatic Ezsignsignatures # noqa: E501 + Retrieve an existing Ezsigndocument's automatic Ezsignsignatures """ pass def test_ezsigndocument_get_ezsignsignatures_v1(self) -> None: """Test case for ezsigndocument_get_ezsignsignatures_v1 - Retrieve an existing Ezsigndocument's Ezsignsignatures # noqa: E501 + Retrieve an existing Ezsigndocument's Ezsignsignatures """ pass def test_ezsigndocument_get_form_data_v1(self) -> None: """Test case for ezsigndocument_get_form_data_v1 - Retrieve an existing Ezsigndocument's Form Data # noqa: E501 + Retrieve an existing Ezsigndocument's Form Data """ pass def test_ezsigndocument_get_object_v1(self) -> None: """Test case for ezsigndocument_get_object_v1 - Retrieve an existing Ezsigndocument # noqa: E501 + Retrieve an existing Ezsigndocument """ pass def test_ezsigndocument_get_object_v2(self) -> None: """Test case for ezsigndocument_get_object_v2 - Retrieve an existing Ezsigndocument # noqa: E501 + Retrieve an existing Ezsigndocument """ pass def test_ezsigndocument_get_temporary_proof_v1(self) -> None: """Test case for ezsigndocument_get_temporary_proof_v1 - Retrieve the temporary proof # noqa: E501 + Retrieve the temporary proof """ pass def test_ezsigndocument_get_words_positions_v1(self) -> None: """Test case for ezsigndocument_get_words_positions_v1 - Retrieve positions X,Y of given words from a Ezsigndocument # noqa: E501 + Retrieve positions X,Y of given words from a Ezsigndocument """ pass def test_ezsigndocument_patch_object_v1(self) -> None: """Test case for ezsigndocument_patch_object_v1 - Patch an existing Ezsigndocument # noqa: E501 + Patch an existing Ezsigndocument """ pass def test_ezsigndocument_submit_ezsignform_v1(self) -> None: """Test case for ezsigndocument_submit_ezsignform_v1 - Submit the Ezsignform # noqa: E501 + Submit the Ezsignform """ pass def test_ezsigndocument_unsend_v1(self) -> None: """Test case for ezsigndocument_unsend_v1 - Unsend the Ezsigndocument # noqa: E501 + Unsend the Ezsigndocument """ pass diff --git a/test/test_object_ezsignfolder_api.py b/test/test_object_ezsignfolder_api.py index 990220811..4affa09b3 100644 --- a/test/test_object_ezsignfolder_api.py +++ b/test/test_object_ezsignfolder_api.py @@ -15,14 +15,14 @@ import unittest -from eZmaxApi.api.object_ezsignfolder_api import ObjectEzsignfolderApi # noqa: E501 +from eZmaxApi.api.object_ezsignfolder_api import ObjectEzsignfolderApi class TestObjectEzsignfolderApi(unittest.TestCase): """ObjectEzsignfolderApi unit test stubs""" def setUp(self) -> None: - self.api = ObjectEzsignfolderApi() # noqa: E501 + self.api = ObjectEzsignfolderApi() def tearDown(self) -> None: pass @@ -30,189 +30,203 @@ def tearDown(self) -> None: def test_ezsignfolder_archive_v1(self) -> None: """Test case for ezsignfolder_archive_v1 - Archive the Ezsignfolder # noqa: E501 + Archive the Ezsignfolder """ pass def test_ezsignfolder_batch_download_v1(self) -> None: """Test case for ezsignfolder_batch_download_v1 - Download multiples files from an Ezsignfolder # noqa: E501 + Download multiples files from an Ezsignfolder """ pass def test_ezsignfolder_create_object_v1(self) -> None: """Test case for ezsignfolder_create_object_v1 - Create a new Ezsignfolder # noqa: E501 + Create a new Ezsignfolder """ pass def test_ezsignfolder_create_object_v2(self) -> None: """Test case for ezsignfolder_create_object_v2 - Create a new Ezsignfolder # noqa: E501 + Create a new Ezsignfolder """ pass def test_ezsignfolder_delete_object_v1(self) -> None: """Test case for ezsignfolder_delete_object_v1 - Delete an existing Ezsignfolder # noqa: E501 + Delete an existing Ezsignfolder """ pass def test_ezsignfolder_dispose_ezsignfolders_v1(self) -> None: """Test case for ezsignfolder_dispose_ezsignfolders_v1 - Dispose Ezsignfolders # noqa: E501 + Dispose Ezsignfolders """ pass def test_ezsignfolder_dispose_v1(self) -> None: """Test case for ezsignfolder_dispose_v1 - Dispose the Ezsignfolder # noqa: E501 + Dispose the Ezsignfolder """ pass def test_ezsignfolder_edit_object_v1(self) -> None: """Test case for ezsignfolder_edit_object_v1 - Edit an existing Ezsignfolder # noqa: E501 + Edit an existing Ezsignfolder """ pass def test_ezsignfolder_get_actionable_elements_v1(self) -> None: """Test case for ezsignfolder_get_actionable_elements_v1 - Retrieve actionable elements for the Ezsignfolder # noqa: E501 + Retrieve actionable elements for the Ezsignfolder + """ + pass + + def test_ezsignfolder_get_attachment_count_v1(self) -> None: + """Test case for ezsignfolder_get_attachment_count_v1 + + Retrieve Attachment count + """ + pass + + def test_ezsignfolder_get_attachments_v1(self) -> None: + """Test case for ezsignfolder_get_attachments_v1 + + Retrieve Ezsignfolder's Attachments """ pass def test_ezsignfolder_get_communication_count_v1(self) -> None: """Test case for ezsignfolder_get_communication_count_v1 - Retrieve Communication count # noqa: E501 + Retrieve Communication count """ pass def test_ezsignfolder_get_communication_list_v1(self) -> None: """Test case for ezsignfolder_get_communication_list_v1 - Retrieve Communication list # noqa: E501 + Retrieve Communication list """ pass def test_ezsignfolder_get_communicationrecipients_v1(self) -> None: """Test case for ezsignfolder_get_communicationrecipients_v1 - Retrieve Ezsignfolder's Communicationrecipient # noqa: E501 + Retrieve Ezsignfolder's Communicationrecipient """ pass def test_ezsignfolder_get_communicationsenders_v1(self) -> None: """Test case for ezsignfolder_get_communicationsenders_v1 - Retrieve Ezsignfolder's Communicationsender # noqa: E501 + Retrieve Ezsignfolder's Communicationsender """ pass def test_ezsignfolder_get_ezsigndocuments_v1(self) -> None: """Test case for ezsignfolder_get_ezsigndocuments_v1 - Retrieve an existing Ezsignfolder's Ezsigndocuments # noqa: E501 + Retrieve an existing Ezsignfolder's Ezsigndocuments """ pass def test_ezsignfolder_get_ezsignfoldersignerassociations_v1(self) -> None: """Test case for ezsignfolder_get_ezsignfoldersignerassociations_v1 - Retrieve an existing Ezsignfolder's Ezsignfoldersignerassociations # noqa: E501 + Retrieve an existing Ezsignfolder's Ezsignfoldersignerassociations """ pass def test_ezsignfolder_get_ezsignsignatures_automatic_v1(self) -> None: """Test case for ezsignfolder_get_ezsignsignatures_automatic_v1 - Retrieve an existing Ezsignfolder's automatic Ezsignsignatures # noqa: E501 + Retrieve an existing Ezsignfolder's automatic Ezsignsignatures """ pass def test_ezsignfolder_get_forms_data_v1(self) -> None: """Test case for ezsignfolder_get_forms_data_v1 - Retrieve an existing Ezsignfolder's forms data # noqa: E501 + Retrieve an existing Ezsignfolder's forms data """ pass def test_ezsignfolder_get_list_v1(self) -> None: """Test case for ezsignfolder_get_list_v1 - Retrieve Ezsignfolder list # noqa: E501 + Retrieve Ezsignfolder list """ pass def test_ezsignfolder_get_object_v1(self) -> None: """Test case for ezsignfolder_get_object_v1 - Retrieve an existing Ezsignfolder # noqa: E501 + Retrieve an existing Ezsignfolder """ pass def test_ezsignfolder_get_object_v2(self) -> None: """Test case for ezsignfolder_get_object_v2 - Retrieve an existing Ezsignfolder # noqa: E501 + Retrieve an existing Ezsignfolder """ pass def test_ezsignfolder_import_ezsignfoldersignerassociations_v1(self) -> None: """Test case for ezsignfolder_import_ezsignfoldersignerassociations_v1 - Import an existing Ezsignfoldersignerassociation into this Ezsignfolder # noqa: E501 + Import an existing Ezsignfoldersignerassociation into this Ezsignfolder """ pass def test_ezsignfolder_import_ezsigntemplatepackage_v1(self) -> None: """Test case for ezsignfolder_import_ezsigntemplatepackage_v1 - Import an Ezsigntemplatepackage in the Ezsignfolder. # noqa: E501 + Import an Ezsigntemplatepackage in the Ezsignfolder. """ pass def test_ezsignfolder_reorder_v1(self) -> None: """Test case for ezsignfolder_reorder_v1 - Reorder Ezsigndocuments in the Ezsignfolder # noqa: E501 + Reorder Ezsigndocuments in the Ezsignfolder """ pass def test_ezsignfolder_send_v1(self) -> None: """Test case for ezsignfolder_send_v1 - Send the Ezsignfolder to the signatories for signature # noqa: E501 + Send the Ezsignfolder to the signatories for signature """ pass def test_ezsignfolder_send_v2(self) -> None: """Test case for ezsignfolder_send_v2 - Send the Ezsignfolder to the signatories for signature # noqa: E501 + Send the Ezsignfolder to the signatories for signature """ pass def test_ezsignfolder_send_v3(self) -> None: """Test case for ezsignfolder_send_v3 - Send the Ezsignfolder to the signatories for signature # noqa: E501 + Send the Ezsignfolder to the signatories for signature """ pass def test_ezsignfolder_unsend_v1(self) -> None: """Test case for ezsignfolder_unsend_v1 - Unsend the Ezsignfolder # noqa: E501 + Unsend the Ezsignfolder """ pass diff --git a/test/test_object_ezsignfoldersignerassociation_api.py b/test/test_object_ezsignfoldersignerassociation_api.py index 4096bfad5..37837a0e3 100644 --- a/test/test_object_ezsignfoldersignerassociation_api.py +++ b/test/test_object_ezsignfoldersignerassociation_api.py @@ -15,14 +15,14 @@ import unittest -from eZmaxApi.api.object_ezsignfoldersignerassociation_api import ObjectEzsignfoldersignerassociationApi # noqa: E501 +from eZmaxApi.api.object_ezsignfoldersignerassociation_api import ObjectEzsignfoldersignerassociationApi class TestObjectEzsignfoldersignerassociationApi(unittest.TestCase): """ObjectEzsignfoldersignerassociationApi unit test stubs""" def setUp(self) -> None: - self.api = ObjectEzsignfoldersignerassociationApi() # noqa: E501 + self.api = ObjectEzsignfoldersignerassociationApi() def tearDown(self) -> None: pass @@ -30,63 +30,63 @@ def tearDown(self) -> None: def test_ezsignfoldersignerassociation_create_object_v1(self) -> None: """Test case for ezsignfoldersignerassociation_create_object_v1 - Create a new Ezsignfoldersignerassociation # noqa: E501 + Create a new Ezsignfoldersignerassociation """ pass def test_ezsignfoldersignerassociation_create_object_v2(self) -> None: """Test case for ezsignfoldersignerassociation_create_object_v2 - Create a new Ezsignfoldersignerassociation # noqa: E501 + Create a new Ezsignfoldersignerassociation """ pass def test_ezsignfoldersignerassociation_delete_object_v1(self) -> None: """Test case for ezsignfoldersignerassociation_delete_object_v1 - Delete an existing Ezsignfoldersignerassociation # noqa: E501 + Delete an existing Ezsignfoldersignerassociation """ pass def test_ezsignfoldersignerassociation_edit_object_v1(self) -> None: """Test case for ezsignfoldersignerassociation_edit_object_v1 - Edit an existing Ezsignfoldersignerassociation # noqa: E501 + Edit an existing Ezsignfoldersignerassociation """ pass def test_ezsignfoldersignerassociation_force_disconnect_v1(self) -> None: """Test case for ezsignfoldersignerassociation_force_disconnect_v1 - Disconnects the Ezsignfoldersignerassociation # noqa: E501 + Disconnects the Ezsignfoldersignerassociation """ pass def test_ezsignfoldersignerassociation_get_in_person_login_url_v1(self) -> None: """Test case for ezsignfoldersignerassociation_get_in_person_login_url_v1 - Retrieve a Login Url to allow In-Person signing # noqa: E501 + Retrieve a Login Url to allow In-Person signing """ pass def test_ezsignfoldersignerassociation_get_object_v1(self) -> None: """Test case for ezsignfoldersignerassociation_get_object_v1 - Retrieve an existing Ezsignfoldersignerassociation # noqa: E501 + Retrieve an existing Ezsignfoldersignerassociation """ pass def test_ezsignfoldersignerassociation_get_object_v2(self) -> None: """Test case for ezsignfoldersignerassociation_get_object_v2 - Retrieve an existing Ezsignfoldersignerassociation # noqa: E501 + Retrieve an existing Ezsignfoldersignerassociation """ pass def test_ezsignfoldersignerassociation_patch_object_v1(self) -> None: """Test case for ezsignfoldersignerassociation_patch_object_v1 - Patch an existing Ezsignfoldersignerassociation # noqa: E501 + Patch an existing Ezsignfoldersignerassociation """ pass diff --git a/test/test_object_ezsignfoldertype_api.py b/test/test_object_ezsignfoldertype_api.py index 2bbc69cba..0e0714a71 100644 --- a/test/test_object_ezsignfoldertype_api.py +++ b/test/test_object_ezsignfoldertype_api.py @@ -15,14 +15,14 @@ import unittest -from eZmaxApi.api.object_ezsignfoldertype_api import ObjectEzsignfoldertypeApi # noqa: E501 +from eZmaxApi.api.object_ezsignfoldertype_api import ObjectEzsignfoldertypeApi class TestObjectEzsignfoldertypeApi(unittest.TestCase): """ObjectEzsignfoldertypeApi unit test stubs""" def setUp(self) -> None: - self.api = ObjectEzsignfoldertypeApi() # noqa: E501 + self.api = ObjectEzsignfoldertypeApi() def tearDown(self) -> None: pass @@ -30,42 +30,42 @@ def tearDown(self) -> None: def test_ezsignfoldertype_create_object_v1(self) -> None: """Test case for ezsignfoldertype_create_object_v1 - Create a new Ezsignfoldertype # noqa: E501 + Create a new Ezsignfoldertype """ pass def test_ezsignfoldertype_edit_object_v1(self) -> None: """Test case for ezsignfoldertype_edit_object_v1 - Edit an existing Ezsignfoldertype # noqa: E501 + Edit an existing Ezsignfoldertype """ pass def test_ezsignfoldertype_get_autocomplete_v1(self) -> None: """Test case for ezsignfoldertype_get_autocomplete_v1 - Retrieve Ezsignfoldertypes and IDs # noqa: E501 + Retrieve Ezsignfoldertypes and IDs """ pass def test_ezsignfoldertype_get_autocomplete_v2(self) -> None: """Test case for ezsignfoldertype_get_autocomplete_v2 - Retrieve Ezsignfoldertypes and IDs # noqa: E501 + Retrieve Ezsignfoldertypes and IDs """ pass def test_ezsignfoldertype_get_list_v1(self) -> None: """Test case for ezsignfoldertype_get_list_v1 - Retrieve Ezsignfoldertype list # noqa: E501 + Retrieve Ezsignfoldertype list """ pass def test_ezsignfoldertype_get_object_v2(self) -> None: """Test case for ezsignfoldertype_get_object_v2 - Retrieve an existing Ezsignfoldertype # noqa: E501 + Retrieve an existing Ezsignfoldertype """ pass diff --git a/test/test_object_ezsignformfieldgroup_api.py b/test/test_object_ezsignformfieldgroup_api.py index 1d492b58b..256930340 100644 --- a/test/test_object_ezsignformfieldgroup_api.py +++ b/test/test_object_ezsignformfieldgroup_api.py @@ -15,14 +15,14 @@ import unittest -from eZmaxApi.api.object_ezsignformfieldgroup_api import ObjectEzsignformfieldgroupApi # noqa: E501 +from eZmaxApi.api.object_ezsignformfieldgroup_api import ObjectEzsignformfieldgroupApi class TestObjectEzsignformfieldgroupApi(unittest.TestCase): """ObjectEzsignformfieldgroupApi unit test stubs""" def setUp(self) -> None: - self.api = ObjectEzsignformfieldgroupApi() # noqa: E501 + self.api = ObjectEzsignformfieldgroupApi() def tearDown(self) -> None: pass @@ -30,28 +30,28 @@ def tearDown(self) -> None: def test_ezsignformfieldgroup_create_object_v1(self) -> None: """Test case for ezsignformfieldgroup_create_object_v1 - Create a new Ezsignformfieldgroup # noqa: E501 + Create a new Ezsignformfieldgroup """ pass def test_ezsignformfieldgroup_delete_object_v1(self) -> None: """Test case for ezsignformfieldgroup_delete_object_v1 - Delete an existing Ezsignformfieldgroup # noqa: E501 + Delete an existing Ezsignformfieldgroup """ pass def test_ezsignformfieldgroup_edit_object_v1(self) -> None: """Test case for ezsignformfieldgroup_edit_object_v1 - Edit an existing Ezsignformfieldgroup # noqa: E501 + Edit an existing Ezsignformfieldgroup """ pass def test_ezsignformfieldgroup_get_object_v2(self) -> None: """Test case for ezsignformfieldgroup_get_object_v2 - Retrieve an existing Ezsignformfieldgroup # noqa: E501 + Retrieve an existing Ezsignformfieldgroup """ pass diff --git a/test/test_object_ezsignpage_api.py b/test/test_object_ezsignpage_api.py index 3ea47100b..6c6a27b6a 100644 --- a/test/test_object_ezsignpage_api.py +++ b/test/test_object_ezsignpage_api.py @@ -15,14 +15,14 @@ import unittest -from eZmaxApi.api.object_ezsignpage_api import ObjectEzsignpageApi # noqa: E501 +from eZmaxApi.api.object_ezsignpage_api import ObjectEzsignpageApi class TestObjectEzsignpageApi(unittest.TestCase): """ObjectEzsignpageApi unit test stubs""" def setUp(self) -> None: - self.api = ObjectEzsignpageApi() # noqa: E501 + self.api = ObjectEzsignpageApi() def tearDown(self) -> None: pass @@ -30,7 +30,7 @@ def tearDown(self) -> None: def test_ezsignpage_consult_v1(self) -> None: """Test case for ezsignpage_consult_v1 - Consult an Ezsignpage # noqa: E501 + Consult an Ezsignpage """ pass diff --git a/test/test_object_ezsignsignature_api.py b/test/test_object_ezsignsignature_api.py index 95c469bc8..9aee2b48f 100644 --- a/test/test_object_ezsignsignature_api.py +++ b/test/test_object_ezsignsignature_api.py @@ -15,14 +15,14 @@ import unittest -from eZmaxApi.api.object_ezsignsignature_api import ObjectEzsignsignatureApi # noqa: E501 +from eZmaxApi.api.object_ezsignsignature_api import ObjectEzsignsignatureApi class TestObjectEzsignsignatureApi(unittest.TestCase): """ObjectEzsignsignatureApi unit test stubs""" def setUp(self) -> None: - self.api = ObjectEzsignsignatureApi() # noqa: E501 + self.api = ObjectEzsignsignatureApi() def tearDown(self) -> None: pass @@ -30,56 +30,56 @@ def tearDown(self) -> None: def test_ezsignsignature_create_object_v1(self) -> None: """Test case for ezsignsignature_create_object_v1 - Create a new Ezsignsignature # noqa: E501 + Create a new Ezsignsignature """ pass def test_ezsignsignature_create_object_v2(self) -> None: """Test case for ezsignsignature_create_object_v2 - Create a new Ezsignsignature # noqa: E501 + Create a new Ezsignsignature """ pass def test_ezsignsignature_delete_object_v1(self) -> None: """Test case for ezsignsignature_delete_object_v1 - Delete an existing Ezsignsignature # noqa: E501 + Delete an existing Ezsignsignature """ pass def test_ezsignsignature_edit_object_v1(self) -> None: """Test case for ezsignsignature_edit_object_v1 - Edit an existing Ezsignsignature # noqa: E501 + Edit an existing Ezsignsignature """ pass def test_ezsignsignature_get_ezsignsignatureattachment_v1(self) -> None: """Test case for ezsignsignature_get_ezsignsignatureattachment_v1 - Retrieve an existing Ezsignsignature's Ezsignsignatureattachments # noqa: E501 + Retrieve an existing Ezsignsignature's Ezsignsignatureattachments """ pass def test_ezsignsignature_get_ezsignsignatures_automatic_v1(self) -> None: """Test case for ezsignsignature_get_ezsignsignatures_automatic_v1 - Retrieve all automatic Ezsignsignatures # noqa: E501 + Retrieve all automatic Ezsignsignatures """ pass def test_ezsignsignature_get_object_v2(self) -> None: """Test case for ezsignsignature_get_object_v2 - Retrieve an existing Ezsignsignature # noqa: E501 + Retrieve an existing Ezsignsignature """ pass def test_ezsignsignature_sign_v1(self) -> None: """Test case for ezsignsignature_sign_v1 - Sign the Ezsignsignature # noqa: E501 + Sign the Ezsignsignature """ pass diff --git a/test/test_object_ezsignsignergroup_api.py b/test/test_object_ezsignsignergroup_api.py index 322fb26a1..c8f59d9a2 100644 --- a/test/test_object_ezsignsignergroup_api.py +++ b/test/test_object_ezsignsignergroup_api.py @@ -15,14 +15,14 @@ import unittest -from eZmaxApi.api.object_ezsignsignergroup_api import ObjectEzsignsignergroupApi # noqa: E501 +from eZmaxApi.api.object_ezsignsignergroup_api import ObjectEzsignsignergroupApi class TestObjectEzsignsignergroupApi(unittest.TestCase): """ObjectEzsignsignergroupApi unit test stubs""" def setUp(self) -> None: - self.api = ObjectEzsignsignergroupApi() # noqa: E501 + self.api = ObjectEzsignsignergroupApi() def tearDown(self) -> None: pass @@ -30,42 +30,42 @@ def tearDown(self) -> None: def test_ezsignsignergroup_create_object_v1(self) -> None: """Test case for ezsignsignergroup_create_object_v1 - Create a new Ezsignsignergroup # noqa: E501 + Create a new Ezsignsignergroup """ pass def test_ezsignsignergroup_delete_object_v1(self) -> None: """Test case for ezsignsignergroup_delete_object_v1 - Delete an existing Ezsignsignergroup # noqa: E501 + Delete an existing Ezsignsignergroup """ pass def test_ezsignsignergroup_edit_ezsignsignergroupmemberships_v1(self) -> None: """Test case for ezsignsignergroup_edit_ezsignsignergroupmemberships_v1 - Edit multiple Ezsignsignergroupmemberships # noqa: E501 + Edit multiple Ezsignsignergroupmemberships """ pass def test_ezsignsignergroup_edit_object_v1(self) -> None: """Test case for ezsignsignergroup_edit_object_v1 - Edit an existing Ezsignsignergroup # noqa: E501 + Edit an existing Ezsignsignergroup """ pass def test_ezsignsignergroup_get_ezsignsignergroupmemberships_v1(self) -> None: """Test case for ezsignsignergroup_get_ezsignsignergroupmemberships_v1 - Retrieve an existing Ezsignsignergroup's Ezsignsignergroupmemberships # noqa: E501 + Retrieve an existing Ezsignsignergroup's Ezsignsignergroupmemberships """ pass def test_ezsignsignergroup_get_object_v2(self) -> None: """Test case for ezsignsignergroup_get_object_v2 - Retrieve an existing Ezsignsignergroup # noqa: E501 + Retrieve an existing Ezsignsignergroup """ pass diff --git a/test/test_object_ezsignsignergroupmembership_api.py b/test/test_object_ezsignsignergroupmembership_api.py index 574ff1e8c..3bef89f8c 100644 --- a/test/test_object_ezsignsignergroupmembership_api.py +++ b/test/test_object_ezsignsignergroupmembership_api.py @@ -15,14 +15,14 @@ import unittest -from eZmaxApi.api.object_ezsignsignergroupmembership_api import ObjectEzsignsignergroupmembershipApi # noqa: E501 +from eZmaxApi.api.object_ezsignsignergroupmembership_api import ObjectEzsignsignergroupmembershipApi class TestObjectEzsignsignergroupmembershipApi(unittest.TestCase): """ObjectEzsignsignergroupmembershipApi unit test stubs""" def setUp(self) -> None: - self.api = ObjectEzsignsignergroupmembershipApi() # noqa: E501 + self.api = ObjectEzsignsignergroupmembershipApi() def tearDown(self) -> None: pass @@ -30,21 +30,21 @@ def tearDown(self) -> None: def test_ezsignsignergroupmembership_create_object_v1(self) -> None: """Test case for ezsignsignergroupmembership_create_object_v1 - Create a new Ezsignsignergroupmembership # noqa: E501 + Create a new Ezsignsignergroupmembership """ pass def test_ezsignsignergroupmembership_delete_object_v1(self) -> None: """Test case for ezsignsignergroupmembership_delete_object_v1 - Delete an existing Ezsignsignergroupmembership # noqa: E501 + Delete an existing Ezsignsignergroupmembership """ pass def test_ezsignsignergroupmembership_get_object_v2(self) -> None: """Test case for ezsignsignergroupmembership_get_object_v2 - Retrieve an existing Ezsignsignergroupmembership # noqa: E501 + Retrieve an existing Ezsignsignergroupmembership """ pass diff --git a/test/test_object_ezsignsigningreason_api.py b/test/test_object_ezsignsigningreason_api.py new file mode 100644 index 000000000..776a67002 --- /dev/null +++ b/test/test_object_ezsignsigningreason_api.py @@ -0,0 +1,67 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from eZmaxApi.api.object_ezsignsigningreason_api import ObjectEzsignsigningreasonApi + + +class TestObjectEzsignsigningreasonApi(unittest.TestCase): + """ObjectEzsignsigningreasonApi unit test stubs""" + + def setUp(self) -> None: + self.api = ObjectEzsignsigningreasonApi() + + def tearDown(self) -> None: + pass + + def test_ezsignsigningreason_create_object_v1(self) -> None: + """Test case for ezsignsigningreason_create_object_v1 + + Create a new Ezsignsigningreason + """ + pass + + def test_ezsignsigningreason_edit_object_v1(self) -> None: + """Test case for ezsignsigningreason_edit_object_v1 + + Edit an existing Ezsignsigningreason + """ + pass + + def test_ezsignsigningreason_get_autocomplete_v2(self) -> None: + """Test case for ezsignsigningreason_get_autocomplete_v2 + + Retrieve Ezsignsigningreasons and IDs + """ + pass + + def test_ezsignsigningreason_get_list_v1(self) -> None: + """Test case for ezsignsigningreason_get_list_v1 + + Retrieve Ezsignsigningreason list + """ + pass + + def test_ezsignsigningreason_get_object_v2(self) -> None: + """Test case for ezsignsigningreason_get_object_v2 + + Retrieve an existing Ezsignsigningreason + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_object_ezsigntemplate_api.py b/test/test_object_ezsigntemplate_api.py index 37620692e..d3e987cad 100644 --- a/test/test_object_ezsigntemplate_api.py +++ b/test/test_object_ezsigntemplate_api.py @@ -15,14 +15,14 @@ import unittest -from eZmaxApi.api.object_ezsigntemplate_api import ObjectEzsigntemplateApi # noqa: E501 +from eZmaxApi.api.object_ezsigntemplate_api import ObjectEzsigntemplateApi class TestObjectEzsigntemplateApi(unittest.TestCase): """ObjectEzsigntemplateApi unit test stubs""" def setUp(self) -> None: - self.api = ObjectEzsigntemplateApi() # noqa: E501 + self.api = ObjectEzsigntemplateApi() def tearDown(self) -> None: pass @@ -30,56 +30,56 @@ def tearDown(self) -> None: def test_ezsigntemplate_copy_v1(self) -> None: """Test case for ezsigntemplate_copy_v1 - Copy the Ezsigntemplate # noqa: E501 + Copy the Ezsigntemplate """ pass def test_ezsigntemplate_create_object_v1(self) -> None: """Test case for ezsigntemplate_create_object_v1 - Create a new Ezsigntemplate # noqa: E501 + Create a new Ezsigntemplate """ pass def test_ezsigntemplate_delete_object_v1(self) -> None: """Test case for ezsigntemplate_delete_object_v1 - Delete an existing Ezsigntemplate # noqa: E501 + Delete an existing Ezsigntemplate """ pass def test_ezsigntemplate_edit_object_v1(self) -> None: """Test case for ezsigntemplate_edit_object_v1 - Edit an existing Ezsigntemplate # noqa: E501 + Edit an existing Ezsigntemplate """ pass def test_ezsigntemplate_get_autocomplete_v2(self) -> None: """Test case for ezsigntemplate_get_autocomplete_v2 - Retrieve Ezsigntemplates and IDs # noqa: E501 + Retrieve Ezsigntemplates and IDs """ pass def test_ezsigntemplate_get_list_v1(self) -> None: """Test case for ezsigntemplate_get_list_v1 - Retrieve Ezsigntemplate list # noqa: E501 + Retrieve Ezsigntemplate list """ pass def test_ezsigntemplate_get_object_v1(self) -> None: """Test case for ezsigntemplate_get_object_v1 - Retrieve an existing Ezsigntemplate # noqa: E501 + Retrieve an existing Ezsigntemplate """ pass def test_ezsigntemplate_get_object_v2(self) -> None: """Test case for ezsigntemplate_get_object_v2 - Retrieve an existing Ezsigntemplate # noqa: E501 + Retrieve an existing Ezsigntemplate """ pass diff --git a/test/test_object_ezsigntemplatedocument_api.py b/test/test_object_ezsigntemplatedocument_api.py index 610bd7e76..a8bbcd862 100644 --- a/test/test_object_ezsigntemplatedocument_api.py +++ b/test/test_object_ezsigntemplatedocument_api.py @@ -15,14 +15,14 @@ import unittest -from eZmaxApi.api.object_ezsigntemplatedocument_api import ObjectEzsigntemplatedocumentApi # noqa: E501 +from eZmaxApi.api.object_ezsigntemplatedocument_api import ObjectEzsigntemplatedocumentApi class TestObjectEzsigntemplatedocumentApi(unittest.TestCase): """ObjectEzsigntemplatedocumentApi unit test stubs""" def setUp(self) -> None: - self.api = ObjectEzsigntemplatedocumentApi() # noqa: E501 + self.api = ObjectEzsigntemplatedocumentApi() def tearDown(self) -> None: pass @@ -30,77 +30,77 @@ def tearDown(self) -> None: def test_ezsigntemplatedocument_create_object_v1(self) -> None: """Test case for ezsigntemplatedocument_create_object_v1 - Create a new Ezsigntemplatedocument # noqa: E501 + Create a new Ezsigntemplatedocument """ pass def test_ezsigntemplatedocument_edit_ezsigntemplateformfieldgroups_v1(self) -> None: """Test case for ezsigntemplatedocument_edit_ezsigntemplateformfieldgroups_v1 - Edit multiple Ezsigntemplateformfieldgroups # noqa: E501 + Edit multiple Ezsigntemplateformfieldgroups """ pass def test_ezsigntemplatedocument_edit_ezsigntemplatesignatures_v1(self) -> None: """Test case for ezsigntemplatedocument_edit_ezsigntemplatesignatures_v1 - Edit multiple Ezsigntemplatesignatures # noqa: E501 + Edit multiple Ezsigntemplatesignatures """ pass def test_ezsigntemplatedocument_edit_object_v1(self) -> None: """Test case for ezsigntemplatedocument_edit_object_v1 - Edit an existing Ezsigntemplatedocument # noqa: E501 + Edit an existing Ezsigntemplatedocument """ pass def test_ezsigntemplatedocument_flatten_v1(self) -> None: """Test case for ezsigntemplatedocument_flatten_v1 - Flatten # noqa: E501 + Flatten """ pass def test_ezsigntemplatedocument_get_ezsigntemplatedocumentpages_v1(self) -> None: """Test case for ezsigntemplatedocument_get_ezsigntemplatedocumentpages_v1 - Retrieve an existing Ezsigntemplatedocument's Ezsigntemplatedocumentpages # noqa: E501 + Retrieve an existing Ezsigntemplatedocument's Ezsigntemplatedocumentpages """ pass def test_ezsigntemplatedocument_get_ezsigntemplateformfieldgroups_v1(self) -> None: """Test case for ezsigntemplatedocument_get_ezsigntemplateformfieldgroups_v1 - Retrieve an existing Ezsigntemplatedocument's Ezsigntemplateformfieldgroups # noqa: E501 + Retrieve an existing Ezsigntemplatedocument's Ezsigntemplateformfieldgroups """ pass def test_ezsigntemplatedocument_get_ezsigntemplatesignatures_v1(self) -> None: """Test case for ezsigntemplatedocument_get_ezsigntemplatesignatures_v1 - Retrieve an existing Ezsigntemplatedocument's Ezsigntemplatesignatures # noqa: E501 + Retrieve an existing Ezsigntemplatedocument's Ezsigntemplatesignatures """ pass def test_ezsigntemplatedocument_get_object_v2(self) -> None: """Test case for ezsigntemplatedocument_get_object_v2 - Retrieve an existing Ezsigntemplatedocument # noqa: E501 + Retrieve an existing Ezsigntemplatedocument """ pass def test_ezsigntemplatedocument_get_words_positions_v1(self) -> None: """Test case for ezsigntemplatedocument_get_words_positions_v1 - Retrieve positions X,Y of given words from a Ezsigntemplatedocument # noqa: E501 + Retrieve positions X,Y of given words from a Ezsigntemplatedocument """ pass def test_ezsigntemplatedocument_patch_object_v1(self) -> None: """Test case for ezsigntemplatedocument_patch_object_v1 - Patch an existing Ezsigntemplatedocument # noqa: E501 + Patch an existing Ezsigntemplatedocument """ pass diff --git a/test/test_object_ezsigntemplateformfieldgroup_api.py b/test/test_object_ezsigntemplateformfieldgroup_api.py index 61169ab57..420f2bdf2 100644 --- a/test/test_object_ezsigntemplateformfieldgroup_api.py +++ b/test/test_object_ezsigntemplateformfieldgroup_api.py @@ -15,14 +15,14 @@ import unittest -from eZmaxApi.api.object_ezsigntemplateformfieldgroup_api import ObjectEzsigntemplateformfieldgroupApi # noqa: E501 +from eZmaxApi.api.object_ezsigntemplateformfieldgroup_api import ObjectEzsigntemplateformfieldgroupApi class TestObjectEzsigntemplateformfieldgroupApi(unittest.TestCase): """ObjectEzsigntemplateformfieldgroupApi unit test stubs""" def setUp(self) -> None: - self.api = ObjectEzsigntemplateformfieldgroupApi() # noqa: E501 + self.api = ObjectEzsigntemplateformfieldgroupApi() def tearDown(self) -> None: pass @@ -30,28 +30,28 @@ def tearDown(self) -> None: def test_ezsigntemplateformfieldgroup_create_object_v1(self) -> None: """Test case for ezsigntemplateformfieldgroup_create_object_v1 - Create a new Ezsigntemplateformfieldgroup # noqa: E501 + Create a new Ezsigntemplateformfieldgroup """ pass def test_ezsigntemplateformfieldgroup_delete_object_v1(self) -> None: """Test case for ezsigntemplateformfieldgroup_delete_object_v1 - Delete an existing Ezsigntemplateformfieldgroup # noqa: E501 + Delete an existing Ezsigntemplateformfieldgroup """ pass def test_ezsigntemplateformfieldgroup_edit_object_v1(self) -> None: """Test case for ezsigntemplateformfieldgroup_edit_object_v1 - Edit an existing Ezsigntemplateformfieldgroup # noqa: E501 + Edit an existing Ezsigntemplateformfieldgroup """ pass def test_ezsigntemplateformfieldgroup_get_object_v2(self) -> None: """Test case for ezsigntemplateformfieldgroup_get_object_v2 - Retrieve an existing Ezsigntemplateformfieldgroup # noqa: E501 + Retrieve an existing Ezsigntemplateformfieldgroup """ pass diff --git a/test/test_object_ezsigntemplatepackage_api.py b/test/test_object_ezsigntemplatepackage_api.py index 4474f2687..8ba9b4060 100644 --- a/test/test_object_ezsigntemplatepackage_api.py +++ b/test/test_object_ezsigntemplatepackage_api.py @@ -15,14 +15,14 @@ import unittest -from eZmaxApi.api.object_ezsigntemplatepackage_api import ObjectEzsigntemplatepackageApi # noqa: E501 +from eZmaxApi.api.object_ezsigntemplatepackage_api import ObjectEzsigntemplatepackageApi class TestObjectEzsigntemplatepackageApi(unittest.TestCase): """ObjectEzsigntemplatepackageApi unit test stubs""" def setUp(self) -> None: - self.api = ObjectEzsigntemplatepackageApi() # noqa: E501 + self.api = ObjectEzsigntemplatepackageApi() def tearDown(self) -> None: pass @@ -30,49 +30,49 @@ def tearDown(self) -> None: def test_ezsigntemplatepackage_create_object_v1(self) -> None: """Test case for ezsigntemplatepackage_create_object_v1 - Create a new Ezsigntemplatepackage # noqa: E501 + Create a new Ezsigntemplatepackage """ pass def test_ezsigntemplatepackage_delete_object_v1(self) -> None: """Test case for ezsigntemplatepackage_delete_object_v1 - Delete an existing Ezsigntemplatepackage # noqa: E501 + Delete an existing Ezsigntemplatepackage """ pass def test_ezsigntemplatepackage_edit_ezsigntemplatepackagesigners_v1(self) -> None: """Test case for ezsigntemplatepackage_edit_ezsigntemplatepackagesigners_v1 - Edit multiple Ezsigntemplatepackagesigners # noqa: E501 + Edit multiple Ezsigntemplatepackagesigners """ pass def test_ezsigntemplatepackage_edit_object_v1(self) -> None: """Test case for ezsigntemplatepackage_edit_object_v1 - Edit an existing Ezsigntemplatepackage # noqa: E501 + Edit an existing Ezsigntemplatepackage """ pass def test_ezsigntemplatepackage_get_autocomplete_v2(self) -> None: """Test case for ezsigntemplatepackage_get_autocomplete_v2 - Retrieve Ezsigntemplatepackages and IDs # noqa: E501 + Retrieve Ezsigntemplatepackages and IDs """ pass def test_ezsigntemplatepackage_get_list_v1(self) -> None: """Test case for ezsigntemplatepackage_get_list_v1 - Retrieve Ezsigntemplatepackage list # noqa: E501 + Retrieve Ezsigntemplatepackage list """ pass def test_ezsigntemplatepackage_get_object_v2(self) -> None: """Test case for ezsigntemplatepackage_get_object_v2 - Retrieve an existing Ezsigntemplatepackage # noqa: E501 + Retrieve an existing Ezsigntemplatepackage """ pass diff --git a/test/test_object_ezsigntemplatepackagemembership_api.py b/test/test_object_ezsigntemplatepackagemembership_api.py index d0fe2ed2f..fde05e58a 100644 --- a/test/test_object_ezsigntemplatepackagemembership_api.py +++ b/test/test_object_ezsigntemplatepackagemembership_api.py @@ -15,14 +15,14 @@ import unittest -from eZmaxApi.api.object_ezsigntemplatepackagemembership_api import ObjectEzsigntemplatepackagemembershipApi # noqa: E501 +from eZmaxApi.api.object_ezsigntemplatepackagemembership_api import ObjectEzsigntemplatepackagemembershipApi class TestObjectEzsigntemplatepackagemembershipApi(unittest.TestCase): """ObjectEzsigntemplatepackagemembershipApi unit test stubs""" def setUp(self) -> None: - self.api = ObjectEzsigntemplatepackagemembershipApi() # noqa: E501 + self.api = ObjectEzsigntemplatepackagemembershipApi() def tearDown(self) -> None: pass @@ -30,21 +30,21 @@ def tearDown(self) -> None: def test_ezsigntemplatepackagemembership_create_object_v1(self) -> None: """Test case for ezsigntemplatepackagemembership_create_object_v1 - Create a new Ezsigntemplatepackagemembership # noqa: E501 + Create a new Ezsigntemplatepackagemembership """ pass def test_ezsigntemplatepackagemembership_delete_object_v1(self) -> None: """Test case for ezsigntemplatepackagemembership_delete_object_v1 - Delete an existing Ezsigntemplatepackagemembership # noqa: E501 + Delete an existing Ezsigntemplatepackagemembership """ pass def test_ezsigntemplatepackagemembership_get_object_v2(self) -> None: """Test case for ezsigntemplatepackagemembership_get_object_v2 - Retrieve an existing Ezsigntemplatepackagemembership # noqa: E501 + Retrieve an existing Ezsigntemplatepackagemembership """ pass diff --git a/test/test_object_ezsigntemplatepackagesigner_api.py b/test/test_object_ezsigntemplatepackagesigner_api.py index 390629dc2..cfb61af0b 100644 --- a/test/test_object_ezsigntemplatepackagesigner_api.py +++ b/test/test_object_ezsigntemplatepackagesigner_api.py @@ -15,14 +15,14 @@ import unittest -from eZmaxApi.api.object_ezsigntemplatepackagesigner_api import ObjectEzsigntemplatepackagesignerApi # noqa: E501 +from eZmaxApi.api.object_ezsigntemplatepackagesigner_api import ObjectEzsigntemplatepackagesignerApi class TestObjectEzsigntemplatepackagesignerApi(unittest.TestCase): """ObjectEzsigntemplatepackagesignerApi unit test stubs""" def setUp(self) -> None: - self.api = ObjectEzsigntemplatepackagesignerApi() # noqa: E501 + self.api = ObjectEzsigntemplatepackagesignerApi() def tearDown(self) -> None: pass @@ -30,28 +30,28 @@ def tearDown(self) -> None: def test_ezsigntemplatepackagesigner_create_object_v1(self) -> None: """Test case for ezsigntemplatepackagesigner_create_object_v1 - Create a new Ezsigntemplatepackagesigner # noqa: E501 + Create a new Ezsigntemplatepackagesigner """ pass def test_ezsigntemplatepackagesigner_delete_object_v1(self) -> None: """Test case for ezsigntemplatepackagesigner_delete_object_v1 - Delete an existing Ezsigntemplatepackagesigner # noqa: E501 + Delete an existing Ezsigntemplatepackagesigner """ pass def test_ezsigntemplatepackagesigner_edit_object_v1(self) -> None: """Test case for ezsigntemplatepackagesigner_edit_object_v1 - Edit an existing Ezsigntemplatepackagesigner # noqa: E501 + Edit an existing Ezsigntemplatepackagesigner """ pass def test_ezsigntemplatepackagesigner_get_object_v2(self) -> None: """Test case for ezsigntemplatepackagesigner_get_object_v2 - Retrieve an existing Ezsigntemplatepackagesigner # noqa: E501 + Retrieve an existing Ezsigntemplatepackagesigner """ pass diff --git a/test/test_object_ezsigntemplatepackagesignermembership_api.py b/test/test_object_ezsigntemplatepackagesignermembership_api.py index 2aa9ee658..d807b1530 100644 --- a/test/test_object_ezsigntemplatepackagesignermembership_api.py +++ b/test/test_object_ezsigntemplatepackagesignermembership_api.py @@ -15,14 +15,14 @@ import unittest -from eZmaxApi.api.object_ezsigntemplatepackagesignermembership_api import ObjectEzsigntemplatepackagesignermembershipApi # noqa: E501 +from eZmaxApi.api.object_ezsigntemplatepackagesignermembership_api import ObjectEzsigntemplatepackagesignermembershipApi class TestObjectEzsigntemplatepackagesignermembershipApi(unittest.TestCase): """ObjectEzsigntemplatepackagesignermembershipApi unit test stubs""" def setUp(self) -> None: - self.api = ObjectEzsigntemplatepackagesignermembershipApi() # noqa: E501 + self.api = ObjectEzsigntemplatepackagesignermembershipApi() def tearDown(self) -> None: pass @@ -30,21 +30,21 @@ def tearDown(self) -> None: def test_ezsigntemplatepackagesignermembership_create_object_v1(self) -> None: """Test case for ezsigntemplatepackagesignermembership_create_object_v1 - Create a new Ezsigntemplatepackagesignermembership # noqa: E501 + Create a new Ezsigntemplatepackagesignermembership """ pass def test_ezsigntemplatepackagesignermembership_delete_object_v1(self) -> None: """Test case for ezsigntemplatepackagesignermembership_delete_object_v1 - Delete an existing Ezsigntemplatepackagesignermembership # noqa: E501 + Delete an existing Ezsigntemplatepackagesignermembership """ pass def test_ezsigntemplatepackagesignermembership_get_object_v2(self) -> None: """Test case for ezsigntemplatepackagesignermembership_get_object_v2 - Retrieve an existing Ezsigntemplatepackagesignermembership # noqa: E501 + Retrieve an existing Ezsigntemplatepackagesignermembership """ pass diff --git a/test/test_object_ezsigntemplatesignature_api.py b/test/test_object_ezsigntemplatesignature_api.py index e686850e7..da96744e2 100644 --- a/test/test_object_ezsigntemplatesignature_api.py +++ b/test/test_object_ezsigntemplatesignature_api.py @@ -15,14 +15,14 @@ import unittest -from eZmaxApi.api.object_ezsigntemplatesignature_api import ObjectEzsigntemplatesignatureApi # noqa: E501 +from eZmaxApi.api.object_ezsigntemplatesignature_api import ObjectEzsigntemplatesignatureApi class TestObjectEzsigntemplatesignatureApi(unittest.TestCase): """ObjectEzsigntemplatesignatureApi unit test stubs""" def setUp(self) -> None: - self.api = ObjectEzsigntemplatesignatureApi() # noqa: E501 + self.api = ObjectEzsigntemplatesignatureApi() def tearDown(self) -> None: pass @@ -30,28 +30,28 @@ def tearDown(self) -> None: def test_ezsigntemplatesignature_create_object_v1(self) -> None: """Test case for ezsigntemplatesignature_create_object_v1 - Create a new Ezsigntemplatesignature # noqa: E501 + Create a new Ezsigntemplatesignature """ pass def test_ezsigntemplatesignature_delete_object_v1(self) -> None: """Test case for ezsigntemplatesignature_delete_object_v1 - Delete an existing Ezsigntemplatesignature # noqa: E501 + Delete an existing Ezsigntemplatesignature """ pass def test_ezsigntemplatesignature_edit_object_v1(self) -> None: """Test case for ezsigntemplatesignature_edit_object_v1 - Edit an existing Ezsigntemplatesignature # noqa: E501 + Edit an existing Ezsigntemplatesignature """ pass def test_ezsigntemplatesignature_get_object_v2(self) -> None: """Test case for ezsigntemplatesignature_get_object_v2 - Retrieve an existing Ezsigntemplatesignature # noqa: E501 + Retrieve an existing Ezsigntemplatesignature """ pass diff --git a/test/test_object_ezsigntemplatesigner_api.py b/test/test_object_ezsigntemplatesigner_api.py index a012ef751..b591ef837 100644 --- a/test/test_object_ezsigntemplatesigner_api.py +++ b/test/test_object_ezsigntemplatesigner_api.py @@ -15,14 +15,14 @@ import unittest -from eZmaxApi.api.object_ezsigntemplatesigner_api import ObjectEzsigntemplatesignerApi # noqa: E501 +from eZmaxApi.api.object_ezsigntemplatesigner_api import ObjectEzsigntemplatesignerApi class TestObjectEzsigntemplatesignerApi(unittest.TestCase): """ObjectEzsigntemplatesignerApi unit test stubs""" def setUp(self) -> None: - self.api = ObjectEzsigntemplatesignerApi() # noqa: E501 + self.api = ObjectEzsigntemplatesignerApi() def tearDown(self) -> None: pass @@ -30,28 +30,28 @@ def tearDown(self) -> None: def test_ezsigntemplatesigner_create_object_v1(self) -> None: """Test case for ezsigntemplatesigner_create_object_v1 - Create a new Ezsigntemplatesigner # noqa: E501 + Create a new Ezsigntemplatesigner """ pass def test_ezsigntemplatesigner_delete_object_v1(self) -> None: """Test case for ezsigntemplatesigner_delete_object_v1 - Delete an existing Ezsigntemplatesigner # noqa: E501 + Delete an existing Ezsigntemplatesigner """ pass def test_ezsigntemplatesigner_edit_object_v1(self) -> None: """Test case for ezsigntemplatesigner_edit_object_v1 - Edit an existing Ezsigntemplatesigner # noqa: E501 + Edit an existing Ezsigntemplatesigner """ pass def test_ezsigntemplatesigner_get_object_v2(self) -> None: """Test case for ezsigntemplatesigner_get_object_v2 - Retrieve an existing Ezsigntemplatesigner # noqa: E501 + Retrieve an existing Ezsigntemplatesigner """ pass diff --git a/test/test_object_ezsigntsarequirement_api.py b/test/test_object_ezsigntsarequirement_api.py index 3bd97d80b..a0b8e8eb2 100644 --- a/test/test_object_ezsigntsarequirement_api.py +++ b/test/test_object_ezsigntsarequirement_api.py @@ -15,14 +15,14 @@ import unittest -from eZmaxApi.api.object_ezsigntsarequirement_api import ObjectEzsigntsarequirementApi # noqa: E501 +from eZmaxApi.api.object_ezsigntsarequirement_api import ObjectEzsigntsarequirementApi class TestObjectEzsigntsarequirementApi(unittest.TestCase): """ObjectEzsigntsarequirementApi unit test stubs""" def setUp(self) -> None: - self.api = ObjectEzsigntsarequirementApi() # noqa: E501 + self.api = ObjectEzsigntsarequirementApi() def tearDown(self) -> None: pass @@ -30,7 +30,7 @@ def tearDown(self) -> None: def test_ezsigntsarequirement_get_autocomplete_v2(self) -> None: """Test case for ezsigntsarequirement_get_autocomplete_v2 - Retrieve Ezsigntsarequirements and IDs # noqa: E501 + Retrieve Ezsigntsarequirements and IDs """ pass diff --git a/test/test_object_font_api.py b/test/test_object_font_api.py index 1b8d1c3b3..ae71f75ab 100644 --- a/test/test_object_font_api.py +++ b/test/test_object_font_api.py @@ -15,14 +15,14 @@ import unittest -from eZmaxApi.api.object_font_api import ObjectFontApi # noqa: E501 +from eZmaxApi.api.object_font_api import ObjectFontApi class TestObjectFontApi(unittest.TestCase): """ObjectFontApi unit test stubs""" def setUp(self) -> None: - self.api = ObjectFontApi() # noqa: E501 + self.api = ObjectFontApi() def tearDown(self) -> None: pass @@ -30,7 +30,7 @@ def tearDown(self) -> None: def test_font_get_autocomplete_v2(self) -> None: """Test case for font_get_autocomplete_v2 - Retrieve Fonts and IDs # noqa: E501 + Retrieve Fonts and IDs """ pass diff --git a/test/test_object_franchisebroker_api.py b/test/test_object_franchisebroker_api.py index e39985031..9bab92890 100644 --- a/test/test_object_franchisebroker_api.py +++ b/test/test_object_franchisebroker_api.py @@ -15,14 +15,14 @@ import unittest -from eZmaxApi.api.object_franchisebroker_api import ObjectFranchisebrokerApi # noqa: E501 +from eZmaxApi.api.object_franchisebroker_api import ObjectFranchisebrokerApi class TestObjectFranchisebrokerApi(unittest.TestCase): """ObjectFranchisebrokerApi unit test stubs""" def setUp(self) -> None: - self.api = ObjectFranchisebrokerApi() # noqa: E501 + self.api = ObjectFranchisebrokerApi() def tearDown(self) -> None: pass @@ -30,14 +30,14 @@ def tearDown(self) -> None: def test_franchisebroker_get_autocomplete_v1(self) -> None: """Test case for franchisebroker_get_autocomplete_v1 - Retrieve Franchisebrokers and IDs # noqa: E501 + Retrieve Franchisebrokers and IDs """ pass def test_franchisebroker_get_autocomplete_v2(self) -> None: """Test case for franchisebroker_get_autocomplete_v2 - Retrieve Franchisebrokers and IDs # noqa: E501 + Retrieve Franchisebrokers and IDs """ pass diff --git a/test/test_object_franchiseoffice_api.py b/test/test_object_franchiseoffice_api.py index ba02502d2..53a009fe6 100644 --- a/test/test_object_franchiseoffice_api.py +++ b/test/test_object_franchiseoffice_api.py @@ -15,14 +15,14 @@ import unittest -from eZmaxApi.api.object_franchiseoffice_api import ObjectFranchiseofficeApi # noqa: E501 +from eZmaxApi.api.object_franchiseoffice_api import ObjectFranchiseofficeApi class TestObjectFranchiseofficeApi(unittest.TestCase): """ObjectFranchiseofficeApi unit test stubs""" def setUp(self) -> None: - self.api = ObjectFranchiseofficeApi() # noqa: E501 + self.api = ObjectFranchiseofficeApi() def tearDown(self) -> None: pass @@ -30,7 +30,7 @@ def tearDown(self) -> None: def test_franchiseoffice_get_autocomplete_v2(self) -> None: """Test case for franchiseoffice_get_autocomplete_v2 - Retrieve Franchiseoffices and IDs # noqa: E501 + Retrieve Franchiseoffices and IDs """ pass diff --git a/test/test_object_franchisereferalincome_api.py b/test/test_object_franchisereferalincome_api.py index c45ab9123..07961cda4 100644 --- a/test/test_object_franchisereferalincome_api.py +++ b/test/test_object_franchisereferalincome_api.py @@ -15,14 +15,14 @@ import unittest -from eZmaxApi.api.object_franchisereferalincome_api import ObjectFranchisereferalincomeApi # noqa: E501 +from eZmaxApi.api.object_franchisereferalincome_api import ObjectFranchisereferalincomeApi class TestObjectFranchisereferalincomeApi(unittest.TestCase): """ObjectFranchisereferalincomeApi unit test stubs""" def setUp(self) -> None: - self.api = ObjectFranchisereferalincomeApi() # noqa: E501 + self.api = ObjectFranchisereferalincomeApi() def tearDown(self) -> None: pass @@ -30,14 +30,14 @@ def tearDown(self) -> None: def test_franchisereferalincome_create_object_v1(self) -> None: """Test case for franchisereferalincome_create_object_v1 - Create a new Franchisereferalincome # noqa: E501 + Create a new Franchisereferalincome """ pass def test_franchisereferalincome_create_object_v2(self) -> None: """Test case for franchisereferalincome_create_object_v2 - Create a new Franchisereferalincome # noqa: E501 + Create a new Franchisereferalincome """ pass diff --git a/test/test_object_inscription_api.py b/test/test_object_inscription_api.py index 0e5159770..0642986fe 100644 --- a/test/test_object_inscription_api.py +++ b/test/test_object_inscription_api.py @@ -15,22 +15,36 @@ import unittest -from eZmaxApi.api.object_inscription_api import ObjectInscriptionApi # noqa: E501 +from eZmaxApi.api.object_inscription_api import ObjectInscriptionApi class TestObjectInscriptionApi(unittest.TestCase): """ObjectInscriptionApi unit test stubs""" def setUp(self) -> None: - self.api = ObjectInscriptionApi() # noqa: E501 + self.api = ObjectInscriptionApi() def tearDown(self) -> None: pass + def test_inscription_get_attachments_v1(self) -> None: + """Test case for inscription_get_attachments_v1 + + Retrieve Inscription's Attachments + """ + pass + def test_inscription_get_communication_list_v1(self) -> None: """Test case for inscription_get_communication_list_v1 - Retrieve Communication list # noqa: E501 + Retrieve Communication list + """ + pass + + def test_inscription_get_communicationsenders_v1(self) -> None: + """Test case for inscription_get_communicationsenders_v1 + + Retrieve Inscription's Communicationsender """ pass diff --git a/test/test_object_inscriptionnotauthenticated_api.py b/test/test_object_inscriptionnotauthenticated_api.py index e102dd29a..e566c7ba0 100644 --- a/test/test_object_inscriptionnotauthenticated_api.py +++ b/test/test_object_inscriptionnotauthenticated_api.py @@ -15,14 +15,14 @@ import unittest -from eZmaxApi.api.object_inscriptionnotauthenticated_api import ObjectInscriptionnotauthenticatedApi # noqa: E501 +from eZmaxApi.api.object_inscriptionnotauthenticated_api import ObjectInscriptionnotauthenticatedApi class TestObjectInscriptionnotauthenticatedApi(unittest.TestCase): """ObjectInscriptionnotauthenticatedApi unit test stubs""" def setUp(self) -> None: - self.api = ObjectInscriptionnotauthenticatedApi() # noqa: E501 + self.api = ObjectInscriptionnotauthenticatedApi() def tearDown(self) -> None: pass @@ -30,7 +30,7 @@ def tearDown(self) -> None: def test_inscriptionnotauthenticated_get_communication_list_v1(self) -> None: """Test case for inscriptionnotauthenticated_get_communication_list_v1 - Retrieve Communication list # noqa: E501 + Retrieve Communication list """ pass diff --git a/test/test_object_inscriptiontemp_api.py b/test/test_object_inscriptiontemp_api.py index cfcdfa165..15dff624c 100644 --- a/test/test_object_inscriptiontemp_api.py +++ b/test/test_object_inscriptiontemp_api.py @@ -15,14 +15,14 @@ import unittest -from eZmaxApi.api.object_inscriptiontemp_api import ObjectInscriptiontempApi # noqa: E501 +from eZmaxApi.api.object_inscriptiontemp_api import ObjectInscriptiontempApi class TestObjectInscriptiontempApi(unittest.TestCase): """ObjectInscriptiontempApi unit test stubs""" def setUp(self) -> None: - self.api = ObjectInscriptiontempApi() # noqa: E501 + self.api = ObjectInscriptiontempApi() def tearDown(self) -> None: pass @@ -30,7 +30,7 @@ def tearDown(self) -> None: def test_inscriptiontemp_get_communication_list_v1(self) -> None: """Test case for inscriptiontemp_get_communication_list_v1 - Retrieve Communication list # noqa: E501 + Retrieve Communication list """ pass diff --git a/test/test_object_invoice_api.py b/test/test_object_invoice_api.py index 1565f8243..ded2abdc6 100644 --- a/test/test_object_invoice_api.py +++ b/test/test_object_invoice_api.py @@ -15,22 +15,29 @@ import unittest -from eZmaxApi.api.object_invoice_api import ObjectInvoiceApi # noqa: E501 +from eZmaxApi.api.object_invoice_api import ObjectInvoiceApi class TestObjectInvoiceApi(unittest.TestCase): """ObjectInvoiceApi unit test stubs""" def setUp(self) -> None: - self.api = ObjectInvoiceApi() # noqa: E501 + self.api = ObjectInvoiceApi() def tearDown(self) -> None: pass + def test_invoice_get_attachments_v1(self) -> None: + """Test case for invoice_get_attachments_v1 + + Retrieve Invoice's Attachments + """ + pass + def test_invoice_get_communication_list_v1(self) -> None: """Test case for invoice_get_communication_list_v1 - Retrieve Communication list # noqa: E501 + Retrieve Communication list """ pass diff --git a/test/test_object_language_api.py b/test/test_object_language_api.py index 56c49c9f4..56f330beb 100644 --- a/test/test_object_language_api.py +++ b/test/test_object_language_api.py @@ -15,14 +15,14 @@ import unittest -from eZmaxApi.api.object_language_api import ObjectLanguageApi # noqa: E501 +from eZmaxApi.api.object_language_api import ObjectLanguageApi class TestObjectLanguageApi(unittest.TestCase): """ObjectLanguageApi unit test stubs""" def setUp(self) -> None: - self.api = ObjectLanguageApi() # noqa: E501 + self.api = ObjectLanguageApi() def tearDown(self) -> None: pass @@ -30,7 +30,7 @@ def tearDown(self) -> None: def test_language_get_autocomplete_v2(self) -> None: """Test case for language_get_autocomplete_v2 - Retrieve Languages and IDs # noqa: E501 + Retrieve Languages and IDs """ pass diff --git a/test/test_object_modulegroup_api.py b/test/test_object_modulegroup_api.py index 25ce7675b..29ba4e8f5 100644 --- a/test/test_object_modulegroup_api.py +++ b/test/test_object_modulegroup_api.py @@ -15,14 +15,14 @@ import unittest -from eZmaxApi.api.object_modulegroup_api import ObjectModulegroupApi # noqa: E501 +from eZmaxApi.api.object_modulegroup_api import ObjectModulegroupApi class TestObjectModulegroupApi(unittest.TestCase): """ObjectModulegroupApi unit test stubs""" def setUp(self) -> None: - self.api = ObjectModulegroupApi() # noqa: E501 + self.api = ObjectModulegroupApi() def tearDown(self) -> None: pass @@ -30,7 +30,7 @@ def tearDown(self) -> None: def test_modulegroup_get_all_v1(self) -> None: """Test case for modulegroup_get_all_v1 - Retrieve all Modulegroups # noqa: E501 + Retrieve all Modulegroups """ pass diff --git a/test/test_object_notificationsection_api.py b/test/test_object_notificationsection_api.py index 7b4d5bb0f..bb1f20702 100644 --- a/test/test_object_notificationsection_api.py +++ b/test/test_object_notificationsection_api.py @@ -15,14 +15,14 @@ import unittest -from eZmaxApi.api.object_notificationsection_api import ObjectNotificationsectionApi # noqa: E501 +from eZmaxApi.api.object_notificationsection_api import ObjectNotificationsectionApi class TestObjectNotificationsectionApi(unittest.TestCase): """ObjectNotificationsectionApi unit test stubs""" def setUp(self) -> None: - self.api = ObjectNotificationsectionApi() # noqa: E501 + self.api = ObjectNotificationsectionApi() def tearDown(self) -> None: pass @@ -30,7 +30,7 @@ def tearDown(self) -> None: def test_notificationsection_get_notificationtests_v1(self) -> None: """Test case for notificationsection_get_notificationtests_v1 - Retrieve an existing Notificationsection's Notificationtests # noqa: E501 + Retrieve an existing Notificationsection's Notificationtests """ pass diff --git a/test/test_object_notificationtest_api.py b/test/test_object_notificationtest_api.py index 39244be4a..cb71c7e03 100644 --- a/test/test_object_notificationtest_api.py +++ b/test/test_object_notificationtest_api.py @@ -15,14 +15,14 @@ import unittest -from eZmaxApi.api.object_notificationtest_api import ObjectNotificationtestApi # noqa: E501 +from eZmaxApi.api.object_notificationtest_api import ObjectNotificationtestApi class TestObjectNotificationtestApi(unittest.TestCase): """ObjectNotificationtestApi unit test stubs""" def setUp(self) -> None: - self.api = ObjectNotificationtestApi() # noqa: E501 + self.api = ObjectNotificationtestApi() def tearDown(self) -> None: pass @@ -30,7 +30,7 @@ def tearDown(self) -> None: def test_notificationtest_get_elements_v1(self) -> None: """Test case for notificationtest_get_elements_v1 - Retrieve an existing Notificationtest's Elements # noqa: E501 + Retrieve an existing Notificationtest's Elements """ pass diff --git a/test/test_object_otherincome_api.py b/test/test_object_otherincome_api.py index 0ba31111e..2c6a2f107 100644 --- a/test/test_object_otherincome_api.py +++ b/test/test_object_otherincome_api.py @@ -15,14 +15,14 @@ import unittest -from eZmaxApi.api.object_otherincome_api import ObjectOtherincomeApi # noqa: E501 +from eZmaxApi.api.object_otherincome_api import ObjectOtherincomeApi class TestObjectOtherincomeApi(unittest.TestCase): """ObjectOtherincomeApi unit test stubs""" def setUp(self) -> None: - self.api = ObjectOtherincomeApi() # noqa: E501 + self.api = ObjectOtherincomeApi() def tearDown(self) -> None: pass @@ -30,7 +30,7 @@ def tearDown(self) -> None: def test_otherincome_get_communication_list_v1(self) -> None: """Test case for otherincome_get_communication_list_v1 - Retrieve Communication list # noqa: E501 + Retrieve Communication list """ pass diff --git a/test/test_object_paymentterm_api.py b/test/test_object_paymentterm_api.py index c99bbb54a..88c3fddd2 100644 --- a/test/test_object_paymentterm_api.py +++ b/test/test_object_paymentterm_api.py @@ -15,14 +15,14 @@ import unittest -from eZmaxApi.api.object_paymentterm_api import ObjectPaymenttermApi # noqa: E501 +from eZmaxApi.api.object_paymentterm_api import ObjectPaymenttermApi class TestObjectPaymenttermApi(unittest.TestCase): """ObjectPaymenttermApi unit test stubs""" def setUp(self) -> None: - self.api = ObjectPaymenttermApi() # noqa: E501 + self.api = ObjectPaymenttermApi() def tearDown(self) -> None: pass @@ -30,35 +30,35 @@ def tearDown(self) -> None: def test_paymentterm_create_object_v1(self) -> None: """Test case for paymentterm_create_object_v1 - Create a new Paymentterm # noqa: E501 + Create a new Paymentterm """ pass def test_paymentterm_edit_object_v1(self) -> None: """Test case for paymentterm_edit_object_v1 - Edit an existing Paymentterm # noqa: E501 + Edit an existing Paymentterm """ pass def test_paymentterm_get_autocomplete_v2(self) -> None: """Test case for paymentterm_get_autocomplete_v2 - Retrieve Paymentterms and IDs # noqa: E501 + Retrieve Paymentterms and IDs """ pass def test_paymentterm_get_list_v1(self) -> None: """Test case for paymentterm_get_list_v1 - Retrieve Paymentterm list # noqa: E501 + Retrieve Paymentterm list """ pass def test_paymentterm_get_object_v2(self) -> None: """Test case for paymentterm_get_object_v2 - Retrieve an existing Paymentterm # noqa: E501 + Retrieve an existing Paymentterm """ pass diff --git a/test/test_object_period_api.py b/test/test_object_period_api.py index 8d778da5c..fa7f1cb7a 100644 --- a/test/test_object_period_api.py +++ b/test/test_object_period_api.py @@ -15,14 +15,14 @@ import unittest -from eZmaxApi.api.object_period_api import ObjectPeriodApi # noqa: E501 +from eZmaxApi.api.object_period_api import ObjectPeriodApi class TestObjectPeriodApi(unittest.TestCase): """ObjectPeriodApi unit test stubs""" def setUp(self) -> None: - self.api = ObjectPeriodApi() # noqa: E501 + self.api = ObjectPeriodApi() def tearDown(self) -> None: pass @@ -30,14 +30,14 @@ def tearDown(self) -> None: def test_period_get_autocomplete_v1(self) -> None: """Test case for period_get_autocomplete_v1 - Retrieve Periods and IDs # noqa: E501 + Retrieve Periods and IDs """ pass def test_period_get_autocomplete_v2(self) -> None: """Test case for period_get_autocomplete_v2 - Retrieve Periods and IDs # noqa: E501 + Retrieve Periods and IDs """ pass diff --git a/test/test_object_permission_api.py b/test/test_object_permission_api.py index 340a5806e..751c83c4e 100644 --- a/test/test_object_permission_api.py +++ b/test/test_object_permission_api.py @@ -15,14 +15,14 @@ import unittest -from eZmaxApi.api.object_permission_api import ObjectPermissionApi # noqa: E501 +from eZmaxApi.api.object_permission_api import ObjectPermissionApi class TestObjectPermissionApi(unittest.TestCase): """ObjectPermissionApi unit test stubs""" def setUp(self) -> None: - self.api = ObjectPermissionApi() # noqa: E501 + self.api = ObjectPermissionApi() def tearDown(self) -> None: pass @@ -30,28 +30,28 @@ def tearDown(self) -> None: def test_permission_create_object_v1(self) -> None: """Test case for permission_create_object_v1 - Create a new Permission # noqa: E501 + Create a new Permission """ pass def test_permission_delete_object_v1(self) -> None: """Test case for permission_delete_object_v1 - Delete an existing Permission # noqa: E501 + Delete an existing Permission """ pass def test_permission_edit_object_v1(self) -> None: """Test case for permission_edit_object_v1 - Edit an existing Permission # noqa: E501 + Edit an existing Permission """ pass def test_permission_get_object_v2(self) -> None: """Test case for permission_get_object_v2 - Retrieve an existing Permission # noqa: E501 + Retrieve an existing Permission """ pass diff --git a/test/test_object_phonetype_api.py b/test/test_object_phonetype_api.py index 17390ad7b..4a3cce1d9 100644 --- a/test/test_object_phonetype_api.py +++ b/test/test_object_phonetype_api.py @@ -15,14 +15,14 @@ import unittest -from eZmaxApi.api.object_phonetype_api import ObjectPhonetypeApi # noqa: E501 +from eZmaxApi.api.object_phonetype_api import ObjectPhonetypeApi class TestObjectPhonetypeApi(unittest.TestCase): """ObjectPhonetypeApi unit test stubs""" def setUp(self) -> None: - self.api = ObjectPhonetypeApi() # noqa: E501 + self.api = ObjectPhonetypeApi() def tearDown(self) -> None: pass @@ -30,7 +30,7 @@ def tearDown(self) -> None: def test_phonetype_get_autocomplete_v2(self) -> None: """Test case for phonetype_get_autocomplete_v2 - Retrieve Phonetypes and IDs # noqa: E501 + Retrieve Phonetypes and IDs """ pass diff --git a/test/test_object_rejectedoffertopurchase_api.py b/test/test_object_rejectedoffertopurchase_api.py index 4815d8c5e..25f830c67 100644 --- a/test/test_object_rejectedoffertopurchase_api.py +++ b/test/test_object_rejectedoffertopurchase_api.py @@ -15,14 +15,14 @@ import unittest -from eZmaxApi.api.object_rejectedoffertopurchase_api import ObjectRejectedoffertopurchaseApi # noqa: E501 +from eZmaxApi.api.object_rejectedoffertopurchase_api import ObjectRejectedoffertopurchaseApi class TestObjectRejectedoffertopurchaseApi(unittest.TestCase): """ObjectRejectedoffertopurchaseApi unit test stubs""" def setUp(self) -> None: - self.api = ObjectRejectedoffertopurchaseApi() # noqa: E501 + self.api = ObjectRejectedoffertopurchaseApi() def tearDown(self) -> None: pass @@ -30,7 +30,7 @@ def tearDown(self) -> None: def test_rejectedoffertopurchase_get_communication_list_v1(self) -> None: """Test case for rejectedoffertopurchase_get_communication_list_v1 - Retrieve Communication list # noqa: E501 + Retrieve Communication list """ pass diff --git a/test/test_object_secretquestion_api.py b/test/test_object_secretquestion_api.py index 146b1aed0..4795a8cdf 100644 --- a/test/test_object_secretquestion_api.py +++ b/test/test_object_secretquestion_api.py @@ -15,14 +15,14 @@ import unittest -from eZmaxApi.api.object_secretquestion_api import ObjectSecretquestionApi # noqa: E501 +from eZmaxApi.api.object_secretquestion_api import ObjectSecretquestionApi class TestObjectSecretquestionApi(unittest.TestCase): """ObjectSecretquestionApi unit test stubs""" def setUp(self) -> None: - self.api = ObjectSecretquestionApi() # noqa: E501 + self.api = ObjectSecretquestionApi() def tearDown(self) -> None: pass @@ -30,7 +30,7 @@ def tearDown(self) -> None: def test_secretquestion_get_autocomplete_v2(self) -> None: """Test case for secretquestion_get_autocomplete_v2 - Retrieve Secretquestions and IDs # noqa: E501 + Retrieve Secretquestions and IDs """ pass diff --git a/test/test_object_sessionhistory_api.py b/test/test_object_sessionhistory_api.py index 4ab2728bd..93aca56b0 100644 --- a/test/test_object_sessionhistory_api.py +++ b/test/test_object_sessionhistory_api.py @@ -15,14 +15,14 @@ import unittest -from eZmaxApi.api.object_sessionhistory_api import ObjectSessionhistoryApi # noqa: E501 +from eZmaxApi.api.object_sessionhistory_api import ObjectSessionhistoryApi class TestObjectSessionhistoryApi(unittest.TestCase): """ObjectSessionhistoryApi unit test stubs""" def setUp(self) -> None: - self.api = ObjectSessionhistoryApi() # noqa: E501 + self.api = ObjectSessionhistoryApi() def tearDown(self) -> None: pass @@ -30,7 +30,7 @@ def tearDown(self) -> None: def test_sessionhistory_get_list_v1(self) -> None: """Test case for sessionhistory_get_list_v1 - Retrieve Sessionhistory list # noqa: E501 + Retrieve Sessionhistory list """ pass diff --git a/test/test_object_signature_api.py b/test/test_object_signature_api.py index 408e3ee6c..8c3cd00dc 100644 --- a/test/test_object_signature_api.py +++ b/test/test_object_signature_api.py @@ -15,14 +15,14 @@ import unittest -from eZmaxApi.api.object_signature_api import ObjectSignatureApi # noqa: E501 +from eZmaxApi.api.object_signature_api import ObjectSignatureApi class TestObjectSignatureApi(unittest.TestCase): """ObjectSignatureApi unit test stubs""" def setUp(self) -> None: - self.api = ObjectSignatureApi() # noqa: E501 + self.api = ObjectSignatureApi() def tearDown(self) -> None: pass @@ -30,28 +30,28 @@ def tearDown(self) -> None: def test_signature_create_object_v1(self) -> None: """Test case for signature_create_object_v1 - Create a new Signature # noqa: E501 + Create a new Signature """ pass def test_signature_delete_object_v1(self) -> None: """Test case for signature_delete_object_v1 - Delete an existing Signature # noqa: E501 + Delete an existing Signature """ pass def test_signature_edit_object_v1(self) -> None: """Test case for signature_edit_object_v1 - Edit an existing Signature # noqa: E501 + Edit an existing Signature """ pass def test_signature_get_object_v2(self) -> None: """Test case for signature_get_object_v2 - Retrieve an existing Signature # noqa: E501 + Retrieve an existing Signature """ pass diff --git a/test/test_object_subnet_api.py b/test/test_object_subnet_api.py index 955e7993f..e5b8ede38 100644 --- a/test/test_object_subnet_api.py +++ b/test/test_object_subnet_api.py @@ -15,14 +15,14 @@ import unittest -from eZmaxApi.api.object_subnet_api import ObjectSubnetApi # noqa: E501 +from eZmaxApi.api.object_subnet_api import ObjectSubnetApi class TestObjectSubnetApi(unittest.TestCase): """ObjectSubnetApi unit test stubs""" def setUp(self) -> None: - self.api = ObjectSubnetApi() # noqa: E501 + self.api = ObjectSubnetApi() def tearDown(self) -> None: pass @@ -30,28 +30,28 @@ def tearDown(self) -> None: def test_subnet_create_object_v1(self) -> None: """Test case for subnet_create_object_v1 - Create a new Subnet # noqa: E501 + Create a new Subnet """ pass def test_subnet_delete_object_v1(self) -> None: """Test case for subnet_delete_object_v1 - Delete an existing Subnet # noqa: E501 + Delete an existing Subnet """ pass def test_subnet_edit_object_v1(self) -> None: """Test case for subnet_edit_object_v1 - Edit an existing Subnet # noqa: E501 + Edit an existing Subnet """ pass def test_subnet_get_object_v2(self) -> None: """Test case for subnet_get_object_v2 - Retrieve an existing Subnet # noqa: E501 + Retrieve an existing Subnet """ pass diff --git a/test/test_object_systemconfiguration_api.py b/test/test_object_systemconfiguration_api.py index 3ae31a6c9..81cdcbf91 100644 --- a/test/test_object_systemconfiguration_api.py +++ b/test/test_object_systemconfiguration_api.py @@ -15,14 +15,14 @@ import unittest -from eZmaxApi.api.object_systemconfiguration_api import ObjectSystemconfigurationApi # noqa: E501 +from eZmaxApi.api.object_systemconfiguration_api import ObjectSystemconfigurationApi class TestObjectSystemconfigurationApi(unittest.TestCase): """ObjectSystemconfigurationApi unit test stubs""" def setUp(self) -> None: - self.api = ObjectSystemconfigurationApi() # noqa: E501 + self.api = ObjectSystemconfigurationApi() def tearDown(self) -> None: pass @@ -30,14 +30,14 @@ def tearDown(self) -> None: def test_systemconfiguration_edit_object_v1(self) -> None: """Test case for systemconfiguration_edit_object_v1 - Edit an existing Systemconfiguration # noqa: E501 + Edit an existing Systemconfiguration """ pass def test_systemconfiguration_get_object_v2(self) -> None: """Test case for systemconfiguration_get_object_v2 - Retrieve an existing Systemconfiguration # noqa: E501 + Retrieve an existing Systemconfiguration """ pass diff --git a/test/test_object_taxassignment_api.py b/test/test_object_taxassignment_api.py index e879f671c..361d02d12 100644 --- a/test/test_object_taxassignment_api.py +++ b/test/test_object_taxassignment_api.py @@ -15,14 +15,14 @@ import unittest -from eZmaxApi.api.object_taxassignment_api import ObjectTaxassignmentApi # noqa: E501 +from eZmaxApi.api.object_taxassignment_api import ObjectTaxassignmentApi class TestObjectTaxassignmentApi(unittest.TestCase): """ObjectTaxassignmentApi unit test stubs""" def setUp(self) -> None: - self.api = ObjectTaxassignmentApi() # noqa: E501 + self.api = ObjectTaxassignmentApi() def tearDown(self) -> None: pass @@ -30,7 +30,7 @@ def tearDown(self) -> None: def test_taxassignment_get_autocomplete_v2(self) -> None: """Test case for taxassignment_get_autocomplete_v2 - Retrieve Taxassignments and IDs # noqa: E501 + Retrieve Taxassignments and IDs """ pass diff --git a/test/test_object_timezone_api.py b/test/test_object_timezone_api.py index 243e36f04..71e691419 100644 --- a/test/test_object_timezone_api.py +++ b/test/test_object_timezone_api.py @@ -15,14 +15,14 @@ import unittest -from eZmaxApi.api.object_timezone_api import ObjectTimezoneApi # noqa: E501 +from eZmaxApi.api.object_timezone_api import ObjectTimezoneApi class TestObjectTimezoneApi(unittest.TestCase): """ObjectTimezoneApi unit test stubs""" def setUp(self) -> None: - self.api = ObjectTimezoneApi() # noqa: E501 + self.api = ObjectTimezoneApi() def tearDown(self) -> None: pass @@ -30,7 +30,7 @@ def tearDown(self) -> None: def test_timezone_get_autocomplete_v2(self) -> None: """Test case for timezone_get_autocomplete_v2 - Retrieve Timezones and IDs # noqa: E501 + Retrieve Timezones and IDs """ pass diff --git a/test/test_object_user_api.py b/test/test_object_user_api.py index ae349c03c..c2513ee21 100644 --- a/test/test_object_user_api.py +++ b/test/test_object_user_api.py @@ -15,14 +15,14 @@ import unittest -from eZmaxApi.api.object_user_api import ObjectUserApi # noqa: E501 +from eZmaxApi.api.object_user_api import ObjectUserApi class TestObjectUserApi(unittest.TestCase): """ObjectUserApi unit test stubs""" def setUp(self) -> None: - self.api = ObjectUserApi() # noqa: E501 + self.api = ObjectUserApi() def tearDown(self) -> None: pass @@ -30,77 +30,77 @@ def tearDown(self) -> None: def test_user_create_object_v1(self) -> None: """Test case for user_create_object_v1 - Create a new User # noqa: E501 + Create a new User """ pass def test_user_edit_object_v1(self) -> None: """Test case for user_edit_object_v1 - Edit an existing User # noqa: E501 + Edit an existing User """ pass def test_user_edit_permissions_v1(self) -> None: """Test case for user_edit_permissions_v1 - Edit multiple Permissions # noqa: E501 + Edit multiple Permissions """ pass def test_user_get_apikeys_v1(self) -> None: """Test case for user_get_apikeys_v1 - Retrieve an existing User's Apikeys # noqa: E501 + Retrieve an existing User's Apikeys """ pass def test_user_get_autocomplete_v2(self) -> None: """Test case for user_get_autocomplete_v2 - Retrieve Users and IDs # noqa: E501 + Retrieve Users and IDs """ pass def test_user_get_effective_permissions_v1(self) -> None: """Test case for user_get_effective_permissions_v1 - Retrieve an existing User's Effective Permissions # noqa: E501 + Retrieve an existing User's Effective Permissions """ pass def test_user_get_list_v1(self) -> None: """Test case for user_get_list_v1 - Retrieve User list # noqa: E501 + Retrieve User list """ pass def test_user_get_object_v2(self) -> None: """Test case for user_get_object_v2 - Retrieve an existing User # noqa: E501 + Retrieve an existing User """ pass def test_user_get_permissions_v1(self) -> None: """Test case for user_get_permissions_v1 - Retrieve an existing User's Permissions # noqa: E501 + Retrieve an existing User's Permissions """ pass def test_user_get_subnets_v1(self) -> None: """Test case for user_get_subnets_v1 - Retrieve an existing User's Subnets # noqa: E501 + Retrieve an existing User's Subnets """ pass def test_user_send_password_reset_v1(self) -> None: """Test case for user_send_password_reset_v1 - Send password reset # noqa: E501 + Send password reset """ pass diff --git a/test/test_object_usergroup_api.py b/test/test_object_usergroup_api.py index 480ddfa69..483f43cfd 100644 --- a/test/test_object_usergroup_api.py +++ b/test/test_object_usergroup_api.py @@ -15,14 +15,14 @@ import unittest -from eZmaxApi.api.object_usergroup_api import ObjectUsergroupApi # noqa: E501 +from eZmaxApi.api.object_usergroup_api import ObjectUsergroupApi class TestObjectUsergroupApi(unittest.TestCase): """ObjectUsergroupApi unit test stubs""" def setUp(self) -> None: - self.api = ObjectUsergroupApi() # noqa: E501 + self.api = ObjectUsergroupApi() def tearDown(self) -> None: pass @@ -30,77 +30,77 @@ def tearDown(self) -> None: def test_usergroup_create_object_v1(self) -> None: """Test case for usergroup_create_object_v1 - Create a new Usergroup # noqa: E501 + Create a new Usergroup """ pass def test_usergroup_edit_object_v1(self) -> None: """Test case for usergroup_edit_object_v1 - Edit an existing Usergroup # noqa: E501 + Edit an existing Usergroup """ pass def test_usergroup_edit_permissions_v1(self) -> None: """Test case for usergroup_edit_permissions_v1 - Edit multiple Permissions # noqa: E501 + Edit multiple Permissions """ pass def test_usergroup_edit_usergroupdelegations_v1(self) -> None: """Test case for usergroup_edit_usergroupdelegations_v1 - Edit multiple Usergroupdelegations # noqa: E501 + Edit multiple Usergroupdelegations """ pass def test_usergroup_edit_usergroupmemberships_v1(self) -> None: """Test case for usergroup_edit_usergroupmemberships_v1 - Edit multiple Usergroupmemberships # noqa: E501 + Edit multiple Usergroupmemberships """ pass def test_usergroup_get_autocomplete_v2(self) -> None: """Test case for usergroup_get_autocomplete_v2 - Retrieve Usergroups and IDs # noqa: E501 + Retrieve Usergroups and IDs """ pass def test_usergroup_get_list_v1(self) -> None: """Test case for usergroup_get_list_v1 - Retrieve Usergroup list # noqa: E501 + Retrieve Usergroup list """ pass def test_usergroup_get_object_v2(self) -> None: """Test case for usergroup_get_object_v2 - Retrieve an existing Usergroup # noqa: E501 + Retrieve an existing Usergroup """ pass def test_usergroup_get_permissions_v1(self) -> None: """Test case for usergroup_get_permissions_v1 - Retrieve an existing Usergroup's Permissions # noqa: E501 + Retrieve an existing Usergroup's Permissions """ pass def test_usergroup_get_usergroupdelegations_v1(self) -> None: """Test case for usergroup_get_usergroupdelegations_v1 - Retrieve an existing Usergroup's Usergroupdelegations # noqa: E501 + Retrieve an existing Usergroup's Usergroupdelegations """ pass def test_usergroup_get_usergroupmemberships_v1(self) -> None: """Test case for usergroup_get_usergroupmemberships_v1 - Retrieve an existing Usergroup's Usergroupmemberships # noqa: E501 + Retrieve an existing Usergroup's Usergroupmemberships """ pass diff --git a/test/test_object_usergroupdelegation_api.py b/test/test_object_usergroupdelegation_api.py index 452fa9ee4..7058afa24 100644 --- a/test/test_object_usergroupdelegation_api.py +++ b/test/test_object_usergroupdelegation_api.py @@ -15,14 +15,14 @@ import unittest -from eZmaxApi.api.object_usergroupdelegation_api import ObjectUsergroupdelegationApi # noqa: E501 +from eZmaxApi.api.object_usergroupdelegation_api import ObjectUsergroupdelegationApi class TestObjectUsergroupdelegationApi(unittest.TestCase): """ObjectUsergroupdelegationApi unit test stubs""" def setUp(self) -> None: - self.api = ObjectUsergroupdelegationApi() # noqa: E501 + self.api = ObjectUsergroupdelegationApi() def tearDown(self) -> None: pass @@ -30,28 +30,28 @@ def tearDown(self) -> None: def test_usergroupdelegation_create_object_v1(self) -> None: """Test case for usergroupdelegation_create_object_v1 - Create a new Usergroupdelegation # noqa: E501 + Create a new Usergroupdelegation """ pass def test_usergroupdelegation_delete_object_v1(self) -> None: """Test case for usergroupdelegation_delete_object_v1 - Delete an existing Usergroupdelegation # noqa: E501 + Delete an existing Usergroupdelegation """ pass def test_usergroupdelegation_edit_object_v1(self) -> None: """Test case for usergroupdelegation_edit_object_v1 - Edit an existing Usergroupdelegation # noqa: E501 + Edit an existing Usergroupdelegation """ pass def test_usergroupdelegation_get_object_v2(self) -> None: """Test case for usergroupdelegation_get_object_v2 - Retrieve an existing Usergroupdelegation # noqa: E501 + Retrieve an existing Usergroupdelegation """ pass diff --git a/test/test_object_usergroupmembership_api.py b/test/test_object_usergroupmembership_api.py index f5bd5585f..690e768cc 100644 --- a/test/test_object_usergroupmembership_api.py +++ b/test/test_object_usergroupmembership_api.py @@ -15,14 +15,14 @@ import unittest -from eZmaxApi.api.object_usergroupmembership_api import ObjectUsergroupmembershipApi # noqa: E501 +from eZmaxApi.api.object_usergroupmembership_api import ObjectUsergroupmembershipApi class TestObjectUsergroupmembershipApi(unittest.TestCase): """ObjectUsergroupmembershipApi unit test stubs""" def setUp(self) -> None: - self.api = ObjectUsergroupmembershipApi() # noqa: E501 + self.api = ObjectUsergroupmembershipApi() def tearDown(self) -> None: pass @@ -30,28 +30,28 @@ def tearDown(self) -> None: def test_usergroupmembership_create_object_v1(self) -> None: """Test case for usergroupmembership_create_object_v1 - Create a new Usergroupmembership # noqa: E501 + Create a new Usergroupmembership """ pass def test_usergroupmembership_delete_object_v1(self) -> None: """Test case for usergroupmembership_delete_object_v1 - Delete an existing Usergroupmembership # noqa: E501 + Delete an existing Usergroupmembership """ pass def test_usergroupmembership_edit_object_v1(self) -> None: """Test case for usergroupmembership_edit_object_v1 - Edit an existing Usergroupmembership # noqa: E501 + Edit an existing Usergroupmembership """ pass def test_usergroupmembership_get_object_v2(self) -> None: """Test case for usergroupmembership_get_object_v2 - Retrieve an existing Usergroupmembership # noqa: E501 + Retrieve an existing Usergroupmembership """ pass diff --git a/test/test_object_userlogintype_api.py b/test/test_object_userlogintype_api.py index 73974b19c..48e50eee6 100644 --- a/test/test_object_userlogintype_api.py +++ b/test/test_object_userlogintype_api.py @@ -15,14 +15,14 @@ import unittest -from eZmaxApi.api.object_userlogintype_api import ObjectUserlogintypeApi # noqa: E501 +from eZmaxApi.api.object_userlogintype_api import ObjectUserlogintypeApi class TestObjectUserlogintypeApi(unittest.TestCase): """ObjectUserlogintypeApi unit test stubs""" def setUp(self) -> None: - self.api = ObjectUserlogintypeApi() # noqa: E501 + self.api = ObjectUserlogintypeApi() def tearDown(self) -> None: pass @@ -30,7 +30,7 @@ def tearDown(self) -> None: def test_userlogintype_get_autocomplete_v2(self) -> None: """Test case for userlogintype_get_autocomplete_v2 - Retrieve Userlogintypes and IDs # noqa: E501 + Retrieve Userlogintypes and IDs """ pass diff --git a/test/test_object_userstaged_api.py b/test/test_object_userstaged_api.py index af056a052..114fc08ee 100644 --- a/test/test_object_userstaged_api.py +++ b/test/test_object_userstaged_api.py @@ -15,14 +15,14 @@ import unittest -from eZmaxApi.api.object_userstaged_api import ObjectUserstagedApi # noqa: E501 +from eZmaxApi.api.object_userstaged_api import ObjectUserstagedApi class TestObjectUserstagedApi(unittest.TestCase): """ObjectUserstagedApi unit test stubs""" def setUp(self) -> None: - self.api = ObjectUserstagedApi() # noqa: E501 + self.api = ObjectUserstagedApi() def tearDown(self) -> None: pass @@ -30,35 +30,35 @@ def tearDown(self) -> None: def test_userstaged_create_user_v1(self) -> None: """Test case for userstaged_create_user_v1 - Create a User from a Userstaged and then map it # noqa: E501 + Create a User from a Userstaged and then map it """ pass def test_userstaged_delete_object_v1(self) -> None: """Test case for userstaged_delete_object_v1 - Delete an existing Userstaged # noqa: E501 + Delete an existing Userstaged """ pass def test_userstaged_get_list_v1(self) -> None: """Test case for userstaged_get_list_v1 - Retrieve Userstaged list # noqa: E501 + Retrieve Userstaged list """ pass def test_userstaged_get_object_v2(self) -> None: """Test case for userstaged_get_object_v2 - Retrieve an existing Userstaged # noqa: E501 + Retrieve an existing Userstaged """ pass def test_userstaged_map_v1(self) -> None: """Test case for userstaged_map_v1 - Map the Userstaged to an existing user # noqa: E501 + Map the Userstaged to an existing user """ pass diff --git a/test/test_object_variableexpense_api.py b/test/test_object_variableexpense_api.py index 2aa730de3..fc1825621 100644 --- a/test/test_object_variableexpense_api.py +++ b/test/test_object_variableexpense_api.py @@ -15,14 +15,14 @@ import unittest -from eZmaxApi.api.object_variableexpense_api import ObjectVariableexpenseApi # noqa: E501 +from eZmaxApi.api.object_variableexpense_api import ObjectVariableexpenseApi class TestObjectVariableexpenseApi(unittest.TestCase): """ObjectVariableexpenseApi unit test stubs""" def setUp(self) -> None: - self.api = ObjectVariableexpenseApi() # noqa: E501 + self.api = ObjectVariableexpenseApi() def tearDown(self) -> None: pass @@ -30,35 +30,35 @@ def tearDown(self) -> None: def test_variableexpense_create_object_v1(self) -> None: """Test case for variableexpense_create_object_v1 - Create a new Variableexpense # noqa: E501 + Create a new Variableexpense """ pass def test_variableexpense_edit_object_v1(self) -> None: """Test case for variableexpense_edit_object_v1 - Edit an existing Variableexpense # noqa: E501 + Edit an existing Variableexpense """ pass def test_variableexpense_get_autocomplete_v2(self) -> None: """Test case for variableexpense_get_autocomplete_v2 - Retrieve Variableexpenses and IDs # noqa: E501 + Retrieve Variableexpenses and IDs """ pass def test_variableexpense_get_list_v1(self) -> None: """Test case for variableexpense_get_list_v1 - Retrieve Variableexpense list # noqa: E501 + Retrieve Variableexpense list """ pass def test_variableexpense_get_object_v2(self) -> None: """Test case for variableexpense_get_object_v2 - Retrieve an existing Variableexpense # noqa: E501 + Retrieve an existing Variableexpense """ pass diff --git a/test/test_object_versionhistory_api.py b/test/test_object_versionhistory_api.py index cae11c48b..de0d0b76b 100644 --- a/test/test_object_versionhistory_api.py +++ b/test/test_object_versionhistory_api.py @@ -15,14 +15,14 @@ import unittest -from eZmaxApi.api.object_versionhistory_api import ObjectVersionhistoryApi # noqa: E501 +from eZmaxApi.api.object_versionhistory_api import ObjectVersionhistoryApi class TestObjectVersionhistoryApi(unittest.TestCase): """ObjectVersionhistoryApi unit test stubs""" def setUp(self) -> None: - self.api = ObjectVersionhistoryApi() # noqa: E501 + self.api = ObjectVersionhistoryApi() def tearDown(self) -> None: pass @@ -30,7 +30,7 @@ def tearDown(self) -> None: def test_versionhistory_get_object_v2(self) -> None: """Test case for versionhistory_get_object_v2 - Retrieve an existing Versionhistory # noqa: E501 + Retrieve an existing Versionhistory """ pass diff --git a/test/test_object_webhook_api.py b/test/test_object_webhook_api.py index 9c34d5699..689e928a7 100644 --- a/test/test_object_webhook_api.py +++ b/test/test_object_webhook_api.py @@ -15,14 +15,14 @@ import unittest -from eZmaxApi.api.object_webhook_api import ObjectWebhookApi # noqa: E501 +from eZmaxApi.api.object_webhook_api import ObjectWebhookApi class TestObjectWebhookApi(unittest.TestCase): """ObjectWebhookApi unit test stubs""" def setUp(self) -> None: - self.api = ObjectWebhookApi() # noqa: E501 + self.api = ObjectWebhookApi() def tearDown(self) -> None: pass @@ -30,49 +30,63 @@ def tearDown(self) -> None: def test_webhook_create_object_v1(self) -> None: """Test case for webhook_create_object_v1 - Create a new Webhook # noqa: E501 + Create a new Webhook + """ + pass + + def test_webhook_create_object_v2(self) -> None: + """Test case for webhook_create_object_v2 + + Create a new Webhook """ pass def test_webhook_delete_object_v1(self) -> None: """Test case for webhook_delete_object_v1 - Delete an existing Webhook # noqa: E501 + Delete an existing Webhook """ pass def test_webhook_edit_object_v1(self) -> None: """Test case for webhook_edit_object_v1 - Edit an existing Webhook # noqa: E501 + Edit an existing Webhook """ pass def test_webhook_get_history_v1(self) -> None: """Test case for webhook_get_history_v1 - Retrieve the logs for recent Webhook calls # noqa: E501 + Retrieve the logs for recent Webhook calls """ pass def test_webhook_get_list_v1(self) -> None: """Test case for webhook_get_list_v1 - Retrieve Webhook list # noqa: E501 + Retrieve Webhook list """ pass def test_webhook_get_object_v2(self) -> None: """Test case for webhook_get_object_v2 - Retrieve an existing Webhook # noqa: E501 + Retrieve an existing Webhook + """ + pass + + def test_webhook_regenerate_apikey_v1(self) -> None: + """Test case for webhook_regenerate_apikey_v1 + + Regenerate the Apikey """ pass def test_webhook_test_v1(self) -> None: """Test case for webhook_test_v1 - Test the Webhook by calling the Url # noqa: E501 + Test the Webhook by calling the Url """ pass diff --git a/test/test_otherincome_get_communication_list_v1_response.py b/test/test_otherincome_get_communication_list_v1_response.py index 96eb5967e..00670f797 100644 --- a/test/test_otherincome_get_communication_list_v1_response.py +++ b/test/test_otherincome_get_communication_list_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.otherincome_get_communication_list_v1_response import OtherincomeGetCommunicationListV1Response # noqa: E501 +from eZmaxApi.models.otherincome_get_communication_list_v1_response import OtherincomeGetCommunicationListV1Response class TestOtherincomeGetCommunicationListV1Response(unittest.TestCase): """OtherincomeGetCommunicationListV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> OtherincomeGetCommunicationListV1Re optional params are included """ # uncomment below to create an instance of `OtherincomeGetCommunicationListV1Response` """ - model = OtherincomeGetCommunicationListV1Response() # noqa: E501 + model = OtherincomeGetCommunicationListV1Response() if include_optional: return OtherincomeGetCommunicationListV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload_get_list.Common-Response-objDebugPayload_getList(), diff --git a/test/test_otherincome_get_communication_list_v1_response_m_payload.py b/test/test_otherincome_get_communication_list_v1_response_m_payload.py index 4366e6675..25215cb3c 100644 --- a/test/test_otherincome_get_communication_list_v1_response_m_payload.py +++ b/test/test_otherincome_get_communication_list_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.otherincome_get_communication_list_v1_response_m_payload import OtherincomeGetCommunicationListV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.otherincome_get_communication_list_v1_response_m_payload import OtherincomeGetCommunicationListV1ResponseMPayload class TestOtherincomeGetCommunicationListV1ResponseMPayload(unittest.TestCase): """OtherincomeGetCommunicationListV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> OtherincomeGetCommunicationListV1Re optional params are included """ # uncomment below to create an instance of `OtherincomeGetCommunicationListV1ResponseMPayload` """ - model = OtherincomeGetCommunicationListV1ResponseMPayload() # noqa: E501 + model = OtherincomeGetCommunicationListV1ResponseMPayload() if include_optional: return OtherincomeGetCommunicationListV1ResponseMPayload( a_obj_communication = [ diff --git a/test/test_paymentterm_autocomplete_element_response.py b/test/test_paymentterm_autocomplete_element_response.py index 265be35b8..ce7cce09b 100644 --- a/test/test_paymentterm_autocomplete_element_response.py +++ b/test/test_paymentterm_autocomplete_element_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.paymentterm_autocomplete_element_response import PaymenttermAutocompleteElementResponse # noqa: E501 +from eZmaxApi.models.paymentterm_autocomplete_element_response import PaymenttermAutocompleteElementResponse class TestPaymenttermAutocompleteElementResponse(unittest.TestCase): """PaymenttermAutocompleteElementResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> PaymenttermAutocompleteElementRespo optional params are included """ # uncomment below to create an instance of `PaymenttermAutocompleteElementResponse` """ - model = PaymenttermAutocompleteElementResponse() # noqa: E501 + model = PaymenttermAutocompleteElementResponse() if include_optional: return PaymenttermAutocompleteElementResponse( pki_paymentterm_id = 46, diff --git a/test/test_paymentterm_create_object_v1_request.py b/test/test_paymentterm_create_object_v1_request.py index 84231e1c0..8a80cd5fd 100644 --- a/test/test_paymentterm_create_object_v1_request.py +++ b/test/test_paymentterm_create_object_v1_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.paymentterm_create_object_v1_request import PaymenttermCreateObjectV1Request # noqa: E501 +from eZmaxApi.models.paymentterm_create_object_v1_request import PaymenttermCreateObjectV1Request class TestPaymenttermCreateObjectV1Request(unittest.TestCase): """PaymenttermCreateObjectV1Request unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> PaymenttermCreateObjectV1Request: optional params are included """ # uncomment below to create an instance of `PaymenttermCreateObjectV1Request` """ - model = PaymenttermCreateObjectV1Request() # noqa: E501 + model = PaymenttermCreateObjectV1Request() if include_optional: return PaymenttermCreateObjectV1Request( a_obj_paymentterm = [ diff --git a/test/test_paymentterm_create_object_v1_response.py b/test/test_paymentterm_create_object_v1_response.py index 66e169ddd..87871e536 100644 --- a/test/test_paymentterm_create_object_v1_response.py +++ b/test/test_paymentterm_create_object_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.paymentterm_create_object_v1_response import PaymenttermCreateObjectV1Response # noqa: E501 +from eZmaxApi.models.paymentterm_create_object_v1_response import PaymenttermCreateObjectV1Response class TestPaymenttermCreateObjectV1Response(unittest.TestCase): """PaymenttermCreateObjectV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> PaymenttermCreateObjectV1Response: optional params are included """ # uncomment below to create an instance of `PaymenttermCreateObjectV1Response` """ - model = PaymenttermCreateObjectV1Response() # noqa: E501 + model = PaymenttermCreateObjectV1Response() if include_optional: return PaymenttermCreateObjectV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_paymentterm_create_object_v1_response_m_payload.py b/test/test_paymentterm_create_object_v1_response_m_payload.py index 0a2eaeade..ea4b2682f 100644 --- a/test/test_paymentterm_create_object_v1_response_m_payload.py +++ b/test/test_paymentterm_create_object_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.paymentterm_create_object_v1_response_m_payload import PaymenttermCreateObjectV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.paymentterm_create_object_v1_response_m_payload import PaymenttermCreateObjectV1ResponseMPayload class TestPaymenttermCreateObjectV1ResponseMPayload(unittest.TestCase): """PaymenttermCreateObjectV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> PaymenttermCreateObjectV1ResponseMP optional params are included """ # uncomment below to create an instance of `PaymenttermCreateObjectV1ResponseMPayload` """ - model = PaymenttermCreateObjectV1ResponseMPayload() # noqa: E501 + model = PaymenttermCreateObjectV1ResponseMPayload() if include_optional: return PaymenttermCreateObjectV1ResponseMPayload( a_pki_paymentterm_id = [ diff --git a/test/test_paymentterm_edit_object_v1_request.py b/test/test_paymentterm_edit_object_v1_request.py index adf30bf8d..ebf5b15e9 100644 --- a/test/test_paymentterm_edit_object_v1_request.py +++ b/test/test_paymentterm_edit_object_v1_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.paymentterm_edit_object_v1_request import PaymenttermEditObjectV1Request # noqa: E501 +from eZmaxApi.models.paymentterm_edit_object_v1_request import PaymenttermEditObjectV1Request class TestPaymenttermEditObjectV1Request(unittest.TestCase): """PaymenttermEditObjectV1Request unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> PaymenttermEditObjectV1Request: optional params are included """ # uncomment below to create an instance of `PaymenttermEditObjectV1Request` """ - model = PaymenttermEditObjectV1Request() # noqa: E501 + model = PaymenttermEditObjectV1Request() if include_optional: return PaymenttermEditObjectV1Request( obj_paymentterm = eZmaxApi.models.paymentterm_request_compound.paymentterm-RequestCompound() diff --git a/test/test_paymentterm_edit_object_v1_response.py b/test/test_paymentterm_edit_object_v1_response.py index 20cff48e9..83b219638 100644 --- a/test/test_paymentterm_edit_object_v1_response.py +++ b/test/test_paymentterm_edit_object_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.paymentterm_edit_object_v1_response import PaymenttermEditObjectV1Response # noqa: E501 +from eZmaxApi.models.paymentterm_edit_object_v1_response import PaymenttermEditObjectV1Response class TestPaymenttermEditObjectV1Response(unittest.TestCase): """PaymenttermEditObjectV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> PaymenttermEditObjectV1Response: optional params are included """ # uncomment below to create an instance of `PaymenttermEditObjectV1Response` """ - model = PaymenttermEditObjectV1Response() # noqa: E501 + model = PaymenttermEditObjectV1Response() if include_optional: return PaymenttermEditObjectV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_paymentterm_get_autocomplete_v2_response.py b/test/test_paymentterm_get_autocomplete_v2_response.py index 6def27dbb..177a35412 100644 --- a/test/test_paymentterm_get_autocomplete_v2_response.py +++ b/test/test_paymentterm_get_autocomplete_v2_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.paymentterm_get_autocomplete_v2_response import PaymenttermGetAutocompleteV2Response # noqa: E501 +from eZmaxApi.models.paymentterm_get_autocomplete_v2_response import PaymenttermGetAutocompleteV2Response class TestPaymenttermGetAutocompleteV2Response(unittest.TestCase): """PaymenttermGetAutocompleteV2Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> PaymenttermGetAutocompleteV2Respons optional params are included """ # uncomment below to create an instance of `PaymenttermGetAutocompleteV2Response` """ - model = PaymenttermGetAutocompleteV2Response() # noqa: E501 + model = PaymenttermGetAutocompleteV2Response() if include_optional: return PaymenttermGetAutocompleteV2Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_paymentterm_get_autocomplete_v2_response_m_payload.py b/test/test_paymentterm_get_autocomplete_v2_response_m_payload.py index db0e0d5b9..bd52a82c3 100644 --- a/test/test_paymentterm_get_autocomplete_v2_response_m_payload.py +++ b/test/test_paymentterm_get_autocomplete_v2_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.paymentterm_get_autocomplete_v2_response_m_payload import PaymenttermGetAutocompleteV2ResponseMPayload # noqa: E501 +from eZmaxApi.models.paymentterm_get_autocomplete_v2_response_m_payload import PaymenttermGetAutocompleteV2ResponseMPayload class TestPaymenttermGetAutocompleteV2ResponseMPayload(unittest.TestCase): """PaymenttermGetAutocompleteV2ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> PaymenttermGetAutocompleteV2Respons optional params are included """ # uncomment below to create an instance of `PaymenttermGetAutocompleteV2ResponseMPayload` """ - model = PaymenttermGetAutocompleteV2ResponseMPayload() # noqa: E501 + model = PaymenttermGetAutocompleteV2ResponseMPayload() if include_optional: return PaymenttermGetAutocompleteV2ResponseMPayload( a_obj_paymentterm = [ diff --git a/test/test_paymentterm_get_list_v1_response.py b/test/test_paymentterm_get_list_v1_response.py index 0ba5f6e8d..97a8e4c8e 100644 --- a/test/test_paymentterm_get_list_v1_response.py +++ b/test/test_paymentterm_get_list_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.paymentterm_get_list_v1_response import PaymenttermGetListV1Response # noqa: E501 +from eZmaxApi.models.paymentterm_get_list_v1_response import PaymenttermGetListV1Response class TestPaymenttermGetListV1Response(unittest.TestCase): """PaymenttermGetListV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> PaymenttermGetListV1Response: optional params are included """ # uncomment below to create an instance of `PaymenttermGetListV1Response` """ - model = PaymenttermGetListV1Response() # noqa: E501 + model = PaymenttermGetListV1Response() if include_optional: return PaymenttermGetListV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload_get_list.Common-Response-objDebugPayload_getList(), diff --git a/test/test_paymentterm_get_list_v1_response_m_payload.py b/test/test_paymentterm_get_list_v1_response_m_payload.py index 3ebd8cffe..d0f2930ef 100644 --- a/test/test_paymentterm_get_list_v1_response_m_payload.py +++ b/test/test_paymentterm_get_list_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.paymentterm_get_list_v1_response_m_payload import PaymenttermGetListV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.paymentterm_get_list_v1_response_m_payload import PaymenttermGetListV1ResponseMPayload class TestPaymenttermGetListV1ResponseMPayload(unittest.TestCase): """PaymenttermGetListV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> PaymenttermGetListV1ResponseMPayloa optional params are included """ # uncomment below to create an instance of `PaymenttermGetListV1ResponseMPayload` """ - model = PaymenttermGetListV1ResponseMPayload() # noqa: E501 + model = PaymenttermGetListV1ResponseMPayload() if include_optional: return PaymenttermGetListV1ResponseMPayload( i_row_returned = 100, diff --git a/test/test_paymentterm_get_object_v2_response.py b/test/test_paymentterm_get_object_v2_response.py index 80236bda5..8dc262d3c 100644 --- a/test/test_paymentterm_get_object_v2_response.py +++ b/test/test_paymentterm_get_object_v2_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.paymentterm_get_object_v2_response import PaymenttermGetObjectV2Response # noqa: E501 +from eZmaxApi.models.paymentterm_get_object_v2_response import PaymenttermGetObjectV2Response class TestPaymenttermGetObjectV2Response(unittest.TestCase): """PaymenttermGetObjectV2Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> PaymenttermGetObjectV2Response: optional params are included """ # uncomment below to create an instance of `PaymenttermGetObjectV2Response` """ - model = PaymenttermGetObjectV2Response() # noqa: E501 + model = PaymenttermGetObjectV2Response() if include_optional: return PaymenttermGetObjectV2Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_paymentterm_get_object_v2_response_m_payload.py b/test/test_paymentterm_get_object_v2_response_m_payload.py index 432318f88..bd13fa59a 100644 --- a/test/test_paymentterm_get_object_v2_response_m_payload.py +++ b/test/test_paymentterm_get_object_v2_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.paymentterm_get_object_v2_response_m_payload import PaymenttermGetObjectV2ResponseMPayload # noqa: E501 +from eZmaxApi.models.paymentterm_get_object_v2_response_m_payload import PaymenttermGetObjectV2ResponseMPayload class TestPaymenttermGetObjectV2ResponseMPayload(unittest.TestCase): """PaymenttermGetObjectV2ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> PaymenttermGetObjectV2ResponseMPayl optional params are included """ # uncomment below to create an instance of `PaymenttermGetObjectV2ResponseMPayload` """ - model = PaymenttermGetObjectV2ResponseMPayload() # noqa: E501 + model = PaymenttermGetObjectV2ResponseMPayload() if include_optional: return PaymenttermGetObjectV2ResponseMPayload( obj_paymentterm = eZmaxApi.models.paymentterm_response_compound.paymentterm-ResponseCompound() diff --git a/test/test_paymentterm_list_element.py b/test/test_paymentterm_list_element.py index 8c5ce3056..8a72e9b28 100644 --- a/test/test_paymentterm_list_element.py +++ b/test/test_paymentterm_list_element.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.paymentterm_list_element import PaymenttermListElement # noqa: E501 +from eZmaxApi.models.paymentterm_list_element import PaymenttermListElement class TestPaymenttermListElement(unittest.TestCase): """PaymenttermListElement unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> PaymenttermListElement: optional params are included """ # uncomment below to create an instance of `PaymenttermListElement` """ - model = PaymenttermListElement() # noqa: E501 + model = PaymenttermListElement() if include_optional: return PaymenttermListElement( pki_paymentterm_id = 46, diff --git a/test/test_paymentterm_request.py b/test/test_paymentterm_request.py index 917f02014..4bf4070e3 100644 --- a/test/test_paymentterm_request.py +++ b/test/test_paymentterm_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.paymentterm_request import PaymenttermRequest # noqa: E501 +from eZmaxApi.models.paymentterm_request import PaymenttermRequest class TestPaymenttermRequest(unittest.TestCase): """PaymenttermRequest unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> PaymenttermRequest: optional params are included """ # uncomment below to create an instance of `PaymenttermRequest` """ - model = PaymenttermRequest() # noqa: E501 + model = PaymenttermRequest() if include_optional: return PaymenttermRequest( pki_paymentterm_id = 46, diff --git a/test/test_paymentterm_request_compound.py b/test/test_paymentterm_request_compound.py index 929e36c9d..6f29ddb08 100644 --- a/test/test_paymentterm_request_compound.py +++ b/test/test_paymentterm_request_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.paymentterm_request_compound import PaymenttermRequestCompound # noqa: E501 +from eZmaxApi.models.paymentterm_request_compound import PaymenttermRequestCompound class TestPaymenttermRequestCompound(unittest.TestCase): """PaymenttermRequestCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> PaymenttermRequestCompound: optional params are included """ # uncomment below to create an instance of `PaymenttermRequestCompound` """ - model = PaymenttermRequestCompound() # noqa: E501 + model = PaymenttermRequestCompound() if include_optional: return PaymenttermRequestCompound( pki_paymentterm_id = 46, diff --git a/test/test_paymentterm_response.py b/test/test_paymentterm_response.py index a3b848d3e..80fdce3c3 100644 --- a/test/test_paymentterm_response.py +++ b/test/test_paymentterm_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.paymentterm_response import PaymenttermResponse # noqa: E501 +from eZmaxApi.models.paymentterm_response import PaymenttermResponse class TestPaymenttermResponse(unittest.TestCase): """PaymenttermResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> PaymenttermResponse: optional params are included """ # uncomment below to create an instance of `PaymenttermResponse` """ - model = PaymenttermResponse() # noqa: E501 + model = PaymenttermResponse() if include_optional: return PaymenttermResponse( pki_paymentterm_id = 46, diff --git a/test/test_paymentterm_response_compound.py b/test/test_paymentterm_response_compound.py index 7918a5937..6c349f1bb 100644 --- a/test/test_paymentterm_response_compound.py +++ b/test/test_paymentterm_response_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.paymentterm_response_compound import PaymenttermResponseCompound # noqa: E501 +from eZmaxApi.models.paymentterm_response_compound import PaymenttermResponseCompound class TestPaymenttermResponseCompound(unittest.TestCase): """PaymenttermResponseCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> PaymenttermResponseCompound: optional params are included """ # uncomment below to create an instance of `PaymenttermResponseCompound` """ - model = PaymenttermResponseCompound() # noqa: E501 + model = PaymenttermResponseCompound() if include_optional: return PaymenttermResponseCompound( pki_paymentterm_id = 46, diff --git a/test/test_period_autocomplete_element_response.py b/test/test_period_autocomplete_element_response.py index 3a56217bf..83be93840 100644 --- a/test/test_period_autocomplete_element_response.py +++ b/test/test_period_autocomplete_element_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.period_autocomplete_element_response import PeriodAutocompleteElementResponse # noqa: E501 +from eZmaxApi.models.period_autocomplete_element_response import PeriodAutocompleteElementResponse class TestPeriodAutocompleteElementResponse(unittest.TestCase): """PeriodAutocompleteElementResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> PeriodAutocompleteElementResponse: optional params are included """ # uncomment below to create an instance of `PeriodAutocompleteElementResponse` """ - model = PeriodAutocompleteElementResponse() # noqa: E501 + model = PeriodAutocompleteElementResponse() if include_optional: return PeriodAutocompleteElementResponse( s_period_yyyymm = '2202-12', diff --git a/test/test_period_get_autocomplete_v2_response.py b/test/test_period_get_autocomplete_v2_response.py index 1b4c3842a..536b034c5 100644 --- a/test/test_period_get_autocomplete_v2_response.py +++ b/test/test_period_get_autocomplete_v2_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.period_get_autocomplete_v2_response import PeriodGetAutocompleteV2Response # noqa: E501 +from eZmaxApi.models.period_get_autocomplete_v2_response import PeriodGetAutocompleteV2Response class TestPeriodGetAutocompleteV2Response(unittest.TestCase): """PeriodGetAutocompleteV2Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> PeriodGetAutocompleteV2Response: optional params are included """ # uncomment below to create an instance of `PeriodGetAutocompleteV2Response` """ - model = PeriodGetAutocompleteV2Response() # noqa: E501 + model = PeriodGetAutocompleteV2Response() if include_optional: return PeriodGetAutocompleteV2Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_period_get_autocomplete_v2_response_m_payload.py b/test/test_period_get_autocomplete_v2_response_m_payload.py index ad0e5389c..8bd46880b 100644 --- a/test/test_period_get_autocomplete_v2_response_m_payload.py +++ b/test/test_period_get_autocomplete_v2_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.period_get_autocomplete_v2_response_m_payload import PeriodGetAutocompleteV2ResponseMPayload # noqa: E501 +from eZmaxApi.models.period_get_autocomplete_v2_response_m_payload import PeriodGetAutocompleteV2ResponseMPayload class TestPeriodGetAutocompleteV2ResponseMPayload(unittest.TestCase): """PeriodGetAutocompleteV2ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> PeriodGetAutocompleteV2ResponseMPay optional params are included """ # uncomment below to create an instance of `PeriodGetAutocompleteV2ResponseMPayload` """ - model = PeriodGetAutocompleteV2ResponseMPayload() # noqa: E501 + model = PeriodGetAutocompleteV2ResponseMPayload() if include_optional: return PeriodGetAutocompleteV2ResponseMPayload( a_obj_period = [ diff --git a/test/test_permission_create_object_v1_request.py b/test/test_permission_create_object_v1_request.py index e38502c52..679302b65 100644 --- a/test/test_permission_create_object_v1_request.py +++ b/test/test_permission_create_object_v1_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.permission_create_object_v1_request import PermissionCreateObjectV1Request # noqa: E501 +from eZmaxApi.models.permission_create_object_v1_request import PermissionCreateObjectV1Request class TestPermissionCreateObjectV1Request(unittest.TestCase): """PermissionCreateObjectV1Request unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> PermissionCreateObjectV1Request: optional params are included """ # uncomment below to create an instance of `PermissionCreateObjectV1Request` """ - model = PermissionCreateObjectV1Request() # noqa: E501 + model = PermissionCreateObjectV1Request() if include_optional: return PermissionCreateObjectV1Request( a_obj_permission = [ diff --git a/test/test_permission_create_object_v1_response.py b/test/test_permission_create_object_v1_response.py index 55736b11c..8a9c7d624 100644 --- a/test/test_permission_create_object_v1_response.py +++ b/test/test_permission_create_object_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.permission_create_object_v1_response import PermissionCreateObjectV1Response # noqa: E501 +from eZmaxApi.models.permission_create_object_v1_response import PermissionCreateObjectV1Response class TestPermissionCreateObjectV1Response(unittest.TestCase): """PermissionCreateObjectV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> PermissionCreateObjectV1Response: optional params are included """ # uncomment below to create an instance of `PermissionCreateObjectV1Response` """ - model = PermissionCreateObjectV1Response() # noqa: E501 + model = PermissionCreateObjectV1Response() if include_optional: return PermissionCreateObjectV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_permission_create_object_v1_response_m_payload.py b/test/test_permission_create_object_v1_response_m_payload.py index 90ab459da..d3ffc7654 100644 --- a/test/test_permission_create_object_v1_response_m_payload.py +++ b/test/test_permission_create_object_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.permission_create_object_v1_response_m_payload import PermissionCreateObjectV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.permission_create_object_v1_response_m_payload import PermissionCreateObjectV1ResponseMPayload class TestPermissionCreateObjectV1ResponseMPayload(unittest.TestCase): """PermissionCreateObjectV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> PermissionCreateObjectV1ResponseMPa optional params are included """ # uncomment below to create an instance of `PermissionCreateObjectV1ResponseMPayload` """ - model = PermissionCreateObjectV1ResponseMPayload() # noqa: E501 + model = PermissionCreateObjectV1ResponseMPayload() if include_optional: return PermissionCreateObjectV1ResponseMPayload( a_pki_permission_id = [ diff --git a/test/test_permission_delete_object_v1_response.py b/test/test_permission_delete_object_v1_response.py index 1491f2ccd..ce41b42a9 100644 --- a/test/test_permission_delete_object_v1_response.py +++ b/test/test_permission_delete_object_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.permission_delete_object_v1_response import PermissionDeleteObjectV1Response # noqa: E501 +from eZmaxApi.models.permission_delete_object_v1_response import PermissionDeleteObjectV1Response class TestPermissionDeleteObjectV1Response(unittest.TestCase): """PermissionDeleteObjectV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> PermissionDeleteObjectV1Response: optional params are included """ # uncomment below to create an instance of `PermissionDeleteObjectV1Response` """ - model = PermissionDeleteObjectV1Response() # noqa: E501 + model = PermissionDeleteObjectV1Response() if include_optional: return PermissionDeleteObjectV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_permission_edit_object_v1_request.py b/test/test_permission_edit_object_v1_request.py index 329f12fae..edacda099 100644 --- a/test/test_permission_edit_object_v1_request.py +++ b/test/test_permission_edit_object_v1_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.permission_edit_object_v1_request import PermissionEditObjectV1Request # noqa: E501 +from eZmaxApi.models.permission_edit_object_v1_request import PermissionEditObjectV1Request class TestPermissionEditObjectV1Request(unittest.TestCase): """PermissionEditObjectV1Request unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> PermissionEditObjectV1Request: optional params are included """ # uncomment below to create an instance of `PermissionEditObjectV1Request` """ - model = PermissionEditObjectV1Request() # noqa: E501 + model = PermissionEditObjectV1Request() if include_optional: return PermissionEditObjectV1Request( obj_permission = eZmaxApi.models.permission_request_compound.permission-RequestCompound() diff --git a/test/test_permission_edit_object_v1_response.py b/test/test_permission_edit_object_v1_response.py index fdaccc944..d7cedbecf 100644 --- a/test/test_permission_edit_object_v1_response.py +++ b/test/test_permission_edit_object_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.permission_edit_object_v1_response import PermissionEditObjectV1Response # noqa: E501 +from eZmaxApi.models.permission_edit_object_v1_response import PermissionEditObjectV1Response class TestPermissionEditObjectV1Response(unittest.TestCase): """PermissionEditObjectV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> PermissionEditObjectV1Response: optional params are included """ # uncomment below to create an instance of `PermissionEditObjectV1Response` """ - model = PermissionEditObjectV1Response() # noqa: E501 + model = PermissionEditObjectV1Response() if include_optional: return PermissionEditObjectV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_permission_get_object_v2_response.py b/test/test_permission_get_object_v2_response.py index 32c27ee6d..30b5df2ae 100644 --- a/test/test_permission_get_object_v2_response.py +++ b/test/test_permission_get_object_v2_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.permission_get_object_v2_response import PermissionGetObjectV2Response # noqa: E501 +from eZmaxApi.models.permission_get_object_v2_response import PermissionGetObjectV2Response class TestPermissionGetObjectV2Response(unittest.TestCase): """PermissionGetObjectV2Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> PermissionGetObjectV2Response: optional params are included """ # uncomment below to create an instance of `PermissionGetObjectV2Response` """ - model = PermissionGetObjectV2Response() # noqa: E501 + model = PermissionGetObjectV2Response() if include_optional: return PermissionGetObjectV2Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_permission_get_object_v2_response_m_payload.py b/test/test_permission_get_object_v2_response_m_payload.py index b1919e2cd..f30b45da5 100644 --- a/test/test_permission_get_object_v2_response_m_payload.py +++ b/test/test_permission_get_object_v2_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.permission_get_object_v2_response_m_payload import PermissionGetObjectV2ResponseMPayload # noqa: E501 +from eZmaxApi.models.permission_get_object_v2_response_m_payload import PermissionGetObjectV2ResponseMPayload class TestPermissionGetObjectV2ResponseMPayload(unittest.TestCase): """PermissionGetObjectV2ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> PermissionGetObjectV2ResponseMPaylo optional params are included """ # uncomment below to create an instance of `PermissionGetObjectV2ResponseMPayload` """ - model = PermissionGetObjectV2ResponseMPayload() # noqa: E501 + model = PermissionGetObjectV2ResponseMPayload() if include_optional: return PermissionGetObjectV2ResponseMPayload( obj_permission = eZmaxApi.models.permission_response_compound.permission-ResponseCompound() diff --git a/test/test_permission_request.py b/test/test_permission_request.py index 46e3c0884..00c752652 100644 --- a/test/test_permission_request.py +++ b/test/test_permission_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.permission_request import PermissionRequest # noqa: E501 +from eZmaxApi.models.permission_request import PermissionRequest class TestPermissionRequest(unittest.TestCase): """PermissionRequest unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> PermissionRequest: optional params are included """ # uncomment below to create an instance of `PermissionRequest` """ - model = PermissionRequest() # noqa: E501 + model = PermissionRequest() if include_optional: return PermissionRequest( pki_permission_id = 31, diff --git a/test/test_permission_request_compound.py b/test/test_permission_request_compound.py index fef3fd9c5..0f731a906 100644 --- a/test/test_permission_request_compound.py +++ b/test/test_permission_request_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.permission_request_compound import PermissionRequestCompound # noqa: E501 +from eZmaxApi.models.permission_request_compound import PermissionRequestCompound class TestPermissionRequestCompound(unittest.TestCase): """PermissionRequestCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> PermissionRequestCompound: optional params are included """ # uncomment below to create an instance of `PermissionRequestCompound` """ - model = PermissionRequestCompound() # noqa: E501 + model = PermissionRequestCompound() if include_optional: return PermissionRequestCompound( pki_permission_id = 31, diff --git a/test/test_permission_response.py b/test/test_permission_response.py index 127c74839..b6b613dd2 100644 --- a/test/test_permission_response.py +++ b/test/test_permission_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.permission_response import PermissionResponse # noqa: E501 +from eZmaxApi.models.permission_response import PermissionResponse class TestPermissionResponse(unittest.TestCase): """PermissionResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> PermissionResponse: optional params are included """ # uncomment below to create an instance of `PermissionResponse` """ - model = PermissionResponse() # noqa: E501 + model = PermissionResponse() if include_optional: return PermissionResponse( pki_permission_id = 31, diff --git a/test/test_permission_response_compound.py b/test/test_permission_response_compound.py index 7a10b5dcf..a89182510 100644 --- a/test/test_permission_response_compound.py +++ b/test/test_permission_response_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.permission_response_compound import PermissionResponseCompound # noqa: E501 +from eZmaxApi.models.permission_response_compound import PermissionResponseCompound class TestPermissionResponseCompound(unittest.TestCase): """PermissionResponseCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> PermissionResponseCompound: optional params are included """ # uncomment below to create an instance of `PermissionResponseCompound` """ - model = PermissionResponseCompound() # noqa: E501 + model = PermissionResponseCompound() if include_optional: return PermissionResponseCompound( pki_permission_id = 31, diff --git a/test/test_phone_request.py b/test/test_phone_request.py index 3899ec05d..4c7201dcf 100644 --- a/test/test_phone_request.py +++ b/test/test_phone_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.phone_request import PhoneRequest # noqa: E501 +from eZmaxApi.models.phone_request import PhoneRequest class TestPhoneRequest(unittest.TestCase): """PhoneRequest unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> PhoneRequest: optional params are included """ # uncomment below to create an instance of `PhoneRequest` """ - model = PhoneRequest() # noqa: E501 + model = PhoneRequest() if include_optional: return PhoneRequest( pki_phone_id = 1, diff --git a/test/test_phone_request_compound.py b/test/test_phone_request_compound.py index 412ce1f4c..0b3782ac3 100644 --- a/test/test_phone_request_compound.py +++ b/test/test_phone_request_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.phone_request_compound import PhoneRequestCompound # noqa: E501 +from eZmaxApi.models.phone_request_compound import PhoneRequestCompound class TestPhoneRequestCompound(unittest.TestCase): """PhoneRequestCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> PhoneRequestCompound: optional params are included """ # uncomment below to create an instance of `PhoneRequestCompound` """ - model = PhoneRequestCompound() # noqa: E501 + model = PhoneRequestCompound() if include_optional: return PhoneRequestCompound( pki_phone_id = 1, diff --git a/test/test_phone_response.py b/test/test_phone_response.py index c83df4fc7..9718aa7c7 100644 --- a/test/test_phone_response.py +++ b/test/test_phone_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.phone_response import PhoneResponse # noqa: E501 +from eZmaxApi.models.phone_response import PhoneResponse class TestPhoneResponse(unittest.TestCase): """PhoneResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> PhoneResponse: optional params are included """ # uncomment below to create an instance of `PhoneResponse` """ - model = PhoneResponse() # noqa: E501 + model = PhoneResponse() if include_optional: return PhoneResponse( pki_phone_id = 1, diff --git a/test/test_phone_response_compound.py b/test/test_phone_response_compound.py index 107ad9bb7..fe4943956 100644 --- a/test/test_phone_response_compound.py +++ b/test/test_phone_response_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.phone_response_compound import PhoneResponseCompound # noqa: E501 +from eZmaxApi.models.phone_response_compound import PhoneResponseCompound class TestPhoneResponseCompound(unittest.TestCase): """PhoneResponseCompound unit test stubs""" @@ -34,14 +34,15 @@ def make_instance(self, include_optional) -> PhoneResponseCompound: optional params are included """ # uncomment below to create an instance of `PhoneResponseCompound` """ - model = PhoneResponseCompound() # noqa: E501 + model = PhoneResponseCompound() if include_optional: return PhoneResponseCompound( pki_phone_id = 1, fki_phonetype_id = 1, e_phone_type = 'Local', s_phone_e164 = '+15149901516', - s_phone_extension = '123' + s_phone_extension = '123', + b_phone_international = True ) else: return PhoneResponseCompound( diff --git a/test/test_phonetype_autocomplete_element_response.py b/test/test_phonetype_autocomplete_element_response.py index fe44955ba..a317c358c 100644 --- a/test/test_phonetype_autocomplete_element_response.py +++ b/test/test_phonetype_autocomplete_element_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.phonetype_autocomplete_element_response import PhonetypeAutocompleteElementResponse # noqa: E501 +from eZmaxApi.models.phonetype_autocomplete_element_response import PhonetypeAutocompleteElementResponse class TestPhonetypeAutocompleteElementResponse(unittest.TestCase): """PhonetypeAutocompleteElementResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> PhonetypeAutocompleteElementRespons optional params are included """ # uncomment below to create an instance of `PhonetypeAutocompleteElementResponse` """ - model = PhonetypeAutocompleteElementResponse() # noqa: E501 + model = PhonetypeAutocompleteElementResponse() if include_optional: return PhonetypeAutocompleteElementResponse( pki_phonetype_id = 1, diff --git a/test/test_phonetype_get_autocomplete_v2_response.py b/test/test_phonetype_get_autocomplete_v2_response.py index 22a239071..6d9bf2a7f 100644 --- a/test/test_phonetype_get_autocomplete_v2_response.py +++ b/test/test_phonetype_get_autocomplete_v2_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.phonetype_get_autocomplete_v2_response import PhonetypeGetAutocompleteV2Response # noqa: E501 +from eZmaxApi.models.phonetype_get_autocomplete_v2_response import PhonetypeGetAutocompleteV2Response class TestPhonetypeGetAutocompleteV2Response(unittest.TestCase): """PhonetypeGetAutocompleteV2Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> PhonetypeGetAutocompleteV2Response: optional params are included """ # uncomment below to create an instance of `PhonetypeGetAutocompleteV2Response` """ - model = PhonetypeGetAutocompleteV2Response() # noqa: E501 + model = PhonetypeGetAutocompleteV2Response() if include_optional: return PhonetypeGetAutocompleteV2Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_phonetype_get_autocomplete_v2_response_m_payload.py b/test/test_phonetype_get_autocomplete_v2_response_m_payload.py index 08b0af673..dee208b1d 100644 --- a/test/test_phonetype_get_autocomplete_v2_response_m_payload.py +++ b/test/test_phonetype_get_autocomplete_v2_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.phonetype_get_autocomplete_v2_response_m_payload import PhonetypeGetAutocompleteV2ResponseMPayload # noqa: E501 +from eZmaxApi.models.phonetype_get_autocomplete_v2_response_m_payload import PhonetypeGetAutocompleteV2ResponseMPayload class TestPhonetypeGetAutocompleteV2ResponseMPayload(unittest.TestCase): """PhonetypeGetAutocompleteV2ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> PhonetypeGetAutocompleteV2ResponseM optional params are included """ # uncomment below to create an instance of `PhonetypeGetAutocompleteV2ResponseMPayload` """ - model = PhonetypeGetAutocompleteV2ResponseMPayload() # noqa: E501 + model = PhonetypeGetAutocompleteV2ResponseMPayload() if include_optional: return PhonetypeGetAutocompleteV2ResponseMPayload( a_obj_phonetype = [ diff --git a/test/test_rejectedoffertopurchase_get_communication_list_v1_response.py b/test/test_rejectedoffertopurchase_get_communication_list_v1_response.py index a66cc8a02..146d25f68 100644 --- a/test/test_rejectedoffertopurchase_get_communication_list_v1_response.py +++ b/test/test_rejectedoffertopurchase_get_communication_list_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.rejectedoffertopurchase_get_communication_list_v1_response import RejectedoffertopurchaseGetCommunicationListV1Response # noqa: E501 +from eZmaxApi.models.rejectedoffertopurchase_get_communication_list_v1_response import RejectedoffertopurchaseGetCommunicationListV1Response class TestRejectedoffertopurchaseGetCommunicationListV1Response(unittest.TestCase): """RejectedoffertopurchaseGetCommunicationListV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> RejectedoffertopurchaseGetCommunica optional params are included """ # uncomment below to create an instance of `RejectedoffertopurchaseGetCommunicationListV1Response` """ - model = RejectedoffertopurchaseGetCommunicationListV1Response() # noqa: E501 + model = RejectedoffertopurchaseGetCommunicationListV1Response() if include_optional: return RejectedoffertopurchaseGetCommunicationListV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload_get_list.Common-Response-objDebugPayload_getList(), diff --git a/test/test_rejectedoffertopurchase_get_communication_list_v1_response_m_payload.py b/test/test_rejectedoffertopurchase_get_communication_list_v1_response_m_payload.py index a19256f2d..c91690665 100644 --- a/test/test_rejectedoffertopurchase_get_communication_list_v1_response_m_payload.py +++ b/test/test_rejectedoffertopurchase_get_communication_list_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.rejectedoffertopurchase_get_communication_list_v1_response_m_payload import RejectedoffertopurchaseGetCommunicationListV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.rejectedoffertopurchase_get_communication_list_v1_response_m_payload import RejectedoffertopurchaseGetCommunicationListV1ResponseMPayload class TestRejectedoffertopurchaseGetCommunicationListV1ResponseMPayload(unittest.TestCase): """RejectedoffertopurchaseGetCommunicationListV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> RejectedoffertopurchaseGetCommunica optional params are included """ # uncomment below to create an instance of `RejectedoffertopurchaseGetCommunicationListV1ResponseMPayload` """ - model = RejectedoffertopurchaseGetCommunicationListV1ResponseMPayload() # noqa: E501 + model = RejectedoffertopurchaseGetCommunicationListV1ResponseMPayload() if include_optional: return RejectedoffertopurchaseGetCommunicationListV1ResponseMPayload( a_obj_communication = [ diff --git a/test/test_scim_authentication_scheme.py b/test/test_scim_authentication_scheme.py index ff65e0de0..7bf28867c 100644 --- a/test/test_scim_authentication_scheme.py +++ b/test/test_scim_authentication_scheme.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.scim_authentication_scheme import ScimAuthenticationScheme # noqa: E501 +from eZmaxApi.models.scim_authentication_scheme import ScimAuthenticationScheme class TestScimAuthenticationScheme(unittest.TestCase): """ScimAuthenticationScheme unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> ScimAuthenticationScheme: optional params are included """ # uncomment below to create an instance of `ScimAuthenticationScheme` """ - model = ScimAuthenticationScheme() # noqa: E501 + model = ScimAuthenticationScheme() if include_optional: return ScimAuthenticationScheme( description = 'Bearer token in the Authorization header', diff --git a/test/test_scim_email.py b/test/test_scim_email.py index 4cbac1d8e..0d0172b63 100644 --- a/test/test_scim_email.py +++ b/test/test_scim_email.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.scim_email import ScimEmail # noqa: E501 +from eZmaxApi.models.scim_email import ScimEmail class TestScimEmail(unittest.TestCase): """ScimEmail unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> ScimEmail: optional params are included """ # uncomment below to create an instance of `ScimEmail` """ - model = ScimEmail() # noqa: E501 + model = ScimEmail() if include_optional: return ScimEmail( value = 'email@example.com', diff --git a/test/test_scim_group.py b/test/test_scim_group.py index 3ddf4c219..54d349147 100644 --- a/test/test_scim_group.py +++ b/test/test_scim_group.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.scim_group import ScimGroup # noqa: E501 +from eZmaxApi.models.scim_group import ScimGroup class TestScimGroup(unittest.TestCase): """ScimGroup unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> ScimGroup: optional params are included """ # uncomment below to create an instance of `ScimGroup` """ - model = ScimGroup() # noqa: E501 + model = ScimGroup() if include_optional: return ScimGroup( id = '', diff --git a/test/test_scim_group_member.py b/test/test_scim_group_member.py index 32e34bc82..eb3908a9b 100644 --- a/test/test_scim_group_member.py +++ b/test/test_scim_group_member.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.scim_group_member import ScimGroupMember # noqa: E501 +from eZmaxApi.models.scim_group_member import ScimGroupMember class TestScimGroupMember(unittest.TestCase): """ScimGroupMember unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> ScimGroupMember: optional params are included """ # uncomment below to create an instance of `ScimGroupMember` """ - model = ScimGroupMember() # noqa: E501 + model = ScimGroupMember() if include_optional: return ScimGroupMember( value = '', diff --git a/test/test_scim_groups_api.py b/test/test_scim_groups_api.py index a69e1fce7..e17ad0525 100644 --- a/test/test_scim_groups_api.py +++ b/test/test_scim_groups_api.py @@ -15,14 +15,14 @@ import unittest -from eZmaxApi.api.scim_groups_api import ScimGroupsApi # noqa: E501 +from eZmaxApi.api.scim_groups_api import ScimGroupsApi class TestScimGroupsApi(unittest.TestCase): """ScimGroupsApi unit test stubs""" def setUp(self) -> None: - self.api = ScimGroupsApi() # noqa: E501 + self.api = ScimGroupsApi() def tearDown(self) -> None: pass @@ -30,35 +30,35 @@ def tearDown(self) -> None: def test_groups_create_object_scim_v2(self) -> None: """Test case for groups_create_object_scim_v2 - Create a new Usergroup # noqa: E501 + Create a new Usergroup """ pass def test_groups_delete_object_scim_v2(self) -> None: """Test case for groups_delete_object_scim_v2 - Delete an existing Usergroup # noqa: E501 + Delete an existing Usergroup """ pass def test_groups_edit_object_scim_v2(self) -> None: """Test case for groups_edit_object_scim_v2 - Edit an existing Usergroup # noqa: E501 + Edit an existing Usergroup """ pass def test_groups_get_list_scim_v2(self) -> None: """Test case for groups_get_list_scim_v2 - Retrieve Usergroup list # noqa: E501 + Retrieve Usergroup list """ pass def test_groups_get_object_scim_v2(self) -> None: """Test case for groups_get_object_scim_v2 - Retrieve an existing Usergroup # noqa: E501 + Retrieve an existing Usergroup """ pass diff --git a/test/test_scim_service_provider_config.py b/test/test_scim_service_provider_config.py index 50b53d4be..bec7c3d90 100644 --- a/test/test_scim_service_provider_config.py +++ b/test/test_scim_service_provider_config.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.scim_service_provider_config import ScimServiceProviderConfig # noqa: E501 +from eZmaxApi.models.scim_service_provider_config import ScimServiceProviderConfig class TestScimServiceProviderConfig(unittest.TestCase): """ScimServiceProviderConfig unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> ScimServiceProviderConfig: optional params are included """ # uncomment below to create an instance of `ScimServiceProviderConfig` """ - model = ScimServiceProviderConfig() # noqa: E501 + model = ScimServiceProviderConfig() if include_optional: return ScimServiceProviderConfig( authentication_schemes = [ diff --git a/test/test_scim_service_provider_config_api.py b/test/test_scim_service_provider_config_api.py index f4ba7fc50..cf4381195 100644 --- a/test/test_scim_service_provider_config_api.py +++ b/test/test_scim_service_provider_config_api.py @@ -15,14 +15,14 @@ import unittest -from eZmaxApi.api.scim_service_provider_config_api import ScimServiceProviderConfigApi # noqa: E501 +from eZmaxApi.api.scim_service_provider_config_api import ScimServiceProviderConfigApi class TestScimServiceProviderConfigApi(unittest.TestCase): """ScimServiceProviderConfigApi unit test stubs""" def setUp(self) -> None: - self.api = ScimServiceProviderConfigApi() # noqa: E501 + self.api = ScimServiceProviderConfigApi() def tearDown(self) -> None: pass @@ -30,7 +30,7 @@ def tearDown(self) -> None: def test_service_provider_config_get_object_scim_v2(self) -> None: """Test case for service_provider_config_get_object_scim_v2 - Get Service Provider Configuration # noqa: E501 + Get Service Provider Configuration """ pass diff --git a/test/test_scim_service_provider_config_bulk.py b/test/test_scim_service_provider_config_bulk.py index c9defb661..132e31789 100644 --- a/test/test_scim_service_provider_config_bulk.py +++ b/test/test_scim_service_provider_config_bulk.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.scim_service_provider_config_bulk import ScimServiceProviderConfigBulk # noqa: E501 +from eZmaxApi.models.scim_service_provider_config_bulk import ScimServiceProviderConfigBulk class TestScimServiceProviderConfigBulk(unittest.TestCase): """ScimServiceProviderConfigBulk unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> ScimServiceProviderConfigBulk: optional params are included """ # uncomment below to create an instance of `ScimServiceProviderConfigBulk` """ - model = ScimServiceProviderConfigBulk() # noqa: E501 + model = ScimServiceProviderConfigBulk() if include_optional: return ScimServiceProviderConfigBulk( supported = False, diff --git a/test/test_scim_service_provider_config_change_password.py b/test/test_scim_service_provider_config_change_password.py index 92e0ffb71..a728919e9 100644 --- a/test/test_scim_service_provider_config_change_password.py +++ b/test/test_scim_service_provider_config_change_password.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.scim_service_provider_config_change_password import ScimServiceProviderConfigChangePassword # noqa: E501 +from eZmaxApi.models.scim_service_provider_config_change_password import ScimServiceProviderConfigChangePassword class TestScimServiceProviderConfigChangePassword(unittest.TestCase): """ScimServiceProviderConfigChangePassword unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> ScimServiceProviderConfigChangePass optional params are included """ # uncomment below to create an instance of `ScimServiceProviderConfigChangePassword` """ - model = ScimServiceProviderConfigChangePassword() # noqa: E501 + model = ScimServiceProviderConfigChangePassword() if include_optional: return ScimServiceProviderConfigChangePassword( supported = False diff --git a/test/test_scim_service_provider_config_etag.py b/test/test_scim_service_provider_config_etag.py index 30698f7d2..5320f805b 100644 --- a/test/test_scim_service_provider_config_etag.py +++ b/test/test_scim_service_provider_config_etag.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.scim_service_provider_config_etag import ScimServiceProviderConfigEtag # noqa: E501 +from eZmaxApi.models.scim_service_provider_config_etag import ScimServiceProviderConfigEtag class TestScimServiceProviderConfigEtag(unittest.TestCase): """ScimServiceProviderConfigEtag unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> ScimServiceProviderConfigEtag: optional params are included """ # uncomment below to create an instance of `ScimServiceProviderConfigEtag` """ - model = ScimServiceProviderConfigEtag() # noqa: E501 + model = ScimServiceProviderConfigEtag() if include_optional: return ScimServiceProviderConfigEtag( supported = False diff --git a/test/test_scim_service_provider_config_filter.py b/test/test_scim_service_provider_config_filter.py index 2cfa473bc..9a93c6884 100644 --- a/test/test_scim_service_provider_config_filter.py +++ b/test/test_scim_service_provider_config_filter.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.scim_service_provider_config_filter import ScimServiceProviderConfigFilter # noqa: E501 +from eZmaxApi.models.scim_service_provider_config_filter import ScimServiceProviderConfigFilter class TestScimServiceProviderConfigFilter(unittest.TestCase): """ScimServiceProviderConfigFilter unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> ScimServiceProviderConfigFilter: optional params are included """ # uncomment below to create an instance of `ScimServiceProviderConfigFilter` """ - model = ScimServiceProviderConfigFilter() # noqa: E501 + model = ScimServiceProviderConfigFilter() if include_optional: return ScimServiceProviderConfigFilter( supported = True, diff --git a/test/test_scim_service_provider_config_patch.py b/test/test_scim_service_provider_config_patch.py index 7de118147..377810501 100644 --- a/test/test_scim_service_provider_config_patch.py +++ b/test/test_scim_service_provider_config_patch.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.scim_service_provider_config_patch import ScimServiceProviderConfigPatch # noqa: E501 +from eZmaxApi.models.scim_service_provider_config_patch import ScimServiceProviderConfigPatch class TestScimServiceProviderConfigPatch(unittest.TestCase): """ScimServiceProviderConfigPatch unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> ScimServiceProviderConfigPatch: optional params are included """ # uncomment below to create an instance of `ScimServiceProviderConfigPatch` """ - model = ScimServiceProviderConfigPatch() # noqa: E501 + model = ScimServiceProviderConfigPatch() if include_optional: return ScimServiceProviderConfigPatch( supported = False diff --git a/test/test_scim_service_provider_config_sort.py b/test/test_scim_service_provider_config_sort.py index 8f7c20418..d32c768e6 100644 --- a/test/test_scim_service_provider_config_sort.py +++ b/test/test_scim_service_provider_config_sort.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.scim_service_provider_config_sort import ScimServiceProviderConfigSort # noqa: E501 +from eZmaxApi.models.scim_service_provider_config_sort import ScimServiceProviderConfigSort class TestScimServiceProviderConfigSort(unittest.TestCase): """ScimServiceProviderConfigSort unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> ScimServiceProviderConfigSort: optional params are included """ # uncomment below to create an instance of `ScimServiceProviderConfigSort` """ - model = ScimServiceProviderConfigSort() # noqa: E501 + model = ScimServiceProviderConfigSort() if include_optional: return ScimServiceProviderConfigSort( supported = False diff --git a/test/test_scim_user.py b/test/test_scim_user.py index 34818d819..002250db9 100644 --- a/test/test_scim_user.py +++ b/test/test_scim_user.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.scim_user import ScimUser # noqa: E501 +from eZmaxApi.models.scim_user import ScimUser class TestScimUser(unittest.TestCase): """ScimUser unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> ScimUser: optional params are included """ # uncomment below to create an instance of `ScimUser` """ - model = ScimUser() # noqa: E501 + model = ScimUser() if include_optional: return ScimUser( id = '', diff --git a/test/test_scim_user_list.py b/test/test_scim_user_list.py index 0580a736a..ba7538268 100644 --- a/test/test_scim_user_list.py +++ b/test/test_scim_user_list.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.scim_user_list import ScimUserList # noqa: E501 +from eZmaxApi.models.scim_user_list import ScimUserList class TestScimUserList(unittest.TestCase): """ScimUserList unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> ScimUserList: optional params are included """ # uncomment below to create an instance of `ScimUserList` """ - model = ScimUserList() # noqa: E501 + model = ScimUserList() if include_optional: return ScimUserList( total_results = 56, diff --git a/test/test_scim_users_api.py b/test/test_scim_users_api.py index ab5b393a2..6d6af0583 100644 --- a/test/test_scim_users_api.py +++ b/test/test_scim_users_api.py @@ -15,14 +15,14 @@ import unittest -from eZmaxApi.api.scim_users_api import ScimUsersApi # noqa: E501 +from eZmaxApi.api.scim_users_api import ScimUsersApi class TestScimUsersApi(unittest.TestCase): """ScimUsersApi unit test stubs""" def setUp(self) -> None: - self.api = ScimUsersApi() # noqa: E501 + self.api = ScimUsersApi() def tearDown(self) -> None: pass @@ -30,35 +30,35 @@ def tearDown(self) -> None: def test_users_create_object_scim_v2(self) -> None: """Test case for users_create_object_scim_v2 - Create a new User # noqa: E501 + Create a new User """ pass def test_users_delete_object_scim_v2(self) -> None: """Test case for users_delete_object_scim_v2 - Delete an existing User # noqa: E501 + Delete an existing User """ pass def test_users_edit_object_scim_v2(self) -> None: """Test case for users_edit_object_scim_v2 - Edit an existing User # noqa: E501 + Edit an existing User """ pass def test_users_get_list_scim_v2(self) -> None: """Test case for users_get_list_scim_v2 - Retrieve User list # noqa: E501 + Retrieve User list """ pass def test_users_get_object_scim_v2(self) -> None: """Test case for users_get_object_scim_v2 - Retrieve an existing User # noqa: E501 + Retrieve an existing User """ pass diff --git a/test/test_secretquestion_autocomplete_element_response.py b/test/test_secretquestion_autocomplete_element_response.py index 05052da44..a747bffc6 100644 --- a/test/test_secretquestion_autocomplete_element_response.py +++ b/test/test_secretquestion_autocomplete_element_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.secretquestion_autocomplete_element_response import SecretquestionAutocompleteElementResponse # noqa: E501 +from eZmaxApi.models.secretquestion_autocomplete_element_response import SecretquestionAutocompleteElementResponse class TestSecretquestionAutocompleteElementResponse(unittest.TestCase): """SecretquestionAutocompleteElementResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> SecretquestionAutocompleteElementRe optional params are included """ # uncomment below to create an instance of `SecretquestionAutocompleteElementResponse` """ - model = SecretquestionAutocompleteElementResponse() # noqa: E501 + model = SecretquestionAutocompleteElementResponse() if include_optional: return SecretquestionAutocompleteElementResponse( s_secretquestion_text_x = 'The name of the hospital in which you were born', diff --git a/test/test_secretquestion_get_autocomplete_v2_response.py b/test/test_secretquestion_get_autocomplete_v2_response.py index cc342b9a3..fe6ffdb59 100644 --- a/test/test_secretquestion_get_autocomplete_v2_response.py +++ b/test/test_secretquestion_get_autocomplete_v2_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.secretquestion_get_autocomplete_v2_response import SecretquestionGetAutocompleteV2Response # noqa: E501 +from eZmaxApi.models.secretquestion_get_autocomplete_v2_response import SecretquestionGetAutocompleteV2Response class TestSecretquestionGetAutocompleteV2Response(unittest.TestCase): """SecretquestionGetAutocompleteV2Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> SecretquestionGetAutocompleteV2Resp optional params are included """ # uncomment below to create an instance of `SecretquestionGetAutocompleteV2Response` """ - model = SecretquestionGetAutocompleteV2Response() # noqa: E501 + model = SecretquestionGetAutocompleteV2Response() if include_optional: return SecretquestionGetAutocompleteV2Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_secretquestion_get_autocomplete_v2_response_m_payload.py b/test/test_secretquestion_get_autocomplete_v2_response_m_payload.py index 6e7444440..9e278c1e8 100644 --- a/test/test_secretquestion_get_autocomplete_v2_response_m_payload.py +++ b/test/test_secretquestion_get_autocomplete_v2_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.secretquestion_get_autocomplete_v2_response_m_payload import SecretquestionGetAutocompleteV2ResponseMPayload # noqa: E501 +from eZmaxApi.models.secretquestion_get_autocomplete_v2_response_m_payload import SecretquestionGetAutocompleteV2ResponseMPayload class TestSecretquestionGetAutocompleteV2ResponseMPayload(unittest.TestCase): """SecretquestionGetAutocompleteV2ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> SecretquestionGetAutocompleteV2Resp optional params are included """ # uncomment below to create an instance of `SecretquestionGetAutocompleteV2ResponseMPayload` """ - model = SecretquestionGetAutocompleteV2ResponseMPayload() # noqa: E501 + model = SecretquestionGetAutocompleteV2ResponseMPayload() if include_optional: return SecretquestionGetAutocompleteV2ResponseMPayload( a_obj_secretquestion = [ diff --git a/test/test_sessionhistory_get_list_v1_response.py b/test/test_sessionhistory_get_list_v1_response.py index 46b690a24..2332330ab 100644 --- a/test/test_sessionhistory_get_list_v1_response.py +++ b/test/test_sessionhistory_get_list_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.sessionhistory_get_list_v1_response import SessionhistoryGetListV1Response # noqa: E501 +from eZmaxApi.models.sessionhistory_get_list_v1_response import SessionhistoryGetListV1Response class TestSessionhistoryGetListV1Response(unittest.TestCase): """SessionhistoryGetListV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> SessionhistoryGetListV1Response: optional params are included """ # uncomment below to create an instance of `SessionhistoryGetListV1Response` """ - model = SessionhistoryGetListV1Response() # noqa: E501 + model = SessionhistoryGetListV1Response() if include_optional: return SessionhistoryGetListV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload_get_list.Common-Response-objDebugPayload_getList(), diff --git a/test/test_sessionhistory_get_list_v1_response_m_payload.py b/test/test_sessionhistory_get_list_v1_response_m_payload.py index 4dd129b03..a3a05c372 100644 --- a/test/test_sessionhistory_get_list_v1_response_m_payload.py +++ b/test/test_sessionhistory_get_list_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.sessionhistory_get_list_v1_response_m_payload import SessionhistoryGetListV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.sessionhistory_get_list_v1_response_m_payload import SessionhistoryGetListV1ResponseMPayload class TestSessionhistoryGetListV1ResponseMPayload(unittest.TestCase): """SessionhistoryGetListV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> SessionhistoryGetListV1ResponseMPay optional params are included """ # uncomment below to create an instance of `SessionhistoryGetListV1ResponseMPayload` """ - model = SessionhistoryGetListV1ResponseMPayload() # noqa: E501 + model = SessionhistoryGetListV1ResponseMPayload() if include_optional: return SessionhistoryGetListV1ResponseMPayload( i_row_returned = 100, diff --git a/test/test_sessionhistory_list_element.py b/test/test_sessionhistory_list_element.py index 3d3c046cc..bb9bd8bb3 100644 --- a/test/test_sessionhistory_list_element.py +++ b/test/test_sessionhistory_list_element.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.sessionhistory_list_element import SessionhistoryListElement # noqa: E501 +from eZmaxApi.models.sessionhistory_list_element import SessionhistoryListElement class TestSessionhistoryListElement(unittest.TestCase): """SessionhistoryListElement unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> SessionhistoryListElement: optional params are included """ # uncomment below to create an instance of `SessionhistoryListElement` """ - model = SessionhistoryListElement() # noqa: E501 + model = SessionhistoryListElement() if include_optional: return SessionhistoryListElement( pki_sessionhistory_id = 259, diff --git a/test/test_signature_create_object_v1_request.py b/test/test_signature_create_object_v1_request.py index ac723d7b2..f2e170bd4 100644 --- a/test/test_signature_create_object_v1_request.py +++ b/test/test_signature_create_object_v1_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.signature_create_object_v1_request import SignatureCreateObjectV1Request # noqa: E501 +from eZmaxApi.models.signature_create_object_v1_request import SignatureCreateObjectV1Request class TestSignatureCreateObjectV1Request(unittest.TestCase): """SignatureCreateObjectV1Request unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> SignatureCreateObjectV1Request: optional params are included """ # uncomment below to create an instance of `SignatureCreateObjectV1Request` """ - model = SignatureCreateObjectV1Request() # noqa: E501 + model = SignatureCreateObjectV1Request() if include_optional: return SignatureCreateObjectV1Request( a_obj_signature = [ diff --git a/test/test_signature_create_object_v1_response.py b/test/test_signature_create_object_v1_response.py index fb562642d..939593099 100644 --- a/test/test_signature_create_object_v1_response.py +++ b/test/test_signature_create_object_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.signature_create_object_v1_response import SignatureCreateObjectV1Response # noqa: E501 +from eZmaxApi.models.signature_create_object_v1_response import SignatureCreateObjectV1Response class TestSignatureCreateObjectV1Response(unittest.TestCase): """SignatureCreateObjectV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> SignatureCreateObjectV1Response: optional params are included """ # uncomment below to create an instance of `SignatureCreateObjectV1Response` """ - model = SignatureCreateObjectV1Response() # noqa: E501 + model = SignatureCreateObjectV1Response() if include_optional: return SignatureCreateObjectV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_signature_create_object_v1_response_m_payload.py b/test/test_signature_create_object_v1_response_m_payload.py index c4fc7a263..ec353280e 100644 --- a/test/test_signature_create_object_v1_response_m_payload.py +++ b/test/test_signature_create_object_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.signature_create_object_v1_response_m_payload import SignatureCreateObjectV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.signature_create_object_v1_response_m_payload import SignatureCreateObjectV1ResponseMPayload class TestSignatureCreateObjectV1ResponseMPayload(unittest.TestCase): """SignatureCreateObjectV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> SignatureCreateObjectV1ResponseMPay optional params are included """ # uncomment below to create an instance of `SignatureCreateObjectV1ResponseMPayload` """ - model = SignatureCreateObjectV1ResponseMPayload() # noqa: E501 + model = SignatureCreateObjectV1ResponseMPayload() if include_optional: return SignatureCreateObjectV1ResponseMPayload( a_pki_signature_id = [ diff --git a/test/test_signature_delete_object_v1_response.py b/test/test_signature_delete_object_v1_response.py index d73ab67f3..4b09c9c8a 100644 --- a/test/test_signature_delete_object_v1_response.py +++ b/test/test_signature_delete_object_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.signature_delete_object_v1_response import SignatureDeleteObjectV1Response # noqa: E501 +from eZmaxApi.models.signature_delete_object_v1_response import SignatureDeleteObjectV1Response class TestSignatureDeleteObjectV1Response(unittest.TestCase): """SignatureDeleteObjectV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> SignatureDeleteObjectV1Response: optional params are included """ # uncomment below to create an instance of `SignatureDeleteObjectV1Response` """ - model = SignatureDeleteObjectV1Response() # noqa: E501 + model = SignatureDeleteObjectV1Response() if include_optional: return SignatureDeleteObjectV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_signature_edit_object_v1_request.py b/test/test_signature_edit_object_v1_request.py index 8af3206e8..29d4d0254 100644 --- a/test/test_signature_edit_object_v1_request.py +++ b/test/test_signature_edit_object_v1_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.signature_edit_object_v1_request import SignatureEditObjectV1Request # noqa: E501 +from eZmaxApi.models.signature_edit_object_v1_request import SignatureEditObjectV1Request class TestSignatureEditObjectV1Request(unittest.TestCase): """SignatureEditObjectV1Request unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> SignatureEditObjectV1Request: optional params are included """ # uncomment below to create an instance of `SignatureEditObjectV1Request` """ - model = SignatureEditObjectV1Request() # noqa: E501 + model = SignatureEditObjectV1Request() if include_optional: return SignatureEditObjectV1Request( obj_signature = eZmaxApi.models.signature_request_compound.signature-RequestCompound() diff --git a/test/test_signature_edit_object_v1_response.py b/test/test_signature_edit_object_v1_response.py index e6e5d57ee..672791c8d 100644 --- a/test/test_signature_edit_object_v1_response.py +++ b/test/test_signature_edit_object_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.signature_edit_object_v1_response import SignatureEditObjectV1Response # noqa: E501 +from eZmaxApi.models.signature_edit_object_v1_response import SignatureEditObjectV1Response class TestSignatureEditObjectV1Response(unittest.TestCase): """SignatureEditObjectV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> SignatureEditObjectV1Response: optional params are included """ # uncomment below to create an instance of `SignatureEditObjectV1Response` """ - model = SignatureEditObjectV1Response() # noqa: E501 + model = SignatureEditObjectV1Response() if include_optional: return SignatureEditObjectV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_signature_get_object_v2_response.py b/test/test_signature_get_object_v2_response.py index be8d16fee..6bfefdbf3 100644 --- a/test/test_signature_get_object_v2_response.py +++ b/test/test_signature_get_object_v2_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.signature_get_object_v2_response import SignatureGetObjectV2Response # noqa: E501 +from eZmaxApi.models.signature_get_object_v2_response import SignatureGetObjectV2Response class TestSignatureGetObjectV2Response(unittest.TestCase): """SignatureGetObjectV2Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> SignatureGetObjectV2Response: optional params are included """ # uncomment below to create an instance of `SignatureGetObjectV2Response` """ - model = SignatureGetObjectV2Response() # noqa: E501 + model = SignatureGetObjectV2Response() if include_optional: return SignatureGetObjectV2Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_signature_get_object_v2_response_m_payload.py b/test/test_signature_get_object_v2_response_m_payload.py index 72f329655..9c21c9fd1 100644 --- a/test/test_signature_get_object_v2_response_m_payload.py +++ b/test/test_signature_get_object_v2_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.signature_get_object_v2_response_m_payload import SignatureGetObjectV2ResponseMPayload # noqa: E501 +from eZmaxApi.models.signature_get_object_v2_response_m_payload import SignatureGetObjectV2ResponseMPayload class TestSignatureGetObjectV2ResponseMPayload(unittest.TestCase): """SignatureGetObjectV2ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> SignatureGetObjectV2ResponseMPayloa optional params are included """ # uncomment below to create an instance of `SignatureGetObjectV2ResponseMPayload` """ - model = SignatureGetObjectV2ResponseMPayload() # noqa: E501 + model = SignatureGetObjectV2ResponseMPayload() if include_optional: return SignatureGetObjectV2ResponseMPayload( obj_signature = eZmaxApi.models.signature_response_compound.signature-ResponseCompound() diff --git a/test/test_signature_request.py b/test/test_signature_request.py index d903482ba..7b0460dba 100644 --- a/test/test_signature_request.py +++ b/test/test_signature_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.signature_request import SignatureRequest # noqa: E501 +from eZmaxApi.models.signature_request import SignatureRequest class TestSignatureRequest(unittest.TestCase): """SignatureRequest unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> SignatureRequest: optional params are included """ # uncomment below to create an instance of `SignatureRequest` """ - model = SignatureRequest() # noqa: E501 + model = SignatureRequest() if include_optional: return SignatureRequest( pki_signature_id = 12, diff --git a/test/test_signature_request_compound.py b/test/test_signature_request_compound.py index 58440a6cd..a59de69b4 100644 --- a/test/test_signature_request_compound.py +++ b/test/test_signature_request_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.signature_request_compound import SignatureRequestCompound # noqa: E501 +from eZmaxApi.models.signature_request_compound import SignatureRequestCompound class TestSignatureRequestCompound(unittest.TestCase): """SignatureRequestCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> SignatureRequestCompound: optional params are included """ # uncomment below to create an instance of `SignatureRequestCompound` """ - model = SignatureRequestCompound() # noqa: E501 + model = SignatureRequestCompound() if include_optional: return SignatureRequestCompound( pki_signature_id = 12, diff --git a/test/test_signature_response.py b/test/test_signature_response.py index 17b7d25ed..51c868b1d 100644 --- a/test/test_signature_response.py +++ b/test/test_signature_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.signature_response import SignatureResponse # noqa: E501 +from eZmaxApi.models.signature_response import SignatureResponse class TestSignatureResponse(unittest.TestCase): """SignatureResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> SignatureResponse: optional params are included """ # uncomment below to create an instance of `SignatureResponse` """ - model = SignatureResponse() # noqa: E501 + model = SignatureResponse() if include_optional: return SignatureResponse( pki_signature_id = 12, diff --git a/test/test_signature_response_compound.py b/test/test_signature_response_compound.py index 9a03e2ea9..17db50940 100644 --- a/test/test_signature_response_compound.py +++ b/test/test_signature_response_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.signature_response_compound import SignatureResponseCompound # noqa: E501 +from eZmaxApi.models.signature_response_compound import SignatureResponseCompound class TestSignatureResponseCompound(unittest.TestCase): """SignatureResponseCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> SignatureResponseCompound: optional params are included """ # uncomment below to create an instance of `SignatureResponseCompound` """ - model = SignatureResponseCompound() # noqa: E501 + model = SignatureResponseCompound() if include_optional: return SignatureResponseCompound( pki_signature_id = 12, diff --git a/test/test_subnet_create_object_v1_request.py b/test/test_subnet_create_object_v1_request.py index 0b5655878..ab7d6fe15 100644 --- a/test/test_subnet_create_object_v1_request.py +++ b/test/test_subnet_create_object_v1_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.subnet_create_object_v1_request import SubnetCreateObjectV1Request # noqa: E501 +from eZmaxApi.models.subnet_create_object_v1_request import SubnetCreateObjectV1Request class TestSubnetCreateObjectV1Request(unittest.TestCase): """SubnetCreateObjectV1Request unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> SubnetCreateObjectV1Request: optional params are included """ # uncomment below to create an instance of `SubnetCreateObjectV1Request` """ - model = SubnetCreateObjectV1Request() # noqa: E501 + model = SubnetCreateObjectV1Request() if include_optional: return SubnetCreateObjectV1Request( a_obj_subnet = [ diff --git a/test/test_subnet_create_object_v1_response.py b/test/test_subnet_create_object_v1_response.py index d990d90b5..e93b61f01 100644 --- a/test/test_subnet_create_object_v1_response.py +++ b/test/test_subnet_create_object_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.subnet_create_object_v1_response import SubnetCreateObjectV1Response # noqa: E501 +from eZmaxApi.models.subnet_create_object_v1_response import SubnetCreateObjectV1Response class TestSubnetCreateObjectV1Response(unittest.TestCase): """SubnetCreateObjectV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> SubnetCreateObjectV1Response: optional params are included """ # uncomment below to create an instance of `SubnetCreateObjectV1Response` """ - model = SubnetCreateObjectV1Response() # noqa: E501 + model = SubnetCreateObjectV1Response() if include_optional: return SubnetCreateObjectV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_subnet_create_object_v1_response_m_payload.py b/test/test_subnet_create_object_v1_response_m_payload.py index 7594c08cd..cea5975f4 100644 --- a/test/test_subnet_create_object_v1_response_m_payload.py +++ b/test/test_subnet_create_object_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.subnet_create_object_v1_response_m_payload import SubnetCreateObjectV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.subnet_create_object_v1_response_m_payload import SubnetCreateObjectV1ResponseMPayload class TestSubnetCreateObjectV1ResponseMPayload(unittest.TestCase): """SubnetCreateObjectV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> SubnetCreateObjectV1ResponseMPayloa optional params are included """ # uncomment below to create an instance of `SubnetCreateObjectV1ResponseMPayload` """ - model = SubnetCreateObjectV1ResponseMPayload() # noqa: E501 + model = SubnetCreateObjectV1ResponseMPayload() if include_optional: return SubnetCreateObjectV1ResponseMPayload( a_pki_subnet_id = [ diff --git a/test/test_subnet_delete_object_v1_response.py b/test/test_subnet_delete_object_v1_response.py index 5e1a5d081..f10c56567 100644 --- a/test/test_subnet_delete_object_v1_response.py +++ b/test/test_subnet_delete_object_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.subnet_delete_object_v1_response import SubnetDeleteObjectV1Response # noqa: E501 +from eZmaxApi.models.subnet_delete_object_v1_response import SubnetDeleteObjectV1Response class TestSubnetDeleteObjectV1Response(unittest.TestCase): """SubnetDeleteObjectV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> SubnetDeleteObjectV1Response: optional params are included """ # uncomment below to create an instance of `SubnetDeleteObjectV1Response` """ - model = SubnetDeleteObjectV1Response() # noqa: E501 + model = SubnetDeleteObjectV1Response() if include_optional: return SubnetDeleteObjectV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_subnet_edit_object_v1_request.py b/test/test_subnet_edit_object_v1_request.py index fdbe73c04..83e3707a1 100644 --- a/test/test_subnet_edit_object_v1_request.py +++ b/test/test_subnet_edit_object_v1_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.subnet_edit_object_v1_request import SubnetEditObjectV1Request # noqa: E501 +from eZmaxApi.models.subnet_edit_object_v1_request import SubnetEditObjectV1Request class TestSubnetEditObjectV1Request(unittest.TestCase): """SubnetEditObjectV1Request unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> SubnetEditObjectV1Request: optional params are included """ # uncomment below to create an instance of `SubnetEditObjectV1Request` """ - model = SubnetEditObjectV1Request() # noqa: E501 + model = SubnetEditObjectV1Request() if include_optional: return SubnetEditObjectV1Request( obj_subnet = eZmaxApi.models.subnet_request_compound.subnet-RequestCompound() diff --git a/test/test_subnet_edit_object_v1_response.py b/test/test_subnet_edit_object_v1_response.py index 77f38cf9d..398dae92a 100644 --- a/test/test_subnet_edit_object_v1_response.py +++ b/test/test_subnet_edit_object_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.subnet_edit_object_v1_response import SubnetEditObjectV1Response # noqa: E501 +from eZmaxApi.models.subnet_edit_object_v1_response import SubnetEditObjectV1Response class TestSubnetEditObjectV1Response(unittest.TestCase): """SubnetEditObjectV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> SubnetEditObjectV1Response: optional params are included """ # uncomment below to create an instance of `SubnetEditObjectV1Response` """ - model = SubnetEditObjectV1Response() # noqa: E501 + model = SubnetEditObjectV1Response() if include_optional: return SubnetEditObjectV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_subnet_get_object_v2_response.py b/test/test_subnet_get_object_v2_response.py index 387bd8135..d950110b5 100644 --- a/test/test_subnet_get_object_v2_response.py +++ b/test/test_subnet_get_object_v2_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.subnet_get_object_v2_response import SubnetGetObjectV2Response # noqa: E501 +from eZmaxApi.models.subnet_get_object_v2_response import SubnetGetObjectV2Response class TestSubnetGetObjectV2Response(unittest.TestCase): """SubnetGetObjectV2Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> SubnetGetObjectV2Response: optional params are included """ # uncomment below to create an instance of `SubnetGetObjectV2Response` """ - model = SubnetGetObjectV2Response() # noqa: E501 + model = SubnetGetObjectV2Response() if include_optional: return SubnetGetObjectV2Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_subnet_get_object_v2_response_m_payload.py b/test/test_subnet_get_object_v2_response_m_payload.py index 8c94ca273..d0872bb6a 100644 --- a/test/test_subnet_get_object_v2_response_m_payload.py +++ b/test/test_subnet_get_object_v2_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.subnet_get_object_v2_response_m_payload import SubnetGetObjectV2ResponseMPayload # noqa: E501 +from eZmaxApi.models.subnet_get_object_v2_response_m_payload import SubnetGetObjectV2ResponseMPayload class TestSubnetGetObjectV2ResponseMPayload(unittest.TestCase): """SubnetGetObjectV2ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> SubnetGetObjectV2ResponseMPayload: optional params are included """ # uncomment below to create an instance of `SubnetGetObjectV2ResponseMPayload` """ - model = SubnetGetObjectV2ResponseMPayload() # noqa: E501 + model = SubnetGetObjectV2ResponseMPayload() if include_optional: return SubnetGetObjectV2ResponseMPayload( obj_subnet = eZmaxApi.models.subnet_response_compound.subnet-ResponseCompound() diff --git a/test/test_subnet_request.py b/test/test_subnet_request.py index 061d43301..d0051c814 100644 --- a/test/test_subnet_request.py +++ b/test/test_subnet_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.subnet_request import SubnetRequest # noqa: E501 +from eZmaxApi.models.subnet_request import SubnetRequest class TestSubnetRequest(unittest.TestCase): """SubnetRequest unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> SubnetRequest: optional params are included """ # uncomment below to create an instance of `SubnetRequest` """ - model = SubnetRequest() # noqa: E501 + model = SubnetRequest() if include_optional: return SubnetRequest( pki_subnet_id = 3, diff --git a/test/test_subnet_request_compound.py b/test/test_subnet_request_compound.py index 45d11e62e..749761dcf 100644 --- a/test/test_subnet_request_compound.py +++ b/test/test_subnet_request_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.subnet_request_compound import SubnetRequestCompound # noqa: E501 +from eZmaxApi.models.subnet_request_compound import SubnetRequestCompound class TestSubnetRequestCompound(unittest.TestCase): """SubnetRequestCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> SubnetRequestCompound: optional params are included """ # uncomment below to create an instance of `SubnetRequestCompound` """ - model = SubnetRequestCompound() # noqa: E501 + model = SubnetRequestCompound() if include_optional: return SubnetRequestCompound( pki_subnet_id = 3, diff --git a/test/test_subnet_response.py b/test/test_subnet_response.py index 66872297c..1734d788a 100644 --- a/test/test_subnet_response.py +++ b/test/test_subnet_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.subnet_response import SubnetResponse # noqa: E501 +from eZmaxApi.models.subnet_response import SubnetResponse class TestSubnetResponse(unittest.TestCase): """SubnetResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> SubnetResponse: optional params are included """ # uncomment below to create an instance of `SubnetResponse` """ - model = SubnetResponse() # noqa: E501 + model = SubnetResponse() if include_optional: return SubnetResponse( pki_subnet_id = 3, diff --git a/test/test_subnet_response_compound.py b/test/test_subnet_response_compound.py index afefe954f..2f850b76f 100644 --- a/test/test_subnet_response_compound.py +++ b/test/test_subnet_response_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.subnet_response_compound import SubnetResponseCompound # noqa: E501 +from eZmaxApi.models.subnet_response_compound import SubnetResponseCompound class TestSubnetResponseCompound(unittest.TestCase): """SubnetResponseCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> SubnetResponseCompound: optional params are included """ # uncomment below to create an instance of `SubnetResponseCompound` """ - model = SubnetResponseCompound() # noqa: E501 + model = SubnetResponseCompound() if include_optional: return SubnetResponseCompound( pki_subnet_id = 3, diff --git a/test/test_systemconfiguration_edit_object_v1_request.py b/test/test_systemconfiguration_edit_object_v1_request.py index fe70f7b21..a2fc57688 100644 --- a/test/test_systemconfiguration_edit_object_v1_request.py +++ b/test/test_systemconfiguration_edit_object_v1_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.systemconfiguration_edit_object_v1_request import SystemconfigurationEditObjectV1Request # noqa: E501 +from eZmaxApi.models.systemconfiguration_edit_object_v1_request import SystemconfigurationEditObjectV1Request class TestSystemconfigurationEditObjectV1Request(unittest.TestCase): """SystemconfigurationEditObjectV1Request unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> SystemconfigurationEditObjectV1Requ optional params are included """ # uncomment below to create an instance of `SystemconfigurationEditObjectV1Request` """ - model = SystemconfigurationEditObjectV1Request() # noqa: E501 + model = SystemconfigurationEditObjectV1Request() if include_optional: return SystemconfigurationEditObjectV1Request( obj_systemconfiguration = eZmaxApi.models.systemconfiguration_request_compound.systemconfiguration-RequestCompound() diff --git a/test/test_systemconfiguration_edit_object_v1_response.py b/test/test_systemconfiguration_edit_object_v1_response.py index 75052ff7f..40b510ca9 100644 --- a/test/test_systemconfiguration_edit_object_v1_response.py +++ b/test/test_systemconfiguration_edit_object_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.systemconfiguration_edit_object_v1_response import SystemconfigurationEditObjectV1Response # noqa: E501 +from eZmaxApi.models.systemconfiguration_edit_object_v1_response import SystemconfigurationEditObjectV1Response class TestSystemconfigurationEditObjectV1Response(unittest.TestCase): """SystemconfigurationEditObjectV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> SystemconfigurationEditObjectV1Resp optional params are included """ # uncomment below to create an instance of `SystemconfigurationEditObjectV1Response` """ - model = SystemconfigurationEditObjectV1Response() # noqa: E501 + model = SystemconfigurationEditObjectV1Response() if include_optional: return SystemconfigurationEditObjectV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_systemconfiguration_get_object_v2_response.py b/test/test_systemconfiguration_get_object_v2_response.py index 86dfdf21a..9ad9c6f29 100644 --- a/test/test_systemconfiguration_get_object_v2_response.py +++ b/test/test_systemconfiguration_get_object_v2_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.systemconfiguration_get_object_v2_response import SystemconfigurationGetObjectV2Response # noqa: E501 +from eZmaxApi.models.systemconfiguration_get_object_v2_response import SystemconfigurationGetObjectV2Response class TestSystemconfigurationGetObjectV2Response(unittest.TestCase): """SystemconfigurationGetObjectV2Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> SystemconfigurationGetObjectV2Respo optional params are included """ # uncomment below to create an instance of `SystemconfigurationGetObjectV2Response` """ - model = SystemconfigurationGetObjectV2Response() # noqa: E501 + model = SystemconfigurationGetObjectV2Response() if include_optional: return SystemconfigurationGetObjectV2Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_systemconfiguration_get_object_v2_response_m_payload.py b/test/test_systemconfiguration_get_object_v2_response_m_payload.py index c47b98fef..789bec844 100644 --- a/test/test_systemconfiguration_get_object_v2_response_m_payload.py +++ b/test/test_systemconfiguration_get_object_v2_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.systemconfiguration_get_object_v2_response_m_payload import SystemconfigurationGetObjectV2ResponseMPayload # noqa: E501 +from eZmaxApi.models.systemconfiguration_get_object_v2_response_m_payload import SystemconfigurationGetObjectV2ResponseMPayload class TestSystemconfigurationGetObjectV2ResponseMPayload(unittest.TestCase): """SystemconfigurationGetObjectV2ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> SystemconfigurationGetObjectV2Respo optional params are included """ # uncomment below to create an instance of `SystemconfigurationGetObjectV2ResponseMPayload` """ - model = SystemconfigurationGetObjectV2ResponseMPayload() # noqa: E501 + model = SystemconfigurationGetObjectV2ResponseMPayload() if include_optional: return SystemconfigurationGetObjectV2ResponseMPayload( obj_systemconfiguration = eZmaxApi.models.systemconfiguration_response_compound.systemconfiguration-ResponseCompound() diff --git a/test/test_systemconfiguration_request.py b/test/test_systemconfiguration_request.py index 3972d7a23..6e53ef700 100644 --- a/test/test_systemconfiguration_request.py +++ b/test/test_systemconfiguration_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.systemconfiguration_request import SystemconfigurationRequest # noqa: E501 +from eZmaxApi.models.systemconfiguration_request import SystemconfigurationRequest class TestSystemconfigurationRequest(unittest.TestCase): """SystemconfigurationRequest unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> SystemconfigurationRequest: optional params are included """ # uncomment below to create an instance of `SystemconfigurationRequest` """ - model = SystemconfigurationRequest() # noqa: E501 + model = SystemconfigurationRequest() if include_optional: return SystemconfigurationRequest( pki_systemconfiguration_id = 1, diff --git a/test/test_systemconfiguration_request_compound.py b/test/test_systemconfiguration_request_compound.py index cc7d47199..f76b9382a 100644 --- a/test/test_systemconfiguration_request_compound.py +++ b/test/test_systemconfiguration_request_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.systemconfiguration_request_compound import SystemconfigurationRequestCompound # noqa: E501 +from eZmaxApi.models.systemconfiguration_request_compound import SystemconfigurationRequestCompound class TestSystemconfigurationRequestCompound(unittest.TestCase): """SystemconfigurationRequestCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> SystemconfigurationRequestCompound: optional params are included """ # uncomment below to create an instance of `SystemconfigurationRequestCompound` """ - model = SystemconfigurationRequestCompound() # noqa: E501 + model = SystemconfigurationRequestCompound() if include_optional: return SystemconfigurationRequestCompound( pki_systemconfiguration_id = 1, diff --git a/test/test_systemconfiguration_response.py b/test/test_systemconfiguration_response.py index 68a61052d..51b5ae859 100644 --- a/test/test_systemconfiguration_response.py +++ b/test/test_systemconfiguration_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.systemconfiguration_response import SystemconfigurationResponse # noqa: E501 +from eZmaxApi.models.systemconfiguration_response import SystemconfigurationResponse class TestSystemconfigurationResponse(unittest.TestCase): """SystemconfigurationResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> SystemconfigurationResponse: optional params are included """ # uncomment below to create an instance of `SystemconfigurationResponse` """ - model = SystemconfigurationResponse() # noqa: E501 + model = SystemconfigurationResponse() if include_optional: return SystemconfigurationResponse( pki_systemconfiguration_id = 1, diff --git a/test/test_systemconfiguration_response_compound.py b/test/test_systemconfiguration_response_compound.py index 9ba2e88b3..2c7b68dd0 100644 --- a/test/test_systemconfiguration_response_compound.py +++ b/test/test_systemconfiguration_response_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.systemconfiguration_response_compound import SystemconfigurationResponseCompound # noqa: E501 +from eZmaxApi.models.systemconfiguration_response_compound import SystemconfigurationResponseCompound class TestSystemconfigurationResponseCompound(unittest.TestCase): """SystemconfigurationResponseCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> SystemconfigurationResponseCompound optional params are included """ # uncomment below to create an instance of `SystemconfigurationResponseCompound` """ - model = SystemconfigurationResponseCompound() # noqa: E501 + model = SystemconfigurationResponseCompound() if include_optional: return SystemconfigurationResponseCompound( pki_systemconfiguration_id = 1, diff --git a/test/test_taxassignment_autocomplete_element_response.py b/test/test_taxassignment_autocomplete_element_response.py index cf84fbd51..742e828c1 100644 --- a/test/test_taxassignment_autocomplete_element_response.py +++ b/test/test_taxassignment_autocomplete_element_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.taxassignment_autocomplete_element_response import TaxassignmentAutocompleteElementResponse # noqa: E501 +from eZmaxApi.models.taxassignment_autocomplete_element_response import TaxassignmentAutocompleteElementResponse class TestTaxassignmentAutocompleteElementResponse(unittest.TestCase): """TaxassignmentAutocompleteElementResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> TaxassignmentAutocompleteElementRes optional params are included """ # uncomment below to create an instance of `TaxassignmentAutocompleteElementResponse` """ - model = TaxassignmentAutocompleteElementResponse() # noqa: E501 + model = TaxassignmentAutocompleteElementResponse() if include_optional: return TaxassignmentAutocompleteElementResponse( s_taxassignment_description_x = 'Default', diff --git a/test/test_taxassignment_get_autocomplete_v2_response.py b/test/test_taxassignment_get_autocomplete_v2_response.py index 0ddbe28b4..7af4fc6b8 100644 --- a/test/test_taxassignment_get_autocomplete_v2_response.py +++ b/test/test_taxassignment_get_autocomplete_v2_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.taxassignment_get_autocomplete_v2_response import TaxassignmentGetAutocompleteV2Response # noqa: E501 +from eZmaxApi.models.taxassignment_get_autocomplete_v2_response import TaxassignmentGetAutocompleteV2Response class TestTaxassignmentGetAutocompleteV2Response(unittest.TestCase): """TaxassignmentGetAutocompleteV2Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> TaxassignmentGetAutocompleteV2Respo optional params are included """ # uncomment below to create an instance of `TaxassignmentGetAutocompleteV2Response` """ - model = TaxassignmentGetAutocompleteV2Response() # noqa: E501 + model = TaxassignmentGetAutocompleteV2Response() if include_optional: return TaxassignmentGetAutocompleteV2Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_taxassignment_get_autocomplete_v2_response_m_payload.py b/test/test_taxassignment_get_autocomplete_v2_response_m_payload.py index 8d41003be..c9d1415f9 100644 --- a/test/test_taxassignment_get_autocomplete_v2_response_m_payload.py +++ b/test/test_taxassignment_get_autocomplete_v2_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.taxassignment_get_autocomplete_v2_response_m_payload import TaxassignmentGetAutocompleteV2ResponseMPayload # noqa: E501 +from eZmaxApi.models.taxassignment_get_autocomplete_v2_response_m_payload import TaxassignmentGetAutocompleteV2ResponseMPayload class TestTaxassignmentGetAutocompleteV2ResponseMPayload(unittest.TestCase): """TaxassignmentGetAutocompleteV2ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> TaxassignmentGetAutocompleteV2Respo optional params are included """ # uncomment below to create an instance of `TaxassignmentGetAutocompleteV2ResponseMPayload` """ - model = TaxassignmentGetAutocompleteV2ResponseMPayload() # noqa: E501 + model = TaxassignmentGetAutocompleteV2ResponseMPayload() if include_optional: return TaxassignmentGetAutocompleteV2ResponseMPayload( a_obj_taxassignment = [ diff --git a/test/test_textstylestatic_response.py b/test/test_textstylestatic_response.py index d648fa36d..8116dd158 100644 --- a/test/test_textstylestatic_response.py +++ b/test/test_textstylestatic_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.textstylestatic_response import TextstylestaticResponse # noqa: E501 +from eZmaxApi.models.textstylestatic_response import TextstylestaticResponse class TestTextstylestaticResponse(unittest.TestCase): """TextstylestaticResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> TextstylestaticResponse: optional params are included """ # uncomment below to create an instance of `TextstylestaticResponse` """ - model = TextstylestaticResponse() # noqa: E501 + model = TextstylestaticResponse() if include_optional: return TextstylestaticResponse( pki_textstylestatic_id = 216, diff --git a/test/test_textstylestatic_response_compound.py b/test/test_textstylestatic_response_compound.py index 70d9a5968..96db73ce3 100644 --- a/test/test_textstylestatic_response_compound.py +++ b/test/test_textstylestatic_response_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.textstylestatic_response_compound import TextstylestaticResponseCompound # noqa: E501 +from eZmaxApi.models.textstylestatic_response_compound import TextstylestaticResponseCompound class TestTextstylestaticResponseCompound(unittest.TestCase): """TextstylestaticResponseCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> TextstylestaticResponseCompound: optional params are included """ # uncomment below to create an instance of `TextstylestaticResponseCompound` """ - model = TextstylestaticResponseCompound() # noqa: E501 + model = TextstylestaticResponseCompound() if include_optional: return TextstylestaticResponseCompound( pki_textstylestatic_id = 216, diff --git a/test/test_timezone_autocomplete_element_response.py b/test/test_timezone_autocomplete_element_response.py index f30539657..63adbc159 100644 --- a/test/test_timezone_autocomplete_element_response.py +++ b/test/test_timezone_autocomplete_element_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.timezone_autocomplete_element_response import TimezoneAutocompleteElementResponse # noqa: E501 +from eZmaxApi.models.timezone_autocomplete_element_response import TimezoneAutocompleteElementResponse class TestTimezoneAutocompleteElementResponse(unittest.TestCase): """TimezoneAutocompleteElementResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> TimezoneAutocompleteElementResponse optional params are included """ # uncomment below to create an instance of `TimezoneAutocompleteElementResponse` """ - model = TimezoneAutocompleteElementResponse() # noqa: E501 + model = TimezoneAutocompleteElementResponse() if include_optional: return TimezoneAutocompleteElementResponse( s_timezone_name = 'Default', diff --git a/test/test_timezone_get_autocomplete_v2_response.py b/test/test_timezone_get_autocomplete_v2_response.py index bc0129610..2605e7f8d 100644 --- a/test/test_timezone_get_autocomplete_v2_response.py +++ b/test/test_timezone_get_autocomplete_v2_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.timezone_get_autocomplete_v2_response import TimezoneGetAutocompleteV2Response # noqa: E501 +from eZmaxApi.models.timezone_get_autocomplete_v2_response import TimezoneGetAutocompleteV2Response class TestTimezoneGetAutocompleteV2Response(unittest.TestCase): """TimezoneGetAutocompleteV2Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> TimezoneGetAutocompleteV2Response: optional params are included """ # uncomment below to create an instance of `TimezoneGetAutocompleteV2Response` """ - model = TimezoneGetAutocompleteV2Response() # noqa: E501 + model = TimezoneGetAutocompleteV2Response() if include_optional: return TimezoneGetAutocompleteV2Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_timezone_get_autocomplete_v2_response_m_payload.py b/test/test_timezone_get_autocomplete_v2_response_m_payload.py index e2ed7c645..aa63ab0d4 100644 --- a/test/test_timezone_get_autocomplete_v2_response_m_payload.py +++ b/test/test_timezone_get_autocomplete_v2_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.timezone_get_autocomplete_v2_response_m_payload import TimezoneGetAutocompleteV2ResponseMPayload # noqa: E501 +from eZmaxApi.models.timezone_get_autocomplete_v2_response_m_payload import TimezoneGetAutocompleteV2ResponseMPayload class TestTimezoneGetAutocompleteV2ResponseMPayload(unittest.TestCase): """TimezoneGetAutocompleteV2ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> TimezoneGetAutocompleteV2ResponseMP optional params are included """ # uncomment below to create an instance of `TimezoneGetAutocompleteV2ResponseMPayload` """ - model = TimezoneGetAutocompleteV2ResponseMPayload() # noqa: E501 + model = TimezoneGetAutocompleteV2ResponseMPayload() if include_optional: return TimezoneGetAutocompleteV2ResponseMPayload( a_obj_timezone = [ diff --git a/test/test_user_autocomplete_element_response.py b/test/test_user_autocomplete_element_response.py index 67eef4103..fad0dc21c 100644 --- a/test/test_user_autocomplete_element_response.py +++ b/test/test_user_autocomplete_element_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.user_autocomplete_element_response import UserAutocompleteElementResponse # noqa: E501 +from eZmaxApi.models.user_autocomplete_element_response import UserAutocompleteElementResponse class TestUserAutocompleteElementResponse(unittest.TestCase): """UserAutocompleteElementResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> UserAutocompleteElementResponse: optional params are included """ # uncomment below to create an instance of `UserAutocompleteElementResponse` """ - model = UserAutocompleteElementResponse() # noqa: E501 + model = UserAutocompleteElementResponse() if include_optional: return UserAutocompleteElementResponse( e_user_type = 'EzsignUser', diff --git a/test/test_user_create_ezsignuser_v1_request.py b/test/test_user_create_ezsignuser_v1_request.py index fec4a68b4..b3a6f9a88 100644 --- a/test/test_user_create_ezsignuser_v1_request.py +++ b/test/test_user_create_ezsignuser_v1_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.user_create_ezsignuser_v1_request import UserCreateEzsignuserV1Request # noqa: E501 +from eZmaxApi.models.user_create_ezsignuser_v1_request import UserCreateEzsignuserV1Request class TestUserCreateEzsignuserV1Request(unittest.TestCase): """UserCreateEzsignuserV1Request unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> UserCreateEzsignuserV1Request: optional params are included """ # uncomment below to create an instance of `UserCreateEzsignuserV1Request` """ - model = UserCreateEzsignuserV1Request() # noqa: E501 + model = UserCreateEzsignuserV1Request() if include_optional: return UserCreateEzsignuserV1Request( fki_language_id = 2, diff --git a/test/test_user_create_ezsignuser_v1_response.py b/test/test_user_create_ezsignuser_v1_response.py index 125f05b9e..d4c018e69 100644 --- a/test/test_user_create_ezsignuser_v1_response.py +++ b/test/test_user_create_ezsignuser_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.user_create_ezsignuser_v1_response import UserCreateEzsignuserV1Response # noqa: E501 +from eZmaxApi.models.user_create_ezsignuser_v1_response import UserCreateEzsignuserV1Response class TestUserCreateEzsignuserV1Response(unittest.TestCase): """UserCreateEzsignuserV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> UserCreateEzsignuserV1Response: optional params are included """ # uncomment below to create an instance of `UserCreateEzsignuserV1Response` """ - model = UserCreateEzsignuserV1Response() # noqa: E501 + model = UserCreateEzsignuserV1Response() if include_optional: return UserCreateEzsignuserV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_user_create_ezsignuser_v1_response_m_payload.py b/test/test_user_create_ezsignuser_v1_response_m_payload.py index 41e543eab..1440dc60d 100644 --- a/test/test_user_create_ezsignuser_v1_response_m_payload.py +++ b/test/test_user_create_ezsignuser_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.user_create_ezsignuser_v1_response_m_payload import UserCreateEzsignuserV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.user_create_ezsignuser_v1_response_m_payload import UserCreateEzsignuserV1ResponseMPayload class TestUserCreateEzsignuserV1ResponseMPayload(unittest.TestCase): """UserCreateEzsignuserV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> UserCreateEzsignuserV1ResponseMPayl optional params are included """ # uncomment below to create an instance of `UserCreateEzsignuserV1ResponseMPayload` """ - model = UserCreateEzsignuserV1ResponseMPayload() # noqa: E501 + model = UserCreateEzsignuserV1ResponseMPayload() if include_optional: return UserCreateEzsignuserV1ResponseMPayload( a_s_email_address_success = [ diff --git a/test/test_user_create_object_v1_request.py b/test/test_user_create_object_v1_request.py index 1877ce66f..68475c4d9 100644 --- a/test/test_user_create_object_v1_request.py +++ b/test/test_user_create_object_v1_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.user_create_object_v1_request import UserCreateObjectV1Request # noqa: E501 +from eZmaxApi.models.user_create_object_v1_request import UserCreateObjectV1Request class TestUserCreateObjectV1Request(unittest.TestCase): """UserCreateObjectV1Request unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> UserCreateObjectV1Request: optional params are included """ # uncomment below to create an instance of `UserCreateObjectV1Request` """ - model = UserCreateObjectV1Request() # noqa: E501 + model = UserCreateObjectV1Request() if include_optional: return UserCreateObjectV1Request( a_obj_user = [ diff --git a/test/test_user_create_object_v1_response.py b/test/test_user_create_object_v1_response.py index 81c207e5a..348b12c55 100644 --- a/test/test_user_create_object_v1_response.py +++ b/test/test_user_create_object_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.user_create_object_v1_response import UserCreateObjectV1Response # noqa: E501 +from eZmaxApi.models.user_create_object_v1_response import UserCreateObjectV1Response class TestUserCreateObjectV1Response(unittest.TestCase): """UserCreateObjectV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> UserCreateObjectV1Response: optional params are included """ # uncomment below to create an instance of `UserCreateObjectV1Response` """ - model = UserCreateObjectV1Response() # noqa: E501 + model = UserCreateObjectV1Response() if include_optional: return UserCreateObjectV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_user_create_object_v1_response_m_payload.py b/test/test_user_create_object_v1_response_m_payload.py index 373b8bc3a..27cc4f7ea 100644 --- a/test/test_user_create_object_v1_response_m_payload.py +++ b/test/test_user_create_object_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.user_create_object_v1_response_m_payload import UserCreateObjectV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.user_create_object_v1_response_m_payload import UserCreateObjectV1ResponseMPayload class TestUserCreateObjectV1ResponseMPayload(unittest.TestCase): """UserCreateObjectV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> UserCreateObjectV1ResponseMPayload: optional params are included """ # uncomment below to create an instance of `UserCreateObjectV1ResponseMPayload` """ - model = UserCreateObjectV1ResponseMPayload() # noqa: E501 + model = UserCreateObjectV1ResponseMPayload() if include_optional: return UserCreateObjectV1ResponseMPayload( a_pki_user_id = [ diff --git a/test/test_user_edit_object_v1_request.py b/test/test_user_edit_object_v1_request.py index 5f38f7c95..ecff4d083 100644 --- a/test/test_user_edit_object_v1_request.py +++ b/test/test_user_edit_object_v1_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.user_edit_object_v1_request import UserEditObjectV1Request # noqa: E501 +from eZmaxApi.models.user_edit_object_v1_request import UserEditObjectV1Request class TestUserEditObjectV1Request(unittest.TestCase): """UserEditObjectV1Request unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> UserEditObjectV1Request: optional params are included """ # uncomment below to create an instance of `UserEditObjectV1Request` """ - model = UserEditObjectV1Request() # noqa: E501 + model = UserEditObjectV1Request() if include_optional: return UserEditObjectV1Request( obj_user = eZmaxApi.models.user_request_compound.user-RequestCompound() diff --git a/test/test_user_edit_object_v1_response.py b/test/test_user_edit_object_v1_response.py index 111abf4de..f5faa418d 100644 --- a/test/test_user_edit_object_v1_response.py +++ b/test/test_user_edit_object_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.user_edit_object_v1_response import UserEditObjectV1Response # noqa: E501 +from eZmaxApi.models.user_edit_object_v1_response import UserEditObjectV1Response class TestUserEditObjectV1Response(unittest.TestCase): """UserEditObjectV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> UserEditObjectV1Response: optional params are included """ # uncomment below to create an instance of `UserEditObjectV1Response` """ - model = UserEditObjectV1Response() # noqa: E501 + model = UserEditObjectV1Response() if include_optional: return UserEditObjectV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_user_edit_permissions_v1_request.py b/test/test_user_edit_permissions_v1_request.py index b1f0c5039..4c87ebf92 100644 --- a/test/test_user_edit_permissions_v1_request.py +++ b/test/test_user_edit_permissions_v1_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.user_edit_permissions_v1_request import UserEditPermissionsV1Request # noqa: E501 +from eZmaxApi.models.user_edit_permissions_v1_request import UserEditPermissionsV1Request class TestUserEditPermissionsV1Request(unittest.TestCase): """UserEditPermissionsV1Request unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> UserEditPermissionsV1Request: optional params are included """ # uncomment below to create an instance of `UserEditPermissionsV1Request` """ - model = UserEditPermissionsV1Request() # noqa: E501 + model = UserEditPermissionsV1Request() if include_optional: return UserEditPermissionsV1Request( a_obj_permission = [ diff --git a/test/test_user_edit_permissions_v1_response.py b/test/test_user_edit_permissions_v1_response.py index 39a8ed25b..d036cac05 100644 --- a/test/test_user_edit_permissions_v1_response.py +++ b/test/test_user_edit_permissions_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.user_edit_permissions_v1_response import UserEditPermissionsV1Response # noqa: E501 +from eZmaxApi.models.user_edit_permissions_v1_response import UserEditPermissionsV1Response class TestUserEditPermissionsV1Response(unittest.TestCase): """UserEditPermissionsV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> UserEditPermissionsV1Response: optional params are included """ # uncomment below to create an instance of `UserEditPermissionsV1Response` """ - model = UserEditPermissionsV1Response() # noqa: E501 + model = UserEditPermissionsV1Response() if include_optional: return UserEditPermissionsV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_user_edit_permissions_v1_response_m_payload.py b/test/test_user_edit_permissions_v1_response_m_payload.py index d4c71d39e..717edff26 100644 --- a/test/test_user_edit_permissions_v1_response_m_payload.py +++ b/test/test_user_edit_permissions_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.user_edit_permissions_v1_response_m_payload import UserEditPermissionsV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.user_edit_permissions_v1_response_m_payload import UserEditPermissionsV1ResponseMPayload class TestUserEditPermissionsV1ResponseMPayload(unittest.TestCase): """UserEditPermissionsV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> UserEditPermissionsV1ResponseMPaylo optional params are included """ # uncomment below to create an instance of `UserEditPermissionsV1ResponseMPayload` """ - model = UserEditPermissionsV1ResponseMPayload() # noqa: E501 + model = UserEditPermissionsV1ResponseMPayload() if include_optional: return UserEditPermissionsV1ResponseMPayload( a_pki_permission_id = [ diff --git a/test/test_user_get_apikeys_v1_response.py b/test/test_user_get_apikeys_v1_response.py index fb4334c1a..eeab28b43 100644 --- a/test/test_user_get_apikeys_v1_response.py +++ b/test/test_user_get_apikeys_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.user_get_apikeys_v1_response import UserGetApikeysV1Response # noqa: E501 +from eZmaxApi.models.user_get_apikeys_v1_response import UserGetApikeysV1Response class TestUserGetApikeysV1Response(unittest.TestCase): """UserGetApikeysV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> UserGetApikeysV1Response: optional params are included """ # uncomment below to create an instance of `UserGetApikeysV1Response` """ - model = UserGetApikeysV1Response() # noqa: E501 + model = UserGetApikeysV1Response() if include_optional: return UserGetApikeysV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_user_get_apikeys_v1_response_m_payload.py b/test/test_user_get_apikeys_v1_response_m_payload.py index 4b1b8f9b2..e229ce816 100644 --- a/test/test_user_get_apikeys_v1_response_m_payload.py +++ b/test/test_user_get_apikeys_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.user_get_apikeys_v1_response_m_payload import UserGetApikeysV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.user_get_apikeys_v1_response_m_payload import UserGetApikeysV1ResponseMPayload class TestUserGetApikeysV1ResponseMPayload(unittest.TestCase): """UserGetApikeysV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> UserGetApikeysV1ResponseMPayload: optional params are included """ # uncomment below to create an instance of `UserGetApikeysV1ResponseMPayload` """ - model = UserGetApikeysV1ResponseMPayload() # noqa: E501 + model = UserGetApikeysV1ResponseMPayload() if include_optional: return UserGetApikeysV1ResponseMPayload( a_obj_apikey = [ diff --git a/test/test_user_get_autocomplete_v2_response.py b/test/test_user_get_autocomplete_v2_response.py index e1752182a..cbd6c1da9 100644 --- a/test/test_user_get_autocomplete_v2_response.py +++ b/test/test_user_get_autocomplete_v2_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.user_get_autocomplete_v2_response import UserGetAutocompleteV2Response # noqa: E501 +from eZmaxApi.models.user_get_autocomplete_v2_response import UserGetAutocompleteV2Response class TestUserGetAutocompleteV2Response(unittest.TestCase): """UserGetAutocompleteV2Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> UserGetAutocompleteV2Response: optional params are included """ # uncomment below to create an instance of `UserGetAutocompleteV2Response` """ - model = UserGetAutocompleteV2Response() # noqa: E501 + model = UserGetAutocompleteV2Response() if include_optional: return UserGetAutocompleteV2Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_user_get_autocomplete_v2_response_m_payload.py b/test/test_user_get_autocomplete_v2_response_m_payload.py index a5ef56321..a598c8cf8 100644 --- a/test/test_user_get_autocomplete_v2_response_m_payload.py +++ b/test/test_user_get_autocomplete_v2_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.user_get_autocomplete_v2_response_m_payload import UserGetAutocompleteV2ResponseMPayload # noqa: E501 +from eZmaxApi.models.user_get_autocomplete_v2_response_m_payload import UserGetAutocompleteV2ResponseMPayload class TestUserGetAutocompleteV2ResponseMPayload(unittest.TestCase): """UserGetAutocompleteV2ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> UserGetAutocompleteV2ResponseMPaylo optional params are included """ # uncomment below to create an instance of `UserGetAutocompleteV2ResponseMPayload` """ - model = UserGetAutocompleteV2ResponseMPayload() # noqa: E501 + model = UserGetAutocompleteV2ResponseMPayload() if include_optional: return UserGetAutocompleteV2ResponseMPayload( a_obj_user = [ diff --git a/test/test_user_get_effective_permissions_v1_response.py b/test/test_user_get_effective_permissions_v1_response.py index 623999559..1ca4d8c60 100644 --- a/test/test_user_get_effective_permissions_v1_response.py +++ b/test/test_user_get_effective_permissions_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.user_get_effective_permissions_v1_response import UserGetEffectivePermissionsV1Response # noqa: E501 +from eZmaxApi.models.user_get_effective_permissions_v1_response import UserGetEffectivePermissionsV1Response class TestUserGetEffectivePermissionsV1Response(unittest.TestCase): """UserGetEffectivePermissionsV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> UserGetEffectivePermissionsV1Respon optional params are included """ # uncomment below to create an instance of `UserGetEffectivePermissionsV1Response` """ - model = UserGetEffectivePermissionsV1Response() # noqa: E501 + model = UserGetEffectivePermissionsV1Response() if include_optional: return UserGetEffectivePermissionsV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_user_get_effective_permissions_v1_response_m_payload.py b/test/test_user_get_effective_permissions_v1_response_m_payload.py index f41983659..7d45a5fc5 100644 --- a/test/test_user_get_effective_permissions_v1_response_m_payload.py +++ b/test/test_user_get_effective_permissions_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.user_get_effective_permissions_v1_response_m_payload import UserGetEffectivePermissionsV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.user_get_effective_permissions_v1_response_m_payload import UserGetEffectivePermissionsV1ResponseMPayload class TestUserGetEffectivePermissionsV1ResponseMPayload(unittest.TestCase): """UserGetEffectivePermissionsV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> UserGetEffectivePermissionsV1Respon optional params are included """ # uncomment below to create an instance of `UserGetEffectivePermissionsV1ResponseMPayload` """ - model = UserGetEffectivePermissionsV1ResponseMPayload() # noqa: E501 + model = UserGetEffectivePermissionsV1ResponseMPayload() if include_optional: return UserGetEffectivePermissionsV1ResponseMPayload( a_obj_modulegroup = [ diff --git a/test/test_user_get_list_v1_response.py b/test/test_user_get_list_v1_response.py index 233966fbe..c5bc8985f 100644 --- a/test/test_user_get_list_v1_response.py +++ b/test/test_user_get_list_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.user_get_list_v1_response import UserGetListV1Response # noqa: E501 +from eZmaxApi.models.user_get_list_v1_response import UserGetListV1Response class TestUserGetListV1Response(unittest.TestCase): """UserGetListV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> UserGetListV1Response: optional params are included """ # uncomment below to create an instance of `UserGetListV1Response` """ - model = UserGetListV1Response() # noqa: E501 + model = UserGetListV1Response() if include_optional: return UserGetListV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload_get_list.Common-Response-objDebugPayload_getList(), diff --git a/test/test_user_get_list_v1_response_m_payload.py b/test/test_user_get_list_v1_response_m_payload.py index 0ac96492c..f5866af38 100644 --- a/test/test_user_get_list_v1_response_m_payload.py +++ b/test/test_user_get_list_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.user_get_list_v1_response_m_payload import UserGetListV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.user_get_list_v1_response_m_payload import UserGetListV1ResponseMPayload class TestUserGetListV1ResponseMPayload(unittest.TestCase): """UserGetListV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> UserGetListV1ResponseMPayload: optional params are included """ # uncomment below to create an instance of `UserGetListV1ResponseMPayload` """ - model = UserGetListV1ResponseMPayload() # noqa: E501 + model = UserGetListV1ResponseMPayload() if include_optional: return UserGetListV1ResponseMPayload( i_row_returned = 100, diff --git a/test/test_user_get_object_v2_response.py b/test/test_user_get_object_v2_response.py index 2aa3827da..0c1e15fa1 100644 --- a/test/test_user_get_object_v2_response.py +++ b/test/test_user_get_object_v2_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.user_get_object_v2_response import UserGetObjectV2Response # noqa: E501 +from eZmaxApi.models.user_get_object_v2_response import UserGetObjectV2Response class TestUserGetObjectV2Response(unittest.TestCase): """UserGetObjectV2Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> UserGetObjectV2Response: optional params are included """ # uncomment below to create an instance of `UserGetObjectV2Response` """ - model = UserGetObjectV2Response() # noqa: E501 + model = UserGetObjectV2Response() if include_optional: return UserGetObjectV2Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_user_get_object_v2_response_m_payload.py b/test/test_user_get_object_v2_response_m_payload.py index cfd3a2f49..55aed57e9 100644 --- a/test/test_user_get_object_v2_response_m_payload.py +++ b/test/test_user_get_object_v2_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.user_get_object_v2_response_m_payload import UserGetObjectV2ResponseMPayload # noqa: E501 +from eZmaxApi.models.user_get_object_v2_response_m_payload import UserGetObjectV2ResponseMPayload class TestUserGetObjectV2ResponseMPayload(unittest.TestCase): """UserGetObjectV2ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> UserGetObjectV2ResponseMPayload: optional params are included """ # uncomment below to create an instance of `UserGetObjectV2ResponseMPayload` """ - model = UserGetObjectV2ResponseMPayload() # noqa: E501 + model = UserGetObjectV2ResponseMPayload() if include_optional: return UserGetObjectV2ResponseMPayload( obj_user = eZmaxApi.models.user_response_compound.user-ResponseCompound() diff --git a/test/test_user_get_permissions_v1_response.py b/test/test_user_get_permissions_v1_response.py index 7e307418d..410b9ac53 100644 --- a/test/test_user_get_permissions_v1_response.py +++ b/test/test_user_get_permissions_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.user_get_permissions_v1_response import UserGetPermissionsV1Response # noqa: E501 +from eZmaxApi.models.user_get_permissions_v1_response import UserGetPermissionsV1Response class TestUserGetPermissionsV1Response(unittest.TestCase): """UserGetPermissionsV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> UserGetPermissionsV1Response: optional params are included """ # uncomment below to create an instance of `UserGetPermissionsV1Response` """ - model = UserGetPermissionsV1Response() # noqa: E501 + model = UserGetPermissionsV1Response() if include_optional: return UserGetPermissionsV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_user_get_permissions_v1_response_m_payload.py b/test/test_user_get_permissions_v1_response_m_payload.py index 12e84b959..0ef866685 100644 --- a/test/test_user_get_permissions_v1_response_m_payload.py +++ b/test/test_user_get_permissions_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.user_get_permissions_v1_response_m_payload import UserGetPermissionsV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.user_get_permissions_v1_response_m_payload import UserGetPermissionsV1ResponseMPayload class TestUserGetPermissionsV1ResponseMPayload(unittest.TestCase): """UserGetPermissionsV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> UserGetPermissionsV1ResponseMPayloa optional params are included """ # uncomment below to create an instance of `UserGetPermissionsV1ResponseMPayload` """ - model = UserGetPermissionsV1ResponseMPayload() # noqa: E501 + model = UserGetPermissionsV1ResponseMPayload() if include_optional: return UserGetPermissionsV1ResponseMPayload( a_obj_modulegroup = [ diff --git a/test/test_user_get_subnets_v1_response.py b/test/test_user_get_subnets_v1_response.py index cf0cc03af..f014da05a 100644 --- a/test/test_user_get_subnets_v1_response.py +++ b/test/test_user_get_subnets_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.user_get_subnets_v1_response import UserGetSubnetsV1Response # noqa: E501 +from eZmaxApi.models.user_get_subnets_v1_response import UserGetSubnetsV1Response class TestUserGetSubnetsV1Response(unittest.TestCase): """UserGetSubnetsV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> UserGetSubnetsV1Response: optional params are included """ # uncomment below to create an instance of `UserGetSubnetsV1Response` """ - model = UserGetSubnetsV1Response() # noqa: E501 + model = UserGetSubnetsV1Response() if include_optional: return UserGetSubnetsV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_user_get_subnets_v1_response_m_payload.py b/test/test_user_get_subnets_v1_response_m_payload.py index b22eed78a..5b45eed93 100644 --- a/test/test_user_get_subnets_v1_response_m_payload.py +++ b/test/test_user_get_subnets_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.user_get_subnets_v1_response_m_payload import UserGetSubnetsV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.user_get_subnets_v1_response_m_payload import UserGetSubnetsV1ResponseMPayload class TestUserGetSubnetsV1ResponseMPayload(unittest.TestCase): """UserGetSubnetsV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> UserGetSubnetsV1ResponseMPayload: optional params are included """ # uncomment below to create an instance of `UserGetSubnetsV1ResponseMPayload` """ - model = UserGetSubnetsV1ResponseMPayload() # noqa: E501 + model = UserGetSubnetsV1ResponseMPayload() if include_optional: return UserGetSubnetsV1ResponseMPayload( a_obj_subnet = [ diff --git a/test/test_user_list_element.py b/test/test_user_list_element.py index a4386e919..69e41e21d 100644 --- a/test/test_user_list_element.py +++ b/test/test_user_list_element.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.user_list_element import UserListElement # noqa: E501 +from eZmaxApi.models.user_list_element import UserListElement class TestUserListElement(unittest.TestCase): """UserListElement unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> UserListElement: optional params are included """ # uncomment below to create an instance of `UserListElement` """ - model = UserListElement() # noqa: E501 + model = UserListElement() if include_optional: return UserListElement( pki_user_id = 70, diff --git a/test/test_user_request.py b/test/test_user_request.py index 63f862b46..8dfd59a57 100644 --- a/test/test_user_request.py +++ b/test/test_user_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.user_request import UserRequest # noqa: E501 +from eZmaxApi.models.user_request import UserRequest class TestUserRequest(unittest.TestCase): """UserRequest unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> UserRequest: optional params are included """ # uncomment below to create an instance of `UserRequest` """ - model = UserRequest() # noqa: E501 + model = UserRequest() if include_optional: return UserRequest( pki_user_id = 70, diff --git a/test/test_user_request_compound.py b/test/test_user_request_compound.py index d167b2d9d..d46684e7d 100644 --- a/test/test_user_request_compound.py +++ b/test/test_user_request_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.user_request_compound import UserRequestCompound # noqa: E501 +from eZmaxApi.models.user_request_compound import UserRequestCompound class TestUserRequestCompound(unittest.TestCase): """UserRequestCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> UserRequestCompound: optional params are included """ # uncomment below to create an instance of `UserRequestCompound` """ - model = UserRequestCompound() # noqa: E501 + model = UserRequestCompound() if include_optional: return UserRequestCompound( pki_user_id = 70, diff --git a/test/test_user_response.py b/test/test_user_response.py index 02386da58..a2adeb7ac 100644 --- a/test/test_user_response.py +++ b/test/test_user_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.user_response import UserResponse # noqa: E501 +from eZmaxApi.models.user_response import UserResponse class TestUserResponse(unittest.TestCase): """UserResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> UserResponse: optional params are included """ # uncomment below to create an instance of `UserResponse` """ - model = UserResponse() # noqa: E501 + model = UserResponse() if include_optional: return UserResponse( pki_user_id = 70, diff --git a/test/test_user_response_compound.py b/test/test_user_response_compound.py index b19661afb..1150cddc6 100644 --- a/test/test_user_response_compound.py +++ b/test/test_user_response_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.user_response_compound import UserResponseCompound # noqa: E501 +from eZmaxApi.models.user_response_compound import UserResponseCompound class TestUserResponseCompound(unittest.TestCase): """UserResponseCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> UserResponseCompound: optional params are included """ # uncomment below to create an instance of `UserResponseCompound` """ - model = UserResponseCompound() # noqa: E501 + model = UserResponseCompound() if include_optional: return UserResponseCompound( pki_user_id = 70, diff --git a/test/test_user_send_password_reset_v1_response.py b/test/test_user_send_password_reset_v1_response.py index 2f2f89295..304cc7586 100644 --- a/test/test_user_send_password_reset_v1_response.py +++ b/test/test_user_send_password_reset_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.user_send_password_reset_v1_response import UserSendPasswordResetV1Response # noqa: E501 +from eZmaxApi.models.user_send_password_reset_v1_response import UserSendPasswordResetV1Response class TestUserSendPasswordResetV1Response(unittest.TestCase): """UserSendPasswordResetV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> UserSendPasswordResetV1Response: optional params are included """ # uncomment below to create an instance of `UserSendPasswordResetV1Response` """ - model = UserSendPasswordResetV1Response() # noqa: E501 + model = UserSendPasswordResetV1Response() if include_optional: return UserSendPasswordResetV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_usergroup_autocomplete_element_response.py b/test/test_usergroup_autocomplete_element_response.py index 3c078daa9..fb87ce693 100644 --- a/test/test_usergroup_autocomplete_element_response.py +++ b/test/test_usergroup_autocomplete_element_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.usergroup_autocomplete_element_response import UsergroupAutocompleteElementResponse # noqa: E501 +from eZmaxApi.models.usergroup_autocomplete_element_response import UsergroupAutocompleteElementResponse class TestUsergroupAutocompleteElementResponse(unittest.TestCase): """UsergroupAutocompleteElementResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> UsergroupAutocompleteElementRespons optional params are included """ # uncomment below to create an instance of `UsergroupAutocompleteElementResponse` """ - model = UsergroupAutocompleteElementResponse() # noqa: E501 + model = UsergroupAutocompleteElementResponse() if include_optional: return UsergroupAutocompleteElementResponse( s_usergroup_name_x = 'Administration', diff --git a/test/test_usergroup_create_object_v1_request.py b/test/test_usergroup_create_object_v1_request.py index b5f6f4a9f..0568ec02c 100644 --- a/test/test_usergroup_create_object_v1_request.py +++ b/test/test_usergroup_create_object_v1_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.usergroup_create_object_v1_request import UsergroupCreateObjectV1Request # noqa: E501 +from eZmaxApi.models.usergroup_create_object_v1_request import UsergroupCreateObjectV1Request class TestUsergroupCreateObjectV1Request(unittest.TestCase): """UsergroupCreateObjectV1Request unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> UsergroupCreateObjectV1Request: optional params are included """ # uncomment below to create an instance of `UsergroupCreateObjectV1Request` """ - model = UsergroupCreateObjectV1Request() # noqa: E501 + model = UsergroupCreateObjectV1Request() if include_optional: return UsergroupCreateObjectV1Request( a_obj_usergroup = [ diff --git a/test/test_usergroup_create_object_v1_response.py b/test/test_usergroup_create_object_v1_response.py index dc8c74e76..d86e0c63d 100644 --- a/test/test_usergroup_create_object_v1_response.py +++ b/test/test_usergroup_create_object_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.usergroup_create_object_v1_response import UsergroupCreateObjectV1Response # noqa: E501 +from eZmaxApi.models.usergroup_create_object_v1_response import UsergroupCreateObjectV1Response class TestUsergroupCreateObjectV1Response(unittest.TestCase): """UsergroupCreateObjectV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> UsergroupCreateObjectV1Response: optional params are included """ # uncomment below to create an instance of `UsergroupCreateObjectV1Response` """ - model = UsergroupCreateObjectV1Response() # noqa: E501 + model = UsergroupCreateObjectV1Response() if include_optional: return UsergroupCreateObjectV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_usergroup_create_object_v1_response_m_payload.py b/test/test_usergroup_create_object_v1_response_m_payload.py index 9899a179b..6f961f850 100644 --- a/test/test_usergroup_create_object_v1_response_m_payload.py +++ b/test/test_usergroup_create_object_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.usergroup_create_object_v1_response_m_payload import UsergroupCreateObjectV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.usergroup_create_object_v1_response_m_payload import UsergroupCreateObjectV1ResponseMPayload class TestUsergroupCreateObjectV1ResponseMPayload(unittest.TestCase): """UsergroupCreateObjectV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> UsergroupCreateObjectV1ResponseMPay optional params are included """ # uncomment below to create an instance of `UsergroupCreateObjectV1ResponseMPayload` """ - model = UsergroupCreateObjectV1ResponseMPayload() # noqa: E501 + model = UsergroupCreateObjectV1ResponseMPayload() if include_optional: return UsergroupCreateObjectV1ResponseMPayload( a_pki_usergroup_id = [ diff --git a/test/test_usergroup_edit_object_v1_request.py b/test/test_usergroup_edit_object_v1_request.py index dbf769f12..f25c00481 100644 --- a/test/test_usergroup_edit_object_v1_request.py +++ b/test/test_usergroup_edit_object_v1_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.usergroup_edit_object_v1_request import UsergroupEditObjectV1Request # noqa: E501 +from eZmaxApi.models.usergroup_edit_object_v1_request import UsergroupEditObjectV1Request class TestUsergroupEditObjectV1Request(unittest.TestCase): """UsergroupEditObjectV1Request unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> UsergroupEditObjectV1Request: optional params are included """ # uncomment below to create an instance of `UsergroupEditObjectV1Request` """ - model = UsergroupEditObjectV1Request() # noqa: E501 + model = UsergroupEditObjectV1Request() if include_optional: return UsergroupEditObjectV1Request( obj_usergroup = eZmaxApi.models.usergroup_request_compound.usergroup-RequestCompound() diff --git a/test/test_usergroup_edit_object_v1_response.py b/test/test_usergroup_edit_object_v1_response.py index 445232db9..bba3488fc 100644 --- a/test/test_usergroup_edit_object_v1_response.py +++ b/test/test_usergroup_edit_object_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.usergroup_edit_object_v1_response import UsergroupEditObjectV1Response # noqa: E501 +from eZmaxApi.models.usergroup_edit_object_v1_response import UsergroupEditObjectV1Response class TestUsergroupEditObjectV1Response(unittest.TestCase): """UsergroupEditObjectV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> UsergroupEditObjectV1Response: optional params are included """ # uncomment below to create an instance of `UsergroupEditObjectV1Response` """ - model = UsergroupEditObjectV1Response() # noqa: E501 + model = UsergroupEditObjectV1Response() if include_optional: return UsergroupEditObjectV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_usergroup_edit_permissions_v1_request.py b/test/test_usergroup_edit_permissions_v1_request.py index a46d6d003..de6511105 100644 --- a/test/test_usergroup_edit_permissions_v1_request.py +++ b/test/test_usergroup_edit_permissions_v1_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.usergroup_edit_permissions_v1_request import UsergroupEditPermissionsV1Request # noqa: E501 +from eZmaxApi.models.usergroup_edit_permissions_v1_request import UsergroupEditPermissionsV1Request class TestUsergroupEditPermissionsV1Request(unittest.TestCase): """UsergroupEditPermissionsV1Request unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> UsergroupEditPermissionsV1Request: optional params are included """ # uncomment below to create an instance of `UsergroupEditPermissionsV1Request` """ - model = UsergroupEditPermissionsV1Request() # noqa: E501 + model = UsergroupEditPermissionsV1Request() if include_optional: return UsergroupEditPermissionsV1Request( a_obj_permission = [ diff --git a/test/test_usergroup_edit_permissions_v1_response.py b/test/test_usergroup_edit_permissions_v1_response.py index b04582ceb..2ad0bc518 100644 --- a/test/test_usergroup_edit_permissions_v1_response.py +++ b/test/test_usergroup_edit_permissions_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.usergroup_edit_permissions_v1_response import UsergroupEditPermissionsV1Response # noqa: E501 +from eZmaxApi.models.usergroup_edit_permissions_v1_response import UsergroupEditPermissionsV1Response class TestUsergroupEditPermissionsV1Response(unittest.TestCase): """UsergroupEditPermissionsV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> UsergroupEditPermissionsV1Response: optional params are included """ # uncomment below to create an instance of `UsergroupEditPermissionsV1Response` """ - model = UsergroupEditPermissionsV1Response() # noqa: E501 + model = UsergroupEditPermissionsV1Response() if include_optional: return UsergroupEditPermissionsV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_usergroup_edit_permissions_v1_response_m_payload.py b/test/test_usergroup_edit_permissions_v1_response_m_payload.py index c554d0b4c..9f6d5ddfb 100644 --- a/test/test_usergroup_edit_permissions_v1_response_m_payload.py +++ b/test/test_usergroup_edit_permissions_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.usergroup_edit_permissions_v1_response_m_payload import UsergroupEditPermissionsV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.usergroup_edit_permissions_v1_response_m_payload import UsergroupEditPermissionsV1ResponseMPayload class TestUsergroupEditPermissionsV1ResponseMPayload(unittest.TestCase): """UsergroupEditPermissionsV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> UsergroupEditPermissionsV1ResponseM optional params are included """ # uncomment below to create an instance of `UsergroupEditPermissionsV1ResponseMPayload` """ - model = UsergroupEditPermissionsV1ResponseMPayload() # noqa: E501 + model = UsergroupEditPermissionsV1ResponseMPayload() if include_optional: return UsergroupEditPermissionsV1ResponseMPayload( a_pki_permission_id = [ diff --git a/test/test_usergroup_edit_usergroupdelegations_v1_request.py b/test/test_usergroup_edit_usergroupdelegations_v1_request.py index 9258488fd..3010af076 100644 --- a/test/test_usergroup_edit_usergroupdelegations_v1_request.py +++ b/test/test_usergroup_edit_usergroupdelegations_v1_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.usergroup_edit_usergroupdelegations_v1_request import UsergroupEditUsergroupdelegationsV1Request # noqa: E501 +from eZmaxApi.models.usergroup_edit_usergroupdelegations_v1_request import UsergroupEditUsergroupdelegationsV1Request class TestUsergroupEditUsergroupdelegationsV1Request(unittest.TestCase): """UsergroupEditUsergroupdelegationsV1Request unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> UsergroupEditUsergroupdelegationsV1 optional params are included """ # uncomment below to create an instance of `UsergroupEditUsergroupdelegationsV1Request` """ - model = UsergroupEditUsergroupdelegationsV1Request() # noqa: E501 + model = UsergroupEditUsergroupdelegationsV1Request() if include_optional: return UsergroupEditUsergroupdelegationsV1Request( a_obj_usergroupdelegation = [ diff --git a/test/test_usergroup_edit_usergroupdelegations_v1_response.py b/test/test_usergroup_edit_usergroupdelegations_v1_response.py index dea71aab7..d173c02ca 100644 --- a/test/test_usergroup_edit_usergroupdelegations_v1_response.py +++ b/test/test_usergroup_edit_usergroupdelegations_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.usergroup_edit_usergroupdelegations_v1_response import UsergroupEditUsergroupdelegationsV1Response # noqa: E501 +from eZmaxApi.models.usergroup_edit_usergroupdelegations_v1_response import UsergroupEditUsergroupdelegationsV1Response class TestUsergroupEditUsergroupdelegationsV1Response(unittest.TestCase): """UsergroupEditUsergroupdelegationsV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> UsergroupEditUsergroupdelegationsV1 optional params are included """ # uncomment below to create an instance of `UsergroupEditUsergroupdelegationsV1Response` """ - model = UsergroupEditUsergroupdelegationsV1Response() # noqa: E501 + model = UsergroupEditUsergroupdelegationsV1Response() if include_optional: return UsergroupEditUsergroupdelegationsV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_usergroup_edit_usergroupdelegations_v1_response_m_payload.py b/test/test_usergroup_edit_usergroupdelegations_v1_response_m_payload.py index 4f574ca32..18654bc5f 100644 --- a/test/test_usergroup_edit_usergroupdelegations_v1_response_m_payload.py +++ b/test/test_usergroup_edit_usergroupdelegations_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.usergroup_edit_usergroupdelegations_v1_response_m_payload import UsergroupEditUsergroupdelegationsV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.usergroup_edit_usergroupdelegations_v1_response_m_payload import UsergroupEditUsergroupdelegationsV1ResponseMPayload class TestUsergroupEditUsergroupdelegationsV1ResponseMPayload(unittest.TestCase): """UsergroupEditUsergroupdelegationsV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> UsergroupEditUsergroupdelegationsV1 optional params are included """ # uncomment below to create an instance of `UsergroupEditUsergroupdelegationsV1ResponseMPayload` """ - model = UsergroupEditUsergroupdelegationsV1ResponseMPayload() # noqa: E501 + model = UsergroupEditUsergroupdelegationsV1ResponseMPayload() if include_optional: return UsergroupEditUsergroupdelegationsV1ResponseMPayload( a_pki_usergroupdelegation_id = [ diff --git a/test/test_usergroup_edit_usergroupmemberships_v1_request.py b/test/test_usergroup_edit_usergroupmemberships_v1_request.py index 640235a23..d7226c7f5 100644 --- a/test/test_usergroup_edit_usergroupmemberships_v1_request.py +++ b/test/test_usergroup_edit_usergroupmemberships_v1_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.usergroup_edit_usergroupmemberships_v1_request import UsergroupEditUsergroupmembershipsV1Request # noqa: E501 +from eZmaxApi.models.usergroup_edit_usergroupmemberships_v1_request import UsergroupEditUsergroupmembershipsV1Request class TestUsergroupEditUsergroupmembershipsV1Request(unittest.TestCase): """UsergroupEditUsergroupmembershipsV1Request unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> UsergroupEditUsergroupmembershipsV1 optional params are included """ # uncomment below to create an instance of `UsergroupEditUsergroupmembershipsV1Request` """ - model = UsergroupEditUsergroupmembershipsV1Request() # noqa: E501 + model = UsergroupEditUsergroupmembershipsV1Request() if include_optional: return UsergroupEditUsergroupmembershipsV1Request( a_obj_usergroupmembership = [ diff --git a/test/test_usergroup_edit_usergroupmemberships_v1_response.py b/test/test_usergroup_edit_usergroupmemberships_v1_response.py index 55ddedbd3..b709ceb82 100644 --- a/test/test_usergroup_edit_usergroupmemberships_v1_response.py +++ b/test/test_usergroup_edit_usergroupmemberships_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.usergroup_edit_usergroupmemberships_v1_response import UsergroupEditUsergroupmembershipsV1Response # noqa: E501 +from eZmaxApi.models.usergroup_edit_usergroupmemberships_v1_response import UsergroupEditUsergroupmembershipsV1Response class TestUsergroupEditUsergroupmembershipsV1Response(unittest.TestCase): """UsergroupEditUsergroupmembershipsV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> UsergroupEditUsergroupmembershipsV1 optional params are included """ # uncomment below to create an instance of `UsergroupEditUsergroupmembershipsV1Response` """ - model = UsergroupEditUsergroupmembershipsV1Response() # noqa: E501 + model = UsergroupEditUsergroupmembershipsV1Response() if include_optional: return UsergroupEditUsergroupmembershipsV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_usergroup_edit_usergroupmemberships_v1_response_m_payload.py b/test/test_usergroup_edit_usergroupmemberships_v1_response_m_payload.py index e2cff94ed..95aed8c62 100644 --- a/test/test_usergroup_edit_usergroupmemberships_v1_response_m_payload.py +++ b/test/test_usergroup_edit_usergroupmemberships_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.usergroup_edit_usergroupmemberships_v1_response_m_payload import UsergroupEditUsergroupmembershipsV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.usergroup_edit_usergroupmemberships_v1_response_m_payload import UsergroupEditUsergroupmembershipsV1ResponseMPayload class TestUsergroupEditUsergroupmembershipsV1ResponseMPayload(unittest.TestCase): """UsergroupEditUsergroupmembershipsV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> UsergroupEditUsergroupmembershipsV1 optional params are included """ # uncomment below to create an instance of `UsergroupEditUsergroupmembershipsV1ResponseMPayload` """ - model = UsergroupEditUsergroupmembershipsV1ResponseMPayload() # noqa: E501 + model = UsergroupEditUsergroupmembershipsV1ResponseMPayload() if include_optional: return UsergroupEditUsergroupmembershipsV1ResponseMPayload( a_pki_usergroupmembership_id = [ diff --git a/test/test_usergroup_get_autocomplete_v2_response.py b/test/test_usergroup_get_autocomplete_v2_response.py index 7af99a601..876eb28e4 100644 --- a/test/test_usergroup_get_autocomplete_v2_response.py +++ b/test/test_usergroup_get_autocomplete_v2_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.usergroup_get_autocomplete_v2_response import UsergroupGetAutocompleteV2Response # noqa: E501 +from eZmaxApi.models.usergroup_get_autocomplete_v2_response import UsergroupGetAutocompleteV2Response class TestUsergroupGetAutocompleteV2Response(unittest.TestCase): """UsergroupGetAutocompleteV2Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> UsergroupGetAutocompleteV2Response: optional params are included """ # uncomment below to create an instance of `UsergroupGetAutocompleteV2Response` """ - model = UsergroupGetAutocompleteV2Response() # noqa: E501 + model = UsergroupGetAutocompleteV2Response() if include_optional: return UsergroupGetAutocompleteV2Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_usergroup_get_autocomplete_v2_response_m_payload.py b/test/test_usergroup_get_autocomplete_v2_response_m_payload.py index 4865a7b01..cfdfc96ec 100644 --- a/test/test_usergroup_get_autocomplete_v2_response_m_payload.py +++ b/test/test_usergroup_get_autocomplete_v2_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.usergroup_get_autocomplete_v2_response_m_payload import UsergroupGetAutocompleteV2ResponseMPayload # noqa: E501 +from eZmaxApi.models.usergroup_get_autocomplete_v2_response_m_payload import UsergroupGetAutocompleteV2ResponseMPayload class TestUsergroupGetAutocompleteV2ResponseMPayload(unittest.TestCase): """UsergroupGetAutocompleteV2ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> UsergroupGetAutocompleteV2ResponseM optional params are included """ # uncomment below to create an instance of `UsergroupGetAutocompleteV2ResponseMPayload` """ - model = UsergroupGetAutocompleteV2ResponseMPayload() # noqa: E501 + model = UsergroupGetAutocompleteV2ResponseMPayload() if include_optional: return UsergroupGetAutocompleteV2ResponseMPayload( a_obj_usergroup = [ diff --git a/test/test_usergroup_get_list_v1_response.py b/test/test_usergroup_get_list_v1_response.py index d543dfb8f..309fdf040 100644 --- a/test/test_usergroup_get_list_v1_response.py +++ b/test/test_usergroup_get_list_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.usergroup_get_list_v1_response import UsergroupGetListV1Response # noqa: E501 +from eZmaxApi.models.usergroup_get_list_v1_response import UsergroupGetListV1Response class TestUsergroupGetListV1Response(unittest.TestCase): """UsergroupGetListV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> UsergroupGetListV1Response: optional params are included """ # uncomment below to create an instance of `UsergroupGetListV1Response` """ - model = UsergroupGetListV1Response() # noqa: E501 + model = UsergroupGetListV1Response() if include_optional: return UsergroupGetListV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload_get_list.Common-Response-objDebugPayload_getList(), diff --git a/test/test_usergroup_get_list_v1_response_m_payload.py b/test/test_usergroup_get_list_v1_response_m_payload.py index a7db99157..d1d676410 100644 --- a/test/test_usergroup_get_list_v1_response_m_payload.py +++ b/test/test_usergroup_get_list_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.usergroup_get_list_v1_response_m_payload import UsergroupGetListV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.usergroup_get_list_v1_response_m_payload import UsergroupGetListV1ResponseMPayload class TestUsergroupGetListV1ResponseMPayload(unittest.TestCase): """UsergroupGetListV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> UsergroupGetListV1ResponseMPayload: optional params are included """ # uncomment below to create an instance of `UsergroupGetListV1ResponseMPayload` """ - model = UsergroupGetListV1ResponseMPayload() # noqa: E501 + model = UsergroupGetListV1ResponseMPayload() if include_optional: return UsergroupGetListV1ResponseMPayload( i_row_returned = 100, diff --git a/test/test_usergroup_get_object_v2_response.py b/test/test_usergroup_get_object_v2_response.py index 6e2cbe688..a94ec1429 100644 --- a/test/test_usergroup_get_object_v2_response.py +++ b/test/test_usergroup_get_object_v2_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.usergroup_get_object_v2_response import UsergroupGetObjectV2Response # noqa: E501 +from eZmaxApi.models.usergroup_get_object_v2_response import UsergroupGetObjectV2Response class TestUsergroupGetObjectV2Response(unittest.TestCase): """UsergroupGetObjectV2Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> UsergroupGetObjectV2Response: optional params are included """ # uncomment below to create an instance of `UsergroupGetObjectV2Response` """ - model = UsergroupGetObjectV2Response() # noqa: E501 + model = UsergroupGetObjectV2Response() if include_optional: return UsergroupGetObjectV2Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_usergroup_get_object_v2_response_m_payload.py b/test/test_usergroup_get_object_v2_response_m_payload.py index 9918dccd8..130c78150 100644 --- a/test/test_usergroup_get_object_v2_response_m_payload.py +++ b/test/test_usergroup_get_object_v2_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.usergroup_get_object_v2_response_m_payload import UsergroupGetObjectV2ResponseMPayload # noqa: E501 +from eZmaxApi.models.usergroup_get_object_v2_response_m_payload import UsergroupGetObjectV2ResponseMPayload class TestUsergroupGetObjectV2ResponseMPayload(unittest.TestCase): """UsergroupGetObjectV2ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> UsergroupGetObjectV2ResponseMPayloa optional params are included """ # uncomment below to create an instance of `UsergroupGetObjectV2ResponseMPayload` """ - model = UsergroupGetObjectV2ResponseMPayload() # noqa: E501 + model = UsergroupGetObjectV2ResponseMPayload() if include_optional: return UsergroupGetObjectV2ResponseMPayload( obj_usergroup = eZmaxApi.models.usergroup_response_compound.usergroup-ResponseCompound() diff --git a/test/test_usergroup_get_permissions_v1_response.py b/test/test_usergroup_get_permissions_v1_response.py index 332be6dd4..11d4df563 100644 --- a/test/test_usergroup_get_permissions_v1_response.py +++ b/test/test_usergroup_get_permissions_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.usergroup_get_permissions_v1_response import UsergroupGetPermissionsV1Response # noqa: E501 +from eZmaxApi.models.usergroup_get_permissions_v1_response import UsergroupGetPermissionsV1Response class TestUsergroupGetPermissionsV1Response(unittest.TestCase): """UsergroupGetPermissionsV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> UsergroupGetPermissionsV1Response: optional params are included """ # uncomment below to create an instance of `UsergroupGetPermissionsV1Response` """ - model = UsergroupGetPermissionsV1Response() # noqa: E501 + model = UsergroupGetPermissionsV1Response() if include_optional: return UsergroupGetPermissionsV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_usergroup_get_permissions_v1_response_m_payload.py b/test/test_usergroup_get_permissions_v1_response_m_payload.py index 1bcb29409..56a0e30b3 100644 --- a/test/test_usergroup_get_permissions_v1_response_m_payload.py +++ b/test/test_usergroup_get_permissions_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.usergroup_get_permissions_v1_response_m_payload import UsergroupGetPermissionsV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.usergroup_get_permissions_v1_response_m_payload import UsergroupGetPermissionsV1ResponseMPayload class TestUsergroupGetPermissionsV1ResponseMPayload(unittest.TestCase): """UsergroupGetPermissionsV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> UsergroupGetPermissionsV1ResponseMP optional params are included """ # uncomment below to create an instance of `UsergroupGetPermissionsV1ResponseMPayload` """ - model = UsergroupGetPermissionsV1ResponseMPayload() # noqa: E501 + model = UsergroupGetPermissionsV1ResponseMPayload() if include_optional: return UsergroupGetPermissionsV1ResponseMPayload( a_obj_modulegroup = [ diff --git a/test/test_usergroup_get_usergroupdelegations_v1_response.py b/test/test_usergroup_get_usergroupdelegations_v1_response.py index f33cd74a2..84431c48e 100644 --- a/test/test_usergroup_get_usergroupdelegations_v1_response.py +++ b/test/test_usergroup_get_usergroupdelegations_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.usergroup_get_usergroupdelegations_v1_response import UsergroupGetUsergroupdelegationsV1Response # noqa: E501 +from eZmaxApi.models.usergroup_get_usergroupdelegations_v1_response import UsergroupGetUsergroupdelegationsV1Response class TestUsergroupGetUsergroupdelegationsV1Response(unittest.TestCase): """UsergroupGetUsergroupdelegationsV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> UsergroupGetUsergroupdelegationsV1R optional params are included """ # uncomment below to create an instance of `UsergroupGetUsergroupdelegationsV1Response` """ - model = UsergroupGetUsergroupdelegationsV1Response() # noqa: E501 + model = UsergroupGetUsergroupdelegationsV1Response() if include_optional: return UsergroupGetUsergroupdelegationsV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_usergroup_get_usergroupdelegations_v1_response_m_payload.py b/test/test_usergroup_get_usergroupdelegations_v1_response_m_payload.py index e9d7b639e..dc18214b4 100644 --- a/test/test_usergroup_get_usergroupdelegations_v1_response_m_payload.py +++ b/test/test_usergroup_get_usergroupdelegations_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.usergroup_get_usergroupdelegations_v1_response_m_payload import UsergroupGetUsergroupdelegationsV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.usergroup_get_usergroupdelegations_v1_response_m_payload import UsergroupGetUsergroupdelegationsV1ResponseMPayload class TestUsergroupGetUsergroupdelegationsV1ResponseMPayload(unittest.TestCase): """UsergroupGetUsergroupdelegationsV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> UsergroupGetUsergroupdelegationsV1R optional params are included """ # uncomment below to create an instance of `UsergroupGetUsergroupdelegationsV1ResponseMPayload` """ - model = UsergroupGetUsergroupdelegationsV1ResponseMPayload() # noqa: E501 + model = UsergroupGetUsergroupdelegationsV1ResponseMPayload() if include_optional: return UsergroupGetUsergroupdelegationsV1ResponseMPayload( a_obj_usergroupdelegation = [ diff --git a/test/test_usergroup_get_usergroupmemberships_v1_response.py b/test/test_usergroup_get_usergroupmemberships_v1_response.py index ba3fab2f0..6c3d106c4 100644 --- a/test/test_usergroup_get_usergroupmemberships_v1_response.py +++ b/test/test_usergroup_get_usergroupmemberships_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.usergroup_get_usergroupmemberships_v1_response import UsergroupGetUsergroupmembershipsV1Response # noqa: E501 +from eZmaxApi.models.usergroup_get_usergroupmemberships_v1_response import UsergroupGetUsergroupmembershipsV1Response class TestUsergroupGetUsergroupmembershipsV1Response(unittest.TestCase): """UsergroupGetUsergroupmembershipsV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> UsergroupGetUsergroupmembershipsV1R optional params are included """ # uncomment below to create an instance of `UsergroupGetUsergroupmembershipsV1Response` """ - model = UsergroupGetUsergroupmembershipsV1Response() # noqa: E501 + model = UsergroupGetUsergroupmembershipsV1Response() if include_optional: return UsergroupGetUsergroupmembershipsV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_usergroup_get_usergroupmemberships_v1_response_m_payload.py b/test/test_usergroup_get_usergroupmemberships_v1_response_m_payload.py index 7ca57b0ab..aacb92ee0 100644 --- a/test/test_usergroup_get_usergroupmemberships_v1_response_m_payload.py +++ b/test/test_usergroup_get_usergroupmemberships_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.usergroup_get_usergroupmemberships_v1_response_m_payload import UsergroupGetUsergroupmembershipsV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.usergroup_get_usergroupmemberships_v1_response_m_payload import UsergroupGetUsergroupmembershipsV1ResponseMPayload class TestUsergroupGetUsergroupmembershipsV1ResponseMPayload(unittest.TestCase): """UsergroupGetUsergroupmembershipsV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> UsergroupGetUsergroupmembershipsV1R optional params are included """ # uncomment below to create an instance of `UsergroupGetUsergroupmembershipsV1ResponseMPayload` """ - model = UsergroupGetUsergroupmembershipsV1ResponseMPayload() # noqa: E501 + model = UsergroupGetUsergroupmembershipsV1ResponseMPayload() if include_optional: return UsergroupGetUsergroupmembershipsV1ResponseMPayload( a_obj_usergroupmembership = [ diff --git a/test/test_usergroup_list_element.py b/test/test_usergroup_list_element.py index 8b171524d..65118ce96 100644 --- a/test/test_usergroup_list_element.py +++ b/test/test_usergroup_list_element.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.usergroup_list_element import UsergroupListElement # noqa: E501 +from eZmaxApi.models.usergroup_list_element import UsergroupListElement class TestUsergroupListElement(unittest.TestCase): """UsergroupListElement unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> UsergroupListElement: optional params are included """ # uncomment below to create an instance of `UsergroupListElement` """ - model = UsergroupListElement() # noqa: E501 + model = UsergroupListElement() if include_optional: return UsergroupListElement( pki_usergroup_id = 2, diff --git a/test/test_usergroup_request.py b/test/test_usergroup_request.py index 697aa4e44..fee7d60b8 100644 --- a/test/test_usergroup_request.py +++ b/test/test_usergroup_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.usergroup_request import UsergroupRequest # noqa: E501 +from eZmaxApi.models.usergroup_request import UsergroupRequest class TestUsergroupRequest(unittest.TestCase): """UsergroupRequest unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> UsergroupRequest: optional params are included """ # uncomment below to create an instance of `UsergroupRequest` """ - model = UsergroupRequest() # noqa: E501 + model = UsergroupRequest() if include_optional: return UsergroupRequest( pki_usergroup_id = 2, diff --git a/test/test_usergroup_request_compound.py b/test/test_usergroup_request_compound.py index 8cdda1cf2..4eee7f516 100644 --- a/test/test_usergroup_request_compound.py +++ b/test/test_usergroup_request_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.usergroup_request_compound import UsergroupRequestCompound # noqa: E501 +from eZmaxApi.models.usergroup_request_compound import UsergroupRequestCompound class TestUsergroupRequestCompound(unittest.TestCase): """UsergroupRequestCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> UsergroupRequestCompound: optional params are included """ # uncomment below to create an instance of `UsergroupRequestCompound` """ - model = UsergroupRequestCompound() # noqa: E501 + model = UsergroupRequestCompound() if include_optional: return UsergroupRequestCompound( pki_usergroup_id = 2, diff --git a/test/test_usergroup_response.py b/test/test_usergroup_response.py index c50a0bd65..1c268afc7 100644 --- a/test/test_usergroup_response.py +++ b/test/test_usergroup_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.usergroup_response import UsergroupResponse # noqa: E501 +from eZmaxApi.models.usergroup_response import UsergroupResponse class TestUsergroupResponse(unittest.TestCase): """UsergroupResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> UsergroupResponse: optional params are included """ # uncomment below to create an instance of `UsergroupResponse` """ - model = UsergroupResponse() # noqa: E501 + model = UsergroupResponse() if include_optional: return UsergroupResponse( pki_usergroup_id = 2, diff --git a/test/test_usergroup_response_compound.py b/test/test_usergroup_response_compound.py index 56f37221c..a5e365402 100644 --- a/test/test_usergroup_response_compound.py +++ b/test/test_usergroup_response_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.usergroup_response_compound import UsergroupResponseCompound # noqa: E501 +from eZmaxApi.models.usergroup_response_compound import UsergroupResponseCompound class TestUsergroupResponseCompound(unittest.TestCase): """UsergroupResponseCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> UsergroupResponseCompound: optional params are included """ # uncomment below to create an instance of `UsergroupResponseCompound` """ - model = UsergroupResponseCompound() # noqa: E501 + model = UsergroupResponseCompound() if include_optional: return UsergroupResponseCompound( pki_usergroup_id = 2, diff --git a/test/test_usergroupdelegation_create_object_v1_request.py b/test/test_usergroupdelegation_create_object_v1_request.py index 067e65da6..179c4a17b 100644 --- a/test/test_usergroupdelegation_create_object_v1_request.py +++ b/test/test_usergroupdelegation_create_object_v1_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.usergroupdelegation_create_object_v1_request import UsergroupdelegationCreateObjectV1Request # noqa: E501 +from eZmaxApi.models.usergroupdelegation_create_object_v1_request import UsergroupdelegationCreateObjectV1Request class TestUsergroupdelegationCreateObjectV1Request(unittest.TestCase): """UsergroupdelegationCreateObjectV1Request unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> UsergroupdelegationCreateObjectV1Re optional params are included """ # uncomment below to create an instance of `UsergroupdelegationCreateObjectV1Request` """ - model = UsergroupdelegationCreateObjectV1Request() # noqa: E501 + model = UsergroupdelegationCreateObjectV1Request() if include_optional: return UsergroupdelegationCreateObjectV1Request( a_obj_usergroupdelegation = [ diff --git a/test/test_usergroupdelegation_create_object_v1_response.py b/test/test_usergroupdelegation_create_object_v1_response.py index 8cb47f843..c8d6e423e 100644 --- a/test/test_usergroupdelegation_create_object_v1_response.py +++ b/test/test_usergroupdelegation_create_object_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.usergroupdelegation_create_object_v1_response import UsergroupdelegationCreateObjectV1Response # noqa: E501 +from eZmaxApi.models.usergroupdelegation_create_object_v1_response import UsergroupdelegationCreateObjectV1Response class TestUsergroupdelegationCreateObjectV1Response(unittest.TestCase): """UsergroupdelegationCreateObjectV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> UsergroupdelegationCreateObjectV1Re optional params are included """ # uncomment below to create an instance of `UsergroupdelegationCreateObjectV1Response` """ - model = UsergroupdelegationCreateObjectV1Response() # noqa: E501 + model = UsergroupdelegationCreateObjectV1Response() if include_optional: return UsergroupdelegationCreateObjectV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_usergroupdelegation_create_object_v1_response_m_payload.py b/test/test_usergroupdelegation_create_object_v1_response_m_payload.py index cbf28fa5c..b36682e97 100644 --- a/test/test_usergroupdelegation_create_object_v1_response_m_payload.py +++ b/test/test_usergroupdelegation_create_object_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.usergroupdelegation_create_object_v1_response_m_payload import UsergroupdelegationCreateObjectV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.usergroupdelegation_create_object_v1_response_m_payload import UsergroupdelegationCreateObjectV1ResponseMPayload class TestUsergroupdelegationCreateObjectV1ResponseMPayload(unittest.TestCase): """UsergroupdelegationCreateObjectV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> UsergroupdelegationCreateObjectV1Re optional params are included """ # uncomment below to create an instance of `UsergroupdelegationCreateObjectV1ResponseMPayload` """ - model = UsergroupdelegationCreateObjectV1ResponseMPayload() # noqa: E501 + model = UsergroupdelegationCreateObjectV1ResponseMPayload() if include_optional: return UsergroupdelegationCreateObjectV1ResponseMPayload( a_pki_usergroupdelegation_id = [ diff --git a/test/test_usergroupdelegation_delete_object_v1_response.py b/test/test_usergroupdelegation_delete_object_v1_response.py index a877c31c1..3db3920bc 100644 --- a/test/test_usergroupdelegation_delete_object_v1_response.py +++ b/test/test_usergroupdelegation_delete_object_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.usergroupdelegation_delete_object_v1_response import UsergroupdelegationDeleteObjectV1Response # noqa: E501 +from eZmaxApi.models.usergroupdelegation_delete_object_v1_response import UsergroupdelegationDeleteObjectV1Response class TestUsergroupdelegationDeleteObjectV1Response(unittest.TestCase): """UsergroupdelegationDeleteObjectV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> UsergroupdelegationDeleteObjectV1Re optional params are included """ # uncomment below to create an instance of `UsergroupdelegationDeleteObjectV1Response` """ - model = UsergroupdelegationDeleteObjectV1Response() # noqa: E501 + model = UsergroupdelegationDeleteObjectV1Response() if include_optional: return UsergroupdelegationDeleteObjectV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_usergroupdelegation_edit_object_v1_request.py b/test/test_usergroupdelegation_edit_object_v1_request.py index 03bac8f70..a72eeb94f 100644 --- a/test/test_usergroupdelegation_edit_object_v1_request.py +++ b/test/test_usergroupdelegation_edit_object_v1_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.usergroupdelegation_edit_object_v1_request import UsergroupdelegationEditObjectV1Request # noqa: E501 +from eZmaxApi.models.usergroupdelegation_edit_object_v1_request import UsergroupdelegationEditObjectV1Request class TestUsergroupdelegationEditObjectV1Request(unittest.TestCase): """UsergroupdelegationEditObjectV1Request unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> UsergroupdelegationEditObjectV1Requ optional params are included """ # uncomment below to create an instance of `UsergroupdelegationEditObjectV1Request` """ - model = UsergroupdelegationEditObjectV1Request() # noqa: E501 + model = UsergroupdelegationEditObjectV1Request() if include_optional: return UsergroupdelegationEditObjectV1Request( obj_usergroupdelegation = eZmaxApi.models.usergroupdelegation_request_compound.usergroupdelegation-RequestCompound() diff --git a/test/test_usergroupdelegation_edit_object_v1_response.py b/test/test_usergroupdelegation_edit_object_v1_response.py index a99206717..40f10ba38 100644 --- a/test/test_usergroupdelegation_edit_object_v1_response.py +++ b/test/test_usergroupdelegation_edit_object_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.usergroupdelegation_edit_object_v1_response import UsergroupdelegationEditObjectV1Response # noqa: E501 +from eZmaxApi.models.usergroupdelegation_edit_object_v1_response import UsergroupdelegationEditObjectV1Response class TestUsergroupdelegationEditObjectV1Response(unittest.TestCase): """UsergroupdelegationEditObjectV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> UsergroupdelegationEditObjectV1Resp optional params are included """ # uncomment below to create an instance of `UsergroupdelegationEditObjectV1Response` """ - model = UsergroupdelegationEditObjectV1Response() # noqa: E501 + model = UsergroupdelegationEditObjectV1Response() if include_optional: return UsergroupdelegationEditObjectV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_usergroupdelegation_get_object_v2_response.py b/test/test_usergroupdelegation_get_object_v2_response.py index 81690ebd2..4888c4fb4 100644 --- a/test/test_usergroupdelegation_get_object_v2_response.py +++ b/test/test_usergroupdelegation_get_object_v2_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.usergroupdelegation_get_object_v2_response import UsergroupdelegationGetObjectV2Response # noqa: E501 +from eZmaxApi.models.usergroupdelegation_get_object_v2_response import UsergroupdelegationGetObjectV2Response class TestUsergroupdelegationGetObjectV2Response(unittest.TestCase): """UsergroupdelegationGetObjectV2Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> UsergroupdelegationGetObjectV2Respo optional params are included """ # uncomment below to create an instance of `UsergroupdelegationGetObjectV2Response` """ - model = UsergroupdelegationGetObjectV2Response() # noqa: E501 + model = UsergroupdelegationGetObjectV2Response() if include_optional: return UsergroupdelegationGetObjectV2Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_usergroupdelegation_get_object_v2_response_m_payload.py b/test/test_usergroupdelegation_get_object_v2_response_m_payload.py index c0c4c96c0..2a1b16f64 100644 --- a/test/test_usergroupdelegation_get_object_v2_response_m_payload.py +++ b/test/test_usergroupdelegation_get_object_v2_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.usergroupdelegation_get_object_v2_response_m_payload import UsergroupdelegationGetObjectV2ResponseMPayload # noqa: E501 +from eZmaxApi.models.usergroupdelegation_get_object_v2_response_m_payload import UsergroupdelegationGetObjectV2ResponseMPayload class TestUsergroupdelegationGetObjectV2ResponseMPayload(unittest.TestCase): """UsergroupdelegationGetObjectV2ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> UsergroupdelegationGetObjectV2Respo optional params are included """ # uncomment below to create an instance of `UsergroupdelegationGetObjectV2ResponseMPayload` """ - model = UsergroupdelegationGetObjectV2ResponseMPayload() # noqa: E501 + model = UsergroupdelegationGetObjectV2ResponseMPayload() if include_optional: return UsergroupdelegationGetObjectV2ResponseMPayload( obj_usergroupdelegation = eZmaxApi.models.usergroupdelegation_response_compound.usergroupdelegation-ResponseCompound() diff --git a/test/test_usergroupdelegation_request.py b/test/test_usergroupdelegation_request.py index 2739fc938..3685ff7ef 100644 --- a/test/test_usergroupdelegation_request.py +++ b/test/test_usergroupdelegation_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.usergroupdelegation_request import UsergroupdelegationRequest # noqa: E501 +from eZmaxApi.models.usergroupdelegation_request import UsergroupdelegationRequest class TestUsergroupdelegationRequest(unittest.TestCase): """UsergroupdelegationRequest unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> UsergroupdelegationRequest: optional params are included """ # uncomment below to create an instance of `UsergroupdelegationRequest` """ - model = UsergroupdelegationRequest() # noqa: E501 + model = UsergroupdelegationRequest() if include_optional: return UsergroupdelegationRequest( pki_usergroupdelegation_id = 141, diff --git a/test/test_usergroupdelegation_request_compound.py b/test/test_usergroupdelegation_request_compound.py index f7d42bfe7..1c1e6b346 100644 --- a/test/test_usergroupdelegation_request_compound.py +++ b/test/test_usergroupdelegation_request_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.usergroupdelegation_request_compound import UsergroupdelegationRequestCompound # noqa: E501 +from eZmaxApi.models.usergroupdelegation_request_compound import UsergroupdelegationRequestCompound class TestUsergroupdelegationRequestCompound(unittest.TestCase): """UsergroupdelegationRequestCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> UsergroupdelegationRequestCompound: optional params are included """ # uncomment below to create an instance of `UsergroupdelegationRequestCompound` """ - model = UsergroupdelegationRequestCompound() # noqa: E501 + model = UsergroupdelegationRequestCompound() if include_optional: return UsergroupdelegationRequestCompound( pki_usergroupdelegation_id = 141, diff --git a/test/test_usergroupdelegation_response.py b/test/test_usergroupdelegation_response.py index a426ae31e..0de00d960 100644 --- a/test/test_usergroupdelegation_response.py +++ b/test/test_usergroupdelegation_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.usergroupdelegation_response import UsergroupdelegationResponse # noqa: E501 +from eZmaxApi.models.usergroupdelegation_response import UsergroupdelegationResponse class TestUsergroupdelegationResponse(unittest.TestCase): """UsergroupdelegationResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> UsergroupdelegationResponse: optional params are included """ # uncomment below to create an instance of `UsergroupdelegationResponse` """ - model = UsergroupdelegationResponse() # noqa: E501 + model = UsergroupdelegationResponse() if include_optional: return UsergroupdelegationResponse( pki_usergroupdelegation_id = 141, diff --git a/test/test_usergroupdelegation_response_compound.py b/test/test_usergroupdelegation_response_compound.py index 31bb49cd4..4e2e87770 100644 --- a/test/test_usergroupdelegation_response_compound.py +++ b/test/test_usergroupdelegation_response_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.usergroupdelegation_response_compound import UsergroupdelegationResponseCompound # noqa: E501 +from eZmaxApi.models.usergroupdelegation_response_compound import UsergroupdelegationResponseCompound class TestUsergroupdelegationResponseCompound(unittest.TestCase): """UsergroupdelegationResponseCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> UsergroupdelegationResponseCompound optional params are included """ # uncomment below to create an instance of `UsergroupdelegationResponseCompound` """ - model = UsergroupdelegationResponseCompound() # noqa: E501 + model = UsergroupdelegationResponseCompound() if include_optional: return UsergroupdelegationResponseCompound( pki_usergroupdelegation_id = 141, diff --git a/test/test_usergroupmembership_create_object_v1_request.py b/test/test_usergroupmembership_create_object_v1_request.py index 4d2d24bb4..16c7a8a88 100644 --- a/test/test_usergroupmembership_create_object_v1_request.py +++ b/test/test_usergroupmembership_create_object_v1_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.usergroupmembership_create_object_v1_request import UsergroupmembershipCreateObjectV1Request # noqa: E501 +from eZmaxApi.models.usergroupmembership_create_object_v1_request import UsergroupmembershipCreateObjectV1Request class TestUsergroupmembershipCreateObjectV1Request(unittest.TestCase): """UsergroupmembershipCreateObjectV1Request unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> UsergroupmembershipCreateObjectV1Re optional params are included """ # uncomment below to create an instance of `UsergroupmembershipCreateObjectV1Request` """ - model = UsergroupmembershipCreateObjectV1Request() # noqa: E501 + model = UsergroupmembershipCreateObjectV1Request() if include_optional: return UsergroupmembershipCreateObjectV1Request( a_obj_usergroupmembership = [ diff --git a/test/test_usergroupmembership_create_object_v1_response.py b/test/test_usergroupmembership_create_object_v1_response.py index 23bf693b5..9b8b8d929 100644 --- a/test/test_usergroupmembership_create_object_v1_response.py +++ b/test/test_usergroupmembership_create_object_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.usergroupmembership_create_object_v1_response import UsergroupmembershipCreateObjectV1Response # noqa: E501 +from eZmaxApi.models.usergroupmembership_create_object_v1_response import UsergroupmembershipCreateObjectV1Response class TestUsergroupmembershipCreateObjectV1Response(unittest.TestCase): """UsergroupmembershipCreateObjectV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> UsergroupmembershipCreateObjectV1Re optional params are included """ # uncomment below to create an instance of `UsergroupmembershipCreateObjectV1Response` """ - model = UsergroupmembershipCreateObjectV1Response() # noqa: E501 + model = UsergroupmembershipCreateObjectV1Response() if include_optional: return UsergroupmembershipCreateObjectV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_usergroupmembership_create_object_v1_response_m_payload.py b/test/test_usergroupmembership_create_object_v1_response_m_payload.py index 86d709f60..c29052389 100644 --- a/test/test_usergroupmembership_create_object_v1_response_m_payload.py +++ b/test/test_usergroupmembership_create_object_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.usergroupmembership_create_object_v1_response_m_payload import UsergroupmembershipCreateObjectV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.usergroupmembership_create_object_v1_response_m_payload import UsergroupmembershipCreateObjectV1ResponseMPayload class TestUsergroupmembershipCreateObjectV1ResponseMPayload(unittest.TestCase): """UsergroupmembershipCreateObjectV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> UsergroupmembershipCreateObjectV1Re optional params are included """ # uncomment below to create an instance of `UsergroupmembershipCreateObjectV1ResponseMPayload` """ - model = UsergroupmembershipCreateObjectV1ResponseMPayload() # noqa: E501 + model = UsergroupmembershipCreateObjectV1ResponseMPayload() if include_optional: return UsergroupmembershipCreateObjectV1ResponseMPayload( a_pki_usergroupmembership_id = [ diff --git a/test/test_usergroupmembership_delete_object_v1_response.py b/test/test_usergroupmembership_delete_object_v1_response.py index a12ba52c7..f1970b117 100644 --- a/test/test_usergroupmembership_delete_object_v1_response.py +++ b/test/test_usergroupmembership_delete_object_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.usergroupmembership_delete_object_v1_response import UsergroupmembershipDeleteObjectV1Response # noqa: E501 +from eZmaxApi.models.usergroupmembership_delete_object_v1_response import UsergroupmembershipDeleteObjectV1Response class TestUsergroupmembershipDeleteObjectV1Response(unittest.TestCase): """UsergroupmembershipDeleteObjectV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> UsergroupmembershipDeleteObjectV1Re optional params are included """ # uncomment below to create an instance of `UsergroupmembershipDeleteObjectV1Response` """ - model = UsergroupmembershipDeleteObjectV1Response() # noqa: E501 + model = UsergroupmembershipDeleteObjectV1Response() if include_optional: return UsergroupmembershipDeleteObjectV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_usergroupmembership_edit_object_v1_request.py b/test/test_usergroupmembership_edit_object_v1_request.py index 012f5a06b..4bed1c27f 100644 --- a/test/test_usergroupmembership_edit_object_v1_request.py +++ b/test/test_usergroupmembership_edit_object_v1_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.usergroupmembership_edit_object_v1_request import UsergroupmembershipEditObjectV1Request # noqa: E501 +from eZmaxApi.models.usergroupmembership_edit_object_v1_request import UsergroupmembershipEditObjectV1Request class TestUsergroupmembershipEditObjectV1Request(unittest.TestCase): """UsergroupmembershipEditObjectV1Request unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> UsergroupmembershipEditObjectV1Requ optional params are included """ # uncomment below to create an instance of `UsergroupmembershipEditObjectV1Request` """ - model = UsergroupmembershipEditObjectV1Request() # noqa: E501 + model = UsergroupmembershipEditObjectV1Request() if include_optional: return UsergroupmembershipEditObjectV1Request( obj_usergroupmembership = eZmaxApi.models.usergroupmembership_request_compound.usergroupmembership-RequestCompound() diff --git a/test/test_usergroupmembership_edit_object_v1_response.py b/test/test_usergroupmembership_edit_object_v1_response.py index b15a915b1..d31531845 100644 --- a/test/test_usergroupmembership_edit_object_v1_response.py +++ b/test/test_usergroupmembership_edit_object_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.usergroupmembership_edit_object_v1_response import UsergroupmembershipEditObjectV1Response # noqa: E501 +from eZmaxApi.models.usergroupmembership_edit_object_v1_response import UsergroupmembershipEditObjectV1Response class TestUsergroupmembershipEditObjectV1Response(unittest.TestCase): """UsergroupmembershipEditObjectV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> UsergroupmembershipEditObjectV1Resp optional params are included """ # uncomment below to create an instance of `UsergroupmembershipEditObjectV1Response` """ - model = UsergroupmembershipEditObjectV1Response() # noqa: E501 + model = UsergroupmembershipEditObjectV1Response() if include_optional: return UsergroupmembershipEditObjectV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_usergroupmembership_get_object_v2_response.py b/test/test_usergroupmembership_get_object_v2_response.py index ef534e39f..3637e361f 100644 --- a/test/test_usergroupmembership_get_object_v2_response.py +++ b/test/test_usergroupmembership_get_object_v2_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.usergroupmembership_get_object_v2_response import UsergroupmembershipGetObjectV2Response # noqa: E501 +from eZmaxApi.models.usergroupmembership_get_object_v2_response import UsergroupmembershipGetObjectV2Response class TestUsergroupmembershipGetObjectV2Response(unittest.TestCase): """UsergroupmembershipGetObjectV2Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> UsergroupmembershipGetObjectV2Respo optional params are included """ # uncomment below to create an instance of `UsergroupmembershipGetObjectV2Response` """ - model = UsergroupmembershipGetObjectV2Response() # noqa: E501 + model = UsergroupmembershipGetObjectV2Response() if include_optional: return UsergroupmembershipGetObjectV2Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_usergroupmembership_get_object_v2_response_m_payload.py b/test/test_usergroupmembership_get_object_v2_response_m_payload.py index 9af60acf8..8fe7661a4 100644 --- a/test/test_usergroupmembership_get_object_v2_response_m_payload.py +++ b/test/test_usergroupmembership_get_object_v2_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.usergroupmembership_get_object_v2_response_m_payload import UsergroupmembershipGetObjectV2ResponseMPayload # noqa: E501 +from eZmaxApi.models.usergroupmembership_get_object_v2_response_m_payload import UsergroupmembershipGetObjectV2ResponseMPayload class TestUsergroupmembershipGetObjectV2ResponseMPayload(unittest.TestCase): """UsergroupmembershipGetObjectV2ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> UsergroupmembershipGetObjectV2Respo optional params are included """ # uncomment below to create an instance of `UsergroupmembershipGetObjectV2ResponseMPayload` """ - model = UsergroupmembershipGetObjectV2ResponseMPayload() # noqa: E501 + model = UsergroupmembershipGetObjectV2ResponseMPayload() if include_optional: return UsergroupmembershipGetObjectV2ResponseMPayload( obj_usergroupmembership = eZmaxApi.models.usergroupmembership_response_compound.usergroupmembership-ResponseCompound() diff --git a/test/test_usergroupmembership_request.py b/test/test_usergroupmembership_request.py index dace0d10e..4b0b10fe1 100644 --- a/test/test_usergroupmembership_request.py +++ b/test/test_usergroupmembership_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.usergroupmembership_request import UsergroupmembershipRequest # noqa: E501 +from eZmaxApi.models.usergroupmembership_request import UsergroupmembershipRequest class TestUsergroupmembershipRequest(unittest.TestCase): """UsergroupmembershipRequest unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> UsergroupmembershipRequest: optional params are included """ # uncomment below to create an instance of `UsergroupmembershipRequest` """ - model = UsergroupmembershipRequest() # noqa: E501 + model = UsergroupmembershipRequest() if include_optional: return UsergroupmembershipRequest( pki_usergroupmembership_id = 21, diff --git a/test/test_usergroupmembership_request_compound.py b/test/test_usergroupmembership_request_compound.py index 1820d2992..8f532a334 100644 --- a/test/test_usergroupmembership_request_compound.py +++ b/test/test_usergroupmembership_request_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.usergroupmembership_request_compound import UsergroupmembershipRequestCompound # noqa: E501 +from eZmaxApi.models.usergroupmembership_request_compound import UsergroupmembershipRequestCompound class TestUsergroupmembershipRequestCompound(unittest.TestCase): """UsergroupmembershipRequestCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> UsergroupmembershipRequestCompound: optional params are included """ # uncomment below to create an instance of `UsergroupmembershipRequestCompound` """ - model = UsergroupmembershipRequestCompound() # noqa: E501 + model = UsergroupmembershipRequestCompound() if include_optional: return UsergroupmembershipRequestCompound( pki_usergroupmembership_id = 21, diff --git a/test/test_usergroupmembership_response.py b/test/test_usergroupmembership_response.py index c7153beb9..98bcbf56a 100644 --- a/test/test_usergroupmembership_response.py +++ b/test/test_usergroupmembership_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.usergroupmembership_response import UsergroupmembershipResponse # noqa: E501 +from eZmaxApi.models.usergroupmembership_response import UsergroupmembershipResponse class TestUsergroupmembershipResponse(unittest.TestCase): """UsergroupmembershipResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> UsergroupmembershipResponse: optional params are included """ # uncomment below to create an instance of `UsergroupmembershipResponse` """ - model = UsergroupmembershipResponse() # noqa: E501 + model = UsergroupmembershipResponse() if include_optional: return UsergroupmembershipResponse( pki_usergroupmembership_id = 21, diff --git a/test/test_usergroupmembership_response_compound.py b/test/test_usergroupmembership_response_compound.py index 64f661ffe..2fe93b97b 100644 --- a/test/test_usergroupmembership_response_compound.py +++ b/test/test_usergroupmembership_response_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.usergroupmembership_response_compound import UsergroupmembershipResponseCompound # noqa: E501 +from eZmaxApi.models.usergroupmembership_response_compound import UsergroupmembershipResponseCompound class TestUsergroupmembershipResponseCompound(unittest.TestCase): """UsergroupmembershipResponseCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> UsergroupmembershipResponseCompound optional params are included """ # uncomment below to create an instance of `UsergroupmembershipResponseCompound` """ - model = UsergroupmembershipResponseCompound() # noqa: E501 + model = UsergroupmembershipResponseCompound() if include_optional: return UsergroupmembershipResponseCompound( pki_usergroupmembership_id = 21, diff --git a/test/test_userlogintype_autocomplete_element_response.py b/test/test_userlogintype_autocomplete_element_response.py index d8d754c1a..5fd787bed 100644 --- a/test/test_userlogintype_autocomplete_element_response.py +++ b/test/test_userlogintype_autocomplete_element_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.userlogintype_autocomplete_element_response import UserlogintypeAutocompleteElementResponse # noqa: E501 +from eZmaxApi.models.userlogintype_autocomplete_element_response import UserlogintypeAutocompleteElementResponse class TestUserlogintypeAutocompleteElementResponse(unittest.TestCase): """UserlogintypeAutocompleteElementResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> UserlogintypeAutocompleteElementRes optional params are included """ # uncomment below to create an instance of `UserlogintypeAutocompleteElementResponse` """ - model = UserlogintypeAutocompleteElementResponse() # noqa: E501 + model = UserlogintypeAutocompleteElementResponse() if include_optional: return UserlogintypeAutocompleteElementResponse( pki_userlogintype_id = 2, diff --git a/test/test_userlogintype_get_autocomplete_v2_response.py b/test/test_userlogintype_get_autocomplete_v2_response.py index decf2d3d5..1e47c18d4 100644 --- a/test/test_userlogintype_get_autocomplete_v2_response.py +++ b/test/test_userlogintype_get_autocomplete_v2_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.userlogintype_get_autocomplete_v2_response import UserlogintypeGetAutocompleteV2Response # noqa: E501 +from eZmaxApi.models.userlogintype_get_autocomplete_v2_response import UserlogintypeGetAutocompleteV2Response class TestUserlogintypeGetAutocompleteV2Response(unittest.TestCase): """UserlogintypeGetAutocompleteV2Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> UserlogintypeGetAutocompleteV2Respo optional params are included """ # uncomment below to create an instance of `UserlogintypeGetAutocompleteV2Response` """ - model = UserlogintypeGetAutocompleteV2Response() # noqa: E501 + model = UserlogintypeGetAutocompleteV2Response() if include_optional: return UserlogintypeGetAutocompleteV2Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_userlogintype_get_autocomplete_v2_response_m_payload.py b/test/test_userlogintype_get_autocomplete_v2_response_m_payload.py index bf36426b0..a53577585 100644 --- a/test/test_userlogintype_get_autocomplete_v2_response_m_payload.py +++ b/test/test_userlogintype_get_autocomplete_v2_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.userlogintype_get_autocomplete_v2_response_m_payload import UserlogintypeGetAutocompleteV2ResponseMPayload # noqa: E501 +from eZmaxApi.models.userlogintype_get_autocomplete_v2_response_m_payload import UserlogintypeGetAutocompleteV2ResponseMPayload class TestUserlogintypeGetAutocompleteV2ResponseMPayload(unittest.TestCase): """UserlogintypeGetAutocompleteV2ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> UserlogintypeGetAutocompleteV2Respo optional params are included """ # uncomment below to create an instance of `UserlogintypeGetAutocompleteV2ResponseMPayload` """ - model = UserlogintypeGetAutocompleteV2ResponseMPayload() # noqa: E501 + model = UserlogintypeGetAutocompleteV2ResponseMPayload() if include_optional: return UserlogintypeGetAutocompleteV2ResponseMPayload( a_obj_userlogintype = [ diff --git a/test/test_userstaged_create_user_v1_response.py b/test/test_userstaged_create_user_v1_response.py index d38f43c33..097346ae3 100644 --- a/test/test_userstaged_create_user_v1_response.py +++ b/test/test_userstaged_create_user_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.userstaged_create_user_v1_response import UserstagedCreateUserV1Response # noqa: E501 +from eZmaxApi.models.userstaged_create_user_v1_response import UserstagedCreateUserV1Response class TestUserstagedCreateUserV1Response(unittest.TestCase): """UserstagedCreateUserV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> UserstagedCreateUserV1Response: optional params are included """ # uncomment below to create an instance of `UserstagedCreateUserV1Response` """ - model = UserstagedCreateUserV1Response() # noqa: E501 + model = UserstagedCreateUserV1Response() if include_optional: return UserstagedCreateUserV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_userstaged_create_user_v1_response_m_payload.py b/test/test_userstaged_create_user_v1_response_m_payload.py index 3fe7a5041..4c2a3e394 100644 --- a/test/test_userstaged_create_user_v1_response_m_payload.py +++ b/test/test_userstaged_create_user_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.userstaged_create_user_v1_response_m_payload import UserstagedCreateUserV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.userstaged_create_user_v1_response_m_payload import UserstagedCreateUserV1ResponseMPayload class TestUserstagedCreateUserV1ResponseMPayload(unittest.TestCase): """UserstagedCreateUserV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> UserstagedCreateUserV1ResponseMPayl optional params are included """ # uncomment below to create an instance of `UserstagedCreateUserV1ResponseMPayload` """ - model = UserstagedCreateUserV1ResponseMPayload() # noqa: E501 + model = UserstagedCreateUserV1ResponseMPayload() if include_optional: return UserstagedCreateUserV1ResponseMPayload( pki_user_id = 70 diff --git a/test/test_userstaged_delete_object_v1_response.py b/test/test_userstaged_delete_object_v1_response.py index 05bad7a22..c328dba99 100644 --- a/test/test_userstaged_delete_object_v1_response.py +++ b/test/test_userstaged_delete_object_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.userstaged_delete_object_v1_response import UserstagedDeleteObjectV1Response # noqa: E501 +from eZmaxApi.models.userstaged_delete_object_v1_response import UserstagedDeleteObjectV1Response class TestUserstagedDeleteObjectV1Response(unittest.TestCase): """UserstagedDeleteObjectV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> UserstagedDeleteObjectV1Response: optional params are included """ # uncomment below to create an instance of `UserstagedDeleteObjectV1Response` """ - model = UserstagedDeleteObjectV1Response() # noqa: E501 + model = UserstagedDeleteObjectV1Response() if include_optional: return UserstagedDeleteObjectV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_userstaged_get_list_v1_response.py b/test/test_userstaged_get_list_v1_response.py index b1e3cce3a..c8aa78037 100644 --- a/test/test_userstaged_get_list_v1_response.py +++ b/test/test_userstaged_get_list_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.userstaged_get_list_v1_response import UserstagedGetListV1Response # noqa: E501 +from eZmaxApi.models.userstaged_get_list_v1_response import UserstagedGetListV1Response class TestUserstagedGetListV1Response(unittest.TestCase): """UserstagedGetListV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> UserstagedGetListV1Response: optional params are included """ # uncomment below to create an instance of `UserstagedGetListV1Response` """ - model = UserstagedGetListV1Response() # noqa: E501 + model = UserstagedGetListV1Response() if include_optional: return UserstagedGetListV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload_get_list.Common-Response-objDebugPayload_getList(), diff --git a/test/test_userstaged_get_list_v1_response_m_payload.py b/test/test_userstaged_get_list_v1_response_m_payload.py index 3a40235b0..113242766 100644 --- a/test/test_userstaged_get_list_v1_response_m_payload.py +++ b/test/test_userstaged_get_list_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.userstaged_get_list_v1_response_m_payload import UserstagedGetListV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.userstaged_get_list_v1_response_m_payload import UserstagedGetListV1ResponseMPayload class TestUserstagedGetListV1ResponseMPayload(unittest.TestCase): """UserstagedGetListV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> UserstagedGetListV1ResponseMPayload optional params are included """ # uncomment below to create an instance of `UserstagedGetListV1ResponseMPayload` """ - model = UserstagedGetListV1ResponseMPayload() # noqa: E501 + model = UserstagedGetListV1ResponseMPayload() if include_optional: return UserstagedGetListV1ResponseMPayload( i_row_returned = 100, diff --git a/test/test_userstaged_get_object_v2_response.py b/test/test_userstaged_get_object_v2_response.py index 2685d0f6c..d6ed2b2c6 100644 --- a/test/test_userstaged_get_object_v2_response.py +++ b/test/test_userstaged_get_object_v2_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.userstaged_get_object_v2_response import UserstagedGetObjectV2Response # noqa: E501 +from eZmaxApi.models.userstaged_get_object_v2_response import UserstagedGetObjectV2Response class TestUserstagedGetObjectV2Response(unittest.TestCase): """UserstagedGetObjectV2Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> UserstagedGetObjectV2Response: optional params are included """ # uncomment below to create an instance of `UserstagedGetObjectV2Response` """ - model = UserstagedGetObjectV2Response() # noqa: E501 + model = UserstagedGetObjectV2Response() if include_optional: return UserstagedGetObjectV2Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_userstaged_get_object_v2_response_m_payload.py b/test/test_userstaged_get_object_v2_response_m_payload.py index e32fb00ef..33a73e8ba 100644 --- a/test/test_userstaged_get_object_v2_response_m_payload.py +++ b/test/test_userstaged_get_object_v2_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.userstaged_get_object_v2_response_m_payload import UserstagedGetObjectV2ResponseMPayload # noqa: E501 +from eZmaxApi.models.userstaged_get_object_v2_response_m_payload import UserstagedGetObjectV2ResponseMPayload class TestUserstagedGetObjectV2ResponseMPayload(unittest.TestCase): """UserstagedGetObjectV2ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> UserstagedGetObjectV2ResponseMPaylo optional params are included """ # uncomment below to create an instance of `UserstagedGetObjectV2ResponseMPayload` """ - model = UserstagedGetObjectV2ResponseMPayload() # noqa: E501 + model = UserstagedGetObjectV2ResponseMPayload() if include_optional: return UserstagedGetObjectV2ResponseMPayload( obj_userstaged = eZmaxApi.models.userstaged_response_compound.userstaged-ResponseCompound() diff --git a/test/test_userstaged_list_element.py b/test/test_userstaged_list_element.py index 3cc7e7d51..713f4cfef 100644 --- a/test/test_userstaged_list_element.py +++ b/test/test_userstaged_list_element.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.userstaged_list_element import UserstagedListElement # noqa: E501 +from eZmaxApi.models.userstaged_list_element import UserstagedListElement class TestUserstagedListElement(unittest.TestCase): """UserstagedListElement unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> UserstagedListElement: optional params are included """ # uncomment below to create an instance of `UserstagedListElement` """ - model = UserstagedListElement() # noqa: E501 + model = UserstagedListElement() if include_optional: return UserstagedListElement( pki_userstaged_id = 90, diff --git a/test/test_userstaged_map_v1_request.py b/test/test_userstaged_map_v1_request.py index 30cb69d74..ffb57395c 100644 --- a/test/test_userstaged_map_v1_request.py +++ b/test/test_userstaged_map_v1_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.userstaged_map_v1_request import UserstagedMapV1Request # noqa: E501 +from eZmaxApi.models.userstaged_map_v1_request import UserstagedMapV1Request class TestUserstagedMapV1Request(unittest.TestCase): """UserstagedMapV1Request unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> UserstagedMapV1Request: optional params are included """ # uncomment below to create an instance of `UserstagedMapV1Request` """ - model = UserstagedMapV1Request() # noqa: E501 + model = UserstagedMapV1Request() if include_optional: return UserstagedMapV1Request( fki_user_id = 70 diff --git a/test/test_userstaged_map_v1_response.py b/test/test_userstaged_map_v1_response.py index fdcb232ff..bef1a3588 100644 --- a/test/test_userstaged_map_v1_response.py +++ b/test/test_userstaged_map_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.userstaged_map_v1_response import UserstagedMapV1Response # noqa: E501 +from eZmaxApi.models.userstaged_map_v1_response import UserstagedMapV1Response class TestUserstagedMapV1Response(unittest.TestCase): """UserstagedMapV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> UserstagedMapV1Response: optional params are included """ # uncomment below to create an instance of `UserstagedMapV1Response` """ - model = UserstagedMapV1Response() # noqa: E501 + model = UserstagedMapV1Response() if include_optional: return UserstagedMapV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_userstaged_response.py b/test/test_userstaged_response.py index 111115b7b..312115650 100644 --- a/test/test_userstaged_response.py +++ b/test/test_userstaged_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.userstaged_response import UserstagedResponse # noqa: E501 +from eZmaxApi.models.userstaged_response import UserstagedResponse class TestUserstagedResponse(unittest.TestCase): """UserstagedResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> UserstagedResponse: optional params are included """ # uncomment below to create an instance of `UserstagedResponse` """ - model = UserstagedResponse() # noqa: E501 + model = UserstagedResponse() if include_optional: return UserstagedResponse( pki_userstaged_id = 90, diff --git a/test/test_userstaged_response_compound.py b/test/test_userstaged_response_compound.py index 03d341144..49c9d0574 100644 --- a/test/test_userstaged_response_compound.py +++ b/test/test_userstaged_response_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.userstaged_response_compound import UserstagedResponseCompound # noqa: E501 +from eZmaxApi.models.userstaged_response_compound import UserstagedResponseCompound class TestUserstagedResponseCompound(unittest.TestCase): """UserstagedResponseCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> UserstagedResponseCompound: optional params are included """ # uncomment below to create an instance of `UserstagedResponseCompound` """ - model = UserstagedResponseCompound() # noqa: E501 + model = UserstagedResponseCompound() if include_optional: return UserstagedResponseCompound( pki_userstaged_id = 90, diff --git a/test/test_variableexpense_autocomplete_element_response.py b/test/test_variableexpense_autocomplete_element_response.py index a98beb366..221dc9097 100644 --- a/test/test_variableexpense_autocomplete_element_response.py +++ b/test/test_variableexpense_autocomplete_element_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.variableexpense_autocomplete_element_response import VariableexpenseAutocompleteElementResponse # noqa: E501 +from eZmaxApi.models.variableexpense_autocomplete_element_response import VariableexpenseAutocompleteElementResponse class TestVariableexpenseAutocompleteElementResponse(unittest.TestCase): """VariableexpenseAutocompleteElementResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> VariableexpenseAutocompleteElementR optional params are included """ # uncomment below to create an instance of `VariableexpenseAutocompleteElementResponse` """ - model = VariableexpenseAutocompleteElementResponse() # noqa: E501 + model = VariableexpenseAutocompleteElementResponse() if include_optional: return VariableexpenseAutocompleteElementResponse( s_variableexpense_description_x = 'Équipements de bureau', diff --git a/test/test_variableexpense_create_object_v1_request.py b/test/test_variableexpense_create_object_v1_request.py index c90eb59f2..be41f69fa 100644 --- a/test/test_variableexpense_create_object_v1_request.py +++ b/test/test_variableexpense_create_object_v1_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.variableexpense_create_object_v1_request import VariableexpenseCreateObjectV1Request # noqa: E501 +from eZmaxApi.models.variableexpense_create_object_v1_request import VariableexpenseCreateObjectV1Request class TestVariableexpenseCreateObjectV1Request(unittest.TestCase): """VariableexpenseCreateObjectV1Request unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> VariableexpenseCreateObjectV1Reques optional params are included """ # uncomment below to create an instance of `VariableexpenseCreateObjectV1Request` """ - model = VariableexpenseCreateObjectV1Request() # noqa: E501 + model = VariableexpenseCreateObjectV1Request() if include_optional: return VariableexpenseCreateObjectV1Request( a_obj_variableexpense = [ diff --git a/test/test_variableexpense_create_object_v1_response.py b/test/test_variableexpense_create_object_v1_response.py index e474c3863..d2e61f342 100644 --- a/test/test_variableexpense_create_object_v1_response.py +++ b/test/test_variableexpense_create_object_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.variableexpense_create_object_v1_response import VariableexpenseCreateObjectV1Response # noqa: E501 +from eZmaxApi.models.variableexpense_create_object_v1_response import VariableexpenseCreateObjectV1Response class TestVariableexpenseCreateObjectV1Response(unittest.TestCase): """VariableexpenseCreateObjectV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> VariableexpenseCreateObjectV1Respon optional params are included """ # uncomment below to create an instance of `VariableexpenseCreateObjectV1Response` """ - model = VariableexpenseCreateObjectV1Response() # noqa: E501 + model = VariableexpenseCreateObjectV1Response() if include_optional: return VariableexpenseCreateObjectV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_variableexpense_create_object_v1_response_m_payload.py b/test/test_variableexpense_create_object_v1_response_m_payload.py index aeb43b8dc..e3439a949 100644 --- a/test/test_variableexpense_create_object_v1_response_m_payload.py +++ b/test/test_variableexpense_create_object_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.variableexpense_create_object_v1_response_m_payload import VariableexpenseCreateObjectV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.variableexpense_create_object_v1_response_m_payload import VariableexpenseCreateObjectV1ResponseMPayload class TestVariableexpenseCreateObjectV1ResponseMPayload(unittest.TestCase): """VariableexpenseCreateObjectV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> VariableexpenseCreateObjectV1Respon optional params are included """ # uncomment below to create an instance of `VariableexpenseCreateObjectV1ResponseMPayload` """ - model = VariableexpenseCreateObjectV1ResponseMPayload() # noqa: E501 + model = VariableexpenseCreateObjectV1ResponseMPayload() if include_optional: return VariableexpenseCreateObjectV1ResponseMPayload( a_pki_variableexpense_id = [ diff --git a/test/test_variableexpense_edit_object_v1_request.py b/test/test_variableexpense_edit_object_v1_request.py index 4bc665f92..2352673f9 100644 --- a/test/test_variableexpense_edit_object_v1_request.py +++ b/test/test_variableexpense_edit_object_v1_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.variableexpense_edit_object_v1_request import VariableexpenseEditObjectV1Request # noqa: E501 +from eZmaxApi.models.variableexpense_edit_object_v1_request import VariableexpenseEditObjectV1Request class TestVariableexpenseEditObjectV1Request(unittest.TestCase): """VariableexpenseEditObjectV1Request unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> VariableexpenseEditObjectV1Request: optional params are included """ # uncomment below to create an instance of `VariableexpenseEditObjectV1Request` """ - model = VariableexpenseEditObjectV1Request() # noqa: E501 + model = VariableexpenseEditObjectV1Request() if include_optional: return VariableexpenseEditObjectV1Request( obj_variableexpense = eZmaxApi.models.variableexpense_request_compound.variableexpense-RequestCompound() diff --git a/test/test_variableexpense_edit_object_v1_response.py b/test/test_variableexpense_edit_object_v1_response.py index dc79674cc..73d9c63a4 100644 --- a/test/test_variableexpense_edit_object_v1_response.py +++ b/test/test_variableexpense_edit_object_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.variableexpense_edit_object_v1_response import VariableexpenseEditObjectV1Response # noqa: E501 +from eZmaxApi.models.variableexpense_edit_object_v1_response import VariableexpenseEditObjectV1Response class TestVariableexpenseEditObjectV1Response(unittest.TestCase): """VariableexpenseEditObjectV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> VariableexpenseEditObjectV1Response optional params are included """ # uncomment below to create an instance of `VariableexpenseEditObjectV1Response` """ - model = VariableexpenseEditObjectV1Response() # noqa: E501 + model = VariableexpenseEditObjectV1Response() if include_optional: return VariableexpenseEditObjectV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_variableexpense_get_autocomplete_v2_response.py b/test/test_variableexpense_get_autocomplete_v2_response.py index 2c6419d5c..9fc1caf94 100644 --- a/test/test_variableexpense_get_autocomplete_v2_response.py +++ b/test/test_variableexpense_get_autocomplete_v2_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.variableexpense_get_autocomplete_v2_response import VariableexpenseGetAutocompleteV2Response # noqa: E501 +from eZmaxApi.models.variableexpense_get_autocomplete_v2_response import VariableexpenseGetAutocompleteV2Response class TestVariableexpenseGetAutocompleteV2Response(unittest.TestCase): """VariableexpenseGetAutocompleteV2Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> VariableexpenseGetAutocompleteV2Res optional params are included """ # uncomment below to create an instance of `VariableexpenseGetAutocompleteV2Response` """ - model = VariableexpenseGetAutocompleteV2Response() # noqa: E501 + model = VariableexpenseGetAutocompleteV2Response() if include_optional: return VariableexpenseGetAutocompleteV2Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_variableexpense_get_autocomplete_v2_response_m_payload.py b/test/test_variableexpense_get_autocomplete_v2_response_m_payload.py index 8ff1ac738..37397d2dc 100644 --- a/test/test_variableexpense_get_autocomplete_v2_response_m_payload.py +++ b/test/test_variableexpense_get_autocomplete_v2_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.variableexpense_get_autocomplete_v2_response_m_payload import VariableexpenseGetAutocompleteV2ResponseMPayload # noqa: E501 +from eZmaxApi.models.variableexpense_get_autocomplete_v2_response_m_payload import VariableexpenseGetAutocompleteV2ResponseMPayload class TestVariableexpenseGetAutocompleteV2ResponseMPayload(unittest.TestCase): """VariableexpenseGetAutocompleteV2ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> VariableexpenseGetAutocompleteV2Res optional params are included """ # uncomment below to create an instance of `VariableexpenseGetAutocompleteV2ResponseMPayload` """ - model = VariableexpenseGetAutocompleteV2ResponseMPayload() # noqa: E501 + model = VariableexpenseGetAutocompleteV2ResponseMPayload() if include_optional: return VariableexpenseGetAutocompleteV2ResponseMPayload( a_obj_variableexpense = [ diff --git a/test/test_variableexpense_get_list_v1_response.py b/test/test_variableexpense_get_list_v1_response.py index 51d8d37fa..25723b15c 100644 --- a/test/test_variableexpense_get_list_v1_response.py +++ b/test/test_variableexpense_get_list_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.variableexpense_get_list_v1_response import VariableexpenseGetListV1Response # noqa: E501 +from eZmaxApi.models.variableexpense_get_list_v1_response import VariableexpenseGetListV1Response class TestVariableexpenseGetListV1Response(unittest.TestCase): """VariableexpenseGetListV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> VariableexpenseGetListV1Response: optional params are included """ # uncomment below to create an instance of `VariableexpenseGetListV1Response` """ - model = VariableexpenseGetListV1Response() # noqa: E501 + model = VariableexpenseGetListV1Response() if include_optional: return VariableexpenseGetListV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload_get_list.Common-Response-objDebugPayload_getList(), diff --git a/test/test_variableexpense_get_list_v1_response_m_payload.py b/test/test_variableexpense_get_list_v1_response_m_payload.py index 24a4251dc..65b2dd479 100644 --- a/test/test_variableexpense_get_list_v1_response_m_payload.py +++ b/test/test_variableexpense_get_list_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.variableexpense_get_list_v1_response_m_payload import VariableexpenseGetListV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.variableexpense_get_list_v1_response_m_payload import VariableexpenseGetListV1ResponseMPayload class TestVariableexpenseGetListV1ResponseMPayload(unittest.TestCase): """VariableexpenseGetListV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> VariableexpenseGetListV1ResponseMPa optional params are included """ # uncomment below to create an instance of `VariableexpenseGetListV1ResponseMPayload` """ - model = VariableexpenseGetListV1ResponseMPayload() # noqa: E501 + model = VariableexpenseGetListV1ResponseMPayload() if include_optional: return VariableexpenseGetListV1ResponseMPayload( i_row_returned = 100, diff --git a/test/test_variableexpense_get_object_v2_response.py b/test/test_variableexpense_get_object_v2_response.py index d07c6cde2..d2d8ec21c 100644 --- a/test/test_variableexpense_get_object_v2_response.py +++ b/test/test_variableexpense_get_object_v2_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.variableexpense_get_object_v2_response import VariableexpenseGetObjectV2Response # noqa: E501 +from eZmaxApi.models.variableexpense_get_object_v2_response import VariableexpenseGetObjectV2Response class TestVariableexpenseGetObjectV2Response(unittest.TestCase): """VariableexpenseGetObjectV2Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> VariableexpenseGetObjectV2Response: optional params are included """ # uncomment below to create an instance of `VariableexpenseGetObjectV2Response` """ - model = VariableexpenseGetObjectV2Response() # noqa: E501 + model = VariableexpenseGetObjectV2Response() if include_optional: return VariableexpenseGetObjectV2Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_variableexpense_get_object_v2_response_m_payload.py b/test/test_variableexpense_get_object_v2_response_m_payload.py index 41d962f65..267df1c7c 100644 --- a/test/test_variableexpense_get_object_v2_response_m_payload.py +++ b/test/test_variableexpense_get_object_v2_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.variableexpense_get_object_v2_response_m_payload import VariableexpenseGetObjectV2ResponseMPayload # noqa: E501 +from eZmaxApi.models.variableexpense_get_object_v2_response_m_payload import VariableexpenseGetObjectV2ResponseMPayload class TestVariableexpenseGetObjectV2ResponseMPayload(unittest.TestCase): """VariableexpenseGetObjectV2ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> VariableexpenseGetObjectV2ResponseM optional params are included """ # uncomment below to create an instance of `VariableexpenseGetObjectV2ResponseMPayload` """ - model = VariableexpenseGetObjectV2ResponseMPayload() # noqa: E501 + model = VariableexpenseGetObjectV2ResponseMPayload() if include_optional: return VariableexpenseGetObjectV2ResponseMPayload( obj_variableexpense = eZmaxApi.models.variableexpense_response_compound.variableexpense-ResponseCompound() diff --git a/test/test_variableexpense_list_element.py b/test/test_variableexpense_list_element.py index d6c306c66..85a8c0ada 100644 --- a/test/test_variableexpense_list_element.py +++ b/test/test_variableexpense_list_element.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.variableexpense_list_element import VariableexpenseListElement # noqa: E501 +from eZmaxApi.models.variableexpense_list_element import VariableexpenseListElement class TestVariableexpenseListElement(unittest.TestCase): """VariableexpenseListElement unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> VariableexpenseListElement: optional params are included """ # uncomment below to create an instance of `VariableexpenseListElement` """ - model = VariableexpenseListElement() # noqa: E501 + model = VariableexpenseListElement() if include_optional: return VariableexpenseListElement( pki_variableexpense_id = 2, diff --git a/test/test_variableexpense_request.py b/test/test_variableexpense_request.py index 600239ce0..402a78abd 100644 --- a/test/test_variableexpense_request.py +++ b/test/test_variableexpense_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.variableexpense_request import VariableexpenseRequest # noqa: E501 +from eZmaxApi.models.variableexpense_request import VariableexpenseRequest class TestVariableexpenseRequest(unittest.TestCase): """VariableexpenseRequest unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> VariableexpenseRequest: optional params are included """ # uncomment below to create an instance of `VariableexpenseRequest` """ - model = VariableexpenseRequest() # noqa: E501 + model = VariableexpenseRequest() if include_optional: return VariableexpenseRequest( pki_variableexpense_id = 2, diff --git a/test/test_variableexpense_request_compound.py b/test/test_variableexpense_request_compound.py index 6bb9e40e7..aa6ceb569 100644 --- a/test/test_variableexpense_request_compound.py +++ b/test/test_variableexpense_request_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.variableexpense_request_compound import VariableexpenseRequestCompound # noqa: E501 +from eZmaxApi.models.variableexpense_request_compound import VariableexpenseRequestCompound class TestVariableexpenseRequestCompound(unittest.TestCase): """VariableexpenseRequestCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> VariableexpenseRequestCompound: optional params are included """ # uncomment below to create an instance of `VariableexpenseRequestCompound` """ - model = VariableexpenseRequestCompound() # noqa: E501 + model = VariableexpenseRequestCompound() if include_optional: return VariableexpenseRequestCompound( pki_variableexpense_id = 2, diff --git a/test/test_variableexpense_response.py b/test/test_variableexpense_response.py index 9250a11ca..86593d9c5 100644 --- a/test/test_variableexpense_response.py +++ b/test/test_variableexpense_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.variableexpense_response import VariableexpenseResponse # noqa: E501 +from eZmaxApi.models.variableexpense_response import VariableexpenseResponse class TestVariableexpenseResponse(unittest.TestCase): """VariableexpenseResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> VariableexpenseResponse: optional params are included """ # uncomment below to create an instance of `VariableexpenseResponse` """ - model = VariableexpenseResponse() # noqa: E501 + model = VariableexpenseResponse() if include_optional: return VariableexpenseResponse( pki_variableexpense_id = 2, diff --git a/test/test_variableexpense_response_compound.py b/test/test_variableexpense_response_compound.py index dad3d82d9..f2a9809e9 100644 --- a/test/test_variableexpense_response_compound.py +++ b/test/test_variableexpense_response_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.variableexpense_response_compound import VariableexpenseResponseCompound # noqa: E501 +from eZmaxApi.models.variableexpense_response_compound import VariableexpenseResponseCompound class TestVariableexpenseResponseCompound(unittest.TestCase): """VariableexpenseResponseCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> VariableexpenseResponseCompound: optional params are included """ # uncomment below to create an instance of `VariableexpenseResponseCompound` """ - model = VariableexpenseResponseCompound() # noqa: E501 + model = VariableexpenseResponseCompound() if include_optional: return VariableexpenseResponseCompound( pki_variableexpense_id = 2, diff --git a/test/test_versionhistory_get_object_v2_response.py b/test/test_versionhistory_get_object_v2_response.py index 5eec0000b..8b9b116ed 100644 --- a/test/test_versionhistory_get_object_v2_response.py +++ b/test/test_versionhistory_get_object_v2_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.versionhistory_get_object_v2_response import VersionhistoryGetObjectV2Response # noqa: E501 +from eZmaxApi.models.versionhistory_get_object_v2_response import VersionhistoryGetObjectV2Response class TestVersionhistoryGetObjectV2Response(unittest.TestCase): """VersionhistoryGetObjectV2Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> VersionhistoryGetObjectV2Response: optional params are included """ # uncomment below to create an instance of `VersionhistoryGetObjectV2Response` """ - model = VersionhistoryGetObjectV2Response() # noqa: E501 + model = VersionhistoryGetObjectV2Response() if include_optional: return VersionhistoryGetObjectV2Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_versionhistory_get_object_v2_response_m_payload.py b/test/test_versionhistory_get_object_v2_response_m_payload.py index ae431125e..aaf3239b0 100644 --- a/test/test_versionhistory_get_object_v2_response_m_payload.py +++ b/test/test_versionhistory_get_object_v2_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.versionhistory_get_object_v2_response_m_payload import VersionhistoryGetObjectV2ResponseMPayload # noqa: E501 +from eZmaxApi.models.versionhistory_get_object_v2_response_m_payload import VersionhistoryGetObjectV2ResponseMPayload class TestVersionhistoryGetObjectV2ResponseMPayload(unittest.TestCase): """VersionhistoryGetObjectV2ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> VersionhistoryGetObjectV2ResponseMP optional params are included """ # uncomment below to create an instance of `VersionhistoryGetObjectV2ResponseMPayload` """ - model = VersionhistoryGetObjectV2ResponseMPayload() # noqa: E501 + model = VersionhistoryGetObjectV2ResponseMPayload() if include_optional: return VersionhistoryGetObjectV2ResponseMPayload( obj_versionhistory = eZmaxApi.models.versionhistory_response_compound.versionhistory-ResponseCompound() diff --git a/test/test_versionhistory_response.py b/test/test_versionhistory_response.py index e12ae7e38..5984c3b3b 100644 --- a/test/test_versionhistory_response.py +++ b/test/test_versionhistory_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.versionhistory_response import VersionhistoryResponse # noqa: E501 +from eZmaxApi.models.versionhistory_response import VersionhistoryResponse class TestVersionhistoryResponse(unittest.TestCase): """VersionhistoryResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> VersionhistoryResponse: optional params are included """ # uncomment below to create an instance of `VersionhistoryResponse` """ - model = VersionhistoryResponse() # noqa: E501 + model = VersionhistoryResponse() if include_optional: return VersionhistoryResponse( pki_versionhistory_id = 42, diff --git a/test/test_versionhistory_response_compound.py b/test/test_versionhistory_response_compound.py index 70c8d052f..bd3513e91 100644 --- a/test/test_versionhistory_response_compound.py +++ b/test/test_versionhistory_response_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.versionhistory_response_compound import VersionhistoryResponseCompound # noqa: E501 +from eZmaxApi.models.versionhistory_response_compound import VersionhistoryResponseCompound class TestVersionhistoryResponseCompound(unittest.TestCase): """VersionhistoryResponseCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> VersionhistoryResponseCompound: optional params are included """ # uncomment below to create an instance of `VersionhistoryResponseCompound` """ - model = VersionhistoryResponseCompound() # noqa: E501 + model = VersionhistoryResponseCompound() if include_optional: return VersionhistoryResponseCompound( pki_versionhistory_id = 42, diff --git a/test/test_webhook_create_object_v1_request.py b/test/test_webhook_create_object_v1_request.py index a7ca02c2a..0979dc0e2 100644 --- a/test/test_webhook_create_object_v1_request.py +++ b/test/test_webhook_create_object_v1_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.webhook_create_object_v1_request import WebhookCreateObjectV1Request # noqa: E501 +from eZmaxApi.models.webhook_create_object_v1_request import WebhookCreateObjectV1Request class TestWebhookCreateObjectV1Request(unittest.TestCase): """WebhookCreateObjectV1Request unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> WebhookCreateObjectV1Request: optional params are included """ # uncomment below to create an instance of `WebhookCreateObjectV1Request` """ - model = WebhookCreateObjectV1Request() # noqa: E501 + model = WebhookCreateObjectV1Request() if include_optional: return WebhookCreateObjectV1Request( a_obj_webhook = [ diff --git a/test/test_webhook_create_object_v1_response.py b/test/test_webhook_create_object_v1_response.py index 3d3881df3..b4a2b296e 100644 --- a/test/test_webhook_create_object_v1_response.py +++ b/test/test_webhook_create_object_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.webhook_create_object_v1_response import WebhookCreateObjectV1Response # noqa: E501 +from eZmaxApi.models.webhook_create_object_v1_response import WebhookCreateObjectV1Response class TestWebhookCreateObjectV1Response(unittest.TestCase): """WebhookCreateObjectV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> WebhookCreateObjectV1Response: optional params are included """ # uncomment below to create an instance of `WebhookCreateObjectV1Response` """ - model = WebhookCreateObjectV1Response() # noqa: E501 + model = WebhookCreateObjectV1Response() if include_optional: return WebhookCreateObjectV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_webhook_create_object_v1_response_m_payload.py b/test/test_webhook_create_object_v1_response_m_payload.py index 392a017df..a91118182 100644 --- a/test/test_webhook_create_object_v1_response_m_payload.py +++ b/test/test_webhook_create_object_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.webhook_create_object_v1_response_m_payload import WebhookCreateObjectV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.webhook_create_object_v1_response_m_payload import WebhookCreateObjectV1ResponseMPayload class TestWebhookCreateObjectV1ResponseMPayload(unittest.TestCase): """WebhookCreateObjectV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> WebhookCreateObjectV1ResponseMPaylo optional params are included """ # uncomment below to create an instance of `WebhookCreateObjectV1ResponseMPayload` """ - model = WebhookCreateObjectV1ResponseMPayload() # noqa: E501 + model = WebhookCreateObjectV1ResponseMPayload() if include_optional: return WebhookCreateObjectV1ResponseMPayload( a_pki_webhook_id = [ diff --git a/test/test_webhook_create_object_v2_request.py b/test/test_webhook_create_object_v2_request.py new file mode 100644 index 000000000..b3b153375 --- /dev/null +++ b/test/test_webhook_create_object_v2_request.py @@ -0,0 +1,58 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest +import datetime + +from eZmaxApi.models.webhook_create_object_v2_request import WebhookCreateObjectV2Request + +class TestWebhookCreateObjectV2Request(unittest.TestCase): + """WebhookCreateObjectV2Request unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> WebhookCreateObjectV2Request: + """Test WebhookCreateObjectV2Request + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `WebhookCreateObjectV2Request` + """ + model = WebhookCreateObjectV2Request() + if include_optional: + return WebhookCreateObjectV2Request( + a_obj_webhook = [ + eZmaxApi.models.webhook_request_compound.webhook-RequestCompound() + ] + ) + else: + return WebhookCreateObjectV2Request( + a_obj_webhook = [ + eZmaxApi.models.webhook_request_compound.webhook-RequestCompound() + ], + ) + """ + + def testWebhookCreateObjectV2Request(self): + """Test WebhookCreateObjectV2Request""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_webhook_create_object_v2_response.py b/test/test_webhook_create_object_v2_response.py new file mode 100644 index 000000000..37f203b88 --- /dev/null +++ b/test/test_webhook_create_object_v2_response.py @@ -0,0 +1,75 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest +import datetime + +from eZmaxApi.models.webhook_create_object_v2_response import WebhookCreateObjectV2Response + +class TestWebhookCreateObjectV2Response(unittest.TestCase): + """WebhookCreateObjectV2Response unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> WebhookCreateObjectV2Response: + """Test WebhookCreateObjectV2Response + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `WebhookCreateObjectV2Response` + """ + model = WebhookCreateObjectV2Response() + if include_optional: + return WebhookCreateObjectV2Response( + obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( + i_version_min = 1, + i_version_max = 2, + a_required_permission = [ + 117 + ], + b_version_deprecated = False, ), + obj_debug = {"sMemoryUsage":"11,923MB","sRunTime":"0.6084s","iSQLSelects":3,"iSQLQueries":6,"a_objSQLQuery":[{"sQuery":"SELECT * FROM table","fDuration":1.0E-4},{"sQuery":"SELECT * FROM table","fDuration":1.0E-4}]}, + m_payload = eZmaxApi.models.webhook_create_object_v2_response_m_payload.webhook-createObject-v2-Response-mPayload( + a_obj_webhook = [ + eZmaxApi.models.webhook_response_compound.webhook-ResponseCompound() + ], ) + ) + else: + return WebhookCreateObjectV2Response( + obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( + i_version_min = 1, + i_version_max = 2, + a_required_permission = [ + 117 + ], + b_version_deprecated = False, ), + m_payload = eZmaxApi.models.webhook_create_object_v2_response_m_payload.webhook-createObject-v2-Response-mPayload( + a_obj_webhook = [ + eZmaxApi.models.webhook_response_compound.webhook-ResponseCompound() + ], ), + ) + """ + + def testWebhookCreateObjectV2Response(self): + """Test WebhookCreateObjectV2Response""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_webhook_create_object_v2_response_m_payload.py b/test/test_webhook_create_object_v2_response_m_payload.py new file mode 100644 index 000000000..f10270d19 --- /dev/null +++ b/test/test_webhook_create_object_v2_response_m_payload.py @@ -0,0 +1,58 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest +import datetime + +from eZmaxApi.models.webhook_create_object_v2_response_m_payload import WebhookCreateObjectV2ResponseMPayload + +class TestWebhookCreateObjectV2ResponseMPayload(unittest.TestCase): + """WebhookCreateObjectV2ResponseMPayload unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> WebhookCreateObjectV2ResponseMPayload: + """Test WebhookCreateObjectV2ResponseMPayload + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `WebhookCreateObjectV2ResponseMPayload` + """ + model = WebhookCreateObjectV2ResponseMPayload() + if include_optional: + return WebhookCreateObjectV2ResponseMPayload( + a_obj_webhook = [ + eZmaxApi.models.webhook_response_compound.webhook-ResponseCompound() + ] + ) + else: + return WebhookCreateObjectV2ResponseMPayload( + a_obj_webhook = [ + eZmaxApi.models.webhook_response_compound.webhook-ResponseCompound() + ], + ) + """ + + def testWebhookCreateObjectV2ResponseMPayload(self): + """Test WebhookCreateObjectV2ResponseMPayload""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_webhook_delete_object_v1_response.py b/test/test_webhook_delete_object_v1_response.py index 0c829b8ed..932452215 100644 --- a/test/test_webhook_delete_object_v1_response.py +++ b/test/test_webhook_delete_object_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.webhook_delete_object_v1_response import WebhookDeleteObjectV1Response # noqa: E501 +from eZmaxApi.models.webhook_delete_object_v1_response import WebhookDeleteObjectV1Response class TestWebhookDeleteObjectV1Response(unittest.TestCase): """WebhookDeleteObjectV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> WebhookDeleteObjectV1Response: optional params are included """ # uncomment below to create an instance of `WebhookDeleteObjectV1Response` """ - model = WebhookDeleteObjectV1Response() # noqa: E501 + model = WebhookDeleteObjectV1Response() if include_optional: return WebhookDeleteObjectV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_webhook_edit_object_v1_request.py b/test/test_webhook_edit_object_v1_request.py index ded3b28d3..55d8e1ab8 100644 --- a/test/test_webhook_edit_object_v1_request.py +++ b/test/test_webhook_edit_object_v1_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.webhook_edit_object_v1_request import WebhookEditObjectV1Request # noqa: E501 +from eZmaxApi.models.webhook_edit_object_v1_request import WebhookEditObjectV1Request class TestWebhookEditObjectV1Request(unittest.TestCase): """WebhookEditObjectV1Request unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> WebhookEditObjectV1Request: optional params are included """ # uncomment below to create an instance of `WebhookEditObjectV1Request` """ - model = WebhookEditObjectV1Request() # noqa: E501 + model = WebhookEditObjectV1Request() if include_optional: return WebhookEditObjectV1Request( obj_webhook = eZmaxApi.models.webhook_request_compound.webhook-RequestCompound() diff --git a/test/test_webhook_edit_object_v1_response.py b/test/test_webhook_edit_object_v1_response.py index 5996da566..122e38f31 100644 --- a/test/test_webhook_edit_object_v1_response.py +++ b/test/test_webhook_edit_object_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.webhook_edit_object_v1_response import WebhookEditObjectV1Response # noqa: E501 +from eZmaxApi.models.webhook_edit_object_v1_response import WebhookEditObjectV1Response class TestWebhookEditObjectV1Response(unittest.TestCase): """WebhookEditObjectV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> WebhookEditObjectV1Response: optional params are included """ # uncomment below to create an instance of `WebhookEditObjectV1Response` """ - model = WebhookEditObjectV1Response() # noqa: E501 + model = WebhookEditObjectV1Response() if include_optional: return WebhookEditObjectV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_webhook_ezsign_document_completed.py b/test/test_webhook_ezsign_document_completed.py index 4e953cdf2..b57d6210b 100644 --- a/test/test_webhook_ezsign_document_completed.py +++ b/test/test_webhook_ezsign_document_completed.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.webhook_ezsign_document_completed import WebhookEzsignDocumentCompleted # noqa: E501 +from eZmaxApi.models.webhook_ezsign_document_completed import WebhookEzsignDocumentCompleted class TestWebhookEzsignDocumentCompleted(unittest.TestCase): """WebhookEzsignDocumentCompleted unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> WebhookEzsignDocumentCompleted: optional params are included """ # uncomment below to create an instance of `WebhookEzsignDocumentCompleted` """ - model = WebhookEzsignDocumentCompleted() # noqa: E501 + model = WebhookEzsignDocumentCompleted() if include_optional: return WebhookEzsignDocumentCompleted( obj_webhook = eZmaxApi.models.custom_webhook_response.Custom-Webhook-Response(), @@ -78,7 +78,8 @@ def make_instance(self, include_optional) -> WebhookEzsignDocumentCompleted: s_user_firstname = 'John', s_apikey_description_x = 'Project X', dt_auditdetail_date = '2020-12-31 23:59:59', ), ), - s_ezsigndocument_externalid = '{"ID": 1234, "TAGS": ["tag1", "tag2", "tag3"]}', ) + s_ezsigndocument_externalid = '{"ID": 1234, "TAGS": ["tag1", "tag2", "tag3"]}', + i_ezsigndocument_ezsignsignatureattachmenttotal = 3, ) ) else: return WebhookEzsignDocumentCompleted( @@ -123,7 +124,8 @@ def make_instance(self, include_optional) -> WebhookEzsignDocumentCompleted: s_user_firstname = 'John', s_apikey_description_x = 'Project X', dt_auditdetail_date = '2020-12-31 23:59:59', ), ), - s_ezsigndocument_externalid = '{"ID": 1234, "TAGS": ["tag1", "tag2", "tag3"]}', ), + s_ezsigndocument_externalid = '{"ID": 1234, "TAGS": ["tag1", "tag2", "tag3"]}', + i_ezsigndocument_ezsignsignatureattachmenttotal = 3, ), ) """ diff --git a/test/test_webhook_ezsign_ezsignsigner_acceptclause.py b/test/test_webhook_ezsign_ezsignsigner_acceptclause.py index 6b1a4b197..c2202a0a1 100644 --- a/test/test_webhook_ezsign_ezsignsigner_acceptclause.py +++ b/test/test_webhook_ezsign_ezsignsigner_acceptclause.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.webhook_ezsign_ezsignsigner_acceptclause import WebhookEzsignEzsignsignerAcceptclause # noqa: E501 +from eZmaxApi.models.webhook_ezsign_ezsignsigner_acceptclause import WebhookEzsignEzsignsignerAcceptclause class TestWebhookEzsignEzsignsignerAcceptclause(unittest.TestCase): """WebhookEzsignEzsignsignerAcceptclause unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> WebhookEzsignEzsignsignerAcceptclau optional params are included """ # uncomment below to create an instance of `WebhookEzsignEzsignsignerAcceptclause` """ - model = WebhookEzsignEzsignsignerAcceptclause() # noqa: E501 + model = WebhookEzsignEzsignsignerAcceptclause() if include_optional: return WebhookEzsignEzsignsignerAcceptclause( obj_webhook = eZmaxApi.models.custom_webhook_response.Custom-Webhook-Response(), diff --git a/test/test_webhook_ezsign_ezsignsigner_connect.py b/test/test_webhook_ezsign_ezsignsigner_connect.py index 0d2a3f6c0..d9eac6bd8 100644 --- a/test/test_webhook_ezsign_ezsignsigner_connect.py +++ b/test/test_webhook_ezsign_ezsignsigner_connect.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.webhook_ezsign_ezsignsigner_connect import WebhookEzsignEzsignsignerConnect # noqa: E501 +from eZmaxApi.models.webhook_ezsign_ezsignsigner_connect import WebhookEzsignEzsignsignerConnect class TestWebhookEzsignEzsignsignerConnect(unittest.TestCase): """WebhookEzsignEzsignsignerConnect unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> WebhookEzsignEzsignsignerConnect: optional params are included """ # uncomment below to create an instance of `WebhookEzsignEzsignsignerConnect` """ - model = WebhookEzsignEzsignsignerConnect() # noqa: E501 + model = WebhookEzsignEzsignsignerConnect() if include_optional: return WebhookEzsignEzsignsignerConnect( obj_webhook = eZmaxApi.models.custom_webhook_response.Custom-Webhook-Response(), diff --git a/test/test_webhook_ezsign_folder_completed.py b/test/test_webhook_ezsign_folder_completed.py index 0e1dc277b..b1355d705 100644 --- a/test/test_webhook_ezsign_folder_completed.py +++ b/test/test_webhook_ezsign_folder_completed.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.webhook_ezsign_folder_completed import WebhookEzsignFolderCompleted # noqa: E501 +from eZmaxApi.models.webhook_ezsign_folder_completed import WebhookEzsignFolderCompleted class TestWebhookEzsignFolderCompleted(unittest.TestCase): """WebhookEzsignFolderCompleted unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> WebhookEzsignFolderCompleted: optional params are included """ # uncomment below to create an instance of `WebhookEzsignFolderCompleted` """ - model = WebhookEzsignFolderCompleted() # noqa: E501 + model = WebhookEzsignFolderCompleted() if include_optional: return WebhookEzsignFolderCompleted( obj_webhook = eZmaxApi.models.custom_webhook_response.Custom-Webhook-Response(), diff --git a/test/test_webhook_get_history_v1_response.py b/test/test_webhook_get_history_v1_response.py index e67d6cf11..47d254b5a 100644 --- a/test/test_webhook_get_history_v1_response.py +++ b/test/test_webhook_get_history_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.webhook_get_history_v1_response import WebhookGetHistoryV1Response # noqa: E501 +from eZmaxApi.models.webhook_get_history_v1_response import WebhookGetHistoryV1Response class TestWebhookGetHistoryV1Response(unittest.TestCase): """WebhookGetHistoryV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> WebhookGetHistoryV1Response: optional params are included """ # uncomment below to create an instance of `WebhookGetHistoryV1Response` """ - model = WebhookGetHistoryV1Response() # noqa: E501 + model = WebhookGetHistoryV1Response() if include_optional: return WebhookGetHistoryV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_webhook_get_history_v1_response_m_payload.py b/test/test_webhook_get_history_v1_response_m_payload.py index 0a59a84bb..2e0471a3b 100644 --- a/test/test_webhook_get_history_v1_response_m_payload.py +++ b/test/test_webhook_get_history_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.webhook_get_history_v1_response_m_payload import WebhookGetHistoryV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.webhook_get_history_v1_response_m_payload import WebhookGetHistoryV1ResponseMPayload class TestWebhookGetHistoryV1ResponseMPayload(unittest.TestCase): """WebhookGetHistoryV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> WebhookGetHistoryV1ResponseMPayload optional params are included """ # uncomment below to create an instance of `WebhookGetHistoryV1ResponseMPayload` """ - model = WebhookGetHistoryV1ResponseMPayload() # noqa: E501 + model = WebhookGetHistoryV1ResponseMPayload() if include_optional: return WebhookGetHistoryV1ResponseMPayload( a_obj_webhooklog = [ diff --git a/test/test_webhook_get_list_v1_response.py b/test/test_webhook_get_list_v1_response.py index 8534bd8c2..5752607ff 100644 --- a/test/test_webhook_get_list_v1_response.py +++ b/test/test_webhook_get_list_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.webhook_get_list_v1_response import WebhookGetListV1Response # noqa: E501 +from eZmaxApi.models.webhook_get_list_v1_response import WebhookGetListV1Response class TestWebhookGetListV1Response(unittest.TestCase): """WebhookGetListV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> WebhookGetListV1Response: optional params are included """ # uncomment below to create an instance of `WebhookGetListV1Response` """ - model = WebhookGetListV1Response() # noqa: E501 + model = WebhookGetListV1Response() if include_optional: return WebhookGetListV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload_get_list.Common-Response-objDebugPayload_getList(), diff --git a/test/test_webhook_get_list_v1_response_m_payload.py b/test/test_webhook_get_list_v1_response_m_payload.py index 7c6f4140a..49e479f09 100644 --- a/test/test_webhook_get_list_v1_response_m_payload.py +++ b/test/test_webhook_get_list_v1_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.webhook_get_list_v1_response_m_payload import WebhookGetListV1ResponseMPayload # noqa: E501 +from eZmaxApi.models.webhook_get_list_v1_response_m_payload import WebhookGetListV1ResponseMPayload class TestWebhookGetListV1ResponseMPayload(unittest.TestCase): """WebhookGetListV1ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> WebhookGetListV1ResponseMPayload: optional params are included """ # uncomment below to create an instance of `WebhookGetListV1ResponseMPayload` """ - model = WebhookGetListV1ResponseMPayload() # noqa: E501 + model = WebhookGetListV1ResponseMPayload() if include_optional: return WebhookGetListV1ResponseMPayload( i_row_returned = 100, @@ -49,7 +49,8 @@ def make_instance(self, include_optional) -> WebhookGetListV1ResponseMPayload: e_webhook_module = 'Ezsign', e_webhook_ezsignevent = 'FolderCompleted', e_webhook_managementevent = 'UserCreated', - b_webhook_isactive = True, ) + b_webhook_isactive = True, + b_webhook_issigned = True, ) ] ) else: @@ -66,7 +67,8 @@ def make_instance(self, include_optional) -> WebhookGetListV1ResponseMPayload: e_webhook_module = 'Ezsign', e_webhook_ezsignevent = 'FolderCompleted', e_webhook_managementevent = 'UserCreated', - b_webhook_isactive = True, ) + b_webhook_isactive = True, + b_webhook_issigned = True, ) ], ) """ diff --git a/test/test_webhook_get_object_v2_response.py b/test/test_webhook_get_object_v2_response.py index 615370f3a..fb1d42fd2 100644 --- a/test/test_webhook_get_object_v2_response.py +++ b/test/test_webhook_get_object_v2_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.webhook_get_object_v2_response import WebhookGetObjectV2Response # noqa: E501 +from eZmaxApi.models.webhook_get_object_v2_response import WebhookGetObjectV2Response class TestWebhookGetObjectV2Response(unittest.TestCase): """WebhookGetObjectV2Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> WebhookGetObjectV2Response: optional params are included """ # uncomment below to create an instance of `WebhookGetObjectV2Response` """ - model = WebhookGetObjectV2Response() # noqa: E501 + model = WebhookGetObjectV2Response() if include_optional: return WebhookGetObjectV2Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_webhook_get_object_v2_response_m_payload.py b/test/test_webhook_get_object_v2_response_m_payload.py index ba24f6067..fe5b6354e 100644 --- a/test/test_webhook_get_object_v2_response_m_payload.py +++ b/test/test_webhook_get_object_v2_response_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.webhook_get_object_v2_response_m_payload import WebhookGetObjectV2ResponseMPayload # noqa: E501 +from eZmaxApi.models.webhook_get_object_v2_response_m_payload import WebhookGetObjectV2ResponseMPayload class TestWebhookGetObjectV2ResponseMPayload(unittest.TestCase): """WebhookGetObjectV2ResponseMPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> WebhookGetObjectV2ResponseMPayload: optional params are included """ # uncomment below to create an instance of `WebhookGetObjectV2ResponseMPayload` """ - model = WebhookGetObjectV2ResponseMPayload() # noqa: E501 + model = WebhookGetObjectV2ResponseMPayload() if include_optional: return WebhookGetObjectV2ResponseMPayload( obj_webhook = eZmaxApi.models.webhook_response_compound.webhook-ResponseCompound() diff --git a/test/test_webhook_list_element.py b/test/test_webhook_list_element.py index 50c152720..ffe2eae8f 100644 --- a/test/test_webhook_list_element.py +++ b/test/test_webhook_list_element.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.webhook_list_element import WebhookListElement # noqa: E501 +from eZmaxApi.models.webhook_list_element import WebhookListElement class TestWebhookListElement(unittest.TestCase): """WebhookListElement unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> WebhookListElement: optional params are included """ # uncomment below to create an instance of `WebhookListElement` """ - model = WebhookListElement() # noqa: E501 + model = WebhookListElement() if include_optional: return WebhookListElement( pki_webhook_id = 77, @@ -45,7 +45,8 @@ def make_instance(self, include_optional) -> WebhookListElement: e_webhook_module = 'Ezsign', e_webhook_ezsignevent = 'FolderCompleted', e_webhook_managementevent = 'UserCreated', - b_webhook_isactive = True + b_webhook_isactive = True, + b_webhook_issigned = True ) else: return WebhookListElement( @@ -56,6 +57,7 @@ def make_instance(self, include_optional) -> WebhookListElement: s_webhook_emailfailed = 'email@example.com', e_webhook_module = 'Ezsign', b_webhook_isactive = True, + b_webhook_issigned = True, ) """ diff --git a/test/test_webhook_regenerate_apikey_v1_request.py b/test/test_webhook_regenerate_apikey_v1_request.py new file mode 100644 index 000000000..72a8f15e9 --- /dev/null +++ b/test/test_webhook_regenerate_apikey_v1_request.py @@ -0,0 +1,53 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest +import datetime + +from eZmaxApi.models.webhook_regenerate_apikey_v1_request import WebhookRegenerateApikeyV1Request + +class TestWebhookRegenerateApikeyV1Request(unittest.TestCase): + """WebhookRegenerateApikeyV1Request unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> WebhookRegenerateApikeyV1Request: + """Test WebhookRegenerateApikeyV1Request + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `WebhookRegenerateApikeyV1Request` + """ + model = WebhookRegenerateApikeyV1Request() + if include_optional: + return WebhookRegenerateApikeyV1Request( + b_webhook_issigned = True + ) + else: + return WebhookRegenerateApikeyV1Request( + ) + """ + + def testWebhookRegenerateApikeyV1Request(self): + """Test WebhookRegenerateApikeyV1Request""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_webhook_regenerate_apikey_v1_response.py b/test/test_webhook_regenerate_apikey_v1_response.py new file mode 100644 index 000000000..21d61d483 --- /dev/null +++ b/test/test_webhook_regenerate_apikey_v1_response.py @@ -0,0 +1,71 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest +import datetime + +from eZmaxApi.models.webhook_regenerate_apikey_v1_response import WebhookRegenerateApikeyV1Response + +class TestWebhookRegenerateApikeyV1Response(unittest.TestCase): + """WebhookRegenerateApikeyV1Response unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> WebhookRegenerateApikeyV1Response: + """Test WebhookRegenerateApikeyV1Response + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `WebhookRegenerateApikeyV1Response` + """ + model = WebhookRegenerateApikeyV1Response() + if include_optional: + return WebhookRegenerateApikeyV1Response( + obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( + i_version_min = 1, + i_version_max = 2, + a_required_permission = [ + 117 + ], + b_version_deprecated = False, ), + obj_debug = {"sMemoryUsage":"11,923MB","sRunTime":"0.6084s","iSQLSelects":3,"iSQLQueries":6,"a_objSQLQuery":[{"sQuery":"SELECT * FROM table","fDuration":1.0E-4},{"sQuery":"SELECT * FROM table","fDuration":1.0E-4}]}, + m_payload = eZmaxApi.models.webhook_regenerate_apikey_v1_response_m_payload.webhook-regenerateApikey-v1-Response-mPayload( + obj_webhook = eZmaxApi.models.webhook_response_compound.webhook-ResponseCompound(), ) + ) + else: + return WebhookRegenerateApikeyV1Response( + obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( + i_version_min = 1, + i_version_max = 2, + a_required_permission = [ + 117 + ], + b_version_deprecated = False, ), + m_payload = eZmaxApi.models.webhook_regenerate_apikey_v1_response_m_payload.webhook-regenerateApikey-v1-Response-mPayload( + obj_webhook = eZmaxApi.models.webhook_response_compound.webhook-ResponseCompound(), ), + ) + """ + + def testWebhookRegenerateApikeyV1Response(self): + """Test WebhookRegenerateApikeyV1Response""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_webhook_regenerate_apikey_v1_response_m_payload.py b/test/test_webhook_regenerate_apikey_v1_response_m_payload.py new file mode 100644 index 000000000..5ee3ca548 --- /dev/null +++ b/test/test_webhook_regenerate_apikey_v1_response_m_payload.py @@ -0,0 +1,54 @@ +# coding: utf-8 + +""" + eZmax API Definition (Full) + + This API expose all the functionnalities for the eZmax and eZsign applications. + + The version of the OpenAPI document: 1.2.0 + Contact: support-api@ezmax.ca + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest +import datetime + +from eZmaxApi.models.webhook_regenerate_apikey_v1_response_m_payload import WebhookRegenerateApikeyV1ResponseMPayload + +class TestWebhookRegenerateApikeyV1ResponseMPayload(unittest.TestCase): + """WebhookRegenerateApikeyV1ResponseMPayload unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> WebhookRegenerateApikeyV1ResponseMPayload: + """Test WebhookRegenerateApikeyV1ResponseMPayload + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `WebhookRegenerateApikeyV1ResponseMPayload` + """ + model = WebhookRegenerateApikeyV1ResponseMPayload() + if include_optional: + return WebhookRegenerateApikeyV1ResponseMPayload( + obj_webhook = eZmaxApi.models.webhook_response_compound.webhook-ResponseCompound() + ) + else: + return WebhookRegenerateApikeyV1ResponseMPayload( + obj_webhook = eZmaxApi.models.webhook_response_compound.webhook-ResponseCompound(), + ) + """ + + def testWebhookRegenerateApikeyV1ResponseMPayload(self): + """Test WebhookRegenerateApikeyV1ResponseMPayload""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_webhook_request.py b/test/test_webhook_request.py index 89f379898..f0e86ec86 100644 --- a/test/test_webhook_request.py +++ b/test/test_webhook_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.webhook_request import WebhookRequest # noqa: E501 +from eZmaxApi.models.webhook_request import WebhookRequest class TestWebhookRequest(unittest.TestCase): """WebhookRequest unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> WebhookRequest: optional params are included """ # uncomment below to create an instance of `WebhookRequest` """ - model = WebhookRequest() # noqa: E501 + model = WebhookRequest() if include_optional: return WebhookRequest( pki_webhook_id = 77, @@ -46,6 +46,7 @@ def make_instance(self, include_optional) -> WebhookRequest: s_webhook_url = 'https://www.example.com', s_webhook_emailfailed = 'email@example.com', b_webhook_isactive = True, + b_webhook_issigned = True, b_webhook_skipsslvalidation = False ) else: diff --git a/test/test_webhook_request_compound.py b/test/test_webhook_request_compound.py index f745c811e..33d5b6e53 100644 --- a/test/test_webhook_request_compound.py +++ b/test/test_webhook_request_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.webhook_request_compound import WebhookRequestCompound # noqa: E501 +from eZmaxApi.models.webhook_request_compound import WebhookRequestCompound class TestWebhookRequestCompound(unittest.TestCase): """WebhookRequestCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> WebhookRequestCompound: optional params are included """ # uncomment below to create an instance of `WebhookRequestCompound` """ - model = WebhookRequestCompound() # noqa: E501 + model = WebhookRequestCompound() if include_optional: return WebhookRequestCompound( pki_webhook_id = 77, @@ -46,6 +46,7 @@ def make_instance(self, include_optional) -> WebhookRequestCompound: s_webhook_url = 'https://www.example.com', s_webhook_emailfailed = 'email@example.com', b_webhook_isactive = True, + b_webhook_issigned = True, b_webhook_skipsslvalidation = False ) else: diff --git a/test/test_webhook_response.py b/test/test_webhook_response.py index 7e16da92d..c8d06169d 100644 --- a/test/test_webhook_response.py +++ b/test/test_webhook_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.webhook_response import WebhookResponse # noqa: E501 +from eZmaxApi.models.webhook_response import WebhookResponse class TestWebhookResponse(unittest.TestCase): """WebhookResponse unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> WebhookResponse: optional params are included """ # uncomment below to create an instance of `WebhookResponse` """ - model = WebhookResponse() # noqa: E501 + model = WebhookResponse() if include_optional: return WebhookResponse( pki_webhook_id = 77, @@ -46,7 +46,10 @@ def make_instance(self, include_optional) -> WebhookResponse: e_webhook_managementevent = 'UserCreated', s_webhook_url = 'https://www.example.com', s_webhook_emailfailed = 'email@example.com', + s_webhook_apikey = '', + s_webhook_secret = '', b_webhook_isactive = True, + b_webhook_issigned = True, b_webhook_skipsslvalidation = False ) else: @@ -57,6 +60,7 @@ def make_instance(self, include_optional) -> WebhookResponse: s_webhook_url = 'https://www.example.com', s_webhook_emailfailed = 'email@example.com', b_webhook_isactive = True, + b_webhook_issigned = True, b_webhook_skipsslvalidation = False, ) """ diff --git a/test/test_webhook_response_compound.py b/test/test_webhook_response_compound.py index f4a983908..6898227a8 100644 --- a/test/test_webhook_response_compound.py +++ b/test/test_webhook_response_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.webhook_response_compound import WebhookResponseCompound # noqa: E501 +from eZmaxApi.models.webhook_response_compound import WebhookResponseCompound class TestWebhookResponseCompound(unittest.TestCase): """WebhookResponseCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> WebhookResponseCompound: optional params are included """ # uncomment below to create an instance of `WebhookResponseCompound` """ - model = WebhookResponseCompound() # noqa: E501 + model = WebhookResponseCompound() if include_optional: return WebhookResponseCompound( pki_webhook_id = 77, @@ -46,7 +46,10 @@ def make_instance(self, include_optional) -> WebhookResponseCompound: e_webhook_managementevent = 'UserCreated', s_webhook_url = 'https://www.example.com', s_webhook_emailfailed = 'email@example.com', + s_webhook_apikey = '', + s_webhook_secret = '', b_webhook_isactive = True, + b_webhook_issigned = True, b_webhook_skipsslvalidation = False, s_webhook_event = 'Ezsign-DocumentCompleted' ) @@ -58,6 +61,7 @@ def make_instance(self, include_optional) -> WebhookResponseCompound: s_webhook_url = 'https://www.example.com', s_webhook_emailfailed = 'email@example.com', b_webhook_isactive = True, + b_webhook_issigned = True, b_webhook_skipsslvalidation = False, ) """ diff --git a/test/test_webhook_test_v1_response.py b/test/test_webhook_test_v1_response.py index 968b4743e..2dd7adbfb 100644 --- a/test/test_webhook_test_v1_response.py +++ b/test/test_webhook_test_v1_response.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.webhook_test_v1_response import WebhookTestV1Response # noqa: E501 +from eZmaxApi.models.webhook_test_v1_response import WebhookTestV1Response class TestWebhookTestV1Response(unittest.TestCase): """WebhookTestV1Response unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> WebhookTestV1Response: optional params are included """ # uncomment below to create an instance of `WebhookTestV1Response` """ - model = WebhookTestV1Response() # noqa: E501 + model = WebhookTestV1Response() if include_optional: return WebhookTestV1Response( obj_debug_payload = eZmaxApi.models.common_response_obj_debug_payload.Common-Response-objDebugPayload( diff --git a/test/test_webhook_user_user_created.py b/test/test_webhook_user_user_created.py index 9cf84aaf6..9f5323994 100644 --- a/test/test_webhook_user_user_created.py +++ b/test/test_webhook_user_user_created.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.webhook_user_user_created import WebhookUserUserCreated # noqa: E501 +from eZmaxApi.models.webhook_user_user_created import WebhookUserUserCreated class TestWebhookUserUserCreated(unittest.TestCase): """WebhookUserUserCreated unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> WebhookUserUserCreated: optional params are included """ # uncomment below to create an instance of `WebhookUserUserCreated` """ - model = WebhookUserUserCreated() # noqa: E501 + model = WebhookUserUserCreated() if include_optional: return WebhookUserUserCreated( obj_webhook = eZmaxApi.models.custom_webhook_response.Custom-Webhook-Response(), diff --git a/test/test_webhook_userstaged_userstaged_created.py b/test/test_webhook_userstaged_userstaged_created.py index f0878a2f7..b2846310a 100644 --- a/test/test_webhook_userstaged_userstaged_created.py +++ b/test/test_webhook_userstaged_userstaged_created.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.webhook_userstaged_userstaged_created import WebhookUserstagedUserstagedCreated # noqa: E501 +from eZmaxApi.models.webhook_userstaged_userstaged_created import WebhookUserstagedUserstagedCreated class TestWebhookUserstagedUserstagedCreated(unittest.TestCase): """WebhookUserstagedUserstagedCreated unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> WebhookUserstagedUserstagedCreated: optional params are included """ # uncomment below to create an instance of `WebhookUserstagedUserstagedCreated` """ - model = WebhookUserstagedUserstagedCreated() # noqa: E501 + model = WebhookUserstagedUserstagedCreated() if include_optional: return WebhookUserstagedUserstagedCreated( obj_webhook = eZmaxApi.models.custom_webhook_response.Custom-Webhook-Response(), diff --git a/test/test_website_request.py b/test/test_website_request.py index 040c35ad7..3c80971d3 100644 --- a/test/test_website_request.py +++ b/test/test_website_request.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.website_request import WebsiteRequest # noqa: E501 +from eZmaxApi.models.website_request import WebsiteRequest class TestWebsiteRequest(unittest.TestCase): """WebsiteRequest unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> WebsiteRequest: optional params are included """ # uncomment below to create an instance of `WebsiteRequest` """ - model = WebsiteRequest() # noqa: E501 + model = WebsiteRequest() if include_optional: return WebsiteRequest( fki_websitetype_id = 1, diff --git a/test/test_website_request_compound.py b/test/test_website_request_compound.py index 15f062d0d..676a2cff8 100644 --- a/test/test_website_request_compound.py +++ b/test/test_website_request_compound.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.website_request_compound import WebsiteRequestCompound # noqa: E501 +from eZmaxApi.models.website_request_compound import WebsiteRequestCompound class TestWebsiteRequestCompound(unittest.TestCase): """WebsiteRequestCompound unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> WebsiteRequestCompound: optional params are included """ # uncomment below to create an instance of `WebsiteRequestCompound` """ - model = WebsiteRequestCompound() # noqa: E501 + model = WebsiteRequestCompound() if include_optional: return WebsiteRequestCompound( fki_websitetype_id = 1, diff --git a/test/test_websocket_request_server_get_websocket_idv1.py b/test/test_websocket_request_server_get_websocket_idv1.py index 5087b7ad9..74b9593b1 100644 --- a/test/test_websocket_request_server_get_websocket_idv1.py +++ b/test/test_websocket_request_server_get_websocket_idv1.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.websocket_request_server_get_websocket_idv1 import WebsocketRequestServerGetWebsocketIDV1 # noqa: E501 +from eZmaxApi.models.websocket_request_server_get_websocket_idv1 import WebsocketRequestServerGetWebsocketIDV1 class TestWebsocketRequestServerGetWebsocketIDV1(unittest.TestCase): """WebsocketRequestServerGetWebsocketIDV1 unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> WebsocketRequestServerGetWebsocketI optional params are included """ # uncomment below to create an instance of `WebsocketRequestServerGetWebsocketIDV1` """ - model = WebsocketRequestServerGetWebsocketIDV1() # noqa: E501 + model = WebsocketRequestServerGetWebsocketIDV1() if include_optional: return WebsocketRequestServerGetWebsocketIDV1( e_websocket_messagetype = 'RequestServer-GetWebsocketID-V1' diff --git a/test/test_websocket_response_error_v1.py b/test/test_websocket_response_error_v1.py index 197475c09..634638717 100644 --- a/test/test_websocket_response_error_v1.py +++ b/test/test_websocket_response_error_v1.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.websocket_response_error_v1 import WebsocketResponseErrorV1 # noqa: E501 +from eZmaxApi.models.websocket_response_error_v1 import WebsocketResponseErrorV1 class TestWebsocketResponseErrorV1(unittest.TestCase): """WebsocketResponseErrorV1 unit test stubs""" @@ -34,10 +34,11 @@ def make_instance(self, include_optional) -> WebsocketResponseErrorV1: optional params are included """ # uncomment below to create an instance of `WebsocketResponseErrorV1` """ - model = WebsocketResponseErrorV1() # noqa: E501 + model = WebsocketResponseErrorV1() if include_optional: return WebsocketResponseErrorV1( e_websocket_messagetype = 'Response-Error-V1', + s_websocket_channel = 'Ch@nnel_1.0', m_payload = eZmaxApi.models.websocket_response_error_v1_m_payload.Websocket-Response-Error-V1-mPayload( s_error_message = 'Invalid Signature Headers', e_error_code = 'BADREQUEST', ) @@ -45,6 +46,7 @@ def make_instance(self, include_optional) -> WebsocketResponseErrorV1: else: return WebsocketResponseErrorV1( e_websocket_messagetype = 'Response-Error-V1', + s_websocket_channel = 'Ch@nnel_1.0', m_payload = eZmaxApi.models.websocket_response_error_v1_m_payload.Websocket-Response-Error-V1-mPayload( s_error_message = 'Invalid Signature Headers', e_error_code = 'BADREQUEST', ), diff --git a/test/test_websocket_response_error_v1_m_payload.py b/test/test_websocket_response_error_v1_m_payload.py index c9f8d0a15..2cfc5a938 100644 --- a/test/test_websocket_response_error_v1_m_payload.py +++ b/test/test_websocket_response_error_v1_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.websocket_response_error_v1_m_payload import WebsocketResponseErrorV1MPayload # noqa: E501 +from eZmaxApi.models.websocket_response_error_v1_m_payload import WebsocketResponseErrorV1MPayload class TestWebsocketResponseErrorV1MPayload(unittest.TestCase): """WebsocketResponseErrorV1MPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> WebsocketResponseErrorV1MPayload: optional params are included """ # uncomment below to create an instance of `WebsocketResponseErrorV1MPayload` """ - model = WebsocketResponseErrorV1MPayload() # noqa: E501 + model = WebsocketResponseErrorV1MPayload() if include_optional: return WebsocketResponseErrorV1MPayload( s_error_message = 'Invalid Signature Headers', diff --git a/test/test_websocket_response_get_websocket_idv1.py b/test/test_websocket_response_get_websocket_idv1.py index b642a069c..c586e3ae1 100644 --- a/test/test_websocket_response_get_websocket_idv1.py +++ b/test/test_websocket_response_get_websocket_idv1.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.websocket_response_get_websocket_idv1 import WebsocketResponseGetWebsocketIDV1 # noqa: E501 +from eZmaxApi.models.websocket_response_get_websocket_idv1 import WebsocketResponseGetWebsocketIDV1 class TestWebsocketResponseGetWebsocketIDV1(unittest.TestCase): """WebsocketResponseGetWebsocketIDV1 unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> WebsocketResponseGetWebsocketIDV1: optional params are included """ # uncomment below to create an instance of `WebsocketResponseGetWebsocketIDV1` """ - model = WebsocketResponseGetWebsocketIDV1() # noqa: E501 + model = WebsocketResponseGetWebsocketIDV1() if include_optional: return WebsocketResponseGetWebsocketIDV1( e_websocket_messagetype = 'Response-GetWebsocketID-V1', diff --git a/test/test_websocket_response_get_websocket_idv1_m_payload.py b/test/test_websocket_response_get_websocket_idv1_m_payload.py index c2bc2d539..a75a694ab 100644 --- a/test/test_websocket_response_get_websocket_idv1_m_payload.py +++ b/test/test_websocket_response_get_websocket_idv1_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.websocket_response_get_websocket_idv1_m_payload import WebsocketResponseGetWebsocketIDV1MPayload # noqa: E501 +from eZmaxApi.models.websocket_response_get_websocket_idv1_m_payload import WebsocketResponseGetWebsocketIDV1MPayload class TestWebsocketResponseGetWebsocketIDV1MPayload(unittest.TestCase): """WebsocketResponseGetWebsocketIDV1MPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> WebsocketResponseGetWebsocketIDV1MP optional params are included """ # uncomment below to create an instance of `WebsocketResponseGetWebsocketIDV1MPayload` """ - model = WebsocketResponseGetWebsocketIDV1MPayload() # noqa: E501 + model = WebsocketResponseGetWebsocketIDV1MPayload() if include_optional: return WebsocketResponseGetWebsocketIDV1MPayload( s_websocket_id = 'G_omidyY4osCFEQ=' diff --git a/test/test_websocket_response_information_v1.py b/test/test_websocket_response_information_v1.py index 252d18c89..a862d099a 100644 --- a/test/test_websocket_response_information_v1.py +++ b/test/test_websocket_response_information_v1.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.websocket_response_information_v1 import WebsocketResponseInformationV1 # noqa: E501 +from eZmaxApi.models.websocket_response_information_v1 import WebsocketResponseInformationV1 class TestWebsocketResponseInformationV1(unittest.TestCase): """WebsocketResponseInformationV1 unit test stubs""" @@ -34,16 +34,18 @@ def make_instance(self, include_optional) -> WebsocketResponseInformationV1: optional params are included """ # uncomment below to create an instance of `WebsocketResponseInformationV1` """ - model = WebsocketResponseInformationV1() # noqa: E501 + model = WebsocketResponseInformationV1() if include_optional: return WebsocketResponseInformationV1( e_websocket_messagetype = 'Response-Information-V1', + s_websocket_channel = 'Ch@nnel_1.0', m_payload = eZmaxApi.models.websocket_response_information_v1_m_payload.Websocket-Response-Information-V1-mPayload( s_information_message = 'Rasterizing pages', ) ) else: return WebsocketResponseInformationV1( e_websocket_messagetype = 'Response-Information-V1', + s_websocket_channel = 'Ch@nnel_1.0', m_payload = eZmaxApi.models.websocket_response_information_v1_m_payload.Websocket-Response-Information-V1-mPayload( s_information_message = 'Rasterizing pages', ), ) diff --git a/test/test_websocket_response_information_v1_m_payload.py b/test/test_websocket_response_information_v1_m_payload.py index 4f1921b11..044c4ccda 100644 --- a/test/test_websocket_response_information_v1_m_payload.py +++ b/test/test_websocket_response_information_v1_m_payload.py @@ -16,7 +16,7 @@ import unittest import datetime -from eZmaxApi.models.websocket_response_information_v1_m_payload import WebsocketResponseInformationV1MPayload # noqa: E501 +from eZmaxApi.models.websocket_response_information_v1_m_payload import WebsocketResponseInformationV1MPayload class TestWebsocketResponseInformationV1MPayload(unittest.TestCase): """WebsocketResponseInformationV1MPayload unit test stubs""" @@ -34,7 +34,7 @@ def make_instance(self, include_optional) -> WebsocketResponseInformationV1MPayl optional params are included """ # uncomment below to create an instance of `WebsocketResponseInformationV1MPayload` """ - model = WebsocketResponseInformationV1MPayload() # noqa: E501 + model = WebsocketResponseInformationV1MPayload() if include_optional: return WebsocketResponseInformationV1MPayload( s_information_message = 'Rasterizing pages'